diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 4fc7a5b73..c7ccbf9fa 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -9,12 +9,21 @@ ARG INSTALL_NODE="true" ARG NODE_VERSION="lts/*" RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "source /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi -# [Optional] Uncomment this section to install additional OS packages. +# Install additional OS packages RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ - && apt-get -y install --no-install-recommends libtag1-dev ffmpeg + && apt-get -y install --no-install-recommends ffmpeg -# [Optional] Uncomment the next line to use go get to install anything else you need -# RUN go get -x +# Install TagLib from cross-taglib releases +ARG CROSS_TAGLIB_VERSION="2.2.0-1" +ARG TARGETARCH +RUN DOWNLOAD_ARCH="linux-${TARGETARCH}" \ + && wget -q "https://github.com/navidrome/cross-taglib/releases/download/v${CROSS_TAGLIB_VERSION}/taglib-${DOWNLOAD_ARCH}.tar.gz" -O /tmp/cross-taglib.tar.gz \ + && tar -xzf /tmp/cross-taglib.tar.gz -C /usr --strip-components=1 \ + && mv /usr/include/taglib/* /usr/include/ \ + && rmdir /usr/include/taglib \ + && rm /tmp/cross-taglib.tar.gz /usr/provenance.json + +ENV CGO_CFLAGS_ALLOW="--define-prefix" # [Optional] Uncomment this line to install global node packages. # RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index f339f62f7..81398a3ce 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -4,10 +4,11 @@ "dockerfile": "Dockerfile", "args": { // Update the VARIANT arg to pick a version of Go: 1, 1.15, 1.14 - "VARIANT": "1.24", + "VARIANT": "1.25", // Options "INSTALL_NODE": "true", - "NODE_VERSION": "v20" + "NODE_VERSION": "v24", + "CROSS_TAGLIB_VERSION": "2.2.0-1" } }, "workspaceMount": "", @@ -54,12 +55,10 @@ 4533, 4633 ], - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "make setup-dev", // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. "remoteUser": "vscode", "remoteEnv": { "ND_MUSICFOLDER": "./music", "ND_DATAFOLDER": "./data" } -} +} \ No newline at end of file diff --git a/.dockerignore b/.dockerignore index 596aa2955..eb012c6e2 100644 --- a/.dockerignore +++ b/.dockerignore @@ -15,4 +15,5 @@ dist binaries cache music +music.old !Dockerfile \ No newline at end of file diff --git a/.github/workflows/pipeline.yml b/.github/workflows/pipeline.yml index 9488f20f7..2529aaf36 100644 --- a/.github/workflows/pipeline.yml +++ b/.github/workflows/pipeline.yml @@ -14,7 +14,8 @@ concurrency: cancel-in-progress: true env: - CROSS_TAGLIB_VERSION: "2.1.1-1" + CROSS_TAGLIB_VERSION: "2.2.0-1" + CGO_CFLAGS_ALLOW: "--define-prefix" IS_RELEASE: ${{ startsWith(github.ref, 'refs/tags/') && 'true' || 'false' }} jobs: @@ -25,7 +26,7 @@ jobs: git_tag: ${{ steps.git-version.outputs.GIT_TAG }} git_sha: ${{ steps.git-version.outputs.GIT_SHA }} steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v6 with: fetch-depth: 0 fetch-tags: true @@ -63,7 +64,7 @@ jobs: name: Lint Go code runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v6 - name: Download TagLib uses: ./.github/actions/download-taglib @@ -71,7 +72,7 @@ jobs: version: ${{ env.CROSS_TAGLIB_VERSION }} - name: golangci-lint - uses: golangci/golangci-lint-action@v8 + uses: golangci/golangci-lint-action@v9 with: version: latest problem-matchers: true @@ -88,12 +89,22 @@ jobs: exit 1 fi + - name: Run go generate + run: go generate ./... + - name: Verify no changes from go generate + run: | + git status --porcelain + if [ -n "$(git status --porcelain)" ]; then + echo 'Generated code is out of date. Run "make gen" and commit the changes' + exit 1 + fi + go: name: Test Go code runs-on: ubuntu-latest steps: - name: Check out code into the Go module directory - uses: actions/checkout@v4 + uses: actions/checkout@v6 - name: Download TagLib uses: ./.github/actions/download-taglib @@ -106,7 +117,14 @@ jobs: - name: Test run: | pkg-config --define-prefix --cflags --libs taglib # for debugging - go test -shuffle=on -tags netgo -race -cover ./... -v + go test -shuffle=on -tags netgo,sqlite_fts5 -race ./... -v + + - name: Test ndpgen + run: | + cd plugins/cmd/ndpgen + go test -shuffle=on -v + go build -o ndpgen . + ./ndpgen --help js: name: Test JS code @@ -114,10 +132,10 @@ jobs: env: NODE_OPTIONS: "--max_old_space_size=4096" steps: - - uses: actions/checkout@v4 - - uses: actions/setup-node@v4 + - uses: actions/checkout@v6 + - uses: actions/setup-node@v6 with: - node-version: 20 + node-version: 24 cache: "npm" cache-dependency-path: "**/package-lock.json" @@ -145,7 +163,7 @@ jobs: name: Lint i18n files runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v6 - run: | set -e for file in resources/i18n/*.json; do @@ -175,7 +193,7 @@ jobs: needs: [js, go, go-lint, i18n-lint, git-version, check-push-enabled] strategy: matrix: - platform: [ linux/amd64, linux/arm64, linux/arm/v5, linux/arm/v6, linux/arm/v7, linux/386, darwin/amd64, darwin/arm64, windows/amd64, windows/386 ] + platform: [ linux/amd64, linux/arm64, linux/arm/v5, linux/arm/v6, linux/arm/v7, linux/386, linux/riscv64, darwin/amd64, darwin/arm64, windows/amd64, windows/386 ] runs-on: ubuntu-latest env: IS_LINUX: ${{ startsWith(matrix.platform, 'linux/') && 'true' || 'false' }} @@ -191,7 +209,7 @@ jobs: PLATFORM=$(echo ${{ matrix.platform }} | tr '/' '_') echo "PLATFORM=$PLATFORM" >> $GITHUB_ENV - - uses: actions/checkout@v4 + - uses: actions/checkout@v6 - name: Prepare Docker Buildx uses: ./.github/actions/prepare-docker @@ -203,7 +221,7 @@ jobs: hub_password: ${{ secrets.DOCKER_HUB_PASSWORD }} - name: Build Binaries - uses: docker/build-push-action@v6 + uses: docker/build-push-action@v7 with: context: . file: Dockerfile @@ -217,7 +235,7 @@ jobs: CROSS_TAGLIB_VERSION=${{ env.CROSS_TAGLIB_VERSION }} - name: Upload Binaries - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@v7 with: name: navidrome-${{ env.PLATFORM }} path: ./output @@ -226,7 +244,7 @@ jobs: - name: Build and push image by digest id: push-image if: env.IS_LINUX == 'true' && env.IS_DOCKER_PUSH_CONFIGURED == 'true' && env.IS_ARMV5 == 'false' - uses: docker/build-push-action@v6 + uses: docker/build-push-action@v7 with: context: . file: Dockerfile @@ -248,7 +266,7 @@ jobs: touch "/tmp/digests/${digest#sha256:}" - name: Upload digest - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@v7 if: env.IS_LINUX == 'true' && env.IS_DOCKER_PUSH_CONFIGURED == 'true' && env.IS_ARMV5 == 'false' with: name: digests-${{ env.PLATFORM }} @@ -256,18 +274,55 @@ jobs: if-no-files-found: error retention-days: 1 - push-manifest: - name: Push Docker manifest + push-manifest-ghcr: + name: Push to GHCR + permissions: + contents: read + packages: write runs-on: ubuntu-latest needs: [build, check-push-enabled] if: needs.check-push-enabled.outputs.is_enabled == 'true' env: REGISTRY_IMAGE: ghcr.io/${{ github.repository }} steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v6 - name: Download digests - uses: actions/download-artifact@v4 + uses: actions/download-artifact@v8 + with: + path: /tmp/digests + pattern: digests-* + merge-multiple: true + + - name: Prepare Docker Buildx + uses: ./.github/actions/prepare-docker + id: docker + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + + - name: Create manifest list and push to ghcr.io + working-directory: /tmp/digests + run: | + docker buildx imagetools create $(jq -cr '.tags | map(select(startswith("ghcr.io"))) | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON") \ + $(printf '${{ env.REGISTRY_IMAGE }}@sha256:%s ' *) + + - name: Inspect image in ghcr.io + run: | + docker buildx imagetools inspect ${{ env.REGISTRY_IMAGE }}:${{ steps.docker.outputs.version }} + + push-manifest-dockerhub: + name: Push to Docker Hub + runs-on: ubuntu-latest + permissions: + contents: read + needs: [build, check-push-enabled] + if: needs.check-push-enabled.outputs.is_enabled == 'true' && vars.DOCKER_HUB_REPO != '' + continue-on-error: true + steps: + - uses: actions/checkout@v6 + + - name: Download digests + uses: actions/download-artifact@v8 with: path: /tmp/digests pattern: digests-* @@ -282,28 +337,27 @@ jobs: hub_username: ${{ secrets.DOCKER_HUB_USERNAME }} hub_password: ${{ secrets.DOCKER_HUB_PASSWORD }} - - name: Create manifest list and push to ghcr.io - working-directory: /tmp/digests - run: | - docker buildx imagetools create $(jq -cr '.tags | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON") \ - $(printf '${{ env.REGISTRY_IMAGE }}@sha256:%s ' *) - - name: Create manifest list and push to Docker Hub - working-directory: /tmp/digests - if: vars.DOCKER_HUB_REPO != '' - run: | - docker buildx imagetools create $(jq -cr '.tags | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON") \ - $(printf '${{ vars.DOCKER_HUB_REPO }}@sha256:%s ' *) - - - name: Inspect image in ghcr.io - run: | - docker buildx imagetools inspect ${{ env.REGISTRY_IMAGE }}:${{ steps.docker.outputs.version }} + uses: nick-fields/retry@v4 + with: + timeout_minutes: 5 + max_attempts: 3 + retry_wait_seconds: 30 + command: | + cd /tmp/digests + docker buildx imagetools create $(jq -cr '.tags | map(select(startswith("ghcr.io") | not)) | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON") \ + $(printf 'ghcr.io/${{ github.repository }}@sha256:%s ' *) - name: Inspect image in Docker Hub - if: vars.DOCKER_HUB_REPO != '' run: | docker buildx imagetools inspect ${{ vars.DOCKER_HUB_REPO }}:${{ steps.docker.outputs.version }} + cleanup-digests: + name: Cleanup digest artifacts + runs-on: ubuntu-latest + needs: [push-manifest-ghcr, push-manifest-dockerhub] + if: always() && needs.push-manifest-ghcr.result == 'success' + steps: - name: Delete unnecessary digest artifacts env: GH_TOKEN: ${{ github.token }} @@ -318,9 +372,9 @@ jobs: runs-on: ubuntu-24.04 steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v6 - - uses: actions/download-artifact@v4 + - uses: actions/download-artifact@v8 with: path: ./binaries pattern: navidrome-windows* @@ -339,7 +393,7 @@ jobs: du -h binaries/msi/*.msi - name: Upload MSI files - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@v7 with: name: navidrome-windows-installers path: binaries/msi/*.msi @@ -352,12 +406,12 @@ jobs: outputs: package_list: ${{ steps.set-package-list.outputs.package_list }} steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v6 with: fetch-depth: 0 fetch-tags: true - - uses: actions/download-artifact@v4 + - uses: actions/download-artifact@v8 with: path: ./binaries pattern: navidrome-* @@ -370,7 +424,7 @@ jobs: run: echo 'RELEASE_FLAGS=--skip=publish --snapshot' >> $GITHUB_ENV - name: Run GoReleaser - uses: goreleaser/goreleaser-action@v6 + uses: goreleaser/goreleaser-action@v7 with: version: '~> v2' args: "release --clean -f release/goreleaser.yml ${{ env.RELEASE_FLAGS }}" @@ -383,7 +437,7 @@ jobs: rm ./dist/*.tar.gz ./dist/*.zip - name: Upload all-packages artifact - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@v7 with: name: packages path: dist/navidrome_0* @@ -406,13 +460,13 @@ jobs: item: ${{ fromJson(needs.release.outputs.package_list) }} steps: - name: Download all-packages artifact - uses: actions/download-artifact@v4 + uses: actions/download-artifact@v8 with: name: packages path: ./dist - name: Upload all-packages artifact - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@v7 with: name: navidrome_linux_${{ matrix.item }} path: dist/navidrome_0*_linux_${{ matrix.item }} diff --git a/.github/workflows/push-translations.sh b/.github/workflows/push-translations.sh new file mode 100755 index 000000000..be153eea8 --- /dev/null +++ b/.github/workflows/push-translations.sh @@ -0,0 +1,138 @@ +#!/bin/sh + +set -e + +I18N_DIR=resources/i18n + +# Normalize JSON for deterministic comparison: +# remove empty/null attributes, sort keys alphabetically +process_json() { + jq 'walk(if type == "object" then with_entries(select(.value != null and .value != "" and .value != [] and .value != {})) | to_entries | sort_by(.key) | from_entries else . end)' "$1" +} + +# Get list of all languages configured in the POEditor project +get_language_list() { + curl -s -X POST https://api.poeditor.com/v2/languages/list \ + -d api_token="${POEDITOR_APIKEY}" \ + -d id="${POEDITOR_PROJECTID}" +} + +# Extract language name from the language list JSON given a language code +get_language_name() { + lang_code="$1" + lang_list="$2" + echo "$lang_list" | jq -r ".result.languages[] | select(.code == \"$lang_code\") | .name" +} + +# Extract language code from a file path (e.g., "resources/i18n/fr.json" -> "fr") +get_lang_code() { + filepath="$1" + filename=$(basename "$filepath") + echo "${filename%.*}" +} + +# Export the current translation for a language from POEditor (v2 API) +export_language() { + lang_code="$1" + response=$(curl -s -X POST https://api.poeditor.com/v2/projects/export \ + -d api_token="${POEDITOR_APIKEY}" \ + -d id="${POEDITOR_PROJECTID}" \ + -d language="$lang_code" \ + -d type="key_value_json") + + url=$(echo "$response" | jq -r '.result.url') + if [ -z "$url" ] || [ "$url" = "null" ]; then + echo "Failed to export $lang_code: $response" >&2 + return 1 + fi + echo "$url" +} + +# Flatten nested JSON to POEditor languages/update format. +# POEditor uses term + context pairs, where: +# term = the leaf key name +# context = the parent path as "key1"."key2"."key3" (empty for root keys) +flatten_to_poeditor() { + jq -c '[paths(scalars) as $p | + { + "term": ($p | last | tostring), + "context": (if ($p | length) > 1 then ($p[:-1] | map("\"" + tostring + "\"") | join(".")) else "" end), + "translation": {"content": getpath($p)} + } + ]' "$1" +} + +# Update translations for a language in POEditor via languages/update API +update_language() { + lang_code="$1" + file="$2" + + flatten_to_poeditor "$file" > /tmp/poeditor_data.json + response=$(curl -s -X POST https://api.poeditor.com/v2/languages/update \ + -d api_token="${POEDITOR_APIKEY}" \ + -d id="${POEDITOR_PROJECTID}" \ + -d language="$lang_code" \ + --data-urlencode data@/tmp/poeditor_data.json) + rm -f /tmp/poeditor_data.json + + status=$(echo "$response" | jq -r '.response.status') + if [ "$status" != "success" ]; then + echo "Failed to update $lang_code: $response" >&2 + return 1 + fi + + parsed=$(echo "$response" | jq -r '.result.translations.parsed') + added=$(echo "$response" | jq -r '.result.translations.added') + updated=$(echo "$response" | jq -r '.result.translations.updated') + echo " Translations - parsed: $parsed, added: $added, updated: $updated" +} + +# --- Main --- + +if [ $# -eq 0 ]; then + echo "Usage: $0 [file2] ..." + echo "No files specified. Nothing to do." + exit 0 +fi + +lang_list=$(get_language_list) +upload_count=0 + +for file in "$@"; do + if [ ! -f "$file" ]; then + echo "Warning: File not found: $file, skipping" + continue + fi + + lang_code=$(get_lang_code "$file") + lang_name=$(get_language_name "$lang_code" "$lang_list") + + if [ -z "$lang_name" ]; then + echo "Warning: Language code '$lang_code' not found in POEditor, skipping $file" + continue + fi + + echo "Processing $lang_name ($lang_code)..." + + # Export current state from POEditor + url=$(export_language "$lang_code") + curl -sSL "$url" -o poeditor_export.json + + # Normalize both files for comparison + process_json "$file" > local_normalized.json + process_json poeditor_export.json > remote_normalized.json + + # Compare normalized versions + if diff -q local_normalized.json remote_normalized.json > /dev/null 2>&1; then + echo " No differences, skipping" + else + echo " Differences found, updating POEditor..." + update_language "$lang_code" "$file" + upload_count=$((upload_count + 1)) + fi + + rm -f poeditor_export.json local_normalized.json remote_normalized.json +done + +echo "" +echo "Done. Updated $upload_count translation(s) in POEditor." diff --git a/.github/workflows/push-translations.yml b/.github/workflows/push-translations.yml new file mode 100644 index 000000000..f7cf00621 --- /dev/null +++ b/.github/workflows/push-translations.yml @@ -0,0 +1,32 @@ +name: POEditor export + +on: + push: + branches: + - master + paths: + - 'resources/i18n/*.json' + +jobs: + push-translations: + runs-on: ubuntu-latest + if: ${{ github.repository_owner == 'navidrome' }} + steps: + - uses: actions/checkout@v6 + with: + fetch-depth: 2 + + - name: Detect changed translation files + id: changed + run: | + CHANGED_FILES=$(git diff --name-only HEAD~1 HEAD -- 'resources/i18n/*.json' | tr '\n' ' ') + echo "files=$CHANGED_FILES" >> $GITHUB_OUTPUT + echo "Changed translation files: $CHANGED_FILES" + + - name: Push translations to POEditor + if: ${{ steps.changed.outputs.files != '' }} + env: + POEDITOR_APIKEY: ${{ secrets.POEDITOR_APIKEY }} + POEDITOR_PROJECTID: ${{ secrets.POEDITOR_PROJECTID }} + run: | + .github/workflows/push-translations.sh ${{ steps.changed.outputs.files }} diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index c8bf3ae7f..69e6ac99e 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -12,7 +12,7 @@ jobs: pull-requests: write runs-on: ubuntu-latest steps: - - uses: dessant/lock-threads@v5 + - uses: dessant/lock-threads@v6 with: process-only: 'issues, prs' issue-inactive-days: 120 diff --git a/.github/workflows/update-translations.yml b/.github/workflows/update-translations.yml index 70a9de3d8..8fe0b5379 100644 --- a/.github/workflows/update-translations.yml +++ b/.github/workflows/update-translations.yml @@ -8,7 +8,7 @@ jobs: runs-on: ubuntu-latest if: ${{ github.repository_owner == 'navidrome' }} steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v6 - name: Get updated translations id: poeditor env: @@ -24,7 +24,7 @@ jobs: git status --porcelain git diff - name: Create Pull Request - uses: peter-evans/create-pull-request@v7 + uses: peter-evans/create-pull-request@v8 with: token: ${{ secrets.PAT }} author: "navidrome-bot " diff --git a/.gitignore b/.gitignore index 74d7ee46f..73475a53a 100644 --- a/.gitignore +++ b/.gitignore @@ -17,18 +17,25 @@ master.zip testDB cache/* *.swp +coverage.out dist music +music.old *.db* .gitinfo docker-compose.yml !contrib/docker-compose.yml binaries navidrome-* +/ndpgen AGENTS.md .github/prompts .github/instructions .github/git-commit-instructions.md *.exe *.test -*.wasm \ No newline at end of file +*.wasm +*.ndp +openspec/ +go.work* +.worktrees/ \ No newline at end of file diff --git a/.golangci.yml b/.golangci.yml index 996dafccb..b6c632dee 100644 --- a/.golangci.yml +++ b/.golangci.yml @@ -2,6 +2,7 @@ version: "2" run: build-tags: - netgo + - sqlite_fts5 linters: enable: - asasalint @@ -39,6 +40,11 @@ linters: enable: - nilness exclusions: + rules: + - linters: + - gosec + path: _test\.go + text: "G703" generated: lax presets: - comments diff --git a/.nvmrc b/.nvmrc index 9a2a0e219..54c65116f 100644 --- a/.nvmrc +++ b/.nvmrc @@ -1 +1 @@ -v20 +v24 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f2631f597..71c13b497 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,7 +38,7 @@ Before submitting a pull request, ensure that you go through the following: ### Commit Conventions Each commit message must adhere to the following format: ``` -(scope): - +(scope): [optional body] ``` diff --git a/Dockerfile b/Dockerfile index ec3b6d938..b32c1df56 100644 --- a/Dockerfile +++ b/Dockerfile @@ -2,10 +2,10 @@ FROM --platform=$BUILDPLATFORM ghcr.io/crazy-max/osxcross:14.5-debian AS osxcros ######################################################################################################################## ### Build xx (original image: tonistiigi/xx) -FROM --platform=$BUILDPLATFORM public.ecr.aws/docker/library/alpine:3.19 AS xx-build +FROM --platform=$BUILDPLATFORM public.ecr.aws/docker/library/alpine:3.20 AS xx-build -# v1.5.0 -ENV XX_VERSION=b4e4c451c778822e6742bfc9d9a91d7c7d885c8a +# v1.9.0 +ENV XX_VERSION=a5592eab7a57895e8d385394ff12241bc65ecd50 RUN apk add -U --no-cache git RUN git clone https://github.com/tonistiigi/xx && \ @@ -26,12 +26,14 @@ COPY --from=xx-build /out/ /usr/bin/ ######################################################################################################################## ### Get TagLib -FROM --platform=$BUILDPLATFORM public.ecr.aws/docker/library/alpine:3.19 AS taglib-build +FROM --platform=$BUILDPLATFORM public.ecr.aws/docker/library/alpine:3.20 AS taglib-build ARG TARGETPLATFORM -ARG CROSS_TAGLIB_VERSION=2.1.1-1 +ARG CROSS_TAGLIB_VERSION=2.2.0-1 ENV CROSS_TAGLIB_RELEASES_URL=https://github.com/navidrome/cross-taglib/releases/download/v${CROSS_TAGLIB_VERSION}/ +# wget in busybox can't follow redirects RUN < /dev/null || (echo "Installing golangci-lint..." && curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/HEAD/install.sh | sh -s v2.1.6) + @INSTALL=false; \ + if PATH=$$PATH:./bin which golangci-lint > /dev/null 2>&1; then \ + CURRENT_VERSION=$$(PATH=$$PATH:./bin golangci-lint version 2>/dev/null | grep -oE '[0-9]+\.[0-9]+\.[0-9]+' | head -n1); \ + REQUIRED_VERSION=$$(echo "$(GOLANGCI_LINT_VERSION)" | sed 's/^v//'); \ + if [ "$$CURRENT_VERSION" != "$$REQUIRED_VERSION" ]; then \ + echo "Found golangci-lint $$CURRENT_VERSION, but $$REQUIRED_VERSION is required. Reinstalling..."; \ + rm -f ./bin/golangci-lint; \ + INSTALL=true; \ + fi; \ + else \ + INSTALL=true; \ + fi; \ + if [ "$$INSTALL" = "true" ]; then \ + echo "Installing golangci-lint $(GOLANGCI_LINT_VERSION)..."; \ + curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/HEAD/install.sh | sh -s $(GOLANGCI_LINT_VERSION); \ + fi .PHONY: install-golangci-lint lint: install-golangci-lint ##@Development Lint Go code - PATH=$$PATH:./bin golangci-lint run -v --timeout 5m + PATH=$$PATH:./bin golangci-lint run --timeout 5m .PHONY: lint lintall: lint ##@Development Lint Go and JS code @@ -84,9 +109,18 @@ format: ##@Development Format code .PHONY: format wire: check_go_env ##@Development Update Dependency Injection - go tool wire gen -tags=netgo ./... + go tool wire gen -tags="$$(echo '$(GO_BUILD_TAGS)' | tr ',' ' ')" ./... .PHONY: wire +gen: check_go_env ##@Development Run go generate for code generation + go generate ./... + cd plugins/cmd/ndpgen && go run . -host-wrappers -input=../../host -package=host + cd plugins/cmd/ndpgen && go run . -input=../../host -output=../../pdk -go -python -rust + cd plugins/cmd/ndpgen && go run . -capability-only -input=../../capabilities -output=../../pdk -go -rust + cd plugins/cmd/ndpgen && go run . -schemas -input=../../capabilities + go mod tidy -C plugins/pdk/go +.PHONY: gen + snapshots: ##@Development Update (GoLang) Snapshot tests UPDATE_SNAPSHOTS=true go tool ginkgo ./server/subsonic/responses/... .PHONY: snapshots @@ -111,14 +145,14 @@ setup-git: ##@Development Setup Git hooks (pre-commit and pre-push) .PHONY: setup-git build: check_go_env buildjs ##@Build Build the project - go build -ldflags="-X github.com/navidrome/navidrome/consts.gitSha=$(GIT_SHA) -X github.com/navidrome/navidrome/consts.gitTag=$(GIT_TAG)" -tags=netgo + go build -ldflags="-X github.com/navidrome/navidrome/consts.gitSha=$(GIT_SHA) -X github.com/navidrome/navidrome/consts.gitTag=$(GIT_TAG)" -tags=$(GO_BUILD_TAGS) .PHONY: build buildall: deprecated build .PHONY: buildall debug-build: check_go_env buildjs ##@Build Build the project (with remote debug on) - go build -gcflags="all=-N -l" -ldflags="-X github.com/navidrome/navidrome/consts.gitSha=$(GIT_SHA) -X github.com/navidrome/navidrome/consts.gitTag=$(GIT_TAG)" -tags=netgo + go build -gcflags="all=-N -l" -ldflags="-X github.com/navidrome/navidrome/consts.gitSha=$(GIT_SHA) -X github.com/navidrome/navidrome/consts.gitTag=$(GIT_TAG)" -tags=$(GO_BUILD_TAGS) .PHONY: debug-build buildjs: check_node_env ui/build/index.html ##@Build Build only frontend @@ -168,8 +202,8 @@ docker-msi: ##@Cross_Compilation Build MSI installer for Windows @du -h binaries/msi/*.msi .PHONY: docker-msi -run-docker: ##@Development Run a Navidrome Docker image. Usage: make run-docker tag= - @if [ -z "$(tag)" ]; then echo "Usage: make run-docker tag="; exit 1; fi +docker-run: ##@Development Run a Navidrome Docker image. Usage: make docker-run tag= + @if [ -z "$(tag)" ]; then echo "Usage: make docker-run tag="; exit 1; fi @TAG_DIR="tmp/$$(echo '$(tag)' | tr '/:' '_')"; mkdir -p "$$TAG_DIR"; \ VOLUMES="-v $(PWD)/$$TAG_DIR:/data"; \ if [ -f navidrome.toml ]; then \ @@ -180,7 +214,7 @@ run-docker: ##@Development Run a Navidrome Docker image. Usage: make run-docker fi; \ fi; \ echo "Running: docker run --rm -p 4533:4533 $$VOLUMES $(tag)"; docker run --rm -p 4533:4533 $$VOLUMES $(tag) -.PHONY: run-docker +.PHONY: docker-run package: docker-build ##@Cross_Compilation Create binaries and packages for ALL supported platforms @if [ -z `which goreleaser` ]; then echo "Please install goreleaser first: https://goreleaser.com/install/"; exit 1; fi @@ -199,6 +233,39 @@ get-music: ##@Development Download some free music from Navidrome's demo instanc .PHONY: get-music +########################################## +#### Worktrees + +WORKTREES_DIR := .worktrees + +wt: check_go_env ##@Worktrees Create and setup a git worktree. Usage: make wt name=feature-name [go=1] + @if [ -z "${name}" ]; then echo "Usage: make wt name= [go=1]"; exit 1; fi + @mkdir -p $(WORKTREES_DIR) + @echo "Creating worktree for branch '${name}'..." + @git worktree add $(WORKTREES_DIR)/${name} -b ${name} 2>/dev/null || \ + git worktree add $(WORKTREES_DIR)/${name} ${name} + @if [ -n "${go}" ]; then \ + ./scripts/setup-worktree.sh $(WORKTREES_DIR)/${name} --go-only; \ + else \ + ./scripts/setup-worktree.sh $(WORKTREES_DIR)/${name}; \ + fi + @echo "\nWorktree ready at $(WORKTREES_DIR)/${name}" + @echo " cd $(WORKTREES_DIR)/${name}" +.PHONY: wt + +rm-wt: ##@Worktrees Remove a git worktree. Usage: make rm-wt name=feature-name + @if [ -z "${name}" ]; then echo "Usage: make rm-wt name="; exit 1; fi + @if [ ! -d "$(WORKTREES_DIR)/${name}" ]; then echo "Worktree '${name}' not found in $(WORKTREES_DIR)/"; exit 1; fi + @echo "Removing worktree '${name}'..." + @git worktree remove --force $(WORKTREES_DIR)/${name} + @echo "Worktree '${name}' removed." + @echo "Note: branch '${name}' still exists. Delete it with: git branch -D ${name}" +.PHONY: rm-wt + +ls-wt: ##@Worktrees List all active git worktrees + @git worktree list +.PHONY: ls-wt + ########################################## #### Miscellaneous @@ -250,24 +317,6 @@ deprecated: @echo "WARNING: This target is deprecated and will be removed in future releases. Use 'make build' instead." .PHONY: deprecated -# Generate Go code from plugins/api/api.proto -plugin-gen: check_go_env ##@Development Generate Go code from plugins protobuf files - go generate ./plugins/... -.PHONY: plugin-gen - -plugin-examples: check_go_env ##@Development Build all example plugins - $(MAKE) -C plugins/examples clean all -.PHONY: plugin-examples - -plugin-clean: check_go_env ##@Development Clean all plugins - $(MAKE) -C plugins/examples clean - $(MAKE) -C plugins/testdata clean -.PHONY: plugin-clean - -plugin-tests: check_go_env ##@Development Build all test plugins - $(MAKE) -C plugins/testdata clean all -.PHONY: plugin-tests - .DEFAULT_GOAL := help HELP_FUN = \ diff --git a/adapters/deezer/client.go b/adapters/deezer/client.go new file mode 100644 index 000000000..31150c673 --- /dev/null +++ b/adapters/deezer/client.go @@ -0,0 +1,217 @@ +package deezer + +import ( + bytes "bytes" + "context" + "encoding/json" + "errors" + "fmt" + "io" + "net/http" + "net/url" + "strconv" + "strings" + + "github.com/microcosm-cc/bluemonday" + "github.com/navidrome/navidrome/log" +) + +const apiBaseURL = "https://api.deezer.com" +const authBaseURL = "https://auth.deezer.com" + +var ( + ErrNotFound = errors.New("deezer: not found") +) + +type httpDoer interface { + Do(req *http.Request) (*http.Response, error) +} + +type client struct { + httpDoer httpDoer + jwt jwtToken +} + +func newClient(hc httpDoer) *client { + return &client{ + httpDoer: hc, + } +} + +func (c *client) searchArtists(ctx context.Context, name string, limit int) ([]Artist, error) { + params := url.Values{} + params.Add("q", name) + params.Add("order", "RANKING") + params.Add("limit", strconv.Itoa(limit)) + req, err := http.NewRequestWithContext(ctx, "GET", apiBaseURL+"/search/artist", nil) + if err != nil { + return nil, err + } + req.URL.RawQuery = params.Encode() + + var results SearchArtistResults + err = c.makeRequest(req, &results) + if err != nil { + return nil, err + } + + if len(results.Data) == 0 { + return nil, ErrNotFound + } + return results.Data, nil +} + +func (c *client) makeRequest(req *http.Request, response any) error { + log.Trace(req.Context(), fmt.Sprintf("Sending Deezer %s request", req.Method), "url", req.URL) + resp, err := c.httpDoer.Do(req) + if err != nil { + return err + } + + defer resp.Body.Close() + data, err := io.ReadAll(resp.Body) + if err != nil { + return err + } + + if resp.StatusCode != 200 { + return c.parseError(data) + } + + return json.Unmarshal(data, response) +} + +func (c *client) parseError(data []byte) error { + var deezerError Error + err := json.Unmarshal(data, &deezerError) + if err != nil { + return err + } + return fmt.Errorf("deezer error(%d): %s", deezerError.Error.Code, deezerError.Error.Message) +} + +func (c *client) getRelatedArtists(ctx context.Context, artistID int) ([]Artist, error) { + req, err := http.NewRequestWithContext(ctx, "GET", fmt.Sprintf("%s/artist/%d/related", apiBaseURL, artistID), nil) + if err != nil { + return nil, err + } + + var results RelatedArtists + err = c.makeRequest(req, &results) + if err != nil { + return nil, err + } + + return results.Data, nil +} + +func (c *client) getTopTracks(ctx context.Context, artistID int, limit int) ([]Track, error) { + params := url.Values{} + params.Add("limit", strconv.Itoa(limit)) + req, err := http.NewRequestWithContext(ctx, "GET", fmt.Sprintf("%s/artist/%d/top", apiBaseURL, artistID), nil) + if err != nil { + return nil, err + } + req.URL.RawQuery = params.Encode() + + var results TopTracks + err = c.makeRequest(req, &results) + if err != nil { + return nil, err + } + + return results.Data, nil +} + +const pipeAPIURL = "https://pipe.deezer.com/api" + +var strictPolicy = bluemonday.StrictPolicy() + +func (c *client) getArtistBio(ctx context.Context, artistID int, lang string) (string, error) { + jwt, err := c.getJWT(ctx) + if err != nil { + return "", fmt.Errorf("deezer: failed to get JWT: %w", err) + } + + query := map[string]any{ + "operationName": "ArtistBio", + "variables": map[string]any{ + "artistId": strconv.Itoa(artistID), + }, + "query": `query ArtistBio($artistId: String!) { + artist(artistId: $artistId) { + bio { + full + } + } + }`, + } + + body, err := json.Marshal(query) + if err != nil { + return "", err + } + + req, err := http.NewRequestWithContext(ctx, "POST", pipeAPIURL, bytes.NewReader(body)) + if err != nil { + return "", err + } + + req.Header.Set("Content-Type", "application/json") + req.Header.Set("Accept-Language", lang) + req.Header.Set("Authorization", "Bearer "+jwt) + + log.Trace(ctx, "Fetching Deezer artist biography via GraphQL", "artistId", artistID, "language", lang) + resp, err := c.httpDoer.Do(req) + if err != nil { + return "", err + } + defer resp.Body.Close() + + if resp.StatusCode != 200 { + return "", fmt.Errorf("deezer: failed to fetch biography: %s", resp.Status) + } + + data, err := io.ReadAll(resp.Body) + if err != nil { + return "", err + } + + type graphQLResponse struct { + Data struct { + Artist struct { + Bio struct { + Full string `json:"full"` + } `json:"bio"` + } `json:"artist"` + } `json:"data"` + Errors []struct { + Message string `json:"message"` + } + } + + var result graphQLResponse + if err := json.Unmarshal(data, &result); err != nil { + return "", fmt.Errorf("deezer: failed to parse GraphQL response: %w", err) + } + + if len(result.Errors) > 0 { + var errs []error + for m := range result.Errors { + errs = append(errs, errors.New(result.Errors[m].Message)) + } + err := errors.Join(errs...) + return "", fmt.Errorf("deezer: GraphQL error: %w", err) + } + + if result.Data.Artist.Bio.Full == "" { + return "", errors.New("deezer: biography not found") + } + + return cleanBio(result.Data.Artist.Bio.Full), nil +} + +func cleanBio(bio string) string { + bio = strings.ReplaceAll(bio, "

", "\n") + return strictPolicy.Sanitize(bio) +} diff --git a/adapters/deezer/client_auth.go b/adapters/deezer/client_auth.go new file mode 100644 index 000000000..eb664c00b --- /dev/null +++ b/adapters/deezer/client_auth.go @@ -0,0 +1,101 @@ +package deezer + +import ( + "context" + "encoding/json" + "errors" + "fmt" + "io" + "net/http" + "sync" + "time" + + "github.com/lestrrat-go/jwx/v3/jwt" + "github.com/navidrome/navidrome/log" +) + +type jwtToken struct { + token string + expiresAt time.Time + mu sync.RWMutex +} + +func (j *jwtToken) get() (string, bool) { + j.mu.RLock() + defer j.mu.RUnlock() + if time.Now().Before(j.expiresAt) { + return j.token, true + } + return "", false +} + +func (j *jwtToken) set(token string, expiresIn time.Duration) { + j.mu.Lock() + defer j.mu.Unlock() + j.token = token + j.expiresAt = time.Now().Add(expiresIn) +} + +func (c *client) getJWT(ctx context.Context) (string, error) { + // Check if we have a valid cached token + if token, valid := c.jwt.get(); valid { + return token, nil + } + + // Fetch a new anonymous token + req, err := http.NewRequestWithContext(ctx, "GET", authBaseURL+"/login/anonymous?jo=p&rto=c", nil) + if err != nil { + return "", err + } + req.Header.Set("Accept", "application/json") + + resp, err := c.httpDoer.Do(req) + if err != nil { + return "", err + } + defer resp.Body.Close() + + if resp.StatusCode != 200 { + return "", fmt.Errorf("deezer: failed to get JWT token: %s", resp.Status) + } + + data, err := io.ReadAll(resp.Body) + if err != nil { + return "", err + } + + type authResponse struct { + JWT string `json:"jwt"` //nolint:gosec + } + + var result authResponse + if err := json.Unmarshal(data, &result); err != nil { + return "", fmt.Errorf("deezer: failed to parse auth response: %w", err) + } + + if result.JWT == "" { + return "", errors.New("deezer: no JWT token in response") + } + + // Parse JWT to get actual expiration time + token, err := jwt.ParseString(result.JWT, jwt.WithVerify(false), jwt.WithValidate(false)) + if err != nil { + return "", fmt.Errorf("deezer: failed to parse JWT token: %w", err) + } + + // Calculate TTL with a 1-minute buffer for clock skew and network delays + expiresAt, ok := token.Expiration() + if !ok || expiresAt.IsZero() { + return "", errors.New("deezer: JWT token has no expiration time") + } + + ttl := time.Until(expiresAt) - 1*time.Minute + if ttl <= 0 { + return "", errors.New("deezer: JWT token already expired or expires too soon") + } + + c.jwt.set(result.JWT, ttl) + log.Trace(ctx, "Fetched new Deezer JWT token", "expiresAt", expiresAt, "ttl", ttl) + + return result.JWT, nil +} diff --git a/adapters/deezer/client_auth_test.go b/adapters/deezer/client_auth_test.go new file mode 100644 index 000000000..005a84e1a --- /dev/null +++ b/adapters/deezer/client_auth_test.go @@ -0,0 +1,294 @@ +package deezer + +import ( + "bytes" + "context" + "fmt" + "io" + "net/http" + "sync" + "time" + + "github.com/lestrrat-go/jwx/v3/jwt" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("JWT Authentication", func() { + var httpClient *fakeHttpClient + var client *client + var ctx context.Context + + BeforeEach(func() { + httpClient = &fakeHttpClient{} + client = newClient(httpClient) + ctx = context.Background() + }) + + Describe("getJWT", func() { + Context("with a valid JWT response", func() { + It("successfully fetches and caches a JWT token", func() { + testJWT := createTestJWT(5 * time.Minute) + httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(fmt.Sprintf(`{"jwt":"%s"}`, testJWT))), + }) + + token, err := client.getJWT(ctx) + Expect(err).To(BeNil()) + Expect(token).To(Equal(testJWT)) + }) + + It("returns the cached token on subsequent calls", func() { + testJWT := createTestJWT(5 * time.Minute) + httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(fmt.Sprintf(`{"jwt":"%s"}`, testJWT))), + }) + + // First call should fetch from API + token1, err := client.getJWT(ctx) + Expect(err).To(BeNil()) + Expect(token1).To(Equal(testJWT)) + Expect(httpClient.lastRequest.URL.Path).To(Equal("/login/anonymous")) + + // Second call should return cached token without hitting API + httpClient.lastRequest = nil // Clear last request to verify no new request is made + token2, err := client.getJWT(ctx) + Expect(err).To(BeNil()) + Expect(token2).To(Equal(testJWT)) + Expect(httpClient.lastRequest).To(BeNil()) // No new request made + }) + + It("parses the JWT expiration time correctly", func() { + expectedExpiration := time.Now().Add(5 * time.Minute) + testToken, err := jwt.NewBuilder(). + Expiration(expectedExpiration). + Build() + Expect(err).To(BeNil()) + testJWT, err := jwt.Sign(testToken, jwt.WithInsecureNoSignature()) + Expect(err).To(BeNil()) + + httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(fmt.Sprintf(`{"jwt":"%s"}`, string(testJWT)))), + }) + + token, err := client.getJWT(ctx) + Expect(err).To(BeNil()) + Expect(token).ToNot(BeEmpty()) + + // Verify the token is cached until close to expiration + // The cache should expire 1 minute before the JWT expires + expectedCacheExpiry := expectedExpiration.Add(-1 * time.Minute) + Expect(client.jwt.expiresAt).To(BeTemporally("~", expectedCacheExpiry, 2*time.Second)) + }) + }) + + Context("with JWT tokens that expire soon", func() { + It("rejects tokens that expire in less than 1 minute", func() { + // Create a token that expires in 30 seconds (less than 1-minute buffer) + testJWT := createTestJWT(30 * time.Second) + httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(fmt.Sprintf(`{"jwt":"%s"}`, testJWT))), + }) + + _, err := client.getJWT(ctx) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("JWT token already expired or expires too soon")) + }) + + It("rejects already expired tokens", func() { + // Create a token that expired 1 minute ago + testJWT := createTestJWT(-1 * time.Minute) + httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(fmt.Sprintf(`{"jwt":"%s"}`, testJWT))), + }) + + _, err := client.getJWT(ctx) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("JWT token already expired or expires too soon")) + }) + + It("accepts tokens that expire in more than 1 minute", func() { + // Create a token that expires in 2 minutes (just over the 1-minute buffer) + testJWT := createTestJWT(2 * time.Minute) + httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(fmt.Sprintf(`{"jwt":"%s"}`, testJWT))), + }) + + token, err := client.getJWT(ctx) + Expect(err).To(BeNil()) + Expect(token).ToNot(BeEmpty()) + }) + }) + + Context("with invalid responses", func() { + It("handles HTTP error responses", func() { + httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ + StatusCode: 500, + Body: io.NopCloser(bytes.NewBufferString(`{"error":"Internal server error"}`)), + }) + + _, err := client.getJWT(ctx) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("failed to get JWT token")) + }) + + It("handles malformed JSON responses", func() { + httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(`{invalid json}`)), + }) + + _, err := client.getJWT(ctx) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("failed to parse auth response")) + }) + + It("handles responses with empty JWT field", func() { + httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(`{"jwt":""}`)), + }) + + _, err := client.getJWT(ctx) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(Equal("deezer: no JWT token in response")) + }) + + It("handles invalid JWT tokens", func() { + httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(`{"jwt":"not-a-valid-jwt"}`)), + }) + + _, err := client.getJWT(ctx) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("failed to parse JWT token")) + }) + + It("rejects JWT tokens without expiration", func() { + // Create a JWT without expiration claim + testToken, err := jwt.NewBuilder(). + Claim("custom", "value"). + Build() + Expect(err).To(BeNil()) + + // Verify token has no expiration + _, hasExp := testToken.Expiration() + Expect(hasExp).To(BeFalse()) + + testJWT, err := jwt.Sign(testToken, jwt.WithInsecureNoSignature()) + Expect(err).To(BeNil()) + + httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(fmt.Sprintf(`{"jwt":"%s"}`, string(testJWT)))), + }) + + _, err = client.getJWT(ctx) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(Equal("deezer: JWT token has no expiration time")) + }) + }) + + Context("token caching behavior", func() { + It("fetches a new token when the cached token expires", func() { + // First token expires in 5 minutes + firstJWT := createTestJWT(5 * time.Minute) + httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(fmt.Sprintf(`{"jwt":"%s"}`, firstJWT))), + }) + + token1, err := client.getJWT(ctx) + Expect(err).To(BeNil()) + Expect(token1).To(Equal(firstJWT)) + + // Manually expire the cached token + client.jwt.expiresAt = time.Now().Add(-1 * time.Second) + + // Second token with different expiration (10 minutes) + secondJWT := createTestJWT(10 * time.Minute) + httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(fmt.Sprintf(`{"jwt":"%s"}`, secondJWT))), + }) + + token2, err := client.getJWT(ctx) + Expect(err).To(BeNil()) + Expect(token2).To(Equal(secondJWT)) + Expect(token2).ToNot(Equal(token1)) + }) + }) + }) + + Describe("jwtToken cache", func() { + var cache *jwtToken + + BeforeEach(func() { + cache = &jwtToken{} + }) + + It("returns false for expired tokens", func() { + cache.set("test-token", -1*time.Second) // Already expired + token, valid := cache.get() + Expect(valid).To(BeFalse()) + Expect(token).To(BeEmpty()) + }) + + It("returns true for valid tokens", func() { + cache.set("test-token", 4*time.Minute) + token, valid := cache.get() + Expect(valid).To(BeTrue()) + Expect(token).To(Equal("test-token")) + }) + + It("is thread-safe for concurrent access", func() { + wg := sync.WaitGroup{} + + // Writer goroutine + wg.Go(func() { + for i := range 100 { + cache.set(fmt.Sprintf("token-%d", i), 1*time.Hour) + time.Sleep(1 * time.Millisecond) + } + }) + + // Reader goroutine + wg.Go(func() { + for range 100 { + cache.get() + time.Sleep(1 * time.Millisecond) + } + }) + + // Wait for both goroutines to complete + wg.Wait() + + // Verify final state is valid + token, valid := cache.get() + Expect(valid).To(BeTrue()) + Expect(token).To(HavePrefix("token-")) + }) + }) +}) + +// createTestJWT creates a valid JWT token for testing purposes +func createTestJWT(expiresIn time.Duration) string { + token, err := jwt.NewBuilder(). + Expiration(time.Now().Add(expiresIn)). + Build() + if err != nil { + panic(fmt.Sprintf("failed to create test JWT: %v", err)) + } + signed, err := jwt.Sign(token, jwt.WithInsecureNoSignature()) + if err != nil { + panic(fmt.Sprintf("failed to sign test JWT: %v", err)) + } + return string(signed) +} diff --git a/adapters/deezer/client_test.go b/adapters/deezer/client_test.go new file mode 100644 index 000000000..9fa7afdd9 --- /dev/null +++ b/adapters/deezer/client_test.go @@ -0,0 +1,210 @@ +package deezer + +import ( + "bytes" + "fmt" + "io" + "net/http" + "os" + "time" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("client", func() { + var httpClient *fakeHttpClient + var client *client + + BeforeEach(func() { + httpClient = &fakeHttpClient{} + client = newClient(httpClient) + }) + + Describe("ArtistImages", func() { + It("returns artist images from a successful request", func() { + f, err := os.Open("tests/fixtures/deezer.search.artist.json") + Expect(err).To(BeNil()) + httpClient.mock("https://api.deezer.com/search/artist", http.Response{Body: f, StatusCode: 200}) + + artists, err := client.searchArtists(GinkgoT().Context(), "Michael Jackson", 20) + Expect(err).To(BeNil()) + Expect(artists).To(HaveLen(17)) + Expect(artists[0].Name).To(Equal("Michael Jackson")) + Expect(artists[0].PictureXl).To(Equal("https://cdn-images.dzcdn.net/images/artist/97fae13b2b30e4aec2e8c9e0c7839d92/1000x1000-000000-80-0-0.jpg")) + }) + + It("fails if artist was not found", func() { + httpClient.mock("https://api.deezer.com/search/artist", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(`{"data":[],"total":0}`)), + }) + + _, err := client.searchArtists(GinkgoT().Context(), "Michael Jackson", 20) + Expect(err).To(MatchError(ErrNotFound)) + }) + }) + + Describe("TopTracks", func() { + It("returns top tracks with artist and album info from a successful request", func() { + f, err := os.Open("tests/fixtures/deezer.artist.top.json") + Expect(err).To(BeNil()) + httpClient.mock("https://api.deezer.com/artist/27/top", http.Response{Body: f, StatusCode: 200}) + + tracks, err := client.getTopTracks(GinkgoT().Context(), 27, 5) + Expect(err).To(BeNil()) + Expect(tracks).To(HaveLen(5)) + + // Verify first track has all expected fields + Expect(tracks[0].Title).To(Equal("Instant Crush (feat. Julian Casablancas)")) + Expect(tracks[0].Artist.Name).To(Equal("Daft Punk")) + Expect(tracks[0].Album.Title).To(Equal("Random Access Memories")) + + // Verify second track + Expect(tracks[1].Title).To(Equal("One More Time")) + Expect(tracks[1].Artist.Name).To(Equal("Daft Punk")) + Expect(tracks[1].Album.Title).To(Equal("Discovery")) + }) + }) + + Describe("ArtistBio", func() { + BeforeEach(func() { + // Mock the JWT token endpoint with a valid JWT that expires in 5 minutes + testJWT := createTestJWT(5 * time.Minute) + httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(fmt.Sprintf(`{"jwt":"%s","refresh_token":""}`, testJWT))), + }) + }) + + It("returns artist bio from a successful request", func() { + f, err := os.Open("tests/fixtures/deezer.artist.bio.en.json") + Expect(err).To(BeNil()) + httpClient.mock("https://pipe.deezer.com/api", http.Response{Body: f, StatusCode: 200}) + + bio, err := client.getArtistBio(GinkgoT().Context(), 27, "en") + Expect(err).To(BeNil()) + Expect(bio).To(ContainSubstring("Schoolmates Thomas and Guy-Manuel")) + Expect(bio).ToNot(ContainSubstring("

")) + Expect(bio).ToNot(ContainSubstring("

")) + }) + + It("uses the provided language", func() { + f, err := os.Open("tests/fixtures/deezer.artist.bio.fr.json") + Expect(err).To(BeNil()) + httpClient.mock("https://pipe.deezer.com/api", http.Response{Body: f, StatusCode: 200}) + + _, err = client.getArtistBio(GinkgoT().Context(), 27, "fr") + Expect(err).To(BeNil()) + Expect(httpClient.lastRequest.Header.Get("Accept-Language")).To(Equal("fr")) + }) + + It("includes the JWT token in the request", func() { + f, err := os.Open("tests/fixtures/deezer.artist.bio.en.json") + Expect(err).To(BeNil()) + httpClient.mock("https://pipe.deezer.com/api", http.Response{Body: f, StatusCode: 200}) + + _, err = client.getArtistBio(GinkgoT().Context(), 27, "en") + Expect(err).To(BeNil()) + // Verify that the Authorization header has the Bearer token format + authHeader := httpClient.lastRequest.Header.Get("Authorization") + Expect(authHeader).To(HavePrefix("Bearer ")) + Expect(len(authHeader)).To(BeNumerically(">", 20)) // JWT tokens are longer than 20 chars + }) + + It("handles GraphQL errors", func() { + errorResponse := `{ + "data": { + "artist": { + "bio": { + "full": "" + } + } + }, + "errors": [ + { + "message": "Artist not found" + }, + { + "message": "Invalid artist ID" + } + ] + }` + httpClient.mock("https://pipe.deezer.com/api", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(errorResponse)), + }) + + _, err := client.getArtistBio(GinkgoT().Context(), 999, "en") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("GraphQL error")) + Expect(err.Error()).To(ContainSubstring("Artist not found")) + Expect(err.Error()).To(ContainSubstring("Invalid artist ID")) + }) + + It("handles empty biography", func() { + emptyBioResponse := `{ + "data": { + "artist": { + "bio": { + "full": "" + } + } + } + }` + httpClient.mock("https://pipe.deezer.com/api", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(emptyBioResponse)), + }) + + _, err := client.getArtistBio(GinkgoT().Context(), 27, "en") + Expect(err).To(MatchError("deezer: biography not found")) + }) + + It("handles JWT token fetch failure", func() { + httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ + StatusCode: 500, + Body: io.NopCloser(bytes.NewBufferString(`{"error":"Internal server error"}`)), + }) + + _, err := client.getArtistBio(GinkgoT().Context(), 27, "en") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("failed to get JWT")) + }) + + It("handles JWT token that expires too soon", func() { + // Create a JWT that expires in 30 seconds (less than the 1-minute buffer) + expiredJWT := createTestJWT(30 * time.Second) + httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(fmt.Sprintf(`{"jwt":"%s","refresh_token":""}`, expiredJWT))), + }) + + _, err := client.getArtistBio(GinkgoT().Context(), 27, "en") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("JWT token already expired or expires too soon")) + }) + }) +}) + +type fakeHttpClient struct { + responses map[string]*http.Response + lastRequest *http.Request +} + +func (c *fakeHttpClient) mock(url string, response http.Response) { + if c.responses == nil { + c.responses = make(map[string]*http.Response) + } + c.responses[url] = &response +} + +func (c *fakeHttpClient) Do(req *http.Request) (*http.Response, error) { + c.lastRequest = req + u := req.URL + u.RawQuery = "" + if resp, ok := c.responses[u.String()]; ok { + return resp, nil + } + panic("URL not mocked: " + u.String()) +} diff --git a/core/agents/deezer/deezer.go b/adapters/deezer/deezer.go similarity index 53% rename from core/agents/deezer/deezer.go rename to adapters/deezer/deezer.go index 8cabfbcfb..ed3071766 100644 --- a/core/agents/deezer/deezer.go +++ b/adapters/deezer/deezer.go @@ -3,6 +3,7 @@ package deezer import ( "context" "errors" + "fmt" "net/http" "strings" @@ -12,6 +13,7 @@ import ( "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/utils/cache" + "github.com/navidrome/navidrome/utils/slice" ) const deezerAgentName = "deezer" @@ -24,10 +26,14 @@ const deezerArtistSearchLimit = 50 type deezerAgent struct { dataStore model.DataStore client *client + languages []string } func deezerConstructor(dataStore model.DataStore) agents.Interface { - agent := &deezerAgent{dataStore: dataStore} + agent := &deezerAgent{ + dataStore: dataStore, + languages: conf.Server.Deezer.Languages, + } httpClient := &http.Client{ Timeout: consts.DefaultHttpClientTimeOut, } @@ -81,13 +87,82 @@ func (s *deezerAgent) searchArtist(ctx context.Context, name string) (*Artist, e return nil, err } + log.Trace(ctx, "Artists found", "count", len(artists), "searched_name", name) + for i := range artists { + log.Trace(ctx, fmt.Sprintf("Artists found #%d", i), "name", artists[i].Name, "id", artists[i].ID, "link", artists[i].Link) + if i > 2 { + break + } + } + // If the first one has the same name, that's the one if !strings.EqualFold(artists[0].Name, name) { + log.Trace(ctx, "Top artist do not match", "searched_name", name, "found_name", artists[0].Name) return nil, agents.ErrNotFound } + log.Trace(ctx, "Found artist", "name", artists[0].Name, "id", artists[0].ID, "link", artists[0].Link) return &artists[0], err } +func (s *deezerAgent) GetSimilarArtists(ctx context.Context, _, name, _ string, limit int) ([]agents.Artist, error) { + artist, err := s.searchArtist(ctx, name) + if err != nil { + return nil, err + } + + related, err := s.client.getRelatedArtists(ctx, artist.ID) + if err != nil { + return nil, err + } + + res := slice.Map(related, func(r Artist) agents.Artist { + return agents.Artist{ + Name: r.Name, + } + }) + if len(res) > limit { + res = res[:limit] + } + return res, nil +} + +func (s *deezerAgent) GetArtistTopSongs(ctx context.Context, _, artistName, _ string, count int) ([]agents.Song, error) { + artist, err := s.searchArtist(ctx, artistName) + if err != nil { + return nil, err + } + + tracks, err := s.client.getTopTracks(ctx, artist.ID, count) + if err != nil { + return nil, err + } + + res := slice.Map(tracks, func(r Track) agents.Song { + return agents.Song{ + Name: r.Title, + Album: r.Album.Title, + Duration: uint32(r.Duration * 1000), // Convert seconds to milliseconds + } + }) + return res, nil +} + +func (s *deezerAgent) GetArtistBiography(ctx context.Context, _, name, _ string) (string, error) { + artist, err := s.searchArtist(ctx, name) + if err != nil { + return "", err + } + + for _, lang := range s.languages { + bio, err := s.client.getArtistBio(ctx, artist.ID, lang) + if err == nil && bio != "" { + return bio, nil + } + log.Debug(ctx, "Deezer/artist.bio returned empty/error, trying next language", "artist", name, "lang", lang, err) + } + return "", agents.ErrNotFound +} + func init() { conf.AddHook(func() { if conf.Server.Deezer.Enabled { diff --git a/core/agents/deezer/deezer_suite_test.go b/adapters/deezer/deezer_suite_test.go similarity index 100% rename from core/agents/deezer/deezer_suite_test.go rename to adapters/deezer/deezer_suite_test.go diff --git a/adapters/deezer/deezer_test.go b/adapters/deezer/deezer_test.go new file mode 100644 index 000000000..4dd251585 --- /dev/null +++ b/adapters/deezer/deezer_test.go @@ -0,0 +1,171 @@ +package deezer + +import ( + "bytes" + "context" + "fmt" + "io" + "net/http" + "os" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/core/agents" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("deezerAgent", func() { + var ctx context.Context + + BeforeEach(func() { + ctx = context.Background() + DeferCleanup(configtest.SetupConfig()) + conf.Server.Deezer.Enabled = true + }) + + Describe("deezerConstructor", func() { + It("uses configured languages", func() { + conf.Server.Deezer.Languages = []string{"pt", "en"} + agent := deezerConstructor(&tests.MockDataStore{}).(*deezerAgent) + Expect(agent.languages).To(Equal([]string{"pt", "en"})) + }) + }) + + Describe("GetArtistBiography - Language Fallback", func() { + var agent *deezerAgent + var httpClient *langAwareHttpClient + + BeforeEach(func() { + httpClient = newLangAwareHttpClient() + + // Mock search artist (returns Michael Jackson) + fSearch, _ := os.Open("tests/fixtures/deezer.search.artist.json") + httpClient.searchResponse = &http.Response{Body: fSearch, StatusCode: 200} + + // Mock JWT token + testJWT := createTestJWT(5 * time.Minute) + httpClient.jwtResponse = &http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(fmt.Sprintf(`{"jwt":"%s","refresh_token":""}`, testJWT))), + } + }) + + setupAgent := func(languages []string) { + conf.Server.Deezer.Languages = languages + agent = &deezerAgent{ + dataStore: &tests.MockDataStore{}, + client: newClient(httpClient), + languages: languages, + } + } + + It("returns content in first language when available (1 bio API call)", func() { + setupAgent([]string{"fr", "en"}) + + // French biography available + fFr, _ := os.Open("tests/fixtures/deezer.artist.bio.fr.json") + httpClient.bioResponses["fr"] = &http.Response{Body: fFr, StatusCode: 200} + + bio, err := agent.GetArtistBiography(ctx, "", "Michael Jackson", "") + + Expect(err).ToNot(HaveOccurred()) + Expect(bio).To(ContainSubstring("Guy-Manuel de Homem Christo et Thomas Bangalter")) + Expect(httpClient.bioRequestCount).To(Equal(1)) + Expect(httpClient.bioRequests[0].Header.Get("Accept-Language")).To(Equal("fr")) + }) + + It("falls back to second language when first returns empty (2 bio API calls)", func() { + setupAgent([]string{"ja", "en"}) + + // Japanese returns empty biography + fJa, _ := os.Open("tests/fixtures/deezer.artist.bio.empty.json") + httpClient.bioResponses["ja"] = &http.Response{Body: fJa, StatusCode: 200} + // English returns full biography + fEn, _ := os.Open("tests/fixtures/deezer.artist.bio.en.json") + httpClient.bioResponses["en"] = &http.Response{Body: fEn, StatusCode: 200} + + bio, err := agent.GetArtistBiography(ctx, "", "Michael Jackson", "") + + Expect(err).ToNot(HaveOccurred()) + Expect(bio).To(ContainSubstring("Schoolmates Thomas and Guy-Manuel")) + Expect(httpClient.bioRequestCount).To(Equal(2)) + Expect(httpClient.bioRequests[0].Header.Get("Accept-Language")).To(Equal("ja")) + Expect(httpClient.bioRequests[1].Header.Get("Accept-Language")).To(Equal("en")) + }) + + It("returns ErrNotFound when all languages return empty", func() { + setupAgent([]string{"ja", "xx"}) + + // Both languages return empty biography + fJa, _ := os.Open("tests/fixtures/deezer.artist.bio.empty.json") + httpClient.bioResponses["ja"] = &http.Response{Body: fJa, StatusCode: 200} + fXx, _ := os.Open("tests/fixtures/deezer.artist.bio.empty.json") + httpClient.bioResponses["xx"] = &http.Response{Body: fXx, StatusCode: 200} + + _, err := agent.GetArtistBiography(ctx, "", "Michael Jackson", "") + + Expect(err).To(MatchError(agents.ErrNotFound)) + Expect(httpClient.bioRequestCount).To(Equal(2)) + }) + }) +}) + +// langAwareHttpClient is a mock HTTP client that returns different responses based on the Accept-Language header +type langAwareHttpClient struct { + searchResponse *http.Response + jwtResponse *http.Response + bioResponses map[string]*http.Response + bioRequests []*http.Request + bioRequestCount int +} + +func newLangAwareHttpClient() *langAwareHttpClient { + return &langAwareHttpClient{ + bioResponses: make(map[string]*http.Response), + bioRequests: make([]*http.Request, 0), + } +} + +func (c *langAwareHttpClient) Do(req *http.Request) (*http.Response, error) { + // Handle search artist request + if req.URL.Host == "api.deezer.com" && req.URL.Path == "/search/artist" { + if c.searchResponse != nil { + return c.searchResponse, nil + } + return &http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(`{"data":[],"total":0}`)), + }, nil + } + + // Handle JWT token request + if req.URL.Host == "auth.deezer.com" && req.URL.Path == "/login/anonymous" { + if c.jwtResponse != nil { + return c.jwtResponse, nil + } + return &http.Response{ + StatusCode: 500, + Body: io.NopCloser(bytes.NewBufferString(`{"error":"no mock"}`)), + }, nil + } + + // Handle bio request (GraphQL API) + if req.URL.Host == "pipe.deezer.com" && req.URL.Path == "/api" { + c.bioRequestCount++ + c.bioRequests = append(c.bioRequests, req) + lang := req.Header.Get("Accept-Language") + if resp, ok := c.bioResponses[lang]; ok { + return resp, nil + } + // Return empty bio by default + return &http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(`{"data":{"artist":{"bio":{"full":""}}}}`)), + }, nil + } + + panic("URL not mocked: " + req.URL.String()) +} diff --git a/adapters/deezer/responses.go b/adapters/deezer/responses.go new file mode 100644 index 000000000..266c44c62 --- /dev/null +++ b/adapters/deezer/responses.go @@ -0,0 +1,66 @@ +package deezer + +type SearchArtistResults struct { + Data []Artist `json:"data"` + Total int `json:"total"` + Next string `json:"next"` +} + +type Artist struct { + ID int `json:"id"` + Name string `json:"name"` + Link string `json:"link"` + Picture string `json:"picture"` + PictureSmall string `json:"picture_small"` + PictureMedium string `json:"picture_medium"` + PictureBig string `json:"picture_big"` + PictureXl string `json:"picture_xl"` + NbAlbum int `json:"nb_album"` + NbFan int `json:"nb_fan"` + Radio bool `json:"radio"` + Tracklist string `json:"tracklist"` + Type string `json:"type"` +} + +type Error struct { + Error struct { + Type string `json:"type"` + Message string `json:"message"` + Code int `json:"code"` + } `json:"error"` +} + +type RelatedArtists struct { + Data []Artist `json:"data"` + Total int `json:"total"` +} + +type TopTracks struct { + Data []Track `json:"data"` + Total int `json:"total"` + Next string `json:"next"` +} + +type Track struct { + ID int `json:"id"` + Title string `json:"title"` + Link string `json:"link"` + Duration int `json:"duration"` + Rank int `json:"rank"` + Preview string `json:"preview"` + Artist Artist `json:"artist"` + Album Album `json:"album"` + Contributors []Artist `json:"contributors"` +} + +type Album struct { + ID int `json:"id"` + Title string `json:"title"` + Cover string `json:"cover"` + CoverSmall string `json:"cover_small"` + CoverMedium string `json:"cover_medium"` + CoverBig string `json:"cover_big"` + CoverXl string `json:"cover_xl"` + Tracklist string `json:"tracklist"` + Type string `json:"type"` +} diff --git a/core/agents/deezer/responses_test.go b/adapters/deezer/responses_test.go similarity index 53% rename from core/agents/deezer/responses_test.go rename to adapters/deezer/responses_test.go index 95a7f43f4..a9de5c5fb 100644 --- a/core/agents/deezer/responses_test.go +++ b/adapters/deezer/responses_test.go @@ -35,4 +35,35 @@ var _ = Describe("Responses", func() { Expect(errorResp.Error.Message).To(Equal("Missing parameters: q")) }) }) + + Describe("Related Artists", func() { + It("parses the related artists response correctly", func() { + var resp RelatedArtists + body, err := os.ReadFile("tests/fixtures/deezer.artist.related.json") + Expect(err).To(BeNil()) + err = json.Unmarshal(body, &resp) + Expect(err).To(BeNil()) + + Expect(resp.Data).To(HaveLen(20)) + justice := resp.Data[0] + Expect(justice.Name).To(Equal("Justice")) + Expect(justice.ID).To(Equal(6404)) + }) + }) + + Describe("Top Tracks", func() { + It("parses the top tracks response correctly", func() { + var resp TopTracks + body, err := os.ReadFile("tests/fixtures/deezer.artist.top.json") + Expect(err).To(BeNil()) + err = json.Unmarshal(body, &resp) + Expect(err).To(BeNil()) + + Expect(resp.Data).To(HaveLen(5)) + track := resp.Data[0] + Expect(track.Title).To(Equal("Instant Crush (feat. Julian Casablancas)")) + Expect(track.ID).To(Equal(67238732)) + Expect(track.Album.Title).To(Equal("Random Access Memories")) + }) + }) }) diff --git a/adapters/gotaglib/end_to_end_test.go b/adapters/gotaglib/end_to_end_test.go new file mode 100644 index 000000000..4a93f5b83 --- /dev/null +++ b/adapters/gotaglib/end_to_end_test.go @@ -0,0 +1,274 @@ +package gotaglib + +import ( + "io/fs" + "os" + "time" + + "github.com/djherbis/times" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/metadata" + "github.com/navidrome/navidrome/utils/gg" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +type testFileInfo struct { + fs.FileInfo +} + +func (t testFileInfo) BirthTime() time.Time { + if ts := times.Get(t.FileInfo); ts.HasBirthTime() { + return ts.BirthTime() + } + return t.FileInfo.ModTime() +} + +var _ = Describe("Extractor", func() { + toP := func(name, sortName, mbid string) model.Participant { + return model.Participant{ + Artist: model.Artist{Name: name, SortArtistName: sortName, MbzArtistID: mbid}, + } + } + + roles := []struct { + model.Role + model.ParticipantList + }{ + {model.RoleComposer, model.ParticipantList{ + toP("coma a", "a, coma", "bf13b584-f27c-43db-8f42-32898d33d4e2"), + toP("comb", "comb", "924039a2-09c6-4d29-9b4f-50cc54447d36"), + }}, + {model.RoleLyricist, model.ParticipantList{ + toP("la a", "a, la", "c84f648f-68a6-40a2-a0cb-d135b25da3c2"), + toP("lb", "lb", "0a7c582d-143a-4540-b4e9-77200835af65"), + }}, + {model.RoleArranger, model.ParticipantList{ + toP("aa", "", "4605a1d4-8d15-42a3-bd00-9c20e42f71e6"), + toP("ab", "", "002f0ff8-77bf-42cc-8216-61a9c43dc145"), + }}, + {model.RoleConductor, model.ParticipantList{ + toP("cona", "", "af86879b-2141-42af-bad2-389a4dc91489"), + toP("conb", "", "3dfa3c70-d7d3-4b97-b953-c298dd305e12"), + }}, + {model.RoleDirector, model.ParticipantList{ + toP("dia", "", "f943187f-73de-4794-be47-88c66f0fd0f4"), + toP("dib", "", "bceb75da-1853-4b3d-b399-b27f0cafc389"), + }}, + {model.RoleEngineer, model.ParticipantList{ + toP("ea", "", "f634bf6d-d66a-425d-888a-28ad39392759"), + toP("eb", "", "243d64ae-d514-44e1-901a-b918d692baee"), + }}, + {model.RoleProducer, model.ParticipantList{ + toP("pra", "", "d971c8d7-999c-4a5f-ac31-719721ab35d6"), + toP("prb", "", "f0a09070-9324-434f-a599-6d25ded87b69"), + }}, + {model.RoleRemixer, model.ParticipantList{ + toP("ra", "", "c7dc6095-9534-4c72-87cc-aea0103462cf"), + toP("rb", "", "8ebeef51-c08c-4736-992f-c37870becedd"), + }}, + {model.RoleDJMixer, model.ParticipantList{ + toP("dja", "", "d063f13b-7589-4efc-ab7f-c60e6db17247"), + toP("djb", "", "3636670c-385f-4212-89c8-0ff51d6bc456"), + }}, + {model.RoleMixer, model.ParticipantList{ + toP("ma", "", "53fb5a2d-7016-427e-a563-d91819a5f35a"), + toP("mb", "", "64c13e65-f0da-4ab9-a300-71ee53b0376a"), + }}, + } + + var e *extractor + + parseTestFile := func(path string) *model.MediaFile { + mds, err := e.Parse(path) + Expect(err).ToNot(HaveOccurred()) + + info, ok := mds[path] + Expect(ok).To(BeTrue()) + + fileInfo, err := os.Stat(path) + Expect(err).ToNot(HaveOccurred()) + info.FileInfo = testFileInfo{FileInfo: fileInfo} + + metadata := metadata.New(path, info) + mf := metadata.ToMediaFile(1, "folderID") + return &mf + } + + BeforeEach(func() { + e = &extractor{fs: os.DirFS(".")} + }) + + Describe("ReplayGain", func() { + DescribeTable("test replaygain end-to-end", func(file string, trackGain, trackPeak, albumGain, albumPeak *float64) { + mf := parseTestFile("tests/fixtures/" + file) + + Expect(mf.RGTrackGain).To(Equal(trackGain)) + Expect(mf.RGTrackPeak).To(Equal(trackPeak)) + Expect(mf.RGAlbumGain).To(Equal(albumGain)) + Expect(mf.RGAlbumPeak).To(Equal(albumPeak)) + }, + Entry("mp3 with no replaygain", "no_replaygain.mp3", nil, nil, nil, nil), + Entry("mp3 with no zero replaygain", "zero_replaygain.mp3", gg.P(0.0), gg.P(1.0), gg.P(0.0), gg.P(1.0)), + ) + }) + + Describe("lyrics", func() { + makeLyrics := func(code, secondLine string) model.Lyrics { + return model.Lyrics{ + DisplayArtist: "", + DisplayTitle: "", + Lang: code, + Line: []model.Line{ + {Start: gg.P(int64(0)), Value: "This is"}, + {Start: gg.P(int64(2500)), Value: secondLine}, + }, + Offset: nil, + Synced: true, + } + } + + It("should fetch both synced and unsynced lyrics in mixed flac", func() { + mf := parseTestFile("tests/fixtures/mixed-lyrics.flac") + + lyrics, err := mf.StructuredLyrics() + Expect(err).ToNot(HaveOccurred()) + Expect(lyrics).To(HaveLen(2)) + + Expect(lyrics[0].Synced).To(BeTrue()) + Expect(lyrics[1].Synced).To(BeFalse()) + }) + + It("should handle mp3 with uslt and sylt", func() { + mf := parseTestFile("tests/fixtures/test.mp3") + + lyrics, err := mf.StructuredLyrics() + Expect(err).ToNot(HaveOccurred()) + Expect(lyrics).To(HaveLen(4)) + + engSylt := makeLyrics("eng", "English SYLT") + engUslt := makeLyrics("eng", "English") + unsSylt := makeLyrics("xxx", "unspecified SYLT") + unsUslt := makeLyrics("xxx", "unspecified") + + Expect(lyrics).To(ConsistOf(engSylt, engUslt, unsSylt, unsUslt)) + }) + + DescribeTable("format-specific lyrics", func(file string, isId3 bool) { + mf := parseTestFile("tests/fixtures/" + file) + + lyrics, err := mf.StructuredLyrics() + Expect(err).To(Not(HaveOccurred())) + Expect(lyrics).To(HaveLen(2)) + + unspec := makeLyrics("xxx", "unspecified") + eng := makeLyrics("xxx", "English") + + if isId3 { + eng.Lang = "eng" + } + + Expect(lyrics).To(Or( + Equal(model.LyricList{unspec, eng}), + Equal(model.LyricList{eng, unspec}))) + }, + Entry("flac", "test.flac", false), + Entry("m4a", "test.m4a", false), + Entry("ogg", "test.ogg", false), + Entry("wma", "test.wma", false), + Entry("wv", "test.wv", false), + Entry("wav", "test.wav", true), + Entry("aiff", "test.aiff", true), + ) + }) + + Describe("Participants", func() { + DescribeTable("test tags consistent across formats", func(format string) { + mf := parseTestFile("tests/fixtures/test." + format) + + for _, data := range roles { + role := data.Role + artists := data.ParticipantList + + actual := mf.Participants[role] + Expect(actual).To(HaveLen(len(artists))) + + for i := range artists { + actualArtist := actual[i] + expectedArtist := artists[i] + + Expect(actualArtist.Name).To(Equal(expectedArtist.Name)) + Expect(actualArtist.SortArtistName).To(Equal(expectedArtist.SortArtistName)) + Expect(actualArtist.MbzArtistID).To(Equal(expectedArtist.MbzArtistID)) + } + } + + if format != "m4a" { + performers := mf.Participants[model.RolePerformer] + Expect(performers).To(HaveLen(8)) + + rules := map[string][]string{ + "pgaa": {"2fd0b311-9fa8-4ff9-be5d-f6f3d16b835e", "Guitar"}, + "pgbb": {"223d030b-bf97-4c2a-ad26-b7f7bbe25c93", "Guitar", ""}, + "pvaa": {"cb195f72-448f-41c8-b962-3f3c13d09d38", "Vocals"}, + "pvbb": {"60a1f832-8ca2-49f6-8660-84d57f07b520", "Vocals", "Flute"}, + "pfaa": {"51fb40c-0305-4bf9-a11b-2ee615277725", "", "Flute"}, + } + + for name, rule := range rules { + mbid := rule[0] + for i := 1; i < len(rule); i++ { + found := false + + for _, mapped := range performers { + if mapped.Name == name && mapped.MbzArtistID == mbid && mapped.SubRole == rule[i] { + found = true + break + } + } + + Expect(found).To(BeTrue(), "Could not find matching artist") + } + } + } + }, + Entry("FLAC format", "flac"), + Entry("M4a format", "m4a"), + Entry("OGG format", "ogg"), + Entry("WV format", "wv"), + + Entry("MP3 format", "mp3"), + Entry("WAV format", "wav"), + Entry("AIFF format", "aiff"), + ) + + It("should parse wma", func() { + mf := parseTestFile("tests/fixtures/test.wma") + + for _, data := range roles { + role := data.Role + artists := data.ParticipantList + actual := mf.Participants[role] + + // WMA has no Arranger role + if role == model.RoleArranger { + Expect(actual).To(HaveLen(0)) + continue + } + + Expect(actual).To(HaveLen(len(artists)), role.String()) + + // For some bizarre reason, the order is inverted. We also don't get + // sort names or MBIDs + for i := range artists { + idx := len(artists) - 1 - i + + actualArtist := actual[i] + expectedArtist := artists[idx] + + Expect(actualArtist.Name).To(Equal(expectedArtist.Name)) + } + } + }) + }) +}) diff --git a/adapters/gotaglib/gotaglib.go b/adapters/gotaglib/gotaglib.go new file mode 100644 index 000000000..7ea98a442 --- /dev/null +++ b/adapters/gotaglib/gotaglib.go @@ -0,0 +1,301 @@ +// Package gotaglib provides an alternative metadata extractor using go-taglib, +// a pure Go (WASM-based) implementation of TagLib. +// +// This extractor aims for parity with the CGO-based taglib extractor. It uses +// TagLib's PropertyMap interface for standard tags. The File handle API provides +// efficient access to format-specific tags (ID3v2 frames, MP4 atoms, ASF attributes) +// through a single file open operation. +// +// This extractor is registered under the name "taglib". It only works with a filesystem +// (fs.FS) and does not support direct local file paths. Files returned by the filesystem +// must implement io.ReadSeeker for go-taglib to read them. +package gotaglib + +import ( + "errors" + "fmt" + "io" + "io/fs" + "runtime/debug" + "strings" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/core/storage/local" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model/metadata" + "go.senan.xyz/taglib" +) + +type extractor struct { + fs fs.FS +} + +func (e extractor) Parse(files ...string) (map[string]metadata.Info, error) { + results := make(map[string]metadata.Info) + for _, path := range files { + props, err := e.extractMetadata(path) + if err != nil { + continue + } + results[path] = *props + } + return results, nil +} + +func (e extractor) Version() string { + bi, ok := debug.ReadBuildInfo() + if ok { + for _, dep := range bi.Deps { + if dep.Path == "go.senan.xyz/taglib" { + if dep.Replace != nil { + return dep.Replace.Version + } + return dep.Version + } + } + } + return "unknown" +} + +func (e extractor) extractMetadata(filePath string) (info *metadata.Info, err error) { + // Recover from panics in the WASM runtime that can occur during any taglib + // operation (opening, reading tags, or reading properties). This catches crashes + // from malformed files or WASM runtime issues (e.g., wazero mmap failures on + // hardened systems with MemoryDenyWriteExecute=true). + debug.SetPanicOnFault(true) + defer func() { + if r := recover(); r != nil { + log.Error("gotaglib: WASM runtime panic reading file. Skipping", "filePath", filePath, "panic", r) + debug.PrintStack() + err = fmt.Errorf("WASM runtime panic: %v", r) + } + }() + + f, close, err := e.openFile(filePath) + if err != nil { + log.Warn("gotaglib: Error reading metadata from file. Skipping", "filePath", filePath, err) + return nil, err + } + defer close() + + // Get all tags and properties in one go + allTags := f.AllTags() + props := f.Properties() + + // Map properties to AudioProperties + ap := metadata.AudioProperties{ + Duration: props.Length.Round(time.Millisecond * 10), + BitRate: int(props.Bitrate), + Channels: int(props.Channels), + SampleRate: int(props.SampleRate), + BitDepth: int(props.BitsPerSample), + Codec: props.Codec, + } + + // Convert normalized tags to lowercase keys (go-taglib returns UPPERCASE keys) + normalizedTags := make(map[string][]string, len(allTags.Tags)) + for key, values := range allTags.Tags { + lowerKey := strings.ToLower(key) + normalizedTags[lowerKey] = values + } + + // Process format-specific raw tags + processRawTags(allTags, normalizedTags) + + // Parse track/disc totals from "N/Total" format + parseTuple(normalizedTags, "track") + parseTuple(normalizedTags, "disc") + + // Adjust some ID3 tags + parseLyrics(normalizedTags) + parseTIPL(normalizedTags) + delete(normalizedTags, "tmcl") // TMCL is already parsed by TagLib + + // Determine if file has embedded picture + hasPicture := len(props.Images) > 0 + + return &metadata.Info{ + Tags: normalizedTags, + AudioProperties: ap, + HasPicture: hasPicture, + }, nil +} + +// openFile opens the file at filePath using the extractor's filesystem. +// It returns a TagLib File handle and a cleanup function to close resources. +func (e extractor) openFile(filePath string) (f *taglib.File, closeFunc func(), err error) { + // Open the file from the filesystem + file, err := e.fs.Open(filePath) + if err != nil { + return nil, nil, err + } + rs, isSeekable := file.(io.ReadSeeker) + if !isSeekable { + file.Close() + return nil, nil, errors.New("file is not seekable") + } + // WithFilename provides a format detection hint via the file extension, + // since OpenStream alone relies on content-sniffing which fails for some files. + f, err = taglib.OpenStream(rs, + taglib.WithReadStyle(taglib.ReadStyleFast), + taglib.WithFilename(filePath), + ) + if err != nil { + file.Close() + return nil, nil, err + } + closeFunc = func() { + f.Close() + file.Close() + } + return f, closeFunc, nil +} + +// parseTuple parses track/disc numbers in "N/Total" format and separates them. +// For example, tracknumber="2/10" becomes tracknumber="2" and tracktotal="10". +func parseTuple(tags map[string][]string, prop string) { + tagName := prop + "number" + tagTotal := prop + "total" + if value, ok := tags[tagName]; ok && len(value) > 0 { + parts := strings.Split(value[0], "/") + tags[tagName] = []string{parts[0]} + if len(parts) == 2 { + tags[tagTotal] = []string{parts[1]} + } + } +} + +// parseLyrics ensures lyrics tags have a language code. +// If lyrics exist without a language code, they are moved to "lyrics:xxx". +func parseLyrics(tags map[string][]string) { + lyrics := tags["lyrics"] + if len(lyrics) > 0 { + tags["lyrics:xxx"] = lyrics + delete(tags, "lyrics") + } +} + +// processRawTags processes format-specific raw tags based on the detected file format. +// This handles ID3v2 frames (MP3/WAV/AIFF), MP4 atoms, and ASF attributes. +func processRawTags(allTags taglib.AllTags, normalizedTags map[string][]string) { + switch allTags.Format { + case taglib.FormatMPEG, taglib.FormatWAV, taglib.FormatAIFF: + parseID3v2Frames(allTags.Raw, normalizedTags) + case taglib.FormatMP4: + parseMP4Atoms(allTags.Raw, normalizedTags) + case taglib.FormatASF: + parseASFAttributes(allTags.Raw, normalizedTags) + } +} + +// parseID3v2Frames processes ID3v2 raw frames to extract USLT/SYLT with language codes. +// This extracts language-specific lyrics that the standard Tags() doesn't provide. +func parseID3v2Frames(rawFrames map[string][]string, tags map[string][]string) { + // Process frames that have language-specific data + for key, values := range rawFrames { + lowerKey := strings.ToLower(key) + + // Handle USLT:xxx and SYLT:xxx (lyrics with language codes) + if strings.HasPrefix(lowerKey, "uslt:") || strings.HasPrefix(lowerKey, "sylt:") { + parts := strings.SplitN(lowerKey, ":", 2) + if len(parts) == 2 && parts[1] != "" { + lang := parts[1] + lyricsKey := "lyrics:" + lang + tags[lyricsKey] = append(tags[lyricsKey], values...) + } + } + } + + // If we found any language-specific lyrics from ID3v2 frames, remove the generic lyrics + for key := range tags { + if strings.HasPrefix(key, "lyrics:") && key != "lyrics" { + delete(tags, "lyrics") + break + } + } +} + +const iTunesKeyPrefix = "----:com.apple.iTunes:" + +// parseMP4Atoms processes MP4 raw atoms to get iTunes-specific tags. +func parseMP4Atoms(rawAtoms map[string][]string, tags map[string][]string) { + // Process all atoms and add them to tags + for key, values := range rawAtoms { + // Strip iTunes prefix and convert to lowercase + normalizedKey := strings.TrimPrefix(key, iTunesKeyPrefix) + normalizedKey = strings.ToLower(normalizedKey) + + // Only add if the tag doesn't already exist (avoid duplication with PropertyMap) + if _, exists := tags[normalizedKey]; !exists { + tags[normalizedKey] = values + } + } +} + +// parseASFAttributes processes ASF raw attributes to get WMA-specific tags. +func parseASFAttributes(rawAttrs map[string][]string, tags map[string][]string) { + // Process all attributes and add them to tags + for key, values := range rawAttrs { + normalizedKey := strings.ToLower(key) + + // Only add if the tag doesn't already exist (avoid duplication with PropertyMap) + if _, exists := tags[normalizedKey]; !exists { + tags[normalizedKey] = values + } + } +} + +// These are the only roles we support, based on Picard's tag map: +// https://picard-docs.musicbrainz.org/downloads/MusicBrainz_Picard_Tag_Map.html +var tiplMapping = map[string]string{ + "arranger": "arranger", + "engineer": "engineer", + "producer": "producer", + "mix": "mixer", + "DJ-mix": "djmixer", +} + +// parseTIPL parses the ID3v2.4 TIPL frame string, which is received from TagLib in the format: +// +// "arranger Andrew Powell engineer Chris Blair engineer Pat Stapley producer Eric Woolfson". +// +// and breaks it down into a map of roles and names, e.g.: +// +// {"arranger": ["Andrew Powell"], "engineer": ["Chris Blair", "Pat Stapley"], "producer": ["Eric Woolfson"]}. +func parseTIPL(tags map[string][]string) { + tipl := tags["tipl"] + if len(tipl) == 0 { + return + } + addRole := func(currentRole string, currentValue []string) { + if currentRole != "" && len(currentValue) > 0 { + role := tiplMapping[currentRole] + tags[role] = append(tags[role], strings.Join(currentValue, " ")) + } + } + var currentRole string + var currentValue []string + for part := range strings.SplitSeq(tipl[0], " ") { + if _, ok := tiplMapping[part]; ok { + addRole(currentRole, currentValue) + currentRole = part + currentValue = nil + continue + } + currentValue = append(currentValue, part) + } + addRole(currentRole, currentValue) + delete(tags, "tipl") +} + +var _ local.Extractor = (*extractor)(nil) + +func init() { + local.RegisterExtractor("taglib", func(fsys fs.FS, baseDir string) local.Extractor { + return &extractor{fsys} + }) + conf.AddHook(func() { + log.Debug("go-taglib version", "version", extractor{}.Version()) + }) +} diff --git a/adapters/gotaglib/gotaglib_suite_test.go b/adapters/gotaglib/gotaglib_suite_test.go new file mode 100644 index 000000000..cc7ddc471 --- /dev/null +++ b/adapters/gotaglib/gotaglib_suite_test.go @@ -0,0 +1,17 @@ +package gotaglib + +import ( + "testing" + + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestGoTagLib(t *testing.T) { + tests.Init(t, true) + log.SetLevel(log.LevelFatal) + RegisterFailHandler(Fail) + RunSpecs(t, "GoTagLib Suite") +} diff --git a/adapters/gotaglib/gotaglib_test.go b/adapters/gotaglib/gotaglib_test.go new file mode 100644 index 000000000..8fdf5b406 --- /dev/null +++ b/adapters/gotaglib/gotaglib_test.go @@ -0,0 +1,305 @@ +package gotaglib + +import ( + "io/fs" + "os" + "strings" + + "github.com/navidrome/navidrome/utils" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Extractor", func() { + var e *extractor + + BeforeEach(func() { + e = &extractor{fs: os.DirFS(".")} + }) + + Describe("Parse", func() { + It("correctly parses metadata from all files in folder", func() { + mds, err := e.Parse( + "tests/fixtures/test.mp3", + "tests/fixtures/test.ogg", + ) + Expect(err).NotTo(HaveOccurred()) + Expect(mds).To(HaveLen(2)) + + // Test MP3 + m := mds["tests/fixtures/test.mp3"] + Expect(m.Tags).To(HaveKeyWithValue("title", []string{"Song"})) + Expect(m.Tags).To(HaveKeyWithValue("album", []string{"Album"})) + Expect(m.Tags).To(HaveKeyWithValue("artist", []string{"Artist"})) + Expect(m.Tags).To(HaveKeyWithValue("albumartist", []string{"Album Artist"})) + + Expect(m.HasPicture).To(BeTrue()) + Expect(m.AudioProperties.Duration.String()).To(Equal("1.02s")) + Expect(m.AudioProperties.BitRate).To(Equal(192)) + Expect(m.AudioProperties.Channels).To(Equal(2)) + Expect(m.AudioProperties.SampleRate).To(Equal(44100)) + + Expect(m.Tags).To(Or( + HaveKeyWithValue("compilation", []string{"1"}), + HaveKeyWithValue("tcmp", []string{"1"})), + ) + Expect(m.Tags).To(HaveKeyWithValue("genre", []string{"Rock"})) + Expect(m.Tags).To(HaveKeyWithValue("date", []string{"2014-05-21"})) + Expect(m.Tags).To(HaveKeyWithValue("originaldate", []string{"1996-11-21"})) + Expect(m.Tags).To(HaveKeyWithValue("releasedate", []string{"2020-12-31"})) + Expect(m.Tags).To(HaveKeyWithValue("discnumber", []string{"1"})) + Expect(m.Tags).To(HaveKeyWithValue("disctotal", []string{"2"})) + Expect(m.Tags).To(HaveKeyWithValue("comment", []string{"Comment1\nComment2"})) + Expect(m.Tags).To(HaveKeyWithValue("bpm", []string{"123"})) + Expect(m.Tags).To(HaveKeyWithValue("replaygain_album_gain", []string{"+3.21518 dB"})) + Expect(m.Tags).To(HaveKeyWithValue("replaygain_album_peak", []string{"0.9125"})) + Expect(m.Tags).To(HaveKeyWithValue("replaygain_track_gain", []string{"-1.48 dB"})) + Expect(m.Tags).To(HaveKeyWithValue("replaygain_track_peak", []string{"0.4512"})) + + Expect(m.Tags).To(HaveKeyWithValue("tracknumber", []string{"2"})) + Expect(m.Tags).To(HaveKeyWithValue("tracktotal", []string{"10"})) + + Expect(m.Tags).ToNot(HaveKey("lyrics")) + Expect(m.Tags).To(Or(HaveKeyWithValue("lyrics:eng", []string{ + "[00:00.00]This is\n[00:02.50]English SYLT\n", + "[00:00.00]This is\n[00:02.50]English", + }), HaveKeyWithValue("lyrics:eng", []string{ + "[00:00.00]This is\n[00:02.50]English", + "[00:00.00]This is\n[00:02.50]English SYLT\n", + }))) + Expect(m.Tags).To(Or(HaveKeyWithValue("lyrics:xxx", []string{ + "[00:00.00]This is\n[00:02.50]unspecified SYLT\n", + "[00:00.00]This is\n[00:02.50]unspecified", + }), HaveKeyWithValue("lyrics:xxx", []string{ + "[00:00.00]This is\n[00:02.50]unspecified", + "[00:00.00]This is\n[00:02.50]unspecified SYLT\n", + }))) + + // Test OGG + m = mds["tests/fixtures/test.ogg"] + Expect(err).To(BeNil()) + Expect(m.Tags).To(HaveKeyWithValue("fbpm", []string{"141.7"})) + + // TagLib 1.12 returns 18, previous versions return 39. + // See https://github.com/taglib/taglib/commit/2f238921824741b2cfe6fbfbfc9701d9827ab06b + Expect(m.AudioProperties.BitRate).To(BeElementOf(18, 19, 39, 40, 43, 49)) + Expect(m.AudioProperties.Channels).To(BeElementOf(2)) + Expect(m.AudioProperties.SampleRate).To(BeElementOf(8000)) + Expect(m.HasPicture).To(BeTrue()) + }) + + DescribeTable("Format-Specific tests", + func(file, duration string, channels, samplerate, bitdepth int, albumGain, albumPeak, trackGain, trackPeak string, id3Lyrics bool, image bool) { + file = "tests/fixtures/" + file + mds, err := e.Parse(file) + Expect(err).NotTo(HaveOccurred()) + Expect(mds).To(HaveLen(1)) + + m := mds[file] + + Expect(m.HasPicture).To(Equal(image)) + Expect(m.AudioProperties.Duration.String()).To(Equal(duration)) + Expect(m.AudioProperties.Channels).To(Equal(channels)) + Expect(m.AudioProperties.SampleRate).To(Equal(samplerate)) + Expect(m.AudioProperties.BitDepth).To(Equal(bitdepth)) + + Expect(m.Tags).To(Or( + HaveKeyWithValue("replaygain_album_gain", []string{albumGain}), + HaveKeyWithValue("----:com.apple.itunes:replaygain_album_gain", []string{albumGain}), + )) + + Expect(m.Tags).To(Or( + HaveKeyWithValue("replaygain_album_peak", []string{albumPeak}), + HaveKeyWithValue("----:com.apple.itunes:replaygain_album_peak", []string{albumPeak}), + )) + Expect(m.Tags).To(Or( + HaveKeyWithValue("replaygain_track_gain", []string{trackGain}), + HaveKeyWithValue("----:com.apple.itunes:replaygain_track_gain", []string{trackGain}), + )) + Expect(m.Tags).To(Or( + HaveKeyWithValue("replaygain_track_peak", []string{trackPeak}), + HaveKeyWithValue("----:com.apple.itunes:replaygain_track_peak", []string{trackPeak}), + )) + + Expect(m.Tags).To(HaveKeyWithValue("title", []string{"Title"})) + Expect(m.Tags).To(HaveKeyWithValue("album", []string{"Album"})) + Expect(m.Tags).To(HaveKeyWithValue("artist", []string{"Artist"})) + Expect(m.Tags).To(HaveKeyWithValue("albumartist", []string{"Album Artist"})) + Expect(m.Tags).To(HaveKeyWithValue("genre", []string{"Rock"})) + Expect(m.Tags).To(HaveKeyWithValue("date", []string{"2014"})) + + Expect(m.Tags).To(HaveKeyWithValue("bpm", []string{"123"})) + Expect(m.Tags).To(Or( + HaveKeyWithValue("tracknumber", []string{"3"}), + HaveKeyWithValue("tracknumber", []string{"3/10"}), + )) + if !strings.HasSuffix(file, "test.wma") { + // TODO Not sure why this is not working for WMA + Expect(m.Tags).To(HaveKeyWithValue("tracktotal", []string{"10"})) + } + Expect(m.Tags).To(Or( + HaveKeyWithValue("discnumber", []string{"1"}), + HaveKeyWithValue("discnumber", []string{"1/2"}), + )) + Expect(m.Tags).To(HaveKeyWithValue("disctotal", []string{"2"})) + + // WMA does not have a "compilation" tag, but "wm/iscompilation" + Expect(m.Tags).To(Or( + HaveKeyWithValue("compilation", []string{"1"}), + HaveKeyWithValue("wm/iscompilation", []string{"1"})), + ) + + if id3Lyrics { + Expect(m.Tags).To(HaveKeyWithValue("lyrics:eng", []string{ + "[00:00.00]This is\n[00:02.50]English", + })) + Expect(m.Tags).To(HaveKeyWithValue("lyrics:xxx", []string{ + "[00:00.00]This is\n[00:02.50]unspecified", + })) + } else { + Expect(m.Tags).To(HaveKeyWithValue("lyrics:xxx", []string{ + "[00:00.00]This is\n[00:02.50]unspecified", + "[00:00.00]This is\n[00:02.50]English", + })) + } + + Expect(m.Tags).To(HaveKeyWithValue("comment", []string{"Comment1\nComment2"})) + }, + + // ffmpeg -f lavfi -i "sine=frequency=1200:duration=1" test.flac + Entry("correctly parses flac tags", "test.flac", "1s", 1, 44100, 16, "+4.06 dB", "0.12496948", "+4.06 dB", "0.12496948", false, true), + + Entry("correctly parses m4a (aac) gain tags", "01 Invisible (RED) Edit Version.m4a", "1.04s", 2, 44100, 16, "0.37", "0.48", "0.37", "0.48", false, true), + Entry("correctly parses m4a (aac) gain tags (uppercase)", "test.m4a", "1.04s", 2, 44100, 16, "0.37", "0.48", "0.37", "0.48", false, true), + Entry("correctly parses ogg (vorbis) tags", "test.ogg", "1.04s", 2, 8000, 0, "+7.64 dB", "0.11772506", "+7.64 dB", "0.11772506", false, true), + + // ffmpeg -f lavfi -i "sine=frequency=1100:duration=1" -c:a libopus test.opus (tags added via mutagen) + Entry("correctly parses opus tags (#4998)", "test.opus", "1s", 1, 48000, 0, "+5.12 dB", "0.11345678", "+5.12 dB", "0.11345678", false, true), + + // ffmpeg -f lavfi -i "sine=frequency=900:duration=1" test.wma + // Weird note: for the tag parsing to work, the lyrics are actually stored in the reverse order + Entry("correctly parses wma/asf tags", "test.wma", "1.02s", 1, 44100, 16, "3.27 dB", "0.132914", "3.27 dB", "0.132914", false, true), + + // ffmpeg -f lavfi -i "sine=frequency=800:duration=1" test.wv + Entry("correctly parses wv (wavpak) tags", "test.wv", "1s", 1, 44100, 16, "3.43 dB", "0.125061", "3.43 dB", "0.125061", false, true), + + // ffmpeg -f lavfi -i "sine=frequency=1000:duration=1" test.wav + Entry("correctly parses wav tags", "test.wav", "1s", 1, 44100, 16, "3.06 dB", "0.125056", "3.06 dB", "0.125056", true, true), + + // ffmpeg -f lavfi -i "sine=frequency=1400:duration=1" test.aiff + Entry("correctly parses aiff tags", "test.aiff", "1s", 1, 44100, 16, "2.00 dB", "0.124972", "2.00 dB", "0.124972", true, true), + ) + + // Skip these tests when running as root + Context("Access Forbidden", func() { + var accessForbiddenFile string + var RegularUserContext = XContext + var isRegularUser = os.Getuid() != 0 + if isRegularUser { + RegularUserContext = Context + } + + // Only run permission tests if we are not root + RegularUserContext("when run without root privileges", func() { + BeforeEach(func() { + // Use root fs for absolute paths in temp directory + e = &extractor{fs: os.DirFS("/")} + accessForbiddenFile = utils.TempFileName("access_forbidden-", ".mp3") + + f, err := os.OpenFile(accessForbiddenFile, os.O_WRONLY|os.O_CREATE, 0222) + Expect(err).ToNot(HaveOccurred()) + + DeferCleanup(func() { + Expect(f.Close()).To(Succeed()) + Expect(os.Remove(accessForbiddenFile)).To(Succeed()) + }) + }) + + It("correctly handle unreadable file due to insufficient read permission", func() { + // Strip leading slash for DirFS rooted at "/" + _, err := e.extractMetadata(accessForbiddenFile[1:]) + Expect(err).To(MatchError(os.ErrPermission)) + }) + + It("skips the file if it cannot be read", func() { + // Get current working directory to construct paths relative to root + cwd, err := os.Getwd() + Expect(err).ToNot(HaveOccurred()) + // Strip leading slash for DirFS rooted at "/" + files := []string{ + cwd[1:] + "/tests/fixtures/test.mp3", + cwd[1:] + "/tests/fixtures/test.ogg", + accessForbiddenFile[1:], + } + mds, err := e.Parse(files...) + Expect(err).NotTo(HaveOccurred()) + Expect(mds).To(HaveLen(2)) + Expect(mds).ToNot(HaveKey(accessForbiddenFile[1:])) + }) + }) + }) + + }) + + Describe("Error Checking", func() { + It("returns a generic ErrPath if file does not exist", func() { + testFilePath := "tests/fixtures/NON_EXISTENT.ogg" + _, err := e.extractMetadata(testFilePath) + Expect(err).To(MatchError(fs.ErrNotExist)) + }) + It("does not throw a SIGSEGV error when reading a file with an invalid frame", func() { + // File has an empty TDAT frame + md, err := e.extractMetadata("tests/fixtures/invalid-files/test-invalid-frame.mp3") + Expect(err).ToNot(HaveOccurred()) + Expect(md.Tags).To(HaveKeyWithValue("albumartist", []string{"Elvis Presley"})) + }) + }) + + Describe("parseTIPL", func() { + var tags map[string][]string + + BeforeEach(func() { + tags = make(map[string][]string) + }) + + Context("when the TIPL string is populated", func() { + It("correctly parses roles and names", func() { + tags["tipl"] = []string{"arranger Andrew Powell DJ-mix François Kevorkian DJ-mix Jane Doe engineer Chris Blair"} + parseTIPL(tags) + Expect(tags["arranger"]).To(ConsistOf("Andrew Powell")) + Expect(tags["engineer"]).To(ConsistOf("Chris Blair")) + Expect(tags["djmixer"]).To(ConsistOf("François Kevorkian", "Jane Doe")) + }) + + It("handles multiple names for a single role", func() { + tags["tipl"] = []string{"engineer Pat Stapley producer Eric Woolfson engineer Chris Blair"} + parseTIPL(tags) + Expect(tags["producer"]).To(ConsistOf("Eric Woolfson")) + Expect(tags["engineer"]).To(ConsistOf("Pat Stapley", "Chris Blair")) + }) + + It("discards roles without names", func() { + tags["tipl"] = []string{"engineer Pat Stapley producer engineer Chris Blair"} + parseTIPL(tags) + Expect(tags).ToNot(HaveKey("producer")) + Expect(tags["engineer"]).To(ConsistOf("Pat Stapley", "Chris Blair")) + }) + }) + + Context("when the TIPL string is empty", func() { + It("does nothing", func() { + tags["tipl"] = []string{""} + parseTIPL(tags) + Expect(tags).To(BeEmpty()) + }) + }) + + Context("when the TIPL is not present", func() { + It("does nothing", func() { + parseTIPL(tags) + Expect(tags).To(BeEmpty()) + }) + }) + }) + +}) diff --git a/core/agents/lastfm/agent.go b/adapters/lastfm/agent.go similarity index 68% rename from core/agents/lastfm/agent.go rename to adapters/lastfm/agent.go index d01b496ec..b3e89a9dc 100644 --- a/core/agents/lastfm/agent.go +++ b/adapters/lastfm/agent.go @@ -26,18 +26,25 @@ const ( sessionKeyProperty = "LastFMSessionKey" ) -var ignoredBiographies = []string{ - // Unknown Artist +var ignoredContent = []string{ + // Empty Artist/Album `Read more on Last\.fm\.?`) + +func cleanContent(content string) string { + return strings.TrimSpace(lastFMReadMoreRegex.ReplaceAllString(content, "")) +} + type lastfmAgent struct { ds model.DataStore sessionKeys *agents.SessionKeys apiKey string secret string - lang string + languages []string client *client + httpClient httpDoer getInfoMutex sync.Mutex } @@ -47,7 +54,7 @@ func lastFMConstructor(ds model.DataStore) *lastfmAgent { } l := &lastfmAgent{ ds: ds, - lang: conf.Server.LastFM.Language, + languages: conf.Server.LastFM.Languages, apiKey: conf.Server.LastFM.ApiKey, secret: conf.Server.LastFM.Secret, sessionKeys: &agents.SessionKeys{DataStore: ds, KeyName: sessionKeyProperty}, @@ -56,7 +63,8 @@ func lastFMConstructor(ds model.DataStore) *lastfmAgent { Timeout: consts.DefaultHttpClientTimeOut, } chc := cache.NewHTTPClient(hc, consts.DefaultHttpClientTimeOut) - l.client = newClient(l.apiKey, l.secret, l.lang, chc) + l.httpClient = chc + l.client = newClient(l.apiKey, l.secret, chc) return l } @@ -66,22 +74,47 @@ func (l *lastfmAgent) AgentName() string { var imageRegex = regexp.MustCompile(`u\/(\d+)`) -func (l *lastfmAgent) GetAlbumInfo(ctx context.Context, name, artist, mbid string) (*agents.AlbumInfo, error) { - a, err := l.callAlbumGetInfo(ctx, name, artist, mbid) - if err != nil { - return nil, err +// isValidContent checks if content is non-empty and not in the ignored list +func isValidContent(content string) bool { + content = strings.TrimSpace(content) + if content == "" { + return false } + for _, ign := range ignoredContent { + if strings.HasPrefix(content, ign) { + return false + } + } + return true +} - return &agents.AlbumInfo{ - Name: a.Name, - MBID: a.MBID, - Description: a.Description.Summary, - URL: a.URL, - }, nil +func (l *lastfmAgent) GetAlbumInfo(ctx context.Context, name, artist, mbid string) (*agents.AlbumInfo, error) { + var a *Album + var resp agents.AlbumInfo + for _, lang := range l.languages { + var err error + a, err = l.callAlbumGetInfo(ctx, name, artist, mbid, lang) + if err != nil { + return nil, err + } + resp.Name = a.Name + resp.MBID = a.MBID + resp.URL = a.URL + if isValidContent(a.Description.Summary) { + resp.Description = cleanContent(a.Description.Summary) + return &resp, nil + } + log.Debug(ctx, "LastFM/album.getInfo returned empty/ignored description, trying next language", "album", name, "artist", artist, "lang", lang) + } + // This condition should not be hit (languages default to ["en"]), but just in case + if a == nil { + return nil, agents.ErrNotFound + } + return &resp, nil } func (l *lastfmAgent) GetAlbumImages(ctx context.Context, name, artist, mbid string) ([]agents.ExternalImage, error) { - a, err := l.callAlbumGetInfo(ctx, name, artist, mbid) + a, err := l.callAlbumGetInfo(ctx, name, artist, mbid, l.languages[0]) if err != nil { return nil, err } @@ -116,7 +149,7 @@ func (l *lastfmAgent) GetAlbumImages(ctx context.Context, name, artist, mbid str } func (l *lastfmAgent) GetArtistMBID(ctx context.Context, id string, name string) (string, error) { - a, err := l.callArtistGetInfo(ctx, name) + a, err := l.callArtistGetInfo(ctx, name, l.languages[0]) if err != nil { return "", err } @@ -127,7 +160,7 @@ func (l *lastfmAgent) GetArtistMBID(ctx context.Context, id string, name string) } func (l *lastfmAgent) GetArtistURL(ctx context.Context, id, name, mbid string) (string, error) { - a, err := l.callArtistGetInfo(ctx, name) + a, err := l.callArtistGetInfo(ctx, name, l.languages[0]) if err != nil { return "", err } @@ -138,20 +171,17 @@ func (l *lastfmAgent) GetArtistURL(ctx context.Context, id, name, mbid string) ( } func (l *lastfmAgent) GetArtistBiography(ctx context.Context, id, name, mbid string) (string, error) { - a, err := l.callArtistGetInfo(ctx, name) - if err != nil { - return "", err - } - a.Bio.Summary = strings.TrimSpace(a.Bio.Summary) - if a.Bio.Summary == "" { - return "", agents.ErrNotFound - } - for _, ign := range ignoredBiographies { - if strings.HasPrefix(a.Bio.Summary, ign) { - return "", nil + for _, lang := range l.languages { + a, err := l.callArtistGetInfo(ctx, name, lang) + if err != nil { + return "", err } + if isValidContent(a.Bio.Summary) { + return cleanContent(a.Bio.Summary), nil + } + log.Debug(ctx, "LastFM/artist.getInfo returned empty/ignored biography, trying next language", "artist", name, "lang", lang) } - return a.Bio.Summary, nil + return "", agents.ErrNotFound } func (l *lastfmAgent) GetSimilarArtists(ctx context.Context, id, name, mbid string, limit int) ([]agents.Artist, error) { @@ -190,14 +220,34 @@ func (l *lastfmAgent) GetArtistTopSongs(ctx context.Context, id, artistName, mbi return res, nil } -var artistOpenGraphQuery = cascadia.MustCompile(`html > head > meta[property="og:image"]`) +func (l *lastfmAgent) GetSimilarSongsByTrack(ctx context.Context, id, name, artist, mbid string, count int) ([]agents.Song, error) { + resp, err := l.callTrackGetSimilar(ctx, name, artist, count) + if err != nil { + return nil, err + } + if len(resp) == 0 { + return nil, agents.ErrNotFound + } + res := make([]agents.Song, 0, len(resp)) + for _, t := range resp { + res = append(res, agents.Song{ + Name: t.Name, + MBID: t.MBID, + Artist: t.Artist.Name, + ArtistMBID: t.Artist.MBID, + }) + } + return res, nil +} + +var ( + artistOpenGraphQuery = cascadia.MustCompile(`html > head > meta[property="og:image"]`) + artistIgnoredImage = "2a96cbd8b46e442fc41c2b86b821562f" // Last.fm artist placeholder image name +) func (l *lastfmAgent) GetArtistImages(ctx context.Context, _, name, mbid string) ([]agents.ExternalImage, error) { log.Debug(ctx, "Getting artist images from Last.fm", "name", name) - hc := http.Client{ - Timeout: consts.DefaultHttpClientTimeOut, - } - a, err := l.callArtistGetInfo(ctx, name) + a, err := l.callArtistGetInfo(ctx, name, l.languages[0]) if err != nil { return nil, fmt.Errorf("get artist info: %w", err) } @@ -205,7 +255,7 @@ func (l *lastfmAgent) GetArtistImages(ctx context.Context, _, name, mbid string) if err != nil { return nil, fmt.Errorf("create artist image request: %w", err) } - resp, err := hc.Do(req) + resp, err := l.httpClient.Do(req) if err != nil { return nil, fmt.Errorf("get artist url: %w", err) } @@ -222,24 +272,29 @@ func (l *lastfmAgent) GetArtistImages(ctx context.Context, _, name, mbid string) return res, nil } for _, attr := range n.Attr { - if attr.Key == "content" { - res = []agents.ExternalImage{ - {URL: attr.Val}, - } - break + if attr.Key != "content" { + continue + } + if strings.Contains(attr.Val, artistIgnoredImage) { + log.Debug(ctx, "Artist image is ignored default image", "name", name, "url", attr.Val) + return res, nil + } + + res = []agents.ExternalImage{ + {URL: attr.Val}, } } return res, nil } -func (l *lastfmAgent) callAlbumGetInfo(ctx context.Context, name, artist, mbid string) (*Album, error) { - a, err := l.client.albumGetInfo(ctx, name, artist, mbid) +func (l *lastfmAgent) callAlbumGetInfo(ctx context.Context, name, artist, mbid string, lang string) (*Album, error) { + a, err := l.client.albumGetInfo(ctx, name, artist, mbid, lang) var lfErr *lastFMError isLastFMError := errors.As(err, &lfErr) if mbid != "" && (isLastFMError && lfErr.Code == 6) { log.Debug(ctx, "LastFM/album.getInfo could not find album by mbid, trying again", "album", name, "mbid", mbid) - return l.callAlbumGetInfo(ctx, name, artist, "") + return l.callAlbumGetInfo(ctx, name, artist, "", lang) } if err != nil { @@ -253,11 +308,11 @@ func (l *lastfmAgent) callAlbumGetInfo(ctx context.Context, name, artist, mbid s return a, nil } -func (l *lastfmAgent) callArtistGetInfo(ctx context.Context, name string) (*Artist, error) { +func (l *lastfmAgent) callArtistGetInfo(ctx context.Context, name string, lang string) (*Artist, error) { l.getInfoMutex.Lock() defer l.getInfoMutex.Unlock() - a, err := l.client.artistGetInfo(ctx, name) + a, err := l.client.artistGetInfo(ctx, name, lang) if err != nil { log.Error(ctx, "Error calling LastFM/artist.getInfo", "artist", name, err) return nil, err @@ -283,11 +338,20 @@ func (l *lastfmAgent) callArtistGetTopTracks(ctx context.Context, artistName str return t.Track, nil } -func (l *lastfmAgent) getArtistForScrobble(track *model.MediaFile) string { - if conf.Server.LastFM.ScrobbleFirstArtistOnly && len(track.Participants[model.RoleArtist]) > 0 { - return track.Participants[model.RoleArtist][0].Name +func (l *lastfmAgent) callTrackGetSimilar(ctx context.Context, name, artist string, count int) ([]SimilarTrack, error) { + s, err := l.client.trackGetSimilar(ctx, name, artist, count) + if err != nil { + log.Error(ctx, "Error calling LastFM/track.getSimilar", "track", name, "artist", artist, err) + return nil, err } - return track.Artist + return s.Track, nil +} + +func (l *lastfmAgent) getArtistForScrobble(track *model.MediaFile, role model.Role, displayName string) string { + if conf.Server.LastFM.ScrobbleFirstArtistOnly && len(track.Participants[role]) > 0 { + return track.Participants[role][0].Name + } + return displayName } func (l *lastfmAgent) NowPlaying(ctx context.Context, userId string, track *model.MediaFile, position int) error { @@ -297,13 +361,13 @@ func (l *lastfmAgent) NowPlaying(ctx context.Context, userId string, track *mode } err = l.client.updateNowPlaying(ctx, sk, ScrobbleInfo{ - artist: l.getArtistForScrobble(track), + artist: l.getArtistForScrobble(track, model.RoleArtist, track.Artist), track: track.Title, album: track.Album, trackNumber: track.TrackNumber, mbid: track.MbzRecordingID, duration: int(track.Duration), - albumArtist: track.AlbumArtist, + albumArtist: l.getArtistForScrobble(track, model.RoleAlbumArtist, track.AlbumArtist), }) if err != nil { log.Warn(ctx, "Last.fm client.updateNowPlaying returned error", "track", track.Title, err) @@ -323,13 +387,13 @@ func (l *lastfmAgent) Scrobble(ctx context.Context, userId string, s scrobbler.S return nil } err = l.client.scrobble(ctx, sk, ScrobbleInfo{ - artist: l.getArtistForScrobble(&s.MediaFile), + artist: l.getArtistForScrobble(&s.MediaFile, model.RoleArtist, s.Artist), track: s.Title, album: s.Album, trackNumber: s.TrackNumber, mbid: s.MbzRecordingID, duration: int(s.Duration), - albumArtist: s.AlbumArtist, + albumArtist: l.getArtistForScrobble(&s.MediaFile, model.RoleAlbumArtist, s.AlbumArtist), timestamp: s.TimeStamp, }) if err == nil { diff --git a/core/agents/lastfm/agent_test.go b/adapters/lastfm/agent_test.go similarity index 55% rename from core/agents/lastfm/agent_test.go rename to adapters/lastfm/agent_test.go index 4476d592f..94788b8bd 100644 --- a/core/agents/lastfm/agent_test.go +++ b/adapters/lastfm/agent_test.go @@ -6,6 +6,7 @@ import ( "errors" "io" "net/http" + "net/url" "os" "strconv" "time" @@ -38,12 +39,12 @@ var _ = Describe("lastfmAgent", func() { }) Describe("lastFMConstructor", func() { When("Agent is properly configured", func() { - It("uses configured api key and language", func() { - conf.Server.LastFM.Language = "pt" + It("uses configured api key and languages", func() { + conf.Server.LastFM.Languages = []string{"pt", "en"} agent := lastFMConstructor(ds) Expect(agent.apiKey).To(Equal("123")) Expect(agent.secret).To(Equal("secret")) - Expect(agent.lang).To(Equal("pt")) + Expect(agent.languages).To(Equal([]string{"pt", "en"})) }) }) When("Agent is disabled", func() { @@ -71,7 +72,7 @@ var _ = Describe("lastfmAgent", func() { var httpClient *tests.FakeHttpClient BeforeEach(func() { httpClient = &tests.FakeHttpClient{} - client := newClient("API_KEY", "SECRET", "pt", httpClient) + client := newClient("API_KEY", "SECRET", httpClient) agent = lastFMConstructor(ds) agent.client = client }) @@ -79,7 +80,7 @@ var _ = Describe("lastfmAgent", func() { It("returns the biography", func() { f, _ := os.Open("tests/fixtures/lastfm.artist.getinfo.json") httpClient.Res = http.Response{Body: f, StatusCode: 200} - Expect(agent.GetArtistBiography(ctx, "123", "U2", "")).To(Equal("U2 é uma das mais importantes bandas de rock de todos os tempos. Formada em 1976 em Dublin, composta por Bono (vocalista e guitarrista), The Edge (guitarrista, pianista e backing vocal), Adam Clayton (baixista), Larry Mullen, Jr. (baterista e percussionista).\n\nDesde a década de 80, U2 é uma das bandas mais populares no mundo. Seus shows são únicos e um verdadeiro festival de efeitos especiais, além de serem um dos que mais arrecadam anualmente. Read more on Last.fm")) + Expect(agent.GetArtistBiography(ctx, "123", "U2", "")).To(Equal("U2 é uma das mais importantes bandas de rock de todos os tempos. Formada em 1976 em Dublin, composta por Bono (vocalista e guitarrista), The Edge (guitarrista, pianista e backing vocal), Adam Clayton (baixista), Larry Mullen, Jr. (baterista e percussionista).\n\nDesde a década de 80, U2 é uma das bandas mais populares no mundo. Seus shows são únicos e um verdadeiro festival de efeitos especiais, além de serem um dos que mais arrecadam anualmente.")) Expect(httpClient.RequestCount).To(Equal(1)) Expect(httpClient.SavedRequest.URL.Query().Get("artist")).To(Equal("U2")) }) @@ -101,12 +102,129 @@ var _ = Describe("lastfmAgent", func() { }) }) + Describe("Language Fallback", func() { + Describe("GetArtistBiography", func() { + var agent *lastfmAgent + var httpClient *langAwareHttpClient + + BeforeEach(func() { + httpClient = newLangAwareHttpClient() + }) + + It("returns content in first language when available (1 API call)", func() { + conf.Server.LastFM.Languages = []string{"pt", "en"} + agent = lastFMConstructor(ds) + agent.client = newClient("API_KEY", "SECRET", httpClient) + + // Portuguese biography available + f, _ := os.Open("tests/fixtures/lastfm.artist.getinfo.json") + httpClient.responses["pt"] = http.Response{Body: f, StatusCode: 200} + + bio, err := agent.GetArtistBiography(ctx, "123", "U2", "") + + Expect(err).ToNot(HaveOccurred()) + Expect(bio).To(ContainSubstring("U2 é uma das mais importantes bandas de rock")) + Expect(httpClient.requestCount).To(Equal(1)) + Expect(httpClient.requests[0].URL.Query().Get("lang")).To(Equal("pt")) + }) + + It("falls back to second language when first returns empty (2 API calls)", func() { + conf.Server.LastFM.Languages = []string{"ja", "en"} + agent = lastFMConstructor(ds) + agent.client = newClient("API_KEY", "SECRET", httpClient) + + // Japanese returns empty/ignored biography (actual Last.fm response with just "Read more" link) + fJa, _ := os.Open("tests/fixtures/lastfm.artist.getinfo.empty.json") + httpClient.responses["ja"] = http.Response{Body: fJa, StatusCode: 200} + // English returns full biography + fEn, _ := os.Open("tests/fixtures/lastfm.artist.getinfo.en.json") + httpClient.responses["en"] = http.Response{Body: fEn, StatusCode: 200} + + bio, err := agent.GetArtistBiography(ctx, "123", "Legião Urbana", "") + + Expect(err).ToNot(HaveOccurred()) + Expect(bio).To(ContainSubstring("Legião Urbana was a Brazilian post-punk band")) + Expect(httpClient.requestCount).To(Equal(2)) + Expect(httpClient.requests[0].URL.Query().Get("lang")).To(Equal("ja")) + Expect(httpClient.requests[1].URL.Query().Get("lang")).To(Equal("en")) + }) + + It("returns ErrNotFound when all languages return empty", func() { + conf.Server.LastFM.Languages = []string{"ja", "xx"} + agent = lastFMConstructor(ds) + agent.client = newClient("API_KEY", "SECRET", httpClient) + + // Both languages return empty/ignored biography (using actual Last.fm response format) + fJa, _ := os.Open("tests/fixtures/lastfm.artist.getinfo.empty.json") + httpClient.responses["ja"] = http.Response{Body: fJa, StatusCode: 200} + // Second language also returns empty + fXx, _ := os.Open("tests/fixtures/lastfm.artist.getinfo.empty.json") + httpClient.responses["xx"] = http.Response{Body: fXx, StatusCode: 200} + + _, err := agent.GetArtistBiography(ctx, "123", "Legião Urbana", "") + + Expect(err).To(MatchError(agents.ErrNotFound)) + Expect(httpClient.requestCount).To(Equal(2)) + }) + }) + + Describe("GetAlbumInfo", func() { + var agent *lastfmAgent + var httpClient *langAwareHttpClient + + BeforeEach(func() { + httpClient = newLangAwareHttpClient() + }) + + It("falls back to second language when first returns empty description (2 API calls)", func() { + conf.Server.LastFM.Languages = []string{"ja", "en"} + agent = lastFMConstructor(ds) + agent.client = newClient("API_KEY", "SECRET", httpClient) + + // Japanese returns album without wiki/description (actual Last.fm response) + fJa, _ := os.Open("tests/fixtures/lastfm.album.getinfo.empty.json") + httpClient.responses["ja"] = http.Response{Body: fJa, StatusCode: 200} + // English returns album with description + fEn, _ := os.Open("tests/fixtures/lastfm.album.getinfo.en.json") + httpClient.responses["en"] = http.Response{Body: fEn, StatusCode: 200} + + albumInfo, err := agent.GetAlbumInfo(ctx, "Dois", "Legião Urbana", "") + + Expect(err).ToNot(HaveOccurred()) + Expect(albumInfo.Name).To(Equal("Dois")) + Expect(albumInfo.Description).To(ContainSubstring("segundo álbum de estúdio")) + Expect(httpClient.requestCount).To(Equal(2)) + Expect(httpClient.requests[0].URL.Query().Get("lang")).To(Equal("ja")) + Expect(httpClient.requests[1].URL.Query().Get("lang")).To(Equal("en")) + }) + + It("returns album without description when all languages return empty", func() { + conf.Server.LastFM.Languages = []string{"ja", "xx"} + agent = lastFMConstructor(ds) + agent.client = newClient("API_KEY", "SECRET", httpClient) + + // Both languages return album without description + fJa, _ := os.Open("tests/fixtures/lastfm.album.getinfo.empty.json") + httpClient.responses["ja"] = http.Response{Body: fJa, StatusCode: 200} + fXx, _ := os.Open("tests/fixtures/lastfm.album.getinfo.empty.json") + httpClient.responses["xx"] = http.Response{Body: fXx, StatusCode: 200} + + albumInfo, err := agent.GetAlbumInfo(ctx, "Dois", "Legião Urbana", "") + + Expect(err).ToNot(HaveOccurred()) + Expect(albumInfo.Name).To(Equal("Dois")) + Expect(albumInfo.Description).To(BeEmpty()) + Expect(httpClient.requestCount).To(Equal(2)) + }) + }) + }) + Describe("GetSimilarArtists", func() { var agent *lastfmAgent var httpClient *tests.FakeHttpClient BeforeEach(func() { httpClient = &tests.FakeHttpClient{} - client := newClient("API_KEY", "SECRET", "pt", httpClient) + client := newClient("API_KEY", "SECRET", httpClient) agent = lastFMConstructor(ds) agent.client = client }) @@ -144,7 +262,7 @@ var _ = Describe("lastfmAgent", func() { var httpClient *tests.FakeHttpClient BeforeEach(func() { httpClient = &tests.FakeHttpClient{} - client := newClient("API_KEY", "SECRET", "pt", httpClient) + client := newClient("API_KEY", "SECRET", httpClient) agent = lastFMConstructor(ds) agent.client = client }) @@ -177,6 +295,54 @@ var _ = Describe("lastfmAgent", func() { }) }) + Describe("GetSimilarSongsByTrack", func() { + var agent *lastfmAgent + var httpClient *tests.FakeHttpClient + BeforeEach(func() { + httpClient = &tests.FakeHttpClient{} + client := newClient("API_KEY", "SECRET", httpClient) + agent = lastFMConstructor(ds) + agent.client = client + }) + + It("returns similar songs", func() { + f, _ := os.Open("tests/fixtures/lastfm.track.getsimilar.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + Expect(agent.GetSimilarSongsByTrack(ctx, "123", "Just Can't Get Enough", "Depeche Mode", "", 5)).To(Equal([]agents.Song{ + {Name: "Dreaming of Me", MBID: "027b553e-7c74-3ed4-a95e-1d4fea51f174", Artist: "Depeche Mode", ArtistMBID: "8538e728-ca0b-4321-b7e5-cff6565dd4c0"}, + {Name: "Everything Counts", MBID: "5a5a3ca4-bdb8-4641-a674-9b54b9b319a6", Artist: "Depeche Mode", ArtistMBID: "8538e728-ca0b-4321-b7e5-cff6565dd4c0"}, + {Name: "Don't You Want Me", MBID: "", Artist: "The Human League", ArtistMBID: "7adaabfb-acfb-47bc-8c7c-59471c2f0db8"}, + {Name: "Tainted Love", MBID: "", Artist: "Soft Cell", ArtistMBID: "7fb50287-029d-47cc-825a-235ca28024b2"}, + {Name: "Blue Monday", MBID: "727e84c6-1b56-31dd-a958-a5f46305cec0", Artist: "New Order", ArtistMBID: "f1106b17-dcbb-45f6-b938-199ccfab50cc"}, + })) + Expect(httpClient.RequestCount).To(Equal(1)) + Expect(httpClient.SavedRequest.URL.Query().Get("track")).To(Equal("Just Can't Get Enough")) + Expect(httpClient.SavedRequest.URL.Query().Get("artist")).To(Equal("Depeche Mode")) + }) + + It("returns ErrNotFound when no similar songs found", func() { + f, _ := os.Open("tests/fixtures/lastfm.track.getsimilar.unknown.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + _, err := agent.GetSimilarSongsByTrack(ctx, "123", "UnknownTrack", "UnknownArtist", "", 3) + Expect(err).To(MatchError(agents.ErrNotFound)) + Expect(httpClient.RequestCount).To(Equal(1)) + }) + + It("returns an error if Last.fm call fails", func() { + httpClient.Err = errors.New("error") + _, err := agent.GetSimilarSongsByTrack(ctx, "123", "Believe", "Cher", "", 3) + Expect(err).To(HaveOccurred()) + Expect(httpClient.RequestCount).To(Equal(1)) + }) + + It("returns an error if Last.fm call returns an error", func() { + httpClient.Res = http.Response{Body: io.NopCloser(bytes.NewBufferString(lastfmError3)), StatusCode: 200} + _, err := agent.GetSimilarSongsByTrack(ctx, "123", "Believe", "Cher", "", 3) + Expect(err).To(HaveOccurred()) + Expect(httpClient.RequestCount).To(Equal(1)) + }) + }) + Describe("Scrobbling", func() { var agent *lastfmAgent var httpClient *tests.FakeHttpClient @@ -184,7 +350,7 @@ var _ = Describe("lastfmAgent", func() { BeforeEach(func() { _ = ds.UserProps(ctx).Put("user-1", sessionKeyProperty, "SK-1") httpClient = &tests.FakeHttpClient{} - client := newClient("API_KEY", "SECRET", "en", httpClient) + client := newClient("API_KEY", "SECRET", httpClient) agent = lastFMConstructor(ds) agent.client = client track = &model.MediaFile{ @@ -201,6 +367,10 @@ var _ = Describe("lastfmAgent", func() { {Artist: model.Artist{ID: "ar-1", Name: "First Artist"}}, {Artist: model.Artist{ID: "ar-2", Name: "Second Artist"}}, }, + model.RoleAlbumArtist: []model.Participant{ + {Artist: model.Artist{ID: "ar-1", Name: "First Album Artist"}}, + {Artist: model.Artist{ID: "ar-2", Name: "Second Album Artist"}}, + }, }, } }) @@ -213,7 +383,8 @@ var _ = Describe("lastfmAgent", func() { Expect(err).ToNot(HaveOccurred()) Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodPost)) - sentParams := httpClient.SavedRequest.URL.Query() + body, _ := io.ReadAll(httpClient.SavedRequest.Body) + sentParams, _ := url.ParseQuery(string(body)) Expect(sentParams.Get("method")).To(Equal("track.updateNowPlaying")) Expect(sentParams.Get("sk")).To(Equal("SK-1")) Expect(sentParams.Get("track")).To(Equal(track.Title)) @@ -229,6 +400,24 @@ var _ = Describe("lastfmAgent", func() { err := agent.NowPlaying(ctx, "user-2", track, 0) Expect(err).To(MatchError(scrobbler.ErrNotAuthorized)) }) + + When("ScrobbleFirstArtistOnly is true", func() { + BeforeEach(func() { + conf.Server.LastFM.ScrobbleFirstArtistOnly = true + }) + + It("uses only the first artist", func() { + httpClient.Res = http.Response{Body: io.NopCloser(bytes.NewBufferString("{}")), StatusCode: 200} + + err := agent.NowPlaying(ctx, "user-1", track, 0) + + Expect(err).ToNot(HaveOccurred()) + body, _ := io.ReadAll(httpClient.SavedRequest.Body) + sentParams, _ := url.ParseQuery(string(body)) + Expect(sentParams.Get("artist")).To(Equal("First Artist")) + Expect(sentParams.Get("albumArtist")).To(Equal("First Album Artist")) + }) + }) }) Describe("scrobble", func() { @@ -240,7 +429,8 @@ var _ = Describe("lastfmAgent", func() { Expect(err).ToNot(HaveOccurred()) Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodPost)) - sentParams := httpClient.SavedRequest.URL.Query() + body, _ := io.ReadAll(httpClient.SavedRequest.Body) + sentParams, _ := url.ParseQuery(string(body)) Expect(sentParams.Get("method")).To(Equal("track.scrobble")) Expect(sentParams.Get("sk")).To(Equal("SK-1")) Expect(sentParams.Get("track")).To(Equal(track.Title)) @@ -265,8 +455,10 @@ var _ = Describe("lastfmAgent", func() { err := agent.Scrobble(ctx, "user-1", scrobbler.Scrobble{MediaFile: *track, TimeStamp: ts}) Expect(err).ToNot(HaveOccurred()) - sentParams := httpClient.SavedRequest.URL.Query() + body, _ := io.ReadAll(httpClient.SavedRequest.Body) + sentParams, _ := url.ParseQuery(string(body)) Expect(sentParams.Get("artist")).To(Equal("First Artist")) + Expect(sentParams.Get("albumArtist")).To(Equal("First Album Artist")) }) }) @@ -332,7 +524,7 @@ var _ = Describe("lastfmAgent", func() { var httpClient *tests.FakeHttpClient BeforeEach(func() { httpClient = &tests.FakeHttpClient{} - client := newClient("API_KEY", "SECRET", "pt", httpClient) + client := newClient("API_KEY", "SECRET", httpClient) agent = lastFMConstructor(ds) agent.client = client }) @@ -343,7 +535,7 @@ var _ = Describe("lastfmAgent", func() { Expect(agent.GetAlbumInfo(ctx, "Believe", "Cher", "03c91c40-49a6-44a7-90e7-a700edf97a62")).To(Equal(&agents.AlbumInfo{ Name: "Believe", MBID: "03c91c40-49a6-44a7-90e7-a700edf97a62", - Description: "Believe is the twenty-third studio album by American singer-actress Cher, released on November 10, 1998 by Warner Bros. Records. The RIAA certified it Quadruple Platinum on December 23, 1999, recognizing four million shipments in the United States; Worldwide, the album has sold more than 20 million copies, making it the biggest-selling album of her career. In 1999 the album received three Grammy Awards nominations including \"Record of the Year\", \"Best Pop Album\" and winning \"Best Dance Recording\" for the single \"Believe\". It was released by Warner Bros. Records at the end of 1998. The album was executive produced by Rob Read more on Last.fm.", + Description: "Believe is the twenty-third studio album by American singer-actress Cher, released on November 10, 1998 by Warner Bros. Records. The RIAA certified it Quadruple Platinum on December 23, 1999, recognizing four million shipments in the United States; Worldwide, the album has sold more than 20 million copies, making it the biggest-selling album of her career. In 1999 the album received three Grammy Awards nominations including \"Record of the Year\", \"Best Pop Album\" and winning \"Best Dance Recording\" for the single \"Believe\". It was released by Warner Bros. Records at the end of 1998. The album was executive produced by Rob", URL: "https://www.last.fm/music/Cher/Believe", })) Expect(httpClient.RequestCount).To(Equal(1)) @@ -393,4 +585,101 @@ var _ = Describe("lastfmAgent", func() { }) }) }) + + Describe("GetArtistImages", func() { + var agent *lastfmAgent + var apiClient *tests.FakeHttpClient + var httpClient *tests.FakeHttpClient + + BeforeEach(func() { + apiClient = &tests.FakeHttpClient{} + httpClient = &tests.FakeHttpClient{} + client := newClient("API_KEY", "SECRET", apiClient) + agent = lastFMConstructor(ds) + agent.client = client + agent.httpClient = httpClient + }) + + It("returns the artist image from the page", func() { + fApi, _ := os.Open("tests/fixtures/lastfm.artist.getinfo.json") + apiClient.Res = http.Response{Body: fApi, StatusCode: 200} + + fScraper, _ := os.Open("tests/fixtures/lastfm.artist.page.html") + httpClient.Res = http.Response{Body: fScraper, StatusCode: 200} + + images, err := agent.GetArtistImages(ctx, "123", "U2", "") + Expect(err).ToNot(HaveOccurred()) + Expect(images).To(HaveLen(1)) + Expect(images[0].URL).To(Equal("https://lastfm.freetls.fastly.net/i/u/ar0/818148bf682d429dc21b59a73ef6f68e.png")) + }) + + It("returns empty list if image is the ignored default image", func() { + fApi, _ := os.Open("tests/fixtures/lastfm.artist.getinfo.json") + apiClient.Res = http.Response{Body: fApi, StatusCode: 200} + + fScraper, _ := os.Open("tests/fixtures/lastfm.artist.page.ignored.html") + httpClient.Res = http.Response{Body: fScraper, StatusCode: 200} + + images, err := agent.GetArtistImages(ctx, "123", "U2", "") + Expect(err).ToNot(HaveOccurred()) + Expect(images).To(BeEmpty()) + }) + + It("returns empty list if page has no meta tags", func() { + fApi, _ := os.Open("tests/fixtures/lastfm.artist.getinfo.json") + apiClient.Res = http.Response{Body: fApi, StatusCode: 200} + + fScraper, _ := os.Open("tests/fixtures/lastfm.artist.page.no_meta.html") + httpClient.Res = http.Response{Body: fScraper, StatusCode: 200} + + images, err := agent.GetArtistImages(ctx, "123", "U2", "") + Expect(err).ToNot(HaveOccurred()) + Expect(images).To(BeEmpty()) + }) + + It("returns error if API call fails", func() { + apiClient.Err = errors.New("api error") + _, err := agent.GetArtistImages(ctx, "123", "U2", "") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("get artist info")) + }) + + It("returns error if scraper call fails", func() { + fApi, _ := os.Open("tests/fixtures/lastfm.artist.getinfo.json") + apiClient.Res = http.Response{Body: fApi, StatusCode: 200} + + httpClient.Err = errors.New("scraper error") + _, err := agent.GetArtistImages(ctx, "123", "U2", "") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("get artist url")) + }) + }) }) + +// langAwareHttpClient is a mock HTTP client that returns different responses based on the lang parameter +type langAwareHttpClient struct { + responses map[string]http.Response + requests []*http.Request + requestCount int +} + +func newLangAwareHttpClient() *langAwareHttpClient { + return &langAwareHttpClient{ + responses: make(map[string]http.Response), + requests: make([]*http.Request, 0), + } +} + +func (c *langAwareHttpClient) Do(req *http.Request) (*http.Response, error) { + c.requestCount++ + c.requests = append(c.requests, req) + lang := req.URL.Query().Get("lang") + if resp, ok := c.responses[lang]; ok { + return &resp, nil + } + // Return default empty response if no specific response is configured + return &http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(`{}`)), + }, nil +} diff --git a/core/agents/lastfm/auth_router.go b/adapters/lastfm/auth_router.go similarity index 96% rename from core/agents/lastfm/auth_router.go rename to adapters/lastfm/auth_router.go index 290caaad3..162ae9037 100644 --- a/core/agents/lastfm/auth_router.go +++ b/adapters/lastfm/auth_router.go @@ -44,7 +44,7 @@ func NewRouter(ds model.DataStore) *Router { hc := &http.Client{ Timeout: consts.DefaultHttpClientTimeOut, } - r.client = newClient(r.apiKey, r.secret, "en", hc) + r.client = newClient(r.apiKey, r.secret, hc) return r } @@ -65,7 +65,7 @@ func (s *Router) routes() http.Handler { } func (s *Router) getLinkStatus(w http.ResponseWriter, r *http.Request) { - resp := map[string]interface{}{ + resp := map[string]any{ "apiKey": s.apiKey, } u, _ := request.UserFrom(r.Context()) @@ -110,7 +110,7 @@ func (s *Router) callback(w http.ResponseWriter, r *http.Request) { if err != nil { w.Header().Set("Content-Type", "text/plain; charset=utf-8") w.WriteHeader(http.StatusBadRequest) - _, _ = w.Write([]byte("An error occurred while authorizing with Last.fm. \n\nRequest ID: " + middleware.GetReqID(ctx))) + _, _ = w.Write([]byte("An error occurred while authorizing with Last.fm. \n\nRequest ID: " + middleware.GetReqID(ctx))) //nolint:gosec return } diff --git a/core/agents/lastfm/client.go b/adapters/lastfm/client.go similarity index 84% rename from core/agents/lastfm/client.go rename to adapters/lastfm/client.go index 6a24ac80a..726df1360 100644 --- a/core/agents/lastfm/client.go +++ b/adapters/lastfm/client.go @@ -34,24 +34,23 @@ type httpDoer interface { Do(req *http.Request) (*http.Response, error) } -func newClient(apiKey string, secret string, lang string, hc httpDoer) *client { - return &client{apiKey, secret, lang, hc} +func newClient(apiKey string, secret string, hc httpDoer) *client { + return &client{apiKey, secret, hc} } type client struct { apiKey string secret string - lang string hc httpDoer } -func (c *client) albumGetInfo(ctx context.Context, name string, artist string, mbid string) (*Album, error) { +func (c *client) albumGetInfo(ctx context.Context, name string, artist string, mbid string, lang string) (*Album, error) { params := url.Values{} params.Add("method", "album.getInfo") params.Add("album", name) params.Add("artist", artist) params.Add("mbid", mbid) - params.Add("lang", c.lang) + params.Add("lang", lang) response, err := c.makeRequest(ctx, http.MethodGet, params, false) if err != nil { return nil, err @@ -59,11 +58,11 @@ func (c *client) albumGetInfo(ctx context.Context, name string, artist string, m return &response.Album, nil } -func (c *client) artistGetInfo(ctx context.Context, name string) (*Artist, error) { +func (c *client) artistGetInfo(ctx context.Context, name string, lang string) (*Artist, error) { params := url.Values{} params.Add("method", "artist.getInfo") params.Add("artist", name) - params.Add("lang", c.lang) + params.Add("lang", lang) response, err := c.makeRequest(ctx, http.MethodGet, params, false) if err != nil { return nil, err @@ -95,6 +94,19 @@ func (c *client) artistGetTopTracks(ctx context.Context, name string, limit int) return &response.TopTracks, nil } +func (c *client) trackGetSimilar(ctx context.Context, name, artist string, limit int) (*SimilarTracks, error) { + params := url.Values{} + params.Add("method", "track.getSimilar") + params.Add("track", name) + params.Add("artist", artist) + params.Add("limit", strconv.Itoa(limit)) + response, err := c.makeRequest(ctx, http.MethodGet, params, false) + if err != nil { + return nil, err + } + return &response.SimilarTracks, nil +} + func (c *client) GetToken(ctx context.Context) (string, error) { params := url.Values{} params.Add("method", "auth.getToken") @@ -185,8 +197,15 @@ func (c *client) makeRequest(ctx context.Context, method string, params url.Valu c.sign(params) } - req, _ := http.NewRequestWithContext(ctx, method, apiBaseUrl, nil) - req.URL.RawQuery = params.Encode() + var req *http.Request + if method == http.MethodPost { + body := strings.NewReader(params.Encode()) + req, _ = http.NewRequestWithContext(ctx, method, apiBaseUrl, body) + req.Header.Set("Content-Type", "application/x-www-form-urlencoded") + } else { + req, _ = http.NewRequestWithContext(ctx, method, apiBaseUrl, nil) + req.URL.RawQuery = params.Encode() + } log.Trace(ctx, fmt.Sprintf("Sending Last.fm %s request", req.Method), "url", req.URL) resp, err := c.hc.Do(req) diff --git a/core/agents/lastfm/client_test.go b/adapters/lastfm/client_test.go similarity index 59% rename from core/agents/lastfm/client_test.go rename to adapters/lastfm/client_test.go index 85ec11506..271ae1419 100644 --- a/core/agents/lastfm/client_test.go +++ b/adapters/lastfm/client_test.go @@ -22,7 +22,7 @@ var _ = Describe("client", func() { BeforeEach(func() { httpClient = &tests.FakeHttpClient{} - client = newClient("API_KEY", "SECRET", "pt", httpClient) + client = newClient("API_KEY", "SECRET", httpClient) }) Describe("albumGetInfo", func() { @@ -30,7 +30,7 @@ var _ = Describe("client", func() { f, _ := os.Open("tests/fixtures/lastfm.album.getinfo.json") httpClient.Res = http.Response{Body: f, StatusCode: 200} - album, err := client.albumGetInfo(context.Background(), "Believe", "U2", "mbid-1234") + album, err := client.albumGetInfo(context.Background(), "Believe", "U2", "mbid-1234", "pt") Expect(err).To(BeNil()) Expect(album.Name).To(Equal("Believe")) Expect(httpClient.SavedRequest.URL.String()).To(Equal(apiBaseUrl + "?album=Believe&api_key=API_KEY&artist=U2&format=json&lang=pt&mbid=mbid-1234&method=album.getInfo")) @@ -42,7 +42,7 @@ var _ = Describe("client", func() { f, _ := os.Open("tests/fixtures/lastfm.artist.getinfo.json") httpClient.Res = http.Response{Body: f, StatusCode: 200} - artist, err := client.artistGetInfo(context.Background(), "U2") + artist, err := client.artistGetInfo(context.Background(), "U2", "pt") Expect(err).To(BeNil()) Expect(artist.Name).To(Equal("U2")) Expect(httpClient.SavedRequest.URL.String()).To(Equal(apiBaseUrl + "?api_key=API_KEY&artist=U2&format=json&lang=pt&method=artist.getInfo")) @@ -54,7 +54,7 @@ var _ = Describe("client", func() { StatusCode: 500, } - _, err := client.artistGetInfo(context.Background(), "U2") + _, err := client.artistGetInfo(context.Background(), "U2", "pt") Expect(err).To(MatchError("last.fm http status: (500)")) }) @@ -64,7 +64,7 @@ var _ = Describe("client", func() { StatusCode: 400, } - _, err := client.artistGetInfo(context.Background(), "U2") + _, err := client.artistGetInfo(context.Background(), "U2", "pt") Expect(err).To(MatchError(&lastFMError{Code: 3, Message: "Invalid Method - No method with that name in this package"})) }) @@ -74,14 +74,14 @@ var _ = Describe("client", func() { StatusCode: 200, } - _, err := client.artistGetInfo(context.Background(), "U2") + _, err := client.artistGetInfo(context.Background(), "U2", "pt") Expect(err).To(MatchError(&lastFMError{Code: 6, Message: "The artist you supplied could not be found"})) }) It("fails if HttpClient.Do() returns error", func() { httpClient.Err = errors.New("generic error") - _, err := client.artistGetInfo(context.Background(), "U2") + _, err := client.artistGetInfo(context.Background(), "U2", "pt") Expect(err).To(MatchError("generic error")) }) @@ -91,7 +91,7 @@ var _ = Describe("client", func() { StatusCode: 200, } - _, err := client.artistGetInfo(context.Background(), "U2") + _, err := client.artistGetInfo(context.Background(), "U2", "pt") Expect(err).To(MatchError("invalid character '<' looking for beginning of value")) }) @@ -121,6 +121,30 @@ var _ = Describe("client", func() { }) }) + Describe("trackGetSimilar", func() { + It("returns similar tracks for a successful response", func() { + f, _ := os.Open("tests/fixtures/lastfm.track.getsimilar.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + + similar, err := client.trackGetSimilar(context.Background(), "Just Can't Get Enough", "Depeche Mode", 5) + Expect(err).To(BeNil()) + Expect(len(similar.Track)).To(Equal(5)) + Expect(similar.Track[0].Name).To(Equal("Dreaming of Me")) + Expect(similar.Track[0].Artist.Name).To(Equal("Depeche Mode")) + Expect(similar.Track[0].Match).To(Equal(1.0)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(apiBaseUrl + "?api_key=API_KEY&artist=Depeche+Mode&format=json&limit=5&method=track.getSimilar&track=Just+Can%27t+Get+Enough")) + }) + + It("returns empty list when no similar tracks found", func() { + f, _ := os.Open("tests/fixtures/lastfm.track.getsimilar.unknown.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + + similar, err := client.trackGetSimilar(context.Background(), "UnknownTrack", "UnknownArtist", 3) + Expect(err).To(BeNil()) + Expect(similar.Track).To(BeEmpty()) + }) + }) + Describe("GetToken", func() { It("returns a token when the request is successful", func() { httpClient.Res = http.Response{ @@ -154,6 +178,74 @@ var _ = Describe("client", func() { }) }) + Describe("scrobble", func() { + It("sends parameters in request body for POST", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`{"scrobbles":{"scrobble":{"ignoredMessage":{"code":"0"}},"@attr":{"accepted":1}}}`)), + StatusCode: 200, + } + + info := ScrobbleInfo{ + artist: "U2", + track: "One", + album: "Achtung Baby", + trackNumber: 1, + duration: 276, + albumArtist: "U2", + } + err := client.scrobble(context.Background(), "SESSION_KEY", info) + Expect(err).To(BeNil()) + + req := httpClient.SavedRequest + Expect(req.Method).To(Equal(http.MethodPost)) + Expect(req.Header.Get("Content-Type")).To(Equal("application/x-www-form-urlencoded")) + Expect(req.URL.RawQuery).To(BeEmpty()) + + body, _ := io.ReadAll(req.Body) + bodyParams, _ := url.ParseQuery(string(body)) + Expect(bodyParams.Get("method")).To(Equal("track.scrobble")) + Expect(bodyParams.Get("artist")).To(Equal("U2")) + Expect(bodyParams.Get("track")).To(Equal("One")) + Expect(bodyParams.Get("sk")).To(Equal("SESSION_KEY")) + Expect(bodyParams.Get("api_key")).To(Equal("API_KEY")) + Expect(bodyParams.Get("api_sig")).ToNot(BeEmpty()) + }) + }) + + Describe("updateNowPlaying", func() { + It("sends parameters in request body for POST", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`{"nowplaying":{"ignoredMessage":{"code":"0"}}}`)), + StatusCode: 200, + } + + info := ScrobbleInfo{ + artist: "U2", + track: "One", + album: "Achtung Baby", + trackNumber: 1, + duration: 276, + albumArtist: "U2", + } + err := client.updateNowPlaying(context.Background(), "SESSION_KEY", info) + Expect(err).To(BeNil()) + + req := httpClient.SavedRequest + Expect(req.Method).To(Equal(http.MethodPost)) + Expect(req.Header.Get("Content-Type")).To(Equal("application/x-www-form-urlencoded")) + Expect(req.URL.RawQuery).To(BeEmpty()) + + body, _ := io.ReadAll(req.Body) + bodyParams, _ := url.ParseQuery(string(body)) + Expect(bodyParams.Get("method")).To(Equal("track.updateNowPlaying")) + Expect(bodyParams.Get("artist")).To(Equal("U2")) + Expect(bodyParams.Get("track")).To(Equal("One")) + Expect(bodyParams.Get("sk")).To(Equal("SESSION_KEY")) + Expect(bodyParams.Get("api_key")).To(Equal("API_KEY")) + Expect(bodyParams.Get("api_sig")).ToNot(BeEmpty()) + }) + }) + Describe("sign", func() { It("adds an api_sig param with the signature", func() { params := url.Values{} diff --git a/core/agents/lastfm/lastfm_suite_test.go b/adapters/lastfm/lastfm_suite_test.go similarity index 100% rename from core/agents/lastfm/lastfm_suite_test.go rename to adapters/lastfm/lastfm_suite_test.go diff --git a/core/agents/lastfm/responses.go b/adapters/lastfm/responses.go similarity index 84% rename from core/agents/lastfm/responses.go rename to adapters/lastfm/responses.go index 1ceebe767..026741672 100644 --- a/core/agents/lastfm/responses.go +++ b/adapters/lastfm/responses.go @@ -5,6 +5,7 @@ type Response struct { SimilarArtists SimilarArtists `json:"similarartists"` TopTracks TopTracks `json:"toptracks"` Album Album `json:"album"` + SimilarTracks SimilarTracks `json:"similartracks"` Error int `json:"error"` Message string `json:"message"` Token string `json:"token"` @@ -59,6 +60,28 @@ type TopTracks struct { Attr Attr `json:"@attr"` } +type SimilarTracks struct { + Track []SimilarTrack `json:"track"` + Attr SimilarAttr `json:"@attr"` +} + +type SimilarTrack struct { + Name string `json:"name"` + MBID string `json:"mbid"` + Match float64 `json:"match"` + Artist SimilarTrackArtist `json:"artist"` +} + +type SimilarTrackArtist struct { + Name string `json:"name"` + MBID string `json:"mbid"` +} + +type SimilarAttr struct { + Artist string `json:"artist"` + Track string `json:"track"` +} + type Session struct { Name string `json:"name"` Key string `json:"key"` diff --git a/core/agents/lastfm/responses_test.go b/adapters/lastfm/responses_test.go similarity index 100% rename from core/agents/lastfm/responses_test.go rename to adapters/lastfm/responses_test.go diff --git a/core/agents/lastfm/token_received.html b/adapters/lastfm/token_received.html similarity index 100% rename from core/agents/lastfm/token_received.html rename to adapters/lastfm/token_received.html diff --git a/core/agents/listenbrainz/agent.go b/adapters/listenbrainz/agent.go similarity index 55% rename from core/agents/listenbrainz/agent.go rename to adapters/listenbrainz/agent.go index 769b0f5a6..019c6e9f4 100644 --- a/core/agents/listenbrainz/agent.go +++ b/adapters/listenbrainz/agent.go @@ -118,12 +118,129 @@ func (l *listenBrainzAgent) IsAuthorized(ctx context.Context, userId string) boo return err == nil && sk != "" } +func (l *listenBrainzAgent) GetArtistURL(ctx context.Context, id, name, mbid string) (string, error) { + if mbid == "" { + return "", agents.ErrNotFound + } + + url, err := l.client.getArtistUrl(ctx, mbid) + if err != nil { + return "", err + } + return url, nil +} + +func (l *listenBrainzAgent) GetArtistTopSongs(ctx context.Context, id, artistName, mbid string, count int) ([]agents.Song, error) { + resp, err := l.client.getArtistTopSongs(ctx, mbid, count) + if err != nil { + return nil, err + } + if len(resp) == 0 { + return nil, agents.ErrNotFound + } + + res := make([]agents.Song, len(resp)) + for i, t := range resp { + mbid := "" + if len(t.ArtistMBIDs) > 0 { + mbid = t.ArtistMBIDs[0] + } + + res[i] = agents.Song{ + Album: t.ReleaseName, + AlbumMBID: t.ReleaseMBID, + Artist: t.ArtistName, + ArtistMBID: mbid, + Duration: t.DurationMs, + Name: t.RecordingName, + MBID: t.RecordingMbid, + } + } + return res, nil +} + +func (l *listenBrainzAgent) GetSimilarArtists(ctx context.Context, id string, name string, mbid string, limit int) ([]agents.Artist, error) { + if mbid == "" { + return nil, agents.ErrNotFound + } + + resp, err := l.client.getSimilarArtists(ctx, mbid, limit) + if err != nil { + return nil, err + } + + if len(resp) == 0 { + return nil, agents.ErrNotFound + } + + artists := make([]agents.Artist, len(resp)) + for i, artist := range resp { + artists[i] = agents.Artist{ + MBID: artist.MBID, + Name: artist.Name, + } + } + + return artists, nil +} + +func (l *listenBrainzAgent) GetSimilarSongsByTrack(ctx context.Context, id string, name string, artist string, mbid string, limit int) ([]agents.Song, error) { + if mbid == "" { + return nil, agents.ErrNotFound + } + + resp, err := l.client.getSimilarRecordings(ctx, mbid, limit) + if err != nil { + return nil, err + } + + if len(resp) == 0 { + return nil, agents.ErrNotFound + } + + songs := make([]agents.Song, len(resp)) + for i, song := range resp { + songs[i] = agents.Song{ + Album: song.ReleaseName, + AlbumMBID: song.ReleaseMBID, + Artist: song.Artist, + MBID: song.MBID, + Name: song.Name, + } + } + + return songs, nil +} + func init() { conf.AddHook(func() { if conf.Server.ListenBrainz.Enabled { scrobbler.Register(listenBrainzAgentName, func(ds model.DataStore) scrobbler.Scrobbler { - return listenBrainzConstructor(ds) + // This is a workaround for the fact that a (Interface)(nil) is not the same as a (*listenBrainzAgent)(nil) + // See https://go.dev/doc/faq#nil_error + a := listenBrainzConstructor(ds) + if a != nil { + return a + } + return nil + }) + + agents.Register(listenBrainzAgentName, func(ds model.DataStore) agents.Interface { + // This is a workaround for the fact that a (Interface)(nil) is not the same as a (*listenBrainzAgent)(nil) + // See https://go.dev/doc/faq#nil_error + a := listenBrainzConstructor(ds) + if a != nil { + return a + } + return nil }) } }) } + +var ( + _ agents.ArtistTopSongsRetriever = (*listenBrainzAgent)(nil) + _ agents.ArtistURLRetriever = (*listenBrainzAgent)(nil) + _ agents.ArtistSimilarRetriever = (*listenBrainzAgent)(nil) + _ agents.SimilarSongsByTrackRetriever = (*listenBrainzAgent)(nil) +) diff --git a/adapters/listenbrainz/agent_test.go b/adapters/listenbrainz/agent_test.go new file mode 100644 index 000000000..df70ec9c4 --- /dev/null +++ b/adapters/listenbrainz/agent_test.go @@ -0,0 +1,443 @@ +package listenbrainz + +import ( + "bytes" + "context" + "encoding/json" + "errors" + "io" + "net/http" + "os" + "time" + + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/core/agents" + "github.com/navidrome/navidrome/core/scrobbler" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + . "github.com/onsi/gomega/gstruct" +) + +var _ = Describe("listenBrainzAgent", func() { + var ds model.DataStore + var ctx context.Context + var agent *listenBrainzAgent + var httpClient *tests.FakeHttpClient + var track *model.MediaFile + + BeforeEach(func() { + ds = &tests.MockDataStore{} + ctx = context.Background() + _ = ds.UserProps(ctx).Put("user-1", sessionKeyProperty, "SK-1") + httpClient = &tests.FakeHttpClient{} + agent = listenBrainzConstructor(ds) + agent.client = newClient("http://localhost:8080", httpClient) + track = &model.MediaFile{ + ID: "123", + Title: "Track Title", + Album: "Track Album", + Artist: "Track Artist", + TrackNumber: 1, + MbzRecordingID: "mbz-123", + MbzAlbumID: "mbz-456", + MbzReleaseGroupID: "mbz-789", + Duration: 142.2, + Participants: map[model.Role]model.ParticipantList{ + model.RoleArtist: []model.Participant{ + {Artist: model.Artist{ID: "ar-1", Name: "Artist 1", MbzArtistID: "mbz-111"}}, + {Artist: model.Artist{ID: "ar-2", Name: "Artist 2", MbzArtistID: "mbz-222"}}, + }, + }, + } + }) + + Describe("formatListen", func() { + It("constructs the listenInfo properly", func() { + lr := agent.formatListen(track) + Expect(lr).To(MatchAllFields(Fields{ + "ListenedAt": Equal(0), + "TrackMetadata": MatchAllFields(Fields{ + "ArtistName": Equal(track.Artist), + "TrackName": Equal(track.Title), + "ReleaseName": Equal(track.Album), + "AdditionalInfo": MatchAllFields(Fields{ + "SubmissionClient": Equal(consts.AppName), + "SubmissionClientVersion": Equal(consts.Version), + "TrackNumber": Equal(track.TrackNumber), + "RecordingMBID": Equal(track.MbzRecordingID), + "ReleaseMBID": Equal(track.MbzAlbumID), + "ReleaseGroupMBID": Equal(track.MbzReleaseGroupID), + "ArtistNames": ConsistOf("Artist 1", "Artist 2"), + "ArtistMBIDs": ConsistOf("mbz-111", "mbz-222"), + "DurationMs": Equal(142200), + }), + }), + })) + }) + }) + + Describe("NowPlaying", func() { + It("updates NowPlaying successfully", func() { + httpClient.Res = http.Response{Body: io.NopCloser(bytes.NewBufferString(`{"status": "ok"}`)), StatusCode: 200} + + err := agent.NowPlaying(ctx, "user-1", track, 0) + Expect(err).ToNot(HaveOccurred()) + }) + + It("returns ErrNotAuthorized if user is not linked", func() { + err := agent.NowPlaying(ctx, "user-2", track, 0) + Expect(err).To(MatchError(scrobbler.ErrNotAuthorized)) + }) + }) + + Describe("Scrobble", func() { + var sc scrobbler.Scrobble + + BeforeEach(func() { + sc = scrobbler.Scrobble{MediaFile: *track, TimeStamp: time.Now()} + }) + + It("sends a Scrobble successfully", func() { + httpClient.Res = http.Response{Body: io.NopCloser(bytes.NewBufferString(`{"status": "ok"}`)), StatusCode: 200} + + err := agent.Scrobble(ctx, "user-1", sc) + Expect(err).ToNot(HaveOccurred()) + }) + + It("sets the Timestamp properly", func() { + httpClient.Res = http.Response{Body: io.NopCloser(bytes.NewBufferString(`{"status": "ok"}`)), StatusCode: 200} + + err := agent.Scrobble(ctx, "user-1", sc) + Expect(err).ToNot(HaveOccurred()) + + decoder := json.NewDecoder(httpClient.SavedRequest.Body) + var lr listenBrainzRequestBody + err = decoder.Decode(&lr) + + Expect(err).ToNot(HaveOccurred()) + Expect(lr.Payload[0].ListenedAt).To(Equal(int(sc.TimeStamp.Unix()))) + }) + + It("returns ErrNotAuthorized if user is not linked", func() { + err := agent.Scrobble(ctx, "user-2", sc) + Expect(err).To(MatchError(scrobbler.ErrNotAuthorized)) + }) + + It("returns ErrRetryLater on error 503", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`{"code": 503, "error": "Cannot submit listens to queue, please try again later."}`)), + StatusCode: 503, + } + + err := agent.Scrobble(ctx, "user-1", sc) + Expect(err).To(MatchError(scrobbler.ErrRetryLater)) + }) + + It("returns ErrRetryLater on error 500", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`{"code": 500, "error": "Something went wrong. Please try again."}`)), + StatusCode: 500, + } + + err := agent.Scrobble(ctx, "user-1", sc) + Expect(err).To(MatchError(scrobbler.ErrRetryLater)) + }) + + It("returns ErrRetryLater on http errors", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`Bad Gateway`)), + StatusCode: 500, + } + + err := agent.Scrobble(ctx, "user-1", sc) + Expect(err).To(MatchError(scrobbler.ErrRetryLater)) + }) + + It("returns ErrUnrecoverable on other errors", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`{"code": 400, "error": "BadRequest: Invalid JSON document submitted."}`)), + StatusCode: 400, + } + + err := agent.Scrobble(ctx, "user-1", sc) + Expect(err).To(MatchError(scrobbler.ErrUnrecoverable)) + }) + }) + + Describe("GetArtistUrl", func() { + var agent *listenBrainzAgent + var httpClient *tests.FakeHttpClient + BeforeEach(func() { + httpClient = &tests.FakeHttpClient{} + client := newClient("BASE_URL", httpClient) + agent = listenBrainzConstructor(ds) + agent.client = client + }) + + It("returns artist url when MBID present", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.artist.metadata.homepage.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + Expect(agent.GetArtistURL(ctx, "", "", "d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56")).To(Equal("http://projectmili.com/")) + Expect(httpClient.RequestCount).To(Equal(1)) + Expect(httpClient.SavedRequest.URL.Query().Get("artist_mbids")).To(Equal("d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56")) + }) + + It("returns error when url not present", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.artist.metadata.no_homepage.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + _, err := agent.GetArtistURL(ctx, "", "", "7c2cc610-f998-43ef-a08f-dae3344b8973") + Expect(err).To(HaveOccurred()) + Expect(httpClient.RequestCount).To(Equal(1)) + Expect(httpClient.SavedRequest.URL.Query().Get("artist_mbids")).To(Equal("7c2cc610-f998-43ef-a08f-dae3344b8973")) + }) + + It("returns error when fetch calls fails", func() { + httpClient.Err = errors.New("error") + _, err := agent.GetArtistURL(ctx, "", "", "7c2cc610-f998-43ef-a08f-dae3344b8973") + Expect(err).To(HaveOccurred()) + Expect(httpClient.RequestCount).To(Equal(1)) + Expect(httpClient.SavedRequest.URL.Query().Get("artist_mbids")).To(Equal("7c2cc610-f998-43ef-a08f-dae3344b8973")) + }) + + It("returns error when ListenBrainz returns an error", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`{"code": 400,"error": "artist mbid 1 is not valid."}`)), + StatusCode: 400, + } + _, err := agent.GetArtistURL(ctx, "", "", "7c2cc610-f998-43ef-a08f-dae3344b8973") + Expect(err).To(HaveOccurred()) + Expect(httpClient.RequestCount).To(Equal(1)) + Expect(httpClient.SavedRequest.URL.Query().Get("artist_mbids")).To(Equal("7c2cc610-f998-43ef-a08f-dae3344b8973")) + }) + }) + + Describe("GetTopSongs", func() { + var agent *listenBrainzAgent + var httpClient *tests.FakeHttpClient + BeforeEach(func() { + httpClient = &tests.FakeHttpClient{} + client := newClient("BASE_URL", httpClient) + agent = listenBrainzConstructor(ds) + agent.client = client + }) + + It("returns error when fetch calls", func() { + httpClient.Err = errors.New("error") + _, err := agent.GetArtistTopSongs(ctx, "", "", "d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56", 1) + Expect(err).To(HaveOccurred()) + Expect(httpClient.RequestCount).To(Equal(1)) + Expect(httpClient.SavedRequest.URL.Path).To(Equal("/1/popularity/top-recordings-for-artist/d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56")) + }) + + It("returns an error on listenbrainz error", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`{"code":400,"error":"artist_mbid: '1' is not a valid uuid"}`)), + StatusCode: 400, + } + _, err := agent.GetArtistTopSongs(ctx, "", "", "1", 1) + Expect(err).To(HaveOccurred()) + Expect(httpClient.RequestCount).To(Equal(1)) + Expect(httpClient.SavedRequest.URL.Path).To(Equal("/1/popularity/top-recordings-for-artist/1")) + }) + + It("returns all tracks when asked", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.popularity.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + data, err := agent.GetArtistTopSongs(ctx, "", "", "d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56", 2) + Expect(err).ToNot(HaveOccurred()) + Expect(data).To(Equal([]agents.Song{ + { + ID: "", + Name: "world.execute(me);", + MBID: "9980309d-3480-4e7e-89ce-fce971a452be", + Artist: "Mili", + ArtistMBID: "d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56", + Album: "Miracle Milk", + AlbumMBID: "38a8f6e1-0e34-4418-a89d-78240a367408", + Duration: 211912, + }, + { + ID: "", + Name: "String Theocracy", + MBID: "afa2c83d-b17f-4029-b9da-790ea9250cf9", + Artist: "Mili", + ArtistMBID: "d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56", + Album: "String Theocracy", + AlbumMBID: "d79a38e3-7016-4f39-a31a-f495ce914b8e", + Duration: 174000, + }, + })) + }) + + It("returns only one track when prompted", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.popularity.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + data, err := agent.GetArtistTopSongs(ctx, "", "", "d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56", 1) + Expect(err).ToNot(HaveOccurred()) + Expect(data).To(Equal([]agents.Song{ + { + ID: "", + Name: "world.execute(me);", + MBID: "9980309d-3480-4e7e-89ce-fce971a452be", + Artist: "Mili", + ArtistMBID: "d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56", + Album: "Miracle Milk", + AlbumMBID: "38a8f6e1-0e34-4418-a89d-78240a367408", + Duration: 211912, + }, + })) + }) + }) + + Describe("GetSimilarArtists", func() { + var agent *listenBrainzAgent + var httpClient *tests.FakeHttpClient + baseUrl := "https://labs.api.listenbrainz.org/similar-artists/json?algorithm=session_based_days_9000_session_300_contribution_5_threshold_15_limit_50_skip_30&artist_mbids=" + mbid := "db92a151-1ac2-438b-bc43-b82e149ddd50" + + BeforeEach(func() { + httpClient = &tests.FakeHttpClient{} + client := newClient("BASE_URL", httpClient) + agent = listenBrainzConstructor(ds) + agent.client = client + }) + + It("returns error when fetch calls", func() { + httpClient.Err = errors.New("error") + _, err := agent.GetSimilarArtists(ctx, "", "", mbid, 1) + Expect(err).To(HaveOccurred()) + Expect(httpClient.RequestCount).To(Equal(1)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(baseUrl + mbid)) + }) + + It("returns an error on listenbrainz error", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`Bad request`)), + StatusCode: 400, + } + _, err := agent.GetSimilarArtists(ctx, "", "", "1", 1) + Expect(err).To(HaveOccurred()) + Expect(httpClient.RequestCount).To(Equal(1)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(baseUrl + "1")) + }) + + It("returns all data on call", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.labs.similar-artists.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + + resp, err := agent.GetSimilarArtists(ctx, "", "", "db92a151-1ac2-438b-bc43-b82e149ddd50", 2) + Expect(err).ToNot(HaveOccurred()) + Expect(httpClient.RequestCount).To(Equal(1)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(baseUrl + mbid)) + Expect(resp).To(Equal([]agents.Artist{ + {MBID: "f27ec8db-af05-4f36-916e-3d57f91ecf5e", Name: "Michael Jackson"}, + {MBID: "7364dea6-ca9a-48e3-be01-b44ad0d19897", Name: "a-ha"}, + })) + }) + + It("returns subset of data on call", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.labs.similar-artists.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + + resp, err := agent.GetSimilarArtists(ctx, "", "", "db92a151-1ac2-438b-bc43-b82e149ddd50", 1) + Expect(err).ToNot(HaveOccurred()) + Expect(httpClient.RequestCount).To(Equal(1)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(baseUrl + mbid)) + Expect(resp).To(Equal([]agents.Artist{ + {MBID: "f27ec8db-af05-4f36-916e-3d57f91ecf5e", Name: "Michael Jackson"}, + })) + }) + }) + + Describe("GetSimilarTracks", func() { + var agent *listenBrainzAgent + var httpClient *tests.FakeHttpClient + mbid := "8f3471b5-7e6a-48da-86a9-c1c07a0f47ae" + baseUrl := "https://labs.api.listenbrainz.org/similar-recordings/json?algorithm=session_based_days_9000_session_300_contribution_5_threshold_15_limit_50_skip_30&recording_mbids=" + + BeforeEach(func() { + httpClient = &tests.FakeHttpClient{} + client := newClient("BASE_URL", httpClient) + agent = listenBrainzConstructor(ds) + agent.client = client + }) + + It("returns error when fetch calls", func() { + httpClient.Err = errors.New("error") + _, err := agent.GetSimilarSongsByTrack(ctx, "", "", "", mbid, 1) + Expect(err).To(HaveOccurred()) + Expect(httpClient.RequestCount).To(Equal(1)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(baseUrl + mbid)) + }) + + It("returns an error on listenbrainz error", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`Bad request`)), + StatusCode: 400, + } + _, err := agent.GetSimilarSongsByTrack(ctx, "", "", "", "1", 1) + Expect(err).To(HaveOccurred()) + Expect(httpClient.RequestCount).To(Equal(1)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(baseUrl + "1")) + }) + + It("returns all data on call", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.labs.similar-recordings.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + + resp, err := agent.GetSimilarSongsByTrack(ctx, "", "", "", mbid, 2) + Expect(err).ToNot(HaveOccurred()) + Expect(httpClient.RequestCount).To(Equal(1)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(baseUrl + mbid)) + Expect(resp).To(Equal([]agents.Song{ + { + ID: "", + Name: "Take On Me", + MBID: "12f65dca-de8f-43fe-a65d-f12a02aaadf3", + ISRC: "", + Artist: "a‐ha", + ArtistMBID: "", + Album: "Hunting High and Low", + AlbumMBID: "4ec07fe8-e7c6-3106-a0aa-fdf92f13f7fc", + Duration: 0, + }, + { + ID: "", + Name: "Wake Me Up Before You Go‐Go", + MBID: "80033c72-aa19-4ba8-9227-afb075fec46e", + ISRC: "", + Artist: "Wham!", + ArtistMBID: "", + Album: "Make It Big", + AlbumMBID: "c143d542-48dc-446b-b523-1762da721638", + Duration: 0, + }, + })) + }) + + It("returns subset of data on call", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.labs.similar-recordings.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + + resp, err := agent.GetSimilarSongsByTrack(ctx, "", "", "", mbid, 1) + Expect(err).ToNot(HaveOccurred()) + Expect(httpClient.RequestCount).To(Equal(1)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(baseUrl + mbid)) + Expect(resp).To(Equal([]agents.Song{ + { + ID: "", + Name: "Take On Me", + MBID: "12f65dca-de8f-43fe-a65d-f12a02aaadf3", + ISRC: "", + Artist: "a‐ha", + ArtistMBID: "", + Album: "Hunting High and Low", + AlbumMBID: "4ec07fe8-e7c6-3106-a0aa-fdf92f13f7fc", + Duration: 0, + }, + })) + }) + }) +}) diff --git a/core/agents/listenbrainz/auth_router.go b/adapters/listenbrainz/auth_router.go similarity index 95% rename from core/agents/listenbrainz/auth_router.go rename to adapters/listenbrainz/auth_router.go index 2382aeb73..7cb9eb16a 100644 --- a/core/agents/listenbrainz/auth_router.go +++ b/adapters/listenbrainz/auth_router.go @@ -60,7 +60,7 @@ func (s *Router) routes() http.Handler { } func (s *Router) getLinkStatus(w http.ResponseWriter, r *http.Request) { - resp := map[string]interface{}{} + resp := map[string]any{} u, _ := request.UserFrom(r.Context()) key, err := s.sessionKeys.Get(r.Context(), u.ID) if err != nil && !errors.Is(err, model.ErrNotFound) { @@ -107,7 +107,7 @@ func (s *Router) link(w http.ResponseWriter, r *http.Request) { return } - _ = rest.RespondWithJSON(w, http.StatusOK, map[string]interface{}{"status": resp.Valid, "user": resp.UserName}) + _ = rest.RespondWithJSON(w, http.StatusOK, map[string]any{"status": resp.Valid, "user": resp.UserName}) } func (s *Router) unlink(w http.ResponseWriter, r *http.Request) { diff --git a/core/agents/listenbrainz/auth_router_test.go b/adapters/listenbrainz/auth_router_test.go similarity index 97% rename from core/agents/listenbrainz/auth_router_test.go rename to adapters/listenbrainz/auth_router_test.go index dc705dbc9..c3861799a 100644 --- a/core/agents/listenbrainz/auth_router_test.go +++ b/adapters/listenbrainz/auth_router_test.go @@ -37,7 +37,7 @@ var _ = Describe("ListenBrainz Auth Router", func() { req = httptest.NewRequest("GET", "/listenbrainz/link", nil) r.getLinkStatus(resp, req) Expect(resp.Code).To(Equal(http.StatusOK)) - var parsed map[string]interface{} + var parsed map[string]any Expect(json.Unmarshal(resp.Body.Bytes(), &parsed)).To(BeNil()) Expect(parsed["status"]).To(Equal(false)) }) @@ -47,7 +47,7 @@ var _ = Describe("ListenBrainz Auth Router", func() { req = httptest.NewRequest("GET", "/listenbrainz/link", nil) r.getLinkStatus(resp, req) Expect(resp.Code).To(Equal(http.StatusOK)) - var parsed map[string]interface{} + var parsed map[string]any Expect(json.Unmarshal(resp.Body.Bytes(), &parsed)).To(BeNil()) Expect(parsed["status"]).To(Equal(true)) }) @@ -80,7 +80,7 @@ var _ = Describe("ListenBrainz Auth Router", func() { req = httptest.NewRequest("PUT", "/listenbrainz/link", strings.NewReader(`{"token": "tok-1"}`)) r.link(resp, req) Expect(resp.Code).To(Equal(http.StatusOK)) - var parsed map[string]interface{} + var parsed map[string]any Expect(json.Unmarshal(resp.Body.Bytes(), &parsed)).To(BeNil()) Expect(parsed["status"]).To(Equal(true)) Expect(parsed["user"]).To(Equal("ListenBrainzUser")) diff --git a/adapters/listenbrainz/client.go b/adapters/listenbrainz/client.go new file mode 100644 index 000000000..708f02f28 --- /dev/null +++ b/adapters/listenbrainz/client.go @@ -0,0 +1,378 @@ +package listenbrainz + +import ( + "bytes" + "cmp" + "context" + "encoding/json" + "errors" + "fmt" + "net/http" + "net/url" + "path" + "slices" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/log" +) + +const ( + lbzApiUrl = "https://api.listenbrainz.org/1/" + labsBase = "https://labs.api.listenbrainz.org/" +) + +var ( + ErrorNotFound = errors.New("listenbrainz: not found") +) + +type listenBrainzError struct { + Code int + Message string +} + +func (e *listenBrainzError) Error() string { + return fmt.Sprintf("ListenBrainz error(%d): %s", e.Code, e.Message) +} + +type httpDoer interface { + Do(req *http.Request) (*http.Response, error) +} + +func newClient(baseURL string, hc httpDoer) *client { + return &client{baseURL, hc} +} + +type client struct { + baseURL string + hc httpDoer +} + +type listenBrainzResponse struct { + Code int `json:"code"` + Message string `json:"message"` + Error string `json:"error"` + Status string `json:"status"` + Valid bool `json:"valid"` + UserName string `json:"user_name"` +} + +type listenBrainzRequest struct { + ApiKey string //nolint:gosec + Body listenBrainzRequestBody +} + +type listenBrainzRequestBody struct { + ListenType listenType `json:"listen_type,omitempty"` + Payload []listenInfo `json:"payload,omitempty"` +} + +type listenType string + +const ( + Single listenType = "single" + PlayingNow listenType = "playing_now" +) + +type listenInfo struct { + ListenedAt int `json:"listened_at,omitempty"` + TrackMetadata trackMetadata `json:"track_metadata"` +} + +type trackMetadata struct { + ArtistName string `json:"artist_name,omitempty"` + TrackName string `json:"track_name,omitempty"` + ReleaseName string `json:"release_name,omitempty"` + AdditionalInfo additionalInfo `json:"additional_info"` +} + +type additionalInfo struct { + SubmissionClient string `json:"submission_client,omitempty"` + SubmissionClientVersion string `json:"submission_client_version,omitempty"` + TrackNumber int `json:"tracknumber,omitempty"` + ArtistNames []string `json:"artist_names,omitempty"` + ArtistMBIDs []string `json:"artist_mbids,omitempty"` + RecordingMBID string `json:"recording_mbid,omitempty"` + ReleaseMBID string `json:"release_mbid,omitempty"` + ReleaseGroupMBID string `json:"release_group_mbid,omitempty"` + DurationMs int `json:"duration_ms,omitempty"` +} + +func (c *client) validateToken(ctx context.Context, apiKey string) (*listenBrainzResponse, error) { + r := &listenBrainzRequest{ + ApiKey: apiKey, + } + response, err := c.makeAuthenticatedRequest(ctx, http.MethodGet, "validate-token", r) + if err != nil { + return nil, err + } + return response, nil +} + +func (c *client) updateNowPlaying(ctx context.Context, apiKey string, li listenInfo) error { + r := &listenBrainzRequest{ + ApiKey: apiKey, + Body: listenBrainzRequestBody{ + ListenType: PlayingNow, + Payload: []listenInfo{li}, + }, + } + + resp, err := c.makeAuthenticatedRequest(ctx, http.MethodPost, "submit-listens", r) + if err != nil { + return err + } + if resp.Status != "ok" { + log.Warn(ctx, "ListenBrainz: NowPlaying was not accepted", "status", resp.Status) + } + return nil +} + +func (c *client) scrobble(ctx context.Context, apiKey string, li listenInfo) error { + r := &listenBrainzRequest{ + ApiKey: apiKey, + Body: listenBrainzRequestBody{ + ListenType: Single, + Payload: []listenInfo{li}, + }, + } + resp, err := c.makeAuthenticatedRequest(ctx, http.MethodPost, "submit-listens", r) + if err != nil { + return err + } + if resp.Status != "ok" { + log.Warn(ctx, "ListenBrainz: Scrobble was not accepted", "status", resp.Status) + } + return nil +} + +func (c *client) path(endpoint string) (string, error) { + u, err := url.Parse(c.baseURL) + if err != nil { + return "", err + } + u.Path = path.Join(u.Path, endpoint) + return u.String(), nil +} + +func (c *client) makeAuthenticatedRequest(ctx context.Context, method string, endpoint string, r *listenBrainzRequest) (*listenBrainzResponse, error) { + b, _ := json.Marshal(r.Body) + uri, err := c.path(endpoint) + if err != nil { + return nil, err + } + req, _ := http.NewRequestWithContext(ctx, method, uri, bytes.NewBuffer(b)) + req.Header.Add("Content-Type", "application/json; charset=UTF-8") + + if r.ApiKey != "" { + req.Header.Add("Authorization", fmt.Sprintf("Token %s", r.ApiKey)) + } + + log.Trace(ctx, fmt.Sprintf("Sending ListenBrainz %s request", req.Method), "url", req.URL) + resp, err := c.hc.Do(req) + if err != nil { + return nil, err + } + + defer resp.Body.Close() + decoder := json.NewDecoder(resp.Body) + + var response listenBrainzResponse + jsonErr := decoder.Decode(&response) + if resp.StatusCode != 200 && jsonErr != nil { + return nil, fmt.Errorf("ListenBrainz: HTTP Error, Status: (%d)", resp.StatusCode) + } + if jsonErr != nil { + return nil, jsonErr + } + if response.Code != 0 && response.Code != 200 { + return &response, &listenBrainzError{Code: response.Code, Message: response.Error} + } + + return &response, nil +} + +type lbzHttpError struct { + Code int `json:"code"` + Error string `json:"error"` +} + +func (c *client) makeGenericRequest(ctx context.Context, method string, endpoint string, params url.Values) (*http.Response, error) { + req, _ := http.NewRequestWithContext(ctx, method, lbzApiUrl+endpoint, nil) + req.Header.Add("Content-Type", "application/json; charset=UTF-8") + req.URL.RawQuery = params.Encode() + + log.Trace(ctx, fmt.Sprintf("Sending ListenBrainz %s request", req.Method), "url", req.URL) + resp, err := c.hc.Do(req) + + if err != nil { + return nil, err + } + + // On a 200 code, there is no code. Decode using using error message if it exists + if resp.StatusCode != 200 { + defer resp.Body.Close() + decoder := json.NewDecoder(resp.Body) + + var lbzError lbzHttpError + jsonErr := decoder.Decode(&lbzError) + + if jsonErr != nil { + return nil, fmt.Errorf("ListenBrainz: HTTP Error, Status: (%d)", resp.StatusCode) + } + + return nil, &listenBrainzError{Code: lbzError.Code, Message: lbzError.Error} + } + + return resp, err +} + +type artistMetadataResult struct { + Rels struct { + OfficialHomepage string `json:"official homepage,omitempty"` + } `json:"rels,omitzero"` +} + +func (c *client) getArtistUrl(ctx context.Context, mbid string) (string, error) { + params := url.Values{} + params.Add("artist_mbids", mbid) + resp, err := c.makeGenericRequest(ctx, http.MethodGet, "metadata/artist", params) + if err != nil { + return "", err + } + + defer resp.Body.Close() + decoder := json.NewDecoder(resp.Body) + + var response []artistMetadataResult + jsonErr := decoder.Decode(&response) + if jsonErr != nil { + return "", fmt.Errorf("ListenBrainz: HTTP Error, Status: (%d)", resp.StatusCode) + } + + if len(response) == 0 || response[0].Rels.OfficialHomepage == "" { + return "", ErrorNotFound + } + + return response[0].Rels.OfficialHomepage, nil +} + +type trackInfo struct { + ArtistName string `json:"artist_name"` + ArtistMBIDs []string `json:"artist_mbids"` + DurationMs uint32 `json:"length"` + RecordingName string `json:"recording_name"` + RecordingMbid string `json:"recording_mbid"` + ReleaseName string `json:"release_name"` + ReleaseMBID string `json:"release_mbid"` +} + +func (c *client) getArtistTopSongs(ctx context.Context, mbid string, count int) ([]trackInfo, error) { + resp, err := c.makeGenericRequest(ctx, http.MethodGet, "popularity/top-recordings-for-artist/"+mbid, url.Values{}) + if err != nil { + return nil, err + } + + defer resp.Body.Close() + decoder := json.NewDecoder(resp.Body) + + var response []trackInfo + jsonErr := decoder.Decode(&response) + if jsonErr != nil { + return nil, fmt.Errorf("ListenBrainz: HTTP Error, Status: (%d)", resp.StatusCode) + } + + if len(response) > count { + return response[0:count], nil + } + + return response, nil +} + +type artist struct { + MBID string `json:"artist_mbid"` + Name string `json:"name"` + Score int `json:"score"` +} + +func (c *client) getSimilarArtists(ctx context.Context, mbid string, limit int) ([]artist, error) { + req, _ := http.NewRequestWithContext(ctx, http.MethodGet, labsBase+"similar-artists/json", nil) + req.Header.Add("Content-Type", "application/json; charset=UTF-8") + req.URL.RawQuery = url.Values{ + "artist_mbids": []string{mbid}, "algorithm": []string{conf.Server.ListenBrainz.ArtistAlgorithm}, + }.Encode() + + log.Trace(ctx, fmt.Sprintf("Sending ListenBrainz Labs %s request", req.Method), "url", req.URL) + resp, err := c.hc.Do(req) + + if err != nil { + return nil, err + } + + defer resp.Body.Close() + decoder := json.NewDecoder(resp.Body) + + var artists []artist + jsonErr := decoder.Decode(&artists) + if jsonErr != nil { + return nil, fmt.Errorf("ListenBrainz: HTTP Error, Status: (%d)", resp.StatusCode) + } + + if len(artists) > limit { + return artists[:limit], nil + } + + return artists, nil +} + +type recording struct { + MBID string `json:"recording_mbid"` + Name string `json:"recording_name"` + Artist string `json:"artist_credit_name"` + ReleaseName string `json:"release_name"` + ReleaseMBID string `json:"release_mbid"` + Score int `json:"score"` +} + +func (c *client) getSimilarRecordings(ctx context.Context, mbid string, limit int) ([]recording, error) { + req, _ := http.NewRequestWithContext(ctx, http.MethodGet, labsBase+"similar-recordings/json", nil) + req.Header.Add("Content-Type", "application/json; charset=UTF-8") + req.URL.RawQuery = url.Values{ + "recording_mbids": []string{mbid}, "algorithm": []string{conf.Server.ListenBrainz.TrackAlgorithm}, + }.Encode() + + log.Trace(ctx, fmt.Sprintf("Sending ListenBrainz Labs %s request", req.Method), "url", req.URL) + resp, err := c.hc.Do(req) + + if err != nil { + return nil, err + } + + defer resp.Body.Close() + decoder := json.NewDecoder(resp.Body) + + var recordings []recording + jsonErr := decoder.Decode(&recordings) + if jsonErr != nil { + return nil, fmt.Errorf("ListenBrainz: HTTP Error, Status: (%d)", resp.StatusCode) + } + + // For whatever reason, labs API isn't guaranteed to give results in the proper order + // and may also provide duplicates. See listenbrainz.labs.similar-recordings-real-out-of-order.json + // generated from https://labs.api.listenbrainz.org/similar-recordings/json?recording_mbids=8f3471b5-7e6a-48da-86a9-c1c07a0f47ae&algorithm=session_based_days_180_session_300_contribution_5_threshold_15_limit_50_skip_30 + slices.SortFunc(recordings, func(a, b recording) int { + return cmp.Or( + cmp.Compare(b.Score, a.Score), // Sort by score descending + cmp.Compare(a.MBID, b.MBID), // Then by MBID ascending to ensure deterministic order for duplicates + ) + }) + + recordings = slices.CompactFunc(recordings, func(a, b recording) bool { + return a.MBID == b.MBID + }) + + if len(recordings) > limit { + return recordings[:limit], nil + } + + return recordings, nil +} diff --git a/adapters/listenbrainz/client_test.go b/adapters/listenbrainz/client_test.go new file mode 100644 index 000000000..319cf01ab --- /dev/null +++ b/adapters/listenbrainz/client_test.go @@ -0,0 +1,464 @@ +package listenbrainz + +import ( + "bytes" + "context" + "encoding/json" + "fmt" + "io" + "net/http" + "os" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("client", func() { + var httpClient *tests.FakeHttpClient + var client *client + BeforeEach(func() { + httpClient = &tests.FakeHttpClient{} + client = newClient("BASE_URL/", httpClient) + }) + + Describe("listenBrainzResponse", func() { + It("parses a response properly", func() { + var response listenBrainzResponse + err := json.Unmarshal([]byte(`{"code": 200, "message": "Message", "user_name": "UserName", "valid": true, "status": "ok", "error": "Error"}`), &response) + + Expect(err).ToNot(HaveOccurred()) + Expect(response.Code).To(Equal(200)) + Expect(response.Message).To(Equal("Message")) + Expect(response.UserName).To(Equal("UserName")) + Expect(response.Valid).To(BeTrue()) + Expect(response.Status).To(Equal("ok")) + Expect(response.Error).To(Equal("Error")) + }) + }) + + Describe("validateToken", func() { + BeforeEach(func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`{"code": 200, "message": "Token valid.", "user_name": "ListenBrainzUser", "valid": true}`)), + StatusCode: 200, + } + }) + + It("formats the request properly", func() { + _, err := client.validateToken(context.Background(), "LB-TOKEN") + Expect(err).ToNot(HaveOccurred()) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal("BASE_URL/validate-token")) + Expect(httpClient.SavedRequest.Header.Get("Authorization")).To(Equal("Token LB-TOKEN")) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + }) + + It("parses and returns the response", func() { + res, err := client.validateToken(context.Background(), "LB-TOKEN") + Expect(err).ToNot(HaveOccurred()) + Expect(res.Valid).To(Equal(true)) + Expect(res.UserName).To(Equal("ListenBrainzUser")) + }) + }) + + Context("with listenInfo", func() { + var li listenInfo + BeforeEach(func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`{"status": "ok"}`)), + StatusCode: 200, + } + li = listenInfo{ + TrackMetadata: trackMetadata{ + ArtistName: "Track Artist", + TrackName: "Track Title", + ReleaseName: "Track Album", + AdditionalInfo: additionalInfo{ + TrackNumber: 1, + ArtistNames: []string{"Artist 1", "Artist 2"}, + ArtistMBIDs: []string{"mbz-789", "mbz-012"}, + RecordingMBID: "mbz-123", + ReleaseMBID: "mbz-456", + DurationMs: 142200, + }, + }, + } + }) + + Describe("updateNowPlaying", func() { + It("formats the request properly", func() { + Expect(client.updateNowPlaying(context.Background(), "LB-TOKEN", li)).To(Succeed()) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodPost)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal("BASE_URL/submit-listens")) + Expect(httpClient.SavedRequest.Header.Get("Authorization")).To(Equal("Token LB-TOKEN")) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + + body, _ := io.ReadAll(httpClient.SavedRequest.Body) + f, _ := os.ReadFile("tests/fixtures/listenbrainz.nowplaying.request.json") + Expect(body).To(MatchJSON(f)) + }) + }) + + Describe("scrobble", func() { + BeforeEach(func() { + li.ListenedAt = 1635000000 + }) + + It("formats the request properly", func() { + Expect(client.scrobble(context.Background(), "LB-TOKEN", li)).To(Succeed()) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodPost)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal("BASE_URL/submit-listens")) + Expect(httpClient.SavedRequest.Header.Get("Authorization")).To(Equal("Token LB-TOKEN")) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + + body, _ := io.ReadAll(httpClient.SavedRequest.Body) + f, _ := os.ReadFile("tests/fixtures/listenbrainz.scrobble.request.json") + Expect(body).To(MatchJSON(f)) + }) + }) + }) + + Context("getArtistUrl", func() { + baseUrl := "https://api.listenbrainz.org/1/metadata/artist?" + It("handles a malformed request with status code", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`{"code": 400,"error": "artist mbid 1 is not valid."}`)), + StatusCode: 400, + } + _, err := client.getArtistUrl(context.Background(), "1") + Expect(err.Error()).To(Equal("ListenBrainz error(400): artist mbid 1 is not valid.")) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(baseUrl + "artist_mbids=1")) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + }) + + It("handles a malformed request without meaningful body", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(``)), + StatusCode: 501, + } + _, err := client.getArtistUrl(context.Background(), "1") + Expect(err.Error()).To(Equal("ListenBrainz: HTTP Error, Status: (501)")) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(baseUrl + "artist_mbids=1")) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + }) + + It("It returns not found when the artist has no official homepage", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.artist.metadata.no_homepage.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + _, err := client.getArtistUrl(context.Background(), "7c2cc610-f998-43ef-a08f-dae3344b8973") + Expect(err.Error()).To(Equal("listenbrainz: not found")) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(baseUrl + "artist_mbids=7c2cc610-f998-43ef-a08f-dae3344b8973")) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + }) + + It("It returns data when the artist has a homepage", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.artist.metadata.homepage.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + url, err := client.getArtistUrl(context.Background(), "d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56") + Expect(err).ToNot(HaveOccurred()) + Expect(url).To(Equal("http://projectmili.com/")) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(baseUrl + "artist_mbids=d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56")) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + }) + }) + + Context("getArtistTopSongs", func() { + baseUrl := "https://api.listenbrainz.org/1/popularity/top-recordings-for-artist/" + + It("handles a malformed request with status code", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`{"code":400,"error":"artist_mbid: '1' is not a valid uuid"}`)), + StatusCode: 400, + } + _, err := client.getArtistTopSongs(context.Background(), "1", 50) + Expect(err.Error()).To(Equal("ListenBrainz error(400): artist_mbid: '1' is not a valid uuid")) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(baseUrl + "1")) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + }) + + It("handles a malformed request without standard body", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(``)), + StatusCode: 500, + } + _, err := client.getArtistTopSongs(context.Background(), "1", 1) + Expect(err.Error()).To(Equal("ListenBrainz: HTTP Error, Status: (500)")) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(baseUrl + "1")) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + }) + + It("It returns all tracks when given the opportunity", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.popularity.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + data, err := client.getArtistTopSongs(context.Background(), "d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56", 5) + Expect(err).ToNot(HaveOccurred()) + Expect(data).To(Equal([]trackInfo{ + { + ArtistName: "Mili", + ArtistMBIDs: []string{"d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56"}, + DurationMs: 211912, + RecordingName: "world.execute(me);", + RecordingMbid: "9980309d-3480-4e7e-89ce-fce971a452be", + ReleaseName: "Miracle Milk", + ReleaseMBID: "38a8f6e1-0e34-4418-a89d-78240a367408", + }, + { + ArtistName: "Mili", + ArtistMBIDs: []string{"d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56"}, + DurationMs: 174000, + RecordingName: "String Theocracy", + RecordingMbid: "afa2c83d-b17f-4029-b9da-790ea9250cf9", + ReleaseName: "String Theocracy", + ReleaseMBID: "d79a38e3-7016-4f39-a31a-f495ce914b8e", + }, + })) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(baseUrl + "d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56")) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + }) + + It("It returns a subset of tracks when allowed", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.popularity.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + data, err := client.getArtistTopSongs(context.Background(), "d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56", 1) + Expect(err).ToNot(HaveOccurred()) + Expect(data).To(Equal([]trackInfo{ + { + ArtistName: "Mili", + ArtistMBIDs: []string{"d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56"}, + DurationMs: 211912, + RecordingName: "world.execute(me);", + RecordingMbid: "9980309d-3480-4e7e-89ce-fce971a452be", + ReleaseName: "Miracle Milk", + ReleaseMBID: "38a8f6e1-0e34-4418-a89d-78240a367408", + }, + })) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(baseUrl + "d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56")) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + }) + }) + + Context("getSimilarArtists", func() { + var algorithm string + + BeforeEach(func() { + algorithm = "session_based_days_9000_session_300_contribution_5_threshold_15_limit_50_skip_30" + DeferCleanup(configtest.SetupConfig()) + }) + + getUrl := func(mbid string) string { + return fmt.Sprintf("https://labs.api.listenbrainz.org/similar-artists/json?algorithm=%s&artist_mbids=%s", algorithm, mbid) + } + + mbid := "db92a151-1ac2-438b-bc43-b82e149ddd50" + + It("handles a malformed request with status code", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`Bad request`)), + StatusCode: 400, + } + _, err := client.getSimilarArtists(context.Background(), "1", 2) + Expect(err.Error()).To(Equal("ListenBrainz: HTTP Error, Status: (400)")) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(getUrl("1"))) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + }) + + It("handles real data properly", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.labs.similar-artists.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + resp, err := client.getSimilarArtists(context.Background(), mbid, 2) + Expect(err).ToNot(HaveOccurred()) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(getUrl(mbid))) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + Expect(resp).To(Equal([]artist{ + {MBID: "f27ec8db-af05-4f36-916e-3d57f91ecf5e", Name: "Michael Jackson", Score: 800}, + {MBID: "7364dea6-ca9a-48e3-be01-b44ad0d19897", Name: "a-ha", Score: 792}, + })) + }) + + It("truncates data when requested", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.labs.similar-artists.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + resp, err := client.getSimilarArtists(context.Background(), "db92a151-1ac2-438b-bc43-b82e149ddd50", 1) + Expect(err).ToNot(HaveOccurred()) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(getUrl(mbid))) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + Expect(resp).To(Equal([]artist{ + {MBID: "f27ec8db-af05-4f36-916e-3d57f91ecf5e", Name: "Michael Jackson", Score: 800}, + })) + }) + + It("fetches a different endpoint when algorithm changes", func() { + algorithm = "session_based_days_1825_session_300_contribution_3_threshold_10_limit_100_filter_True_skip_30" + conf.Server.ListenBrainz.ArtistAlgorithm = algorithm + + f, _ := os.Open("tests/fixtures/listenbrainz.labs.similar-artists.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + resp, err := client.getSimilarArtists(context.Background(), mbid, 2) + Expect(err).ToNot(HaveOccurred()) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(getUrl(mbid))) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + Expect(resp).To(Equal([]artist{ + {MBID: "f27ec8db-af05-4f36-916e-3d57f91ecf5e", Name: "Michael Jackson", Score: 800}, + {MBID: "7364dea6-ca9a-48e3-be01-b44ad0d19897", Name: "a-ha", Score: 792}, + })) + }) + }) + + Context("getSimilarRecordings", func() { + var algorithm string + + BeforeEach(func() { + algorithm = "session_based_days_9000_session_300_contribution_5_threshold_15_limit_50_skip_30" + DeferCleanup(configtest.SetupConfig()) + }) + + getUrl := func(mbid string) string { + return fmt.Sprintf("https://labs.api.listenbrainz.org/similar-recordings/json?algorithm=%s&recording_mbids=%s", algorithm, mbid) + } + + mbid := "8f3471b5-7e6a-48da-86a9-c1c07a0f47ae" + + It("handles a malformed request with status code", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`Bad request`)), + StatusCode: 400, + } + _, err := client.getSimilarRecordings(context.Background(), "1", 2) + Expect(err.Error()).To(Equal("ListenBrainz: HTTP Error, Status: (400)")) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(getUrl("1"))) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + }) + + It("handles real data properly", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.labs.similar-recordings.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + resp, err := client.getSimilarRecordings(context.Background(), mbid, 2) + Expect(err).ToNot(HaveOccurred()) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(getUrl(mbid))) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + Expect(resp).To(Equal([]recording{ + { + MBID: "12f65dca-de8f-43fe-a65d-f12a02aaadf3", + Name: "Take On Me", + Artist: "a‐ha", + ReleaseName: "Hunting High and Low", + ReleaseMBID: "4ec07fe8-e7c6-3106-a0aa-fdf92f13f7fc", + Score: 124, + }, + { + MBID: "80033c72-aa19-4ba8-9227-afb075fec46e", + Name: "Wake Me Up Before You Go‐Go", + Artist: "Wham!", + ReleaseName: "Make It Big", + ReleaseMBID: "c143d542-48dc-446b-b523-1762da721638", + Score: 65, + }, + })) + }) + + It("truncates data when requested", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.labs.similar-recordings.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + resp, err := client.getSimilarRecordings(context.Background(), mbid, 1) + Expect(err).ToNot(HaveOccurred()) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(getUrl(mbid))) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + Expect(resp).To(Equal([]recording{ + { + MBID: "12f65dca-de8f-43fe-a65d-f12a02aaadf3", + Name: "Take On Me", + Artist: "a‐ha", + ReleaseName: "Hunting High and Low", + ReleaseMBID: "4ec07fe8-e7c6-3106-a0aa-fdf92f13f7fc", + Score: 124, + }, + })) + }) + + It("properly sorts by score and truncates duplicates", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.labs.similar-recordings-real-out-of-order.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + // There are actually 5 items. The dedup should happen FIRST + resp, err := client.getSimilarRecordings(context.Background(), mbid, 4) + Expect(err).ToNot(HaveOccurred()) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(getUrl(mbid))) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + Expect(resp).To(Equal([]recording{ + { + MBID: "12f65dca-de8f-43fe-a65d-f12a02aaadf3", + Name: "Take On Me", + Artist: "a‐ha", + ReleaseName: "Hunting High and Low", + ReleaseMBID: "4ec07fe8-e7c6-3106-a0aa-fdf92f13f7fc", + Score: 124, + }, + { + MBID: "e4b347be-ecb2-44ff-aaa8-3d4c517d7ea5", + Name: "Everybody Wants to Rule the World", + Artist: "Tears for Fears", + ReleaseName: "Songs From the Big Chair", + ReleaseMBID: "21f19b06-81f1-347a-add5-5d0c77696597", + Score: 68, + }, + { + MBID: "80033c72-aa19-4ba8-9227-afb075fec46e", + Name: "Wake Me Up Before You Go‐Go", + Artist: "Wham!", + ReleaseName: "Make It Big", + ReleaseMBID: "c143d542-48dc-446b-b523-1762da721638", + Score: 65, + }, + { + MBID: "ef4c6855-949e-4e22-b41e-8e0a2d372d5f", + Name: "Tainted Love", + Artist: "Soft Cell", + ReleaseName: "Non-Stop Erotic Cabaret", + ReleaseMBID: "1acaa870-6e0c-4b6e-9e91-fdec4e5ea4b1", + Score: 61, + }, + })) + }) + + It("uses a different algorithm when configured", func() { + algorithm = "session_based_days_180_session_300_contribution_5_threshold_15_limit_50_skip_30" + conf.Server.ListenBrainz.TrackAlgorithm = algorithm + + f, _ := os.Open("tests/fixtures/listenbrainz.labs.similar-recordings.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + resp, err := client.getSimilarRecordings(context.Background(), mbid, 1) + Expect(err).ToNot(HaveOccurred()) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(getUrl(mbid))) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + Expect(resp).To(Equal([]recording{ + { + MBID: "12f65dca-de8f-43fe-a65d-f12a02aaadf3", + Name: "Take On Me", + Artist: "a‐ha", + ReleaseName: "Hunting High and Low", + ReleaseMBID: "4ec07fe8-e7c6-3106-a0aa-fdf92f13f7fc", + Score: 124, + }, + })) + }) + }) +}) diff --git a/core/agents/listenbrainz/listenbrainz_suite_test.go b/adapters/listenbrainz/listenbrainz_suite_test.go similarity index 100% rename from core/agents/listenbrainz/listenbrainz_suite_test.go rename to adapters/listenbrainz/listenbrainz_suite_test.go diff --git a/adapters/taglib/end_to_end_test.go b/adapters/taglib/end_to_end_test.go index e4d94bb24..265f258f5 100644 --- a/adapters/taglib/end_to_end_test.go +++ b/adapters/taglib/end_to_end_test.go @@ -151,11 +151,7 @@ var _ = Describe("Extractor", func() { unsSylt := makeLyrics("xxx", "unspecified SYLT") unsUslt := makeLyrics("xxx", "unspecified") - // Why is the order inconsistent between runs? Nobody knows - Expect(lyrics).To(Or( - Equal(model.LyricList{engSylt, engUslt, unsSylt, unsUslt}), - Equal(model.LyricList{unsSylt, unsUslt, engSylt, engUslt}), - )) + Expect(lyrics).To(ConsistOf(engSylt, engUslt, unsSylt, unsUslt)) }) DescribeTable("format-specific lyrics", func(file string, isId3 bool) { diff --git a/adapters/taglib/taglib.go b/adapters/taglib/taglib.go index 62a949d85..ac299ea2b 100644 --- a/adapters/taglib/taglib.go +++ b/adapters/taglib/taglib.go @@ -43,23 +43,21 @@ func (e extractor) extractMetadata(filePath string) (*metadata.Info, error) { // Parse audio properties ap := metadata.AudioProperties{} - if length, ok := tags["_lengthinmilliseconds"]; ok && len(length) > 0 { - millis, _ := strconv.Atoi(length[0]) - if millis > 0 { - ap.Duration = (time.Millisecond * time.Duration(millis)).Round(time.Millisecond * 10) - } - delete(tags, "_lengthinmilliseconds") - } - parseProp := func(prop string, target *int) { - if value, ok := tags[prop]; ok && len(value) > 0 { - *target, _ = strconv.Atoi(value[0]) - delete(tags, prop) - } - } - parseProp("_bitrate", &ap.BitRate) - parseProp("_channels", &ap.Channels) - parseProp("_samplerate", &ap.SampleRate) - parseProp("_bitspersample", &ap.BitDepth) + ap.BitRate = parseProp(tags, "__bitrate") + ap.Channels = parseProp(tags, "__channels") + ap.SampleRate = parseProp(tags, "__samplerate") + ap.BitDepth = parseProp(tags, "__bitspersample") + length := parseProp(tags, "__lengthinmilliseconds") + ap.Duration = (time.Millisecond * time.Duration(length)).Round(time.Millisecond * 10) + + // Extract basic tags + parseBasicTag(tags, "__title", "title") + parseBasicTag(tags, "__artist", "artist") + parseBasicTag(tags, "__album", "album") + parseBasicTag(tags, "__comment", "comment") + parseBasicTag(tags, "__genre", "genre") + parseBasicTag(tags, "__year", "year") + parseBasicTag(tags, "__track", "tracknumber") // Parse track/disc totals parseTuple := func(prop string) { @@ -107,6 +105,31 @@ var tiplMapping = map[string]string{ "DJ-mix": "djmixer", } +// parseProp parses a property from the tags map and sets it to the target integer. +// It also deletes the property from the tags map after parsing. +func parseProp(tags map[string][]string, prop string) int { + if value, ok := tags[prop]; ok && len(value) > 0 { + v, _ := strconv.Atoi(value[0]) + delete(tags, prop) + return v + } + return 0 +} + +// parseBasicTag checks if a basic tag (like __title, __artist, etc.) exists in the tags map. +// If it does, it moves the value to a more appropriate tag name (like title, artist, etc.), +// and deletes the basic tag from the map. If the target tag already exists, it ignores the basic tag. +func parseBasicTag(tags map[string][]string, basicName string, tagName string) { + basicValue := tags[basicName] + if len(basicValue) == 0 { + return + } + delete(tags, basicName) + if len(tags[tagName]) == 0 { + tags[tagName] = basicValue + } +} + // parseTIPL parses the ID3v2.4 TIPL frame string, which is received from TagLib in the format: // // "arranger Andrew Powell engineer Chris Blair engineer Pat Stapley producer Eric Woolfson". @@ -145,7 +168,7 @@ func parseTIPL(tags map[string][]string) { var _ local.Extractor = (*extractor)(nil) func init() { - local.RegisterExtractor("taglib", func(_ fs.FS, baseDir string) local.Extractor { + local.RegisterExtractor("legacy-taglib", func(_ fs.FS, baseDir string) local.Extractor { // ignores fs, as taglib extractor only works with local files return &extractor{baseDir} }) diff --git a/adapters/taglib/taglib_test.go b/adapters/taglib/taglib_test.go index f24c0e839..f524f77ec 100644 --- a/adapters/taglib/taglib_test.go +++ b/adapters/taglib/taglib_test.go @@ -80,12 +80,11 @@ var _ = Describe("Extractor", func() { Expect(err).To(BeNil()) Expect(m.Tags).To(HaveKeyWithValue("fbpm", []string{"141.7"})) - // TabLib 1.12 returns 18, previous versions return 39. + // TagLib 1.12 returns 18, previous versions return 39. // See https://github.com/taglib/taglib/commit/2f238921824741b2cfe6fbfbfc9701d9827ab06b Expect(m.AudioProperties.BitRate).To(BeElementOf(18, 19, 39, 40, 43, 49)) Expect(m.AudioProperties.Channels).To(BeElementOf(2)) Expect(m.AudioProperties.SampleRate).To(BeElementOf(8000)) - Expect(m.AudioProperties.SampleRate).To(BeElementOf(8000)) Expect(m.HasPicture).To(BeTrue()) }) @@ -106,7 +105,7 @@ var _ = Describe("Extractor", func() { Expect(m.Tags).To(Or( HaveKeyWithValue("replaygain_album_gain", []string{albumGain}), - HaveKeyWithValue("----:com.apple.itunes:replaygain_track_gain", []string{albumGain}), + HaveKeyWithValue("----:com.apple.itunes:replaygain_album_gain", []string{albumGain}), )) Expect(m.Tags).To(Or( diff --git a/adapters/taglib/taglib_wrapper.cpp b/adapters/taglib/taglib_wrapper.cpp index 224642c6d..2985e8f18 100644 --- a/adapters/taglib/taglib_wrapper.cpp +++ b/adapters/taglib/taglib_wrapper.cpp @@ -45,31 +45,63 @@ int taglib_read(const FILENAME_CHAR_T *filename, unsigned long id) { // Add audio properties to the tags const TagLib::AudioProperties *props(f.audioProperties()); - goPutInt(id, (char *)"_lengthinmilliseconds", props->lengthInMilliseconds()); - goPutInt(id, (char *)"_bitrate", props->bitrate()); - goPutInt(id, (char *)"_channels", props->channels()); - goPutInt(id, (char *)"_samplerate", props->sampleRate()); + goPutInt(id, (char *)"__lengthinmilliseconds", props->lengthInMilliseconds()); + goPutInt(id, (char *)"__bitrate", props->bitrate()); + goPutInt(id, (char *)"__channels", props->channels()); + goPutInt(id, (char *)"__samplerate", props->sampleRate()); + // Extract bits per sample for supported formats + int bitsPerSample = 0; if (const auto* apeProperties{ dynamic_cast(props) }) - goPutInt(id, (char *)"_bitspersample", apeProperties->bitsPerSample()); - if (const auto* asfProperties{ dynamic_cast(props) }) - goPutInt(id, (char *)"_bitspersample", asfProperties->bitsPerSample()); + bitsPerSample = apeProperties->bitsPerSample(); + else if (const auto* asfProperties{ dynamic_cast(props) }) + bitsPerSample = asfProperties->bitsPerSample(); else if (const auto* flacProperties{ dynamic_cast(props) }) - goPutInt(id, (char *)"_bitspersample", flacProperties->bitsPerSample()); + bitsPerSample = flacProperties->bitsPerSample(); else if (const auto* mp4Properties{ dynamic_cast(props) }) - goPutInt(id, (char *)"_bitspersample", mp4Properties->bitsPerSample()); + bitsPerSample = mp4Properties->bitsPerSample(); else if (const auto* wavePackProperties{ dynamic_cast(props) }) - goPutInt(id, (char *)"_bitspersample", wavePackProperties->bitsPerSample()); + bitsPerSample = wavePackProperties->bitsPerSample(); else if (const auto* aiffProperties{ dynamic_cast(props) }) - goPutInt(id, (char *)"_bitspersample", aiffProperties->bitsPerSample()); + bitsPerSample = aiffProperties->bitsPerSample(); else if (const auto* wavProperties{ dynamic_cast(props) }) - goPutInt(id, (char *)"_bitspersample", wavProperties->bitsPerSample()); + bitsPerSample = wavProperties->bitsPerSample(); else if (const auto* dsfProperties{ dynamic_cast(props) }) - goPutInt(id, (char *)"_bitspersample", dsfProperties->bitsPerSample()); + bitsPerSample = dsfProperties->bitsPerSample(); + + if (bitsPerSample > 0) { + goPutInt(id, (char *)"__bitspersample", bitsPerSample); + } // Send all properties to the Go map TagLib::PropertyMap tags = f.file()->properties(); + // Make sure at least the basic properties are extracted + TagLib::Tag *basic = f.file()->tag(); + if (!basic->isEmpty()) { + if (!basic->title().isEmpty()) { + tags.insert("__title", basic->title()); + } + if (!basic->artist().isEmpty()) { + tags.insert("__artist", basic->artist()); + } + if (!basic->album().isEmpty()) { + tags.insert("__album", basic->album()); + } + if (!basic->comment().isEmpty()) { + tags.insert("__comment", basic->comment()); + } + if (!basic->genre().isEmpty()) { + tags.insert("__genre", basic->genre()); + } + if (basic->year() > 0) { + tags.insert("__year", TagLib::String::number(basic->year())); + } + if (basic->track() > 0) { + tags.insert("__track", TagLib::String::number(basic->track())); + } + } + TagLib::ID3v2::Tag *id3Tags = NULL; // Get some extended/non-standard ID3-only tags (ex: iTunes extended frames) diff --git a/cmd/pls.go b/cmd/pls.go index fc0f22fba..9b94c9e8f 100644 --- a/cmd/pls.go +++ b/cmd/pls.go @@ -10,11 +10,8 @@ import ( "strconv" "github.com/Masterminds/squirrel" - "github.com/navidrome/navidrome/core/auth" - "github.com/navidrome/navidrome/db" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/persistence" "github.com/spf13/cobra" ) @@ -52,7 +49,7 @@ var ( Short: "Export playlists", Long: "Export Navidrome playlists to M3U files", Run: func(cmd *cobra.Command, args []string) { - runExporter() + runExporter(cmd.Context()) }, } @@ -60,15 +57,13 @@ var ( Use: "list", Short: "List playlists", Run: func(cmd *cobra.Command, args []string) { - runList() + runList(cmd.Context()) }, } ) -func runExporter() { - sqlDB := db.Db() - ds := persistence.New(sqlDB) - ctx := auth.WithAdminUser(context.Background(), ds) +func runExporter(ctx context.Context) { + ds, ctx := getAdminContext(ctx) playlist, err := ds.Playlist(ctx).GetWithTracks(playlistID, true, false) if err != nil && !errors.Is(err, model.ErrNotFound) { log.Fatal("Error retrieving playlist", "name", playlistID, err) @@ -100,31 +95,19 @@ func runExporter() { } } -func runList() { +func runList(ctx context.Context) { if outputFormat != "csv" && outputFormat != "json" { log.Fatal("Invalid output format. Must be one of csv, json", "format", outputFormat) } - sqlDB := db.Db() - ds := persistence.New(sqlDB) - ctx := auth.WithAdminUser(context.Background(), ds) - + ds, ctx := getAdminContext(ctx) options := model.QueryOptions{Sort: "owner_name"} if userID != "" { - user, err := ds.User(ctx).FindByUsername(userID) - - if err != nil && !errors.Is(err, model.ErrNotFound) { - log.Fatal("Error retrieving user by name", "name", userID, err) + user, err := getUser(ctx, userID, ds) + if err != nil { + log.Fatal(ctx, "Error retrieving user", "username or id", userID) } - - if errors.Is(err, model.ErrNotFound) { - user, err = ds.User(ctx).Get(userID) - if err != nil { - log.Fatal("Error retrieving user by id", "id", userID, err) - } - } - options.Filters = squirrel.Eq{"owner_id": user.ID} } diff --git a/cmd/plugin.go b/cmd/plugin.go deleted file mode 100644 index 0f3b66078..000000000 --- a/cmd/plugin.go +++ /dev/null @@ -1,716 +0,0 @@ -package cmd - -import ( - "cmp" - "crypto/sha256" - "encoding/hex" - "fmt" - "io" - "os" - "path/filepath" - "strings" - "text/tabwriter" - "time" - - "github.com/navidrome/navidrome/conf" - "github.com/navidrome/navidrome/log" - "github.com/navidrome/navidrome/plugins" - "github.com/navidrome/navidrome/plugins/schema" - "github.com/navidrome/navidrome/utils" - "github.com/navidrome/navidrome/utils/slice" - "github.com/spf13/cobra" -) - -const ( - pluginPackageExtension = ".ndp" - pluginDirPermissions = 0700 - pluginFilePermissions = 0600 -) - -func init() { - pluginCmd := &cobra.Command{ - Use: "plugin", - Short: "Manage Navidrome plugins", - Long: "Commands for managing Navidrome plugins", - } - - listCmd := &cobra.Command{ - Use: "list", - Short: "List installed plugins", - Long: "List all installed plugins with their metadata", - Run: pluginList, - } - - infoCmd := &cobra.Command{ - Use: "info [pluginPackage|pluginName]", - Short: "Show details of a plugin", - Long: "Show detailed information about a plugin package (.ndp file) or an installed plugin", - Args: cobra.ExactArgs(1), - Run: pluginInfo, - } - - installCmd := &cobra.Command{ - Use: "install [pluginPackage]", - Short: "Install a plugin from a .ndp file", - Long: "Install a Navidrome Plugin Package (.ndp) file", - Args: cobra.ExactArgs(1), - Run: pluginInstall, - } - - removeCmd := &cobra.Command{ - Use: "remove [pluginName]", - Short: "Remove an installed plugin", - Long: "Remove a plugin by name", - Args: cobra.ExactArgs(1), - Run: pluginRemove, - } - - updateCmd := &cobra.Command{ - Use: "update [pluginPackage]", - Short: "Update an existing plugin", - Long: "Update an installed plugin with a new version from a .ndp file", - Args: cobra.ExactArgs(1), - Run: pluginUpdate, - } - - refreshCmd := &cobra.Command{ - Use: "refresh [pluginName]", - Short: "Reload a plugin without restarting Navidrome", - Long: "Reload and recompile a plugin without needing to restart Navidrome", - Args: cobra.ExactArgs(1), - Run: pluginRefresh, - } - - devCmd := &cobra.Command{ - Use: "dev [folder_path]", - Short: "Create symlink to development folder", - Long: "Create a symlink from a plugin development folder to the plugins directory for easier development", - Args: cobra.ExactArgs(1), - Run: pluginDev, - } - - pluginCmd.AddCommand(listCmd, infoCmd, installCmd, removeCmd, updateCmd, refreshCmd, devCmd) - rootCmd.AddCommand(pluginCmd) -} - -// Validation helpers - -func validatePluginPackageFile(path string) error { - if !utils.FileExists(path) { - return fmt.Errorf("plugin package not found: %s", path) - } - if filepath.Ext(path) != pluginPackageExtension { - return fmt.Errorf("not a valid plugin package: %s (expected %s extension)", path, pluginPackageExtension) - } - return nil -} - -func validatePluginDirectory(pluginsDir, pluginName string) (string, error) { - pluginDir := filepath.Join(pluginsDir, pluginName) - if !utils.FileExists(pluginDir) { - return "", fmt.Errorf("plugin not found: %s (path: %s)", pluginName, pluginDir) - } - return pluginDir, nil -} - -func resolvePluginPath(pluginDir string) (resolvedPath string, isSymlink bool, err error) { - // Check if it's a directory or a symlink - lstat, err := os.Lstat(pluginDir) - if err != nil { - return "", false, fmt.Errorf("failed to stat plugin: %w", err) - } - - isSymlink = lstat.Mode()&os.ModeSymlink != 0 - - if isSymlink { - // Resolve the symlink target - targetDir, err := os.Readlink(pluginDir) - if err != nil { - return "", true, fmt.Errorf("failed to resolve symlink: %w", err) - } - - // If target is a relative path, make it absolute - if !filepath.IsAbs(targetDir) { - targetDir = filepath.Join(filepath.Dir(pluginDir), targetDir) - } - - // Verify the target exists and is a directory - targetInfo, err := os.Stat(targetDir) - if err != nil { - return "", true, fmt.Errorf("failed to access symlink target %s: %w", targetDir, err) - } - - if !targetInfo.IsDir() { - return "", true, fmt.Errorf("symlink target is not a directory: %s", targetDir) - } - - return targetDir, true, nil - } else if !lstat.IsDir() { - return "", false, fmt.Errorf("not a valid plugin directory: %s", pluginDir) - } - - return pluginDir, false, nil -} - -// Package handling helpers - -func loadAndValidatePackage(ndpPath string) (*plugins.PluginPackage, error) { - if err := validatePluginPackageFile(ndpPath); err != nil { - return nil, err - } - - pkg, err := plugins.LoadPackage(ndpPath) - if err != nil { - return nil, fmt.Errorf("failed to load plugin package: %w", err) - } - - return pkg, nil -} - -func extractAndSetupPlugin(ndpPath, targetDir string) error { - if err := plugins.ExtractPackage(ndpPath, targetDir); err != nil { - return fmt.Errorf("failed to extract plugin package: %w", err) - } - - ensurePluginDirPermissions(targetDir) - return nil -} - -// Display helpers - -func displayPluginTableRow(w *tabwriter.Writer, discovery plugins.PluginDiscoveryEntry) { - if discovery.Error != nil { - // Handle global errors (like directory read failure) - if discovery.ID == "" { - log.Error("Failed to read plugins directory", "folder", conf.Server.Plugins.Folder, discovery.Error) - return - } - // Handle individual plugin errors - show them in the table - fmt.Fprintf(w, "%s\tERROR\tERROR\tERROR\tERROR\t%v\n", discovery.ID, discovery.Error) - return - } - - // Mark symlinks with an indicator - nameDisplay := discovery.Manifest.Name - if discovery.IsSymlink { - nameDisplay = nameDisplay + " (dev)" - } - - // Convert capabilities to strings - capabilities := slice.Map(discovery.Manifest.Capabilities, func(cap schema.PluginManifestCapabilitiesElem) string { - return string(cap) - }) - - fmt.Fprintf(w, "%s\t%s\t%s\t%s\t%s\t%s\n", - discovery.ID, - nameDisplay, - cmp.Or(discovery.Manifest.Author, "-"), - cmp.Or(discovery.Manifest.Version, "-"), - strings.Join(capabilities, ", "), - cmp.Or(discovery.Manifest.Description, "-")) -} - -func displayTypedPermissions(permissions schema.PluginManifestPermissions, indent string) { - if permissions.Http != nil { - fmt.Printf("%shttp:\n", indent) - fmt.Printf("%s Reason: %s\n", indent, permissions.Http.Reason) - fmt.Printf("%s Allow Local Network: %t\n", indent, permissions.Http.AllowLocalNetwork) - fmt.Printf("%s Allowed URLs:\n", indent) - for urlPattern, methodEnums := range permissions.Http.AllowedUrls { - methods := make([]string, len(methodEnums)) - for i, methodEnum := range methodEnums { - methods[i] = string(methodEnum) - } - fmt.Printf("%s %s: [%s]\n", indent, urlPattern, strings.Join(methods, ", ")) - } - fmt.Println() - } - - if permissions.Config != nil { - fmt.Printf("%sconfig:\n", indent) - fmt.Printf("%s Reason: %s\n", indent, permissions.Config.Reason) - fmt.Println() - } - - if permissions.Scheduler != nil { - fmt.Printf("%sscheduler:\n", indent) - fmt.Printf("%s Reason: %s\n", indent, permissions.Scheduler.Reason) - fmt.Println() - } - - if permissions.Websocket != nil { - fmt.Printf("%swebsocket:\n", indent) - fmt.Printf("%s Reason: %s\n", indent, permissions.Websocket.Reason) - fmt.Printf("%s Allow Local Network: %t\n", indent, permissions.Websocket.AllowLocalNetwork) - fmt.Printf("%s Allowed URLs: [%s]\n", indent, strings.Join(permissions.Websocket.AllowedUrls, ", ")) - fmt.Println() - } - - if permissions.Cache != nil { - fmt.Printf("%scache:\n", indent) - fmt.Printf("%s Reason: %s\n", indent, permissions.Cache.Reason) - fmt.Println() - } - - if permissions.Artwork != nil { - fmt.Printf("%sartwork:\n", indent) - fmt.Printf("%s Reason: %s\n", indent, permissions.Artwork.Reason) - fmt.Println() - } - - if permissions.Subsonicapi != nil { - allowedUsers := "All Users" - if len(permissions.Subsonicapi.AllowedUsernames) > 0 { - allowedUsers = strings.Join(permissions.Subsonicapi.AllowedUsernames, ", ") - } - fmt.Printf("%ssubsonicapi:\n", indent) - fmt.Printf("%s Reason: %s\n", indent, permissions.Subsonicapi.Reason) - fmt.Printf("%s Allow Admins: %t\n", indent, permissions.Subsonicapi.AllowAdmins) - fmt.Printf("%s Allowed Usernames: [%s]\n", indent, allowedUsers) - fmt.Println() - } -} - -func displayPluginDetails(manifest *schema.PluginManifest, fileInfo *pluginFileInfo, permInfo *pluginPermissionInfo) { - fmt.Println("\nPlugin Information:") - fmt.Printf(" Name: %s\n", manifest.Name) - fmt.Printf(" Author: %s\n", manifest.Author) - fmt.Printf(" Version: %s\n", manifest.Version) - fmt.Printf(" Description: %s\n", manifest.Description) - - fmt.Print(" Capabilities: ") - capabilities := make([]string, len(manifest.Capabilities)) - for i, cap := range manifest.Capabilities { - capabilities[i] = string(cap) - } - fmt.Print(strings.Join(capabilities, ", ")) - fmt.Println() - - // Display manifest permissions using the typed permissions - fmt.Println(" Required Permissions:") - displayTypedPermissions(manifest.Permissions, " ") - - // Print file information if available - if fileInfo != nil { - fmt.Println("Package Information:") - fmt.Printf(" File: %s\n", fileInfo.path) - fmt.Printf(" Size: %d bytes (%.2f KB)\n", fileInfo.size, float64(fileInfo.size)/1024) - fmt.Printf(" SHA-256: %s\n", fileInfo.hash) - fmt.Printf(" Modified: %s\n", fileInfo.modTime.Format(time.RFC3339)) - } - - // Print file permissions information if available - if permInfo != nil { - fmt.Println("File Permissions:") - fmt.Printf(" Plugin Directory: %s (%s)\n", permInfo.dirPath, permInfo.dirMode) - if permInfo.isSymlink { - fmt.Printf(" Symlink Target: %s (%s)\n", permInfo.targetPath, permInfo.targetMode) - } - fmt.Printf(" Manifest File: %s\n", permInfo.manifestMode) - if permInfo.wasmMode != "" { - fmt.Printf(" WASM File: %s\n", permInfo.wasmMode) - } - } -} - -type pluginFileInfo struct { - path string - size int64 - hash string - modTime time.Time -} - -type pluginPermissionInfo struct { - dirPath string - dirMode string - isSymlink bool - targetPath string - targetMode string - manifestMode string - wasmMode string -} - -func getFileInfo(path string) *pluginFileInfo { - fileInfo, err := os.Stat(path) - if err != nil { - log.Error("Failed to get file information", err) - return nil - } - - return &pluginFileInfo{ - path: path, - size: fileInfo.Size(), - hash: calculateSHA256(path), - modTime: fileInfo.ModTime(), - } -} - -func getPermissionInfo(pluginDir string) *pluginPermissionInfo { - // Get plugin directory permissions - dirInfo, err := os.Lstat(pluginDir) - if err != nil { - log.Error("Failed to get plugin directory permissions", err) - return nil - } - - permInfo := &pluginPermissionInfo{ - dirPath: pluginDir, - dirMode: dirInfo.Mode().String(), - } - - // Check if it's a symlink - if dirInfo.Mode()&os.ModeSymlink != 0 { - permInfo.isSymlink = true - - // Get target path and permissions - targetPath, err := os.Readlink(pluginDir) - if err == nil { - if !filepath.IsAbs(targetPath) { - targetPath = filepath.Join(filepath.Dir(pluginDir), targetPath) - } - permInfo.targetPath = targetPath - - if targetInfo, err := os.Stat(targetPath); err == nil { - permInfo.targetMode = targetInfo.Mode().String() - } - } - } - - // Get manifest file permissions - manifestPath := filepath.Join(pluginDir, "manifest.json") - if manifestInfo, err := os.Stat(manifestPath); err == nil { - permInfo.manifestMode = manifestInfo.Mode().String() - } - - // Get WASM file permissions (look for .wasm files) - entries, err := os.ReadDir(pluginDir) - if err == nil { - for _, entry := range entries { - if filepath.Ext(entry.Name()) == ".wasm" { - wasmPath := filepath.Join(pluginDir, entry.Name()) - if wasmInfo, err := os.Stat(wasmPath); err == nil { - permInfo.wasmMode = wasmInfo.Mode().String() - break // Just show the first WASM file found - } - } - } - } - - return permInfo -} - -// Command implementations - -func pluginList(cmd *cobra.Command, args []string) { - discoveries := plugins.DiscoverPlugins(conf.Server.Plugins.Folder) - - w := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0) - fmt.Fprintln(w, "ID\tNAME\tAUTHOR\tVERSION\tCAPABILITIES\tDESCRIPTION") - - for _, discovery := range discoveries { - displayPluginTableRow(w, discovery) - } - w.Flush() -} - -func pluginInfo(cmd *cobra.Command, args []string) { - path := args[0] - pluginsDir := conf.Server.Plugins.Folder - - var manifest *schema.PluginManifest - var fileInfo *pluginFileInfo - var permInfo *pluginPermissionInfo - - if filepath.Ext(path) == pluginPackageExtension { - // It's a package file - pkg, err := loadAndValidatePackage(path) - if err != nil { - log.Fatal("Failed to load plugin package", err) - } - manifest = pkg.Manifest - fileInfo = getFileInfo(path) - // No permission info for package files - } else { - // It's a plugin name - pluginDir, err := validatePluginDirectory(pluginsDir, path) - if err != nil { - log.Fatal("Plugin validation failed", err) - } - - manifest, err = plugins.LoadManifest(pluginDir) - if err != nil { - log.Fatal("Failed to load plugin manifest", err) - } - - // Get permission info for installed plugins - permInfo = getPermissionInfo(pluginDir) - } - - displayPluginDetails(manifest, fileInfo, permInfo) -} - -func pluginInstall(cmd *cobra.Command, args []string) { - ndpPath := args[0] - pluginsDir := conf.Server.Plugins.Folder - - pkg, err := loadAndValidatePackage(ndpPath) - if err != nil { - log.Fatal("Package validation failed", err) - } - - // Create target directory based on plugin name - targetDir := filepath.Join(pluginsDir, pkg.Manifest.Name) - - // Check if plugin already exists - if utils.FileExists(targetDir) { - log.Fatal("Plugin already installed", "name", pkg.Manifest.Name, "path", targetDir, - "use", "navidrome plugin update") - } - - if err := extractAndSetupPlugin(ndpPath, targetDir); err != nil { - log.Fatal("Plugin installation failed", err) - } - - fmt.Printf("Plugin '%s' v%s installed successfully\n", pkg.Manifest.Name, pkg.Manifest.Version) -} - -func pluginRemove(cmd *cobra.Command, args []string) { - pluginName := args[0] - pluginsDir := conf.Server.Plugins.Folder - - pluginDir, err := validatePluginDirectory(pluginsDir, pluginName) - if err != nil { - log.Fatal("Plugin validation failed", err) - } - - _, isSymlink, err := resolvePluginPath(pluginDir) - if err != nil { - log.Fatal("Failed to resolve plugin path", err) - } - - if isSymlink { - // For symlinked plugins (dev mode), just remove the symlink - if err := os.Remove(pluginDir); err != nil { - log.Fatal("Failed to remove plugin symlink", "name", pluginName, err) - } - fmt.Printf("Development plugin symlink '%s' removed successfully (target directory preserved)\n", pluginName) - } else { - // For regular plugins, remove the entire directory - if err := os.RemoveAll(pluginDir); err != nil { - log.Fatal("Failed to remove plugin directory", "name", pluginName, err) - } - fmt.Printf("Plugin '%s' removed successfully\n", pluginName) - } -} - -func pluginUpdate(cmd *cobra.Command, args []string) { - ndpPath := args[0] - pluginsDir := conf.Server.Plugins.Folder - - pkg, err := loadAndValidatePackage(ndpPath) - if err != nil { - log.Fatal("Package validation failed", err) - } - - // Check if plugin exists - targetDir := filepath.Join(pluginsDir, pkg.Manifest.Name) - if !utils.FileExists(targetDir) { - log.Fatal("Plugin not found", "name", pkg.Manifest.Name, "path", targetDir, - "use", "navidrome plugin install") - } - - // Create a backup of the existing plugin - backupDir := targetDir + ".bak." + time.Now().Format("20060102150405") - if err := os.Rename(targetDir, backupDir); err != nil { - log.Fatal("Failed to backup existing plugin", err) - } - - // Extract the new package - if err := extractAndSetupPlugin(ndpPath, targetDir); err != nil { - // Restore backup if extraction failed - os.RemoveAll(targetDir) - _ = os.Rename(backupDir, targetDir) // Ignore error as we're already in a fatal path - log.Fatal("Plugin update failed", err) - } - - // Remove the backup - os.RemoveAll(backupDir) - - fmt.Printf("Plugin '%s' updated to v%s successfully\n", pkg.Manifest.Name, pkg.Manifest.Version) -} - -func pluginRefresh(cmd *cobra.Command, args []string) { - pluginName := args[0] - pluginsDir := conf.Server.Plugins.Folder - - pluginDir, err := validatePluginDirectory(pluginsDir, pluginName) - if err != nil { - log.Fatal("Plugin validation failed", err) - } - - resolvedPath, isSymlink, err := resolvePluginPath(pluginDir) - if err != nil { - log.Fatal("Failed to resolve plugin path", err) - } - - if isSymlink { - log.Debug("Processing symlinked plugin", "name", pluginName, "link", pluginDir, "target", resolvedPath) - } - - fmt.Printf("Refreshing plugin '%s'...\n", pluginName) - - // Get the plugin manager and refresh - mgr := GetPluginManager(cmd.Context()) - log.Debug("Scanning plugins directory", "path", pluginsDir) - mgr.ScanPlugins() - - log.Info("Waiting for plugin compilation to complete", "name", pluginName) - - // Wait for compilation to complete - if err := mgr.EnsureCompiled(pluginName); err != nil { - log.Fatal("Failed to compile refreshed plugin", "name", pluginName, err) - } - - log.Info("Plugin compilation completed successfully", "name", pluginName) - fmt.Printf("Plugin '%s' refreshed successfully\n", pluginName) -} - -func pluginDev(cmd *cobra.Command, args []string) { - sourcePath, err := filepath.Abs(args[0]) - if err != nil { - log.Fatal("Invalid path", "path", args[0], err) - } - pluginsDir := conf.Server.Plugins.Folder - - // Validate source directory and manifest - if err := validateDevSource(sourcePath); err != nil { - log.Fatal("Source validation failed", err) - } - - // Load manifest to get plugin name - manifest, err := plugins.LoadManifest(sourcePath) - if err != nil { - log.Fatal("Failed to load plugin manifest", "path", filepath.Join(sourcePath, "manifest.json"), err) - } - - pluginName := cmp.Or(manifest.Name, filepath.Base(sourcePath)) - targetPath := filepath.Join(pluginsDir, pluginName) - - // Handle existing target - if err := handleExistingTarget(targetPath, sourcePath); err != nil { - log.Fatal("Failed to handle existing target", err) - } - - // Create target directory if needed - if err := os.MkdirAll(filepath.Dir(targetPath), 0755); err != nil { - log.Fatal("Failed to create plugins directory", "path", filepath.Dir(targetPath), err) - } - - // Create the symlink - if err := os.Symlink(sourcePath, targetPath); err != nil { - log.Fatal("Failed to create symlink", "source", sourcePath, "target", targetPath, err) - } - - fmt.Printf("Development symlink created: '%s' -> '%s'\n", targetPath, sourcePath) - fmt.Println("Plugin can be refreshed with: navidrome plugin refresh", pluginName) -} - -// Utility functions - -func validateDevSource(sourcePath string) error { - sourceInfo, err := os.Stat(sourcePath) - if err != nil { - return fmt.Errorf("source folder not found: %s (%w)", sourcePath, err) - } - if !sourceInfo.IsDir() { - return fmt.Errorf("source path is not a directory: %s", sourcePath) - } - - manifestPath := filepath.Join(sourcePath, "manifest.json") - if !utils.FileExists(manifestPath) { - return fmt.Errorf("source folder missing manifest.json: %s", sourcePath) - } - - return nil -} - -func handleExistingTarget(targetPath, sourcePath string) error { - if !utils.FileExists(targetPath) { - return nil // Nothing to handle - } - - // Check if it's already a symlink to our source - existingLink, err := os.Readlink(targetPath) - if err == nil && existingLink == sourcePath { - fmt.Printf("Symlink already exists and points to the correct source\n") - return fmt.Errorf("symlink already exists") // This will cause early return in caller - } - - // Handle case where target exists but is not a symlink to our source - fmt.Printf("Target path '%s' already exists.\n", targetPath) - fmt.Print("Do you want to replace it? (y/N): ") - var response string - _, err = fmt.Scanln(&response) - if err != nil || strings.ToLower(response) != "y" { - if err != nil { - log.Debug("Error reading input, assuming 'no'", err) - } - return fmt.Errorf("operation canceled") - } - - // Remove existing target - if err := os.RemoveAll(targetPath); err != nil { - return fmt.Errorf("failed to remove existing target %s: %w", targetPath, err) - } - - return nil -} - -func ensurePluginDirPermissions(dir string) { - if err := os.Chmod(dir, pluginDirPermissions); err != nil { - log.Error("Failed to set plugin directory permissions", "dir", dir, err) - } - - // Apply permissions to all files in the directory - entries, err := os.ReadDir(dir) - if err != nil { - log.Error("Failed to read plugin directory", "dir", dir, err) - return - } - - for _, entry := range entries { - path := filepath.Join(dir, entry.Name()) - info, err := os.Stat(path) - if err != nil { - log.Error("Failed to stat file", "path", path, err) - continue - } - - mode := os.FileMode(pluginFilePermissions) // Files - if info.IsDir() { - mode = os.FileMode(pluginDirPermissions) // Directories - ensurePluginDirPermissions(path) // Recursive - } - - if err := os.Chmod(path, mode); err != nil { - log.Error("Failed to set file permissions", "path", path, err) - } - } -} - -func calculateSHA256(filePath string) string { - file, err := os.Open(filePath) - if err != nil { - log.Error("Failed to open file for hashing", err) - return "N/A" - } - defer file.Close() - - hasher := sha256.New() - if _, err := io.Copy(hasher, file); err != nil { - log.Error("Failed to calculate hash", err) - return "N/A" - } - - return hex.EncodeToString(hasher.Sum(nil)) -} diff --git a/cmd/plugin_test.go b/cmd/plugin_test.go deleted file mode 100644 index 3a4aefa88..000000000 --- a/cmd/plugin_test.go +++ /dev/null @@ -1,193 +0,0 @@ -package cmd - -import ( - "io" - "os" - "path/filepath" - "strings" - - "github.com/navidrome/navidrome/conf" - "github.com/navidrome/navidrome/conf/configtest" - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" - "github.com/spf13/cobra" -) - -var _ = Describe("Plugin CLI Commands", func() { - var tempDir string - var cmd *cobra.Command - var stdOut *os.File - var origStdout *os.File - var outReader *os.File - - // Helper to create a test plugin with the given name and details - createTestPlugin := func(name, author, version string, capabilities []string) string { - pluginDir := filepath.Join(tempDir, name) - Expect(os.MkdirAll(pluginDir, 0755)).To(Succeed()) - - // Create a properly formatted capabilities JSON array - capabilitiesJSON := `"` + strings.Join(capabilities, `", "`) + `"` - - manifest := `{ - "name": "` + name + `", - "author": "` + author + `", - "version": "` + version + `", - "description": "Plugin for testing", - "website": "https://test.navidrome.org/` + name + `", - "capabilities": [` + capabilitiesJSON + `], - "permissions": {} - }` - - Expect(os.WriteFile(filepath.Join(pluginDir, "manifest.json"), []byte(manifest), 0600)).To(Succeed()) - - // Create a dummy WASM file - wasmContent := []byte("dummy wasm content for testing") - Expect(os.WriteFile(filepath.Join(pluginDir, "plugin.wasm"), wasmContent, 0600)).To(Succeed()) - - return pluginDir - } - - // Helper to execute a command and return captured output - captureOutput := func(reader io.Reader) string { - stdOut.Close() - outputBytes, err := io.ReadAll(reader) - Expect(err).NotTo(HaveOccurred()) - return string(outputBytes) - } - - BeforeEach(func() { - DeferCleanup(configtest.SetupConfig()) - tempDir = GinkgoT().TempDir() - - // Setup config - conf.Server.Plugins.Enabled = true - conf.Server.Plugins.Folder = tempDir - - // Create a command for testing - cmd = &cobra.Command{Use: "test"} - - // Setup stdout capture - origStdout = os.Stdout - var err error - outReader, stdOut, err = os.Pipe() - Expect(err).NotTo(HaveOccurred()) - os.Stdout = stdOut - - DeferCleanup(func() { - os.Stdout = origStdout - }) - }) - - AfterEach(func() { - os.Stdout = origStdout - if stdOut != nil { - stdOut.Close() - } - if outReader != nil { - outReader.Close() - } - }) - - Describe("Plugin list command", func() { - It("should list installed plugins", func() { - // Create test plugins - createTestPlugin("plugin1", "Test Author", "1.0.0", []string{"MetadataAgent"}) - createTestPlugin("plugin2", "Another Author", "2.1.0", []string{"Scrobbler"}) - - // Execute command - pluginList(cmd, []string{}) - - // Verify output - output := captureOutput(outReader) - - Expect(output).To(ContainSubstring("plugin1")) - Expect(output).To(ContainSubstring("Test Author")) - Expect(output).To(ContainSubstring("1.0.0")) - Expect(output).To(ContainSubstring("MetadataAgent")) - - Expect(output).To(ContainSubstring("plugin2")) - Expect(output).To(ContainSubstring("Another Author")) - Expect(output).To(ContainSubstring("2.1.0")) - Expect(output).To(ContainSubstring("Scrobbler")) - }) - }) - - Describe("Plugin info command", func() { - It("should display information about an installed plugin", func() { - // Create test plugin with multiple capabilities - createTestPlugin("test-plugin", "Test Author", "1.0.0", - []string{"MetadataAgent", "Scrobbler"}) - - // Execute command - pluginInfo(cmd, []string{"test-plugin"}) - - // Verify output - output := captureOutput(outReader) - - Expect(output).To(ContainSubstring("Name: test-plugin")) - Expect(output).To(ContainSubstring("Author: Test Author")) - Expect(output).To(ContainSubstring("Version: 1.0.0")) - Expect(output).To(ContainSubstring("Description: Plugin for testing")) - Expect(output).To(ContainSubstring("Capabilities: MetadataAgent, Scrobbler")) - }) - }) - - Describe("Plugin remove command", func() { - It("should remove a regular plugin directory", func() { - // Create test plugin - pluginDir := createTestPlugin("regular-plugin", "Test Author", "1.0.0", - []string{"MetadataAgent"}) - - // Execute command - pluginRemove(cmd, []string{"regular-plugin"}) - - // Verify output - output := captureOutput(outReader) - Expect(output).To(ContainSubstring("Plugin 'regular-plugin' removed successfully")) - - // Verify directory is actually removed - _, err := os.Stat(pluginDir) - Expect(os.IsNotExist(err)).To(BeTrue()) - }) - - It("should remove only the symlink for a development plugin", func() { - // Create a real source directory - sourceDir := filepath.Join(GinkgoT().TempDir(), "dev-plugin-source") - Expect(os.MkdirAll(sourceDir, 0755)).To(Succeed()) - - manifest := `{ - "name": "dev-plugin", - "author": "Dev Author", - "version": "0.1.0", - "description": "Development plugin for testing", - "website": "https://test.navidrome.org/dev-plugin", - "capabilities": ["Scrobbler"], - "permissions": {} - }` - Expect(os.WriteFile(filepath.Join(sourceDir, "manifest.json"), []byte(manifest), 0600)).To(Succeed()) - - // Create a dummy WASM file - wasmContent := []byte("dummy wasm content for testing") - Expect(os.WriteFile(filepath.Join(sourceDir, "plugin.wasm"), wasmContent, 0600)).To(Succeed()) - - // Create a symlink in the plugins directory - symlinkPath := filepath.Join(tempDir, "dev-plugin") - Expect(os.Symlink(sourceDir, symlinkPath)).To(Succeed()) - - // Execute command - pluginRemove(cmd, []string{"dev-plugin"}) - - // Verify output - output := captureOutput(outReader) - Expect(output).To(ContainSubstring("Development plugin symlink 'dev-plugin' removed successfully")) - Expect(output).To(ContainSubstring("target directory preserved")) - - // Verify the symlink is removed but source directory exists - _, err := os.Lstat(symlinkPath) - Expect(os.IsNotExist(err)).To(BeTrue()) - - _, err = os.Stat(sourceDir) - Expect(err).NotTo(HaveOccurred()) - }) - }) -}) diff --git a/cmd/root.go b/cmd/root.go index 9618b16e6..5fdb591ff 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -9,7 +9,6 @@ import ( "time" "github.com/go-chi/chi/v5/middleware" - _ "github.com/navidrome/navidrome/adapters/taglib" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/consts" "github.com/navidrome/navidrome/db" @@ -22,6 +21,13 @@ import ( "github.com/spf13/cobra" "github.com/spf13/viper" "golang.org/x/sync/errgroup" + + // Import adapters to register them + _ "github.com/navidrome/navidrome/adapters/deezer" + _ "github.com/navidrome/navidrome/adapters/gotaglib" + _ "github.com/navidrome/navidrome/adapters/lastfm" + _ "github.com/navidrome/navidrome/adapters/listenbrainz" + _ "github.com/navidrome/navidrome/adapters/taglib" ) var ( @@ -189,7 +195,8 @@ func runInitialScan(ctx context.Context) func() error { if err != nil { return err } - scanNeeded := conf.Server.Scanner.ScanOnStartup || inProgress || fullScanRequired == "1" || pidHasChanged + scanOnStartup := conf.Server.Scanner.Enabled && conf.Server.Scanner.ScanOnStartup + scanNeeded := scanOnStartup || inProgress || fullScanRequired == "1" || pidHasChanged time.Sleep(2 * time.Second) // Wait 2 seconds before the initial scan if scanNeeded { s := CreateScanner(ctx) @@ -330,23 +337,20 @@ func startPlaybackServer(ctx context.Context) func() error { // startPluginManager starts the plugin manager, if configured. func startPluginManager(ctx context.Context) func() error { return func() error { + manager := GetPluginManager(ctx) if !conf.Server.Plugins.Enabled { - log.Debug("Plugins are DISABLED") + log.Debug("Plugin system is DISABLED") return nil } log.Info(ctx, "Starting plugin manager") - // Get the manager instance and scan for plugins - manager := GetPluginManager(ctx) - manager.ScanPlugins() - - return nil + return manager.Start(ctx) } } // TODO: Implement some struct tags to map flags to viper func init() { cobra.OnInitialize(func() { - conf.InitConfig(cfgFile) + conf.InitConfig(cfgFile, true) }) rootCmd.PersistentFlags().StringVarP(&cfgFile, "configfile", "c", "", `config file (default "./navidrome.toml")`) @@ -374,6 +378,7 @@ func init() { rootCmd.Flags().Duration("scaninterval", viper.GetDuration("scaninterval"), "how frequently to scan for changes in your music library") rootCmd.Flags().String("uiloginbackgroundurl", viper.GetString("uiloginbackgroundurl"), "URL to a backaground image used in the Login page") rootCmd.Flags().Bool("enabletranscodingconfig", viper.GetBool("enabletranscodingconfig"), "enables transcoding configuration in the UI") + rootCmd.Flags().Bool("enabletranscodingcancellation", viper.GetBool("enabletranscodingcancellation"), "enables transcoding context cancellation") rootCmd.Flags().String("transcodingcachesize", viper.GetString("transcodingcachesize"), "size of transcoding cache") rootCmd.Flags().String("imagecachesize", viper.GetString("imagecachesize"), "size of image (art work) cache. set to 0 to disable cache") rootCmd.Flags().String("albumplaycountmode", viper.GetString("albumplaycountmode"), "how to compute playcount for albums. absolute (default) or normalized") @@ -397,6 +402,7 @@ func init() { _ = viper.BindPFlag("prometheus.metricspath", rootCmd.Flags().Lookup("prometheus.metricspath")) _ = viper.BindPFlag("enabletranscodingconfig", rootCmd.Flags().Lookup("enabletranscodingconfig")) + _ = viper.BindPFlag("enabletranscodingcancellation", rootCmd.Flags().Lookup("enabletranscodingcancellation")) _ = viper.BindPFlag("transcodingcachesize", rootCmd.Flags().Lookup("transcodingcachesize")) _ = viper.BindPFlag("imagecachesize", rootCmd.Flags().Lookup("imagecachesize")) } diff --git a/cmd/scan.go b/cmd/scan.go index d37ccd69f..d8a563396 100644 --- a/cmd/scan.go +++ b/cmd/scan.go @@ -1,13 +1,18 @@ package cmd import ( + "bufio" "context" "encoding/gob" + "fmt" "os" + "strings" "github.com/navidrome/navidrome/core" + "github.com/navidrome/navidrome/core/playlists" "github.com/navidrome/navidrome/db" "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/persistence" "github.com/navidrome/navidrome/scanner" "github.com/navidrome/navidrome/utils/pl" @@ -17,11 +22,15 @@ import ( var ( fullScan bool subprocess bool + targets []string + targetFile string ) func init() { scanCmd.Flags().BoolVarP(&fullScan, "full", "f", false, "check all subfolders, ignoring timestamps") scanCmd.Flags().BoolVarP(&subprocess, "subprocess", "", false, "run as subprocess (internal use)") + scanCmd.Flags().StringArrayVarP(&targets, "target", "t", []string{}, "list of libraryID:folderPath pairs, can be repeated (e.g., \"-t 1:Music/Rock -t 1:Music/Jazz -t 2:Classical\")") + scanCmd.Flags().StringVar(&targetFile, "target-file", "", "path to file containing targets (one libraryID:folderPath per line)") rootCmd.AddCommand(scanCmd) } @@ -66,9 +75,27 @@ func runScanner(ctx context.Context) { sqlDB := db.Db() defer db.Db().Close() ds := persistence.New(sqlDB) - pls := core.NewPlaylists(ds) + pls := playlists.NewPlaylists(ds, core.NewImageUploadService()) - progress, err := scanner.CallScan(ctx, ds, pls, fullScan) + // Parse targets from command line or file + var scanTargets []model.ScanTarget + var err error + + if targetFile != "" { + scanTargets, err = readTargetsFromFile(targetFile) + if err != nil { + log.Fatal(ctx, "Failed to read targets from file", err) + } + log.Info(ctx, "Scanning specific folders from file", "numTargets", len(scanTargets)) + } else if len(targets) > 0 { + scanTargets, err = model.ParseTargets(targets) + if err != nil { + log.Fatal(ctx, "Failed to parse targets", err) + } + log.Info(ctx, "Scanning specific folders", "numTargets", len(scanTargets)) + } + + progress, err := scanner.CallScan(ctx, ds, pls, fullScan, scanTargets) if err != nil { log.Fatal(ctx, "Failed to scan", err) } @@ -80,3 +107,31 @@ func runScanner(ctx context.Context) { trackScanInteractively(ctx, progress) } } + +// readTargetsFromFile reads scan targets from a file, one per line. +// Each line should be in the format "libraryID:folderPath". +// Empty lines and lines starting with # are ignored. +func readTargetsFromFile(filePath string) ([]model.ScanTarget, error) { + file, err := os.Open(filePath) + if err != nil { + return nil, fmt.Errorf("failed to open target file: %w", err) + } + defer file.Close() + + var targetStrings []string + scanner := bufio.NewScanner(file) + for scanner.Scan() { + line := strings.TrimSpace(scanner.Text()) + // Skip empty lines and comments + if line == "" { + continue + } + targetStrings = append(targetStrings, line) + } + + if err := scanner.Err(); err != nil { + return nil, fmt.Errorf("failed to read target file: %w", err) + } + + return model.ParseTargets(targetStrings) +} diff --git a/cmd/scan_test.go b/cmd/scan_test.go new file mode 100644 index 000000000..beeecca19 --- /dev/null +++ b/cmd/scan_test.go @@ -0,0 +1,89 @@ +package cmd + +import ( + "os" + "path/filepath" + + "github.com/navidrome/navidrome/model" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("readTargetsFromFile", func() { + var tempDir string + + BeforeEach(func() { + var err error + tempDir, err = os.MkdirTemp("", "navidrome-test-") + Expect(err).ToNot(HaveOccurred()) + }) + + AfterEach(func() { + os.RemoveAll(tempDir) + }) + + It("reads valid targets from file", func() { + filePath := filepath.Join(tempDir, "targets.txt") + content := "1:Music/Rock\n2:Music/Jazz\n3:Classical\n" + err := os.WriteFile(filePath, []byte(content), 0600) + Expect(err).ToNot(HaveOccurred()) + + targets, err := readTargetsFromFile(filePath) + Expect(err).ToNot(HaveOccurred()) + Expect(targets).To(HaveLen(3)) + Expect(targets[0]).To(Equal(model.ScanTarget{LibraryID: 1, FolderPath: "Music/Rock"})) + Expect(targets[1]).To(Equal(model.ScanTarget{LibraryID: 2, FolderPath: "Music/Jazz"})) + Expect(targets[2]).To(Equal(model.ScanTarget{LibraryID: 3, FolderPath: "Classical"})) + }) + + It("skips empty lines", func() { + filePath := filepath.Join(tempDir, "targets.txt") + content := "1:Music/Rock\n\n2:Music/Jazz\n\n" + err := os.WriteFile(filePath, []byte(content), 0600) + Expect(err).ToNot(HaveOccurred()) + + targets, err := readTargetsFromFile(filePath) + Expect(err).ToNot(HaveOccurred()) + Expect(targets).To(HaveLen(2)) + }) + + It("trims whitespace", func() { + filePath := filepath.Join(tempDir, "targets.txt") + content := " 1:Music/Rock \n\t2:Music/Jazz\t\n" + err := os.WriteFile(filePath, []byte(content), 0600) + Expect(err).ToNot(HaveOccurred()) + + targets, err := readTargetsFromFile(filePath) + Expect(err).ToNot(HaveOccurred()) + Expect(targets).To(HaveLen(2)) + Expect(targets[0].FolderPath).To(Equal("Music/Rock")) + Expect(targets[1].FolderPath).To(Equal("Music/Jazz")) + }) + + It("returns error for non-existent file", func() { + _, err := readTargetsFromFile("/nonexistent/file.txt") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("failed to open target file")) + }) + + It("returns error for invalid target format", func() { + filePath := filepath.Join(tempDir, "targets.txt") + content := "invalid-format\n" + err := os.WriteFile(filePath, []byte(content), 0600) + Expect(err).ToNot(HaveOccurred()) + + _, err = readTargetsFromFile(filePath) + Expect(err).To(HaveOccurred()) + }) + + It("handles mixed valid and empty lines", func() { + filePath := filepath.Join(tempDir, "targets.txt") + content := "\n1:Music/Rock\n\n\n2:Music/Jazz\n\n" + err := os.WriteFile(filePath, []byte(content), 0600) + Expect(err).ToNot(HaveOccurred()) + + targets, err := readTargetsFromFile(filePath) + Expect(err).ToNot(HaveOccurred()) + Expect(targets).To(HaveLen(2)) + }) +}) diff --git a/cmd/svc.go b/cmd/svc.go index e277bd459..89ca08056 100644 --- a/cmd/svc.go +++ b/cmd/svc.go @@ -248,6 +248,7 @@ ExecStart={{.Path|cmdEscape}}{{range .Arguments}} {{.|cmd}}{{end}} TimeoutStopSec=20 RestartSec=120 EnvironmentFile=-/etc/sysconfig/{{.Name}} +Environment="ND_SYSTEMD_PRIORITY_LOGGING=1" DevicePolicy=closed NoNewPrivileges=yes diff --git a/cmd/user.go b/cmd/user.go new file mode 100644 index 000000000..1abf157b7 --- /dev/null +++ b/cmd/user.go @@ -0,0 +1,477 @@ +package cmd + +import ( + "context" + "encoding/csv" + "encoding/json" + "errors" + "fmt" + "os" + "strconv" + "strings" + "syscall" + "time" + + "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/spf13/cobra" + "golang.org/x/term" +) + +var ( + email string + libraryIds []int + name string + + removeEmail bool + removeName bool + setAdmin bool + setPassword bool + setRegularUser bool +) + +func init() { + rootCmd.AddCommand(userRoot) + + userCreateCommand.Flags().StringVarP(&userID, "username", "u", "", "username") + + userCreateCommand.Flags().StringVarP(&email, "email", "e", "", "New user email") + userCreateCommand.Flags().IntSliceVarP(&libraryIds, "library-ids", "i", []int{}, "Comma-separated list of library IDs. Set the user's accessible libraries. If empty, the user can access all libraries. This is incompatible with admin, as admin can always access all libraries") + + userCreateCommand.Flags().BoolVarP(&setAdmin, "admin", "a", false, "If set, make the user an admin. This user will have access to every library") + userCreateCommand.Flags().StringVar(&name, "name", "", "New user's name (this is separate from username used to log in)") + + _ = userCreateCommand.MarkFlagRequired("username") + + userRoot.AddCommand(userCreateCommand) + + userDeleteCommand.Flags().StringVarP(&userID, "user", "u", "", "username or id") + _ = userDeleteCommand.MarkFlagRequired("user") + userRoot.AddCommand(userDeleteCommand) + + userEditCommand.Flags().StringVarP(&userID, "user", "u", "", "username or id") + + userEditCommand.Flags().BoolVar(&setAdmin, "set-admin", false, "If set, make the user an admin") + userEditCommand.Flags().BoolVar(&setRegularUser, "set-regular", false, "If set, make the user a non-admin") + userEditCommand.MarkFlagsMutuallyExclusive("set-admin", "set-regular") + + userEditCommand.Flags().BoolVar(&removeEmail, "remove-email", false, "If set, clear the user's email") + userEditCommand.Flags().StringVarP(&email, "email", "e", "", "New user email") + userEditCommand.MarkFlagsMutuallyExclusive("email", "remove-email") + + userEditCommand.Flags().BoolVar(&removeName, "remove-name", false, "If set, clear the user's name") + userEditCommand.Flags().StringVar(&name, "name", "", "New user name (this is separate from username used to log in)") + userEditCommand.MarkFlagsMutuallyExclusive("name", "remove-name") + + userEditCommand.Flags().BoolVar(&setPassword, "set-password", false, "If set, the user's new password will be prompted on the CLI") + + userEditCommand.Flags().IntSliceVarP(&libraryIds, "library-ids", "i", []int{}, "Comma-separated list of library IDs. Set the user's accessible libraries by id") + + _ = userEditCommand.MarkFlagRequired("user") + userRoot.AddCommand(userEditCommand) + + userListCommand.Flags().StringVarP(&outputFormat, "format", "f", "csv", "output format [supported values: csv, json]") + userRoot.AddCommand(userListCommand) +} + +var ( + userRoot = &cobra.Command{ + Use: "user", + Short: "Administer users", + Long: "Create, delete, list, or update users", + } + + userCreateCommand = &cobra.Command{ + Use: "create", + Aliases: []string{"c"}, + Short: "Create a new user", + Run: func(cmd *cobra.Command, args []string) { + runCreateUser(cmd.Context()) + }, + } + + userDeleteCommand = &cobra.Command{ + Use: "delete", + Aliases: []string{"d"}, + Short: "Deletes an existing user", + Run: func(cmd *cobra.Command, args []string) { + runDeleteUser(cmd.Context()) + }, + } + + userEditCommand = &cobra.Command{ + Use: "edit", + Aliases: []string{"e"}, + Short: "Edit a user", + Long: "Edit the password, admin status, and/or library access", + Run: func(cmd *cobra.Command, args []string) { + runUserEdit(cmd.Context()) + }, + } + + userListCommand = &cobra.Command{ + Use: "list", + Short: "List users", + Run: func(cmd *cobra.Command, args []string) { + runUserList(cmd.Context()) + }, + } +) + +func promptPassword() string { + for { + fmt.Print("Enter new password (press enter with no password to cancel): ") + // This cast is necessary for some platforms + password, err := term.ReadPassword(int(syscall.Stdin)) //nolint:unconvert + + if err != nil { + log.Fatal("Error getting password", err) + } + + fmt.Print("\nConfirm new password (press enter with no password to cancel): ") + confirmation, err := term.ReadPassword(int(syscall.Stdin)) //nolint:unconvert + + if err != nil { + log.Fatal("Error getting password confirmation", err) + } + + // clear the line. + fmt.Println() + + pass := string(password) + confirm := string(confirmation) + + if pass == "" { + return "" + } + + if pass == confirm { + return pass + } + + fmt.Println("Password and password confirmation do not match") + } +} + +func libraryError(libraries model.Libraries) error { + ids := make([]int, len(libraries)) + for idx, library := range libraries { + ids[idx] = library.ID + } + return fmt.Errorf("not all available libraries found. Requested ids: %v, Found libraries: %v", libraryIds, ids) +} + +func runCreateUser(ctx context.Context) { + password := promptPassword() + if password == "" { + log.Fatal("Empty password provided, user creation cancelled") + } + + user := model.User{ + UserName: userID, + Email: email, + Name: name, + IsAdmin: setAdmin, + NewPassword: password, + } + + if user.Name == "" { + user.Name = userID + } + + ds, ctx := getAdminContext(ctx) + + err := ds.WithTx(func(tx model.DataStore) error { + existingUser, err := tx.User(ctx).FindByUsername(userID) + if existingUser != nil { + return fmt.Errorf("existing user '%s'", userID) + } + + if err != nil && !errors.Is(err, model.ErrNotFound) { + return fmt.Errorf("failed to check existing username: %w", err) + } + + if len(libraryIds) > 0 && !setAdmin { + user.Libraries, err = tx.Library(ctx).GetAll(model.QueryOptions{Filters: squirrel.Eq{"id": libraryIds}}) + if err != nil { + return err + } + + if len(user.Libraries) != len(libraryIds) { + return libraryError(user.Libraries) + } + } else { + user.Libraries, err = tx.Library(ctx).GetAll() + if err != nil { + return err + } + } + + err = tx.User(ctx).Put(&user) + if err != nil { + return err + } + + updatedIds := make([]int, len(user.Libraries)) + for idx, lib := range user.Libraries { + updatedIds[idx] = lib.ID + } + + err = tx.User(ctx).SetUserLibraries(user.ID, updatedIds) + return err + }) + + if err != nil { + log.Fatal(ctx, err) + } + + log.Info(ctx, "Successfully created user", "id", user.ID, "username", user.UserName) +} + +func runDeleteUser(ctx context.Context) { + ds, ctx := getAdminContext(ctx) + + var err error + var user *model.User + + err = ds.WithTx(func(tx model.DataStore) error { + count, err := tx.User(ctx).CountAll() + if err != nil { + return err + } + + if count == 1 { + return errors.New("refusing to delete the last user") + } + + user, err = getUser(ctx, userID, tx) + if err != nil { + return err + } + + return tx.User(ctx).Delete(user.ID) + }) + + if err != nil { + log.Fatal(ctx, "Failed to delete user", err) + } + + log.Info(ctx, "Deleted user", "username", user.UserName) +} + +func runUserEdit(ctx context.Context) { + ds, ctx := getAdminContext(ctx) + + var err error + var user *model.User + changes := []string{} + + err = ds.WithTx(func(tx model.DataStore) error { + var newLibraries model.Libraries + + user, err = getUser(ctx, userID, tx) + if err != nil { + return err + } + + if len(libraryIds) > 0 && !setAdmin { + libraries, err := tx.Library(ctx).GetAll(model.QueryOptions{Filters: squirrel.Eq{"id": libraryIds}}) + + if err != nil { + return err + } + + if len(libraries) != len(libraryIds) { + return libraryError(libraries) + } + + newLibraries = libraries + changes = append(changes, "updated library ids") + } + + if setAdmin && !user.IsAdmin { + libraries, err := tx.Library(ctx).GetAll() + if err != nil { + return err + } + + user.IsAdmin = true + user.Libraries = libraries + changes = append(changes, "set admin") + + newLibraries = libraries + } + + if setRegularUser && user.IsAdmin { + user.IsAdmin = false + changes = append(changes, "set regular user") + } + + if setPassword { + password := promptPassword() + + if password != "" { + user.NewPassword = password + changes = append(changes, "updated password") + } + } + + if email != "" && email != user.Email { + user.Email = email + changes = append(changes, "updated email") + } else if removeEmail && user.Email != "" { + user.Email = "" + changes = append(changes, "removed email") + } + + if name != "" && name != user.Name { + user.Name = name + changes = append(changes, "updated name") + } else if removeName && user.Name != "" { + user.Name = "" + changes = append(changes, "removed name") + } + + if len(changes) == 0 { + return nil + } + + err := tx.User(ctx).Put(user) + if err != nil { + return err + } + + if len(newLibraries) > 0 { + updatedIds := make([]int, len(newLibraries)) + for idx, lib := range newLibraries { + updatedIds[idx] = lib.ID + } + + err := tx.User(ctx).SetUserLibraries(user.ID, updatedIds) + if err != nil { + return err + } + } + + return nil + }) + + if err != nil { + log.Fatal(ctx, "Failed to update user", err) + } + + if len(changes) == 0 { + log.Info(ctx, "No changes for user", "user", user.UserName) + } else { + log.Info(ctx, "Updated user", "user", user.UserName, "changes", strings.Join(changes, ", ")) + } +} + +type displayLibrary struct { + ID int `json:"id"` + Path string `json:"path"` +} + +type displayUser struct { + Id string `json:"id"` + Username string `json:"username"` + Name string `json:"name"` + Email string `json:"email"` + Admin bool `json:"admin"` + CreatedAt time.Time `json:"createdAt"` + UpdatedAt time.Time `json:"updatedAt"` + LastAccess *time.Time `json:"lastAccess"` + LastLogin *time.Time `json:"lastLogin"` + Libraries []displayLibrary `json:"libraries"` +} + +func runUserList(ctx context.Context) { + if outputFormat != "csv" && outputFormat != "json" { + log.Fatal("Invalid output format. Must be one of csv, json", "format", outputFormat) + } + + ds, ctx := getAdminContext(ctx) + + users, err := ds.User(ctx).ReadAll() + if err != nil { + log.Fatal(ctx, "Failed to retrieve users", err) + } + + userList := users.(model.Users) + + if outputFormat == "csv" { + w := csv.NewWriter(os.Stdout) + _ = w.Write([]string{ + "user id", + "username", + "user's name", + "user email", + "admin", + "created at", + "updated at", + "last access", + "last login", + "libraries", + }) + for _, user := range userList { + paths := make([]string, len(user.Libraries)) + + for idx, library := range user.Libraries { + paths[idx] = fmt.Sprintf("%d:%s", library.ID, library.Path) + } + + var lastAccess, lastLogin string + + if user.LastAccessAt != nil { + lastAccess = user.LastAccessAt.Format(time.RFC3339Nano) + } else { + lastAccess = "never" + } + + if user.LastLoginAt != nil { + lastLogin = user.LastLoginAt.Format(time.RFC3339Nano) + } else { + lastLogin = "never" + } + + _ = w.Write([]string{ + user.ID, + user.UserName, + user.Name, + user.Email, + strconv.FormatBool(user.IsAdmin), + user.CreatedAt.Format(time.RFC3339Nano), + user.UpdatedAt.Format(time.RFC3339Nano), + lastAccess, + lastLogin, + fmt.Sprintf("'%s'", strings.Join(paths, "|")), + }) + } + w.Flush() + } else { + users := make([]displayUser, len(userList)) + for idx, user := range userList { + paths := make([]displayLibrary, len(user.Libraries)) + + for idx, library := range user.Libraries { + paths[idx].ID = library.ID + paths[idx].Path = library.Path + } + + users[idx].Id = user.ID + users[idx].Username = user.UserName + users[idx].Name = user.Name + users[idx].Email = user.Email + users[idx].Admin = user.IsAdmin + users[idx].CreatedAt = user.CreatedAt + users[idx].UpdatedAt = user.UpdatedAt + users[idx].LastAccess = user.LastAccessAt + users[idx].LastLogin = user.LastLoginAt + users[idx].Libraries = paths + } + + j, _ := json.Marshal(users) + fmt.Printf("%s\n", j) + } +} diff --git a/cmd/utils.go b/cmd/utils.go new file mode 100644 index 000000000..81d646cf1 --- /dev/null +++ b/cmd/utils.go @@ -0,0 +1,42 @@ +package cmd + +import ( + "context" + "errors" + "fmt" + + "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/db" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/persistence" +) + +func getAdminContext(ctx context.Context) (model.DataStore, context.Context) { + sqlDB := db.Db() + ds := persistence.New(sqlDB) + ctx = auth.WithAdminUser(ctx, ds) + u, _ := request.UserFrom(ctx) + if !u.IsAdmin { + log.Fatal(ctx, "There must be at least one admin user to run this command.") + } + return ds, ctx +} + +func getUser(ctx context.Context, id string, ds model.DataStore) (*model.User, error) { + user, err := ds.User(ctx).FindByUsername(id) + + if err != nil && !errors.Is(err, model.ErrNotFound) { + return nil, fmt.Errorf("finding user by name: %w", err) + } + + if errors.Is(err, model.ErrNotFound) { + user, err = ds.User(ctx).Get(id) + if err != nil { + return nil, fmt.Errorf("finding user by id: %w", err) + } + } + + return user, nil +} diff --git a/cmd/wire_gen.go b/cmd/wire_gen.go index 187ab488d..5b9fd648f 100644 --- a/cmd/wire_gen.go +++ b/cmd/wire_gen.go @@ -1,6 +1,6 @@ // Code generated by Wire. DO NOT EDIT. -//go:generate go run -mod=mod github.com/google/wire/cmd/wire gen -tags "netgo" +//go:generate go run -mod=mod github.com/google/wire/cmd/wire gen -tags "netgo sqlite_fts5" //go:build !wireinject // +build !wireinject @@ -9,16 +9,19 @@ package cmd import ( "context" "github.com/google/wire" + "github.com/navidrome/navidrome/adapters/lastfm" + "github.com/navidrome/navidrome/adapters/listenbrainz" "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/core/agents" - "github.com/navidrome/navidrome/core/agents/lastfm" - "github.com/navidrome/navidrome/core/agents/listenbrainz" "github.com/navidrome/navidrome/core/artwork" "github.com/navidrome/navidrome/core/external" "github.com/navidrome/navidrome/core/ffmpeg" + "github.com/navidrome/navidrome/core/lyrics" "github.com/navidrome/navidrome/core/metrics" "github.com/navidrome/navidrome/core/playback" + "github.com/navidrome/navidrome/core/playlists" "github.com/navidrome/navidrome/core/scrobbler" + "github.com/navidrome/navidrome/core/stream" "github.com/navidrome/navidrome/db" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/persistence" @@ -32,6 +35,10 @@ import ( ) import ( + _ "github.com/navidrome/navidrome/adapters/deezer" + _ "github.com/navidrome/navidrome/adapters/gotaglib" + _ "github.com/navidrome/navidrome/adapters/lastfm" + _ "github.com/navidrome/navidrome/adapters/listenbrainz" _ "github.com/navidrome/navidrome/adapters/taglib" ) @@ -47,9 +54,7 @@ func CreateServer() *server.Server { sqlDB := db.Db() dataStore := persistence.New(sqlDB) broker := events.GetBroker() - metricsMetrics := metrics.GetPrometheusInstance(dataStore) - manager := plugins.GetManager(dataStore, metricsMetrics) - insights := metrics.GetInstance(dataStore, manager) + insights := metrics.GetInstance(dataStore) serverServer := server.New(dataStore, broker, insights) return serverServer } @@ -58,21 +63,24 @@ func CreateNativeAPIRouter(ctx context.Context) *nativeapi.Router { sqlDB := db.Db() dataStore := persistence.New(sqlDB) share := core.NewShare(dataStore) - playlists := core.NewPlaylists(dataStore) - metricsMetrics := metrics.GetPrometheusInstance(dataStore) - manager := plugins.GetManager(dataStore, metricsMetrics) - insights := metrics.GetInstance(dataStore, manager) + imageUploadService := core.NewImageUploadService() + playlistsPlaylists := playlists.NewPlaylists(dataStore, imageUploadService) + insights := metrics.GetInstance(dataStore) fileCache := artwork.GetImageCache() fFmpeg := ffmpeg.New() + broker := events.GetBroker() + metricsMetrics := metrics.GetPrometheusInstance(dataStore) + manager := plugins.GetManager(dataStore, broker, metricsMetrics) agentsAgents := agents.GetAgents(dataStore, manager) provider := external.NewProvider(dataStore, agentsAgents) artworkArtwork := artwork.NewArtwork(dataStore, fileCache, fFmpeg, provider) cacheWarmer := artwork.NewCacheWarmer(artworkArtwork, fileCache) - broker := events.GetBroker() - scannerScanner := scanner.New(ctx, dataStore, cacheWarmer, broker, playlists, metricsMetrics) - watcher := scanner.GetWatcher(dataStore, scannerScanner) - library := core.NewLibrary(dataStore, scannerScanner, watcher, broker) - router := nativeapi.New(dataStore, share, playlists, insights, library) + modelScanner := scanner.New(ctx, dataStore, cacheWarmer, broker, playlistsPlaylists, metricsMetrics) + watcher := scanner.GetWatcher(dataStore, modelScanner) + library := core.NewLibrary(dataStore, modelScanner, watcher, broker, manager) + user := core.NewUser(dataStore, manager) + maintenance := core.NewMaintenance(dataStore) + router := nativeapi.New(dataStore, share, playlistsPlaylists, insights, library, user, maintenance, manager, imageUploadService) return router } @@ -81,23 +89,26 @@ func CreateSubsonicAPIRouter(ctx context.Context) *subsonic.Router { dataStore := persistence.New(sqlDB) fileCache := artwork.GetImageCache() fFmpeg := ffmpeg.New() + broker := events.GetBroker() metricsMetrics := metrics.GetPrometheusInstance(dataStore) - manager := plugins.GetManager(dataStore, metricsMetrics) + manager := plugins.GetManager(dataStore, broker, metricsMetrics) agentsAgents := agents.GetAgents(dataStore, manager) provider := external.NewProvider(dataStore, agentsAgents) artworkArtwork := artwork.NewArtwork(dataStore, fileCache, fFmpeg, provider) - transcodingCache := core.GetTranscodingCache() - mediaStreamer := core.NewMediaStreamer(dataStore, fFmpeg, transcodingCache) + transcodingCache := stream.GetTranscodingCache() + mediaStreamer := stream.NewMediaStreamer(dataStore, fFmpeg, transcodingCache) share := core.NewShare(dataStore) archiver := core.NewArchiver(mediaStreamer, dataStore, share) players := core.NewPlayers(dataStore) cacheWarmer := artwork.NewCacheWarmer(artworkArtwork, fileCache) - broker := events.GetBroker() - playlists := core.NewPlaylists(dataStore) - scannerScanner := scanner.New(ctx, dataStore, cacheWarmer, broker, playlists, metricsMetrics) + imageUploadService := core.NewImageUploadService() + playlistsPlaylists := playlists.NewPlaylists(dataStore, imageUploadService) + modelScanner := scanner.New(ctx, dataStore, cacheWarmer, broker, playlistsPlaylists, metricsMetrics) playTracker := scrobbler.GetPlayTracker(dataStore, broker, manager) playbackServer := playback.GetInstance(dataStore) - router := subsonic.New(dataStore, artworkArtwork, mediaStreamer, archiver, players, provider, scannerScanner, broker, playlists, playTracker, share, playbackServer, metricsMetrics) + lyricsLyrics := lyrics.NewLyrics(manager) + transcodeDecider := stream.NewTranscodeDecider(dataStore, fFmpeg) + router := subsonic.New(dataStore, artworkArtwork, mediaStreamer, archiver, players, provider, modelScanner, broker, playlistsPlaylists, playTracker, share, playbackServer, metricsMetrics, lyricsLyrics, transcodeDecider) return router } @@ -106,13 +117,14 @@ func CreatePublicRouter() *public.Router { dataStore := persistence.New(sqlDB) fileCache := artwork.GetImageCache() fFmpeg := ffmpeg.New() + broker := events.GetBroker() metricsMetrics := metrics.GetPrometheusInstance(dataStore) - manager := plugins.GetManager(dataStore, metricsMetrics) + manager := plugins.GetManager(dataStore, broker, metricsMetrics) agentsAgents := agents.GetAgents(dataStore, manager) provider := external.NewProvider(dataStore, agentsAgents) artworkArtwork := artwork.NewArtwork(dataStore, fileCache, fFmpeg, provider) - transcodingCache := core.GetTranscodingCache() - mediaStreamer := core.NewMediaStreamer(dataStore, fFmpeg, transcodingCache) + transcodingCache := stream.GetTranscodingCache() + mediaStreamer := stream.NewMediaStreamer(dataStore, fFmpeg, transcodingCache) share := core.NewShare(dataStore) archiver := core.NewArchiver(mediaStreamer, dataStore, share) router := public.New(dataStore, artworkArtwork, mediaStreamer, share, archiver) @@ -136,9 +148,7 @@ func CreateListenBrainzRouter() *listenbrainz.Router { func CreateInsights() metrics.Insights { sqlDB := db.Db() dataStore := persistence.New(sqlDB) - metricsMetrics := metrics.GetPrometheusInstance(dataStore) - manager := plugins.GetManager(dataStore, metricsMetrics) - insights := metrics.GetInstance(dataStore, manager) + insights := metrics.GetInstance(dataStore) return insights } @@ -149,21 +159,22 @@ func CreatePrometheus() metrics.Metrics { return metricsMetrics } -func CreateScanner(ctx context.Context) scanner.Scanner { +func CreateScanner(ctx context.Context) model.Scanner { sqlDB := db.Db() dataStore := persistence.New(sqlDB) fileCache := artwork.GetImageCache() fFmpeg := ffmpeg.New() + broker := events.GetBroker() metricsMetrics := metrics.GetPrometheusInstance(dataStore) - manager := plugins.GetManager(dataStore, metricsMetrics) + manager := plugins.GetManager(dataStore, broker, metricsMetrics) agentsAgents := agents.GetAgents(dataStore, manager) provider := external.NewProvider(dataStore, agentsAgents) artworkArtwork := artwork.NewArtwork(dataStore, fileCache, fFmpeg, provider) cacheWarmer := artwork.NewCacheWarmer(artworkArtwork, fileCache) - broker := events.GetBroker() - playlists := core.NewPlaylists(dataStore) - scannerScanner := scanner.New(ctx, dataStore, cacheWarmer, broker, playlists, metricsMetrics) - return scannerScanner + imageUploadService := core.NewImageUploadService() + playlistsPlaylists := playlists.NewPlaylists(dataStore, imageUploadService) + modelScanner := scanner.New(ctx, dataStore, cacheWarmer, broker, playlistsPlaylists, metricsMetrics) + return modelScanner } func CreateScanWatcher(ctx context.Context) scanner.Watcher { @@ -171,16 +182,17 @@ func CreateScanWatcher(ctx context.Context) scanner.Watcher { dataStore := persistence.New(sqlDB) fileCache := artwork.GetImageCache() fFmpeg := ffmpeg.New() + broker := events.GetBroker() metricsMetrics := metrics.GetPrometheusInstance(dataStore) - manager := plugins.GetManager(dataStore, metricsMetrics) + manager := plugins.GetManager(dataStore, broker, metricsMetrics) agentsAgents := agents.GetAgents(dataStore, manager) provider := external.NewProvider(dataStore, agentsAgents) artworkArtwork := artwork.NewArtwork(dataStore, fileCache, fFmpeg, provider) cacheWarmer := artwork.NewCacheWarmer(artworkArtwork, fileCache) - broker := events.GetBroker() - playlists := core.NewPlaylists(dataStore) - scannerScanner := scanner.New(ctx, dataStore, cacheWarmer, broker, playlists, metricsMetrics) - watcher := scanner.GetWatcher(dataStore, scannerScanner) + imageUploadService := core.NewImageUploadService() + playlistsPlaylists := playlists.NewPlaylists(dataStore, imageUploadService) + modelScanner := scanner.New(ctx, dataStore, cacheWarmer, broker, playlistsPlaylists, metricsMetrics) + watcher := scanner.GetWatcher(dataStore, modelScanner) return watcher } @@ -191,19 +203,20 @@ func GetPlaybackServer() playback.PlaybackServer { return playbackServer } -func getPluginManager() plugins.Manager { +func getPluginManager() *plugins.Manager { sqlDB := db.Db() dataStore := persistence.New(sqlDB) + broker := events.GetBroker() metricsMetrics := metrics.GetPrometheusInstance(dataStore) - manager := plugins.GetManager(dataStore, metricsMetrics) + manager := plugins.GetManager(dataStore, broker, metricsMetrics) return manager } // wire_injectors.go: -var allProviders = wire.NewSet(core.Set, artwork.Set, server.New, subsonic.New, nativeapi.New, public.New, persistence.New, lastfm.NewRouter, listenbrainz.NewRouter, events.GetBroker, scanner.New, scanner.GetWatcher, plugins.GetManager, metrics.GetPrometheusInstance, db.Db, wire.Bind(new(agents.PluginLoader), new(plugins.Manager)), wire.Bind(new(scrobbler.PluginLoader), new(plugins.Manager)), wire.Bind(new(metrics.PluginLoader), new(plugins.Manager)), wire.Bind(new(core.Scanner), new(scanner.Scanner)), wire.Bind(new(core.Watcher), new(scanner.Watcher))) +var allProviders = wire.NewSet(core.Set, artwork.Set, server.New, subsonic.New, nativeapi.New, public.New, persistence.New, lastfm.NewRouter, listenbrainz.NewRouter, events.GetBroker, scanner.New, scanner.GetWatcher, metrics.GetPrometheusInstance, db.Db, plugins.GetManager, wire.Bind(new(agents.PluginLoader), new(*plugins.Manager)), wire.Bind(new(scrobbler.PluginLoader), new(*plugins.Manager)), wire.Bind(new(lyrics.PluginLoader), new(*plugins.Manager)), wire.Bind(new(nativeapi.PluginManager), new(*plugins.Manager)), wire.Bind(new(core.PluginUnloader), new(*plugins.Manager)), wire.Bind(new(plugins.PluginMetricsRecorder), new(metrics.Metrics)), wire.Bind(new(core.Watcher), new(scanner.Watcher))) -func GetPluginManager(ctx context.Context) plugins.Manager { +func GetPluginManager(ctx context.Context) *plugins.Manager { manager := getPluginManager() manager.SetSubsonicRouter(CreateSubsonicAPIRouter(ctx)) return manager diff --git a/cmd/wire_injectors.go b/cmd/wire_injectors.go index e8759ac53..d87a8d6d3 100644 --- a/cmd/wire_injectors.go +++ b/cmd/wire_injectors.go @@ -6,11 +6,12 @@ import ( "context" "github.com/google/wire" + "github.com/navidrome/navidrome/adapters/lastfm" + "github.com/navidrome/navidrome/adapters/listenbrainz" "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/core/agents" - "github.com/navidrome/navidrome/core/agents/lastfm" - "github.com/navidrome/navidrome/core/agents/listenbrainz" "github.com/navidrome/navidrome/core/artwork" + "github.com/navidrome/navidrome/core/lyrics" "github.com/navidrome/navidrome/core/metrics" "github.com/navidrome/navidrome/core/playback" "github.com/navidrome/navidrome/core/scrobbler" @@ -39,13 +40,15 @@ var allProviders = wire.NewSet( events.GetBroker, scanner.New, scanner.GetWatcher, - plugins.GetManager, metrics.GetPrometheusInstance, db.Db, - wire.Bind(new(agents.PluginLoader), new(plugins.Manager)), - wire.Bind(new(scrobbler.PluginLoader), new(plugins.Manager)), - wire.Bind(new(metrics.PluginLoader), new(plugins.Manager)), - wire.Bind(new(core.Scanner), new(scanner.Scanner)), + plugins.GetManager, + wire.Bind(new(agents.PluginLoader), new(*plugins.Manager)), + wire.Bind(new(scrobbler.PluginLoader), new(*plugins.Manager)), + wire.Bind(new(lyrics.PluginLoader), new(*plugins.Manager)), + wire.Bind(new(nativeapi.PluginManager), new(*plugins.Manager)), + wire.Bind(new(core.PluginUnloader), new(*plugins.Manager)), + wire.Bind(new(plugins.PluginMetricsRecorder), new(metrics.Metrics)), wire.Bind(new(core.Watcher), new(scanner.Watcher)), ) @@ -103,7 +106,7 @@ func CreatePrometheus() metrics.Metrics { )) } -func CreateScanner(ctx context.Context) scanner.Scanner { +func CreateScanner(ctx context.Context) model.Scanner { panic(wire.Build( allProviders, )) @@ -121,13 +124,13 @@ func GetPlaybackServer() playback.PlaybackServer { )) } -func getPluginManager() plugins.Manager { +func getPluginManager() *plugins.Manager { panic(wire.Build( allProviders, )) } -func GetPluginManager(ctx context.Context) plugins.Manager { +func GetPluginManager(ctx context.Context) *plugins.Manager { manager := getPluginManager() manager.SetSubsonicRouter(CreateSubsonicAPIRouter(ctx)) return manager diff --git a/conf/buildtags/buildtags.go b/conf/buildtags/buildtags.go deleted file mode 100644 index 5fc125087..000000000 --- a/conf/buildtags/buildtags.go +++ /dev/null @@ -1,4 +0,0 @@ -package buildtags - -// This file is left intentionally empty. It is used to make sure the package is not empty, in the case all -// required build tags are disabled. diff --git a/conf/buildtags/doc.go b/conf/buildtags/doc.go new file mode 100644 index 000000000..f637b6355 --- /dev/null +++ b/conf/buildtags/doc.go @@ -0,0 +1,6 @@ +// Package buildtags provides compile-time enforcement of required build tags. +// +// Each file in this package is guarded by a build constraint and exports a variable +// that main.go references. If a required tag is missing during compilation, the build +// fails with an "undefined" error, directing the developer to use `make build`. +package buildtags diff --git a/conf/buildtags/netgo.go b/conf/buildtags/netgo.go index 0062ad2bc..407004703 100644 --- a/conf/buildtags/netgo.go +++ b/conf/buildtags/netgo.go @@ -2,10 +2,6 @@ package buildtags -// NOTICE: This file was created to force the inclusion of the `netgo` tag when compiling the project. -// If the tag is not included, the compilation will fail because this variable won't be defined, and the `main.go` -// file requires it. - -// Why this tag is required? See https://github.com/navidrome/navidrome/issues/700 +// The `netgo` tag is required when compiling the project. See https://github.com/navidrome/navidrome/issues/700 var NETGO = true diff --git a/conf/buildtags/sqlite_fts5.go b/conf/buildtags/sqlite_fts5.go new file mode 100644 index 000000000..1476e04cd --- /dev/null +++ b/conf/buildtags/sqlite_fts5.go @@ -0,0 +1,8 @@ +//go:build sqlite_fts5 + +package buildtags + +// FTS5 is required for full-text search. Without this tag, the SQLite driver +// won't include FTS5 support, causing runtime failures on migrations and search queries. + +var SQLITE_FTS5 = true diff --git a/conf/configuration.go b/conf/configuration.go index 7292c7dfe..5f74d6db0 100644 --- a/conf/configuration.go +++ b/conf/configuration.go @@ -1,11 +1,13 @@ package conf import ( + "cmp" "fmt" "net/url" "os" "path/filepath" "runtime" + "slices" "strings" "time" @@ -14,8 +16,8 @@ import ( "github.com/kr/pretty" "github.com/navidrome/navidrome/consts" "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/scheduler" "github.com/navidrome/navidrome/utils/run" - "github.com/robfig/cron/v3" "github.com/spf13/viper" ) @@ -41,8 +43,10 @@ type configOptions struct { UIWelcomeMessage string MaxSidebarPlaylists int EnableTranscodingConfig bool + EnableTranscodingCancellation bool EnableDownloads bool EnableExternalServices bool + EnableM3UExternalAlbumArt bool EnableInsightsCollector bool EnableMediaFileCoverArt bool TranscodingCacheSize string @@ -55,7 +59,8 @@ type configOptions struct { SmartPlaylistRefreshDelay time.Duration AutoTranscodeDownload bool DefaultDownsamplingFormat string - SearchFullString bool + Search searchOptions `json:",omitzero"` + SimilarSongsMatchThreshold int RecentlyAddedByModTime bool PreferSortTags bool IgnoredArticles string @@ -64,13 +69,16 @@ type configOptions struct { MPVPath string MPVCmdTemplate string CoverArtPriority string - CoverJpegQuality int + CoverArtQuality int ArtistArtPriority string + ArtistImageFolder string + DiscArtPriority string LyricsPriority string EnableGravatar bool EnableFavourites bool EnableStarRating bool EnableUserEditing bool + EnableCoverArtUpload bool EnableSharing bool ShareURL string DefaultShareExpiration time.Duration @@ -78,6 +86,7 @@ type configOptions struct { DefaultTheme string DefaultLanguage string DefaultUIVolume int + UISearchDebounceMs int EnableReplayGain bool EnableCoverAnimation bool EnableNowPlaying bool @@ -86,11 +95,9 @@ type configOptions struct { AuthRequestLimit int AuthWindowLength time.Duration PasswordEncryptionKey string - ReverseProxyUserHeader string - ReverseProxyWhitelist string + ExtAuth extAuthOptions Plugins pluginsOptions - PluginConfig map[string]map[string]string - HTTPSecurityHeaders secureOptions `json:",omitzero"` + HTTPHeaders httpHeaderOptions `json:",omitzero"` Prometheus prometheusOptions `json:",omitzero"` Scanner scannerOptions `json:",omitzero"` Jukebox jukeboxOptions `json:",omitzero"` @@ -99,37 +106,42 @@ type configOptions struct { Inspect inspectOptions `json:",omitzero"` Subsonic subsonicOptions `json:",omitzero"` LastFM lastfmOptions `json:",omitzero"` - Spotify spotifyOptions `json:",omitzero"` Deezer deezerOptions `json:",omitzero"` ListenBrainz listenBrainzOptions `json:",omitzero"` - Tags map[string]TagConf `json:",omitempty"` + EnableScrobbleHistory bool + Tags map[string]TagConf `json:",omitempty"` Agents string // DevFlags. These are used to enable/disable debugging and incomplete features - DevLogLevels map[string]string `json:",omitempty"` - DevLogSourceLine bool - DevEnableProfiler bool - DevAutoCreateAdminPassword string - DevAutoLoginUsername string - DevActivityPanel bool - DevActivityPanelUpdateRate time.Duration - DevSidebarPlaylists bool - DevShowArtistPage bool - DevUIShowConfig bool - DevNewEventStream bool - DevOffsetOptimize int - DevArtworkMaxRequests int - DevArtworkThrottleBacklogLimit int - DevArtworkThrottleBacklogTimeout time.Duration - DevArtistInfoTimeToLive time.Duration - DevAlbumInfoTimeToLive time.Duration - DevExternalScanner bool - DevScannerThreads uint - DevInsightsInitialDelay time.Duration - DevEnablePlayerInsights bool - DevEnablePluginsInsights bool - DevPluginCompilationTimeout time.Duration - DevExternalArtistFetchMultiplier float64 + DevLogLevels map[string]string `json:",omitempty"` + DevLogSourceLine bool + DevEnableProfiler bool + DevAutoCreateAdminPassword string + DevAutoLoginUsername string + DevActivityPanel bool + DevActivityPanelUpdateRate time.Duration + DevSidebarPlaylists bool + DevShowArtistPage bool + DevUIShowConfig bool + DevNewEventStream bool + DevOffsetOptimize int + DevArtworkMaxRequests int + DevArtworkThrottleBacklogLimit int + DevArtworkThrottleBacklogTimeout time.Duration + DevArtistInfoTimeToLive time.Duration + DevAlbumInfoTimeToLive time.Duration + DevExternalScanner bool + DevScannerThreads uint + DevSelectiveWatcher bool + DevInsightsInitialDelay time.Duration + DevEnablePlayerInsights bool + DevEnablePluginsInsights bool + DevPluginCompilationTimeout time.Duration + DevExternalArtistFetchMultiplier float64 + DevOptimizeDB bool + DevPreserveUnicodeInExternalCalls bool + DevEnableMediaFileProbe bool + DevJpegCoverArt bool } type scannerOptions struct { @@ -147,9 +159,12 @@ type scannerOptions struct { type subsonicOptions struct { AppendSubtitle bool + AppendAlbumVersion bool ArtistParticipations bool DefaultReportRealPath bool + EnableAverageRating bool LegacyClients string + MinimalClients string } type TagConf struct { @@ -163,34 +178,38 @@ type TagConf struct { type lastfmOptions struct { Enabled bool - ApiKey string - Secret string + ApiKey string //nolint:gosec + Secret string //nolint:gosec Language string ScrobbleFirstArtistOnly bool -} -type spotifyOptions struct { - ID string - Secret string + // Computed values + Languages []string // Computed from Language, split by comma } type deezerOptions struct { - Enabled bool + Enabled bool + Language string + + // Computed values + Languages []string // Computed from Language, split by comma } type listenBrainzOptions struct { - Enabled bool - BaseURL string + Enabled bool + BaseURL string + ArtistAlgorithm string + TrackAlgorithm string } -type secureOptions struct { - CustomFrameOptionsValue string +type httpHeaderOptions struct { + FrameOptions string } type prometheusOptions struct { Enabled bool MetricsPath string - Password string + Password string //nolint:gosec } type AudioDeviceDefinition []string @@ -221,9 +240,22 @@ type inspectOptions struct { } type pluginsOptions struct { - Enabled bool - Folder string - CacheSize string + Enabled bool + Folder string + CacheSize string + AutoReload bool + LogLevel string +} + +type extAuthOptions struct { + TrustedSources string + UserHeader string + LogoutURL string +} + +type searchOptions struct { + Backend string + FullString bool } var ( @@ -244,6 +276,12 @@ func LoadFromFile(confFile string) { func Load(noConfigDump bool) { parseIniFileConfiguration() + // Map deprecated options to their new names for backwards compatibility + mapDeprecatedOption("ReverseProxyWhitelist", "ExtAuth.TrustedSources") + mapDeprecatedOption("ReverseProxyUserHeader", "ExtAuth.UserHeader") + mapDeprecatedOption("HTTPSecurityHeaders.CustomFrameOptionsValue", "HTTPHeaders.FrameOptions") + mapDeprecatedOption("CoverJpegQuality", "CoverArtQuality") + err := viper.Unmarshal(&Server) if err != nil { _, _ = fmt.Fprintln(os.Stderr, "FATAL: Error parsing config:", err) @@ -265,6 +303,12 @@ func Load(noConfigDump bool) { os.Exit(1) } + err = os.MkdirAll(filepath.Join(Server.DataFolder, consts.ArtworkFolder), os.ModePerm) + if err != nil { + _, _ = fmt.Fprintln(os.Stderr, "FATAL: Error creating artwork path:", err) + os.Exit(1) + } + if Server.Plugins.Enabled { if Server.Plugins.Folder == "" { Server.Plugins.Folder = filepath.Join(Server.DataFolder, "plugins") @@ -297,6 +341,12 @@ func Load(noConfigDump bool) { os.Exit(1) } log.SetOutput(out) + } else if os.Getenv("ND_SYSTEMD_PRIORITY_LOGGING") != "" && os.Getenv("JOURNAL_STREAM") != "" { + // When running under systemd, prepend syslog priority prefixes so + // journald assigns the correct severity to each log line. + // Note that we have an additional environment variable, as JOURNAL_STREAM + // can be present in a systemd environment even if not running as a systemd service + log.EnableJournalFormat() } log.SetLevelString(Server.LogLevel) @@ -309,11 +359,14 @@ func Load(noConfigDump bool) { validateBackupSchedule, validatePlaylistsPath, validatePurgeMissingOption, + validateURL("ExtAuth.LogoutURL", Server.ExtAuth.LogoutURL), ) if err != nil { os.Exit(1) } + Server.Search.Backend = normalizeSearchBackend(Server.Search.Backend) + if Server.BaseURL != "" { u, err := url.Parse(Server.BaseURL) if err != nil { @@ -327,9 +380,18 @@ func Load(noConfigDump bool) { Server.BaseScheme = u.Scheme } + // Log configuration source + if Server.ConfigFile != "" { + log.Info("Loaded configuration", "file", Server.ConfigFile) + } else if hasNDEnvVars() { + log.Info("No configuration file found. Loaded configuration only from environment variables") + } else { + log.Warn("No configuration file found. Using default values. To specify a config file, use the --configfile flag or set the ND_CONFIGFILE environment variable.") + } + // Print current configuration if log level is Debug if log.IsGreaterOrEqualTo(log.LevelDebug) && !noConfigDump { - prettyConf := pretty.Sprintf("Loaded configuration from '%s': %# v", Server.ConfigFile, Server) + prettyConf := pretty.Sprintf("Configuration: %# v", Server) if Server.EnableLogRedacting { prettyConf = log.Redact(prettyConf) } @@ -340,13 +402,28 @@ func Load(noConfigDump bool) { disableExternalServices() } - if Server.Scanner.Extractor != consts.DefaultScannerExtractor { - log.Warn(fmt.Sprintf("Extractor '%s' is not implemented, using 'taglib'", Server.Scanner.Extractor)) - Server.Scanner.Extractor = consts.DefaultScannerExtractor - } - logDeprecatedOptions("Scanner.GenreSeparators") - logDeprecatedOptions("Scanner.GroupAlbumReleases") - logDeprecatedOptions("DevEnableBufferedScrobble") // Deprecated: Buffered scrobbling is now always enabled and this option is ignored + // Make sure we don't have empty PIDs + Server.PID.Album = cmp.Or(Server.PID.Album, consts.DefaultAlbumPID) + Server.PID.Track = cmp.Or(Server.PID.Track, consts.DefaultTrackPID) + + // Parse LastFM.Language into Languages slice (comma-separated, with fallback to DefaultInfoLanguage) + Server.LastFM.Languages = parseLanguages(Server.LastFM.Language) + + // Parse Deezer.Language into Languages slice (comma-separated, with fallback to DefaultInfoLanguage) + Server.Deezer.Languages = parseLanguages(Server.Deezer.Language) + + // Deprecated options + logDeprecatedOptions("Scanner.GenreSeparators", "") + logDeprecatedOptions("Scanner.GroupAlbumReleases", "") + logDeprecatedOptions("DevEnableBufferedScrobble", "") // Deprecated: Buffered scrobbling is now always enabled and this option is ignored + logDeprecatedOptions("SearchFullString", "Search.FullString") + logDeprecatedOptions("ReverseProxyWhitelist", "ExtAuth.TrustedSources") + logDeprecatedOptions("ReverseProxyUserHeader", "ExtAuth.UserHeader") + logDeprecatedOptions("HTTPSecurityHeaders.CustomFrameOptionsValue", "HTTPHeaders.FrameOptions") + logDeprecatedOptions("CoverJpegQuality", "CoverArtQuality") + + // Removed options + logRemovedOptions("Spotify.ID", "Spotify.Secret") // Call init hooks for _, hook := range hooks { @@ -354,15 +431,46 @@ func Load(noConfigDump bool) { } } -func logDeprecatedOptions(options ...string) { +func logDeprecatedOptions(oldName, newName string) { + envVar := "ND_" + strings.ToUpper(strings.ReplaceAll(oldName, ".", "_")) + newEnvVar := "ND_" + strings.ToUpper(strings.ReplaceAll(newName, ".", "_")) + logWarning := func(oldName, newName string) { + if newName != "" { + log.Warn(fmt.Sprintf("Option '%s' is deprecated and will be ignored in a future release. Please use the new '%s'", oldName, newName)) + } else { + log.Warn(fmt.Sprintf("Option '%s' is deprecated and will be ignored in a future release", oldName)) + } + } + if os.Getenv(envVar) != "" { + logWarning(envVar, newEnvVar) + } + if viper.InConfig(oldName) { + logWarning(oldName, newName) + } +} + +// logRemovedOptions checks if the option is set, and if yes, outputs a warning message saying the option is +// not available anymore +func logRemovedOptions(options ...string) { for _, option := range options { envVar := "ND_" + strings.ToUpper(strings.ReplaceAll(option, ".", "_")) - if os.Getenv(envVar) != "" { - log.Warn(fmt.Sprintf("Option '%s' is deprecated and will be ignored in a future release", envVar)) + logWarning := func(option string) { + log.Warn(fmt.Sprintf("Option '%s' is not available anymore and will be ignored. Please remove it from your config", option)) } if viper.InConfig(option) { - log.Warn(fmt.Sprintf("Option '%s' is deprecated and will be ignored in a future release", option)) + logWarning(option) } + if os.Getenv(envVar) != "" { + logWarning(envVar) + } + } +} + +// mapDeprecatedOption is used to provide backwards compatibility for deprecated options. It should be called after +// the config has been read by viper, but before unmarshalling it into the Config struct. +func mapDeprecatedOption(legacyName, newName string) { + if viper.IsSet(legacyName) { + viper.Set(newName, viper.Get(legacyName)) } } @@ -372,7 +480,7 @@ func logDeprecatedOptions(options ...string) { func parseIniFileConfiguration() { cfgFile := viper.ConfigFileUsed() if strings.ToLower(filepath.Ext(cfgFile)) == ".ini" { - var iniConfig map[string]interface{} + var iniConfig map[string]any err := viper.Unmarshal(&iniConfig) if err != nil { _, _ = fmt.Fprintln(os.Stderr, "FATAL: Error parsing config:", err) @@ -394,8 +502,8 @@ func parseIniFileConfiguration() { func disableExternalServices() { log.Info("All external integrations are DISABLED!") Server.EnableInsightsCollector = false + Server.EnableM3UExternalAlbumArt = false Server.LastFM.Enabled = false - Server.Spotify.ID = "" Server.Deezer.Enabled = false Server.ListenBrainz.Enabled = false Server.Agents = "" @@ -405,7 +513,7 @@ func disableExternalServices() { } func validatePlaylistsPath() error { - for _, path := range strings.Split(Server.PlaylistsPath, string(filepath.ListSeparator)) { + for path := range strings.SplitSeq(Server.PlaylistsPath, string(filepath.ListSeparator)) { _, err := doublestar.Match(path, "") if err != nil { log.Error("Invalid PlaylistsPath", "path", path, err) @@ -415,17 +523,27 @@ func validatePlaylistsPath() error { return nil } -func validatePurgeMissingOption() error { - allowedValues := []string{consts.PurgeMissingNever, consts.PurgeMissingAlways, consts.PurgeMissingFull} - valid := false - for _, v := range allowedValues { - if v == Server.Scanner.PurgeMissing { - valid = true - break +// parseLanguages parses a comma-separated language string into a slice. +// It trims whitespace from each entry and ensures at least [DefaultInfoLanguage] is returned. +func parseLanguages(lang string) []string { + var languages []string + for l := range strings.SplitSeq(lang, ",") { + l = strings.TrimSpace(l) + if l != "" { + languages = append(languages, l) } } + if len(languages) == 0 { + return []string{consts.DefaultInfoLanguage} + } + return languages +} + +func validatePurgeMissingOption() error { + allowedValues := []string{consts.PurgeMissingNever, consts.PurgeMissingAlways, consts.PurgeMissingFull} + valid := slices.Contains(allowedValues, Server.Scanner.PurgeMissing) if !valid { - err := fmt.Errorf("Invalid Scanner.PurgeMissing value: '%s'. Must be one of: %v", Server.Scanner.PurgeMissing, allowedValues) + err := fmt.Errorf("invalid Scanner.PurgeMissing value: '%s'. Must be one of: %v", Server.Scanner.PurgeMissing, allowedValues) log.Error(err.Error()) Server.Scanner.PurgeMissing = consts.PurgeMissingNever return err @@ -454,24 +572,66 @@ func validateBackupSchedule() error { } func validateSchedule(schedule, field string) (string, error) { - if _, err := time.ParseDuration(schedule); err == nil { - schedule = "@every " + schedule - } - c := cron.New() - id, err := c.AddFunc(schedule, func() {}) + _, err := scheduler.ParseCrontab(schedule) if err != nil { log.Error(fmt.Sprintf("Invalid %s. Please read format spec at https://pkg.go.dev/github.com/robfig/cron#hdr-CRON_Expression_Format", field), "schedule", schedule, err) - } else { - c.Remove(id) } return schedule, err } +// validateURL checks if the provided URL is valid and has either http or https scheme. +// It returns a function that can be used as a hook to validate URLs in the config. +func validateURL(optionName, optionURL string) func() error { + return func() error { + if optionURL == "" { + return nil + } + u, err := url.Parse(optionURL) + if err != nil { + log.Error(fmt.Sprintf("Invalid %s: it could not be parsed", optionName), "url", optionURL, "err", err) + return err + } + if u.Scheme != "http" && u.Scheme != "https" { + err := fmt.Errorf("invalid scheme for %s: '%s'. Only 'http' and 'https' are allowed", optionName, u.Scheme) + log.Error(err.Error()) + return err + } + // Require an absolute URL with a non-empty host and no opaque component. + if u.Host == "" || u.Opaque != "" { + err := fmt.Errorf("invalid %s: '%s'. A full http(s) URL with a non-empty host is required", optionName, optionURL) + log.Error(err.Error()) + return err + } + return nil + } +} + +func normalizeSearchBackend(value string) string { + v := strings.ToLower(strings.TrimSpace(value)) + switch v { + case "fts", "legacy": + return v + default: + log.Error("Invalid Search.Backend value, falling back to 'fts'", "value", value) + return "fts" + } +} + // AddHook is used to register initialization code that should run as soon as the config is loaded func AddHook(hook func()) { hooks = append(hooks, hook) } +// hasNDEnvVars checks if any ND_ prefixed environment variables are set (excluding ND_CONFIGFILE) +func hasNDEnvVars() bool { + for _, env := range os.Environ() { + if strings.HasPrefix(env, "ND_") && !strings.HasPrefix(env, "ND_CONFIGFILE=") { + return true + } + } + return false +} + func setViperDefaults() { viper.SetDefault("musicfolder", filepath.Join(".", "music")) viper.SetDefault("cachefolder", "") @@ -489,6 +649,7 @@ func setViperDefaults() { viper.SetDefault("uiwelcomemessage", "") viper.SetDefault("maxsidebarplaylists", consts.DefaultMaxSidebarPlaylists) viper.SetDefault("enabletranscodingconfig", false) + viper.SetDefault("enabletranscodingcancellation", false) viper.SetDefault("transcodingcachesize", "100MB") viper.SetDefault("imagecachesize", "100MB") viper.SetDefault("albumplaycountmode", consts.AlbumPlayCountModeAbsolute) @@ -499,10 +660,13 @@ func setViperDefaults() { viper.SetDefault("smartPlaylistRefreshDelay", 5*time.Second) viper.SetDefault("enabledownloads", true) viper.SetDefault("enableexternalservices", true) + viper.SetDefault("enablem3uexternalalbumart", false) viper.SetDefault("enablemediafilecoverart", true) viper.SetDefault("autotranscodedownload", false) viper.SetDefault("defaultdownsamplingformat", consts.DefaultDownsamplingFormat) - viper.SetDefault("searchfullstring", false) + viper.SetDefault("search.fullstring", false) + viper.SetDefault("search.backend", "fts") + viper.SetDefault("similarsongsmatchthreshold", 85) viper.SetDefault("recentlyaddedbymodtime", false) viper.SetDefault("prefersorttags", false) viper.SetDefault("ignoredarticles", "The El La Los Las Le Les Os As O A") @@ -510,8 +674,9 @@ func setViperDefaults() { viper.SetDefault("ffmpegpath", "") viper.SetDefault("mpvcmdtemplate", "mpv --audio-device=%d --no-audio-display %f --input-ipc-server=%s") viper.SetDefault("coverartpriority", "cover.*, folder.*, front.*, embedded, external") - viper.SetDefault("coverjpegquality", 75) + viper.SetDefault("coverartquality", 75) viper.SetDefault("artistartpriority", "artist.*, album/artist.*, external") + viper.SetDefault("discartpriority", "disc*.*, cd*.*, cover.*, folder.*, front.*, discsubtitle, embedded") viper.SetDefault("lyricspriority", ".lrc,.txt,embedded") viper.SetDefault("enablegravatar", false) viper.SetDefault("enablefavourites", true) @@ -520,9 +685,11 @@ func setViperDefaults() { viper.SetDefault("defaulttheme", "Dark") viper.SetDefault("defaultlanguage", "") viper.SetDefault("defaultuivolume", consts.DefaultUIVolume) + viper.SetDefault("uisearchdebouncems", consts.DefaultUISearchDebounceMs) viper.SetDefault("enablereplaygain", true) viper.SetDefault("enablecoveranimation", true) viper.SetDefault("enablenowplaying", true) + viper.SetDefault("enablecoverartupload", true) viper.SetDefault("enablesharing", false) viper.SetDefault("shareurl", "") viper.SetDefault("defaultshareexpiration", 8760*time.Hour) @@ -533,8 +700,9 @@ func setViperDefaults() { viper.SetDefault("authrequestlimit", 5) viper.SetDefault("authwindowlength", 20*time.Second) viper.SetDefault("passwordencryptionkey", "") - viper.SetDefault("reverseproxyuserheader", "Remote-User") - viper.SetDefault("reverseproxywhitelist", "") + viper.SetDefault("extauth.userheader", "Remote-User") + viper.SetDefault("extauth.trustedsources", "") + viper.SetDefault("extauth.logouturl", "") viper.SetDefault("prometheus.enabled", false) viper.SetDefault("prometheus.metricspath", consts.PrometheusDefaultPath) viper.SetDefault("prometheus.password", "") @@ -553,21 +721,26 @@ func setViperDefaults() { viper.SetDefault("scanner.followsymlinks", true) viper.SetDefault("scanner.purgemissing", consts.PurgeMissingNever) viper.SetDefault("subsonic.appendsubtitle", true) + viper.SetDefault("subsonic.appendalbumversion", true) viper.SetDefault("subsonic.artistparticipations", false) viper.SetDefault("subsonic.defaultreportrealpath", false) + viper.SetDefault("subsonic.enableaveragerating", true) viper.SetDefault("subsonic.legacyclients", "DSub") - viper.SetDefault("agents", "lastfm,spotify,deezer") + viper.SetDefault("subsonic.minimalclients", "SubMusic") + viper.SetDefault("agents", "deezer,lastfm,listenbrainz") viper.SetDefault("lastfm.enabled", true) - viper.SetDefault("lastfm.language", "en") + viper.SetDefault("lastfm.language", consts.DefaultInfoLanguage) viper.SetDefault("lastfm.apikey", "") viper.SetDefault("lastfm.secret", "") viper.SetDefault("lastfm.scrobblefirstartistonly", false) - viper.SetDefault("spotify.id", "") - viper.SetDefault("spotify.secret", "") viper.SetDefault("deezer.enabled", true) + viper.SetDefault("deezer.language", consts.DefaultInfoLanguage) viper.SetDefault("listenbrainz.enabled", true) - viper.SetDefault("listenbrainz.baseurl", "https://api.listenbrainz.org/1/") - viper.SetDefault("httpsecurityheaders.customframeoptionsvalue", "DENY") + viper.SetDefault("listenbrainz.baseurl", consts.DefaultListenBrainzBaseURL) + viper.SetDefault("listenbrainz.artistalgorithm", consts.DefaultListenBrainzArtistAlgorithm) + viper.SetDefault("listenbrainz.trackalgorithm", consts.DefaultListenBrainzTrackAlgorithm) + viper.SetDefault("enablescrobblehistory", true) + viper.SetDefault("httpheaders.frameoptions", "DENY") viper.SetDefault("backup.path", "") viper.SetDefault("backup.schedule", "") viper.SetDefault("backup.count", 0) @@ -578,8 +751,9 @@ func setViperDefaults() { viper.SetDefault("inspect.backloglimit", consts.RequestThrottleBacklogLimit) viper.SetDefault("inspect.backlogtimeout", consts.RequestThrottleBacklogTimeout) viper.SetDefault("plugins.folder", "") - viper.SetDefault("plugins.enabled", false) - viper.SetDefault("plugins.cachesize", "100MB") + viper.SetDefault("plugins.enabled", true) + viper.SetDefault("plugins.cachesize", "200MB") + viper.SetDefault("plugins.autoreload", false) // DevFlags. These are used to enable/disable debugging and incomplete features viper.SetDefault("devlogsourceline", false) @@ -593,27 +767,37 @@ func setViperDefaults() { viper.SetDefault("devuishowconfig", true) viper.SetDefault("devneweventstream", true) viper.SetDefault("devoffsetoptimize", 50000) - viper.SetDefault("devartworkmaxrequests", max(2, runtime.NumCPU()/3)) + viper.SetDefault("devartworkmaxrequests", max(4, runtime.NumCPU())) viper.SetDefault("devartworkthrottlebackloglimit", consts.RequestThrottleBacklogLimit) viper.SetDefault("devartworkthrottlebacklogtimeout", consts.RequestThrottleBacklogTimeout) viper.SetDefault("devartistinfotimetolive", consts.ArtistInfoTimeToLive) viper.SetDefault("devalbuminfotimetolive", consts.AlbumInfoTimeToLive) viper.SetDefault("devexternalscanner", true) viper.SetDefault("devscannerthreads", 5) + viper.SetDefault("devselectivewatcher", true) viper.SetDefault("devinsightsinitialdelay", consts.InsightsInitialDelay) viper.SetDefault("devenableplayerinsights", true) viper.SetDefault("devenablepluginsinsights", true) viper.SetDefault("devplugincompilationtimeout", time.Minute) viper.SetDefault("devexternalartistfetchmultiplier", 1.5) + viper.SetDefault("devoptimizedb", true) + viper.SetDefault("devpreserveunicodeinexternalcalls", false) + viper.SetDefault("devenablemediafileprobe", true) + viper.SetDefault("devjpegcoverart", false) } func init() { setViperDefaults() } -func InitConfig(cfgFile string) { +func InitConfig(cfgFile string, loadEnvVars bool) { codecRegistry := viper.NewCodecRegistry() - _ = codecRegistry.RegisterCodec("ini", ini.Codec{}) + _ = codecRegistry.RegisterCodec("ini", ini.Codec{ + LoadOptions: ini.LoadOptions{ + UnescapeValueDoubleQuotes: true, + UnescapeValueCommentSymbols: true, + }, + }) viper.SetOptions(viper.WithCodecRegistry(codecRegistry)) cfgFile = getConfigFile(cfgFile) @@ -627,10 +811,12 @@ func InitConfig(cfgFile string) { } _ = viper.BindEnv("port") - viper.SetEnvPrefix("ND") - replacer := strings.NewReplacer(".", "_") - viper.SetEnvKeyReplacer(replacer) - viper.AutomaticEnv() + if loadEnvVars { + viper.SetEnvPrefix("ND") + replacer := strings.NewReplacer(".", "_") + viper.SetEnvKeyReplacer(replacer) + viper.AutomaticEnv() + } err := viper.ReadInConfig() if viper.ConfigFileUsed() != "" && err != nil { @@ -647,7 +833,7 @@ func getConfigFile(cfgFile string) string { } cfgFile = os.Getenv("ND_CONFIGFILE") if cfgFile != "" { - if _, err := os.Stat(cfgFile); err == nil { + if _, err := os.Stat(cfgFile); err == nil { //nolint:gosec return cfgFile } } diff --git a/conf/configuration_test.go b/conf/configuration_test.go index 5b54e4975..73fec4196 100644 --- a/conf/configuration_test.go +++ b/conf/configuration_test.go @@ -26,12 +26,94 @@ var _ = Describe("Configuration", func() { conf.ResetConf() }) + Describe("ParseLanguages", func() { + It("parses single language", func() { + Expect(conf.ParseLanguages("en")).To(Equal([]string{"en"})) + }) + + It("parses multiple comma-separated languages", func() { + Expect(conf.ParseLanguages("pt,en")).To(Equal([]string{"pt", "en"})) + }) + + It("trims whitespace from languages", func() { + Expect(conf.ParseLanguages(" pt , en ")).To(Equal([]string{"pt", "en"})) + }) + + It("returns default 'en' when empty", func() { + Expect(conf.ParseLanguages("")).To(Equal([]string{"en"})) + }) + + It("returns default 'en' when only whitespace", func() { + Expect(conf.ParseLanguages(" ")).To(Equal([]string{"en"})) + }) + + It("handles multiple languages with various spacing", func() { + Expect(conf.ParseLanguages("ja, pt, en")).To(Equal([]string{"ja", "pt", "en"})) + }) + }) + + Describe("ValidateURL", func() { + It("accepts a valid http URL", func() { + fn := conf.ValidateURL("TestOption", "http://example.com/path") + Expect(fn()).To(Succeed()) + }) + + It("accepts a valid https URL", func() { + fn := conf.ValidateURL("TestOption", "https://example.com/path") + Expect(fn()).To(Succeed()) + }) + + It("rejects a URL with no scheme", func() { + fn := conf.ValidateURL("TestOption", "example.com/path") + Expect(fn()).To(MatchError(ContainSubstring("invalid scheme"))) + }) + + It("rejects a URL with an unsupported scheme", func() { + fn := conf.ValidateURL("TestOption", "javascript://example.com/path") + Expect(fn()).To(MatchError(ContainSubstring("invalid scheme"))) + }) + + It("accepts an empty URL (optional config)", func() { + fn := conf.ValidateURL("TestOption", "") + Expect(fn()).To(Succeed()) + }) + + It("includes the option name in the error message", func() { + fn := conf.ValidateURL("MyOption", "ftp://example.com") + Expect(fn()).To(MatchError(ContainSubstring("MyOption"))) + }) + + It("rejects a URL that cannot be parsed", func() { + fn := conf.ValidateURL("TestOption", "://invalid") + Expect(fn()).To(HaveOccurred()) + }) + + It("rejects a URL without a host", func() { + fn := conf.ValidateURL("TestOption", "http:///path") + Expect(fn()).To(MatchError(ContainSubstring("non-empty host is required"))) + }) + }) + + DescribeTable("NormalizeSearchBackend", + func(input, expected string) { + Expect(conf.NormalizeSearchBackend(input)).To(Equal(expected)) + }, + Entry("accepts 'fts'", "fts", "fts"), + Entry("accepts 'legacy'", "legacy", "legacy"), + Entry("normalizes 'FTS' to lowercase", "FTS", "fts"), + Entry("normalizes 'Legacy' to lowercase", "Legacy", "legacy"), + Entry("trims whitespace", " fts ", "fts"), + Entry("falls back to 'fts' for 'fts5'", "fts5", "fts"), + Entry("falls back to 'fts' for unrecognized values", "invalid", "fts"), + Entry("falls back to 'fts' for empty string", "", "fts"), + ) + DescribeTable("should load configuration from", func(format string) { filename := filepath.Join("testdata", "cfg."+format) // Initialize config with the test file - conf.InitConfig(filename) + conf.InitConfig(filename, false) // Load the configuration (with noConfigDump=true) conf.Load(true) @@ -39,6 +121,10 @@ var _ = Describe("Configuration", func() { Expect(conf.Server.MusicFolder).To(Equal(fmt.Sprintf("/%s/music", format))) Expect(conf.Server.UIWelcomeMessage).To(Equal("Welcome " + format)) Expect(conf.Server.Tags["custom"].Aliases).To(Equal([]string{format, "test"})) + Expect(conf.Server.Tags["artist"].Split).To(Equal([]string{";"})) + + // Check deprecated option mapping + Expect(conf.Server.ExtAuth.UserHeader).To(Equal("X-Auth-User")) // The config file used should be the one we created Expect(conf.Server.ConfigFile).To(Equal(filename)) diff --git a/conf/export_test.go b/conf/export_test.go index 1b6daf036..d1d1bb3a9 100644 --- a/conf/export_test.go +++ b/conf/export_test.go @@ -5,3 +5,9 @@ func ResetConf() { } var SetViperDefaults = setViperDefaults + +var ParseLanguages = parseLanguages + +var ValidateURL = validateURL + +var NormalizeSearchBackend = normalizeSearchBackend diff --git a/conf/testdata/cfg.ini b/conf/testdata/cfg.ini index cec7d3c70..cc8b2a4a5 100644 --- a/conf/testdata/cfg.ini +++ b/conf/testdata/cfg.ini @@ -1,6 +1,8 @@ [default] MusicFolder = /ini/music -UIWelcomeMessage = Welcome ini +UIWelcomeMessage = 'Welcome ini' ; Just a comment to test the LoadOptions +ReverseProxyUserHeader = 'X-Auth-User' [Tags] -Custom.Aliases = ini,test \ No newline at end of file +Custom.Aliases = ini,test +artist.Split = ";" # Should be able to read ; as a separator \ No newline at end of file diff --git a/conf/testdata/cfg.json b/conf/testdata/cfg.json index 37cf74f08..28fb039d2 100644 --- a/conf/testdata/cfg.json +++ b/conf/testdata/cfg.json @@ -1,7 +1,11 @@ { "musicFolder": "/json/music", "uiWelcomeMessage": "Welcome json", + "reverseProxyUserHeader": "X-Auth-User", "Tags": { + "artist": { + "split": ";" + }, "custom": { "aliases": [ "json", diff --git a/conf/testdata/cfg.toml b/conf/testdata/cfg.toml index 1dc852b18..589e2a100 100644 --- a/conf/testdata/cfg.toml +++ b/conf/testdata/cfg.toml @@ -1,5 +1,8 @@ musicFolder = "/toml/music" uiWelcomeMessage = "Welcome toml" +ReverseProxyUserHeader = "X-Auth-User" + +Tags.artist.Split = ';' [Tags.custom] aliases = ["toml", "test"] diff --git a/conf/testdata/cfg.yaml b/conf/testdata/cfg.yaml index 38b98d4aa..e44d2ebbb 100644 --- a/conf/testdata/cfg.yaml +++ b/conf/testdata/cfg.yaml @@ -1,6 +1,9 @@ musicFolder: "/yaml/music" uiWelcomeMessage: "Welcome yaml" +reverseProxyUserHeader: "X-Auth-User" Tags: + artist: + split: [";"] custom: aliases: - yaml diff --git a/consts/consts.go b/consts/consts.go index fbb2c9429..f1010a872 100644 --- a/consts/consts.go +++ b/consts/consts.go @@ -56,6 +56,8 @@ const ( ServerReadHeaderTimeout = 3 * time.Second + DefaultInfoLanguage = "en" + ArtistInfoTimeToLive = 24 * time.Hour AlbumInfoTimeToLive = 7 * 24 * time.Hour UpdateLastAccessFrequency = time.Minute @@ -63,20 +65,31 @@ const ( I18nFolder = "i18n" ScanIgnoreFile = ".ndignore" + ArtworkFolder = "artwork" - PlaceholderArtistArt = "artist-placeholder.webp" - PlaceholderAlbumArt = "album-placeholder.webp" - PlaceholderAvatar = "logo-192x192.png" - UICoverArtSize = 300 - DefaultUIVolume = 100 + PlaceholderArtistArt = "artist-placeholder.webp" + PlaceholderAlbumArt = "album-placeholder.webp" + PlaceholderAvatar = "logo-192x192.png" + DefaultUIVolume = 100 + DefaultUISearchDebounceMs = 200 DefaultHttpClientTimeOut = 10 * time.Second + DefaultListenBrainzBaseURL = "https://api.listenbrainz.org/1/" + DefaultListenBrainzArtistAlgorithm = "session_based_days_9000_session_300_contribution_5_threshold_15_limit_50_skip_30" + DefaultListenBrainzTrackAlgorithm = "session_based_days_9000_session_300_contribution_5_threshold_15_limit_50_skip_30" + DefaultScannerExtractor = "taglib" DefaultWatcherWait = 5 * time.Second Zwsp = string('\u200b') ) +const ( + UICoverArtSize = 600 +) + +var CacheWarmerImageSizes = []int{UICoverArtSize} + // Prometheus options const ( PrometheusDefaultPath = "/metrics" @@ -95,6 +108,13 @@ const ( DefaultCacheCleanUpInterval = 10 * time.Minute ) +// Entity types +const ( + EntityArtist = "artist" + EntityPlaylist = "playlist" + EntityRadio = "radio" +) + const ( AlbumPlayCountModeAbsolute = "absolute" AlbumPlayCountModeNormalized = "normalized" @@ -147,9 +167,17 @@ var ( DefaultBitRate: 256, Command: "ffmpeg -i %s -ss %t -map 0:a:0 -b:a %bk -v 0 -c:a aac -f adts -", }, + { + Name: "flac audio", + TargetFormat: "flac", + DefaultBitRate: 0, + Command: "ffmpeg -i %s -ss %t -map 0:a:0 -v 0 -c:a flac -f flac -", + }, } ) +var HTTPUserAgent = "Navidrome" + "/" + Version + var ( VariousArtists = "Various Artists" // TODO This will be dynamic when using disambiguation diff --git a/core/agents/README.md b/core/agents/README.md index 1a3a8e96e..cce62889c 100644 --- a/core/agents/README.md +++ b/core/agents/README.md @@ -7,6 +7,6 @@ A new agent must comply with these simple implementation rules: 2) Implement one or more of the `*Retriever()` interfaces. That's where the agent's logic resides. 3) Register itself (in its `init()` function). -For an agent to be used it needs to be listed in the `Agents` config option (default is `"lastfm,spotify"`). The order dictates the priority of the agents +For an agent to be used it needs to be listed in the `Agents` config option (default is `"deezer,lastfm"`). The order dictates the priority of the agents For a simple Agent example, look at the [local_agent](local_agent.go) agent source code. diff --git a/core/agents/agents.go b/core/agents/agents.go index 4ec324b71..ead6dacd0 100644 --- a/core/agents/agents.go +++ b/core/agents/agents.go @@ -22,6 +22,8 @@ type PluginLoader interface { LoadMediaAgent(name string) (Interface, bool) } +// Agents is a meta-agent that aggregates multiple built-in and plugin agents. It tries each enabled agent in order +// until one returns valid data. type Agents struct { ds model.DataStore pluginLoader PluginLoader @@ -64,6 +66,7 @@ func (a *Agents) getEnabledAgentNames() []enabledAgent { if a.pluginLoader != nil { availablePlugins = a.pluginLoader.PluginNames("MetadataAgent") } + log.Trace("Available MetadataAgent plugins", "plugins", availablePlugins) configuredAgents := strings.Split(conf.Server.Agents, ",") @@ -87,7 +90,7 @@ func (a *Agents) getEnabledAgentNames() []enabledAgent { } else if isPlugin { validAgents = append(validAgents, enabledAgent{name: name, isPlugin: true}) } else { - log.Warn("Unknown agent ignored", "name", name) + log.Debug("Unknown agent ignored", "name", name) } } return validAgents @@ -128,26 +131,14 @@ func (a *Agents) GetArtistMBID(ctx context.Context, id string, name string) (str case consts.VariousArtistsID: return "", nil } - start := time.Now() - for _, enabledAgent := range a.getEnabledAgentNames() { - ag := a.getAgent(enabledAgent) - if ag == nil { - continue - } - if utils.IsCtxDone(ctx) { - break - } + + return callAgentMethod(ctx, a, "GetArtistMBID", func(ag Interface) (string, error) { retriever, ok := ag.(ArtistMBIDRetriever) if !ok { - continue + return "", ErrNotFound } - mbid, err := retriever.GetArtistMBID(ctx, id, name) - if mbid != "" && err == nil { - log.Debug(ctx, "Got MBID", "agent", ag.AgentName(), "artist", name, "mbid", mbid, "elapsed", time.Since(start)) - return mbid, nil - } - } - return "", ErrNotFound + return retriever.GetArtistMBID(ctx, id, name) + }) } func (a *Agents) GetArtistURL(ctx context.Context, id, name, mbid string) (string, error) { @@ -157,26 +148,14 @@ func (a *Agents) GetArtistURL(ctx context.Context, id, name, mbid string) (strin case consts.VariousArtistsID: return "", nil } - start := time.Now() - for _, enabledAgent := range a.getEnabledAgentNames() { - ag := a.getAgent(enabledAgent) - if ag == nil { - continue - } - if utils.IsCtxDone(ctx) { - break - } + + return callAgentMethod(ctx, a, "GetArtistURL", func(ag Interface) (string, error) { retriever, ok := ag.(ArtistURLRetriever) if !ok { - continue + return "", ErrNotFound } - url, err := retriever.GetArtistURL(ctx, id, name, mbid) - if url != "" && err == nil { - log.Debug(ctx, "Got External Url", "agent", ag.AgentName(), "artist", name, "url", url, "elapsed", time.Since(start)) - return url, nil - } - } - return "", ErrNotFound + return retriever.GetArtistURL(ctx, id, name, mbid) + }) } func (a *Agents) GetArtistBiography(ctx context.Context, id, name, mbid string) (string, error) { @@ -186,26 +165,14 @@ func (a *Agents) GetArtistBiography(ctx context.Context, id, name, mbid string) case consts.VariousArtistsID: return "", nil } - start := time.Now() - for _, enabledAgent := range a.getEnabledAgentNames() { - ag := a.getAgent(enabledAgent) - if ag == nil { - continue - } - if utils.IsCtxDone(ctx) { - break - } + + return callAgentMethod(ctx, a, "GetArtistBiography", func(ag Interface) (string, error) { retriever, ok := ag.(ArtistBiographyRetriever) if !ok { - continue + return "", ErrNotFound } - bio, err := retriever.GetArtistBiography(ctx, id, name, mbid) - if err == nil { - log.Debug(ctx, "Got Biography", "agent", ag.AgentName(), "artist", name, "len", len(bio), "elapsed", time.Since(start)) - return bio, nil - } - } - return "", ErrNotFound + return retriever.GetArtistBiography(ctx, id, name, mbid) + }) } // GetSimilarArtists returns similar artists by id, name, and/or mbid. Because some artists returned from an enabled @@ -253,26 +220,14 @@ func (a *Agents) GetArtistImages(ctx context.Context, id, name, mbid string) ([] case consts.VariousArtistsID: return nil, nil } - start := time.Now() - for _, enabledAgent := range a.getEnabledAgentNames() { - ag := a.getAgent(enabledAgent) - if ag == nil { - continue - } - if utils.IsCtxDone(ctx) { - break - } + + return callAgentSliceMethod(ctx, a, "GetArtistImages", func(ag Interface) ([]ExternalImage, error) { retriever, ok := ag.(ArtistImageRetriever) if !ok { - continue + return nil, ErrNotFound } - images, err := retriever.GetArtistImages(ctx, id, name, mbid) - if len(images) > 0 && err == nil { - log.Debug(ctx, "Got Images", "agent", ag.AgentName(), "artist", name, "images", images, "elapsed", time.Since(start)) - return images, nil - } - } - return nil, ErrNotFound + return retriever.GetArtistImages(ctx, id, name, mbid) + }) } // GetArtistTopSongs returns top songs by id, name, and/or mbid. Because some songs returned from an enabled @@ -287,77 +242,127 @@ func (a *Agents) GetArtistTopSongs(ctx context.Context, id, artistName, mbid str overLimit := int(float64(count) * conf.Server.DevExternalArtistFetchMultiplier) - start := time.Now() - for _, enabledAgent := range a.getEnabledAgentNames() { - ag := a.getAgent(enabledAgent) - if ag == nil { - continue - } - if utils.IsCtxDone(ctx) { - break - } + return callAgentSliceMethod(ctx, a, "GetArtistTopSongs", func(ag Interface) ([]Song, error) { retriever, ok := ag.(ArtistTopSongsRetriever) if !ok { - continue + return nil, ErrNotFound } - songs, err := retriever.GetArtistTopSongs(ctx, id, artistName, mbid, overLimit) - if len(songs) > 0 && err == nil { - log.Debug(ctx, "Got Top Songs", "agent", ag.AgentName(), "artist", artistName, "songs", songs, "elapsed", time.Since(start)) - return songs, nil - } - } - return nil, ErrNotFound + return retriever.GetArtistTopSongs(ctx, id, artistName, mbid, overLimit) + }) } func (a *Agents) GetAlbumInfo(ctx context.Context, name, artist, mbid string) (*AlbumInfo, error) { if name == consts.UnknownAlbum { return nil, ErrNotFound } - start := time.Now() - for _, enabledAgent := range a.getEnabledAgentNames() { - ag := a.getAgent(enabledAgent) - if ag == nil { - continue - } - if utils.IsCtxDone(ctx) { - break - } + + return callAgentMethod(ctx, a, "GetAlbumInfo", func(ag Interface) (*AlbumInfo, error) { retriever, ok := ag.(AlbumInfoRetriever) if !ok { - continue + return nil, ErrNotFound } - album, err := retriever.GetAlbumInfo(ctx, name, artist, mbid) - if err == nil { - log.Debug(ctx, "Got Album Info", "agent", ag.AgentName(), "album", name, "artist", artist, - "mbid", mbid, "elapsed", time.Since(start)) - return album, nil - } - } - return nil, ErrNotFound + return retriever.GetAlbumInfo(ctx, name, artist, mbid) + }) } func (a *Agents) GetAlbumImages(ctx context.Context, name, artist, mbid string) ([]ExternalImage, error) { if name == consts.UnknownAlbum { return nil, ErrNotFound } + + return callAgentSliceMethod(ctx, a, "GetAlbumImages", func(ag Interface) ([]ExternalImage, error) { + retriever, ok := ag.(AlbumImageRetriever) + if !ok { + return nil, ErrNotFound + } + return retriever.GetAlbumImages(ctx, name, artist, mbid) + }) +} + +// GetSimilarSongsByTrack returns similar songs for a given track. +func (a *Agents) GetSimilarSongsByTrack(ctx context.Context, id, name, artist, mbid string, count int) ([]Song, error) { + return callAgentSliceMethod(ctx, a, "GetSimilarSongsByTrack", func(ag Interface) ([]Song, error) { + retriever, ok := ag.(SimilarSongsByTrackRetriever) + if !ok { + return nil, ErrNotFound + } + return retriever.GetSimilarSongsByTrack(ctx, id, name, artist, mbid, count) + }) +} + +// GetSimilarSongsByAlbum returns similar songs for a given album. +func (a *Agents) GetSimilarSongsByAlbum(ctx context.Context, id, name, artist, mbid string, count int) ([]Song, error) { + return callAgentSliceMethod(ctx, a, "GetSimilarSongsByAlbum", func(ag Interface) ([]Song, error) { + retriever, ok := ag.(SimilarSongsByAlbumRetriever) + if !ok { + return nil, ErrNotFound + } + return retriever.GetSimilarSongsByAlbum(ctx, id, name, artist, mbid, count) + }) +} + +// GetSimilarSongsByArtist returns similar songs for a given artist. +func (a *Agents) GetSimilarSongsByArtist(ctx context.Context, id, name, mbid string, count int) ([]Song, error) { + switch id { + case consts.UnknownArtistID: + return nil, ErrNotFound + case consts.VariousArtistsID: + return nil, nil + } + + return callAgentSliceMethod(ctx, a, "GetSimilarSongsByArtist", func(ag Interface) ([]Song, error) { + retriever, ok := ag.(SimilarSongsByArtistRetriever) + if !ok { + return nil, ErrNotFound + } + return retriever.GetSimilarSongsByArtist(ctx, id, name, mbid, count) + }) +} + +func callAgentMethod[T comparable](ctx context.Context, agents *Agents, methodName string, fn func(Interface) (T, error)) (T, error) { + var zero T start := time.Now() - for _, enabledAgent := range a.getEnabledAgentNames() { - ag := a.getAgent(enabledAgent) + for _, enabledAgent := range agents.getEnabledAgentNames() { + ag := agents.getAgent(enabledAgent) if ag == nil { continue } if utils.IsCtxDone(ctx) { break } - retriever, ok := ag.(AlbumImageRetriever) - if !ok { + result, err := fn(ag) + if err != nil { + log.Trace(ctx, "Agent method call error", "method", methodName, "agent", ag.AgentName(), "error", err) continue } - images, err := retriever.GetAlbumImages(ctx, name, artist, mbid) - if len(images) > 0 && err == nil { - log.Debug(ctx, "Got Album Images", "agent", ag.AgentName(), "album", name, "artist", artist, - "mbid", mbid, "elapsed", time.Since(start)) - return images, nil + + if result != zero { + log.Debug(ctx, "Got result", "method", methodName, "agent", ag.AgentName(), "elapsed", time.Since(start)) + return result, nil + } + } + return zero, ErrNotFound +} + +func callAgentSliceMethod[T any](ctx context.Context, agents *Agents, methodName string, fn func(Interface) ([]T, error)) ([]T, error) { + start := time.Now() + for _, enabledAgent := range agents.getEnabledAgentNames() { + ag := agents.getAgent(enabledAgent) + if ag == nil { + continue + } + if utils.IsCtxDone(ctx) { + break + } + results, err := fn(ag) + if err != nil { + log.Trace(ctx, "Agent method call error", "method", methodName, "agent", ag.AgentName(), "error", err) + continue + } + + if len(results) > 0 { + log.Debug(ctx, "Got results", "method", methodName, "agent", ag.AgentName(), "count", len(results), "elapsed", time.Since(start)) + return results, nil } } return nil, ErrNotFound @@ -372,3 +377,6 @@ var _ ArtistImageRetriever = (*Agents)(nil) var _ ArtistTopSongsRetriever = (*Agents)(nil) var _ AlbumInfoRetriever = (*Agents)(nil) var _ AlbumImageRetriever = (*Agents)(nil) +var _ SimilarSongsByTrackRetriever = (*Agents)(nil) +var _ SimilarSongsByAlbumRetriever = (*Agents)(nil) +var _ SimilarSongsByArtistRetriever = (*Agents)(nil) diff --git a/core/agents/agents_test.go b/core/agents/agents_test.go index 0b7eec282..50285a084 100644 --- a/core/agents/agents_test.go +++ b/core/agents/agents_test.go @@ -295,11 +295,77 @@ var _ = Describe("Agents", func() { Expect(mock.Args).To(BeEmpty()) }) }) + + Describe("GetSimilarSongsByTrack", func() { + It("returns on first match", func() { + Expect(ag.GetSimilarSongsByTrack(ctx, "123", "test song", "test artist", "mb123", 2)).To(Equal([]Song{{ + Name: "Similar Song", + MBID: "mbid555", + }})) + Expect(mock.Args).To(HaveExactElements("123", "test song", "test artist", "mb123", 2)) + }) + It("skips the agent if it returns an error", func() { + mock.Err = errors.New("error") + _, err := ag.GetSimilarSongsByTrack(ctx, "123", "test song", "test artist", "mb123", 2) + Expect(err).To(MatchError(ErrNotFound)) + Expect(mock.Args).To(HaveExactElements("123", "test song", "test artist", "mb123", 2)) + }) + It("interrupts if the context is canceled", func() { + cancel() + _, err := ag.GetSimilarSongsByTrack(ctx, "123", "test song", "test artist", "mb123", 2) + Expect(err).To(MatchError(ErrNotFound)) + Expect(mock.Args).To(BeEmpty()) + }) + }) + + Describe("GetSimilarSongsByAlbum", func() { + It("returns on first match", func() { + Expect(ag.GetSimilarSongsByAlbum(ctx, "123", "test album", "test artist", "mb123", 2)).To(Equal([]Song{{ + Name: "Album Similar Song", + MBID: "mbid666", + }})) + Expect(mock.Args).To(HaveExactElements("123", "test album", "test artist", "mb123", 2)) + }) + It("skips the agent if it returns an error", func() { + mock.Err = errors.New("error") + _, err := ag.GetSimilarSongsByAlbum(ctx, "123", "test album", "test artist", "mb123", 2) + Expect(err).To(MatchError(ErrNotFound)) + Expect(mock.Args).To(HaveExactElements("123", "test album", "test artist", "mb123", 2)) + }) + It("interrupts if the context is canceled", func() { + cancel() + _, err := ag.GetSimilarSongsByAlbum(ctx, "123", "test album", "test artist", "mb123", 2) + Expect(err).To(MatchError(ErrNotFound)) + Expect(mock.Args).To(BeEmpty()) + }) + }) + + Describe("GetSimilarSongsByArtist", func() { + It("returns on first match", func() { + Expect(ag.GetSimilarSongsByArtist(ctx, "123", "test artist", "mb123", 2)).To(Equal([]Song{{ + Name: "Artist Similar Song", + MBID: "mbid777", + }})) + Expect(mock.Args).To(HaveExactElements("123", "test artist", "mb123", 2)) + }) + It("skips the agent if it returns an error", func() { + mock.Err = errors.New("error") + _, err := ag.GetSimilarSongsByArtist(ctx, "123", "test artist", "mb123", 2) + Expect(err).To(MatchError(ErrNotFound)) + Expect(mock.Args).To(HaveExactElements("123", "test artist", "mb123", 2)) + }) + It("interrupts if the context is canceled", func() { + cancel() + _, err := ag.GetSimilarSongsByArtist(ctx, "123", "test artist", "mb123", 2) + Expect(err).To(MatchError(ErrNotFound)) + Expect(mock.Args).To(BeEmpty()) + }) + }) }) }) type mockAgent struct { - Args []interface{} + Args []any Err error } @@ -308,7 +374,7 @@ func (a *mockAgent) AgentName() string { } func (a *mockAgent) GetArtistMBID(_ context.Context, id string, name string) (string, error) { - a.Args = []interface{}{id, name} + a.Args = []any{id, name} if a.Err != nil { return "", a.Err } @@ -316,7 +382,7 @@ func (a *mockAgent) GetArtistMBID(_ context.Context, id string, name string) (st } func (a *mockAgent) GetArtistURL(_ context.Context, id, name, mbid string) (string, error) { - a.Args = []interface{}{id, name, mbid} + a.Args = []any{id, name, mbid} if a.Err != nil { return "", a.Err } @@ -324,7 +390,7 @@ func (a *mockAgent) GetArtistURL(_ context.Context, id, name, mbid string) (stri } func (a *mockAgent) GetArtistBiography(_ context.Context, id, name, mbid string) (string, error) { - a.Args = []interface{}{id, name, mbid} + a.Args = []any{id, name, mbid} if a.Err != nil { return "", a.Err } @@ -332,7 +398,7 @@ func (a *mockAgent) GetArtistBiography(_ context.Context, id, name, mbid string) } func (a *mockAgent) GetArtistImages(_ context.Context, id, name, mbid string) ([]ExternalImage, error) { - a.Args = []interface{}{id, name, mbid} + a.Args = []any{id, name, mbid} if a.Err != nil { return nil, a.Err } @@ -343,7 +409,7 @@ func (a *mockAgent) GetArtistImages(_ context.Context, id, name, mbid string) ([ } func (a *mockAgent) GetSimilarArtists(_ context.Context, id, name, mbid string, limit int) ([]Artist, error) { - a.Args = []interface{}{id, name, mbid, limit} + a.Args = []any{id, name, mbid, limit} if a.Err != nil { return nil, a.Err } @@ -354,7 +420,7 @@ func (a *mockAgent) GetSimilarArtists(_ context.Context, id, name, mbid string, } func (a *mockAgent) GetArtistTopSongs(_ context.Context, id, artistName, mbid string, count int) ([]Song, error) { - a.Args = []interface{}{id, artistName, mbid, count} + a.Args = []any{id, artistName, mbid, count} if a.Err != nil { return nil, a.Err } @@ -365,7 +431,7 @@ func (a *mockAgent) GetArtistTopSongs(_ context.Context, id, artistName, mbid st } func (a *mockAgent) GetAlbumInfo(ctx context.Context, name, artist, mbid string) (*AlbumInfo, error) { - a.Args = []interface{}{name, artist, mbid} + a.Args = []any{name, artist, mbid} if a.Err != nil { return nil, a.Err } @@ -377,6 +443,39 @@ func (a *mockAgent) GetAlbumInfo(ctx context.Context, name, artist, mbid string) }, nil } +func (a *mockAgent) GetSimilarSongsByTrack(_ context.Context, id, name, artist, mbid string, count int) ([]Song, error) { + a.Args = []any{id, name, artist, mbid, count} + if a.Err != nil { + return nil, a.Err + } + return []Song{{ + Name: "Similar Song", + MBID: "mbid555", + }}, nil +} + +func (a *mockAgent) GetSimilarSongsByAlbum(_ context.Context, id, name, artist, mbid string, count int) ([]Song, error) { + a.Args = []any{id, name, artist, mbid, count} + if a.Err != nil { + return nil, a.Err + } + return []Song{{ + Name: "Album Similar Song", + MBID: "mbid666", + }}, nil +} + +func (a *mockAgent) GetSimilarSongsByArtist(_ context.Context, id, name, mbid string, count int) ([]Song, error) { + a.Args = []any{id, name, mbid, count} + if a.Err != nil { + return nil, a.Err + } + return []Song{{ + Name: "Artist Similar Song", + MBID: "mbid777", + }}, nil +} + type emptyAgent struct { Interface } @@ -389,12 +488,12 @@ type testImageAgent struct { Name string Images []ExternalImage Err error - Args []interface{} + Args []any } func (t *testImageAgent) AgentName() string { return t.Name } func (t *testImageAgent) GetArtistImages(_ context.Context, id, name, mbid string) ([]ExternalImage, error) { - t.Args = []interface{}{id, name, mbid} + t.Args = []any{id, name, mbid} return t.Images, t.Err } diff --git a/core/agents/deezer/client.go b/core/agents/deezer/client.go deleted file mode 100644 index e75526d80..000000000 --- a/core/agents/deezer/client.go +++ /dev/null @@ -1,83 +0,0 @@ -package deezer - -import ( - "context" - "encoding/json" - "errors" - "fmt" - "io" - "net/http" - "net/url" - "strconv" - - "github.com/navidrome/navidrome/log" -) - -const apiBaseURL = "https://api.deezer.com" - -var ( - ErrNotFound = errors.New("deezer: not found") -) - -type httpDoer interface { - Do(req *http.Request) (*http.Response, error) -} - -type client struct { - httpDoer httpDoer -} - -func newClient(hc httpDoer) *client { - return &client{hc} -} - -func (c *client) searchArtists(ctx context.Context, name string, limit int) ([]Artist, error) { - params := url.Values{} - params.Add("q", name) - params.Add("limit", strconv.Itoa(limit)) - req, err := http.NewRequestWithContext(ctx, "GET", apiBaseURL+"/search/artist", nil) - if err != nil { - return nil, err - } - req.URL.RawQuery = params.Encode() - - var results SearchArtistResults - err = c.makeRequest(req, &results) - if err != nil { - return nil, err - } - - if len(results.Data) == 0 { - return nil, ErrNotFound - } - return results.Data, nil -} - -func (c *client) makeRequest(req *http.Request, response interface{}) error { - log.Trace(req.Context(), fmt.Sprintf("Sending Deezer %s request", req.Method), "url", req.URL) - resp, err := c.httpDoer.Do(req) - if err != nil { - return err - } - - defer resp.Body.Close() - data, err := io.ReadAll(resp.Body) - if err != nil { - return err - } - - if resp.StatusCode != 200 { - return c.parseError(data) - } - - return json.Unmarshal(data, response) -} - -func (c *client) parseError(data []byte) error { - var deezerError Error - err := json.Unmarshal(data, &deezerError) - if err != nil { - return err - } - return fmt.Errorf("deezer error(%d): %s", deezerError.Error.Code, deezerError.Error.Message) -} diff --git a/core/agents/deezer/client_test.go b/core/agents/deezer/client_test.go deleted file mode 100644 index 5e47460d4..000000000 --- a/core/agents/deezer/client_test.go +++ /dev/null @@ -1,68 +0,0 @@ -package deezer - -import ( - "bytes" - "context" - "io" - "net/http" - "os" - - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" -) - -var _ = Describe("client", func() { - var httpClient *fakeHttpClient - var client *client - - BeforeEach(func() { - httpClient = &fakeHttpClient{} - client = newClient(httpClient) - }) - - Describe("ArtistImages", func() { - It("returns artist images from a successful request", func() { - f, err := os.Open("tests/fixtures/deezer.search.artist.json") - Expect(err).To(BeNil()) - httpClient.mock("https://api.deezer.com/search/artist", http.Response{Body: f, StatusCode: 200}) - - artists, err := client.searchArtists(context.TODO(), "Michael Jackson", 20) - Expect(err).To(BeNil()) - Expect(artists).To(HaveLen(17)) - Expect(artists[0].Name).To(Equal("Michael Jackson")) - Expect(artists[0].PictureXl).To(Equal("https://cdn-images.dzcdn.net/images/artist/97fae13b2b30e4aec2e8c9e0c7839d92/1000x1000-000000-80-0-0.jpg")) - }) - - It("fails if artist was not found", func() { - httpClient.mock("https://api.deezer.com/search/artist", http.Response{ - StatusCode: 200, - Body: io.NopCloser(bytes.NewBufferString(`{"data":[],"total":0}`)), - }) - - _, err := client.searchArtists(context.TODO(), "Michael Jackson", 20) - Expect(err).To(MatchError(ErrNotFound)) - }) - }) -}) - -type fakeHttpClient struct { - responses map[string]*http.Response - lastRequest *http.Request -} - -func (c *fakeHttpClient) mock(url string, response http.Response) { - if c.responses == nil { - c.responses = make(map[string]*http.Response) - } - c.responses[url] = &response -} - -func (c *fakeHttpClient) Do(req *http.Request) (*http.Response, error) { - c.lastRequest = req - u := req.URL - u.RawQuery = "" - if resp, ok := c.responses[u.String()]; ok { - return resp, nil - } - panic("URL not mocked: " + u.String()) -} diff --git a/core/agents/deezer/responses.go b/core/agents/deezer/responses.go deleted file mode 100644 index 112fe28ec..000000000 --- a/core/agents/deezer/responses.go +++ /dev/null @@ -1,31 +0,0 @@ -package deezer - -type SearchArtistResults struct { - Data []Artist `json:"data"` - Total int `json:"total"` - Next string `json:"next"` -} - -type Artist struct { - ID int `json:"id"` - Name string `json:"name"` - Link string `json:"link"` - Picture string `json:"picture"` - PictureSmall string `json:"picture_small"` - PictureMedium string `json:"picture_medium"` - PictureBig string `json:"picture_big"` - PictureXl string `json:"picture_xl"` - NbAlbum int `json:"nb_album"` - NbFan int `json:"nb_fan"` - Radio bool `json:"radio"` - Tracklist string `json:"tracklist"` - Type string `json:"type"` -} - -type Error struct { - Error struct { - Type string `json:"type"` - Message string `json:"message"` - Code int `json:"code"` - } `json:"error"` -} diff --git a/core/agents/interfaces.go b/core/agents/interfaces.go index e60c61909..19df91d02 100644 --- a/core/agents/interfaces.go +++ b/core/agents/interfaces.go @@ -22,6 +22,7 @@ type AlbumInfo struct { } type Artist struct { + ID string Name string MBID string } @@ -32,8 +33,15 @@ type ExternalImage struct { } type Song struct { - Name string - MBID string + ID string + Name string + MBID string + ISRC string + Artist string + ArtistMBID string + Album string + AlbumMBID string + Duration uint32 // Duration in milliseconds, 0 means unknown } var ( @@ -74,6 +82,41 @@ type ArtistTopSongsRetriever interface { GetArtistTopSongs(ctx context.Context, id, artistName, mbid string, count int) ([]Song, error) } +// SimilarSongsByTrackRetriever provides similar songs based on a specific track +type SimilarSongsByTrackRetriever interface { + // GetSimilarSongsByTrack returns songs similar to the given track. + // Parameters: + // - id: local mediafile ID + // - name: track title + // - artist: artist name + // - mbid: MusicBrainz recording ID (may be empty) + // - count: maximum number of results + GetSimilarSongsByTrack(ctx context.Context, id, name, artist, mbid string, count int) ([]Song, error) +} + +// SimilarSongsByAlbumRetriever provides similar songs based on an album +type SimilarSongsByAlbumRetriever interface { + // GetSimilarSongsByAlbum returns songs similar to tracks on the given album. + // Parameters: + // - id: local album ID + // - name: album name + // - artist: album artist name + // - mbid: MusicBrainz release ID (may be empty) + // - count: maximum number of results + GetSimilarSongsByAlbum(ctx context.Context, id, name, artist, mbid string, count int) ([]Song, error) +} + +// SimilarSongsByArtistRetriever provides similar songs based on an artist +type SimilarSongsByArtistRetriever interface { + // GetSimilarSongsByArtist returns songs similar to the artist's catalog. + // Parameters: + // - id: local artist ID + // - name: artist name + // - mbid: MusicBrainz artist ID (may be empty) + // - count: maximum number of results + GetSimilarSongsByArtist(ctx context.Context, id, name, mbid string, count int) ([]Song, error) +} + var Map map[string]Constructor func Register(name string, init Constructor) { diff --git a/core/agents/listenbrainz/agent_test.go b/core/agents/listenbrainz/agent_test.go deleted file mode 100644 index e99b442de..000000000 --- a/core/agents/listenbrainz/agent_test.go +++ /dev/null @@ -1,165 +0,0 @@ -package listenbrainz - -import ( - "bytes" - "context" - "encoding/json" - "io" - "net/http" - "time" - - "github.com/navidrome/navidrome/consts" - "github.com/navidrome/navidrome/core/scrobbler" - "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/tests" - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" - . "github.com/onsi/gomega/gstruct" -) - -var _ = Describe("listenBrainzAgent", func() { - var ds model.DataStore - var ctx context.Context - var agent *listenBrainzAgent - var httpClient *tests.FakeHttpClient - var track *model.MediaFile - - BeforeEach(func() { - ds = &tests.MockDataStore{} - ctx = context.Background() - _ = ds.UserProps(ctx).Put("user-1", sessionKeyProperty, "SK-1") - httpClient = &tests.FakeHttpClient{} - agent = listenBrainzConstructor(ds) - agent.client = newClient("http://localhost:8080", httpClient) - track = &model.MediaFile{ - ID: "123", - Title: "Track Title", - Album: "Track Album", - Artist: "Track Artist", - TrackNumber: 1, - MbzRecordingID: "mbz-123", - MbzAlbumID: "mbz-456", - MbzReleaseGroupID: "mbz-789", - Duration: 142.2, - Participants: map[model.Role]model.ParticipantList{ - model.RoleArtist: []model.Participant{ - {Artist: model.Artist{ID: "ar-1", Name: "Artist 1", MbzArtistID: "mbz-111"}}, - {Artist: model.Artist{ID: "ar-2", Name: "Artist 2", MbzArtistID: "mbz-222"}}, - }, - }, - } - }) - - Describe("formatListen", func() { - It("constructs the listenInfo properly", func() { - lr := agent.formatListen(track) - Expect(lr).To(MatchAllFields(Fields{ - "ListenedAt": Equal(0), - "TrackMetadata": MatchAllFields(Fields{ - "ArtistName": Equal(track.Artist), - "TrackName": Equal(track.Title), - "ReleaseName": Equal(track.Album), - "AdditionalInfo": MatchAllFields(Fields{ - "SubmissionClient": Equal(consts.AppName), - "SubmissionClientVersion": Equal(consts.Version), - "TrackNumber": Equal(track.TrackNumber), - "RecordingMBID": Equal(track.MbzRecordingID), - "ReleaseMBID": Equal(track.MbzAlbumID), - "ReleaseGroupMBID": Equal(track.MbzReleaseGroupID), - "ArtistNames": ConsistOf("Artist 1", "Artist 2"), - "ArtistMBIDs": ConsistOf("mbz-111", "mbz-222"), - "DurationMs": Equal(142200), - }), - }), - })) - }) - }) - - Describe("NowPlaying", func() { - It("updates NowPlaying successfully", func() { - httpClient.Res = http.Response{Body: io.NopCloser(bytes.NewBufferString(`{"status": "ok"}`)), StatusCode: 200} - - err := agent.NowPlaying(ctx, "user-1", track, 0) - Expect(err).ToNot(HaveOccurred()) - }) - - It("returns ErrNotAuthorized if user is not linked", func() { - err := agent.NowPlaying(ctx, "user-2", track, 0) - Expect(err).To(MatchError(scrobbler.ErrNotAuthorized)) - }) - }) - - Describe("Scrobble", func() { - var sc scrobbler.Scrobble - - BeforeEach(func() { - sc = scrobbler.Scrobble{MediaFile: *track, TimeStamp: time.Now()} - }) - - It("sends a Scrobble successfully", func() { - httpClient.Res = http.Response{Body: io.NopCloser(bytes.NewBufferString(`{"status": "ok"}`)), StatusCode: 200} - - err := agent.Scrobble(ctx, "user-1", sc) - Expect(err).ToNot(HaveOccurred()) - }) - - It("sets the Timestamp properly", func() { - httpClient.Res = http.Response{Body: io.NopCloser(bytes.NewBufferString(`{"status": "ok"}`)), StatusCode: 200} - - err := agent.Scrobble(ctx, "user-1", sc) - Expect(err).ToNot(HaveOccurred()) - - decoder := json.NewDecoder(httpClient.SavedRequest.Body) - var lr listenBrainzRequestBody - err = decoder.Decode(&lr) - - Expect(err).ToNot(HaveOccurred()) - Expect(lr.Payload[0].ListenedAt).To(Equal(int(sc.TimeStamp.Unix()))) - }) - - It("returns ErrNotAuthorized if user is not linked", func() { - err := agent.Scrobble(ctx, "user-2", sc) - Expect(err).To(MatchError(scrobbler.ErrNotAuthorized)) - }) - - It("returns ErrRetryLater on error 503", func() { - httpClient.Res = http.Response{ - Body: io.NopCloser(bytes.NewBufferString(`{"code": 503, "error": "Cannot submit listens to queue, please try again later."}`)), - StatusCode: 503, - } - - err := agent.Scrobble(ctx, "user-1", sc) - Expect(err).To(MatchError(scrobbler.ErrRetryLater)) - }) - - It("returns ErrRetryLater on error 500", func() { - httpClient.Res = http.Response{ - Body: io.NopCloser(bytes.NewBufferString(`{"code": 500, "error": "Something went wrong. Please try again."}`)), - StatusCode: 500, - } - - err := agent.Scrobble(ctx, "user-1", sc) - Expect(err).To(MatchError(scrobbler.ErrRetryLater)) - }) - - It("returns ErrRetryLater on http errors", func() { - httpClient.Res = http.Response{ - Body: io.NopCloser(bytes.NewBufferString(`Bad Gateway`)), - StatusCode: 500, - } - - err := agent.Scrobble(ctx, "user-1", sc) - Expect(err).To(MatchError(scrobbler.ErrRetryLater)) - }) - - It("returns ErrUnrecoverable on other errors", func() { - httpClient.Res = http.Response{ - Body: io.NopCloser(bytes.NewBufferString(`{"code": 400, "error": "BadRequest: Invalid JSON document submitted."}`)), - StatusCode: 400, - } - - err := agent.Scrobble(ctx, "user-1", sc) - Expect(err).To(MatchError(scrobbler.ErrUnrecoverable)) - }) - }) -}) diff --git a/core/agents/listenbrainz/client.go b/core/agents/listenbrainz/client.go deleted file mode 100644 index 168aad549..000000000 --- a/core/agents/listenbrainz/client.go +++ /dev/null @@ -1,179 +0,0 @@ -package listenbrainz - -import ( - "bytes" - "context" - "encoding/json" - "fmt" - "net/http" - "net/url" - "path" - - "github.com/navidrome/navidrome/log" -) - -type listenBrainzError struct { - Code int - Message string -} - -func (e *listenBrainzError) Error() string { - return fmt.Sprintf("ListenBrainz error(%d): %s", e.Code, e.Message) -} - -type httpDoer interface { - Do(req *http.Request) (*http.Response, error) -} - -func newClient(baseURL string, hc httpDoer) *client { - return &client{baseURL, hc} -} - -type client struct { - baseURL string - hc httpDoer -} - -type listenBrainzResponse struct { - Code int `json:"code"` - Message string `json:"message"` - Error string `json:"error"` - Status string `json:"status"` - Valid bool `json:"valid"` - UserName string `json:"user_name"` -} - -type listenBrainzRequest struct { - ApiKey string - Body listenBrainzRequestBody -} - -type listenBrainzRequestBody struct { - ListenType listenType `json:"listen_type,omitempty"` - Payload []listenInfo `json:"payload,omitempty"` -} - -type listenType string - -const ( - Single listenType = "single" - PlayingNow listenType = "playing_now" -) - -type listenInfo struct { - ListenedAt int `json:"listened_at,omitempty"` - TrackMetadata trackMetadata `json:"track_metadata,omitempty"` -} - -type trackMetadata struct { - ArtistName string `json:"artist_name,omitempty"` - TrackName string `json:"track_name,omitempty"` - ReleaseName string `json:"release_name,omitempty"` - AdditionalInfo additionalInfo `json:"additional_info,omitempty"` -} - -type additionalInfo struct { - SubmissionClient string `json:"submission_client,omitempty"` - SubmissionClientVersion string `json:"submission_client_version,omitempty"` - TrackNumber int `json:"tracknumber,omitempty"` - ArtistNames []string `json:"artist_names,omitempty"` - ArtistMBIDs []string `json:"artist_mbids,omitempty"` - RecordingMBID string `json:"recording_mbid,omitempty"` - ReleaseMBID string `json:"release_mbid,omitempty"` - ReleaseGroupMBID string `json:"release_group_mbid,omitempty"` - DurationMs int `json:"duration_ms,omitempty"` -} - -func (c *client) validateToken(ctx context.Context, apiKey string) (*listenBrainzResponse, error) { - r := &listenBrainzRequest{ - ApiKey: apiKey, - } - response, err := c.makeRequest(ctx, http.MethodGet, "validate-token", r) - if err != nil { - return nil, err - } - return response, nil -} - -func (c *client) updateNowPlaying(ctx context.Context, apiKey string, li listenInfo) error { - r := &listenBrainzRequest{ - ApiKey: apiKey, - Body: listenBrainzRequestBody{ - ListenType: PlayingNow, - Payload: []listenInfo{li}, - }, - } - - resp, err := c.makeRequest(ctx, http.MethodPost, "submit-listens", r) - if err != nil { - return err - } - if resp.Status != "ok" { - log.Warn(ctx, "ListenBrainz: NowPlaying was not accepted", "status", resp.Status) - } - return nil -} - -func (c *client) scrobble(ctx context.Context, apiKey string, li listenInfo) error { - r := &listenBrainzRequest{ - ApiKey: apiKey, - Body: listenBrainzRequestBody{ - ListenType: Single, - Payload: []listenInfo{li}, - }, - } - resp, err := c.makeRequest(ctx, http.MethodPost, "submit-listens", r) - if err != nil { - return err - } - if resp.Status != "ok" { - log.Warn(ctx, "ListenBrainz: Scrobble was not accepted", "status", resp.Status) - } - return nil -} - -func (c *client) path(endpoint string) (string, error) { - u, err := url.Parse(c.baseURL) - if err != nil { - return "", err - } - u.Path = path.Join(u.Path, endpoint) - return u.String(), nil -} - -func (c *client) makeRequest(ctx context.Context, method string, endpoint string, r *listenBrainzRequest) (*listenBrainzResponse, error) { - b, _ := json.Marshal(r.Body) - uri, err := c.path(endpoint) - if err != nil { - return nil, err - } - req, _ := http.NewRequestWithContext(ctx, method, uri, bytes.NewBuffer(b)) - req.Header.Add("Content-Type", "application/json; charset=UTF-8") - - if r.ApiKey != "" { - req.Header.Add("Authorization", fmt.Sprintf("Token %s", r.ApiKey)) - } - - log.Trace(ctx, fmt.Sprintf("Sending ListenBrainz %s request", req.Method), "url", req.URL) - resp, err := c.hc.Do(req) - if err != nil { - return nil, err - } - - defer resp.Body.Close() - decoder := json.NewDecoder(resp.Body) - - var response listenBrainzResponse - jsonErr := decoder.Decode(&response) - if resp.StatusCode != 200 && jsonErr != nil { - return nil, fmt.Errorf("ListenBrainz: HTTP Error, Status: (%d)", resp.StatusCode) - } - if jsonErr != nil { - return nil, jsonErr - } - if response.Code != 0 && response.Code != 200 { - return &response, &listenBrainzError{Code: response.Code, Message: response.Error} - } - - return &response, nil -} diff --git a/core/agents/listenbrainz/client_test.go b/core/agents/listenbrainz/client_test.go deleted file mode 100644 index 680a7d185..000000000 --- a/core/agents/listenbrainz/client_test.go +++ /dev/null @@ -1,120 +0,0 @@ -package listenbrainz - -import ( - "bytes" - "context" - "encoding/json" - "io" - "net/http" - "os" - - "github.com/navidrome/navidrome/tests" - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" -) - -var _ = Describe("client", func() { - var httpClient *tests.FakeHttpClient - var client *client - BeforeEach(func() { - httpClient = &tests.FakeHttpClient{} - client = newClient("BASE_URL/", httpClient) - }) - - Describe("listenBrainzResponse", func() { - It("parses a response properly", func() { - var response listenBrainzResponse - err := json.Unmarshal([]byte(`{"code": 200, "message": "Message", "user_name": "UserName", "valid": true, "status": "ok", "error": "Error"}`), &response) - - Expect(err).ToNot(HaveOccurred()) - Expect(response.Code).To(Equal(200)) - Expect(response.Message).To(Equal("Message")) - Expect(response.UserName).To(Equal("UserName")) - Expect(response.Valid).To(BeTrue()) - Expect(response.Status).To(Equal("ok")) - Expect(response.Error).To(Equal("Error")) - }) - }) - - Describe("validateToken", func() { - BeforeEach(func() { - httpClient.Res = http.Response{ - Body: io.NopCloser(bytes.NewBufferString(`{"code": 200, "message": "Token valid.", "user_name": "ListenBrainzUser", "valid": true}`)), - StatusCode: 200, - } - }) - - It("formats the request properly", func() { - _, err := client.validateToken(context.Background(), "LB-TOKEN") - Expect(err).ToNot(HaveOccurred()) - Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) - Expect(httpClient.SavedRequest.URL.String()).To(Equal("BASE_URL/validate-token")) - Expect(httpClient.SavedRequest.Header.Get("Authorization")).To(Equal("Token LB-TOKEN")) - Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) - }) - - It("parses and returns the response", func() { - res, err := client.validateToken(context.Background(), "LB-TOKEN") - Expect(err).ToNot(HaveOccurred()) - Expect(res.Valid).To(Equal(true)) - Expect(res.UserName).To(Equal("ListenBrainzUser")) - }) - }) - - Context("with listenInfo", func() { - var li listenInfo - BeforeEach(func() { - httpClient.Res = http.Response{ - Body: io.NopCloser(bytes.NewBufferString(`{"status": "ok"}`)), - StatusCode: 200, - } - li = listenInfo{ - TrackMetadata: trackMetadata{ - ArtistName: "Track Artist", - TrackName: "Track Title", - ReleaseName: "Track Album", - AdditionalInfo: additionalInfo{ - TrackNumber: 1, - ArtistNames: []string{"Artist 1", "Artist 2"}, - ArtistMBIDs: []string{"mbz-789", "mbz-012"}, - RecordingMBID: "mbz-123", - ReleaseMBID: "mbz-456", - DurationMs: 142200, - }, - }, - } - }) - - Describe("updateNowPlaying", func() { - It("formats the request properly", func() { - Expect(client.updateNowPlaying(context.Background(), "LB-TOKEN", li)).To(Succeed()) - Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodPost)) - Expect(httpClient.SavedRequest.URL.String()).To(Equal("BASE_URL/submit-listens")) - Expect(httpClient.SavedRequest.Header.Get("Authorization")).To(Equal("Token LB-TOKEN")) - Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) - - body, _ := io.ReadAll(httpClient.SavedRequest.Body) - f, _ := os.ReadFile("tests/fixtures/listenbrainz.nowplaying.request.json") - Expect(body).To(MatchJSON(f)) - }) - }) - - Describe("scrobble", func() { - BeforeEach(func() { - li.ListenedAt = 1635000000 - }) - - It("formats the request properly", func() { - Expect(client.scrobble(context.Background(), "LB-TOKEN", li)).To(Succeed()) - Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodPost)) - Expect(httpClient.SavedRequest.URL.String()).To(Equal("BASE_URL/submit-listens")) - Expect(httpClient.SavedRequest.Header.Get("Authorization")).To(Equal("Token LB-TOKEN")) - Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) - - body, _ := io.ReadAll(httpClient.SavedRequest.Body) - f, _ := os.ReadFile("tests/fixtures/listenbrainz.scrobble.request.json") - Expect(body).To(MatchJSON(f)) - }) - }) - }) -}) diff --git a/core/agents/spotify/client.go b/core/agents/spotify/client.go deleted file mode 100644 index 25b1f9ede..000000000 --- a/core/agents/spotify/client.go +++ /dev/null @@ -1,116 +0,0 @@ -package spotify - -import ( - "context" - "encoding/base64" - "encoding/json" - "errors" - "fmt" - "io" - "net/http" - "net/url" - "strconv" - "strings" - - "github.com/navidrome/navidrome/log" -) - -const apiBaseUrl = "https://api.spotify.com/v1/" - -var ( - ErrNotFound = errors.New("spotify: not found") -) - -type httpDoer interface { - Do(req *http.Request) (*http.Response, error) -} - -func newClient(id, secret string, hc httpDoer) *client { - return &client{id, secret, hc} -} - -type client struct { - id string - secret string - hc httpDoer -} - -func (c *client) searchArtists(ctx context.Context, name string, limit int) ([]Artist, error) { - token, err := c.authorize(ctx) - if err != nil { - return nil, err - } - - params := url.Values{} - params.Add("type", "artist") - params.Add("q", name) - params.Add("offset", "0") - params.Add("limit", strconv.Itoa(limit)) - req, _ := http.NewRequestWithContext(ctx, "GET", apiBaseUrl+"search", nil) - req.URL.RawQuery = params.Encode() - req.Header.Add("Authorization", "Bearer "+token) - - var results SearchResults - err = c.makeRequest(req, &results) - if err != nil { - return nil, err - } - - if len(results.Artists.Items) == 0 { - return nil, ErrNotFound - } - return results.Artists.Items, err -} - -func (c *client) authorize(ctx context.Context) (string, error) { - payload := url.Values{} - payload.Add("grant_type", "client_credentials") - - encodePayload := payload.Encode() - req, _ := http.NewRequestWithContext(ctx, "POST", "https://accounts.spotify.com/api/token", strings.NewReader(encodePayload)) - req.Header.Add("Content-Type", "application/x-www-form-urlencoded") - req.Header.Add("Content-Length", strconv.Itoa(len(encodePayload))) - auth := c.id + ":" + c.secret - req.Header.Add("Authorization", "Basic "+base64.StdEncoding.EncodeToString([]byte(auth))) - - response := map[string]interface{}{} - err := c.makeRequest(req, &response) - if err != nil { - return "", err - } - - if v, ok := response["access_token"]; ok { - return v.(string), nil - } - log.Error(ctx, "Invalid spotify response", "resp", response) - return "", errors.New("invalid response") -} - -func (c *client) makeRequest(req *http.Request, response interface{}) error { - log.Trace(req.Context(), fmt.Sprintf("Sending Spotify %s request", req.Method), "url", req.URL) - resp, err := c.hc.Do(req) - if err != nil { - return err - } - - defer resp.Body.Close() - data, err := io.ReadAll(resp.Body) - if err != nil { - return err - } - - if resp.StatusCode != 200 { - return c.parseError(data) - } - - return json.Unmarshal(data, response) -} - -func (c *client) parseError(data []byte) error { - var e Error - err := json.Unmarshal(data, &e) - if err != nil { - return err - } - return fmt.Errorf("spotify error(%s): %s", e.Code, e.Message) -} diff --git a/core/agents/spotify/client_test.go b/core/agents/spotify/client_test.go deleted file mode 100644 index 2782d2122..000000000 --- a/core/agents/spotify/client_test.go +++ /dev/null @@ -1,131 +0,0 @@ -package spotify - -import ( - "bytes" - "context" - "io" - "net/http" - "os" - - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" -) - -var _ = Describe("client", func() { - var httpClient *fakeHttpClient - var client *client - - BeforeEach(func() { - httpClient = &fakeHttpClient{} - client = newClient("SPOTIFY_ID", "SPOTIFY_SECRET", httpClient) - }) - - Describe("ArtistImages", func() { - It("returns artist images from a successful request", func() { - f, _ := os.Open("tests/fixtures/spotify.search.artist.json") - httpClient.mock("https://api.spotify.com/v1/search", http.Response{Body: f, StatusCode: 200}) - httpClient.mock("https://accounts.spotify.com/api/token", http.Response{ - StatusCode: 200, - Body: io.NopCloser(bytes.NewBufferString(`{"access_token": "NEW_ACCESS_TOKEN","token_type": "Bearer","expires_in": 3600}`)), - }) - - artists, err := client.searchArtists(context.TODO(), "U2", 10) - Expect(err).To(BeNil()) - Expect(artists).To(HaveLen(20)) - Expect(artists[0].Popularity).To(Equal(82)) - - images := artists[0].Images - Expect(images).To(HaveLen(3)) - Expect(images[0].Width).To(Equal(640)) - Expect(images[1].Width).To(Equal(320)) - Expect(images[2].Width).To(Equal(160)) - }) - - It("fails if artist was not found", func() { - httpClient.mock("https://api.spotify.com/v1/search", http.Response{ - StatusCode: 200, - Body: io.NopCloser(bytes.NewBufferString(`{ - "artists" : { - "href" : "https://api.spotify.com/v1/search?query=dasdasdas%2Cdna&type=artist&offset=0&limit=20", - "items" : [ ], "limit" : 20, "next" : null, "offset" : 0, "previous" : null, "total" : 0 - }}`)), - }) - httpClient.mock("https://accounts.spotify.com/api/token", http.Response{ - StatusCode: 200, - Body: io.NopCloser(bytes.NewBufferString(`{"access_token": "NEW_ACCESS_TOKEN","token_type": "Bearer","expires_in": 3600}`)), - }) - - _, err := client.searchArtists(context.TODO(), "U2", 10) - Expect(err).To(MatchError(ErrNotFound)) - }) - - It("fails if not able to authorize", func() { - f, _ := os.Open("tests/fixtures/spotify.search.artist.json") - httpClient.mock("https://api.spotify.com/v1/search", http.Response{Body: f, StatusCode: 200}) - httpClient.mock("https://accounts.spotify.com/api/token", http.Response{ - StatusCode: 400, - Body: io.NopCloser(bytes.NewBufferString(`{"error":"invalid_client","error_description":"Invalid client"}`)), - }) - - _, err := client.searchArtists(context.TODO(), "U2", 10) - Expect(err).To(MatchError("spotify error(invalid_client): Invalid client")) - }) - }) - - Describe("authorize", func() { - It("returns an access_token on successful authorization", func() { - httpClient.mock("https://accounts.spotify.com/api/token", http.Response{ - StatusCode: 200, - Body: io.NopCloser(bytes.NewBufferString(`{"access_token": "NEW_ACCESS_TOKEN","token_type": "Bearer","expires_in": 3600}`)), - }) - - token, err := client.authorize(context.TODO()) - Expect(err).To(BeNil()) - Expect(token).To(Equal("NEW_ACCESS_TOKEN")) - auth := httpClient.lastRequest.Header.Get("Authorization") - Expect(auth).To(Equal("Basic U1BPVElGWV9JRDpTUE9USUZZX1NFQ1JFVA==")) - }) - - It("fails on unsuccessful authorization", func() { - httpClient.mock("https://accounts.spotify.com/api/token", http.Response{ - StatusCode: 400, - Body: io.NopCloser(bytes.NewBufferString(`{"error":"invalid_client","error_description":"Invalid client"}`)), - }) - - _, err := client.authorize(context.TODO()) - Expect(err).To(MatchError("spotify error(invalid_client): Invalid client")) - }) - - It("fails on invalid JSON response", func() { - httpClient.mock("https://accounts.spotify.com/api/token", http.Response{ - StatusCode: 200, - Body: io.NopCloser(bytes.NewBufferString(`{NOT_VALID}`)), - }) - - _, err := client.authorize(context.TODO()) - Expect(err).To(MatchError("invalid character 'N' looking for beginning of object key string")) - }) - }) -}) - -type fakeHttpClient struct { - responses map[string]*http.Response - lastRequest *http.Request -} - -func (c *fakeHttpClient) mock(url string, response http.Response) { - if c.responses == nil { - c.responses = make(map[string]*http.Response) - } - c.responses[url] = &response -} - -func (c *fakeHttpClient) Do(req *http.Request) (*http.Response, error) { - c.lastRequest = req - u := req.URL - u.RawQuery = "" - if resp, ok := c.responses[u.String()]; ok { - return resp, nil - } - panic("URL not mocked: " + u.String()) -} diff --git a/core/agents/spotify/responses.go b/core/agents/spotify/responses.go deleted file mode 100644 index 21166bf74..000000000 --- a/core/agents/spotify/responses.go +++ /dev/null @@ -1,30 +0,0 @@ -package spotify - -type SearchResults struct { - Artists ArtistsResult `json:"artists"` -} - -type ArtistsResult struct { - HRef string `json:"href"` - Items []Artist `json:"items"` -} - -type Artist struct { - Genres []string `json:"genres"` - HRef string `json:"href"` - ID string `json:"id"` - Popularity int `json:"popularity"` - Images []Image `json:"images"` - Name string `json:"name"` -} - -type Image struct { - URL string `json:"url"` - Width int `json:"width"` - Height int `json:"height"` -} - -type Error struct { - Code string `json:"error"` - Message string `json:"error_description"` -} diff --git a/core/agents/spotify/responses_test.go b/core/agents/spotify/responses_test.go deleted file mode 100644 index 704119816..000000000 --- a/core/agents/spotify/responses_test.go +++ /dev/null @@ -1,48 +0,0 @@ -package spotify - -import ( - "encoding/json" - "os" - - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" -) - -var _ = Describe("Responses", func() { - Describe("Search type=artist", func() { - It("parses the artist search result correctly ", func() { - var resp SearchResults - body, _ := os.ReadFile("tests/fixtures/spotify.search.artist.json") - err := json.Unmarshal(body, &resp) - Expect(err).To(BeNil()) - - Expect(resp.Artists.Items).To(HaveLen(20)) - u2 := resp.Artists.Items[0] - Expect(u2.Name).To(Equal("U2")) - Expect(u2.Genres).To(ContainElements("irish rock", "permanent wave", "rock")) - Expect(u2.ID).To(Equal("51Blml2LZPmy7TTiAg47vQ")) - Expect(u2.HRef).To(Equal("https://api.spotify.com/v1/artists/51Blml2LZPmy7TTiAg47vQ")) - Expect(u2.Images[0].URL).To(Equal("https://i.scdn.co/image/e22d5c0c8139b8439440a69854ed66efae91112d")) - Expect(u2.Images[0].Width).To(Equal(640)) - Expect(u2.Images[0].Height).To(Equal(640)) - Expect(u2.Images[1].URL).To(Equal("https://i.scdn.co/image/40d6c5c14355cfc127b70da221233315497ec91d")) - Expect(u2.Images[1].Width).To(Equal(320)) - Expect(u2.Images[1].Height).To(Equal(320)) - Expect(u2.Images[2].URL).To(Equal("https://i.scdn.co/image/7293d6752ae8a64e34adee5086858e408185b534")) - Expect(u2.Images[2].Width).To(Equal(160)) - Expect(u2.Images[2].Height).To(Equal(160)) - }) - }) - - Describe("Error", func() { - It("parses the error response correctly", func() { - var errorResp Error - body := []byte(`{"error":"invalid_client","error_description":"Invalid client"}`) - err := json.Unmarshal(body, &errorResp) - Expect(err).To(BeNil()) - - Expect(errorResp.Code).To(Equal("invalid_client")) - Expect(errorResp.Message).To(Equal("Invalid client")) - }) - }) -}) diff --git a/core/agents/spotify/spotify.go b/core/agents/spotify/spotify.go deleted file mode 100644 index 633c32984..000000000 --- a/core/agents/spotify/spotify.go +++ /dev/null @@ -1,96 +0,0 @@ -package spotify - -import ( - "context" - "errors" - "fmt" - "net/http" - "sort" - "strings" - - "github.com/navidrome/navidrome/conf" - "github.com/navidrome/navidrome/consts" - "github.com/navidrome/navidrome/core/agents" - "github.com/navidrome/navidrome/log" - "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/utils/cache" - "github.com/xrash/smetrics" -) - -const spotifyAgentName = "spotify" - -type spotifyAgent struct { - ds model.DataStore - id string - secret string - client *client -} - -func spotifyConstructor(ds model.DataStore) agents.Interface { - if conf.Server.Spotify.ID == "" || conf.Server.Spotify.Secret == "" { - return nil - } - l := &spotifyAgent{ - ds: ds, - id: conf.Server.Spotify.ID, - secret: conf.Server.Spotify.Secret, - } - hc := &http.Client{ - Timeout: consts.DefaultHttpClientTimeOut, - } - chc := cache.NewHTTPClient(hc, consts.DefaultHttpClientTimeOut) - l.client = newClient(l.id, l.secret, chc) - return l -} - -func (s *spotifyAgent) AgentName() string { - return spotifyAgentName -} - -func (s *spotifyAgent) GetArtistImages(ctx context.Context, id, name, mbid string) ([]agents.ExternalImage, error) { - a, err := s.searchArtist(ctx, name) - if err != nil { - if errors.Is(err, model.ErrNotFound) { - log.Warn(ctx, "Artist not found in Spotify", "artist", name) - } else { - log.Error(ctx, "Error calling Spotify", "artist", name, err) - } - return nil, err - } - - var res []agents.ExternalImage - for _, img := range a.Images { - res = append(res, agents.ExternalImage{ - URL: img.URL, - Size: img.Width, - }) - } - return res, nil -} - -func (s *spotifyAgent) searchArtist(ctx context.Context, name string) (*Artist, error) { - artists, err := s.client.searchArtists(ctx, name, 40) - if err != nil || len(artists) == 0 { - return nil, model.ErrNotFound - } - name = strings.ToLower(name) - - // Sort results, prioritizing artists with images, with similar names and with high popularity, in this order - sort.Slice(artists, func(i, j int) bool { - ai := fmt.Sprintf("%-5t-%03d-%04d", len(artists[i].Images) == 0, smetrics.WagnerFischer(name, strings.ToLower(artists[i].Name), 1, 1, 2), 1000-artists[i].Popularity) - aj := fmt.Sprintf("%-5t-%03d-%04d", len(artists[j].Images) == 0, smetrics.WagnerFischer(name, strings.ToLower(artists[j].Name), 1, 1, 2), 1000-artists[j].Popularity) - return ai < aj - }) - - // If the first one has the same name, that's the one - if strings.ToLower(artists[0].Name) != name { - return nil, model.ErrNotFound - } - return &artists[0], err -} - -func init() { - conf.AddHook(func() { - agents.Register(spotifyAgentName, spotifyConstructor) - }) -} diff --git a/core/archiver.go b/core/archiver.go index 63459816e..8305c4f6c 100644 --- a/core/archiver.go +++ b/core/archiver.go @@ -10,6 +10,7 @@ import ( "strings" "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/core/stream" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/utils/slice" @@ -22,13 +23,13 @@ type Archiver interface { ZipPlaylist(ctx context.Context, id string, format string, bitrate int, w io.Writer) error } -func NewArchiver(ms MediaStreamer, ds model.DataStore, shares Share) Archiver { +func NewArchiver(ms stream.MediaStreamer, ds model.DataStore, shares Share) Archiver { return &archiver{ds: ds, ms: ms, shares: shares} } type archiver struct { ds model.DataStore - ms MediaStreamer + ms stream.MediaStreamer shares Share } @@ -176,7 +177,7 @@ func (a *archiver) addFileToZip(ctx context.Context, z *zip.Writer, mf model.Med var r io.ReadCloser if format != "raw" && format != "" { - r, err = a.ms.DoStream(ctx, &mf, format, bitrate, 0) + r, err = a.ms.NewStream(ctx, &mf, stream.Request{Format: format, BitRate: bitrate}) } else { r, err = os.Open(path) } diff --git a/core/archiver_test.go b/core/archiver_test.go index 37c4ef9ab..4f7aed278 100644 --- a/core/archiver_test.go +++ b/core/archiver_test.go @@ -9,6 +9,7 @@ import ( "github.com/Masterminds/squirrel" "github.com/navidrome/navidrome/core" + "github.com/navidrome/navidrome/core/stream" "github.com/navidrome/navidrome/model" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" @@ -44,7 +45,7 @@ var _ = Describe("Archiver", func() { }}).Return(mfs, nil) ds.On("MediaFile", mock.Anything).Return(mfRepo) - ms.On("DoStream", mock.Anything, mock.Anything, "mp3", 128, 0).Return(io.NopCloser(strings.NewReader("test")), nil).Times(3) + ms.On("NewStream", mock.Anything, mock.Anything, stream.Request{Format: "mp3", BitRate: 128}).Return(io.NopCloser(strings.NewReader("test")), nil).Times(3) out := new(bytes.Buffer) err := arch.ZipAlbum(context.Background(), "1", "mp3", 128, out) @@ -73,7 +74,7 @@ var _ = Describe("Archiver", func() { }}).Return(mfs, nil) ds.On("MediaFile", mock.Anything).Return(mfRepo) - ms.On("DoStream", mock.Anything, mock.Anything, "mp3", 128, 0).Return(io.NopCloser(strings.NewReader("test")), nil).Times(2) + ms.On("NewStream", mock.Anything, mock.Anything, stream.Request{Format: "mp3", BitRate: 128}).Return(io.NopCloser(strings.NewReader("test")), nil).Times(2) out := new(bytes.Buffer) err := arch.ZipArtist(context.Background(), "1", "mp3", 128, out) @@ -104,7 +105,7 @@ var _ = Describe("Archiver", func() { } sh.On("Load", mock.Anything, "1").Return(share, nil) - ms.On("DoStream", mock.Anything, mock.Anything, "mp3", 128, 0).Return(io.NopCloser(strings.NewReader("test")), nil).Times(2) + ms.On("NewStream", mock.Anything, mock.Anything, stream.Request{Format: "mp3", BitRate: 128}).Return(io.NopCloser(strings.NewReader("test")), nil).Times(2) out := new(bytes.Buffer) err := arch.ZipShare(context.Background(), "1", out) @@ -136,7 +137,7 @@ var _ = Describe("Archiver", func() { plRepo := &mockPlaylistRepository{} plRepo.On("GetWithTracks", "1", true, false).Return(pls, nil) ds.On("Playlist", mock.Anything).Return(plRepo) - ms.On("DoStream", mock.Anything, mock.Anything, "mp3", 128, 0).Return(io.NopCloser(strings.NewReader("test")), nil).Times(2) + ms.On("NewStream", mock.Anything, mock.Anything, stream.Request{Format: "mp3", BitRate: 128}).Return(io.NopCloser(strings.NewReader("test")), nil).Times(2) out := new(bytes.Buffer) err := arch.ZipPlaylist(context.Background(), "1", "mp3", 128, out) @@ -214,15 +215,15 @@ func (m *mockPlaylistRepository) GetWithTracks(id string, refreshSmartPlaylists, type mockMediaStreamer struct { mock.Mock - core.MediaStreamer + stream.MediaStreamer } -func (m *mockMediaStreamer) DoStream(ctx context.Context, mf *model.MediaFile, reqFormat string, reqBitRate int, reqOffset int) (*core.Stream, error) { - args := m.Called(ctx, mf, reqFormat, reqBitRate, reqOffset) +func (m *mockMediaStreamer) NewStream(ctx context.Context, mf *model.MediaFile, req stream.Request) (*stream.Stream, error) { + args := m.Called(ctx, mf, req) if args.Error(1) != nil { return nil, args.Error(1) } - return &core.Stream{ReadCloser: args.Get(0).(io.ReadCloser)}, nil + return &stream.Stream{ReadCloser: args.Get(0).(io.ReadCloser)}, nil } type mockShare struct { diff --git a/core/artwork/animation.go b/core/artwork/animation.go new file mode 100644 index 000000000..07f493eb4 --- /dev/null +++ b/core/artwork/animation.go @@ -0,0 +1,120 @@ +package artwork + +import ( + "bytes" + "encoding/binary" +) + +// isAnimatedGIF checks for multiple image descriptor blocks (0x2C) in a GIF file. +// Animated GIFs use GIF89a and contain multiple image blocks. +func isAnimatedGIF(data []byte) bool { + // GIF header: "GIF87a" or "GIF89a" + if !bytes.HasPrefix(data, []byte("GIF")) { + return false + } + + // Skip header (6 bytes) + logical screen descriptor (7 bytes) + pos := 13 + if pos >= len(data) { + return false + } + + // Skip Global Color Table if present (bit 7 of packed byte at offset 10) + if len(data) > 10 && data[10]&0x80 != 0 { + // GCT size = 3 * 2^(N+1) where N = bits 0-2 of packed byte + gctSize := 3 * (1 << ((data[10] & 0x07) + 1)) + pos += gctSize + } + + frameCount := 0 + for pos < len(data) { + switch data[pos] { + case 0x2C: // Image Descriptor - marks a frame + frameCount++ + if frameCount > 1 { + return true + } + pos++ // skip introducer + if pos+8 >= len(data) { + return false + } + pos += 8 // skip x, y, w, h (each 2 bytes) + packed := data[pos] + pos++ // skip packed byte + // Skip Local Color Table if present + if packed&0x80 != 0 { + lctSize := 3 * (1 << ((packed & 0x07) + 1)) + pos += lctSize + } + // Skip LZW minimum code size + pos++ + // Skip sub-blocks + pos = skipGIFSubBlocks(data, pos) + case 0x21: // Extension block + pos++ // skip introducer + if pos >= len(data) { + return false + } + pos++ // skip extension label + // Skip sub-blocks + pos = skipGIFSubBlocks(data, pos) + case 0x3B: // Trailer + return false + default: + // Unknown block, bail + return false + } + } + return false +} + +// skipGIFSubBlocks advances past a sequence of GIF sub-blocks (terminated by a zero-length block). +func skipGIFSubBlocks(data []byte, pos int) int { + for pos < len(data) { + blockSize := int(data[pos]) + pos++ // skip size byte + if blockSize == 0 { + break + } + pos += blockSize + } + return pos +} + +// isAnimatedWebP checks for ANMF (animation frame) chunks in a WebP RIFF container. +func isAnimatedWebP(data []byte) bool { + // WebP header: "RIFF" + 4 bytes size + "WEBP" + if !bytes.HasPrefix(data, []byte("RIFF")) || len(data) < 12 { + return false + } + if !bytes.Equal(data[8:12], []byte("WEBP")) { + return false + } + // Scan for ANMF chunk identifier + return bytes.Contains(data[12:], []byte("ANMF")) +} + +// isAnimatedPNG checks for the acTL (animation control) chunk in a PNG file. +// APNG files contain an acTL chunk that is not present in static PNGs. +func isAnimatedPNG(data []byte) bool { + // PNG signature: 8 bytes + pngSig := []byte{0x89, 0x50, 0x4E, 0x47, 0x0D, 0x0A, 0x1A, 0x0A} + if !bytes.HasPrefix(data, pngSig) { + return false + } + + // Scan chunks for "acTL" (animation control) + pos := uint64(8) + dataLen := uint64(len(data)) + for pos+8 <= dataLen { + chunkLen := uint64(binary.BigEndian.Uint32(data[pos : pos+4])) + chunkType := string(data[pos+4 : pos+8]) + + if chunkType == "acTL" { + return true + } + // Move to next chunk: 4 (length) + 4 (type) + chunkLen (data) + 4 (CRC) + pos += 12 + chunkLen + } + return false +} diff --git a/core/artwork/animation_test.go b/core/artwork/animation_test.go new file mode 100644 index 000000000..9000a8511 --- /dev/null +++ b/core/artwork/animation_test.go @@ -0,0 +1,161 @@ +package artwork + +import ( + "bytes" + "encoding/binary" + "image" + "image/color" + "image/gif" + "image/png" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Animation detection", func() { + Describe("isAnimatedGIF", func() { + It("detects an animated GIF with multiple frames", func() { + Expect(isAnimatedGIF(createAnimatedGIF(2))).To(BeTrue()) + }) + + It("detects an animated GIF with many frames", func() { + Expect(isAnimatedGIF(createAnimatedGIF(5))).To(BeTrue()) + }) + + It("does not flag a static GIF (single frame)", func() { + Expect(isAnimatedGIF(createAnimatedGIF(1))).To(BeFalse()) + }) + + It("returns false for non-GIF data", func() { + Expect(isAnimatedGIF(nil)).To(BeFalse()) + Expect(isAnimatedGIF([]byte{0xFF, 0xD8})).To(BeFalse()) + }) + }) + + Describe("isAnimatedWebP", func() { + It("detects an animated WebP with ANMF chunk", func() { + Expect(isAnimatedWebP(createAnimatedWebPBytes())).To(BeTrue()) + }) + + It("does not flag a static WebP (no ANMF chunk)", func() { + Expect(isAnimatedWebP(createStaticWebPBytes())).To(BeFalse()) + }) + + It("returns false for non-WebP data", func() { + Expect(isAnimatedWebP(nil)).To(BeFalse()) + Expect(isAnimatedWebP([]byte{0xFF, 0xD8})).To(BeFalse()) + }) + }) + + Describe("isAnimatedPNG", func() { + It("detects an APNG with acTL chunk", func() { + Expect(isAnimatedPNG(createAPNGBytes())).To(BeTrue()) + }) + + It("does not flag a static PNG (no acTL chunk)", func() { + Expect(isAnimatedPNG(createStaticPNGBytes())).To(BeFalse()) + }) + + It("returns false for non-PNG data", func() { + Expect(isAnimatedPNG(nil)).To(BeFalse()) + Expect(isAnimatedPNG([]byte{0xFF, 0xD8})).To(BeFalse()) + }) + }) +}) + +// createAnimatedGIF creates a minimal animated GIF with the given number of frames. +func createAnimatedGIF(frames int) []byte { + g := &gif.GIF{ + LoopCount: 0, + } + for range frames { + img := image.NewPaletted(image.Rect(0, 0, 2, 2), color.Palette{color.Black, color.White}) + g.Image = append(g.Image, img) + g.Delay = append(g.Delay, 10) + } + var buf bytes.Buffer + err := gif.EncodeAll(&buf, g) + if err != nil { + panic(err) + } + return buf.Bytes() +} + +// writeUint32LE appends a little-endian uint32 to the buffer. +func writeUint32LE(buf *bytes.Buffer, v uint32) { + b := make([]byte, 4) + binary.LittleEndian.PutUint32(b, v) + buf.Write(b) +} + +// writeUint32BE appends a big-endian uint32 to the buffer. +func writeUint32BE(buf *bytes.Buffer, v uint32) { + b := make([]byte, 4) + binary.BigEndian.PutUint32(b, v) + buf.Write(b) +} + +// createAnimatedWebPBytes creates a minimal RIFF/WEBP container with an ANMF chunk. +func createAnimatedWebPBytes() []byte { + var buf bytes.Buffer + buf.WriteString("RIFF") + writeUint32LE(&buf, 100) // file size placeholder + buf.WriteString("WEBP") + // VP8X chunk (extended format, required for animation) + buf.WriteString("VP8X") + writeUint32LE(&buf, 10) + buf.Write(make([]byte, 10)) + // ANIM chunk (animation parameters) + buf.WriteString("ANIM") + writeUint32LE(&buf, 6) + buf.Write(make([]byte, 6)) + // ANMF chunk (animation frame) + buf.WriteString("ANMF") + writeUint32LE(&buf, 16) + buf.Write(make([]byte, 16)) + return buf.Bytes() +} + +// createStaticWebPBytes creates a minimal RIFF/WEBP container without ANMF chunks. +func createStaticWebPBytes() []byte { + var buf bytes.Buffer + buf.WriteString("RIFF") + writeUint32LE(&buf, 20) // file size + buf.WriteString("WEBP") + // VP8 chunk (simple lossy format) + buf.WriteString("VP8 ") + writeUint32LE(&buf, 4) + buf.Write(make([]byte, 4)) + return buf.Bytes() +} + +// createAPNGBytes creates a minimal PNG with an acTL chunk (making it APNG). +func createAPNGBytes() []byte { + // Start with a real PNG + staticPNG := createStaticPNGBytes() + + // Insert an acTL chunk after the IHDR chunk. + // PNG structure: signature (8) + IHDR chunk (4 len + 4 type + 13 data + 4 crc = 25) + ihdrEnd := 8 + 25 + var buf bytes.Buffer + buf.Write(staticPNG[:ihdrEnd]) + // Write acTL chunk: length=8, type="acTL", data=num_frames(4)+num_plays(4), CRC=4 + writeUint32BE(&buf, 8) // chunk data length + buf.WriteString("acTL") + writeUint32BE(&buf, 2) // num_frames + writeUint32BE(&buf, 0) // num_plays (0 = infinite) + writeUint32BE(&buf, 0) // CRC placeholder + buf.Write(staticPNG[ihdrEnd:]) + return buf.Bytes() +} + +// createStaticPNGBytes creates a minimal valid static PNG. +func createStaticPNGBytes() []byte { + img := image.NewRGBA(image.Rect(0, 0, 2, 2)) + var buf bytes.Buffer + err := png.Encode(&buf, img) + if err != nil { + panic(err) + } + return buf.Bytes() +} diff --git a/core/artwork/artwork.go b/core/artwork/artwork.go index 2e92b24c8..b8c395c12 100644 --- a/core/artwork/artwork.go +++ b/core/artwork/artwork.go @@ -122,6 +122,10 @@ func (a *artwork) getArtworkReader(ctx context.Context, artID model.ArtworkID, s artReader, err = newMediafileArtworkReader(ctx, a, artID) case model.KindPlaylistArtwork: artReader, err = newPlaylistArtworkReader(ctx, a, artID) + case model.KindDiscArtwork: + artReader, err = newDiscArtworkReader(ctx, a, artID) + case model.KindRadioArtwork: + artReader, err = newRadioArtworkReader(ctx, a, artID) default: return nil, ErrUnavailable } diff --git a/core/artwork/artwork_internal_test.go b/core/artwork/artwork_internal_test.go index cfb7850bd..4b2359898 100644 --- a/core/artwork/artwork_internal_test.go +++ b/core/artwork/artwork_internal_test.go @@ -7,9 +7,12 @@ import ( "image/jpeg" "image/png" "io" + "os" "path/filepath" + _ "github.com/gen2brain/webp" + "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/conf/configtest" "github.com/navidrome/navidrome/log" @@ -25,7 +28,7 @@ var _ = Describe("Artwork", func() { var ffmpeg *tests.MockFFmpeg var folderRepo *fakeFolderRepo ctx := log.NewContext(context.TODO()) - var alOnlyEmbed, alEmbedNotFound, alOnlyExternal, alExternalNotFound, alMultipleCovers model.Album + var alOnlyEmbed, alEmbedNotFound, alOnlyExternal, alExternalNotFound, alMultipleCovers, alSingleDisc model.Album var arMultipleCovers model.Artist var mfWithEmbed, mfAnotherWithEmbed, mfWithoutEmbed, mfCorruptedCover model.MediaFile @@ -41,8 +44,9 @@ var _ = Describe("Artwork", func() { } alOnlyEmbed = model.Album{ID: "222", Name: "Only embed", EmbedArtPath: "tests/fixtures/artist/an-album/test.mp3", FolderIDs: []string{"f1"}} alEmbedNotFound = model.Album{ID: "333", Name: "Embed not found", EmbedArtPath: "tests/fixtures/NON_EXISTENT.mp3", FolderIDs: []string{"f1"}} - alOnlyExternal = model.Album{ID: "444", Name: "Only external", FolderIDs: []string{"f1"}} + alOnlyExternal = model.Album{ID: "444", Name: "Only external", FolderIDs: []string{"f1"}, Discs: model.Discs{1: "", 2: ""}} alExternalNotFound = model.Album{ID: "555", Name: "External not found", FolderIDs: []string{"f2"}} + alSingleDisc = model.Album{ID: "888", Name: "Single disc", FolderIDs: []string{"f1"}, Discs: model.Discs{1: ""}} arMultipleCovers = model.Artist{ID: "777", Name: "All options"} alMultipleCovers = model.Album{ ID: "666", @@ -190,6 +194,7 @@ var _ = Describe("Artwork", func() { ds.Album(ctx).(*tests.MockAlbumRepo).SetData(model.Albums{ alOnlyEmbed, alOnlyExternal, + alSingleDisc, }) ds.MediaFile(ctx).(*tests.MockMediaFileRepo).SetData(model.MediaFiles{ mfWithEmbed, @@ -233,8 +238,137 @@ var _ = Describe("Artwork", func() { Expect(err).ToNot(HaveOccurred()) Expect(path).To(Equal("al-444_0")) }) + It("falls back to disc cover art when media file has a disc number on a multi-disc album", func() { + mfWithDisc := model.MediaFile{ID: "46", Path: "tests/fixtures/test.ogg", AlbumID: "444", DiscNumber: 2} + Expect(ds.MediaFile(ctx).(*tests.MockMediaFileRepo).Put(&mfWithDisc)).To(Succeed()) + + aw, err := newMediafileArtworkReader(ctx, aw, model.MustParseArtworkID("mf-"+mfWithDisc.ID)) + Expect(err).ToNot(HaveOccurred()) + _, path, err := aw.Reader(ctx) + Expect(err).ToNot(HaveOccurred()) + // Should fall back to disc art, which itself falls back to album art + Expect(path).To(Equal("dc-444:2_0")) + }) + It("falls back to album cover art for single-disc albums even with a disc number", func() { + mfOnSingleDisc := model.MediaFile{ID: "47", Path: "tests/fixtures/test.ogg", AlbumID: "888", DiscNumber: 1} + Expect(ds.MediaFile(ctx).(*tests.MockMediaFileRepo).Put(&mfOnSingleDisc)).To(Succeed()) + + aw, err := newMediafileArtworkReader(ctx, aw, model.MustParseArtworkID("mf-"+mfOnSingleDisc.ID)) + Expect(err).ToNot(HaveOccurred()) + _, path, err := aw.Reader(ctx) + Expect(err).ToNot(HaveOccurred()) + // Single-disc album should skip disc art and go straight to album art + Expect(path).To(Equal("al-888_0")) + }) }) }) + Describe("playlistArtworkReader", func() { + Describe("findPlaylistSidecarPath", func() { + It("discovers sidecar image next to playlist file", func() { + tmpDir := GinkgoT().TempDir() + plsPath := filepath.Join(tmpDir, "MyPlaylist.m3u") + imgPath := filepath.Join(tmpDir, "MyPlaylist.jpg") + Expect(os.WriteFile(plsPath, []byte("#EXTM3U\n"), 0600)).To(Succeed()) + Expect(os.WriteFile(imgPath, []byte("fake image"), 0600)).To(Succeed()) + + result := findPlaylistSidecarPath(GinkgoT().Context(), plsPath) + Expect(result).To(Equal(imgPath)) + }) + + It("returns empty string when no sidecar image exists", func() { + tmpDir := GinkgoT().TempDir() + plsPath := filepath.Join(tmpDir, "MyPlaylist.m3u") + Expect(os.WriteFile(plsPath, []byte("#EXTM3U\n"), 0600)).To(Succeed()) + + result := findPlaylistSidecarPath(GinkgoT().Context(), plsPath) + Expect(result).To(BeEmpty()) + }) + + It("returns empty string when playlist has no path", func() { + result := findPlaylistSidecarPath(GinkgoT().Context(), "") + Expect(result).To(BeEmpty()) + }) + + It("finds sidecar with different case base name", func() { + tmpDir := GinkgoT().TempDir() + plsPath := filepath.Join(tmpDir, "myplaylist.m3u") + imgPath := filepath.Join(tmpDir, "MyPlaylist.jpg") + Expect(os.WriteFile(plsPath, []byte("#EXTM3U\n"), 0600)).To(Succeed()) + Expect(os.WriteFile(imgPath, []byte("fake image"), 0600)).To(Succeed()) + + result := findPlaylistSidecarPath(GinkgoT().Context(), plsPath) + Expect(result).To(Equal(imgPath)) + }) + }) + + Describe("fromPlaylistExternalImage", func() { + It("opens local path from ExternalImageURL", func() { + tmpDir := GinkgoT().TempDir() + imgPath := filepath.Join(tmpDir, "cover.jpg") + Expect(os.WriteFile(imgPath, []byte("external image data"), 0600)).To(Succeed()) + + reader := &playlistArtworkReader{ + pl: model.Playlist{ExternalImageURL: imgPath}, + } + r, path, err := reader.fromPlaylistExternalImage(ctx)() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + Expect(path).To(Equal(imgPath)) + data, _ := io.ReadAll(r) + Expect(string(data)).To(Equal("external image data")) + r.Close() + }) + + It("returns nil when ExternalImageURL is empty", func() { + reader := &playlistArtworkReader{ + pl: model.Playlist{ExternalImageURL: ""}, + } + r, path, err := reader.fromPlaylistExternalImage(ctx)() + Expect(err).ToNot(HaveOccurred()) + Expect(r).To(BeNil()) + Expect(path).To(BeEmpty()) + }) + + It("returns error when local file does not exist", func() { + reader := &playlistArtworkReader{ + pl: model.Playlist{ExternalImageURL: "/non/existent/path/cover.jpg"}, + } + r, _, err := reader.fromPlaylistExternalImage(ctx)() + Expect(err).To(HaveOccurred()) + Expect(r).To(BeNil()) + }) + + It("skips HTTP URL when EnableM3UExternalAlbumArt is false", func() { + conf.Server.EnableM3UExternalAlbumArt = false + + reader := &playlistArtworkReader{ + pl: model.Playlist{ExternalImageURL: "https://example.com/cover.jpg"}, + } + r, path, err := reader.fromPlaylistExternalImage(ctx)() + Expect(err).ToNot(HaveOccurred()) + Expect(r).To(BeNil()) + Expect(path).To(BeEmpty()) + }) + + It("still opens local path when EnableM3UExternalAlbumArt is false", func() { + conf.Server.EnableM3UExternalAlbumArt = false + + tmpDir := GinkgoT().TempDir() + imgPath := filepath.Join(tmpDir, "cover.jpg") + Expect(os.WriteFile(imgPath, []byte("local image"), 0600)).To(Succeed()) + + reader := &playlistArtworkReader{ + pl: model.Playlist{ExternalImageURL: imgPath}, + } + r, path, err := reader.fromPlaylistExternalImage(ctx)() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + Expect(path).To(Equal(imgPath)) + r.Close() + }) + }) + }) + Describe("resizedArtworkReader", func() { BeforeEach(func() { folderRepo.result = []model.Folder{{ @@ -246,24 +380,24 @@ var _ = Describe("Artwork", func() { }) }) When("Square is false", func() { - It("returns a PNG if original image is a PNG", func() { + It("returns WebP even if original image is a PNG", func() { conf.Server.CoverArtPriority = "front.png" r, _, err := aw.Get(context.Background(), alMultipleCovers.CoverArtID(), 15, false) Expect(err).ToNot(HaveOccurred()) img, format, err := image.Decode(r) Expect(err).ToNot(HaveOccurred()) - Expect(format).To(Equal("png")) + Expect(format).To(Equal("webp")) Expect(img.Bounds().Size().X).To(Equal(15)) Expect(img.Bounds().Size().Y).To(Equal(15)) }) - It("returns a JPEG if original image is not a PNG", func() { + It("returns WebP if original image is not a PNG", func() { conf.Server.CoverArtPriority = "cover.jpg" r, _, err := aw.Get(context.Background(), alMultipleCovers.CoverArtID(), 200, false) Expect(err).ToNot(HaveOccurred()) img, format, err := image.Decode(r) - Expect(format).To(Equal("jpeg")) + Expect(format).To(Equal("webp")) Expect(err).ToNot(HaveOccurred()) Expect(img.Bounds().Size().X).To(Equal(200)) Expect(img.Bounds().Size().Y).To(Equal(200)) @@ -273,9 +407,9 @@ var _ = Describe("Artwork", func() { var alCover model.Album DescribeTable("resize", - func(format string, landscape bool, size int) { - coverFileName := "cover." + format - dirName := createImage(format, landscape, size) + func(srcFormat string, expectedFormat string, landscape bool, size int) { + coverFileName := "cover." + srcFormat + dirName := createImage(srcFormat, landscape, size) alCover = model.Album{ ID: "444", Name: "Only external", @@ -292,16 +426,97 @@ var _ = Describe("Artwork", func() { img, format, err := image.Decode(r) Expect(err).ToNot(HaveOccurred()) - Expect(format).To(Equal("png")) + Expect(format).To(Equal(expectedFormat)) Expect(img.Bounds().Size().X).To(Equal(size)) Expect(img.Bounds().Size().Y).To(Equal(size)) }, - Entry("portrait png image", "png", false, 200), - Entry("landscape png image", "png", true, 200), - Entry("portrait jpg image", "jpg", false, 200), - Entry("landscape jpg image", "jpg", true, 200), + Entry("portrait png image", "png", "webp", false, 200), + Entry("landscape png image", "png", "webp", true, 200), + Entry("portrait jpg image", "jpg", "webp", false, 200), + Entry("landscape jpg image", "jpg", "webp", true, 200), ) }) + When("DevJpegCoverArt is true and square is false", func() { + BeforeEach(func() { + conf.Server.DevJpegCoverArt = true + }) + It("returns JPEG even if original image is a PNG", func() { + conf.Server.CoverArtPriority = "front.png" + r, _, err := aw.Get(context.Background(), alMultipleCovers.CoverArtID(), 15, false) + Expect(err).ToNot(HaveOccurred()) + + img, format, err := image.Decode(r) + Expect(err).ToNot(HaveOccurred()) + Expect(format).To(Equal("jpeg")) + Expect(img.Bounds().Size().X).To(Equal(15)) + Expect(img.Bounds().Size().Y).To(Equal(15)) + }) + It("returns JPEG if original image is a JPG", func() { + conf.Server.CoverArtPriority = "cover.jpg" + r, _, err := aw.Get(context.Background(), alMultipleCovers.CoverArtID(), 200, false) + Expect(err).ToNot(HaveOccurred()) + + img, format, err := image.Decode(r) + Expect(err).ToNot(HaveOccurred()) + Expect(format).To(Equal("jpeg")) + Expect(img.Bounds().Size().X).To(Equal(200)) + Expect(img.Bounds().Size().Y).To(Equal(200)) + }) + }) + When("DevJpegCoverArt is true and square is true", func() { + var alCover model.Album + + BeforeEach(func() { + conf.Server.DevJpegCoverArt = true + }) + It("returns PNG for square mode", func() { + dirName := createImage("png", false, 200) + alCover = model.Album{ + ID: "444", + Name: "Only external", + FolderIDs: []string{"tmp"}, + } + folderRepo.result = []model.Folder{{Path: dirName, ImageFiles: []string{"cover.png"}}} + ds.Album(ctx).(*tests.MockAlbumRepo).SetData(model.Albums{alCover}) + + conf.Server.CoverArtPriority = "cover.png" + r, _, err := aw.Get(context.Background(), alCover.CoverArtID(), 200, true) + Expect(err).ToNot(HaveOccurred()) + + img, format, err := image.Decode(r) + Expect(err).ToNot(HaveOccurred()) + Expect(format).To(Equal("png")) + Expect(img.Bounds().Size().X).To(Equal(200)) + Expect(img.Bounds().Size().Y).To(Equal(200)) + }) + }) + When("Requested size is larger than original", func() { + It("clamps size to original dimensions", func() { + conf.Server.CoverArtPriority = "front.png" + // front.png is 16x16, requesting 99999 should return at original size + r, _, err := aw.Get(context.Background(), alMultipleCovers.CoverArtID(), 99999, false) + Expect(err).ToNot(HaveOccurred()) + + img, _, err := image.Decode(r) + Expect(err).ToNot(HaveOccurred()) + // Should be clamped to original size (16), not 99999 + Expect(img.Bounds().Size().X).To(Equal(16)) + Expect(img.Bounds().Size().Y).To(Equal(16)) + }) + + It("clamps square size to original dimensions", func() { + conf.Server.CoverArtPriority = "front.png" + // front.png is 16x16, requesting 99999 with square should return 16x16 square + r, _, err := aw.Get(context.Background(), alMultipleCovers.CoverArtID(), 99999, true) + Expect(err).ToNot(HaveOccurred()) + + img, _, err := image.Decode(r) + Expect(err).ToNot(HaveOccurred()) + // Should be clamped to original size (16), not 99999 + Expect(img.Bounds().Size().X).To(Equal(16)) + Expect(img.Bounds().Size().Y).To(Equal(16)) + }) + }) }) }) diff --git a/core/artwork/benchmark_decode_test.go b/core/artwork/benchmark_decode_test.go new file mode 100644 index 000000000..cfbfe5605 --- /dev/null +++ b/core/artwork/benchmark_decode_test.go @@ -0,0 +1,37 @@ +package artwork + +import ( + "bytes" + "fmt" + "image" + _ "image/jpeg" + _ "image/png" + "testing" +) + +func BenchmarkImageDecode(b *testing.B) { + sizes := []int{300, 1000, 3000} + formats := []struct { + name string + gen func(tb testing.TB, w, h int) []byte + }{ + {"jpeg", func(tb testing.TB, w, h int) []byte { return generateJPEG(tb, w, h, 75) }}, + {"png", func(tb testing.TB, w, h int) []byte { return generatePNG(tb, w, h) }}, + } + + for _, format := range formats { + for _, size := range sizes { + data := format.gen(b, size, size) + b.Run(fmt.Sprintf("%s/%dx%d", format.name, size, size), func(b *testing.B) { + b.SetBytes(int64(len(data))) + b.ResetTimer() + for i := 0; i < b.N; i++ { + _, _, err := image.Decode(bytes.NewReader(data)) + if err != nil { + b.Fatal(err) + } + } + }) + } + } +} diff --git a/core/artwork/benchmark_e2e_test.go b/core/artwork/benchmark_e2e_test.go new file mode 100644 index 000000000..c27964018 --- /dev/null +++ b/core/artwork/benchmark_e2e_test.go @@ -0,0 +1,189 @@ +package artwork + +import ( + "context" + "fmt" + "image/jpeg" + "io" + "os" + "path/filepath" + "runtime" + "sync" + "testing" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + "github.com/navidrome/navidrome/utils/cache" +) + +// setupE2EBenchmark creates an artwork instance with a real album cover image on disk, +// backed by either a real file cache or disabled cache depending on cacheSize. +// Note: This benchmarks artwork.Get() directly (not the full HTTP handler), which covers +// the critical path (source selection, decode, resize, encode, cache). This is a deliberate +// spec deviation — the full HTTP round-trip benchmark requires significant infrastructure +// (DB, scanner, fake filesystem) and can be added later if HTTP overhead proves significant. +// +// Depends on fakeFolderRepo defined in reader_artist_test.go (same package, compiled together). +func setupE2EBenchmark(b *testing.B, cacheSize string) (Artwork, model.ArtworkID, func()) { + b.Helper() + cleanup := configtest.SetupConfig() + b.Cleanup(cleanup) + + tmpDir, err := os.MkdirTemp("", "artwork-bench-*") + if err != nil { + b.Fatal(err) + } + + // Create a realistic cover image on disk + coverPath := filepath.Join(tmpDir, "cover.jpg") + coverImg := generateGradientImage(1000, 1000) + f, err := os.Create(coverPath) + if err != nil { + b.Fatal(err) + } + if err := jpeg.Encode(f, coverImg, &jpeg.Options{Quality: 90}); err != nil { + f.Close() + b.Fatal(err) + } + f.Close() + + // Configure cache + conf.Server.ImageCacheSize = cacheSize + conf.Server.CacheFolder = tmpDir + conf.Server.CoverArtQuality = 75 + conf.Server.CoverArtPriority = "cover.*" + + // Set up mock data store with album pointing to our cover. + // Set UpdatedAt so CoverArtID().LastUpdate is consistent across calls. + album := model.Album{ + ID: "bench-album-1", + Name: "Benchmark Album", + FolderIDs: []string{"f1"}, + UpdatedAt: time.Date(2025, 1, 1, 0, 0, 0, 0, time.UTC), + } + folderRepo := &fakeFolderRepo{ + result: []model.Folder{{ + Path: tmpDir, + ImageFiles: []string{"cover.jpg"}, + }}, + } + ds := &tests.MockDataStore{ + MockedTranscoding: &tests.MockTranscodingRepo{}, + MockedFolder: folderRepo, + } + ds.Album(context.Background()).(*tests.MockAlbumRepo).SetData(model.Albums{album}) + + artID := album.CoverArtID() + + imgCache := cache.NewFileCache("BenchImage", cacheSize, "bench-images", 0, + func(ctx context.Context, arg cache.Item) (io.Reader, error) { + r, _, err := arg.(artworkReader).Reader(ctx) + return r, err + }) + + // Wait for cache init if enabled + if cacheSize != "0" { + for !imgCache.Available(context.Background()) && !imgCache.Disabled(context.Background()) { + runtime.Gosched() // Yield to allow background init goroutine to run + } + } + + ffmpeg := tests.NewMockFFmpeg("fallback content") + aw := NewArtwork(ds, imgCache, ffmpeg, nil) + + cleanupAll := func() { + os.RemoveAll(tmpDir) + } + return aw, artID, cleanupAll +} + +func BenchmarkArtworkGetE2E(b *testing.B) { + cacheConfigs := []struct { + name string + cacheSize string + }{ + {"no_cache", "0"}, + {"with_cache", "100MB"}, + } + sizes := []int{0, 300} + + for _, cc := range cacheConfigs { + for _, size := range sizes { + b.Run(fmt.Sprintf("%s/size_%d", cc.name, size), func(b *testing.B) { + aw, artID, cleanup := setupE2EBenchmark(b, cc.cacheSize) + defer cleanup() + + // Warm the cache on first call if cache is enabled + if cc.cacheSize != "0" { + r, _, err := aw.Get(context.Background(), artID, size, size > 0) + if err != nil { + b.Fatal(err) + } + _, _ = io.ReadAll(r) + r.Close() + } + + b.ResetTimer() + for i := 0; i < b.N; i++ { + r, _, err := aw.Get(context.Background(), artID, size, size > 0) + if err != nil { + b.Fatal(err) + } + _, _ = io.ReadAll(r) + r.Close() + } + }) + } + } +} + +func BenchmarkArtworkGetE2EConcurrent(b *testing.B) { + cacheConfigs := []struct { + name string + cacheSize string + }{ + {"no_cache", "0"}, + {"with_cache", "100MB"}, + } + concurrencyLevels := []int{10, 50} + + for _, cc := range cacheConfigs { + for _, n := range concurrencyLevels { + b.Run(fmt.Sprintf("%s/goroutines_%d", cc.name, n), func(b *testing.B) { + aw, artID, cleanup := setupE2EBenchmark(b, cc.cacheSize) + defer cleanup() + + // Warm cache + if cc.cacheSize != "0" { + r, _, _ := aw.Get(context.Background(), artID, 300, true) + if r != nil { + _, _ = io.ReadAll(r) + r.Close() + } + } + + b.ResetTimer() + for i := 0; i < b.N; i++ { + var wg sync.WaitGroup + wg.Add(n) + for g := 0; g < n; g++ { + go func() { + defer wg.Done() + r, _, err := aw.Get(context.Background(), artID, 300, true) + if err != nil { + b.Error(err) + return + } + _, _ = io.ReadAll(r) + r.Close() + }() + } + wg.Wait() + } + }) + } + } +} diff --git a/core/artwork/benchmark_encode_test.go b/core/artwork/benchmark_encode_test.go new file mode 100644 index 000000000..d8ab858f5 --- /dev/null +++ b/core/artwork/benchmark_encode_test.go @@ -0,0 +1,40 @@ +package artwork + +import ( + "bytes" + "fmt" + "image/jpeg" + "image/png" + "testing" +) + +func BenchmarkImageEncode(b *testing.B) { + img := generateGradientImage(300, 300) + + jpegQualities := []int{60, 75, 90} + for _, q := range jpegQualities { + b.Run(fmt.Sprintf("jpeg/q%d/300x300", q), func(b *testing.B) { + var buf bytes.Buffer + b.ResetTimer() + for i := 0; i < b.N; i++ { + buf.Reset() + if err := jpeg.Encode(&buf, img, &jpeg.Options{Quality: q}); err != nil { + b.Fatal(err) + } + } + b.ReportMetric(float64(buf.Len()), "bytes") + }) + } + + b.Run("png/300x300", func(b *testing.B) { + var buf bytes.Buffer + b.ResetTimer() + for i := 0; i < b.N; i++ { + buf.Reset() + if err := png.Encode(&buf, img); err != nil { + b.Fatal(err) + } + } + b.ReportMetric(float64(buf.Len()), "bytes") + }) +} diff --git a/core/artwork/benchmark_helpers_test.go b/core/artwork/benchmark_helpers_test.go new file mode 100644 index 000000000..60990bb8b --- /dev/null +++ b/core/artwork/benchmark_helpers_test.go @@ -0,0 +1,47 @@ +package artwork + +import ( + "bytes" + "image" + "image/color" + "image/jpeg" + "image/png" + "testing" +) + +// generateJPEG creates a JPEG image of the given dimensions with a gradient pattern. +// The gradient ensures the image has realistic entropy (not trivially compressible). +func generateJPEG(t testing.TB, width, height, quality int) []byte { + t.Helper() + img := generateGradientImage(width, height) + var buf bytes.Buffer + if err := jpeg.Encode(&buf, img, &jpeg.Options{Quality: quality}); err != nil { + t.Fatal(err) + } + return buf.Bytes() +} + +// generatePNG creates a PNG image of the given dimensions with a gradient pattern. +func generatePNG(t testing.TB, width, height int) []byte { + t.Helper() + img := generateGradientImage(width, height) + var buf bytes.Buffer + if err := png.Encode(&buf, img); err != nil { + t.Fatal(err) + } + return buf.Bytes() +} + +// generateGradientImage creates an RGBA image with a diagonal gradient pattern. +func generateGradientImage(width, height int) *image.RGBA { + img := image.NewRGBA(image.Rect(0, 0, width, height)) + for y := 0; y < height; y++ { + for x := 0; x < width; x++ { + r := uint8((x * 255) / width) + g := uint8((y * 255) / height) + b := uint8(((x + y) * 255) / (width + height)) + img.Set(x, y, color.RGBA{R: r, G: g, B: b, A: 255}) + } + } + return img +} diff --git a/core/artwork/benchmark_pipeline_test.go b/core/artwork/benchmark_pipeline_test.go new file mode 100644 index 000000000..23d5954df --- /dev/null +++ b/core/artwork/benchmark_pipeline_test.go @@ -0,0 +1,50 @@ +package artwork + +import ( + "fmt" + "testing" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" +) + +func BenchmarkResizeFullPipeline(b *testing.B) { + cleanup := configtest.SetupConfig() + b.Cleanup(cleanup) + conf.Server.CoverArtQuality = 75 + + sourceSizes := []int{1000, 3000} + targetSize := 300 + + for _, srcSize := range sourceSizes { + jpegData := generateJPEG(b, srcSize, srcSize, 90) + + b.Run(fmt.Sprintf("jpeg/%dx%d_to_%d", srcSize, srcSize, targetSize), func(b *testing.B) { + b.SetBytes(int64(len(jpegData))) + b.ResetTimer() + for i := 0; i < b.N; i++ { + result, _, err := resizeStaticImage(jpegData, targetSize, false) + if err != nil { + b.Fatal(err) + } + if result == nil { + b.Fatal("expected non-nil resized image") + } + } + }) + + b.Run(fmt.Sprintf("jpeg/%dx%d_to_%d_square", srcSize, srcSize, targetSize), func(b *testing.B) { + b.SetBytes(int64(len(jpegData))) + b.ResetTimer() + for i := 0; i < b.N; i++ { + result, _, err := resizeStaticImage(jpegData, targetSize, true) + if err != nil { + b.Fatal(err) + } + if result == nil { + b.Fatal("expected non-nil resized image") + } + } + }) + } +} diff --git a/core/artwork/benchmark_tag_test.go b/core/artwork/benchmark_tag_test.go new file mode 100644 index 000000000..fd649beab --- /dev/null +++ b/core/artwork/benchmark_tag_test.go @@ -0,0 +1,38 @@ +package artwork + +import ( + "path/filepath" + "runtime" + "testing" + + "go.senan.xyz/taglib" +) + +func BenchmarkTagExtraction(b *testing.B) { + // Ensure working directory is the project root (tests.Init not called with -run='^$') + _, file, _, ok := runtime.Caller(0) + if !ok { + b.Fatal("runtime.Caller failed") + } + appPath, _ := filepath.Abs(filepath.Join(filepath.Dir(file), "..", "..")) + + // Use existing test fixture with embedded artwork + testFile := filepath.Join(appPath, "tests/fixtures/artist/an-album/test.mp3") + + b.ResetTimer() + for i := 0; i < b.N; i++ { + f, err := taglib.OpenReadOnly(testFile, taglib.WithReadStyle(taglib.ReadStyleFast)) + if err != nil { + b.Fatal(err) + } + images := f.Properties().Images + if len(images) == 0 { + b.Fatal("no images found in test file") + } + data, err := f.Image(0) + if err != nil || len(data) == 0 { + b.Fatal("failed to extract image data") + } + f.Close() + } +} diff --git a/core/artwork/cache_warmer.go b/core/artwork/cache_warmer.go index 909d299d8..bd1359b74 100644 --- a/core/artwork/cache_warmer.go +++ b/core/artwork/cache_warmer.go @@ -132,7 +132,7 @@ func (a *cacheWarmer) waitSignal(ctx context.Context, timeout time.Duration) { func (a *cacheWarmer) processBatch(ctx context.Context, batch []model.ArtworkID) { log.Trace(ctx, "PreCaching a new batch of artwork", "batchSize", len(batch)) input := pl.FromSlice(ctx, batch) - errs := pl.Sink(ctx, 2, input, a.doCacheImage) + errs := pl.Sink(ctx, 4, input, a.doCacheImage) for err := range errs { log.Debug(ctx, "Error warming cache", err) } @@ -142,13 +142,13 @@ func (a *cacheWarmer) doCacheImage(ctx context.Context, id model.ArtworkID) erro ctx, cancel := context.WithTimeout(ctx, 10*time.Second) defer cancel() - r, _, err := a.artwork.Get(ctx, id, consts.UICoverArtSize, true) - if err != nil { - return fmt.Errorf("caching id='%s': %w", id, err) - } - defer r.Close() - _, err = io.Copy(io.Discard, r) - if err != nil { + for _, size := range consts.CacheWarmerImageSizes { + r, _, err := a.artwork.Get(ctx, id, size, true) + if err != nil { + return fmt.Errorf("caching id='%s', size=%d: %w", id, size, err) + } + _, err = io.Copy(io.Discard, r) + r.Close() return err } return nil diff --git a/core/artwork/cache_warmer_test.go b/core/artwork/cache_warmer_test.go index 4125d6de0..9798ea8d6 100644 --- a/core/artwork/cache_warmer_test.go +++ b/core/artwork/cache_warmer_test.go @@ -6,11 +6,13 @@ import ( "fmt" "io" "strings" + "sync" "sync/atomic" "time" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/consts" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/utils/cache" . "github.com/onsi/ginkgo/v2" @@ -90,6 +92,7 @@ var _ = Describe("CacheWarmer", func() { }) It("deduplicates items in buffer", func() { + fc.SetReady(false) // Make cache unavailable so items stay in buffer cw := NewCacheWarmer(aw, fc).(*cacheWarmer) cw.PreCache(model.MustParseArtworkID("al-1")) cw.PreCache(model.MustParseArtworkID("al-1")) @@ -142,7 +145,7 @@ var _ = Describe("CacheWarmer", func() { It("processes items in batches", func() { cw := NewCacheWarmer(aw, fc).(*cacheWarmer) - for i := 0; i < 5; i++ { + for i := range 5 { cw.PreCache(model.MustParseArtworkID(fmt.Sprintf("al-%d", i))) } @@ -172,20 +175,42 @@ var _ = Describe("CacheWarmer", func() { return len(cw.buffer) }).Should(Equal(0)) }) + + It("pre-caches UICoverArtSize", func() { + cw := NewCacheWarmer(aw, fc).(*cacheWarmer) + cw.PreCache(model.MustParseArtworkID("al-1")) + + Eventually(func() []int { + return aw.getCachedSizes() + }).Should(ContainElements(consts.UICoverArtSize)) + }) }) }) type mockArtwork struct { - err error + err error + mu sync.Mutex + cachedSizes []int } func (m *mockArtwork) Get(ctx context.Context, artID model.ArtworkID, size int, square bool) (io.ReadCloser, time.Time, error) { if m.err != nil { return nil, time.Time{}, m.err } + m.mu.Lock() + m.cachedSizes = append(m.cachedSizes, size) + m.mu.Unlock() return io.NopCloser(strings.NewReader("test")), time.Now(), nil } +func (m *mockArtwork) getCachedSizes() []int { + m.mu.Lock() + defer m.mu.Unlock() + result := make([]int, len(m.cachedSizes)) + copy(result, m.cachedSizes) + return result +} + func (m *mockArtwork) GetOrPlaceholder(ctx context.Context, id string, size int, square bool) (io.ReadCloser, time.Time, error) { return m.Get(ctx, model.ArtworkID{}, size, square) } diff --git a/core/artwork/reader_album.go b/core/artwork/reader_album.go index 55d8b4352..6de1d31d1 100644 --- a/core/artwork/reader_album.go +++ b/core/artwork/reader_album.go @@ -1,8 +1,10 @@ package artwork import ( + "cmp" "context" "crypto/md5" + "errors" "fmt" "io" "path/filepath" @@ -15,7 +17,9 @@ import ( "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/core/external" "github.com/navidrome/navidrome/core/ffmpeg" + "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/utils/natural" ) type albumArtworkReader struct { @@ -55,10 +59,11 @@ func newAlbumArtworkReader(ctx context.Context, artwork *artwork, artID model.Ar } func (a *albumArtworkReader) Key() string { - var hash [16]byte + hashInput := conf.Server.CoverArtPriority if conf.Server.EnableExternalServices { - hash = md5.Sum([]byte(conf.Server.Agents + conf.Server.CoverArtPriority)) + hashInput += conf.Server.Agents } + hash := md5.Sum([]byte(hashInput)) return fmt.Sprintf( "%s.%x.%t", a.cacheKey.Key(), @@ -77,7 +82,7 @@ func (a *albumArtworkReader) Reader(ctx context.Context) (io.ReadCloser, string, func (a *albumArtworkReader) fromCoverArtPriority(ctx context.Context, ffmpeg ffmpeg.FFmpeg, priority string) []sourceFunc { var ff []sourceFunc - for _, pattern := range strings.Split(strings.ToLower(priority), ",") { + for pattern := range strings.SplitSeq(strings.ToLower(priority), ",") { pattern = strings.TrimSpace(pattern) switch { case pattern == "embedded": @@ -101,6 +106,28 @@ func loadAlbumFoldersPaths(ctx context.Context, ds model.DataStore, albums ...mo if err != nil { return nil, nil, nil, err } + + folderIDSet := make(map[string]bool, len(folderIDs)) + for _, id := range folderIDs { + folderIDSet[id] = true + } + + // For multi-disc albums (2+ folders), check if all folders share a common parent + // that is not already included. This finds cover art in the album root folder + // (e.g., "Artist/Album/cover.jpg" when tracks are in "Artist/Album/CD1/" and "Artist/Album/CD2/"). + // We skip single-folder albums to avoid pulling images from the artist folder. + if commonParentID := commonParentFolder(folders, folderIDSet); commonParentID != "" { + parentFolder, err := ds.Folder(ctx).Get(commonParentID) + if errors.Is(err, model.ErrNotFound) { + log.Warn(ctx, "Parent folder not found for album cover art lookup", "parentID", commonParentID) + } else if err != nil { + return nil, nil, nil, err + } + if parentFolder != nil { + folders = append(folders, *parentFolder) + } + } + var paths []string var imgFiles []string var updatedAt time.Time @@ -116,8 +143,48 @@ func loadAlbumFoldersPaths(ctx context.Context, ds model.DataStore, albums ...mo } // Sort image files to ensure consistent selection of cover art - // This prioritizes files from lower-numbered disc folders by sorting the paths - slices.Sort(imgFiles) + // This prioritizes files without numeric suffixes (e.g., cover.jpg over cover.1.jpg) + // by comparing base filenames without extensions + slices.SortFunc(imgFiles, compareImageFiles) return paths, imgFiles, &updatedAt, nil } + +// commonParentFolder returns the shared parent folder ID when all folders have the +// same parent and that parent is not already in folderIDSet. Returns "" otherwise. +func commonParentFolder(folders []model.Folder, folderIDSet map[string]bool) string { + if len(folders) < 2 { + return "" + } + parentID := folders[0].ParentID + if parentID == "" || folderIDSet[parentID] { + return "" + } + for _, f := range folders[1:] { + if f.ParentID != parentID { + return "" + } + } + return parentID +} + +// compareImageFiles compares two image file paths for sorting. +// It extracts the base filename (without extension) and compares case-insensitively. +// This ensures that "cover.jpg" sorts before "cover.1.jpg" since "cover" < "cover.1". +// Note: This function is called O(n log n) times during sorting, but in practice albums +// typically have only 1-20 image files, making the repeated string operations negligible. +func compareImageFiles(a, b string) int { + // Case-insensitive comparison + a = strings.ToLower(a) + b = strings.ToLower(b) + + // Extract base filenames without extensions + baseA := strings.TrimSuffix(filepath.Base(a), filepath.Ext(a)) + baseB := strings.TrimSuffix(filepath.Base(b), filepath.Ext(b)) + + // Compare base names first, then full paths if equal + return cmp.Or( + natural.Compare(baseA, baseB), + natural.Compare(a, b), + ) +} diff --git a/core/artwork/reader_album_test.go b/core/artwork/reader_album_test.go index 2665632b9..a8a0eae3e 100644 --- a/core/artwork/reader_album_test.go +++ b/core/artwork/reader_album_test.go @@ -2,6 +2,7 @@ package artwork import ( "context" + "errors" "path/filepath" "time" @@ -27,26 +28,7 @@ var _ = Describe("Album Artwork Reader", func() { expectedAt = now.Add(5 * time.Minute) // Set up the test folders with image files - repo = &fakeFolderRepo{ - result: []model.Folder{ - { - Path: "Artist/Album/Disc1", - ImagesUpdatedAt: expectedAt, - ImageFiles: []string{"cover.jpg", "back.jpg"}, - }, - { - Path: "Artist/Album/Disc2", - ImagesUpdatedAt: now, - ImageFiles: []string{"cover.jpg"}, - }, - { - Path: "Artist/Album/Disc10", - ImagesUpdatedAt: now, - ImageFiles: []string{"cover.jpg"}, - }, - }, - err: nil, - } + repo = &fakeFolderRepo{} ds = &fakeDataStore{ folderRepo: repo, } @@ -58,19 +40,258 @@ var _ = Describe("Album Artwork Reader", func() { }) It("returns sorted image files", func() { + repo.result = []model.Folder{ + { + Path: "Artist/Album/Disc1", + ImagesUpdatedAt: expectedAt, + ImageFiles: []string{"cover.jpg", "back.jpg", "cover.1.jpg"}, + }, + { + Path: "Artist/Album/Disc2", + ImagesUpdatedAt: now, + ImageFiles: []string{"cover.jpg"}, + }, + { + Path: "Artist/Album/Disc10", + ImagesUpdatedAt: now, + ImageFiles: []string{"cover.jpg"}, + }, + } + _, imgFiles, imagesUpdatedAt, err := loadAlbumFoldersPaths(ctx, ds, album) Expect(err).ToNot(HaveOccurred()) Expect(*imagesUpdatedAt).To(Equal(expectedAt)) - // Check that image files are sorted alphabetically - Expect(imgFiles).To(HaveLen(4)) + // Check that image files are sorted by base name (without extension) + Expect(imgFiles).To(HaveLen(5)) - // The files should be sorted by full path + // Files should be sorted by base filename without extension, then by full path + // "back" < "cover", so back.jpg comes first + // Then all cover.jpg files, sorted by path Expect(imgFiles[0]).To(Equal(filepath.FromSlash("Artist/Album/Disc1/back.jpg"))) Expect(imgFiles[1]).To(Equal(filepath.FromSlash("Artist/Album/Disc1/cover.jpg"))) - Expect(imgFiles[2]).To(Equal(filepath.FromSlash("Artist/Album/Disc10/cover.jpg"))) - Expect(imgFiles[3]).To(Equal(filepath.FromSlash("Artist/Album/Disc2/cover.jpg"))) + Expect(imgFiles[2]).To(Equal(filepath.FromSlash("Artist/Album/Disc2/cover.jpg"))) + Expect(imgFiles[3]).To(Equal(filepath.FromSlash("Artist/Album/Disc10/cover.jpg"))) + Expect(imgFiles[4]).To(Equal(filepath.FromSlash("Artist/Album/Disc1/cover.1.jpg"))) + }) + + It("prioritizes files without numeric suffixes", func() { + // Test case for issue #4683: cover.jpg should come before cover.1.jpg + repo.result = []model.Folder{ + { + Path: "Artist/Album", + ImagesUpdatedAt: now, + ImageFiles: []string{"cover.1.jpg", "cover.jpg", "cover.2.jpg"}, + }, + } + + _, imgFiles, _, err := loadAlbumFoldersPaths(ctx, ds, album) + + Expect(err).ToNot(HaveOccurred()) + Expect(imgFiles).To(HaveLen(3)) + + // cover.jpg should come first because "cover" < "cover.1" < "cover.2" + Expect(imgFiles[0]).To(Equal(filepath.FromSlash("Artist/Album/cover.jpg"))) + Expect(imgFiles[1]).To(Equal(filepath.FromSlash("Artist/Album/cover.1.jpg"))) + Expect(imgFiles[2]).To(Equal(filepath.FromSlash("Artist/Album/cover.2.jpg"))) + }) + + It("handles case-insensitive sorting", func() { + // Test that Cover.jpg and cover.jpg are treated as equivalent + repo.result = []model.Folder{ + { + Path: "Artist/Album", + ImagesUpdatedAt: now, + ImageFiles: []string{"Folder.jpg", "cover.jpg", "BACK.jpg"}, + }, + } + + _, imgFiles, _, err := loadAlbumFoldersPaths(ctx, ds, album) + + Expect(err).ToNot(HaveOccurred()) + Expect(imgFiles).To(HaveLen(3)) + + // Files should be sorted case-insensitively: BACK, cover, Folder + Expect(imgFiles[0]).To(Equal(filepath.FromSlash("Artist/Album/BACK.jpg"))) + Expect(imgFiles[1]).To(Equal(filepath.FromSlash("Artist/Album/cover.jpg"))) + Expect(imgFiles[2]).To(Equal(filepath.FromSlash("Artist/Album/Folder.jpg"))) + }) + + It("includes images from parent folder for multi-disc albums", func() { + // Simulates: Artist/Album/cover.jpg with tracks in Artist/Album/CD1/ and Artist/Album/CD2/ + repo.result = []model.Folder{ + { + ID: "folder1", + Path: "Artist/Album", + Name: "CD1", + ParentID: "parentFolder", + ImagesUpdatedAt: now, + ImageFiles: []string{}, + }, + { + ID: "folder2", + Path: "Artist/Album", + Name: "CD2", + ParentID: "parentFolder", + ImagesUpdatedAt: now, + ImageFiles: []string{}, + }, + } + repo.parentResult = &model.Folder{ + ID: "parentFolder", + Path: "Artist", + Name: "Album", + ImagesUpdatedAt: expectedAt, + ImageFiles: []string{"cover.jpg", "back.jpg"}, + } + + _, imgFiles, imagesUpdatedAt, err := loadAlbumFoldersPaths(ctx, ds, album) + + Expect(err).ToNot(HaveOccurred()) + Expect(*imagesUpdatedAt).To(Equal(expectedAt)) + Expect(imgFiles).To(HaveLen(2)) + Expect(imgFiles[0]).To(Equal(filepath.FromSlash("Artist/Album/back.jpg"))) + Expect(imgFiles[1]).To(Equal(filepath.FromSlash("Artist/Album/cover.jpg"))) + }) + + It("does not query parent when parent ID is already in album folders", func() { + // When the parent folder is already one of the album's folders, skip it + repo.result = []model.Folder{ + { + ID: "folder1", + Path: "Artist", + Name: "Album", + ParentID: "folder2", + ImagesUpdatedAt: now, + ImageFiles: []string{"cover.jpg"}, + }, + { + ID: "folder2", + Path: "", + Name: "Artist", + ImagesUpdatedAt: now, + ImageFiles: []string{}, + }, + } + + _, imgFiles, _, err := loadAlbumFoldersPaths(ctx, ds, album) + + Expect(err).ToNot(HaveOccurred()) + Expect(imgFiles).To(HaveLen(1)) + Expect(imgFiles[0]).To(Equal(filepath.FromSlash("Artist/Album/cover.jpg"))) + // Get should not have been called (parent already in folder set) + Expect(repo.getCallCount).To(Equal(0)) + }) + + It("does not query parent when folders have different parents", func() { + // When album folders span different parents, don't search any parent + repo.result = []model.Folder{ + { + ID: "folder1", + Path: "Artist1/Album", + Name: "part1", + ParentID: "parentA", + ImagesUpdatedAt: now, + ImageFiles: []string{"cover.jpg"}, + }, + { + ID: "folder2", + Path: "Artist2/Album", + Name: "part2", + ParentID: "parentB", + ImagesUpdatedAt: now, + ImageFiles: []string{}, + }, + } + + _, imgFiles, _, err := loadAlbumFoldersPaths(ctx, ds, album) + + Expect(err).ToNot(HaveOccurred()) + Expect(imgFiles).To(HaveLen(1)) + Expect(imgFiles[0]).To(Equal(filepath.FromSlash("Artist1/Album/part1/cover.jpg"))) + // Get should not have been called (different parents) + Expect(repo.getCallCount).To(Equal(0)) + }) + + It("does not query parent for single-folder albums", func() { + // A single-folder album's parent is typically the artist folder, + // which should not be searched for cover art + repo.result = []model.Folder{ + { + ID: "folder1", + Path: "Artist", + Name: "Album", + ParentID: "artistFolder", + ImagesUpdatedAt: now, + ImageFiles: []string{"cover.jpg"}, + }, + } + + _, imgFiles, _, err := loadAlbumFoldersPaths(ctx, ds, album) + + Expect(err).ToNot(HaveOccurred()) + Expect(imgFiles).To(HaveLen(1)) + Expect(imgFiles[0]).To(Equal(filepath.FromSlash("Artist/Album/cover.jpg"))) + // Get should not have been called (single folder, no parent lookup) + Expect(repo.getCallCount).To(Equal(0)) + }) + + It("propagates non-ErrNotFound errors from parent folder lookup", func() { + repo.result = []model.Folder{ + { + ID: "folder1", + Path: "Artist/Album", + Name: "CD1", + ParentID: "parentFolder", + ImagesUpdatedAt: now, + ImageFiles: []string{"cover.jpg"}, + }, + { + ID: "folder2", + Path: "Artist/Album", + Name: "CD2", + ParentID: "parentFolder", + ImagesUpdatedAt: now, + ImageFiles: []string{}, + }, + } + repo.getErr = errors.New("db connection failed") + + _, _, _, err := loadAlbumFoldersPaths(ctx, ds, album) + + Expect(err).To(MatchError("db connection failed")) + Expect(repo.getCallCount).To(Equal(1)) + }) + + It("continues gracefully when parent folder is not found", func() { + // Parent folder may have been deleted; should log a warning and continue + repo.result = []model.Folder{ + { + ID: "folder1", + Path: "Artist/Album", + Name: "CD1", + ParentID: "missingParent", + ImagesUpdatedAt: now, + ImageFiles: []string{"cover.jpg"}, + }, + { + ID: "folder2", + Path: "Artist/Album", + Name: "CD2", + ParentID: "missingParent", + ImagesUpdatedAt: now, + ImageFiles: []string{}, + }, + } + // parentResult is nil, so Get will return ErrNotFound + + _, imgFiles, _, err := loadAlbumFoldersPaths(ctx, ds, album) + + Expect(err).ToNot(HaveOccurred()) + Expect(imgFiles).To(HaveLen(1)) + Expect(imgFiles[0]).To(Equal(filepath.FromSlash("Artist/Album/CD1/cover.jpg"))) + Expect(repo.getCallCount).To(Equal(1)) }) }) }) diff --git a/core/artwork/reader_artist.go b/core/artwork/reader_artist.go index cb029a16e..96ba08b8f 100644 --- a/core/artwork/reader_artist.go +++ b/core/artwork/reader_artist.go @@ -8,6 +8,7 @@ import ( "io/fs" "os" "path/filepath" + "slices" "strings" "time" @@ -28,11 +29,12 @@ const ( type artistReader struct { cacheKey - a *artwork - provider external.Provider - artist model.Artist - artistFolder string - imgFiles []string + a *artwork + provider external.Provider + artist model.Artist + artistFolder string + imgFiles []string + imgFolderImgPath string // cached path from ArtistImageFolder lookup } func newArtistArtworkReader(ctx context.Context, artwork *artwork, artID model.ArtworkID, provider external.Provider) (*artistReader, error) { @@ -70,15 +72,26 @@ func newArtistArtworkReader(ctx context.Context, artwork *artwork, artID model.A //a.cacheKey.lastUpdate = ar.ExternalInfoUpdatedAt a.cacheKey.lastUpdate = *imagesUpdatedAt + if ar.UpdatedAt != nil && ar.UpdatedAt.After(a.cacheKey.lastUpdate) { + a.cacheKey.lastUpdate = *ar.UpdatedAt + } if artistFolderLastUpdate.After(a.cacheKey.lastUpdate) { a.cacheKey.lastUpdate = artistFolderLastUpdate } + if conf.Server.ArtistImageFolder != "" && strings.Contains(strings.ToLower(conf.Server.ArtistArtPriority), "image-folder") { + a.imgFolderImgPath = findImageInArtistFolder(conf.Server.ArtistImageFolder, ar.MbzArtistID, ar.Name) + if a.imgFolderImgPath != "" { + if info, err := os.Stat(a.imgFolderImgPath); err == nil && info.ModTime().After(a.cacheKey.lastUpdate) { + a.cacheKey.lastUpdate = info.ModTime() + } + } + } a.cacheKey.artID = artID return a, nil } func (a *artistReader) Key() string { - hash := md5.Sum([]byte(conf.Server.Agents + conf.Server.Spotify.ID)) + hash := md5.Sum([]byte(conf.Server.Agents)) return fmt.Sprintf( "%s.%t.%x", a.cacheKey.Key(), @@ -92,17 +105,24 @@ func (a *artistReader) LastUpdated() time.Time { } func (a *artistReader) Reader(ctx context.Context) (io.ReadCloser, string, error) { - var ff = a.fromArtistArtPriority(ctx, conf.Server.ArtistArtPriority) + ff := []sourceFunc{a.fromArtistUploadedImage()} + ff = append(ff, a.fromArtistArtPriority(ctx, conf.Server.ArtistArtPriority)...) return selectImageReader(ctx, a.artID, ff...) } +func (a *artistReader) fromArtistUploadedImage() sourceFunc { + return fromLocalFile(a.artist.UploadedImagePath()) +} + func (a *artistReader) fromArtistArtPriority(ctx context.Context, priority string) []sourceFunc { var ff []sourceFunc - for _, pattern := range strings.Split(strings.ToLower(priority), ",") { + for pattern := range strings.SplitSeq(strings.ToLower(priority), ",") { pattern = strings.TrimSpace(pattern) switch { case pattern == "external": ff = append(ff, fromArtistExternalSource(ctx, a.artist, a.provider)) + case pattern == "image-folder": + ff = append(ff, a.fromArtistImageFolder(ctx)) case strings.HasPrefix(pattern, "album/"): ff = append(ff, fromExternalFile(ctx, a.imgFiles, strings.TrimPrefix(pattern, "album/"))) default: @@ -115,7 +135,7 @@ func (a *artistReader) fromArtistArtPriority(ctx context.Context, priority strin func fromArtistFolder(ctx context.Context, artistFolder string, pattern string) sourceFunc { return func() (io.ReadCloser, string, error) { current := artistFolder - for i := 0; i < maxArtistFolderTraversalDepth; i++ { + for range maxArtistFolderTraversalDepth { if reader, path, err := findImageInFolder(ctx, current, pattern); err == nil { return reader, path, nil } @@ -139,11 +159,22 @@ func findImageInFolder(ctx context.Context, folder, pattern string) (io.ReadClos return nil, "", err } + // Filter to valid image files + var imagePaths []string for _, m := range matches { if !model.IsImageFile(m) { continue } - filePath := filepath.Join(folder, m) + imagePaths = append(imagePaths, m) + } + + // Sort image files by prioritizing base filenames without numeric + // suffixes (e.g., artist.jpg before artist.1.jpg) + slices.SortFunc(imagePaths, compareImageFiles) + + // Try to open files in sorted order + for _, p := range imagePaths { + filePath := filepath.Join(folder, p) f, err := os.Open(filePath) if err != nil { log.Warn(ctx, "Could not open cover art file", "file", filePath, err) @@ -184,3 +215,51 @@ func loadArtistFolder(ctx context.Context, ds model.DataStore, albums model.Albu } return folderPath, folders[0].ImagesUpdatedAt, nil } + +func (a *artistReader) fromArtistImageFolder(ctx context.Context) sourceFunc { + return func() (io.ReadCloser, string, error) { + folder := conf.Server.ArtistImageFolder + if folder == "" { + return nil, "", nil + } + // Use cached path from newArtistArtworkReader if available, + // avoiding a second directory scan. + path := a.imgFolderImgPath + if path == "" { + path = findImageInArtistFolder(folder, a.artist.MbzArtistID, a.artist.Name) + } + if path == "" { + return nil, "", fmt.Errorf("no image found for artist %q in %s", a.artist.Name, folder) + } + f, err := os.Open(path) + if err != nil { + return nil, "", err + } + return f, path, nil + } +} + +// findImageInArtistFolder scans a folder for an image file matching the artist's MBID or name +// (case-insensitive). Returns the full path, or empty string if not found. +func findImageInArtistFolder(folder, mbzArtistID, artistName string) string { + entries, err := os.ReadDir(folder) + if err != nil { + return "" + } + for _, candidate := range []string{mbzArtistID, artistName} { + if candidate == "" { + continue + } + for _, entry := range entries { + if entry.IsDir() { + continue + } + name := entry.Name() + base := strings.TrimSuffix(name, filepath.Ext(name)) + if strings.EqualFold(base, candidate) && model.IsImageFile(name) { + return filepath.Join(folder, name) + } + } + } + return "" +} diff --git a/core/artwork/reader_artist_test.go b/core/artwork/reader_artist_test.go index 527b0849f..5e2066aeb 100644 --- a/core/artwork/reader_artist_test.go +++ b/core/artwork/reader_artist_test.go @@ -8,6 +8,8 @@ import ( "path/filepath" "time" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/model" . "github.com/onsi/ginkgo/v2" @@ -240,24 +242,79 @@ var _ = Describe("artistArtworkReader", func() { Expect(os.MkdirAll(artistDir, 0755)).To(Succeed()) // Create multiple matching files - Expect(os.WriteFile(filepath.Join(artistDir, "artist.jpg"), []byte("jpg image"), 0600)).To(Succeed()) + Expect(os.WriteFile(filepath.Join(artistDir, "artist.abc"), []byte("text file"), 0600)).To(Succeed()) Expect(os.WriteFile(filepath.Join(artistDir, "artist.png"), []byte("png image"), 0600)).To(Succeed()) - Expect(os.WriteFile(filepath.Join(artistDir, "artist.txt"), []byte("text file"), 0600)).To(Succeed()) + Expect(os.WriteFile(filepath.Join(artistDir, "artist.jpg"), []byte("jpg image"), 0600)).To(Succeed()) testFunc = fromArtistFolder(ctx, artistDir, "artist.*") }) - It("returns the first valid image file", func() { + It("returns the first valid image file in sorted order", func() { reader, path, err := testFunc() Expect(err).ToNot(HaveOccurred()) Expect(reader).ToNot(BeNil()) - // Should return an image file, not the text file - Expect(path).To(SatisfyAny( - ContainSubstring("artist.jpg"), - ContainSubstring("artist.png"), - )) - Expect(path).ToNot(ContainSubstring("artist.txt")) + // Should return an image file, + // Files are sorted: jpg comes before png alphabetically. + // .abc comes first, but it's not an image. + Expect(path).To(ContainSubstring("artist.jpg")) + reader.Close() + }) + }) + + When("prioritizing files without numeric suffixes", func() { + BeforeEach(func() { + // Test case for issue #4683: artist.jpg should come before artist.1.jpg + artistDir := filepath.Join(tempDir, "artist") + Expect(os.MkdirAll(artistDir, 0755)).To(Succeed()) + + // Create multiple matches with and without numeric suffixes + Expect(os.WriteFile(filepath.Join(artistDir, "artist.1.jpg"), []byte("artist 1"), 0600)).To(Succeed()) + Expect(os.WriteFile(filepath.Join(artistDir, "artist.jpg"), []byte("artist main"), 0600)).To(Succeed()) + Expect(os.WriteFile(filepath.Join(artistDir, "artist.2.jpg"), []byte("artist 2"), 0600)).To(Succeed()) + + testFunc = fromArtistFolder(ctx, artistDir, "artist.*") + }) + + It("returns artist.jpg before artist.1.jpg and artist.2.jpg", func() { + reader, path, err := testFunc() + Expect(err).ToNot(HaveOccurred()) + Expect(reader).ToNot(BeNil()) + Expect(path).To(ContainSubstring("artist.jpg")) + + // Verify it's the main file, not a numbered variant + data, err := io.ReadAll(reader) + Expect(err).ToNot(HaveOccurred()) + Expect(string(data)).To(Equal("artist main")) + reader.Close() + }) + }) + + When("handling case-insensitive sorting", func() { + BeforeEach(func() { + // Test case to ensure case-insensitive natural sorting + artistDir := filepath.Join(tempDir, "artist") + Expect(os.MkdirAll(artistDir, 0755)).To(Succeed()) + + // Create files with mixed case names + Expect(os.WriteFile(filepath.Join(artistDir, "Folder.jpg"), []byte("folder"), 0600)).To(Succeed()) + Expect(os.WriteFile(filepath.Join(artistDir, "artist.jpg"), []byte("artist"), 0600)).To(Succeed()) + Expect(os.WriteFile(filepath.Join(artistDir, "BACK.jpg"), []byte("back"), 0600)).To(Succeed()) + + testFunc = fromArtistFolder(ctx, artistDir, "*.*") + }) + + It("sorts case-insensitively", func() { + reader, path, err := testFunc() + Expect(err).ToNot(HaveOccurred()) + Expect(reader).ToNot(BeNil()) + + // Should return artist.jpg first (case-insensitive: "artist" < "back" < "folder") + Expect(path).To(ContainSubstring("artist.jpg")) + + data, err := io.ReadAll(reader) + Expect(err).ToNot(HaveOccurred()) + Expect(string(data)).To(Equal("artist")) reader.Close() }) }) @@ -358,18 +415,283 @@ var _ = Describe("artistArtworkReader", func() { }) }) }) + + Describe("fromArtistUploadedImage", func() { + var ( + tempDir string + reader *artistReader + ) + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + tempDir = GinkgoT().TempDir() + conf.Server.DataFolder = tempDir + + // Create the artwork/artist directory + Expect(os.MkdirAll(filepath.Join(tempDir, "artwork", "artist"), 0755)).To(Succeed()) + + reader = &artistReader{} + }) + + When("artist has an uploaded image", func() { + It("returns the uploaded image", func() { + imgPath := filepath.Join(tempDir, "artwork", "artist", "ar-1_test.jpg") + Expect(os.WriteFile(imgPath, []byte("uploaded artist image"), 0600)).To(Succeed()) + + reader.artist = model.Artist{ID: "ar-1", UploadedImage: "ar-1_test.jpg"} + sf := reader.fromArtistUploadedImage() + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + Expect(path).To(Equal(imgPath)) + + data, err := io.ReadAll(r) + Expect(err).ToNot(HaveOccurred()) + Expect(string(data)).To(Equal("uploaded artist image")) + r.Close() + }) + }) + + When("artist has no uploaded image", func() { + It("returns nil reader (falls through)", func() { + reader.artist = model.Artist{ID: "ar-1"} + sf := reader.fromArtistUploadedImage() + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).To(BeNil()) + Expect(path).To(BeEmpty()) + }) + }) + }) + + Describe("fromArtistImageFolder", func() { + var ( + ctx context.Context + tempDir string + ar *artistReader + ) + + BeforeEach(func() { + ctx = context.Background() + DeferCleanup(configtest.SetupConfig()) + tempDir = GinkgoT().TempDir() + ar = &artistReader{} + }) + + When("ArtistImageFolder is not configured", func() { + It("returns nil (skips)", func() { + conf.Server.ArtistImageFolder = "" + ar.artist = model.Artist{Name: "Test Artist"} + sf := ar.fromArtistImageFolder(ctx) + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).To(BeNil()) + Expect(path).To(BeEmpty()) + }) + }) + + When("image exists matching MBID", func() { + It("finds the image by MBID", func() { + conf.Server.ArtistImageFolder = tempDir + mbid := "f27ec8db-af05-4f36-916e-3d57f91ecf5e" + imgPath := filepath.Join(tempDir, mbid+".jpg") + Expect(os.WriteFile(imgPath, []byte("mbid image"), 0600)).To(Succeed()) + + ar.artist = model.Artist{Name: "Test Artist", MbzArtistID: mbid} + sf := ar.fromArtistImageFolder(ctx) + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + Expect(path).To(Equal(imgPath)) + + data, err := io.ReadAll(r) + Expect(err).ToNot(HaveOccurred()) + Expect(string(data)).To(Equal("mbid image")) + r.Close() + }) + }) + + When("MBID match is case-insensitive", func() { + It("finds the image regardless of case", func() { + conf.Server.ArtistImageFolder = tempDir + mbid := "F27EC8DB-AF05-4F36-916E-3D57F91ECF5E" + imgPath := filepath.Join(tempDir, "f27ec8db-af05-4f36-916e-3d57f91ecf5e.png") + Expect(os.WriteFile(imgPath, []byte("mbid case image"), 0600)).To(Succeed()) + + ar.artist = model.Artist{Name: "Test Artist", MbzArtistID: mbid} + sf := ar.fromArtistImageFolder(ctx) + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + Expect(path).To(Equal(imgPath)) + r.Close() + }) + }) + + When("no MBID file exists but artist name file does", func() { + It("falls back to artist name match", func() { + conf.Server.ArtistImageFolder = tempDir + imgPath := filepath.Join(tempDir, "Test Artist.jpg") + Expect(os.WriteFile(imgPath, []byte("name image"), 0600)).To(Succeed()) + + ar.artist = model.Artist{Name: "Test Artist", MbzArtistID: "nonexistent-mbid"} + sf := ar.fromArtistImageFolder(ctx) + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + Expect(path).To(Equal(imgPath)) + + data, err := io.ReadAll(r) + Expect(err).ToNot(HaveOccurred()) + Expect(string(data)).To(Equal("name image")) + r.Close() + }) + }) + + When("artist name match is case-insensitive", func() { + It("matches regardless of case", func() { + conf.Server.ArtistImageFolder = tempDir + imgPath := filepath.Join(tempDir, "test artist.jpg") + Expect(os.WriteFile(imgPath, []byte("case insensitive"), 0600)).To(Succeed()) + + ar.artist = model.Artist{Name: "Test Artist"} + sf := ar.fromArtistImageFolder(ctx) + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + Expect(path).To(Equal(imgPath)) + r.Close() + }) + }) + + When("both MBID and name files exist", func() { + It("prefers MBID over name match", func() { + conf.Server.ArtistImageFolder = tempDir + mbid := "f27ec8db-af05-4f36-916e-3d57f91ecf5e" + mbidPath := filepath.Join(tempDir, mbid+".jpg") + namePath := filepath.Join(tempDir, "Test Artist.jpg") + Expect(os.WriteFile(mbidPath, []byte("mbid image"), 0600)).To(Succeed()) + Expect(os.WriteFile(namePath, []byte("name image"), 0600)).To(Succeed()) + + ar.artist = model.Artist{Name: "Test Artist", MbzArtistID: mbid} + sf := ar.fromArtistImageFolder(ctx) + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + Expect(path).To(Equal(mbidPath)) + + data, err := io.ReadAll(r) + Expect(err).ToNot(HaveOccurred()) + Expect(string(data)).To(Equal("mbid image")) + r.Close() + }) + }) + + When("no matching image found", func() { + It("returns an error", func() { + conf.Server.ArtistImageFolder = tempDir + // Create an unrelated file + Expect(os.WriteFile(filepath.Join(tempDir, "other.jpg"), []byte("other"), 0600)).To(Succeed()) + + ar.artist = model.Artist{Name: "Test Artist"} + sf := ar.fromArtistImageFolder(ctx) + r, _, err := sf() + Expect(err).To(HaveOccurred()) + Expect(r).To(BeNil()) + Expect(err.Error()).To(ContainSubstring("no image found")) + }) + }) + + When("cached imgFolderImgPath is set", func() { + It("uses cached path instead of scanning", func() { + conf.Server.ArtistImageFolder = tempDir + imgPath := filepath.Join(tempDir, "cached.jpg") + Expect(os.WriteFile(imgPath, []byte("cached image"), 0600)).To(Succeed()) + + ar.artist = model.Artist{Name: "Test Artist"} + ar.imgFolderImgPath = imgPath + sf := ar.fromArtistImageFolder(ctx) + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + Expect(path).To(Equal(imgPath)) + + data, err := io.ReadAll(r) + Expect(err).ToNot(HaveOccurred()) + Expect(string(data)).To(Equal("cached image")) + r.Close() + }) + }) + }) + + Describe("findImageInArtistFolder", func() { + var tempDir string + + BeforeEach(func() { + tempDir = GinkgoT().TempDir() + }) + + When("matching file exists by MBID", func() { + It("returns the file path", func() { + mbid := "f27ec8db-af05-4f36-916e-3d57f91ecf5e" + imgPath := filepath.Join(tempDir, mbid+".jpg") + Expect(os.WriteFile(imgPath, []byte("image"), 0600)).To(Succeed()) + + path := findImageInArtistFolder(tempDir, mbid, "Test") + Expect(path).To(Equal(imgPath)) + }) + }) + + When("matching file exists by name", func() { + It("returns the file path", func() { + imgPath := filepath.Join(tempDir, "Test Artist.png") + Expect(os.WriteFile(imgPath, []byte("image"), 0600)).To(Succeed()) + + path := findImageInArtistFolder(tempDir, "", "Test Artist") + Expect(path).To(Equal(imgPath)) + }) + }) + + When("no matching file exists", func() { + It("returns empty string", func() { + path := findImageInArtistFolder(tempDir, "", "Unknown Artist") + Expect(path).To(BeEmpty()) + }) + }) + + When("folder does not exist", func() { + It("returns empty string", func() { + path := findImageInArtistFolder("/nonexistent/path", "", "Test") + Expect(path).To(BeEmpty()) + }) + }) + }) }) type fakeFolderRepo struct { model.FolderRepository - result []model.Folder - err error + result []model.Folder + parentResult *model.Folder + getErr error + getCallCount int + err error } func (f *fakeFolderRepo) GetAll(...model.QueryOptions) ([]model.Folder, error) { return f.result, f.err } +func (f *fakeFolderRepo) Get(id string) (*model.Folder, error) { + f.getCallCount++ + if f.getErr != nil { + return nil, f.getErr + } + if f.parentResult != nil { + return f.parentResult, nil + } + return nil, model.ErrNotFound +} + type fakeDataStore struct { model.DataStore folderRepo *fakeFolderRepo diff --git a/core/artwork/reader_disc.go b/core/artwork/reader_disc.go new file mode 100644 index 000000000..7548f76d2 --- /dev/null +++ b/core/artwork/reader_disc.go @@ -0,0 +1,268 @@ +package artwork + +import ( + "context" + "crypto/md5" + "fmt" + "io" + "os" + "path/filepath" + "strconv" + "strings" + "time" + + "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/core" + "github.com/navidrome/navidrome/core/ffmpeg" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" +) + +type discArtworkReader struct { + cacheKey + a *artwork + album model.Album + discNumber int + imgFiles []string + discFolders map[string]bool + isMultiFolder bool + firstTrackPath string + updatedAt *time.Time +} + +func newDiscArtworkReader(ctx context.Context, a *artwork, artID model.ArtworkID) (*discArtworkReader, error) { + albumID, discNumber, err := model.ParseDiscArtworkID(artID.ID) + if err != nil { + return nil, fmt.Errorf("invalid disc artwork id '%s': %w", artID.ID, err) + } + + al, err := a.ds.Album(ctx).Get(albumID) + if err != nil { + return nil, err + } + + _, imgFiles, imagesUpdatedAt, err := loadAlbumFoldersPaths(ctx, a.ds, *al) + if err != nil { + return nil, err + } + + // Query mediafiles for this album + disc to find folder associations and first track + mfs, err := a.ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Sort: "track_number", + Order: "ASC", + Filters: squirrel.Eq{"album_id": albumID, "disc_number": discNumber}, + }) + if err != nil { + return nil, err + } + + // Build disc folder set and find first track + discFolders := make(map[string]bool) + var firstTrackPath string + allFolderIDs := make(map[string]bool) + for _, mf := range mfs { + allFolderIDs[mf.FolderID] = true + if firstTrackPath == "" { + firstTrackPath = mf.Path + } + } + + // Resolve folder IDs to absolute paths + if len(allFolderIDs) > 0 { + folderIDs := make([]string, 0, len(allFolderIDs)) + for id := range allFolderIDs { + folderIDs = append(folderIDs, id) + } + folders, err := a.ds.Folder(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"folder.id": folderIDs}, + }) + if err != nil { + return nil, err + } + for _, f := range folders { + discFolders[f.AbsolutePath()] = true + } + } + + isMultiFolder := len(al.FolderIDs) > 1 + + r := &discArtworkReader{ + a: a, + album: *al, + discNumber: discNumber, + imgFiles: imgFiles, + discFolders: discFolders, + isMultiFolder: isMultiFolder, + firstTrackPath: core.AbsolutePath(ctx, a.ds, al.LibraryID, firstTrackPath), + updatedAt: imagesUpdatedAt, + } + r.cacheKey.artID = artID + if r.updatedAt != nil && r.updatedAt.After(al.UpdatedAt) { + r.cacheKey.lastUpdate = *r.updatedAt + } else { + r.cacheKey.lastUpdate = al.UpdatedAt + } + return r, nil +} + +func (d *discArtworkReader) Key() string { + hash := md5.Sum([]byte(conf.Server.DiscArtPriority)) + return fmt.Sprintf( + "%s.%x", + d.cacheKey.Key(), + hash, + ) +} + +func (d *discArtworkReader) LastUpdated() time.Time { + return d.album.UpdatedAt +} + +func (d *discArtworkReader) Reader(ctx context.Context) (io.ReadCloser, string, error) { + var ff = d.fromDiscArtPriority(ctx, d.a.ffmpeg, conf.Server.DiscArtPriority) + // Fallback to album cover art + albumArtID := model.NewArtworkID(model.KindAlbumArtwork, d.album.ID, &d.album.UpdatedAt) + ff = append(ff, fromAlbum(ctx, d.a, albumArtID)) + return selectImageReader(ctx, d.cacheKey.artID, ff...) +} + +func (d *discArtworkReader) fromDiscArtPriority(ctx context.Context, ffmpeg ffmpeg.FFmpeg, priority string) []sourceFunc { + var ff []sourceFunc + for pattern := range strings.SplitSeq(strings.ToLower(priority), ",") { + pattern = strings.TrimSpace(pattern) + switch { + case pattern == "embedded": + ff = append(ff, fromTag(ctx, d.firstTrackPath), fromFFmpegTag(ctx, ffmpeg, d.firstTrackPath)) + case pattern == "external": + // Not supported for disc art, silently ignore + case pattern == "discsubtitle": + if subtitle := strings.TrimSpace(d.album.Discs[d.discNumber]); subtitle != "" { + ff = append(ff, d.fromDiscSubtitle(ctx, subtitle)) + } + case len(d.imgFiles) > 0: + ff = append(ff, d.fromExternalFile(ctx, pattern)) + } + } + return ff +} + +// fromDiscSubtitle returns a sourceFunc that matches image files whose stem +// (filename without extension) equals the disc subtitle (case-insensitive). +func (d *discArtworkReader) fromDiscSubtitle(ctx context.Context, subtitle string) sourceFunc { + return func() (io.ReadCloser, string, error) { + for _, file := range d.imgFiles { + _, name := filepath.Split(file) + stem := strings.TrimSuffix(name, filepath.Ext(name)) + if !strings.EqualFold(stem, subtitle) { + continue + } + f, err := os.Open(file) + if err != nil { + log.Warn(ctx, "Could not open disc art file", "file", file, err) + continue + } + return f, file, nil + } + return nil, "", fmt.Errorf("disc %d: no image file matching subtitle %q", d.discNumber, subtitle) + } +} + +// extractDiscNumber extracts a disc number from a filename based on a glob pattern. +// It finds the portion of the filename that the wildcard matched and parses leading +// digits as the disc number. Returns (0, false) if the pattern doesn't match or +// no leading digits are found in the wildcard portion. +func extractDiscNumber(pattern, filename string) (int, bool) { + filename = strings.ToLower(filename) + pattern = strings.ToLower(pattern) + + matched, err := filepath.Match(pattern, filename) + if err != nil || !matched { + return 0, false + } + + // Find the prefix before the first '*' in the pattern + starIdx := strings.IndexByte(pattern, '*') + if starIdx < 0 { + return 0, false + } + prefix := pattern[:starIdx] + + // Strip the prefix from the filename to get the wildcard-matched portion + if !strings.HasPrefix(filename, prefix) { + return 0, false + } + remainder := filename[len(prefix):] + + // Extract leading ASCII digits from the remainder + var digits []byte + for _, r := range remainder { + if r >= '0' && r <= '9' { + digits = append(digits, byte(r)) + } else { + break + } + } + + if len(digits) == 0 { + return 0, false + } + + num, err := strconv.Atoi(string(digits)) + if err != nil { + return 0, false + } + return num, true +} + +// fromExternalFile returns a sourceFunc that matches image files against a glob +// pattern with disc-number-aware filtering. +// +// Matching rules: +// - If a disc number can be extracted from the filename, the file matches only if +// the number equals the target disc number. +// - If no number is found and this is a multi-folder album, the file matches if +// it's in a folder containing tracks for this disc. +// - If no number is found and this is a single-folder album, the file is skipped +// (ambiguous). +func (d *discArtworkReader) fromExternalFile(ctx context.Context, pattern string) sourceFunc { + return func() (io.ReadCloser, string, error) { + for _, file := range d.imgFiles { + _, name := filepath.Split(file) + match, err := filepath.Match(pattern, strings.ToLower(name)) + if err != nil { + log.Warn(ctx, "Error matching disc art file to pattern", "pattern", pattern, "file", file) + continue + } + if !match { + continue + } + + // Try to extract disc number from filename + num, hasNum := extractDiscNumber(pattern, name) + if hasNum { + // File has a disc number — must match target disc + if num != d.discNumber { + continue + } + } else if d.isMultiFolder { + // No number, multi-folder: match by folder association + dir := filepath.Dir(file) + if !d.discFolders[dir] { + continue + } + } else { + // No number, single-folder: ambiguous, skip + continue + } + + f, err := os.Open(file) + if err != nil { + log.Warn(ctx, "Could not open disc art file", "file", file, err) + continue + } + return f, file, nil + } + return nil, "", fmt.Errorf("disc %d: pattern '%s' not matched by files", d.discNumber, pattern) + } +} diff --git a/core/artwork/reader_disc_test.go b/core/artwork/reader_disc_test.go new file mode 100644 index 000000000..f8193e24e --- /dev/null +++ b/core/artwork/reader_disc_test.go @@ -0,0 +1,285 @@ +package artwork + +import ( + "context" + "os" + "path/filepath" + + "github.com/navidrome/navidrome/model" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Disc Artwork Reader", func() { + Describe("extractDiscNumber", func() { + DescribeTable("extracts disc number from filename based on glob pattern", + func(pattern, filename string, expectedNum int, expectedOk bool) { + num, ok := extractDiscNumber(pattern, filename) + Expect(ok).To(Equal(expectedOk)) + if expectedOk { + Expect(num).To(Equal(expectedNum)) + } + }, + // Standard disc patterns + Entry("disc1.jpg", "disc*.*", "disc1.jpg", 1, true), + Entry("disc2.png", "disc*.*", "disc2.png", 2, true), + Entry("disc01.jpg", "disc*.*", "disc01.jpg", 1, true), + Entry("disc02.png", "disc*.*", "disc02.png", 2, true), + Entry("disc10.jpg", "disc*.*", "disc10.jpg", 10, true), + + // CD patterns + Entry("cd1.jpg", "cd*.*", "cd1.jpg", 1, true), + Entry("cd02.png", "cd*.*", "cd02.png", 2, true), + + // No number in filename + Entry("disc.jpg has no number", "disc*.*", "disc.jpg", 0, false), + Entry("cd.jpg has no number", "cd*.*", "cd.jpg", 0, false), + + // Extra text after number + Entry("disc2-bonus.jpg", "disc*.*", "disc2-bonus.jpg", 2, true), + Entry("disc01_front.png", "disc*.*", "disc01_front.png", 1, true), + + // Case insensitive (filename already lowered by caller) + Entry("Disc1.jpg lowered", "disc*.*", "disc1.jpg", 1, true), + + // Pattern doesn't match + Entry("cover.jpg doesn't match disc*.*", "disc*.*", "cover.jpg", 0, false), + + // Pattern with no wildcard before dot + Entry("front1.jpg with front*.*", "front*.*", "front1.jpg", 1, true), + ) + }) + + Describe("fromExternalFile", func() { + var ( + ctx context.Context + tmpDir string + ) + + BeforeEach(func() { + ctx = context.Background() + tmpDir = GinkgoT().TempDir() + }) + + createFile := func(path string) string { + fullPath := filepath.Join(tmpDir, filepath.FromSlash(path)) + Expect(os.MkdirAll(filepath.Dir(fullPath), 0755)).To(Succeed()) + Expect(os.WriteFile(fullPath, []byte("image data"), 0600)).To(Succeed()) + return fullPath + } + + It("matches file with disc number in single-folder album", func() { + f1 := createFile("album/disc1.jpg") + f2 := createFile("album/disc2.jpg") + reader := &discArtworkReader{ + discNumber: 1, + imgFiles: []string{f1, f2}, + discFolders: map[string]bool{filepath.Join(tmpDir, "album"): true}, + } + + sf := reader.fromExternalFile(ctx, "disc*.*") + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + r.Close() + Expect(path).To(Equal(f1)) + }) + + It("skips file without number in single-folder album", func() { + f1 := createFile("album/disc.jpg") + reader := &discArtworkReader{ + discNumber: 1, + imgFiles: []string{f1}, + discFolders: map[string]bool{filepath.Join(tmpDir, "album"): true}, + } + + sf := reader.fromExternalFile(ctx, "disc*.*") + r, _, _ := sf() + Expect(r).To(BeNil()) + }) + + It("matches file without number in multi-folder album by folder", func() { + f1 := createFile("album/cd1/disc.jpg") + f2 := createFile("album/cd2/disc.jpg") + reader := &discArtworkReader{ + discNumber: 1, + imgFiles: []string{f1, f2}, + discFolders: map[string]bool{filepath.Join(tmpDir, "album", "cd1"): true}, + isMultiFolder: true, + } + + sf := reader.fromExternalFile(ctx, "disc*.*") + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + r.Close() + Expect(path).To(Equal(f1)) + }) + + It("prefers disc number over folder when number is present", func() { + // disc2.jpg in cd1 folder should match disc 2, not disc 1 + f1 := createFile("album/cd1/disc2.jpg") + reader := &discArtworkReader{ + discNumber: 2, + imgFiles: []string{f1}, + discFolders: map[string]bool{filepath.Join(tmpDir, "album", "cd1"): true}, + isMultiFolder: true, + } + + sf := reader.fromExternalFile(ctx, "disc*.*") + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + r.Close() + Expect(path).To(Equal(f1)) + }) + + It("does not match disc2.jpg when looking for disc 1", func() { + f1 := createFile("album/disc2.jpg") + reader := &discArtworkReader{ + discNumber: 1, + imgFiles: []string{f1}, + discFolders: map[string]bool{filepath.Join(tmpDir, "album"): true}, + } + + sf := reader.fromExternalFile(ctx, "disc*.*") + r, _, _ := sf() + Expect(r).To(BeNil()) + }) + }) + + Describe("fromDiscSubtitle", func() { + var ( + ctx context.Context + tmpDir string + ) + + BeforeEach(func() { + ctx = context.Background() + tmpDir = GinkgoT().TempDir() + }) + + createFile := func(path string) string { + fullPath := filepath.Join(tmpDir, filepath.FromSlash(path)) + Expect(os.MkdirAll(filepath.Dir(fullPath), 0755)).To(Succeed()) + Expect(os.WriteFile(fullPath, []byte("image data"), 0600)).To(Succeed()) + return fullPath + } + + It("matches image file whose stem equals the disc subtitle (case-insensitive)", func() { + f1 := createFile("album/The Blue Disc.jpg") + reader := &discArtworkReader{ + discNumber: 1, + imgFiles: []string{f1}, + } + + sf := reader.fromDiscSubtitle(ctx, "The Blue Disc") + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + r.Close() + Expect(path).To(Equal(f1)) + }) + + It("matches case-insensitively", func() { + f1 := createFile("album/bonus tracks.png") + reader := &discArtworkReader{ + discNumber: 2, + imgFiles: []string{f1}, + } + + sf := reader.fromDiscSubtitle(ctx, "Bonus Tracks") + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + r.Close() + Expect(path).To(Equal(f1)) + }) + + It("returns error when no matching file found", func() { + f1 := createFile("album/cover.jpg") + reader := &discArtworkReader{ + discNumber: 1, + imgFiles: []string{f1}, + } + + sf := reader.fromDiscSubtitle(ctx, "The Blue Disc") + _, _, err := sf() + Expect(err).To(HaveOccurred()) + }) + + It("matches first file when multiple extensions exist", func() { + f1 := createFile("album/The Blue Disc.jpg") + f2 := createFile("album/The Blue Disc.png") + reader := &discArtworkReader{ + discNumber: 1, + imgFiles: []string{f1, f2}, + } + + sf := reader.fromDiscSubtitle(ctx, "The Blue Disc") + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + r.Close() + Expect(path).To(Equal(f1)) + }) + }) + + Describe("discArtworkReader", func() { + Describe("fromDiscArtPriority", func() { + var reader *discArtworkReader + + BeforeEach(func() { + reader = &discArtworkReader{ + discNumber: 2, + isMultiFolder: true, + discFolders: map[string]bool{"/music/album/cd2": true}, + imgFiles: []string{ + "/music/album/cd1/disc.jpg", + "/music/album/cd2/disc.jpg", + "/music/album/cd2/disc2.jpg", + }, + firstTrackPath: "/music/album/cd2/track1.flac", + } + }) + + It("returns source funcs for glob patterns", func() { + ff := reader.fromDiscArtPriority(context.Background(), nil, "disc*.*") + Expect(ff).To(HaveLen(1)) + }) + + It("returns source funcs for embedded pattern", func() { + ff := reader.fromDiscArtPriority(context.Background(), nil, "embedded") + Expect(ff).To(HaveLen(2)) // fromTag + fromFFmpegTag + }) + + It("handles multiple comma-separated patterns", func() { + ff := reader.fromDiscArtPriority(context.Background(), nil, "disc*.*, cd*.*, embedded") + Expect(ff).To(HaveLen(4)) // disc*.* + cd*.* + fromTag + fromFFmpegTag + }) + + It("ignores 'external' pattern silently", func() { + ff := reader.fromDiscArtPriority(context.Background(), nil, "external") + Expect(ff).To(HaveLen(0)) + }) + + It("returns no source funcs when imgFiles is empty and pattern is not embedded", func() { + reader.imgFiles = nil + ff := reader.fromDiscArtPriority(context.Background(), nil, "disc*.*") + Expect(ff).To(HaveLen(0)) + }) + + It("returns source func for discsubtitle pattern", func() { + reader.album = model.Album{Discs: model.Discs{2: "Bonus Tracks"}} + ff := reader.fromDiscArtPriority(context.Background(), nil, "discsubtitle") + Expect(ff).To(HaveLen(1)) + }) + + It("returns no source func for discsubtitle when disc has no subtitle", func() { + reader.album = model.Album{Discs: model.Discs{2: ""}} + ff := reader.fromDiscArtPriority(context.Background(), nil, "discsubtitle") + Expect(ff).To(HaveLen(0)) + }) + }) + }) +}) diff --git a/core/artwork/reader_mediafile.go b/core/artwork/reader_mediafile.go index c72d9543d..cf25c8f5d 100644 --- a/core/artwork/reader_mediafile.go +++ b/core/artwork/reader_mediafile.go @@ -26,16 +26,22 @@ func newMediafileArtworkReader(ctx context.Context, artwork *artwork, artID mode if err != nil { return nil, err } + _, _, imagesUpdatedAt, err := loadAlbumFoldersPaths(ctx, artwork.ds, *al) + if err != nil { + return nil, err + } a := &mediafileArtworkReader{ a: artwork, mediafile: *mf, album: *al, } a.cacheKey.artID = artID - if al.UpdatedAt.After(mf.UpdatedAt) { + a.cacheKey.lastUpdate = mf.UpdatedAt + if al.UpdatedAt.After(a.cacheKey.lastUpdate) { a.cacheKey.lastUpdate = al.UpdatedAt - } else { - a.cacheKey.lastUpdate = mf.UpdatedAt + } + if imagesUpdatedAt != nil && imagesUpdatedAt.After(a.cacheKey.lastUpdate) { + a.cacheKey.lastUpdate = *imagesUpdatedAt } return a, nil } @@ -60,6 +66,12 @@ func (a *mediafileArtworkReader) Reader(ctx context.Context) (io.ReadCloser, str fromFFmpegTag(ctx, a.a.ffmpeg, path), } } - ff = append(ff, fromAlbum(ctx, a.a, a.mediafile.AlbumCoverArtID())) + // For multi-disc albums, fall back to disc artwork first; for single-disc albums, + // skip disc resolution (it would just fall through to album art anyway). + if len(a.album.Discs) > 1 { + ff = append(ff, fromAlbum(ctx, a.a, a.mediafile.DiscCoverArtID())) + } else { + ff = append(ff, fromAlbum(ctx, a.a, a.mediafile.AlbumCoverArtID())) + } return selectImageReader(ctx, a.artID, ff...) } diff --git a/core/artwork/reader_playlist.go b/core/artwork/reader_playlist.go index a9f289ad8..09707843d 100644 --- a/core/artwork/reader_playlist.go +++ b/core/artwork/reader_playlist.go @@ -8,12 +8,17 @@ import ( "image/draw" "image/png" "io" + "net/url" + "os" + "path/filepath" + "strings" "time" - "github.com/disintegration/imaging" + "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/utils/slice" + xdraw "golang.org/x/image/draw" ) type playlistArtworkReader struct { @@ -35,6 +40,24 @@ func newPlaylistArtworkReader(ctx context.Context, artwork *artwork, artID model } a.cacheKey.artID = artID a.cacheKey.lastUpdate = pl.UpdatedAt + + // Check sidecar and ExternalImageURL local file ModTimes for cache invalidation. + // If either is newer than the playlist's UpdatedAt, use that instead so the + // cache is busted when a user replaces a sidecar image or local file reference. + for _, path := range []string{ + findPlaylistSidecarPath(ctx, pl.Path), + pl.ExternalImageURL, + } { + if path == "" || strings.HasPrefix(path, "http://") || strings.HasPrefix(path, "https://") { + continue + } + if info, err := os.Stat(path); err == nil { + if info.ModTime().After(a.cacheKey.lastUpdate) { + a.cacheKey.lastUpdate = info.ModTime() + } + } + } + return a, nil } @@ -43,11 +66,81 @@ func (a *playlistArtworkReader) LastUpdated() time.Time { } func (a *playlistArtworkReader) Reader(ctx context.Context) (io.ReadCloser, string, error) { - ff := []sourceFunc{ + return selectImageReader(ctx, a.artID, + a.fromPlaylistUploadedImage(), + a.fromPlaylistSidecar(ctx), + a.fromPlaylistExternalImage(ctx), a.fromGeneratedTiledCover(ctx), fromAlbumPlaceholder(), + ) +} + +func (a *playlistArtworkReader) fromPlaylistUploadedImage() sourceFunc { + return fromLocalFile(a.pl.UploadedImagePath()) +} + +func (a *playlistArtworkReader) fromPlaylistSidecar(ctx context.Context) sourceFunc { + return fromLocalFile(findPlaylistSidecarPath(ctx, a.pl.Path)) +} + +func (a *playlistArtworkReader) fromPlaylistExternalImage(ctx context.Context) sourceFunc { + return func() (io.ReadCloser, string, error) { + imgURL := a.pl.ExternalImageURL + if imgURL == "" { + return nil, "", nil + } + parsed, err := url.Parse(imgURL) + if err != nil { + return nil, "", err + } + if parsed.Scheme == "http" || parsed.Scheme == "https" { + if !conf.Server.EnableM3UExternalAlbumArt { + return nil, "", nil + } + return fromURL(ctx, parsed) + } + return fromLocalFile(imgURL)() } - return selectImageReader(ctx, a.artID, ff...) +} + +// fromLocalFile returns a sourceFunc that opens the given local path. +// Returns (nil, "", nil) if path is empty — signalling "not found, try next source". +func fromLocalFile(path string) sourceFunc { + return func() (io.ReadCloser, string, error) { + if path == "" { + return nil, "", nil + } + f, err := os.Open(path) + if err != nil { + return nil, "", err + } + return f, path, nil + } +} + +// findPlaylistSidecarPath scans the directory of the playlist file for a sidecar +// image file with the same base name (case-insensitive). Returns empty string if +// no matching image is found or if plsPath is empty. +func findPlaylistSidecarPath(ctx context.Context, plsPath string) string { + if plsPath == "" { + return "" + } + dir := filepath.Dir(plsPath) + base := strings.TrimSuffix(filepath.Base(plsPath), filepath.Ext(plsPath)) + + entries, err := os.ReadDir(dir) + if err != nil { + log.Warn(ctx, "Could not read directory for playlist sidecar", "dir", dir, err) + return "" + } + for _, entry := range entries { + name := entry.Name() + nameBase := strings.TrimSuffix(name, filepath.Ext(name)) + if !entry.IsDir() && strings.EqualFold(nameBase, base) && model.IsImageFile(name) { + return filepath.Join(dir, name) + } + } + return "" } func (a *playlistArtworkReader) fromGeneratedTiledCover(ctx context.Context) sourceFunc { @@ -107,7 +200,7 @@ func (a *playlistArtworkReader) createTile(_ context.Context, r io.ReadCloser) ( if err != nil { return nil, err } - return imaging.Fill(img, tileSize/2, tileSize/2, imaging.Center, imaging.Lanczos), nil + return fillCenter(img, tileSize/2, tileSize/2), nil } func (a *playlistArtworkReader) createTiledImage(_ context.Context, tiles []image.Image) (io.ReadCloser, error) { @@ -145,3 +238,32 @@ func rect(pos int) image.Rectangle { r.Max.Y = r.Min.Y + tileSize/2 return r } + +// fillCenter crops the source image from the center and scales it to fill dstW x dstH exactly, +// equivalent to imaging.Fill with Center anchor. +func fillCenter(src image.Image, dstW, dstH int) image.Image { + srcBounds := src.Bounds() + srcW := srcBounds.Dx() + srcH := srcBounds.Dy() + + // Calculate crop rectangle (center crop to match destination aspect ratio) + srcAspect := float64(srcW) / float64(srcH) + dstAspect := float64(dstW) / float64(dstH) + + var cropRect image.Rectangle + if srcAspect > dstAspect { + // Source is wider — crop horizontally + cropW := int(float64(srcH) * dstAspect) + cropX := (srcW - cropW) / 2 + cropRect = image.Rect(srcBounds.Min.X+cropX, srcBounds.Min.Y, srcBounds.Min.X+cropX+cropW, srcBounds.Max.Y) + } else { + // Source is taller — crop vertically + cropH := int(float64(srcW) / dstAspect) + cropY := (srcH - cropH) / 2 + cropRect = image.Rect(srcBounds.Min.X, srcBounds.Min.Y+cropY, srcBounds.Max.X, srcBounds.Min.Y+cropY+cropH) + } + + dst := image.NewNRGBA(image.Rect(0, 0, dstW, dstH)) + xdraw.CatmullRom.Scale(dst, dst.Bounds(), src, cropRect, draw.Src, nil) + return dst +} diff --git a/core/artwork/reader_radio.go b/core/artwork/reader_radio.go new file mode 100644 index 000000000..22db6e302 --- /dev/null +++ b/core/artwork/reader_radio.go @@ -0,0 +1,40 @@ +package artwork + +import ( + "context" + "io" + "time" + + "github.com/navidrome/navidrome/model" +) + +type radioArtworkReader struct { + cacheKey + a *artwork + radio model.Radio +} + +func newRadioArtworkReader(ctx context.Context, artwork *artwork, artID model.ArtworkID) (*radioArtworkReader, error) { + r, err := artwork.ds.Radio(ctx).Get(artID.ID) + if err != nil { + return nil, err + } + a := &radioArtworkReader{a: artwork, radio: *r} + a.cacheKey.artID = artID + a.cacheKey.lastUpdate = r.UpdatedAt + return a, nil +} + +func (a *radioArtworkReader) LastUpdated() time.Time { + return a.lastUpdate +} + +func (a *radioArtworkReader) Reader(ctx context.Context) (io.ReadCloser, string, error) { + return selectImageReader(ctx, a.artID, + a.fromRadioUploadedImage(), + ) +} + +func (a *radioArtworkReader) fromRadioUploadedImage() sourceFunc { + return fromLocalFile(a.radio.UploadedImagePath()) +} diff --git a/core/artwork/reader_radio_test.go b/core/artwork/reader_radio_test.go new file mode 100644 index 000000000..1f5bc9084 --- /dev/null +++ b/core/artwork/reader_radio_test.go @@ -0,0 +1,84 @@ +package artwork + +import ( + "context" + "os" + "path/filepath" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("radioArtworkReader", func() { + var ( + tempDir string + reader *radioArtworkReader + ) + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + tempDir = GinkgoT().TempDir() + conf.Server.DataFolder = tempDir + + Expect(os.MkdirAll(filepath.Join(tempDir, "artwork", "radio"), 0755)).To(Succeed()) + + reader = &radioArtworkReader{} + }) + + Describe("fromRadioUploadedImage", func() { + When("radio has an uploaded image", func() { + It("returns the uploaded image", func() { + imgPath := filepath.Join(tempDir, "artwork", "radio", "rd-1_test.jpg") + Expect(os.WriteFile(imgPath, []byte("uploaded radio image"), 0600)).To(Succeed()) + + reader.radio = model.Radio{ID: "rd-1", UploadedImage: "rd-1_test.jpg"} + sf := reader.fromRadioUploadedImage() + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + Expect(path).To(Equal(imgPath)) + r.Close() + }) + }) + + When("radio has no uploaded image", func() { + It("returns nil reader (falls through)", func() { + reader.radio = model.Radio{ID: "rd-1"} + sf := reader.fromRadioUploadedImage() + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).To(BeNil()) + Expect(path).To(BeEmpty()) + }) + }) + }) + + Describe("Reader", func() { + When("radio has an uploaded image", func() { + It("returns the image reader", func() { + imgPath := filepath.Join(tempDir, "artwork", "radio", "rd-1_test.jpg") + Expect(os.WriteFile(imgPath, []byte("uploaded radio image"), 0600)).To(Succeed()) + + reader.radio = model.Radio{ID: "rd-1", UploadedImage: "rd-1_test.jpg"} + reader.cacheKey.artID = model.ArtworkID{Kind: model.KindRadioArtwork, ID: "rd-1"} + r, _, err := reader.Reader(context.Background()) + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + r.Close() + }) + }) + + When("radio has no uploaded image", func() { + It("returns ErrUnavailable", func() { + reader.radio = model.Radio{ID: "rd-1"} + reader.cacheKey.artID = model.ArtworkID{Kind: model.KindRadioArtwork, ID: "rd-1"} + r, _, err := reader.Reader(context.Background()) + Expect(err).To(MatchError(ErrUnavailable)) + Expect(r).To(BeNil()) + }) + }) + }) +}) diff --git a/core/artwork/reader_resized.go b/core/artwork/reader_resized.go index 83e6e25c2..72baad434 100644 --- a/core/artwork/reader_resized.go +++ b/core/artwork/reader_resized.go @@ -5,17 +5,26 @@ import ( "context" "fmt" "image" + "image/draw" "image/jpeg" "image/png" "io" + "sync" "time" - "github.com/disintegration/imaging" + "github.com/gen2brain/webp" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" + xdraw "golang.org/x/image/draw" ) +var bufPool = sync.Pool{ + New: func() any { + return new(bytes.Buffer) + }, +} + type resizedArtworkReader struct { artID model.ArtworkID cacheKey string @@ -46,7 +55,7 @@ func (a *resizedArtworkReader) Key() string { if a.square { return baseKey + ".square" } - return fmt.Sprintf("%s.%d", baseKey, conf.Server.CoverJpegQuality) + return fmt.Sprintf("%s.%d", baseKey, conf.Server.CoverArtQuality) } func (a *resizedArtworkReader) LastUpdated() time.Time { @@ -61,7 +70,7 @@ func (a *resizedArtworkReader) Reader(ctx context.Context) (io.ReadCloser, strin } defer orig.Close() - resized, origSize, err := resizeImage(orig, a.size, a.square) + resized, origSize, err := a.resizeImage(ctx, orig) if resized == nil { log.Trace(ctx, "Image smaller than requested size", "artID", a.artID, "original", origSize, "resized", a.size, "square", a.square) } else { @@ -75,11 +84,42 @@ func (a *resizedArtworkReader) Reader(ctx context.Context) (io.ReadCloser, strin orig, _, err = a.a.Get(ctx, a.artID, 0, false) return orig, "", err } + // Preserve ReadCloser semantics if the resized reader already supports Close + // (e.g., ffmpeg pipe), otherwise wrap with NopCloser + if rc, ok := resized.(io.ReadCloser); ok { + return rc, fmt.Sprintf("%s@%d", a.artID, a.size), nil + } return io.NopCloser(resized), fmt.Sprintf("%s@%d", a.artID, a.size), nil } -func resizeImage(reader io.Reader, size int, square bool) (io.Reader, int, error) { - original, format, err := image.Decode(reader) +func (a *resizedArtworkReader) resizeImage(ctx context.Context, reader io.Reader) (io.Reader, int, error) { + data, err := io.ReadAll(reader) + if err != nil { + return nil, 0, fmt.Errorf("reading image data: %w", err) + } + + // Preserve animation for animated images (skip for square thumbnails) + if !a.square { + if isAnimatedGIF(data) { + if a.a.ffmpeg.IsAvailable() { + // Animated GIF: convert to animated WebP via ffmpeg (with optional resize) + r, err := a.a.ffmpeg.ConvertAnimatedImage(ctx, bytes.NewReader(data), a.size, conf.Server.CoverArtQuality) + if err == nil { + return r, 0, nil + } + log.Warn(ctx, "Could not convert animated GIF, falling back to static", err) + } + } else if isAnimatedWebP(data) || isAnimatedPNG(data) { + // Animated WebP/APNG: return original as-is (ffmpeg can't re-encode these) + return bytes.NewReader(data), 0, nil + } + } + + return resizeStaticImage(data, a.size, a.square) +} + +func resizeStaticImage(data []byte, size int, square bool) (io.Reader, int, error) { + original, _, err := image.Decode(bytes.NewReader(data)) if err != nil { return nil, 0, err } @@ -87,30 +127,54 @@ func resizeImage(reader io.Reader, size int, square bool) (io.Reader, int, error bounds := original.Bounds() originalSize := max(bounds.Max.X, bounds.Max.Y) + // Clamp size to original dimensions - upscaling wastes resources and adds no information + if size > originalSize { + size = originalSize + } + if originalSize <= size && !square { return nil, originalSize, nil } - var resized image.Image - if originalSize >= size { - resized = imaging.Fit(original, size, size, imaging.Lanczos) - } else { - if bounds.Max.Y < bounds.Max.X { - resized = imaging.Resize(original, size, 0, imaging.Lanczos) - } else { - resized = imaging.Resize(original, 0, size, imaging.Lanczos) - } - } - if square { - bg := image.NewRGBA(image.Rect(0, 0, size, size)) - resized = imaging.OverlayCenter(bg, resized, 1) - } + // Calculate aspect-fit dimensions + srcW, srcH := bounds.Dx(), bounds.Dy() + scale := float64(size) / float64(max(srcW, srcH)) + dstW := int(float64(srcW) * scale) + dstH := int(float64(srcH) * scale) - buf := new(bytes.Buffer) - if format == "png" || square { - err = png.Encode(buf, resized) + var dst *image.NRGBA + var dstRect image.Rectangle + if square { + // Square canvas with image centered (transparent padding via zero-initialized NRGBA) + dst = image.NewNRGBA(image.Rect(0, 0, size, size)) + offsetX := (size - dstW) / 2 + offsetY := (size - dstH) / 2 + dstRect = image.Rect(offsetX, offsetY, offsetX+dstW, offsetY+dstH) } else { - err = jpeg.Encode(buf, resized, &jpeg.Options{Quality: conf.Server.CoverJpegQuality}) + // Tight-fit canvas + dst = image.NewNRGBA(image.Rect(0, 0, dstW, dstH)) + dstRect = dst.Bounds() } - return buf, originalSize, err + xdraw.CatmullRom.Scale(dst, dstRect, original, bounds, draw.Src, nil) + + buf := bufPool.Get().(*bytes.Buffer) + buf.Reset() + if conf.Server.DevJpegCoverArt { + if square { + err = png.Encode(buf, dst) + } else { + err = jpeg.Encode(buf, dst, &jpeg.Options{Quality: conf.Server.CoverArtQuality}) + } + } else { + err = webp.Encode(buf, dst, webp.Options{Quality: conf.Server.CoverArtQuality}) + } + if err != nil { + bufPool.Put(buf) + return nil, originalSize, err + } + // Copy bytes before returning buffer to pool (pool may reuse the buffer) + encoded := make([]byte, buf.Len()) + copy(encoded, buf.Bytes()) + bufPool.Put(buf) + return bytes.NewReader(encoded), originalSize, nil } diff --git a/core/artwork/reader_resized_test.go b/core/artwork/reader_resized_test.go new file mode 100644 index 000000000..7c9e21c0a --- /dev/null +++ b/core/artwork/reader_resized_test.go @@ -0,0 +1,170 @@ +package artwork + +import ( + "bytes" + "context" + "errors" + "io" + + "github.com/navidrome/navidrome/core/ffmpeg" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("resizeImage", func() { + var mockFF *tests.MockFFmpeg + var r *resizedArtworkReader + + BeforeEach(func() { + mockFF = tests.NewMockFFmpeg("converted-animated-data") + r = &resizedArtworkReader{ + size: 300, + square: false, + a: &artwork{ffmpeg: mockFF}, + } + }) + + Describe("animated GIF handling", func() { + It("converts animated GIF via ffmpeg when available", func() { + data := createAnimatedGIF(3) + result, _, err := r.resizeImage(context.Background(), bytes.NewReader(data)) + Expect(err).ToNot(HaveOccurred()) + Expect(result).ToNot(BeNil()) + + // Should have been processed by ffmpeg (mock returns "converted-animated-data") + output, err := io.ReadAll(result) + Expect(err).ToNot(HaveOccurred()) + Expect(output).To(Equal(data)) // MockFFmpeg echoes input back + }) + + It("falls back to static resize when ffmpeg fails for animated GIF", func() { + mockFF.Error = errors.New("ffmpeg failed") + // Use size smaller than image so static resize actually produces output + r.size = 1 + data := createAnimatedGIF(3) + result, _, err := r.resizeImage(context.Background(), bytes.NewReader(data)) + // Should fall through to static resize successfully (no ffmpeg error propagated) + Expect(err).ToNot(HaveOccurred()) + Expect(result).ToNot(BeNil()) + + // Verify it's a static image (WebP encoded), not the ffmpeg error + output, err := io.ReadAll(result) + Expect(err).ToNot(HaveOccurred()) + Expect(len(output)).To(BeNumerically(">", 0)) + }) + + It("skips animation for square thumbnails even with animated GIF", func() { + r.square = true + data := createAnimatedGIF(3) + result, _, err := r.resizeImage(context.Background(), bytes.NewReader(data)) + // Should fall through to static resize (not ffmpeg conversion) + // The minimal test GIF may or may not resize successfully, + // but ffmpeg should NOT have been called for animated conversion + _ = result + _ = err + // Verify by checking the mock wasn't used for animated conversion: + // If ffmpeg was called, it would return mock data, not static resize result + }) + }) + + Describe("animated WebP handling", func() { + It("returns animated WebP data as-is when not square", func() { + data := createAnimatedWebPBytes() + result, _, err := r.resizeImage(context.Background(), bytes.NewReader(data)) + Expect(err).ToNot(HaveOccurred()) + Expect(result).ToNot(BeNil()) + + // Should return original data unchanged + output, err := io.ReadAll(result) + Expect(err).ToNot(HaveOccurred()) + Expect(output).To(Equal(data)) + }) + + It("does not passthrough animated WebP for square thumbnails", func() { + r.square = true + data := createAnimatedWebPBytes() + // Should fall through to static resize, which will fail on fake WebP data + _, _, err := r.resizeImage(context.Background(), bytes.NewReader(data)) + // Static decode will fail on our minimal test WebP bytes (not a real image) + Expect(err).To(HaveOccurred()) + }) + }) + + Describe("animated PNG handling", func() { + It("returns animated PNG data as-is when not square", func() { + data := createAPNGBytes() + result, _, err := r.resizeImage(context.Background(), bytes.NewReader(data)) + Expect(err).ToNot(HaveOccurred()) + Expect(result).ToNot(BeNil()) + + // Should return original data unchanged + output, err := io.ReadAll(result) + Expect(err).ToNot(HaveOccurred()) + Expect(output).To(Equal(data)) + }) + + It("does not passthrough animated PNG for square thumbnails", func() { + r.square = true + data := createAPNGBytes() + // Should fall through to static resize + result, _, err := r.resizeImage(context.Background(), bytes.NewReader(data)) + // Static PNG decode should succeed on our APNG (it's a valid PNG) + if err == nil { + Expect(result).ToNot(BeNil()) + } + }) + }) + + Describe("static image handling", func() { + It("resizes a static PNG normally", func() { + data := createStaticPNGBytes() + result, _, err := r.resizeImage(context.Background(), bytes.NewReader(data)) + // Static PNG is 2x2, size 300 is larger, so should return nil (no upscale) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(BeNil()) + }) + }) + + Describe("ReadCloser preservation", func() { + It("preserves Close semantics from ffmpeg ReadCloser", func() { + // Create a trackable ReadCloser + tracker := &closeTracker{Reader: bytes.NewReader([]byte("test data"))} + mockFF2 := &mockFFmpegWithCloser{tracker: tracker} + r.a = &artwork{ffmpeg: mockFF2} + + data := createAnimatedGIF(3) + result, _, err := r.resizeImage(context.Background(), bytes.NewReader(data)) + Expect(err).ToNot(HaveOccurred()) + + // The result should be an io.ReadCloser (the tracker) + rc, ok := result.(io.ReadCloser) + Expect(ok).To(BeTrue()) + Expect(rc.Close()).ToNot(HaveOccurred()) + Expect(tracker.closed).To(BeTrue()) + }) + }) +}) + +// closeTracker is an io.ReadCloser that tracks whether Close was called. +type closeTracker struct { + io.Reader + closed bool +} + +func (c *closeTracker) Close() error { + c.closed = true + return nil +} + +// mockFFmpegWithCloser is a minimal FFmpeg mock that returns a specific ReadCloser +// for ConvertAnimatedImage, allowing us to verify Close propagation. +type mockFFmpegWithCloser struct { + ffmpeg.FFmpeg + tracker *closeTracker +} + +func (m *mockFFmpegWithCloser) IsAvailable() bool { return true } +func (m *mockFFmpegWithCloser) ConvertAnimatedImage(_ context.Context, _ io.Reader, _ int, _ int) (io.ReadCloser, error) { + return m.tracker, nil +} diff --git a/core/artwork/sources.go b/core/artwork/sources.go index 4250a373b..0628461e0 100644 --- a/core/artwork/sources.go +++ b/core/artwork/sources.go @@ -15,13 +15,13 @@ import ( "strings" "time" - "github.com/dhowden/tag" "github.com/navidrome/navidrome/consts" "github.com/navidrome/navidrome/core/external" "github.com/navidrome/navidrome/core/ffmpeg" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/resources" + "go.senan.xyz/taglib" ) func selectImageReader(ctx context.Context, artID model.ArtworkID, extractFuncs ...sourceFunc) (io.ReadCloser, string, error) { @@ -88,46 +88,39 @@ func fromTag(ctx context.Context, path string) sourceFunc { if path == "" { return nil, "", nil } - f, err := os.Open(path) + f, err := taglib.OpenReadOnly(path, taglib.WithReadStyle(taglib.ReadStyleFast)) if err != nil { return nil, "", err } defer f.Close() - m, err := tag.ReadFrom(f) - if err != nil { - return nil, "", err - } - - types := m.PictureTypes() - if len(types) == 0 { + images := f.Properties().Images + if len(images) == 0 { return nil, "", fmt.Errorf("no embedded image found in %s", path) } - var picture *tag.Picture - for _, regex := range picTypeRegexes { - for _, t := range types { - if regex.MatchString(t) { - log.Trace(ctx, "Found embedded image", "type", t, "path", path) - picture = m.Pictures(t) - break - } - } - if picture != nil { - break - } - } - if picture == nil { - log.Trace(ctx, "Could not find a front image. Getting the first one", "type", types[0], "path", path) - picture = m.Picture() - } - if picture == nil { + imageIndex := findBestImageIndex(ctx, images, path) + data, err := f.Image(imageIndex) + if err != nil || len(data) == 0 { return nil, "", fmt.Errorf("could not load embedded image from %s", path) } - return io.NopCloser(bytes.NewReader(picture.Data)), path, nil + return io.NopCloser(bytes.NewReader(data)), path, nil } } +func findBestImageIndex(ctx context.Context, images []taglib.ImageDesc, path string) int { + for _, regex := range picTypeRegexes { + for i, img := range images { + if regex.MatchString(img.Type) { + log.Trace(ctx, "Found embedded image", "type", img.Type, "path", path) + return i + } + } + } + log.Trace(ctx, "Could not find a front image. Getting the first one", "type", images[0].Type, "path", path) + return 0 +} + func fromFFmpegTag(ctx context.Context, ffmpeg ffmpeg.FFmpeg, path string) sourceFunc { return func() (io.ReadCloser, string, error) { if path == "" { @@ -182,7 +175,8 @@ func fromAlbumExternalSource(ctx context.Context, al model.Album, provider exter func fromURL(ctx context.Context, imageUrl *url.URL) (io.ReadCloser, string, error) { hc := http.Client{Timeout: 5 * time.Second} req, _ := http.NewRequestWithContext(ctx, http.MethodGet, imageUrl.String(), nil) - resp, err := hc.Do(req) + req.Header.Set("User-Agent", consts.HTTPUserAgent) + resp, err := hc.Do(req) //nolint:gosec if err != nil { return nil, "", err } diff --git a/core/auth/auth.go b/core/auth/auth.go index fd2b670a4..a75111b35 100644 --- a/core/auth/auth.go +++ b/core/auth/auth.go @@ -8,7 +8,7 @@ import ( "time" "github.com/go-chi/jwtauth/v5" - "github.com/lestrrat-go/jwx/v2/jwt" + "github.com/lestrrat-go/jwx/v3/jwt" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/consts" "github.com/navidrome/navidrome/log" @@ -45,42 +45,30 @@ func Init(ds model.DataStore) { }) } -func createBaseClaims() map[string]any { - tokenClaims := map[string]any{} - tokenClaims[jwt.IssuerKey] = consts.JWTIssuer - return tokenClaims -} - -func CreatePublicToken(claims map[string]any) (string, error) { - tokenClaims := createBaseClaims() - for k, v := range claims { - tokenClaims[k] = v - } - _, token, err := TokenAuth.Encode(tokenClaims) - +func CreatePublicToken(claims Claims) (string, error) { + claims.Issuer = consts.JWTIssuer + _, token, err := TokenAuth.Encode(claims.ToMap()) return token, err } -func CreateExpiringPublicToken(exp time.Time, claims map[string]any) (string, error) { - tokenClaims := createBaseClaims() +func CreateExpiringPublicToken(exp time.Time, claims Claims) (string, error) { + claims.Issuer = consts.JWTIssuer if !exp.IsZero() { - tokenClaims[jwt.ExpirationKey] = exp.UTC().Unix() + claims.ExpiresAt = exp } - for k, v := range claims { - tokenClaims[k] = v - } - _, token, err := TokenAuth.Encode(tokenClaims) - + _, token, err := TokenAuth.Encode(claims.ToMap()) return token, err } func CreateToken(u *model.User) (string, error) { - claims := createBaseClaims() - claims[jwt.SubjectKey] = u.UserName - claims[jwt.IssuedAtKey] = time.Now().UTC().Unix() - claims["uid"] = u.ID - claims["adm"] = u.IsAdmin - token, _, err := TokenAuth.Encode(claims) + claims := Claims{ + Issuer: consts.JWTIssuer, + Subject: u.UserName, + IssuedAt: time.Now(), + UserID: u.ID, + IsAdmin: u.IsAdmin, + } + token, _, err := TokenAuth.Encode(claims.ToMap()) if err != nil { return "", err } @@ -89,23 +77,18 @@ func CreateToken(u *model.User) (string, error) { } func TouchToken(token jwt.Token) (string, error) { - claims, err := token.AsMap(context.Background()) - if err != nil { - return "", err - } - - claims[jwt.ExpirationKey] = time.Now().UTC().Add(conf.Server.SessionTimeout).Unix() - _, newToken, err := TokenAuth.Encode(claims) - + claims := ClaimsFromToken(token). + WithExpiresAt(time.Now().UTC().Add(conf.Server.SessionTimeout)) + _, newToken, err := TokenAuth.Encode(claims.ToMap()) return newToken, err } -func Validate(tokenStr string) (map[string]interface{}, error) { +func Validate(tokenStr string) (Claims, error) { token, err := jwtauth.VerifyToken(TokenAuth, tokenStr) if err != nil { - return nil, err + return Claims{}, err } - return token.AsMap(context.Background()) + return ClaimsFromToken(token), nil } func WithAdminUser(ctx context.Context, ds model.DataStore) context.Context { @@ -113,9 +96,9 @@ func WithAdminUser(ctx context.Context, ds model.DataStore) context.Context { if err != nil { c, err := ds.User(ctx).CountAll() if c == 0 && err == nil { - log.Debug(ctx, "Scanner: No admin user yet!", err) + log.Debug(ctx, "No admin user yet!", err) } else { - log.Error(ctx, "Scanner: No admin user found!", err) + log.Error(ctx, "No admin user found!", err) } u = &model.User{} } @@ -137,6 +120,19 @@ func createNewSecret(ctx context.Context, ds model.DataStore) string { return secret } +// EncodeToken creates a signed JWT from an arbitrary claims map. +// It sets the issuer claim automatically. +func EncodeToken(claims map[string]any) (string, error) { + claims[jwt.IssuerKey] = consts.JWTIssuer + _, token, err := TokenAuth.Encode(claims) + return token, err +} + +// DecodeAndVerifyToken verifies a JWT string and returns the parsed token. +func DecodeAndVerifyToken(tokenStr string) (jwt.Token, error) { + return jwtauth.VerifyToken(TokenAuth, tokenStr) +} + func getEncKey() []byte { key := cmp.Or( conf.Server.PasswordEncryptionKey, diff --git a/core/auth/auth_test.go b/core/auth/auth_test.go index 504e56a52..761dd205c 100644 --- a/core/auth/auth_test.go +++ b/core/auth/auth_test.go @@ -45,7 +45,7 @@ var _ = Describe("Auth", func() { }) It("returns the claims from a valid JWT token", func() { - claims := map[string]interface{}{} + claims := map[string]any{} claims["iss"] = "issuer" claims["iat"] = time.Now().Unix() claims["exp"] = time.Now().Add(1 * time.Minute).Unix() @@ -54,11 +54,11 @@ var _ = Describe("Auth", func() { decodedClaims, err := auth.Validate(tokenStr) Expect(err).NotTo(HaveOccurred()) - Expect(decodedClaims["iss"]).To(Equal("issuer")) + Expect(decodedClaims.Issuer).To(Equal("issuer")) }) It("returns ErrExpired if the `exp` field is in the past", func() { - claims := map[string]interface{}{} + claims := map[string]any{} claims["iss"] = "issuer" claims["exp"] = time.Now().Add(-1 * time.Minute).Unix() _, tokenStr, err := auth.TokenAuth.Encode(claims) @@ -82,18 +82,18 @@ var _ = Describe("Auth", func() { claims, err := auth.Validate(tokenStr) Expect(err).NotTo(HaveOccurred()) - Expect(claims["iss"]).To(Equal(consts.JWTIssuer)) - Expect(claims["sub"]).To(Equal("johndoe")) - Expect(claims["uid"]).To(Equal("123")) - Expect(claims["adm"]).To(Equal(true)) - Expect(claims["exp"]).To(BeTemporally(">", time.Now())) + Expect(claims.Issuer).To(Equal(consts.JWTIssuer)) + Expect(claims.Subject).To(Equal("johndoe")) + Expect(claims.UserID).To(Equal("123")) + Expect(claims.IsAdmin).To(Equal(true)) + Expect(claims.ExpiresAt).To(BeTemporally(">", time.Now())) }) }) Describe("TouchToken", func() { It("updates the expiration time", func() { yesterday := time.Now().Add(-oneDay) - claims := map[string]interface{}{} + claims := map[string]any{} claims["iss"] = "issuer" claims["exp"] = yesterday.Unix() token, _, err := auth.TokenAuth.Encode(claims) @@ -104,8 +104,7 @@ var _ = Describe("Auth", func() { decodedClaims, err := auth.Validate(touched) Expect(err).NotTo(HaveOccurred()) - exp := decodedClaims["exp"].(time.Time) - Expect(exp.Sub(yesterday)).To(BeNumerically(">=", oneDay)) + Expect(decodedClaims.ExpiresAt.Sub(yesterday)).To(BeNumerically(">=", oneDay)) }) }) }) diff --git a/core/auth/claims.go b/core/auth/claims.go new file mode 100644 index 000000000..c0e4dea7f --- /dev/null +++ b/core/auth/claims.go @@ -0,0 +1,96 @@ +package auth + +import ( + "time" + + "github.com/lestrrat-go/jwx/v3/jwt" +) + +// Claims represents the typed JWT claims used throughout Navidrome, +// replacing the untyped map[string]any approach. +type Claims struct { + // Standard JWT claims + Issuer string + Subject string // username for session tokens + IssuedAt time.Time + ExpiresAt time.Time + + // Custom claims + UserID string // "uid" + IsAdmin bool // "adm" + ID string // "id" - artwork/mediafile ID + Format string // "f" - audio format + BitRate int // "b" - audio bitrate +} + +// ToMap converts Claims to a map[string]any for use with TokenAuth.Encode(). +// Only non-zero fields are included. +func (c Claims) ToMap() map[string]any { + m := make(map[string]any) + if c.Issuer != "" { + m[jwt.IssuerKey] = c.Issuer + } + if c.Subject != "" { + m[jwt.SubjectKey] = c.Subject + } + if !c.IssuedAt.IsZero() { + m[jwt.IssuedAtKey] = c.IssuedAt.UTC().Unix() + } + if !c.ExpiresAt.IsZero() { + m[jwt.ExpirationKey] = c.ExpiresAt.UTC().Unix() + } + if c.UserID != "" { + m["uid"] = c.UserID + } + if c.IsAdmin { + m["adm"] = c.IsAdmin + } + if c.ID != "" { + m["id"] = c.ID + } + if c.Format != "" { + m["f"] = c.Format + } + if c.BitRate != 0 { + m["b"] = c.BitRate + } + return m +} + +func (c Claims) WithExpiresAt(t time.Time) Claims { + c.ExpiresAt = t + return c +} + +// ClaimsFromToken extracts Claims directly from a jwt.Token using token.Get(). +func ClaimsFromToken(token jwt.Token) Claims { + var c Claims + c.Issuer, _ = token.Issuer() + c.Subject, _ = token.Subject() + c.IssuedAt, _ = token.IssuedAt() + c.ExpiresAt, _ = token.Expiration() + + var uid string + if err := token.Get("uid", &uid); err == nil { + c.UserID = uid + } + var adm bool + if err := token.Get("adm", &adm); err == nil { + c.IsAdmin = adm + } + var id string + if err := token.Get("id", &id); err == nil { + c.ID = id + } + var f string + if err := token.Get("f", &f); err == nil { + c.Format = f + } + if err := token.Get("b", &c.BitRate); err != nil { + var bf float64 + if err := token.Get("b", &bf); err == nil { + c.BitRate = int(bf) + } + } + return c +} diff --git a/core/auth/claims_test.go b/core/auth/claims_test.go new file mode 100644 index 000000000..cf6b07263 --- /dev/null +++ b/core/auth/claims_test.go @@ -0,0 +1,99 @@ +package auth_test + +import ( + "time" + + "github.com/go-chi/jwtauth/v5" + "github.com/navidrome/navidrome/core/auth" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Claims", func() { + Describe("ToMap", func() { + It("includes only non-zero fields", func() { + c := auth.Claims{ + Issuer: "ND", + Subject: "johndoe", + UserID: "123", + IsAdmin: true, + } + m := c.ToMap() + Expect(m).To(HaveKeyWithValue("iss", "ND")) + Expect(m).To(HaveKeyWithValue("sub", "johndoe")) + Expect(m).To(HaveKeyWithValue("uid", "123")) + Expect(m).To(HaveKeyWithValue("adm", true)) + Expect(m).NotTo(HaveKey("exp")) + Expect(m).NotTo(HaveKey("iat")) + Expect(m).NotTo(HaveKey("id")) + Expect(m).NotTo(HaveKey("f")) + Expect(m).NotTo(HaveKey("b")) + }) + + It("includes expiration and issued-at when set", func() { + now := time.Now() + c := auth.Claims{ + IssuedAt: now, + ExpiresAt: now.Add(time.Hour), + } + m := c.ToMap() + Expect(m).To(HaveKey("iat")) + Expect(m).To(HaveKey("exp")) + }) + + It("includes custom claims for public tokens", func() { + c := auth.Claims{ + ID: "al-123", + Format: "mp3", + BitRate: 192, + } + m := c.ToMap() + Expect(m).To(HaveKeyWithValue("id", "al-123")) + Expect(m).To(HaveKeyWithValue("f", "mp3")) + Expect(m).To(HaveKeyWithValue("b", 192)) + }) + }) + + Describe("ClaimsFromToken", func() { + It("round-trips session claims through encode/decode", func() { + tokenAuth := jwtauth.New("HS256", []byte("test-secret"), nil) + now := time.Now().Truncate(time.Second) + original := auth.Claims{ + Issuer: "ND", + Subject: "johndoe", + UserID: "123", + IsAdmin: true, + } + m := original.ToMap() + m["iat"] = now.UTC().Unix() + token, _, err := tokenAuth.Encode(m) + Expect(err).NotTo(HaveOccurred()) + + c := auth.ClaimsFromToken(token) + Expect(c.Issuer).To(Equal("ND")) + Expect(c.Subject).To(Equal("johndoe")) + Expect(c.UserID).To(Equal("123")) + Expect(c.IsAdmin).To(BeTrue()) + Expect(c.IssuedAt.UTC()).To(Equal(now.UTC())) + }) + + It("round-trips public token claims through encode/decode", func() { + tokenAuth := jwtauth.New("HS256", []byte("test-secret"), nil) + original := auth.Claims{ + Issuer: "ND", + ID: "al-456", + Format: "opus", + BitRate: 128, + } + token, _, err := tokenAuth.Encode(original.ToMap()) + Expect(err).NotTo(HaveOccurred()) + + c := auth.ClaimsFromToken(token) + Expect(c.Issuer).To(Equal("ND")) + Expect(c.ID).To(Equal("al-456")) + Expect(c.Format).To(Equal("opus")) + Expect(c.BitRate).To(Equal(128)) + }) + }) + +}) diff --git a/core/external/extdata_helper_test.go b/core/external/extdata_helper_test.go index 29975e5c5..8fabf4490 100644 --- a/core/external/extdata_helper_test.go +++ b/core/external/extdata_helper_test.go @@ -40,7 +40,7 @@ func (m *mockArtistRepo) Get(id string) (*model.Artist, error) { // GetAll implements model.ArtistRepository. func (m *mockArtistRepo) GetAll(options ...model.QueryOptions) (model.Artists, error) { - argsSlice := make([]interface{}, len(options)) + argsSlice := make([]any, len(options)) for i, v := range options { argsSlice[i] = v } @@ -92,9 +92,14 @@ func (m *mockMediaFileRepo) Get(id string) (*model.MediaFile, error) { return args.Get(0).(*model.MediaFile), args.Error(1) } +// GetAllByTags implements model.MediaFileRepository. +func (m *mockMediaFileRepo) GetAllByTags(_ model.TagName, _ []string, options ...model.QueryOptions) (model.MediaFiles, error) { + return m.GetAll(options...) +} + // GetAll implements model.MediaFileRepository. func (m *mockMediaFileRepo) GetAll(options ...model.QueryOptions) (model.MediaFiles, error) { - argsSlice := make([]interface{}, len(options)) + argsSlice := make([]any, len(options)) for i, v := range options { argsSlice[i] = v } @@ -147,7 +152,7 @@ func (m *mockAlbumRepo) Get(id string) (*model.Album, error) { // GetAll implements model.AlbumRepository. func (m *mockAlbumRepo) GetAll(options ...model.QueryOptions) (model.Albums, error) { - argsSlice := make([]interface{}, len(options)) + argsSlice := make([]any, len(options)) for i, v := range options { argsSlice[i] = v } @@ -282,3 +287,27 @@ func (m *mockAgents) GetAlbumImages(ctx context.Context, name, artist, mbid stri } return nil, args.Error(1) } + +func (m *mockAgents) GetSimilarSongsByTrack(ctx context.Context, id, name, artist, mbid string, count int) ([]agents.Song, error) { + args := m.Called(ctx, id, name, artist, mbid, count) + if args.Get(0) != nil { + return args.Get(0).([]agents.Song), args.Error(1) + } + return nil, args.Error(1) +} + +func (m *mockAgents) GetSimilarSongsByAlbum(ctx context.Context, id, name, artist, mbid string, count int) ([]agents.Song, error) { + args := m.Called(ctx, id, name, artist, mbid, count) + if args.Get(0) != nil { + return args.Get(0).([]agents.Song), args.Error(1) + } + return nil, args.Error(1) +} + +func (m *mockAgents) GetSimilarSongsByArtist(ctx context.Context, id, name, mbid string, count int) ([]agents.Song, error) { + args := m.Called(ctx, id, name, mbid, count) + if args.Get(0) != nil { + return args.Get(0).([]agents.Song), args.Error(1) + } + return nil, args.Error(1) +} diff --git a/core/external/provider.go b/core/external/provider.go index 8e9a458c1..a30afed15 100644 --- a/core/external/provider.go +++ b/core/external/provider.go @@ -12,10 +12,6 @@ import ( "github.com/Masterminds/squirrel" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/core/agents" - _ "github.com/navidrome/navidrome/core/agents/deezer" - _ "github.com/navidrome/navidrome/core/agents/lastfm" - _ "github.com/navidrome/navidrome/core/agents/listenbrainz" - _ "github.com/navidrome/navidrome/core/agents/spotify" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/utils" @@ -36,7 +32,7 @@ const ( type Provider interface { UpdateAlbumInfo(ctx context.Context, id string) (*model.Album, error) UpdateArtistInfo(ctx context.Context, id string, count int, includeNotPresent bool) (*model.Artist, error) - ArtistRadio(ctx context.Context, id string, count int) (model.MediaFiles, error) + SimilarSongs(ctx context.Context, id string, count int) (model.MediaFiles, error) TopSongs(ctx context.Context, artist string, count int) (model.MediaFiles, error) ArtistImage(ctx context.Context, id string) (*url.URL, error) AlbumImage(ctx context.Context, id string) (*url.URL, error) @@ -51,12 +47,28 @@ type provider struct { type auxAlbum struct { model.Album - Name string +} + +// Name returns the appropriate album name for external API calls +// based on the DevPreserveUnicodeInExternalCalls configuration option +func (a *auxAlbum) Name() string { + if conf.Server.DevPreserveUnicodeInExternalCalls { + return a.Album.Name + } + return str.Clear(a.Album.Name) } type auxArtist struct { model.Artist - Name string +} + +// Name returns the appropriate artist name for external API calls +// based on the DevPreserveUnicodeInExternalCalls configuration option +func (a *auxArtist) Name() string { + if conf.Server.DevPreserveUnicodeInExternalCalls { + return a.Artist.Name + } + return str.Clear(a.Artist.Name) } type Agents interface { @@ -68,6 +80,9 @@ type Agents interface { agents.ArtistSimilarRetriever agents.ArtistTopSongsRetriever agents.ArtistURLRetriever + agents.SimilarSongsByTrackRetriever + agents.SimilarSongsByAlbumRetriever + agents.SimilarSongsByArtistRetriever } func NewProvider(ds model.DataStore, agents Agents) Provider { @@ -78,7 +93,7 @@ func NewProvider(ds model.DataStore, agents Agents) Provider { } func (e *provider) getAlbum(ctx context.Context, id string) (auxAlbum, error) { - var entity interface{} + var entity any entity, err := model.GetEntityByID(ctx, e.ds, id) if err != nil { return auxAlbum{}, err @@ -88,7 +103,6 @@ func (e *provider) getAlbum(ctx context.Context, id string) (auxAlbum, error) { switch v := entity.(type) { case *model.Album: album.Album = *v - album.Name = str.Clear(v.Name) case *model.MediaFile: return e.getAlbum(ctx, v.AlbumID) default: @@ -106,8 +120,9 @@ func (e *provider) UpdateAlbumInfo(ctx context.Context, id string) (*model.Album } updatedAt := V(album.ExternalInfoUpdatedAt) + albumName := album.Name() if updatedAt.IsZero() { - log.Debug(ctx, "AlbumInfo not cached. Retrieving it now", "updatedAt", updatedAt, "id", id, "name", album.Name) + log.Debug(ctx, "AlbumInfo not cached. Retrieving it now", "updatedAt", updatedAt, "id", id, "name", albumName) album, err = e.populateAlbumInfo(ctx, album) if err != nil { return nil, err @@ -116,7 +131,7 @@ func (e *provider) UpdateAlbumInfo(ctx context.Context, id string) (*model.Album // If info is expired, trigger a populateAlbumInfo in the background if time.Since(updatedAt) > conf.Server.DevAlbumInfoTimeToLive { - log.Debug("Found expired cached AlbumInfo, refreshing in the background", "updatedAt", album.ExternalInfoUpdatedAt, "name", album.Name) + log.Debug("Found expired cached AlbumInfo, refreshing in the background", "updatedAt", album.ExternalInfoUpdatedAt, "name", albumName) e.albumQueue.enqueue(&album) } @@ -125,12 +140,13 @@ func (e *provider) UpdateAlbumInfo(ctx context.Context, id string) (*model.Album func (e *provider) populateAlbumInfo(ctx context.Context, album auxAlbum) (auxAlbum, error) { start := time.Now() - info, err := e.ag.GetAlbumInfo(ctx, album.Name, album.AlbumArtist, album.MbzAlbumID) + albumName := album.Name() + info, err := e.ag.GetAlbumInfo(ctx, albumName, album.AlbumArtist, album.MbzAlbumID) if errors.Is(err, agents.ErrNotFound) { return album, nil } if err != nil { - log.Error("Error refreshing AlbumInfo", "id", album.ID, "name", album.Name, "artist", album.AlbumArtist, + log.Error("Error refreshing AlbumInfo", "id", album.ID, "name", albumName, "artist", album.AlbumArtist, "elapsed", time.Since(start), err) return album, err } @@ -142,7 +158,7 @@ func (e *provider) populateAlbumInfo(ctx context.Context, album auxAlbum) (auxAl album.Description = info.Description } - images, err := e.ag.GetAlbumImages(ctx, album.Name, album.AlbumArtist, album.MbzAlbumID) + images, err := e.ag.GetAlbumImages(ctx, albumName, album.AlbumArtist, album.MbzAlbumID) if err == nil && len(images) > 0 { sort.Slice(images, func(i, j int) bool { return images[i].Size > images[j].Size @@ -161,7 +177,7 @@ func (e *provider) populateAlbumInfo(ctx context.Context, album auxAlbum) (auxAl err = e.ds.Album(ctx).UpdateExternalInfo(&album.Album) if err != nil { - log.Error(ctx, "Error trying to update album external information", "id", album.ID, "name", album.Name, + log.Error(ctx, "Error trying to update album external information", "id", album.ID, "name", albumName, "elapsed", time.Since(start), err) } else { log.Trace(ctx, "AlbumInfo collected", "album", album, "elapsed", time.Since(start)) @@ -171,7 +187,7 @@ func (e *provider) populateAlbumInfo(ctx context.Context, album auxAlbum) (auxAl } func (e *provider) getArtist(ctx context.Context, id string) (auxArtist, error) { - var entity interface{} + var entity any entity, err := model.GetEntityByID(ctx, e.ds, id) if err != nil { return auxArtist{}, err @@ -181,7 +197,6 @@ func (e *provider) getArtist(ctx context.Context, id string) (auxArtist, error) switch v := entity.(type) { case *model.Artist: artist.Artist = *v - artist.Name = str.Clear(v.Name) case *model.MediaFile: return e.getArtist(ctx, v.ArtistID) case *model.Album: @@ -210,8 +225,9 @@ func (e *provider) refreshArtistInfo(ctx context.Context, id string) (auxArtist, // If we don't have any info, retrieves it now updatedAt := V(artist.ExternalInfoUpdatedAt) + artistName := artist.Name() if updatedAt.IsZero() { - log.Debug(ctx, "ArtistInfo not cached. Retrieving it now", "updatedAt", updatedAt, "id", id, "name", artist.Name) + log.Debug(ctx, "ArtistInfo not cached. Retrieving it now", "updatedAt", updatedAt, "id", id, "name", artistName) artist, err = e.populateArtistInfo(ctx, artist) if err != nil { return auxArtist{}, err @@ -220,7 +236,7 @@ func (e *provider) refreshArtistInfo(ctx context.Context, id string) (auxArtist, // If info is expired, trigger a populateArtistInfo in the background if time.Since(updatedAt) > conf.Server.DevArtistInfoTimeToLive { - log.Debug("Found expired cached ArtistInfo, refreshing in the background", "updatedAt", updatedAt, "name", artist.Name) + log.Debug("Found expired cached ArtistInfo, refreshing in the background", "updatedAt", updatedAt, "name", artistName) e.artistQueue.enqueue(&artist) } return artist, nil @@ -229,8 +245,9 @@ func (e *provider) refreshArtistInfo(ctx context.Context, id string) (auxArtist, func (e *provider) populateArtistInfo(ctx context.Context, artist auxArtist) (auxArtist, error) { start := time.Now() // Get MBID first, if it is not yet available + artistName := artist.Name() if artist.MbzArtistID == "" { - mbid, err := e.ag.GetArtistMBID(ctx, artist.ID, artist.Name) + mbid, err := e.ag.GetArtistMBID(ctx, artist.ID, artistName) if mbid != "" && err == nil { artist.MbzArtistID = mbid } @@ -242,18 +259,18 @@ func (e *provider) populateArtistInfo(ctx context.Context, artist auxArtist) (au g.Go(func() error { e.callGetImage(ctx, e.ag, &artist); return nil }) g.Go(func() error { e.callGetBiography(ctx, e.ag, &artist); return nil }) g.Go(func() error { e.callGetURL(ctx, e.ag, &artist); return nil }) - g.Go(func() error { e.callGetSimilar(ctx, e.ag, &artist, maxSimilarArtists, true); return nil }) + g.Go(func() error { e.callGetSimilarArtists(ctx, e.ag, &artist, maxSimilarArtists, true); return nil }) _ = g.Wait() if utils.IsCtxDone(ctx) { - log.Warn(ctx, "ArtistInfo update canceled", "elapsed", "id", artist.ID, "name", artist.Name, time.Since(start), ctx.Err()) + log.Warn(ctx, "ArtistInfo update canceled", "id", artist.ID, "name", artistName, "elapsed", time.Since(start), ctx.Err()) return artist, ctx.Err() } artist.ExternalInfoUpdatedAt = P(time.Now()) err := e.ds.Artist(ctx).UpdateExternalInfo(&artist.Artist) if err != nil { - log.Error(ctx, "Error trying to update artist external information", "id", artist.ID, "name", artist.Name, + log.Error(ctx, "Error trying to update artist external information", "id", artist.ID, "name", artistName, "elapsed", time.Since(start), err) } else { log.Trace(ctx, "ArtistInfo collected", "artist", artist, "elapsed", time.Since(start)) @@ -261,27 +278,59 @@ func (e *provider) populateArtistInfo(ctx context.Context, artist auxArtist) (au return artist, nil } -func (e *provider) ArtistRadio(ctx context.Context, id string, count int) (model.MediaFiles, error) { +func (e *provider) SimilarSongs(ctx context.Context, id string, count int) (model.MediaFiles, error) { + entity, err := model.GetEntityByID(ctx, e.ds, id) + if err != nil { + return nil, err + } + + var songs []agents.Song + + // Try entity-specific similarity first + switch v := entity.(type) { + case *model.MediaFile: + songs, err = e.ag.GetSimilarSongsByTrack(ctx, v.ID, v.Title, v.Artist, v.MbzRecordingID, count) + case *model.Album: + songs, err = e.ag.GetSimilarSongsByAlbum(ctx, v.ID, v.Name, v.AlbumArtist, v.MbzAlbumID, count) + case *model.Artist: + songs, err = e.ag.GetSimilarSongsByArtist(ctx, v.ID, v.Name, v.MbzArtistID, count) + default: + log.Warn(ctx, "Unknown entity type", "id", id, "type", fmt.Sprintf("%T", entity)) + return nil, model.ErrNotFound + } + + if err == nil && len(songs) > 0 { + return e.matchSongsToLibrary(ctx, songs, count) + } + + // Fallback to existing similar artists + top songs algorithm + return e.similarSongsFallback(ctx, id, count) +} + +// similarSongsFallback uses the original similar artists + top songs algorithm. The idea is to +// get the artist of the given entity, retrieve similar artists, get their top songs, and pick +// a weighted random selection of songs to return as similar songs. +func (e *provider) similarSongsFallback(ctx context.Context, id string, count int) (model.MediaFiles, error) { artist, err := e.getArtist(ctx, id) if err != nil { return nil, err } - e.callGetSimilar(ctx, e.ag, &artist, 15, false) + e.callGetSimilarArtists(ctx, e.ag, &artist, 15, false) if utils.IsCtxDone(ctx) { - log.Warn(ctx, "ArtistRadio call canceled", ctx.Err()) + log.Warn(ctx, "SimilarSongs call canceled", ctx.Err()) return nil, ctx.Err() } weightedSongs := random.NewWeightedChooser[model.MediaFile]() addArtist := func(a model.Artist, weightedSongs *random.WeightedChooser[model.MediaFile], count, artistWeight int) error { if utils.IsCtxDone(ctx) { - log.Warn(ctx, "ArtistRadio call canceled", ctx.Err()) + log.Warn(ctx, "SimilarSongs call canceled", ctx.Err()) return ctx.Err() } topCount := max(count, 20) - topSongs, err := e.getMatchingTopSongs(ctx, e.ag, &auxArtist{Name: a.Name, Artist: a}, topCount) + topSongs, err := e.getMatchingTopSongs(ctx, e.ag, &auxArtist{Artist: a}, topCount) if err != nil { log.Warn(ctx, "Error getting artist's top songs", "artist", a.Name, err) return nil @@ -325,13 +374,19 @@ func (e *provider) ArtistImage(ctx context.Context, id string) (*url.URL, error) return nil, err } - e.callGetImage(ctx, e.ag, &artist) - if utils.IsCtxDone(ctx) { - log.Warn(ctx, "ArtistImage call canceled", ctx.Err()) - return nil, ctx.Err() + // Use already-stored image URL if available, avoiding expensive external API calls. + // If the info is expired, the background refresh (via UpdateArtistInfo/artistQueue) will update it. + imageUrl := artist.ArtistImageUrl() + if imageUrl == "" { + // No cached URL — must fetch from external source synchronously + e.callGetImage(ctx, e.ag, &artist) + if utils.IsCtxDone(ctx) { + log.Warn(ctx, "ArtistImage call canceled", ctx.Err()) + return nil, ctx.Err() + } + imageUrl = artist.ArtistImageUrl() } - imageUrl := artist.ArtistImageUrl() if imageUrl == "" { return nil, model.ErrNotFound } @@ -344,22 +399,23 @@ func (e *provider) AlbumImage(ctx context.Context, id string) (*url.URL, error) return nil, err } - images, err := e.ag.GetAlbumImages(ctx, album.Name, album.AlbumArtist, album.MbzAlbumID) + albumName := album.Name() + images, err := e.ag.GetAlbumImages(ctx, albumName, album.AlbumArtist, album.MbzAlbumID) if err != nil { switch { case errors.Is(err, agents.ErrNotFound): - log.Trace(ctx, "Album not found in agent", "albumID", id, "name", album.Name, "artist", album.AlbumArtist) + log.Trace(ctx, "Album not found in agent", "albumID", id, "name", albumName, "artist", album.AlbumArtist) return nil, model.ErrNotFound case errors.Is(err, context.Canceled): log.Debug(ctx, "GetAlbumImages call canceled", err) default: - log.Warn(ctx, "Error getting album images from agent", "albumID", id, "name", album.Name, "artist", album.AlbumArtist, err) + log.Warn(ctx, "Error getting album images from agent", "albumID", id, "name", albumName, "artist", album.AlbumArtist, err) } return nil, err } if len(images) == 0 { - log.Warn(ctx, "Agent returned no images without error", "albumID", id, "name", album.Name, "artist", album.AlbumArtist) + log.Warn(ctx, "Agent returned no images without error", "albumID", id, "name", albumName, "artist", album.AlbumArtist) return nil, model.ErrNotFound } @@ -401,124 +457,38 @@ func (e *provider) TopSongs(ctx context.Context, artistName string, count int) ( } func (e *provider) getMatchingTopSongs(ctx context.Context, agent agents.ArtistTopSongsRetriever, artist *auxArtist, count int) (model.MediaFiles, error) { - songs, err := agent.GetArtistTopSongs(ctx, artist.ID, artist.Name, artist.MbzArtistID, count) + artistName := artist.Name() + songs, err := agent.GetArtistTopSongs(ctx, artist.ID, artistName, artist.MbzArtistID, count) if err != nil { - return nil, fmt.Errorf("failed to get top songs for artist %s: %w", artist.Name, err) + return nil, fmt.Errorf("failed to get top songs for artist %s: %w", artistName, err) } - mbidMatches, err := e.loadTracksByMBID(ctx, songs) - if err != nil { - return nil, fmt.Errorf("failed to load tracks by MBID: %w", err) - } - titleMatches, err := e.loadTracksByTitle(ctx, songs, artist, mbidMatches) - if err != nil { - return nil, fmt.Errorf("failed to load tracks by title: %w", err) + // Enrich songs with artist info if not already present (for top songs, we know the artist) + for i := range songs { + if songs[i].Artist == "" { + songs[i].Artist = artistName + } + if songs[i].ArtistMBID == "" { + songs[i].ArtistMBID = artist.MbzArtistID + } } - log.Trace(ctx, "Top Songs loaded", "name", artist.Name, "numSongs", len(songs), "numMBIDMatches", len(mbidMatches), "numTitleMatches", len(titleMatches)) - mfs := e.selectTopSongs(songs, mbidMatches, titleMatches, count) + mfs, err := e.matchSongsToLibrary(ctx, songs, count) + if err != nil { + return nil, err + } if len(mfs) == 0 { - log.Debug(ctx, "No matching top songs found", "name", artist.Name) + log.Debug(ctx, "No matching top songs found", "name", artistName) } else { - log.Debug(ctx, "Found matching top songs", "name", artist.Name, "numSongs", len(mfs)) + log.Debug(ctx, "Found matching top songs", "name", artistName, "numSongs", len(mfs)) } return mfs, nil } -func (e *provider) loadTracksByMBID(ctx context.Context, songs []agents.Song) (map[string]model.MediaFile, error) { - var mbids []string - for _, s := range songs { - if s.MBID != "" { - mbids = append(mbids, s.MBID) - } - } - matches := map[string]model.MediaFile{} - if len(mbids) == 0 { - return matches, nil - } - res, err := e.ds.MediaFile(ctx).GetAll(model.QueryOptions{ - Filters: squirrel.And{ - squirrel.Eq{"mbz_recording_id": mbids}, - squirrel.Eq{"missing": false}, - }, - }) - if err != nil { - return matches, err - } - for _, mf := range res { - if id := mf.MbzRecordingID; id != "" { - if _, ok := matches[id]; !ok { - matches[id] = mf - } - } - } - return matches, nil -} - -func (e *provider) loadTracksByTitle(ctx context.Context, songs []agents.Song, artist *auxArtist, mbidMatches map[string]model.MediaFile) (map[string]model.MediaFile, error) { - titleMap := map[string]string{} - for _, s := range songs { - if s.MBID != "" && mbidMatches[s.MBID].ID != "" { - continue - } - sanitized := str.SanitizeFieldForSorting(s.Name) - titleMap[sanitized] = s.Name - } - matches := map[string]model.MediaFile{} - if len(titleMap) == 0 { - return matches, nil - } - titleFilters := squirrel.Or{} - for sanitized := range titleMap { - titleFilters = append(titleFilters, squirrel.Like{"order_title": sanitized}) - } - - res, err := e.ds.MediaFile(ctx).GetAll(model.QueryOptions{ - Filters: squirrel.And{ - squirrel.Or{ - squirrel.Eq{"artist_id": artist.ID}, - squirrel.Eq{"album_artist_id": artist.ID}, - }, - titleFilters, - squirrel.Eq{"missing": false}, - }, - Sort: "starred desc, rating desc, year asc, compilation asc ", - }) - if err != nil { - return matches, err - } - for _, mf := range res { - sanitized := str.SanitizeFieldForSorting(mf.Title) - if _, ok := matches[sanitized]; !ok { - matches[sanitized] = mf - } - } - return matches, nil -} - -func (e *provider) selectTopSongs(songs []agents.Song, byMBID, byTitle map[string]model.MediaFile, count int) model.MediaFiles { - var mfs model.MediaFiles - for _, t := range songs { - if len(mfs) == count { - break - } - if t.MBID != "" { - if mf, ok := byMBID[t.MBID]; ok { - mfs = append(mfs, mf) - continue - } - } - if mf, ok := byTitle[str.SanitizeFieldForSorting(t.Name)]; ok { - mfs = append(mfs, mf) - } - } - return mfs -} - func (e *provider) callGetURL(ctx context.Context, agent agents.ArtistURLRetriever, artist *auxArtist) { - artisURL, err := agent.GetArtistURL(ctx, artist.ID, artist.Name, artist.MbzArtistID) + artisURL, err := agent.GetArtistURL(ctx, artist.ID, artist.Name(), artist.MbzArtistID) if err != nil { return } @@ -526,7 +496,7 @@ func (e *provider) callGetURL(ctx context.Context, agent agents.ArtistURLRetriev } func (e *provider) callGetBiography(ctx context.Context, agent agents.ArtistBiographyRetriever, artist *auxArtist) { - bio, err := agent.GetArtistBiography(ctx, artist.ID, str.Clear(artist.Name), artist.MbzArtistID) + bio, err := agent.GetArtistBiography(ctx, artist.ID, artist.Name(), artist.MbzArtistID) if err != nil { return } @@ -536,7 +506,7 @@ func (e *provider) callGetBiography(ctx context.Context, agent agents.ArtistBiog } func (e *provider) callGetImage(ctx context.Context, agent agents.ArtistImageRetriever, artist *auxArtist) { - images, err := agent.GetArtistImages(ctx, artist.ID, artist.Name, artist.MbzArtistID) + images, err := agent.GetArtistImages(ctx, artist.ID, artist.Name(), artist.MbzArtistID) if err != nil { return } @@ -553,15 +523,16 @@ func (e *provider) callGetImage(ctx context.Context, agent agents.ArtistImageRet } } -func (e *provider) callGetSimilar(ctx context.Context, agent agents.ArtistSimilarRetriever, artist *auxArtist, +func (e *provider) callGetSimilarArtists(ctx context.Context, agent agents.ArtistSimilarRetriever, artist *auxArtist, limit int, includeNotPresent bool) { - similar, err := agent.GetSimilarArtists(ctx, artist.ID, artist.Name, artist.MbzArtistID, limit) + artistName := artist.Name() + similar, err := agent.GetSimilarArtists(ctx, artist.ID, artistName, artist.MbzArtistID, limit) if len(similar) == 0 || err != nil { return } start := time.Now() sa, err := e.mapSimilarArtists(ctx, similar, limit, includeNotPresent) - log.Debug(ctx, "Mapped Similar Artists", "artist", artist.Name, "numSimilar", len(sa), "elapsed", time.Since(start)) + log.Debug(ctx, "Mapped Similar Artists", "artist", artistName, "numSimilar", len(sa), "elapsed", time.Since(start)) if err != nil { return } @@ -572,36 +543,51 @@ func (e *provider) mapSimilarArtists(ctx context.Context, similar []agents.Artis var result model.Artists var notPresent []string - artistNames := slice.Map(similar, func(artist agents.Artist) string { return artist.Name }) - - // Query all artists at once - clauses := slice.Map(artistNames, func(name string) squirrel.Sqlizer { - return squirrel.Like{"artist.name": name} - }) - artists, err := e.ds.Artist(ctx).GetAll(model.QueryOptions{ - Filters: squirrel.Or(clauses), - }) + // Load artists by ID (highest priority) + idMatches, err := e.loadArtistsByID(ctx, similar) if err != nil { return nil, err } - // Create a map for quick lookup - artistMap := make(map[string]model.Artist) - for _, artist := range artists { - artistMap[artist.Name] = artist + // Load artists by MBID (second priority) + mbidMatches, err := e.loadArtistsByMBID(ctx, similar, idMatches) + if err != nil { + return nil, err + } + + // Load artists by name (lowest priority, fallback) + nameMatches, err := e.loadArtistsByName(ctx, similar, idMatches, mbidMatches) + if err != nil { + return nil, err } count := 0 - // Process the similar artists + // Process the similar artists using priority: ID → MBID → Name for _, s := range similar { - if artist, found := artistMap[s.Name]; found { + if count >= limit { + break + } + // Try ID match first + if s.ID != "" { + if artist, found := idMatches[s.ID]; found { + result = append(result, artist) + count++ + continue + } + } + // Try MBID match second + if s.MBID != "" { + if artist, found := mbidMatches[s.MBID]; found { + result = append(result, artist) + count++ + continue + } + } + // Fall back to name match + if artist, found := nameMatches[s.Name]; found { result = append(result, artist) count++ - - if count >= limit { - break - } } else { notPresent = append(notPresent, s.Name) } @@ -624,6 +610,95 @@ func (e *provider) mapSimilarArtists(ctx context.Context, similar []agents.Artis return result, nil } +func (e *provider) loadArtistsByID(ctx context.Context, similar []agents.Artist) (map[string]model.Artist, error) { + var ids []string + for _, s := range similar { + if s.ID != "" { + ids = append(ids, s.ID) + } + } + matches := map[string]model.Artist{} + if len(ids) == 0 { + return matches, nil + } + res, err := e.ds.Artist(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"artist.id": ids}, + }) + if err != nil { + return matches, err + } + for _, a := range res { + if _, ok := matches[a.ID]; !ok { + matches[a.ID] = a + } + } + return matches, nil +} + +func (e *provider) loadArtistsByMBID(ctx context.Context, similar []agents.Artist, idMatches map[string]model.Artist) (map[string]model.Artist, error) { + var mbids []string + for _, s := range similar { + // Skip if already matched by ID + if s.ID != "" && idMatches[s.ID].ID != "" { + continue + } + if s.MBID != "" { + mbids = append(mbids, s.MBID) + } + } + matches := map[string]model.Artist{} + if len(mbids) == 0 { + return matches, nil + } + res, err := e.ds.Artist(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"mbz_artist_id": mbids}, + }) + if err != nil { + return matches, err + } + for _, a := range res { + if id := a.MbzArtistID; id != "" { + if _, ok := matches[id]; !ok { + matches[id] = a + } + } + } + return matches, nil +} + +func (e *provider) loadArtistsByName(ctx context.Context, similar []agents.Artist, idMatches map[string]model.Artist, mbidMatches map[string]model.Artist) (map[string]model.Artist, error) { + var names []string + for _, s := range similar { + // Skip if already matched by ID or MBID + if s.ID != "" && idMatches[s.ID].ID != "" { + continue + } + if s.MBID != "" && mbidMatches[s.MBID].ID != "" { + continue + } + names = append(names, s.Name) + } + matches := map[string]model.Artist{} + if len(names) == 0 { + return matches, nil + } + clauses := slice.Map(names, func(name string) squirrel.Sqlizer { + return squirrel.Like{"artist.name": name} + }) + res, err := e.ds.Artist(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Or(clauses), + }) + if err != nil { + return matches, err + } + for _, a := range res { + if _, ok := matches[a.Name]; !ok { + matches[a.Name] = a + } + } + return matches, nil +} + func (e *provider) findArtistByName(ctx context.Context, artistName string) (*auxArtist, error) { artists, err := e.ds.Artist(ctx).GetAll(model.QueryOptions{ Filters: squirrel.Like{"artist.name": artistName}, @@ -635,11 +710,7 @@ func (e *provider) findArtistByName(ctx context.Context, artistName string) (*au if len(artists) == 0 { return nil, model.ErrNotFound } - artist := &auxArtist{ - Artist: artists[0], - Name: str.Clear(artists[0].Name), - } - return artist, nil + return &auxArtist{Artist: artists[0]}, nil } func (e *provider) loadSimilar(ctx context.Context, artist *auxArtist, count int, includeNotPresent bool) error { @@ -655,7 +726,7 @@ func (e *provider) loadSimilar(ctx context.Context, artist *auxArtist, count int Filters: squirrel.Eq{"artist.id": ids}, }) if err != nil { - log.Error("Error loading similar artists", "id", artist.ID, "name", artist.Name, err) + log.Error("Error loading similar artists", "id", artist.ID, "name", artist.Name(), err) return err } diff --git a/core/external/provider_albumimage_test.go b/core/external/provider_albumimage_test.go index 9b682462d..8a81b4f4d 100644 --- a/core/external/provider_albumimage_test.go +++ b/core/external/provider_albumimage_test.go @@ -260,6 +260,69 @@ var _ = Describe("Provider - AlbumImage", func() { mockMediaFileRepo.AssertCalled(GinkgoT(), "Get", "not-found") mockAlbumAgent.AssertNotCalled(GinkgoT(), "GetAlbumImages", mock.Anything, mock.Anything, mock.Anything) }) + + Context("Unicode handling in album names", func() { + var albumWithEnDash *model.Album + var expectedURL *url.URL + + const ( + originalAlbumName = "Raising Hell–Deluxe" // Album name with en dash + normalizedAlbumName = "Raising Hell-Deluxe" // Normalized version with hyphen + ) + + BeforeEach(func() { + // Test with en dash (–) in album name + albumWithEnDash = &model.Album{ID: "album-endash", Name: originalAlbumName, AlbumArtistID: "artist-1"} + mockArtistRepo.Mock = mock.Mock{} // Reset default expectations + mockAlbumRepo.Mock = mock.Mock{} // Reset default expectations + mockArtistRepo.On("Get", "album-endash").Return(nil, model.ErrNotFound).Once() + mockAlbumRepo.On("Get", "album-endash").Return(albumWithEnDash, nil).Once() + + expectedURL, _ = url.Parse("http://example.com/album.jpg") + + // Mock the album agent to return an image for the album + mockAlbumAgent.On("GetAlbumImages", ctx, mock.AnythingOfType("string"), "", ""). + Return([]agents.ExternalImage{ + {URL: "http://example.com/album.jpg", Size: 1000}, + }, nil).Once() + }) + + When("DevPreserveUnicodeInExternalCalls is true", func() { + BeforeEach(func() { + conf.Server.DevPreserveUnicodeInExternalCalls = true + }) + + It("preserves Unicode characters in album names", func() { + // Act + imgURL, err := provider.AlbumImage(ctx, "album-endash") + + // Assert + Expect(err).ToNot(HaveOccurred()) + Expect(imgURL).To(Equal(expectedURL)) + mockAlbumRepo.AssertCalled(GinkgoT(), "Get", "album-endash") + // This is the key assertion: ensure the original Unicode name is used + mockAlbumAgent.AssertCalled(GinkgoT(), "GetAlbumImages", ctx, originalAlbumName, "", "") + }) + }) + + When("DevPreserveUnicodeInExternalCalls is false", func() { + BeforeEach(func() { + conf.Server.DevPreserveUnicodeInExternalCalls = false + }) + + It("normalizes Unicode characters", func() { + // Act + imgURL, err := provider.AlbumImage(ctx, "album-endash") + + // Assert + Expect(err).ToNot(HaveOccurred()) + Expect(imgURL).To(Equal(expectedURL)) + mockAlbumRepo.AssertCalled(GinkgoT(), "Get", "album-endash") + // This assertion ensures the normalized name is used (en dash → hyphen) + mockAlbumAgent.AssertCalled(GinkgoT(), "GetAlbumImages", ctx, normalizedAlbumName, "", "") + }) + }) + }) }) // mockAlbumInfoAgent implementation diff --git a/core/external/provider_artistimage_test.go b/core/external/provider_artistimage_test.go index 96341836a..11290bb66 100644 --- a/core/external/provider_artistimage_test.go +++ b/core/external/provider_artistimage_test.go @@ -265,6 +265,67 @@ var _ = Describe("Provider - ArtistImage", func() { mockArtistRepo.AssertCalled(GinkgoT(), "Get", "artist-1") mockImageAgent.AssertCalled(GinkgoT(), "GetArtistImages", ctx, "artist-1", "Artist One", "") }) + + Context("Unicode handling in artist names", func() { + var artistWithEnDash *model.Artist + var expectedURL *url.URL + + const ( + originalArtistName = "Run–D.M.C." // Artist name with en dash + normalizedArtistName = "Run-D.M.C." // Normalized version with hyphen + ) + + BeforeEach(func() { + // Test with en dash (–) in artist name like "Run–D.M.C." + artistWithEnDash = &model.Artist{ID: "artist-endash", Name: originalArtistName} + mockArtistRepo.Mock = mock.Mock{} // Reset default expectations + mockArtistRepo.On("Get", "artist-endash").Return(artistWithEnDash, nil).Once() + + expectedURL, _ = url.Parse("http://example.com/rundmc.jpg") + + // Mock the image agent to return an image for the artist + mockImageAgent.On("GetArtistImages", ctx, "artist-endash", mock.AnythingOfType("string"), ""). + Return([]agents.ExternalImage{ + {URL: "http://example.com/rundmc.jpg", Size: 1000}, + }, nil).Once() + + }) + + When("DevPreserveUnicodeInExternalCalls is true", func() { + BeforeEach(func() { + conf.Server.DevPreserveUnicodeInExternalCalls = true + }) + It("preserves Unicode characters in artist names", func() { + // Act + imgURL, err := provider.ArtistImage(ctx, "artist-endash") + + // Assert + Expect(err).ToNot(HaveOccurred()) + Expect(imgURL).To(Equal(expectedURL)) + mockArtistRepo.AssertCalled(GinkgoT(), "Get", "artist-endash") + // This is the key assertion: ensure the original Unicode name is used + mockImageAgent.AssertCalled(GinkgoT(), "GetArtistImages", ctx, "artist-endash", originalArtistName, "") + }) + }) + + When("DevPreserveUnicodeInExternalCalls is false", func() { + BeforeEach(func() { + conf.Server.DevPreserveUnicodeInExternalCalls = false + }) + + It("normalizes Unicode characters", func() { + // Act + imgURL, err := provider.ArtistImage(ctx, "artist-endash") + + // Assert + Expect(err).ToNot(HaveOccurred()) + Expect(imgURL).To(Equal(expectedURL)) + mockArtistRepo.AssertCalled(GinkgoT(), "Get", "artist-endash") + // This assertion ensures the normalized name is used (en dash → hyphen) + mockImageAgent.AssertCalled(GinkgoT(), "GetArtistImages", ctx, "artist-endash", normalizedArtistName, "") + }) + }) + }) }) // mockArtistImageAgent implementation using testify/mock diff --git a/core/external/provider_artistradio_test.go b/core/external/provider_artistradio_test.go deleted file mode 100644 index 21ea07706..000000000 --- a/core/external/provider_artistradio_test.go +++ /dev/null @@ -1,196 +0,0 @@ -package external_test - -import ( - "context" - "errors" - - "github.com/navidrome/navidrome/core/agents" - . "github.com/navidrome/navidrome/core/external" - "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/tests" - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" - "github.com/stretchr/testify/mock" -) - -var _ = Describe("Provider - ArtistRadio", func() { - var ds model.DataStore - var provider Provider - var mockAgent *mockSimilarArtistAgent - var mockTopAgent agents.ArtistTopSongsRetriever - var mockSimilarAgent agents.ArtistSimilarRetriever - var agentsCombined Agents - var artistRepo *mockArtistRepo - var mediaFileRepo *mockMediaFileRepo - var ctx context.Context - - BeforeEach(func() { - ctx = GinkgoT().Context() - - artistRepo = newMockArtistRepo() - mediaFileRepo = newMockMediaFileRepo() - - ds = &tests.MockDataStore{ - MockedArtist: artistRepo, - MockedMediaFile: mediaFileRepo, - } - - mockAgent = &mockSimilarArtistAgent{} - mockTopAgent = mockAgent - mockSimilarAgent = mockAgent - - agentsCombined = &mockAgents{ - topSongsAgent: mockTopAgent, - similarAgent: mockSimilarAgent, - } - - provider = NewProvider(ds, agentsCombined) - }) - - It("returns similar songs from main artist and similar artists", func() { - artist1 := model.Artist{ID: "artist-1", Name: "Artist One"} - similarArtist := model.Artist{ID: "artist-3", Name: "Similar Artist"} - song1 := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1", MbzRecordingID: "mbid-1"} - song2 := model.MediaFile{ID: "song-2", Title: "Song Two", ArtistID: "artist-1", MbzRecordingID: "mbid-2"} - song3 := model.MediaFile{ID: "song-3", Title: "Song Three", ArtistID: "artist-3", MbzRecordingID: "mbid-3"} - - artistRepo.On("Get", "artist-1").Return(&artist1, nil).Maybe() - artistRepo.On("Get", "artist-3").Return(&similarArtist, nil).Maybe() - - artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { - return opt.Max == 1 && opt.Filters != nil - })).Return(model.Artists{artist1}, nil).Once() - - similarAgentsResp := []agents.Artist{ - {Name: "Similar Artist", MBID: "similar-mbid"}, - } - mockAgent.On("GetSimilarArtists", mock.Anything, "artist-1", "Artist One", "", 15). - Return(similarAgentsResp, nil).Once() - - artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { - return opt.Max == 0 && opt.Filters != nil - })).Return(model.Artists{similarArtist}, nil).Once() - - mockAgent.On("GetArtistTopSongs", mock.Anything, "artist-1", "Artist One", "", mock.Anything). - Return([]agents.Song{ - {Name: "Song One", MBID: "mbid-1"}, - {Name: "Song Two", MBID: "mbid-2"}, - }, nil).Once() - - mockAgent.On("GetArtistTopSongs", mock.Anything, "artist-3", "Similar Artist", "", mock.Anything). - Return([]agents.Song{ - {Name: "Song Three", MBID: "mbid-3"}, - }, nil).Once() - - mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song1, song2}, nil).Once() - mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song3}, nil).Once() - - songs, err := provider.ArtistRadio(ctx, "artist-1", 3) - - Expect(err).ToNot(HaveOccurred()) - Expect(songs).To(HaveLen(3)) - for _, song := range songs { - Expect(song.ID).To(BeElementOf("song-1", "song-2", "song-3")) - } - }) - - It("returns ErrNotFound when artist is not found", func() { - artistRepo.On("Get", "artist-unknown-artist").Return(nil, model.ErrNotFound) - mediaFileRepo.On("Get", "artist-unknown-artist").Return(nil, model.ErrNotFound) - - artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { - return opt.Max == 1 && opt.Filters != nil - })).Return(model.Artists{}, nil).Maybe() - - songs, err := provider.ArtistRadio(ctx, "artist-unknown-artist", 5) - - Expect(err).To(Equal(model.ErrNotFound)) - Expect(songs).To(BeNil()) - }) - - It("returns songs from main artist when GetSimilarArtists returns error", func() { - artist1 := model.Artist{ID: "artist-1", Name: "Artist One"} - song1 := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1", MbzRecordingID: "mbid-1"} - - artistRepo.On("Get", "artist-1").Return(&artist1, nil).Maybe() - artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { - return opt.Max == 1 && opt.Filters != nil - })).Return(model.Artists{artist1}, nil).Maybe() - - mockAgent.On("GetSimilarArtists", mock.Anything, "artist-1", "Artist One", "", 15). - Return(nil, errors.New("error getting similar artists")).Once() - - artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { - return opt.Max == 0 && opt.Filters != nil - })).Return(model.Artists{}, nil).Once() - - mockAgent.On("GetArtistTopSongs", mock.Anything, "artist-1", "Artist One", "", mock.Anything). - Return([]agents.Song{ - {Name: "Song One", MBID: "mbid-1"}, - }, nil).Once() - - mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song1}, nil).Once() - - songs, err := provider.ArtistRadio(ctx, "artist-1", 5) - - Expect(err).ToNot(HaveOccurred()) - Expect(songs).To(HaveLen(1)) - Expect(songs[0].ID).To(Equal("song-1")) - }) - - It("returns empty list when GetArtistTopSongs returns error", func() { - artist1 := model.Artist{ID: "artist-1", Name: "Artist One"} - - artistRepo.On("Get", "artist-1").Return(&artist1, nil).Maybe() - artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { - return opt.Max == 1 && opt.Filters != nil - })).Return(model.Artists{artist1}, nil).Maybe() - - mockAgent.On("GetSimilarArtists", mock.Anything, "artist-1", "Artist One", "", 15). - Return([]agents.Artist{}, nil).Once() - - artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { - return opt.Max == 0 && opt.Filters != nil - })).Return(model.Artists{}, nil).Once() - - mockAgent.On("GetArtistTopSongs", mock.Anything, "artist-1", "Artist One", "", mock.Anything). - Return(nil, errors.New("error getting top songs")).Once() - - songs, err := provider.ArtistRadio(ctx, "artist-1", 5) - - Expect(err).ToNot(HaveOccurred()) - Expect(songs).To(BeEmpty()) - }) - - It("respects count parameter", func() { - artist1 := model.Artist{ID: "artist-1", Name: "Artist One"} - song1 := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1", MbzRecordingID: "mbid-1"} - song2 := model.MediaFile{ID: "song-2", Title: "Song Two", ArtistID: "artist-1", MbzRecordingID: "mbid-2"} - - artistRepo.On("Get", "artist-1").Return(&artist1, nil).Maybe() - artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { - return opt.Max == 1 && opt.Filters != nil - })).Return(model.Artists{artist1}, nil).Maybe() - - mockAgent.On("GetSimilarArtists", mock.Anything, "artist-1", "Artist One", "", 15). - Return([]agents.Artist{}, nil).Once() - - artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { - return opt.Max == 0 && opt.Filters != nil - })).Return(model.Artists{}, nil).Once() - - mockAgent.On("GetArtistTopSongs", mock.Anything, "artist-1", "Artist One", "", mock.Anything). - Return([]agents.Song{ - {Name: "Song One", MBID: "mbid-1"}, - {Name: "Song Two", MBID: "mbid-2"}, - }, nil).Once() - - mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song1, song2}, nil).Once() - - songs, err := provider.ArtistRadio(ctx, "artist-1", 1) - - Expect(err).ToNot(HaveOccurred()) - Expect(songs).To(HaveLen(1)) - Expect(songs[0].ID).To(BeElementOf("song-1", "song-2")) - }) -}) diff --git a/core/external/provider_matching.go b/core/external/provider_matching.go new file mode 100644 index 000000000..74ad56d42 --- /dev/null +++ b/core/external/provider_matching.go @@ -0,0 +1,504 @@ +package external + +import ( + "context" + "fmt" + "math" + + "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/core/agents" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/utils/str" + "github.com/xrash/smetrics" +) + +// matchSongsToLibrary matches agent song results to local library tracks using a multi-phase +// matching algorithm that prioritizes accuracy over recall. +// +// # Algorithm Overview +// +// The algorithm matches songs from external agents (Last.fm, Deezer, etc.) to tracks in the +// local music library using four matching strategies in priority order: +// +// 1. Direct ID match: Songs with an ID field are matched directly to MediaFiles by ID +// 2. MusicBrainz Recording ID (MBID) match: Songs with MBID are matched to tracks with +// matching mbz_recording_id +// 3. ISRC match: Songs with ISRC are matched to tracks with matching ISRC tag +// 4. Title+Artist fuzzy match: Remaining songs are matched using fuzzy string comparison +// with metadata specificity scoring +// +// # Matching Priority +// +// When selecting the final result, matches are prioritized in order: ID > MBID > ISRC > Title+Artist. +// This ensures that more reliable identifiers take precedence over fuzzy text matching. +// +// # Fuzzy Matching Details +// +// For title+artist matching, the algorithm uses Jaro-Winkler similarity (threshold configurable +// via SimilarSongsMatchThreshold, default 85%). Matches are ranked by: +// +// 1. Title similarity (Jaro-Winkler score, 0.0-1.0) +// 2. Duration proximity (closer duration = higher score, 1.0 if unknown) +// 3. Specificity level (0-5, based on metadata precision): +// - Level 5: Title + Artist MBID + Album MBID (most specific) +// - Level 4: Title + Artist MBID + Album name (fuzzy) +// - Level 3: Title + Artist name + Album name (fuzzy) +// - Level 2: Title + Artist MBID +// - Level 1: Title + Artist name +// - Level 0: Title only +// 4. Album similarity (Jaro-Winkler, as final tiebreaker) +// +// # Examples +// +// Example 1 - MBID Priority: +// +// Agent returns: {Name: "Paranoid Android", MBID: "abc-123", Artist: "Radiohead"} +// Library has: [ +// {ID: "t1", Title: "Paranoid Android", MbzRecordingID: "abc-123"}, +// {ID: "t2", Title: "Paranoid Android", Artist: "Radiohead"}, +// ] +// Result: t1 (MBID match takes priority over title+artist) +// +// Example 2 - ISRC Priority: +// +// Agent returns: {Name: "Paranoid Android", ISRC: "GBAYE0000351", Artist: "Radiohead"} +// Library has: [ +// {ID: "t1", Title: "Paranoid Android", Tags: {isrc: ["GBAYE0000351"]}}, +// {ID: "t2", Title: "Paranoid Android", Artist: "Radiohead"}, +// ] +// Result: t1 (ISRC match takes priority over title+artist) +// +// Example 3 - Specificity Ranking: +// +// Agent returns: {Name: "Enjoy the Silence", Artist: "Depeche Mode", Album: "Violator"} +// Library has: [ +// {ID: "t1", Title: "Enjoy the Silence", Artist: "Depeche Mode", Album: "101"}, // Level 1 +// {ID: "t2", Title: "Enjoy the Silence", Artist: "Depeche Mode", Album: "Violator"}, // Level 3 +// ] +// Result: t2 (Level 3 beats Level 1 due to album match) +// +// Example 4 - Fuzzy Title Matching: +// +// Agent returns: {Name: "Bohemian Rhapsody", Artist: "Queen"} +// Library has: {ID: "t1", Title: "Bohemian Rhapsody - Remastered", Artist: "Queen"} +// With threshold=85%: Match succeeds (similarity ~0.87) +// With threshold=100%: No match (not exact) +// +// # Parameters +// +// - ctx: Context for database operations +// - songs: Slice of agent.Song results from external providers +// - count: Maximum number of matches to return +// +// # Returns +// +// Returns up to 'count' MediaFiles from the library that best match the input songs, +// preserving the original order from the agent. Songs that cannot be matched are skipped. +func (e *provider) matchSongsToLibrary(ctx context.Context, songs []agents.Song, count int) (model.MediaFiles, error) { + idMatches, err := e.loadTracksByID(ctx, songs) + if err != nil { + return nil, fmt.Errorf("failed to load tracks by ID: %w", err) + } + mbidMatches, err := e.loadTracksByMBID(ctx, songs, idMatches) + if err != nil { + return nil, fmt.Errorf("failed to load tracks by MBID: %w", err) + } + isrcMatches, err := e.loadTracksByISRC(ctx, songs, idMatches, mbidMatches) + if err != nil { + return nil, fmt.Errorf("failed to load tracks by ISRC: %w", err) + } + titleMatches, err := e.loadTracksByTitleAndArtist(ctx, songs, idMatches, mbidMatches, isrcMatches) + if err != nil { + return nil, fmt.Errorf("failed to load tracks by title: %w", err) + } + + return e.selectBestMatchingSongs(songs, idMatches, mbidMatches, isrcMatches, titleMatches, count), nil +} + +// songMatchedIn checks if a song has already been matched in any of the provided match maps. +// It checks the song's ID, MBID, and ISRC fields against the corresponding map keys. +func songMatchedIn(s agents.Song, priorMatches ...map[string]model.MediaFile) bool { + _, found := lookupByIdentifiers(s, priorMatches...) + return found +} + +// lookupByIdentifiers searches for a song's identifiers (ID, MBID, ISRC) in the provided maps. +// Returns the first matching MediaFile found and true, or an empty MediaFile and false if no match. +func lookupByIdentifiers(s agents.Song, maps ...map[string]model.MediaFile) (model.MediaFile, bool) { + keys := []string{s.ID, s.MBID, s.ISRC} + for _, m := range maps { + for _, key := range keys { + if key != "" { + if mf, ok := m[key]; ok && mf.ID != "" { + return mf, true + } + } + } + } + return model.MediaFile{}, false +} + +// loadTracksByID fetches MediaFiles from the library using direct ID matching. +// It extracts all non-empty ID fields from the input songs and performs a single +// batch query to the database. Returns a map keyed by MediaFile ID for O(1) lookup. +// Only non-missing files are returned. +func (e *provider) loadTracksByID(ctx context.Context, songs []agents.Song) (map[string]model.MediaFile, error) { + var ids []string + for _, s := range songs { + if s.ID != "" { + ids = append(ids, s.ID) + } + } + matches := map[string]model.MediaFile{} + if len(ids) == 0 { + return matches, nil + } + res, err := e.ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.And{ + squirrel.Eq{"media_file.id": ids}, + squirrel.Eq{"missing": false}, + }, + }) + if err != nil { + return matches, err + } + for _, mf := range res { + if _, ok := matches[mf.ID]; !ok { + matches[mf.ID] = mf + } + } + return matches, nil +} + +// loadTracksByMBID fetches MediaFiles from the library using MusicBrainz Recording IDs. +// It extracts all non-empty MBID fields from the input songs and performs a single +// batch query against the mbz_recording_id column. Returns a map keyed by MBID for +// O(1) lookup. Only non-missing files are returned. +func (e *provider) loadTracksByMBID(ctx context.Context, songs []agents.Song, priorMatches ...map[string]model.MediaFile) (map[string]model.MediaFile, error) { + var mbids []string + for _, s := range songs { + if s.MBID != "" && !songMatchedIn(s, priorMatches...) { + mbids = append(mbids, s.MBID) + } + } + matches := map[string]model.MediaFile{} + if len(mbids) == 0 { + return matches, nil + } + res, err := e.ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.And{ + squirrel.Eq{"mbz_recording_id": mbids}, + squirrel.Eq{"missing": false}, + }, + }) + if err != nil { + return matches, err + } + for _, mf := range res { + if id := mf.MbzRecordingID; id != "" { + if _, ok := matches[id]; !ok { + matches[id] = mf + } + } + } + return matches, nil +} + +// loadTracksByISRC fetches MediaFiles from the library using ISRC (International Standard +// Recording Code) matching. It extracts all non-empty ISRC fields from the input songs and +// queries the tags JSON column for matching ISRC values. Returns a map keyed by ISRC for +// O(1) lookup. Only non-missing files are returned. +func (e *provider) loadTracksByISRC(ctx context.Context, songs []agents.Song, priorMatches ...map[string]model.MediaFile) (map[string]model.MediaFile, error) { + var isrcs []string + for _, s := range songs { + if s.ISRC != "" && !songMatchedIn(s, priorMatches...) { + isrcs = append(isrcs, s.ISRC) + } + } + matches := map[string]model.MediaFile{} + if len(isrcs) == 0 { + return matches, nil + } + res, err := e.ds.MediaFile(ctx).GetAllByTags(model.TagISRC, isrcs, model.QueryOptions{ + Filters: squirrel.Eq{"missing": false}, + }) + if err != nil { + return matches, err + } + for _, mf := range res { + for _, isrc := range mf.Tags.Values(model.TagISRC) { + if _, ok := matches[isrc]; !ok { + matches[isrc] = mf + } + } + } + return matches, nil +} + +// songQuery represents a normalized query for matching a song to library tracks. +// All string fields are sanitized (lowercased, diacritics removed) for comparison. +// This struct is used internally by loadTracksByTitleAndArtist to group queries by artist. +type songQuery struct { + title string // Sanitized song title + artist string // Sanitized artist name (without articles like "The") + artistMBID string // MusicBrainz Artist ID (optional, for higher specificity matching) + album string // Sanitized album name (optional, for specificity scoring) + albumMBID string // MusicBrainz Album ID (optional, for highest specificity matching) + durationMs uint32 // Duration in milliseconds (0 means unknown, skip duration filtering) +} + +// matchScore combines title/album similarity with metadata specificity for ranking matches +type matchScore struct { + titleSimilarity float64 // 0.0-1.0 (Jaro-Winkler) + durationProximity float64 // 0.0-1.0 (closer duration = higher, 1.0 if unknown) + albumSimilarity float64 // 0.0-1.0 (Jaro-Winkler), used as tiebreaker + specificityLevel int // 0-5 (higher = more specific metadata match) +} + +// betterThan returns true if this score beats another. +// Comparison order: title similarity > duration proximity > specificity level > album similarity +func (s matchScore) betterThan(other matchScore) bool { + if s.titleSimilarity != other.titleSimilarity { + return s.titleSimilarity > other.titleSimilarity + } + if s.durationProximity != other.durationProximity { + return s.durationProximity > other.durationProximity + } + if s.specificityLevel != other.specificityLevel { + return s.specificityLevel > other.specificityLevel + } + return s.albumSimilarity > other.albumSimilarity +} + +// computeSpecificityLevel determines how well query metadata matches a track (0-5). +// Higher values indicate more specific matches (MBIDs > names > title only). +// Uses fuzzy matching for album names with the same threshold as title matching. +func computeSpecificityLevel(q songQuery, mf model.MediaFile, albumThreshold float64) int { + title := str.SanitizeFieldForSorting(mf.Title) + artist := str.SanitizeFieldForSortingNoArticle(mf.Artist) + album := str.SanitizeFieldForSorting(mf.Album) + + // Level 5: Title + Artist MBID + Album MBID (most specific) + if q.artistMBID != "" && q.albumMBID != "" && + mf.MbzArtistID == q.artistMBID && mf.MbzAlbumID == q.albumMBID { + return 5 + } + // Level 4: Title + Artist MBID + Album name (fuzzy) + if q.artistMBID != "" && q.album != "" && + mf.MbzArtistID == q.artistMBID && similarityRatio(album, q.album) >= albumThreshold { + return 4 + } + // Level 3: Title + Artist name + Album name (fuzzy) + if q.artist != "" && q.album != "" && + artist == q.artist && similarityRatio(album, q.album) >= albumThreshold { + return 3 + } + // Level 2: Title + Artist MBID + if q.artistMBID != "" && mf.MbzArtistID == q.artistMBID { + return 2 + } + // Level 1: Title + Artist name + if q.artist != "" && artist == q.artist { + return 1 + } + // Level 0: Title only match (but for fuzzy, title matched via similarity) + // Check if at least the title matches exactly + if title == q.title { + return 0 + } + return -1 // No exact title match, but could still be a fuzzy match +} + +// loadTracksByTitleAndArtist loads tracks matching by title with optional artist/album filtering. +// Uses a unified scoring approach that combines title similarity (Jaro-Winkler) with +// metadata specificity (MBIDs, album names) for both exact and fuzzy matches. +// Returns a map keyed by "title|artist" for compatibility with selectBestMatchingSongs. +func (e *provider) loadTracksByTitleAndArtist(ctx context.Context, songs []agents.Song, priorMatches ...map[string]model.MediaFile) (map[string]model.MediaFile, error) { + queries := e.buildTitleQueries(songs, priorMatches...) + if len(queries) == 0 { + return map[string]model.MediaFile{}, nil + } + + threshold := float64(conf.Server.SimilarSongsMatchThreshold) / 100.0 + + // Group queries by artist for efficient DB access + byArtist := map[string][]songQuery{} + for _, q := range queries { + if q.artist != "" { + byArtist[q.artist] = append(byArtist[q.artist], q) + } + } + + matches := map[string]model.MediaFile{} + for artist, artistQueries := range byArtist { + // Single DB query per artist - get all their tracks + tracks, err := e.ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.And{ + squirrel.Eq{"order_artist_name": artist}, + squirrel.Eq{"missing": false}, + }, + Sort: "starred desc, rating desc, year asc, compilation asc", + }) + if err != nil { + continue + } + + // Find best match for each query using unified scoring + for _, q := range artistQueries { + if mf, found := e.findBestMatch(q, tracks, threshold); found { + key := q.title + "|" + q.artist + if _, exists := matches[key]; !exists { + matches[key] = mf + } + } + } + } + return matches, nil +} + +// durationProximity returns a score from 0.0 to 1.0 indicating how close +// the track's duration is to the target. A perfect match returns 1.0, and the +// score decreases as the difference grows (using 1 / (1 + diff)). Returns 1.0 +// if durationMs is 0 (unknown), so duration does not influence scoring. +func durationProximity(durationMs uint32, mediaFileDurationSec float32) float64 { + if durationMs <= 0 { + return 1.0 // Unknown duration — don't penalise + } + durationSec := float64(durationMs) / 1000.0 + diff := math.Abs(durationSec - float64(mediaFileDurationSec)) + return 1.0 / (1.0 + diff) +} + +// findBestMatch finds the best matching track using combined title/album similarity and specificity scoring. +// A track must meet the threshold for title similarity, then the best match is chosen by: +// 1. Highest title similarity +// 2. Duration proximity (closer duration = higher score, 1.0 if unknown) +// 3. Highest specificity level +// 4. Highest album similarity (as final tiebreaker) +func (e *provider) findBestMatch(q songQuery, tracks model.MediaFiles, threshold float64) (model.MediaFile, bool) { + var bestMatch model.MediaFile + bestScore := matchScore{titleSimilarity: -1} + found := false + + for _, mf := range tracks { + trackTitle := str.SanitizeFieldForSorting(mf.Title) + titleSim := similarityRatio(q.title, trackTitle) + + if titleSim < threshold { + continue + } + + // Compute album similarity for tiebreaking (0.0 if no album in query) + var albumSim float64 + if q.album != "" { + trackAlbum := str.SanitizeFieldForSorting(mf.Album) + albumSim = similarityRatio(q.album, trackAlbum) + } + + score := matchScore{ + titleSimilarity: titleSim, + durationProximity: durationProximity(q.durationMs, mf.Duration), + albumSimilarity: albumSim, + specificityLevel: computeSpecificityLevel(q, mf, threshold), + } + + if score.betterThan(bestScore) { + bestScore = score + bestMatch = mf + found = true + } + } + return bestMatch, found +} + +// buildTitleQueries converts agent songs into normalized songQuery structs for title+artist matching. +// It skips songs that have already been matched in prior phases (by ID, MBID, or ISRC) and sanitizes +// all string fields for consistent comparison (lowercase, diacritics removed, articles stripped from artist names). +func (e *provider) buildTitleQueries(songs []agents.Song, priorMatches ...map[string]model.MediaFile) []songQuery { + var queries []songQuery + for _, s := range songs { + if songMatchedIn(s, priorMatches...) { + continue + } + queries = append(queries, songQuery{ + title: str.SanitizeFieldForSorting(s.Name), + artist: str.SanitizeFieldForSortingNoArticle(s.Artist), + artistMBID: s.ArtistMBID, + album: str.SanitizeFieldForSorting(s.Album), + albumMBID: s.AlbumMBID, + durationMs: s.Duration, + }) + } + return queries +} + +// selectBestMatchingSongs assembles the final result by mapping input songs to their best matching +// library tracks. It iterates through the input songs in order and selects the first available match +// using priority order: ID > MBID > ISRC > title+artist. +// +// The function also handles deduplication: when multiple different input songs would match the same +// library track (e.g., "Song (Live)" and "Song (Remastered)" both matching "Song (Live)" in the library), +// only the first match is kept. However, if the same input song appears multiple times (intentional +// repetition), duplicates are preserved in the output. +// +// Returns up to 'count' MediaFiles, preserving the input order. Songs that cannot be matched are skipped. +func (e *provider) selectBestMatchingSongs(songs []agents.Song, byID, byMBID, byISRC, byTitleArtist map[string]model.MediaFile, count int) model.MediaFiles { + mfs := make(model.MediaFiles, 0, len(songs)) + // Track MediaFile.ID -> input song that added it, for deduplication + addedBy := make(map[string]agents.Song, len(songs)) + + for _, t := range songs { + if len(mfs) == count { + break + } + + mf, found := findMatchingTrack(t, byID, byMBID, byISRC, byTitleArtist) + if !found { + continue + } + + // Check for duplicate library track + if prevSong, alreadyAdded := addedBy[mf.ID]; alreadyAdded { + // Only add duplicate if input songs are identical + if t != prevSong { + continue // Different input songs → skip mismatch-induced duplicate + } + } else { + addedBy[mf.ID] = t + } + + mfs = append(mfs, mf) + } + return mfs +} + +// findMatchingTrack looks up a song in the match maps using priority order: ID > MBID > ISRC > title+artist. +// Returns the matched MediaFile and true if found, or an empty MediaFile and false if no match exists. +func findMatchingTrack(t agents.Song, byID, byMBID, byISRC, byTitleArtist map[string]model.MediaFile) (model.MediaFile, bool) { + // Try identifier-based matches first (ID, MBID, ISRC) + if mf, found := lookupByIdentifiers(t, byID, byMBID, byISRC); found { + return mf, true + } + // Fall back to title+artist fuzzy match + key := str.SanitizeFieldForSorting(t.Name) + "|" + str.SanitizeFieldForSortingNoArticle(t.Artist) + if mf, ok := byTitleArtist[key]; ok { + return mf, true + } + return model.MediaFile{}, false +} + +// similarityRatio calculates the similarity between two strings using Jaro-Winkler algorithm. +// Returns a value between 0.0 (completely different) and 1.0 (identical). +// Jaro-Winkler is well-suited for matching song titles because it gives higher scores +// when strings share a common prefix (e.g., "Song Title" vs "Song Title - Remastered"). +func similarityRatio(a, b string) float64 { + if a == b { + return 1.0 + } + if len(a) == 0 || len(b) == 0 { + return 0.0 + } + // JaroWinkler params: boostThreshold=0.7, prefixSize=4 + return smetrics.JaroWinkler(a, b, 0.7, 4) +} diff --git a/core/external/provider_matching_internal_test.go b/core/external/provider_matching_internal_test.go new file mode 100644 index 000000000..5b9ccea3b --- /dev/null +++ b/core/external/provider_matching_internal_test.go @@ -0,0 +1,57 @@ +package external + +import ( + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("similarityRatio", func() { + It("returns 1.0 for identical strings", func() { + Expect(similarityRatio("hello", "hello")).To(BeNumerically("==", 1.0)) + }) + + It("returns 0.0 for empty strings", func() { + Expect(similarityRatio("", "test")).To(BeNumerically("==", 0.0)) + Expect(similarityRatio("test", "")).To(BeNumerically("==", 0.0)) + }) + + It("returns high similarity for remastered suffix", func() { + // Jaro-Winkler gives ~0.92 for this case + ratio := similarityRatio("paranoid android", "paranoid android remastered") + Expect(ratio).To(BeNumerically(">=", 0.85)) + }) + + It("returns high similarity for suffix additions like (Live)", func() { + // Jaro-Winkler gives ~0.96 for this case + ratio := similarityRatio("bohemian rhapsody", "bohemian rhapsody live") + Expect(ratio).To(BeNumerically(">=", 0.90)) + }) + + It("returns high similarity for 'yesterday' variants (common prefix)", func() { + // Jaro-Winkler gives ~0.90 because of common prefix + ratio := similarityRatio("yesterday", "yesterday once more") + Expect(ratio).To(BeNumerically(">=", 0.85)) + }) + + It("returns low similarity for same suffix", func() { + // Jaro-Winkler gives ~0.70 for this case + ratio := similarityRatio("postman (live)", "taxman (live)") + Expect(ratio).To(BeNumerically("<", 0.85)) + }) + + It("handles unicode characters", func() { + ratio := similarityRatio("dont stop believin", "don't stop believin'") + Expect(ratio).To(BeNumerically(">=", 0.85)) + }) + + It("returns low similarity for completely different strings", func() { + ratio := similarityRatio("abc", "xyz") + Expect(ratio).To(BeNumerically("<", 0.5)) + }) + + It("is symmetric", func() { + ratio1 := similarityRatio("hello world", "hello") + ratio2 := similarityRatio("hello", "hello world") + Expect(ratio1).To(Equal(ratio2)) + }) +}) diff --git a/core/external/provider_matching_test.go b/core/external/provider_matching_test.go new file mode 100644 index 000000000..b3624ef3a --- /dev/null +++ b/core/external/provider_matching_test.go @@ -0,0 +1,762 @@ +package external_test + +import ( + "context" + + "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/core/agents" + . "github.com/navidrome/navidrome/core/external" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + "github.com/stretchr/testify/mock" +) + +var _ = Describe("Provider - Song Matching", func() { + var ds model.DataStore + var provider Provider + var agentsCombined *mockAgents + var artistRepo *mockArtistRepo + var mediaFileRepo *mockMediaFileRepo + var albumRepo *mockAlbumRepo + var ctx context.Context + + BeforeEach(func() { + ctx = GinkgoT().Context() + + artistRepo = newMockArtistRepo() + mediaFileRepo = newMockMediaFileRepo() + albumRepo = newMockAlbumRepo() + + ds = &tests.MockDataStore{ + MockedArtist: artistRepo, + MockedMediaFile: mediaFileRepo, + MockedAlbum: albumRepo, + } + + agentsCombined = &mockAgents{} + provider = NewProvider(ds, agentsCombined) + }) + + // Shared helper for tests that only need artist track queries (no ID/MBID matching) + setupSimilarSongsExpectations := func(returnedSongs []agents.Song, artistTracks model.MediaFiles) { + agentsCombined.On("GetSimilarSongsByTrack", mock.Anything, mock.Anything, mock.Anything, mock.Anything, mock.Anything, mock.Anything). + Return(returnedSongs, nil).Once() + + // loadTracksByTitleAndArtist - queries by artist name + mediaFileRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + and, ok := opt.Filters.(squirrel.And) + if !ok || len(and) < 2 { + return false + } + eq, hasEq := and[0].(squirrel.Eq) + if !hasEq { + return false + } + _, hasArtist := eq["order_artist_name"] + return hasArtist + })).Return(artistTracks, nil).Maybe() + } + + Describe("matchSongsToLibrary priority matching", func() { + var track model.MediaFile + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + // Disable fuzzy matching for these tests to avoid unexpected GetAll calls + conf.Server.SimilarSongsMatchThreshold = 100 + + track = model.MediaFile{ID: "track-1", Title: "Test Track", Artist: "Test Artist", MbzRecordingID: ""} + + // Setup for GetEntityByID to return the track + artistRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + albumRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + mediaFileRepo.On("Get", "track-1").Return(&track, nil).Once() + }) + + setupExpectations := func(returnedSongs []agents.Song, idMatches, mbidMatches, artistTracks model.MediaFiles) { + agentsCombined.On("GetSimilarSongsByTrack", mock.Anything, mock.Anything, mock.Anything, mock.Anything, mock.Anything, mock.Anything). + Return(returnedSongs, nil).Once() + + // loadTracksByID + mediaFileRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + _, ok := opt.Filters.(squirrel.Eq) + return ok + })).Return(idMatches, nil).Once() + + // loadTracksByMBID + mediaFileRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + and, ok := opt.Filters.(squirrel.And) + if !ok || len(and) < 1 { + return false + } + eq, hasEq := and[0].(squirrel.Eq) + if !hasEq { + return false + } + _, hasMBID := eq["mbz_recording_id"] + return hasMBID + })).Return(mbidMatches, nil).Once() + + // loadTracksByTitleAndArtist - now queries by artist name + mediaFileRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + and, ok := opt.Filters.(squirrel.And) + if !ok || len(and) < 2 { + return false + } + eq, hasEq := and[0].(squirrel.Eq) + if !hasEq { + return false + } + _, hasArtist := eq["order_artist_name"] + return hasArtist + })).Return(artistTracks, nil).Maybe() + } + + Context("when agent returns artist and album metadata", func() { + It("matches by title + artist MBID + album MBID (highest priority)", func() { + // Song in library with all MBIDs + correctMatch := model.MediaFile{ + ID: "correct-match", Title: "Similar Song", Artist: "Depeche Mode", Album: "Violator", + MbzArtistID: "artist-mbid-123", MbzAlbumID: "album-mbid-456", + } + // Another song with same title but different MBIDs (should NOT match) + wrongMatch := model.MediaFile{ + ID: "wrong-match", Title: "Similar Song", Artist: "Depeche Mode", Album: "Some Other Album", + MbzArtistID: "artist-mbid-123", MbzAlbumID: "different-album-mbid", + } + returnedSongs := []agents.Song{ + {Name: "Similar Song", Artist: "Depeche Mode", ArtistMBID: "artist-mbid-123", Album: "Violator", AlbumMBID: "album-mbid-456"}, + } + + setupExpectations(returnedSongs, model.MediaFiles{}, model.MediaFiles{}, model.MediaFiles{wrongMatch, correctMatch}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("correct-match")) + }) + + It("matches by title + artist name + album name when MBIDs unavailable", func() { + // Song in library without MBIDs but with matching artist/album names + correctMatch := model.MediaFile{ + ID: "correct-match", Title: "Similar Song", Artist: "depeche mode", Album: "violator", + } + // Another song with same title but different artist (should NOT match) + wrongMatch := model.MediaFile{ + ID: "wrong-match", Title: "Similar Song", Artist: "Other Artist", Album: "Other Album", + } + + returnedSongs := []agents.Song{ + {Name: "Similar Song", Artist: "Depeche Mode", Album: "Violator"}, // No MBIDs + } + + setupExpectations(returnedSongs, model.MediaFiles{}, model.MediaFiles{}, model.MediaFiles{wrongMatch, correctMatch}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("correct-match")) + }) + + It("matches by title + artist only when album info unavailable", func() { + // Song in library with matching artist + correctMatch := model.MediaFile{ + ID: "correct-match", Title: "Similar Song", Artist: "depeche mode", Album: "Some Album", + } + // Another song with same title but different artist + wrongMatch := model.MediaFile{ + ID: "wrong-match", Title: "Similar Song", Artist: "Other Artist", Album: "Other Album", + } + returnedSongs := []agents.Song{ + {Name: "Similar Song", Artist: "Depeche Mode"}, // No album info + } + + setupExpectations(returnedSongs, model.MediaFiles{}, model.MediaFiles{}, model.MediaFiles{wrongMatch, correctMatch}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("correct-match")) + }) + + It("does not match songs without artist info", func() { + // Songs without artist info cannot be matched since we query by artist + returnedSongs := []agents.Song{ + {Name: "Similar Song"}, // No artist/album info at all + } + + // No artist to query, so no GetAll calls for title matching + setupExpectations(returnedSongs, model.MediaFiles{}, model.MediaFiles{}, model.MediaFiles{}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(BeEmpty()) + }) + }) + + Context("when matching multiple songs with the same title but different artists", func() { + It("returns distinct matches for each artist's version (covers scenario)", func() { + // Multiple covers of the same song by different artists + cover1 := model.MediaFile{ + ID: "cover-1", Title: "Yesterday", Artist: "The Beatles", Album: "Help!", + } + cover2 := model.MediaFile{ + ID: "cover-2", Title: "Yesterday", Artist: "Ray Charles", Album: "Greatest Hits", + } + cover3 := model.MediaFile{ + ID: "cover-3", Title: "Yesterday", Artist: "Frank Sinatra", Album: "My Way", + } + + returnedSongs := []agents.Song{ + {Name: "Yesterday", Artist: "The Beatles", Album: "Help!"}, + {Name: "Yesterday", Artist: "Ray Charles", Album: "Greatest Hits"}, + {Name: "Yesterday", Artist: "Frank Sinatra", Album: "My Way"}, + } + + setupExpectations(returnedSongs, model.MediaFiles{}, model.MediaFiles{}, model.MediaFiles{cover1, cover2, cover3}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + // All three covers should be returned, not just the first one + Expect(songs).To(HaveLen(3)) + // Verify all three different versions are included + ids := []string{songs[0].ID, songs[1].ID, songs[2].ID} + Expect(ids).To(ContainElements("cover-1", "cover-2", "cover-3")) + }) + }) + + Context("when matching multiple songs with different precision levels", func() { + It("prefers more precise matches for each song", func() { + // Library has multiple versions of same song + preciseMatch := model.MediaFile{ + ID: "precise", Title: "Song A", Artist: "Artist One", Album: "Album One", + MbzArtistID: "mbid-1", MbzAlbumID: "album-mbid-1", + } + lessAccurateMatch := model.MediaFile{ + ID: "less-accurate", Title: "Song A", Artist: "Artist One", Album: "Compilation", + MbzArtistID: "mbid-1", + } + artistTwoMatch := model.MediaFile{ + ID: "artist-two", Title: "Song B", Artist: "Artist Two", + } + + returnedSongs := []agents.Song{ + {Name: "Song A", Artist: "Artist One", ArtistMBID: "mbid-1", Album: "Album One", AlbumMBID: "album-mbid-1"}, + {Name: "Song B", Artist: "Artist Two"}, // Different artist + } + + setupExpectations(returnedSongs, model.MediaFiles{}, model.MediaFiles{}, model.MediaFiles{lessAccurateMatch, preciseMatch, artistTwoMatch}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(2)) + // First song should be the precise match (has all MBIDs) + Expect(songs[0].ID).To(Equal("precise")) + // Second song matches by title + artist + Expect(songs[1].ID).To(Equal("artist-two")) + }) + }) + }) + + Describe("Fuzzy matching fallback", func() { + var track model.MediaFile + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + track = model.MediaFile{ID: "track-1", Title: "Test Track", Artist: "Test Artist"} + + // Setup for GetEntityByID to return the track + artistRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + albumRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + mediaFileRepo.On("Get", "track-1").Return(&track, nil).Once() + }) + + Context("with default threshold (85%)", func() { + It("matches songs with remastered suffix", func() { + conf.Server.SimilarSongsMatchThreshold = 85 + + // Agent returns "Paranoid Android" but library has "Paranoid Android - Remastered" + returnedSongs := []agents.Song{ + {Name: "Paranoid Android", Artist: "Radiohead"}, + } + // Artist catalog has the remastered version (fuzzy match will find it) + artistTracks := model.MediaFiles{ + {ID: "remastered", Title: "Paranoid Android - Remastered", Artist: "Radiohead"}, + } + + setupSimilarSongsExpectations(returnedSongs, artistTracks) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("remastered")) + }) + + It("matches songs with live suffix", func() { + conf.Server.SimilarSongsMatchThreshold = 85 + + returnedSongs := []agents.Song{ + {Name: "Bohemian Rhapsody", Artist: "Queen"}, + } + artistTracks := model.MediaFiles{ + {ID: "live", Title: "Bohemian Rhapsody (Live)", Artist: "Queen"}, + } + + setupSimilarSongsExpectations(returnedSongs, artistTracks) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("live")) + }) + + It("does not match completely different songs", func() { + conf.Server.SimilarSongsMatchThreshold = 85 + + returnedSongs := []agents.Song{ + {Name: "Yesterday", Artist: "The Beatles"}, + } + // Artist catalog has completely different songs + artistTracks := model.MediaFiles{ + {ID: "different", Title: "Tomorrow Never Knows", Artist: "The Beatles"}, + {ID: "different2", Title: "Here Comes The Sun", Artist: "The Beatles"}, + } + + setupSimilarSongsExpectations(returnedSongs, artistTracks) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(BeEmpty()) + }) + }) + + Context("with threshold set to 100 (exact match only)", func() { + It("only matches exact titles", func() { + conf.Server.SimilarSongsMatchThreshold = 100 + + returnedSongs := []agents.Song{ + {Name: "Paranoid Android", Artist: "Radiohead"}, + } + // Artist catalog has only remastered version - no exact match + artistTracks := model.MediaFiles{ + {ID: "remastered", Title: "Paranoid Android - Remastered", Artist: "Radiohead"}, + } + + setupSimilarSongsExpectations(returnedSongs, artistTracks) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(BeEmpty()) + }) + }) + + Context("with lower threshold (75%)", func() { + It("matches more aggressively", func() { + conf.Server.SimilarSongsMatchThreshold = 75 + + returnedSongs := []agents.Song{ + {Name: "Song", Artist: "Artist"}, + } + artistTracks := model.MediaFiles{ + {ID: "extended", Title: "Song (Extended Mix)", Artist: "Artist"}, + } + + setupSimilarSongsExpectations(returnedSongs, artistTracks) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("extended")) + }) + }) + + Context("with fuzzy album matching", func() { + It("matches album with (Remaster) suffix", func() { + conf.Server.SimilarSongsMatchThreshold = 85 + + // Agent returns "A Night at the Opera" but library has remastered version + returnedSongs := []agents.Song{ + {Name: "Bohemian Rhapsody", Artist: "Queen", Album: "A Night at the Opera"}, + } + // Library has same album with remaster suffix + correctMatch := model.MediaFile{ + ID: "correct", Title: "Bohemian Rhapsody", Artist: "Queen", Album: "A Night at the Opera (2011 Remaster)", + } + wrongMatch := model.MediaFile{ + ID: "wrong", Title: "Bohemian Rhapsody", Artist: "Queen", Album: "Greatest Hits", + } + + setupSimilarSongsExpectations(returnedSongs, model.MediaFiles{wrongMatch, correctMatch}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + // Should prefer the fuzzy album match (Level 3) over title+artist only (Level 1) + Expect(songs[0].ID).To(Equal("correct")) + }) + + It("matches album with (Deluxe Edition) suffix", func() { + conf.Server.SimilarSongsMatchThreshold = 85 + + returnedSongs := []agents.Song{ + {Name: "Enjoy the Silence", Artist: "Depeche Mode", Album: "Violator"}, + } + correctMatch := model.MediaFile{ + ID: "correct", Title: "Enjoy the Silence", Artist: "Depeche Mode", Album: "Violator (Deluxe Edition)", + } + wrongMatch := model.MediaFile{ + ID: "wrong", Title: "Enjoy the Silence", Artist: "Depeche Mode", Album: "101", + } + + setupSimilarSongsExpectations(returnedSongs, model.MediaFiles{wrongMatch, correctMatch}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("correct")) + }) + + It("prefers exact album match over fuzzy album match", func() { + conf.Server.SimilarSongsMatchThreshold = 85 + + returnedSongs := []agents.Song{ + {Name: "Enjoy the Silence", Artist: "Depeche Mode", Album: "Violator"}, + } + exactMatch := model.MediaFile{ + ID: "exact", Title: "Enjoy the Silence", Artist: "Depeche Mode", Album: "Violator", + } + fuzzyMatch := model.MediaFile{ + ID: "fuzzy", Title: "Enjoy the Silence", Artist: "Depeche Mode", Album: "Violator (Deluxe Edition)", + } + + setupSimilarSongsExpectations(returnedSongs, model.MediaFiles{fuzzyMatch, exactMatch}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + // Both have same title similarity (1.0), so should prefer exact album match (higher specificity via higher album similarity) + Expect(songs[0].ID).To(Equal("exact")) + }) + }) + }) + + Describe("Duration matching", func() { + var track model.MediaFile + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.SimilarSongsMatchThreshold = 100 // Exact title match for predictable tests + + track = model.MediaFile{ID: "track-1", Title: "Test Track", Artist: "Test Artist"} + + // Setup for GetEntityByID to return the track + artistRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + albumRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + mediaFileRepo.On("Get", "track-1").Return(&track, nil).Once() + }) + + Context("when agent provides duration", func() { + It("prefers tracks with matching duration", func() { + // Agent returns song with duration 180000ms (180 seconds) + returnedSongs := []agents.Song{ + {Name: "Similar Song", Artist: "Test Artist", Duration: 180000}, + } + // Library has two versions: one matching duration, one not + correctMatch := model.MediaFile{ + ID: "correct", Title: "Similar Song", Artist: "Test Artist", Duration: 180.0, + } + wrongDuration := model.MediaFile{ + ID: "wrong", Title: "Similar Song", Artist: "Test Artist", Duration: 240.0, + } + + setupSimilarSongsExpectations(returnedSongs, model.MediaFiles{wrongDuration, correctMatch}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("correct")) + }) + + It("matches tracks with close duration", func() { + // Agent returns song with duration 180000ms (180 seconds) + returnedSongs := []agents.Song{ + {Name: "Similar Song", Artist: "Test Artist", Duration: 180000}, + } + // Library has track with 182.5 seconds (close to target) + closeDuration := model.MediaFile{ + ID: "close-duration", Title: "Similar Song", Artist: "Test Artist", Duration: 182.5, + } + + setupSimilarSongsExpectations(returnedSongs, model.MediaFiles{closeDuration}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("close-duration")) + }) + + It("prefers closer duration over farther duration", func() { + // Agent returns song with duration 180000ms (180 seconds) + returnedSongs := []agents.Song{ + {Name: "Similar Song", Artist: "Test Artist", Duration: 180000}, + } + // Library has one close, one far + closeDuration := model.MediaFile{ + ID: "close", Title: "Similar Song", Artist: "Test Artist", Duration: 181.0, + } + farDuration := model.MediaFile{ + ID: "far", Title: "Similar Song", Artist: "Test Artist", Duration: 190.0, + } + + setupSimilarSongsExpectations(returnedSongs, model.MediaFiles{farDuration, closeDuration}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("close")) + }) + + It("still matches when no tracks have matching duration", func() { + // Agent returns song with duration 180000ms + returnedSongs := []agents.Song{ + {Name: "Similar Song", Artist: "Test Artist", Duration: 180000}, + } + // Library only has tracks with very different duration + differentDuration := model.MediaFile{ + ID: "different", Title: "Similar Song", Artist: "Test Artist", Duration: 300.0, + } + + setupSimilarSongsExpectations(returnedSongs, model.MediaFiles{differentDuration}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + // Duration mismatch doesn't exclude the track; it's just scored lower + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("different")) + }) + + It("prefers title match over duration match when titles differ", func() { + // Agent returns "Similar Song" with duration 180000ms + returnedSongs := []agents.Song{ + {Name: "Similar Song", Artist: "Test Artist", Duration: 180000}, + } + // Library has: + // - differentTitle: matches duration but has different title (won't pass title threshold) + // - correctTitle: doesn't match duration but has correct title (wins on title similarity) + differentTitle := model.MediaFile{ + ID: "wrong-title", Title: "Different Song", Artist: "Test Artist", Duration: 180.0, + } + correctTitle := model.MediaFile{ + ID: "correct-title", Title: "Similar Song", Artist: "Test Artist", Duration: 300.0, + } + + setupSimilarSongsExpectations(returnedSongs, model.MediaFiles{differentTitle, correctTitle}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + // Title similarity is the top priority, so the correct title wins despite duration mismatch + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("correct-title")) + }) + }) + + Context("when agent does not provide duration", func() { + It("matches without duration filtering (duration=0)", func() { + // Agent returns song without duration + returnedSongs := []agents.Song{ + {Name: "Similar Song", Artist: "Test Artist", Duration: 0}, + } + // Library tracks with various durations should all be candidates + anyTrack := model.MediaFile{ + ID: "any", Title: "Similar Song", Artist: "Test Artist", Duration: 999.0, + } + + setupSimilarSongsExpectations(returnedSongs, model.MediaFiles{anyTrack}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("any")) + }) + }) + + Context("edge cases", func() { + It("handles very short songs with close duration", func() { + // 30-second song with 1-second difference + returnedSongs := []agents.Song{ + {Name: "Short Song", Artist: "Test Artist", Duration: 30000}, + } + shortTrack := model.MediaFile{ + ID: "short", Title: "Short Song", Artist: "Test Artist", Duration: 31.0, + } + + setupSimilarSongsExpectations(returnedSongs, model.MediaFiles{shortTrack}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("short")) + }) + }) + }) + + Describe("Deduplication of mismatched songs", func() { + var track model.MediaFile + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.SimilarSongsMatchThreshold = 85 // Allow fuzzy matching + + track = model.MediaFile{ID: "track-1", Title: "Test Track", Artist: "Test Artist"} + + // Setup for GetEntityByID to return the track + artistRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + albumRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + mediaFileRepo.On("Get", "track-1").Return(&track, nil).Once() + }) + + It("removes duplicates when different input songs match the same library track", func() { + // Agent returns two different versions that will both fuzzy-match to the same library track + returnedSongs := []agents.Song{ + {Name: "Bohemian Rhapsody (Live)", Artist: "Queen"}, + {Name: "Bohemian Rhapsody (Original Mix)", Artist: "Queen"}, + } + // Library only has one version + libraryTrack := model.MediaFile{ + ID: "br-live", Title: "Bohemian Rhapsody (Live)", Artist: "Queen", + } + + setupSimilarSongsExpectations(returnedSongs, model.MediaFiles{libraryTrack}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + // Should only return one track, not two duplicates + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("br-live")) + }) + + It("preserves duplicates when identical input songs match the same library track", func() { + // Agent returns the exact same song twice (intentional repetition) + returnedSongs := []agents.Song{ + {Name: "Bohemian Rhapsody", Artist: "Queen", Album: "A Night at the Opera"}, + {Name: "Bohemian Rhapsody", Artist: "Queen", Album: "A Night at the Opera"}, + } + // Library has matching track + libraryTrack := model.MediaFile{ + ID: "br", Title: "Bohemian Rhapsody", Artist: "Queen", Album: "A Night at the Opera", + } + + setupSimilarSongsExpectations(returnedSongs, model.MediaFiles{libraryTrack}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + // Should return two tracks since input songs were identical + Expect(songs).To(HaveLen(2)) + Expect(songs[0].ID).To(Equal("br")) + Expect(songs[1].ID).To(Equal("br")) + }) + + It("handles mixed scenario with both identical and different input songs", func() { + // Agent returns: Song A, Song B (different from A), Song A again (same as first) + // All three match to the same library track + returnedSongs := []agents.Song{ + {Name: "Yesterday", Artist: "The Beatles", Album: "Help!"}, + {Name: "Yesterday (Remastered)", Artist: "The Beatles", Album: "1"}, // Different version + {Name: "Yesterday", Artist: "The Beatles", Album: "Help!"}, // Same as first + {Name: "Yesterday (Anthology)", Artist: "The Beatles", Album: "Anthology"}, // Another different version + } + // Library only has one version + libraryTrack := model.MediaFile{ + ID: "yesterday", Title: "Yesterday", Artist: "The Beatles", Album: "Help!", + } + + setupSimilarSongsExpectations(returnedSongs, model.MediaFiles{libraryTrack}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + // Should return 2 tracks: + // 1. First "Yesterday" (original) + // 2. Third "Yesterday" (same as first, so kept) + // Skip: Second "Yesterday (Remastered)" (different input, same library track) + // Skip: Fourth "Yesterday (Anthology)" (different input, same library track) + Expect(songs).To(HaveLen(2)) + Expect(songs[0].ID).To(Equal("yesterday")) + Expect(songs[1].ID).To(Equal("yesterday")) + }) + + It("does not deduplicate songs that match different library tracks", func() { + // Agent returns different songs that match different library tracks + returnedSongs := []agents.Song{ + {Name: "Song A", Artist: "Artist"}, + {Name: "Song B", Artist: "Artist"}, + {Name: "Song C", Artist: "Artist"}, + } + // Library has all three songs + trackA := model.MediaFile{ID: "track-a", Title: "Song A", Artist: "Artist"} + trackB := model.MediaFile{ID: "track-b", Title: "Song B", Artist: "Artist"} + trackC := model.MediaFile{ID: "track-c", Title: "Song C", Artist: "Artist"} + + setupSimilarSongsExpectations(returnedSongs, model.MediaFiles{trackA, trackB, trackC}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + // All three should be returned since they match different library tracks + Expect(songs).To(HaveLen(3)) + Expect(songs[0].ID).To(Equal("track-a")) + Expect(songs[1].ID).To(Equal("track-b")) + Expect(songs[2].ID).To(Equal("track-c")) + }) + + It("respects count limit after deduplication", func() { + // Agent returns 4 songs: 2 unique + 2 that would create duplicates + returnedSongs := []agents.Song{ + {Name: "Song A", Artist: "Artist"}, + {Name: "Song A (Live)", Artist: "Artist"}, // Different, matches same track + {Name: "Song B", Artist: "Artist"}, + {Name: "Song B (Remix)", Artist: "Artist"}, // Different, matches same track + } + trackA := model.MediaFile{ID: "track-a", Title: "Song A", Artist: "Artist"} + trackB := model.MediaFile{ID: "track-b", Title: "Song B", Artist: "Artist"} + + setupSimilarSongsExpectations(returnedSongs, model.MediaFiles{trackA, trackB}) + + // Request only 2 songs + songs, err := provider.SimilarSongs(ctx, "track-1", 2) + + Expect(err).ToNot(HaveOccurred()) + // Should return exactly 2: Song A and Song B (skipping duplicates) + Expect(songs).To(HaveLen(2)) + Expect(songs[0].ID).To(Equal("track-a")) + Expect(songs[1].ID).To(Equal("track-b")) + }) + }) +}) diff --git a/core/external/provider_similarsongs_test.go b/core/external/provider_similarsongs_test.go new file mode 100644 index 000000000..1491d394e --- /dev/null +++ b/core/external/provider_similarsongs_test.go @@ -0,0 +1,443 @@ +package external_test + +import ( + "context" + "errors" + + "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/core/agents" + . "github.com/navidrome/navidrome/core/external" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + "github.com/stretchr/testify/mock" +) + +var _ = Describe("Provider - SimilarSongs", func() { + var ds model.DataStore + var provider Provider + var mockAgent *mockSimilarArtistAgent + var mockTopAgent agents.ArtistTopSongsRetriever + var mockSimilarAgent agents.ArtistSimilarRetriever + var agentsCombined *mockAgents + var artistRepo *mockArtistRepo + var mediaFileRepo *mockMediaFileRepo + var albumRepo *mockAlbumRepo + var ctx context.Context + + BeforeEach(func() { + ctx = GinkgoT().Context() + + artistRepo = newMockArtistRepo() + mediaFileRepo = newMockMediaFileRepo() + albumRepo = newMockAlbumRepo() + + ds = &tests.MockDataStore{ + MockedArtist: artistRepo, + MockedMediaFile: mediaFileRepo, + MockedAlbum: albumRepo, + } + + mockAgent = &mockSimilarArtistAgent{} + mockTopAgent = mockAgent + mockSimilarAgent = mockAgent + + agentsCombined = &mockAgents{ + topSongsAgent: mockTopAgent, + similarAgent: mockSimilarAgent, + } + + provider = NewProvider(ds, agentsCombined) + }) + + Describe("dispatch by entity type", func() { + Context("when ID is a MediaFile (track)", func() { + It("calls GetSimilarSongsByTrack and returns matched songs", func() { + track := model.MediaFile{ID: "track-1", Title: "Just Can't Get Enough", Artist: "Depeche Mode", MbzRecordingID: "track-mbid"} + matchedSong := model.MediaFile{ID: "matched-1", Title: "Dreaming of Me", Artist: "Depeche Mode"} + + // GetEntityByID tries Artist, Album, Playlist, then MediaFile + artistRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + albumRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + mediaFileRepo.On("Get", "track-1").Return(&track, nil).Once() + + agentsCombined.On("GetSimilarSongsByTrack", mock.Anything, "track-1", "Just Can't Get Enough", "Depeche Mode", "track-mbid", 5). + Return([]agents.Song{ + {Name: "Dreaming of Me", MBID: "", Artist: "Depeche Mode", ArtistMBID: "artist-mbid"}, + }, nil).Once() + + // Mock loadTracksByID - no ID matches + mediaFileRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + _, ok := opt.Filters.(squirrel.Eq) + return ok + })).Return(model.MediaFiles{}, nil).Once() + + // Mock loadTracksByMBID - no MBID matches (empty MBID means this won't be called) + mediaFileRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + and, ok := opt.Filters.(squirrel.And) + if !ok || len(and) < 1 { + return false + } + eq, hasEq := and[0].(squirrel.Eq) + if !hasEq { + return false + } + _, hasMBID := eq["mbz_recording_id"] + return hasMBID + })).Return(model.MediaFiles{}, nil).Maybe() + + // Mock loadTracksByTitleAndArtist - queries by artist name + mediaFileRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + and, ok := opt.Filters.(squirrel.And) + if !ok || len(and) < 2 { + return false + } + eq, hasEq := and[0].(squirrel.Eq) + if !hasEq { + return false + } + _, hasArtist := eq["order_artist_name"] + return hasArtist + })).Return(model.MediaFiles{matchedSong}, nil).Maybe() + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("matched-1")) + }) + + It("falls back to artist-based algorithm when GetSimilarSongsByTrack returns empty", func() { + track := model.MediaFile{ID: "track-1", Title: "Track", Artist: "Artist", ArtistID: "artist-1"} + artist := model.Artist{ID: "artist-1", Name: "Artist"} + song := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1", MbzRecordingID: "mbid-1"} + + // GetEntityByID for the initial call tries Artist, Album, Playlist, then MediaFile + artistRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + albumRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + mediaFileRepo.On("Get", "track-1").Return(&track, nil).Once() + + agentsCombined.On("GetSimilarSongsByTrack", mock.Anything, "track-1", "Track", "Artist", "", mock.Anything). + Return([]agents.Song{}, nil).Once() + + // Fallback calls getArtist(id) which calls GetEntityByID again - this time it finds the mediafile + // and recursively calls getArtist(v.ArtistID) + artistRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + albumRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + mediaFileRepo.On("Get", "track-1").Return(&track, nil).Once() + + // Then it recurses with the artist-1 ID + artistRepo.On("Get", "artist-1").Return(&artist, nil).Maybe() + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + return opt.Max == 1 && opt.Filters != nil + })).Return(model.Artists{artist}, nil).Maybe() + + mockAgent.On("GetSimilarArtists", mock.Anything, "artist-1", "Artist", "", 15). + Return([]agents.Artist{}, nil).Once() + + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + return opt.Max == 0 && opt.Filters != nil + })).Return(model.Artists{}, nil).Once() + + mockAgent.On("GetArtistTopSongs", mock.Anything, "artist-1", "Artist", "", mock.Anything). + Return([]agents.Song{{Name: "Song One", MBID: "mbid-1"}}, nil).Once() + + mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song}, nil).Once() + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("song-1")) + }) + }) + + Context("when ID is an Album", func() { + It("calls GetSimilarSongsByAlbum and returns matched songs", func() { + album := model.Album{ID: "album-1", Name: "Speak & Spell", AlbumArtist: "Depeche Mode", MbzAlbumID: "album-mbid"} + matchedSong := model.MediaFile{ID: "matched-1", Title: "New Life", Artist: "Depeche Mode", MbzRecordingID: "song-mbid"} + + // GetEntityByID tries Artist, Album, Playlist, then MediaFile + artistRepo.On("Get", "album-1").Return(nil, model.ErrNotFound).Once() + albumRepo.On("Get", "album-1").Return(&album, nil).Once() + + agentsCombined.On("GetSimilarSongsByAlbum", mock.Anything, "album-1", "Speak & Spell", "Depeche Mode", "album-mbid", 5). + Return([]agents.Song{ + {Name: "New Life", MBID: "song-mbid", Artist: "Depeche Mode"}, + }, nil).Once() + + // Mock loadTracksByID - no ID matches + mediaFileRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + _, ok := opt.Filters.(squirrel.Eq) + return ok + })).Return(model.MediaFiles{}, nil).Once() + + // Mock loadTracksByMBID - MBID match + mediaFileRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + and, ok := opt.Filters.(squirrel.And) + if !ok || len(and) < 1 { + return false + } + _, hasEq := and[0].(squirrel.Eq) + return hasEq + })).Return(model.MediaFiles{matchedSong}, nil).Once() + + songs, err := provider.SimilarSongs(ctx, "album-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("matched-1")) + }) + + It("falls back when GetSimilarSongsByAlbum returns ErrNotFound", func() { + album := model.Album{ID: "album-1", Name: "Album", AlbumArtist: "Artist", AlbumArtistID: "artist-1"} + artist := model.Artist{ID: "artist-1", Name: "Artist"} + song := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1", MbzRecordingID: "mbid-1"} + + // GetEntityByID for the initial call tries Artist, Album, Playlist, then MediaFile + artistRepo.On("Get", "album-1").Return(nil, model.ErrNotFound).Once() + albumRepo.On("Get", "album-1").Return(&album, nil).Once() + + agentsCombined.On("GetSimilarSongsByAlbum", mock.Anything, "album-1", "Album", "Artist", "", mock.Anything). + Return(nil, agents.ErrNotFound).Once() + + // Fallback calls getArtist(id) which calls GetEntityByID again - this time it finds the album + // and recursively calls getArtist(v.AlbumArtistID) + artistRepo.On("Get", "album-1").Return(nil, model.ErrNotFound).Once() + albumRepo.On("Get", "album-1").Return(&album, nil).Once() + + // Then it recurses with the artist-1 ID + artistRepo.On("Get", "artist-1").Return(&artist, nil).Maybe() + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + return opt.Max == 1 && opt.Filters != nil + })).Return(model.Artists{artist}, nil).Maybe() + + mockAgent.On("GetSimilarArtists", mock.Anything, "artist-1", "Artist", "", 15). + Return([]agents.Artist{}, nil).Once() + + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + return opt.Max == 0 && opt.Filters != nil + })).Return(model.Artists{}, nil).Once() + + mockAgent.On("GetArtistTopSongs", mock.Anything, "artist-1", "Artist", "", mock.Anything). + Return([]agents.Song{{Name: "Song One", MBID: "mbid-1"}}, nil).Once() + + mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song}, nil).Once() + + songs, err := provider.SimilarSongs(ctx, "album-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("song-1")) + }) + }) + + Context("when ID is an Artist", func() { + It("calls GetSimilarSongsByArtist and returns matched songs", func() { + artist := model.Artist{ID: "artist-1", Name: "Depeche Mode", MbzArtistID: "artist-mbid"} + matchedSong := model.MediaFile{ID: "matched-1", Title: "Enjoy the Silence", Artist: "Depeche Mode", MbzRecordingID: "song-mbid"} + + artistRepo.On("Get", "artist-1").Return(&artist, nil).Once() + agentsCombined.On("GetSimilarSongsByArtist", mock.Anything, "artist-1", "Depeche Mode", "artist-mbid", 5). + Return([]agents.Song{ + {Name: "Enjoy the Silence", MBID: "song-mbid", Artist: "Depeche Mode"}, + }, nil).Once() + + // Mock loadTracksByID - no ID matches + mediaFileRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + _, ok := opt.Filters.(squirrel.Eq) + return ok + })).Return(model.MediaFiles{}, nil).Once() + + // Mock loadTracksByMBID - MBID match + mediaFileRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + and, ok := opt.Filters.(squirrel.And) + if !ok || len(and) < 1 { + return false + } + _, hasEq := and[0].(squirrel.Eq) + return hasEq + })).Return(model.MediaFiles{matchedSong}, nil).Once() + + songs, err := provider.SimilarSongs(ctx, "artist-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("matched-1")) + }) + }) + }) + + It("returns similar songs from main artist and similar artists", func() { + artist1 := model.Artist{ID: "artist-1", Name: "Artist One"} + similarArtist := model.Artist{ID: "artist-3", Name: "Similar Artist"} + song1 := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1", MbzRecordingID: "mbid-1"} + song2 := model.MediaFile{ID: "song-2", Title: "Song Two", ArtistID: "artist-1", MbzRecordingID: "mbid-2"} + song3 := model.MediaFile{ID: "song-3", Title: "Song Three", ArtistID: "artist-3", MbzRecordingID: "mbid-3"} + + artistRepo.On("Get", "artist-1").Return(&artist1, nil).Maybe() + artistRepo.On("Get", "artist-3").Return(&similarArtist, nil).Maybe() + + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + return opt.Max == 1 && opt.Filters != nil + })).Return(model.Artists{artist1}, nil).Once() + + // New similar songs by artist returns ErrNotFound to trigger fallback + agentsCombined.On("GetSimilarSongsByArtist", mock.Anything, "artist-1", "Artist One", "", mock.Anything). + Return(nil, agents.ErrNotFound).Once() + + similarAgentsResp := []agents.Artist{ + {Name: "Similar Artist", MBID: "similar-mbid"}, + } + mockAgent.On("GetSimilarArtists", mock.Anything, "artist-1", "Artist One", "", 15). + Return(similarAgentsResp, nil).Once() + + // Mock the three-phase artist lookup: ID (skipped - no IDs), MBID, then Name + // MBID lookup returns empty (no match) + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + _, ok := opt.Filters.(squirrel.Eq) + return opt.Max == 0 && ok + })).Return(model.Artists{}, nil).Once() + // Name lookup returns the similar artist + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + _, ok := opt.Filters.(squirrel.Or) + return opt.Max == 0 && ok + })).Return(model.Artists{similarArtist}, nil).Once() + + mockAgent.On("GetArtistTopSongs", mock.Anything, "artist-1", "Artist One", "", mock.Anything). + Return([]agents.Song{ + {Name: "Song One", MBID: "mbid-1"}, + {Name: "Song Two", MBID: "mbid-2"}, + }, nil).Once() + + mockAgent.On("GetArtistTopSongs", mock.Anything, "artist-3", "Similar Artist", "", mock.Anything). + Return([]agents.Song{ + {Name: "Song Three", MBID: "mbid-3"}, + }, nil).Once() + + mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song1, song2}, nil).Once() + mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song3}, nil).Once() + + songs, err := provider.SimilarSongs(ctx, "artist-1", 3) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(3)) + for _, song := range songs { + Expect(song.ID).To(BeElementOf("song-1", "song-2", "song-3")) + } + }) + + It("returns ErrNotFound when artist is not found", func() { + artistRepo.On("Get", "artist-unknown-artist").Return(nil, model.ErrNotFound) + mediaFileRepo.On("Get", "artist-unknown-artist").Return(nil, model.ErrNotFound) + albumRepo.On("Get", "artist-unknown-artist").Return(nil, model.ErrNotFound) + + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + return opt.Max == 1 && opt.Filters != nil + })).Return(model.Artists{}, nil).Maybe() + + songs, err := provider.SimilarSongs(ctx, "artist-unknown-artist", 5) + + Expect(err).To(Equal(model.ErrNotFound)) + Expect(songs).To(BeNil()) + }) + + It("returns songs from main artist when GetSimilarArtists returns error", func() { + artist1 := model.Artist{ID: "artist-1", Name: "Artist One"} + song1 := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1", MbzRecordingID: "mbid-1"} + + artistRepo.On("Get", "artist-1").Return(&artist1, nil).Maybe() + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + return opt.Max == 1 && opt.Filters != nil + })).Return(model.Artists{artist1}, nil).Maybe() + + // New similar songs by artist returns ErrNotFound to trigger fallback + agentsCombined.On("GetSimilarSongsByArtist", mock.Anything, "artist-1", "Artist One", "", mock.Anything). + Return(nil, agents.ErrNotFound).Once() + + mockAgent.On("GetSimilarArtists", mock.Anything, "artist-1", "Artist One", "", 15). + Return(nil, errors.New("error getting similar artists")).Once() + + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + return opt.Max == 0 && opt.Filters != nil + })).Return(model.Artists{}, nil).Once() + + mockAgent.On("GetArtistTopSongs", mock.Anything, "artist-1", "Artist One", "", mock.Anything). + Return([]agents.Song{ + {Name: "Song One", MBID: "mbid-1"}, + }, nil).Once() + + mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song1}, nil).Once() + + songs, err := provider.SimilarSongs(ctx, "artist-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("song-1")) + }) + + It("returns empty list when GetArtistTopSongs returns error", func() { + artist1 := model.Artist{ID: "artist-1", Name: "Artist One"} + + artistRepo.On("Get", "artist-1").Return(&artist1, nil).Maybe() + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + return opt.Max == 1 && opt.Filters != nil + })).Return(model.Artists{artist1}, nil).Maybe() + + // New similar songs by artist returns ErrNotFound to trigger fallback + agentsCombined.On("GetSimilarSongsByArtist", mock.Anything, "artist-1", "Artist One", "", mock.Anything). + Return(nil, agents.ErrNotFound).Once() + + mockAgent.On("GetSimilarArtists", mock.Anything, "artist-1", "Artist One", "", 15). + Return([]agents.Artist{}, nil).Once() + + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + return opt.Max == 0 && opt.Filters != nil + })).Return(model.Artists{}, nil).Once() + + mockAgent.On("GetArtistTopSongs", mock.Anything, "artist-1", "Artist One", "", mock.Anything). + Return(nil, errors.New("error getting top songs")).Once() + + songs, err := provider.SimilarSongs(ctx, "artist-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(BeEmpty()) + }) + + It("respects count parameter", func() { + artist1 := model.Artist{ID: "artist-1", Name: "Artist One"} + song1 := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1", MbzRecordingID: "mbid-1"} + song2 := model.MediaFile{ID: "song-2", Title: "Song Two", ArtistID: "artist-1", MbzRecordingID: "mbid-2"} + + artistRepo.On("Get", "artist-1").Return(&artist1, nil).Maybe() + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + return opt.Max == 1 && opt.Filters != nil + })).Return(model.Artists{artist1}, nil).Maybe() + + // New similar songs by artist returns ErrNotFound to trigger fallback + agentsCombined.On("GetSimilarSongsByArtist", mock.Anything, "artist-1", "Artist One", "", mock.Anything). + Return(nil, agents.ErrNotFound).Once() + + mockAgent.On("GetSimilarArtists", mock.Anything, "artist-1", "Artist One", "", 15). + Return([]agents.Artist{}, nil).Once() + + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + return opt.Max == 0 && opt.Filters != nil + })).Return(model.Artists{}, nil).Once() + + mockAgent.On("GetArtistTopSongs", mock.Anything, "artist-1", "Artist One", "", mock.Anything). + Return([]agents.Song{ + {Name: "Song One", MBID: "mbid-1"}, + {Name: "Song Two", MBID: "mbid-2"}, + }, nil).Once() + + mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song1, song2}, nil).Once() + + songs, err := provider.SimilarSongs(ctx, "artist-1", 1) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(BeElementOf("song-1", "song-2")) + }) +}) diff --git a/core/external/provider_topsongs_test.go b/core/external/provider_topsongs_test.go index 5a5a25714..b73c8ab3e 100644 --- a/core/external/provider_topsongs_test.go +++ b/core/external/provider_topsongs_test.go @@ -4,10 +4,11 @@ import ( "context" "errors" + _ "github.com/navidrome/navidrome/adapters/lastfm" + _ "github.com/navidrome/navidrome/adapters/listenbrainz" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" "github.com/navidrome/navidrome/core/agents" - _ "github.com/navidrome/navidrome/core/agents/lastfm" - _ "github.com/navidrome/navidrome/core/agents/listenbrainz" - _ "github.com/navidrome/navidrome/core/agents/spotify" . "github.com/navidrome/navidrome/core/external" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/tests" @@ -26,6 +27,10 @@ var _ = Describe("Provider - TopSongs", func() { ) BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + // Disable fuzzy matching for these tests to avoid unexpected GetAll calls + conf.Server.SimilarSongsMatchThreshold = 100 + ctx = GinkgoT().Context() artistRepo = newMockArtistRepo() // Use helper mock @@ -271,4 +276,60 @@ var _ = Describe("Provider - TopSongs", func() { ag.AssertExpectations(GinkgoT()) mediaFileRepo.AssertExpectations(GinkgoT()) }) + + It("matches songs by ID first when agent provides IDs", func() { + // Mock finding the artist + artist1 := model.Artist{ID: "artist-1", Name: "Artist One", MbzArtistID: "mbid-artist-1"} + artistRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.Artists{artist1}, nil).Once() + + // Mock agent response with IDs provided (highest priority matching) + // Note: Songs have no MBID to ensure only ID matching is used + agentSongs := []agents.Song{ + {ID: "song-1", Name: "Song One"}, + {ID: "song-2", Name: "Song Two"}, + } + ag.On("GetArtistTopSongs", ctx, "artist-1", "Artist One", "mbid-artist-1", 2).Return(agentSongs, nil).Once() + + // Mock ID lookup (first query - should match both songs directly) + song1 := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1"} + song2 := model.MediaFile{ID: "song-2", Title: "Song Two", ArtistID: "artist-1"} + mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song1, song2}, nil).Once() + + songs, err := p.TopSongs(ctx, "Artist One", 2) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(2)) + Expect(songs[0].ID).To(Equal("song-1")) + Expect(songs[1].ID).To(Equal("song-2")) + artistRepo.AssertExpectations(GinkgoT()) + ag.AssertExpectations(GinkgoT()) + mediaFileRepo.AssertExpectations(GinkgoT()) + }) + + It("falls back to MBID when ID is not found", func() { + // Mock finding the artist + artist1 := model.Artist{ID: "artist-1", Name: "Artist One", MbzArtistID: "mbid-artist-1"} + artistRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.Artists{artist1}, nil).Once() + + // Mock agent response with ID that won't be found, but MBID that will + agentSongs := []agents.Song{ + {ID: "non-existent-id", Name: "Song One", MBID: "mbid-song-1"}, + } + ag.On("GetArtistTopSongs", ctx, "artist-1", "Artist One", "mbid-artist-1", 1).Return(agentSongs, nil).Once() + + // Mock ID lookup - returns empty (ID not found) + mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{}, nil).Once() + // Mock MBID lookup - finds the song + song1 := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1", MbzRecordingID: "mbid-song-1"} + mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song1}, nil).Once() + + songs, err := p.TopSongs(ctx, "Artist One", 1) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("song-1")) + artistRepo.AssertExpectations(GinkgoT()) + ag.AssertExpectations(GinkgoT()) + mediaFileRepo.AssertExpectations(GinkgoT()) + }) }) diff --git a/core/external/provider_updateartistinfo_test.go b/core/external/provider_updateartistinfo_test.go index 9b1e8d866..0c489eadd 100644 --- a/core/external/provider_updateartistinfo_test.go +++ b/core/external/provider_updateartistinfo_test.go @@ -226,4 +226,88 @@ var _ = Describe("Provider - UpdateArtistInfo", func() { Expect(updatedArtist.ID).To(Equal("ar-agent-fail")) ag.AssertExpectations(GinkgoT()) }) + + It("matches similar artists by ID first when agent provides IDs", func() { + originalArtist := &model.Artist{ + ID: "ar-id-match", + Name: "ID Match Artist", + } + similarByID := model.Artist{ID: "ar-similar-by-id", Name: "Similar By ID", MbzArtistID: "mbid-similar"} + mockArtistRepo.SetData(model.Artists{*originalArtist, similarByID}) + + // Agent returns similar artist with ID (highest priority matching) + rawSimilar := []agents.Artist{ + {ID: "ar-similar-by-id", Name: "Different Name", MBID: "different-mbid"}, + } + + ag.On("GetArtistMBID", ctx, "ar-id-match", "ID Match Artist").Return("", nil).Once() + ag.On("GetArtistImages", ctx, "ar-id-match", "ID Match Artist", mock.Anything).Return(nil, nil).Maybe() + ag.On("GetArtistBiography", ctx, "ar-id-match", "ID Match Artist", mock.Anything).Return("", nil).Maybe() + ag.On("GetArtistURL", ctx, "ar-id-match", "ID Match Artist", mock.Anything).Return("", nil).Maybe() + ag.On("GetSimilarArtists", ctx, "ar-id-match", "ID Match Artist", mock.Anything, 100).Return(rawSimilar, nil).Once() + + updatedArtist, err := p.UpdateArtistInfo(ctx, "ar-id-match", 10, false) + + Expect(err).NotTo(HaveOccurred()) + Expect(updatedArtist.SimilarArtists).To(HaveLen(1)) + // Should match by ID, not by name or MBID + Expect(updatedArtist.SimilarArtists[0].ID).To(Equal("ar-similar-by-id")) + Expect(updatedArtist.SimilarArtists[0].Name).To(Equal("Similar By ID")) + }) + + It("matches similar artists by MBID when ID is empty", func() { + originalArtist := &model.Artist{ + ID: "ar-mbid-match", + Name: "MBID Match Artist", + } + similarByMBID := model.Artist{ID: "ar-similar-by-mbid", Name: "Similar By MBID", MbzArtistID: "mbid-similar"} + mockArtistRepo.SetData(model.Artists{*originalArtist, similarByMBID}) + + // Agent returns similar artist with only MBID (no ID) + rawSimilar := []agents.Artist{ + {Name: "Different Name", MBID: "mbid-similar"}, + } + + ag.On("GetArtistMBID", ctx, "ar-mbid-match", "MBID Match Artist").Return("", nil).Once() + ag.On("GetArtistImages", ctx, "ar-mbid-match", "MBID Match Artist", mock.Anything).Return(nil, nil).Maybe() + ag.On("GetArtistBiography", ctx, "ar-mbid-match", "MBID Match Artist", mock.Anything).Return("", nil).Maybe() + ag.On("GetArtistURL", ctx, "ar-mbid-match", "MBID Match Artist", mock.Anything).Return("", nil).Maybe() + ag.On("GetSimilarArtists", ctx, "ar-mbid-match", "MBID Match Artist", mock.Anything, 100).Return(rawSimilar, nil).Once() + + updatedArtist, err := p.UpdateArtistInfo(ctx, "ar-mbid-match", 10, false) + + Expect(err).NotTo(HaveOccurred()) + Expect(updatedArtist.SimilarArtists).To(HaveLen(1)) + // Should match by MBID since ID was empty + Expect(updatedArtist.SimilarArtists[0].ID).To(Equal("ar-similar-by-mbid")) + Expect(updatedArtist.SimilarArtists[0].Name).To(Equal("Similar By MBID")) + }) + + It("falls back to name matching when ID and MBID don't match", func() { + originalArtist := &model.Artist{ + ID: "ar-name-match", + Name: "Name Match Artist", + } + similarByName := model.Artist{ID: "ar-similar-by-name", Name: "Similar By Name"} + mockArtistRepo.SetData(model.Artists{*originalArtist, similarByName}) + + // Agent returns similar artist with non-matching ID and MBID + rawSimilar := []agents.Artist{ + {ID: "non-existent-id", Name: "Similar By Name", MBID: "non-existent-mbid"}, + } + + ag.On("GetArtistMBID", ctx, "ar-name-match", "Name Match Artist").Return("", nil).Once() + ag.On("GetArtistImages", ctx, "ar-name-match", "Name Match Artist", mock.Anything).Return(nil, nil).Maybe() + ag.On("GetArtistBiography", ctx, "ar-name-match", "Name Match Artist", mock.Anything).Return("", nil).Maybe() + ag.On("GetArtistURL", ctx, "ar-name-match", "Name Match Artist", mock.Anything).Return("", nil).Maybe() + ag.On("GetSimilarArtists", ctx, "ar-name-match", "Name Match Artist", mock.Anything, 100).Return(rawSimilar, nil).Once() + + updatedArtist, err := p.UpdateArtistInfo(ctx, "ar-name-match", 10, false) + + Expect(err).NotTo(HaveOccurred()) + Expect(updatedArtist.SimilarArtists).To(HaveLen(1)) + // Should fall back to name matching since ID and MBID didn't match + Expect(updatedArtist.SimilarArtists[0].ID).To(Equal("ar-similar-by-name")) + Expect(updatedArtist.SimilarArtists[0].Name).To(Equal("Similar By Name")) + }) }) diff --git a/core/ffmpeg/ffmpeg.go b/core/ffmpeg/ffmpeg.go index 2e0d5a4b7..33d6733c8 100644 --- a/core/ffmpeg/ffmpeg.go +++ b/core/ffmpeg/ffmpeg.go @@ -1,24 +1,52 @@ package ffmpeg import ( + "bytes" "context" + "encoding/json" "errors" "fmt" "io" "os" "os/exec" + "path/filepath" "strconv" "strings" "sync" "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/consts" "github.com/navidrome/navidrome/log" ) +// TranscodeOptions contains all parameters for a transcoding operation. +type TranscodeOptions struct { + Command string // DB command template (used to detect custom vs default) + Format string // Target format (mp3, opus, aac, flac) + FilePath string + BitRate int // kbps, 0 = codec default + SampleRate int // 0 = no constraint + Channels int // 0 = no constraint + BitDepth int // 0 = no constraint; valid values: 16, 24, 32 + Offset int // seconds +} + +// AudioProbeResult contains authoritative audio stream properties from ffprobe. +type AudioProbeResult struct { + Codec string `json:"codec"` + Profile string `json:"profile,omitempty"` + BitRate int `json:"bitRate"` + SampleRate int `json:"sampleRate"` + BitDepth int `json:"bitDepth"` + Channels int `json:"channels"` +} + type FFmpeg interface { - Transcode(ctx context.Context, command, path string, maxBitRate, offset int) (io.ReadCloser, error) + Transcode(ctx context.Context, opts TranscodeOptions) (io.ReadCloser, error) ExtractImage(ctx context.Context, path string) (io.ReadCloser, error) + ConvertAnimatedImage(ctx context.Context, reader io.Reader, maxSize int, quality int) (io.ReadCloser, error) Probe(ctx context.Context, files []string) (string, error) + ProbeAudioStream(ctx context.Context, filePath string) (*AudioProbeResult, error) CmdPath() (string, error) IsAvailable() bool Version() string @@ -29,29 +57,50 @@ func New() FFmpeg { } const ( - extractImageCmd = "ffmpeg -i %s -map 0:v -map -0:V -vcodec copy -f image2pipe -" - probeCmd = "ffmpeg %s -f ffmetadata" + extractImageCmd = "ffmpeg -i %s -map 0:v -map -0:V -vcodec copy -f image2pipe -" + probeCmd = "ffmpeg %s -f ffmetadata" + probeAudioStreamCmd = "ffprobe -v quiet -select_streams a:0 -print_format json -show_streams -show_format %s" ) type ffmpeg struct{} -func (e *ffmpeg) Transcode(ctx context.Context, command, path string, maxBitRate, offset int) (io.ReadCloser, error) { +func (e *ffmpeg) Transcode(ctx context.Context, opts TranscodeOptions) (io.ReadCloser, error) { if _, err := ffmpegCmd(); err != nil { return nil, err } - // First make sure the file exists - if err := fileExists(path); err != nil { + if err := fileExists(opts.FilePath); err != nil { return nil, err } - args := createFFmpegCommand(command, path, maxBitRate, offset) + var args []string + if isDefaultCommand(opts.Format, opts.Command) { + args = buildDynamicArgs(opts) + } else { + args = buildTemplateArgs(opts) + } return e.start(ctx, args) } +func (e *ffmpeg) ConvertAnimatedImage(ctx context.Context, reader io.Reader, maxSize int, quality int) (io.ReadCloser, error) { + cmdPath, err := ffmpegCmd() + if err != nil { + return nil, err + } + + args := []string{cmdPath, "-i", "pipe:0"} + if maxSize > 0 { + vf := fmt.Sprintf("scale='min(%d,iw)':'min(%d,ih)':force_original_aspect_ratio=decrease", maxSize, maxSize) + args = append(args, "-vf", vf) + } + args = append(args, "-loop", "0", "-c:v", "libwebp_anim", + "-quality", strconv.Itoa(quality), "-f", "webp", "-") + + return e.start(ctx, args, reader) +} + func (e *ffmpeg) ExtractImage(ctx context.Context, path string) (io.ReadCloser, error) { if _, err := ffmpegCmd(); err != nil { return nil, err } - // First make sure the file exists if err := fileExists(path); err != nil { return nil, err } @@ -81,6 +130,91 @@ func (e *ffmpeg) Probe(ctx context.Context, files []string) (string, error) { return string(output), nil } +func (e *ffmpeg) ProbeAudioStream(ctx context.Context, filePath string) (*AudioProbeResult, error) { + if _, err := ffmpegCmd(); err != nil { + return nil, err + } + if err := fileExists(filePath); err != nil { + return nil, err + } + args := createFFmpegCommand(probeAudioStreamCmd, filePath, 0, 0) + log.Trace(ctx, "Executing ffprobe command", "args", args) + cmd := exec.CommandContext(ctx, args[0], args[1:]...) // #nosec + output, err := cmd.Output() + if err != nil { + return nil, fmt.Errorf("running ffprobe on %q: %w", filePath, err) + } + return parseProbeOutput(output) +} + +type probeOutput struct { + Streams []probeStream `json:"streams"` + Format probeFormat `json:"format"` +} + +type probeFormat struct { + BitRate string `json:"bit_rate"` +} + +type probeStream struct { + CodecName string `json:"codec_name"` + CodecType string `json:"codec_type"` + Profile string `json:"profile"` + SampleRate string `json:"sample_rate"` + BitRate string `json:"bit_rate"` + Channels int `json:"channels"` + BitsPerSample int `json:"bits_per_sample"` + BitsPerRawSample string `json:"bits_per_raw_sample"` +} + +func parseProbeOutput(data []byte) (*AudioProbeResult, error) { + var output probeOutput + if err := json.Unmarshal(data, &output); err != nil { + return nil, fmt.Errorf("parsing ffprobe output: %w", err) + } + + for _, s := range output.Streams { + if s.CodecType != "audio" { + continue + } + bitDepth := s.BitsPerSample + if bitDepth == 0 && s.BitsPerRawSample != "" { + bitDepth, _ = strconv.Atoi(s.BitsPerRawSample) + } + result := &AudioProbeResult{ + Codec: s.CodecName, + Channels: s.Channels, + BitDepth: bitDepth, + } + + // Profile: "unknown" → empty + if s.Profile != "" && !strings.EqualFold(s.Profile, "unknown") { + result.Profile = s.Profile + } + + // Sample rate: string → int + if s.SampleRate != "" { + result.SampleRate, _ = strconv.Atoi(s.SampleRate) + } + + // Bit rate: bps string → kbps int + if s.BitRate != "" { + bps, _ := strconv.Atoi(s.BitRate) + result.BitRate = bps / 1000 + } + + // Fallback to format-level bit_rate (needed for FLAC, Opus, etc.) + if result.BitRate == 0 && output.Format.BitRate != "" { + bps, _ := strconv.Atoi(output.Format.BitRate) + result.BitRate = bps / 1000 + } + + return result, nil + } + + return nil, fmt.Errorf("no audio stream found in ffprobe output") +} + func (e *ffmpeg) CmdPath() (string, error) { return ffmpegCmd() } @@ -108,11 +242,14 @@ func (e *ffmpeg) Version() string { return parts[2] } -func (e *ffmpeg) start(ctx context.Context, args []string) (io.ReadCloser, error) { +func (e *ffmpeg) start(ctx context.Context, args []string, input ...io.Reader) (io.ReadCloser, error) { log.Trace(ctx, "Executing ffmpeg command", "cmd", args) j := &ffCmd{args: args} + if len(input) > 0 { + j.input = input[0] + } j.PipeReader, j.out = io.Pipe() - err := j.start() + err := j.start(ctx) if err != nil { return nil, err } @@ -122,18 +259,25 @@ func (e *ffmpeg) start(ctx context.Context, args []string) (io.ReadCloser, error type ffCmd struct { *io.PipeReader - out *io.PipeWriter - args []string - cmd *exec.Cmd + out *io.PipeWriter + args []string + cmd *exec.Cmd + input io.Reader // optional stdin source + stderr *bytes.Buffer } -func (j *ffCmd) start() error { - cmd := exec.Command(j.args[0], j.args[1:]...) // #nosec +func (j *ffCmd) start(ctx context.Context) error { + cmd := exec.CommandContext(ctx, j.args[0], j.args[1:]...) // #nosec cmd.Stdout = j.out + if j.input != nil { + cmd.Stdin = j.input + } + j.stderr = &bytes.Buffer{} + stderrWriter := &limitedWriter{buf: j.stderr, limit: 4096} if log.IsGreaterOrEqualTo(log.LevelTrace) { - cmd.Stderr = os.Stderr + cmd.Stderr = io.MultiWriter(os.Stderr, stderrWriter) } else { - cmd.Stderr = io.Discard + cmd.Stderr = stderrWriter } j.cmd = cmd @@ -147,7 +291,11 @@ func (j *ffCmd) wait() { if err := j.cmd.Wait(); err != nil { var exitErr *exec.ExitError if errors.As(err, &exitErr) { - _ = j.out.CloseWithError(fmt.Errorf("%s exited with non-zero status code: %d", j.args[0], exitErr.ExitCode())) + errMsg := fmt.Sprintf("%s exited with non-zero status code: %d", j.args[0], exitErr.ExitCode()) + if stderrOutput := strings.TrimSpace(j.stderr.String()); stderrOutput != "" { + errMsg += ": " + stderrOutput + } + _ = j.out.CloseWithError(errors.New(errMsg)) } else { _ = j.out.CloseWithError(fmt.Errorf("waiting %s cmd: %w", j.args[0], err)) } @@ -156,6 +304,156 @@ func (j *ffCmd) wait() { _ = j.out.Close() } +// limitedWriter wraps a bytes.Buffer and stops writing once the limit is reached. +// Writes that would exceed the limit are silently discarded to prevent unbounded memory usage. +type limitedWriter struct { + buf *bytes.Buffer + limit int +} + +func (w *limitedWriter) Write(p []byte) (int, error) { + n := len(p) + remaining := w.limit - w.buf.Len() + if remaining <= 0 { + return n, nil // Discard but report success to avoid breaking the writer + } + if len(p) > remaining { + p = p[:remaining] + } + w.buf.Write(p) + return n, nil // Always report full write to avoid ErrShortWrite from io.MultiWriter +} + +// formatCodecMap maps target format to ffmpeg codec flag. +var formatCodecMap = map[string]string{ + "mp3": "libmp3lame", + "opus": "libopus", + "aac": "aac", + "flac": "flac", +} + +// formatOutputMap maps target format to ffmpeg output format flag (-f). +var formatOutputMap = map[string]string{ + "mp3": "mp3", + "opus": "opus", + "aac": "adts", + "flac": "flac", +} + +// defaultCommands is used to detect whether a user has customized their transcoding command. +var defaultCommands = func() map[string]string { + m := make(map[string]string, len(consts.DefaultTranscodings)) + for _, t := range consts.DefaultTranscodings { + m[t.TargetFormat] = t.Command + } + return m +}() + +// isDefaultCommand returns true if the command matches the known default for this format. +func isDefaultCommand(format, command string) bool { + return defaultCommands[format] == command +} + +// buildDynamicArgs programmatically constructs ffmpeg arguments for known formats, +// including all transcoding parameters (bitrate, sample rate, channels). +func buildDynamicArgs(opts TranscodeOptions) []string { + cmdPath, _ := ffmpegCmd() + args := []string{cmdPath, "-i", opts.FilePath} + + if opts.Offset > 0 { + args = append(args, "-ss", strconv.Itoa(opts.Offset)) + } + + args = append(args, "-map", "0:a:0") + + if codec, ok := formatCodecMap[opts.Format]; ok { + args = append(args, "-c:a", codec) + } + + if opts.BitRate > 0 { + args = append(args, "-b:a", strconv.Itoa(opts.BitRate)+"k") + } + if opts.SampleRate > 0 { + args = append(args, "-ar", strconv.Itoa(opts.SampleRate)) + } + if opts.Channels > 0 { + args = append(args, "-ac", strconv.Itoa(opts.Channels)) + } + // Only pass -sample_fmt for lossless output formats where bit depth matters. + // Lossy codecs (mp3, aac, opus) handle sample format conversion internally, + // and passing interleaved formats like "s16" causes silent failures. + if opts.BitDepth >= 16 && isLosslessOutputFormat(opts.Format) { + args = append(args, "-sample_fmt", bitDepthToSampleFmt(opts.BitDepth)) + } + + args = append(args, "-v", "0") + + if outputFmt, ok := formatOutputMap[opts.Format]; ok { + args = append(args, "-f", outputFmt) + } + + args = append(args, "-") + return args +} + +// buildTemplateArgs handles user-customized command templates, with dynamic injection +// of sample rate, channels, and bit depth when requested by the transcode decision. +// Note: these flags are injected unconditionally when non-zero, even if the template +// already includes them. FFmpeg uses the last occurrence of duplicate flags. +func buildTemplateArgs(opts TranscodeOptions) []string { + args := createFFmpegCommand(opts.Command, opts.FilePath, opts.BitRate, opts.Offset) + + // Dynamically inject -ar, -ac, and -sample_fmt before the output target + if opts.SampleRate > 0 { + args = injectBeforeOutput(args, "-ar", strconv.Itoa(opts.SampleRate)) + } + if opts.Channels > 0 { + args = injectBeforeOutput(args, "-ac", strconv.Itoa(opts.Channels)) + } + if opts.BitDepth >= 16 && isLosslessOutputFormat(opts.Format) { + args = injectBeforeOutput(args, "-sample_fmt", bitDepthToSampleFmt(opts.BitDepth)) + } + return args +} + +// injectBeforeOutput inserts a flag and value before the trailing "-" (stdout output). +func injectBeforeOutput(args []string, flag, value string) []string { + if len(args) > 0 && args[len(args)-1] == "-" { + result := make([]string, 0, len(args)+2) + result = append(result, args[:len(args)-1]...) + result = append(result, flag, value, "-") + return result + } + return append(args, flag, value) +} + +// isLosslessOutputFormat returns true if the format is a lossless audio format +// where preserving bit depth via -sample_fmt is meaningful. +// Note: this covers only formats ffmpeg can produce as output. For the full set of +// lossless formats used in transcoding decisions, see core/stream/codec.go:isLosslessFormat. +func isLosslessOutputFormat(format string) bool { + switch strings.ToLower(format) { + case "flac", "alac", "wav", "aiff": + return true + } + return false +} + +// bitDepthToSampleFmt converts a bit depth value to the ffmpeg sample_fmt string. +// FLAC only supports s16 and s32; for 24-bit sources, s32 is the correct format +// (ffmpeg packs 24-bit samples into 32-bit containers). +func bitDepthToSampleFmt(bitDepth int) string { + switch bitDepth { + case 16: + return "s16" + case 32: + return "s32" + default: + // 24-bit and other depths: use s32 (the next valid container size) + return "s32" + } +} + // Path will always be an absolute path func createFFmpegCommand(cmd, path string, maxBitRate, offset int) []string { var args []string @@ -196,10 +494,20 @@ func fixCmd(cmd string) []string { if s == "ffmpeg" || s == "ffmpeg.exe" { split[i] = cmdPath } + if s == "ffprobe" || s == "ffprobe.exe" { + split[i] = ffprobePath(cmdPath) + } } return split } +// ffprobePath derives the ffprobe binary path from the resolved ffmpeg path. +func ffprobePath(ffmpegCmd string) string { + dir := filepath.Dir(ffmpegCmd) + base := filepath.Base(ffmpegCmd) + return filepath.Join(dir, strings.Replace(base, "ffmpeg", "ffprobe", 1)) +} + func ffmpegCmd() (string, error) { ffOnce.Do(func() { if conf.Server.FFmpegPath != "" { diff --git a/core/ffmpeg/ffmpeg_test.go b/core/ffmpeg/ffmpeg_test.go index 7e67a2a6a..04663828f 100644 --- a/core/ffmpeg/ffmpeg_test.go +++ b/core/ffmpeg/ffmpeg_test.go @@ -1,16 +1,28 @@ package ffmpeg import ( + "context" + "os" + "path/filepath" + "runtime" + sync "sync" "testing" + "time" + "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/log" - "github.com/navidrome/navidrome/tests" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) func TestFFmpeg(t *testing.T) { - tests.Init(t, false) + // Inline test init to avoid import cycle with tests package + //nolint:dogsled + _, file, _, _ := runtime.Caller(0) + appPath, _ := filepath.Abs(filepath.Join(filepath.Dir(file), "..", "..")) + confPath := filepath.Join(appPath, "tests", "navidrome-test.toml") + _ = os.Chdir(appPath) + conf.LoadFromFile(confPath) log.SetLevel(log.LevelFatal) RegisterFailHandler(Fail) RunSpecs(t, "FFmpeg Suite") @@ -65,4 +77,617 @@ var _ = Describe("ffmpeg", func() { Expect(args).To(Equal([]string{"/usr/bin/with spaces/ffmpeg.exe", "-i", "one.mp3", "-f", "ffmetadata"})) }) }) + + Describe("isDefaultCommand", func() { + It("returns true for known default mp3 command", func() { + Expect(isDefaultCommand("mp3", "ffmpeg -i %s -ss %t -map 0:a:0 -b:a %bk -v 0 -f mp3 -")).To(BeTrue()) + }) + It("returns true for known default opus command", func() { + Expect(isDefaultCommand("opus", "ffmpeg -i %s -ss %t -map 0:a:0 -b:a %bk -v 0 -c:a libopus -f opus -")).To(BeTrue()) + }) + It("returns true for known default aac command", func() { + Expect(isDefaultCommand("aac", "ffmpeg -i %s -ss %t -map 0:a:0 -b:a %bk -v 0 -c:a aac -f adts -")).To(BeTrue()) + }) + It("returns true for known default flac command", func() { + Expect(isDefaultCommand("flac", "ffmpeg -i %s -ss %t -map 0:a:0 -v 0 -c:a flac -f flac -")).To(BeTrue()) + }) + It("returns false for a custom command", func() { + Expect(isDefaultCommand("mp3", "ffmpeg -i %s -b:a %bk -custom-flag -f mp3 -")).To(BeFalse()) + }) + It("returns false for unknown format", func() { + Expect(isDefaultCommand("wav", "ffmpeg -i %s -f wav -")).To(BeFalse()) + }) + }) + + Describe("buildDynamicArgs", func() { + It("builds mp3 args with bitrate, samplerate, and channels", func() { + args := buildDynamicArgs(TranscodeOptions{ + Format: "mp3", + FilePath: "/music/file.flac", + BitRate: 256, + SampleRate: 48000, + Channels: 2, + }) + Expect(args).To(Equal([]string{ + "ffmpeg", "-i", "/music/file.flac", + "-map", "0:a:0", + "-c:a", "libmp3lame", + "-b:a", "256k", + "-ar", "48000", + "-ac", "2", + "-v", "0", + "-f", "mp3", + "-", + })) + }) + + It("builds flac args without bitrate", func() { + args := buildDynamicArgs(TranscodeOptions{ + Format: "flac", + FilePath: "/music/file.dsf", + SampleRate: 48000, + }) + Expect(args).To(Equal([]string{ + "ffmpeg", "-i", "/music/file.dsf", + "-map", "0:a:0", + "-c:a", "flac", + "-ar", "48000", + "-v", "0", + "-f", "flac", + "-", + })) + }) + + It("builds opus args with bitrate only", func() { + args := buildDynamicArgs(TranscodeOptions{ + Format: "opus", + FilePath: "/music/file.flac", + BitRate: 128, + }) + Expect(args).To(Equal([]string{ + "ffmpeg", "-i", "/music/file.flac", + "-map", "0:a:0", + "-c:a", "libopus", + "-b:a", "128k", + "-v", "0", + "-f", "opus", + "-", + })) + }) + + It("includes offset when specified", func() { + args := buildDynamicArgs(TranscodeOptions{ + Format: "mp3", + FilePath: "/music/file.mp3", + BitRate: 192, + Offset: 30, + }) + Expect(args).To(Equal([]string{ + "ffmpeg", "-i", "/music/file.mp3", + "-ss", "30", + "-map", "0:a:0", + "-c:a", "libmp3lame", + "-b:a", "192k", + "-v", "0", + "-f", "mp3", + "-", + })) + }) + + It("builds aac args with ADTS output", func() { + args := buildDynamicArgs(TranscodeOptions{ + Format: "aac", + FilePath: "/music/file.flac", + BitRate: 256, + }) + Expect(args).To(Equal([]string{ + "ffmpeg", "-i", "/music/file.flac", + "-map", "0:a:0", + "-c:a", "aac", + "-b:a", "256k", + "-v", "0", + "-f", "adts", + "-", + })) + }) + + It("builds flac args with bit depth", func() { + args := buildDynamicArgs(TranscodeOptions{ + Format: "flac", + FilePath: "/music/file.dsf", + BitDepth: 24, + }) + Expect(args).To(Equal([]string{ + "ffmpeg", "-i", "/music/file.dsf", + "-map", "0:a:0", + "-c:a", "flac", + "-sample_fmt", "s32", + "-v", "0", + "-f", "flac", + "-", + })) + }) + + It("omits -sample_fmt when bit depth is 0", func() { + args := buildDynamicArgs(TranscodeOptions{ + Format: "flac", + FilePath: "/music/file.flac", + BitDepth: 0, + }) + Expect(args).ToNot(ContainElement("-sample_fmt")) + }) + + It("omits -sample_fmt when bit depth is too low (DSD)", func() { + args := buildDynamicArgs(TranscodeOptions{ + Format: "flac", + FilePath: "/music/file.dsf", + BitDepth: 1, + }) + Expect(args).ToNot(ContainElement("-sample_fmt")) + }) + + DescribeTable("omits -sample_fmt for lossy formats even when bit depth >= 16", + func(format string, bitRate int) { + args := buildDynamicArgs(TranscodeOptions{ + Format: format, + FilePath: "/music/file.flac", + BitRate: bitRate, + BitDepth: 16, + }) + Expect(args).ToNot(ContainElement("-sample_fmt")) + }, + Entry("mp3", "mp3", 256), + Entry("aac", "aac", 256), + Entry("opus", "opus", 128), + ) + }) + + Describe("bitDepthToSampleFmt", func() { + It("converts 16-bit", func() { + Expect(bitDepthToSampleFmt(16)).To(Equal("s16")) + }) + It("converts 24-bit to s32 (FLAC only supports s16/s32)", func() { + Expect(bitDepthToSampleFmt(24)).To(Equal("s32")) + }) + It("converts 32-bit", func() { + Expect(bitDepthToSampleFmt(32)).To(Equal("s32")) + }) + }) + + Describe("buildTemplateArgs", func() { + It("injects -ar and -ac into custom template", func() { + args := buildTemplateArgs(TranscodeOptions{ + Command: "ffmpeg -i %s -b:a %bk -v 0 -f mp3 -", + FilePath: "/music/file.flac", + BitRate: 192, + SampleRate: 44100, + Channels: 2, + }) + Expect(args).To(Equal([]string{ + "ffmpeg", "-i", "/music/file.flac", + "-b:a", "192k", "-v", "0", "-f", "mp3", + "-ar", "44100", "-ac", "2", + "-", + })) + }) + + It("injects only -ar when channels is 0", func() { + args := buildTemplateArgs(TranscodeOptions{ + Command: "ffmpeg -i %s -b:a %bk -v 0 -f mp3 -", + FilePath: "/music/file.flac", + BitRate: 192, + SampleRate: 48000, + }) + Expect(args).To(Equal([]string{ + "ffmpeg", "-i", "/music/file.flac", + "-b:a", "192k", "-v", "0", "-f", "mp3", + "-ar", "48000", + "-", + })) + }) + + It("does not inject anything when sample rate and channels are 0", func() { + args := buildTemplateArgs(TranscodeOptions{ + Command: "ffmpeg -i %s -b:a %bk -v 0 -f mp3 -", + FilePath: "/music/file.flac", + BitRate: 192, + }) + Expect(args).To(Equal([]string{ + "ffmpeg", "-i", "/music/file.flac", + "-b:a", "192k", "-v", "0", "-f", "mp3", + "-", + })) + }) + + It("injects -sample_fmt for lossless output format with bit depth", func() { + args := buildTemplateArgs(TranscodeOptions{ + Command: "ffmpeg -i %s -v 0 -c:a flac -f flac -", + Format: "flac", + FilePath: "/music/file.dsf", + BitDepth: 24, + }) + Expect(args).To(Equal([]string{ + "ffmpeg", "-i", "/music/file.dsf", + "-v", "0", "-c:a", "flac", "-f", "flac", + "-sample_fmt", "s32", + "-", + })) + }) + + It("does not inject -sample_fmt for lossy output format even with bit depth", func() { + args := buildTemplateArgs(TranscodeOptions{ + Command: "ffmpeg -i %s -b:a %bk -v 0 -f mp3 -", + Format: "mp3", + FilePath: "/music/file.flac", + BitRate: 192, + BitDepth: 16, + }) + Expect(args).To(Equal([]string{ + "ffmpeg", "-i", "/music/file.flac", + "-b:a", "192k", "-v", "0", "-f", "mp3", + "-", + })) + }) + }) + + Describe("injectBeforeOutput", func() { + It("inserts flag before trailing dash", func() { + args := injectBeforeOutput([]string{"ffmpeg", "-i", "file.mp3", "-f", "mp3", "-"}, "-ar", "48000") + Expect(args).To(Equal([]string{"ffmpeg", "-i", "file.mp3", "-f", "mp3", "-ar", "48000", "-"})) + }) + + It("appends when no trailing dash", func() { + args := injectBeforeOutput([]string{"ffmpeg", "-i", "file.mp3"}, "-ar", "48000") + Expect(args).To(Equal([]string{"ffmpeg", "-i", "file.mp3", "-ar", "48000"})) + }) + }) + + Describe("parseProbeOutput", func() { + It("parses MP3 with embedded artwork (real ffprobe output)", func() { + // Real: MP3 file with mjpeg artwork stream after audio + data := []byte(`{"streams":[` + + `{"index":0,"codec_name":"mp3","codec_long_name":"MP3 (MPEG audio layer 3)","codec_type":"audio",` + + `"sample_fmt":"fltp","sample_rate":"44100","channels":2,"channel_layout":"stereo",` + + `"bits_per_sample":0,"bit_rate":"198314","tags":{"encoder":"LAME3.99r"}},` + + `{"index":1,"codec_name":"mjpeg","codec_type":"video","profile":"Baseline","width":400,"height":400}]}`) + result, err := parseProbeOutput(data) + Expect(err).ToNot(HaveOccurred()) + Expect(result.Codec).To(Equal("mp3")) + Expect(result.Profile).To(BeEmpty()) // MP3 has no profile field + Expect(result.SampleRate).To(Equal(44100)) + Expect(result.Channels).To(Equal(2)) + Expect(result.BitRate).To(Equal(198)) // 198314 bps -> 198 kbps + Expect(result.BitDepth).To(Equal(0)) // lossy codec + }) + + It("parses AAC-LC in m4a container (real ffprobe output)", func() { + // Real: AAC LC file with profile and artwork + data := []byte(`{"streams":[` + + `{"index":0,"codec_name":"aac","codec_long_name":"AAC (Advanced Audio Coding)",` + + `"profile":"LC","codec_type":"audio","sample_fmt":"fltp","sample_rate":"44100",` + + `"channels":2,"channel_layout":"stereo","bits_per_sample":0,"bit_rate":"279958"},` + + `{"index":1,"codec_name":"mjpeg","codec_type":"video","profile":"Baseline"}]}`) + result, err := parseProbeOutput(data) + Expect(err).ToNot(HaveOccurred()) + Expect(result.Codec).To(Equal("aac")) + Expect(result.Profile).To(Equal("LC")) + Expect(result.SampleRate).To(Equal(44100)) + Expect(result.Channels).To(Equal(2)) + Expect(result.BitRate).To(Equal(279)) // 279958 bps -> 279 kbps + }) + + It("parses HE-AACv2 in mp4 container with video stream (real ffprobe output)", func() { + // Real: Fraunhofer HE-AACv2 sample (LFE-SBRstereo.mp4), video stream before audio + data := []byte(`{"streams":[` + + `{"index":0,"codec_name":"h264","codec_type":"video","profile":"Main"},` + + `{"index":1,"codec_name":"aac","codec_long_name":"AAC (Advanced Audio Coding)",` + + `"profile":"HE-AACv2","codec_type":"audio","sample_fmt":"fltp",` + + `"sample_rate":"48000","channels":2,"channel_layout":"stereo",` + + `"bits_per_sample":0,"bit_rate":"55999"}]}`) + result, err := parseProbeOutput(data) + Expect(err).ToNot(HaveOccurred()) + Expect(result.Codec).To(Equal("aac")) + Expect(result.Profile).To(Equal("HE-AACv2")) + Expect(result.SampleRate).To(Equal(48000)) + Expect(result.Channels).To(Equal(2)) + Expect(result.BitRate).To(Equal(55)) // 55999 bps -> 55 kbps + }) + + It("parses FLAC using bits_per_raw_sample and format-level bit_rate (real ffprobe output)", func() { + // Real: FLAC reports bit depth in bits_per_raw_sample, not bits_per_sample. + // Stream-level bit_rate is absent; format-level bit_rate is used as fallback. + data := []byte(`{"streams":[` + + `{"index":0,"codec_name":"flac","codec_long_name":"FLAC (Free Lossless Audio Codec)",` + + `"codec_type":"audio","sample_fmt":"s16","sample_rate":"44100","channels":2,` + + `"channel_layout":"stereo","bits_per_sample":0,"bits_per_raw_sample":"16"},` + + `{"index":1,"codec_name":"mjpeg","codec_type":"video","profile":"Baseline"}],` + + `"format":{"bit_rate":"906900"}}`) + result, err := parseProbeOutput(data) + Expect(err).ToNot(HaveOccurred()) + Expect(result.Codec).To(Equal("flac")) + Expect(result.SampleRate).To(Equal(44100)) + Expect(result.BitDepth).To(Equal(16)) // from bits_per_raw_sample + Expect(result.BitRate).To(Equal(906)) // format-level: 906900 bps -> 906 kbps + Expect(result.Profile).To(BeEmpty()) // no profile field in real output + }) + + It("parses Opus with format-level bit_rate fallback (real ffprobe output)", func() { + // Real: Opus stream-level bit_rate is absent; format-level is used as fallback. + data := []byte(`{"streams":[` + + `{"index":0,"codec_name":"opus","codec_long_name":"Opus (Opus Interactive Audio Codec)",` + + `"codec_type":"audio","sample_fmt":"fltp","sample_rate":"48000","channels":2,` + + `"channel_layout":"stereo","bits_per_sample":0}],` + + `"format":{"bit_rate":"128000"}}`) + result, err := parseProbeOutput(data) + Expect(err).ToNot(HaveOccurred()) + Expect(result.Codec).To(Equal("opus")) + Expect(result.SampleRate).To(Equal(48000)) + Expect(result.Channels).To(Equal(2)) + Expect(result.BitRate).To(Equal(128)) // format-level: 128000 bps -> 128 kbps + Expect(result.BitDepth).To(Equal(0)) + }) + + It("parses WAV/PCM with bits_per_sample (real ffprobe output)", func() { + // Real: WAV uses bits_per_sample directly + data := []byte(`{"streams":[` + + `{"index":0,"codec_name":"pcm_s16le","codec_long_name":"PCM signed 16-bit little-endian",` + + `"codec_type":"audio","sample_fmt":"s16","sample_rate":"44100","channels":2,` + + `"bits_per_sample":16,"bit_rate":"1411200"}]}`) + result, err := parseProbeOutput(data) + Expect(err).ToNot(HaveOccurred()) + Expect(result.Codec).To(Equal("pcm_s16le")) + Expect(result.SampleRate).To(Equal(44100)) + Expect(result.Channels).To(Equal(2)) + Expect(result.BitDepth).To(Equal(16)) + Expect(result.BitRate).To(Equal(1411)) + }) + + It("parses ALAC in m4a container (real ffprobe output)", func() { + // Real: Beatles - You Can't Do That (2023 Mix), ALAC 16-bit + data := []byte(`{"streams":[` + + `{"index":0,"codec_name":"alac","codec_long_name":"ALAC (Apple Lossless Audio Codec)",` + + `"codec_type":"audio","sample_fmt":"s16p","sample_rate":"44100","channels":2,` + + `"channel_layout":"stereo","bits_per_sample":0,"bit_rate":"1011003",` + + `"bits_per_raw_sample":"16"},` + + `{"index":1,"codec_name":"mjpeg","codec_type":"video","profile":"Baseline"}]}`) + result, err := parseProbeOutput(data) + Expect(err).ToNot(HaveOccurred()) + Expect(result.Codec).To(Equal("alac")) + Expect(result.BitDepth).To(Equal(16)) // from bits_per_raw_sample + Expect(result.SampleRate).To(Equal(44100)) + Expect(result.Channels).To(Equal(2)) + Expect(result.BitRate).To(Equal(1011)) // 1011003 bps -> 1011 kbps + }) + + It("skips video-only streams", func() { + data := []byte(`{"streams":[{"index":0,"codec_name":"mjpeg","codec_type":"video","profile":"Baseline"}]}`) + _, err := parseProbeOutput(data) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("no audio stream")) + }) + + It("returns error for empty streams array", func() { + data := []byte(`{"streams":[]}`) + _, err := parseProbeOutput(data) + Expect(err).To(HaveOccurred()) + }) + + It("returns error for invalid JSON", func() { + data := []byte(`not json`) + _, err := parseProbeOutput(data) + Expect(err).To(HaveOccurred()) + }) + + It("parses HiRes multichannel FLAC with format-level bit_rate (real ffprobe output)", func() { + // Real: Pink Floyd - 192kHz/24-bit/7.1 surround FLAC + data := []byte(`{"streams":[` + + `{"index":0,"codec_name":"flac","codec_long_name":"FLAC (Free Lossless Audio Codec)",` + + `"codec_type":"audio","sample_fmt":"s32","sample_rate":"192000","channels":8,` + + `"channel_layout":"7.1","bits_per_sample":0,"bits_per_raw_sample":"24"},` + + `{"index":1,"codec_name":"mjpeg","codec_type":"video","profile":"Progressive"}],` + + `"format":{"bit_rate":"18432000"}}`) + result, err := parseProbeOutput(data) + Expect(err).ToNot(HaveOccurred()) + Expect(result.Codec).To(Equal("flac")) + Expect(result.SampleRate).To(Equal(192000)) + Expect(result.BitDepth).To(Equal(24)) + Expect(result.Channels).To(Equal(8)) + Expect(result.BitRate).To(Equal(18432)) // format-level: 18432000 bps -> 18432 kbps + }) + + It("parses DSD/DSF file (real ffprobe output)", func() { + // Real: Yes - Owner of a Lonely Heart, DSD64 DSF + data := []byte(`{"streams":[` + + `{"index":0,"codec_name":"dsd_lsbf_planar",` + + `"codec_long_name":"DSD (Direct Stream Digital), least significant bit first, planar",` + + `"codec_type":"audio","sample_fmt":"fltp","sample_rate":"352800","channels":2,` + + `"channel_layout":"stereo","bits_per_sample":8,"bit_rate":"5644800"},` + + `{"index":1,"codec_name":"mjpeg","codec_type":"video","profile":"Baseline"}]}`) + result, err := parseProbeOutput(data) + Expect(err).ToNot(HaveOccurred()) + Expect(result.Codec).To(Equal("dsd_lsbf_planar")) + Expect(result.BitDepth).To(Equal(8)) // DSD reports 8 bits_per_sample + Expect(result.SampleRate).To(Equal(352800)) // DSD64 sample rate + Expect(result.Channels).To(Equal(2)) + Expect(result.BitRate).To(Equal(5644)) // 5644800 bps -> 5644 kbps + }) + + It("prefers stream-level bit_rate over format-level when both are present", func() { + // ALAC/DSD: stream has bit_rate, format also has bit_rate — stream wins + data := []byte(`{"streams":[` + + `{"index":0,"codec_name":"alac","codec_type":"audio","sample_fmt":"s16p",` + + `"sample_rate":"44100","channels":2,"bits_per_sample":0,` + + `"bit_rate":"1011003","bits_per_raw_sample":"16"}],` + + `"format":{"bit_rate":"1050000"}}`) + result, err := parseProbeOutput(data) + Expect(err).ToNot(HaveOccurred()) + Expect(result.BitRate).To(Equal(1011)) // stream-level: 1011003 bps -> 1011 kbps (not format's 1050) + }) + + It("returns BitRate 0 when neither stream nor format has bit_rate", func() { + data := []byte(`{"streams":[` + + `{"index":0,"codec_name":"flac","codec_type":"audio","sample_fmt":"s16",` + + `"sample_rate":"44100","channels":2,"bits_per_sample":0,"bits_per_raw_sample":"16"}],` + + `"format":{}}`) + result, err := parseProbeOutput(data) + Expect(err).ToNot(HaveOccurred()) + Expect(result.BitRate).To(Equal(0)) + }) + + It("clears 'unknown' profile to empty string", func() { + data := []byte(`{"streams":[{"index":0,"codec_name":"flac",` + + `"codec_type":"audio","profile":"unknown","sample_rate":"44100",` + + `"channels":2,"bits_per_sample":0}]}`) + result, err := parseProbeOutput(data) + Expect(err).ToNot(HaveOccurred()) + Expect(result.Profile).To(BeEmpty()) + }) + }) + + Describe("FFmpeg", func() { + Context("when FFmpeg is available", func() { + var ff FFmpeg + + BeforeEach(func() { + ffOnce = sync.Once{} + ff = New() + // Skip if FFmpeg is not available + if !ff.IsAvailable() { + Skip("FFmpeg not available on this system") + } + }) + + It("should interrupt transcoding when context is cancelled", func() { + ctx, cancel := context.WithTimeout(GinkgoT().Context(), 5*time.Second) + defer cancel() + + // Use a command that generates audio indefinitely + // -f lavfi uses FFmpeg's built-in audio source + // -t 0 means no time limit (runs forever) + command := "ffmpeg -f lavfi -i sine=frequency=1000:duration=0 -f mp3 -" + + // The input file is not used here, but we need to provide a valid path to the Transcode function + stream, err := ff.Transcode(ctx, TranscodeOptions{ + Command: command, + Format: "mp3", + FilePath: "tests/fixtures/test.mp3", + BitRate: 128, + }) + Expect(err).ToNot(HaveOccurred()) + defer stream.Close() + + // Read some data first to ensure FFmpeg is running + buf := make([]byte, 1024) + _, err = stream.Read(buf) + Expect(err).ToNot(HaveOccurred()) + + // Cancel the context + cancel() + + // Next read should fail due to cancelled context + _, err = stream.Read(buf) + Expect(err).To(HaveOccurred()) + }) + + It("should handle immediate context cancellation", func() { + ctx, cancel := context.WithCancel(GinkgoT().Context()) + cancel() // Cancel immediately + + // This should fail immediately + _, err := ff.Transcode(ctx, TranscodeOptions{ + Command: "ffmpeg -i %s -f mp3 -", + Format: "mp3", + FilePath: "tests/fixtures/test.mp3", + BitRate: 128, + }) + Expect(err).To(MatchError(context.Canceled)) + }) + }) + + Context("stderr capture", func() { + BeforeEach(func() { + if runtime.GOOS == "windows" { + Skip("stderr capture tests use /bin/sh, skipping on Windows") + } + }) + + It("should include stderr in error when process fails", func() { + ff := &ffmpeg{} + ctx := GinkgoT().Context() + + // Directly call start() with a bash command that writes to stderr and fails + args := []string{"/bin/sh", "-c", "echo 'codec not found: libopus' >&2; exit 1"} + stream, err := ff.start(ctx, args) + Expect(err).ToNot(HaveOccurred()) + defer stream.Close() + + buf := make([]byte, 1024) + _, err = stream.Read(buf) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("codec not found: libopus")) + }) + + It("should not include stderr in error when process succeeds", func() { + ff := &ffmpeg{} + ctx := GinkgoT().Context() + + // Command that writes to stderr but exits successfully + args := []string{"/bin/sh", "-c", "echo 'warning: something' >&2; printf 'output'"} + stream, err := ff.start(ctx, args) + Expect(err).ToNot(HaveOccurred()) + defer stream.Close() + + buf := make([]byte, 1024) + n, err := stream.Read(buf) + Expect(err).ToNot(HaveOccurred()) + Expect(string(buf[:n])).To(Equal("output")) + }) + }) + + Context("with mock process behavior", func() { + var longRunningCmd string + BeforeEach(func() { + // Use a long-running command for testing cancellation + switch runtime.GOOS { + case "windows": + // Use PowerShell's Start-Sleep + ffmpegPath = "powershell" + longRunningCmd = "powershell -Command Start-Sleep -Seconds 10" + default: + // Use sleep on Unix-like systems + ffmpegPath = "sleep" + longRunningCmd = "sleep 10" + } + }) + + It("should terminate the underlying process when context is cancelled", func() { + ff := New() + ctx, cancel := context.WithTimeout(GinkgoT().Context(), 5*time.Second) + defer cancel() + + // Start a process that will run for a while + stream, err := ff.Transcode(ctx, TranscodeOptions{ + Command: longRunningCmd, + FilePath: "tests/fixtures/test.mp3", + }) + Expect(err).ToNot(HaveOccurred()) + defer stream.Close() + + // Give the process time to start + time.Sleep(50 * time.Millisecond) + + // Cancel the context + cancel() + + // Try to read from the stream, which should fail + buf := make([]byte, 100) + _, err = stream.Read(buf) + Expect(err).To(HaveOccurred(), "Expected stream to be closed due to process termination") + + // Verify the stream is closed by attempting another read + _, err = stream.Read(buf) + Expect(err).To(HaveOccurred()) + }) + }) + }) }) diff --git a/core/image_upload.go b/core/image_upload.go new file mode 100644 index 000000000..c2432b647 --- /dev/null +++ b/core/image_upload.go @@ -0,0 +1,71 @@ +package core + +import ( + "context" + "fmt" + "io" + "os" + "path/filepath" + + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/utils" +) + +type ImageUploadService interface { + SetImage(ctx context.Context, entityType string, entityID string, name string, oldPath string, reader io.Reader, ext string) (filename string, err error) + RemoveImage(ctx context.Context, path string) error +} + +type imageUploadService struct{} + +func NewImageUploadService() ImageUploadService { + return &imageUploadService{} +} + +func (s *imageUploadService) SetImage(ctx context.Context, entityType string, entityID string, name string, oldPath string, reader io.Reader, ext string) (string, error) { + filename := imageFilename(entityID, name, ext) + absPath := model.UploadedImagePath(entityType, filename) + + if err := os.MkdirAll(filepath.Dir(absPath), 0755); err != nil { + return "", fmt.Errorf("creating image directory: %w", err) + } + + // Remove old image if it exists + if oldPath != "" { + if err := os.Remove(oldPath); err != nil && !os.IsNotExist(err) { + log.Warn(ctx, "Failed to remove old image", "path", oldPath, err) + } + } + + // Save new image + f, err := os.Create(absPath) + if err != nil { + return "", fmt.Errorf("creating image file: %w", err) + } + defer f.Close() + + if _, err := io.Copy(f, reader); err != nil { + return "", fmt.Errorf("writing image file: %w", err) + } + + return filename, nil +} + +func (s *imageUploadService) RemoveImage(ctx context.Context, path string) error { + if path == "" { + return nil + } + if err := os.Remove(path); err != nil && !os.IsNotExist(err) { + return fmt.Errorf("removing image %q: %w", path, err) + } + return nil +} + +func imageFilename(id, name, ext string) string { + clean := utils.CleanFileName(name) + if clean == "" { + return id + ext + } + return id + "_" + clean + ext +} diff --git a/core/image_upload_test.go b/core/image_upload_test.go new file mode 100644 index 000000000..d13a04775 --- /dev/null +++ b/core/image_upload_test.go @@ -0,0 +1,99 @@ +package core_test + +import ( + "context" + "os" + "path/filepath" + "strings" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/core" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("ImageUploadService", func() { + var svc core.ImageUploadService + var tmpDir string + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + tmpDir = GinkgoT().TempDir() + conf.Server.DataFolder = tmpDir + svc = core.NewImageUploadService() + }) + + Describe("SetImage", func() { + It("creates directory and saves image file", func() { + ctx := context.Background() + reader := strings.NewReader("fake image data") + filename, err := svc.SetImage(ctx, consts.EntityArtist, "ar-1", "Pink Floyd", "", reader, ".jpg") + Expect(err).ToNot(HaveOccurred()) + Expect(filename).To(Equal("ar-1_pink_floyd.jpg")) + + absPath := filepath.Join(tmpDir, "artwork", "artist", "ar-1_pink_floyd.jpg") + data, err := os.ReadFile(absPath) + Expect(err).ToNot(HaveOccurred()) + Expect(string(data)).To(Equal("fake image data")) + }) + + It("falls back to ID-only filename when name cleans to empty", func() { + ctx := context.Background() + reader := strings.NewReader("data") + filename, err := svc.SetImage(ctx, consts.EntityPlaylist, "pl-1", "!!!", "", reader, ".png") + Expect(err).ToNot(HaveOccurred()) + Expect(filename).To(Equal("pl-1.png")) + }) + + It("removes old image when replacing", func() { + ctx := context.Background() + oldDir := filepath.Join(tmpDir, "artwork", "artist") + Expect(os.MkdirAll(oldDir, 0755)).To(Succeed()) + oldFile := filepath.Join(oldDir, "ar-1_old.png") + Expect(os.WriteFile(oldFile, []byte("old"), 0600)).To(Succeed()) + + reader := strings.NewReader("new image") + _, err := svc.SetImage(ctx, consts.EntityArtist, "ar-1", "New Name", oldFile, reader, ".jpg") + Expect(err).ToNot(HaveOccurred()) + Expect(oldFile).ToNot(BeAnExistingFile()) + + newPath := filepath.Join(oldDir, "ar-1_new_name.jpg") + Expect(newPath).To(BeAnExistingFile()) + }) + + It("ignores missing old file without error", func() { + ctx := context.Background() + reader := strings.NewReader("data") + _, err := svc.SetImage(ctx, consts.EntityArtist, "ar-1", "Name", "/nonexistent/path.jpg", reader, ".jpg") + Expect(err).ToNot(HaveOccurred()) + }) + }) + + Describe("RemoveImage", func() { + It("removes the file at the given path", func() { + ctx := context.Background() + dir := filepath.Join(tmpDir, "artwork", "artist") + Expect(os.MkdirAll(dir, 0755)).To(Succeed()) + path := filepath.Join(dir, "ar-1_test.jpg") + Expect(os.WriteFile(path, []byte("img"), 0600)).To(Succeed()) + + err := svc.RemoveImage(ctx, path) + Expect(err).ToNot(HaveOccurred()) + Expect(path).ToNot(BeAnExistingFile()) + }) + + It("succeeds when file does not exist", func() { + ctx := context.Background() + err := svc.RemoveImage(ctx, "/nonexistent/file.jpg") + Expect(err).ToNot(HaveOccurred()) + }) + + It("succeeds with empty path", func() { + ctx := context.Background() + err := svc.RemoveImage(ctx, "") + Expect(err).ToNot(HaveOccurred()) + }) + }) +}) diff --git a/core/library.go b/core/library.go index 7abd35c8f..0bf3be9fa 100644 --- a/core/library.go +++ b/core/library.go @@ -21,11 +21,6 @@ import ( "github.com/navidrome/navidrome/utils/slice" ) -// Scanner interface for triggering scans -type Scanner interface { - ScanAll(ctx context.Context, fullScan bool) (warnings []string, err error) -} - // Watcher interface for managing file system watchers type Watcher interface { Watch(ctx context.Context, lib *model.Library) error @@ -42,19 +37,21 @@ type Library interface { } type libraryService struct { - ds model.DataStore - scanner Scanner - watcher Watcher - broker events.Broker + ds model.DataStore + scanner model.Scanner + watcher Watcher + broker events.Broker + pluginManager PluginUnloader } // NewLibrary creates a new Library service -func NewLibrary(ds model.DataStore, scanner Scanner, watcher Watcher, broker events.Broker) Library { +func NewLibrary(ds model.DataStore, scanner model.Scanner, watcher Watcher, broker events.Broker, pluginManager PluginUnloader) Library { return &libraryService{ - ds: ds, - scanner: scanner, - watcher: watcher, - broker: broker, + ds: ds, + scanner: scanner, + watcher: watcher, + broker: broker, + pluginManager: pluginManager, } } @@ -146,6 +143,7 @@ func (s *libraryService) NewRepository(ctx context.Context) rest.Repository { scanner: s.scanner, watcher: s.watcher, broker: s.broker, + pluginManager: s.pluginManager, } return wrapper } @@ -153,14 +151,15 @@ func (s *libraryService) NewRepository(ctx context.Context) rest.Repository { type libraryRepositoryWrapper struct { rest.Repository model.LibraryRepository - ctx context.Context - ds model.DataStore - scanner Scanner - watcher Watcher - broker events.Broker + ctx context.Context + ds model.DataStore + scanner model.Scanner + watcher Watcher + broker events.Broker + pluginManager PluginUnloader } -func (r *libraryRepositoryWrapper) Save(entity interface{}) (string, error) { +func (r *libraryRepositoryWrapper) Save(entity any) (string, error) { lib := entity.(*model.Library) if err := r.validateLibrary(lib); err != nil { return "", err @@ -192,7 +191,7 @@ func (r *libraryRepositoryWrapper) Save(entity interface{}) (string, error) { return strconv.Itoa(lib.ID), nil } -func (r *libraryRepositoryWrapper) Update(id string, entity interface{}, cols ...string) error { +func (r *libraryRepositoryWrapper) Update(id string, entity any, _ ...string) error { lib := entity.(*model.Library) libID, err := strconv.Atoi(id) if err != nil { @@ -277,6 +276,10 @@ func (r *libraryRepositoryWrapper) Delete(id string) error { log.Debug(r.ctx, "Library deleted - sent refresh event", "libraryID", libID, "name", lib.Name) } + // After successful deletion, check if any plugins were auto-disabled + // and need to be unloaded from memory + r.pluginManager.UnloadDisabledPlugins(r.ctx) + return nil } diff --git a/core/library_test.go b/core/library_test.go index bfbb4300a..175d9c37d 100644 --- a/core/library_test.go +++ b/core/library_test.go @@ -9,7 +9,7 @@ import ( "sync" "github.com/deluan/rest" - _ "github.com/navidrome/navidrome/adapters/taglib" // Register taglib extractor + _ "github.com/navidrome/navidrome/adapters/gotaglib" // Register taglib extractor "github.com/navidrome/navidrome/conf/configtest" "github.com/navidrome/navidrome/core" _ "github.com/navidrome/navidrome/core/storage/local" // Register local storage @@ -29,9 +29,10 @@ var _ = Describe("Library Service", func() { var userRepo *tests.MockedUserRepo var ctx context.Context var tempDir string - var scanner *mockScanner + var scanner *tests.MockScanner var watcherManager *mockWatcherManager var broker *mockEventBroker + var pluginManager *mockPluginUnloader BeforeEach(func() { DeferCleanup(configtest.SetupConfig()) @@ -43,14 +44,16 @@ var _ = Describe("Library Service", func() { ds.MockedUser = userRepo // Create a mock scanner that tracks calls - scanner = &mockScanner{} + scanner = tests.NewMockScanner() // Create a mock watcher manager watcherManager = &mockWatcherManager{ libraryStates: make(map[int]model.Library), } // Create a mock event broker broker = &mockEventBroker{} - service = core.NewLibrary(ds, scanner, watcherManager, broker) + // Create a mock plugin unloader + pluginManager = &mockPluginUnloader{} + service = core.NewLibrary(ds, scanner, watcherManager, broker, pluginManager) ctx = context.Background() // Create a temporary directory for testing valid paths @@ -616,11 +619,12 @@ var _ = Describe("Library Service", func() { // Wait briefly for the goroutine to complete Eventually(func() int { - return scanner.len() + return scanner.GetScanAllCallCount() }, "1s", "10ms").Should(Equal(1)) // Verify scan was called with correct parameters - Expect(scanner.ScanCalls[0].FullScan).To(BeFalse()) // Should be quick scan + calls := scanner.GetScanAllCalls() + Expect(calls[0].FullScan).To(BeFalse()) // Should be quick scan }) It("triggers scan when updating library path", func() { @@ -641,11 +645,12 @@ var _ = Describe("Library Service", func() { // Wait briefly for the goroutine to complete Eventually(func() int { - return scanner.len() + return scanner.GetScanAllCallCount() }, "1s", "10ms").Should(Equal(1)) // Verify scan was called with correct parameters - Expect(scanner.ScanCalls[0].FullScan).To(BeFalse()) // Should be quick scan + calls := scanner.GetScanAllCalls() + Expect(calls[0].FullScan).To(BeFalse()) // Should be quick scan }) It("does not trigger scan when updating library without path change", func() { @@ -661,7 +666,7 @@ var _ = Describe("Library Service", func() { // Wait a bit to ensure no scan was triggered Consistently(func() int { - return scanner.len() + return scanner.GetScanAllCallCount() }, "100ms", "10ms").Should(Equal(0)) }) @@ -674,7 +679,7 @@ var _ = Describe("Library Service", func() { // Ensure no scan was triggered since creation failed Consistently(func() int { - return scanner.len() + return scanner.GetScanAllCallCount() }, "100ms", "10ms").Should(Equal(0)) }) @@ -691,7 +696,7 @@ var _ = Describe("Library Service", func() { // Ensure no scan was triggered since update failed Consistently(func() int { - return scanner.len() + return scanner.GetScanAllCallCount() }, "100ms", "10ms").Should(Equal(0)) }) @@ -707,11 +712,12 @@ var _ = Describe("Library Service", func() { // Wait briefly for the goroutine to complete Eventually(func() int { - return scanner.len() + return scanner.GetScanAllCallCount() }, "1s", "10ms").Should(Equal(1)) // Verify scan was called with correct parameters - Expect(scanner.ScanCalls[0].FullScan).To(BeFalse()) // Should be quick scan + calls := scanner.GetScanAllCalls() + Expect(calls[0].FullScan).To(BeFalse()) // Should be quick scan }) It("does not trigger scan when library deletion fails", func() { @@ -721,7 +727,7 @@ var _ = Describe("Library Service", func() { // Ensure no scan was triggered since deletion failed Consistently(func() int { - return scanner.len() + return scanner.GetScanAllCallCount() }, "100ms", "10ms").Should(Equal(0)) }) @@ -866,31 +872,43 @@ var _ = Describe("Library Service", func() { Expect(broker.Events).To(HaveLen(1)) }) }) + + Describe("Plugin Manager Integration", func() { + var repo rest.Persistable + + BeforeEach(func() { + // Reset the call count for each test + pluginManager.unloadCalls = 0 + r := service.NewRepository(ctx) + repo = r.(rest.Persistable) + }) + + It("calls UnloadDisabledPlugins after successful library deletion", func() { + libraryRepo.SetData(model.Libraries{ + {ID: 2, Name: "Library to Delete", Path: tempDir}, + }) + + err := repo.Delete("2") + Expect(err).NotTo(HaveOccurred()) + Expect(pluginManager.unloadCalls).To(Equal(1)) + }) + + It("does not call UnloadDisabledPlugins when library deletion fails", func() { + // Try to delete non-existent library + err := repo.Delete("999") + Expect(err).To(HaveOccurred()) + Expect(pluginManager.unloadCalls).To(Equal(0)) + }) + }) }) -// mockScanner provides a simple mock implementation of core.Scanner for testing -type mockScanner struct { - ScanCalls []ScanCall - mu sync.RWMutex +// mockPluginUnloader is a simple mock for testing UnloadDisabledPlugins calls +type mockPluginUnloader struct { + unloadCalls int } -type ScanCall struct { - FullScan bool -} - -func (m *mockScanner) ScanAll(ctx context.Context, fullScan bool) (warnings []string, err error) { - m.mu.Lock() - defer m.mu.Unlock() - m.ScanCalls = append(m.ScanCalls, ScanCall{ - FullScan: fullScan, - }) - return []string{}, nil -} - -func (m *mockScanner) len() int { - m.mu.RLock() - defer m.mu.RUnlock() - return len(m.ScanCalls) +func (m *mockPluginUnloader) UnloadDisabledPlugins(ctx context.Context) { + m.unloadCalls++ } // mockWatcherManager provides a simple mock implementation of core.Watcher for testing diff --git a/core/lyrics/lyrics.go b/core/lyrics/lyrics.go index 858a3ffd8..758053042 100644 --- a/core/lyrics/lyrics.go +++ b/core/lyrics/lyrics.go @@ -9,23 +9,45 @@ import ( "github.com/navidrome/navidrome/model" ) -func GetLyrics(ctx context.Context, mf *model.MediaFile) (model.LyricList, error) { +// Lyrics can fetch lyrics for a media file. +type Lyrics interface { + GetLyrics(ctx context.Context, mf *model.MediaFile) (model.LyricList, error) +} + +// PluginLoader discovers and loads lyrics provider plugins. +type PluginLoader interface { + LoadLyricsProvider(name string) (Lyrics, bool) +} + +type lyricsService struct { + pluginLoader PluginLoader +} + +// NewLyrics creates a new lyrics service. pluginLoader may be nil if no plugin +// system is available. +func NewLyrics(pluginLoader PluginLoader) Lyrics { + return &lyricsService{pluginLoader: pluginLoader} +} + +// GetLyrics returns lyrics for the given media file, trying sources in the +// order specified by conf.Server.LyricsPriority. +func (l *lyricsService) GetLyrics(ctx context.Context, mf *model.MediaFile) (model.LyricList, error) { var lyricsList model.LyricList var err error - for pattern := range strings.SplitSeq(strings.ToLower(conf.Server.LyricsPriority), ",") { + for pattern := range strings.SplitSeq(conf.Server.LyricsPriority, ",") { pattern = strings.TrimSpace(pattern) switch { - case pattern == "embedded": + case strings.EqualFold(pattern, "embedded"): lyricsList, err = fromEmbedded(ctx, mf) case strings.HasPrefix(pattern, "."): - lyricsList, err = fromExternalFile(ctx, mf, pattern) + lyricsList, err = fromExternalFile(ctx, mf, strings.ToLower(pattern)) default: - log.Error(ctx, "Invalid lyric pattern", "pattern", pattern) + lyricsList, err = l.fromPlugin(ctx, mf, pattern) } if err != nil { - log.Error(ctx, "error parsing lyrics", "source", pattern, err) + log.Error(ctx, "error getting lyrics", "source", pattern, err) } if len(lyricsList) > 0 { diff --git a/core/lyrics/lyrics_test.go b/core/lyrics/lyrics_test.go index f4197ccf6..2e495a714 100644 --- a/core/lyrics/lyrics_test.go +++ b/core/lyrics/lyrics_test.go @@ -3,6 +3,7 @@ package lyrics_test import ( "context" "encoding/json" + "fmt" "os" "github.com/navidrome/navidrome/conf" @@ -72,7 +73,8 @@ var _ = Describe("sources", func() { DescribeTable("Lyrics Priority", func(priority string, expected model.LyricList) { conf.Server.LyricsPriority = priority - list, err := lyrics.GetLyrics(ctx, &mf) + svc := lyrics.NewLyrics(nil) + list, err := svc.GetLyrics(ctx, &mf) Expect(err).To(BeNil()) Expect(list).To(Equal(expected)) }, @@ -107,7 +109,8 @@ var _ = Describe("sources", func() { It("should fallback to embedded if an error happens when parsing file", func() { conf.Server.LyricsPriority = ".mp3,embedded" - list, err := lyrics.GetLyrics(ctx, &mf) + svc := lyrics.NewLyrics(nil) + list, err := svc.GetLyrics(ctx, &mf) Expect(err).To(BeNil()) Expect(list).To(Equal(embeddedLyrics)) }) @@ -115,10 +118,109 @@ var _ = Describe("sources", func() { It("should return nothing if error happens when trying to parse file", func() { conf.Server.LyricsPriority = ".mp3" - list, err := lyrics.GetLyrics(ctx, &mf) + svc := lyrics.NewLyrics(nil) + list, err := svc.GetLyrics(ctx, &mf) Expect(err).To(BeNil()) Expect(list).To(BeEmpty()) }) }) }) + + Context("plugin sources", func() { + var mockLoader *mockPluginLoader + + BeforeEach(func() { + mockLoader = &mockPluginLoader{} + }) + + It("should return lyrics from a plugin", func() { + conf.Server.LyricsPriority = "test-lyrics-plugin" + mockLoader.lyrics = unsyncedLyrics + svc := lyrics.NewLyrics(mockLoader) + list, err := svc.GetLyrics(ctx, &mf) + Expect(err).To(BeNil()) + Expect(list).To(Equal(unsyncedLyrics)) + }) + + It("should try plugin after embedded returns nothing", func() { + conf.Server.LyricsPriority = "embedded,test-lyrics-plugin" + mf.Lyrics = "" // No embedded lyrics + mockLoader.lyrics = unsyncedLyrics + svc := lyrics.NewLyrics(mockLoader) + list, err := svc.GetLyrics(ctx, &mf) + Expect(err).To(BeNil()) + Expect(list).To(Equal(unsyncedLyrics)) + }) + + It("should skip plugin if embedded has lyrics", func() { + conf.Server.LyricsPriority = "embedded,test-lyrics-plugin" + mockLoader.lyrics = unsyncedLyrics + svc := lyrics.NewLyrics(mockLoader) + list, err := svc.GetLyrics(ctx, &mf) + Expect(err).To(BeNil()) + Expect(list).To(Equal(embeddedLyrics)) // embedded wins + }) + + It("should skip unknown plugin names gracefully", func() { + conf.Server.LyricsPriority = "nonexistent-plugin,embedded" + mockLoader.notFound = true + svc := lyrics.NewLyrics(mockLoader) + list, err := svc.GetLyrics(ctx, &mf) + Expect(err).To(BeNil()) + Expect(list).To(Equal(embeddedLyrics)) // falls through to embedded + }) + + It("should preserve plugin name case from config", func() { + conf.Server.LyricsPriority = "MyLyricsPlugin" + mockLoader.pluginName = "MyLyricsPlugin" + mockLoader.lyrics = unsyncedLyrics + svc := lyrics.NewLyrics(mockLoader) + list, err := svc.GetLyrics(ctx, &mf) + Expect(err).To(BeNil()) + Expect(list).To(Equal(unsyncedLyrics)) + }) + + It("should handle plugin error gracefully", func() { + conf.Server.LyricsPriority = "test-lyrics-plugin,embedded" + mockLoader.err = fmt.Errorf("plugin error") + svc := lyrics.NewLyrics(mockLoader) + list, err := svc.GetLyrics(ctx, &mf) + Expect(err).To(BeNil()) + Expect(list).To(Equal(embeddedLyrics)) // falls through to embedded + }) + }) }) + +type mockPluginLoader struct { + lyrics model.LyricList + err error + notFound bool + pluginName string // expected plugin name (exact match, like real manager) +} + +func (m *mockPluginLoader) PluginNames(_ string) []string { + if m.notFound { + return nil + } + return []string{"test-lyrics-plugin"} +} + +func (m *mockPluginLoader) LoadLyricsProvider(name string) (lyrics.Lyrics, bool) { + if m.notFound { + return nil, false + } + // If pluginName is set, require exact match (like the real plugin manager) + if m.pluginName != "" && name != m.pluginName { + return nil, false + } + return &mockLyricsProvider{lyrics: m.lyrics, err: m.err}, true +} + +type mockLyricsProvider struct { + lyrics model.LyricList + err error +} + +func (m *mockLyricsProvider) GetLyrics(_ context.Context, _ *model.MediaFile) (model.LyricList, error) { + return m.lyrics, m.err +} diff --git a/core/lyrics/sources.go b/core/lyrics/sources.go index 6d4a4cc6f..82a10ca41 100644 --- a/core/lyrics/sources.go +++ b/core/lyrics/sources.go @@ -8,6 +8,7 @@ import ( "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/utils/ioutils" ) func fromEmbedded(ctx context.Context, mf *model.MediaFile) (model.LyricList, error) { @@ -27,8 +28,7 @@ func fromExternalFile(ctx context.Context, mf *model.MediaFile, suffix string) ( externalLyric := basePath[0:len(basePath)-len(ext)] + suffix - contents, err := os.ReadFile(externalLyric) - + contents, err := ioutils.UTF8ReadFile(externalLyric) if errors.Is(err, os.ErrNotExist) { log.Trace(ctx, "no lyrics found at path", "path", externalLyric) return nil, nil @@ -49,3 +49,27 @@ func fromExternalFile(ctx context.Context, mf *model.MediaFile, suffix string) ( return model.LyricList{*lyrics}, nil } + +// fromPlugin attempts to load lyrics from a plugin with the given name. +func (l *lyricsService) fromPlugin(ctx context.Context, mf *model.MediaFile, pluginName string) (model.LyricList, error) { + if l.pluginLoader == nil { + log.Debug(ctx, "Invalid lyric source", "source", pluginName) + return nil, nil + } + + provider, ok := l.pluginLoader.LoadLyricsProvider(pluginName) + if !ok { + log.Warn(ctx, "Lyrics plugin not found", "plugin", pluginName) + return nil, nil + } + + lyricsList, err := provider.GetLyrics(ctx, mf) + if err != nil { + return nil, err + } + + if len(lyricsList) > 0 { + log.Trace(ctx, "Retrieved lyrics from plugin", "plugin", pluginName, "count", len(lyricsList)) + } + return lyricsList, nil +} diff --git a/core/lyrics/sources_test.go b/core/lyrics/sources_test.go index e92564c00..b3d502101 100644 --- a/core/lyrics/sources_test.go +++ b/core/lyrics/sources_test.go @@ -108,5 +108,39 @@ var _ = Describe("sources", func() { }, })) }) + + It("should handle LRC files with UTF-8 BOM marker (issue #4631)", func() { + // The function looks for , so we need to pass + // a MediaFile with .mp3 path and look for .lrc suffix + mf := model.MediaFile{Path: "tests/fixtures/bom-test.mp3"} + lyrics, err := fromExternalFile(ctx, &mf, ".lrc") + + Expect(err).To(BeNil()) + Expect(lyrics).ToNot(BeNil()) + Expect(lyrics).To(HaveLen(1)) + + // The critical assertion: even with BOM, synced should be true + Expect(lyrics[0].Synced).To(BeTrue(), "Lyrics with BOM marker should be recognized as synced") + Expect(lyrics[0].Line).To(HaveLen(1)) + Expect(lyrics[0].Line[0].Start).To(Equal(gg.P(int64(0)))) + Expect(lyrics[0].Line[0].Value).To(ContainSubstring("作曲")) + }) + + It("should handle UTF-16 LE encoded LRC files", func() { + mf := model.MediaFile{Path: "tests/fixtures/bom-utf16-test.mp3"} + lyrics, err := fromExternalFile(ctx, &mf, ".lrc") + + Expect(err).To(BeNil()) + Expect(lyrics).ToNot(BeNil()) + Expect(lyrics).To(HaveLen(1)) + + // UTF-16 should be properly converted to UTF-8 + Expect(lyrics[0].Synced).To(BeTrue(), "UTF-16 encoded lyrics should be recognized as synced") + Expect(lyrics[0].Line).To(HaveLen(2)) + Expect(lyrics[0].Line[0].Start).To(Equal(gg.P(int64(18800)))) + Expect(lyrics[0].Line[0].Value).To(Equal("We're no strangers to love")) + Expect(lyrics[0].Line[1].Start).To(Equal(gg.P(int64(22801)))) + Expect(lyrics[0].Line[1].Value).To(Equal("You know the rules and so do I")) + }) }) }) diff --git a/core/maintenance.go b/core/maintenance.go new file mode 100644 index 000000000..13d1141d3 --- /dev/null +++ b/core/maintenance.go @@ -0,0 +1,224 @@ +package core + +import ( + "context" + "fmt" + "slices" + "sync" + "time" + + "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/utils/slice" +) + +type Maintenance interface { + // DeleteMissingFiles deletes specific missing files by their IDs + DeleteMissingFiles(ctx context.Context, ids []string) error + // DeleteAllMissingFiles deletes all files marked as missing + DeleteAllMissingFiles(ctx context.Context) error +} + +type maintenanceService struct { + ds model.DataStore + wg sync.WaitGroup +} + +func NewMaintenance(ds model.DataStore) Maintenance { + return &maintenanceService{ + ds: ds, + } +} + +func (s *maintenanceService) DeleteMissingFiles(ctx context.Context, ids []string) error { + return s.deleteMissing(ctx, ids) +} + +func (s *maintenanceService) DeleteAllMissingFiles(ctx context.Context) error { + return s.deleteMissing(ctx, nil) +} + +// deleteMissing handles the deletion of missing files and triggers necessary cleanup operations +func (s *maintenanceService) deleteMissing(ctx context.Context, ids []string) error { + // Track affected album IDs before deletion for refresh + affectedAlbumIDs, err := s.getAffectedAlbumIDs(ctx, ids) + if err != nil { + log.Warn(ctx, "Error tracking affected albums for refresh", err) + // Don't fail the operation, just log the warning + } + + // Delete missing files within a transaction + err = s.ds.WithTx(func(tx model.DataStore) error { + if len(ids) == 0 { + _, err := tx.MediaFile(ctx).DeleteAllMissing() + return err + } + return tx.MediaFile(ctx).DeleteMissing(ids) + }) + if err != nil { + log.Error(ctx, "Error deleting missing tracks from DB", "ids", ids, err) + return err + } + + // Run garbage collection to clean up orphaned records + if err := s.ds.GC(ctx); err != nil { + log.Error(ctx, "Error running GC after deleting missing tracks", err) + return err + } + + // Refresh statistics in background + s.refreshStatsAsync(ctx, affectedAlbumIDs) + + return nil +} + +// refreshAlbums recalculates album attributes (size, duration, song count, etc.) from media files. +// It uses batch queries to minimize database round-trips for efficiency. +func (s *maintenanceService) refreshAlbums(ctx context.Context, albumIDs []string) error { + if len(albumIDs) == 0 { + return nil + } + + log.Debug(ctx, "Refreshing albums", "count", len(albumIDs)) + + // Process in chunks to avoid query size limits + const chunkSize = 100 + for chunk := range slice.CollectChunks(slices.Values(albumIDs), chunkSize) { + if err := s.refreshAlbumChunk(ctx, chunk); err != nil { + return fmt.Errorf("refreshing album chunk: %w", err) + } + } + + log.Debug(ctx, "Successfully refreshed albums", "count", len(albumIDs)) + return nil +} + +// refreshAlbumChunk processes a single chunk of album IDs +func (s *maintenanceService) refreshAlbumChunk(ctx context.Context, albumIDs []string) error { + albumRepo := s.ds.Album(ctx) + mfRepo := s.ds.MediaFile(ctx) + + // Batch load existing albums + albums, err := albumRepo.GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"album.id": albumIDs}, + }) + if err != nil { + return fmt.Errorf("loading albums: %w", err) + } + + // Create a map for quick lookup + albumMap := make(map[string]*model.Album, len(albums)) + for i := range albums { + albumMap[albums[i].ID] = &albums[i] + } + + // Batch load all media files for these albums + mediaFiles, err := mfRepo.GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"album_id": albumIDs}, + Sort: "album_id, path", + }) + if err != nil { + return fmt.Errorf("loading media files: %w", err) + } + + // Group media files by album ID + filesByAlbum := make(map[string]model.MediaFiles) + for i := range mediaFiles { + albumID := mediaFiles[i].AlbumID + filesByAlbum[albumID] = append(filesByAlbum[albumID], mediaFiles[i]) + } + + // Recalculate each album from its media files + for albumID, oldAlbum := range albumMap { + mfs, hasTracks := filesByAlbum[albumID] + if !hasTracks { + // Album has no tracks anymore, skip (will be cleaned up by GC) + log.Debug(ctx, "Skipping album with no tracks", "albumID", albumID) + continue + } + + // Recalculate album from media files + newAlbum := mfs.ToAlbum() + + // Only update if something changed (avoid unnecessary writes) + if !oldAlbum.Equals(newAlbum) { + // Preserve original timestamps + newAlbum.UpdatedAt = time.Now() + newAlbum.CreatedAt = oldAlbum.CreatedAt + + if err := albumRepo.Put(&newAlbum); err != nil { + log.Error(ctx, "Error updating album during refresh", "albumID", albumID, err) + // Continue with other albums instead of failing entirely + continue + } + log.Trace(ctx, "Refreshed album", "albumID", albumID, "name", newAlbum.Name) + } + } + + return nil +} + +// getAffectedAlbumIDs returns distinct album IDs from missing media files +func (s *maintenanceService) getAffectedAlbumIDs(ctx context.Context, ids []string) ([]string, error) { + var filters squirrel.Sqlizer = squirrel.Eq{"missing": true} + if len(ids) > 0 { + filters = squirrel.And{ + squirrel.Eq{"missing": true}, + squirrel.Eq{"media_file.id": ids}, + } + } + + mfs, err := s.ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: filters, + }) + if err != nil { + return nil, err + } + + // Extract unique album IDs + albumIDMap := make(map[string]struct{}, len(mfs)) + for _, mf := range mfs { + if mf.AlbumID != "" { + albumIDMap[mf.AlbumID] = struct{}{} + } + } + + albumIDs := make([]string, 0, len(albumIDMap)) + for id := range albumIDMap { + albumIDs = append(albumIDs, id) + } + + return albumIDs, nil +} + +// refreshStatsAsync refreshes artist and album statistics in background goroutines +func (s *maintenanceService) refreshStatsAsync(ctx context.Context, affectedAlbumIDs []string) { + // Refresh artist stats in background + s.wg.Go(func() { + bgCtx := request.AddValues(context.Background(), ctx) + if _, err := s.ds.Artist(bgCtx).RefreshStats(true); err != nil { + log.Error(bgCtx, "Error refreshing artist stats after deleting missing files", err) + } else { + log.Debug(bgCtx, "Successfully refreshed artist stats after deleting missing files") + } + + // Refresh album stats in background if we have affected albums + if len(affectedAlbumIDs) > 0 { + if err := s.refreshAlbums(bgCtx, affectedAlbumIDs); err != nil { + log.Error(bgCtx, "Error refreshing album stats after deleting missing files", err) + } else { + log.Debug(bgCtx, "Successfully refreshed album stats after deleting missing files", "count", len(affectedAlbumIDs)) + } + } + }) +} + +// Wait waits for all background goroutines to complete. +// WARNING: This method is ONLY for testing. Never call this in production code. +// Calling Wait() in production will block until ALL background operations complete +// and may cause race conditions with new operations starting. +func (s *maintenanceService) wait() { + s.wg.Wait() +} diff --git a/core/maintenance_test.go b/core/maintenance_test.go new file mode 100644 index 000000000..09b442438 --- /dev/null +++ b/core/maintenance_test.go @@ -0,0 +1,364 @@ +package core + +import ( + "context" + "errors" + "sync" + + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + "github.com/sirupsen/logrus" +) + +var _ = Describe("Maintenance", func() { + var ds *tests.MockDataStore + var mfRepo *extendedMediaFileRepo + var service Maintenance + var ctx context.Context + + BeforeEach(func() { + ctx = context.Background() + ctx = request.WithUser(ctx, model.User{ID: "user1", IsAdmin: true}) + + ds = createTestDataStore() + mfRepo = ds.MockedMediaFile.(*extendedMediaFileRepo) + service = NewMaintenance(ds) + }) + + Describe("DeleteMissingFiles", func() { + Context("with specific IDs", func() { + It("deletes specific missing files and runs GC", func() { + // Setup: mock missing files with album IDs + mfRepo.SetData(model.MediaFiles{ + {ID: "mf1", AlbumID: "album1", Missing: true}, + {ID: "mf2", AlbumID: "album2", Missing: true}, + }) + + err := service.DeleteMissingFiles(ctx, []string{"mf1", "mf2"}) + + Expect(err).ToNot(HaveOccurred()) + Expect(mfRepo.deleteMissingCalled).To(BeTrue()) + Expect(mfRepo.deletedIDs).To(Equal([]string{"mf1", "mf2"})) + Expect(ds.GCCalled).To(BeTrue(), "GC should be called after deletion") + }) + + It("triggers artist stats refresh and album refresh after deletion", func() { + artistRepo := ds.MockedArtist.(*extendedArtistRepo) + // Setup: mock missing files with albums + albumRepo := ds.MockedAlbum.(*extendedAlbumRepo) + albumRepo.SetData(model.Albums{ + {ID: "album1", Name: "Test Album", SongCount: 5}, + }) + mfRepo.SetData(model.MediaFiles{ + {ID: "mf1", AlbumID: "album1", Missing: true}, + {ID: "mf2", AlbumID: "album1", Missing: false, Size: 1000, Duration: 180}, + {ID: "mf3", AlbumID: "album1", Missing: false, Size: 2000, Duration: 200}, + }) + + err := service.DeleteMissingFiles(ctx, []string{"mf1"}) + + Expect(err).ToNot(HaveOccurred()) + + // Wait for background goroutines to complete + service.(*maintenanceService).wait() + + // RefreshStats should be called + Expect(artistRepo.IsRefreshStatsCalled()).To(BeTrue(), "Artist stats should be refreshed") + + // Album should be updated with new calculated values + Expect(albumRepo.GetPutCallCount()).To(BeNumerically(">", 0), "Album.Put() should be called to refresh album data") + }) + + It("returns error if deletion fails", func() { + mfRepo.deleteMissingError = errors.New("delete failed") + + err := service.DeleteMissingFiles(ctx, []string{"mf1"}) + + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("delete failed")) + }) + + It("continues even if album tracking fails", func() { + mfRepo.SetError(true) + + err := service.DeleteMissingFiles(ctx, []string{"mf1"}) + + // Should not fail, just log warning + Expect(err).ToNot(HaveOccurred()) + Expect(mfRepo.deleteMissingCalled).To(BeTrue()) + }) + + It("returns error if GC fails", func() { + mfRepo.SetData(model.MediaFiles{ + {ID: "mf1", AlbumID: "album1", Missing: true}, + }) + + // Set GC to return error + ds.GCError = errors.New("gc failed") + + err := service.DeleteMissingFiles(ctx, []string{"mf1"}) + + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("gc failed")) + }) + }) + + Context("album ID extraction", func() { + It("extracts unique album IDs from missing files", func() { + mfRepo.SetData(model.MediaFiles{ + {ID: "mf1", AlbumID: "album1", Missing: true}, + {ID: "mf2", AlbumID: "album1", Missing: true}, + {ID: "mf3", AlbumID: "album2", Missing: true}, + }) + + err := service.DeleteMissingFiles(ctx, []string{"mf1", "mf2", "mf3"}) + + Expect(err).ToNot(HaveOccurred()) + }) + + It("skips files without album IDs", func() { + mfRepo.SetData(model.MediaFiles{ + {ID: "mf1", AlbumID: "", Missing: true}, + {ID: "mf2", AlbumID: "album1", Missing: true}, + }) + + err := service.DeleteMissingFiles(ctx, []string{"mf1", "mf2"}) + + Expect(err).ToNot(HaveOccurred()) + }) + }) + }) + + Describe("DeleteAllMissingFiles", func() { + It("deletes all missing files and runs GC", func() { + mfRepo.SetData(model.MediaFiles{ + {ID: "mf1", AlbumID: "album1", Missing: true}, + {ID: "mf2", AlbumID: "album2", Missing: true}, + {ID: "mf3", AlbumID: "album3", Missing: true}, + }) + + err := service.DeleteAllMissingFiles(ctx) + + Expect(err).ToNot(HaveOccurred()) + Expect(ds.GCCalled).To(BeTrue(), "GC should be called after deletion") + }) + + It("returns error if deletion fails", func() { + mfRepo.SetError(true) + + err := service.DeleteAllMissingFiles(ctx) + + Expect(err).To(HaveOccurred()) + }) + + It("handles empty result gracefully", func() { + mfRepo.SetData(model.MediaFiles{}) + + err := service.DeleteAllMissingFiles(ctx) + + Expect(err).ToNot(HaveOccurred()) + }) + }) + + Describe("Album refresh logic", func() { + var albumRepo *extendedAlbumRepo + + BeforeEach(func() { + albumRepo = ds.MockedAlbum.(*extendedAlbumRepo) + }) + + Context("when album has no tracks after deletion", func() { + It("skips the album without updating it", func() { + // Setup album with no remaining tracks + albumRepo.SetData(model.Albums{ + {ID: "album1", Name: "Empty Album", SongCount: 1}, + }) + mfRepo.SetData(model.MediaFiles{ + {ID: "mf1", AlbumID: "album1", Missing: true}, + }) + + err := service.DeleteMissingFiles(ctx, []string{"mf1"}) + + Expect(err).ToNot(HaveOccurred()) + + // Wait for background goroutines to complete + service.(*maintenanceService).wait() + + // Album should NOT be updated because it has no tracks left + Expect(albumRepo.GetPutCallCount()).To(Equal(0), "Album with no tracks should not be updated") + }) + }) + + Context("when Put fails for one album", func() { + It("continues processing other albums", func() { + albumRepo.SetData(model.Albums{ + {ID: "album1", Name: "Album 1"}, + {ID: "album2", Name: "Album 2"}, + }) + mfRepo.SetData(model.MediaFiles{ + {ID: "mf1", AlbumID: "album1", Missing: true}, + {ID: "mf2", AlbumID: "album1", Missing: false, Size: 1000, Duration: 180}, + {ID: "mf3", AlbumID: "album2", Missing: true}, + {ID: "mf4", AlbumID: "album2", Missing: false, Size: 2000, Duration: 200}, + }) + + // Make Put fail on first call but succeed on subsequent calls + albumRepo.putError = errors.New("put failed") + albumRepo.failOnce = true + + err := service.DeleteMissingFiles(ctx, []string{"mf1", "mf3"}) + + // Should not fail even if one album's Put fails + Expect(err).ToNot(HaveOccurred()) + + // Wait for background goroutines to complete + service.(*maintenanceService).wait() + + // Put should have been called multiple times + Expect(albumRepo.GetPutCallCount()).To(BeNumerically(">", 0), "Put should be attempted") + }) + }) + + Context("when media file loading fails", func() { + It("logs warning but continues when tracking affected albums fails", func() { + // Set up log capturing + hook, cleanup := tests.LogHook() + defer cleanup() + + albumRepo.SetData(model.Albums{ + {ID: "album1", Name: "Album 1"}, + }) + mfRepo.SetData(model.MediaFiles{ + {ID: "mf1", AlbumID: "album1", Missing: true}, + }) + // Make GetAll fail when loading media files + mfRepo.SetError(true) + + err := service.DeleteMissingFiles(ctx, []string{"mf1"}) + + // Deletion should succeed despite the tracking error + Expect(err).ToNot(HaveOccurred()) + Expect(mfRepo.deleteMissingCalled).To(BeTrue()) + + // Verify the warning was logged + Expect(hook.LastEntry()).ToNot(BeNil()) + Expect(hook.LastEntry().Level).To(Equal(logrus.WarnLevel)) + Expect(hook.LastEntry().Message).To(Equal("Error tracking affected albums for refresh")) + }) + }) + }) +}) + +// Test helper to create a mock DataStore with controllable behavior +func createTestDataStore() *tests.MockDataStore { + ds := &tests.MockDataStore{} + + // Create extended album repo with Put tracking + albumRepo := &extendedAlbumRepo{ + MockAlbumRepo: tests.CreateMockAlbumRepo(), + } + ds.MockedAlbum = albumRepo + + // Create extended artist repo with RefreshStats tracking + artistRepo := &extendedArtistRepo{ + MockArtistRepo: tests.CreateMockArtistRepo(), + } + ds.MockedArtist = artistRepo + + // Create extended media file repo with DeleteMissing support + mfRepo := &extendedMediaFileRepo{ + MockMediaFileRepo: tests.CreateMockMediaFileRepo(), + } + ds.MockedMediaFile = mfRepo + + return ds +} + +// Extension of MockMediaFileRepo to add DeleteMissing method +type extendedMediaFileRepo struct { + *tests.MockMediaFileRepo + deleteMissingCalled bool + deletedIDs []string + deleteMissingError error +} + +func (m *extendedMediaFileRepo) DeleteMissing(ids []string) error { + m.deleteMissingCalled = true + m.deletedIDs = ids + if m.deleteMissingError != nil { + return m.deleteMissingError + } + // Actually delete from the mock data + for _, id := range ids { + delete(m.Data, id) + } + return nil +} + +// Extension of MockAlbumRepo to track Put calls +type extendedAlbumRepo struct { + *tests.MockAlbumRepo + mu sync.RWMutex + putCallCount int + lastPutData *model.Album + putError error + failOnce bool +} + +func (m *extendedAlbumRepo) Put(album *model.Album) error { + m.mu.Lock() + m.putCallCount++ + m.lastPutData = album + + // Handle failOnce behavior + var err error + if m.putError != nil { + if m.failOnce { + err = m.putError + m.putError = nil // Clear error after first failure + m.mu.Unlock() + return err + } + err = m.putError + m.mu.Unlock() + return err + } + m.mu.Unlock() + + return m.MockAlbumRepo.Put(album) +} + +func (m *extendedAlbumRepo) GetPutCallCount() int { + m.mu.RLock() + defer m.mu.RUnlock() + return m.putCallCount +} + +// Extension of MockArtistRepo to track RefreshStats calls +type extendedArtistRepo struct { + *tests.MockArtistRepo + mu sync.RWMutex + refreshStatsCalled bool + refreshStatsError error +} + +func (m *extendedArtistRepo) RefreshStats(allArtists bool) (int64, error) { + m.mu.Lock() + m.refreshStatsCalled = true + err := m.refreshStatsError + m.mu.Unlock() + + if err != nil { + return 0, err + } + return m.MockArtistRepo.RefreshStats(allArtists) +} + +func (m *extendedArtistRepo) IsRefreshStatsCalled() bool { + m.mu.RLock() + defer m.mu.RUnlock() + return m.refreshStatsCalled +} diff --git a/core/media_streamer.go b/core/media_streamer.go deleted file mode 100644 index b3593c4eb..000000000 --- a/core/media_streamer.go +++ /dev/null @@ -1,214 +0,0 @@ -package core - -import ( - "context" - "fmt" - "io" - "mime" - "os" - "sync" - "time" - - "github.com/navidrome/navidrome/conf" - "github.com/navidrome/navidrome/consts" - "github.com/navidrome/navidrome/core/ffmpeg" - "github.com/navidrome/navidrome/log" - "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/model/request" - "github.com/navidrome/navidrome/utils/cache" -) - -type MediaStreamer interface { - NewStream(ctx context.Context, id string, reqFormat string, reqBitRate int, offset int) (*Stream, error) - DoStream(ctx context.Context, mf *model.MediaFile, reqFormat string, reqBitRate int, reqOffset int) (*Stream, error) -} - -type TranscodingCache cache.FileCache - -func NewMediaStreamer(ds model.DataStore, t ffmpeg.FFmpeg, cache TranscodingCache) MediaStreamer { - return &mediaStreamer{ds: ds, transcoder: t, cache: cache} -} - -type mediaStreamer struct { - ds model.DataStore - transcoder ffmpeg.FFmpeg - cache cache.FileCache -} - -type streamJob struct { - ms *mediaStreamer - mf *model.MediaFile - filePath string - format string - bitRate int - offset int -} - -func (j *streamJob) Key() string { - return fmt.Sprintf("%s.%s.%d.%s.%d", j.mf.ID, j.mf.UpdatedAt.Format(time.RFC3339Nano), j.bitRate, j.format, j.offset) -} - -func (ms *mediaStreamer) NewStream(ctx context.Context, id string, reqFormat string, reqBitRate int, reqOffset int) (*Stream, error) { - mf, err := ms.ds.MediaFile(ctx).Get(id) - if err != nil { - return nil, err - } - - return ms.DoStream(ctx, mf, reqFormat, reqBitRate, reqOffset) -} - -func (ms *mediaStreamer) DoStream(ctx context.Context, mf *model.MediaFile, reqFormat string, reqBitRate int, reqOffset int) (*Stream, error) { - var format string - var bitRate int - var cached bool - defer func() { - log.Info(ctx, "Streaming file", "title", mf.Title, "artist", mf.Artist, "format", format, "cached", cached, - "bitRate", bitRate, "user", userName(ctx), "transcoding", format != "raw", - "originalFormat", mf.Suffix, "originalBitRate", mf.BitRate) - }() - - format, bitRate = selectTranscodingOptions(ctx, ms.ds, mf, reqFormat, reqBitRate) - s := &Stream{ctx: ctx, mf: mf, format: format, bitRate: bitRate} - filePath := mf.AbsolutePath() - - if format == "raw" { - log.Debug(ctx, "Streaming RAW file", "id", mf.ID, "path", filePath, - "requestBitrate", reqBitRate, "requestFormat", reqFormat, "requestOffset", reqOffset, - "originalBitrate", mf.BitRate, "originalFormat", mf.Suffix, - "selectedBitrate", bitRate, "selectedFormat", format) - f, err := os.Open(filePath) - if err != nil { - return nil, err - } - s.ReadCloser = f - s.Seeker = f - s.format = mf.Suffix - return s, nil - } - - job := &streamJob{ - ms: ms, - mf: mf, - filePath: filePath, - format: format, - bitRate: bitRate, - offset: reqOffset, - } - r, err := ms.cache.Get(ctx, job) - if err != nil { - log.Error(ctx, "Error accessing transcoding cache", "id", mf.ID, err) - return nil, err - } - cached = r.Cached - - s.ReadCloser = r - s.Seeker = r.Seeker - - log.Debug(ctx, "Streaming TRANSCODED file", "id", mf.ID, "path", filePath, - "requestBitrate", reqBitRate, "requestFormat", reqFormat, "requestOffset", reqOffset, - "originalBitrate", mf.BitRate, "originalFormat", mf.Suffix, - "selectedBitrate", bitRate, "selectedFormat", format, "cached", cached, "seekable", s.Seekable()) - - return s, nil -} - -type Stream struct { - ctx context.Context - mf *model.MediaFile - bitRate int - format string - io.ReadCloser - io.Seeker -} - -func (s *Stream) Seekable() bool { return s.Seeker != nil } -func (s *Stream) Duration() float32 { return s.mf.Duration } -func (s *Stream) ContentType() string { return mime.TypeByExtension("." + s.format) } -func (s *Stream) Name() string { return s.mf.Title + "." + s.format } -func (s *Stream) ModTime() time.Time { return s.mf.UpdatedAt } -func (s *Stream) EstimatedContentLength() int { - return int(s.mf.Duration * float32(s.bitRate) / 8 * 1024) -} - -// TODO This function deserves some love (refactoring) -func selectTranscodingOptions(ctx context.Context, ds model.DataStore, mf *model.MediaFile, reqFormat string, reqBitRate int) (format string, bitRate int) { - format = "raw" - if reqFormat == "raw" { - return format, 0 - } - if reqFormat == mf.Suffix && reqBitRate == 0 { - bitRate = mf.BitRate - return format, bitRate - } - trc, hasDefault := request.TranscodingFrom(ctx) - var cFormat string - var cBitRate int - if reqFormat != "" { - cFormat = reqFormat - } else { - if hasDefault { - cFormat = trc.TargetFormat - cBitRate = trc.DefaultBitRate - if p, ok := request.PlayerFrom(ctx); ok { - cBitRate = p.MaxBitRate - } - } else if reqBitRate > 0 && reqBitRate < mf.BitRate && conf.Server.DefaultDownsamplingFormat != "" { - // If no format is specified and no transcoding associated to the player, but a bitrate is specified, - // and there is no transcoding set for the player, we use the default downsampling format. - // But only if the requested bitRate is lower than the original bitRate. - log.Debug("Default Downsampling", "Using default downsampling format", conf.Server.DefaultDownsamplingFormat) - cFormat = conf.Server.DefaultDownsamplingFormat - } - } - if reqBitRate > 0 { - cBitRate = reqBitRate - } - if cBitRate == 0 && cFormat == "" { - return format, bitRate - } - t, err := ds.Transcoding(ctx).FindByFormat(cFormat) - if err == nil { - format = t.TargetFormat - if cBitRate != 0 { - bitRate = cBitRate - } else { - bitRate = t.DefaultBitRate - } - } - if format == mf.Suffix && bitRate >= mf.BitRate { - format = "raw" - bitRate = 0 - } - return format, bitRate -} - -var ( - onceTranscodingCache sync.Once - instanceTranscodingCache TranscodingCache -) - -func GetTranscodingCache() TranscodingCache { - onceTranscodingCache.Do(func() { - instanceTranscodingCache = NewTranscodingCache() - }) - return instanceTranscodingCache -} - -func NewTranscodingCache() TranscodingCache { - return cache.NewFileCache("Transcoding", conf.Server.TranscodingCacheSize, - consts.TranscodingCacheDir, consts.DefaultTranscodingCacheMaxItems, - func(ctx context.Context, arg cache.Item) (io.Reader, error) { - job := arg.(*streamJob) - t, err := job.ms.ds.Transcoding(ctx).FindByFormat(job.format) - if err != nil { - log.Error(ctx, "Error loading transcoding command", "format", job.format, err) - return nil, os.ErrInvalid - } - out, err := job.ms.transcoder.Transcode(ctx, t.Command, job.filePath, job.bitRate, job.offset) - if err != nil { - log.Error(ctx, "Error starting transcoder", "id", job.mf.ID, err) - return nil, os.ErrInvalid - } - return out, nil - }) -} diff --git a/core/media_streamer_Internal_test.go b/core/media_streamer_Internal_test.go deleted file mode 100644 index 44fbf701c..000000000 --- a/core/media_streamer_Internal_test.go +++ /dev/null @@ -1,162 +0,0 @@ -package core - -import ( - "context" - - "github.com/navidrome/navidrome/conf" - "github.com/navidrome/navidrome/log" - "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/model/request" - "github.com/navidrome/navidrome/tests" - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" -) - -var _ = Describe("MediaStreamer", func() { - var ds model.DataStore - ctx := log.NewContext(context.Background()) - - BeforeEach(func() { - ds = &tests.MockDataStore{MockedTranscoding: &tests.MockTranscodingRepo{}} - }) - - Context("selectTranscodingOptions", func() { - mf := &model.MediaFile{} - Context("player is not configured", func() { - It("returns raw if raw is requested", func() { - mf.Suffix = "flac" - mf.BitRate = 1000 - format, _ := selectTranscodingOptions(ctx, ds, mf, "raw", 0) - Expect(format).To(Equal("raw")) - }) - It("returns raw if a transcoder does not exists", func() { - mf.Suffix = "flac" - mf.BitRate = 1000 - format, _ := selectTranscodingOptions(ctx, ds, mf, "m4a", 0) - Expect(format).To(Equal("raw")) - }) - It("returns the requested format if a transcoder exists", func() { - mf.Suffix = "flac" - mf.BitRate = 1000 - format, bitRate := selectTranscodingOptions(ctx, ds, mf, "mp3", 0) - Expect(format).To(Equal("mp3")) - Expect(bitRate).To(Equal(160)) // Default Bit Rate - }) - It("returns raw if requested format is the same as the original and it is not necessary to downsample", func() { - mf.Suffix = "mp3" - mf.BitRate = 112 - format, _ := selectTranscodingOptions(ctx, ds, mf, "mp3", 128) - Expect(format).To(Equal("raw")) - }) - It("returns the requested format if requested BitRate is lower than original", func() { - mf.Suffix = "mp3" - mf.BitRate = 320 - format, bitRate := selectTranscodingOptions(ctx, ds, mf, "mp3", 192) - Expect(format).To(Equal("mp3")) - Expect(bitRate).To(Equal(192)) - }) - It("returns raw if requested format is the same as the original, but requested BitRate is 0", func() { - mf.Suffix = "mp3" - mf.BitRate = 320 - format, bitRate := selectTranscodingOptions(ctx, ds, mf, "mp3", 0) - Expect(format).To(Equal("raw")) - Expect(bitRate).To(Equal(320)) - }) - Context("Downsampling", func() { - BeforeEach(func() { - conf.Server.DefaultDownsamplingFormat = "opus" - mf.Suffix = "FLAC" - mf.BitRate = 960 - }) - It("returns the DefaultDownsamplingFormat if a maxBitrate is requested but not the format", func() { - format, bitRate := selectTranscodingOptions(ctx, ds, mf, "", 128) - Expect(format).To(Equal("opus")) - Expect(bitRate).To(Equal(128)) - }) - It("returns raw if maxBitrate is equal or greater than original", func() { - // This happens with DSub (and maybe other clients?). See https://github.com/navidrome/navidrome/issues/2066 - format, bitRate := selectTranscodingOptions(ctx, ds, mf, "", 960) - Expect(format).To(Equal("raw")) - Expect(bitRate).To(Equal(0)) - }) - }) - }) - - Context("player has format configured", func() { - BeforeEach(func() { - t := model.Transcoding{ID: "oga1", TargetFormat: "oga", DefaultBitRate: 96} - ctx = request.WithTranscoding(ctx, t) - }) - It("returns raw if raw is requested", func() { - mf.Suffix = "flac" - mf.BitRate = 1000 - format, _ := selectTranscodingOptions(ctx, ds, mf, "raw", 0) - Expect(format).To(Equal("raw")) - }) - It("returns configured format/bitrate as default", func() { - mf.Suffix = "flac" - mf.BitRate = 1000 - format, bitRate := selectTranscodingOptions(ctx, ds, mf, "", 0) - Expect(format).To(Equal("oga")) - Expect(bitRate).To(Equal(96)) - }) - It("returns requested format", func() { - mf.Suffix = "flac" - mf.BitRate = 1000 - format, bitRate := selectTranscodingOptions(ctx, ds, mf, "mp3", 0) - Expect(format).To(Equal("mp3")) - Expect(bitRate).To(Equal(160)) // Default Bit Rate - }) - It("returns requested bitrate", func() { - mf.Suffix = "flac" - mf.BitRate = 1000 - format, bitRate := selectTranscodingOptions(ctx, ds, mf, "", 80) - Expect(format).To(Equal("oga")) - Expect(bitRate).To(Equal(80)) - }) - It("returns raw if selected bitrate and format is the same as original", func() { - mf.Suffix = "mp3" - mf.BitRate = 192 - format, bitRate := selectTranscodingOptions(ctx, ds, mf, "mp3", 192) - Expect(format).To(Equal("raw")) - Expect(bitRate).To(Equal(0)) - }) - }) - - Context("player has maxBitRate configured", func() { - BeforeEach(func() { - t := model.Transcoding{ID: "oga1", TargetFormat: "oga", DefaultBitRate: 96} - p := model.Player{ID: "player1", TranscodingId: t.ID, MaxBitRate: 192} - ctx = request.WithTranscoding(ctx, t) - ctx = request.WithPlayer(ctx, p) - }) - It("returns raw if raw is requested", func() { - mf.Suffix = "flac" - mf.BitRate = 1000 - format, _ := selectTranscodingOptions(ctx, ds, mf, "raw", 0) - Expect(format).To(Equal("raw")) - }) - It("returns configured format/bitrate as default", func() { - mf.Suffix = "flac" - mf.BitRate = 1000 - format, bitRate := selectTranscodingOptions(ctx, ds, mf, "", 0) - Expect(format).To(Equal("oga")) - Expect(bitRate).To(Equal(192)) - }) - It("returns requested format", func() { - mf.Suffix = "flac" - mf.BitRate = 1000 - format, bitRate := selectTranscodingOptions(ctx, ds, mf, "mp3", 0) - Expect(format).To(Equal("mp3")) - Expect(bitRate).To(Equal(160)) // Default Bit Rate - }) - It("returns requested bitrate", func() { - mf.Suffix = "flac" - mf.BitRate = 1000 - format, bitRate := selectTranscodingOptions(ctx, ds, mf, "", 160) - Expect(format).To(Equal("oga")) - Expect(bitRate).To(Equal(160)) - }) - }) - }) -}) diff --git a/core/metrics/insights.go b/core/metrics/insights.go index f4f8738e7..5f3f491ea 100644 --- a/core/metrics/insights.go +++ b/core/metrics/insights.go @@ -6,6 +6,7 @@ import ( "encoding/json" "math" "net/http" + "os" "path/filepath" "runtime" "runtime/debug" @@ -21,7 +22,9 @@ import ( "github.com/navidrome/navidrome/core/metrics/insights" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/plugins/schema" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/plugins" + "github.com/navidrome/navidrome/server/events" "github.com/navidrome/navidrome/utils/singleton" ) @@ -35,18 +38,12 @@ var ( ) type insightsCollector struct { - ds model.DataStore - pluginLoader PluginLoader - lastRun atomic.Int64 - lastStatus atomic.Bool + ds model.DataStore + lastRun atomic.Int64 + lastStatus atomic.Bool } -// PluginLoader defines an interface for loading plugins -type PluginLoader interface { - PluginList() map[string]schema.PluginManifest -} - -func GetInstance(ds model.DataStore, pluginLoader PluginLoader) Insights { +func GetInstance(ds model.DataStore) Insights { return singleton.GetInstance(func() *insightsCollector { id, err := ds.Property(context.TODO()).Get(consts.InsightsIDKey) if err != nil { @@ -58,14 +55,21 @@ func GetInstance(ds model.DataStore, pluginLoader PluginLoader) Insights { } } insightsID = id - return &insightsCollector{ds: ds, pluginLoader: pluginLoader} + return &insightsCollector{ds: ds} }) } func (c *insightsCollector) Run(ctx context.Context) { - ctx = auth.WithAdminUser(ctx, c.ds) for { - c.sendInsights(ctx) + // Refresh admin context on each iteration to handle cases where + // admin user wasn't available on previous runs + insightsCtx := auth.WithAdminUser(ctx, c.ds) + u, _ := request.UserFrom(insightsCtx) + if !u.IsAdmin { + log.Trace(insightsCtx, "No admin user available, skipping insights collection") + } else { + c.sendInsights(insightsCtx) + } select { case <-time.After(consts.InsightsUpdateInterval): continue @@ -104,7 +108,7 @@ func (c *insightsCollector) sendInsights(ctx context.Context) { return } req.Header.Set("Content-Type", "application/json") - resp, err := hc.Do(req) + resp, err := hc.Do(req) //nolint:gosec if err != nil { log.Trace(ctx, "Could not send Insights data", err) return @@ -160,6 +164,13 @@ var staticData = sync.OnceValue(func() insights.Data { data.Build.Settings, data.Build.GoVersion = buildInfo() data.OS.Containerized = consts.InContainer + // Install info + packageFilename := filepath.Join(conf.Server.DataFolder, ".package") + packageFileData, err := os.ReadFile(packageFilename) + if err == nil { + data.OS.Package = string(packageFileData) + } + // OS info data.OS.Type = runtime.GOOS data.OS.Arch = runtime.GOARCH @@ -188,7 +199,6 @@ var staticData = sync.OnceValue(func() insights.Data { data.Config.EnableSharing = conf.Server.EnableSharing data.Config.EnableStarRating = conf.Server.EnableStarRating data.Config.EnableLastFM = conf.Server.LastFM.Enabled && conf.Server.LastFM.ApiKey != "" && conf.Server.LastFM.Secret != "" - data.Config.EnableSpotify = conf.Server.Spotify.ID != "" && conf.Server.Spotify.Secret != "" data.Config.EnableListenBrainz = conf.Server.ListenBrainz.Enabled data.Config.EnableDeezer = conf.Server.Deezer.Enabled data.Config.EnableMediaFileCoverArt = conf.Server.EnableMediaFileCoverArt @@ -197,18 +207,20 @@ var staticData = sync.OnceValue(func() insights.Data { data.Config.TranscodingCacheSize = conf.Server.TranscodingCacheSize data.Config.ImageCacheSize = conf.Server.ImageCacheSize data.Config.SessionTimeout = uint64(math.Trunc(conf.Server.SessionTimeout.Seconds())) - data.Config.SearchFullString = conf.Server.SearchFullString + data.Config.SearchFullString = conf.Server.Search.FullString + data.Config.SearchBackend = conf.Server.Search.Backend data.Config.RecentlyAddedByModTime = conf.Server.RecentlyAddedByModTime data.Config.PreferSortTags = conf.Server.PreferSortTags data.Config.BackupSchedule = conf.Server.Backup.Schedule data.Config.BackupCount = conf.Server.Backup.Count data.Config.DevActivityPanel = conf.Server.DevActivityPanel data.Config.ScannerEnabled = conf.Server.Scanner.Enabled + data.Config.ScannerExtractor = conf.Server.Scanner.Extractor data.Config.ScanSchedule = conf.Server.Scanner.Schedule data.Config.ScanWatcherWait = uint64(math.Trunc(conf.Server.Scanner.WatcherWait.Seconds())) data.Config.ScanOnStartup = conf.Server.Scanner.ScanOnStartup - data.Config.ReverseProxyConfigured = conf.Server.ReverseProxyWhitelist != "" - data.Config.HasCustomPID = conf.Server.PID.Track != "" || conf.Server.PID.Album != "" + data.Config.ReverseProxyConfigured = conf.Server.ExtAuth.TrustedSources != "" + data.Config.HasCustomPID = conf.Server.PID.Track != consts.DefaultTrackPID || conf.Server.PID.Album != consts.DefaultAlbumPID data.Config.HasCustomTags = len(conf.Server.Tags) > 0 return data @@ -254,6 +266,10 @@ func (c *insightsCollector) collect(ctx context.Context) []byte { if err != nil { log.Trace(ctx, "Error reading active users count", err) } + data.Library.FileSuffixes, err = c.ds.MediaFile(ctx).CountBySuffix() + if err != nil { + log.Trace(ctx, "Error reading file suffixes count", err) + } // Check for smart playlists data.Config.HasSmartPlaylists, err = c.hasSmartPlaylists(ctx) @@ -303,12 +319,16 @@ func (c *insightsCollector) hasSmartPlaylists(ctx context.Context) (bool, error) // collectPlugins collects information about installed plugins func (c *insightsCollector) collectPlugins(_ context.Context) map[string]insights.PluginInfo { - plugins := make(map[string]insights.PluginInfo) - for id, manifest := range c.pluginLoader.PluginList() { - plugins[id] = insights.PluginInfo{ - Name: manifest.Name, - Version: manifest.Version, + // TODO Fix import/inject cycles + manager := plugins.GetManager(c.ds, events.GetBroker(), nil) + info := manager.GetPluginInfo() + + result := make(map[string]insights.PluginInfo, len(info)) + for name, p := range info { + result[name] = insights.PluginInfo{ + Name: p.Name, + Version: p.Version, } } - return plugins + return result } diff --git a/core/metrics/insights/data.go b/core/metrics/insights/data.go index 105a6218e..27186e020 100644 --- a/core/metrics/insights/data.go +++ b/core/metrics/insights/data.go @@ -16,6 +16,7 @@ type Data struct { Containerized bool `json:"containerized"` Arch string `json:"arch"` NumCPU int `json:"numCPU"` + Package string `json:"package,omitempty"` } `json:"os"` Mem struct { Alloc uint64 `json:"alloc"` @@ -39,12 +40,14 @@ type Data struct { Libraries int64 `json:"libraries"` ActiveUsers int64 `json:"activeUsers"` ActivePlayers map[string]int64 `json:"activePlayers,omitempty"` + FileSuffixes map[string]int64 `json:"fileSuffixes,omitempty"` } `json:"library"` Config struct { LogLevel string `json:"logLevel,omitempty"` LogFileConfigured bool `json:"logFileConfigured,omitempty"` TLSConfigured bool `json:"tlsConfigured,omitempty"` ScannerEnabled bool `json:"scannerEnabled,omitempty"` + ScannerExtractor string `json:"scannerExtractor,omitempty"` ScanSchedule string `json:"scanSchedule,omitempty"` ScanWatcherWait uint64 `json:"scanWatcherWait,omitempty"` ScanOnStartup bool `json:"scanOnStartup,omitempty"` @@ -58,13 +61,13 @@ type Data struct { EnableListenBrainz bool `json:"enableListenBrainz,omitempty"` EnableDeezer bool `json:"enableDeezer,omitempty"` EnableMediaFileCoverArt bool `json:"enableMediaFileCoverArt,omitempty"` - EnableSpotify bool `json:"enableSpotify,omitempty"` EnableJukebox bool `json:"enableJukebox,omitempty"` EnablePrometheus bool `json:"enablePrometheus,omitempty"` EnableCoverAnimation bool `json:"enableCoverAnimation,omitempty"` EnableNowPlaying bool `json:"enableNowPlaying,omitempty"` SessionTimeout uint64 `json:"sessionTimeout,omitempty"` SearchFullString bool `json:"searchFullString,omitempty"` + SearchBackend string `json:"searchBackend,omitempty"` RecentlyAddedByModTime bool `json:"recentlyAddedByModTime,omitempty"` PreferSortTags bool `json:"preferSortTags,omitempty"` BackupSchedule string `json:"backupSchedule,omitempty"` diff --git a/core/metrics/insights_linux.go b/core/metrics/insights_linux.go index dbf3c277c..f37c945c1 100644 --- a/core/metrics/insights_linux.go +++ b/core/metrics/insights_linux.go @@ -42,6 +42,7 @@ type MountInfo struct { var fsTypeMap = map[int64]string{ 0x5346414f: "afs", + 0x187: "autofs", 0x61756673: "aufs", 0x9123683E: "btrfs", 0xc36400: "ceph", @@ -55,9 +56,11 @@ var fsTypeMap = map[int64]string{ 0x6a656a63: "fakeowner", // FS inside a container 0x65735546: "fuse", 0x4244: "hfs", + 0x482b: "hfs+", 0x9660: "iso9660", 0x3153464a: "jfs", 0x00006969: "nfs", + 0x5346544e: "ntfs", // NTFS_SB_MAGIC 0x7366746e: "ntfs", 0x794c7630: "overlayfs", 0x9fa0: "proc", @@ -69,8 +72,16 @@ var fsTypeMap = map[int64]string{ 0x01021997: "v9fs", 0x786f4256: "vboxsf", 0x4d44: "vfat", + 0xca451a4e: "virtiofs", 0x58465342: "xfs", 0x2FC12FC1: "zfs", + 0x7c7c6673: "prlfs", // Parallels Shared Folders + + // Signed/unsigned conversion issues (negative hex values converted to uint32) + -0x6edc97c2: "btrfs", // 0x9123683e + -0x1acb2be: "smb2", // 0xfe534d42 + -0xacb2be: "cifs", // 0xff534d42 + -0xd0adff0: "f2fs", // 0xf2f52010 } func getFilesystemType(path string) (string, error) { diff --git a/core/playback/mpv/mpv.go b/core/playback/mpv/mpv.go index f356a1410..035e18dd5 100644 --- a/core/playback/mpv/mpv.go +++ b/core/playback/mpv/mpv.go @@ -10,9 +10,9 @@ import ( "strings" "sync" - "github.com/kballard/go-shellquote" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/utils/shellquote" ) func start(ctx context.Context, args []string) (Executor, error) { diff --git a/core/playback/mpv/mpv_test.go b/core/playback/mpv/mpv_test.go index 20c02501b..b1f2435a3 100644 --- a/core/playback/mpv/mpv_test.go +++ b/core/playback/mpv/mpv_test.go @@ -188,7 +188,7 @@ var _ = Describe("MPV", func() { It("returns empty slice for empty template", func() { args := createMPVCommand("auto", "/music/test.mp3", "/tmp/socket") - Expect(args).To(Equal([]string{})) + Expect(args).To(BeEmpty()) }) }) }) diff --git a/core/playback/queue.go b/core/playback/queue.go index 0c230a61f..d15eaad96 100644 --- a/core/playback/queue.go +++ b/core/playback/queue.go @@ -3,6 +3,7 @@ package playback import ( "fmt" "math/rand" + "strings" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" @@ -21,11 +22,11 @@ func NewQueue() *Queue { } func (pd *Queue) String() string { - filenames := "" + var filenames strings.Builder for idx, item := range pd.Items { - filenames += fmt.Sprint(idx) + ":" + item.Path + " " + filenames.WriteString(fmt.Sprint(idx) + ":" + item.Path + " ") } - return fmt.Sprintf("#Items: %d, idx: %d, files: %s", len(pd.Items), pd.Index, filenames) + return fmt.Sprintf("#Items: %d, idx: %d, files: %s", len(pd.Items), pd.Index, filenames.String()) } // returns the current mediafile or nil diff --git a/core/playlists.go b/core/playlists.go deleted file mode 100644 index 2eebc94e7..000000000 --- a/core/playlists.go +++ /dev/null @@ -1,390 +0,0 @@ -package core - -import ( - "context" - "encoding/json" - "errors" - "fmt" - "io" - "net/url" - "os" - "path/filepath" - "regexp" - "strings" - "time" - - "github.com/RaveNoX/go-jsoncommentstrip" - "github.com/bmatcuk/doublestar/v4" - "github.com/navidrome/navidrome/conf" - "github.com/navidrome/navidrome/log" - "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/model/criteria" - "github.com/navidrome/navidrome/model/request" - "github.com/navidrome/navidrome/utils/slice" - "golang.org/x/text/unicode/norm" -) - -type Playlists interface { - ImportFile(ctx context.Context, folder *model.Folder, filename string) (*model.Playlist, error) - Update(ctx context.Context, playlistID string, name *string, comment *string, public *bool, idsToAdd []string, idxToRemove []int) error - ImportM3U(ctx context.Context, reader io.Reader) (*model.Playlist, error) -} - -type playlists struct { - ds model.DataStore -} - -func NewPlaylists(ds model.DataStore) Playlists { - return &playlists{ds: ds} -} - -func InPlaylistsPath(folder model.Folder) bool { - if conf.Server.PlaylistsPath == "" { - return true - } - rel, _ := filepath.Rel(folder.LibraryPath, folder.AbsolutePath()) - for _, path := range strings.Split(conf.Server.PlaylistsPath, string(filepath.ListSeparator)) { - if match, _ := doublestar.Match(path, rel); match { - return true - } - } - return false -} - -func (s *playlists) ImportFile(ctx context.Context, folder *model.Folder, filename string) (*model.Playlist, error) { - pls, err := s.parsePlaylist(ctx, filename, folder) - if err != nil { - log.Error(ctx, "Error parsing playlist", "path", filepath.Join(folder.AbsolutePath(), filename), err) - return nil, err - } - log.Debug("Found playlist", "name", pls.Name, "lastUpdated", pls.UpdatedAt, "path", pls.Path, "numTracks", len(pls.Tracks)) - err = s.updatePlaylist(ctx, pls) - if err != nil { - log.Error(ctx, "Error updating playlist", "path", filepath.Join(folder.AbsolutePath(), filename), err) - } - return pls, err -} - -func (s *playlists) ImportM3U(ctx context.Context, reader io.Reader) (*model.Playlist, error) { - owner, _ := request.UserFrom(ctx) - pls := &model.Playlist{ - OwnerID: owner.ID, - Public: false, - Sync: false, - } - err := s.parseM3U(ctx, pls, nil, reader) - if err != nil { - log.Error(ctx, "Error parsing playlist", err) - return nil, err - } - err = s.ds.Playlist(ctx).Put(pls) - if err != nil { - log.Error(ctx, "Error saving playlist", err) - return nil, err - } - return pls, nil -} - -func (s *playlists) parsePlaylist(ctx context.Context, playlistFile string, folder *model.Folder) (*model.Playlist, error) { - pls, err := s.newSyncedPlaylist(folder.AbsolutePath(), playlistFile) - if err != nil { - return nil, err - } - - file, err := os.Open(pls.Path) - if err != nil { - return nil, err - } - defer file.Close() - - extension := strings.ToLower(filepath.Ext(playlistFile)) - switch extension { - case ".nsp": - err = s.parseNSP(ctx, pls, file) - default: - err = s.parseM3U(ctx, pls, folder, file) - } - return pls, err -} - -func (s *playlists) newSyncedPlaylist(baseDir string, playlistFile string) (*model.Playlist, error) { - playlistPath := filepath.Join(baseDir, playlistFile) - info, err := os.Stat(playlistPath) - if err != nil { - return nil, err - } - - var extension = filepath.Ext(playlistFile) - var name = playlistFile[0 : len(playlistFile)-len(extension)] - - pls := &model.Playlist{ - Name: name, - Comment: fmt.Sprintf("Auto-imported from '%s'", playlistFile), - Public: false, - Path: playlistPath, - Sync: true, - UpdatedAt: info.ModTime(), - } - return pls, nil -} - -func getPositionFromOffset(data []byte, offset int64) (line, column int) { - line = 1 - for _, b := range data[:offset] { - if b == '\n' { - line++ - column = 1 - } else { - column++ - } - } - return -} - -func (s *playlists) parseNSP(_ context.Context, pls *model.Playlist, reader io.Reader) error { - nsp := &nspFile{} - reader = io.LimitReader(reader, 100*1024) // Limit to 100KB - reader = jsoncommentstrip.NewReader(reader) - input, err := io.ReadAll(reader) - if err != nil { - return fmt.Errorf("reading SmartPlaylist: %w", err) - } - err = json.Unmarshal(input, nsp) - if err != nil { - var syntaxErr *json.SyntaxError - if errors.As(err, &syntaxErr) { - line, col := getPositionFromOffset(input, syntaxErr.Offset) - return fmt.Errorf("JSON syntax error in SmartPlaylist at line %d, column %d: %w", line, col, err) - } - return fmt.Errorf("JSON parsing error in SmartPlaylist: %w", err) - } - pls.Rules = &nsp.Criteria - if nsp.Name != "" { - pls.Name = nsp.Name - } - if nsp.Comment != "" { - pls.Comment = nsp.Comment - } - return nil -} - -func (s *playlists) parseM3U(ctx context.Context, pls *model.Playlist, folder *model.Folder, reader io.Reader) error { - mediaFileRepository := s.ds.MediaFile(ctx) - var mfs model.MediaFiles - for lines := range slice.CollectChunks(slice.LinesFrom(reader), 400) { - filteredLines := make([]string, 0, len(lines)) - for _, line := range lines { - line := strings.TrimSpace(line) - if strings.HasPrefix(line, "#PLAYLIST:") { - pls.Name = line[len("#PLAYLIST:"):] - continue - } - // Skip empty lines and extended info - if line == "" || strings.HasPrefix(line, "#") { - continue - } - if strings.HasPrefix(line, "file://") { - line = strings.TrimPrefix(line, "file://") - line, _ = url.QueryUnescape(line) - } - if !model.IsAudioFile(line) { - continue - } - filteredLines = append(filteredLines, line) - } - paths, err := s.normalizePaths(ctx, pls, folder, filteredLines) - if err != nil { - log.Warn(ctx, "Error normalizing paths in playlist", "playlist", pls.Name, err) - continue - } - found, err := mediaFileRepository.FindByPaths(paths) - if err != nil { - log.Warn(ctx, "Error reading files from DB", "playlist", pls.Name, err) - continue - } - existing := make(map[string]int, len(found)) - for idx := range found { - existing[normalizePathForComparison(found[idx].Path)] = idx - } - for _, path := range paths { - idx, ok := existing[normalizePathForComparison(path)] - if ok { - mfs = append(mfs, found[idx]) - } else { - log.Warn(ctx, "Path in playlist not found", "playlist", pls.Name, "path", path) - } - } - } - if pls.Name == "" { - pls.Name = time.Now().Format(time.RFC3339) - } - pls.Tracks = nil - pls.AddMediaFiles(mfs) - - return nil -} - -// normalizePathForComparison normalizes a file path to NFC form and converts to lowercase -// for consistent comparison. This fixes Unicode normalization issues on macOS where -// Apple Music creates playlists with NFC-encoded paths but the filesystem uses NFD. -func normalizePathForComparison(path string) string { - return strings.ToLower(norm.NFC.String(path)) -} - -// TODO This won't work for multiple libraries -func (s *playlists) normalizePaths(ctx context.Context, pls *model.Playlist, folder *model.Folder, lines []string) ([]string, error) { - libRegex, err := s.compileLibraryPaths(ctx) - if err != nil { - return nil, err - } - - res := make([]string, 0, len(lines)) - for idx, line := range lines { - var libPath string - var filePath string - - if folder != nil && !filepath.IsAbs(line) { - libPath = folder.LibraryPath - filePath = filepath.Join(folder.AbsolutePath(), line) - } else { - cleanLine := filepath.Clean(line) - if libPath = libRegex.FindString(cleanLine); libPath != "" { - filePath = cleanLine - } - } - - if libPath != "" { - if rel, err := filepath.Rel(libPath, filePath); err == nil { - res = append(res, rel) - } else { - log.Debug(ctx, "Error getting relative path", "playlist", pls.Name, "path", line, "libPath", libPath, - "filePath", filePath, err) - } - } else { - log.Warn(ctx, "Path in playlist not found in any library", "path", line, "line", idx) - } - } - return slice.Map(res, filepath.ToSlash), nil -} - -func (s *playlists) compileLibraryPaths(ctx context.Context) (*regexp.Regexp, error) { - libs, err := s.ds.Library(ctx).GetAll() - if err != nil { - return nil, err - } - - // Create regex patterns for each library path - patterns := make([]string, len(libs)) - for i, lib := range libs { - cleanPath := filepath.Clean(lib.Path) - escapedPath := regexp.QuoteMeta(cleanPath) - patterns[i] = fmt.Sprintf("^%s(?:/|$)", escapedPath) - } - // Combine all patterns into a single regex - combinedPattern := strings.Join(patterns, "|") - re, err := regexp.Compile(combinedPattern) - if err != nil { - return nil, fmt.Errorf("compiling library paths `%s`: %w", combinedPattern, err) - } - return re, nil -} - -func (s *playlists) updatePlaylist(ctx context.Context, newPls *model.Playlist) error { - owner, _ := request.UserFrom(ctx) - - pls, err := s.ds.Playlist(ctx).FindByPath(newPls.Path) - if err != nil && !errors.Is(err, model.ErrNotFound) { - return err - } - if err == nil && !pls.Sync { - log.Debug(ctx, "Playlist already imported and not synced", "playlist", pls.Name, "path", pls.Path) - return nil - } - - if err == nil { - log.Info(ctx, "Updating synced playlist", "playlist", pls.Name, "path", newPls.Path) - newPls.ID = pls.ID - newPls.Name = pls.Name - newPls.Comment = pls.Comment - newPls.OwnerID = pls.OwnerID - newPls.Public = pls.Public - newPls.EvaluatedAt = &time.Time{} - } else { - log.Info(ctx, "Adding synced playlist", "playlist", newPls.Name, "path", newPls.Path, "owner", owner.UserName) - newPls.OwnerID = owner.ID - newPls.Public = conf.Server.DefaultPlaylistPublicVisibility - } - return s.ds.Playlist(ctx).Put(newPls) -} - -func (s *playlists) Update(ctx context.Context, playlistID string, - name *string, comment *string, public *bool, - idsToAdd []string, idxToRemove []int) error { - needsInfoUpdate := name != nil || comment != nil || public != nil - needsTrackRefresh := len(idxToRemove) > 0 - - return s.ds.WithTxImmediate(func(tx model.DataStore) error { - var pls *model.Playlist - var err error - repo := tx.Playlist(ctx) - tracks := repo.Tracks(playlistID, true) - if tracks == nil { - return fmt.Errorf("%w: playlist '%s'", model.ErrNotFound, playlistID) - } - if needsTrackRefresh { - pls, err = repo.GetWithTracks(playlistID, true, false) - pls.RemoveTracks(idxToRemove) - pls.AddMediaFilesByID(idsToAdd) - } else { - if len(idsToAdd) > 0 { - _, err = tracks.Add(idsToAdd) - if err != nil { - return err - } - } - if needsInfoUpdate { - pls, err = repo.Get(playlistID) - } - } - if err != nil { - return err - } - if !needsTrackRefresh && !needsInfoUpdate { - return nil - } - - if name != nil { - pls.Name = *name - } - if comment != nil { - pls.Comment = *comment - } - if public != nil { - pls.Public = *public - } - // Special case: The playlist is now empty - if len(idxToRemove) > 0 && len(pls.Tracks) == 0 { - if err = tracks.DeleteAll(); err != nil { - return err - } - } - return repo.Put(pls) - }) -} - -type nspFile struct { - criteria.Criteria - Name string `json:"name"` - Comment string `json:"comment"` -} - -func (i *nspFile) UnmarshalJSON(data []byte) error { - m := map[string]interface{}{} - err := json.Unmarshal(data, &m) - if err != nil { - return err - } - i.Name, _ = m["name"].(string) - i.Comment, _ = m["comment"].(string) - return json.Unmarshal(data, &i.Criteria) -} diff --git a/core/playlists/import.go b/core/playlists/import.go new file mode 100644 index 000000000..4462554c7 --- /dev/null +++ b/core/playlists/import.go @@ -0,0 +1,120 @@ +package playlists + +import ( + "context" + "errors" + "io" + "os" + "path/filepath" + "strings" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/utils/ioutils" + "golang.org/x/text/unicode/norm" +) + +func (s *playlists) ImportFile(ctx context.Context, folder *model.Folder, filename string) (*model.Playlist, error) { + pls, err := s.parsePlaylist(ctx, filename, folder) + if err != nil { + log.Error(ctx, "Error parsing playlist", "path", filepath.Join(folder.AbsolutePath(), filename), err) + return nil, err + } + log.Debug(ctx, "Found playlist", "name", pls.Name, "lastUpdated", pls.UpdatedAt, "path", pls.Path, "numTracks", len(pls.Tracks)) + err = s.updatePlaylist(ctx, pls) + if err != nil { + log.Error(ctx, "Error updating playlist", "path", filepath.Join(folder.AbsolutePath(), filename), err) + } + return pls, err +} + +func (s *playlists) ImportM3U(ctx context.Context, reader io.Reader) (*model.Playlist, error) { + owner, _ := request.UserFrom(ctx) + pls := &model.Playlist{ + OwnerID: owner.ID, + Public: false, + Sync: false, + } + err := s.parseM3U(ctx, pls, nil, reader) + if err != nil { + log.Error(ctx, "Error parsing playlist", err) + return nil, err + } + err = s.ds.Playlist(ctx).Put(pls) + if err != nil { + log.Error(ctx, "Error saving playlist", err) + return nil, err + } + return pls, nil +} + +func (s *playlists) parsePlaylist(ctx context.Context, playlistFile string, folder *model.Folder) (*model.Playlist, error) { + pls, err := s.newSyncedPlaylist(folder.AbsolutePath(), playlistFile) + if err != nil { + return nil, err + } + + file, err := os.Open(pls.Path) + if err != nil { + return nil, err + } + defer file.Close() + + reader := ioutils.UTF8Reader(file) + extension := strings.ToLower(filepath.Ext(playlistFile)) + switch extension { + case ".nsp": + err = s.parseNSP(ctx, pls, reader) + default: + err = s.parseM3U(ctx, pls, folder, reader) + } + return pls, err +} + +func (s *playlists) updatePlaylist(ctx context.Context, newPls *model.Playlist) error { + owner, _ := request.UserFrom(ctx) + + // Try to find existing playlist by path. Since filesystem normalization differs across + // platforms (macOS uses NFD, Linux/Windows use NFC), we try both forms to match + // playlists that may have been imported on a different platform. + pls, err := s.ds.Playlist(ctx).FindByPath(newPls.Path) + if errors.Is(err, model.ErrNotFound) { + // Try alternate normalization form + altPath := norm.NFD.String(newPls.Path) + if altPath == newPls.Path { + altPath = norm.NFC.String(newPls.Path) + } + if altPath != newPls.Path { + pls, err = s.ds.Playlist(ctx).FindByPath(altPath) + } + } + if err != nil && !errors.Is(err, model.ErrNotFound) { + return err + } + if err == nil && !pls.Sync { + log.Debug(ctx, "Playlist already imported and not synced", "playlist", pls.Name, "path", pls.Path) + return nil + } + + if err == nil { + log.Info(ctx, "Updating synced playlist", "playlist", pls.Name, "path", newPls.Path) + newPls.ID = pls.ID + newPls.Name = pls.Name + newPls.Comment = pls.Comment + newPls.OwnerID = pls.OwnerID + newPls.Public = pls.Public + newPls.UploadedImage = pls.UploadedImage // Preserve manual upload + newPls.EvaluatedAt = &time.Time{} + } else { + log.Info(ctx, "Adding synced playlist", "playlist", newPls.Name, "path", newPls.Path, "owner", owner.UserName) + newPls.OwnerID = owner.ID + // For NSP files, Public may already be set from the file; for M3U, use server default + if !newPls.IsSmartPlaylist() { + newPls.Public = conf.Server.DefaultPlaylistPublicVisibility + } + } + return s.ds.Playlist(ctx).Put(newPls) +} diff --git a/core/playlists/import_test.go b/core/playlists/import_test.go new file mode 100644 index 000000000..a6320bc7e --- /dev/null +++ b/core/playlists/import_test.go @@ -0,0 +1,923 @@ +package playlists_test + +import ( + "context" + "fmt" + "os" + "path/filepath" + "strconv" + "strings" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/core" + "github.com/navidrome/navidrome/core/playlists" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/criteria" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + "golang.org/x/text/unicode/norm" +) + +var _ = Describe("Playlists - Import", func() { + var ds *tests.MockDataStore + var ps playlists.Playlists + var mockPlsRepo *tests.MockPlaylistRepo + var mockLibRepo *tests.MockLibraryRepo + ctx := context.Background() + + BeforeEach(func() { + mockPlsRepo = tests.CreateMockPlaylistRepo() + mockLibRepo = &tests.MockLibraryRepo{} + ds = &tests.MockDataStore{ + MockedPlaylist: mockPlsRepo, + MockedLibrary: mockLibRepo, + } + ctx = request.WithUser(ctx, model.User{ID: "123"}) + }) + + Describe("ImportFile", func() { + var folder *model.Folder + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + ds.MockedMediaFile = &mockedMediaFileRepo{} + libPath, _ := os.Getwd() + // Set up library with the actual library path that matches the folder + mockLibRepo.SetData([]model.Library{{ID: 1, Path: libPath}}) + folder = &model.Folder{ + ID: "1", + LibraryID: 1, + LibraryPath: libPath, + Path: "tests/fixtures", + Name: "playlists", + } + }) + + Describe("M3U", func() { + It("parses well-formed playlists", func() { + pls, err := ps.ImportFile(ctx, folder, "pls1.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.OwnerID).To(Equal("123")) + Expect(pls.Tracks).To(HaveLen(2)) + Expect(pls.Tracks[0].Path).To(Equal("tests/fixtures/playlists/test.mp3")) + Expect(pls.Tracks[1].Path).To(Equal("tests/fixtures/playlists/test.ogg")) + Expect(mockPlsRepo.Last).To(Equal(pls)) + }) + + It("parses playlists using LF ending", func() { + pls, err := ps.ImportFile(ctx, folder, "lf-ended.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Tracks).To(HaveLen(2)) + }) + + It("parses playlists using CR ending (old Mac format)", func() { + pls, err := ps.ImportFile(ctx, folder, "cr-ended.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Tracks).To(HaveLen(2)) + }) + + It("parses playlists with UTF-8 BOM marker", func() { + pls, err := ps.ImportFile(ctx, folder, "bom-test.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.OwnerID).To(Equal("123")) + Expect(pls.Name).To(Equal("Test Playlist")) + Expect(pls.Tracks).To(HaveLen(1)) + Expect(pls.Tracks[0].Path).To(Equal("tests/fixtures/playlists/test.mp3")) + }) + + It("parses UTF-16 LE encoded playlists with BOM and converts to UTF-8", func() { + pls, err := ps.ImportFile(ctx, folder, "bom-test-utf16.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.OwnerID).To(Equal("123")) + Expect(pls.Name).To(Equal("UTF-16 Test Playlist")) + Expect(pls.Tracks).To(HaveLen(1)) + Expect(pls.Tracks[0].Path).To(Equal("tests/fixtures/playlists/test.mp3")) + }) + + It("parses #EXTALBUMARTURL with HTTP URL", func() { + conf.Server.EnableM3UExternalAlbumArt = true + + pls, err := ps.ImportFile(ctx, folder, "pls-with-art-url.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.ExternalImageURL).To(Equal("https://example.com/cover.jpg")) + Expect(pls.Tracks).To(HaveLen(2)) + }) + + It("parses #EXTALBUMARTURL with absolute local path", func() { + tmpDir := GinkgoT().TempDir() + imgPath := filepath.Join(tmpDir, "cover.jpg") + Expect(os.WriteFile(imgPath, []byte("fake image"), 0600)).To(Succeed()) + + m3u := fmt.Sprintf("#EXTALBUMARTURL:%s\ntest.mp3\ntest.ogg\n", imgPath) + plsFile := filepath.Join(tmpDir, "test.m3u") + Expect(os.WriteFile(plsFile, []byte(m3u), 0600)).To(Succeed()) + + mockLibRepo.SetData([]model.Library{{ID: 1, Path: tmpDir}}) + ds.MockedMediaFile = &mockedMediaFileFromListRepo{data: []string{"test.mp3", "test.ogg"}} + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + + plsFolder := &model.Folder{ID: "1", LibraryID: 1, LibraryPath: tmpDir, Path: "", Name: ""} + pls, err := ps.ImportFile(ctx, plsFolder, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.ExternalImageURL).To(Equal(imgPath)) + }) + + It("parses #EXTALBUMARTURL with relative local path", func() { + tmpDir := GinkgoT().TempDir() + Expect(os.WriteFile(filepath.Join(tmpDir, "cover.jpg"), []byte("fake image"), 0600)).To(Succeed()) + + m3u := "#EXTALBUMARTURL:cover.jpg\ntest.mp3\n" + plsFile := filepath.Join(tmpDir, "test.m3u") + Expect(os.WriteFile(plsFile, []byte(m3u), 0600)).To(Succeed()) + + mockLibRepo.SetData([]model.Library{{ID: 1, Path: tmpDir}}) + ds.MockedMediaFile = &mockedMediaFileFromListRepo{data: []string{"test.mp3"}} + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + + plsFolder := &model.Folder{ID: "1", LibraryID: 1, LibraryPath: tmpDir, Path: "", Name: ""} + pls, err := ps.ImportFile(ctx, plsFolder, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.ExternalImageURL).To(Equal(filepath.Join(tmpDir, "cover.jpg"))) + }) + + It("parses #EXTALBUMARTURL with file:// URL", func() { + tmpDir := GinkgoT().TempDir() + imgPath := filepath.Join(tmpDir, "my cover.jpg") + Expect(os.WriteFile(imgPath, []byte("fake image"), 0600)).To(Succeed()) + + m3u := fmt.Sprintf("#EXTALBUMARTURL:file://%s\ntest.mp3\n", strings.ReplaceAll(imgPath, " ", "%20")) + plsFile := filepath.Join(tmpDir, "test.m3u") + Expect(os.WriteFile(plsFile, []byte(m3u), 0600)).To(Succeed()) + + mockLibRepo.SetData([]model.Library{{ID: 1, Path: tmpDir}}) + ds.MockedMediaFile = &mockedMediaFileFromListRepo{data: []string{"test.mp3"}} + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + + plsFolder := &model.Folder{ID: "1", LibraryID: 1, LibraryPath: tmpDir, Path: "", Name: ""} + pls, err := ps.ImportFile(ctx, plsFolder, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.ExternalImageURL).To(Equal(imgPath)) + }) + + It("preserves + in file:// URLs (PathUnescape, not QueryUnescape)", func() { + tmpDir := GinkgoT().TempDir() + imgPath := filepath.Join(tmpDir, "A+B.jpg") + Expect(os.WriteFile(imgPath, []byte("fake image"), 0600)).To(Succeed()) + + m3u := fmt.Sprintf("#EXTALBUMARTURL:file://%s\ntest.mp3\n", imgPath) + plsFile := filepath.Join(tmpDir, "test.m3u") + Expect(os.WriteFile(plsFile, []byte(m3u), 0600)).To(Succeed()) + + mockLibRepo.SetData([]model.Library{{ID: 1, Path: tmpDir}}) + ds.MockedMediaFile = &mockedMediaFileFromListRepo{data: []string{"test.mp3"}} + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + + plsFolder := &model.Folder{ID: "1", LibraryID: 1, LibraryPath: tmpDir, Path: "", Name: ""} + pls, err := ps.ImportFile(ctx, plsFolder, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.ExternalImageURL).To(Equal(imgPath)) + }) + + It("rejects #EXTALBUMARTURL with absolute path outside library boundaries", func() { + tmpDir := GinkgoT().TempDir() + + m3u := "#EXTALBUMARTURL:/etc/passwd\ntest.mp3\n" + plsFile := filepath.Join(tmpDir, "test.m3u") + Expect(os.WriteFile(plsFile, []byte(m3u), 0600)).To(Succeed()) + + mockLibRepo.SetData([]model.Library{{ID: 1, Path: tmpDir}}) + ds.MockedMediaFile = &mockedMediaFileFromListRepo{data: []string{"test.mp3"}} + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + + plsFolder := &model.Folder{ID: "1", LibraryID: 1, LibraryPath: tmpDir, Path: "", Name: ""} + pls, err := ps.ImportFile(ctx, plsFolder, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.ExternalImageURL).To(BeEmpty()) + }) + + It("rejects #EXTALBUMARTURL with file:// URL outside library boundaries", func() { + tmpDir := GinkgoT().TempDir() + + m3u := "#EXTALBUMARTURL:file:///etc/passwd\ntest.mp3\n" + plsFile := filepath.Join(tmpDir, "test.m3u") + Expect(os.WriteFile(plsFile, []byte(m3u), 0600)).To(Succeed()) + + mockLibRepo.SetData([]model.Library{{ID: 1, Path: tmpDir}}) + ds.MockedMediaFile = &mockedMediaFileFromListRepo{data: []string{"test.mp3"}} + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + + plsFolder := &model.Folder{ID: "1", LibraryID: 1, LibraryPath: tmpDir, Path: "", Name: ""} + pls, err := ps.ImportFile(ctx, plsFolder, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.ExternalImageURL).To(BeEmpty()) + }) + + It("rejects #EXTALBUMARTURL with relative path escaping library", func() { + tmpDir := GinkgoT().TempDir() + + m3u := "#EXTALBUMARTURL:../../etc/passwd\ntest.mp3\n" + plsFile := filepath.Join(tmpDir, "test.m3u") + Expect(os.WriteFile(plsFile, []byte(m3u), 0600)).To(Succeed()) + + mockLibRepo.SetData([]model.Library{{ID: 1, Path: tmpDir}}) + ds.MockedMediaFile = &mockedMediaFileFromListRepo{data: []string{"test.mp3"}} + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + + plsFolder := &model.Folder{ID: "1", LibraryID: 1, LibraryPath: tmpDir, Path: "", Name: ""} + pls, err := ps.ImportFile(ctx, plsFolder, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.ExternalImageURL).To(BeEmpty()) + }) + + It("ignores HTTP #EXTALBUMARTURL when EnableM3UExternalAlbumArt is false", func() { + conf.Server.EnableM3UExternalAlbumArt = false + + tmpDir := GinkgoT().TempDir() + m3u := "#EXTALBUMARTURL:https://example.com/cover.jpg\ntest.mp3\n" + plsFile := filepath.Join(tmpDir, "test.m3u") + Expect(os.WriteFile(plsFile, []byte(m3u), 0600)).To(Succeed()) + + mockLibRepo.SetData([]model.Library{{ID: 1, Path: tmpDir}}) + ds.MockedMediaFile = &mockedMediaFileFromListRepo{data: []string{"test.mp3"}} + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + + plsFolder := &model.Folder{ID: "1", LibraryID: 1, LibraryPath: tmpDir, Path: "", Name: ""} + pls, err := ps.ImportFile(ctx, plsFolder, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.ExternalImageURL).To(BeEmpty()) + }) + + It("updates ExternalImageURL on re-scan even when UploadedImage is set", func() { + conf.Server.EnableM3UExternalAlbumArt = true + + tmpDir := GinkgoT().TempDir() + mockLibRepo.SetData([]model.Library{{ID: 1, Path: tmpDir}}) + ds.MockedMediaFile = &mockedMediaFileFromListRepo{data: []string{"test.mp3"}} + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + + m3u := "#EXTALBUMARTURL:https://example.com/new-cover.jpg\ntest.mp3\n" + plsFile := filepath.Join(tmpDir, "test.m3u") + Expect(os.WriteFile(plsFile, []byte(m3u), 0600)).To(Succeed()) + + existingPls := &model.Playlist{ + ID: "existing-id", + Name: "Existing Playlist", + Path: plsFile, + Sync: true, + UploadedImage: "existing-id.jpg", + ExternalImageURL: "https://example.com/old-cover.jpg", + } + mockPlsRepo.PathMap = map[string]*model.Playlist{plsFile: existingPls} + + plsFolder := &model.Folder{ID: "1", LibraryID: 1, LibraryPath: tmpDir, Path: "", Name: ""} + pls, err := ps.ImportFile(ctx, plsFolder, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.UploadedImage).To(Equal("existing-id.jpg")) + Expect(pls.ExternalImageURL).To(Equal("https://example.com/new-cover.jpg")) + }) + + It("clears ExternalImageURL on re-scan when directive is removed", func() { + tmpDir := GinkgoT().TempDir() + mockLibRepo.SetData([]model.Library{{ID: 1, Path: tmpDir}}) + ds.MockedMediaFile = &mockedMediaFileFromListRepo{data: []string{"test.mp3"}} + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + + m3u := "test.mp3\n" + plsFile := filepath.Join(tmpDir, "test.m3u") + Expect(os.WriteFile(plsFile, []byte(m3u), 0600)).To(Succeed()) + + existingPls := &model.Playlist{ + ID: "existing-id", + Name: "Existing Playlist", + Path: plsFile, + Sync: true, + ExternalImageURL: "https://example.com/old-cover.jpg", + } + mockPlsRepo.PathMap = map[string]*model.Playlist{plsFile: existingPls} + + plsFolder := &model.Folder{ID: "1", LibraryID: 1, LibraryPath: tmpDir, Path: "", Name: ""} + pls, err := ps.ImportFile(ctx, plsFolder, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.ExternalImageURL).To(BeEmpty()) + }) + }) + + Describe("NSP", func() { + It("parses well-formed playlists", func() { + pls, err := ps.ImportFile(ctx, folder, "recently_played.nsp") + Expect(err).ToNot(HaveOccurred()) + Expect(mockPlsRepo.Last).To(Equal(pls)) + Expect(pls.OwnerID).To(Equal("123")) + Expect(pls.Name).To(Equal("Recently Played")) + Expect(pls.Comment).To(Equal("Recently played tracks")) + Expect(pls.Rules.Sort).To(Equal("lastPlayed")) + Expect(pls.Rules.Order).To(Equal("desc")) + Expect(pls.Rules.Limit).To(Equal(100)) + Expect(pls.Rules.Expression).To(BeAssignableToTypeOf(criteria.All{})) + }) + It("returns an error if the playlist is not well-formed", func() { + _, err := ps.ImportFile(ctx, folder, "invalid_json.nsp") + Expect(err.Error()).To(ContainSubstring("line 19, column 1: invalid character '\\n'")) + }) + It("parses NSP with public: true and creates public playlist", func() { + pls, err := ps.ImportFile(ctx, folder, "public_playlist.nsp") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Name).To(Equal("Public Playlist")) + Expect(pls.Public).To(BeTrue()) + }) + It("parses NSP with public: false and creates private playlist", func() { + pls, err := ps.ImportFile(ctx, folder, "private_playlist.nsp") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Name).To(Equal("Private Playlist")) + Expect(pls.Public).To(BeFalse()) + }) + It("uses server default when public field is absent", func() { + conf.Server.DefaultPlaylistPublicVisibility = true + + pls, err := ps.ImportFile(ctx, folder, "recently_played.nsp") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Name).To(Equal("Recently Played")) + Expect(pls.Public).To(BeTrue()) // Should be true since server default is true + }) + }) + + DescribeTable("Playlist filename Unicode normalization (regression fix-playlist-filename-normalization)", + func(storedForm, filesystemForm string) { + // Use Polish characters that decompose: ó (U+00F3) -> o + combining acute (U+006F + U+0301) + plsNameNFC := "Piosenki_Polskie_zółć" // NFC form (composed) + plsNameNFD := norm.NFD.String(plsNameNFC) + Expect(plsNameNFD).ToNot(Equal(plsNameNFC)) // Verify they differ + + nameByForm := map[string]string{"NFC": plsNameNFC, "NFD": plsNameNFD} + storedName := nameByForm[storedForm] + filesystemName := nameByForm[filesystemForm] + + tmpDir := GinkgoT().TempDir() + mockLibRepo.SetData([]model.Library{{ID: 1, Path: tmpDir}}) + ds.MockedMediaFile = &mockedMediaFileFromListRepo{data: []string{}} + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + + // Create the playlist file on disk with the filesystem's normalization form + plsFile := tmpDir + "/" + filesystemName + ".m3u" + Expect(os.WriteFile(plsFile, []byte("#PLAYLIST:Test\n"), 0600)).To(Succeed()) + + // Pre-populate mock repo with the stored normalization form + storedPath := tmpDir + "/" + storedName + ".m3u" + existingPls := &model.Playlist{ + ID: "existing-id", + Name: "Existing Playlist", + Path: storedPath, + Sync: true, + } + mockPlsRepo.PathMap = map[string]*model.Playlist{storedPath: existingPls} + + // Import using the filesystem's normalization form + plsFolder := &model.Folder{ + ID: "1", + LibraryID: 1, + LibraryPath: tmpDir, + Path: "", + Name: "", + } + pls, err := ps.ImportFile(ctx, plsFolder, filesystemName+".m3u") + Expect(err).ToNot(HaveOccurred()) + + // Should update existing playlist, not create new one + Expect(pls.ID).To(Equal("existing-id")) + Expect(pls.Name).To(Equal("Existing Playlist")) + }, + Entry("finds NFD-stored playlist when filesystem provides NFC path", "NFD", "NFC"), + Entry("finds NFC-stored playlist when filesystem provides NFD path", "NFC", "NFD"), + ) + + Describe("Cross-library relative paths", func() { + var tmpDir, plsDir, songsDir string + + BeforeEach(func() { + // Create temp directory structure + tmpDir = GinkgoT().TempDir() + plsDir = tmpDir + "/playlists" + songsDir = tmpDir + "/songs" + Expect(os.Mkdir(plsDir, 0755)).To(Succeed()) + Expect(os.Mkdir(songsDir, 0755)).To(Succeed()) + + // Setup two different libraries with paths matching our temp structure + mockLibRepo.SetData([]model.Library{ + {ID: 1, Path: songsDir}, + {ID: 2, Path: plsDir}, + }) + + // Create a mock media file repository that returns files for both libraries + // Note: The paths are relative to their respective library roots + ds.MockedMediaFile = &mockedMediaFileFromListRepo{ + data: []string{ + "abc.mp3", // This is songs/abc.mp3 relative to songsDir + "def.mp3", // This is playlists/def.mp3 relative to plsDir + }, + } + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + }) + + It("handles relative paths that reference files in other libraries", func() { + // Create a temporary playlist file with relative path + plsContent := "#PLAYLIST:Cross Library Test\n../songs/abc.mp3\ndef.mp3" + plsFile := plsDir + "/test.m3u" + Expect(os.WriteFile(plsFile, []byte(plsContent), 0600)).To(Succeed()) + + // Playlist is in the Playlists library folder + // Important: Path should be relative to LibraryPath, and Name is the folder name + plsFolder := &model.Folder{ + ID: "2", + LibraryID: 2, + LibraryPath: plsDir, + Path: "", + Name: "", + } + + pls, err := ps.ImportFile(ctx, plsFolder, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Tracks).To(HaveLen(2)) + Expect(pls.Tracks[0].Path).To(Equal("abc.mp3")) // From songsDir library + Expect(pls.Tracks[1].Path).To(Equal("def.mp3")) // From plsDir library + }) + + It("ignores paths that point outside all libraries", func() { + // Create a temporary playlist file with path outside libraries + plsContent := "#PLAYLIST:Outside Test\n../../outside.mp3\nabc.mp3" + plsFile := plsDir + "/test.m3u" + Expect(os.WriteFile(plsFile, []byte(plsContent), 0600)).To(Succeed()) + + plsFolder := &model.Folder{ + ID: "2", + LibraryID: 2, + LibraryPath: plsDir, + Path: "", + Name: "", + } + + pls, err := ps.ImportFile(ctx, plsFolder, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + // Should only find abc.mp3, not outside.mp3 + Expect(pls.Tracks).To(HaveLen(1)) + Expect(pls.Tracks[0].Path).To(Equal("abc.mp3")) + }) + + It("handles relative paths with multiple '../' components", func() { + // Create a nested structure: tmpDir/playlists/subfolder/test.m3u + subFolder := plsDir + "/subfolder" + Expect(os.Mkdir(subFolder, 0755)).To(Succeed()) + + // Create the media file in the subfolder directory + // The mock will return it as "def.mp3" relative to plsDir + ds.MockedMediaFile = &mockedMediaFileFromListRepo{ + data: []string{ + "abc.mp3", // From songsDir library + "def.mp3", // From plsDir library root + }, + } + + // From subfolder, ../../songs/abc.mp3 should resolve to songs library + // ../def.mp3 should resolve to plsDir/def.mp3 + plsContent := "#PLAYLIST:Nested Test\n../../songs/abc.mp3\n../def.mp3" + plsFile := subFolder + "/test.m3u" + Expect(os.WriteFile(plsFile, []byte(plsContent), 0600)).To(Succeed()) + + // The folder: AbsolutePath = LibraryPath + Path + Name + // So for /playlists/subfolder: LibraryPath=/playlists, Path="", Name="subfolder" + plsFolder := &model.Folder{ + ID: "2", + LibraryID: 2, + LibraryPath: plsDir, + Path: "", // Empty because subfolder is directly under library root + Name: "subfolder", // The folder name + } + + pls, err := ps.ImportFile(ctx, plsFolder, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Tracks).To(HaveLen(2)) + Expect(pls.Tracks[0].Path).To(Equal("abc.mp3")) // From songsDir library + Expect(pls.Tracks[1].Path).To(Equal("def.mp3")) // From plsDir library root + }) + + It("correctly resolves libraries when one path is a prefix of another", func() { + // This tests the bug where /music would match before /music-classical + // Create temp directory structure with prefix conflict + tmpDir := GinkgoT().TempDir() + musicDir := tmpDir + "/music" + musicClassicalDir := tmpDir + "/music-classical" + Expect(os.Mkdir(musicDir, 0755)).To(Succeed()) + Expect(os.Mkdir(musicClassicalDir, 0755)).To(Succeed()) + + // Setup two libraries where one is a prefix of the other + mockLibRepo.SetData([]model.Library{ + {ID: 1, Path: musicDir}, // /tmp/xxx/music + {ID: 2, Path: musicClassicalDir}, // /tmp/xxx/music-classical + }) + + // Mock will return tracks from both libraries + ds.MockedMediaFile = &mockedMediaFileFromListRepo{ + data: []string{ + "rock.mp3", // From music library + "bach.mp3", // From music-classical library + }, + } + + // Create playlist in music library that references music-classical + plsContent := "#PLAYLIST:Cross Prefix Test\nrock.mp3\n../music-classical/bach.mp3" + plsFile := musicDir + "/test.m3u" + Expect(os.WriteFile(plsFile, []byte(plsContent), 0600)).To(Succeed()) + + plsFolder := &model.Folder{ + ID: "1", + LibraryID: 1, + LibraryPath: musicDir, + Path: "", + Name: "", + } + + pls, err := ps.ImportFile(ctx, plsFolder, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Tracks).To(HaveLen(2)) + Expect(pls.Tracks[0].Path).To(Equal("rock.mp3")) // From music library + Expect(pls.Tracks[1].Path).To(Equal("bach.mp3")) // From music-classical library (not music!) + }) + + It("correctly handles identical relative paths from different libraries", func() { + // This tests the bug where two libraries have files at the same relative path + // and only one appears in the playlist + tmpDir := GinkgoT().TempDir() + musicDir := tmpDir + "/music" + classicalDir := tmpDir + "/classical" + Expect(os.Mkdir(musicDir, 0755)).To(Succeed()) + Expect(os.Mkdir(classicalDir, 0755)).To(Succeed()) + Expect(os.MkdirAll(musicDir+"/album", 0755)).To(Succeed()) + Expect(os.MkdirAll(classicalDir+"/album", 0755)).To(Succeed()) + // Create placeholder files so paths resolve correctly + Expect(os.WriteFile(musicDir+"/album/track.mp3", []byte{}, 0600)).To(Succeed()) + Expect(os.WriteFile(classicalDir+"/album/track.mp3", []byte{}, 0600)).To(Succeed()) + + // Both libraries have a file at "album/track.mp3" + mockLibRepo.SetData([]model.Library{ + {ID: 1, Path: musicDir}, + {ID: 2, Path: classicalDir}, + }) + + // Mock returns files with same relative path but different IDs and library IDs + // Keys use the library-qualified format: "libraryID:path" + ds.MockedMediaFile = &mockedMediaFileRepo{ + data: map[string]model.MediaFile{ + "1:album/track.mp3": {ID: "music-track", Path: "album/track.mp3", LibraryID: 1, Title: "Rock Song"}, + "2:album/track.mp3": {ID: "classical-track", Path: "album/track.mp3", LibraryID: 2, Title: "Classical Piece"}, + }, + } + // Recreate playlists service to pick up new mock + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + + // Create playlist in music library that references both tracks + plsContent := "#PLAYLIST:Same Path Test\nalbum/track.mp3\n../classical/album/track.mp3" + plsFile := musicDir + "/test.m3u" + Expect(os.WriteFile(plsFile, []byte(plsContent), 0600)).To(Succeed()) + + plsFolder := &model.Folder{ + ID: "1", + LibraryID: 1, + LibraryPath: musicDir, + Path: "", + Name: "", + } + + pls, err := ps.ImportFile(ctx, plsFolder, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + + // Should have BOTH tracks, not just one + Expect(pls.Tracks).To(HaveLen(2), "Playlist should contain both tracks with same relative path") + + // Verify we got tracks from DIFFERENT libraries (the key fix!) + // Collect the library IDs + libIDs := make(map[int]bool) + for _, track := range pls.Tracks { + libIDs[track.LibraryID] = true + } + Expect(libIDs).To(HaveLen(2), "Tracks should come from two different libraries") + Expect(libIDs[1]).To(BeTrue(), "Should have track from library 1") + Expect(libIDs[2]).To(BeTrue(), "Should have track from library 2") + + // Both tracks should have the same relative path + Expect(pls.Tracks[0].Path).To(Equal("album/track.mp3")) + Expect(pls.Tracks[1].Path).To(Equal("album/track.mp3")) + }) + }) + }) + + Describe("ImportM3U", func() { + var repo *mockedMediaFileFromListRepo + BeforeEach(func() { + repo = &mockedMediaFileFromListRepo{} + ds.MockedMediaFile = repo + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + mockLibRepo.SetData([]model.Library{{ID: 1, Path: "/music"}, {ID: 2, Path: "/new"}}) + ctx = request.WithUser(ctx, model.User{ID: "123"}) + }) + + It("parses well-formed playlists", func() { + repo.data = []string{ + "tests/test.mp3", + "tests/test.ogg", + "tests/01 Invisible (RED) Edit Version.mp3", + "downloads/newfile.flac", + } + m3u := strings.Join([]string{ + "#PLAYLIST:playlist 1", + "/music/tests/test.mp3", + "/music/tests/test.ogg", + "/new/downloads/newfile.flac", + "file:///music/tests/01%20Invisible%20(RED)%20Edit%20Version.mp3", + }, "\n") + f := strings.NewReader(m3u) + + pls, err := ps.ImportM3U(ctx, f) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.OwnerID).To(Equal("123")) + Expect(pls.Name).To(Equal("playlist 1")) + Expect(pls.Sync).To(BeFalse()) + Expect(pls.Tracks).To(HaveLen(4)) + Expect(pls.Tracks[0].Path).To(Equal("tests/test.mp3")) + Expect(pls.Tracks[1].Path).To(Equal("tests/test.ogg")) + Expect(pls.Tracks[2].Path).To(Equal("downloads/newfile.flac")) + Expect(pls.Tracks[3].Path).To(Equal("tests/01 Invisible (RED) Edit Version.mp3")) + Expect(mockPlsRepo.Last).To(Equal(pls)) + }) + + It("sets the playlist name as a timestamp if the #PLAYLIST directive is not present", func() { + repo.data = []string{ + "tests/test.mp3", + "tests/test.ogg", + "/tests/01 Invisible (RED) Edit Version.mp3", + } + m3u := strings.Join([]string{ + "/music/tests/test.mp3", + "/music/tests/test.ogg", + }, "\n") + f := strings.NewReader(m3u) + pls, err := ps.ImportM3U(ctx, f) + Expect(err).ToNot(HaveOccurred()) + _, err = time.Parse(time.RFC3339, pls.Name) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Tracks).To(HaveLen(2)) + }) + + It("returns only tracks that exist in the database and in the same order as the m3u", func() { + repo.data = []string{ + "album1/test1.mp3", + "album2/test2.mp3", + "album3/test3.mp3", + } + m3u := strings.Join([]string{ + "/music/album3/test3.mp3", + "/music/album1/test1.mp3", + "/music/album4/test4.mp3", + "/music/album2/test2.mp3", + }, "\n") + f := strings.NewReader(m3u) + pls, err := ps.ImportM3U(ctx, f) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Tracks).To(HaveLen(3)) + Expect(pls.Tracks[0].Path).To(Equal("album3/test3.mp3")) + Expect(pls.Tracks[1].Path).To(Equal("album1/test1.mp3")) + Expect(pls.Tracks[2].Path).To(Equal("album2/test2.mp3")) + }) + + It("is case-insensitive when comparing paths", func() { + repo.data = []string{ + "abc/tEsT1.Mp3", + } + m3u := strings.Join([]string{ + "/music/ABC/TeSt1.mP3", + }, "\n") + f := strings.NewReader(m3u) + pls, err := ps.ImportM3U(ctx, f) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Tracks).To(HaveLen(1)) + Expect(pls.Tracks[0].Path).To(Equal("abc/tEsT1.Mp3")) + }) + + It("parses #EXTALBUMARTURL with HTTP URL via ImportM3U", func() { + conf.Server.EnableM3UExternalAlbumArt = true + + repo.data = []string{"tests/test.mp3"} + m3u := "#EXTALBUMARTURL:https://example.com/cover.jpg\n/music/tests/test.mp3\n" + pls, err := ps.ImportM3U(ctx, strings.NewReader(m3u)) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.ExternalImageURL).To(Equal("https://example.com/cover.jpg")) + }) + + It("ignores relative #EXTALBUMARTURL when imported via API (no folder context)", func() { + repo.data = []string{"tests/test.mp3"} + m3u := "#EXTALBUMARTURL:cover.jpg\n/music/tests/test.mp3\n" + pls, err := ps.ImportM3U(ctx, strings.NewReader(m3u)) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.ExternalImageURL).To(BeEmpty()) + }) + + // Fullwidth characters (e.g., ＡＢＣＤ) are not handled by SQLite's NOCASE collation, + // so we need exact matching for non-ASCII characters. + It("matches fullwidth characters exactly (SQLite NOCASE limitation)", func() { + // Fullwidth uppercase ＡＣＲＯＳＳ (U+FF21, U+FF23, U+FF32, U+FF2F, U+FF33, U+FF33) + repo.data = []string{ + "plex/02 - ＡＣＲＯＳＳ.flac", + } + m3u := "/music/plex/02 - ＡＣＲＯＳＳ.flac\n" + f := strings.NewReader(m3u) + pls, err := ps.ImportM3U(ctx, f) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Tracks).To(HaveLen(1)) + Expect(pls.Tracks[0].Path).To(Equal("plex/02 - ＡＣＲＯＳＳ.flac")) + }) + + // Unicode normalization tests: NFC (composed) vs NFD (decomposed) forms + // macOS stores paths in NFD, Linux/Windows use NFC. Playlists may use either form. + DescribeTable("matches paths across Unicode NFC/NFD normalization", + func(description, pathNFC string, dbForm, playlistForm norm.Form) { + pathNFD := norm.NFD.String(pathNFC) + Expect(pathNFD).ToNot(Equal(pathNFC), "test path should have decomposable characters") + + // Set up DB with specified normalization form + var dbPath string + if dbForm == norm.NFC { + dbPath = pathNFC + } else { + dbPath = pathNFD + } + repo.data = []string{dbPath} + + // Set up playlist with specified normalization form + var playlistPath string + if playlistForm == norm.NFC { + playlistPath = pathNFC + } else { + playlistPath = pathNFD + } + m3u := "/music/" + playlistPath + "\n" + f := strings.NewReader(m3u) + + pls, err := ps.ImportM3U(ctx, f) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Tracks).To(HaveLen(1)) + Expect(pls.Tracks[0].Path).To(Equal(dbPath)) + }, + // French: è (U+00E8) decomposes to e + combining grave (U+0065 + U+0300) + Entry("French diacritics - DB:NFD, playlist:NFC", + "macOS DB with Apple Music playlist", + "artist/Michèle/song.mp3", norm.NFD, norm.NFC), + + // Japanese Katakana: ド (U+30C9) decomposes to ト (U+30C8) + combining dakuten (U+3099) + Entry("Japanese Katakana with dakuten - DB:NFC, playlist:NFC (#4884)", + "Linux/Windows DB with NFC playlist", + "artist/\u30a2\u30a4\u30c9\u30eb/\u30c9\u30ea\u30fc\u30e0\u30bd\u30f3\u30b0.mp3", norm.NFC, norm.NFC), + Entry("Japanese Katakana with dakuten - DB:NFD, playlist:NFC (#4884)", + "macOS DB with NFC playlist", + "artist/\u30a2\u30a4\u30c9\u30eb/\u30c9\u30ea\u30fc\u30e0\u30bd\u30f3\u30b0.mp3", norm.NFD, norm.NFC), + + // Cyrillic: й (U+0439) decomposes to и (U+0438) + combining breve (U+0306) + Entry("Cyrillic characters - DB:NFD, playlist:NFC (#4791)", + "macOS DB with NFC playlist", + "Жуки/Батарейка/01 - Разлюбила.mp3", norm.NFD, norm.NFC), + + // Polish: ó (U+00F3) decomposes to o + combining acute (U+0301) + Entry("Polish diacritics - DB:NFD, playlist:NFC (#4663)", + "macOS DB with NFC playlist", + "Zespół/Człowiek/Piosenka o miłości.mp3", norm.NFD, norm.NFC), + Entry("Polish diacritics - DB:NFC, playlist:NFD", + "Linux/Windows DB with macOS-exported playlist", + "Zespół/Człowiek/Piosenka o miłości.mp3", norm.NFC, norm.NFD), + ) + + }) + + Describe("InPath", func() { + var folder model.Folder + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + folder = model.Folder{ + LibraryPath: "/music", + Path: "playlists/abc", + Name: "folder1", + } + }) + + It("returns true if PlaylistsPath is empty", func() { + conf.Server.PlaylistsPath = "" + Expect(playlists.InPath(folder)).To(BeTrue()) + }) + + It("returns true if PlaylistsPath is any (**/**)", func() { + conf.Server.PlaylistsPath = "**/**" + Expect(playlists.InPath(folder)).To(BeTrue()) + }) + + It("returns true if folder is in PlaylistsPath", func() { + conf.Server.PlaylistsPath = "other/**:playlists/**" + Expect(playlists.InPath(folder)).To(BeTrue()) + }) + + It("returns false if folder is not in PlaylistsPath", func() { + conf.Server.PlaylistsPath = "other" + Expect(playlists.InPath(folder)).To(BeFalse()) + }) + + It("returns true if for a playlist in root of MusicFolder if PlaylistsPath is '.'", func() { + conf.Server.PlaylistsPath = "." + Expect(playlists.InPath(folder)).To(BeFalse()) + + folder2 := model.Folder{ + LibraryPath: "/music", + Path: "", + Name: ".", + } + + Expect(playlists.InPath(folder2)).To(BeTrue()) + }) + }) +}) + +// mockedMediaFileRepo's FindByPaths method returns MediaFiles for the given paths. +// If data map is provided, looks up files by key; otherwise creates them from paths. +type mockedMediaFileRepo struct { + model.MediaFileRepository + data map[string]model.MediaFile +} + +func (r *mockedMediaFileRepo) FindByPaths(paths []string) (model.MediaFiles, error) { + var mfs model.MediaFiles + + // If data map provided, look up files + if r.data != nil { + for _, path := range paths { + if mf, ok := r.data[path]; ok { + mfs = append(mfs, mf) + } + } + return mfs, nil + } + + // Otherwise, create MediaFiles from paths + for idx, path := range paths { + // Strip library qualifier if present (format: "libraryID:path") + actualPath := path + libraryID := 1 + if parts := strings.SplitN(path, ":", 2); len(parts) == 2 { + if id, err := strconv.Atoi(parts[0]); err == nil { + libraryID = id + actualPath = parts[1] + } + } + + mfs = append(mfs, model.MediaFile{ + ID: strconv.Itoa(idx), + Path: actualPath, + LibraryID: libraryID, + }) + } + return mfs, nil +} + +// mockedMediaFileFromListRepo's FindByPaths method returns a list of MediaFiles based on the data field +type mockedMediaFileFromListRepo struct { + model.MediaFileRepository + data []string +} + +func (r *mockedMediaFileFromListRepo) FindByPaths(paths []string) (model.MediaFiles, error) { + var mfs model.MediaFiles + + for idx, dataPath := range r.data { + for _, requestPath := range paths { + // Strip library qualifier if present (format: "libraryID:path") + actualPath := requestPath + libraryID := 1 + if parts := strings.SplitN(requestPath, ":", 2); len(parts) == 2 { + if id, err := strconv.Atoi(parts[0]); err == nil { + libraryID = id + actualPath = parts[1] + } + } + + // Case-insensitive comparison (like SQL's "collate nocase"), but with no + // implicit Unicode normalization (SQLite does not normalize NFC/NFD). + if strings.EqualFold(actualPath, dataPath) { + mfs = append(mfs, model.MediaFile{ + ID: strconv.Itoa(idx), + Path: dataPath, // Return original path from DB + LibraryID: libraryID, + }) + break + } + } + } + return mfs, nil +} diff --git a/core/playlists/parse_m3u.go b/core/playlists/parse_m3u.go new file mode 100644 index 000000000..b9f5c92a2 --- /dev/null +++ b/core/playlists/parse_m3u.go @@ -0,0 +1,324 @@ +package playlists + +import ( + "cmp" + "context" + "fmt" + "io" + "net/url" + "path/filepath" + "slices" + "strings" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/utils/slice" + "golang.org/x/text/unicode/norm" +) + +func (s *playlists) parseM3U(ctx context.Context, pls *model.Playlist, folder *model.Folder, reader io.Reader) error { + mediaFileRepository := s.ds.MediaFile(ctx) + resolver, err := newPathResolver(ctx, s.ds) + if err != nil { + return err + } + var mfs model.MediaFiles + // Chunk size of 100 lines, as each line can generate up to 4 lookup candidates + // (NFC/NFD × raw/lowercase), and SQLite has a max expression tree depth of 1000. + for lines := range slice.CollectChunks(slice.LinesFrom(reader), 100) { + filteredLines := make([]string, 0, len(lines)) + for _, line := range lines { + line := strings.TrimSpace(line) + if after, ok := strings.CutPrefix(line, "#PLAYLIST:"); ok { + pls.Name = after + continue + } + if after, ok := strings.CutPrefix(line, "#EXTALBUMARTURL:"); ok { + pls.ExternalImageURL = resolveImageURL(after, folder, resolver.matcher) + continue + } + // Skip empty lines and extended info + if line == "" || strings.HasPrefix(line, "#") { + continue + } + if after, ok := strings.CutPrefix(line, "file://"); ok { + line = after + line, _ = url.PathUnescape(line) + } + if !model.IsAudioFile(line) { + continue + } + filteredLines = append(filteredLines, line) + } + resolvedPaths, err := resolver.resolvePaths(ctx, folder, filteredLines) + if err != nil { + log.Warn(ctx, "Error resolving paths in playlist", "playlist", pls.Name, err) + continue + } + + // SQLite comparisons do not perform Unicode normalization, and filesystem normalization + // differs across platforms (macOS often yields NFD, while Linux/Windows typically use NFC). + // Generate lookup candidates for both forms so playlist entries match DB paths regardless + // of the original normalization. See https://github.com/navidrome/navidrome/issues/4884 + // + // We also include the original (non-lowercased) paths because SQLite's COLLATE NOCASE + // only handles ASCII case-insensitivity. Non-ASCII characters like fullwidth letters + // (e.g., ＡＢＣＤ vs ａｂｃｄ) are not matched case-insensitively by NOCASE. + lookupCandidates := make([]string, 0, len(resolvedPaths)*4) + seen := make(map[string]struct{}, len(resolvedPaths)*4) + for _, path := range resolvedPaths { + // Add original paths first (for exact matching of non-ASCII characters) + nfcRaw := norm.NFC.String(path) + if _, ok := seen[nfcRaw]; !ok { + seen[nfcRaw] = struct{}{} + lookupCandidates = append(lookupCandidates, nfcRaw) + } + nfdRaw := norm.NFD.String(path) + if _, ok := seen[nfdRaw]; !ok { + seen[nfdRaw] = struct{}{} + lookupCandidates = append(lookupCandidates, nfdRaw) + } + + // Add lowercased paths (for ASCII case-insensitive matching via NOCASE) + nfc := strings.ToLower(nfcRaw) + if _, ok := seen[nfc]; !ok { + seen[nfc] = struct{}{} + lookupCandidates = append(lookupCandidates, nfc) + } + nfd := strings.ToLower(nfdRaw) + if _, ok := seen[nfd]; !ok { + seen[nfd] = struct{}{} + lookupCandidates = append(lookupCandidates, nfd) + } + } + + found, err := mediaFileRepository.FindByPaths(lookupCandidates) + if err != nil { + log.Warn(ctx, "Error reading files from DB", "playlist", pls.Name, err) + continue + } + + // Build lookup map with library-qualified keys, normalized for comparison. + // Canonicalize to NFC so NFD/NFC become comparable. + existing := make(map[string]int, len(found)) + for idx := range found { + key := fmt.Sprintf("%d:%s", found[idx].LibraryID, strings.ToLower(norm.NFC.String(found[idx].Path))) + existing[key] = idx + } + + // Find media files in the order of the resolved paths, to keep playlist order. + // Both `existing` keys and `resolvedPaths` use the library-qualified format "libraryID:relativePath", + // so normalizing the full string produces matching keys (digits and ':' are ASCII-invariant). + for _, path := range resolvedPaths { + key := strings.ToLower(norm.NFC.String(path)) + idx, ok := existing[key] + if ok { + mfs = append(mfs, found[idx]) + } else { + // Prefer logging a composed representation when possible to avoid confusing output + // with decomposed combining marks. + log.Warn(ctx, "Path in playlist not found", "playlist", pls.Name, "path", norm.NFC.String(path)) + } + } + } + if pls.Name == "" { + pls.Name = time.Now().Format(time.RFC3339) + } + pls.Tracks = nil + pls.AddMediaFiles(mfs) + + return nil +} + +// pathResolution holds the result of resolving a playlist path to a library-relative path. +type pathResolution struct { + absolutePath string + libraryPath string + libraryID int + valid bool +} + +// ToQualifiedString converts the path resolution to a library-qualified string with forward slashes. +// Format: "libraryID:relativePath" with forward slashes for path separators. +func (r pathResolution) ToQualifiedString() (string, error) { + if !r.valid { + return "", fmt.Errorf("invalid path resolution") + } + relativePath, err := filepath.Rel(r.libraryPath, r.absolutePath) + if err != nil { + return "", err + } + // Convert path separators to forward slashes + return fmt.Sprintf("%d:%s", r.libraryID, filepath.ToSlash(relativePath)), nil +} + +// libraryMatcher holds sorted libraries with cleaned paths for efficient path matching. +type libraryMatcher struct { + libraries model.Libraries + cleanedPaths []string +} + +// findLibraryForPath finds which library contains the given absolute path. +// Returns library ID and path, or 0 and empty string if not found. +func (lm *libraryMatcher) findLibraryForPath(absolutePath string) (int, string) { + // Check sorted libraries (longest path first) to find the best match + for i, cleanLibPath := range lm.cleanedPaths { + // Check if absolutePath is under this library path + if strings.HasPrefix(absolutePath, cleanLibPath) { + // Ensure it's a proper path boundary (not just a prefix) + if len(absolutePath) == len(cleanLibPath) || absolutePath[len(cleanLibPath)] == filepath.Separator { + return lm.libraries[i].ID, cleanLibPath + } + } + } + return 0, "" +} + +// newLibraryMatcher creates a libraryMatcher with libraries sorted by path length (longest first). +// This ensures correct matching when library paths are prefixes of each other. +// Example: /music-classical must be checked before /music +// Otherwise, /music-classical/track.mp3 would match /music instead of /music-classical +func newLibraryMatcher(libs model.Libraries) *libraryMatcher { + // Sort libraries by path length (descending) to ensure longest paths match first. + slices.SortFunc(libs, func(i, j model.Library) int { + return cmp.Compare(len(j.Path), len(i.Path)) // Reverse order for descending + }) + + // Pre-clean all library paths once for efficient matching + cleanedPaths := make([]string, len(libs)) + for i, lib := range libs { + cleanedPaths[i] = filepath.Clean(lib.Path) + } + return &libraryMatcher{ + libraries: libs, + cleanedPaths: cleanedPaths, + } +} + +// pathResolver handles path resolution logic for playlist imports. +type pathResolver struct { + matcher *libraryMatcher +} + +// newPathResolver creates a pathResolver with libraries loaded from the datastore. +func newPathResolver(ctx context.Context, ds model.DataStore) (*pathResolver, error) { + libs, err := ds.Library(ctx).GetAll() + if err != nil { + return nil, err + } + matcher := newLibraryMatcher(libs) + return &pathResolver{matcher: matcher}, nil +} + +// resolvePath determines the absolute path and library path for a playlist entry. +// For absolute paths, it uses them directly. +// For relative paths, it resolves them relative to the playlist's folder location. +// Example: playlist at /music/playlists/test.m3u with line "../songs/abc.mp3" +// +// resolves to /music/songs/abc.mp3 +func (r *pathResolver) resolvePath(line string, folder *model.Folder) pathResolution { + var absolutePath string + if folder != nil && !filepath.IsAbs(line) { + // Resolve relative path to absolute path based on playlist location + absolutePath = filepath.Clean(filepath.Join(folder.AbsolutePath(), line)) + } else { + // Use absolute path directly after cleaning + absolutePath = filepath.Clean(line) + } + + return r.findInLibraries(absolutePath) +} + +// findInLibraries matches an absolute path against all known libraries and returns +// a pathResolution with the library information. Returns an invalid resolution if +// the path is not found in any library. +func (r *pathResolver) findInLibraries(absolutePath string) pathResolution { + libID, libPath := r.matcher.findLibraryForPath(absolutePath) + if libID == 0 { + return pathResolution{valid: false} + } + return pathResolution{ + absolutePath: absolutePath, + libraryPath: libPath, + libraryID: libID, + valid: true, + } +} + +// resolvePaths converts playlist file paths to library-qualified paths (format: "libraryID:relativePath"). +// For relative paths, it resolves them to absolute paths first, then determines which +// library they belong to. This allows playlists to reference files across library boundaries. +func (r *pathResolver) resolvePaths(ctx context.Context, folder *model.Folder, lines []string) ([]string, error) { + results := make([]string, 0, len(lines)) + for idx, line := range lines { + resolution := r.resolvePath(line, folder) + + if !resolution.valid { + log.Warn(ctx, "Path in playlist not found in any library", "path", line, "line", idx) + continue + } + + qualifiedPath, err := resolution.ToQualifiedString() + if err != nil { + log.Debug(ctx, "Error getting library-qualified path", "path", line, + "libPath", resolution.libraryPath, "filePath", resolution.absolutePath, err) + continue + } + + results = append(results, qualifiedPath) + } + + return results, nil +} + +// resolveImageURL resolves an #EXTALBUMARTURL value to a storable string. +// HTTP(S) URLs are stored as-is (gated by EnableM3UExternalAlbumArt). +// Local paths (file://, absolute, or relative) are resolved to an absolute path +// and validated against known library boundaries via matcher. +func resolveImageURL(value string, folder *model.Folder, matcher *libraryMatcher) string { + value = strings.TrimSpace(value) + if value == "" { + return "" + } + + // HTTP(S) URLs — store as-is, but only if external album art is enabled + if strings.HasPrefix(value, "http://") || strings.HasPrefix(value, "https://") { + if !conf.Server.EnableM3UExternalAlbumArt { + return "" + } + return value + } + + // Resolve to local absolute path + localPath, ok := resolveLocalPath(value, folder) + if !ok { + return "" + } + + // Validate path is within a known library + if libID, _ := matcher.findLibraryForPath(localPath); libID == 0 { + return "" + } + return localPath +} + +// resolveLocalPath converts a file://, absolute, or relative path to a clean absolute path. +// Returns ("", false) if the path cannot be resolved. +func resolveLocalPath(value string, folder *model.Folder) (string, bool) { + if after, ok := strings.CutPrefix(value, "file://"); ok { + decoded, err := url.PathUnescape(after) + if err != nil { + return "", false + } + return filepath.Clean(decoded), true + } + if filepath.IsAbs(value) { + return filepath.Clean(value), true + } + if folder == nil { + return "", false + } + return filepath.Clean(filepath.Join(folder.AbsolutePath(), value)), true +} diff --git a/core/playlists/parse_m3u_test.go b/core/playlists/parse_m3u_test.go new file mode 100644 index 000000000..05e1c30e1 --- /dev/null +++ b/core/playlists/parse_m3u_test.go @@ -0,0 +1,406 @@ +package playlists + +import ( + "context" + + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("libraryMatcher", func() { + var ds *tests.MockDataStore + var mockLibRepo *tests.MockLibraryRepo + ctx := context.Background() + + BeforeEach(func() { + mockLibRepo = &tests.MockLibraryRepo{} + ds = &tests.MockDataStore{ + MockedLibrary: mockLibRepo, + } + }) + + // Helper function to create a libraryMatcher from the mock datastore + createMatcher := func(ds model.DataStore) *libraryMatcher { + libs, err := ds.Library(ctx).GetAll() + Expect(err).ToNot(HaveOccurred()) + return newLibraryMatcher(libs) + } + + Describe("Longest library path matching", func() { + It("matches the longest library path when multiple libraries share a prefix", func() { + // Setup libraries with prefix conflicts + mockLibRepo.SetData([]model.Library{ + {ID: 1, Path: "/music"}, + {ID: 2, Path: "/music-classical"}, + {ID: 3, Path: "/music-classical/opera"}, + }) + + matcher := createMatcher(ds) + + // Test that longest path matches first and returns correct library ID + testCases := []struct { + path string + expectedLibID int + expectedLibPath string + }{ + {"/music-classical/opera/track.mp3", 3, "/music-classical/opera"}, + {"/music-classical/track.mp3", 2, "/music-classical"}, + {"/music/track.mp3", 1, "/music"}, + {"/music-classical/opera/subdir/file.mp3", 3, "/music-classical/opera"}, + } + + for _, tc := range testCases { + libID, libPath := matcher.findLibraryForPath(tc.path) + Expect(libID).To(Equal(tc.expectedLibID), "Path %s should match library ID %d, but got %d", tc.path, tc.expectedLibID, libID) + Expect(libPath).To(Equal(tc.expectedLibPath), "Path %s should match library path %s, but got %s", tc.path, tc.expectedLibPath, libPath) + } + }) + + It("handles libraries with similar prefixes but different structures", func() { + mockLibRepo.SetData([]model.Library{ + {ID: 1, Path: "/home/user/music"}, + {ID: 2, Path: "/home/user/music-backup"}, + }) + + matcher := createMatcher(ds) + + // Test that music-backup library is matched correctly + libID, libPath := matcher.findLibraryForPath("/home/user/music-backup/track.mp3") + Expect(libID).To(Equal(2)) + Expect(libPath).To(Equal("/home/user/music-backup")) + + // Test that music library is still matched correctly + libID, libPath = matcher.findLibraryForPath("/home/user/music/track.mp3") + Expect(libID).To(Equal(1)) + Expect(libPath).To(Equal("/home/user/music")) + }) + + It("matches path that is exactly the library root", func() { + mockLibRepo.SetData([]model.Library{ + {ID: 1, Path: "/music"}, + {ID: 2, Path: "/music-classical"}, + }) + + matcher := createMatcher(ds) + + // Exact library path should match + libID, libPath := matcher.findLibraryForPath("/music-classical") + Expect(libID).To(Equal(2)) + Expect(libPath).To(Equal("/music-classical")) + }) + + It("handles complex nested library structures", func() { + mockLibRepo.SetData([]model.Library{ + {ID: 1, Path: "/media"}, + {ID: 2, Path: "/media/audio"}, + {ID: 3, Path: "/media/audio/classical"}, + {ID: 4, Path: "/media/audio/classical/baroque"}, + }) + + matcher := createMatcher(ds) + + testCases := []struct { + path string + expectedLibID int + expectedLibPath string + }{ + {"/media/audio/classical/baroque/bach/track.mp3", 4, "/media/audio/classical/baroque"}, + {"/media/audio/classical/mozart/track.mp3", 3, "/media/audio/classical"}, + {"/media/audio/rock/track.mp3", 2, "/media/audio"}, + {"/media/video/movie.mp4", 1, "/media"}, + } + + for _, tc := range testCases { + libID, libPath := matcher.findLibraryForPath(tc.path) + Expect(libID).To(Equal(tc.expectedLibID), "Path %s should match library ID %d", tc.path, tc.expectedLibID) + Expect(libPath).To(Equal(tc.expectedLibPath), "Path %s should match library path %s", tc.path, tc.expectedLibPath) + } + }) + }) + + Describe("Edge cases", func() { + It("handles empty library list", func() { + mockLibRepo.SetData([]model.Library{}) + + matcher := createMatcher(ds) + Expect(matcher).ToNot(BeNil()) + + // Should not match anything + libID, libPath := matcher.findLibraryForPath("/music/track.mp3") + Expect(libID).To(Equal(0)) + Expect(libPath).To(BeEmpty()) + }) + + It("handles single library", func() { + mockLibRepo.SetData([]model.Library{ + {ID: 1, Path: "/music"}, + }) + + matcher := createMatcher(ds) + + libID, libPath := matcher.findLibraryForPath("/music/track.mp3") + Expect(libID).To(Equal(1)) + Expect(libPath).To(Equal("/music")) + }) + + It("handles libraries with special characters in paths", func() { + mockLibRepo.SetData([]model.Library{ + {ID: 1, Path: "/music[test]"}, + {ID: 2, Path: "/music(backup)"}, + }) + + matcher := createMatcher(ds) + Expect(matcher).ToNot(BeNil()) + + // Special characters should match literally + libID, libPath := matcher.findLibraryForPath("/music[test]/track.mp3") + Expect(libID).To(Equal(1)) + Expect(libPath).To(Equal("/music[test]")) + }) + }) + + Describe("Path matching order", func() { + It("ensures longest paths match first", func() { + mockLibRepo.SetData([]model.Library{ + {ID: 1, Path: "/a"}, + {ID: 2, Path: "/ab"}, + {ID: 3, Path: "/abc"}, + }) + + matcher := createMatcher(ds) + + // Verify that longer paths match correctly (not cut off by shorter prefix) + testCases := []struct { + path string + expectedLibID int + }{ + {"/abc/file.mp3", 3}, + {"/ab/file.mp3", 2}, + {"/a/file.mp3", 1}, + } + + for _, tc := range testCases { + libID, _ := matcher.findLibraryForPath(tc.path) + Expect(libID).To(Equal(tc.expectedLibID), "Path %s should match library ID %d", tc.path, tc.expectedLibID) + } + }) + }) +}) + +var _ = Describe("pathResolver", func() { + var ds *tests.MockDataStore + var mockLibRepo *tests.MockLibraryRepo + var resolver *pathResolver + ctx := context.Background() + + BeforeEach(func() { + mockLibRepo = &tests.MockLibraryRepo{} + ds = &tests.MockDataStore{ + MockedLibrary: mockLibRepo, + } + + // Setup test libraries + mockLibRepo.SetData([]model.Library{ + {ID: 1, Path: "/music"}, + {ID: 2, Path: "/music-classical"}, + {ID: 3, Path: "/podcasts"}, + }) + + var err error + resolver, err = newPathResolver(ctx, ds) + Expect(err).ToNot(HaveOccurred()) + }) + + Describe("resolvePath", func() { + Context("basic", func() { + It("resolves absolute paths", func() { + resolution := resolver.resolvePath("/music/artist/album/track.mp3", nil) + + Expect(resolution.valid).To(BeTrue()) + Expect(resolution.libraryID).To(Equal(1)) + Expect(resolution.libraryPath).To(Equal("/music")) + Expect(resolution.absolutePath).To(Equal("/music/artist/album/track.mp3")) + }) + + It("resolves relative paths when folder is provided", func() { + folder := &model.Folder{ + Path: "playlists", + LibraryPath: "/music", + LibraryID: 1, + } + + resolution := resolver.resolvePath("../artist/album/track.mp3", folder) + + Expect(resolution.valid).To(BeTrue()) + Expect(resolution.libraryID).To(Equal(1)) + Expect(resolution.absolutePath).To(Equal("/music/artist/album/track.mp3")) + }) + + It("returns invalid resolution for paths outside any library", func() { + resolution := resolver.resolvePath("/outside/library/track.mp3", nil) + + Expect(resolution.valid).To(BeFalse()) + }) + }) + + Context("cross-library", func() { + It("resolves path within a library", func() { + resolution := resolver.resolvePath("/music/track.mp3", nil) + + Expect(resolution.valid).To(BeTrue()) + Expect(resolution.libraryID).To(Equal(1)) + Expect(resolution.libraryPath).To(Equal("/music")) + Expect(resolution.absolutePath).To(Equal("/music/track.mp3")) + }) + + It("resolves path to the longest matching library", func() { + resolution := resolver.resolvePath("/music-classical/track.mp3", nil) + + Expect(resolution.valid).To(BeTrue()) + Expect(resolution.libraryID).To(Equal(2)) + Expect(resolution.libraryPath).To(Equal("/music-classical")) + }) + + It("returns invalid resolution for path outside libraries", func() { + resolution := resolver.resolvePath("/videos/movie.mp4", nil) + + Expect(resolution.valid).To(BeFalse()) + }) + + It("cleans the path before matching", func() { + resolution := resolver.resolvePath("/music//artist/../artist/track.mp3", nil) + + Expect(resolution.valid).To(BeTrue()) + Expect(resolution.absolutePath).To(Equal("/music/artist/track.mp3")) + }) + }) + + Context("With relative paths", func() { + It("resolves relative path within same library", func() { + folder := &model.Folder{ + Path: "playlists", + LibraryPath: "/music", + LibraryID: 1, + } + + resolution := resolver.resolvePath("../songs/track.mp3", folder) + + Expect(resolution.valid).To(BeTrue()) + Expect(resolution.libraryID).To(Equal(1)) + Expect(resolution.absolutePath).To(Equal("/music/songs/track.mp3")) + }) + + It("resolves relative path to different library", func() { + folder := &model.Folder{ + Path: "playlists", + LibraryPath: "/music", + LibraryID: 1, + } + + // Path goes up and into a different library + resolution := resolver.resolvePath("../../podcasts/episode.mp3", folder) + + Expect(resolution.valid).To(BeTrue()) + Expect(resolution.libraryID).To(Equal(3)) + Expect(resolution.libraryPath).To(Equal("/podcasts")) + }) + + It("uses matcher to find correct library for resolved path", func() { + folder := &model.Folder{ + Path: "playlists", + LibraryPath: "/music", + LibraryID: 1, + } + + // This relative path resolves to music-classical library + resolution := resolver.resolvePath("../../music-classical/track.mp3", folder) + + Expect(resolution.valid).To(BeTrue()) + Expect(resolution.libraryID).To(Equal(2)) + Expect(resolution.libraryPath).To(Equal("/music-classical")) + }) + + It("returns invalid for relative paths escaping all libraries", func() { + folder := &model.Folder{ + Path: "playlists", + LibraryPath: "/music", + LibraryID: 1, + } + + resolution := resolver.resolvePath("../../../../etc/passwd", folder) + + Expect(resolution.valid).To(BeFalse()) + }) + }) + }) + + Describe("Cross-library resolution scenarios", func() { + It("handles playlist in library A referencing file in library B", func() { + // Playlist is in /music/playlists + folder := &model.Folder{ + Path: "playlists", + LibraryPath: "/music", + LibraryID: 1, + } + + // Relative path that goes to /podcasts library + resolution := resolver.resolvePath("../../podcasts/show/episode.mp3", folder) + + Expect(resolution.valid).To(BeTrue()) + Expect(resolution.libraryID).To(Equal(3), "Should resolve to podcasts library") + Expect(resolution.libraryPath).To(Equal("/podcasts")) + }) + + It("prefers longer library paths when resolving", func() { + // Ensure /music-classical is matched instead of /music + resolution := resolver.resolvePath("/music-classical/baroque/track.mp3", nil) + + Expect(resolution.valid).To(BeTrue()) + Expect(resolution.libraryID).To(Equal(2), "Should match /music-classical, not /music") + }) + }) +}) + +var _ = Describe("pathResolution", func() { + Describe("ToQualifiedString", func() { + It("converts valid resolution to qualified string with forward slashes", func() { + resolution := pathResolution{ + absolutePath: "/music/artist/album/track.mp3", + libraryPath: "/music", + libraryID: 1, + valid: true, + } + + qualifiedStr, err := resolution.ToQualifiedString() + + Expect(err).ToNot(HaveOccurred()) + Expect(qualifiedStr).To(Equal("1:artist/album/track.mp3")) + }) + + It("handles Windows-style paths by converting to forward slashes", func() { + resolution := pathResolution{ + absolutePath: "/music/artist/album/track.mp3", + libraryPath: "/music", + libraryID: 2, + valid: true, + } + + qualifiedStr, err := resolution.ToQualifiedString() + + Expect(err).ToNot(HaveOccurred()) + // Should always use forward slashes regardless of OS + Expect(qualifiedStr).To(ContainSubstring("2:")) + Expect(qualifiedStr).ToNot(ContainSubstring("\\")) + }) + + It("returns error for invalid resolution", func() { + resolution := pathResolution{valid: false} + + _, err := resolution.ToQualifiedString() + + Expect(err).To(HaveOccurred()) + }) + }) +}) diff --git a/core/playlists/parse_nsp.go b/core/playlists/parse_nsp.go new file mode 100644 index 000000000..56c80a950 --- /dev/null +++ b/core/playlists/parse_nsp.go @@ -0,0 +1,103 @@ +package playlists + +import ( + "context" + "encoding/json" + "errors" + "fmt" + "io" + "os" + "path/filepath" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/criteria" + "github.com/navidrome/navidrome/utils/jsoncommentstrip" +) + +func (s *playlists) newSyncedPlaylist(baseDir string, playlistFile string) (*model.Playlist, error) { + playlistPath := filepath.Join(baseDir, playlistFile) + info, err := os.Stat(playlistPath) + if err != nil { + return nil, err + } + + var extension = filepath.Ext(playlistFile) + var name = playlistFile[0 : len(playlistFile)-len(extension)] + + pls := &model.Playlist{ + Name: name, + Comment: fmt.Sprintf("Auto-imported from '%s'", playlistFile), + Public: false, + Path: playlistPath, + Sync: true, + UpdatedAt: info.ModTime(), + } + return pls, nil +} + +func getPositionFromOffset(data []byte, offset int64) (line, column int) { + line = 1 + for _, b := range data[:offset] { + if b == '\n' { + line++ + column = 1 + } else { + column++ + } + } + return +} + +func (s *playlists) parseNSP(_ context.Context, pls *model.Playlist, reader io.Reader) error { + nsp := &nspFile{} + reader = io.LimitReader(reader, 100*1024) // Limit to 100KB + reader = jsoncommentstrip.NewReader(reader) + input, err := io.ReadAll(reader) + if err != nil { + return fmt.Errorf("reading SmartPlaylist: %w", err) + } + err = json.Unmarshal(input, nsp) + if err != nil { + var syntaxErr *json.SyntaxError + if errors.As(err, &syntaxErr) { + line, col := getPositionFromOffset(input, syntaxErr.Offset) + return fmt.Errorf("JSON syntax error in SmartPlaylist at line %d, column %d: %w", line, col, err) + } + return fmt.Errorf("JSON parsing error in SmartPlaylist: %w", err) + } + pls.Rules = &nsp.Criteria + if nsp.Name != "" { + pls.Name = nsp.Name + } + if nsp.Comment != "" { + pls.Comment = nsp.Comment + } + if nsp.Public != nil { + pls.Public = *nsp.Public + } else { + pls.Public = conf.Server.DefaultPlaylistPublicVisibility + } + return nil +} + +type nspFile struct { + criteria.Criteria + Name string `json:"name"` + Comment string `json:"comment"` + Public *bool `json:"public"` +} + +func (i *nspFile) UnmarshalJSON(data []byte) error { + m := map[string]any{} + err := json.Unmarshal(data, &m) + if err != nil { + return err + } + i.Name, _ = m["name"].(string) + i.Comment, _ = m["comment"].(string) + if public, ok := m["public"].(bool); ok { + i.Public = &public + } + return json.Unmarshal(data, &i.Criteria) +} diff --git a/core/playlists/parse_nsp_test.go b/core/playlists/parse_nsp_test.go new file mode 100644 index 000000000..516a5355d --- /dev/null +++ b/core/playlists/parse_nsp_test.go @@ -0,0 +1,228 @@ +package playlists + +import ( + "context" + "os" + "path/filepath" + "strings" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/criteria" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("parseNSP", func() { + var s *playlists + ctx := context.Background() + + BeforeEach(func() { + s = &playlists{} + }) + + It("parses a well-formed NSP with all fields", func() { + nsp := `{ + "name": "My Smart Playlist", + "comment": "A test playlist", + "public": true, + "all": [{"is": {"loved": true}}], + "sort": "title", + "order": "asc", + "limit": 50 + }` + pls := &model.Playlist{Name: "default-name"} + err := s.parseNSP(ctx, pls, strings.NewReader(nsp)) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Name).To(Equal("My Smart Playlist")) + Expect(pls.Comment).To(Equal("A test playlist")) + Expect(pls.Public).To(BeTrue()) + Expect(pls.Rules).ToNot(BeNil()) + Expect(pls.Rules.Sort).To(Equal("title")) + Expect(pls.Rules.Order).To(Equal("asc")) + Expect(pls.Rules.Limit).To(Equal(50)) + Expect(pls.Rules.Expression).To(BeAssignableToTypeOf(criteria.All{})) + }) + + It("keeps existing name when NSP has no name field", func() { + nsp := `{"all": [{"is": {"loved": true}}]}` + pls := &model.Playlist{Name: "Original Name"} + err := s.parseNSP(ctx, pls, strings.NewReader(nsp)) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Name).To(Equal("Original Name")) + }) + + It("keeps existing comment when NSP has no comment field", func() { + nsp := `{"all": [{"is": {"loved": true}}]}` + pls := &model.Playlist{Comment: "Original Comment"} + err := s.parseNSP(ctx, pls, strings.NewReader(nsp)) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Comment).To(Equal("Original Comment")) + }) + + It("strips JSON comments before parsing", func() { + nsp := `{ + // Line comment + "name": "Commented Playlist", + /* Block comment */ + "all": [{"is": {"loved": true}}] + }` + pls := &model.Playlist{} + err := s.parseNSP(ctx, pls, strings.NewReader(nsp)) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Name).To(Equal("Commented Playlist")) + }) + + It("uses server default when public field is absent", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.DefaultPlaylistPublicVisibility = true + + nsp := `{"all": [{"is": {"loved": true}}]}` + pls := &model.Playlist{} + err := s.parseNSP(ctx, pls, strings.NewReader(nsp)) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Public).To(BeTrue()) + }) + + It("honors explicit public: false over server default", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.DefaultPlaylistPublicVisibility = true + + nsp := `{"public": false, "all": [{"is": {"loved": true}}]}` + pls := &model.Playlist{} + err := s.parseNSP(ctx, pls, strings.NewReader(nsp)) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Public).To(BeFalse()) + }) + + It("returns a syntax error with line and column info", func() { + nsp := "{\n \"name\": \"Bad\",\n \"all\": [INVALID]\n}" + pls := &model.Playlist{} + err := s.parseNSP(ctx, pls, strings.NewReader(nsp)) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("JSON syntax error in SmartPlaylist")) + Expect(err.Error()).To(MatchRegexp(`line \d+, column \d+`)) + }) + + It("returns a parsing error for completely invalid JSON", func() { + nsp := `not json at all` + pls := &model.Playlist{} + err := s.parseNSP(ctx, pls, strings.NewReader(nsp)) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("SmartPlaylist")) + }) + + It("gracefully handles non-string name field", func() { + nsp := `{"name": 123, "all": [{"is": {"loved": true}}]}` + pls := &model.Playlist{Name: "Original"} + err := s.parseNSP(ctx, pls, strings.NewReader(nsp)) + Expect(err).ToNot(HaveOccurred()) + // Type assertion in UnmarshalJSON fails silently; name stays as original + Expect(pls.Name).To(Equal("Original")) + }) + + It("parses limitPercent from NSP", func() { + nsp := `{ + "all": [{"is": {"loved": true}}], + "sort": "playCount", + "order": "desc", + "limitPercent": 25 + }` + pls := &model.Playlist{} + err := s.parseNSP(ctx, pls, strings.NewReader(nsp)) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Rules).ToNot(BeNil()) + Expect(pls.Rules.LimitPercent).To(Equal(25)) + Expect(pls.Rules.Limit).To(Equal(0)) + }) + + It("parses criteria with multiple rules", func() { + nsp := `{ + "all": [ + {"is": {"loved": true}}, + {"contains": {"title": "rock"}} + ], + "sort": "lastPlayed", + "order": "desc", + "limit": 100 + }` + pls := &model.Playlist{} + err := s.parseNSP(ctx, pls, strings.NewReader(nsp)) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Rules).ToNot(BeNil()) + Expect(pls.Rules.Sort).To(Equal("lastPlayed")) + Expect(pls.Rules.Order).To(Equal("desc")) + Expect(pls.Rules.Limit).To(Equal(100)) + }) +}) + +var _ = Describe("getPositionFromOffset", func() { + It("returns correct position on first line", func() { + data := []byte("hello world") + line, col := getPositionFromOffset(data, 5) + Expect(line).To(Equal(1)) + Expect(col).To(Equal(5)) + }) + + It("returns correct position after newlines", func() { + data := []byte("line1\nline2\nline3") + // Offsets: l(0) i(1) n(2) e(3) 1(4) \n(5) l(6) i(7) n(8) + line, col := getPositionFromOffset(data, 8) + Expect(line).To(Equal(2)) + Expect(col).To(Equal(3)) + }) + + It("returns correct position at start of new line", func() { + data := []byte("line1\nline2") + // After \n at offset 5, col resets to 1; offset 6 is 'l' -> col=1 + line, col := getPositionFromOffset(data, 6) + Expect(line).To(Equal(2)) + Expect(col).To(Equal(1)) + }) + + It("handles multiple newlines", func() { + data := []byte("a\nb\nc\nd") + // a(0) \n(1) b(2) \n(3) c(4) \n(5) d(6) + line, col := getPositionFromOffset(data, 6) + Expect(line).To(Equal(4)) + Expect(col).To(Equal(1)) + }) +}) + +var _ = Describe("newSyncedPlaylist", func() { + var s *playlists + + BeforeEach(func() { + s = &playlists{} + }) + + It("creates a synced playlist with correct attributes", func() { + tmpDir := GinkgoT().TempDir() + Expect(os.WriteFile(filepath.Join(tmpDir, "test.m3u"), []byte("content"), 0600)).To(Succeed()) + + pls, err := s.newSyncedPlaylist(tmpDir, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Name).To(Equal("test")) + Expect(pls.Comment).To(Equal("Auto-imported from 'test.m3u'")) + Expect(pls.Public).To(BeFalse()) + Expect(pls.Path).To(Equal(filepath.Join(tmpDir, "test.m3u"))) + Expect(pls.Sync).To(BeTrue()) + Expect(pls.UpdatedAt).ToNot(BeZero()) + }) + + It("strips extension from filename to derive name", func() { + tmpDir := GinkgoT().TempDir() + Expect(os.WriteFile(filepath.Join(tmpDir, "My Favorites.nsp"), []byte("{}"), 0600)).To(Succeed()) + + pls, err := s.newSyncedPlaylist(tmpDir, "My Favorites.nsp") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Name).To(Equal("My Favorites")) + }) + + It("returns error for non-existent file", func() { + tmpDir := GinkgoT().TempDir() + _, err := s.newSyncedPlaylist(tmpDir, "nonexistent.m3u") + Expect(err).To(HaveOccurred()) + }) +}) diff --git a/core/playlists/playlists.go b/core/playlists/playlists.go new file mode 100644 index 000000000..a0086cd2d --- /dev/null +++ b/core/playlists/playlists.go @@ -0,0 +1,321 @@ +package playlists + +import ( + "context" + "io" + "os" + "path/filepath" + "strconv" + "strings" + + "github.com/bmatcuk/doublestar/v4" + "github.com/deluan/rest" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" +) + +type Playlists interface { + // Reads + GetAll(ctx context.Context, options ...model.QueryOptions) (model.Playlists, error) + Get(ctx context.Context, id string) (*model.Playlist, error) + GetWithTracks(ctx context.Context, id string) (*model.Playlist, error) + GetPlaylists(ctx context.Context, mediaFileId string) (model.Playlists, error) + + // Mutations + Create(ctx context.Context, playlistId string, name string, ids []string) (string, error) + Delete(ctx context.Context, id string) error + Update(ctx context.Context, playlistID string, name *string, comment *string, public *bool, idsToAdd []string, idxToRemove []int) error + + // Track management + AddTracks(ctx context.Context, playlistID string, ids []string) (int, error) + AddAlbums(ctx context.Context, playlistID string, albumIds []string) (int, error) + AddArtists(ctx context.Context, playlistID string, artistIds []string) (int, error) + AddDiscs(ctx context.Context, playlistID string, discs []model.DiscID) (int, error) + RemoveTracks(ctx context.Context, playlistID string, trackIds []string) error + ReorderTrack(ctx context.Context, playlistID string, pos int, newPos int) error + + // Cover art + SetImage(ctx context.Context, playlistID string, reader io.Reader, ext string) error + RemoveImage(ctx context.Context, playlistID string) error + + // Import + ImportFile(ctx context.Context, folder *model.Folder, filename string) (*model.Playlist, error) + ImportM3U(ctx context.Context, reader io.Reader) (*model.Playlist, error) + + // REST adapters (follows Share/Library pattern) + NewRepository(ctx context.Context) rest.Repository + TracksRepository(ctx context.Context, playlistId string, refreshSmartPlaylist bool) rest.Repository +} + +// ImageUploadService is a local interface satisfied by core.ImageUploadService. +// Defined here to avoid an import cycle between core and core/playlists. +type ImageUploadService interface { + SetImage(ctx context.Context, entityType string, entityID string, name string, oldPath string, reader io.Reader, ext string) (filename string, err error) + RemoveImage(ctx context.Context, path string) error +} + +type playlists struct { + ds model.DataStore + imgUpload ImageUploadService +} + +func NewPlaylists(ds model.DataStore, imgUpload ImageUploadService) Playlists { + return &playlists{ds: ds, imgUpload: imgUpload} +} + +func InPath(folder model.Folder) bool { + if conf.Server.PlaylistsPath == "" { + return true + } + rel, _ := filepath.Rel(folder.LibraryPath, folder.AbsolutePath()) + for path := range strings.SplitSeq(conf.Server.PlaylistsPath, string(filepath.ListSeparator)) { + if match, _ := doublestar.Match(path, rel); match { + return true + } + } + return false +} + +// --- Read operations --- + +func (s *playlists) GetAll(ctx context.Context, options ...model.QueryOptions) (model.Playlists, error) { + return s.ds.Playlist(ctx).GetAll(options...) +} + +func (s *playlists) Get(ctx context.Context, id string) (*model.Playlist, error) { + return s.ds.Playlist(ctx).Get(id) +} + +func (s *playlists) GetWithTracks(ctx context.Context, id string) (*model.Playlist, error) { + return s.ds.Playlist(ctx).GetWithTracks(id, true, false) +} + +func (s *playlists) GetPlaylists(ctx context.Context, mediaFileId string) (model.Playlists, error) { + return s.ds.Playlist(ctx).GetPlaylists(mediaFileId) +} + +// --- Mutation operations --- + +// Create creates a new playlist (when name is provided) or replaces tracks on an existing +// playlist (when playlistId is provided). This matches the Subsonic createPlaylist semantics. +func (s *playlists) Create(ctx context.Context, playlistId string, name string, ids []string) (string, error) { + usr, _ := request.UserFrom(ctx) + err := s.ds.WithTxImmediate(func(tx model.DataStore) error { + var pls *model.Playlist + var err error + + if playlistId != "" { + pls, err = tx.Playlist(ctx).Get(playlistId) + if err != nil { + return err + } + if pls.IsSmartPlaylist() { + return model.ErrNotAuthorized + } + if !usr.IsAdmin && pls.OwnerID != usr.ID { + return model.ErrNotAuthorized + } + } else { + pls = &model.Playlist{Name: name} + pls.OwnerID = usr.ID + } + pls.Tracks = nil + pls.AddMediaFilesByID(ids) + + err = tx.Playlist(ctx).Put(pls) + playlistId = pls.ID + return err + }) + return playlistId, err +} + +func (s *playlists) Delete(ctx context.Context, id string) error { + pls, err := s.checkWritable(ctx, id) + if err != nil { + return err + } + + // Clean up custom cover image file if one exists + if path := pls.UploadedImagePath(); path != "" { + if err := os.Remove(path); err != nil && !os.IsNotExist(err) { + log.Warn(ctx, "Failed to remove playlist image on delete", "path", path, err) + } + } + + return s.ds.Playlist(ctx).Delete(id) +} + +func (s *playlists) Update(ctx context.Context, playlistID string, + name *string, comment *string, public *bool, + idsToAdd []string, idxToRemove []int) error { + var pls *model.Playlist + var err error + hasTrackChanges := len(idsToAdd) > 0 || len(idxToRemove) > 0 + if hasTrackChanges { + pls, err = s.checkTracksEditable(ctx, playlistID) + } else { + pls, err = s.checkWritable(ctx, playlistID) + } + if err != nil { + return err + } + return s.ds.WithTxImmediate(func(tx model.DataStore) error { + repo := tx.Playlist(ctx) + + if len(idxToRemove) > 0 { + tracksRepo := repo.Tracks(playlistID, false) + // Convert 0-based indices to 1-based position IDs and delete them directly, + // avoiding the need to load all tracks into memory. + positions := make([]string, len(idxToRemove)) + for i, idx := range idxToRemove { + positions[i] = strconv.Itoa(idx + 1) + } + if err := tracksRepo.Delete(positions...); err != nil { + return err + } + if len(idsToAdd) > 0 { + if _, err := tracksRepo.Add(idsToAdd); err != nil { + return err + } + } + return s.updateMetadata(ctx, tx, pls, name, comment, public) + } + + if len(idsToAdd) > 0 { + if _, err := repo.Tracks(playlistID, false).Add(idsToAdd); err != nil { + return err + } + } + if name == nil && comment == nil && public == nil { + return nil + } + // Reuse the playlist from checkWritable (no tracks loaded, so Put only refreshes counters) + return s.updateMetadata(ctx, tx, pls, name, comment, public) + }) +} + +// --- Permission helpers --- + +// checkWritable fetches the playlist and verifies the current user can modify it. +func (s *playlists) checkWritable(ctx context.Context, id string) (*model.Playlist, error) { + pls, err := s.ds.Playlist(ctx).Get(id) + if err != nil { + return nil, err + } + usr, _ := request.UserFrom(ctx) + if !usr.IsAdmin && pls.OwnerID != usr.ID { + return nil, model.ErrNotAuthorized + } + return pls, nil +} + +// checkTracksEditable verifies the user can modify tracks (ownership + not smart playlist). +func (s *playlists) checkTracksEditable(ctx context.Context, playlistID string) (*model.Playlist, error) { + pls, err := s.checkWritable(ctx, playlistID) + if err != nil { + return nil, err + } + if pls.IsSmartPlaylist() { + return nil, model.ErrNotAuthorized + } + return pls, nil +} + +// updateMetadata applies optional metadata changes to a playlist and persists it. +// Accepts a DataStore parameter so it can be used inside transactions. +// The caller is responsible for permission checks. +func (s *playlists) updateMetadata(ctx context.Context, ds model.DataStore, pls *model.Playlist, name *string, comment *string, public *bool) error { + if name != nil { + pls.Name = *name + } + if comment != nil { + pls.Comment = *comment + } + if public != nil { + pls.Public = *public + } + return ds.Playlist(ctx).Put(pls) +} + +// --- Track management operations --- + +func (s *playlists) AddTracks(ctx context.Context, playlistID string, ids []string) (int, error) { + if _, err := s.checkTracksEditable(ctx, playlistID); err != nil { + return 0, err + } + return s.ds.Playlist(ctx).Tracks(playlistID, false).Add(ids) +} + +func (s *playlists) AddAlbums(ctx context.Context, playlistID string, albumIds []string) (int, error) { + if _, err := s.checkTracksEditable(ctx, playlistID); err != nil { + return 0, err + } + return s.ds.Playlist(ctx).Tracks(playlistID, false).AddAlbums(albumIds) +} + +func (s *playlists) AddArtists(ctx context.Context, playlistID string, artistIds []string) (int, error) { + if _, err := s.checkTracksEditable(ctx, playlistID); err != nil { + return 0, err + } + return s.ds.Playlist(ctx).Tracks(playlistID, false).AddArtists(artistIds) +} + +func (s *playlists) AddDiscs(ctx context.Context, playlistID string, discs []model.DiscID) (int, error) { + if _, err := s.checkTracksEditable(ctx, playlistID); err != nil { + return 0, err + } + return s.ds.Playlist(ctx).Tracks(playlistID, false).AddDiscs(discs) +} + +func (s *playlists) RemoveTracks(ctx context.Context, playlistID string, trackIds []string) error { + if _, err := s.checkTracksEditable(ctx, playlistID); err != nil { + return err + } + return s.ds.WithTx(func(tx model.DataStore) error { + return tx.Playlist(ctx).Tracks(playlistID, false).Delete(trackIds...) + }) +} + +func (s *playlists) ReorderTrack(ctx context.Context, playlistID string, pos int, newPos int) error { + if _, err := s.checkTracksEditable(ctx, playlistID); err != nil { + return err + } + return s.ds.WithTx(func(tx model.DataStore) error { + return tx.Playlist(ctx).Tracks(playlistID, false).Reorder(pos, newPos) + }) +} + +// --- Cover art operations --- + +func (s *playlists) SetImage(ctx context.Context, playlistID string, reader io.Reader, ext string) error { + pls, err := s.checkWritable(ctx, playlistID) + if err != nil { + return err + } + + oldPath := pls.UploadedImagePath() + filename, err := s.imgUpload.SetImage(ctx, consts.EntityPlaylist, pls.ID, pls.Name, oldPath, reader, ext) + if err != nil { + return err + } + + pls.UploadedImage = filename + return s.ds.Playlist(ctx).Put(pls) +} + +func (s *playlists) RemoveImage(ctx context.Context, playlistID string) error { + pls, err := s.checkWritable(ctx, playlistID) + if err != nil { + return err + } + + if err := s.imgUpload.RemoveImage(ctx, pls.UploadedImagePath()); err != nil { + return err + } + + pls.UploadedImage = "" + return s.ds.Playlist(ctx).Put(pls) +} diff --git a/core/playlists/playlists_suite_test.go b/core/playlists/playlists_suite_test.go new file mode 100644 index 000000000..b57248490 --- /dev/null +++ b/core/playlists/playlists_suite_test.go @@ -0,0 +1,17 @@ +package playlists_test + +import ( + "testing" + + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestPlaylists(t *testing.T) { + tests.Init(t, false) + log.SetLevel(log.LevelFatal) + RegisterFailHandler(Fail) + RunSpecs(t, "Playlists Suite") +} diff --git a/core/playlists/playlists_test.go b/core/playlists/playlists_test.go new file mode 100644 index 000000000..52d5c88d8 --- /dev/null +++ b/core/playlists/playlists_test.go @@ -0,0 +1,418 @@ +package playlists_test + +import ( + "context" + "os" + "path/filepath" + "strings" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/core" + "github.com/navidrome/navidrome/core/playlists" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/criteria" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Playlists", func() { + var ds *tests.MockDataStore + var ps playlists.Playlists + var mockPlsRepo *tests.MockPlaylistRepo + ctx := context.Background() + + BeforeEach(func() { + mockPlsRepo = tests.CreateMockPlaylistRepo() + ds = &tests.MockDataStore{ + MockedPlaylist: mockPlsRepo, + MockedLibrary: &tests.MockLibraryRepo{}, + } + ctx = request.WithUser(ctx, model.User{ID: "123"}) + }) + + Describe("Delete", func() { + var mockTracks *tests.MockPlaylistTrackRepo + + BeforeEach(func() { + mockTracks = &tests.MockPlaylistTrackRepo{AddCount: 3} + mockPlsRepo.Data = map[string]*model.Playlist{ + "pls-1": {ID: "pls-1", Name: "My Playlist", OwnerID: "user-1"}, + } + mockPlsRepo.TracksRepo = mockTracks + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + }) + + It("allows owner to delete their playlist", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + err := ps.Delete(ctx, "pls-1") + Expect(err).ToNot(HaveOccurred()) + Expect(mockPlsRepo.Deleted).To(ContainElement("pls-1")) + }) + + It("allows admin to delete any playlist", func() { + ctx = request.WithUser(ctx, model.User{ID: "admin-1", IsAdmin: true}) + err := ps.Delete(ctx, "pls-1") + Expect(err).ToNot(HaveOccurred()) + Expect(mockPlsRepo.Deleted).To(ContainElement("pls-1")) + }) + + It("denies non-owner, non-admin from deleting", func() { + ctx = request.WithUser(ctx, model.User{ID: "other-user", IsAdmin: false}) + err := ps.Delete(ctx, "pls-1") + Expect(err).To(MatchError(model.ErrNotAuthorized)) + Expect(mockPlsRepo.Deleted).To(BeEmpty()) + }) + + It("returns error when playlist not found", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + err := ps.Delete(ctx, "nonexistent") + Expect(err).To(Equal(model.ErrNotFound)) + }) + }) + + Describe("Create", func() { + BeforeEach(func() { + mockPlsRepo.Data = map[string]*model.Playlist{ + "pls-1": {ID: "pls-1", Name: "Existing", OwnerID: "user-1"}, + "pls-2": {ID: "pls-2", Name: "Other's", OwnerID: "other-user"}, + "pls-smart": {ID: "pls-smart", Name: "Smart", OwnerID: "user-1", + Rules: &criteria.Criteria{Expression: criteria.Contains{"title": "test"}}}, + } + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + }) + + It("creates a new playlist with owner set from context", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + id, err := ps.Create(ctx, "", "New Playlist", []string{"song-1", "song-2"}) + Expect(err).ToNot(HaveOccurred()) + Expect(id).ToNot(BeEmpty()) + Expect(mockPlsRepo.Last.Name).To(Equal("New Playlist")) + Expect(mockPlsRepo.Last.OwnerID).To(Equal("user-1")) + }) + + It("replaces tracks on existing playlist when owner matches", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + id, err := ps.Create(ctx, "pls-1", "", []string{"song-3"}) + Expect(err).ToNot(HaveOccurred()) + Expect(id).To(Equal("pls-1")) + Expect(mockPlsRepo.Last.Tracks).To(HaveLen(1)) + }) + + It("allows admin to replace tracks on any playlist", func() { + ctx = request.WithUser(ctx, model.User{ID: "admin-1", IsAdmin: true}) + id, err := ps.Create(ctx, "pls-2", "", []string{"song-3"}) + Expect(err).ToNot(HaveOccurred()) + Expect(id).To(Equal("pls-2")) + }) + + It("denies non-owner, non-admin from replacing tracks on existing playlist", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + _, err := ps.Create(ctx, "pls-2", "", []string{"song-3"}) + Expect(err).To(MatchError(model.ErrNotAuthorized)) + }) + + It("returns error when existing playlistId not found", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + _, err := ps.Create(ctx, "nonexistent", "", []string{"song-1"}) + Expect(err).To(Equal(model.ErrNotFound)) + }) + + It("denies replacing tracks on a smart playlist", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + _, err := ps.Create(ctx, "pls-smart", "", []string{"song-1"}) + Expect(err).To(MatchError(model.ErrNotAuthorized)) + }) + }) + + Describe("Update", func() { + var mockTracks *tests.MockPlaylistTrackRepo + + BeforeEach(func() { + mockTracks = &tests.MockPlaylistTrackRepo{AddCount: 2} + mockPlsRepo.Data = map[string]*model.Playlist{ + "pls-1": {ID: "pls-1", Name: "My Playlist", OwnerID: "user-1"}, + "pls-other": {ID: "pls-other", Name: "Other's", OwnerID: "other-user"}, + "pls-smart": {ID: "pls-smart", Name: "Smart", OwnerID: "user-1", + Rules: &criteria.Criteria{Expression: criteria.Contains{"title": "test"}}}, + } + mockPlsRepo.TracksRepo = mockTracks + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + }) + + It("allows owner to update their playlist", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + newName := "Updated Name" + err := ps.Update(ctx, "pls-1", &newName, nil, nil, nil, nil) + Expect(err).ToNot(HaveOccurred()) + }) + + It("allows admin to update any playlist", func() { + ctx = request.WithUser(ctx, model.User{ID: "admin-1", IsAdmin: true}) + newName := "Updated Name" + err := ps.Update(ctx, "pls-other", &newName, nil, nil, nil, nil) + Expect(err).ToNot(HaveOccurred()) + }) + + It("denies non-owner, non-admin from updating", func() { + ctx = request.WithUser(ctx, model.User{ID: "other-user", IsAdmin: false}) + newName := "Updated Name" + err := ps.Update(ctx, "pls-1", &newName, nil, nil, nil, nil) + Expect(err).To(MatchError(model.ErrNotAuthorized)) + }) + + It("returns error when playlist not found", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + newName := "Updated Name" + err := ps.Update(ctx, "nonexistent", &newName, nil, nil, nil, nil) + Expect(err).To(Equal(model.ErrNotFound)) + }) + + It("denies adding tracks to a smart playlist", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + err := ps.Update(ctx, "pls-smart", nil, nil, nil, []string{"song-1"}, nil) + Expect(err).To(MatchError(model.ErrNotAuthorized)) + }) + + It("denies removing tracks from a smart playlist", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + err := ps.Update(ctx, "pls-smart", nil, nil, nil, nil, []int{0}) + Expect(err).To(MatchError(model.ErrNotAuthorized)) + }) + + It("allows metadata updates on a smart playlist", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + newName := "Updated Smart" + err := ps.Update(ctx, "pls-smart", &newName, nil, nil, nil, nil) + Expect(err).ToNot(HaveOccurred()) + }) + }) + + Describe("AddTracks", func() { + var mockTracks *tests.MockPlaylistTrackRepo + + BeforeEach(func() { + mockTracks = &tests.MockPlaylistTrackRepo{AddCount: 2} + mockPlsRepo.Data = map[string]*model.Playlist{ + "pls-1": {ID: "pls-1", Name: "My Playlist", OwnerID: "user-1"}, + "pls-smart": {ID: "pls-smart", Name: "Smart", OwnerID: "user-1", + Rules: &criteria.Criteria{Expression: criteria.Contains{"title": "test"}}}, + "pls-other": {ID: "pls-other", Name: "Other's", OwnerID: "other-user"}, + } + mockPlsRepo.TracksRepo = mockTracks + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + }) + + It("allows owner to add tracks", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + count, err := ps.AddTracks(ctx, "pls-1", []string{"song-1", "song-2"}) + Expect(err).ToNot(HaveOccurred()) + Expect(count).To(Equal(2)) + Expect(mockTracks.AddedIds).To(ConsistOf("song-1", "song-2")) + }) + + It("allows admin to add tracks to any playlist", func() { + ctx = request.WithUser(ctx, model.User{ID: "admin-1", IsAdmin: true}) + count, err := ps.AddTracks(ctx, "pls-other", []string{"song-1"}) + Expect(err).ToNot(HaveOccurred()) + Expect(count).To(Equal(2)) + }) + + It("denies non-owner, non-admin", func() { + ctx = request.WithUser(ctx, model.User{ID: "other-user", IsAdmin: false}) + _, err := ps.AddTracks(ctx, "pls-1", []string{"song-1"}) + Expect(err).To(MatchError(model.ErrNotAuthorized)) + }) + + It("denies editing smart playlists", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + _, err := ps.AddTracks(ctx, "pls-smart", []string{"song-1"}) + Expect(err).To(MatchError(model.ErrNotAuthorized)) + }) + + It("returns error when playlist not found", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + _, err := ps.AddTracks(ctx, "nonexistent", []string{"song-1"}) + Expect(err).To(Equal(model.ErrNotFound)) + }) + }) + + Describe("RemoveTracks", func() { + var mockTracks *tests.MockPlaylistTrackRepo + + BeforeEach(func() { + mockTracks = &tests.MockPlaylistTrackRepo{} + mockPlsRepo.Data = map[string]*model.Playlist{ + "pls-1": {ID: "pls-1", Name: "My Playlist", OwnerID: "user-1"}, + "pls-smart": {ID: "pls-smart", Name: "Smart", OwnerID: "user-1", + Rules: &criteria.Criteria{Expression: criteria.Contains{"title": "test"}}}, + } + mockPlsRepo.TracksRepo = mockTracks + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + }) + + It("allows owner to remove tracks", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + err := ps.RemoveTracks(ctx, "pls-1", []string{"track-1", "track-2"}) + Expect(err).ToNot(HaveOccurred()) + Expect(mockTracks.DeletedIds).To(ConsistOf("track-1", "track-2")) + }) + + It("denies on smart playlist", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + err := ps.RemoveTracks(ctx, "pls-smart", []string{"track-1"}) + Expect(err).To(MatchError(model.ErrNotAuthorized)) + }) + + It("denies non-owner", func() { + ctx = request.WithUser(ctx, model.User{ID: "other-user", IsAdmin: false}) + err := ps.RemoveTracks(ctx, "pls-1", []string{"track-1"}) + Expect(err).To(MatchError(model.ErrNotAuthorized)) + }) + }) + + Describe("ReorderTrack", func() { + var mockTracks *tests.MockPlaylistTrackRepo + + BeforeEach(func() { + mockTracks = &tests.MockPlaylistTrackRepo{} + mockPlsRepo.Data = map[string]*model.Playlist{ + "pls-1": {ID: "pls-1", Name: "My Playlist", OwnerID: "user-1"}, + "pls-smart": {ID: "pls-smart", Name: "Smart", OwnerID: "user-1", + Rules: &criteria.Criteria{Expression: criteria.Contains{"title": "test"}}}, + } + mockPlsRepo.TracksRepo = mockTracks + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + }) + + It("allows owner to reorder", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + err := ps.ReorderTrack(ctx, "pls-1", 1, 3) + Expect(err).ToNot(HaveOccurred()) + Expect(mockTracks.Reordered).To(BeTrue()) + }) + + It("denies on smart playlist", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + err := ps.ReorderTrack(ctx, "pls-smart", 1, 3) + Expect(err).To(MatchError(model.ErrNotAuthorized)) + }) + }) + + Describe("SetImage", func() { + var tmpDir string + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + tmpDir = GinkgoT().TempDir() + conf.Server.DataFolder = tmpDir + + mockPlsRepo.Data = map[string]*model.Playlist{ + "pls-1": {ID: "pls-1", Name: "My Playlist", OwnerID: "user-1"}, + "pls-other": {ID: "pls-other", Name: "Other's", OwnerID: "other-user"}, + } + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + }) + + It("saves image file and updates UploadedImage", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + reader := strings.NewReader("fake image data") + err := ps.SetImage(ctx, "pls-1", reader, ".jpg") + Expect(err).ToNot(HaveOccurred()) + + Expect(mockPlsRepo.Last.UploadedImage).To(Equal("pls-1_my_playlist.jpg")) + absPath := filepath.Join(tmpDir, "artwork", "playlist", "pls-1_my_playlist.jpg") + data, err := os.ReadFile(absPath) + Expect(err).ToNot(HaveOccurred()) + Expect(string(data)).To(Equal("fake image data")) + }) + + It("removes old image when replacing", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + + // Upload first image + err := ps.SetImage(ctx, "pls-1", strings.NewReader("first"), ".png") + Expect(err).ToNot(HaveOccurred()) + oldPath := filepath.Join(tmpDir, "artwork", "playlist", "pls-1_my_playlist.png") + Expect(oldPath).To(BeAnExistingFile()) + + // Upload replacement image + err = ps.SetImage(ctx, "pls-1", strings.NewReader("second"), ".jpg") + Expect(err).ToNot(HaveOccurred()) + Expect(oldPath).ToNot(BeAnExistingFile()) + newPath := filepath.Join(tmpDir, "artwork", "playlist", "pls-1_my_playlist.jpg") + Expect(newPath).To(BeAnExistingFile()) + }) + + It("allows admin to set image on any playlist", func() { + ctx = request.WithUser(ctx, model.User{ID: "admin-1", IsAdmin: true}) + err := ps.SetImage(ctx, "pls-other", strings.NewReader("data"), ".jpg") + Expect(err).ToNot(HaveOccurred()) + }) + + It("denies non-owner", func() { + ctx = request.WithUser(ctx, model.User{ID: "other-user", IsAdmin: false}) + err := ps.SetImage(ctx, "pls-1", strings.NewReader("data"), ".jpg") + Expect(err).To(MatchError(model.ErrNotAuthorized)) + }) + + It("returns error when playlist not found", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + err := ps.SetImage(ctx, "nonexistent", strings.NewReader("data"), ".jpg") + Expect(err).To(Equal(model.ErrNotFound)) + }) + }) + + Describe("RemoveImage", func() { + var tmpDir string + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + tmpDir = GinkgoT().TempDir() + conf.Server.DataFolder = tmpDir + + // Create a real image file on disk + imgDir := filepath.Join(tmpDir, "artwork", "playlist") + Expect(os.MkdirAll(imgDir, 0755)).To(Succeed()) + Expect(os.WriteFile(filepath.Join(imgDir, "pls-1.jpg"), []byte("img data"), 0600)).To(Succeed()) + + mockPlsRepo.Data = map[string]*model.Playlist{ + "pls-1": {ID: "pls-1", Name: "My Playlist", OwnerID: "user-1", UploadedImage: "pls-1.jpg"}, + "pls-empty": {ID: "pls-empty", Name: "No Cover", OwnerID: "user-1"}, + "pls-other": {ID: "pls-other", Name: "Other's", OwnerID: "other-user"}, + } + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + }) + + It("removes file and clears UploadedImage", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + err := ps.RemoveImage(ctx, "pls-1") + Expect(err).ToNot(HaveOccurred()) + + Expect(mockPlsRepo.Last.UploadedImage).To(BeEmpty()) + absPath := filepath.Join(tmpDir, "artwork", "playlist", "pls-1.jpg") + Expect(absPath).ToNot(BeAnExistingFile()) + }) + + It("succeeds even if playlist has no image", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + err := ps.RemoveImage(ctx, "pls-empty") + Expect(err).ToNot(HaveOccurred()) + Expect(mockPlsRepo.Last.UploadedImage).To(BeEmpty()) + }) + + It("denies non-owner", func() { + ctx = request.WithUser(ctx, model.User{ID: "other-user", IsAdmin: false}) + err := ps.RemoveImage(ctx, "pls-1") + Expect(err).To(MatchError(model.ErrNotAuthorized)) + }) + + It("returns error when playlist not found", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + err := ps.RemoveImage(ctx, "nonexistent") + Expect(err).To(Equal(model.ErrNotFound)) + }) + }) +}) diff --git a/core/playlists/rest_adapter.go b/core/playlists/rest_adapter.go new file mode 100644 index 000000000..3fecda0d5 --- /dev/null +++ b/core/playlists/rest_adapter.go @@ -0,0 +1,103 @@ +package playlists + +import ( + "context" + "errors" + + "github.com/deluan/rest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" +) + +// --- REST adapter (follows Share/Library pattern) --- + +func (s *playlists) NewRepository(ctx context.Context) rest.Repository { + return &playlistRepositoryWrapper{ + ctx: ctx, + PlaylistRepository: s.ds.Playlist(ctx), + service: s, + } +} + +// playlistRepositoryWrapper wraps the playlist repository as a thin REST-to-service adapter. +// It satisfies rest.Repository through the embedded PlaylistRepository (via ResourceRepository), +// and rest.Persistable by delegating to service methods for all mutations. +type playlistRepositoryWrapper struct { + model.PlaylistRepository + ctx context.Context + service *playlists +} + +func (r *playlistRepositoryWrapper) Save(entity any) (string, error) { + return r.service.savePlaylist(r.ctx, entity.(*model.Playlist)) +} + +func (r *playlistRepositoryWrapper) Update(id string, entity any, cols ...string) error { + return r.service.updatePlaylistEntity(r.ctx, id, entity.(*model.Playlist), cols...) +} + +func (r *playlistRepositoryWrapper) Delete(id string) error { + err := r.service.Delete(r.ctx, id) + switch { + case errors.Is(err, model.ErrNotFound): + return rest.ErrNotFound + case errors.Is(err, model.ErrNotAuthorized): + return rest.ErrPermissionDenied + default: + return err + } +} + +func (s *playlists) TracksRepository(ctx context.Context, playlistId string, refreshSmartPlaylist bool) rest.Repository { + repo := s.ds.Playlist(ctx) + tracks := repo.Tracks(playlistId, refreshSmartPlaylist) + if tracks == nil { + return nil + } + return tracks.(rest.Repository) +} + +// savePlaylist creates a new playlist, assigning the owner from context. +// Only Name, Comment, Public, and Rules are user-settable via the REST API. +func (s *playlists) savePlaylist(ctx context.Context, pls *model.Playlist) (string, error) { + usr, _ := request.UserFrom(ctx) + pls.OwnerID = usr.ID + pls.ID = "" // Force new creation + pls.Path = "" // Server-managed (M3U file path) + pls.Sync = false // Server-managed (M3U sync flag) + pls.UploadedImage = "" // Managed by image upload endpoint + pls.ExternalImageURL = "" // Managed by M3U import / plugins only + pls.EvaluatedAt = nil // Server-managed + err := s.ds.Playlist(ctx).Put(pls) + if err != nil { + return "", err + } + return pls.ID, nil +} + +// updatePlaylistEntity updates playlist metadata with permission checks. +// Used by the REST API wrapper. +func (s *playlists) updatePlaylistEntity(ctx context.Context, id string, entity *model.Playlist, cols ...string) error { + current, err := s.checkWritable(ctx, id) + if err != nil { + switch { + case errors.Is(err, model.ErrNotFound): + return rest.ErrNotFound + case errors.Is(err, model.ErrNotAuthorized): + return rest.ErrPermissionDenied + default: + return err + } + } + usr, _ := request.UserFrom(ctx) + if !usr.IsAdmin && entity.OwnerID != "" && entity.OwnerID != current.OwnerID { + return rest.ErrPermissionDenied + } + // Apply ownership change (admin only) + if entity.OwnerID != "" { + current.OwnerID = entity.OwnerID + } + // Apply smart playlist rules update + current.Rules = entity.Rules + return s.updateMetadata(ctx, s.ds, current, &entity.Name, &entity.Comment, &entity.Public) +} diff --git a/core/playlists/rest_adapter_test.go b/core/playlists/rest_adapter_test.go new file mode 100644 index 000000000..097bc6310 --- /dev/null +++ b/core/playlists/rest_adapter_test.go @@ -0,0 +1,171 @@ +package playlists_test + +import ( + "context" + "time" + + "github.com/deluan/rest" + "github.com/navidrome/navidrome/core" + "github.com/navidrome/navidrome/core/playlists" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/criteria" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("REST Adapter", func() { + var ds *tests.MockDataStore + var ps playlists.Playlists + var mockPlsRepo *tests.MockPlaylistRepo + ctx := context.Background() + + BeforeEach(func() { + mockPlsRepo = tests.CreateMockPlaylistRepo() + ds = &tests.MockDataStore{ + MockedPlaylist: mockPlsRepo, + MockedLibrary: &tests.MockLibraryRepo{}, + } + ctx = request.WithUser(ctx, model.User{ID: "123"}) + }) + + Describe("NewRepository", func() { + var repo rest.Persistable + + BeforeEach(func() { + mockPlsRepo.Data = map[string]*model.Playlist{ + "pls-1": {ID: "pls-1", Name: "My Playlist", OwnerID: "user-1"}, + } + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + }) + + Describe("Save", func() { + It("sets the owner from the context user", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + repo = ps.NewRepository(ctx).(rest.Persistable) + pls := &model.Playlist{Name: "New Playlist"} + id, err := repo.Save(pls) + Expect(err).ToNot(HaveOccurred()) + Expect(id).ToNot(BeEmpty()) + Expect(pls.OwnerID).To(Equal("user-1")) + }) + + It("forces a new creation by clearing ID", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + repo = ps.NewRepository(ctx).(rest.Persistable) + pls := &model.Playlist{ID: "should-be-cleared", Name: "New"} + _, err := repo.Save(pls) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.ID).ToNot(Equal("should-be-cleared")) + }) + + It("clears server-managed fields to prevent injection via REST API", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + repo = ps.NewRepository(ctx).(rest.Persistable) + now := time.Now() + pls := &model.Playlist{ + Name: "Legit Playlist", + Comment: "A comment", + Public: true, + Rules: &criteria.Criteria{Expression: criteria.Contains{"title": "test"}}, + Path: "/some/path/playlist.m3u", + Sync: true, + UploadedImage: "injected-image-path", + ExternalImageURL: "http://evil.example.com/ssrf", + EvaluatedAt: &now, + } + _, err := repo.Save(pls) + Expect(err).ToNot(HaveOccurred()) + + saved := mockPlsRepo.Last + // User-settable fields are preserved + Expect(saved.Name).To(Equal("Legit Playlist")) + Expect(saved.Comment).To(Equal("A comment")) + Expect(saved.Public).To(BeTrue()) + Expect(saved.Rules).ToNot(BeNil()) + // Server-managed fields are cleared + Expect(saved.Path).To(BeEmpty()) + Expect(saved.Sync).To(BeFalse()) + Expect(saved.UploadedImage).To(BeEmpty()) + Expect(saved.ExternalImageURL).To(BeEmpty()) + Expect(saved.EvaluatedAt).To(BeNil()) + }) + }) + + Describe("Update", func() { + It("allows owner to update their playlist", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + repo = ps.NewRepository(ctx).(rest.Persistable) + pls := &model.Playlist{Name: "Updated"} + err := repo.Update("pls-1", pls) + Expect(err).ToNot(HaveOccurred()) + }) + + It("allows admin to update any playlist", func() { + ctx = request.WithUser(ctx, model.User{ID: "admin-1", IsAdmin: true}) + repo = ps.NewRepository(ctx).(rest.Persistable) + pls := &model.Playlist{Name: "Updated"} + err := repo.Update("pls-1", pls) + Expect(err).ToNot(HaveOccurred()) + }) + + It("denies non-owner, non-admin", func() { + ctx = request.WithUser(ctx, model.User{ID: "other-user", IsAdmin: false}) + repo = ps.NewRepository(ctx).(rest.Persistable) + pls := &model.Playlist{Name: "Updated"} + err := repo.Update("pls-1", pls) + Expect(err).To(Equal(rest.ErrPermissionDenied)) + }) + + It("denies regular user from changing ownership", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + repo = ps.NewRepository(ctx).(rest.Persistable) + pls := &model.Playlist{Name: "Updated", OwnerID: "other-user"} + err := repo.Update("pls-1", pls) + Expect(err).To(Equal(rest.ErrPermissionDenied)) + }) + + It("updates smart playlist rules", func() { + mockPlsRepo.Data["smart-1"] = &model.Playlist{ + ID: "smart-1", + Name: "Smart Playlist", + OwnerID: "user-1", + Rules: &criteria.Criteria{Expression: criteria.Contains{"title": "old"}}, + } + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + repo = ps.NewRepository(ctx).(rest.Persistable) + newRules := &criteria.Criteria{Expression: criteria.Contains{"title": "new"}} + pls := &model.Playlist{Name: "Smart Playlist", Rules: newRules} + err := repo.Update("smart-1", pls) + Expect(err).ToNot(HaveOccurred()) + Expect(mockPlsRepo.Last.Rules).To(Equal(newRules)) + }) + + It("returns rest.ErrNotFound when playlist doesn't exist", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + repo = ps.NewRepository(ctx).(rest.Persistable) + pls := &model.Playlist{Name: "Updated"} + err := repo.Update("nonexistent", pls) + Expect(err).To(Equal(rest.ErrNotFound)) + }) + }) + + Describe("Delete", func() { + It("delegates to service Delete with permission checks", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + repo = ps.NewRepository(ctx).(rest.Persistable) + err := repo.Delete("pls-1") + Expect(err).ToNot(HaveOccurred()) + Expect(mockPlsRepo.Deleted).To(ContainElement("pls-1")) + }) + + It("denies non-owner", func() { + ctx = request.WithUser(ctx, model.User{ID: "other-user", IsAdmin: false}) + repo = ps.NewRepository(ctx).(rest.Persistable) + err := repo.Delete("pls-1") + Expect(err).To(Equal(rest.ErrPermissionDenied)) + }) + }) + }) +}) diff --git a/core/playlists_test.go b/core/playlists_test.go deleted file mode 100644 index 399210ac8..000000000 --- a/core/playlists_test.go +++ /dev/null @@ -1,332 +0,0 @@ -package core - -import ( - "context" - "os" - "strconv" - "strings" - "time" - - "github.com/navidrome/navidrome/conf" - "github.com/navidrome/navidrome/conf/configtest" - "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/model/criteria" - "github.com/navidrome/navidrome/model/request" - "github.com/navidrome/navidrome/tests" - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" - "golang.org/x/text/unicode/norm" -) - -var _ = Describe("Playlists", func() { - var ds *tests.MockDataStore - var ps Playlists - var mockPlsRepo mockedPlaylistRepo - var mockLibRepo *tests.MockLibraryRepo - ctx := context.Background() - - BeforeEach(func() { - mockPlsRepo = mockedPlaylistRepo{} - mockLibRepo = &tests.MockLibraryRepo{} - ds = &tests.MockDataStore{ - MockedPlaylist: &mockPlsRepo, - MockedLibrary: mockLibRepo, - } - ctx = request.WithUser(ctx, model.User{ID: "123"}) - // Path should be libPath, but we want to match the root folder referenced in the m3u, which is `/` - mockLibRepo.SetData([]model.Library{{ID: 1, Path: "/"}}) - }) - - Describe("ImportFile", func() { - var folder *model.Folder - BeforeEach(func() { - ps = NewPlaylists(ds) - ds.MockedMediaFile = &mockedMediaFileRepo{} - libPath, _ := os.Getwd() - folder = &model.Folder{ - ID: "1", - LibraryID: 1, - LibraryPath: libPath, - Path: "tests/fixtures", - Name: "playlists", - } - }) - - Describe("M3U", func() { - It("parses well-formed playlists", func() { - pls, err := ps.ImportFile(ctx, folder, "pls1.m3u") - Expect(err).ToNot(HaveOccurred()) - Expect(pls.OwnerID).To(Equal("123")) - Expect(pls.Tracks).To(HaveLen(2)) - Expect(pls.Tracks[0].Path).To(Equal("tests/fixtures/playlists/test.mp3")) - Expect(pls.Tracks[1].Path).To(Equal("tests/fixtures/playlists/test.ogg")) - Expect(mockPlsRepo.last).To(Equal(pls)) - }) - - It("parses playlists using LF ending", func() { - pls, err := ps.ImportFile(ctx, folder, "lf-ended.m3u") - Expect(err).ToNot(HaveOccurred()) - Expect(pls.Tracks).To(HaveLen(2)) - }) - - It("parses playlists using CR ending (old Mac format)", func() { - pls, err := ps.ImportFile(ctx, folder, "cr-ended.m3u") - Expect(err).ToNot(HaveOccurred()) - Expect(pls.Tracks).To(HaveLen(2)) - }) - }) - - Describe("NSP", func() { - It("parses well-formed playlists", func() { - pls, err := ps.ImportFile(ctx, folder, "recently_played.nsp") - Expect(err).ToNot(HaveOccurred()) - Expect(mockPlsRepo.last).To(Equal(pls)) - Expect(pls.OwnerID).To(Equal("123")) - Expect(pls.Name).To(Equal("Recently Played")) - Expect(pls.Comment).To(Equal("Recently played tracks")) - Expect(pls.Rules.Sort).To(Equal("lastPlayed")) - Expect(pls.Rules.Order).To(Equal("desc")) - Expect(pls.Rules.Limit).To(Equal(100)) - Expect(pls.Rules.Expression).To(BeAssignableToTypeOf(criteria.All{})) - }) - It("returns an error if the playlist is not well-formed", func() { - _, err := ps.ImportFile(ctx, folder, "invalid_json.nsp") - Expect(err.Error()).To(ContainSubstring("line 19, column 1: invalid character '\\n'")) - }) - }) - }) - - Describe("ImportM3U", func() { - var repo *mockedMediaFileFromListRepo - BeforeEach(func() { - repo = &mockedMediaFileFromListRepo{} - ds.MockedMediaFile = repo - ps = NewPlaylists(ds) - mockLibRepo.SetData([]model.Library{{ID: 1, Path: "/music"}, {ID: 2, Path: "/new"}}) - ctx = request.WithUser(ctx, model.User{ID: "123"}) - }) - - It("parses well-formed playlists", func() { - repo.data = []string{ - "tests/test.mp3", - "tests/test.ogg", - "tests/01 Invisible (RED) Edit Version.mp3", - "downloads/newfile.flac", - } - m3u := strings.Join([]string{ - "#PLAYLIST:playlist 1", - "/music/tests/test.mp3", - "/music/tests/test.ogg", - "/new/downloads/newfile.flac", - "file:///music/tests/01%20Invisible%20(RED)%20Edit%20Version.mp3", - }, "\n") - f := strings.NewReader(m3u) - - pls, err := ps.ImportM3U(ctx, f) - Expect(err).ToNot(HaveOccurred()) - Expect(pls.OwnerID).To(Equal("123")) - Expect(pls.Name).To(Equal("playlist 1")) - Expect(pls.Sync).To(BeFalse()) - Expect(pls.Tracks).To(HaveLen(4)) - Expect(pls.Tracks[0].Path).To(Equal("tests/test.mp3")) - Expect(pls.Tracks[1].Path).To(Equal("tests/test.ogg")) - Expect(pls.Tracks[2].Path).To(Equal("downloads/newfile.flac")) - Expect(pls.Tracks[3].Path).To(Equal("tests/01 Invisible (RED) Edit Version.mp3")) - Expect(mockPlsRepo.last).To(Equal(pls)) - }) - - It("sets the playlist name as a timestamp if the #PLAYLIST directive is not present", func() { - repo.data = []string{ - "tests/test.mp3", - "tests/test.ogg", - "/tests/01 Invisible (RED) Edit Version.mp3", - } - m3u := strings.Join([]string{ - "/music/tests/test.mp3", - "/music/tests/test.ogg", - }, "\n") - f := strings.NewReader(m3u) - pls, err := ps.ImportM3U(ctx, f) - Expect(err).ToNot(HaveOccurred()) - _, err = time.Parse(time.RFC3339, pls.Name) - Expect(err).ToNot(HaveOccurred()) - Expect(pls.Tracks).To(HaveLen(2)) - }) - - It("returns only tracks that exist in the database and in the same other as the m3u", func() { - repo.data = []string{ - "album1/test1.mp3", - "album2/test2.mp3", - "album3/test3.mp3", - } - m3u := strings.Join([]string{ - "/music/album3/test3.mp3", - "/music/album1/test1.mp3", - "/music/album4/test4.mp3", - "/music/album2/test2.mp3", - }, "\n") - f := strings.NewReader(m3u) - pls, err := ps.ImportM3U(ctx, f) - Expect(err).ToNot(HaveOccurred()) - Expect(pls.Tracks).To(HaveLen(3)) - Expect(pls.Tracks[0].Path).To(Equal("album3/test3.mp3")) - Expect(pls.Tracks[1].Path).To(Equal("album1/test1.mp3")) - Expect(pls.Tracks[2].Path).To(Equal("album2/test2.mp3")) - }) - - It("is case-insensitive when comparing paths", func() { - repo.data = []string{ - "abc/tEsT1.Mp3", - } - m3u := strings.Join([]string{ - "/music/ABC/TeSt1.mP3", - }, "\n") - f := strings.NewReader(m3u) - pls, err := ps.ImportM3U(ctx, f) - Expect(err).ToNot(HaveOccurred()) - Expect(pls.Tracks).To(HaveLen(1)) - Expect(pls.Tracks[0].Path).To(Equal("abc/tEsT1.Mp3")) - }) - - It("handles Unicode normalization when comparing paths", func() { - // Test case for Apple Music playlists that use NFC encoding vs macOS filesystem NFD - // The character "è" can be represented as NFC (single codepoint) or NFD (e + combining accent) - - const pathWithAccents = "artist/Michèle Desrosiers/album/Noël.m4a" - - // Simulate a database entry with NFD encoding (as stored by macOS filesystem) - nfdPath := norm.NFD.String(pathWithAccents) - repo.data = []string{nfdPath} - - // Simulate an Apple Music M3U playlist entry with NFC encoding - nfcPath := norm.NFC.String("/music/" + pathWithAccents) - m3u := strings.Join([]string{ - nfcPath, - }, "\n") - f := strings.NewReader(m3u) - - pls, err := ps.ImportM3U(ctx, f) - Expect(err).ToNot(HaveOccurred()) - Expect(pls.Tracks).To(HaveLen(1), "Should find the track despite Unicode normalization differences") - Expect(pls.Tracks[0].Path).To(Equal(nfdPath)) - }) - }) - - Describe("normalizePathForComparison", func() { - It("normalizes Unicode characters to NFC form and converts to lowercase", func() { - // Test with NFD (decomposed) input - as would come from macOS filesystem - nfdPath := norm.NFD.String("Michèle") // Explicitly convert to NFD form - normalized := normalizePathForComparison(nfdPath) - Expect(normalized).To(Equal("michèle")) - - // Test with NFC (composed) input - as would come from Apple Music M3U - nfcPath := "Michèle" // This might be in NFC form - normalizedNfc := normalizePathForComparison(nfcPath) - - // Ensure the two paths are not equal in their original forms - Expect(nfdPath).ToNot(Equal(nfcPath)) - - // Both should normalize to the same result - Expect(normalized).To(Equal(normalizedNfc)) - }) - - It("handles paths with mixed case and Unicode characters", func() { - path := "Artist/Noël Coward/Album/Song.mp3" - normalized := normalizePathForComparison(path) - Expect(normalized).To(Equal("artist/noël coward/album/song.mp3")) - }) - }) - - Describe("InPlaylistsPath", func() { - var folder model.Folder - - BeforeEach(func() { - DeferCleanup(configtest.SetupConfig()) - folder = model.Folder{ - LibraryPath: "/music", - Path: "playlists/abc", - Name: "folder1", - } - }) - - It("returns true if PlaylistsPath is empty", func() { - conf.Server.PlaylistsPath = "" - Expect(InPlaylistsPath(folder)).To(BeTrue()) - }) - - It("returns true if PlaylistsPath is any (**/**)", func() { - conf.Server.PlaylistsPath = "**/**" - Expect(InPlaylistsPath(folder)).To(BeTrue()) - }) - - It("returns true if folder is in PlaylistsPath", func() { - conf.Server.PlaylistsPath = "other/**:playlists/**" - Expect(InPlaylistsPath(folder)).To(BeTrue()) - }) - - It("returns false if folder is not in PlaylistsPath", func() { - conf.Server.PlaylistsPath = "other" - Expect(InPlaylistsPath(folder)).To(BeFalse()) - }) - - It("returns true if for a playlist in root of MusicFolder if PlaylistsPath is '.'", func() { - conf.Server.PlaylistsPath = "." - Expect(InPlaylistsPath(folder)).To(BeFalse()) - - folder2 := model.Folder{ - LibraryPath: "/music", - Path: "", - Name: ".", - } - - Expect(InPlaylistsPath(folder2)).To(BeTrue()) - }) - }) -}) - -// mockedMediaFileRepo's FindByPaths method returns a list of MediaFiles with the same paths as the input -type mockedMediaFileRepo struct { - model.MediaFileRepository -} - -func (r *mockedMediaFileRepo) FindByPaths(paths []string) (model.MediaFiles, error) { - var mfs model.MediaFiles - for idx, path := range paths { - mfs = append(mfs, model.MediaFile{ - ID: strconv.Itoa(idx), - Path: path, - }) - } - return mfs, nil -} - -// mockedMediaFileFromListRepo's FindByPaths method returns a list of MediaFiles based on the data field -type mockedMediaFileFromListRepo struct { - model.MediaFileRepository - data []string -} - -func (r *mockedMediaFileFromListRepo) FindByPaths([]string) (model.MediaFiles, error) { - var mfs model.MediaFiles - for idx, path := range r.data { - mfs = append(mfs, model.MediaFile{ - ID: strconv.Itoa(idx), - Path: path, - }) - } - return mfs, nil -} - -type mockedPlaylistRepo struct { - last *model.Playlist - model.PlaylistRepository -} - -func (r *mockedPlaylistRepo) FindByPath(string) (*model.Playlist, error) { - return nil, model.ErrNotFound -} - -func (r *mockedPlaylistRepo) Put(pls *model.Playlist) error { - r.last = pls - return nil -} diff --git a/core/publicurl/publicurl.go b/core/publicurl/publicurl.go new file mode 100644 index 000000000..c1b8e01c4 --- /dev/null +++ b/core/publicurl/publicurl.go @@ -0,0 +1,81 @@ +package publicurl + +import ( + "cmp" + "net/http" + "net/url" + "path" + "strconv" + "strings" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" +) + +// ImageURL generates a public URL for artwork images. +// It creates a signed token for the artwork ID and builds a complete public URL. +func ImageURL(req *http.Request, artID model.ArtworkID, size int) string { + token, _ := auth.CreatePublicToken(auth.Claims{ID: artID.String()}) + uri := path.Join(consts.URLPathPublicImages, token) + params := url.Values{} + if size > 0 { + params.Add("size", strconv.Itoa(size)) + } + return PublicURL(req, uri, params) +} + +// PublicURL builds a full URL for public-facing resources. +// It uses ShareURL from config if available, otherwise falls back to extracting +// the scheme and host from the provided http.Request. +// If req is nil and ShareURL is not set, it defaults to http://localhost. +func PublicURL(req *http.Request, u string, params url.Values) string { + if conf.Server.ShareURL == "" { + return AbsoluteURL(req, u, params) + } + shareUrl, err := url.Parse(conf.Server.ShareURL) + if err != nil { + return AbsoluteURL(req, u, params) + } + buildUrl, err := url.Parse(u) + if err != nil { + return AbsoluteURL(req, u, params) + } + buildUrl.Scheme = shareUrl.Scheme + buildUrl.Host = shareUrl.Host + if len(params) > 0 { + buildUrl.RawQuery = params.Encode() + } + return buildUrl.String() +} + +// AbsoluteURL builds an absolute URL from a relative path. +// It uses BaseHost/BaseScheme from config if available, otherwise extracts +// the scheme and host from the http.Request. +// If req is nil and BaseHost is not set, it defaults to http://localhost. +func AbsoluteURL(req *http.Request, u string, params url.Values) string { + buildUrl, err := url.Parse(u) + if err != nil { + log.Error(req.Context(), "Failed to parse URL path", "url", u, err) + return "" + } + if strings.HasPrefix(u, "/") { + buildUrl.Path = path.Join(conf.Server.BasePath, buildUrl.Path) + if conf.Server.BaseHost != "" { + buildUrl.Scheme = cmp.Or(conf.Server.BaseScheme, "http") + buildUrl.Host = conf.Server.BaseHost + } else if req != nil { + buildUrl.Scheme = req.URL.Scheme + buildUrl.Host = req.Host + } else { + buildUrl.Scheme = "http" + buildUrl.Host = "localhost" + } + } + if len(params) > 0 { + buildUrl.RawQuery = params.Encode() + } + return buildUrl.String() +} diff --git a/core/publicurl/publicurl_test.go b/core/publicurl/publicurl_test.go new file mode 100644 index 000000000..18f8f8129 --- /dev/null +++ b/core/publicurl/publicurl_test.go @@ -0,0 +1,174 @@ +package publicurl_test + +import ( + "net/http" + "net/url" + "testing" + + "github.com/go-chi/jwtauth/v5" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/core/publicurl" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestPublicURL(t *testing.T) { + tests.Init(t, false) + log.SetLevel(log.LevelFatal) + RegisterFailHandler(Fail) + RunSpecs(t, "Public URL Suite") +} + +var _ = Describe("Public URL Utilities", func() { + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + }) + + Describe("PublicURL", func() { + When("ShareURL is set", func() { + BeforeEach(func() { + conf.Server.ShareURL = "https://share.example.com" + }) + + It("uses ShareURL as the base", func() { + r, _ := http.NewRequest("GET", "http://localhost/test", nil) + result := publicurl.PublicURL(r, "/path/to/resource", nil) + Expect(result).To(Equal("https://share.example.com/path/to/resource")) + }) + + It("includes query parameters", func() { + r, _ := http.NewRequest("GET", "http://localhost/test", nil) + params := url.Values{"size": []string{"300"}, "format": []string{"png"}} + result := publicurl.PublicURL(r, "/image/123", params) + Expect(result).To(ContainSubstring("https://share.example.com/image/123")) + Expect(result).To(ContainSubstring("size=300")) + Expect(result).To(ContainSubstring("format=png")) + }) + + It("works without a request", func() { + result := publicurl.PublicURL(nil, "/path/to/resource", nil) + Expect(result).To(Equal("https://share.example.com/path/to/resource")) + }) + }) + + When("ShareURL is not set", func() { + BeforeEach(func() { + conf.Server.ShareURL = "" + }) + + It("falls back to AbsoluteURL with request", func() { + r, _ := http.NewRequest("GET", "https://myserver.com/test", nil) + r.Host = "myserver.com" + result := publicurl.PublicURL(r, "/path/to/resource", nil) + Expect(result).To(Equal("https://myserver.com/path/to/resource")) + }) + + It("falls back to localhost without request", func() { + result := publicurl.PublicURL(nil, "/path/to/resource", nil) + Expect(result).To(Equal("http://localhost/path/to/resource")) + }) + }) + }) + + Describe("AbsoluteURL", func() { + When("BaseHost is set", func() { + BeforeEach(func() { + conf.Server.BaseHost = "configured.example.com" + conf.Server.BaseScheme = "https" + conf.Server.BasePath = "" + }) + + It("uses BaseHost and BaseScheme", func() { + r, _ := http.NewRequest("GET", "http://localhost/test", nil) + result := publicurl.AbsoluteURL(r, "/path/to/resource", nil) + Expect(result).To(Equal("https://configured.example.com/path/to/resource")) + }) + + It("defaults to http scheme if BaseScheme is empty", func() { + conf.Server.BaseScheme = "" + r, _ := http.NewRequest("GET", "http://localhost/test", nil) + result := publicurl.AbsoluteURL(r, "/path/to/resource", nil) + Expect(result).To(Equal("http://configured.example.com/path/to/resource")) + }) + }) + + When("BaseHost is not set", func() { + BeforeEach(func() { + conf.Server.BaseHost = "" + conf.Server.BasePath = "" + }) + + It("extracts host from request", func() { + r, _ := http.NewRequest("GET", "https://request.example.com/test", nil) + r.Host = "request.example.com" + result := publicurl.AbsoluteURL(r, "/path/to/resource", nil) + Expect(result).To(Equal("https://request.example.com/path/to/resource")) + }) + + It("falls back to localhost without request", func() { + result := publicurl.AbsoluteURL(nil, "/path/to/resource", nil) + Expect(result).To(Equal("http://localhost/path/to/resource")) + }) + }) + + When("BasePath is set", func() { + BeforeEach(func() { + conf.Server.BasePath = "/navidrome" + conf.Server.BaseHost = "example.com" + conf.Server.BaseScheme = "https" + }) + + It("prepends BasePath to the URL", func() { + r, _ := http.NewRequest("GET", "http://localhost/test", nil) + result := publicurl.AbsoluteURL(r, "/path/to/resource", nil) + Expect(result).To(Equal("https://example.com/navidrome/path/to/resource")) + }) + }) + + It("passes through absolute URLs unchanged", func() { + r, _ := http.NewRequest("GET", "http://localhost/test", nil) + result := publicurl.AbsoluteURL(r, "https://other.example.com/path", nil) + Expect(result).To(Equal("https://other.example.com/path")) + }) + + It("includes query parameters", func() { + conf.Server.BaseHost = "example.com" + conf.Server.BaseScheme = "https" + r, _ := http.NewRequest("GET", "http://localhost/test", nil) + params := url.Values{"key": []string{"value"}} + result := publicurl.AbsoluteURL(r, "/path", params) + Expect(result).To(Equal("https://example.com/path?key=value")) + }) + }) + + Describe("ImageURL", func() { + BeforeEach(func() { + conf.Server.ShareURL = "https://share.example.com" + // Initialize JWT auth for token generation + auth.TokenAuth = jwtauth.New("HS256", []byte("test secret"), nil) + }) + + It("generates a URL with the artwork token", func() { + artID := model.NewArtworkID(model.KindAlbumArtwork, "album-123", nil) + result := publicurl.ImageURL(nil, artID, 0) + Expect(result).To(HavePrefix("https://share.example.com/share/img/")) + }) + + It("includes size parameter when provided", func() { + artID := model.NewArtworkID(model.KindArtistArtwork, "artist-1", nil) + result := publicurl.ImageURL(nil, artID, 300) + Expect(result).To(ContainSubstring("size=300")) + }) + + It("omits size parameter when zero", func() { + artID := model.NewArtworkID(model.KindMediaFileArtwork, "track-1", nil) + result := publicurl.ImageURL(nil, artID, 0) + Expect(result).ToNot(ContainSubstring("size=")) + }) + }) +}) diff --git a/core/scrobbler/buffered_scrobbler.go b/core/scrobbler/buffered_scrobbler.go index 4f64a3c2b..be36e1f24 100644 --- a/core/scrobbler/buffered_scrobbler.go +++ b/core/scrobbler/buffered_scrobbler.go @@ -9,11 +9,27 @@ import ( "github.com/navidrome/navidrome/model" ) +// Loader is a function that loads a scrobbler by name. +// It returns the scrobbler and true if found, or nil and false if not available. +// This allows the buffered scrobbler to always get the current plugin instance. +type Loader func() (Scrobbler, bool) + +// newBufferedScrobbler creates a buffered scrobbler that wraps a static scrobbler instance. +// Use this for builtin scrobblers that don't change. func newBufferedScrobbler(ds model.DataStore, s Scrobbler, service string) *bufferedScrobbler { + return newBufferedScrobblerWithLoader(ds, service, func() (Scrobbler, bool) { + return s, true + }) +} + +// newBufferedScrobblerWithLoader creates a buffered scrobbler that dynamically loads +// the underlying scrobbler on each call. Use this for plugin scrobblers that may be +// reloaded (e.g., after configuration changes). +func newBufferedScrobblerWithLoader(ds model.DataStore, service string, loader Loader) *bufferedScrobbler { ctx, cancel := context.WithCancel(context.Background()) b := &bufferedScrobbler{ ds: ds, - wrapped: s, + loader: loader, service: service, wakeSignal: make(chan struct{}, 1), ctx: ctx, @@ -25,7 +41,7 @@ func newBufferedScrobbler(ds model.DataStore, s Scrobbler, service string) *buff type bufferedScrobbler struct { ds model.DataStore - wrapped Scrobbler + loader Loader service string wakeSignal chan struct{} ctx context.Context @@ -39,11 +55,19 @@ func (b *bufferedScrobbler) Stop() { } func (b *bufferedScrobbler) IsAuthorized(ctx context.Context, userId string) bool { - return b.wrapped.IsAuthorized(ctx, userId) + s, ok := b.loader() + if !ok { + return false + } + return s.IsAuthorized(ctx, userId) } func (b *bufferedScrobbler) NowPlaying(ctx context.Context, userId string, track *model.MediaFile, position int) error { - return b.wrapped.NowPlaying(ctx, userId, track, position) + s, ok := b.loader() + if !ok { + return errors.New("scrobbler not available") + } + return s.NowPlaying(ctx, userId, track, position) } func (b *bufferedScrobbler) Scrobble(ctx context.Context, userId string, s Scrobble) error { @@ -107,8 +131,13 @@ func (b *bufferedScrobbler) processUserQueue(ctx context.Context, userId string) if entry == nil { return true } + s, ok := b.loader() + if !ok { + log.Warn(ctx, "Scrobbler not available, will retry later", "scrobbler", b.service) + return false + } log.Debug(ctx, "Sending scrobble", "scrobbler", b.service, "track", entry.Title, "artist", entry.Artist) - err = b.wrapped.Scrobble(ctx, entry.UserID, Scrobble{ + err = s.Scrobble(ctx, entry.UserID, Scrobble{ MediaFile: entry.MediaFile, TimeStamp: entry.PlayTime, }) diff --git a/core/scrobbler/buffered_scrobbler_test.go b/core/scrobbler/buffered_scrobbler_test.go index c1440046d..9fbca6f71 100644 --- a/core/scrobbler/buffered_scrobbler_test.go +++ b/core/scrobbler/buffered_scrobbler_test.go @@ -38,9 +38,9 @@ var _ = Describe("BufferedScrobbler", func() { It("forwards NowPlaying calls", func() { track := &model.MediaFile{ID: "123", Title: "Test Track"} Expect(bs.NowPlaying(ctx, "user1", track, 0)).To(Succeed()) - Expect(scr.NowPlayingCalled).To(BeTrue()) - Expect(scr.UserID).To(Equal("user1")) - Expect(scr.Track).To(Equal(track)) + Expect(scr.GetNowPlayingCalled()).To(BeTrue()) + Expect(scr.GetUserID()).To(Equal("user1")) + Expect(scr.GetTrack()).To(Equal(track)) }) It("enqueues scrobbles to buffer", func() { @@ -51,9 +51,10 @@ var _ = Describe("BufferedScrobbler", func() { Expect(scr.ScrobbleCalled.Load()).To(BeFalse()) Expect(bs.Scrobble(ctx, "user1", scrobble)).To(Succeed()) - Expect(buffer.Length()).To(Equal(int64(1))) - // Wait for the scrobble to be sent + // Wait for the background goroutine to process the scrobble. + // We don't check buffer.Length() here because the background goroutine + // may dequeue the entry before we can observe it. Eventually(scr.ScrobbleCalled.Load).Should(BeTrue()) lastScrobble := scr.LastScrobble.Load() diff --git a/core/scrobbler/play_tracker.go b/core/scrobbler/play_tracker.go index 3b71a2100..d1338ca39 100644 --- a/core/scrobbler/play_tracker.go +++ b/core/scrobbler/play_tracker.go @@ -31,6 +31,13 @@ type Submission struct { Timestamp time.Time } +type nowPlayingEntry struct { + ctx context.Context + userId string + track *model.MediaFile + position int +} + type PlayTracker interface { NowPlaying(ctx context.Context, playerId string, playerName string, trackId string, position int) error GetNowPlaying(ctx context.Context) ([]NowPlayingInfo, error) @@ -52,6 +59,11 @@ type playTracker struct { pluginScrobblers map[string]Scrobbler pluginLoader PluginLoader mu sync.RWMutex + npQueue map[string]nowPlayingEntry + npMu sync.Mutex + npSignal chan struct{} + shutdown chan struct{} + workerDone chan struct{} } func GetPlayTracker(ds model.DataStore, broker events.Broker, pluginManager PluginLoader) PlayTracker { @@ -71,6 +83,10 @@ func newPlayTracker(ds model.DataStore, broker events.Broker, pluginManager Plug builtinScrobblers: make(map[string]Scrobbler), pluginScrobblers: make(map[string]Scrobbler), pluginLoader: pluginManager, + npQueue: make(map[string]nowPlayingEntry), + npSignal: make(chan struct{}, 1), + shutdown: make(chan struct{}), + workerDone: make(chan struct{}), } if conf.Server.EnableNowPlaying { m.OnExpiration(func(_ string, _ NowPlayingInfo) { @@ -90,10 +106,17 @@ func newPlayTracker(ds model.DataStore, broker events.Broker, pluginManager Plug p.builtinScrobblers[name] = s } log.Debug("List of builtin scrobblers enabled", "names", enabled) + go p.nowPlayingWorker() return p } -// pluginNamesMatchScrobblers returns true if the set of pluginNames matches the keys in pluginScrobblers +// stopNowPlayingWorker stops the background worker. This is primarily for testing. +func (p *playTracker) stopNowPlayingWorker() { + close(p.shutdown) + <-p.workerDone // Wait for worker to finish +} + +// pluginNamesMatchScrobblers returns true if the set of pluginNames matches the keys in pluginScrobblers. func pluginNamesMatchScrobblers(pluginNames []string, scrobblers map[string]Scrobbler) bool { if len(pluginNames) != len(scrobblers) { return false @@ -106,7 +129,9 @@ func pluginNamesMatchScrobblers(pluginNames []string, scrobblers map[string]Scro return true } -// refreshPluginScrobblers updates the pluginScrobblers map to match the current set of plugin scrobblers +// refreshPluginScrobblers updates the pluginScrobblers map to match the current set of plugin scrobblers. +// The buffered scrobblers use a loader function to dynamically get the current plugin instance, +// so we only need to add/remove scrobblers when plugins are added/removed (not when reloaded). func (p *playTracker) refreshPluginScrobblers() { p.mu.Lock() defer p.mu.Unlock() @@ -125,15 +150,16 @@ func (p *playTracker) refreshPluginScrobblers() { // Build a set of current plugins for faster lookups current := make(map[string]struct{}, len(pluginNames)) - // Process additions - add new plugins + // Process additions - add new plugins with a loader that dynamically fetches the current instance for _, name := range pluginNames { current[name] = struct{}{} - // Only create a new scrobbler if it doesn't exist if _, exists := p.pluginScrobblers[name]; !exists { - s, ok := p.pluginLoader.LoadScrobbler(name) - if ok && s != nil { - p.pluginScrobblers[name] = newBufferedScrobbler(p.ds, s, name) - } + // Capture the name for the closure + pluginName := name + loader := p.pluginLoader + p.pluginScrobblers[name] = newBufferedScrobblerWithLoader(p.ds, name, func() (Scrobbler, bool) { + return loader.LoadScrobbler(pluginName) + }) } } @@ -186,10 +212,7 @@ func (p *playTracker) NowPlaying(ctx context.Context, playerId string, playerNam // Calculate TTL based on remaining track duration. If position exceeds track duration, // remaining is set to 0 to avoid negative TTL. - remaining := int(mf.Duration) - position - if remaining < 0 { - remaining = 0 - } + remaining := max(int(mf.Duration)-position, 0) // Add 5 seconds buffer to ensure the NowPlaying info is available slightly longer than the track duration. ttl := time.Duration(remaining+5) * time.Second _ = p.playMap.AddWithTTL(playerId, info, ttl) @@ -198,11 +221,60 @@ func (p *playTracker) NowPlaying(ctx context.Context, playerId string, playerNam } player, _ := request.PlayerFrom(ctx) if player.ScrobbleEnabled { - p.dispatchNowPlaying(ctx, user.ID, mf, position) + p.enqueueNowPlaying(ctx, playerId, user.ID, mf, position) } return nil } +func (p *playTracker) enqueueNowPlaying(ctx context.Context, playerId string, userId string, track *model.MediaFile, position int) { + p.npMu.Lock() + defer p.npMu.Unlock() + ctx = context.WithoutCancel(ctx) // Prevent cancellation from affecting background processing + p.npQueue[playerId] = nowPlayingEntry{ + ctx: ctx, + userId: userId, + track: track, + position: position, + } + p.sendNowPlayingSignal() +} + +func (p *playTracker) sendNowPlayingSignal() { + // Don't block if the previous signal was not read yet + select { + case p.npSignal <- struct{}{}: + default: + } +} + +func (p *playTracker) nowPlayingWorker() { + defer close(p.workerDone) + for { + select { + case <-p.shutdown: + return + case <-time.After(time.Second): + case <-p.npSignal: + } + + p.npMu.Lock() + if len(p.npQueue) == 0 { + p.npMu.Unlock() + continue + } + + // Keep a copy of the entries to process and clear the queue + entries := p.npQueue + p.npQueue = make(map[string]nowPlayingEntry) + p.npMu.Unlock() + + // Process entries without holding lock + for _, entry := range entries { + p.dispatchNowPlaying(entry.ctx, entry.userId, entry.track, entry.position) + } + } +} + func (p *playTracker) dispatchNowPlaying(ctx context.Context, userId string, t *model.MediaFile, position int) { if t.Artist == consts.UnknownArtist { log.Debug(ctx, "Ignoring external NowPlaying update for track with unknown artist", "track", t.Title, "artist", t.Artist) @@ -276,8 +348,14 @@ func (p *playTracker) incPlay(ctx context.Context, track *model.MediaFile, times } for _, artist := range track.Participants[model.RoleArtist] { err = tx.Artist(ctx).IncPlayCount(artist.ID, timestamp) + if err != nil { + return err + } } - return err + if conf.Server.EnableScrobbleHistory { + return tx.Scrobble(ctx).RecordScrobble(track.ID, timestamp) + } + return nil }) } diff --git a/core/scrobbler/play_tracker_test.go b/core/scrobbler/play_tracker_test.go index 7b4785bb5..f7edecdfd 100644 --- a/core/scrobbler/play_tracker_test.go +++ b/core/scrobbler/play_tracker_test.go @@ -24,15 +24,26 @@ import ( // Moved to top-level scope to avoid linter issues type mockPluginLoader struct { + mu sync.RWMutex names []string scrobblers map[string]Scrobbler } func (m *mockPluginLoader) PluginNames(service string) []string { + m.mu.RLock() + defer m.mu.RUnlock() return m.names } +func (m *mockPluginLoader) SetNames(names []string) { + m.mu.Lock() + defer m.mu.Unlock() + m.names = names +} + func (m *mockPluginLoader) LoadScrobbler(name string) (Scrobbler, bool) { + m.mu.RLock() + defer m.mu.RUnlock() s, ok := m.scrobblers[name] return s, ok } @@ -46,24 +57,24 @@ var _ = Describe("PlayTracker", func() { var album model.Album var artist1 model.Artist var artist2 model.Artist - var fake fakeScrobbler + var fake *fakeScrobbler BeforeEach(func() { DeferCleanup(configtest.SetupConfig()) - ctx = context.Background() + ctx = GinkgoT().Context() ctx = request.WithUser(ctx, model.User{ID: "u-1"}) ctx = request.WithPlayer(ctx, model.Player{ScrobbleEnabled: true}) ds = &tests.MockDataStore{} - fake = fakeScrobbler{Authorized: true} + fake = &fakeScrobbler{Authorized: true} Register("fake", func(model.DataStore) Scrobbler { - return &fake + return fake }) Register("disabled", func(model.DataStore) Scrobbler { return nil }) eventBroker = &fakeEventBroker{} tracker = newPlayTracker(ds, eventBroker, nil) - tracker.(*playTracker).builtinScrobblers["fake"] = &fake // Bypass buffering for tests + tracker.(*playTracker).builtinScrobblers["fake"] = fake // Bypass buffering for tests track = model.MediaFile{ ID: "123", @@ -86,6 +97,11 @@ var _ = Describe("PlayTracker", func() { _ = ds.Album(ctx).(*tests.MockAlbumRepo).Put(&album) }) + AfterEach(func() { + // Stop the worker goroutine to prevent data races between tests + tracker.(*playTracker).stopNowPlayingWorker() + }) + It("does not register disabled scrobblers", func() { Expect(tracker.(*playTracker).builtinScrobblers).To(HaveKey("fake")) Expect(tracker.(*playTracker).builtinScrobblers).ToNot(HaveKey("disabled")) @@ -95,10 +111,10 @@ var _ = Describe("PlayTracker", func() { It("sends track to agent", func() { err := tracker.NowPlaying(ctx, "player-1", "player-one", "123", 0) Expect(err).ToNot(HaveOccurred()) - Expect(fake.NowPlayingCalled).To(BeTrue()) - Expect(fake.UserID).To(Equal("u-1")) - Expect(fake.Track.ID).To(Equal("123")) - Expect(fake.Track.Participants).To(Equal(track.Participants)) + Eventually(func() bool { return fake.GetNowPlayingCalled() }).Should(BeTrue()) + Expect(fake.GetUserID()).To(Equal("u-1")) + Expect(fake.GetTrack().ID).To(Equal("123")) + Expect(fake.GetTrack().Participants).To(Equal(track.Participants)) }) It("does not send track to agent if user has not authorized", func() { fake.Authorized = false @@ -106,7 +122,7 @@ var _ = Describe("PlayTracker", func() { err := tracker.NowPlaying(ctx, "player-1", "player-one", "123", 0) Expect(err).ToNot(HaveOccurred()) - Expect(fake.NowPlayingCalled).To(BeFalse()) + Expect(fake.GetNowPlayingCalled()).To(BeFalse()) }) It("does not send track to agent if player is not enabled to send scrobbles", func() { ctx = request.WithPlayer(ctx, model.Player{ScrobbleEnabled: false}) @@ -114,7 +130,7 @@ var _ = Describe("PlayTracker", func() { err := tracker.NowPlaying(ctx, "player-1", "player-one", "123", 0) Expect(err).ToNot(HaveOccurred()) - Expect(fake.NowPlayingCalled).To(BeFalse()) + Expect(fake.GetNowPlayingCalled()).To(BeFalse()) }) It("does not send track to agent if artist is unknown", func() { track.Artist = consts.UnknownArtist @@ -122,7 +138,7 @@ var _ = Describe("PlayTracker", func() { err := tracker.NowPlaying(ctx, "player-1", "player-one", "123", 0) Expect(err).ToNot(HaveOccurred()) - Expect(fake.NowPlayingCalled).To(BeFalse()) + Expect(fake.GetNowPlayingCalled()).To(BeFalse()) }) It("stores position when greater than zero", func() { @@ -130,11 +146,12 @@ var _ = Describe("PlayTracker", func() { err := tracker.NowPlaying(ctx, "player-1", "player-one", "123", pos) Expect(err).ToNot(HaveOccurred()) + Eventually(func() int { return fake.GetPosition() }).Should(Equal(pos)) + playing, err := tracker.GetNowPlaying(ctx) Expect(err).ToNot(HaveOccurred()) Expect(playing).To(HaveLen(1)) Expect(playing[0].Position).To(Equal(pos)) - Expect(fake.Position).To(Equal(pos)) }) It("sends event with count", func() { @@ -153,6 +170,17 @@ var _ = Describe("PlayTracker", func() { Expect(err).ToNot(HaveOccurred()) Expect(eventBroker.getEvents()).To(BeEmpty()) }) + + It("passes user to scrobbler via context (fix for issue #4787)", func() { + ctx = request.WithUser(ctx, model.User{ID: "u-1", UserName: "testuser"}) + ctx = request.WithPlayer(ctx, model.Player{ScrobbleEnabled: true}) + + err := tracker.NowPlaying(ctx, "player-1", "player-one", "123", 0) + Expect(err).ToNot(HaveOccurred()) + Eventually(func() bool { return fake.GetNowPlayingCalled() }).Should(BeTrue()) + // Verify the username was passed through async dispatch via context + Eventually(func() string { return fake.GetUsername() }).Should(Equal("testuser")) + }) }) Describe("GetNowPlaying", func() { @@ -160,9 +188,9 @@ var _ = Describe("PlayTracker", func() { track2 := track track2.ID = "456" _ = ds.MediaFile(ctx).Put(&track2) - ctx = request.WithUser(context.Background(), model.User{UserName: "user-1"}) + ctx = request.WithUser(GinkgoT().Context(), model.User{UserName: "user-1"}) _ = tracker.NowPlaying(ctx, "player-1", "player-one", "123", 0) - ctx = request.WithUser(context.Background(), model.User{UserName: "user-2"}) + ctx = request.WithUser(GinkgoT().Context(), model.User{UserName: "user-2"}) _ = tracker.NowPlaying(ctx, "player-2", "player-two", "456", 0) playing, err := tracker.GetNowPlaying(ctx) @@ -210,7 +238,7 @@ var _ = Describe("PlayTracker", func() { Expect(err).ToNot(HaveOccurred()) Expect(fake.ScrobbleCalled.Load()).To(BeTrue()) - Expect(fake.UserID).To(Equal("u-1")) + Expect(fake.GetUserID()).To(Equal("u-1")) lastScrobble := fake.LastScrobble.Load() Expect(lastScrobble.TimeStamp).To(BeTemporally("~", ts, 1*time.Second)) Expect(lastScrobble.ID).To(Equal("123")) @@ -274,49 +302,82 @@ var _ = Describe("PlayTracker", func() { Expect(artist1.PlayCount).To(Equal(int64(1))) Expect(artist2.PlayCount).To(Equal(int64(1))) }) + + Context("Scrobble History", func() { + It("records scrobble in repository", func() { + conf.Server.EnableScrobbleHistory = true + ctx = request.WithUser(ctx, model.User{ID: "u-1", UserName: "user-1"}) + ts := time.Now() + + err := tracker.Submit(ctx, []Submission{{TrackID: "123", Timestamp: ts}}) + + Expect(err).ToNot(HaveOccurred()) + + mockDS := ds.(*tests.MockDataStore) + mockScrobble := mockDS.Scrobble(ctx).(*tests.MockScrobbleRepo) + Expect(mockScrobble.RecordedScrobbles).To(HaveLen(1)) + Expect(mockScrobble.RecordedScrobbles[0].MediaFileID).To(Equal("123")) + Expect(mockScrobble.RecordedScrobbles[0].UserID).To(Equal("u-1")) + Expect(mockScrobble.RecordedScrobbles[0].SubmissionTime).To(Equal(ts)) + }) + + It("does not record scrobble when history is disabled", func() { + conf.Server.EnableScrobbleHistory = false + ctx = request.WithUser(ctx, model.User{ID: "u-1", UserName: "user-1"}) + ts := time.Now() + + err := tracker.Submit(ctx, []Submission{{TrackID: "123", Timestamp: ts}}) + + Expect(err).ToNot(HaveOccurred()) + mockDS := ds.(*tests.MockDataStore) + mockScrobble := mockDS.Scrobble(ctx).(*tests.MockScrobbleRepo) + Expect(mockScrobble.RecordedScrobbles).To(HaveLen(0)) + }) + }) }) Describe("Plugin scrobbler logic", func() { var pluginLoader *mockPluginLoader - var pluginFake fakeScrobbler + var pluginFake *fakeScrobbler BeforeEach(func() { - pluginFake = fakeScrobbler{Authorized: true} + pluginFake = &fakeScrobbler{Authorized: true} pluginLoader = &mockPluginLoader{ names: []string{"plugin1"}, - scrobblers: map[string]Scrobbler{"plugin1": &pluginFake}, + scrobblers: map[string]Scrobbler{"plugin1": pluginFake}, } tracker = newPlayTracker(ds, events.GetBroker(), pluginLoader) // Bypass buffering for both built-in and plugin scrobblers - tracker.(*playTracker).builtinScrobblers["fake"] = &fake - tracker.(*playTracker).pluginScrobblers["plugin1"] = &pluginFake + tracker.(*playTracker).builtinScrobblers["fake"] = fake + tracker.(*playTracker).pluginScrobblers["plugin1"] = pluginFake }) It("registers and uses plugin scrobbler for NowPlaying", func() { err := tracker.NowPlaying(ctx, "player-1", "player-one", "123", 0) Expect(err).ToNot(HaveOccurred()) - Expect(pluginFake.NowPlayingCalled).To(BeTrue()) + Eventually(func() bool { return pluginFake.GetNowPlayingCalled() }).Should(BeTrue()) }) It("removes plugin scrobbler if not present anymore", func() { // First call: plugin present _ = tracker.NowPlaying(ctx, "player-1", "player-one", "123", 0) - Expect(pluginFake.NowPlayingCalled).To(BeTrue()) - pluginFake.NowPlayingCalled = false + Eventually(func() bool { return pluginFake.GetNowPlayingCalled() }).Should(BeTrue()) + pluginFake.nowPlayingCalled.Store(false) // Remove plugin - pluginLoader.names = []string{} + pluginLoader.SetNames([]string{}) _ = tracker.NowPlaying(ctx, "player-1", "player-one", "123", 0) - Expect(pluginFake.NowPlayingCalled).To(BeFalse()) + // Should not be called since plugin was removed + Consistently(func() bool { return pluginFake.GetNowPlayingCalled() }).Should(BeFalse()) }) It("calls both builtin and plugin scrobblers for NowPlaying", func() { - fake.NowPlayingCalled = false - pluginFake.NowPlayingCalled = false + fake.nowPlayingCalled.Store(false) + pluginFake.nowPlayingCalled.Store(false) err := tracker.NowPlaying(ctx, "player-1", "player-one", "123", 0) Expect(err).ToNot(HaveOccurred()) - Expect(fake.NowPlayingCalled).To(BeTrue()) - Expect(pluginFake.NowPlayingCalled).To(BeTrue()) + Eventually(func() bool { return fake.GetNowPlayingCalled() }).Should(BeTrue()) + Eventually(func() bool { return pluginFake.GetNowPlayingCalled() }).Should(BeTrue()) }) It("calls plugin scrobbler for Submit", func() { @@ -334,7 +395,7 @@ var _ = Describe("PlayTracker", func() { var mockedBS *mockBufferedScrobbler BeforeEach(func() { - ctx = context.Background() + ctx = GinkgoT().Context() ctx = request.WithUser(ctx, model.User{ID: "u-1"}) ctx = request.WithPlayer(ctx, model.Player{ScrobbleEnabled: true}) ds = &tests.MockDataStore{} @@ -359,7 +420,7 @@ var _ = Describe("PlayTracker", func() { It("calls Stop on scrobblers when removing them", func() { // Change the plugin names to simulate a plugin being removed - mockPlugin.names = []string{} + mockPlugin.SetNames([]string{}) // Call refreshPluginScrobblers which should detect the removed plugin pTracker.refreshPluginScrobblers() @@ -371,36 +432,189 @@ var _ = Describe("PlayTracker", func() { Expect(pTracker.pluginScrobblers).NotTo(HaveKey("plugin1")) }) }) + + Describe("Plugin reload (config update) behavior", func() { + var mockPlugin *mockPluginLoader + var pTracker *playTracker + var originalScrobbler *fakeScrobbler + var reloadedScrobbler *fakeScrobbler + + BeforeEach(func() { + ctx = GinkgoT().Context() + ctx = request.WithUser(ctx, model.User{ID: "u-1"}) + ctx = request.WithPlayer(ctx, model.Player{ScrobbleEnabled: true}) + ds = &tests.MockDataStore{} + + // Setup initial plugin scrobbler + originalScrobbler = &fakeScrobbler{Authorized: true} + reloadedScrobbler = &fakeScrobbler{Authorized: true} + + mockPlugin = &mockPluginLoader{ + names: []string{"plugin1"}, + scrobblers: map[string]Scrobbler{"plugin1": originalScrobbler}, + } + + // Create tracker - this will create buffered scrobblers with loaders + pTracker = newPlayTracker(ds, events.GetBroker(), mockPlugin) + + // Trigger initial plugin registration + pTracker.refreshPluginScrobblers() + }) + + AfterEach(func() { + pTracker.stopNowPlayingWorker() + }) + + It("uses the new plugin instance after reload (simulating config update)", func() { + // First call should use the original scrobbler + scrobblers := pTracker.getActiveScrobblers() + pluginScr := scrobblers["plugin1"] + Expect(pluginScr).ToNot(BeNil()) + + err := pluginScr.NowPlaying(ctx, "u-1", &track, 0) + Expect(err).ToNot(HaveOccurred()) + Expect(originalScrobbler.GetNowPlayingCalled()).To(BeTrue()) + Expect(reloadedScrobbler.GetNowPlayingCalled()).To(BeFalse()) + + // Simulate plugin reload (config update): replace the scrobbler in the loader + // This is what happens when UpdatePluginConfig is called - the plugin manager + // unloads the old plugin and loads a new instance + mockPlugin.mu.Lock() + mockPlugin.scrobblers["plugin1"] = reloadedScrobbler + mockPlugin.mu.Unlock() + + // Reset call tracking + originalScrobbler.nowPlayingCalled.Store(false) + + // Get scrobblers again - should still return the same buffered scrobbler + // but subsequent calls should use the new plugin instance via the loader + scrobblers = pTracker.getActiveScrobblers() + pluginScr = scrobblers["plugin1"] + + err = pluginScr.NowPlaying(ctx, "u-1", &track, 0) + Expect(err).ToNot(HaveOccurred()) + + // The new scrobbler should be called, not the old one + Expect(reloadedScrobbler.GetNowPlayingCalled()).To(BeTrue()) + Expect(originalScrobbler.GetNowPlayingCalled()).To(BeFalse()) + }) + + It("handles plugin becoming unavailable temporarily", func() { + // First verify plugin works + scrobblers := pTracker.getActiveScrobblers() + pluginScr := scrobblers["plugin1"] + + err := pluginScr.NowPlaying(ctx, "u-1", &track, 0) + Expect(err).ToNot(HaveOccurred()) + Expect(originalScrobbler.GetNowPlayingCalled()).To(BeTrue()) + + // Simulate plugin becoming unavailable (e.g., during reload) + mockPlugin.mu.Lock() + delete(mockPlugin.scrobblers, "plugin1") + mockPlugin.mu.Unlock() + + originalScrobbler.nowPlayingCalled.Store(false) + + // NowPlaying should return error when plugin unavailable + err = pluginScr.NowPlaying(ctx, "u-1", &track, 0) + Expect(err).To(HaveOccurred()) + Expect(originalScrobbler.GetNowPlayingCalled()).To(BeFalse()) + + // Simulate plugin becoming available again + mockPlugin.mu.Lock() + mockPlugin.scrobblers["plugin1"] = reloadedScrobbler + mockPlugin.mu.Unlock() + + // Should work again with new instance + err = pluginScr.NowPlaying(ctx, "u-1", &track, 0) + Expect(err).ToNot(HaveOccurred()) + Expect(reloadedScrobbler.GetNowPlayingCalled()).To(BeTrue()) + }) + + It("IsAuthorized uses the current plugin instance", func() { + scrobblers := pTracker.getActiveScrobblers() + pluginScr := scrobblers["plugin1"] + + // Original is authorized + Expect(pluginScr.IsAuthorized(ctx, "u-1")).To(BeTrue()) + + // Replace with unauthorized scrobbler + unauthorizedScrobbler := &fakeScrobbler{Authorized: false} + mockPlugin.mu.Lock() + mockPlugin.scrobblers["plugin1"] = unauthorizedScrobbler + mockPlugin.mu.Unlock() + + // Should reflect the new scrobbler's authorization status + Expect(pluginScr.IsAuthorized(ctx, "u-1")).To(BeFalse()) + }) + }) }) type fakeScrobbler struct { Authorized bool - NowPlayingCalled bool + nowPlayingCalled atomic.Bool ScrobbleCalled atomic.Bool - UserID string - Track *model.MediaFile - Position int + userID atomic.Pointer[string] + username atomic.Pointer[string] + track atomic.Pointer[model.MediaFile] + position atomic.Int32 LastScrobble atomic.Pointer[Scrobble] Error error } +func (f *fakeScrobbler) GetNowPlayingCalled() bool { + return f.nowPlayingCalled.Load() +} + +func (f *fakeScrobbler) GetUserID() string { + if p := f.userID.Load(); p != nil { + return *p + } + return "" +} + +func (f *fakeScrobbler) GetTrack() *model.MediaFile { + return f.track.Load() +} + +func (f *fakeScrobbler) GetPosition() int { + return int(f.position.Load()) +} + +func (f *fakeScrobbler) GetUsername() string { + if p := f.username.Load(); p != nil { + return *p + } + return "" +} + func (f *fakeScrobbler) IsAuthorized(ctx context.Context, userId string) bool { return f.Error == nil && f.Authorized } func (f *fakeScrobbler) NowPlaying(ctx context.Context, userId string, track *model.MediaFile, position int) error { - f.NowPlayingCalled = true + f.nowPlayingCalled.Store(true) if f.Error != nil { return f.Error } - f.UserID = userId - f.Track = track - f.Position = position + f.userID.Store(&userId) + // Capture username from context (this is what plugin scrobblers do) + username, _ := request.UsernameFrom(ctx) + if username == "" { + if u, ok := request.UserFrom(ctx); ok { + username = u.UserName + } + } + if username != "" { + f.username.Store(&username) + } + f.track.Store(track) + f.position.Store(int32(position)) return nil } func (f *fakeScrobbler) Scrobble(ctx context.Context, userId string, s Scrobble) error { - f.UserID = userId + f.userID.Store(&userId) f.LastScrobble.Store(&s) f.ScrobbleCalled.Store(true) if f.Error != nil { diff --git a/core/share.go b/core/share.go index 202c27d89..a6d06a018 100644 --- a/core/share.go +++ b/core/share.go @@ -7,12 +7,13 @@ import ( "github.com/Masterminds/squirrel" "github.com/deluan/rest" - gonanoid "github.com/matoous/go-nanoid/v2" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" . "github.com/navidrome/navidrome/utils/gg" + "github.com/navidrome/navidrome/utils/nanoid" "github.com/navidrome/navidrome/utils/slice" + "github.com/navidrome/navidrome/utils/str" ) type Share interface { @@ -72,7 +73,7 @@ type shareRepositoryWrapper struct { func (r *shareRepositoryWrapper) newId() (string, error) { for { - id, err := gonanoid.Generate("0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz", 10) + id, err := nanoid.Generate("0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz", 10) if err != nil { return "", err } @@ -86,7 +87,7 @@ func (r *shareRepositoryWrapper) newId() (string, error) { } } -func (r *shareRepositoryWrapper) Save(entity interface{}) (string, error) { +func (r *shareRepositoryWrapper) Save(entity any) (string, error) { s := entity.(*model.Share) id, err := r.newId() if err != nil { @@ -119,15 +120,14 @@ func (r *shareRepositoryWrapper) Save(entity interface{}) (string, error) { log.Error(r.ctx, "Invalid Resource ID", "id", firstId) return "", model.ErrNotFound } - if len(s.Contents) > 30 { - s.Contents = s.Contents[:26] + "..." - } + + s.Contents = str.TruncateRunes(s.Contents, 30, "...") id, err = r.Persistable.Save(s) return id, err } -func (r *shareRepositoryWrapper) Update(id string, entity interface{}, _ ...string) error { +func (r *shareRepositoryWrapper) Update(id string, entity any, _ ...string) error { cols := []string{"description", "downloadable"} // TODO Better handling of Share expiration diff --git a/core/share_test.go b/core/share_test.go index 21069bb59..475d40ec9 100644 --- a/core/share_test.go +++ b/core/share_test.go @@ -38,6 +38,38 @@ var _ = Describe("Share", func() { Expect(id).ToNot(BeEmpty()) Expect(entity.ID).To(Equal(id)) }) + + It("does not truncate ASCII labels shorter than 30 characters", func() { + _ = ds.MediaFile(ctx).Put(&model.MediaFile{ID: "456", Title: "Example Media File"}) + entity := &model.Share{Description: "test", ResourceIDs: "456"} + _, err := repo.Save(entity) + Expect(err).ToNot(HaveOccurred()) + Expect(entity.Contents).To(Equal("Example Media File")) + }) + + It("truncates ASCII labels longer than 30 characters", func() { + _ = ds.MediaFile(ctx).Put(&model.MediaFile{ID: "789", Title: "Example Media File But The Title Is Really Long For Testing Purposes"}) + entity := &model.Share{Description: "test", ResourceIDs: "789"} + _, err := repo.Save(entity) + Expect(err).ToNot(HaveOccurred()) + Expect(entity.Contents).To(Equal("Example Media File But The ...")) + }) + + It("does not truncate CJK labels shorter than 30 runes", func() { + _ = ds.MediaFile(ctx).Put(&model.MediaFile{ID: "456", Title: "青春コンプレックス"}) + entity := &model.Share{Description: "test", ResourceIDs: "456"} + _, err := repo.Save(entity) + Expect(err).ToNot(HaveOccurred()) + Expect(entity.Contents).To(Equal("青春コンプレックス")) + }) + + It("truncates CJK labels longer than 30 runes", func() { + _ = ds.MediaFile(ctx).Put(&model.MediaFile{ID: "789", Title: "私の中の幻想的世界観及びその顕現を想起させたある現実での出来事に関する一考察"}) + entity := &model.Share{Description: "test", ResourceIDs: "789"} + _, err := repo.Save(entity) + Expect(err).ToNot(HaveOccurred()) + Expect(entity.Contents).To(Equal("私の中の幻想的世界観及びその顕現を想起させたある現実で...")) + }) }) Describe("Update", func() { diff --git a/core/storage/local/local.go b/core/storage/local/local.go index 5c335ddb9..cd60c9ef1 100644 --- a/core/storage/local/local.go +++ b/core/storage/local/local.go @@ -44,7 +44,7 @@ func newLocalStorage(u url.URL) storage.Storage { func (s *localStorage) FS() (storage.MusicFS, error) { path := s.u.Path - if _, err := os.Stat(path); err != nil { + if _, err := os.Stat(path); err != nil { //nolint:gosec return nil, fmt.Errorf("%w: %s", err, path) } return &localFS{FS: os.DirFS(path), extractor: s.extractor}, nil diff --git a/core/storage/local/watcher.go b/core/storage/local/watcher.go index e2418f4cb..1b8a4e0c8 100644 --- a/core/storage/local/watcher.go +++ b/core/storage/local/watcher.go @@ -17,8 +17,8 @@ func (s *localStorage) Start(ctx context.Context) (<-chan string, error) { if !s.watching.CompareAndSwap(false, true) { return nil, errors.New("watcher already started") } - input := make(chan notify.EventInfo, 1) - output := make(chan string, 1) + input := make(chan notify.EventInfo, 500) + output := make(chan string, 500) started := make(chan struct{}) go func() { diff --git a/core/storage/storagetest/fake_storage.go b/core/storage/storagetest/fake_storage.go index 009b37d2d..1b0d1a6c1 100644 --- a/core/storage/storagetest/fake_storage.go +++ b/core/storage/storagetest/fake_storage.go @@ -6,6 +6,7 @@ import ( "errors" "fmt" "io/fs" + "maps" "net/url" "path" "testing/fstest" @@ -135,9 +136,7 @@ func (ffs *FakeFS) UpdateTags(filePath string, newTags map[string]any, when ...t if err != nil { panic(err) } - for k, v := range newTags { - tags[k] = v - } + maps.Copy(tags, newTags) data, _ := json.Marshal(tags) f.Data = data ffs.Touch(filePath, when...) @@ -180,9 +179,7 @@ func Track(num int, title string, tags ...map[string]any) map[string]any { ts["title"] = title ts["track"] = num for _, t := range tags { - for k, v := range t { - ts[k] = v - } + maps.Copy(ts, t) } return ts } @@ -200,9 +197,7 @@ func MP3(tags ...map[string]any) *fstest.MapFile { func File(tags ...map[string]any) *fstest.MapFile { ts := map[string]any{} for _, t := range tags { - for k, v := range t { - ts[k] = v - } + maps.Copy(ts, t) } modTime := time.Now() if mt, ok := ts[fakeFileInfoModTime]; !ok { @@ -289,6 +284,9 @@ func (ffs *FakeFS) parseFile(filePath string) (*metadata.Info, error) { p.AudioProperties.BitDepth = getInt("bitdepth") p.AudioProperties.SampleRate = getInt("samplerate") p.AudioProperties.Channels = getInt("channels") + if codec, ok := data["codec"].(string); ok { + p.AudioProperties.Codec = codec + } for k, v := range data { p.Tags[k] = []string{fmt.Sprintf("%v", v)} } diff --git a/core/stream/aliases.go b/core/stream/aliases.go new file mode 100644 index 000000000..af42ac076 --- /dev/null +++ b/core/stream/aliases.go @@ -0,0 +1,92 @@ +package stream + +import ( + "slices" + "strings" +) + +// containerAliasGroups maps each container alias to a canonical group name. +var containerAliasGroups = func() map[string]string { + groups := [][]string{ + {"aac", "adts", "m4a", "mp4", "m4b", "m4p"}, + {"mpeg", "mp3", "mp2"}, + {"ogg", "oga", "opus"}, + {"aif", "aiff"}, + {"asf", "wma"}, + {"mpc", "mpp"}, + {"wv"}, + } + m := make(map[string]string) + for _, g := range groups { + canonical := g[0] + for _, name := range g { + m[name] = canonical + } + } + return m +}() + +// codecAliasGroups maps each codec alias to a canonical group name. +// Codecs within the same group are considered equivalent. +var codecAliasGroups = func() map[string]string { + groups := [][]string{ + {"aac", "adts"}, + {"ac3", "ac-3"}, + {"eac3", "e-ac3", "e-ac-3", "eac-3"}, + {"mpc7", "musepack7"}, + {"mpc8", "musepack8"}, + {"wma1", "wmav1"}, + {"wma2", "wmav2"}, + {"wmalossless", "wma9lossless"}, + {"wmapro", "wma9pro"}, + {"shn", "shorten"}, + {"mp4als", "als"}, + } + m := make(map[string]string) + for _, g := range groups { + for _, name := range g { + m[name] = g[0] // canonical = first entry + } + } + return m +}() + +// matchesWithAliases checks if a value matches any entry in candidates, +// consulting the alias map for equivalent names. +func matchesWithAliases(value string, candidates []string, aliases map[string]string) bool { + value = strings.ToLower(value) + canonical := aliases[value] + for _, c := range candidates { + c = strings.ToLower(c) + if c == value { + return true + } + if canonical != "" && aliases[c] == canonical { + return true + } + } + return false +} + +// matchesContainer checks if a file suffix matches any of the container names, +// including common aliases. +func matchesContainer(suffix string, containers []string) bool { + return matchesWithAliases(suffix, containers, containerAliasGroups) +} + +// matchesCodec checks if a codec matches any of the codec names, +// including common aliases. +func matchesCodec(codec string, codecs []string) bool { + return matchesWithAliases(codec, codecs, codecAliasGroups) +} + +// IsAACCodec returns true if the given codec or container name resolves to AAC. +func IsAACCodec(name string) bool { + return matchesCodec(name, []string{"aac"}) || matchesContainer(name, []string{"aac"}) +} + +func containsIgnoreCase(slice []string, s string) bool { + return slices.ContainsFunc(slice, func(item string) bool { + return strings.EqualFold(item, s) + }) +} diff --git a/core/stream/aliases_test.go b/core/stream/aliases_test.go new file mode 100644 index 000000000..72f061810 --- /dev/null +++ b/core/stream/aliases_test.go @@ -0,0 +1,30 @@ +package stream + +import ( + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Aliases", func() { + Describe("IsAACCodec", func() { + It("returns true for AAC and its aliases", func() { + Expect(IsAACCodec("aac")).To(BeTrue()) + Expect(IsAACCodec("AAC")).To(BeTrue()) + Expect(IsAACCodec("adts")).To(BeTrue()) + Expect(IsAACCodec("m4a")).To(BeTrue()) + Expect(IsAACCodec("mp4")).To(BeTrue()) + Expect(IsAACCodec("m4b")).To(BeTrue()) + }) + + It("returns false for non-AAC formats", func() { + Expect(IsAACCodec("mp3")).To(BeFalse()) + Expect(IsAACCodec("opus")).To(BeFalse()) + Expect(IsAACCodec("flac")).To(BeFalse()) + Expect(IsAACCodec("ogg")).To(BeFalse()) + }) + + It("returns false for empty string", func() { + Expect(IsAACCodec("")).To(BeFalse()) + }) + }) +}) diff --git a/core/stream/codec.go b/core/stream/codec.go new file mode 100644 index 000000000..88d1ae45d --- /dev/null +++ b/core/stream/codec.go @@ -0,0 +1,77 @@ +package stream + +import "strings" + +// normalizeProbeCodec maps ffprobe codec_name values to the simplified internal +// codec names used throughout Navidrome (matching inferCodecFromSuffix output). +// Most ffprobe names match directly; this handles the exceptions. +func normalizeProbeCodec(codec string) string { + c := strings.ToLower(codec) + // DSD variants: dsd_lsbf_planar, dsd_msbf_planar, dsd_lsbf, dsd_msbf + if strings.HasPrefix(c, "dsd") { + return "dsd" + } + // PCM variants: pcm_s16le, pcm_s24le, pcm_s32be, pcm_f32le, etc. + if strings.HasPrefix(c, "pcm_") { + return "pcm" + } + return c +} + +// isLosslessFormat returns true if the format is a known lossless audio codec/format. +// Detection is based on codec name only, not bit depth — some lossy codecs (e.g. ADPCM) +// report non-zero bits_per_sample in ffprobe, so bit depth alone is not a reliable signal. +// +// Note: core/ffmpeg has a separate isLosslessOutputFormat that covers only formats +// ffmpeg can produce as output (a smaller set). +func isLosslessFormat(format string) bool { + switch strings.ToLower(format) { + case "flac", "alac", "wav", "aiff", "ape", "wv", "wavpack", "tta", "tak", "shn", "dsd", "pcm": + return true + } + return false +} + +// normalizeSourceSampleRate adjusts the source sample rate for codecs that store +// it differently than PCM. Currently handles DSD (÷8): +// DSD64=2822400→352800, DSD128=5644800→705600, etc. +// For other codecs, returns the rate unchanged. +func normalizeSourceSampleRate(sampleRate int, codec string) int { + if strings.EqualFold(codec, "dsd") && sampleRate > 0 { + return sampleRate / 8 + } + return sampleRate +} + +// normalizeSourceBitDepth adjusts the source bit depth for codecs that use +// non-standard bit depths. Currently handles DSD (1-bit → 24-bit PCM, which is +// what ffmpeg produces). For other codecs, returns the depth unchanged. +func normalizeSourceBitDepth(bitDepth int, codec string) int { + if strings.EqualFold(codec, "dsd") && bitDepth == 1 { + return 24 + } + return bitDepth +} + +// codecFixedOutputSampleRate returns the mandatory output sample rate for codecs +// that always resample regardless of input (e.g., Opus always outputs 48000Hz). +// Returns 0 if the codec has no fixed output rate. +func codecFixedOutputSampleRate(codec string) int { + switch strings.ToLower(codec) { + case "opus": + return 48000 + } + return 0 +} + +// codecMaxSampleRate returns the hard maximum output sample rate for a codec. +// Returns 0 if the codec has no hard limit. +func codecMaxSampleRate(codec string) int { + switch strings.ToLower(codec) { + case "mp3": + return 48000 + case "aac": + return 96000 + } + return 0 +} diff --git a/core/stream/codec_test.go b/core/stream/codec_test.go new file mode 100644 index 000000000..4c76b3ecd --- /dev/null +++ b/core/stream/codec_test.go @@ -0,0 +1,69 @@ +package stream + +import ( + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Codec", func() { + Describe("isLosslessFormat", func() { + It("returns true for known lossless codecs", func() { + Expect(isLosslessFormat("flac")).To(BeTrue()) + Expect(isLosslessFormat("alac")).To(BeTrue()) + Expect(isLosslessFormat("pcm")).To(BeTrue()) + Expect(isLosslessFormat("wav")).To(BeTrue()) + Expect(isLosslessFormat("dsd")).To(BeTrue()) + Expect(isLosslessFormat("ape")).To(BeTrue()) + Expect(isLosslessFormat("wv")).To(BeTrue()) + Expect(isLosslessFormat("wavpack")).To(BeTrue()) // ffprobe codec_name for WavPack + }) + + It("returns false for lossy codecs", func() { + Expect(isLosslessFormat("mp3")).To(BeFalse()) + Expect(isLosslessFormat("aac")).To(BeFalse()) + Expect(isLosslessFormat("opus")).To(BeFalse()) + Expect(isLosslessFormat("vorbis")).To(BeFalse()) + }) + + It("returns false for unknown codecs", func() { + Expect(isLosslessFormat("unknown_codec")).To(BeFalse()) + }) + + It("is case-insensitive", func() { + Expect(isLosslessFormat("FLAC")).To(BeTrue()) + Expect(isLosslessFormat("Alac")).To(BeTrue()) + }) + }) + + Describe("normalizeProbeCodec", func() { + It("passes through common codec names unchanged", func() { + Expect(normalizeProbeCodec("mp3")).To(Equal("mp3")) + Expect(normalizeProbeCodec("aac")).To(Equal("aac")) + Expect(normalizeProbeCodec("flac")).To(Equal("flac")) + Expect(normalizeProbeCodec("opus")).To(Equal("opus")) + Expect(normalizeProbeCodec("vorbis")).To(Equal("vorbis")) + Expect(normalizeProbeCodec("alac")).To(Equal("alac")) + Expect(normalizeProbeCodec("wmav2")).To(Equal("wmav2")) + }) + + It("normalizes DSD variants to dsd", func() { + Expect(normalizeProbeCodec("dsd_lsbf_planar")).To(Equal("dsd")) + Expect(normalizeProbeCodec("dsd_msbf_planar")).To(Equal("dsd")) + Expect(normalizeProbeCodec("dsd_lsbf")).To(Equal("dsd")) + Expect(normalizeProbeCodec("dsd_msbf")).To(Equal("dsd")) + }) + + It("normalizes PCM variants to pcm", func() { + Expect(normalizeProbeCodec("pcm_s16le")).To(Equal("pcm")) + Expect(normalizeProbeCodec("pcm_s24le")).To(Equal("pcm")) + Expect(normalizeProbeCodec("pcm_s32be")).To(Equal("pcm")) + Expect(normalizeProbeCodec("pcm_f32le")).To(Equal("pcm")) + }) + + It("lowercases input", func() { + Expect(normalizeProbeCodec("MP3")).To(Equal("mp3")) + Expect(normalizeProbeCodec("AAC")).To(Equal("aac")) + Expect(normalizeProbeCodec("DSD_LSBF_PLANAR")).To(Equal("dsd")) + }) + }) +}) diff --git a/core/stream/decider.go b/core/stream/decider.go new file mode 100644 index 000000000..5cca0cb0f --- /dev/null +++ b/core/stream/decider.go @@ -0,0 +1,449 @@ +package stream + +import ( + "context" + "encoding/json" + "fmt" + "strings" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/core/ffmpeg" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" +) + +const fallbackBitrate = 256 // kbps + +// TranscodeDecider is the core service interface for making transcoding decisions +type TranscodeDecider interface { + MakeDecision(ctx context.Context, mf *model.MediaFile, clientInfo *ClientInfo, opts TranscodeOptions) (*TranscodeDecision, error) + CreateTranscodeParams(decision *TranscodeDecision) (string, error) + ResolveRequestFromToken(ctx context.Context, token string, mf *model.MediaFile, offset int) (Request, error) + ResolveRequest(ctx context.Context, mf *model.MediaFile, reqFormat string, reqBitRate int, offset int) Request +} + +func NewTranscodeDecider(ds model.DataStore, ff ffmpeg.FFmpeg) TranscodeDecider { + return &deciderService{ + ds: ds, + ff: ff, + } +} + +type deciderService struct { + ds model.DataStore + ff ffmpeg.FFmpeg +} + +func (s *deciderService) MakeDecision(ctx context.Context, mf *model.MediaFile, clientInfo *ClientInfo, opts TranscodeOptions) (*TranscodeDecision, error) { + decision := &TranscodeDecision{ + MediaID: mf.ID, + SourceUpdatedAt: mf.UpdatedAt, + } + + var probe *ffmpeg.AudioProbeResult + if !opts.SkipProbe { + var err error + probe, err = s.ensureProbed(ctx, mf) + if err != nil { + return nil, err + } + } + + // Build source stream details (uses probe data if available) + decision.SourceStream = buildSourceStream(mf, probe) + src := &decision.SourceStream + + // Check for server-side player transcoding override + if trc, ok := request.TranscodingFrom(ctx); ok && trc.TargetFormat != "" { + clientInfo = applyServerOverride(ctx, clientInfo, &trc) + } else if player, ok := request.PlayerFrom(ctx); ok && player.MaxBitRate > 0 { + if clientInfo.MaxAudioBitrate == 0 || player.MaxBitRate < clientInfo.MaxAudioBitrate { + modified := *clientInfo + modified.MaxAudioBitrate = player.MaxBitRate + clientInfo = &modified + log.Debug(ctx, "Applied player MaxBitRate cap", "playerMaxBitRate", player.MaxBitRate, "client", clientInfo.Name) + } + } + + log.Trace(ctx, "Making transcode decision", "mediaID", mf.ID, "container", src.Container, + "codec", src.Codec, "bitrate", src.Bitrate, "channels", src.Channels, + "sampleRate", src.SampleRate, "lossless", src.IsLossless, "client", clientInfo.Name) + + // Check global bitrate constraint first. + if clientInfo.MaxAudioBitrate > 0 && src.Bitrate > clientInfo.MaxAudioBitrate { + log.Trace(ctx, "Global bitrate constraint exceeded, skipping direct play", + "sourceBitrate", src.Bitrate, "maxAudioBitrate", clientInfo.MaxAudioBitrate) + decision.TranscodeReasons = append(decision.TranscodeReasons, "audio bitrate not supported") + // Skip direct play profiles entirely — global constraint fails + } else { + // Try direct play profiles, collecting reasons for each failure + for _, profile := range clientInfo.DirectPlayProfiles { + if reason := s.checkDirectPlayProfile(src, &profile, clientInfo); reason == "" { + decision.CanDirectPlay = true + decision.TranscodeReasons = nil // Clear any previously collected reasons + break + } else { + decision.TranscodeReasons = append(decision.TranscodeReasons, reason) + } + } + } + + // If direct play is possible, we're done + if decision.CanDirectPlay { + log.Debug(ctx, "Transcode decision: direct play", "mediaID", mf.ID, "container", src.Container, "codec", src.Codec) + return decision, nil + } + + // Try transcoding profiles (in order of preference) + for _, profile := range clientInfo.TranscodingProfiles { + if ts, transcodeFormat := s.computeTranscodedStream(ctx, src, &profile, clientInfo); ts != nil { + decision.CanTranscode = true + decision.TargetFormat = transcodeFormat + decision.TargetBitrate = ts.Bitrate + decision.TargetChannels = ts.Channels + decision.TargetSampleRate = ts.SampleRate + decision.TargetBitDepth = ts.BitDepth + decision.TranscodeStream = ts + break + } + } + + if decision.CanTranscode { + log.Debug(ctx, "Transcode decision: transcode", "mediaID", mf.ID, + "targetFormat", decision.TargetFormat, "targetBitrate", decision.TargetBitrate, + "targetChannels", decision.TargetChannels, "reasons", decision.TranscodeReasons) + } + + // If neither direct play nor transcode is possible + if !decision.CanDirectPlay && !decision.CanTranscode { + decision.ErrorReason = "no compatible playback profile found" + log.Warn(ctx, "Transcode decision: no compatible profile", "mediaID", mf.ID, + "container", src.Container, "codec", src.Codec, "reasons", decision.TranscodeReasons) + } + + return decision, nil +} + +func buildSourceStream(mf *model.MediaFile, probe *ffmpeg.AudioProbeResult) Details { + sd := Details{ + Container: mf.Suffix, + Duration: mf.Duration, + Size: mf.Size, + } + + // Use pre-parsed probe result, or fall back to parsing stored probe data + if probe == nil { + probe, _ = parseProbeData(mf.ProbeData) + } + + // Use probe data if available for authoritative values + if probe != nil { + sd.Codec = normalizeProbeCodec(probe.Codec) + sd.Profile = probe.Profile + sd.Bitrate = probe.BitRate + sd.SampleRate = probe.SampleRate + sd.BitDepth = probe.BitDepth + sd.Channels = probe.Channels + } else { + sd.Codec = mf.AudioCodec() + sd.Bitrate = mf.BitRate + sd.SampleRate = mf.SampleRate + sd.BitDepth = mf.BitDepth + sd.Channels = mf.Channels + } + sd.IsLossless = isLosslessFormat(sd.Codec) + + return sd +} + +// applyServerOverride replaces the client-provided profiles with synthetic ones +// matching the server-forced transcoding format and bitrate. +func applyServerOverride(ctx context.Context, original *ClientInfo, trc *model.Transcoding) *ClientInfo { + maxBitRate := trc.DefaultBitRate + if player, ok := request.PlayerFrom(ctx); ok && player.MaxBitRate > 0 { + maxBitRate = player.MaxBitRate + } + + log.Debug(ctx, "Applying server-side transcoding override", + "targetFormat", trc.TargetFormat, "maxBitRate", maxBitRate, + "client", original.Name) + + return &ClientInfo{ + Name: original.Name, + Platform: original.Platform, + MaxAudioBitrate: maxBitRate, + MaxTranscodingAudioBitrate: maxBitRate, + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{trc.TargetFormat}, AudioCodecs: []string{trc.TargetFormat}, Protocols: []string{ProtocolHTTP}}, + }, + TranscodingProfiles: []Profile{ + {Container: trc.TargetFormat, AudioCodec: trc.TargetFormat, Protocol: ProtocolHTTP}, + }, + } +} + +func parseProbeData(data string) (*ffmpeg.AudioProbeResult, error) { + if data == "" { + return nil, nil + } + var result ffmpeg.AudioProbeResult + if err := json.Unmarshal([]byte(data), &result); err != nil { + return nil, err + } + return &result, nil +} + +// checkDirectPlayProfile returns "" if the profile matches (direct play OK), +// or a typed reason string if it doesn't match. +func (s *deciderService) checkDirectPlayProfile(src *Details, profile *DirectPlayProfile, clientInfo *ClientInfo) string { + // Check protocol (only http for now) + if len(profile.Protocols) > 0 && !containsIgnoreCase(profile.Protocols, ProtocolHTTP) { + return "protocol not supported" + } + + // Check container + if len(profile.Containers) > 0 && !matchesContainer(src.Container, profile.Containers) { + return "container not supported" + } + + // Check codec + if len(profile.AudioCodecs) > 0 && !matchesCodec(src.Codec, profile.AudioCodecs) { + return "audio codec not supported" + } + + // Check channels + if profile.MaxAudioChannels > 0 && src.Channels > profile.MaxAudioChannels { + return "audio channels not supported" + } + + // Check codec-specific limitations + for _, codecProfile := range clientInfo.CodecProfiles { + if strings.EqualFold(codecProfile.Type, CodecProfileTypeAudio) && matchesCodec(src.Codec, []string{codecProfile.Name}) { + if reason := checkLimitations(src, codecProfile.Limitations); reason != "" { + return reason + } + } + } + + return "" +} + +// computeTranscodedStream attempts to build a valid transcoded stream for the given profile. +// Returns the stream details and the internal transcoding format (which may differ from the +// response container when a codec fallback occurs, e.g., "mp4"→"aac"). +// Returns nil, "" if the profile cannot produce a valid output. +func (s *deciderService) computeTranscodedStream(ctx context.Context, src *Details, profile *Profile, clientInfo *ClientInfo) (*Details, string) { + // Check protocol (only http for now) + if profile.Protocol != "" && !strings.EqualFold(profile.Protocol, ProtocolHTTP) { + log.Trace(ctx, "Skipping transcoding profile: unsupported protocol", "protocol", profile.Protocol) + return nil, "" + } + + responseContainer, targetFormat := resolveTargetFormat(profile) + if targetFormat == "" { + return nil, "" + } + + // Verify we have a transcoding command available (DB custom or built-in default) + if LookupTranscodeCommand(ctx, s.ds, targetFormat) == "" { + log.Trace(ctx, "Skipping transcoding profile: no transcoding command available", "targetFormat", targetFormat) + return nil, "" + } + + targetIsLossless := isLosslessFormat(targetFormat) + + // Reject lossy to lossless conversion + if !src.IsLossless && targetIsLossless { + log.Trace(ctx, "Skipping transcoding profile: lossy to lossless not allowed", "targetFormat", targetFormat) + return nil, "" + } + + ts := &Details{ + Container: responseContainer, + Codec: strings.ToLower(profile.AudioCodec), + SampleRate: normalizeSourceSampleRate(src.SampleRate, src.Codec), + Channels: src.Channels, + BitDepth: normalizeSourceBitDepth(src.BitDepth, src.Codec), + IsLossless: targetIsLossless, + } + if ts.Codec == "" { + ts.Codec = targetFormat + } + + // Apply codec-intrinsic sample rate adjustments before codec profile limitations + if fixedRate := codecFixedOutputSampleRate(ts.Codec); fixedRate > 0 { + ts.SampleRate = fixedRate + } + if maxRate := codecMaxSampleRate(ts.Codec); maxRate > 0 && ts.SampleRate > maxRate { + ts.SampleRate = maxRate + } + + // Determine target bitrate (all in kbps) + if ok := s.computeBitrate(ctx, src, targetFormat, targetIsLossless, clientInfo, ts); !ok { + return nil, "" + } + + // Apply MaxAudioChannels from the transcoding profile + if profile.MaxAudioChannels > 0 && src.Channels > profile.MaxAudioChannels { + ts.Channels = profile.MaxAudioChannels + } + + // Apply codec profile limitations to the TARGET codec + if ok := s.applyCodecLimitations(ctx, src.Bitrate, targetFormat, targetIsLossless, clientInfo, ts); !ok { + return nil, "" + } + + return ts, targetFormat +} + +// lookupDefaultBitrate returns the default bitrate for the given format. +// It checks the DB first (for user-customized values), then falls back to +// the built-in defaults, and finally to fallbackBitrate. +func lookupDefaultBitrate(ctx context.Context, ds model.DataStore, format string) int { + if t, err := ds.Transcoding(ctx).FindByFormat(format); err == nil && t.DefaultBitRate > 0 { + return t.DefaultBitRate + } + for _, dt := range consts.DefaultTranscodings { + if dt.TargetFormat == format && dt.DefaultBitRate > 0 { + return dt.DefaultBitRate + } + } + return fallbackBitrate +} + +// LookupTranscodeCommand returns the ffmpeg command for the given format. +// It checks the DB first (for user-customized commands), then falls back to +// the built-in default command. Returns "" if the format is unknown. +func LookupTranscodeCommand(ctx context.Context, ds model.DataStore, format string) string { + t, err := ds.Transcoding(ctx).FindByFormat(format) + if err == nil && t.Command != "" { + return t.Command + } + // Fall back to built-in defaults + for _, dt := range consts.DefaultTranscodings { + if dt.TargetFormat == format { + return dt.Command + } + } + return "" +} + +// resolveTargetFormat determines the response container and internal target format +// from the profile's Container and AudioCodec fields. When an AudioCodec is specified +// it is preferred as targetFormat (e.g. container "mp4" with audioCodec "aac" → targetFormat "aac"). +func resolveTargetFormat(profile *Profile) (responseContainer, targetFormat string) { + responseContainer = strings.ToLower(profile.Container) + targetFormat = responseContainer + + // Prefer the audioCodec as targetFormat when provided (handles container-to-codec + // mapping like "mp4" → "aac", "ogg" → "opus"). + if profile.AudioCodec != "" { + targetFormat = strings.ToLower(profile.AudioCodec) + } + + // If neither container nor audioCodec is set, we can't resolve a format. + if targetFormat == "" { + return "", "" + } + + // When no container was specified, use the targetFormat as container too. + if responseContainer == "" { + responseContainer = targetFormat + } + + return responseContainer, targetFormat +} + +// computeBitrate determines the target bitrate for the transcoded stream. +// Returns false if the profile should be rejected. +func (s *deciderService) computeBitrate(ctx context.Context, src *Details, targetFormat string, targetIsLossless bool, clientInfo *ClientInfo, ts *Details) bool { + if src.IsLossless { + if !targetIsLossless { + if clientInfo.MaxTranscodingAudioBitrate > 0 { + ts.Bitrate = clientInfo.MaxTranscodingAudioBitrate + } else if clientInfo.MaxAudioBitrate > 0 { + ts.Bitrate = clientInfo.MaxAudioBitrate + } else { + ts.Bitrate = lookupDefaultBitrate(ctx, s.ds, targetFormat) + } + } else { + if clientInfo.MaxAudioBitrate > 0 && src.Bitrate > clientInfo.MaxAudioBitrate { + log.Trace(ctx, "Skipping transcoding profile: lossless target exceeds bitrate limit", + "targetFormat", targetFormat, "sourceBitrate", src.Bitrate, "maxAudioBitrate", clientInfo.MaxAudioBitrate) + return false + } + } + } else { + ts.Bitrate = src.Bitrate + } + + // Apply maxAudioBitrate as final cap + if clientInfo.MaxAudioBitrate > 0 && ts.Bitrate > 0 && ts.Bitrate > clientInfo.MaxAudioBitrate { + ts.Bitrate = clientInfo.MaxAudioBitrate + } + return true +} + +// applyCodecLimitations applies codec profile limitations to the transcoded stream. +// Returns false if the profile should be rejected. +func (s *deciderService) applyCodecLimitations(ctx context.Context, sourceBitrate int, targetFormat string, targetIsLossless bool, clientInfo *ClientInfo, ts *Details) bool { + targetCodec := ts.Codec + for _, codecProfile := range clientInfo.CodecProfiles { + if !strings.EqualFold(codecProfile.Type, CodecProfileTypeAudio) { + continue + } + if !matchesCodec(targetCodec, []string{codecProfile.Name}) { + continue + } + for _, lim := range codecProfile.Limitations { + result := applyLimitation(sourceBitrate, &lim, ts) + if strings.EqualFold(lim.Name, LimitationAudioBitrate) && targetIsLossless && result == adjustAdjusted { + log.Trace(ctx, "Skipping transcoding profile: cannot adjust bitrate for lossless target", + "targetFormat", targetFormat, "codec", targetCodec, "limitation", lim.Name) + return false + } + if result == adjustCannotFit { + log.Trace(ctx, "Skipping transcoding profile: codec limitation cannot be satisfied", + "targetFormat", targetFormat, "codec", targetCodec, "limitation", lim.Name, + "comparison", lim.Comparison, "values", lim.Values) + return false + } + } + } + return true +} + +// ensureProbed runs ffprobe if probe data is missing, persists it, and returns +// the parsed result. Returns (nil, nil) when probing is skipped or data already exists +// (in which case the caller should parse mf.ProbeData). +func (s *deciderService) ensureProbed(ctx context.Context, mf *model.MediaFile) (*ffmpeg.AudioProbeResult, error) { + if mf.ProbeData != "" { + return nil, nil + } + if !conf.Server.DevEnableMediaFileProbe { + return nil, nil + } + + result, err := s.ff.ProbeAudioStream(ctx, mf.AbsolutePath()) + if err != nil { + return nil, fmt.Errorf("probing media file %s: %w", mf.ID, err) + } + + data, err := json.Marshal(result) + if err != nil { + return nil, fmt.Errorf("marshaling probe result for %s: %w", mf.ID, err) + } + mf.ProbeData = string(data) + + if err := s.ds.MediaFile(ctx).UpdateProbeData(mf.ID, mf.ProbeData); err != nil { + log.Error(ctx, "Failed to persist probe data", "mediaID", mf.ID, err) + // Don't fail the decision — we have the data in memory + } + + log.Debug(ctx, "Probed media file", "mediaID", mf.ID, "codec", result.Codec, + "profile", result.Profile, "bitRate", result.BitRate, + "sampleRate", result.SampleRate, "bitDepth", result.BitDepth, "channels", result.Channels) + return result, nil +} diff --git a/core/stream/decider_test.go b/core/stream/decider_test.go new file mode 100644 index 000000000..42ebd84f1 --- /dev/null +++ b/core/stream/decider_test.go @@ -0,0 +1,1190 @@ +package stream + +import ( + "context" + "encoding/json" + "fmt" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/core/ffmpeg" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +// withProbe pre-populates ProbeData on a MediaFile from its own fields, +// so ensureProbed short-circuits and tests don't need mock ffprobe results. +func withProbe(mf *model.MediaFile) *model.MediaFile { + probe := ffmpeg.AudioProbeResult{ + Codec: mf.AudioCodec(), + BitRate: mf.BitRate, + SampleRate: mf.SampleRate, + BitDepth: mf.BitDepth, + Channels: mf.Channels, + } + data, _ := json.Marshal(probe) + mf.ProbeData = string(data) + return mf +} + +var _ = Describe("Decider", func() { + var ( + ds *tests.MockDataStore + ff *tests.MockFFmpeg + svc TranscodeDecider + ctx context.Context + ) + + BeforeEach(func() { + ctx = GinkgoT().Context() + ds = &tests.MockDataStore{ + MockedProperty: &tests.MockedPropertyRepo{}, + MockedTranscoding: &tests.MockTranscodingRepo{}, + } + ff = tests.NewMockFFmpeg("") + auth.Init(ds) + svc = NewTranscodeDecider(ds, ff) + }) + + Describe("MakeDecision", func() { + Context("Direct Play", func() { + It("allows direct play when profile matches", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "mp3", Codec: "MP3", BitRate: 320, Channels: 2, SampleRate: 44100}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"mp3"}, AudioCodecs: []string{"mp3"}, Protocols: []string{ProtocolHTTP}, MaxAudioChannels: 2}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeTrue()) + Expect(decision.CanTranscode).To(BeFalse()) + Expect(decision.TranscodeReasons).To(BeEmpty()) + }) + + It("rejects direct play when container doesn't match", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"mp3"}, Protocols: []string{ProtocolHTTP}}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeFalse()) + Expect(decision.TranscodeReasons).To(ContainElement("container not supported")) + }) + + It("rejects direct play when codec doesn't match", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "m4a", Codec: "ALAC", BitRate: 1000, Channels: 2}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"m4a"}, AudioCodecs: []string{"aac"}, Protocols: []string{ProtocolHTTP}}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeFalse()) + Expect(decision.TranscodeReasons).To(ContainElement("audio codec not supported")) + }) + + It("rejects direct play when channels exceed limit", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 6}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"flac"}, Protocols: []string{ProtocolHTTP}, MaxAudioChannels: 2}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeFalse()) + Expect(decision.TranscodeReasons).To(ContainElement("audio channels not supported")) + }) + + It("handles container aliases (aac -> m4a)", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "m4a", Codec: "AAC", BitRate: 256, Channels: 2}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"aac"}, AudioCodecs: []string{"aac"}, Protocols: []string{ProtocolHTTP}}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeTrue()) + }) + + It("handles container aliases (mp4 -> m4a)", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "m4a", Codec: "AAC", BitRate: 256, Channels: 2}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"mp4"}, AudioCodecs: []string{"aac"}, Protocols: []string{ProtocolHTTP}}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeTrue()) + }) + + It("handles container aliases (opus -> ogg)", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "opus", Codec: "Opus", BitRate: 165, Channels: 2, SampleRate: 48000}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"ogg"}, AudioCodecs: []string{"opus"}, Protocols: []string{ProtocolHTTP}}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeTrue()) + }) + + It("handles codec aliases (adts -> aac)", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "m4a", Codec: "AAC", BitRate: 256, Channels: 2}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"m4a"}, AudioCodecs: []string{"adts"}, Protocols: []string{ProtocolHTTP}}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeTrue()) + }) + + It("allows when protocol list is empty (any protocol)", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"flac"}, AudioCodecs: []string{"flac"}}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeTrue()) + }) + + It("allows when both container and codec lists are empty (wildcard)", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "mp3", Codec: "MP3", BitRate: 128, Channels: 2}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{}, AudioCodecs: []string{}}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeTrue()) + }) + }) + + Context("MaxAudioBitrate constraint", func() { + It("revokes direct play when bitrate exceeds maxAudioBitrate", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1500, Channels: 2}) + ci := &ClientInfo{ + MaxAudioBitrate: 500, // kbps + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"flac"}, Protocols: []string{ProtocolHTTP}}, + }, + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeFalse()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TranscodeReasons).To(ContainElement("audio bitrate not supported")) + }) + }) + + Context("Transcoding", func() { + It("selects transcoding when direct play isn't possible", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 16}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 256, // kbps + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"mp3"}, Protocols: []string{ProtocolHTTP}}, + }, + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP, MaxAudioChannels: 2}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeFalse()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TargetFormat).To(Equal("mp3")) + Expect(decision.TargetBitrate).To(Equal(256)) // kbps + Expect(decision.TranscodeReasons).To(ContainElement("container not supported")) + }) + + It("rejects lossy to lossless transcoding", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "mp3", Codec: "MP3", BitRate: 320, Channels: 2}) + ci := &ClientInfo{ + TranscodingProfiles: []Profile{ + {Container: "flac", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeFalse()) + }) + + It("uses default bitrate when client doesn't specify", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, BitDepth: 16}) + ci := &ClientInfo{ + TranscodingProfiles: []Profile{ + {Container: "mp3", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TargetBitrate).To(Equal(160)) // mp3 default from mock transcoding repo + }) + + It("preserves lossy bitrate when under max", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "ogg", BitRate: 192, Channels: 2}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 256, // kbps + TranscodingProfiles: []Profile{ + {Container: "mp3", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TargetBitrate).To(Equal(192)) // source bitrate in kbps + }) + + It("rejects format with no transcoding command available", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2}) + ci := &ClientInfo{ + TranscodingProfiles: []Profile{ + {Container: "wav", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeFalse()) + }) + + It("applies maxAudioBitrate as final cap on transcoded stream", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "mp3", Codec: "MP3", BitRate: 320, Channels: 2}) + ci := &ClientInfo{ + MaxAudioBitrate: 96, // kbps + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TargetBitrate).To(Equal(96)) // capped by maxAudioBitrate + }) + + It("selects first valid transcoding profile in order", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 48000, BitDepth: 16}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 320, + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"mp3"}, Protocols: []string{ProtocolHTTP}}, + }, + TranscodingProfiles: []Profile{ + {Container: "opus", AudioCodec: "opus", Protocol: ProtocolHTTP}, + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP, MaxAudioChannels: 2}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TargetFormat).To(Equal("opus")) + }) + }) + + Context("Lossless to lossless transcoding", func() { + It("allows lossless to lossless when samplerate needs downsampling", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "dsf", Codec: "DSD", BitRate: 5644, Channels: 2, SampleRate: 176400, BitDepth: 1}) + ci := &ClientInfo{ + MaxAudioBitrate: 1000, + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"flac"}, Protocols: []string{ProtocolHTTP}}, + }, + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TargetFormat).To(Equal("mp3")) + }) + + It("sets IsLossless=true on transcoded stream when target is lossless", func() { + // Transcoding to mp3 (lossy) should result in IsLossless=false. + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 96000, BitDepth: 24}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 320, + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TranscodeStream.IsLossless).To(BeFalse()) // mp3 is lossy + }) + }) + + Context("No compatible profile", func() { + It("returns error when nothing matches", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 6}) + ci := &ClientInfo{} + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeFalse()) + Expect(decision.CanTranscode).To(BeFalse()) + Expect(decision.ErrorReason).To(Equal("no compatible playback profile found")) + }) + }) + + Context("Codec limitations on direct play", func() { + It("rejects direct play when codec limitation fails (required)", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "mp3", Codec: "MP3", BitRate: 512, Channels: 2, SampleRate: 44100}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"mp3"}, AudioCodecs: []string{"mp3"}, Protocols: []string{ProtocolHTTP}}, + }, + CodecProfiles: []CodecProfile{ + { + Type: CodecProfileTypeAudio, + Name: "mp3", + Limitations: []Limitation{ + {Name: LimitationAudioBitrate, Comparison: ComparisonLessThanEqual, Values: []string{"320"}, Required: true}, + }, + }, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeFalse()) + Expect(decision.TranscodeReasons).To(ContainElement("audio bitrate not supported")) + }) + + It("allows direct play when optional limitation fails", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "mp3", Codec: "MP3", BitRate: 512, Channels: 2, SampleRate: 44100}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"mp3"}, AudioCodecs: []string{"mp3"}, Protocols: []string{ProtocolHTTP}}, + }, + CodecProfiles: []CodecProfile{ + { + Type: CodecProfileTypeAudio, + Name: "mp3", + Limitations: []Limitation{ + {Name: LimitationAudioBitrate, Comparison: ComparisonLessThanEqual, Values: []string{"320"}, Required: false}, + }, + }, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeTrue()) + }) + + It("handles Equals comparison with multiple values", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"flac"}, Protocols: []string{ProtocolHTTP}}, + }, + CodecProfiles: []CodecProfile{ + { + Type: CodecProfileTypeAudio, + Name: "flac", + Limitations: []Limitation{ + {Name: LimitationAudioChannels, Comparison: ComparisonEquals, Values: []string{"1", "2"}, Required: true}, + }, + }, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeTrue()) + }) + + It("rejects when Equals comparison doesn't match any value", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 6, SampleRate: 44100}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"flac"}, Protocols: []string{ProtocolHTTP}}, + }, + CodecProfiles: []CodecProfile{ + { + Type: CodecProfileTypeAudio, + Name: "flac", + Limitations: []Limitation{ + {Name: LimitationAudioChannels, Comparison: ComparisonEquals, Values: []string{"1", "2"}, Required: true}, + }, + }, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeFalse()) + }) + + It("rejects direct play when audioProfile limitation fails (required)", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "m4a", Codec: "AAC", BitRate: 256, Channels: 2, SampleRate: 44100}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"m4a"}, AudioCodecs: []string{"aac"}, Protocols: []string{ProtocolHTTP}}, + }, + CodecProfiles: []CodecProfile{ + { + Type: CodecProfileTypeAudio, + Name: "aac", + Limitations: []Limitation{ + {Name: LimitationAudioProfile, Comparison: ComparisonEquals, Values: []string{"LC"}, Required: true}, + }, + }, + }, + } + // Source profile is empty (not yet populated from scanner), so Equals("LC") fails + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeFalse()) + Expect(decision.TranscodeReasons).To(ContainElement("audio profile not supported")) + }) + + It("allows direct play when audioProfile limitation is optional", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "m4a", Codec: "AAC", BitRate: 256, Channels: 2, SampleRate: 44100}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"m4a"}, AudioCodecs: []string{"aac"}, Protocols: []string{ProtocolHTTP}}, + }, + CodecProfiles: []CodecProfile{ + { + Type: CodecProfileTypeAudio, + Name: "aac", + Limitations: []Limitation{ + {Name: LimitationAudioProfile, Comparison: ComparisonEquals, Values: []string{"LC"}, Required: false}, + }, + }, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeTrue()) + }) + + It("rejects direct play due to samplerate limitation", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 96000, BitDepth: 24}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"flac"}, Protocols: []string{ProtocolHTTP}}, + }, + CodecProfiles: []CodecProfile{ + { + Type: CodecProfileTypeAudio, + Name: "flac", + Limitations: []Limitation{ + {Name: LimitationAudioSamplerate, Comparison: ComparisonLessThanEqual, Values: []string{"48000"}, Required: true}, + }, + }, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeFalse()) + Expect(decision.TranscodeReasons).To(ContainElement("audio samplerate not supported")) + }) + }) + + Context("Codec limitations on transcoded output", func() { + It("applies bitrate limitation to transcoded stream", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "mp3", Codec: "MP3", BitRate: 192, Channels: 2, SampleRate: 44100}) + ci := &ClientInfo{ + MaxAudioBitrate: 96, // force transcode + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP}, + }, + CodecProfiles: []CodecProfile{ + { + Type: CodecProfileTypeAudio, + Name: "mp3", + Limitations: []Limitation{ + {Name: LimitationAudioBitrate, Comparison: ComparisonLessThanEqual, Values: []string{"96"}, Required: true}, + }, + }, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TranscodeStream.Bitrate).To(Equal(96)) + }) + + It("applies channel limitation to transcoded stream", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 6, SampleRate: 48000, BitDepth: 16}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 320, + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP}, + }, + CodecProfiles: []CodecProfile{ + { + Type: CodecProfileTypeAudio, + Name: "mp3", + Limitations: []Limitation{ + {Name: LimitationAudioChannels, Comparison: ComparisonLessThanEqual, Values: []string{"2"}, Required: true}, + }, + }, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TranscodeStream.Channels).To(Equal(2)) + }) + + It("applies samplerate limitation to transcoded stream", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 96000, BitDepth: 24}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 320, + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP}, + }, + CodecProfiles: []CodecProfile{ + { + Type: CodecProfileTypeAudio, + Name: "mp3", + Limitations: []Limitation{ + {Name: LimitationAudioSamplerate, Comparison: ComparisonLessThanEqual, Values: []string{"48000"}, Required: true}, + }, + }, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TranscodeStream.SampleRate).To(Equal(48000)) + }) + + It("applies bitdepth limitation to transcoded stream", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 96000, BitDepth: 24}) + ci := &ClientInfo{ + TranscodingProfiles: []Profile{ + {Container: "flac", AudioCodec: "flac", Protocol: ProtocolHTTP}, + }, + CodecProfiles: []CodecProfile{ + { + Type: CodecProfileTypeAudio, + Name: "flac", + Limitations: []Limitation{ + {Name: LimitationAudioBitdepth, Comparison: ComparisonLessThanEqual, Values: []string{"16"}, Required: true}, + }, + }, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TranscodeStream.BitDepth).To(Equal(16)) + Expect(decision.TargetBitDepth).To(Equal(16)) + }) + + It("preserves source bit depth when no limitation applies", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 24}) + ci := &ClientInfo{ + TranscodingProfiles: []Profile{ + {Container: "flac", AudioCodec: "flac", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TranscodeStream.BitDepth).To(Equal(24)) + Expect(decision.TargetBitDepth).To(Equal(24)) + }) + + It("rejects transcoding profile when GreaterThanEqual cannot be satisfied", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 16}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 320, + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP}, + }, + CodecProfiles: []CodecProfile{ + { + Type: CodecProfileTypeAudio, + Name: "mp3", + Limitations: []Limitation{ + {Name: LimitationAudioSamplerate, Comparison: ComparisonGreaterThanEqual, Values: []string{"96000"}, Required: true}, + }, + }, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeFalse()) + }) + }) + + Context("DSD sample rate conversion", func() { + It("converts DSD sample rate to PCM-equivalent in decision", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "dsf", Codec: "DSD", BitRate: 5644, Channels: 2, SampleRate: 2822400, BitDepth: 1}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 320, + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TargetFormat).To(Equal("mp3")) + // DSD64 2822400 / 8 = 352800, capped by MP3 max of 48000 + Expect(decision.TranscodeStream.SampleRate).To(Equal(48000)) + Expect(decision.TargetSampleRate).To(Equal(48000)) + // DSD 1-bit → 24-bit PCM + Expect(decision.TranscodeStream.BitDepth).To(Equal(24)) + Expect(decision.TargetBitDepth).To(Equal(24)) + }) + + It("converts DSD sample rate for FLAC target without codec limit", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "dsf", Codec: "DSD", BitRate: 5644, Channels: 2, SampleRate: 2822400, BitDepth: 1}) + ci := &ClientInfo{ + TranscodingProfiles: []Profile{ + {Container: "flac", AudioCodec: "flac", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TargetFormat).To(Equal("flac")) + // DSD64 2822400 / 8 = 352800, FLAC has no hard max + Expect(decision.TranscodeStream.SampleRate).To(Equal(352800)) + Expect(decision.TargetSampleRate).To(Equal(352800)) + // DSD 1-bit → 24-bit PCM + Expect(decision.TranscodeStream.BitDepth).To(Equal(24)) + Expect(decision.TargetBitDepth).To(Equal(24)) + }) + + It("applies codec profile limit to DSD-converted FLAC sample rate", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "dsf", Codec: "DSD", BitRate: 5644, Channels: 2, SampleRate: 2822400, BitDepth: 1}) + ci := &ClientInfo{ + TranscodingProfiles: []Profile{ + {Container: "flac", AudioCodec: "flac", Protocol: ProtocolHTTP}, + }, + CodecProfiles: []CodecProfile{ + { + Type: CodecProfileTypeAudio, + Name: "flac", + Limitations: []Limitation{ + {Name: LimitationAudioSamplerate, Comparison: ComparisonLessThanEqual, Values: []string{"48000"}, Required: true}, + }, + }, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + // DSD64 2822400 / 8 = 352800, capped by codec profile limit of 48000 + Expect(decision.TranscodeStream.SampleRate).To(Equal(48000)) + Expect(decision.TargetSampleRate).To(Equal(48000)) + // DSD 1-bit → 24-bit PCM + Expect(decision.TranscodeStream.BitDepth).To(Equal(24)) + Expect(decision.TargetBitDepth).To(Equal(24)) + }) + + It("applies audioBitdepth limitation to DSD-converted bit depth", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "dsf", Codec: "DSD", BitRate: 5644, Channels: 2, SampleRate: 2822400, BitDepth: 1}) + ci := &ClientInfo{ + TranscodingProfiles: []Profile{ + {Container: "flac", AudioCodec: "flac", Protocol: ProtocolHTTP}, + }, + CodecProfiles: []CodecProfile{ + { + Type: CodecProfileTypeAudio, + Name: "flac", + Limitations: []Limitation{ + {Name: LimitationAudioBitdepth, Comparison: ComparisonLessThanEqual, Values: []string{"16"}, Required: true}, + }, + }, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + // DSD 1-bit → 24-bit PCM, then capped by codec profile limit to 16-bit + Expect(decision.TranscodeStream.BitDepth).To(Equal(16)) + Expect(decision.TargetBitDepth).To(Equal(16)) + }) + }) + + Context("Probe-based lossless detection", func() { + It("uses probe codec name for lossless detection", func() { + // WavPack files: ffprobe reports codec as "wavpack", suffix is ".wv" + mf := &model.MediaFile{ID: "1", Suffix: "wv", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 16} + probe := ffmpeg.AudioProbeResult{ + Codec: "wavpack", BitRate: 1000, SampleRate: 44100, BitDepth: 16, Channels: 2, + } + data, _ := json.Marshal(probe) + mf.ProbeData = string(data) + + ci := &ClientInfo{ + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP}, + }, + MaxTranscodingAudioBitrate: 256, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.SourceStream.IsLossless).To(BeTrue()) + Expect(decision.SourceStream.Codec).To(Equal("wavpack")) + // Lossless source transcoding to MP3 should use MaxTranscodingAudioBitrate + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TranscodeStream.Bitrate).To(Equal(256)) + }) + + It("detects lossy from probe codec name", func() { + mf := &model.MediaFile{ID: "1", Suffix: "ogg", BitRate: 192, Channels: 2, SampleRate: 48000} + probe := ffmpeg.AudioProbeResult{ + Codec: "vorbis", BitRate: 192, SampleRate: 48000, BitDepth: 0, Channels: 2, + } + data, _ := json.Marshal(probe) + mf.ProbeData = string(data) + + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"ogg"}, AudioCodecs: []string{"vorbis"}, Protocols: []string{ProtocolHTTP}}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.SourceStream.IsLossless).To(BeFalse()) + Expect(decision.CanDirectPlay).To(BeTrue()) + }) + }) + + Context("Opus fixed sample rate", func() { + It("sets Opus output to 48000Hz regardless of input", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 16}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 128, + TranscodingProfiles: []Profile{ + {Container: "opus", AudioCodec: "opus", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TargetFormat).To(Equal("opus")) + // Opus always outputs 48000Hz + Expect(decision.TranscodeStream.SampleRate).To(Equal(48000)) + Expect(decision.TargetSampleRate).To(Equal(48000)) + }) + + It("sets Opus output to 48000Hz even for 96kHz input", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1500, Channels: 2, SampleRate: 96000, BitDepth: 24}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 128, + TranscodingProfiles: []Profile{ + {Container: "opus", AudioCodec: "opus", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TranscodeStream.SampleRate).To(Equal(48000)) + }) + }) + + Context("Container vs format separation", func() { + It("preserves mp4 container when falling back to aac format", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 16}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 256, + TranscodingProfiles: []Profile{ + {Container: "mp4", AudioCodec: "aac", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + // TargetFormat is the internal format used for transcoding ("aac") + Expect(decision.TargetFormat).To(Equal("aac")) + // Container in the response preserves what the client asked ("mp4") + Expect(decision.TranscodeStream.Container).To(Equal("mp4")) + Expect(decision.TranscodeStream.Codec).To(Equal("aac")) + }) + + It("uses container as format when container matches transcoding config", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 16}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 256, + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TargetFormat).To(Equal("mp3")) + Expect(decision.TranscodeStream.Container).To(Equal("mp3")) + }) + }) + + Context("MP3 max sample rate", func() { + It("caps sample rate at 48000 for MP3", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1500, Channels: 2, SampleRate: 96000, BitDepth: 24}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 320, + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TranscodeStream.SampleRate).To(Equal(48000)) + }) + + It("preserves sample rate at 44100 for MP3", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 16}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 320, + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TranscodeStream.SampleRate).To(Equal(44100)) + }) + }) + + Context("AAC max sample rate", func() { + It("caps sample rate at 96000 for AAC", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "dsf", Codec: "DSD", BitRate: 5644, Channels: 2, SampleRate: 2822400, BitDepth: 1}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 320, + TranscodingProfiles: []Profile{ + {Container: "aac", AudioCodec: "aac", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + // DSD64 2822400 / 8 = 352800, capped by AAC max of 96000 + Expect(decision.TranscodeStream.SampleRate).To(Equal(96000)) + }) + }) + + Context("Typed transcode reasons from multiple profiles", func() { + It("collects reasons from each failed direct play profile", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "ogg", Codec: "Vorbis", BitRate: 128, Channels: 2, SampleRate: 48000}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"flac"}, Protocols: []string{ProtocolHTTP}}, + {Containers: []string{"mp3"}, AudioCodecs: []string{"mp3"}, Protocols: []string{ProtocolHTTP}}, + {Containers: []string{"m4a", "mp4"}, AudioCodecs: []string{"aac"}, Protocols: []string{ProtocolHTTP}}, + }, + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeFalse()) + Expect(decision.TranscodeReasons).To(HaveLen(3)) + Expect(decision.TranscodeReasons[0]).To(Equal("container not supported")) + Expect(decision.TranscodeReasons[1]).To(Equal("container not supported")) + Expect(decision.TranscodeReasons[2]).To(Equal("container not supported")) + }) + }) + + Context("Source stream details", func() { + It("populates source stream correctly with kbps bitrate", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 96000, BitDepth: 24, Duration: 300.5, Size: 50000000}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"flac"}, Protocols: []string{ProtocolHTTP}}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.SourceStream.Container).To(Equal("flac")) + Expect(decision.SourceStream.Codec).To(Equal("flac")) + Expect(decision.SourceStream.Bitrate).To(Equal(1000)) // kbps + Expect(decision.SourceStream.SampleRate).To(Equal(96000)) + Expect(decision.SourceStream.BitDepth).To(Equal(24)) + Expect(decision.SourceStream.Channels).To(Equal(2)) + }) + }) + + Context("Server-side player transcoding override", func() { + It("forces transcoding when override targets a different format", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100}) + ci := &ClientInfo{ + Name: "TestClient", + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"flac"}, Protocols: []string{ProtocolHTTP}}, + }, + } + // Set server override in context + overrideCtx := request.WithTranscoding(ctx, model.Transcoding{TargetFormat: "mp3", DefaultBitRate: 192}) + overrideCtx = request.WithPlayer(overrideCtx, model.Player{MaxBitRate: 0}) + + decision, err := svc.MakeDecision(overrideCtx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeFalse()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TargetFormat).To(Equal("mp3")) + Expect(decision.TargetBitrate).To(Equal(192)) + }) + + It("allows direct play when source matches forced format and bitrate is within cap", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "mp3", Codec: "MP3", BitRate: 128, Channels: 2, SampleRate: 44100}) + ci := &ClientInfo{ + Name: "TestClient", + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"flac"}, Protocols: []string{ProtocolHTTP}}, + }, + } + overrideCtx := request.WithTranscoding(ctx, model.Transcoding{TargetFormat: "mp3", DefaultBitRate: 256}) + + decision, err := svc.MakeDecision(overrideCtx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeTrue()) + Expect(decision.CanTranscode).To(BeFalse()) + }) + + It("transcodes when source bitrate exceeds the forced cap", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "mp3", Codec: "MP3", BitRate: 320, Channels: 2, SampleRate: 44100}) + ci := &ClientInfo{ + Name: "TestClient", + } + overrideCtx := request.WithTranscoding(ctx, model.Transcoding{TargetFormat: "mp3", DefaultBitRate: 192}) + + decision, err := svc.MakeDecision(overrideCtx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeFalse()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TargetFormat).To(Equal("mp3")) + Expect(decision.TargetBitrate).To(Equal(192)) + }) + + It("uses player MaxBitRate over transcoding DefaultBitRate", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100}) + ci := &ClientInfo{ + Name: "TestClient", + } + overrideCtx := request.WithTranscoding(ctx, model.Transcoding{TargetFormat: "mp3", DefaultBitRate: 192}) + overrideCtx = request.WithPlayer(overrideCtx, model.Player{MaxBitRate: 320}) + + decision, err := svc.MakeDecision(overrideCtx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TargetFormat).To(Equal("mp3")) + Expect(decision.TargetBitrate).To(Equal(320)) + }) + + It("applies no bitrate cap when both MaxBitRate and DefaultBitRate are 0", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100}) + ci := &ClientInfo{ + Name: "TestClient", + } + overrideCtx := request.WithTranscoding(ctx, model.Transcoding{TargetFormat: "mp3", DefaultBitRate: 0}) + overrideCtx = request.WithPlayer(overrideCtx, model.Player{MaxBitRate: 0}) + + decision, err := svc.MakeDecision(overrideCtx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TargetFormat).To(Equal("mp3")) + // With no cap, lossless→lossy uses format default bitrate (160 for mp3 from mock) + Expect(decision.TargetBitrate).To(Equal(160)) + }) + + It("does not apply override when no transcoding is in context", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100}) + ci := &ClientInfo{ + Name: "TestClient", + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"flac"}, Protocols: []string{ProtocolHTTP}}, + }, + } + // No override in context — client profiles used as-is + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeTrue()) + }) + + }) + + Context("Player MaxBitRate cap", func() { + It("applies player MaxBitRate cap when client has no limit", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 16}) + ci := &ClientInfo{ + Name: "TestClient", + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"flac", "mp3"}, AudioCodecs: []string{"flac", "mp3"}, Protocols: []string{ProtocolHTTP}}, + }, + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP}, + }, + } + playerCtx := request.WithPlayer(ctx, model.Player{MaxBitRate: 320}) + + decision, err := svc.MakeDecision(playerCtx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + // Source bitrate 1000 > player cap 320, so direct play is not possible + Expect(decision.CanDirectPlay).To(BeFalse()) + Expect(decision.CanTranscode).To(BeTrue()) + // Lossless→lossy should use MaxAudioBitrate (320) as target, not format default + Expect(decision.TargetBitrate).To(Equal(320)) + }) + + It("uses client limit when it is more restrictive than player MaxBitRate", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 16}) + ci := &ClientInfo{ + Name: "TestClient", + MaxAudioBitrate: 256, + MaxTranscodingAudioBitrate: 256, + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP}, + }, + } + playerCtx := request.WithPlayer(ctx, model.Player{MaxBitRate: 500}) + + decision, err := svc.MakeDecision(playerCtx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + // Client limit 256 < player cap 500, so player cap doesn't apply; client limit wins + Expect(decision.TargetBitrate).To(Equal(256)) + }) + + It("does not cap when player MaxBitRate is 0", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "mp3", Codec: "MP3", BitRate: 320, Channels: 2, SampleRate: 44100}) + ci := &ClientInfo{ + Name: "TestClient", + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"mp3"}, AudioCodecs: []string{"mp3"}, Protocols: []string{ProtocolHTTP}}, + }, + } + playerCtx := request.WithPlayer(ctx, model.Player{MaxBitRate: 0}) + + decision, err := svc.MakeDecision(playerCtx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeTrue()) + }) + }) + + Context("Format-aware default bitrate", func() { + It("uses opus default bitrate from DB", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 48000, BitDepth: 16}) + ci := &ClientInfo{ + TranscodingProfiles: []Profile{ + {Container: "opus", AudioCodec: "opus", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TargetBitrate).To(Equal(96)) // opus default from mock + }) + + It("uses aac default bitrate from DB", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 16}) + ci := &ClientInfo{ + TranscodingProfiles: []Profile{ + {Container: "aac", AudioCodec: "aac", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TargetBitrate).To(Equal(256)) // aac default from mock + }) + + It("falls back to 256 for unknown format", func() { + bitrate := lookupDefaultBitrate(ctx, ds, "xyz") + Expect(bitrate).To(Equal(fallbackBitrate)) + }) + }) + }) + + Describe("ensureProbed", func() { + var mockMFRepo *tests.MockMediaFileRepo + + BeforeEach(func() { + mockMFRepo = tests.CreateMockMediaFileRepo() + ds.MockedMediaFile = mockMFRepo + }) + + It("calls ffprobe and populates ProbeData when empty", func() { + mf := &model.MediaFile{ID: "probe-1", Suffix: "mp3", BitRate: 320, Channels: 2} + mockMFRepo.SetData(model.MediaFiles{*mf}) + + ff.ProbeAudioResult = &ffmpeg.AudioProbeResult{ + Codec: "mp3", BitRate: 320, SampleRate: 44100, Channels: 2, + } + + svc := NewTranscodeDecider(ds, ff).(*deciderService) + probe, err := svc.ensureProbed(ctx, mf) + Expect(err).ToNot(HaveOccurred()) + Expect(mf.ProbeData).ToNot(BeEmpty()) + Expect(probe).ToNot(BeNil()) + Expect(probe.Codec).To(Equal("mp3")) + Expect(probe.BitRate).To(Equal(320)) + Expect(probe.SampleRate).To(Equal(44100)) + Expect(probe.Channels).To(Equal(2)) + + // Verify persisted to DB + stored := mockMFRepo.Data["probe-1"] + Expect(stored.ProbeData).To(Equal(mf.ProbeData)) + }) + + It("skips ffprobe when ProbeData is already set", func() { + mf := withProbe(&model.MediaFile{ID: "probe-2", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2}) + + // Set error on mock — if ffprobe were called, this would fail + ff.Error = fmt.Errorf("should not be called") + + svc := NewTranscodeDecider(ds, ff).(*deciderService) + probe, err := svc.ensureProbed(ctx, mf) + Expect(err).ToNot(HaveOccurred()) + Expect(probe).To(BeNil()) + }) + + It("returns error when ffprobe fails", func() { + mf := &model.MediaFile{ID: "probe-3", Suffix: "mp3"} + ff.Error = fmt.Errorf("ffprobe not found") + + svc := NewTranscodeDecider(ds, ff).(*deciderService) + _, err := svc.ensureProbed(ctx, mf) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("probing media file")) + Expect(mf.ProbeData).To(BeEmpty()) + }) + + It("skips ffprobe when DevEnableMediaFileProbe is false", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.DevEnableMediaFileProbe = false + + mf := &model.MediaFile{ID: "probe-4", Suffix: "mp3"} + // Set a result — if ffprobe were called, ProbeData would be populated + ff.ProbeAudioResult = &ffmpeg.AudioProbeResult{Codec: "mp3"} + + svc := NewTranscodeDecider(ds, ff).(*deciderService) + probe, err := svc.ensureProbed(ctx, mf) + Expect(err).ToNot(HaveOccurred()) + Expect(probe).To(BeNil()) + Expect(mf.ProbeData).To(BeEmpty()) + }) + }) + +}) diff --git a/core/stream/legacy_client.go b/core/stream/legacy_client.go new file mode 100644 index 000000000..d6e929ec8 --- /dev/null +++ b/core/stream/legacy_client.go @@ -0,0 +1,101 @@ +package stream + +import ( + "context" + "strings" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" +) + +// buildLegacyClientInfo translates legacy Subsonic stream/download parameters +// into a ClientInfo for use with MakeDecision. +// It does NOT read request.TranscodingFrom(ctx) — that is handled by +// MakeDecision's applyServerOverride. +func buildLegacyClientInfo(mf *model.MediaFile, reqFormat string, reqBitRate int) *ClientInfo { + ci := &ClientInfo{Name: "legacy"} + + // Determine target format for transcoding + var targetFormat string + switch { + case reqFormat != "": + targetFormat = reqFormat + case reqBitRate > 0 && reqBitRate < mf.BitRate && conf.Server.DefaultDownsamplingFormat != "": + targetFormat = conf.Server.DefaultDownsamplingFormat + } + + if targetFormat != "" { + // Add a direct play profile for the source format when no explicit + // format was requested (bitrate-only downsampling) or when the + // requested format matches the source. When the client explicitly + // requests a different format, direct play must not match the + // source — otherwise the source is returned untranscoded. + if reqFormat == "" || strings.EqualFold(reqFormat, mf.Suffix) { + ci.DirectPlayProfiles = []DirectPlayProfile{ + {Containers: []string{mf.Suffix}, AudioCodecs: []string{mf.AudioCodec()}, Protocols: []string{ProtocolHTTP}}, + } + } + ci.TranscodingProfiles = []Profile{ + {Container: targetFormat, AudioCodec: targetFormat, Protocol: ProtocolHTTP}, + } + if reqBitRate > 0 { + ci.MaxAudioBitrate = reqBitRate + ci.MaxTranscodingAudioBitrate = reqBitRate + } + } else { + // No transcoding requested — direct play everything + ci.DirectPlayProfiles = []DirectPlayProfile{ + {Protocols: []string{ProtocolHTTP}}, + } + } + + return ci +} + +// ResolveRequest uses MakeDecision to resolve legacy Subsonic stream parameters +// into a fully specified Request. +func (s *deciderService) ResolveRequest(ctx context.Context, mf *model.MediaFile, reqFormat string, reqBitRate int, offset int) Request { + var req Request + req.Offset = offset + + if reqFormat == "raw" { + req.Format = "raw" + return req + } + + clientInfo := buildLegacyClientInfo(mf, reqFormat, reqBitRate) + decision, err := s.MakeDecision(ctx, mf, clientInfo, TranscodeOptions{SkipProbe: true}) + if err != nil { + log.Error(ctx, "Error making transcode decision, falling back to raw", "id", mf.ID, err) + req.Format = "raw" + return req + } + + if decision.CanDirectPlay { + req.Format = "raw" + return req + } + + if decision.CanTranscode { + req.Format = decision.TargetFormat + req.BitRate = decision.TargetBitrate + req.SampleRate = decision.TargetSampleRate + req.BitDepth = decision.TargetBitDepth + req.Channels = decision.TargetChannels + return req + } + + // No compatible profile for the requested format — retry with DefaultDownsamplingFormat + // TODO: validate DefaultDownsamplingFormat at startup to warn about unsupported values + fallbackFormat := conf.Server.DefaultDownsamplingFormat + if reqFormat != "" && fallbackFormat != "" && !strings.EqualFold(reqFormat, fallbackFormat) { + log.Warn(ctx, "Requested format not available, falling back to default downsampling format", + "requestedFormat", reqFormat, "fallbackFormat", fallbackFormat, "id", mf.ID) + return s.ResolveRequest(ctx, mf, fallbackFormat, reqBitRate, offset) + } + + // Ultimate fallback — raw + req.Format = "raw" + return req +} diff --git a/core/stream/legacy_client_test.go b/core/stream/legacy_client_test.go new file mode 100644 index 000000000..de1eb1339 --- /dev/null +++ b/core/stream/legacy_client_test.go @@ -0,0 +1,240 @@ +package stream + +import ( + "context" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("buildLegacyClientInfo", func() { + var mf *model.MediaFile + + BeforeEach(func() { + mf = &model.MediaFile{Suffix: "flac", BitRate: 960} + }) + + It("sets transcoding profile for explicit format without bitrate", func() { + ci := buildLegacyClientInfo(mf, "mp3", 0) + + Expect(ci.Name).To(Equal("legacy")) + Expect(ci.TranscodingProfiles).To(HaveLen(1)) + Expect(ci.TranscodingProfiles[0].Container).To(Equal("mp3")) + Expect(ci.TranscodingProfiles[0].AudioCodec).To(Equal("mp3")) + Expect(ci.TranscodingProfiles[0].Protocol).To(Equal(ProtocolHTTP)) + Expect(ci.MaxAudioBitrate).To(BeZero()) + Expect(ci.MaxTranscodingAudioBitrate).To(BeZero()) + Expect(ci.DirectPlayProfiles).To(BeEmpty()) + }) + + It("does not add direct play profile when explicit format differs from source (no bitrate)", func() { + ci := buildLegacyClientInfo(mf, "opus", 0) + + Expect(ci.TranscodingProfiles).To(HaveLen(1)) + Expect(ci.TranscodingProfiles[0].Container).To(Equal("opus")) + Expect(ci.DirectPlayProfiles).To(BeEmpty()) + }) + + It("adds direct play profile when explicit format matches source format", func() { + ci := buildLegacyClientInfo(mf, "flac", 0) + + Expect(ci.TranscodingProfiles).To(HaveLen(1)) + Expect(ci.TranscodingProfiles[0].Container).To(Equal("flac")) + Expect(ci.DirectPlayProfiles).To(HaveLen(1)) + Expect(ci.DirectPlayProfiles[0].Containers).To(Equal([]string{"flac"})) + Expect(ci.DirectPlayProfiles[0].AudioCodecs).To(Equal([]string{mf.AudioCodec()})) + }) + + It("sets transcoding profile and bitrate for explicit format with bitrate", func() { + ci := buildLegacyClientInfo(mf, "mp3", 192) + + Expect(ci.TranscodingProfiles).To(HaveLen(1)) + Expect(ci.TranscodingProfiles[0].Container).To(Equal("mp3")) + Expect(ci.TranscodingProfiles[0].AudioCodec).To(Equal("mp3")) + Expect(ci.MaxAudioBitrate).To(Equal(192)) + Expect(ci.MaxTranscodingAudioBitrate).To(Equal(192)) + Expect(ci.DirectPlayProfiles).To(BeEmpty()) + }) + + It("returns direct play profile when no format and no bitrate", func() { + ci := buildLegacyClientInfo(mf, "", 0) + + Expect(ci.DirectPlayProfiles).To(HaveLen(1)) + Expect(ci.DirectPlayProfiles[0].Containers).To(BeEmpty()) + Expect(ci.DirectPlayProfiles[0].AudioCodecs).To(BeEmpty()) + Expect(ci.DirectPlayProfiles[0].Protocols).To(Equal([]string{ProtocolHTTP})) + Expect(ci.TranscodingProfiles).To(BeEmpty()) + Expect(ci.MaxAudioBitrate).To(BeZero()) + }) + + It("uses default downsampling format for bitrate-only downsampling", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.DefaultDownsamplingFormat = "opus" + + ci := buildLegacyClientInfo(mf, "", 128) + + Expect(ci.TranscodingProfiles).To(HaveLen(1)) + Expect(ci.TranscodingProfiles[0].Container).To(Equal("opus")) + Expect(ci.TranscodingProfiles[0].AudioCodec).To(Equal("opus")) + Expect(ci.TranscodingProfiles[0].Protocol).To(Equal(ProtocolHTTP)) + Expect(ci.MaxAudioBitrate).To(Equal(128)) + Expect(ci.MaxTranscodingAudioBitrate).To(Equal(128)) + Expect(ci.DirectPlayProfiles).To(HaveLen(1)) + Expect(ci.DirectPlayProfiles[0].Containers).To(Equal([]string{"flac"})) + Expect(ci.DirectPlayProfiles[0].AudioCodecs).To(Equal([]string{mf.AudioCodec()})) + }) + + It("returns direct play when bitrate >= source bitrate", func() { + ci := buildLegacyClientInfo(mf, "", 960) + + Expect(ci.DirectPlayProfiles).To(HaveLen(1)) + Expect(ci.DirectPlayProfiles[0].Containers).To(BeEmpty()) + Expect(ci.DirectPlayProfiles[0].AudioCodecs).To(BeEmpty()) + Expect(ci.DirectPlayProfiles[0].Protocols).To(Equal([]string{ProtocolHTTP})) + Expect(ci.TranscodingProfiles).To(BeEmpty()) + Expect(ci.MaxAudioBitrate).To(BeZero()) + }) +}) + +var _ = Describe("ResolveRequest", func() { + var ( + svc TranscodeDecider + ctx context.Context + ) + + BeforeEach(func() { + ctx = GinkgoT().Context() + ds := &tests.MockDataStore{ + MockedProperty: &tests.MockedPropertyRepo{}, + MockedTranscoding: &tests.MockTranscodingRepo{}, + } + ff := tests.NewMockFFmpeg("") + auth.Init(ds) + svc = NewTranscodeDecider(ds, ff) + }) + + It("returns raw when format is 'raw'", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "mp3", Codec: "MP3", BitRate: 320, Channels: 2, SampleRate: 44100}) + + decider := svc.(*deciderService) + req := decider.ResolveRequest(ctx, mf, "raw", 0, 0) + + Expect(req.Format).To(Equal("raw")) + }) + + It("returns raw (direct play) when no format or bitrate specified", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "mp3", Codec: "MP3", BitRate: 320, Channels: 2, SampleRate: 44100}) + + decider := svc.(*deciderService) + req := decider.ResolveRequest(ctx, mf, "", 0, 0) + + Expect(req.Format).To(Equal("raw")) + }) + + It("transcodes to requested format", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 16}) + + decider := svc.(*deciderService) + req := decider.ResolveRequest(ctx, mf, "opus", 0, 0) + + Expect(req.Format).To(Equal("opus")) + }) + + It("transcodes to requested format with bitrate limit", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 16}) + + decider := svc.(*deciderService) + req := decider.ResolveRequest(ctx, mf, "mp3", 128, 0) + + Expect(req.Format).To(Equal("mp3")) + Expect(req.BitRate).To(Equal(128)) + }) + + It("returns raw when requested format matches source and no bitrate reduction", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "mp3", Codec: "MP3", BitRate: 320, Channels: 2, SampleRate: 44100}) + + decider := svc.(*deciderService) + req := decider.ResolveRequest(ctx, mf, "mp3", 320, 0) + + Expect(req.Format).To(Equal("raw")) + }) + + It("downsamples when only bitrate is specified below source", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.DefaultDownsamplingFormat = "opus" + + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 16}) + + decider := svc.(*deciderService) + req := decider.ResolveRequest(ctx, mf, "", 128, 0) + + Expect(req.Format).To(Equal("opus")) + Expect(req.BitRate).To(Equal(128)) + }) + + It("passes offset through", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 16}) + + decider := svc.(*deciderService) + req := decider.ResolveRequest(ctx, mf, "opus", 128, 30) + + Expect(req.Format).To(Equal("opus")) + Expect(req.Offset).To(Equal(30)) + }) + + Context("fallback for unknown format", func() { + It("falls back to DefaultDownsamplingFormat", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.DefaultDownsamplingFormat = "opus" + + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "mp3", Codec: "MP3", BitRate: 320, Channels: 2, SampleRate: 44100}) + + decider := svc.(*deciderService) + req := decider.ResolveRequest(ctx, mf, "xyz", 0, 0) + + Expect(req.Format).To(Equal("opus")) + }) + + It("falls back to raw when DefaultDownsamplingFormat is empty", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.DefaultDownsamplingFormat = "" + + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "mp3", Codec: "MP3", BitRate: 320, Channels: 2, SampleRate: 44100}) + + decider := svc.(*deciderService) + req := decider.ResolveRequest(ctx, mf, "xyz", 0, 0) + + Expect(req.Format).To(Equal("raw")) + }) + + It("falls back to raw when DefaultDownsamplingFormat is also invalid", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.DefaultDownsamplingFormat = "xyz" + + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "mp3", Codec: "MP3", BitRate: 320, Channels: 2, SampleRate: 44100}) + + decider := svc.(*deciderService) + req := decider.ResolveRequest(ctx, mf, "xyz", 0, 0) + + Expect(req.Format).To(Equal("raw")) + }) + + It("preserves bitrate when falling back to DefaultDownsamplingFormat", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.DefaultDownsamplingFormat = "opus" + + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 16}) + + decider := svc.(*deciderService) + req := decider.ResolveRequest(ctx, mf, "xyz", 128, 0) + + Expect(req.Format).To(Equal("opus")) + Expect(req.BitRate).To(Equal(128)) + }) + }) +}) diff --git a/core/stream/limitations.go b/core/stream/limitations.go new file mode 100644 index 000000000..ab70d6c07 --- /dev/null +++ b/core/stream/limitations.go @@ -0,0 +1,171 @@ +package stream + +import ( + "strconv" + "strings" +) + +// adjustResult represents the outcome of applying a limitation to a transcoded stream value +type adjustResult int + +const ( + adjustNone adjustResult = iota // Value already satisfies the limitation + adjustAdjusted // Value was changed to fit the limitation + adjustCannotFit // Cannot satisfy the limitation (reject this profile) +) + +// checkLimitations checks codec profile limitations against source stream details. +// Returns "" if all limitations pass, or a typed reason string for the first failure. +func checkLimitations(src *Details, limitations []Limitation) string { + for _, lim := range limitations { + var ok bool + var reason string + + switch lim.Name { + case LimitationAudioChannels: + ok = checkIntLimitation(src.Channels, lim.Comparison, lim.Values) + reason = "audio channels not supported" + case LimitationAudioSamplerate: + ok = checkIntLimitation(src.SampleRate, lim.Comparison, lim.Values) + reason = "audio samplerate not supported" + case LimitationAudioBitrate: + ok = checkIntLimitation(src.Bitrate, lim.Comparison, lim.Values) + reason = "audio bitrate not supported" + case LimitationAudioBitdepth: + ok = checkIntLimitation(src.BitDepth, lim.Comparison, lim.Values) + reason = "audio bitdepth not supported" + case LimitationAudioProfile: + ok = checkStringLimitation(src.Profile, lim.Comparison, lim.Values) + reason = "audio profile not supported" + default: + continue + } + + if !ok && lim.Required { + return reason + } + } + return "" +} + +// applyLimitation adjusts a transcoded stream parameter to satisfy the limitation. +// Returns the adjustment result. +func applyLimitation(sourceBitrate int, lim *Limitation, ts *Details) adjustResult { + switch lim.Name { + case LimitationAudioChannels: + return applyIntLimitation(lim.Comparison, lim.Values, ts.Channels, func(v int) { ts.Channels = v }) + case LimitationAudioBitrate: + current := ts.Bitrate + if current == 0 { + current = sourceBitrate + } + return applyIntLimitation(lim.Comparison, lim.Values, current, func(v int) { ts.Bitrate = v }) + case LimitationAudioSamplerate: + return applyIntLimitation(lim.Comparison, lim.Values, ts.SampleRate, func(v int) { ts.SampleRate = v }) + case LimitationAudioBitdepth: + if ts.BitDepth > 0 { + return applyIntLimitation(lim.Comparison, lim.Values, ts.BitDepth, func(v int) { ts.BitDepth = v }) + } + case LimitationAudioProfile: + // TODO: implement when audio profile data is available + } + return adjustNone +} + +// applyIntLimitation applies a limitation comparison to a value. +// If the value needs adjusting, calls the setter and returns the result. +func applyIntLimitation(comparison string, values []string, current int, setter func(int)) adjustResult { + if len(values) == 0 { + return adjustNone + } + + switch comparison { + case ComparisonLessThanEqual: + limit, ok := parseInt(values[0]) + if !ok { + return adjustNone + } + if current <= limit { + return adjustNone + } + setter(limit) + return adjustAdjusted + case ComparisonGreaterThanEqual: + limit, ok := parseInt(values[0]) + if !ok { + return adjustNone + } + if current >= limit { + return adjustNone + } + // Cannot upscale + return adjustCannotFit + case ComparisonEquals: + // Check if current value matches any allowed value + for _, v := range values { + if limit, ok := parseInt(v); ok && current == limit { + return adjustNone + } + } + // Find the closest allowed value below current (don't upscale) + var closest int + found := false + for _, v := range values { + if limit, ok := parseInt(v); ok && limit < current { + if !found || limit > closest { + closest = limit + found = true + } + } + } + if found { + setter(closest) + return adjustAdjusted + } + return adjustCannotFit + case ComparisonNotEquals: + for _, v := range values { + if limit, ok := parseInt(v); ok && current == limit { + return adjustCannotFit + } + } + return adjustNone + } + + return adjustNone +} + +func checkIntLimitation(value int, comparison string, values []string) bool { + return applyIntLimitation(comparison, values, value, func(int) {}) == adjustNone +} + +// checkStringLimitation checks a string value against a limitation. +// Only Equals and NotEquals comparisons are meaningful for strings. +// LessThanEqual/GreaterThanEqual are not applicable and always pass. +func checkStringLimitation(value string, comparison string, values []string) bool { + switch comparison { + case ComparisonEquals: + for _, v := range values { + if strings.EqualFold(value, v) { + return true + } + } + return false + case ComparisonNotEquals: + for _, v := range values { + if strings.EqualFold(value, v) { + return false + } + } + return true + } + return true +} + +func parseInt(s string) (int, bool) { + v, err := strconv.Atoi(s) + if err != nil || v < 0 { + return 0, false + } + return v, true +} diff --git a/core/stream/media_streamer.go b/core/stream/media_streamer.go new file mode 100644 index 000000000..de03b4d2f --- /dev/null +++ b/core/stream/media_streamer.go @@ -0,0 +1,257 @@ +package stream + +import ( + "context" + "fmt" + "io" + "mime" + "net/http" + "os" + "strconv" + "sync" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/core/ffmpeg" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/utils/cache" + "github.com/navidrome/navidrome/utils/req" +) + +type MediaStreamer interface { + NewStream(ctx context.Context, mf *model.MediaFile, req Request) (*Stream, error) +} + +type TranscodingCache cache.FileCache + +func NewMediaStreamer(ds model.DataStore, t ffmpeg.FFmpeg, cache TranscodingCache) MediaStreamer { + return &mediaStreamer{ds: ds, transcoder: t, cache: cache} +} + +type mediaStreamer struct { + ds model.DataStore + transcoder ffmpeg.FFmpeg + cache cache.FileCache +} + +type streamJob struct { + ms *mediaStreamer + mf *model.MediaFile + filePath string + format string + bitRate int + sampleRate int + bitDepth int + channels int + offset int +} + +func (j *streamJob) Key() string { + return fmt.Sprintf("%s.%s.%d.%d.%d.%d.%s.%d", j.mf.ID, j.mf.UpdatedAt.Format(time.RFC3339Nano), j.bitRate, j.sampleRate, j.bitDepth, j.channels, j.format, j.offset) +} + +// NewStream creates a Stream for the given MediaFile and Request. It handles both raw streaming (no transcoding) +// and transcoded streaming based on the requested format and bitrate. It also logs detailed information about +// the streaming request and whether the transcoding result was served from cache or not. +func (ms *mediaStreamer) NewStream(ctx context.Context, mf *model.MediaFile, req Request) (*Stream, error) { + var format string + var bitRate int + var cached bool + defer func() { + log.Info(ctx, "Streaming file", "title", mf.Title, "artist", mf.Artist, "format", format, "cached", cached, + "bitRate", bitRate, "sampleRate", req.SampleRate, "bitDepth", req.BitDepth, "channels", req.Channels, + "user", userName(ctx), "transcoding", format != "raw", + "originalFormat", mf.Suffix, "originalBitRate", mf.BitRate) + }() + + format = req.Format + bitRate = req.BitRate + if format == "" || format == "raw" { + format = "raw" + bitRate = 0 + } + s := &Stream{ctx: ctx, mf: mf, format: format, bitRate: bitRate} + filePath := mf.AbsolutePath() + + if format == "raw" { + log.Debug(ctx, "Streaming RAW file", "id", mf.ID, "path", filePath, + "requestBitrate", req.BitRate, "requestFormat", req.Format, "requestOffset", req.Offset, + "originalBitrate", mf.BitRate, "originalFormat", mf.Suffix, + "selectedBitrate", bitRate, "selectedFormat", format) + f, err := os.Open(filePath) + if err != nil { + return nil, err + } + s.ReadCloser = f + s.Seeker = f + s.format = mf.Suffix + return s, nil + } + + job := &streamJob{ + ms: ms, + mf: mf, + filePath: filePath, + format: format, + bitRate: bitRate, + sampleRate: req.SampleRate, + bitDepth: req.BitDepth, + channels: req.Channels, + offset: req.Offset, + } + r, err := ms.cache.Get(ctx, job) + if err != nil { + log.Error(ctx, "Error accessing transcoding cache", "id", mf.ID, err) + return nil, err + } + cached = r.Cached + + s.ReadCloser = r + s.Seeker = r.Seeker + + log.Debug(ctx, "Streaming TRANSCODED file", "id", mf.ID, "path", filePath, + "requestBitrate", req.BitRate, "requestFormat", req.Format, "requestOffset", req.Offset, + "originalBitrate", mf.BitRate, "originalFormat", mf.Suffix, + "selectedBitrate", bitRate, "selectedFormat", format, "cached", cached, "seekable", s.Seekable()) + + return s, nil +} + +type Stream struct { + ctx context.Context + mf *model.MediaFile + bitRate int + format string + io.ReadCloser + io.Seeker +} + +func (s *Stream) Seekable() bool { return s.Seeker != nil } +func (s *Stream) Duration() float32 { return s.mf.Duration } +func (s *Stream) ContentType() string { return mime.TypeByExtension("." + s.format) } +func (s *Stream) Name() string { return s.mf.Title + "." + s.format } +func (s *Stream) ModTime() time.Time { return s.mf.UpdatedAt } +func (s *Stream) EstimatedContentLength() int { + return int(s.mf.Duration * float32(s.bitRate) / 8 * 1024) +} + +// Serve writes the stream to the HTTP response. For seekable streams it uses http.ServeContent +// (supporting range requests). For non-seekable streams it writes directly and logs any errors. +// Returns the number of bytes written and an error only when io.Copy fails with 0 bytes written +// (meaning the HTTP 200 status has not been flushed yet and the caller can still send an error response). +// Empty output (0 bytes, no error) is logged but not treated as an error. +func (s *Stream) Serve(ctx context.Context, w http.ResponseWriter, r *http.Request) (int64, error) { + if s.Seekable() { + http.ServeContent(w, r, s.Name(), s.ModTime(), s) + return -1, nil + } + + w.Header().Set("Accept-Ranges", "none") + w.Header().Set("Content-Type", s.ContentType()) + + if req.Params(r).BoolOr("estimateContentLength", false) { + length := strconv.Itoa(s.EstimatedContentLength()) + log.Trace(ctx, "Estimated content-length", "contentLength", length) + w.Header().Set("Content-Length", length) + } + + if r.Method == http.MethodHead { + go func() { _, _ = io.Copy(io.Discard, s) }() + return 0, nil + } + + id := s.mf.ID + c, err := io.Copy(w, s) + if err != nil { + log.Error(ctx, "Error sending transcoded file", "id", id, err) + if c == 0 { + w.Header().Del("Content-Length") + return 0, fmt.Errorf("sending transcoded file: %w", err) + } + return c, nil + } + if c == 0 { + log.Error(ctx, "Transcoding returned empty output, ffmpeg may have failed. "+ + "Check that ffmpeg supports the requested codec. Enable Trace logging for ffmpeg stderr details", + "id", id, "format", s.ContentType()) + } else { + log.Trace(ctx, "Success sending transcoded file", "id", id, "size", c) + } + return c, nil +} + +// NewStream creates a non-seekable Stream from the given components. +func NewStream(mf *model.MediaFile, format string, bitRate int, r io.ReadCloser) *Stream { + return &Stream{ + ctx: context.Background(), + mf: mf, + format: format, + bitRate: bitRate, + ReadCloser: r, + } +} + +var ( + onceTranscodingCache sync.Once + instanceTranscodingCache TranscodingCache +) + +func GetTranscodingCache() TranscodingCache { + onceTranscodingCache.Do(func() { + instanceTranscodingCache = NewTranscodingCache() + }) + return instanceTranscodingCache +} + +func NewTranscodingCache() TranscodingCache { + return cache.NewFileCache("Transcoding", conf.Server.TranscodingCacheSize, + consts.TranscodingCacheDir, consts.DefaultTranscodingCacheMaxItems, + func(ctx context.Context, arg cache.Item) (io.Reader, error) { + job := arg.(*streamJob) + command := LookupTranscodeCommand(ctx, job.ms.ds, job.format) + if command == "" { + log.Error(ctx, "No transcoding command available", "format", job.format) + return nil, os.ErrInvalid + } + + // Choose the appropriate context based on EnableTranscodingCancellation configuration. + // This is where we decide whether transcoding processes should be cancellable or not. + var transcodingCtx context.Context + if conf.Server.EnableTranscodingCancellation { + // Use the request context directly, allowing cancellation when client disconnects + transcodingCtx = ctx + } else { + // Use background context with request values preserved. + // This prevents cancellation but maintains request metadata (user, client, etc.) + transcodingCtx = request.AddValues(context.Background(), ctx) + } + + out, err := job.ms.transcoder.Transcode(transcodingCtx, ffmpeg.TranscodeOptions{ + Command: command, + Format: job.format, + FilePath: job.filePath, + BitRate: job.bitRate, + SampleRate: job.sampleRate, + BitDepth: job.bitDepth, + Channels: job.channels, + Offset: job.offset, + }) + if err != nil { + log.Error(ctx, "Error starting transcoder", "id", job.mf.ID, err) + return nil, os.ErrInvalid + } + return out, nil + }) +} + +// userName extracts the username from the context for logging purposes. +func userName(ctx context.Context) string { + if user, ok := request.UserFrom(ctx); !ok { + return "UNKNOWN" + } else { + return user.UserName + } +} diff --git a/core/media_streamer_test.go b/core/stream/media_streamer_test.go similarity index 70% rename from core/media_streamer_test.go rename to core/stream/media_streamer_test.go index f5175495b..1bc21e239 100644 --- a/core/media_streamer_test.go +++ b/core/stream/media_streamer_test.go @@ -1,4 +1,4 @@ -package core_test +package stream_test import ( "context" @@ -7,7 +7,7 @@ import ( "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/conf/configtest" - "github.com/navidrome/navidrome/core" + "github.com/navidrome/navidrome/core/stream" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/tests" @@ -16,7 +16,7 @@ import ( ) var _ = Describe("MediaStreamer", func() { - var streamer core.MediaStreamer + var streamer stream.MediaStreamer var ds model.DataStore ffmpeg := tests.NewMockFFmpeg("fake data") ctx := log.NewContext(context.TODO()) @@ -29,44 +29,45 @@ var _ = Describe("MediaStreamer", func() { ds.MediaFile(ctx).(*tests.MockMediaFileRepo).SetData(model.MediaFiles{ {ID: "123", Path: "tests/fixtures/test.mp3", Suffix: "mp3", BitRate: 128, Duration: 257.0}, }) - testCache := core.NewTranscodingCache() + testCache := stream.NewTranscodingCache() Eventually(func() bool { return testCache.Available(context.TODO()) }).Should(BeTrue()) - streamer = core.NewMediaStreamer(ds, ffmpeg, testCache) + streamer = stream.NewMediaStreamer(ds, ffmpeg, testCache) }) AfterEach(func() { _ = os.RemoveAll(conf.Server.CacheFolder) }) Context("NewStream", func() { + var mf *model.MediaFile + BeforeEach(func() { + var err error + mf, err = ds.MediaFile(ctx).Get("123") + Expect(err).ToNot(HaveOccurred()) + }) It("returns a seekable stream if format is 'raw'", func() { - s, err := streamer.NewStream(ctx, "123", "raw", 0, 0) + s, err := streamer.NewStream(ctx, mf, stream.Request{Format: "raw"}) Expect(err).ToNot(HaveOccurred()) Expect(s.Seekable()).To(BeTrue()) }) - It("returns a seekable stream if maxBitRate is 0", func() { - s, err := streamer.NewStream(ctx, "123", "mp3", 0, 0) - Expect(err).ToNot(HaveOccurred()) - Expect(s.Seekable()).To(BeTrue()) - }) - It("returns a seekable stream if maxBitRate is higher than file bitRate", func() { - s, err := streamer.NewStream(ctx, "123", "mp3", 320, 0) + It("returns a seekable stream if no format is specified (direct play)", func() { + s, err := streamer.NewStream(ctx, mf, stream.Request{}) Expect(err).ToNot(HaveOccurred()) Expect(s.Seekable()).To(BeTrue()) }) It("returns a NON seekable stream if transcode is required", func() { - s, err := streamer.NewStream(ctx, "123", "mp3", 64, 0) + s, err := streamer.NewStream(ctx, mf, stream.Request{Format: "mp3", BitRate: 64}) Expect(err).To(BeNil()) Expect(s.Seekable()).To(BeFalse()) Expect(s.Duration()).To(Equal(float32(257.0))) }) It("returns a seekable stream if the file is complete in the cache", func() { - s, err := streamer.NewStream(ctx, "123", "mp3", 32, 0) + s, err := streamer.NewStream(ctx, mf, stream.Request{Format: "mp3", BitRate: 32}) Expect(err).To(BeNil()) _, _ = io.ReadAll(s) _ = s.Close() Eventually(func() bool { return ffmpeg.IsClosed() }, "3s").Should(BeTrue()) - s, err = streamer.NewStream(ctx, "123", "mp3", 32, 0) + s, err = streamer.NewStream(ctx, mf, stream.Request{Format: "mp3", BitRate: 32}) Expect(err).To(BeNil()) Expect(s.Seekable()).To(BeTrue()) }) diff --git a/core/agents/spotify/spotify_suite_test.go b/core/stream/stream_suite_test.go similarity index 74% rename from core/agents/spotify/spotify_suite_test.go rename to core/stream/stream_suite_test.go index 275b05e73..36e9e7f43 100644 --- a/core/agents/spotify/spotify_suite_test.go +++ b/core/stream/stream_suite_test.go @@ -1,4 +1,4 @@ -package spotify +package stream import ( "testing" @@ -9,9 +9,9 @@ import ( . "github.com/onsi/gomega" ) -func TestSpotify(t *testing.T) { +func TestStream(t *testing.T) { tests.Init(t, false) log.SetLevel(log.LevelFatal) RegisterFailHandler(Fail) - RunSpecs(t, "Spotify Test Suite") + RunSpecs(t, "Stream Suite") } diff --git a/core/stream/token.go b/core/stream/token.go new file mode 100644 index 000000000..24a154b54 --- /dev/null +++ b/core/stream/token.go @@ -0,0 +1,148 @@ +package stream + +import ( + "context" + "errors" + "fmt" + "time" + + "github.com/lestrrat-go/jwx/v3/jwt" + "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" +) + +const tokenTTL = 48 * time.Hour + +// params contains the parameters extracted from a transcode token. +// TargetBitrate is in kilobits per second (kbps). +type params struct { + MediaID string + DirectPlay bool + TargetFormat string + TargetBitrate int + TargetChannels int + TargetSampleRate int + TargetBitDepth int + SourceUpdatedAt time.Time +} + +// toClaimsMap converts a Decision into a JWT claims map for token encoding. +// Only non-zero transcode fields are included. +func (d *TranscodeDecision) toClaimsMap() map[string]any { + m := map[string]any{ + "mid": d.MediaID, + "ua": d.SourceUpdatedAt.Truncate(time.Second).Unix(), + jwt.ExpirationKey: time.Now().Add(tokenTTL).UTC().Unix(), + } + if d.CanDirectPlay { + m["dp"] = true + } + if d.CanTranscode && d.TargetFormat != "" { + m["f"] = d.TargetFormat + if d.TargetBitrate != 0 { + m["b"] = d.TargetBitrate + } + if d.TargetChannels != 0 { + m["ch"] = d.TargetChannels + } + if d.TargetSampleRate != 0 { + m["sr"] = d.TargetSampleRate + } + if d.TargetBitDepth != 0 { + m["bd"] = d.TargetBitDepth + } + } + return m +} + +// paramsFromToken extracts and validates Params from a parsed JWT token. +// Returns an error if required claims (media ID, source timestamp) are missing. +func paramsFromToken(token jwt.Token) (*params, error) { + var p params + var mid string + if err := token.Get("mid", &mid); err == nil { + p.MediaID = mid + } + if p.MediaID == "" { + return nil, fmt.Errorf("%w: missing media ID", ErrTokenInvalid) + } + + var dp bool + if err := token.Get("dp", &dp); err == nil { + p.DirectPlay = dp + } + + ua := getIntClaim(token, "ua") + if ua != 0 { + p.SourceUpdatedAt = time.Unix(int64(ua), 0) + } + if p.SourceUpdatedAt.IsZero() { + return nil, fmt.Errorf("%w: missing source timestamp", ErrTokenInvalid) + } + + var f string + if err := token.Get("f", &f); err == nil { + p.TargetFormat = f + } + p.TargetBitrate = getIntClaim(token, "b") + p.TargetChannels = getIntClaim(token, "ch") + p.TargetSampleRate = getIntClaim(token, "sr") + p.TargetBitDepth = getIntClaim(token, "bd") + return &p, nil +} + +// getIntClaim extracts an int claim from a JWT token, handling the case where +// the value may be stored as int64 or float64 (common in JSON-based JWT libraries). +func getIntClaim(token jwt.Token, key string) int { + var v int + if err := token.Get(key, &v); err == nil { + return v + } + var v64 int64 + if err := token.Get(key, &v64); err == nil { + return int(v64) + } + var f float64 + if err := token.Get(key, &f); err == nil { + return int(f) + } + return 0 +} + +func (s *deciderService) CreateTranscodeParams(decision *TranscodeDecision) (string, error) { + return auth.EncodeToken(decision.toClaimsMap()) +} + +func (s *deciderService) parseTranscodeParams(tokenStr string) (*params, error) { + token, err := auth.DecodeAndVerifyToken(tokenStr) + if err != nil { + return nil, err + } + return paramsFromToken(token) +} + +func (s *deciderService) ResolveRequestFromToken(ctx context.Context, token string, mf *model.MediaFile, offset int) (Request, error) { + p, err := s.parseTranscodeParams(token) + if err != nil { + return Request{}, errors.Join(ErrTokenInvalid, err) + } + if p.MediaID != mf.ID { + return Request{}, fmt.Errorf("%w: token mediaID %q does not match %q", ErrTokenInvalid, p.MediaID, mf.ID) + } + if !mf.UpdatedAt.Truncate(time.Second).Equal(p.SourceUpdatedAt) { + log.Info(ctx, "Transcode token is stale", "mediaID", mf.ID, + "tokenUpdatedAt", p.SourceUpdatedAt, "fileUpdatedAt", mf.UpdatedAt) + return Request{}, ErrTokenStale + } + + req := Request{Offset: offset} + if !p.DirectPlay && p.TargetFormat != "" { + req.Format = p.TargetFormat + req.BitRate = p.TargetBitrate + req.SampleRate = p.TargetSampleRate + req.BitDepth = p.TargetBitDepth + req.Channels = p.TargetChannels + } + return req, nil +} diff --git a/core/stream/token_test.go b/core/stream/token_test.go new file mode 100644 index 000000000..7409a7532 --- /dev/null +++ b/core/stream/token_test.go @@ -0,0 +1,256 @@ +package stream + +import ( + "context" + "time" + + "github.com/go-chi/jwtauth/v5" + "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Token", func() { + var ( + ds *tests.MockDataStore + ff *tests.MockFFmpeg + svc TranscodeDecider + ctx context.Context + ) + + BeforeEach(func() { + ctx = GinkgoT().Context() + ds = &tests.MockDataStore{ + MockedProperty: &tests.MockedPropertyRepo{}, + MockedTranscoding: &tests.MockTranscodingRepo{}, + } + ff = tests.NewMockFFmpeg("") + auth.Init(ds) + svc = NewTranscodeDecider(ds, ff) + }) + + Describe("Token round-trip", func() { + var ( + sourceTime time.Time + impl *deciderService + ) + + BeforeEach(func() { + sourceTime = time.Date(2025, 6, 15, 10, 30, 0, 0, time.UTC) + impl = svc.(*deciderService) + }) + + It("creates and parses a direct play token", func() { + decision := &TranscodeDecision{ + MediaID: "media-123", + CanDirectPlay: true, + SourceUpdatedAt: sourceTime, + } + token, err := svc.CreateTranscodeParams(decision) + Expect(err).ToNot(HaveOccurred()) + Expect(token).ToNot(BeEmpty()) + + params, err := impl.parseTranscodeParams(token) + Expect(err).ToNot(HaveOccurred()) + Expect(params.MediaID).To(Equal("media-123")) + Expect(params.DirectPlay).To(BeTrue()) + Expect(params.TargetFormat).To(BeEmpty()) + Expect(params.SourceUpdatedAt.Unix()).To(Equal(sourceTime.Unix())) + }) + + It("creates and parses a transcode token with kbps bitrate", func() { + decision := &TranscodeDecision{ + MediaID: "media-456", + CanDirectPlay: false, + CanTranscode: true, + TargetFormat: "mp3", + TargetBitrate: 256, // kbps + TargetChannels: 2, + SourceUpdatedAt: sourceTime, + } + token, err := svc.CreateTranscodeParams(decision) + Expect(err).ToNot(HaveOccurred()) + + params, err := impl.parseTranscodeParams(token) + Expect(err).ToNot(HaveOccurred()) + Expect(params.MediaID).To(Equal("media-456")) + Expect(params.DirectPlay).To(BeFalse()) + Expect(params.TargetFormat).To(Equal("mp3")) + Expect(params.TargetBitrate).To(Equal(256)) // kbps + Expect(params.TargetChannels).To(Equal(2)) + Expect(params.SourceUpdatedAt.Unix()).To(Equal(sourceTime.Unix())) + }) + + It("creates and parses a transcode token with sample rate", func() { + decision := &TranscodeDecision{ + MediaID: "media-789", + CanDirectPlay: false, + CanTranscode: true, + TargetFormat: "flac", + TargetBitrate: 0, + TargetChannels: 2, + TargetSampleRate: 48000, + SourceUpdatedAt: sourceTime, + } + token, err := svc.CreateTranscodeParams(decision) + Expect(err).ToNot(HaveOccurred()) + + params, err := impl.parseTranscodeParams(token) + Expect(err).ToNot(HaveOccurred()) + Expect(params.MediaID).To(Equal("media-789")) + Expect(params.DirectPlay).To(BeFalse()) + Expect(params.TargetFormat).To(Equal("flac")) + Expect(params.TargetSampleRate).To(Equal(48000)) + Expect(params.TargetChannels).To(Equal(2)) + }) + + It("creates and parses a transcode token with bit depth", func() { + decision := &TranscodeDecision{ + MediaID: "media-bd", + CanDirectPlay: false, + CanTranscode: true, + TargetFormat: "flac", + TargetBitrate: 0, + TargetChannels: 2, + TargetBitDepth: 24, + SourceUpdatedAt: sourceTime, + } + token, err := svc.CreateTranscodeParams(decision) + Expect(err).ToNot(HaveOccurred()) + + params, err := impl.parseTranscodeParams(token) + Expect(err).ToNot(HaveOccurred()) + Expect(params.MediaID).To(Equal("media-bd")) + Expect(params.TargetBitDepth).To(Equal(24)) + }) + + It("omits bit depth from token when 0", func() { + decision := &TranscodeDecision{ + MediaID: "media-nobd", + CanDirectPlay: false, + CanTranscode: true, + TargetFormat: "mp3", + TargetBitrate: 256, + TargetBitDepth: 0, + SourceUpdatedAt: sourceTime, + } + token, err := svc.CreateTranscodeParams(decision) + Expect(err).ToNot(HaveOccurred()) + + params, err := impl.parseTranscodeParams(token) + Expect(err).ToNot(HaveOccurred()) + Expect(params.TargetBitDepth).To(Equal(0)) + }) + + It("omits sample rate from token when 0", func() { + decision := &TranscodeDecision{ + MediaID: "media-100", + CanDirectPlay: false, + CanTranscode: true, + TargetFormat: "mp3", + TargetBitrate: 256, + TargetSampleRate: 0, + SourceUpdatedAt: sourceTime, + } + token, err := svc.CreateTranscodeParams(decision) + Expect(err).ToNot(HaveOccurred()) + + params, err := impl.parseTranscodeParams(token) + Expect(err).ToNot(HaveOccurred()) + Expect(params.TargetSampleRate).To(Equal(0)) + }) + + It("truncates SourceUpdatedAt to seconds", func() { + timeWithNanos := time.Date(2025, 6, 15, 10, 30, 0, 123456789, time.UTC) + decision := &TranscodeDecision{ + MediaID: "media-trunc", + CanDirectPlay: true, + SourceUpdatedAt: timeWithNanos, + } + token, err := svc.CreateTranscodeParams(decision) + Expect(err).ToNot(HaveOccurred()) + + params, err := impl.parseTranscodeParams(token) + Expect(err).ToNot(HaveOccurred()) + Expect(params.SourceUpdatedAt.Unix()).To(Equal(timeWithNanos.Truncate(time.Second).Unix())) + }) + + It("rejects an invalid token", func() { + _, err := impl.parseTranscodeParams("invalid-token") + Expect(err).To(HaveOccurred()) + }) + }) + + Describe("ResolveRequestFromToken", func() { + var sourceTime time.Time + + BeforeEach(func() { + sourceTime = time.Date(2025, 6, 15, 10, 30, 0, 0, time.UTC) + }) + + createTokenForMedia := func(mediaID string, updatedAt time.Time) string { + decision := &TranscodeDecision{ + MediaID: mediaID, + CanDirectPlay: true, + SourceUpdatedAt: updatedAt, + } + token, err := svc.CreateTranscodeParams(decision) + Expect(err).ToNot(HaveOccurred()) + return token + } + + It("returns stream request for valid token", func() { + mf := &model.MediaFile{ID: "song-1", UpdatedAt: sourceTime} + token := createTokenForMedia("song-1", sourceTime) + + req, err := svc.ResolveRequestFromToken(ctx, token, mf, 0) + Expect(err).ToNot(HaveOccurred()) + Expect(req.Format).To(BeEmpty()) // direct play has no target format + }) + + It("returns ErrTokenInvalid for invalid token", func() { + mf := &model.MediaFile{ID: "song-1", UpdatedAt: sourceTime} + _, err := svc.ResolveRequestFromToken(ctx, "bad-token", mf, 0) + Expect(err).To(MatchError(ContainSubstring(ErrTokenInvalid.Error()))) + }) + + It("returns ErrTokenInvalid when mediaID does not match token", func() { + mf := &model.MediaFile{ID: "song-2", UpdatedAt: sourceTime} + token := createTokenForMedia("song-1", sourceTime) + + _, err := svc.ResolveRequestFromToken(ctx, token, mf, 0) + Expect(err).To(MatchError(ContainSubstring(ErrTokenInvalid.Error()))) + }) + + It("returns ErrTokenStale when media file has changed", func() { + newTime := sourceTime.Add(1 * time.Hour) + mf := &model.MediaFile{ID: "song-1", UpdatedAt: newTime} + token := createTokenForMedia("song-1", sourceTime) + + _, err := svc.ResolveRequestFromToken(ctx, token, mf, 0) + Expect(err).To(MatchError(ErrTokenStale)) + }) + }) + + Describe("paramsFromToken", func() { + It("returns error when media ID is missing", func() { + tokenAuth := jwtauth.New("HS256", []byte("test-secret"), nil) + token, _, err := tokenAuth.Encode(map[string]any{"ua": int64(1700000000)}) + Expect(err).NotTo(HaveOccurred()) + + _, err = paramsFromToken(token) + Expect(err).To(MatchError(ContainSubstring("missing media ID"))) + }) + + It("returns error when source timestamp is missing", func() { + tokenAuth := jwtauth.New("HS256", []byte("test-secret"), nil) + token, _, err := tokenAuth.Encode(map[string]any{"mid": "song-5"}) + Expect(err).NotTo(HaveOccurred()) + + _, err = paramsFromToken(token) + Expect(err).To(MatchError(ContainSubstring("missing source timestamp"))) + }) + }) +}) diff --git a/core/stream/types.go b/core/stream/types.go new file mode 100644 index 000000000..0cb4ac47d --- /dev/null +++ b/core/stream/types.go @@ -0,0 +1,132 @@ +package stream + +import ( + "errors" + "time" +) + +var ( + ErrTokenInvalid = errors.New("invalid or expired transcode token") + ErrTokenStale = errors.New("transcode token is stale: media file has changed") +) + +// TranscodeOptions controls optional behavior of MakeTranscodeDecision. +type TranscodeOptions struct { + // SkipProbe prevents MakeTranscodeDecision from running ffprobe on the media file. + // When true, source stream details are derived from tag metadata only. + SkipProbe bool +} + +// Request contains the resolved parameters for creating a media stream. +type Request struct { + Format string + BitRate int // kbps + SampleRate int + BitDepth int + Channels int + Offset int // seconds +} + +// ClientInfo represents client playback capabilities. +// All bitrate values are in kilobits per second (kbps) +type ClientInfo struct { + Name string + Platform string + MaxAudioBitrate int + MaxTranscodingAudioBitrate int + DirectPlayProfiles []DirectPlayProfile + TranscodingProfiles []Profile + CodecProfiles []CodecProfile +} + +// DirectPlayProfile describes a format the client can play directly +type DirectPlayProfile struct { + Containers []string + AudioCodecs []string + Protocols []string + MaxAudioChannels int +} + +// Profile describes a transcoding target the client supports +type Profile struct { + Container string + AudioCodec string + Protocol string + MaxAudioChannels int +} + +// CodecProfile describes codec-specific limitations +type CodecProfile struct { + Type string + Name string + Limitations []Limitation +} + +// Limitation describes a specific codec limitation +type Limitation struct { + Name string + Comparison string + Values []string + Required bool +} + +// Protocol values (OpenSubsonic spec enum) +const ( + ProtocolHTTP = "http" + ProtocolHLS = "hls" +) + +// Comparison operators (OpenSubsonic spec enum) +const ( + ComparisonEquals = "Equals" + ComparisonNotEquals = "NotEquals" + ComparisonLessThanEqual = "LessThanEqual" + ComparisonGreaterThanEqual = "GreaterThanEqual" +) + +// Limitation names (OpenSubsonic spec enum) +const ( + LimitationAudioChannels = "audioChannels" + LimitationAudioBitrate = "audioBitrate" + LimitationAudioProfile = "audioProfile" + LimitationAudioSamplerate = "audioSamplerate" + LimitationAudioBitdepth = "audioBitdepth" +) + +// Codec profile types (OpenSubsonic spec enum) +const ( + CodecProfileTypeAudio = "AudioCodec" +) + +// TranscodeDecision represents the internal decision result. +// All bitrate values are in kilobits per second (kbps). +type TranscodeDecision struct { + MediaID string + CanDirectPlay bool + CanTranscode bool + TranscodeReasons []string + ErrorReason string + TargetFormat string + TargetBitrate int + TargetChannels int + TargetSampleRate int + TargetBitDepth int + SourceStream Details + SourceUpdatedAt time.Time + TranscodeStream *Details +} + +// Details describes audio stream properties. +// Bitrate is in kilobits per second (kbps). +type Details struct { + Container string + Codec string + Profile string // Audio profile (e.g., "LC", "HE-AACv2"). Populated from ffprobe data. + Bitrate int + SampleRate int + BitDepth int + Channels int + Duration float32 + Size int64 + IsLossless bool +} diff --git a/core/user.go b/core/user.go new file mode 100644 index 000000000..f13e90167 --- /dev/null +++ b/core/user.go @@ -0,0 +1,76 @@ +package core + +import ( + "context" + + "github.com/deluan/rest" + "github.com/navidrome/navidrome/model" +) + +// PluginUnloader defines the interface for unloading disabled plugins. +// This is satisfied by plugins.Manager but defined here to avoid import cycles. +type PluginUnloader interface { + UnloadDisabledPlugins(ctx context.Context) +} + +// User provides business logic for user management with plugin coordination. +type User interface { + NewRepository(ctx context.Context) rest.Repository +} + +type userService struct { + ds model.DataStore + pluginManager PluginUnloader +} + +// NewUser creates a new User service +func NewUser(ds model.DataStore, pluginManager PluginUnloader) User { + return &userService{ + ds: ds, + pluginManager: pluginManager, + } +} + +// NewRepository returns a REST repository wrapper for user operations. +// The wrapper intercepts Delete operations to coordinate plugin unloading. +func (s *userService) NewRepository(ctx context.Context) rest.Repository { + repo := s.ds.User(ctx) + wrapper := &userRepositoryWrapper{ + ctx: ctx, + UserRepository: repo, + pluginManager: s.pluginManager, + } + return wrapper +} + +type userRepositoryWrapper struct { + model.UserRepository + ctx context.Context + pluginManager PluginUnloader +} + +// Save implements rest.Persistable by delegating to the underlying repository. +func (r *userRepositoryWrapper) Save(entity any) (string, error) { + return r.UserRepository.(rest.Persistable).Save(entity) +} + +// Update implements rest.Persistable by delegating to the underlying repository. +func (r *userRepositoryWrapper) Update(id string, entity any, cols ...string) error { + return r.UserRepository.(rest.Persistable).Update(id, entity, cols...) +} + +// Delete implements rest.Persistable and coordinates plugin unloading. +func (r *userRepositoryWrapper) Delete(id string) error { + // The underlying repository Delete handles the database cleanup + // including calling cleanupPluginUserReferences + err := r.UserRepository.(rest.Persistable).Delete(id) + if err != nil { + return err + } + + // After successful deletion, check if any plugins were auto-disabled + // and need to be unloaded from memory + r.pluginManager.UnloadDisabledPlugins(r.ctx) + + return nil +} diff --git a/core/user_test.go b/core/user_test.go new file mode 100644 index 000000000..b2d3117f8 --- /dev/null +++ b/core/user_test.go @@ -0,0 +1,86 @@ +package core_test + +import ( + "context" + "errors" + + "github.com/deluan/rest" + "github.com/navidrome/navidrome/core" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("User Service", func() { + var service core.User + var ds *tests.MockDataStore + var userRepo *tests.MockedUserRepo + var pluginManager *mockPluginUnloader + var ctx context.Context + + BeforeEach(func() { + ds = &tests.MockDataStore{} + userRepo = tests.CreateMockUserRepo() + ds.MockedUser = userRepo + pluginManager = &mockPluginUnloader{} + service = core.NewUser(ds, pluginManager) + ctx = GinkgoT().Context() + }) + + Describe("NewRepository", func() { + It("returns a rest.Persistable", func() { + repo := service.NewRepository(ctx) + _, ok := repo.(rest.Persistable) + Expect(ok).To(BeTrue()) + }) + }) + + Describe("Delete", func() { + var repo rest.Persistable + + BeforeEach(func() { + r := service.NewRepository(ctx) + repo = r.(rest.Persistable) + + // Add a test user + user := &model.User{ + ID: "user-123", + UserName: "testuser", + IsAdmin: false, + } + user.NewPassword = "password" + Expect(userRepo.Put(user)).To(Succeed()) + }) + + It("deletes the user successfully", func() { + err := repo.Delete("user-123") + Expect(err).NotTo(HaveOccurred()) + + // Verify user is deleted + _, err = userRepo.Get("user-123") + Expect(err).To(Equal(model.ErrNotFound)) + }) + + It("calls UnloadDisabledPlugins after successful deletion", func() { + err := repo.Delete("user-123") + Expect(err).NotTo(HaveOccurred()) + Expect(pluginManager.unloadCalls).To(Equal(1)) + }) + + It("does not call UnloadDisabledPlugins when deletion fails", func() { + // Try to delete non-existent user + err := repo.Delete("non-existent") + Expect(err).To(HaveOccurred()) + Expect(pluginManager.unloadCalls).To(Equal(0)) + }) + + It("returns error when repository fails", func() { + userRepo.Error = errors.New("database error") + err := repo.Delete("user-123") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("database error")) + Expect(pluginManager.unloadCalls).To(Equal(0)) + }) + }) +}) diff --git a/core/wire_providers.go b/core/wire_providers.go index ae365156a..276d9556a 100644 --- a/core/wire_providers.go +++ b/core/wire_providers.go @@ -5,19 +5,27 @@ import ( "github.com/navidrome/navidrome/core/agents" "github.com/navidrome/navidrome/core/external" "github.com/navidrome/navidrome/core/ffmpeg" + "github.com/navidrome/navidrome/core/lyrics" "github.com/navidrome/navidrome/core/metrics" "github.com/navidrome/navidrome/core/playback" + "github.com/navidrome/navidrome/core/playlists" "github.com/navidrome/navidrome/core/scrobbler" + "github.com/navidrome/navidrome/core/stream" ) var Set = wire.NewSet( - NewMediaStreamer, - GetTranscodingCache, + stream.NewMediaStreamer, + stream.GetTranscodingCache, NewArchiver, NewPlayers, NewShare, - NewPlaylists, + playlists.NewPlaylists, NewLibrary, + NewUser, + NewMaintenance, + NewImageUploadService, + wire.Bind(new(playlists.ImageUploadService), new(ImageUploadService)), + stream.NewTranscodeDecider, agents.GetAgents, external.NewProvider, wire.Bind(new(external.Agents), new(*agents.Agents)), @@ -25,4 +33,5 @@ var Set = wire.NewSet( scrobbler.GetPlayTracker, playback.GetInstance, metrics.GetInstance, + lyrics.NewLyrics, ) diff --git a/db/db.go b/db/db.go index cb1ebd9e3..0945d1a00 100644 --- a/db/db.go +++ b/db/db.go @@ -45,10 +45,12 @@ func Db() *sql.DB { if err != nil { log.Fatal("Error opening database", err) } - _, err = db.Exec("PRAGMA optimize=0x10002") - if err != nil { - log.Error("Error applying PRAGMA optimize", err) - return nil + if conf.Server.DevOptimizeDB { + _, err = db.Exec("PRAGMA optimize=0x10002") + if err != nil { + log.Error("Error applying PRAGMA optimize", err) + return nil + } } return db }) @@ -99,7 +101,7 @@ func Init(ctx context.Context) func() { log.Fatal(ctx, "Failed to apply new migrations", err) } - if hasSchemaChanges { + if hasSchemaChanges && conf.Server.DevOptimizeDB { log.Debug(ctx, "Applying PRAGMA optimize after schema changes") _, err = db.ExecContext(ctx, "PRAGMA optimize") if err != nil { @@ -114,6 +116,9 @@ func Init(ctx context.Context) func() { // Optimize runs PRAGMA optimize on each connection in the pool func Optimize(ctx context.Context) { + if !conf.Server.DevOptimizeDB { + return + } numConns := Db().Stats().OpenConnections if numConns == 0 { log.Debug(ctx, "No open connections to optimize") @@ -121,7 +126,7 @@ func Optimize(ctx context.Context) { } log.Debug(ctx, "Optimizing open connections", "numConns", numConns) var conns []*sql.Conn - for i := 0; i < numConns; i++ { + for range numConns { conn, err := Db().Conn(ctx) conns = append(conns, conn) if err != nil { @@ -142,8 +147,8 @@ func Optimize(ctx context.Context) { type statusLogger struct{ numPending int } -func (*statusLogger) Fatalf(format string, v ...interface{}) { log.Fatal(fmt.Sprintf(format, v...)) } -func (l *statusLogger) Printf(format string, v ...interface{}) { +func (*statusLogger) Fatalf(format string, v ...any) { log.Fatal(fmt.Sprintf(format, v...)) } +func (l *statusLogger) Printf(format string, v ...any) { if len(v) < 1 { return } @@ -178,27 +183,27 @@ type logAdapter struct { silent bool } -func (l *logAdapter) Fatal(v ...interface{}) { +func (l *logAdapter) Fatal(v ...any) { log.Fatal(l.ctx, fmt.Sprint(v...)) } -func (l *logAdapter) Fatalf(format string, v ...interface{}) { +func (l *logAdapter) Fatalf(format string, v ...any) { log.Fatal(l.ctx, fmt.Sprintf(format, v...)) } -func (l *logAdapter) Print(v ...interface{}) { +func (l *logAdapter) Print(v ...any) { if !l.silent { log.Info(l.ctx, fmt.Sprint(v...)) } } -func (l *logAdapter) Println(v ...interface{}) { +func (l *logAdapter) Println(v ...any) { if !l.silent { log.Info(l.ctx, fmt.Sprintln(v...)) } } -func (l *logAdapter) Printf(format string, v ...interface{}) { +func (l *logAdapter) Printf(format string, v ...any) { if !l.silent { log.Info(l.ctx, fmt.Sprintf(format, v...)) } diff --git a/db/migrations/20250823142158_make_playqueue_position_int.sql b/db/migrations/20250823142158_make_playqueue_position_int.sql new file mode 100644 index 000000000..de20f0c79 --- /dev/null +++ b/db/migrations/20250823142158_make_playqueue_position_int.sql @@ -0,0 +1,9 @@ +-- +goose Up +-- +goose StatementBegin +ALTER TABLE playqueue ADD COLUMN position_int integer; +UPDATE playqueue SET position_int = CAST(position as INTEGER) ; +ALTER TABLE playqueue DROP COLUMN position; +ALTER TABLE playqueue RENAME COLUMN position_int TO position; +-- +goose StatementEnd + +-- +goose Down diff --git a/db/migrations/20251109010105_add_annotation_rating_date.sql b/db/migrations/20251109010105_add_annotation_rating_date.sql new file mode 100644 index 000000000..9dac46a5e --- /dev/null +++ b/db/migrations/20251109010105_add_annotation_rating_date.sql @@ -0,0 +1,7 @@ +-- +goose Up +-- +goose StatementBegin +ALTER TABLE annotation ADD COLUMN rated_at datetime; +-- +goose StatementEnd + +-- +goose Down + \ No newline at end of file diff --git a/db/migrations/20251206013022_create_scrobbles_table.sql b/db/migrations/20251206013022_create_scrobbles_table.sql new file mode 100644 index 000000000..9791c48e3 --- /dev/null +++ b/db/migrations/20251206013022_create_scrobbles_table.sql @@ -0,0 +1,20 @@ +-- +goose Up +-- +goose StatementBegin +CREATE TABLE scrobbles( + media_file_id VARCHAR(255) NOT NULL + REFERENCES media_file(id) + ON DELETE CASCADE + ON UPDATE CASCADE, + user_id VARCHAR(255) NOT NULL + REFERENCES user(id) + ON DELETE CASCADE + ON UPDATE CASCADE, + submission_time INTEGER NOT NULL +); +CREATE INDEX scrobbles_date ON scrobbles (submission_time); +-- +goose StatementEnd + +-- +goose Down +-- +goose StatementBegin +DROP TABLE scrobbles; +-- +goose StatementEnd diff --git a/db/migrations/20260104203627_playlist_case_insensitive_name.sql b/db/migrations/20260104203627_playlist_case_insensitive_name.sql new file mode 100644 index 000000000..64b079cca --- /dev/null +++ b/db/migrations/20260104203627_playlist_case_insensitive_name.sql @@ -0,0 +1,99 @@ +-- +goose Up +-- Fix case-insensitive sorting for playlist names +create table playlist_dg_tmp +( + id varchar(255) not null + primary key, + name varchar(255) collate NOCASE default '' not null, + comment varchar(255) default '' not null, + duration real default 0 not null, + song_count integer default 0 not null, + public bool default FALSE not null, + created_at datetime, + updated_at datetime, + path string default '' not null, + sync bool default false not null, + size integer default 0 not null, + rules varchar, + evaluated_at datetime, + owner_id varchar(255) not null + constraint playlist_user_user_id_fk + references user + on update cascade on delete cascade +); + +insert into playlist_dg_tmp(id, name, comment, duration, song_count, public, created_at, updated_at, path, sync, size, + rules, evaluated_at, owner_id) +select id, name, comment, duration, song_count, public, created_at, updated_at, path, sync, size, rules, evaluated_at, + owner_id +from playlist; + +drop table playlist; + +alter table playlist_dg_tmp + rename to playlist; + +create index playlist_name + on playlist (name); + +create index playlist_created_at + on playlist (created_at); + +create index playlist_updated_at + on playlist (updated_at); + +create index playlist_evaluated_at + on playlist (evaluated_at); + +create index playlist_size + on playlist (size); + +-- +goose Down +-- Note: Downgrade loses the collation but preserves data +create table playlist_dg_tmp +( + id varchar(255) not null + primary key, + name varchar(255) default '' not null, + comment varchar(255) default '' not null, + duration real default 0 not null, + song_count integer default 0 not null, + public bool default FALSE not null, + created_at datetime, + updated_at datetime, + path string default '' not null, + sync bool default false not null, + size integer default 0 not null, + rules varchar, + evaluated_at datetime, + owner_id varchar(255) not null + constraint playlist_user_user_id_fk + references user + on update cascade on delete cascade +); + +insert into playlist_dg_tmp(id, name, comment, duration, song_count, public, created_at, updated_at, path, sync, size, + rules, evaluated_at, owner_id) +select id, name, comment, duration, song_count, public, created_at, updated_at, path, sync, size, rules, evaluated_at, + owner_id +from playlist; + +drop table playlist; + +alter table playlist_dg_tmp + rename to playlist; + +create index playlist_name + on playlist (name); + +create index playlist_created_at + on playlist (created_at); + +create index playlist_updated_at + on playlist (updated_at); + +create index playlist_evaluated_at + on playlist (evaluated_at); + +create index playlist_size + on playlist (size); diff --git a/db/migrations/20260106000620_create_plugin_table.sql b/db/migrations/20260106000620_create_plugin_table.sql new file mode 100644 index 000000000..bcc83be0b --- /dev/null +++ b/db/migrations/20260106000620_create_plugin_table.sql @@ -0,0 +1,19 @@ +-- +goose Up +CREATE TABLE IF NOT EXISTS plugin ( + id TEXT PRIMARY KEY, + path TEXT NOT NULL, + manifest JSONB NOT NULL, + config JSONB, + users JSONB, + all_users BOOL NOT NULL DEFAULT false, + libraries JSONB, + all_libraries BOOL NOT NULL DEFAULT false, + enabled BOOL NOT NULL DEFAULT false, + last_error TEXT, + sha256 TEXT NOT NULL, + created_at DATETIME NOT NULL, + updated_at DATETIME NOT NULL +); + +-- +goose Down +DROP TABLE IF EXISTS plugin; diff --git a/db/migrations/20260117201522_add_avg_rating_column.sql b/db/migrations/20260117201522_add_avg_rating_column.sql new file mode 100644 index 000000000..f5c8d4522 --- /dev/null +++ b/db/migrations/20260117201522_add_avg_rating_column.sql @@ -0,0 +1,23 @@ +-- +goose Up +ALTER TABLE album ADD COLUMN average_rating REAL NOT NULL DEFAULT 0; +ALTER TABLE media_file ADD COLUMN average_rating REAL NOT NULL DEFAULT 0; +ALTER TABLE artist ADD COLUMN average_rating REAL NOT NULL DEFAULT 0; + +-- Populate average_rating from existing ratings +UPDATE album SET average_rating = coalesce( + (SELECT round(avg(rating), 2) FROM annotation WHERE item_id = album.id AND item_type = 'album' AND rating > 0), + 0 +); +UPDATE media_file SET average_rating = coalesce( + (SELECT round(avg(rating), 2) FROM annotation WHERE item_id = media_file.id AND item_type = 'media_file' AND rating > 0), + 0 +); +UPDATE artist SET average_rating = coalesce( + (SELECT round(avg(rating), 2) FROM annotation WHERE item_id = artist.id AND item_type = 'artist' AND rating > 0), + 0 +); + +-- +goose Down +ALTER TABLE artist DROP COLUMN average_rating; +ALTER TABLE media_file DROP COLUMN average_rating; +ALTER TABLE album DROP COLUMN average_rating; diff --git a/db/migrations/20260220173400_add_fts5_search.go b/db/migrations/20260220173400_add_fts5_search.go new file mode 100644 index 000000000..dc4cd647b --- /dev/null +++ b/db/migrations/20260220173400_add_fts5_search.go @@ -0,0 +1,391 @@ +package migrations + +import ( + "context" + "database/sql" + "fmt" + + "github.com/pressly/goose/v3" +) + +func init() { + goose.AddMigrationContext(upAddFts5Search, downAddFts5Search) +} + +// stripPunct generates a SQL expression that strips common punctuation from a column or expression. +// Used during migration to approximate the Go normalizeForFTS function for bulk-populating search_normalized. +func stripPunct(col string) string { + return fmt.Sprintf( + `REPLACE(REPLACE(REPLACE(REPLACE(REPLACE(REPLACE(%s, '.', ''), '/', ''), '-', ''), '''', ''), '&', ''), ',', '')`, + col, + ) +} + +func upAddFts5Search(ctx context.Context, tx *sql.Tx) error { + notice(tx, "Adding FTS5 full-text search indexes. This may take a moment on large libraries.") + + // Step 1: Add search_participants and search_normalized columns to media_file, album, and artist + _, err := tx.ExecContext(ctx, `ALTER TABLE media_file ADD COLUMN search_participants TEXT NOT NULL DEFAULT ''`) + if err != nil { + return fmt.Errorf("adding search_participants to media_file: %w", err) + } + _, err = tx.ExecContext(ctx, `ALTER TABLE media_file ADD COLUMN search_normalized TEXT NOT NULL DEFAULT ''`) + if err != nil { + return fmt.Errorf("adding search_normalized to media_file: %w", err) + } + _, err = tx.ExecContext(ctx, `ALTER TABLE album ADD COLUMN search_participants TEXT NOT NULL DEFAULT ''`) + if err != nil { + return fmt.Errorf("adding search_participants to album: %w", err) + } + _, err = tx.ExecContext(ctx, `ALTER TABLE album ADD COLUMN search_normalized TEXT NOT NULL DEFAULT ''`) + if err != nil { + return fmt.Errorf("adding search_normalized to album: %w", err) + } + _, err = tx.ExecContext(ctx, `ALTER TABLE artist ADD COLUMN search_normalized TEXT NOT NULL DEFAULT ''`) + if err != nil { + return fmt.Errorf("adding search_normalized to artist: %w", err) + } + + // Step 2: Populate search_participants from participants JSON. + // Extract all "name" values from the participants JSON structure. + // participants is a JSON object like: {"artist":[{"name":"...","id":"..."}],"albumartist":[...]} + // We use json_each + json_extract to flatten all names into a space-separated string. + _, err = tx.ExecContext(ctx, ` + UPDATE media_file SET search_participants = COALESCE( + (SELECT group_concat(json_extract(je2.value, '$.name'), ' ') + FROM json_each(media_file.participants) AS je1, + json_each(je1.value) AS je2 + WHERE json_extract(je2.value, '$.name') IS NOT NULL), + '' + ) + WHERE participants IS NOT NULL AND participants != '' AND participants != '{}' + `) + if err != nil { + return fmt.Errorf("populating media_file search_participants: %w", err) + } + + _, err = tx.ExecContext(ctx, ` + UPDATE album SET search_participants = COALESCE( + (SELECT group_concat(json_extract(je2.value, '$.name'), ' ') + FROM json_each(album.participants) AS je1, + json_each(je1.value) AS je2 + WHERE json_extract(je2.value, '$.name') IS NOT NULL), + '' + ) + WHERE participants IS NOT NULL AND participants != '' AND participants != '{}' + `) + if err != nil { + return fmt.Errorf("populating album search_participants: %w", err) + } + + // Step 2b: Populate search_normalized using SQL REPLACE chains for common punctuation. + // The Go code will compute the precise value on next scan; this is a best-effort approximation. + _, err = tx.ExecContext(ctx, fmt.Sprintf(` + UPDATE artist SET search_normalized = %s + WHERE name != %s`, + stripPunct("name"), stripPunct("name"))) + if err != nil { + return fmt.Errorf("populating artist search_normalized: %w", err) + } + + _, err = tx.ExecContext(ctx, fmt.Sprintf(` + UPDATE album SET search_normalized = TRIM(%s || ' ' || %s) + WHERE name != %s OR COALESCE(album_artist, '') != %s`, + stripPunct("name"), stripPunct("COALESCE(album_artist, '')"), + stripPunct("name"), stripPunct("COALESCE(album_artist, '')"))) + if err != nil { + return fmt.Errorf("populating album search_normalized: %w", err) + } + + _, err = tx.ExecContext(ctx, fmt.Sprintf(` + UPDATE media_file SET search_normalized = + TRIM(%s || ' ' || %s || ' ' || %s || ' ' || %s) + WHERE title != %s + OR COALESCE(album, '') != %s + OR COALESCE(artist, '') != %s + OR COALESCE(album_artist, '') != %s`, + stripPunct("title"), stripPunct("COALESCE(album, '')"), + stripPunct("COALESCE(artist, '')"), stripPunct("COALESCE(album_artist, '')"), + stripPunct("title"), stripPunct("COALESCE(album, '')"), + stripPunct("COALESCE(artist, '')"), stripPunct("COALESCE(album_artist, '')"))) + if err != nil { + return fmt.Errorf("populating media_file search_normalized: %w", err) + } + + // Step 3: Create FTS5 virtual tables + _, err = tx.ExecContext(ctx, ` + CREATE VIRTUAL TABLE IF NOT EXISTS media_file_fts USING fts5( + title, album, artist, album_artist, + sort_title, sort_album_name, sort_artist_name, sort_album_artist_name, + disc_subtitle, search_participants, search_normalized, + content='', content_rowid='rowid', + tokenize='unicode61 remove_diacritics 2' + ) + `) + if err != nil { + return fmt.Errorf("creating media_file_fts: %w", err) + } + + _, err = tx.ExecContext(ctx, ` + CREATE VIRTUAL TABLE IF NOT EXISTS album_fts USING fts5( + name, sort_album_name, album_artist, + search_participants, discs, catalog_num, album_version, search_normalized, + content='', content_rowid='rowid', + tokenize='unicode61 remove_diacritics 2' + ) + `) + if err != nil { + return fmt.Errorf("creating album_fts: %w", err) + } + + _, err = tx.ExecContext(ctx, ` + CREATE VIRTUAL TABLE IF NOT EXISTS artist_fts USING fts5( + name, sort_artist_name, search_normalized, + content='', content_rowid='rowid', + tokenize='unicode61 remove_diacritics 2' + ) + `) + if err != nil { + return fmt.Errorf("creating artist_fts: %w", err) + } + + // Step 4: Bulk-populate FTS5 indexes from existing data + _, err = tx.ExecContext(ctx, ` + INSERT INTO media_file_fts(rowid, title, album, artist, album_artist, + sort_title, sort_album_name, sort_artist_name, sort_album_artist_name, + disc_subtitle, search_participants, search_normalized) + SELECT rowid, title, album, artist, album_artist, + sort_title, sort_album_name, sort_artist_name, sort_album_artist_name, + COALESCE(disc_subtitle, ''), COALESCE(search_participants, ''), + COALESCE(search_normalized, '') + FROM media_file + `) + if err != nil { + return fmt.Errorf("populating media_file_fts: %w", err) + } + + _, err = tx.ExecContext(ctx, ` + INSERT INTO album_fts(rowid, name, sort_album_name, album_artist, + search_participants, discs, catalog_num, album_version, search_normalized) + SELECT rowid, name, COALESCE(sort_album_name, ''), COALESCE(album_artist, ''), + COALESCE(search_participants, ''), COALESCE(discs, ''), + COALESCE(catalog_num, ''), + COALESCE((SELECT group_concat(json_extract(je.value, '$.value'), ' ') + FROM json_each(album.tags, '$.albumversion') AS je), ''), + COALESCE(search_normalized, '') + FROM album + `) + if err != nil { + return fmt.Errorf("populating album_fts: %w", err) + } + + _, err = tx.ExecContext(ctx, ` + INSERT INTO artist_fts(rowid, name, sort_artist_name, search_normalized) + SELECT rowid, name, COALESCE(sort_artist_name, ''), COALESCE(search_normalized, '') + FROM artist + `) + if err != nil { + return fmt.Errorf("populating artist_fts: %w", err) + } + + // Step 5: Create triggers for media_file + _, err = tx.ExecContext(ctx, ` + CREATE TRIGGER media_file_fts_ai AFTER INSERT ON media_file BEGIN + INSERT INTO media_file_fts(rowid, title, album, artist, album_artist, + sort_title, sort_album_name, sort_artist_name, sort_album_artist_name, + disc_subtitle, search_participants, search_normalized) + VALUES (NEW.rowid, NEW.title, NEW.album, NEW.artist, NEW.album_artist, + NEW.sort_title, NEW.sort_album_name, NEW.sort_artist_name, NEW.sort_album_artist_name, + COALESCE(NEW.disc_subtitle, ''), COALESCE(NEW.search_participants, ''), + COALESCE(NEW.search_normalized, '')); + END + `) + if err != nil { + return fmt.Errorf("creating media_file_fts insert trigger: %w", err) + } + + _, err = tx.ExecContext(ctx, ` + CREATE TRIGGER media_file_fts_ad AFTER DELETE ON media_file BEGIN + INSERT INTO media_file_fts(media_file_fts, rowid, title, album, artist, album_artist, + sort_title, sort_album_name, sort_artist_name, sort_album_artist_name, + disc_subtitle, search_participants, search_normalized) + VALUES ('delete', OLD.rowid, OLD.title, OLD.album, OLD.artist, OLD.album_artist, + OLD.sort_title, OLD.sort_album_name, OLD.sort_artist_name, OLD.sort_album_artist_name, + COALESCE(OLD.disc_subtitle, ''), COALESCE(OLD.search_participants, ''), + COALESCE(OLD.search_normalized, '')); + END + `) + if err != nil { + return fmt.Errorf("creating media_file_fts delete trigger: %w", err) + } + + _, err = tx.ExecContext(ctx, ` + CREATE TRIGGER media_file_fts_au AFTER UPDATE ON media_file + WHEN + OLD.title IS NOT NEW.title OR + OLD.album IS NOT NEW.album OR + OLD.artist IS NOT NEW.artist OR + OLD.album_artist IS NOT NEW.album_artist OR + OLD.sort_title IS NOT NEW.sort_title OR + OLD.sort_album_name IS NOT NEW.sort_album_name OR + OLD.sort_artist_name IS NOT NEW.sort_artist_name OR + OLD.sort_album_artist_name IS NOT NEW.sort_album_artist_name OR + OLD.disc_subtitle IS NOT NEW.disc_subtitle OR + OLD.search_participants IS NOT NEW.search_participants OR + OLD.search_normalized IS NOT NEW.search_normalized + BEGIN + INSERT INTO media_file_fts(media_file_fts, rowid, title, album, artist, album_artist, + sort_title, sort_album_name, sort_artist_name, sort_album_artist_name, + disc_subtitle, search_participants, search_normalized) + VALUES ('delete', OLD.rowid, OLD.title, OLD.album, OLD.artist, OLD.album_artist, + OLD.sort_title, OLD.sort_album_name, OLD.sort_artist_name, OLD.sort_album_artist_name, + COALESCE(OLD.disc_subtitle, ''), COALESCE(OLD.search_participants, ''), + COALESCE(OLD.search_normalized, '')); + INSERT INTO media_file_fts(rowid, title, album, artist, album_artist, + sort_title, sort_album_name, sort_artist_name, sort_album_artist_name, + disc_subtitle, search_participants, search_normalized) + VALUES (NEW.rowid, NEW.title, NEW.album, NEW.artist, NEW.album_artist, + NEW.sort_title, NEW.sort_album_name, NEW.sort_artist_name, NEW.sort_album_artist_name, + COALESCE(NEW.disc_subtitle, ''), COALESCE(NEW.search_participants, ''), + COALESCE(NEW.search_normalized, '')); + END + `) + if err != nil { + return fmt.Errorf("creating media_file_fts update trigger: %w", err) + } + + // Step 6: Create triggers for album + _, err = tx.ExecContext(ctx, ` + CREATE TRIGGER album_fts_ai AFTER INSERT ON album BEGIN + INSERT INTO album_fts(rowid, name, sort_album_name, album_artist, + search_participants, discs, catalog_num, album_version, search_normalized) + VALUES (NEW.rowid, NEW.name, COALESCE(NEW.sort_album_name, ''), COALESCE(NEW.album_artist, ''), + COALESCE(NEW.search_participants, ''), COALESCE(NEW.discs, ''), + COALESCE(NEW.catalog_num, ''), + COALESCE((SELECT group_concat(json_extract(je.value, '$.value'), ' ') + FROM json_each(NEW.tags, '$.albumversion') AS je), ''), + COALESCE(NEW.search_normalized, '')); + END + `) + if err != nil { + return fmt.Errorf("creating album_fts insert trigger: %w", err) + } + + _, err = tx.ExecContext(ctx, ` + CREATE TRIGGER album_fts_ad AFTER DELETE ON album BEGIN + INSERT INTO album_fts(album_fts, rowid, name, sort_album_name, album_artist, + search_participants, discs, catalog_num, album_version, search_normalized) + VALUES ('delete', OLD.rowid, OLD.name, COALESCE(OLD.sort_album_name, ''), COALESCE(OLD.album_artist, ''), + COALESCE(OLD.search_participants, ''), COALESCE(OLD.discs, ''), + COALESCE(OLD.catalog_num, ''), + COALESCE((SELECT group_concat(json_extract(je.value, '$.value'), ' ') + FROM json_each(OLD.tags, '$.albumversion') AS je), ''), + COALESCE(OLD.search_normalized, '')); + END + `) + if err != nil { + return fmt.Errorf("creating album_fts delete trigger: %w", err) + } + + _, err = tx.ExecContext(ctx, ` + CREATE TRIGGER album_fts_au AFTER UPDATE ON album + WHEN + OLD.name IS NOT NEW.name OR + OLD.sort_album_name IS NOT NEW.sort_album_name OR + OLD.album_artist IS NOT NEW.album_artist OR + OLD.search_participants IS NOT NEW.search_participants OR + OLD.discs IS NOT NEW.discs OR + OLD.catalog_num IS NOT NEW.catalog_num OR + OLD.tags IS NOT NEW.tags OR + OLD.search_normalized IS NOT NEW.search_normalized + BEGIN + INSERT INTO album_fts(album_fts, rowid, name, sort_album_name, album_artist, + search_participants, discs, catalog_num, album_version, search_normalized) + VALUES ('delete', OLD.rowid, OLD.name, COALESCE(OLD.sort_album_name, ''), COALESCE(OLD.album_artist, ''), + COALESCE(OLD.search_participants, ''), COALESCE(OLD.discs, ''), + COALESCE(OLD.catalog_num, ''), + COALESCE((SELECT group_concat(json_extract(je.value, '$.value'), ' ') + FROM json_each(OLD.tags, '$.albumversion') AS je), ''), + COALESCE(OLD.search_normalized, '')); + INSERT INTO album_fts(rowid, name, sort_album_name, album_artist, + search_participants, discs, catalog_num, album_version, search_normalized) + VALUES (NEW.rowid, NEW.name, COALESCE(NEW.sort_album_name, ''), COALESCE(NEW.album_artist, ''), + COALESCE(NEW.search_participants, ''), COALESCE(NEW.discs, ''), + COALESCE(NEW.catalog_num, ''), + COALESCE((SELECT group_concat(json_extract(je.value, '$.value'), ' ') + FROM json_each(NEW.tags, '$.albumversion') AS je), ''), + COALESCE(NEW.search_normalized, '')); + END + `) + if err != nil { + return fmt.Errorf("creating album_fts update trigger: %w", err) + } + + // Step 7: Create triggers for artist + _, err = tx.ExecContext(ctx, ` + CREATE TRIGGER artist_fts_ai AFTER INSERT ON artist BEGIN + INSERT INTO artist_fts(rowid, name, sort_artist_name, search_normalized) + VALUES (NEW.rowid, NEW.name, COALESCE(NEW.sort_artist_name, ''), + COALESCE(NEW.search_normalized, '')); + END + `) + if err != nil { + return fmt.Errorf("creating artist_fts insert trigger: %w", err) + } + + _, err = tx.ExecContext(ctx, ` + CREATE TRIGGER artist_fts_ad AFTER DELETE ON artist BEGIN + INSERT INTO artist_fts(artist_fts, rowid, name, sort_artist_name, search_normalized) + VALUES ('delete', OLD.rowid, OLD.name, COALESCE(OLD.sort_artist_name, ''), + COALESCE(OLD.search_normalized, '')); + END + `) + if err != nil { + return fmt.Errorf("creating artist_fts delete trigger: %w", err) + } + + _, err = tx.ExecContext(ctx, ` + CREATE TRIGGER artist_fts_au AFTER UPDATE ON artist + WHEN + OLD.name IS NOT NEW.name OR + OLD.sort_artist_name IS NOT NEW.sort_artist_name OR + OLD.search_normalized IS NOT NEW.search_normalized + BEGIN + INSERT INTO artist_fts(artist_fts, rowid, name, sort_artist_name, search_normalized) + VALUES ('delete', OLD.rowid, OLD.name, COALESCE(OLD.sort_artist_name, ''), + COALESCE(OLD.search_normalized, '')); + INSERT INTO artist_fts(rowid, name, sort_artist_name, search_normalized) + VALUES (NEW.rowid, NEW.name, COALESCE(NEW.sort_artist_name, ''), + COALESCE(NEW.search_normalized, '')); + END + `) + if err != nil { + return fmt.Errorf("creating artist_fts update trigger: %w", err) + } + + return nil +} + +func downAddFts5Search(ctx context.Context, tx *sql.Tx) error { + for _, trigger := range []string{ + "media_file_fts_ai", "media_file_fts_ad", "media_file_fts_au", + "album_fts_ai", "album_fts_ad", "album_fts_au", + "artist_fts_ai", "artist_fts_ad", "artist_fts_au", + } { + _, err := tx.ExecContext(ctx, "DROP TRIGGER IF EXISTS "+trigger) + if err != nil { + return fmt.Errorf("dropping trigger %s: %w", trigger, err) + } + } + + for _, table := range []string{"media_file_fts", "album_fts", "artist_fts"} { + _, err := tx.ExecContext(ctx, "DROP TABLE IF EXISTS "+table) + if err != nil { + return fmt.Errorf("dropping table %s: %w", table, err) + } + } + + // Note: We don't drop search_participants columns because SQLite doesn't support DROP COLUMN + // on older versions, and the column is harmless if left in place. + return nil +} diff --git a/db/migrations/20260228020813_add_plugin_allow_write_access.sql b/db/migrations/20260228020813_add_plugin_allow_write_access.sql new file mode 100644 index 000000000..e17d874a5 --- /dev/null +++ b/db/migrations/20260228020813_add_plugin_allow_write_access.sql @@ -0,0 +1,5 @@ +-- +goose Up +ALTER TABLE plugin ADD COLUMN allow_write_access BOOL NOT NULL DEFAULT false; + +-- +goose Down +ALTER TABLE plugin DROP COLUMN allow_write_access; diff --git a/db/migrations/20260228172956_add_playlist_image_file.go b/db/migrations/20260228172956_add_playlist_image_file.go new file mode 100644 index 000000000..da2177aba --- /dev/null +++ b/db/migrations/20260228172956_add_playlist_image_file.go @@ -0,0 +1,22 @@ +package migrations + +import ( + "context" + "database/sql" + + "github.com/pressly/goose/v3" +) + +func init() { + goose.AddMigrationContext(upAddPlaylistImageFile, downAddPlaylistImageFile) +} + +func upAddPlaylistImageFile(ctx context.Context, tx *sql.Tx) error { + _, err := tx.ExecContext(ctx, `ALTER TABLE playlist ADD COLUMN image_file VARCHAR(255) DEFAULT '';`) + return err +} + +func downAddPlaylistImageFile(ctx context.Context, tx *sql.Tx) error { + _, err := tx.ExecContext(ctx, `ALTER TABLE playlist DROP COLUMN image_file;`) + return err +} diff --git a/db/migrations/20260302021413_rename_playlist_image_fields.go b/db/migrations/20260302021413_rename_playlist_image_fields.go new file mode 100644 index 000000000..1e9754637 --- /dev/null +++ b/db/migrations/20260302021413_rename_playlist_image_fields.go @@ -0,0 +1,30 @@ +package migrations + +import ( + "context" + "database/sql" + + "github.com/pressly/goose/v3" +) + +func init() { + goose.AddMigrationContext(upRenamePlaylistImageFields, downRenamePlaylistImageFields) +} + +func upRenamePlaylistImageFields(ctx context.Context, tx *sql.Tx) error { + _, err := tx.ExecContext(ctx, `ALTER TABLE playlist RENAME COLUMN image_file TO uploaded_image;`) + if err != nil { + return err + } + _, err = tx.ExecContext(ctx, `ALTER TABLE playlist ADD COLUMN external_image_url VARCHAR(255) DEFAULT '';`) + return err +} + +func downRenamePlaylistImageFields(ctx context.Context, tx *sql.Tx) error { + _, err := tx.ExecContext(ctx, `ALTER TABLE playlist DROP COLUMN external_image_url;`) + if err != nil { + return err + } + _, err = tx.ExecContext(ctx, `ALTER TABLE playlist RENAME COLUMN uploaded_image TO image_file;`) + return err +} diff --git a/db/migrations/20260307175815_add_codec_and_update_transcodings.go b/db/migrations/20260307175815_add_codec_and_update_transcodings.go new file mode 100644 index 000000000..4e8b1b7f5 --- /dev/null +++ b/db/migrations/20260307175815_add_codec_and_update_transcodings.go @@ -0,0 +1,73 @@ +package migrations + +import ( + "context" + "database/sql" + + "github.com/navidrome/navidrome/model/id" + "github.com/pressly/goose/v3" +) + +func init() { + goose.AddMigrationContext(upAddCodecAndUpdateTranscodings, downAddCodecAndUpdateTranscodings) +} + +func upAddCodecAndUpdateTranscodings(_ context.Context, tx *sql.Tx) error { + // Add codec column to media_file. + _, err := tx.Exec(`ALTER TABLE media_file ADD COLUMN codec VARCHAR(255) DEFAULT '' NOT NULL`) + if err != nil { + return err + } + _, err = tx.Exec(`CREATE INDEX IF NOT EXISTS media_file_codec ON media_file(codec)`) + if err != nil { + return err + } + + // Update old AAC default (adts) to new default (ipod with fragmented MP4). + // Only affects users who still have the unmodified old default command. + _, err = tx.Exec( + `UPDATE transcoding SET command = ? WHERE target_format = 'aac' AND command = ?`, + "ffmpeg -i %s -ss %t -map 0:a:0 -b:a %bk -v 0 -c:a aac -f ipod -movflags frag_keyframe+empty_moov -", + "ffmpeg -i %s -ss %t -map 0:a:0 -b:a %bk -v 0 -c:a aac -f adts -", + ) + if err != nil { + return err + } + + // Add FLAC transcoding for existing installations that were seeded before FLAC was added. + var count int + err = tx.QueryRow("SELECT COUNT(*) FROM transcoding WHERE target_format = 'flac'").Scan(&count) + if err != nil { + return err + } + if count == 0 { + _, err = tx.Exec( + "INSERT INTO transcoding (id, name, target_format, default_bit_rate, command) VALUES (?, ?, ?, ?, ?)", + id.NewRandom(), "flac audio", "flac", 0, + "ffmpeg -i %s -ss %t -map 0:a:0 -v 0 -c:a flac -f flac -", + ) + if err != nil { + return err + } + } + + // Add probe_data column for caching ffprobe results. + _, err = tx.Exec(`ALTER TABLE media_file ADD COLUMN probe_data TEXT DEFAULT NULL`) + if err != nil { + return err + } + return nil +} + +func downAddCodecAndUpdateTranscodings(_ context.Context, tx *sql.Tx) error { + _, err := tx.Exec(`ALTER TABLE media_file DROP COLUMN probe_data`) + if err != nil { + return err + } + _, err = tx.Exec(`DROP INDEX IF EXISTS media_file_codec`) + if err != nil { + return err + } + _, err = tx.Exec(`ALTER TABLE media_file DROP COLUMN codec`) + return err +} diff --git a/db/migrations/20260309120007_fix_probe_data_null.go b/db/migrations/20260309120007_fix_probe_data_null.go new file mode 100644 index 000000000..a7e7366ed --- /dev/null +++ b/db/migrations/20260309120007_fix_probe_data_null.go @@ -0,0 +1,28 @@ +package migrations + +import ( + "context" + "database/sql" + + "github.com/pressly/goose/v3" +) + +func init() { + goose.AddMigrationContext(upFixProbeDataNull, downFixProbeDataNull) +} + +func upFixProbeDataNull(_ context.Context, tx *sql.Tx) error { + // Recreate probe_data column as NOT NULL with empty string default. + // The previous migration created it with DEFAULT NULL, which causes + // scan errors when reading into Go string fields. + _, err := tx.Exec(`ALTER TABLE media_file DROP COLUMN probe_data`) + if err != nil { + return err + } + _, err = tx.Exec(`ALTER TABLE media_file ADD COLUMN probe_data TEXT DEFAULT '' NOT NULL`) + return err +} + +func downFixProbeDataNull(_ context.Context, tx *sql.Tx) error { + return nil +} diff --git a/db/migrations/20260309203355_ensure_default_transcodings.go b/db/migrations/20260309203355_ensure_default_transcodings.go new file mode 100644 index 000000000..ab6d24952 --- /dev/null +++ b/db/migrations/20260309203355_ensure_default_transcodings.go @@ -0,0 +1,44 @@ +package migrations + +import ( + "context" + "database/sql" + + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/model/id" + "github.com/pressly/goose/v3" +) + +func init() { + goose.AddMigrationContext(upEnsureDefaultTranscodings, downEnsureDefaultTranscodings) +} + +func upEnsureDefaultTranscodings(_ context.Context, tx *sql.Tx) error { + // Older installations may be missing default transcodings that were added + // after the initial seeding (e.g., aac was added later than mp3/opus). + // Insert any missing defaults without touching user-customized entries. + // Check both target_format and name since both have UNIQUE constraints, + // and older entries may have a different target_format (e.g., 'oga' vs 'opus') + // but the same name. + for _, t := range consts.DefaultTranscodings { + var count int + err := tx.QueryRow("SELECT COUNT(*) FROM transcoding WHERE target_format = ? OR name = ?", t.TargetFormat, t.Name).Scan(&count) + if err != nil { + return err + } + if count == 0 { + _, err = tx.Exec( + "INSERT INTO transcoding (id, name, target_format, default_bit_rate, command) VALUES (?, ?, ?, ?, ?)", + id.NewRandom(), t.Name, t.TargetFormat, t.DefaultBitRate, t.Command, + ) + if err != nil { + return err + } + } + } + return nil +} + +func downEnsureDefaultTranscodings(_ context.Context, tx *sql.Tx) error { + return nil +} diff --git a/db/migrations/20260310113858_fix_aac_transcode_command.go b/db/migrations/20260310113858_fix_aac_transcode_command.go new file mode 100644 index 000000000..588137383 --- /dev/null +++ b/db/migrations/20260310113858_fix_aac_transcode_command.go @@ -0,0 +1,30 @@ +package migrations + +import ( + "context" + "database/sql" + + "github.com/pressly/goose/v3" +) + +func init() { + goose.AddMigrationContext(upFixAacTranscodeCommand, downFixAacTranscodeCommand) +} + +func upFixAacTranscodeCommand(_ context.Context, tx *sql.Tx) error { + // The old AAC command used `-f ipod -movflags frag_keyframe+empty_moov` which produces + // corrupt/silent audio when ffmpeg pipes to stdout (confirmed in ffmpeg 8.0+). + // Switch to `-f adts` (raw AAC framing) which works reliably via pipe. + // Only update rows that still have the old default command. + const oldCommand = "ffmpeg -i %s -ss %t -map 0:a:0 -b:a %bk -v 0 -c:a aac -f ipod -movflags frag_keyframe+empty_moov -" + const newCommand = "ffmpeg -i %s -ss %t -map 0:a:0 -b:a %bk -v 0 -c:a aac -f adts -" + _, err := tx.Exec( + "UPDATE transcoding SET command = ? WHERE target_format = 'aac' AND command = ?", + newCommand, oldCommand, + ) + return err +} + +func downFixAacTranscodeCommand(_ context.Context, tx *sql.Tx) error { + return nil +} diff --git a/db/migrations/20260315233131_add_artist_uploaded_image.go b/db/migrations/20260315233131_add_artist_uploaded_image.go new file mode 100644 index 000000000..964e346f5 --- /dev/null +++ b/db/migrations/20260315233131_add_artist_uploaded_image.go @@ -0,0 +1,22 @@ +package migrations + +import ( + "context" + "database/sql" + + "github.com/pressly/goose/v3" +) + +func init() { + goose.AddMigrationContext(upAddArtistUploadedImage, downAddArtistUploadedImage) +} + +func upAddArtistUploadedImage(ctx context.Context, tx *sql.Tx) error { + _, err := tx.ExecContext(ctx, `ALTER TABLE artist ADD COLUMN uploaded_image VARCHAR(255) DEFAULT ''`) + return err +} + +func downAddArtistUploadedImage(ctx context.Context, tx *sql.Tx) error { + // This code is executed when the migration is rolled back. + return nil +} diff --git a/db/migrations/20260316000000_normalize_timestamps.sql b/db/migrations/20260316000000_normalize_timestamps.sql new file mode 100644 index 000000000..a2e1183e9 --- /dev/null +++ b/db/migrations/20260316000000_normalize_timestamps.sql @@ -0,0 +1,74 @@ +-- +goose Up + +-- Normalize T-format timestamps (RFC3339Nano with 'T' separator) to SQLite-compatible format. +-- SQLite uses string comparison for ORDER BY on TEXT columns, so 'T' (ASCII 84) > ' ' (ASCII 32) +-- causes T-format timestamps to sort after space-format ones, breaking "Recently Added" ordering. + +UPDATE album SET created_at = replace(replace(created_at, 'T', ' '), 'Z', '+00:00') WHERE created_at LIKE '%T%'; +UPDATE album SET updated_at = replace(replace(updated_at, 'T', ' '), 'Z', '+00:00') WHERE updated_at LIKE '%T%'; +UPDATE album SET imported_at = replace(replace(imported_at, 'T', ' '), 'Z', '+00:00') WHERE imported_at LIKE '%T%'; +UPDATE album SET external_info_updated_at = replace(replace(external_info_updated_at, 'T', ' '), 'Z', '+00:00') WHERE external_info_updated_at LIKE '%T%'; + +UPDATE media_file SET created_at = replace(replace(created_at, 'T', ' '), 'Z', '+00:00') WHERE created_at LIKE '%T%'; +UPDATE media_file SET updated_at = replace(replace(updated_at, 'T', ' '), 'Z', '+00:00') WHERE updated_at LIKE '%T%'; +UPDATE media_file SET birth_time = replace(replace(birth_time, 'T', ' '), 'Z', '+00:00') WHERE birth_time LIKE '%T%'; + +UPDATE artist SET created_at = replace(replace(created_at, 'T', ' '), 'Z', '+00:00') WHERE created_at LIKE '%T%'; +UPDATE artist SET updated_at = replace(replace(updated_at, 'T', ' '), 'Z', '+00:00') WHERE updated_at LIKE '%T%'; +UPDATE artist SET external_info_updated_at = replace(replace(external_info_updated_at, 'T', ' '), 'Z', '+00:00') WHERE external_info_updated_at LIKE '%T%'; + +UPDATE annotation SET play_date = replace(replace(play_date, 'T', ' '), 'Z', '+00:00') WHERE play_date LIKE '%T%'; +UPDATE annotation SET starred_at = replace(replace(starred_at, 'T', ' '), 'Z', '+00:00') WHERE starred_at LIKE '%T%'; +UPDATE annotation SET rated_at = replace(replace(rated_at, 'T', ' '), 'Z', '+00:00') WHERE rated_at LIKE '%T%'; + +UPDATE playlist SET created_at = replace(replace(created_at, 'T', ' '), 'Z', '+00:00') WHERE created_at LIKE '%T%'; +UPDATE playlist SET updated_at = replace(replace(updated_at, 'T', ' '), 'Z', '+00:00') WHERE updated_at LIKE '%T%'; +UPDATE playlist SET evaluated_at = replace(replace(evaluated_at, 'T', ' '), 'Z', '+00:00') WHERE evaluated_at LIKE '%T%'; + +UPDATE user SET created_at = replace(replace(created_at, 'T', ' '), 'Z', '+00:00') WHERE created_at LIKE '%T%'; +UPDATE user SET updated_at = replace(replace(updated_at, 'T', ' '), 'Z', '+00:00') WHERE updated_at LIKE '%T%'; +UPDATE user SET last_login_at = replace(replace(last_login_at, 'T', ' '), 'Z', '+00:00') WHERE last_login_at LIKE '%T%'; +UPDATE user SET last_access_at = replace(replace(last_access_at, 'T', ' '), 'Z', '+00:00') WHERE last_access_at LIKE '%T%'; + +UPDATE player SET last_seen = replace(replace(last_seen, 'T', ' '), 'Z', '+00:00') WHERE last_seen LIKE '%T%'; + +UPDATE playqueue SET created_at = replace(replace(created_at, 'T', ' '), 'Z', '+00:00') WHERE created_at LIKE '%T%'; +UPDATE playqueue SET updated_at = replace(replace(updated_at, 'T', ' '), 'Z', '+00:00') WHERE updated_at LIKE '%T%'; + +UPDATE bookmark SET created_at = replace(replace(created_at, 'T', ' '), 'Z', '+00:00') WHERE created_at LIKE '%T%'; +UPDATE bookmark SET updated_at = replace(replace(updated_at, 'T', ' '), 'Z', '+00:00') WHERE updated_at LIKE '%T%'; + +UPDATE share SET created_at = replace(replace(created_at, 'T', ' '), 'Z', '+00:00') WHERE created_at LIKE '%T%'; +UPDATE share SET updated_at = replace(replace(updated_at, 'T', ' '), 'Z', '+00:00') WHERE updated_at LIKE '%T%'; +UPDATE share SET expires_at = replace(replace(expires_at, 'T', ' '), 'Z', '+00:00') WHERE expires_at LIKE '%T%'; +UPDATE share SET last_visited_at = replace(replace(last_visited_at, 'T', ' '), 'Z', '+00:00') WHERE last_visited_at LIKE '%T%'; + +UPDATE radio SET created_at = replace(replace(created_at, 'T', ' '), 'Z', '+00:00') WHERE created_at LIKE '%T%'; +UPDATE radio SET updated_at = replace(replace(updated_at, 'T', ' '), 'Z', '+00:00') WHERE updated_at LIKE '%T%'; + +UPDATE folder SET created_at = replace(replace(created_at, 'T', ' '), 'Z', '+00:00') WHERE created_at LIKE '%T%'; +UPDATE folder SET updated_at = replace(replace(updated_at, 'T', ' '), 'Z', '+00:00') WHERE updated_at LIKE '%T%'; +UPDATE folder SET images_updated_at = replace(replace(images_updated_at, 'T', ' '), 'Z', '+00:00') WHERE images_updated_at LIKE '%T%'; + +UPDATE library SET created_at = replace(replace(created_at, 'T', ' '), 'Z', '+00:00') WHERE created_at LIKE '%T%'; +UPDATE library SET updated_at = replace(replace(updated_at, 'T', ' '), 'Z', '+00:00') WHERE updated_at LIKE '%T%'; +UPDATE library SET last_scan_at = replace(replace(last_scan_at, 'T', ' '), 'Z', '+00:00') WHERE last_scan_at LIKE '%T%'; +UPDATE library SET last_scan_started_at = replace(replace(last_scan_started_at, 'T', ' '), 'Z', '+00:00') WHERE last_scan_started_at LIKE '%T%'; + +UPDATE scrobble_buffer SET play_time = replace(replace(play_time, 'T', ' '), 'Z', '+00:00') WHERE play_time LIKE '%T%'; +UPDATE scrobble_buffer SET enqueue_time = replace(replace(enqueue_time, 'T', ' '), 'Z', '+00:00') WHERE enqueue_time LIKE '%T%'; + +UPDATE plugin SET created_at = replace(replace(created_at, 'T', ' '), 'Z', '+00:00') WHERE created_at LIKE '%T%'; +UPDATE plugin SET updated_at = replace(replace(updated_at, 'T', ' '), 'Z', '+00:00') WHERE updated_at LIKE '%T%'; + +-- Replace plain indexes with expression indexes for datetime()-based sorting +DROP INDEX IF EXISTS album_created_at; +CREATE INDEX album_created_at ON album(datetime(created_at)); +DROP INDEX IF EXISTS album_updated_at; +CREATE INDEX album_updated_at ON album(datetime(updated_at)); + +-- +goose Down +DROP INDEX IF EXISTS album_created_at; +CREATE INDEX album_created_at ON album(created_at); +DROP INDEX IF EXISTS album_updated_at; +CREATE INDEX album_updated_at ON album(updated_at); diff --git a/db/migrations/20260318182414_add_radio_uploaded_image.go b/db/migrations/20260318182414_add_radio_uploaded_image.go new file mode 100644 index 000000000..e92a6d2ef --- /dev/null +++ b/db/migrations/20260318182414_add_radio_uploaded_image.go @@ -0,0 +1,22 @@ +package migrations + +import ( + "context" + "database/sql" + + "github.com/pressly/goose/v3" +) + +func init() { + goose.AddMigrationContext(upAddRadioUploadedImage, downAddRadioUploadedImage) +} + +func upAddRadioUploadedImage(ctx context.Context, tx *sql.Tx) error { + _, err := tx.ExecContext(ctx, `ALTER TABLE radio ADD COLUMN uploaded_image VARCHAR(255) NOT NULL DEFAULT ''`) + return err +} + +func downAddRadioUploadedImage(ctx context.Context, tx *sql.Tx) error { + // This code is executed when the migration is rolled back. + return nil +} diff --git a/db/migrations/migration.go b/db/migrations/migration.go index 8d8f8a91e..fde6f5817 100644 --- a/db/migrations/migration.go +++ b/db/migrations/migration.go @@ -7,6 +7,7 @@ import ( "strings" "sync" + "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/consts" ) @@ -21,11 +22,13 @@ func notice(tx *sql.Tx, msg string) { // Call this in migrations that requires a full rescan func forceFullRescan(tx *sql.Tx) error { // If a full scan is required, most probably the query optimizer is outdated, so we run `analyze`. - _, err := tx.Exec(`ANALYZE;`) - if err != nil { - return err + if conf.Server.DevOptimizeDB { + _, err := tx.Exec(`ANALYZE;`) + if err != nil { + return err + } } - _, err = tx.Exec(fmt.Sprintf(` + _, err := tx.Exec(fmt.Sprintf(` INSERT OR REPLACE into property (id, value) values ('%s', '1'); `, consts.FullScanAfterMigrationFlagKey)) return err diff --git a/go.mod b/go.mod index e1a827f1d..487b57ef7 100644 --- a/go.mod +++ b/go.mod @@ -1,135 +1,145 @@ module github.com/navidrome/navidrome -go 1.24.5 +go 1.25.0 -// Fork to fix https://github.com/navidrome/navidrome/pull/3254 -replace github.com/dhowden/tag v0.0.0-20240417053706-3d75831295e8 => github.com/deluan/tag v0.0.0-20241002021117-dfe5e6ea396d +// Fork to implement raw tags support +replace go.senan.xyz/taglib => github.com/deluan/go-taglib v0.0.0-20260307161927-168f6e74ada7 require ( github.com/Masterminds/squirrel v1.5.4 - github.com/RaveNoX/go-jsoncommentstrip v1.0.0 github.com/andybalholm/cascadia v1.3.3 - github.com/bmatcuk/doublestar/v4 v4.9.0 + github.com/bmatcuk/doublestar/v4 v4.10.0 github.com/bradleyjkemp/cupaloy/v2 v2.8.0 github.com/deluan/rest v0.0.0-20211102003136-6260bc399cbf github.com/deluan/sanitize v0.0.0-20241120162836-fdfd8fdfaa55 github.com/dexterlb/mpvipc v0.0.0-20241005113212-7cdefca0e933 - github.com/dhowden/tag v0.0.0-20240417053706-3d75831295e8 - github.com/disintegration/imaging v1.6.2 github.com/djherbis/atime v1.1.0 github.com/djherbis/fscache v0.10.2-0.20231127215153-442a07e326c4 github.com/djherbis/stream v1.4.0 github.com/djherbis/times v1.6.0 github.com/dustin/go-humanize v1.0.1 + github.com/extism/go-sdk v1.7.1 github.com/fatih/structs v1.1.0 - github.com/go-chi/chi/v5 v5.2.2 + github.com/gen2brain/webp v0.5.5 + github.com/go-chi/chi/v5 v5.2.5 github.com/go-chi/cors v1.2.2 github.com/go-chi/httprate v0.15.0 - github.com/go-chi/jwtauth/v5 v5.3.3 + github.com/go-chi/jwtauth/v5 v5.4.0 github.com/go-viper/encoding/ini v0.1.1 - github.com/gohugoio/hashstructure v0.5.0 + github.com/gohugoio/hashstructure v0.6.0 github.com/google/go-pipeline v0.0.0-20230411140531-6cbedfc1d3fc github.com/google/uuid v1.6.0 - github.com/google/wire v0.6.0 + github.com/google/wire v0.7.0 github.com/gorilla/websocket v1.5.3 github.com/hashicorp/go-multierror v1.1.1 github.com/jellydator/ttlcache/v3 v3.4.0 github.com/kardianos/service v1.2.4 - github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51 - github.com/knqyf263/go-plugin v0.9.0 github.com/kr/pretty v0.3.1 - github.com/lestrrat-go/jwx/v2 v2.1.6 - github.com/matoous/go-nanoid/v2 v2.1.0 - github.com/mattn/go-sqlite3 v1.14.29 + github.com/lestrrat-go/jwx/v3 v3.0.13 + github.com/mattn/go-sqlite3 v1.14.37 github.com/microcosm-cc/bluemonday v1.0.27 github.com/mileusna/useragent v1.3.5 - github.com/onsi/ginkgo/v2 v2.23.4 - github.com/onsi/gomega v1.38.0 + github.com/onsi/ginkgo/v2 v2.28.1 + github.com/onsi/gomega v1.39.1 github.com/pelletier/go-toml/v2 v2.2.4 - github.com/pocketbase/dbx v1.11.0 - github.com/pressly/goose/v3 v3.24.3 - github.com/prometheus/client_golang v1.22.0 + github.com/pocketbase/dbx v1.12.0 + github.com/pressly/goose/v3 v3.27.0 + github.com/prometheus/client_golang v1.23.2 github.com/rjeczalik/notify v0.9.3 github.com/robfig/cron/v3 v3.0.1 github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06 - github.com/sirupsen/logrus v1.9.3 - github.com/spf13/cobra v1.9.1 - github.com/spf13/viper v1.20.1 - github.com/stretchr/testify v1.10.0 - github.com/tetratelabs/wazero v1.9.0 + github.com/santhosh-tekuri/jsonschema/v6 v6.0.2 + github.com/sirupsen/logrus v1.9.4 + github.com/spf13/cobra v1.10.2 + github.com/spf13/viper v1.21.0 + github.com/stretchr/testify v1.11.1 + github.com/tetratelabs/wazero v1.11.0 github.com/unrolled/secure v1.17.0 github.com/xrash/smetrics v0.0.0-20250705151800-55b8f293f342 + go.senan.xyz/taglib v0.11.1 go.uber.org/goleak v1.3.0 - golang.org/x/exp v0.0.0-20250718183923-645b1fa84792 - golang.org/x/image v0.29.0 - golang.org/x/net v0.42.0 - golang.org/x/sync v0.16.0 - golang.org/x/sys v0.34.0 - golang.org/x/text v0.27.0 - golang.org/x/time v0.12.0 - google.golang.org/protobuf v1.36.6 + golang.org/x/image v0.37.0 + golang.org/x/net v0.52.0 + golang.org/x/sync v0.20.0 + golang.org/x/sys v0.42.0 + golang.org/x/term v0.41.0 + golang.org/x/text v0.35.0 + golang.org/x/time v0.15.0 gopkg.in/yaml.v3 v3.0.1 ) require ( dario.cat/mergo v1.0.2 // indirect + github.com/Masterminds/semver/v3 v3.4.0 // indirect github.com/atombender/go-jsonschema v0.20.0 // indirect github.com/aymerick/douceur v0.2.0 // indirect github.com/beorn7/perks v1.0.1 // indirect github.com/cespare/reflex v0.3.1 // indirect github.com/cespare/xxhash/v2 v2.3.0 // indirect - github.com/creack/pty v1.1.11 // indirect + github.com/creack/pty v1.1.24 // indirect github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect - github.com/decred/dcrd/dcrec/secp256k1/v4 v4.4.0 // indirect + github.com/decred/dcrd/dcrec/secp256k1/v4 v4.4.1 // indirect + github.com/dylibso/observe-sdk/go v0.0.0-20240828172851-9145d8ad07e1 // indirect + github.com/ebitengine/purego v0.10.0 // indirect github.com/fsnotify/fsnotify v1.9.0 // indirect github.com/go-logr/logr v1.4.3 // indirect github.com/go-task/slim-sprig/v3 v3.0.0 // indirect - github.com/go-viper/mapstructure/v2 v2.4.0 // indirect - github.com/goccy/go-json v0.10.5 // indirect - github.com/goccy/go-yaml v1.17.1 // indirect + github.com/go-viper/mapstructure/v2 v2.5.0 // indirect + github.com/gobwas/glob v0.2.3 // indirect + github.com/goccy/go-json v0.10.6 // indirect + github.com/goccy/go-yaml v1.19.2 // indirect github.com/google/go-cmp v0.7.0 // indirect - github.com/google/pprof v0.0.0-20250630185457-6e76a2b096b5 // indirect + github.com/google/pprof v0.0.0-20260302011040-a15ffb7f9dcc // indirect github.com/google/subcommands v1.2.0 // indirect github.com/gorilla/css v1.0.1 // indirect github.com/hashicorp/errwrap v1.1.0 // indirect + github.com/ianlancetaylor/demangle v0.0.0-20251118225945-96ee0021ea0f // indirect github.com/inconshreveable/mousetrap v1.1.0 // indirect + github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51 // indirect github.com/klauspost/cpuid/v2 v2.3.0 // indirect github.com/kr/text v0.2.0 // indirect github.com/lann/builder v0.0.0-20180802200727-47ae307949d0 // indirect github.com/lann/ps v0.0.0-20150810152359-62de8c46ede0 // indirect github.com/lestrrat-go/blackmagic v1.0.4 // indirect + github.com/lestrrat-go/dsig v1.0.0 // indirect + github.com/lestrrat-go/dsig-secp256k1 v1.0.0 // indirect github.com/lestrrat-go/httpcc v1.0.1 // indirect - github.com/lestrrat-go/httprc v1.0.6 // indirect - github.com/lestrrat-go/iter v1.0.2 // indirect - github.com/lestrrat-go/option v1.0.1 // indirect + github.com/lestrrat-go/httprc/v3 v3.0.4 // indirect + github.com/lestrrat-go/option/v2 v2.0.0 // indirect + github.com/maruel/natural v1.3.0 // indirect github.com/mfridman/interpolate v0.0.2 // indirect github.com/mitchellh/go-wordwrap v1.0.1 // indirect github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect github.com/ogier/pflag v0.0.1 // indirect github.com/pkg/errors v0.9.1 // indirect github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect - github.com/prometheus/client_model v0.6.1 // indirect - github.com/prometheus/common v0.62.0 // indirect - github.com/prometheus/procfs v0.16.1 // indirect + github.com/prometheus/client_model v0.6.2 // indirect + github.com/prometheus/common v0.67.5 // indirect + github.com/prometheus/procfs v0.19.2 // indirect github.com/rogpeppe/go-internal v1.14.1 // indirect - github.com/sagikazarmark/locafero v0.9.0 // indirect + github.com/sagikazarmark/locafero v0.12.0 // indirect github.com/sanity-io/litter v1.5.8 // indirect - github.com/segmentio/asm v1.2.0 // indirect + github.com/segmentio/asm v1.2.1 // indirect github.com/sethvargo/go-retry v0.3.0 // indirect github.com/sosodev/duration v1.3.1 // indirect - github.com/sourcegraph/conc v0.3.0 // indirect - github.com/spf13/afero v1.14.0 // indirect - github.com/spf13/cast v1.9.2 // indirect - github.com/spf13/pflag v1.0.7 // indirect - github.com/stretchr/objx v0.5.2 // indirect + github.com/spf13/afero v1.15.0 // indirect + github.com/spf13/cast v1.10.0 // indirect + github.com/spf13/pflag v1.0.10 // indirect + github.com/stretchr/objx v0.5.3 // indirect github.com/subosito/gotenv v1.6.0 // indirect - github.com/zeebo/xxh3 v1.0.2 // indirect - go.uber.org/automaxprocs v1.6.0 // indirect + github.com/tetratelabs/wabin v0.0.0-20230304001439-f6f874872834 // indirect + github.com/valyala/fastjson v1.6.10 // indirect + github.com/zeebo/xxh3 v1.1.0 // indirect + go.opentelemetry.io/proto/otlp v1.10.0 // indirect go.uber.org/multierr v1.11.0 // indirect - golang.org/x/crypto v0.40.0 // indirect - golang.org/x/mod v0.26.0 // indirect - golang.org/x/tools v0.35.0 // indirect - gopkg.in/ini.v1 v1.67.0 // indirect + go.yaml.in/yaml/v2 v2.4.3 // indirect + go.yaml.in/yaml/v3 v3.0.4 // indirect + golang.org/x/crypto v0.49.0 // indirect + golang.org/x/mod v0.34.0 // indirect + golang.org/x/telemetry v0.0.0-20260311193753-579e4da9a98c // indirect + golang.org/x/tools v0.43.0 // indirect + google.golang.org/protobuf v1.36.11 // indirect + gopkg.in/ini.v1 v1.67.1 // indirect gopkg.in/natefinch/npipe.v2 v2.0.0-20160621034901-c1b8fa8bdcce // indirect ) diff --git a/go.sum b/go.sum index 36558f264..d7b16d9d3 100644 --- a/go.sum +++ b/go.sum @@ -1,11 +1,11 @@ dario.cat/mergo v1.0.2 h1:85+piFYR1tMbRrLcDwR18y4UKJ3aH1Tbzi24VRW1TK8= dario.cat/mergo v1.0.2/go.mod h1:E/hbnu0NxMFBjpMIE34DRGLWqDy0g5FuKDhCb31ngxA= -filippo.io/edwards25519 v1.1.0 h1:FNf4tywRC1HmFuKW5xopWpigGjJKiJSV0Cqo0cJWDaA= -filippo.io/edwards25519 v1.1.0/go.mod h1:BxyFTGdWcka3PhytdK4V28tE5sGfRvvvRV7EaN4VDT4= +filippo.io/edwards25519 v1.2.0 h1:crnVqOiS4jqYleHd9vaKZ+HKtHfllngJIiOpNpoJsjo= +filippo.io/edwards25519 v1.2.0/go.mod h1:xzAOLCNug/yB62zG1bQ8uziwrIqIuxhctzJT18Q77mc= +github.com/Masterminds/semver/v3 v3.4.0 h1:Zog+i5UMtVoCU8oKka5P7i9q9HgrJeGzI9SA1Xbatp0= +github.com/Masterminds/semver/v3 v3.4.0/go.mod h1:4V+yj/TJE1HU9XfppCwVMZq3I84lprf4nC11bSS5beM= github.com/Masterminds/squirrel v1.5.4 h1:uUcX/aBc8O7Fg9kaISIUsHXdKuqehiXAMQTYX8afzqM= github.com/Masterminds/squirrel v1.5.4/go.mod h1:NNaOrjSoIDfDA40n7sr2tPNZRfjzjA400rg+riTZj10= -github.com/RaveNoX/go-jsoncommentstrip v1.0.0 h1:t527LHHE3HmiHrq74QMpNPZpGCIJzTx+apLkMKt4HC0= -github.com/RaveNoX/go-jsoncommentstrip v1.0.0/go.mod h1:78ihd09MekBnJnxpICcwzCMzGrKSKYe4AqU6PDYYpjk= github.com/andybalholm/cascadia v1.3.3 h1:AG2YHrzJIm4BZ19iwJ/DAua6Btl3IwJX+VI4kktS1LM= github.com/andybalholm/cascadia v1.3.3/go.mod h1:xNd9bqTn98Ln4DwST8/nG+H0yuB8Hmgu1YHNnWw0GeA= github.com/atombender/go-jsonschema v0.20.0 h1:AHg0LeI0HcjQ686ALwUNqVJjNRcSXpIR6U+wC2J0aFY= @@ -14,8 +14,8 @@ github.com/aymerick/douceur v0.2.0 h1:Mv+mAeH1Q+n9Fr+oyamOlAkUNPWPlA8PPGR0QAaYuP github.com/aymerick/douceur v0.2.0/go.mod h1:wlT5vV2O3h55X9m7iVYN0TBM0NH/MmbLnd30/FjWUq4= github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM= github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw= -github.com/bmatcuk/doublestar/v4 v4.9.0 h1:DBvuZxjdKkRP/dr4GVV4w2fnmrk5Hxc90T51LZjv0JA= -github.com/bmatcuk/doublestar/v4 v4.9.0/go.mod h1:xBQ8jztBU6kakFMg+8WGxn0c6z1fTSPVIjEY1Wr7jzc= +github.com/bmatcuk/doublestar/v4 v4.10.0 h1:zU9WiOla1YA122oLM6i4EXvGW62DvKZVxIe6TYWexEs= +github.com/bmatcuk/doublestar/v4 v4.10.0/go.mod h1:xBQ8jztBU6kakFMg+8WGxn0c6z1fTSPVIjEY1Wr7jzc= github.com/bradleyjkemp/cupaloy/v2 v2.8.0 h1:any4BmKE+jGIaMpnU8YgH/I2LPiLBufr6oMMlVBbn9M= github.com/bradleyjkemp/cupaloy/v2 v2.8.0/go.mod h1:bm7JXdkRd4BHJk9HpwqAI8BoAY1lps46Enkdqw6aRX0= github.com/cespare/reflex v0.3.1 h1:N4Y/UmRrjwOkNT0oQQnYsdr6YBxvHqtSfPB4mqOyAKk= @@ -24,25 +24,24 @@ github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UF github.com/cespare/xxhash/v2 v2.3.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs= github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g= github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E= -github.com/creack/pty v1.1.11 h1:07n33Z8lZxZ2qwegKbObQohDhXDQxiMMz1NOUGYlesw= github.com/creack/pty v1.1.11/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E= +github.com/creack/pty v1.1.24 h1:bJrF4RRfyJnbTJqzRLHzcGaZK1NeM5kTC9jGgovnR1s= +github.com/creack/pty v1.1.24/go.mod h1:08sCNb52WyoAwi2QDyzUCTgcvVFhUzewun7wtTfvcwE= github.com/davecgh/go-spew v0.0.0-20161028175848-04cdfd42973b/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc h1:U9qPSI2PIWSS1VwoXQT9A3Wy9MM3WgvqSxFWenqJduM= github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= -github.com/decred/dcrd/dcrec/secp256k1/v4 v4.4.0 h1:NMZiJj8QnKe1LgsbDayM4UoHwbvwDRwnI3hwNaAHRnc= -github.com/decred/dcrd/dcrec/secp256k1/v4 v4.4.0/go.mod h1:ZXNYxsqcloTdSy/rNShjYzMhyjf0LaoftYK0p+A3h40= +github.com/decred/dcrd/dcrec/secp256k1/v4 v4.4.1 h1:5RVFMOWjMyRy8cARdy79nAmgYw3hK/4HUq48LQ6Wwqo= +github.com/decred/dcrd/dcrec/secp256k1/v4 v4.4.1/go.mod h1:ZXNYxsqcloTdSy/rNShjYzMhyjf0LaoftYK0p+A3h40= +github.com/deluan/go-taglib v0.0.0-20260307161927-168f6e74ada7 h1:RpRSTEsAdLHx3Ci0d3M5wtpjcBZiKzhnGfnNAxGXrAE= +github.com/deluan/go-taglib v0.0.0-20260307161927-168f6e74ada7/go.mod h1:sKDN0U4qXDlq6LFK+aOAkDH4Me5nDV1V/A4B+B69xBA= github.com/deluan/rest v0.0.0-20211102003136-6260bc399cbf h1:tb246l2Zmpt/GpF9EcHCKTtwzrd0HGfEmoODFA/qnk4= github.com/deluan/rest v0.0.0-20211102003136-6260bc399cbf/go.mod h1:tSgDythFsl0QgS/PFWfIZqcJKnkADWneY80jaVRlqK8= github.com/deluan/sanitize v0.0.0-20241120162836-fdfd8fdfaa55 h1:wSCnggTs2f2ji6nFwQmfwgINcmSMj0xF0oHnoyRSPe4= github.com/deluan/sanitize v0.0.0-20241120162836-fdfd8fdfaa55/go.mod h1:ZNCLJfehvEf34B7BbLKjgpsL9lyW7q938w/GY1XgV4E= -github.com/deluan/tag v0.0.0-20241002021117-dfe5e6ea396d h1:x/R3+oPEjnisl1zBx2f2v7Gf6f11l0N0JoD6BkwcJyA= -github.com/deluan/tag v0.0.0-20241002021117-dfe5e6ea396d/go.mod h1:apkPC/CR3s48O2D7Y++n1XWEpgPNNCjXYga3PPbJe2E= github.com/dexterlb/mpvipc v0.0.0-20241005113212-7cdefca0e933 h1:r4hxcT6GBIA/j8Ox4OXI5MNgMKfR+9plcAWYi1OnmOg= github.com/dexterlb/mpvipc v0.0.0-20241005113212-7cdefca0e933/go.mod h1:RkQWLNITKkXHLP7LXxZSgEq+uFWU25M5qW7qfEhL9Wc= -github.com/disintegration/imaging v1.6.2 h1:w1LecBlG2Lnp8B3jk5zSuNqd7b4DXhcjwek1ei82L+c= -github.com/disintegration/imaging v1.6.2/go.mod h1:44/5580QXChDfwIclfc/PCwrr44amcmDAg8hxG0Ewe4= github.com/djherbis/atime v1.1.0 h1:rgwVbP/5by8BvvjBNrbh64Qz33idKT3pSnMSJsxhi0g= github.com/djherbis/atime v1.1.0/go.mod h1:28OF6Y8s3NQWwacXc5eZTsEsiMzp7LF8MbXE+XJPdBE= github.com/djherbis/fscache v0.10.2-0.20231127215153-442a07e326c4 h1:wdZllsLrDJtYfHiAKogB4PNHSDeO+v+5S3eqSWHGDlc= @@ -51,8 +50,16 @@ github.com/djherbis/stream v1.4.0 h1:aVD46WZUiq5kJk55yxJAyw6Kuera6kmC3i2vEQyW/AE github.com/djherbis/stream v1.4.0/go.mod h1:cqjC1ZRq3FFwkGmUtHwcldbnW8f0Q4YuVsGW1eAFtOk= github.com/djherbis/times v1.6.0 h1:w2ctJ92J8fBvWPxugmXIv7Nz7Q3iDMKNx9v5ocVH20c= github.com/djherbis/times v1.6.0/go.mod h1:gOHeRAz2h+VJNZ5Gmc/o7iD9k4wW7NMVqieYCY99oc0= +github.com/dlclark/regexp2 v1.11.0 h1:G/nrcoOa7ZXlpoa/91N3X7mM3r8eIlMBBJZvsz/mxKI= +github.com/dlclark/regexp2 v1.11.0/go.mod h1:DHkYz0B9wPfa6wondMfaivmHpzrQ3v9q8cnmRbL6yW8= github.com/dustin/go-humanize v1.0.1 h1:GzkhY7T5VNhEkwH0PVJgjz+fX1rhBrR7pRT3mDkpeCY= github.com/dustin/go-humanize v1.0.1/go.mod h1:Mu1zIs6XwVuF/gI1OepvI0qD18qycQx+mFykh5fBlto= +github.com/dylibso/observe-sdk/go v0.0.0-20240828172851-9145d8ad07e1 h1:idfl8M8rPW93NehFw5H1qqH8yG158t5POr+LX9avbJY= +github.com/dylibso/observe-sdk/go v0.0.0-20240828172851-9145d8ad07e1/go.mod h1:C8DzXehI4zAbrdlbtOByKX6pfivJTBiV9Jjqv56Yd9Q= +github.com/ebitengine/purego v0.10.0 h1:QIw4xfpWT6GWTzaW5XEKy3HXoqrJGx1ijYHzTF0/ISU= +github.com/ebitengine/purego v0.10.0/go.mod h1:iIjxzd6CiRiOG0UyXP+V1+jWqUXVjPKLAI0mRfJZTmQ= +github.com/extism/go-sdk v1.7.1 h1:lWJos6uY+tRFdlIHR+SJjwFDApY7OypS/2nMhiVQ9Sw= +github.com/extism/go-sdk v1.7.1/go.mod h1:IT+Xdg5AZM9hVtpFUA+uZCJMge/hbvshl8bwzLtFyKA= github.com/fatih/structs v1.1.0 h1:Q7juDM0QtcnhCpeyLGQKyg4TOIghuNXrkL32pHAUMxo= github.com/fatih/structs v1.1.0/go.mod h1:9NiDSp5zOcgEDl+j00MP/WkGVPOlPRLejGD8Ga6PJ7M= github.com/frankban/quicktest v1.14.6 h1:7Xjx+VpznH+oBnejlPUj8oUpdxnVs4f8XU8WnHkI4W8= @@ -60,46 +67,55 @@ github.com/frankban/quicktest v1.14.6/go.mod h1:4ptaffx2x8+WTWXmUCuVU6aPUX1/Mz7z github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo= github.com/fsnotify/fsnotify v1.9.0 h1:2Ml+OJNzbYCTzsxtv8vKSFD9PbJjmhYF14k/jKC7S9k= github.com/fsnotify/fsnotify v1.9.0/go.mod h1:8jBTzvmWwFyi3Pb8djgCCO5IBqzKJ/Jwo8TRcHyHii0= -github.com/go-chi/chi/v5 v5.2.2 h1:CMwsvRVTbXVytCk1Wd72Zy1LAsAh9GxMmSNWLHCG618= -github.com/go-chi/chi/v5 v5.2.2/go.mod h1:L2yAIGWB3H+phAw1NxKwWM+7eUH/lU8pOMm5hHcoops= +github.com/gen2brain/webp v0.5.5 h1:MvQR75yIPU/9nSqYT5h13k4URaJK3gf9tgz/ksRbyEg= +github.com/gen2brain/webp v0.5.5/go.mod h1:xOSMzp4aROt2KFW++9qcK/RBTOVC2S9tJG66ip/9Oc0= +github.com/gkampitakis/ciinfo v0.3.2 h1:JcuOPk8ZU7nZQjdUhctuhQofk7BGHuIy0c9Ez8BNhXs= +github.com/gkampitakis/ciinfo v0.3.2/go.mod h1:1NIwaOcFChN4fa/B0hEBdAb6npDlFL8Bwx4dfRLRqAo= +github.com/gkampitakis/go-diff v1.3.2 h1:Qyn0J9XJSDTgnsgHRdz9Zp24RaJeKMUHg2+PDZZdC4M= +github.com/gkampitakis/go-diff v1.3.2/go.mod h1:LLgOrpqleQe26cte8s36HTWcTmMEur6OPYerdAAS9tk= +github.com/gkampitakis/go-snaps v0.5.15 h1:amyJrvM1D33cPHwVrjo9jQxX8g/7E2wYdZ+01KS3zGE= +github.com/gkampitakis/go-snaps v0.5.15/go.mod h1:HNpx/9GoKisdhw9AFOBT1N7DBs9DiHo/hGheFGBZ+mc= +github.com/go-chi/chi/v5 v5.2.5 h1:Eg4myHZBjyvJmAFjFvWgrqDTXFyOzjj7YIm3L3mu6Ug= +github.com/go-chi/chi/v5 v5.2.5/go.mod h1:X7Gx4mteadT3eDOMTsXzmI4/rwUpOwBHLpAfupzFJP0= github.com/go-chi/cors v1.2.2 h1:Jmey33TE+b+rB7fT8MUy1u0I4L+NARQlK6LhzKPSyQE= github.com/go-chi/cors v1.2.2/go.mod h1:sSbTewc+6wYHBBCW7ytsFSn836hqM7JxpglAy2Vzc58= github.com/go-chi/httprate v0.15.0 h1:j54xcWV9KGmPf/X4H32/aTH+wBlrvxL7P+SdnRqxh5g= github.com/go-chi/httprate v0.15.0/go.mod h1:rzGHhVrsBn3IMLYDOZQsSU4fJNWcjui4fWKJcCId1R4= -github.com/go-chi/jwtauth/v5 v5.3.3 h1:50Uzmacu35/ZP9ER2Ht6SazwPsnLQ9LRJy6zTZJpHEo= -github.com/go-chi/jwtauth/v5 v5.3.3/go.mod h1:O4QvPRuZLZghl9WvfVaON+ARfGzpD2PBX/QY5vUz7aQ= +github.com/go-chi/jwtauth/v5 v5.4.0 h1:Ieh0xMJsFvqylqJ02/mQHKzbbKO9DYNBh4DPKCwTwYI= +github.com/go-chi/jwtauth/v5 v5.4.0/go.mod h1:w6yjqUUXz1b8+oiJel64Sz1KJwduQM6qUA5QNzO5+bQ= github.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI= github.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY= github.com/go-sql-driver/mysql v1.4.1/go.mod h1:zAC/RDZ24gD3HViQzih4MyKcchzm+sOG5ZlKdlhCg5w= -github.com/go-sql-driver/mysql v1.9.2 h1:4cNKDYQ1I84SXslGddlsrMhc8k4LeDVj6Ad6WRjiHuU= -github.com/go-sql-driver/mysql v1.9.2/go.mod h1:qn46aNg1333BRMNU69Lq93t8du/dwxI64Gl8i5p1WMU= +github.com/go-sql-driver/mysql v1.9.3 h1:U/N249h2WzJ3Ukj8SowVFjdtZKfu9vlLZxjPXV1aweo= +github.com/go-sql-driver/mysql v1.9.3/go.mod h1:qn46aNg1333BRMNU69Lq93t8du/dwxI64Gl8i5p1WMU= github.com/go-task/slim-sprig/v3 v3.0.0 h1:sUs3vkvUymDpBKi3qH1YSqBQk9+9D/8M2mN1vB6EwHI= github.com/go-task/slim-sprig/v3 v3.0.0/go.mod h1:W848ghGpv3Qj3dhTPRyJypKRiqCdHZiAzKg9hl15HA8= github.com/go-viper/encoding/ini v0.1.1 h1:MVWY7B2XNw7lnOqHutGRc97bF3rP7omOdgjdMPAJgbs= github.com/go-viper/encoding/ini v0.1.1/go.mod h1:Pfi4M2V1eAGJVZ5q6FrkHPhtHED2YgLlXhvgMVrB+YQ= -github.com/go-viper/mapstructure/v2 v2.4.0 h1:EBsztssimR/CONLSZZ04E8qAkxNYq4Qp9LvH92wZUgs= -github.com/go-viper/mapstructure/v2 v2.4.0/go.mod h1:oJDH3BJKyqBA2TXFhDsKDGDTlndYOZ6rGS0BRZIxGhM= -github.com/goccy/go-json v0.10.5 h1:Fq85nIqj+gXn/S5ahsiTlK3TmC85qgirsdTP/+DeaC4= -github.com/goccy/go-json v0.10.5/go.mod h1:oq7eo15ShAhp70Anwd5lgX2pLfOS3QCiwU/PULtXL6M= -github.com/goccy/go-yaml v1.17.1 h1:LI34wktB2xEE3ONG/2Ar54+/HJVBriAGJ55PHls4YuY= -github.com/goccy/go-yaml v1.17.1/go.mod h1:XBurs7gK8ATbW4ZPGKgcbrY1Br56PdM69F7LkFRi1kA= -github.com/gohugoio/hashstructure v0.5.0 h1:G2fjSBU36RdwEJBWJ+919ERvOVqAg9tfcYp47K9swqg= -github.com/gohugoio/hashstructure v0.5.0/go.mod h1:Ser0TniXuu/eauYmrwM4o64EBvySxNzITEOLlm4igec= +github.com/go-viper/mapstructure/v2 v2.5.0 h1:vM5IJoUAy3d7zRSVtIwQgBj7BiWtMPfmPEgAXnvj1Ro= +github.com/go-viper/mapstructure/v2 v2.5.0/go.mod h1:oJDH3BJKyqBA2TXFhDsKDGDTlndYOZ6rGS0BRZIxGhM= +github.com/gobwas/glob v0.2.3 h1:A4xDbljILXROh+kObIiy5kIaPYD8e96x1tgBhUI5J+Y= +github.com/gobwas/glob v0.2.3/go.mod h1:d3Ez4x06l9bZtSvzIay5+Yzi0fmZzPgnTbPcKjJAkT8= +github.com/goccy/go-json v0.10.6 h1:p8HrPJzOakx/mn/bQtjgNjdTcN+/S6FcG2CTtQOrHVU= +github.com/goccy/go-json v0.10.6/go.mod h1:oq7eo15ShAhp70Anwd5lgX2pLfOS3QCiwU/PULtXL6M= +github.com/goccy/go-yaml v1.19.2 h1:PmFC1S6h8ljIz6gMRBopkjP1TVT7xuwrButHID66PoM= +github.com/goccy/go-yaml v1.19.2/go.mod h1:XBurs7gK8ATbW4ZPGKgcbrY1Br56PdM69F7LkFRi1kA= +github.com/gohugoio/hashstructure v0.6.0 h1:7wMB/2CfXoThFYhdWRGv3u3rUM761Cq29CxUW+NltUg= +github.com/gohugoio/hashstructure v0.6.0/go.mod h1:lapVLk9XidheHG1IQ4ZSbyYrXcaILU1ZEP/+vno5rBQ= github.com/golang/protobuf v1.3.1/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= -github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M= github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8= github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU= github.com/google/go-pipeline v0.0.0-20230411140531-6cbedfc1d3fc h1:hd+uUVsB1vdxohPneMrhGH2YfQuH5hRIK9u4/XCeUtw= github.com/google/go-pipeline v0.0.0-20230411140531-6cbedfc1d3fc/go.mod h1:SL66SJVysrh7YbDCP9tH30b8a9o/N2HeiQNUm85EKhc= -github.com/google/pprof v0.0.0-20250630185457-6e76a2b096b5 h1:xhMrHhTJ6zxu3gA4enFM9MLn9AY7613teCdFnlUVbSQ= -github.com/google/pprof v0.0.0-20250630185457-6e76a2b096b5/go.mod h1:5hDyRhoBCxViHszMt12TnOpEI4VVi+U8Gm9iphldiMA= +github.com/google/pprof v0.0.0-20260302011040-a15ffb7f9dcc h1:VBbFa1lDYWEeV5FZKUiYKYT0VxCp9twUmmaq9eb8sXw= +github.com/google/pprof v0.0.0-20260302011040-a15ffb7f9dcc/go.mod h1:MxpfABSjhmINe3F1It9d+8exIHFvUqtLIRCdOGNXqiI= github.com/google/subcommands v1.2.0 h1:vWQspBTo2nEqTUFita5/KeEWlUL8kQObDFbub/EN9oE= github.com/google/subcommands v1.2.0/go.mod h1:ZjhPrFU+Olkh9WazFPsl27BQ4UPiG37m3yTrtFlrHVk= github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0= github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= -github.com/google/wire v0.6.0 h1:HBkoIh4BdSxoyo9PveV8giw7ZsaBOvzWKfcg/6MrVwI= -github.com/google/wire v0.6.0/go.mod h1:F4QhpQ9EDIdJ1Mbop/NZBRB+5yrR6qg3BnctaoUk6NA= +github.com/google/wire v0.7.0 h1:JxUKI6+CVBgCO2WToKy/nQk0sS+amI9z9EjVmdaocj4= +github.com/google/wire v0.7.0/go.mod h1:n6YbUQD9cPKTnHXEBN2DXlOp/mVADhVErcMFb0v3J18= github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1 h1:EGx4pi6eqNxGaHF6qqu48+N2wcFQ5qg5FXgOdqsJ5d8= github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1/go.mod h1:wJfORRmW1u3UXTncJ5qlYoELFm8eSnnEO6hX4iZ3EWY= github.com/gorilla/css v1.0.1 h1:ntNaBIghp6JmvWnxbZKANoLyuXTPZ4cAMlo6RyhlbO8= @@ -111,22 +127,24 @@ github.com/hashicorp/errwrap v1.1.0 h1:OxrOeh75EUXMY8TBjag2fzXGZ40LB6IKw45YeGUDY github.com/hashicorp/errwrap v1.1.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4= github.com/hashicorp/go-multierror v1.1.1 h1:H5DkEtf6CXdFp0N0Em5UCwQpXMWke8IA0+lD48awMYo= github.com/hashicorp/go-multierror v1.1.1/go.mod h1:iw975J/qwKPdAO1clOe2L8331t/9/fmwbPZ6JB6eMoM= +github.com/ianlancetaylor/demangle v0.0.0-20251118225945-96ee0021ea0f h1:Fnl4pzx8SR7k7JuzyW8lEtSFH6EQ8xgcypgIn8pcGIE= +github.com/ianlancetaylor/demangle v0.0.0-20251118225945-96ee0021ea0f/go.mod h1:gx7rwoVhcfuVKG5uya9Hs3Sxj7EIvldVofAWIUtGouw= github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8= github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw= github.com/jellydator/ttlcache/v3 v3.4.0 h1:YS4P125qQS0tNhtL6aeYkheEaB/m8HCqdMMP4mnWdTY= github.com/jellydator/ttlcache/v3 v3.4.0/go.mod h1:Hw9EgjymziQD3yGsQdf1FqFdpp7YjFMd4Srg5EJlgD4= +github.com/joshdk/go-junit v1.0.0 h1:S86cUKIdwBHWwA6xCmFlf3RTLfVXYQfvanM5Uh+K6GE= +github.com/joshdk/go-junit v1.0.0/go.mod h1:TiiV0PqkaNfFXjEiyjWM3XXrhVyCa1K4Zfga6W52ung= github.com/jtolds/gls v4.20.0+incompatible h1:xdiiI2gbIgH/gLH7ADydsJ1uDOEzR8yvV7C0MuV77Wo= github.com/jtolds/gls v4.20.0+incompatible/go.mod h1:QJZ7F/aHp+rZTRtaJ1ow/lLfFfVYBRgL+9YlvaHOwJU= github.com/kardianos/service v1.2.4 h1:XNlGtZOYNx2u91urOdg/Kfmc+gfmuIo1Dd3rEi2OgBk= github.com/kardianos/service v1.2.4/go.mod h1:E4V9ufUuY82F7Ztlu1eN9VXWIQxg8NoLQlmFe0MtrXc= github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51 h1:Z9n2FFNUXsshfwJMBgNA0RU6/i7WVaAegv3PtuIHPMs= github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51/go.mod h1:CzGEWj7cYgsdH8dAjBGEr58BoE7ScuLd+fwFZ44+/x8= -github.com/klauspost/compress v1.18.0 h1:c/Cqfb0r+Yi+JtIEq73FWXVkRonBlf0CRNYc8Zttxdo= -github.com/klauspost/compress v1.18.0/go.mod h1:2Pp+KzxcywXVXMr50+X0Q/Lsb43OQHYWRCY2AiWywWQ= +github.com/klauspost/compress v1.18.4 h1:RPhnKRAQ4Fh8zU2FY/6ZFDwTVTxgJ/EMydqSTzE9a2c= +github.com/klauspost/compress v1.18.4/go.mod h1:R0h/fSBs8DE4ENlcrlib3PsXS61voFxhIs2DeRhCvJ4= github.com/klauspost/cpuid/v2 v2.3.0 h1:S4CRMLnYUhGeDFDqkGriYKdfoFlDnMtqTiI/sFzhA9Y= github.com/klauspost/cpuid/v2 v2.3.0/go.mod h1:hqwkgyIinND0mEev00jJYCxPNVRVXFQeu1XKlok6oO0= -github.com/knqyf263/go-plugin v0.9.0 h1:CQs2+lOPIlkZVtcb835ZYDEoyyWJWLbSTWeCs0EwTwI= -github.com/knqyf263/go-plugin v0.9.0/go.mod h1:2z5lCO1/pez6qGo8CvCxSlBFSEat4MEp1DrnA+f7w8Q= github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ= github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= @@ -143,24 +161,28 @@ github.com/lann/ps v0.0.0-20150810152359-62de8c46ede0 h1:P6pPBnrTSX3DEVR4fDembhR github.com/lann/ps v0.0.0-20150810152359-62de8c46ede0/go.mod h1:vmVJ0l/dxyfGW6FmdpVm2joNMFikkuWg0EoCKLGUMNw= github.com/lestrrat-go/blackmagic v1.0.4 h1:IwQibdnf8l2KoO+qC3uT4OaTWsW7tuRQXy9TRN9QanA= github.com/lestrrat-go/blackmagic v1.0.4/go.mod h1:6AWFyKNNj0zEXQYfTMPfZrAXUWUfTIZ5ECEUEJaijtw= +github.com/lestrrat-go/dsig v1.0.0 h1:OE09s2r9Z81kxzJYRn07TFM9XA4akrUdoMwr0L8xj38= +github.com/lestrrat-go/dsig v1.0.0/go.mod h1:dEgoOYYEJvW6XGbLasr8TFcAxoWrKlbQvmJgCR0qkDo= +github.com/lestrrat-go/dsig-secp256k1 v1.0.0 h1:JpDe4Aybfl0soBvoVwjqDbp+9S1Y2OM7gcrVVMFPOzY= +github.com/lestrrat-go/dsig-secp256k1 v1.0.0/go.mod h1:CxUgAhssb8FToqbL8NjSPoGQlnO4w3LG1P0qPWQm/NU= github.com/lestrrat-go/httpcc v1.0.1 h1:ydWCStUeJLkpYyjLDHihupbn2tYmZ7m22BGkcvZZrIE= github.com/lestrrat-go/httpcc v1.0.1/go.mod h1:qiltp3Mt56+55GPVCbTdM9MlqhvzyuL6W/NMDA8vA5E= -github.com/lestrrat-go/httprc v1.0.6 h1:qgmgIRhpvBqexMJjA/PmwSvhNk679oqD1RbovdCGW8k= -github.com/lestrrat-go/httprc v1.0.6/go.mod h1:mwwz3JMTPBjHUkkDv/IGJ39aALInZLrhBp0X7KGUZlo= -github.com/lestrrat-go/iter v1.0.2 h1:gMXo1q4c2pHmC3dn8LzRhJfP1ceCbgSiT9lUydIzltI= -github.com/lestrrat-go/iter v1.0.2/go.mod h1:Momfcq3AnRlRjI5b5O8/G5/BvpzrhoFTZcn06fEOPt4= -github.com/lestrrat-go/jwx/v2 v2.1.6 h1:hxM1gfDILk/l5ylers6BX/Eq1m/pnxe9NBwW6lVfecA= -github.com/lestrrat-go/jwx/v2 v2.1.6/go.mod h1:Y722kU5r/8mV7fYDifjug0r8FK8mZdw0K0GpJw/l8pU= -github.com/lestrrat-go/option v1.0.1 h1:oAzP2fvZGQKWkvHa1/SAcFolBEca1oN+mQ7eooNBEYU= -github.com/lestrrat-go/option v1.0.1/go.mod h1:5ZHFbivi4xwXxhxY9XHDe2FHo6/Z7WWmtT7T5nBBp3I= -github.com/matoous/go-nanoid/v2 v2.1.0 h1:P64+dmq21hhWdtvZfEAofnvJULaRR1Yib0+PnU669bE= -github.com/matoous/go-nanoid/v2 v2.1.0/go.mod h1:KlbGNQ+FhrUNIHUxZdL63t7tl4LaPkZNpUULS8H4uVM= +github.com/lestrrat-go/httprc/v3 v3.0.4 h1:pXyH2ppK8GYYggygxJ3TvxpCZnbEUWc9qSwRTTApaLA= +github.com/lestrrat-go/httprc/v3 v3.0.4/go.mod h1:mSMtkZW92Z98M5YoNNztbRGxbXHql7tSitCvaxvo9l0= +github.com/lestrrat-go/jwx/v3 v3.0.13 h1:AdHKiPIYeCSnOJtvdpipPg/0SuFh9rdkN+HF3O0VdSk= +github.com/lestrrat-go/jwx/v3 v3.0.13/go.mod h1:2m0PV1A9tM4b/jVLMx8rh6rBl7F6WGb3EG2hufN9OQU= +github.com/lestrrat-go/option/v2 v2.0.0 h1:XxrcaJESE1fokHy3FpaQ/cXW8ZsIdWcdFzzLOcID3Ss= +github.com/lestrrat-go/option/v2 v2.0.0/go.mod h1:oSySsmzMoR0iRzCDCaUfsCzxQHUEuhOViQObyy7S6Vg= +github.com/maruel/natural v1.3.0 h1:VsmCsBmEyrR46RomtgHs5hbKADGRVtliHTyCOLFBpsg= +github.com/maruel/natural v1.3.0/go.mod h1:v+Rfd79xlw1AgVBjbO0BEQmptqb5HvL/k9GRHB7ZKEg= github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= -github.com/mattn/go-sqlite3 v1.14.29 h1:1O6nRLJKvsi1H2Sj0Hzdfojwt8GiGKm+LOfLaBFaouQ= -github.com/mattn/go-sqlite3 v1.14.29/go.mod h1:Uh1q+B4BYcTPb+yiD3kU8Ct7aC0hY9fxUwlHK0RXw+Y= +github.com/mattn/go-sqlite3 v1.14.37 h1:3DOZp4cXis1cUIpCfXLtmlGolNLp2VEqhiB/PARNBIg= +github.com/mattn/go-sqlite3 v1.14.37/go.mod h1:Uh1q+B4BYcTPb+yiD3kU8Ct7aC0hY9fxUwlHK0RXw+Y= github.com/mfridman/interpolate v0.0.2 h1:pnuTK7MQIxxFz1Gr+rjSIx9u7qVjf5VOoM/u6BbAxPY= github.com/mfridman/interpolate v0.0.2/go.mod h1:p+7uk6oE07mpE/Ik1b8EckO0O4ZXiGAfshKBWLUM9Xg= +github.com/mfridman/tparse v0.18.0 h1:wh6dzOKaIwkUGyKgOntDW4liXSo37qg5AXbIhkMV3vE= +github.com/mfridman/tparse v0.18.0/go.mod h1:gEvqZTuCgEhPbYk/2lS3Kcxg1GmTxxU7kTC8DvP0i/A= github.com/microcosm-cc/bluemonday v1.0.27 h1:MpEUotklkwCSLeH+Qdx1VJgNqLlpY2KXwXFM08ygZfk= github.com/microcosm-cc/bluemonday v1.0.27/go.mod h1:jFi9vgW+H7c3V0lb6nR74Ib/DIB5OBs92Dimizgw2cA= github.com/mileusna/useragent v1.3.5 h1:SJM5NzBmh/hO+4LGeATKpaEX9+b4vcGg2qXGLiNGDws= @@ -169,14 +191,14 @@ github.com/mitchellh/go-wordwrap v1.0.1 h1:TLuKupo69TCn6TQSyGxwI1EblZZEsQ0vMlAFQ github.com/mitchellh/go-wordwrap v1.0.1/go.mod h1:R62XHJLzvMFRBbcrT7m7WgmE1eOyTSsCt+hzestvNj0= github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 h1:C3w9PqII01/Oq1c1nUAm88MOHcQC9l5mIlSMApZMrHA= github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ= -github.com/ncruces/go-strftime v0.1.9 h1:bY0MQC28UADQmHmaF5dgpLmImcShSi2kHU9XLdhx/f4= -github.com/ncruces/go-strftime v0.1.9/go.mod h1:Fwc5htZGVVkseilnfgOVb9mKy6w1naJmn9CehxcKcls= +github.com/ncruces/go-strftime v1.0.0 h1:HMFp8mLCTPp341M/ZnA4qaf7ZlsbTc+miZjCLOFAw7w= +github.com/ncruces/go-strftime v1.0.0/go.mod h1:Fwc5htZGVVkseilnfgOVb9mKy6w1naJmn9CehxcKcls= github.com/ogier/pflag v0.0.1 h1:RW6JSWSu/RkSatfcLtogGfFgpim5p7ARQ10ECk5O750= github.com/ogier/pflag v0.0.1/go.mod h1:zkFki7tvTa0tafRvTBIZTvzYyAu6kQhPZFnshFFPE+g= -github.com/onsi/ginkgo/v2 v2.23.4 h1:ktYTpKJAVZnDT4VjxSbiBenUjmlL/5QkBEocaWXiQus= -github.com/onsi/ginkgo/v2 v2.23.4/go.mod h1:Bt66ApGPBFzHyR+JO10Zbt0Gsp4uWxu5mIOTusL46e8= -github.com/onsi/gomega v1.38.0 h1:c/WX+w8SLAinvuKKQFh77WEucCnPk4j2OTUr7lt7BeY= -github.com/onsi/gomega v1.38.0/go.mod h1:OcXcwId0b9QsE7Y49u+BTrL4IdKOBOKnD6VQNTJEB6o= +github.com/onsi/ginkgo/v2 v2.28.1 h1:S4hj+HbZp40fNKuLUQOYLDgZLwNUVn19N3Atb98NCyI= +github.com/onsi/ginkgo/v2 v2.28.1/go.mod h1:CLtbVInNckU3/+gC8LzkGUb9oF+e8W8TdUsxPwvdOgE= +github.com/onsi/gomega v1.39.1 h1:1IJLAad4zjPn2PsnhH70V4DKRFlrCzGBNrNaru+Vf28= +github.com/onsi/gomega v1.39.1/go.mod h1:hL6yVALoTOxeWudERyfppUcZXjMwIMLnuSfruD2lcfg= github.com/pelletier/go-toml/v2 v2.2.4 h1:mye9XuhQ6gvn5h28+VilKrrPoQVanw5PMw/TB0t5Ec4= github.com/pelletier/go-toml/v2 v2.2.4/go.mod h1:2gIqNv+qfxSVS7cM2xJQKtLSTLUE9V8t9Stt+h56mCY= github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e/go.mod h1:pJLUxLENpZxwdsKMEsNbx1VGcRFpLqf3715MtcvvzbA= @@ -186,20 +208,18 @@ github.com/pmezard/go-difflib v0.0.0-20151028094244-d8ed2627bdf0/go.mod h1:iKH77 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 h1:Jamvg5psRIccs7FGNTlIRMkT8wgtp5eCXdBlqhYGL6U= github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= -github.com/pocketbase/dbx v1.11.0 h1:LpZezioMfT3K4tLrqA55wWFw1EtH1pM4tzSVa7kgszU= -github.com/pocketbase/dbx v1.11.0/go.mod h1:xXRCIAKTHMgUCyCKZm55pUOdvFziJjQfXaWKhu2vhMs= -github.com/prashantv/gostub v1.1.0 h1:BTyx3RfQjRHnUWaGF9oQos79AlQ5k8WNktv7VGvVH4g= -github.com/prashantv/gostub v1.1.0/go.mod h1:A5zLQHz7ieHGG7is6LLXLz7I8+3LZzsrV0P1IAHhP5U= -github.com/pressly/goose/v3 v3.24.3 h1:DSWWNwwggVUsYZ0X2VitiAa9sKuqtBfe+Jr9zFGwWlM= -github.com/pressly/goose/v3 v3.24.3/go.mod h1:v9zYL4xdViLHCUUJh/mhjnm6JrK7Eul8AS93IxiZM4E= -github.com/prometheus/client_golang v1.22.0 h1:rb93p9lokFEsctTys46VnV1kLCDpVZ0a/Y92Vm0Zc6Q= -github.com/prometheus/client_golang v1.22.0/go.mod h1:R7ljNsLXhuQXYZYtw6GAE9AZg8Y7vEW5scdCXrWRXC0= -github.com/prometheus/client_model v0.6.1 h1:ZKSh/rekM+n3CeS952MLRAdFwIKqeY8b62p8ais2e9E= -github.com/prometheus/client_model v0.6.1/go.mod h1:OrxVMOVHjw3lKMa8+x6HeMGkHMQyHDk9E3jmP2AmGiY= -github.com/prometheus/common v0.62.0 h1:xasJaQlnWAeyHdUBeGjXmutelfJHWMRr+Fg4QszZ2Io= -github.com/prometheus/common v0.62.0/go.mod h1:vyBcEuLSvWos9B1+CyL7JZ2up+uFzXhkqml0W5zIY1I= -github.com/prometheus/procfs v0.16.1 h1:hZ15bTNuirocR6u0JZ6BAHHmwS1p8B4P6MRqxtzMyRg= -github.com/prometheus/procfs v0.16.1/go.mod h1:teAbpZRB1iIAJYREa1LsoWUXykVXA1KlTmWl8x/U+Is= +github.com/pocketbase/dbx v1.12.0 h1:/oLErM+A0b4xI0PWTGPqSDVjzix48PqI/bng2l0PzoA= +github.com/pocketbase/dbx v1.12.0/go.mod h1:xXRCIAKTHMgUCyCKZm55pUOdvFziJjQfXaWKhu2vhMs= +github.com/pressly/goose/v3 v3.27.0 h1:/D30gVTuQhu0WsNZYbJi4DMOsx1lNq+6SkLe+Wp59BM= +github.com/pressly/goose/v3 v3.27.0/go.mod h1:3ZBeCXqzkgIRvrEMDkYh1guvtoJTU5oMMuDdkutoM78= +github.com/prometheus/client_golang v1.23.2 h1:Je96obch5RDVy3FDMndoUsjAhG5Edi49h0RJWRi/o0o= +github.com/prometheus/client_golang v1.23.2/go.mod h1:Tb1a6LWHB3/SPIzCoaDXI4I8UHKeFTEQ1YCr+0Gyqmg= +github.com/prometheus/client_model v0.6.2 h1:oBsgwpGs7iVziMvrGhE53c/GrLUsZdHnqNwqPLxwZyk= +github.com/prometheus/client_model v0.6.2/go.mod h1:y3m2F6Gdpfy6Ut/GBsUqTWZqCUvMVzSfMLjcu6wAwpE= +github.com/prometheus/common v0.67.5 h1:pIgK94WWlQt1WLwAC5j2ynLaBRDiinoAb86HZHTUGI4= +github.com/prometheus/common v0.67.5/go.mod h1:SjE/0MzDEEAyrdr5Gqc6G+sXI67maCxzaT3A2+HqjUw= +github.com/prometheus/procfs v0.19.2 h1:zUMhqEW66Ex7OXIiDkll3tl9a1ZdilUOd/F6ZXw4Vws= +github.com/prometheus/procfs v0.19.2/go.mod h1:M0aotyiemPhBCM0z5w87kL22CxfcH05ZpYlu+b4J7mw= github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec h1:W09IVJc94icq4NjY3clb7Lk8O1qJ8BdBEF8z0ibU0rE= github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec/go.mod h1:qqbHyh8v60DhA7CoWK5oRCqLrMHRGoxYCSS9EjAz6Eo= github.com/rjeczalik/notify v0.9.3 h1:6rJAzHTGKXGj76sbRgDiDcYj/HniypXmSJo1SWakZeY= @@ -212,89 +232,106 @@ github.com/rogpeppe/go-internal v1.14.1/go.mod h1:MaRKkUm5W0goXpeCfT7UZI6fk/L7L7 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06 h1:OkMGxebDjyw0ULyrTYWeN0UNCCkmCWfjPnIA2W6oviI= github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06/go.mod h1:+ePHsJ1keEjQtpvf9HHw0f4ZeJ0TLRsxhunSI2hYJSs= -github.com/sagikazarmark/locafero v0.9.0 h1:GbgQGNtTrEmddYDSAH9QLRyfAHY12md+8YFTqyMTC9k= -github.com/sagikazarmark/locafero v0.9.0/go.mod h1:UBUyz37V+EdMS3hDF3QWIiVr/2dPrx49OMO0Bn0hJqk= +github.com/sagikazarmark/locafero v0.12.0 h1:/NQhBAkUb4+fH1jivKHWusDYFjMOOKU88eegjfxfHb4= +github.com/sagikazarmark/locafero v0.12.0/go.mod h1:sZh36u/YSZ918v0Io+U9ogLYQJ9tLLBmM4eneO6WwsI= github.com/sanity-io/litter v1.5.8 h1:uM/2lKrWdGbRXDrIq08Lh9XtVYoeGtcQxk9rtQ7+rYg= github.com/sanity-io/litter v1.5.8/go.mod h1:9gzJgR2i4ZpjZHsKvUXIRQVk7P+yM3e+jAF7bU2UI5U= -github.com/segmentio/asm v1.2.0 h1:9BQrFxC+YOHJlTlHGkTrFWf59nbL3XnCoFLTwDCI7ys= -github.com/segmentio/asm v1.2.0/go.mod h1:BqMnlJP91P8d+4ibuonYZw9mfnzI9HfxselHZr5aAcs= +github.com/santhosh-tekuri/jsonschema/v6 v6.0.2 h1:KRzFb2m7YtdldCEkzs6KqmJw4nqEVZGK7IN2kJkjTuQ= +github.com/santhosh-tekuri/jsonschema/v6 v6.0.2/go.mod h1:JXeL+ps8p7/KNMjDQk3TCwPpBy0wYklyWTfbkIzdIFU= +github.com/segmentio/asm v1.2.1 h1:DTNbBqs57ioxAD4PrArqftgypG4/qNpXoJx8TVXxPR0= +github.com/segmentio/asm v1.2.1/go.mod h1:BqMnlJP91P8d+4ibuonYZw9mfnzI9HfxselHZr5aAcs= github.com/sethvargo/go-retry v0.3.0 h1:EEt31A35QhrcRZtrYFDTBg91cqZVnFL2navjDrah2SE= github.com/sethvargo/go-retry v0.3.0/go.mod h1:mNX17F0C/HguQMyMyJxcnU471gOZGxCLyYaFyAZraas= github.com/sirupsen/logrus v1.4.2/go.mod h1:tLMulIdttU9McNUspp0xgXVQah82FyeX6MwdIuYE2rE= -github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ= -github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ= +github.com/sirupsen/logrus v1.9.4 h1:TsZE7l11zFCLZnZ+teH4Umoq5BhEIfIzfRDZ1Uzql2w= +github.com/sirupsen/logrus v1.9.4/go.mod h1:ftWc9WdOfJ0a92nsE2jF5u5ZwH8Bv2zdeOC42RjbV2g= github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d h1:zE9ykElWQ6/NYmHa3jpm/yHnI4xSofP+UP6SpjHcSeM= github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d/go.mod h1:OnSkiWE9lh6wB0YB77sQom3nweQdgAjqCqsofrRNTgc= github.com/smartystreets/goconvey v1.6.4 h1:fv0U8FUIMPNf1L9lnHLvLhgicrIVChEkdzIKYqbNC9s= github.com/smartystreets/goconvey v1.6.4/go.mod h1:syvi0/a8iFYH4r/RixwvyeAJjdLS9QV7WQ/tjFTllLA= github.com/sosodev/duration v1.3.1 h1:qtHBDMQ6lvMQsL15g4aopM4HEfOaYuhWBw3NPTtlqq4= github.com/sosodev/duration v1.3.1/go.mod h1:RQIBBX0+fMLc/D9+Jb/fwvVmo0eZvDDEERAikUR6SDg= -github.com/sourcegraph/conc v0.3.0 h1:OQTbbt6P72L20UqAkXXuLOj79LfEanQ+YQFNpLA9ySo= -github.com/sourcegraph/conc v0.3.0/go.mod h1:Sdozi7LEKbFPqYX2/J+iBAM6HpqSLTASQIKqDmF7Mt0= -github.com/spf13/afero v1.14.0 h1:9tH6MapGnn/j0eb0yIXiLjERO8RB6xIVZRDCX7PtqWA= -github.com/spf13/afero v1.14.0/go.mod h1:acJQ8t0ohCGuMN3O+Pv0V0hgMxNYDlvdk+VTfyZmbYo= -github.com/spf13/cast v1.9.2 h1:SsGfm7M8QOFtEzumm7UZrZdLLquNdzFYfIbEXntcFbE= -github.com/spf13/cast v1.9.2/go.mod h1:jNfB8QC9IA6ZuY2ZjDp0KtFO2LZZlg4S/7bzP6qqeHo= -github.com/spf13/cobra v1.9.1 h1:CXSaggrXdbHK9CF+8ywj8Amf7PBRmPCOJugH954Nnlo= -github.com/spf13/cobra v1.9.1/go.mod h1:nDyEzZ8ogv936Cinf6g1RU9MRY64Ir93oCnqb9wxYW0= -github.com/spf13/pflag v1.0.6/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= -github.com/spf13/pflag v1.0.7 h1:vN6T9TfwStFPFM5XzjsvmzZkLuaLX+HS+0SeFLRgU6M= -github.com/spf13/pflag v1.0.7/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= -github.com/spf13/viper v1.20.1 h1:ZMi+z/lvLyPSCoNtFCpqjy0S4kPbirhpTMwl8BkW9X4= -github.com/spf13/viper v1.20.1/go.mod h1:P9Mdzt1zoHIG8m2eZQinpiBjo6kCmZSKBClNNqjJvu4= +github.com/spf13/afero v1.15.0 h1:b/YBCLWAJdFWJTN9cLhiXXcD7mzKn9Dm86dNnfyQw1I= +github.com/spf13/afero v1.15.0/go.mod h1:NC2ByUVxtQs4b3sIUphxK0NioZnmxgyCrfzeuq8lxMg= +github.com/spf13/cast v1.10.0 h1:h2x0u2shc1QuLHfxi+cTJvs30+ZAHOGRic8uyGTDWxY= +github.com/spf13/cast v1.10.0/go.mod h1:jNfB8QC9IA6ZuY2ZjDp0KtFO2LZZlg4S/7bzP6qqeHo= +github.com/spf13/cobra v1.10.2 h1:DMTTonx5m65Ic0GOoRY2c16WCbHxOOw6xxezuLaBpcU= +github.com/spf13/cobra v1.10.2/go.mod h1:7C1pvHqHw5A4vrJfjNwvOdzYu0Gml16OCs2GRiTUUS4= +github.com/spf13/pflag v1.0.9/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= +github.com/spf13/pflag v1.0.10 h1:4EBh2KAYBwaONj6b2Ye1GiHfwjqyROoF4RwYO+vPwFk= +github.com/spf13/pflag v1.0.10/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= +github.com/spf13/viper v1.21.0 h1:x5S+0EU27Lbphp4UKm1C+1oQO+rKx36vfCoaVebLFSU= +github.com/spf13/viper v1.21.0/go.mod h1:P0lhsswPGWD/1lZJ9ny3fYnVqxiegrlNrEmgLjbTCAY= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= -github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw= +github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo= github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/objx v0.5.3 h1:jmXUvGomnU1o3W/V5h2VEradbpJDwGrzugQQvL0POH4= +github.com/stretchr/objx v0.5.3/go.mod h1:rDQraq+vQZU7Fde9LOZLr8Tax6zZvy4kuNKF+QYS+U0= github.com/stretchr/testify v0.0.0-20161117074351-18a02ba4a312/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= -github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= -github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA= -github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= +github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= +github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= github.com/subosito/gotenv v1.6.0 h1:9NlTDc1FTs4qu0DDq7AEtTPNw6SVm7uBMsUCUjABIf8= github.com/subosito/gotenv v1.6.0/go.mod h1:Dk4QP5c2W3ibzajGcXpNraDfq2IrhjMIvMSWPKKo0FU= -github.com/tetratelabs/wazero v1.9.0 h1:IcZ56OuxrtaEz8UYNRHBrUa9bYeX9oVY93KspZZBf/I= -github.com/tetratelabs/wazero v1.9.0/go.mod h1:TSbcXCfFP0L2FGkRPxHphadXPjo1T6W+CseNNY7EkjM= +github.com/tetratelabs/wabin v0.0.0-20230304001439-f6f874872834 h1:ZF+QBjOI+tILZjBaFj3HgFonKXUcwgJ4djLb6i42S3Q= +github.com/tetratelabs/wabin v0.0.0-20230304001439-f6f874872834/go.mod h1:m9ymHTgNSEjuxvw8E7WWe4Pl4hZQHXONY8wE6dMLaRk= +github.com/tetratelabs/wazero v1.11.0 h1:+gKemEuKCTevU4d7ZTzlsvgd1uaToIDtlQlmNbwqYhA= +github.com/tetratelabs/wazero v1.11.0/go.mod h1:eV28rsN8Q+xwjogd7f4/Pp4xFxO7uOGbLcD/LzB1wiU= +github.com/tidwall/gjson v1.18.0 h1:FIDeeyB800efLX89e5a8Y0BNH+LOngJyGrIWxG2FKQY= +github.com/tidwall/gjson v1.18.0/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk= +github.com/tidwall/match v1.1.1 h1:+Ho715JplO36QYgwN9PGYNhgZvoUSc9X2c80KVTi+GA= +github.com/tidwall/match v1.1.1/go.mod h1:eRSPERbgtNPcGhD8UCthc6PmLEQXEWd3PRB5JTxsfmM= +github.com/tidwall/pretty v1.2.1 h1:qjsOFOWWQl+N3RsoF5/ssm1pHmJJwhjlSbZ51I6wMl4= +github.com/tidwall/pretty v1.2.1/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU= +github.com/tidwall/sjson v1.2.5 h1:kLy8mja+1c9jlljvWTlSazM7cKDRfJuR/bOJhcY5NcY= +github.com/tidwall/sjson v1.2.5/go.mod h1:Fvgq9kS/6ociJEDnK0Fk1cpYF4FIW6ZF7LAe+6jwd28= github.com/unrolled/secure v1.17.0 h1:Io7ifFgo99Bnh0J7+Q+qcMzWM6kaDPCA5FroFZEdbWU= github.com/unrolled/secure v1.17.0/go.mod h1:BmF5hyM6tXczk3MpQkFf1hpKSRqCyhqcbiQtiAF7+40= +github.com/valyala/fastjson v1.6.10 h1:/yjJg8jaVQdYR3arGxPE2X5z89xrlhS0eGXdv+ADTh4= +github.com/valyala/fastjson v1.6.10/go.mod h1:e6FubmQouUNP73jtMLmcbxS6ydWIpOfhz34TSfO3JaE= github.com/xrash/smetrics v0.0.0-20250705151800-55b8f293f342 h1:FnBeRrxr7OU4VvAzt5X7s6266i6cSVkkFPS0TuXWbIg= github.com/xrash/smetrics v0.0.0-20250705151800-55b8f293f342/go.mod h1:Ohn+xnUBiLI6FVj/9LpzZWtj1/D6lUovWYBkxHVV3aM= github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= github.com/zeebo/assert v1.3.0 h1:g7C04CbJuIDKNPFHmsk4hwZDO5O+kntRxzaUoNXj+IQ= github.com/zeebo/assert v1.3.0/go.mod h1:Pq9JiuJQpG8JLJdtkwrJESF0Foym2/D9XMU5ciN/wJ0= -github.com/zeebo/xxh3 v1.0.2 h1:xZmwmqxHZA8AI603jOQ0tMqmBr9lPeFwGg6d+xy9DC0= -github.com/zeebo/xxh3 v1.0.2/go.mod h1:5NWz9Sef7zIDm2JHfFlcQvNekmcEl9ekUZQQKCYaDcA= -go.uber.org/automaxprocs v1.6.0 h1:O3y2/QNTOdbF+e/dpXNNW7Rx2hZ4sTIPyybbxyNqTUs= -go.uber.org/automaxprocs v1.6.0/go.mod h1:ifeIMSnPZuznNm6jmdzmU3/bfk01Fe2fotchwEFJ8r8= +github.com/zeebo/xxh3 v1.1.0 h1:s7DLGDK45Dyfg7++yxI0khrfwq9661w9EN78eP/UZVs= +github.com/zeebo/xxh3 v1.1.0/go.mod h1:IisAie1LELR4xhVinxWS5+zf1lA4p0MW4T+w+W07F5s= +go.opentelemetry.io/proto/otlp v1.10.0 h1:IQRWgT5srOCYfiWnpqUYz9CVmbO8bFmKcwYxpuCSL2g= +go.opentelemetry.io/proto/otlp v1.10.0/go.mod h1:/CV4QoCR/S9yaPj8utp3lvQPoqMtxXdzn7ozvvozVqk= go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto= go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE= go.uber.org/multierr v1.11.0 h1:blXXJkSxSSfBVBlC76pxqeO+LN3aDfLQo+309xJstO0= go.uber.org/multierr v1.11.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y= +go.yaml.in/yaml/v2 v2.4.3 h1:6gvOSjQoTB3vt1l+CU+tSyi/HOjfOjRLJ4YwYZGwRO0= +go.yaml.in/yaml/v2 v2.4.3/go.mod h1:zSxWcmIDjOzPXpjlTTbAsKokqkDNAVtZO0WOMiT90s8= +go.yaml.in/yaml/v3 v3.0.4 h1:tfq32ie2Jv2UxXFdLJdh3jXuOzWiL1fo0bu/FbuKpbc= +go.yaml.in/yaml/v3 v3.0.4/go.mod h1:DhzuOOF2ATzADvBadXxruRBLzYTpT36CKvDb3+aBEFg= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= golang.org/x/crypto v0.13.0/go.mod h1:y6Z2r+Rw4iayiXXAIxJIDAJ1zMW4yaTpebo8fPOliYc= -golang.org/x/crypto v0.18.0/go.mod h1:R0j02AL6hcrfOiy9T4ZYp/rcWeMxM3L6QYxlOuEG1mg= golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDfU= golang.org/x/crypto v0.23.0/go.mod h1:CKFgDieR+mRhux2Lsu27y0fO304Db0wZe70UKqHu0v8= golang.org/x/crypto v0.31.0/go.mod h1:kDsLvtWBEx7MV9tJOj9bnXsPbxwJQ6csT/x4KIN4Ssk= -golang.org/x/crypto v0.40.0 h1:r4x+VvoG5Fm+eJcxMaY8CQM7Lb0l1lsmjGBQ6s8BfKM= -golang.org/x/crypto v0.40.0/go.mod h1:Qr1vMER5WyS2dfPHAlsOj01wgLbsyWtFn/aY+5+ZdxY= -golang.org/x/exp v0.0.0-20250718183923-645b1fa84792 h1:R9PFI6EUdfVKgwKjZef7QIwGcBKu86OEFpJ9nUEP2l4= -golang.org/x/exp v0.0.0-20250718183923-645b1fa84792/go.mod h1:A+z0yzpGtvnG90cToK5n2tu8UJVP2XUATh+r+sfOOOc= -golang.org/x/image v0.0.0-20191009234506-e7c1f5e7dbb8/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0= -golang.org/x/image v0.29.0 h1:HcdsyR4Gsuys/Axh0rDEmlBmB68rW1U9BUdB3UVHsas= -golang.org/x/image v0.29.0/go.mod h1:RVJROnf3SLK8d26OW91j4FrIHGbsJ8QnbEocVTOWQDA= +golang.org/x/crypto v0.49.0 h1:+Ng2ULVvLHnJ/ZFEq4KdcDd/cfjrrjjNSXNzxg0Y4U4= +golang.org/x/crypto v0.49.0/go.mod h1:ErX4dUh2UM+CFYiXZRTcMpEcN8b/1gxEuv3nODoYtCA= +golang.org/x/exp v0.0.0-20260218203240-3dfff04db8fa h1:Zt3DZoOFFYkKhDT3v7Lm9FDMEV06GpzjG2jrqW+QTE0= +golang.org/x/exp v0.0.0-20260218203240-3dfff04db8fa/go.mod h1:K79w1Vqn7PoiZn+TkNpx3BUWUQksGO3JcVX6qIjytmA= +golang.org/x/image v0.37.0 h1:ZiRjArKI8GwxZOoEtUfhrBtaCN+4b/7709dlT6SSnQA= +golang.org/x/image v0.37.0/go.mod h1:/3f6vaXC+6CEanU4KJxbcUZyEePbyKbaLoDOe4ehFYY= golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= golang.org/x/mod v0.12.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= -golang.org/x/mod v0.14.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= golang.org/x/mod v0.15.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= golang.org/x/mod v0.17.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= -golang.org/x/mod v0.26.0 h1:EGMPT//Ezu+ylkCijjPc+f4Aih7sZvaAr+O3EHBxvZg= -golang.org/x/mod v0.26.0/go.mod h1:/j6NAhSk8iQ723BGAUyoAcn7SlD7s15Dp9Nd/SfeaFQ= +golang.org/x/mod v0.34.0 h1:xIHgNUUnW6sYkcM5Jleh05DvLOtwc6RitGHbDk4akRI= +golang.org/x/mod v0.34.0/go.mod h1:ykgH52iCZe79kzLLMhyCUzhMci+nQj+0XkbXpNYtVjY= golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190603091049-60506f45cf65/go.mod h1:HSz+uSET+XFnRR8LxR5pz3Of3rY3CfYBVs4xY44aLks= golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= @@ -303,12 +340,11 @@ golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs= golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg= golang.org/x/net v0.15.0/go.mod h1:idbUs1IY1+zTqbi8yxTbhexhEEk5ur9LInksu6HrEpk= -golang.org/x/net v0.20.0/go.mod h1:z8BVo6PvndSri0LbOE3hAn0apkU+1YvI6E70E9jsnvY= golang.org/x/net v0.21.0/go.mod h1:bIjVDfnllIU7BJ2DNgfnXvpSvtn8VRwhlsaeUTyUS44= golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM= golang.org/x/net v0.33.0/go.mod h1:HXLR5J+9DxmrqMwG9qjGCxZ+zKXxBru04zlTvWlWuN4= -golang.org/x/net v0.42.0 h1:jzkYrhi3YQWD6MLBJcsklgQsoAcw89EcZbJw8Z614hs= -golang.org/x/net v0.42.0/go.mod h1:FF1RA5d3u7nAYA4z2TkclSCKh68eSXtiFwcWQpPXdt8= +golang.org/x/net v0.52.0 h1:He/TN1l0e4mmR3QqHMT2Xab3Aj3L9qjbhRm78/6jrW0= +golang.org/x/net v0.52.0/go.mod h1:R1MAz7uMZxVMualyPXb+VaqGSa3LIaUqk0eEt3w36Sw= golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= @@ -316,8 +352,8 @@ golang.org/x/sync v0.3.0/go.mod h1:FU7BRWz2tNW+3quACPkgCx/L+uEAv1htQ0V83Z9Rj+Y= golang.org/x/sync v0.6.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= golang.org/x/sync v0.7.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= golang.org/x/sync v0.10.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= -golang.org/x/sync v0.16.0 h1:ycBJEhp9p4vXvUZNszeOq0kGTPghopOL8q0fq3vstxw= -golang.org/x/sync v0.16.0/go.mod h1:1dzgHSNfp02xaA81J2MS99Qcpr2w7fw1gpm99rleRqA= +golang.org/x/sync v0.20.0 h1:e0PTpb7pjO8GAtTs2dQ6jYa5BWYlMuX047Dco/pItO4= +golang.org/x/sync v0.20.0/go.mod h1:9xrNwdLfx4jkKbNva9FpL6vEN7evnE43NNNJQ2LF3+0= golang.org/x/sys v0.0.0-20180909124046-d0be0721c37e/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20180926160741-c2ed4eda69e7/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= @@ -326,27 +362,28 @@ golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7w golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220615213510-4f61da869c0c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.16.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= golang.org/x/sys v0.28.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= -golang.org/x/sys v0.34.0 h1:H5Y5sJ2L2JRdyv7ROF1he/lPdvFsd0mJHFw2ThKHxLA= -golang.org/x/sys v0.34.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k= +golang.org/x/sys v0.42.0 h1:omrd2nAlyT5ESRdCLYdm3+fMfNFE/+Rf4bDIQImRJeo= +golang.org/x/sys v0.42.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw= golang.org/x/telemetry v0.0.0-20240228155512-f48c80bd79b2/go.mod h1:TeRTkGYfJXctD9OcfyVLyj2J3IxLnKwHJR8f4D8a3YE= +golang.org/x/telemetry v0.0.0-20260311193753-579e4da9a98c h1:6a8FdnNk6bTXBjR4AGKFgUKuo+7GnR3FX5L7CbveeZc= +golang.org/x/telemetry v0.0.0-20260311193753-579e4da9a98c/go.mod h1:TpUTTEp9frx7rTdLpC9gFG9kdI7zVLFTFFlqaH2Cncw= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k= golang.org/x/term v0.8.0/go.mod h1:xPskH00ivmX89bAKVGSKKtLOWNx2+17Eiy94tnKShWo= golang.org/x/term v0.12.0/go.mod h1:owVbMEjm3cBLCHdkQu9b1opXd4ETQWc3BhuQGKgXgvU= -golang.org/x/term v0.16.0/go.mod h1:yn7UURbUtPyrVJPGPq404EukNFxcm/foM+bV/bfcDsY= golang.org/x/term v0.17.0/go.mod h1:lLRBjIVuehSbZlaOtGMbcMncT+aqLLLmKrsjNrUguwk= golang.org/x/term v0.20.0/go.mod h1:8UkIAJTvZgivsXaD6/pH6U9ecQzZ45awqEOzuCvwpFY= golang.org/x/term v0.27.0/go.mod h1:iMsnZpn0cago0GOrHO2+Y7u7JPn5AylBrcoWkElMTSM= +golang.org/x/term v0.41.0 h1:QCgPso/Q3RTJx2Th4bDLqML4W6iJiaXFq2/ftQF13YU= +golang.org/x/term v0.41.0/go.mod h1:3pfBgksrReYfZ5lvYM0kSO0LIkAl4Yl2bXOkKP7Ec2A= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= @@ -357,40 +394,39 @@ golang.org/x/text v0.13.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE= golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= golang.org/x/text v0.15.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ= -golang.org/x/text v0.27.0 h1:4fGWRpyh641NLlecmyl4LOe6yDdfaYNrGb2zdfo4JV4= -golang.org/x/text v0.27.0/go.mod h1:1D28KMCvyooCX9hBiosv5Tz/+YLxj0j7XhWjpSUF7CU= -golang.org/x/time v0.12.0 h1:ScB/8o8olJvc+CQPWrK3fPZNfh7qgwCrY0zJmoEQLSE= -golang.org/x/time v0.12.0/go.mod h1:CDIdPxbZBQxdj6cxyCIdrNogrJKMJ7pr37NYpMcMDSg= +golang.org/x/text v0.35.0 h1:JOVx6vVDFokkpaq1AEptVzLTpDe9KGpj5tR4/X+ybL8= +golang.org/x/text v0.35.0/go.mod h1:khi/HExzZJ2pGnjenulevKNX1W67CUy0AsXcNubPGCA= +golang.org/x/time v0.15.0 h1:bbrp8t3bGUeFOx08pvsMYRTCVSMk89u4tKbNOZbp88U= +golang.org/x/time v0.15.0/go.mod h1:Y4YMaQmXwGQZoFaVFk4YpCt4FLQMYKZe9oeV/f4MSno= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20190328211700-ab21143f2384/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU= golang.org/x/tools v0.13.0/go.mod h1:HvlwmtVNQAhOuCjW7xxvovg8wbNq7LwfXh/k7wXUl58= -golang.org/x/tools v0.17.0/go.mod h1:xsh6VxdV005rRVaS6SSAf9oiAqljS7UZUacMZ8Bnsps= golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d/go.mod h1:aiJjzUbINMkxbQROHiO6hDPo2LHcIPhhQsa9DLh0yGk= -golang.org/x/tools v0.35.0 h1:mBffYraMEf7aa0sB+NuKnuCy8qI/9Bughn8dC2Gu5r0= -golang.org/x/tools v0.35.0/go.mod h1:NKdj5HkL/73byiZSJjqJgKn3ep7KjFkBOkR/Hps3VPw= +golang.org/x/tools v0.43.0 h1:12BdW9CeB3Z+J/I/wj34VMl8X+fEXBxVR90JeMX5E7s= +golang.org/x/tools v0.43.0/go.mod h1:uHkMso649BX2cZK6+RpuIPXS3ho2hZo4FVwfoy1vIk0= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= google.golang.org/appengine v1.6.5/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc= -google.golang.org/protobuf v1.36.6 h1:z1NpPI8ku2WgiWnf+t9wTPsn6eP1L7ksHUlkfLvd9xY= -google.golang.org/protobuf v1.36.6/go.mod h1:jduwjTPXsFjZGTmRluh+L6NjiWu7pchiJ2/5YcXBHnY= +google.golang.org/protobuf v1.36.11 h1:fV6ZwhNocDyBLK0dj+fg8ektcVegBBuEolpbTQyBNVE= +google.golang.org/protobuf v1.36.11/go.mod h1:HTf+CrKn2C3g5S8VImy6tdcUvCska2kB7j23XfzDpco= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= -gopkg.in/ini.v1 v1.67.0 h1:Dgnx+6+nfE+IfzjUEISNeydPJh9AXNNsWbGP9KzCsOA= -gopkg.in/ini.v1 v1.67.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k= +gopkg.in/ini.v1 v1.67.1 h1:tVBILHy0R6e4wkYOn3XmiITt/hEVH4TFMYvAX2Ytz6k= +gopkg.in/ini.v1 v1.67.1/go.mod h1:x/cyOwCgZqOkJoDIJ3c1KNHMo10+nLGAhh+kn3Zizss= gopkg.in/natefinch/npipe.v2 v2.0.0-20160621034901-c1b8fa8bdcce h1:+JknDZhAj8YMt7GC73Ei8pv4MzjDUNPHgQWJdtMAaDU= gopkg.in/natefinch/npipe.v2 v2.0.0-20160621034901-c1b8fa8bdcce/go.mod h1:5AcXVHNjg+BDxry382+8OKon8SEWiKktQR07RKPsv1c= gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= -modernc.org/libc v1.65.0 h1:e183gLDnAp9VJh6gWKdTy0CThL9Pt7MfcR/0bgb7Y1Y= -modernc.org/libc v1.65.0/go.mod h1:7m9VzGq7APssBTydds2zBcxGREwvIGpuUBaKTXdm2Qs= +modernc.org/libc v1.68.0 h1:PJ5ikFOV5pwpW+VqCK1hKJuEWsonkIJhhIXyuF/91pQ= +modernc.org/libc v1.68.0/go.mod h1:NnKCYeoYgsEqnY3PgvNgAeaJnso968ygU8Z0DxjoEc0= modernc.org/mathutil v1.7.1 h1:GCZVGXdaN8gTqB1Mf/usp1Y/hSqgI2vAGGP4jZMCxOU= modernc.org/mathutil v1.7.1/go.mod h1:4p5IwJITfppl0G4sUEDtCr4DthTaT47/N3aT6MhfgJg= -modernc.org/memory v1.10.0 h1:fzumd51yQ1DxcOxSO+S6X7+QTuVU+n8/Aj7swYjFfC4= -modernc.org/memory v1.10.0/go.mod h1:/JP4VbVC+K5sU2wZi9bHoq2MAkCnrt2r98UGeSK7Mjw= -modernc.org/sqlite v1.37.0 h1:s1TMe7T3Q3ovQiK2Ouz4Jwh7dw4ZDqbebSDTlSJdfjI= -modernc.org/sqlite v1.37.0/go.mod h1:5YiWv+YviqGMuGw4V+PNplcyaJ5v+vQd7TQOgkACoJM= +modernc.org/memory v1.11.0 h1:o4QC8aMQzmcwCK3t3Ux/ZHmwFPzE6hf2Y5LbkRs+hbI= +modernc.org/memory v1.11.0/go.mod h1:/JP4VbVC+K5sU2wZi9bHoq2MAkCnrt2r98UGeSK7Mjw= +modernc.org/sqlite v1.46.1 h1:eFJ2ShBLIEnUWlLy12raN0Z1plqmFX9Qe3rjQTKt6sU= +modernc.org/sqlite v1.46.1/go.mod h1:CzbrU2lSB1DKUusvwGz7rqEKIq+NUd8GWuBBZDs9/nA= diff --git a/log/journal.go b/log/journal.go new file mode 100644 index 000000000..f1c17d2e7 --- /dev/null +++ b/log/journal.go @@ -0,0 +1,41 @@ +package log + +import ( + "fmt" + + "github.com/sirupsen/logrus" +) + +// journalFormatter wraps a logrus.Formatter and prepends a syslog priority +// prefix () to each log line. When stderr is captured by systemd-journald, +// this prefix tells journald the correct severity for each message. +// +// See https://www.freedesktop.org/software/systemd/man/sd-daemon.html +type journalFormatter struct { + inner logrus.Formatter +} + +// levelToPriority maps logrus levels to syslog priority values. +// The mapping follows RFC 5424 severity levels. +var levelToPriority = map[logrus.Level]int{ + logrus.PanicLevel: 0, // emerg + logrus.FatalLevel: 2, // crit + logrus.ErrorLevel: 3, // err + logrus.WarnLevel: 4, // warning + logrus.InfoLevel: 6, // info + logrus.DebugLevel: 7, // debug + logrus.TraceLevel: 7, // debug +} + +func (f *journalFormatter) Format(entry *logrus.Entry) ([]byte, error) { + formatted, err := f.inner.Format(entry) + if err != nil { + return formatted, err + } + priority, ok := levelToPriority[entry.Level] + if !ok { + priority = 6 // default to info for unknown levels + } + prefix := []byte(fmt.Sprintf("<%d>", priority)) + return append(prefix, formatted...), nil +} diff --git a/log/journal_test.go b/log/journal_test.go new file mode 100644 index 000000000..770f12b6d --- /dev/null +++ b/log/journal_test.go @@ -0,0 +1,41 @@ +package log + +import ( + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + "github.com/sirupsen/logrus" +) + +var _ = Describe("journalFormatter", func() { + var formatter *journalFormatter + + BeforeEach(func() { + inner := &logrus.TextFormatter{ + DisableTimestamp: true, + DisableColors: true, + } + formatter = &journalFormatter{inner: inner} + }) + + DescribeTable("prefixes log lines with syslog priority", + func(level logrus.Level, expectedPrefix string) { + entry := &logrus.Entry{ + Logger: logrus.New(), + Level: level, + Message: "test message", + Data: logrus.Fields{}, + } + out, err := formatter.Format(entry) + Expect(err).ToNot(HaveOccurred()) + Expect(string(out)).To(HavePrefix(expectedPrefix)) + }, + Entry("error", logrus.ErrorLevel, "<3>"), + Entry("warning", logrus.WarnLevel, "<4>"), + Entry("info", logrus.InfoLevel, "<6>"), + Entry("debug", logrus.DebugLevel, "<7>"), + Entry("trace", logrus.TraceLevel, "<7>"), + Entry("fatal", logrus.FatalLevel, "<2>"), + Entry("panic", logrus.PanicLevel, "<0>"), + Entry("unknown level defaults to info", logrus.Level(99), "<6>"), + ) +}) diff --git a/log/log.go b/log/log.go index 20119ab46..2764d80e5 100644 --- a/log/log.go +++ b/log/log.go @@ -11,6 +11,7 @@ import ( "runtime" "sort" "strings" + "sync" "time" "github.com/sirupsen/logrus" @@ -18,7 +19,7 @@ import ( type Level uint32 -type LevelFunc = func(ctx interface{}, msg interface{}, keyValuePairs ...interface{}) +type LevelFunc = func(ctx any, msg any, keyValuePairs ...any) var redacted = &Hook{ AcceptedLevels: logrus.AllLevels, @@ -26,10 +27,9 @@ var redacted = &Hook{ // Keys from the config "(ApiKey:\")[\\w]*", "(Secret:\")[\\w]*", - "(Spotify.*ID:\")[\\w]*", "(PasswordEncryptionKey:[\\s]*\")[^\"]*", - "(ReverseProxyUserHeader:[\\s]*\")[^\"]*", - "(ReverseProxyWhitelist:[\\s]*\")[^\"]*", + "(UserHeader:[\\s]*\")[^\"]*", + "(TrustedSources:[\\s]*\")[^\"]*", "(MetricsPath:[\\s]*\")[^\"]*", "(DevAutoCreateAdminPassword:[\\s]*\")[^\"]*", "(DevAutoLoginUsername:[\\s]*\")[^\"]*", @@ -70,6 +70,7 @@ type levelPath struct { var ( currentLevel Level + loggerMu sync.RWMutex defaultLogger = logrus.New() logSourceLine = false rootPath string @@ -78,17 +79,19 @@ var ( // SetLevel sets the global log level used by the simple logger. func SetLevel(l Level) { + loggerMu.Lock() currentLevel = l defaultLogger.Level = logrus.TraceLevel + loggerMu.Unlock() logrus.SetLevel(logrus.Level(l)) } func SetLevelString(l string) { - level := levelFromString(l) + level := ParseLogLevel(l) SetLevel(level) } -func levelFromString(l string) Level { +func ParseLogLevel(l string) Level { envLevel := strings.ToLower(l) var level Level switch envLevel { @@ -110,9 +113,11 @@ func levelFromString(l string) Level { // SetLogLevels sets the log levels for specific paths in the codebase. func SetLogLevels(levels map[string]string) { + loggerMu.Lock() + defer loggerMu.Unlock() logLevels = nil for k, v := range levels { - logLevels = append(logLevels, levelPath{path: k, level: levelFromString(v)}) + logLevels = append(logLevels, levelPath{path: k, level: ParseLogLevel(v)}) } sort.Slice(logLevels, func(i, j int) bool { return logLevels[i].path > logLevels[j].path @@ -125,6 +130,8 @@ func SetLogSourceLine(enabled bool) { func SetRedacting(enabled bool) { if enabled { + loggerMu.Lock() + defer loggerMu.Unlock() defaultLogger.AddHook(redacted) } } @@ -133,16 +140,27 @@ func SetOutput(w io.Writer) { if runtime.GOOS == "windows" { w = CRLFWriter(w) } + loggerMu.Lock() + defer loggerMu.Unlock() defaultLogger.SetOutput(w) } +// EnableJournalFormat wraps the current logger formatter with syslog +// priority prefixes for systemd-journald. Only call this when output +// goes to stderr and JOURNAL_STREAM is set. +func EnableJournalFormat() { + loggerMu.Lock() + defer loggerMu.Unlock() + defaultLogger.Formatter = &journalFormatter{inner: defaultLogger.Formatter} +} + // Redact applies redaction to a single string func Redact(msg string) string { r, _ := redacted.redact(msg) return r } -func NewContext(ctx context.Context, keyValuePairs ...interface{}) context.Context { +func NewContext(ctx context.Context, keyValuePairs ...any) context.Context { if ctx == nil { ctx = context.Background() } @@ -158,10 +176,14 @@ func NewContext(ctx context.Context, keyValuePairs ...interface{}) context.Conte } func SetDefaultLogger(l *logrus.Logger) { + loggerMu.Lock() + defer loggerMu.Unlock() defaultLogger = l } func CurrentLevel() Level { + loggerMu.RLock() + defer loggerMu.RUnlock() return currentLevel } @@ -170,32 +192,32 @@ func IsGreaterOrEqualTo(level Level) bool { return shouldLog(level, 2) } -func Fatal(args ...interface{}) { - log(LevelFatal, args...) +func Fatal(args ...any) { + Log(LevelFatal, args...) os.Exit(1) } -func Error(args ...interface{}) { - log(LevelError, args...) +func Error(args ...any) { + Log(LevelError, args...) } -func Warn(args ...interface{}) { - log(LevelWarn, args...) +func Warn(args ...any) { + Log(LevelWarn, args...) } -func Info(args ...interface{}) { - log(LevelInfo, args...) +func Info(args ...any) { + Log(LevelInfo, args...) } -func Debug(args ...interface{}) { - log(LevelDebug, args...) +func Debug(args ...any) { + Log(LevelDebug, args...) } -func Trace(args ...interface{}) { - log(LevelTrace, args...) +func Trace(args ...any) { + Log(LevelTrace, args...) } -func log(level Level, args ...interface{}) { +func Log(level Level, args ...any) { if !shouldLog(level, 3) { return } @@ -204,14 +226,21 @@ func log(level Level, args ...interface{}) { } func Writer() io.Writer { + loggerMu.RLock() + defer loggerMu.RUnlock() return defaultLogger.Writer() } func shouldLog(requiredLevel Level, skip int) bool { - if currentLevel >= requiredLevel { + loggerMu.RLock() + level := currentLevel + levels := logLevels + loggerMu.RUnlock() + + if level >= requiredLevel { return true } - if len(logLevels) == 0 { + if len(levels) == 0 { return false } @@ -221,7 +250,7 @@ func shouldLog(requiredLevel Level, skip int) bool { } file = strings.TrimPrefix(file, rootPath) - for _, lp := range logLevels { + for _, lp := range levels { if strings.HasPrefix(file, lp.path) { return lp.level >= requiredLevel } @@ -229,7 +258,7 @@ func shouldLog(requiredLevel Level, skip int) bool { return false } -func parseArgs(args []interface{}) (*logrus.Entry, string) { +func parseArgs(args []any) (*logrus.Entry, string) { var l *logrus.Entry var err error if args[0] == nil { @@ -268,7 +297,7 @@ func parseArgs(args []interface{}) (*logrus.Entry, string) { return l, "" } -func addFields(logger *logrus.Entry, keyValuePairs []interface{}) *logrus.Entry { +func addFields(logger *logrus.Entry, keyValuePairs []any) *logrus.Entry { for i := 0; i < len(keyValuePairs); i += 2 { switch name := keyValuePairs[i].(type) { case error: @@ -295,7 +324,7 @@ func addFields(logger *logrus.Entry, keyValuePairs []interface{}) *logrus.Entry return logger } -func extractLogger(ctx interface{}) (*logrus.Entry, error) { +func extractLogger(ctx any) (*logrus.Entry, error) { switch ctx := ctx.(type) { case *logrus.Entry: return ctx, nil @@ -314,6 +343,8 @@ func extractLogger(ctx interface{}) (*logrus.Entry, error) { func createNewLogger() *logrus.Entry { //logrus.SetFormatter(&logrus.TextFormatter{ForceColors: true, DisableTimestamp: false, FullTimestamp: true}) //l.Formatter = &logrus.TextFormatter{ForceColors: true, DisableTimestamp: false, FullTimestamp: true} + loggerMu.RLock() + defer loggerMu.RUnlock() logger := logrus.NewEntry(defaultLogger) return logger } diff --git a/main.go b/main.go index 65db162ac..b5fb508b4 100644 --- a/main.go +++ b/main.go @@ -9,11 +9,12 @@ import ( //goland:noinspection GoBoolExpressions func main() { - // This import is used to force the inclusion of the `netgo` tag when compiling the project. + // These references force the inclusion of build tags when compiling the project. // If you get compilation errors like "undefined: buildtags.NETGO", this means you forgot to specify - // the `netgo` build tag when compiling the project. + // the required build tags when compiling the project. // To avoid these kind of errors, you should use `make build` to compile the project. _ = buildtags.NETGO + _ = buildtags.SQLITE_FTS5 cmd.Execute() } diff --git a/model/album.go b/model/album.go index a8dcfe682..667f4695b 100644 --- a/model/album.go +++ b/model/album.go @@ -1,11 +1,14 @@ package model import ( + "fmt" "iter" "math" "sync" "time" + "github.com/navidrome/navidrome/conf" + "github.com/gohugoio/hashstructure" ) @@ -70,6 +73,13 @@ func (a Album) CoverArtID() ArtworkID { return artworkIDFromAlbum(a) } +func (a Album) FullName() string { + if conf.Server.Subsonic.AppendAlbumVersion && len(a.Tags[TagAlbumVersion]) > 0 { + return fmt.Sprintf("%s (%s)", a.Name, a.Tags[TagAlbumVersion][0]) + } + return a.Name +} + // Equals compares two Album structs, ignoring calculated fields func (a Album) Equals(other Album) bool { // Normalize float32 values to avoid false negatives diff --git a/model/album_test.go b/model/album_test.go index a45d16dd5..0f4c912cd 100644 --- a/model/album_test.go +++ b/model/album_test.go @@ -3,11 +3,30 @@ package model_test import ( "encoding/json" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" . "github.com/navidrome/navidrome/model" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) +var _ = Describe("Album", func() { + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + }) + DescribeTable("FullName", + func(enabled bool, tags Tags, expected string) { + conf.Server.Subsonic.AppendAlbumVersion = enabled + a := Album{Name: "Album", Tags: tags} + Expect(a.FullName()).To(Equal(expected)) + }, + Entry("appends version when enabled and tag is present", true, Tags{TagAlbumVersion: []string{"Remastered"}}, "Album (Remastered)"), + Entry("returns just name when disabled", false, Tags{TagAlbumVersion: []string{"Remastered"}}, "Album"), + Entry("returns just name when tag is absent", true, Tags{}, "Album"), + Entry("returns just name when tag is an empty slice", true, Tags{TagAlbumVersion: []string{}}, "Album"), + ) +}) + var _ = Describe("Albums", func() { var albums Albums diff --git a/model/annotation.go b/model/annotation.go index 2ec72c1b7..5228028a6 100644 --- a/model/annotation.go +++ b/model/annotation.go @@ -3,11 +3,13 @@ package model import "time" type Annotations struct { - PlayCount int64 `structs:"play_count" json:"playCount,omitempty"` - PlayDate *time.Time `structs:"play_date" json:"playDate,omitempty" ` - Rating int `structs:"rating" json:"rating,omitempty" ` - Starred bool `structs:"starred" json:"starred,omitempty" ` - StarredAt *time.Time `structs:"starred_at" json:"starredAt,omitempty"` + PlayCount int64 `structs:"play_count" json:"playCount,omitempty"` + PlayDate *time.Time `structs:"play_date" json:"playDate,omitempty" ` + Rating int `structs:"rating" json:"rating,omitempty" ` + RatedAt *time.Time `structs:"rated_at" json:"ratedAt,omitempty" ` + Starred bool `structs:"starred" json:"starred,omitempty" ` + StarredAt *time.Time `structs:"starred_at" json:"starredAt,omitempty"` + AverageRating float64 `structs:"average_rating" json:"averageRating,omitempty"` } type AnnotatedRepository interface { diff --git a/model/artist.go b/model/artist.go index 309ee800f..2085f0051 100644 --- a/model/artist.go +++ b/model/artist.go @@ -4,6 +4,8 @@ import ( "maps" "slices" "time" + + "github.com/navidrome/navidrome/consts" ) type Artist struct { @@ -34,6 +36,8 @@ type Artist struct { Missing bool `structs:"missing" json:"missing"` + UploadedImage string `structs:"uploaded_image" json:"uploadedImage,omitempty"` + CreatedAt *time.Time `structs:"created_at" json:"createdAt,omitempty"` UpdatedAt *time.Time `structs:"updated_at" json:"updatedAt,omitempty"` } @@ -58,6 +62,10 @@ func (a Artist) CoverArtID() ArtworkID { return artworkIDFromArtist(a) } +func (a Artist) UploadedImagePath() string { + return UploadedImagePath(consts.EntityArtist, a.UploadedImage) +} + // Roles returns the roles this artist has participated in., based on the Stats field func (a Artist) Roles() []Role { return slices.Collect(maps.Keys(a.Stats)) diff --git a/model/artist_test.go b/model/artist_test.go new file mode 100644 index 000000000..5a24504eb --- /dev/null +++ b/model/artist_test.go @@ -0,0 +1,30 @@ +package model_test + +import ( + "path/filepath" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Artist", func() { + Describe("UploadedImagePath", func() { + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.DataFolder = "/data" + }) + + It("returns empty string when no image uploaded", func() { + a := model.Artist{ID: "ar-1"} + Expect(a.UploadedImagePath()).To(BeEmpty()) + }) + + It("returns full path when image is set", func() { + a := model.Artist{ID: "ar-1", UploadedImage: "ar-1_test.jpg"} + Expect(a.UploadedImagePath()).To(Equal(filepath.Join("/data", "artwork", "artist", "ar-1_test.jpg"))) + }) + }) +}) diff --git a/model/artwork_id.go b/model/artwork_id.go index 36026dd03..1bd146c1f 100644 --- a/model/artwork_id.go +++ b/model/artwork_id.go @@ -22,6 +22,8 @@ var ( KindArtistArtwork = Kind{"ar", "artist"} KindAlbumArtwork = Kind{"al", "album"} KindPlaylistArtwork = Kind{"pl", "playlist"} + KindDiscArtwork = Kind{"dc", "disc"} + KindRadioArtwork = Kind{"ra", "radio"} ) var artworkKindMap = map[string]Kind{ @@ -29,6 +31,8 @@ var artworkKindMap = map[string]Kind{ KindArtistArtwork.prefix: KindArtistArtwork, KindAlbumArtwork.prefix: KindAlbumArtwork, KindPlaylistArtwork.prefix: KindPlaylistArtwork, + KindDiscArtwork.prefix: KindDiscArtwork, + KindRadioArtwork.prefix: KindRadioArtwork, } type ArtworkID struct { @@ -91,6 +95,22 @@ func MustParseArtworkID(id string) ArtworkID { return artID } +func DiscArtworkID(albumID string, discNumber int) string { + return fmt.Sprintf("%s:%d", albumID, discNumber) +} + +func ParseDiscArtworkID(id string) (albumID string, discNumber int, err error) { + parts := strings.SplitN(id, ":", 2) + if len(parts) != 2 || parts[1] == "" { + return "", 0, errors.New("invalid disc artwork id") + } + num, err := strconv.Atoi(parts[1]) + if err != nil { + return "", 0, fmt.Errorf("invalid disc number in artwork id: %w", err) + } + return parts[0], num, nil +} + func artworkIDFromAlbum(al Album) ArtworkID { return ArtworkID{ Kind: KindAlbumArtwork, @@ -121,3 +141,11 @@ func artworkIDFromArtist(ar Artist) ArtworkID { ID: ar.ID, } } + +func artworkIDFromRadio(r Radio) ArtworkID { + return ArtworkID{ + Kind: KindRadioArtwork, + ID: r.ID, + LastUpdate: r.UpdatedAt, + } +} diff --git a/model/artwork_id_test.go b/model/artwork_id_test.go index 2f42217f9..b634e7cbc 100644 --- a/model/artwork_id_test.go +++ b/model/artwork_id_test.go @@ -28,6 +28,40 @@ var _ = Describe("ArtworkID", func() { Expect(parsedId.LastUpdate.Unix()).To(Equal(id.LastUpdate.Unix())) }) }) + Describe("ParseArtworkID - disc kind", func() { + It("parses a disc artwork ID with dc prefix", func() { + now := time.Now() + id := model.NewArtworkID(model.KindDiscArtwork, "albumid123:2", &now) + parsedId, err := model.ParseArtworkID(id.String()) + Expect(err).ToNot(HaveOccurred()) + Expect(parsedId.Kind).To(Equal(model.KindDiscArtwork)) + Expect(parsedId.ID).To(Equal("albumid123:2")) + Expect(parsedId.LastUpdate.Unix()).To(Equal(now.Unix())) + }) + }) + + Describe("ParseDiscArtworkID", func() { + DescribeTable("parses composite disc artwork IDs", + func(id string, expectedAlbum string, expectedDisc int, expectErr bool) { + albumID, discNumber, err := model.ParseDiscArtworkID(id) + if expectErr { + Expect(err).To(HaveOccurred()) + } else { + Expect(err).ToNot(HaveOccurred()) + Expect(albumID).To(Equal(expectedAlbum)) + Expect(discNumber).To(Equal(expectedDisc)) + } + }, + Entry("valid id", "albumid123:2", "albumid123", 2, false), + Entry("disc number 1", "abc:1", "abc", 1, false), + Entry("large disc number", "abc:10", "abc", 10, false), + Entry("missing colon", "albumid123", "", 0, true), + Entry("missing disc number", "albumid123:", "", 0, true), + Entry("non-numeric disc", "albumid123:abc", "", 0, true), + Entry("empty string", "", "", 0, true), + ) + }) + Describe("ParseArtworkID()", func() { It("parses album artwork ids", func() { id, err := model.ParseArtworkID("al-1234") diff --git a/model/criteria/criteria.go b/model/criteria/criteria.go index fa92c5aca..278acf34c 100644 --- a/model/criteria/criteria.go +++ b/model/criteria/criteria.go @@ -15,10 +15,38 @@ type Expression = squirrel.Sqlizer type Criteria struct { Expression - Sort string - Order string - Limit int - Offset int + Sort string + Order string + Limit int + LimitPercent int + Offset int +} + +// EffectiveLimit resolves the effective limit for a query. If a fixed Limit is +// set it takes precedence. Otherwise, if LimitPercent is set, the limit is +// computed as a percentage of totalCount (minimum 1 when totalCount > 0). +// Returns 0 when no limit applies. +func (c Criteria) EffectiveLimit(totalCount int64) int { + if c.Limit > 0 { + return c.Limit + } + if c.LimitPercent > 0 && c.LimitPercent <= 100 { + if totalCount <= 0 { + return 0 + } + result := int(totalCount) * c.LimitPercent / 100 + if result < 1 { + return 1 + } + return result + } + return 0 +} + +// IsPercentageLimit returns true when the criteria uses a valid percentage-based +// limit (i.e. LimitPercent is in [1, 100] and no fixed Limit overrides it). +func (c Criteria) IsPercentageLimit() bool { + return c.Limit == 0 && c.LimitPercent > 0 && c.LimitPercent <= 100 } func (c Criteria) OrderBy() string { @@ -61,7 +89,12 @@ func (c Criteria) OrderBy() string { if f.order != "" { mapped = f.order } else if f.isTag { - mapped = "COALESCE(json_extract(media_file.tags, '$." + sortField + "[0].value'), '')" + // Use the actual field name (handles aliases like albumtype -> releasetype) + tagName := sortField + if f.field != "" { + tagName = f.field + } + mapped = "COALESCE(json_extract(media_file.tags, '$." + tagName + "[0].value'), '')" } else if f.isRole { mapped = "COALESCE(json_extract(media_file.participants, '$." + sortField + "[0].name'), '')" } else { @@ -90,6 +123,35 @@ func (c Criteria) ToSql() (sql string, args []any, err error) { return c.Expression.ToSql() } +// ExpressionJoins returns only the JOINs needed by the WHERE-clause expression, +// excluding any JOINs required solely for sorting. This is useful for COUNT +// queries where sort order is irrelevant. +func (c Criteria) ExpressionJoins() JoinType { + if c.Expression == nil { + return JoinNone + } + return extractJoinTypes(c.Expression) +} + +// RequiredJoins inspects the expression tree and Sort field to determine which +// additional JOINs are needed when evaluating this criteria. +func (c Criteria) RequiredJoins() JoinType { + result := JoinNone + if c.Expression != nil { + result |= extractJoinTypes(c.Expression) + } + // Also check Sort fields + if c.Sort != "" { + for _, p := range strings.Split(c.Sort, ",") { + p = strings.TrimSpace(p) + p = strings.TrimLeft(p, "+-") + p = strings.TrimSpace(p) + result |= fieldJoinType(p) + } + } + return result +} + func (c Criteria) ChildPlaylistIds() []string { if c.Expression == nil { return nil @@ -104,17 +166,19 @@ func (c Criteria) ChildPlaylistIds() []string { func (c Criteria) MarshalJSON() ([]byte, error) { aux := struct { - All []Expression `json:"all,omitempty"` - Any []Expression `json:"any,omitempty"` - Sort string `json:"sort,omitempty"` - Order string `json:"order,omitempty"` - Limit int `json:"limit,omitempty"` - Offset int `json:"offset,omitempty"` + All []Expression `json:"all,omitempty"` + Any []Expression `json:"any,omitempty"` + Sort string `json:"sort,omitempty"` + Order string `json:"order,omitempty"` + Limit int `json:"limit,omitempty"` + LimitPercent int `json:"limitPercent,omitempty"` + Offset int `json:"offset,omitempty"` }{ - Sort: c.Sort, - Order: c.Order, - Limit: c.Limit, - Offset: c.Offset, + Sort: c.Sort, + Order: c.Order, + Limit: c.Limit, + LimitPercent: c.LimitPercent, + Offset: c.Offset, } switch rules := c.Expression.(type) { case Any: @@ -129,12 +193,13 @@ func (c Criteria) MarshalJSON() ([]byte, error) { func (c *Criteria) UnmarshalJSON(data []byte) error { var aux struct { - All unmarshalConjunctionType `json:"all"` - Any unmarshalConjunctionType `json:"any"` - Sort string `json:"sort"` - Order string `json:"order"` - Limit int `json:"limit"` - Offset int `json:"offset"` + All unmarshalConjunctionType `json:"all"` + Any unmarshalConjunctionType `json:"any"` + Sort string `json:"sort"` + Order string `json:"order"` + Limit int `json:"limit"` + LimitPercent int `json:"limitPercent"` + Offset int `json:"offset"` } if err := json.Unmarshal(data, &aux); err != nil { return err @@ -150,5 +215,15 @@ func (c *Criteria) UnmarshalJSON(data []byte) error { c.Order = aux.Order c.Limit = aux.Limit c.Offset = aux.Offset + + // Clamp LimitPercent to [0, 100] + if aux.LimitPercent < 0 { + log.Warn("limitPercent value out of range, clamping to 0", "value", aux.LimitPercent) + aux.LimitPercent = 0 + } else if aux.LimitPercent > 100 { + log.Warn("limitPercent value out of range, clamping to 100", "value", aux.LimitPercent) + aux.LimitPercent = 100 + } + c.LimitPercent = aux.LimitPercent return nil } diff --git a/model/criteria/criteria_test.go b/model/criteria/criteria_test.go index 3792264a5..a76b3fc1f 100644 --- a/model/criteria/criteria_test.go +++ b/model/criteria/criteria_test.go @@ -27,6 +27,7 @@ var _ = Describe("Criteria", func() { StartsWith{"comment": "this"}, InTheRange{"year": []int{1980, 1990}}, IsNot{"genre": "Rock"}, + Gt{"albumrating": 3}, }, }, Sort: "title", @@ -48,7 +49,8 @@ var _ = Describe("Criteria", func() { { "all": [ { "startsWith": {"comment": "this"} }, { "inTheRange": {"year":[1980,1990]} }, - { "isNot": { "genre": "Rock" }} + { "isNot": { "genre": "Rock" }}, + { "gt": { "albumrating": 3 } } ] } ], @@ -68,10 +70,10 @@ var _ = Describe("Criteria", func() { gomega.Expect(err).ToNot(gomega.HaveOccurred()) gomega.Expect(sql).To(gomega.Equal( `(media_file.title LIKE ? AND media_file.title NOT LIKE ? ` + - `AND (not exists (select 1 from json_tree(participants, '$.artist') where key='name' and value = ?) ` + + `AND (not exists (select 1 from json_tree(media_file.participants, '$.artist') where key='name' and value = ?) ` + `OR media_file.album = ?) AND (media_file.comment LIKE ? AND (media_file.year >= ? AND media_file.year <= ?) ` + - `AND not exists (select 1 from json_tree(tags, '$.genre') where key='value' and value = ?)))`)) - gomega.Expect(args).To(gomega.HaveExactElements("%love%", "%hate%", "u2", "best of", "this%", 1980, 1990, "Rock")) + `AND not exists (select 1 from json_tree(media_file.tags, '$.genre') where key='value' and value = ?) AND COALESCE(album_annotation.rating, 0) > ?))`)) + gomega.Expect(args).To(gomega.HaveExactElements("%love%", "%hate%", "u2", "best of", "this%", 1980, 1990, "Rock", 3)) }) It("marshals to JSON", func() { j, err := json.Marshal(goObj) @@ -118,6 +120,16 @@ var _ = Describe("Criteria", func() { ) }) + It("sorts by albumtype alias (resolves to releasetype)", func() { + AddTagNames([]string{"releasetype"}) + goObj.Sort = "albumtype" + gomega.Expect(goObj.OrderBy()).To( + gomega.Equal( + "COALESCE(json_extract(media_file.tags, '$.releasetype[0].value'), '') asc", + ), + ) + }) + It("sorts by random", func() { newObj := goObj newObj.Sort = "random" @@ -162,13 +174,237 @@ var _ = Describe("Criteria", func() { sql, args, err := goObj.ToSql() gomega.Expect(err).ToNot(gomega.HaveOccurred()) gomega.Expect(sql).To(gomega.Equal( - `(exists (select 1 from json_tree(participants, '$.artist') where key='name' and value = ?) AND ` + - `exists (select 1 from json_tree(participants, '$.composer') where key='name' and value LIKE ?))`, + `(exists (select 1 from json_tree(media_file.participants, '$.artist') where key='name' and value = ?) AND ` + + `exists (select 1 from json_tree(media_file.participants, '$.composer') where key='name' and value LIKE ?))`, )) gomega.Expect(args).To(gomega.HaveExactElements("The Beatles", "%Lennon%")) }) }) + Describe("ExpressionJoins", func() { + It("excludes sort-only joins", func() { + c := Criteria{ + Expression: All{ + Contains{"title": "love"}, + }, + Sort: "albumRating", + } + gomega.Expect(c.ExpressionJoins()).To(gomega.Equal(JoinNone)) + gomega.Expect(c.RequiredJoins().Has(JoinAlbumAnnotation)).To(gomega.BeTrue()) + }) + + It("includes expression-based joins", func() { + c := Criteria{ + Expression: All{ + Gt{"albumRating": 3}, + }, + } + gomega.Expect(c.ExpressionJoins().Has(JoinAlbumAnnotation)).To(gomega.BeTrue()) + }) + }) + + Describe("RequiredJoins", func() { + It("returns JoinNone when no annotation fields are used", func() { + c := Criteria{ + Expression: All{ + Contains{"title": "love"}, + }, + } + gomega.Expect(c.RequiredJoins()).To(gomega.Equal(JoinNone)) + }) + It("returns JoinNone for media_file annotation fields", func() { + c := Criteria{ + Expression: All{ + Is{"loved": true}, + Gt{"playCount": 5}, + }, + } + gomega.Expect(c.RequiredJoins()).To(gomega.Equal(JoinNone)) + }) + It("returns JoinAlbumAnnotation for album annotation fields", func() { + c := Criteria{ + Expression: All{ + Gt{"albumRating": 3}, + }, + } + gomega.Expect(c.RequiredJoins()).To(gomega.Equal(JoinAlbumAnnotation)) + }) + It("returns JoinArtistAnnotation for artist annotation fields", func() { + c := Criteria{ + Expression: All{ + Is{"artistLoved": true}, + }, + } + gomega.Expect(c.RequiredJoins()).To(gomega.Equal(JoinArtistAnnotation)) + }) + It("returns both join types when both are used", func() { + c := Criteria{ + Expression: All{ + Gt{"albumRating": 3}, + Is{"artistLoved": true}, + }, + } + j := c.RequiredJoins() + gomega.Expect(j.Has(JoinAlbumAnnotation)).To(gomega.BeTrue()) + gomega.Expect(j.Has(JoinArtistAnnotation)).To(gomega.BeTrue()) + }) + It("detects join types in nested expressions", func() { + c := Criteria{ + Expression: All{ + Any{ + All{ + Is{"albumLoved": true}, + }, + }, + Any{ + Gt{"artistPlayCount": 10}, + }, + }, + } + j := c.RequiredJoins() + gomega.Expect(j.Has(JoinAlbumAnnotation)).To(gomega.BeTrue()) + gomega.Expect(j.Has(JoinArtistAnnotation)).To(gomega.BeTrue()) + }) + It("detects join types from Sort field", func() { + c := Criteria{ + Expression: All{ + Contains{"title": "love"}, + }, + Sort: "albumRating", + } + gomega.Expect(c.RequiredJoins().Has(JoinAlbumAnnotation)).To(gomega.BeTrue()) + }) + It("detects join types from Sort field with direction prefix", func() { + c := Criteria{ + Expression: All{ + Contains{"title": "love"}, + }, + Sort: "-artistRating", + } + gomega.Expect(c.RequiredJoins().Has(JoinArtistAnnotation)).To(gomega.BeTrue()) + }) + }) + + Describe("LimitPercent", func() { + Describe("JSON round-trip", func() { + It("marshals and unmarshals limitPercent", func() { + goObj := Criteria{ + Expression: All{Contains{"title": "love"}}, + Sort: "title", + Order: "asc", + LimitPercent: 10, + } + j, err := json.Marshal(goObj) + gomega.Expect(err).ToNot(gomega.HaveOccurred()) + gomega.Expect(string(j)).To(gomega.ContainSubstring(`"limitPercent":10`)) + gomega.Expect(string(j)).ToNot(gomega.ContainSubstring(`"limit"`)) + + var newObj Criteria + err = json.Unmarshal(j, &newObj) + gomega.Expect(err).ToNot(gomega.HaveOccurred()) + gomega.Expect(newObj.LimitPercent).To(gomega.Equal(10)) + gomega.Expect(newObj.Limit).To(gomega.Equal(0)) + }) + + It("does not include limitPercent when zero", func() { + goObj := Criteria{ + Expression: All{Contains{"title": "love"}}, + Limit: 50, + } + j, err := json.Marshal(goObj) + gomega.Expect(err).ToNot(gomega.HaveOccurred()) + gomega.Expect(string(j)).To(gomega.ContainSubstring(`"limit":50`)) + gomega.Expect(string(j)).ToNot(gomega.ContainSubstring(`limitPercent`)) + }) + + It("backward compatible: JSON with only limit still works", func() { + jsonStr := `{"all":[{"contains":{"title":"love"}}],"limit":20}` + var c Criteria + err := json.Unmarshal([]byte(jsonStr), &c) + gomega.Expect(err).ToNot(gomega.HaveOccurred()) + gomega.Expect(c.Limit).To(gomega.Equal(20)) + gomega.Expect(c.LimitPercent).To(gomega.Equal(0)) + }) + }) + + Describe("UnmarshalJSON clamping", func() { + It("clamps values above 100 to 100", func() { + jsonStr := `{"all":[{"contains":{"title":"love"}}],"limitPercent":150}` + var c Criteria + err := json.Unmarshal([]byte(jsonStr), &c) + gomega.Expect(err).ToNot(gomega.HaveOccurred()) + gomega.Expect(c.LimitPercent).To(gomega.Equal(100)) + }) + + It("clamps negative values to 0", func() { + jsonStr := `{"all":[{"contains":{"title":"love"}}],"limitPercent":-5}` + var c Criteria + err := json.Unmarshal([]byte(jsonStr), &c) + gomega.Expect(err).ToNot(gomega.HaveOccurred()) + gomega.Expect(c.LimitPercent).To(gomega.Equal(0)) + }) + }) + + Describe("EffectiveLimit", func() { + It("returns fixed limit when Limit is set", func() { + c := Criteria{Limit: 50, LimitPercent: 10} + gomega.Expect(c.EffectiveLimit(1000)).To(gomega.Equal(50)) + }) + + It("returns percentage-based limit", func() { + c := Criteria{LimitPercent: 10} + gomega.Expect(c.EffectiveLimit(450)).To(gomega.Equal(45)) + }) + + It("returns minimum 1 when totalCount > 0 and percentage rounds to 0", func() { + c := Criteria{LimitPercent: 1} + gomega.Expect(c.EffectiveLimit(5)).To(gomega.Equal(1)) + }) + + It("returns 0 when totalCount is 0", func() { + c := Criteria{LimitPercent: 10} + gomega.Expect(c.EffectiveLimit(0)).To(gomega.Equal(0)) + }) + + It("returns 0 when no limit is set", func() { + c := Criteria{} + gomega.Expect(c.EffectiveLimit(1000)).To(gomega.Equal(0)) + }) + + It("returns full count for 100%", func() { + c := Criteria{LimitPercent: 100} + gomega.Expect(c.EffectiveLimit(450)).To(gomega.Equal(450)) + }) + + It("returns 1 for 1% of 50 items", func() { + c := Criteria{LimitPercent: 1} + gomega.Expect(c.EffectiveLimit(50)).To(gomega.Equal(1)) + }) + }) + + Describe("IsPercentageLimit", func() { + It("returns true when LimitPercent is set and Limit is 0", func() { + c := Criteria{LimitPercent: 10} + gomega.Expect(c.IsPercentageLimit()).To(gomega.BeTrue()) + }) + + It("returns false when Limit is set", func() { + c := Criteria{Limit: 50, LimitPercent: 10} + gomega.Expect(c.IsPercentageLimit()).To(gomega.BeFalse()) + }) + + It("returns false when neither is set", func() { + c := Criteria{} + gomega.Expect(c.IsPercentageLimit()).To(gomega.BeFalse()) + }) + + It("returns false when LimitPercent is out of range", func() { + c := Criteria{LimitPercent: 150} + gomega.Expect(c.IsPercentageLimit()).To(gomega.BeFalse()) + }) + }) + }) + Context("with child playlists", func() { var ( topLevelInPlaylistID string diff --git a/model/criteria/fields.go b/model/criteria/fields.go index 3699eb14a..b9d91f087 100644 --- a/model/criteria/fields.go +++ b/model/criteria/fields.go @@ -9,44 +9,72 @@ import ( "github.com/navidrome/navidrome/log" ) +// JoinType is a bitmask indicating which additional JOINs are needed by a smart playlist expression. +type JoinType int + +const ( + JoinNone JoinType = 0 + JoinAlbumAnnotation JoinType = 1 << iota + JoinArtistAnnotation +) + +// Has returns true if j contains all bits in other. +func (j JoinType) Has(other JoinType) bool { return j&other != 0 } + var fieldMap = map[string]*mappedField{ - "title": {field: "media_file.title"}, - "album": {field: "media_file.album"}, - "hascoverart": {field: "media_file.has_cover_art"}, - "tracknumber": {field: "media_file.track_number"}, - "discnumber": {field: "media_file.disc_number"}, - "year": {field: "media_file.year"}, - "date": {field: "media_file.date", alias: "recordingdate"}, - "originalyear": {field: "media_file.original_year"}, - "originaldate": {field: "media_file.original_date"}, - "releaseyear": {field: "media_file.release_year"}, - "releasedate": {field: "media_file.release_date"}, - "size": {field: "media_file.size"}, - "compilation": {field: "media_file.compilation"}, - "dateadded": {field: "media_file.created_at"}, - "datemodified": {field: "media_file.updated_at"}, - "discsubtitle": {field: "media_file.disc_subtitle"}, - "comment": {field: "media_file.comment"}, - "lyrics": {field: "media_file.lyrics"}, - "sorttitle": {field: "media_file.sort_title"}, - "sortalbum": {field: "media_file.sort_album_name"}, - "sortartist": {field: "media_file.sort_artist_name"}, - "sortalbumartist": {field: "media_file.sort_album_artist_name"}, - "albumtype": {field: "media_file.mbz_album_type", alias: "releasetype"}, - "albumcomment": {field: "media_file.mbz_album_comment"}, - "catalognumber": {field: "media_file.catalog_num"}, - "filepath": {field: "media_file.path"}, - "filetype": {field: "media_file.suffix"}, - "duration": {field: "media_file.duration"}, - "bitrate": {field: "media_file.bit_rate"}, - "bitdepth": {field: "media_file.bit_depth"}, - "bpm": {field: "media_file.bpm"}, - "channels": {field: "media_file.channels"}, - "loved": {field: "COALESCE(annotation.starred, false)"}, - "dateloved": {field: "annotation.starred_at"}, - "lastplayed": {field: "annotation.play_date"}, - "playcount": {field: "COALESCE(annotation.play_count, 0)"}, - "rating": {field: "COALESCE(annotation.rating, 0)"}, + "title": {field: "media_file.title"}, + "album": {field: "media_file.album"}, + "hascoverart": {field: "media_file.has_cover_art"}, + "tracknumber": {field: "media_file.track_number"}, + "discnumber": {field: "media_file.disc_number"}, + "year": {field: "media_file.year"}, + "date": {field: "media_file.date", alias: "recordingdate"}, + "originalyear": {field: "media_file.original_year"}, + "originaldate": {field: "media_file.original_date"}, + "releaseyear": {field: "media_file.release_year"}, + "releasedate": {field: "media_file.release_date"}, + "size": {field: "media_file.size"}, + "compilation": {field: "media_file.compilation"}, + "explicitstatus": {field: "media_file.explicit_status"}, + "dateadded": {field: "media_file.created_at"}, + "datemodified": {field: "media_file.updated_at"}, + "discsubtitle": {field: "media_file.disc_subtitle"}, + "comment": {field: "media_file.comment"}, + "lyrics": {field: "media_file.lyrics"}, + "sorttitle": {field: "media_file.sort_title"}, + "sortalbum": {field: "media_file.sort_album_name"}, + "sortartist": {field: "media_file.sort_artist_name"}, + "sortalbumartist": {field: "media_file.sort_album_artist_name"}, + "albumcomment": {field: "media_file.mbz_album_comment"}, + "catalognumber": {field: "media_file.catalog_num"}, + "filepath": {field: "media_file.path"}, + "filetype": {field: "media_file.suffix"}, + "duration": {field: "media_file.duration"}, + "bitrate": {field: "media_file.bit_rate"}, + "bitdepth": {field: "media_file.bit_depth"}, + "bpm": {field: "media_file.bpm"}, + "channels": {field: "media_file.channels"}, + "loved": {field: "COALESCE(annotation.starred, false)"}, + "dateloved": {field: "annotation.starred_at"}, + "lastplayed": {field: "annotation.play_date"}, + "daterated": {field: "annotation.rated_at"}, + "playcount": {field: "COALESCE(annotation.play_count, 0)"}, + "rating": {field: "COALESCE(annotation.rating, 0)"}, + "averagerating": {field: "media_file.average_rating", numeric: true}, + "albumrating": {field: "COALESCE(album_annotation.rating, 0)", joinType: JoinAlbumAnnotation}, + "albumloved": {field: "COALESCE(album_annotation.starred, false)", joinType: JoinAlbumAnnotation}, + "albumplaycount": {field: "COALESCE(album_annotation.play_count, 0)", joinType: JoinAlbumAnnotation}, + "albumlastplayed": {field: "album_annotation.play_date", joinType: JoinAlbumAnnotation}, + "albumdateloved": {field: "album_annotation.starred_at", joinType: JoinAlbumAnnotation}, + "albumdaterated": {field: "album_annotation.rated_at", joinType: JoinAlbumAnnotation}, + + "artistrating": {field: "COALESCE(artist_annotation.rating, 0)", joinType: JoinArtistAnnotation}, + "artistloved": {field: "COALESCE(artist_annotation.starred, false)", joinType: JoinArtistAnnotation}, + "artistplaycount": {field: "COALESCE(artist_annotation.play_count, 0)", joinType: JoinArtistAnnotation}, + "artistlastplayed": {field: "artist_annotation.play_date", joinType: JoinArtistAnnotation}, + "artistdateloved": {field: "artist_annotation.starred_at", joinType: JoinArtistAnnotation}, + "artistdaterated": {field: "artist_annotation.rated_at", joinType: JoinArtistAnnotation}, + "mbz_album_id": {field: "media_file.mbz_album_id"}, "mbz_album_artist_id": {field: "media_file.mbz_album_artist_id"}, "mbz_artist_id": {field: "media_file.mbz_artist_id"}, @@ -55,18 +83,22 @@ var fieldMap = map[string]*mappedField{ "mbz_release_group_id": {field: "media_file.mbz_release_group_id"}, "library_id": {field: "media_file.library_id", numeric: true}, + // Backward compatibility: albumtype is an alias for releasetype tag + "albumtype": {field: "releasetype", isTag: true}, + // special fields "random": {field: "", order: "random()"}, // pseudo-field for random sorting "value": {field: "value"}, // pseudo-field for tag and roles values } type mappedField struct { - field string - order string - isRole bool // true if the field is a role (e.g. "artist", "composer", "conductor", etc.) - isTag bool // true if the field is a tag imported from the file metadata - alias string // name from `mappings.yml` that may differ from the name used in the smart playlist - numeric bool // true if the field/tag should be treated as numeric + field string + order string + isRole bool // true if the field is a role (e.g. "artist", "composer", "conductor", etc.) + isTag bool // true if the field is a tag imported from the file metadata + alias string // name from `mappings.yml` that may differ from the name used in the smart playlist + numeric bool // true if the field/tag should be treated as numeric + joinType JoinType // which additional JOINs this field requires } func mapFields(expr map[string]any) map[string]any { @@ -90,27 +122,24 @@ func mapExpr(expr squirrel.Sqlizer, negate bool, exprFunc func(string, squirrel. log.Fatal(fmt.Sprintf("expr is not a map-based operator: %T", expr)) } - // Extract into a generic map + // Extract the field name and value, then build a new map keyed by "value" + // for the inner condition. The original map is left untouched so that + // ToSql can be called multiple times without corruption. var k string - m := make(map[string]any, rv.Len()) + var v any for _, key := range rv.MapKeys() { - // Save the key to build the expression, and use the provided keyName as the key k = key.String() - m["value"] = rv.MapIndex(key).Interface() + v = rv.MapIndex(key).Interface() break // only one key is expected (and supported) } - // Clear the original map - for _, key := range rv.MapKeys() { - rv.SetMapIndex(key, reflect.Value{}) - } + // Create a new map-based expression with "value" as the key, matching the + // column name inside json_tree subqueries. + newMap := reflect.MakeMap(rv.Type()) + newMap.SetMapIndex(reflect.ValueOf("value"), reflect.ValueOf(v)) + newExpr := newMap.Interface().(squirrel.Sqlizer) - // Write the updated map back into the original variable - for key, val := range m { - rv.SetMapIndex(reflect.ValueOf(key), reflect.ValueOf(val)) - } - - return exprFunc(k, expr, negate) + return exprFunc(k, newExpr, negate) } // mapTagExpr maps a normal field expression to a tag expression. @@ -154,13 +183,19 @@ type tagCond struct { func (e tagCond) ToSql() (string, []any, error) { cond, args, err := e.cond.ToSql() - // Check if this tag is marked as numeric in the fieldMap - if fm, ok := fieldMap[e.tag]; ok && fm.numeric { - cond = strings.ReplaceAll(cond, "value", "CAST(value AS REAL)") + // Resolve the actual tag name (handles aliases like albumtype -> releasetype) + tagName := e.tag + if fm, ok := fieldMap[e.tag]; ok { + if fm.field != "" { + tagName = fm.field + } + if fm.numeric { + cond = strings.ReplaceAll(cond, "value", "CAST(value AS REAL)") + } } - cond = fmt.Sprintf("exists (select 1 from json_tree(tags, '$.%s') where key='value' and %s)", - e.tag, cond) + cond = fmt.Sprintf("exists (select 1 from json_tree(media_file.tags, '$.%s') where key='value' and %s)", + tagName, cond) if e.not { cond = "not " + cond } @@ -179,7 +214,7 @@ type roleCond struct { func (e roleCond) ToSql() (string, []any, error) { cond, args, err := e.cond.ToSql() - cond = fmt.Sprintf(`exists (select 1 from json_tree(participants, '$.%s') where key='name' and %s)`, + cond = fmt.Sprintf(`exists (select 1 from json_tree(media_file.participants, '$.%s') where key='name' and %s)`, e.role, cond) if e.not { cond = "not " + cond @@ -187,6 +222,38 @@ func (e roleCond) ToSql() (string, []any, error) { return cond, args, err } +// fieldJoinType returns the JoinType for a given field name (case-insensitive). +func fieldJoinType(name string) JoinType { + if f, ok := fieldMap[strings.ToLower(name)]; ok { + return f.joinType + } + return JoinNone +} + +// extractJoinTypes walks an expression tree and collects all required JoinType flags. +func extractJoinTypes(expr any) JoinType { + result := JoinNone + switch e := expr.(type) { + case All: + for _, sub := range e { + result |= extractJoinTypes(sub) + } + case Any: + for _, sub := range e { + result |= extractJoinTypes(sub) + } + default: + // Leaf expression: use reflection to check if it's a map with field names + rv := reflect.ValueOf(expr) + if rv.Kind() == reflect.Map && rv.Type().Key().Kind() == reflect.String { + for _, key := range rv.MapKeys() { + result |= fieldJoinType(key.String()) + } + } + } + return result +} + // AddRoles adds roles to the field map. This is used to add all artist roles to the field map, so they can be used in // smart playlists. If a role already exists in the field map, it is ignored, so calls to this function are idempotent. func AddRoles(roles []string) { diff --git a/model/criteria/operators_test.go b/model/criteria/operators_test.go index ee716a9cd..5f756f97d 100644 --- a/model/criteria/operators_test.go +++ b/model/criteria/operators_test.go @@ -54,23 +54,43 @@ var _ = Describe("Operators", func() { Entry("inTheLast", InTheLast{"lastPlayed": 30}, "annotation.play_date > ?", StartOfPeriod(30, time.Now())), Entry("notInTheLast", NotInTheLast{"lastPlayed": 30}, "(annotation.play_date < ? OR annotation.play_date IS NULL)", StartOfPeriod(30, time.Now())), + // Album annotation fields + Entry("albumRating", Gt{"albumRating": 3}, "COALESCE(album_annotation.rating, 0) > ?", 3), + Entry("albumLoved", Is{"albumLoved": true}, "COALESCE(album_annotation.starred, false) = ?", true), + Entry("albumPlayCount", Gt{"albumPlayCount": 5}, "COALESCE(album_annotation.play_count, 0) > ?", 5), + Entry("albumLastPlayed", After{"albumLastPlayed": rangeStart}, "album_annotation.play_date > ?", rangeStart), + Entry("albumDateLoved", Before{"albumDateLoved": rangeStart}, "album_annotation.starred_at < ?", rangeStart), + Entry("albumDateRated", After{"albumDateRated": rangeStart}, "album_annotation.rated_at > ?", rangeStart), + Entry("albumLastPlayed inTheLast", InTheLast{"albumLastPlayed": 30}, "album_annotation.play_date > ?", StartOfPeriod(30, time.Now())), + Entry("albumLastPlayed notInTheLast", NotInTheLast{"albumLastPlayed": 30}, "(album_annotation.play_date < ? OR album_annotation.play_date IS NULL)", StartOfPeriod(30, time.Now())), + + // Artist annotation fields + Entry("artistRating", Gt{"artistRating": 3}, "COALESCE(artist_annotation.rating, 0) > ?", 3), + Entry("artistLoved", Is{"artistLoved": true}, "COALESCE(artist_annotation.starred, false) = ?", true), + Entry("artistPlayCount", Gt{"artistPlayCount": 5}, "COALESCE(artist_annotation.play_count, 0) > ?", 5), + Entry("artistLastPlayed", After{"artistLastPlayed": rangeStart}, "artist_annotation.play_date > ?", rangeStart), + Entry("artistDateLoved", Before{"artistDateLoved": rangeStart}, "artist_annotation.starred_at < ?", rangeStart), + Entry("artistDateRated", After{"artistDateRated": rangeStart}, "artist_annotation.rated_at > ?", rangeStart), + Entry("artistLastPlayed inTheLast", InTheLast{"artistLastPlayed": 30}, "artist_annotation.play_date > ?", StartOfPeriod(30, time.Now())), + Entry("artistLastPlayed notInTheLast", NotInTheLast{"artistLastPlayed": 30}, "(artist_annotation.play_date < ? OR artist_annotation.play_date IS NULL)", StartOfPeriod(30, time.Now())), + // Tag tests - Entry("tag is [string]", Is{"genre": "Rock"}, "exists (select 1 from json_tree(tags, '$.genre') where key='value' and value = ?)", "Rock"), - Entry("tag isNot [string]", IsNot{"genre": "Rock"}, "not exists (select 1 from json_tree(tags, '$.genre') where key='value' and value = ?)", "Rock"), - Entry("tag gt", Gt{"genre": "A"}, "exists (select 1 from json_tree(tags, '$.genre') where key='value' and value > ?)", "A"), - Entry("tag lt", Lt{"genre": "Z"}, "exists (select 1 from json_tree(tags, '$.genre') where key='value' and value < ?)", "Z"), - Entry("tag contains", Contains{"genre": "Rock"}, "exists (select 1 from json_tree(tags, '$.genre') where key='value' and value LIKE ?)", "%Rock%"), - Entry("tag not contains", NotContains{"genre": "Rock"}, "not exists (select 1 from json_tree(tags, '$.genre') where key='value' and value LIKE ?)", "%Rock%"), - Entry("tag startsWith", StartsWith{"genre": "Soft"}, "exists (select 1 from json_tree(tags, '$.genre') where key='value' and value LIKE ?)", "Soft%"), - Entry("tag endsWith", EndsWith{"genre": "Rock"}, "exists (select 1 from json_tree(tags, '$.genre') where key='value' and value LIKE ?)", "%Rock"), + Entry("tag is [string]", Is{"genre": "Rock"}, "exists (select 1 from json_tree(media_file.tags, '$.genre') where key='value' and value = ?)", "Rock"), + Entry("tag isNot [string]", IsNot{"genre": "Rock"}, "not exists (select 1 from json_tree(media_file.tags, '$.genre') where key='value' and value = ?)", "Rock"), + Entry("tag gt", Gt{"genre": "A"}, "exists (select 1 from json_tree(media_file.tags, '$.genre') where key='value' and value > ?)", "A"), + Entry("tag lt", Lt{"genre": "Z"}, "exists (select 1 from json_tree(media_file.tags, '$.genre') where key='value' and value < ?)", "Z"), + Entry("tag contains", Contains{"genre": "Rock"}, "exists (select 1 from json_tree(media_file.tags, '$.genre') where key='value' and value LIKE ?)", "%Rock%"), + Entry("tag not contains", NotContains{"genre": "Rock"}, "not exists (select 1 from json_tree(media_file.tags, '$.genre') where key='value' and value LIKE ?)", "%Rock%"), + Entry("tag startsWith", StartsWith{"genre": "Soft"}, "exists (select 1 from json_tree(media_file.tags, '$.genre') where key='value' and value LIKE ?)", "Soft%"), + Entry("tag endsWith", EndsWith{"genre": "Rock"}, "exists (select 1 from json_tree(media_file.tags, '$.genre') where key='value' and value LIKE ?)", "%Rock"), // Artist roles tests - Entry("role is [string]", Is{"artist": "u2"}, "exists (select 1 from json_tree(participants, '$.artist') where key='name' and value = ?)", "u2"), - Entry("role isNot [string]", IsNot{"artist": "u2"}, "not exists (select 1 from json_tree(participants, '$.artist') where key='name' and value = ?)", "u2"), - Entry("role contains [string]", Contains{"artist": "u2"}, "exists (select 1 from json_tree(participants, '$.artist') where key='name' and value LIKE ?)", "%u2%"), - Entry("role not contains [string]", NotContains{"artist": "u2"}, "not exists (select 1 from json_tree(participants, '$.artist') where key='name' and value LIKE ?)", "%u2%"), - Entry("role startsWith [string]", StartsWith{"composer": "John"}, "exists (select 1 from json_tree(participants, '$.composer') where key='name' and value LIKE ?)", "John%"), - Entry("role endsWith [string]", EndsWith{"composer": "Lennon"}, "exists (select 1 from json_tree(participants, '$.composer') where key='name' and value LIKE ?)", "%Lennon"), + Entry("role is [string]", Is{"artist": "u2"}, "exists (select 1 from json_tree(media_file.participants, '$.artist') where key='name' and value = ?)", "u2"), + Entry("role isNot [string]", IsNot{"artist": "u2"}, "not exists (select 1 from json_tree(media_file.participants, '$.artist') where key='name' and value = ?)", "u2"), + Entry("role contains [string]", Contains{"artist": "u2"}, "exists (select 1 from json_tree(media_file.participants, '$.artist') where key='name' and value LIKE ?)", "%u2%"), + Entry("role not contains [string]", NotContains{"artist": "u2"}, "not exists (select 1 from json_tree(media_file.participants, '$.artist') where key='name' and value LIKE ?)", "%u2%"), + Entry("role startsWith [string]", StartsWith{"composer": "John"}, "exists (select 1 from json_tree(media_file.participants, '$.composer') where key='name' and value LIKE ?)", "John%"), + Entry("role endsWith [string]", EndsWith{"composer": "Lennon"}, "exists (select 1 from json_tree(media_file.participants, '$.composer') where key='name' and value LIKE ?)", "%Lennon"), ) // TODO Validate operators that are not valid for each field type. @@ -88,7 +108,7 @@ var _ = Describe("Operators", func() { op := EndsWith{"mood": "Soft"} sql, args, err := op.ToSql() gomega.Expect(err).ToNot(gomega.HaveOccurred()) - gomega.Expect(sql).To(gomega.Equal("exists (select 1 from json_tree(tags, '$.mood') where key='value' and value LIKE ?)")) + gomega.Expect(sql).To(gomega.Equal("exists (select 1 from json_tree(media_file.tags, '$.mood') where key='value' and value LIKE ?)")) gomega.Expect(args).To(gomega.HaveExactElements("%Soft")) }) It("casts numeric comparisons", func() { @@ -96,7 +116,7 @@ var _ = Describe("Operators", func() { op := Lt{"rate": 6} sql, args, err := op.ToSql() gomega.Expect(err).ToNot(gomega.HaveOccurred()) - gomega.Expect(sql).To(gomega.Equal("exists (select 1 from json_tree(tags, '$.rate') where key='value' and CAST(value AS REAL) < ?)")) + gomega.Expect(sql).To(gomega.Equal("exists (select 1 from json_tree(media_file.tags, '$.rate') where key='value' and CAST(value AS REAL) < ?)")) gomega.Expect(args).To(gomega.HaveExactElements(6)) }) It("skips unknown tag names", func() { @@ -105,6 +125,40 @@ var _ = Describe("Operators", func() { gomega.Expect(sql).To(gomega.BeEmpty()) gomega.Expect(args).To(gomega.BeEmpty()) }) + It("supports releasetype as multi-valued tag", func() { + AddTagNames([]string{"releasetype"}) + op := Contains{"releasetype": "soundtrack"} + sql, args, err := op.ToSql() + gomega.Expect(err).ToNot(gomega.HaveOccurred()) + gomega.Expect(sql).To(gomega.Equal("exists (select 1 from json_tree(media_file.tags, '$.releasetype') where key='value' and value LIKE ?)")) + gomega.Expect(args).To(gomega.HaveExactElements("%soundtrack%")) + }) + It("supports albumtype as alias for releasetype", func() { + AddTagNames([]string{"releasetype"}) + op := Contains{"albumtype": "live"} + sql, args, err := op.ToSql() + gomega.Expect(err).ToNot(gomega.HaveOccurred()) + gomega.Expect(sql).To(gomega.Equal("exists (select 1 from json_tree(media_file.tags, '$.releasetype') where key='value' and value LIKE ?)")) + gomega.Expect(args).To(gomega.HaveExactElements("%live%")) + }) + It("supports albumtype alias with Is operator", func() { + AddTagNames([]string{"releasetype"}) + op := Is{"albumtype": "album"} + sql, args, err := op.ToSql() + gomega.Expect(err).ToNot(gomega.HaveOccurred()) + // Should query $.releasetype, not $.albumtype + gomega.Expect(sql).To(gomega.Equal("exists (select 1 from json_tree(media_file.tags, '$.releasetype') where key='value' and value = ?)")) + gomega.Expect(args).To(gomega.HaveExactElements("album")) + }) + It("supports albumtype alias with IsNot operator", func() { + AddTagNames([]string{"releasetype"}) + op := IsNot{"albumtype": "compilation"} + sql, args, err := op.ToSql() + gomega.Expect(err).ToNot(gomega.HaveOccurred()) + // Should query $.releasetype, not $.albumtype + gomega.Expect(sql).To(gomega.Equal("not exists (select 1 from json_tree(media_file.tags, '$.releasetype') where key='value' and value = ?)")) + gomega.Expect(args).To(gomega.HaveExactElements("compilation")) + }) }) Describe("Custom Roles", func() { @@ -113,7 +167,7 @@ var _ = Describe("Operators", func() { op := EndsWith{"producer": "Eno"} sql, args, err := op.ToSql() gomega.Expect(err).ToNot(gomega.HaveOccurred()) - gomega.Expect(sql).To(gomega.Equal("exists (select 1 from json_tree(participants, '$.producer') where key='name' and value LIKE ?)")) + gomega.Expect(sql).To(gomega.Equal("exists (select 1 from json_tree(media_file.participants, '$.producer') where key='name' and value LIKE ?)")) gomega.Expect(args).To(gomega.HaveExactElements("%Eno")) }) It("skips unknown roles", func() { @@ -124,6 +178,21 @@ var _ = Describe("Operators", func() { }) }) + DescribeTable("ToSql idempotency", + func(expr Expression) { + sql1, args1, err1 := expr.ToSql() + sql2, args2, err2 := expr.ToSql() + + gomega.Expect(err1).ToNot(gomega.HaveOccurred()) + gomega.Expect(err2).ToNot(gomega.HaveOccurred()) + gomega.Expect(sql2).To(gomega.Equal(sql1)) + gomega.Expect(args2).To(gomega.Equal(args1)) + }, + Entry("tag expression", Is{"genre": "Rock"}), + Entry("role expression", Contains{"artist": "Beatles"}), + Entry("nested criteria", Criteria{Expression: All{Is{"genre": "Rock"}, Contains{"artist": "Beatles"}}}), + ) + DescribeTable("JSON Marshaling", func(op Expression, jsonString string) { obj := And{op} diff --git a/model/datastore.go b/model/datastore.go index 4290e2134..94c3c3622 100644 --- a/model/datastore.go +++ b/model/datastore.go @@ -38,10 +38,12 @@ type DataStore interface { User(ctx context.Context) UserRepository UserProps(ctx context.Context) UserPropsRepository ScrobbleBuffer(ctx context.Context) ScrobbleBufferRepository + Scrobble(ctx context.Context) ScrobbleRepository + Plugin(ctx context.Context) PluginRepository - Resource(ctx context.Context, model interface{}) ResourceRepository + Resource(ctx context.Context, model any) ResourceRepository WithTx(block func(tx DataStore) error, scope ...string) error WithTxImmediate(block func(tx DataStore) error, scope ...string) error - GC(ctx context.Context) error + GC(ctx context.Context, libraryIDs ...int) error } diff --git a/model/folder.go b/model/folder.go index f715f8c11..7a769735e 100644 --- a/model/folder.go +++ b/model/folder.go @@ -85,7 +85,7 @@ type FolderRepository interface { GetByPath(lib Library, path string) (*Folder, error) GetAll(...QueryOptions) ([]Folder, error) CountAll(...QueryOptions) (int64, error) - GetLastUpdates(lib Library) (map[string]FolderUpdateInfo, error) + GetFolderUpdateInfo(lib Library, targetPaths ...string) (map[string]FolderUpdateInfo, error) Put(*Folder) error MarkMissing(missing bool, ids ...string) error GetTouchedWithPlaylists() (FolderCursor, error) diff --git a/model/get_entity.go b/model/get_entity.go index f51d8c36a..60972b2e9 100644 --- a/model/get_entity.go +++ b/model/get_entity.go @@ -5,7 +5,7 @@ import ( ) // TODO: Should the type be encoded in the ID? -func GetEntityByID(ctx context.Context, ds DataStore, id string) (interface{}, error) { +func GetEntityByID(ctx context.Context, ds DataStore, id string) (any, error) { ar, err := ds.Artist(ctx).Get(id) if err == nil { return ar, nil @@ -22,5 +22,9 @@ func GetEntityByID(ctx context.Context, ds DataStore, id string) (interface{}, e if err == nil { return mf, nil } + r, err := ds.Radio(ctx).Get(id) + if err == nil { + return r, nil + } return nil, err } diff --git a/model/id/id.go b/model/id/id.go index 930875260..b54542898 100644 --- a/model/id/id.go +++ b/model/id/id.go @@ -6,12 +6,12 @@ import ( "math/big" "strings" - gonanoid "github.com/matoous/go-nanoid/v2" "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/utils/nanoid" ) func NewRandom() string { - id, err := gonanoid.Generate("0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz", 22) + id, err := nanoid.Generate("0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz", 22) if err != nil { log.Error("Could not generate new ID", err) } diff --git a/model/image.go b/model/image.go new file mode 100644 index 000000000..68d8ae64c --- /dev/null +++ b/model/image.go @@ -0,0 +1,17 @@ +package model + +import ( + "path/filepath" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/consts" +) + +// UploadedImagePath returns the absolute filesystem path for a manually uploaded +// entity cover image. Returns empty string if filename is empty. +func UploadedImagePath(entityType, filename string) string { + if filename == "" { + return "" + } + return filepath.Join(conf.Server.DataFolder, consts.ArtworkFolder, entityType, filename) +} diff --git a/model/mediafile.go b/model/mediafile.go index 0ef26d746..ec83b76fd 100644 --- a/model/mediafile.go +++ b/model/mediafile.go @@ -38,7 +38,7 @@ type MediaFile struct { AlbumArtistID string `structs:"album_artist_id" json:"albumArtistId"` // Deprecated: Use Participants instead // AlbumArtist is the display name used for the album artist. AlbumArtist string `structs:"album_artist" json:"albumArtist"` - AlbumID string `structs:"album_id" json:"albumId"` + AlbumID string `structs:"album_id" json:"albumId" hash:"ignore"` HasCoverArt bool `structs:"has_cover_art" json:"hasCoverArt"` TrackNumber int `structs:"track_number" json:"trackNumber"` DiscNumber int `structs:"disc_number" json:"discNumber"` @@ -56,6 +56,8 @@ type MediaFile struct { SampleRate int `structs:"sample_rate" json:"sampleRate"` BitDepth int `structs:"bit_depth" json:"bitDepth"` Channels int `structs:"channels" json:"channels"` + Codec string `structs:"codec" json:"codec"` + ProbeData string `structs:"probe_data" json:"-" hash:"ignore"` Genre string `structs:"genre" json:"genre"` Genres Genres `structs:"-" json:"genres,omitempty"` SortTitle string `structs:"sort_title" json:"sortTitle,omitempty"` @@ -95,12 +97,19 @@ type MediaFile struct { } func (mf MediaFile) FullTitle() string { - if conf.Server.Subsonic.AppendSubtitle && mf.Tags[TagSubtitle] != nil { + if conf.Server.Subsonic.AppendSubtitle && len(mf.Tags[TagSubtitle]) > 0 { return fmt.Sprintf("%s (%s)", mf.Title, mf.Tags[TagSubtitle][0]) } return mf.Title } +func (mf MediaFile) FullAlbumName() string { + if conf.Server.Subsonic.AppendAlbumVersion && len(mf.Tags[TagAlbumVersion]) > 0 { + return fmt.Sprintf("%s (%s)", mf.Album, mf.Tags[TagAlbumVersion][0]) + } + return mf.Album +} + func (mf MediaFile) ContentType() string { return mime.TypeByExtension("." + mf.Suffix) } @@ -110,7 +119,16 @@ func (mf MediaFile) CoverArtID() ArtworkID { if mf.HasCoverArt && conf.Server.EnableMediaFileCoverArt { return artworkIDFromMediaFile(mf) } - // if it does not have a coverArt, fallback to the album cover + // Otherwise fallback to disc (if available) or album cover + return mf.DiscCoverArtID() +} + +// DiscCoverArtID returns the disc artwork ID when the media file has a disc number, +// otherwise it returns the album artwork ID. +func (mf MediaFile) DiscCoverArtID() ArtworkID { + if mf.DiscNumber > 0 { + return NewArtworkID(KindDiscArtwork, DiscArtworkID(mf.AlbumID, mf.DiscNumber), nil) + } return mf.AlbumCoverArtID() } @@ -140,7 +158,7 @@ func (mf MediaFile) Hash() string { } hash, _ := hashstructure.Hash(mf, opts) sum := md5.New() - sum.Write([]byte(fmt.Sprintf("%d", hash))) + sum.Write(fmt.Appendf(nil, "%d", hash)) sum.Write(mf.Tags.Hash()) sum.Write(mf.Participants.Hash()) return fmt.Sprintf("%x", sum.Sum(nil)) @@ -161,6 +179,63 @@ func (mf MediaFile) AbsolutePath() string { return filepath.Join(mf.LibraryPath, mf.Path) } +// AudioCodec returns the audio codec for this file. +// Uses the stored Codec field if available, otherwise infers from Suffix and audio properties. +func (mf MediaFile) AudioCodec() string { + // If we have a stored codec from scanning, normalize and return it + if mf.Codec != "" { + return strings.ToLower(mf.Codec) + } + // Fallback: infer from Suffix + BitDepth + return mf.inferCodecFromSuffix() +} + +// inferCodecFromSuffix infers the codec from the file extension when Codec field is empty. +func (mf MediaFile) inferCodecFromSuffix() string { + switch strings.ToLower(mf.Suffix) { + case "mp3", "mpga": + return "mp3" + case "mp2": + return "mp2" + case "ogg", "oga": + return "vorbis" + case "opus": + return "opus" + case "mpc": + return "mpc" + case "wma": + return "wma" + case "flac": + return "flac" + case "wav": + return "pcm" + case "aif", "aiff", "aifc": + return "pcm" + case "ape": + return "ape" + case "wv", "wvp": + return "wv" + case "tta": + return "tta" + case "tak": + return "tak" + case "shn": + return "shn" + case "dsf", "dff": + return "dsd" + case "m4a": + // AAC if BitDepth==0, ALAC if BitDepth>0 + if mf.BitDepth > 0 { + return "alac" + } + return "aac" + case "m4b", "m4p", "m4r": + return "aac" + default: + return "" + } +} + type MediaFiles []MediaFile // ToAlbum creates an Album object based on the attributes of this MediaFiles collection. @@ -353,11 +428,14 @@ type MediaFileCursor iter.Seq2[MediaFile, error] type MediaFileRepository interface { CountAll(options ...QueryOptions) (int64, error) + CountBySuffix(options ...QueryOptions) (map[string]int64, error) Exists(id string) (bool, error) Put(m *MediaFile) error + UpdateProbeData(id string, data string) error Get(id string) (*MediaFile, error) GetWithParticipants(id string) (*MediaFile, error) GetAll(options ...QueryOptions) (MediaFiles, error) + GetAllByTags(tag TagName, values []string, options ...QueryOptions) (MediaFiles, error) GetCursor(options ...QueryOptions) (MediaFileCursor, error) Delete(id string) error DeleteMissing(ids []string) error diff --git a/model/mediafile_test.go b/model/mediafile_test.go index 635a61d30..038ac93d5 100644 --- a/model/mediafile_test.go +++ b/model/mediafile_test.go @@ -475,20 +475,55 @@ var _ = Describe("MediaFile", func() { DeferCleanup(configtest.SetupConfig()) conf.Server.EnableMediaFileCoverArt = true }) - Describe(".CoverArtId()", func() { + DescribeTable("FullTitle", + func(enabled bool, tags Tags, expected string) { + conf.Server.Subsonic.AppendSubtitle = enabled + mf := MediaFile{Title: "Song", Tags: tags} + Expect(mf.FullTitle()).To(Equal(expected)) + }, + Entry("appends subtitle when enabled and tag is present", true, Tags{TagSubtitle: []string{"Live"}}, "Song (Live)"), + Entry("returns just title when disabled", false, Tags{TagSubtitle: []string{"Live"}}, "Song"), + Entry("returns just title when tag is absent", true, Tags{}, "Song"), + Entry("returns just title when tag is an empty slice", true, Tags{TagSubtitle: []string{}}, "Song"), + ) + DescribeTable("FullAlbumName", + func(enabled bool, tags Tags, expected string) { + conf.Server.Subsonic.AppendAlbumVersion = enabled + mf := MediaFile{Album: "Album", Tags: tags} + Expect(mf.FullAlbumName()).To(Equal(expected)) + }, + Entry("appends version when enabled and tag is present", true, Tags{TagAlbumVersion: []string{"Deluxe Edition"}}, "Album (Deluxe Edition)"), + Entry("returns just album name when disabled", false, Tags{TagAlbumVersion: []string{"Deluxe Edition"}}, "Album"), + Entry("returns just album name when tag is absent", true, Tags{}, "Album"), + Entry("returns just album name when tag is an empty slice", true, Tags{TagAlbumVersion: []string{}}, "Album"), + ) + Describe("CoverArtId", func() { It("returns its own id if it HasCoverArt", func() { mf := MediaFile{ID: "111", AlbumID: "1", HasCoverArt: true} id := mf.CoverArtID() Expect(id.Kind).To(Equal(KindMediaFileArtwork)) Expect(id.ID).To(Equal(mf.ID)) }) - It("returns its album id if HasCoverArt is false", func() { + It("returns disc art id if HasCoverArt is false and DiscNumber > 0", func() { + mf := MediaFile{ID: "111", AlbumID: "1", HasCoverArt: false, DiscNumber: 2} + id := mf.CoverArtID() + Expect(id.Kind).To(Equal(KindDiscArtwork)) + Expect(id.ID).To(Equal("1:2")) + }) + It("returns its album id if HasCoverArt is false and DiscNumber is 0", func() { mf := MediaFile{ID: "111", AlbumID: "1", HasCoverArt: false} id := mf.CoverArtID() Expect(id.Kind).To(Equal(KindAlbumArtwork)) Expect(id.ID).To(Equal(mf.AlbumID)) }) - It("returns its album id if EnableMediaFileCoverArt is disabled", func() { + It("returns disc art id if EnableMediaFileCoverArt is disabled and DiscNumber > 0", func() { + conf.Server.EnableMediaFileCoverArt = false + mf := MediaFile{ID: "111", AlbumID: "1", HasCoverArt: true, DiscNumber: 3} + id := mf.CoverArtID() + Expect(id.Kind).To(Equal(KindDiscArtwork)) + Expect(id.ID).To(Equal("1:3")) + }) + It("returns its album id if EnableMediaFileCoverArt is disabled and DiscNumber is 0", func() { conf.Server.EnableMediaFileCoverArt = false mf := MediaFile{ID: "111", AlbumID: "1", HasCoverArt: true} id := mf.CoverArtID() @@ -496,6 +531,58 @@ var _ = Describe("MediaFile", func() { Expect(id.ID).To(Equal(mf.AlbumID)) }) }) + + Describe("AudioCodec", func() { + It("returns normalized stored codec when available", func() { + mf := MediaFile{Codec: "AAC", Suffix: "m4a"} + Expect(mf.AudioCodec()).To(Equal("aac")) + }) + + It("returns stored codec lowercased", func() { + mf := MediaFile{Codec: "ALAC", Suffix: "m4a"} + Expect(mf.AudioCodec()).To(Equal("alac")) + }) + + DescribeTable("infers codec from suffix when Codec field is empty", + func(suffix string, bitDepth int, expected string) { + mf := MediaFile{Suffix: suffix, BitDepth: bitDepth} + Expect(mf.AudioCodec()).To(Equal(expected)) + }, + Entry("mp3", "mp3", 0, "mp3"), + Entry("mpga", "mpga", 0, "mp3"), + Entry("mp2", "mp2", 0, "mp2"), + Entry("ogg", "ogg", 0, "vorbis"), + Entry("oga", "oga", 0, "vorbis"), + Entry("opus", "opus", 0, "opus"), + Entry("mpc", "mpc", 0, "mpc"), + Entry("wma", "wma", 0, "wma"), + Entry("flac", "flac", 0, "flac"), + Entry("wav", "wav", 0, "pcm"), + Entry("aif", "aif", 0, "pcm"), + Entry("aiff", "aiff", 0, "pcm"), + Entry("aifc", "aifc", 0, "pcm"), + Entry("ape", "ape", 0, "ape"), + Entry("wv", "wv", 0, "wv"), + Entry("wvp", "wvp", 0, "wv"), + Entry("tta", "tta", 0, "tta"), + Entry("tak", "tak", 0, "tak"), + Entry("shn", "shn", 0, "shn"), + Entry("dsf", "dsf", 0, "dsd"), + Entry("dff", "dff", 0, "dsd"), + Entry("m4a with BitDepth=0 (AAC)", "m4a", 0, "aac"), + Entry("m4a with BitDepth>0 (ALAC)", "m4a", 16, "alac"), + Entry("m4b", "m4b", 0, "aac"), + Entry("m4p", "m4p", 0, "aac"), + Entry("m4r", "m4r", 0, "aac"), + Entry("unknown suffix", "xyz", 0, ""), + ) + + It("prefers stored codec over suffix inference", func() { + mf := MediaFile{Codec: "ALAC", Suffix: "m4a", BitDepth: 0} + Expect(mf.AudioCodec()).To(Equal("alac")) + }) + }) + }) func t(v string) time.Time { diff --git a/model/metadata/legacy_ids.go b/model/metadata/legacy_ids.go index 0a3bf0bf3..18a273550 100644 --- a/model/metadata/legacy_ids.go +++ b/model/metadata/legacy_ids.go @@ -23,7 +23,7 @@ func legacyTrackID(mf model.MediaFile, prependLibId bool) string { } func legacyAlbumID(mf model.MediaFile, md Metadata, prependLibId bool) string { - releaseDate := legacyReleaseDate(md) + _, _, releaseDate := md.mapDates() albumPath := strings.ToLower(fmt.Sprintf("%s\\%s", legacyMapAlbumArtistName(md), legacyMapAlbumName(md))) if !conf.Server.Scanner.GroupAlbumReleases { if len(releaseDate) != 0 { @@ -55,9 +55,3 @@ func legacyMapAlbumName(md Metadata) string { consts.UnknownAlbum, ) } - -// Keep the TaggedLikePicard logic for backwards compatibility -func legacyReleaseDate(md Metadata) string { - _, _, releaseDate := md.mapDates() - return string(releaseDate) -} diff --git a/model/metadata/legacy_ids_test.go b/model/metadata/legacy_ids_test.go deleted file mode 100644 index b6d096763..000000000 --- a/model/metadata/legacy_ids_test.go +++ /dev/null @@ -1,30 +0,0 @@ -package metadata - -import ( - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" -) - -var _ = Describe("legacyReleaseDate", func() { - - DescribeTable("legacyReleaseDate", - func(recordingDate, originalDate, releaseDate, expected string) { - md := New("", Info{ - Tags: map[string][]string{ - "DATE": {recordingDate}, - "ORIGINALDATE": {originalDate}, - "RELEASEDATE": {releaseDate}, - }, - }) - - result := legacyReleaseDate(md) - Expect(result).To(Equal(expected)) - }, - Entry("regular mapping", "2020-05-15", "2019-02-10", "2021-01-01", "2021-01-01"), - Entry("legacy mapping", "2020-05-15", "2019-02-10", "", "2020-05-15"), - Entry("legacy mapping, originalYear < year", "2018-05-15", "2019-02-10", "2021-01-01", "2021-01-01"), - Entry("legacy mapping, originalYear empty", "2020-05-15", "", "2021-01-01", "2021-01-01"), - Entry("legacy mapping, releaseYear", "2020-05-15", "2019-02-10", "2021-01-01", "2021-01-01"), - Entry("legacy mapping, same dates", "2020-05-15", "2020-05-15", "", "2020-05-15"), - ) -}) diff --git a/model/metadata/map_mediafile.go b/model/metadata/map_mediafile.go index c64e8c724..824cad7c2 100644 --- a/model/metadata/map_mediafile.go +++ b/model/metadata/map_mediafile.go @@ -65,6 +65,7 @@ func (md Metadata) ToMediaFile(libID int, folderID string) model.MediaFile { mf.SampleRate = md.AudioProperties().SampleRate mf.BitDepth = md.AudioProperties().BitDepth mf.Channels = md.AudioProperties().Channels + mf.Codec = md.AudioProperties().Codec mf.Path = md.FilePath() mf.Suffix = md.Suffix() mf.Size = md.Size() diff --git a/model/metadata/map_mediafile_test.go b/model/metadata/map_mediafile_test.go index ddda39bc2..e3adf3fae 100644 --- a/model/metadata/map_mediafile_test.go +++ b/model/metadata/map_mediafile_test.go @@ -75,6 +75,23 @@ var _ = Describe("ToMediaFile", func() { Expect(mf.OriginalYear).To(Equal(1966)) Expect(mf.ReleaseYear).To(Equal(2014)) }) + DescribeTable("legacyReleaseDate (TaggedLikePicard old behavior)", + func(recordingDate, originalDate, releaseDate, expected string) { + mf := toMediaFile(model.RawTags{ + "DATE": {recordingDate}, + "ORIGINALDATE": {originalDate}, + "RELEASEDATE": {releaseDate}, + }) + + Expect(mf.ReleaseDate).To(Equal(expected)) + }, + Entry("regular mapping", "2020-05-15", "2019-02-10", "2021-01-01", "2021-01-01"), + Entry("legacy mapping", "2020-05-15", "2019-02-10", "", "2020-05-15"), + Entry("legacy mapping, originalYear < year", "2018-05-15", "2019-02-10", "2021-01-01", "2021-01-01"), + Entry("legacy mapping, originalYear empty", "2020-05-15", "", "2021-01-01", "2021-01-01"), + Entry("legacy mapping, releaseYear", "2020-05-15", "2019-02-10", "2021-01-01", "2021-01-01"), + Entry("legacy mapping, same dates", "2020-05-15", "2020-05-15", "", "2020-05-15"), + ) }) Describe("Lyrics", func() { diff --git a/model/metadata/metadata.go b/model/metadata/metadata.go index 1372d0034..48928f989 100644 --- a/model/metadata/metadata.go +++ b/model/metadata/metadata.go @@ -35,6 +35,7 @@ type AudioProperties struct { BitDepth int SampleRate int Channels int + Codec string } type Date string @@ -250,7 +251,15 @@ func processPairMapping(name model.TagName, mapping model.TagConf, lowered model id3Base := parseID3Pairs(name, lowered) if len(aliasValues) > 0 { - id3Base = append(id3Base, parseVorbisPairs(aliasValues)...) + // For lyrics, don't use parseVorbisPairs as parentheses in lyrics content + // should not be interpreted as language keys (e.g. "(intro)" is not a language) + if name == model.TagLyrics { + for _, v := range aliasValues { + id3Base = append(id3Base, NewPair("xxx", v)) + } + } else { + id3Base = append(id3Base, parseVorbisPairs(aliasValues)...) + } } return id3Base } @@ -260,8 +269,8 @@ func parseID3Pairs(name model.TagName, lowered model.Tags) []string { prefix := string(name) + ":" for tagKey, tagValues := range lowered { keyStr := string(tagKey) - if strings.HasPrefix(keyStr, prefix) { - keyPart := strings.TrimPrefix(keyStr, prefix) + if after, ok := strings.CutPrefix(keyStr, prefix); ok { + keyPart := after if keyPart == string(name) { keyPart = "" } diff --git a/model/metadata/metadata_test.go b/model/metadata/metadata_test.go index 82afd8657..663e306c4 100644 --- a/model/metadata/metadata_test.go +++ b/model/metadata/metadata_test.go @@ -246,6 +246,18 @@ var _ = Describe("Metadata", func() { metadata.NewPair("eng", "Lyrics"), )) }) + + It("should preserve lyrics starting with parentheses from alias tags", func() { + props.Tags = model.RawTags{ + "LYRICS": {"(line one)\nline two\nline three"}, + } + md = metadata.New(filePath, props) + + Expect(md.All()).To(HaveKey(model.TagLyrics)) + Expect(md.Strings(model.TagLyrics)).To(ContainElements( + metadata.NewPair("xxx", "(line one)\nline two\nline three"), + )) + }) }) Describe("ReplayGain", func() { diff --git a/model/metadata/persistent_ids.go b/model/metadata/persistent_ids.go index b45882946..70dfe0532 100644 --- a/model/metadata/persistent_ids.go +++ b/model/metadata/persistent_ids.go @@ -8,6 +8,7 @@ import ( "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/id" "github.com/navidrome/navidrome/utils" @@ -26,10 +27,14 @@ type getPIDFunc = func(mf model.MediaFile, md Metadata, spec string, prependLibI func createGetPID(hash hashFunc) getPIDFunc { var getPID getPIDFunc - getAttr := func(mf model.MediaFile, md Metadata, attr string, prependLibId bool) string { + getAttr := func(mf model.MediaFile, md Metadata, attr string, prependLibId bool, spec string) string { attr = strings.TrimSpace(strings.ToLower(attr)) switch attr { case "albumid": + if spec == conf.Server.PID.Album { + log.Error("Recursive PID definition detected, ignoring `albumid`", "spec", spec) + return "" + } return getPID(mf, md, conf.Server.PID.Album, prependLibId) case "folder": return filepath.Dir(mf.Path) @@ -44,12 +49,12 @@ func createGetPID(hash hashFunc) getPIDFunc { } getPID = func(mf model.MediaFile, md Metadata, spec string, prependLibId bool) string { pid := "" - fields := strings.Split(spec, "|") - for _, field := range fields { + fields := strings.SplitSeq(spec, "|") + for field := range fields { attributes := strings.Split(field, ",") hasValue := false values := slice.Map(attributes, func(attr string) string { - v := getAttr(mf, md, attr, prependLibId) + v := getAttr(mf, md, attr, prependLibId, spec) if v != "" { hasValue = true } diff --git a/model/metadata/persistent_ids_test.go b/model/metadata/persistent_ids_test.go index 7ae0c91f7..9f1dacbd4 100644 --- a/model/metadata/persistent_ids_test.go +++ b/model/metadata/persistent_ids_test.go @@ -65,7 +65,7 @@ var _ = Describe("getPID", func() { Context("calculated attributes", func() { BeforeEach(func() { DeferCleanup(configtest.SetupConfig()) - conf.Server.PID.Album = "musicbrainz_albumid|albumartistid,album,version,releasedate" + conf.Server.PID.Album = "musicbrainz_albumid|albumartistid,album,albumversion,releasedate" }) When("field is title", func() { It("should return the pid", func() { @@ -88,13 +88,13 @@ var _ = Describe("getPID", func() { It("should return the pid", func() { spec := "albumid|title" md.tags = map[model.TagName][]string{ - "title": {"title"}, - "album": {"album name"}, - "version": {"version"}, - "releasedate": {"2021-01-01"}, + "title": {"title"}, + "album": {"album name"}, + "albumversion": {"deluxe edition"}, + "releasedate": {"2021-01-01"}, } mf.AlbumArtist = "Album Artist" - Expect(getPID(mf, md, spec, false)).To(Equal("(((album artist)\\album name\\version\\2021-01-01))")) + Expect(getPID(mf, md, spec, false)).To(Equal("(((album artist)\\album name\\deluxe edition\\2021-01-01))")) }) }) When("field is albumartistid", func() { @@ -114,6 +114,24 @@ var _ = Describe("getPID", func() { Expect(getPID(mf, md, spec, false)).To(Equal("(album name)")) }) }) + + When("albumid configuration refers to albumid recursively", func() { + It("should avoid infinite recursion", func() { + // Reproduce the issue from #4920 + conf.Server.PID.Album = "albumid,album,albumversion,releasedate" + spec := conf.Server.PID.Album + md.tags = map[model.TagName][]string{ + "album": {"Album Name"}, + "albumversion": {"Version"}, + "releasedate": {"2022"}, + } + // Should not panic and return a valid PID ignoring the recursive "albumid" + Expect(func() { + pid := getPID(mf, md, spec, false) + Expect(pid).To(Equal("(\\album name\\Version\\2022)")) + }).To(Not(Panic())) + }) + }) }) Context("edge cases", func() { diff --git a/model/playlist.go b/model/playlist.go index a87019ed5..e2f93993d 100644 --- a/model/playlist.go +++ b/model/playlist.go @@ -5,24 +5,27 @@ import ( "strconv" "time" + "github.com/navidrome/navidrome/consts" "github.com/navidrome/navidrome/model/criteria" ) type Playlist struct { - ID string `structs:"id" json:"id"` - Name string `structs:"name" json:"name"` - Comment string `structs:"comment" json:"comment"` - Duration float32 `structs:"duration" json:"duration"` - Size int64 `structs:"size" json:"size"` - SongCount int `structs:"song_count" json:"songCount"` - OwnerName string `structs:"-" json:"ownerName"` - OwnerID string `structs:"owner_id" json:"ownerId"` - Public bool `structs:"public" json:"public"` - Tracks PlaylistTracks `structs:"-" json:"tracks,omitempty"` - Path string `structs:"path" json:"path"` - Sync bool `structs:"sync" json:"sync"` - CreatedAt time.Time `structs:"created_at" json:"createdAt"` - UpdatedAt time.Time `structs:"updated_at" json:"updatedAt"` + ID string `structs:"id" json:"id"` + Name string `structs:"name" json:"name"` + Comment string `structs:"comment" json:"comment"` + Duration float32 `structs:"duration" json:"duration"` + Size int64 `structs:"size" json:"size"` + SongCount int `structs:"song_count" json:"songCount"` + OwnerName string `structs:"-" json:"ownerName"` + OwnerID string `structs:"owner_id" json:"ownerId"` + Public bool `structs:"public" json:"public"` + Tracks PlaylistTracks `structs:"-" json:"tracks,omitempty"` + Path string `structs:"path" json:"path"` + Sync bool `structs:"sync" json:"sync"` + UploadedImage string `structs:"uploaded_image" json:"uploadedImage"` + ExternalImageURL string `structs:"external_image_url" json:"externalImageUrl,omitempty"` + CreatedAt time.Time `structs:"created_at" json:"createdAt"` + UpdatedAt time.Time `structs:"updated_at" json:"updatedAt"` // SmartPlaylist attributes Rules *criteria.Criteria `structs:"rules" json:"rules"` @@ -106,6 +109,14 @@ func (pls Playlist) CoverArtID() ArtworkID { return artworkIDFromPlaylist(pls) } +// UploadedImagePath returns the absolute filesystem path for a manually uploaded +// playlist cover image. Returns empty string if no image has been uploaded. +// This does NOT cover sidecar images or external URLs — those are resolved +// by the artwork reader's fallback chain. +func (pls Playlist) UploadedImagePath() string { + return UploadedImagePath(consts.EntityPlaylist, pls.UploadedImage) +} + type Playlists []Playlist type PlaylistRepository interface { diff --git a/model/plugin.go b/model/plugin.go new file mode 100644 index 000000000..18d66e305 --- /dev/null +++ b/model/plugin.go @@ -0,0 +1,32 @@ +package model + +import "time" + +type Plugin struct { + ID string `structs:"id" json:"id"` + Path string `structs:"path" json:"path"` + Manifest string `structs:"manifest" json:"manifest"` + Config string `structs:"config" json:"config,omitempty"` + Users string `structs:"users" json:"users,omitempty"` + AllUsers bool `structs:"all_users" json:"allUsers,omitempty"` + Libraries string `structs:"libraries" json:"libraries,omitempty"` + AllLibraries bool `structs:"all_libraries" json:"allLibraries,omitempty"` + AllowWriteAccess bool `structs:"allow_write_access" json:"allowWriteAccess,omitempty"` + Enabled bool `structs:"enabled" json:"enabled"` + LastError string `structs:"last_error" json:"lastError,omitempty"` + SHA256 string `structs:"sha256" json:"sha256"` + CreatedAt time.Time `structs:"created_at" json:"createdAt"` + UpdatedAt time.Time `structs:"updated_at" json:"updatedAt"` +} + +type Plugins []Plugin + +type PluginRepository interface { + ResourceRepository + ClearErrors() error + CountAll(options ...QueryOptions) (int64, error) + Delete(id string) error + Get(id string) (*Plugin, error) + GetAll(options ...QueryOptions) (Plugins, error) + Put(p *Plugin) error +} diff --git a/model/radio.go b/model/radio.go index 567d32e44..86f27c24c 100644 --- a/model/radio.go +++ b/model/radio.go @@ -1,14 +1,27 @@ package model -import "time" +import ( + "time" + + "github.com/navidrome/navidrome/consts" +) type Radio struct { - ID string `structs:"id" json:"id"` - StreamUrl string `structs:"stream_url" json:"streamUrl"` - Name string `structs:"name" json:"name"` - HomePageUrl string `structs:"home_page_url" json:"homePageUrl"` - CreatedAt time.Time `structs:"created_at" json:"createdAt"` - UpdatedAt time.Time `structs:"updated_at" json:"updatedAt"` + ID string `structs:"id" json:"id"` + StreamUrl string `structs:"stream_url" json:"streamUrl"` + Name string `structs:"name" json:"name"` + HomePageUrl string `structs:"home_page_url" json:"homePageUrl"` + UploadedImage string `structs:"uploaded_image" json:"uploadedImage,omitempty"` + CreatedAt time.Time `structs:"created_at" json:"createdAt"` + UpdatedAt time.Time `structs:"updated_at" json:"updatedAt"` +} + +func (r Radio) CoverArtID() ArtworkID { + return artworkIDFromRadio(r) +} + +func (r Radio) UploadedImagePath() string { + return UploadedImagePath(consts.EntityRadio, r.UploadedImage) } type Radios []Radio @@ -19,5 +32,5 @@ type RadioRepository interface { Delete(id string) error Get(id string) (*Radio, error) GetAll(options ...QueryOptions) (Radios, error) - Put(u *Radio) error + Put(u *Radio, colsToUpdate ...string) error } diff --git a/model/radio_test.go b/model/radio_test.go new file mode 100644 index 000000000..dc421454e --- /dev/null +++ b/model/radio_test.go @@ -0,0 +1,42 @@ +package model_test + +import ( + "path/filepath" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Radio", func() { + Describe("CoverArtID", func() { + It("returns a radio artwork ID", func() { + now := time.Now() + r := model.Radio{ID: "rd-1", UpdatedAt: now} + artID := r.CoverArtID() + Expect(artID.Kind).To(Equal(model.KindRadioArtwork)) + Expect(artID.ID).To(Equal("rd-1")) + Expect(artID.LastUpdate).To(Equal(now)) + }) + }) + + Describe("UploadedImagePath", func() { + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.DataFolder = "/data" + }) + + It("returns empty string when no image uploaded", func() { + r := model.Radio{ID: "rd-1"} + Expect(r.UploadedImagePath()).To(BeEmpty()) + }) + + It("returns full path when image is set", func() { + r := model.Radio{ID: "rd-1", UploadedImage: "rd-1_test.jpg"} + Expect(r.UploadedImagePath()).To(Equal(filepath.Join("/data", "artwork", "radio", "rd-1_test.jpg"))) + }) + }) +}) diff --git a/model/scanner.go b/model/scanner.go new file mode 100644 index 000000000..54f81037c --- /dev/null +++ b/model/scanner.go @@ -0,0 +1,81 @@ +package model + +import ( + "context" + "fmt" + "strconv" + "strings" + "time" +) + +// ScanTarget represents a specific folder within a library to be scanned. +// NOTE: This struct is used as a map key, so it should only contain comparable types. +type ScanTarget struct { + LibraryID int + FolderPath string // Relative path within the library, or "" for entire library +} + +func (st ScanTarget) String() string { + return fmt.Sprintf("%d:%s", st.LibraryID, st.FolderPath) +} + +// ScannerStatus holds information about the current scan status +type ScannerStatus struct { + Scanning bool + LastScan time.Time + Count uint32 + FolderCount uint32 + LastError string + ScanType string + ElapsedTime time.Duration +} + +type Scanner interface { + // ScanAll starts a scan of all libraries. This is a blocking operation. + ScanAll(ctx context.Context, fullScan bool) (warnings []string, err error) + // ScanFolders scans specific library/folder pairs, recursing into subdirectories. + // If targets is nil, it scans all libraries. This is a blocking operation. + ScanFolders(ctx context.Context, fullScan bool, targets []ScanTarget) (warnings []string, err error) + Status(context.Context) (*ScannerStatus, error) +} + +// ParseTargets parses scan targets strings into ScanTarget structs. +// Example: []string{"1:Music/Rock", "2:Classical"} +func ParseTargets(libFolders []string) ([]ScanTarget, error) { + targets := make([]ScanTarget, 0, len(libFolders)) + + for _, part := range libFolders { + part = strings.TrimSpace(part) + if part == "" { + continue + } + + // Split by the first colon + before, after, ok := strings.Cut(part, ":") + if !ok { + return nil, fmt.Errorf("invalid target format: %q (expected libraryID:folderPath)", part) + } + + libIDStr := before + folderPath := after + + libID, err := strconv.Atoi(libIDStr) + if err != nil { + return nil, fmt.Errorf("invalid library ID %q: %w", libIDStr, err) + } + if libID <= 0 { + return nil, fmt.Errorf("invalid library ID %q", libIDStr) + } + + targets = append(targets, ScanTarget{ + LibraryID: libID, + FolderPath: folderPath, + }) + } + + if len(targets) == 0 { + return nil, fmt.Errorf("no valid targets found") + } + + return targets, nil +} diff --git a/model/scanner_test.go b/model/scanner_test.go new file mode 100644 index 000000000..8ca0c53fa --- /dev/null +++ b/model/scanner_test.go @@ -0,0 +1,89 @@ +package model_test + +import ( + "github.com/navidrome/navidrome/model" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("ParseTargets", func() { + It("parses multiple entries in slice", func() { + targets, err := model.ParseTargets([]string{"1:Music/Rock", "1:Music/Jazz", "2:Classical"}) + Expect(err).ToNot(HaveOccurred()) + Expect(targets).To(HaveLen(3)) + Expect(targets[0].LibraryID).To(Equal(1)) + Expect(targets[0].FolderPath).To(Equal("Music/Rock")) + Expect(targets[1].LibraryID).To(Equal(1)) + Expect(targets[1].FolderPath).To(Equal("Music/Jazz")) + Expect(targets[2].LibraryID).To(Equal(2)) + Expect(targets[2].FolderPath).To(Equal("Classical")) + }) + + It("handles empty folder paths", func() { + targets, err := model.ParseTargets([]string{"1:", "2:"}) + Expect(err).ToNot(HaveOccurred()) + Expect(targets).To(HaveLen(2)) + Expect(targets[0].FolderPath).To(Equal("")) + Expect(targets[1].FolderPath).To(Equal("")) + }) + + It("trims whitespace from entries", func() { + targets, err := model.ParseTargets([]string{" 1:Music/Rock", " 2:Classical "}) + Expect(err).ToNot(HaveOccurred()) + Expect(targets).To(HaveLen(2)) + Expect(targets[0].LibraryID).To(Equal(1)) + Expect(targets[0].FolderPath).To(Equal("Music/Rock")) + Expect(targets[1].LibraryID).To(Equal(2)) + Expect(targets[1].FolderPath).To(Equal("Classical")) + }) + + It("skips empty strings", func() { + targets, err := model.ParseTargets([]string{"1:Music/Rock", "", "2:Classical"}) + Expect(err).ToNot(HaveOccurred()) + Expect(targets).To(HaveLen(2)) + }) + + It("handles paths with colons", func() { + targets, err := model.ParseTargets([]string{"1:C:/Music/Rock", "2:/path:with:colons"}) + Expect(err).ToNot(HaveOccurred()) + Expect(targets).To(HaveLen(2)) + Expect(targets[0].FolderPath).To(Equal("C:/Music/Rock")) + Expect(targets[1].FolderPath).To(Equal("/path:with:colons")) + }) + + It("returns error for invalid format without colon", func() { + _, err := model.ParseTargets([]string{"1Music/Rock"}) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("invalid target format")) + }) + + It("returns error for non-numeric library ID", func() { + _, err := model.ParseTargets([]string{"abc:Music/Rock"}) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("invalid library ID")) + }) + + It("returns error for negative library ID", func() { + _, err := model.ParseTargets([]string{"-1:Music/Rock"}) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("invalid library ID")) + }) + + It("returns error for zero library ID", func() { + _, err := model.ParseTargets([]string{"0:Music/Rock"}) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("invalid library ID")) + }) + + It("returns error for empty input", func() { + _, err := model.ParseTargets([]string{}) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("no valid targets found")) + }) + + It("returns error for all empty strings", func() { + _, err := model.ParseTargets([]string{"", " ", ""}) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("no valid targets found")) + }) +}) diff --git a/model/scrobble.go b/model/scrobble.go new file mode 100644 index 000000000..e1567abc3 --- /dev/null +++ b/model/scrobble.go @@ -0,0 +1,13 @@ +package model + +import "time" + +type Scrobble struct { + MediaFileID string + UserID string + SubmissionTime time.Time +} + +type ScrobbleRepository interface { + RecordScrobble(mediaFileID string, submissionTime time.Time) error +} diff --git a/model/searchable.go b/model/searchable.go index 631a11726..a64a0171c 100644 --- a/model/searchable.go +++ b/model/searchable.go @@ -1,5 +1,5 @@ package model type SearchableRepository[T any] interface { - Search(q string, offset, size int, options ...QueryOptions) (T, error) + Search(q string, options ...QueryOptions) (T, error) } diff --git a/model/share.go b/model/share.go index acb5fb428..ce0846d60 100644 --- a/model/share.go +++ b/model/share.go @@ -22,8 +22,8 @@ type Share struct { Format string `structs:"format" json:"format,omitempty"` MaxBitRate int `structs:"max_bit_rate" json:"maxBitRate,omitempty"` VisitCount int `structs:"visit_count" json:"visitCount,omitempty"` - CreatedAt time.Time `structs:"created_at" json:"createdAt,omitempty"` - UpdatedAt time.Time `structs:"updated_at" json:"updatedAt,omitempty"` + CreatedAt time.Time `structs:"created_at" json:"createdAt"` + UpdatedAt time.Time `structs:"updated_at" json:"updatedAt"` Tracks MediaFiles `structs:"-" json:"tracks,omitempty"` Albums Albums `structs:"-" json:"albums,omitempty"` URL string `structs:"-" json:"-"` diff --git a/model/tag.go b/model/tag.go index 674f688ca..1f6b24d21 100644 --- a/model/tag.go +++ b/model/tag.go @@ -144,10 +144,8 @@ func (t Tags) Merge(tags Tags) { } func (t Tags) Add(name TagName, v string) { - for _, existing := range t[name] { - if existing == v { - return - } + if slices.Contains(t[name], v) { + return } t[name] = append(t[name], v) } diff --git a/model/user.go b/model/user.go index aabedc096..1c8541ccf 100644 --- a/model/user.go +++ b/model/user.go @@ -22,7 +22,7 @@ type User struct { Password string `structs:"-" json:"-"` // This is used to set or change a password when calling Put. If it is empty, the password is not changed. // It is received from the UI with the name "password" - NewPassword string `structs:"password,omitempty" json:"password,omitempty"` + NewPassword string `structs:"password,omitempty" json:"password,omitempty"` //nolint:gosec // If changing the password, this is also required CurrentPassword string `structs:"current_password,omitempty" json:"currentPassword,omitempty"` } @@ -42,8 +42,11 @@ func (u User) HasLibraryAccess(libraryID int) bool { type Users []User type UserRepository interface { + ResourceRepository CountAll(...QueryOptions) (int64, error) + Delete(id string) error Get(id string) (*User, error) + GetAll(options ...QueryOptions) (Users, error) Put(*User) error UpdateLastLoginAt(id string) error UpdateLastAccessAt(id string) error diff --git a/persistence/album_repository.go b/persistence/album_repository.go index 6f9bb3b48..c51a5beb1 100644 --- a/persistence/album_repository.go +++ b/persistence/album_repository.go @@ -4,6 +4,7 @@ import ( "context" "encoding/json" "fmt" + "iter" "maps" "slices" "strings" @@ -12,7 +13,6 @@ import ( . "github.com/Masterminds/squirrel" "github.com/deluan/rest" - "github.com/google/uuid" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" @@ -62,11 +62,14 @@ func (a *dbAlbum) PostScan() error { func (a *dbAlbum) PostMapArgs(args map[string]any) error { fullText := []string{a.Name, a.SortAlbumName, a.AlbumArtist} - fullText = append(fullText, a.Album.Participants.AllNames()...) + participantNames := a.Album.Participants.AllNames() + fullText = append(fullText, participantNames...) fullText = append(fullText, slices.Collect(maps.Values(a.Album.Discs))...) fullText = append(fullText, a.Album.Tags[model.TagAlbumVersion]...) fullText = append(fullText, a.Album.Tags[model.TagCatalogNumber]...) args["full_text"] = formatFullText(fullText...) + args["search_participants"] = strings.Join(participantNames, " ") + args["search_normalized"] = normalizeForFTS(a.Name, a.AlbumArtist) args["tags"] = marshalTags(a.Album.Tags) args["participants"] = marshalParticipants(a.Album.Participants) @@ -106,6 +109,7 @@ func NewAlbumRepository(ctx context.Context, db dbx.Builder) model.AlbumReposito "random": "random", "recently_added": recentlyAddedSort(), "starred_at": "starred, starred_at", + "rated_at": "rating, rated_at", }) return r } @@ -118,8 +122,8 @@ var albumFilters = sync.OnceValue(func() map[string]filterFunc { "artist_id": artistFilter, "year": yearFilter, "recently_played": recentlyPlayedFilter, - "starred": booleanFilter, - "has_rating": hasRatingFilter, + "starred": annotationBoolFilter("starred"), + "has_rating": annotationBoolFilter("rating"), "missing": booleanFilter, "genre_id": tagIDFilter, "role_total_id": allRolesFilter, @@ -139,20 +143,16 @@ var albumFilters = sync.OnceValue(func() map[string]filterFunc { func recentlyAddedSort() string { if conf.Server.RecentlyAddedByModTime { - return "updated_at" + return "datetime(album.updated_at)" } - return "created_at" + return "datetime(album.created_at)" } -func recentlyPlayedFilter(string, interface{}) Sqlizer { +func recentlyPlayedFilter(string, any) Sqlizer { return Gt{"play_count": 0} } -func hasRatingFilter(string, interface{}) Sqlizer { - return Gt{"rating": 0} -} - -func yearFilter(_ string, value interface{}) Sqlizer { +func yearFilter(_ string, value any) Sqlizer { return Or{ And{ Gt{"min_year": 0}, @@ -163,14 +163,14 @@ func yearFilter(_ string, value interface{}) Sqlizer { } } -func artistFilter(_ string, value interface{}) Sqlizer { +func artistFilter(_ string, value any) Sqlizer { return Or{ Exists("json_tree(participants, '$.albumartist')", Eq{"value": value}), Exists("json_tree(participants, '$.artist')", Eq{"value": value}), } } -func artistRoleFilter(name string, value interface{}) Sqlizer { +func artistRoleFilter(name string, value any) Sqlizer { roleName := strings.TrimSuffix(strings.TrimPrefix(name, "role_"), "_id") // Check if the role name is valid. If not, return an invalid filter @@ -180,7 +180,7 @@ func artistRoleFilter(name string, value interface{}) Sqlizer { return Exists(fmt.Sprintf("json_tree(participants, '$.%s')", roleName), Eq{"value": value}) } -func allRolesFilter(_ string, value interface{}) Sqlizer { +func allRolesFilter(_ string, value any) Sqlizer { return Like{"participants": fmt.Sprintf(`%%"%s"%%`, value)} } @@ -203,12 +203,11 @@ func (r *albumRepository) Put(al *model.Album) error { } al.ID = id if len(al.Participants) > 0 { - err = r.updateParticipants(al.ID, al.Participants) - if err != nil { + if err = r.updateParticipants(al.ID, al.Participants); err != nil { return err } } - return err + return nil } // TODO Move external metadata to a separated table @@ -242,7 +241,7 @@ func (r *albumRepository) GetAll(options ...model.QueryOptions) (model.Albums, e if err != nil { return nil, err } - return res.toModels(), err + return res.toModels(), nil } func (r *albumRepository) CopyAttributes(fromID, toID string, columns ...string) error { @@ -251,7 +250,7 @@ func (r *albumRepository) CopyAttributes(fromID, toID string, columns ...string) if err != nil { return fmt.Errorf("getting album to copy fields from: %w", err) } - to := make(map[string]interface{}) + to := make(map[string]any) for _, col := range columns { to[col] = from[col] } @@ -303,17 +302,21 @@ func (r *albumRepository) GetTouchedAlbums(libID int) (model.AlbumCursor, error) if err != nil { return nil, err } + return wrapAlbumCursor(cursor), nil +} + +func wrapAlbumCursor(cursor iter.Seq2[dbAlbum, error]) model.AlbumCursor { return func(yield func(model.Album, error) bool) { for a, err := range cursor { if a.Album == nil { - yield(model.Album{}, fmt.Errorf("unexpected nil album: %v", a)) + yield(model.Album{}, fmt.Errorf("unexpected nil album (%v): %w", a, err)) return } if !yield(*a.Album, err) || err != nil { return } } - }, nil + } } // RefreshPlayCounts updates the play count and last play date annotations for all albums, based @@ -337,8 +340,12 @@ on conflict (user_id, item_id, item_type) do update return r.executeSQL(query) } -func (r *albumRepository) purgeEmpty() error { +func (r *albumRepository) purgeEmpty(libraryIDs ...int) error { del := Delete(r.tableName).Where("id not in (select distinct(album_id) from media_file)") + // If libraryIDs are specified, only purge albums from those libraries + if len(libraryIDs) > 0 { + del = del.Where(Eq{"library_id": libraryIDs}) + } c, err := r.executeSQL(del) if err != nil { return fmt.Errorf("purging empty albums: %w", err) @@ -349,18 +356,21 @@ func (r *albumRepository) purgeEmpty() error { return nil } -func (r *albumRepository) Search(q string, offset int, size int, options ...model.QueryOptions) (model.Albums, error) { +var albumSearchConfig = searchConfig{ + NaturalOrder: "album.rowid", + OrderBy: []string{"name"}, + MBIDFields: []string{"mbz_album_id", "mbz_release_group_id"}, +} + +func (r *albumRepository) Search(q string, options ...model.QueryOptions) (model.Albums, error) { + var opts model.QueryOptions + if len(options) > 0 { + opts = options[0] + } var res dbAlbums - if uuid.Validate(q) == nil { - err := r.searchByMBID(r.selectAlbum(options...), q, []string{"mbz_album_id", "mbz_release_group_id"}, &res) - if err != nil { - return nil, fmt.Errorf("searching album by MBID %q: %w", q, err) - } - } else { - err := r.doSearch(r.selectAlbum(options...), q, offset, size, &res, "album.rowid", "name") - if err != nil { - return nil, fmt.Errorf("searching album by query %q: %w", q, err) - } + err := r.doSearch(r.selectAlbum(options...), q, &res, albumSearchConfig, opts) + if err != nil { + return nil, fmt.Errorf("searching album %q: %w", q, err) } return res.toModels(), nil } @@ -369,11 +379,11 @@ func (r *albumRepository) Count(options ...rest.QueryOptions) (int64, error) { return r.CountAll(r.parseRestOptions(r.ctx, options...)) } -func (r *albumRepository) Read(id string) (interface{}, error) { +func (r *albumRepository) Read(id string) (any, error) { return r.Get(id) } -func (r *albumRepository) ReadAll(options ...rest.QueryOptions) (interface{}, error) { +func (r *albumRepository) ReadAll(options ...rest.QueryOptions) (any, error) { return r.GetAll(r.parseRestOptions(r.ctx, options...)) } @@ -381,7 +391,7 @@ func (r *albumRepository) EntityName() string { return "album" } -func (r *albumRepository) NewInstance() interface{} { +func (r *albumRepository) NewInstance() any { return &model.Album{} } diff --git a/persistence/album_repository_test.go b/persistence/album_repository_test.go index 4be89bcb8..2792cec97 100644 --- a/persistence/album_repository_test.go +++ b/persistence/album_repository_test.go @@ -1,10 +1,12 @@ package persistence import ( + "errors" "fmt" "time" "github.com/Masterminds/squirrel" + "github.com/deluan/rest" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/consts" "github.com/navidrome/navidrome/model" @@ -55,15 +57,23 @@ var _ = Describe("AlbumRepository", func() { It("returns all records sorted", func() { Expect(GetAll(model.QueryOptions{Sort: "name"})).To(Equal(model.Albums{ albumAbbeyRoad, + albumWithVersion, + albumCJK, + albumMultiDisc, albumRadioactivity, albumSgtPeppers, + albumPunctuation, })) }) It("returns all records sorted desc", func() { Expect(GetAll(model.QueryOptions{Sort: "name", Order: "desc"})).To(Equal(model.Albums{ + albumPunctuation, albumSgtPeppers, albumRadioactivity, + albumMultiDisc, + albumCJK, + albumWithVersion, albumAbbeyRoad, })) }) @@ -75,6 +85,129 @@ var _ = Describe("AlbumRepository", func() { }) }) + Describe("recently_added sort", func() { + It("sorts correctly regardless of timestamp format (T-format vs space-format)", func() { + // Both timestamps share the same date prefix "2024-01-15" so the T vs space + // character at position 10 determines sort order in raw string comparison. + // Without normalization, 'T' (ASCII 84) > ' ' (ASCII 32) makes the older + // T-format timestamp sort AFTER the newer space-format one. + + // Older album: morning of Jan 15, stored in T-format + olderAlbum := &model.Album{LibraryID: 1, ID: "ts-older", Name: "Older Album"} + Expect(albumRepo.Put(olderAlbum)).To(Succeed()) + _, err := albumRepo.executeSQL(squirrel.Update("album"). + Set("created_at", "2024-01-15T08:00:00Z"). + Where(squirrel.Eq{"id": "ts-older"})) + Expect(err).ToNot(HaveOccurred()) + + // Newer album: evening of Jan 15, stored in space-format + newerAlbum := &model.Album{LibraryID: 1, ID: "ts-newer", Name: "Newer Album"} + Expect(albumRepo.Put(newerAlbum)).To(Succeed()) + _, err = albumRepo.executeSQL(squirrel.Update("album"). + Set("created_at", "2024-01-15 20:00:00+00:00"). + Where(squirrel.Eq{"id": "ts-newer"})) + Expect(err).ToNot(HaveOccurred()) + + albums, err := albumRepo.GetAll(model.QueryOptions{Sort: "recently_added", Order: "desc"}) + Expect(err).ToNot(HaveOccurred()) + + // Find positions of our test albums + olderIdx, newerIdx := -1, -1 + for i, a := range albums { + switch a.ID { + case "ts-older": + olderIdx = i + case "ts-newer": + newerIdx = i + } + } + Expect(olderIdx).To(BeNumerically(">=", 0), "older album not found in results") + Expect(newerIdx).To(BeNumerically(">=", 0), "newer album not found in results") + // Newer album (evening, space-format) should come before older album (morning, T-format) in desc order + Expect(newerIdx).To(BeNumerically("<", olderIdx), + "Newer album (20:00 space-format) should sort before older album (08:00 T-format) in desc order") + + // Clean up + _, _ = albumRepo.executeSQL(squirrel.Delete("album").Where(squirrel.Eq{"id": []string{"ts-older", "ts-newer"}})) + }) + }) + + Context("Filters", func() { + var albumWithoutAnnotation model.Album + + BeforeEach(func() { + // Create album without any annotation (no star, no rating) + albumWithoutAnnotation = model.Album{ID: "no-annotation-album", Name: "No Annotation", LibraryID: 1} + Expect(albumRepo.Put(&albumWithoutAnnotation)).To(Succeed()) + }) + + AfterEach(func() { + _, _ = albumRepo.executeSQL(squirrel.Delete("album").Where(squirrel.Eq{"id": albumWithoutAnnotation.ID})) + }) + + Describe("starred", func() { + It("false includes items without annotations", func() { + res, err := albumRepo.ReadAll(rest.QueryOptions{ + Filters: map[string]any{"starred": "false"}, + }) + Expect(err).ToNot(HaveOccurred()) + albums := res.(model.Albums) + + var found bool + for _, a := range albums { + if a.ID == albumWithoutAnnotation.ID { + found = true + break + } + } + Expect(found).To(BeTrue(), "Album without annotation should be included in starred=false filter") + }) + + It("true excludes items without annotations", func() { + res, err := albumRepo.ReadAll(rest.QueryOptions{ + Filters: map[string]any{"starred": "true"}, + }) + Expect(err).ToNot(HaveOccurred()) + albums := res.(model.Albums) + + for _, a := range albums { + Expect(a.ID).ToNot(Equal(albumWithoutAnnotation.ID)) + } + }) + }) + + Describe("has_rating", func() { + It("false includes items without annotations", func() { + res, err := albumRepo.ReadAll(rest.QueryOptions{ + Filters: map[string]any{"has_rating": "false"}, + }) + Expect(err).ToNot(HaveOccurred()) + albums := res.(model.Albums) + + var found bool + for _, a := range albums { + if a.ID == albumWithoutAnnotation.ID { + found = true + break + } + } + Expect(found).To(BeTrue(), "Album without annotation should be included in has_rating=false filter") + }) + + It("true excludes items without annotations", func() { + res, err := albumRepo.ReadAll(rest.QueryOptions{ + Filters: map[string]any{"has_rating": "true"}, + }) + Expect(err).ToNot(HaveOccurred()) + albums := res.(model.Albums) + + for _, a := range albums { + Expect(a.ID).ToNot(Equal(albumWithoutAnnotation.ID)) + } + }) + }) + }) + Describe("Album.PlayCount", func() { // Implementation is in withAnnotation() method DescribeTable("normalizes play count when AlbumPlayCountMode is absolute", @@ -83,7 +216,7 @@ var _ = Describe("AlbumRepository", func() { newID := id.NewRandom() Expect(albumRepo.Put(&model.Album{LibraryID: 1, ID: newID, Name: "name", SongCount: songCount})).To(Succeed()) - for i := 0; i < playCount; i++ { + for range playCount { Expect(albumRepo.IncPlayCount(newID, time.Now())).To(Succeed()) } @@ -106,7 +239,7 @@ var _ = Describe("AlbumRepository", func() { newID := id.NewRandom() Expect(albumRepo.Put(&model.Album{LibraryID: 1, ID: newID, Name: "name", SongCount: songCount})).To(Succeed()) - for i := 0; i < playCount; i++ { + for range playCount { Expect(albumRepo.IncPlayCount(newID, time.Now())).To(Succeed()) } @@ -124,6 +257,89 @@ var _ = Describe("AlbumRepository", func() { ) }) + Describe("Album.AverageRating", func() { + It("returns 0 when no ratings exist", func() { + newID := id.NewRandom() + Expect(albumRepo.Put(&model.Album{LibraryID: 1, ID: newID, Name: "no ratings album"})).To(Succeed()) + + album, err := albumRepo.Get(newID) + Expect(err).ToNot(HaveOccurred()) + Expect(album.AverageRating).To(Equal(0.0)) + + _, _ = albumRepo.executeSQL(squirrel.Delete("album").Where(squirrel.Eq{"id": newID})) + }) + + It("returns the user's rating as average when only one user rated", func() { + newID := id.NewRandom() + Expect(albumRepo.Put(&model.Album{LibraryID: 1, ID: newID, Name: "single rating album"})).To(Succeed()) + Expect(albumRepo.SetRating(4, newID)).To(Succeed()) + + album, err := albumRepo.Get(newID) + Expect(err).ToNot(HaveOccurred()) + Expect(album.AverageRating).To(Equal(4.0)) + + _, _ = albumRepo.executeSQL(squirrel.Delete("annotation").Where(squirrel.Eq{"item_id": newID})) + _, _ = albumRepo.executeSQL(squirrel.Delete("album").Where(squirrel.Eq{"id": newID})) + }) + + It("calculates average across multiple users", func() { + newID := id.NewRandom() + Expect(albumRepo.Put(&model.Album{LibraryID: 1, ID: newID, Name: "multi rating album"})).To(Succeed()) + + Expect(albumRepo.SetRating(4, newID)).To(Succeed()) + + user2Ctx := request.WithUser(GinkgoT().Context(), regularUser) + user2Repo := NewAlbumRepository(user2Ctx, GetDBXBuilder()).(*albumRepository) + Expect(user2Repo.SetRating(5, newID)).To(Succeed()) + + album, err := albumRepo.Get(newID) + Expect(err).ToNot(HaveOccurred()) + Expect(album.AverageRating).To(Equal(4.5)) + + _, _ = albumRepo.executeSQL(squirrel.Delete("annotation").Where(squirrel.Eq{"item_id": newID})) + _, _ = albumRepo.executeSQL(squirrel.Delete("album").Where(squirrel.Eq{"id": newID})) + }) + + It("excludes zero ratings from average calculation", func() { + newID := id.NewRandom() + Expect(albumRepo.Put(&model.Album{LibraryID: 1, ID: newID, Name: "zero rating excluded album"})).To(Succeed()) + Expect(albumRepo.SetRating(3, newID)).To(Succeed()) + + user2Ctx := request.WithUser(GinkgoT().Context(), regularUser) + user2Repo := NewAlbumRepository(user2Ctx, GetDBXBuilder()).(*albumRepository) + Expect(user2Repo.SetRating(0, newID)).To(Succeed()) + + album, err := albumRepo.Get(newID) + Expect(err).ToNot(HaveOccurred()) + Expect(album.AverageRating).To(Equal(3.0)) + + _, _ = albumRepo.executeSQL(squirrel.Delete("annotation").Where(squirrel.Eq{"item_id": newID})) + _, _ = albumRepo.executeSQL(squirrel.Delete("album").Where(squirrel.Eq{"id": newID})) + }) + + It("rounds to 2 decimal places", func() { + newID := id.NewRandom() + Expect(albumRepo.Put(&model.Album{LibraryID: 1, ID: newID, Name: "rounding test album"})).To(Succeed()) + + Expect(albumRepo.SetRating(5, newID)).To(Succeed()) + + user2Ctx := request.WithUser(GinkgoT().Context(), regularUser) + user2Repo := NewAlbumRepository(user2Ctx, GetDBXBuilder()).(*albumRepository) + Expect(user2Repo.SetRating(4, newID)).To(Succeed()) + + user3Ctx := request.WithUser(GinkgoT().Context(), thirdUser) + user3Repo := NewAlbumRepository(user3Ctx, GetDBXBuilder()).(*albumRepository) + Expect(user3Repo.SetRating(4, newID)).To(Succeed()) + + album, err := albumRepo.Get(newID) + Expect(err).ToNot(HaveOccurred()) + Expect(album.AverageRating).To(Equal(4.33)) // (5 + 4 + 4) / 3 = 4.333... + + _, _ = albumRepo.executeSQL(squirrel.Delete("annotation").Where(squirrel.Eq{"item_id": newID})) + _, _ = albumRepo.executeSQL(squirrel.Delete("album").Where(squirrel.Eq{"id": newID})) + }) + }) + Describe("dbAlbum mapping", func() { var ( a model.Album @@ -244,7 +460,7 @@ var _ = Describe("AlbumRepository", func() { sql, args, err := sqlizer.ToSql() Expect(err).ToNot(HaveOccurred()) Expect(sql).To(Equal(expectedSQL)) - Expect(args).To(Equal([]interface{}{artistID})) + Expect(args).To(Equal([]any{artistID})) }, Entry("artist role", "role_artist_id", "123", "exists (select 1 from json_tree(participants, '$.artist') where value = ?)"), @@ -266,7 +482,7 @@ var _ = Describe("AlbumRepository", func() { sql, args, err := sqlizer.ToSql() Expect(err).ToNot(HaveOccurred()) Expect(sql).To(Equal(fmt.Sprintf("exists (select 1 from json_tree(participants, '$.%s') where value = ?)", roleName))) - Expect(args).To(Equal([]interface{}{"test-id"})) + Expect(args).To(Equal([]any{"test-id"})) } }) @@ -510,6 +726,110 @@ var _ = Describe("AlbumRepository", func() { // Clean up the test album created for this test _, _ = albumRepo.executeSQL(squirrel.Delete("album").Where(squirrel.Eq{"id": album.ID})) }) + + It("removes stale role associations when artist role changes", func() { + // Regression test for issue #4242: Composers displayed in albumartist list + // This happens when an artist's role changes (e.g., was both albumartist and composer, + // now only composer) and the old role association isn't properly removed. + + // Create an artist that will have changing roles + artist := &model.Artist{ + ID: "role-change-artist-1", + Name: "Role Change Artist", + OrderArtistName: "role change artist", + } + err := createArtistWithLibrary(artistRepo, artist, 1) + Expect(err).ToNot(HaveOccurred()) + + // Create album with artist as both albumartist and composer + album := &model.Album{ + LibraryID: 1, + ID: "test-album-role-change", + Name: "Test Album Role Change", + AlbumArtistID: "role-change-artist-1", + AlbumArtist: "Role Change Artist", + Participants: model.Participants{ + model.RoleAlbumArtist: { + {Artist: model.Artist{ID: "role-change-artist-1", Name: "Role Change Artist"}}, + }, + model.RoleComposer: { + {Artist: model.Artist{ID: "role-change-artist-1", Name: "Role Change Artist"}}, + }, + }, + } + + err = albumRepo.Put(album) + Expect(err).ToNot(HaveOccurred()) + + // Verify initial state: artist has both albumartist and composer roles + expected := []albumArtistRecord{ + {ArtistID: "role-change-artist-1", Role: "albumartist", SubRole: ""}, + {ArtistID: "role-change-artist-1", Role: "composer", SubRole: ""}, + } + verifyAlbumArtists(album.ID, expected) + + // Now update album so artist is ONLY a composer (remove albumartist role) + album.Participants = model.Participants{ + model.RoleComposer: { + {Artist: model.Artist{ID: "role-change-artist-1", Name: "Role Change Artist"}}, + }, + } + + err = albumRepo.Put(album) + Expect(err).ToNot(HaveOccurred()) + + // Verify that the albumartist role was removed - only composer should remain + // This is the key test: before the fix, the albumartist role would remain + // causing composers to appear in the albumartist filter + expectedAfter := []albumArtistRecord{ + {ArtistID: "role-change-artist-1", Role: "composer", SubRole: ""}, + } + verifyAlbumArtists(album.ID, expectedAfter) + + // Clean up + _, _ = artistRepo.executeSQL(squirrel.Delete("artist").Where(squirrel.Eq{"id": artist.ID})) + _, _ = albumRepo.executeSQL(squirrel.Delete("album").Where(squirrel.Eq{"id": album.ID})) + }) + }) + + Describe("wrapAlbumCursor", func() { + It("does not panic when the cursor yields a dbAlbum with nil Album", func() { + // Simulate what queryWithStableResults does on the rows.Err() path: + // it yields a zero-value dbAlbum (where Album is nil) with an error. + dbErr := fmt.Errorf("database is locked") + cursor := func(yield func(dbAlbum, error) bool) { + var empty dbAlbum // Album pointer is nil + yield(empty, dbErr) + } + + // wrapAlbumCursor should handle the nil Album without panicking + wrappedCursor := wrapAlbumCursor(cursor) + var gotErr error + Expect(func() { + for _, err := range wrappedCursor { + gotErr = err + } + }).ToNot(Panic()) + Expect(gotErr).To(HaveOccurred()) + Expect(gotErr.Error()).To(ContainSubstring("unexpected nil album")) + Expect(errors.Is(gotErr, dbErr)).To(BeTrue(), "should wrap the original cursor error") + }) + + It("yields albums from a valid cursor", func() { + album := &model.Album{ID: "a1", Name: "Test"} + cursor := func(yield func(dbAlbum, error) bool) { + yield(dbAlbum{Album: album}, nil) + } + + wrappedCursor := wrapAlbumCursor(cursor) + var albums []model.Album + for a, err := range wrappedCursor { + Expect(err).ToNot(HaveOccurred()) + albums = append(albums, a) + } + Expect(albums).To(HaveLen(1)) + Expect(albums[0].ID).To(Equal("a1")) + }) }) }) diff --git a/persistence/artist_repository.go b/persistence/artist_repository.go index a7cf9272a..e75a0e58c 100644 --- a/persistence/artist_repository.go +++ b/persistence/artist_repository.go @@ -4,15 +4,17 @@ import ( "cmp" "context" "encoding/json" + "errors" "fmt" + "os" "slices" "strings" "time" . "github.com/Masterminds/squirrel" "github.com/deluan/rest" - "github.com/google/uuid" "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/consts" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/utils" @@ -102,6 +104,7 @@ func (a *dbArtist) PostMapArgs(m map[string]any) error { similarArtists, _ := json.Marshal(sa) m["similar_artists"] = string(similarArtists) m["full_text"] = formatFullText(a.Name, a.SortArtistName) + m["search_normalized"] = normalizeForFTS(a.Name) // Do not override the sort_artist_name and mbz_artist_id fields if they are empty // TODO: Better way to handle this? @@ -133,14 +136,16 @@ func NewArtistRepository(ctx context.Context, db dbx.Builder) model.ArtistReposi r.registerModel(&model.Artist{}, map[string]filterFunc{ "id": idFilter(r.tableName), "name": fullTextFilter(r.tableName, "mbz_artist_id"), - "starred": booleanFilter, + "starred": annotationBoolFilter("starred"), + "has_rating": annotationBoolFilter("rating"), "role": roleFilter, "missing": booleanFilter, "library_id": artistLibraryIdFilter, }) - r.setSortMappings(map[string]string{ + r.setSortMappings(map[string]string{ //nolint:gosec "name": "order_artist_name", "starred_at": "starred, starred_at", + "rated_at": "rating, rated_at", "song_count": "stats->>'total'->>'m'", "album_count": "stats->>'total'->>'a'", "size": "stats->>'total'->>'s'", @@ -163,7 +168,7 @@ func roleFilter(_ string, role any) Sqlizer { } // artistLibraryIdFilter filters artists based on library access through the library_artist table -func artistLibraryIdFilter(_ string, value interface{}) Sqlizer { +func artistLibraryIdFilter(_ string, value any) Sqlizer { return Eq{"library_artist.library_id": value} } @@ -313,7 +318,19 @@ func (r *artistRepository) GetIndex(includeMissing bool, libraryIds []int, roles } func (r *artistRepository) purgeEmpty() error { - del := Delete(r.tableName).Where("id not in (select artist_id from album_artists)") + orphanFilter := "id not in (select artist_id from album_artists)" + + // Collect uploaded image filenames before deleting + sel := Select("uploaded_image").From(r.tableName). + Where(orphanFilter). + Where("uploaded_image != ''") + var imageFiles []string + if err := r.queryAllSlice(sel, &imageFiles); err != nil && !errors.Is(err, model.ErrNotFound) { + return fmt.Errorf("collecting artist images for cleanup: %w", err) + } + + // Delete orphan artists + del := Delete(r.tableName).Where(orphanFilter) c, err := r.executeSQL(del) if err != nil { return fmt.Errorf("purging empty artists: %w", err) @@ -321,6 +338,19 @@ func (r *artistRepository) purgeEmpty() error { if c > 0 { log.Debug(r.ctx, "Purged empty artists", "totalDeleted", c) } + + if len(imageFiles) == 0 { + return nil + } + + // Best-effort cleanup of uploaded image files + log.Debug(r.ctx, "Cleaning up artist images", "totalImages", len(imageFiles)) + for _, filename := range imageFiles { + path := model.UploadedImagePath(consts.EntityArtist, filename) + if err := os.Remove(path); err != nil && !os.IsNotExist(err) { + log.Warn(r.ctx, "Failed to remove artist image during GC", "path", path, err) + } + } return nil } @@ -400,23 +430,16 @@ func (r *artistRepository) RefreshStats(allArtists bool) (int64, error) { // This now calculates per-library statistics and stores them in library_artist.stats batchUpdateStatsSQL := ` WITH artist_role_counters AS ( - SELECT jt.atom AS artist_id, + SELECT mfa.artist_id, mf.library_id, - substr( - replace(jt.path, '$.', ''), - 1, - CASE WHEN instr(replace(jt.path, '$.', ''), '[') > 0 - THEN instr(replace(jt.path, '$.', ''), '[') - 1 - ELSE length(replace(jt.path, '$.', '')) - END - ) AS role, + mfa.role, count(DISTINCT mf.album_id) AS album_count, - count(mf.id) AS count, + count(DISTINCT mf.id) AS count, sum(mf.size) AS size - FROM media_file mf - JOIN json_tree(mf.participants) jt ON jt.key = 'id' AND jt.atom IS NOT NULL - WHERE jt.atom IN (ROLE_IDS_PLACEHOLDER) -- Will replace with actual placeholders - GROUP BY jt.atom, mf.library_id, role + FROM media_file_artists mfa + JOIN media_file mf ON mfa.media_file_id = mf.id + WHERE mfa.artist_id IN (ROLE_IDS_PLACEHOLDER) -- Will replace with actual placeholders + GROUP BY mfa.artist_id, mf.library_id, mfa.role ), artist_total_counters AS ( SELECT mfa.artist_id, @@ -445,24 +468,24 @@ func (r *artistRepository) RefreshStats(allArtists bool) (int64, error) { ), combined_counters AS ( SELECT artist_id, library_id, role, album_count, count, size FROM artist_role_counters - UNION + UNION ALL SELECT artist_id, library_id, role, album_count, count, size FROM artist_total_counters - UNION + UNION ALL SELECT artist_id, library_id, role, album_count, count, size FROM artist_participant_counter ), library_artist_counters AS ( SELECT artist_id, library_id, json_group_object( - replace(role, '"', ''), + role, json_object('a', album_count, 'm', count, 's', size) ) AS counters FROM combined_counters GROUP BY artist_id, library_id ) UPDATE library_artist - SET stats = coalesce((SELECT counters FROM library_artist_counters lac - WHERE lac.artist_id = library_artist.artist_id + SET stats = coalesce((SELECT counters FROM library_artist_counters lac + WHERE lac.artist_id = library_artist.artist_id AND lac.library_id = library_artist.library_id), '{}') WHERE library_artist.artist_id IN (ROLE_IDS_PLACEHOLDER);` // Will replace with actual placeholders @@ -518,20 +541,25 @@ func (r *artistRepository) RefreshStats(allArtists bool) (int64, error) { return totalRowsAffected, nil } -func (r *artistRepository) Search(q string, offset int, size int, options ...model.QueryOptions) (model.Artists, error) { - var res dbArtists - if uuid.Validate(q) == nil { - err := r.searchByMBID(r.selectArtist(options...), q, []string{"mbz_artist_id"}, &res) - if err != nil { - return nil, fmt.Errorf("searching artist by MBID %q: %w", q, err) - } - } else { +func (r *artistRepository) searchCfg() searchConfig { + return searchConfig{ // Natural order for artists is more performant by ID, due to GROUP BY clause in selectArtist - err := r.doSearch(r.selectArtist(options...), q, offset, size, &res, "artist.id", - "sum(json_extract(stats, '$.total.m')) desc", "name") - if err != nil { - return nil, fmt.Errorf("searching artist by query %q: %w", q, err) - } + NaturalOrder: "artist.id", + OrderBy: []string{"sum(json_extract(stats, '$.total.m')) desc", "name"}, + MBIDFields: []string{"mbz_artist_id"}, + LibraryFilter: r.applyLibraryFilterToArtistQuery, + } +} + +func (r *artistRepository) Search(q string, options ...model.QueryOptions) (model.Artists, error) { + var opts model.QueryOptions + if len(options) > 0 { + opts = options[0] + } + var res dbArtists + err := r.doSearch(r.selectArtist(options...), q, &res, r.searchCfg(), opts) + if err != nil { + return nil, fmt.Errorf("searching artist %q: %w", q, err) } return res.toModels(), nil } @@ -540,11 +568,11 @@ func (r *artistRepository) Count(options ...rest.QueryOptions) (int64, error) { return r.CountAll(r.parseRestOptions(r.ctx, options...)) } -func (r *artistRepository) Read(id string) (interface{}, error) { +func (r *artistRepository) Read(id string) (any, error) { return r.Get(id) } -func (r *artistRepository) ReadAll(options ...rest.QueryOptions) (interface{}, error) { +func (r *artistRepository) ReadAll(options ...rest.QueryOptions) (any, error) { role := "total" if len(options) > 0 { if v, ok := options[0].Filters["role"].(string); ok { @@ -561,7 +589,7 @@ func (r *artistRepository) EntityName() string { return "artist" } -func (r *artistRepository) NewInstance() interface{} { +func (r *artistRepository) NewInstance() any { return &model.Artist{} } diff --git a/persistence/artist_repository_test.go b/persistence/artist_repository_test.go index dfaf499ac..e2904466c 100644 --- a/persistence/artist_repository_test.go +++ b/persistence/artist_repository_test.go @@ -3,10 +3,14 @@ package persistence import ( "context" "encoding/json" + "os" + "path/filepath" "github.com/Masterminds/squirrel" + "github.com/deluan/rest" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/consts" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/request" "github.com/navidrome/navidrome/utils" @@ -192,7 +196,7 @@ var _ = Describe("ArtistRepository", func() { Describe("Basic Operations", func() { Describe("Count", func() { It("returns the number of artists in the DB", func() { - Expect(repo.CountAll()).To(Equal(int64(2))) + Expect(repo.CountAll()).To(Equal(int64(4))) }) }) @@ -227,13 +231,19 @@ var _ = Describe("ArtistRepository", func() { idx, err := repo.GetIndex(false, []int{1}) Expect(err).ToNot(HaveOccurred()) - Expect(idx).To(HaveLen(2)) + Expect(idx).To(HaveLen(4)) Expect(idx[0].ID).To(Equal("F")) Expect(idx[0].Artists).To(HaveLen(1)) Expect(idx[0].Artists[0].Name).To(Equal(artistBeatles.Name)) Expect(idx[1].ID).To(Equal("K")) Expect(idx[1].Artists).To(HaveLen(1)) Expect(idx[1].Artists[0].Name).To(Equal(artistKraftwerk.Name)) + Expect(idx[2].ID).To(Equal("R")) + Expect(idx[2].Artists).To(HaveLen(1)) + Expect(idx[2].Artists[0].Name).To(Equal(artistPunctuation.Name)) + Expect(idx[3].ID).To(Equal("S")) + Expect(idx[3].Artists).To(HaveLen(1)) + Expect(idx[3].Artists[0].Name).To(Equal(artistCJK.Name)) // Restore the original value artistBeatles.SortArtistName = "" @@ -245,13 +255,19 @@ var _ = Describe("ArtistRepository", func() { XIt("returns the index when PreferSortTags is true and SortArtistName is empty", func() { idx, err := repo.GetIndex(false, []int{1}) Expect(err).ToNot(HaveOccurred()) - Expect(idx).To(HaveLen(2)) + Expect(idx).To(HaveLen(4)) Expect(idx[0].ID).To(Equal("B")) Expect(idx[0].Artists).To(HaveLen(1)) Expect(idx[0].Artists[0].Name).To(Equal(artistBeatles.Name)) Expect(idx[1].ID).To(Equal("K")) Expect(idx[1].Artists).To(HaveLen(1)) Expect(idx[1].Artists[0].Name).To(Equal(artistKraftwerk.Name)) + Expect(idx[2].ID).To(Equal("R")) + Expect(idx[2].Artists).To(HaveLen(1)) + Expect(idx[2].Artists[0].Name).To(Equal(artistPunctuation.Name)) + Expect(idx[3].ID).To(Equal("S")) + Expect(idx[3].Artists).To(HaveLen(1)) + Expect(idx[3].Artists[0].Name).To(Equal(artistCJK.Name)) }) }) @@ -267,13 +283,19 @@ var _ = Describe("ArtistRepository", func() { idx, err := repo.GetIndex(false, []int{1}) Expect(err).ToNot(HaveOccurred()) - Expect(idx).To(HaveLen(2)) + Expect(idx).To(HaveLen(4)) Expect(idx[0].ID).To(Equal("B")) Expect(idx[0].Artists).To(HaveLen(1)) Expect(idx[0].Artists[0].Name).To(Equal(artistBeatles.Name)) Expect(idx[1].ID).To(Equal("K")) Expect(idx[1].Artists).To(HaveLen(1)) Expect(idx[1].Artists[0].Name).To(Equal(artistKraftwerk.Name)) + Expect(idx[2].ID).To(Equal("R")) + Expect(idx[2].Artists).To(HaveLen(1)) + Expect(idx[2].Artists[0].Name).To(Equal(artistPunctuation.Name)) + Expect(idx[3].ID).To(Equal("S")) + Expect(idx[3].Artists).To(HaveLen(1)) + Expect(idx[3].Artists[0].Name).To(Equal(artistCJK.Name)) // Restore the original value artistBeatles.SortArtistName = "" @@ -284,13 +306,19 @@ var _ = Describe("ArtistRepository", func() { It("returns the index when SortArtistName is empty", func() { idx, err := repo.GetIndex(false, []int{1}) Expect(err).ToNot(HaveOccurred()) - Expect(idx).To(HaveLen(2)) + Expect(idx).To(HaveLen(4)) Expect(idx[0].ID).To(Equal("B")) Expect(idx[0].Artists).To(HaveLen(1)) Expect(idx[0].Artists[0].Name).To(Equal(artistBeatles.Name)) Expect(idx[1].ID).To(Equal("K")) Expect(idx[1].Artists).To(HaveLen(1)) Expect(idx[1].Artists[0].Name).To(Equal(artistKraftwerk.Name)) + Expect(idx[2].ID).To(Equal("R")) + Expect(idx[2].Artists).To(HaveLen(1)) + Expect(idx[2].Artists[0].Name).To(Equal(artistPunctuation.Name)) + Expect(idx[3].ID).To(Equal("S")) + Expect(idx[3].Artists).To(HaveLen(1)) + Expect(idx[3].Artists[0].Name).To(Equal(artistCJK.Name)) }) }) @@ -376,7 +404,7 @@ var _ = Describe("ArtistRepository", func() { // Admin users can see all content when valid library IDs are provided idx, err := repo.GetIndex(false, []int{1}) Expect(err).ToNot(HaveOccurred()) - Expect(idx).To(HaveLen(2)) + Expect(idx).To(HaveLen(4)) // With non-existent library ID, admin users see no content because no artists are associated with that library idx, err = repo.GetIndex(false, []int{999}) @@ -386,6 +414,54 @@ var _ = Describe("ArtistRepository", func() { }) }) + Describe("Filters", func() { + var artistWithoutAnnotation model.Artist + + BeforeEach(func() { + // Create artist without any annotation + artistWithoutAnnotation = model.Artist{ID: "no-annotation-artist", Name: "No Annotation Artist"} + err := createArtistWithLibrary(repo, &artistWithoutAnnotation, 1) + Expect(err).ToNot(HaveOccurred()) + }) + + AfterEach(func() { + if raw, ok := repo.(*artistRepository); ok { + _, _ = raw.executeSQL(squirrel.Delete(raw.tableName).Where(squirrel.Eq{"id": artistWithoutAnnotation.ID})) + } + }) + + Describe("starred", func() { + It("false includes items without annotations", func() { + res, err := repo.(model.ResourceRepository).ReadAll(rest.QueryOptions{ + Filters: map[string]any{"starred": "false"}, + }) + Expect(err).ToNot(HaveOccurred()) + artists := res.(model.Artists) + + var found bool + for _, a := range artists { + if a.ID == artistWithoutAnnotation.ID { + found = true + break + } + } + Expect(found).To(BeTrue(), "Artist without annotation should be included in starred=false filter") + }) + + It("true excludes items without annotations", func() { + res, err := repo.(model.ResourceRepository).ReadAll(rest.QueryOptions{ + Filters: map[string]any{"starred": "true"}, + }) + Expect(err).ToNot(HaveOccurred()) + artists := res.(model.Artists) + + for _, a := range artists { + Expect(a.ID).ToNot(Equal(artistWithoutAnnotation.ID)) + } + }) + }) + }) + Describe("MBID and Text Search", func() { var lib2 model.Library var lr model.LibraryRepository @@ -439,7 +515,7 @@ var _ = Describe("ArtistRepository", func() { Expect(err).ToNot(HaveOccurred()) // Test the search - results, err := (*testRepo).Search("550e8400-e29b-41d4-a716-446655440010", 0, 10) + results, err := (*testRepo).Search("550e8400-e29b-41d4-a716-446655440010", model.QueryOptions{Max: 10}) Expect(err).ToNot(HaveOccurred()) if shouldFind { @@ -470,12 +546,12 @@ var _ = Describe("ArtistRepository", func() { Expect(err).ToNot(HaveOccurred()) // Restricted user should not find this artist - results, err := restrictedRepo.Search("a74b1b7f-71a5-4011-9441-d0b5e4122711", 0, 10) + results, err := restrictedRepo.Search("a74b1b7f-71a5-4011-9441-d0b5e4122711", model.QueryOptions{Max: 10}) Expect(err).ToNot(HaveOccurred()) Expect(results).To(BeEmpty()) // But admin should find it - results, err = repo.Search("a74b1b7f-71a5-4011-9441-d0b5e4122711", 0, 10) + results, err = repo.Search("a74b1b7f-71a5-4011-9441-d0b5e4122711", model.QueryOptions{Max: 10}) Expect(err).ToNot(HaveOccurred()) Expect(results).To(HaveLen(1)) @@ -487,7 +563,7 @@ var _ = Describe("ArtistRepository", func() { Context("Text Search", func() { It("allows admin to find artists by name regardless of library", func() { - results, err := repo.Search("Beatles", 0, 10) + results, err := repo.Search("Beatles", model.QueryOptions{Max: 10}) Expect(err).ToNot(HaveOccurred()) Expect(results).To(HaveLen(1)) Expect(results[0].Name).To(Equal("The Beatles")) @@ -507,7 +583,7 @@ var _ = Describe("ArtistRepository", func() { Expect(err).ToNot(HaveOccurred()) // Restricted user should not find this artist - results, err := restrictedRepo.Search("Unique Search Name", 0, 10) + results, err := restrictedRepo.Search("Unique Search Name", model.QueryOptions{Max: 10}) Expect(err).ToNot(HaveOccurred()) Expect(results).To(BeEmpty(), "Text search should respect library filtering") @@ -576,11 +652,11 @@ var _ = Describe("ArtistRepository", func() { It("sees all artists regardless of library permissions", func() { count, err := repo.CountAll() Expect(err).ToNot(HaveOccurred()) - Expect(count).To(Equal(int64(2))) + Expect(count).To(Equal(int64(4))) artists, err := repo.GetAll() Expect(err).ToNot(HaveOccurred()) - Expect(artists).To(HaveLen(2)) + Expect(artists).To(HaveLen(4)) exists, err := repo.Exists(artistBeatles.ID) Expect(err).ToNot(HaveOccurred()) @@ -612,10 +688,10 @@ var _ = Describe("ArtistRepository", func() { // Should see missing artist in GetAll by default for admin users artists, err := repo.GetAll() Expect(err).ToNot(HaveOccurred()) - Expect(artists).To(HaveLen(3)) // Including the missing artist + Expect(artists).To(HaveLen(5)) // Including the missing artist // Search never returns missing artists (hardcoded behavior) - results, err := repo.Search("Missing Artist", 0, 10) + results, err := repo.Search("Missing Artist", model.QueryOptions{Max: 10}) Expect(err).ToNot(HaveOccurred()) Expect(results).To(BeEmpty()) }) @@ -669,11 +745,11 @@ var _ = Describe("ArtistRepository", func() { }) It("Search returns empty results for users without library access", func() { - results, err := restrictedRepo.Search("Beatles", 0, 10) + results, err := restrictedRepo.Search("Beatles", model.QueryOptions{Max: 10}) Expect(err).ToNot(HaveOccurred()) Expect(results).To(BeEmpty()) - results, err = restrictedRepo.Search("Kraftwerk", 0, 10) + results, err = restrictedRepo.Search("Kraftwerk", model.QueryOptions{Max: 10}) Expect(err).ToNot(HaveOccurred()) Expect(results).To(BeEmpty()) }) @@ -718,19 +794,19 @@ var _ = Describe("ArtistRepository", func() { It("CountAll returns correct count after gaining access", func() { count, err := restrictedRepo.CountAll() Expect(err).ToNot(HaveOccurred()) - Expect(count).To(Equal(int64(2))) // Beatles and Kraftwerk + Expect(count).To(Equal(int64(4))) // Beatles, Kraftwerk, Seatbelts, and The Roots }) It("GetAll returns artists after gaining access", func() { artists, err := restrictedRepo.GetAll() Expect(err).ToNot(HaveOccurred()) - Expect(artists).To(HaveLen(2)) + Expect(artists).To(HaveLen(4)) var names []string for _, artist := range artists { names = append(names, artist.Name) } - Expect(names).To(ContainElements("The Beatles", "Kraftwerk")) + Expect(names).To(ContainElements("The Beatles", "Kraftwerk", "シートベルツ", "The Roots")) }) It("Exists returns true for accessible artists", func() { @@ -747,7 +823,7 @@ var _ = Describe("ArtistRepository", func() { // With valid library access, should see artists idx, err := restrictedRepo.GetIndex(false, []int{1}) Expect(err).ToNot(HaveOccurred()) - Expect(idx).To(HaveLen(2)) + Expect(idx).To(HaveLen(4)) // With non-existent library ID, should see nothing (non-admin user) idx, err = restrictedRepo.GetIndex(false, []int{999}) @@ -756,6 +832,89 @@ var _ = Describe("ArtistRepository", func() { }) }) }) + + Describe("purgeEmpty", func() { + var repo *artistRepository + var tmpDir string + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + tmpDir = GinkgoT().TempDir() + conf.Server.DataFolder = tmpDir + + ctx := request.WithUser(GinkgoT().Context(), adminUser) + repo = NewArtistRepository(ctx, GetDBXBuilder()).(*artistRepository) + }) + + // Helper to create an artist image file on disk and return its path + createImageFile := func(filename string) string { + dir := filepath.Join(tmpDir, consts.ArtworkFolder, consts.EntityArtist) + Expect(os.MkdirAll(dir, 0755)).To(Succeed()) + path := filepath.Join(dir, filename) + Expect(os.WriteFile(path, []byte("fake image data"), 0600)).To(Succeed()) + return path + } + + It("removes uploaded image files for purged artists", func() { + // Create an orphan artist (not in album_artists) with an uploaded image + orphanArtist := model.Artist{ID: "orphan-with-image", Name: "Orphan Artist", UploadedImage: "orphan-with-image_Orphan_Artist.jpg"} + Expect(repo.Put(&orphanArtist)).To(Succeed()) + imgPath := createImageFile("orphan-with-image_Orphan_Artist.jpg") + + Expect(repo.purgeEmpty()).To(Succeed()) + + // Artist should be gone from DB + exists, err := repo.Exists("orphan-with-image") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + + // Image file should be removed from disk + _, err = os.Stat(imgPath) + Expect(os.IsNotExist(err)).To(BeTrue()) + }) + + It("handles missing image files gracefully", func() { + // Artist has UploadedImage set but no actual file on disk + orphanArtist := model.Artist{ID: "orphan-no-file", Name: "Ghost Image", UploadedImage: "orphan-no-file_Ghost_Image.jpg"} + Expect(repo.Put(&orphanArtist)).To(Succeed()) + + Expect(repo.purgeEmpty()).To(Succeed()) + + // Artist should be gone from DB + exists, err := repo.Exists("orphan-no-file") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + }) + + It("does not delete images for artists that are kept", func() { + // Create an artist with an uploaded image AND an album_artists entry so it won't be purged + keptArtist := model.Artist{ID: "kept-artist", Name: "Kept Artist", UploadedImage: "kept-artist_Kept_Artist.jpg"} + Expect(repo.Put(&keptArtist)).To(Succeed()) + imgPath := createImageFile("kept-artist_Kept_Artist.jpg") + + // Insert an album_artists record to keep this artist from being purged + _, err := repo.executeSQL(squirrel.Insert("album_artists"). + SetMap(map[string]any{"album_id": "101", "artist_id": "kept-artist", "role": "artist", "sub_role": ""})) + Expect(err).ToNot(HaveOccurred()) + + DeferCleanup(func() { + _, _ = repo.executeSQL(squirrel.Delete("album_artists").Where(squirrel.Eq{"artist_id": "kept-artist"})) + _ = repo.delete(squirrel.Eq{"id": "kept-artist"}) + }) + + Expect(repo.purgeEmpty()).To(Succeed()) + + // Artist should still exist (check directly, bypassing library filter) + var ids []string + err = repo.queryAllSlice(squirrel.Select("id").From("artist").Where(squirrel.Eq{"id": "kept-artist"}), &ids) + Expect(err).ToNot(HaveOccurred()) + Expect(ids).To(HaveLen(1)) + + // Image file should still be on disk + _, err = os.Stat(imgPath) + Expect(err).ToNot(HaveOccurred()) + }) + }) }) // Helper function to create an artist with proper library association. diff --git a/persistence/collation_test.go b/persistence/collation_test.go index 7e1144753..bb1276577 100644 --- a/persistence/collation_test.go +++ b/persistence/collation_test.go @@ -32,6 +32,7 @@ var _ = Describe("Collation", func() { Entry("media_file.sort_title", "media_file", "sort_title"), Entry("media_file.sort_album_name", "media_file", "sort_album_name"), Entry("media_file.sort_artist_name", "media_file", "sort_artist_name"), + Entry("playlist.name", "playlist", "name"), Entry("radio.name", "radio", "name"), Entry("user.name", "user", "name"), ) @@ -53,6 +54,7 @@ var _ = Describe("Collation", func() { Entry("media_file.sort_album_name", "media_file", "coalesce(nullif(sort_album_name,''),order_album_name) collate nocase"), Entry("media_file.sort_artist_name", "media_file", "coalesce(nullif(sort_artist_name,''),order_artist_name) collate nocase"), Entry("media_file.path", "media_file", "path collate nocase"), + Entry("playlist.name", "playlist", "name collate nocase"), Entry("radio.name", "radio", "name collate nocase"), Entry("user.user_name", "user", "user_name collate nocase"), ) diff --git a/persistence/folder_repository.go b/persistence/folder_repository.go index 96a9bae82..f7bb6a4fe 100644 --- a/persistence/folder_repository.go +++ b/persistence/folder_repository.go @@ -4,7 +4,12 @@ import ( "context" "encoding/json" "fmt" + "iter" + "maps" + "os" + "path/filepath" "slices" + "strings" "time" . "github.com/Masterminds/squirrel" @@ -91,8 +96,82 @@ func (r folderRepository) CountAll(opt ...model.QueryOptions) (int64, error) { return r.count(query) } -func (r folderRepository) GetLastUpdates(lib model.Library) (map[string]model.FolderUpdateInfo, error) { - sq := r.newSelect().Columns("id", "updated_at", "hash").Where(Eq{"library_id": lib.ID, "missing": false}) +func (r folderRepository) GetFolderUpdateInfo(lib model.Library, targetPaths ...string) (map[string]model.FolderUpdateInfo, error) { + // If no specific paths, return all folders in the library + if len(targetPaths) == 0 { + return r.getFolderUpdateInfoAll(lib) + } + + // Check if any path is root (return all folders) + for _, targetPath := range targetPaths { + if targetPath == "" || targetPath == "." { + return r.getFolderUpdateInfoAll(lib) + } + } + + // Process paths in batches to avoid SQLite's expression tree depth limit (max 1000). + // Each path generates ~3 conditions, so batch size of 100 keeps us well under the limit. + const batchSize = 100 + result := make(map[string]model.FolderUpdateInfo) + + for batch := range slices.Chunk(targetPaths, batchSize) { + batchResult, err := r.getFolderUpdateInfoBatch(lib, batch) + if err != nil { + return nil, err + } + maps.Copy(result, batchResult) + } + + return result, nil +} + +// getFolderUpdateInfoAll returns update info for all non-missing folders in the library +func (r folderRepository) getFolderUpdateInfoAll(lib model.Library) (map[string]model.FolderUpdateInfo, error) { + where := And{ + Eq{"library_id": lib.ID}, + Eq{"missing": false}, + } + return r.queryFolderUpdateInfo(where) +} + +// getFolderUpdateInfoBatch returns update info for a batch of target paths and their descendants +func (r folderRepository) getFolderUpdateInfoBatch(lib model.Library, targetPaths []string) (map[string]model.FolderUpdateInfo, error) { + where := And{ + Eq{"library_id": lib.ID}, + Eq{"missing": false}, + } + + // Collect folder IDs for exact target folders and path conditions for descendants + folderIDs := make([]string, 0, len(targetPaths)) + pathConditions := make(Or, 0, len(targetPaths)*2) + + for _, targetPath := range targetPaths { + // Clean the path to normalize it. Paths stored in the folder table do not have leading/trailing slashes. + cleanPath := strings.TrimPrefix(targetPath, string(os.PathSeparator)) + cleanPath = filepath.Clean(cleanPath) + + // Include the target folder itself by ID + folderIDs = append(folderIDs, model.FolderID(lib, cleanPath)) + + // Include all descendants: folders whose path field equals or starts with the target path + // Note: Folder.Path is the directory path, so children have path = targetPath + pathConditions = append(pathConditions, Eq{"path": cleanPath}) + pathConditions = append(pathConditions, Like{"path": cleanPath + "/%"}) + } + + // Combine conditions: exact folder IDs OR descendant path patterns + if len(folderIDs) > 0 { + where = append(where, Or{Eq{"id": folderIDs}, pathConditions}) + } else if len(pathConditions) > 0 { + where = append(where, pathConditions) + } + + return r.queryFolderUpdateInfo(where) +} + +// queryFolderUpdateInfo executes the query and returns the result map +func (r folderRepository) queryFolderUpdateInfo(where And) (map[string]model.FolderUpdateInfo, error) { + sq := r.newSelect().Columns("id", "updated_at", "hash").Where(where) var res []struct { ID string UpdatedAt time.Time @@ -140,16 +219,24 @@ func (r folderRepository) GetTouchedWithPlaylists() (model.FolderCursor, error) if err != nil { return nil, err } + return wrapFolderCursor(cursor), nil +} + +func wrapFolderCursor(cursor iter.Seq2[dbFolder, error]) model.FolderCursor { return func(yield func(model.Folder, error) bool) { for f, err := range cursor { + if f.Folder == nil { + yield(model.Folder{}, fmt.Errorf("unexpected nil folder (%v): %w", f, err)) + return + } if !yield(*f.Folder, err) || err != nil { return } } - }, nil + } } -func (r folderRepository) purgeEmpty() error { +func (r folderRepository) purgeEmpty(libraryIDs ...int) error { sq := Delete(r.tableName).Where(And{ Eq{"num_audio_files": 0}, Eq{"num_playlists": 0}, @@ -157,6 +244,10 @@ func (r folderRepository) purgeEmpty() error { ConcatExpr("id not in (select parent_id from folder)"), ConcatExpr("id not in (select folder_id from media_file)"), }) + // If libraryIDs are specified, only purge folders from those libraries + if len(libraryIDs) > 0 { + sq = sq.Where(Eq{"library_id": libraryIDs}) + } c, err := r.executeSQL(sq) if err != nil { return fmt.Errorf("purging empty folders: %w", err) diff --git a/persistence/folder_repository_test.go b/persistence/folder_repository_test.go new file mode 100644 index 000000000..7b6a0f764 --- /dev/null +++ b/persistence/folder_repository_test.go @@ -0,0 +1,254 @@ +package persistence + +import ( + "context" + "errors" + "fmt" + + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + "github.com/pocketbase/dbx" +) + +var _ = Describe("FolderRepository", func() { + var repo model.FolderRepository + var ctx context.Context + var conn *dbx.DB + var testLib, otherLib model.Library + + BeforeEach(func() { + ctx = request.WithUser(log.NewContext(context.TODO()), model.User{ID: "userid"}) + conn = GetDBXBuilder() + repo = newFolderRepository(ctx, conn) + + // Use existing library ID 1 from test fixtures + libRepo := NewLibraryRepository(ctx, conn) + lib, err := libRepo.Get(1) + Expect(err).ToNot(HaveOccurred()) + testLib = *lib + + // Create a second library with its own folder to verify isolation + otherLib = model.Library{Name: "Other Library", Path: "/other/path"} + Expect(libRepo.Put(&otherLib)).To(Succeed()) + }) + + AfterEach(func() { + // Clean up only test folders created by our tests (paths starting with "Test") + // This prevents interference with fixture data needed by other tests + _, _ = conn.NewQuery("DELETE FROM folder WHERE library_id = 1 AND path LIKE 'Test%'").Execute() + _, _ = conn.NewQuery(fmt.Sprintf("DELETE FROM library WHERE id = %d", otherLib.ID)).Execute() + }) + + Describe("GetFolderUpdateInfo", func() { + Context("with no target paths", func() { + It("returns all folders in the library", func() { + // Create test folders with unique names to avoid conflicts + folder1 := model.NewFolder(testLib, "TestGetLastUpdates/Folder1") + folder2 := model.NewFolder(testLib, "TestGetLastUpdates/Folder2") + + err := repo.Put(folder1) + Expect(err).ToNot(HaveOccurred()) + err = repo.Put(folder2) + Expect(err).ToNot(HaveOccurred()) + + otherFolder := model.NewFolder(otherLib, "TestOtherLib/Folder") + err = repo.Put(otherFolder) + Expect(err).ToNot(HaveOccurred()) + + // Query all folders (no target paths) - should only return folders from testLib + results, err := repo.GetFolderUpdateInfo(testLib) + Expect(err).ToNot(HaveOccurred()) + // Should include folders from testLib + Expect(results).To(HaveKey(folder1.ID)) + Expect(results).To(HaveKey(folder2.ID)) + // Should NOT include folders from other library + Expect(results).ToNot(HaveKey(otherFolder.ID)) + }) + }) + + Context("with specific target paths", func() { + It("returns folder info for existing folders", func() { + // Create test folders with unique names + folder1 := model.NewFolder(testLib, "TestSpecific/Rock") + folder2 := model.NewFolder(testLib, "TestSpecific/Jazz") + folder3 := model.NewFolder(testLib, "TestSpecific/Classical") + + err := repo.Put(folder1) + Expect(err).ToNot(HaveOccurred()) + err = repo.Put(folder2) + Expect(err).ToNot(HaveOccurred()) + err = repo.Put(folder3) + Expect(err).ToNot(HaveOccurred()) + + // Query specific paths + results, err := repo.GetFolderUpdateInfo(testLib, "TestSpecific/Rock", "TestSpecific/Classical") + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(2)) + + // Verify folder IDs are in results + Expect(results).To(HaveKey(folder1.ID)) + Expect(results).To(HaveKey(folder3.ID)) + Expect(results).ToNot(HaveKey(folder2.ID)) + + // Verify update info is populated + Expect(results[folder1.ID].UpdatedAt).ToNot(BeZero()) + Expect(results[folder1.ID].Hash).To(Equal(folder1.Hash)) + }) + + It("includes all child folders when querying parent", func() { + // Create a parent folder with multiple children + parent := model.NewFolder(testLib, "TestParent/Music") + child1 := model.NewFolder(testLib, "TestParent/Music/Rock/Queen") + child2 := model.NewFolder(testLib, "TestParent/Music/Jazz") + otherParent := model.NewFolder(testLib, "TestParent2/Music/Jazz") + + Expect(repo.Put(parent)).To(Succeed()) + Expect(repo.Put(child1)).To(Succeed()) + Expect(repo.Put(child2)).To(Succeed()) + + // Query the parent folder - should return parent and all children + results, err := repo.GetFolderUpdateInfo(testLib, "TestParent/Music") + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(3)) + Expect(results).To(HaveKey(parent.ID)) + Expect(results).To(HaveKey(child1.ID)) + Expect(results).To(HaveKey(child2.ID)) + Expect(results).ToNot(HaveKey(otherParent.ID)) + }) + + It("excludes children from other libraries", func() { + // Create parent in testLib + parent := model.NewFolder(testLib, "TestIsolation/Parent") + child := model.NewFolder(testLib, "TestIsolation/Parent/Child") + + Expect(repo.Put(parent)).To(Succeed()) + Expect(repo.Put(child)).To(Succeed()) + + // Create similar path in other library + otherParent := model.NewFolder(otherLib, "TestIsolation/Parent") + otherChild := model.NewFolder(otherLib, "TestIsolation/Parent/Child") + + Expect(repo.Put(otherParent)).To(Succeed()) + Expect(repo.Put(otherChild)).To(Succeed()) + + // Query should only return folders from testLib + results, err := repo.GetFolderUpdateInfo(testLib, "TestIsolation/Parent") + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(2)) + Expect(results).To(HaveKey(parent.ID)) + Expect(results).To(HaveKey(child.ID)) + Expect(results).ToNot(HaveKey(otherParent.ID)) + Expect(results).ToNot(HaveKey(otherChild.ID)) + }) + + It("excludes missing children when querying parent", func() { + // Create parent and children, mark one as missing + parent := model.NewFolder(testLib, "TestMissingChild/Parent") + child1 := model.NewFolder(testLib, "TestMissingChild/Parent/Child1") + child2 := model.NewFolder(testLib, "TestMissingChild/Parent/Child2") + child2.Missing = true + + Expect(repo.Put(parent)).To(Succeed()) + Expect(repo.Put(child1)).To(Succeed()) + Expect(repo.Put(child2)).To(Succeed()) + + // Query parent - should only return parent and non-missing child + results, err := repo.GetFolderUpdateInfo(testLib, "TestMissingChild/Parent") + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(2)) + Expect(results).To(HaveKey(parent.ID)) + Expect(results).To(HaveKey(child1.ID)) + Expect(results).ToNot(HaveKey(child2.ID)) + }) + + It("handles mix of existing and non-existing target paths", func() { + // Create folders for one path but not the other + existingParent := model.NewFolder(testLib, "TestMixed/Exists") + existingChild := model.NewFolder(testLib, "TestMixed/Exists/Child") + + Expect(repo.Put(existingParent)).To(Succeed()) + Expect(repo.Put(existingChild)).To(Succeed()) + + // Query both existing and non-existing paths + results, err := repo.GetFolderUpdateInfo(testLib, "TestMixed/Exists", "TestMixed/DoesNotExist") + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(2)) + Expect(results).To(HaveKey(existingParent.ID)) + Expect(results).To(HaveKey(existingChild.ID)) + }) + + It("handles empty folder path as root", func() { + // Test querying for root folder without creating it (fixtures should have one) + rootFolderID := model.FolderID(testLib, ".") + + results, err := repo.GetFolderUpdateInfo(testLib, "") + Expect(err).ToNot(HaveOccurred()) + // Should return the root folder if it exists + if len(results) > 0 { + Expect(results).To(HaveKey(rootFolderID)) + } + }) + + It("returns empty map for non-existent folders", func() { + results, err := repo.GetFolderUpdateInfo(testLib, "NonExistent/Path") + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(BeEmpty()) + }) + + It("skips missing folders", func() { + // Create a folder and mark it as missing + folder := model.NewFolder(testLib, "TestMissing/Folder") + folder.Missing = true + err := repo.Put(folder) + Expect(err).ToNot(HaveOccurred()) + + results, err := repo.GetFolderUpdateInfo(testLib, "TestMissing/Folder") + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(BeEmpty()) + }) + }) + }) + + Describe("wrapFolderCursor", func() { + It("does not panic when the cursor yields a dbFolder with nil Folder", func() { + // Simulate what queryWithStableResults does on the rows.Err() path: + // it yields a zero-value dbFolder (where Folder is nil) with an error. + dbErr := fmt.Errorf("database is locked") + cursor := func(yield func(dbFolder, error) bool) { + var empty dbFolder // Folder pointer is nil + yield(empty, dbErr) + } + + // wrapFolderCursor should handle the nil Folder without panicking + wrappedCursor := wrapFolderCursor(cursor) + var gotErr error + Expect(func() { + for _, err := range wrappedCursor { + gotErr = err + } + }).ToNot(Panic()) + Expect(gotErr).To(HaveOccurred()) + Expect(gotErr.Error()).To(ContainSubstring("unexpected nil folder")) + Expect(errors.Is(gotErr, dbErr)).To(BeTrue(), "should wrap the original cursor error") + }) + + It("yields folders from a valid cursor", func() { + folder := &model.Folder{ID: "f1", Name: "Test"} + cursor := func(yield func(dbFolder, error) bool) { + yield(dbFolder{Folder: folder}, nil) + } + + wrappedCursor := wrapFolderCursor(cursor) + var folders []model.Folder + for f, err := range wrappedCursor { + Expect(err).ToNot(HaveOccurred()) + folders = append(folders, f) + } + Expect(folders).To(HaveLen(1)) + Expect(folders[0].ID).To(Equal("f1")) + }) + }) +}) diff --git a/persistence/genre_repository.go b/persistence/genre_repository.go index 5857350a6..53f324bf4 100644 --- a/persistence/genre_repository.go +++ b/persistence/genre_repository.go @@ -33,18 +33,18 @@ func (r *genreRepository) GetAll(opt ...model.QueryOptions) (model.Genres, error // Override ResourceRepository methods to return Genre objects instead of Tag objects -func (r *genreRepository) Read(id string) (interface{}, error) { +func (r *genreRepository) Read(id string) (any, error) { sel := r.selectGenre().Where(Eq{"tag.id": id}) var res model.Genre err := r.queryOne(sel, &res) return &res, err } -func (r *genreRepository) ReadAll(options ...rest.QueryOptions) (interface{}, error) { +func (r *genreRepository) ReadAll(options ...rest.QueryOptions) (any, error) { return r.GetAll(r.parseRestOptions(r.ctx, options...)) } -func (r *genreRepository) NewInstance() interface{} { +func (r *genreRepository) NewInstance() any { return &model.Genre{} } diff --git a/persistence/genre_repository_test.go b/persistence/genre_repository_test.go index 67e84ce51..e3779725c 100644 --- a/persistence/genre_repository_test.go +++ b/persistence/genre_repository_test.go @@ -182,7 +182,7 @@ var _ = Describe("GenreRepository", func() { It("should filter by name using like match", func() { // Test filtering by partial name match using the "name" filter which maps to containsFilter("tag_value") options := rest.QueryOptions{ - Filters: map[string]interface{}{"name": "%rock%"}, + Filters: map[string]any{"name": "%rock%"}, } count, err := restRepo.Count(options) Expect(err).ToNot(HaveOccurred()) @@ -289,7 +289,7 @@ var _ = Describe("GenreRepository", func() { It("should allow headless processes to apply explicit library_id filters", func() { // Filter by specific library genres, err := headlessRestRepo.ReadAll(rest.QueryOptions{ - Filters: map[string]interface{}{"library_id": 2}, + Filters: map[string]any{"library_id": 2}, }) Expect(err).ToNot(HaveOccurred()) diff --git a/persistence/helpers.go b/persistence/helpers.go index 73815ae45..fd6a9a4cd 100644 --- a/persistence/helpers.go +++ b/persistence/helpers.go @@ -15,7 +15,7 @@ type PostMapper interface { PostMapArgs(map[string]any) error } -func toSQLArgs(rec interface{}) (map[string]interface{}, error) { +func toSQLArgs(rec any) (map[string]any, error) { m := structs.Map(rec) for k, v := range m { switch t := v.(type) { @@ -71,7 +71,7 @@ type existsCond struct { not bool } -func (e existsCond) ToSql() (string, []interface{}, error) { +func (e existsCond) ToSql() (string, []any, error) { sql, args, err := e.cond.ToSql() sql = fmt.Sprintf("exists (select 1 from %s where %s)", e.subTable, sql) if e.not { diff --git a/persistence/library_repository.go b/persistence/library_repository.go index 314b682bb..1d8e6f35e 100644 --- a/persistence/library_repository.go +++ b/persistence/library_repository.go @@ -177,7 +177,11 @@ func (r *libraryRepository) ScanEnd(id int) error { return err } // https://www.sqlite.org/pragma.html#pragma_optimize - _, err = r.executeSQL(Expr("PRAGMA optimize=0x10012;")) + // Use mask 0x10000 to check table sizes without running ANALYZE + // Running ANALYZE can cause query planner issues with expression-based collation indexes + if conf.Server.DevOptimizeDB { + _, err = r.executeSQL(Expr("PRAGMA optimize=0x10000;")) + } return err } @@ -262,6 +266,10 @@ func (r *libraryRepository) Delete(id int) error { defer libLock.Unlock() delete(libCache, id) + // Clean up orphaned plugin references for the deleted library + if err := cleanupPluginLibraryReferences(r.db, id); err != nil { + log.Error(r.ctx, "Failed to cleanup plugin library references", "libraryID", id, err) + } return nil } @@ -297,7 +305,7 @@ func (r *libraryRepository) Count(options ...rest.QueryOptions) (int64, error) { return r.CountAll(r.parseRestOptions(r.ctx, options...)) } -func (r *libraryRepository) Read(id string) (interface{}, error) { +func (r *libraryRepository) Read(id string) (any, error) { idInt, err := strconv.Atoi(id) if err != nil { log.Trace(r.ctx, "invalid library id: %s", id, err) @@ -306,7 +314,7 @@ func (r *libraryRepository) Read(id string) (interface{}, error) { return r.Get(idInt) } -func (r *libraryRepository) ReadAll(options ...rest.QueryOptions) (interface{}, error) { +func (r *libraryRepository) ReadAll(options ...rest.QueryOptions) (any, error) { return r.GetAll(r.parseRestOptions(r.ctx, options...)) } @@ -314,11 +322,11 @@ func (r *libraryRepository) EntityName() string { return "library" } -func (r *libraryRepository) NewInstance() interface{} { +func (r *libraryRepository) NewInstance() any { return &model.Library{} } -func (r *libraryRepository) Save(entity interface{}) (string, error) { +func (r *libraryRepository) Save(entity any) (string, error) { lib := entity.(*model.Library) lib.ID = 0 // Reset ID to ensure we create a new library err := r.Put(lib) @@ -328,7 +336,7 @@ func (r *libraryRepository) Save(entity interface{}) (string, error) { return strconv.Itoa(lib.ID), nil } -func (r *libraryRepository) Update(id string, entity interface{}, cols ...string) error { +func (r *libraryRepository) Update(id string, entity any, cols ...string) error { lib := entity.(*model.Library) idInt, err := strconv.Atoi(id) if err != nil { diff --git a/persistence/library_repository_test.go b/persistence/library_repository_test.go index 6f4df1beb..3e3972bdb 100644 --- a/persistence/library_repository_test.go +++ b/persistence/library_repository_test.go @@ -142,4 +142,62 @@ var _ = Describe("LibraryRepository", func() { Expect(libAfter.TotalSize).To(Equal(sizeRes.Sum)) Expect(libAfter.TotalDuration).To(Equal(durationRes.Sum)) }) + + Describe("ScanBegin and ScanEnd", func() { + var lib *model.Library + + BeforeEach(func() { + lib = &model.Library{ + ID: 0, + Name: "Test Scan Library", + Path: "/music/test-scan", + } + err := repo.Put(lib) + Expect(err).ToNot(HaveOccurred()) + }) + + DescribeTable("ScanBegin", + func(fullScan bool, expectedFullScanInProgress bool) { + err := repo.ScanBegin(lib.ID, fullScan) + Expect(err).ToNot(HaveOccurred()) + + updatedLib, err := repo.Get(lib.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(updatedLib.LastScanStartedAt).ToNot(BeZero()) + Expect(updatedLib.FullScanInProgress).To(Equal(expectedFullScanInProgress)) + }, + Entry("sets FullScanInProgress to true for full scan", true, true), + Entry("sets FullScanInProgress to false for quick scan", false, false), + ) + + Context("ScanEnd", func() { + BeforeEach(func() { + err := repo.ScanBegin(lib.ID, true) + Expect(err).ToNot(HaveOccurred()) + }) + + It("sets LastScanAt and clears FullScanInProgress and LastScanStartedAt", func() { + err := repo.ScanEnd(lib.ID) + Expect(err).ToNot(HaveOccurred()) + + updatedLib, err := repo.Get(lib.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(updatedLib.LastScanAt).ToNot(BeZero()) + Expect(updatedLib.FullScanInProgress).To(BeFalse()) + Expect(updatedLib.LastScanStartedAt).To(BeZero()) + }) + + It("sets LastScanAt to be after LastScanStartedAt", func() { + libBefore, err := repo.Get(lib.ID) + Expect(err).ToNot(HaveOccurred()) + + err = repo.ScanEnd(lib.ID) + Expect(err).ToNot(HaveOccurred()) + + libAfter, err := repo.Get(lib.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(libAfter.LastScanAt).To(BeTemporally(">=", libBefore.LastScanStartedAt)) + }) + }) + }) }) diff --git a/persistence/mediafile_repository.go b/persistence/mediafile_repository.go index e7883947a..264778ea0 100644 --- a/persistence/mediafile_repository.go +++ b/persistence/mediafile_repository.go @@ -3,13 +3,15 @@ package persistence import ( "context" "fmt" + "iter" "slices" + "strconv" + "strings" "sync" "time" . "github.com/Masterminds/squirrel" "github.com/deluan/rest" - "github.com/google/uuid" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" @@ -56,8 +58,11 @@ func (m *dbMediaFile) PostScan() error { func (m *dbMediaFile) PostMapArgs(args map[string]any) error { fullText := []string{m.FullTitle(), m.Album, m.Artist, m.AlbumArtist, m.SortTitle, m.SortAlbumName, m.SortArtistName, m.SortAlbumArtistName, m.DiscSubtitle} - fullText = append(fullText, m.MediaFile.Participants.AllNames()...) + participantNames := m.MediaFile.Participants.AllNames() + fullText = append(fullText, participantNames...) args["full_text"] = formatFullText(fullText...) + args["search_participants"] = strings.Join(participantNames, " ") + args["search_normalized"] = normalizeForFTS(m.FullTitle(), m.Album, m.Artist, m.AlbumArtist) args["tags"] = marshalTags(m.MediaFile.Tags) args["participants"] = marshalParticipants(m.MediaFile.Participants) return nil @@ -84,6 +89,7 @@ func NewMediaFileRepository(ctx context.Context, db dbx.Builder) model.MediaFile "created_at": "media_file.created_at", "recently_added": mediaFileRecentlyAddedSort(), "starred_at": "starred, starred_at", + "rated_at": "rating, rated_at", }) return r } @@ -92,7 +98,8 @@ var mediaFileFilter = sync.OnceValue(func() map[string]filterFunc { filters := map[string]filterFunc{ "id": idFilter("media_file"), "title": fullTextFilter("media_file", "mbz_recording_id", "mbz_release_track_id"), - "starred": booleanFilter, + "starred": annotationBoolFilter("starred"), + "has_rating": annotationBoolFilter("rating"), "genre_id": tagIDFilter, "missing": booleanFilter, "artists_id": artistFilter, @@ -121,12 +128,33 @@ func (r *mediaFileRepository) CountAll(options ...model.QueryOptions) (int64, er return r.count(query, options...) } +func (r *mediaFileRepository) CountBySuffix(options ...model.QueryOptions) (map[string]int64, error) { + sel := r.newSelect(options...). + Columns("lower(suffix) as suffix", "count(*) as count"). + GroupBy("lower(suffix)") + var res []struct { + Suffix string + Count int64 + } + err := r.queryAll(sel, &res) + if err != nil { + return nil, err + } + counts := make(map[string]int64, len(res)) + for _, c := range res { + counts[c.Suffix] = c.Count + } + return counts, nil +} + func (r *mediaFileRepository) Exists(id string) (bool, error) { return r.exists(Eq{"media_file.id": id}) } func (r *mediaFileRepository) Put(m *model.MediaFile) error { - m.CreatedAt = time.Now() + if m.CreatedAt.IsZero() { + m.CreatedAt = time.Now() + } id, err := r.putByMatch(Eq{"path": m.Path, "library_id": m.LibraryID}, m.ID, &dbMediaFile{MediaFile: m}) if err != nil { return err @@ -135,6 +163,11 @@ func (r *mediaFileRepository) Put(m *model.MediaFile) error { return r.updateParticipants(m.ID, m.Participants) } +func (r *mediaFileRepository) UpdateProbeData(id string, data string) error { + _, err := r.executeSQL(Update(r.tableName).Set("probe_data", data).Where(Eq{"id": id})) + return err +} + func (r *mediaFileRepository) selectMediaFile(options ...model.QueryOptions) SelectBuilder { sql := r.newSelect(options...).Columns("media_file.*", "library.path as library_path", "library.name as library_name"). LeftJoin("library on media_file.library_id = library.id") @@ -173,31 +206,77 @@ func (r *mediaFileRepository) GetAll(options ...model.QueryOptions) (model.Media return res.toModels(), nil } +func (r *mediaFileRepository) GetAllByTags(tag model.TagName, values []string, options ...model.QueryOptions) (model.MediaFiles, error) { + placeholders := make([]string, len(values)) + args := make([]any, len(values)) + for i, v := range values { + placeholders[i] = "?" + args[i] = v + } + tagFilter := Expr( + fmt.Sprintf("exists (select 1 from json_tree(media_file.tags, '$.%s') where key='value' and value in (%s))", + tag, strings.Join(placeholders, ",")), + args..., + ) + + var opts model.QueryOptions + if len(options) > 0 { + opts = options[0] + } + if opts.Filters != nil { + opts.Filters = And{tagFilter, opts.Filters} + } else { + opts.Filters = tagFilter + } + return r.GetAll(opts) +} + func (r *mediaFileRepository) GetCursor(options ...model.QueryOptions) (model.MediaFileCursor, error) { sq := r.selectMediaFile(options...) cursor, err := queryWithStableResults[dbMediaFile](r.sqlRepository, sq) if err != nil { return nil, err } - return func(yield func(model.MediaFile, error) bool) { - for m, err := range cursor { - if m.MediaFile == nil { - yield(model.MediaFile{}, fmt.Errorf("unexpected nil mediafile: %v", m)) - return - } - if !yield(*m.MediaFile, err) || err != nil { - return - } - } - }, nil + return wrapMediaFileCursor(cursor), nil } +// FindByPaths finds media files by their paths. +// The paths can be library-qualified (format: "libraryID:path") or unqualified ("path"). +// Library-qualified paths search within the specified library, while unqualified paths +// search across all libraries for backward compatibility. func (r *mediaFileRepository) FindByPaths(paths []string) (model.MediaFiles, error) { - sel := r.newSelect().Columns("*").Where(Eq{"path collate nocase": paths}) + query := Or{} + + for _, path := range paths { + parts := strings.SplitN(path, ":", 2) + if len(parts) == 2 { + // Library-qualified path: "libraryID:path" + libraryID, err := strconv.Atoi(parts[0]) + if err != nil { + // Invalid format, skip + continue + } + relativePath := parts[1] + query = append(query, And{ + Eq{"path collate nocase": relativePath}, + Eq{"library_id": libraryID}, + }) + } else { + // Unqualified path: search across all libraries + query = append(query, Eq{"path collate nocase": path}) + } + } + + if len(query) == 0 { + return model.MediaFiles{}, nil + } + + sel := r.newSelect().Columns("*").Where(query) var res dbMediaFiles if err := r.queryAll(sel, &res); err != nil { return nil, err } + return res.toModels(), nil } @@ -288,25 +367,36 @@ func (r *mediaFileRepository) GetMissingAndMatching(libId int) (model.MediaFileC if err != nil { return nil, err } + return wrapMediaFileCursor(cursor), nil +} + +func wrapMediaFileCursor(cursor iter.Seq2[dbMediaFile, error]) model.MediaFileCursor { return func(yield func(model.MediaFile, error) bool) { for m, err := range cursor { + if m.MediaFile == nil { + yield(model.MediaFile{}, fmt.Errorf("unexpected nil mediafile (%v): %w", m, err)) + return + } if !yield(*m.MediaFile, err) || err != nil { return } } - }, nil + } } // FindRecentFilesByMBZTrackID finds recently added files by MusicBrainz Track ID in other libraries +// It uses a lightweight query without annotation/bookmark joins since those are not needed for matching func (r *mediaFileRepository) FindRecentFilesByMBZTrackID(missing model.MediaFile, since time.Time) (model.MediaFiles, error) { - sel := r.selectMediaFile().Where(And{ - NotEq{"media_file.library_id": missing.LibraryID}, - Eq{"media_file.mbz_release_track_id": missing.MbzReleaseTrackID}, - NotEq{"media_file.mbz_release_track_id": ""}, // Exclude empty MBZ Track IDs - Eq{"media_file.suffix": missing.Suffix}, - Gt{"media_file.created_at": since}, - Eq{"media_file.missing": false}, - }).OrderBy("media_file.created_at DESC") + sel := r.newSelect().Columns("media_file.*", "library.path as library_path", "library.name as library_name"). + LeftJoin("library on media_file.library_id = library.id"). + Where(And{ + NotEq{"media_file.library_id": missing.LibraryID}, + Eq{"media_file.mbz_release_track_id": missing.MbzReleaseTrackID}, + NotEq{"media_file.mbz_release_track_id": ""}, // Exclude empty MBZ Track IDs + Eq{"media_file.suffix": missing.Suffix}, + Gt{"media_file.created_at": since}, + Eq{"media_file.missing": false}, + }).OrderBy("media_file.created_at DESC") var res dbMediaFiles err := r.queryAll(sel, &res) @@ -317,19 +407,22 @@ func (r *mediaFileRepository) FindRecentFilesByMBZTrackID(missing model.MediaFil } // FindRecentFilesByProperties finds recently added files by intrinsic properties in other libraries +// It uses a lightweight query without annotation/bookmark joins since those are not needed for matching func (r *mediaFileRepository) FindRecentFilesByProperties(missing model.MediaFile, since time.Time) (model.MediaFiles, error) { - sel := r.selectMediaFile().Where(And{ - NotEq{"media_file.library_id": missing.LibraryID}, - Eq{"media_file.title": missing.Title}, - Eq{"media_file.size": missing.Size}, - Eq{"media_file.suffix": missing.Suffix}, - Eq{"media_file.disc_number": missing.DiscNumber}, - Eq{"media_file.track_number": missing.TrackNumber}, - Eq{"media_file.album": missing.Album}, - Eq{"media_file.mbz_release_track_id": ""}, // Exclude files with MBZ Track ID - Gt{"media_file.created_at": since}, - Eq{"media_file.missing": false}, - }).OrderBy("media_file.created_at DESC") + sel := r.newSelect().Columns("media_file.*", "library.path as library_path", "library.name as library_name"). + LeftJoin("library on media_file.library_id = library.id"). + Where(And{ + NotEq{"media_file.library_id": missing.LibraryID}, + Eq{"media_file.title": missing.Title}, + Eq{"media_file.size": missing.Size}, + Eq{"media_file.suffix": missing.Suffix}, + Eq{"media_file.disc_number": missing.DiscNumber}, + Eq{"media_file.track_number": missing.TrackNumber}, + Eq{"media_file.album": missing.Album}, + Eq{"media_file.mbz_release_track_id": ""}, // Exclude files with MBZ Track ID + Gt{"media_file.created_at": since}, + Eq{"media_file.missing": false}, + }).OrderBy("media_file.created_at DESC") var res dbMediaFiles err := r.queryAll(sel, &res) @@ -339,18 +432,21 @@ func (r *mediaFileRepository) FindRecentFilesByProperties(missing model.MediaFil return res.toModels(), nil } -func (r *mediaFileRepository) Search(q string, offset int, size int, options ...model.QueryOptions) (model.MediaFiles, error) { +var mediaFileSearchConfig = searchConfig{ + NaturalOrder: "media_file.rowid", + OrderBy: []string{"title"}, + MBIDFields: []string{"mbz_recording_id", "mbz_release_track_id"}, +} + +func (r *mediaFileRepository) Search(q string, options ...model.QueryOptions) (model.MediaFiles, error) { + var opts model.QueryOptions + if len(options) > 0 { + opts = options[0] + } var res dbMediaFiles - if uuid.Validate(q) == nil { - err := r.searchByMBID(r.selectMediaFile(options...), q, []string{"mbz_recording_id", "mbz_release_track_id"}, &res) - if err != nil { - return nil, fmt.Errorf("searching media_file by MBID %q: %w", q, err) - } - } else { - err := r.doSearch(r.selectMediaFile(options...), q, offset, size, &res, "media_file.rowid", "title") - if err != nil { - return nil, fmt.Errorf("searching media_file by query %q: %w", q, err) - } + err := r.doSearch(r.selectMediaFile(options...), q, &res, mediaFileSearchConfig, opts) + if err != nil { + return nil, fmt.Errorf("searching media_file %q: %w", q, err) } return res.toModels(), nil } @@ -359,11 +455,11 @@ func (r *mediaFileRepository) Count(options ...rest.QueryOptions) (int64, error) return r.CountAll(r.parseRestOptions(r.ctx, options...)) } -func (r *mediaFileRepository) Read(id string) (interface{}, error) { +func (r *mediaFileRepository) Read(id string) (any, error) { return r.Get(id) } -func (r *mediaFileRepository) ReadAll(options ...rest.QueryOptions) (interface{}, error) { +func (r *mediaFileRepository) ReadAll(options ...rest.QueryOptions) (any, error) { return r.GetAll(r.parseRestOptions(r.ctx, options...)) } @@ -371,7 +467,7 @@ func (r *mediaFileRepository) EntityName() string { return "mediafile" } -func (r *mediaFileRepository) NewInstance() interface{} { +func (r *mediaFileRepository) NewInstance() any { return &model.MediaFile{} } diff --git a/persistence/mediafile_repository_test.go b/persistence/mediafile_repository_test.go index 002b82499..5a866379f 100644 --- a/persistence/mediafile_repository_test.go +++ b/persistence/mediafile_repository_test.go @@ -2,9 +2,12 @@ package persistence import ( "context" + "errors" + "fmt" "time" "github.com/Masterminds/squirrel" + "github.com/deluan/rest" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/conf/configtest" "github.com/navidrome/navidrome/log" @@ -38,7 +41,45 @@ var _ = Describe("MediaRepository", func() { }) It("counts the number of mediafiles in the DB", func() { - Expect(mr.CountAll()).To(Equal(int64(6))) + Expect(mr.CountAll()).To(Equal(int64(13))) + }) + + Describe("CountBySuffix", func() { + var mp3File, flacFile1, flacFile2, flacUpperFile model.MediaFile + + BeforeEach(func() { + mp3File = model.MediaFile{ID: "suffix-mp3", LibraryID: 1, Suffix: "mp3", Path: "/test/file.mp3"} + flacFile1 = model.MediaFile{ID: "suffix-flac1", LibraryID: 1, Suffix: "flac", Path: "/test/file1.flac"} + flacFile2 = model.MediaFile{ID: "suffix-flac2", LibraryID: 1, Suffix: "flac", Path: "/test/file2.flac"} + flacUpperFile = model.MediaFile{ID: "suffix-FLAC", LibraryID: 1, Suffix: "FLAC", Path: "/test/file.FLAC"} + + Expect(mr.Put(&mp3File)).To(Succeed()) + Expect(mr.Put(&flacFile1)).To(Succeed()) + Expect(mr.Put(&flacFile2)).To(Succeed()) + Expect(mr.Put(&flacUpperFile)).To(Succeed()) + }) + + AfterEach(func() { + _ = mr.Delete(mp3File.ID) + _ = mr.Delete(flacFile1.ID) + _ = mr.Delete(flacFile2.ID) + _ = mr.Delete(flacUpperFile.ID) + }) + + It("counts media files grouped by suffix with lowercase normalization", func() { + counts, err := mr.CountBySuffix() + Expect(err).ToNot(HaveOccurred()) + + // Should have lowercase keys only + Expect(counts).To(HaveKey("mp3")) + Expect(counts).To(HaveKey("flac")) + Expect(counts).ToNot(HaveKey("FLAC")) + + // mp3: 1 file + Expect(counts["mp3"]).To(Equal(int64(1))) + // flac: 3 files (2 lowercase + 1 uppercase normalized) + Expect(counts["flac"]).To(Equal(int64(3))) + }) }) It("returns songs ordered by lyrics with a specific title/artist", func() { @@ -65,6 +106,68 @@ var _ = Describe("MediaRepository", func() { } }) + Describe("Put CreatedAt behavior (#5050)", func() { + It("sets CreatedAt to now when inserting a new file with zero CreatedAt", func() { + before := time.Now().Add(-time.Second) + newFile := model.MediaFile{ID: id.NewRandom(), LibraryID: 1, Path: "/test/created-at-zero.mp3"} + Expect(mr.Put(&newFile)).To(Succeed()) + + retrieved, err := mr.Get(newFile.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(retrieved.CreatedAt).To(BeTemporally(">", before)) + + _ = mr.Delete(newFile.ID) + }) + + It("preserves CreatedAt when inserting a new file with non-zero CreatedAt", func() { + originalTime := time.Date(2020, 3, 15, 10, 30, 0, 0, time.UTC) + newFile := model.MediaFile{ + ID: id.NewRandom(), + LibraryID: 1, + Path: "/test/created-at-preserved.mp3", + CreatedAt: originalTime, + } + Expect(mr.Put(&newFile)).To(Succeed()) + + retrieved, err := mr.Get(newFile.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(retrieved.CreatedAt).To(BeTemporally("~", originalTime, time.Second)) + + _ = mr.Delete(newFile.ID) + }) + + It("does not reset CreatedAt when updating an existing file", func() { + originalTime := time.Date(2019, 6, 1, 12, 0, 0, 0, time.UTC) + fileID := id.NewRandom() + newFile := model.MediaFile{ + ID: fileID, + LibraryID: 1, + Path: "/test/created-at-update.mp3", + Title: "Original Title", + CreatedAt: originalTime, + } + Expect(mr.Put(&newFile)).To(Succeed()) + + // Update the file with a new title but zero CreatedAt + updatedFile := model.MediaFile{ + ID: fileID, + LibraryID: 1, + Path: "/test/created-at-update.mp3", + Title: "Updated Title", + // CreatedAt is zero - should NOT overwrite the stored value + } + Expect(mr.Put(&updatedFile)).To(Succeed()) + + retrieved, err := mr.Get(fileID) + Expect(err).ToNot(HaveOccurred()) + Expect(retrieved.Title).To(Equal("Updated Title")) + // CreatedAt should still be the original time (not reset) + Expect(retrieved.CreatedAt).To(BeTemporally("~", originalTime, time.Second)) + + _ = mr.Delete(fileID) + }) + }) + It("checks existence of mediafiles in the DB", func() { Expect(mr.Exists(songAntenna.ID)).To(BeTrue()) Expect(mr.Exists("666")).To(BeFalse()) @@ -119,6 +222,74 @@ var _ = Describe("MediaRepository", func() { Expect(mf.PlayCount).To(Equal(int64(1))) }) + Describe("AverageRating", func() { + var raw *mediaFileRepository + + BeforeEach(func() { + raw = mr.(*mediaFileRepository) + }) + + It("returns 0 when no ratings exist", func() { + newID := id.NewRandom() + Expect(mr.Put(&model.MediaFile{LibraryID: 1, ID: newID, Path: "/test/no-rating.mp3"})).To(Succeed()) + + mf, err := mr.Get(newID) + Expect(err).ToNot(HaveOccurred()) + Expect(mf.AverageRating).To(Equal(0.0)) + + _, _ = raw.executeSQL(squirrel.Delete("media_file").Where(squirrel.Eq{"id": newID})) + }) + + It("returns the user's rating as average when only one user rated", func() { + newID := id.NewRandom() + Expect(mr.Put(&model.MediaFile{LibraryID: 1, ID: newID, Path: "/test/single-rating.mp3"})).To(Succeed()) + Expect(mr.SetRating(5, newID)).To(Succeed()) + + mf, err := mr.Get(newID) + Expect(err).ToNot(HaveOccurred()) + Expect(mf.AverageRating).To(Equal(5.0)) + + _, _ = raw.executeSQL(squirrel.Delete("annotation").Where(squirrel.Eq{"item_id": newID})) + _, _ = raw.executeSQL(squirrel.Delete("media_file").Where(squirrel.Eq{"id": newID})) + }) + + It("calculates average across multiple users", func() { + newID := id.NewRandom() + Expect(mr.Put(&model.MediaFile{LibraryID: 1, ID: newID, Path: "/test/multi-rating.mp3"})).To(Succeed()) + + Expect(mr.SetRating(3, newID)).To(Succeed()) + + user2Ctx := request.WithUser(GinkgoT().Context(), regularUser) + user2Repo := NewMediaFileRepository(user2Ctx, GetDBXBuilder()) + Expect(user2Repo.SetRating(5, newID)).To(Succeed()) + + mf, err := mr.Get(newID) + Expect(err).ToNot(HaveOccurred()) + Expect(mf.AverageRating).To(Equal(4.0)) + + _, _ = raw.executeSQL(squirrel.Delete("annotation").Where(squirrel.Eq{"item_id": newID})) + _, _ = raw.executeSQL(squirrel.Delete("media_file").Where(squirrel.Eq{"id": newID})) + }) + + It("excludes zero ratings from average calculation", func() { + newID := id.NewRandom() + Expect(mr.Put(&model.MediaFile{LibraryID: 1, ID: newID, Path: "/test/zero-excluded.mp3"})).To(Succeed()) + + Expect(mr.SetRating(4, newID)).To(Succeed()) + + user2Ctx := request.WithUser(GinkgoT().Context(), regularUser) + user2Repo := NewMediaFileRepository(user2Ctx, GetDBXBuilder()) + Expect(user2Repo.SetRating(0, newID)).To(Succeed()) + + mf, err := mr.Get(newID) + Expect(err).ToNot(HaveOccurred()) + Expect(mf.AverageRating).To(Equal(4.0)) + + _, _ = raw.executeSQL(squirrel.Delete("annotation").Where(squirrel.Eq{"item_id": newID})) + _, _ = raw.executeSQL(squirrel.Delete("media_file").Where(squirrel.Eq{"id": newID})) + }) + }) + It("preserves play date if and only if provided date is older", func() { id := "incplay.playdate" Expect(mr.Put(&model.MediaFile{LibraryID: 1, ID: id})).To(BeNil()) @@ -203,7 +374,7 @@ var _ = Describe("MediaRepository", func() { // Update "Old Song": created long ago, updated recently _, err := db.Update("media_file", - map[string]interface{}{ + map[string]any{ "created_at": oldTime, "updated_at": newTime, }, @@ -212,7 +383,7 @@ var _ = Describe("MediaRepository", func() { // Update "Middle Song": created and updated at the same middle time _, err = db.Update("media_file", - map[string]interface{}{ + map[string]any{ "created_at": middleTime, "updated_at": middleTime, }, @@ -221,7 +392,7 @@ var _ = Describe("MediaRepository", func() { // Update "New Song": created recently, updated long ago _, err = db.Update("media_file", - map[string]interface{}{ + map[string]any{ "created_at": newTime, "updated_at": oldTime, }, @@ -311,10 +482,54 @@ var _ = Describe("MediaRepository", func() { }) }) + Context("Filters", func() { + var mfWithoutAnnotation model.MediaFile + + BeforeEach(func() { + mfWithoutAnnotation = model.MediaFile{ID: "no-annotation-file", LibraryID: 1, Path: "/test/no-annotation.mp3", Title: "No Annotation"} + Expect(mr.Put(&mfWithoutAnnotation)).To(Succeed()) + }) + + AfterEach(func() { + _ = mr.Delete(mfWithoutAnnotation.ID) + }) + + Describe("starred", func() { + It("false includes items without annotations", func() { + res, err := mr.(model.ResourceRepository).ReadAll(rest.QueryOptions{ + Filters: map[string]any{"starred": "false"}, + }) + Expect(err).ToNot(HaveOccurred()) + files := res.(model.MediaFiles) + + var found bool + for _, f := range files { + if f.ID == mfWithoutAnnotation.ID { + found = true + break + } + } + Expect(found).To(BeTrue(), "MediaFile without annotation should be included in starred=false filter") + }) + + It("true excludes items without annotations", func() { + res, err := mr.(model.ResourceRepository).ReadAll(rest.QueryOptions{ + Filters: map[string]any{"starred": "true"}, + }) + Expect(err).ToNot(HaveOccurred()) + files := res.(model.MediaFiles) + + for _, f := range files { + Expect(f.ID).ToNot(Equal(mfWithoutAnnotation.ID)) + } + }) + }) + }) + Describe("Search", func() { Context("text search", func() { It("finds media files by title", func() { - results, err := mr.Search("Antenna", 0, 10) + results, err := mr.Search("Antenna", model.QueryOptions{Max: 10}) Expect(err).ToNot(HaveOccurred()) Expect(results).To(HaveLen(3)) // songAntenna, songAntennaWithLyrics, songAntenna2 for _, result := range results { @@ -323,7 +538,7 @@ var _ = Describe("MediaRepository", func() { }) It("finds media files case insensitively", func() { - results, err := mr.Search("antenna", 0, 10) + results, err := mr.Search("antenna", model.QueryOptions{Max: 10}) Expect(err).ToNot(HaveOccurred()) Expect(results).To(HaveLen(3)) for _, result := range results { @@ -332,7 +547,7 @@ var _ = Describe("MediaRepository", func() { }) It("returns empty result when no matches found", func() { - results, err := mr.Search("nonexistent", 0, 10) + results, err := mr.Search("nonexistent", model.QueryOptions{Max: 10}) Expect(err).ToNot(HaveOccurred()) Expect(results).To(BeEmpty()) }) @@ -365,7 +580,7 @@ var _ = Describe("MediaRepository", func() { }) It("finds media file by mbz_recording_id", func() { - results, err := mr.Search("550e8400-e29b-41d4-a716-446655440020", 0, 10) + results, err := mr.Search("550e8400-e29b-41d4-a716-446655440020", model.QueryOptions{Max: 10}) Expect(err).ToNot(HaveOccurred()) Expect(results).To(HaveLen(1)) Expect(results[0].ID).To(Equal("test-mbid-mediafile")) @@ -373,7 +588,7 @@ var _ = Describe("MediaRepository", func() { }) It("finds media file by mbz_release_track_id", func() { - results, err := mr.Search("550e8400-e29b-41d4-a716-446655440021", 0, 10) + results, err := mr.Search("550e8400-e29b-41d4-a716-446655440021", model.QueryOptions{Max: 10}) Expect(err).ToNot(HaveOccurred()) Expect(results).To(HaveLen(1)) Expect(results[0].ID).To(Equal("test-mbid-mediafile")) @@ -381,7 +596,7 @@ var _ = Describe("MediaRepository", func() { }) It("returns empty result when MBID is not found", func() { - results, err := mr.Search("550e8400-e29b-41d4-a716-446655440099", 0, 10) + results, err := mr.Search("550e8400-e29b-41d4-a716-446655440099", model.QueryOptions{Max: 10}) Expect(err).ToNot(HaveOccurred()) Expect(results).To(BeEmpty()) }) @@ -401,7 +616,7 @@ var _ = Describe("MediaRepository", func() { Expect(err).ToNot(HaveOccurred()) // Search never returns missing media files (hardcoded behavior) - results, err := mr.Search("550e8400-e29b-41d4-a716-446655440022", 0, 10) + results, err := mr.Search("550e8400-e29b-41d4-a716-446655440022", model.QueryOptions{Max: 10}) Expect(err).ToNot(HaveOccurred()) Expect(results).To(BeEmpty()) @@ -410,4 +625,132 @@ var _ = Describe("MediaRepository", func() { }) }) }) + + Describe("FindByPaths", func() { + // Test fixtures for Unicode and case-sensitivity tests + var testFiles []model.MediaFile + + BeforeEach(func() { + testFiles = []model.MediaFile{ + {ID: "findpath-1", LibraryID: 1, Path: "artist/Album/track.mp3", Title: "Track"}, + {ID: "findpath-2", LibraryID: 1, Path: "artist/Album/UPPER.mp3", Title: "Upper"}, + // Fullwidth uppercase: ＡＣＲＯＳＳ (U+FF21 U+FF23 U+FF32 U+FF2F U+FF33 U+FF33) + {ID: "findpath-3", LibraryID: 1, Path: "plex/02 - ＡＣＲＯＳＳ.flac", Title: "Fullwidth"}, + // French diacritic: è (U+00E8, can decompose to e + combining grave) + {ID: "findpath-4", LibraryID: 1, Path: "artist/Michèle/song.mp3", Title: "French"}, + } + for _, mf := range testFiles { + Expect(mr.Put(&mf)).To(Succeed()) + } + }) + + AfterEach(func() { + for _, mf := range testFiles { + _ = mr.Delete(mf.ID) + } + }) + + It("finds files by exact path", func() { + results, err := mr.FindByPaths([]string{"1:artist/Album/track.mp3"}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].ID).To(Equal("findpath-1")) + }) + + It("finds files case-insensitively for ASCII characters (NOCASE)", func() { + // SQLite's COLLATE NOCASE handles ASCII case-insensitivity + results, err := mr.FindByPaths([]string{"1:ARTIST/ALBUM/TRACK.MP3"}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].ID).To(Equal("findpath-1")) + }) + + It("finds fullwidth characters only with exact case match (SQLite NOCASE limitation)", func() { + // SQLite's NOCASE does NOT handle fullwidth uppercase/lowercase equivalence + // The DB has fullwidth uppercase ＡＣＲＯＳＳ, searching with exact match should work + results, err := mr.FindByPaths([]string{"1:plex/02 - ＡＣＲＯＳＳ.flac"}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].ID).To(Equal("findpath-3")) + + // Searching with fullwidth lowercase ａｃｒｏｓｓ should NOT match + // (this is the SQLite limitation that requires exact matching for non-ASCII) + results, err = mr.FindByPaths([]string{"1:plex/02 - ａｃｒｏｓｓ.flac"}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(BeEmpty()) + }) + + It("returns multiple files when querying multiple paths", func() { + results, err := mr.FindByPaths([]string{ + "1:artist/Album/track.mp3", + "1:artist/Album/UPPER.mp3", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(2)) + }) + + It("returns empty slice for non-existent paths", func() { + results, err := mr.FindByPaths([]string{"1:nonexistent/path.mp3"}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(BeEmpty()) + }) + + It("returns empty slice for empty input", func() { + results, err := mr.FindByPaths([]string{}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(BeEmpty()) + }) + + It("handles library-qualified paths correctly", func() { + // Library 1 should find the file + results, err := mr.FindByPaths([]string{"1:artist/Album/track.mp3"}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + + // Library 2 should NOT find it (file is in library 1) + results, err = mr.FindByPaths([]string{"2:artist/Album/track.mp3"}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(BeEmpty()) + }) + }) + + Describe("wrapMediaFileCursor", func() { + It("does not panic when the cursor yields a dbMediaFile with nil MediaFile", func() { + // Simulate what queryWithStableResults does on the rows.Err() path: + // it yields a zero-value dbMediaFile (where MediaFile is nil) with an error. + dbErr := fmt.Errorf("database is locked") + cursor := func(yield func(dbMediaFile, error) bool) { + var empty dbMediaFile // MediaFile pointer is nil + yield(empty, dbErr) + } + + // wrapMediaFileCursor should handle the nil MediaFile without panicking + wrappedCursor := wrapMediaFileCursor(cursor) + var gotErr error + Expect(func() { + for _, err := range wrappedCursor { + gotErr = err + } + }).ToNot(Panic()) + Expect(gotErr).To(HaveOccurred()) + Expect(gotErr.Error()).To(ContainSubstring("unexpected nil mediafile")) + Expect(errors.Is(gotErr, dbErr)).To(BeTrue(), "should wrap the original cursor error") + }) + + It("yields mediafiles from a valid cursor", func() { + mf := &model.MediaFile{ID: "mf1", Title: "Test"} + cursor := func(yield func(dbMediaFile, error) bool) { + yield(dbMediaFile{MediaFile: mf}, nil) + } + + wrappedCursor := wrapMediaFileCursor(cursor) + var mediafiles []model.MediaFile + for m, err := range wrappedCursor { + Expect(err).ToNot(HaveOccurred()) + mediafiles = append(mediafiles, m) + } + Expect(mediafiles).To(HaveLen(1)) + Expect(mediafiles[0].ID).To(Equal("mf1")) + }) + }) }) diff --git a/persistence/persistence.go b/persistence/persistence.go index ac607f85f..83211bdd5 100644 --- a/persistence/persistence.go +++ b/persistence/persistence.go @@ -89,7 +89,15 @@ func (s *SQLStore) ScrobbleBuffer(ctx context.Context) model.ScrobbleBufferRepos return NewScrobbleBufferRepository(ctx, s.getDBXBuilder()) } -func (s *SQLStore) Resource(ctx context.Context, m interface{}) model.ResourceRepository { +func (s *SQLStore) Scrobble(ctx context.Context) model.ScrobbleRepository { + return NewScrobbleRepository(ctx, s.getDBXBuilder()) +} + +func (s *SQLStore) Plugin(ctx context.Context) model.PluginRepository { + return NewPluginRepository(ctx, s.getDBXBuilder()) +} + +func (s *SQLStore) Resource(ctx context.Context, m any) model.ResourceRepository { switch m.(type) { case model.User: return s.User(ctx).(model.ResourceRepository) @@ -113,6 +121,8 @@ func (s *SQLStore) Resource(ctx context.Context, m interface{}) model.ResourceRe return s.Share(ctx).(model.ResourceRepository) case model.Tag: return s.Tag(ctx).(model.ResourceRepository) + case model.Plugin: + return s.Plugin(ctx).(model.ResourceRepository) } log.Error("Resource not implemented", "model", reflect.TypeOf(m).Name()) return nil @@ -157,7 +167,7 @@ func (s *SQLStore) WithTxImmediate(block func(tx model.DataStore) error, scope . }, scope...) } -func (s *SQLStore) GC(ctx context.Context) error { +func (s *SQLStore) GC(ctx context.Context, libraryIDs ...int) error { trace := func(ctx context.Context, msg string, f func() error) func() error { return func() error { start := time.Now() @@ -167,11 +177,17 @@ func (s *SQLStore) GC(ctx context.Context) error { } } + // If libraryIDs are provided, scope operations to those libraries where possible + scoped := len(libraryIDs) > 0 + if scoped { + log.Debug(ctx, "GC: Running selective garbage collection", "libraryIDs", libraryIDs) + } + err := run.Sequentially( - trace(ctx, "purge empty albums", func() error { return s.Album(ctx).(*albumRepository).purgeEmpty() }), + trace(ctx, "purge empty albums", func() error { return s.Album(ctx).(*albumRepository).purgeEmpty(libraryIDs...) }), trace(ctx, "purge empty artists", func() error { return s.Artist(ctx).(*artistRepository).purgeEmpty() }), trace(ctx, "mark missing artists", func() error { return s.Artist(ctx).(*artistRepository).markMissing() }), - trace(ctx, "purge empty folders", func() error { return s.Folder(ctx).(*folderRepository).purgeEmpty() }), + trace(ctx, "purge empty folders", func() error { return s.Folder(ctx).(*folderRepository).purgeEmpty(libraryIDs...) }), trace(ctx, "clean album annotations", func() error { return s.Album(ctx).(*albumRepository).cleanAnnotations() }), trace(ctx, "clean artist annotations", func() error { return s.Artist(ctx).(*artistRepository).cleanAnnotations() }), trace(ctx, "clean media file annotations", func() error { return s.MediaFile(ctx).(*mediaFileRepository).cleanAnnotations() }), diff --git a/persistence/persistence_suite_test.go b/persistence/persistence_suite_test.go index 1007d84fe..3ed443129 100644 --- a/persistence/persistence_suite_test.go +++ b/persistence/persistence_suite_test.go @@ -5,6 +5,7 @@ import ( "path/filepath" "testing" + "github.com/Masterminds/squirrel" _ "github.com/mattn/go-sqlite3" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/db" @@ -56,12 +57,22 @@ func al(al model.Album) model.Album { return al } +func alWithTags(a model.Album, tags model.Tags) model.Album { + a = al(a) + a.Tags = tags + return a +} + var ( - artistKraftwerk = model.Artist{ID: "2", Name: "Kraftwerk", OrderArtistName: "kraftwerk"} - artistBeatles = model.Artist{ID: "3", Name: "The Beatles", OrderArtistName: "beatles"} - testArtists = model.Artists{ + artistKraftwerk = model.Artist{ID: "2", Name: "Kraftwerk", OrderArtistName: "kraftwerk"} + artistBeatles = model.Artist{ID: "3", Name: "The Beatles", OrderArtistName: "beatles"} + artistCJK = model.Artist{ID: "4", Name: "シートベルツ", SortArtistName: "Seatbelts", OrderArtistName: "seatbelts"} + artistPunctuation = model.Artist{ID: "5", Name: "The Roots", OrderArtistName: "roots"} + testArtists = model.Artists{ artistKraftwerk, artistBeatles, + artistCJK, + artistPunctuation, } ) @@ -69,10 +80,19 @@ var ( albumSgtPeppers = al(model.Album{ID: "101", Name: "Sgt Peppers", AlbumArtist: "The Beatles", OrderAlbumName: "sgt peppers", AlbumArtistID: "3", EmbedArtPath: p("/beatles/1/sgt/a day.mp3"), SongCount: 1, MaxYear: 1967}) albumAbbeyRoad = al(model.Album{ID: "102", Name: "Abbey Road", AlbumArtist: "The Beatles", OrderAlbumName: "abbey road", AlbumArtistID: "3", EmbedArtPath: p("/beatles/1/come together.mp3"), SongCount: 1, MaxYear: 1969}) albumRadioactivity = al(model.Album{ID: "103", Name: "Radioactivity", AlbumArtist: "Kraftwerk", OrderAlbumName: "radioactivity", AlbumArtistID: "2", EmbedArtPath: p("/kraft/radio/radio.mp3"), SongCount: 2}) - testAlbums = model.Albums{ + albumMultiDisc = al(model.Album{ID: "104", Name: "Multi Disc Album", AlbumArtist: "Test Artist", OrderAlbumName: "multi disc album", AlbumArtistID: "1", EmbedArtPath: p("/test/multi/disc1/track1.mp3"), SongCount: 4}) + albumCJK = al(model.Album{ID: "105", Name: "COWBOY BEBOP", AlbumArtist: "シートベルツ", OrderAlbumName: "cowboy bebop", AlbumArtistID: "4", EmbedArtPath: p("/seatbelts/cowboy-bebop/track1.mp3"), SongCount: 1}) + albumWithVersion = alWithTags(model.Album{ID: "106", Name: "Abbey Road", AlbumArtist: "The Beatles", OrderAlbumName: "abbey road", AlbumArtistID: "3", EmbedArtPath: p("/beatles/2/come together.mp3"), SongCount: 1, MaxYear: 2019}, + model.Tags{model.TagAlbumVersion: {"Deluxe Edition"}}) + albumPunctuation = al(model.Album{ID: "107", Name: "Things Fall Apart", AlbumArtist: "The Roots", OrderAlbumName: "things fall apart", AlbumArtistID: "5", EmbedArtPath: p("/roots/things/track1.mp3"), SongCount: 1}) + testAlbums = model.Albums{ albumSgtPeppers, albumAbbeyRoad, albumRadioactivity, + albumMultiDisc, + albumCJK, + albumWithVersion, + albumPunctuation, } ) @@ -94,13 +114,28 @@ var ( Lyrics: `[{"lang":"xxx","line":[{"value":"This is a set of lyrics"}],"synced":false}]`, }) songAntenna2 = mf(model.MediaFile{ID: "1006", Title: "Antenna", ArtistID: "2", Artist: "Kraftwerk", AlbumID: "103"}) - testSongs = model.MediaFiles{ + // Multi-disc album tracks (intentionally out of order to test sorting) + songDisc2Track11 = mf(model.MediaFile{ID: "2001", Title: "Disc 2 Track 11", ArtistID: "1", Artist: "Test Artist", AlbumID: "104", Album: "Multi Disc Album", DiscNumber: 2, TrackNumber: 11, Path: p("/test/multi/disc2/track11.mp3"), OrderAlbumName: "multi disc album", OrderArtistName: "test artist"}) + songDisc1Track01 = mf(model.MediaFile{ID: "2002", Title: "Disc 1 Track 1", ArtistID: "1", Artist: "Test Artist", AlbumID: "104", Album: "Multi Disc Album", DiscNumber: 1, TrackNumber: 1, Path: p("/test/multi/disc1/track1.mp3"), OrderAlbumName: "multi disc album", OrderArtistName: "test artist"}) + songDisc2Track01 = mf(model.MediaFile{ID: "2003", Title: "Disc 2 Track 1", ArtistID: "1", Artist: "Test Artist", AlbumID: "104", Album: "Multi Disc Album", DiscNumber: 2, TrackNumber: 1, Path: p("/test/multi/disc2/track1.mp3"), OrderAlbumName: "multi disc album", OrderArtistName: "test artist"}) + songDisc1Track02 = mf(model.MediaFile{ID: "2004", Title: "Disc 1 Track 2", ArtistID: "1", Artist: "Test Artist", AlbumID: "104", Album: "Multi Disc Album", DiscNumber: 1, TrackNumber: 2, Path: p("/test/multi/disc1/track2.mp3"), OrderAlbumName: "multi disc album", OrderArtistName: "test artist"}) + songCJK = mf(model.MediaFile{ID: "3001", Title: "プラチナ・ジェット", ArtistID: "4", Artist: "シートベルツ", AlbumID: "105", Album: "COWBOY BEBOP", Path: p("/seatbelts/cowboy-bebop/track1.mp3")}) + songVersioned = mf(model.MediaFile{ID: "3002", Title: "Come Together", ArtistID: "3", Artist: "The Beatles", AlbumID: "106", Album: "Abbey Road", Path: p("/beatles/2/come together.mp3")}) + songPunctuation = mf(model.MediaFile{ID: "3003", Title: "!!!!!!!", ArtistID: "5", Artist: "The Roots", AlbumID: "107", Album: "Things Fall Apart", Path: p("/roots/things/track1.mp3")}) + testSongs = model.MediaFiles{ songDayInALife, songComeTogether, songRadioactivity, songAntenna, songAntennaWithLyrics, songAntenna2, + songDisc2Track11, + songDisc1Track01, + songDisc2Track01, + songDisc1Track02, + songCJK, + songVersioned, + songPunctuation, } ) @@ -119,7 +154,8 @@ var ( var ( adminUser = model.User{ID: "userid", UserName: "userid", Name: "admin", Email: "admin@email.com", IsAdmin: true} regularUser = model.User{ID: "2222", UserName: "regular-user", Name: "Regular User", Email: "regular@example.com"} - testUsers = model.Users{adminUser, regularUser} + thirdUser = model.User{ID: "3333", UserName: "third-user", Name: "Third User", Email: "third@example.com"} + testUsers = model.Users{adminUser, regularUser, thirdUser} ) func p(path string) string { @@ -176,6 +212,27 @@ var _ = BeforeSuite(func() { } } + // Populate album_artists based on the AlbumArtistID relationships in testAlbums + artistIDs := map[string]bool{} + for _, a := range testArtists { + artistIDs[a.ID] = true + } + for i := range testAlbums { + a := testAlbums[i] + if a.AlbumArtistID == "" || !artistIDs[a.AlbumArtistID] { + continue + } + _, err := alr.executeSQL(squirrel.Insert("album_artists").SetMap(map[string]any{ + "album_id": a.ID, + "artist_id": a.AlbumArtistID, + "role": "artist", + "sub_role": "", + })) + if err != nil { + panic(err) + } + } + mr := NewMediaFileRepository(ctx, conn) for i := range testSongs { err := mr.Put(&testSongs[i]) diff --git a/persistence/player_repository.go b/persistence/player_repository.go index 73c820753..6c8339378 100644 --- a/persistence/player_repository.go +++ b/persistence/player_repository.go @@ -103,14 +103,14 @@ func (r *playerRepository) Count(options ...rest.QueryOptions) (int64, error) { return r.CountAll(r.parseRestOptions(r.ctx, options...)) } -func (r *playerRepository) Read(id string) (interface{}, error) { +func (r *playerRepository) Read(id string) (any, error) { sel := r.newRestSelect().Where(Eq{"player.id": id}) var res model.Player err := r.queryOne(sel, &res) return &res, err } -func (r *playerRepository) ReadAll(options ...rest.QueryOptions) (interface{}, error) { +func (r *playerRepository) ReadAll(options ...rest.QueryOptions) (any, error) { sel := r.newRestSelect(r.parseRestOptions(r.ctx, options...)) res := model.Players{} err := r.queryAll(sel, &res) @@ -121,7 +121,7 @@ func (r *playerRepository) EntityName() string { return "player" } -func (r *playerRepository) NewInstance() interface{} { +func (r *playerRepository) NewInstance() any { return &model.Player{} } @@ -130,7 +130,7 @@ func (r *playerRepository) isPermitted(p *model.Player) bool { return u.IsAdmin || p.UserId == u.ID } -func (r *playerRepository) Save(entity interface{}) (string, error) { +func (r *playerRepository) Save(entity any) (string, error) { t := entity.(*model.Player) if !r.isPermitted(t) { return "", rest.ErrPermissionDenied @@ -142,7 +142,7 @@ func (r *playerRepository) Save(entity interface{}) (string, error) { return id, err } -func (r *playerRepository) Update(id string, entity interface{}, cols ...string) error { +func (r *playerRepository) Update(id string, entity any, cols ...string) error { t := entity.(*model.Player) t.ID = id if !r.isPermitted(t) { diff --git a/persistence/playlist_repository.go b/persistence/playlist_repository.go index 046284e1f..8d1bbe0f8 100644 --- a/persistence/playlist_repository.go +++ b/persistence/playlist_repository.go @@ -61,14 +61,14 @@ func NewPlaylistRepository(ctx context.Context, db dbx.Builder) model.PlaylistRe return r } -func playlistFilter(_ string, value interface{}) Sqlizer { +func playlistFilter(_ string, value any) Sqlizer { return Or{ substringFilter("playlist.name", value), substringFilter("playlist.comment", value), } } -func smartPlaylistFilter(string, interface{}) Sqlizer { +func smartPlaylistFilter(string, any) Sqlizer { return Or{ Eq{"rules": ""}, Eq{"rules": nil}, @@ -96,16 +96,6 @@ func (r *playlistRepository) Exists(id string) (bool, error) { } func (r *playlistRepository) Delete(id string) error { - usr := loggedUser(r.ctx) - if !usr.IsAdmin { - pls, err := r.Get(id) - if err != nil { - return err - } - if pls.OwnerID != usr.ID { - return rest.ErrPermissionDenied - } - } return r.delete(And{Eq{"id": id}, r.userFilter()}) } @@ -113,14 +103,6 @@ func (r *playlistRepository) Put(p *model.Playlist) error { pls := dbPlaylist{Playlist: *p} if pls.ID == "" { pls.CreatedAt = time.Now() - } else { - ok, err := r.Exists(pls.ID) - if err != nil { - return err - } - if !ok { - return model.ErrNotAuthorized - } } pls.UpdatedAt = time.Now() @@ -132,7 +114,6 @@ func (r *playlistRepository) Put(p *model.Playlist) error { if p.IsSmartPlaylist() { // Do not update tracks at this point, as it may take a long time and lock the DB, breaking the scan process - //r.refreshSmartPlaylist(p) return nil } // Only update tracks if they were specified @@ -260,10 +241,44 @@ func (r *playlistRepository) refreshSmartPlaylist(pls *model.Playlist) bool { } sq := Select("row_number() over (order by "+rules.OrderBy()+") as id", "'"+pls.ID+"' as playlist_id", "media_file.id as media_file_id"). - From("media_file").LeftJoin("annotation on (" + - "annotation.item_id = media_file.id" + - " AND annotation.item_type = 'media_file'" + - " AND annotation.user_id = '" + usr.ID + "')") + From("media_file").LeftJoin("annotation on ("+ + "annotation.item_id = media_file.id"+ + " AND annotation.item_type = 'media_file'"+ + " AND annotation.user_id = ?)", usr.ID) + + // Conditionally join album/artist annotation tables only when referenced by criteria or sort + requiredJoins := rules.RequiredJoins() + sq = r.addSmartPlaylistAnnotationJoins(sq, requiredJoins, usr.ID) + + // Only include media files from libraries the user has access to + sq = r.applyLibraryFilter(sq, "media_file") + + // Resolve percentage-based limit to an absolute number before applying criteria + if rules.IsPercentageLimit() { + // Use only expression-based joins for the COUNT query (sort joins are unnecessary) + exprJoins := rules.ExpressionJoins() + countSq := Select("count(*) as count").From("media_file"). + LeftJoin("annotation on ("+ + "annotation.item_id = media_file.id"+ + " AND annotation.item_type = 'media_file'"+ + " AND annotation.user_id = ?)", usr.ID) + countSq = r.addSmartPlaylistAnnotationJoins(countSq, exprJoins, usr.ID) + countSq = r.applyLibraryFilter(countSq, "media_file") + countSq = countSq.Where(rules) + + var res struct{ Count int64 } + err = r.queryOne(countSq, &res) + if err != nil { + log.Error(r.ctx, "Error counting matching tracks for percentage limit", "playlist", pls.Name, "id", pls.ID, err) + return false + } + resolvedLimit := rules.EffectiveLimit(res.Count) + log.Debug(r.ctx, "Resolved percentage limit", "playlist", pls.Name, "percent", rules.LimitPercent, "totalMatching", res.Count, "resolvedLimit", resolvedLimit) + rules.Limit = resolvedLimit + rules.LimitPercent = 0 + } + + // Apply the criteria rules sq = r.addCriteria(sq, rules) insSql := Insert("playlist_tracks").Columns("id", "playlist_id", "media_file_id").Select(sq) _, err = r.executeSQL(insSql) @@ -280,18 +295,37 @@ func (r *playlistRepository) refreshSmartPlaylist(pls *model.Playlist) bool { } // Update when the playlist was last refreshed (for cache purposes) - updSql := Update(r.tableName).Set("evaluated_at", time.Now()).Where(Eq{"id": pls.ID}) + now := time.Now() + updSql := Update(r.tableName).Set("evaluated_at", now).Where(Eq{"id": pls.ID}) _, err = r.executeSQL(updSql) if err != nil { log.Error(r.ctx, "Error updating smart playlist", "playlist", pls.Name, "id", pls.ID, err) return false } + pls.EvaluatedAt = &now + log.Debug(r.ctx, "Refreshed playlist", "playlist", pls.Name, "id", pls.ID, "numTracks", pls.SongCount, "elapsed", time.Since(start)) return true } +func (r *playlistRepository) addSmartPlaylistAnnotationJoins(sq SelectBuilder, joins criteria.JoinType, userID string) SelectBuilder { + if joins.Has(criteria.JoinAlbumAnnotation) { + sq = sq.LeftJoin("annotation AS album_annotation ON ("+ + "album_annotation.item_id = media_file.album_id"+ + " AND album_annotation.item_type = 'album'"+ + " AND album_annotation.user_id = ?)", userID) + } + if joins.Has(criteria.JoinArtistAnnotation) { + sq = sq.LeftJoin("annotation AS artist_annotation ON ("+ + "artist_annotation.item_id = media_file.artist_id"+ + " AND artist_annotation.item_type = 'artist'"+ + " AND artist_annotation.user_id = ?)", userID) + } + return sq +} + func (r *playlistRepository) addCriteria(sql SelectBuilder, c criteria.Criteria) SelectBuilder { sql = sql.Where(c) if c.Limit > 0 { @@ -312,10 +346,6 @@ func (r *playlistRepository) updateTracks(id string, tracks model.MediaFiles) er } func (r *playlistRepository) updatePlaylist(playlistId string, mediaFileIds []string) error { - if !r.isWritable(playlistId) { - return rest.ErrPermissionDenied - } - // Remove old tracks del := Delete("playlist_tracks").Where(Eq{"playlist_id": playlistId}) _, err := r.executeSQL(del) @@ -388,6 +418,7 @@ func (r *playlistRepository) loadTracks(sel SelectBuilder, id string) (model.Pla "coalesce(play_count, 0) as play_count", "play_date", "coalesce(rating, 0) as rating", + "rated_at", "f.*", "playlist_tracks.*", "library.path as library_path", @@ -412,11 +443,11 @@ func (r *playlistRepository) Count(options ...rest.QueryOptions) (int64, error) return r.CountAll(r.parseRestOptions(r.ctx, options...)) } -func (r *playlistRepository) Read(id string) (interface{}, error) { +func (r *playlistRepository) Read(id string) (any, error) { return r.Get(id) } -func (r *playlistRepository) ReadAll(options ...rest.QueryOptions) (interface{}, error) { +func (r *playlistRepository) ReadAll(options ...rest.QueryOptions) (any, error) { return r.GetAll(r.parseRestOptions(r.ctx, options...)) } @@ -424,14 +455,13 @@ func (r *playlistRepository) EntityName() string { return "playlist" } -func (r *playlistRepository) NewInstance() interface{} { +func (r *playlistRepository) NewInstance() any { return &model.Playlist{} } -func (r *playlistRepository) Save(entity interface{}) (string, error) { +func (r *playlistRepository) Save(entity any) (string, error) { pls := entity.(*model.Playlist) - pls.OwnerID = loggedUser(r.ctx).ID - pls.ID = "" // Make sure we don't override an existing playlist + pls.ID = "" // Force new creation err := r.Put(pls) if err != nil { return "", err @@ -439,26 +469,11 @@ func (r *playlistRepository) Save(entity interface{}) (string, error) { return pls.ID, err } -func (r *playlistRepository) Update(id string, entity interface{}, cols ...string) error { +func (r *playlistRepository) Update(id string, entity any, cols ...string) error { pls := dbPlaylist{Playlist: *entity.(*model.Playlist)} - current, err := r.Get(id) - if err != nil { - return err - } - usr := loggedUser(r.ctx) - if !usr.IsAdmin { - // Only the owner can update the playlist - if current.OwnerID != usr.ID { - return rest.ErrPermissionDenied - } - // Regular users can't change the ownership of a playlist - if pls.OwnerID != "" && pls.OwnerID != usr.ID { - return rest.ErrPermissionDenied - } - } pls.ID = id pls.UpdatedAt = time.Now() - _, err = r.put(id, pls, append(cols, "updatedAt")...) + _, err := r.put(id, pls, append(cols, "updatedAt")...) if errors.Is(err, model.ErrNotFound) { return rest.ErrNotFound } @@ -498,23 +513,31 @@ func (r *playlistRepository) removeOrphans() error { return nil } +// renumber updates the position of all tracks in the playlist to be sequential starting from 1, ordered by their +// current position. This is needed after removing orphan tracks, to ensure there are no gaps in the track numbering. +// The two-step approach (negate then reassign via CTE) avoids UNIQUE constraint violations on (playlist_id, id). func (r *playlistRepository) renumber(id string) error { - var ids []string - sq := Select("media_file_id").From("playlist_tracks").Where(Eq{"playlist_id": id}).OrderBy("id") - err := r.queryAllSlice(sq, &ids) + // Step 1: Negate all IDs to clear the positive ID space + _, err := r.executeSQL(Expr( + `UPDATE playlist_tracks SET id = -id WHERE playlist_id = ? AND id > 0`, id)) if err != nil { return err } - return r.updatePlaylist(id, ids) -} - -func (r *playlistRepository) isWritable(playlistId string) bool { - usr := loggedUser(r.ctx) - if usr.IsAdmin { - return true + // Step 2: Assign new sequential positive IDs using UPDATE...FROM with a CTE. + // The CTE is fully materialized before the UPDATE begins, avoiding self-referencing issues. + // ORDER BY id DESC restores original order since IDs are now negative. + _, err = r.executeSQL(Expr( + `WITH new_ids AS ( + SELECT rowid as rid, ROW_NUMBER() OVER (ORDER BY id DESC) as new_id + FROM playlist_tracks WHERE playlist_id = ? + ) + UPDATE playlist_tracks SET id = new_ids.new_id + FROM new_ids + WHERE playlist_tracks.rowid = new_ids.rid AND playlist_tracks.playlist_id = ?`, id, id)) + if err != nil { + return err } - pls, err := r.Get(playlistId) - return err == nil && pls.OwnerID == usr.ID + return r.refreshCounters(&model.Playlist{ID: id}) } var _ model.PlaylistRepository = (*playlistRepository)(nil) diff --git a/persistence/playlist_repository_test.go b/persistence/playlist_repository_test.go index 15ae438d9..c091cb32b 100644 --- a/persistence/playlist_repository_test.go +++ b/persistence/playlist_repository_test.go @@ -1,23 +1,24 @@ package persistence import ( - "context" "time" "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/criteria" "github.com/navidrome/navidrome/model/request" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" + "github.com/pocketbase/dbx" ) var _ = Describe("PlaylistRepository", func() { var repo model.PlaylistRepository BeforeEach(func() { - ctx := log.NewContext(context.TODO()) + ctx := log.NewContext(GinkgoT().Context()) ctx = request.WithUser(ctx, model.User{ID: "userid", UserName: "userid", IsAdmin: true}) repo = NewPlaylistRepository(ctx, GetDBXBuilder()) }) @@ -160,14 +161,23 @@ var _ = Describe("PlaylistRepository", func() { }) }) - // TODO Validate these tests - XContext("child smart playlists", func() { - When("refresh day has expired", func() { + Context("child smart playlists", func() { + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + }) + + When("refresh delay has expired", func() { It("should refresh tracks for smart playlist referenced in parent smart playlist criteria", func() { conf.Server.SmartPlaylistRefreshDelay = -1 * time.Second - nestedPls := model.Playlist{Name: "Nested", OwnerID: "userid", Rules: rules} + childRules := &criteria.Criteria{ + Expression: criteria.All{ + criteria.Contains{"title": "Day"}, + }, + } + nestedPls := model.Playlist{Name: "Nested", OwnerID: "userid", Public: true, Rules: childRules} Expect(repo.Put(&nestedPls)).To(Succeed()) + DeferCleanup(func() { _ = repo.Delete(nestedPls.ID) }) parentPls := model.Playlist{Name: "Parent", OwnerID: "userid", Rules: &criteria.Criteria{ Expression: criteria.All{ @@ -175,48 +185,524 @@ var _ = Describe("PlaylistRepository", func() { }, }} Expect(repo.Put(&parentPls)).To(Succeed()) + DeferCleanup(func() { _ = repo.Delete(parentPls.ID) }) + // Nested playlist has not been evaluated yet nestedPlsRead, err := repo.Get(nestedPls.ID) Expect(err).ToNot(HaveOccurred()) + Expect(nestedPlsRead.EvaluatedAt).To(BeNil()) - _, err = repo.GetWithTracks(parentPls.ID, true, false) + // Getting parent with refresh should recursively refresh the nested playlist + pls, err := repo.GetWithTracks(parentPls.ID, true, false) Expect(err).ToNot(HaveOccurred()) + Expect(pls.EvaluatedAt).ToNot(BeNil()) + Expect(*pls.EvaluatedAt).To(BeTemporally("~", time.Now(), 2*time.Second)) - // Check that the nested playlist was refreshed by parent get by verifying evaluatedAt is updated since first nestedPls get + // Parent should have tracks from the nested playlist + Expect(pls.Tracks).To(HaveLen(1)) + Expect(pls.Tracks[0].MediaFileID).To(Equal(songDayInALife.ID)) + + // Nested playlist should now have been refreshed (EvaluatedAt set) nestedPlsAfterParentGet, err := repo.Get(nestedPls.ID) Expect(err).ToNot(HaveOccurred()) - - Expect(*nestedPlsAfterParentGet.EvaluatedAt).To(BeTemporally(">", *nestedPlsRead.EvaluatedAt)) + Expect(nestedPlsAfterParentGet.EvaluatedAt).ToNot(BeNil()) + Expect(*nestedPlsAfterParentGet.EvaluatedAt).To(BeTemporally("~", time.Now(), 2*time.Second)) }) }) - When("refresh day has not expired", func() { + When("refresh delay has not expired", func() { It("should NOT refresh tracks for smart playlist referenced in parent smart playlist criteria", func() { conf.Server.SmartPlaylistRefreshDelay = 1 * time.Hour + childEvaluatedAt := time.Now().Add(-30 * time.Minute) - nestedPls := model.Playlist{Name: "Nested", OwnerID: "userid", Rules: rules} + childRules := &criteria.Criteria{ + Expression: criteria.All{ + criteria.Contains{"title": "Day"}, + }, + } + nestedPls := model.Playlist{Name: "Nested", OwnerID: "userid", Public: true, Rules: childRules, EvaluatedAt: &childEvaluatedAt} Expect(repo.Put(&nestedPls)).To(Succeed()) + DeferCleanup(func() { _ = repo.Delete(nestedPls.ID) }) + // Parent has no EvaluatedAt, so it WILL refresh, but the child should not parentPls := model.Playlist{Name: "Parent", OwnerID: "userid", Rules: &criteria.Criteria{ Expression: criteria.All{ criteria.InPlaylist{"id": nestedPls.ID}, }, }} Expect(repo.Put(&parentPls)).To(Succeed()) + DeferCleanup(func() { _ = repo.Delete(parentPls.ID) }) nestedPlsRead, err := repo.Get(nestedPls.ID) Expect(err).ToNot(HaveOccurred()) - _, err = repo.GetWithTracks(parentPls.ID, true, false) + // Getting parent with refresh should NOT recursively refresh the nested playlist + parent, err := repo.GetWithTracks(parentPls.ID, true, false) Expect(err).ToNot(HaveOccurred()) - // Check that the nested playlist was not refreshed by parent get by verifying evaluatedAt is not updated since first nestedPls get + // Parent should have been refreshed (its EvaluatedAt was nil) + Expect(parent.EvaluatedAt).ToNot(BeNil()) + Expect(*parent.EvaluatedAt).To(BeTemporally("~", time.Now(), 2*time.Second)) + + // Nested playlist should NOT have been refreshed (still within delay window) nestedPlsAfterParentGet, err := repo.Get(nestedPls.ID) Expect(err).ToNot(HaveOccurred()) - + Expect(*nestedPlsAfterParentGet.EvaluatedAt).To(BeTemporally("~", childEvaluatedAt, time.Second)) Expect(*nestedPlsAfterParentGet.EvaluatedAt).To(Equal(*nestedPlsRead.EvaluatedAt)) }) }) }) }) + + Describe("Playlist Track Sorting", func() { + var testPlaylistID string + + AfterEach(func() { + if testPlaylistID != "" { + Expect(repo.Delete(testPlaylistID)).To(BeNil()) + testPlaylistID = "" + } + }) + + It("sorts tracks correctly by album (disc and track number)", func() { + By("creating a playlist with multi-disc album tracks in arbitrary order") + newPls := model.Playlist{Name: "Multi-Disc Test", OwnerID: "userid"} + // Add tracks in intentionally scrambled order + newPls.AddMediaFilesByID([]string{"2001", "2002", "2003", "2004"}) + Expect(repo.Put(&newPls)).To(Succeed()) + testPlaylistID = newPls.ID + + By("retrieving tracks sorted by album") + tracksRepo := repo.Tracks(newPls.ID, false) + tracks, err := tracksRepo.GetAll(model.QueryOptions{Sort: "album", Order: "asc"}) + Expect(err).ToNot(HaveOccurred()) + + By("verifying tracks are sorted by disc number then track number") + Expect(tracks).To(HaveLen(4)) + // Expected order: Disc 1 Track 1, Disc 1 Track 2, Disc 2 Track 1, Disc 2 Track 11 + Expect(tracks[0].MediaFileID).To(Equal("2002")) // Disc 1, Track 1 + Expect(tracks[1].MediaFileID).To(Equal("2004")) // Disc 1, Track 2 + Expect(tracks[2].MediaFileID).To(Equal("2003")) // Disc 2, Track 1 + Expect(tracks[3].MediaFileID).To(Equal("2001")) // Disc 2, Track 11 + }) + }) + + Describe("Smart Playlists with Album/Artist Annotation Criteria", func() { + var testPlaylistID string + + AfterEach(func() { + if testPlaylistID != "" { + _ = repo.Delete(testPlaylistID) + testPlaylistID = "" + } + }) + + It("matches tracks from starred albums using albumLoved", func() { + // albumRadioactivity (ID "103") is starred in test fixtures + // Songs in album 103: 1003, 1004, 1005, 1006 + rules := &criteria.Criteria{ + Expression: criteria.All{ + criteria.Is{"albumLoved": true}, + }, + } + newPls := model.Playlist{Name: "Starred Album Songs", OwnerID: "userid", Rules: rules} + Expect(repo.Put(&newPls)).To(Succeed()) + testPlaylistID = newPls.ID + + conf.Server.SmartPlaylistRefreshDelay = -1 * time.Second + pls, err := repo.GetWithTracks(newPls.ID, true, false) + Expect(err).ToNot(HaveOccurred()) + + trackIDs := make([]string, len(pls.Tracks)) + for i, t := range pls.Tracks { + trackIDs[i] = t.MediaFileID + } + Expect(trackIDs).To(ConsistOf("1003", "1004", "1005", "1006")) + }) + + It("matches tracks from starred artists using artistLoved", func() { + // artistBeatles (ID "3") is starred in test fixtures + // Songs with ArtistID "3": 1001, 1002, 3002 + rules := &criteria.Criteria{ + Expression: criteria.All{ + criteria.Is{"artistLoved": true}, + }, + } + newPls := model.Playlist{Name: "Starred Artist Songs", OwnerID: "userid", Rules: rules} + Expect(repo.Put(&newPls)).To(Succeed()) + testPlaylistID = newPls.ID + + conf.Server.SmartPlaylistRefreshDelay = -1 * time.Second + pls, err := repo.GetWithTracks(newPls.ID, true, false) + Expect(err).ToNot(HaveOccurred()) + + trackIDs := make([]string, len(pls.Tracks)) + for i, t := range pls.Tracks { + trackIDs[i] = t.MediaFileID + } + Expect(trackIDs).To(ConsistOf("1001", "1002", "3002")) + }) + + It("matches tracks with combined album and artist criteria", func() { + // albumLoved=true → songs from album 103 (1003, 1004, 1005, 1006) + // artistLoved=true → songs with artist 3 (1001, 1002) + // Using Any: union of both sets + rules := &criteria.Criteria{ + Expression: criteria.Any{ + criteria.Is{"albumLoved": true}, + criteria.Is{"artistLoved": true}, + }, + } + newPls := model.Playlist{Name: "Combined Album+Artist", OwnerID: "userid", Rules: rules} + Expect(repo.Put(&newPls)).To(Succeed()) + testPlaylistID = newPls.ID + + conf.Server.SmartPlaylistRefreshDelay = -1 * time.Second + pls, err := repo.GetWithTracks(newPls.ID, true, false) + Expect(err).ToNot(HaveOccurred()) + + trackIDs := make([]string, len(pls.Tracks)) + for i, t := range pls.Tracks { + trackIDs[i] = t.MediaFileID + } + Expect(trackIDs).To(ConsistOf("1001", "1002", "1003", "1004", "1005", "1006", "3002")) + }) + + It("returns no tracks when no albums/artists match", func() { + // No album has rating 5 in fixtures + rules := &criteria.Criteria{ + Expression: criteria.All{ + criteria.Is{"albumRating": 5}, + }, + } + newPls := model.Playlist{Name: "No Match", OwnerID: "userid", Rules: rules} + Expect(repo.Put(&newPls)).To(Succeed()) + testPlaylistID = newPls.ID + + conf.Server.SmartPlaylistRefreshDelay = -1 * time.Second + pls, err := repo.GetWithTracks(newPls.ID, true, false) + Expect(err).ToNot(HaveOccurred()) + + Expect(pls.Tracks).To(BeEmpty()) + }) + }) + + Describe("Smart Playlists with Tag Criteria", func() { + var mfRepo model.MediaFileRepository + var testPlaylistID string + var songWithGrouping, songWithoutGrouping model.MediaFile + + BeforeEach(func() { + ctx := log.NewContext(GinkgoT().Context()) + ctx = request.WithUser(ctx, model.User{ID: "userid", UserName: "userid", IsAdmin: true}) + mfRepo = NewMediaFileRepository(ctx, GetDBXBuilder()) + + // Register 'grouping' as a valid tag for smart playlists + criteria.AddTagNames([]string{"grouping"}) + + // Create a song with the grouping tag + songWithGrouping = model.MediaFile{ + ID: "test-grouping-1", + Title: "Song With Grouping", + Artist: "Test Artist", + ArtistID: "1", + Album: "Test Album", + AlbumID: "101", + Path: "/test/grouping/song1.mp3", + Tags: model.Tags{ + "grouping": []string{"My Crate"}, + }, + Participants: model.Participants{}, + LibraryID: 1, + Lyrics: "[]", + } + Expect(mfRepo.Put(&songWithGrouping)).To(Succeed()) + + // Create a song without the grouping tag + songWithoutGrouping = model.MediaFile{ + ID: "test-grouping-2", + Title: "Song Without Grouping", + Artist: "Test Artist", + ArtistID: "1", + Album: "Test Album", + AlbumID: "101", + Path: "/test/grouping/song2.mp3", + Tags: model.Tags{}, + Participants: model.Participants{}, + LibraryID: 1, + Lyrics: "[]", + } + Expect(mfRepo.Put(&songWithoutGrouping)).To(Succeed()) + }) + + AfterEach(func() { + if testPlaylistID != "" { + _ = repo.Delete(testPlaylistID) + testPlaylistID = "" + } + // Clean up test media files + _, _ = GetDBXBuilder().Delete("media_file", dbx.HashExp{"id": "test-grouping-1"}).Execute() + _, _ = GetDBXBuilder().Delete("media_file", dbx.HashExp{"id": "test-grouping-2"}).Execute() + }) + + It("matches tracks with a tag value using 'contains' with empty string (issue #4728 workaround)", func() { + By("creating a smart playlist that checks if grouping tag has any value") + // This is the workaround for issue #4728: using 'contains' with empty string + // generates SQL: value LIKE '%%' which matches any non-empty string + rules := &criteria.Criteria{ + Expression: criteria.All{ + criteria.Contains{"grouping": ""}, + }, + } + newPls := model.Playlist{Name: "Tracks with Grouping", OwnerID: "userid", Rules: rules} + Expect(repo.Put(&newPls)).To(Succeed()) + testPlaylistID = newPls.ID + + By("refreshing the smart playlist") + conf.Server.SmartPlaylistRefreshDelay = -1 * time.Second // Force refresh + pls, err := repo.GetWithTracks(newPls.ID, true, false) + Expect(err).ToNot(HaveOccurred()) + + By("verifying only the track with grouping tag is matched") + Expect(pls.Tracks).To(HaveLen(1)) + Expect(pls.Tracks[0].MediaFileID).To(Equal(songWithGrouping.ID)) + }) + + It("excludes tracks with a tag value using 'notContains' with empty string", func() { + By("creating a smart playlist that checks if grouping tag is NOT set") + rules := &criteria.Criteria{ + Expression: criteria.All{ + criteria.NotContains{"grouping": ""}, + }, + } + newPls := model.Playlist{Name: "Tracks without Grouping", OwnerID: "userid", Rules: rules} + Expect(repo.Put(&newPls)).To(Succeed()) + testPlaylistID = newPls.ID + + By("refreshing the smart playlist") + conf.Server.SmartPlaylistRefreshDelay = -1 * time.Second // Force refresh + pls, err := repo.GetWithTracks(newPls.ID, true, false) + Expect(err).ToNot(HaveOccurred()) + + By("verifying the track with grouping is NOT in the playlist") + for _, track := range pls.Tracks { + Expect(track.MediaFileID).ToNot(Equal(songWithGrouping.ID)) + } + + By("verifying the track without grouping IS in the playlist") + var foundWithoutGrouping bool + for _, track := range pls.Tracks { + if track.MediaFileID == songWithoutGrouping.ID { + foundWithoutGrouping = true + break + } + } + Expect(foundWithoutGrouping).To(BeTrue()) + }) + }) + + Describe("Track Deletion and Renumbering", func() { + var testPlaylistID string + + AfterEach(func() { + if testPlaylistID != "" { + Expect(repo.Delete(testPlaylistID)).To(BeNil()) + testPlaylistID = "" + } + }) + + // helper to get track positions and media file IDs + getTrackInfo := func(playlistID string) (ids []string, mediaFileIDs []string) { + pls, err := repo.GetWithTracks(playlistID, false, false) + Expect(err).ToNot(HaveOccurred()) + for _, t := range pls.Tracks { + ids = append(ids, t.ID) + mediaFileIDs = append(mediaFileIDs, t.MediaFileID) + } + return + } + + It("renumbers correctly after deleting a track from the middle", func() { + By("creating a playlist with 4 tracks") + newPls := model.Playlist{Name: "Renumber Test Middle", OwnerID: "userid"} + newPls.AddMediaFilesByID([]string{"1001", "1002", "1003", "1004"}) + Expect(repo.Put(&newPls)).To(Succeed()) + testPlaylistID = newPls.ID + + By("deleting the second track (position 2)") + tracksRepo := repo.Tracks(newPls.ID, false) + Expect(tracksRepo.Delete("2")).To(Succeed()) + + By("verifying remaining tracks are renumbered sequentially") + ids, mediaFileIDs := getTrackInfo(newPls.ID) + Expect(ids).To(Equal([]string{"1", "2", "3"})) + Expect(mediaFileIDs).To(Equal([]string{"1001", "1003", "1004"})) + }) + + It("renumbers correctly after deleting the first track", func() { + By("creating a playlist with 3 tracks") + newPls := model.Playlist{Name: "Renumber Test First", OwnerID: "userid"} + newPls.AddMediaFilesByID([]string{"1001", "1002", "1003"}) + Expect(repo.Put(&newPls)).To(Succeed()) + testPlaylistID = newPls.ID + + By("deleting the first track (position 1)") + tracksRepo := repo.Tracks(newPls.ID, false) + Expect(tracksRepo.Delete("1")).To(Succeed()) + + By("verifying remaining tracks are renumbered sequentially") + ids, mediaFileIDs := getTrackInfo(newPls.ID) + Expect(ids).To(Equal([]string{"1", "2"})) + Expect(mediaFileIDs).To(Equal([]string{"1002", "1003"})) + }) + + It("renumbers correctly after deleting the last track", func() { + By("creating a playlist with 3 tracks") + newPls := model.Playlist{Name: "Renumber Test Last", OwnerID: "userid"} + newPls.AddMediaFilesByID([]string{"1001", "1002", "1003"}) + Expect(repo.Put(&newPls)).To(Succeed()) + testPlaylistID = newPls.ID + + By("deleting the last track (position 3)") + tracksRepo := repo.Tracks(newPls.ID, false) + Expect(tracksRepo.Delete("3")).To(Succeed()) + + By("verifying remaining tracks are renumbered sequentially") + ids, mediaFileIDs := getTrackInfo(newPls.ID) + Expect(ids).To(Equal([]string{"1", "2"})) + Expect(mediaFileIDs).To(Equal([]string{"1001", "1002"})) + }) + }) + + Describe("Smart Playlists Library Filtering", func() { + var mfRepo model.MediaFileRepository + var testPlaylistID string + var lib2ID int + var restrictedUserID string + var uniqueLibPath string + + BeforeEach(func() { + db := GetDBXBuilder() + + // Generate unique IDs for this test run + uniqueSuffix := time.Now().Format("20060102150405.000") + restrictedUserID = "restricted-user-" + uniqueSuffix + uniqueLibPath = "/music/lib2-" + uniqueSuffix + + // Create a second library with unique name and path to avoid conflicts with other tests + _, err := db.DB().Exec("INSERT INTO library (name, path, created_at, updated_at) VALUES (?, ?, datetime('now'), datetime('now'))", "Library 2-"+uniqueSuffix, uniqueLibPath) + Expect(err).ToNot(HaveOccurred()) + err = db.DB().QueryRow("SELECT last_insert_rowid()").Scan(&lib2ID) + Expect(err).ToNot(HaveOccurred()) + + // Create a restricted user with access only to library 1 + _, err = db.DB().Exec("INSERT INTO user (id, user_name, name, is_admin, password, created_at, updated_at) VALUES (?, ?, 'Restricted User', false, 'pass', datetime('now'), datetime('now'))", restrictedUserID, restrictedUserID) + Expect(err).ToNot(HaveOccurred()) + _, err = db.DB().Exec("INSERT INTO user_library (user_id, library_id) VALUES (?, 1)", restrictedUserID) + Expect(err).ToNot(HaveOccurred()) + + // Create test media files in each library + ctx := log.NewContext(GinkgoT().Context()) + ctx = request.WithUser(ctx, model.User{ID: "userid", UserName: "userid", IsAdmin: true}) + mfRepo = NewMediaFileRepository(ctx, db) + + // Song in library 1 (accessible by restricted user) + songLib1 := model.MediaFile{ + ID: "lib1-song", + Title: "Song in Lib1", + Artist: "Test Artist", + ArtistID: "1", + Album: "Test Album", + AlbumID: "101", + Path: "/music/lib1/song.mp3", + LibraryID: 1, + Participants: model.Participants{}, + Tags: model.Tags{}, + Lyrics: "[]", + } + Expect(mfRepo.Put(&songLib1)).To(Succeed()) + + // Song in library 2 (NOT accessible by restricted user) + songLib2 := model.MediaFile{ + ID: "lib2-song", + Title: "Song in Lib2", + Artist: "Test Artist", + ArtistID: "1", + Album: "Test Album", + AlbumID: "101", + Path: uniqueLibPath + "/song.mp3", + LibraryID: lib2ID, + Participants: model.Participants{}, + Tags: model.Tags{}, + Lyrics: "[]", + } + Expect(mfRepo.Put(&songLib2)).To(Succeed()) + }) + + AfterEach(func() { + db := GetDBXBuilder() + if testPlaylistID != "" { + _ = repo.Delete(testPlaylistID) + testPlaylistID = "" + } + // Clean up test data + _, _ = db.Delete("media_file", dbx.HashExp{"id": "lib1-song"}).Execute() + _, _ = db.Delete("media_file", dbx.HashExp{"id": "lib2-song"}).Execute() + _, _ = db.Delete("user_library", dbx.HashExp{"user_id": restrictedUserID}).Execute() + _, _ = db.Delete("user", dbx.HashExp{"id": restrictedUserID}).Execute() + _, _ = db.DB().Exec("DELETE FROM library WHERE id = ?", lib2ID) + }) + + It("should only include tracks from libraries the user has access to (issue #4738)", func() { + db := GetDBXBuilder() + ctx := log.NewContext(GinkgoT().Context()) + + // Create the smart playlist as the restricted user + restrictedUser := model.User{ID: restrictedUserID, UserName: restrictedUserID, IsAdmin: false} + ctx = request.WithUser(ctx, restrictedUser) + restrictedRepo := NewPlaylistRepository(ctx, db) + + // Create a smart playlist that matches all songs + rules := &criteria.Criteria{ + Expression: criteria.All{ + criteria.Gt{"playCount": -1}, // Matches everything + }, + } + newPls := model.Playlist{Name: "All Songs", OwnerID: restrictedUserID, Rules: rules} + Expect(restrictedRepo.Put(&newPls)).To(Succeed()) + testPlaylistID = newPls.ID + + By("refreshing the smart playlist") + conf.Server.SmartPlaylistRefreshDelay = -1 * time.Second // Force refresh + pls, err := restrictedRepo.GetWithTracks(newPls.ID, true, false) + Expect(err).ToNot(HaveOccurred()) + + By("verifying only the track from library 1 is in the playlist") + var foundLib1Song, foundLib2Song bool + for _, track := range pls.Tracks { + if track.MediaFileID == "lib1-song" { + foundLib1Song = true + } + if track.MediaFileID == "lib2-song" { + foundLib2Song = true + } + } + Expect(foundLib1Song).To(BeTrue(), "Song from library 1 should be in the playlist") + Expect(foundLib2Song).To(BeFalse(), "Song from library 2 should NOT be in the playlist") + + By("verifying playlist_tracks table only contains the accessible track") + var playlistTracksCount int + err = db.DB().QueryRow("SELECT count(*) FROM playlist_tracks WHERE playlist_id = ?", newPls.ID).Scan(&playlistTracksCount) + Expect(err).ToNot(HaveOccurred()) + // Count should only include tracks visible to the user (lib1-song) + // The count may include other test songs from library 1, but NOT lib2-song + var lib2TrackCount int + err = db.DB().QueryRow("SELECT count(*) FROM playlist_tracks WHERE playlist_id = ? AND media_file_id = 'lib2-song'", newPls.ID).Scan(&lib2TrackCount) + Expect(err).ToNot(HaveOccurred()) + Expect(lib2TrackCount).To(Equal(0), "lib2-song should not be in playlist_tracks") + + By("verifying SongCount matches visible tracks") + Expect(pls.SongCount).To(Equal(len(pls.Tracks)), "SongCount should match the number of visible tracks") + }) + }) }) diff --git a/persistence/playlist_track_repository.go b/persistence/playlist_track_repository.go index 01eec0d02..1a7062cc2 100644 --- a/persistence/playlist_track_repository.go +++ b/persistence/playlist_track_repository.go @@ -55,7 +55,7 @@ func (r *playlistRepository) Tracks(playlistId string, refreshSmartPlaylist bool "id": "playlist_tracks.id", "artist": "order_artist_name", "album_artist": "order_album_artist_name", - "album": "order_album_name, order_album_artist_name", + "album": "order_album_name, album_id, disc_number, track_number, order_artist_name, title", "title": "order_title", // To make sure these fields will be whitelisted "duration": "duration", @@ -84,7 +84,7 @@ func (r *playlistTrackRepository) Count(options ...rest.QueryOptions) (int64, er return r.count(query, r.parseRestOptions(r.ctx, options...)) } -func (r *playlistTrackRepository) Read(id string) (interface{}, error) { +func (r *playlistTrackRepository) Read(id string) (any, error) { userID := loggedUser(r.ctx).ID sel := r.newSelect(). LeftJoin("annotation on ("+ @@ -97,6 +97,7 @@ func (r *playlistTrackRepository) Read(id string) (interface{}, error) { "coalesce(rating, 0) as rating", "starred_at", "play_date", + "rated_at", "f.*", "playlist_tracks.*", ). @@ -127,7 +128,7 @@ func (r *playlistTrackRepository) GetAlbumIDs(options ...model.QueryOptions) ([] return ids, nil } -func (r *playlistTrackRepository) ReadAll(options ...rest.QueryOptions) (interface{}, error) { +func (r *playlistTrackRepository) ReadAll(options ...rest.QueryOptions) (any, error) { return r.GetAll(r.parseRestOptions(r.ctx, options...)) } @@ -135,19 +136,11 @@ func (r *playlistTrackRepository) EntityName() string { return "playlist_tracks" } -func (r *playlistTrackRepository) NewInstance() interface{} { +func (r *playlistTrackRepository) NewInstance() any { return &model.PlaylistTrack{} } -func (r *playlistTrackRepository) isTracksEditable() bool { - return r.playlistRepo.isWritable(r.playlistId) && !r.playlist.IsSmartPlaylist() -} - func (r *playlistTrackRepository) Add(mediaFileIds []string) (int, error) { - if !r.isTracksEditable() { - return 0, rest.ErrPermissionDenied - } - if len(mediaFileIds) > 0 { log.Debug(r.ctx, "Adding songs to playlist", "playlistId", r.playlistId, "mediaFileIds", mediaFileIds) } else { @@ -195,22 +188,7 @@ func (r *playlistTrackRepository) AddDiscs(discs []model.DiscID) (int, error) { return r.addMediaFileIds(clauses) } -// Get ids from all current tracks -func (r *playlistTrackRepository) getTracks() ([]string, error) { - all := r.newSelect().Columns("media_file_id").Where(Eq{"playlist_id": r.playlistId}).OrderBy("id") - var ids []string - err := r.queryAllSlice(all, &ids) - if err != nil { - log.Error(r.ctx, "Error querying current tracks from playlist", "playlistId", r.playlistId, err) - return nil, err - } - return ids, nil -} - func (r *playlistTrackRepository) Delete(ids ...string) error { - if !r.isTracksEditable() { - return rest.ErrPermissionDenied - } err := r.delete(And{Eq{"playlist_id": r.playlistId}, Eq{"id": ids}}) if err != nil { return err @@ -220,9 +198,6 @@ func (r *playlistTrackRepository) Delete(ids ...string) error { } func (r *playlistTrackRepository) DeleteAll() error { - if !r.isTracksEditable() { - return rest.ErrPermissionDenied - } err := r.delete(Eq{"playlist_id": r.playlistId}) if err != nil { return err @@ -231,16 +206,45 @@ func (r *playlistTrackRepository) DeleteAll() error { return r.playlistRepo.renumber(r.playlistId) } +// Reorder moves a track from pos to newPos, shifting other tracks accordingly. func (r *playlistTrackRepository) Reorder(pos int, newPos int) error { - if !r.isTracksEditable() { - return rest.ErrPermissionDenied + if pos == newPos { + return nil } - ids, err := r.getTracks() + pid := r.playlistId + + // Step 1: Move the source track out of the way (temporary sentinel value) + _, err := r.executeSQL(Expr( + `UPDATE playlist_tracks SET id = -999999 WHERE playlist_id = ? AND id = ?`, pid, pos)) if err != nil { return err } - newOrder := slice.Move(ids, pos-1, newPos-1) - return r.playlistRepo.updatePlaylist(r.playlistId, newOrder) + + // Step 2: Shift the affected range using negative values to avoid unique constraint violations + if pos < newPos { + _, err = r.executeSQL(Expr( + `UPDATE playlist_tracks SET id = -(id - 1) WHERE playlist_id = ? AND id > ? AND id <= ?`, + pid, pos, newPos)) + } else { + _, err = r.executeSQL(Expr( + `UPDATE playlist_tracks SET id = -(id + 1) WHERE playlist_id = ? AND id >= ? AND id < ?`, + pid, newPos, pos)) + } + if err != nil { + return err + } + + // Step 3: Flip the shifted range back to positive + _, err = r.executeSQL(Expr( + `UPDATE playlist_tracks SET id = -id WHERE playlist_id = ? AND id < 0 AND id != -999999`, pid)) + if err != nil { + return err + } + + // Step 4: Place the source track at its new position + _, err = r.executeSQL(Expr( + `UPDATE playlist_tracks SET id = ? WHERE playlist_id = ? AND id = -999999`, newPos, pid)) + return err } var _ model.PlaylistTrackRepository = (*playlistTrackRepository)(nil) diff --git a/persistence/playqueue_repository.go b/persistence/playqueue_repository.go index 74c80ee92..c952b42b1 100644 --- a/persistence/playqueue_repository.go +++ b/persistence/playqueue_repository.go @@ -122,8 +122,8 @@ func (r *playQueueRepository) toModel(pq *playQueue) model.PlayQueue { UpdatedAt: pq.UpdatedAt, } if strings.TrimSpace(pq.Items) != "" { - tracks := strings.Split(pq.Items, ",") - for _, t := range tracks { + tracks := strings.SplitSeq(pq.Items, ",") + for t := range tracks { q.Items = append(q.Items, model.MediaFile{ID: t}) } } diff --git a/persistence/plugin_cleanup.go b/persistence/plugin_cleanup.go new file mode 100644 index 000000000..0202726e4 --- /dev/null +++ b/persistence/plugin_cleanup.go @@ -0,0 +1,86 @@ +package persistence + +import ( + "github.com/pocketbase/dbx" +) + +// cleanupPluginUserReferences removes a user ID from all plugins' users JSON arrays +// and auto-disables plugins that lose their only permitted user (when users permission is required). +// This is called from userRepository.Delete() to maintain referential integrity. +func cleanupPluginUserReferences(db dbx.Builder, userID string) error { + // SQLite JSON function: json_remove removes the element at the path where user matches. + // We use a subquery with json_each to find and remove the user ID from the array. + // This updates all plugins where the users array contains the given user ID. + _, err := db.NewQuery(` + UPDATE plugin + SET users = ( + SELECT json_group_array(value) + FROM json_each(plugin.users) + WHERE value != {:userID} + ), + updated_at = CURRENT_TIMESTAMP + WHERE users IS NOT NULL + AND users != '' + AND EXISTS (SELECT 1 FROM json_each(plugin.users) WHERE value = {:userID}) + `).Bind(dbx.Params{"userID": userID}).Execute() + if err != nil { + return err + } + + // Auto-disable plugins that: + // 1. Are currently enabled + // 2. Require users permission (manifest has permissions.users) + // 3. Don't have allUsers enabled + // 4. Now have an empty users array after cleanup + // + // The manifest check uses JSON path to see if permissions.users exists. + _, err = db.NewQuery(` + UPDATE plugin + SET enabled = false, + updated_at = CURRENT_TIMESTAMP + WHERE enabled = true + AND all_users = false + AND json_extract(manifest, '$.permissions.users') IS NOT NULL + AND (users IS NULL OR users = '' OR users = '[]' OR json_array_length(users) = 0) + `).Execute() + return err +} + +// cleanupPluginLibraryReferences removes a library ID from all plugins' libraries JSON arrays +// and auto-disables plugins that lose their only permitted library (when library permission is required). +// This is called from libraryRepository.Delete() to maintain referential integrity. +func cleanupPluginLibraryReferences(db dbx.Builder, libraryID int) error { + // SQLite JSON function: we filter out the library ID from the array. + // Libraries are stored as integers in the JSON array. + _, err := db.NewQuery(` + UPDATE plugin + SET libraries = ( + SELECT json_group_array(value) + FROM json_each(plugin.libraries) + WHERE CAST(value AS INTEGER) != {:libraryID} + ), + updated_at = CURRENT_TIMESTAMP + WHERE libraries IS NOT NULL + AND libraries != '' + AND EXISTS (SELECT 1 FROM json_each(plugin.libraries) WHERE CAST(value AS INTEGER) = {:libraryID}) + `).Bind(dbx.Params{"libraryID": libraryID}).Execute() + if err != nil { + return err + } + + // Auto-disable plugins that: + // 1. Are currently enabled + // 2. Require library permission (manifest has permissions.library) + // 3. Don't have allLibraries enabled + // 4. Now have an empty libraries array after cleanup + _, err = db.NewQuery(` + UPDATE plugin + SET enabled = false, + updated_at = CURRENT_TIMESTAMP + WHERE enabled = true + AND all_libraries = false + AND json_extract(manifest, '$.permissions.library') IS NOT NULL + AND (libraries IS NULL OR libraries = '' OR libraries = '[]' OR json_array_length(libraries) = 0) + `).Execute() + return err +} diff --git a/persistence/plugin_cleanup_test.go b/persistence/plugin_cleanup_test.go new file mode 100644 index 000000000..bfe6d60ca --- /dev/null +++ b/persistence/plugin_cleanup_test.go @@ -0,0 +1,263 @@ +package persistence + +import ( + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Plugin Cleanup", func() { + var pluginRepo model.PluginRepository + var userRepo model.UserRepository + var libraryRepo model.LibraryRepository + + BeforeEach(func() { + ctx := GinkgoT().Context() + ctx = request.WithUser(ctx, model.User{ID: "admin", UserName: "admin", IsAdmin: true}) + db := GetDBXBuilder() + pluginRepo = NewPluginRepository(ctx, db) + userRepo = NewUserRepository(ctx, db) + libraryRepo = NewLibraryRepository(ctx, db) + + // Clean up any existing plugins + all, _ := pluginRepo.GetAll() + for _, p := range all { + _ = pluginRepo.Delete(p.ID) + } + }) + + AfterEach(func() { + // Clean up after tests + all, _ := pluginRepo.GetAll() + for _, p := range all { + _ = pluginRepo.Delete(p.ID) + } + }) + + Describe("cleanupPluginUserReferences", func() { + It("removes user ID from plugin users array", func() { + // Create a plugin with multiple users + plugin := &model.Plugin{ + ID: "test-plugin", + Path: "/plugins/test.wasm", + Manifest: `{"name":"test"}`, + SHA256: "abc123", + Users: `["user1","user2","user3"]`, + Enabled: true, + } + Expect(pluginRepo.Put(plugin)).To(Succeed()) + + // Clean up user2 reference + db := GetDBXBuilder() + Expect(cleanupPluginUserReferences(db, "user2")).To(Succeed()) + + // Verify user2 was removed + updated, err := pluginRepo.Get("test-plugin") + Expect(err).ToNot(HaveOccurred()) + Expect(updated.Users).To(Equal(`["user1","user3"]`)) + Expect(updated.Enabled).To(BeTrue()) // Still has users, should remain enabled + }) + + It("auto-disables plugin when last permitted user is removed", func() { + // Create a plugin that requires users permission with only one user + plugin := &model.Plugin{ + ID: "user-plugin", + Path: "/plugins/user.wasm", + Manifest: `{"name":"user-plugin","permissions":{"users":{}}}`, + SHA256: "def456", + Users: `["only-user"]`, + AllUsers: false, + Enabled: true, + } + Expect(pluginRepo.Put(plugin)).To(Succeed()) + + // Remove the only user + db := GetDBXBuilder() + Expect(cleanupPluginUserReferences(db, "only-user")).To(Succeed()) + + // Verify plugin was auto-disabled + updated, err := pluginRepo.Get("user-plugin") + Expect(err).ToNot(HaveOccurred()) + Expect(updated.Users).To(Equal(`[]`)) + Expect(updated.Enabled).To(BeFalse()) + }) + + It("does not disable plugin when allUsers is true", func() { + plugin := &model.Plugin{ + ID: "all-users-plugin", + Path: "/plugins/all.wasm", + Manifest: `{"name":"all-users","permissions":{"users":{}}}`, + SHA256: "ghi789", + Users: `["user1"]`, + AllUsers: true, + Enabled: true, + } + Expect(pluginRepo.Put(plugin)).To(Succeed()) + + // Remove the user (but allUsers is true) + db := GetDBXBuilder() + Expect(cleanupPluginUserReferences(db, "user1")).To(Succeed()) + + // Plugin should still be enabled because allUsers is true + updated, err := pluginRepo.Get("all-users-plugin") + Expect(err).ToNot(HaveOccurred()) + Expect(updated.Enabled).To(BeTrue()) + }) + + It("does not affect plugins without users permission requirement", func() { + plugin := &model.Plugin{ + ID: "no-users-perm", + Path: "/plugins/noperm.wasm", + Manifest: `{"name":"no-perm"}`, // No permissions.users in manifest + SHA256: "jkl012", + Users: `["user1"]`, + Enabled: true, + } + Expect(pluginRepo.Put(plugin)).To(Succeed()) + + // Remove the user + db := GetDBXBuilder() + Expect(cleanupPluginUserReferences(db, "user1")).To(Succeed()) + + // Plugin should still be enabled (no users permission requirement) + updated, err := pluginRepo.Get("no-users-perm") + Expect(err).ToNot(HaveOccurred()) + Expect(updated.Users).To(Equal(`[]`)) + Expect(updated.Enabled).To(BeTrue()) + }) + }) + + Describe("cleanupPluginLibraryReferences", func() { + It("removes library ID from plugin libraries array", func() { + // Create a plugin with multiple libraries + plugin := &model.Plugin{ + ID: "lib-plugin", + Path: "/plugins/lib.wasm", + Manifest: `{"name":"lib-plugin"}`, + SHA256: "mno345", + Libraries: `[1,2,3]`, + Enabled: true, + } + Expect(pluginRepo.Put(plugin)).To(Succeed()) + + // Clean up library 2 reference + db := GetDBXBuilder() + Expect(cleanupPluginLibraryReferences(db, 2)).To(Succeed()) + + // Verify library 2 was removed + updated, err := pluginRepo.Get("lib-plugin") + Expect(err).ToNot(HaveOccurred()) + Expect(updated.Libraries).To(Equal(`[1,3]`)) + }) + + It("auto-disables plugin when last permitted library is removed", func() { + // Create a plugin that requires library permission with only one library + plugin := &model.Plugin{ + ID: "lib-only-plugin", + Path: "/plugins/libonly.wasm", + Manifest: `{"name":"lib-only","permissions":{"library":{}}}`, + SHA256: "pqr678", + Libraries: `[99]`, + AllLibraries: false, + Enabled: true, + } + Expect(pluginRepo.Put(plugin)).To(Succeed()) + + // Remove the only library + db := GetDBXBuilder() + Expect(cleanupPluginLibraryReferences(db, 99)).To(Succeed()) + + // Verify plugin was auto-disabled + updated, err := pluginRepo.Get("lib-only-plugin") + Expect(err).ToNot(HaveOccurred()) + Expect(updated.Libraries).To(Equal(`[]`)) + Expect(updated.Enabled).To(BeFalse()) + }) + + It("does not disable plugin when allLibraries is true", func() { + plugin := &model.Plugin{ + ID: "all-libs-plugin", + Path: "/plugins/alllibs.wasm", + Manifest: `{"name":"all-libs","permissions":{"library":{}}}`, + SHA256: "stu901", + Libraries: `[1]`, + AllLibraries: true, + Enabled: true, + } + Expect(pluginRepo.Put(plugin)).To(Succeed()) + + // Remove the library (but allLibraries is true) + db := GetDBXBuilder() + Expect(cleanupPluginLibraryReferences(db, 1)).To(Succeed()) + + // Plugin should still be enabled + updated, err := pluginRepo.Get("all-libs-plugin") + Expect(err).ToNot(HaveOccurred()) + Expect(updated.Enabled).To(BeTrue()) + }) + }) + + Describe("User Delete integration", func() { + It("cleans up plugin references when user is deleted", func() { + // Create a test user + user := &model.User{ + ID: "test-delete-user", + UserName: "plugin-cleanup-test-user", + IsAdmin: false, + } + user.NewPassword = "password123" + Expect(userRepo.Put(user)).To(Succeed()) + + // Create a plugin referencing this user + plugin := &model.Plugin{ + ID: "user-ref-plugin", + Path: "/plugins/userref.wasm", + Manifest: `{"name":"user-ref"}`, + SHA256: "xyz123", + Users: `["test-delete-user","other-user"]`, + Enabled: true, + } + Expect(pluginRepo.Put(plugin)).To(Succeed()) + + // Delete the user + Expect(userRepo.Delete("test-delete-user")).To(Succeed()) + + // Verify user was removed from plugin + updated, err := pluginRepo.Get("user-ref-plugin") + Expect(err).ToNot(HaveOccurred()) + Expect(updated.Users).To(Equal(`["other-user"]`)) + }) + }) + + Describe("Library Delete integration", func() { + It("cleans up plugin references when library is deleted", func() { + // Create a test library (ID > 1 since ID 1 cannot be deleted) + library := &model.Library{ + ID: 99, + Name: "Test Library", + Path: "/tmp/test-lib", + } + Expect(libraryRepo.Put(library)).To(Succeed()) + + // Create a plugin referencing this library + plugin := &model.Plugin{ + ID: "lib-ref-plugin", + Path: "/plugins/libref.wasm", + Manifest: `{"name":"lib-ref"}`, + SHA256: "abc789", + Libraries: `[99,1]`, + Enabled: true, + } + Expect(pluginRepo.Put(plugin)).To(Succeed()) + + // Delete the library + Expect(libraryRepo.Delete(99)).To(Succeed()) + + // Verify library was removed from plugin + updated, err := pluginRepo.Get("lib-ref-plugin") + Expect(err).ToNot(HaveOccurred()) + Expect(updated.Libraries).To(Equal(`[1]`)) + }) + }) +}) diff --git a/persistence/plugin_repository.go b/persistence/plugin_repository.go new file mode 100644 index 000000000..35c32de91 --- /dev/null +++ b/persistence/plugin_repository.go @@ -0,0 +1,171 @@ +package persistence + +import ( + "context" + "errors" + "time" + + . "github.com/Masterminds/squirrel" + "github.com/deluan/rest" + "github.com/navidrome/navidrome/model" + "github.com/pocketbase/dbx" +) + +type pluginRepository struct { + sqlRepository +} + +func NewPluginRepository(ctx context.Context, db dbx.Builder) model.PluginRepository { + r := &pluginRepository{} + r.ctx = ctx + r.db = db + r.registerModel(&model.Plugin{}, map[string]filterFunc{ + "id": idFilter("plugin"), + "enabled": booleanFilter, + }) + return r +} + +func (r *pluginRepository) isPermitted() bool { + user := loggedUser(r.ctx) + return user.IsAdmin +} + +func (r *pluginRepository) ClearErrors() error { + if !r.isPermitted() { + return rest.ErrPermissionDenied + } + _, err := r.db.NewQuery("UPDATE plugin SET last_error = '' WHERE last_error != ''").Execute() + return err +} + +func (r *pluginRepository) CountAll(options ...model.QueryOptions) (int64, error) { + if !r.isPermitted() { + return 0, rest.ErrPermissionDenied + } + sql := r.newSelect() + return r.count(sql, options...) +} + +func (r *pluginRepository) Delete(id string) error { + if !r.isPermitted() { + return rest.ErrPermissionDenied + } + return r.delete(Eq{"id": id}) +} + +func (r *pluginRepository) Get(id string) (*model.Plugin, error) { + if !r.isPermitted() { + return nil, rest.ErrPermissionDenied + } + sel := r.newSelect().Where(Eq{"id": id}).Columns("*") + res := model.Plugin{} + err := r.queryOne(sel, &res) + return &res, err +} + +func (r *pluginRepository) GetAll(options ...model.QueryOptions) (model.Plugins, error) { + if !r.isPermitted() { + return nil, rest.ErrPermissionDenied + } + sel := r.newSelect(options...).Columns("*") + res := model.Plugins{} + err := r.queryAll(sel, &res) + return res, err +} + +func (r *pluginRepository) Put(plugin *model.Plugin) error { + if !r.isPermitted() { + return rest.ErrPermissionDenied + } + + plugin.UpdatedAt = time.Now() + + if plugin.ID == "" { + return errors.New("plugin ID cannot be empty") + } + + // Upsert using INSERT ... ON CONFLICT for atomic operation + _, err := r.db.NewQuery(` + INSERT INTO plugin (id, path, manifest, config, users, all_users, libraries, all_libraries, allow_write_access, enabled, last_error, sha256, created_at, updated_at) + VALUES ({:id}, {:path}, {:manifest}, {:config}, {:users}, {:all_users}, {:libraries}, {:all_libraries}, {:allow_write_access}, {:enabled}, {:last_error}, {:sha256}, {:created_at}, {:updated_at}) + ON CONFLICT(id) DO UPDATE SET + path = excluded.path, + manifest = excluded.manifest, + config = excluded.config, + users = excluded.users, + all_users = excluded.all_users, + libraries = excluded.libraries, + all_libraries = excluded.all_libraries, + allow_write_access = excluded.allow_write_access, + enabled = excluded.enabled, + last_error = excluded.last_error, + sha256 = excluded.sha256, + updated_at = excluded.updated_at + `).Bind(dbx.Params{ + "id": plugin.ID, + "path": plugin.Path, + "manifest": plugin.Manifest, + "config": plugin.Config, + "users": plugin.Users, + "all_users": plugin.AllUsers, + "libraries": plugin.Libraries, + "all_libraries": plugin.AllLibraries, + "allow_write_access": plugin.AllowWriteAccess, + "enabled": plugin.Enabled, + "last_error": plugin.LastError, + "sha256": plugin.SHA256, + "created_at": time.Now(), + "updated_at": plugin.UpdatedAt, + }).Execute() + return err +} + +func (r *pluginRepository) Count(options ...rest.QueryOptions) (int64, error) { + return r.CountAll(r.parseRestOptions(r.ctx, options...)) +} + +func (r *pluginRepository) EntityName() string { + return "plugin" +} + +func (r *pluginRepository) NewInstance() any { + return &model.Plugin{} +} + +func (r *pluginRepository) Read(id string) (any, error) { + return r.Get(id) +} + +func (r *pluginRepository) ReadAll(options ...rest.QueryOptions) (any, error) { + return r.GetAll(r.parseRestOptions(r.ctx, options...)) +} + +func (r *pluginRepository) Save(entity any) (string, error) { + p := entity.(*model.Plugin) + if !r.isPermitted() { + return "", rest.ErrPermissionDenied + } + err := r.Put(p) + if errors.Is(err, model.ErrNotFound) { + return "", rest.ErrNotFound + } + return p.ID, err +} + +func (r *pluginRepository) Update(id string, entity any, cols ...string) error { + p := entity.(*model.Plugin) + p.ID = id + if !r.isPermitted() { + return rest.ErrPermissionDenied + } + err := r.Put(p) + if errors.Is(err, model.ErrNotFound) { + return rest.ErrNotFound + } + return err +} + +var _ model.PluginRepository = (*pluginRepository)(nil) +var _ rest.Repository = (*pluginRepository)(nil) +var _ rest.Persistable = (*pluginRepository)(nil) diff --git a/persistence/plugin_repository_test.go b/persistence/plugin_repository_test.go new file mode 100644 index 000000000..dc68b0892 --- /dev/null +++ b/persistence/plugin_repository_test.go @@ -0,0 +1,251 @@ +package persistence + +import ( + "github.com/deluan/rest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("PluginRepository", func() { + var repo model.PluginRepository + + Describe("Admin User", func() { + BeforeEach(func() { + ctx := GinkgoT().Context() + ctx = request.WithUser(ctx, model.User{ID: "userid", UserName: "userid", IsAdmin: true}) + repo = NewPluginRepository(ctx, GetDBXBuilder()) + + // Clean up any existing plugins + all, _ := repo.GetAll() + for _, p := range all { + _ = repo.Delete(p.ID) + } + }) + + AfterEach(func() { + // Clean up after tests + all, _ := repo.GetAll() + for _, p := range all { + _ = repo.Delete(p.ID) + } + }) + + Describe("CountAll", func() { + It("returns 0 when no plugins exist", func() { + Expect(repo.CountAll()).To(Equal(int64(0))) + }) + + It("returns the number of plugins in the DB", func() { + _ = repo.Put(&model.Plugin{ID: "test-plugin-1", Path: "/plugins/test1.wasm", Manifest: "{}", SHA256: "abc123"}) + _ = repo.Put(&model.Plugin{ID: "test-plugin-2", Path: "/plugins/test2.wasm", Manifest: "{}", SHA256: "def456"}) + + Expect(repo.CountAll()).To(Equal(int64(2))) + }) + }) + + Describe("Delete", func() { + It("deletes existing item", func() { + plugin := &model.Plugin{ID: "to-delete", Path: "/plugins/delete.wasm", Manifest: "{}", SHA256: "hash"} + _ = repo.Put(plugin) + + err := repo.Delete(plugin.ID) + Expect(err).To(BeNil()) + + _, err = repo.Get(plugin.ID) + Expect(err).To(MatchError(model.ErrNotFound)) + }) + }) + + Describe("Get", func() { + It("returns an existing item", func() { + plugin := &model.Plugin{ID: "test-get", Path: "/plugins/test.wasm", Manifest: `{"name":"test"}`, SHA256: "hash123"} + _ = repo.Put(plugin) + + res, err := repo.Get(plugin.ID) + Expect(err).To(BeNil()) + Expect(res.ID).To(Equal(plugin.ID)) + Expect(res.Path).To(Equal(plugin.Path)) + Expect(res.Manifest).To(Equal(plugin.Manifest)) + }) + + It("errors when missing", func() { + _, err := repo.Get("notanid") + Expect(err).To(MatchError(model.ErrNotFound)) + }) + }) + + Describe("GetAll", func() { + It("returns all items from the DB", func() { + _ = repo.Put(&model.Plugin{ID: "plugin-a", Path: "/plugins/a.wasm", Manifest: "{}", SHA256: "hash1"}) + _ = repo.Put(&model.Plugin{ID: "plugin-b", Path: "/plugins/b.wasm", Manifest: "{}", SHA256: "hash2"}) + + all, err := repo.GetAll() + Expect(err).To(BeNil()) + Expect(all).To(HaveLen(2)) + }) + + It("supports pagination", func() { + _ = repo.Put(&model.Plugin{ID: "plugin-1", Path: "/plugins/1.wasm", Manifest: "{}", SHA256: "h1"}) + _ = repo.Put(&model.Plugin{ID: "plugin-2", Path: "/plugins/2.wasm", Manifest: "{}", SHA256: "h2"}) + _ = repo.Put(&model.Plugin{ID: "plugin-3", Path: "/plugins/3.wasm", Manifest: "{}", SHA256: "h3"}) + + page1, err := repo.GetAll(model.QueryOptions{Max: 2, Offset: 0, Sort: "id"}) + Expect(err).To(BeNil()) + Expect(page1).To(HaveLen(2)) + + page2, err := repo.GetAll(model.QueryOptions{Max: 2, Offset: 2, Sort: "id"}) + Expect(err).To(BeNil()) + Expect(page2).To(HaveLen(1)) + }) + }) + + Describe("Put", func() { + It("successfully creates a new plugin", func() { + plugin := &model.Plugin{ + ID: "new-plugin", + Path: "/plugins/new.wasm", + Manifest: `{"name":"new","version":"1.0"}`, + Config: `{"setting":"value"}`, + SHA256: "sha256hash", + Enabled: false, + } + + err := repo.Put(plugin) + Expect(err).To(BeNil()) + + saved, err := repo.Get(plugin.ID) + Expect(err).To(BeNil()) + Expect(saved.Path).To(Equal(plugin.Path)) + Expect(saved.Manifest).To(Equal(plugin.Manifest)) + Expect(saved.Config).To(Equal(plugin.Config)) + Expect(saved.Enabled).To(BeFalse()) + Expect(saved.CreatedAt).NotTo(BeZero()) + Expect(saved.UpdatedAt).NotTo(BeZero()) + }) + + It("successfully updates an existing plugin", func() { + plugin := &model.Plugin{ + ID: "update-plugin", + Path: "/plugins/update.wasm", + Manifest: `{"name":"test"}`, + SHA256: "original", + Enabled: false, + } + _ = repo.Put(plugin) + + plugin.Enabled = true + plugin.Config = `{"new":"config"}` + plugin.SHA256 = "updated" + err := repo.Put(plugin) + Expect(err).To(BeNil()) + + saved, err := repo.Get(plugin.ID) + Expect(err).To(BeNil()) + Expect(saved.Enabled).To(BeTrue()) + Expect(saved.Config).To(Equal(`{"new":"config"}`)) + Expect(saved.SHA256).To(Equal("updated")) + }) + + It("stores and retrieves last_error", func() { + plugin := &model.Plugin{ + ID: "error-plugin", + Path: "/plugins/error.wasm", + Manifest: "{}", + SHA256: "hash", + LastError: "failed to load: missing export", + } + err := repo.Put(plugin) + Expect(err).To(BeNil()) + + saved, err := repo.Get(plugin.ID) + Expect(err).To(BeNil()) + Expect(saved.LastError).To(Equal("failed to load: missing export")) + }) + + It("fails when ID is empty", func() { + plugin := &model.Plugin{ + Path: "/plugins/noid.wasm", + Manifest: "{}", + SHA256: "hash", + } + err := repo.Put(plugin) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("ID cannot be empty")) + }) + }) + + Describe("ClearErrors", func() { + It("clears last_error on all plugins with errors", func() { + _ = repo.Put(&model.Plugin{ID: "ok-plugin", Path: "/plugins/ok.wasm", Manifest: "{}", SHA256: "h1"}) + _ = repo.Put(&model.Plugin{ID: "err-plugin-1", Path: "/plugins/e1.wasm", Manifest: "{}", SHA256: "h2", LastError: "incompatible version"}) + _ = repo.Put(&model.Plugin{ID: "err-plugin-2", Path: "/plugins/e2.wasm", Manifest: "{}", SHA256: "h3", LastError: "missing export"}) + + err := repo.ClearErrors() + Expect(err).To(BeNil()) + + all, err := repo.GetAll() + Expect(err).To(BeNil()) + for _, p := range all { + Expect(p.LastError).To(BeEmpty(), "plugin %s should have no error", p.ID) + } + }) + + It("succeeds when no plugins have errors", func() { + _ = repo.Put(&model.Plugin{ID: "clean-plugin", Path: "/plugins/c.wasm", Manifest: "{}", SHA256: "h1"}) + + err := repo.ClearErrors() + Expect(err).To(BeNil()) + }) + }) + }) + + Describe("Regular User", func() { + BeforeEach(func() { + ctx := GinkgoT().Context() + ctx = request.WithUser(ctx, model.User{ID: "userid", UserName: "userid", IsAdmin: false}) + repo = NewPluginRepository(ctx, GetDBXBuilder()) + }) + + Describe("CountAll", func() { + It("fails to count items", func() { + _, err := repo.CountAll() + Expect(err).To(Equal(rest.ErrPermissionDenied)) + }) + }) + + Describe("Delete", func() { + It("fails to delete items", func() { + err := repo.Delete("any-id") + Expect(err).To(Equal(rest.ErrPermissionDenied)) + }) + }) + + Describe("Get", func() { + It("fails to get items", func() { + _, err := repo.Get("any-id") + Expect(err).To(Equal(rest.ErrPermissionDenied)) + }) + }) + + Describe("GetAll", func() { + It("fails to get all items", func() { + _, err := repo.GetAll() + Expect(err).To(Equal(rest.ErrPermissionDenied)) + }) + }) + + Describe("Put", func() { + It("fails to create/update item", func() { + err := repo.Put(&model.Plugin{ + ID: "user-create", + Path: "/plugins/create.wasm", + Manifest: "{}", + SHA256: "hash", + }) + Expect(err).To(Equal(rest.ErrPermissionDenied)) + }) + }) + }) +}) diff --git a/persistence/radio_repository.go b/persistence/radio_repository.go index cf253d06b..a073643db 100644 --- a/persistence/radio_repository.go +++ b/persistence/radio_repository.go @@ -58,34 +58,20 @@ func (r *radioRepository) GetAll(options ...model.QueryOptions) (model.Radios, e return res, err } -func (r *radioRepository) Put(radio *model.Radio) error { +func (r *radioRepository) Put(radio *model.Radio, colsToUpdate ...string) error { if !r.isPermitted() { return rest.ErrPermissionDenied } - var values map[string]interface{} - radio.UpdatedAt = time.Now() - if radio.ID == "" { radio.CreatedAt = time.Now() radio.ID = id.NewRandom() - values, _ = toSQLArgs(*radio) - } else { - values, _ = toSQLArgs(*radio) - update := Update(r.tableName).Where(Eq{"id": radio.ID}).SetMap(values) - count, err := r.executeSQL(update) - - if err != nil { - return err - } else if count > 0 { - return nil - } } - - values["created_at"] = time.Now() - insert := Insert(r.tableName).SetMap(values) - _, err := r.executeSQL(insert) + if len(colsToUpdate) > 0 { + colsToUpdate = append(colsToUpdate, "UpdatedAt") + } + _, err := r.put(radio.ID, radio, colsToUpdate...) return err } @@ -97,19 +83,19 @@ func (r *radioRepository) EntityName() string { return "radio" } -func (r *radioRepository) NewInstance() interface{} { +func (r *radioRepository) NewInstance() any { return &model.Radio{} } -func (r *radioRepository) Read(id string) (interface{}, error) { +func (r *radioRepository) Read(id string) (any, error) { return r.Get(id) } -func (r *radioRepository) ReadAll(options ...rest.QueryOptions) (interface{}, error) { +func (r *radioRepository) ReadAll(options ...rest.QueryOptions) (any, error) { return r.GetAll(r.parseRestOptions(r.ctx, options...)) } -func (r *radioRepository) Save(entity interface{}) (string, error) { +func (r *radioRepository) Save(entity any) (string, error) { t := entity.(*model.Radio) if !r.isPermitted() { return "", rest.ErrPermissionDenied @@ -121,7 +107,7 @@ func (r *radioRepository) Save(entity interface{}) (string, error) { return t.ID, err } -func (r *radioRepository) Update(id string, entity interface{}, cols ...string) error { +func (r *radioRepository) Update(id string, entity any, cols ...string) error { t := entity.(*model.Radio) t.ID = id if !r.isPermitted() { diff --git a/persistence/scrobble_buffer_repository.go b/persistence/scrobble_buffer_repository.go index d0f88903e..3cfb836bf 100644 --- a/persistence/scrobble_buffer_repository.go +++ b/persistence/scrobble_buffer_repository.go @@ -51,7 +51,7 @@ func (r *scrobbleBufferRepository) UserIDs(service string) ([]string, error) { } func (r *scrobbleBufferRepository) Enqueue(service, userId, mediaFileId string, playTime time.Time) error { - ins := Insert(r.tableName).SetMap(map[string]interface{}{ + ins := Insert(r.tableName).SetMap(map[string]any{ "id": id.NewRandom(), "user_id": userId, "service": service, diff --git a/persistence/scrobble_buffer_repository_test.go b/persistence/scrobble_buffer_repository_test.go index 62423ff45..edf59ce49 100644 --- a/persistence/scrobble_buffer_repository_test.go +++ b/persistence/scrobble_buffer_repository_test.go @@ -24,7 +24,7 @@ var _ = Describe("ScrobbleBufferRepository", func() { id := id.NewRandom() ids = append(ids, id) - ins := squirrel.Insert("scrobble_buffer").SetMap(map[string]interface{}{ + ins := squirrel.Insert("scrobble_buffer").SetMap(map[string]any{ "id": id, "user_id": userId, "service": service, diff --git a/persistence/scrobble_repository.go b/persistence/scrobble_repository.go new file mode 100644 index 000000000..219a48198 --- /dev/null +++ b/persistence/scrobble_repository.go @@ -0,0 +1,34 @@ +package persistence + +import ( + "context" + "time" + + . "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/model" + "github.com/pocketbase/dbx" +) + +type scrobbleRepository struct { + sqlRepository +} + +func NewScrobbleRepository(ctx context.Context, db dbx.Builder) model.ScrobbleRepository { + r := &scrobbleRepository{} + r.ctx = ctx + r.db = db + r.tableName = "scrobbles" + return r +} + +func (r *scrobbleRepository) RecordScrobble(mediaFileID string, submissionTime time.Time) error { + userID := loggedUser(r.ctx).ID + values := map[string]any{ + "media_file_id": mediaFileID, + "user_id": userID, + "submission_time": submissionTime.Unix(), + } + insert := Insert(r.tableName).SetMap(values) + _, err := r.executeSQL(insert) + return err +} diff --git a/persistence/scrobble_repository_test.go b/persistence/scrobble_repository_test.go new file mode 100644 index 000000000..d43848d03 --- /dev/null +++ b/persistence/scrobble_repository_test.go @@ -0,0 +1,84 @@ +package persistence + +import ( + "context" + "time" + + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/id" + "github.com/navidrome/navidrome/model/request" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + "github.com/pocketbase/dbx" +) + +var _ = Describe("ScrobbleRepository", func() { + var repo model.ScrobbleRepository + var rawRepo sqlRepository + var ctx context.Context + var fileID string + var userID string + + BeforeEach(func() { + fileID = id.NewRandom() + userID = id.NewRandom() + ctx = request.WithUser(log.NewContext(GinkgoT().Context()), model.User{ID: userID, UserName: "johndoe", IsAdmin: true}) + db := GetDBXBuilder() + repo = NewScrobbleRepository(ctx, db) + + rawRepo = sqlRepository{ + ctx: ctx, + tableName: "scrobbles", + db: db, + } + }) + + AfterEach(func() { + _, _ = rawRepo.db.Delete("scrobbles", dbx.HashExp{"media_file_id": fileID}).Execute() + _, _ = rawRepo.db.Delete("media_file", dbx.HashExp{"id": fileID}).Execute() + _, _ = rawRepo.db.Delete("user", dbx.HashExp{"id": userID}).Execute() + }) + + Describe("RecordScrobble", func() { + It("records a scrobble event", func() { + submissionTime := time.Now().UTC() + + // Insert User + _, err := rawRepo.db.Insert("user", dbx.Params{ + "id": userID, + "user_name": "user", + "password": "pw", + "created_at": time.Now(), + "updated_at": time.Now(), + }).Execute() + Expect(err).ToNot(HaveOccurred()) + + // Insert MediaFile + _, err = rawRepo.db.Insert("media_file", dbx.Params{ + "id": fileID, + "path": "path", + "created_at": time.Now(), + "updated_at": time.Now(), + }).Execute() + Expect(err).ToNot(HaveOccurred()) + + err = repo.RecordScrobble(fileID, submissionTime) + Expect(err).ToNot(HaveOccurred()) + + // Verify insertion + var scrobble struct { + MediaFileID string `db:"media_file_id"` + UserID string `db:"user_id"` + SubmissionTime int64 `db:"submission_time"` + } + err = rawRepo.db.Select("*").From("scrobbles"). + Where(dbx.HashExp{"media_file_id": fileID, "user_id": userID}). + One(&scrobble) + Expect(err).ToNot(HaveOccurred()) + Expect(scrobble.MediaFileID).To(Equal(fileID)) + Expect(scrobble.UserID).To(Equal(userID)) + Expect(scrobble.SubmissionTime).To(Equal(submissionTime.Unix())) + }) + }) +}) diff --git a/persistence/share_repository.go b/persistence/share_repository.go index d943943e0..415109640 100644 --- a/persistence/share_repository.go +++ b/persistence/share_repository.go @@ -30,7 +30,33 @@ func NewShareRepository(ctx context.Context, db dbx.Builder) model.ShareReposito return r } +// TODO: Ownership checks should be moved to the service layer (core/share.go) +func (r *shareRepository) checkOwnership(id string) error { + usr := loggedUser(r.ctx) + if usr.IsAdmin || usr.ID == invalidUserId { + return nil + } + sel := r.newSelect().Columns("user_id").Where(Eq{"id": id}) + var share struct { + UserID string `db:"user_id"` + } + err := r.queryOne(sel, &share) + if err != nil { + if errors.Is(err, model.ErrNotFound) { + return rest.ErrNotFound + } + return err + } + if share.UserID != usr.ID { + return rest.ErrPermissionDenied + } + return nil +} + func (r *shareRepository) Delete(id string) error { + if err := r.checkOwnership(id); err != nil { + return err + } err := r.delete(Eq{"id": id}) if errors.Is(err, model.ErrNotFound) { return rest.ErrNotFound @@ -138,9 +164,11 @@ func sortByIdPosition(mfs model.MediaFiles, ids []string) model.MediaFiles { return sorted } -func (r *shareRepository) Update(id string, entity interface{}, cols ...string) error { +func (r *shareRepository) Update(id string, entity any, cols ...string) error { s := entity.(*model.Share) - // TODO Validate record + if err := r.checkOwnership(id); err != nil { + return err + } s.ID = id s.UpdatedAt = time.Now() cols = append(cols, "updated_at") @@ -151,7 +179,7 @@ func (r *shareRepository) Update(id string, entity interface{}, cols ...string) return err } -func (r *shareRepository) Save(entity interface{}) (string, error) { +func (r *shareRepository) Save(entity any) (string, error) { s := entity.(*model.Share) // TODO Validate record u := loggedUser(r.ctx) @@ -179,18 +207,18 @@ func (r *shareRepository) EntityName() string { return "share" } -func (r *shareRepository) NewInstance() interface{} { +func (r *shareRepository) NewInstance() any { return &model.Share{} } -func (r *shareRepository) Read(id string) (interface{}, error) { +func (r *shareRepository) Read(id string) (any, error) { sel := r.selectShare().Where(Eq{"share.id": id}) var res model.Share err := r.queryOne(sel, &res) return &res, err } -func (r *shareRepository) ReadAll(options ...rest.QueryOptions) (interface{}, error) { +func (r *shareRepository) ReadAll(options ...rest.QueryOptions) (any, error) { sq := r.selectShare(r.parseRestOptions(r.ctx, options...)) res := model.Shares{} err := r.queryAll(sq, &res) diff --git a/persistence/share_repository_test.go b/persistence/share_repository_test.go index 252115175..6988f323f 100644 --- a/persistence/share_repository_test.go +++ b/persistence/share_repository_test.go @@ -4,6 +4,7 @@ import ( "context" "time" + "github.com/deluan/rest" "github.com/navidrome/navidrome/conf/configtest" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" @@ -47,7 +48,7 @@ var _ = Describe("ShareRepository", func() { _, err := GetDBXBuilder().NewQuery(` INSERT INTO share (id, user_id, description, resource_type, resource_ids, created_at, updated_at) VALUES ({:id}, {:user}, {:desc}, {:type}, {:ids}, {:created}, {:updated}) - `).Bind(map[string]interface{}{ + `).Bind(map[string]any{ "id": shareID, "user": adminUser.ID, "desc": "Headless Test Share", @@ -79,7 +80,7 @@ var _ = Describe("ShareRepository", func() { _, err := GetDBXBuilder().NewQuery(` INSERT INTO share (id, user_id, description, resource_type, resource_ids, created_at, updated_at) VALUES ({:id}, {:user}, {:desc}, {:type}, {:ids}, {:created}, {:updated}) - `).Bind(map[string]interface{}{ + `).Bind(map[string]any{ "id": shareID, "user": adminUser.ID, "desc": "Headless Get Share", @@ -110,7 +111,7 @@ var _ = Describe("ShareRepository", func() { _, err := GetDBXBuilder().NewQuery(` INSERT INTO share (id, user_id, description, resource_type, resource_ids, created_at, updated_at) VALUES ({:id}, {:user}, {:desc}, {:type}, {:ids}, {:created}, {:updated}) - `).Bind(map[string]interface{}{ + `).Bind(map[string]any{ "id": shareID, "user": adminUser.ID, "desc": "SQL Test Share", @@ -130,4 +131,91 @@ var _ = Describe("ShareRepository", func() { Expect(share.Albums).To(BeEmpty()) }) }) + + Describe("Ownership Checks", func() { + var ownerUser = model.User{ID: "2222", UserName: "regular-user"} + var otherUser = model.User{ID: "3333", UserName: "third-user"} + + insertShare := func(shareID, userID string) { + _, err := GetDBXBuilder().NewQuery(` + INSERT INTO share (id, user_id, description, resource_type, resource_ids, created_at, updated_at) + VALUES ({:id}, {:user}, {:desc}, {:type}, {:ids}, {:created}, {:updated}) + `).Bind(map[string]any{ + "id": shareID, + "user": userID, + "desc": "Test Share", + "type": "media_file", + "ids": "1001", + "created": time.Now(), + "updated": time.Now(), + }).Execute() + Expect(err).ToNot(HaveOccurred()) + } + + Describe("Delete", func() { + It("allows a non-admin user to delete their own share", func() { + insertShare("own-share-del", ownerUser.ID) + ctx := request.WithUser(log.NewContext(context.TODO()), ownerUser) + repo := NewShareRepository(ctx, GetDBXBuilder()) + err := repo.(rest.Persistable).Delete("own-share-del") + Expect(err).ToNot(HaveOccurred()) + }) + + It("denies a non-admin user from deleting another user's share", func() { + insertShare("other-share-del", ownerUser.ID) + ctx := request.WithUser(log.NewContext(context.TODO()), otherUser) + repo := NewShareRepository(ctx, GetDBXBuilder()) + err := repo.(rest.Persistable).Delete("other-share-del") + Expect(err).To(Equal(rest.ErrPermissionDenied)) + }) + + It("allows an admin to delete any user's share", func() { + insertShare("admin-del-share", ownerUser.ID) + ctx := request.WithUser(log.NewContext(context.TODO()), adminUser) + repo := NewShareRepository(ctx, GetDBXBuilder()) + err := repo.(rest.Persistable).Delete("admin-del-share") + Expect(err).ToNot(HaveOccurred()) + }) + + It("allows headless context (no user) to delete a share", func() { + insertShare("headless-del-share", ownerUser.ID) + repo := NewShareRepository(context.Background(), GetDBXBuilder()) + err := repo.(rest.Persistable).Delete("headless-del-share") + Expect(err).ToNot(HaveOccurred()) + }) + }) + + Describe("Update", func() { + It("allows a non-admin user to update their own share", func() { + insertShare("own-share-upd", ownerUser.ID) + ctx := request.WithUser(log.NewContext(context.TODO()), ownerUser) + repo := NewShareRepository(ctx, GetDBXBuilder()) + err := repo.(rest.Persistable).Update("own-share-upd", &model.Share{Description: "Updated"}, "description") + Expect(err).ToNot(HaveOccurred()) + }) + + It("denies a non-admin user from updating another user's share", func() { + insertShare("other-share-upd", ownerUser.ID) + ctx := request.WithUser(log.NewContext(context.TODO()), otherUser) + repo := NewShareRepository(ctx, GetDBXBuilder()) + err := repo.(rest.Persistable).Update("other-share-upd", &model.Share{Description: "Hacked"}, "description") + Expect(err).To(Equal(rest.ErrPermissionDenied)) + }) + + It("allows an admin to update any user's share", func() { + insertShare("admin-upd-share", ownerUser.ID) + ctx := request.WithUser(log.NewContext(context.TODO()), adminUser) + repo := NewShareRepository(ctx, GetDBXBuilder()) + err := repo.(rest.Persistable).Update("admin-upd-share", &model.Share{Description: "Admin Updated"}, "description") + Expect(err).ToNot(HaveOccurred()) + }) + + It("allows headless context (no user) to update a share", func() { + insertShare("headless-upd-share", ownerUser.ID) + repo := NewShareRepository(context.Background(), GetDBXBuilder()) + err := repo.(rest.Persistable).Update("headless-upd-share", &model.Share{Description: "Headless"}, "description") + Expect(err).ToNot(HaveOccurred()) + }) + }) + }) }) diff --git a/persistence/sql_annotations.go b/persistence/sql_annotations.go index 6691b553c..07bd96975 100644 --- a/persistence/sql_annotations.go +++ b/persistence/sql_annotations.go @@ -4,6 +4,7 @@ import ( "database/sql" "errors" "fmt" + "strings" "time" . "github.com/Masterminds/squirrel" @@ -17,7 +18,7 @@ const annotationTable = "annotation" func (r sqlRepository) withAnnotation(query SelectBuilder, idField string) SelectBuilder { userID := loggedUser(r.ctx).ID if userID == invalidUserId { - return query + return query.Columns(fmt.Sprintf("%s.average_rating", r.tableName)) } query = query. LeftJoin("annotation on ("+ @@ -28,6 +29,7 @@ func (r sqlRepository) withAnnotation(query SelectBuilder, idField string) Selec "coalesce(rating, 0) as rating", "starred_at", "play_date", + "rated_at", ) if conf.Server.AlbumPlayCountMode == consts.AlbumPlayCountModeNormalized && r.tableName == "album" { query = query.Columns( @@ -37,9 +39,24 @@ func (r sqlRepository) withAnnotation(query SelectBuilder, idField string) Selec query = query.Columns("coalesce(play_count, 0) as play_count") } + query = query.Columns(fmt.Sprintf("%s.average_rating", r.tableName)) + return query } +func annotationBoolFilter(field string) func(string, any) Sqlizer { + return func(_ string, value any) Sqlizer { + v, ok := value.(string) + if !ok { + return nil + } + if strings.ToLower(v) == "true" { + return Expr(fmt.Sprintf("COALESCE(%s, 0) > 0", field)) + } + return Expr(fmt.Sprintf("COALESCE(%s, 0) = 0", field)) + } +} + func (r sqlRepository) annId(itemID ...string) And { userID := loggedUser(r.ctx).ID return And{ @@ -49,7 +66,7 @@ func (r sqlRepository) annId(itemID ...string) And { } } -func (r sqlRepository) annUpsert(values map[string]interface{}, itemIDs ...string) error { +func (r sqlRepository) annUpsert(values map[string]any, itemIDs ...string) error { upd := Update(annotationTable).Where(r.annId(itemIDs...)) for f, v := range values { upd = upd.Set(f, v) @@ -73,11 +90,27 @@ func (r sqlRepository) annUpsert(values map[string]interface{}, itemIDs ...strin func (r sqlRepository) SetStar(starred bool, ids ...string) error { starredAt := time.Now() - return r.annUpsert(map[string]interface{}{"starred": starred, "starred_at": starredAt}, ids...) + return r.annUpsert(map[string]any{"starred": starred, "starred_at": starredAt}, ids...) } func (r sqlRepository) SetRating(rating int, itemID string) error { - return r.annUpsert(map[string]interface{}{"rating": rating}, itemID) + ratedAt := time.Now() + err := r.annUpsert(map[string]any{"rating": rating, "rated_at": ratedAt}, itemID) + if err != nil { + return err + } + return r.updateAvgRating(itemID) +} + +func (r sqlRepository) updateAvgRating(itemID string) error { + upd := Update(r.tableName). + Where(Eq{"id": itemID}). + Set("average_rating", Expr( + "coalesce((select round(avg(rating), 2) from annotation where item_id = ? and item_type = ? and rating > 0), 0)", + itemID, r.tableName, + )) + _, err := r.executeSQL(upd) + return err } func (r sqlRepository) IncPlayCount(itemID string, ts time.Time) error { @@ -88,7 +121,7 @@ func (r sqlRepository) IncPlayCount(itemID string, ts time.Time) error { if c == 0 || errors.Is(err, sql.ErrNoRows) { userID := loggedUser(r.ctx).ID - values := map[string]interface{}{} + values := map[string]any{} values["user_id"] = userID values["item_type"] = r.tableName values["item_id"] = itemID @@ -119,7 +152,7 @@ func (r sqlRepository) cleanAnnotations() error { del := Delete(annotationTable).Where(Eq{"item_type": r.tableName}).Where("item_id not in (select id from " + r.tableName + ")") c, err := r.executeSQL(del) if err != nil { - return fmt.Errorf("error cleaning up annotations: %w", err) + return fmt.Errorf("error cleaning up %s annotations: %w", r.tableName, err) } if c > 0 { log.Debug(r.ctx, "Clean-up annotations", "table", r.tableName, "totalDeleted", c) diff --git a/persistence/sql_annotations_test.go b/persistence/sql_annotations_test.go new file mode 100644 index 000000000..15efc5dc7 --- /dev/null +++ b/persistence/sql_annotations_test.go @@ -0,0 +1,153 @@ +package persistence + +import ( + "context" + + "github.com/Masterminds/squirrel" + "github.com/deluan/rest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Annotation Filters", func() { + var ( + albumRepo *albumRepository + albumWithoutAnnotation model.Album + ) + + BeforeEach(func() { + ctx := request.WithUser(context.Background(), model.User{ID: "userid", UserName: "johndoe"}) + albumRepo = NewAlbumRepository(ctx, GetDBXBuilder()).(*albumRepository) + + // Create album without any annotation (no star, no rating) + albumWithoutAnnotation = model.Album{ID: "no-annotation-album", Name: "No Annotation", LibraryID: 1} + Expect(albumRepo.Put(&albumWithoutAnnotation)).To(Succeed()) + }) + + AfterEach(func() { + _, _ = albumRepo.executeSQL(squirrel.Delete("album").Where(squirrel.Eq{"id": albumWithoutAnnotation.ID})) + }) + + Describe("annotationBoolFilter", func() { + DescribeTable("creates correct SQL expressions", + func(field, value string, expectedSQL string, expectedArgs []any) { + sqlizer := annotationBoolFilter(field)(field, value) + sql, args, err := sqlizer.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(Equal(expectedSQL)) + Expect(args).To(Equal(expectedArgs)) + }, + Entry("starred=true", "starred", "true", "COALESCE(starred, 0) > 0", []any(nil)), + Entry("starred=false", "starred", "false", "COALESCE(starred, 0) = 0", []any(nil)), + Entry("starred=True (case insensitive)", "starred", "True", "COALESCE(starred, 0) > 0", []any(nil)), + Entry("rating=true", "rating", "true", "COALESCE(rating, 0) > 0", []any(nil)), + ) + + It("returns nil if value is not a string", func() { + sqlizer := annotationBoolFilter("starred")("starred", 123) + Expect(sqlizer).To(BeNil()) + }) + }) + + Describe("starredFilter", func() { + It("false includes items without annotations", func() { + albums, err := albumRepo.GetAll(model.QueryOptions{ + Filters: annotationBoolFilter("starred")("starred", "false"), + }) + Expect(err).ToNot(HaveOccurred()) + + var found bool + for _, a := range albums { + if a.ID == albumWithoutAnnotation.ID { + found = true + break + } + } + Expect(found).To(BeTrue(), "Item without annotation should be included in starred=false filter") + }) + + It("true excludes items without annotations", func() { + albums, err := albumRepo.GetAll(model.QueryOptions{ + Filters: annotationBoolFilter("starred")("starred", "true"), + }) + Expect(err).ToNot(HaveOccurred()) + + for _, a := range albums { + Expect(a.ID).ToNot(Equal(albumWithoutAnnotation.ID)) + } + }) + }) + + Describe("hasRatingFilter", func() { + It("false includes items without annotations", func() { + albums, err := albumRepo.GetAll(model.QueryOptions{ + Filters: annotationBoolFilter("rating")("rating", "false"), + }) + Expect(err).ToNot(HaveOccurred()) + + var found bool + for _, a := range albums { + if a.ID == albumWithoutAnnotation.ID { + found = true + break + } + } + Expect(found).To(BeTrue(), "Item without annotation should be included in has_rating=false filter") + }) + + It("true excludes items without annotations", func() { + albums, err := albumRepo.GetAll(model.QueryOptions{ + Filters: annotationBoolFilter("rating")("rating", "true"), + }) + Expect(err).ToNot(HaveOccurred()) + + for _, a := range albums { + Expect(a.ID).ToNot(Equal(albumWithoutAnnotation.ID)) + } + }) + + It("true includes items with rating > 0", func() { + // Create album with rating 1 + ratedAlbum := model.Album{ID: "rated-album", Name: "Rated Album", LibraryID: 1} + Expect(albumRepo.Put(&ratedAlbum)).To(Succeed()) + Expect(albumRepo.SetRating(1, ratedAlbum.ID)).To(Succeed()) + defer func() { + _, _ = albumRepo.executeSQL(squirrel.Delete("annotation").Where(squirrel.Eq{"item_id": ratedAlbum.ID})) + _, _ = albumRepo.executeSQL(squirrel.Delete("album").Where(squirrel.Eq{"id": ratedAlbum.ID})) + }() + + albums, err := albumRepo.GetAll(model.QueryOptions{ + Filters: annotationBoolFilter("rating")("rating", "true"), + }) + Expect(err).ToNot(HaveOccurred()) + + var found bool + for _, a := range albums { + if a.ID == ratedAlbum.ID { + found = true + break + } + } + Expect(found).To(BeTrue(), "Album with rating 5 should be included in has_rating=true filter") + }) + }) + + It("ignores invalid filter values (not strings)", func() { + res, err := albumRepo.ReadAll(rest.QueryOptions{ + Filters: map[string]any{"starred": 123}, + }) + Expect(err).ToNot(HaveOccurred()) + albums := res.(model.Albums) + + var found bool + for _, a := range albums { + if a.ID == albumWithoutAnnotation.ID { + found = true + break + } + } + Expect(found).To(BeTrue(), "Item without annotation should be included when filter is ignored") + }) +}) diff --git a/persistence/sql_base_repository.go b/persistence/sql_base_repository.go index ce026a3c3..fd263d37b 100644 --- a/persistence/sql_base_repository.go +++ b/persistence/sql_base_repository.go @@ -196,7 +196,7 @@ func (r *sqlRepository) withTableName(filter filterFunc) filterFunc { } // libraryIdFilter is a filter function to be added to resources that have a library_id column. -func libraryIdFilter(_ string, value interface{}) Sqlizer { +func libraryIdFilter(_ string, value any) Sqlizer { return Eq{"library_id": value} } @@ -281,7 +281,7 @@ func (r sqlRepository) toSQL(sq Sqlizer) (string, dbx.Params, error) { return result, params, nil } -func (r sqlRepository) queryOne(sq Sqlizer, response interface{}) error { +func (r sqlRepository) queryOne(sq Sqlizer, response any) error { query, args, err := r.toSQL(sq) if err != nil { return err @@ -328,7 +328,7 @@ func queryWithStableResults[T any](r sqlRepository, sq SelectBuilder, options .. }, nil } -func (r sqlRepository) queryAll(sq SelectBuilder, response interface{}, options ...model.QueryOptions) error { +func (r sqlRepository) queryAll(sq SelectBuilder, response any, options ...model.QueryOptions) error { if len(options) > 0 && options[0].Offset > 0 { sq = r.optimizePagination(sq, options[0]) } @@ -347,7 +347,7 @@ func (r sqlRepository) queryAll(sq SelectBuilder, response interface{}, options } // queryAllSlice is a helper function to query a single column and return the result in a slice -func (r sqlRepository) queryAllSlice(sq SelectBuilder, response interface{}) error { +func (r sqlRepository) queryAllSlice(sq SelectBuilder, response any) error { query, args, err := r.toSQL(sq) if err != nil { return err @@ -394,7 +394,7 @@ func (r sqlRepository) count(countQuery SelectBuilder, options ...model.QueryOpt return res.Count, err } -func (r sqlRepository) putByMatch(filter Sqlizer, id string, m interface{}, colsToUpdate ...string) (string, error) { +func (r sqlRepository) putByMatch(filter Sqlizer, id string, m any, colsToUpdate ...string) (string, error) { if id != "" { return r.put(id, m, colsToUpdate...) } @@ -408,14 +408,14 @@ func (r sqlRepository) putByMatch(filter Sqlizer, id string, m interface{}, cols return r.put(res.ID, m, colsToUpdate...) } -func (r sqlRepository) put(id string, m interface{}, colsToUpdate ...string) (newId string, err error) { +func (r sqlRepository) put(id string, m any, colsToUpdate ...string) (newId string, err error) { values, err := toSQLArgs(m) if err != nil { return "", fmt.Errorf("error preparing values to write to DB: %w", err) } // If there's an ID, try to update first if id != "" { - updateValues := map[string]interface{}{} + updateValues := map[string]any{} // This is a map of the columns that need to be updated, if specified c2upd := slice.ToMap(colsToUpdate, func(s string) (string, struct{}) { diff --git a/persistence/sql_bookmarks.go b/persistence/sql_bookmarks.go index 52c4b8e9c..19f16b231 100644 --- a/persistence/sql_bookmarks.go +++ b/persistence/sql_bookmarks.go @@ -37,7 +37,7 @@ func (r sqlRepository) bmkID(itemID ...string) And { func (r sqlRepository) bmkUpsert(itemID, comment string, position int64) error { client, _ := request.ClientFrom(r.ctx) user, _ := request.UserFrom(r.ctx) - values := map[string]interface{}{ + values := map[string]any{ "comment": comment, "position": position, "updated_at": time.Now(), @@ -148,10 +148,10 @@ func (r sqlRepository) cleanBookmarks() error { del := Delete(bookmarkTable).Where(Eq{"item_type": r.tableName}).Where("item_id not in (select id from " + r.tableName + ")") c, err := r.executeSQL(del) if err != nil { - return fmt.Errorf("error cleaning up bookmarks: %w", err) + return fmt.Errorf("error cleaning up %s bookmarks: %w", r.tableName, err) } if c > 0 { - log.Debug(r.ctx, "Clean-up bookmarks", "totalDeleted", c) + log.Debug(r.ctx, "Clean-up bookmarks", "totalDeleted", c, "itemType", r.tableName) } return nil } diff --git a/persistence/sql_participations.go b/persistence/sql_participations.go index d88eca45e..38b0203fa 100644 --- a/persistence/sql_participations.go +++ b/persistence/sql_participations.go @@ -51,8 +51,10 @@ func unmarshalParticipants(data string) (model.Participants, error) { } func (r sqlRepository) updateParticipants(itemID string, participants model.Participants) error { - ids := participants.AllIDs() - sqd := Delete(r.tableName + "_artists").Where(And{Eq{r.tableName + "_id": itemID}, NotEq{"artist_id": ids}}) + // Delete all existing participant entries for this item. + // This ensures stale role associations are removed when an artist's role changes + // (e.g., an artist was both albumartist and composer, but is now only composer). + sqd := Delete(r.tableName + "_artists").Where(Eq{r.tableName + "_id": itemID}) _, err := r.executeSQL(sqd) if err != nil { return err diff --git a/persistence/sql_restful.go b/persistence/sql_restful.go index ff0d06a8b..02162387c 100644 --- a/persistence/sql_restful.go +++ b/persistence/sql_restful.go @@ -109,11 +109,10 @@ func booleanFilter(field string, value any) Sqlizer { func fullTextFilter(tableName string, mbidFields ...string) func(string, any) Sqlizer { return func(field string, value any) Sqlizer { v := strings.ToLower(value.(string)) - cond := cmp.Or( + return cmp.Or[Sqlizer]( mbidExpr(tableName, v, mbidFields...), - fullTextExpr(tableName, v), + getSearchStrategy(tableName, v), ) - return cond } } diff --git a/persistence/sql_restful_test.go b/persistence/sql_restful_test.go index fd95fbb31..32f418b8e 100644 --- a/persistence/sql_restful_test.go +++ b/persistence/sql_restful_test.go @@ -26,11 +26,13 @@ var _ = Describe("sqlRestful", func() { Expect(r.parseRestFilters(context.Background(), options)).To(BeNil()) }) - It(`returns nil if tries a filter with fullTextExpr("'")`, func() { + It(`returns nil if tries a filter with legacySearchExpr("'")`, func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Search.Backend = "legacy" r.filterMappings = map[string]filterFunc{ "name": fullTextFilter("table"), } - options.Filters = map[string]interface{}{"name": "'"} + options.Filters = map[string]any{"name": "'"} Expect(r.parseRestFilters(context.Background(), options)).To(BeEmpty()) }) @@ -40,32 +42,32 @@ var _ = Describe("sqlRestful", func() { return nil }, } - options.Filters = map[string]interface{}{"name": "joe"} + options.Filters = map[string]any{"name": "joe"} Expect(r.parseRestFilters(context.Background(), options)).To(BeEmpty()) }) It("returns a '=' condition for 'id' filter", func() { - options.Filters = map[string]interface{}{"id": "123"} + options.Filters = map[string]any{"id": "123"} Expect(r.parseRestFilters(context.Background(), options)).To(Equal(squirrel.And{squirrel.Eq{"id": "123"}})) }) It("returns a 'in' condition for multiples 'id' filters", func() { - options.Filters = map[string]interface{}{"id": []string{"123", "456"}} + options.Filters = map[string]any{"id": []string{"123", "456"}} Expect(r.parseRestFilters(context.Background(), options)).To(Equal(squirrel.And{squirrel.Eq{"id": []string{"123", "456"}}})) }) It("returns a 'like' condition for other filters", func() { - options.Filters = map[string]interface{}{"name": "joe"} + options.Filters = map[string]any{"name": "joe"} Expect(r.parseRestFilters(context.Background(), options)).To(Equal(squirrel.And{squirrel.Like{"name": "joe%"}})) }) It("uses the custom filter", func() { r.filterMappings = map[string]filterFunc{ - "test": func(field string, value interface{}) squirrel.Sqlizer { + "test": func(field string, value any) squirrel.Sqlizer { return squirrel.Gt{field: value} }, } - options.Filters = map[string]interface{}{"test": 100} + options.Filters = map[string]any{"test": 100} Expect(r.parseRestFilters(context.Background(), options)).To(Equal(squirrel.And{squirrel.Gt{"test": 100}})) }) }) @@ -77,6 +79,7 @@ var _ = Describe("sqlRestful", func() { BeforeEach(func() { DeferCleanup(configtest.SetupConfig()) + conf.Server.Search.Backend = "legacy" tableName = "test_table" mbidFields = []string{"mbid", "artist_mbid"} filter = fullTextFilter(tableName, mbidFields...) @@ -99,11 +102,11 @@ var _ = Describe("sqlRestful", func() { uuid := "550e8400-e29b-41d4-a716-446655440000" result := noMbidFilter("search", uuid) - // mbidExpr with no fields returns nil, so cmp.Or falls back to fullTextExpr - expected := squirrel.And{ - squirrel.Like{"test_table.full_text": "% 550e8400-e29b-41d4-a716-446655440000%"}, - } - Expect(result).To(Equal(expected)) + // mbidExpr with no fields returns nil, so cmp.Or falls back to search strategy + sql, args, err := result.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("test_table.full_text LIKE")) + Expect(args).To(ContainElement("% 550e8400-e29b-41d4-a716-446655440000%")) }) }) @@ -111,54 +114,75 @@ var _ = Describe("sqlRestful", func() { It("returns full text search condition only", func() { result := filter("search", "beatles") - // mbidExpr returns nil for non-UUIDs, so fullTextExpr result is returned directly - expected := squirrel.And{ - squirrel.Like{"test_table.full_text": "% beatles%"}, - } - Expect(result).To(Equal(expected)) + // mbidExpr returns nil for non-UUIDs, so search strategy result is returned directly + sql, args, err := result.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("test_table.full_text LIKE")) + Expect(args).To(ContainElement("% beatles%")) }) It("handles multi-word search terms", func() { result := filter("search", "the beatles abbey road") - // Should return And condition directly - andCondition, ok := result.(squirrel.And) - Expect(ok).To(BeTrue()) - Expect(andCondition).To(HaveLen(4)) - - // Check that all words are present (order may vary) - Expect(andCondition).To(ContainElement(squirrel.Like{"test_table.full_text": "% the%"})) - Expect(andCondition).To(ContainElement(squirrel.Like{"test_table.full_text": "% beatles%"})) - Expect(andCondition).To(ContainElement(squirrel.Like{"test_table.full_text": "% abbey%"})) - Expect(andCondition).To(ContainElement(squirrel.Like{"test_table.full_text": "% road%"})) + sql, args, err := result.ToSql() + Expect(err).ToNot(HaveOccurred()) + // All words should be present as LIKE conditions + Expect(sql).To(ContainSubstring("test_table.full_text LIKE")) + Expect(args).To(HaveLen(4)) + Expect(args).To(ContainElement("% the%")) + Expect(args).To(ContainElement("% beatles%")) + Expect(args).To(ContainElement("% abbey%")) + Expect(args).To(ContainElement("% road%")) }) }) Context("when SearchFullString config changes behavior", func() { It("uses different separator with SearchFullString=false", func() { - conf.Server.SearchFullString = false + conf.Server.Search.FullString = false result := filter("search", "test query") - andCondition, ok := result.(squirrel.And) - Expect(ok).To(BeTrue()) - Expect(andCondition).To(HaveLen(2)) - - // Check that all words are present with leading space (order may vary) - Expect(andCondition).To(ContainElement(squirrel.Like{"test_table.full_text": "% test%"})) - Expect(andCondition).To(ContainElement(squirrel.Like{"test_table.full_text": "% query%"})) + sql, args, err := result.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("test_table.full_text LIKE")) + Expect(args).To(HaveLen(2)) + Expect(args).To(ContainElement("% test%")) + Expect(args).To(ContainElement("% query%")) }) It("uses no separator with SearchFullString=true", func() { - conf.Server.SearchFullString = true + conf.Server.Search.FullString = true result := filter("search", "test query") - andCondition, ok := result.(squirrel.And) - Expect(ok).To(BeTrue()) - Expect(andCondition).To(HaveLen(2)) + sql, args, err := result.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("test_table.full_text LIKE")) + Expect(args).To(HaveLen(2)) + Expect(args).To(ContainElement("%test%")) + Expect(args).To(ContainElement("%query%")) + }) + }) - // Check that all words are present without leading space (order may vary) - Expect(andCondition).To(ContainElement(squirrel.Like{"test_table.full_text": "%test%"})) - Expect(andCondition).To(ContainElement(squirrel.Like{"test_table.full_text": "%query%"})) + Context("single-character queries (regression: must not be rejected)", func() { + It("returns valid filter for single-char query with legacy backend", func() { + conf.Server.Search.Backend = "legacy" + result := filter("search", "a") + Expect(result).ToNot(BeNil(), "single-char REST filter must not be dropped") + sql, args, err := result.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("LIKE")) + Expect(args).ToNot(BeEmpty()) + }) + + It("returns valid filter for single-char query with FTS backend", func() { + conf.Server.Search.Backend = "fts" + conf.Server.Search.FullString = false + ftsFilter := fullTextFilter(tableName, mbidFields...) + result := ftsFilter("search", "a") + Expect(result).ToNot(BeNil(), "single-char REST filter must not be dropped") + sql, args, err := result.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("MATCH")) + Expect(args).ToNot(BeEmpty()) }) }) @@ -176,10 +200,10 @@ var _ = Describe("sqlRestful", func() { It("handles special characters that are sanitized", func() { result := filter("search", "don't") - expected := squirrel.And{ - squirrel.Like{"test_table.full_text": "% dont%"}, // str.SanitizeStrings removes quotes - } - Expect(result).To(Equal(expected)) + sql, args, err := result.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("test_table.full_text LIKE")) + Expect(args).To(ContainElement("% dont%")) }) It("returns nil for single quote (SQL injection protection)", func() { @@ -203,31 +227,30 @@ var _ = Describe("sqlRestful", func() { result := filter("search", "550e8400-invalid-uuid") // Should return full text filter since UUID is invalid - expected := squirrel.And{ - squirrel.Like{"test_table.full_text": "% 550e8400-invalid-uuid%"}, - } - Expect(result).To(Equal(expected)) + sql, args, err := result.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("test_table.full_text LIKE")) + Expect(args).To(ContainElement("% 550e8400-invalid-uuid%")) }) It("handles empty mbid fields array", func() { emptyMbidFilter := fullTextFilter(tableName, []string{}...) result := emptyMbidFilter("search", "test") - // mbidExpr with empty fields returns nil, so cmp.Or falls back to fullTextExpr - expected := squirrel.And{ - squirrel.Like{"test_table.full_text": "% test%"}, - } - Expect(result).To(Equal(expected)) + // mbidExpr with empty fields returns nil, so search strategy result is returned directly + sql, args, err := result.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("test_table.full_text LIKE")) + Expect(args).To(ContainElement("% test%")) }) It("converts value to lowercase before processing", func() { result := filter("search", "TEST") - // The function converts to lowercase internally - expected := squirrel.And{ - squirrel.Like{"test_table.full_text": "% test%"}, - } - Expect(result).To(Equal(expected)) + sql, args, err := result.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("test_table.full_text LIKE")) + Expect(args).To(ContainElement("% test%")) }) }) }) diff --git a/persistence/sql_search.go b/persistence/sql_search.go index 0d3bfb743..43965ebb7 100644 --- a/persistence/sql_search.go +++ b/persistence/sql_search.go @@ -15,36 +15,71 @@ func formatFullText(text ...string) string { return " " + fullText } -// doSearch performs a full-text search with the specified parameters. -// The naturalOrder is used to sort results when no full-text filter is applied. It is useful for cases like -// OpenSubsonic, where an empty search query should return all results in a natural order. Normally the parameter -// should be `tableName + ".rowid"`, but some repositories (ex: artist) may use a different natural order. -func (r sqlRepository) doSearch(sq SelectBuilder, q string, offset, size int, results any, naturalOrder string, orderBys ...string) error { +// searchConfig holds per-repository constants for doSearch. +type searchConfig struct { + NaturalOrder string // ORDER BY for empty-query results (e.g. "album.rowid") + OrderBy []string // ORDER BY for text search results (e.g. ["name"]) + MBIDFields []string // columns to match when query is a UUID + // LibraryFilter overrides the default applyLibraryFilter for FTS Phase 1. + // Needed when library access requires a junction table (e.g. artist → library_artist). + LibraryFilter func(sq SelectBuilder) SelectBuilder +} + +// searchStrategy defines how to execute a text search against a repository table. +// options carries filters and pagination that must reach all query phases, +// including FTS Phase 1 which builds its own query outside sq. +type searchStrategy interface { + Sqlizer + execute(r sqlRepository, sq SelectBuilder, dest any, cfg searchConfig, options model.QueryOptions) error +} + +// getSearchStrategy returns the appropriate search strategy based on config and query content. +// Returns nil when the query produces no searchable tokens. +func getSearchStrategy(tableName, query string) searchStrategy { + if conf.Server.Search.Backend == "legacy" || conf.Server.Search.FullString { + return newLegacySearch(tableName, query) + } + if containsCJK(query) { + return newLikeSearch(tableName, query) + } + return newFTSSearch(tableName, query) +} + +// doSearch dispatches a search query: empty → natural order, UUID → MBID match, +// otherwise delegates to getSearchStrategy. sq must already have LIMIT/OFFSET set +// via newSelect(options...). options is forwarded so FTS Phase 1 can apply the same +// filters and pagination independently. +func (r sqlRepository) doSearch(sq SelectBuilder, q string, results any, cfg searchConfig, options model.QueryOptions) error { q = strings.TrimSpace(q) q = strings.TrimSuffix(q, "*") + + sq = sq.Where(Eq{r.tableName + ".missing": false}) + + // Empty query (OpenSubsonic `search3?query=""`) — return all in natural order. + if q == "" || q == `""` { + sq = sq.OrderBy(cfg.NaturalOrder) + return r.queryAll(sq, results, options) + } + + // MBID search: if query is a valid UUID, search by MBID fields instead + if uuid.Validate(q) == nil && len(cfg.MBIDFields) > 0 { + sq = sq.Where(mbidExpr(r.tableName, q, cfg.MBIDFields...)) + return r.queryAll(sq, results) + } + + // Min-length guard: single-character queries are too broad for search3. + // This check lives here (not in the strategies) so that fullTextFilter + // (REST filter path) can still use single-character queries. if len(q) < 2 { return nil } - filter := fullTextExpr(r.tableName, q) - if filter != nil { - sq = sq.Where(filter) - sq = sq.OrderBy(orderBys...) - } else { - // This is to speed up the results of `search3?query=""`, for OpenSubsonic - // If the filter is empty, we sort by the specified natural order. - sq = sq.OrderBy(naturalOrder) + strategy := getSearchStrategy(r.tableName, q) + if strategy == nil { + return nil } - sq = sq.Where(Eq{r.tableName + ".missing": false}) - sq = sq.Limit(uint64(size)).Offset(uint64(offset)) - return r.queryAll(sq, results, model.QueryOptions{Offset: offset}) -} -func (r sqlRepository) searchByMBID(sq SelectBuilder, mbid string, mbidFields []string, results any) error { - sq = sq.Where(mbidExpr(r.tableName, mbid, mbidFields...)) - sq = sq.Where(Eq{r.tableName + ".missing": false}) - - return r.queryAll(sq, results) + return strategy.execute(r, sq, results, cfg, options) } func mbidExpr(tableName, mbid string, mbidFields ...string) Sqlizer { @@ -58,20 +93,3 @@ func mbidExpr(tableName, mbid string, mbidFields ...string) Sqlizer { } return Or(cond) } - -func fullTextExpr(tableName string, s string) Sqlizer { - q := str.SanitizeStrings(s) - if q == "" { - return nil - } - var sep string - if !conf.Server.SearchFullString { - sep = " " - } - parts := strings.Split(q, " ") - filters := And{} - for _, part := range parts { - filters = append(filters, Like{tableName + ".full_text": "%" + sep + part + "%"}) - } - return filters -} diff --git a/persistence/sql_search_fts.go b/persistence/sql_search_fts.go new file mode 100644 index 000000000..9eb01f0cf --- /dev/null +++ b/persistence/sql_search_fts.go @@ -0,0 +1,422 @@ +package persistence + +import ( + "fmt" + "regexp" + "strings" + "unicode" + "unicode/utf8" + + . "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" +) + +// containsCJK returns true if the string contains any CJK (Chinese/Japanese/Korean) characters. +// CJK text doesn't use spaces between words, so FTS5's unicode61 tokenizer treats entire +// CJK phrases as single tokens, making token-based search ineffective for CJK content. +func containsCJK(s string) bool { + for _, r := range s { + if unicode.Is(unicode.Han, r) || + unicode.Is(unicode.Hiragana, r) || + unicode.Is(unicode.Katakana, r) || + unicode.Is(unicode.Hangul, r) { + return true + } + } + return false +} + +// fts5SpecialChars matches characters that should be stripped from user input. +// We keep only Unicode letters, numbers, whitespace, * (prefix wildcard), " (phrase quotes), +// and \x00 (internal placeholder marker). All punctuation is removed because the unicode61 +// tokenizer treats it as token separators, and characters like ' can cause FTS5 parse errors +// as unbalanced string delimiters. +var fts5SpecialChars = regexp.MustCompile(`[^\p{L}\p{N}\s*"\x00]`) + +// fts5PunctStrip strips everything except letters and numbers (no whitespace, wildcards, or quotes). +// Used for normalizing words at index time to create concatenated forms (e.g., "R.E.M." → "REM"). +var fts5PunctStrip = regexp.MustCompile(`[^\p{L}\p{N}]`) + +// fts5Operators matches FTS5 boolean operators as whole words (case-insensitive). +var fts5Operators = regexp.MustCompile(`(?i)\b(AND|OR|NOT|NEAR)\b`) + +// fts5LeadingStar matches a * at the start of a token. FTS5 only supports * at the end (prefix queries). +var fts5LeadingStar = regexp.MustCompile(`(^|[\s])\*+`) + +// normalizeForFTS takes multiple strings, strips non-letter/non-number characters from each word, +// and returns a space-separated string of words that changed after stripping (deduplicated). +// This is used at index time to create concatenated forms: "R.E.M." → "REM", "AC/DC" → "ACDC". +func normalizeForFTS(values ...string) string { + seen := make(map[string]struct{}) + var result []string + for _, v := range values { + for _, word := range strings.Fields(v) { + stripped := fts5PunctStrip.ReplaceAllString(word, "") + if stripped == "" || stripped == word { + continue + } + lower := strings.ToLower(stripped) + if _, ok := seen[lower]; ok { + continue + } + seen[lower] = struct{}{} + result = append(result, stripped) + } + } + return strings.Join(result, " ") +} + +// isSingleUnicodeLetter returns true if token is exactly one Unicode letter. +func isSingleUnicodeLetter(token string) bool { + r, size := utf8.DecodeRuneInString(token) + return size == len(token) && size > 0 && unicode.IsLetter(r) +} + +// namePunctuation is the set of characters commonly used as separators in artist/album +// names (hyphens, slashes, dots, apostrophes). Only words containing these are candidates +// for punctuated-word processing; other special characters (^, :, &) are just stripped. +const namePunctuation = `-/.''` + +// processPunctuatedWords handles words with embedded name punctuation before the general +// special-character stripping. For each punctuated word it produces either: +// - A quoted phrase for dotted abbreviations: R.E.M. → "R E M" +// - A phrase+concat OR for other patterns: a-ha → ("a ha" OR aha*) +func processPunctuatedWords(input string, phrases []string) (string, []string) { + words := strings.Fields(input) + var result []string + for _, w := range words { + if strings.HasPrefix(w, "\x00") || strings.ContainsAny(w, `*"`) || !strings.ContainsAny(w, namePunctuation) { + result = append(result, w) + continue + } + concat := fts5PunctStrip.ReplaceAllString(w, "") + if concat == "" || concat == w { + result = append(result, w) + continue + } + subTokens := strings.Fields(fts5SpecialChars.ReplaceAllString(w, " ")) + if len(subTokens) < 2 { + // Single sub-token after splitting (e.g., N' → N): just use the stripped form + result = append(result, concat) + continue + } + // Dotted abbreviations (R.E.M., U.K.) — all single letters separated by dots only + if isDottedAbbreviation(w, subTokens) { + phrases = append(phrases, fmt.Sprintf(`"%s"`, strings.Join(subTokens, " "))) + } else { + // Punctuated names (a-ha, AC/DC, Jay-Z) — phrase for adjacency + concat for search_normalized + phrases = append(phrases, fmt.Sprintf(`("%s" OR %s*)`, strings.Join(subTokens, " "), concat)) + } + result = append(result, fmt.Sprintf("\x00PHRASE%d\x00", len(phrases)-1)) + } + return strings.Join(result, " "), phrases +} + +// isDottedAbbreviation returns true if w uses only dots as punctuation and all sub-tokens +// are single letters (e.g., "R.E.M.", "U.K." but not "a-ha" or "AC/DC"). +func isDottedAbbreviation(w string, subTokens []string) bool { + for _, r := range w { + if !unicode.IsLetter(r) && !unicode.IsNumber(r) && r != '.' { + return false + } + } + for _, st := range subTokens { + if !isSingleUnicodeLetter(st) { + return false + } + } + return true +} + +// buildFTS5Query preprocesses user input into a safe FTS5 MATCH expression. +// It preserves quoted phrases and * prefix wildcards, neutralizes FTS5 operators +// (by lowercasing them, since FTS5 operators are case-sensitive) and strips +// special characters to prevent query injection. +func buildFTS5Query(userInput string) string { + q := strings.TrimSpace(userInput) + if q == "" || q == `""` { + return "" + } + + var phrases []string + result := q + for { + start := strings.Index(result, `"`) + if start == -1 { + break + } + end := strings.Index(result[start+1:], `"`) + if end == -1 { + // Unmatched quote — remove it + result = result[:start] + result[start+1:] + break + } + end += start + 1 + phrase := result[start : end+1] // includes quotes + phrases = append(phrases, phrase) + result = result[:start] + fmt.Sprintf("\x00PHRASE%d\x00", len(phrases)-1) + result[end+1:] + } + + // Neutralize FTS5 operators by lowercasing them (FTS5 operators are case-sensitive: + // AND, OR, NOT, NEAR are operators, but and, or, not, near are plain tokens) + result = fts5Operators.ReplaceAllStringFunc(result, strings.ToLower) + + // Handle words with embedded punctuation (a-ha, AC/DC, R.E.M.) before stripping + result, phrases = processPunctuatedWords(result, phrases) + + result = fts5SpecialChars.ReplaceAllString(result, " ") + result = fts5LeadingStar.ReplaceAllString(result, "$1") + tokens := strings.Fields(result) + + // Append * to plain tokens for prefix matching (e.g., "love" → "love*"). + // Skip tokens that are already wildcarded or are quoted phrase placeholders. + for i, t := range tokens { + if strings.HasPrefix(t, "\x00") || strings.HasSuffix(t, "*") { + continue + } + tokens[i] = t + "*" + } + + result = strings.Join(tokens, " ") + + for i, phrase := range phrases { + placeholder := fmt.Sprintf("\x00PHRASE%d\x00", i) + result = strings.ReplaceAll(result, placeholder, phrase) + } + + return result +} + +// ftsColumn pairs an FTS5 column name with its BM25 relevance weight. +type ftsColumn struct { + Name string + Weight float64 +} + +// ftsColumnDefs defines FTS5 columns and their BM25 relevance weights. +// The order MUST match the column order in the FTS5 table definition (see migrations). +// All columns are both searched and ranked. When adding indexed-but-not-searched +// columns in the future, use Weight: 0 to exclude from the search column filter. +var ftsColumnDefs = map[string][]ftsColumn{ + "media_file": { + {"title", 10.0}, + {"album", 5.0}, + {"artist", 3.0}, + {"album_artist", 3.0}, + {"sort_title", 1.0}, + {"sort_album_name", 1.0}, + {"sort_artist_name", 1.0}, + {"sort_album_artist_name", 1.0}, + {"disc_subtitle", 1.0}, + {"search_participants", 2.0}, + {"search_normalized", 1.0}, + }, + "album": { + {"name", 10.0}, + {"sort_album_name", 1.0}, + {"album_artist", 3.0}, + {"search_participants", 2.0}, + {"discs", 1.0}, + {"catalog_num", 1.0}, + {"album_version", 1.0}, + {"search_normalized", 1.0}, + }, + "artist": { + {"name", 10.0}, + {"sort_artist_name", 1.0}, + {"search_normalized", 1.0}, + }, +} + +// ftsColumnFilters and ftsBM25Weights are precomputed from ftsColumnDefs at init time +// to avoid per-query allocations. +var ( + ftsColumnFilters = map[string]string{} + ftsBM25Weights = map[string]string{} +) + +func init() { + for table, cols := range ftsColumnDefs { + var names []string + weights := make([]string, len(cols)) + for i, c := range cols { + if c.Weight > 0 { + names = append(names, c.Name) + } + weights[i] = fmt.Sprintf("%.1f", c.Weight) + } + ftsColumnFilters[table] = "{" + strings.Join(names, " ") + "}" + ftsBM25Weights[table] = strings.Join(weights, ", ") + } +} + +// ftsSearch implements searchStrategy using FTS5 full-text search with BM25 ranking. +type ftsSearch struct { + tableName string + ftsTable string + matchExpr string + rankExpr string +} + +// ToSql returns a single-query fallback for the REST filter path (no two-phase split). +func (s *ftsSearch) ToSql() (string, []interface{}, error) { + sql := s.tableName + ".rowid IN (SELECT rowid FROM " + s.ftsTable + " WHERE " + s.ftsTable + " MATCH ?)" + return sql, []interface{}{s.matchExpr}, nil +} + +// execute runs a two-phase FTS5 search: +// - Phase 1: lightweight rowid query (main table + FTS + library filter) for ranking and pagination. +// - Phase 2: full SELECT with all JOINs, scoped to Phase 1's rowid set. +// +// Complex ORDER BY (function calls, aggregations) are dropped from Phase 1. +func (s *ftsSearch) execute(r sqlRepository, sq SelectBuilder, dest any, cfg searchConfig, options model.QueryOptions) error { + qualifiedOrderBys := []string{s.rankExpr} + for _, ob := range cfg.OrderBy { + if qualified := qualifyOrderBy(s.tableName, ob); qualified != "" { + qualifiedOrderBys = append(qualifiedOrderBys, qualified) + } + } + + // Phase 1: fresh query — must set LIMIT/OFFSET from options explicitly. + // Mirror applyOptions behavior: Max=0 means no limit, not LIMIT 0. + rowidQuery := Select(s.tableName+".rowid"). + From(s.tableName). + Join(s.ftsTable+" ON "+s.ftsTable+".rowid = "+s.tableName+".rowid AND "+s.ftsTable+" MATCH ?", s.matchExpr). + Where(Eq{s.tableName + ".missing": false}). + OrderBy(qualifiedOrderBys...) + if options.Max > 0 { + rowidQuery = rowidQuery.Limit(uint64(options.Max)) + } + if options.Offset > 0 { + rowidQuery = rowidQuery.Offset(uint64(options.Offset)) + } + + // Library filter + musicFolderId must be applied here, before pagination. + if cfg.LibraryFilter != nil { + rowidQuery = cfg.LibraryFilter(rowidQuery) + } else { + rowidQuery = r.applyLibraryFilter(rowidQuery) + } + if options.Filters != nil { + rowidQuery = rowidQuery.Where(options.Filters) + } + + rowidSQL, rowidArgs, err := rowidQuery.ToSql() + if err != nil { + return fmt.Errorf("building FTS rowid query: %w", err) + } + + // Phase 2: strip LIMIT/OFFSET from sq (Phase 1 handled pagination), + // join on the ranked rowid set to hydrate with full columns. + sq = sq.RemoveLimit().RemoveOffset() + rankedSubquery := fmt.Sprintf( + "(SELECT rowid as _rid, row_number() OVER () AS _rn FROM (%s)) AS _ranked", + rowidSQL, + ) + sq = sq.Join(rankedSubquery+" ON "+s.tableName+".rowid = _ranked._rid", rowidArgs...) + sq = sq.OrderBy("_ranked._rn") + return r.queryAll(sq, dest) +} + +// qualifyOrderBy prepends tableName to a simple column name. Returns empty string for +// complex expressions (function calls, aggregations) that can't be used in Phase 1. +func qualifyOrderBy(tableName, orderBy string) string { + orderBy = strings.TrimSpace(orderBy) + if orderBy == "" || strings.ContainsAny(orderBy, "(,") { + return "" + } + parts := strings.Fields(orderBy) + if !strings.Contains(parts[0], ".") { + parts[0] = tableName + "." + parts[0] + } + return strings.Join(parts, " ") +} + +// ftsQueryDegraded returns true when the FTS query lost significant discriminating +// content compared to the original input. This happens when special characters that +// are part of the entity name (e.g., "1+", "C++", "!!!", "C#") get stripped by FTS +// tokenization, leaving only very short/broad tokens. Also detects quoted phrases +// that would be degraded by FTS5's unicode61 tokenizer (e.g., "1+" → token "1"). +func ftsQueryDegraded(original, ftsQuery string) bool { + original = strings.TrimSpace(original) + if original == "" || ftsQuery == "" { + return false + } + // Strip quotes from original for comparison — we want the raw content + stripped := strings.ReplaceAll(original, `"`, "") + // Extract the alphanumeric content from the original query + alphaNum := fts5PunctStrip.ReplaceAllString(stripped, "") + // If the original is entirely alphanumeric, nothing was stripped — not degraded + if len(alphaNum) == len(stripped) { + return false + } + // Check if all effective FTS tokens are very short (≤2 chars). + // Short tokens with prefix matching are too broad when special chars were stripped. + // For quoted phrases, extract the content and check the tokens inside. + tokens := strings.Fields(ftsQuery) + for _, t := range tokens { + t = strings.TrimSuffix(t, "*") + // Skip internal phrase placeholders + if strings.HasPrefix(t, "\x00") { + return false + } + // For OR groups from processPunctuatedWords (e.g., ("a ha" OR aha*)), + // the punctuated word was already handled meaningfully — not degraded. + if strings.HasPrefix(t, "(") { + return false + } + // For quoted phrases, check the tokens inside as FTS5 will tokenize them + if strings.HasPrefix(t, `"`) { + // Extract content between quotes + inner := strings.Trim(t, `"`) + innerAlpha := fts5PunctStrip.ReplaceAllString(inner, " ") + for _, it := range strings.Fields(innerAlpha) { + if len(it) > 2 { + return false + } + } + continue + } + if len(t) > 2 { + return false + } + } + return true +} + +// newFTSSearch creates an FTS5 search strategy. Falls back to LIKE search if the +// query produces no FTS tokens (e.g., punctuation-only like "!!!!!!!") or if FTS +// tokenization stripped significant content from the query (e.g., "1+" → "1*"). +// Returns nil when the query produces no searchable tokens at all. +func newFTSSearch(tableName, query string) searchStrategy { + q := buildFTS5Query(query) + if q == "" || ftsQueryDegraded(query, q) { + // Fallback: try LIKE search with the raw query + cleaned := strings.TrimSpace(strings.ReplaceAll(query, `"`, "")) + if cleaned != "" { + log.Trace("Search using LIKE fallback for non-tokenizable query", "table", tableName, "query", cleaned) + return newLikeSearch(tableName, cleaned) + } + return nil + } + ftsTable := tableName + "_fts" + matchExpr := q + if cols, ok := ftsColumnFilters[tableName]; ok { + matchExpr = cols + " : (" + q + ")" + } + + rankExpr := ftsTable + ".rank" + if weights, ok := ftsBM25Weights[tableName]; ok { + rankExpr = "bm25(" + ftsTable + ", " + weights + ")" + } + + s := &ftsSearch{ + tableName: tableName, + ftsTable: ftsTable, + matchExpr: matchExpr, + rankExpr: rankExpr, + } + log.Trace("Search using FTS5 backend", "table", tableName, "query", q, "filter", s) + return s +} diff --git a/persistence/sql_search_fts_test.go b/persistence/sql_search_fts_test.go new file mode 100644 index 000000000..337d54201 --- /dev/null +++ b/persistence/sql_search_fts_test.go @@ -0,0 +1,435 @@ +package persistence + +import ( + "context" + + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = DescribeTable("buildFTS5Query", + func(input, expected string) { + Expect(buildFTS5Query(input)).To(Equal(expected)) + }, + Entry("returns empty string for empty input", "", ""), + Entry("returns empty string for whitespace-only input", " ", ""), + Entry("appends * to a single word for prefix matching", "beatles", "beatles*"), + Entry("appends * to each word for prefix matching", "abbey road", "abbey* road*"), + Entry("preserves quoted phrases without appending *", `"the beatles"`, `"the beatles"`), + Entry("does not double-append * to existing prefix wildcard", "beat*", "beat*"), + Entry("strips FTS5 operators and appends * to lowercased words", "AND OR NOT NEAR", "and* or* not* near*"), + Entry("strips special FTS5 syntax characters and appends *", "test^col:val", "test* col* val*"), + Entry("handles mixed phrases and words", `"the beatles" abbey`, `"the beatles" abbey*`), + Entry("handles prefix with multiple words", "beat* abbey", "beat* abbey*"), + Entry("collapses multiple spaces", "abbey road", "abbey* road*"), + Entry("strips leading * from tokens and appends trailing *", "*livia", "livia*"), + Entry("strips leading * and preserves existing trailing *", "*livia oliv*", "livia* oliv*"), + Entry("strips standalone *", "*", ""), + Entry("strips apostrophe from input", "Guns N' Roses", "Guns* N* Roses*"), + Entry("converts slashed word to phrase+concat OR", "AC/DC", `("AC DC" OR ACDC*)`), + Entry("converts hyphenated word to phrase+concat OR", "a-ha", `("a ha" OR aha*)`), + Entry("converts partial hyphenated word to phrase+concat OR", "a-h", `("a h" OR ah*)`), + Entry("converts hyphenated name to phrase+concat OR", "Jay-Z", `("Jay Z" OR JayZ*)`), + Entry("converts contraction to phrase+concat OR", "it's", `("it s" OR its*)`), + Entry("handles punctuated word mixed with plain words", "best of a-ha", `best* of* ("a ha" OR aha*)`), + Entry("strips miscellaneous punctuation", "rock & roll, vol. 2", "rock* roll* vol* 2*"), + Entry("preserves unicode characters with diacritics", "Björk début", "Björk* début*"), + Entry("collapses dotted abbreviation into phrase", "R.E.M.", `"R E M"`), + Entry("collapses abbreviation without trailing dot", "R.E.M", `"R E M"`), + Entry("collapses abbreviation mixed with words", "best of R.E.M.", `best* of* "R E M"`), + Entry("collapses two-letter abbreviation", "U.K.", `"U K"`), + Entry("does not collapse single letter surrounded by words", "I am fine", "I* am* fine*"), + Entry("does not collapse single standalone letter", "A test", "A* test*"), + Entry("preserves quoted phrase with punctuation verbatim", `"ac/dc"`, `"ac/dc"`), + Entry("preserves quoted abbreviation verbatim", `"R.E.M."`, `"R.E.M."`), + Entry("returns empty string for punctuation-only input", "!!!!!!!", ""), + Entry("returns empty string for mixed punctuation", "!@#$%^&", ""), + Entry("returns empty string for empty quoted phrase", `""`, ""), +) + +var _ = DescribeTable("ftsQueryDegraded", + func(original, ftsQuery string, expected bool) { + Expect(ftsQueryDegraded(original, ftsQuery)).To(Equal(expected)) + }, + Entry("not degraded for empty original", "", "1*", false), + Entry("not degraded for empty ftsQuery", "1+", "", false), + Entry("not degraded for purely alphanumeric query", "beatles", "beatles*", false), + Entry("not degraded when long tokens remain", "test^val", "test* val*", false), + Entry("not degraded for quoted phrase with long tokens", `"the beatles"`, `"the beatles"`, false), + Entry("degraded for quoted phrase with only short tokens after tokenizer strips special chars", `"1+"`, `"1+"`, true), + Entry("not degraded for quoted phrase with meaningful content", `"C++ programming"`, `"C++ programming"`, false), + Entry("degraded when special chars stripped leaving short token", "1+", "1*", true), + Entry("degraded when special chars stripped leaving two short tokens", "C# 1", "C* 1*", true), + Entry("not degraded when at least one long token remains", "1+ beatles", "1* beatles*", false), + Entry("not degraded for OR groups from processPunctuatedWords", "AC/DC", `("AC DC" OR ACDC*)`, false), +) + +var _ = DescribeTable("normalizeForFTS", + func(expected string, values ...string) { + Expect(normalizeForFTS(values...)).To(Equal(expected)) + }, + Entry("strips dots and concatenates", "REM", "R.E.M."), + Entry("strips slash", "ACDC", "AC/DC"), + Entry("strips hyphen", "Aha", "A-ha"), + Entry("skips unchanged words", "", "The Beatles"), + Entry("handles mixed input", "REM", "R.E.M.", "Automatic for the People"), + Entry("deduplicates", "REM", "R.E.M.", "R.E.M."), + Entry("strips apostrophe from word", "N", "Guns N' Roses"), + Entry("handles multiple values with punctuation", "REM ACDC", "R.E.M.", "AC/DC"), +) + +var _ = DescribeTable("containsCJK", + func(input string, expected bool) { + Expect(containsCJK(input)).To(Equal(expected)) + }, + Entry("returns false for empty string", "", false), + Entry("returns false for ASCII text", "hello world", false), + Entry("returns false for Latin with diacritics", "Björk début", false), + Entry("detects Chinese characters (Han)", "周杰伦", true), + Entry("detects Japanese Hiragana", "こんにちは", true), + Entry("detects Japanese Katakana", "カタカナ", true), + Entry("detects Korean Hangul", "한국어", true), + Entry("detects CJK mixed with Latin", "best of 周杰伦", true), + Entry("detects single CJK character", "a曲b", true), +) + +var _ = DescribeTable("qualifyOrderBy", + func(tableName, orderBy, expected string) { + Expect(qualifyOrderBy(tableName, orderBy)).To(Equal(expected)) + }, + Entry("returns empty string for empty input", "artist", "", ""), + Entry("qualifies simple column with table name", "artist", "name", "artist.name"), + Entry("qualifies column with direction", "artist", "name desc", "artist.name desc"), + Entry("preserves already-qualified column", "artist", "artist.name", "artist.name"), + Entry("preserves already-qualified column with direction", "artist", "artist.name desc", "artist.name desc"), + Entry("returns empty for function call expression", "artist", "sum(json_extract(stats, '$.total.m')) desc", ""), + Entry("returns empty for expression with comma", "artist", "a, b", ""), + Entry("qualifies media_file column", "media_file", "title", "media_file.title"), +) + +var _ = Describe("ftsColumnDefs helpers", func() { + Describe("ftsColumnFilters", func() { + It("returns column filter for media_file", func() { + Expect(ftsColumnFilters).To(HaveKeyWithValue("media_file", + "{title album artist album_artist sort_title sort_album_name sort_artist_name sort_album_artist_name disc_subtitle search_participants search_normalized}", + )) + }) + + It("returns column filter for album", func() { + Expect(ftsColumnFilters).To(HaveKeyWithValue("album", + "{name sort_album_name album_artist search_participants discs catalog_num album_version search_normalized}", + )) + }) + + It("returns column filter for artist", func() { + Expect(ftsColumnFilters).To(HaveKeyWithValue("artist", + "{name sort_artist_name search_normalized}", + )) + }) + + It("has no entry for unknown table", func() { + Expect(ftsColumnFilters).ToNot(HaveKey("unknown")) + }) + }) + + Describe("ftsBM25Weights", func() { + It("returns weight CSV for media_file", func() { + Expect(ftsBM25Weights).To(HaveKeyWithValue("media_file", + "10.0, 5.0, 3.0, 3.0, 1.0, 1.0, 1.0, 1.0, 1.0, 2.0, 1.0", + )) + }) + + It("returns weight CSV for album", func() { + Expect(ftsBM25Weights).To(HaveKeyWithValue("album", + "10.0, 1.0, 3.0, 2.0, 1.0, 1.0, 1.0, 1.0", + )) + }) + + It("returns weight CSV for artist", func() { + Expect(ftsBM25Weights).To(HaveKeyWithValue("artist", + "10.0, 1.0, 1.0", + )) + }) + + It("has no entry for unknown table", func() { + Expect(ftsBM25Weights).ToNot(HaveKey("unknown")) + }) + }) + + It("has definitions for all known tables", func() { + for _, table := range []string{"media_file", "album", "artist"} { + Expect(ftsColumnDefs).To(HaveKey(table)) + Expect(ftsColumnDefs[table]).ToNot(BeEmpty()) + } + }) + + It("has matching column count between filter and weights", func() { + for table, cols := range ftsColumnDefs { + // Column filter only includes Weight > 0 columns + filterCount := 0 + for _, c := range cols { + if c.Weight > 0 { + filterCount++ + } + } + // For now, all columns have Weight > 0, so filter count == total count + Expect(filterCount).To(Equal(len(cols)), "table %s: all columns should have positive weights", table) + } + }) +}) + +var _ = Describe("newFTSSearch", func() { + It("returns nil for empty query", func() { + Expect(newFTSSearch("media_file", "")).To(BeNil()) + }) + + It("returns non-nil for single-character query", func() { + strategy := newFTSSearch("media_file", "a") + Expect(strategy).ToNot(BeNil(), "single-char queries must not be rejected; min-length is enforced in doSearch, not here") + sql, _, err := strategy.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("MATCH")) + }) + + It("returns ftsSearch with correct table names and MATCH expression", func() { + strategy := newFTSSearch("media_file", "beatles") + fts, ok := strategy.(*ftsSearch) + Expect(ok).To(BeTrue()) + Expect(fts.tableName).To(Equal("media_file")) + Expect(fts.ftsTable).To(Equal("media_file_fts")) + Expect(fts.matchExpr).To(HavePrefix("{title album artist album_artist")) + Expect(fts.matchExpr).To(ContainSubstring("beatles*")) + }) + + It("ToSql generates rowid IN subquery with MATCH (fallback path)", func() { + strategy := newFTSSearch("media_file", "beatles") + sql, args, err := strategy.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("media_file.rowid IN")) + Expect(sql).To(ContainSubstring("media_file_fts")) + Expect(sql).To(ContainSubstring("MATCH")) + Expect(args).To(HaveLen(1)) + }) + + It("generates correct FTS table name per entity", func() { + for _, table := range []string{"media_file", "album", "artist"} { + strategy := newFTSSearch(table, "test") + fts, ok := strategy.(*ftsSearch) + Expect(ok).To(BeTrue()) + Expect(fts.tableName).To(Equal(table)) + Expect(fts.ftsTable).To(Equal(table + "_fts")) + } + }) + + It("builds bm25() rank expression with column weights", func() { + strategy := newFTSSearch("media_file", "beatles") + fts, ok := strategy.(*ftsSearch) + Expect(ok).To(BeTrue()) + Expect(fts.rankExpr).To(HavePrefix("bm25(media_file_fts,")) + Expect(fts.rankExpr).To(ContainSubstring("10.0")) + + strategy = newFTSSearch("artist", "beatles") + fts, ok = strategy.(*ftsSearch) + Expect(ok).To(BeTrue()) + Expect(fts.rankExpr).To(HavePrefix("bm25(artist_fts,")) + }) + + It("falls back to ftsTable.rank for unknown tables", func() { + strategy := newFTSSearch("unknown_table", "test") + fts, ok := strategy.(*ftsSearch) + Expect(ok).To(BeTrue()) + Expect(fts.rankExpr).To(Equal("unknown_table_fts.rank")) + }) + + It("wraps query with column filter for known tables", func() { + strategy := newFTSSearch("artist", "Beatles") + fts, ok := strategy.(*ftsSearch) + Expect(ok).To(BeTrue()) + Expect(fts.matchExpr).To(Equal("{name sort_artist_name search_normalized} : (Beatles*)")) + }) + + It("passes query without column filter for unknown tables", func() { + strategy := newFTSSearch("unknown_table", "test") + fts, ok := strategy.(*ftsSearch) + Expect(ok).To(BeTrue()) + Expect(fts.matchExpr).To(Equal("test*")) + }) + + It("preserves phrase queries inside column filter", func() { + strategy := newFTSSearch("media_file", `"the beatles"`) + fts, ok := strategy.(*ftsSearch) + Expect(ok).To(BeTrue()) + Expect(fts.matchExpr).To(ContainSubstring(`"the beatles"`)) + }) + + It("preserves prefix queries inside column filter", func() { + strategy := newFTSSearch("media_file", "beat*") + fts, ok := strategy.(*ftsSearch) + Expect(ok).To(BeTrue()) + Expect(fts.matchExpr).To(ContainSubstring("beat*")) + }) + + It("falls back to LIKE search for punctuation-only query", func() { + strategy := newFTSSearch("media_file", "!!!!!!!") + Expect(strategy).ToNot(BeNil()) + _, ok := strategy.(*ftsSearch) + Expect(ok).To(BeFalse(), "punctuation-only should fall back to LIKE, not FTS") + sql, args, err := strategy.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("LIKE")) + Expect(args).To(ContainElement("%!!!!!!!%")) + }) + + It("falls back to LIKE search for degraded query (special chars stripped leaving short tokens)", func() { + strategy := newFTSSearch("album", "1+") + Expect(strategy).ToNot(BeNil()) + _, ok := strategy.(*ftsSearch) + Expect(ok).To(BeFalse(), "degraded query should fall back to LIKE, not FTS") + sql, args, err := strategy.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("LIKE")) + Expect(args).To(ContainElement("%1+%")) + }) + + It("returns nil for empty string even with LIKE fallback", func() { + Expect(newFTSSearch("media_file", "")).To(BeNil()) + Expect(newFTSSearch("media_file", " ")).To(BeNil()) + }) + + It("returns nil for empty quoted phrase", func() { + Expect(newFTSSearch("media_file", `""`)).To(BeNil()) + }) +}) + +var _ = Describe("FTS5 Integration Search", func() { + var ( + mr model.MediaFileRepository + alr model.AlbumRepository + arr model.ArtistRepository + ) + + BeforeEach(func() { + ctx := log.NewContext(context.TODO()) + ctx = request.WithUser(ctx, adminUser) + conn := GetDBXBuilder() + mr = NewMediaFileRepository(ctx, conn) + alr = NewAlbumRepository(ctx, conn) + arr = NewArtistRepository(ctx, conn) + }) + + Describe("MediaFile search", func() { + It("finds media files by title", func() { + results, err := mr.Search("Radioactivity", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].Title).To(Equal("Radioactivity")) + Expect(results[0].ID).To(Equal(songRadioactivity.ID)) + }) + + It("finds media files by artist name", func() { + results, err := mr.Search("Beatles", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(3)) + for _, r := range results { + Expect(r.Artist).To(Equal("The Beatles")) + } + }) + }) + + Describe("Album search", func() { + It("finds albums by name", func() { + results, err := alr.Search("Sgt Peppers", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].Name).To(Equal("Sgt Peppers")) + Expect(results[0].ID).To(Equal(albumSgtPeppers.ID)) + }) + + It("finds albums with multi-word search", func() { + results, err := alr.Search("Abbey Road", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(2)) + }) + }) + + Describe("Artist search", func() { + It("finds artists by name", func() { + results, err := arr.Search("Kraftwerk", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].Name).To(Equal("Kraftwerk")) + Expect(results[0].ID).To(Equal(artistKraftwerk.ID)) + }) + }) + + Describe("CJK search", func() { + It("finds media files by CJK title", func() { + results, err := mr.Search("プラチナ", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].Title).To(Equal("プラチナ・ジェット")) + Expect(results[0].ID).To(Equal(songCJK.ID)) + }) + + It("finds media files by CJK artist name", func() { + results, err := mr.Search("シートベルツ", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].Artist).To(Equal("シートベルツ")) + }) + + It("finds albums by CJK artist name", func() { + results, err := alr.Search("シートベルツ", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].Name).To(Equal("COWBOY BEBOP")) + Expect(results[0].ID).To(Equal(albumCJK.ID)) + }) + + It("finds artists by CJK name", func() { + results, err := arr.Search("シートベルツ", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].Name).To(Equal("シートベルツ")) + Expect(results[0].ID).To(Equal(artistCJK.ID)) + }) + }) + + Describe("Album version search", func() { + It("finds albums by version tag via FTS", func() { + results, err := alr.Search("Deluxe", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].ID).To(Equal(albumWithVersion.ID)) + }) + }) + + Describe("Punctuation-only search", func() { + It("finds media files with punctuation-only title", func() { + results, err := mr.Search("!!!!!!!", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].Title).To(Equal("!!!!!!!")) + Expect(results[0].ID).To(Equal(songPunctuation.ID)) + }) + }) + + Describe("Single-character search (doSearch min-length guard)", func() { + It("returns empty results for single-char query via Search", func() { + results, err := mr.Search("a", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(BeEmpty(), "doSearch should reject single-char queries") + }) + }) + + Describe("Max=0 means no limit (regression: must not produce LIMIT 0)", func() { + It("returns results with Max=0", func() { + results, err := mr.Search("Beatles", model.QueryOptions{Max: 0}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).ToNot(BeEmpty(), "Max=0 should mean no limit, not LIMIT 0") + }) + }) +}) diff --git a/persistence/sql_search_like.go b/persistence/sql_search_like.go new file mode 100644 index 000000000..769a911d5 --- /dev/null +++ b/persistence/sql_search_like.go @@ -0,0 +1,106 @@ +package persistence + +import ( + "strings" + + . "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/utils/str" +) + +// likeSearch implements searchStrategy using LIKE-based SQL filters. +// Used for legacy full_text searches, CJK fallback, and punctuation-only fallback. +type likeSearch struct { + filter Sqlizer +} + +func (s *likeSearch) ToSql() (string, []interface{}, error) { + return s.filter.ToSql() +} + +func (s *likeSearch) execute(r sqlRepository, sq SelectBuilder, dest any, cfg searchConfig, options model.QueryOptions) error { + sq = sq.Where(s.filter) + sq = sq.OrderBy(cfg.OrderBy...) + return r.queryAll(sq, dest, options) +} + +// newLegacySearch creates a LIKE search against the full_text column. +// Returns nil when the query produces no searchable tokens. +func newLegacySearch(tableName, query string) searchStrategy { + filter := legacySearchExpr(tableName, query) + if filter == nil { + return nil + } + return &likeSearch{filter: filter} +} + +// newLikeSearch creates a LIKE search against core entity columns (CJK, punctuation fallback). +// No minimum length is enforced, since single CJK characters are meaningful words. +// Returns nil when the query produces no searchable tokens. +func newLikeSearch(tableName, query string) searchStrategy { + filter := likeSearchExpr(tableName, query) + if filter == nil { + return nil + } + return &likeSearch{filter: filter} +} + +// legacySearchExpr generates LIKE-based search filters against the full_text column. +// This is the original search implementation, used when Search.Backend="legacy". +func legacySearchExpr(tableName string, s string) Sqlizer { + q := str.SanitizeStrings(s) + if q == "" { + log.Trace("Search using legacy backend, query is empty", "table", tableName) + return nil + } + var sep string + if !conf.Server.Search.FullString { + sep = " " + } + parts := strings.Split(q, " ") + filters := And{} + for _, part := range parts { + filters = append(filters, Like{tableName + ".full_text": "%" + sep + part + "%"}) + } + log.Trace("Search using legacy backend", "query", filters, "table", tableName) + return filters +} + +// likeSearchColumns defines the core columns to search with LIKE queries. +// These are the primary user-visible fields for each entity type. +// Used as a fallback when FTS5 cannot handle the query (e.g., CJK text, punctuation-only input). +var likeSearchColumns = map[string][]string{ + "media_file": {"title", "album", "artist", "album_artist"}, + "album": {"name", "album_artist"}, + "artist": {"name"}, +} + +// likeSearchExpr generates LIKE-based search filters against core columns. +// Each word in the query must match at least one column (AND between words), +// and each word can match any column (OR within a word). +// Used as a fallback when FTS5 cannot handle the query (e.g., CJK text, punctuation-only input). +func likeSearchExpr(tableName string, s string) Sqlizer { + s = strings.TrimSpace(s) + if s == "" { + log.Trace("Search using LIKE backend, query is empty", "table", tableName) + return nil + } + columns, ok := likeSearchColumns[tableName] + if !ok { + log.Trace("Search using LIKE backend, couldn't find columns for this table", "table", tableName) + return nil + } + words := strings.Fields(s) + wordFilters := And{} + for _, word := range words { + colFilters := Or{} + for _, col := range columns { + colFilters = append(colFilters, Like{tableName + "." + col: "%" + word + "%"}) + } + wordFilters = append(wordFilters, colFilters) + } + log.Trace("Search using LIKE backend", "query", wordFilters, "table", tableName) + return wordFilters +} diff --git a/persistence/sql_search_like_test.go b/persistence/sql_search_like_test.go new file mode 100644 index 000000000..8ee4ef93c --- /dev/null +++ b/persistence/sql_search_like_test.go @@ -0,0 +1,134 @@ +package persistence + +import ( + "context" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("newLegacySearch", func() { + It("returns non-nil for single-character query", func() { + strategy := newLegacySearch("media_file", "a") + Expect(strategy).ToNot(BeNil(), "single-char queries must not be rejected; min-length is enforced in doSearch, not here") + sql, _, err := strategy.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("LIKE")) + }) +}) + +var _ = Describe("legacySearchExpr", func() { + It("returns nil for empty query", func() { + Expect(legacySearchExpr("media_file", "")).To(BeNil()) + }) + + It("generates LIKE filter for single word", func() { + expr := legacySearchExpr("media_file", "beatles") + sql, args, err := expr.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("media_file.full_text LIKE")) + Expect(args).To(ContainElement("% beatles%")) + }) + + It("generates AND of LIKE filters for multiple words", func() { + expr := legacySearchExpr("media_file", "abbey road") + sql, args, err := expr.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("AND")) + Expect(args).To(HaveLen(2)) + }) +}) + +var _ = Describe("likeSearchExpr", func() { + It("returns nil for empty query", func() { + Expect(likeSearchExpr("media_file", "")).To(BeNil()) + }) + + It("returns nil for whitespace-only query", func() { + Expect(likeSearchExpr("media_file", " ")).To(BeNil()) + }) + + It("generates LIKE filters against core columns for single CJK word", func() { + expr := likeSearchExpr("media_file", "周杰伦") + sql, args, err := expr.ToSql() + Expect(err).ToNot(HaveOccurred()) + // Should have OR between columns for the single word + Expect(sql).To(ContainSubstring("OR")) + Expect(sql).To(ContainSubstring("media_file.title LIKE")) + Expect(sql).To(ContainSubstring("media_file.album LIKE")) + Expect(sql).To(ContainSubstring("media_file.artist LIKE")) + Expect(sql).To(ContainSubstring("media_file.album_artist LIKE")) + Expect(args).To(HaveLen(4)) + for _, arg := range args { + Expect(arg).To(Equal("%周杰伦%")) + } + }) + + It("generates AND of OR groups for multi-word query", func() { + expr := likeSearchExpr("media_file", "周杰伦 greatest") + sql, args, err := expr.ToSql() + Expect(err).ToNot(HaveOccurred()) + // Two groups AND'd together, each with 4 columns OR'd + Expect(sql).To(ContainSubstring("AND")) + Expect(args).To(HaveLen(8)) + }) + + It("uses correct columns for album table", func() { + expr := likeSearchExpr("album", "周杰伦") + sql, args, err := expr.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("album.name LIKE")) + Expect(sql).To(ContainSubstring("album.album_artist LIKE")) + Expect(args).To(HaveLen(2)) + }) + + It("uses correct columns for artist table", func() { + expr := likeSearchExpr("artist", "周杰伦") + sql, args, err := expr.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("artist.name LIKE")) + Expect(args).To(HaveLen(1)) + }) + + It("returns nil for unknown table", func() { + Expect(likeSearchExpr("unknown_table", "周杰伦")).To(BeNil()) + }) +}) + +var _ = Describe("Legacy Integration Search", func() { + var mr model.MediaFileRepository + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Search.Backend = "legacy" + + ctx := log.NewContext(context.TODO()) + ctx = request.WithUser(ctx, adminUser) + conn := GetDBXBuilder() + mr = NewMediaFileRepository(ctx, conn) + }) + + It("returns results using legacy LIKE-based search", func() { + results, err := mr.Search("Radioactivity", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].Title).To(Equal("Radioactivity")) + }) + + It("returns empty results for single-char query (doSearch min-length guard)", func() { + results, err := mr.Search("a", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(BeEmpty(), "doSearch should reject single-char queries") + }) + + It("returns results with Max=0 (regression: must not produce LIMIT 0)", func() { + results, err := mr.Search("Beatles", model.QueryOptions{Max: 0}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).ToNot(BeEmpty(), "Max=0 should mean no limit, not LIMIT 0") + }) +}) diff --git a/persistence/sql_search_test.go b/persistence/sql_search_test.go index 6bfd88d9f..68ee205b4 100644 --- a/persistence/sql_search_test.go +++ b/persistence/sql_search_test.go @@ -1,6 +1,8 @@ package persistence import ( + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) @@ -11,4 +13,100 @@ var _ = Describe("sqlRepository", func() { Expect(formatFullText("legiao urbana")).To(Equal(" legiao urbana")) }) }) + + Describe("getSearchStrategy", func() { + It("returns FTS strategy by default", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Search.Backend = "fts" + conf.Server.Search.FullString = false + + strategy := getSearchStrategy("media_file", "test") + Expect(strategy).ToNot(BeNil()) + sql, _, err := strategy.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("MATCH")) + }) + + It("returns legacy LIKE strategy when SearchBackend is legacy", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Search.Backend = "legacy" + conf.Server.Search.FullString = false + + strategy := getSearchStrategy("media_file", "test") + Expect(strategy).ToNot(BeNil()) + sql, _, err := strategy.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("LIKE")) + }) + + It("falls back to legacy LIKE strategy when SearchFullString is enabled", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Search.Backend = "fts" + conf.Server.Search.FullString = true + + strategy := getSearchStrategy("media_file", "test") + Expect(strategy).ToNot(BeNil()) + sql, _, err := strategy.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("LIKE")) + }) + + It("routes CJK queries to LIKE strategy instead of FTS", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Search.Backend = "fts" + conf.Server.Search.FullString = false + + strategy := getSearchStrategy("media_file", "周杰伦") + Expect(strategy).ToNot(BeNil()) + sql, _, err := strategy.ToSql() + Expect(err).ToNot(HaveOccurred()) + // CJK should use LIKE, not MATCH + Expect(sql).To(ContainSubstring("LIKE")) + Expect(sql).NotTo(ContainSubstring("MATCH")) + }) + + It("routes non-CJK queries to FTS strategy", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Search.Backend = "fts" + conf.Server.Search.FullString = false + + strategy := getSearchStrategy("media_file", "beatles") + Expect(strategy).ToNot(BeNil()) + sql, _, err := strategy.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("MATCH")) + }) + + It("returns non-nil for single-character query (no min-length in strategy)", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Search.Backend = "fts" + conf.Server.Search.FullString = false + + strategy := getSearchStrategy("media_file", "a") + Expect(strategy).ToNot(BeNil(), "single-char queries must be accepted by strategies (min-length is enforced in doSearch)") + }) + + It("returns non-nil for single-character query with legacy backend", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Search.Backend = "legacy" + conf.Server.Search.FullString = false + + strategy := getSearchStrategy("media_file", "a") + Expect(strategy).ToNot(BeNil(), "single-char queries must be accepted by legacy strategy (min-length is enforced in doSearch)") + }) + + It("uses legacy for CJK when SearchBackend is legacy", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Search.Backend = "legacy" + conf.Server.Search.FullString = false + + strategy := getSearchStrategy("media_file", "周杰伦") + Expect(strategy).ToNot(BeNil()) + sql, _, err := strategy.ToSql() + Expect(err).ToNot(HaveOccurred()) + // Legacy should still use full_text column LIKE + Expect(sql).To(ContainSubstring("LIKE")) + Expect(sql).To(ContainSubstring("full_text")) + }) + }) }) diff --git a/persistence/sql_tags.go b/persistence/sql_tags.go index 8c3c1e89d..88acebb7f 100644 --- a/persistence/sql_tags.go +++ b/persistence/sql_tags.go @@ -60,7 +60,7 @@ func tagIDFilter(name string, idValue any) Sqlizer { } // tagLibraryIdFilter filters tags based on library access through the library_tag table -func tagLibraryIdFilter(_ string, value interface{}) Sqlizer { +func tagLibraryIdFilter(_ string, value any) Sqlizer { return Eq{"library_tag.library_id": value} } @@ -142,14 +142,14 @@ func (r *baseTagRepository) Count(options ...rest.QueryOptions) (int64, error) { return r.count(sq, r.parseRestOptions(r.ctx, options...)) } -func (r *baseTagRepository) Read(id string) (interface{}, error) { +func (r *baseTagRepository) Read(id string) (any, error) { query := r.newSelect().Where(Eq{"id": id}) var res model.Tag err := r.queryOne(query, &res) return &res, err } -func (r *baseTagRepository) ReadAll(options ...rest.QueryOptions) (interface{}, error) { +func (r *baseTagRepository) ReadAll(options ...rest.QueryOptions) (any, error) { query := r.newSelect(r.parseRestOptions(r.ctx, options...)) var res model.TagList err := r.queryAll(query, &res) @@ -160,7 +160,7 @@ func (r *baseTagRepository) EntityName() string { return "tag" } -func (r *baseTagRepository) NewInstance() interface{} { +func (r *baseTagRepository) NewInstance() any { return model.Tag{} } diff --git a/persistence/tag_library_filtering_test.go b/persistence/tag_library_filtering_test.go index ab0d57d52..ddd897165 100644 --- a/persistence/tag_library_filtering_test.go +++ b/persistence/tag_library_filtering_test.go @@ -2,6 +2,7 @@ package persistence import ( "context" + "time" "github.com/deluan/rest" "github.com/navidrome/navidrome/conf/configtest" @@ -45,6 +46,9 @@ var _ = Describe("Tag Library Filtering", func() { BeforeEach(func() { DeferCleanup(configtest.SetupConfig()) + // Generate unique path suffix to avoid conflicts with other tests + uniqueSuffix := time.Now().Format("20060102150405.000") + // Clean up database db := GetDBXBuilder() _, err := db.NewQuery("DELETE FROM library_tag").Execute() @@ -57,12 +61,12 @@ var _ = Describe("Tag Library Filtering", func() { _, err = db.NewQuery("DELETE FROM library WHERE id > 1").Execute() Expect(err).ToNot(HaveOccurred()) - // Create test libraries + // Create test libraries with unique names and paths to avoid conflicts with other tests _, err = db.NewQuery("INSERT INTO library (id, name, path) VALUES ({:id}, {:name}, {:path})"). - Bind(dbx.Params{"id": libraryID2, "name": "Library 2", "path": "/music/lib2"}).Execute() + Bind(dbx.Params{"id": libraryID2, "name": "Library 2-" + uniqueSuffix, "path": "/music/lib2-" + uniqueSuffix}).Execute() Expect(err).ToNot(HaveOccurred()) _, err = db.NewQuery("INSERT INTO library (id, name, path) VALUES ({:id}, {:name}, {:path})"). - Bind(dbx.Params{"id": libraryID3, "name": "Library 3", "path": "/music/lib3"}).Execute() + Bind(dbx.Params{"id": libraryID3, "name": "Library 3-" + uniqueSuffix, "path": "/music/lib3-" + uniqueSuffix}).Execute() Expect(err).ToNot(HaveOccurred()) // Give admin access to all libraries @@ -161,7 +165,7 @@ var _ = Describe("Tag Library Filtering", func() { It("should respect explicit library_id filters within accessible libraries", func() { tags := readAllTags(®ularUser, rest.QueryOptions{ - Filters: map[string]interface{}{"library_id": libraryID2}, + Filters: map[string]any{"library_id": libraryID2}, }) // Should see only tags from library 2: pop and rock(lib2) Expect(tags).To(HaveLen(2)) @@ -170,7 +174,7 @@ var _ = Describe("Tag Library Filtering", func() { It("should not return tags when filtering by inaccessible library", func() { tags := readAllTags(®ularUser, rest.QueryOptions{ - Filters: map[string]interface{}{"library_id": libraryID3}, + Filters: map[string]any{"library_id": libraryID3}, }) // Should return no tags since user can't access library 3 Expect(tags).To(HaveLen(0)) @@ -178,7 +182,7 @@ var _ = Describe("Tag Library Filtering", func() { It("should filter by library 1 correctly", func() { tags := readAllTags(®ularUser, rest.QueryOptions{ - Filters: map[string]interface{}{"library_id": libraryID1}, + Filters: map[string]any{"library_id": libraryID1}, }) // Should see only rock from library 1 Expect(tags).To(HaveLen(1)) @@ -223,7 +227,7 @@ var _ = Describe("Tag Library Filtering", func() { It("should allow headless processes to apply explicit library_id filters", func() { tags := readAllTags(nil, rest.QueryOptions{ - Filters: map[string]interface{}{"library_id": libraryID3}, + Filters: map[string]any{"library_id": libraryID3}, }) // Should see only jazz from library 3 Expect(tags).To(HaveLen(1)) @@ -239,7 +243,7 @@ var _ = Describe("Tag Library Filtering", func() { It("should respect explicit library_id filters", func() { tags := readAllTags(&adminUser, rest.QueryOptions{ - Filters: map[string]interface{}{"library_id": libraryID3}, + Filters: map[string]any{"library_id": libraryID3}, }) // Should see only jazz from library 3 Expect(tags).To(HaveLen(1)) @@ -248,7 +252,7 @@ var _ = Describe("Tag Library Filtering", func() { It("should filter by library 2 correctly", func() { tags := readAllTags(&adminUser, rest.QueryOptions{ - Filters: map[string]interface{}{"library_id": libraryID2}, + Filters: map[string]any{"library_id": libraryID2}, }) // Should see pop and rock from library 2 Expect(tags).To(HaveLen(2)) diff --git a/persistence/tag_repository.go b/persistence/tag_repository.go index b224450ab..5bb8b3832 100644 --- a/persistence/tag_repository.go +++ b/persistence/tag_repository.go @@ -88,10 +88,10 @@ func (r *tagRepository) purgeUnused() error { `) c, err := r.executeSQL(del) if err != nil { - return fmt.Errorf("error purging unused tags: %w", err) + return fmt.Errorf("error purging %s unused tags: %w", r.tableName, err) } if c > 0 { - log.Debug(r.ctx, "Purged unused tags", "totalDeleted", c) + log.Debug(r.ctx, "Purged unused tags", "totalDeleted", c, "table", r.tableName) } return err } diff --git a/persistence/tag_repository_test.go b/persistence/tag_repository_test.go index c3947a9f7..9a019c30e 100644 --- a/persistence/tag_repository_test.go +++ b/persistence/tag_repository_test.go @@ -234,7 +234,7 @@ var _ = Describe("TagRepository", func() { It("should filter tags by partial value correctly", func() { options := rest.QueryOptions{ - Filters: map[string]interface{}{"name": "%rock%"}, // Tags containing 'rock' + Filters: map[string]any{"name": "%rock%"}, // Tags containing 'rock' } result, err := restRepo.ReadAll(options) Expect(err).ToNot(HaveOccurred()) @@ -249,7 +249,7 @@ var _ = Describe("TagRepository", func() { It("should filter tags by partial value using LIKE", func() { options := rest.QueryOptions{ - Filters: map[string]interface{}{"name": "%e%"}, // Tags containing 'e' + Filters: map[string]any{"name": "%e%"}, // Tags containing 'e' } result, err := restRepo.ReadAll(options) Expect(err).ToNot(HaveOccurred()) @@ -264,7 +264,7 @@ var _ = Describe("TagRepository", func() { It("should sort tags by value ascending", func() { options := rest.QueryOptions{ - Filters: map[string]interface{}{"name": "%r%"}, // Tags containing 'r' + Filters: map[string]any{"name": "%r%"}, // Tags containing 'r' Sort: "name", Order: "asc", } @@ -280,7 +280,7 @@ var _ = Describe("TagRepository", func() { It("should sort tags by value descending", func() { options := rest.QueryOptions{ - Filters: map[string]interface{}{"name": "%r%"}, // Tags containing 'r' + Filters: map[string]any{"name": "%r%"}, // Tags containing 'r' Sort: "name", Order: "desc", } diff --git a/persistence/transcoding_repository.go b/persistence/transcoding_repository.go index 125f57541..870da61c8 100644 --- a/persistence/transcoding_repository.go +++ b/persistence/transcoding_repository.go @@ -52,11 +52,11 @@ func (r *transcodingRepository) Count(options ...rest.QueryOptions) (int64, erro return r.count(Select(), r.parseRestOptions(r.ctx, options...)) } -func (r *transcodingRepository) Read(id string) (interface{}, error) { +func (r *transcodingRepository) Read(id string) (any, error) { return r.Get(id) } -func (r *transcodingRepository) ReadAll(options ...rest.QueryOptions) (interface{}, error) { +func (r *transcodingRepository) ReadAll(options ...rest.QueryOptions) (any, error) { sel := r.newSelect(r.parseRestOptions(r.ctx, options...)).Columns("*") res := model.Transcodings{} err := r.queryAll(sel, &res) @@ -67,11 +67,11 @@ func (r *transcodingRepository) EntityName() string { return "transcoding" } -func (r *transcodingRepository) NewInstance() interface{} { +func (r *transcodingRepository) NewInstance() any { return &model.Transcoding{} } -func (r *transcodingRepository) Save(entity interface{}) (string, error) { +func (r *transcodingRepository) Save(entity any) (string, error) { if !loggedUser(r.ctx).IsAdmin { return "", rest.ErrPermissionDenied } @@ -83,7 +83,7 @@ func (r *transcodingRepository) Save(entity interface{}) (string, error) { return id, err } -func (r *transcodingRepository) Update(id string, entity interface{}, cols ...string) error { +func (r *transcodingRepository) Update(id string, entity any, cols ...string) error { if !loggedUser(r.ctx).IsAdmin { return rest.ErrPermissionDenied } diff --git a/persistence/user_repository.go b/persistence/user_repository.go index a7181b1a7..dc149e8ba 100644 --- a/persistence/user_repository.go +++ b/persistence/user_repository.go @@ -57,6 +57,7 @@ func NewUserRepository(ctx context.Context, db dbx.Builder) model.UserRepository r.db = db r.tableName = "user" r.registerModel(&model.User{}, map[string]filterFunc{ + "id": idFilter(r.tableName), "password": invalidFilter(ctx), "name": r.withTableName(startsWithFilter), }) @@ -339,7 +340,15 @@ func (r *userRepository) Delete(id string) error { if errors.Is(err, model.ErrNotFound) { return rest.ErrNotFound } - return err + if err != nil { + return err + } + + // Clean up orphaned plugin references for the deleted user + if err := cleanupPluginUserReferences(r.db, id); err != nil { + log.Error(r.ctx, "Failed to cleanup plugin user references", "userID", id, err) + } + return nil } func keyTo32Bytes(input string) []byte { diff --git a/persistence/user_repository_test.go b/persistence/user_repository_test.go index 7c0707ecd..8abbf76a9 100644 --- a/persistence/user_repository_test.go +++ b/persistence/user_repository_test.go @@ -559,4 +559,15 @@ var _ = Describe("UserRepository", func() { Expect(user.Libraries[0].ID).To(Equal(1)) }) }) + + Describe("filters", func() { + It("qualifies id filter with table name", func() { + r := repo.(*userRepository) + qo := r.parseRestOptions(r.ctx, rest.QueryOptions{Filters: map[string]any{"id": "123"}}) + sel := r.selectUserWithLibraries(qo) + query, _, err := r.toSQL(sel) + Expect(err).NotTo(HaveOccurred()) + Expect(query).To(ContainSubstring("user.id = {:p0}")) + }) + }) }) diff --git a/plugins/.gitignore b/plugins/.gitignore new file mode 100644 index 000000000..5026985e6 --- /dev/null +++ b/plugins/.gitignore @@ -0,0 +1,4 @@ +# Rust build artifacts +# Cargo.lock is not needed for library crates (this is a cdylib) +Cargo.lock +target \ No newline at end of file diff --git a/plugins/README.md b/plugins/README.md index 100230cbf..e37a94d7a 100644 --- a/plugins/README.md +++ b/plugins/README.md @@ -1,1760 +1,1077 @@ # Navidrome Plugin System -## Overview +Navidrome supports WebAssembly (Wasm) plugins for extending functionality. Plugins run in a secure sandbox and can provide metadata agents, scrobblers, and other integrations through host services like scheduling, caching, WebSockets, and Subsonic API access. -Navidrome's plugin system is a WebAssembly (WASM) based extension mechanism that enables developers to expand Navidrome's functionality without modifying the core codebase. The plugin system supports several capabilities that can be implemented by plugins: +The plugin system is built on **[Extism](https://extism.org/)**, a cross-language framework for building WebAssembly plugins. This means you can write plugins in any language that Extism supports (Go, Rust, Python, TypeScript, and more) using their Plugin Development Kits (PDKs). -1. **MetadataAgent** - For fetching artist and album information, images, etc. -2. **Scrobbler** - For implementing scrobbling functionality with external services -3. **SchedulerCallback** - For executing code after a specified delay or on a recurring schedule -4. **WebSocketCallback** - For interacting with WebSocket endpoints and handling WebSocket events -5. **LifecycleManagement** - For plugin initialization and configuration (one-time `OnInit` only; not invoked per-request) +**Essential Extism Resources:** +- [Extism Documentation](https://extism.org/docs/overview) – Core concepts and architecture +- [Plugin Development Kits (PDKs)](https://extism.org/docs/concepts/pdk) – Language-specific libraries for writing plugins +- [Go PDK](https://github.com/extism/go-pdk) – Recommended for Go plugins with TinyGo +- [Rust PDK](https://github.com/extism/rust-pdk) – For Rust plugins +- [Python PDK](https://github.com/extism/python-pdk) – Experimental Python support +- [JavaScript PDK](https://github.com/extism/js-pdk) – For TypeScript/JavaScript plugins -## Plugin Architecture +## Table of Contents -The plugin system is built on the following key components: +- [Quick Start](#quick-start) +- [Plugin Basics](#plugin-basics) +- [Capabilities](#capabilities) + - [MetadataAgent](#metadataagent) + - [Scrobbler](#scrobbler) + - [Lifecycle](#lifecycle) +- [Host Services](#host-services) + - [HTTP Requests](#http-requests) + - [Scheduler](#scheduler) + - [Cache](#cache) + - [KVStore](#kvstore) + - [WebSocket](#websocket) + - [Library](#library) + - [Artwork](#artwork) + - [SubsonicAPI](#subsonicapi) + - [Config](#config) + - [Users](#users) +- [Configuration](#configuration) +- [Building Plugins](#building-plugins) +- [Examples](#examples) +- [Security](#security) -### 1. Plugin Manager +--- -The `Manager` (implemented in `plugins/manager.go`) is the core component that: +## Quick Start -- Scans for plugins in the configured plugins directory -- Loads and compiles plugins -- Provides access to loaded plugins through capability-specific interfaces +### 1. Create a minimal plugin -### 2. Plugin Protocol - -Plugins communicate with Navidrome using Protocol Buffers (protobuf) over a WASM runtime. The protocol is defined in `plugins/api/api.proto` which specifies the capabilities and messages that plugins can implement. - -### 3. Plugin Adapters - -Adapters bridge between the plugin API and Navidrome's internal interfaces: - -- `wasmMediaAgent` adapts `MetadataAgent` to the internal `agents.Interface` -- `wasmScrobblerPlugin` adapts `Scrobbler` to the internal `scrobbler.Scrobbler` -- `wasmSchedulerCallback` adapts `SchedulerCallback` to the internal `SchedulerCallback` - -* **Plugin Instance Pooling**: Instances are managed in an internal pool (default 8 max, 1m TTL). -* **WASM Compilation & Caching**: Modules are pre-compiled concurrently (max 2) and cached in `[CacheFolder]/plugins`, reducing startup time. The compilation timeout can be configured via `DevPluginCompilationTimeout` in development. - -### 4. Host Services - -Navidrome provides host services that plugins can call to access functionality like HTTP requests and scheduling. -These services are defined in `plugins/host/` and implemented in corresponding host files: - -- HTTP service (in `plugins/host_http.go`) for making external requests -- Scheduler service (in `plugins/host_scheduler.go`) for scheduling timed events -- Config service (in `plugins/host_config.go`) for accessing plugin-specific configuration -- WebSocket service (in `plugins/host_websocket.go`) for WebSocket communication -- Cache service (in `plugins/host_cache.go`) for TTL-based plugin caching -- Artwork service (in `plugins/host_artwork.go`) for generating public artwork URLs -- SubsonicAPI service (in `plugins/host_subsonicapi.go`) for accessing Navidrome's Subsonic API - -### Available Host Services - -The following host services are available to plugins: - -#### HttpService - -```protobuf -// HTTP methods available to plugins -service HttpService { - rpc Get(HttpRequest) returns (HttpResponse); - rpc Post(HttpRequest) returns (HttpResponse); - rpc Put(HttpRequest) returns (HttpResponse); - rpc Delete(HttpRequest) returns (HttpResponse); - rpc Patch(HttpRequest) returns (HttpResponse); - rpc Head(HttpRequest) returns (HttpResponse); - rpc Options(HttpRequest) returns (HttpResponse); -} -``` - -#### ConfigService - -```protobuf -service ConfigService { - rpc GetPluginConfig(GetPluginConfigRequest) returns (GetPluginConfigResponse); -} -``` - -The ConfigService allows plugins to access plugin-specific configuration. See the [config.proto](host/config/config.proto) file for the full API. - -#### ArtworkService - -```protobuf -service ArtworkService { - rpc GetArtistUrl(GetArtworkUrlRequest) returns (GetArtworkUrlResponse); - rpc GetAlbumUrl(GetArtworkUrlRequest) returns (GetArtworkUrlResponse); - rpc GetTrackUrl(GetArtworkUrlRequest) returns (GetArtworkUrlResponse); -} -``` - -Provides methods to get public URLs for artwork images: - -- `GetArtistUrl(id string, size int) string`: Returns a public URL for an artist's artwork -- `GetAlbumUrl(id string, size int) string`: Returns a public URL for an album's artwork -- `GetTrackUrl(id string, size int) string`: Returns a public URL for a track's artwork - -The `size` parameter is optional (use 0 for original size). The URLs returned are based on the server's ShareURL configuration. - -Example: +Create `main.go`: ```go -url := artwork.GetArtistUrl("123", 300) // Get artist artwork URL with size 300px -url := artwork.GetAlbumUrl("456", 0) // Get album artwork URL in original size +package main + +import "github.com/extism/go-pdk" + +func main() {} + +// Implement your capability functions here ``` -#### CacheService - -```protobuf -service CacheService { - // Set a string value in the cache - rpc SetString(SetStringRequest) returns (SetResponse); - - // Get a string value from the cache - rpc GetString(GetRequest) returns (GetStringResponse); - - // Set an integer value in the cache - rpc SetInt(SetIntRequest) returns (SetResponse); - - // Get an integer value from the cache - rpc GetInt(GetRequest) returns (GetIntResponse); - - // Set a float value in the cache - rpc SetFloat(SetFloatRequest) returns (SetResponse); - - // Get a float value from the cache - rpc GetFloat(GetRequest) returns (GetFloatResponse); - - // Set a byte slice value in the cache - rpc SetBytes(SetBytesRequest) returns (SetResponse); - - // Get a byte slice value from the cache - rpc GetBytes(GetRequest) returns (GetBytesResponse); - - // Remove a value from the cache - rpc Remove(RemoveRequest) returns (RemoveResponse); - - // Check if a key exists in the cache - rpc Has(HasRequest) returns (HasResponse); -} -``` - -The CacheService provides a TTL-based cache for plugins. Each plugin gets its own isolated cache instance. By default, cached items expire after 24 hours unless a custom TTL is specified. - -Key features: - -- **Isolated Caches**: Each plugin has its own cache namespace, so different plugins can use the same key names without conflicts -- **Typed Values**: Store and retrieve values with their proper types (string, int64, float64, or byte slice) -- **Configurable TTL**: Set custom expiration times per item, or use the default 24-hour TTL -- **Type Safety**: The system handles type checking, returning "not exists" if there's a type mismatch - -Example usage: - -```go -// Store a string value with default TTL (24 hours) -cacheService.SetString(ctx, &cache.SetStringRequest{ - Key: "user_preference", - Value: "dark_mode", -}) - -// Store an integer with custom TTL (5 minutes) -cacheService.SetInt(ctx, &cache.SetIntRequest{ - Key: "api_call_count", - Value: 42, - TtlSeconds: 300, // 5 minutes -}) - -// Retrieve a value -resp, err := cacheService.GetString(ctx, &cache.GetRequest{ - Key: "user_preference", -}) -if err != nil { - // Handle error -} -if resp.Exists { - // Use resp.Value -} else { - // Key doesn't exist or has expired -} - -// Check if a key exists -hasResp, err := cacheService.Has(ctx, &cache.HasRequest{ - Key: "api_call_count", -}) -if hasResp.Exists { - // Key exists and hasn't expired -} - -// Remove a value -cacheService.Remove(ctx, &cache.RemoveRequest{ - Key: "user_preference", -}) -``` - -See the [cache.proto](host/cache/cache.proto) file for the full API definition. - -#### SchedulerService - -The SchedulerService provides a unified interface for scheduling both one-time and recurring tasks, as well as accessing current time information. See the [scheduler.proto](host/scheduler/scheduler.proto) file for the full API. - -```protobuf -service SchedulerService { - // One-time event scheduling - rpc ScheduleOneTime(ScheduleOneTimeRequest) returns (ScheduleResponse); - - // Recurring event scheduling - rpc ScheduleRecurring(ScheduleRecurringRequest) returns (ScheduleResponse); - - // Cancel any scheduled job - rpc CancelSchedule(CancelRequest) returns (CancelResponse); - - // Get current time in multiple formats - rpc TimeNow(TimeNowRequest) returns (TimeNowResponse); -} -``` - -**Key Features:** - -- **One-time scheduling**: Schedule a callback to be executed once after a specified delay. -- **Recurring scheduling**: Schedule a callback to be executed repeatedly according to a cron expression. -- **Current time access**: Get the current time in standardized formats for time-based operations. - -**TimeNow Function:** - -The `TimeNow` function returns the current time in three formats: - -```protobuf -message TimeNowResponse { - string rfc3339_nano = 1; // RFC3339 format with nanosecond precision - int64 unix_milli = 2; // Unix timestamp in milliseconds - string local_time_zone = 3; // Local timezone name (e.g., "UTC", "America/New_York") -} -``` - -This allows plugins to: - -- Get high-precision timestamps for logging and event correlation -- Perform time-based calculations using Unix timestamps -- Handle timezone-aware operations by knowing the server's local timezone - -Example usage: - -```go -// Get current time information -timeResp, err := scheduler.TimeNow(ctx, &scheduler.TimeNowRequest{}) -if err != nil { - return err -} - -// Use the different time formats -timestamp := timeResp.Rfc3339Nano // "2024-01-15T10:30:45.123456789Z" -unixMs := timeResp.UnixMilli // 1705312245123 -timezone := timeResp.LocalTimeZone // "UTC" -``` - -Plugins using this service must implement the `SchedulerCallback` interface: - -```protobuf -service SchedulerCallback { - rpc OnSchedulerCallback(SchedulerCallbackRequest) returns (SchedulerCallbackResponse); -} -``` - -The `IsRecurring` field in the request allows plugins to differentiate between one-time and recurring callbacks. - -#### WebSocketService - -The WebSocketService enables plugins to connect to and interact with WebSocket endpoints. See the [websocket.proto](host/websocket/websocket.proto) file for the full API. - -```protobuf -service WebSocketService { - // Connect to a WebSocket endpoint - rpc Connect(ConnectRequest) returns (ConnectResponse); - - // Send a text message - rpc SendText(SendTextRequest) returns (SendTextResponse); - - // Send binary data - rpc SendBinary(SendBinaryRequest) returns (SendBinaryResponse); - - // Close a connection - rpc Close(CloseRequest) returns (CloseResponse); -} -``` - -- **Connect**: Establish a WebSocket connection to a specified URL with optional headers -- **SendText**: Send text messages over an established connection -- **SendBinary**: Send binary data over an established connection -- **Close**: Close a WebSocket connection with optional close code and reason - -Plugins using this service must implement the `WebSocketCallback` interface to handle incoming messages and connection events: - -```protobuf -service WebSocketCallback { - rpc OnTextMessage(OnTextMessageRequest) returns (OnTextMessageResponse); - rpc OnBinaryMessage(OnBinaryMessageRequest) returns (OnBinaryMessageResponse); - rpc OnError(OnErrorRequest) returns (OnErrorResponse); - rpc OnClose(OnCloseRequest) returns (OnCloseResponse); -} -``` - -Example usage: - -```go -// Connect to a WebSocket server -connectResp, err := websocket.Connect(ctx, &websocket.ConnectRequest{ - Url: "wss://example.com/ws", - Headers: map[string]string{"Authorization": "Bearer token"}, - ConnectionId: "my-connection-id", -}) -if err != nil { - return err -} - -// Send a text message -_, err = websocket.SendText(ctx, &websocket.SendTextRequest{ - ConnectionId: "my-connection-id", - Message: "Hello WebSocket", -}) - -// Send binary data -_, err = websocket.SendBinary(ctx, &websocket.SendBinaryRequest{ - ConnectionId: "my-connection-id", - Data: []byte{0x01, 0x02, 0x03}, -}) - -// Close the connection when done -_, err = websocket.Close(ctx, &websocket.CloseRequest{ - ConnectionId: "my-connection-id", - Code: 1000, // Normal closure - Reason: "Done", -}) -``` - -#### SubsonicAPIService - -```protobuf -service SubsonicAPIService { - rpc Call(CallRequest) returns (CallResponse); -} -``` - -The SubsonicAPIService provides plugins with access to Navidrome's Subsonic API endpoints. This allows plugins to query and interact with Navidrome's music library data using the same API that external Subsonic clients use. - -Key features: - -- **Library Access**: Query artists, albums, tracks, playlists, and other music library data -- **Search Functionality**: Search across the music library using various criteria -- **Metadata Retrieval**: Get detailed information about music items including ratings, play counts, etc. -- **Authentication Handled**: The service automatically handles authentication using internal auth context -- **JSON Responses**: All responses are returned as JSON strings for easy parsing - -**Important Security Notes:** - -- Plugins must specify a username via the `u` parameter in the URL - this determines which user's library view and permissions apply -- The service uses internal authentication, so plugins don't need to provide passwords or API keys -- All Subsonic API security and access controls apply based on the specified user - -Example usage: - -```go -// Get ping response to test connectivity -resp, err := subsonicAPI.Call(ctx, &subsonicapi.CallRequest{ - Url: "/rest/ping?u=admin", -}) -if err != nil { - return err -} -// resp.Json contains the JSON response - -// Search for artists -resp, err = subsonicAPI.Call(ctx, &subsonicapi.CallRequest{ - Url: "/rest/search3?u=admin&query=Beatles&artistCount=10", -}) - -// Get album details -resp, err = subsonicAPI.Call(ctx, &subsonicapi.CallRequest{ - Url: "/rest/getAlbum?u=admin&id=123", -}) - -// Check for errors -if resp.Error != "" { - // Handle error - could be missing parameters, invalid user, etc. - log.Printf("SubsonicAPI error: %s", resp.Error) -} -``` - -**Common URL Patterns:** - -- `/rest/ping?u=USERNAME` - Test API connectivity -- `/rest/search3?u=USERNAME&query=TERM` - Search library -- `/rest/getArtists?u=USERNAME` - Get all artists -- `/rest/getAlbum?u=USERNAME&id=ID` - Get album details -- `/rest/getPlaylists?u=USERNAME` - Get user playlists - -**Required Parameters:** - -- `u` (username): Required for all requests - determines user context and permissions -- `f=json`: Recommended to get JSON responses (easier to parse than XML) - -The service accepts standard Subsonic API endpoints and parameters. Refer to the [Subsonic API documentation](http://www.subsonic.org/pages/api.jsp) for complete endpoint details, but note that authentication parameters (`p`, `t`, `s`, `c`, `v`) are handled automatically. - -See the [subsonicapi.proto](host/subsonicapi/subsonicapi.proto) file for the full API definition. - -## Plugin Permission System - -Navidrome implements a permission-based security system that controls which host services plugins can access. This system enforces security at load-time by only making authorized services available to plugins in their WebAssembly runtime environment. - -### How Permissions Work - -The permission system follows a **secure-by-default** approach: - -1. **Default Behavior**: Plugins have access to **no host services** unless explicitly declared -2. **Load-time Enforcement**: Only services listed in a plugin's permissions are loaded into its WASM runtime -3. **Runtime Security**: Unauthorized services are completely unavailable - attempts to call them result in "function not exported" errors - -This design ensures that even if malicious code tries to access unauthorized services, the calls will fail because the functions simply don't exist in the plugin's runtime environment. - -### Permission Syntax - -Permissions are declared in the plugin's `manifest.json` file using the `permissions` field as an object: +Create `manifest.json`: ```json { - "name": "my-plugin", - "author": "Plugin Developer", - "version": "1.0.0", - "description": "A plugin that fetches data and caches results", - "website": "https://github.com/plugindeveloper/my-plugin", - "capabilities": ["MetadataAgent"], - "permissions": { - "http": { - "reason": "To fetch metadata from external APIs", - "allowedUrls": { - "https://api.musicbrainz.org": ["GET"], - "https://coverartarchive.org": ["GET"] - }, - "allowLocalNetwork": false - }, - "cache": { - "reason": "To cache API responses and reduce rate limiting" - }, - "subsonicapi": { - "reason": "To query music library for artist and album information", - "allowedUsernames": ["metadata-user"], - "allowAdmins": false - } - } + "name": "My Plugin", + "author": "Your Name", + "version": "1.0.0" } ``` -Each permission is represented as a key in the permissions object. The value must be an object containing a `reason` field that explains why the permission is needed. +### 2. Build with TinyGo and package as .ndp -**Important**: Some permissions require additional configuration fields: +```bash +# Compile to WebAssembly +tinygo build -o plugin.wasm -target wasip1 -buildmode=c-shared . -- **`http`**: Requires `allowedUrls` object mapping URL patterns to allowed HTTP methods, and optional `allowLocalNetwork` boolean -- **`websocket`**: Requires `allowedUrls` array of WebSocket URL patterns, and optional `allowLocalNetwork` boolean -- **`subsonicapi`**: Requires `reason` field, with optional `allowedUsernames` array and `allowAdmins` boolean for fine-grained access control -- **`config`**, **`cache`**, **`scheduler`**, **`artwork`**: Only require the `reason` field - -**Security Benefits of Required Reasons:** - -- **Transparency**: Users can see exactly what each plugin will do with its permissions -- **Security Auditing**: Makes it easier to identify suspicious or overly broad permission requests -- **Developer Accountability**: Forces plugin authors to justify each permission they request -- **Trust Building**: Clear explanations help users make informed decisions about plugin installation - -If no permissions are needed, use an empty permissions object: `"permissions": {}`. - -### Available Permissions - -The following permission keys correspond to host services: - -| Permission | Host Service | Description | Required Fields | -| ------------- | ------------------ | -------------------------------------------------- | ----------------------------------------------------- | -| `http` | HttpService | Make HTTP requests (GET, POST, PUT, DELETE, etc..) | `reason`, `allowedUrls` | -| `websocket` | WebSocketService | Connect to and communicate via WebSockets | `reason`, `allowedUrls` | -| `cache` | CacheService | Store and retrieve cached data with TTL | `reason` | -| `config` | ConfigService | Access Navidrome configuration values | `reason` | -| `scheduler` | SchedulerService | Schedule one-time and recurring tasks | `reason` | -| `artwork` | ArtworkService | Generate public URLs for artwork images | `reason` | -| `subsonicapi` | SubsonicAPIService | Access Navidrome's Subsonic API endpoints | `reason`, optional: `allowedUsernames`, `allowAdmins` | - -#### HTTP Permission Structure - -HTTP permissions require explicit URL whitelisting for security: - -```json -{ - "http": { - "reason": "To fetch artist data from MusicBrainz and album covers from Cover Art Archive", - "allowedUrls": { - "https://musicbrainz.org/ws/2/*": ["GET"], - "https://coverartarchive.org/*": ["GET"], - "https://api.example.com/submit": ["POST"] - }, - "allowLocalNetwork": false - } -} +# Package as .ndp (zip archive) +zip -j my-plugin.ndp manifest.json plugin.wasm ``` -**Fields:** +### 3. Install -- `reason` (required): Explanation of why HTTP access is needed -- `allowedUrls` (required): Object mapping URL patterns to allowed HTTP methods -- `allowLocalNetwork` (optional, default false): Whether to allow requests to localhost/private IPs - -**URL Pattern Matching:** - -- Exact URLs: `"https://api.example.com/endpoint": ["GET"]` -- Wildcard paths: `"https://api.example.com/*": ["GET", "POST"]` -- Subdomain wildcards: `"https://*.example.com": ["GET"]` - -**Important**: Redirect destinations must also be included in `allowedUrls` if you want to follow redirects. - -#### WebSocket Permission Structure - -WebSocket permissions require explicit URL whitelisting: - -```json -{ - "websocket": { - "reason": "To connect to Discord gateway for real-time Rich Presence updates", - "allowedUrls": ["wss://gateway.discord.gg", "wss://*.discord.gg"], - "allowLocalNetwork": false - } -} -``` - -**Fields:** - -- `reason` (required): Explanation of why WebSocket access is needed -- `allowedUrls` (required): Array of WebSocket URL patterns (must start with `ws://` or `wss://`) -- `allowLocalNetwork` (optional, default false): Whether to allow connections to localhost/private IPs - -#### SubsonicAPI Permission Structure - -SubsonicAPI permissions control which users plugins can access Navidrome's Subsonic API as, providing fine-grained security controls: - -```json -{ - "subsonicapi": { - "reason": "To query music library data for recommendation engine", - "allowedUsernames": ["plugin-user", "readonly-user"], - "allowAdmins": false - } -} -``` - -**Fields:** - -- `reason` (required): Explanation of why SubsonicAPI access is needed -- `allowedUsernames` (optional): Array of specific usernames the plugin is allowed to use. If empty or omitted, any username can be used -- `allowAdmins` (optional, default false): Whether the plugin can make API calls using admin user accounts - -**Security Model:** - -The SubsonicAPI service enforces strict user-based access controls: - -- **Username Validation**: The plugin must provide a valid `u` (username) parameter in all API calls -- **User Context**: All API responses are filtered based on the specified user's permissions and library access -- **Admin Protection**: By default, plugins cannot use admin accounts for API calls to prevent privilege escalation -- **Username Restrictions**: When `allowedUsernames` is specified, only those users can be used - -**Common Permission Patterns:** - -```jsonc -// Allow any non-admin user (most permissive) -{ - "subsonicapi": { - "reason": "To search music library for metadata enhancement", - "allowAdmins": false - } -} - -// Allow only specific users (most secure) -{ - "subsonicapi": { - "reason": "To access playlists for synchronization with external service", - "allowedUsernames": ["sync-user"], - "allowAdmins": false - } -} - -// Allow admin users (use with caution) -{ - "subsonicapi": { - "reason": "To perform administrative tasks like library statistics", - "allowAdmins": true - } -} - -// Restrict to specific users but allow admins -{ - "subsonicapi": { - "reason": "To backup playlists for authorized users only", - "allowedUsernames": ["backup-admin", "user1", "user2"], - "allowAdmins": true - } -} -``` - -**Important Notes:** - -- Username matching is case-insensitive -- If `allowedUsernames` is empty or omitted, any username can be used (subject to `allowAdmins` setting) -- Admin restriction (`allowAdmins: false`) is checked after username validation -- Invalid or non-existent usernames will result in API call errors - -### Permission Validation - -The plugin system validates permissions during loading: - -1. **Schema Validation**: The manifest is validated against the JSON schema -2. **Permission Recognition**: Unknown permission keys are silently accepted for forward compatibility -3. **Service Loading**: Only services with corresponding permissions are made available to the plugin - -### Security Model - -The permission system provides multiple layers of security: - -#### 1. Principle of Least Privilege - -- Plugins start with zero permissions -- Only explicitly requested services are available -- No way to escalate privileges at runtime - -#### 2. Load-time Enforcement - -- Unauthorized services are not loaded into the WASM runtime -- No performance overhead for permission checks during execution -- Impossible to bypass restrictions through code manipulation - -#### 3. Service Isolation - -- Each plugin gets its own isolated service instances -- Plugins cannot interfere with each other's service usage -- Host services are sandboxed within the WASM environment - -### Best Practices for Plugin Developers - -#### Request Minimal Permissions - -```jsonc -// Good: No permissions if none needed -{ - "permissions": {} -} - -// Good: Only request what you need with clear reasoning -{ - "permissions": { - "http": { - "reason": "To fetch artist biography from MusicBrainz database", - "allowedUrls": { - "https://musicbrainz.org/ws/2/artist/*": ["GET"] - }, - "allowLocalNetwork": false - } - } -} - -// Avoid: Requesting unnecessary permissions -{ - "permissions": { - "http": { - "reason": "To fetch data", - "allowedUrls": { - "https://*": ["*"] - }, - "allowLocalNetwork": true - }, - "cache": { - "reason": "For caching" - }, - "scheduler": { - "reason": "For scheduling" - }, - "websocket": { - "reason": "For real-time updates", - "allowedUrls": ["wss://*"], - "allowLocalNetwork": true - } - } -} -``` - -#### Write Clear Permission Reasons - -Provide specific, descriptive reasons for each permission that explain exactly what the plugin does. Good reasons should: - -- Specify **what data** will be accessed/fetched -- Mention **which external services** will be contacted (if applicable) -- Explain **why** the permission is necessary for the plugin's functionality -- Use clear, non-technical language that users can understand - -```jsonc -// Good: Specific and informative -{ - "http": { - "reason": "To fetch album reviews from AllMusic API and artist biographies from MusicBrainz", - "allowedUrls": { - "https://www.allmusic.com/api/*": ["GET"], - "https://musicbrainz.org/ws/2/*": ["GET"] - }, - "allowLocalNetwork": false - }, - "cache": { - "reason": "To cache API responses for 24 hours to respect rate limits and improve performance" - } -} - -// Bad: Vague and unhelpful -{ - "http": { - "reason": "To make requests", - "allowedUrls": { - "https://*": ["*"] - }, - "allowLocalNetwork": true - }, - "cache": { - "reason": "For caching" - } -} -``` - -#### Handle Missing Permissions Gracefully - -Your plugin should provide clear error messages when permissions are missing: - -```go -func (p *Plugin) GetArtistInfo(ctx context.Context, req *api.ArtistInfoRequest) (*api.ArtistInfoResponse, error) { - // This will fail with "function not exported" if http permission is missing - resp, err := p.httpClient.Get(ctx, &http.HttpRequest{Url: apiURL}) - if err != nil { - // Check if it's a permission error - if strings.Contains(err.Error(), "not exported") { - return &api.ArtistInfoResponse{ - Error: "Plugin requires 'http' permission (reason: 'To fetch artist metadata from external APIs') - please add to manifest.json", - }, nil - } - return &api.ArtistInfoResponse{Error: err.Error()}, nil - } - // ... process response -} -``` - -### Troubleshooting Permissions - -#### Common Error Messages - -**"function not exported in module env"** - -- Cause: Plugin trying to call a service without proper permission -- Solution: Add the required permission to your manifest.json - -**"manifest validation failed" or "missing required field"** - -- Cause: Plugin manifest is missing required fields (e.g., `allowedUrls` for HTTP/WebSocket permissions) -- Solution: Ensure your manifest includes all required fields for each permission type - -**Permission silently ignored** - -- Cause: Using a permission key not recognized by current Navidrome version -- Effect: The unknown permission is silently ignored (no error or warning) -- Solution: This is actually normal behavior for forward compatibility - -#### Debugging Permission Issues - -1. **Check the manifest**: Ensure required permissions are spelled correctly and present -2. **Verify required fields**: Check that HTTP and WebSocket permissions include `allowedUrls` and other required fields -3. **Review logs**: Check for plugin loading errors, manifest validation errors, and WASM runtime errors -4. **Test incrementally**: Add permissions one at a time to identify which services your plugin needs -5. **Verify service names**: Ensure permission keys match exactly: `http`, `cache`, `config`, `scheduler`, `websocket`, `artwork`, `subsonicapi` -6. **Validate manifest**: Use a JSON schema validator to check your manifest against the schema - -### Future Considerations - -The permission system is designed for extensibility: - -- **Unknown permissions** are allowed in manifests for forward compatibility -- **New services** can be added with corresponding permission keys -- **Permission scoping** could be added in the future (e.g., read-only vs. read-write access) - -This ensures that plugins developed today will continue to work as the system evolves, while maintaining strong security boundaries. - -## Plugin System Implementation - -Navidrome's plugin system is built using the following key libraries: - -### 1. WebAssembly Runtime (Wazero) - -The plugin system uses [Wazero](https://github.com/tetratelabs/wazero), a WebAssembly runtime written in pure Go. Wazero was chosen for several reasons: - -- **No CGO dependency**: Unlike other WebAssembly runtimes, Wazero is implemented in pure Go, which simplifies cross-compilation and deployment. -- **Performance**: It provides efficient compilation and caching of WebAssembly modules. -- **Security**: Wazero enforces strict sandboxing, which is important for running third-party plugin code safely. - -The plugin manager uses Wazero to: - -- Compile and cache WebAssembly modules -- Create isolated runtime environments for each plugin -- Instantiate plugin modules when they're called -- Provide host functions that plugins can call - -### 2. Go-plugin Framework - -Navidrome builds on [go-plugin](https://github.com/knqyf263/go-plugin), a Go plugin system over WebAssembly that provides: - -- **Code generation**: Custom Protocol Buffer compiler plugin (`protoc-gen-go-plugin`) that generates Go code for both the host and WebAssembly plugins -- **Host function system**: Framework for exposing host functionality to plugins safely -- **Interface versioning**: Built-in mechanism for handling API compatibility between the host and plugins -- **Type conversion**: Utilities for marshaling and unmarshaling data between Go and WebAssembly - -This framework significantly simplifies plugin development by handling the low-level details of WebAssembly communication, allowing plugin developers to focus on implementing capabilities interfaces. - -### 3. Protocol Buffers (Protobuf) - -[Protocol Buffers](https://developers.google.com/protocol-buffers) serve as the interface definition language for the plugin system. Navidrome uses: - -- **protoc-gen-go-plugin**: A custom protobuf compiler plugin that generates Go code for both the Navidrome host and WebAssembly plugins -- Protobuf messages for structured data exchange between the host and plugins - -The protobuf definitions are located in: - -- `plugins/api/api.proto`: Core plugin capability interfaces -- `plugins/host/http/http.proto`: HTTP service interface -- `plugins/host/scheduler/scheduler.proto`: Scheduler service interface -- `plugins/host/config/config.proto`: Config service interface -- `plugins/host/websocket/websocket.proto`: WebSocket service interface -- `plugins/host/cache/cache.proto`: Cache service interface -- `plugins/host/artwork/artwork.proto`: Artwork service interface -- `plugins/host/subsonicapi/subsonicapi.proto`: SubsonicAPI service interface - -### 4. Integration Architecture - -The plugin system integrates these libraries through several key components: - -- **Plugin Manager**: Manages the lifecycle of plugins, from discovery to loading -- **Compilation Cache**: Improves performance by caching compiled WebAssembly modules -- **Host Function Bridge**: Exposes Navidrome functionality to plugins through WebAssembly imports -- **Capability Adapters**: Convert between the plugin API and Navidrome's internal interfaces - -Each plugin method call: - -1. Creates a new isolated plugin instance using Wazero -2. Executes the method in the sandboxed environment -3. Converts data between Go and WebAssembly formats using the protobuf-generated code -4. Cleans up the instance after the call completes - -This stateless design ensures that plugins remain isolated and can't interfere with Navidrome's core functionality or each other. - -## Configuration - -Plugins are configured in Navidrome's main configuration via the `Plugins` section: +Copy `my-plugin.ndp` to your Navidrome plugins folder and enable plugins in your config: ```toml [Plugins] -# Enable or disable plugin support Enabled = true - -# Directory where plugins are stored (defaults to [DataFolder]/plugins) Folder = "/path/to/plugins" ``` -By default, the plugins folder is created under `[DataFolder]/plugins` with restrictive permissions (`0700`) to limit access to the Navidrome user. +--- -### Plugin-specific Configuration +## Plugin Basics -You can also provide plugin-specific configuration using the `PluginConfig` section. Each plugin can have its own configuration map using the **folder name** as the key: +### What is a Plugin? -```toml -[PluginConfig.my-plugin-folder] -api_key = "your-api-key" -user_id = "your-user-id" -enable_feature = "true" +A Navidrome plugin is an `.ndp` package file (zip archive) containing: -[PluginConfig.another-plugin-folder] -server_url = "https://example.com/api" -timeout = "30" -``` +1. **`manifest.json`** – Plugin metadata (name, author, version, permissions) +2. **`plugin.wasm`** – Compiled WebAssembly module with capability functions -These configuration values are passed to plugins during initialization through the `OnInit` method in the `LifecycleManagement` capability. -Plugins that implement the `LifecycleManagement` capability will receive their configuration as a map of string keys and values. - -## Plugin Directory Structure - -Each plugin must be located in its own directory under the plugins folder: +### Plugin Package Structure ``` -plugins/ -├── my-plugin/ -│ ├── plugin.wasm # Compiled WebAssembly module -│ └── manifest.json # Plugin manifest defining metadata and capabilities -├── another-plugin/ -│ ├── plugin.wasm -│ └── manifest.json +my-plugin.ndp (zip archive) +├── manifest.json # Required: Plugin metadata +└── plugin.wasm # Required: Compiled WebAssembly module ``` -**Note**: Plugin identification has changed! Navidrome now uses the **folder name** as the unique identifier for plugins, not the `name` field in `manifest.json`. This means: +### Plugin Naming -- **Multiple plugins can have the same `name` in their manifest**, as long as they are in different folders -- **Plugin loading and commands use the folder name**, not the manifest name -- **Folder names must be unique** across all plugins in your plugins directory +Plugins are identified by their **filename** (without `.ndp` extension), not the manifest `name` field: -This change allows you to have multiple versions or variants of the same plugin (e.g., `lastfm-official`, `lastfm-custom`, `lastfm-dev`) that all have the same manifest name but coexist peacefully. +- `my-plugin.ndp` → plugin ID is `my-plugin` +- The manifest `name` is the display name shown in the UI -### Example: Multiple Plugin Variants +This allows users to have multiple instances of the same plugin with different configs by renaming the files. -``` -plugins/ -├── lastfm-official/ -│ ├── plugin.wasm -│ └── manifest.json # {"name": "LastFM Agent", ...} -├── lastfm-custom/ -│ ├── plugin.wasm -│ └── manifest.json # {"name": "LastFM Agent", ...} -└── lastfm-dev/ - ├── plugin.wasm - └── manifest.json # {"name": "LastFM Agent", ...} -``` +### The Manifest -All three plugins can have the same `"name": "LastFM Agent"` in their manifest, but they are identified and loaded by their folder names: - -```bash -# Load specific variants -navidrome plugin refresh lastfm-official -navidrome plugin refresh lastfm-custom -navidrome plugin refresh lastfm-dev - -# Configure each variant separately -[PluginConfig.lastfm-official] -api_key = "production-key" - -[PluginConfig.lastfm-dev] -api_key = "development-key" -``` - -### Using Symlinks for Plugin Variants - -Symlinks provide a powerful way to create multiple configurations for the same plugin without duplicating files. When you create a symlink to a plugin directory, Navidrome treats the symlink as a separate plugin with its own configuration. - -**Example: Discord Rich Presence with Multiple Configurations** - -```bash -# Create symlinks for different environments -cd /path/to/navidrome/plugins -ln -s /path/to/discord-rich-presence-plugin drp-prod -ln -s /path/to/discord-rich-presence-plugin drp-dev -ln -s /path/to/discord-rich-presence-plugin drp-test -``` - -Directory structure: - -``` -plugins/ -├── drp-prod -> /path/to/discord-rich-presence-plugin/ -├── drp-dev -> /path/to/discord-rich-presence-plugin/ -├── drp-test -> /path/to/discord-rich-presence-plugin/ -``` - -Each symlink can have its own configuration: - -```toml -[PluginConfig.drp-prod] -clientid = "production-client-id" -users = "admin:prod-token" - -[PluginConfig.drp-dev] -clientid = "development-client-id" -users = "admin:dev-token,testuser:test-token" - -[PluginConfig.drp-test] -clientid = "test-client-id" -users = "testuser:test-token" -``` - -**Key Benefits:** - -- **Single Source**: One plugin implementation serves multiple use cases -- **Independent Configuration**: Each symlink has its own configuration namespace -- **Development Workflow**: Easy to test different configurations without code changes -- **Resource Sharing**: All symlinks share the same compiled WASM binary - -**Important Notes:** - -- The **symlink name** (not the target folder name) is used as the plugin ID -- Configuration keys use the symlink name: `PluginConfig.` -- Each symlink appears as a separate plugin in `navidrome plugin list` -- CLI commands use the symlink name: `navidrome plugin refresh drp-dev` - -## Plugin Package Format (.ndp) - -Navidrome Plugin Packages (.ndp) are ZIP archives that bundle all files needed for a plugin. They can be installed using the `navidrome plugin install` command. - -### Package Structure - -A valid .ndp file must contain: - -``` -plugin-name.ndp (ZIP file) -├── plugin.wasm # Required: The compiled WebAssembly module -├── manifest.json # Required: Plugin manifest with metadata -├── README.md # Optional: Documentation -└── LICENSE # Optional: License information -``` - -### Creating a Plugin Package - -To create a plugin package: - -1. Compile your plugin to WebAssembly (plugin.wasm) -2. Create a manifest.json file with required fields -3. Include any documentation files you want to bundle -4. Create a ZIP archive of all files -5. Rename the ZIP file to have a .ndp extension - -### Installing a Plugin Package - -Use the Navidrome CLI to install plugins: - -```bash -navidrome plugin install /path/to/plugin-name.ndp -``` - -This will extract the plugin to a directory in your configured plugins folder. - -## Plugin Management - -Navidrome provides a command-line interface for managing plugins. To use these commands, the plugin system must be enabled in your configuration. - -### Available Commands - -```bash -# List all installed plugins -navidrome plugin list - -# Show detailed information about a plugin package or installed plugin -navidrome plugin info plugin-name-or-package.ndp - -# Install a plugin from a .ndp file -navidrome plugin install /path/to/plugin.ndp - -# Remove an installed plugin (use folder name) -navidrome plugin remove plugin-folder-name - -# Update an existing plugin -navidrome plugin update /path/to/updated-plugin.ndp - -# Reload a plugin without restarting Navidrome (use folder name) -navidrome plugin refresh plugin-folder-name - -# Create a symlink to a plugin development folder -navidrome plugin dev /path/to/dev/folder -``` - -### Plugin Development - -The `dev` and `refresh` commands are particularly useful for plugin development: - -#### Development Workflow - -1. Create a plugin development folder with required files (`manifest.json` and `plugin.wasm`) -2. Run `navidrome plugin dev /path/to/your/plugin` to create a symlink in the plugins directory -3. Make changes to your plugin code -4. Recompile the WebAssembly module -5. Run `navidrome plugin refresh your-plugin-folder-name` to reload the plugin without restarting Navidrome - -The `dev` command creates a symlink from your development folder to the plugins directory, allowing you to edit the plugin files directly in your development environment without copying them to the plugins directory after each change. - -The refresh process: - -- Reloads the plugin manifest -- Recompiles the WebAssembly module -- Updates the plugin registration -- Makes the updated plugin immediately available to Navidrome - -### Plugin Security - -Navidrome provides multiple layers of security for plugin execution: - -1. **WebAssembly Sandbox**: Plugins run in isolated WebAssembly environments with no direct system access -2. **Permission System**: Plugins can only access host services they explicitly request in their manifest (see [Plugin Permission System](#plugin-permission-system)) -3. **File System Security**: The plugins folder is configured with restricted permissions (0700) accessible only by the user running Navidrome -4. **Resource Isolation**: Each plugin instance is isolated and cannot interfere with other plugins or core Navidrome functionality - -The permission system ensures that plugins follow the principle of least privilege - they start with no access to host services and must explicitly declare what they need. This prevents malicious or poorly written plugins from accessing unauthorized functionality. - -Always ensure you trust the source of any plugins you install, and review their requested permissions before installation. - -## Plugin Manifest - -**Capability Names Are Case-Sensitive**: Entries in the `capabilities` array must exactly match one of the supported capabilities: `MetadataAgent`, `Scrobbler`, `SchedulerCallback`, `WebSocketCallback`, or `LifecycleManagement`. -**Manifest Validation**: The `manifest.json` is validated against the embedded JSON schema (`plugins/schema/manifest.schema.json`). Invalid manifests will be rejected during plugin discovery. - -Every plugin must provide a `manifest.json` file that declares metadata, capabilities, and permissions: +Every plugin must include a `manifest.json` file. Example: ```json { - "name": "my-awesome-plugin", - "author": "Your Name", + "name": "My Plugin", + "author": "Author Name", "version": "1.0.0", - "description": "A plugin that does awesome things", - "website": "https://github.com/yourname/my-awesome-plugin", - "capabilities": [ - "MetadataAgent", - "Scrobbler", - "SchedulerCallback", - "WebSocketCallback", - "LifecycleManagement" - ], + "description": "What this plugin does", + "website": "https://example.com", "permissions": { "http": { - "reason": "To fetch metadata from external music APIs" - }, - "cache": { - "reason": "To cache API responses and reduce rate limiting" - }, - "config": { - "reason": "To read API keys and service configuration" - }, - "scheduler": { - "reason": "To schedule periodic data refresh tasks" + "reason": "Fetch metadata from external API", + "requiredHosts": ["api.example.com", "*.musicbrainz.org"] } } } ``` -Required fields: +**Required fields:** `name`, `author`, `version` -- `name`: Display name of the plugin (used for documentation/display purposes; folder name is used for identification) -- `author`: The creator or organization behind the plugin -- `version`: Version identifier (recommended to follow semantic versioning) -- `description`: A brief description of what the plugin does -- `website`: Website URL for the plugin documentation, source code, or homepage (must be a valid URI) -- `capabilities`: Array of capability types the plugin implements -- `permissions`: Object mapping host service names to their configurations (use empty object `{}` for no permissions) +#### Experimental Features -Currently supported capabilities: +Plugins can opt-in to experimental WebAssembly features that may change or be removed in future versions. Currently supported: -- `MetadataAgent` - For implementing media metadata providers -- `Scrobbler` - For implementing scrobbling plugins -- `SchedulerCallback` - For implementing timed callbacks -- `WebSocketCallback` - For interacting with WebSocket endpoints and handling WebSocket events -- `LifecycleManagement` - For handling plugin initialization and configuration +- **`threads`** – Enables WebAssembly threads support (for plugins compiled with multi-threading) -## Plugin Loading Process +```json +{ + "name": "Threaded Plugin", + "author": "Author Name", + "version": "1.0.0", + "experimental": { + "threads": { + "reason": "Required for concurrent audio processing" + } + } +} +``` -1. The Plugin Manager scans the plugins directory and all subdirectories -2. For each subdirectory containing a `plugin.wasm` file and valid `manifest.json`, the manager: - - Validates the manifest and checks for supported capabilities - - Pre-compiles the WASM module in the background - - Registers the plugin using the **folder name** as the unique identifier in the plugin registry -3. Plugins can be loaded on-demand by folder name or all at once, depending on the manager's method calls +> **Note:** Experimental features may have compatibility or performance implications. Use only when necessary. -## Writing a Plugin +--- -### Requirements +## Capabilities -1. Your plugin must be compiled to WebAssembly (WASM) -2. Your plugin must implement at least one of the capability interfaces defined in `api.proto` -3. Your plugin must be placed in its own directory with a proper `manifest.json` +Capabilities define what your plugin can do. They're automatically detected based on which functions you export. -### Plugin Registration Functions +### MetadataAgent -The plugin API provides several registration functions that plugins can call during initialization to register capabilities and obtain host services. These functions should typically be called in your plugin's `init()` function. +Provides artist and album metadata. Export one or more of these functions: -#### Standard Registration Functions +| Function | Input | Output | Description | +|---------------------------|----------------------------|----------------------------------|----------------------| +| `nd_get_artist_mbid` | `{id, name}` | `{mbid}` | Get MusicBrainz ID | +| `nd_get_artist_url` | `{id, name, mbid?}` | `{url}` | Get artist URL | +| `nd_get_artist_biography` | `{id, name, mbid?}` | `{biography}` | Get artist biography | +| `nd_get_similar_artists` | `{id, name, mbid?, limit}` | `{artists: [{name, mbid?}]}` | Get similar artists | +| `nd_get_artist_images` | `{id, name, mbid?}` | `{images: [{url, size}]}` | Get artist images | +| `nd_get_artist_top_songs` | `{id, name, mbid?, count}` | `{songs: [{name, mbid?}]}` | Get top songs | +| `nd_get_album_info` | `{name, artist, mbid?}` | `{name, mbid, description, url}` | Get album info | +| `nd_get_album_images` | `{name, artist, mbid?}` | `{images: [{url, size}]}` | Get album images | + +**Example:** ```go -func RegisterMetadataAgent(agent MetadataAgent) -func RegisterScrobbler(scrobbler Scrobbler) -func RegisterSchedulerCallback(callback SchedulerCallback) -func RegisterLifecycleManagement(lifecycle LifecycleManagement) -func RegisterWebSocketCallback(callback WebSocketCallback) +type ArtistInput struct { + ID string `json:"id"` + Name string `json:"name"` + MBID string `json:"mbid,omitempty"` +} + +type BiographyOutput struct { + Biography string `json:"biography"` +} + +//go:wasmexport nd_get_artist_biography +func ndGetArtistBiography() int32 { + var input ArtistInput + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return 1 + } + + // Fetch biography from your data source... + output := BiographyOutput{Biography: "Artist biography..."} + pdk.OutputJSON(output) + return 0 +} ``` -These functions register plugins for the standard capability interfaces: +To use the plugin as a metadata agent, add it to your config: -- **RegisterMetadataAgent**: Register a plugin that provides artist/album metadata and images -- **RegisterScrobbler**: Register a plugin that handles scrobbling to external services -- **RegisterSchedulerCallback**: Register a plugin that handles scheduled callbacks (single callback per plugin) -- **RegisterLifecycleManagement**: Register a plugin that handles initialization and configuration -- **RegisterWebSocketCallback**: Register a plugin that handles WebSocket events +```toml +Agents = "lastfm,spotify,my-plugin" +``` -**Basic Usage Example:** +### Scrobbler + +Integrates with external scrobbling services. Export one or more of these functions: + +| Function | Input | Output | Description | +|------------------------------|-----------------------|----------------|-----------------------------| +| `nd_scrobbler_is_authorized` | `{username}` | `bool` | Check if user is authorized | +| `nd_scrobbler_now_playing` | See below | (none) | Send now playing | +| `nd_scrobbler_scrobble` | See below | (none) | Submit a scrobble | + +> **Important:** Scrobbler plugins require the `users` permission in their manifest. Scrobble events are only sent for users assigned to the plugin through Navidrome's configuration. The `nd_scrobbler_is_authorized` function is called after the server-side user check passes. + +**Manifest permission:** + +```json +{ + "permissions": { + "users": { + "reason": "Receive scrobble events for users assigned to this plugin" + } + } +} +``` + +**NowPlaying/Scrobble Input:** + +```json +{ + "username": "john", + "track": { + "id": "track-id", + "title": "Song Title", + "album": "Album Name", + "artist": "Artist Name", + "albumArtist": "Album Artist", + "duration": 180.5, + "trackNumber": 1, + "discNumber": 1, + "mbzRecordingId": "...", + "mbzAlbumId": "...", + "mbzArtistId": "..." + }, + "timestamp": 1703270400 +} +``` + +**Error Handling:** + +On success, return `0`. On failure, use `pdk.SetError()` with one of these error types: + +- `scrobbler(not_authorized)` – User needs to re-authorize +- `scrobbler(retry_later)` – Temporary failure, Navidrome will retry +- `scrobbler(unrecoverable)` – Permanent failure, scrobble discarded ```go -type MyPlugin struct { - // plugin implementation -} +import "github.com/navidrome/navidrome/plugins/pdk/go/scrobbler" -func init() { - plugin := &MyPlugin{} - - // Register capabilities your plugin implements - api.RegisterScrobbler(plugin) - api.RegisterLifecycleManagement(plugin) -} +// Return error using predefined constants +return scrobbler.ScrobblerErrorNotAuthorized +return scrobbler.ScrobblerErrorRetryLater +return scrobbler.ScrobblerErrorUnrecoverable ``` -#### RegisterNamedSchedulerCallback +### Lifecycle -```go -func RegisterNamedSchedulerCallback(name string, cb SchedulerCallback) scheduler.SchedulerService -``` +Optional initialization callback. Export this function to run code when your plugin loads: -This function registers a named scheduler callback and returns a scheduler service instance. Named callbacks allow a single plugin to register multiple scheduler callbacks for different purposes, each with its own identifier. +| Function | Input | Output | Description | +|--------------|-------|------------|--------------------------------| +| `nd_on_init` | `{}` | `{error?}` | Called once after plugin loads | -**Parameters:** +Useful for initializing connections, scheduling recurring tasks, etc. -- `name` (string): A unique identifier for this scheduler callback within the plugin. This name is used to route scheduled events to the correct callback handler. -- `cb` (SchedulerCallback): An object that implements the `SchedulerCallback` interface - -**Returns:** - -- `scheduler.SchedulerService`: A scheduler service instance that can be used to schedule one-time or recurring tasks for this specific callback - -**Usage Example** (from Discord Rich Presence plugin): - -```go -func init() { - // Register multiple named scheduler callbacks for different purposes - plugin.sched = api.RegisterNamedSchedulerCallback("close-activity", plugin) - plugin.rpc.sched = api.RegisterNamedSchedulerCallback("heartbeat", plugin.rpc) -} - -// The plugin implements SchedulerCallback to handle "close-activity" events -func (d *DiscordRPPlugin) OnSchedulerCallback(ctx context.Context, req *api.SchedulerCallbackRequest) (*api.SchedulerCallbackResponse, error) { - log.Printf("Removing presence for user %s", req.ScheduleId) - // Handle close-activity scheduling events - return nil, d.rpc.clearActivity(ctx, req.ScheduleId) -} - -// The rpc component implements SchedulerCallback to handle "heartbeat" events -func (r *discordRPC) OnSchedulerCallback(ctx context.Context, req *api.SchedulerCallbackRequest) (*api.SchedulerCallbackResponse, error) { - // Handle heartbeat scheduling events - return nil, r.sendHeartbeat(ctx, req.ScheduleId) -} - -// Use the returned scheduler service to schedule tasks -func (d *DiscordRPPlugin) NowPlaying(ctx context.Context, request *api.ScrobblerNowPlayingRequest) (*api.ScrobblerNowPlayingResponse, error) { - // Schedule a one-time callback to clear activity when track ends - _, err = d.sched.ScheduleOneTime(ctx, &scheduler.ScheduleOneTimeRequest{ - ScheduleId: request.Username, - DelaySeconds: request.Track.Length - request.Track.Position + 5, - }) - return nil, err -} - -func (r *discordRPC) connect(ctx context.Context, username string, token string) error { - // Schedule recurring heartbeats for Discord connection - _, err := r.sched.ScheduleRecurring(ctx, &scheduler.ScheduleRecurringRequest{ - CronExpression: "@every 41s", - ScheduleId: username, - }) - return err -} -``` - -**Key Benefits:** - -- **Multiple Schedulers**: A single plugin can have multiple named scheduler callbacks for different purposes (e.g., "heartbeat", "cleanup", "refresh") -- **Isolated Scheduling**: Each named callback gets its own scheduler service, allowing independent scheduling management -- **Clear Separation**: Different callback handlers can be implemented on different objects within your plugin -- **Flexible Routing**: The scheduler automatically routes callbacks to the correct handler based on the registration name - -**Important Notes:** - -- The `name` parameter must be unique within your plugin, but can be the same across different plugins -- The returned scheduler service is specifically tied to the named callback you registered -- Scheduled events will call the `OnSchedulerCallback` method on the object you provided during registration -- You must implement the `SchedulerCallback` interface on the object you register - -#### RegisterSchedulerCallback vs RegisterNamedSchedulerCallback - -- **Use `RegisterSchedulerCallback`** when your plugin only needs a single scheduler callback -- **Use `RegisterNamedSchedulerCallback`** when your plugin needs multiple scheduler callbacks for different purposes (like the Discord plugin's "heartbeat" and "close-activity" callbacks) - -The named version allows better organization and separation of concerns when you have complex scheduling requirements. - -### Capability Interfaces - -#### Metadata Agent - -A capability fetches metadata about artists and albums. Implement this interface to add support for fetching data from external sources. - -```protobuf -service MetadataAgent { - // Artist metadata methods - rpc GetArtistMBID(ArtistMBIDRequest) returns (ArtistMBIDResponse); - rpc GetArtistURL(ArtistURLRequest) returns (ArtistURLResponse); - rpc GetArtistBiography(ArtistBiographyRequest) returns (ArtistBiographyResponse); - rpc GetSimilarArtists(ArtistSimilarRequest) returns (ArtistSimilarResponse); - rpc GetArtistImages(ArtistImageRequest) returns (ArtistImageResponse); - rpc GetArtistTopSongs(ArtistTopSongsRequest) returns (ArtistTopSongsResponse); - - // Album metadata methods - rpc GetAlbumInfo(AlbumInfoRequest) returns (AlbumInfoResponse); - rpc GetAlbumImages(AlbumImagesRequest) returns (AlbumImagesResponse); -} -``` - -#### Scrobbler - -This capability enables scrobbling to external services. Implement this interface to add support for custom scrobblers. - -```protobuf -service Scrobbler { - rpc IsAuthorized(ScrobblerIsAuthorizedRequest) returns (ScrobblerIsAuthorizedResponse); - rpc NowPlaying(ScrobblerNowPlayingRequest) returns (ScrobblerNowPlayingResponse); - rpc Scrobble(ScrobblerScrobbleRequest) returns (ScrobblerScrobbleResponse); -} -``` - -#### Scheduler Callback - -This capability allows plugins to receive one-time or recurring scheduled callbacks. Implement this interface to add -support for scheduled tasks. See the [SchedulerService](#scheduler-service) for more information. - -```protobuf -service SchedulerCallback { - rpc OnSchedulerCallback(SchedulerCallbackRequest) returns (SchedulerCallbackResponse); -} -``` - -#### WebSocket Callback - -This capability allows plugins to interact with WebSocket endpoints and handle WebSocket events. Implement this interface to add support for WebSocket-based communication. - -```protobuf -service WebSocketCallback { - // Called when a text message is received - rpc OnTextMessage(OnTextMessageRequest) returns (OnTextMessageResponse); - - // Called when a binary message is received - rpc OnBinaryMessage(OnBinaryMessageRequest) returns (OnBinaryMessageResponse); - - // Called when an error occurs - rpc OnError(OnErrorRequest) returns (OnErrorResponse); - - // Called when the connection is closed - rpc OnClose(OnCloseRequest) returns (OnCloseResponse); -} -``` - -Plugins can use the WebSocket host service to connect to WebSocket endpoints, send messages, and handle responses: - -```go -// Define a connection ID first -connectionID := "my-connection-id" - -// Connect to a WebSocket server -connectResp, err := websocket.Connect(ctx, &websocket.ConnectRequest{ - Url: "wss://example.com/ws", - Headers: map[string]string{"Authorization": "Bearer token"}, - ConnectionId: connectionID, -}) -if err != nil { - return err -} - -// Send a text message -_, err = websocket.SendText(ctx, &websocket.SendTextRequest{ - ConnectionId: connectionID, - Message: "Hello WebSocket", -}) - -// Close the connection when done -_, err = websocket.Close(ctx, &websocket.CloseRequest{ - ConnectionId: connectionID, - Code: 1000, // Normal closure - Reason: "Done", -}) -``` +--- ## Host Services -Navidrome provides several host services that plugins can use to interact with external systems and access functionality. Plugins must declare permissions for each service they want to use in their `manifest.json`. +Host services let your plugin call back into Navidrome for advanced functionality. Each service requires declaring the permission in your manifest. -### HTTP Service +### HTTP Requests -The HTTP service allows plugins to make HTTP requests to external APIs and services. To use this service, declare the `http` permission in your manifest. +Make HTTP requests using the Extism PDK's built-in HTTP support. See your [Extism PDK documentation](https://extism.org/docs/concepts/pdk) for more details on making requests. -#### Basic Usage +**Manifest permission:** ```json { "permissions": { "http": { - "reason": "To fetch artist metadata from external music APIs" + "reason": "Fetch metadata from external API", + "requiredHosts": ["api.example.com", "*.musicbrainz.org"] } } } ``` -#### Granular Permissions - -For enhanced security, you can specify granular HTTP permissions that restrict which URLs and HTTP methods your plugin can access: - -```json -{ - "permissions": { - "http": { - "reason": "To fetch album reviews from AllMusic and artist data from MusicBrainz", - "allowedUrls": { - "https://api.allmusic.com": ["GET", "POST"], - "https://*.musicbrainz.org": ["GET"], - "https://coverartarchive.org": ["GET"], - "*": ["GET"] - }, - "allowLocalNetwork": false - } - } -} -``` - -**Permission Fields:** - -- `reason` (required): Clear explanation of why HTTP access is needed -- `allowedUrls` (required): Map of URL patterns to allowed HTTP methods - - - Must contain at least one URL pattern - - For unrestricted access, use: `{"*": ["*"]}` - - Keys can be exact URLs, wildcard patterns, or `*` for any URL - - Values are arrays of HTTP methods: `GET`, `POST`, `PUT`, `DELETE`, `PATCH`, `HEAD`, `OPTIONS`, or `*` for any method - - **Important**: Redirect destinations must also be included in this list. If a URL redirects to another URL not in `allowedUrls`, the redirect will be blocked. - -- `allowLocalNetwork` (optional, default: `false`): Whether to allow requests to localhost/private IPs - -**URL Pattern Matching:** - -- Exact URLs: `https://api.example.com` -- Wildcard subdomains: `https://*.example.com` (matches any subdomain) -- Wildcard paths: `https://example.com/api/*` (matches any path under /api/) -- Global wildcard: `*` (matches any URL - use with caution) - -**Examples:** - -```json -// Allow only GET requests to specific APIs -{ - "allowedUrls": { - "https://api.last.fm": ["GET"], - "https://ws.audioscrobbler.com": ["GET"] - } -} - -// Allow any method to a trusted domain, GET everywhere else -{ - "allowedUrls": { - "https://my-trusted-api.com": ["*"], - "*": ["GET"] - } -} - -// Handle redirects by including redirect destinations -{ - "allowedUrls": { - "https://short.ly/api123": ["GET"], // Original URL - "https://api.actual-service.com": ["GET"] // Redirect destination - } -} - -// Strict permissions for a secure plugin (blocks redirects by not including redirect destinations) -{ - "allowedUrls": { - "https://api.musicbrainz.org/ws/2": ["GET"] - }, - "allowLocalNetwork": false -} -``` - -#### Security Considerations - -The HTTP service implements several security features: - -1. **Local Network Protection**: By default, requests to localhost and private IP ranges are blocked -2. **URL Filtering**: Only URLs matching `allowedUrls` patterns are allowed -3. **Method Restrictions**: HTTP methods are validated against the allowed list for each URL pattern -4. **Redirect Security**: - - Redirect destinations must also match `allowedUrls` patterns and methods - - Maximum of 5 redirects per request to prevent redirect loops - - To block all redirects, simply don't include any redirect destinations in `allowedUrls` - -**Private IP Ranges Blocked (when `allowLocalNetwork: false`):** - -- IPv4: `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`, `127.0.0.0/8`, `169.254.0.0/16` -- IPv6: `::1`, `fe80::/10`, `fc00::/7` -- Hostnames: `localhost` - -#### Making HTTP Requests +**Usage:** ```go -import "github.com/navidrome/navidrome/plugins/host/http" +req := pdk.NewHTTPRequest(pdk.MethodGet, "https://api.example.com/data") +req.SetHeader("Authorization", "Bearer " + apiKey) +resp := req.Send() -// GET request -resp, err := httpClient.Get(ctx, &http.HttpRequest{ - Url: "https://api.example.com/data", - Headers: map[string]string{ - "Authorization": "Bearer " + token, - "User-Agent": "MyPlugin/1.0", - }, - TimeoutMs: 5000, -}) - -// POST request with body -resp, err := httpClient.Post(ctx, &http.HttpRequest{ - Url: "https://api.example.com/submit", - Headers: map[string]string{ - "Content-Type": "application/json", - }, - Body: []byte(`{"key": "value"}`), - TimeoutMs: 10000, -}) - -// Handle response -if err != nil { - return &api.Response{Error: "HTTP request failed: " + err.Error()}, nil -} - -if resp.Error != "" { - return &api.Response{Error: "HTTP error: " + resp.Error}, nil -} - -if resp.Status != 200 { - return &api.Response{Error: fmt.Sprintf("HTTP %d: %s", resp.Status, string(resp.Body))}, nil -} - -// Use response data -data := resp.Body -headers := resp.Headers -``` - -### Other Host Services - -#### Config Service - -Access plugin-specific configuration: - -```json -{ - "permissions": { - "config": { - "reason": "To read API keys and service endpoints from plugin configuration" - } - } +if resp.Status() == 200 { + data := resp.Body() + // Process response... } ``` -#### Cache Service +### Scheduler -Store and retrieve data to improve performance: +Schedule one-time or recurring tasks. Your plugin must export `nd_scheduler_callback` to receive events. -```json -{ - "permissions": { - "cache": { - "reason": "To cache API responses and reduce external service calls" - } - } -} -``` - -#### Scheduler Service - -Schedule recurring or one-time tasks: +**Manifest permission:** ```json { "permissions": { "scheduler": { - "reason": "To schedule periodic metadata refresh and cleanup tasks" + "reason": "Schedule periodic metadata refresh" } } } ``` -#### WebSocket Service +**Host functions:** -Connect to WebSocket endpoints: +| Function | Parameters | Description | +|-------------------------------|------------------------------------------|-----------------------------| +| `scheduler_scheduleonetime` | `delaySeconds, payload, scheduleId?` | Schedule one-time callback | +| `scheduler_schedulerecurring` | `cronExpression, payload, scheduleId?` | Schedule recurring callback | +| `scheduler_cancelschedule` | `scheduleId` | Cancel a scheduled task | + +**Callback function:** + +```go +type SchedulerCallbackInput struct { + ScheduleID string `json:"scheduleId"` + Payload string `json:"payload"` + IsRecurring bool `json:"isRecurring"` +} + +//go:wasmexport nd_scheduler_callback +func ndSchedulerCallback() int32 { + var input SchedulerCallbackInput + pdk.InputJSON(&input) + + // Handle the scheduled task based on payload + pdk.Log(pdk.LogInfo, "Task fired: " + input.ScheduleID) + return 0 +} +``` + +**Scheduling tasks (using generated SDK):** + +Add the generated SDK to your `go.mod`: + +``` +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go +``` + +Then import and use: + +```go +import "github.com/navidrome/navidrome/plugins/pdk/go/host" + +// Schedule one-time task in 60 seconds +scheduleID, err := host.SchedulerScheduleOneTime(60, "my-payload", "") + +// Schedule recurring task with cron expression (every hour) +scheduleID, err := host.SchedulerScheduleRecurring("0 * * * *", "hourly-task", "") + +// Cancel a task +err := host.SchedulerCancelSchedule(scheduleID) +``` + +### Cache + +Store and retrieve data in an in-memory TTL-based cache. Each plugin has its own isolated namespace. + +**Manifest permission:** + +```json +{ + "permissions": { + "cache": { + "reason": "Cache API responses to reduce external requests" + } + } +} +``` + +**Host functions:** + +| Function | Parameters | Description | +|-------------------|---------------------------|-----------------------| +| `cache_setstring` | `key, value, ttl_seconds` | Store a string | +| `cache_getstring` | `key` | Get a string | +| `cache_setint` | `key, value, ttl_seconds` | Store an integer | +| `cache_getint` | `key` | Get an integer | +| `cache_setfloat` | `key, value, ttl_seconds` | Store a float | +| `cache_getfloat` | `key` | Get a float | +| `cache_setbytes` | `key, value, ttl_seconds` | Store bytes | +| `cache_getbytes` | `key` | Get bytes | +| `cache_has` | `key` | Check if key exists | +| `cache_remove` | `key` | Delete a cached value | + +**TTL:** Pass `0` for the default (24 hours), or specify seconds. + +**Usage (with generated SDK):** + +Import the Go SDK (see [Scheduler](#scheduler) for `go.mod` setup): + +```go +import "github.com/navidrome/navidrome/plugins/pdk/go/host" + +// Cache a value for 1 hour +host.CacheSetString("api-response", responseData, 3600) + +// Retrieve (check Exists before using Value) +result, err := host.CacheGetString("api-response") +if result.Exists { + data := result.Value +} +``` + +> **Note:** Cache is in-memory only and cleared on server restart. + +### KVStore + +Persistent key-value storage that survives server restarts. Each plugin has its own isolated SQLite database. + +**Manifest permission:** + +```json +{ + "permissions": { + "kvstore": { + "reason": "Store OAuth tokens and plugin state", + "maxSize": "1MB" + } + } +} +``` + +**Permission options:** +- `maxSize`: Maximum storage size (e.g., `"1MB"`, `"500KB"`). Default: 1MB + +**Host functions:** + +| Function | Parameters | Description | +|--------------------------|--------------|-----------------------------------| +| `kvstore_set` | `key, value` | Store a byte value | +| `kvstore_get` | `key` | Retrieve a byte value | +| `kvstore_delete` | `key` | Delete a value | +| `kvstore_has` | `key` | Check if key exists | +| `kvstore_list` | `prefix` | List keys matching prefix | +| `kvstore_getstorageused` | - | Get current storage usage (bytes) | + +**Key constraints:** +- Maximum key length: 256 bytes +- Keys must be valid UTF-8 strings + +**Usage (with generated SDK):** + +Import the Go SDK (see [Scheduler](#scheduler) for `go.mod` setup): + +```go +import "github.com/navidrome/navidrome/plugins/pdk/go/host" + +// Store a value (as raw bytes) +token := []byte(`{"access_token": "xyz", "refresh_token": "abc"}`) +_, err := host.KVStoreSet("oauth:spotify", token) + +// Retrieve a value +result, err := host.KVStoreGet("oauth:spotify") +if result.Exists { + var tokenData map[string]string + json.Unmarshal(result.Value, &tokenData) +} + +// List all keys with prefix +keysResult, err := host.KVStoreList("user:") +for _, key := range keysResult.Keys { + // Process each key +} + +// Check storage usage +usageResult, err := host.KVStoreGetStorageUsed() +fmt.Printf("Using %d bytes\n", usageResult.Bytes) + +// Delete a value +host.KVStoreDelete("oauth:spotify") +``` + +> **Note:** Unlike Cache, KVStore data persists across server restarts. Storage is located at `${DataFolder}/plugins/${pluginID}/kvstore.db`. + +### WebSocket + +Establish persistent WebSocket connections to external services. + +**Manifest permission:** ```json { "permissions": { "websocket": { - "reason": "To connect to real-time music service APIs for live data", - "allowedUrls": [ - "wss://api.musicservice.com/ws", - "wss://realtime.example.com" - ], - "allowLocalNetwork": false + "reason": "Real-time connection to service", + "requiredHosts": ["gateway.example.com", "*.discord.gg"] } } } ``` -#### Artwork Service +**Host functions:** -Generate public URLs for artwork: +| Function | Parameters | Description | +|------------------------|---------------------------------|-------------------| +| `websocket_connect` | `url, headers?, connectionId?` | Open a connection | +| `websocket_sendtext` | `connectionId, message` | Send text message | +| `websocket_sendbinary` | `connectionId, data` | Send binary data | +| `websocket_close` | `connectionId, code?, reason?` | Close connection | + +**Callback functions (export these to receive events):** + +| Function | Input | Description | +|----------------------------------|---------------------------------|----------------------------------| +| `nd_websocket_on_text_message` | `{connectionId, message}` | Text message received | +| `nd_websocket_on_binary_message` | `{connectionId, data}` | Binary message received (base64) | +| `nd_websocket_on_error` | `{connectionId, error}` | Connection error | +| `nd_websocket_on_close` | `{connectionId, code, reason}` | Connection closed | + +### Library + +Access music library metadata and optionally read files from library directories. + +**Manifest permission:** + +```json +{ + "permissions": { + "library": { + "reason": "Access library metadata for analysis", + "filesystem": false + } + } +} +``` + +- `filesystem` – Set to `true` to enable read-only access to library directories (default: `false`) + +**Host functions:** + +| Function | Parameters | Returns | +|----------------------------|------------|---------------------------| +| `library_getlibrary` | `id` | Library metadata | +| `library_getalllibraries` | (none) | Array of library metadata | + +**Library metadata:** + +```json +{ + "id": 1, + "name": "My Music", + "path": "/music/collection", + "mountPoint": "/libraries/1", + "lastScanAt": 1703270400, + "totalSongs": 5000, + "totalAlbums": 500, + "totalArtists": 200, + "totalSize": 50000000000, + "totalDuration": 1500000.5 +} +``` + +> **Note:** The `path` and `mountPoint` fields are only included when `filesystem: true` is set in the permission. + +**Filesystem access:** + +When `filesystem: true`, your plugin can read files from library directories via WASI filesystem APIs. Each library is mounted at `/libraries/`: + +```go +import "os" + +// Read a file from library 1 +content, err := os.ReadFile("/libraries/1/Artist/Album/track.mp3") + +// List directory contents +entries, err := os.ReadDir("/libraries/1/Artist") +``` + +> **Security:** Filesystem access is read-only and restricted to configured library paths only. Plugins cannot access other parts of the host filesystem. + +**Usage (with generated SDK):** + +Import the Go SDK (see [Scheduler](#scheduler) for `go.mod` setup). The `Library` struct is provided by the SDK: + +```go +import "github.com/navidrome/navidrome/plugins/pdk/go/host" + +// Get a specific library +resp, err := host.LibraryGetLibrary(1) +if err != nil { + // Handle error +} +library := resp.Result + +// Get all libraries +resp, err := host.LibraryGetAllLibraries() +for _, lib := range resp.Result { + // lib is of type host.Library + fmt.Printf("Library: %s (%d songs)\n", lib.Name, lib.TotalSongs) +} +``` + +### Artwork + +Generate public URLs for Navidrome artwork (albums, artists, tracks, playlists). + +**Manifest permission:** ```json { "permissions": { "artwork": { - "reason": "To generate public URLs for album and artist images" + "reason": "Get artwork URLs for display" } } } ``` -### Error Handling +**Host functions:** -Plugins should use the standard error values (`plugin:not_found`, `plugin:not_implemented`) to indicate resource-not-found and unimplemented-method scenarios. All other errors will be propagated directly to the caller. Ensure your capability methods return errors via the response message `error` fields rather than panicking or relying on transport errors. +| Function | Parameters | Returns | +|--------------------------|------------|-------------| +| `artwork_getartisturl` | `id, size` | Artwork URL | +| `artwork_getalbumurl` | `id, size` | Artwork URL | +| `artwork_gettrackurl` | `id, size` | Artwork URL | +| `artwork_getplaylisturl` | `id, size` | Artwork URL | -## Plugin Lifecycle and Statelessness +### SubsonicAPI -**Important**: Navidrome plugins are stateless. Each method call creates a new plugin instance which is destroyed afterward. This has several important implications: +Call Navidrome's Subsonic API internally (no network round-trip). -1. **No in-memory persistence**: Plugins cannot store state between method calls in memory -2. **Each call is isolated**: Variables, configurations, and runtime state don't persist between calls -3. **No shared resources**: Each plugin instance has its own memory space +**Manifest permission:** -This stateless design is crucial for security and stability: - -- Memory leaks in one call won't affect subsequent operations -- A crashed plugin instance won't bring down the entire system -- Resource usage is more predictable and contained - -When developing plugins, keep these guidelines in mind: - -- Don't try to cache data in memory between calls -- Don't store authentication tokens or session data in variables -- If persistence is needed, use external storage or the host's HTTP interface -- Performance optimizations should focus on efficient per-call execution - -### Using Plugin Configuration - -Since plugins are stateless, you can use the `LifecycleManagement` interface to read configuration when your plugin is loaded and perform any necessary setup: - -```go -func (p *myPlugin) OnInit(ctx context.Context, req *api.InitRequest) (*api.InitResponse, error) { - // Access plugin configuration - apiKey := req.Config["api_key"] - if apiKey == "" { - return &api.InitResponse{Error: "Missing API key in configuration"}, nil +```json +{ + "permissions": { + "subsonicapi": { + "reason": "Access library data" + }, + "users": { + "reason": "Access user information for SubsonicAPI authorization" } - - // Validate configuration - serverURL := req.Config["server_url"] - if serverURL == "" { - serverURL = "https://default-api.example.com" // Use default if not specified - } - - // Perform initialization tasks (e.g., validate API key) - httpClient := &http.HttpServiceClient{} - resp, err := httpClient.Get(ctx, &http.HttpRequest{ - Url: serverURL + "/validate?key=" + apiKey, - }) - if err != nil { - return &api.InitResponse{Error: "Failed to validate API key: " + err.Error()}, nil - } - - if resp.StatusCode != 200 { - return &api.InitResponse{Error: "Invalid API key"}, nil - } - - return &api.InitResponse{}, nil + } } ``` -Remember, the `OnInit` method is called only once when the plugin is loaded. It cannot store any state that needs to persist between method calls. It's primarily useful for: +> **Important:** The `subsonicapi` permission requires the `users` permission. User access is controlled through the plugin's database configuration, not the manifest. Configure which users can use the plugin through the Navidrome UI or API. -1. Validating required configuration -2. Checking API credentials -3. Verifying connectivity to external services -4. Initializing any external resources +**Host function:** -## Caching +| Function | Parameters | Returns | +|--------------------|------------|---------------| +| `subsonicapi_call` | `uri` | JSON response | -The plugin system implements a compilation cache to improve performance: +**Usage:** -1. Compiled WASM modules are cached in `[CacheFolder]/plugins` -2. This reduces startup time for plugins that have already been compiled -3. The cache has a automatic cleanup mechanism to remove old modules. - - when the cache folder exceeds `Plugins.CacheSize` (default 100MB), - the oldest modules are removed +```go +// The URI must include the 'u' parameter with the username +response, err := SubsonicAPICall("getAlbumList2?type=random&size=10&u=username") +``` -### WASM Loading Optimization +### Config -To improve performance during plugin instance creation, the system implements an optimization that avoids repeated file reads and compilation: +Access plugin configuration values programmatically. Unlike `pdk.GetConfig()` which only retrieves individual values, this service can list all available configuration keys—useful for discovering dynamic configuration (e.g., user-to-token mappings). -1. **Precompilation**: During plugin discovery, WASM files are read and compiled in the background, with both the MD5 hash of the file bytes and compiled modules cached in memory. +> **Note:** This service is always available and does not require a manifest permission. -2. **Optimized Runtime**: After precompilation completes, plugins use an `optimizedRuntime` wrapper that overrides `CompileModule` to detect when the same WASM bytes are being compiled by comparing MD5 hashes. +**Host functions:** -3. **Cache Hit**: When the generated plugin code calls `os.ReadFile()` and `CompileModule()`, the optimization calculates the MD5 hash of the incoming bytes and compares it with the cached hash. If they match, it returns the pre-compiled module directly. +| Function | Parameters | Returns | +|-----------------|------------|-----------------------------| +| `config_get` | `key` | `value, exists` | +| `config_getint` | `key` | `value, exists` | +| `config_keys` | `prefix` | Array of matching key names | -4. **Performance Benefit**: This eliminates repeated compilation while using minimal memory (16 bytes per plugin for the MD5 hash vs potentially MB of WASM bytes), significantly improving plugin instance creation speed while maintaining full compatibility with the generated API code. +**Usage (with generated SDK):** -5. **Memory Efficiency**: By storing only MD5 hashes instead of full WASM bytes, the optimization scales efficiently regardless of plugin size or count. +```go +import "github.com/navidrome/navidrome/plugins/pdk/go/host" -The optimization is transparent to plugin developers and automatically activates when plugins are successfully precompiled. +// Get a string configuration value +value, exists := host.ConfigGet("api_key") +if exists { + // Use the value +} -## Best Practices +// Get an integer configuration value +count, exists := host.ConfigGetInt("max_retries") -1. **Resource Management**: +// List all keys with a prefix (useful for user-specific config) +keys := host.ConfigKeys("user:") +for _, key := range keys { + // key might be "user:john", "user:jane", etc. +} - - The host handles HTTP response cleanup, so no need to close response objects - - Keep plugin instances lightweight as they are created and destroyed frequently +// List all configuration keys +allKeys := host.ConfigKeys("") +``` -2. **Error Handling**: +### Users - - Use the standard error types when appropriate - - Return descriptive error messages for debugging - - Custom errors are supported and will be propagated to the caller +Access user information for the users that the plugin has been granted access to. This is useful for plugins that need to associate data with specific users or display user information. -3. **Performance**: +**Manifest permission:** - - Remember plugins are stateless, so don't rely on local variables for caching. Use the CacheService for caching data. - - Use efficient algorithms that work well in single-call scenarios +```json +{ + "permissions": { + "users": { + "reason": "Display user information in status updates" + } + } +} +``` -4. **Security**: - - Only request permissions you actually need (see [Plugin Permission System](#plugin-permission-system)) - - Validate inputs to prevent injection attacks - - Don't store sensitive credentials in the plugin code - - Use configuration for API keys and sensitive data +**Important:** Before enabling a plugin that requires the `users` permission, an administrator must configure which users the plugin can access. This can be done in two ways: -## Limitations +1. **Allow all users** – Enable the "Allow all users" toggle in the plugin settings +2. **Select specific users** – Choose individual users from the user list -1. WASM plugins have limited access to system resources -2. Plugin compilation has an initial overhead on first load, as it needs to be compiled to WebAssembly - - Subsequent calls are faster due to caching -3. New plugin capabilities types require changes to the core codebase -4. Stateless nature prevents certain optimizations +If neither option is configured, the plugin cannot be enabled. -## Troubleshooting +**Host functions:** -1. **Plugin not detected**: +| Function | Parameters | Returns | +|------------------|------------|-----------------------| +| `users_getusers` | – | Array of User objects | - - Ensure `plugin.wasm` and `manifest.json` exist in the plugin directory - - Check that the manifest contains valid capabilities names - - Verify the manifest schema is valid (see [Plugin Permission System](#plugin-permission-system)) +**User object fields:** -2. **Permission errors**: +| Field | Type | Description | +|------------|---------|--------------------------------| +| `userName` | string | The user's unique username | +| `name` | string | The user's display name | +| `isAdmin` | boolean | Whether the user is an admin | - - **"function not exported in module env"**: Plugin trying to use a service without proper permission - - Check that required permissions are declared in `manifest.json` - - See [Troubleshooting Permissions](#troubleshooting-permissions) for detailed guidance +> **Security:** Sensitive fields like passwords, email addresses, and internal IDs are never exposed to plugins. -3. **Compilation errors**: +**Usage (with generated SDK):** - - Check logs for WASM compilation errors - - Verify the plugin is compatible with the current API version +```go +import "github.com/navidrome/navidrome/plugins/pdk/go/host" -4. **Runtime errors**: - - Look for error messages in the Navidrome logs - - Add debug logging to your plugin - - Check if the error is permission-related before debugging plugin logic +// Get all users the plugin has access to +users, err := host.UsersGetUsers() +if err != nil { + pdk.Log(pdk.LogError, "Failed to get users: " + err.Error()) + return +} + +for _, user := range users { + pdk.Log(pdk.LogInfo, "User: " + user.UserName + " (" + user.Name + ")") + if user.IsAdmin { + pdk.Log(pdk.LogInfo, " - Administrator") + } +} +``` + +**Rust example:** + +```rust +use nd_pdk_host::users::get_users; + +let users = get_users()?; +for user in users { + println!("User: {} ({})", user.user_name, user.name); +} +``` + +**Python example:** + +```python +from host.nd_host_users import users_get_users + +users = users_get_users() +for user in users: + print(f"User: {user['userName']} ({user['name']})") +``` + +--- + +## Configuration + +### Server Configuration + +Enable plugins in `navidrome.toml`: + +```toml +[Plugins] +Enabled = true +Folder = "/path/to/plugins" # Default: DataFolder/plugins +AutoReload = true # Auto-reload on file changes (dev mode) +LogLevel = "debug" # Plugin-specific log level +CacheSize = "200MB" # Compilation cache size limit +``` + +### Plugin Configuration + +Plugin configuration is managed through the Navidrome web UI. Navigate to the Plugins page, select a plugin, and edit its configuration as key-value pairs. + +Access configuration values in your plugin: + +```go +apiKey, ok := pdk.GetConfig("api_key") +if !ok { + pdk.SetErrorString("api_key configuration is required") + return 1 +} +``` + +--- + +## Building Plugins + +### Supported Languages + +Plugins can be written in any language that Extism supports. Each language has its own PDK (Plugin Development Kit) that provides the APIs for I/O, logging, configuration, and HTTP requests. See the [Extism PDK documentation](https://extism.org/docs/concepts/pdk) for details. + +We recommend: + +- **Go** – Best experience with [TinyGo](https://tinygo.org/) and the [Go PDK](https://github.com/extism/go-pdk) +- **Rust** – Excellent performance with the [Rust PDK](https://github.com/extism/rust-pdk) +- **Python** – Experimental support via [extism-py](https://github.com/extism/python-pdk) +- **TypeScript** – Experimental support via [extism-js](https://github.com/extism/js-pdk) + +### Go with TinyGo (Recommended) + +```bash +# Install TinyGo: https://tinygo.org/getting-started/install/ + +# Build WebAssembly module +tinygo build -o plugin.wasm -target wasip1 -buildmode=c-shared . + +# Package as .ndp +zip -j my-plugin.ndp manifest.json plugin.wasm +``` + +#### Using Go PDK Packages + +Navidrome provides type-safe Go packages for each capability in `plugins/pdk/go/`. Instead of manually exporting functions with `//go:wasmexport`, use the `Register()` pattern: + +```go +package main + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/metadata" +) + +type myPlugin struct{} + +func (p *myPlugin) GetArtistBiography(input metadata.ArtistRequest) (*metadata.ArtistBiographyResponse, error) { + return &metadata.ArtistBiographyResponse{Biography: "Biography text..."}, nil +} + +func init() { + metadata.Register(&myPlugin{}) +} + +func main() {} +``` + +Add to your `go.mod`: + +``` +require github.com/navidrome/navidrome v0.0.0 +replace github.com/navidrome/navidrome => ../../.. +``` + +Available capability packages: + +| Package | Import Path | Description | +|-------------|----------------------------|--------------------------------------| +| `metadata` | `plugins/pdk/go/metadata` | Artist/album metadata providers | +| `scrobbler` | `plugins/pdk/go/scrobbler` | Scrobbling services | +| `lifecycle` | `plugins/pdk/go/lifecycle` | Plugin initialization | +| `scheduler` | `plugins/pdk/go/scheduler` | Scheduled task callbacks | +| `websocket` | `plugins/pdk/go/websocket` | WebSocket event handlers | +| `host` | `plugins/pdk/go/host` | Host service SDK (HTTP, cache, etc.) | + +See the example plugins in [examples/](examples/) for complete usage patterns. + +### Rust + +```bash +# Build WebAssembly module +cargo build --release --target wasm32-wasip1 + +# Package as .ndp +zip -j my-plugin.ndp manifest.json target/wasm32-wasip1/release/plugin.wasm +``` + +#### Using Rust PDK + +The Rust PDK provides generated type-safe wrappers for both capabilities and host services: + +```toml +# Cargo.toml +[dependencies] +nd-pdk = { path = "../../pdk/rust/nd-pdk" } +extism-pdk = "1.2" +serde = { version = "1.0", features = ["derive"] } +serde_json = "1.0" +``` + +**Implementing capabilities with traits and macros:** + +```rust +use nd_pdk::scrobbler::{Scrobbler, IsAuthorizedRequest, Error}; +use nd_pdk::register_scrobbler; + +#[derive(Default)] +struct MyPlugin; + +impl Scrobbler for MyPlugin { + fn is_authorized(&self, req: IsAuthorizedRequest) -> Result { + Ok(true) + } + fn now_playing(&self, req: NowPlayingRequest) -> Result<(), Error> { Ok(()) } + fn scrobble(&self, req: ScrobbleRequest) -> Result<(), Error> { Ok(()) } +} + +register_scrobbler!(MyPlugin); // Generates all WASM exports +``` + +**Using host services:** + +```rust +use nd_pdk::host::{cache, scheduler, library}; + +// Cache a value for 1 hour +cache::set_string("my_key", "my_value", 3600)?; + +// Schedule a recurring task +scheduler::schedule_recurring("@every 5m", "payload", "task_id")?; + +// Access library metadata +let libs = library::get_all_libraries()?; +``` + +See [pdk/rust/README.md](pdk/rust/README.md) for detailed documentation and examples. + +### Python (with extism-py) + +```bash +# Build WebAssembly module (requires extism-py installed) +extism-py plugin.wasm -o plugin.wasm *.py + +# Package as .ndp +zip -j my-plugin.ndp manifest.json plugin.wasm +``` + +### Using XTP CLI (Scaffolding) + +Bootstrap a new plugin from a schema: + +```bash +# Install XTP CLI: https://docs.xtp.dylibso.com/docs/cli + +# Create a metadata agent plugin +xtp plugin init \ + --schema-file plugins/capabilities/metadata_agent.yaml \ + --template go \ + --path ./my-agent \ + --name my-agent + +# Build and package +cd my-agent && xtp plugin build +zip -j my-agent.ndp manifest.json dist/plugin.wasm +``` + +See [capabilities/README.md](capabilities/README.md) for available schemas and scaffolding examples. + +### Using Host Service SDKs + +Generated SDKs for calling host services are in `plugins/pdk/go/`, `plugins/pdk/python/` and `plugins/pdk/rust`. + +**For Go plugins:** Import the SDK as a Go module: + +```go +import "github.com/navidrome/navidrome/plugins/pdk/go/host" +``` + +Add to your `go.mod`: + +``` +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go +``` + +See [pdk/go/README.md](pdk/go/README.md) for detailed documentation. + +**For Python plugins:** Copy functions from `nd_host_*.py` into your `__init__.py` (see comments in those files for extism-py limitations). + +**Recommendations:** + +- **Go:** Best overall experience with excellent stdlib support and familiar syntax for most developers. Recommended if you're already in the Go ecosystem. +- **Rust:** Best for performance-critical plugins or when leveraging Rust's ecosystem. Produces smallest binaries with excellent type safety. +- **Python:** Best for rapid prototyping or simple plugins. Note that extism-py has limitations compared to compiled languages. + +--- + +## Examples + +See [examples/](examples/) for complete working plugins: + +| Plugin | Language | Capabilities | Host Services | Description | +|----------------------------------------------------------------|----------|---------------|--------------------------------------------|--------------------------------| +| [minimal](examples/minimal/) | Go | MetadataAgent | – | Basic structure example | +| [wikimedia](examples/wikimedia/) | Go | MetadataAgent | HTTP | Wikidata/Wikipedia integration | +| [coverartarchive-py](examples/coverartarchive-py/) | Python | MetadataAgent | HTTP | Cover Art Archive | +| [webhook-rs](examples/webhook-rs/) | Rust | Scrobbler | HTTP | HTTP webhooks | +| [nowplaying-py](examples/nowplaying-py/) | Python | Lifecycle | Scheduler, SubsonicAPI | Periodic now-playing logger | +| [library-inspector](examples/library-inspector-rs/) | Rust | Lifecycle | Library, Scheduler | Periodic library stats logging | +| [crypto-ticker](examples/crypto-ticker/) | Go | Lifecycle | WebSocket, Scheduler | Real-time crypto prices demo | +| [discord-rich-presence-rs](examples/discord-rich-presence-rs/) | Rust | Scrobbler | HTTP, WebSocket, Cache, Scheduler, Artwork | Discord integration (Rust) | + +--- + + +## Security + +Plugins run in a secure WebAssembly sandbox provided by [Extism](https://extism.org/) and the [Wazero](https://wazero.io/) runtime: + +1. **Host Allowlisting** – Only explicitly allowed hosts are accessible via HTTP/WebSocket +2. **Limited File System** – Plugins can only access library directories when explicitly granted the `library.filesystem` permission, and access is read-only +3. **No Network Listeners** – Plugins cannot bind ports +4. **Config Isolation** – Plugins only receive their own config section +5. **Memory Limits** – Controlled by the WebAssembly runtime +6. **User-Scoped Authorization** – Plugins with `subsonicapi` or `scrobbler` capabilities can only access/receive events for users assigned to them through Navidrome's configuration. The `users` permission is required for these features. +7. **Users Permission** – Plugins requesting user access must be explicitly configured with allowed users; sensitive data (passwords, emails) is never exposed + + +--- + +## Runtime Management + +### Auto-Reload + +With `AutoReload = true`, Navidrome watches the plugins folder and automatically detects when `.ndp` files are added, modified, or removed. When a plugin file changes, the plugin is disabled and its metadata is re-read from the archive. + +If the `AutoReload` setting is disabled, Navidrome needs to be restarted to pick up plugin changes. + +### Enabling/Disabling Plugins + +Plugins can be enabled/disabled via the Navidrome UI. The plugin state is persisted in the database. + +### Important Notes + +- **In-flight requests** – When reloading, existing requests complete before the new version takes over +- **Config changes** – Changes to the plugin configuration in the UI are applied immediately +- **Cache persistence** – The in-memory cache is cleared when a plugin is unloaded diff --git a/plugins/adapter_media_agent.go b/plugins/adapter_media_agent.go deleted file mode 100644 index eca891275..000000000 --- a/plugins/adapter_media_agent.go +++ /dev/null @@ -1,166 +0,0 @@ -package plugins - -import ( - "context" - - "github.com/navidrome/navidrome/core/agents" - "github.com/navidrome/navidrome/log" - "github.com/navidrome/navidrome/plugins/api" - "github.com/tetratelabs/wazero" -) - -// NewWasmMediaAgent creates a new adapter for a MetadataAgent plugin -func newWasmMediaAgent(wasmPath, pluginID string, m *managerImpl, runtime api.WazeroNewRuntime, mc wazero.ModuleConfig) WasmPlugin { - loader, err := api.NewMetadataAgentPlugin(context.Background(), api.WazeroRuntime(runtime), api.WazeroModuleConfig(mc)) - if err != nil { - log.Error("Error creating media metadata service plugin", "plugin", pluginID, "path", wasmPath, err) - return nil - } - return &wasmMediaAgent{ - baseCapability: newBaseCapability[api.MetadataAgent, *api.MetadataAgentPlugin]( - wasmPath, - pluginID, - CapabilityMetadataAgent, - m.metrics, - loader, - func(ctx context.Context, l *api.MetadataAgentPlugin, path string) (api.MetadataAgent, error) { - return l.Load(ctx, path) - }, - ), - } -} - -// wasmMediaAgent adapts a MetadataAgent plugin to implement the agents.Interface -type wasmMediaAgent struct { - *baseCapability[api.MetadataAgent, *api.MetadataAgentPlugin] -} - -func (w *wasmMediaAgent) AgentName() string { - return w.id -} - -func (w *wasmMediaAgent) mapError(err error) error { - if err != nil && (err.Error() == api.ErrNotFound.Error() || err.Error() == api.ErrNotImplemented.Error()) { - return agents.ErrNotFound - } - return err -} - -// Album-related methods - -func (w *wasmMediaAgent) GetAlbumInfo(ctx context.Context, name, artist, mbid string) (*agents.AlbumInfo, error) { - res, err := callMethod(ctx, w, "GetAlbumInfo", func(inst api.MetadataAgent) (*api.AlbumInfoResponse, error) { - return inst.GetAlbumInfo(ctx, &api.AlbumInfoRequest{Name: name, Artist: artist, Mbid: mbid}) - }) - if err != nil { - return nil, w.mapError(err) - } - if res == nil || res.Info == nil { - return nil, agents.ErrNotFound - } - info := res.Info - return &agents.AlbumInfo{ - Name: info.Name, - MBID: info.Mbid, - Description: info.Description, - URL: info.Url, - }, nil -} - -func (w *wasmMediaAgent) GetAlbumImages(ctx context.Context, name, artist, mbid string) ([]agents.ExternalImage, error) { - res, err := callMethod(ctx, w, "GetAlbumImages", func(inst api.MetadataAgent) (*api.AlbumImagesResponse, error) { - return inst.GetAlbumImages(ctx, &api.AlbumImagesRequest{Name: name, Artist: artist, Mbid: mbid}) - }) - if err != nil { - return nil, w.mapError(err) - } - return convertExternalImages(res.Images), nil -} - -// Artist-related methods - -func (w *wasmMediaAgent) GetArtistMBID(ctx context.Context, id string, name string) (string, error) { - res, err := callMethod(ctx, w, "GetArtistMBID", func(inst api.MetadataAgent) (*api.ArtistMBIDResponse, error) { - return inst.GetArtistMBID(ctx, &api.ArtistMBIDRequest{Id: id, Name: name}) - }) - if err != nil { - return "", w.mapError(err) - } - return res.GetMbid(), nil -} - -func (w *wasmMediaAgent) GetArtistURL(ctx context.Context, id, name, mbid string) (string, error) { - res, err := callMethod(ctx, w, "GetArtistURL", func(inst api.MetadataAgent) (*api.ArtistURLResponse, error) { - return inst.GetArtistURL(ctx, &api.ArtistURLRequest{Id: id, Name: name, Mbid: mbid}) - }) - if err != nil { - return "", w.mapError(err) - } - return res.GetUrl(), nil -} - -func (w *wasmMediaAgent) GetArtistBiography(ctx context.Context, id, name, mbid string) (string, error) { - res, err := callMethod(ctx, w, "GetArtistBiography", func(inst api.MetadataAgent) (*api.ArtistBiographyResponse, error) { - return inst.GetArtistBiography(ctx, &api.ArtistBiographyRequest{Id: id, Name: name, Mbid: mbid}) - }) - if err != nil { - return "", w.mapError(err) - } - return res.GetBiography(), nil -} - -func (w *wasmMediaAgent) GetSimilarArtists(ctx context.Context, id, name, mbid string, limit int) ([]agents.Artist, error) { - resp, err := callMethod(ctx, w, "GetSimilarArtists", func(inst api.MetadataAgent) (*api.ArtistSimilarResponse, error) { - return inst.GetSimilarArtists(ctx, &api.ArtistSimilarRequest{Id: id, Name: name, Mbid: mbid, Limit: int32(limit)}) - }) - if err != nil { - return nil, w.mapError(err) - } - artists := make([]agents.Artist, 0, len(resp.GetArtists())) - for _, a := range resp.GetArtists() { - artists = append(artists, agents.Artist{ - Name: a.GetName(), - MBID: a.GetMbid(), - }) - } - return artists, nil -} - -func (w *wasmMediaAgent) GetArtistImages(ctx context.Context, id, name, mbid string) ([]agents.ExternalImage, error) { - resp, err := callMethod(ctx, w, "GetArtistImages", func(inst api.MetadataAgent) (*api.ArtistImageResponse, error) { - return inst.GetArtistImages(ctx, &api.ArtistImageRequest{Id: id, Name: name, Mbid: mbid}) - }) - if err != nil { - return nil, w.mapError(err) - } - return convertExternalImages(resp.Images), nil -} - -func (w *wasmMediaAgent) GetArtistTopSongs(ctx context.Context, id, artistName, mbid string, count int) ([]agents.Song, error) { - resp, err := callMethod(ctx, w, "GetArtistTopSongs", func(inst api.MetadataAgent) (*api.ArtistTopSongsResponse, error) { - return inst.GetArtistTopSongs(ctx, &api.ArtistTopSongsRequest{Id: id, ArtistName: artistName, Mbid: mbid, Count: int32(count)}) - }) - if err != nil { - return nil, w.mapError(err) - } - songs := make([]agents.Song, 0, len(resp.GetSongs())) - for _, s := range resp.GetSongs() { - songs = append(songs, agents.Song{ - Name: s.GetName(), - MBID: s.GetMbid(), - }) - } - return songs, nil -} - -// Helper function to convert ExternalImage objects from the API to the agents package -func convertExternalImages(images []*api.ExternalImage) []agents.ExternalImage { - result := make([]agents.ExternalImage, 0, len(images)) - for _, img := range images { - result = append(result, agents.ExternalImage{ - URL: img.GetUrl(), - Size: int(img.GetSize()), - }) - } - return result -} diff --git a/plugins/adapter_media_agent_test.go b/plugins/adapter_media_agent_test.go deleted file mode 100644 index 70b5d275a..000000000 --- a/plugins/adapter_media_agent_test.go +++ /dev/null @@ -1,227 +0,0 @@ -package plugins - -import ( - "context" - "errors" - - "github.com/navidrome/navidrome/conf" - "github.com/navidrome/navidrome/conf/configtest" - "github.com/navidrome/navidrome/core/agents" - "github.com/navidrome/navidrome/core/metrics" - "github.com/navidrome/navidrome/plugins/api" - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" -) - -var _ = Describe("Adapter Media Agent", func() { - var ctx context.Context - var mgr *managerImpl - - BeforeEach(func() { - ctx = GinkgoT().Context() - - // Ensure plugins folder is set to testdata - DeferCleanup(configtest.SetupConfig()) - conf.Server.Plugins.Folder = testDataDir - - mgr = createManager(nil, metrics.NewNoopInstance()) - mgr.ScanPlugins() - - // Wait for all plugins to compile to avoid race conditions - err := mgr.EnsureCompiled("multi_plugin") - Expect(err).NotTo(HaveOccurred(), "multi_plugin should compile successfully") - err = mgr.EnsureCompiled("fake_album_agent") - Expect(err).NotTo(HaveOccurred(), "fake_album_agent should compile successfully") - }) - - Describe("AgentName and PluginName", func() { - It("should return the plugin name", func() { - agent := mgr.LoadPlugin("multi_plugin", "MetadataAgent") - Expect(agent).NotTo(BeNil(), "multi_plugin should be loaded") - Expect(agent.PluginID()).To(Equal("multi_plugin")) - }) - It("should return the agent name", func() { - agent, ok := mgr.LoadMediaAgent("multi_plugin") - Expect(ok).To(BeTrue(), "multi_plugin should be loaded as media agent") - Expect(agent.AgentName()).To(Equal("multi_plugin")) - }) - }) - - Describe("Album methods", func() { - var agent *wasmMediaAgent - - BeforeEach(func() { - a, ok := mgr.LoadMediaAgent("fake_album_agent") - Expect(ok).To(BeTrue(), "fake_album_agent should be loaded") - agent = a.(*wasmMediaAgent) - }) - - Context("GetAlbumInfo", func() { - It("should return album information", func() { - info, err := agent.GetAlbumInfo(ctx, "Test Album", "Test Artist", "mbid") - - Expect(err).NotTo(HaveOccurred()) - Expect(info).NotTo(BeNil()) - Expect(info.Name).To(Equal("Test Album")) - Expect(info.MBID).To(Equal("album-mbid-123")) - Expect(info.Description).To(Equal("This is a test album description")) - Expect(info.URL).To(Equal("https://example.com/album")) - }) - - It("should return ErrNotFound when plugin returns not found", func() { - _, err := agent.GetAlbumInfo(ctx, "Test Album", "", "mbid") - - Expect(err).To(Equal(agents.ErrNotFound)) - }) - - It("should return ErrNotFound when plugin returns nil response", func() { - _, err := agent.GetAlbumInfo(ctx, "", "", "") - - Expect(err).To(Equal(agents.ErrNotFound)) - }) - }) - - Context("GetAlbumImages", func() { - It("should return album images", func() { - images, err := agent.GetAlbumImages(ctx, "Test Album", "Test Artist", "mbid") - - Expect(err).NotTo(HaveOccurred()) - Expect(images).To(Equal([]agents.ExternalImage{ - {URL: "https://example.com/album1.jpg", Size: 300}, - {URL: "https://example.com/album2.jpg", Size: 400}, - })) - }) - }) - }) - - Describe("Artist methods", func() { - var agent *wasmMediaAgent - - BeforeEach(func() { - a, ok := mgr.LoadMediaAgent("fake_artist_agent") - Expect(ok).To(BeTrue(), "fake_artist_agent should be loaded") - agent = a.(*wasmMediaAgent) - }) - - Context("GetArtistMBID", func() { - It("should return artist MBID", func() { - mbid, err := agent.GetArtistMBID(ctx, "artist-id", "Test Artist") - - Expect(err).NotTo(HaveOccurred()) - Expect(mbid).To(Equal("1234567890")) - }) - - It("should return ErrNotFound when plugin returns not found", func() { - _, err := agent.GetArtistMBID(ctx, "artist-id", "") - - Expect(err).To(Equal(agents.ErrNotFound)) - }) - }) - - Context("GetArtistURL", func() { - It("should return artist URL", func() { - url, err := agent.GetArtistURL(ctx, "artist-id", "Test Artist", "mbid") - - Expect(err).NotTo(HaveOccurred()) - Expect(url).To(Equal("https://example.com")) - }) - }) - - Context("GetArtistBiography", func() { - It("should return artist biography", func() { - bio, err := agent.GetArtistBiography(ctx, "artist-id", "Test Artist", "mbid") - - Expect(err).NotTo(HaveOccurred()) - Expect(bio).To(Equal("This is a test biography")) - }) - }) - - Context("GetSimilarArtists", func() { - It("should return similar artists", func() { - artists, err := agent.GetSimilarArtists(ctx, "artist-id", "Test Artist", "mbid", 10) - - Expect(err).NotTo(HaveOccurred()) - Expect(artists).To(Equal([]agents.Artist{ - {Name: "Similar Artist 1", MBID: "mbid1"}, - {Name: "Similar Artist 2", MBID: "mbid2"}, - })) - }) - }) - - Context("GetArtistImages", func() { - It("should return artist images", func() { - images, err := agent.GetArtistImages(ctx, "artist-id", "Test Artist", "mbid") - - Expect(err).NotTo(HaveOccurred()) - Expect(images).To(Equal([]agents.ExternalImage{ - {URL: "https://example.com/image1.jpg", Size: 100}, - {URL: "https://example.com/image2.jpg", Size: 200}, - })) - }) - }) - - Context("GetArtistTopSongs", func() { - It("should return artist top songs", func() { - songs, err := agent.GetArtistTopSongs(ctx, "artist-id", "Test Artist", "mbid", 10) - - Expect(err).NotTo(HaveOccurred()) - Expect(songs).To(Equal([]agents.Song{ - {Name: "Song 1", MBID: "mbid1"}, - {Name: "Song 2", MBID: "mbid2"}, - })) - }) - }) - }) - - Describe("Helper functions", func() { - It("convertExternalImages should convert API image objects to agent image objects", func() { - apiImages := []*api.ExternalImage{ - {Url: "https://example.com/image1.jpg", Size: 100}, - {Url: "https://example.com/image2.jpg", Size: 200}, - } - - agentImages := convertExternalImages(apiImages) - Expect(agentImages).To(HaveLen(2)) - - for i, img := range agentImages { - Expect(img.URL).To(Equal(apiImages[i].Url)) - Expect(img.Size).To(Equal(int(apiImages[i].Size))) - } - }) - - It("convertExternalImages should handle empty slice", func() { - agentImages := convertExternalImages([]*api.ExternalImage{}) - Expect(agentImages).To(BeEmpty()) - }) - - It("convertExternalImages should handle nil", func() { - agentImages := convertExternalImages(nil) - Expect(agentImages).To(BeEmpty()) - }) - }) - - Describe("Error mapping", func() { - var agent wasmMediaAgent - - It("should map API ErrNotFound to agents.ErrNotFound", func() { - err := agent.mapError(api.ErrNotFound) - Expect(err).To(Equal(agents.ErrNotFound)) - }) - - It("should map API ErrNotImplemented to agents.ErrNotFound", func() { - err := agent.mapError(api.ErrNotImplemented) - Expect(err).To(Equal(agents.ErrNotFound)) - }) - - It("should pass through other errors", func() { - testErr := errors.New("test error") - err := agent.mapError(testErr) - Expect(err).To(Equal(testErr)) - }) - - It("should handle nil error", func() { - err := agent.mapError(nil) - Expect(err).To(BeNil()) - }) - }) -}) diff --git a/plugins/adapter_scheduler_callback.go b/plugins/adapter_scheduler_callback.go deleted file mode 100644 index 64b7eefff..000000000 --- a/plugins/adapter_scheduler_callback.go +++ /dev/null @@ -1,46 +0,0 @@ -package plugins - -import ( - "context" - - "github.com/navidrome/navidrome/log" - "github.com/navidrome/navidrome/plugins/api" - "github.com/tetratelabs/wazero" -) - -// newWasmSchedulerCallback creates a new adapter for a SchedulerCallback plugin -func newWasmSchedulerCallback(wasmPath, pluginID string, m *managerImpl, runtime api.WazeroNewRuntime, mc wazero.ModuleConfig) WasmPlugin { - loader, err := api.NewSchedulerCallbackPlugin(context.Background(), api.WazeroRuntime(runtime), api.WazeroModuleConfig(mc)) - if err != nil { - log.Error("Error creating scheduler callback plugin", "plugin", pluginID, "path", wasmPath, err) - return nil - } - return &wasmSchedulerCallback{ - baseCapability: newBaseCapability[api.SchedulerCallback, *api.SchedulerCallbackPlugin]( - wasmPath, - pluginID, - CapabilitySchedulerCallback, - m.metrics, - loader, - func(ctx context.Context, l *api.SchedulerCallbackPlugin, path string) (api.SchedulerCallback, error) { - return l.Load(ctx, path) - }, - ), - } -} - -// wasmSchedulerCallback adapts a SchedulerCallback plugin -type wasmSchedulerCallback struct { - *baseCapability[api.SchedulerCallback, *api.SchedulerCallbackPlugin] -} - -func (w *wasmSchedulerCallback) OnSchedulerCallback(ctx context.Context, scheduleID string, payload []byte, isRecurring bool) error { - _, err := callMethod(ctx, w, "OnSchedulerCallback", func(inst api.SchedulerCallback) (*api.SchedulerCallbackResponse, error) { - return inst.OnSchedulerCallback(ctx, &api.SchedulerCallbackRequest{ - ScheduleId: scheduleID, - Payload: payload, - IsRecurring: isRecurring, - }) - }) - return err -} diff --git a/plugins/adapter_scrobbler.go b/plugins/adapter_scrobbler.go deleted file mode 100644 index 54c6af127..000000000 --- a/plugins/adapter_scrobbler.go +++ /dev/null @@ -1,136 +0,0 @@ -package plugins - -import ( - "context" - "time" - - "github.com/navidrome/navidrome/core/scrobbler" - "github.com/navidrome/navidrome/log" - "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/model/request" - "github.com/navidrome/navidrome/plugins/api" - "github.com/tetratelabs/wazero" -) - -func newWasmScrobblerPlugin(wasmPath, pluginID string, m *managerImpl, runtime api.WazeroNewRuntime, mc wazero.ModuleConfig) WasmPlugin { - loader, err := api.NewScrobblerPlugin(context.Background(), api.WazeroRuntime(runtime), api.WazeroModuleConfig(mc)) - if err != nil { - log.Error("Error creating scrobbler service plugin", "plugin", pluginID, "path", wasmPath, err) - return nil - } - return &wasmScrobblerPlugin{ - baseCapability: newBaseCapability[api.Scrobbler, *api.ScrobblerPlugin]( - wasmPath, - pluginID, - CapabilityScrobbler, - m.metrics, - loader, - func(ctx context.Context, l *api.ScrobblerPlugin, path string) (api.Scrobbler, error) { - return l.Load(ctx, path) - }, - ), - } -} - -type wasmScrobblerPlugin struct { - *baseCapability[api.Scrobbler, *api.ScrobblerPlugin] -} - -func (w *wasmScrobblerPlugin) IsAuthorized(ctx context.Context, userId string) bool { - username, _ := request.UsernameFrom(ctx) - if username == "" { - u, ok := request.UserFrom(ctx) - if ok { - username = u.UserName - } - } - resp, err := callMethod(ctx, w, "IsAuthorized", func(inst api.Scrobbler) (*api.ScrobblerIsAuthorizedResponse, error) { - return inst.IsAuthorized(ctx, &api.ScrobblerIsAuthorizedRequest{ - UserId: userId, - Username: username, - }) - }) - if err != nil { - log.Warn("Error calling IsAuthorized", "userId", userId, "pluginID", w.id, err) - } - return err == nil && resp.Authorized -} - -func (w *wasmScrobblerPlugin) NowPlaying(ctx context.Context, userId string, track *model.MediaFile, position int) error { - username, _ := request.UsernameFrom(ctx) - if username == "" { - u, ok := request.UserFrom(ctx) - if ok { - username = u.UserName - } - } - - trackInfo := w.toTrackInfo(track, position) - _, err := callMethod(ctx, w, "NowPlaying", func(inst api.Scrobbler) (struct{}, error) { - resp, err := inst.NowPlaying(ctx, &api.ScrobblerNowPlayingRequest{ - UserId: userId, - Username: username, - Track: trackInfo, - Timestamp: time.Now().Unix(), - }) - if err != nil { - return struct{}{}, err - } - if resp.Error != "" { - return struct{}{}, nil - } - return struct{}{}, nil - }) - return err -} - -func (w *wasmScrobblerPlugin) Scrobble(ctx context.Context, userId string, s scrobbler.Scrobble) error { - username, _ := request.UsernameFrom(ctx) - if username == "" { - u, ok := request.UserFrom(ctx) - if ok { - username = u.UserName - } - } - trackInfo := w.toTrackInfo(&s.MediaFile, 0) - _, err := callMethod(ctx, w, "Scrobble", func(inst api.Scrobbler) (struct{}, error) { - resp, err := inst.Scrobble(ctx, &api.ScrobblerScrobbleRequest{ - UserId: userId, - Username: username, - Track: trackInfo, - Timestamp: s.TimeStamp.Unix(), - }) - if err != nil { - return struct{}{}, err - } - if resp.Error != "" { - return struct{}{}, nil - } - return struct{}{}, nil - }) - return err -} - -func (w *wasmScrobblerPlugin) toTrackInfo(track *model.MediaFile, position int) *api.TrackInfo { - artists := make([]*api.Artist, 0, len(track.Participants[model.RoleArtist])) - - for _, a := range track.Participants[model.RoleArtist] { - artists = append(artists, &api.Artist{Name: a.Name, Mbid: a.MbzArtistID}) - } - albumArtists := make([]*api.Artist, 0, len(track.Participants[model.RoleAlbumArtist])) - for _, a := range track.Participants[model.RoleAlbumArtist] { - albumArtists = append(albumArtists, &api.Artist{Name: a.Name, Mbid: a.MbzArtistID}) - } - trackInfo := &api.TrackInfo{ - Id: track.ID, - Mbid: track.MbzRecordingID, - Name: track.Title, - Album: track.Album, - AlbumMbid: track.MbzAlbumID, - Artists: artists, - AlbumArtists: albumArtists, - Length: int32(track.Duration), - Position: int32(position), - } - return trackInfo -} diff --git a/plugins/adapter_websocket_callback.go b/plugins/adapter_websocket_callback.go deleted file mode 100644 index 83b8dd567..000000000 --- a/plugins/adapter_websocket_callback.go +++ /dev/null @@ -1,35 +0,0 @@ -package plugins - -import ( - "context" - - "github.com/navidrome/navidrome/log" - "github.com/navidrome/navidrome/plugins/api" - "github.com/tetratelabs/wazero" -) - -// newWasmWebSocketCallback creates a new adapter for a WebSocketCallback plugin -func newWasmWebSocketCallback(wasmPath, pluginID string, m *managerImpl, runtime api.WazeroNewRuntime, mc wazero.ModuleConfig) WasmPlugin { - loader, err := api.NewWebSocketCallbackPlugin(context.Background(), api.WazeroRuntime(runtime), api.WazeroModuleConfig(mc)) - if err != nil { - log.Error("Error creating WebSocket callback plugin", "plugin", pluginID, "path", wasmPath, err) - return nil - } - return &wasmWebSocketCallback{ - baseCapability: newBaseCapability[api.WebSocketCallback, *api.WebSocketCallbackPlugin]( - wasmPath, - pluginID, - CapabilityWebSocketCallback, - m.metrics, - loader, - func(ctx context.Context, l *api.WebSocketCallbackPlugin, path string) (api.WebSocketCallback, error) { - return l.Load(ctx, path) - }, - ), - } -} - -// wasmWebSocketCallback adapts a WebSocketCallback plugin -type wasmWebSocketCallback struct { - *baseCapability[api.WebSocketCallback, *api.WebSocketCallbackPlugin] -} diff --git a/plugins/api/api.pb.go b/plugins/api/api.pb.go deleted file mode 100644 index b570d5c61..000000000 --- a/plugins/api/api.pb.go +++ /dev/null @@ -1,1136 +0,0 @@ -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: api/api.proto - -package api - -import ( - context "context" - protoreflect "google.golang.org/protobuf/reflect/protoreflect" - protoimpl "google.golang.org/protobuf/runtime/protoimpl" -) - -const ( - // Verify that this generated code is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion) - // Verify that runtime/protoimpl is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) -) - -type ArtistMBIDRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` - Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` -} - -func (x *ArtistMBIDRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *ArtistMBIDRequest) GetId() string { - if x != nil { - return x.Id - } - return "" -} - -func (x *ArtistMBIDRequest) GetName() string { - if x != nil { - return x.Name - } - return "" -} - -type ArtistMBIDResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Mbid string `protobuf:"bytes,1,opt,name=mbid,proto3" json:"mbid,omitempty"` -} - -func (x *ArtistMBIDResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *ArtistMBIDResponse) GetMbid() string { - if x != nil { - return x.Mbid - } - return "" -} - -type ArtistURLRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` - Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` - Mbid string `protobuf:"bytes,3,opt,name=mbid,proto3" json:"mbid,omitempty"` -} - -func (x *ArtistURLRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *ArtistURLRequest) GetId() string { - if x != nil { - return x.Id - } - return "" -} - -func (x *ArtistURLRequest) GetName() string { - if x != nil { - return x.Name - } - return "" -} - -func (x *ArtistURLRequest) GetMbid() string { - if x != nil { - return x.Mbid - } - return "" -} - -type ArtistURLResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"` -} - -func (x *ArtistURLResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *ArtistURLResponse) GetUrl() string { - if x != nil { - return x.Url - } - return "" -} - -type ArtistBiographyRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` - Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` - Mbid string `protobuf:"bytes,3,opt,name=mbid,proto3" json:"mbid,omitempty"` -} - -func (x *ArtistBiographyRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *ArtistBiographyRequest) GetId() string { - if x != nil { - return x.Id - } - return "" -} - -func (x *ArtistBiographyRequest) GetName() string { - if x != nil { - return x.Name - } - return "" -} - -func (x *ArtistBiographyRequest) GetMbid() string { - if x != nil { - return x.Mbid - } - return "" -} - -type ArtistBiographyResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Biography string `protobuf:"bytes,1,opt,name=biography,proto3" json:"biography,omitempty"` -} - -func (x *ArtistBiographyResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *ArtistBiographyResponse) GetBiography() string { - if x != nil { - return x.Biography - } - return "" -} - -type ArtistSimilarRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` - Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` - Mbid string `protobuf:"bytes,3,opt,name=mbid,proto3" json:"mbid,omitempty"` - Limit int32 `protobuf:"varint,4,opt,name=limit,proto3" json:"limit,omitempty"` -} - -func (x *ArtistSimilarRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *ArtistSimilarRequest) GetId() string { - if x != nil { - return x.Id - } - return "" -} - -func (x *ArtistSimilarRequest) GetName() string { - if x != nil { - return x.Name - } - return "" -} - -func (x *ArtistSimilarRequest) GetMbid() string { - if x != nil { - return x.Mbid - } - return "" -} - -func (x *ArtistSimilarRequest) GetLimit() int32 { - if x != nil { - return x.Limit - } - return 0 -} - -type Artist struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` - Mbid string `protobuf:"bytes,2,opt,name=mbid,proto3" json:"mbid,omitempty"` -} - -func (x *Artist) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *Artist) GetName() string { - if x != nil { - return x.Name - } - return "" -} - -func (x *Artist) GetMbid() string { - if x != nil { - return x.Mbid - } - return "" -} - -type ArtistSimilarResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Artists []*Artist `protobuf:"bytes,1,rep,name=artists,proto3" json:"artists,omitempty"` -} - -func (x *ArtistSimilarResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *ArtistSimilarResponse) GetArtists() []*Artist { - if x != nil { - return x.Artists - } - return nil -} - -type ArtistImageRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` - Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` - Mbid string `protobuf:"bytes,3,opt,name=mbid,proto3" json:"mbid,omitempty"` -} - -func (x *ArtistImageRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *ArtistImageRequest) GetId() string { - if x != nil { - return x.Id - } - return "" -} - -func (x *ArtistImageRequest) GetName() string { - if x != nil { - return x.Name - } - return "" -} - -func (x *ArtistImageRequest) GetMbid() string { - if x != nil { - return x.Mbid - } - return "" -} - -type ExternalImage struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"` - Size int32 `protobuf:"varint,2,opt,name=size,proto3" json:"size,omitempty"` -} - -func (x *ExternalImage) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *ExternalImage) GetUrl() string { - if x != nil { - return x.Url - } - return "" -} - -func (x *ExternalImage) GetSize() int32 { - if x != nil { - return x.Size - } - return 0 -} - -type ArtistImageResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Images []*ExternalImage `protobuf:"bytes,1,rep,name=images,proto3" json:"images,omitempty"` -} - -func (x *ArtistImageResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *ArtistImageResponse) GetImages() []*ExternalImage { - if x != nil { - return x.Images - } - return nil -} - -type ArtistTopSongsRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` - ArtistName string `protobuf:"bytes,2,opt,name=artistName,proto3" json:"artistName,omitempty"` - Mbid string `protobuf:"bytes,3,opt,name=mbid,proto3" json:"mbid,omitempty"` - Count int32 `protobuf:"varint,4,opt,name=count,proto3" json:"count,omitempty"` -} - -func (x *ArtistTopSongsRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *ArtistTopSongsRequest) GetId() string { - if x != nil { - return x.Id - } - return "" -} - -func (x *ArtistTopSongsRequest) GetArtistName() string { - if x != nil { - return x.ArtistName - } - return "" -} - -func (x *ArtistTopSongsRequest) GetMbid() string { - if x != nil { - return x.Mbid - } - return "" -} - -func (x *ArtistTopSongsRequest) GetCount() int32 { - if x != nil { - return x.Count - } - return 0 -} - -type Song struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` - Mbid string `protobuf:"bytes,2,opt,name=mbid,proto3" json:"mbid,omitempty"` -} - -func (x *Song) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *Song) GetName() string { - if x != nil { - return x.Name - } - return "" -} - -func (x *Song) GetMbid() string { - if x != nil { - return x.Mbid - } - return "" -} - -type ArtistTopSongsResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Songs []*Song `protobuf:"bytes,1,rep,name=songs,proto3" json:"songs,omitempty"` -} - -func (x *ArtistTopSongsResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *ArtistTopSongsResponse) GetSongs() []*Song { - if x != nil { - return x.Songs - } - return nil -} - -type AlbumInfoRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` - Artist string `protobuf:"bytes,2,opt,name=artist,proto3" json:"artist,omitempty"` - Mbid string `protobuf:"bytes,3,opt,name=mbid,proto3" json:"mbid,omitempty"` -} - -func (x *AlbumInfoRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *AlbumInfoRequest) GetName() string { - if x != nil { - return x.Name - } - return "" -} - -func (x *AlbumInfoRequest) GetArtist() string { - if x != nil { - return x.Artist - } - return "" -} - -func (x *AlbumInfoRequest) GetMbid() string { - if x != nil { - return x.Mbid - } - return "" -} - -type AlbumInfo struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` - Mbid string `protobuf:"bytes,2,opt,name=mbid,proto3" json:"mbid,omitempty"` - Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"` - Url string `protobuf:"bytes,4,opt,name=url,proto3" json:"url,omitempty"` -} - -func (x *AlbumInfo) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *AlbumInfo) GetName() string { - if x != nil { - return x.Name - } - return "" -} - -func (x *AlbumInfo) GetMbid() string { - if x != nil { - return x.Mbid - } - return "" -} - -func (x *AlbumInfo) GetDescription() string { - if x != nil { - return x.Description - } - return "" -} - -func (x *AlbumInfo) GetUrl() string { - if x != nil { - return x.Url - } - return "" -} - -type AlbumInfoResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Info *AlbumInfo `protobuf:"bytes,1,opt,name=info,proto3" json:"info,omitempty"` -} - -func (x *AlbumInfoResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *AlbumInfoResponse) GetInfo() *AlbumInfo { - if x != nil { - return x.Info - } - return nil -} - -type AlbumImagesRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` - Artist string `protobuf:"bytes,2,opt,name=artist,proto3" json:"artist,omitempty"` - Mbid string `protobuf:"bytes,3,opt,name=mbid,proto3" json:"mbid,omitempty"` -} - -func (x *AlbumImagesRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *AlbumImagesRequest) GetName() string { - if x != nil { - return x.Name - } - return "" -} - -func (x *AlbumImagesRequest) GetArtist() string { - if x != nil { - return x.Artist - } - return "" -} - -func (x *AlbumImagesRequest) GetMbid() string { - if x != nil { - return x.Mbid - } - return "" -} - -type AlbumImagesResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Images []*ExternalImage `protobuf:"bytes,1,rep,name=images,proto3" json:"images,omitempty"` -} - -func (x *AlbumImagesResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *AlbumImagesResponse) GetImages() []*ExternalImage { - if x != nil { - return x.Images - } - return nil -} - -type ScrobblerIsAuthorizedRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"` - Username string `protobuf:"bytes,2,opt,name=username,proto3" json:"username,omitempty"` -} - -func (x *ScrobblerIsAuthorizedRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *ScrobblerIsAuthorizedRequest) GetUserId() string { - if x != nil { - return x.UserId - } - return "" -} - -func (x *ScrobblerIsAuthorizedRequest) GetUsername() string { - if x != nil { - return x.Username - } - return "" -} - -type ScrobblerIsAuthorizedResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Authorized bool `protobuf:"varint,1,opt,name=authorized,proto3" json:"authorized,omitempty"` - Error string `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"` -} - -func (x *ScrobblerIsAuthorizedResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *ScrobblerIsAuthorizedResponse) GetAuthorized() bool { - if x != nil { - return x.Authorized - } - return false -} - -func (x *ScrobblerIsAuthorizedResponse) GetError() string { - if x != nil { - return x.Error - } - return "" -} - -type TrackInfo struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` - Mbid string `protobuf:"bytes,2,opt,name=mbid,proto3" json:"mbid,omitempty"` - Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"` - Album string `protobuf:"bytes,4,opt,name=album,proto3" json:"album,omitempty"` - AlbumMbid string `protobuf:"bytes,5,opt,name=album_mbid,json=albumMbid,proto3" json:"album_mbid,omitempty"` - Artists []*Artist `protobuf:"bytes,6,rep,name=artists,proto3" json:"artists,omitempty"` - AlbumArtists []*Artist `protobuf:"bytes,7,rep,name=album_artists,json=albumArtists,proto3" json:"album_artists,omitempty"` - Length int32 `protobuf:"varint,8,opt,name=length,proto3" json:"length,omitempty"` // seconds - Position int32 `protobuf:"varint,9,opt,name=position,proto3" json:"position,omitempty"` // seconds -} - -func (x *TrackInfo) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *TrackInfo) GetId() string { - if x != nil { - return x.Id - } - return "" -} - -func (x *TrackInfo) GetMbid() string { - if x != nil { - return x.Mbid - } - return "" -} - -func (x *TrackInfo) GetName() string { - if x != nil { - return x.Name - } - return "" -} - -func (x *TrackInfo) GetAlbum() string { - if x != nil { - return x.Album - } - return "" -} - -func (x *TrackInfo) GetAlbumMbid() string { - if x != nil { - return x.AlbumMbid - } - return "" -} - -func (x *TrackInfo) GetArtists() []*Artist { - if x != nil { - return x.Artists - } - return nil -} - -func (x *TrackInfo) GetAlbumArtists() []*Artist { - if x != nil { - return x.AlbumArtists - } - return nil -} - -func (x *TrackInfo) GetLength() int32 { - if x != nil { - return x.Length - } - return 0 -} - -func (x *TrackInfo) GetPosition() int32 { - if x != nil { - return x.Position - } - return 0 -} - -type ScrobblerNowPlayingRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"` - Username string `protobuf:"bytes,2,opt,name=username,proto3" json:"username,omitempty"` - Track *TrackInfo `protobuf:"bytes,3,opt,name=track,proto3" json:"track,omitempty"` - Timestamp int64 `protobuf:"varint,4,opt,name=timestamp,proto3" json:"timestamp,omitempty"` -} - -func (x *ScrobblerNowPlayingRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *ScrobblerNowPlayingRequest) GetUserId() string { - if x != nil { - return x.UserId - } - return "" -} - -func (x *ScrobblerNowPlayingRequest) GetUsername() string { - if x != nil { - return x.Username - } - return "" -} - -func (x *ScrobblerNowPlayingRequest) GetTrack() *TrackInfo { - if x != nil { - return x.Track - } - return nil -} - -func (x *ScrobblerNowPlayingRequest) GetTimestamp() int64 { - if x != nil { - return x.Timestamp - } - return 0 -} - -type ScrobblerNowPlayingResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Error string `protobuf:"bytes,1,opt,name=error,proto3" json:"error,omitempty"` -} - -func (x *ScrobblerNowPlayingResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *ScrobblerNowPlayingResponse) GetError() string { - if x != nil { - return x.Error - } - return "" -} - -type ScrobblerScrobbleRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"` - Username string `protobuf:"bytes,2,opt,name=username,proto3" json:"username,omitempty"` - Track *TrackInfo `protobuf:"bytes,3,opt,name=track,proto3" json:"track,omitempty"` - Timestamp int64 `protobuf:"varint,4,opt,name=timestamp,proto3" json:"timestamp,omitempty"` -} - -func (x *ScrobblerScrobbleRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *ScrobblerScrobbleRequest) GetUserId() string { - if x != nil { - return x.UserId - } - return "" -} - -func (x *ScrobblerScrobbleRequest) GetUsername() string { - if x != nil { - return x.Username - } - return "" -} - -func (x *ScrobblerScrobbleRequest) GetTrack() *TrackInfo { - if x != nil { - return x.Track - } - return nil -} - -func (x *ScrobblerScrobbleRequest) GetTimestamp() int64 { - if x != nil { - return x.Timestamp - } - return 0 -} - -type ScrobblerScrobbleResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Error string `protobuf:"bytes,1,opt,name=error,proto3" json:"error,omitempty"` -} - -func (x *ScrobblerScrobbleResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *ScrobblerScrobbleResponse) GetError() string { - if x != nil { - return x.Error - } - return "" -} - -type SchedulerCallbackRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - ScheduleId string `protobuf:"bytes,1,opt,name=schedule_id,json=scheduleId,proto3" json:"schedule_id,omitempty"` // ID of the scheduled job that triggered this callback - Payload []byte `protobuf:"bytes,2,opt,name=payload,proto3" json:"payload,omitempty"` // The data passed when the job was scheduled - IsRecurring bool `protobuf:"varint,3,opt,name=is_recurring,json=isRecurring,proto3" json:"is_recurring,omitempty"` // Whether this is from a recurring schedule (cron job) -} - -func (x *SchedulerCallbackRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *SchedulerCallbackRequest) GetScheduleId() string { - if x != nil { - return x.ScheduleId - } - return "" -} - -func (x *SchedulerCallbackRequest) GetPayload() []byte { - if x != nil { - return x.Payload - } - return nil -} - -func (x *SchedulerCallbackRequest) GetIsRecurring() bool { - if x != nil { - return x.IsRecurring - } - return false -} - -type SchedulerCallbackResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Error string `protobuf:"bytes,1,opt,name=error,proto3" json:"error,omitempty"` // Error message if the callback failed -} - -func (x *SchedulerCallbackResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *SchedulerCallbackResponse) GetError() string { - if x != nil { - return x.Error - } - return "" -} - -type InitRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Config map[string]string `protobuf:"bytes,1,rep,name=config,proto3" json:"config,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"` // Configuration specific to this plugin -} - -func (x *InitRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *InitRequest) GetConfig() map[string]string { - if x != nil { - return x.Config - } - return nil -} - -type InitResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Error string `protobuf:"bytes,1,opt,name=error,proto3" json:"error,omitempty"` // Error message if initialization failed -} - -func (x *InitResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *InitResponse) GetError() string { - if x != nil { - return x.Error - } - return "" -} - -type OnTextMessageRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - ConnectionId string `protobuf:"bytes,1,opt,name=connection_id,json=connectionId,proto3" json:"connection_id,omitempty"` - Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"` -} - -func (x *OnTextMessageRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *OnTextMessageRequest) GetConnectionId() string { - if x != nil { - return x.ConnectionId - } - return "" -} - -func (x *OnTextMessageRequest) GetMessage() string { - if x != nil { - return x.Message - } - return "" -} - -type OnTextMessageResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields -} - -func (x *OnTextMessageResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -type OnBinaryMessageRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - ConnectionId string `protobuf:"bytes,1,opt,name=connection_id,json=connectionId,proto3" json:"connection_id,omitempty"` - Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"` -} - -func (x *OnBinaryMessageRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *OnBinaryMessageRequest) GetConnectionId() string { - if x != nil { - return x.ConnectionId - } - return "" -} - -func (x *OnBinaryMessageRequest) GetData() []byte { - if x != nil { - return x.Data - } - return nil -} - -type OnBinaryMessageResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields -} - -func (x *OnBinaryMessageResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -type OnErrorRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - ConnectionId string `protobuf:"bytes,1,opt,name=connection_id,json=connectionId,proto3" json:"connection_id,omitempty"` - Error string `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"` -} - -func (x *OnErrorRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *OnErrorRequest) GetConnectionId() string { - if x != nil { - return x.ConnectionId - } - return "" -} - -func (x *OnErrorRequest) GetError() string { - if x != nil { - return x.Error - } - return "" -} - -type OnErrorResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields -} - -func (x *OnErrorResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -type OnCloseRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - ConnectionId string `protobuf:"bytes,1,opt,name=connection_id,json=connectionId,proto3" json:"connection_id,omitempty"` - Code int32 `protobuf:"varint,2,opt,name=code,proto3" json:"code,omitempty"` - Reason string `protobuf:"bytes,3,opt,name=reason,proto3" json:"reason,omitempty"` -} - -func (x *OnCloseRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *OnCloseRequest) GetConnectionId() string { - if x != nil { - return x.ConnectionId - } - return "" -} - -func (x *OnCloseRequest) GetCode() int32 { - if x != nil { - return x.Code - } - return 0 -} - -func (x *OnCloseRequest) GetReason() string { - if x != nil { - return x.Reason - } - return "" -} - -type OnCloseResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields -} - -func (x *OnCloseResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -// go:plugin type=plugin version=1 -type MetadataAgent interface { - // Artist metadata methods - GetArtistMBID(context.Context, *ArtistMBIDRequest) (*ArtistMBIDResponse, error) - GetArtistURL(context.Context, *ArtistURLRequest) (*ArtistURLResponse, error) - GetArtistBiography(context.Context, *ArtistBiographyRequest) (*ArtistBiographyResponse, error) - GetSimilarArtists(context.Context, *ArtistSimilarRequest) (*ArtistSimilarResponse, error) - GetArtistImages(context.Context, *ArtistImageRequest) (*ArtistImageResponse, error) - GetArtistTopSongs(context.Context, *ArtistTopSongsRequest) (*ArtistTopSongsResponse, error) - // Album metadata methods - GetAlbumInfo(context.Context, *AlbumInfoRequest) (*AlbumInfoResponse, error) - GetAlbumImages(context.Context, *AlbumImagesRequest) (*AlbumImagesResponse, error) -} - -// go:plugin type=plugin version=1 -type Scrobbler interface { - IsAuthorized(context.Context, *ScrobblerIsAuthorizedRequest) (*ScrobblerIsAuthorizedResponse, error) - NowPlaying(context.Context, *ScrobblerNowPlayingRequest) (*ScrobblerNowPlayingResponse, error) - Scrobble(context.Context, *ScrobblerScrobbleRequest) (*ScrobblerScrobbleResponse, error) -} - -// go:plugin type=plugin version=1 -type SchedulerCallback interface { - OnSchedulerCallback(context.Context, *SchedulerCallbackRequest) (*SchedulerCallbackResponse, error) -} - -// go:plugin type=plugin version=1 -type LifecycleManagement interface { - OnInit(context.Context, *InitRequest) (*InitResponse, error) -} - -// go:plugin type=plugin version=1 -type WebSocketCallback interface { - // Called when a text message is received - OnTextMessage(context.Context, *OnTextMessageRequest) (*OnTextMessageResponse, error) - // Called when a binary message is received - OnBinaryMessage(context.Context, *OnBinaryMessageRequest) (*OnBinaryMessageResponse, error) - // Called when an error occurs - OnError(context.Context, *OnErrorRequest) (*OnErrorResponse, error) - // Called when the connection is closed - OnClose(context.Context, *OnCloseRequest) (*OnCloseResponse, error) -} diff --git a/plugins/api/api.proto b/plugins/api/api.proto deleted file mode 100644 index 7929ff9e6..000000000 --- a/plugins/api/api.proto +++ /dev/null @@ -1,246 +0,0 @@ -syntax = "proto3"; - -package api; - -option go_package = "github.com/navidrome/navidrome/plugins/api;api"; - -// go:plugin type=plugin version=1 -service MetadataAgent { - // Artist metadata methods - rpc GetArtistMBID(ArtistMBIDRequest) returns (ArtistMBIDResponse); - rpc GetArtistURL(ArtistURLRequest) returns (ArtistURLResponse); - rpc GetArtistBiography(ArtistBiographyRequest) returns (ArtistBiographyResponse); - rpc GetSimilarArtists(ArtistSimilarRequest) returns (ArtistSimilarResponse); - rpc GetArtistImages(ArtistImageRequest) returns (ArtistImageResponse); - rpc GetArtistTopSongs(ArtistTopSongsRequest) returns (ArtistTopSongsResponse); - - // Album metadata methods - rpc GetAlbumInfo(AlbumInfoRequest) returns (AlbumInfoResponse); - rpc GetAlbumImages(AlbumImagesRequest) returns (AlbumImagesResponse); -} - -message ArtistMBIDRequest { - string id = 1; - string name = 2; -} - -message ArtistMBIDResponse { - string mbid = 1; -} - -message ArtistURLRequest { - string id = 1; - string name = 2; - string mbid = 3; -} - -message ArtistURLResponse { - string url = 1; -} - -message ArtistBiographyRequest { - string id = 1; - string name = 2; - string mbid = 3; -} - -message ArtistBiographyResponse { - string biography = 1; -} - -message ArtistSimilarRequest { - string id = 1; - string name = 2; - string mbid = 3; - int32 limit = 4; -} - -message Artist { - string name = 1; - string mbid = 2; -} - -message ArtistSimilarResponse { - repeated Artist artists = 1; -} - -message ArtistImageRequest { - string id = 1; - string name = 2; - string mbid = 3; -} - -message ExternalImage { - string url = 1; - int32 size = 2; -} - -message ArtistImageResponse { - repeated ExternalImage images = 1; -} - -message ArtistTopSongsRequest { - string id = 1; - string artistName = 2; - string mbid = 3; - int32 count = 4; -} - -message Song { - string name = 1; - string mbid = 2; -} - -message ArtistTopSongsResponse { - repeated Song songs = 1; -} - -message AlbumInfoRequest { - string name = 1; - string artist = 2; - string mbid = 3; -} - -message AlbumInfo { - string name = 1; - string mbid = 2; - string description = 3; - string url = 4; -} - -message AlbumInfoResponse { - AlbumInfo info = 1; -} - -message AlbumImagesRequest { - string name = 1; - string artist = 2; - string mbid = 3; -} - -message AlbumImagesResponse { - repeated ExternalImage images = 1; -} - -// go:plugin type=plugin version=1 -service Scrobbler { - rpc IsAuthorized(ScrobblerIsAuthorizedRequest) returns (ScrobblerIsAuthorizedResponse); - rpc NowPlaying(ScrobblerNowPlayingRequest) returns (ScrobblerNowPlayingResponse); - rpc Scrobble(ScrobblerScrobbleRequest) returns (ScrobblerScrobbleResponse); -} - -message ScrobblerIsAuthorizedRequest { - string user_id = 1; - string username = 2; -} - -message ScrobblerIsAuthorizedResponse { - bool authorized = 1; - string error = 2; -} - -message TrackInfo { - string id = 1; - string mbid = 2; - string name = 3; - string album = 4; - string album_mbid = 5; - repeated Artist artists = 6; - repeated Artist album_artists = 7; - int32 length = 8; // seconds - int32 position = 9; // seconds -} - -message ScrobblerNowPlayingRequest { - string user_id = 1; - string username = 2; - TrackInfo track = 3; - int64 timestamp = 4; -} - -message ScrobblerNowPlayingResponse { - string error = 1; -} - -message ScrobblerScrobbleRequest { - string user_id = 1; - string username = 2; - TrackInfo track = 3; - int64 timestamp = 4; -} - -message ScrobblerScrobbleResponse { - string error = 1; -} - -// go:plugin type=plugin version=1 -service SchedulerCallback { - rpc OnSchedulerCallback(SchedulerCallbackRequest) returns (SchedulerCallbackResponse); -} - -message SchedulerCallbackRequest { - string schedule_id = 1; // ID of the scheduled job that triggered this callback - bytes payload = 2; // The data passed when the job was scheduled - bool is_recurring = 3; // Whether this is from a recurring schedule (cron job) -} - -message SchedulerCallbackResponse { - string error = 1; // Error message if the callback failed -} - -// go:plugin type=plugin version=1 -service LifecycleManagement { - rpc OnInit(InitRequest) returns (InitResponse); -} - -message InitRequest { - map config = 1; // Configuration specific to this plugin -} - -message InitResponse { - string error = 1; // Error message if initialization failed -} - -// go:plugin type=plugin version=1 -service WebSocketCallback { - // Called when a text message is received - rpc OnTextMessage(OnTextMessageRequest) returns (OnTextMessageResponse); - - // Called when a binary message is received - rpc OnBinaryMessage(OnBinaryMessageRequest) returns (OnBinaryMessageResponse); - - // Called when an error occurs - rpc OnError(OnErrorRequest) returns (OnErrorResponse); - - // Called when the connection is closed - rpc OnClose(OnCloseRequest) returns (OnCloseResponse); -} - -message OnTextMessageRequest { - string connection_id = 1; - string message = 2; -} - -message OnTextMessageResponse {} - -message OnBinaryMessageRequest { - string connection_id = 1; - bytes data = 2; -} - -message OnBinaryMessageResponse {} - -message OnErrorRequest { - string connection_id = 1; - string error = 2; -} - -message OnErrorResponse {} - -message OnCloseRequest { - string connection_id = 1; - int32 code = 2; - string reason = 3; -} - -message OnCloseResponse {} \ No newline at end of file diff --git a/plugins/api/api_host.pb.go b/plugins/api/api_host.pb.go deleted file mode 100644 index 55e648c6c..000000000 --- a/plugins/api/api_host.pb.go +++ /dev/null @@ -1,1688 +0,0 @@ -//go:build !wasip1 - -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: api/api.proto - -package api - -import ( - context "context" - errors "errors" - fmt "fmt" - wazero "github.com/tetratelabs/wazero" - api "github.com/tetratelabs/wazero/api" - sys "github.com/tetratelabs/wazero/sys" - os "os" -) - -const MetadataAgentPluginAPIVersion = 1 - -type MetadataAgentPlugin struct { - newRuntime func(context.Context) (wazero.Runtime, error) - moduleConfig wazero.ModuleConfig -} - -func NewMetadataAgentPlugin(ctx context.Context, opts ...wazeroConfigOption) (*MetadataAgentPlugin, error) { - o := &WazeroConfig{ - newRuntime: DefaultWazeroRuntime(), - moduleConfig: wazero.NewModuleConfig().WithStartFunctions("_initialize"), - } - - for _, opt := range opts { - opt(o) - } - - return &MetadataAgentPlugin{ - newRuntime: o.newRuntime, - moduleConfig: o.moduleConfig, - }, nil -} - -type metadataAgent interface { - Close(ctx context.Context) error - MetadataAgent -} - -func (p *MetadataAgentPlugin) Load(ctx context.Context, pluginPath string) (metadataAgent, error) { - b, err := os.ReadFile(pluginPath) - if err != nil { - return nil, err - } - - // Create a new runtime so that multiple modules will not conflict - r, err := p.newRuntime(ctx) - if err != nil { - return nil, err - } - - // Compile the WebAssembly module using the default configuration. - code, err := r.CompileModule(ctx, b) - if err != nil { - return nil, err - } - - // InstantiateModule runs the "_start" function, WASI's "main". - module, err := r.InstantiateModule(ctx, code, p.moduleConfig) - if err != nil { - // Note: Most compilers do not exit the module after running "_start", - // unless there was an Error. This allows you to call exported functions. - if exitErr, ok := err.(*sys.ExitError); ok && exitErr.ExitCode() != 0 { - return nil, fmt.Errorf("unexpected exit_code: %d", exitErr.ExitCode()) - } else if !ok { - return nil, err - } - } - - // Compare API versions with the loading plugin - apiVersion := module.ExportedFunction("metadata_agent_api_version") - if apiVersion == nil { - return nil, errors.New("metadata_agent_api_version is not exported") - } - results, err := apiVersion.Call(ctx) - if err != nil { - return nil, err - } else if len(results) != 1 { - return nil, errors.New("invalid metadata_agent_api_version signature") - } - if results[0] != MetadataAgentPluginAPIVersion { - return nil, fmt.Errorf("API version mismatch, host: %d, plugin: %d", MetadataAgentPluginAPIVersion, results[0]) - } - - getartistmbid := module.ExportedFunction("metadata_agent_get_artist_mbid") - if getartistmbid == nil { - return nil, errors.New("metadata_agent_get_artist_mbid is not exported") - } - getartisturl := module.ExportedFunction("metadata_agent_get_artist_url") - if getartisturl == nil { - return nil, errors.New("metadata_agent_get_artist_url is not exported") - } - getartistbiography := module.ExportedFunction("metadata_agent_get_artist_biography") - if getartistbiography == nil { - return nil, errors.New("metadata_agent_get_artist_biography is not exported") - } - getsimilarartists := module.ExportedFunction("metadata_agent_get_similar_artists") - if getsimilarartists == nil { - return nil, errors.New("metadata_agent_get_similar_artists is not exported") - } - getartistimages := module.ExportedFunction("metadata_agent_get_artist_images") - if getartistimages == nil { - return nil, errors.New("metadata_agent_get_artist_images is not exported") - } - getartisttopsongs := module.ExportedFunction("metadata_agent_get_artist_top_songs") - if getartisttopsongs == nil { - return nil, errors.New("metadata_agent_get_artist_top_songs is not exported") - } - getalbuminfo := module.ExportedFunction("metadata_agent_get_album_info") - if getalbuminfo == nil { - return nil, errors.New("metadata_agent_get_album_info is not exported") - } - getalbumimages := module.ExportedFunction("metadata_agent_get_album_images") - if getalbumimages == nil { - return nil, errors.New("metadata_agent_get_album_images is not exported") - } - - malloc := module.ExportedFunction("malloc") - if malloc == nil { - return nil, errors.New("malloc is not exported") - } - - free := module.ExportedFunction("free") - if free == nil { - return nil, errors.New("free is not exported") - } - return &metadataAgentPlugin{ - runtime: r, - module: module, - malloc: malloc, - free: free, - getartistmbid: getartistmbid, - getartisturl: getartisturl, - getartistbiography: getartistbiography, - getsimilarartists: getsimilarartists, - getartistimages: getartistimages, - getartisttopsongs: getartisttopsongs, - getalbuminfo: getalbuminfo, - getalbumimages: getalbumimages, - }, nil -} - -func (p *metadataAgentPlugin) Close(ctx context.Context) (err error) { - if r := p.runtime; r != nil { - r.Close(ctx) - } - return -} - -type metadataAgentPlugin struct { - runtime wazero.Runtime - module api.Module - malloc api.Function - free api.Function - getartistmbid api.Function - getartisturl api.Function - getartistbiography api.Function - getsimilarartists api.Function - getartistimages api.Function - getartisttopsongs api.Function - getalbuminfo api.Function - getalbumimages api.Function -} - -func (p *metadataAgentPlugin) GetArtistMBID(ctx context.Context, request *ArtistMBIDRequest) (*ArtistMBIDResponse, error) { - data, err := request.MarshalVT() - if err != nil { - return nil, err - } - dataSize := uint64(len(data)) - - var dataPtr uint64 - // If the input data is not empty, we must allocate the in-Wasm memory to store it, and pass to the plugin. - if dataSize != 0 { - results, err := p.malloc.Call(ctx, dataSize) - if err != nil { - return nil, err - } - dataPtr = results[0] - // This pointer is managed by the Wasm module, which is unaware of external usage. - // So, we have to free it when finished - defer p.free.Call(ctx, dataPtr) - - // The pointer is a linear memory offset, which is where we write the name. - if !p.module.Memory().Write(uint32(dataPtr), data) { - return nil, fmt.Errorf("Memory.Write(%d, %d) out of range of memory size %d", dataPtr, dataSize, p.module.Memory().Size()) - } - } - - ptrSize, err := p.getartistmbid.Call(ctx, dataPtr, dataSize) - if err != nil { - return nil, err - } - - resPtr := uint32(ptrSize[0] >> 32) - resSize := uint32(ptrSize[0]) - var isErrResponse bool - if (resSize & (1 << 31)) > 0 { - isErrResponse = true - resSize &^= (1 << 31) - } - - // We don't need the memory after deserialization: make sure it is freed. - if resPtr != 0 { - defer p.free.Call(ctx, uint64(resPtr)) - } - - // The pointer is a linear memory offset, which is where we write the name. - bytes, ok := p.module.Memory().Read(resPtr, resSize) - if !ok { - return nil, fmt.Errorf("Memory.Read(%d, %d) out of range of memory size %d", - resPtr, resSize, p.module.Memory().Size()) - } - - if isErrResponse { - return nil, errors.New(string(bytes)) - } - - response := new(ArtistMBIDResponse) - if err = response.UnmarshalVT(bytes); err != nil { - return nil, err - } - - return response, nil -} -func (p *metadataAgentPlugin) GetArtistURL(ctx context.Context, request *ArtistURLRequest) (*ArtistURLResponse, error) { - data, err := request.MarshalVT() - if err != nil { - return nil, err - } - dataSize := uint64(len(data)) - - var dataPtr uint64 - // If the input data is not empty, we must allocate the in-Wasm memory to store it, and pass to the plugin. - if dataSize != 0 { - results, err := p.malloc.Call(ctx, dataSize) - if err != nil { - return nil, err - } - dataPtr = results[0] - // This pointer is managed by the Wasm module, which is unaware of external usage. - // So, we have to free it when finished - defer p.free.Call(ctx, dataPtr) - - // The pointer is a linear memory offset, which is where we write the name. - if !p.module.Memory().Write(uint32(dataPtr), data) { - return nil, fmt.Errorf("Memory.Write(%d, %d) out of range of memory size %d", dataPtr, dataSize, p.module.Memory().Size()) - } - } - - ptrSize, err := p.getartisturl.Call(ctx, dataPtr, dataSize) - if err != nil { - return nil, err - } - - resPtr := uint32(ptrSize[0] >> 32) - resSize := uint32(ptrSize[0]) - var isErrResponse bool - if (resSize & (1 << 31)) > 0 { - isErrResponse = true - resSize &^= (1 << 31) - } - - // We don't need the memory after deserialization: make sure it is freed. - if resPtr != 0 { - defer p.free.Call(ctx, uint64(resPtr)) - } - - // The pointer is a linear memory offset, which is where we write the name. - bytes, ok := p.module.Memory().Read(resPtr, resSize) - if !ok { - return nil, fmt.Errorf("Memory.Read(%d, %d) out of range of memory size %d", - resPtr, resSize, p.module.Memory().Size()) - } - - if isErrResponse { - return nil, errors.New(string(bytes)) - } - - response := new(ArtistURLResponse) - if err = response.UnmarshalVT(bytes); err != nil { - return nil, err - } - - return response, nil -} -func (p *metadataAgentPlugin) GetArtistBiography(ctx context.Context, request *ArtistBiographyRequest) (*ArtistBiographyResponse, error) { - data, err := request.MarshalVT() - if err != nil { - return nil, err - } - dataSize := uint64(len(data)) - - var dataPtr uint64 - // If the input data is not empty, we must allocate the in-Wasm memory to store it, and pass to the plugin. - if dataSize != 0 { - results, err := p.malloc.Call(ctx, dataSize) - if err != nil { - return nil, err - } - dataPtr = results[0] - // This pointer is managed by the Wasm module, which is unaware of external usage. - // So, we have to free it when finished - defer p.free.Call(ctx, dataPtr) - - // The pointer is a linear memory offset, which is where we write the name. - if !p.module.Memory().Write(uint32(dataPtr), data) { - return nil, fmt.Errorf("Memory.Write(%d, %d) out of range of memory size %d", dataPtr, dataSize, p.module.Memory().Size()) - } - } - - ptrSize, err := p.getartistbiography.Call(ctx, dataPtr, dataSize) - if err != nil { - return nil, err - } - - resPtr := uint32(ptrSize[0] >> 32) - resSize := uint32(ptrSize[0]) - var isErrResponse bool - if (resSize & (1 << 31)) > 0 { - isErrResponse = true - resSize &^= (1 << 31) - } - - // We don't need the memory after deserialization: make sure it is freed. - if resPtr != 0 { - defer p.free.Call(ctx, uint64(resPtr)) - } - - // The pointer is a linear memory offset, which is where we write the name. - bytes, ok := p.module.Memory().Read(resPtr, resSize) - if !ok { - return nil, fmt.Errorf("Memory.Read(%d, %d) out of range of memory size %d", - resPtr, resSize, p.module.Memory().Size()) - } - - if isErrResponse { - return nil, errors.New(string(bytes)) - } - - response := new(ArtistBiographyResponse) - if err = response.UnmarshalVT(bytes); err != nil { - return nil, err - } - - return response, nil -} -func (p *metadataAgentPlugin) GetSimilarArtists(ctx context.Context, request *ArtistSimilarRequest) (*ArtistSimilarResponse, error) { - data, err := request.MarshalVT() - if err != nil { - return nil, err - } - dataSize := uint64(len(data)) - - var dataPtr uint64 - // If the input data is not empty, we must allocate the in-Wasm memory to store it, and pass to the plugin. - if dataSize != 0 { - results, err := p.malloc.Call(ctx, dataSize) - if err != nil { - return nil, err - } - dataPtr = results[0] - // This pointer is managed by the Wasm module, which is unaware of external usage. - // So, we have to free it when finished - defer p.free.Call(ctx, dataPtr) - - // The pointer is a linear memory offset, which is where we write the name. - if !p.module.Memory().Write(uint32(dataPtr), data) { - return nil, fmt.Errorf("Memory.Write(%d, %d) out of range of memory size %d", dataPtr, dataSize, p.module.Memory().Size()) - } - } - - ptrSize, err := p.getsimilarartists.Call(ctx, dataPtr, dataSize) - if err != nil { - return nil, err - } - - resPtr := uint32(ptrSize[0] >> 32) - resSize := uint32(ptrSize[0]) - var isErrResponse bool - if (resSize & (1 << 31)) > 0 { - isErrResponse = true - resSize &^= (1 << 31) - } - - // We don't need the memory after deserialization: make sure it is freed. - if resPtr != 0 { - defer p.free.Call(ctx, uint64(resPtr)) - } - - // The pointer is a linear memory offset, which is where we write the name. - bytes, ok := p.module.Memory().Read(resPtr, resSize) - if !ok { - return nil, fmt.Errorf("Memory.Read(%d, %d) out of range of memory size %d", - resPtr, resSize, p.module.Memory().Size()) - } - - if isErrResponse { - return nil, errors.New(string(bytes)) - } - - response := new(ArtistSimilarResponse) - if err = response.UnmarshalVT(bytes); err != nil { - return nil, err - } - - return response, nil -} -func (p *metadataAgentPlugin) GetArtistImages(ctx context.Context, request *ArtistImageRequest) (*ArtistImageResponse, error) { - data, err := request.MarshalVT() - if err != nil { - return nil, err - } - dataSize := uint64(len(data)) - - var dataPtr uint64 - // If the input data is not empty, we must allocate the in-Wasm memory to store it, and pass to the plugin. - if dataSize != 0 { - results, err := p.malloc.Call(ctx, dataSize) - if err != nil { - return nil, err - } - dataPtr = results[0] - // This pointer is managed by the Wasm module, which is unaware of external usage. - // So, we have to free it when finished - defer p.free.Call(ctx, dataPtr) - - // The pointer is a linear memory offset, which is where we write the name. - if !p.module.Memory().Write(uint32(dataPtr), data) { - return nil, fmt.Errorf("Memory.Write(%d, %d) out of range of memory size %d", dataPtr, dataSize, p.module.Memory().Size()) - } - } - - ptrSize, err := p.getartistimages.Call(ctx, dataPtr, dataSize) - if err != nil { - return nil, err - } - - resPtr := uint32(ptrSize[0] >> 32) - resSize := uint32(ptrSize[0]) - var isErrResponse bool - if (resSize & (1 << 31)) > 0 { - isErrResponse = true - resSize &^= (1 << 31) - } - - // We don't need the memory after deserialization: make sure it is freed. - if resPtr != 0 { - defer p.free.Call(ctx, uint64(resPtr)) - } - - // The pointer is a linear memory offset, which is where we write the name. - bytes, ok := p.module.Memory().Read(resPtr, resSize) - if !ok { - return nil, fmt.Errorf("Memory.Read(%d, %d) out of range of memory size %d", - resPtr, resSize, p.module.Memory().Size()) - } - - if isErrResponse { - return nil, errors.New(string(bytes)) - } - - response := new(ArtistImageResponse) - if err = response.UnmarshalVT(bytes); err != nil { - return nil, err - } - - return response, nil -} -func (p *metadataAgentPlugin) GetArtistTopSongs(ctx context.Context, request *ArtistTopSongsRequest) (*ArtistTopSongsResponse, error) { - data, err := request.MarshalVT() - if err != nil { - return nil, err - } - dataSize := uint64(len(data)) - - var dataPtr uint64 - // If the input data is not empty, we must allocate the in-Wasm memory to store it, and pass to the plugin. - if dataSize != 0 { - results, err := p.malloc.Call(ctx, dataSize) - if err != nil { - return nil, err - } - dataPtr = results[0] - // This pointer is managed by the Wasm module, which is unaware of external usage. - // So, we have to free it when finished - defer p.free.Call(ctx, dataPtr) - - // The pointer is a linear memory offset, which is where we write the name. - if !p.module.Memory().Write(uint32(dataPtr), data) { - return nil, fmt.Errorf("Memory.Write(%d, %d) out of range of memory size %d", dataPtr, dataSize, p.module.Memory().Size()) - } - } - - ptrSize, err := p.getartisttopsongs.Call(ctx, dataPtr, dataSize) - if err != nil { - return nil, err - } - - resPtr := uint32(ptrSize[0] >> 32) - resSize := uint32(ptrSize[0]) - var isErrResponse bool - if (resSize & (1 << 31)) > 0 { - isErrResponse = true - resSize &^= (1 << 31) - } - - // We don't need the memory after deserialization: make sure it is freed. - if resPtr != 0 { - defer p.free.Call(ctx, uint64(resPtr)) - } - - // The pointer is a linear memory offset, which is where we write the name. - bytes, ok := p.module.Memory().Read(resPtr, resSize) - if !ok { - return nil, fmt.Errorf("Memory.Read(%d, %d) out of range of memory size %d", - resPtr, resSize, p.module.Memory().Size()) - } - - if isErrResponse { - return nil, errors.New(string(bytes)) - } - - response := new(ArtistTopSongsResponse) - if err = response.UnmarshalVT(bytes); err != nil { - return nil, err - } - - return response, nil -} -func (p *metadataAgentPlugin) GetAlbumInfo(ctx context.Context, request *AlbumInfoRequest) (*AlbumInfoResponse, error) { - data, err := request.MarshalVT() - if err != nil { - return nil, err - } - dataSize := uint64(len(data)) - - var dataPtr uint64 - // If the input data is not empty, we must allocate the in-Wasm memory to store it, and pass to the plugin. - if dataSize != 0 { - results, err := p.malloc.Call(ctx, dataSize) - if err != nil { - return nil, err - } - dataPtr = results[0] - // This pointer is managed by the Wasm module, which is unaware of external usage. - // So, we have to free it when finished - defer p.free.Call(ctx, dataPtr) - - // The pointer is a linear memory offset, which is where we write the name. - if !p.module.Memory().Write(uint32(dataPtr), data) { - return nil, fmt.Errorf("Memory.Write(%d, %d) out of range of memory size %d", dataPtr, dataSize, p.module.Memory().Size()) - } - } - - ptrSize, err := p.getalbuminfo.Call(ctx, dataPtr, dataSize) - if err != nil { - return nil, err - } - - resPtr := uint32(ptrSize[0] >> 32) - resSize := uint32(ptrSize[0]) - var isErrResponse bool - if (resSize & (1 << 31)) > 0 { - isErrResponse = true - resSize &^= (1 << 31) - } - - // We don't need the memory after deserialization: make sure it is freed. - if resPtr != 0 { - defer p.free.Call(ctx, uint64(resPtr)) - } - - // The pointer is a linear memory offset, which is where we write the name. - bytes, ok := p.module.Memory().Read(resPtr, resSize) - if !ok { - return nil, fmt.Errorf("Memory.Read(%d, %d) out of range of memory size %d", - resPtr, resSize, p.module.Memory().Size()) - } - - if isErrResponse { - return nil, errors.New(string(bytes)) - } - - response := new(AlbumInfoResponse) - if err = response.UnmarshalVT(bytes); err != nil { - return nil, err - } - - return response, nil -} -func (p *metadataAgentPlugin) GetAlbumImages(ctx context.Context, request *AlbumImagesRequest) (*AlbumImagesResponse, error) { - data, err := request.MarshalVT() - if err != nil { - return nil, err - } - dataSize := uint64(len(data)) - - var dataPtr uint64 - // If the input data is not empty, we must allocate the in-Wasm memory to store it, and pass to the plugin. - if dataSize != 0 { - results, err := p.malloc.Call(ctx, dataSize) - if err != nil { - return nil, err - } - dataPtr = results[0] - // This pointer is managed by the Wasm module, which is unaware of external usage. - // So, we have to free it when finished - defer p.free.Call(ctx, dataPtr) - - // The pointer is a linear memory offset, which is where we write the name. - if !p.module.Memory().Write(uint32(dataPtr), data) { - return nil, fmt.Errorf("Memory.Write(%d, %d) out of range of memory size %d", dataPtr, dataSize, p.module.Memory().Size()) - } - } - - ptrSize, err := p.getalbumimages.Call(ctx, dataPtr, dataSize) - if err != nil { - return nil, err - } - - resPtr := uint32(ptrSize[0] >> 32) - resSize := uint32(ptrSize[0]) - var isErrResponse bool - if (resSize & (1 << 31)) > 0 { - isErrResponse = true - resSize &^= (1 << 31) - } - - // We don't need the memory after deserialization: make sure it is freed. - if resPtr != 0 { - defer p.free.Call(ctx, uint64(resPtr)) - } - - // The pointer is a linear memory offset, which is where we write the name. - bytes, ok := p.module.Memory().Read(resPtr, resSize) - if !ok { - return nil, fmt.Errorf("Memory.Read(%d, %d) out of range of memory size %d", - resPtr, resSize, p.module.Memory().Size()) - } - - if isErrResponse { - return nil, errors.New(string(bytes)) - } - - response := new(AlbumImagesResponse) - if err = response.UnmarshalVT(bytes); err != nil { - return nil, err - } - - return response, nil -} - -const ScrobblerPluginAPIVersion = 1 - -type ScrobblerPlugin struct { - newRuntime func(context.Context) (wazero.Runtime, error) - moduleConfig wazero.ModuleConfig -} - -func NewScrobblerPlugin(ctx context.Context, opts ...wazeroConfigOption) (*ScrobblerPlugin, error) { - o := &WazeroConfig{ - newRuntime: DefaultWazeroRuntime(), - moduleConfig: wazero.NewModuleConfig().WithStartFunctions("_initialize"), - } - - for _, opt := range opts { - opt(o) - } - - return &ScrobblerPlugin{ - newRuntime: o.newRuntime, - moduleConfig: o.moduleConfig, - }, nil -} - -type scrobbler interface { - Close(ctx context.Context) error - Scrobbler -} - -func (p *ScrobblerPlugin) Load(ctx context.Context, pluginPath string) (scrobbler, error) { - b, err := os.ReadFile(pluginPath) - if err != nil { - return nil, err - } - - // Create a new runtime so that multiple modules will not conflict - r, err := p.newRuntime(ctx) - if err != nil { - return nil, err - } - - // Compile the WebAssembly module using the default configuration. - code, err := r.CompileModule(ctx, b) - if err != nil { - return nil, err - } - - // InstantiateModule runs the "_start" function, WASI's "main". - module, err := r.InstantiateModule(ctx, code, p.moduleConfig) - if err != nil { - // Note: Most compilers do not exit the module after running "_start", - // unless there was an Error. This allows you to call exported functions. - if exitErr, ok := err.(*sys.ExitError); ok && exitErr.ExitCode() != 0 { - return nil, fmt.Errorf("unexpected exit_code: %d", exitErr.ExitCode()) - } else if !ok { - return nil, err - } - } - - // Compare API versions with the loading plugin - apiVersion := module.ExportedFunction("scrobbler_api_version") - if apiVersion == nil { - return nil, errors.New("scrobbler_api_version is not exported") - } - results, err := apiVersion.Call(ctx) - if err != nil { - return nil, err - } else if len(results) != 1 { - return nil, errors.New("invalid scrobbler_api_version signature") - } - if results[0] != ScrobblerPluginAPIVersion { - return nil, fmt.Errorf("API version mismatch, host: %d, plugin: %d", ScrobblerPluginAPIVersion, results[0]) - } - - isauthorized := module.ExportedFunction("scrobbler_is_authorized") - if isauthorized == nil { - return nil, errors.New("scrobbler_is_authorized is not exported") - } - nowplaying := module.ExportedFunction("scrobbler_now_playing") - if nowplaying == nil { - return nil, errors.New("scrobbler_now_playing is not exported") - } - scrobble := module.ExportedFunction("scrobbler_scrobble") - if scrobble == nil { - return nil, errors.New("scrobbler_scrobble is not exported") - } - - malloc := module.ExportedFunction("malloc") - if malloc == nil { - return nil, errors.New("malloc is not exported") - } - - free := module.ExportedFunction("free") - if free == nil { - return nil, errors.New("free is not exported") - } - return &scrobblerPlugin{ - runtime: r, - module: module, - malloc: malloc, - free: free, - isauthorized: isauthorized, - nowplaying: nowplaying, - scrobble: scrobble, - }, nil -} - -func (p *scrobblerPlugin) Close(ctx context.Context) (err error) { - if r := p.runtime; r != nil { - r.Close(ctx) - } - return -} - -type scrobblerPlugin struct { - runtime wazero.Runtime - module api.Module - malloc api.Function - free api.Function - isauthorized api.Function - nowplaying api.Function - scrobble api.Function -} - -func (p *scrobblerPlugin) IsAuthorized(ctx context.Context, request *ScrobblerIsAuthorizedRequest) (*ScrobblerIsAuthorizedResponse, error) { - data, err := request.MarshalVT() - if err != nil { - return nil, err - } - dataSize := uint64(len(data)) - - var dataPtr uint64 - // If the input data is not empty, we must allocate the in-Wasm memory to store it, and pass to the plugin. - if dataSize != 0 { - results, err := p.malloc.Call(ctx, dataSize) - if err != nil { - return nil, err - } - dataPtr = results[0] - // This pointer is managed by the Wasm module, which is unaware of external usage. - // So, we have to free it when finished - defer p.free.Call(ctx, dataPtr) - - // The pointer is a linear memory offset, which is where we write the name. - if !p.module.Memory().Write(uint32(dataPtr), data) { - return nil, fmt.Errorf("Memory.Write(%d, %d) out of range of memory size %d", dataPtr, dataSize, p.module.Memory().Size()) - } - } - - ptrSize, err := p.isauthorized.Call(ctx, dataPtr, dataSize) - if err != nil { - return nil, err - } - - resPtr := uint32(ptrSize[0] >> 32) - resSize := uint32(ptrSize[0]) - var isErrResponse bool - if (resSize & (1 << 31)) > 0 { - isErrResponse = true - resSize &^= (1 << 31) - } - - // We don't need the memory after deserialization: make sure it is freed. - if resPtr != 0 { - defer p.free.Call(ctx, uint64(resPtr)) - } - - // The pointer is a linear memory offset, which is where we write the name. - bytes, ok := p.module.Memory().Read(resPtr, resSize) - if !ok { - return nil, fmt.Errorf("Memory.Read(%d, %d) out of range of memory size %d", - resPtr, resSize, p.module.Memory().Size()) - } - - if isErrResponse { - return nil, errors.New(string(bytes)) - } - - response := new(ScrobblerIsAuthorizedResponse) - if err = response.UnmarshalVT(bytes); err != nil { - return nil, err - } - - return response, nil -} -func (p *scrobblerPlugin) NowPlaying(ctx context.Context, request *ScrobblerNowPlayingRequest) (*ScrobblerNowPlayingResponse, error) { - data, err := request.MarshalVT() - if err != nil { - return nil, err - } - dataSize := uint64(len(data)) - - var dataPtr uint64 - // If the input data is not empty, we must allocate the in-Wasm memory to store it, and pass to the plugin. - if dataSize != 0 { - results, err := p.malloc.Call(ctx, dataSize) - if err != nil { - return nil, err - } - dataPtr = results[0] - // This pointer is managed by the Wasm module, which is unaware of external usage. - // So, we have to free it when finished - defer p.free.Call(ctx, dataPtr) - - // The pointer is a linear memory offset, which is where we write the name. - if !p.module.Memory().Write(uint32(dataPtr), data) { - return nil, fmt.Errorf("Memory.Write(%d, %d) out of range of memory size %d", dataPtr, dataSize, p.module.Memory().Size()) - } - } - - ptrSize, err := p.nowplaying.Call(ctx, dataPtr, dataSize) - if err != nil { - return nil, err - } - - resPtr := uint32(ptrSize[0] >> 32) - resSize := uint32(ptrSize[0]) - var isErrResponse bool - if (resSize & (1 << 31)) > 0 { - isErrResponse = true - resSize &^= (1 << 31) - } - - // We don't need the memory after deserialization: make sure it is freed. - if resPtr != 0 { - defer p.free.Call(ctx, uint64(resPtr)) - } - - // The pointer is a linear memory offset, which is where we write the name. - bytes, ok := p.module.Memory().Read(resPtr, resSize) - if !ok { - return nil, fmt.Errorf("Memory.Read(%d, %d) out of range of memory size %d", - resPtr, resSize, p.module.Memory().Size()) - } - - if isErrResponse { - return nil, errors.New(string(bytes)) - } - - response := new(ScrobblerNowPlayingResponse) - if err = response.UnmarshalVT(bytes); err != nil { - return nil, err - } - - return response, nil -} -func (p *scrobblerPlugin) Scrobble(ctx context.Context, request *ScrobblerScrobbleRequest) (*ScrobblerScrobbleResponse, error) { - data, err := request.MarshalVT() - if err != nil { - return nil, err - } - dataSize := uint64(len(data)) - - var dataPtr uint64 - // If the input data is not empty, we must allocate the in-Wasm memory to store it, and pass to the plugin. - if dataSize != 0 { - results, err := p.malloc.Call(ctx, dataSize) - if err != nil { - return nil, err - } - dataPtr = results[0] - // This pointer is managed by the Wasm module, which is unaware of external usage. - // So, we have to free it when finished - defer p.free.Call(ctx, dataPtr) - - // The pointer is a linear memory offset, which is where we write the name. - if !p.module.Memory().Write(uint32(dataPtr), data) { - return nil, fmt.Errorf("Memory.Write(%d, %d) out of range of memory size %d", dataPtr, dataSize, p.module.Memory().Size()) - } - } - - ptrSize, err := p.scrobble.Call(ctx, dataPtr, dataSize) - if err != nil { - return nil, err - } - - resPtr := uint32(ptrSize[0] >> 32) - resSize := uint32(ptrSize[0]) - var isErrResponse bool - if (resSize & (1 << 31)) > 0 { - isErrResponse = true - resSize &^= (1 << 31) - } - - // We don't need the memory after deserialization: make sure it is freed. - if resPtr != 0 { - defer p.free.Call(ctx, uint64(resPtr)) - } - - // The pointer is a linear memory offset, which is where we write the name. - bytes, ok := p.module.Memory().Read(resPtr, resSize) - if !ok { - return nil, fmt.Errorf("Memory.Read(%d, %d) out of range of memory size %d", - resPtr, resSize, p.module.Memory().Size()) - } - - if isErrResponse { - return nil, errors.New(string(bytes)) - } - - response := new(ScrobblerScrobbleResponse) - if err = response.UnmarshalVT(bytes); err != nil { - return nil, err - } - - return response, nil -} - -const SchedulerCallbackPluginAPIVersion = 1 - -type SchedulerCallbackPlugin struct { - newRuntime func(context.Context) (wazero.Runtime, error) - moduleConfig wazero.ModuleConfig -} - -func NewSchedulerCallbackPlugin(ctx context.Context, opts ...wazeroConfigOption) (*SchedulerCallbackPlugin, error) { - o := &WazeroConfig{ - newRuntime: DefaultWazeroRuntime(), - moduleConfig: wazero.NewModuleConfig().WithStartFunctions("_initialize"), - } - - for _, opt := range opts { - opt(o) - } - - return &SchedulerCallbackPlugin{ - newRuntime: o.newRuntime, - moduleConfig: o.moduleConfig, - }, nil -} - -type schedulerCallback interface { - Close(ctx context.Context) error - SchedulerCallback -} - -func (p *SchedulerCallbackPlugin) Load(ctx context.Context, pluginPath string) (schedulerCallback, error) { - b, err := os.ReadFile(pluginPath) - if err != nil { - return nil, err - } - - // Create a new runtime so that multiple modules will not conflict - r, err := p.newRuntime(ctx) - if err != nil { - return nil, err - } - - // Compile the WebAssembly module using the default configuration. - code, err := r.CompileModule(ctx, b) - if err != nil { - return nil, err - } - - // InstantiateModule runs the "_start" function, WASI's "main". - module, err := r.InstantiateModule(ctx, code, p.moduleConfig) - if err != nil { - // Note: Most compilers do not exit the module after running "_start", - // unless there was an Error. This allows you to call exported functions. - if exitErr, ok := err.(*sys.ExitError); ok && exitErr.ExitCode() != 0 { - return nil, fmt.Errorf("unexpected exit_code: %d", exitErr.ExitCode()) - } else if !ok { - return nil, err - } - } - - // Compare API versions with the loading plugin - apiVersion := module.ExportedFunction("scheduler_callback_api_version") - if apiVersion == nil { - return nil, errors.New("scheduler_callback_api_version is not exported") - } - results, err := apiVersion.Call(ctx) - if err != nil { - return nil, err - } else if len(results) != 1 { - return nil, errors.New("invalid scheduler_callback_api_version signature") - } - if results[0] != SchedulerCallbackPluginAPIVersion { - return nil, fmt.Errorf("API version mismatch, host: %d, plugin: %d", SchedulerCallbackPluginAPIVersion, results[0]) - } - - onschedulercallback := module.ExportedFunction("scheduler_callback_on_scheduler_callback") - if onschedulercallback == nil { - return nil, errors.New("scheduler_callback_on_scheduler_callback is not exported") - } - - malloc := module.ExportedFunction("malloc") - if malloc == nil { - return nil, errors.New("malloc is not exported") - } - - free := module.ExportedFunction("free") - if free == nil { - return nil, errors.New("free is not exported") - } - return &schedulerCallbackPlugin{ - runtime: r, - module: module, - malloc: malloc, - free: free, - onschedulercallback: onschedulercallback, - }, nil -} - -func (p *schedulerCallbackPlugin) Close(ctx context.Context) (err error) { - if r := p.runtime; r != nil { - r.Close(ctx) - } - return -} - -type schedulerCallbackPlugin struct { - runtime wazero.Runtime - module api.Module - malloc api.Function - free api.Function - onschedulercallback api.Function -} - -func (p *schedulerCallbackPlugin) OnSchedulerCallback(ctx context.Context, request *SchedulerCallbackRequest) (*SchedulerCallbackResponse, error) { - data, err := request.MarshalVT() - if err != nil { - return nil, err - } - dataSize := uint64(len(data)) - - var dataPtr uint64 - // If the input data is not empty, we must allocate the in-Wasm memory to store it, and pass to the plugin. - if dataSize != 0 { - results, err := p.malloc.Call(ctx, dataSize) - if err != nil { - return nil, err - } - dataPtr = results[0] - // This pointer is managed by the Wasm module, which is unaware of external usage. - // So, we have to free it when finished - defer p.free.Call(ctx, dataPtr) - - // The pointer is a linear memory offset, which is where we write the name. - if !p.module.Memory().Write(uint32(dataPtr), data) { - return nil, fmt.Errorf("Memory.Write(%d, %d) out of range of memory size %d", dataPtr, dataSize, p.module.Memory().Size()) - } - } - - ptrSize, err := p.onschedulercallback.Call(ctx, dataPtr, dataSize) - if err != nil { - return nil, err - } - - resPtr := uint32(ptrSize[0] >> 32) - resSize := uint32(ptrSize[0]) - var isErrResponse bool - if (resSize & (1 << 31)) > 0 { - isErrResponse = true - resSize &^= (1 << 31) - } - - // We don't need the memory after deserialization: make sure it is freed. - if resPtr != 0 { - defer p.free.Call(ctx, uint64(resPtr)) - } - - // The pointer is a linear memory offset, which is where we write the name. - bytes, ok := p.module.Memory().Read(resPtr, resSize) - if !ok { - return nil, fmt.Errorf("Memory.Read(%d, %d) out of range of memory size %d", - resPtr, resSize, p.module.Memory().Size()) - } - - if isErrResponse { - return nil, errors.New(string(bytes)) - } - - response := new(SchedulerCallbackResponse) - if err = response.UnmarshalVT(bytes); err != nil { - return nil, err - } - - return response, nil -} - -const LifecycleManagementPluginAPIVersion = 1 - -type LifecycleManagementPlugin struct { - newRuntime func(context.Context) (wazero.Runtime, error) - moduleConfig wazero.ModuleConfig -} - -func NewLifecycleManagementPlugin(ctx context.Context, opts ...wazeroConfigOption) (*LifecycleManagementPlugin, error) { - o := &WazeroConfig{ - newRuntime: DefaultWazeroRuntime(), - moduleConfig: wazero.NewModuleConfig().WithStartFunctions("_initialize"), - } - - for _, opt := range opts { - opt(o) - } - - return &LifecycleManagementPlugin{ - newRuntime: o.newRuntime, - moduleConfig: o.moduleConfig, - }, nil -} - -type lifecycleManagement interface { - Close(ctx context.Context) error - LifecycleManagement -} - -func (p *LifecycleManagementPlugin) Load(ctx context.Context, pluginPath string) (lifecycleManagement, error) { - b, err := os.ReadFile(pluginPath) - if err != nil { - return nil, err - } - - // Create a new runtime so that multiple modules will not conflict - r, err := p.newRuntime(ctx) - if err != nil { - return nil, err - } - - // Compile the WebAssembly module using the default configuration. - code, err := r.CompileModule(ctx, b) - if err != nil { - return nil, err - } - - // InstantiateModule runs the "_start" function, WASI's "main". - module, err := r.InstantiateModule(ctx, code, p.moduleConfig) - if err != nil { - // Note: Most compilers do not exit the module after running "_start", - // unless there was an Error. This allows you to call exported functions. - if exitErr, ok := err.(*sys.ExitError); ok && exitErr.ExitCode() != 0 { - return nil, fmt.Errorf("unexpected exit_code: %d", exitErr.ExitCode()) - } else if !ok { - return nil, err - } - } - - // Compare API versions with the loading plugin - apiVersion := module.ExportedFunction("lifecycle_management_api_version") - if apiVersion == nil { - return nil, errors.New("lifecycle_management_api_version is not exported") - } - results, err := apiVersion.Call(ctx) - if err != nil { - return nil, err - } else if len(results) != 1 { - return nil, errors.New("invalid lifecycle_management_api_version signature") - } - if results[0] != LifecycleManagementPluginAPIVersion { - return nil, fmt.Errorf("API version mismatch, host: %d, plugin: %d", LifecycleManagementPluginAPIVersion, results[0]) - } - - oninit := module.ExportedFunction("lifecycle_management_on_init") - if oninit == nil { - return nil, errors.New("lifecycle_management_on_init is not exported") - } - - malloc := module.ExportedFunction("malloc") - if malloc == nil { - return nil, errors.New("malloc is not exported") - } - - free := module.ExportedFunction("free") - if free == nil { - return nil, errors.New("free is not exported") - } - return &lifecycleManagementPlugin{ - runtime: r, - module: module, - malloc: malloc, - free: free, - oninit: oninit, - }, nil -} - -func (p *lifecycleManagementPlugin) Close(ctx context.Context) (err error) { - if r := p.runtime; r != nil { - r.Close(ctx) - } - return -} - -type lifecycleManagementPlugin struct { - runtime wazero.Runtime - module api.Module - malloc api.Function - free api.Function - oninit api.Function -} - -func (p *lifecycleManagementPlugin) OnInit(ctx context.Context, request *InitRequest) (*InitResponse, error) { - data, err := request.MarshalVT() - if err != nil { - return nil, err - } - dataSize := uint64(len(data)) - - var dataPtr uint64 - // If the input data is not empty, we must allocate the in-Wasm memory to store it, and pass to the plugin. - if dataSize != 0 { - results, err := p.malloc.Call(ctx, dataSize) - if err != nil { - return nil, err - } - dataPtr = results[0] - // This pointer is managed by the Wasm module, which is unaware of external usage. - // So, we have to free it when finished - defer p.free.Call(ctx, dataPtr) - - // The pointer is a linear memory offset, which is where we write the name. - if !p.module.Memory().Write(uint32(dataPtr), data) { - return nil, fmt.Errorf("Memory.Write(%d, %d) out of range of memory size %d", dataPtr, dataSize, p.module.Memory().Size()) - } - } - - ptrSize, err := p.oninit.Call(ctx, dataPtr, dataSize) - if err != nil { - return nil, err - } - - resPtr := uint32(ptrSize[0] >> 32) - resSize := uint32(ptrSize[0]) - var isErrResponse bool - if (resSize & (1 << 31)) > 0 { - isErrResponse = true - resSize &^= (1 << 31) - } - - // We don't need the memory after deserialization: make sure it is freed. - if resPtr != 0 { - defer p.free.Call(ctx, uint64(resPtr)) - } - - // The pointer is a linear memory offset, which is where we write the name. - bytes, ok := p.module.Memory().Read(resPtr, resSize) - if !ok { - return nil, fmt.Errorf("Memory.Read(%d, %d) out of range of memory size %d", - resPtr, resSize, p.module.Memory().Size()) - } - - if isErrResponse { - return nil, errors.New(string(bytes)) - } - - response := new(InitResponse) - if err = response.UnmarshalVT(bytes); err != nil { - return nil, err - } - - return response, nil -} - -const WebSocketCallbackPluginAPIVersion = 1 - -type WebSocketCallbackPlugin struct { - newRuntime func(context.Context) (wazero.Runtime, error) - moduleConfig wazero.ModuleConfig -} - -func NewWebSocketCallbackPlugin(ctx context.Context, opts ...wazeroConfigOption) (*WebSocketCallbackPlugin, error) { - o := &WazeroConfig{ - newRuntime: DefaultWazeroRuntime(), - moduleConfig: wazero.NewModuleConfig().WithStartFunctions("_initialize"), - } - - for _, opt := range opts { - opt(o) - } - - return &WebSocketCallbackPlugin{ - newRuntime: o.newRuntime, - moduleConfig: o.moduleConfig, - }, nil -} - -type webSocketCallback interface { - Close(ctx context.Context) error - WebSocketCallback -} - -func (p *WebSocketCallbackPlugin) Load(ctx context.Context, pluginPath string) (webSocketCallback, error) { - b, err := os.ReadFile(pluginPath) - if err != nil { - return nil, err - } - - // Create a new runtime so that multiple modules will not conflict - r, err := p.newRuntime(ctx) - if err != nil { - return nil, err - } - - // Compile the WebAssembly module using the default configuration. - code, err := r.CompileModule(ctx, b) - if err != nil { - return nil, err - } - - // InstantiateModule runs the "_start" function, WASI's "main". - module, err := r.InstantiateModule(ctx, code, p.moduleConfig) - if err != nil { - // Note: Most compilers do not exit the module after running "_start", - // unless there was an Error. This allows you to call exported functions. - if exitErr, ok := err.(*sys.ExitError); ok && exitErr.ExitCode() != 0 { - return nil, fmt.Errorf("unexpected exit_code: %d", exitErr.ExitCode()) - } else if !ok { - return nil, err - } - } - - // Compare API versions with the loading plugin - apiVersion := module.ExportedFunction("web_socket_callback_api_version") - if apiVersion == nil { - return nil, errors.New("web_socket_callback_api_version is not exported") - } - results, err := apiVersion.Call(ctx) - if err != nil { - return nil, err - } else if len(results) != 1 { - return nil, errors.New("invalid web_socket_callback_api_version signature") - } - if results[0] != WebSocketCallbackPluginAPIVersion { - return nil, fmt.Errorf("API version mismatch, host: %d, plugin: %d", WebSocketCallbackPluginAPIVersion, results[0]) - } - - ontextmessage := module.ExportedFunction("web_socket_callback_on_text_message") - if ontextmessage == nil { - return nil, errors.New("web_socket_callback_on_text_message is not exported") - } - onbinarymessage := module.ExportedFunction("web_socket_callback_on_binary_message") - if onbinarymessage == nil { - return nil, errors.New("web_socket_callback_on_binary_message is not exported") - } - onerror := module.ExportedFunction("web_socket_callback_on_error") - if onerror == nil { - return nil, errors.New("web_socket_callback_on_error is not exported") - } - onclose := module.ExportedFunction("web_socket_callback_on_close") - if onclose == nil { - return nil, errors.New("web_socket_callback_on_close is not exported") - } - - malloc := module.ExportedFunction("malloc") - if malloc == nil { - return nil, errors.New("malloc is not exported") - } - - free := module.ExportedFunction("free") - if free == nil { - return nil, errors.New("free is not exported") - } - return &webSocketCallbackPlugin{ - runtime: r, - module: module, - malloc: malloc, - free: free, - ontextmessage: ontextmessage, - onbinarymessage: onbinarymessage, - onerror: onerror, - onclose: onclose, - }, nil -} - -func (p *webSocketCallbackPlugin) Close(ctx context.Context) (err error) { - if r := p.runtime; r != nil { - r.Close(ctx) - } - return -} - -type webSocketCallbackPlugin struct { - runtime wazero.Runtime - module api.Module - malloc api.Function - free api.Function - ontextmessage api.Function - onbinarymessage api.Function - onerror api.Function - onclose api.Function -} - -func (p *webSocketCallbackPlugin) OnTextMessage(ctx context.Context, request *OnTextMessageRequest) (*OnTextMessageResponse, error) { - data, err := request.MarshalVT() - if err != nil { - return nil, err - } - dataSize := uint64(len(data)) - - var dataPtr uint64 - // If the input data is not empty, we must allocate the in-Wasm memory to store it, and pass to the plugin. - if dataSize != 0 { - results, err := p.malloc.Call(ctx, dataSize) - if err != nil { - return nil, err - } - dataPtr = results[0] - // This pointer is managed by the Wasm module, which is unaware of external usage. - // So, we have to free it when finished - defer p.free.Call(ctx, dataPtr) - - // The pointer is a linear memory offset, which is where we write the name. - if !p.module.Memory().Write(uint32(dataPtr), data) { - return nil, fmt.Errorf("Memory.Write(%d, %d) out of range of memory size %d", dataPtr, dataSize, p.module.Memory().Size()) - } - } - - ptrSize, err := p.ontextmessage.Call(ctx, dataPtr, dataSize) - if err != nil { - return nil, err - } - - resPtr := uint32(ptrSize[0] >> 32) - resSize := uint32(ptrSize[0]) - var isErrResponse bool - if (resSize & (1 << 31)) > 0 { - isErrResponse = true - resSize &^= (1 << 31) - } - - // We don't need the memory after deserialization: make sure it is freed. - if resPtr != 0 { - defer p.free.Call(ctx, uint64(resPtr)) - } - - // The pointer is a linear memory offset, which is where we write the name. - bytes, ok := p.module.Memory().Read(resPtr, resSize) - if !ok { - return nil, fmt.Errorf("Memory.Read(%d, %d) out of range of memory size %d", - resPtr, resSize, p.module.Memory().Size()) - } - - if isErrResponse { - return nil, errors.New(string(bytes)) - } - - response := new(OnTextMessageResponse) - if err = response.UnmarshalVT(bytes); err != nil { - return nil, err - } - - return response, nil -} -func (p *webSocketCallbackPlugin) OnBinaryMessage(ctx context.Context, request *OnBinaryMessageRequest) (*OnBinaryMessageResponse, error) { - data, err := request.MarshalVT() - if err != nil { - return nil, err - } - dataSize := uint64(len(data)) - - var dataPtr uint64 - // If the input data is not empty, we must allocate the in-Wasm memory to store it, and pass to the plugin. - if dataSize != 0 { - results, err := p.malloc.Call(ctx, dataSize) - if err != nil { - return nil, err - } - dataPtr = results[0] - // This pointer is managed by the Wasm module, which is unaware of external usage. - // So, we have to free it when finished - defer p.free.Call(ctx, dataPtr) - - // The pointer is a linear memory offset, which is where we write the name. - if !p.module.Memory().Write(uint32(dataPtr), data) { - return nil, fmt.Errorf("Memory.Write(%d, %d) out of range of memory size %d", dataPtr, dataSize, p.module.Memory().Size()) - } - } - - ptrSize, err := p.onbinarymessage.Call(ctx, dataPtr, dataSize) - if err != nil { - return nil, err - } - - resPtr := uint32(ptrSize[0] >> 32) - resSize := uint32(ptrSize[0]) - var isErrResponse bool - if (resSize & (1 << 31)) > 0 { - isErrResponse = true - resSize &^= (1 << 31) - } - - // We don't need the memory after deserialization: make sure it is freed. - if resPtr != 0 { - defer p.free.Call(ctx, uint64(resPtr)) - } - - // The pointer is a linear memory offset, which is where we write the name. - bytes, ok := p.module.Memory().Read(resPtr, resSize) - if !ok { - return nil, fmt.Errorf("Memory.Read(%d, %d) out of range of memory size %d", - resPtr, resSize, p.module.Memory().Size()) - } - - if isErrResponse { - return nil, errors.New(string(bytes)) - } - - response := new(OnBinaryMessageResponse) - if err = response.UnmarshalVT(bytes); err != nil { - return nil, err - } - - return response, nil -} -func (p *webSocketCallbackPlugin) OnError(ctx context.Context, request *OnErrorRequest) (*OnErrorResponse, error) { - data, err := request.MarshalVT() - if err != nil { - return nil, err - } - dataSize := uint64(len(data)) - - var dataPtr uint64 - // If the input data is not empty, we must allocate the in-Wasm memory to store it, and pass to the plugin. - if dataSize != 0 { - results, err := p.malloc.Call(ctx, dataSize) - if err != nil { - return nil, err - } - dataPtr = results[0] - // This pointer is managed by the Wasm module, which is unaware of external usage. - // So, we have to free it when finished - defer p.free.Call(ctx, dataPtr) - - // The pointer is a linear memory offset, which is where we write the name. - if !p.module.Memory().Write(uint32(dataPtr), data) { - return nil, fmt.Errorf("Memory.Write(%d, %d) out of range of memory size %d", dataPtr, dataSize, p.module.Memory().Size()) - } - } - - ptrSize, err := p.onerror.Call(ctx, dataPtr, dataSize) - if err != nil { - return nil, err - } - - resPtr := uint32(ptrSize[0] >> 32) - resSize := uint32(ptrSize[0]) - var isErrResponse bool - if (resSize & (1 << 31)) > 0 { - isErrResponse = true - resSize &^= (1 << 31) - } - - // We don't need the memory after deserialization: make sure it is freed. - if resPtr != 0 { - defer p.free.Call(ctx, uint64(resPtr)) - } - - // The pointer is a linear memory offset, which is where we write the name. - bytes, ok := p.module.Memory().Read(resPtr, resSize) - if !ok { - return nil, fmt.Errorf("Memory.Read(%d, %d) out of range of memory size %d", - resPtr, resSize, p.module.Memory().Size()) - } - - if isErrResponse { - return nil, errors.New(string(bytes)) - } - - response := new(OnErrorResponse) - if err = response.UnmarshalVT(bytes); err != nil { - return nil, err - } - - return response, nil -} -func (p *webSocketCallbackPlugin) OnClose(ctx context.Context, request *OnCloseRequest) (*OnCloseResponse, error) { - data, err := request.MarshalVT() - if err != nil { - return nil, err - } - dataSize := uint64(len(data)) - - var dataPtr uint64 - // If the input data is not empty, we must allocate the in-Wasm memory to store it, and pass to the plugin. - if dataSize != 0 { - results, err := p.malloc.Call(ctx, dataSize) - if err != nil { - return nil, err - } - dataPtr = results[0] - // This pointer is managed by the Wasm module, which is unaware of external usage. - // So, we have to free it when finished - defer p.free.Call(ctx, dataPtr) - - // The pointer is a linear memory offset, which is where we write the name. - if !p.module.Memory().Write(uint32(dataPtr), data) { - return nil, fmt.Errorf("Memory.Write(%d, %d) out of range of memory size %d", dataPtr, dataSize, p.module.Memory().Size()) - } - } - - ptrSize, err := p.onclose.Call(ctx, dataPtr, dataSize) - if err != nil { - return nil, err - } - - resPtr := uint32(ptrSize[0] >> 32) - resSize := uint32(ptrSize[0]) - var isErrResponse bool - if (resSize & (1 << 31)) > 0 { - isErrResponse = true - resSize &^= (1 << 31) - } - - // We don't need the memory after deserialization: make sure it is freed. - if resPtr != 0 { - defer p.free.Call(ctx, uint64(resPtr)) - } - - // The pointer is a linear memory offset, which is where we write the name. - bytes, ok := p.module.Memory().Read(resPtr, resSize) - if !ok { - return nil, fmt.Errorf("Memory.Read(%d, %d) out of range of memory size %d", - resPtr, resSize, p.module.Memory().Size()) - } - - if isErrResponse { - return nil, errors.New(string(bytes)) - } - - response := new(OnCloseResponse) - if err = response.UnmarshalVT(bytes); err != nil { - return nil, err - } - - return response, nil -} diff --git a/plugins/api/api_options.pb.go b/plugins/api/api_options.pb.go deleted file mode 100644 index 430bf0a5c..000000000 --- a/plugins/api/api_options.pb.go +++ /dev/null @@ -1,47 +0,0 @@ -//go:build !wasip1 - -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: api/api.proto - -package api - -import ( - context "context" - wazero "github.com/tetratelabs/wazero" - wasi_snapshot_preview1 "github.com/tetratelabs/wazero/imports/wasi_snapshot_preview1" -) - -type wazeroConfigOption func(plugin *WazeroConfig) - -type WazeroNewRuntime func(context.Context) (wazero.Runtime, error) - -type WazeroConfig struct { - newRuntime func(context.Context) (wazero.Runtime, error) - moduleConfig wazero.ModuleConfig -} - -func WazeroRuntime(newRuntime WazeroNewRuntime) wazeroConfigOption { - return func(h *WazeroConfig) { - h.newRuntime = newRuntime - } -} - -func DefaultWazeroRuntime() WazeroNewRuntime { - return func(ctx context.Context) (wazero.Runtime, error) { - r := wazero.NewRuntime(ctx) - if _, err := wasi_snapshot_preview1.Instantiate(ctx, r); err != nil { - return nil, err - } - - return r, nil - } -} - -func WazeroModuleConfig(moduleConfig wazero.ModuleConfig) wazeroConfigOption { - return func(h *WazeroConfig) { - h.moduleConfig = moduleConfig - } -} diff --git a/plugins/api/api_plugin.pb.go b/plugins/api/api_plugin.pb.go deleted file mode 100644 index 0a022be9b..000000000 --- a/plugins/api/api_plugin.pb.go +++ /dev/null @@ -1,487 +0,0 @@ -//go:build wasip1 - -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: api/api.proto - -package api - -import ( - context "context" - wasm "github.com/knqyf263/go-plugin/wasm" -) - -const MetadataAgentPluginAPIVersion = 1 - -//go:wasmexport metadata_agent_api_version -func _metadata_agent_api_version() uint64 { - return MetadataAgentPluginAPIVersion -} - -var metadataAgent MetadataAgent - -func RegisterMetadataAgent(p MetadataAgent) { - metadataAgent = p -} - -//go:wasmexport metadata_agent_get_artist_mbid -func _metadata_agent_get_artist_mbid(ptr, size uint32) uint64 { - b := wasm.PtrToByte(ptr, size) - req := new(ArtistMBIDRequest) - if err := req.UnmarshalVT(b); err != nil { - return 0 - } - response, err := metadataAgent.GetArtistMBID(context.Background(), req) - if err != nil { - ptr, size = wasm.ByteToPtr([]byte(err.Error())) - return (uint64(ptr) << uint64(32)) | uint64(size) | - // Indicate that this is the error string by setting the 32-th bit, assuming that - // no data exceeds 31-bit size (2 GiB). - (1 << 31) - } - - b, err = response.MarshalVT() - if err != nil { - return 0 - } - ptr, size = wasm.ByteToPtr(b) - return (uint64(ptr) << uint64(32)) | uint64(size) -} - -//go:wasmexport metadata_agent_get_artist_url -func _metadata_agent_get_artist_url(ptr, size uint32) uint64 { - b := wasm.PtrToByte(ptr, size) - req := new(ArtistURLRequest) - if err := req.UnmarshalVT(b); err != nil { - return 0 - } - response, err := metadataAgent.GetArtistURL(context.Background(), req) - if err != nil { - ptr, size = wasm.ByteToPtr([]byte(err.Error())) - return (uint64(ptr) << uint64(32)) | uint64(size) | - // Indicate that this is the error string by setting the 32-th bit, assuming that - // no data exceeds 31-bit size (2 GiB). - (1 << 31) - } - - b, err = response.MarshalVT() - if err != nil { - return 0 - } - ptr, size = wasm.ByteToPtr(b) - return (uint64(ptr) << uint64(32)) | uint64(size) -} - -//go:wasmexport metadata_agent_get_artist_biography -func _metadata_agent_get_artist_biography(ptr, size uint32) uint64 { - b := wasm.PtrToByte(ptr, size) - req := new(ArtistBiographyRequest) - if err := req.UnmarshalVT(b); err != nil { - return 0 - } - response, err := metadataAgent.GetArtistBiography(context.Background(), req) - if err != nil { - ptr, size = wasm.ByteToPtr([]byte(err.Error())) - return (uint64(ptr) << uint64(32)) | uint64(size) | - // Indicate that this is the error string by setting the 32-th bit, assuming that - // no data exceeds 31-bit size (2 GiB). - (1 << 31) - } - - b, err = response.MarshalVT() - if err != nil { - return 0 - } - ptr, size = wasm.ByteToPtr(b) - return (uint64(ptr) << uint64(32)) | uint64(size) -} - -//go:wasmexport metadata_agent_get_similar_artists -func _metadata_agent_get_similar_artists(ptr, size uint32) uint64 { - b := wasm.PtrToByte(ptr, size) - req := new(ArtistSimilarRequest) - if err := req.UnmarshalVT(b); err != nil { - return 0 - } - response, err := metadataAgent.GetSimilarArtists(context.Background(), req) - if err != nil { - ptr, size = wasm.ByteToPtr([]byte(err.Error())) - return (uint64(ptr) << uint64(32)) | uint64(size) | - // Indicate that this is the error string by setting the 32-th bit, assuming that - // no data exceeds 31-bit size (2 GiB). - (1 << 31) - } - - b, err = response.MarshalVT() - if err != nil { - return 0 - } - ptr, size = wasm.ByteToPtr(b) - return (uint64(ptr) << uint64(32)) | uint64(size) -} - -//go:wasmexport metadata_agent_get_artist_images -func _metadata_agent_get_artist_images(ptr, size uint32) uint64 { - b := wasm.PtrToByte(ptr, size) - req := new(ArtistImageRequest) - if err := req.UnmarshalVT(b); err != nil { - return 0 - } - response, err := metadataAgent.GetArtistImages(context.Background(), req) - if err != nil { - ptr, size = wasm.ByteToPtr([]byte(err.Error())) - return (uint64(ptr) << uint64(32)) | uint64(size) | - // Indicate that this is the error string by setting the 32-th bit, assuming that - // no data exceeds 31-bit size (2 GiB). - (1 << 31) - } - - b, err = response.MarshalVT() - if err != nil { - return 0 - } - ptr, size = wasm.ByteToPtr(b) - return (uint64(ptr) << uint64(32)) | uint64(size) -} - -//go:wasmexport metadata_agent_get_artist_top_songs -func _metadata_agent_get_artist_top_songs(ptr, size uint32) uint64 { - b := wasm.PtrToByte(ptr, size) - req := new(ArtistTopSongsRequest) - if err := req.UnmarshalVT(b); err != nil { - return 0 - } - response, err := metadataAgent.GetArtistTopSongs(context.Background(), req) - if err != nil { - ptr, size = wasm.ByteToPtr([]byte(err.Error())) - return (uint64(ptr) << uint64(32)) | uint64(size) | - // Indicate that this is the error string by setting the 32-th bit, assuming that - // no data exceeds 31-bit size (2 GiB). - (1 << 31) - } - - b, err = response.MarshalVT() - if err != nil { - return 0 - } - ptr, size = wasm.ByteToPtr(b) - return (uint64(ptr) << uint64(32)) | uint64(size) -} - -//go:wasmexport metadata_agent_get_album_info -func _metadata_agent_get_album_info(ptr, size uint32) uint64 { - b := wasm.PtrToByte(ptr, size) - req := new(AlbumInfoRequest) - if err := req.UnmarshalVT(b); err != nil { - return 0 - } - response, err := metadataAgent.GetAlbumInfo(context.Background(), req) - if err != nil { - ptr, size = wasm.ByteToPtr([]byte(err.Error())) - return (uint64(ptr) << uint64(32)) | uint64(size) | - // Indicate that this is the error string by setting the 32-th bit, assuming that - // no data exceeds 31-bit size (2 GiB). - (1 << 31) - } - - b, err = response.MarshalVT() - if err != nil { - return 0 - } - ptr, size = wasm.ByteToPtr(b) - return (uint64(ptr) << uint64(32)) | uint64(size) -} - -//go:wasmexport metadata_agent_get_album_images -func _metadata_agent_get_album_images(ptr, size uint32) uint64 { - b := wasm.PtrToByte(ptr, size) - req := new(AlbumImagesRequest) - if err := req.UnmarshalVT(b); err != nil { - return 0 - } - response, err := metadataAgent.GetAlbumImages(context.Background(), req) - if err != nil { - ptr, size = wasm.ByteToPtr([]byte(err.Error())) - return (uint64(ptr) << uint64(32)) | uint64(size) | - // Indicate that this is the error string by setting the 32-th bit, assuming that - // no data exceeds 31-bit size (2 GiB). - (1 << 31) - } - - b, err = response.MarshalVT() - if err != nil { - return 0 - } - ptr, size = wasm.ByteToPtr(b) - return (uint64(ptr) << uint64(32)) | uint64(size) -} - -const ScrobblerPluginAPIVersion = 1 - -//go:wasmexport scrobbler_api_version -func _scrobbler_api_version() uint64 { - return ScrobblerPluginAPIVersion -} - -var scrobbler Scrobbler - -func RegisterScrobbler(p Scrobbler) { - scrobbler = p -} - -//go:wasmexport scrobbler_is_authorized -func _scrobbler_is_authorized(ptr, size uint32) uint64 { - b := wasm.PtrToByte(ptr, size) - req := new(ScrobblerIsAuthorizedRequest) - if err := req.UnmarshalVT(b); err != nil { - return 0 - } - response, err := scrobbler.IsAuthorized(context.Background(), req) - if err != nil { - ptr, size = wasm.ByteToPtr([]byte(err.Error())) - return (uint64(ptr) << uint64(32)) | uint64(size) | - // Indicate that this is the error string by setting the 32-th bit, assuming that - // no data exceeds 31-bit size (2 GiB). - (1 << 31) - } - - b, err = response.MarshalVT() - if err != nil { - return 0 - } - ptr, size = wasm.ByteToPtr(b) - return (uint64(ptr) << uint64(32)) | uint64(size) -} - -//go:wasmexport scrobbler_now_playing -func _scrobbler_now_playing(ptr, size uint32) uint64 { - b := wasm.PtrToByte(ptr, size) - req := new(ScrobblerNowPlayingRequest) - if err := req.UnmarshalVT(b); err != nil { - return 0 - } - response, err := scrobbler.NowPlaying(context.Background(), req) - if err != nil { - ptr, size = wasm.ByteToPtr([]byte(err.Error())) - return (uint64(ptr) << uint64(32)) | uint64(size) | - // Indicate that this is the error string by setting the 32-th bit, assuming that - // no data exceeds 31-bit size (2 GiB). - (1 << 31) - } - - b, err = response.MarshalVT() - if err != nil { - return 0 - } - ptr, size = wasm.ByteToPtr(b) - return (uint64(ptr) << uint64(32)) | uint64(size) -} - -//go:wasmexport scrobbler_scrobble -func _scrobbler_scrobble(ptr, size uint32) uint64 { - b := wasm.PtrToByte(ptr, size) - req := new(ScrobblerScrobbleRequest) - if err := req.UnmarshalVT(b); err != nil { - return 0 - } - response, err := scrobbler.Scrobble(context.Background(), req) - if err != nil { - ptr, size = wasm.ByteToPtr([]byte(err.Error())) - return (uint64(ptr) << uint64(32)) | uint64(size) | - // Indicate that this is the error string by setting the 32-th bit, assuming that - // no data exceeds 31-bit size (2 GiB). - (1 << 31) - } - - b, err = response.MarshalVT() - if err != nil { - return 0 - } - ptr, size = wasm.ByteToPtr(b) - return (uint64(ptr) << uint64(32)) | uint64(size) -} - -const SchedulerCallbackPluginAPIVersion = 1 - -//go:wasmexport scheduler_callback_api_version -func _scheduler_callback_api_version() uint64 { - return SchedulerCallbackPluginAPIVersion -} - -var schedulerCallback SchedulerCallback - -func RegisterSchedulerCallback(p SchedulerCallback) { - schedulerCallback = p -} - -//go:wasmexport scheduler_callback_on_scheduler_callback -func _scheduler_callback_on_scheduler_callback(ptr, size uint32) uint64 { - b := wasm.PtrToByte(ptr, size) - req := new(SchedulerCallbackRequest) - if err := req.UnmarshalVT(b); err != nil { - return 0 - } - response, err := schedulerCallback.OnSchedulerCallback(context.Background(), req) - if err != nil { - ptr, size = wasm.ByteToPtr([]byte(err.Error())) - return (uint64(ptr) << uint64(32)) | uint64(size) | - // Indicate that this is the error string by setting the 32-th bit, assuming that - // no data exceeds 31-bit size (2 GiB). - (1 << 31) - } - - b, err = response.MarshalVT() - if err != nil { - return 0 - } - ptr, size = wasm.ByteToPtr(b) - return (uint64(ptr) << uint64(32)) | uint64(size) -} - -const LifecycleManagementPluginAPIVersion = 1 - -//go:wasmexport lifecycle_management_api_version -func _lifecycle_management_api_version() uint64 { - return LifecycleManagementPluginAPIVersion -} - -var lifecycleManagement LifecycleManagement - -func RegisterLifecycleManagement(p LifecycleManagement) { - lifecycleManagement = p -} - -//go:wasmexport lifecycle_management_on_init -func _lifecycle_management_on_init(ptr, size uint32) uint64 { - b := wasm.PtrToByte(ptr, size) - req := new(InitRequest) - if err := req.UnmarshalVT(b); err != nil { - return 0 - } - response, err := lifecycleManagement.OnInit(context.Background(), req) - if err != nil { - ptr, size = wasm.ByteToPtr([]byte(err.Error())) - return (uint64(ptr) << uint64(32)) | uint64(size) | - // Indicate that this is the error string by setting the 32-th bit, assuming that - // no data exceeds 31-bit size (2 GiB). - (1 << 31) - } - - b, err = response.MarshalVT() - if err != nil { - return 0 - } - ptr, size = wasm.ByteToPtr(b) - return (uint64(ptr) << uint64(32)) | uint64(size) -} - -const WebSocketCallbackPluginAPIVersion = 1 - -//go:wasmexport web_socket_callback_api_version -func _web_socket_callback_api_version() uint64 { - return WebSocketCallbackPluginAPIVersion -} - -var webSocketCallback WebSocketCallback - -func RegisterWebSocketCallback(p WebSocketCallback) { - webSocketCallback = p -} - -//go:wasmexport web_socket_callback_on_text_message -func _web_socket_callback_on_text_message(ptr, size uint32) uint64 { - b := wasm.PtrToByte(ptr, size) - req := new(OnTextMessageRequest) - if err := req.UnmarshalVT(b); err != nil { - return 0 - } - response, err := webSocketCallback.OnTextMessage(context.Background(), req) - if err != nil { - ptr, size = wasm.ByteToPtr([]byte(err.Error())) - return (uint64(ptr) << uint64(32)) | uint64(size) | - // Indicate that this is the error string by setting the 32-th bit, assuming that - // no data exceeds 31-bit size (2 GiB). - (1 << 31) - } - - b, err = response.MarshalVT() - if err != nil { - return 0 - } - ptr, size = wasm.ByteToPtr(b) - return (uint64(ptr) << uint64(32)) | uint64(size) -} - -//go:wasmexport web_socket_callback_on_binary_message -func _web_socket_callback_on_binary_message(ptr, size uint32) uint64 { - b := wasm.PtrToByte(ptr, size) - req := new(OnBinaryMessageRequest) - if err := req.UnmarshalVT(b); err != nil { - return 0 - } - response, err := webSocketCallback.OnBinaryMessage(context.Background(), req) - if err != nil { - ptr, size = wasm.ByteToPtr([]byte(err.Error())) - return (uint64(ptr) << uint64(32)) | uint64(size) | - // Indicate that this is the error string by setting the 32-th bit, assuming that - // no data exceeds 31-bit size (2 GiB). - (1 << 31) - } - - b, err = response.MarshalVT() - if err != nil { - return 0 - } - ptr, size = wasm.ByteToPtr(b) - return (uint64(ptr) << uint64(32)) | uint64(size) -} - -//go:wasmexport web_socket_callback_on_error -func _web_socket_callback_on_error(ptr, size uint32) uint64 { - b := wasm.PtrToByte(ptr, size) - req := new(OnErrorRequest) - if err := req.UnmarshalVT(b); err != nil { - return 0 - } - response, err := webSocketCallback.OnError(context.Background(), req) - if err != nil { - ptr, size = wasm.ByteToPtr([]byte(err.Error())) - return (uint64(ptr) << uint64(32)) | uint64(size) | - // Indicate that this is the error string by setting the 32-th bit, assuming that - // no data exceeds 31-bit size (2 GiB). - (1 << 31) - } - - b, err = response.MarshalVT() - if err != nil { - return 0 - } - ptr, size = wasm.ByteToPtr(b) - return (uint64(ptr) << uint64(32)) | uint64(size) -} - -//go:wasmexport web_socket_callback_on_close -func _web_socket_callback_on_close(ptr, size uint32) uint64 { - b := wasm.PtrToByte(ptr, size) - req := new(OnCloseRequest) - if err := req.UnmarshalVT(b); err != nil { - return 0 - } - response, err := webSocketCallback.OnClose(context.Background(), req) - if err != nil { - ptr, size = wasm.ByteToPtr([]byte(err.Error())) - return (uint64(ptr) << uint64(32)) | uint64(size) | - // Indicate that this is the error string by setting the 32-th bit, assuming that - // no data exceeds 31-bit size (2 GiB). - (1 << 31) - } - - b, err = response.MarshalVT() - if err != nil { - return 0 - } - ptr, size = wasm.ByteToPtr(b) - return (uint64(ptr) << uint64(32)) | uint64(size) -} diff --git a/plugins/api/api_plugin_dev.go b/plugins/api/api_plugin_dev.go deleted file mode 100644 index ed5a064b2..000000000 --- a/plugins/api/api_plugin_dev.go +++ /dev/null @@ -1,34 +0,0 @@ -//go:build !wasip1 - -package api - -import "github.com/navidrome/navidrome/plugins/host/scheduler" - -// This file exists to provide stubs for the plugin registration functions when building for non-WASM targets. -// This is useful for testing and development purposes, as it allows you to build and run your plugin code -// without having to compile it to WASM. -// In a real-world scenario, you would compile your plugin to WASM and use the generated registration functions. - -func RegisterMetadataAgent(MetadataAgent) { - panic("not implemented") -} - -func RegisterScrobbler(Scrobbler) { - panic("not implemented") -} - -func RegisterSchedulerCallback(SchedulerCallback) { - panic("not implemented") -} - -func RegisterLifecycleManagement(LifecycleManagement) { - panic("not implemented") -} - -func RegisterWebSocketCallback(WebSocketCallback) { - panic("not implemented") -} - -func RegisterNamedSchedulerCallback(name string, cb SchedulerCallback) scheduler.SchedulerService { - panic("not implemented") -} diff --git a/plugins/api/api_plugin_dev_named_registry.go b/plugins/api/api_plugin_dev_named_registry.go deleted file mode 100644 index 2ddb68779..000000000 --- a/plugins/api/api_plugin_dev_named_registry.go +++ /dev/null @@ -1,94 +0,0 @@ -//go:build wasip1 - -package api - -import ( - "context" - "strings" - - "github.com/navidrome/navidrome/plugins/host/scheduler" -) - -var callbacks = make(namedCallbacks) - -// RegisterNamedSchedulerCallback registers a named scheduler callback. Named callbacks allow multiple callbacks to be registered -// within the same plugin, and for the schedules to be scoped to the named callback. If you only need a single callback, you can use -// the default (unnamed) callback registration function, RegisterSchedulerCallback. -// It returns a scheduler.SchedulerService that can be used to schedule jobs for the named callback. -// -// Notes: -// -// - You can't mix named and unnamed callbacks within the same plugin. -// - The name should be unique within the plugin, and it's recommended to use a short, descriptive name. -// - The name is case-sensitive. -func RegisterNamedSchedulerCallback(name string, cb SchedulerCallback) scheduler.SchedulerService { - callbacks[name] = cb - RegisterSchedulerCallback(&callbacks) - return &namedSchedulerService{name: name, svc: scheduler.NewSchedulerService()} -} - -const zwsp = string('\u200b') - -// namedCallbacks is a map of named scheduler callbacks. The key is the name of the callback, and the value is the callback itself. -type namedCallbacks map[string]SchedulerCallback - -func parseKey(key string) (string, string) { - parts := strings.SplitN(key, zwsp, 2) - if len(parts) != 2 { - return "", "" - } - return parts[0], parts[1] -} - -func (n *namedCallbacks) OnSchedulerCallback(ctx context.Context, req *SchedulerCallbackRequest) (*SchedulerCallbackResponse, error) { - name, scheduleId := parseKey(req.ScheduleId) - cb, exists := callbacks[name] - if !exists { - return nil, nil - } - req.ScheduleId = scheduleId - return cb.OnSchedulerCallback(ctx, req) -} - -// namedSchedulerService is a wrapper around the host scheduler service that prefixes the schedule IDs with the -// callback name. It is returned by RegisterNamedSchedulerCallback, and should be used by the plugin to schedule -// jobs for the named callback. -type namedSchedulerService struct { - name string - cb SchedulerCallback - svc scheduler.SchedulerService -} - -func (n *namedSchedulerService) makeKey(id string) string { - return n.name + zwsp + id -} - -func (n *namedSchedulerService) mapResponse(resp *scheduler.ScheduleResponse, err error) (*scheduler.ScheduleResponse, error) { - if err != nil { - return nil, err - } - _, resp.ScheduleId = parseKey(resp.ScheduleId) - return resp, nil -} - -func (n *namedSchedulerService) ScheduleOneTime(ctx context.Context, request *scheduler.ScheduleOneTimeRequest) (*scheduler.ScheduleResponse, error) { - key := n.makeKey(request.ScheduleId) - request.ScheduleId = key - return n.mapResponse(n.svc.ScheduleOneTime(ctx, request)) -} - -func (n *namedSchedulerService) ScheduleRecurring(ctx context.Context, request *scheduler.ScheduleRecurringRequest) (*scheduler.ScheduleResponse, error) { - key := n.makeKey(request.ScheduleId) - request.ScheduleId = key - return n.mapResponse(n.svc.ScheduleRecurring(ctx, request)) -} - -func (n *namedSchedulerService) CancelSchedule(ctx context.Context, request *scheduler.CancelRequest) (*scheduler.CancelResponse, error) { - key := n.makeKey(request.ScheduleId) - request.ScheduleId = key - return n.svc.CancelSchedule(ctx, request) -} - -func (n *namedSchedulerService) TimeNow(ctx context.Context, request *scheduler.TimeNowRequest) (*scheduler.TimeNowResponse, error) { - return n.svc.TimeNow(ctx, request) -} diff --git a/plugins/api/api_vtproto.pb.go b/plugins/api/api_vtproto.pb.go deleted file mode 100644 index 11caa1946..000000000 --- a/plugins/api/api_vtproto.pb.go +++ /dev/null @@ -1,7315 +0,0 @@ -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: api/api.proto - -package api - -import ( - fmt "fmt" - protoimpl "google.golang.org/protobuf/runtime/protoimpl" - io "io" - bits "math/bits" -) - -const ( - // Verify that this generated code is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion) - // Verify that runtime/protoimpl is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) -) - -func (m *ArtistMBIDRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *ArtistMBIDRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *ArtistMBIDRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Name) > 0 { - i -= len(m.Name) - copy(dAtA[i:], m.Name) - i = encodeVarint(dAtA, i, uint64(len(m.Name))) - i-- - dAtA[i] = 0x12 - } - if len(m.Id) > 0 { - i -= len(m.Id) - copy(dAtA[i:], m.Id) - i = encodeVarint(dAtA, i, uint64(len(m.Id))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *ArtistMBIDResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *ArtistMBIDResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *ArtistMBIDResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Mbid) > 0 { - i -= len(m.Mbid) - copy(dAtA[i:], m.Mbid) - i = encodeVarint(dAtA, i, uint64(len(m.Mbid))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *ArtistURLRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *ArtistURLRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *ArtistURLRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Mbid) > 0 { - i -= len(m.Mbid) - copy(dAtA[i:], m.Mbid) - i = encodeVarint(dAtA, i, uint64(len(m.Mbid))) - i-- - dAtA[i] = 0x1a - } - if len(m.Name) > 0 { - i -= len(m.Name) - copy(dAtA[i:], m.Name) - i = encodeVarint(dAtA, i, uint64(len(m.Name))) - i-- - dAtA[i] = 0x12 - } - if len(m.Id) > 0 { - i -= len(m.Id) - copy(dAtA[i:], m.Id) - i = encodeVarint(dAtA, i, uint64(len(m.Id))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *ArtistURLResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *ArtistURLResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *ArtistURLResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Url) > 0 { - i -= len(m.Url) - copy(dAtA[i:], m.Url) - i = encodeVarint(dAtA, i, uint64(len(m.Url))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *ArtistBiographyRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *ArtistBiographyRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *ArtistBiographyRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Mbid) > 0 { - i -= len(m.Mbid) - copy(dAtA[i:], m.Mbid) - i = encodeVarint(dAtA, i, uint64(len(m.Mbid))) - i-- - dAtA[i] = 0x1a - } - if len(m.Name) > 0 { - i -= len(m.Name) - copy(dAtA[i:], m.Name) - i = encodeVarint(dAtA, i, uint64(len(m.Name))) - i-- - dAtA[i] = 0x12 - } - if len(m.Id) > 0 { - i -= len(m.Id) - copy(dAtA[i:], m.Id) - i = encodeVarint(dAtA, i, uint64(len(m.Id))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *ArtistBiographyResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *ArtistBiographyResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *ArtistBiographyResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Biography) > 0 { - i -= len(m.Biography) - copy(dAtA[i:], m.Biography) - i = encodeVarint(dAtA, i, uint64(len(m.Biography))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *ArtistSimilarRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *ArtistSimilarRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *ArtistSimilarRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if m.Limit != 0 { - i = encodeVarint(dAtA, i, uint64(m.Limit)) - i-- - dAtA[i] = 0x20 - } - if len(m.Mbid) > 0 { - i -= len(m.Mbid) - copy(dAtA[i:], m.Mbid) - i = encodeVarint(dAtA, i, uint64(len(m.Mbid))) - i-- - dAtA[i] = 0x1a - } - if len(m.Name) > 0 { - i -= len(m.Name) - copy(dAtA[i:], m.Name) - i = encodeVarint(dAtA, i, uint64(len(m.Name))) - i-- - dAtA[i] = 0x12 - } - if len(m.Id) > 0 { - i -= len(m.Id) - copy(dAtA[i:], m.Id) - i = encodeVarint(dAtA, i, uint64(len(m.Id))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *Artist) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *Artist) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *Artist) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Mbid) > 0 { - i -= len(m.Mbid) - copy(dAtA[i:], m.Mbid) - i = encodeVarint(dAtA, i, uint64(len(m.Mbid))) - i-- - dAtA[i] = 0x12 - } - if len(m.Name) > 0 { - i -= len(m.Name) - copy(dAtA[i:], m.Name) - i = encodeVarint(dAtA, i, uint64(len(m.Name))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *ArtistSimilarResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *ArtistSimilarResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *ArtistSimilarResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Artists) > 0 { - for iNdEx := len(m.Artists) - 1; iNdEx >= 0; iNdEx-- { - size, err := m.Artists[iNdEx].MarshalToSizedBufferVT(dAtA[:i]) - if err != nil { - return 0, err - } - i -= size - i = encodeVarint(dAtA, i, uint64(size)) - i-- - dAtA[i] = 0xa - } - } - return len(dAtA) - i, nil -} - -func (m *ArtistImageRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *ArtistImageRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *ArtistImageRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Mbid) > 0 { - i -= len(m.Mbid) - copy(dAtA[i:], m.Mbid) - i = encodeVarint(dAtA, i, uint64(len(m.Mbid))) - i-- - dAtA[i] = 0x1a - } - if len(m.Name) > 0 { - i -= len(m.Name) - copy(dAtA[i:], m.Name) - i = encodeVarint(dAtA, i, uint64(len(m.Name))) - i-- - dAtA[i] = 0x12 - } - if len(m.Id) > 0 { - i -= len(m.Id) - copy(dAtA[i:], m.Id) - i = encodeVarint(dAtA, i, uint64(len(m.Id))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *ExternalImage) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *ExternalImage) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *ExternalImage) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if m.Size != 0 { - i = encodeVarint(dAtA, i, uint64(m.Size)) - i-- - dAtA[i] = 0x10 - } - if len(m.Url) > 0 { - i -= len(m.Url) - copy(dAtA[i:], m.Url) - i = encodeVarint(dAtA, i, uint64(len(m.Url))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *ArtistImageResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *ArtistImageResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *ArtistImageResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Images) > 0 { - for iNdEx := len(m.Images) - 1; iNdEx >= 0; iNdEx-- { - size, err := m.Images[iNdEx].MarshalToSizedBufferVT(dAtA[:i]) - if err != nil { - return 0, err - } - i -= size - i = encodeVarint(dAtA, i, uint64(size)) - i-- - dAtA[i] = 0xa - } - } - return len(dAtA) - i, nil -} - -func (m *ArtistTopSongsRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *ArtistTopSongsRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *ArtistTopSongsRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if m.Count != 0 { - i = encodeVarint(dAtA, i, uint64(m.Count)) - i-- - dAtA[i] = 0x20 - } - if len(m.Mbid) > 0 { - i -= len(m.Mbid) - copy(dAtA[i:], m.Mbid) - i = encodeVarint(dAtA, i, uint64(len(m.Mbid))) - i-- - dAtA[i] = 0x1a - } - if len(m.ArtistName) > 0 { - i -= len(m.ArtistName) - copy(dAtA[i:], m.ArtistName) - i = encodeVarint(dAtA, i, uint64(len(m.ArtistName))) - i-- - dAtA[i] = 0x12 - } - if len(m.Id) > 0 { - i -= len(m.Id) - copy(dAtA[i:], m.Id) - i = encodeVarint(dAtA, i, uint64(len(m.Id))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *Song) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *Song) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *Song) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Mbid) > 0 { - i -= len(m.Mbid) - copy(dAtA[i:], m.Mbid) - i = encodeVarint(dAtA, i, uint64(len(m.Mbid))) - i-- - dAtA[i] = 0x12 - } - if len(m.Name) > 0 { - i -= len(m.Name) - copy(dAtA[i:], m.Name) - i = encodeVarint(dAtA, i, uint64(len(m.Name))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *ArtistTopSongsResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *ArtistTopSongsResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *ArtistTopSongsResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Songs) > 0 { - for iNdEx := len(m.Songs) - 1; iNdEx >= 0; iNdEx-- { - size, err := m.Songs[iNdEx].MarshalToSizedBufferVT(dAtA[:i]) - if err != nil { - return 0, err - } - i -= size - i = encodeVarint(dAtA, i, uint64(size)) - i-- - dAtA[i] = 0xa - } - } - return len(dAtA) - i, nil -} - -func (m *AlbumInfoRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *AlbumInfoRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *AlbumInfoRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Mbid) > 0 { - i -= len(m.Mbid) - copy(dAtA[i:], m.Mbid) - i = encodeVarint(dAtA, i, uint64(len(m.Mbid))) - i-- - dAtA[i] = 0x1a - } - if len(m.Artist) > 0 { - i -= len(m.Artist) - copy(dAtA[i:], m.Artist) - i = encodeVarint(dAtA, i, uint64(len(m.Artist))) - i-- - dAtA[i] = 0x12 - } - if len(m.Name) > 0 { - i -= len(m.Name) - copy(dAtA[i:], m.Name) - i = encodeVarint(dAtA, i, uint64(len(m.Name))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *AlbumInfo) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *AlbumInfo) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *AlbumInfo) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Url) > 0 { - i -= len(m.Url) - copy(dAtA[i:], m.Url) - i = encodeVarint(dAtA, i, uint64(len(m.Url))) - i-- - dAtA[i] = 0x22 - } - if len(m.Description) > 0 { - i -= len(m.Description) - copy(dAtA[i:], m.Description) - i = encodeVarint(dAtA, i, uint64(len(m.Description))) - i-- - dAtA[i] = 0x1a - } - if len(m.Mbid) > 0 { - i -= len(m.Mbid) - copy(dAtA[i:], m.Mbid) - i = encodeVarint(dAtA, i, uint64(len(m.Mbid))) - i-- - dAtA[i] = 0x12 - } - if len(m.Name) > 0 { - i -= len(m.Name) - copy(dAtA[i:], m.Name) - i = encodeVarint(dAtA, i, uint64(len(m.Name))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *AlbumInfoResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *AlbumInfoResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *AlbumInfoResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if m.Info != nil { - size, err := m.Info.MarshalToSizedBufferVT(dAtA[:i]) - if err != nil { - return 0, err - } - i -= size - i = encodeVarint(dAtA, i, uint64(size)) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *AlbumImagesRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *AlbumImagesRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *AlbumImagesRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Mbid) > 0 { - i -= len(m.Mbid) - copy(dAtA[i:], m.Mbid) - i = encodeVarint(dAtA, i, uint64(len(m.Mbid))) - i-- - dAtA[i] = 0x1a - } - if len(m.Artist) > 0 { - i -= len(m.Artist) - copy(dAtA[i:], m.Artist) - i = encodeVarint(dAtA, i, uint64(len(m.Artist))) - i-- - dAtA[i] = 0x12 - } - if len(m.Name) > 0 { - i -= len(m.Name) - copy(dAtA[i:], m.Name) - i = encodeVarint(dAtA, i, uint64(len(m.Name))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *AlbumImagesResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *AlbumImagesResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *AlbumImagesResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Images) > 0 { - for iNdEx := len(m.Images) - 1; iNdEx >= 0; iNdEx-- { - size, err := m.Images[iNdEx].MarshalToSizedBufferVT(dAtA[:i]) - if err != nil { - return 0, err - } - i -= size - i = encodeVarint(dAtA, i, uint64(size)) - i-- - dAtA[i] = 0xa - } - } - return len(dAtA) - i, nil -} - -func (m *ScrobblerIsAuthorizedRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *ScrobblerIsAuthorizedRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *ScrobblerIsAuthorizedRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Username) > 0 { - i -= len(m.Username) - copy(dAtA[i:], m.Username) - i = encodeVarint(dAtA, i, uint64(len(m.Username))) - i-- - dAtA[i] = 0x12 - } - if len(m.UserId) > 0 { - i -= len(m.UserId) - copy(dAtA[i:], m.UserId) - i = encodeVarint(dAtA, i, uint64(len(m.UserId))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *ScrobblerIsAuthorizedResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *ScrobblerIsAuthorizedResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *ScrobblerIsAuthorizedResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Error) > 0 { - i -= len(m.Error) - copy(dAtA[i:], m.Error) - i = encodeVarint(dAtA, i, uint64(len(m.Error))) - i-- - dAtA[i] = 0x12 - } - if m.Authorized { - i-- - if m.Authorized { - dAtA[i] = 1 - } else { - dAtA[i] = 0 - } - i-- - dAtA[i] = 0x8 - } - return len(dAtA) - i, nil -} - -func (m *TrackInfo) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *TrackInfo) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *TrackInfo) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if m.Position != 0 { - i = encodeVarint(dAtA, i, uint64(m.Position)) - i-- - dAtA[i] = 0x48 - } - if m.Length != 0 { - i = encodeVarint(dAtA, i, uint64(m.Length)) - i-- - dAtA[i] = 0x40 - } - if len(m.AlbumArtists) > 0 { - for iNdEx := len(m.AlbumArtists) - 1; iNdEx >= 0; iNdEx-- { - size, err := m.AlbumArtists[iNdEx].MarshalToSizedBufferVT(dAtA[:i]) - if err != nil { - return 0, err - } - i -= size - i = encodeVarint(dAtA, i, uint64(size)) - i-- - dAtA[i] = 0x3a - } - } - if len(m.Artists) > 0 { - for iNdEx := len(m.Artists) - 1; iNdEx >= 0; iNdEx-- { - size, err := m.Artists[iNdEx].MarshalToSizedBufferVT(dAtA[:i]) - if err != nil { - return 0, err - } - i -= size - i = encodeVarint(dAtA, i, uint64(size)) - i-- - dAtA[i] = 0x32 - } - } - if len(m.AlbumMbid) > 0 { - i -= len(m.AlbumMbid) - copy(dAtA[i:], m.AlbumMbid) - i = encodeVarint(dAtA, i, uint64(len(m.AlbumMbid))) - i-- - dAtA[i] = 0x2a - } - if len(m.Album) > 0 { - i -= len(m.Album) - copy(dAtA[i:], m.Album) - i = encodeVarint(dAtA, i, uint64(len(m.Album))) - i-- - dAtA[i] = 0x22 - } - if len(m.Name) > 0 { - i -= len(m.Name) - copy(dAtA[i:], m.Name) - i = encodeVarint(dAtA, i, uint64(len(m.Name))) - i-- - dAtA[i] = 0x1a - } - if len(m.Mbid) > 0 { - i -= len(m.Mbid) - copy(dAtA[i:], m.Mbid) - i = encodeVarint(dAtA, i, uint64(len(m.Mbid))) - i-- - dAtA[i] = 0x12 - } - if len(m.Id) > 0 { - i -= len(m.Id) - copy(dAtA[i:], m.Id) - i = encodeVarint(dAtA, i, uint64(len(m.Id))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *ScrobblerNowPlayingRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *ScrobblerNowPlayingRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *ScrobblerNowPlayingRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if m.Timestamp != 0 { - i = encodeVarint(dAtA, i, uint64(m.Timestamp)) - i-- - dAtA[i] = 0x20 - } - if m.Track != nil { - size, err := m.Track.MarshalToSizedBufferVT(dAtA[:i]) - if err != nil { - return 0, err - } - i -= size - i = encodeVarint(dAtA, i, uint64(size)) - i-- - dAtA[i] = 0x1a - } - if len(m.Username) > 0 { - i -= len(m.Username) - copy(dAtA[i:], m.Username) - i = encodeVarint(dAtA, i, uint64(len(m.Username))) - i-- - dAtA[i] = 0x12 - } - if len(m.UserId) > 0 { - i -= len(m.UserId) - copy(dAtA[i:], m.UserId) - i = encodeVarint(dAtA, i, uint64(len(m.UserId))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *ScrobblerNowPlayingResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *ScrobblerNowPlayingResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *ScrobblerNowPlayingResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Error) > 0 { - i -= len(m.Error) - copy(dAtA[i:], m.Error) - i = encodeVarint(dAtA, i, uint64(len(m.Error))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *ScrobblerScrobbleRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *ScrobblerScrobbleRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *ScrobblerScrobbleRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if m.Timestamp != 0 { - i = encodeVarint(dAtA, i, uint64(m.Timestamp)) - i-- - dAtA[i] = 0x20 - } - if m.Track != nil { - size, err := m.Track.MarshalToSizedBufferVT(dAtA[:i]) - if err != nil { - return 0, err - } - i -= size - i = encodeVarint(dAtA, i, uint64(size)) - i-- - dAtA[i] = 0x1a - } - if len(m.Username) > 0 { - i -= len(m.Username) - copy(dAtA[i:], m.Username) - i = encodeVarint(dAtA, i, uint64(len(m.Username))) - i-- - dAtA[i] = 0x12 - } - if len(m.UserId) > 0 { - i -= len(m.UserId) - copy(dAtA[i:], m.UserId) - i = encodeVarint(dAtA, i, uint64(len(m.UserId))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *ScrobblerScrobbleResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *ScrobblerScrobbleResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *ScrobblerScrobbleResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Error) > 0 { - i -= len(m.Error) - copy(dAtA[i:], m.Error) - i = encodeVarint(dAtA, i, uint64(len(m.Error))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *SchedulerCallbackRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *SchedulerCallbackRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *SchedulerCallbackRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if m.IsRecurring { - i-- - if m.IsRecurring { - dAtA[i] = 1 - } else { - dAtA[i] = 0 - } - i-- - dAtA[i] = 0x18 - } - if len(m.Payload) > 0 { - i -= len(m.Payload) - copy(dAtA[i:], m.Payload) - i = encodeVarint(dAtA, i, uint64(len(m.Payload))) - i-- - dAtA[i] = 0x12 - } - if len(m.ScheduleId) > 0 { - i -= len(m.ScheduleId) - copy(dAtA[i:], m.ScheduleId) - i = encodeVarint(dAtA, i, uint64(len(m.ScheduleId))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *SchedulerCallbackResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *SchedulerCallbackResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *SchedulerCallbackResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Error) > 0 { - i -= len(m.Error) - copy(dAtA[i:], m.Error) - i = encodeVarint(dAtA, i, uint64(len(m.Error))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *InitRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *InitRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *InitRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Config) > 0 { - for k := range m.Config { - v := m.Config[k] - baseI := i - i -= len(v) - copy(dAtA[i:], v) - i = encodeVarint(dAtA, i, uint64(len(v))) - i-- - dAtA[i] = 0x12 - i -= len(k) - copy(dAtA[i:], k) - i = encodeVarint(dAtA, i, uint64(len(k))) - i-- - dAtA[i] = 0xa - i = encodeVarint(dAtA, i, uint64(baseI-i)) - i-- - dAtA[i] = 0xa - } - } - return len(dAtA) - i, nil -} - -func (m *InitResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *InitResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *InitResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Error) > 0 { - i -= len(m.Error) - copy(dAtA[i:], m.Error) - i = encodeVarint(dAtA, i, uint64(len(m.Error))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *OnTextMessageRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *OnTextMessageRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *OnTextMessageRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Message) > 0 { - i -= len(m.Message) - copy(dAtA[i:], m.Message) - i = encodeVarint(dAtA, i, uint64(len(m.Message))) - i-- - dAtA[i] = 0x12 - } - if len(m.ConnectionId) > 0 { - i -= len(m.ConnectionId) - copy(dAtA[i:], m.ConnectionId) - i = encodeVarint(dAtA, i, uint64(len(m.ConnectionId))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *OnTextMessageResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *OnTextMessageResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *OnTextMessageResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - return len(dAtA) - i, nil -} - -func (m *OnBinaryMessageRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *OnBinaryMessageRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *OnBinaryMessageRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Data) > 0 { - i -= len(m.Data) - copy(dAtA[i:], m.Data) - i = encodeVarint(dAtA, i, uint64(len(m.Data))) - i-- - dAtA[i] = 0x12 - } - if len(m.ConnectionId) > 0 { - i -= len(m.ConnectionId) - copy(dAtA[i:], m.ConnectionId) - i = encodeVarint(dAtA, i, uint64(len(m.ConnectionId))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *OnBinaryMessageResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *OnBinaryMessageResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *OnBinaryMessageResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - return len(dAtA) - i, nil -} - -func (m *OnErrorRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *OnErrorRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *OnErrorRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Error) > 0 { - i -= len(m.Error) - copy(dAtA[i:], m.Error) - i = encodeVarint(dAtA, i, uint64(len(m.Error))) - i-- - dAtA[i] = 0x12 - } - if len(m.ConnectionId) > 0 { - i -= len(m.ConnectionId) - copy(dAtA[i:], m.ConnectionId) - i = encodeVarint(dAtA, i, uint64(len(m.ConnectionId))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *OnErrorResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *OnErrorResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *OnErrorResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - return len(dAtA) - i, nil -} - -func (m *OnCloseRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *OnCloseRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *OnCloseRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Reason) > 0 { - i -= len(m.Reason) - copy(dAtA[i:], m.Reason) - i = encodeVarint(dAtA, i, uint64(len(m.Reason))) - i-- - dAtA[i] = 0x1a - } - if m.Code != 0 { - i = encodeVarint(dAtA, i, uint64(m.Code)) - i-- - dAtA[i] = 0x10 - } - if len(m.ConnectionId) > 0 { - i -= len(m.ConnectionId) - copy(dAtA[i:], m.ConnectionId) - i = encodeVarint(dAtA, i, uint64(len(m.ConnectionId))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *OnCloseResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *OnCloseResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *OnCloseResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - return len(dAtA) - i, nil -} - -func encodeVarint(dAtA []byte, offset int, v uint64) int { - offset -= sov(v) - base := offset - for v >= 1<<7 { - dAtA[offset] = uint8(v&0x7f | 0x80) - v >>= 7 - offset++ - } - dAtA[offset] = uint8(v) - return base -} -func (m *ArtistMBIDRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Id) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Name) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *ArtistMBIDResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Mbid) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *ArtistURLRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Id) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Name) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Mbid) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *ArtistURLResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Url) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *ArtistBiographyRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Id) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Name) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Mbid) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *ArtistBiographyResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Biography) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *ArtistSimilarRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Id) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Name) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Mbid) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - if m.Limit != 0 { - n += 1 + sov(uint64(m.Limit)) - } - n += len(m.unknownFields) - return n -} - -func (m *Artist) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Name) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Mbid) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *ArtistSimilarResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - if len(m.Artists) > 0 { - for _, e := range m.Artists { - l = e.SizeVT() - n += 1 + l + sov(uint64(l)) - } - } - n += len(m.unknownFields) - return n -} - -func (m *ArtistImageRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Id) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Name) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Mbid) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *ExternalImage) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Url) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - if m.Size != 0 { - n += 1 + sov(uint64(m.Size)) - } - n += len(m.unknownFields) - return n -} - -func (m *ArtistImageResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - if len(m.Images) > 0 { - for _, e := range m.Images { - l = e.SizeVT() - n += 1 + l + sov(uint64(l)) - } - } - n += len(m.unknownFields) - return n -} - -func (m *ArtistTopSongsRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Id) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.ArtistName) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Mbid) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - if m.Count != 0 { - n += 1 + sov(uint64(m.Count)) - } - n += len(m.unknownFields) - return n -} - -func (m *Song) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Name) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Mbid) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *ArtistTopSongsResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - if len(m.Songs) > 0 { - for _, e := range m.Songs { - l = e.SizeVT() - n += 1 + l + sov(uint64(l)) - } - } - n += len(m.unknownFields) - return n -} - -func (m *AlbumInfoRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Name) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Artist) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Mbid) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *AlbumInfo) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Name) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Mbid) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Description) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Url) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *AlbumInfoResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - if m.Info != nil { - l = m.Info.SizeVT() - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *AlbumImagesRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Name) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Artist) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Mbid) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *AlbumImagesResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - if len(m.Images) > 0 { - for _, e := range m.Images { - l = e.SizeVT() - n += 1 + l + sov(uint64(l)) - } - } - n += len(m.unknownFields) - return n -} - -func (m *ScrobblerIsAuthorizedRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.UserId) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Username) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *ScrobblerIsAuthorizedResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - if m.Authorized { - n += 2 - } - l = len(m.Error) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *TrackInfo) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Id) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Mbid) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Name) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Album) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.AlbumMbid) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - if len(m.Artists) > 0 { - for _, e := range m.Artists { - l = e.SizeVT() - n += 1 + l + sov(uint64(l)) - } - } - if len(m.AlbumArtists) > 0 { - for _, e := range m.AlbumArtists { - l = e.SizeVT() - n += 1 + l + sov(uint64(l)) - } - } - if m.Length != 0 { - n += 1 + sov(uint64(m.Length)) - } - if m.Position != 0 { - n += 1 + sov(uint64(m.Position)) - } - n += len(m.unknownFields) - return n -} - -func (m *ScrobblerNowPlayingRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.UserId) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Username) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - if m.Track != nil { - l = m.Track.SizeVT() - n += 1 + l + sov(uint64(l)) - } - if m.Timestamp != 0 { - n += 1 + sov(uint64(m.Timestamp)) - } - n += len(m.unknownFields) - return n -} - -func (m *ScrobblerNowPlayingResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Error) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *ScrobblerScrobbleRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.UserId) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Username) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - if m.Track != nil { - l = m.Track.SizeVT() - n += 1 + l + sov(uint64(l)) - } - if m.Timestamp != 0 { - n += 1 + sov(uint64(m.Timestamp)) - } - n += len(m.unknownFields) - return n -} - -func (m *ScrobblerScrobbleResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Error) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *SchedulerCallbackRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.ScheduleId) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Payload) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - if m.IsRecurring { - n += 2 - } - n += len(m.unknownFields) - return n -} - -func (m *SchedulerCallbackResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Error) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *InitRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - if len(m.Config) > 0 { - for k, v := range m.Config { - _ = k - _ = v - mapEntrySize := 1 + len(k) + sov(uint64(len(k))) + 1 + len(v) + sov(uint64(len(v))) - n += mapEntrySize + 1 + sov(uint64(mapEntrySize)) - } - } - n += len(m.unknownFields) - return n -} - -func (m *InitResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Error) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *OnTextMessageRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.ConnectionId) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Message) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *OnTextMessageResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - n += len(m.unknownFields) - return n -} - -func (m *OnBinaryMessageRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.ConnectionId) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Data) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *OnBinaryMessageResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - n += len(m.unknownFields) - return n -} - -func (m *OnErrorRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.ConnectionId) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Error) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *OnErrorResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - n += len(m.unknownFields) - return n -} - -func (m *OnCloseRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.ConnectionId) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - if m.Code != 0 { - n += 1 + sov(uint64(m.Code)) - } - l = len(m.Reason) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *OnCloseResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - n += len(m.unknownFields) - return n -} - -func sov(x uint64) (n int) { - return (bits.Len64(x|1) + 6) / 7 -} -func soz(x uint64) (n int) { - return sov(uint64((x << 1) ^ uint64((int64(x) >> 63)))) -} -func (m *ArtistMBIDRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: ArtistMBIDRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: ArtistMBIDRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Id", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Id = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Name", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Name = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *ArtistMBIDResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: ArtistMBIDResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: ArtistMBIDResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Mbid", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Mbid = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *ArtistURLRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: ArtistURLRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: ArtistURLRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Id", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Id = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Name", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Name = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 3: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Mbid", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Mbid = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *ArtistURLResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: ArtistURLResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: ArtistURLResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Url", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Url = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *ArtistBiographyRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: ArtistBiographyRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: ArtistBiographyRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Id", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Id = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Name", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Name = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 3: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Mbid", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Mbid = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *ArtistBiographyResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: ArtistBiographyResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: ArtistBiographyResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Biography", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Biography = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *ArtistSimilarRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: ArtistSimilarRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: ArtistSimilarRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Id", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Id = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Name", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Name = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 3: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Mbid", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Mbid = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 4: - if wireType != 0 { - return fmt.Errorf("proto: wrong wireType = %d for field Limit", wireType) - } - m.Limit = 0 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - m.Limit |= int32(b&0x7F) << shift - if b < 0x80 { - break - } - } - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *Artist) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: Artist: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: Artist: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Name", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Name = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Mbid", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Mbid = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *ArtistSimilarResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: ArtistSimilarResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: ArtistSimilarResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Artists", wireType) - } - var msglen int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - msglen |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - if msglen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + msglen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Artists = append(m.Artists, &Artist{}) - if err := m.Artists[len(m.Artists)-1].UnmarshalVT(dAtA[iNdEx:postIndex]); err != nil { - return err - } - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *ArtistImageRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: ArtistImageRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: ArtistImageRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Id", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Id = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Name", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Name = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 3: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Mbid", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Mbid = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *ExternalImage) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: ExternalImage: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: ExternalImage: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Url", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Url = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 0 { - return fmt.Errorf("proto: wrong wireType = %d for field Size", wireType) - } - m.Size = 0 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - m.Size |= int32(b&0x7F) << shift - if b < 0x80 { - break - } - } - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *ArtistImageResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: ArtistImageResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: ArtistImageResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Images", wireType) - } - var msglen int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - msglen |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - if msglen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + msglen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Images = append(m.Images, &ExternalImage{}) - if err := m.Images[len(m.Images)-1].UnmarshalVT(dAtA[iNdEx:postIndex]); err != nil { - return err - } - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *ArtistTopSongsRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: ArtistTopSongsRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: ArtistTopSongsRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Id", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Id = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field ArtistName", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.ArtistName = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 3: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Mbid", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Mbid = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 4: - if wireType != 0 { - return fmt.Errorf("proto: wrong wireType = %d for field Count", wireType) - } - m.Count = 0 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - m.Count |= int32(b&0x7F) << shift - if b < 0x80 { - break - } - } - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *Song) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: Song: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: Song: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Name", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Name = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Mbid", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Mbid = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *ArtistTopSongsResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: ArtistTopSongsResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: ArtistTopSongsResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Songs", wireType) - } - var msglen int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - msglen |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - if msglen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + msglen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Songs = append(m.Songs, &Song{}) - if err := m.Songs[len(m.Songs)-1].UnmarshalVT(dAtA[iNdEx:postIndex]); err != nil { - return err - } - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *AlbumInfoRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: AlbumInfoRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: AlbumInfoRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Name", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Name = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Artist", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Artist = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 3: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Mbid", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Mbid = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *AlbumInfo) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: AlbumInfo: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: AlbumInfo: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Name", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Name = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Mbid", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Mbid = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 3: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Description", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Description = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 4: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Url", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Url = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *AlbumInfoResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: AlbumInfoResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: AlbumInfoResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Info", wireType) - } - var msglen int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - msglen |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - if msglen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + msglen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - if m.Info == nil { - m.Info = &AlbumInfo{} - } - if err := m.Info.UnmarshalVT(dAtA[iNdEx:postIndex]); err != nil { - return err - } - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *AlbumImagesRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: AlbumImagesRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: AlbumImagesRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Name", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Name = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Artist", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Artist = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 3: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Mbid", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Mbid = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *AlbumImagesResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: AlbumImagesResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: AlbumImagesResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Images", wireType) - } - var msglen int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - msglen |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - if msglen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + msglen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Images = append(m.Images, &ExternalImage{}) - if err := m.Images[len(m.Images)-1].UnmarshalVT(dAtA[iNdEx:postIndex]); err != nil { - return err - } - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *ScrobblerIsAuthorizedRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: ScrobblerIsAuthorizedRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: ScrobblerIsAuthorizedRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field UserId", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.UserId = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Username", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Username = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *ScrobblerIsAuthorizedResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: ScrobblerIsAuthorizedResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: ScrobblerIsAuthorizedResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 0 { - return fmt.Errorf("proto: wrong wireType = %d for field Authorized", wireType) - } - var v int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - v |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - m.Authorized = bool(v != 0) - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Error", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Error = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *TrackInfo) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: TrackInfo: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: TrackInfo: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Id", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Id = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Mbid", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Mbid = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 3: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Name", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Name = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 4: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Album", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Album = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 5: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field AlbumMbid", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.AlbumMbid = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 6: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Artists", wireType) - } - var msglen int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - msglen |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - if msglen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + msglen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Artists = append(m.Artists, &Artist{}) - if err := m.Artists[len(m.Artists)-1].UnmarshalVT(dAtA[iNdEx:postIndex]); err != nil { - return err - } - iNdEx = postIndex - case 7: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field AlbumArtists", wireType) - } - var msglen int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - msglen |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - if msglen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + msglen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.AlbumArtists = append(m.AlbumArtists, &Artist{}) - if err := m.AlbumArtists[len(m.AlbumArtists)-1].UnmarshalVT(dAtA[iNdEx:postIndex]); err != nil { - return err - } - iNdEx = postIndex - case 8: - if wireType != 0 { - return fmt.Errorf("proto: wrong wireType = %d for field Length", wireType) - } - m.Length = 0 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - m.Length |= int32(b&0x7F) << shift - if b < 0x80 { - break - } - } - case 9: - if wireType != 0 { - return fmt.Errorf("proto: wrong wireType = %d for field Position", wireType) - } - m.Position = 0 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - m.Position |= int32(b&0x7F) << shift - if b < 0x80 { - break - } - } - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *ScrobblerNowPlayingRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: ScrobblerNowPlayingRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: ScrobblerNowPlayingRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field UserId", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.UserId = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Username", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Username = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 3: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Track", wireType) - } - var msglen int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - msglen |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - if msglen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + msglen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - if m.Track == nil { - m.Track = &TrackInfo{} - } - if err := m.Track.UnmarshalVT(dAtA[iNdEx:postIndex]); err != nil { - return err - } - iNdEx = postIndex - case 4: - if wireType != 0 { - return fmt.Errorf("proto: wrong wireType = %d for field Timestamp", wireType) - } - m.Timestamp = 0 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - m.Timestamp |= int64(b&0x7F) << shift - if b < 0x80 { - break - } - } - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *ScrobblerNowPlayingResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: ScrobblerNowPlayingResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: ScrobblerNowPlayingResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Error", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Error = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *ScrobblerScrobbleRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: ScrobblerScrobbleRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: ScrobblerScrobbleRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field UserId", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.UserId = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Username", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Username = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 3: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Track", wireType) - } - var msglen int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - msglen |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - if msglen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + msglen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - if m.Track == nil { - m.Track = &TrackInfo{} - } - if err := m.Track.UnmarshalVT(dAtA[iNdEx:postIndex]); err != nil { - return err - } - iNdEx = postIndex - case 4: - if wireType != 0 { - return fmt.Errorf("proto: wrong wireType = %d for field Timestamp", wireType) - } - m.Timestamp = 0 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - m.Timestamp |= int64(b&0x7F) << shift - if b < 0x80 { - break - } - } - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *ScrobblerScrobbleResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: ScrobblerScrobbleResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: ScrobblerScrobbleResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Error", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Error = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *SchedulerCallbackRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: SchedulerCallbackRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: SchedulerCallbackRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field ScheduleId", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.ScheduleId = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Payload", wireType) - } - var byteLen int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - byteLen |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - if byteLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + byteLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Payload = append(m.Payload[:0], dAtA[iNdEx:postIndex]...) - if m.Payload == nil { - m.Payload = []byte{} - } - iNdEx = postIndex - case 3: - if wireType != 0 { - return fmt.Errorf("proto: wrong wireType = %d for field IsRecurring", wireType) - } - var v int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - v |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - m.IsRecurring = bool(v != 0) - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *SchedulerCallbackResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: SchedulerCallbackResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: SchedulerCallbackResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Error", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Error = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *InitRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: InitRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: InitRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Config", wireType) - } - var msglen int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - msglen |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - if msglen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + msglen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - if m.Config == nil { - m.Config = make(map[string]string) - } - var mapkey string - var mapvalue string - for iNdEx < postIndex { - entryPreIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - if fieldNum == 1 { - var stringLenmapkey uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLenmapkey |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLenmapkey := int(stringLenmapkey) - if intStringLenmapkey < 0 { - return ErrInvalidLength - } - postStringIndexmapkey := iNdEx + intStringLenmapkey - if postStringIndexmapkey < 0 { - return ErrInvalidLength - } - if postStringIndexmapkey > l { - return io.ErrUnexpectedEOF - } - mapkey = string(dAtA[iNdEx:postStringIndexmapkey]) - iNdEx = postStringIndexmapkey - } else if fieldNum == 2 { - var stringLenmapvalue uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLenmapvalue |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLenmapvalue := int(stringLenmapvalue) - if intStringLenmapvalue < 0 { - return ErrInvalidLength - } - postStringIndexmapvalue := iNdEx + intStringLenmapvalue - if postStringIndexmapvalue < 0 { - return ErrInvalidLength - } - if postStringIndexmapvalue > l { - return io.ErrUnexpectedEOF - } - mapvalue = string(dAtA[iNdEx:postStringIndexmapvalue]) - iNdEx = postStringIndexmapvalue - } else { - iNdEx = entryPreIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > postIndex { - return io.ErrUnexpectedEOF - } - iNdEx += skippy - } - } - m.Config[mapkey] = mapvalue - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *InitResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: InitResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: InitResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Error", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Error = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *OnTextMessageRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: OnTextMessageRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: OnTextMessageRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field ConnectionId", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.ConnectionId = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Message", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Message = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *OnTextMessageResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: OnTextMessageResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: OnTextMessageResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *OnBinaryMessageRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: OnBinaryMessageRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: OnBinaryMessageRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field ConnectionId", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.ConnectionId = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Data", wireType) - } - var byteLen int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - byteLen |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - if byteLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + byteLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Data = append(m.Data[:0], dAtA[iNdEx:postIndex]...) - if m.Data == nil { - m.Data = []byte{} - } - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *OnBinaryMessageResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: OnBinaryMessageResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: OnBinaryMessageResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *OnErrorRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: OnErrorRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: OnErrorRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field ConnectionId", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.ConnectionId = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Error", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Error = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *OnErrorResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: OnErrorResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: OnErrorResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *OnCloseRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: OnCloseRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: OnCloseRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field ConnectionId", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.ConnectionId = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 0 { - return fmt.Errorf("proto: wrong wireType = %d for field Code", wireType) - } - m.Code = 0 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - m.Code |= int32(b&0x7F) << shift - if b < 0x80 { - break - } - } - case 3: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Reason", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Reason = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *OnCloseResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: OnCloseResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: OnCloseResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} - -func skip(dAtA []byte) (n int, err error) { - l := len(dAtA) - iNdEx := 0 - depth := 0 - for iNdEx < l { - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return 0, ErrIntOverflow - } - if iNdEx >= l { - return 0, io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= (uint64(b) & 0x7F) << shift - if b < 0x80 { - break - } - } - wireType := int(wire & 0x7) - switch wireType { - case 0: - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return 0, ErrIntOverflow - } - if iNdEx >= l { - return 0, io.ErrUnexpectedEOF - } - iNdEx++ - if dAtA[iNdEx-1] < 0x80 { - break - } - } - case 1: - iNdEx += 8 - case 2: - var length int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return 0, ErrIntOverflow - } - if iNdEx >= l { - return 0, io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - length |= (int(b) & 0x7F) << shift - if b < 0x80 { - break - } - } - if length < 0 { - return 0, ErrInvalidLength - } - iNdEx += length - case 3: - depth++ - case 4: - if depth == 0 { - return 0, ErrUnexpectedEndOfGroup - } - depth-- - case 5: - iNdEx += 4 - default: - return 0, fmt.Errorf("proto: illegal wireType %d", wireType) - } - if iNdEx < 0 { - return 0, ErrInvalidLength - } - if depth == 0 { - return iNdEx, nil - } - } - return 0, io.ErrUnexpectedEOF -} - -var ( - ErrInvalidLength = fmt.Errorf("proto: negative length found during unmarshaling") - ErrIntOverflow = fmt.Errorf("proto: integer overflow") - ErrUnexpectedEndOfGroup = fmt.Errorf("proto: unexpected end of group") -) diff --git a/plugins/api/errors.go b/plugins/api/errors.go deleted file mode 100644 index 796774b15..000000000 --- a/plugins/api/errors.go +++ /dev/null @@ -1,12 +0,0 @@ -package api - -import "errors" - -var ( - // ErrNotImplemented indicates that the plugin does not implement the requested method. - // No logic should be executed by the plugin. - ErrNotImplemented = errors.New("plugin:not_implemented") - - // ErrNotFound indicates that the requested resource was not found by the plugin. - ErrNotFound = errors.New("plugin:not_found") -) diff --git a/plugins/base_capability.go b/plugins/base_capability.go deleted file mode 100644 index 6572a25ec..000000000 --- a/plugins/base_capability.go +++ /dev/null @@ -1,159 +0,0 @@ -package plugins - -import ( - "context" - "errors" - "fmt" - "time" - - "github.com/navidrome/navidrome/core/metrics" - "github.com/navidrome/navidrome/log" - "github.com/navidrome/navidrome/model/id" - "github.com/navidrome/navidrome/plugins/api" -) - -// newBaseCapability creates a new instance of baseCapability with the required parameters. -func newBaseCapability[S any, P any](wasmPath, id, capability string, m metrics.Metrics, loader P, loadFunc loaderFunc[S, P]) *baseCapability[S, P] { - return &baseCapability[S, P]{ - wasmPath: wasmPath, - id: id, - capability: capability, - loader: loader, - loadFunc: loadFunc, - metrics: m, - } -} - -// LoaderFunc is a generic function type that loads a plugin instance. -type loaderFunc[S any, P any] func(ctx context.Context, loader P, path string) (S, error) - -// baseCapability is a generic base implementation for WASM plugins. -// S is the capability interface type and P is the plugin loader type. -type baseCapability[S any, P any] struct { - wasmPath string - id string - capability string - loader P - loadFunc loaderFunc[S, P] - metrics metrics.Metrics -} - -func (w *baseCapability[S, P]) PluginID() string { - return w.id -} - -func (w *baseCapability[S, P]) serviceName() string { - return w.id + "_" + w.capability -} - -func (w *baseCapability[S, P]) getMetrics() metrics.Metrics { - return w.metrics -} - -// getInstance loads a new plugin instance and returns a cleanup function. -func (w *baseCapability[S, P]) getInstance(ctx context.Context, methodName string) (S, func(), error) { - start := time.Now() - // Add context metadata for tracing - ctx = log.NewContext(ctx, "capability", w.serviceName(), "method", methodName) - - inst, err := w.loadFunc(ctx, w.loader, w.wasmPath) - if err != nil { - var zero S - return zero, func() {}, fmt.Errorf("baseCapability: failed to load instance for %s: %w", w.serviceName(), err) - } - // Add context metadata for tracing - ctx = log.NewContext(ctx, "instanceID", getInstanceID(inst)) - log.Trace(ctx, "baseCapability: loaded instance", "elapsed", time.Since(start)) - return inst, func() { - log.Trace(ctx, "baseCapability: finished using instance", "elapsed", time.Since(start)) - if closer, ok := any(inst).(interface{ Close(context.Context) error }); ok { - _ = closer.Close(ctx) - } - }, nil -} - -type wasmPlugin[S any] interface { - PluginID() string - getInstance(ctx context.Context, methodName string) (S, func(), error) - getMetrics() metrics.Metrics -} - -func callMethod[S any, R any](ctx context.Context, wp WasmPlugin, methodName string, fn func(inst S) (R, error)) (R, error) { - // Add a unique call ID to the context for tracing - ctx = log.NewContext(ctx, "callID", id.NewRandom()) - var r R - - p, ok := wp.(wasmPlugin[S]) - if !ok { - log.Error(ctx, "callMethod: not a wasm plugin", "method", methodName, "pluginID", wp.PluginID()) - return r, fmt.Errorf("wasm plugin: not a wasm plugin: %s", wp.PluginID()) - } - - inst, done, err := p.getInstance(ctx, methodName) - if err != nil { - return r, err - } - start := time.Now() - defer done() - r, err = checkErr(fn(inst)) - elapsed := time.Since(start) - - if !errors.Is(err, api.ErrNotImplemented) { - id := p.PluginID() - isOk := err == nil - metrics := p.getMetrics() - if metrics != nil { - metrics.RecordPluginRequest(ctx, id, methodName, isOk, elapsed.Milliseconds()) - log.Trace(ctx, "callMethod: sending metrics", "plugin", id, "method", methodName, "ok", isOk, "elapsed", elapsed) - } - } - - return r, err -} - -// errorResponse is an interface that defines a method to retrieve an error message. -// It is automatically implemented (generated) by all plugin responses that have an Error field -type errorResponse interface { - GetError() string -} - -// checkErr returns an updated error if the response implements errorResponse and contains an error message. -// If the response is nil, it returns the original error. Otherwise, it wraps or creates an error as needed. -// It also maps error strings to their corresponding api.Err* constants. -func checkErr[T any](resp T, err error) (T, error) { - if any(resp) == nil { - return resp, mapAPIError(err) - } - respErr, ok := any(resp).(errorResponse) - if ok && respErr.GetError() != "" { - respErrMsg := respErr.GetError() - respErrErr := errors.New(respErrMsg) - mappedErr := mapAPIError(respErrErr) - // Check if the error was mapped to an API error (different from the temp error) - if errors.Is(mappedErr, api.ErrNotImplemented) || errors.Is(mappedErr, api.ErrNotFound) { - // Return the mapped API error instead of wrapping - return resp, mappedErr - } - // For non-API errors, use wrap the original error if it is not nil - return resp, errors.Join(respErrErr, err) - } - return resp, mapAPIError(err) -} - -// mapAPIError maps error strings to their corresponding api.Err* constants. -// This is needed as errors from plugins may not be of type api.Error, due to serialization/deserialization. -func mapAPIError(err error) error { - if err == nil { - return nil - } - - errStr := err.Error() - switch errStr { - case api.ErrNotImplemented.Error(): - return api.ErrNotImplemented - case api.ErrNotFound.Error(): - return api.ErrNotFound - default: - return err - } -} diff --git a/plugins/base_capability_test.go b/plugins/base_capability_test.go deleted file mode 100644 index 3bece8dcd..000000000 --- a/plugins/base_capability_test.go +++ /dev/null @@ -1,285 +0,0 @@ -package plugins - -import ( - "context" - "errors" - - "github.com/navidrome/navidrome/plugins/api" - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" -) - -type nilInstance struct{} - -var _ = Describe("baseCapability", func() { - var ctx = context.Background() - - It("should load instance using loadFunc", func() { - called := false - plugin := &baseCapability[*nilInstance, any]{ - wasmPath: "", - id: "test", - capability: "test", - loadFunc: func(ctx context.Context, _ any, path string) (*nilInstance, error) { - called = true - return &nilInstance{}, nil - }, - } - inst, done, err := plugin.getInstance(ctx, "test") - defer done() - Expect(err).To(BeNil()) - Expect(inst).ToNot(BeNil()) - Expect(called).To(BeTrue()) - }) -}) - -var _ = Describe("checkErr", func() { - Context("when resp is nil", func() { - It("should return nil error when both resp and err are nil", func() { - var resp *testErrorResponse - - result, err := checkErr(resp, nil) - - Expect(result).To(BeNil()) - Expect(err).To(BeNil()) - }) - - It("should return original error unchanged for non-API errors", func() { - var resp *testErrorResponse - originalErr := errors.New("original error") - - result, err := checkErr(resp, originalErr) - - Expect(result).To(BeNil()) - Expect(err).To(Equal(originalErr)) - }) - - It("should return mapped API error for ErrNotImplemented", func() { - var resp *testErrorResponse - err := errors.New("plugin:not_implemented") - - result, mappedErr := checkErr(resp, err) - - Expect(result).To(BeNil()) - Expect(mappedErr).To(Equal(api.ErrNotImplemented)) - }) - - It("should return mapped API error for ErrNotFound", func() { - var resp *testErrorResponse - err := errors.New("plugin:not_found") - - result, mappedErr := checkErr(resp, err) - - Expect(result).To(BeNil()) - Expect(mappedErr).To(Equal(api.ErrNotFound)) - }) - }) - - Context("when resp is a typed nil that implements errorResponse", func() { - It("should not panic and return original error", func() { - var resp *testErrorResponse // typed nil - originalErr := errors.New("original error") - - // This should not panic - result, err := checkErr(resp, originalErr) - - Expect(result).To(BeNil()) - Expect(err).To(Equal(originalErr)) - }) - - It("should handle typed nil with nil error gracefully", func() { - var resp *testErrorResponse // typed nil - - // This should not panic - result, err := checkErr(resp, nil) - - Expect(result).To(BeNil()) - Expect(err).To(BeNil()) - }) - }) - - Context("when resp implements errorResponse with non-empty error", func() { - It("should create new error when original error is nil", func() { - resp := &testErrorResponse{errorMsg: "plugin error"} - - result, err := checkErr(resp, nil) - - Expect(result).To(Equal(resp)) - Expect(err).To(MatchError("plugin error")) - }) - - It("should wrap original error when both exist", func() { - resp := &testErrorResponse{errorMsg: "plugin error"} - originalErr := errors.New("original error") - - result, err := checkErr(resp, originalErr) - - Expect(result).To(Equal(resp)) - Expect(err).To(HaveOccurred()) - // Check that both error messages are present in the joined error - errStr := err.Error() - Expect(errStr).To(ContainSubstring("plugin error")) - Expect(errStr).To(ContainSubstring("original error")) - }) - - It("should return mapped API error for ErrNotImplemented when no original error", func() { - resp := &testErrorResponse{errorMsg: "plugin:not_implemented"} - - result, err := checkErr(resp, nil) - - Expect(result).To(Equal(resp)) - Expect(err).To(MatchError(api.ErrNotImplemented)) - }) - - It("should return mapped API error for ErrNotFound when no original error", func() { - resp := &testErrorResponse{errorMsg: "plugin:not_found"} - - result, err := checkErr(resp, nil) - - Expect(result).To(Equal(resp)) - Expect(err).To(MatchError(api.ErrNotFound)) - }) - - It("should return mapped API error for ErrNotImplemented even with original error", func() { - resp := &testErrorResponse{errorMsg: "plugin:not_implemented"} - originalErr := errors.New("original error") - - result, err := checkErr(resp, originalErr) - - Expect(result).To(Equal(resp)) - Expect(err).To(MatchError(api.ErrNotImplemented)) - }) - - It("should return mapped API error for ErrNotFound even with original error", func() { - resp := &testErrorResponse{errorMsg: "plugin:not_found"} - originalErr := errors.New("original error") - - result, err := checkErr(resp, originalErr) - - Expect(result).To(Equal(resp)) - Expect(err).To(MatchError(api.ErrNotFound)) - }) - }) - - Context("when resp implements errorResponse with empty error", func() { - It("should return original error unchanged", func() { - resp := &testErrorResponse{errorMsg: ""} - originalErr := errors.New("original error") - - result, err := checkErr(resp, originalErr) - - Expect(result).To(Equal(resp)) - Expect(err).To(MatchError(originalErr)) - }) - - It("should return nil error when both are empty/nil", func() { - resp := &testErrorResponse{errorMsg: ""} - - result, err := checkErr(resp, nil) - - Expect(result).To(Equal(resp)) - Expect(err).To(BeNil()) - }) - - It("should map original API error when response error is empty", func() { - resp := &testErrorResponse{errorMsg: ""} - originalErr := errors.New("plugin:not_implemented") - - result, err := checkErr(resp, originalErr) - - Expect(result).To(Equal(resp)) - Expect(err).To(MatchError(api.ErrNotImplemented)) - }) - }) - - Context("when resp does not implement errorResponse", func() { - It("should return original error unchanged", func() { - resp := &testNonErrorResponse{data: "some data"} - originalErr := errors.New("original error") - - result, err := checkErr(resp, originalErr) - - Expect(result).To(Equal(resp)) - Expect(err).To(Equal(originalErr)) - }) - - It("should return nil error when original error is nil", func() { - resp := &testNonErrorResponse{data: "some data"} - - result, err := checkErr(resp, nil) - - Expect(result).To(Equal(resp)) - Expect(err).To(BeNil()) - }) - - It("should map original API error when response doesn't implement errorResponse", func() { - resp := &testNonErrorResponse{data: "some data"} - originalErr := errors.New("plugin:not_found") - - result, err := checkErr(resp, originalErr) - - Expect(result).To(Equal(resp)) - Expect(err).To(MatchError(api.ErrNotFound)) - }) - }) - - Context("when resp is a value type (not pointer)", func() { - It("should handle value types that implement errorResponse", func() { - resp := testValueErrorResponse{errorMsg: "value error"} - originalErr := errors.New("original error") - - result, err := checkErr(resp, originalErr) - - Expect(result).To(Equal(resp)) - Expect(err).To(HaveOccurred()) - // Check that both error messages are present in the joined error - errStr := err.Error() - Expect(errStr).To(ContainSubstring("value error")) - Expect(errStr).To(ContainSubstring("original error")) - }) - - It("should handle value types with empty error", func() { - resp := testValueErrorResponse{errorMsg: ""} - originalErr := errors.New("original error") - - result, err := checkErr(resp, originalErr) - - Expect(result).To(Equal(resp)) - Expect(err).To(MatchError(originalErr)) - }) - - It("should handle value types with API error", func() { - resp := testValueErrorResponse{errorMsg: "plugin:not_implemented"} - originalErr := errors.New("original error") - - result, err := checkErr(resp, originalErr) - - Expect(result).To(Equal(resp)) - Expect(err).To(MatchError(api.ErrNotImplemented)) - }) - }) -}) - -// Test helper types -type testErrorResponse struct { - errorMsg string -} - -func (t *testErrorResponse) GetError() string { - if t == nil { - return "" // This is what would typically happen with a typed nil - } - return t.errorMsg -} - -type testNonErrorResponse struct { - data string -} - -type testValueErrorResponse struct { - errorMsg string -} - -func (t testValueErrorResponse) GetError() string { - return t.errorMsg -} diff --git a/plugins/capabilities.go b/plugins/capabilities.go new file mode 100644 index 000000000..81e683b6b --- /dev/null +++ b/plugins/capabilities.go @@ -0,0 +1,41 @@ +package plugins + +import "slices" + +// Capability represents a plugin capability type. +// Capabilities are detected by checking which functions a plugin exports. +type Capability string + +// capabilityFunctions maps each capability to its required/optional functions. +// A plugin has a capability if it exports at least one of these functions. +var capabilityFunctions = map[Capability][]string{} + +// registerCapability registers a capability with its associated functions. +func registerCapability(cap Capability, functions ...string) { + capabilityFunctions[cap] = functions +} + +// functionExistsChecker is an interface for checking if a function exists in a plugin. +// This allows for testing without a real plugin instance. +type functionExistsChecker interface { + FunctionExists(name string) bool +} + +// detectCapabilities detects which capabilities a plugin has by checking +// which functions it exports. +func detectCapabilities(plugin functionExistsChecker) []Capability { + var capabilities []Capability + + for cap, functions := range capabilityFunctions { + if slices.ContainsFunc(functions, plugin.FunctionExists) { + capabilities = append(capabilities, cap) // Found at least one function, plugin has this capability + } + } + + return capabilities +} + +// hasCapability checks if the given capabilities slice contains a specific capability. +func hasCapability(capabilities []Capability, cap Capability) bool { + return slices.Contains(capabilities, cap) +} diff --git a/plugins/capabilities/README.md b/plugins/capabilities/README.md new file mode 100644 index 000000000..fca3cbd31 --- /dev/null +++ b/plugins/capabilities/README.md @@ -0,0 +1,87 @@ +# Navidrome Plugin Capabilities + +This directory contains the Go interface definitions for Navidrome plugin capabilities. These interfaces are the **source of truth** for plugin development and are used to generate: + +1. **Go PDK packages** (`pdk/go/*/`) - Type-safe wrappers for Go plugin developers +2. **Rust PDK crates** (`pdk/rust/*/`) - Type-safe wrappers for Rust plugin developers +3. **XTP YAML schemas** (`*.yaml`) - Schema files for other [Extism plugin languages](https://extism.org/docs/concepts/pdk/) (TypeScript, Python, C#, Zig, C++, ...) + +## For Go Plugin Developers + +Go developers should use the generated PDK packages in `plugins/pdk/go/`. See the example Go plugins in `plugins/examples/` for usage patterns. + +## For Rust Plugin Developers + +Rust developers should use the generated PDK crate in `plugins/pdk/rust/nd-pdk`. See the example Rust plugins in `plugins/examples` for usage patterns. + +## For Non-Go Plugin Developers + +If you're developing plugins in other languages (TypeScript, Rust, Python, C#, Zig, C++), you can use the XTP CLI to generate type-safe bindings from the YAML schema files in this directory. + +### Prerequisites + +Install the XTP CLI: + +```bash +# macOS +brew install dylibso/tap/xtp + +# Other platforms - see https://docs.xtp.dylibso.com/docs/cli +curl https://static.dylibso.com/cli/install.sh | bash +``` + +### Generating Plugin Scaffolding + +Use the XTP CLI to generate plugin boilerplate from any capability schema: + +```bash +# TypeScript +xtp plugin init --schema-file plugins/capabilities/metadata_agent.yaml \ + --template typescript --path my-plugin + +# Rust +xtp plugin init --schema-file plugins/capabilities/scrobbler.yaml \ + --template rust --path my-plugin + +# Python +xtp plugin init --schema-file plugins/capabilities/lifecycle.yaml \ + --template python --path my-plugin + +# C# +xtp plugin init --schema-file plugins/capabilities/scheduler_callback.yaml \ + --template csharp --path my-plugin + +# Go (alternative to using the PDK packages) +xtp plugin init --schema-file plugins/capabilities/websocket_callback.yaml \ + --template go --path my-plugin +``` + +### Available Capabilities + +| Capability | Schema File | Description | +|--------------------|---------------------------|-------------------------------------------------------------| +| Metadata Agent | `metadata_agent.yaml` | Fetch artist biographies, album images, and similar artists | +| Scrobbler | `scrobbler.yaml` | Report listening activity to external services | +| Lifecycle | `lifecycle.yaml` | Plugin initialization callbacks | +| Scheduler Callback | `scheduler_callback.yaml` | Scheduled task execution | +| WebSocket Callback | `websocket_callback.yaml` | Real-time WebSocket message handling | + +### Building Your Plugin + +After generating the scaffolding, implement the required functions and build your plugin as a WebAssembly module. The exact build process depends on your chosen language - see the [Extism PDK documentation](https://extism.org/docs/concepts/pdk) for language-specific guides. + +## XTP Schema Generation + +The YAML schemas in this package are automatically generated from the capability Go interfaces using `ndpgen`. +To regenerate the schemas after modifying the interfaces, run: + +```bash +cd plugins/cmd/ndpgen && go run . -schemas -input=./plugins/capabilities +``` + +## Resources + +- [XTP Documentation](https://docs.xtp.dylibso.com/) +- [XTP Bindgen Repository](https://github.com/dylibso/xtp-bindgen) +- [Extism Plugin Development Kit](https://extism.org/docs/concepts/pdk) +- [XTP Schema Definition](https://raw.githubusercontent.com/dylibso/xtp-bindgen/5090518dd86ba5e734dc225a33066ecc0ed2e12d/plugin/schema.json) diff --git a/plugins/capabilities/doc.go b/plugins/capabilities/doc.go new file mode 100644 index 000000000..fa9b7eb5d --- /dev/null +++ b/plugins/capabilities/doc.go @@ -0,0 +1,56 @@ +// Package capabilities defines Go interfaces for Navidrome plugin capabilities. +// +// These interfaces serve as the source of truth for capability definitions. +// The ndpgen tool generates: +// - Go export wrappers in plugins/pdk/go// for Go plugins +// - XTP YAML schemas for non-Go plugins (Rust, TypeScript, etc.) +// +// Each capability is defined as an annotated interface: +// +// //nd:capability name=metadata +// type MetadataAgent interface { +// //nd:export name=nd_get_artist_biography +// GetArtistBiography(ArtistRequest) (*ArtistBiographyResponse, error) +// } +// +// Annotation Reference: +// +// //nd:capability name= [required=true] +// - Marks an interface as a capability +// - name: Generated package name (e.g., name=metadata → pdk/go/metadata/) +// - required: If true, all methods must be implemented (default: false) +// +// //nd:export name= +// - Marks a method as an exported WASM function +// - name: The export name (e.g., nd_get_artist_biography) +// +// Generated Code Structure: +// +// For a capability like MetadataAgent with required=false: +// +// package metadata +// +// // Agent is the marker interface +// type Agent interface{} +// +// // Optional provider interfaces +// type ArtistBiographyProvider interface { +// GetArtistBiography(ArtistRequest) (*ArtistBiographyResponse, error) +// } +// +// // Registration function +// func Register(impl Agent) { ... } +// +// For a capability with required=true: +// +// package scrobbler +// +// // Scrobbler requires all methods +// type Scrobbler interface { +// IsAuthorized(IsAuthorizedRequest) (bool, error) +// NowPlaying(NowPlayingRequest) error +// Scrobble(ScrobbleRequest) error +// } +// +// func Register(impl Scrobbler) { ... } +package capabilities diff --git a/plugins/capabilities/lifecycle.go b/plugins/capabilities/lifecycle.go new file mode 100644 index 000000000..b5f19ec5b --- /dev/null +++ b/plugins/capabilities/lifecycle.go @@ -0,0 +1,19 @@ +package capabilities + +// Lifecycle provides plugin lifecycle hooks. +// This capability allows plugins to perform initialization when loaded, +// such as establishing connections, starting background processes, or +// validating configuration. +// +// The OnInit function is called once when the plugin is loaded, and is NOT +// called when the plugin is hot-reloaded. Plugins should not assume this +// function will be called on every startup. +// +//nd:capability name=lifecycle +type Lifecycle interface { + // OnInit is called after a plugin is fully loaded with all services registered. + // Plugins can use this function to perform one-time initialization tasks. + // Errors are logged but will not prevent the plugin from being loaded. + //nd:export name=nd_on_init + OnInit() error +} diff --git a/plugins/capabilities/lifecycle.yaml b/plugins/capabilities/lifecycle.yaml new file mode 100644 index 000000000..7c6af62b8 --- /dev/null +++ b/plugins/capabilities/lifecycle.yaml @@ -0,0 +1,7 @@ +version: v1-draft +exports: + nd_on_init: + description: |- + OnInit is called after a plugin is fully loaded with all services registered. + Plugins can use this function to perform one-time initialization tasks. + Errors are logged but will not prevent the plugin from being loaded. diff --git a/plugins/capabilities/lyrics.go b/plugins/capabilities/lyrics.go new file mode 100644 index 000000000..6f6d19177 --- /dev/null +++ b/plugins/capabilities/lyrics.go @@ -0,0 +1,26 @@ +package capabilities + +// Lyrics provides lyrics for a given track from external sources. +// +//nd:capability name=lyrics required=true +type Lyrics interface { + //nd:export name=nd_lyrics_get_lyrics + GetLyrics(GetLyricsRequest) (GetLyricsResponse, error) +} + +// GetLyricsRequest contains the track information for lyrics lookup. +type GetLyricsRequest struct { + Track TrackInfo `json:"track"` +} + +// GetLyricsResponse contains the lyrics returned by the plugin. +type GetLyricsResponse struct { + Lyrics []LyricsText `json:"lyrics"` +} + +// LyricsText represents a single set of lyrics in raw text format. +// Text can be plain text or LRC format — Navidrome will parse it. +type LyricsText struct { + Lang string `json:"lang,omitempty"` + Text string `json:"text"` +} diff --git a/plugins/capabilities/lyrics.yaml b/plugins/capabilities/lyrics.yaml new file mode 100644 index 000000000..e4f88476c --- /dev/null +++ b/plugins/capabilities/lyrics.yaml @@ -0,0 +1,115 @@ +version: v1-draft +exports: + nd_lyrics_get_lyrics: + input: + $ref: '#/components/schemas/GetLyricsRequest' + contentType: application/json + output: + $ref: '#/components/schemas/GetLyricsResponse' + contentType: application/json +components: + schemas: + ArtistRef: + description: ArtistRef is a reference to an artist with name and optional MBID. + properties: + id: + type: string + description: ID is the internal Navidrome artist ID (if known). + name: + type: string + description: Name is the artist name. + mbid: + type: string + description: MBID is the MusicBrainz ID for the artist. + required: + - name + GetLyricsRequest: + description: GetLyricsRequest contains the track information for lyrics lookup. + properties: + track: + $ref: '#/components/schemas/TrackInfo' + required: + - track + GetLyricsResponse: + description: GetLyricsResponse contains the lyrics returned by the plugin. + properties: + lyrics: + type: array + items: + $ref: '#/components/schemas/LyricsText' + required: + - lyrics + LyricsText: + description: |- + LyricsText represents a single set of lyrics in raw text format. + Text can be plain text or LRC format — Navidrome will parse it. + properties: + lang: + type: string + text: + type: string + required: + - text + TrackInfo: + description: TrackInfo contains track metadata. + properties: + id: + type: string + description: ID is the internal Navidrome track ID. + title: + type: string + description: Title is the track title. + album: + type: string + description: Album is the album name. + artist: + type: string + description: Artist is the formatted artist name for display (e.g., "Artist1 • Artist2"). + albumArtist: + type: string + description: AlbumArtist is the formatted album artist name for display. + artists: + type: array + description: Artists is the list of track artists. + items: + $ref: '#/components/schemas/ArtistRef' + albumArtists: + type: array + description: AlbumArtists is the list of album artists. + items: + $ref: '#/components/schemas/ArtistRef' + duration: + type: number + format: float + description: Duration is the track duration in seconds. + trackNumber: + type: integer + format: int32 + description: TrackNumber is the track number on the album. + discNumber: + type: integer + format: int32 + description: DiscNumber is the disc number. + mbzRecordingId: + type: string + description: MBZRecordingID is the MusicBrainz recording ID. + mbzAlbumId: + type: string + description: MBZAlbumID is the MusicBrainz album/release ID. + mbzReleaseGroupId: + type: string + description: MBZReleaseGroupID is the MusicBrainz release group ID. + mbzReleaseTrackId: + type: string + description: MBZReleaseTrackID is the MusicBrainz release track ID. + required: + - id + - title + - album + - artist + - albumArtist + - artists + - albumArtists + - duration + - trackNumber + - discNumber diff --git a/plugins/capabilities/metadata_agent.go b/plugins/capabilities/metadata_agent.go new file mode 100644 index 000000000..407f21ec5 --- /dev/null +++ b/plugins/capabilities/metadata_agent.go @@ -0,0 +1,237 @@ +package capabilities + +// MetadataAgent provides artist and album metadata retrieval. +// This capability allows plugins to provide external metadata for artists and albums, +// such as biographies, images, similar artists, and top songs. +// +// Plugins implementing this capability can choose which methods to implement. +// Each method is optional - plugins only need to provide the functionality they support. +// +//nd:capability name=metadata +type MetadataAgent interface { + // GetArtistMBID retrieves the MusicBrainz ID for an artist. + //nd:export name=nd_get_artist_mbid + GetArtistMBID(ArtistMBIDRequest) (*ArtistMBIDResponse, error) + + // GetArtistURL retrieves the external URL for an artist. + //nd:export name=nd_get_artist_url + GetArtistURL(ArtistRequest) (*ArtistURLResponse, error) + + // GetArtistBiography retrieves the biography for an artist. + //nd:export name=nd_get_artist_biography + GetArtistBiography(ArtistRequest) (*ArtistBiographyResponse, error) + + // GetSimilarArtists retrieves similar artists for a given artist. + //nd:export name=nd_get_similar_artists + GetSimilarArtists(SimilarArtistsRequest) (*SimilarArtistsResponse, error) + + // GetArtistImages retrieves images for an artist. + //nd:export name=nd_get_artist_images + GetArtistImages(ArtistRequest) (*ArtistImagesResponse, error) + + // GetArtistTopSongs retrieves top songs for an artist. + //nd:export name=nd_get_artist_top_songs + GetArtistTopSongs(TopSongsRequest) (*TopSongsResponse, error) + + // GetAlbumInfo retrieves album information. + //nd:export name=nd_get_album_info + GetAlbumInfo(AlbumRequest) (*AlbumInfoResponse, error) + + // GetAlbumImages retrieves images for an album. + //nd:export name=nd_get_album_images + GetAlbumImages(AlbumRequest) (*AlbumImagesResponse, error) + + // GetSimilarSongsByTrack retrieves songs similar to a specific track. + //nd:export name=nd_get_similar_songs_by_track + GetSimilarSongsByTrack(SimilarSongsByTrackRequest) (*SimilarSongsResponse, error) + + // GetSimilarSongsByAlbum retrieves songs similar to tracks on an album. + //nd:export name=nd_get_similar_songs_by_album + GetSimilarSongsByAlbum(SimilarSongsByAlbumRequest) (*SimilarSongsResponse, error) + + // GetSimilarSongsByArtist retrieves songs similar to an artist's catalog. + //nd:export name=nd_get_similar_songs_by_artist + GetSimilarSongsByArtist(SimilarSongsByArtistRequest) (*SimilarSongsResponse, error) +} + +// ArtistMBIDRequest is the request for GetArtistMBID. +type ArtistMBIDRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` +} + +// ArtistMBIDResponse is the response for GetArtistMBID. +type ArtistMBIDResponse struct { + // MBID is the MusicBrainz ID for the artist. + MBID string `json:"mbid"` +} + +// ArtistRequest is the common request for artist-related functions. +type ArtistRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the artist (if known). + MBID string `json:"mbid,omitempty"` +} + +// ArtistURLResponse is the response for GetArtistURL. +type ArtistURLResponse struct { + // URL is the external URL for the artist. + URL string `json:"url"` +} + +// ArtistBiographyResponse is the response for GetArtistBiography. +type ArtistBiographyResponse struct { + // Biography is the artist biography text. + Biography string `json:"biography"` +} + +// SimilarArtistsRequest is the request for GetSimilarArtists. +type SimilarArtistsRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the artist (if known). + MBID string `json:"mbid,omitempty"` + // Limit is the maximum number of similar artists to return. + Limit int32 `json:"limit"` +} + +// SimilarArtistsResponse is the response for GetSimilarArtists. +type SimilarArtistsResponse struct { + // Artists is the list of similar artists. + Artists []ArtistRef `json:"artists"` +} + +// ImageInfo represents an image with URL and size. +type ImageInfo struct { + // URL is the URL of the image. + URL string `json:"url"` + // Size is the size of the image in pixels (width or height). + Size int32 `json:"size"` +} + +// ArtistImagesResponse is the response for GetArtistImages. +type ArtistImagesResponse struct { + // Images is the list of artist images. + Images []ImageInfo `json:"images"` +} + +// TopSongsRequest is the request for GetArtistTopSongs. +type TopSongsRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the artist (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of top songs to return. + Count int32 `json:"count"` +} + +// SongRef is a reference to a song with metadata for matching. +type SongRef struct { + // ID is the internal Navidrome mediafile ID (if known). + ID string `json:"id,omitempty"` + // Name is the song name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the song. + MBID string `json:"mbid,omitempty"` + // ISRC is the International Standard Recording Code for the song. + ISRC string `json:"isrc,omitempty"` + // Artist is the artist name. + Artist string `json:"artist,omitempty"` + // ArtistMBID is the MusicBrainz artist ID. + ArtistMBID string `json:"artistMbid,omitempty"` + // Album is the album name. + Album string `json:"album,omitempty"` + // AlbumMBID is the MusicBrainz release ID. + AlbumMBID string `json:"albumMbid,omitempty"` + // Duration is the song duration in seconds. + Duration float32 `json:"duration,omitempty"` +} + +// TopSongsResponse is the response for GetArtistTopSongs. +type TopSongsResponse struct { + // Songs is the list of top songs. + Songs []SongRef `json:"songs"` +} + +// AlbumRequest is the common request for album-related functions. +type AlbumRequest struct { + // Name is the album name. + Name string `json:"name"` + // Artist is the album artist name. + Artist string `json:"artist"` + // MBID is the MusicBrainz ID for the album (if known). + MBID string `json:"mbid,omitempty"` +} + +// AlbumInfoResponse is the response for GetAlbumInfo. +type AlbumInfoResponse struct { + // Name is the album name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the album. + MBID string `json:"mbid"` + // Description is the album description/notes. + Description string `json:"description"` + // URL is the external URL for the album. + URL string `json:"url"` +} + +// AlbumImagesResponse is the response for GetAlbumImages. +type AlbumImagesResponse struct { + // Images is the list of album images. + Images []ImageInfo `json:"images"` +} + +// SimilarSongsByTrackRequest is the request for GetSimilarSongsByTrack. +type SimilarSongsByTrackRequest struct { + // ID is the internal Navidrome mediafile ID. + ID string `json:"id"` + // Name is the track title. + Name string `json:"name"` + // Artist is the artist name. + Artist string `json:"artist"` + // MBID is the MusicBrainz recording ID (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of similar songs to return. + Count int32 `json:"count"` +} + +// SimilarSongsByAlbumRequest is the request for GetSimilarSongsByAlbum. +type SimilarSongsByAlbumRequest struct { + // ID is the internal Navidrome album ID. + ID string `json:"id"` + // Name is the album name. + Name string `json:"name"` + // Artist is the album artist name. + Artist string `json:"artist"` + // MBID is the MusicBrainz release ID (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of similar songs to return. + Count int32 `json:"count"` +} + +// SimilarSongsByArtistRequest is the request for GetSimilarSongsByArtist. +type SimilarSongsByArtistRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz artist ID (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of similar songs to return. + Count int32 `json:"count"` +} + +// SimilarSongsResponse is the response for GetSimilarSongsBy* functions. +type SimilarSongsResponse struct { + // Songs is the list of similar songs. + Songs []SongRef `json:"songs"` +} diff --git a/plugins/capabilities/metadata_agent.yaml b/plugins/capabilities/metadata_agent.yaml new file mode 100644 index 000000000..4940a5056 --- /dev/null +++ b/plugins/capabilities/metadata_agent.yaml @@ -0,0 +1,396 @@ +version: v1-draft +exports: + nd_get_artist_mbid: + description: GetArtistMBID retrieves the MusicBrainz ID for an artist. + input: + $ref: '#/components/schemas/ArtistMBIDRequest' + contentType: application/json + output: + $ref: '#/components/schemas/ArtistMBIDResponse' + contentType: application/json + nd_get_artist_url: + description: GetArtistURL retrieves the external URL for an artist. + input: + $ref: '#/components/schemas/ArtistRequest' + contentType: application/json + output: + $ref: '#/components/schemas/ArtistURLResponse' + contentType: application/json + nd_get_artist_biography: + description: GetArtistBiography retrieves the biography for an artist. + input: + $ref: '#/components/schemas/ArtistRequest' + contentType: application/json + output: + $ref: '#/components/schemas/ArtistBiographyResponse' + contentType: application/json + nd_get_similar_artists: + description: GetSimilarArtists retrieves similar artists for a given artist. + input: + $ref: '#/components/schemas/SimilarArtistsRequest' + contentType: application/json + output: + $ref: '#/components/schemas/SimilarArtistsResponse' + contentType: application/json + nd_get_artist_images: + description: GetArtistImages retrieves images for an artist. + input: + $ref: '#/components/schemas/ArtistRequest' + contentType: application/json + output: + $ref: '#/components/schemas/ArtistImagesResponse' + contentType: application/json + nd_get_artist_top_songs: + description: GetArtistTopSongs retrieves top songs for an artist. + input: + $ref: '#/components/schemas/TopSongsRequest' + contentType: application/json + output: + $ref: '#/components/schemas/TopSongsResponse' + contentType: application/json + nd_get_album_info: + description: GetAlbumInfo retrieves album information. + input: + $ref: '#/components/schemas/AlbumRequest' + contentType: application/json + output: + $ref: '#/components/schemas/AlbumInfoResponse' + contentType: application/json + nd_get_album_images: + description: GetAlbumImages retrieves images for an album. + input: + $ref: '#/components/schemas/AlbumRequest' + contentType: application/json + output: + $ref: '#/components/schemas/AlbumImagesResponse' + contentType: application/json + nd_get_similar_songs_by_track: + description: GetSimilarSongsByTrack retrieves songs similar to a specific track. + input: + $ref: '#/components/schemas/SimilarSongsByTrackRequest' + contentType: application/json + output: + $ref: '#/components/schemas/SimilarSongsResponse' + contentType: application/json + nd_get_similar_songs_by_album: + description: GetSimilarSongsByAlbum retrieves songs similar to tracks on an album. + input: + $ref: '#/components/schemas/SimilarSongsByAlbumRequest' + contentType: application/json + output: + $ref: '#/components/schemas/SimilarSongsResponse' + contentType: application/json + nd_get_similar_songs_by_artist: + description: GetSimilarSongsByArtist retrieves songs similar to an artist's catalog. + input: + $ref: '#/components/schemas/SimilarSongsByArtistRequest' + contentType: application/json + output: + $ref: '#/components/schemas/SimilarSongsResponse' + contentType: application/json +components: + schemas: + AlbumImagesResponse: + description: AlbumImagesResponse is the response for GetAlbumImages. + properties: + images: + type: array + description: Images is the list of album images. + items: + $ref: '#/components/schemas/ImageInfo' + required: + - images + AlbumInfoResponse: + description: AlbumInfoResponse is the response for GetAlbumInfo. + properties: + name: + type: string + description: Name is the album name. + mbid: + type: string + description: MBID is the MusicBrainz ID for the album. + description: + type: string + description: Description is the album description/notes. + url: + type: string + description: URL is the external URL for the album. + required: + - name + - mbid + - description + - url + AlbumRequest: + description: AlbumRequest is the common request for album-related functions. + properties: + name: + type: string + description: Name is the album name. + artist: + type: string + description: Artist is the album artist name. + mbid: + type: string + description: MBID is the MusicBrainz ID for the album (if known). + required: + - name + - artist + ArtistBiographyResponse: + description: ArtistBiographyResponse is the response for GetArtistBiography. + properties: + biography: + type: string + description: Biography is the artist biography text. + required: + - biography + ArtistImagesResponse: + description: ArtistImagesResponse is the response for GetArtistImages. + properties: + images: + type: array + description: Images is the list of artist images. + items: + $ref: '#/components/schemas/ImageInfo' + required: + - images + ArtistMBIDRequest: + description: ArtistMBIDRequest is the request for GetArtistMBID. + properties: + id: + type: string + description: ID is the internal Navidrome artist ID. + name: + type: string + description: Name is the artist name. + required: + - id + - name + ArtistMBIDResponse: + description: ArtistMBIDResponse is the response for GetArtistMBID. + properties: + mbid: + type: string + description: MBID is the MusicBrainz ID for the artist. + required: + - mbid + ArtistRef: + description: ArtistRef is a reference to an artist with name and optional MBID. + properties: + id: + type: string + description: ID is the internal Navidrome artist ID (if known). + name: + type: string + description: Name is the artist name. + mbid: + type: string + description: MBID is the MusicBrainz ID for the artist. + required: + - name + ArtistRequest: + description: ArtistRequest is the common request for artist-related functions. + properties: + id: + type: string + description: ID is the internal Navidrome artist ID. + name: + type: string + description: Name is the artist name. + mbid: + type: string + description: MBID is the MusicBrainz ID for the artist (if known). + required: + - id + - name + ArtistURLResponse: + description: ArtistURLResponse is the response for GetArtistURL. + properties: + url: + type: string + description: URL is the external URL for the artist. + required: + - url + ImageInfo: + description: ImageInfo represents an image with URL and size. + properties: + url: + type: string + description: URL is the URL of the image. + size: + type: integer + format: int32 + description: Size is the size of the image in pixels (width or height). + required: + - url + - size + SimilarArtistsRequest: + description: SimilarArtistsRequest is the request for GetSimilarArtists. + properties: + id: + type: string + description: ID is the internal Navidrome artist ID. + name: + type: string + description: Name is the artist name. + mbid: + type: string + description: MBID is the MusicBrainz ID for the artist (if known). + limit: + type: integer + format: int32 + description: Limit is the maximum number of similar artists to return. + required: + - id + - name + - limit + SimilarArtistsResponse: + description: SimilarArtistsResponse is the response for GetSimilarArtists. + properties: + artists: + type: array + description: Artists is the list of similar artists. + items: + $ref: '#/components/schemas/ArtistRef' + required: + - artists + SimilarSongsByAlbumRequest: + description: SimilarSongsByAlbumRequest is the request for GetSimilarSongsByAlbum. + properties: + id: + type: string + description: ID is the internal Navidrome album ID. + name: + type: string + description: Name is the album name. + artist: + type: string + description: Artist is the album artist name. + mbid: + type: string + description: MBID is the MusicBrainz release ID (if known). + count: + type: integer + format: int32 + description: Count is the maximum number of similar songs to return. + required: + - id + - name + - artist + - count + SimilarSongsByArtistRequest: + description: SimilarSongsByArtistRequest is the request for GetSimilarSongsByArtist. + properties: + id: + type: string + description: ID is the internal Navidrome artist ID. + name: + type: string + description: Name is the artist name. + mbid: + type: string + description: MBID is the MusicBrainz artist ID (if known). + count: + type: integer + format: int32 + description: Count is the maximum number of similar songs to return. + required: + - id + - name + - count + SimilarSongsByTrackRequest: + description: SimilarSongsByTrackRequest is the request for GetSimilarSongsByTrack. + properties: + id: + type: string + description: ID is the internal Navidrome mediafile ID. + name: + type: string + description: Name is the track title. + artist: + type: string + description: Artist is the artist name. + mbid: + type: string + description: MBID is the MusicBrainz recording ID (if known). + count: + type: integer + format: int32 + description: Count is the maximum number of similar songs to return. + required: + - id + - name + - artist + - count + SimilarSongsResponse: + description: SimilarSongsResponse is the response for GetSimilarSongsBy* functions. + properties: + songs: + type: array + description: Songs is the list of similar songs. + items: + $ref: '#/components/schemas/SongRef' + required: + - songs + SongRef: + description: SongRef is a reference to a song with metadata for matching. + properties: + id: + type: string + description: ID is the internal Navidrome mediafile ID (if known). + name: + type: string + description: Name is the song name. + mbid: + type: string + description: MBID is the MusicBrainz ID for the song. + isrc: + type: string + description: ISRC is the International Standard Recording Code for the song. + artist: + type: string + description: Artist is the artist name. + artistMbid: + type: string + description: ArtistMBID is the MusicBrainz artist ID. + album: + type: string + description: Album is the album name. + albumMbid: + type: string + description: AlbumMBID is the MusicBrainz release ID. + duration: + type: number + format: float + description: Duration is the song duration in seconds. + required: + - name + TopSongsRequest: + description: TopSongsRequest is the request for GetArtistTopSongs. + properties: + id: + type: string + description: ID is the internal Navidrome artist ID. + name: + type: string + description: Name is the artist name. + mbid: + type: string + description: MBID is the MusicBrainz ID for the artist (if known). + count: + type: integer + format: int32 + description: Count is the maximum number of top songs to return. + required: + - id + - name + - count + TopSongsResponse: + description: TopSongsResponse is the response for GetArtistTopSongs. + properties: + songs: + type: array + description: Songs is the list of top songs. + items: + $ref: '#/components/schemas/SongRef' + required: + - songs diff --git a/plugins/capabilities/scheduler_callback.go b/plugins/capabilities/scheduler_callback.go new file mode 100644 index 000000000..93f66f10d --- /dev/null +++ b/plugins/capabilities/scheduler_callback.go @@ -0,0 +1,27 @@ +package capabilities + +// SchedulerCallback provides scheduled task handling. +// This capability allows plugins to receive callbacks when their scheduled tasks execute. +// Plugins that use the scheduler host service must implement this capability +// to handle task execution. +// +//nd:capability name=scheduler +type SchedulerCallback interface { + // OnCallback is called when a scheduled task fires. + // Errors are logged but do not affect the scheduling system. + //nd:export name=nd_scheduler_callback + OnCallback(SchedulerCallbackRequest) error +} + +// SchedulerCallbackRequest is the request provided when a scheduled task fires. +type SchedulerCallbackRequest struct { + // ScheduleID is the unique identifier for this scheduled task. + // This is either the ID provided when scheduling, or an auto-generated UUID if none was specified. + ScheduleID string `json:"scheduleId"` + // Payload is the payload data that was provided when the task was scheduled. + // Can be used to pass context or parameters to the callback handler. + Payload string `json:"payload"` + // IsRecurring is true if this is a recurring schedule (created via ScheduleRecurring), + // false if it's a one-time schedule (created via ScheduleOneTime). + IsRecurring bool `json:"isRecurring"` +} diff --git a/plugins/capabilities/scheduler_callback.yaml b/plugins/capabilities/scheduler_callback.yaml new file mode 100644 index 000000000..9a081cd08 --- /dev/null +++ b/plugins/capabilities/scheduler_callback.yaml @@ -0,0 +1,33 @@ +version: v1-draft +exports: + nd_scheduler_callback: + description: |- + OnCallback is called when a scheduled task fires. + Errors are logged but do not affect the scheduling system. + input: + $ref: '#/components/schemas/SchedulerCallbackRequest' + contentType: application/json +components: + schemas: + SchedulerCallbackRequest: + description: SchedulerCallbackRequest is the request provided when a scheduled task fires. + properties: + scheduleId: + type: string + description: |- + ScheduleID is the unique identifier for this scheduled task. + This is either the ID provided when scheduling, or an auto-generated UUID if none was specified. + payload: + type: string + description: |- + Payload is the payload data that was provided when the task was scheduled. + Can be used to pass context or parameters to the callback handler. + isRecurring: + type: boolean + description: |- + IsRecurring is true if this is a recurring schedule (created via ScheduleRecurring), + false if it's a one-time schedule (created via ScheduleOneTime). + required: + - scheduleId + - payload + - isRecurring diff --git a/plugins/capabilities/scrobbler.go b/plugins/capabilities/scrobbler.go new file mode 100644 index 000000000..8091efe50 --- /dev/null +++ b/plugins/capabilities/scrobbler.go @@ -0,0 +1,106 @@ +package capabilities + +// Scrobbler provides scrobbling functionality to external services. +// This capability allows plugins to submit listening history to services like Last.fm, +// ListenBrainz, or custom scrobbling backends. +// +// All methods are required - plugins implementing this capability must provide +// all three functions: IsAuthorized, NowPlaying, and Scrobble. +// +//nd:capability name=scrobbler required=true +type Scrobbler interface { + // IsAuthorized checks if a user is authorized to scrobble to this service. + //nd:export name=nd_scrobbler_is_authorized + IsAuthorized(IsAuthorizedRequest) (bool, error) + + // NowPlaying sends a now playing notification to the scrobbling service. + //nd:export name=nd_scrobbler_now_playing + NowPlaying(NowPlayingRequest) error + + // Scrobble submits a completed scrobble to the scrobbling service. + //nd:export name=nd_scrobbler_scrobble + Scrobble(ScrobbleRequest) error +} + +// IsAuthorizedRequest is the request for authorization check. +type IsAuthorizedRequest struct { + // Username is the username of the user. + Username string `json:"username"` +} + +// ArtistRef is a reference to an artist with name and optional MBID. +type ArtistRef struct { + // ID is the internal Navidrome artist ID (if known). + ID string `json:"id,omitempty"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the artist. + MBID string `json:"mbid,omitempty"` +} + +// TrackInfo contains track metadata. +type TrackInfo struct { + // ID is the internal Navidrome track ID. + ID string `json:"id"` + // Title is the track title. + Title string `json:"title"` + // Album is the album name. + Album string `json:"album"` + // Artist is the formatted artist name for display (e.g., "Artist1 • Artist2"). + Artist string `json:"artist"` + // AlbumArtist is the formatted album artist name for display. + AlbumArtist string `json:"albumArtist"` + // Artists is the list of track artists. + Artists []ArtistRef `json:"artists"` + // AlbumArtists is the list of album artists. + AlbumArtists []ArtistRef `json:"albumArtists"` + // Duration is the track duration in seconds. + Duration float32 `json:"duration"` + // TrackNumber is the track number on the album. + TrackNumber int32 `json:"trackNumber"` + // DiscNumber is the disc number. + DiscNumber int32 `json:"discNumber"` + // MBZRecordingID is the MusicBrainz recording ID. + MBZRecordingID string `json:"mbzRecordingId,omitempty"` + // MBZAlbumID is the MusicBrainz album/release ID. + MBZAlbumID string `json:"mbzAlbumId,omitempty"` + // MBZReleaseGroupID is the MusicBrainz release group ID. + MBZReleaseGroupID string `json:"mbzReleaseGroupId,omitempty"` + // MBZReleaseTrackID is the MusicBrainz release track ID. + MBZReleaseTrackID string `json:"mbzReleaseTrackId,omitempty"` +} + +// NowPlayingRequest is the request for now playing notification. +type NowPlayingRequest struct { + // Username is the username of the user. + Username string `json:"username"` + // Track is the track currently playing. + Track TrackInfo `json:"track"` + // Position is the current playback position in seconds. + Position int32 `json:"position"` +} + +// ScrobbleRequest is the request for submitting a scrobble. +type ScrobbleRequest struct { + // Username is the username of the user. + Username string `json:"username"` + // Track is the track that was played. + Track TrackInfo `json:"track"` + // Timestamp is the Unix timestamp when the track started playing. + Timestamp int64 `json:"timestamp"` +} + +// ScrobblerError represents an error type for scrobbling operations. +type ScrobblerError string + +const ( + // ScrobblerErrorNotAuthorized indicates the user is not authorized. + ScrobblerErrorNotAuthorized ScrobblerError = "scrobbler(not_authorized)" + // ScrobblerErrorRetryLater indicates the operation should be retried later. + ScrobblerErrorRetryLater ScrobblerError = "scrobbler(retry_later)" + // ScrobblerErrorUnrecoverable indicates an unrecoverable error. + ScrobblerErrorUnrecoverable ScrobblerError = "scrobbler(unrecoverable)" +) + +// Error implements the error interface for ScrobblerError. +func (e ScrobblerError) Error() string { return string(e) } diff --git a/plugins/capabilities/scrobbler.yaml b/plugins/capabilities/scrobbler.yaml new file mode 100644 index 000000000..5de351a5f --- /dev/null +++ b/plugins/capabilities/scrobbler.yaml @@ -0,0 +1,141 @@ +version: v1-draft +exports: + nd_scrobbler_is_authorized: + description: IsAuthorized checks if a user is authorized to scrobble to this service. + input: + $ref: '#/components/schemas/IsAuthorizedRequest' + contentType: application/json + output: + type: boolean + contentType: application/json + nd_scrobbler_now_playing: + description: NowPlaying sends a now playing notification to the scrobbling service. + input: + $ref: '#/components/schemas/NowPlayingRequest' + contentType: application/json + nd_scrobbler_scrobble: + description: Scrobble submits a completed scrobble to the scrobbling service. + input: + $ref: '#/components/schemas/ScrobbleRequest' + contentType: application/json +components: + schemas: + ArtistRef: + description: ArtistRef is a reference to an artist with name and optional MBID. + properties: + id: + type: string + description: ID is the internal Navidrome artist ID (if known). + name: + type: string + description: Name is the artist name. + mbid: + type: string + description: MBID is the MusicBrainz ID for the artist. + required: + - name + IsAuthorizedRequest: + description: IsAuthorizedRequest is the request for authorization check. + properties: + username: + type: string + description: Username is the username of the user. + required: + - username + NowPlayingRequest: + description: NowPlayingRequest is the request for now playing notification. + properties: + username: + type: string + description: Username is the username of the user. + track: + $ref: '#/components/schemas/TrackInfo' + description: Track is the track currently playing. + position: + type: integer + format: int32 + description: Position is the current playback position in seconds. + required: + - username + - track + - position + ScrobbleRequest: + description: ScrobbleRequest is the request for submitting a scrobble. + properties: + username: + type: string + description: Username is the username of the user. + track: + $ref: '#/components/schemas/TrackInfo' + description: Track is the track that was played. + timestamp: + type: integer + format: int64 + description: Timestamp is the Unix timestamp when the track started playing. + required: + - username + - track + - timestamp + TrackInfo: + description: TrackInfo contains track metadata. + properties: + id: + type: string + description: ID is the internal Navidrome track ID. + title: + type: string + description: Title is the track title. + album: + type: string + description: Album is the album name. + artist: + type: string + description: Artist is the formatted artist name for display (e.g., "Artist1 • Artist2"). + albumArtist: + type: string + description: AlbumArtist is the formatted album artist name for display. + artists: + type: array + description: Artists is the list of track artists. + items: + $ref: '#/components/schemas/ArtistRef' + albumArtists: + type: array + description: AlbumArtists is the list of album artists. + items: + $ref: '#/components/schemas/ArtistRef' + duration: + type: number + format: float + description: Duration is the track duration in seconds. + trackNumber: + type: integer + format: int32 + description: TrackNumber is the track number on the album. + discNumber: + type: integer + format: int32 + description: DiscNumber is the disc number. + mbzRecordingId: + type: string + description: MBZRecordingID is the MusicBrainz recording ID. + mbzAlbumId: + type: string + description: MBZAlbumID is the MusicBrainz album/release ID. + mbzReleaseGroupId: + type: string + description: MBZReleaseGroupID is the MusicBrainz release group ID. + mbzReleaseTrackId: + type: string + description: MBZReleaseTrackID is the MusicBrainz release track ID. + required: + - id + - title + - album + - artist + - albumArtist + - artists + - albumArtists + - duration + - trackNumber + - discNumber diff --git a/plugins/capabilities/taskworker.go b/plugins/capabilities/taskworker.go new file mode 100644 index 000000000..c53d50174 --- /dev/null +++ b/plugins/capabilities/taskworker.go @@ -0,0 +1,27 @@ +package capabilities + +// TaskWorker provides task execution handling. +// This capability allows plugins to receive callbacks when their queued tasks +// are ready to execute. Plugins that use the taskqueue host service must +// implement this capability. +// +//nd:capability name=taskworker +type TaskWorker interface { + // OnTaskExecute is called when a queued task is ready to run. + // The returned string is a status/result message stored in the tasks table. + // Return an error to trigger retry (if retries are configured). + //nd:export name=nd_task_execute + OnTaskExecute(TaskExecuteRequest) (string, error) +} + +// TaskExecuteRequest is the request provided when a task is ready to execute. +type TaskExecuteRequest struct { + // QueueName is the name of the queue this task belongs to. + QueueName string `json:"queueName"` + // TaskID is the unique identifier for this task. + TaskID string `json:"taskId"` + // Payload is the opaque data provided when the task was enqueued. + Payload []byte `json:"payload"` + // Attempt is the current attempt number (1-based: first attempt = 1). + Attempt int32 `json:"attempt"` +} diff --git a/plugins/capabilities/taskworker.yaml b/plugins/capabilities/taskworker.yaml new file mode 100644 index 000000000..7aa7126e0 --- /dev/null +++ b/plugins/capabilities/taskworker.yaml @@ -0,0 +1,37 @@ +version: v1-draft +exports: + nd_task_execute: + description: |- + OnTaskExecute is called when a queued task is ready to run. + The returned string is a status/result message stored in the tasks table. + Return an error to trigger retry (if retries are configured). + input: + $ref: '#/components/schemas/TaskExecuteRequest' + contentType: application/json + output: + type: string + contentType: application/json +components: + schemas: + TaskExecuteRequest: + description: TaskExecuteRequest is the request provided when a task is ready to execute. + properties: + queueName: + type: string + description: QueueName is the name of the queue this task belongs to. + taskId: + type: string + description: TaskID is the unique identifier for this task. + payload: + type: string + format: byte + description: Payload is the opaque data provided when the task was enqueued. + attempt: + type: integer + format: int32 + description: 'Attempt is the current attempt number (1-based: first attempt = 1).' + required: + - queueName + - taskId + - payload + - attempt diff --git a/plugins/capabilities/websocket_callback.go b/plugins/capabilities/websocket_callback.go new file mode 100644 index 000000000..ddfc0fc95 --- /dev/null +++ b/plugins/capabilities/websocket_callback.go @@ -0,0 +1,61 @@ +package capabilities + +// WebSocketCallback provides WebSocket message handling. +// This capability allows plugins to receive callbacks for WebSocket events +// such as text messages, binary messages, errors, and connection closures. +// Plugins that use the WebSocket host service must implement this capability +// to handle incoming events. +// +//nd:capability name=websocket +type WebSocketCallback interface { + // OnTextMessage is called when a text message is received on a WebSocket connection. + //nd:export name=nd_websocket_on_text_message + OnTextMessage(OnTextMessageRequest) error + + // OnBinaryMessage is called when a binary message is received on a WebSocket connection. + //nd:export name=nd_websocket_on_binary_message + OnBinaryMessage(OnBinaryMessageRequest) error + + // OnError is called when an error occurs on a WebSocket connection. + //nd:export name=nd_websocket_on_error + OnError(OnErrorRequest) error + + // OnClose is called when a WebSocket connection is closed. + //nd:export name=nd_websocket_on_close + OnClose(OnCloseRequest) error +} + +// OnTextMessageRequest is the request provided when a text message is received. +type OnTextMessageRequest struct { + // ConnectionID is the unique identifier for the WebSocket connection that received the message. + ConnectionID string `json:"connectionId"` + // Message is the text message content received from the WebSocket. + Message string `json:"message"` +} + +// OnBinaryMessageRequest is the request provided when a binary message is received. +type OnBinaryMessageRequest struct { + // ConnectionID is the unique identifier for the WebSocket connection that received the message. + ConnectionID string `json:"connectionId"` + // Data is the binary data received from the WebSocket, encoded as base64. + Data []byte `json:"data"` +} + +// OnErrorRequest is the request provided when an error occurs on a WebSocket connection. +type OnErrorRequest struct { + // ConnectionID is the unique identifier for the WebSocket connection where the error occurred. + ConnectionID string `json:"connectionId"` + // Error is the error message describing what went wrong. + Error string `json:"error"` +} + +// OnCloseRequest is the request provided when a WebSocket connection is closed. +type OnCloseRequest struct { + // ConnectionID is the unique identifier for the WebSocket connection that was closed. + ConnectionID string `json:"connectionId"` + // Code is the WebSocket close status code (e.g., 1000 for normal closure, + // 1001 for going away, 1006 for abnormal closure). + Code int32 `json:"code"` + // Reason is the human-readable reason for the connection closure, if provided. + Reason string `json:"reason"` +} diff --git a/plugins/capabilities/websocket_callback.yaml b/plugins/capabilities/websocket_callback.yaml new file mode 100644 index 000000000..6cd0cff9f --- /dev/null +++ b/plugins/capabilities/websocket_callback.yaml @@ -0,0 +1,80 @@ +version: v1-draft +exports: + nd_websocket_on_text_message: + description: OnTextMessage is called when a text message is received on a WebSocket connection. + input: + $ref: '#/components/schemas/OnTextMessageRequest' + contentType: application/json + nd_websocket_on_binary_message: + description: OnBinaryMessage is called when a binary message is received on a WebSocket connection. + input: + $ref: '#/components/schemas/OnBinaryMessageRequest' + contentType: application/json + nd_websocket_on_error: + description: OnError is called when an error occurs on a WebSocket connection. + input: + $ref: '#/components/schemas/OnErrorRequest' + contentType: application/json + nd_websocket_on_close: + description: OnClose is called when a WebSocket connection is closed. + input: + $ref: '#/components/schemas/OnCloseRequest' + contentType: application/json +components: + schemas: + OnBinaryMessageRequest: + description: OnBinaryMessageRequest is the request provided when a binary message is received. + properties: + connectionId: + type: string + description: ConnectionID is the unique identifier for the WebSocket connection that received the message. + data: + type: string + format: byte + description: Data is the binary data received from the WebSocket, encoded as base64. + required: + - connectionId + - data + OnCloseRequest: + description: OnCloseRequest is the request provided when a WebSocket connection is closed. + properties: + connectionId: + type: string + description: ConnectionID is the unique identifier for the WebSocket connection that was closed. + code: + type: integer + format: int32 + description: |- + Code is the WebSocket close status code (e.g., 1000 for normal closure, + 1001 for going away, 1006 for abnormal closure). + reason: + type: string + description: Reason is the human-readable reason for the connection closure, if provided. + required: + - connectionId + - code + - reason + OnErrorRequest: + description: OnErrorRequest is the request provided when an error occurs on a WebSocket connection. + properties: + connectionId: + type: string + description: ConnectionID is the unique identifier for the WebSocket connection where the error occurred. + error: + type: string + description: Error is the error message describing what went wrong. + required: + - connectionId + - error + OnTextMessageRequest: + description: OnTextMessageRequest is the request provided when a text message is received. + properties: + connectionId: + type: string + description: ConnectionID is the unique identifier for the WebSocket connection that received the message. + message: + type: string + description: Message is the text message content received from the WebSocket. + required: + - connectionId + - message diff --git a/plugins/capabilities_test.go b/plugins/capabilities_test.go new file mode 100644 index 000000000..35fc3910a --- /dev/null +++ b/plugins/capabilities_test.go @@ -0,0 +1,81 @@ +package plugins + +import ( + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +// mockFunctionChecker implements functionExistsChecker for testing +type mockFunctionChecker struct { + functions map[string]bool +} + +func (m *mockFunctionChecker) FunctionExists(name string) bool { + return m.functions[name] +} + +var _ = Describe("Capabilities", func() { + Describe("detectCapabilities", func() { + It("detects MetadataAgent capability when plugin exports artist biography function", func() { + checker := &mockFunctionChecker{ + functions: map[string]bool{ + FuncGetArtistBiography: true, + }, + } + + caps := detectCapabilities(checker) + Expect(caps).To(ContainElement(CapabilityMetadataAgent)) + }) + + It("detects MetadataAgent capability when plugin exports multiple functions", func() { + checker := &mockFunctionChecker{ + functions: map[string]bool{ + FuncGetArtistMBID: true, + FuncGetArtistURL: true, + FuncGetAlbumInfo: true, + FuncGetAlbumImages: true, + }, + } + + caps := detectCapabilities(checker) + Expect(caps).To(ContainElement(CapabilityMetadataAgent)) + Expect(caps).To(HaveLen(1)) // Should only have one MetadataAgent capability + }) + + It("returns empty slice when no capability functions are exported", func() { + checker := &mockFunctionChecker{ + functions: map[string]bool{ + "some_other_function": true, + }, + } + + caps := detectCapabilities(checker) + Expect(caps).To(BeEmpty()) + }) + + It("returns empty slice when plugin exports no functions", func() { + checker := &mockFunctionChecker{ + functions: map[string]bool{}, + } + + caps := detectCapabilities(checker) + Expect(caps).To(BeEmpty()) + }) + }) + + Describe("hasCapability", func() { + It("returns true when capability exists", func() { + caps := []Capability{CapabilityMetadataAgent} + Expect(hasCapability(caps, CapabilityMetadataAgent)).To(BeTrue()) + }) + + It("returns false when capability does not exist", func() { + var caps []Capability + Expect(hasCapability(caps, CapabilityMetadataAgent)).To(BeFalse()) + }) + + It("returns false when capabilities slice is nil", func() { + Expect(hasCapability(nil, CapabilityMetadataAgent)).To(BeFalse()) + }) + }) +}) diff --git a/plugins/capability_lifecycle.go b/plugins/capability_lifecycle.go new file mode 100644 index 000000000..499e3916d --- /dev/null +++ b/plugins/capability_lifecycle.go @@ -0,0 +1,38 @@ +package plugins + +import ( + "context" + + "github.com/navidrome/navidrome/log" +) + +// CapabilityLifecycle indicates the plugin has lifecycle callback functions. +// Detected when the plugin exports the nd_on_init function. +const CapabilityLifecycle Capability = "Lifecycle" + +const FuncOnInit = "nd_on_init" + +func init() { + registerCapability( + CapabilityLifecycle, + FuncOnInit, + ) +} + +// callPluginInit calls the plugin's nd_on_init function if it has the Lifecycle capability. +// This is called after the plugin is fully loaded with all services registered. +func callPluginInit(ctx context.Context, instance *plugin) { + if !hasCapability(instance.capabilities, CapabilityLifecycle) { + return + } + + log.Debug(ctx, "Calling plugin init function", "plugin", instance.name) + + err := callPluginFunctionNoInput(ctx, instance, FuncOnInit) + if err != nil { + log.Error(ctx, "Plugin init function failed", "plugin", instance.name, err) + return + } + + log.Debug(ctx, "Plugin init function completed", "plugin", instance.name) +} diff --git a/plugins/cmd/ndpgen/.gitignore b/plugins/cmd/ndpgen/.gitignore new file mode 100644 index 000000000..315ccc05f --- /dev/null +++ b/plugins/cmd/ndpgen/.gitignore @@ -0,0 +1 @@ +ndpgen \ No newline at end of file diff --git a/plugins/cmd/ndpgen/README.md b/plugins/cmd/ndpgen/README.md new file mode 100644 index 000000000..d2f67a60c --- /dev/null +++ b/plugins/cmd/ndpgen/README.md @@ -0,0 +1,198 @@ +# ndpgen + +Navidrome Plugin Development Kit (PDK) code generator. It reads Go interface definitions with special annotations and generates client wrappers for WASM plugins. + +This tool is the unified code generator that handle both host function wrappers and capability wrappers. + +## Usage + +```bash +ndpgen -input -output [-package ] [-v] [-dry-run] [-host-only] [-go] [-python] [-rust] +``` + +### Flags + +| Flag | Description | Default | +|--------------|----------------------------------------------------------------|----------------------| +| `-input` | Directory containing Go source files with annotated interfaces | Required | +| `-output` | Directory where generated files will be written | Same as input | +| `-package` | Package name for generated files | Inferred from output | +| `-v` | Verbose output | `false` | +| `-dry-run` | Parse and validate without writing files | `false` | +| `-host-only` | Generate only host function wrappers (capability support TBD) | `true` | +| `-go` | Generate Go client wrappers | `true`* | +| `-python` | Generate Python client wrappers | `false` | +| `-rust` | Generate Rust client wrappers | `false` | + +\* `-go` is enabled by default when neither `-python` nor `-rust` is specified. Use combinations like `-go -python -rust` to generate multiple languages. + +### Example + +```bash +go run ./plugins/cmd/ndpgen \ + -input ./plugins/host \ + -output ./plugins/pdk +``` + +## Annotations + +### `//nd:hostservice` + +Marks an interface as a host service that will have wrappers generated. + +```go +//nd:hostservice name= permission= +type MyService interface { ... } +``` + +| Parameter | Description | Required | +|--------------|-----------------------------------------------------------------|----------| +| `name` | Service name used in generated type names and function prefixes | Yes | +| `permission` | Permission required by plugins to use this service | Yes | + +### `//nd:hostfunc` + +Marks a method within a host service interface for export to plugins. + +```go +//nd:hostfunc [name=] +MethodName(ctx context.Context, ...) (result Type, err error) +``` + +| Parameter | Description | Required | +|-----------|-------------------------------------------------------------------------|----------| +| `name` | Custom export name (default: `_` in lowercase) | No | + +## Input Format + +Host service interfaces must follow these conventions: + +1. **First parameter must be `context.Context`** - Required for all methods +2. **Last return value should be `error`** - For proper error handling +3. **Annotations must be on consecutive lines** - No blank comment lines between doc and annotation + +### Example Interface + +```go +package host + +import "context" + +// SubsonicAPIService provides access to Navidrome's Subsonic API. +// This documentation becomes part of the generated code. +//nd:hostservice name=SubsonicAPI permission=subsonicapi +type SubsonicAPIService interface { + // Call executes a Subsonic API request and returns the response. + //nd:hostfunc + Call(ctx context.Context, uri string) (response string, err error) +} +``` + +## Generated Output + +### Go Client Library (Go/TinyGo WASM) + +Generated files are named `nd_host_.go` (lowercase) and placed in `$output/go/host/`. The `$output/go/` directory becomes a complete Go module (`github.com/navidrome/navidrome/plugins/pdk/go`) with package name `host`, intended for import by Navidrome plugins built with TinyGo. + +The generator creates: +- `nd_host_.go` - Client wrapper code (WASM build) +- `nd_host__stub.go` - Mock implementations for non-WASM platforms (testing) +- `doc.go` - Package documentation listing all available services +- `go.mod` - Go module file with required dependencies + +Each service file includes: + +- `// Code generated by ndpgen. DO NOT EDIT.` header +- Required imports (`encoding/json`, `errors`, `github.com/extism/go-pdk`) +- `//go:wasmimport` declarations for each host function +- Response struct types and any struct definitions from the service +- Wrapper functions that handle memory allocation and JSON parsing + +### Testing Plugins with Mocks + +The stub files (`*_stub.go`) contain [testify/mock](https://github.com/stretchr/testify) implementations that allow plugin authors to unit test their code on non-WASM platforms. + +Each host service has: +- A private mock struct embedding `mock.Mock` +- An exported auto-instantiated mock instance (e.g., `host.CacheMock`, `host.ArtworkMock`) +- Wrapper functions that delegate to the mock + +**Example: Testing a plugin that uses the Cache service** + +```go +package myplugin + +import ( + "testing" + + "github.com/navidrome/navidrome/plugins/pdk/go/host" +) + +func TestMyPluginFunction(t *testing.T) { + // Set expectations on the mock + host.CacheMock.On("GetString", "my-key").Return("cached-value", true, nil) + host.CacheMock.On("SetString", "new-key", "new-value", int64(3600)).Return(nil) + + // Call your plugin code that uses host.CacheGetString and host.CacheSetString + result := myPluginFunction() + + // Assert the result + if result != "expected" { + t.Errorf("unexpected result: %s", result) + } + + // Verify all expected calls were made + host.CacheMock.AssertExpectations(t) +} +``` + +**Resetting mocks between tests:** + +If you need to reset mock state between tests, testify's mock doesn't have a built-in reset. Either use separate test functions (testify automatically resets between test runs), or create a helper to set up fresh expectations. + +### Python Client Library + +When using `-python`, Python client files are generated in a `python/` subdirectory. + +### Rust Client Library + +When using `-rust`, Rust client files are generated in a `rust/` subdirectory. + +## Supported Types + +ndpgen supports these Go types in method signatures: + +| Type | JSON Representation | +|-------------------------------|------------------------------------------| +| `string`, `int`, `bool`, etc. | Native JSON types | +| `[]T` (slices) | JSON arrays | +| `map[K]V` (maps) | JSON objects | +| `*T` (pointers) | Nullable fields | +| `interface{}` / `any` | Converts to `any` | +| Custom structs | JSON objects (must be JSON-serializable) | + +### Multiple Return Values + +Methods can return multiple values (plus error): + +```go +//nd:hostfunc +Search(ctx context.Context, query string) (results []string, total int, hasMore bool, err error) +``` + +Generates: + +```go +type ServiceSearchResponse struct { + Results []string `json:"results,omitempty"` + Total int `json:"total,omitempty"` + HasMore bool `json:"hasMore,omitempty"` + Error string `json:"error,omitempty"` +} +``` + +## Running Tests + +```bash +go test ./plugins/cmd/ndpgen/... +``` diff --git a/plugins/cmd/ndpgen/go.mod b/plugins/cmd/ndpgen/go.mod new file mode 100644 index 000000000..af9fce441 --- /dev/null +++ b/plugins/cmd/ndpgen/go.mod @@ -0,0 +1,26 @@ +module github.com/navidrome/navidrome/plugins/cmd/ndpgen + +go 1.25 + +require ( + github.com/extism/go-pdk v1.1.3 + github.com/onsi/ginkgo/v2 v2.27.5 + github.com/onsi/gomega v1.39.0 + github.com/santhosh-tekuri/jsonschema/v6 v6.0.2 + golang.org/x/tools v0.41.0 + gopkg.in/yaml.v3 v3.0.1 +) + +require ( + github.com/Masterminds/semver/v3 v3.4.0 // indirect + github.com/go-logr/logr v1.4.3 // indirect + github.com/go-task/slim-sprig/v3 v3.0.0 // indirect + github.com/google/go-cmp v0.7.0 // indirect + github.com/google/pprof v0.0.0-20260115054156-294ebfa9ad83 // indirect + go.yaml.in/yaml/v3 v3.0.4 // indirect + golang.org/x/mod v0.32.0 // indirect + golang.org/x/net v0.49.0 // indirect + golang.org/x/sync v0.19.0 // indirect + golang.org/x/sys v0.40.0 // indirect + golang.org/x/text v0.33.0 // indirect +) diff --git a/plugins/cmd/ndpgen/go.sum b/plugins/cmd/ndpgen/go.sum new file mode 100644 index 000000000..952672d0e --- /dev/null +++ b/plugins/cmd/ndpgen/go.sum @@ -0,0 +1,75 @@ +github.com/Masterminds/semver/v3 v3.4.0 h1:Zog+i5UMtVoCU8oKka5P7i9q9HgrJeGzI9SA1Xbatp0= +github.com/Masterminds/semver/v3 v3.4.0/go.mod h1:4V+yj/TJE1HU9XfppCwVMZq3I84lprf4nC11bSS5beM= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/dlclark/regexp2 v1.11.0 h1:G/nrcoOa7ZXlpoa/91N3X7mM3r8eIlMBBJZvsz/mxKI= +github.com/dlclark/regexp2 v1.11.0/go.mod h1:DHkYz0B9wPfa6wondMfaivmHpzrQ3v9q8cnmRbL6yW8= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/gkampitakis/ciinfo v0.3.2 h1:JcuOPk8ZU7nZQjdUhctuhQofk7BGHuIy0c9Ez8BNhXs= +github.com/gkampitakis/ciinfo v0.3.2/go.mod h1:1NIwaOcFChN4fa/B0hEBdAb6npDlFL8Bwx4dfRLRqAo= +github.com/gkampitakis/go-diff v1.3.2 h1:Qyn0J9XJSDTgnsgHRdz9Zp24RaJeKMUHg2+PDZZdC4M= +github.com/gkampitakis/go-diff v1.3.2/go.mod h1:LLgOrpqleQe26cte8s36HTWcTmMEur6OPYerdAAS9tk= +github.com/gkampitakis/go-snaps v0.5.15 h1:amyJrvM1D33cPHwVrjo9jQxX8g/7E2wYdZ+01KS3zGE= +github.com/gkampitakis/go-snaps v0.5.15/go.mod h1:HNpx/9GoKisdhw9AFOBT1N7DBs9DiHo/hGheFGBZ+mc= +github.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI= +github.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY= +github.com/go-task/slim-sprig/v3 v3.0.0 h1:sUs3vkvUymDpBKi3qH1YSqBQk9+9D/8M2mN1vB6EwHI= +github.com/go-task/slim-sprig/v3 v3.0.0/go.mod h1:W848ghGpv3Qj3dhTPRyJypKRiqCdHZiAzKg9hl15HA8= +github.com/goccy/go-yaml v1.18.0 h1:8W7wMFS12Pcas7KU+VVkaiCng+kG8QiFeFwzFb+rwuw= +github.com/goccy/go-yaml v1.18.0/go.mod h1:XBurs7gK8ATbW4ZPGKgcbrY1Br56PdM69F7LkFRi1kA= +github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8= +github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU= +github.com/google/pprof v0.0.0-20260115054156-294ebfa9ad83 h1:z2ogiKUYzX5Is6zr/vP9vJGqPwcdqsWjOt+V8J7+bTc= +github.com/google/pprof v0.0.0-20260115054156-294ebfa9ad83/go.mod h1:MxpfABSjhmINe3F1It9d+8exIHFvUqtLIRCdOGNXqiI= +github.com/joshdk/go-junit v1.0.0 h1:S86cUKIdwBHWwA6xCmFlf3RTLfVXYQfvanM5Uh+K6GE= +github.com/joshdk/go-junit v1.0.0/go.mod h1:TiiV0PqkaNfFXjEiyjWM3XXrhVyCa1K4Zfga6W52ung= +github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= +github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk= +github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= +github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= +github.com/maruel/natural v1.1.1 h1:Hja7XhhmvEFhcByqDoHz9QZbkWey+COd9xWfCfn1ioo= +github.com/maruel/natural v1.1.1/go.mod h1:v+Rfd79xlw1AgVBjbO0BEQmptqb5HvL/k9GRHB7ZKEg= +github.com/mfridman/tparse v0.18.0 h1:wh6dzOKaIwkUGyKgOntDW4liXSo37qg5AXbIhkMV3vE= +github.com/mfridman/tparse v0.18.0/go.mod h1:gEvqZTuCgEhPbYk/2lS3Kcxg1GmTxxU7kTC8DvP0i/A= +github.com/onsi/ginkgo/v2 v2.27.5 h1:ZeVgZMx2PDMdJm/+w5fE/OyG6ILo1Y3e+QX4zSR0zTE= +github.com/onsi/ginkgo/v2 v2.27.5/go.mod h1:ArE1D/XhNXBXCBkKOLkbsb2c81dQHCRcF5zwn/ykDRo= +github.com/onsi/gomega v1.39.0 h1:y2ROC3hKFmQZJNFeGAMeHZKkjBL65mIZcvrLQBF9k6Q= +github.com/onsi/gomega v1.39.0/go.mod h1:ZCU1pkQcXDO5Sl9/VVEGlDyp+zm0m1cmeG5TOzLgdh4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/rogpeppe/go-internal v1.13.1 h1:KvO1DLK/DRN07sQ1LQKScxyZJuNnedQ5/wKSR38lUII= +github.com/rogpeppe/go-internal v1.13.1/go.mod h1:uMEvuHeurkdAXX61udpOXGD/AzZDWNMNyH2VO9fmH0o= +github.com/santhosh-tekuri/jsonschema/v6 v6.0.2 h1:KRzFb2m7YtdldCEkzs6KqmJw4nqEVZGK7IN2kJkjTuQ= +github.com/santhosh-tekuri/jsonschema/v6 v6.0.2/go.mod h1:JXeL+ps8p7/KNMjDQk3TCwPpBy0wYklyWTfbkIzdIFU= +github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk= +github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= +github.com/tidwall/gjson v1.18.0 h1:FIDeeyB800efLX89e5a8Y0BNH+LOngJyGrIWxG2FKQY= +github.com/tidwall/gjson v1.18.0/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk= +github.com/tidwall/match v1.1.1 h1:+Ho715JplO36QYgwN9PGYNhgZvoUSc9X2c80KVTi+GA= +github.com/tidwall/match v1.1.1/go.mod h1:eRSPERbgtNPcGhD8UCthc6PmLEQXEWd3PRB5JTxsfmM= +github.com/tidwall/pretty v1.2.1 h1:qjsOFOWWQl+N3RsoF5/ssm1pHmJJwhjlSbZ51I6wMl4= +github.com/tidwall/pretty v1.2.1/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU= +github.com/tidwall/sjson v1.2.5 h1:kLy8mja+1c9jlljvWTlSazM7cKDRfJuR/bOJhcY5NcY= +github.com/tidwall/sjson v1.2.5/go.mod h1:Fvgq9kS/6ociJEDnK0Fk1cpYF4FIW6ZF7LAe+6jwd28= +go.yaml.in/yaml/v3 v3.0.4 h1:tfq32ie2Jv2UxXFdLJdh3jXuOzWiL1fo0bu/FbuKpbc= +go.yaml.in/yaml/v3 v3.0.4/go.mod h1:DhzuOOF2ATzADvBadXxruRBLzYTpT36CKvDb3+aBEFg= +golang.org/x/mod v0.32.0 h1:9F4d3PHLljb6x//jOyokMv3eX+YDeepZSEo3mFJy93c= +golang.org/x/mod v0.32.0/go.mod h1:SgipZ/3h2Ci89DlEtEXWUk/HteuRin+HHhN+WbNhguU= +golang.org/x/net v0.49.0 h1:eeHFmOGUTtaaPSGNmjBKpbng9MulQsJURQUAfUwY++o= +golang.org/x/net v0.49.0/go.mod h1:/ysNB2EvaqvesRkuLAyjI1ycPZlQHM3q01F02UY/MV8= +golang.org/x/sync v0.19.0 h1:vV+1eWNmZ5geRlYjzm2adRgW2/mcpevXNg50YZtPCE4= +golang.org/x/sync v0.19.0/go.mod h1:9KTHXmSnoGruLpwFjVSX0lNNA75CykiMECbovNTZqGI= +golang.org/x/sys v0.40.0 h1:DBZZqJ2Rkml6QMQsZywtnjnnGvHza6BTfYFWY9kjEWQ= +golang.org/x/sys v0.40.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks= +golang.org/x/text v0.33.0 h1:B3njUFyqtHDUI5jMn1YIr5B0IE2U0qck04r6d4KPAxE= +golang.org/x/text v0.33.0/go.mod h1:LuMebE6+rBincTi9+xWTY8TztLzKHc/9C1uBCG27+q8= +golang.org/x/tools v0.41.0 h1:a9b8iMweWG+S0OBnlU36rzLp20z1Rp10w+IY2czHTQc= +golang.org/x/tools v0.41.0/go.mod h1:XSY6eDqxVNiYgezAVqqCeihT4j1U2CCsqvH3WhQpnlg= +google.golang.org/protobuf v1.36.7 h1:IgrO7UwFQGJdRNXH/sQux4R1Dj1WAKcLElzeeRaXV2A= +google.golang.org/protobuf v1.36.7/go.mod h1:jduwjTPXsFjZGTmRluh+L6NjiWu7pchiJ2/5YcXBHnY= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY= +gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/cmd/ndpgen/integration_test.go b/plugins/cmd/ndpgen/integration_test.go new file mode 100644 index 000000000..db500c1fc --- /dev/null +++ b/plugins/cmd/ndpgen/integration_test.go @@ -0,0 +1,534 @@ +package main + +import ( + "fmt" + "go/format" + "os" + "os/exec" + "path/filepath" + "strings" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +// normalizeGeneratedCode normalizes generated code for comparison with expected output. +func normalizeGeneratedCode(code string) string { + // Replace package names (generated uses ndpdk, testdata may use ndhost) + code = strings.ReplaceAll(code, "package ndhost", "package ndpdk") + return code +} + +var _ = Describe("ndpgen CLI", Ordered, func() { + var ( + testDir string + outputDir string + ndpgenBin string + ) + + BeforeAll(func() { + // Set testdata directory (relative to ndpgen root) + testdataDir = filepath.Join(mustGetWd(GinkgoT()), "testdata") + + // Build the ndpgen binary + ndpgenBin = filepath.Join(os.TempDir(), "ndpgen-test") + cmd := exec.Command("go", "build", "-o", ndpgenBin, ".") + cmd.Dir = mustGetWd(GinkgoT()) + output, err := cmd.CombinedOutput() + Expect(err).ToNot(HaveOccurred(), "Failed to build ndpgen: %s", output) + DeferCleanup(func() { + os.Remove(ndpgenBin) + }) + }) + + BeforeEach(func() { + var err error + testDir, err = os.MkdirTemp("", "ndpgen-test-input-*") + Expect(err).ToNot(HaveOccurred()) + outputDir, err = os.MkdirTemp("", "ndpgen-test-output-*") + Expect(err).ToNot(HaveOccurred()) + }) + + AfterEach(func() { + os.RemoveAll(testDir) + os.RemoveAll(outputDir) + }) + + Describe("CLI flags and behavior", func() { + BeforeEach(func() { + serviceCode := `package testpkg + +import "context" + +//nd:hostservice name=Test permission=test +type TestService interface { + //nd:hostfunc + DoAction(ctx context.Context, input string) (output string, err error) +} +` + Expect(os.WriteFile(filepath.Join(testDir, "service.go"), []byte(serviceCode), 0600)).To(Succeed()) + }) + + It("supports verbose mode", func() { + cmd := exec.Command(ndpgenBin, "-input", testDir, "-output", outputDir, "-package", "ndpdk", "-v") + output, err := cmd.CombinedOutput() + Expect(err).ToNot(HaveOccurred(), "Command failed: %s", output) + + outputStr := string(output) + Expect(outputStr).To(ContainSubstring("Input directory:")) + Expect(outputStr).To(ContainSubstring("Base output directory:")) + Expect(outputStr).To(ContainSubstring("Go output directory:")) + Expect(outputStr).To(ContainSubstring("Found 1 host service(s)")) + Expect(outputStr).To(ContainSubstring("Generated")) + }) + + It("supports dry-run mode", func() { + cmd := exec.Command(ndpgenBin, "-input", testDir, "-output", outputDir, "-package", "ndpdk", "-dry-run") + output, err := cmd.CombinedOutput() + Expect(err).ToNot(HaveOccurred(), "Command failed: %s", output) + + Expect(string(output)).To(ContainSubstring("func TestDoAction(")) + Expect(filepath.Join(outputDir, "nd_host_test.go")).ToNot(BeAnExistingFile()) + }) + + It("uses default package name 'host'", func() { + customOutput, err := os.MkdirTemp("", "mypkg") + Expect(err).ToNot(HaveOccurred()) + defer os.RemoveAll(customOutput) + + cmd := exec.Command(ndpgenBin, "-input", testDir, "-output", customOutput) + _, err = cmd.CombinedOutput() + Expect(err).ToNot(HaveOccurred()) + + // Go code goes to $output/go/host/ + content, err := os.ReadFile(filepath.Join(customOutput, "go", "host", "nd_host_test.go")) + Expect(err).ToNot(HaveOccurred()) + Expect(string(content)).To(ContainSubstring("package host")) + }) + + It("returns error for invalid input directory", func() { + cmd := exec.Command(ndpgenBin, "-input", "/nonexistent/path") + output, err := cmd.CombinedOutput() + Expect(err).To(HaveOccurred()) + Expect(string(output)).To(ContainSubstring("parsing source files")) + }) + + It("handles no annotated services gracefully", func() { + Expect(os.WriteFile(filepath.Join(testDir, "service.go"), []byte("package testpkg\n"), 0600)).To(Succeed()) + + cmd := exec.Command(ndpgenBin, "-input", testDir, "-output", outputDir, "-v") + output, err := cmd.CombinedOutput() + Expect(err).ToNot(HaveOccurred(), "Command failed: %s", output) + Expect(string(output)).To(ContainSubstring("No host services found")) + }) + + It("generates separate files for multiple services", func() { + // Remove service.go created by BeforeEach + Expect(os.Remove(filepath.Join(testDir, "service.go"))).To(Succeed()) + + service1 := `package testpkg +import "context" +//nd:hostservice name=ServiceA permission=a +type ServiceA interface { + //nd:hostfunc + MethodA(ctx context.Context) error +} +` + service2 := `package testpkg +import "context" +//nd:hostservice name=ServiceB permission=b +type ServiceB interface { + //nd:hostfunc + MethodB(ctx context.Context) error +} +` + Expect(os.WriteFile(filepath.Join(testDir, "a.go"), []byte(service1), 0600)).To(Succeed()) + Expect(os.WriteFile(filepath.Join(testDir, "b.go"), []byte(service2), 0600)).To(Succeed()) + + cmd := exec.Command(ndpgenBin, "-input", testDir, "-output", outputDir, "-package", "ndpdk", "-v") + output, err := cmd.CombinedOutput() + Expect(err).ToNot(HaveOccurred(), "Command failed: %s", output) + Expect(string(output)).To(ContainSubstring("Found 2 host service(s)")) + + // Go code goes to $output/go/host/ + goHostDir := filepath.Join(outputDir, "go", "host") + Expect(filepath.Join(goHostDir, "nd_host_servicea.go")).To(BeAnExistingFile()) + Expect(filepath.Join(goHostDir, "nd_host_serviceb.go")).To(BeAnExistingFile()) + }) + + It("generates Go client code by default", func() { + cmd := exec.Command(ndpgenBin, "-input", testDir, "-output", outputDir, "-package", "ndpdk") + output, err := cmd.CombinedOutput() + Expect(err).ToNot(HaveOccurred(), "Command failed: %s", output) + + // Go client code goes to $output/go/host/ + goHostDir := filepath.Join(outputDir, "go", "host") + Expect(filepath.Join(goHostDir, "nd_host_test.go")).To(BeAnExistingFile()) + // Stub file also generated + Expect(filepath.Join(goHostDir, "nd_host_test_stub.go")).To(BeAnExistingFile()) + // doc.go in host dir + Expect(filepath.Join(goHostDir, "doc.go")).To(BeAnExistingFile()) + // go.mod at parent $output/go/ for consolidated module + goDir := filepath.Join(outputDir, "go") + Expect(filepath.Join(goDir, "go.mod")).To(BeAnExistingFile()) + }) + }) + + Describe("code generation", func() { + DescribeTable("generates correct client output", + func(serviceFile, goClientExpectedFile, pyClientExpectedFile, rsClientExpectedFile string) { + serviceCode := readTestdata(serviceFile) + goClientExpected := readTestdata(goClientExpectedFile) + pyClientExpected := readTestdata(pyClientExpectedFile) + rsClientExpected := readTestdata(rsClientExpectedFile) + + Expect(os.WriteFile(filepath.Join(testDir, "service.go"), []byte(serviceCode), 0600)).To(Succeed()) + + // Generate all client code (Go, Python, Rust) + cmd := exec.Command(ndpgenBin, "-input", testDir, "-output", outputDir, "-package", "ndpdk", "-go", "-python", "-rust") + output, err := cmd.CombinedOutput() + Expect(err).ToNot(HaveOccurred(), "Command failed: %s", output) + + // Verify Go client code (now in $output/go/host/) + goHostDir := filepath.Join(outputDir, "go", "host") + entries, err := os.ReadDir(goHostDir) + Expect(err).ToNot(HaveOccurred()) + + var goClientFiles []string + for _, e := range entries { + if !e.IsDir() && + !strings.HasSuffix(e.Name(), "_stub.go") && + e.Name() != "doc.go" && e.Name() != "go.mod" { + goClientFiles = append(goClientFiles, e.Name()) + } + } + Expect(goClientFiles).To(HaveLen(1), "Expected exactly one Go client file, got: %v", goClientFiles) + + goClientActual, err := os.ReadFile(filepath.Join(goHostDir, goClientFiles[0])) + Expect(err).ToNot(HaveOccurred()) + + formattedGoClientActual, err := format.Source(goClientActual) + Expect(err).ToNot(HaveOccurred(), "Generated Go client code is not valid Go:\n%s", goClientActual) + + // Normalize expected code to match ndpgen output format + normalizedExpected := normalizeGeneratedCode(goClientExpected) + formattedGoClientExpected, err := format.Source([]byte(normalizedExpected)) + Expect(err).ToNot(HaveOccurred(), "Expected Go client code is not valid Go") + + Expect(string(formattedGoClientActual)).To(Equal(string(formattedGoClientExpected)), "Go client code mismatch") + + // Verify Python client code (now in $output/python/host/) + pythonHostDir := filepath.Join(outputDir, "python", "host") + pyClientEntries, err := os.ReadDir(pythonHostDir) + Expect(err).ToNot(HaveOccurred()) + Expect(pyClientEntries).To(HaveLen(1), "Expected exactly one Python client file") + + pyClientActual, err := os.ReadFile(filepath.Join(pythonHostDir, pyClientEntries[0].Name())) + Expect(err).ToNot(HaveOccurred()) + + Expect(string(pyClientActual)).To(Equal(pyClientExpected), "Python client code mismatch") + + // Verify Rust client code (now in $output/rust/nd-pdk-host/src/) + rustSrcDir := filepath.Join(outputDir, "rust", "nd-pdk-host", "src") + rsClientEntries, err := os.ReadDir(rustSrcDir) + Expect(err).ToNot(HaveOccurred()) + Expect(rsClientEntries).To(HaveLen(2), "Expected Rust client file and lib.rs in src/") + + // Find the client file (not lib.rs) + var rsClientName string + for _, entry := range rsClientEntries { + if entry.Name() != "lib.rs" { + rsClientName = entry.Name() + break + } + } + Expect(rsClientName).ToNot(BeEmpty(), "Expected to find Rust client file") + + rsClientActual, err := os.ReadFile(filepath.Join(rustSrcDir, rsClientName)) + Expect(err).ToNot(HaveOccurred()) + + Expect(string(rsClientActual)).To(Equal(rsClientExpected), "Rust client code mismatch") + }, + + Entry("simple string params", + "echo_service.go.txt", "echo_client_expected.go.txt", "echo_client_expected.py", "echo_client_expected.rs"), + + Entry("multiple simple params (int32)", + "math_service.go.txt", "math_client_expected.go.txt", "math_client_expected.py", "math_client_expected.rs"), + + Entry("struct param with request type", + "store_service.go.txt", "store_client_expected.go.txt", "store_client_expected.py", "store_client_expected.rs"), + + Entry("mixed simple and complex params", + "list_service.go.txt", "list_client_expected.go.txt", "list_client_expected.py", "list_client_expected.rs"), + + Entry("method without error", + "counter_service.go.txt", "counter_client_expected.go.txt", "counter_client_expected.py", "counter_client_expected.rs"), + + Entry("no params, error only", + "ping_service.go.txt", "ping_client_expected.go.txt", "ping_client_expected.py", "ping_client_expected.rs"), + + Entry("map and interface types", + "meta_service.go.txt", "meta_client_expected.go.txt", "meta_client_expected.py", "meta_client_expected.rs"), + + Entry("pointer types", + "users_service.go.txt", "users_client_expected.go.txt", "users_client_expected.py", "users_client_expected.rs"), + + Entry("multiple returns", + "search_service.go.txt", "search_client_expected.go.txt", "search_client_expected.py", "search_client_expected.rs"), + + Entry("bytes", + "codec_service.go.txt", "codec_client_expected.go.txt", "codec_client_expected.py", "codec_client_expected.rs"), + + Entry("option pattern (value, exists bool)", + "config_service.go.txt", "config_client_expected.go.txt", "config_client_expected.py", "config_client_expected.rs"), + ) + + It("generates compilable client code for comprehensive service", func() { + serviceCode := readTestdata("comprehensive_service.go.txt") + + Expect(os.WriteFile(filepath.Join(testDir, "service.go"), []byte(serviceCode), 0600)).To(Succeed()) + + // Generate client code + cmd := exec.Command(ndpgenBin, "-input", testDir, "-output", outputDir, "-package", "ndpdk") + output, err := cmd.CombinedOutput() + Expect(err).ToNot(HaveOccurred(), "Generation failed: %s", output) + + // Go code goes to $output/go/host/ + goHostDir := filepath.Join(outputDir, "go", "host") + + // Read generated client code + entries, err := os.ReadDir(goHostDir) + Expect(err).ToNot(HaveOccurred()) + + // Find the client file + var clientFileName string + for _, entry := range entries { + name := entry.Name() + if name != "doc.go" && name != "go.mod" && !strings.HasSuffix(name, "_stub.go") && strings.HasSuffix(name, ".go") { + clientFileName = name + break + } + } + Expect(clientFileName).ToNot(BeEmpty(), "Expected to find Go client file") + + content, err := os.ReadFile(filepath.Join(goHostDir, clientFileName)) + Expect(err).ToNot(HaveOccurred()) + + // Verify key expected content + contentStr := string(content) + // Should have wasmimport declarations for all methods + Expect(contentStr).To(ContainSubstring("//go:wasmimport extism:host/user comprehensive_simpleparams")) + Expect(contentStr).To(ContainSubstring("//go:wasmimport extism:host/user comprehensive_structparam")) + Expect(contentStr).To(ContainSubstring("//go:wasmimport extism:host/user comprehensive_noerror")) + Expect(contentStr).To(ContainSubstring("//go:wasmimport extism:host/user comprehensive_noparams")) + Expect(contentStr).To(ContainSubstring("//go:wasmimport extism:host/user comprehensive_noparamsnoreturns")) + + // Should have response types for methods with complex returns (private types in client code) + Expect(contentStr).To(ContainSubstring("type comprehensiveSimpleParamsResponse struct")) + Expect(contentStr).To(ContainSubstring("type comprehensiveMultipleReturnsResponse struct")) + + // Should have wrapper functions + Expect(contentStr).To(ContainSubstring("func ComprehensiveSimpleParams(")) + Expect(contentStr).To(ContainSubstring("func ComprehensiveNoParams()")) + Expect(contentStr).To(ContainSubstring("func ComprehensiveNoParamsNoReturns()")) + + // Create a plugin directory with proper import structure + pluginDir := filepath.Join(outputDir, "plugin") + Expect(os.MkdirAll(pluginDir, 0750)).To(Succeed()) + + // go.mod is at parent $output/go/ for consolidated module + goDir := filepath.Join(outputDir, "go") + + // Create go.mod for the plugin that imports the generated library + goMod := fmt.Sprintf(`module testplugin + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +replace github.com/navidrome/navidrome/plugins/pdk/go => %s +`, goDir) + Expect(os.WriteFile(filepath.Join(pluginDir, "go.mod"), []byte(goMod), 0600)).To(Succeed()) + + // Add a simple main function that imports and uses the ndpdk package + mainGo := `package main + +import ndpdk "github.com/navidrome/navidrome/plugins/pdk/go/host" + +func main() {} + +// Use some functions to ensure import is not unused +var _ = ndpdk.ComprehensiveNoParams +` + Expect(os.WriteFile(filepath.Join(pluginDir, "main.go"), []byte(mainGo), 0600)).To(Succeed()) + + // Tidy dependencies for the generated go library + goTidyLibCmd := exec.Command("go", "mod", "tidy") + goTidyLibCmd.Dir = goDir + goTidyLibOutput, err := goTidyLibCmd.CombinedOutput() + Expect(err).ToNot(HaveOccurred(), "go mod tidy (library) failed: %s", goTidyLibOutput) + + // Tidy dependencies for the plugin + goTidyCmd := exec.Command("go", "mod", "tidy") + goTidyCmd.Dir = pluginDir + goTidyOutput, err := goTidyCmd.CombinedOutput() + Expect(err).ToNot(HaveOccurred(), "go mod tidy (plugin) failed: %s", goTidyOutput) + + // Build as WASM plugin - this validates the client code compiles correctly + buildCmd := exec.Command("go", "build", "-buildmode=c-shared", "-o", "plugin.wasm", ".") + buildCmd.Dir = pluginDir + buildCmd.Env = append(os.Environ(), "GOOS=wasip1", "GOARCH=wasm") + buildOutput, err := buildCmd.CombinedOutput() + Expect(err).ToNot(HaveOccurred(), "WASM build failed: %s", buildOutput) + + // Verify .wasm file was created + Expect(filepath.Join(pluginDir, "plugin.wasm")).To(BeAnExistingFile()) + }) + + It("generates Python client code with -python flag", func() { + serviceCode := `package testpkg + +import "context" + +//nd:hostservice name=Test permission=test +type TestService interface { + //nd:hostfunc + DoAction(ctx context.Context, input string) (output string, err error) +} +` + Expect(os.WriteFile(filepath.Join(testDir, "service.go"), []byte(serviceCode), 0600)).To(Succeed()) + + cmd := exec.Command(ndpgenBin, "-input", testDir, "-output", outputDir, "-package", "ndpdk", "-python") + output, err := cmd.CombinedOutput() + Expect(err).ToNot(HaveOccurred(), "Command failed: %s", output) + + // Verify Python client code exists in $output/python/host/ + pythonHostDir := filepath.Join(outputDir, "python", "host") + Expect(pythonHostDir).To(BeADirectory()) + + pythonFile := filepath.Join(pythonHostDir, "nd_host_test.py") + Expect(pythonFile).To(BeAnExistingFile()) + + content, err := os.ReadFile(pythonFile) + Expect(err).ToNot(HaveOccurred()) + + contentStr := string(content) + Expect(contentStr).To(ContainSubstring("Code generated by ndpgen. DO NOT EDIT.")) + Expect(contentStr).To(ContainSubstring("class HostFunctionError(Exception):")) + Expect(contentStr).To(ContainSubstring(`@extism.import_fn("extism:host/user", "test_doaction")`)) + Expect(contentStr).To(ContainSubstring("def test_do_action(input: str) -> str:")) + }) + + It("generates both Go and Python client code with -go -python flags", func() { + serviceCode := `package testpkg + +import "context" + +//nd:hostservice name=Test permission=test +type TestService interface { + //nd:hostfunc + DoAction(ctx context.Context, input string) (output string, err error) +} +` + Expect(os.WriteFile(filepath.Join(testDir, "service.go"), []byte(serviceCode), 0600)).To(Succeed()) + + cmd := exec.Command(ndpgenBin, "-input", testDir, "-output", outputDir, "-package", "ndpdk", "-go", "-python") + output, err := cmd.CombinedOutput() + Expect(err).ToNot(HaveOccurred(), "Command failed: %s", output) + + // Verify Go client code exists in $output/go/host/ + goHostDir := filepath.Join(outputDir, "go", "host") + Expect(filepath.Join(goHostDir, "nd_host_test.go")).To(BeAnExistingFile()) + + // Verify Python client code exists in $output/python/host/ + pythonHostDir := filepath.Join(outputDir, "python", "host") + Expect(pythonHostDir).To(BeADirectory()) + Expect(filepath.Join(pythonHostDir, "nd_host_test.py")).To(BeAnExistingFile()) + }) + + It("generates Python code with dataclass for multi-value returns", func() { + serviceCode := `package testpkg + +import "context" + +//nd:hostservice name=Cache permission=cache +type CacheService interface { + //nd:hostfunc + GetString(ctx context.Context, key string) (value string, exists bool, err error) +} +` + Expect(os.WriteFile(filepath.Join(testDir, "service.go"), []byte(serviceCode), 0600)).To(Succeed()) + + cmd := exec.Command(ndpgenBin, "-input", testDir, "-output", outputDir, "-package", "ndpdk", "-python") + output, err := cmd.CombinedOutput() + Expect(err).ToNot(HaveOccurred(), "Command failed: %s", output) + + content, err := os.ReadFile(filepath.Join(outputDir, "python", "host", "nd_host_cache.py")) + Expect(err).ToNot(HaveOccurred()) + + contentStr := string(content) + Expect(contentStr).To(ContainSubstring("@dataclass")) + Expect(contentStr).To(ContainSubstring("class CacheGetStringResult:")) + Expect(contentStr).To(ContainSubstring("value: str")) + Expect(contentStr).To(ContainSubstring("exists: bool")) + Expect(contentStr).To(ContainSubstring("def cache_get_string(key: str) -> CacheGetStringResult:")) + }) + + It("generates Python code for methods with no parameters", func() { + serviceCode := `package testpkg + +import "context" + +//nd:hostservice name=Test permission=test +type TestService interface { + //nd:hostfunc + Ping(ctx context.Context) (status string, err error) +} +` + Expect(os.WriteFile(filepath.Join(testDir, "service.go"), []byte(serviceCode), 0600)).To(Succeed()) + + cmd := exec.Command(ndpgenBin, "-input", testDir, "-output", outputDir, "-package", "ndpdk", "-python") + output, err := cmd.CombinedOutput() + Expect(err).ToNot(HaveOccurred(), "Command failed: %s", output) + + content, err := os.ReadFile(filepath.Join(outputDir, "python", "host", "nd_host_test.py")) + Expect(err).ToNot(HaveOccurred()) + + contentStr := string(content) + Expect(contentStr).To(ContainSubstring("def test_ping() -> str:")) + Expect(contentStr).To(ContainSubstring(`request_bytes = b"{}"`)) + }) + }) +}) + +var testdataDir string + +func readTestdata(filename string) string { + content, err := os.ReadFile(filepath.Join(testdataDir, filename)) + Expect(err).ToNot(HaveOccurred(), "Failed to read testdata file: %s", filename) + return string(content) +} + +func mustGetWd(t FullGinkgoTInterface) string { + dir, err := os.Getwd() + if err != nil { + t.Fatal(err) + } + // Look for ndpgen's own go.mod (the subproject root) + for { + goModPath := filepath.Join(dir, "go.mod") + if _, err := os.Stat(goModPath); err == nil { + // Check if this is the ndpgen go.mod by reading it + content, err := os.ReadFile(goModPath) + if err == nil && strings.Contains(string(content), "plugins/cmd/ndpgen") { + return dir + } + } + parent := filepath.Dir(dir) + if parent == dir { + t.Fatal("could not find ndpgen project root") + } + dir = parent + } +} diff --git a/plugins/cmd/ndpgen/internal/generator.go b/plugins/cmd/ndpgen/internal/generator.go new file mode 100644 index 000000000..705cd4d36 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/generator.go @@ -0,0 +1,889 @@ +package internal + +import ( + "bytes" + "embed" + "fmt" + "strings" + "text/template" +) + +//go:embed templates/*.tmpl +var templatesFS embed.FS + +// hostFuncMap returns the template functions for host code generation. +func hostFuncMap(svc Service) template.FuncMap { + return template.FuncMap{ + "lower": strings.ToLower, + "title": strings.Title, + "exportName": func(m Method) string { return m.FunctionName(svc.ExportPrefix()) }, + "requestType": func(m Method) string { return m.RequestTypeName(svc.Name) }, + "responseType": func(m Method) string { return m.ResponseTypeName(svc.Name) }, + } +} + +// clientFuncMap returns the template functions for client code generation. +// Uses private (lowercase) type names for request/response structs. +func clientFuncMap(svc Service) template.FuncMap { + return template.FuncMap{ + "lower": strings.ToLower, + "title": strings.Title, + "exportName": func(m Method) string { return m.FunctionName(svc.ExportPrefix()) }, + "requestType": func(m Method) string { return m.ClientRequestTypeName(svc.Name) }, + "responseType": func(m Method) string { return m.ClientResponseTypeName(svc.Name) }, + "formatDoc": formatDoc, + "mockReturnValues": mockReturnValues, + } +} + +// mockReturnValues generates the testify mock return value accessors for a method. +// For example: args.String(0), args.Bool(1), args.Error(2) +func mockReturnValues(m Method) string { + var parts []string + idx := 0 + + for _, r := range m.Returns { + parts = append(parts, mockAccessor(r.Type, idx)) + idx++ + } + + if m.HasError { + parts = append(parts, fmt.Sprintf("args.Error(%d)", idx)) + } + + return strings.Join(parts, ", ") +} + +// mockAccessor returns the testify mock accessor call for a given type and index. +func mockAccessor(typ string, idx int) string { + switch { + case typ == "string": + return fmt.Sprintf("args.String(%d)", idx) + case typ == "bool": + return fmt.Sprintf("args.Bool(%d)", idx) + case typ == "int": + return fmt.Sprintf("args.Int(%d)", idx) + case typ == "int64": + return fmt.Sprintf("args.Get(%d).(int64)", idx) + case typ == "int32": + return fmt.Sprintf("args.Get(%d).(int32)", idx) + case typ == "float64": + return fmt.Sprintf("args.Get(%d).(float64)", idx) + case typ == "float32": + return fmt.Sprintf("args.Get(%d).(float32)", idx) + case typ == "[]byte": + return fmt.Sprintf("args.Get(%d).([]byte)", idx) + default: + // For slices, maps, pointers, and custom types, use Get with type assertion + return fmt.Sprintf("args.Get(%d).(%s)", idx, typ) + } +} + +// pythonFuncMap returns the template functions for Python client code generation. +func pythonFuncMap(svc Service) template.FuncMap { + return template.FuncMap{ + "lower": strings.ToLower, + "exportName": func(m Method) string { return m.FunctionName(svc.ExportPrefix()) }, + "pythonFunc": func(m Method) string { return m.PythonFunctionName(svc.ExportPrefix()) }, + "pythonResultType": func(m Method) string { return m.PythonResultTypeName(svc.Name) }, + "pythonDefault": pythonDefaultValue, + } +} + +// GenerateHost generates the host function wrapper code for a service. +func GenerateHost(svc Service, pkgName string) ([]byte, error) { + tmplContent, err := templatesFS.ReadFile("templates/host.go.tmpl") + if err != nil { + return nil, fmt.Errorf("reading host template: %w", err) + } + + tmpl, err := template.New("host").Funcs(hostFuncMap(svc)).Parse(string(tmplContent)) + if err != nil { + return nil, fmt.Errorf("parsing template: %w", err) + } + + data := templateData{ + Package: pkgName, + Service: svc, + } + + var buf bytes.Buffer + if err := tmpl.Execute(&buf, data); err != nil { + return nil, fmt.Errorf("executing template: %w", err) + } + + return buf.Bytes(), nil +} + +// GenerateClientGo generates client wrapper code for plugins to call host functions. +func GenerateClientGo(svc Service, pkgName string) ([]byte, error) { + tmplContent, err := templatesFS.ReadFile("templates/client.go.tmpl") + if err != nil { + return nil, fmt.Errorf("reading client template: %w", err) + } + + tmpl, err := template.New("client").Funcs(clientFuncMap(svc)).Parse(string(tmplContent)) + if err != nil { + return nil, fmt.Errorf("parsing template: %w", err) + } + + data := templateData{ + Package: pkgName, + Service: svc, + } + + var buf bytes.Buffer + if err := tmpl.Execute(&buf, data); err != nil { + return nil, fmt.Errorf("executing template: %w", err) + } + + return buf.Bytes(), nil +} + +// GenerateClientGoStub generates stub code for non-WASM platforms. +// These stubs provide type definitions and function signatures for IDE support, +// but panic at runtime since host functions are only available in WASM plugins. +func GenerateClientGoStub(svc Service, pkgName string) ([]byte, error) { + tmplContent, err := templatesFS.ReadFile("templates/client_stub.go.tmpl") + if err != nil { + return nil, fmt.Errorf("reading client stub template: %w", err) + } + + tmpl, err := template.New("client_stub").Funcs(clientFuncMap(svc)).Parse(string(tmplContent)) + if err != nil { + return nil, fmt.Errorf("parsing template: %w", err) + } + + data := templateData{ + Package: pkgName, + Service: svc, + } + + var buf bytes.Buffer + if err := tmpl.Execute(&buf, data); err != nil { + return nil, fmt.Errorf("executing template: %w", err) + } + + return buf.Bytes(), nil +} + +type templateData struct { + Package string + Service Service +} + +// formatDoc formats a documentation string for Go comments. +// It prefixes each line with "// " and trims trailing whitespace. +func formatDoc(doc string) string { + if doc == "" { + return "" + } + lines := strings.Split(strings.TrimSpace(doc), "\n") + var result []string + for _, line := range lines { + result = append(result, "// "+strings.TrimRight(line, " \t")) + } + return strings.Join(result, "\n") +} + +// GenerateClientPython generates Python client wrapper code for plugins. +func GenerateClientPython(svc Service) ([]byte, error) { + tmplContent, err := templatesFS.ReadFile("templates/client.py.tmpl") + if err != nil { + return nil, fmt.Errorf("reading Python client template: %w", err) + } + + tmpl, err := template.New("client_py").Funcs(pythonFuncMap(svc)).Parse(string(tmplContent)) + if err != nil { + return nil, fmt.Errorf("parsing template: %w", err) + } + + data := templateData{ + Service: svc, + } + + var buf bytes.Buffer + if err := tmpl.Execute(&buf, data); err != nil { + return nil, fmt.Errorf("executing template: %w", err) + } + + return buf.Bytes(), nil +} + +// pythonDefaultValue returns a Python default value for response.get() calls. +func pythonDefaultValue(p Param) string { + switch p.Type { + case "string": + return `, ""` + case "int", "int32", "int64": + return ", 0" + case "float32", "float64": + return ", 0.0" + case "bool": + return ", False" + case "[]byte": + return ", b\"\"" + default: + return ", None" + } +} + +// rustFuncMap returns the template functions for Rust client code generation. +func rustFuncMap(svc Service) template.FuncMap { + knownStructs := svc.KnownStructs() + return template.FuncMap{ + "lower": strings.ToLower, + "exportName": func(m Method) string { return m.FunctionName(svc.ExportPrefix()) }, + "requestType": func(m Method) string { return m.RequestTypeName(svc.Name) }, + "responseType": func(m Method) string { return m.ResponseTypeName(svc.Name) }, + "rustFunc": func(m Method) string { return m.RustFunctionName(svc.ExportPrefix()) }, + "rustDocComment": RustDocComment, + "rustType": func(p Param) string { return p.RustTypeWithStructs(knownStructs) }, + "rustParamType": func(p Param) string { return p.RustParamTypeWithStructs(knownStructs) }, + "fieldRustType": func(f FieldDef) string { return f.RustType(knownStructs) }, + } +} + +// GenerateClientRust generates Rust client wrapper code for plugins. +func GenerateClientRust(svc Service) ([]byte, error) { + tmplContent, err := templatesFS.ReadFile("templates/client.rs.tmpl") + if err != nil { + return nil, fmt.Errorf("reading Rust client template: %w", err) + } + + tmpl, err := template.New("client_rs").Funcs(rustFuncMap(svc)).Parse(string(tmplContent)) + if err != nil { + return nil, fmt.Errorf("parsing template: %w", err) + } + + partialContent, err := templatesFS.ReadFile("templates/base64_bytes.rs.tmpl") + if err != nil { + return nil, fmt.Errorf("reading base64_bytes partial: %w", err) + } + tmpl, err = tmpl.Parse(string(partialContent)) + if err != nil { + return nil, fmt.Errorf("parsing base64_bytes partial: %w", err) + } + + data := templateData{ + Service: svc, + } + + var buf bytes.Buffer + if err := tmpl.Execute(&buf, data); err != nil { + return nil, fmt.Errorf("executing template: %w", err) + } + + return buf.Bytes(), nil +} + +// firstLine returns the first line of a multi-line string, with the first word removed. +func firstLine(s string) string { + line := s + if idx := strings.Index(s, "\n"); idx >= 0 { + line = s[:idx] + } + // Remove the first word (service name like "ArtworkService") + if idx := strings.Index(line, " "); idx >= 0 { + line = line[idx+1:] + } + return line +} + +// GenerateRustLib generates the lib.rs file that exposes all service modules. +func GenerateRustLib(services []Service) ([]byte, error) { + tmplContent, err := templatesFS.ReadFile("templates/lib.rs.tmpl") + if err != nil { + return nil, fmt.Errorf("reading Rust lib template: %w", err) + } + + tmpl, err := template.New("lib_rs").Funcs(template.FuncMap{ + "lower": strings.ToLower, + "firstLine": firstLine, + }).Parse(string(tmplContent)) + if err != nil { + return nil, fmt.Errorf("parsing template: %w", err) + } + + data := struct { + Services []Service + }{ + Services: services, + } + + var buf bytes.Buffer + if err := tmpl.Execute(&buf, data); err != nil { + return nil, fmt.Errorf("executing template: %w", err) + } + + return buf.Bytes(), nil +} + +// GenerateGoDoc generates the doc.go file that provides package documentation. +func GenerateGoDoc(services []Service, pkgName string) ([]byte, error) { + tmplContent, err := templatesFS.ReadFile("templates/doc.go.tmpl") + if err != nil { + return nil, fmt.Errorf("reading Go doc template: %w", err) + } + + tmpl, err := template.New("doc_go").Funcs(template.FuncMap{ + "firstLine": firstLine, + }).Parse(string(tmplContent)) + if err != nil { + return nil, fmt.Errorf("parsing template: %w", err) + } + + data := struct { + Package string + Services []Service + }{ + Package: pkgName, + Services: services, + } + + var buf bytes.Buffer + if err := tmpl.Execute(&buf, data); err != nil { + return nil, fmt.Errorf("executing template: %w", err) + } + + return buf.Bytes(), nil +} + +// GenerateGoMod generates the go.mod file for the Go client library. +func GenerateGoMod() ([]byte, error) { + tmplContent, err := templatesFS.ReadFile("templates/go.mod.tmpl") + if err != nil { + return nil, fmt.Errorf("reading go.mod template: %w", err) + } + return tmplContent, nil +} + +// capabilityTemplateData holds data for capability template execution. +type capabilityTemplateData struct { + Package string + Capability Capability +} + +// capabilityFuncMap returns template functions for capability code generation. +func capabilityFuncMap(cap Capability) template.FuncMap { + return template.FuncMap{ + "formatDoc": formatDoc, + "indent": indentText, + "agentName": capabilityAgentName, + "providerInterface": func(e Export) string { return e.ProviderInterfaceName() }, + "implVar": func(e Export) string { return e.ImplVarName() }, + "exportFunc": func(e Export) string { return e.ExportFuncName() }, + } +} + +// indentText adds n tabs to each line of text. +func indentText(n int, s string) string { + indent := strings.Repeat("\t", n) + lines := strings.Split(s, "\n") + for i, line := range lines { + if line != "" { + lines[i] = indent + line + } + } + return strings.Join(lines, "\n") +} + +// capabilityAgentName returns the interface name for a capability. +// Uses the Go interface name stripped of common suffixes. +func capabilityAgentName(cap Capability) string { + name := cap.Interface + // Remove common suffixes to get a clean name + for _, suffix := range []string{"Agent", "Callback", "Service"} { + if strings.HasSuffix(name, suffix) { + name = name[:len(name)-len(suffix)] + break + } + } + // Use the shortened name or the original if no suffix found + if name == "" { + name = cap.Interface + } + return name +} + +// GenerateCapabilityGo generates Go export wrapper code for a capability. +func GenerateCapabilityGo(cap Capability, pkgName string) ([]byte, error) { + tmplContent, err := templatesFS.ReadFile("templates/capability.go.tmpl") + if err != nil { + return nil, fmt.Errorf("reading capability template: %w", err) + } + + tmpl, err := template.New("capability").Funcs(capabilityFuncMap(cap)).Parse(string(tmplContent)) + if err != nil { + return nil, fmt.Errorf("parsing template: %w", err) + } + + data := capabilityTemplateData{ + Package: pkgName, + Capability: cap, + } + + var buf bytes.Buffer + if err := tmpl.Execute(&buf, data); err != nil { + return nil, fmt.Errorf("executing template: %w", err) + } + + return buf.Bytes(), nil +} + +// GenerateCapabilityGoStub generates stub code for non-WASM platforms. +func GenerateCapabilityGoStub(cap Capability, pkgName string) ([]byte, error) { + tmplContent, err := templatesFS.ReadFile("templates/capability_stub.go.tmpl") + if err != nil { + return nil, fmt.Errorf("reading capability stub template: %w", err) + } + + tmpl, err := template.New("capability_stub").Funcs(capabilityFuncMap(cap)).Parse(string(tmplContent)) + if err != nil { + return nil, fmt.Errorf("parsing template: %w", err) + } + + data := capabilityTemplateData{ + Package: pkgName, + Capability: cap, + } + + var buf bytes.Buffer + if err := tmpl.Execute(&buf, data); err != nil { + return nil, fmt.Errorf("executing template: %w", err) + } + + return buf.Bytes(), nil +} + +// rustCapabilityFuncMap returns template functions for Rust capability code generation. +func rustCapabilityFuncMap(cap Capability) template.FuncMap { + knownStructs := cap.KnownStructs() + return template.FuncMap{ + "rustDocComment": RustDocComment, + "rustTypeAlias": rustTypeAlias, + "rustConstType": rustConstType, + "rustConstName": rustConstName, + "rustFieldName": func(name string) string { return ToSnakeCase(name) }, + "rustMethodName": func(name string) string { return ToSnakeCase(name) }, + "fieldRustType": func(f FieldDef) string { return f.RustType(knownStructs) }, + "rustOutputType": rustOutputType, + "isPrimitiveRust": isPrimitiveRustType, + "skipSerializingFunc": skipSerializingFunc, + "hasHashMap": hasHashMap, + "agentName": capabilityAgentName, + "providerInterface": func(e Export) string { return e.ProviderInterfaceName() }, + "registerMacroName": func(name string) string { return registerMacroName(cap.Name, name) }, + "snakeCase": ToSnakeCase, + "indent": func(spaces int, s string) string { + indent := strings.Repeat(" ", spaces) + lines := strings.Split(s, "\n") + for i, line := range lines { + if line != "" { + lines[i] = indent + line + } + } + return strings.Join(lines, "\n") + }, + } +} + +// rustTypeAlias converts a Go type to its Rust equivalent for type aliases. +// For string types used as error sentinels/constants, we use &'static str +// since Rust consts can't be heap-allocated String values. +func rustTypeAlias(goType string) string { + switch goType { + case "string": + return "&'static str" + case "int", "int32": + return "i32" + case "int64": + return "i64" + default: + return goType + } +} + +// rustConstType converts a Go type to its Rust equivalent for const declarations. +// For String types, it returns &'static str since Rust consts can't be heap-allocated. +func rustConstType(goType string) string { + switch goType { + case "string", "String": + return "&'static str" + case "int", "int32": + return "i32" + case "int64": + return "i64" + default: + return goType + } +} + +// rustOutputType converts a Go type to Rust for capability method signatures. +// It handles pointer types specially - for capability outputs, pointers become the base type +// (not Option) because Rust's Result already provides optional semantics. +// +// TODO: Pointer to primitive types (e.g., *string, *int32) are not handled correctly. +// Currently "*string" returns "string" instead of "String". This would generate invalid +// Rust code. No current capability uses this pattern, but it should be fixed if needed. +func rustOutputType(goType string) string { + // Strip pointer prefix - capability outputs use Result for optionality + if strings.HasPrefix(goType, "*") { + return goType[1:] + } + // Convert Go primitives to Rust primitives + switch goType { + case "bool": + return "bool" + case "string": + return "String" + case "int", "int32": + return "i32" + case "int64": + return "i64" + case "float32": + return "f32" + case "float64": + return "f64" + } + return goType +} + +// isPrimitiveRustType returns true if the Go type maps to a Rust primitive type. +func isPrimitiveRustType(goType string) bool { + // Strip pointer prefix first + if strings.HasPrefix(goType, "*") { + goType = goType[1:] + } + switch goType { + case "bool", "string", "int", "int32", "int64", "float32", "float64": + return true + } + return false +} + +// rustConstName converts a Go const name to Rust convention (SCREAMING_SNAKE_CASE). +func rustConstName(name string) string { + return strings.ToUpper(ToSnakeCase(name)) +} + +// skipSerializingFunc returns the appropriate skip_serializing_if function name. +func skipSerializingFunc(goType string) string { + if strings.HasPrefix(goType, "*") || strings.HasPrefix(goType, "[]") || strings.HasPrefix(goType, "map[") { + return "Option::is_none" + } + switch goType { + case "string": + return "String::is_empty" + case "bool": + return "std::ops::Not::not" + case "int32": + return "is_zero_i32" + case "uint32": + return "is_zero_u32" + case "int64": + return "is_zero_i64" + case "uint64": + return "is_zero_u64" + case "float32": + return "is_zero_f32" + case "float64": + return "is_zero_f64" + default: + return "Option::is_none" + } +} + +// hasHashMap returns true if any struct in the capability uses HashMap. +func hasHashMap(cap Capability) bool { + for _, st := range cap.Structs { + for _, f := range st.Fields { + if strings.HasPrefix(f.Type, "map[") { + return true + } + } + } + return false +} + +// registerMacroName returns the macro name for registering an optional method. +// For package "websocket" and method "OnClose", returns "register_websocket_close". +func registerMacroName(pkg, name string) string { + // Remove common prefixes from method name + for _, prefix := range []string{"Get", "On"} { + if strings.HasPrefix(name, prefix) { + name = name[len(prefix):] + break + } + } + return "register_" + ToSnakeCase(pkg) + "_" + ToSnakeCase(name) +} + +// GenerateCapabilityRust generates Rust export wrapper code for a capability. +func GenerateCapabilityRust(cap Capability) ([]byte, error) { + tmplContent, err := templatesFS.ReadFile("templates/capability.rs.tmpl") + if err != nil { + return nil, fmt.Errorf("reading Rust capability template: %w", err) + } + + tmpl, err := template.New("capability_rust").Funcs(rustCapabilityFuncMap(cap)).Parse(string(tmplContent)) + if err != nil { + return nil, fmt.Errorf("parsing template: %w", err) + } + + partialContent, err := templatesFS.ReadFile("templates/base64_bytes.rs.tmpl") + if err != nil { + return nil, fmt.Errorf("reading base64_bytes partial: %w", err) + } + tmpl, err = tmpl.Parse(string(partialContent)) + if err != nil { + return nil, fmt.Errorf("parsing base64_bytes partial: %w", err) + } + + data := capabilityTemplateData{ + Package: cap.Name, + Capability: cap, + } + + var buf bytes.Buffer + if err := tmpl.Execute(&buf, data); err != nil { + return nil, fmt.Errorf("executing template: %w", err) + } + + return buf.Bytes(), nil +} + +// GenerateCapabilityRustLib generates the lib.rs file for the Rust capabilities crate. +func GenerateCapabilityRustLib(capabilities []Capability) ([]byte, error) { + var buf bytes.Buffer + buf.WriteString("// Code generated by ndpgen. DO NOT EDIT.\n\n") + buf.WriteString("//! Navidrome Plugin Development Kit - Capability Wrappers\n") + buf.WriteString("//!\n") + buf.WriteString("//! This crate provides type definitions, traits, and registration macros\n") + buf.WriteString("//! for implementing Navidrome plugin capabilities in Rust.\n\n") + + // Module declarations + for _, cap := range capabilities { + moduleName := ToSnakeCase(cap.Name) + buf.WriteString(fmt.Sprintf("pub mod %s;\n", moduleName)) + } + + return buf.Bytes(), nil +} + +// pdkFuncMap returns the template functions for PDK code generation. +func pdkFuncMap() template.FuncMap { + return template.FuncMap{ + "firstSentence": firstSentence, + "paramList": pdkParamList, + "returnList": pdkReturnList, + "argList": pdkArgList, + "argListWithReceiver": pdkArgListWithReceiver, + "mockReturns": pdkMockReturns, + "constValue": pdkConstValue, + "stubTypeUnderlying": stubTypeUnderlying, + "methodReceiver": pdkMethodReceiver, + } +} + +// stubTypeUnderlying returns the appropriate stub type for non-WASM builds. +// For types that reference internal packages (like memory.Memory), returns "struct{}". +func stubTypeUnderlying(t PDKType) string { + underlying := t.Underlying + // If the underlying type references a package (contains a dot), use a stub struct + if strings.Contains(underlying, ".") { + return "struct{}" + } + // For simple types like int, int32, return as-is + return underlying +} + +// firstSentence returns the first sentence of a doc string, normalized to a single line. +func firstSentence(doc string) string { + if doc == "" { + return "" + } + // Normalize whitespace (replace newlines with spaces, collapse multiple spaces) + doc = strings.Join(strings.Fields(doc), " ") + + // Find first period followed by space or end + for i, r := range doc { + if r == '.' && (i+1 >= len(doc) || doc[i+1] == ' ') { + return doc[:i+1] + } + } + return doc +} + +// pdkParamList generates a parameter list string for function signature. +func pdkParamList(params []PDKParam) string { + var parts []string + for _, p := range params { + if p.Name != "" { + parts = append(parts, p.Name+" "+p.Type) + } else { + parts = append(parts, p.Type) + } + } + return strings.Join(parts, ", ") +} + +// pdkReturnList generates a return list string for function signature. +func pdkReturnList(returns []PDKReturn) string { + if len(returns) == 0 { + return "" + } + if len(returns) == 1 && returns[0].Name == "" { + return " " + returns[0].Type + } + var parts []string + for _, r := range returns { + if r.Name != "" { + parts = append(parts, r.Name+" "+r.Type) + } else { + parts = append(parts, r.Type) + } + } + return " (" + strings.Join(parts, ", ") + ")" +} + +// pdkArgList generates an argument list string for function call. +func pdkArgList(params []PDKParam) string { + var parts []string + for _, p := range params { + if p.Name != "" { + parts = append(parts, p.Name) + } else { + parts = append(parts, "_") + } + } + return strings.Join(parts, ", ") +} + +// pdkArgListWithReceiver generates an argument list that includes the receiver variable +// as the first argument to PDKMock.Called(). This allows tests to verify which instance +// a method was called on. +func pdkArgListWithReceiver(params []PDKParam, typeName string) string { + // Use lowercase first letter of type name as receiver variable + receiverVar := strings.ToLower(typeName[:1]) + parts := []string{receiverVar} + for _, p := range params { + if p.Name != "" { + parts = append(parts, p.Name) + } else { + parts = append(parts, "_") + } + } + return strings.Join(parts, ", ") +} + +// pdkMethodReceiver generates the receiver declaration for a method. +// Example: "r *HTTPRequest" or "m Memory" +func pdkMethodReceiver(receiver, typeName string) string { + receiverVar := strings.ToLower(typeName[:1]) + if strings.HasPrefix(receiver, "*") { + return receiverVar + " *" + typeName + } + return receiverVar + " " + typeName +} + +// pdkMockReturns generates the mock return accessors for a function. +func pdkMockReturns(returns []PDKReturn) string { + var parts []string + for i, r := range returns { + parts = append(parts, mockAccessorForType(r.Type, i)) + } + return strings.Join(parts, ", ") +} + +// mockAccessorForType returns the testify mock accessor for a type. +func mockAccessorForType(typ string, idx int) string { + switch typ { + case "string": + return fmt.Sprintf("args.String(%d)", idx) + case "bool": + return fmt.Sprintf("args.Bool(%d)", idx) + case "int": + return fmt.Sprintf("args.Int(%d)", idx) + case "error": + return fmt.Sprintf("args.Error(%d)", idx) + case "[]byte": + return fmt.Sprintf("args.Get(%d).([]byte)", idx) + case "uint64": + return fmt.Sprintf("args.Get(%d).(uint64)", idx) + case "uint32": + return fmt.Sprintf("args.Get(%d).(uint32)", idx) + case "uint16": + return fmt.Sprintf("args.Get(%d).(uint16)", idx) + default: + return fmt.Sprintf("args.Get(%d).(%s)", idx, typ) + } +} + +// pdkConstValue returns the value expression for a constant. +func pdkConstValue(c PDKConst) string { + if c.Value == "" || c.Value == "iota" { + return "iota" + } + return c.Value +} + +// GeneratePDKGo generates the WASM implementation of the PDK wrapper package. +func GeneratePDKGo(symbols *PDKSymbols) ([]byte, error) { + tmplContent, err := templatesFS.ReadFile("templates/pdk.go.tmpl") + if err != nil { + return nil, fmt.Errorf("reading pdk template: %w", err) + } + + tmpl, err := template.New("pdk").Funcs(pdkFuncMap()).Parse(string(tmplContent)) + if err != nil { + return nil, fmt.Errorf("parsing template: %w", err) + } + + var buf bytes.Buffer + if err := tmpl.Execute(&buf, symbols); err != nil { + return nil, fmt.Errorf("executing template: %w", err) + } + + return buf.Bytes(), nil +} + +// GeneratePDKGoStub generates the native stub implementation of the PDK wrapper package. +func GeneratePDKGoStub(symbols *PDKSymbols) ([]byte, error) { + tmplContent, err := templatesFS.ReadFile("templates/pdk_stub.go.tmpl") + if err != nil { + return nil, fmt.Errorf("reading pdk stub template: %w", err) + } + + tmpl, err := template.New("pdk_stub").Funcs(pdkFuncMap()).Parse(string(tmplContent)) + if err != nil { + return nil, fmt.Errorf("parsing template: %w", err) + } + + var buf bytes.Buffer + if err := tmpl.Execute(&buf, symbols); err != nil { + return nil, fmt.Errorf("executing template: %w", err) + } + + return buf.Bytes(), nil +} + +// GeneratePDKTypesStub generates the native type definitions for the PDK wrapper package. +func GeneratePDKTypesStub(symbols *PDKSymbols) ([]byte, error) { + tmplContent, err := templatesFS.ReadFile("templates/types_stub.go.tmpl") + if err != nil { + return nil, fmt.Errorf("reading types stub template: %w", err) + } + + tmpl, err := template.New("types_stub").Funcs(pdkFuncMap()).Parse(string(tmplContent)) + if err != nil { + return nil, fmt.Errorf("parsing template: %w", err) + } + + var buf bytes.Buffer + if err := tmpl.Execute(&buf, symbols); err != nil { + return nil, fmt.Errorf("executing template: %w", err) + } + + return buf.Bytes(), nil +} diff --git a/plugins/cmd/ndpgen/internal/generator_test.go b/plugins/cmd/ndpgen/internal/generator_test.go new file mode 100644 index 000000000..34c2c2886 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/generator_test.go @@ -0,0 +1,1664 @@ +package internal + +import ( + "go/format" + "os" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Generator", func() { + Describe("GenerateHost", func() { + It("should generate valid Go code for a simple service with strings", func() { + // All methods use JSON request/response types + svc := Service{ + Name: "SubsonicAPI", + Permission: "subsonicapi", + Interface: "SubsonicAPIService", + Methods: []Method{ + { + Name: "Call", + HasError: true, + Params: []Param{NewParam("uri", "string")}, + Returns: []Param{NewParam("response", "string")}, + }, + }, + } + + code, err := GenerateHost(svc, "host") + Expect(err).NotTo(HaveOccurred()) + + // Verify the code is valid Go + _, err = format.Source(code) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Check for generated header + Expect(codeStr).To(ContainSubstring("Code generated by ndpgen. DO NOT EDIT.")) + + // Check for package declaration + Expect(codeStr).To(ContainSubstring("package host")) + + // All methods now use request type for JSON protocol + Expect(codeStr).To(ContainSubstring("type SubsonicAPICallRequest struct")) + Expect(codeStr).To(ContainSubstring(`Uri string `)) + + // Response type with error handling + Expect(codeStr).To(ContainSubstring("type SubsonicAPICallResponse struct")) + Expect(codeStr).To(ContainSubstring(`Response string `)) + Expect(codeStr).To(ContainSubstring(`Error string `)) + + // Check for registration function + Expect(codeStr).To(ContainSubstring("func RegisterSubsonicAPIHostFunctions(service SubsonicAPIService)")) + + // Check for host function name + Expect(codeStr).To(ContainSubstring(`"subsonicapi_call"`)) + + // Check for JSON unmarshal (all methods use JSON now) + Expect(codeStr).To(ContainSubstring("json.Unmarshal")) + }) + + It("should generate code for methods without parameters", func() { + svc := Service{ + Name: "Test", + Permission: "test", + Interface: "TestService", + Methods: []Method{ + { + Name: "NoParams", + HasError: true, + Returns: []Param{NewParam("result", "string")}, + }, + }, + } + + code, err := GenerateHost(svc, "host") + Expect(err).NotTo(HaveOccurred()) + + _, err = format.Source(code) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + // Methods without params don't need a request type - no params to serialize + Expect(codeStr).NotTo(ContainSubstring("type TestNoParamsRequest struct")) + // But still uses PTR input/output for consistency + Expect(codeStr).To(MatchRegexp(`\[\]extism\.ValueType\{extism\.ValueTypePTR\},\s*\[\]extism\.ValueType\{extism\.ValueTypePTR\}`)) + }) + + It("should generate code for methods without return values", func() { + svc := Service{ + Name: "Test", + Permission: "test", + Interface: "TestService", + Methods: []Method{ + { + Name: "NoReturn", + HasError: true, + Params: []Param{NewParam("input", "string")}, + }, + }, + } + + code, err := GenerateHost(svc, "host") + Expect(err).NotTo(HaveOccurred()) + + _, err = format.Source(code) + Expect(err).NotTo(HaveOccurred()) + }) + + It("should generate code for multiple methods", func() { + svc := Service{ + Name: "Scheduler", + Permission: "scheduler", + Interface: "SchedulerService", + Methods: []Method{ + { + Name: "ScheduleRecurring", + HasError: true, + Params: []Param{NewParam("cronExpression", "string")}, + Returns: []Param{NewParam("scheduleID", "string")}, + }, + { + Name: "ScheduleOneTime", + HasError: true, + Params: []Param{NewParam("delaySeconds", "int32")}, + Returns: []Param{NewParam("scheduleID", "string")}, + }, + { + Name: "CancelSchedule", + HasError: true, + Params: []Param{NewParam("scheduleID", "string")}, + Returns: []Param{NewParam("canceled", "bool")}, + }, + }, + } + + code, err := GenerateHost(svc, "host") + Expect(err).NotTo(HaveOccurred()) + + _, err = format.Source(code) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + Expect(codeStr).To(ContainSubstring("scheduler_schedulerecurring")) + Expect(codeStr).To(ContainSubstring("scheduler_scheduleonetime")) + Expect(codeStr).To(ContainSubstring("scheduler_cancelschedule")) + }) + + It("should handle multiple simple parameters with JSON", func() { + // All params use JSON - single PTR input + svc := Service{ + Name: "Test", + Permission: "test", + Interface: "TestService", + Methods: []Method{ + { + Name: "MultiParam", + HasError: true, + Params: []Param{ + NewParam("name", "string"), + NewParam("count", "int32"), + NewParam("enabled", "bool"), + }, + Returns: []Param{NewParam("result", "string")}, + }, + }, + } + + code, err := GenerateHost(svc, "host") + Expect(err).NotTo(HaveOccurred()) + + _, err = format.Source(code) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + // All methods use request type with JSON protocol + Expect(codeStr).To(ContainSubstring("type TestMultiParamRequest struct")) + // Check for JSON unmarshal (all methods use JSON now) + Expect(codeStr).To(ContainSubstring("json.Unmarshal")) + // Check that input/output ValueType both use PTR (JSON) + Expect(codeStr).To(MatchRegexp(`\[\]extism\.ValueType\{extism\.ValueTypePTR\},\s*\[\]extism\.ValueType\{extism\.ValueTypePTR\}`)) + }) + + It("should use single PTR for mixed simple and complex params", func() { + // When any param needs JSON, all are bundled into one request struct + svc := Service{ + Name: "Test", + Permission: "test", + Interface: "TestService", + Methods: []Method{ + { + Name: "MixedParam", + HasError: true, + Params: []Param{ + NewParam("id", "string"), // simple (PTR for string) + NewParam("tags", "[]string"), // complex - needs JSON + }, + Returns: []Param{NewParam("count", "int32")}, // simple + }, + }, + } + + code, err := GenerateHost(svc, "host") + Expect(err).NotTo(HaveOccurred()) + + _, err = format.Source(code) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + // Request type IS needed because of complex param + Expect(codeStr).To(ContainSubstring("type TestMixedParamRequest struct")) + // When using request type, only ONE PTR for input (the JSON request) + Expect(codeStr).To(MatchRegexp(`\[\]extism\.ValueType\{extism\.ValueTypePTR\},\s*\[\]extism\.ValueType\{extism\.ValueTypePTR\}`)) + }) + + It("should generate proper JSON tags for complex types", func() { + // Complex types (structs, slices, maps) need JSON serialization + svc := Service{ + Name: "Test", + Permission: "test", + Interface: "TestService", + Methods: []Method{ + { + Name: "Method", + HasError: true, + Params: []Param{NewParam("inputValue", "[]string")}, // slice needs JSON + Returns: []Param{NewParam("outputValue", "map[string]string")}, // map needs JSON + }, + }, + } + + code, err := GenerateHost(svc, "host") + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + // Complex params need request type with JSON tags + Expect(codeStr).To(ContainSubstring(`json:"inputValue"`)) + // Complex returns need response type with JSON tags + Expect(codeStr).To(ContainSubstring(`json:"outputValue,omitempty"`)) + }) + + It("should include required imports", func() { + // Service with complex types needs JSON import + svc := Service{ + Name: "Test", + Permission: "test", + Interface: "TestService", + Methods: []Method{ + { + Name: "Method", + HasError: true, + Params: []Param{NewParam("data", "MyStruct")}, // struct needs JSON + }, + }, + } + + code, err := GenerateHost(svc, "host") + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + Expect(codeStr).To(ContainSubstring(`"context"`)) + Expect(codeStr).To(ContainSubstring(`"encoding/json"`)) + Expect(codeStr).To(ContainSubstring(`extism "github.com/extism/go-sdk"`)) + }) + + It("should always include json import for JSON protocol", func() { + // All services use JSON protocol, so json import is always needed + svc := Service{ + Name: "Test", + Permission: "test", + Interface: "TestService", + Methods: []Method{ + { + Name: "Method", + Params: []Param{NewParam("count", "int32")}, + Returns: []Param{NewParam("result", "int64")}, + }, + }, + } + + code, err := GenerateHost(svc, "host") + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + Expect(codeStr).To(ContainSubstring(`"context"`)) + Expect(codeStr).To(ContainSubstring(`"encoding/json"`)) + Expect(codeStr).To(ContainSubstring(`extism "github.com/extism/go-sdk"`)) + }) + }) + + Describe("toJSONName", func() { + It("should convert to camelCase matching Rust serde behavior", func() { + Expect(toJSONName("InputValue")).To(Equal("inputValue")) + Expect(toJSONName("URI")).To(Equal("uri")) + Expect(toJSONName("id")).To(Equal("id")) + Expect(toJSONName("ID")).To(Equal("id")) + Expect(toJSONName("ConnectionID")).To(Equal("connectionId")) + Expect(toJSONName("NewConnectionID")).To(Equal("newConnectionId")) + Expect(toJSONName("XMLHTTPRequest")).To(Equal("xmlhttpRequest")) + Expect(toJSONName("APIKey")).To(Equal("apiKey")) + }) + + It("should handle empty string", func() { + Expect(toJSONName("")).To(Equal("")) + }) + }) + + Describe("NewParam", func() { + It("should create param with auto-generated JSON name", func() { + p := NewParam("MyParam", "string") + Expect(p.Name).To(Equal("MyParam")) + Expect(p.Type).To(Equal("string")) + Expect(p.JSONName).To(Equal("myParam")) + }) + }) + + Describe("Method.IsOptionPattern", func() { + It("should return true for (value, exists bool) pattern", func() { + m := Method{ + Returns: []Param{ + {Name: "value", Type: "string"}, + {Name: "exists", Type: "bool"}, + }, + } + Expect(m.IsOptionPattern()).To(BeTrue()) + }) + + It("should return true for (value, ok bool) pattern", func() { + m := Method{ + Returns: []Param{ + {Name: "value", Type: "int64"}, + {Name: "ok", Type: "bool"}, + }, + } + Expect(m.IsOptionPattern()).To(BeTrue()) + }) + + It("should return true for (value, found bool) pattern", func() { + m := Method{ + Returns: []Param{ + {Name: "data", Type: "[]byte"}, + {Name: "found", Type: "bool"}, + }, + } + Expect(m.IsOptionPattern()).To(BeTrue()) + }) + + It("should be case insensitive for bool name", func() { + m := Method{ + Returns: []Param{ + {Name: "value", Type: "string"}, + {Name: "EXISTS", Type: "bool"}, + }, + } + Expect(m.IsOptionPattern()).To(BeTrue()) + }) + + It("should return false for single return", func() { + m := Method{ + Returns: []Param{ + {Name: "value", Type: "string"}, + }, + } + Expect(m.IsOptionPattern()).To(BeFalse()) + }) + + It("should return false for more than two returns", func() { + m := Method{ + Returns: []Param{ + {Name: "value", Type: "string"}, + {Name: "count", Type: "int"}, + {Name: "exists", Type: "bool"}, + }, + } + Expect(m.IsOptionPattern()).To(BeFalse()) + }) + + It("should return false when second return is not bool", func() { + m := Method{ + Returns: []Param{ + {Name: "value", Type: "string"}, + {Name: "count", Type: "int"}, + }, + } + Expect(m.IsOptionPattern()).To(BeFalse()) + }) + + It("should return false when bool is not named exists/ok/found", func() { + m := Method{ + Returns: []Param{ + {Name: "value", Type: "string"}, + {Name: "success", Type: "bool"}, + }, + } + Expect(m.IsOptionPattern()).To(BeFalse()) + }) + + It("should return false for Has() pattern where first return is bool", func() { + // Has(key) -> (exists bool) should NOT be treated as Option pattern + m := Method{ + Returns: []Param{ + {Name: "exists", Type: "bool"}, + }, + } + Expect(m.IsOptionPattern()).To(BeFalse()) + }) + + It("should return false when first return is bool (preserves Has-like methods)", func() { + // Even with two returns, if first is bool, don't convert to Option + m := Method{ + Returns: []Param{ + {Name: "result", Type: "bool"}, + {Name: "exists", Type: "bool"}, + }, + } + Expect(m.IsOptionPattern()).To(BeFalse()) + }) + }) + + Describe("Python type and name helpers", func() { + Describe("ToPythonType", func() { + It("should map Go types to Python types", func() { + Expect(ToPythonType("string")).To(Equal("str")) + Expect(ToPythonType("int")).To(Equal("int")) + Expect(ToPythonType("int32")).To(Equal("int")) + Expect(ToPythonType("int64")).To(Equal("int")) + Expect(ToPythonType("float32")).To(Equal("float")) + Expect(ToPythonType("float64")).To(Equal("float")) + Expect(ToPythonType("bool")).To(Equal("bool")) + Expect(ToPythonType("[]byte")).To(Equal("bytes")) + Expect(ToPythonType("unknown")).To(Equal("Any")) + }) + }) + + Describe("ToSnakeCase", func() { + It("should convert PascalCase to snake_case", func() { + Expect(ToSnakeCase("ScheduleRecurring")).To(Equal("schedule_recurring")) + Expect(ToSnakeCase("GetString")).To(Equal("get_string")) + Expect(ToSnakeCase("simple")).To(Equal("simple")) + }) + + It("should handle acronyms correctly", func() { + Expect(ToSnakeCase("ID")).To(Equal("id")) + Expect(ToSnakeCase("ScheduleID")).To(Equal("schedule_id")) + Expect(ToSnakeCase("NewScheduleID")).To(Equal("new_schedule_id")) + Expect(ToSnakeCase("XMLParser")).To(Equal("xml_parser")) + Expect(ToSnakeCase("GetHTTPResponse")).To(Equal("get_http_response")) + }) + }) + + Describe("Method.PythonFunctionName", func() { + It("should generate snake_case function name with service prefix", func() { + m := Method{Name: "GetString"} + Expect(m.PythonFunctionName("cache")).To(Equal("cache_get_string")) + }) + }) + + Describe("Param.PythonType", func() { + It("should return Python type for parameter", func() { + p := NewParam("value", "string") + Expect(p.PythonType()).To(Equal("str")) + }) + }) + + Describe("Param.PythonName", func() { + It("should return snake_case name for parameter", func() { + p := NewParam("ttlSeconds", "int64") + Expect(p.PythonName()).To(Equal("ttl_seconds")) + }) + }) + }) + + Describe("GenerateClientPython", func() { + It("should generate valid Python code for a simple service", func() { + svc := Service{ + Name: "SubsonicAPI", + Permission: "subsonicapi", + Interface: "SubsonicAPIService", + Methods: []Method{ + { + Name: "Call", + HasError: true, + Params: []Param{NewParam("uri", "string")}, + Returns: []Param{NewParam("responseJSON", "string")}, + }, + }, + } + + code, err := GenerateClientPython(svc) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Check for generated header + Expect(codeStr).To(ContainSubstring("Code generated by ndpgen. DO NOT EDIT.")) + + // Check for imports + Expect(codeStr).To(ContainSubstring("from dataclasses import dataclass")) + Expect(codeStr).To(ContainSubstring("import extism")) + Expect(codeStr).To(ContainSubstring("import json")) + + // Check for exception class + Expect(codeStr).To(ContainSubstring("class HostFunctionError(Exception):")) + + // Check for raw import function + Expect(codeStr).To(ContainSubstring(`@extism.import_fn("extism:host/user", "subsonicapi_call")`)) + Expect(codeStr).To(ContainSubstring("def _subsonicapi_call(offset: int) -> int:")) + + // Check for wrapper function with type hints + Expect(codeStr).To(ContainSubstring("def subsonicapi_call(uri: str) -> str:")) + + // Check for error handling + Expect(codeStr).To(ContainSubstring("raise HostFunctionError(response[")) + }) + + It("should generate dataclass for multi-value returns", func() { + svc := Service{ + Name: "Cache", + Permission: "cache", + Interface: "CacheService", + Methods: []Method{ + { + Name: "GetString", + HasError: true, + Params: []Param{NewParam("key", "string")}, + Returns: []Param{ + NewParam("value", "string"), + NewParam("exists", "bool"), + }, + }, + }, + } + + code, err := GenerateClientPython(svc) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Check for dataclass + Expect(codeStr).To(ContainSubstring("@dataclass")) + Expect(codeStr).To(ContainSubstring("class CacheGetStringResult:")) + Expect(codeStr).To(ContainSubstring("value: str")) + Expect(codeStr).To(ContainSubstring("exists: bool")) + + // Check that function returns dataclass + Expect(codeStr).To(ContainSubstring("def cache_get_string(key: str) -> CacheGetStringResult:")) + Expect(codeStr).To(ContainSubstring("return CacheGetStringResult(")) + }) + + It("should handle methods with no parameters", func() { + svc := Service{ + Name: "Test", + Permission: "test", + Interface: "TestService", + Methods: []Method{ + { + Name: "NoParams", + HasError: true, + Returns: []Param{NewParam("result", "string")}, + }, + }, + } + + code, err := GenerateClientPython(svc) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Function with no params + Expect(codeStr).To(ContainSubstring("def test_no_params() -> str:")) + // Empty request + Expect(codeStr).To(ContainSubstring(`request_bytes = b"{}"`)) + }) + + It("should handle methods with no return values", func() { + svc := Service{ + Name: "Test", + Permission: "test", + Interface: "TestService", + Methods: []Method{ + { + Name: "NoReturn", + HasError: true, + Params: []Param{NewParam("input", "string")}, + }, + }, + } + + code, err := GenerateClientPython(svc) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Function returns None + Expect(codeStr).To(ContainSubstring("def test_no_return(input: str) -> None:")) + }) + + It("should generate correct Python defaults for different types", func() { + svc := Service{ + Name: "Test", + Permission: "test", + Interface: "TestService", + Methods: []Method{ + { + Name: "AllTypes", + HasError: true, + Returns: []Param{ + NewParam("strVal", "string"), + NewParam("intVal", "int64"), + NewParam("floatVal", "float64"), + NewParam("boolVal", "bool"), + }, + }, + }, + } + + code, err := GenerateClientPython(svc) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Check defaults in response.get() calls + Expect(codeStr).To(ContainSubstring(`response.get("strVal", "")`)) + Expect(codeStr).To(ContainSubstring(`response.get("intVal", 0)`)) + Expect(codeStr).To(ContainSubstring(`response.get("floatVal", 0.0)`)) + Expect(codeStr).To(ContainSubstring(`response.get("boolVal", False)`)) + }) + + It("should not import base64 for non-byte services", func() { + svc := Service{ + Name: "Test", + Permission: "test", + Interface: "TestService", + Methods: []Method{ + { + Name: "Call", + HasError: true, + Params: []Param{NewParam("uri", "string")}, + Returns: []Param{NewParam("response", "string")}, + }, + }, + } + + code, err := GenerateClientPython(svc) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + Expect(codeStr).NotTo(ContainSubstring("import base64")) + }) + + It("should generate base64 encoding/decoding for byte fields", func() { + svc := Service{ + Name: "Codec", + Permission: "codec", + Interface: "CodecService", + Methods: []Method{ + { + Name: "Encode", + HasError: true, + Params: []Param{NewParam("data", "[]byte")}, + Returns: []Param{NewParam("result", "[]byte")}, + }, + }, + } + + code, err := GenerateClientPython(svc) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Should import base64 + Expect(codeStr).To(ContainSubstring("import base64")) + + // Should base64-encode byte params in request + Expect(codeStr).To(ContainSubstring(`base64.b64encode(data).decode("ascii")`)) + + // Should base64-decode byte returns in response + Expect(codeStr).To(ContainSubstring(`base64.b64decode(response.get("result", ""))`)) + }) + }) + + Describe("GenerateGoDoc", func() { + It("should generate valid doc.go content for multiple services", func() { + services := []Service{ + { + Name: "Cache", + Permission: "cache", + Interface: "CacheService", + Doc: "CacheService provides temporary key-value storage with TTL.", + }, + { + Name: "Scheduler", + Permission: "scheduler", + Interface: "SchedulerService", + Doc: "SchedulerService manages scheduled tasks.", + }, + } + + code, err := GenerateGoDoc(services, "ndpdk") + Expect(err).NotTo(HaveOccurred()) + + // Verify it's valid Go code + _, err = format.Source(code) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Check for generated header + Expect(codeStr).To(ContainSubstring("Code generated by ndpgen. DO NOT EDIT.")) + + // Check for package declaration + Expect(codeStr).To(ContainSubstring("package ndpdk")) + + // Check for package documentation + Expect(codeStr).To(ContainSubstring("Package ndpdk provides Navidrome Plugin Development Kit wrappers")) + + // Check that services are listed + Expect(codeStr).To(ContainSubstring("Cache:")) + Expect(codeStr).To(ContainSubstring("Scheduler:")) + }) + }) + + Describe("GenerateGoMod", func() { + It("should generate valid go.mod content", func() { + code, err := GenerateGoMod() + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Check for module declaration (consolidated PDK path at pdk/go level) + Expect(codeStr).To(ContainSubstring("module github.com/navidrome/navidrome/plugins/pdk/go")) + // Ensure it's not the old host-specific path + Expect(codeStr).NotTo(ContainSubstring("module github.com/navidrome/navidrome/plugins/pdk/go/host")) + + // Check for Go version + Expect(codeStr).To(ContainSubstring("go 1.25")) + + // Check for extism-go-pdk dependency + Expect(codeStr).To(ContainSubstring("github.com/extism/go-pdk")) + }) + }) + + Describe("GenerateClientGo", func() { + It("should include errors import when service has methods with errors", func() { + svc := Service{ + Name: "Cache", + Permission: "cache", + Interface: "CacheService", + Methods: []Method{ + { + Name: "Get", + HasError: true, + Params: []Param{NewParam("key", "string")}, + Returns: []Param{NewParam("value", "string")}, + }, + }, + } + + code, err := GenerateClientGo(svc, "host") + Expect(err).NotTo(HaveOccurred()) + + // Verify the code is valid Go (can't actually compile without wasip1) + codeStr := string(code) + + // Check for errors import when methods have errors + Expect(codeStr).To(ContainSubstring(`"errors"`)) + Expect(codeStr).To(ContainSubstring("errors.New")) + }) + + It("should not include errors import when service has no methods with errors", func() { + svc := Service{ + Name: "Config", + Permission: "config", + Interface: "ConfigService", + Methods: []Method{ + { + Name: "Get", + HasError: false, + Params: []Param{NewParam("key", "string")}, + Returns: []Param{NewParam("value", "string"), NewParam("exists", "bool")}, + }, + { + Name: "List", + HasError: false, + Params: []Param{NewParam("prefix", "string")}, + Returns: []Param{NewParam("keys", "[]string")}, + }, + }, + } + + code, err := GenerateClientGo(svc, "host") + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Check that errors is NOT imported when no methods have errors + Expect(codeStr).NotTo(ContainSubstring(`"errors"`)) + Expect(codeStr).NotTo(ContainSubstring("errors.New")) + }) + + It("should generate valid Go code structure", func() { + svc := Service{ + Name: "SubsonicAPI", + Permission: "subsonicapi", + Interface: "SubsonicAPIService", + Methods: []Method{ + { + Name: "Call", + HasError: true, + Params: []Param{NewParam("uri", "string")}, + Returns: []Param{NewParam("response", "string")}, + }, + }, + } + + code, err := GenerateClientGo(svc, "host") + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Check for generated header + Expect(codeStr).To(ContainSubstring("Code generated by ndpgen. DO NOT EDIT.")) + + // Check for build tag + Expect(codeStr).To(ContainSubstring("//go:build wasip1")) + + // Check for package declaration + Expect(codeStr).To(ContainSubstring("package host")) + + // Check for wasmimport directive + Expect(codeStr).To(ContainSubstring("//go:wasmimport extism:host/user")) + + // Check for PDK import + Expect(codeStr).To(ContainSubstring("github.com/navidrome/navidrome/plugins/pdk/go/pdk")) + }) + + }) + + Describe("GenerateClientGoStub", func() { + It("should generate valid mock code with testify/mock", func() { + svc := Service{ + Name: "Cache", + Permission: "cache", + Interface: "CacheService", + Doc: "CacheService provides caching capabilities.", + Methods: []Method{ + { + Name: "Get", + Doc: "Get retrieves a value from the cache.", + Params: []Param{ + {Name: "key", Type: "string"}, + }, + Returns: []Param{ + {Name: "value", Type: "string"}, + {Name: "exists", Type: "bool"}, + }, + }, + }, + } + + code, err := GenerateClientGoStub(svc, "ndpdk") + Expect(err).NotTo(HaveOccurred()) + + // Verify it's valid Go code + _, err = format.Source(code) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Check for build tag (non-WASM) + Expect(codeStr).To(ContainSubstring("//go:build !wasip1")) + + // Check for package declaration + Expect(codeStr).To(ContainSubstring("package ndpdk")) + + // Check for mock comment + Expect(codeStr).To(ContainSubstring("mock implementations for non-WASM builds")) + + // Check for testify/mock import + Expect(codeStr).To(ContainSubstring(`"github.com/stretchr/testify/mock"`)) + + // Check for private mock struct + Expect(codeStr).To(ContainSubstring("type mockCacheService struct")) + Expect(codeStr).To(ContainSubstring("mock.Mock")) + + // Check for exported mock instance + Expect(codeStr).To(ContainSubstring("var CacheMock = &mockCacheService{}")) + + // Check for mock method + Expect(codeStr).To(ContainSubstring("func (m *mockCacheService) Get(key string)")) + Expect(codeStr).To(ContainSubstring("m.Called(key)")) + + // Check for wrapper function delegating to mock + Expect(codeStr).To(ContainSubstring("func CacheGet(key string)")) + Expect(codeStr).To(ContainSubstring("return CacheMock.Get(key)")) + + // Stub files should NOT have request/response types (they're not needed) + Expect(codeStr).NotTo(ContainSubstring("Request struct")) + Expect(codeStr).NotTo(ContainSubstring("Response struct")) + }) + + It("should generate correct mock return values for different types", func() { + svc := Service{ + Name: "Test", + Permission: "test", + Interface: "TestService", + Methods: []Method{ + { + Name: "GetString", + Params: []Param{ + {Name: "key", Type: "string"}, + }, + Returns: []Param{ + {Name: "value", Type: "string"}, + }, + HasError: true, + }, + { + Name: "GetInt64", + Params: []Param{ + {Name: "key", Type: "string"}, + }, + Returns: []Param{ + {Name: "value", Type: "int64"}, + {Name: "exists", Type: "bool"}, + }, + HasError: true, + }, + { + Name: "GetBytes", + Params: []Param{ + {Name: "key", Type: "string"}, + }, + Returns: []Param{ + {Name: "value", Type: "[]byte"}, + }, + HasError: true, + }, + }, + } + + code, err := GenerateClientGoStub(svc, "ndpdk") + Expect(err).NotTo(HaveOccurred()) + + // Verify it's valid Go code + _, err = format.Source(code) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Check string return uses args.String(0) + Expect(codeStr).To(ContainSubstring("args.String(0)")) + + // Check int64 return uses args.Get(0).(int64) + Expect(codeStr).To(ContainSubstring("args.Get(0).(int64)")) + + // Check bool return uses args.Bool(1) + Expect(codeStr).To(ContainSubstring("args.Bool(1)")) + + // Check []byte return uses args.Get(0).([]byte) + Expect(codeStr).To(ContainSubstring("args.Get(0).([]byte)")) + + // Check error returns use args.Error(N) + Expect(codeStr).To(ContainSubstring("args.Error(")) + }) + }) + + Describe("Integration", func() { + It("should generate compilable code from parsed source", func() { + // This is an integration test that verifies the full pipeline + src := `package host + +import "context" + +// TestService is a test service. +//nd:hostservice name=Test permission=test +type TestService interface { + // DoSomething does something. + //nd:hostfunc + DoSomething(ctx context.Context, input string) (output string, err error) +} +` + // Create temporary directory + tmpDir := GinkgoT().TempDir() + path := tmpDir + "/test.go" + err := writeFile(path, src) + Expect(err).NotTo(HaveOccurred()) + + // Parse + services, err := ParseDirectory(tmpDir) + Expect(err).NotTo(HaveOccurred()) + Expect(services).To(HaveLen(1)) + + // Generate + code, err := GenerateHost(services[0], "host") + Expect(err).NotTo(HaveOccurred()) + + // Format (validates syntax) + formatted, err := format.Source(code) + Expect(err).NotTo(HaveOccurred()) + + // Verify key elements + codeStr := string(formatted) + Expect(codeStr).To(ContainSubstring("RegisterTestHostFunctions")) + Expect(codeStr).To(ContainSubstring(`"test_dosomething"`)) + }) + }) + + Describe("GenerateCapabilityGo", func() { + It("should generate valid Go code for a non-required capability", func() { + cap := Capability{ + Name: "metadata", + Interface: "MetadataAgent", + Required: false, + Doc: "MetadataAgent provides metadata retrieval.", + Methods: []Export{ + { + Name: "GetArtistBiography", + ExportName: "nd_get_artist_biography", + Input: Param{Type: "ArtistInput"}, + Output: Param{Type: "ArtistBiographyOutput"}, + Doc: "Returns artist biography", + }, + { + Name: "GetArtistImages", + ExportName: "nd_get_artist_images", + Input: Param{Type: "ArtistInput"}, + Output: Param{Type: "ArtistImagesOutput"}, + Doc: "Returns artist images", + }, + }, + Structs: []StructDef{ + { + Name: "ArtistInput", + Fields: []FieldDef{ + {Name: "ID", Type: "string", JSONTag: "id"}, + {Name: "Name", Type: "string", JSONTag: "name"}, + }, + }, + { + Name: "ArtistBiographyOutput", + Fields: []FieldDef{ + {Name: "Biography", Type: "string", JSONTag: "biography"}, + }, + }, + { + Name: "ArtistImagesOutput", + Fields: []FieldDef{ + {Name: "Images", Type: "[]ImageInfo", JSONTag: "images"}, + }, + }, + { + Name: "ImageInfo", + Fields: []FieldDef{ + {Name: "URL", Type: "string", JSONTag: "url"}, + {Name: "Size", Type: "int32", JSONTag: "size"}, + }, + }, + }, + } + + code, err := GenerateCapabilityGo(cap, "metadata") + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Check for build tag + Expect(codeStr).To(ContainSubstring("//go:build wasip1")) + + // Check for package declaration + Expect(codeStr).To(ContainSubstring("package metadata")) + + // Check for marker interface (non-required) + Expect(codeStr).To(ContainSubstring("type Metadata interface{}")) + + // Check for provider interfaces + Expect(codeStr).To(ContainSubstring("type ArtistBiographyProvider interface")) + Expect(codeStr).To(ContainSubstring("type ArtistImagesProvider interface")) + + // Check for Register function with type assertions + Expect(codeStr).To(ContainSubstring("func Register(impl Metadata)")) + Expect(codeStr).To(ContainSubstring("impl.(ArtistBiographyProvider)")) + + // Check for export wrappers + Expect(codeStr).To(ContainSubstring("//go:wasmexport nd_get_artist_biography")) + Expect(codeStr).To(ContainSubstring("func _NdGetArtistBiography()")) + + // Check for NotImplementedCode handling + Expect(codeStr).To(ContainSubstring("NotImplementedCode")) + Expect(codeStr).To(ContainSubstring("return NotImplementedCode")) + + // Check struct definitions + Expect(codeStr).To(ContainSubstring("type ArtistInput struct")) + Expect(codeStr).To(ContainSubstring("type ImageInfo struct")) + }) + + It("should generate valid Go code for a required capability", func() { + cap := Capability{ + Name: "scrobbler", + Interface: "Scrobbler", + Required: true, + Methods: []Export{ + { + Name: "IsAuthorized", + ExportName: "nd_scrobbler_is_authorized", + Input: Param{Type: "AuthInput"}, + Output: Param{Type: "AuthOutput"}, + }, + { + Name: "Scrobble", + ExportName: "nd_scrobbler_scrobble", + Input: Param{Type: "ScrobbleInput"}, + Output: Param{Type: "ScrobblerOutput"}, + }, + }, + Structs: []StructDef{ + {Name: "AuthInput", Fields: []FieldDef{{Name: "UserID", Type: "string", JSONTag: "userId"}}}, + {Name: "AuthOutput", Fields: []FieldDef{{Name: "Authorized", Type: "bool", JSONTag: "authorized"}}}, + {Name: "ScrobbleInput", Fields: []FieldDef{{Name: "UserID", Type: "string", JSONTag: "userId"}}}, + {Name: "ScrobblerOutput", Fields: []FieldDef{{Name: "Error", Type: "*string", JSONTag: "error", OmitEmpty: true}}}, + }, + } + + code, err := GenerateCapabilityGo(cap, "scrobbler") + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Check for full interface (required capability) + Expect(codeStr).To(ContainSubstring("type Scrobbler interface {")) + Expect(codeStr).To(ContainSubstring("IsAuthorized(AuthInput) (AuthOutput, error)")) + Expect(codeStr).To(ContainSubstring("Scrobble(ScrobbleInput) (ScrobblerOutput, error)")) + + // Should NOT have provider interfaces for required capability + Expect(codeStr).NotTo(ContainSubstring("AuthProvider interface")) + + // Register should directly assign methods + Expect(codeStr).To(ContainSubstring("func Register(impl Scrobbler)")) + Expect(codeStr).To(ContainSubstring("impl.IsAuthorized")) + }) + + It("should include type aliases and consts", func() { + cap := Capability{ + Name: "scrobbler", + Interface: "Scrobbler", + Required: true, + Methods: []Export{ + { + Name: "Scrobble", + ExportName: "nd_scrobble", + Input: Param{Type: "ScrobbleInput"}, + Output: Param{Type: "ScrobblerOutput"}, + }, + }, + Structs: []StructDef{ + {Name: "ScrobbleInput", Fields: []FieldDef{{Name: "UserID", Type: "string", JSONTag: "userId"}}}, + {Name: "ScrobblerOutput", Fields: []FieldDef{{Name: "ErrorType", Type: "*ScrobblerErrorType", JSONTag: "errorType", OmitEmpty: true}}}, + }, + TypeAliases: []TypeAlias{ + {Name: "ScrobblerErrorType", Type: "string", Doc: "ScrobblerErrorType indicates error handling."}, + }, + Consts: []ConstGroup{ + { + Type: "ScrobblerErrorType", + Values: []ConstDef{ + {Name: "ScrobblerErrorNone", Value: `"none"`, Doc: "No error"}, + {Name: "ScrobblerErrorRetry", Value: `"retry"`, Doc: "Retry later"}, + }, + }, + }, + } + + code, err := GenerateCapabilityGo(cap, "scrobbler") + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Check type alias + Expect(codeStr).To(ContainSubstring("type ScrobblerErrorType string")) + + // Check consts - all consts should have type annotation + Expect(codeStr).To(ContainSubstring("ScrobblerErrorNone ScrobblerErrorType =")) + Expect(codeStr).To(ContainSubstring(`"none"`)) + Expect(codeStr).To(ContainSubstring("ScrobblerErrorRetry ScrobblerErrorType =")) + Expect(codeStr).To(ContainSubstring(`"retry"`)) + }) + }) + + Describe("GenerateCapabilityGoStub", func() { + It("should generate valid stub code for non-WASM builds", func() { + cap := Capability{ + Name: "metadata", + Interface: "MetadataAgent", + Required: false, + Methods: []Export{ + { + Name: "GetArtistBiography", + ExportName: "nd_get_artist_biography", + Input: Param{Type: "ArtistInput"}, + Output: Param{Type: "ArtistBiographyOutput"}, + }, + }, + Structs: []StructDef{ + {Name: "ArtistInput", Fields: []FieldDef{{Name: "ID", Type: "string", JSONTag: "id"}}}, + {Name: "ArtistBiographyOutput", Fields: []FieldDef{{Name: "Biography", Type: "string", JSONTag: "biography"}}}, + }, + } + + code, err := GenerateCapabilityGoStub(cap, "metadata") + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Check for non-WASM build tag + Expect(codeStr).To(ContainSubstring("//go:build !wasip1")) + + // Check for package declaration + Expect(codeStr).To(ContainSubstring("package metadata")) + + // Check for no-op Register + Expect(codeStr).To(ContainSubstring("func Register(_ Metadata) {}")) + + // Check struct definitions are present + Expect(codeStr).To(ContainSubstring("type ArtistInput struct")) + + // Check there are no export wrappers + Expect(codeStr).NotTo(ContainSubstring("//go:wasmexport")) + Expect(codeStr).NotTo(ContainSubstring("pdk.InputJSON")) + }) + }) + + Describe("End-to-end capability generation", func() { + It("should parse and generate capability code from source", func() { + src := `package capabilities + +// Lifecycle provides plugin lifecycle hooks. +//nd:capability name=lifecycle +type Lifecycle interface { + // OnInit is called when the plugin is loaded. + //nd:export name=nd_on_init + OnInit(OnInitInput) (OnInitOutput, error) +} + +// OnInitInput is the input for OnInit. +type OnInitInput struct { +} + +// OnInitOutput is the output for OnInit. +type OnInitOutput struct { + // Error is the error message if initialization failed. + Error *string ` + "`json:\"error,omitempty\"`" + ` +} +` + // Create temporary directory + tmpDir := GinkgoT().TempDir() + path := tmpDir + "/lifecycle.go" + err := writeFile(path, src) + Expect(err).NotTo(HaveOccurred()) + + // Parse + capabilities, err := ParseCapabilities(tmpDir) + Expect(err).NotTo(HaveOccurred()) + Expect(capabilities).To(HaveLen(1)) + + cap := capabilities[0] + Expect(cap.Name).To(Equal("lifecycle")) + Expect(cap.Methods).To(HaveLen(1)) + + // Generate WASM code + code, err := GenerateCapabilityGo(cap, "lifecycle") + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + Expect(codeStr).To(ContainSubstring("//go:wasmexport nd_on_init")) + Expect(codeStr).To(ContainSubstring("type InitProvider interface")) + + // Generate stub code + stubCode, err := GenerateCapabilityGoStub(cap, "lifecycle") + Expect(err).NotTo(HaveOccurred()) + + stubStr := string(stubCode) + Expect(stubStr).To(ContainSubstring("//go:build !wasip1")) + Expect(stubStr).To(ContainSubstring("func Register(_ Lifecycle) {}")) + }) + }) +}) + +var _ = Describe("Rust Generation", func() { + Describe("skipSerializingFunc", func() { + It("should return Option::is_none for pointer, slice, and map types", func() { + Expect(skipSerializingFunc("*string")).To(Equal("Option::is_none")) + Expect(skipSerializingFunc("*MyStruct")).To(Equal("Option::is_none")) + Expect(skipSerializingFunc("[]string")).To(Equal("Option::is_none")) + Expect(skipSerializingFunc("[]int32")).To(Equal("Option::is_none")) + Expect(skipSerializingFunc("map[string]int")).To(Equal("Option::is_none")) + }) + + It("should return String::is_empty for string type", func() { + Expect(skipSerializingFunc("string")).To(Equal("String::is_empty")) + }) + + It("should return std::ops::Not::not for bool type", func() { + Expect(skipSerializingFunc("bool")).To(Equal("std::ops::Not::not")) + }) + + It("should return is_zero_* functions for numeric types", func() { + Expect(skipSerializingFunc("int32")).To(Equal("is_zero_i32")) + Expect(skipSerializingFunc("uint32")).To(Equal("is_zero_u32")) + Expect(skipSerializingFunc("int64")).To(Equal("is_zero_i64")) + Expect(skipSerializingFunc("uint64")).To(Equal("is_zero_u64")) + Expect(skipSerializingFunc("float32")).To(Equal("is_zero_f32")) + Expect(skipSerializingFunc("float64")).To(Equal("is_zero_f64")) + }) + + It("should return Option::is_none for unknown types", func() { + Expect(skipSerializingFunc("CustomType")).To(Equal("Option::is_none")) + }) + }) + + Describe("rustOutputType", func() { + It("should convert Go primitives to Rust primitives", func() { + Expect(rustOutputType("bool")).To(Equal("bool")) + Expect(rustOutputType("string")).To(Equal("String")) + Expect(rustOutputType("int")).To(Equal("i32")) + Expect(rustOutputType("int32")).To(Equal("i32")) + Expect(rustOutputType("int64")).To(Equal("i64")) + Expect(rustOutputType("float32")).To(Equal("f32")) + Expect(rustOutputType("float64")).To(Equal("f64")) + }) + + It("should strip pointer prefix", func() { + // NOTE: This behavior is incorrect for pointer to primitives. + // "*string" returns "string" instead of "String", which would generate + // invalid Rust code. No current capability uses this pattern. + // See TODO in rustOutputType function. + Expect(rustOutputType("*string")).To(Equal("string")) + Expect(rustOutputType("*MyStruct")).To(Equal("MyStruct")) + }) + + It("should pass through unknown types", func() { + Expect(rustOutputType("CustomType")).To(Equal("CustomType")) + Expect(rustOutputType("MyStruct")).To(Equal("MyStruct")) + }) + }) + + Describe("isPrimitiveRustType", func() { + It("should return true for primitive Go types", func() { + Expect(isPrimitiveRustType("bool")).To(BeTrue()) + Expect(isPrimitiveRustType("string")).To(BeTrue()) + Expect(isPrimitiveRustType("int")).To(BeTrue()) + Expect(isPrimitiveRustType("int32")).To(BeTrue()) + Expect(isPrimitiveRustType("int64")).To(BeTrue()) + Expect(isPrimitiveRustType("float32")).To(BeTrue()) + Expect(isPrimitiveRustType("float64")).To(BeTrue()) + }) + + It("should return false for non-primitive types", func() { + Expect(isPrimitiveRustType("MyStruct")).To(BeFalse()) + Expect(isPrimitiveRustType("CustomType")).To(BeFalse()) + Expect(isPrimitiveRustType("[]string")).To(BeFalse()) + Expect(isPrimitiveRustType("map[string]int")).To(BeFalse()) + }) + + It("should handle pointer types by stripping prefix", func() { + Expect(isPrimitiveRustType("*string")).To(BeTrue()) + Expect(isPrimitiveRustType("*int64")).To(BeTrue()) + Expect(isPrimitiveRustType("*MyStruct")).To(BeFalse()) + }) + }) + + Describe("GenerateCapabilityRust", func() { + It("should generate valid Rust code with primitive output types", func() { + cap := Capability{ + Name: "test", + Interface: "TestAgent", + Required: true, + SourceFile: "test", + Methods: []Export{ + { + Name: "GetBool", + ExportName: "nd_get_bool", + Input: Param{Type: "BoolInput"}, + Output: Param{Type: "bool"}, + }, + { + Name: "GetString", + ExportName: "nd_get_string", + Input: Param{Type: "StrInput"}, + Output: Param{Type: "string"}, + }, + { + Name: "GetInt", + ExportName: "nd_get_int", + Input: Param{Type: "IntInput"}, + Output: Param{Type: "int32"}, + }, + }, + Structs: []StructDef{ + {Name: "BoolInput", Fields: []FieldDef{{Name: "ID", Type: "string", JSONTag: "id"}}}, + {Name: "StrInput", Fields: []FieldDef{{Name: "Key", Type: "string", JSONTag: "key"}}}, + {Name: "IntInput", Fields: []FieldDef{{Name: "Index", Type: "int32", JSONTag: "index"}}}, + }, + } + + code, err := GenerateCapabilityRust(cap) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Check that primitive output types are not prefixed with $crate:: + // The template should use isPrimitiveRust to determine this + Expect(codeStr).To(ContainSubstring("FnResult>")) + Expect(codeStr).To(ContainSubstring("FnResult>")) + Expect(codeStr).To(ContainSubstring("FnResult>")) + + // Verify that primitive output types don't use $crate:: prefix in FnResult + // The pattern "$crate::test::bool>" would indicate incorrect generation + Expect(codeStr).NotTo(ContainSubstring("$crate::test::bool>")) + Expect(codeStr).NotTo(ContainSubstring("$crate::test::String>")) + Expect(codeStr).NotTo(ContainSubstring("$crate::test::i32>")) + }) + + It("should generate valid Rust code with struct output types", func() { + cap := Capability{ + Name: "metadata", + Interface: "MetadataAgent", + Required: true, + SourceFile: "metadata", + Methods: []Export{ + { + Name: "GetArtist", + ExportName: "nd_get_artist", + Input: Param{Type: "ArtistInput"}, + Output: Param{Type: "ArtistOutput"}, + }, + }, + Structs: []StructDef{ + {Name: "ArtistInput", Fields: []FieldDef{{Name: "ID", Type: "string", JSONTag: "id"}}}, + {Name: "ArtistOutput", Fields: []FieldDef{{Name: "Name", Type: "string", JSONTag: "name"}}}, + }, + } + + code, err := GenerateCapabilityRust(cap) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Non-primitive struct types should use $crate:: prefix + Expect(codeStr).To(ContainSubstring("$crate::metadata::ArtistOutput")) + }) + + It("should generate valid Rust code with pointer output types", func() { + cap := Capability{ + Name: "test", + Interface: "TestAgent", + Required: true, + SourceFile: "test", + Methods: []Export{ + { + Name: "GetOptionalStruct", + ExportName: "nd_get_optional_struct", + Input: Param{Type: "Input"}, + Output: Param{Type: "*Output"}, + }, + }, + Structs: []StructDef{ + {Name: "Input", Fields: []FieldDef{{Name: "ID", Type: "string", JSONTag: "id"}}}, + {Name: "Output", Fields: []FieldDef{{Name: "Value", Type: "string", JSONTag: "value"}}}, + }, + } + + code, err := GenerateCapabilityRust(cap) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Pointer to struct should strip pointer and use struct type with $crate:: + Expect(codeStr).To(ContainSubstring("$crate::test::Output>")) + // Pointer output types should NOT have Option<> wrapping - Result handles optionality + Expect(codeStr).NotTo(ContainSubstring("Option<")) + }) + + It("should include all float types correctly", func() { + cap := Capability{ + Name: "test", + Interface: "TestAgent", + Required: true, + SourceFile: "test", + Methods: []Export{ + { + Name: "GetFloat32", + ExportName: "nd_get_float32", + Input: Param{Type: "Input"}, + Output: Param{Type: "float32"}, + }, + { + Name: "GetFloat64", + ExportName: "nd_get_float64", + Input: Param{Type: "Input"}, + Output: Param{Type: "float64"}, + }, + }, + Structs: []StructDef{ + {Name: "Input", Fields: []FieldDef{{Name: "ID", Type: "string", JSONTag: "id"}}}, + }, + } + + code, err := GenerateCapabilityRust(cap) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + Expect(codeStr).To(ContainSubstring("FnResult>")) + Expect(codeStr).To(ContainSubstring("FnResult>")) + }) + }) + + Describe("GenerateClientRust", func() { + It("should generate Option for (value, exists bool) pattern", func() { + svc := Service{ + Name: "Config", + Permission: "config", + Interface: "ConfigService", + Methods: []Method{ + { + Name: "Get", + Params: []Param{ + {Name: "key", Type: "string", JSONName: "key"}, + }, + Returns: []Param{ + {Name: "value", Type: "string", JSONName: "value"}, + {Name: "exists", Type: "bool", JSONName: "exists"}, + }, + }, + }, + } + + code, err := GenerateClientRust(svc) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Should generate Option return type, not (String, bool) + Expect(codeStr).To(ContainSubstring("Result, Error>")) + Expect(codeStr).NotTo(ContainSubstring("Result<(String, bool), Error>")) + + // Should generate Some/None logic + Expect(codeStr).To(ContainSubstring("Ok(Some(")) + Expect(codeStr).To(ContainSubstring("Ok(None)")) + }) + + It("should generate tuple for non-option multi-return", func() { + svc := Service{ + Name: "Test", + Permission: "test", + Interface: "TestService", + Methods: []Method{ + { + Name: "GetStats", + Returns: []Param{ + {Name: "count", Type: "int64", JSONName: "count"}, + {Name: "size", Type: "int64", JSONName: "size"}, + }, + }, + }, + } + + code, err := GenerateClientRust(svc) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Should generate tuple return type + Expect(codeStr).To(ContainSubstring("Result<(i64, i64), Error>")) + Expect(codeStr).NotTo(ContainSubstring("Option<")) + }) + + It("should NOT generate Option for Has() pattern where first return is bool", func() { + svc := Service{ + Name: "Cache", + Permission: "cache", + Interface: "CacheService", + Methods: []Method{ + { + Name: "Has", + Params: []Param{ + {Name: "key", Type: "string", JSONName: "key"}, + }, + Returns: []Param{ + {Name: "exists", Type: "bool", JSONName: "exists"}, + }, + }, + }, + } + + code, err := GenerateClientRust(svc) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Should generate simple bool return, not Option + Expect(codeStr).To(ContainSubstring("Result")) + Expect(codeStr).NotTo(ContainSubstring("Option")) + }) + + It("should generate base64 serde for Vec fields", func() { + svc := Service{ + Name: "Codec", + Permission: "codec", + Interface: "CodecService", + Methods: []Method{ + { + Name: "Encode", + HasError: true, + Params: []Param{NewParam("data", "[]byte")}, + Returns: []Param{NewParam("result", "[]byte")}, + }, + }, + } + + code, err := GenerateClientRust(svc) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Should generate base64_bytes serde module + Expect(codeStr).To(ContainSubstring("mod base64_bytes")) + Expect(codeStr).To(ContainSubstring("use base64::Engine as _")) + + // Should add serde(with = "base64_bytes") on Vec fields + Expect(codeStr).To(ContainSubstring(`#[serde(with = "base64_bytes")]`)) + }) + + It("should not generate base64 module when no byte fields", func() { + svc := Service{ + Name: "Test", + Permission: "test", + Interface: "TestService", + Methods: []Method{ + { + Name: "Call", + HasError: true, + Params: []Param{NewParam("uri", "string")}, + Returns: []Param{NewParam("response", "string")}, + }, + }, + } + + code, err := GenerateClientRust(svc) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + Expect(codeStr).NotTo(ContainSubstring("mod base64_bytes")) + Expect(codeStr).NotTo(ContainSubstring("use base64")) + }) + }) +}) + +func writeFile(path, content string) error { + return os.WriteFile(path, []byte(content), 0600) +} diff --git a/plugins/cmd/ndpgen/internal/internal_suite_test.go b/plugins/cmd/ndpgen/internal/internal_suite_test.go new file mode 100644 index 000000000..5c7d27088 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/internal_suite_test.go @@ -0,0 +1,13 @@ +package internal + +import ( + "testing" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestInternal(t *testing.T) { + RegisterFailHandler(Fail) + RunSpecs(t, "NDPGen Internal Suite") +} diff --git a/plugins/cmd/ndpgen/internal/parser.go b/plugins/cmd/ndpgen/internal/parser.go new file mode 100644 index 000000000..4cb28f8d4 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/parser.go @@ -0,0 +1,846 @@ +package internal + +import ( + "fmt" + "go/ast" + "go/parser" + "go/token" + "maps" + "os" + "path/filepath" + "regexp" + "slices" + "strings" +) + +// Annotation patterns +var ( + // //nd:hostservice name=ServiceName permission=key + hostServicePattern = regexp.MustCompile(`//nd:hostservice\s+(.*)`) + // //nd:hostfunc [name=CustomName] + hostFuncPattern = regexp.MustCompile(`//nd:hostfunc(?:\s+(.*))?`) + // //nd:capability name=PackageName [required=true] + capabilityPattern = regexp.MustCompile(`//nd:capability\s+(.*)`) + // //nd:export name=ExportName + exportPattern = regexp.MustCompile(`//nd:export\s+(.*)`) + // key=value pairs + keyValuePattern = regexp.MustCompile(`(\w+)=(\S+)`) +) + +// ParseDirectory parses all Go source files in a directory and extracts host services. +func ParseDirectory(dir string) ([]Service, error) { + entries, err := os.ReadDir(dir) + if err != nil { + return nil, fmt.Errorf("reading directory: %w", err) + } + + var services []Service + fset := token.NewFileSet() + + for _, entry := range entries { + if entry.IsDir() || !strings.HasSuffix(entry.Name(), ".go") { + continue + } + // Skip generated files and test files + if strings.HasSuffix(entry.Name(), "_gen.go") || strings.HasSuffix(entry.Name(), "_test.go") { + continue + } + + path := filepath.Join(dir, entry.Name()) + parsed, err := parseFile(fset, path) + if err != nil { + return nil, fmt.Errorf("parsing %s: %w", entry.Name(), err) + } + services = append(services, parsed...) + } + + return services, nil +} + +// ParseCapabilities parses all Go source files in a directory and extracts capabilities. +func ParseCapabilities(dir string) ([]Capability, error) { + entries, err := os.ReadDir(dir) + if err != nil { + return nil, fmt.Errorf("reading directory: %w", err) + } + + fset := token.NewFileSet() + + // First pass: collect all structs and type aliases from all files in the package + sharedStructMap := make(map[string]StructDef) + sharedAliasMap := make(map[string]TypeAlias) + var allConstGroups []ConstGroup + + var goFiles []string + for _, entry := range entries { + if entry.IsDir() || !strings.HasSuffix(entry.Name(), ".go") { + continue + } + // Skip generated files, test files, and doc.go + if strings.HasSuffix(entry.Name(), "_gen.go") || + strings.HasSuffix(entry.Name(), "_test.go") || + entry.Name() == "doc.go" { + continue + } + goFiles = append(goFiles, filepath.Join(dir, entry.Name())) + } + + for _, path := range goFiles { + f, err := parser.ParseFile(fset, path, nil, parser.ParseComments) + if err != nil { + return nil, fmt.Errorf("parsing %s for types: %w", filepath.Base(path), err) + } + for _, s := range parseStructs(f) { + sharedStructMap[s.Name] = s + } + for _, a := range parseTypeAliases(f) { + sharedAliasMap[a.Name] = a + } + allConstGroups = append(allConstGroups, parseConstGroups(f)...) + } + + // Second pass: parse capabilities using the shared type maps + var capabilities []Capability + for _, path := range goFiles { + parsed, err := parseCapabilityFile(fset, path, sharedStructMap, sharedAliasMap, allConstGroups) + if err != nil { + return nil, fmt.Errorf("parsing %s: %w", filepath.Base(path), err) + } + capabilities = append(capabilities, parsed...) + } + + return capabilities, nil +} + +// parseCapabilityFile parses a single Go source file and extracts capabilities. +func parseCapabilityFile(fset *token.FileSet, path string, structMap map[string]StructDef, aliasMap map[string]TypeAlias, allConstGroups []ConstGroup) ([]Capability, error) { + f, err := parser.ParseFile(fset, path, nil, parser.ParseComments) + if err != nil { + return nil, err + } + + var capabilities []Capability + + for _, decl := range f.Decls { + genDecl, ok := decl.(*ast.GenDecl) + if !ok || genDecl.Tok != token.TYPE { + continue + } + + for _, spec := range genDecl.Specs { + typeSpec, ok := spec.(*ast.TypeSpec) + if !ok { + continue + } + + interfaceType, ok := typeSpec.Type.(*ast.InterfaceType) + if !ok { + continue + } + + // Check for //nd:capability annotation in doc comment + docText, rawDoc := getDocComment(genDecl, typeSpec) + capAnnotation := parseCapabilityAnnotation(rawDoc) + if capAnnotation == nil { + continue + } + + // Extract source file base name (e.g., "websocket_callback" from "websocket_callback.go") + baseName := filepath.Base(path) + sourceFile := strings.TrimSuffix(baseName, ".go") + + capability := Capability{ + Name: capAnnotation["name"], + Interface: typeSpec.Name.Name, + Required: capAnnotation["required"] == "true", + Doc: cleanDoc(docText), + SourceFile: sourceFile, + } + + // Parse methods and collect referenced types + referencedTypes := make(map[string]bool) + for _, method := range interfaceType.Methods.List { + if len(method.Names) == 0 { + continue // Embedded interface + } + + funcType, ok := method.Type.(*ast.FuncType) + if !ok { + continue + } + + // Check for //nd:export annotation + methodDocText, methodRawDoc := getMethodDocComment(method) + exportAnnotation := parseExportAnnotation(methodRawDoc) + if exportAnnotation == nil { + continue + } + + export, err := parseExport(method.Names[0].Name, funcType, exportAnnotation, cleanDoc(methodDocText)) + if err != nil { + return nil, fmt.Errorf("parsing export %s.%s: %w", typeSpec.Name.Name, method.Names[0].Name, err) + } + capability.Methods = append(capability.Methods, export) + + // Collect referenced types from input and output + collectReferencedTypes(export.Input.Type, referencedTypes) + collectReferencedTypes(export.Output.Type, referencedTypes) + } + + // Recursively collect all struct dependencies + collectAllStructDependencies(referencedTypes, structMap) + + // Sort type names for stable output order + sortedTypeNames := slices.Sorted(maps.Keys(referencedTypes)) + + // Attach referenced structs to the capability + for _, typeName := range sortedTypeNames { + if s, exists := structMap[typeName]; exists { + capability.Structs = append(capability.Structs, s) + } + } + + // Attach referenced type aliases + for _, typeName := range sortedTypeNames { + if a, exists := aliasMap[typeName]; exists { + capability.TypeAliases = append(capability.TypeAliases, a) + } + } + + // Also attach type aliases prefixed with interface name (e.g., ScrobblerError for Scrobbler interface) + // This supports error types that are not directly referenced in method signatures + interfaceName := typeSpec.Name.Name + for _, typeName := range slices.Sorted(maps.Keys(aliasMap)) { + a := aliasMap[typeName] + if strings.HasPrefix(typeName, interfaceName) && !referencedTypes[typeName] { + capability.TypeAliases = append(capability.TypeAliases, a) + referencedTypes[typeName] = true // Mark as referenced for const lookup + } + } + + // Attach const groups that match referenced type aliases + for _, group := range allConstGroups { + if group.Type == "" { + continue + } + if referencedTypes[group.Type] { + capability.Consts = append(capability.Consts, group) + } + } + + if len(capability.Methods) > 0 { + capabilities = append(capabilities, capability) + } + } + } + + return capabilities, nil +} + +// collectAllStructDependencies recursively collects all struct types referenced by other structs. +func collectAllStructDependencies(referencedTypes map[string]bool, structMap map[string]StructDef) { + // Keep iterating until no new types are added + for { + newTypes := make(map[string]bool) + for typeName := range referencedTypes { + if s, exists := structMap[typeName]; exists { + for _, field := range s.Fields { + collectReferencedTypes(field.Type, newTypes) + } + } + } + // Check if any new types were found + foundNew := false + for t := range newTypes { + if !referencedTypes[t] { + referencedTypes[t] = true + foundNew = true + } + } + if !foundNew { + break + } + } +} + +// parseExport parses an export method signature into an Export struct. +func parseExport(name string, funcType *ast.FuncType, annotation map[string]string, doc string) (Export, error) { + export := Export{ + Name: name, + ExportName: annotation["name"], + Doc: doc, + } + + // Capability exports have exactly one input parameter (the struct type) + if funcType.Params != nil && len(funcType.Params.List) == 1 { + field := funcType.Params.List[0] + typeName := typeToString(field.Type) + paramName := "input" + if len(field.Names) > 0 { + paramName = field.Names[0].Name + } + export.Input = NewParam(paramName, typeName) + } + + // Capability exports return (OutputType, error) + if funcType.Results != nil { + for _, field := range funcType.Results.List { + typeName := typeToString(field.Type) + if typeName == "error" { + continue // Skip error return + } + paramName := "output" + if len(field.Names) > 0 { + paramName = field.Names[0].Name + } + export.Output = NewParam(paramName, typeName) + break // Only take the first non-error return + } + } + + return export, nil +} + +// parseFile parses a single Go source file and extracts host services. +func parseFile(fset *token.FileSet, path string) ([]Service, error) { + f, err := parser.ParseFile(fset, path, nil, parser.ParseComments) + if err != nil { + return nil, err + } + + // First pass: collect all struct definitions in the file + allStructs := parseStructs(f) + structMap := make(map[string]StructDef) + for _, s := range allStructs { + structMap[s.Name] = s + } + + var services []Service + + for _, decl := range f.Decls { + genDecl, ok := decl.(*ast.GenDecl) + if !ok || genDecl.Tok != token.TYPE { + continue + } + + for _, spec := range genDecl.Specs { + typeSpec, ok := spec.(*ast.TypeSpec) + if !ok { + continue + } + + interfaceType, ok := typeSpec.Type.(*ast.InterfaceType) + if !ok { + continue + } + + // Check for //nd:hostservice annotation in doc comment + docText, rawDoc := getDocComment(genDecl, typeSpec) + svcAnnotation := parseHostServiceAnnotation(rawDoc) + if svcAnnotation == nil { + continue + } + + service := Service{ + Name: svcAnnotation["name"], + Permission: svcAnnotation["permission"], + Interface: typeSpec.Name.Name, + Doc: cleanDoc(docText), + } + + // Parse methods and collect referenced types + referencedTypes := make(map[string]bool) + for _, method := range interfaceType.Methods.List { + if len(method.Names) == 0 { + continue // Embedded interface + } + + funcType, ok := method.Type.(*ast.FuncType) + if !ok { + continue + } + + // Check for //nd:hostfunc annotation + methodDocText, methodRawDoc := getMethodDocComment(method) + methodAnnotation := parseHostFuncAnnotation(methodRawDoc) + if methodAnnotation == nil { + continue + } + + m, err := parseMethod(method.Names[0].Name, funcType, methodAnnotation, cleanDoc(methodDocText)) + if err != nil { + return nil, fmt.Errorf("parsing method %s.%s: %w", typeSpec.Name.Name, method.Names[0].Name, err) + } + service.Methods = append(service.Methods, m) + + // Collect referenced types from params and returns + for _, p := range m.Params { + collectReferencedTypes(p.Type, referencedTypes) + } + for _, r := range m.Returns { + collectReferencedTypes(r.Type, referencedTypes) + } + } + + // Attach referenced structs to the service (sorted for stable output) + for _, typeName := range slices.Sorted(maps.Keys(referencedTypes)) { + if s, exists := structMap[typeName]; exists { + service.Structs = append(service.Structs, s) + } + } + + if len(service.Methods) > 0 { + services = append(services, service) + } + } + } + + return services, nil +} + +// parseStructs extracts all struct type definitions from a parsed Go file. +func parseStructs(f *ast.File) []StructDef { + var structs []StructDef + + for _, decl := range f.Decls { + genDecl, ok := decl.(*ast.GenDecl) + if !ok || genDecl.Tok != token.TYPE { + continue + } + + for _, spec := range genDecl.Specs { + typeSpec, ok := spec.(*ast.TypeSpec) + if !ok { + continue + } + + structType, ok := typeSpec.Type.(*ast.StructType) + if !ok { + continue + } + + docText, _ := getDocComment(genDecl, typeSpec) + s := StructDef{ + Name: typeSpec.Name.Name, + Doc: cleanDoc(docText), + } + + // Parse struct fields + for _, field := range structType.Fields.List { + if len(field.Names) == 0 { + continue // Embedded field + } + + fieldDef := parseStructField(field) + s.Fields = append(s.Fields, fieldDef...) + } + + structs = append(structs, s) + } + } + + return structs +} + +// parseTypeAliases extracts all type alias definitions from a parsed Go file. +// Type aliases are non-struct type declarations like: type MyType string +func parseTypeAliases(f *ast.File) []TypeAlias { + var aliases []TypeAlias + + for _, decl := range f.Decls { + genDecl, ok := decl.(*ast.GenDecl) + if !ok || genDecl.Tok != token.TYPE { + continue + } + + for _, spec := range genDecl.Specs { + typeSpec, ok := spec.(*ast.TypeSpec) + if !ok { + continue + } + + // Skip struct and interface types + if _, isStruct := typeSpec.Type.(*ast.StructType); isStruct { + continue + } + if _, isInterface := typeSpec.Type.(*ast.InterfaceType); isInterface { + continue + } + + docText, _ := getDocComment(genDecl, typeSpec) + aliases = append(aliases, TypeAlias{ + Name: typeSpec.Name.Name, + Type: typeToString(typeSpec.Type), + Doc: cleanDoc(docText), + }) + } + } + + return aliases +} + +// parseConstGroups extracts const groups from a parsed Go file. +func parseConstGroups(f *ast.File) []ConstGroup { + var groups []ConstGroup + + for _, decl := range f.Decls { + genDecl, ok := decl.(*ast.GenDecl) + if !ok || genDecl.Tok != token.CONST { + continue + } + + group := ConstGroup{} + for _, spec := range genDecl.Specs { + valueSpec, ok := spec.(*ast.ValueSpec) + if !ok { + continue + } + + // Get type if specified + if valueSpec.Type != nil && group.Type == "" { + group.Type = typeToString(valueSpec.Type) + } + + // Extract values + for i, name := range valueSpec.Names { + def := ConstDef{ + Name: name.Name, + } + // Get value if present + if i < len(valueSpec.Values) { + def.Value = exprToString(valueSpec.Values[i]) + } + // Get doc comment + if valueSpec.Doc != nil { + def.Doc = cleanDoc(valueSpec.Doc.Text()) + } else if valueSpec.Comment != nil { + def.Doc = cleanDoc(valueSpec.Comment.Text()) + } + group.Values = append(group.Values, def) + } + } + + if len(group.Values) > 0 { + groups = append(groups, group) + } + } + + return groups +} + +// exprToString converts an AST expression to a Go source string. +func exprToString(expr ast.Expr) string { + switch e := expr.(type) { + case *ast.BasicLit: + return e.Value + case *ast.Ident: + return e.Name + default: + return "" + } +} + +// parseStructField parses a struct field and returns FieldDef for each name. +func parseStructField(field *ast.Field) []FieldDef { + var fields []FieldDef + typeName := typeToString(field.Type) + + // Parse struct tag for JSON field name and omitempty + jsonTag := "" + omitEmpty := false + if field.Tag != nil { + tag := field.Tag.Value + // Remove backticks + tag = strings.Trim(tag, "`") + // Parse json tag + jsonTag, omitEmpty = parseJSONTag(tag) + } + + // Get doc comment + var doc string + if field.Doc != nil { + doc = cleanDoc(field.Doc.Text()) + } + + for _, name := range field.Names { + fieldJSONTag := jsonTag + if fieldJSONTag == "" { + // Default to field name with camelCase + fieldJSONTag = toJSONName(name.Name) + } + fields = append(fields, FieldDef{ + Name: name.Name, + Type: typeName, + JSONTag: fieldJSONTag, + OmitEmpty: omitEmpty, + Doc: doc, + }) + } + + return fields +} + +// parseJSONTag extracts the json field name and omitempty flag from a struct tag. +func parseJSONTag(tag string) (name string, omitEmpty bool) { + // Find json:"..." in the tag + for _, part := range strings.Split(tag, " ") { + if strings.HasPrefix(part, `json:"`) { + value := strings.TrimPrefix(part, `json:"`) + value = strings.TrimSuffix(value, `"`) + parts := strings.Split(value, ",") + if len(parts) > 0 && parts[0] != "-" { + name = parts[0] + } + for _, opt := range parts[1:] { + if opt == "omitempty" { + omitEmpty = true + } + } + return + } + } + return "", false +} + +// collectReferencedTypes extracts custom type names from a Go type string. +// It handles pointers, slices, and maps, collecting base type names. +func collectReferencedTypes(goType string, refs map[string]bool) { + // Strip pointer + if strings.HasPrefix(goType, "*") { + collectReferencedTypes(goType[1:], refs) + return + } + // Strip slice + if strings.HasPrefix(goType, "[]") { + if goType != "[]byte" { + collectReferencedTypes(goType[2:], refs) + } + return + } + // Handle map + if strings.HasPrefix(goType, "map[") { + rest := goType[4:] // Remove "map[" + depth := 1 + keyEnd := 0 + for i, r := range rest { + if r == '[' { + depth++ + } else if r == ']' { + depth-- + if depth == 0 { + keyEnd = i + break + } + } + } + keyType := rest[:keyEnd] + valueType := rest[keyEnd+1:] + collectReferencedTypes(keyType, refs) + collectReferencedTypes(valueType, refs) + return + } + + // Check if it's a custom type (starts with uppercase, not a builtin) + if len(goType) > 0 && goType[0] >= 'A' && goType[0] <= 'Z' { + switch goType { + case "String", "Bool", "Int", "Int32", "Int64", "Float32", "Float64": + // Not custom types (just capitalized for some reason) + default: + refs[goType] = true + } + } +} + +// toJSONName is imported from types.go via the same package + +// getDocComment extracts the doc comment for a type spec. +// Returns both the readable doc text and the raw comment text (which includes pragma-style comments). +func getDocComment(genDecl *ast.GenDecl, typeSpec *ast.TypeSpec) (docText, rawText string) { + var docGroup *ast.CommentGroup + // First check the TypeSpec's own doc (when multiple types in one block) + if typeSpec.Doc != nil { + docGroup = typeSpec.Doc + } else if genDecl.Doc != nil { + // Fall back to GenDecl doc (single type declaration) + docGroup = genDecl.Doc + } + if docGroup == nil { + return "", "" + } + return docGroup.Text(), commentGroupRaw(docGroup) +} + +// commentGroupRaw returns all comment text including pragma-style comments (//nd:...). +// Go's ast.CommentGroup.Text() strips comments without a space after //, so we need this. +func commentGroupRaw(cg *ast.CommentGroup) string { + if cg == nil { + return "" + } + var lines []string + for _, c := range cg.List { + lines = append(lines, c.Text) + } + return strings.Join(lines, "\n") +} + +// getMethodDocComment extracts the doc comment for a method. +func getMethodDocComment(field *ast.Field) (docText, rawText string) { + if field.Doc == nil { + return "", "" + } + return field.Doc.Text(), commentGroupRaw(field.Doc) +} + +// parseHostServiceAnnotation extracts //nd:hostservice annotation parameters. +func parseHostServiceAnnotation(doc string) map[string]string { + for _, line := range strings.Split(doc, "\n") { + line = strings.TrimSpace(line) + match := hostServicePattern.FindStringSubmatch(line) + if match != nil { + return parseKeyValuePairs(match[1]) + } + } + return nil +} + +// parseHostFuncAnnotation extracts //nd:hostfunc annotation parameters. +func parseHostFuncAnnotation(doc string) map[string]string { + for _, line := range strings.Split(doc, "\n") { + line = strings.TrimSpace(line) + match := hostFuncPattern.FindStringSubmatch(line) + if match != nil { + params := parseKeyValuePairs(match[1]) + if params == nil { + params = make(map[string]string) + } + return params + } + } + return nil +} + +// parseCapabilityAnnotation extracts //nd:capability annotation parameters. +func parseCapabilityAnnotation(doc string) map[string]string { + for _, line := range strings.Split(doc, "\n") { + line = strings.TrimSpace(line) + match := capabilityPattern.FindStringSubmatch(line) + if match != nil { + return parseKeyValuePairs(match[1]) + } + } + return nil +} + +// parseExportAnnotation extracts //nd:export annotation parameters. +func parseExportAnnotation(doc string) map[string]string { + for _, line := range strings.Split(doc, "\n") { + line = strings.TrimSpace(line) + match := exportPattern.FindStringSubmatch(line) + if match != nil { + return parseKeyValuePairs(match[1]) + } + } + return nil +} + +// parseKeyValuePairs extracts key=value pairs from annotation text. +func parseKeyValuePairs(text string) map[string]string { + matches := keyValuePattern.FindAllStringSubmatch(text, -1) + if len(matches) == 0 { + return nil + } + result := make(map[string]string) + for _, m := range matches { + result[m[1]] = m[2] + } + return result +} + +// parseMethod parses a method signature into a Method struct. +func parseMethod(name string, funcType *ast.FuncType, annotation map[string]string, doc string) (Method, error) { + m := Method{ + Name: name, + ExportName: annotation["name"], + Doc: doc, + } + + // Parse parameters (skip context.Context) + if funcType.Params != nil { + for _, field := range funcType.Params.List { + typeName := typeToString(field.Type) + if typeName == "context.Context" { + continue // Skip context parameter + } + + for _, name := range field.Names { + m.Params = append(m.Params, NewParam(name.Name, typeName)) + } + } + } + + // Parse return values + if funcType.Results != nil { + for _, field := range funcType.Results.List { + typeName := typeToString(field.Type) + if typeName == "error" { + m.HasError = true + continue // Track error but don't include in Returns + } + + // Handle anonymous returns + if len(field.Names) == 0 { + // Generate a name based on position + m.Returns = append(m.Returns, NewParam("result", typeName)) + } else { + for _, name := range field.Names { + m.Returns = append(m.Returns, NewParam(name.Name, typeName)) + } + } + } + } + + return m, nil +} + +// typeToString converts an AST type expression to a string. +func typeToString(expr ast.Expr) string { + switch t := expr.(type) { + case *ast.Ident: + return t.Name + case *ast.SelectorExpr: + return typeToString(t.X) + "." + t.Sel.Name + case *ast.StarExpr: + return "*" + typeToString(t.X) + case *ast.ArrayType: + if t.Len == nil { + return "[]" + typeToString(t.Elt) + } + return fmt.Sprintf("[%s]%s", typeToString(t.Len), typeToString(t.Elt)) + case *ast.MapType: + return fmt.Sprintf("map[%s]%s", typeToString(t.Key), typeToString(t.Value)) + case *ast.BasicLit: + return t.Value + case *ast.InterfaceType: + // Empty interface (interface{} or any) + if t.Methods == nil || len(t.Methods.List) == 0 { + return "any" + } + // Non-empty interfaces can't be easily represented + return "any" + default: + return fmt.Sprintf("%T", expr) + } +} + +// cleanDoc removes annotation lines from documentation. +func cleanDoc(doc string) string { + var lines []string + for _, line := range strings.Split(doc, "\n") { + trimmed := strings.TrimSpace(line) + if strings.HasPrefix(trimmed, "//nd:") { + continue + } + lines = append(lines, line) + } + return strings.TrimSpace(strings.Join(lines, "\n")) +} diff --git a/plugins/cmd/ndpgen/internal/parser_test.go b/plugins/cmd/ndpgen/internal/parser_test.go new file mode 100644 index 000000000..f43578397 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/parser_test.go @@ -0,0 +1,547 @@ +package internal + +import ( + "os" + "path/filepath" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Parser", func() { + var tmpDir string + + BeforeEach(func() { + var err error + tmpDir, err = os.MkdirTemp("", "ndpgen-test-*") + Expect(err).NotTo(HaveOccurred()) + }) + + AfterEach(func() { + os.RemoveAll(tmpDir) + }) + + Describe("ParseDirectory", func() { + It("should parse a simple host service interface", func() { + src := `package host + +import "context" + +// SubsonicAPIService provides access to Navidrome's Subsonic API. +//nd:hostservice name=SubsonicAPI permission=subsonicapi +type SubsonicAPIService interface { + // Call executes a Subsonic API request. + //nd:hostfunc + Call(ctx context.Context, uri string) (response string, err error) +} +` + err := os.WriteFile(filepath.Join(tmpDir, "service.go"), []byte(src), 0600) + Expect(err).NotTo(HaveOccurred()) + + services, err := ParseDirectory(tmpDir) + Expect(err).NotTo(HaveOccurred()) + Expect(services).To(HaveLen(1)) + + svc := services[0] + Expect(svc.Name).To(Equal("SubsonicAPI")) + Expect(svc.Permission).To(Equal("subsonicapi")) + Expect(svc.Interface).To(Equal("SubsonicAPIService")) + Expect(svc.Methods).To(HaveLen(1)) + + m := svc.Methods[0] + Expect(m.Name).To(Equal("Call")) + Expect(m.HasError).To(BeTrue()) + Expect(m.Params).To(HaveLen(1)) + Expect(m.Params[0].Name).To(Equal("uri")) + Expect(m.Params[0].Type).To(Equal("string")) + Expect(m.Returns).To(HaveLen(1)) + Expect(m.Returns[0].Name).To(Equal("response")) + Expect(m.Returns[0].Type).To(Equal("string")) + }) + + It("should parse multiple methods", func() { + src := `package host + +import "context" + +// SchedulerService provides scheduling capabilities. +//nd:hostservice name=Scheduler permission=scheduler +type SchedulerService interface { + //nd:hostfunc + ScheduleRecurring(ctx context.Context, cronExpression string) (scheduleID string, err error) + + //nd:hostfunc + ScheduleOneTime(ctx context.Context, delaySeconds int32) (scheduleID string, err error) + + //nd:hostfunc + CancelSchedule(ctx context.Context, scheduleID string) (canceled bool, err error) +} +` + err := os.WriteFile(filepath.Join(tmpDir, "scheduler.go"), []byte(src), 0600) + Expect(err).NotTo(HaveOccurred()) + + services, err := ParseDirectory(tmpDir) + Expect(err).NotTo(HaveOccurred()) + Expect(services).To(HaveLen(1)) + + svc := services[0] + Expect(svc.Name).To(Equal("Scheduler")) + Expect(svc.Methods).To(HaveLen(3)) + + Expect(svc.Methods[0].Name).To(Equal("ScheduleRecurring")) + Expect(svc.Methods[0].Params[0].Type).To(Equal("string")) + + Expect(svc.Methods[1].Name).To(Equal("ScheduleOneTime")) + Expect(svc.Methods[1].Params[0].Type).To(Equal("int32")) + + Expect(svc.Methods[2].Name).To(Equal("CancelSchedule")) + Expect(svc.Methods[2].Returns[0].Type).To(Equal("bool")) + }) + + It("should skip methods without hostfunc annotation", func() { + src := `package host + +import "context" + +//nd:hostservice name=Test permission=test +type TestService interface { + //nd:hostfunc + Exported(ctx context.Context) error + + // This method is not exported + NotExported(ctx context.Context) error +} +` + err := os.WriteFile(filepath.Join(tmpDir, "test.go"), []byte(src), 0600) + Expect(err).NotTo(HaveOccurred()) + + services, err := ParseDirectory(tmpDir) + Expect(err).NotTo(HaveOccurred()) + Expect(services).To(HaveLen(1)) + Expect(services[0].Methods).To(HaveLen(1)) + Expect(services[0].Methods[0].Name).To(Equal("Exported")) + }) + + It("should handle custom export name", func() { + src := `package host + +import "context" + +//nd:hostservice name=Test permission=test +type TestService interface { + //nd:hostfunc name=custom_export_name + MyMethod(ctx context.Context) error +} +` + err := os.WriteFile(filepath.Join(tmpDir, "test.go"), []byte(src), 0600) + Expect(err).NotTo(HaveOccurred()) + + services, err := ParseDirectory(tmpDir) + Expect(err).NotTo(HaveOccurred()) + Expect(services[0].Methods[0].ExportName).To(Equal("custom_export_name")) + Expect(services[0].Methods[0].FunctionName("test")).To(Equal("custom_export_name")) + }) + + It("should skip generated files", func() { + regularSrc := `package host + +import "context" + +//nd:hostservice name=Test permission=test +type TestService interface { + //nd:hostfunc + Method(ctx context.Context) error +} +` + genSrc := `// Code generated. DO NOT EDIT. +package host + +//nd:hostservice name=Generated permission=gen +type GeneratedService interface { + //nd:hostfunc + Method() error +} +` + err := os.WriteFile(filepath.Join(tmpDir, "test.go"), []byte(regularSrc), 0600) + Expect(err).NotTo(HaveOccurred()) + err = os.WriteFile(filepath.Join(tmpDir, "test_gen.go"), []byte(genSrc), 0600) + Expect(err).NotTo(HaveOccurred()) + + services, err := ParseDirectory(tmpDir) + Expect(err).NotTo(HaveOccurred()) + Expect(services).To(HaveLen(1)) + Expect(services[0].Name).To(Equal("Test")) + }) + + It("should skip interfaces without hostservice annotation", func() { + src := `package host + +import "context" + +// Regular interface without annotation +type RegularInterface interface { + Method(ctx context.Context) error +} + +//nd:hostservice name=Annotated permission=annotated +type AnnotatedService interface { + //nd:hostfunc + Method(ctx context.Context) error +} +` + err := os.WriteFile(filepath.Join(tmpDir, "test.go"), []byte(src), 0600) + Expect(err).NotTo(HaveOccurred()) + + services, err := ParseDirectory(tmpDir) + Expect(err).NotTo(HaveOccurred()) + Expect(services).To(HaveLen(1)) + Expect(services[0].Name).To(Equal("Annotated")) + }) + + It("should return empty slice for directory with no host services", func() { + src := `package host + +type RegularInterface interface { + Method() error +} +` + err := os.WriteFile(filepath.Join(tmpDir, "test.go"), []byte(src), 0600) + Expect(err).NotTo(HaveOccurred()) + + services, err := ParseDirectory(tmpDir) + Expect(err).NotTo(HaveOccurred()) + Expect(services).To(BeEmpty()) + }) + }) + + Describe("parseKeyValuePairs", func() { + It("should parse key=value pairs", func() { + result := parseKeyValuePairs("name=Test permission=test") + Expect(result).To(HaveKeyWithValue("name", "Test")) + Expect(result).To(HaveKeyWithValue("permission", "test")) + }) + + It("should return nil for empty input", func() { + result := parseKeyValuePairs("") + Expect(result).To(BeNil()) + }) + }) + + Describe("typeToString", func() { + It("should handle basic types", func() { + src := `package test +type T interface { + Method(s string, i int, b bool) ([]byte, error) +} +` + err := os.WriteFile(filepath.Join(tmpDir, "types.go"), []byte(src), 0600) + Expect(err).NotTo(HaveOccurred()) + + // Parse and verify type conversion works + // This is implicitly tested through ParseDirectory + }) + + It("should convert interface{} to any", func() { + src := `package test + +import "context" + +//nd:hostservice name=Test permission=test +type TestService interface { + //nd:hostfunc + GetMetadata(ctx context.Context) (data map[string]interface{}, err error) +} +` + err := os.WriteFile(filepath.Join(tmpDir, "test.go"), []byte(src), 0600) + Expect(err).NotTo(HaveOccurred()) + + services, err := ParseDirectory(tmpDir) + Expect(err).NotTo(HaveOccurred()) + Expect(services).To(HaveLen(1)) + Expect(services[0].Methods[0].Returns[0].Type).To(Equal("map[string]any")) + }) + }) + + Describe("Method helpers", func() { + It("should generate correct function names", func() { + m := Method{Name: "Call"} + Expect(m.FunctionName("subsonicapi")).To(Equal("subsonicapi_call")) + + m.ExportName = "custom_name" + Expect(m.FunctionName("subsonicapi")).To(Equal("custom_name")) + }) + + It("should generate correct type names", func() { + m := Method{Name: "Call"} + // Host-side types are public + Expect(m.RequestTypeName("SubsonicAPI")).To(Equal("SubsonicAPICallRequest")) + Expect(m.ResponseTypeName("SubsonicAPI")).To(Equal("SubsonicAPICallResponse")) + // Client/PDK types are private + Expect(m.ClientRequestTypeName("SubsonicAPI")).To(Equal("subsonicAPICallRequest")) + Expect(m.ClientResponseTypeName("SubsonicAPI")).To(Equal("subsonicAPICallResponse")) + }) + }) + + Describe("Service helpers", func() { + It("should generate correct output file name", func() { + s := Service{Name: "SubsonicAPI"} + Expect(s.OutputFileName()).To(Equal("subsonicapi_gen.go")) + }) + + It("should generate correct export prefix", func() { + s := Service{Name: "SubsonicAPI"} + Expect(s.ExportPrefix()).To(Equal("subsonicapi")) + }) + }) + + Describe("ParseCapabilities", func() { + It("should parse a simple capability interface", func() { + src := `package capabilities + +// MetadataAgent provides metadata retrieval. +//nd:capability name=metadata +type MetadataAgent interface { + // GetArtistBiography returns artist biography. + //nd:export name=nd_get_artist_biography + GetArtistBiography(ArtistInput) (ArtistBiographyOutput, error) +} + +// ArtistInput is the input for artist-related functions. +type ArtistInput struct { + // ID is the artist ID. + ID string ` + "`json:\"id\"`" + ` + // Name is the artist name. + Name string ` + "`json:\"name\"`" + ` +} + +// ArtistBiographyOutput is the output for GetArtistBiography. +type ArtistBiographyOutput struct { + // Biography is the biography text. + Biography string ` + "`json:\"biography\"`" + ` +} +` + err := os.WriteFile(filepath.Join(tmpDir, "metadata.go"), []byte(src), 0600) + Expect(err).NotTo(HaveOccurred()) + + capabilities, err := ParseCapabilities(tmpDir) + Expect(err).NotTo(HaveOccurred()) + Expect(capabilities).To(HaveLen(1)) + + cap := capabilities[0] + Expect(cap.Name).To(Equal("metadata")) + Expect(cap.Interface).To(Equal("MetadataAgent")) + Expect(cap.Required).To(BeFalse()) + Expect(cap.Doc).To(ContainSubstring("MetadataAgent provides metadata retrieval")) + Expect(cap.Methods).To(HaveLen(1)) + + m := cap.Methods[0] + Expect(m.Name).To(Equal("GetArtistBiography")) + Expect(m.ExportName).To(Equal("nd_get_artist_biography")) + Expect(m.Input.Type).To(Equal("ArtistInput")) + Expect(m.Output.Type).To(Equal("ArtistBiographyOutput")) + + // Check structs were collected + Expect(cap.Structs).To(HaveLen(2)) + }) + + It("should parse a required capability", func() { + src := `package capabilities + +// Scrobbler requires all methods to be implemented. +//nd:capability name=scrobbler required=true +type Scrobbler interface { + //nd:export name=nd_scrobbler_is_authorized + IsAuthorized(AuthInput) (AuthOutput, error) + + //nd:export name=nd_scrobbler_scrobble + Scrobble(ScrobbleInput) (ScrobblerOutput, error) +} + +type AuthInput struct { + UserID string ` + "`json:\"userId\"`" + ` +} + +type AuthOutput struct { + Authorized bool ` + "`json:\"authorized\"`" + ` +} + +type ScrobbleInput struct { + UserID string ` + "`json:\"userId\"`" + ` +} + +type ScrobblerOutput struct { + Error *string ` + "`json:\"error,omitempty\"`" + ` +} +` + err := os.WriteFile(filepath.Join(tmpDir, "scrobbler.go"), []byte(src), 0600) + Expect(err).NotTo(HaveOccurred()) + + capabilities, err := ParseCapabilities(tmpDir) + Expect(err).NotTo(HaveOccurred()) + Expect(capabilities).To(HaveLen(1)) + + cap := capabilities[0] + Expect(cap.Name).To(Equal("scrobbler")) + Expect(cap.Required).To(BeTrue()) + Expect(cap.Methods).To(HaveLen(2)) + }) + + It("should parse type aliases and consts", func() { + src := `package capabilities + +//nd:capability name=scrobbler required=true +type Scrobbler interface { + //nd:export name=nd_scrobble + Scrobble(ScrobbleInput) (ScrobblerOutput, error) +} + +type ScrobbleInput struct { + UserID string ` + "`json:\"userId\"`" + ` +} + +// ScrobblerErrorType indicates error handling behavior. +type ScrobblerErrorType string + +const ( + // ScrobblerErrorNone indicates no error. + ScrobblerErrorNone ScrobblerErrorType = "none" + // ScrobblerErrorRetry indicates retry later. + ScrobblerErrorRetry ScrobblerErrorType = "retry" +) + +type ScrobblerOutput struct { + ErrorType *ScrobblerErrorType ` + "`json:\"errorType,omitempty\"`" + ` +} +` + err := os.WriteFile(filepath.Join(tmpDir, "scrobbler.go"), []byte(src), 0600) + Expect(err).NotTo(HaveOccurred()) + + capabilities, err := ParseCapabilities(tmpDir) + Expect(err).NotTo(HaveOccurred()) + Expect(capabilities).To(HaveLen(1)) + + cap := capabilities[0] + // Type alias should be collected + Expect(cap.TypeAliases).To(HaveLen(1)) + Expect(cap.TypeAliases[0].Name).To(Equal("ScrobblerErrorType")) + Expect(cap.TypeAliases[0].Type).To(Equal("string")) + + // Consts should be collected + Expect(cap.Consts).To(HaveLen(1)) + Expect(cap.Consts[0].Type).To(Equal("ScrobblerErrorType")) + Expect(cap.Consts[0].Values).To(HaveLen(2)) + Expect(cap.Consts[0].Values[0].Name).To(Equal("ScrobblerErrorNone")) + Expect(cap.Consts[0].Values[0].Value).To(Equal(`"none"`)) + }) + + It("should collect nested struct dependencies", func() { + src := `package capabilities + +//nd:capability name=metadata +type MetadataAgent interface { + //nd:export name=nd_get_images + GetImages(ArtistInput) (ImagesOutput, error) +} + +type ArtistInput struct { + ID string ` + "`json:\"id\"`" + ` +} + +type ImagesOutput struct { + Images []ImageInfo ` + "`json:\"images\"`" + ` +} + +type ImageInfo struct { + URL string ` + "`json:\"url\"`" + ` + Size int32 ` + "`json:\"size\"`" + ` +} +` + err := os.WriteFile(filepath.Join(tmpDir, "metadata.go"), []byte(src), 0600) + Expect(err).NotTo(HaveOccurred()) + + capabilities, err := ParseCapabilities(tmpDir) + Expect(err).NotTo(HaveOccurred()) + Expect(capabilities).To(HaveLen(1)) + + cap := capabilities[0] + // Should collect all 3 structs: ArtistInput, ImagesOutput, and ImageInfo + Expect(cap.Structs).To(HaveLen(3)) + + structNames := make([]string, len(cap.Structs)) + for i, s := range cap.Structs { + structNames[i] = s.Name + } + Expect(structNames).To(ContainElements("ArtistInput", "ImagesOutput", "ImageInfo")) + }) + + It("should return empty slice for directory with no capabilities", func() { + src := `package capabilities + +type RegularInterface interface { + Method() error +} +` + err := os.WriteFile(filepath.Join(tmpDir, "test.go"), []byte(src), 0600) + Expect(err).NotTo(HaveOccurred()) + + capabilities, err := ParseCapabilities(tmpDir) + Expect(err).NotTo(HaveOccurred()) + Expect(capabilities).To(BeEmpty()) + }) + + It("should ignore methods without export annotation", func() { + src := `package capabilities + +//nd:capability name=test +type TestCapability interface { + //nd:export name=nd_exported + ExportedMethod(Input) (Output, error) + + // This method has no export annotation + NotExportedMethod(Input) (Output, error) +} + +type Input struct { + Value string ` + "`json:\"value\"`" + ` +} + +type Output struct { + Result string ` + "`json:\"result\"`" + ` +} +` + err := os.WriteFile(filepath.Join(tmpDir, "test.go"), []byte(src), 0600) + Expect(err).NotTo(HaveOccurred()) + + capabilities, err := ParseCapabilities(tmpDir) + Expect(err).NotTo(HaveOccurred()) + Expect(capabilities).To(HaveLen(1)) + + // Only the exported method should be captured + Expect(capabilities[0].Methods).To(HaveLen(1)) + Expect(capabilities[0].Methods[0].Name).To(Equal("ExportedMethod")) + }) + }) + + Describe("Export helpers", func() { + It("should generate correct provider interface name", func() { + e := Export{Name: "GetArtistBiography"} + Expect(e.ProviderInterfaceName()).To(Equal("ArtistBiographyProvider")) + + e = Export{Name: "OnInit"} + Expect(e.ProviderInterfaceName()).To(Equal("InitProvider")) + }) + + It("should generate correct impl variable name", func() { + e := Export{Name: "GetArtistBiography"} + Expect(e.ImplVarName()).To(Equal("artistBiographyImpl")) + + e = Export{Name: "OnInit"} + Expect(e.ImplVarName()).To(Equal("initImpl")) + }) + + It("should generate correct export function name", func() { + e := Export{Name: "GetArtistBiography", ExportName: "nd_get_artist_biography"} + Expect(e.ExportFuncName()).To(Equal("_NdGetArtistBiography")) + }) + }) +}) diff --git a/plugins/cmd/ndpgen/internal/pdk_parser.go b/plugins/cmd/ndpgen/internal/pdk_parser.go new file mode 100644 index 000000000..4756334dd --- /dev/null +++ b/plugins/cmd/ndpgen/internal/pdk_parser.go @@ -0,0 +1,441 @@ +package internal + +import ( + "fmt" + "go/ast" + "go/token" + "sort" + "strings" + + "golang.org/x/tools/go/packages" +) + +// PDKSymbols contains all exported symbols parsed from extism/go-pdk. +type PDKSymbols struct { + Types []PDKType + Consts []PDKConst + Functions []PDKFunc +} + +// PDKType represents an exported type from extism/go-pdk. +type PDKType struct { + Name string + Underlying string // The underlying type (e.g., "int" for LogLevel) + IsAlias bool // True if it's a type alias (type X = Y) + Doc string // Documentation comment + Methods []PDKFunc // Methods on this type + Fields []PDKField // Struct fields (if it's a struct type) +} + +// PDKField represents a struct field. +type PDKField struct { + Name string + Type string + Tag string // Struct tag (e.g., `json:"name"`) +} + +// PDKConst represents an exported constant from extism/go-pdk. +type PDKConst struct { + Name string + Type string // The type name (may be empty for untyped consts) + Value string // The value expression + Doc string +} + +// PDKFunc represents an exported function from extism/go-pdk. +type PDKFunc struct { + Name string + Doc string + Receiver string // Empty for package-level functions + Params []PDKParam + Returns []PDKReturn + IsVariadic bool +} + +// PDKParam represents a function parameter. +type PDKParam struct { + Name string + Type string +} + +// PDKReturn represents a function return value. +type PDKReturn struct { + Name string // May be empty for unnamed returns + Type string +} + +// ParseExtismPDK parses the extism/go-pdk package and extracts all exported symbols. +func ParseExtismPDK() (*PDKSymbols, error) { + // Load both packages with syntax trees in one call + cfg := &packages.Config{ + Mode: packages.NeedName | packages.NeedSyntax | packages.NeedFiles, + } + pkgs, err := packages.Load(cfg, + "github.com/extism/go-pdk", + "github.com/extism/go-pdk/internal/memory", + ) + if err != nil { + return nil, fmt.Errorf("loading extism/go-pdk: %w", err) + } + + // Find both packages + var pdkPkg, memoryPkg *packages.Package + for _, pkg := range pkgs { + if len(pkg.Errors) > 0 { + return nil, fmt.Errorf("loading %s: %v", pkg.PkgPath, pkg.Errors[0]) + } + switch pkg.Name { + case "pdk": + pdkPkg = pkg + case "memory": + memoryPkg = pkg + } + } + if pdkPkg == nil { + return nil, fmt.Errorf("package github.com/extism/go-pdk not found") + } + if memoryPkg == nil { + return nil, fmt.Errorf("package github.com/extism/go-pdk/internal/memory not found") + } + + symbols := &PDKSymbols{} + seenTypes := make(map[string]bool) + + // Extract Memory type from internal/memory package first + extractMemorySymbols(memoryPkg.Syntax, symbols, seenTypes) + + // First pass: collect types from pdk package (skip if already found in internal packages) + for _, file := range pdkPkg.Syntax { + for _, decl := range file.Decls { + if genDecl, ok := decl.(*ast.GenDecl); ok { + for _, spec := range genDecl.Specs { + if typeSpec, ok := spec.(*ast.TypeSpec); ok { + if !typeSpec.Name.IsExported() { + continue + } + // Skip if we already have this type (from internal packages) + if seenTypes[typeSpec.Name.Name] { + continue + } + seenTypes[typeSpec.Name.Name] = true + pdkType := extractType(typeSpec, genDecl.Doc) + symbols.Types = append(symbols.Types, pdkType) + } + } + } + } + } + + // Build typeMap from the final slice (after all types are added) + typeMap := make(map[string]*PDKType) + for i := range symbols.Types { + typeMap[symbols.Types[i].Name] = &symbols.Types[i] + } + + // Second pass: collect functions and methods from pdk package + for _, file := range pdkPkg.Syntax { + for _, decl := range file.Decls { + switch d := decl.(type) { + case *ast.GenDecl: + if d.Tok == token.CONST { + consts := extractConsts(d) + symbols.Consts = append(symbols.Consts, consts...) + } + case *ast.FuncDecl: + if !d.Name.IsExported() { + continue + } + fn := extractFunc(d) + if fn.Receiver != "" { + // It's a method, associate with type + typeName := fn.Receiver + if strings.HasPrefix(typeName, "*") { + typeName = typeName[1:] + } + if t, ok := typeMap[typeName]; ok { + t.Methods = append(t.Methods, fn) + } + } else { + symbols.Functions = append(symbols.Functions, fn) + } + } + } + } + + // Sort for consistent output + sort.Slice(symbols.Types, func(i, j int) bool { + return symbols.Types[i].Name < symbols.Types[j].Name + }) + sort.Slice(symbols.Consts, func(i, j int) bool { + return symbols.Consts[i].Name < symbols.Consts[j].Name + }) + sort.Slice(symbols.Functions, func(i, j int) bool { + return symbols.Functions[i].Name < symbols.Functions[j].Name + }) + + return symbols, nil +} + +func extractType(spec *ast.TypeSpec, doc *ast.CommentGroup) PDKType { + t := PDKType{ + Name: spec.Name.Name, + Doc: extractDoc(doc), + } + + // Check if it's an alias (type X = Y) + t.IsAlias = spec.Assign.IsValid() + + // Extract underlying type + t.Underlying = typeString(spec.Type) + + // Extract struct fields if it's a struct type + if structType, ok := spec.Type.(*ast.StructType); ok { + t.Fields = extractStructFields(structType) + } + + return t +} + +func extractStructFields(st *ast.StructType) []PDKField { + var fields []PDKField + if st.Fields == nil { + return fields + } + + for _, field := range st.Fields.List { + fieldType := typeString(field.Type) + tag := "" + if field.Tag != nil { + tag = field.Tag.Value + } + + if len(field.Names) == 0 { + // Embedded field + fields = append(fields, PDKField{ + Name: fieldType, // Use type name as field name for embedded + Type: fieldType, + Tag: tag, + }) + } else { + for _, name := range field.Names { + // Skip unexported fields + if !name.IsExported() { + continue + } + fields = append(fields, PDKField{ + Name: name.Name, + Type: fieldType, + Tag: tag, + }) + } + } + } + return fields +} + +func extractConsts(decl *ast.GenDecl) []PDKConst { + var consts []PDKConst + var currentType string // For iota-style const blocks + + for i, spec := range decl.Specs { + valSpec, ok := spec.(*ast.ValueSpec) + if !ok { + continue + } + + // Update type if specified + if valSpec.Type != nil { + currentType = typeString(valSpec.Type) + } + + for j, name := range valSpec.Names { + if !name.IsExported() { + continue + } + + c := PDKConst{ + Name: name.Name, + Type: currentType, + } + + // Extract value + if j < len(valSpec.Values) { + c.Value = exprString(valSpec.Values[j]) + } else if i == 0 && j == 0 { + // First const with no value - likely iota + c.Value = "iota" + } + + // Extract doc + if valSpec.Doc != nil { + c.Doc = extractDoc(valSpec.Doc) + } else if i == 0 && decl.Doc != nil { + c.Doc = extractDoc(decl.Doc) + } + + consts = append(consts, c) + } + } + + return consts +} + +func extractFunc(decl *ast.FuncDecl) PDKFunc { + fn := PDKFunc{ + Name: decl.Name.Name, + Doc: extractDoc(decl.Doc), + } + + // Extract receiver + if decl.Recv != nil && len(decl.Recv.List) > 0 { + fn.Receiver = typeString(decl.Recv.List[0].Type) + } + + // Extract parameters + if decl.Type.Params != nil { + for _, field := range decl.Type.Params.List { + paramType := typeString(field.Type) + + // Check for variadic + if _, ok := field.Type.(*ast.Ellipsis); ok { + fn.IsVariadic = true + } + + if len(field.Names) == 0 { + // Unnamed parameter + fn.Params = append(fn.Params, PDKParam{Type: paramType}) + } else { + for _, name := range field.Names { + fn.Params = append(fn.Params, PDKParam{ + Name: name.Name, + Type: paramType, + }) + } + } + } + } + + // Extract returns + if decl.Type.Results != nil { + for _, field := range decl.Type.Results.List { + retType := typeString(field.Type) + + if len(field.Names) == 0 { + // Unnamed return + fn.Returns = append(fn.Returns, PDKReturn{Type: retType}) + } else { + for _, name := range field.Names { + fn.Returns = append(fn.Returns, PDKReturn{ + Name: name.Name, + Type: retType, + }) + } + } + } + } + + return fn +} + +func extractDoc(doc *ast.CommentGroup) string { + if doc == nil { + return "" + } + return strings.TrimSpace(doc.Text()) +} + +func typeString(expr ast.Expr) string { + switch t := expr.(type) { + case *ast.Ident: + return t.Name + case *ast.StarExpr: + return "*" + typeString(t.X) + case *ast.SelectorExpr: + return typeString(t.X) + "." + t.Sel.Name + case *ast.ArrayType: + if t.Len == nil { + return "[]" + typeString(t.Elt) + } + return fmt.Sprintf("[%s]%s", exprString(t.Len), typeString(t.Elt)) + case *ast.MapType: + return fmt.Sprintf("map[%s]%s", typeString(t.Key), typeString(t.Value)) + case *ast.InterfaceType: + return "any" // Simplified + case *ast.Ellipsis: + return "..." + typeString(t.Elt) + case *ast.StructType: + return "struct{}" // Simplified for anonymous structs + case *ast.FuncType: + return "func()" // Simplified + default: + return fmt.Sprintf("%T", expr) + } +} + +func exprString(expr ast.Expr) string { + switch e := expr.(type) { + case *ast.Ident: + return e.Name + case *ast.BasicLit: + return e.Value + case *ast.BinaryExpr: + return exprString(e.X) + " " + e.Op.String() + " " + exprString(e.Y) + case *ast.UnaryExpr: + return e.Op.String() + exprString(e.X) + case *ast.CallExpr: + return typeString(e.Fun) + "(...)" + default: + return fmt.Sprintf("%T", expr) + } +} + +// extractMemorySymbols extracts the Memory type and its methods from already-parsed syntax trees. +// This is needed because Memory is defined in internal/memory but re-exported by the pdk package. +func extractMemorySymbols(files []*ast.File, symbols *PDKSymbols, seenTypes map[string]bool) { + // Collect the Memory type + for _, file := range files { + for _, decl := range file.Decls { + if genDecl, ok := decl.(*ast.GenDecl); ok { + for _, spec := range genDecl.Specs { + if typeSpec, ok := spec.(*ast.TypeSpec); ok { + // Only interested in Memory type + if typeSpec.Name.Name == "Memory" { + pdkType := extractType(typeSpec, genDecl.Doc) + symbols.Types = append(symbols.Types, pdkType) + seenTypes["Memory"] = true + } + } + } + } + } + } + + // Build local type map for method association + localTypeMap := make(map[string]*PDKType) + for i := range symbols.Types { + localTypeMap[symbols.Types[i].Name] = &symbols.Types[i] + } + + // Collect methods for Memory + for _, file := range files { + for _, decl := range file.Decls { + if funcDecl, ok := decl.(*ast.FuncDecl); ok { + if !funcDecl.Name.IsExported() { + continue + } + fn := extractFunc(funcDecl) + if fn.Receiver != "" { + typeName := fn.Receiver + if strings.HasPrefix(typeName, "*") { + typeName = typeName[1:] + } + if typeName == "Memory" { + if t, ok := localTypeMap["Memory"]; ok { + t.Methods = append(t.Methods, fn) + } + } + } + } + } + } +} diff --git a/plugins/cmd/ndpgen/internal/templates/base64_bytes.rs.tmpl b/plugins/cmd/ndpgen/internal/templates/base64_bytes.rs.tmpl new file mode 100644 index 000000000..929aa8e3e --- /dev/null +++ b/plugins/cmd/ndpgen/internal/templates/base64_bytes.rs.tmpl @@ -0,0 +1,25 @@ +{{define "base64_bytes_module"}} +use base64::Engine as _; +use base64::engine::general_purpose::STANDARD as BASE64; + +mod base64_bytes { + use serde::{self, Deserialize, Deserializer, Serializer}; + use base64::Engine as _; + use base64::engine::general_purpose::STANDARD as BASE64; + + pub fn serialize(bytes: &Vec, serializer: S) -> Result + where + S: Serializer, + { + serializer.serialize_str(&BASE64.encode(bytes)) + } + + pub fn deserialize<'de, D>(deserializer: D) -> Result, D::Error> + where + D: Deserializer<'de>, + { + let s = String::deserialize(deserializer)?; + BASE64.decode(&s).map_err(serde::de::Error::custom) + } +} +{{- end}} \ No newline at end of file diff --git a/plugins/cmd/ndpgen/internal/templates/capability.go.tmpl b/plugins/cmd/ndpgen/internal/templates/capability.go.tmpl new file mode 100644 index 000000000..ebcd80739 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/templates/capability.go.tmpl @@ -0,0 +1,223 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the {{.Capability.Interface}} capability. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package {{.Package}} + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +{{- /* Generate type alias definitions */ -}} +{{- range .Capability.TypeAliases}} + +{{- if .Doc}} +{{formatDoc .Doc}} +{{- end}} +type {{.Name}} {{.Type}} +{{- end}} + +{{- /* Generate const definitions */ -}} +{{- range .Capability.Consts}} +{{- if .Values}} + +const ( +{{- $type := .Type}} +{{- range $i, $v := .Values}} +{{- if $v.Doc}} +{{formatDoc $v.Doc | indent 1}} +{{- end}} +{{- if $type}} + {{$v.Name}} {{$type}} = {{$v.Value}} +{{- else}} + {{$v.Name}} = {{$v.Value}} +{{- end}} +{{- end}} +) +{{- end}} +{{- end}} + +{{- /* Generate Error() methods for string type aliases with const values (implements error interface) */ -}} +{{- $consts := .Capability.Consts}} +{{- range .Capability.TypeAliases}} +{{- if eq .Type "string"}} +{{- $typeName := .Name}} +{{- range $consts}} +{{- if eq .Type $typeName}} + +// Error implements the error interface for {{$typeName}}. +func (e {{$typeName}}) Error() string { return string(e) } +{{- end}} +{{- end}} +{{- end}} +{{- end}} + +{{- /* Generate struct definitions */ -}} +{{- range .Capability.Structs}} + +{{- if .Doc}} +{{formatDoc .Doc}} +{{- else}} +// {{.Name}} represents the {{.Name}} data structure. +{{- end}} +type {{.Name}} struct { +{{- range .Fields}} +{{- if .Doc}} +{{formatDoc .Doc | indent 1}} +{{- end}} + {{.Name}} {{.Type}} `json:"{{.JSONTag}}{{if .OmitEmpty}},omitempty{{end}}"` +{{- end}} +} +{{- end}} + +{{- /* Generate main interface based on required flag */ -}} +{{if .Capability.Required}} + +// {{agentName .Capability}} requires all methods to be implemented. +{{- if .Capability.Doc}} +{{formatDoc .Capability.Doc}} +{{- end}} +type {{agentName .Capability}} interface { +{{- range .Capability.Methods}} + // {{.Name}}{{if .Doc}} - {{.Doc}}{{end}} + {{- if and .HasInput .HasOutput}} + {{.Name}}({{.Input.Type}}) ({{.Output.Type}}, error) + {{- else if .HasInput}} + {{.Name}}({{.Input.Type}}) error + {{- else if .HasOutput}} + {{.Name}}() ({{.Output.Type}}, error) + {{- else}} + {{.Name}}() error + {{- end}} +{{- end}} +} +{{- else}} + +// {{agentName .Capability}} is the marker interface for {{.Package}} plugins. +// Implement one or more of the provider interfaces below. +{{- if .Capability.Doc}} +{{formatDoc .Capability.Doc}} +{{- end}} +type {{agentName .Capability}} interface{} +{{- end}} + +{{- /* Generate optional provider interfaces for non-required capabilities */ -}} +{{- if not .Capability.Required}} +{{- range .Capability.Methods}} + +// {{providerInterface .}} provides the {{.Name}} function. +type {{providerInterface .}} interface { + {{- if and .HasInput .HasOutput}} + {{.Name}}({{.Input.Type}}) ({{.Output.Type}}, error) + {{- else if .HasInput}} + {{.Name}}({{.Input.Type}}) error + {{- else if .HasOutput}} + {{.Name}}() ({{.Output.Type}}, error) + {{- else}} + {{.Name}}() error + {{- end}} +} +{{- end}} +{{- end}} + +{{- /* Generate implementation function holders */ -}} + +// Internal implementation holders +var ( +{{- range .Capability.Methods}} + {{- if and .HasInput .HasOutput}} + {{implVar .}} func({{.Input.Type}}) ({{.Output.Type}}, error) + {{- else if .HasInput}} + {{implVar .}} func({{.Input.Type}}) error + {{- else if .HasOutput}} + {{implVar .}} func() ({{.Output.Type}}, error) + {{- else}} + {{implVar .}} func() error + {{- end}} +{{- end}} +) + +// Register registers a {{.Package}} implementation. +{{- if .Capability.Required}} +// All methods are required. +func Register(impl {{agentName .Capability}}) { +{{- range .Capability.Methods}} + {{implVar .}} = impl.{{.Name}} +{{- end}} +} +{{- else}} +// The implementation is checked for optional provider interfaces. +func Register(impl {{agentName .Capability}}) { +{{- range .Capability.Methods}} + if p, ok := impl.({{providerInterface .}}); ok { + {{implVar .}} = p.{{.Name}} + } +{{- end}} +} +{{- end}} + +// NotImplementedCode is the standard return code for unimplemented functions. +// The host recognizes this and skips the plugin gracefully. +const NotImplementedCode int32 = -2 + +{{- /* Generate export wrappers */ -}} +{{range .Capability.Methods}} + +//go:wasmexport {{.ExportName}} +func {{exportFunc .}}() int32 { + if {{implVar .}} == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } +{{- if .HasInput}} + + var input {{.Input.Type}} + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } +{{- end}} +{{- if and .HasInput .HasOutput}} + + output, err := {{implVar .}}(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } +{{- else if .HasInput}} + + if err := {{implVar .}}(input); err != nil { + pdk.SetError(err) + return -1 + } +{{- else if .HasOutput}} + + output, err := {{implVar .}}() + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } +{{- else}} + + if err := {{implVar .}}(); err != nil { + pdk.SetError(err) + return -1 + } +{{- end}} + + return 0 +} +{{- end}} diff --git a/plugins/cmd/ndpgen/internal/templates/capability.rs.tmpl b/plugins/cmd/ndpgen/internal/templates/capability.rs.tmpl new file mode 100644 index 000000000..790ed93e4 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/templates/capability.rs.tmpl @@ -0,0 +1,202 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the {{.Capability.Interface}} capability. +// It is intended for use in Navidrome plugins built with extism-pdk. +{{if .Capability.Structs}} +use serde::{Deserialize, Serialize}; +{{- if hasHashMap .Capability}} +use std::collections::HashMap; +{{- end}} +{{- if .Capability.HasByteFields}}{{template "base64_bytes_module" .}}{{- end}} + +// Helper functions for skip_serializing_if with numeric types +#[allow(dead_code)] +fn is_zero_i32(value: &i32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u32(value: &u32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_i64(value: &i64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u64(value: &u64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_f32(value: &f32) -> bool { *value == 0.0 } +#[allow(dead_code)] +fn is_zero_f64(value: &f64) -> bool { *value == 0.0 } +{{- end}} + +{{- /* Generate type alias definitions */ -}} +{{- range .Capability.TypeAliases}} + +{{- if .Doc}} +{{rustDocComment .Doc}} +{{- end}} +pub type {{.Name}} = {{rustTypeAlias .Type}}; +{{- end}} + +{{- /* Generate const definitions */ -}} +{{- range .Capability.Consts}} +{{- if .Values}} +{{- $type := .Type}} +{{- range $i, $v := .Values}} + +{{- if $v.Doc}} +{{rustDocComment $v.Doc}} +{{- end}} +{{- /* Use the type alias name if a named type is provided, otherwise use &'static str */ -}} +{{- if $type}} +pub const {{rustConstName $v.Name}}: {{$type}} = {{$v.Value}}; +{{- else}} +pub const {{rustConstName $v.Name}}: &'static str = {{$v.Value}}; +{{- end}} +{{- end}} +{{- end}} +{{- end}} + +{{- /* Generate struct definitions */ -}} +{{- range .Capability.Structs}} + +{{- if .Doc}} +{{rustDocComment .Doc}} +{{- else}} +/// {{.Name}} represents the {{.Name}} data structure. +{{- end}} +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct {{.Name}} { +{{- range .Fields}} +{{- if .Doc}} +{{rustDocComment .Doc | indent 4}} +{{- end}} +{{- if .OmitEmpty}} + #[serde(default, skip_serializing_if = "{{skipSerializingFunc .Type}}")] +{{- else}} + #[serde(default)] +{{- end}} +{{- if .IsByteSlice}} + #[serde(with = "base64_bytes")] +{{- end}} + pub {{rustFieldName .Name}}: {{fieldRustType .}}, +{{- end}} +} +{{- end}} + +/// Error represents an error from a capability method. +#[derive(Debug)] +pub struct Error { + pub message: String, +} + +impl std::fmt::Display for Error { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.message) + } +} + +impl std::error::Error for Error {} + +impl Error { + pub fn new(message: impl Into) -> Self { + Self { message: message.into() } + } +} + +{{- /* Generate main interface based on required flag */ -}} +{{if .Capability.Required}} + +/// {{agentName .Capability}} requires all methods to be implemented. +{{- if .Capability.Doc}} +{{rustDocComment .Capability.Doc}} +{{- end}} +pub trait {{agentName .Capability}} { +{{- range .Capability.Methods}} + /// {{.Name}}{{if .Doc}} - {{.Doc}}{{end}} + {{- if and .HasInput .HasOutput}} + fn {{rustMethodName .Name}}(&self, req: {{rustOutputType .Input.Type}}) -> Result<{{rustOutputType .Output.Type}}, Error>; + {{- else if .HasInput}} + fn {{rustMethodName .Name}}(&self, req: {{rustOutputType .Input.Type}}) -> Result<(), Error>; + {{- else if .HasOutput}} + fn {{rustMethodName .Name}}(&self) -> Result<{{rustOutputType .Output.Type}}, Error>; + {{- else}} + fn {{rustMethodName .Name}}(&self) -> Result<(), Error>; + {{- end}} +{{- end}} +} + +/// Register all exports for the {{agentName .Capability}} capability. +/// This macro generates the WASM export functions for all trait methods. +#[macro_export] +macro_rules! register_{{snakeCase .Package}} { + ($plugin_type:ty) => { + {{- range .Capability.Methods}} + #[extism_pdk::plugin_fn] + pub fn {{.ExportName}}( + {{- if .HasInput}} + req: extism_pdk::Json<$crate::{{snakeCase $.Package}}::{{rustOutputType .Input.Type}}> + {{- end}} + ) -> extism_pdk::FnResult<{{if .HasOutput}}extism_pdk::Json<{{if isPrimitiveRust .Output.Type}}{{rustOutputType .Output.Type}}{{else}}$crate::{{snakeCase $.Package}}::{{rustOutputType .Output.Type}}{{end}}>{{else}}(){{end}}> { + let plugin = <$plugin_type>::default(); + {{- if and .HasInput .HasOutput}} + let result = $crate::{{snakeCase $.Package}}::{{agentName $.Capability}}::{{rustMethodName .Name}}(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + {{- else if .HasInput}} + $crate::{{snakeCase $.Package}}::{{agentName $.Capability}}::{{rustMethodName .Name}}(&plugin, req.into_inner())?; + Ok(()) + {{- else if .HasOutput}} + let result = $crate::{{snakeCase $.Package}}::{{agentName $.Capability}}::{{rustMethodName .Name}}(&plugin)?; + Ok(extism_pdk::Json(result)) + {{- else}} + $crate::{{snakeCase $.Package}}::{{agentName $.Capability}}::{{rustMethodName .Name}}(&plugin)?; + Ok(()) + {{- end}} + } + {{- end}} + }; +} +{{- else}} + +{{- /* Generate optional provider interfaces for non-required capabilities */ -}} +{{- range .Capability.Methods}} + +/// {{providerInterface .}} provides the {{.Name}} function. +pub trait {{providerInterface .}} { + {{- if and .HasInput .HasOutput}} + fn {{rustMethodName .Name}}(&self, req: {{rustOutputType .Input.Type}}) -> Result<{{rustOutputType .Output.Type}}, Error>; + {{- else if .HasInput}} + fn {{rustMethodName .Name}}(&self, req: {{rustOutputType .Input.Type}}) -> Result<(), Error>; + {{- else if .HasOutput}} + fn {{rustMethodName .Name}}(&self) -> Result<{{rustOutputType .Output.Type}}, Error>; + {{- else}} + fn {{rustMethodName .Name}}(&self) -> Result<(), Error>; + {{- end}} +} + +/// Register the {{rustMethodName .Name}} export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! {{registerMacroName .Name}} { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn {{.ExportName}}( + {{- if .HasInput}} + req: extism_pdk::Json<$crate::{{snakeCase $.Package}}::{{rustOutputType .Input.Type}}> + {{- end}} + ) -> extism_pdk::FnResult<{{if .HasOutput}}extism_pdk::Json<{{if isPrimitiveRust .Output.Type}}{{rustOutputType .Output.Type}}{{else}}$crate::{{snakeCase $.Package}}::{{rustOutputType .Output.Type}}{{end}}>{{else}}(){{end}}> { + let plugin = <$plugin_type>::default(); + {{- if and .HasInput .HasOutput}} + let result = $crate::{{snakeCase $.Package}}::{{providerInterface .}}::{{rustMethodName .Name}}(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + {{- else if .HasInput}} + $crate::{{snakeCase $.Package}}::{{providerInterface .}}::{{rustMethodName .Name}}(&plugin, req.into_inner())?; + Ok(()) + {{- else if .HasOutput}} + let result = $crate::{{snakeCase $.Package}}::{{providerInterface .}}::{{rustMethodName .Name}}(&plugin)?; + Ok(extism_pdk::Json(result)) + {{- else}} + $crate::{{snakeCase $.Package}}::{{providerInterface .}}::{{rustMethodName .Name}}(&plugin)?; + Ok(()) + {{- end}} + } + }; +} +{{- end}} +{{- end}} diff --git a/plugins/cmd/ndpgen/internal/templates/capability_stub.go.tmpl b/plugins/cmd/ndpgen/internal/templates/capability_stub.go.tmpl new file mode 100644 index 000000000..90f72be93 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/templates/capability_stub.go.tmpl @@ -0,0 +1,132 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file provides stub implementations for non-WASM platforms. +// It allows Go plugins to compile and run tests outside of WASM, +// but the actual functionality is only available in WASM builds. +// +//go:build !wasip1 + +package {{.Package}} + +{{- /* Generate type alias definitions */ -}} +{{- range .Capability.TypeAliases}} + +{{- if .Doc}} +{{formatDoc .Doc}} +{{- end}} +type {{.Name}} {{.Type}} +{{- end}} + +{{- /* Generate const definitions */ -}} +{{- range .Capability.Consts}} +{{- if .Values}} + +const ( +{{- $type := .Type}} +{{- range $i, $v := .Values}} +{{- if $v.Doc}} +{{formatDoc $v.Doc | indent 1}} +{{- end}} +{{- if $type}} + {{$v.Name}} {{$type}} = {{$v.Value}} +{{- else}} + {{$v.Name}} = {{$v.Value}} +{{- end}} +{{- end}} +) +{{- end}} +{{- end}} + +{{- /* Generate Error() methods for string type aliases with const values (implements error interface) */ -}} +{{- $consts := .Capability.Consts}} +{{- range .Capability.TypeAliases}} +{{- if eq .Type "string"}} +{{- $typeName := .Name}} +{{- range $consts}} +{{- if eq .Type $typeName}} + +// Error implements the error interface for {{$typeName}}. +func (e {{$typeName}}) Error() string { return string(e) } +{{- end}} +{{- end}} +{{- end}} +{{- end}} + +{{- /* Generate struct definitions */ -}} +{{- range .Capability.Structs}} + +{{- if .Doc}} +{{formatDoc .Doc}} +{{- else}} +// {{.Name}} represents the {{.Name}} data structure. +{{- end}} +type {{.Name}} struct { +{{- range .Fields}} +{{- if .Doc}} +{{formatDoc .Doc | indent 1}} +{{- end}} + {{.Name}} {{.Type}} `json:"{{.JSONTag}}{{if .OmitEmpty}},omitempty{{end}}"` +{{- end}} +} +{{- end}} + +{{- /* Generate main interface based on required flag */ -}} +{{if .Capability.Required}} + +// {{agentName .Capability}} requires all methods to be implemented. +{{- if .Capability.Doc}} +{{formatDoc .Capability.Doc}} +{{- end}} +type {{agentName .Capability}} interface { +{{- range .Capability.Methods}} + // {{.Name}}{{if .Doc}} - {{.Doc}}{{end}} + {{- if and .HasInput .HasOutput}} + {{.Name}}({{.Input.Type}}) ({{.Output.Type}}, error) + {{- else if .HasInput}} + {{.Name}}({{.Input.Type}}) error + {{- else if .HasOutput}} + {{.Name}}() ({{.Output.Type}}, error) + {{- else}} + {{.Name}}() error + {{- end}} +{{- end}} +} +{{- else}} + +// {{agentName .Capability}} is the marker interface for {{.Package}} plugins. +// Implement one or more of the provider interfaces below. +{{- if .Capability.Doc}} +{{formatDoc .Capability.Doc}} +{{- end}} +type {{agentName .Capability}} interface{} +{{- end}} + +{{- /* Generate optional provider interfaces for non-required capabilities */ -}} +{{- if not .Capability.Required}} +{{- range .Capability.Methods}} + +// {{providerInterface .}} provides the {{.Name}} function. +type {{providerInterface .}} interface { + {{- if and .HasInput .HasOutput}} + {{.Name}}({{.Input.Type}}) ({{.Output.Type}}, error) + {{- else if .HasInput}} + {{.Name}}({{.Input.Type}}) error + {{- else if .HasOutput}} + {{.Name}}() ({{.Output.Type}}, error) + {{- else}} + {{.Name}}() error + {{- end}} +} +{{- end}} +{{- end}} + +// NotImplementedCode is the standard return code for unimplemented functions. +const NotImplementedCode int32 = -2 + +// Register is a no-op on non-WASM platforms. +// This stub allows code to compile outside of WASM. +{{- if .Capability.Required}} +func Register(_ {{agentName .Capability}}) {} +{{- else}} +func Register(_ {{agentName .Capability}}) {} +{{- end}} diff --git a/plugins/cmd/ndpgen/internal/templates/client.go.tmpl b/plugins/cmd/ndpgen/internal/templates/client.go.tmpl new file mode 100644 index 000000000..a6ee04446 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/templates/client.go.tmpl @@ -0,0 +1,129 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the {{.Service.Name}} host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package {{.Package}} + +import ( + "encoding/json" +{{- if .Service.HasErrors}} + "errors" +{{- end}} + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +{{- /* Generate struct definitions */ -}} +{{- range .Service.Structs}} + +// {{.Name}} represents the {{.Name}} data structure. +{{- if .Doc}} +{{formatDoc .Doc}} +{{- end}} +type {{.Name}} struct { +{{- range .Fields}} + {{.Name}} {{.Type}} `json:"{{.JSONTag}}"` +{{- end}} +} +{{- end}} + +{{- /* Generate wasmimport declarations for each method */ -}} +{{range .Service.Methods}} + +// {{exportName .}} is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user {{exportName .}} +func {{exportName .}}(uint64) uint64 +{{- end}} + +{{- /* Generate request/response types for all methods (private) */ -}} +{{range .Service.Methods}} +{{- if .HasParams}} + +type {{requestType .}} struct { +{{- range .Params}} + {{title .Name}} {{.Type}} `json:"{{.JSONName}}"` +{{- end}} +} +{{- end}} +{{- if not .IsErrorOnly}} + +type {{responseType .}} struct { +{{- range .Returns}} + {{title .Name}} {{.Type}} `json:"{{.JSONName}},omitempty"` +{{- end}} +{{- if .HasError}} + Error string `json:"error,omitempty"` +{{- end}} +} +{{- end}} +{{- end}} + +{{- /* Generate wrapper functions */ -}} +{{range .Service.Methods}} + +// {{$.Service.Name}}{{.Name}} calls the {{exportName .}} host function. +{{- if .Doc}} +{{formatDoc .Doc}} +{{- end}} +func {{$.Service.Name}}{{.Name}}({{range $i, $p := .Params}}{{if $i}}, {{end}}{{$p.Name}} {{$p.Type}}{{end}}) {{.ReturnSignature}} { +{{- if .HasParams}} + // Marshal request to JSON + req := {{requestType .}}{ +{{- range .Params}} + {{title .Name}}: {{.Name}}, +{{- end}} + } + reqBytes, err := json.Marshal(req) + if err != nil { + return {{if .HasReturns}}{{.ZeroValues}}{{end}}{{if and .HasReturns .HasError}}, {{end}}{{if .HasError}}err{{end}} + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() +{{- else}} + // No parameters - allocate empty JSON object + reqMem := pdk.AllocateBytes([]byte("{}")) + defer reqMem.Free() +{{- end}} + + // Call the host function + responsePtr := {{exportName .}}(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() +{{- if .IsErrorOnly}} + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +{{- else}} + + // Parse the response + var response {{responseType .}} + if err := json.Unmarshal(responseBytes, &response); err != nil { + return {{if .HasReturns}}{{.ZeroValues}}{{end}}{{if and .HasReturns .HasError}}, {{end}}{{if .HasError}}err{{end}} + } +{{- if .HasError}} + + // Convert Error field to Go error + if response.Error != "" { + return {{if .HasReturns}}{{.ZeroValues}}, {{end}}errors.New(response.Error) + } +{{- end}} + + return {{range $i, $r := .Returns}}{{if $i}}, {{end}}response.{{title $r.Name}}{{end}}{{if and .HasReturns .HasError}}, {{end}}{{if .HasError}}nil{{end}} +{{- end}} +} +{{- end}} diff --git a/plugins/cmd/ndpgen/internal/templates/client.py.tmpl b/plugins/cmd/ndpgen/internal/templates/client.py.tmpl new file mode 100644 index 000000000..7ccaa6106 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/templates/client.py.tmpl @@ -0,0 +1,111 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the {{.Service.Name}} host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json +{{- if .Service.HasByteFields}} +import base64 +{{- end}} + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + +{{- /* Generate raw host function imports */ -}} +{{range .Service.Methods}} + + +@extism.import_fn("extism:host/user", "{{exportName .}}") +def _{{exportName .}}(offset: int) -> int: + """Raw host function - do not call directly.""" + ... +{{- end}} +{{- /* Generate dataclasses for multi-value returns */ -}} +{{range .Service.Methods}} +{{- if .NeedsResultClass}} + + +@dataclass +class {{pythonResultType .}}: + """Result type for {{pythonFunc .}}.""" +{{- range .Returns}} + {{.PythonName}}: {{.PythonType}} +{{- end}} +{{- end}} +{{- end}} +{{- /* Generate wrapper functions */ -}} +{{range .Service.Methods}} + + +def {{pythonFunc .}}({{range $i, $p := .Params}}{{if $i}}, {{end}}{{$p.PythonName}}: {{$p.PythonType}}{{end}}){{if .NeedsResultClass}} -> {{pythonResultType .}}{{else if .HasReturns}} -> {{(index .Returns 0).PythonType}}{{else}} -> None{{end}}: + """{{if .Doc}}{{.Doc}}{{else}}Call the {{exportName .}} host function.{{end}} +{{- if .HasParams}} + + Args: +{{- range .Params}} + {{.PythonName}}: {{.PythonType}} parameter. +{{- end}} +{{- end}} +{{- if .HasReturns}} + + Returns: +{{- if .NeedsResultClass}} + {{pythonResultType .}} containing{{range .Returns}} {{.PythonName}},{{end}}. +{{- else}} + {{(index .Returns 0).PythonType}}: The result value. +{{- end}} +{{- end}} + + Raises: + HostFunctionError: If the host function returns an error. + """ +{{- if .HasParams}} + request = { +{{- range .Params}} +{{- if .IsByteSlice}} + "{{.JSONName}}": base64.b64encode({{.PythonName}}).decode("ascii"), +{{- else}} + "{{.JSONName}}": {{.PythonName}}, +{{- end}} +{{- end}} + } + request_bytes = json.dumps(request).encode("utf-8") +{{- else}} + request_bytes = b"{}" +{{- end}} + request_mem = extism.memory.alloc(request_bytes) + response_offset = _{{exportName .}}(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) +{{if .HasError}} + if response.get("error"): + raise HostFunctionError(response["error"]) +{{end}} +{{- if .NeedsResultClass}} + return {{pythonResultType .}}( +{{- range .Returns}} +{{- if .IsByteSlice}} + {{.PythonName}}=base64.b64decode(response.get("{{.JSONName}}", "")), +{{- else}} + {{.PythonName}}=response.get("{{.JSONName}}"{{pythonDefault .}}), +{{- end}} +{{- end}} + ) +{{- else if .HasReturns}} +{{- if (index .Returns 0).IsByteSlice}} + return base64.b64decode(response.get("{{(index .Returns 0).JSONName}}", "")) +{{- else}} + return response.get("{{(index .Returns 0).JSONName}}"{{pythonDefault (index .Returns 0)}}) +{{- end}} +{{- end}} +{{- end}} diff --git a/plugins/cmd/ndpgen/internal/templates/client.rs.tmpl b/plugins/cmd/ndpgen/internal/templates/client.rs.tmpl new file mode 100644 index 000000000..f8b786849 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/templates/client.rs.tmpl @@ -0,0 +1,144 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the {{.Service.Name}} host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; +{{- if .Service.HasByteFields}}{{template "base64_bytes_module" .}}{{- end}} +{{- /* Generate struct definitions */ -}} +{{- range .Service.Structs}} +{{if .Doc}} +{{rustDocComment .Doc}} +{{else}} +{{end}}#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct {{.Name}} { +{{- range .Fields}} +{{- if .NeedsDefault}} + #[serde(default)] +{{- end}} +{{- if .IsByteSlice}} + #[serde(with = "base64_bytes")] +{{- end}} + pub {{.RustName}}: {{fieldRustType .}}, +{{- end}} +} +{{- end}} +{{- /* Generate request/response types */ -}} +{{- range .Service.Methods}} +{{- if .HasParams}} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct {{requestType .}} { +{{- range .Params}} +{{- if .IsByteSlice}} + #[serde(with = "base64_bytes")] +{{- end}} + {{.RustName}}: {{rustType .}}, +{{- end}} +} +{{- end}} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct {{responseType .}} { +{{- range .Returns}} + #[serde(default)] +{{- if .IsByteSlice}} + #[serde(with = "base64_bytes")] +{{- end}} + {{.RustName}}: {{rustType .}}, +{{- end}} +{{- if .HasError}} + #[serde(default)] + error: Option, +{{- end}} +} +{{- end}} + +#[host_fn] +extern "ExtismHost" { +{{- range .Service.Methods}} + fn {{exportName .}}(input: Json<{{if .HasParams}}{{requestType .}}{{else}}serde_json::Value{{end}}>) -> Json<{{responseType .}}>; +{{- end}} +} + +{{- /* Generate wrapper functions */ -}} +{{range .Service.Methods}} + +{{if .Doc}}{{rustDocComment .Doc}}{{else}}/// Calls the {{exportName .}} host function.{{end}} +{{- if .HasParams}} +/// +/// # Arguments +{{- range .Params}} +/// * `{{.RustName}}` - {{rustType .}} parameter. +{{- end}} +{{- end}} +{{- if .HasReturns}} +/// +/// # Returns +{{- if .IsOptionPattern}} +/// `Some({{(index .Returns 0).RustName}})` if found, `None` otherwise. +{{- else if eq (len .Returns) 1}} +/// The {{(index .Returns 0).RustName}} value. +{{- else}} +/// A tuple of ({{range $i, $r := .Returns}}{{if $i}}, {{end}}{{$r.RustName}}{{end}}). +{{- end}} +{{- end}} +/// +/// # Errors +/// Returns an error if the host function call fails. +{{- if .IsOptionPattern}} +pub fn {{rustFunc .}}({{range $i, $p := .Params}}{{if $i}}, {{end}}{{$p.RustName}}: {{rustParamType $p}}{{end}}) -> Result, Error> { + let response = unsafe { +{{- if .HasParams}} + {{exportName .}}(Json({{requestType .}} { +{{- range .Params}} + {{.RustName}}: {{.RustName}}{{if .NeedsToOwned}}.to_owned(){{end}}, +{{- end}} + }))? +{{- else}} + {{exportName .}}(Json(serde_json::json!({})))? +{{- end}} + }; +{{if .HasError}} + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } +{{end}} + if response.0.{{(index .Returns 1).RustName}} { + Ok(Some(response.0.{{(index .Returns 0).RustName}})) + } else { + Ok(None) + } +} +{{- else}} +pub fn {{rustFunc .}}({{range $i, $p := .Params}}{{if $i}}, {{end}}{{$p.RustName}}: {{rustParamType $p}}{{end}}) -> Result<{{if eq (len .Returns) 0}}(){{else if eq (len .Returns) 1}}{{rustType (index .Returns 0)}}{{else}}({{range $i, $r := .Returns}}{{if $i}}, {{end}}{{rustType $r}}{{end}}){{end}}, Error> { + let response = unsafe { +{{- if .HasParams}} + {{exportName .}}(Json({{requestType .}} { +{{- range .Params}} + {{.RustName}}: {{.RustName}}{{if .NeedsToOwned}}.to_owned(){{end}}, +{{- end}} + }))? +{{- else}} + {{exportName .}}(Json(serde_json::json!({})))? +{{- end}} + }; +{{if .HasError}} + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } +{{end}} +{{- if eq (len .Returns) 0}} + Ok(()) +{{- else if eq (len .Returns) 1}} + Ok(response.0.{{(index .Returns 0).RustName}}) +{{- else}} + Ok(({{range $i, $r := .Returns}}{{if $i}}, {{end}}response.0.{{$r.RustName}}{{end}})) +{{- end}} +} +{{- end}} +{{- end}} diff --git a/plugins/cmd/ndpgen/internal/templates/client_stub.go.tmpl b/plugins/cmd/ndpgen/internal/templates/client_stub.go.tmpl new file mode 100644 index 000000000..da19df666 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/templates/client_stub.go.tmpl @@ -0,0 +1,50 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains mock implementations for non-WASM builds. +// These mocks allow IDE support, compilation, and unit testing on non-WASM platforms. +// Plugin authors can use the exported mock instances to set expectations in tests. +// +//go:build !wasip1 + +package {{.Package}} + +import "github.com/stretchr/testify/mock" + +{{- /* Generate struct definitions (same as main file, needed for type references in function signatures) */ -}} +{{- range .Service.Structs}} + +// {{.Name}} represents the {{.Name}} data structure. +{{- if .Doc}} +{{formatDoc .Doc}} +{{- end}} +type {{.Name}} struct { +{{- range .Fields}} + {{.Name}} {{.Type}} `json:"{{.JSONTag}}"` +{{- end}} +} +{{- end}} + +// mock{{.Service.Name}}Service is the mock implementation for testing. +type mock{{.Service.Name}}Service struct { + mock.Mock +} + +// {{.Service.Name}}Mock is the auto-instantiated mock instance for testing. +// Use this to set expectations: host.{{.Service.Name}}Mock.On("MethodName", args...).Return(values...) +var {{.Service.Name}}Mock = &mock{{.Service.Name}}Service{} +{{range .Service.Methods}} + +// {{.Name}} is the mock method for {{$.Service.Name}}{{.Name}}. +func (m *mock{{$.Service.Name}}Service) {{.Name}}({{range $i, $p := .Params}}{{if $i}}, {{end}}{{$p.Name}} {{$p.Type}}{{end}}) {{.ReturnSignature}} { + args := m.Called({{range $i, $p := .Params}}{{if $i}}, {{end}}{{$p.Name}}{{end}}) + return {{mockReturnValues .}} +} + +// {{$.Service.Name}}{{.Name}} delegates to the mock instance. +{{- if .Doc}} +{{formatDoc .Doc}} +{{- end}} +func {{$.Service.Name}}{{.Name}}({{range $i, $p := .Params}}{{if $i}}, {{end}}{{$p.Name}} {{$p.Type}}{{end}}) {{.ReturnSignature}} { + return {{$.Service.Name}}Mock.{{.Name}}({{range $i, $p := .Params}}{{if $i}}, {{end}}{{$p.Name}}{{end}}) +} +{{- end}} diff --git a/plugins/cmd/ndpgen/internal/templates/doc.go.tmpl b/plugins/cmd/ndpgen/internal/templates/doc.go.tmpl new file mode 100644 index 000000000..e48dc3363 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/templates/doc.go.tmpl @@ -0,0 +1,49 @@ +// Code generated by ndpgen. DO NOT EDIT. + +/* +Package {{.Package}} provides Navidrome Plugin Development Kit wrappers for Go/TinyGo plugins. + +This package is auto-generated by the ndpgen tool and should not be edited manually. + +# Usage + +Add this module as a dependency in your plugin's go.mod: + + require github.com/navidrome/navidrome/plugins/pdk/go/host v0.0.0 + +Then import the package in your plugin code: + + import {{.Package}} "github.com/navidrome/navidrome/plugins/pdk/go/host" + + func myPluginFunction() error { + // Use the cache service + _, err := {{.Package}}.CacheSetString("my_key", "my_value", 3600) + if err != nil { + return err + } + + // Schedule a recurring task + _, err = {{.Package}}.SchedulerScheduleRecurring("@every 5m", "payload", "task_id") + if err != nil { + return err + } + + return nil + } + +# Available Services + +The following host services are available: +{{range .Services}} + - {{.Name}}: {{if .Doc}}{{.Doc | firstLine}}{{else}}{{.Name}} service{{end}} +{{- end}} + +# Building Plugins + +Go plugins must be compiled to WebAssembly using TinyGo: + + tinygo build -o plugin.wasm -target=wasip1 -buildmode=c-shared . + +See the examples directory for complete plugin implementations. +*/ +package {{.Package}} diff --git a/plugins/cmd/ndpgen/internal/templates/go.mod.tmpl b/plugins/cmd/ndpgen/internal/templates/go.mod.tmpl new file mode 100644 index 000000000..3916cd749 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/templates/go.mod.tmpl @@ -0,0 +1,8 @@ +module github.com/navidrome/navidrome/plugins/pdk/go + +go 1.25 + +require ( + github.com/extism/go-pdk v1.1.3 + github.com/stretchr/testify v1.11.1 +) diff --git a/plugins/cmd/ndpgen/internal/templates/host.go.tmpl b/plugins/cmd/ndpgen/internal/templates/host.go.tmpl new file mode 100644 index 000000000..083f7577e --- /dev/null +++ b/plugins/cmd/ndpgen/internal/templates/host.go.tmpl @@ -0,0 +1,129 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package {{.Package}} + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +{{- /* Generate request/response types for all methods */ -}} +{{range .Service.Methods}} +{{- if .HasParams}} + +// {{requestType .}} is the request type for {{$.Service.Name}}.{{.Name}}. +type {{requestType .}} struct { +{{- range .Params}} + {{title .Name}} {{.Type}} `json:"{{.JSONName}}"` +{{- end}} +} +{{- end}} + +// {{responseType .}} is the response type for {{$.Service.Name}}.{{.Name}}. +type {{responseType .}} struct { +{{- range .Returns}} + {{title .Name}} {{.Type}} `json:"{{.JSONName}},omitempty"` +{{- end}} +{{- if .HasError}} + Error string `json:"error,omitempty"` +{{- end}} +} +{{end}} + +// Register{{.Service.Name}}HostFunctions registers {{.Service.Name}} service host functions. +// The returned host functions should be added to the plugin's configuration. +func Register{{.Service.Name}}HostFunctions(service {{.Service.Interface}}) []extism.HostFunction { + return []extism.HostFunction{ +{{- range .Service.Methods}} + new{{$.Service.Name}}{{.Name}}HostFunction(service), +{{- end}} + } +} +{{range .Service.Methods}} + +func new{{$.Service.Name}}{{.Name}}HostFunction(service {{$.Service.Interface}}) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "{{exportName .}}", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { +{{- if .HasParams}} + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + {{$.Service.Name | lower}}WriteError(p, stack, err) + return + } + var req {{requestType .}} + if err := json.Unmarshal(reqBytes, &req); err != nil { + {{$.Service.Name | lower}}WriteError(p, stack, err) + return + } +{{- end}} + + // Call the service method +{{- if .HasReturns}} +{{- if .HasError}} + {{range $i, $r := .Returns}}{{if $i}}, {{end}}{{lower $r.Name}}{{end}}, svcErr := service.{{.Name}}(ctx{{range .Params}}, req.{{title .Name}}{{end}}) + if svcErr != nil { + {{$.Service.Name | lower}}WriteError(p, stack, svcErr) + return + } +{{- else}} + {{range $i, $r := .Returns}}{{if $i}}, {{end}}{{lower $r.Name}}{{end}} := service.{{.Name}}(ctx{{range .Params}}, req.{{title .Name}}{{end}}) +{{- end}} + + // Write JSON response to plugin memory + resp := {{responseType .}}{ +{{- range .Returns}} + {{title .Name}}: {{lower .Name}}, +{{- end}} + } + {{$.Service.Name | lower}}WriteResponse(p, stack, resp) +{{- else if .HasError}} + if svcErr := service.{{.Name}}(ctx{{range .Params}}, req.{{title .Name}}{{end}}); svcErr != nil { + {{$.Service.Name | lower}}WriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := {{responseType .}}{} + {{$.Service.Name | lower}}WriteResponse(p, stack, resp) +{{- else}} + service.{{.Name}}(ctx{{range .Params}}, req.{{title .Name}}{{end}}) + + // Write JSON response to plugin memory + resp := {{responseType .}}{} + {{$.Service.Name | lower}}WriteResponse(p, stack, resp) +{{- end}} + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} +{{end}} + +// {{.Service.Name | lower}}WriteResponse writes a JSON response to plugin memory. +func {{.Service.Name | lower}}WriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + {{.Service.Name | lower}}WriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// {{.Service.Name | lower}}WriteError writes an error response to plugin memory. +func {{.Service.Name | lower}}WriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/cmd/ndpgen/internal/templates/lib.rs.tmpl b/plugins/cmd/ndpgen/internal/templates/lib.rs.tmpl new file mode 100644 index 000000000..3b0434ee2 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/templates/lib.rs.tmpl @@ -0,0 +1,47 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +//! Navidrome Host Function Wrappers for Rust Plugins +//! +//! This crate provides idiomatic Rust wrappers for all Navidrome host services. +//! It is auto-generated by the ndpgen tool and should not be edited manually. +//! +//! # Usage +//! +//! Add this crate as a dependency in your plugin's Cargo.toml: +//! +//! ```toml +//! [dependencies] +//! nd-host = { path = "../../host/rust" } +//! ``` +//! +//! Then import the services you need: +//! +//! ```ignore +//! use nd_host::{cache, scheduler}; +//! +//! fn my_plugin_function() -> Result<(), extism_pdk::Error> { +//! // Use the cache service +//! cache::set_string("my_key", "my_value", 3600)?; +//! +//! // Schedule a recurring task +//! scheduler::schedule_recurring("@every 5m", "payload", "task_id")?; +//! +//! Ok(()) +//! } +//! ``` +//! +//! # Available Services +//! +{{- range .Services}} +//! - [`{{.Name | lower}}`] - {{if .Doc}}{{.Doc | firstLine}}{{else}}{{.Name}} service{{end}} +{{- end}} +{{range .Services}} +#[doc(hidden)] +mod nd_host_{{.Name | lower}}; +/// {{if .Doc}}{{.Doc | firstLine}}{{else}}{{.Name}} host service wrappers.{{end}} +pub mod {{.Name | lower}} { + pub use super::nd_host_{{.Name | lower}}::*; +} +{{end}} +// Re-export commonly used types from extism-pdk for convenience +pub use extism_pdk::Error; diff --git a/plugins/cmd/ndpgen/internal/templates/pdk.go.tmpl b/plugins/cmd/ndpgen/internal/templates/pdk.go.tmpl new file mode 100644 index 000000000..ebaf88df0 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/templates/pdk.go.tmpl @@ -0,0 +1,50 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains wrapper functions for the extism/go-pdk package. +// For WASM builds, it provides type aliases and function wrappers that delegate +// to the real extism/go-pdk package with zero overhead. +// +//go:build wasip1 + +package pdk + +import ( + extism "github.com/extism/go-pdk" +) + +// Type aliases - zero overhead, full compatibility +{{- range .Types}} +type {{.Name}} = extism.{{.Name}} +{{- end}} + +// Constants +{{- $prevType := ""}} +{{- range .Consts}} +{{- if ne .Type $prevType}} +{{- if ne $prevType ""}} +) +{{- end}} + +const ( +{{- end}} + {{.Name}} = extism.{{.Name}} +{{- $prevType = .Type}} +{{- end}} +{{- if ne $prevType ""}} +) +{{- end}} + +// Functions +{{- range .Functions}} + +{{- if .Doc}} +// {{.Name}} {{firstSentence .Doc}} +{{- end}} +func {{.Name}}({{paramList .Params}}){{returnList .Returns}} { +{{- if .Returns}} + return extism.{{.Name}}({{argList .Params}}) +{{- else}} + extism.{{.Name}}({{argList .Params}}) +{{- end}} +} +{{- end}} diff --git a/plugins/cmd/ndpgen/internal/templates/pdk_stub.go.tmpl b/plugins/cmd/ndpgen/internal/templates/pdk_stub.go.tmpl new file mode 100644 index 000000000..6a57a6469 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/templates/pdk_stub.go.tmpl @@ -0,0 +1,42 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains mock implementations for non-WASM builds. +// These mocks allow IDE support, compilation, and unit testing on non-WASM platforms. +// Plugin authors can use the exported PDKMock instance to set expectations in tests. +// +//go:build !wasip1 + +package pdk + +import "github.com/stretchr/testify/mock" + +// mockPDK is the mock implementation for testing PDK functions. +type mockPDK struct { + mock.Mock +} + +// PDKMock is the auto-instantiated mock instance for testing. +// Use this to set expectations: pdk.PDKMock.On("GetConfig", "key").Return("value", true) +var PDKMock = &mockPDK{} + +// ResetMock resets the mock to its initial state. +// Call this in test setup/teardown to ensure clean state between tests. +func ResetMock() { + PDKMock = &mockPDK{} +} + +// Functions +{{- range .Functions}} + +{{- if .Doc}} +// {{.Name}} {{firstSentence .Doc}} +{{- end}} +func {{.Name}}({{paramList .Params}}){{returnList .Returns}} { +{{- if .Returns}} + args := PDKMock.Called({{argList .Params}}) + return {{mockReturns .Returns}} +{{- else}} + PDKMock.Called({{argList .Params}}) +{{- end}} +} +{{- end}} diff --git a/plugins/cmd/ndpgen/internal/templates/types_stub.go.tmpl b/plugins/cmd/ndpgen/internal/templates/types_stub.go.tmpl new file mode 100644 index 000000000..06cbb4f1f --- /dev/null +++ b/plugins/cmd/ndpgen/internal/templates/types_stub.go.tmpl @@ -0,0 +1,192 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains type definitions for non-WASM builds. +// These types match the extism/go-pdk signatures to allow compilation and testing +// on native platforms without importing the WASM-only extism package. +// +//go:build !wasip1 + +package pdk + +// LogLevel represents a logging level. +type LogLevel int + +// Log level constants +const ( + LogTrace LogLevel = iota + LogDebug + LogInfo + LogWarn + LogError +) + +// HTTPMethod represents an HTTP method. +type HTTPMethod int32 + +// HTTP method constants +const ( + MethodGet HTTPMethod = iota + MethodHead + MethodPost + MethodPut + MethodPatch + MethodDelete + MethodConnect + MethodOptions + MethodTrace +) + +// String returns the string representation of the HTTP method. +func (m HTTPMethod) String() string { + switch m { + case MethodGet: + return "GET" + case MethodHead: + return "HEAD" + case MethodPost: + return "POST" + case MethodPut: + return "PUT" + case MethodPatch: + return "PATCH" + case MethodDelete: + return "DELETE" + case MethodConnect: + return "CONNECT" + case MethodOptions: + return "OPTIONS" + case MethodTrace: + return "TRACE" + default: + return "UNKNOWN" + } +} + +// Memory represents memory allocated by (and shared with) the host. +// This is a stub implementation for non-WASM platforms. +type Memory struct { + offset uint64 + length uint64 + data []byte +} + +// Offset returns the offset of the memory block. +func (m Memory) Offset() uint64 { + return m.offset +} + +// Length returns the length of the memory block. +func (m Memory) Length() uint64 { + return m.length +} + +// ReadBytes reads all bytes from the memory block. +func (m Memory) ReadBytes() []byte { + return m.data +} + +// Load reads the memory block into the provided buffer. +func (m *Memory) Load(buffer []byte) { + copy(buffer, m.data) +} + +// Store writes data to the memory block. +func (m *Memory) Store(data []byte) { + m.data = make([]byte, len(data)) + copy(m.data, data) + m.length = uint64(len(data)) +} + +// Free frees the memory block. +func (m *Memory) Free() { + m.data = nil + m.length = 0 +} + +// NewStubMemory creates a new stub Memory for testing. +// This is a helper function not present in the real PDK. +func NewStubMemory(offset, length uint64, data []byte) Memory { + return Memory{ + offset: offset, + length: length, + data: data, + } +} + +// HTTPRequest represents an HTTP request sent by the host. +// This is a stub implementation for non-WASM platforms. +type HTTPRequest struct { + method HTTPMethod + url string + headers map[string]string + body []byte +} + +// SetHeader sets an HTTP header key to value. +func (r *HTTPRequest) SetHeader(key string, value string) *HTTPRequest { + if r.headers == nil { + r.headers = make(map[string]string) + } + r.headers[key] = value + return r +} + +// SetBody sets the HTTP request body. +func (r *HTTPRequest) SetBody(body []byte) *HTTPRequest { + r.body = body + return r +} + +// Send sends the HTTP request and returns the response. +// In the stub implementation, this delegates to the mock. +func (r *HTTPRequest) Send() HTTPResponse { + args := PDKMock.Called(r) + return args.Get(0).(HTTPResponse) +} + +// HTTPRequestMeta represents the metadata associated with an HTTP request. +type HTTPRequestMeta struct { + URL string `json:"url"` + Method string `json:"method"` + Headers map[string]string `json:"headers"` +} + +// HTTPResponse represents an HTTP response returned from the host. +// This is a stub implementation for non-WASM platforms. +type HTTPResponse struct { + status uint16 + headers map[string]string + body []byte + memory Memory +} + +// Status returns the status code from the response. +func (r HTTPResponse) Status() uint16 { + return r.status +} + +// Headers returns the HTTP response headers. +func (r *HTTPResponse) Headers() map[string]string { + return r.headers +} + +// Body returns the body byte slice from the response. +func (r HTTPResponse) Body() []byte { + return r.body +} + +// Memory returns the memory associated with the response. +func (r HTTPResponse) Memory() Memory { + return r.memory +} + +// NewStubHTTPResponse creates a new stub HTTPResponse for testing. +// This is a helper function not present in the real PDK. +func NewStubHTTPResponse(status uint16, headers map[string]string, body []byte) HTTPResponse { + return HTTPResponse{ + status: status, + headers: headers, + body: body, + memory: NewStubMemory(0, uint64(len(body)), body), + } +} diff --git a/plugins/cmd/ndpgen/internal/types.go b/plugins/cmd/ndpgen/internal/types.go new file mode 100644 index 000000000..6132dfbc4 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/types.go @@ -0,0 +1,669 @@ +package internal + +import ( + "strings" + "unicode" +) + +// Service represents a parsed host service interface. +type Service struct { + Name string // Service name from annotation (e.g., "SubsonicAPI") + Permission string // Manifest permission key (e.g., "subsonicapi") + Interface string // Go interface name (e.g., "SubsonicAPIService") + Methods []Method // Methods marked with //nd:hostfunc + Doc string // Documentation comment for the service + Structs []StructDef // Structs used by this service +} + +// Capability represents a parsed capability interface for plugin exports. +type Capability struct { + Name string // Package name from annotation (e.g., "metadata") + Interface string // Go interface name (e.g., "MetadataAgent") + Required bool // If true, all methods must be implemented + Methods []Export // Methods marked with //nd:export + Doc string // Documentation comment for the capability + Structs []StructDef // Structs used by this capability + TypeAliases []TypeAlias // Type aliases used by this capability + Consts []ConstGroup // Const groups used by this capability + SourceFile string // Base name of source file without extension (e.g., "websocket_callback") +} + +// TypeAlias represents a type alias definition (e.g., type ScrobblerErrorType string). +type TypeAlias struct { + Name string // Type name + Type string // Underlying type + Doc string // Documentation comment +} + +// ConstGroup represents a group of const definitions. +type ConstGroup struct { + Type string // Type name for typed consts (empty for untyped) + Values []ConstDef // Const definitions +} + +// ConstDef represents a single const definition. +type ConstDef struct { + Name string // Const name + Value string // Const value + Doc string // Documentation comment +} + +// KnownStructs returns a map of struct names defined in this capability. +func (c Capability) KnownStructs() map[string]bool { + result := make(map[string]bool) + for _, st := range c.Structs { + result[st.Name] = true + } + return result +} + +// Export represents an exported WASM function within a capability. +type Export struct { + Name string // Go method name (e.g., "GetArtistBiography") + ExportName string // WASM export name (e.g., "nd_get_artist_biography") + Input Param // Single input parameter (the struct type) + Output Param // Single output return value (the struct type) + Doc string // Documentation comment for the method +} + +// ProviderInterfaceName returns the optional provider interface name. +// For a method "GetArtistBiography", returns "ArtistBiographyProvider". +func (e Export) ProviderInterfaceName() string { + // Remove "Get", "On", etc. prefixes and add "Provider" suffix + name := e.Name + for _, prefix := range []string{"Get", "On"} { + if strings.HasPrefix(name, prefix) { + name = name[len(prefix):] + break + } + } + return name + "Provider" +} + +// ImplVarName returns the internal implementation variable name. +// For "GetArtistBiography", returns "artistBiographyImpl". +func (e Export) ImplVarName() string { + name := e.Name + for _, prefix := range []string{"Get", "On"} { + if strings.HasPrefix(name, prefix) { + name = name[len(prefix):] + break + } + } + // Convert to camelCase + if len(name) > 0 { + name = strings.ToLower(string(name[0])) + name[1:] + } + return name + "Impl" +} + +// ExportFuncName returns the unexported WASM export function name. +// For "nd_get_artist_biography", returns "_ndGetArtistBiography". +func (e Export) ExportFuncName() string { + // Convert snake_case to PascalCase + parts := strings.Split(e.ExportName, "_") + var result strings.Builder + result.WriteString("_") + for _, part := range parts { + if len(part) > 0 { + result.WriteString(strings.ToUpper(string(part[0]))) + result.WriteString(part[1:]) + } + } + return result.String() +} + +// HasInput returns true if the method has an input parameter. +func (e Export) HasInput() bool { + return e.Input.Type != "" +} + +// HasOutput returns true if the method has a non-error return value. +func (e Export) HasOutput() bool { + return e.Output.Type != "" +} + +// IsPointerOutput returns true if the output type is a pointer. +func (e Export) IsPointerOutput() bool { + return strings.HasPrefix(e.Output.Type, "*") +} + +// StructDef represents a Go struct type definition. +type StructDef struct { + Name string // Go struct name (e.g., "Library") + Fields []FieldDef // Struct fields + Doc string // Documentation comment +} + +// FieldDef represents a field within a struct. +type FieldDef struct { + Name string // Go field name (e.g., "TotalSongs") + Type string // Go type (e.g., "int32", "*string", "[]User") + JSONTag string // JSON tag value (e.g., "totalSongs,omitempty") + OmitEmpty bool // Whether the field has omitempty tag + Doc string // Field documentation +} + +// OutputFileName returns the generated file name for this service. +func (s Service) OutputFileName() string { + return strings.ToLower(s.Name) + "_gen.go" +} + +// ExportPrefix returns the prefix for exported host function names. +func (s Service) ExportPrefix() string { + return strings.ToLower(s.Name) +} + +// KnownStructs returns a map of struct names defined in this service. +func (s Service) KnownStructs() map[string]bool { + result := make(map[string]bool) + for _, st := range s.Structs { + result[st.Name] = true + } + return result +} + +// HasErrors returns true if any method in the service returns an error. +func (s Service) HasErrors() bool { + for _, m := range s.Methods { + if m.HasError { + return true + } + } + return false +} + +// Method represents a host function method within a service. +type Method struct { + Name string // Go method name (e.g., "Call") + ExportName string // Optional override for export name + Params []Param // Method parameters (excluding context.Context) + Returns []Param // Return values (excluding error) + HasError bool // Whether the method returns an error + Doc string // Documentation comment for the method +} + +// FunctionName returns the Extism host function export name. +func (m Method) FunctionName(servicePrefix string) string { + if m.ExportName != "" { + return m.ExportName + } + return servicePrefix + "_" + strings.ToLower(m.Name) +} + +// RequestTypeName returns the generated request type name (public, for host-side code). +func (m Method) RequestTypeName(serviceName string) string { + return serviceName + m.Name + "Request" +} + +// ResponseTypeName returns the generated response type name (public, for host-side code). +func (m Method) ResponseTypeName(serviceName string) string { + return serviceName + m.Name + "Response" +} + +// ClientRequestTypeName returns the generated request type name (private, for client/PDK code). +func (m Method) ClientRequestTypeName(serviceName string) string { + return lowerFirst(serviceName) + m.Name + "Request" +} + +// ClientResponseTypeName returns the generated response type name (private, for client/PDK code). +func (m Method) ClientResponseTypeName(serviceName string) string { + return lowerFirst(serviceName) + m.Name + "Response" +} + +// lowerFirst returns the string with the first letter lowercased. +func lowerFirst(s string) string { + if s == "" { + return s + } + r := []rune(s) + r[0] = unicode.ToLower(r[0]) + return string(r) +} + +// HasParams returns true if the method has input parameters. +func (m Method) HasParams() bool { + return len(m.Params) > 0 +} + +// HasReturns returns true if the method has return values (excluding error). +func (m Method) HasReturns() bool { + return len(m.Returns) > 0 +} + +// IsErrorOnly returns true if the method only returns an error (no data fields). +func (m Method) IsErrorOnly() bool { + return m.HasError && !m.HasReturns() +} + +// IsSingleReturn returns true if the method has exactly one return value (excluding error). +func (m Method) IsSingleReturn() bool { + return len(m.Returns) == 1 +} + +// IsMultiReturn returns true if the method has multiple return values (excluding error). +func (m Method) IsMultiReturn() bool { + return len(m.Returns) > 1 +} + +// IsOptionPattern returns true if the method returns (value, bool) where the bool +// indicates existence (named "exists", "ok", or "found"). This pattern is used to +// generate Option in Rust instead of a tuple. +func (m Method) IsOptionPattern() bool { + if len(m.Returns) != 2 { + return false + } + if m.Returns[1].Type != "bool" { + return false + } + // Only treat as option pattern if the first return has a meaningful value type + // (not just a bool check like Has()) + if m.Returns[0].Type == "bool" { + return false + } + name := strings.ToLower(m.Returns[1].Name) + return name == "exists" || name == "ok" || name == "found" +} + +// ReturnSignature returns the Go return type signature for the wrapper function. +// For error-only: "error" +// For single return with error: "(Type, error)" +// For single return no error: "Type" +// For multi return: "(Type1, Type2, ..., error)" +func (m Method) ReturnSignature() string { + if m.IsErrorOnly() { + return "error" + } + var parts []string + for _, r := range m.Returns { + parts = append(parts, r.Type) + } + if m.HasError { + parts = append(parts, "error") + } + // Single return without error doesn't need parentheses + if len(parts) == 1 { + return parts[0] + } + return "(" + strings.Join(parts, ", ") + ")" +} + +// ZeroValues returns the zero value expressions for all return types (excluding error). +// Used for error return statements like "return "", false, err". +func (m Method) ZeroValues() string { + var zeros []string + for _, r := range m.Returns { + zeros = append(zeros, zeroValue(r.Type)) + } + return strings.Join(zeros, ", ") +} + +// zeroValue returns the zero value for a Go type. +func zeroValue(typ string) string { + switch { + case typ == "string": + return `""` + case typ == "bool": + return "false" + case typ == "int", typ == "int8", typ == "int16", typ == "int32", typ == "int64", + typ == "uint", typ == "uint8", typ == "uint16", typ == "uint32", typ == "uint64", + typ == "float32", typ == "float64": + return "0" + case typ == "[]byte": + return "nil" + case strings.HasPrefix(typ, "[]"): + return "nil" + case strings.HasPrefix(typ, "map["): + return "nil" + case strings.HasPrefix(typ, "*"): + return "nil" + case typ == "any", typ == "interface{}": + return "nil" + default: + // For custom struct types, return empty struct + return typ + "{}" + } +} + +// Param represents a method parameter or return value. +type Param struct { + Name string // Parameter name + Type string // Go type (e.g., "string", "int32", "[]byte") + JSONName string // JSON field name (camelCase) +} + +// IsByteSlice returns true if the parameter type is []byte. +func (p Param) IsByteSlice() bool { + return p.Type == "[]byte" +} + +// IsByteSlice returns true if the field type is []byte. +func (f FieldDef) IsByteSlice() bool { + return f.Type == "[]byte" +} + +// HasByteFields returns true if any method params, returns, or struct fields use []byte. +func (s Service) HasByteFields() bool { + for _, m := range s.Methods { + for _, p := range m.Params { + if p.IsByteSlice() { + return true + } + } + for _, r := range m.Returns { + if r.IsByteSlice() { + return true + } + } + } + for _, st := range s.Structs { + for _, f := range st.Fields { + if f.IsByteSlice() { + return true + } + } + } + return false +} + +// HasByteFields returns true if any capability struct fields use []byte. +func (c Capability) HasByteFields() bool { + for _, st := range c.Structs { + for _, f := range st.Fields { + if f.IsByteSlice() { + return true + } + } + } + return false +} + +// NewParam creates a Param with auto-generated JSON name. +func NewParam(name, typ string) Param { + return Param{ + Name: name, + Type: typ, + JSONName: toJSONName(name), + } +} + +// toJSONName converts a Go identifier to camelCase JSON field name. +// This matches Rust serde's rename_all = "camelCase" behavior. +// Examples: "ConnectionID" -> "connectionId", "NewConnectionID" -> "newConnectionId" +func toJSONName(name string) string { + if name == "" { + return "" + } + + runes := []rune(name) + result := make([]rune, 0, len(runes)) + + for i, r := range runes { + if i == 0 { + // First character is always lowercase + result = append(result, unicode.ToLower(r)) + } else if unicode.IsUpper(r) { + // Check if this is part of an acronym (consecutive uppercase) + // or a word boundary + prevIsUpper := unicode.IsUpper(runes[i-1]) + nextIsLower := i+1 < len(runes) && unicode.IsLower(runes[i+1]) + + if prevIsUpper && !nextIsLower { + // Middle of an acronym - lowercase it + result = append(result, unicode.ToLower(r)) + } else if prevIsUpper && nextIsLower { + // End of acronym followed by lowercase - this starts a new word + // Keep uppercase + result = append(result, r) + } else { + // Regular word boundary - keep uppercase + result = append(result, r) + } + } else { + result = append(result, r) + } + } + + return string(result) +} + +// ToPythonType converts a Go type to its Python equivalent. +func ToPythonType(goType string) string { + switch goType { + case "string": + return "str" + case "int", "int32", "int64": + return "int" + case "float32", "float64": + return "float" + case "bool": + return "bool" + case "[]byte": + return "bytes" + default: + return "Any" + } +} + +// ToSnakeCase converts a PascalCase or camelCase string to snake_case. +// It handles consecutive uppercase letters correctly (e.g., "ScheduleID" -> "schedule_id"). +func ToSnakeCase(s string) string { + var result strings.Builder + runes := []rune(s) + for i, r := range runes { + if i > 0 && r >= 'A' && r <= 'Z' { + // Add underscore before uppercase, but not if: + // - Previous char was uppercase AND next char is uppercase or end of string + // (this handles acronyms like "ID" in "NewScheduleID") + prevUpper := runes[i-1] >= 'A' && runes[i-1] <= 'Z' + nextUpper := i+1 < len(runes) && runes[i+1] >= 'A' && runes[i+1] <= 'Z' + atEnd := i+1 == len(runes) + + // Only skip underscore if we're in the middle of an acronym + if !prevUpper || (!nextUpper && !atEnd) { + result.WriteByte('_') + } + } + result.WriteRune(r) + } + return strings.ToLower(result.String()) +} + +// PythonFunctionName returns the Python function name for a method. +func (m Method) PythonFunctionName(servicePrefix string) string { + return ToSnakeCase(servicePrefix + m.Name) +} + +// PythonResultTypeName returns the Python dataclass name for multi-value returns. +func (m Method) PythonResultTypeName(serviceName string) string { + return serviceName + m.Name + "Result" +} + +// NeedsResultClass returns true if the method needs a dataclass for returns. +func (m Method) NeedsResultClass() bool { + return len(m.Returns) > 1 +} + +// PythonType returns the Python type for this parameter. +func (p Param) PythonType() string { + return ToPythonType(p.Type) +} + +// PythonName returns the snake_case Python name for this parameter. +func (p Param) PythonName() string { + return ToSnakeCase(p.Name) +} + +// ToRustType converts a Go type to its Rust equivalent. +func ToRustType(goType string) string { + return ToRustTypeWithStructs(goType, nil) +} + +// RustParamType returns the Rust type for a function parameter (uses &str for strings). +func RustParamType(goType string) string { + if goType == "string" { + return "&str" + } + return ToRustType(goType) +} + +// RustDefaultValue returns the default value for a Rust type. +func RustDefaultValue(goType string) string { + switch goType { + case "string": + return `String::new()` + case "int", "int32", "int64", "uint", "uint32", "uint64": + return "0" + case "float32", "float64": + return "0.0" + case "bool": + return "false" + default: + if strings.HasPrefix(goType, "[]") { + return "Vec::new()" + } + if strings.HasPrefix(goType, "map[") { + return "std::collections::HashMap::new()" + } + if strings.HasPrefix(goType, "*") { + return "None" + } + return "serde_json::Value::Null" + } +} + +// RustFunctionName returns the Rust function name for a method (snake_case). +// Uses just the method name without service prefix since the module provides namespacing. +func (m Method) RustFunctionName(_ string) string { + return ToSnakeCase(m.Name) +} + +// RustDocComment returns a properly formatted Rust doc comment. +// Each line of the input doc string is prefixed with "/// ". +func RustDocComment(doc string) string { + if doc == "" { + return "" + } + lines := strings.Split(doc, "\n") + var result []string + for _, line := range lines { + result = append(result, "/// "+line) + } + return strings.Join(result, "\n") +} + +// RustType returns the Rust type for this parameter. +func (p Param) RustType() string { + return ToRustType(p.Type) +} + +// RustTypeWithStructs returns the Rust type using known struct names. +func (p Param) RustTypeWithStructs(knownStructs map[string]bool) string { + return ToRustTypeWithStructs(p.Type, knownStructs) +} + +// RustParamType returns the Rust type for this parameter when used as a function argument. +func (p Param) RustParamType() string { + return RustParamType(p.Type) +} + +// RustParamTypeWithStructs returns the Rust param type using known struct names. +func (p Param) RustParamTypeWithStructs(knownStructs map[string]bool) string { + if p.Type == "string" { + return "&str" + } + return ToRustTypeWithStructs(p.Type, knownStructs) +} + +// RustName returns the snake_case Rust name for this parameter. +func (p Param) RustName() string { + return ToSnakeCase(p.Name) +} + +// NeedsToOwned returns true if the parameter needs .to_owned() when used. +func (p Param) NeedsToOwned() bool { + return p.Type == "string" +} + +// RustType returns the Rust type for this field, using known struct names. +func (f FieldDef) RustType(knownStructs map[string]bool) string { + return ToRustTypeWithStructs(f.Type, knownStructs) +} + +// RustName returns the snake_case Rust name for this field. +func (f FieldDef) RustName() string { + return ToSnakeCase(f.Name) +} + +// NeedsDefault returns true if the field needs #[serde(default)] attribute. +// This is true for fields with omitempty tag. +func (f FieldDef) NeedsDefault() bool { + return f.OmitEmpty +} + +// ToRustTypeWithStructs converts a Go type to its Rust equivalent, +// using known struct names instead of serde_json::Value. +func ToRustTypeWithStructs(goType string, knownStructs map[string]bool) string { + // Handle pointer types + if strings.HasPrefix(goType, "*") { + inner := ToRustTypeWithStructs(goType[1:], knownStructs) + return "Option<" + inner + ">" + } + // Handle slice types + if strings.HasPrefix(goType, "[]") { + if goType == "[]byte" { + return "Vec" + } + inner := ToRustTypeWithStructs(goType[2:], knownStructs) + return "Vec<" + inner + ">" + } + // Handle map types + if strings.HasPrefix(goType, "map[") { + // Extract key and value types from map[K]V + rest := goType[4:] // Remove "map[" + depth := 1 + keyEnd := 0 + for i, r := range rest { + if r == '[' { + depth++ + } else if r == ']' { + depth-- + if depth == 0 { + keyEnd = i + break + } + } + } + keyType := rest[:keyEnd] + valueType := rest[keyEnd+1:] + return "std::collections::HashMap<" + ToRustTypeWithStructs(keyType, knownStructs) + ", " + ToRustTypeWithStructs(valueType, knownStructs) + ">" + } + + switch goType { + case "string": + return "String" + case "int", "int32": + return "i32" + case "int64": + return "i64" + case "uint", "uint32": + return "u32" + case "uint64": + return "u64" + case "float32": + return "f32" + case "float64": + return "f64" + case "bool": + return "bool" + case "interface{}", "any": + return "serde_json::Value" + default: + // Check if this is a known struct type + if knownStructs != nil && knownStructs[goType] { + return goType + } + // For unknown custom types, fall back to Value + return "serde_json::Value" + } +} diff --git a/plugins/cmd/ndpgen/internal/xtp_schema.go b/plugins/cmd/ndpgen/internal/xtp_schema.go new file mode 100644 index 000000000..cc2a7d0e0 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/xtp_schema.go @@ -0,0 +1,339 @@ +package internal + +import ( + "sort" + "strings" + + "gopkg.in/yaml.v3" +) + +// XTP Schema types for YAML marshalling +type ( + xtpSchema struct { + Version string `yaml:"version"` + Exports yaml.Node `yaml:"exports,omitempty"` + Components *xtpComponents `yaml:"components,omitempty"` + } + + xtpComponents struct { + Schemas yaml.Node `yaml:"schemas"` + } + + xtpExport struct { + Description string `yaml:"description,omitempty"` + Input *xtpIOParam `yaml:"input,omitempty"` + Output *xtpIOParam `yaml:"output,omitempty"` + } + + xtpIOParam struct { + Ref string `yaml:"$ref,omitempty"` + Type string `yaml:"type,omitempty"` + ContentType string `yaml:"contentType"` + } + + // xtpObjectSchema represents an object schema in XTP. + // Per the XTP JSON Schema, ObjectSchema has properties, required, and description + // but NOT a type field. + xtpObjectSchema struct { + Description string `yaml:"description,omitempty"` + Properties yaml.Node `yaml:"properties"` + Required []string `yaml:"required,omitempty"` + } + + xtpEnumSchema struct { + Description string `yaml:"description,omitempty"` + Type string `yaml:"type"` + Enum []string `yaml:"enum"` + } + + xtpProperty struct { + Ref string `yaml:"$ref,omitempty"` + Type string `yaml:"type,omitempty"` + Format string `yaml:"format,omitempty"` + Description string `yaml:"description,omitempty"` + Nullable bool `yaml:"nullable,omitempty"` + Items *xtpProperty `yaml:"items,omitempty"` + } +) + +// GenerateSchema generates an XTP YAML schema from a capability. +func GenerateSchema(cap Capability) ([]byte, error) { + schema := xtpSchema{Version: "v1-draft"} + + // Build exports as ordered map + if len(cap.Methods) > 0 { + schema.Exports = yaml.Node{Kind: yaml.MappingNode} + for _, export := range cap.Methods { + addToMap(&schema.Exports, export.ExportName, buildExport(export)) + } + } + + // Build components/schemas + schemas := buildSchemas(cap) + if len(schemas.Content) > 0 { + schema.Components = &xtpComponents{Schemas: schemas} + } + + return yaml.Marshal(schema) +} + +func buildExport(export Export) xtpExport { + e := xtpExport{Description: cleanDocForYAML(export.Doc)} + if export.Input.Type != "" { + e.Input = &xtpIOParam{ + Ref: "#/components/schemas/" + strings.TrimPrefix(export.Input.Type, "*"), + ContentType: "application/json", + } + } + if export.Output.Type != "" { + outputType := strings.TrimPrefix(export.Output.Type, "*") + // Check if output is a primitive type + if isPrimitiveGoType(outputType) { + e.Output = &xtpIOParam{ + Type: goTypeToXTPType(outputType), + ContentType: "application/json", + } + } else { + e.Output = &xtpIOParam{ + Ref: "#/components/schemas/" + outputType, + ContentType: "application/json", + } + } + } + return e +} + +// isPrimitiveGoType returns true if the Go type is a primitive type. +func isPrimitiveGoType(goType string) bool { + switch goType { + case "bool", "string", "int", "int32", "int64", "uint", "uint32", "uint64", "float32", "float64", "[]byte": + return true + } + return false +} + +func buildSchemas(cap Capability) yaml.Node { + schemas := yaml.Node{Kind: yaml.MappingNode} + knownTypes := cap.KnownStructs() + for _, alias := range cap.TypeAliases { + knownTypes[alias.Name] = true + } + + // Collect types that are actually used by exports + usedTypes := collectUsedTypes(cap, knownTypes) + + // Sort structs by name for consistent output + structNames := make([]string, 0, len(cap.Structs)) + structMap := make(map[string]StructDef) + for _, st := range cap.Structs { + if usedTypes[st.Name] { + structNames = append(structNames, st.Name) + structMap[st.Name] = st + } + } + sort.Strings(structNames) + + for _, name := range structNames { + st := structMap[name] + addToMap(&schemas, name, buildObjectSchema(st, knownTypes)) + } + + // Build enum types from type aliases (only if used by exports) + for _, alias := range cap.TypeAliases { + if !usedTypes[alias.Name] { + continue + } + if alias.Type == "string" { + for _, cg := range cap.Consts { + if cg.Type == alias.Name { + addToMap(&schemas, alias.Name, buildEnumSchema(alias, cg)) + break + } + } + } + } + + return schemas +} + +// collectUsedTypes returns a set of type names that are reachable from exports. +func collectUsedTypes(cap Capability, knownTypes map[string]bool) map[string]bool { + used := make(map[string]bool) + + // Start with types directly referenced by exports + for _, export := range cap.Methods { + if export.Input.Type != "" { + addTypeAndDeps(strings.TrimPrefix(export.Input.Type, "*"), cap, knownTypes, used) + } + if export.Output.Type != "" { + outputType := strings.TrimPrefix(export.Output.Type, "*") + if !isPrimitiveGoType(outputType) { + addTypeAndDeps(outputType, cap, knownTypes, used) + } + } + } + + return used +} + +// addTypeAndDeps adds a type and all its dependencies to the used set. +func addTypeAndDeps(typeName string, cap Capability, knownTypes map[string]bool, used map[string]bool) { + if used[typeName] || !knownTypes[typeName] { + return + } + used[typeName] = true + + // Find the struct and add its field types + for _, st := range cap.Structs { + if st.Name == typeName { + for _, field := range st.Fields { + fieldType := strings.TrimPrefix(field.Type, "*") + fieldType = strings.TrimPrefix(fieldType, "[]") + if knownTypes[fieldType] { + addTypeAndDeps(fieldType, cap, knownTypes, used) + } + } + return + } + } +} + +func buildObjectSchema(st StructDef, knownTypes map[string]bool) xtpObjectSchema { + schema := xtpObjectSchema{ + Description: cleanDocForYAML(st.Doc), + Properties: yaml.Node{Kind: yaml.MappingNode}, + } + + for _, field := range st.Fields { + propName := getJSONFieldName(field) + addToMap(&schema.Properties, propName, buildProperty(field, knownTypes)) + + if !strings.HasPrefix(field.Type, "*") && !field.OmitEmpty { + schema.Required = append(schema.Required, propName) + } + } + + return schema +} + +func buildEnumSchema(alias TypeAlias, cg ConstGroup) xtpEnumSchema { + values := make([]string, 0, len(cg.Values)) + for _, cv := range cg.Values { + values = append(values, strings.Trim(cv.Value, `"`)) + } + return xtpEnumSchema{ + Description: cleanDocForYAML(alias.Doc), + Type: "string", + Enum: values, + } +} + +func buildProperty(field FieldDef, knownTypes map[string]bool) xtpProperty { + goType := field.Type + isPointer := strings.HasPrefix(goType, "*") + if isPointer { + goType = goType[1:] + } + + prop := xtpProperty{ + Description: cleanDocForYAML(field.Doc), + Nullable: isPointer, + } + + // Handle reference types (use $ref instead of type) + if isKnownType(goType, knownTypes) && !strings.HasPrefix(goType, "[]") { + prop.Ref = "#/components/schemas/" + goType + return prop + } + + // Handle primitive types (including []byte which maps to string/byte, not array) + if isPrimitiveGoType(goType) { + prop.Type, prop.Format = goTypeToXTPTypeAndFormat(goType) + return prop + } + + // Handle slice types + if strings.HasPrefix(goType, "[]") { + elemType := goType[2:] + prop.Type = "array" + prop.Items = &xtpProperty{} + if isKnownType(elemType, knownTypes) { + prop.Items.Ref = "#/components/schemas/" + elemType + } else { + prop.Items.Type = goTypeToXTPType(elemType) + } + return prop + } + + // Handle remaining types + prop.Type, prop.Format = goTypeToXTPTypeAndFormat(goType) + return prop +} + +// addToMap adds a key-value pair to a yaml.Node map, preserving insertion order. +func addToMap[T any](node *yaml.Node, key string, value T) { + var valNode yaml.Node + _ = valNode.Encode(value) + node.Content = append(node.Content, &yaml.Node{Kind: yaml.ScalarNode, Value: key}, &valNode) +} + +func getJSONFieldName(field FieldDef) string { + propName := field.JSONTag + if idx := strings.Index(propName, ","); idx >= 0 { + propName = propName[:idx] + } + if propName == "" { + propName = field.Name + } + return propName +} + +// isKnownType checks if a type is a known struct or type alias. +func isKnownType(typeName string, knownTypes map[string]bool) bool { + return knownTypes[typeName] +} + +// goTypeToXTPType converts a Go type to an XTP schema type. +func goTypeToXTPType(goType string) string { + typ, _ := goTypeToXTPTypeAndFormat(goType) + return typ +} + +// goTypeToXTPTypeAndFormat converts a Go type to XTP type and format. +func goTypeToXTPTypeAndFormat(goType string) (typ, format string) { + switch goType { + case "string": + return "string", "" + case "int", "int32": + return "integer", "int32" + case "int64": + return "integer", "int64" + case "uint", "uint32": + // XTP schema doesn't support unsigned formats; use int64 to hold full uint32 range + return "integer", "int64" + case "uint64": + // XTP schema doesn't support unsigned formats; use int64 (may lose precision for large values) + return "integer", "int64" + case "float32": + return "number", "float" + case "float64": + return "number", "float" + case "bool": + return "boolean", "" + case "[]byte": + return "string", "byte" + default: + return "object", "" + } +} + +// cleanDocForYAML cleans documentation for YAML output. +func cleanDocForYAML(doc string) string { + doc = strings.TrimSpace(doc) + // Remove leading "// " from each line if present + lines := strings.Split(doc, "\n") + for i, line := range lines { + lines[i] = strings.TrimPrefix(strings.TrimSpace(line), "// ") + } + return strings.TrimSpace(strings.Join(lines, "\n")) +} diff --git a/plugins/cmd/ndpgen/internal/xtp_schema.json b/plugins/cmd/ndpgen/internal/xtp_schema.json new file mode 100644 index 000000000..8b3fbe0b9 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/xtp_schema.json @@ -0,0 +1,549 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "type": "object", + "properties": { + "version": { + "$ref": "#/$defs/XtpVersion" + } + }, + "required": [ + "version" + ], + "allOf": [ + { + "if": { + "properties": { + "version": { + "const": "v0" + } + } + }, + "then": { + "properties": { + "exports": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[a-zA-Z_$][a-zA-Z0-9_$]*$" + } + }, + "version": { + "const": "v0" + } + }, + "required": [ + "exports" + ], + "additionalProperties": false + } + }, + { + "if": { + "properties": { + "version": { + "const": "v1-draft" + } + } + }, + "then": { + "properties": { + "version": { + "$ref": "#/$defs/XtpVersion" + }, + "exports": { + "type": "object", + "patternProperties": { + "^[a-zA-Z_$][a-zA-Z0-9_$]*$": { + "$ref": "#/$defs/Export" + } + }, + "additionalProperties": false + }, + "imports": { + "type": "object", + "patternProperties": { + "^[a-zA-Z_$][a-zA-Z0-9_$]*$": { + "$ref": "#/$defs/Import" + } + }, + "additionalProperties": false + }, + "components": { + "type": "object", + "properties": { + "schemas": { + "type": "object", + "patternProperties": { + "^[a-zA-Z_$][a-zA-Z0-9_$]*$": { + "$ref": "#/$defs/Schema" + } + }, + "additionalProperties": false + } + }, + "required": [ + "schemas" + ], + "additionalProperties": false + } + }, + "required": [ + "exports" + ], + "additionalProperties": false + } + } + ], + "$defs": { + "XtpVersion": { + "type": "string", + "enum": [ + "v0", + "v1-draft" + ] + }, + "Export": { + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "codeSamples": { + "type": "array", + "items": { + "$ref": "#/$defs/CodeSample" + } + }, + "input": { + "$ref": "#/$defs/Parameter" + }, + "output": { + "$ref": "#/$defs/Parameter" + } + }, + "additionalProperties": false + }, + "CodeSample": { + "type": "object", + "properties": { + "lang": { + "anyOf": [ + { + "type": "string", + "enum": [ + "typescript", + "csharp", + "zig", + "rust", + "go", + "python", + "c++" + ] + }, + { + "type": "string" + } + ] + }, + "source": { + "type": "string" + }, + "label": { + "type": "string" + } + }, + "required": [ + "lang", + "source" + ], + "additionalProperties": false + }, + "Import": { + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "input": { + "$ref": "#/$defs/Parameter" + }, + "output": { + "$ref": "#/$defs/Parameter" + } + }, + "additionalProperties": false + }, + "Schema": { + "oneOf": [ + { + "$ref": "#/$defs/ObjectSchema" + }, + { + "$ref": "#/$defs/EnumSchema" + } + ] + }, + "ObjectSchema": { + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "properties": { + "type": "object", + "patternProperties": { + "^[a-zA-Z_$][a-zA-Z0-9_$]*$": { + "$ref": "#/$defs/Property" + } + }, + "additionalProperties": false + }, + "required": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "properties" + ], + "additionalProperties": false + }, + "EnumSchema": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "string" + ] + }, + "description": { + "type": "string" + }, + "enum": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[a-zA-Z_$][a-zA-Z0-9_$]*$" + } + } + }, + "required": [ + "enum" + ], + "additionalProperties": false + }, + "Parameter": { + "oneOf": [ + { + "$ref": "#/$defs/ValueParameter" + }, + { + "$ref": "#/$defs/RefParameter" + }, + { + "$ref": "#/$defs/MapParameter" + } + ] + }, + "RefParameter": { + "type": "object", + "properties": { + "$ref": { + "$ref": "#/$defs/SchemaReference" + }, + "description": { + "type": "string" + }, + "nullable": { + "type": "boolean", + "default": false + }, + "contentType": { + "$ref": "#/$defs/ContentType" + } + }, + "required": [ + "$ref", + "contentType" + ], + "additionalProperties": false + }, + "ValueParameter": { + "type": "object", + "properties": { + "contentType": { + "$ref": "#/$defs/ContentType" + }, + "type": { + "$ref": "#/$defs/XtpType" + }, + "format": { + "$ref": "#/$defs/XtpFormat" + }, + "nullable": { + "type": "boolean", + "default": false + }, + "description": { + "type": "string" + }, + "items": { + "type": "object", + "$ref": "#/$defs/ArrayItem" + } + }, + "required": [ + "type", + "contentType" + ], + "additionalProperties": false + }, + "MapParameter": { + "type": "object", + "properties": { + "type": { + "const": "object" + }, + "description": { + "type": "string" + }, + "additionalProperties": { + "allOf": [ + { + "$ref": "#/$defs/NonMapProperty" + }, + { + "type": "object", + "properties": { + "description": false + }, + "additionalProperties": false + } + ] + }, + "nullable": { + "type": "boolean", + "default": false + }, + "contentType": { + "$ref": "#/$defs/ContentType" + } + }, + "required": [ + "additionalProperties", + "contentType" + ] + }, + "NonMapProperty": { + "oneOf": [ + { + "$ref": "#/$defs/ValueProperty" + }, + { + "$ref": "#/$defs/RefProperty" + } + ] + }, + "Property": { + "oneOf": [ + { + "$ref": "#/$defs/ValueProperty" + }, + { + "$ref": "#/$defs/RefProperty" + }, + { + "$ref": "#/$defs/MapProperty" + } + ] + }, + "ValueProperty": { + "type": "object", + "properties": { + "type": { + "$ref": "#/$defs/XtpType" + }, + "format": { + "$ref": "#/$defs/XtpFormat" + }, + "nullable": { + "type": "boolean", + "default": false + }, + "description": { + "type": "string" + }, + "items": { + "type": "object", + "$ref": "#/$defs/ArrayItem" + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + "MapProperty": { + "type": "object", + "properties": { + "type": { + "const": "object" + }, + "description": { + "type": "string" + }, + "additionalProperties": { + "allOf": [ + { + "$ref": "#/$defs/NonMapProperty" + }, + { + "not": { + "type": "object", + "required": ["description"] + } + } + ] + }, + "nullable": { + "type": "boolean", + "default": false + } + }, + "required": [ + "additionalProperties" + ], + "additionalProperties": false + }, + "RefProperty": { + "type": "object", + "properties": { + "$ref": { + "$ref": "#/$defs/SchemaReference" + }, + "description": { + "type": "string" + }, + "nullable": { + "type": "boolean", + "default": false + } + }, + "required": [ + "$ref" + ], + "additionalProperties": false + }, + "ContentType": { + "type": "string", + "enum": [ + "application/json", + "application/x-binary", + "text/plain; charset=utf-8" + ] + }, + "SchemaReference": { + "type": "string", + "pattern": "^#/components/schemas/[^/]+$" + }, + "XtpType": { + "type": "string", + "enum": [ + "integer", + "string", + "number", + "boolean", + "object", + "array", + "buffer" + ] + }, + "XtpFormat": { + "type": "string", + "enum": [ + "int32", + "int64", + "float", + "double", + "date-time", + "byte" + ] + }, + "ArrayItem": { + "type": "object", + "oneOf": [ + { + "$ref": "#/$defs/ValueArrayItem" + }, + { + "$ref": "#/$defs/RefArrayItem" + }, + { + "$ref": "#/$defs/MapArrayItem" + } + ] + }, + "ValueArrayItem": { + "type": "object", + "properties": { + "type": { + "$ref": "#/$defs/XtpType" + }, + "format": { + "$ref": "#/$defs/XtpFormat" + }, + "nullable": { + "type": "boolean" + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + "RefArrayItem": { + "type": "object", + "properties": { + "$ref": { + "$ref": "#/$defs/SchemaReference" + }, + "nullable": { + "type": "boolean", + "default": false + } + }, + "required": [ + "$ref" + ], + "additionalProperties": false + }, + "MapArrayItem": { + "type": "object", + "properties": { + "type": { + "const": "object" + }, + "additionalProperties": { + "allOf": [ + { + "$ref": "#/$defs/NonMapProperty" + }, + { + "not": { + "type": "object", + "required": ["description"] + } + } + ] + } + }, + "required": [ + "additionalProperties" + ], + "additionalProperties": false + } + } +} diff --git a/plugins/cmd/ndpgen/internal/xtp_schema_test.go b/plugins/cmd/ndpgen/internal/xtp_schema_test.go new file mode 100644 index 000000000..2e28a75d8 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/xtp_schema_test.go @@ -0,0 +1,761 @@ +package internal + +import ( + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + "gopkg.in/yaml.v3" +) + +var _ = Describe("XTP Schema Generation", func() { + parseSchema := func(schema []byte) map[string]any { + var doc map[string]any + Expect(yaml.Unmarshal(schema, &doc)).To(Succeed()) + return doc + } + + Describe("GenerateSchema", func() { + Context("basic capability with one export", func() { + var schema []byte + + BeforeEach(func() { + capability := Capability{ + Name: "test", + Doc: "Test capability", + SourceFile: "test", + Methods: []Export{ + { + ExportName: "test_method", + Doc: "Test method does something", + Input: NewParam("input", "TestInput"), + Output: NewParam("output", "TestOutput"), + }, + }, + Structs: []StructDef{ + { + Name: "TestInput", + Doc: "Input for test", + Fields: []FieldDef{ + {Name: "Name", Type: "string", JSONTag: "name", Doc: "The name"}, + {Name: "Count", Type: "int", JSONTag: "count", Doc: "The count"}, + }, + }, + { + Name: "TestOutput", + Doc: "Output for test", + Fields: []FieldDef{ + {Name: "Result", Type: "string", JSONTag: "result", Doc: "The result"}, + }, + }, + }, + } + var err error + schema, err = GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + Expect(schema).NotTo(BeEmpty()) + }) + + It("should validate against XTP JSONSchema", func() { + Expect(ValidateXTPSchema(schema)).To(Succeed()) + }) + + It("should have correct version", func() { + doc := parseSchema(schema) + Expect(doc["version"]).To(Equal("v1-draft")) + }) + + It("should include exports with description", func() { + doc := parseSchema(schema) + exports := doc["exports"].(map[string]any) + Expect(exports).To(HaveKey("test_method")) + method := exports["test_method"].(map[string]any) + Expect(method["description"]).To(Equal("Test method does something")) + }) + + It("should include schemas for input and output types", func() { + doc := parseSchema(schema) + components := doc["components"].(map[string]any) + schemas := components["schemas"].(map[string]any) + Expect(schemas).To(HaveKey("TestInput")) + Expect(schemas).To(HaveKey("TestOutput")) + }) + + It("should define input schema with correct properties", func() { + doc := parseSchema(schema) + components := doc["components"].(map[string]any) + schemas := components["schemas"].(map[string]any) + input := schemas["TestInput"].(map[string]any) + // Per XTP spec, ObjectSchema does NOT have a type field - only properties, required, description + Expect(input).NotTo(HaveKey("type")) + props := input["properties"].(map[string]any) + Expect(props).To(HaveKey("name")) + Expect(props).To(HaveKey("count")) + }) + + It("should mark non-pointer, non-omitempty fields as required", func() { + doc := parseSchema(schema) + components := doc["components"].(map[string]any) + schemas := components["schemas"].(map[string]any) + input := schemas["TestInput"].(map[string]any) + required := input["required"].([]any) + Expect(required).To(ContainElement("name")) + Expect(required).To(ContainElement("count")) + }) + }) + + Context("capability with pointer fields (nullable)", func() { + var schema []byte + + BeforeEach(func() { + capability := Capability{ + Name: "nullable_test", + SourceFile: "nullable_test", + Methods: []Export{ + {ExportName: "test", Input: NewParam("input", "Input"), Output: NewParam("output", "Output")}, + }, + Structs: []StructDef{ + { + Name: "Input", + Fields: []FieldDef{ + {Name: "Required", Type: "string", JSONTag: "required"}, + {Name: "Optional", Type: "*string", JSONTag: "optional,omitempty", OmitEmpty: true}, + }, + }, + { + Name: "Output", + Fields: []FieldDef{ + {Name: "Value", Type: "string", JSONTag: "value"}, + }, + }, + }, + } + var err error + schema, err = GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + }) + + It("should validate against XTP JSONSchema", func() { + Expect(ValidateXTPSchema(schema)).To(Succeed()) + }) + + It("should not mark required field as nullable", func() { + doc := parseSchema(schema) + components := doc["components"].(map[string]any) + schemas := components["schemas"].(map[string]any) + input := schemas["Input"].(map[string]any) + props := input["properties"].(map[string]any) + requiredField := props["required"].(map[string]any) + Expect(requiredField).NotTo(HaveKey("nullable")) + }) + + It("should mark optional pointer field as nullable", func() { + doc := parseSchema(schema) + components := doc["components"].(map[string]any) + schemas := components["schemas"].(map[string]any) + input := schemas["Input"].(map[string]any) + props := input["properties"].(map[string]any) + optionalField := props["optional"].(map[string]any) + Expect(optionalField["nullable"]).To(BeTrue()) + }) + + It("should only include non-pointer fields in required array", func() { + doc := parseSchema(schema) + components := doc["components"].(map[string]any) + schemas := components["schemas"].(map[string]any) + input := schemas["Input"].(map[string]any) + required := input["required"].([]any) + Expect(required).To(ContainElement("required")) + Expect(required).NotTo(ContainElement("optional")) + }) + }) + + Context("capability with enum", func() { + var schema []byte + + BeforeEach(func() { + capability := Capability{ + Name: "enum_test", + SourceFile: "enum_test", + Methods: []Export{ + {ExportName: "test", Input: NewParam("input", "Input"), Output: NewParam("output", "Output")}, + }, + Structs: []StructDef{ + { + Name: "Input", + Fields: []FieldDef{ + {Name: "Status", Type: "Status", JSONTag: "status"}, + }, + }, + { + Name: "Output", + Fields: []FieldDef{ + {Name: "Value", Type: "string", JSONTag: "value"}, + }, + }, + }, + TypeAliases: []TypeAlias{ + {Name: "Status", Type: "string", Doc: "Status type"}, + }, + Consts: []ConstGroup{ + { + Type: "Status", + Values: []ConstDef{ + {Name: "StatusPending", Value: `"pending"`}, + {Name: "StatusActive", Value: `"active"`}, + {Name: "StatusDone", Value: `"done"`}, + }, + }, + }, + } + var err error + schema, err = GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + }) + + It("should validate against XTP JSONSchema", func() { + Expect(ValidateXTPSchema(schema)).To(Succeed()) + }) + + It("should define enum type with correct values", func() { + doc := parseSchema(schema) + components := doc["components"].(map[string]any) + schemas := components["schemas"].(map[string]any) + Expect(schemas).To(HaveKey("Status")) + status := schemas["Status"].(map[string]any) + Expect(status["type"]).To(Equal("string")) + enum := status["enum"].([]any) + Expect(enum).To(ConsistOf("pending", "active", "done")) + }) + + It("should use $ref for enum field in struct", func() { + doc := parseSchema(schema) + components := doc["components"].(map[string]any) + schemas := components["schemas"].(map[string]any) + input := schemas["Input"].(map[string]any) + props := input["properties"].(map[string]any) + statusRef := props["status"].(map[string]any) + Expect(statusRef["$ref"]).To(Equal("#/components/schemas/Status")) + }) + }) + + Context("capability with array types", func() { + var schema []byte + + BeforeEach(func() { + capability := Capability{ + Name: "array_test", + SourceFile: "array_test", + Methods: []Export{ + {ExportName: "test", Input: NewParam("input", "Input"), Output: NewParam("output", "Output")}, + }, + Structs: []StructDef{ + { + Name: "Input", + Fields: []FieldDef{ + {Name: "Tags", Type: "[]string", JSONTag: "tags"}, + {Name: "Items", Type: "[]Item", JSONTag: "items"}, + }, + }, + { + Name: "Output", + Fields: []FieldDef{ + {Name: "Value", Type: "string", JSONTag: "value"}, + }, + }, + { + Name: "Item", + Fields: []FieldDef{ + {Name: "ID", Type: "string", JSONTag: "id"}, + }, + }, + }, + } + var err error + schema, err = GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + }) + + It("should validate against XTP JSONSchema", func() { + Expect(ValidateXTPSchema(schema)).To(Succeed()) + }) + + It("should define string array with primitive type", func() { + doc := parseSchema(schema) + components := doc["components"].(map[string]any) + schemas := components["schemas"].(map[string]any) + input := schemas["Input"].(map[string]any) + props := input["properties"].(map[string]any) + tags := props["tags"].(map[string]any) + Expect(tags["type"]).To(Equal("array")) + tagItems := tags["items"].(map[string]any) + Expect(tagItems["type"]).To(Equal("string")) + }) + + It("should define struct array with $ref", func() { + doc := parseSchema(schema) + components := doc["components"].(map[string]any) + schemas := components["schemas"].(map[string]any) + input := schemas["Input"].(map[string]any) + props := input["properties"].(map[string]any) + items := props["items"].(map[string]any) + Expect(items["type"]).To(Equal("array")) + itemItems := items["items"].(map[string]any) + Expect(itemItems["$ref"]).To(Equal("#/components/schemas/Item")) + }) + }) + + Context("capability with []byte field", func() { + It("should map []byte to string with byte format, not array", func() { + capability := Capability{ + Name: "byte_test", + SourceFile: "byte_test", + Methods: []Export{ + {ExportName: "test", Input: NewParam("input", "Input"), Output: NewParam("output", "Output")}, + }, + Structs: []StructDef{ + { + Name: "Input", + Fields: []FieldDef{ + {Name: "Data", Type: "[]byte", JSONTag: "data"}, + }, + }, + { + Name: "Output", + Fields: []FieldDef{ + {Name: "Value", Type: "string", JSONTag: "value"}, + }, + }, + }, + } + schema, err := GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + Expect(ValidateXTPSchema(schema)).To(Succeed()) + + doc := parseSchema(schema) + components := doc["components"].(map[string]any) + schemas := components["schemas"].(map[string]any) + input := schemas["Input"].(map[string]any) + props := input["properties"].(map[string]any) + data := props["data"].(map[string]any) + Expect(data["type"]).To(Equal("string")) + Expect(data["format"]).To(Equal("byte")) + Expect(data).NotTo(HaveKey("items")) + }) + }) + + Context("capability with nullable ref", func() { + It("should mark pointer to enum as nullable with $ref", func() { + capability := Capability{ + Name: "nullable_ref_test", + SourceFile: "nullable_ref_test", + Methods: []Export{ + {ExportName: "test", Input: NewParam("input", "Input"), Output: NewParam("output", "Output")}, + }, + Structs: []StructDef{ + { + Name: "Input", + Fields: []FieldDef{ + {Name: "Value", Type: "string", JSONTag: "value"}, + }, + }, + { + Name: "Output", + Fields: []FieldDef{ + {Name: "Status", Type: "*ErrorType", JSONTag: "status,omitempty", OmitEmpty: true}, + }, + }, + }, + TypeAliases: []TypeAlias{ + {Name: "ErrorType", Type: "string"}, + }, + Consts: []ConstGroup{ + { + Type: "ErrorType", + Values: []ConstDef{ + {Name: "ErrorNone", Value: `"none"`}, + {Name: "ErrorFatal", Value: `"fatal"`}, + }, + }, + }, + } + schema, err := GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + + // Validate against XTP JSONSchema + Expect(ValidateXTPSchema(schema)).To(Succeed()) + + doc := parseSchema(schema) + components := doc["components"].(map[string]any) + schemas := components["schemas"].(map[string]any) + output := schemas["Output"].(map[string]any) + props := output["properties"].(map[string]any) + status := props["status"].(map[string]any) + Expect(status["$ref"]).To(Equal("#/components/schemas/ErrorType")) + Expect(status["nullable"]).To(BeTrue()) + }) + }) + }) + + Describe("goTypeToXTPTypeAndFormat", func() { + DescribeTable("should convert Go types to XTP types", + func(goType, wantType, wantFormat string) { + gotType, gotFormat := goTypeToXTPTypeAndFormat(goType) + Expect(gotType).To(Equal(wantType)) + Expect(gotFormat).To(Equal(wantFormat)) + }, + Entry("string", "string", "string", ""), + Entry("int", "int", "integer", "int32"), + Entry("int32", "int32", "integer", "int32"), + Entry("int64", "int64", "integer", "int64"), + Entry("float32", "float32", "number", "float"), + Entry("float64", "float64", "number", "float"), + Entry("bool", "bool", "boolean", ""), + Entry("[]byte", "[]byte", "string", "byte"), + Entry("unknown types default to object", "CustomType", "object", ""), + ) + }) + + Describe("cleanDocForYAML", func() { + DescribeTable("should clean documentation strings", + func(doc, want string) { + Expect(cleanDocForYAML(doc)).To(Equal(want)) + }, + Entry("empty", "", ""), + Entry("single line", "Simple description", "Simple description"), + Entry("multiline", "First line\nSecond line", "First line\nSecond line"), + Entry("trailing newline", "Description\n", "Description"), + Entry("whitespace", " Description ", "Description"), + ) + }) + + Describe("isPrimitiveGoType", func() { + DescribeTable("should identify primitive Go types", + func(goType string, want bool) { + Expect(isPrimitiveGoType(goType)).To(Equal(want)) + }, + Entry("bool", "bool", true), + Entry("string", "string", true), + Entry("int", "int", true), + Entry("int32", "int32", true), + Entry("int64", "int64", true), + Entry("float32", "float32", true), + Entry("float64", "float64", true), + Entry("[]byte", "[]byte", true), + Entry("custom type", "CustomType", false), + Entry("struct type", "MyStruct", false), + Entry("slice of string", "[]string", false), + Entry("map type", "map[string]int", false), + ) + }) + + Describe("GenerateSchema with primitive output types", func() { + inputStruct := StructDef{ + Name: "Input", + Fields: []FieldDef{{Name: "ID", Type: "string", JSONTag: "id"}}, + } + + Context("export with primitive string output", func() { + It("should use type instead of $ref and validate against XTP JSONSchema", func() { + capability := Capability{ + Name: "test", + SourceFile: "test", + Methods: []Export{ + {ExportName: "get_name", Input: NewParam("input", "Input"), Output: NewParam("output", "string")}, + }, + Structs: []StructDef{inputStruct}, + } + schema, err := GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + Expect(schema).NotTo(BeEmpty()) + Expect(ValidateXTPSchema(schema)).To(Succeed()) + + doc := parseSchema(schema) + exports := doc["exports"].(map[string]any) + method := exports["get_name"].(map[string]any) + output := method["output"].(map[string]any) + Expect(output["type"]).To(Equal("string")) + Expect(output).NotTo(HaveKey("$ref")) + Expect(output["contentType"]).To(Equal("application/json")) + }) + }) + + Context("export with primitive bool output", func() { + It("should use boolean type and validate against XTP JSONSchema", func() { + capability := Capability{ + Name: "test", + SourceFile: "test", + Methods: []Export{ + {ExportName: "is_valid", Input: NewParam("input", "Input"), Output: NewParam("output", "bool")}, + }, + Structs: []StructDef{inputStruct}, + } + schema, err := GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + Expect(ValidateXTPSchema(schema)).To(Succeed()) + + doc := parseSchema(schema) + exports := doc["exports"].(map[string]any) + method := exports["is_valid"].(map[string]any) + output := method["output"].(map[string]any) + Expect(output["type"]).To(Equal("boolean")) + Expect(output).NotTo(HaveKey("$ref")) + }) + }) + + Context("export with primitive int output", func() { + It("should use integer type and validate against XTP JSONSchema", func() { + capability := Capability{ + Name: "test", + SourceFile: "test", + Methods: []Export{ + {ExportName: "get_count", Input: NewParam("input", "Input"), Output: NewParam("output", "int32")}, + }, + Structs: []StructDef{inputStruct}, + } + schema, err := GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + Expect(ValidateXTPSchema(schema)).To(Succeed()) + + doc := parseSchema(schema) + exports := doc["exports"].(map[string]any) + method := exports["get_count"].(map[string]any) + output := method["output"].(map[string]any) + Expect(output["type"]).To(Equal("integer")) + Expect(output).NotTo(HaveKey("$ref")) + }) + }) + + Context("export with pointer to primitive output", func() { + It("should strip pointer and use primitive type and validate against XTP JSONSchema", func() { + capability := Capability{ + Name: "test", + SourceFile: "test", + Methods: []Export{ + {ExportName: "get_optional_string", Input: NewParam("input", "Input"), Output: NewParam("output", "*string")}, + }, + Structs: []StructDef{inputStruct}, + } + schema, err := GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + Expect(ValidateXTPSchema(schema)).To(Succeed()) + + doc := parseSchema(schema) + exports := doc["exports"].(map[string]any) + method := exports["get_optional_string"].(map[string]any) + output := method["output"].(map[string]any) + Expect(output["type"]).To(Equal("string")) + Expect(output).NotTo(HaveKey("$ref")) + }) + }) + + Context("export with struct output", func() { + It("should still use $ref and validate against XTP JSONSchema", func() { + capability := Capability{ + Name: "test", + SourceFile: "test", + Methods: []Export{ + {ExportName: "get_result", Input: NewParam("input", "Input"), Output: NewParam("output", "Output")}, + }, + Structs: []StructDef{ + inputStruct, + {Name: "Output", Fields: []FieldDef{{Name: "Value", Type: "string", JSONTag: "value"}}}, + }, + } + schema, err := GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + Expect(ValidateXTPSchema(schema)).To(Succeed()) + + doc := parseSchema(schema) + exports := doc["exports"].(map[string]any) + method := exports["get_result"].(map[string]any) + output := method["output"].(map[string]any) + Expect(output["$ref"]).To(Equal("#/components/schemas/Output")) + Expect(output).NotTo(HaveKey("type")) + }) + }) + }) + + Describe("collectUsedTypes", func() { + getSchemas := func(schema []byte) map[string]any { + doc := parseSchema(schema) + components, hasComponents := doc["components"].(map[string]any) + if !hasComponents { + return make(map[string]any) + } + schemas, ok := components["schemas"].(map[string]any) + if !ok { + return make(map[string]any) + } + return schemas + } + + It("should only include types referenced by exports", func() { + capability := Capability{ + Name: "test", + SourceFile: "test", + Methods: []Export{ + {ExportName: "test", Input: NewParam("input", "UsedInput"), Output: NewParam("output", "UsedOutput")}, + }, + Structs: []StructDef{ + {Name: "UsedInput", Fields: []FieldDef{{Name: "ID", Type: "string", JSONTag: "id"}}}, + {Name: "UsedOutput", Fields: []FieldDef{{Name: "Value", Type: "string", JSONTag: "value"}}}, + {Name: "UnusedStruct", Fields: []FieldDef{{Name: "Foo", Type: "string", JSONTag: "foo"}}}, + }, + } + schema, err := GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + Expect(ValidateXTPSchema(schema)).To(Succeed()) + + schemas := getSchemas(schema) + Expect(schemas).To(HaveKey("UsedInput")) + Expect(schemas).To(HaveKey("UsedOutput")) + Expect(schemas).NotTo(HaveKey("UnusedStruct")) + }) + + It("should include transitively referenced types", func() { + capability := Capability{ + Name: "test", + SourceFile: "test", + Methods: []Export{ + {ExportName: "test", Input: NewParam("input", "Input"), Output: NewParam("output", "Output")}, + }, + Structs: []StructDef{ + {Name: "Input", Fields: []FieldDef{{Name: "ID", Type: "string", JSONTag: "id"}}}, + {Name: "Output", Fields: []FieldDef{{Name: "Nested", Type: "NestedType", JSONTag: "nested"}}}, + {Name: "NestedType", Fields: []FieldDef{{Name: "Value", Type: "string", JSONTag: "value"}}}, + }, + } + schema, err := GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + Expect(ValidateXTPSchema(schema)).To(Succeed()) + + schemas := getSchemas(schema) + Expect(schemas).To(HaveKey("Input")) + Expect(schemas).To(HaveKey("Output")) + Expect(schemas).To(HaveKey("NestedType")) + }) + + It("should include array element types", func() { + capability := Capability{ + Name: "test", + SourceFile: "test", + Methods: []Export{ + {ExportName: "test", Input: NewParam("input", "Input"), Output: NewParam("output", "Output")}, + }, + Structs: []StructDef{ + {Name: "Input", Fields: []FieldDef{{Name: "ID", Type: "string", JSONTag: "id"}}}, + {Name: "Output", Fields: []FieldDef{{Name: "Items", Type: "[]Item", JSONTag: "items"}}}, + {Name: "Item", Fields: []FieldDef{{Name: "Name", Type: "string", JSONTag: "name"}}}, + }, + } + schema, err := GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + Expect(ValidateXTPSchema(schema)).To(Succeed()) + + schemas := getSchemas(schema) + Expect(schemas).To(HaveKey("Input")) + Expect(schemas).To(HaveKey("Output")) + Expect(schemas).To(HaveKey("Item")) + }) + + It("should include pointer types", func() { + capability := Capability{ + Name: "test", + SourceFile: "test", + Methods: []Export{ + {ExportName: "test", Input: NewParam("input", "Input"), Output: NewParam("output", "Output")}, + }, + Structs: []StructDef{ + {Name: "Input", Fields: []FieldDef{{Name: "ID", Type: "string", JSONTag: "id"}}}, + {Name: "Output", Fields: []FieldDef{{Name: "Optional", Type: "*OptionalType", JSONTag: "optional"}}}, + {Name: "OptionalType", Fields: []FieldDef{{Name: "Value", Type: "string", JSONTag: "value"}}}, + }, + } + schema, err := GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + Expect(ValidateXTPSchema(schema)).To(Succeed()) + + schemas := getSchemas(schema) + Expect(schemas).To(HaveKey("Input")) + Expect(schemas).To(HaveKey("Output")) + Expect(schemas).To(HaveKey("OptionalType")) + }) + + It("should exclude primitive output types from schema", func() { + capability := Capability{ + Name: "test", + SourceFile: "test", + Methods: []Export{ + {ExportName: "test", Input: NewParam("input", "Input"), Output: NewParam("output", "string")}, + }, + Structs: []StructDef{ + {Name: "Input", Fields: []FieldDef{{Name: "ID", Type: "string", JSONTag: "id"}}}, + }, + } + schema, err := GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + Expect(ValidateXTPSchema(schema)).To(Succeed()) + + schemas := getSchemas(schema) + Expect(schemas).To(HaveKey("Input")) + }) + }) + + Describe("GenerateSchema enum filtering", func() { + It("should only include enums that are actually used by exports", func() { + capability := Capability{ + Name: "test", + SourceFile: "test", + Methods: []Export{ + {ExportName: "test", Input: NewParam("input", "Input"), Output: NewParam("output", "Output")}, + }, + Structs: []StructDef{ + { + Name: "Input", + Fields: []FieldDef{{Name: "Status", Type: "UsedStatus", JSONTag: "status"}}, + }, + { + Name: "Output", + Fields: []FieldDef{{Name: "Value", Type: "string", JSONTag: "value"}}, + }, + }, + TypeAliases: []TypeAlias{ + {Name: "UsedStatus", Type: "string"}, + {Name: "UnusedStatus", Type: "string"}, + }, + Consts: []ConstGroup{ + { + Type: "UsedStatus", + Values: []ConstDef{ + {Name: "StatusActive", Value: `"active"`}, + {Name: "StatusInactive", Value: `"inactive"`}, + }, + }, + { + Type: "UnusedStatus", + Values: []ConstDef{ + {Name: "UnusedPending", Value: `"pending"`}, + }, + }, + }, + } + + schema, err := GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + Expect(ValidateXTPSchema(schema)).To(Succeed()) + + doc := parseSchema(schema) + components := doc["components"].(map[string]any) + schemas := components["schemas"].(map[string]any) + + // UsedStatus should be included because it's referenced by Input + Expect(schemas).To(HaveKey("UsedStatus")) + usedStatus := schemas["UsedStatus"].(map[string]any) + Expect(usedStatus["type"]).To(Equal("string")) + enum := usedStatus["enum"].([]any) + Expect(enum).To(ConsistOf("active", "inactive")) + + // UnusedStatus should NOT be included + Expect(schemas).NotTo(HaveKey("UnusedStatus")) + }) + }) +}) diff --git a/plugins/cmd/ndpgen/internal/xtp_schema_validate.go b/plugins/cmd/ndpgen/internal/xtp_schema_validate.go new file mode 100644 index 000000000..94404fb79 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/xtp_schema_validate.go @@ -0,0 +1,86 @@ +package internal + +import ( + _ "embed" + "encoding/json" + "errors" + "fmt" + "strings" + + "github.com/santhosh-tekuri/jsonschema/v6" + "gopkg.in/yaml.v3" +) + +// XTP JSONSchema specification, from +// https://raw.githubusercontent.com/dylibso/xtp-bindgen/5090518dd86ba5e734dc225a33066ecc0ed2e12d/plugin/schema.json +// +//go:embed xtp_schema.json +var xtpSchemaJSON string + +// ValidateXTPSchema validates that the generated schema conforms to the XTP JSONSchema specification. +// Returns nil if valid, or an error with validation details if invalid. +func ValidateXTPSchema(generatedSchema []byte) error { + // Parse the YAML schema to JSON for validation + var schemaDoc map[string]any + if err := yaml.Unmarshal(generatedSchema, &schemaDoc); err != nil { + return fmt.Errorf("failed to parse generated schema as YAML: %w", err) + } + + // Parse the XTP schema JSON + var xtpSchema any + if err := json.Unmarshal([]byte(xtpSchemaJSON), &xtpSchema); err != nil { + return fmt.Errorf("failed to parse XTP schema: %w", err) + } + + // Compile the XTP schema + compiler := jsonschema.NewCompiler() + if err := compiler.AddResource("xtp-schema.json", xtpSchema); err != nil { + return fmt.Errorf("failed to add XTP schema resource: %w", err) + } + + schema, err := compiler.Compile("xtp-schema.json") + if err != nil { + return fmt.Errorf("failed to compile XTP schema: %w", err) + } + + // Validate the generated schema against XTP schema + if err := schema.Validate(schemaDoc); err != nil { + return fmt.Errorf("schema validation errors:\n%s", formatValidationErrors(err)) + } + + return nil +} + +// formatValidationErrors formats jsonschema validation errors into readable strings. +func formatValidationErrors(err error) string { + var validationErr *jsonschema.ValidationError + if !errors.As(err, &validationErr) { + return fmt.Sprintf("- %s", err.Error()) + } + + var errs []string + collectValidationErrors(validationErr, &errs) + + if len(errs) == 0 { + return fmt.Sprintf("- %s", validationErr.Error()) + } + return strings.Join(errs, "\n") +} + +// collectValidationErrors recursively collects leaf validation errors. +func collectValidationErrors(err *jsonschema.ValidationError, errs *[]string) { + if len(err.Causes) > 0 { + for _, cause := range err.Causes { + collectValidationErrors(cause, errs) + } + return + } + + // Leaf error - format with location if available + msg := err.Error() + if len(err.InstanceLocation) > 0 { + location := strings.Join(err.InstanceLocation, "/") + msg = fmt.Sprintf("%s: %s", location, msg) + } + *errs = append(*errs, fmt.Sprintf("- %s", msg)) +} diff --git a/plugins/cmd/ndpgen/main.go b/plugins/cmd/ndpgen/main.go new file mode 100644 index 000000000..b34ee4296 --- /dev/null +++ b/plugins/cmd/ndpgen/main.go @@ -0,0 +1,957 @@ +// ndpgen generates Navidrome Plugin Development Kit (PDK) code from annotated Go interfaces. +// +// This is the unified code generator that handles both host function wrappers +// and capability export wrappers. +// +// Usage: +// +// # Generate host wrappers for Navidrome server (output to input directory) +// ndpgen -host-wrappers -input=./plugins/host -package=host +// +// # Generate PDK client wrappers (from plugins/host to plugins/pdk) +// ndpgen -host-only -input=./plugins/host -output=./plugins/pdk +// +// # Generate capability wrappers (from plugins/capabilities to plugins/pdk) +// ndpgen -capability-only -input=./plugins/capabilities -output=./plugins/pdk +// +// # Generate XTP schemas from capabilities (output to input directory) +// ndpgen -schemas -input=./plugins/capabilities +// +// Output directories: +// - Host wrappers: $input/_gen.go (server-side, used by Navidrome) +// - Host functions: $output/go/host/, $output/python/host/, $output/rust/host/ +// - Capabilities: $output/go// (e.g., $output/go/metadata/) +// - Schemas: $input/.yaml (co-located with Go sources) +// +// Flags: +// +// -input Input directory containing Go source files with annotated interfaces +// -output Output directory base for generated files (default: same as input) +// -package Output package name for Go (default: host for host-only, auto for capabilities) +// -host-wrappers Generate server-side host wrappers (used by Navidrome, output to input directory) +// -host-only Generate PDK client wrappers for calling host functions +// -capability-only Generate only capability export wrappers +// -schemas Generate XTP YAML schemas from capabilities +// -go Generate Go client wrappers (default: true when not using -python/-rust) +// -python Generate Python client wrappers (default: false) +// -rust Generate Rust client wrappers (default: false) +// -v Verbose output +// -dry-run Preview generated code without writing files +package main + +import ( + "flag" + "fmt" + "go/format" + "os" + "path/filepath" + "strings" + + "github.com/navidrome/navidrome/plugins/cmd/ndpgen/internal" +) + +// config holds the parsed command-line configuration. +type config struct { + inputDir string + outputDir string // Base output directory (e.g., plugins/pdk) + goOutputDir string // Go output: $outputDir/go/host (for host-only) + pythonOutputDir string // Python output: $outputDir/python/host + rustOutputDir string // Rust output: $outputDir/rust/host + pkgName string + hostOnly bool + hostWrappers bool // Generate host wrappers (used by Navidrome server) + capabilityOnly bool + schemasOnly bool // Generate XTP schemas from capabilities (output goes to inputDir) + pdkOnly bool // Generate PDK abstraction layer wrapper + generateGoClient bool + generatePyClient bool + generateRsClient bool + verbose bool + dryRun bool +} + +func main() { + cfg, err := parseConfig() + if err != nil { + fmt.Fprintf(os.Stderr, "Error: %v\n", err) + os.Exit(1) + } + + if cfg.schemasOnly { + if err := runSchemaGeneration(cfg); err != nil { + fmt.Fprintf(os.Stderr, "Error: %v\n", err) + os.Exit(1) + } + return + } + + if cfg.pdkOnly { + if err := runPDKGeneration(cfg); err != nil { + fmt.Fprintf(os.Stderr, "Error: %v\n", err) + os.Exit(1) + } + return + } + + if cfg.capabilityOnly { + if err := runCapabilityGeneration(cfg); err != nil { + fmt.Fprintf(os.Stderr, "Error: %v\n", err) + os.Exit(1) + } + return + } + + if cfg.hostWrappers { + if err := runHostWrapperGeneration(cfg); err != nil { + fmt.Fprintf(os.Stderr, "Error: %v\n", err) + os.Exit(1) + } + return + } + + // Default: host-only mode + services, err := parseServices(cfg) + if err != nil { + fmt.Fprintf(os.Stderr, "Error: %v\n", err) + os.Exit(1) + } + if len(services) == 0 { + return + } + + if err := generateAllCode(cfg, services); err != nil { + fmt.Fprintf(os.Stderr, "Error: %v\n", err) + os.Exit(1) + } +} + +// runCapabilityGeneration handles capability-only code generation. +func runCapabilityGeneration(cfg *config) error { + capabilities, err := parseCapabilities(cfg) + if err != nil { + return err + } + if len(capabilities) == 0 { + if cfg.verbose { + fmt.Println("No capabilities found") + } + return nil + } + + return generateCapabilityCode(cfg, capabilities) +} + +// runSchemaGeneration handles XTP schema generation from capabilities. +func runSchemaGeneration(cfg *config) error { + capabilities, err := parseCapabilities(cfg) + if err != nil { + return err + } + if len(capabilities) == 0 { + if cfg.verbose { + fmt.Println("No capabilities found") + } + return nil + } + + return generateSchemas(cfg, capabilities) +} + +// runPDKGeneration handles PDK abstraction layer code generation. +// This generates the pdk wrapper package that wraps extism/go-pdk +// with mockable implementations for unit testing on native platforms. +func runPDKGeneration(cfg *config) error { + // Output directory is $output/go/pdk/ + outputDir := filepath.Join(cfg.outputDir, "go", "pdk") + return generatePDKPackageWithParsing(outputDir, cfg.dryRun, cfg.verbose) +} + +// generatePDKPackageWithParsing generates the PDK abstraction layer using AST parsing. +// It extracts all exported symbols from extism/go-pdk and generates wrappers for them. +func generatePDKPackageWithParsing(outputDir string, dryRun, verbose bool) error { + if verbose { + fmt.Println("Parsing extism/go-pdk to extract exported symbols...") + } + + // Parse extism/go-pdk to get all exported symbols + symbols, err := internal.ParseExtismPDK() + if err != nil { + return fmt.Errorf("parsing extism/go-pdk: %w", err) + } + + if verbose { + fmt.Printf("Found %d types, %d constants, %d functions\n", + len(symbols.Types), len(symbols.Consts), len(symbols.Functions)) + for _, t := range symbols.Types { + fmt.Printf(" Type %s: %d methods, %d fields\n", t.Name, len(t.Methods), len(t.Fields)) + for _, m := range t.Methods { + fmt.Printf(" Method: %s (receiver: %s)\n", m.Name, m.Receiver) + } + } + fmt.Printf("Generating PDK abstraction layer to: %s\n", outputDir) + } + + // Generate the WASM implementation (pdk.go) + pdkCode, err := internal.GeneratePDKGo(symbols) + if err != nil { + return fmt.Errorf("generating pdk.go: %w", err) + } + + formatted, err := format.Source(pdkCode) + if err != nil { + return fmt.Errorf("formatting pdk.go: %w\nRaw code:\n%s", err, pdkCode) + } + + pdkFile := filepath.Join(outputDir, "pdk.go") + + if dryRun { + fmt.Printf("=== %s ===\n%s\n", pdkFile, formatted) + } else { + if err := os.MkdirAll(outputDir, 0755); err != nil { + return fmt.Errorf("creating output directory: %w", err) + } + + if err := os.WriteFile(pdkFile, formatted, 0600); err != nil { + return fmt.Errorf("writing pdk.go: %w", err) + } + + if verbose { + fmt.Printf("Generated: %s\n", pdkFile) + } + } + + // Generate the types stub (types_stub.go) + typesStubCode, err := internal.GeneratePDKTypesStub(symbols) + if err != nil { + return fmt.Errorf("generating types_stub.go: %w", err) + } + + formattedTypesStub, err := format.Source(typesStubCode) + if err != nil { + return fmt.Errorf("formatting types_stub.go: %w\nRaw code:\n%s", err, typesStubCode) + } + + typesStubFile := filepath.Join(outputDir, "types_stub.go") + + if dryRun { + fmt.Printf("=== %s ===\n%s\n", typesStubFile, formattedTypesStub) + } else { + if err := os.WriteFile(typesStubFile, formattedTypesStub, 0600); err != nil { + return fmt.Errorf("writing types_stub.go: %w", err) + } + + if verbose { + fmt.Printf("Generated: %s\n", typesStubFile) + } + } + + // Generate the stub implementation (pdk_stub.go) + stubCode, err := internal.GeneratePDKGoStub(symbols) + if err != nil { + return fmt.Errorf("generating pdk_stub.go: %w", err) + } + + formattedStub, err := format.Source(stubCode) + if err != nil { + return fmt.Errorf("formatting pdk_stub.go: %w\nRaw code:\n%s", err, stubCode) + } + + stubFile := filepath.Join(outputDir, "pdk_stub.go") + + if dryRun { + fmt.Printf("=== %s ===\n%s\n", stubFile, formattedStub) + } else { + if err := os.WriteFile(stubFile, formattedStub, 0600); err != nil { + return fmt.Errorf("writing pdk_stub.go: %w", err) + } + + if verbose { + fmt.Printf("Generated: %s\n", stubFile) + } + } + + return nil +} + +// generatePDKPackage generates the PDK abstraction layer to a specific directory. +// This is called by generateAllCode to include the PDK package alongside host client code. +func generatePDKPackage(outputDir string, dryRun, verbose bool) error { + return generatePDKPackageWithParsing(outputDir, dryRun, verbose) +} + +// runHostWrapperGeneration handles host wrapper code generation. +// This generates the *_gen.go files in the input directory that are used +// by Navidrome server to expose host functions to plugins. +func runHostWrapperGeneration(cfg *config) error { + services, err := parseServices(cfg) + if err != nil { + return err + } + if len(services) == 0 { + if cfg.verbose { + fmt.Println("No host services found") + } + return nil + } + + // Generate host wrappers for each service + for _, svc := range services { + if err := generateHostWrapperCode(svc, cfg.inputDir, cfg.pkgName, cfg.dryRun, cfg.verbose); err != nil { + return fmt.Errorf("generating host wrapper for %s: %w", svc.Name, err) + } + } + + return nil +} + +// parseConfig parses command-line flags and returns the configuration. +func parseConfig() (*config, error) { + var ( + inputDir = flag.String("input", ".", "Input directory containing Go source files") + outputDir = flag.String("output", "", "Base output directory for generated files (default: same as input)") + pkgName = flag.String("package", "", "Output package name for Go (default: host for host-only, auto for capabilities)") + hostOnly = flag.Bool("host-only", false, "Generate only host function wrappers") + hostWrappers = flag.Bool("host-wrappers", false, "Generate host wrappers (used by Navidrome server, output to input directory)") + capabilityOnly = flag.Bool("capability-only", false, "Generate only capability export wrappers") + schemasOnly = flag.Bool("schemas", false, "Generate XTP YAML schemas from capabilities (output to input directory)") + pdkOnly = flag.Bool("extism-pdk", false, "Generate PDK abstraction layer by parsing extism/go-pdk") + goClient = flag.Bool("go", false, "Generate Go client wrappers") + pyClient = flag.Bool("python", false, "Generate Python client wrappers") + rsClient = flag.Bool("rust", false, "Generate Rust client wrappers") + verbose = flag.Bool("v", false, "Verbose output") + dryRun = flag.Bool("dry-run", false, "Preview generated code without writing files") + ) + flag.Parse() + + // Count how many mode flags are specified + modeCount := 0 + if *hostOnly { + modeCount++ + } + if *hostWrappers { + modeCount++ + } + if *capabilityOnly { + modeCount++ + } + if *schemasOnly { + modeCount++ + } + if *pdkOnly { + modeCount++ + } + + // Default to host-only if no mode is specified + if modeCount == 0 { + *hostOnly = true + } + + // Cannot specify multiple modes + if modeCount > 1 { + return nil, fmt.Errorf("cannot specify multiple modes (-host-only, -host-wrappers, -capability-only, -schemas, -pdk)") + } + + if *outputDir == "" { + *outputDir = *inputDir + } + + // Default package name based on mode + if *pkgName == "" { + if *hostOnly { + *pkgName = "host" + } + // For capability-only, package name is derived from capability annotation + } + + absInput, err := filepath.Abs(*inputDir) + if err != nil { + return nil, fmt.Errorf("resolving input path: %w", err) + } + absOutput, err := filepath.Abs(*outputDir) + if err != nil { + return nil, fmt.Errorf("resolving output path: %w", err) + } + + // Set output directories for each language + // Go host wrappers: $output/go/host/ + // Python host wrappers: $output/python/host/ + // Rust host wrappers: $output/rust/nd-pdk-host/ (renamed crate) + absGoOutput := filepath.Join(absOutput, "go", "host") + absPythonOutput := filepath.Join(absOutput, "python", "host") + absRustOutput := filepath.Join(absOutput, "rust", "nd-pdk-host") + + // Determine what to generate + // Default: generate Go clients if no language flag is specified + anyLangFlag := *goClient || *pyClient || *rsClient + + return &config{ + inputDir: absInput, + outputDir: absOutput, + goOutputDir: absGoOutput, + pythonOutputDir: absPythonOutput, + rustOutputDir: absRustOutput, + pkgName: *pkgName, + hostOnly: *hostOnly, + hostWrappers: *hostWrappers, + capabilityOnly: *capabilityOnly, + schemasOnly: *schemasOnly, + pdkOnly: *pdkOnly, + generateGoClient: *goClient || !anyLangFlag, + generatePyClient: *pyClient, + generateRsClient: *rsClient, + verbose: *verbose, + dryRun: *dryRun, + }, nil +} + +// parseServices parses source files and returns discovered services. +func parseServices(cfg *config) ([]internal.Service, error) { + if cfg.verbose { + fmt.Printf("Input directory: %s\n", cfg.inputDir) + fmt.Printf("Base output directory: %s\n", cfg.outputDir) + if cfg.generateGoClient { + fmt.Printf("Go output directory: %s\n", cfg.goOutputDir) + } + if cfg.generatePyClient { + fmt.Printf("Python output directory: %s\n", cfg.pythonOutputDir) + } + if cfg.generateRsClient { + fmt.Printf("Rust output directory: %s\n", cfg.rustOutputDir) + } + fmt.Printf("Package name: %s\n", cfg.pkgName) + fmt.Printf("Host-only mode: %v\n", cfg.hostOnly) + fmt.Printf("Generate Go client code: %v\n", cfg.generateGoClient) + fmt.Printf("Generate Python client code: %v\n", cfg.generatePyClient) + fmt.Printf("Generate Rust client code: %v\n", cfg.generateRsClient) + } + + services, err := internal.ParseDirectory(cfg.inputDir) + if err != nil { + return nil, fmt.Errorf("parsing source files: %w", err) + } + + if len(services) == 0 { + if cfg.verbose { + fmt.Println("No host services found") + } + return nil, nil + } + + if cfg.verbose { + fmt.Printf("Found %d host service(s)\n", len(services)) + for _, svc := range services { + fmt.Printf(" - %s (%d methods)\n", svc.Name, len(svc.Methods)) + } + } + + return services, nil +} + +// parseCapabilities parses source files and returns discovered capabilities. +func parseCapabilities(cfg *config) ([]internal.Capability, error) { + if cfg.verbose { + fmt.Printf("Input directory: %s\n", cfg.inputDir) + fmt.Printf("Base output directory: %s\n", cfg.outputDir) + fmt.Printf("Capability-only mode: %v\n", cfg.capabilityOnly) + } + + capabilities, err := internal.ParseCapabilities(cfg.inputDir) + if err != nil { + return nil, fmt.Errorf("parsing capability files: %w", err) + } + + if len(capabilities) == 0 { + return nil, nil + } + + if cfg.verbose { + fmt.Printf("Found %d capability(ies)\n", len(capabilities)) + for _, cap := range capabilities { + fmt.Printf(" - %s (%d exports, required=%v)\n", cap.Name, len(cap.Methods), cap.Required) + } + } + + return capabilities, nil +} + +// generateCapabilityCode generates export wrappers for all capabilities. +func generateCapabilityCode(cfg *config, capabilities []internal.Capability) error { + // Generate Go capability wrappers (always, for now) + for _, cap := range capabilities { + // Output directory is $output/go// + outputDir := filepath.Join(cfg.outputDir, "go", cap.Name) + + if err := generateCapabilityGoCode(cap, outputDir, cfg.dryRun, cfg.verbose); err != nil { + return fmt.Errorf("generating Go capability code for %s: %w", cap.Name, err) + } + } + + // Generate Rust capability wrappers if -rust flag is set + if cfg.generateRsClient { + rustOutputDir := filepath.Join(cfg.outputDir, "rust", "nd-pdk-capabilities", "src") + if err := generateCapabilityRustCode(capabilities, rustOutputDir, cfg.dryRun, cfg.verbose); err != nil { + return fmt.Errorf("generating Rust capability code: %w", err) + } + } + + return nil +} + +// generateCapabilityGoCode generates Go export wrapper code for a capability. +func generateCapabilityGoCode(cap internal.Capability, outputDir string, dryRun, verbose bool) error { + // Use the capability name as the package name + pkgName := cap.Name + + // Generate the main WASM code + code, err := internal.GenerateCapabilityGo(cap, pkgName) + if err != nil { + return fmt.Errorf("generating code: %w", err) + } + + formatted, err := format.Source(code) + if err != nil { + return fmt.Errorf("formatting code: %w\nRaw code:\n%s", err, code) + } + + mainFile := filepath.Join(outputDir, cap.Name+".go") + + if dryRun { + fmt.Printf("=== %s ===\n%s\n", mainFile, formatted) + } else { + if err := os.MkdirAll(outputDir, 0755); err != nil { + return fmt.Errorf("creating output directory: %w", err) + } + + if err := os.WriteFile(mainFile, formatted, 0600); err != nil { + return fmt.Errorf("writing file: %w", err) + } + + if verbose { + fmt.Printf("Generated capability code: %s\n", mainFile) + } + } + + // Generate the stub code for non-WASM platforms + stubCode, err := internal.GenerateCapabilityGoStub(cap, pkgName) + if err != nil { + return fmt.Errorf("generating stub code: %w", err) + } + + formattedStub, err := format.Source(stubCode) + if err != nil { + return fmt.Errorf("formatting stub code: %w\nRaw code:\n%s", err, stubCode) + } + + stubFile := filepath.Join(outputDir, cap.Name+"_stub.go") + + if dryRun { + fmt.Printf("=== %s ===\n%s\n", stubFile, formattedStub) + } else { + if err := os.WriteFile(stubFile, formattedStub, 0600); err != nil { + return fmt.Errorf("writing stub file: %w", err) + } + + if verbose { + fmt.Printf("Generated capability stub: %s\n", stubFile) + } + } + + return nil +} + +// generateCapabilityRustCode generates Rust export wrapper code for all capabilities. +func generateCapabilityRustCode(capabilities []internal.Capability, outputDir string, dryRun, verbose bool) error { + // Generate individual capability modules + for _, cap := range capabilities { + code, err := internal.GenerateCapabilityRust(cap) + if err != nil { + return fmt.Errorf("generating Rust code for %s: %w", cap.Name, err) + } + + fileName := internal.ToSnakeCase(cap.Name) + ".rs" + filePath := filepath.Join(outputDir, fileName) + + if dryRun { + fmt.Printf("=== %s ===\n%s\n", filePath, code) + } else { + if err := os.MkdirAll(outputDir, 0755); err != nil { + return fmt.Errorf("creating output directory: %w", err) + } + + if err := os.WriteFile(filePath, code, 0600); err != nil { + return fmt.Errorf("writing file %s: %w", filePath, err) + } + + if verbose { + fmt.Printf("Generated Rust capability code: %s\n", filePath) + } + } + } + + // Generate lib.rs + libCode, err := internal.GenerateCapabilityRustLib(capabilities) + if err != nil { + return fmt.Errorf("generating lib.rs: %w", err) + } + + libPath := filepath.Join(outputDir, "lib.rs") + + if dryRun { + fmt.Printf("=== %s ===\n%s\n", libPath, libCode) + } else { + if err := os.WriteFile(libPath, libCode, 0600); err != nil { + return fmt.Errorf("writing lib.rs: %w", err) + } + + if verbose { + fmt.Printf("Generated Rust lib.rs: %s\n", libPath) + } + } + + return nil +} + +// generateAllCode generates all requested code for the services. +func generateAllCode(cfg *config, services []internal.Service) error { + for _, svc := range services { + if cfg.generateGoClient { + if err := generateGoClientCode(svc, cfg.goOutputDir, cfg.pkgName, cfg.dryRun, cfg.verbose); err != nil { + return fmt.Errorf("generating Go client code for %s: %w", svc.Name, err) + } + } + if cfg.generatePyClient { + if err := generatePythonClientCode(svc, cfg.pythonOutputDir, cfg.dryRun, cfg.verbose); err != nil { + return fmt.Errorf("generating Python client code for %s: %w", svc.Name, err) + } + } + if cfg.generateRsClient { + if err := generateRustClientCode(svc, cfg.rustOutputDir, cfg.dryRun, cfg.verbose); err != nil { + return fmt.Errorf("generating Rust client code for %s: %w", svc.Name, err) + } + } + } + + if cfg.generateRsClient && len(services) > 0 { + if err := generateRustLibFile(services, cfg.rustOutputDir, cfg.dryRun, cfg.verbose); err != nil { + return fmt.Errorf("generating Rust lib.rs: %w", err) + } + } + + if cfg.generateGoClient && len(services) > 0 { + if err := generateGoDocFile(services, cfg.goOutputDir, cfg.pkgName, cfg.dryRun, cfg.verbose); err != nil { + return fmt.Errorf("generating Go doc.go: %w", err) + } + if err := generateGoModFile(cfg.goOutputDir, cfg.dryRun, cfg.verbose); err != nil { + return fmt.Errorf("generating Go go.mod: %w", err) + } + // Generate PDK abstraction layer alongside host client code + pdkDir := filepath.Join(filepath.Dir(cfg.goOutputDir), "pdk") + if err := generatePDKPackage(pdkDir, cfg.dryRun, cfg.verbose); err != nil { + return fmt.Errorf("generating PDK package: %w", err) + } + } + + return nil +} + +// generateHostWrapperCode generates host wrapper code for a service. +// This generates the *_gen.go files that are used by Navidrome server +// to expose host functions to plugins via Extism. +func generateHostWrapperCode(svc internal.Service, outputDir, pkgName string, dryRun, verbose bool) error { + code, err := internal.GenerateHost(svc, pkgName) + if err != nil { + return fmt.Errorf("generating code: %w", err) + } + + formatted, err := format.Source(code) + if err != nil { + return fmt.Errorf("formatting code: %w\nRaw code:\n%s", err, code) + } + + // Host wrapper file follows the pattern _gen.go + hostFile := filepath.Join(outputDir, strings.ToLower(svc.Name)+"_gen.go") + + if dryRun { + fmt.Printf("=== %s ===\n%s\n", hostFile, formatted) + } else { + if err := os.WriteFile(hostFile, formatted, 0600); err != nil { + return fmt.Errorf("writing file: %w", err) + } + + if verbose { + fmt.Printf("Generated host wrapper: %s\n", hostFile) + } + } + + return nil +} + +// generateGoClientCode generates Go client-side code for a service. +func generateGoClientCode(svc internal.Service, outputDir, pkgName string, dryRun, verbose bool) error { + code, err := internal.GenerateClientGo(svc, pkgName) + if err != nil { + return fmt.Errorf("generating code: %w", err) + } + + formatted, err := format.Source(code) + if err != nil { + return fmt.Errorf("formatting code: %w\nRaw code:\n%s", err, code) + } + + // Client code goes directly in the output directory + clientFile := filepath.Join(outputDir, "nd_host_"+strings.ToLower(svc.Name)+".go") + + if dryRun { + fmt.Printf("=== %s ===\n%s\n", clientFile, formatted) + } else { + // Create output directory if needed + if err := os.MkdirAll(outputDir, 0755); err != nil { + return fmt.Errorf("creating output directory: %w", err) + } + + if err := os.WriteFile(clientFile, formatted, 0600); err != nil { + return fmt.Errorf("writing file: %w", err) + } + + if verbose { + fmt.Printf("Generated Go client code: %s\n", clientFile) + } + } + + // Also generate stub file for non-WASM platforms + return generateGoClientStubCode(svc, outputDir, pkgName, dryRun, verbose) +} + +// generateGoClientStubCode generates stub code for non-WASM platforms. +func generateGoClientStubCode(svc internal.Service, outputDir, pkgName string, dryRun, verbose bool) error { + code, err := internal.GenerateClientGoStub(svc, pkgName) + if err != nil { + return fmt.Errorf("generating stub code: %w", err) + } + + formatted, err := format.Source(code) + if err != nil { + return fmt.Errorf("formatting stub code: %w\nRaw code:\n%s", err, code) + } + + // Stub code goes directly in output directory with _stub suffix + stubFile := filepath.Join(outputDir, "nd_host_"+strings.ToLower(svc.Name)+"_stub.go") + + if dryRun { + fmt.Printf("=== %s ===\n%s\n", stubFile, formatted) + return nil + } + + // Create output directory if needed + if err := os.MkdirAll(outputDir, 0755); err != nil { + return fmt.Errorf("creating output directory: %w", err) + } + + if err := os.WriteFile(stubFile, formatted, 0600); err != nil { + return fmt.Errorf("writing stub file: %w", err) + } + + if verbose { + fmt.Printf("Generated Go client stub: %s\n", stubFile) + } + return nil +} + +// generatePythonClientCode generates Python client-side code for a service. +func generatePythonClientCode(svc internal.Service, outputDir string, dryRun, verbose bool) error { + code, err := internal.GenerateClientPython(svc) + if err != nil { + return fmt.Errorf("generating code: %w", err) + } + + // Python code goes directly in the output directory + clientFile := filepath.Join(outputDir, "nd_host_"+strings.ToLower(svc.Name)+".py") + + if dryRun { + fmt.Printf("=== %s ===\n%s\n", clientFile, code) + return nil + } + + // Create output directory if needed + if err := os.MkdirAll(outputDir, 0755); err != nil { + return fmt.Errorf("creating python client directory: %w", err) + } + + if err := os.WriteFile(clientFile, code, 0600); err != nil { + return fmt.Errorf("writing file: %w", err) + } + + if verbose { + fmt.Printf("Generated Python client code: %s\n", clientFile) + } + return nil +} + +// generateRustClientCode generates Rust client-side code for a service. +func generateRustClientCode(svc internal.Service, outputDir string, dryRun, verbose bool) error { + code, err := internal.GenerateClientRust(svc) + if err != nil { + return fmt.Errorf("generating code: %w", err) + } + + // Rust code goes in src/ subdirectory (standard Rust convention) + srcDir := filepath.Join(outputDir, "src") + clientFile := filepath.Join(srcDir, "nd_host_"+strings.ToLower(svc.Name)+".rs") + + if dryRun { + fmt.Printf("=== %s ===\n%s\n", clientFile, code) + return nil + } + + // Create src directory if needed + if err := os.MkdirAll(srcDir, 0755); err != nil { + return fmt.Errorf("creating rust src directory: %w", err) + } + + if err := os.WriteFile(clientFile, code, 0600); err != nil { + return fmt.Errorf("writing file: %w", err) + } + + if verbose { + fmt.Printf("Generated Rust client code: %s\n", clientFile) + } + return nil +} + +// generateRustLibFile generates the lib.rs file that exposes all Rust modules. +func generateRustLibFile(services []internal.Service, outputDir string, dryRun, verbose bool) error { + code, err := internal.GenerateRustLib(services) + if err != nil { + return fmt.Errorf("generating lib.rs: %w", err) + } + + // lib.rs goes in src/ subdirectory (standard Rust convention) + srcDir := filepath.Join(outputDir, "src") + libFile := filepath.Join(srcDir, "lib.rs") + + if dryRun { + fmt.Printf("=== %s ===\n%s\n", libFile, code) + return nil + } + + // Create src directory if needed + if err := os.MkdirAll(srcDir, 0755); err != nil { + return fmt.Errorf("creating rust src directory: %w", err) + } + + if err := os.WriteFile(libFile, code, 0600); err != nil { + return fmt.Errorf("writing file: %w", err) + } + + if verbose { + fmt.Printf("Generated Rust lib.rs: %s\n", libFile) + } + return nil +} + +// generateGoDocFile generates the doc.go file for the Go library. +func generateGoDocFile(services []internal.Service, outputDir, pkgName string, dryRun, verbose bool) error { + code, err := internal.GenerateGoDoc(services, pkgName) + if err != nil { + return fmt.Errorf("generating doc.go: %w", err) + } + + formatted, err := format.Source(code) + if err != nil { + return fmt.Errorf("formatting doc.go: %w\nRaw code:\n%s", err, code) + } + + docFile := filepath.Join(outputDir, "doc.go") + + if dryRun { + fmt.Printf("=== %s ===\n%s\n", docFile, formatted) + return nil + } + + // Create output directory if needed + if err := os.MkdirAll(outputDir, 0755); err != nil { + return fmt.Errorf("creating output directory: %w", err) + } + + if err := os.WriteFile(docFile, formatted, 0600); err != nil { + return fmt.Errorf("writing file: %w", err) + } + + if verbose { + fmt.Printf("Generated Go doc.go: %s\n", docFile) + } + return nil +} + +// generateGoModFile generates the go.mod file for the Go library. +// The go.mod is placed at the parent directory ($output/go/) to create a unified +// module that includes both host wrappers and capabilities. +func generateGoModFile(outputDir string, dryRun, verbose bool) error { + code, err := internal.GenerateGoMod() + if err != nil { + return fmt.Errorf("generating go.mod: %w", err) + } + + // Output to parent directory ($output/go/) instead of host directory + parentDir := filepath.Dir(outputDir) + modFile := filepath.Join(parentDir, "go.mod") + + if dryRun { + fmt.Printf("=== %s ===\n%s\n", modFile, code) + return nil + } + + // Create parent directory if needed + if err := os.MkdirAll(parentDir, 0755); err != nil { + return fmt.Errorf("creating output directory: %w", err) + } + + if err := os.WriteFile(modFile, code, 0600); err != nil { + return fmt.Errorf("writing file: %w", err) + } + + if verbose { + fmt.Printf("Generated Go go.mod: %s\n", modFile) + } + return nil +} + +// generateSchemas generates XTP YAML schemas from capabilities. +func generateSchemas(cfg *config, capabilities []internal.Capability) error { + for _, cap := range capabilities { + if err := generateSchemaFile(cap, cfg.inputDir, cfg.dryRun, cfg.verbose); err != nil { + return fmt.Errorf("generating schema for %s: %w", cap.Name, err) + } + } + return nil +} + +// generateSchemaFile generates an XTP YAML schema file for a capability. +func generateSchemaFile(cap internal.Capability, outputDir string, dryRun, verbose bool) error { + schema, err := internal.GenerateSchema(cap) + if err != nil { + return fmt.Errorf("generating schema: %w", err) + } + + // Validate the generated schema against XTP JSONSchema spec + if err := internal.ValidateXTPSchema(schema); err != nil { + fmt.Fprintf(os.Stderr, "Warning: Schema validation for %s:\n%s\n", cap.Name, err) + } + + // Use the source file name: websocket_callback.go -> websocket_callback.yaml + schemaFile := filepath.Join(outputDir, cap.SourceFile+".yaml") + + if dryRun { + fmt.Printf("=== %s ===\n%s\n", schemaFile, schema) + return nil + } + + if err := os.WriteFile(schemaFile, schema, 0600); err != nil { + return fmt.Errorf("writing file: %w", err) + } + + if verbose { + fmt.Printf("Generated XTP schema: %s\n", schemaFile) + } + return nil +} diff --git a/plugins/cmd/ndpgen/ndpgen_suite_test.go b/plugins/cmd/ndpgen/ndpgen_suite_test.go new file mode 100644 index 000000000..543fe8876 --- /dev/null +++ b/plugins/cmd/ndpgen/ndpgen_suite_test.go @@ -0,0 +1,13 @@ +package main + +import ( + "testing" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestNdpgen(t *testing.T) { + RegisterFailHandler(Fail) + RunSpecs(t, "NDPGen CLI Suite") +} diff --git a/plugins/cmd/ndpgen/testdata/codec_client_expected.go.txt b/plugins/cmd/ndpgen/testdata/codec_client_expected.go.txt new file mode 100644 index 000000000..93d5cb27c --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/codec_client_expected.go.txt @@ -0,0 +1,63 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Codec host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package ndhost + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// codec_encode is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user codec_encode +func codec_encode(uint64) uint64 + +type codecEncodeRequest struct { + Data []byte `json:"data"` +} + +type codecEncodeResponse struct { + Result []byte `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// CodecEncode calls the codec_encode host function. +func CodecEncode(data []byte) ([]byte, error) { + // Marshal request to JSON + req := codecEncodeRequest{ + Data: data, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return nil, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := codec_encode(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response codecEncodeResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return nil, err + } + + // Convert Error field to Go error + if response.Error != "" { + return nil, errors.New(response.Error) + } + + return response.Result, nil +} diff --git a/plugins/cmd/ndpgen/testdata/codec_client_expected.py b/plugins/cmd/ndpgen/testdata/codec_client_expected.py new file mode 100644 index 000000000..5142ffd0e --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/codec_client_expected.py @@ -0,0 +1,53 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Codec host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json +import base64 + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "codec_encode") +def _codec_encode(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def codec_encode(data: bytes) -> bytes: + """Call the codec_encode host function. + + Args: + data: bytes parameter. + + Returns: + bytes: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "data": base64.b64encode(data).decode("ascii"), + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _codec_encode(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return base64.b64decode(response.get("result", "")) diff --git a/plugins/cmd/ndpgen/testdata/codec_client_expected.rs b/plugins/cmd/ndpgen/testdata/codec_client_expected.rs new file mode 100644 index 000000000..3e229ea8a --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/codec_client_expected.rs @@ -0,0 +1,76 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Codec host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; +use base64::Engine as _; +use base64::engine::general_purpose::STANDARD as BASE64; + +mod base64_bytes { + use serde::{self, Deserialize, Deserializer, Serializer}; + use base64::Engine as _; + use base64::engine::general_purpose::STANDARD as BASE64; + + pub fn serialize(bytes: &Vec, serializer: S) -> Result + where + S: Serializer, + { + serializer.serialize_str(&BASE64.encode(bytes)) + } + + pub fn deserialize<'de, D>(deserializer: D) -> Result, D::Error> + where + D: Deserializer<'de>, + { + let s = String::deserialize(deserializer)?; + BASE64.decode(&s).map_err(serde::de::Error::custom) + } +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct CodecEncodeRequest { + #[serde(with = "base64_bytes")] + data: Vec, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct CodecEncodeResponse { + #[serde(default)] + #[serde(with = "base64_bytes")] + result: Vec, + #[serde(default)] + error: Option, +} + +#[host_fn] +extern "ExtismHost" { + fn codec_encode(input: Json) -> Json; +} + +/// Calls the codec_encode host function. +/// +/// # Arguments +/// * `data` - Vec parameter. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn encode(data: Vec) -> Result, Error> { + let response = unsafe { + codec_encode(Json(CodecEncodeRequest { + data: data, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} diff --git a/plugins/cmd/ndpgen/testdata/codec_expected.go.txt b/plugins/cmd/ndpgen/testdata/codec_expected.go.txt new file mode 100644 index 000000000..8655e49c8 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/codec_expected.go.txt @@ -0,0 +1,88 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package testpkg + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// CodecEncodeRequest is the request type for Codec.Encode. +type CodecEncodeRequest struct { + Data []byte `json:"data"` +} + +// CodecEncodeResponse is the response type for Codec.Encode. +type CodecEncodeResponse struct { + Result []byte `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// RegisterCodecHostFunctions registers Codec service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterCodecHostFunctions(service CodecService) []extism.HostFunction { + return []extism.HostFunction{ + newCodecEncodeHostFunction(service), + } +} + +func newCodecEncodeHostFunction(service CodecService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "codec_encode", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + codecWriteError(p, stack, err) + return + } + var req CodecEncodeRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + codecWriteError(p, stack, err) + return + } + + // Call the service method + result, svcErr := service.Encode(ctx, req.Data) + if svcErr != nil { + codecWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := CodecEncodeResponse{ + Result: result, + } + codecWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// codecWriteResponse writes a JSON response to plugin memory. +func codecWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + codecWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// codecWriteError writes an error response to plugin memory. +func codecWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/cmd/ndpgen/testdata/codec_service.go.txt b/plugins/cmd/ndpgen/testdata/codec_service.go.txt new file mode 100644 index 000000000..94a1b71db --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/codec_service.go.txt @@ -0,0 +1,9 @@ +package testpkg + +import "context" + +//nd:hostservice name=Codec permission=codec +type CodecService interface { + //nd:hostfunc + Encode(ctx context.Context, data []byte) ([]byte, error) +} diff --git a/plugins/cmd/ndpgen/testdata/comprehensive_client_expected.py b/plugins/cmd/ndpgen/testdata/comprehensive_client_expected.py new file mode 100644 index 000000000..93370ddcf --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/comprehensive_client_expected.py @@ -0,0 +1,342 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Comprehensive host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json +import base64 + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "comprehensive_simpleparams") +def _comprehensive_simpleparams(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "comprehensive_structparam") +def _comprehensive_structparam(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "comprehensive_mixedparams") +def _comprehensive_mixedparams(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "comprehensive_noerror") +def _comprehensive_noerror(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "comprehensive_noparams") +def _comprehensive_noparams(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "comprehensive_noparamsnoreturns") +def _comprehensive_noparamsnoreturns(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "comprehensive_pointerparams") +def _comprehensive_pointerparams(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "comprehensive_mapparams") +def _comprehensive_mapparams(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "comprehensive_multiplereturns") +def _comprehensive_multiplereturns(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "comprehensive_byteslice") +def _comprehensive_byteslice(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@dataclass +class ComprehensiveMultipleReturnsResult: + """Result type for comprehensive_multiple_returns.""" + results: Any + total: int + + +def comprehensive_simple_params(name: str, count: int) -> str: + """Call the comprehensive_simpleparams host function. + + Args: + name: str parameter. + count: int parameter. + + Returns: + str: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "name": name, + "count": count, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _comprehensive_simpleparams(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("result", "") + + +def comprehensive_struct_param(user: Any) -> None: + """Call the comprehensive_structparam host function. + + Args: + user: Any parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "user": user, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _comprehensive_structparam(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + + +def comprehensive_mixed_params(id: str, filter: Any) -> int: + """Call the comprehensive_mixedparams host function. + + Args: + id: str parameter. + filter: Any parameter. + + Returns: + int: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "id": id, + "filter": filter, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _comprehensive_mixedparams(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("result", 0) + + +def comprehensive_no_error(name: str) -> str: + """Call the comprehensive_noerror host function. + + Args: + name: str parameter. + + Returns: + str: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "name": name, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _comprehensive_noerror(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("result", "") + + +def comprehensive_no_params() -> None: + """Call the comprehensive_noparams host function. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request_bytes = b"{}" + request_mem = extism.memory.alloc(request_bytes) + response_offset = _comprehensive_noparams(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + + +def comprehensive_no_params_no_returns() -> None: + """Call the comprehensive_noparamsnoreturns host function. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request_bytes = b"{}" + request_mem = extism.memory.alloc(request_bytes) + response_offset = _comprehensive_noparamsnoreturns(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + + +def comprehensive_pointer_params(id: Any, user: Any) -> Any: + """Call the comprehensive_pointerparams host function. + + Args: + id: Any parameter. + user: Any parameter. + + Returns: + Any: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "id": id, + "user": user, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _comprehensive_pointerparams(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("result", None) + + +def comprehensive_map_params(data: Any) -> Any: + """Call the comprehensive_mapparams host function. + + Args: + data: Any parameter. + + Returns: + Any: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "data": data, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _comprehensive_mapparams(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("result", None) + + +def comprehensive_multiple_returns(query: str) -> ComprehensiveMultipleReturnsResult: + """Call the comprehensive_multiplereturns host function. + + Args: + query: str parameter. + + Returns: + ComprehensiveMultipleReturnsResult containing results, total,. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "query": query, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _comprehensive_multiplereturns(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return ComprehensiveMultipleReturnsResult( + results=response.get("results", None), + total=response.get("total", 0), + ) + + +def comprehensive_byte_slice(data: bytes) -> bytes: + """Call the comprehensive_byteslice host function. + + Args: + data: bytes parameter. + + Returns: + bytes: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "data": base64.b64encode(data).decode("ascii"), + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _comprehensive_byteslice(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return base64.b64decode(response.get("result", "")) diff --git a/plugins/cmd/ndpgen/testdata/comprehensive_client_expected.rs b/plugins/cmd/ndpgen/testdata/comprehensive_client_expected.rs new file mode 100644 index 000000000..08dae2901 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/comprehensive_client_expected.rs @@ -0,0 +1,423 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Comprehensive host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; +use base64::Engine as _; +use base64::engine::general_purpose::STANDARD as BASE64; + +mod base64_bytes { + use serde::{self, Deserialize, Deserializer, Serializer}; + use base64::Engine as _; + use base64::engine::general_purpose::STANDARD as BASE64; + + pub fn serialize(bytes: &Vec, serializer: S) -> Result + where + S: Serializer, + { + serializer.serialize_str(&BASE64.encode(bytes)) + } + + pub fn deserialize<'de, D>(deserializer: D) -> Result, D::Error> + where + D: Deserializer<'de>, + { + let s = String::deserialize(deserializer)?; + BASE64.decode(&s).map_err(serde::de::Error::custom) + } +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct User2 { + pub id: String, + pub name: String, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct Filter2 { + pub active: bool, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensiveSimpleParamsRequest { + name: String, + count: i32, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensiveSimpleParamsResponse { + #[serde(default)] + result: String, + #[serde(default)] + error: Option, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensiveStructParamRequest { + user: User2, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensiveStructParamResponse { + #[serde(default)] + error: Option, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensiveMixedParamsRequest { + id: String, + filter: Filter2, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensiveMixedParamsResponse { + #[serde(default)] + result: i32, + #[serde(default)] + error: Option, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensiveNoErrorRequest { + name: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensiveNoErrorResponse { + #[serde(default)] + result: String, + #[serde(default)] + error: Option, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensiveNoParamsResponse { + #[serde(default)] + error: Option, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensiveNoParamsNoReturnsResponse { + #[serde(default)] + error: Option, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensivePointerParamsRequest { + id: Option, + user: Option, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensivePointerParamsResponse { + #[serde(default)] + result: Option, + #[serde(default)] + error: Option, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensiveMapParamsRequest { + data: std::collections::HashMap, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensiveMapParamsResponse { + #[serde(default)] + result: serde_json::Value, + #[serde(default)] + error: Option, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensiveMultipleReturnsRequest { + query: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensiveMultipleReturnsResponse { + #[serde(default)] + results: Vec, + #[serde(default)] + total: i32, + #[serde(default)] + error: Option, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensiveByteSliceRequest { + #[serde(with = "base64_bytes")] + data: Vec, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensiveByteSliceResponse { + #[serde(default)] + #[serde(with = "base64_bytes")] + result: Vec, + #[serde(default)] + error: Option, +} + +#[host_fn] +extern "ExtismHost" { + fn comprehensive_simpleparams(input: Json) -> Json; + fn comprehensive_structparam(input: Json) -> Json; + fn comprehensive_mixedparams(input: Json) -> Json; + fn comprehensive_noerror(input: Json) -> Json; + fn comprehensive_noparams(input: Json) -> Json; + fn comprehensive_noparamsnoreturns(input: Json) -> Json; + fn comprehensive_pointerparams(input: Json) -> Json; + fn comprehensive_mapparams(input: Json) -> Json; + fn comprehensive_multiplereturns(input: Json) -> Json; + fn comprehensive_byteslice(input: Json) -> Json; +} + +/// Calls the comprehensive_simpleparams host function. +/// +/// # Arguments +/// * `name` - String parameter. +/// * `count` - i32 parameter. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn simple_params(name: &str, count: i32) -> Result { + let response = unsafe { + comprehensive_simpleparams(Json(ComprehensiveSimpleParamsRequest { + name: name.to_owned(), + count: count, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} + +/// Calls the comprehensive_structparam host function. +/// +/// # Arguments +/// * `user` - User2 parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn struct_param(user: User2) -> Result<(), Error> { + let response = unsafe { + comprehensive_structparam(Json(ComprehensiveStructParamRequest { + user: user, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} + +/// Calls the comprehensive_mixedparams host function. +/// +/// # Arguments +/// * `id` - String parameter. +/// * `filter` - Filter2 parameter. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn mixed_params(id: &str, filter: Filter2) -> Result { + let response = unsafe { + comprehensive_mixedparams(Json(ComprehensiveMixedParamsRequest { + id: id.to_owned(), + filter: filter, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} + +/// Calls the comprehensive_noerror host function. +/// +/// # Arguments +/// * `name` - String parameter. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn no_error(name: &str) -> Result { + let response = unsafe { + comprehensive_noerror(Json(ComprehensiveNoErrorRequest { + name: name.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} + +/// Calls the comprehensive_noparams host function. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn no_params() -> Result<(), Error> { + let response = unsafe { + comprehensive_noparams(Json(serde_json::json!({})))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} + +/// Calls the comprehensive_noparamsnoreturns host function. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn no_params_no_returns() -> Result<(), Error> { + let response = unsafe { + comprehensive_noparamsnoreturns(Json(serde_json::json!({})))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} + +/// Calls the comprehensive_pointerparams host function. +/// +/// # Arguments +/// * `id` - Option parameter. +/// * `user` - Option parameter. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn pointer_params(id: Option, user: Option) -> Result, Error> { + let response = unsafe { + comprehensive_pointerparams(Json(ComprehensivePointerParamsRequest { + id: id, + user: user, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} + +/// Calls the comprehensive_mapparams host function. +/// +/// # Arguments +/// * `data` - std::collections::HashMap parameter. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn map_params(data: std::collections::HashMap) -> Result { + let response = unsafe { + comprehensive_mapparams(Json(ComprehensiveMapParamsRequest { + data: data, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} + +/// Calls the comprehensive_multiplereturns host function. +/// +/// # Arguments +/// * `query` - String parameter. +/// +/// # Returns +/// A tuple of (results, total). +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn multiple_returns(query: &str) -> Result<(Vec, i32), Error> { + let response = unsafe { + comprehensive_multiplereturns(Json(ComprehensiveMultipleReturnsRequest { + query: query.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok((response.0.results, response.0.total)) +} + +/// Calls the comprehensive_byteslice host function. +/// +/// # Arguments +/// * `data` - Vec parameter. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn byte_slice(data: Vec) -> Result, Error> { + let response = unsafe { + comprehensive_byteslice(Json(ComprehensiveByteSliceRequest { + data: data, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} diff --git a/plugins/cmd/ndpgen/testdata/comprehensive_service.go.txt b/plugins/cmd/ndpgen/testdata/comprehensive_service.go.txt new file mode 100644 index 000000000..3a9a1bfc4 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/comprehensive_service.go.txt @@ -0,0 +1,36 @@ +package testpkg + +import "context" + +type User2 struct { + ID string + Name string +} + +type Filter2 struct { + Active bool +} + +//nd:hostservice name=Comprehensive permission=comprehensive +type ComprehensiveService interface { + //nd:hostfunc + SimpleParams(ctx context.Context, name string, count int32) (string, error) + //nd:hostfunc + StructParam(ctx context.Context, user User2) error + //nd:hostfunc + MixedParams(ctx context.Context, id string, filter Filter2) (int32, error) + //nd:hostfunc + NoError(ctx context.Context, name string) string + //nd:hostfunc + NoParams(ctx context.Context) error + //nd:hostfunc + NoParamsNoReturns(ctx context.Context) + //nd:hostfunc + PointerParams(ctx context.Context, id *string, user *User2) (*User2, error) + //nd:hostfunc + MapParams(ctx context.Context, data map[string]any) (interface{}, error) + //nd:hostfunc + MultipleReturns(ctx context.Context, query string) (results []User2, total int32, err error) + //nd:hostfunc + ByteSlice(ctx context.Context, data []byte) ([]byte, error) +} diff --git a/plugins/cmd/ndpgen/testdata/config_client_expected.go.txt b/plugins/cmd/ndpgen/testdata/config_client_expected.go.txt new file mode 100644 index 000000000..c88fb930b --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/config_client_expected.go.txt @@ -0,0 +1,156 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Config host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package ndhost + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// config_get is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user config_get +func config_get(uint64) uint64 + +// config_set is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user config_set +func config_set(uint64) uint64 + +// config_has is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user config_has +func config_has(uint64) uint64 + +type configGetRequest struct { + Key string `json:"key"` +} + +type configGetResponse struct { + Value string `json:"value,omitempty"` + Exists bool `json:"exists,omitempty"` + Error string `json:"error,omitempty"` +} + +type configSetRequest struct { + Key string `json:"key"` + Value string `json:"value"` +} + +type configHasRequest struct { + Key string `json:"key"` +} + +type configHasResponse struct { + Exists bool `json:"exists,omitempty"` + Error string `json:"error,omitempty"` +} + +// ConfigGet calls the config_get host function. +func ConfigGet(key string) (string, bool, error) { + // Marshal request to JSON + req := configGetRequest{ + Key: key, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return "", false, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := config_get(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response configGetResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return "", false, err + } + + // Convert Error field to Go error + if response.Error != "" { + return "", false, errors.New(response.Error) + } + + return response.Value, response.Exists, nil +} + +// ConfigSet calls the config_set host function. +func ConfigSet(key string, value string) error { + // Marshal request to JSON + req := configSetRequest{ + Key: key, + Value: value, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := config_set(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} + +// ConfigHas calls the config_has host function. +func ConfigHas(key string) (bool, error) { + // Marshal request to JSON + req := configHasRequest{ + Key: key, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return false, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := config_has(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response configHasResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return false, err + } + + // Convert Error field to Go error + if response.Error != "" { + return false, errors.New(response.Error) + } + + return response.Exists, nil +} diff --git a/plugins/cmd/ndpgen/testdata/config_client_expected.py b/plugins/cmd/ndpgen/testdata/config_client_expected.py new file mode 100644 index 000000000..370de6d10 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/config_client_expected.py @@ -0,0 +1,126 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Config host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "config_get") +def _config_get(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "config_set") +def _config_set(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "config_has") +def _config_has(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@dataclass +class ConfigGetResult: + """Result type for config_get.""" + value: str + exists: bool + + +def config_get(key: str) -> ConfigGetResult: + """Call the config_get host function. + + Args: + key: str parameter. + + Returns: + ConfigGetResult containing value, exists,. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _config_get(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return ConfigGetResult( + value=response.get("value", ""), + exists=response.get("exists", False), + ) + + +def config_set(key: str, value: str) -> None: + """Call the config_set host function. + + Args: + key: str parameter. + value: str parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + "value": value, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _config_set(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + + +def config_has(key: str) -> bool: + """Call the config_has host function. + + Args: + key: str parameter. + + Returns: + bool: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _config_has(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("exists", False) diff --git a/plugins/cmd/ndpgen/testdata/config_client_expected.rs b/plugins/cmd/ndpgen/testdata/config_client_expected.rs new file mode 100644 index 000000000..154d01b0c --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/config_client_expected.rs @@ -0,0 +1,135 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Config host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ConfigGetRequest { + key: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ConfigGetResponse { + #[serde(default)] + value: String, + #[serde(default)] + exists: bool, + #[serde(default)] + error: Option, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ConfigSetRequest { + key: String, + value: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ConfigSetResponse { + #[serde(default)] + error: Option, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ConfigHasRequest { + key: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ConfigHasResponse { + #[serde(default)] + exists: bool, + #[serde(default)] + error: Option, +} + +#[host_fn] +extern "ExtismHost" { + fn config_get(input: Json) -> Json; + fn config_set(input: Json) -> Json; + fn config_has(input: Json) -> Json; +} + +/// Calls the config_get host function. +/// +/// # Arguments +/// * `key` - String parameter. +/// +/// # Returns +/// `Some(value)` if found, `None` otherwise. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get(key: &str) -> Result, Error> { + let response = unsafe { + config_get(Json(ConfigGetRequest { + key: key.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + if response.0.exists { + Ok(Some(response.0.value)) + } else { + Ok(None) + } +} + +/// Calls the config_set host function. +/// +/// # Arguments +/// * `key` - String parameter. +/// * `value` - String parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn set(key: &str, value: &str) -> Result<(), Error> { + let response = unsafe { + config_set(Json(ConfigSetRequest { + key: key.to_owned(), + value: value.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} + +/// Calls the config_has host function. +/// +/// # Arguments +/// * `key` - String parameter. +/// +/// # Returns +/// The exists value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn has(key: &str) -> Result { + let response = unsafe { + config_has(Json(ConfigHasRequest { + key: key.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.exists) +} diff --git a/plugins/cmd/ndpgen/testdata/config_service.go.txt b/plugins/cmd/ndpgen/testdata/config_service.go.txt new file mode 100644 index 000000000..5def79302 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/config_service.go.txt @@ -0,0 +1,15 @@ +package testpkg + +import "context" + +//nd:hostservice name=Config permission=config +type ConfigService interface { + //nd:hostfunc + Get(ctx context.Context, key string) (value string, exists bool, err error) + + //nd:hostfunc + Set(ctx context.Context, key string, value string) error + + //nd:hostfunc + Has(ctx context.Context, key string) (exists bool, err error) +} diff --git a/plugins/cmd/ndpgen/testdata/counter_client_expected.go.txt b/plugins/cmd/ndpgen/testdata/counter_client_expected.go.txt new file mode 100644 index 000000000..3fbb53727 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/counter_client_expected.go.txt @@ -0,0 +1,56 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Counter host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package ndhost + +import ( + "encoding/json" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// counter_count is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user counter_count +func counter_count(uint64) uint64 + +type counterCountRequest struct { + Name string `json:"name"` +} + +type counterCountResponse struct { + Value int32 `json:"value,omitempty"` +} + +// CounterCount calls the counter_count host function. +func CounterCount(name string) int32 { + // Marshal request to JSON + req := counterCountRequest{ + Name: name, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return 0 + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := counter_count(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response counterCountResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return 0 + } + + return response.Value +} diff --git a/plugins/cmd/ndpgen/testdata/counter_client_expected.py b/plugins/cmd/ndpgen/testdata/counter_client_expected.py new file mode 100644 index 000000000..872d407bb --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/counter_client_expected.py @@ -0,0 +1,49 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Counter host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "counter_count") +def _counter_count(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def counter_count(name: str) -> int: + """Call the counter_count host function. + + Args: + name: str parameter. + + Returns: + int: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "name": name, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _counter_count(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + return response.get("value", 0) diff --git a/plugins/cmd/ndpgen/testdata/counter_client_expected.rs b/plugins/cmd/ndpgen/testdata/counter_client_expected.rs new file mode 100644 index 000000000..a58dd8e1e --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/counter_client_expected.rs @@ -0,0 +1,45 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Counter host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct CounterCountRequest { + name: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct CounterCountResponse { + #[serde(default)] + value: i32, +} + +#[host_fn] +extern "ExtismHost" { + fn counter_count(input: Json) -> Json; +} + +/// Calls the counter_count host function. +/// +/// # Arguments +/// * `name` - String parameter. +/// +/// # Returns +/// The value value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn count(name: &str) -> Result { + let response = unsafe { + counter_count(Json(CounterCountRequest { + name: name.to_owned(), + }))? + }; + + Ok(response.0.value) +} diff --git a/plugins/cmd/ndpgen/testdata/counter_expected.go.txt b/plugins/cmd/ndpgen/testdata/counter_expected.go.txt new file mode 100644 index 000000000..7fd1cbb84 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/counter_expected.go.txt @@ -0,0 +1,83 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package testpkg + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// CounterCountRequest is the request type for Counter.Count. +type CounterCountRequest struct { + Name string `json:"name"` +} + +// CounterCountResponse is the response type for Counter.Count. +type CounterCountResponse struct { + Value int32 `json:"value,omitempty"` +} + +// RegisterCounterHostFunctions registers Counter service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterCounterHostFunctions(service CounterService) []extism.HostFunction { + return []extism.HostFunction{ + newCounterCountHostFunction(service), + } +} + +func newCounterCountHostFunction(service CounterService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "counter_count", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + counterWriteError(p, stack, err) + return + } + var req CounterCountRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + counterWriteError(p, stack, err) + return + } + + // Call the service method + value := service.Count(ctx, req.Name) + + // Write JSON response to plugin memory + resp := CounterCountResponse{ + Value: value, + } + counterWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// counterWriteResponse writes a JSON response to plugin memory. +func counterWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + counterWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// counterWriteError writes an error response to plugin memory. +func counterWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/cmd/ndpgen/testdata/counter_service.go.txt b/plugins/cmd/ndpgen/testdata/counter_service.go.txt new file mode 100644 index 000000000..456599031 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/counter_service.go.txt @@ -0,0 +1,9 @@ +package testpkg + +import "context" + +//nd:hostservice name=Counter permission=counter +type CounterService interface { + //nd:hostfunc + Count(ctx context.Context, name string) (value int32) +} diff --git a/plugins/cmd/ndpgen/testdata/echo_client_expected.go.txt b/plugins/cmd/ndpgen/testdata/echo_client_expected.go.txt new file mode 100644 index 000000000..7a495acf4 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/echo_client_expected.go.txt @@ -0,0 +1,63 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Echo host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package ndhost + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// echo_echo is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user echo_echo +func echo_echo(uint64) uint64 + +type echoEchoRequest struct { + Message string `json:"message"` +} + +type echoEchoResponse struct { + Reply string `json:"reply,omitempty"` + Error string `json:"error,omitempty"` +} + +// EchoEcho calls the echo_echo host function. +func EchoEcho(message string) (string, error) { + // Marshal request to JSON + req := echoEchoRequest{ + Message: message, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return "", err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := echo_echo(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response echoEchoResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return "", err + } + + // Convert Error field to Go error + if response.Error != "" { + return "", errors.New(response.Error) + } + + return response.Reply, nil +} diff --git a/plugins/cmd/ndpgen/testdata/echo_client_expected.py b/plugins/cmd/ndpgen/testdata/echo_client_expected.py new file mode 100644 index 000000000..06565b0d6 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/echo_client_expected.py @@ -0,0 +1,52 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Echo host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "echo_echo") +def _echo_echo(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def echo_echo(message: str) -> str: + """Call the echo_echo host function. + + Args: + message: str parameter. + + Returns: + str: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "message": message, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _echo_echo(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("reply", "") diff --git a/plugins/cmd/ndpgen/testdata/echo_client_expected.rs b/plugins/cmd/ndpgen/testdata/echo_client_expected.rs new file mode 100644 index 000000000..0b97ca1cd --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/echo_client_expected.rs @@ -0,0 +1,51 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Echo host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct EchoEchoRequest { + message: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct EchoEchoResponse { + #[serde(default)] + reply: String, + #[serde(default)] + error: Option, +} + +#[host_fn] +extern "ExtismHost" { + fn echo_echo(input: Json) -> Json; +} + +/// Calls the echo_echo host function. +/// +/// # Arguments +/// * `message` - String parameter. +/// +/// # Returns +/// The reply value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn echo(message: &str) -> Result { + let response = unsafe { + echo_echo(Json(EchoEchoRequest { + message: message.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.reply) +} diff --git a/plugins/cmd/ndpgen/testdata/echo_expected.go.txt b/plugins/cmd/ndpgen/testdata/echo_expected.go.txt new file mode 100644 index 000000000..d67854abf --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/echo_expected.go.txt @@ -0,0 +1,88 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package testpkg + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// EchoEchoRequest is the request type for Echo.Echo. +type EchoEchoRequest struct { + Message string `json:"message"` +} + +// EchoEchoResponse is the response type for Echo.Echo. +type EchoEchoResponse struct { + Reply string `json:"reply,omitempty"` + Error string `json:"error,omitempty"` +} + +// RegisterEchoHostFunctions registers Echo service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterEchoHostFunctions(service EchoService) []extism.HostFunction { + return []extism.HostFunction{ + newEchoEchoHostFunction(service), + } +} + +func newEchoEchoHostFunction(service EchoService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "echo_echo", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + echoWriteError(p, stack, err) + return + } + var req EchoEchoRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + echoWriteError(p, stack, err) + return + } + + // Call the service method + reply, svcErr := service.Echo(ctx, req.Message) + if svcErr != nil { + echoWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := EchoEchoResponse{ + Reply: reply, + } + echoWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// echoWriteResponse writes a JSON response to plugin memory. +func echoWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + echoWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// echoWriteError writes an error response to plugin memory. +func echoWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/cmd/ndpgen/testdata/echo_service.go.txt b/plugins/cmd/ndpgen/testdata/echo_service.go.txt new file mode 100644 index 000000000..42a1e9572 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/echo_service.go.txt @@ -0,0 +1,9 @@ +package testpkg + +import "context" + +//nd:hostservice name=Echo permission=echo +type EchoService interface { + //nd:hostfunc + Echo(ctx context.Context, message string) (reply string, err error) +} diff --git a/plugins/cmd/ndpgen/testdata/list_client_expected.go.txt b/plugins/cmd/ndpgen/testdata/list_client_expected.go.txt new file mode 100644 index 000000000..ea825ee43 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/list_client_expected.go.txt @@ -0,0 +1,70 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the List host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package ndhost + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// Filter represents the Filter data structure. +type Filter struct { + Active bool `json:"active"` +} + +// list_items is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user list_items +func list_items(uint64) uint64 + +type listItemsRequest struct { + Name string `json:"name"` + Filter Filter `json:"filter"` +} + +type listItemsResponse struct { + Count int32 `json:"count,omitempty"` + Error string `json:"error,omitempty"` +} + +// ListItems calls the list_items host function. +func ListItems(name string, filter Filter) (int32, error) { + // Marshal request to JSON + req := listItemsRequest{ + Name: name, + Filter: filter, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return 0, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := list_items(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response listItemsResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return 0, err + } + + // Convert Error field to Go error + if response.Error != "" { + return 0, errors.New(response.Error) + } + + return response.Count, nil +} diff --git a/plugins/cmd/ndpgen/testdata/list_client_expected.py b/plugins/cmd/ndpgen/testdata/list_client_expected.py new file mode 100644 index 000000000..58ccad146 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/list_client_expected.py @@ -0,0 +1,54 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the List host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "list_items") +def _list_items(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def list_items(name: str, filter: Any) -> int: + """Call the list_items host function. + + Args: + name: str parameter. + filter: Any parameter. + + Returns: + int: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "name": name, + "filter": filter, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _list_items(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("count", 0) diff --git a/plugins/cmd/ndpgen/testdata/list_client_expected.rs b/plugins/cmd/ndpgen/testdata/list_client_expected.rs new file mode 100644 index 000000000..9b54f7544 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/list_client_expected.rs @@ -0,0 +1,60 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the List host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct Filter { + pub active: bool, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ListItemsRequest { + name: String, + filter: Filter, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ListItemsResponse { + #[serde(default)] + count: i32, + #[serde(default)] + error: Option, +} + +#[host_fn] +extern "ExtismHost" { + fn list_items(input: Json) -> Json; +} + +/// Calls the list_items host function. +/// +/// # Arguments +/// * `name` - String parameter. +/// * `filter` - Filter parameter. +/// +/// # Returns +/// The count value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn items(name: &str, filter: Filter) -> Result { + let response = unsafe { + list_items(Json(ListItemsRequest { + name: name.to_owned(), + filter: filter, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.count) +} diff --git a/plugins/cmd/ndpgen/testdata/list_expected.go.txt b/plugins/cmd/ndpgen/testdata/list_expected.go.txt new file mode 100644 index 000000000..778f3a409 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/list_expected.go.txt @@ -0,0 +1,89 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package testpkg + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// ListItemsRequest is the request type for List.Items. +type ListItemsRequest struct { + Name string `json:"name"` + Filter Filter `json:"filter"` +} + +// ListItemsResponse is the response type for List.Items. +type ListItemsResponse struct { + Count int32 `json:"count,omitempty"` + Error string `json:"error,omitempty"` +} + +// RegisterListHostFunctions registers List service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterListHostFunctions(service ListService) []extism.HostFunction { + return []extism.HostFunction{ + newListItemsHostFunction(service), + } +} + +func newListItemsHostFunction(service ListService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "list_items", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + listWriteError(p, stack, err) + return + } + var req ListItemsRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + listWriteError(p, stack, err) + return + } + + // Call the service method + count, svcErr := service.Items(ctx, req.Name, req.Filter) + if svcErr != nil { + listWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := ListItemsResponse{ + Count: count, + } + listWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// listWriteResponse writes a JSON response to plugin memory. +func listWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + listWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// listWriteError writes an error response to plugin memory. +func listWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/cmd/ndpgen/testdata/list_service.go.txt b/plugins/cmd/ndpgen/testdata/list_service.go.txt new file mode 100644 index 000000000..ff3a42e01 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/list_service.go.txt @@ -0,0 +1,13 @@ +package testpkg + +import "context" + +type Filter struct { + Active bool +} + +//nd:hostservice name=List permission=list +type ListService interface { + //nd:hostfunc + Items(ctx context.Context, name string, filter Filter) (count int32, err error) +} diff --git a/plugins/cmd/ndpgen/testdata/math_client_expected.go.txt b/plugins/cmd/ndpgen/testdata/math_client_expected.go.txt new file mode 100644 index 000000000..9b95b50e9 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/math_client_expected.go.txt @@ -0,0 +1,65 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Math host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package ndhost + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// math_add is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user math_add +func math_add(uint64) uint64 + +type mathAddRequest struct { + A int32 `json:"a"` + B int32 `json:"b"` +} + +type mathAddResponse struct { + Result int32 `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// MathAdd calls the math_add host function. +func MathAdd(a int32, b int32) (int32, error) { + // Marshal request to JSON + req := mathAddRequest{ + A: a, + B: b, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return 0, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := math_add(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response mathAddResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return 0, err + } + + // Convert Error field to Go error + if response.Error != "" { + return 0, errors.New(response.Error) + } + + return response.Result, nil +} diff --git a/plugins/cmd/ndpgen/testdata/math_client_expected.py b/plugins/cmd/ndpgen/testdata/math_client_expected.py new file mode 100644 index 000000000..f3ea53335 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/math_client_expected.py @@ -0,0 +1,54 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Math host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "math_add") +def _math_add(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def math_add(a: int, b: int) -> int: + """Call the math_add host function. + + Args: + a: int parameter. + b: int parameter. + + Returns: + int: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "a": a, + "b": b, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _math_add(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("result", 0) diff --git a/plugins/cmd/ndpgen/testdata/math_client_expected.rs b/plugins/cmd/ndpgen/testdata/math_client_expected.rs new file mode 100644 index 000000000..fde6a7cb9 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/math_client_expected.rs @@ -0,0 +1,54 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Math host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct MathAddRequest { + a: i32, + b: i32, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct MathAddResponse { + #[serde(default)] + result: i32, + #[serde(default)] + error: Option, +} + +#[host_fn] +extern "ExtismHost" { + fn math_add(input: Json) -> Json; +} + +/// Calls the math_add host function. +/// +/// # Arguments +/// * `a` - i32 parameter. +/// * `b` - i32 parameter. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn add(a: i32, b: i32) -> Result { + let response = unsafe { + math_add(Json(MathAddRequest { + a: a, + b: b, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} diff --git a/plugins/cmd/ndpgen/testdata/math_expected.go.txt b/plugins/cmd/ndpgen/testdata/math_expected.go.txt new file mode 100644 index 000000000..48a2bf875 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/math_expected.go.txt @@ -0,0 +1,89 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package testpkg + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// MathAddRequest is the request type for Math.Add. +type MathAddRequest struct { + A int32 `json:"a"` + B int32 `json:"b"` +} + +// MathAddResponse is the response type for Math.Add. +type MathAddResponse struct { + Result int32 `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// RegisterMathHostFunctions registers Math service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterMathHostFunctions(service MathService) []extism.HostFunction { + return []extism.HostFunction{ + newMathAddHostFunction(service), + } +} + +func newMathAddHostFunction(service MathService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "math_add", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + mathWriteError(p, stack, err) + return + } + var req MathAddRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + mathWriteError(p, stack, err) + return + } + + // Call the service method + result, svcErr := service.Add(ctx, req.A, req.B) + if svcErr != nil { + mathWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := MathAddResponse{ + Result: result, + } + mathWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// mathWriteResponse writes a JSON response to plugin memory. +func mathWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + mathWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// mathWriteError writes an error response to plugin memory. +func mathWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/cmd/ndpgen/testdata/math_service.go.txt b/plugins/cmd/ndpgen/testdata/math_service.go.txt new file mode 100644 index 000000000..66776b1da --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/math_service.go.txt @@ -0,0 +1,9 @@ +package testpkg + +import "context" + +//nd:hostservice name=Math permission=math +type MathService interface { + //nd:hostfunc + Add(ctx context.Context, a int32, b int32) (result int32, err error) +} diff --git a/plugins/cmd/ndpgen/testdata/meta_client_expected.go.txt b/plugins/cmd/ndpgen/testdata/meta_client_expected.go.txt new file mode 100644 index 000000000..4147f35f1 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/meta_client_expected.go.txt @@ -0,0 +1,105 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Meta host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package ndhost + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// meta_get is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user meta_get +func meta_get(uint64) uint64 + +// meta_set is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user meta_set +func meta_set(uint64) uint64 + +type metaGetRequest struct { + Key string `json:"key"` +} + +type metaGetResponse struct { + Value any `json:"value,omitempty"` + Error string `json:"error,omitempty"` +} + +type metaSetRequest struct { + Data map[string]any `json:"data"` +} + +// MetaGet calls the meta_get host function. +func MetaGet(key string) (any, error) { + // Marshal request to JSON + req := metaGetRequest{ + Key: key, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return nil, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := meta_get(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response metaGetResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return nil, err + } + + // Convert Error field to Go error + if response.Error != "" { + return nil, errors.New(response.Error) + } + + return response.Value, nil +} + +// MetaSet calls the meta_set host function. +func MetaSet(data map[string]any) error { + // Marshal request to JSON + req := metaSetRequest{ + Data: data, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := meta_set(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} diff --git a/plugins/cmd/ndpgen/testdata/meta_client_expected.py b/plugins/cmd/ndpgen/testdata/meta_client_expected.py new file mode 100644 index 000000000..4d20c73ff --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/meta_client_expected.py @@ -0,0 +1,81 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Meta host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "meta_get") +def _meta_get(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "meta_set") +def _meta_set(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def meta_get(key: str) -> Any: + """Call the meta_get host function. + + Args: + key: str parameter. + + Returns: + Any: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _meta_get(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("value", None) + + +def meta_set(data: Any) -> None: + """Call the meta_set host function. + + Args: + data: Any parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "data": data, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _meta_set(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + diff --git a/plugins/cmd/ndpgen/testdata/meta_client_expected.rs b/plugins/cmd/ndpgen/testdata/meta_client_expected.rs new file mode 100644 index 000000000..79b95ffb3 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/meta_client_expected.rs @@ -0,0 +1,86 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Meta host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct MetaGetRequest { + key: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct MetaGetResponse { + #[serde(default)] + value: serde_json::Value, + #[serde(default)] + error: Option, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct MetaSetRequest { + data: std::collections::HashMap, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct MetaSetResponse { + #[serde(default)] + error: Option, +} + +#[host_fn] +extern "ExtismHost" { + fn meta_get(input: Json) -> Json; + fn meta_set(input: Json) -> Json; +} + +/// Calls the meta_get host function. +/// +/// # Arguments +/// * `key` - String parameter. +/// +/// # Returns +/// The value value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get(key: &str) -> Result { + let response = unsafe { + meta_get(Json(MetaGetRequest { + key: key.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.value) +} + +/// Calls the meta_set host function. +/// +/// # Arguments +/// * `data` - std::collections::HashMap parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn set(data: std::collections::HashMap) -> Result<(), Error> { + let response = unsafe { + meta_set(Json(MetaSetRequest { + data: data, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} diff --git a/plugins/cmd/ndpgen/testdata/meta_expected.go.txt b/plugins/cmd/ndpgen/testdata/meta_expected.go.txt new file mode 100644 index 000000000..6f660fd65 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/meta_expected.go.txt @@ -0,0 +1,130 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package testpkg + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// MetaGetRequest is the request type for Meta.Get. +type MetaGetRequest struct { + Key string `json:"key"` +} + +// MetaGetResponse is the response type for Meta.Get. +type MetaGetResponse struct { + Value any `json:"value,omitempty"` + Error string `json:"error,omitempty"` +} + +// MetaSetRequest is the request type for Meta.Set. +type MetaSetRequest struct { + Data map[string]any `json:"data"` +} + +// MetaSetResponse is the response type for Meta.Set. +type MetaSetResponse struct { + Error string `json:"error,omitempty"` +} + +// RegisterMetaHostFunctions registers Meta service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterMetaHostFunctions(service MetaService) []extism.HostFunction { + return []extism.HostFunction{ + newMetaGetHostFunction(service), + newMetaSetHostFunction(service), + } +} + +func newMetaGetHostFunction(service MetaService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "meta_get", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + metaWriteError(p, stack, err) + return + } + var req MetaGetRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + metaWriteError(p, stack, err) + return + } + + // Call the service method + value, svcErr := service.Get(ctx, req.Key) + if svcErr != nil { + metaWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := MetaGetResponse{ + Value: value, + } + metaWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newMetaSetHostFunction(service MetaService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "meta_set", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + metaWriteError(p, stack, err) + return + } + var req MetaSetRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + metaWriteError(p, stack, err) + return + } + + // Call the service method + if svcErr := service.Set(ctx, req.Data); svcErr != nil { + metaWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := MetaSetResponse{} + metaWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// metaWriteResponse writes a JSON response to plugin memory. +func metaWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + metaWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// metaWriteError writes an error response to plugin memory. +func metaWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/cmd/ndpgen/testdata/meta_service.go.txt b/plugins/cmd/ndpgen/testdata/meta_service.go.txt new file mode 100644 index 000000000..a7b23ecea --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/meta_service.go.txt @@ -0,0 +1,11 @@ +package testpkg + +import "context" + +//nd:hostservice name=Meta permission=meta +type MetaService interface { + //nd:hostfunc + Get(ctx context.Context, key string) (value interface{}, err error) + //nd:hostfunc + Set(ctx context.Context, data map[string]any) error +} diff --git a/plugins/cmd/ndpgen/testdata/ping_client_expected.go.txt b/plugins/cmd/ndpgen/testdata/ping_client_expected.go.txt new file mode 100644 index 000000000..be9668314 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/ping_client_expected.go.txt @@ -0,0 +1,46 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Ping host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package ndhost + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// ping_ping is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user ping_ping +func ping_ping(uint64) uint64 + +// PingPing calls the ping_ping host function. +func PingPing() error { + // No parameters - allocate empty JSON object + reqMem := pdk.AllocateBytes([]byte("{}")) + defer reqMem.Free() + + // Call the host function + responsePtr := ping_ping(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} diff --git a/plugins/cmd/ndpgen/testdata/ping_client_expected.py b/plugins/cmd/ndpgen/testdata/ping_client_expected.py new file mode 100644 index 000000000..4c7d41d8e --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/ping_client_expected.py @@ -0,0 +1,42 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Ping host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "ping_ping") +def _ping_ping(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def ping_ping() -> None: + """Call the ping_ping host function. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request_bytes = b"{}" + request_mem = extism.memory.alloc(request_bytes) + response_offset = _ping_ping(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + diff --git a/plugins/cmd/ndpgen/testdata/ping_client_expected.rs b/plugins/cmd/ndpgen/testdata/ping_client_expected.rs new file mode 100644 index 000000000..a40f10843 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/ping_client_expected.rs @@ -0,0 +1,35 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Ping host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct PingPingResponse { + #[serde(default)] + error: Option, +} + +#[host_fn] +extern "ExtismHost" { + fn ping_ping(input: Json) -> Json; +} + +/// Calls the ping_ping host function. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn ping() -> Result<(), Error> { + let response = unsafe { + ping_ping(Json(serde_json::json!({})))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} diff --git a/plugins/cmd/ndpgen/testdata/ping_expected.go.txt b/plugins/cmd/ndpgen/testdata/ping_expected.go.txt new file mode 100644 index 000000000..0b0253817 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/ping_expected.go.txt @@ -0,0 +1,68 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package testpkg + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// PingPingResponse is the response type for Ping.Ping. +type PingPingResponse struct { + Error string `json:"error,omitempty"` +} + +// RegisterPingHostFunctions registers Ping service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterPingHostFunctions(service PingService) []extism.HostFunction { + return []extism.HostFunction{ + newPingPingHostFunction(service), + } +} + +func newPingPingHostFunction(service PingService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "ping_ping", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + + // Call the service method + if svcErr := service.Ping(ctx); svcErr != nil { + pingWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := PingPingResponse{} + pingWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// pingWriteResponse writes a JSON response to plugin memory. +func pingWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + pingWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// pingWriteError writes an error response to plugin memory. +func pingWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/cmd/ndpgen/testdata/ping_service.go.txt b/plugins/cmd/ndpgen/testdata/ping_service.go.txt new file mode 100644 index 000000000..c6bd1f489 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/ping_service.go.txt @@ -0,0 +1,9 @@ +package testpkg + +import "context" + +//nd:hostservice name=Ping permission=ping +type PingService interface { + //nd:hostfunc + Ping(ctx context.Context) error +} diff --git a/plugins/cmd/ndpgen/testdata/search_client_expected.go.txt b/plugins/cmd/ndpgen/testdata/search_client_expected.go.txt new file mode 100644 index 000000000..6ea002cf3 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/search_client_expected.go.txt @@ -0,0 +1,69 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Search host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package ndhost + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// Result represents the Result data structure. +type Result struct { + ID string `json:"id"` +} + +// search_find is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user search_find +func search_find(uint64) uint64 + +type searchFindRequest struct { + Query string `json:"query"` +} + +type searchFindResponse struct { + Results []Result `json:"results,omitempty"` + Total int32 `json:"total,omitempty"` + Error string `json:"error,omitempty"` +} + +// SearchFind calls the search_find host function. +func SearchFind(query string) ([]Result, int32, error) { + // Marshal request to JSON + req := searchFindRequest{ + Query: query, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return nil, 0, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := search_find(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response searchFindResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return nil, 0, err + } + + // Convert Error field to Go error + if response.Error != "" { + return nil, 0, errors.New(response.Error) + } + + return response.Results, response.Total, nil +} diff --git a/plugins/cmd/ndpgen/testdata/search_client_expected.py b/plugins/cmd/ndpgen/testdata/search_client_expected.py new file mode 100644 index 000000000..aa2e98a36 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/search_client_expected.py @@ -0,0 +1,62 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Search host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "search_find") +def _search_find(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@dataclass +class SearchFindResult: + """Result type for search_find.""" + results: Any + total: int + + +def search_find(query: str) -> SearchFindResult: + """Call the search_find host function. + + Args: + query: str parameter. + + Returns: + SearchFindResult containing results, total,. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "query": query, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _search_find(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return SearchFindResult( + results=response.get("results", None), + total=response.get("total", 0), + ) diff --git a/plugins/cmd/ndpgen/testdata/search_client_expected.rs b/plugins/cmd/ndpgen/testdata/search_client_expected.rs new file mode 100644 index 000000000..b0ab2505a --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/search_client_expected.rs @@ -0,0 +1,59 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Search host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct Result { + pub id: String, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct SearchFindRequest { + query: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct SearchFindResponse { + #[serde(default)] + results: Vec, + #[serde(default)] + total: i32, + #[serde(default)] + error: Option, +} + +#[host_fn] +extern "ExtismHost" { + fn search_find(input: Json) -> Json; +} + +/// Calls the search_find host function. +/// +/// # Arguments +/// * `query` - String parameter. +/// +/// # Returns +/// A tuple of (results, total). +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn find(query: &str) -> Result<(Vec, i32), Error> { + let response = unsafe { + search_find(Json(SearchFindRequest { + query: query.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok((response.0.results, response.0.total)) +} diff --git a/plugins/cmd/ndpgen/testdata/search_expected.go.txt b/plugins/cmd/ndpgen/testdata/search_expected.go.txt new file mode 100644 index 000000000..6c316266f --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/search_expected.go.txt @@ -0,0 +1,90 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package testpkg + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// SearchFindRequest is the request type for Search.Find. +type SearchFindRequest struct { + Query string `json:"query"` +} + +// SearchFindResponse is the response type for Search.Find. +type SearchFindResponse struct { + Results []Result `json:"results,omitempty"` + Total int32 `json:"total,omitempty"` + Error string `json:"error,omitempty"` +} + +// RegisterSearchHostFunctions registers Search service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterSearchHostFunctions(service SearchService) []extism.HostFunction { + return []extism.HostFunction{ + newSearchFindHostFunction(service), + } +} + +func newSearchFindHostFunction(service SearchService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "search_find", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + searchWriteError(p, stack, err) + return + } + var req SearchFindRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + searchWriteError(p, stack, err) + return + } + + // Call the service method + results, total, svcErr := service.Find(ctx, req.Query) + if svcErr != nil { + searchWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := SearchFindResponse{ + Results: results, + Total: total, + } + searchWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// searchWriteResponse writes a JSON response to plugin memory. +func searchWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + searchWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// searchWriteError writes an error response to plugin memory. +func searchWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/cmd/ndpgen/testdata/search_service.go.txt b/plugins/cmd/ndpgen/testdata/search_service.go.txt new file mode 100644 index 000000000..03a081966 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/search_service.go.txt @@ -0,0 +1,13 @@ +package testpkg + +import "context" + +type Result struct { + ID string +} + +//nd:hostservice name=Search permission=search +type SearchService interface { + //nd:hostfunc + Find(ctx context.Context, query string) (results []Result, total int32, err error) +} diff --git a/plugins/cmd/ndpgen/testdata/store_client_expected.go.txt b/plugins/cmd/ndpgen/testdata/store_client_expected.go.txt new file mode 100644 index 000000000..89618026c --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/store_client_expected.go.txt @@ -0,0 +1,69 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Store host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package ndhost + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// Item represents the Item data structure. +type Item struct { + ID string `json:"id"` + Name string `json:"name"` +} + +// store_save is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user store_save +func store_save(uint64) uint64 + +type storeSaveRequest struct { + Item Item `json:"item"` +} + +type storeSaveResponse struct { + Id string `json:"id,omitempty"` + Error string `json:"error,omitempty"` +} + +// StoreSave calls the store_save host function. +func StoreSave(item Item) (string, error) { + // Marshal request to JSON + req := storeSaveRequest{ + Item: item, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return "", err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := store_save(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response storeSaveResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return "", err + } + + // Convert Error field to Go error + if response.Error != "" { + return "", errors.New(response.Error) + } + + return response.Id, nil +} diff --git a/plugins/cmd/ndpgen/testdata/store_client_expected.py b/plugins/cmd/ndpgen/testdata/store_client_expected.py new file mode 100644 index 000000000..4a964a497 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/store_client_expected.py @@ -0,0 +1,52 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Store host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "store_save") +def _store_save(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def store_save(item: Any) -> str: + """Call the store_save host function. + + Args: + item: Any parameter. + + Returns: + str: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "item": item, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _store_save(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("id", "") diff --git a/plugins/cmd/ndpgen/testdata/store_client_expected.rs b/plugins/cmd/ndpgen/testdata/store_client_expected.rs new file mode 100644 index 000000000..25d2af2e0 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/store_client_expected.rs @@ -0,0 +1,58 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Store host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct Item { + pub id: String, + pub name: String, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct StoreSaveRequest { + item: Item, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct StoreSaveResponse { + #[serde(default)] + id: String, + #[serde(default)] + error: Option, +} + +#[host_fn] +extern "ExtismHost" { + fn store_save(input: Json) -> Json; +} + +/// Calls the store_save host function. +/// +/// # Arguments +/// * `item` - Item parameter. +/// +/// # Returns +/// The id value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn save(item: Item) -> Result { + let response = unsafe { + store_save(Json(StoreSaveRequest { + item: item, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.id) +} diff --git a/plugins/cmd/ndpgen/testdata/store_expected.go.txt b/plugins/cmd/ndpgen/testdata/store_expected.go.txt new file mode 100644 index 000000000..07537ca41 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/store_expected.go.txt @@ -0,0 +1,88 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package testpkg + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// StoreSaveRequest is the request type for Store.Save. +type StoreSaveRequest struct { + Item Item `json:"item"` +} + +// StoreSaveResponse is the response type for Store.Save. +type StoreSaveResponse struct { + Id string `json:"id,omitempty"` + Error string `json:"error,omitempty"` +} + +// RegisterStoreHostFunctions registers Store service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterStoreHostFunctions(service StoreService) []extism.HostFunction { + return []extism.HostFunction{ + newStoreSaveHostFunction(service), + } +} + +func newStoreSaveHostFunction(service StoreService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "store_save", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + storeWriteError(p, stack, err) + return + } + var req StoreSaveRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + storeWriteError(p, stack, err) + return + } + + // Call the service method + id, svcErr := service.Save(ctx, req.Item) + if svcErr != nil { + storeWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := StoreSaveResponse{ + Id: id, + } + storeWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// storeWriteResponse writes a JSON response to plugin memory. +func storeWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + storeWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// storeWriteError writes an error response to plugin memory. +func storeWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/cmd/ndpgen/testdata/store_service.go.txt b/plugins/cmd/ndpgen/testdata/store_service.go.txt new file mode 100644 index 000000000..c2ff69740 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/store_service.go.txt @@ -0,0 +1,14 @@ +package testpkg + +import "context" + +type Item struct { + ID string + Name string +} + +//nd:hostservice name=Store permission=store +type StoreService interface { + //nd:hostfunc + Save(ctx context.Context, item Item) (id string, err error) +} diff --git a/plugins/cmd/ndpgen/testdata/users_client_expected.go.txt b/plugins/cmd/ndpgen/testdata/users_client_expected.go.txt new file mode 100644 index 000000000..ddd71f3dc --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/users_client_expected.go.txt @@ -0,0 +1,71 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Users host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package ndhost + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// User represents the User data structure. +type User struct { + ID string `json:"id"` + Name string `json:"name"` +} + +// users_get is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user users_get +func users_get(uint64) uint64 + +type usersGetRequest struct { + Id *string `json:"id"` + Filter *User `json:"filter"` +} + +type usersGetResponse struct { + Result *User `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// UsersGet calls the users_get host function. +func UsersGet(id *string, filter *User) (*User, error) { + // Marshal request to JSON + req := usersGetRequest{ + Id: id, + Filter: filter, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return nil, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := users_get(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response usersGetResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return nil, err + } + + // Convert Error field to Go error + if response.Error != "" { + return nil, errors.New(response.Error) + } + + return response.Result, nil +} diff --git a/plugins/cmd/ndpgen/testdata/users_client_expected.py b/plugins/cmd/ndpgen/testdata/users_client_expected.py new file mode 100644 index 000000000..468b87b98 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/users_client_expected.py @@ -0,0 +1,54 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Users host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "users_get") +def _users_get(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def users_get(id: Any, filter: Any) -> Any: + """Call the users_get host function. + + Args: + id: Any parameter. + filter: Any parameter. + + Returns: + Any: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "id": id, + "filter": filter, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _users_get(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("result", None) diff --git a/plugins/cmd/ndpgen/testdata/users_client_expected.rs b/plugins/cmd/ndpgen/testdata/users_client_expected.rs new file mode 100644 index 000000000..40daa9cfd --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/users_client_expected.rs @@ -0,0 +1,61 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Users host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct User { + pub id: String, + pub name: String, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct UsersGetRequest { + id: Option, + filter: Option, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct UsersGetResponse { + #[serde(default)] + result: Option, + #[serde(default)] + error: Option, +} + +#[host_fn] +extern "ExtismHost" { + fn users_get(input: Json) -> Json; +} + +/// Calls the users_get host function. +/// +/// # Arguments +/// * `id` - Option parameter. +/// * `filter` - Option parameter. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get(id: Option, filter: Option) -> Result, Error> { + let response = unsafe { + users_get(Json(UsersGetRequest { + id: id, + filter: filter, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} diff --git a/plugins/cmd/ndpgen/testdata/users_expected.go.txt b/plugins/cmd/ndpgen/testdata/users_expected.go.txt new file mode 100644 index 000000000..1b0fbfa93 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/users_expected.go.txt @@ -0,0 +1,89 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package testpkg + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// UsersGetRequest is the request type for Users.Get. +type UsersGetRequest struct { + Id *string `json:"id"` + Filter *User `json:"filter"` +} + +// UsersGetResponse is the response type for Users.Get. +type UsersGetResponse struct { + Result *User `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// RegisterUsersHostFunctions registers Users service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterUsersHostFunctions(service UsersService) []extism.HostFunction { + return []extism.HostFunction{ + newUsersGetHostFunction(service), + } +} + +func newUsersGetHostFunction(service UsersService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "users_get", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + usersWriteError(p, stack, err) + return + } + var req UsersGetRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + usersWriteError(p, stack, err) + return + } + + // Call the service method + result, svcErr := service.Get(ctx, req.Id, req.Filter) + if svcErr != nil { + usersWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := UsersGetResponse{ + Result: result, + } + usersWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// usersWriteResponse writes a JSON response to plugin memory. +func usersWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + usersWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// usersWriteError writes an error response to plugin memory. +func usersWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/cmd/ndpgen/testdata/users_service.go.txt b/plugins/cmd/ndpgen/testdata/users_service.go.txt new file mode 100644 index 000000000..cb8db8c12 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/users_service.go.txt @@ -0,0 +1,14 @@ +package testpkg + +import "context" + +type User struct { + ID string + Name string +} + +//nd:hostservice name=Users permission=users +type UsersService interface { + //nd:hostfunc + Get(ctx context.Context, id *string, filter *User) (*User, error) +} diff --git a/plugins/cmd/ndpgen/tools.go b/plugins/cmd/ndpgen/tools.go new file mode 100644 index 000000000..961d4e805 --- /dev/null +++ b/plugins/cmd/ndpgen/tools.go @@ -0,0 +1,8 @@ +//go:build tools + +// This file ensures the extism/go-pdk dependency stays in go.mod. +// The PDK parser loads this package at runtime using go/packages. +// Without this import, `go mod tidy` would remove it since it's not directly imported elsewhere. +package main + +import _ "github.com/extism/go-pdk" diff --git a/plugins/config_validation.go b/plugins/config_validation.go new file mode 100644 index 000000000..d75f9ee7c --- /dev/null +++ b/plugins/config_validation.go @@ -0,0 +1,129 @@ +package plugins + +import ( + "encoding/json" + "errors" + "fmt" + "strings" + + "github.com/santhosh-tekuri/jsonschema/v6" +) + +// ConfigValidationError represents a validation error with field path and message. +type ConfigValidationError struct { + Field string `json:"field"` + Message string `json:"message"` +} + +// ConfigValidationErrors is a collection of validation errors. +type ConfigValidationErrors struct { + Errors []ConfigValidationError `json:"errors"` +} + +func (e *ConfigValidationErrors) Error() string { + if len(e.Errors) == 0 { + return "validation failed" + } + var msgs []string + for _, err := range e.Errors { + if err.Field != "" { + msgs = append(msgs, fmt.Sprintf("%s: %s", err.Field, err.Message)) + } else { + msgs = append(msgs, err.Message) + } + } + return strings.Join(msgs, "; ") +} + +// ValidateConfig validates a config JSON string against a plugin's config schema. +// If the manifest has no config schema, it returns an error indicating the plugin +// has no configurable options. +// Returns nil if validation passes, ConfigValidationErrors if validation fails. +func ValidateConfig(manifest *Manifest, configJSON string) error { + // If no config schema defined, plugin has no configurable options + if !manifest.HasConfigSchema() { + return fmt.Errorf("plugin has no configurable options") + } + + // Parse the config JSON (empty string treated as empty object) + var configData any + if configJSON == "" { + configData = map[string]any{} + } else { + if err := json.Unmarshal([]byte(configJSON), &configData); err != nil { + return &ConfigValidationErrors{ + Errors: []ConfigValidationError{{ + Message: fmt.Sprintf("invalid JSON: %v", err), + }}, + } + } + } + + // Compile the schema + compiler := jsonschema.NewCompiler() + if err := compiler.AddResource("schema.json", manifest.Config.Schema); err != nil { + return fmt.Errorf("adding schema resource: %w", err) + } + + schema, err := compiler.Compile("schema.json") + if err != nil { + return fmt.Errorf("compiling schema: %w", err) + } + + // Validate config against schema + if err := schema.Validate(configData); err != nil { + return convertValidationError(err) + } + + return nil +} + +// convertValidationError converts jsonschema validation errors to our format. +func convertValidationError(err error) *ConfigValidationErrors { + var validationErr *jsonschema.ValidationError + if !errors.As(err, &validationErr) { + return &ConfigValidationErrors{ + Errors: []ConfigValidationError{{ + Message: err.Error(), + }}, + } + } + + var configErrors []ConfigValidationError + collectErrors(validationErr, &configErrors) + + if len(configErrors) == 0 { + configErrors = append(configErrors, ConfigValidationError{ + Message: validationErr.Error(), + }) + } + + return &ConfigValidationErrors{Errors: configErrors} +} + +// collectErrors recursively collects validation errors from the error tree. +func collectErrors(err *jsonschema.ValidationError, errors *[]ConfigValidationError) { + // If there are child errors, collect from them + if len(err.Causes) > 0 { + for _, cause := range err.Causes { + collectErrors(cause, errors) + } + return + } + + // Leaf error - add it + field := "" + if len(err.InstanceLocation) > 0 { + field = strings.Join(err.InstanceLocation, "/") + } + + *errors = append(*errors, ConfigValidationError{ + Field: field, + Message: err.Error(), + }) +} + +// HasConfigSchema returns true if the manifest defines a config schema. +func (m *Manifest) HasConfigSchema() bool { + return m.Config != nil && m.Config.Schema != nil +} diff --git a/plugins/config_validation_test.go b/plugins/config_validation_test.go new file mode 100644 index 000000000..20e1ce29b --- /dev/null +++ b/plugins/config_validation_test.go @@ -0,0 +1,186 @@ +//go:build !windows + +package plugins + +import ( + "errors" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Config Validation", func() { + Describe("ValidateConfig", func() { + Context("when manifest has no config schema", func() { + It("returns an error", func() { + manifest := &Manifest{ + Name: "test", + Author: "test", + Version: "1.0.0", + } + err := ValidateConfig(manifest, `{"key": "value"}`) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("no configurable options")) + }) + }) + + Context("when manifest has config schema", func() { + var manifest *Manifest + + BeforeEach(func() { + manifest = &Manifest{ + Name: "test", + Author: "test", + Version: "1.0.0", + Config: &ConfigDefinition{ + Schema: map[string]any{ + "type": "object", + "properties": map[string]any{ + "apiKey": map[string]any{ + "type": "string", + "description": "API key for the service", + "minLength": float64(1), + }, + "timeout": map[string]any{ + "type": "integer", + "minimum": float64(1), + "maximum": float64(300), + }, + "enabled": map[string]any{ + "type": "boolean", + }, + }, + "required": []any{"apiKey"}, + }, + }, + } + }) + + It("accepts valid config", func() { + err := ValidateConfig(manifest, `{"apiKey": "secret123", "timeout": 30}`) + Expect(err).ToNot(HaveOccurred()) + }) + + It("rejects empty config when required fields are missing", func() { + err := ValidateConfig(manifest, "") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("apiKey")) + + err = ValidateConfig(manifest, "{}") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("apiKey")) + }) + + It("rejects config missing required field", func() { + err := ValidateConfig(manifest, `{"timeout": 30}`) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("apiKey")) + }) + + It("rejects config with wrong type", func() { + err := ValidateConfig(manifest, `{"apiKey": "secret", "timeout": "not a number"}`) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("timeout")) + }) + + It("rejects config with value out of range", func() { + err := ValidateConfig(manifest, `{"apiKey": "secret", "timeout": 500}`) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("timeout")) + }) + + It("rejects config with empty required string", func() { + err := ValidateConfig(manifest, `{"apiKey": ""}`) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("apiKey")) + }) + + It("rejects invalid JSON", func() { + err := ValidateConfig(manifest, `{invalid json}`) + Expect(err).To(HaveOccurred()) + var validationErr *ConfigValidationErrors + Expect(errors.As(err, &validationErr)).To(BeTrue()) + Expect(validationErr.Errors[0].Message).To(ContainSubstring("invalid JSON")) + }) + }) + + Context("with enum values", func() { + It("accepts valid enum value", func() { + manifest := &Manifest{ + Name: "test", + Author: "test", + Version: "1.0.0", + Config: &ConfigDefinition{ + Schema: map[string]any{ + "type": "object", + "properties": map[string]any{ + "logLevel": map[string]any{ + "type": "string", + "enum": []any{"debug", "info", "warn", "error"}, + }, + }, + }, + }, + } + err := ValidateConfig(manifest, `{"logLevel": "info"}`) + Expect(err).ToNot(HaveOccurred()) + }) + + It("rejects invalid enum value", func() { + manifest := &Manifest{ + Name: "test", + Author: "test", + Version: "1.0.0", + Config: &ConfigDefinition{ + Schema: map[string]any{ + "type": "object", + "properties": map[string]any{ + "logLevel": map[string]any{ + "type": "string", + "enum": []any{"debug", "info", "warn", "error"}, + }, + }, + }, + }, + } + err := ValidateConfig(manifest, `{"logLevel": "verbose"}`) + Expect(err).To(HaveOccurred()) + }) + }) + }) + + Describe("HasConfigSchema", func() { + It("returns false when config is nil", func() { + manifest := &Manifest{ + Name: "test", + Author: "test", + Version: "1.0.0", + } + Expect(manifest.HasConfigSchema()).To(BeFalse()) + }) + + It("returns false when schema is nil", func() { + manifest := &Manifest{ + Name: "test", + Author: "test", + Version: "1.0.0", + Config: &ConfigDefinition{}, + } + Expect(manifest.HasConfigSchema()).To(BeFalse()) + }) + + It("returns true when schema is present", func() { + manifest := &Manifest{ + Name: "test", + Author: "test", + Version: "1.0.0", + Config: &ConfigDefinition{ + Schema: map[string]any{ + "type": "object", + }, + }, + } + Expect(manifest.HasConfigSchema()).To(BeTrue()) + }) + }) +}) diff --git a/plugins/discovery.go b/plugins/discovery.go deleted file mode 100644 index 4125da322..000000000 --- a/plugins/discovery.go +++ /dev/null @@ -1,145 +0,0 @@ -package plugins - -import ( - "fmt" - "os" - "path/filepath" - - "github.com/navidrome/navidrome/plugins/schema" -) - -// PluginDiscoveryEntry represents the result of plugin discovery -type PluginDiscoveryEntry struct { - ID string // Plugin ID (directory name) - Path string // Resolved plugin directory path - WasmPath string // Path to the WASM file - Manifest *schema.PluginManifest // Loaded manifest (nil if failed) - IsSymlink bool // Whether the plugin is a development symlink - Error error // Error encountered during discovery -} - -// DiscoverPlugins scans the plugins directory and returns information about all discoverable plugins -// This shared function eliminates duplication between ScanPlugins and plugin list commands -func DiscoverPlugins(pluginsDir string) []PluginDiscoveryEntry { - var discoveries []PluginDiscoveryEntry - - entries, err := os.ReadDir(pluginsDir) - if err != nil { - // Return a single entry with the error - return []PluginDiscoveryEntry{{ - Error: fmt.Errorf("failed to read plugins directory %s: %w", pluginsDir, err), - }} - } - - for _, entry := range entries { - name := entry.Name() - pluginPath := filepath.Join(pluginsDir, name) - - // Skip hidden files - if name[0] == '.' { - continue - } - - // Check if it's a directory or symlink - info, err := os.Lstat(pluginPath) - if err != nil { - discoveries = append(discoveries, PluginDiscoveryEntry{ - ID: name, - Error: fmt.Errorf("failed to stat entry %s: %w", pluginPath, err), - }) - continue - } - - isSymlink := info.Mode()&os.ModeSymlink != 0 - isDir := info.IsDir() - - // Skip if not a directory or symlink - if !isDir && !isSymlink { - continue - } - - // Resolve symlinks - pluginDir := pluginPath - if isSymlink { - targetDir, err := os.Readlink(pluginPath) - if err != nil { - discoveries = append(discoveries, PluginDiscoveryEntry{ - ID: name, - IsSymlink: true, - Error: fmt.Errorf("failed to resolve symlink %s: %w", pluginPath, err), - }) - continue - } - - // If target is a relative path, make it absolute - if !filepath.IsAbs(targetDir) { - targetDir = filepath.Join(filepath.Dir(pluginPath), targetDir) - } - - // Verify that the target is a directory - targetInfo, err := os.Stat(targetDir) - if err != nil { - discoveries = append(discoveries, PluginDiscoveryEntry{ - ID: name, - IsSymlink: true, - Error: fmt.Errorf("failed to stat symlink target %s: %w", targetDir, err), - }) - continue - } - - if !targetInfo.IsDir() { - discoveries = append(discoveries, PluginDiscoveryEntry{ - ID: name, - IsSymlink: true, - Error: fmt.Errorf("symlink target is not a directory: %s", targetDir), - }) - continue - } - - pluginDir = targetDir - } - - // Check for WASM file - wasmPath := filepath.Join(pluginDir, "plugin.wasm") - if _, err := os.Stat(wasmPath); err != nil { - discoveries = append(discoveries, PluginDiscoveryEntry{ - ID: name, - Path: pluginDir, - Error: fmt.Errorf("no plugin.wasm found: %w", err), - }) - continue - } - - // Load manifest - manifest, err := LoadManifest(pluginDir) - if err != nil { - discoveries = append(discoveries, PluginDiscoveryEntry{ - ID: name, - Path: pluginDir, - Error: fmt.Errorf("failed to load manifest: %w", err), - }) - continue - } - - // Check for capabilities - if len(manifest.Capabilities) == 0 { - discoveries = append(discoveries, PluginDiscoveryEntry{ - ID: name, - Path: pluginDir, - Error: fmt.Errorf("no capabilities found in manifest"), - }) - continue - } - - // Success! - discoveries = append(discoveries, PluginDiscoveryEntry{ - ID: name, - Path: pluginDir, - WasmPath: wasmPath, - Manifest: manifest, - IsSymlink: isSymlink, - }) - } - - return discoveries -} diff --git a/plugins/discovery_test.go b/plugins/discovery_test.go deleted file mode 100644 index a5fd34516..000000000 --- a/plugins/discovery_test.go +++ /dev/null @@ -1,402 +0,0 @@ -package plugins - -import ( - "os" - "path/filepath" - - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" -) - -var _ = Describe("DiscoverPlugins", func() { - var tempPluginsDir string - - // Helper to create a valid plugin for discovery testing - createValidPlugin := func(name, manifestName, author, version string, capabilities []string) { - pluginDir := filepath.Join(tempPluginsDir, name) - Expect(os.MkdirAll(pluginDir, 0755)).To(Succeed()) - - // Copy real WASM file from testdata - sourceWasmPath := filepath.Join(testDataDir, "fake_artist_agent", "plugin.wasm") - targetWasmPath := filepath.Join(pluginDir, "plugin.wasm") - sourceWasm, err := os.ReadFile(sourceWasmPath) - Expect(err).ToNot(HaveOccurred()) - Expect(os.WriteFile(targetWasmPath, sourceWasm, 0600)).To(Succeed()) - - manifest := `{ - "name": "` + manifestName + `", - "version": "` + version + `", - "capabilities": [` - for i, cap := range capabilities { - if i > 0 { - manifest += `, ` - } - manifest += `"` + cap + `"` - } - manifest += `], - "author": "` + author + `", - "description": "Test Plugin", - "website": "https://test.navidrome.org/` + manifestName + `", - "permissions": {} - }` - Expect(os.WriteFile(filepath.Join(pluginDir, "manifest.json"), []byte(manifest), 0600)).To(Succeed()) - } - - createManifestOnlyPlugin := func(name string) { - pluginDir := filepath.Join(tempPluginsDir, name) - Expect(os.MkdirAll(pluginDir, 0755)).To(Succeed()) - - manifest := `{ - "name": "manifest-only", - "version": "1.0.0", - "capabilities": ["MetadataAgent"], - "author": "Test Author", - "description": "Test Plugin", - "website": "https://test.navidrome.org/manifest-only", - "permissions": {} - }` - Expect(os.WriteFile(filepath.Join(pluginDir, "manifest.json"), []byte(manifest), 0600)).To(Succeed()) - } - - createWasmOnlyPlugin := func(name string) { - pluginDir := filepath.Join(tempPluginsDir, name) - Expect(os.MkdirAll(pluginDir, 0755)).To(Succeed()) - - // Copy real WASM file from testdata - sourceWasmPath := filepath.Join(testDataDir, "fake_artist_agent", "plugin.wasm") - targetWasmPath := filepath.Join(pluginDir, "plugin.wasm") - sourceWasm, err := os.ReadFile(sourceWasmPath) - Expect(err).ToNot(HaveOccurred()) - Expect(os.WriteFile(targetWasmPath, sourceWasm, 0600)).To(Succeed()) - } - - createInvalidManifestPlugin := func(name string) { - pluginDir := filepath.Join(tempPluginsDir, name) - Expect(os.MkdirAll(pluginDir, 0755)).To(Succeed()) - - // Copy real WASM file from testdata - sourceWasmPath := filepath.Join(testDataDir, "fake_artist_agent", "plugin.wasm") - targetWasmPath := filepath.Join(pluginDir, "plugin.wasm") - sourceWasm, err := os.ReadFile(sourceWasmPath) - Expect(err).ToNot(HaveOccurred()) - Expect(os.WriteFile(targetWasmPath, sourceWasm, 0600)).To(Succeed()) - - invalidManifest := `{ "invalid": "json" }` - Expect(os.WriteFile(filepath.Join(pluginDir, "manifest.json"), []byte(invalidManifest), 0600)).To(Succeed()) - } - - createEmptyCapabilitiesPlugin := func(name string) { - pluginDir := filepath.Join(tempPluginsDir, name) - Expect(os.MkdirAll(pluginDir, 0755)).To(Succeed()) - - // Copy real WASM file from testdata - sourceWasmPath := filepath.Join(testDataDir, "fake_artist_agent", "plugin.wasm") - targetWasmPath := filepath.Join(pluginDir, "plugin.wasm") - sourceWasm, err := os.ReadFile(sourceWasmPath) - Expect(err).ToNot(HaveOccurred()) - Expect(os.WriteFile(targetWasmPath, sourceWasm, 0600)).To(Succeed()) - - manifest := `{ - "name": "empty-capabilities", - "version": "1.0.0", - "capabilities": [], - "author": "Test Author", - "description": "Test Plugin", - "website": "https://test.navidrome.org/empty-capabilities", - "permissions": {} - }` - Expect(os.WriteFile(filepath.Join(pluginDir, "manifest.json"), []byte(manifest), 0600)).To(Succeed()) - } - - BeforeEach(func() { - tempPluginsDir, _ = os.MkdirTemp("", "navidrome-plugins-discovery-test-*") - DeferCleanup(func() { - _ = os.RemoveAll(tempPluginsDir) - }) - }) - - Context("Valid plugins", func() { - It("should discover valid plugins with all required files", func() { - createValidPlugin("test-plugin", "Test Plugin", "Test Author", "1.0.0", []string{"MetadataAgent"}) - createValidPlugin("another-plugin", "Another Plugin", "Another Author", "2.0.0", []string{"Scrobbler"}) - - discoveries := DiscoverPlugins(tempPluginsDir) - - Expect(discoveries).To(HaveLen(2)) - - // Find each plugin by ID - var testPlugin, anotherPlugin *PluginDiscoveryEntry - for i := range discoveries { - switch discoveries[i].ID { - case "test-plugin": - testPlugin = &discoveries[i] - case "another-plugin": - anotherPlugin = &discoveries[i] - } - } - - Expect(testPlugin).NotTo(BeNil()) - Expect(testPlugin.Error).To(BeNil()) - Expect(testPlugin.Manifest.Name).To(Equal("Test Plugin")) - Expect(string(testPlugin.Manifest.Capabilities[0])).To(Equal("MetadataAgent")) - - Expect(anotherPlugin).NotTo(BeNil()) - Expect(anotherPlugin.Error).To(BeNil()) - Expect(anotherPlugin.Manifest.Name).To(Equal("Another Plugin")) - Expect(string(anotherPlugin.Manifest.Capabilities[0])).To(Equal("Scrobbler")) - }) - - It("should handle plugins with same manifest name in different directories", func() { - createValidPlugin("lastfm-official", "lastfm", "Official Author", "1.0.0", []string{"MetadataAgent"}) - createValidPlugin("lastfm-custom", "lastfm", "Custom Author", "2.0.0", []string{"MetadataAgent"}) - - discoveries := DiscoverPlugins(tempPluginsDir) - - Expect(discoveries).To(HaveLen(2)) - - // Find each plugin by ID - var officialPlugin, customPlugin *PluginDiscoveryEntry - for i := range discoveries { - switch discoveries[i].ID { - case "lastfm-official": - officialPlugin = &discoveries[i] - case "lastfm-custom": - customPlugin = &discoveries[i] - } - } - - Expect(officialPlugin).NotTo(BeNil()) - Expect(officialPlugin.Error).To(BeNil()) - Expect(officialPlugin.Manifest.Name).To(Equal("lastfm")) - Expect(officialPlugin.Manifest.Author).To(Equal("Official Author")) - - Expect(customPlugin).NotTo(BeNil()) - Expect(customPlugin.Error).To(BeNil()) - Expect(customPlugin.Manifest.Name).To(Equal("lastfm")) - Expect(customPlugin.Manifest.Author).To(Equal("Custom Author")) - }) - }) - - Context("Missing files", func() { - It("should report error for plugins missing WASM files", func() { - createManifestOnlyPlugin("manifest-only") - - discoveries := DiscoverPlugins(tempPluginsDir) - - Expect(discoveries).To(HaveLen(1)) - Expect(discoveries[0].ID).To(Equal("manifest-only")) - Expect(discoveries[0].Error).To(HaveOccurred()) - Expect(discoveries[0].Error.Error()).To(ContainSubstring("no plugin.wasm found")) - }) - - It("should skip directories missing manifest files", func() { - createWasmOnlyPlugin("wasm-only") - - discoveries := DiscoverPlugins(tempPluginsDir) - - Expect(discoveries).To(HaveLen(1)) - Expect(discoveries[0].ID).To(Equal("wasm-only")) - Expect(discoveries[0].Error).To(HaveOccurred()) - Expect(discoveries[0].Error.Error()).To(ContainSubstring("failed to load manifest")) - }) - }) - - Context("Invalid content", func() { - It("should report error for invalid manifest JSON", func() { - createInvalidManifestPlugin("invalid-manifest") - - discoveries := DiscoverPlugins(tempPluginsDir) - - Expect(discoveries).To(HaveLen(1)) - Expect(discoveries[0].ID).To(Equal("invalid-manifest")) - Expect(discoveries[0].Error).To(HaveOccurred()) - Expect(discoveries[0].Error.Error()).To(ContainSubstring("failed to load manifest")) - }) - - It("should report error for plugins with empty capabilities", func() { - createEmptyCapabilitiesPlugin("empty-capabilities") - - discoveries := DiscoverPlugins(tempPluginsDir) - - Expect(discoveries).To(HaveLen(1)) - Expect(discoveries[0].ID).To(Equal("empty-capabilities")) - Expect(discoveries[0].Error).To(HaveOccurred()) - Expect(discoveries[0].Error.Error()).To(ContainSubstring("field capabilities length: must be >= 1")) - }) - }) - - Context("Symlinks", func() { - It("should discover symlinked plugins correctly", func() { - // Create a real plugin directory outside tempPluginsDir - realPluginDir, err := os.MkdirTemp("", "navidrome-real-plugin-*") - Expect(err).ToNot(HaveOccurred()) - DeferCleanup(func() { - _ = os.RemoveAll(realPluginDir) - }) - - // Create plugin files in the real directory - sourceWasmPath := filepath.Join(testDataDir, "fake_artist_agent", "plugin.wasm") - targetWasmPath := filepath.Join(realPluginDir, "plugin.wasm") - sourceWasm, err := os.ReadFile(sourceWasmPath) - Expect(err).ToNot(HaveOccurred()) - Expect(os.WriteFile(targetWasmPath, sourceWasm, 0600)).To(Succeed()) - - manifest := `{ - "name": "symlinked-plugin", - "version": "1.0.0", - "capabilities": ["MetadataAgent"], - "author": "Test Author", - "description": "Test Plugin", - "website": "https://test.navidrome.org/symlinked-plugin", - "permissions": {} - }` - Expect(os.WriteFile(filepath.Join(realPluginDir, "manifest.json"), []byte(manifest), 0600)).To(Succeed()) - - // Create symlink - symlinkPath := filepath.Join(tempPluginsDir, "symlinked-plugin") - Expect(os.Symlink(realPluginDir, symlinkPath)).To(Succeed()) - - discoveries := DiscoverPlugins(tempPluginsDir) - - Expect(discoveries).To(HaveLen(1)) - Expect(discoveries[0].ID).To(Equal("symlinked-plugin")) - Expect(discoveries[0].Error).To(BeNil()) - Expect(discoveries[0].IsSymlink).To(BeTrue()) - Expect(discoveries[0].Path).To(Equal(realPluginDir)) - Expect(discoveries[0].Manifest.Name).To(Equal("symlinked-plugin")) - }) - - It("should handle relative symlinks", func() { - // Create a real plugin directory in the same parent as tempPluginsDir - parentDir := filepath.Dir(tempPluginsDir) - realPluginDir := filepath.Join(parentDir, "real-plugin-dir") - Expect(os.MkdirAll(realPluginDir, 0755)).To(Succeed()) - DeferCleanup(func() { - _ = os.RemoveAll(realPluginDir) - }) - - // Create plugin files in the real directory - sourceWasmPath := filepath.Join(testDataDir, "fake_artist_agent", "plugin.wasm") - targetWasmPath := filepath.Join(realPluginDir, "plugin.wasm") - sourceWasm, err := os.ReadFile(sourceWasmPath) - Expect(err).ToNot(HaveOccurred()) - Expect(os.WriteFile(targetWasmPath, sourceWasm, 0600)).To(Succeed()) - - manifest := `{ - "name": "relative-symlinked-plugin", - "version": "1.0.0", - "capabilities": ["MetadataAgent"], - "author": "Test Author", - "description": "Test Plugin", - "website": "https://test.navidrome.org/relative-symlinked-plugin", - "permissions": {} - }` - Expect(os.WriteFile(filepath.Join(realPluginDir, "manifest.json"), []byte(manifest), 0600)).To(Succeed()) - - // Create relative symlink - symlinkPath := filepath.Join(tempPluginsDir, "relative-symlinked-plugin") - relativeTarget := "../real-plugin-dir" - Expect(os.Symlink(relativeTarget, symlinkPath)).To(Succeed()) - - discoveries := DiscoverPlugins(tempPluginsDir) - - Expect(discoveries).To(HaveLen(1)) - Expect(discoveries[0].ID).To(Equal("relative-symlinked-plugin")) - Expect(discoveries[0].Error).To(BeNil()) - Expect(discoveries[0].IsSymlink).To(BeTrue()) - Expect(discoveries[0].Path).To(Equal(realPluginDir)) - Expect(discoveries[0].Manifest.Name).To(Equal("relative-symlinked-plugin")) - }) - - It("should report error for broken symlinks", func() { - symlinkPath := filepath.Join(tempPluginsDir, "broken-symlink") - nonExistentTarget := "/non/existent/path" - Expect(os.Symlink(nonExistentTarget, symlinkPath)).To(Succeed()) - - discoveries := DiscoverPlugins(tempPluginsDir) - - Expect(discoveries).To(HaveLen(1)) - Expect(discoveries[0].ID).To(Equal("broken-symlink")) - Expect(discoveries[0].Error).To(HaveOccurred()) - Expect(discoveries[0].Error.Error()).To(ContainSubstring("failed to stat symlink target")) - Expect(discoveries[0].IsSymlink).To(BeTrue()) - }) - - It("should report error for symlinks pointing to files", func() { - // Create a regular file - regularFile := filepath.Join(tempPluginsDir, "regular-file.txt") - Expect(os.WriteFile(regularFile, []byte("content"), 0600)).To(Succeed()) - - // Create symlink pointing to the file - symlinkPath := filepath.Join(tempPluginsDir, "symlink-to-file") - Expect(os.Symlink(regularFile, symlinkPath)).To(Succeed()) - - discoveries := DiscoverPlugins(tempPluginsDir) - - Expect(discoveries).To(HaveLen(1)) - Expect(discoveries[0].ID).To(Equal("symlink-to-file")) - Expect(discoveries[0].Error).To(HaveOccurred()) - Expect(discoveries[0].Error.Error()).To(ContainSubstring("symlink target is not a directory")) - Expect(discoveries[0].IsSymlink).To(BeTrue()) - }) - }) - - Context("Directory filtering", func() { - It("should ignore hidden directories", func() { - createValidPlugin(".hidden-plugin", "Hidden Plugin", "Test Author", "1.0.0", []string{"MetadataAgent"}) - createValidPlugin("visible-plugin", "Visible Plugin", "Test Author", "1.0.0", []string{"MetadataAgent"}) - - discoveries := DiscoverPlugins(tempPluginsDir) - - Expect(discoveries).To(HaveLen(1)) - Expect(discoveries[0].ID).To(Equal("visible-plugin")) - }) - - It("should ignore regular files", func() { - // Create a regular file - Expect(os.WriteFile(filepath.Join(tempPluginsDir, "regular-file.txt"), []byte("content"), 0600)).To(Succeed()) - createValidPlugin("valid-plugin", "Valid Plugin", "Test Author", "1.0.0", []string{"MetadataAgent"}) - - discoveries := DiscoverPlugins(tempPluginsDir) - - Expect(discoveries).To(HaveLen(1)) - Expect(discoveries[0].ID).To(Equal("valid-plugin")) - }) - - It("should handle mixed valid and invalid plugins", func() { - createValidPlugin("valid-plugin", "Valid Plugin", "Test Author", "1.0.0", []string{"MetadataAgent"}) - createManifestOnlyPlugin("manifest-only") - createInvalidManifestPlugin("invalid-manifest") - createValidPlugin("another-valid", "Another Valid", "Test Author", "1.0.0", []string{"Scrobbler"}) - - discoveries := DiscoverPlugins(tempPluginsDir) - - Expect(discoveries).To(HaveLen(4)) - - var validCount int - var errorCount int - for _, discovery := range discoveries { - if discovery.Error == nil { - validCount++ - } else { - errorCount++ - } - } - - Expect(validCount).To(Equal(2)) - Expect(errorCount).To(Equal(2)) - }) - }) - - Context("Error handling", func() { - It("should handle non-existent plugins directory", func() { - nonExistentDir := "/non/existent/plugins/dir" - - discoveries := DiscoverPlugins(nonExistentDir) - - Expect(discoveries).To(HaveLen(1)) - Expect(discoveries[0].Error).To(HaveOccurred()) - Expect(discoveries[0].Error.Error()).To(ContainSubstring("failed to read plugins directory")) - }) - }) -}) diff --git a/plugins/examples/Makefile b/plugins/examples/Makefile index e2acc2ff8..c8a62ab0c 100644 --- a/plugins/examples/Makefile +++ b/plugins/examples/Makefile @@ -1,27 +1,98 @@ -all: wikimedia coverartarchive crypto-ticker discord-rich-presence subsonicapi-demo +# Build example plugins for Navidrome +# Auto-discover all plugin folders (folders containing go.mod) +PLUGINS := $(patsubst %/go.mod,%,$(wildcard */go.mod)) -wikimedia: wikimedia/plugin.wasm -coverartarchive: coverartarchive/plugin.wasm -crypto-ticker: crypto-ticker/plugin.wasm -discord-rich-presence: discord-rich-presence/plugin.wasm -subsonicapi-demo: subsonicapi-demo/plugin.wasm +# Auto-discover Python plugins (folders containing plugin/__init__.py) +PYTHON_PLUGINS := $(patsubst %/plugin/__init__.py,%,$(wildcard */plugin/__init__.py)) -wikimedia/plugin.wasm: wikimedia/plugin.go - GOOS=wasip1 GOARCH=wasm go build -buildmode=c-shared -o $@ ./wikimedia +# Auto-discover Rust plugins (folders containing Cargo.toml) +RUST_PLUGINS := $(patsubst %/Cargo.toml,%,$(wildcard */Cargo.toml)) -coverartarchive/plugin.wasm: coverartarchive/plugin.go - GOOS=wasip1 GOARCH=wasm go build -buildmode=c-shared -o $@ ./coverartarchive +# Prefer tinygo if available, it produces smaller wasm binaries. +TINYGO := $(shell command -v tinygo 2> /dev/null) +EXTISM_PY := $(shell command -v extism-py 2> /dev/null) -crypto-ticker/plugin.wasm: crypto-ticker/plugin.go - GOOS=wasip1 GOARCH=wasm go build -buildmode=c-shared -o $@ ./crypto-ticker +# PDK source files that trigger rebuild when changed (recursive) +PDK_GO_SOURCES := $(shell find ../pdk/go -name '*.go' 2>/dev/null) +PDK_PY_SOURCES := $(shell find ../pdk/python -name '*.py' 2>/dev/null) +PDK_RS_SOURCES := $(shell find ../pdk/rust -name '*.rs' 2>/dev/null) -DISCORD_RP_FILES=$(shell find discord-rich-presence -type f -name "*.go") -discord-rich-presence/plugin.wasm: $(DISCORD_RP_FILES) - GOOS=wasip1 GOARCH=wasm go build -buildmode=c-shared -o $@ ./discord-rich-presence/... +# Allow building plugins without .ndp extension (e.g., make minimal instead of make minimal.ndp) +.PHONY: $(PLUGINS) $(PYTHON_PLUGINS) $(RUST_PLUGINS) +$(PLUGINS): %: %.ndp +$(PYTHON_PLUGINS): %: %.ndp +$(RUST_PLUGINS): %: %.ndp -subsonicapi-demo/plugin.wasm: subsonicapi-demo/plugin.go - GOOS=wasip1 GOARCH=wasm go build -buildmode=c-shared -o $@ ./subsonicapi-demo +# Default target: show available plugins +.DEFAULT_GOAL := help + +help: + @echo "Available Go plugins:" + @$(foreach p,$(PLUGINS),echo " $(p)";) + @echo "" + @echo "Available Python plugins:" + @$(foreach p,$(PYTHON_PLUGINS),echo " $(p)";) + @echo "" + @echo "Available Rust plugins:" + @$(foreach p,$(RUST_PLUGINS),echo " $(p)";) + @echo "" + @echo "Usage:" + @echo " make Build a specific plugin (e.g., make $(firstword $(PLUGINS)))" + @echo " make all Build all plugins" + @echo " make all-go Build all Go plugins" + @echo " make all-python Build all Python plugins (requires extism-py)" + @echo " make all-rust Build all Rust plugins (requires cargo)" + @echo " make clean Remove all built plugins (.ndp and .wasm files)" + +all: all-go all-python all-rust + +all-go: $(PLUGINS:%=%.ndp) + +all-python: $(PYTHON_PLUGINS:%=%.ndp) + +all-rust: $(RUST_PLUGINS:%=%.ndp) clean: - rm -f wikimedia/plugin.wasm coverartarchive/plugin.wasm crypto-ticker/plugin.wasm \ - discord-rich-presence/plugin.wasm subsonicapi-demo/plugin.wasm \ No newline at end of file + rm -f $(PLUGINS:%=%.ndp) $(PYTHON_PLUGINS:%=%.ndp) $(RUST_PLUGINS:%=%.ndp) + rm -f $(PLUGINS:%=%.wasm) $(PYTHON_PLUGINS:%=%.wasm) $(RUST_PLUGINS:%=%.wasm) + @$(foreach p,$(RUST_PLUGINS),(cd $(p) && cargo clean 2>/dev/null) || true;) + +# Mark .wasm files as intermediate so Make deletes them after building .ndp +.INTERMEDIATE: $(PLUGINS:%=%.wasm) $(PYTHON_PLUGINS:%=%.wasm) $(RUST_PLUGINS:%=%.wasm) + +# Build .ndp package from .wasm and manifest.json +# Go plugins +%.ndp: %.wasm %/manifest.json + @rm -f $@ + @cp $< plugin.wasm + zip -j $@ $*/manifest.json plugin.wasm + @rm -f plugin.wasm + @mv $< $<.tmp && mv $<.tmp $< # Touch wasm to ensure it's older than ndp + +# Use secondary expansion to properly track all Go source files +.SECONDEXPANSION: +$(PLUGINS:%=%.wasm): %.wasm: $$(shell find % -name '*.go' 2>/dev/null) %/go.mod $(PDK_GO_SOURCES) +ifdef TINYGO + cd $* && tinygo build -target wasip1 -buildmode=c-shared -o ../$@ . +else + cd $* && GOOS=wasip1 GOARCH=wasm go build -buildmode=c-shared -o ../$@ . +endif + +# Python plugin builds (generic rule for any folder with plugin/__init__.py) +# Use secondary expansion to get all .py files in the plugin directory as dependencies +.SECONDEXPANSION: +$(PYTHON_PLUGINS:%=%.wasm): %.wasm: $$(wildcard %/plugin/*.py) $(PDK_PY_SOURCES) +ifndef EXTISM_PY + $(error extism-py is not installed. Install from https://github.com/extism/python-pdk) +endif + cd $* && PYTHONPATH=plugin extism-py plugin/__init__.py -o ../$@ + +# Rust plugin builds (generic rule for any folder with Cargo.toml) +# Note: Rust crate names use underscores, but plugin names use hyphens +# All Rust plugins use wasm32-wasip1 for WASI support (filesystem, etc.) +RUST_TARGET := wasm32-wasip1 +RUSTUP_CARGO := $(shell rustup which cargo 2>/dev/null || echo cargo) +RUSTUP_RUSTC := $(shell rustup which rustc 2>/dev/null) +$(RUST_PLUGINS:%=%.wasm): %.wasm: %/Cargo.toml $$(wildcard %/src/*.rs) $(PDK_RS_SOURCES) + cd $* && CARGO_BUILD_RUSTC=$(RUSTUP_RUSTC) $(RUSTUP_CARGO) build --release --target $(RUST_TARGET) + cp $*/target/$(RUST_TARGET)/release/$(subst -,_,$*).wasm $@ diff --git a/plugins/examples/README.md b/plugins/examples/README.md index 61d6b2ef9..bce2b6762 100644 --- a/plugins/examples/README.md +++ b/plugins/examples/README.md @@ -1,31 +1,180 @@ -# Plugin Examples +# Navidrome Plugin Examples -This directory contains example plugins for Navidrome, intended for demonstration and reference purposes. These plugins are not used in automated tests. +This folder contains example plugins demonstrating various capabilities and languages supported by Navidrome's plugin system. -## Contents +## Available Examples -- `wikimedia/`: Retrieves artist information from Wikidata. -- `coverartarchive/`: Fetches album cover images from the Cover Art Archive. -- `crypto-ticker/`: Uses websockets to log real-time cryptocurrency prices. -- `discord-rich-presence/`: Integrates with Discord Rich Presence to display currently playing tracks on Discord profiles. -- `subsonicapi-demo/`: Demonstrates interaction with Navidrome's Subsonic API from a plugin. +| Plugin | Language | Capabilities | Description | +|-------------------------------------------------------|----------|-------------------------------------------------|--------------------------------| +| [minimal](minimal/) | Go | MetadataAgent | Basic plugin structure | +| [wikimedia](wikimedia/) | Go | MetadataAgent | Wikidata/Wikipedia metadata | +| [crypto-ticker](crypto-ticker/) | Go | Scheduler, WebSocket, Cache | Real-time crypto prices (demo) | +| [coverartarchive-py](coverartarchive-py/) | Python | MetadataAgent | Cover Art Archive | +| [nowplaying-py](nowplaying-py/) | Python | Scheduler, SubsonicAPI | Now playing logger | +| [webhook-rs](webhook-rs/) | Rust | Scrobbler | HTTP webhook on scrobble | +| [library-inspector-rs](library-inspector-rs/) | Rust | Library, Scheduler | Periodic library stats logging | +| [discord-rich-presence-rs](discord-rich-presence-rs/) | Rust | Scrobbler, Scheduler, WebSocket, Cache, Artwork | Discord integration (Rust) | ## Building -To build all example plugins, run: +### Prerequisites -``` -make +- **Go plugins:** [TinyGo](https://tinygo.org/getting-started/install/) 0.30+ +- **Python plugins:** [extism-py](https://github.com/extism/python-pdk) +- **Rust plugins:** [Rust](https://rustup.rs/) with `wasm32-unknown-unknown` target + +### Build All Plugins + +```bash +make all ``` -Or to build a specific plugin: +This creates `.ndp` package files for each plugin. -``` -make wikimedia -make coverartarchive -make crypto-ticker -make discord-rich-presence -make subsonicapi-demo +### Build Individual Plugin + +```bash +make minimal.ndp +make wikimedia.ndp +make discord-rich-presence-rs.ndp ``` -This will produce the corresponding `plugin.wasm` files in each plugin's directory. +### Clean + +```bash +make clean +``` + +## Testing Plugins + +### With Extism CLI + +Test any plugin without running Navidrome. First extract the `.wasm` file from the `.ndp` package: + +```bash +# Install: https://extism.org/docs/install + +# Extract the wasm file from the package +unzip -p minimal.ndp plugin.wasm > minimal.wasm + +# Test a capability function +extism call minimal.wasm nd_get_artist_biography --wasi \ + --input '{"id":"1","name":"The Beatles"}' +``` + +For plugins that make HTTP requests, allow the hosts: + +```bash +unzip -p wikimedia.ndp plugin.wasm > wikimedia.wasm +extism call wikimedia.wasm nd_get_artist_biography --wasi \ + --input '{"id":"1","name":"Yussef Dayes"}' \ + --allow-host "query.wikidata.org" \ + --allow-host "en.wikipedia.org" +``` + +### With Navidrome + +1. Copy the `.ndp` file to your plugins folder +2. Enable plugins in `navidrome.toml`: + ```toml + [Plugins] + Enabled = true + Folder = "/path/to/plugins" + ``` +3. For metadata agents, add to your agents list: + ```toml + Agents = "lastfm,spotify,wikimedia" + ``` + +## Creating Your Own Plugin + +### Option 1: Start from Minimal + +Copy the [minimal](minimal/) example and modify: + +```bash +cp -r minimal my-plugin +cd my-plugin +# Edit main.go and manifest.json +tinygo build -o plugin.wasm -target wasip1 -buildmode=c-shared . +zip -j my-plugin.ndp manifest.json plugin.wasm +``` + +### Option 2: Bootstrap with XTP CLI + +Generate boilerplate from a schema: + +```bash +# Install XTP: https://docs.xtp.dylibso.com/docs/cli + +xtp plugin init \ + --schema-file ../schemas/metadata_agent.yaml \ + --template go \ + --path ./my-plugin \ + --name my-plugin + +# Then create manifest.json and package +cd my-plugin +xtp plugin build +zip -j my-plugin.ndp manifest.json dist/plugin.wasm +``` + +Available schemas in [../schemas/](../schemas/): +- `metadata_agent.yaml` – Artist/album metadata +- `scrobbler.yaml` – Scrobbling integration +- `lifecycle.yaml` – Init callbacks +- `scheduler_callback.yaml` – Scheduled tasks +- `websocket_callback.yaml` – WebSocket events + +### Option 3: Different Language + +See language-specific examples: +- **Python:** [coverartarchive-py](coverartarchive-py/) +- **Rust:** [webhook-rs](webhook-rs/) + +## Example Breakdown + +### Minimal (Go) + +The simplest possible plugin. Shows: +- Manifest export +- Single capability function +- Basic input/output handling + +### Wikimedia (Go) + +Real-world metadata agent. Shows: +- HTTP requests to external APIs +- SPARQL queries (Wikidata) +- Error handling +- Host allowlisting + +### Discord Rich Presence (Go) + +Complex multi-capability plugin. Shows: +- **Scrobbler** – Receives play events +- **WebSocket** – Maintains Discord gateway connection +- **Scheduler** – Heartbeat and timeout management +- **Cache** – Connection state storage +- **Artwork** – Getting album art URLs + +### Cover Art Archive (Python) + +Python metadata agent. Shows: +- extism-py plugin structure +- HTTP requests +- JSON handling + +### Webhook (Rust) + +Rust scrobbler. Shows: +- extism-rs plugin structure +- HTTP POST requests +- Minimal dependencies + +## Resources + +- [Plugin System Documentation](../README.md) +- [Extism PDK Docs](https://extism.org/docs/concepts/pdk) +- [TinyGo WebAssembly](https://tinygo.org/docs/guides/webassembly/) +- [XTP CLI](https://docs.xtp.dylibso.com/docs/cli) diff --git a/plugins/examples/coverartarchive-py/Makefile b/plugins/examples/coverartarchive-py/Makefile new file mode 100644 index 000000000..e3cd60d1c --- /dev/null +++ b/plugins/examples/coverartarchive-py/Makefile @@ -0,0 +1,27 @@ +# Build the Cover Art Archive Python plugin +.PHONY: build test clean + +WASM_FILE = coverartarchive-py.wasm + +build: $(WASM_FILE) + +$(WASM_FILE): plugin/__init__.py + extism-py plugin/__init__.py -o $(WASM_FILE) + +test: build + @echo "Testing nd_manifest..." + extism call $(WASM_FILE) nd_manifest --wasi + @echo "" + @echo "Testing nd_get_album_images with Portishead's Dummy MBID..." + extism call $(WASM_FILE) nd_get_album_images --wasi \ + --input '{"name":"Dummy","artist":"Portishead","mbid":"76df3287-6cda-33eb-8e9a-044b5e15ffdd"}' \ + --allow-host "coverartarchive.org" --allow-host "archive.org" + +test-error: build + @echo "Testing error case (missing MBID)..." + -extism call $(WASM_FILE) nd_get_album_images --wasi \ + --input '{"name":"Test Album","artist":"Test Artist"}' \ + --allow-host "coverartarchive.org" + +clean: + rm -f $(WASM_FILE) diff --git a/plugins/examples/coverartarchive-py/README.md b/plugins/examples/coverartarchive-py/README.md new file mode 100644 index 000000000..77957ac4f --- /dev/null +++ b/plugins/examples/coverartarchive-py/README.md @@ -0,0 +1,73 @@ +# Cover Art Archive Plugin (Python) + +A Python example plugin that fetches album cover images from the [Cover Art Archive](https://coverartarchive.org/) API using the MusicBrainz Release MBID. + +## Features + +- Implements the `nd_get_album_images` method of the MetadataAgent plugin interface +- Returns front cover images for a given release MBID +- Returns `not found` if no MBID is provided or no images are found +- Demonstrates Python plugin development for Navidrome + +## Prerequisites + +- [extism-py](https://github.com/extism/python-pdk) - Python PDK compiler + ```bash + curl -Ls https://raw.githubusercontent.com/extism/python-pdk/main/install.sh | bash + ``` + +> **Note:** `extism-py` requires [Binaryen](https://github.com/WebAssembly/binaryen/) (`wasm-merge`, `wasm-opt`) to be installed. + +## Building + +From the `plugins/examples` directory: + +```bash +make coverartarchive-py.ndp +``` + +Or directly: + +```bash +extism-py plugin/__init__.py -o plugin.wasm +zip -j coverartarchive-py.ndp manifest.json plugin.wasm +``` + +## Installation + +1. Copy `coverartarchive-py.ndp` to your Navidrome plugins folder + +2. Enable plugins in `navidrome.toml`: + ```toml + [Plugins] + Enabled = true + Folder = "/path/to/plugins" + ``` + +3. Add to your agents list: + ```toml + Agents = "coverartarchive-py,spotify,lastfm" + ``` + +## Testing + +Extract the wasm file and test: + +```bash +unzip -p coverartarchive-py.ndp plugin.wasm > coverartarchive-py.wasm +extism call coverartarchive-py.wasm nd_get_album_images --wasi \ + --input '{"name":"Dummy","artist":"Portishead","mbid":"76df3287-6cda-33eb-8e9a-044b5e15ffdd"}' \ + --allow-host "coverartarchive.org" --allow-host "archive.org" +``` + +## How It Works + +1. **Album Image Request (`nd_get_album_images`)**: Receives album metadata including the MusicBrainz Release MBID. + +2. **API Query**: Fetches cover art metadata from `https://coverartarchive.org/release/{mbid}`. + +3. **Response**: Returns the front cover image URL if found. + +## API Reference + +- [Cover Art Archive API](https://musicbrainz.org/doc/Cover_Art_Archive/API) diff --git a/plugins/examples/coverartarchive-py/manifest.json b/plugins/examples/coverartarchive-py/manifest.json new file mode 100644 index 000000000..c9a52ba07 --- /dev/null +++ b/plugins/examples/coverartarchive-py/manifest.json @@ -0,0 +1,16 @@ +{ + "name": "Cover Art Archive (Python)", + "author": "Navidrome", + "version": "1.0.0", + "description": "Album cover art from the Cover Art Archive - Python example", + "website": "https://coverartarchive.org", + "permissions": { + "http": { + "reason": "Fetch album cover art from Cover Art Archive API", + "requiredHosts": [ + "coverartarchive.org", + "*.archive.org" + ] + } + } +} diff --git a/plugins/examples/coverartarchive-py/plugin/__init__.py b/plugins/examples/coverartarchive-py/plugin/__init__.py new file mode 100644 index 000000000..3c1d4149e --- /dev/null +++ b/plugins/examples/coverartarchive-py/plugin/__init__.py @@ -0,0 +1,105 @@ +# Cover Art Archive Plugin for Navidrome +# +# This plugin fetches album cover art from the Cover Art Archive (https://coverartarchive.org/) +# using the MusicBrainz album MBID. +# +# Build with: +# extism-py plugin/__init__.py -o coverartarchive-py.wasm +# +# Test with: +# extism call coverartarchive-py.wasm nd_get_album_images --wasi \ +# --input '{"name":"Dummy","artist":"Portishead","mbid":"76df3287-6cda-33eb-8e9a-044b5e15ffdd"}' \ +# --allow-host "coverartarchive.org" --allow-host "archive.org" + +import extism +import json + + +@extism.plugin_fn +def nd_get_album_images(): + """Retrieve album cover images from Cover Art Archive.""" + input_data = extism.input_json() + mbid = input_data.get("mbid", "") + + if not mbid: + raise Exception("not found: MBID required") + + # Query Cover Art Archive API + url = f"https://coverartarchive.org/release/{mbid}" + response = extism.Http.request(url, meth="GET") + + if response.status_code != 200: + raise Exception(f"not found: CAA returned status {response.status_code}") + + try: + data = json.loads(response.data_str()) + except json.JSONDecodeError: + raise Exception("not found: invalid JSON response") + + caa_images = data.get("images", []) + if not caa_images: + raise Exception("not found: no images in response") + + # Find the front cover image + front_image = find_front_image(caa_images) + if not front_image: + raise Exception("not found: no front cover image") + + # Build the response with available image sizes + images = build_image_list(front_image) + if not images: + raise Exception("not found: no usable image URLs") + + extism.output_str(json.dumps({"images": images})) + + +def find_front_image(images): + """Find the front cover image from CAA response.""" + # First, look for an image explicitly marked as front + for img in images: + if img.get("front", False): + return img + + # Second, look for an image with "Front" in types + for img in images: + types = img.get("types", []) + if "Front" in types: + return img + + # Fallback to first image + if images: + return images[0] + + return None + + +def build_image_list(img): + """Build list of images with URLs and sizes from CAA image data.""" + images = [] + thumbnails = img.get("thumbnails", {}) + + # First, try numeric sizes (250, 500, 1200, etc.) + for size_str, url in thumbnails.items(): + if not url: + continue + try: + size = int(size_str) + images.append({"url": url, "size": size}) + except ValueError: + pass # Not a numeric size + + # If no numeric sizes, fallback to named sizes + if not images: + size_map = {"large": 500, "small": 250} + for size_name, size in size_map.items(): + url = thumbnails.get(size_name) + if url: + images.append({"url": url, "size": size}) + + # If still no images, use the main image URL + if not images: + main_url = img.get("image") + if main_url: + images.append({"url": main_url, "size": 0}) + + return images diff --git a/plugins/examples/coverartarchive/README.md b/plugins/examples/coverartarchive/README.md deleted file mode 100644 index e886f6871..000000000 --- a/plugins/examples/coverartarchive/README.md +++ /dev/null @@ -1,34 +0,0 @@ -# Cover Art Archive AlbumMetadataService Plugin - -This plugin provides album cover images for Navidrome by querying the [Cover Art Archive](https://coverartarchive.org/) API using the MusicBrainz Release Group MBID. - -## Features - -- Implements only the `GetAlbumImages` method of the AlbumMetadataService plugin interface. -- Returns front cover images for a given release-group MBID. -- Returns `not found` if no MBID is provided or no images are found. - -## Requirements - -- Go 1.24 or newer (with WASI support) -- The Navidrome repository (with generated plugin API code in `plugins/api`) - -## How to Compile - -To build the WASM plugin, run the following command from the project root: - -```sh -GOOS=wasip1 GOARCH=wasm go build -buildmode=c-shared -o plugins/testdata/coverartarchive/plugin.wasm ./plugins/testdata/coverartarchive -``` - -This will produce `plugin.wasm` in this directory. - -## Usage - -- The plugin can be loaded by Navidrome for integration and end-to-end tests of the plugin system. -- It is intended for testing and development purposes only. - -## API Reference - -- [Cover Art Archive API](https://musicbrainz.org/doc/Cover_Art_Archive/API) -- This plugin uses the endpoint: `https://coverartarchive.org/release-group/{mbid}` diff --git a/plugins/examples/coverartarchive/manifest.json b/plugins/examples/coverartarchive/manifest.json deleted file mode 100644 index 4049fc358..000000000 --- a/plugins/examples/coverartarchive/manifest.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "$schema": "https://raw.githubusercontent.com/navidrome/navidrome/refs/heads/master/plugins/schema/manifest.schema.json", - "name": "coverartarchive", - "author": "Navidrome", - "version": "1.0.0", - "description": "Album cover art from the Cover Art Archive", - "website": "https://coverartarchive.org", - "capabilities": ["MetadataAgent"], - "permissions": { - "http": { - "reason": "To fetch album cover art from the Cover Art Archive API", - "allowedUrls": { - "https://coverartarchive.org": ["GET"], - "https://*.archive.org": ["GET"] - }, - "allowLocalNetwork": false - } - } -} diff --git a/plugins/examples/coverartarchive/plugin.go b/plugins/examples/coverartarchive/plugin.go deleted file mode 100644 index ee612c31c..000000000 --- a/plugins/examples/coverartarchive/plugin.go +++ /dev/null @@ -1,151 +0,0 @@ -//go:build wasip1 - -package main - -import ( - "context" - "encoding/json" - "fmt" - "log" - - "github.com/navidrome/navidrome/plugins/api" - "github.com/navidrome/navidrome/plugins/host/http" -) - -type CoverArtArchiveAgent struct{} - -var ErrNotFound = api.ErrNotFound - -type caaImage struct { - Image string `json:"image"` - Front bool `json:"front"` - Types []string `json:"types"` - Thumbnails map[string]string `json:"thumbnails"` -} - -var client = http.NewHttpService() - -func (CoverArtArchiveAgent) GetAlbumImages(ctx context.Context, req *api.AlbumImagesRequest) (*api.AlbumImagesResponse, error) { - if req.Mbid == "" { - return nil, ErrNotFound - } - - url := "https://coverartarchive.org/release/" + req.Mbid - resp, err := client.Get(ctx, &http.HttpRequest{Url: url, TimeoutMs: 5000}) - if err != nil || resp.Status != 200 { - log.Printf("[CAA] Error getting album images from CoverArtArchive (status: %d): %v", resp.Status, err) - return nil, ErrNotFound - } - - images, err := extractFrontImages(resp.Body) - if err != nil || len(images) == 0 { - return nil, ErrNotFound - } - return &api.AlbumImagesResponse{Images: images}, nil -} - -func extractFrontImages(body []byte) ([]*api.ExternalImage, error) { - var data struct { - Images []caaImage `json:"images"` - } - if err := json.Unmarshal(body, &data); err != nil { - return nil, err - } - img := findFrontImage(data.Images) - if img == nil { - return nil, ErrNotFound - } - return buildImageList(img), nil -} - -func findFrontImage(images []caaImage) *caaImage { - for i, img := range images { - if img.Front { - return &images[i] - } - } - for i, img := range images { - for _, t := range img.Types { - if t == "Front" { - return &images[i] - } - } - } - if len(images) > 0 { - return &images[0] - } - return nil -} - -func buildImageList(img *caaImage) []*api.ExternalImage { - var images []*api.ExternalImage - // First, try numeric sizes only - for sizeStr, url := range img.Thumbnails { - if url == "" { - continue - } - size := 0 - if _, err := fmt.Sscanf(sizeStr, "%d", &size); err == nil { - images = append(images, &api.ExternalImage{Url: url, Size: int32(size)}) - } - } - // If no numeric sizes, fallback to large/small - if len(images) == 0 { - for sizeStr, url := range img.Thumbnails { - if url == "" { - continue - } - var size int - switch sizeStr { - case "large": - size = 500 - case "small": - size = 250 - default: - continue - } - images = append(images, &api.ExternalImage{Url: url, Size: int32(size)}) - } - } - if len(images) == 0 && img.Image != "" { - images = append(images, &api.ExternalImage{Url: img.Image, Size: 0}) - } - return images -} - -func (CoverArtArchiveAgent) GetAlbumInfo(ctx context.Context, req *api.AlbumInfoRequest) (*api.AlbumInfoResponse, error) { - return nil, api.ErrNotImplemented -} -func (CoverArtArchiveAgent) GetArtistMBID(ctx context.Context, req *api.ArtistMBIDRequest) (*api.ArtistMBIDResponse, error) { - return nil, api.ErrNotImplemented -} - -func (CoverArtArchiveAgent) GetArtistURL(ctx context.Context, req *api.ArtistURLRequest) (*api.ArtistURLResponse, error) { - return nil, api.ErrNotImplemented -} - -func (CoverArtArchiveAgent) GetArtistBiography(ctx context.Context, req *api.ArtistBiographyRequest) (*api.ArtistBiographyResponse, error) { - return nil, api.ErrNotImplemented -} - -func (CoverArtArchiveAgent) GetSimilarArtists(ctx context.Context, req *api.ArtistSimilarRequest) (*api.ArtistSimilarResponse, error) { - return nil, api.ErrNotImplemented -} - -func (CoverArtArchiveAgent) GetArtistImages(ctx context.Context, req *api.ArtistImageRequest) (*api.ArtistImageResponse, error) { - return nil, api.ErrNotImplemented -} - -func (CoverArtArchiveAgent) GetArtistTopSongs(ctx context.Context, req *api.ArtistTopSongsRequest) (*api.ArtistTopSongsResponse, error) { - return nil, api.ErrNotImplemented -} - -func main() {} - -func init() { - // Configure logging: No timestamps, no source file/line - log.SetFlags(0) - log.SetPrefix("[CAA] ") - - api.RegisterMetadataAgent(CoverArtArchiveAgent{}) -} diff --git a/plugins/examples/crypto-ticker/README.md b/plugins/examples/crypto-ticker/README.md index ca6d2c44a..7f23433f5 100644 --- a/plugins/examples/crypto-ticker/README.md +++ b/plugins/examples/crypto-ticker/README.md @@ -6,48 +6,86 @@ This is a WebSocket-based WASM plugin for Navidrome that displays real-time cryp - Connects to Coinbase WebSocket API to receive real-time ticker updates - Configurable to track multiple cryptocurrency pairs -- Implements WebSocketCallback and LifecycleManagement interfaces -- Automatically reconnects on connection loss +- Implements WebSocket callback handlers for message processing +- Automatically reconnects on connection loss using the scheduler service - Displays price, best bid, best ask, and 24-hour percentage change ## Configuration -In your `navidrome.toml` file, add: +Configure in the Navidrome UI (Settings → Plugins → crypto-ticker): -```toml -[PluginConfig.crypto-ticker] -tickers = "BTC,ETH,SOL,MATIC" -``` +| Key | Description | Default | +|-----------|----------------------------------------------------------------------|-----------| +| `tickers` | Comma-separated list of cryptocurrency symbols (e.g., `BTC,ETH,SOL`) | `BTC,ETH` | -- `tickers` is a comma-separated list of cryptocurrency symbols -- The plugin will append `-USD` to any symbol without a trading pair specified +The plugin will append `-USD` to any symbol without a trading pair specified. ## How it Works -- The plugin connects to Coinbase's WebSocket API upon initialization -- It subscribes to ticker updates for the configured cryptocurrencies -- Incoming ticker data is processed and logged -- On connection loss, it automatically attempts to reconnect (TODO) +1. On plugin initialization, connects to Coinbase's WebSocket API +2. Subscribes to ticker updates for the configured cryptocurrencies +3. Incoming ticker data is processed via `nd_websocket_on_text_message` callback +4. On connection loss, schedules a reconnection attempt via the scheduler service +5. Reconnection is attempted until successful ## Building -To build the plugin to WASM: +To build the plugin and package as `.ndp`: +```bash +# Using TinyGo (recommended - smaller binary) +tinygo build -o plugin.wasm -target wasip1 -buildmode=c-shared . +zip -j crypto-ticker.ndp manifest.json plugin.wasm ``` -GOOS=wasip1 GOARCH=wasm go build -buildmode=c-shared -o plugin.wasm plugin.go + +Or from the `plugins/examples/` directory: + +```bash +make crypto-ticker.ndp ``` ## Installation -Copy the resulting `plugin.wasm` and create a `manifest.json` file in your Navidrome plugins folder under a `crypto-ticker` directory. +Copy the resulting `crypto-ticker.ndp` to your Navidrome plugins folder. ## Example Output ``` -CRYPTO TICKER: BTC-USD Price: 65432.50 Best Bid: 65431.25 Best Ask: 65433.75 24h Change: 2.75% -CRYPTO TICKER: ETH-USD Price: 3456.78 Best Bid: 3455.90 Best Ask: 3457.80 24h Change: 1.25% +[Crypto] Crypto Ticker Plugin initializing... +[Crypto] Configured tickers: [BTC-USD ETH-USD] +[Crypto] Connected to Coinbase WebSocket API (connection: crypto-ticker-conn) +[Crypto] Subscription message sent to Coinbase WebSocket API +[Crypto] Received subscriptions message +[Crypto] 💰 BTC-USD: $98765.43 (24h: +2.35%) Bid: $98764.00 Ask: $98766.00 +[Crypto] 💰 ETH-USD: $3456.78 (24h: -0.54%) Bid: $3455.90 Ask: $3457.80 ``` +## Permissions Required + +- **config**: Read ticker symbols configuration +- **websocket**: Connect to `ws-feed.exchange.coinbase.com` +- **scheduler**: Schedule reconnection attempts + +## Files + +- `main.go` - Main plugin implementation +- `go.mod` - Go module file + +## PDK + +This plugin imports the Navidrome PDK subpackages directly: + +```go +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/host" + "github.com/navidrome/navidrome/plugins/pdk/go/lifecycle" + "github.com/navidrome/navidrome/plugins/pdk/go/scheduler" + "github.com/navidrome/navidrome/plugins/pdk/go/websocket" +) +``` + +The `go.mod` file uses `replace` directives to point to the local packages for development. + --- -For more details, see the source code in `plugin.go`. +For more details, see the source code in `main.go`. diff --git a/plugins/examples/crypto-ticker/go.mod b/plugins/examples/crypto-ticker/go.mod new file mode 100755 index 000000000..f2884679a --- /dev/null +++ b/plugins/examples/crypto-ticker/go.mod @@ -0,0 +1,16 @@ +module crypto-ticker + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/examples/crypto-ticker/go.sum b/plugins/examples/crypto-ticker/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/examples/crypto-ticker/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/examples/crypto-ticker/main.go b/plugins/examples/crypto-ticker/main.go new file mode 100755 index 000000000..8fc189128 --- /dev/null +++ b/plugins/examples/crypto-ticker/main.go @@ -0,0 +1,302 @@ +// Crypto Ticker Plugin - Demonstrates WebSocket host service capabilities. +// +// This plugin connects to Coinbase's WebSocket API to receive real-time +// cryptocurrency price updates and logs them to the Navidrome console. +package main + +import ( + "encoding/json" + "fmt" + "strings" + + "github.com/navidrome/navidrome/plugins/pdk/go/host" + "github.com/navidrome/navidrome/plugins/pdk/go/lifecycle" + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" + "github.com/navidrome/navidrome/plugins/pdk/go/scheduler" + "github.com/navidrome/navidrome/plugins/pdk/go/websocket" +) + +const ( + // Coinbase WebSocket API endpoint + coinbaseWSEndpoint = "wss://ws-feed.exchange.coinbase.com" + + // Connection ID for our WebSocket connection + connectionID = "crypto-ticker-conn" + + // ID for the reconnection schedule + reconnectScheduleID = "crypto-ticker-reconnect" + + // Config keys (must match manifest.json schema property names) + symbolsKey = "symbols" + reconnectDelayKey = "reconnectDelay" + logPricesKey = "logPrices" + + // Default values + defaultReconnectDelay = 5 +) + +// CoinbaseSubscription message structure +type CoinbaseSubscription struct { + Type string `json:"type"` + ProductIDs []string `json:"product_ids"` + Channels []string `json:"channels"` +} + +// CoinbaseTicker message structure +type CoinbaseTicker struct { + Type string `json:"type"` + Sequence int64 `json:"sequence"` + ProductID string `json:"product_id"` + Price string `json:"price"` + Open24h string `json:"open_24h"` + Volume24h string `json:"volume_24h"` + Low24h string `json:"low_24h"` + High24h string `json:"high_24h"` + BestBid string `json:"best_bid"` + BestAsk string `json:"best_ask"` + Time string `json:"time"` +} + +// cryptoTickerPlugin implements the lifecycle, websocket and scheduler interfaces. +type cryptoTickerPlugin struct{} + +// init registers the plugin capabilities +func init() { + lifecycle.Register(&cryptoTickerPlugin{}) + websocket.Register(&cryptoTickerPlugin{}) + scheduler.Register(&cryptoTickerPlugin{}) +} + +// Ensure cryptoTickerPlugin implements the required provider interfaces +var ( + _ lifecycle.InitProvider = (*cryptoTickerPlugin)(nil) + _ websocket.TextMessageProvider = (*cryptoTickerPlugin)(nil) + _ websocket.BinaryMessageProvider = (*cryptoTickerPlugin)(nil) + _ websocket.ErrorProvider = (*cryptoTickerPlugin)(nil) + _ websocket.CloseProvider = (*cryptoTickerPlugin)(nil) + _ scheduler.CallbackProvider = (*cryptoTickerPlugin)(nil) +) + +// OnInit is called when the plugin is loaded. +// We use this to establish the initial WebSocket connection. +func (p *cryptoTickerPlugin) OnInit() error { + pdk.Log(pdk.LogInfo, "Crypto Ticker Plugin initializing...") + + // Get ticker configuration from JSON schema config + symbols := getSymbols() + pdk.Log(pdk.LogInfo, fmt.Sprintf("Configured symbols: %v", symbols)) + + // Connect to WebSocket + // Errors won't fail init - reconnect logic will handle it + return connectAndSubscribe(symbols) +} + +// getSymbols reads the symbols array from config +func getSymbols() []string { + defaultSymbols := []string{"BTC-USD"} + symbolsJSON, ok := pdk.GetConfig(symbolsKey) + if !ok || symbolsJSON == "" { + return defaultSymbols + } + + var symbols []string + if err := json.Unmarshal([]byte(symbolsJSON), &symbols); err != nil { + pdk.Log(pdk.LogWarn, fmt.Sprintf("failed to parse symbols config: %v, using defaults", err)) + return defaultSymbols + } + + if len(symbols) == 0 { + return defaultSymbols + } + + // Normalize symbols - add -USD suffix if not present + for i, s := range symbols { + s = strings.TrimSpace(s) + if !strings.Contains(s, "-") { + symbols[i] = s + "-USD" + } else { + symbols[i] = s + } + } + + return symbols +} + +// getReconnectDelay reads the reconnect delay from config +func getReconnectDelay() int32 { + delayStr, ok := pdk.GetConfig(reconnectDelayKey) + if !ok || delayStr == "" { + return defaultReconnectDelay + } + + var delay int + if _, err := fmt.Sscanf(delayStr, "%d", &delay); err != nil || delay < 1 { + return defaultReconnectDelay + } + return int32(delay) +} + +// shouldLogPrices reads the logPrices setting from config +func shouldLogPrices() bool { + logStr, ok := pdk.GetConfig(logPricesKey) + if !ok || logStr == "" { + return false + } + return logStr == "true" +} + +// connectAndSubscribe connects to Coinbase WebSocket and subscribes to tickers +func connectAndSubscribe(tickers []string) error { + // Connect to WebSocket using host function + newConnID, err := host.WebSocketConnect(coinbaseWSEndpoint, nil, connectionID) + if err != nil { + return fmt.Errorf("WebSocket connection error: %w", err) + } + pdk.Log(pdk.LogInfo, fmt.Sprintf("Connected to Coinbase WebSocket API (connection: %s)", newConnID)) + + // Subscribe to ticker channel + subscription := CoinbaseSubscription{ + Type: "subscribe", + ProductIDs: tickers, + Channels: []string{"ticker"}, + } + + subscriptionJSON, err := json.Marshal(subscription) + if err != nil { + return fmt.Errorf("JSON marshal error: %v", err) + } + + // Send subscription message + err = host.WebSocketSendText(connectionID, string(subscriptionJSON)) + if err != nil { + return fmt.Errorf("WebSocket send error: %w", err) + } + + pdk.Log(pdk.LogInfo, "Subscription message sent to Coinbase WebSocket API") + return nil +} + +// OnTextMessage is called when a text message is received +func (p *cryptoTickerPlugin) OnTextMessage(input websocket.OnTextMessageRequest) error { + // Only process messages from our connection + if input.ConnectionID != connectionID { + return nil + } + + // Try to parse as a ticker message + var ticker CoinbaseTicker + err := json.Unmarshal([]byte(input.Message), &ticker) + if err != nil { + // Not a valid JSON message, ignore + return nil + } + + // Only process ticker messages + if ticker.Type != "ticker" { + // Could be subscription confirmation or heartbeat + if ticker.Type != "" { + pdk.Log(pdk.LogDebug, fmt.Sprintf("Received %s message", ticker.Type)) + } + return nil + } + + // Calculate 24h change percentage + change := calculatePercentChange(ticker.Open24h, ticker.Price) + + // Log ticker information (only if enabled in config) + if shouldLogPrices() { + pdk.Log(pdk.LogInfo, fmt.Sprintf("💰 %s: $%s (24h: %s%%) Bid: $%s Ask: $%s", + ticker.ProductID, + ticker.Price, + change, + ticker.BestBid, + ticker.BestAsk, + )) + } + + return nil +} + +// OnBinaryMessage is called when a binary message is received +func (p *cryptoTickerPlugin) OnBinaryMessage(input websocket.OnBinaryMessageRequest) error { + // Coinbase doesn't send binary messages, but we implement the handler anyway + pdk.Log(pdk.LogWarn, fmt.Sprintf("Received unexpected binary message on connection %s", input.ConnectionID)) + return nil +} + +// OnError is called when an error occurs on the WebSocket connection +func (p *cryptoTickerPlugin) OnError(input websocket.OnErrorRequest) error { + pdk.Log(pdk.LogError, fmt.Sprintf("WebSocket error on connection %s: %s", input.ConnectionID, input.Error)) + return nil +} + +// OnClose is called when the WebSocket connection is closed +func (p *cryptoTickerPlugin) OnClose(input websocket.OnCloseRequest) error { + pdk.Log(pdk.LogInfo, fmt.Sprintf("WebSocket connection %s closed (code: %d, reason: %s)", + input.ConnectionID, input.Code, input.Reason)) + + // Only attempt reconnect for our connection + if input.ConnectionID == connectionID { + delay := getReconnectDelay() + pdk.Log(pdk.LogInfo, fmt.Sprintf("Scheduling reconnection attempt in %d seconds...", delay)) + + // Schedule a one-time reconnection attempt + _, err := host.SchedulerScheduleOneTime(delay, "reconnect", reconnectScheduleID) + if err != nil { + pdk.Log(pdk.LogError, fmt.Sprintf("Failed to schedule reconnection: %v", err)) + } + } + + return nil +} + +// OnCallback is called when a scheduled task fires +func (p *cryptoTickerPlugin) OnCallback(input scheduler.SchedulerCallbackRequest) error { + // Only handle our reconnection schedule + if input.ScheduleID != reconnectScheduleID { + return nil + } + + pdk.Log(pdk.LogInfo, "Attempting to reconnect to Coinbase WebSocket API...") + + // Get ticker configuration + symbols := getSymbols() + + // Try to connect and subscribe + err := connectAndSubscribe(symbols) + if err != nil { + delay := getReconnectDelay() * 2 // Double delay on failure + pdk.Log(pdk.LogError, fmt.Sprintf("Reconnection failed: %v - will retry in %d seconds", err, delay)) + + // Schedule another attempt + _, err := host.SchedulerScheduleOneTime(delay, "reconnect", reconnectScheduleID) + if err != nil { + pdk.Log(pdk.LogError, fmt.Sprintf("Failed to schedule retry: %v", err)) + } + } else { + pdk.Log(pdk.LogInfo, "Successfully reconnected!") + } + + return nil +} + +// calculatePercentChange calculates the percentage change between open and current price +func calculatePercentChange(open, current string) string { + var openFloat, currentFloat float64 + _, err := fmt.Sscanf(open, "%f", &openFloat) + if err != nil || openFloat == 0 { + return "N/A" + } + _, err = fmt.Sscanf(current, "%f", ¤tFloat) + if err != nil { + return "N/A" + } + + change := ((currentFloat - openFloat) / openFloat) * 100 + if change >= 0 { + return fmt.Sprintf("+%.2f", change) + } + return fmt.Sprintf("%.2f", change) +} + +func main() {} diff --git a/plugins/examples/crypto-ticker/manifest.json b/plugins/examples/crypto-ticker/manifest.json index 482731684..362fcd0e9 100644 --- a/plugins/examples/crypto-ticker/manifest.json +++ b/plugins/examples/crypto-ticker/manifest.json @@ -1,25 +1,71 @@ { - "name": "crypto-ticker", - "author": "Navidrome Plugin", + "name": "Crypto Ticker", + "author": "Navidrome", "version": "1.0.0", - "description": "A plugin that tracks crypto currency prices using Coinbase WebSocket API", + "description": "Real-time cryptocurrency price ticker using Coinbase WebSocket API", "website": "https://github.com/navidrome/navidrome/tree/master/plugins/examples/crypto-ticker", - "capabilities": [ - "WebSocketCallback", - "LifecycleManagement", - "SchedulerCallback" - ], - "permissions": { - "config": { - "reason": "To read API configuration and WebSocket endpoint settings" + "config": { + "schema": { + "type": "object", + "properties": { + "symbols": { + "type": "array", + "title": "Trading Pairs", + "description": "Cryptocurrency trading pairs to track (default: BTC-USD)", + "items": { + "type": "string", + "title": "Trading Pair", + "pattern": "^[A-Z]{3,5}-[A-Z]{3,5}$", + "description": "Trading pair in the format BASE-QUOTE (e.g., BTC-USD, ETH-USD)" + }, + "default": ["BTC-USD"] + }, + "reconnectDelay": { + "type": "integer", + "title": "Reconnect Delay", + "description": "Delay in seconds before attempting to reconnect after connection loss", + "default": 5, + "minimum": 1, + "maximum": 60 + }, + "logPrices": { + "type": "boolean", + "title": "Log Prices", + "description": "Whether to log price updates to the server log", + "default": false + } + } }, + "uiSchema": { + "type": "VerticalLayout", + "elements": [ + { + "type": "Control", + "scope": "#/properties/symbols" + }, + { + "type": "HorizontalLayout", + "elements": [ + { + "type": "Control", + "scope": "#/properties/reconnectDelay" + }, + { + "type": "Control", + "scope": "#/properties/logPrices" + } + ] + } + ] + } + }, + "permissions": { "scheduler": { - "reason": "To schedule periodic reconnection attempts and status updates" + "reason": "To schedule reconnection attempts on connection loss" }, "websocket": { - "reason": "To connect to Coinbase WebSocket API for real-time cryptocurrency prices", - "allowedUrls": ["wss://ws-feed.exchange.coinbase.com"], - "allowLocalNetwork": false + "reason": "To connect to Coinbase WebSocket API for real-time prices", + "requiredHosts": ["ws-feed.exchange.coinbase.com"] } } } diff --git a/plugins/examples/crypto-ticker/plugin.go b/plugins/examples/crypto-ticker/plugin.go deleted file mode 100644 index 3fced6d5c..000000000 --- a/plugins/examples/crypto-ticker/plugin.go +++ /dev/null @@ -1,304 +0,0 @@ -//go:build wasip1 - -package main - -import ( - "context" - "encoding/json" - "fmt" - "log" - "strings" - - "github.com/navidrome/navidrome/plugins/api" - "github.com/navidrome/navidrome/plugins/host/config" - "github.com/navidrome/navidrome/plugins/host/scheduler" - "github.com/navidrome/navidrome/plugins/host/websocket" -) - -const ( - // Coinbase WebSocket API endpoint - coinbaseWSEndpoint = "wss://ws-feed.exchange.coinbase.com" - - // Connection ID for our WebSocket connection - connectionID = "crypto-ticker-connection" - - // ID for the reconnection schedule - reconnectScheduleID = "crypto-ticker-reconnect" -) - -var ( - // Store ticker symbols from the configuration - tickers []string -) - -// WebSocketService instance used to manage WebSocket connections and communication. -var wsService = websocket.NewWebSocketService() - -// ConfigService instance for accessing plugin configuration. -var configService = config.NewConfigService() - -// SchedulerService instance for scheduling tasks. -var schedService = scheduler.NewSchedulerService() - -// CryptoTickerPlugin implements WebSocketCallback, LifecycleManagement, and SchedulerCallback interfaces -type CryptoTickerPlugin struct{} - -// Coinbase subscription message structure -type CoinbaseSubscription struct { - Type string `json:"type"` - ProductIDs []string `json:"product_ids"` - Channels []string `json:"channels"` -} - -// Coinbase ticker message structure -type CoinbaseTicker struct { - Type string `json:"type"` - Sequence int64 `json:"sequence"` - ProductID string `json:"product_id"` - Price string `json:"price"` - Open24h string `json:"open_24h"` - Volume24h string `json:"volume_24h"` - Low24h string `json:"low_24h"` - High24h string `json:"high_24h"` - Volume30d string `json:"volume_30d"` - BestBid string `json:"best_bid"` - BestAsk string `json:"best_ask"` - Side string `json:"side"` - Time string `json:"time"` - TradeID int `json:"trade_id"` - LastSize string `json:"last_size"` -} - -// OnInit is called when the plugin is loaded -func (CryptoTickerPlugin) OnInit(ctx context.Context, req *api.InitRequest) (*api.InitResponse, error) { - log.Printf("Crypto Ticker Plugin initializing...") - - // Check if ticker configuration exists - tickerConfig, ok := req.Config["tickers"] - if !ok { - return &api.InitResponse{Error: "Missing 'tickers' configuration"}, nil - } - - // Parse ticker symbols - tickers := parseTickerSymbols(tickerConfig) - log.Printf("Configured tickers: %v", tickers) - - // Connect to WebSocket and subscribe to tickers - err := connectAndSubscribe(ctx, tickers) - if err != nil { - return &api.InitResponse{Error: err.Error()}, nil - } - - return &api.InitResponse{}, nil -} - -// Helper function to parse ticker symbols from a comma-separated string -func parseTickerSymbols(tickerConfig string) []string { - tickers := strings.Split(tickerConfig, ",") - for i, ticker := range tickers { - tickers[i] = strings.TrimSpace(ticker) - - // Add -USD suffix if not present - if !strings.Contains(tickers[i], "-") { - tickers[i] = tickers[i] + "-USD" - } - } - return tickers -} - -// Helper function to connect to WebSocket and subscribe to tickers -func connectAndSubscribe(ctx context.Context, tickers []string) error { - // Connect to the WebSocket API - _, err := wsService.Connect(ctx, &websocket.ConnectRequest{ - Url: coinbaseWSEndpoint, - ConnectionId: connectionID, - }) - - if err != nil { - log.Printf("Failed to connect to Coinbase WebSocket API: %v", err) - return fmt.Errorf("WebSocket connection error: %v", err) - } - - log.Printf("Connected to Coinbase WebSocket API") - - // Subscribe to ticker channel for the configured symbols - subscription := CoinbaseSubscription{ - Type: "subscribe", - ProductIDs: tickers, - Channels: []string{"ticker"}, - } - - subscriptionJSON, err := json.Marshal(subscription) - if err != nil { - log.Printf("Failed to marshal subscription message: %v", err) - return fmt.Errorf("JSON marshal error: %v", err) - } - - // Send subscription message - _, err = wsService.SendText(ctx, &websocket.SendTextRequest{ - ConnectionId: connectionID, - Message: string(subscriptionJSON), - }) - - if err != nil { - log.Printf("Failed to send subscription message: %v", err) - return fmt.Errorf("WebSocket send error: %v", err) - } - - log.Printf("Subscription message sent to Coinbase WebSocket API") - return nil -} - -// OnTextMessage is called when a text message is received from the WebSocket -func (CryptoTickerPlugin) OnTextMessage(ctx context.Context, req *api.OnTextMessageRequest) (*api.OnTextMessageResponse, error) { - // Only process messages from our connection - if req.ConnectionId != connectionID { - log.Printf("Received message from unexpected connection: %s", req.ConnectionId) - return &api.OnTextMessageResponse{}, nil - } - - // Try to parse as a ticker message - var ticker CoinbaseTicker - err := json.Unmarshal([]byte(req.Message), &ticker) - if err != nil { - log.Printf("Failed to parse ticker message: %v", err) - return &api.OnTextMessageResponse{}, nil - } - - // If the message is not a ticker or has an error, just log it - if ticker.Type != "ticker" { - // This could be subscription confirmation or other messages - log.Printf("Received non-ticker message: %s", req.Message) - return &api.OnTextMessageResponse{}, nil - } - - // Format and print ticker information - log.Printf("CRYPTO TICKER: %s Price: %s Best Bid: %s Best Ask: %s 24h Change: %s%%\n", - ticker.ProductID, - ticker.Price, - ticker.BestBid, - ticker.BestAsk, - calculatePercentChange(ticker.Open24h, ticker.Price), - ) - - return &api.OnTextMessageResponse{}, nil -} - -// OnBinaryMessage is called when a binary message is received -func (CryptoTickerPlugin) OnBinaryMessage(ctx context.Context, req *api.OnBinaryMessageRequest) (*api.OnBinaryMessageResponse, error) { - // Not expected from Coinbase WebSocket API - return &api.OnBinaryMessageResponse{}, nil -} - -// OnError is called when an error occurs on the WebSocket connection -func (CryptoTickerPlugin) OnError(ctx context.Context, req *api.OnErrorRequest) (*api.OnErrorResponse, error) { - log.Printf("WebSocket error: %s", req.Error) - return &api.OnErrorResponse{}, nil -} - -// OnClose is called when the WebSocket connection is closed -func (CryptoTickerPlugin) OnClose(ctx context.Context, req *api.OnCloseRequest) (*api.OnCloseResponse, error) { - log.Printf("WebSocket connection closed with code %d: %s", req.Code, req.Reason) - - // Try to reconnect if this is our connection - if req.ConnectionId == connectionID { - log.Printf("Scheduling reconnection attempts every 2 seconds...") - - // Create a recurring schedule to attempt reconnection every 2 seconds - resp, err := schedService.ScheduleRecurring(ctx, &scheduler.ScheduleRecurringRequest{ - // Run every 2 seconds using cron expression - CronExpression: "*/2 * * * * *", - ScheduleId: reconnectScheduleID, - }) - - if err != nil { - log.Printf("Failed to schedule reconnection attempts: %v", err) - } else { - log.Printf("Reconnection schedule created with ID: %s", resp.ScheduleId) - } - } - - return &api.OnCloseResponse{}, nil -} - -// OnSchedulerCallback is called when a scheduled event triggers -func (CryptoTickerPlugin) OnSchedulerCallback(ctx context.Context, req *api.SchedulerCallbackRequest) (*api.SchedulerCallbackResponse, error) { - // Only handle our reconnection schedule - if req.ScheduleId != reconnectScheduleID { - log.Printf("Received callback for unknown schedule: %s", req.ScheduleId) - return &api.SchedulerCallbackResponse{}, nil - } - - log.Printf("Attempting to reconnect to Coinbase WebSocket API...") - - // Get the current ticker configuration - configResp, err := configService.GetPluginConfig(ctx, &config.GetPluginConfigRequest{}) - if err != nil { - log.Printf("Failed to get plugin configuration: %v", err) - return &api.SchedulerCallbackResponse{Error: fmt.Sprintf("Config error: %v", err)}, nil - } - - // Check if ticker configuration exists - tickerConfig, ok := configResp.Config["tickers"] - if !ok { - log.Printf("Missing 'tickers' configuration") - return &api.SchedulerCallbackResponse{Error: "Missing 'tickers' configuration"}, nil - } - - // Parse ticker symbols - tickers := parseTickerSymbols(tickerConfig) - log.Printf("Reconnecting with tickers: %v", tickers) - - // Try to connect and subscribe - err = connectAndSubscribe(ctx, tickers) - if err != nil { - log.Printf("Reconnection attempt failed: %v", err) - return &api.SchedulerCallbackResponse{Error: err.Error()}, nil - } - - // Successfully reconnected, cancel the reconnection schedule - _, err = schedService.CancelSchedule(ctx, &scheduler.CancelRequest{ - ScheduleId: reconnectScheduleID, - }) - - if err != nil { - log.Printf("Failed to cancel reconnection schedule: %v", err) - } else { - log.Printf("Reconnection schedule canceled after successful reconnection") - } - - return &api.SchedulerCallbackResponse{}, nil -} - -// Helper function to calculate percent change -func calculatePercentChange(open, current string) string { - var openFloat, currentFloat float64 - _, err := fmt.Sscanf(open, "%f", &openFloat) - if err != nil { - return "N/A" - } - _, err = fmt.Sscanf(current, "%f", ¤tFloat) - if err != nil { - return "N/A" - } - - if openFloat == 0 { - return "N/A" - } - - change := ((currentFloat - openFloat) / openFloat) * 100 - return fmt.Sprintf("%.2f", change) -} - -// Required by Go WASI build -func main() {} - -func init() { - // Configure logging: No timestamps, no source file/line, prepend [Crypto] - log.SetFlags(0) - log.SetPrefix("[Crypto] ") - - api.RegisterWebSocketCallback(CryptoTickerPlugin{}) - api.RegisterLifecycleManagement(CryptoTickerPlugin{}) - api.RegisterSchedulerCallback(CryptoTickerPlugin{}) -} diff --git a/plugins/examples/discord-rich-presence-rs/.cargo/config.toml b/plugins/examples/discord-rich-presence-rs/.cargo/config.toml new file mode 100644 index 000000000..6b509f5b7 --- /dev/null +++ b/plugins/examples/discord-rich-presence-rs/.cargo/config.toml @@ -0,0 +1,2 @@ +[build] +target = "wasm32-wasip1" diff --git a/plugins/examples/discord-rich-presence-rs/Cargo.toml b/plugins/examples/discord-rich-presence-rs/Cargo.toml new file mode 100644 index 000000000..bc473147d --- /dev/null +++ b/plugins/examples/discord-rich-presence-rs/Cargo.toml @@ -0,0 +1,16 @@ +[package] +name = "discord-rich-presence-rs" +version = "1.0.0" +edition = "2021" +description = "Discord Rich Presence plugin for Navidrome - Rust implementation" +authors = ["Navidrome Team"] +license = "GPL-3.0" + +[lib] +crate-type = ["cdylib"] + +[dependencies] +nd-pdk = { path = "../../pdk/rust/nd-pdk" } +extism-pdk = "1.2" +serde = { version = "1.0", features = ["derive"] } +serde_json = "1.0" diff --git a/plugins/examples/discord-rich-presence-rs/README.md b/plugins/examples/discord-rich-presence-rs/README.md new file mode 100644 index 000000000..5cd973af0 --- /dev/null +++ b/plugins/examples/discord-rich-presence-rs/README.md @@ -0,0 +1,100 @@ +# Discord Rich Presence Plugin (Rust) + +A Navidrome plugin that displays your currently playing track on Discord using Rich Presence. This is the Rust implementation demonstrating how to use the `nd-pdk` library. + +## ⚠️ Warning + +This plugin is for **demonstration purposes only**. It requires storing your Discord token in the Navidrome configuration file, which: + +1. Is not secure (tokens should never be stored in plain text) +2. May violate Discord's Terms of Service + +**Use at your own risk.** + +## Features + +- Shows currently playing track on Discord Rich Presence +- Displays album artwork +- Shows track progress with start/end timestamps +- Automatically clears presence when track finishes +- Supports multiple users + +## Capabilities + +This plugin implements multiple capabilities to demonstrate the nd-pdk library: + +- **Scrobbler**: Receives now-playing events from Navidrome +- **SchedulerCallback**: Handles heartbeat and activity clearing timers +- **WebSocketCallback**: Communicates with Discord gateway (text, binary, error, and close handlers) + +## Configuration + +Configure in the Navidrome UI (Settings → Plugins → discord-rich-presence-rs): + +| Key | Description | Example | +|---------------|--------------------------------------|---------------------------| +| `clientid` | Your Discord application ID | `123456789012345678` | +| `user.` | Discord token for the specified user | `user.alice` = `token123` | + +Each user is configured as a separate key with the `user.` prefix. + + +### Getting Configuration Values + +1. **Client ID**: Create a Discord Application at https://discord.com/developers/applications and copy the Application ID + +2. **Discord Token**: This requires extracting your user token from Discord (not recommended for security reasons) + +3. **Multiple Users**: Add multiple user keys: + ```properties + user.user1 = "token1" + user.user2 = "token2" + ``` + +## Building + +```bash +# From the plugins/examples directory +make discord-rich-presence-rs.ndp + +# This creates discord-rich-presence-rs.ndp containing: +# - manifest.json +# - plugin.wasm +``` + +## Installation + +1. Build the plugin using the command above +2. Copy the `.ndp` file to your Navidrome plugins directory +3. Enable and configure the plugin in the Navidrome UI (Settings → Plugins) +4. Restart Navidrome if needed + +## Using nd-pdk Library + +This plugin demonstrates how to use the Rust plugin development kit: + +```rust +use nd_pdk::host::{artwork, cache, scheduler, websocket}; +use std::collections::HashMap; + +// Get artwork URL +let url = artwork::get_track_url(track_id, 300)?; + +// Cache operations +cache::set_string("key", "value", 3600)?; +if let Some(value) = cache::get_string("key")? { + // Use the cached value +} + +// Schedule tasks +scheduler::schedule_one_time(60, "payload", "task-id")?; +scheduler::schedule_recurring("@every 30s", "heartbeat", "heartbeat-task")?; + +// WebSocket operations +let conn_id = websocket::connect("wss://example.com/socket", HashMap::new(), "my-conn")?; +websocket::send_text(&conn_id, "Hello")?; +``` + +## License + +GPL-3.0 diff --git a/plugins/examples/discord-rich-presence-rs/manifest.json b/plugins/examples/discord-rich-presence-rs/manifest.json new file mode 100644 index 000000000..4cf64b557 --- /dev/null +++ b/plugins/examples/discord-rich-presence-rs/manifest.json @@ -0,0 +1,98 @@ +{ + "name": "Discord Rich Presence (Rust)", + "author": "Navidrome Team", + "version": "1.0.0", + "description": "Discord Rich Presence integration for Navidrome - Rust implementation", + "website": "https://github.com/navidrome/navidrome/tree/master/plugins/examples/discord-rich-presence-rs", + "permissions": { + "users": { + "reason": "To process scrobbles on behalf of users" + }, + "http": { + "reason": "To communicate with Discord API for gateway discovery and image uploads", + "requiredHosts": ["discord.com"] + }, + "websocket": { + "reason": "To maintain real-time connection with Discord gateway", + "requiredHosts": ["gateway.discord.gg"] + }, + "cache": { + "reason": "To store connection state and sequence numbers" + }, + "scheduler": { + "reason": "To schedule heartbeat messages and activity clearing" + }, + "artwork": { + "reason": "To get track artwork URLs for rich presence display" + } + }, + "config": { + "schema": { + "type": "object", + "properties": { + "clientid": { + "type": "string", + "title": "Discord Application Client ID", + "description": "The Client ID from your Discord Developer Application. Create one at https://discord.com/developers/applications", + "minLength": 17, + "maxLength": 20, + "pattern": "^[0-9]+$" + }, + "users": { + "type": "array", + "title": "User Tokens", + "description": "Discord tokens for each Navidrome user. WARNING: Store tokens securely!", + "minItems": 1, + "items": { + "type": "object", + "properties": { + "username": { + "type": "string", + "title": "Navidrome Username", + "description": "The Navidrome username to associate with this Discord token", + "minLength": 1 + }, + "token": { + "type": "string", + "title": "Discord Token", + "description": "The user's Discord token (keep this secret!)", + "minLength": 1 + } + }, + "required": ["username", "token"] + } + } + }, + "required": ["clientid", "users"] + }, + "uiSchema": { + "type": "VerticalLayout", + "elements": [ + { + "type": "Control", + "scope": "#/properties/clientid" + }, + { + "type": "Control", + "scope": "#/properties/users", + "options": { + "elementLabelProp": "username", + "detail": { + "type": "HorizontalLayout", + "elements": [ + { + "type": "Control", + "scope": "#/properties/username" + }, + { + "type": "Control", + "scope": "#/properties/token" + } + ] + } + } + } + ] + } + } +} diff --git a/plugins/examples/discord-rich-presence-rs/src/lib.rs b/plugins/examples/discord-rich-presence-rs/src/lib.rs new file mode 100644 index 000000000..12bf9ed3e --- /dev/null +++ b/plugins/examples/discord-rich-presence-rs/src/lib.rs @@ -0,0 +1,289 @@ +//! Discord Rich Presence Plugin for Navidrome - Rust Implementation +//! +//! This plugin integrates Navidrome with Discord Rich Presence. It demonstrates how to: +//! - Use the nd-pdk crate for host service calls +//! - Implement the Scrobbler capability for now-playing updates +//! - Implement SchedulerCallback for heartbeat and activity clearing +//! - Implement WebSocketCallback for Discord gateway communication +//! +//! ## Configuration +//! +//! Configure this plugin through the Navidrome UI with: +//! - Discord Application Client ID +//! - User tokens array mapping Navidrome usernames to Discord tokens +//! +//! **WARNING**: This plugin is for demonstration purposes only. Storing Discord tokens +//! in configuration files is not secure and may violate Discord's terms of service. + +use extism_pdk::*; +use nd_pdk::host::{artwork, config, scheduler}; +use nd_pdk::scrobbler::{ + Error as ScrobblerError, IsAuthorizedRequest, NowPlayingRequest, + ScrobbleRequest, Scrobbler, SCROBBLER_ERROR_NOT_AUTHORIZED, SCROBBLER_ERROR_RETRY_LATER, +}; +use nd_pdk::scheduler::{ + CallbackProvider, Error as SchedulerError, SchedulerCallbackRequest, +}; +use nd_pdk::websocket::{ + BinaryMessageProvider, CloseProvider, Error as WebSocketError, ErrorProvider, + OnBinaryMessageRequest, OnCloseRequest, OnErrorRequest, OnTextMessageRequest, + TextMessageProvider, +}; +use serde::Deserialize; + +mod rpc; + +// Register capabilities using PDK macros +nd_pdk::register_scrobbler!(DiscordPlugin); +nd_pdk::register_scheduler_callback!(DiscordPlugin); +nd_pdk::register_websocket_text_message!(DiscordPlugin); +nd_pdk::register_websocket_binary_message!(DiscordPlugin); +nd_pdk::register_websocket_error!(DiscordPlugin); +nd_pdk::register_websocket_close!(DiscordPlugin); + +// ============================================================================ +// Constants +// ============================================================================ + +const CLIENT_ID_KEY: &str = "clientid"; +const USERS_KEY: &str = "users"; +const PAYLOAD_HEARTBEAT: &str = "heartbeat"; +const PAYLOAD_CLEAR_ACTIVITY: &str = "clear-activity"; + +// ============================================================================ +// Plugin Implementation +// ============================================================================ + +/// The Discord Rich Presence plugin type. +#[derive(Default)] +struct DiscordPlugin; + +// ============================================================================ +// Configuration +// ============================================================================ + +/// User token entry from the config schema +#[derive(Debug, Deserialize)] +struct UserToken { + username: String, + token: String, +} + +fn get_config() -> Result<(String, std::collections::HashMap), Error> { + let client_id = config::get(CLIENT_ID_KEY)? + .filter(|s| !s.is_empty()) + .ok_or_else(|| Error::msg("missing clientid in configuration"))?; + + // Get users array from config (JSON format) + let users_json = config::get(USERS_KEY)?.unwrap_or_default(); + + let mut users = std::collections::HashMap::new(); + if !users_json.is_empty() { + // Parse JSON array of user tokens + let user_tokens: Vec = serde_json::from_str(&users_json) + .map_err(|e| Error::msg(format!("failed to parse users config: {}", e)))?; + + for user_token in user_tokens { + if !user_token.username.is_empty() && !user_token.token.is_empty() { + users.insert(user_token.username, user_token.token); + } + } + } + + Ok((client_id, users)) +} + +fn get_image_url(track_id: &str) -> String { + match artwork::get_track_url(track_id, 300) { + Ok(url) => { + if url.starts_with("http://localhost") { + String::new() + } else { + url + } + } + Err(e) => { + warn!("Failed to get artwork URL: {:?}", e); + String::new() + } + } +} + +// ============================================================================ +// Scrobbler Implementation +// ============================================================================ + +impl Scrobbler for DiscordPlugin { + fn is_authorized(&self, req: IsAuthorizedRequest) -> Result { + let (_, users) = match get_config() { + Ok(config) => config, + Err(e) => { + error!("Failed to get config: {:?}", e); + return Ok(false); + } + }; + + let authorized = users.contains_key(&req.username); + info!("IsAuthorized for user {}: {}", req.username, authorized); + Ok(authorized) + } + + fn now_playing(&self, req: NowPlayingRequest) -> Result<(), ScrobblerError> { + info!( + "Setting presence for user {}, track: {}", + req.username, req.track.title + ); + + // Load configuration + let (client_id, users) = get_config() + .map_err(|e| ScrobblerError::new(format!("{}: failed to get config: {:?}", SCROBBLER_ERROR_RETRY_LATER, e)))?; + + // Check authorization + let user_token = users.get(&req.username).cloned().ok_or_else(|| { + ScrobblerError::new(format!( + "{}: user '{}' not authorized", + SCROBBLER_ERROR_NOT_AUTHORIZED, req.username + )) + })?; + + // Connect to Discord + rpc::connect(&req.username, &user_token) + .map_err(|e| ScrobblerError::new(format!( + "{}: failed to connect to Discord: {:?}", + SCROBBLER_ERROR_RETRY_LATER, e + )))?; + + // Cancel any existing completion schedule + let _ = scheduler::cancel_schedule(&format!("{}-clear", req.username)); + + // Calculate timestamps + let now = std::time::SystemTime::now() + .duration_since(std::time::UNIX_EPOCH) + .map(|d| d.as_secs() as i64) + .unwrap_or(0); + let start_time = (now - req.position as i64) * 1000; + let end_time = start_time + (req.track.duration as i64) * 1000; + + // Send activity update + rpc::send_activity( + &client_id, + &req.username, + &user_token, + rpc::Activity { + application: client_id.clone(), + name: "Navidrome".to_string(), + activity_type: 2, // Listening + details: req.track.title.clone(), + state: req.track.artist.clone(), + timestamps: rpc::ActivityTimestamps { + start: start_time, + end: end_time, + }, + assets: rpc::ActivityAssets { + large_image: get_image_url(&req.track.id), + large_text: req.track.album.clone(), + }, + }, + ) + .map_err(|e| ScrobblerError::new(format!( + "{}: failed to send activity: {:?}", + SCROBBLER_ERROR_RETRY_LATER, e + )))?; + + // Schedule a timer to clear the activity after the track completes + let remaining_seconds = (req.track.duration as i32) - req.position + 5; + if let Err(e) = scheduler::schedule_one_time( + remaining_seconds, + PAYLOAD_CLEAR_ACTIVITY, + &format!("{}-clear", req.username), + ) { + warn!("Failed to schedule completion timer: {:?}", e); + } + + Ok(()) + } + + fn scrobble(&self, _req: ScrobbleRequest) -> Result<(), ScrobblerError> { + // Discord Rich Presence doesn't need scrobble events - success + Ok(()) + } +} + +// ============================================================================ +// Scheduler Callback Implementation +// ============================================================================ + +impl CallbackProvider for DiscordPlugin { + fn on_callback(&self, req: SchedulerCallbackRequest) -> Result<(), SchedulerError> { + match req.payload.as_str() { + PAYLOAD_HEARTBEAT => { + // Heartbeat callback - schedule_id is the username + if let Err(e) = rpc::handle_heartbeat_callback(&req.schedule_id) { + // On heartbeat failure, clean up the connection (like the original Go plugin) + // The next NowPlaying call will reconnect if needed + warn!("Heartbeat failed for user {}, cleaning up connection: {:?}", req.schedule_id, e); + rpc::cleanup_connection(&req.schedule_id); + return Err(SchedulerError::new(format!("heartbeat failed, connection cleaned up: {}", e))); + } + } + PAYLOAD_CLEAR_ACTIVITY => { + // Clear activity callback - schedule_id is "username-clear" + let username = req.schedule_id.trim_end_matches("-clear"); + info!("Removing presence for user {}", username); + rpc::handle_clear_activity_callback(username) + .map_err(|e| SchedulerError::new(e.to_string()))?; + info!("Disconnecting user {}", username); + rpc::disconnect(username) + .map_err(|e| SchedulerError::new(e.to_string()))?; + } + _ => { + warn!("Unknown scheduler callback payload: {}", req.payload); + } + } + + Ok(()) + } +} + +// ============================================================================ +// WebSocket Callback Implementations +// ============================================================================ + +impl TextMessageProvider for DiscordPlugin { + fn on_text_message(&self, req: OnTextMessageRequest) -> Result<(), WebSocketError> { + rpc::handle_websocket_message(&req.connection_id, &req.message) + .map_err(|e| WebSocketError::new(e.to_string()))?; + Ok(()) + } +} + +impl BinaryMessageProvider for DiscordPlugin { + fn on_binary_message(&self, _req: OnBinaryMessageRequest) -> Result<(), WebSocketError> { + // Binary messages are not expected from Discord + Ok(()) + } +} + +impl ErrorProvider for DiscordPlugin { + fn on_error(&self, req: OnErrorRequest) -> Result<(), WebSocketError> { + warn!( + "WebSocket error for connection '{}': {}", + req.connection_id, req.error + ); + // Clean up all state associated with this connection since it's likely broken + rpc::handle_connection_close(&req.connection_id); + Ok(()) + } +} + +impl CloseProvider for DiscordPlugin { + fn on_close(&self, req: OnCloseRequest) -> Result<(), WebSocketError> { + info!( + "WebSocket connection '{}' closed with code {}: {}", + req.connection_id, req.code, req.reason + ); + // Clean up all state associated with this connection + rpc::handle_connection_close(&req.connection_id); + Ok(()) + } +} diff --git a/plugins/examples/discord-rich-presence-rs/src/rpc.rs b/plugins/examples/discord-rich-presence-rs/src/rpc.rs new file mode 100644 index 000000000..3de9eff63 --- /dev/null +++ b/plugins/examples/discord-rich-presence-rs/src/rpc.rs @@ -0,0 +1,547 @@ +//! Discord Rich Presence Plugin - RPC Communication +//! +//! This module handles all Discord gateway communication including WebSocket connections, +//! presence updates, and heartbeat management. + +use extism_pdk::*; +use nd_pdk::host::{cache, scheduler, websocket}; +use serde::{Deserialize, Serialize}; + +// ============================================================================ +// Constants +// ============================================================================ + +const HEARTBEAT_OP_CODE: i32 = 1; +const GATE_OP_CODE: i32 = 2; +const PRESENCE_OP_CODE: i32 = 3; +const HEARTBEAT_INTERVAL: i32 = 41; +const DEFAULT_IMAGE: &str = "https://i.imgur.com/hb3XPzA.png"; + +const PAYLOAD_HEARTBEAT: &str = "heartbeat"; + +// ============================================================================ +// Discord Types +// ============================================================================ + +#[derive(Serialize)] +pub struct Activity { + pub name: String, + #[serde(rename = "type")] + pub activity_type: i32, + pub details: String, + pub state: String, + #[serde(rename = "application_id")] + pub application: String, + pub timestamps: ActivityTimestamps, + pub assets: ActivityAssets, +} + +#[derive(Serialize)] +pub struct ActivityTimestamps { + pub start: i64, + pub end: i64, +} + +#[derive(Serialize)] +pub struct ActivityAssets { + pub large_image: String, + pub large_text: String, +} + +#[derive(Serialize)] +struct PresencePayload { + activities: Vec, + since: i64, + status: String, + afk: bool, +} + +#[derive(Serialize)] +struct IdentifyPayload { + token: String, + intents: i32, + properties: IdentifyProperties, +} + +#[derive(Serialize)] +struct IdentifyProperties { + os: String, + browser: String, + device: String, +} + +#[derive(Serialize)] +struct GatewayMessage { + op: i32, + d: T, +} + +#[derive(Deserialize)] +struct GatewayResponse { + op: i32, + #[serde(default)] + #[allow(dead_code)] + d: Option, + #[serde(default)] + s: Option, +} + +// ============================================================================ +// Cache Keys +// ============================================================================ + +fn connection_key(username: &str) -> String { + format!("discord.connection.{}", username) +} + +fn token_key(username: &str) -> String { + format!("discord.token.{}", username) +} + +fn sequence_key(username: &str) -> String { + format!("discord.sequence.{}", username) +} + +// ============================================================================ +// Connection Management +// ============================================================================ + +/// Tests if the connection is still valid by trying to send a heartbeat. +fn is_connected(username: &str) -> bool { + match send_heartbeat(username) { + Ok(_) => true, + Err(e) => { + trace!("Connection test failed for user {}: {:?}", username, e); + false + } + } +} + +/// Cleans up a connection for a user. +/// Called when heartbeat fails or connection is lost. +pub fn cleanup_connection(username: &str) { + info!("Cleaning up failed connection for user {}", username); + + // Cancel the heartbeat schedule + if let Err(e) = scheduler::cancel_schedule(username) { + warn!("Failed to cancel heartbeat schedule for user {}: {:?}", username, e); + } + + // Try to close the WebSocket connection + let conn_key = connection_key(username); + if let Ok(Some(conn_id)) = cache::get_string(&conn_key) { + if !conn_id.is_empty() { + if let Err(e) = websocket::close_connection(&conn_id, 1000, "Reconnecting") { + trace!("Failed to close WebSocket for user {}: {:?}", username, e); + } + // Clean up reverse mapping + let reverse_key = format!("discord.reverse.{}", conn_id); + let _ = cache::remove(&reverse_key); + } + } + + // Clean up cache entries + let _ = cache::remove(&conn_key); + let _ = cache::remove(&sequence_key(username)); + + info!("Cleaned up connection for user {}", username); +} + +/// Handles connection close by connection ID (called from WebSocket close callback). +/// This cleans up all state associated with the connection. +pub fn handle_connection_close(connection_id: &str) { + // Find the username for this connection using the reverse mapping + if let Ok(Some(username)) = find_username_for_connection(connection_id) { + info!("Connection closed for user {}, cleaning up", username); + + // Cancel the heartbeat schedule + if let Err(e) = scheduler::cancel_schedule(&username) { + // Not an error if schedule doesn't exist + trace!("Failed to cancel heartbeat schedule for user {}: {:?}", username, e); + } + + // Cancel any pending clear-activity schedule + let _ = scheduler::cancel_schedule(&format!("{}-clear", username)); + + // Clean up cache entries + let conn_key = connection_key(&username); + let _ = cache::remove(&conn_key); + let _ = cache::remove(&sequence_key(&username)); + + // Clean up reverse mapping + let reverse_key = format!("discord.reverse.{}", connection_id); + let _ = cache::remove(&reverse_key); + + info!("Cleaned up connection state for user {}", username); + } else { + // Just clean up the reverse mapping if we can't find the username + let reverse_key = format!("discord.reverse.{}", connection_id); + let _ = cache::remove(&reverse_key); + } +} + +/// Connects to the Discord gateway for a user. +pub fn connect(username: &str, token: &str) -> Result<(), Error> { + // Check if already connected and connection is valid + if is_connected(username) { + info!("Reusing existing connection for user {}", username); + return Ok(()); + } + + // Clean up any stale connection state + cleanup_connection(username); + + info!("Connecting to Discord gateway for user {}", username); + + // Store token for later use + cache::set_string(&token_key(username), token, 86400)?; + + // Get Discord Gateway URL + let gateway = get_discord_gateway()?; + info!("Using gateway: {}", gateway); + + // Connect to Discord gateway + let headers = std::collections::HashMap::new(); + let conn_id = websocket::connect( + &gateway, + headers, + username, // Use username as connection ID for easy lookup + )?; + info!("WebSocket connection established: {}", conn_id); + + // Store connection ID + let conn_key = connection_key(username); + cache::set_string(&conn_key, &conn_id, 86400)?; + + // Send identify immediately (don't wait for Hello) + identify(username)?; + + info!("Successfully connected and identified user {}", username); + Ok(()) +} + +/// Handles a WebSocket message from Discord. +pub fn handle_websocket_message(connection_id: &str, message: &str) -> Result<(), Error> { + let response: GatewayResponse = serde_json::from_str(message) + .map_err(|e| Error::msg(format!("Failed to parse gateway message: {}", e)))?; + + // Update sequence number if present + if let Some(seq) = response.s { + // Find username for this connection + if let Some(username) = find_username_for_connection(connection_id)? { + cache::set_string(&sequence_key(&username), &seq.to_string(), 86400)?; + } + } + + match response.op { + 10 => { + // Hello - we already identified in connect(), nothing to do + } + 11 => { + // Heartbeat ACK - no action needed + } + 1 => { + // Heartbeat request - send heartbeat + if let Some(username) = find_username_for_connection(connection_id)? { + send_heartbeat(&username)?; + } + } + _ => { + trace!("Received Discord gateway op: {}", response.op); + } + } + + Ok(()) +} + +/// Handles heartbeat callback from scheduler. +pub fn handle_heartbeat_callback(username: &str) -> Result<(), Error> { + send_heartbeat(username) +} + +/// Handles clear activity callback from scheduler. +pub fn handle_clear_activity_callback(username: &str) -> Result<(), Error> { + info!("Clearing activity for user {}", username); + + let conn_key = connection_key(username); + if let Some(conn_id) = cache::get_string(&conn_key)?.filter(|s| !s.is_empty()) { + // Send empty presence to clear activity + let msg = GatewayMessage { + op: PRESENCE_OP_CODE, + d: PresencePayload { + activities: vec![], + since: 0, + status: "dnd".to_string(), + afk: false, + }, + }; + + let json = serde_json::to_string(&msg) + .map_err(|e| Error::msg(format!("Failed to serialize message: {}", e)))?; + + websocket::send_text(&conn_id, &json)?; + } + + Ok(()) +} + +/// Disconnects from Discord for a user. +pub fn disconnect(username: &str) -> Result<(), Error> { + info!("Disconnecting from Discord for user {}", username); + + // Cancel the heartbeat schedule + if let Err(e) = scheduler::cancel_schedule(username) { + warn!("Failed to cancel heartbeat schedule: {:?}", e); + } + + // Close the WebSocket connection + let conn_key = connection_key(username); + if let Some(conn_id) = cache::get_string(&conn_key)?.filter(|s| !s.is_empty()) { + if let Err(e) = websocket::close_connection(&conn_id, 1000, "Navidrome disconnect") { + warn!("Failed to close WebSocket connection: {:?}", e); + } + // Clean up reverse mapping + let reverse_key = format!("discord.reverse.{}", conn_id); + let _ = cache::remove(&reverse_key); + } + + // Clean up cache entries + let _ = cache::remove(&conn_key); + let _ = cache::remove(&sequence_key(username)); + + Ok(()) +} + +/// Sends an activity update to Discord. +pub fn send_activity( + client_id: &str, + username: &str, + token: &str, + mut activity: Activity, +) -> Result<(), Error> { + let conn_key = connection_key(username); + let conn_id = cache::get_string(&conn_key)? + .filter(|s| !s.is_empty()) + .ok_or_else(|| Error::msg("Not connected to Discord"))?; + + // Process image URL + activity.assets.large_image = process_image(&activity.assets.large_image, client_id, token)?; + + // Send presence update + let msg = GatewayMessage { + op: PRESENCE_OP_CODE, + d: PresencePayload { + activities: vec![activity], + since: 0, + status: "dnd".to_string(), + afk: false, + }, + }; + + let json = serde_json::to_string(&msg) + .map_err(|e| Error::msg(format!("Failed to serialize message: {}", e)))?; + + websocket::send_text(&conn_id, &json)?; + + Ok(()) +} + +// ============================================================================ +// Internal Functions +// ============================================================================ + +fn find_username_for_connection(connection_id: &str) -> Result, Error> { + // This is a simple approach - in production you might want to maintain a proper mapping + // For now, we'll use a known pattern to find the username + // The connection ID is stored as cache value, so we need to scan for it + // Since we can't iterate cache, we'll use a workaround with a reverse mapping + let reverse_key = format!("discord.reverse.{}", connection_id); + Ok(cache::get_string(&reverse_key)?.filter(|s| !s.is_empty())) +} + +fn get_discord_gateway() -> Result { + let req = HttpRequest::new("https://discord.com/api/gateway") + .with_method("GET"); + + let resp = http::request::(&req, None::)?; + if resp.status_code() >= 400 { + return Err(Error::msg(format!( + "Failed to get Discord gateway: HTTP {}", + resp.status_code() + ))); + } + + let body = resp.body(); + let data: std::collections::HashMap = serde_json::from_slice(&body) + .map_err(|e| Error::msg(format!("Failed to parse gateway response: {}", e)))?; + + data.get("url") + .map(|url| url.to_string()) + .ok_or_else(|| Error::msg("No URL in gateway response")) +} + +fn identify(username: &str) -> Result<(), Error> { + info!("Identifying with Discord for user {}", username); + + let conn_key = connection_key(username); + let conn_id = cache::get_string(&conn_key)? + .filter(|s| !s.is_empty()) + .ok_or_else(|| Error::msg("No connection found"))?; + + let token_k = token_key(username); + let token = cache::get_string(&token_k)? + .filter(|s| !s.is_empty()) + .ok_or_else(|| Error::msg("No token found"))?; + + // Store reverse mapping for connection -> username + let reverse_key = format!("discord.reverse.{}", conn_id); + cache::set_string(&reverse_key, username, 86400)?; + + // Send identify + let msg = GatewayMessage { + op: GATE_OP_CODE, + d: IdentifyPayload { + token, + intents: 0, + properties: IdentifyProperties { + os: "Windows 10".to_string(), + browser: "Discord Client".to_string(), + device: "Discord Client".to_string(), + }, + }, + }; + + let json = serde_json::to_string(&msg) + .map_err(|e| Error::msg(format!("Failed to serialize message: {}", e)))?; + + websocket::send_text(&conn_id, &json)?; + + // Schedule heartbeat + scheduler::schedule_recurring( + &format!("@every {}s", HEARTBEAT_INTERVAL), + PAYLOAD_HEARTBEAT, + username, + )?; + + Ok(()) +} + +fn send_heartbeat(username: &str) -> Result<(), Error> { + let conn_key = connection_key(username); + let conn_id = cache::get_string(&conn_key)? + .filter(|s| !s.is_empty()) + .ok_or_else(|| Error::msg("No connection found"))?; + + // Get sequence number + let seq_key = sequence_key(username); + let seq: Option = cache::get_string(&seq_key)? + .and_then(|s| s.parse().ok()); + + // Send heartbeat + let msg = GatewayMessage { + op: HEARTBEAT_OP_CODE, + d: seq, + }; + + let json = serde_json::to_string(&msg) + .map_err(|e| Error::msg(format!("Failed to serialize message: {}", e)))?; + + websocket::send_text(&conn_id, &json)?; + Ok(()) +} + +fn process_image(image_url: &str, client_id: &str, token: &str) -> Result { + process_image_inner(image_url, client_id, token, false) +} + +fn process_image_inner( + image_url: &str, + client_id: &str, + token: &str, + is_default: bool, +) -> Result { + let url = if image_url.is_empty() { + if is_default { + return Err(Error::msg("default image URL is empty")); + } + return process_image_inner(DEFAULT_IMAGE, client_id, token, true); + } else { + image_url + }; + + // Already processed + if url.starts_with("mp:") { + return Ok(url.to_string()); + } + + // Check cache + let cache_key = format!("discord.image.{:x}", md5_hash(url)); + if let Some(cached) = cache::get_string(&cache_key)?.filter(|s| !s.is_empty()) { + return Ok(cached); + } + + // Process via Discord API + let body = format!(r#"{{"urls":["{}"]}}"#, url); + let api_url = format!( + "https://discord.com/api/v9/applications/{}/external-assets", + client_id + ); + + let req = HttpRequest::new(&api_url) + .with_method("POST") + .with_header("Authorization", token) + .with_header("Content-Type", "application/json"); + + let resp = http::request::(&req, Some(body))?; + if resp.status_code() >= 400 { + if is_default { + return Err(Error::msg(format!( + "failed to process default image: HTTP {}", + resp.status_code() + ))); + } + return process_image_inner(DEFAULT_IMAGE, client_id, token, true); + } + + let body = resp.body(); + let data: Vec> = serde_json::from_slice(&body) + .map_err(|e| Error::msg(format!("Failed to parse image response: {}", e)))?; + + if data.is_empty() { + if is_default { + return Err(Error::msg("no data returned for default image")); + } + return process_image_inner(DEFAULT_IMAGE, client_id, token, true); + } + + let asset_path = data[0] + .get("external_asset_path") + .map(|s| s.as_str()) + .unwrap_or(""); + + if asset_path.is_empty() { + if is_default { + return Err(Error::msg("empty external_asset_path for default image")); + } + return process_image_inner(DEFAULT_IMAGE, client_id, token, true); + } + + let processed = format!("mp:{}", asset_path); + + // Cache the result + let ttl = if is_default { 48 * 60 * 60 } else { 4 * 60 * 60 }; + let _ = cache::set_string(&cache_key, &processed, ttl); + + Ok(processed) +} + +/// Simple hash function for cache keys. +fn md5_hash(input: &str) -> u64 { + // A simple hash - not actual MD5, but sufficient for cache keys + let mut hash: u64 = 0; + for (i, byte) in input.bytes().enumerate() { + hash = hash.wrapping_add((byte as u64).wrapping_mul((i as u64).wrapping_add(1))); + hash = hash.wrapping_mul(31); + } + hash +} diff --git a/plugins/examples/discord-rich-presence/README.md b/plugins/examples/discord-rich-presence/README.md deleted file mode 100644 index 80b12166f..000000000 --- a/plugins/examples/discord-rich-presence/README.md +++ /dev/null @@ -1,88 +0,0 @@ -# Discord Rich Presence Plugin - -This example plugin integrates Navidrome with Discord Rich Presence. It shows how a plugin can keep a real-time -connection to an external service while remaining completely stateless. This plugin is based on the -[Navicord](https://github.com/logixism/navicord) project, which provides a similar functionality. - -**NOTE: This plugin is for demonstration purposes only. It relies on the user's Discord token being stored in the -Navidrome configuration file, which is not secure, and may be against Discord's terms of service. -Use it at your own risk.** - -## Overview - -The plugin exposes three capabilities: - -- **Scrobbler** – receives `NowPlaying` notifications from Navidrome -- **WebSocketCallback** – handles Discord gateway messages -- **SchedulerCallback** – used to clear presence and send periodic heartbeats - -It relies on several host services declared in `manifest.json`: - -- `http` – queries Discord API endpoints -- `websocket` – maintains gateway connections -- `scheduler` – schedules heartbeats and presence cleanup -- `cache` – stores sequence numbers for heartbeats -- `config` – retrieves the plugin configuration on each call -- `artwork` – resolves track artwork URLs - -## Architecture - -Each call from Navidrome creates a new plugin instance. The `init` function registers the capabilities and obtains the -scheduler service: - -```go -api.RegisterScrobbler(plugin) -api.RegisterWebSocketCallback(plugin.rpc) -plugin.sched = api.RegisterNamedSchedulerCallback("close-activity", plugin) -plugin.rpc.sched = api.RegisterNamedSchedulerCallback("heartbeat", plugin.rpc) -``` - -When `NowPlaying` is invoked the plugin: - -1. Loads `clientid` and user tokens from the configuration (because plugins are stateless). -2. Connects to Discord using `WebSocketService` if no connection exists. -3. Sends the activity payload with track details and artwork. -4. Schedules a one‑time callback to clear the presence after the track finishes. - -Heartbeat messages are sent by a recurring scheduler job. Sequence numbers received from Discord are stored in -`CacheService` to remain available across plugin instances. - -The `OnSchedulerCallback` method clears the presence and closes the connection when the scheduled time is reached. - -```go -// The plugin is stateless, we need to load the configuration every time -clientID, users, err := d.getConfig(ctx) -``` - -## Configuration - -Add the following to `navidrome.toml` and adjust for your tokens: - -```toml -[PluginConfig.discord-rich-presence] -ClientID = "123456789012345678" -Users = "alice:token123,bob:token456" -``` - -- `clientid` is your Discord application ID -- `users` is a comma‑separated list of `username:token` pairs used for authorization - -## Building - -```sh -GOOS=wasip1 GOARCH=wasm go build -buildmode=c-shared -o plugin.wasm ./discord-rich-presence/... -``` - -Place the resulting `plugin.wasm` and `manifest.json` in a `discord-rich-presence` folder under your Navidrome plugins -directory. - -## Stateless Operation - -Navidrome plugins are completely stateless – each method call instantiates a new plugin instance and discards it -afterwards. - -To work within this model the plugin stores no in-memory state. Connections are keyed by user name inside the host -services and any transient data (like Discord sequence numbers) is kept in the cache. Configuration is reloaded on every -method call. - -For more implementation details see `plugin.go` and `rpc.go`. diff --git a/plugins/examples/discord-rich-presence/manifest.json b/plugins/examples/discord-rich-presence/manifest.json deleted file mode 100644 index c6fa9c283..000000000 --- a/plugins/examples/discord-rich-presence/manifest.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "$schema": "https://raw.githubusercontent.com/navidrome/navidrome/refs/heads/master/plugins/schema/manifest.schema.json", - "name": "discord-rich-presence", - "author": "Navidrome Team", - "version": "1.0.0", - "description": "Discord Rich Presence integration for Navidrome", - "website": "https://github.com/navidrome/navidrome/tree/master/plugins/examples/discord-rich-presence", - "capabilities": ["Scrobbler", "SchedulerCallback", "WebSocketCallback"], - "permissions": { - "http": { - "reason": "To communicate with Discord API for gateway discovery and image uploads", - "allowedUrls": { - "https://discord.com/api/*": ["GET", "POST"] - }, - "allowLocalNetwork": false - }, - "websocket": { - "reason": "To maintain real-time connection with Discord gateway", - "allowedUrls": ["wss://gateway.discord.gg"], - "allowLocalNetwork": false - }, - "config": { - "reason": "To access plugin configuration (client ID and user tokens)" - }, - "cache": { - "reason": "To store connection state and sequence numbers" - }, - "scheduler": { - "reason": "To schedule heartbeat messages and activity clearing" - }, - "artwork": { - "reason": "To get track artwork URLs for rich presence display" - } - } -} diff --git a/plugins/examples/discord-rich-presence/plugin.go b/plugins/examples/discord-rich-presence/plugin.go deleted file mode 100644 index c93ccf35d..000000000 --- a/plugins/examples/discord-rich-presence/plugin.go +++ /dev/null @@ -1,186 +0,0 @@ -package main - -import ( - "context" - "fmt" - "log" - "strings" - - "github.com/navidrome/navidrome/plugins/api" - "github.com/navidrome/navidrome/plugins/host/artwork" - "github.com/navidrome/navidrome/plugins/host/cache" - "github.com/navidrome/navidrome/plugins/host/config" - "github.com/navidrome/navidrome/plugins/host/http" - "github.com/navidrome/navidrome/plugins/host/scheduler" - "github.com/navidrome/navidrome/plugins/host/websocket" - "github.com/navidrome/navidrome/utils/slice" -) - -type DiscordRPPlugin struct { - rpc *discordRPC - cfg config.ConfigService - artwork artwork.ArtworkService - sched scheduler.SchedulerService -} - -func (d *DiscordRPPlugin) IsAuthorized(ctx context.Context, req *api.ScrobblerIsAuthorizedRequest) (*api.ScrobblerIsAuthorizedResponse, error) { - // Get plugin configuration - _, users, err := d.getConfig(ctx) - if err != nil { - return nil, fmt.Errorf("failed to check user authorization: %w", err) - } - - // Check if the user has a Discord token configured - _, authorized := users[req.Username] - log.Printf("IsAuthorized for user %s: %v", req.Username, authorized) - return &api.ScrobblerIsAuthorizedResponse{ - Authorized: authorized, - }, nil -} - -func (d *DiscordRPPlugin) NowPlaying(ctx context.Context, request *api.ScrobblerNowPlayingRequest) (*api.ScrobblerNowPlayingResponse, error) { - log.Printf("Setting presence for user %s, track: %s", request.Username, request.Track.Name) - - // The plugin is stateless, we need to load the configuration every time - clientID, users, err := d.getConfig(ctx) - if err != nil { - return nil, fmt.Errorf("failed to get config: %w", err) - } - - // Check if the user has a Discord token configured - userToken, authorized := users[request.Username] - if !authorized { - return nil, fmt.Errorf("user '%s' not authorized", request.Username) - } - - // Make sure we have a connection - if err := d.rpc.connect(ctx, request.Username, userToken); err != nil { - return nil, fmt.Errorf("failed to connect to Discord: %w", err) - } - - // Cancel any existing completion schedule - if resp, _ := d.sched.CancelSchedule(ctx, &scheduler.CancelRequest{ScheduleId: request.Username}); resp.Error != "" { - log.Printf("Ignoring failure to cancel schedule: %s", resp.Error) - } - - // Send activity update - if err := d.rpc.sendActivity(ctx, clientID, request.Username, userToken, activity{ - Application: clientID, - Name: "Navidrome", - Type: 2, - Details: request.Track.Name, - State: d.getArtistList(request.Track), - Timestamps: activityTimestamps{ - Start: (request.Timestamp - int64(request.Track.Position)) * 1000, - End: (request.Timestamp - int64(request.Track.Position) + int64(request.Track.Length)) * 1000, - }, - Assets: activityAssets{ - LargeImage: d.imageURL(ctx, request), - LargeText: request.Track.Album, - }, - }); err != nil { - return nil, fmt.Errorf("failed to send activity: %w", err) - } - - // Schedule a timer to clear the activity after the track completes - _, err = d.sched.ScheduleOneTime(ctx, &scheduler.ScheduleOneTimeRequest{ - ScheduleId: request.Username, - DelaySeconds: request.Track.Length - request.Track.Position + 5, - }) - if err != nil { - return nil, fmt.Errorf("failed to schedule completion timer: %w", err) - } - - return nil, nil -} - -func (d *DiscordRPPlugin) imageURL(ctx context.Context, request *api.ScrobblerNowPlayingRequest) string { - imageResp, _ := d.artwork.GetTrackUrl(ctx, &artwork.GetArtworkUrlRequest{Id: request.Track.Id, Size: 300}) - imageURL := imageResp.Url - if strings.HasPrefix(imageURL, "http://localhost") { - return "" - } - return imageURL -} - -func (d *DiscordRPPlugin) getArtistList(track *api.TrackInfo) string { - return strings.Join(slice.Map(track.Artists, func(a *api.Artist) string { return a.Name }), " • ") -} - -func (d *DiscordRPPlugin) Scrobble(context.Context, *api.ScrobblerScrobbleRequest) (*api.ScrobblerScrobbleResponse, error) { - return nil, nil -} - -func (d *DiscordRPPlugin) getConfig(ctx context.Context) (string, map[string]string, error) { - const ( - clientIDKey = "clientid" - usersKey = "users" - ) - confResp, err := d.cfg.GetPluginConfig(ctx, &config.GetPluginConfigRequest{}) - if err != nil { - return "", nil, fmt.Errorf("unable to load config: %w", err) - } - conf := confResp.GetConfig() - if len(conf) < 1 { - log.Print("missing configuration") - return "", nil, nil - } - clientID := conf[clientIDKey] - if clientID == "" { - log.Printf("missing ClientID: %v", conf) - return "", nil, nil - } - cfgUsers := conf[usersKey] - if len(cfgUsers) == 0 { - log.Print("no users configured") - return "", nil, nil - } - users := map[string]string{} - for _, user := range strings.Split(cfgUsers, ",") { - tuple := strings.Split(user, ":") - if len(tuple) != 2 { - return clientID, nil, fmt.Errorf("invalid user config: %s", user) - } - users[tuple[0]] = tuple[1] - } - return clientID, users, nil -} - -func (d *DiscordRPPlugin) OnSchedulerCallback(ctx context.Context, req *api.SchedulerCallbackRequest) (*api.SchedulerCallbackResponse, error) { - log.Printf("Removing presence for user %s", req.ScheduleId) - if err := d.rpc.clearActivity(ctx, req.ScheduleId); err != nil { - return nil, fmt.Errorf("failed to clear activity: %w", err) - } - log.Printf("Disconnecting user %s", req.ScheduleId) - if err := d.rpc.disconnect(ctx, req.ScheduleId); err != nil { - return nil, fmt.Errorf("failed to disconnect from Discord: %w", err) - } - return nil, nil -} - -// Creates a new instance of the DiscordRPPlugin, with all host services as dependencies -var plugin = &DiscordRPPlugin{ - cfg: config.NewConfigService(), - artwork: artwork.NewArtworkService(), - rpc: &discordRPC{ - ws: websocket.NewWebSocketService(), - web: http.NewHttpService(), - mem: cache.NewCacheService(), - }, -} - -func init() { - // Configure logging: No timestamps, no source file/line, prepend [Discord] - log.SetFlags(0) - log.SetPrefix("[Discord] ") - - // Register plugin capabilities - api.RegisterScrobbler(plugin) - api.RegisterWebSocketCallback(plugin.rpc) - - // Register named scheduler callbacks, and get the scheduler service for each - plugin.sched = api.RegisterNamedSchedulerCallback("close-activity", plugin) - plugin.rpc.sched = api.RegisterNamedSchedulerCallback("heartbeat", plugin.rpc) -} - -func main() {} diff --git a/plugins/examples/discord-rich-presence/rpc.go b/plugins/examples/discord-rich-presence/rpc.go deleted file mode 100644 index 4fab42f41..000000000 --- a/plugins/examples/discord-rich-presence/rpc.go +++ /dev/null @@ -1,402 +0,0 @@ -package main - -import ( - "context" - "encoding/json" - "fmt" - "log" - "strings" - "time" - - "github.com/navidrome/navidrome/plugins/api" - "github.com/navidrome/navidrome/plugins/host/cache" - "github.com/navidrome/navidrome/plugins/host/http" - "github.com/navidrome/navidrome/plugins/host/scheduler" - "github.com/navidrome/navidrome/plugins/host/websocket" -) - -type discordRPC struct { - ws websocket.WebSocketService - web http.HttpService - mem cache.CacheService - sched scheduler.SchedulerService -} - -// Discord WebSocket Gateway constants -const ( - heartbeatOpCode = 1 // Heartbeat operation code - gateOpCode = 2 // Identify operation code - presenceOpCode = 3 // Presence update operation code -) - -const ( - heartbeatInterval = 41 // Heartbeat interval in seconds - defaultImage = "https://i.imgur.com/hb3XPzA.png" -) - -// Activity is a struct that represents an activity in Discord. -type activity struct { - Name string `json:"name"` - Type int `json:"type"` - Details string `json:"details"` - State string `json:"state"` - Application string `json:"application_id"` - Timestamps activityTimestamps `json:"timestamps"` - Assets activityAssets `json:"assets"` -} - -type activityTimestamps struct { - Start int64 `json:"start"` - End int64 `json:"end"` -} - -type activityAssets struct { - LargeImage string `json:"large_image"` - LargeText string `json:"large_text"` -} - -// PresencePayload is a struct that represents a presence update in Discord. -type presencePayload struct { - Activities []activity `json:"activities"` - Since int64 `json:"since"` - Status string `json:"status"` - Afk bool `json:"afk"` -} - -// IdentifyPayload is a struct that represents an identify payload in Discord. -type identifyPayload struct { - Token string `json:"token"` - Intents int `json:"intents"` - Properties identifyProperties `json:"properties"` -} - -type identifyProperties struct { - OS string `json:"os"` - Browser string `json:"browser"` - Device string `json:"device"` -} - -func (r *discordRPC) processImage(ctx context.Context, imageURL string, clientID string, token string) (string, error) { - return r.processImageWithFallback(ctx, imageURL, clientID, token, false) -} - -func (r *discordRPC) processImageWithFallback(ctx context.Context, imageURL string, clientID string, token string, isDefaultImage bool) (string, error) { - // Check if context is canceled - if err := ctx.Err(); err != nil { - return "", fmt.Errorf("context canceled: %w", err) - } - - if imageURL == "" { - if isDefaultImage { - // We're already processing the default image and it's empty, return error - return "", fmt.Errorf("default image URL is empty") - } - return r.processImageWithFallback(ctx, defaultImage, clientID, token, true) - } - - if strings.HasPrefix(imageURL, "mp:") { - return imageURL, nil - } - - // Check cache first - cacheKey := fmt.Sprintf("discord.image.%x", imageURL) - cacheResp, _ := r.mem.GetString(ctx, &cache.GetRequest{Key: cacheKey}) - if cacheResp.Exists { - log.Printf("Cache hit for image URL: %s", imageURL) - return cacheResp.Value, nil - } - - resp, _ := r.web.Post(ctx, &http.HttpRequest{ - Url: fmt.Sprintf("https://discord.com/api/v9/applications/%s/external-assets", clientID), - Headers: map[string]string{ - "Authorization": token, - "Content-Type": "application/json", - }, - Body: fmt.Appendf(nil, `{"urls":[%q]}`, imageURL), - }) - - // Handle HTTP error responses - if resp.Status >= 400 { - if isDefaultImage { - return "", fmt.Errorf("failed to process default image: HTTP %d %s", resp.Status, resp.Error) - } - return r.processImageWithFallback(ctx, defaultImage, clientID, token, true) - } - if resp.Error != "" { - if isDefaultImage { - // If we're already processing the default image and it fails, return error - return "", fmt.Errorf("failed to process default image: %s", resp.Error) - } - // Try with default image - return r.processImageWithFallback(ctx, defaultImage, clientID, token, true) - } - - var data []map[string]string - if err := json.Unmarshal(resp.Body, &data); err != nil { - if isDefaultImage { - // If we're already processing the default image and it fails, return error - return "", fmt.Errorf("failed to unmarshal default image response: %w", err) - } - // Try with default image - return r.processImageWithFallback(ctx, defaultImage, clientID, token, true) - } - - if len(data) == 0 { - if isDefaultImage { - // If we're already processing the default image and it fails, return error - return "", fmt.Errorf("no data returned for default image") - } - // Try with default image - return r.processImageWithFallback(ctx, defaultImage, clientID, token, true) - } - - image := data[0]["external_asset_path"] - if image == "" { - if isDefaultImage { - // If we're already processing the default image and it fails, return error - return "", fmt.Errorf("empty external_asset_path for default image") - } - // Try with default image - return r.processImageWithFallback(ctx, defaultImage, clientID, token, true) - } - - processedImage := fmt.Sprintf("mp:%s", image) - - // Cache the processed image URL - var ttl = 4 * time.Hour // 4 hours for regular images - if isDefaultImage { - ttl = 48 * time.Hour // 48 hours for default image - } - - _, _ = r.mem.SetString(ctx, &cache.SetStringRequest{ - Key: cacheKey, - Value: processedImage, - TtlSeconds: int64(ttl.Seconds()), - }) - - log.Printf("Cached processed image URL for %s (TTL: %s seconds)", imageURL, ttl) - - return processedImage, nil -} - -func (r *discordRPC) sendActivity(ctx context.Context, clientID, username, token string, data activity) error { - log.Printf("Sending activity to for user %s: %#v", username, data) - - processedImage, err := r.processImage(ctx, data.Assets.LargeImage, clientID, token) - if err != nil { - log.Printf("Failed to process image for user %s, continuing without image: %v", username, err) - // Clear the image and continue without it - data.Assets.LargeImage = "" - } else { - log.Printf("Processed image for URL %s: %s", data.Assets.LargeImage, processedImage) - data.Assets.LargeImage = processedImage - } - - presence := presencePayload{ - Activities: []activity{data}, - Status: "dnd", - Afk: false, - } - return r.sendMessage(ctx, username, presenceOpCode, presence) -} - -func (r *discordRPC) clearActivity(ctx context.Context, username string) error { - log.Printf("Clearing activity for user %s", username) - return r.sendMessage(ctx, username, presenceOpCode, presencePayload{}) -} - -func (r *discordRPC) sendMessage(ctx context.Context, username string, opCode int, payload any) error { - message := map[string]any{ - "op": opCode, - "d": payload, - } - b, err := json.Marshal(message) - if err != nil { - return fmt.Errorf("failed to marshal presence update: %w", err) - } - - resp, _ := r.ws.SendText(ctx, &websocket.SendTextRequest{ - ConnectionId: username, - Message: string(b), - }) - if resp.Error != "" { - return fmt.Errorf("failed to send presence update: %s", resp.Error) - } - return nil -} - -func (r *discordRPC) getDiscordGateway(ctx context.Context) (string, error) { - resp, _ := r.web.Get(ctx, &http.HttpRequest{ - Url: "https://discord.com/api/gateway", - }) - if resp.Error != "" { - return "", fmt.Errorf("failed to get Discord gateway: %s", resp.Error) - } - var result map[string]string - err := json.Unmarshal(resp.Body, &result) - if err != nil { - return "", fmt.Errorf("failed to parse Discord gateway response: %w", err) - } - return result["url"], nil -} - -func (r *discordRPC) sendHeartbeat(ctx context.Context, username string) error { - resp, _ := r.mem.GetInt(ctx, &cache.GetRequest{ - Key: fmt.Sprintf("discord.seq.%s", username), - }) - log.Printf("Sending heartbeat for user %s: %d", username, resp.Value) - return r.sendMessage(ctx, username, heartbeatOpCode, resp.Value) -} - -func (r *discordRPC) cleanupFailedConnection(ctx context.Context, username string) { - log.Printf("Cleaning up failed connection for user %s", username) - - // Cancel the heartbeat schedule - if resp, _ := r.sched.CancelSchedule(ctx, &scheduler.CancelRequest{ScheduleId: username}); resp.Error != "" { - log.Printf("Failed to cancel heartbeat schedule for user %s: %s", username, resp.Error) - } - - // Close the WebSocket connection - if resp, _ := r.ws.Close(ctx, &websocket.CloseRequest{ - ConnectionId: username, - Code: 1000, - Reason: "Connection lost", - }); resp.Error != "" { - log.Printf("Failed to close WebSocket connection for user %s: %s", username, resp.Error) - } - - // Clean up cache entries (just the sequence number, no failure tracking needed) - _, _ = r.mem.Remove(ctx, &cache.RemoveRequest{Key: fmt.Sprintf("discord.seq.%s", username)}) - - log.Printf("Cleaned up connection for user %s", username) -} - -func (r *discordRPC) isConnected(ctx context.Context, username string) bool { - // Try to send a heartbeat to test the connection - err := r.sendHeartbeat(ctx, username) - if err != nil { - log.Printf("Heartbeat test failed for user %s: %v", username, err) - return false - } - return true -} - -func (r *discordRPC) connect(ctx context.Context, username string, token string) error { - if r.isConnected(ctx, username) { - log.Printf("Reusing existing connection for user %s", username) - return nil - } - log.Printf("Creating new connection for user %s", username) - - // Get Discord Gateway URL - gateway, err := r.getDiscordGateway(ctx) - if err != nil { - return fmt.Errorf("failed to get Discord gateway: %w", err) - } - log.Printf("Using gateway: %s", gateway) - - // Connect to Discord Gateway - resp, _ := r.ws.Connect(ctx, &websocket.ConnectRequest{ - ConnectionId: username, - Url: gateway, - }) - if resp.Error != "" { - return fmt.Errorf("failed to connect to WebSocket: %s", resp.Error) - } - - // Send identify payload - payload := identifyPayload{ - Token: token, - Intents: 0, - Properties: identifyProperties{ - OS: "Windows 10", - Browser: "Discord Client", - Device: "Discord Client", - }, - } - err = r.sendMessage(ctx, username, gateOpCode, payload) - if err != nil { - return fmt.Errorf("failed to send identify payload: %w", err) - } - - // Schedule heartbeats for this user/connection - cronResp, _ := r.sched.ScheduleRecurring(ctx, &scheduler.ScheduleRecurringRequest{ - CronExpression: fmt.Sprintf("@every %ds", heartbeatInterval), - ScheduleId: username, - }) - log.Printf("Scheduled heartbeat for user %s with ID %s", username, cronResp.ScheduleId) - - log.Printf("Successfully authenticated user %s", username) - return nil -} - -func (r *discordRPC) disconnect(ctx context.Context, username string) error { - if resp, _ := r.sched.CancelSchedule(ctx, &scheduler.CancelRequest{ScheduleId: username}); resp.Error != "" { - return fmt.Errorf("failed to cancel schedule: %s", resp.Error) - } - resp, _ := r.ws.Close(ctx, &websocket.CloseRequest{ - ConnectionId: username, - Code: 1000, - Reason: "Navidrome disconnect", - }) - if resp.Error != "" { - return fmt.Errorf("failed to close WebSocket connection: %s", resp.Error) - } - return nil -} - -func (r *discordRPC) OnTextMessage(ctx context.Context, req *api.OnTextMessageRequest) (*api.OnTextMessageResponse, error) { - if len(req.Message) < 1024 { - log.Printf("Received WebSocket message for connection '%s': %s", req.ConnectionId, req.Message) - } else { - log.Printf("Received WebSocket message for connection '%s' (truncated): %s...", req.ConnectionId, req.Message[:1021]) - } - - // Parse the message. If it's a heartbeat_ack, store the sequence number. - message := map[string]any{} - err := json.Unmarshal([]byte(req.Message), &message) - if err != nil { - return nil, fmt.Errorf("failed to parse WebSocket message: %w", err) - } - if v := message["s"]; v != nil { - seq := int64(v.(float64)) - log.Printf("Received heartbeat_ack for connection '%s': %d", req.ConnectionId, seq) - resp, _ := r.mem.SetInt(ctx, &cache.SetIntRequest{ - Key: fmt.Sprintf("discord.seq.%s", req.ConnectionId), - Value: seq, - TtlSeconds: heartbeatInterval * 2, - }) - if !resp.Success { - return nil, fmt.Errorf("failed to store sequence number for user %s", req.ConnectionId) - } - } - return nil, nil -} - -func (r *discordRPC) OnBinaryMessage(_ context.Context, req *api.OnBinaryMessageRequest) (*api.OnBinaryMessageResponse, error) { - log.Printf("Received unexpected binary message for connection '%s'", req.ConnectionId) - return nil, nil -} - -func (r *discordRPC) OnError(_ context.Context, req *api.OnErrorRequest) (*api.OnErrorResponse, error) { - log.Printf("WebSocket error for connection '%s': %s", req.ConnectionId, req.Error) - return nil, nil -} - -func (r *discordRPC) OnClose(_ context.Context, req *api.OnCloseRequest) (*api.OnCloseResponse, error) { - log.Printf("WebSocket connection '%s' closed with code %d: %s", req.ConnectionId, req.Code, req.Reason) - return nil, nil -} - -func (r *discordRPC) OnSchedulerCallback(ctx context.Context, req *api.SchedulerCallbackRequest) (*api.SchedulerCallbackResponse, error) { - err := r.sendHeartbeat(ctx, req.ScheduleId) - if err != nil { - // On first heartbeat failure, immediately clean up the connection - // The next NowPlaying call will reconnect if needed - log.Printf("Heartbeat failed for user %s, cleaning up connection: %v", req.ScheduleId, err) - r.cleanupFailedConnection(ctx, req.ScheduleId) - return nil, fmt.Errorf("heartbeat failed, connection cleaned up: %w", err) - } - - return nil, nil -} diff --git a/plugins/examples/library-inspector-rs/.cargo/config.toml b/plugins/examples/library-inspector-rs/.cargo/config.toml new file mode 100644 index 000000000..6b509f5b7 --- /dev/null +++ b/plugins/examples/library-inspector-rs/.cargo/config.toml @@ -0,0 +1,2 @@ +[build] +target = "wasm32-wasip1" diff --git a/plugins/examples/library-inspector-rs/.gitignore b/plugins/examples/library-inspector-rs/.gitignore new file mode 100644 index 000000000..8f0c20473 --- /dev/null +++ b/plugins/examples/library-inspector-rs/.gitignore @@ -0,0 +1,5 @@ +# Rust build artifacts +/target/ + +# Cargo.lock is not needed for library crates (this is a cdylib) +Cargo.lock \ No newline at end of file diff --git a/plugins/examples/library-inspector-rs/Cargo.toml b/plugins/examples/library-inspector-rs/Cargo.toml new file mode 100644 index 000000000..a0bc9700c --- /dev/null +++ b/plugins/examples/library-inspector-rs/Cargo.toml @@ -0,0 +1,16 @@ +[package] +name = "library-inspector-rs" +version = "1.0.0" +edition = "2021" +description = "Navidrome plugin that periodically logs library details and finds largest files" +authors = ["Navidrome Team"] +license = "GPL-3.0" + +[lib] +crate-type = ["cdylib"] + +[dependencies] +nd-pdk = { path = "../../pdk/rust/nd-pdk" } +extism-pdk = "1.2" +serde = { version = "1.0", features = ["derive"] } +serde_json = "1.0" diff --git a/plugins/examples/library-inspector-rs/README.md b/plugins/examples/library-inspector-rs/README.md new file mode 100644 index 000000000..37c672679 --- /dev/null +++ b/plugins/examples/library-inspector-rs/README.md @@ -0,0 +1,93 @@ +# Library Inspector Plugin + +A Navidrome plugin written in Rust that demonstrates the Library host service. It periodically logs details about all configured music libraries and finds the largest file in the root of each library directory. + +## Features + +- Logs comprehensive library statistics (songs, albums, artists, size, duration) +- Lists the largest file found in each library's root directory +- Configurable inspection interval via cron expression +- Runs an initial inspection on plugin load + +## Requirements + +- Rust toolchain with `wasm32-wasip1` target +- Navidrome with plugins enabled + +## Building + +```bash +# Install the WASM target if you haven't already +rustup target add wasm32-wasip1 + +# Build the plugin +cargo build --target wasm32-wasip1 --release + +# Package as .ndp +zip -j library-inspector.ndp manifest.json target/wasm32-wasip1/release/library_inspector.wasm +``` + +Or use the provided Makefile from the examples directory: + +```bash +cd plugins/examples +make library-inspector.ndp +``` + +## Installation + +1. Copy the `.ndp` file to your Navidrome plugins folder +2. Enable plugins in your Navidrome configuration: + +```toml +[Plugins] +Enabled = true +Folder = "/path/to/plugins" +``` + +3. Restart Navidrome and enable the plugin in the UI + +## Configuration + +Configure the inspection interval in the Navidrome UI (Settings → Plugins → library-inspector): + +| Key | Description | Default | +|--------|------------------------------------------|--------------| +| `cron` | Cron expression for inspection interval | `@every 1m` | + +## Permissions + +This plugin requires: + +- **Library** (with filesystem): To read library metadata and scan directories +- **Scheduler**: To schedule periodic inspections + +## Example Output + +``` +=== Library Inspection Started === +Found 2 libraries +---------------------------------------- +Library: My Music (ID: 1) + Songs: 5432 tracks + Albums: 456 + Artists: 234 + Size: 45.67 GB + Duration: 312h 45m + Mount: /libraries/1 + Largest file in root: cover.jpg (2.34 MB) +---------------------------------------- +Library: Podcasts (ID: 2) + Songs: 128 tracks + Albums: 12 + Artists: 8 + Size: 3.21 GB + Duration: 48h 15m + Mount: /libraries/2 + Largest file in root: episode-001.mp3 (156.78 MB) +=== Library Inspection Complete === +``` + +## License + +GPL-3.0 - Same as Navidrome diff --git a/plugins/examples/library-inspector-rs/manifest.json b/plugins/examples/library-inspector-rs/manifest.json new file mode 100644 index 000000000..6288dc948 --- /dev/null +++ b/plugins/examples/library-inspector-rs/manifest.json @@ -0,0 +1,16 @@ +{ + "name": "Library Inspector", + "author": "Navidrome Team", + "version": "1.0.0", + "description": "Periodically logs library details and finds largest files", + "website": "https://github.com/navidrome/navidrome/tree/master/plugins/examples/library-inspector", + "permissions": { + "library": { + "reason": "To read library metadata and scan directories for file sizes", + "filesystem": true + }, + "scheduler": { + "reason": "To schedule periodic library inspections" + } + } +} diff --git a/plugins/examples/library-inspector-rs/src/lib.rs b/plugins/examples/library-inspector-rs/src/lib.rs new file mode 100644 index 000000000..88ff1b787 --- /dev/null +++ b/plugins/examples/library-inspector-rs/src/lib.rs @@ -0,0 +1,207 @@ +//! Library Inspector Plugin for Navidrome +//! +//! This plugin demonstrates how to use the nd-pdk crate for accessing Navidrome +//! host services and implementing capabilities in Rust. It periodically logs details +//! about all music libraries and finds the largest file in the root of each library. +//! +//! ## Configuration +//! +//! Set the `cron` config key to customize the schedule (default: "@every 1m"): +//! ```toml +//! [PluginConfig.library-inspector] +//! cron = "@every 5m" +//! ``` + +use extism_pdk::*; +use nd_pdk::host::{library, scheduler}; +use nd_pdk::lifecycle::{Error as LifecycleError, InitProvider}; +use nd_pdk::scheduler::{CallbackProvider, Error as SchedulerError, SchedulerCallbackRequest}; +use std::fs; + +// Register capabilities using PDK macros +nd_pdk::register_lifecycle_init!(LibraryInspector); +nd_pdk::register_scheduler_callback!(LibraryInspector); + +// ============================================================================ +// Plugin Implementation +// ============================================================================ + +/// The library inspector plugin type. +#[derive(Default)] +struct LibraryInspector; + +impl InitProvider for LibraryInspector { + fn on_init(&self) -> Result<(), LifecycleError> { + info!("Library Inspector plugin initializing..."); + + // Get cron expression from config, default to every minute + let cron = config::get("cron") + .ok() + .flatten() + .unwrap_or_else(|| "@every 1m".to_string()); + + info!("Scheduling library inspection with cron: {}", cron); + + // Schedule the recurring task using nd-pdk host scheduler + match scheduler::schedule_recurring(&cron, "inspect", "library-inspect") { + Ok(schedule_id) => { + info!("Scheduled inspection task with ID: {}", schedule_id); + } + Err(e) => { + let error_msg = format!("Failed to schedule inspection: {}", e); + error!("{}", error_msg); + return Err(LifecycleError::new(error_msg)); + } + } + + // Run an initial inspection + inspect_libraries(); + + info!("Library Inspector plugin initialized successfully"); + Ok(()) + } +} + +impl CallbackProvider for LibraryInspector { + fn on_callback(&self, req: SchedulerCallbackRequest) -> Result<(), SchedulerError> { + info!( + "Scheduler callback fired: schedule_id={}, payload={}, recurring={}", + req.schedule_id, req.payload, req.is_recurring + ); + + if req.payload == "inspect" { + inspect_libraries(); + } + + Ok(()) + } +} + +// ============================================================================ +// Helper Functions +// ============================================================================ + +/// Format bytes into human-readable size +fn format_size(bytes: i64) -> String { + const KB: i64 = 1024; + const MB: i64 = KB * 1024; + const GB: i64 = MB * 1024; + const TB: i64 = GB * 1024; + + if bytes >= TB { + format!("{:.2} TB", bytes as f64 / TB as f64) + } else if bytes >= GB { + format!("{:.2} GB", bytes as f64 / GB as f64) + } else if bytes >= MB { + format!("{:.2} MB", bytes as f64 / MB as f64) + } else if bytes >= KB { + format!("{:.2} KB", bytes as f64 / KB as f64) + } else { + format!("{} bytes", bytes) + } +} + +/// Format duration in seconds to human-readable format +fn format_duration(seconds: f64) -> String { + let total_seconds = seconds as i64; + let hours = total_seconds / 3600; + let minutes = (total_seconds % 3600) / 60; + + if hours > 0 { + format!("{}h {}m", hours, minutes) + } else { + format!("{}m", minutes) + } +} + +/// Find the largest file in a directory (non-recursive) +fn find_largest_file(mount_point: &str) -> Option<(String, u64)> { + let entries = match fs::read_dir(mount_point) { + Ok(entries) => entries, + Err(e) => { + warn!("Failed to read directory {}: {}", mount_point, e); + return None; + } + }; + + let mut largest: Option<(String, u64)> = None; + + for entry in entries.flatten() { + let path = entry.path(); + + // Only consider files, not directories + if !path.is_file() { + continue; + } + + let metadata = match entry.metadata() { + Ok(m) => m, + Err(_) => continue, + }; + + let size = metadata.len(); + let name = entry.file_name().to_string_lossy().to_string(); + + match &largest { + None => largest = Some((name, size)), + Some((_, current_size)) if size > *current_size => { + largest = Some((name, size)); + } + _ => {} + } + } + + largest +} + +/// Inspect and log all library details +fn inspect_libraries() { + info!("=== Library Inspection Started ==="); + + let libraries = match library::get_all_libraries() { + Ok(libs) => libs, + Err(e) => { + error!("Failed to get libraries: {}", e); + return; + } + }; + + if libraries.is_empty() { + info!("No libraries configured"); + return; + } + + info!("Found {} libraries", libraries.len()); + + for lib in &libraries { + info!("----------------------------------------"); + info!("Library: {} (ID: {})", lib.name, lib.id); + info!(" Songs: {} tracks", lib.total_songs); + info!(" Albums: {}", lib.total_albums); + info!(" Artists: {}", lib.total_artists); + info!(" Size: {}", format_size(lib.total_size)); + info!(" Duration: {}", format_duration(lib.total_duration)); + + // If we have filesystem access, find the largest file + if !lib.mount_point.is_empty() { + info!(" Mount: {}", lib.mount_point); + + match find_largest_file(&lib.mount_point) { + Some((name, size)) => { + info!( + " Largest file in root: {} ({})", + name, + format_size(size as i64) + ); + } + None => { + info!(" Largest file in root: (no files found)"); + } + } + } else { + info!(" (Filesystem access not enabled)"); + } + } + + info!("=== Library Inspection Complete ==="); +} diff --git a/plugins/examples/minimal/README.md b/plugins/examples/minimal/README.md new file mode 100644 index 000000000..549a98a8f --- /dev/null +++ b/plugins/examples/minimal/README.md @@ -0,0 +1,72 @@ +# Minimal Navidrome Plugin Example + +This is a minimal example demonstrating how to create a Navidrome plugin using Go and the Navidrome PDK. + +## Building + +1. Install [TinyGo](https://tinygo.org/getting-started/install/) +2. Build the plugin: + ```bash + go mod tidy + tinygo build -o plugin.wasm -target wasip1 -buildmode=c-shared . + zip -j minimal.ndp manifest.json plugin.wasm + ``` + +Or using the examples Makefile: + ```bash + cd plugins/examples + make minimal.ndp + ``` + +## Installing + +Copy `minimal.ndp` to your Navidrome plugins folder (default: `/plugins/`). + +## Configuration + +Enable plugins in your `navidrome.toml`: + +```toml +[Plugins] +Enabled = true + +# Add the plugin to your agents list +Agents = "lastfm,spotify,minimal" +``` + +## What This Example Demonstrates + +- Plugin package structure (`.ndp` = zip with `manifest.json` + `plugin.wasm`) +- Using the Navidrome PDK `metadata` subpackage +- Implementing the `ArtistBiographyProvider` interface +- Registration pattern with `metadata.Register()` + +## PDK Usage + +```go +import "github.com/navidrome/navidrome/plugins/pdk/go/metadata" + +type myPlugin struct{} + +func init() { + metadata.Register(&myPlugin{}) +} + +func (p *myPlugin) GetArtistBiography(input metadata.ArtistRequest) (metadata.ArtistBiographyResponse, error) { + return metadata.ArtistBiographyResponse{Biography: "..."}, nil +} +``` + +## Extending the Example + +To add more capabilities, implement additional provider interfaces from the `metadata` package: + +- `ArtistMBIDProvider` - Get MusicBrainz ID for an artist +- `ArtistURLProvider` - Get external URL for an artist +- `SimilarArtistsProvider` - Get similar artists +- `ArtistImagesProvider` - Get artist images +- `ArtistTopSongsProvider` - Get top songs for an artist +- `AlbumInfoProvider` - Get album information +- `AlbumImagesProvider` - Get album images + +See the full documentation in `/plugins/README.md` for input/output formats. diff --git a/plugins/examples/minimal/go.mod b/plugins/examples/minimal/go.mod new file mode 100644 index 000000000..b8f6c5fc0 --- /dev/null +++ b/plugins/examples/minimal/go.mod @@ -0,0 +1,16 @@ +module minimal-plugin + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/examples/minimal/go.sum b/plugins/examples/minimal/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/examples/minimal/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/examples/minimal/main.go b/plugins/examples/minimal/main.go new file mode 100644 index 000000000..18303891c --- /dev/null +++ b/plugins/examples/minimal/main.go @@ -0,0 +1,31 @@ +// Minimal example Navidrome plugin demonstrating the MetadataAgent capability. +// +// Build with: +// +// tinygo build -o minimal.wasm -target wasip1 -buildmode=c-shared . +// +// Install by copying minimal.ndp to your Navidrome plugins folder. +package main + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/metadata" +) + +// minimalPlugin implements the metadata provider interfaces. +type minimalPlugin struct{} + +// init registers the plugin implementation +func init() { + metadata.Register(&minimalPlugin{}) +} + +var _ metadata.ArtistBiographyProvider = (*minimalPlugin)(nil) + +// GetArtistBiography returns a placeholder biography for the artist. +func (p *minimalPlugin) GetArtistBiography(input metadata.ArtistRequest) (*metadata.ArtistBiographyResponse, error) { + return &metadata.ArtistBiographyResponse{ + Biography: "This is a placeholder biography for " + input.Name + ".", + }, nil +} + +func main() {} diff --git a/plugins/examples/minimal/manifest.json b/plugins/examples/minimal/manifest.json new file mode 100644 index 000000000..de0c4d75d --- /dev/null +++ b/plugins/examples/minimal/manifest.json @@ -0,0 +1,6 @@ +{ + "name": "Minimal Example", + "author": "Navidrome", + "version": "1.0.0", + "description": "A minimal example plugin" +} diff --git a/plugins/examples/nowplaying-py/Makefile b/plugins/examples/nowplaying-py/Makefile new file mode 100644 index 000000000..2bf6ea971 --- /dev/null +++ b/plugins/examples/nowplaying-py/Makefile @@ -0,0 +1,12 @@ +# Build the Now Playing Logger Python plugin +.PHONY: build test clean + +WASM_FILE = nowplaying-py.wasm + +build: $(WASM_FILE) + +$(WASM_FILE): plugin/__init__.py + extism-py plugin/__init__.py -o $(WASM_FILE) + +clean: + rm -f $(WASM_FILE) diff --git a/plugins/examples/nowplaying-py/README.md b/plugins/examples/nowplaying-py/README.md new file mode 100644 index 000000000..ac4ba26f7 --- /dev/null +++ b/plugins/examples/nowplaying-py/README.md @@ -0,0 +1,112 @@ +# Now Playing Logger Plugin (Python) + +A Python example plugin that demonstrates the **Scheduler** and **SubsonicAPI** host services by periodically logging what is currently playing in Navidrome. + +## Features + +- Uses `scheduler_schedulerecurring` host function to set up a recurring task +- Uses `subsonicapi_call` host function to query the `getNowPlaying` API +- Configurable cron expression and user via plugin config +- Demonstrates Python host function imports using `@extism.import_fn` + +## Prerequisites + +- [extism-py](https://github.com/extism/python-pdk) - Python PDK compiler + ```bash + curl -Ls https://raw.githubusercontent.com/extism/python-pdk/main/install.sh | bash + ``` + +> **Note:** `extism-py` requires [Binaryen](https://github.com/WebAssembly/binaryen/) (`wasm-merge`, `wasm-opt`) to be installed. + +## Building + +From the `plugins/examples` directory: + +```bash +make nowplaying-py.ndp +``` + +Or directly: + +```bash +extism-py plugin/__init__.py -o plugin.wasm +zip -j nowplaying-py.ndp manifest.json plugin.wasm +``` + +## Installation + +1. Copy `nowplaying-py.ndp` to your Navidrome plugins folder + +2. Enable plugins in `navidrome.toml`: + ```toml + [Plugins] + Enabled = true + Folder = "/path/to/plugins" + ``` + +3. Configure the plugin in the UI (Settings → Plugins → nowplaying-py) + +## Configuration + +| Key | Description | Default | +|--------|-------------------------------------|---------------| +| `cron` | Cron expression for check frequency | `*/1 * * * *` | +| `user` | Navidrome user for SubsonicAPI | `admin` | + +## Testing + +Test the manifest: + +```bash +extism call nowplaying-py.wasm nd_manifest --wasi +``` + +## Output + +When running, the plugin logs messages like: + +``` +🎵 john is playing: Pink Floyd - Comfortably Numb (The Wall) +🎵 jane is playing: Radiohead - Paranoid Android (OK Computer) +``` + +Or when no one is playing: + +``` +🎵 No users currently playing music +``` + +## How It Works + +1. **Initialization (`nd_on_init`)**: Reads the cron expression from config and schedules a recurring task using the Scheduler host service. + +2. **Callback (`nd_scheduler_callback`)**: When the scheduled task fires, calls the SubsonicAPI `getNowPlaying` endpoint and logs the results. + +## Host Function Usage (Python) + +This plugin demonstrates how to call Navidrome host functions from Python: + +```python +import extism +import json + +# Import the host function +@extism.import_fn("extism:host/user", "subsonicapi_call") +def _subsonicapi_call(offset: int) -> int: + """Raw host function - returns memory offset.""" + ... + +# Wrapper for JSON marshalling +def subsonicapi_call(uri: str) -> dict: + request = {"uri": uri} + request_bytes = json.dumps(request).encode('utf-8') + request_mem = extism.memory.alloc(request_bytes) + response_offset = _subsonicapi_call(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise Exception(response["error"]) + + return json.loads(response.get("responseJSON", "{}")) +``` \ No newline at end of file diff --git a/plugins/examples/nowplaying-py/manifest.json b/plugins/examples/nowplaying-py/manifest.json new file mode 100644 index 000000000..6284c4617 --- /dev/null +++ b/plugins/examples/nowplaying-py/manifest.json @@ -0,0 +1,18 @@ +{ + "name": "Now Playing Logger (Python)", + "author": "Navidrome", + "version": "1.0.0", + "description": "Periodically logs currently playing tracks - Python example demonstrating Scheduler and SubsonicAPI host services", + "website": "https://github.com/navidrome/navidrome/tree/master/plugins/examples/nowplaying-py", + "permissions": { + "scheduler": { + "reason": "Schedule periodic checks for now playing status" + }, + "subsonicapi": { + "reason": "Query the getNowPlaying API endpoint" + }, + "users": { + "reason": "Access user information for SubsonicAPI authorization" + } + } +} diff --git a/plugins/examples/nowplaying-py/plugin/__init__.py b/plugins/examples/nowplaying-py/plugin/__init__.py new file mode 100644 index 000000000..f7453fdb7 --- /dev/null +++ b/plugins/examples/nowplaying-py/plugin/__init__.py @@ -0,0 +1,168 @@ +# Now Playing Logger Plugin for Navidrome +# +# This plugin demonstrates the Scheduler and SubsonicAPI host services by +# periodically logging what is currently playing in Navidrome. +# +# Build with: +# extism-py plugin/__init__.py -o nowplaying-py.wasm +# +# Configuration: +# [PluginConfig.nowplaying-py] +# cron = "*/1 * * * *" # Every minute (default) +# user = "admin" # User to query getNowPlaying (default) + +import extism +import json + +# Schedule ID for our recurring task +SCHEDULE_ID = "nowplaying-check" + + +# ============================================================================= +# Host Function Imports +# ============================================================================= +# These are custom host functions provided by Navidrome. +# We import them using the extism:host/user namespace. + + +@extism.import_fn("extism:host/user", "scheduler_schedulerecurring") +def _scheduler_schedulerecurring(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "subsonicapi_call") +def _subsonicapi_call(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +# ============================================================================= +# Host Function Wrappers +# ============================================================================= +# These wrappers handle JSON marshalling/unmarshalling and memory management. +# They were copied from plugins/host/python due to extism-py limitations. + + +def scheduler_schedule_recurring(cron_expression: str, payload: str, schedule_id: str) -> str: + """Schedule a recurring task using a cron expression. + + Args: + cron_expression: Cron format (e.g., "*/1 * * * *" for every minute) + payload: Data to pass to the callback + schedule_id: Unique identifier for the schedule + + Returns: + The schedule ID (same as input or auto-generated) + """ + request = { + "cronExpression": cron_expression, + "payload": payload, + "scheduleId": schedule_id + } + request_bytes = json.dumps(request).encode('utf-8') + request_mem = extism.memory.alloc(request_bytes) + response_offset = _scheduler_schedulerecurring(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise Exception(response["error"]) + + return response.get("newScheduleId", schedule_id) + + +def subsonicapi_call(uri: str) -> dict: + """Call a Subsonic API endpoint. + + Args: + uri: API path (e.g., "getNowPlaying") + + Returns: + Parsed JSON response from the API + """ + request = {"uri": uri} + request_bytes = json.dumps(request).encode('utf-8') + request_mem = extism.memory.alloc(request_bytes) + response_offset = _subsonicapi_call(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise Exception(response["error"]) + + # Parse the nested JSON response + response_json = response.get("responseJson", "{}") + return json.loads(response_json) + + +# ============================================================================= +# Plugin Exports +# ============================================================================= + + +@extism.plugin_fn +def nd_on_init(): + """Initialize the plugin by scheduling the recurring task.""" + # Read cron expression from config, default to every minute + cron = extism.Config.get_str("cron") + if not cron: + cron = "*/1 * * * *" + + extism.log(extism.LogLevel.Info, f"Now Playing Logger initializing with cron: {cron}") + + try: + schedule_id = scheduler_schedule_recurring(cron, "check", SCHEDULE_ID) + extism.log(extism.LogLevel.Info, f"Scheduled recurring task with ID: {schedule_id}") + except Exception as e: + extism.log(extism.LogLevel.Error, f"Failed to schedule task: {e}") + raise + # No output - lifecycle callbacks don't return responses + + +@extism.plugin_fn +def nd_scheduler_callback(): + """Handle scheduler callback - check and log now playing tracks.""" + input_data = extism.input_json() + schedule_id = input_data.get("scheduleId", "") + + # Only handle our schedule + if schedule_id != SCHEDULE_ID: + return + + try: + # Read user from config, default to admin + user = extism.Config.get_str("user") + if not user: + user = "admin" + + # Call the getNowPlaying API + response = subsonicapi_call(f"getNowPlaying?u={user}") + + # Extract the subsonic-response + subsonic_response = response.get("subsonic-response", {}) + now_playing = subsonic_response.get("nowPlaying", {}) + entries = now_playing.get("entry", []) + + if not entries: + extism.log(extism.LogLevel.Info, "🎵 No users currently playing music") + else: + # Handle both single entry and list of entries + if isinstance(entries, dict): + entries = [entries] + + for entry in entries: + artist = entry.get("artist", "Unknown Artist") + title = entry.get("title", "Unknown Title") + album = entry.get("album", "Unknown Album") + username = entry.get("username", "Unknown User") + + extism.log( + extism.LogLevel.Info, + f"🎵 {username} is playing: {artist} - {title} ({album})" + ) + # No output - scheduler callbacks don't return responses + + except Exception as e: + extism.log(extism.LogLevel.Error, f"Failed to get now playing: {e}") + # Errors are logged but scheduler callbacks don't return responses diff --git a/plugins/examples/subsonicapi-demo/README.md b/plugins/examples/subsonicapi-demo/README.md deleted file mode 100644 index b5ac9f784..000000000 --- a/plugins/examples/subsonicapi-demo/README.md +++ /dev/null @@ -1,88 +0,0 @@ -# SubsonicAPI Demo Plugin - -This example plugin demonstrates how to use the SubsonicAPI host service to access Navidrome's Subsonic API from within a plugin. - -## What it does - -The plugin performs the following operations during initialization: - -1. **Ping the server**: Calls `/rest/ping` to check if the Subsonic API is responding -2. **Get license info**: Calls `/rest/getLicense` to retrieve server license information - -## Key Features - -- Shows how to request `subsonicapi` permission in the manifest -- Demonstrates making Subsonic API calls using the `subsonicapi.Call()` method -- Handles both successful responses and errors -- Uses proper lifecycle management with `OnInit` - -## Usage - -### Manifest Configuration - -```json -{ - "permissions": { - "subsonicapi": { - "reason": "Demonstrate accessing Navidrome's Subsonic API from within plugins", - "allowAdmins": true - } - } -} -``` - -### Plugin Implementation - -```go -import "github.com/navidrome/navidrome/plugins/host/subsonicapi" - -var subsonicService = subsonicapi.NewSubsonicAPIService() - -// OnInit is called when the plugin is loaded -func (SubsonicAPIDemoPlugin) OnInit(ctx context.Context, req *api.InitRequest) (*api.InitResponse, error) { - // Make API calls - response, err := subsonicService.Call(ctx, &subsonicapi.CallRequest{ - Url: "/rest/ping?u=admin", - }) - // Handle response... -} -``` - -When running Navidrome with this plugin installed, it will automatically call the Subsonic API endpoints during the -server startup, and you can see the results in the logs: - -```agsl -INFO[0000] 2022/01/01 00:00:00 SubsonicAPI Demo Plugin initializing... -DEBU[0000] API: New request /ping client=subsonicapi-demo username=admin version=1.16.1 -DEBU[0000] API: Successful response endpoint=/ping status=OK -DEBU[0000] API: New request /getLicense client=subsonicapi-demo username=admin version=1.16.1 -INFO[0000] 2022/01/01 00:00:00 SubsonicAPI ping response: {"subsonic-response":{"status":"ok","version":"1.16.1","type":"navidrome","serverVersion":"dev","openSubsonic":true}} -DEBU[0000] API: Successful response endpoint=/getLicense status=OK -DEBU[0000] Plugin initialized successfully elapsed=41.9ms plugin=subsonicapi-demo -INFO[0000] 2022/01/01 00:00:00 SubsonicAPI license info: {"subsonic-response":{"status":"ok","version":"1.16.1","type":"navidrome","serverVersion":"dev","openSubsonic":true,"license":{"valid":true}}} -``` - -## Important Notes - -1. **Authentication**: The plugin must provide valid authentication parameters in the URL: - - **Required**: `u` (username) - The service validates this parameter is present - - Example: `"/rest/ping?u=admin"` -2. **URL Format**: Only the path and query parameters from the URL are used - host, protocol, and method are ignored -3. **Automatic Parameters**: The service automatically adds: - - `c`: Plugin name (client identifier) - - `v`: Subsonic API version (1.16.1) - - `f`: Response format (json) -4. **Internal Authentication**: The service sets up internal authentication using the `u` parameter -5. **Lifecycle**: This plugin uses `LifecycleManagement` with only the `OnInit` method - -## Building - -This plugin uses the `wasip1` build constraint and must be compiled for WebAssembly: - -```bash -# Using the project's make target (recommended) -make plugin-examples - -# Manual compilation (when using the proper toolchain) -GOOS=wasip1 GOARCH=wasm go build -buildmode=c-shared -o plugin.wasm plugin.go -``` diff --git a/plugins/examples/subsonicapi-demo/manifest.json b/plugins/examples/subsonicapi-demo/manifest.json deleted file mode 100644 index d26c33181..000000000 --- a/plugins/examples/subsonicapi-demo/manifest.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "$schema": "https://raw.githubusercontent.com/navidrome/navidrome/refs/heads/master/plugins/schema/manifest.schema.json", - "name": "subsonicapi-demo", - "author": "Navidrome Team", - "version": "1.0.0", - "description": "Example plugin demonstrating SubsonicAPI host service usage", - "website": "https://github.com/navidrome/navidrome", - "capabilities": ["LifecycleManagement"], - "permissions": { - "subsonicapi": { - "reason": "Demonstrate accessing Navidrome's Subsonic API from within plugins", - "allowAdmins": true, - "allowedUsernames": ["admin"] - } - } -} diff --git a/plugins/examples/subsonicapi-demo/plugin.go b/plugins/examples/subsonicapi-demo/plugin.go deleted file mode 100644 index 4ca087ac7..000000000 --- a/plugins/examples/subsonicapi-demo/plugin.go +++ /dev/null @@ -1,68 +0,0 @@ -//go:build wasip1 - -package main - -import ( - "context" - "log" - - "github.com/navidrome/navidrome/plugins/api" - "github.com/navidrome/navidrome/plugins/host/subsonicapi" -) - -// SubsonicAPIService instance for making API calls -var subsonicService = subsonicapi.NewSubsonicAPIService() - -// SubsonicAPIDemoPlugin implements LifecycleManagement interface -type SubsonicAPIDemoPlugin struct{} - -// OnInit is called when the plugin is loaded -func (SubsonicAPIDemoPlugin) OnInit(ctx context.Context, req *api.InitRequest) (*api.InitResponse, error) { - log.Printf("SubsonicAPI Demo Plugin initializing...") - - // Example: Call the ping endpoint to check if the server is alive - response, err := subsonicService.Call(ctx, &subsonicapi.CallRequest{ - Url: "/rest/ping?u=admin", - }) - - if err != nil { - log.Printf("SubsonicAPI call failed: %v", err) - return &api.InitResponse{Error: err.Error()}, nil - } - - if response.Error != "" { - log.Printf("SubsonicAPI returned error: %s", response.Error) - return &api.InitResponse{Error: response.Error}, nil - } - - log.Printf("SubsonicAPI ping response: %s", response.Json) - - // Example: Get server info - infoResponse, err := subsonicService.Call(ctx, &subsonicapi.CallRequest{ - Url: "/rest/getLicense?u=admin", - }) - - if err != nil { - log.Printf("SubsonicAPI getLicense call failed: %v", err) - return &api.InitResponse{Error: err.Error()}, nil - } - - if infoResponse.Error != "" { - log.Printf("SubsonicAPI getLicense returned error: %s", infoResponse.Error) - return &api.InitResponse{Error: infoResponse.Error}, nil - } - - log.Printf("SubsonicAPI license info: %s", infoResponse.Json) - - return &api.InitResponse{}, nil -} - -func main() {} - -func init() { - // Configure logging: No timestamps, no source file/line - log.SetFlags(0) - log.SetPrefix("[Subsonic Plugin] ") - - api.RegisterLifecycleManagement(&SubsonicAPIDemoPlugin{}) -} diff --git a/plugins/examples/webhook-rs/.cargo/config.toml b/plugins/examples/webhook-rs/.cargo/config.toml new file mode 100644 index 000000000..6b509f5b7 --- /dev/null +++ b/plugins/examples/webhook-rs/.cargo/config.toml @@ -0,0 +1,2 @@ +[build] +target = "wasm32-wasip1" diff --git a/plugins/examples/webhook-rs/Cargo.toml b/plugins/examples/webhook-rs/Cargo.toml new file mode 100644 index 000000000..d74e180fd --- /dev/null +++ b/plugins/examples/webhook-rs/Cargo.toml @@ -0,0 +1,16 @@ +[package] +name = "webhook-rs" +version = "1.0.0" +edition = "2021" +description = "Navidrome webhook plugin that sends HTTP requests on scrobble events" +authors = ["Navidrome Team"] +license = "GPL-3.0" + +[lib] +crate-type = ["cdylib"] + +[dependencies] +nd-pdk = { path = "../../pdk/rust/nd-pdk" } +extism-pdk = "1.2" +serde = { version = "1.0", features = ["derive"] } +serde_json = "1.0" diff --git a/plugins/examples/webhook-rs/README.md b/plugins/examples/webhook-rs/README.md new file mode 100644 index 000000000..86afad9bb --- /dev/null +++ b/plugins/examples/webhook-rs/README.md @@ -0,0 +1,77 @@ +# Webhook Scrobbler Plugin (Rust) + +A Navidrome plugin written in Rust that sends HTTP webhook notifications when tracks are scrobbled. This is useful for integrating with external services like home automation systems, Discord bots, monitoring tools, or any service that can receive HTTP requests. + +## Features + +- Sends HTTP GET requests to configured URLs on every scrobble event +- Includes track metadata (title, artist, album, username, timestamp) as query parameters +- Supports multiple webhook URLs (comma-separated) +- All users are automatically authorized (no external service authentication required) +- Now playing events are ignored (webhooks fire only on completed scrobbles) + +## Prerequisites + +- [Rust](https://rustup.rs/) toolchain +- WebAssembly target: `rustup target add wasm32-unknown-unknown` + +## Building + +From the `plugins/examples` directory: + +```bash +make webhook-rs.ndp +``` + +Or build directly with cargo: + +```bash +cd webhook-rs +cargo build --release +zip -j webhook-rs.ndp manifest.json target/wasm32-unknown-unknown/release/webhook_rs.wasm +``` + +## Installation + +Copy `webhook-rs.ndp` to your Navidrome plugins folder (configured via `Plugins.Folder` in your config). + +## Configuration + +Configure in the Navidrome UI (Settings → Plugins → webhook-rs): + +| Key | Description | Example | +|--------|--------------------------------------|-----------------------------------------------------------| +| `urls` | Comma-separated list of webhook URLs | `https://example.com/hook1,https://example.com/hook2` | + +## Webhook Request Format + +When a scrobble occurs, the plugin sends an HTTP GET request to each configured URL with the following query parameters: + +| Parameter | Description | +|-------------|-----------------------------------------------| +| `title` | Track title | +| `artist` | Track artist | +| `album` | Album name | +| `user` | Username who scrobbled | +| `timestamp` | Unix timestamp when the track started playing | + +Example request: +``` +GET https://example.com/webhook?title=Song%20Name&artist=Artist%20Name&album=Album%20Name&user=john×tamp=1703270400 +``` + +## Use Cases + +- **Home Automation**: Trigger lights or displays when music starts playing +- **Discord/Slack Notifications**: Post currently playing tracks to a channel +- **Logging/Analytics**: Track listening history in an external system +- **IFTTT/Zapier Integration**: Connect to thousands of services via webhook triggers + +## Development + +The plugin is built using the [Extism Rust PDK](https://github.com/extism/rust-pdk). Key exports: + +- `nd_manifest` - Returns plugin metadata and permissions +- `nd_scrobbler_is_authorized` - Always returns `true` (all users authorized) +- `nd_scrobbler_now_playing` - No-op (returns success without action) +- `nd_scrobbler_scrobble` - Sends webhooks to configured URLs diff --git a/plugins/examples/webhook-rs/manifest.json b/plugins/examples/webhook-rs/manifest.json new file mode 100644 index 000000000..88048a747 --- /dev/null +++ b/plugins/examples/webhook-rs/manifest.json @@ -0,0 +1,16 @@ +{ + "name": "Webhook Scrobbler", + "author": "Navidrome Team", + "version": "1.0.0", + "description": "Sends HTTP webhooks on scrobble events", + "website": "https://github.com/navidrome/navidrome/tree/master/plugins/examples/webhook-rs", + "permissions": { + "http": { + "reason": "To send webhook notifications to configured URLs", + "requiredHosts": ["*"] + }, + "users": { + "reason": "Receive scrobble events for users assigned to this plugin" + } + } +} diff --git a/plugins/examples/webhook-rs/src/lib.rs b/plugins/examples/webhook-rs/src/lib.rs new file mode 100644 index 000000000..e872d845d --- /dev/null +++ b/plugins/examples/webhook-rs/src/lib.rs @@ -0,0 +1,119 @@ +//! Webhook Scrobbler Plugin for Navidrome +//! +//! This plugin demonstrates how to build a Navidrome plugin in Rust using the nd-pdk crate. +//! It implements the Scrobbler capability and sends HTTP GET requests to configured URLs +//! whenever a track is scrobbled. +//! +//! ## Configuration +//! +//! Set the `urls` config key to a comma-separated list of webhook URLs: +//! ```toml +//! [PluginConfig.webhook-rs] +//! urls = "https://example.com/webhook1,https://example.com/webhook2" +//! ``` + +use extism_pdk::{config, error, http, info, warn, HttpRequest}; +use nd_pdk::scrobbler::{ + Error, IsAuthorizedRequest, NowPlayingRequest, ScrobbleRequest, + Scrobbler, +}; + +// Register the WASM exports for the Scrobbler capability +nd_pdk::register_scrobbler!(WebhookPlugin); + +// ============================================================================ +// Plugin Implementation +// ============================================================================ + +/// The webhook plugin type. Implements the Scrobbler trait. +#[derive(Default)] +struct WebhookPlugin; + +impl Scrobbler for WebhookPlugin { + /// Checks if a user is authorized. This plugin authorizes all users. + fn is_authorized(&self, req: IsAuthorizedRequest) -> Result { + info!("Authorization check for user: {}", req.username); + Ok(true) + } + + /// Handles now playing notifications. This plugin ignores them (webhooks only on scrobble). + fn now_playing(&self, req: NowPlayingRequest) -> Result<(), Error> { + info!( + "Now playing (ignored): {} - {} for user {}", + req.track.artist, req.track.title, req.username + ); + Ok(()) + } + + /// Handles scrobble events by sending HTTP GET requests to configured URLs. + fn scrobble(&self, req: ScrobbleRequest) -> Result<(), Error> { + // Get configured URLs + let urls_config = match config::get("urls") { + Ok(Some(urls)) if !urls.is_empty() => urls, + _ => { + warn!("No webhook URLs configured. Set 'urls' in plugin config."); + return Ok(()); + } + }; + + info!( + "Scrobble: {} - {} by user {}", + req.track.artist, req.track.title, req.username + ); + + // Build query parameters + let query = format!( + "?title={}&artist={}&album={}&user={}×tamp={}", + urlencode(&req.track.title), + urlencode(&req.track.artist), + urlencode(&req.track.album), + urlencode(&req.username), + req.timestamp + ); + + // Send requests to each configured URL + for url in urls_config.split(',') { + let url = url.trim(); + if url.is_empty() { + continue; + } + + let full_url = format!("{}{}", url, query); + info!("Sending webhook to: {}", full_url); + + let http_req = HttpRequest::new(&full_url); + match http::request::<()>(&http_req, None) { + Ok(res) => { + let status = res.status_code(); + if status >= 200 && status < 300 { + info!("Webhook succeeded: {} (status {})", url, status); + } else { + warn!("Webhook returned non-2xx status: {} (status {})", url, status); + } + } + Err(e) => { + error!("Webhook failed for {}: {:?}", url, e); + } + } + } + + Ok(()) + } +} + +/// Simple URL encoding for query parameters. +fn urlencode(s: &str) -> String { + let mut result = String::with_capacity(s.len() * 3); + for c in s.chars() { + match c { + 'A'..='Z' | 'a'..='z' | '0'..='9' | '-' | '_' | '.' | '~' => result.push(c), + ' ' => result.push_str("%20"), + _ => { + for b in c.to_string().as_bytes() { + result.push_str(&format!("%{:02X}", b)); + } + } + } + } + result +} diff --git a/plugins/examples/wikimedia/README.md b/plugins/examples/wikimedia/README.md index 15feed2d3..181055c69 100644 --- a/plugins/examples/wikimedia/README.md +++ b/plugins/examples/wikimedia/README.md @@ -1,32 +1,144 @@ -# Wikimedia Artist Metadata Plugin +# Wikimedia Plugin for Navidrome -This is a WASM plugin for Navidrome that retrieves artist information from Wikidata/DBpedia using the Wikidata SPARQL endpoint. +A Navidrome plugin that fetches artist metadata from Wikidata, DBpedia, and Wikipedia. -## Implemented Methods +## Generating the Plugin -- `GetArtistBiography`: Returns the artist's English biography/description from Wikidata. -- `GetArtistURL`: Returns the artist's official website (if available) from Wikidata. -- `GetArtistImages`: Returns the artist's main image (Wikimedia Commons) from Wikidata. +This plugin was generated using the XTP CLI: -All other methods (`GetArtistMBID`, `GetSimilarArtists`, `GetArtistTopSongs`) return a "not implemented" error, as this data is not available from Wikidata/DBpedia. +```bash +xtp plugin init \ + --schema-file plugins/schemas/metadata_agent.yaml \ + --template go \ + --path ./wikimedia \ + --name wikimedia-plugin +``` -## How it Works +## Features -- The plugin uses the host-provided HTTP service (`HttpService`) to make SPARQL queries to the Wikidata endpoint. -- No network requests are made directly from the plugin; all HTTP is routed through the host. +- **Artist URL**: Fetches Wikipedia URL for an artist using Wikidata (by MBID or name), DBpedia, or falls back to a Wikipedia search URL +- **Artist Biography**: Fetches the introductory text from the artist's Wikipedia page +- **Artist Images**: Fetches artist images from Wikidata ## Building -To build the plugin to WASM: +### Using TinyGo -``` -GOOS=wasip1 GOARCH=wasm go build -buildmode=c-shared -o plugin.wasm plugin.go +```bash +tinygo build -target wasip1 -buildmode=c-shared -o plugin.wasm . +zip -j wikimedia.ndp manifest.json plugin.wasm ``` -## Usage +### Using the Makefile -Copy the resulting `plugin.wasm` to your Navidrome plugins folder under a `wikimedia` directory. +From the `plugins/examples` directory: ---- +```bash +make wikimedia.ndp +``` -For more details, see the source code in `plugin.go`. +### Using XTP CLI + +```bash +xtp plugin build +zip -j wikimedia.ndp manifest.json dist/plugin.wasm +``` + +## Installation + +Copy the `.ndp` file to your Navidrome plugins folder: + +```bash +cp wikimedia.ndp /path/to/navidrome/plugins/ +``` + +Then enable plugins in your `navidrome.toml`: + +```toml +[Plugins] +Enabled = true +Folder = "/path/to/navidrome/plugins" +``` + +Add the plugin to your agents list: + +```toml +Agents = "lastfm,wikimedia" +``` + +## Testing with Extism CLI + +Install the [Extism CLI](https://extism.org/docs/install): + +```bash +brew install extism/tap/extism # macOS +# or see https://extism.org/docs/install for other platforms +``` + +Extract the wasm file from the package and test: + +```bash +# Extract wasm from package +unzip -p wikimedia.ndp plugin.wasm > wikimedia.wasm + +# Test artist URL lookup with MBID (The Beatles) +extism call wikimedia.wasm nd_get_artist_url --wasi \ + --input '{"id":"1","name":"The Beatles","mbid":"b10bbbfc-cf9e-42e0-be17-e2c3e1d2600d"}' \ + --allow-host "query.wikidata.org" +``` + +Expected output: +```json +{"url":"https://en.wikipedia.org/wiki/The_Beatles"} +``` + +### Test artist biography + +```bash +extism call wikimedia.wasm nd_get_artist_biography --wasi \ + --input '{"id":"1","name":"The Beatles","mbid":"b10bbbfc-cf9e-42e0-be17-e2c3e1d2600d"}' \ + --allow-host "query.wikidata.org" \ + --allow-host "en.wikipedia.org" +``` + +### Test artist images + +```bash +extism call wikimedia.wasm nd_get_artist_images --wasi \ + --input '{"id":"1","name":"The Beatles","mbid":"b10bbbfc-cf9e-42e0-be17-e2c3e1d2600d"}' \ + --allow-host "query.wikidata.org" +``` + +Expected output: +```json +{"images":[{"url":"http://commons.wikimedia.org/wiki/Special:FilePath/Beatles%20ad%201965%20just%20the%20beatles%20crop.jpg","size":0}]} +``` + +## Project Structure + +``` +wikimedia/ +├── main.go # Plugin implementation with Wikimedia API logic +├── pdk.gen.go # Generated types and export wrappers (DO NOT EDIT) +├── go.mod # Go module file +├── go.sum # Go module checksums +├── prepare.sh # Build preparation script +└── xtp.toml # XTP plugin configuration +``` + +## API Endpoints Used + +| Service | Endpoint | Purpose | +|-----------|--------------------------------------|-----------------------------------------------------------| +| Wikidata | `https://query.wikidata.org/sparql` | SPARQL queries for Wikipedia URLs and images | +| DBpedia | `https://dbpedia.org/sparql` | Fallback SPARQL queries for Wikipedia URLs and short bios | +| Wikipedia | `https://en.wikipedia.org/w/api.php` | MediaWiki API for article extracts | + +## Implemented Functions + +| Function | Description | +|---------------------------|-----------------------------------------------| +| `nd_manifest` | Returns plugin manifest with HTTP permissions | +| `nd_get_artist_url` | Returns Wikipedia URL for an artist | +| `nd_get_artist_biography` | Returns artist biography from Wikipedia | +| `nd_get_artist_images` | Returns artist image URLs from Wikidata | diff --git a/plugins/examples/wikimedia/go.mod b/plugins/examples/wikimedia/go.mod new file mode 100644 index 000000000..17f14b065 --- /dev/null +++ b/plugins/examples/wikimedia/go.mod @@ -0,0 +1,16 @@ +module wikimedia-plugin + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/examples/wikimedia/go.sum b/plugins/examples/wikimedia/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/examples/wikimedia/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/examples/wikimedia/main.go b/plugins/examples/wikimedia/main.go new file mode 100644 index 000000000..8508354cf --- /dev/null +++ b/plugins/examples/wikimedia/main.go @@ -0,0 +1,366 @@ +// Wikimedia plugin for Navidrome - fetches artist metadata from Wikidata, DBpedia and Wikipedia. +// +// Build with: +// +// tinygo build -o wikimedia.wasm -target wasip1 -buildmode=c-shared . +// +// Install by copying the .ndp file to your Navidrome plugins folder. +package main + +import ( + "encoding/json" + "errors" + "fmt" + "net/url" + "strings" + + "github.com/navidrome/navidrome/plugins/pdk/go/host" + "github.com/navidrome/navidrome/plugins/pdk/go/metadata" + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// wikimediaPlugin implements the metadata provider interfaces for the methods we support. +type wikimediaPlugin struct{} + +// init registers the plugin implementation +func init() { + metadata.Register(&wikimediaPlugin{}) +} + +// Ensure wikimediaPlugin implements the provider interfaces +var ( + _ metadata.ArtistURLProvider = (*wikimediaPlugin)(nil) + _ metadata.ArtistBiographyProvider = (*wikimediaPlugin)(nil) + _ metadata.ArtistImagesProvider = (*wikimediaPlugin)(nil) +) + +const ( + wikidataEndpoint = "https://query.wikidata.org/sparql" + dbpediaEndpoint = "https://dbpedia.org/sparql" + mediawikiAPIEndpoint = "https://en.wikipedia.org/w/api.php" +) + +// SPARQL response types +type SPARQLResult struct { + Results struct { + Bindings []SPARQLBinding `json:"bindings"` + } `json:"results"` +} + +type SPARQLBinding struct { + Sitelink *SPARQLValue `json:"sitelink,omitempty"` + Wiki *SPARQLValue `json:"wiki,omitempty"` + Comment *SPARQLValue `json:"comment,omitempty"` + Img *SPARQLValue `json:"img,omitempty"` +} + +type SPARQLValue struct { + Value string `json:"value"` +} + +// MediaWiki API response types +type MediaWikiExtractResult struct { + Query struct { + Pages map[string]MediaWikiPage `json:"pages"` + } `json:"query"` +} + +type MediaWikiPage struct { + PageID int `json:"pageid"` + Ns int `json:"ns"` + Title string `json:"title"` + Extract string `json:"extract"` + Missing bool `json:"missing"` +} + +// sparqlQuery executes a SPARQL query and returns the result +func sparqlQuery(endpoint, query string) (*SPARQLResult, error) { + form := url.Values{} + form.Set("query", query) + + pdk.Log(pdk.LogDebug, fmt.Sprintf("SPARQL query to %s: %s", endpoint, query)) + + resp, err := host.HTTPSend(host.HTTPRequest{ + Method: "POST", + URL: endpoint, + Headers: map[string]string{ + "Accept": "application/sparql-results+json", + "Content-Type": "application/x-www-form-urlencoded", + "User-Agent": "NavidromeWikimediaPlugin/1.0", + }, + Body: []byte(form.Encode()), + TimeoutMs: 10000, + }) + if err != nil { + return nil, fmt.Errorf("SPARQL HTTP error: %w", err) + } + if resp.StatusCode != 200 { + return nil, fmt.Errorf("SPARQL HTTP error: status %d", resp.StatusCode) + } + + var result SPARQLResult + if err := json.Unmarshal(resp.Body, &result); err != nil { + return nil, fmt.Errorf("failed to parse SPARQL response: %w", err) + } + if len(result.Results.Bindings) == 0 { + return nil, errors.New("not found") + } + return &result, nil +} + +// mediawikiQuery executes a MediaWiki API query +func mediawikiQuery(params url.Values) ([]byte, error) { + apiURL := fmt.Sprintf("%s?%s", mediawikiAPIEndpoint, params.Encode()) + + resp, err := host.HTTPSend(host.HTTPRequest{ + Method: "GET", + URL: apiURL, + Headers: map[string]string{ + "Accept": "application/json", + "User-Agent": "NavidromeWikimediaPlugin/1.0", + }, + TimeoutMs: 10000, + }) + if err != nil { + return nil, fmt.Errorf("MediaWiki HTTP error: %w", err) + } + if resp.StatusCode != 200 { + return nil, fmt.Errorf("MediaWiki HTTP error: status %d", resp.StatusCode) + } + return resp.Body, nil +} + +// getWikidataWikipediaURL fetches the Wikipedia URL from Wikidata using MBID or name +func getWikidataWikipediaURL(mbid, name string) (string, error) { + var q string + if mbid != "" { + q = fmt.Sprintf(`SELECT ?sitelink WHERE { ?artist wdt:P434 "%s". ?sitelink schema:about ?artist; schema:isPartOf . } LIMIT 1`, mbid) + } else if name != "" { + escapedName := strings.ReplaceAll(name, "\"", "\\\"") + q = fmt.Sprintf(`SELECT ?sitelink WHERE { ?artist rdfs:label "%s"@en. ?sitelink schema:about ?artist; schema:isPartOf . } LIMIT 1`, escapedName) + } else { + return "", errors.New("MBID or Name required for Wikidata URL lookup") + } + + result, err := sparqlQuery(wikidataEndpoint, q) + if err != nil { + return "", err + } + if result.Results.Bindings[0].Sitelink != nil { + return result.Results.Bindings[0].Sitelink.Value, nil + } + return "", errors.New("not found") +} + +// getDBpediaWikipediaURL fetches the Wikipedia URL from DBpedia using name +func getDBpediaWikipediaURL(name string) (string, error) { + if name == "" { + return "", errors.New("not found") + } + escapedName := strings.ReplaceAll(name, "\"", "\\\"") + q := fmt.Sprintf(`SELECT ?wiki WHERE { ?artist foaf:name "%s"@en; foaf:isPrimaryTopicOf ?wiki. FILTER regex(str(?wiki), "^https://en.wikipedia.org/") } LIMIT 1`, escapedName) + + result, err := sparqlQuery(dbpediaEndpoint, q) + if err != nil { + return "", err + } + if result.Results.Bindings[0].Wiki != nil { + return result.Results.Bindings[0].Wiki.Value, nil + } + return "", errors.New("not found") +} + +// getDBpediaComment fetches the DBpedia comment (short bio) for an artist +func getDBpediaComment(name string) (string, error) { + if name == "" { + return "", errors.New("not found") + } + escapedName := strings.ReplaceAll(name, "\"", "\\\"") + q := fmt.Sprintf(`SELECT ?comment WHERE { ?artist foaf:name "%s"@en; rdfs:comment ?comment. FILTER (lang(?comment) = 'en') } LIMIT 1`, escapedName) + + result, err := sparqlQuery(dbpediaEndpoint, q) + if err != nil { + return "", err + } + if result.Results.Bindings[0].Comment != nil { + return result.Results.Bindings[0].Comment.Value, nil + } + return "", errors.New("not found") +} + +// getWikipediaExtract fetches the intro text from Wikipedia +func getWikipediaExtract(pageTitle string) (string, error) { + if pageTitle == "" { + return "", errors.New("page title required") + } + params := url.Values{} + params.Set("action", "query") + params.Set("format", "json") + params.Set("prop", "extracts") + params.Set("exintro", "true") + params.Set("explaintext", "true") + params.Set("titles", pageTitle) + params.Set("redirects", "1") + + body, err := mediawikiQuery(params) + if err != nil { + return "", err + } + + var result MediaWikiExtractResult + if err := json.Unmarshal(body, &result); err != nil { + return "", fmt.Errorf("failed to parse MediaWiki response: %w", err) + } + + for _, page := range result.Query.Pages { + if page.Missing { + continue + } + if page.Extract != "" { + return strings.TrimSpace(page.Extract), nil + } + } + return "", errors.New("not found") +} + +// extractPageTitleFromURL extracts the page title from a Wikipedia URL +func extractPageTitleFromURL(wikiURL string) (string, error) { + parsedURL, err := url.Parse(wikiURL) + if err != nil { + return "", err + } + if parsedURL.Host != "en.wikipedia.org" { + return "", fmt.Errorf("URL host is not en.wikipedia.org: %s", parsedURL.Host) + } + pathParts := strings.Split(strings.TrimPrefix(parsedURL.Path, "/"), "/") + if len(pathParts) < 2 || pathParts[0] != "wiki" { + return "", fmt.Errorf("URL path does not match /wiki/ format: %s", parsedURL.Path) + } + title := pathParts[1] + if title == "" { + return "", errors.New("extracted title is empty") + } + decodedTitle, err := url.PathUnescape(title) + if err != nil { + return "", fmt.Errorf("failed to decode title '%s': %w", title, err) + } + return decodedTitle, nil +} + +// GetArtistURL returns the Wikipedia URL for an artist +func (*wikimediaPlugin) GetArtistURL(input metadata.ArtistRequest) (*metadata.ArtistURLResponse, error) { + pdk.Log(pdk.LogDebug, fmt.Sprintf("GetArtistURL: name=%s, mbid=%s", input.Name, input.MBID)) + + // 1. Try Wikidata (MBID first, then name) + wikiURL, err := getWikidataWikipediaURL(input.MBID, input.Name) + if err == nil && wikiURL != "" { + return &metadata.ArtistURLResponse{URL: wikiURL}, nil + } + if err != nil { + pdk.Log(pdk.LogDebug, fmt.Sprintf("Wikidata URL failed: %v", err)) + } + + // 2. Try DBpedia (Name only) + if input.Name != "" { + wikiURL, err = getDBpediaWikipediaURL(input.Name) + if err == nil && wikiURL != "" { + return &metadata.ArtistURLResponse{URL: wikiURL}, nil + } + if err != nil { + pdk.Log(pdk.LogDebug, fmt.Sprintf("DBpedia URL failed: %v", err)) + } + } + + // 3. Fallback to search URL + if input.Name != "" { + searchURL := fmt.Sprintf("https://en.wikipedia.org/w/index.php?search=%s", url.QueryEscape(input.Name)) + pdk.Log(pdk.LogInfo, fmt.Sprintf("URL not found, falling back to search URL: %s", searchURL)) + return &metadata.ArtistURLResponse{URL: searchURL}, nil + } + + return nil, errors.New("could not determine Wikipedia URL") +} + +// GetArtistBiography returns the biography for an artist from Wikipedia +func (*wikimediaPlugin) GetArtistBiography(input metadata.ArtistRequest) (*metadata.ArtistBiographyResponse, error) { + pdk.Log(pdk.LogDebug, fmt.Sprintf("GetArtistBiography: name=%s, mbid=%s", input.Name, input.MBID)) + + // 1. Get Wikipedia URL (using the logic from GetArtistURL) + wikiURL := "" + tempURL, wdErr := getWikidataWikipediaURL(input.MBID, input.Name) + if wdErr == nil && tempURL != "" { + pdk.Log(pdk.LogDebug, fmt.Sprintf("Found Wikidata URL: %s", tempURL)) + wikiURL = tempURL + } else if input.Name != "" { + pdk.Log(pdk.LogDebug, fmt.Sprintf("Wikidata URL failed (%v), trying DBpedia", wdErr)) + tempURL, dbErr := getDBpediaWikipediaURL(input.Name) + if dbErr == nil && tempURL != "" { + pdk.Log(pdk.LogDebug, fmt.Sprintf("Found DBpedia URL: %s", tempURL)) + wikiURL = tempURL + } else { + pdk.Log(pdk.LogDebug, fmt.Sprintf("DBpedia URL failed: %v", dbErr)) + } + } + + // 2. If Wikipedia URL found, try MediaWiki API + if wikiURL != "" { + pageTitle, err := extractPageTitleFromURL(wikiURL) + if err == nil { + pdk.Log(pdk.LogDebug, fmt.Sprintf("Extracted page title: %s", pageTitle)) + bio, err := getWikipediaExtract(pageTitle) + if err == nil && bio != "" { + pdk.Log(pdk.LogDebug, "Found Wikipedia extract") + return &metadata.ArtistBiographyResponse{Biography: bio}, nil + } + pdk.Log(pdk.LogDebug, fmt.Sprintf("Wikipedia extract failed: %v", err)) + } else { + pdk.Log(pdk.LogDebug, fmt.Sprintf("Error extracting page title from URL '%s': %v", wikiURL, err)) + } + } + + // 3. Fallback to DBpedia Comment (Name only) + if input.Name != "" { + pdk.Log(pdk.LogDebug, fmt.Sprintf("Falling back to DBpedia comment for name: %s", input.Name)) + bio, err := getDBpediaComment(input.Name) + if err == nil && bio != "" { + pdk.Log(pdk.LogDebug, "Found DBpedia comment") + return &metadata.ArtistBiographyResponse{Biography: bio}, nil + } + pdk.Log(pdk.LogDebug, fmt.Sprintf("DBpedia comment failed: %v", err)) + } + + pdk.Log(pdk.LogInfo, fmt.Sprintf("Biography not found for: %s (%s)", input.Name, input.MBID)) + return nil, errors.New("biography not found") +} + +// GetArtistImages returns artist images from Wikidata +func (*wikimediaPlugin) GetArtistImages(input metadata.ArtistRequest) (*metadata.ArtistImagesResponse, error) { + pdk.Log(pdk.LogDebug, fmt.Sprintf("GetArtistImages: name=%s, mbid=%s", input.Name, input.MBID)) + + var q string + if input.MBID != "" { + q = fmt.Sprintf(`SELECT ?img WHERE { ?artist wdt:P434 "%s"; wdt:P18 ?img } LIMIT 1`, input.MBID) + } else if input.Name != "" { + escapedName := strings.ReplaceAll(input.Name, "\"", "\\\"") + q = fmt.Sprintf(`SELECT ?img WHERE { ?artist rdfs:label "%s"@en; wdt:P18 ?img } LIMIT 1`, escapedName) + } else { + return nil, errors.New("MBID or Name required for Wikidata Image lookup") + } + + result, err := sparqlQuery(wikidataEndpoint, q) + if err != nil { + pdk.Log(pdk.LogInfo, fmt.Sprintf("Image not found for: %s (%s)", input.Name, input.MBID)) + return nil, errors.New("image not found") + } + if result.Results.Bindings[0].Img != nil { + return &metadata.ArtistImagesResponse{ + Images: []metadata.ImageInfo{{URL: result.Results.Bindings[0].Img.Value, Size: 0}}, + }, nil + } + + pdk.Log(pdk.LogInfo, fmt.Sprintf("Image not found for: %s (%s)", input.Name, input.MBID)) + return nil, errors.New("image not found") +} + +// Required main function - init() handles registration +func main() {} diff --git a/plugins/examples/wikimedia/manifest.json b/plugins/examples/wikimedia/manifest.json index 5d0196e0a..8590d51a8 100644 --- a/plugins/examples/wikimedia/manifest.json +++ b/plugins/examples/wikimedia/manifest.json @@ -1,20 +1,17 @@ { - "$schema": "https://raw.githubusercontent.com/navidrome/navidrome/refs/heads/master/plugins/schema/manifest.schema.json", - "name": "wikimedia", + "name": "Wikimedia", "author": "Navidrome", "version": "1.0.0", - "description": "Artist information and images from Wikimedia Commons", - "website": "https://commons.wikimedia.org", - "capabilities": ["MetadataAgent"], + "description": "Fetches artist metadata from Wikidata, DBpedia and Wikipedia", + "website": "https://navidrome.org", "permissions": { "http": { - "reason": "To fetch artist information and images from Wikimedia Commons API", - "allowedUrls": { - "https://*.wikimedia.org": ["GET"], - "https://*.wikipedia.org": ["GET"], - "https://commons.wikimedia.org": ["GET"] - }, - "allowLocalNetwork": false + "reason": "Fetch metadata from Wikimedia APIs", + "requiredHosts": [ + "query.wikidata.org", + "dbpedia.org", + "en.wikipedia.org" + ] } } } diff --git a/plugins/examples/wikimedia/plugin.go b/plugins/examples/wikimedia/plugin.go deleted file mode 100644 index 6b60e69da..000000000 --- a/plugins/examples/wikimedia/plugin.go +++ /dev/null @@ -1,391 +0,0 @@ -//go:build wasip1 - -package main - -import ( - "context" - "encoding/json" - "errors" - "fmt" - "log" - "net/url" - "strings" - - "github.com/navidrome/navidrome/plugins/api" - "github.com/navidrome/navidrome/plugins/host/http" -) - -const ( - wikidataEndpoint = "https://query.wikidata.org/sparql" - dbpediaEndpoint = "https://dbpedia.org/sparql" - mediawikiAPIEndpoint = "https://en.wikipedia.org/w/api.php" - requestTimeoutMs = 5000 -) - -var ( - ErrNotFound = api.ErrNotFound - ErrNotImplemented = api.ErrNotImplemented - - client = http.NewHttpService() -) - -// SPARQLResult struct for all possible fields -// Only the needed field will be non-nil in each context -// (Sitelink, Wiki, Comment, Img) -type SPARQLResult struct { - Results struct { - Bindings []struct { - Sitelink *struct{ Value string } `json:"sitelink,omitempty"` - Wiki *struct{ Value string } `json:"wiki,omitempty"` - Comment *struct{ Value string } `json:"comment,omitempty"` - Img *struct{ Value string } `json:"img,omitempty"` - } `json:"bindings"` - } `json:"results"` -} - -// MediaWikiExtractResult is used to unmarshal MediaWiki API extract responses -// (for getWikipediaExtract) -type MediaWikiExtractResult struct { - Query struct { - Pages map[string]struct { - PageID int `json:"pageid"` - Ns int `json:"ns"` - Title string `json:"title"` - Extract string `json:"extract"` - Missing bool `json:"missing"` - } `json:"pages"` - } `json:"query"` -} - -// --- SPARQL Query Helper --- -func sparqlQuery(ctx context.Context, client http.HttpService, endpoint, query string) (*SPARQLResult, error) { - form := url.Values{} - form.Set("query", query) - - req := &http.HttpRequest{ - Url: endpoint, - Headers: map[string]string{ - "Accept": "application/sparql-results+json", - "Content-Type": "application/x-www-form-urlencoded", // Required by SPARQL endpoints - "User-Agent": "NavidromeWikimediaPlugin/0.1", - }, - Body: []byte(form.Encode()), // Send encoded form data - TimeoutMs: requestTimeoutMs, - } - log.Printf("[Wikimedia Query] Attempting SPARQL query to %s (query length: %d):\n%s", endpoint, len(query), query) - resp, err := client.Post(ctx, req) - if err != nil { - return nil, fmt.Errorf("SPARQL request error: %w", err) - } - if resp.Status != 200 { - log.Printf("[Wikimedia Query] SPARQL HTTP error %d for query to %s. Body: %s", resp.Status, endpoint, string(resp.Body)) - return nil, fmt.Errorf("SPARQL HTTP error: status %d", resp.Status) - } - var result SPARQLResult - if err := json.Unmarshal(resp.Body, &result); err != nil { - return nil, fmt.Errorf("failed to parse SPARQL response: %w", err) - } - if len(result.Results.Bindings) == 0 { - return nil, ErrNotFound - } - return &result, nil -} - -// --- MediaWiki API Helper --- -func mediawikiQuery(ctx context.Context, client http.HttpService, params url.Values) ([]byte, error) { - apiURL := fmt.Sprintf("%s?%s", mediawikiAPIEndpoint, params.Encode()) - req := &http.HttpRequest{ - Url: apiURL, - Headers: map[string]string{ - "Accept": "application/json", - "User-Agent": "NavidromeWikimediaPlugin/0.1", - }, - TimeoutMs: requestTimeoutMs, - } - resp, err := client.Get(ctx, req) - if err != nil { - return nil, fmt.Errorf("MediaWiki request error: %w", err) - } - if resp.Status != 200 { - return nil, fmt.Errorf("MediaWiki HTTP error: status %d, body: %s", resp.Status, string(resp.Body)) - } - return resp.Body, nil -} - -// --- Wikidata Fetch Functions --- -func getWikidataWikipediaURL(ctx context.Context, client http.HttpService, mbid, name string) (string, error) { - var q string - if mbid != "" { - // Using property chain: ?sitelink schema:about ?artist; schema:isPartOf <https://en.wikipedia.org/>. - q = fmt.Sprintf(`SELECT ?sitelink WHERE { ?artist wdt:P434 "%s". ?sitelink schema:about ?artist; schema:isPartOf <https://en.wikipedia.org/>. } LIMIT 1`, mbid) - } else if name != "" { - escapedName := strings.ReplaceAll(name, "\"", "\\\"") - // Using property chain: ?sitelink schema:about ?artist; schema:isPartOf <https://en.wikipedia.org/>. - q = fmt.Sprintf(`SELECT ?sitelink WHERE { ?artist rdfs:label "%s"@en. ?sitelink schema:about ?artist; schema:isPartOf <https://en.wikipedia.org/>. } LIMIT 1`, escapedName) - } else { - return "", errors.New("MBID or Name required for Wikidata URL lookup") - } - - result, err := sparqlQuery(ctx, client, wikidataEndpoint, q) - if err != nil { - return "", fmt.Errorf("Wikidata SPARQL query failed: %w", err) - } - if result.Results.Bindings[0].Sitelink != nil { - return result.Results.Bindings[0].Sitelink.Value, nil - } - return "", ErrNotFound -} - -// --- DBpedia Fetch Functions --- -func getDBpediaWikipediaURL(ctx context.Context, client http.HttpService, name string) (string, error) { - if name == "" { - return "", ErrNotFound - } - escapedName := strings.ReplaceAll(name, "\"", "\\\"") - q := fmt.Sprintf(`SELECT ?wiki WHERE { ?artist foaf:name "%s"@en; foaf:isPrimaryTopicOf ?wiki. FILTER regex(str(?wiki), "^https://en.wikipedia.org/") } LIMIT 1`, escapedName) - result, err := sparqlQuery(ctx, client, dbpediaEndpoint, q) - if err != nil { - return "", fmt.Errorf("DBpedia SPARQL query failed: %w", err) - } - if result.Results.Bindings[0].Wiki != nil { - return result.Results.Bindings[0].Wiki.Value, nil - } - return "", ErrNotFound -} - -func getDBpediaComment(ctx context.Context, client http.HttpService, name string) (string, error) { - if name == "" { - return "", ErrNotFound - } - escapedName := strings.ReplaceAll(name, "\"", "\\\"") - q := fmt.Sprintf(`SELECT ?comment WHERE { ?artist foaf:name "%s"@en; rdfs:comment ?comment. FILTER (lang(?comment) = 'en') } LIMIT 1`, escapedName) - result, err := sparqlQuery(ctx, client, dbpediaEndpoint, q) - if err != nil { - return "", fmt.Errorf("DBpedia comment SPARQL query failed: %w", err) - } - if result.Results.Bindings[0].Comment != nil { - return result.Results.Bindings[0].Comment.Value, nil - } - return "", ErrNotFound -} - -// --- Wikipedia API Fetch Function --- -func getWikipediaExtract(ctx context.Context, client http.HttpService, pageTitle string) (string, error) { - if pageTitle == "" { - return "", errors.New("page title required for Wikipedia API lookup") - } - params := url.Values{} - params.Set("action", "query") - params.Set("format", "json") - params.Set("prop", "extracts") - params.Set("exintro", "true") // Intro section only - params.Set("explaintext", "true") // Plain text - params.Set("titles", pageTitle) - params.Set("redirects", "1") // Follow redirects - - body, err := mediawikiQuery(ctx, client, params) - if err != nil { - return "", fmt.Errorf("MediaWiki query failed: %w", err) - } - - var result MediaWikiExtractResult - if err := json.Unmarshal(body, &result); err != nil { - return "", fmt.Errorf("failed to parse MediaWiki response: %w", err) - } - - // Iterate through the pages map (usually only one page) - for _, page := range result.Query.Pages { - if page.Missing { - continue // Skip missing pages - } - if page.Extract != "" { - return strings.TrimSpace(page.Extract), nil - } - } - - return "", ErrNotFound -} - -// --- Helper to get Wikipedia Page Title from URL --- -func extractPageTitleFromURL(wikiURL string) (string, error) { - parsedURL, err := url.Parse(wikiURL) - if err != nil { - return "", err - } - if parsedURL.Host != "en.wikipedia.org" { - return "", fmt.Errorf("URL host is not en.wikipedia.org: %s", parsedURL.Host) - } - pathParts := strings.Split(strings.TrimPrefix(parsedURL.Path, "/"), "/") - if len(pathParts) < 2 || pathParts[0] != "wiki" { - return "", fmt.Errorf("URL path does not match /wiki/<title> format: %s", parsedURL.Path) - } - title := pathParts[1] - if title == "" { - return "", errors.New("extracted title is empty") - } - decodedTitle, err := url.PathUnescape(title) - if err != nil { - return "", fmt.Errorf("failed to decode title '%s': %w", title, err) - } - return decodedTitle, nil -} - -// --- Agent Implementation --- -type WikimediaAgent struct{} - -// GetArtistURL fetches the Wikipedia URL. -// Order: Wikidata(MBID/Name) -> DBpedia(Name) -> Search URL -func (WikimediaAgent) GetArtistURL(ctx context.Context, req *api.ArtistURLRequest) (*api.ArtistURLResponse, error) { - var wikiURL string - var err error - - // 1. Try Wikidata (MBID first, then name) - wikiURL, err = getWikidataWikipediaURL(ctx, client, req.Mbid, req.Name) - if err == nil && wikiURL != "" { - return &api.ArtistURLResponse{Url: wikiURL}, nil - } - if err != nil && err != ErrNotFound { - log.Printf("[Wikimedia] Error fetching Wikidata URL: %v\n", err) - // Don't stop, try DBpedia - } - - // 2. Try DBpedia (Name only) - if req.Name != "" { - wikiURL, err = getDBpediaWikipediaURL(ctx, client, req.Name) - if err == nil && wikiURL != "" { - return &api.ArtistURLResponse{Url: wikiURL}, nil - } - if err != nil && err != ErrNotFound { - log.Printf("[Wikimedia] Error fetching DBpedia URL: %v\n", err) - // Don't stop, generate search URL - } - } - - // 3. Fallback to search URL - if req.Name != "" { - searchURL := fmt.Sprintf("https://en.wikipedia.org/w/index.php?search=%s", url.QueryEscape(req.Name)) - log.Printf("[Wikimedia] URL not found, falling back to search URL: %s\n", searchURL) - return &api.ArtistURLResponse{Url: searchURL}, nil - } - - log.Printf("[Wikimedia] Could not determine Wikipedia URL for: %s (%s)\n", req.Name, req.Mbid) - return nil, ErrNotFound -} - -// GetArtistBiography fetches the long biography. -// Order: Wikipedia API (via Wikidata/DBpedia URL) -> DBpedia Comment (Name) -func (WikimediaAgent) GetArtistBiography(ctx context.Context, req *api.ArtistBiographyRequest) (*api.ArtistBiographyResponse, error) { - var bio string - var err error - - log.Printf("[Wikimedia Bio] Fetching for Name: %s, MBID: %s", req.Name, req.Mbid) - - // 1. Get Wikipedia URL (using the logic from GetArtistURL) - wikiURL := "" - // Try Wikidata first - tempURL, wdErr := getWikidataWikipediaURL(ctx, client, req.Mbid, req.Name) - if wdErr == nil && tempURL != "" { - log.Printf("[Wikimedia Bio] Found Wikidata URL: %s", tempURL) - wikiURL = tempURL - } else if req.Name != "" { - // Try DBpedia if Wikidata failed or returned not found - log.Printf("[Wikimedia Bio] Wikidata URL failed (%v), trying DBpedia URL", wdErr) - tempURL, dbErr := getDBpediaWikipediaURL(ctx, client, req.Name) - if dbErr == nil && tempURL != "" { - log.Printf("[Wikimedia Bio] Found DBpedia URL: %s", tempURL) - wikiURL = tempURL - } else { - log.Printf("[Wikimedia Bio] DBpedia URL failed (%v)", dbErr) - } - } - - // 2. If Wikipedia URL found, try MediaWiki API - if wikiURL != "" { - pageTitle, err := extractPageTitleFromURL(wikiURL) - if err == nil { - log.Printf("[Wikimedia Bio] Extracted page title: %s", pageTitle) - bio, err = getWikipediaExtract(ctx, client, pageTitle) - if err == nil && bio != "" { - log.Printf("[Wikimedia Bio] Found Wikipedia extract.") - return &api.ArtistBiographyResponse{Biography: bio}, nil - } - log.Printf("[Wikimedia Bio] Wikipedia extract failed: %v", err) - if err != nil && err != ErrNotFound { - log.Printf("[Wikimedia Bio] Error fetching Wikipedia extract for '%s': %v", pageTitle, err) - // Don't stop, try DBpedia comment - } - } else { - log.Printf("[Wikimedia Bio] Error extracting page title from URL '%s': %v", wikiURL, err) - // Don't stop, try DBpedia comment - } - } - - // 3. Fallback to DBpedia Comment (Name only) - if req.Name != "" { - log.Printf("[Wikimedia Bio] Falling back to DBpedia comment for name: %s", req.Name) - bio, err = getDBpediaComment(ctx, client, req.Name) - if err == nil && bio != "" { - log.Printf("[Wikimedia Bio] Found DBpedia comment.") - return &api.ArtistBiographyResponse{Biography: bio}, nil - } - log.Printf("[Wikimedia Bio] DBpedia comment failed: %v", err) - if err != nil && err != ErrNotFound { - log.Printf("[Wikimedia Bio] Error fetching DBpedia comment for '%s': %v", req.Name, err) - } - } - - log.Printf("[Wikimedia Bio] Final: Biography not found for: %s (%s)", req.Name, req.Mbid) - return nil, ErrNotFound -} - -// GetArtistImages fetches images (Wikidata only for now) -func (WikimediaAgent) GetArtistImages(ctx context.Context, req *api.ArtistImageRequest) (*api.ArtistImageResponse, error) { - var q string - if req.Mbid != "" { - q = fmt.Sprintf(`SELECT ?img WHERE { ?artist wdt:P434 "%s"; wdt:P18 ?img } LIMIT 1`, req.Mbid) - } else if req.Name != "" { - escapedName := strings.ReplaceAll(req.Name, "\"", "\\\"") - q = fmt.Sprintf(`SELECT ?img WHERE { ?artist rdfs:label "%s"@en; wdt:P18 ?img } LIMIT 1`, escapedName) - } else { - return nil, errors.New("MBID or Name required for Wikidata Image lookup") - } - - result, err := sparqlQuery(ctx, client, wikidataEndpoint, q) - if err != nil { - log.Printf("[Wikimedia] Image not found for: %s (%s)\n", req.Name, req.Mbid) - return nil, ErrNotFound - } - if result.Results.Bindings[0].Img != nil { - return &api.ArtistImageResponse{Images: []*api.ExternalImage{{Url: result.Results.Bindings[0].Img.Value, Size: 0}}}, nil - } - log.Printf("[Wikimedia] Image not found for: %s (%s)\n", req.Name, req.Mbid) - return nil, ErrNotFound -} - -// Not implemented methods -func (WikimediaAgent) GetArtistMBID(context.Context, *api.ArtistMBIDRequest) (*api.ArtistMBIDResponse, error) { - return nil, ErrNotImplemented -} -func (WikimediaAgent) GetSimilarArtists(context.Context, *api.ArtistSimilarRequest) (*api.ArtistSimilarResponse, error) { - return nil, ErrNotImplemented -} -func (WikimediaAgent) GetArtistTopSongs(context.Context, *api.ArtistTopSongsRequest) (*api.ArtistTopSongsResponse, error) { - return nil, ErrNotImplemented -} -func (WikimediaAgent) GetAlbumInfo(context.Context, *api.AlbumInfoRequest) (*api.AlbumInfoResponse, error) { - return nil, ErrNotImplemented -} - -func (WikimediaAgent) GetAlbumImages(context.Context, *api.AlbumImagesRequest) (*api.AlbumImagesResponse, error) { - return nil, ErrNotImplemented -} - -func main() {} - -func init() { - // Configure logging: No timestamps, no source file/line - log.SetFlags(0) - log.SetPrefix("[Wikimedia] ") - - api.RegisterMetadataAgent(WikimediaAgent{}) -} diff --git a/plugins/examples/wikimedia/prepare.sh b/plugins/examples/wikimedia/prepare.sh new file mode 100644 index 000000000..9fbb93cfb --- /dev/null +++ b/plugins/examples/wikimedia/prepare.sh @@ -0,0 +1,92 @@ +#!/bin/bash +set -eou pipefail + +# Function to check if a command exists +command_exists () { + command -v "$1" >/dev/null 2>&1 +} + +# Function to compare version numbers for "less than" +version_lt() { + test "$(echo "$@" | tr " " "\n" | sort -V | head -n 1)" = "$1" && test "$1" != "$2" +} + +missing_deps=0 + +# Check for Go +if ! (command_exists go); then + missing_deps=1 + echo "❌ Go (supported version between 1.20 - 1.24) is not installed." + echo "" + echo "To install Go, visit the official download page:" + echo "👉 https://go.dev/dl/" + echo "" + echo "Or install it using a package manager:" + echo "" + echo "🔹 macOS (Homebrew):" + echo " brew install go" + echo "" + echo "🔹 Ubuntu/Debian:" + echo " sudo apt-get -y install golang-go" + echo "" + echo "🔹 Arch Linux:" + echo " sudo pacman -S go" + echo "" + echo "🔹 Windows:" + echo " scoop install go" + echo "" +fi + +# Check for the right version of Go, needed by TinyGo (supports go 1.20 - 1.24) +if (command_exists go); then + compat=0 + for v in `seq 20 24`; do + if (go version | grep -q "go1.$v"); then + compat=1 + fi + done + + if [ $compat -eq 0 ]; then + echo "❌ Supported Go version is not installed. Must be Go 1.20 - 1.24." + echo "" + fi +fi + +ARCH=$(arch) + +# Check for TinyGo and its version +if ! (command_exists tinygo); then + missing_deps=1 + echo "❌ TinyGo is not installed." + echo "" + echo "To install TinyGo, visit the official download page:" + echo "👉 https://tinygo.org/getting-started/install/" + echo "" + echo "Or install it using a package manager:" + echo "" + echo "🔹 macOS (Homebrew):" + echo " brew tap tinygo-org/tools" + echo " brew install tinygo" + echo "" + echo "🔹 Ubuntu/Debian:" + echo " wget https://github.com/tinygo-org/tinygo/releases/download/v0.34.0/tinygo_0.34.0_$ARCH.deb" + echo " sudo dpkg -i tinygo_0.34.0_$ARCH.deb" + echo "" + echo "🔹 Arch Linux:" + echo " pacman -S extra/tinygo" + echo "" + echo "🔹 Windows:" + echo " scoop install tinygo" + echo "" +else + # Check TinyGo version + tinygo_version=$(tinygo version | grep -o '[0-9]\+\.[0-9]\+\.[0-9]\+' | head -n1) + if version_lt "$tinygo_version" "0.34.0"; then + missing_deps=1 + echo "❌ TinyGo version must be >= 0.34.0 (current version: $tinygo_version)" + echo "Please update TinyGo to a newer version." + echo "" + fi +fi + +go install golang.org/x/tools/cmd/goimports@latest diff --git a/plugins/examples/wikimedia/xtp.toml b/plugins/examples/wikimedia/xtp.toml new file mode 100755 index 000000000..73000ebcd --- /dev/null +++ b/plugins/examples/wikimedia/xtp.toml @@ -0,0 +1,17 @@ +app_id = "" + +# This is where 'xtp plugin push' expects to find the wasm file after the build script has run. +bin = "dist/plugin.wasm" +extension_point_id = "" +name = "wikimedia-plugin" + +[scripts] + + # xtp plugin build runs this script to generate the wasm file + build = "mkdir -p dist && tinygo build -buildmode c-shared -target wasip1 -o dist/plugin.wasm ." + + # xtp plugin init runs this script to format the plugin code + format = "go fmt && go mod tidy && goimports -w main.go" + + # xtp plugin init runs this script before running the format script + prepare = "bash prepare.sh && go get ./..." diff --git a/plugins/host/artwork.go b/plugins/host/artwork.go new file mode 100644 index 000000000..9b9d3e98e --- /dev/null +++ b/plugins/host/artwork.go @@ -0,0 +1,53 @@ +package host + +import "context" + +// ArtworkService provides artwork public URL generation capabilities for plugins. +// +// This service allows plugins to generate public URLs for artwork images of +// various entity types (artists, albums, tracks, playlists). The generated URLs +// include authentication tokens and can be used to display artwork in external +// services or custom UIs. +// +//nd:hostservice name=Artwork permission=artwork +type ArtworkService interface { + // GetArtistUrl generates a public URL for an artist's artwork. + // + // Parameters: + // - id: The artist's unique identifier + // - size: Desired image size in pixels (0 for original size) + // + // Returns the public URL for the artwork, or an error if generation fails. + //nd:hostfunc + GetArtistUrl(ctx context.Context, id string, size int32) (url string, err error) + + // GetAlbumUrl generates a public URL for an album's artwork. + // + // Parameters: + // - id: The album's unique identifier + // - size: Desired image size in pixels (0 for original size) + // + // Returns the public URL for the artwork, or an error if generation fails. + //nd:hostfunc + GetAlbumUrl(ctx context.Context, id string, size int32) (url string, err error) + + // GetTrackUrl generates a public URL for a track's artwork. + // + // Parameters: + // - id: The track's (media file) unique identifier + // - size: Desired image size in pixels (0 for original size) + // + // Returns the public URL for the artwork, or an error if generation fails. + //nd:hostfunc + GetTrackUrl(ctx context.Context, id string, size int32) (url string, err error) + + // GetPlaylistUrl generates a public URL for a playlist's artwork. + // + // Parameters: + // - id: The playlist's unique identifier + // - size: Desired image size in pixels (0 for original size) + // + // Returns the public URL for the artwork, or an error if generation fails. + //nd:hostfunc + GetPlaylistUrl(ctx context.Context, id string, size int32) (url string, err error) +} diff --git a/plugins/host/artwork/artwork.pb.go b/plugins/host/artwork/artwork.pb.go deleted file mode 100644 index 228eced22..000000000 --- a/plugins/host/artwork/artwork.pb.go +++ /dev/null @@ -1,73 +0,0 @@ -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: host/artwork/artwork.proto - -package artwork - -import ( - context "context" - protoreflect "google.golang.org/protobuf/reflect/protoreflect" - protoimpl "google.golang.org/protobuf/runtime/protoimpl" -) - -const ( - // Verify that this generated code is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion) - // Verify that runtime/protoimpl is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) -) - -type GetArtworkUrlRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` - Size int32 `protobuf:"varint,2,opt,name=size,proto3" json:"size,omitempty"` // Optional, 0 means original size -} - -func (x *GetArtworkUrlRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *GetArtworkUrlRequest) GetId() string { - if x != nil { - return x.Id - } - return "" -} - -func (x *GetArtworkUrlRequest) GetSize() int32 { - if x != nil { - return x.Size - } - return 0 -} - -type GetArtworkUrlResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"` -} - -func (x *GetArtworkUrlResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *GetArtworkUrlResponse) GetUrl() string { - if x != nil { - return x.Url - } - return "" -} - -// go:plugin type=host version=1 -type ArtworkService interface { - GetArtistUrl(context.Context, *GetArtworkUrlRequest) (*GetArtworkUrlResponse, error) - GetAlbumUrl(context.Context, *GetArtworkUrlRequest) (*GetArtworkUrlResponse, error) - GetTrackUrl(context.Context, *GetArtworkUrlRequest) (*GetArtworkUrlResponse, error) -} diff --git a/plugins/host/artwork/artwork.proto b/plugins/host/artwork/artwork.proto deleted file mode 100644 index cb562e536..000000000 --- a/plugins/host/artwork/artwork.proto +++ /dev/null @@ -1,21 +0,0 @@ -syntax = "proto3"; - -package artwork; - -option go_package = "github.com/navidrome/navidrome/plugins/host/artwork;artwork"; - -// go:plugin type=host version=1 -service ArtworkService { - rpc GetArtistUrl(GetArtworkUrlRequest) returns (GetArtworkUrlResponse); - rpc GetAlbumUrl(GetArtworkUrlRequest) returns (GetArtworkUrlResponse); - rpc GetTrackUrl(GetArtworkUrlRequest) returns (GetArtworkUrlResponse); -} - -message GetArtworkUrlRequest { - string id = 1; - int32 size = 2; // Optional, 0 means original size -} - -message GetArtworkUrlResponse { - string url = 1; -} \ No newline at end of file diff --git a/plugins/host/artwork/artwork_host.pb.go b/plugins/host/artwork/artwork_host.pb.go deleted file mode 100644 index 346fe1449..000000000 --- a/plugins/host/artwork/artwork_host.pb.go +++ /dev/null @@ -1,130 +0,0 @@ -//go:build !wasip1 - -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: host/artwork/artwork.proto - -package artwork - -import ( - context "context" - wasm "github.com/knqyf263/go-plugin/wasm" - wazero "github.com/tetratelabs/wazero" - api "github.com/tetratelabs/wazero/api" -) - -const ( - i32 = api.ValueTypeI32 - i64 = api.ValueTypeI64 -) - -type _artworkService struct { - ArtworkService -} - -// Instantiate a Go-defined module named "env" that exports host functions. -func Instantiate(ctx context.Context, r wazero.Runtime, hostFunctions ArtworkService) error { - envBuilder := r.NewHostModuleBuilder("env") - h := _artworkService{hostFunctions} - - envBuilder.NewFunctionBuilder(). - WithGoModuleFunction(api.GoModuleFunc(h._GetArtistUrl), []api.ValueType{i32, i32}, []api.ValueType{i64}). - WithParameterNames("offset", "size"). - Export("get_artist_url") - - envBuilder.NewFunctionBuilder(). - WithGoModuleFunction(api.GoModuleFunc(h._GetAlbumUrl), []api.ValueType{i32, i32}, []api.ValueType{i64}). - WithParameterNames("offset", "size"). - Export("get_album_url") - - envBuilder.NewFunctionBuilder(). - WithGoModuleFunction(api.GoModuleFunc(h._GetTrackUrl), []api.ValueType{i32, i32}, []api.ValueType{i64}). - WithParameterNames("offset", "size"). - Export("get_track_url") - - _, err := envBuilder.Instantiate(ctx) - return err -} - -func (h _artworkService) _GetArtistUrl(ctx context.Context, m api.Module, stack []uint64) { - offset, size := uint32(stack[0]), uint32(stack[1]) - buf, err := wasm.ReadMemory(m.Memory(), offset, size) - if err != nil { - panic(err) - } - request := new(GetArtworkUrlRequest) - err = request.UnmarshalVT(buf) - if err != nil { - panic(err) - } - resp, err := h.GetArtistUrl(ctx, request) - if err != nil { - panic(err) - } - buf, err = resp.MarshalVT() - if err != nil { - panic(err) - } - ptr, err := wasm.WriteMemory(ctx, m, buf) - if err != nil { - panic(err) - } - ptrLen := (ptr << uint64(32)) | uint64(len(buf)) - stack[0] = ptrLen -} - -func (h _artworkService) _GetAlbumUrl(ctx context.Context, m api.Module, stack []uint64) { - offset, size := uint32(stack[0]), uint32(stack[1]) - buf, err := wasm.ReadMemory(m.Memory(), offset, size) - if err != nil { - panic(err) - } - request := new(GetArtworkUrlRequest) - err = request.UnmarshalVT(buf) - if err != nil { - panic(err) - } - resp, err := h.GetAlbumUrl(ctx, request) - if err != nil { - panic(err) - } - buf, err = resp.MarshalVT() - if err != nil { - panic(err) - } - ptr, err := wasm.WriteMemory(ctx, m, buf) - if err != nil { - panic(err) - } - ptrLen := (ptr << uint64(32)) | uint64(len(buf)) - stack[0] = ptrLen -} - -func (h _artworkService) _GetTrackUrl(ctx context.Context, m api.Module, stack []uint64) { - offset, size := uint32(stack[0]), uint32(stack[1]) - buf, err := wasm.ReadMemory(m.Memory(), offset, size) - if err != nil { - panic(err) - } - request := new(GetArtworkUrlRequest) - err = request.UnmarshalVT(buf) - if err != nil { - panic(err) - } - resp, err := h.GetTrackUrl(ctx, request) - if err != nil { - panic(err) - } - buf, err = resp.MarshalVT() - if err != nil { - panic(err) - } - ptr, err := wasm.WriteMemory(ctx, m, buf) - if err != nil { - panic(err) - } - ptrLen := (ptr << uint64(32)) | uint64(len(buf)) - stack[0] = ptrLen -} diff --git a/plugins/host/artwork/artwork_plugin.pb.go b/plugins/host/artwork/artwork_plugin.pb.go deleted file mode 100644 index f54aac0b9..000000000 --- a/plugins/host/artwork/artwork_plugin.pb.go +++ /dev/null @@ -1,90 +0,0 @@ -//go:build wasip1 - -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: host/artwork/artwork.proto - -package artwork - -import ( - context "context" - wasm "github.com/knqyf263/go-plugin/wasm" - _ "unsafe" -) - -type artworkService struct{} - -func NewArtworkService() ArtworkService { - return artworkService{} -} - -//go:wasmimport env get_artist_url -func _get_artist_url(ptr uint32, size uint32) uint64 - -func (h artworkService) GetArtistUrl(ctx context.Context, request *GetArtworkUrlRequest) (*GetArtworkUrlResponse, error) { - buf, err := request.MarshalVT() - if err != nil { - return nil, err - } - ptr, size := wasm.ByteToPtr(buf) - ptrSize := _get_artist_url(ptr, size) - wasm.Free(ptr) - - ptr = uint32(ptrSize >> 32) - size = uint32(ptrSize) - buf = wasm.PtrToByte(ptr, size) - - response := new(GetArtworkUrlResponse) - if err = response.UnmarshalVT(buf); err != nil { - return nil, err - } - return response, nil -} - -//go:wasmimport env get_album_url -func _get_album_url(ptr uint32, size uint32) uint64 - -func (h artworkService) GetAlbumUrl(ctx context.Context, request *GetArtworkUrlRequest) (*GetArtworkUrlResponse, error) { - buf, err := request.MarshalVT() - if err != nil { - return nil, err - } - ptr, size := wasm.ByteToPtr(buf) - ptrSize := _get_album_url(ptr, size) - wasm.Free(ptr) - - ptr = uint32(ptrSize >> 32) - size = uint32(ptrSize) - buf = wasm.PtrToByte(ptr, size) - - response := new(GetArtworkUrlResponse) - if err = response.UnmarshalVT(buf); err != nil { - return nil, err - } - return response, nil -} - -//go:wasmimport env get_track_url -func _get_track_url(ptr uint32, size uint32) uint64 - -func (h artworkService) GetTrackUrl(ctx context.Context, request *GetArtworkUrlRequest) (*GetArtworkUrlResponse, error) { - buf, err := request.MarshalVT() - if err != nil { - return nil, err - } - ptr, size := wasm.ByteToPtr(buf) - ptrSize := _get_track_url(ptr, size) - wasm.Free(ptr) - - ptr = uint32(ptrSize >> 32) - size = uint32(ptrSize) - buf = wasm.PtrToByte(ptr, size) - - response := new(GetArtworkUrlResponse) - if err = response.UnmarshalVT(buf); err != nil { - return nil, err - } - return response, nil -} diff --git a/plugins/host/artwork/artwork_plugin_dev.go b/plugins/host/artwork/artwork_plugin_dev.go deleted file mode 100644 index 0071f5726..000000000 --- a/plugins/host/artwork/artwork_plugin_dev.go +++ /dev/null @@ -1,7 +0,0 @@ -//go:build !wasip1 - -package artwork - -func NewArtworkService() ArtworkService { - panic("not implemented") -} diff --git a/plugins/host/artwork/artwork_vtproto.pb.go b/plugins/host/artwork/artwork_vtproto.pb.go deleted file mode 100644 index 6a1c0ba4e..000000000 --- a/plugins/host/artwork/artwork_vtproto.pb.go +++ /dev/null @@ -1,425 +0,0 @@ -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: host/artwork/artwork.proto - -package artwork - -import ( - fmt "fmt" - protoimpl "google.golang.org/protobuf/runtime/protoimpl" - io "io" - bits "math/bits" -) - -const ( - // Verify that this generated code is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion) - // Verify that runtime/protoimpl is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) -) - -func (m *GetArtworkUrlRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *GetArtworkUrlRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *GetArtworkUrlRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if m.Size != 0 { - i = encodeVarint(dAtA, i, uint64(m.Size)) - i-- - dAtA[i] = 0x10 - } - if len(m.Id) > 0 { - i -= len(m.Id) - copy(dAtA[i:], m.Id) - i = encodeVarint(dAtA, i, uint64(len(m.Id))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *GetArtworkUrlResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *GetArtworkUrlResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *GetArtworkUrlResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Url) > 0 { - i -= len(m.Url) - copy(dAtA[i:], m.Url) - i = encodeVarint(dAtA, i, uint64(len(m.Url))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func encodeVarint(dAtA []byte, offset int, v uint64) int { - offset -= sov(v) - base := offset - for v >= 1<<7 { - dAtA[offset] = uint8(v&0x7f | 0x80) - v >>= 7 - offset++ - } - dAtA[offset] = uint8(v) - return base -} -func (m *GetArtworkUrlRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Id) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - if m.Size != 0 { - n += 1 + sov(uint64(m.Size)) - } - n += len(m.unknownFields) - return n -} - -func (m *GetArtworkUrlResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Url) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func sov(x uint64) (n int) { - return (bits.Len64(x|1) + 6) / 7 -} -func soz(x uint64) (n int) { - return sov(uint64((x << 1) ^ uint64((int64(x) >> 63)))) -} -func (m *GetArtworkUrlRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: GetArtworkUrlRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: GetArtworkUrlRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Id", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Id = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 0 { - return fmt.Errorf("proto: wrong wireType = %d for field Size", wireType) - } - m.Size = 0 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - m.Size |= int32(b&0x7F) << shift - if b < 0x80 { - break - } - } - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *GetArtworkUrlResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: GetArtworkUrlResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: GetArtworkUrlResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Url", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Url = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} - -func skip(dAtA []byte) (n int, err error) { - l := len(dAtA) - iNdEx := 0 - depth := 0 - for iNdEx < l { - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return 0, ErrIntOverflow - } - if iNdEx >= l { - return 0, io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= (uint64(b) & 0x7F) << shift - if b < 0x80 { - break - } - } - wireType := int(wire & 0x7) - switch wireType { - case 0: - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return 0, ErrIntOverflow - } - if iNdEx >= l { - return 0, io.ErrUnexpectedEOF - } - iNdEx++ - if dAtA[iNdEx-1] < 0x80 { - break - } - } - case 1: - iNdEx += 8 - case 2: - var length int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return 0, ErrIntOverflow - } - if iNdEx >= l { - return 0, io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - length |= (int(b) & 0x7F) << shift - if b < 0x80 { - break - } - } - if length < 0 { - return 0, ErrInvalidLength - } - iNdEx += length - case 3: - depth++ - case 4: - if depth == 0 { - return 0, ErrUnexpectedEndOfGroup - } - depth-- - case 5: - iNdEx += 4 - default: - return 0, fmt.Errorf("proto: illegal wireType %d", wireType) - } - if iNdEx < 0 { - return 0, ErrInvalidLength - } - if depth == 0 { - return iNdEx, nil - } - } - return 0, io.ErrUnexpectedEOF -} - -var ( - ErrInvalidLength = fmt.Errorf("proto: negative length found during unmarshaling") - ErrIntOverflow = fmt.Errorf("proto: integer overflow") - ErrUnexpectedEndOfGroup = fmt.Errorf("proto: unexpected end of group") -) diff --git a/plugins/host/artwork_gen.go b/plugins/host/artwork_gen.go new file mode 100644 index 000000000..fbf807351 --- /dev/null +++ b/plugins/host/artwork_gen.go @@ -0,0 +1,230 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package host + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// ArtworkGetArtistUrlRequest is the request type for Artwork.GetArtistUrl. +type ArtworkGetArtistUrlRequest struct { + Id string `json:"id"` + Size int32 `json:"size"` +} + +// ArtworkGetArtistUrlResponse is the response type for Artwork.GetArtistUrl. +type ArtworkGetArtistUrlResponse struct { + Url string `json:"url,omitempty"` + Error string `json:"error,omitempty"` +} + +// ArtworkGetAlbumUrlRequest is the request type for Artwork.GetAlbumUrl. +type ArtworkGetAlbumUrlRequest struct { + Id string `json:"id"` + Size int32 `json:"size"` +} + +// ArtworkGetAlbumUrlResponse is the response type for Artwork.GetAlbumUrl. +type ArtworkGetAlbumUrlResponse struct { + Url string `json:"url,omitempty"` + Error string `json:"error,omitempty"` +} + +// ArtworkGetTrackUrlRequest is the request type for Artwork.GetTrackUrl. +type ArtworkGetTrackUrlRequest struct { + Id string `json:"id"` + Size int32 `json:"size"` +} + +// ArtworkGetTrackUrlResponse is the response type for Artwork.GetTrackUrl. +type ArtworkGetTrackUrlResponse struct { + Url string `json:"url,omitempty"` + Error string `json:"error,omitempty"` +} + +// ArtworkGetPlaylistUrlRequest is the request type for Artwork.GetPlaylistUrl. +type ArtworkGetPlaylistUrlRequest struct { + Id string `json:"id"` + Size int32 `json:"size"` +} + +// ArtworkGetPlaylistUrlResponse is the response type for Artwork.GetPlaylistUrl. +type ArtworkGetPlaylistUrlResponse struct { + Url string `json:"url,omitempty"` + Error string `json:"error,omitempty"` +} + +// RegisterArtworkHostFunctions registers Artwork service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterArtworkHostFunctions(service ArtworkService) []extism.HostFunction { + return []extism.HostFunction{ + newArtworkGetArtistUrlHostFunction(service), + newArtworkGetAlbumUrlHostFunction(service), + newArtworkGetTrackUrlHostFunction(service), + newArtworkGetPlaylistUrlHostFunction(service), + } +} + +func newArtworkGetArtistUrlHostFunction(service ArtworkService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "artwork_getartisturl", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + artworkWriteError(p, stack, err) + return + } + var req ArtworkGetArtistUrlRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + artworkWriteError(p, stack, err) + return + } + + // Call the service method + url, svcErr := service.GetArtistUrl(ctx, req.Id, req.Size) + if svcErr != nil { + artworkWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := ArtworkGetArtistUrlResponse{ + Url: url, + } + artworkWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newArtworkGetAlbumUrlHostFunction(service ArtworkService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "artwork_getalbumurl", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + artworkWriteError(p, stack, err) + return + } + var req ArtworkGetAlbumUrlRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + artworkWriteError(p, stack, err) + return + } + + // Call the service method + url, svcErr := service.GetAlbumUrl(ctx, req.Id, req.Size) + if svcErr != nil { + artworkWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := ArtworkGetAlbumUrlResponse{ + Url: url, + } + artworkWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newArtworkGetTrackUrlHostFunction(service ArtworkService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "artwork_gettrackurl", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + artworkWriteError(p, stack, err) + return + } + var req ArtworkGetTrackUrlRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + artworkWriteError(p, stack, err) + return + } + + // Call the service method + url, svcErr := service.GetTrackUrl(ctx, req.Id, req.Size) + if svcErr != nil { + artworkWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := ArtworkGetTrackUrlResponse{ + Url: url, + } + artworkWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newArtworkGetPlaylistUrlHostFunction(service ArtworkService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "artwork_getplaylisturl", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + artworkWriteError(p, stack, err) + return + } + var req ArtworkGetPlaylistUrlRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + artworkWriteError(p, stack, err) + return + } + + // Call the service method + url, svcErr := service.GetPlaylistUrl(ctx, req.Id, req.Size) + if svcErr != nil { + artworkWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := ArtworkGetPlaylistUrlResponse{ + Url: url, + } + artworkWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// artworkWriteResponse writes a JSON response to plugin memory. +func artworkWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + artworkWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// artworkWriteError writes an error response to plugin memory. +func artworkWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/host/cache.go b/plugins/host/cache.go new file mode 100644 index 000000000..37cb4da74 --- /dev/null +++ b/plugins/host/cache.go @@ -0,0 +1,117 @@ +package host + +import "context" + +// CacheService provides in-memory TTL-based caching capabilities for plugins. +// +// This service allows plugins to store and retrieve typed values (strings, integers, +// floats, and byte slices) with configurable time-to-live expiration. Each plugin's +// cache keys are automatically namespaced to prevent collisions between plugins. +// +// The cache is in-memory only and will be lost on server restart. Plugins should +// handle cache misses gracefully. +// +//nd:hostservice name=Cache permission=cache +type CacheService interface { + // SetString stores a string value in the cache. + // + // Parameters: + // - key: The cache key (will be namespaced with plugin ID) + // - value: The string value to store + // - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) + // + // Returns an error if the operation fails. + //nd:hostfunc + SetString(ctx context.Context, key string, value string, ttlSeconds int64) error + + // GetString retrieves a string value from the cache. + // + // Parameters: + // - key: The cache key (will be namespaced with plugin ID) + // + // Returns the value and whether the key exists. If the key doesn't exist + // or the stored value is not a string, exists will be false. + //nd:hostfunc + GetString(ctx context.Context, key string) (value string, exists bool, err error) + + // SetInt stores an integer value in the cache. + // + // Parameters: + // - key: The cache key (will be namespaced with plugin ID) + // - value: The integer value to store + // - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) + // + // Returns an error if the operation fails. + //nd:hostfunc + SetInt(ctx context.Context, key string, value int64, ttlSeconds int64) error + + // GetInt retrieves an integer value from the cache. + // + // Parameters: + // - key: The cache key (will be namespaced with plugin ID) + // + // Returns the value and whether the key exists. If the key doesn't exist + // or the stored value is not an integer, exists will be false. + //nd:hostfunc + GetInt(ctx context.Context, key string) (value int64, exists bool, err error) + + // SetFloat stores a float value in the cache. + // + // Parameters: + // - key: The cache key (will be namespaced with plugin ID) + // - value: The float value to store + // - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) + // + // Returns an error if the operation fails. + //nd:hostfunc + SetFloat(ctx context.Context, key string, value float64, ttlSeconds int64) error + + // GetFloat retrieves a float value from the cache. + // + // Parameters: + // - key: The cache key (will be namespaced with plugin ID) + // + // Returns the value and whether the key exists. If the key doesn't exist + // or the stored value is not a float, exists will be false. + //nd:hostfunc + GetFloat(ctx context.Context, key string) (value float64, exists bool, err error) + + // SetBytes stores a byte slice in the cache. + // + // Parameters: + // - key: The cache key (will be namespaced with plugin ID) + // - value: The byte slice to store + // - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) + // + // Returns an error if the operation fails. + //nd:hostfunc + SetBytes(ctx context.Context, key string, value []byte, ttlSeconds int64) error + + // GetBytes retrieves a byte slice from the cache. + // + // Parameters: + // - key: The cache key (will be namespaced with plugin ID) + // + // Returns the value and whether the key exists. If the key doesn't exist + // or the stored value is not a byte slice, exists will be false. + //nd:hostfunc + GetBytes(ctx context.Context, key string) (value []byte, exists bool, err error) + + // Has checks if a key exists in the cache. + // + // Parameters: + // - key: The cache key (will be namespaced with plugin ID) + // + // Returns true if the key exists and has not expired. + //nd:hostfunc + Has(ctx context.Context, key string) (exists bool, err error) + + // Remove deletes a value from the cache. + // + // Parameters: + // - key: The cache key (will be namespaced with plugin ID) + // + // Returns an error if the operation fails. Does not return an error if the key doesn't exist. + //nd:hostfunc + Remove(ctx context.Context, key string) error +} diff --git a/plugins/host/cache/cache.pb.go b/plugins/host/cache/cache.pb.go deleted file mode 100644 index 6113a89b4..000000000 --- a/plugins/host/cache/cache.pb.go +++ /dev/null @@ -1,420 +0,0 @@ -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: host/cache/cache.proto - -package cache - -import ( - context "context" - protoreflect "google.golang.org/protobuf/reflect/protoreflect" - protoimpl "google.golang.org/protobuf/runtime/protoimpl" -) - -const ( - // Verify that this generated code is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion) - // Verify that runtime/protoimpl is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) -) - -// Request to store a string value -type SetStringRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"` // Cache key - Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` // String value to store - TtlSeconds int64 `protobuf:"varint,3,opt,name=ttl_seconds,json=ttlSeconds,proto3" json:"ttl_seconds,omitempty"` // TTL in seconds, 0 means use default -} - -func (x *SetStringRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *SetStringRequest) GetKey() string { - if x != nil { - return x.Key - } - return "" -} - -func (x *SetStringRequest) GetValue() string { - if x != nil { - return x.Value - } - return "" -} - -func (x *SetStringRequest) GetTtlSeconds() int64 { - if x != nil { - return x.TtlSeconds - } - return 0 -} - -// Request to store an integer value -type SetIntRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"` // Cache key - Value int64 `protobuf:"varint,2,opt,name=value,proto3" json:"value,omitempty"` // Integer value to store - TtlSeconds int64 `protobuf:"varint,3,opt,name=ttl_seconds,json=ttlSeconds,proto3" json:"ttl_seconds,omitempty"` // TTL in seconds, 0 means use default -} - -func (x *SetIntRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *SetIntRequest) GetKey() string { - if x != nil { - return x.Key - } - return "" -} - -func (x *SetIntRequest) GetValue() int64 { - if x != nil { - return x.Value - } - return 0 -} - -func (x *SetIntRequest) GetTtlSeconds() int64 { - if x != nil { - return x.TtlSeconds - } - return 0 -} - -// Request to store a float value -type SetFloatRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"` // Cache key - Value float64 `protobuf:"fixed64,2,opt,name=value,proto3" json:"value,omitempty"` // Float value to store - TtlSeconds int64 `protobuf:"varint,3,opt,name=ttl_seconds,json=ttlSeconds,proto3" json:"ttl_seconds,omitempty"` // TTL in seconds, 0 means use default -} - -func (x *SetFloatRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *SetFloatRequest) GetKey() string { - if x != nil { - return x.Key - } - return "" -} - -func (x *SetFloatRequest) GetValue() float64 { - if x != nil { - return x.Value - } - return 0 -} - -func (x *SetFloatRequest) GetTtlSeconds() int64 { - if x != nil { - return x.TtlSeconds - } - return 0 -} - -// Request to store a byte slice value -type SetBytesRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"` // Cache key - Value []byte `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` // Byte slice value to store - TtlSeconds int64 `protobuf:"varint,3,opt,name=ttl_seconds,json=ttlSeconds,proto3" json:"ttl_seconds,omitempty"` // TTL in seconds, 0 means use default -} - -func (x *SetBytesRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *SetBytesRequest) GetKey() string { - if x != nil { - return x.Key - } - return "" -} - -func (x *SetBytesRequest) GetValue() []byte { - if x != nil { - return x.Value - } - return nil -} - -func (x *SetBytesRequest) GetTtlSeconds() int64 { - if x != nil { - return x.TtlSeconds - } - return 0 -} - -// Response after setting a value -type SetResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Success bool `protobuf:"varint,1,opt,name=success,proto3" json:"success,omitempty"` // Whether the operation was successful -} - -func (x *SetResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *SetResponse) GetSuccess() bool { - if x != nil { - return x.Success - } - return false -} - -// Request to get a value -type GetRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"` // Cache key -} - -func (x *GetRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *GetRequest) GetKey() string { - if x != nil { - return x.Key - } - return "" -} - -// Response containing a string value -type GetStringResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Exists bool `protobuf:"varint,1,opt,name=exists,proto3" json:"exists,omitempty"` // Whether the key exists - Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` // The string value (if exists is true) -} - -func (x *GetStringResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *GetStringResponse) GetExists() bool { - if x != nil { - return x.Exists - } - return false -} - -func (x *GetStringResponse) GetValue() string { - if x != nil { - return x.Value - } - return "" -} - -// Response containing an integer value -type GetIntResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Exists bool `protobuf:"varint,1,opt,name=exists,proto3" json:"exists,omitempty"` // Whether the key exists - Value int64 `protobuf:"varint,2,opt,name=value,proto3" json:"value,omitempty"` // The integer value (if exists is true) -} - -func (x *GetIntResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *GetIntResponse) GetExists() bool { - if x != nil { - return x.Exists - } - return false -} - -func (x *GetIntResponse) GetValue() int64 { - if x != nil { - return x.Value - } - return 0 -} - -// Response containing a float value -type GetFloatResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Exists bool `protobuf:"varint,1,opt,name=exists,proto3" json:"exists,omitempty"` // Whether the key exists - Value float64 `protobuf:"fixed64,2,opt,name=value,proto3" json:"value,omitempty"` // The float value (if exists is true) -} - -func (x *GetFloatResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *GetFloatResponse) GetExists() bool { - if x != nil { - return x.Exists - } - return false -} - -func (x *GetFloatResponse) GetValue() float64 { - if x != nil { - return x.Value - } - return 0 -} - -// Response containing a byte slice value -type GetBytesResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Exists bool `protobuf:"varint,1,opt,name=exists,proto3" json:"exists,omitempty"` // Whether the key exists - Value []byte `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` // The byte slice value (if exists is true) -} - -func (x *GetBytesResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *GetBytesResponse) GetExists() bool { - if x != nil { - return x.Exists - } - return false -} - -func (x *GetBytesResponse) GetValue() []byte { - if x != nil { - return x.Value - } - return nil -} - -// Request to remove a value -type RemoveRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"` // Cache key -} - -func (x *RemoveRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *RemoveRequest) GetKey() string { - if x != nil { - return x.Key - } - return "" -} - -// Response after removing a value -type RemoveResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Success bool `protobuf:"varint,1,opt,name=success,proto3" json:"success,omitempty"` // Whether the operation was successful -} - -func (x *RemoveResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *RemoveResponse) GetSuccess() bool { - if x != nil { - return x.Success - } - return false -} - -// Request to check if a key exists -type HasRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"` // Cache key -} - -func (x *HasRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *HasRequest) GetKey() string { - if x != nil { - return x.Key - } - return "" -} - -// Response indicating if a key exists -type HasResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Exists bool `protobuf:"varint,1,opt,name=exists,proto3" json:"exists,omitempty"` // Whether the key exists -} - -func (x *HasResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *HasResponse) GetExists() bool { - if x != nil { - return x.Exists - } - return false -} - -// go:plugin type=host version=1 -type CacheService interface { - // Set a string value in the cache - SetString(context.Context, *SetStringRequest) (*SetResponse, error) - // Get a string value from the cache - GetString(context.Context, *GetRequest) (*GetStringResponse, error) - // Set an integer value in the cache - SetInt(context.Context, *SetIntRequest) (*SetResponse, error) - // Get an integer value from the cache - GetInt(context.Context, *GetRequest) (*GetIntResponse, error) - // Set a float value in the cache - SetFloat(context.Context, *SetFloatRequest) (*SetResponse, error) - // Get a float value from the cache - GetFloat(context.Context, *GetRequest) (*GetFloatResponse, error) - // Set a byte slice value in the cache - SetBytes(context.Context, *SetBytesRequest) (*SetResponse, error) - // Get a byte slice value from the cache - GetBytes(context.Context, *GetRequest) (*GetBytesResponse, error) - // Remove a value from the cache - Remove(context.Context, *RemoveRequest) (*RemoveResponse, error) - // Check if a key exists in the cache - Has(context.Context, *HasRequest) (*HasResponse, error) -} diff --git a/plugins/host/cache/cache.proto b/plugins/host/cache/cache.proto deleted file mode 100644 index 8081eca3d..000000000 --- a/plugins/host/cache/cache.proto +++ /dev/null @@ -1,120 +0,0 @@ -syntax = "proto3"; - -package cache; - -option go_package = "github.com/navidrome/navidrome/plugins/host/cache;cache"; - -// go:plugin type=host version=1 -service CacheService { - // Set a string value in the cache - rpc SetString(SetStringRequest) returns (SetResponse); - - // Get a string value from the cache - rpc GetString(GetRequest) returns (GetStringResponse); - - // Set an integer value in the cache - rpc SetInt(SetIntRequest) returns (SetResponse); - - // Get an integer value from the cache - rpc GetInt(GetRequest) returns (GetIntResponse); - - // Set a float value in the cache - rpc SetFloat(SetFloatRequest) returns (SetResponse); - - // Get a float value from the cache - rpc GetFloat(GetRequest) returns (GetFloatResponse); - - // Set a byte slice value in the cache - rpc SetBytes(SetBytesRequest) returns (SetResponse); - - // Get a byte slice value from the cache - rpc GetBytes(GetRequest) returns (GetBytesResponse); - - // Remove a value from the cache - rpc Remove(RemoveRequest) returns (RemoveResponse); - - // Check if a key exists in the cache - rpc Has(HasRequest) returns (HasResponse); -} - -// Request to store a string value -message SetStringRequest { - string key = 1; // Cache key - string value = 2; // String value to store - int64 ttl_seconds = 3; // TTL in seconds, 0 means use default -} - -// Request to store an integer value -message SetIntRequest { - string key = 1; // Cache key - int64 value = 2; // Integer value to store - int64 ttl_seconds = 3; // TTL in seconds, 0 means use default -} - -// Request to store a float value -message SetFloatRequest { - string key = 1; // Cache key - double value = 2; // Float value to store - int64 ttl_seconds = 3; // TTL in seconds, 0 means use default -} - -// Request to store a byte slice value -message SetBytesRequest { - string key = 1; // Cache key - bytes value = 2; // Byte slice value to store - int64 ttl_seconds = 3; // TTL in seconds, 0 means use default -} - -// Response after setting a value -message SetResponse { - bool success = 1; // Whether the operation was successful -} - -// Request to get a value -message GetRequest { - string key = 1; // Cache key -} - -// Response containing a string value -message GetStringResponse { - bool exists = 1; // Whether the key exists - string value = 2; // The string value (if exists is true) -} - -// Response containing an integer value -message GetIntResponse { - bool exists = 1; // Whether the key exists - int64 value = 2; // The integer value (if exists is true) -} - -// Response containing a float value -message GetFloatResponse { - bool exists = 1; // Whether the key exists - double value = 2; // The float value (if exists is true) -} - -// Response containing a byte slice value -message GetBytesResponse { - bool exists = 1; // Whether the key exists - bytes value = 2; // The byte slice value (if exists is true) -} - -// Request to remove a value -message RemoveRequest { - string key = 1; // Cache key -} - -// Response after removing a value -message RemoveResponse { - bool success = 1; // Whether the operation was successful -} - -// Request to check if a key exists -message HasRequest { - string key = 1; // Cache key -} - -// Response indicating if a key exists -message HasResponse { - bool exists = 1; // Whether the key exists -} \ No newline at end of file diff --git a/plugins/host/cache/cache_host.pb.go b/plugins/host/cache/cache_host.pb.go deleted file mode 100644 index 479473fa8..000000000 --- a/plugins/host/cache/cache_host.pb.go +++ /dev/null @@ -1,374 +0,0 @@ -//go:build !wasip1 - -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: host/cache/cache.proto - -package cache - -import ( - context "context" - wasm "github.com/knqyf263/go-plugin/wasm" - wazero "github.com/tetratelabs/wazero" - api "github.com/tetratelabs/wazero/api" -) - -const ( - i32 = api.ValueTypeI32 - i64 = api.ValueTypeI64 -) - -type _cacheService struct { - CacheService -} - -// Instantiate a Go-defined module named "env" that exports host functions. -func Instantiate(ctx context.Context, r wazero.Runtime, hostFunctions CacheService) error { - envBuilder := r.NewHostModuleBuilder("env") - h := _cacheService{hostFunctions} - - envBuilder.NewFunctionBuilder(). - WithGoModuleFunction(api.GoModuleFunc(h._SetString), []api.ValueType{i32, i32}, []api.ValueType{i64}). - WithParameterNames("offset", "size"). - Export("set_string") - - envBuilder.NewFunctionBuilder(). - WithGoModuleFunction(api.GoModuleFunc(h._GetString), []api.ValueType{i32, i32}, []api.ValueType{i64}). - WithParameterNames("offset", "size"). - Export("get_string") - - envBuilder.NewFunctionBuilder(). - WithGoModuleFunction(api.GoModuleFunc(h._SetInt), []api.ValueType{i32, i32}, []api.ValueType{i64}). - WithParameterNames("offset", "size"). - Export("set_int") - - envBuilder.NewFunctionBuilder(). - WithGoModuleFunction(api.GoModuleFunc(h._GetInt), []api.ValueType{i32, i32}, []api.ValueType{i64}). - WithParameterNames("offset", "size"). - Export("get_int") - - envBuilder.NewFunctionBuilder(). - WithGoModuleFunction(api.GoModuleFunc(h._SetFloat), []api.ValueType{i32, i32}, []api.ValueType{i64}). - WithParameterNames("offset", "size"). - Export("set_float") - - envBuilder.NewFunctionBuilder(). - WithGoModuleFunction(api.GoModuleFunc(h._GetFloat), []api.ValueType{i32, i32}, []api.ValueType{i64}). - WithParameterNames("offset", "size"). - Export("get_float") - - envBuilder.NewFunctionBuilder(). - WithGoModuleFunction(api.GoModuleFunc(h._SetBytes), []api.ValueType{i32, i32}, []api.ValueType{i64}). - WithParameterNames("offset", "size"). - Export("set_bytes") - - envBuilder.NewFunctionBuilder(). - WithGoModuleFunction(api.GoModuleFunc(h._GetBytes), []api.ValueType{i32, i32}, []api.ValueType{i64}). - WithParameterNames("offset", "size"). - Export("get_bytes") - - envBuilder.NewFunctionBuilder(). - WithGoModuleFunction(api.GoModuleFunc(h._Remove), []api.ValueType{i32, i32}, []api.ValueType{i64}). - WithParameterNames("offset", "size"). - Export("remove") - - envBuilder.NewFunctionBuilder(). - WithGoModuleFunction(api.GoModuleFunc(h._Has), []api.ValueType{i32, i32}, []api.ValueType{i64}). - WithParameterNames("offset", "size"). - Export("has") - - _, err := envBuilder.Instantiate(ctx) - return err -} - -// Set a string value in the cache - -func (h _cacheService) _SetString(ctx context.Context, m api.Module, stack []uint64) { - offset, size := uint32(stack[0]), uint32(stack[1]) - buf, err := wasm.ReadMemory(m.Memory(), offset, size) - if err != nil { - panic(err) - } - request := new(SetStringRequest) - err = request.UnmarshalVT(buf) - if err != nil { - panic(err) - } - resp, err := h.SetString(ctx, request) - if err != nil { - panic(err) - } - buf, err = resp.MarshalVT() - if err != nil { - panic(err) - } - ptr, err := wasm.WriteMemory(ctx, m, buf) - if err != nil { - panic(err) - } - ptrLen := (ptr << uint64(32)) | uint64(len(buf)) - stack[0] = ptrLen -} - -// Get a string value from the cache - -func (h _cacheService) _GetString(ctx context.Context, m api.Module, stack []uint64) { - offset, size := uint32(stack[0]), uint32(stack[1]) - buf, err := wasm.ReadMemory(m.Memory(), offset, size) - if err != nil { - panic(err) - } - request := new(GetRequest) - err = request.UnmarshalVT(buf) - if err != nil { - panic(err) - } - resp, err := h.GetString(ctx, request) - if err != nil { - panic(err) - } - buf, err = resp.MarshalVT() - if err != nil { - panic(err) - } - ptr, err := wasm.WriteMemory(ctx, m, buf) - if err != nil { - panic(err) - } - ptrLen := (ptr << uint64(32)) | uint64(len(buf)) - stack[0] = ptrLen -} - -// Set an integer value in the cache - -func (h _cacheService) _SetInt(ctx context.Context, m api.Module, stack []uint64) { - offset, size := uint32(stack[0]), uint32(stack[1]) - buf, err := wasm.ReadMemory(m.Memory(), offset, size) - if err != nil { - panic(err) - } - request := new(SetIntRequest) - err = request.UnmarshalVT(buf) - if err != nil { - panic(err) - } - resp, err := h.SetInt(ctx, request) - if err != nil { - panic(err) - } - buf, err = resp.MarshalVT() - if err != nil { - panic(err) - } - ptr, err := wasm.WriteMemory(ctx, m, buf) - if err != nil { - panic(err) - } - ptrLen := (ptr << uint64(32)) | uint64(len(buf)) - stack[0] = ptrLen -} - -// Get an integer value from the cache - -func (h _cacheService) _GetInt(ctx context.Context, m api.Module, stack []uint64) { - offset, size := uint32(stack[0]), uint32(stack[1]) - buf, err := wasm.ReadMemory(m.Memory(), offset, size) - if err != nil { - panic(err) - } - request := new(GetRequest) - err = request.UnmarshalVT(buf) - if err != nil { - panic(err) - } - resp, err := h.GetInt(ctx, request) - if err != nil { - panic(err) - } - buf, err = resp.MarshalVT() - if err != nil { - panic(err) - } - ptr, err := wasm.WriteMemory(ctx, m, buf) - if err != nil { - panic(err) - } - ptrLen := (ptr << uint64(32)) | uint64(len(buf)) - stack[0] = ptrLen -} - -// Set a float value in the cache - -func (h _cacheService) _SetFloat(ctx context.Context, m api.Module, stack []uint64) { - offset, size := uint32(stack[0]), uint32(stack[1]) - buf, err := wasm.ReadMemory(m.Memory(), offset, size) - if err != nil { - panic(err) - } - request := new(SetFloatRequest) - err = request.UnmarshalVT(buf) - if err != nil { - panic(err) - } - resp, err := h.SetFloat(ctx, request) - if err != nil { - panic(err) - } - buf, err = resp.MarshalVT() - if err != nil { - panic(err) - } - ptr, err := wasm.WriteMemory(ctx, m, buf) - if err != nil { - panic(err) - } - ptrLen := (ptr << uint64(32)) | uint64(len(buf)) - stack[0] = ptrLen -} - -// Get a float value from the cache - -func (h _cacheService) _GetFloat(ctx context.Context, m api.Module, stack []uint64) { - offset, size := uint32(stack[0]), uint32(stack[1]) - buf, err := wasm.ReadMemory(m.Memory(), offset, size) - if err != nil { - panic(err) - } - request := new(GetRequest) - err = request.UnmarshalVT(buf) - if err != nil { - panic(err) - } - resp, err := h.GetFloat(ctx, request) - if err != nil { - panic(err) - } - buf, err = resp.MarshalVT() - if err != nil { - panic(err) - } - ptr, err := wasm.WriteMemory(ctx, m, buf) - if err != nil { - panic(err) - } - ptrLen := (ptr << uint64(32)) | uint64(len(buf)) - stack[0] = ptrLen -} - -// Set a byte slice value in the cache - -func (h _cacheService) _SetBytes(ctx context.Context, m api.Module, stack []uint64) { - offset, size := uint32(stack[0]), uint32(stack[1]) - buf, err := wasm.ReadMemory(m.Memory(), offset, size) - if err != nil { - panic(err) - } - request := new(SetBytesRequest) - err = request.UnmarshalVT(buf) - if err != nil { - panic(err) - } - resp, err := h.SetBytes(ctx, request) - if err != nil { - panic(err) - } - buf, err = resp.MarshalVT() - if err != nil { - panic(err) - } - ptr, err := wasm.WriteMemory(ctx, m, buf) - if err != nil { - panic(err) - } - ptrLen := (ptr << uint64(32)) | uint64(len(buf)) - stack[0] = ptrLen -} - -// Get a byte slice value from the cache - -func (h _cacheService) _GetBytes(ctx context.Context, m api.Module, stack []uint64) { - offset, size := uint32(stack[0]), uint32(stack[1]) - buf, err := wasm.ReadMemory(m.Memory(), offset, size) - if err != nil { - panic(err) - } - request := new(GetRequest) - err = request.UnmarshalVT(buf) - if err != nil { - panic(err) - } - resp, err := h.GetBytes(ctx, request) - if err != nil { - panic(err) - } - buf, err = resp.MarshalVT() - if err != nil { - panic(err) - } - ptr, err := wasm.WriteMemory(ctx, m, buf) - if err != nil { - panic(err) - } - ptrLen := (ptr << uint64(32)) | uint64(len(buf)) - stack[0] = ptrLen -} - -// Remove a value from the cache - -func (h _cacheService) _Remove(ctx context.Context, m api.Module, stack []uint64) { - offset, size := uint32(stack[0]), uint32(stack[1]) - buf, err := wasm.ReadMemory(m.Memory(), offset, size) - if err != nil { - panic(err) - } - request := new(RemoveRequest) - err = request.UnmarshalVT(buf) - if err != nil { - panic(err) - } - resp, err := h.Remove(ctx, request) - if err != nil { - panic(err) - } - buf, err = resp.MarshalVT() - if err != nil { - panic(err) - } - ptr, err := wasm.WriteMemory(ctx, m, buf) - if err != nil { - panic(err) - } - ptrLen := (ptr << uint64(32)) | uint64(len(buf)) - stack[0] = ptrLen -} - -// Check if a key exists in the cache - -func (h _cacheService) _Has(ctx context.Context, m api.Module, stack []uint64) { - offset, size := uint32(stack[0]), uint32(stack[1]) - buf, err := wasm.ReadMemory(m.Memory(), offset, size) - if err != nil { - panic(err) - } - request := new(HasRequest) - err = request.UnmarshalVT(buf) - if err != nil { - panic(err) - } - resp, err := h.Has(ctx, request) - if err != nil { - panic(err) - } - buf, err = resp.MarshalVT() - if err != nil { - panic(err) - } - ptr, err := wasm.WriteMemory(ctx, m, buf) - if err != nil { - panic(err) - } - ptrLen := (ptr << uint64(32)) | uint64(len(buf)) - stack[0] = ptrLen -} diff --git a/plugins/host/cache/cache_plugin.pb.go b/plugins/host/cache/cache_plugin.pb.go deleted file mode 100644 index 6e3bdcd44..000000000 --- a/plugins/host/cache/cache_plugin.pb.go +++ /dev/null @@ -1,251 +0,0 @@ -//go:build wasip1 - -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: host/cache/cache.proto - -package cache - -import ( - context "context" - wasm "github.com/knqyf263/go-plugin/wasm" - _ "unsafe" -) - -type cacheService struct{} - -func NewCacheService() CacheService { - return cacheService{} -} - -//go:wasmimport env set_string -func _set_string(ptr uint32, size uint32) uint64 - -func (h cacheService) SetString(ctx context.Context, request *SetStringRequest) (*SetResponse, error) { - buf, err := request.MarshalVT() - if err != nil { - return nil, err - } - ptr, size := wasm.ByteToPtr(buf) - ptrSize := _set_string(ptr, size) - wasm.Free(ptr) - - ptr = uint32(ptrSize >> 32) - size = uint32(ptrSize) - buf = wasm.PtrToByte(ptr, size) - - response := new(SetResponse) - if err = response.UnmarshalVT(buf); err != nil { - return nil, err - } - return response, nil -} - -//go:wasmimport env get_string -func _get_string(ptr uint32, size uint32) uint64 - -func (h cacheService) GetString(ctx context.Context, request *GetRequest) (*GetStringResponse, error) { - buf, err := request.MarshalVT() - if err != nil { - return nil, err - } - ptr, size := wasm.ByteToPtr(buf) - ptrSize := _get_string(ptr, size) - wasm.Free(ptr) - - ptr = uint32(ptrSize >> 32) - size = uint32(ptrSize) - buf = wasm.PtrToByte(ptr, size) - - response := new(GetStringResponse) - if err = response.UnmarshalVT(buf); err != nil { - return nil, err - } - return response, nil -} - -//go:wasmimport env set_int -func _set_int(ptr uint32, size uint32) uint64 - -func (h cacheService) SetInt(ctx context.Context, request *SetIntRequest) (*SetResponse, error) { - buf, err := request.MarshalVT() - if err != nil { - return nil, err - } - ptr, size := wasm.ByteToPtr(buf) - ptrSize := _set_int(ptr, size) - wasm.Free(ptr) - - ptr = uint32(ptrSize >> 32) - size = uint32(ptrSize) - buf = wasm.PtrToByte(ptr, size) - - response := new(SetResponse) - if err = response.UnmarshalVT(buf); err != nil { - return nil, err - } - return response, nil -} - -//go:wasmimport env get_int -func _get_int(ptr uint32, size uint32) uint64 - -func (h cacheService) GetInt(ctx context.Context, request *GetRequest) (*GetIntResponse, error) { - buf, err := request.MarshalVT() - if err != nil { - return nil, err - } - ptr, size := wasm.ByteToPtr(buf) - ptrSize := _get_int(ptr, size) - wasm.Free(ptr) - - ptr = uint32(ptrSize >> 32) - size = uint32(ptrSize) - buf = wasm.PtrToByte(ptr, size) - - response := new(GetIntResponse) - if err = response.UnmarshalVT(buf); err != nil { - return nil, err - } - return response, nil -} - -//go:wasmimport env set_float -func _set_float(ptr uint32, size uint32) uint64 - -func (h cacheService) SetFloat(ctx context.Context, request *SetFloatRequest) (*SetResponse, error) { - buf, err := request.MarshalVT() - if err != nil { - return nil, err - } - ptr, size := wasm.ByteToPtr(buf) - ptrSize := _set_float(ptr, size) - wasm.Free(ptr) - - ptr = uint32(ptrSize >> 32) - size = uint32(ptrSize) - buf = wasm.PtrToByte(ptr, size) - - response := new(SetResponse) - if err = response.UnmarshalVT(buf); err != nil { - return nil, err - } - return response, nil -} - -//go:wasmimport env get_float -func _get_float(ptr uint32, size uint32) uint64 - -func (h cacheService) GetFloat(ctx context.Context, request *GetRequest) (*GetFloatResponse, error) { - buf, err := request.MarshalVT() - if err != nil { - return nil, err - } - ptr, size := wasm.ByteToPtr(buf) - ptrSize := _get_float(ptr, size) - wasm.Free(ptr) - - ptr = uint32(ptrSize >> 32) - size = uint32(ptrSize) - buf = wasm.PtrToByte(ptr, size) - - response := new(GetFloatResponse) - if err = response.UnmarshalVT(buf); err != nil { - return nil, err - } - return response, nil -} - -//go:wasmimport env set_bytes -func _set_bytes(ptr uint32, size uint32) uint64 - -func (h cacheService) SetBytes(ctx context.Context, request *SetBytesRequest) (*SetResponse, error) { - buf, err := request.MarshalVT() - if err != nil { - return nil, err - } - ptr, size := wasm.ByteToPtr(buf) - ptrSize := _set_bytes(ptr, size) - wasm.Free(ptr) - - ptr = uint32(ptrSize >> 32) - size = uint32(ptrSize) - buf = wasm.PtrToByte(ptr, size) - - response := new(SetResponse) - if err = response.UnmarshalVT(buf); err != nil { - return nil, err - } - return response, nil -} - -//go:wasmimport env get_bytes -func _get_bytes(ptr uint32, size uint32) uint64 - -func (h cacheService) GetBytes(ctx context.Context, request *GetRequest) (*GetBytesResponse, error) { - buf, err := request.MarshalVT() - if err != nil { - return nil, err - } - ptr, size := wasm.ByteToPtr(buf) - ptrSize := _get_bytes(ptr, size) - wasm.Free(ptr) - - ptr = uint32(ptrSize >> 32) - size = uint32(ptrSize) - buf = wasm.PtrToByte(ptr, size) - - response := new(GetBytesResponse) - if err = response.UnmarshalVT(buf); err != nil { - return nil, err - } - return response, nil -} - -//go:wasmimport env remove -func _remove(ptr uint32, size uint32) uint64 - -func (h cacheService) Remove(ctx context.Context, request *RemoveRequest) (*RemoveResponse, error) { - buf, err := request.MarshalVT() - if err != nil { - return nil, err - } - ptr, size := wasm.ByteToPtr(buf) - ptrSize := _remove(ptr, size) - wasm.Free(ptr) - - ptr = uint32(ptrSize >> 32) - size = uint32(ptrSize) - buf = wasm.PtrToByte(ptr, size) - - response := new(RemoveResponse) - if err = response.UnmarshalVT(buf); err != nil { - return nil, err - } - return response, nil -} - -//go:wasmimport env has -func _has(ptr uint32, size uint32) uint64 - -func (h cacheService) Has(ctx context.Context, request *HasRequest) (*HasResponse, error) { - buf, err := request.MarshalVT() - if err != nil { - return nil, err - } - ptr, size := wasm.ByteToPtr(buf) - ptrSize := _has(ptr, size) - wasm.Free(ptr) - - ptr = uint32(ptrSize >> 32) - size = uint32(ptrSize) - buf = wasm.PtrToByte(ptr, size) - - response := new(HasResponse) - if err = response.UnmarshalVT(buf); err != nil { - return nil, err - } - return response, nil -} diff --git a/plugins/host/cache/cache_plugin_dev.go b/plugins/host/cache/cache_plugin_dev.go deleted file mode 100644 index 824dcc71d..000000000 --- a/plugins/host/cache/cache_plugin_dev.go +++ /dev/null @@ -1,7 +0,0 @@ -//go:build !wasip1 - -package cache - -func NewCacheService() CacheService { - panic("not implemented") -} diff --git a/plugins/host/cache/cache_vtproto.pb.go b/plugins/host/cache/cache_vtproto.pb.go deleted file mode 100644 index 0ee3d9f22..000000000 --- a/plugins/host/cache/cache_vtproto.pb.go +++ /dev/null @@ -1,2352 +0,0 @@ -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: host/cache/cache.proto - -package cache - -import ( - binary "encoding/binary" - fmt "fmt" - protoimpl "google.golang.org/protobuf/runtime/protoimpl" - io "io" - math "math" - bits "math/bits" -) - -const ( - // Verify that this generated code is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion) - // Verify that runtime/protoimpl is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) -) - -func (m *SetStringRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *SetStringRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *SetStringRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if m.TtlSeconds != 0 { - i = encodeVarint(dAtA, i, uint64(m.TtlSeconds)) - i-- - dAtA[i] = 0x18 - } - if len(m.Value) > 0 { - i -= len(m.Value) - copy(dAtA[i:], m.Value) - i = encodeVarint(dAtA, i, uint64(len(m.Value))) - i-- - dAtA[i] = 0x12 - } - if len(m.Key) > 0 { - i -= len(m.Key) - copy(dAtA[i:], m.Key) - i = encodeVarint(dAtA, i, uint64(len(m.Key))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *SetIntRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *SetIntRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *SetIntRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if m.TtlSeconds != 0 { - i = encodeVarint(dAtA, i, uint64(m.TtlSeconds)) - i-- - dAtA[i] = 0x18 - } - if m.Value != 0 { - i = encodeVarint(dAtA, i, uint64(m.Value)) - i-- - dAtA[i] = 0x10 - } - if len(m.Key) > 0 { - i -= len(m.Key) - copy(dAtA[i:], m.Key) - i = encodeVarint(dAtA, i, uint64(len(m.Key))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *SetFloatRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *SetFloatRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *SetFloatRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if m.TtlSeconds != 0 { - i = encodeVarint(dAtA, i, uint64(m.TtlSeconds)) - i-- - dAtA[i] = 0x18 - } - if m.Value != 0 { - i -= 8 - binary.LittleEndian.PutUint64(dAtA[i:], uint64(math.Float64bits(float64(m.Value)))) - i-- - dAtA[i] = 0x11 - } - if len(m.Key) > 0 { - i -= len(m.Key) - copy(dAtA[i:], m.Key) - i = encodeVarint(dAtA, i, uint64(len(m.Key))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *SetBytesRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *SetBytesRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *SetBytesRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if m.TtlSeconds != 0 { - i = encodeVarint(dAtA, i, uint64(m.TtlSeconds)) - i-- - dAtA[i] = 0x18 - } - if len(m.Value) > 0 { - i -= len(m.Value) - copy(dAtA[i:], m.Value) - i = encodeVarint(dAtA, i, uint64(len(m.Value))) - i-- - dAtA[i] = 0x12 - } - if len(m.Key) > 0 { - i -= len(m.Key) - copy(dAtA[i:], m.Key) - i = encodeVarint(dAtA, i, uint64(len(m.Key))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *SetResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *SetResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *SetResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if m.Success { - i-- - if m.Success { - dAtA[i] = 1 - } else { - dAtA[i] = 0 - } - i-- - dAtA[i] = 0x8 - } - return len(dAtA) - i, nil -} - -func (m *GetRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *GetRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *GetRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Key) > 0 { - i -= len(m.Key) - copy(dAtA[i:], m.Key) - i = encodeVarint(dAtA, i, uint64(len(m.Key))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *GetStringResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *GetStringResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *GetStringResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Value) > 0 { - i -= len(m.Value) - copy(dAtA[i:], m.Value) - i = encodeVarint(dAtA, i, uint64(len(m.Value))) - i-- - dAtA[i] = 0x12 - } - if m.Exists { - i-- - if m.Exists { - dAtA[i] = 1 - } else { - dAtA[i] = 0 - } - i-- - dAtA[i] = 0x8 - } - return len(dAtA) - i, nil -} - -func (m *GetIntResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *GetIntResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *GetIntResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if m.Value != 0 { - i = encodeVarint(dAtA, i, uint64(m.Value)) - i-- - dAtA[i] = 0x10 - } - if m.Exists { - i-- - if m.Exists { - dAtA[i] = 1 - } else { - dAtA[i] = 0 - } - i-- - dAtA[i] = 0x8 - } - return len(dAtA) - i, nil -} - -func (m *GetFloatResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *GetFloatResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *GetFloatResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if m.Value != 0 { - i -= 8 - binary.LittleEndian.PutUint64(dAtA[i:], uint64(math.Float64bits(float64(m.Value)))) - i-- - dAtA[i] = 0x11 - } - if m.Exists { - i-- - if m.Exists { - dAtA[i] = 1 - } else { - dAtA[i] = 0 - } - i-- - dAtA[i] = 0x8 - } - return len(dAtA) - i, nil -} - -func (m *GetBytesResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *GetBytesResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *GetBytesResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Value) > 0 { - i -= len(m.Value) - copy(dAtA[i:], m.Value) - i = encodeVarint(dAtA, i, uint64(len(m.Value))) - i-- - dAtA[i] = 0x12 - } - if m.Exists { - i-- - if m.Exists { - dAtA[i] = 1 - } else { - dAtA[i] = 0 - } - i-- - dAtA[i] = 0x8 - } - return len(dAtA) - i, nil -} - -func (m *RemoveRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *RemoveRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *RemoveRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Key) > 0 { - i -= len(m.Key) - copy(dAtA[i:], m.Key) - i = encodeVarint(dAtA, i, uint64(len(m.Key))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *RemoveResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *RemoveResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *RemoveResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if m.Success { - i-- - if m.Success { - dAtA[i] = 1 - } else { - dAtA[i] = 0 - } - i-- - dAtA[i] = 0x8 - } - return len(dAtA) - i, nil -} - -func (m *HasRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *HasRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *HasRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Key) > 0 { - i -= len(m.Key) - copy(dAtA[i:], m.Key) - i = encodeVarint(dAtA, i, uint64(len(m.Key))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *HasResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *HasResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *HasResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if m.Exists { - i-- - if m.Exists { - dAtA[i] = 1 - } else { - dAtA[i] = 0 - } - i-- - dAtA[i] = 0x8 - } - return len(dAtA) - i, nil -} - -func encodeVarint(dAtA []byte, offset int, v uint64) int { - offset -= sov(v) - base := offset - for v >= 1<<7 { - dAtA[offset] = uint8(v&0x7f | 0x80) - v >>= 7 - offset++ - } - dAtA[offset] = uint8(v) - return base -} -func (m *SetStringRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Key) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Value) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - if m.TtlSeconds != 0 { - n += 1 + sov(uint64(m.TtlSeconds)) - } - n += len(m.unknownFields) - return n -} - -func (m *SetIntRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Key) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - if m.Value != 0 { - n += 1 + sov(uint64(m.Value)) - } - if m.TtlSeconds != 0 { - n += 1 + sov(uint64(m.TtlSeconds)) - } - n += len(m.unknownFields) - return n -} - -func (m *SetFloatRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Key) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - if m.Value != 0 { - n += 9 - } - if m.TtlSeconds != 0 { - n += 1 + sov(uint64(m.TtlSeconds)) - } - n += len(m.unknownFields) - return n -} - -func (m *SetBytesRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Key) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Value) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - if m.TtlSeconds != 0 { - n += 1 + sov(uint64(m.TtlSeconds)) - } - n += len(m.unknownFields) - return n -} - -func (m *SetResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - if m.Success { - n += 2 - } - n += len(m.unknownFields) - return n -} - -func (m *GetRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Key) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *GetStringResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - if m.Exists { - n += 2 - } - l = len(m.Value) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *GetIntResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - if m.Exists { - n += 2 - } - if m.Value != 0 { - n += 1 + sov(uint64(m.Value)) - } - n += len(m.unknownFields) - return n -} - -func (m *GetFloatResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - if m.Exists { - n += 2 - } - if m.Value != 0 { - n += 9 - } - n += len(m.unknownFields) - return n -} - -func (m *GetBytesResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - if m.Exists { - n += 2 - } - l = len(m.Value) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *RemoveRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Key) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *RemoveResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - if m.Success { - n += 2 - } - n += len(m.unknownFields) - return n -} - -func (m *HasRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Key) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *HasResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - if m.Exists { - n += 2 - } - n += len(m.unknownFields) - return n -} - -func sov(x uint64) (n int) { - return (bits.Len64(x|1) + 6) / 7 -} -func soz(x uint64) (n int) { - return sov(uint64((x << 1) ^ uint64((int64(x) >> 63)))) -} -func (m *SetStringRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: SetStringRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: SetStringRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Key", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Key = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Value", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Value = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 3: - if wireType != 0 { - return fmt.Errorf("proto: wrong wireType = %d for field TtlSeconds", wireType) - } - m.TtlSeconds = 0 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - m.TtlSeconds |= int64(b&0x7F) << shift - if b < 0x80 { - break - } - } - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *SetIntRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: SetIntRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: SetIntRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Key", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Key = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 0 { - return fmt.Errorf("proto: wrong wireType = %d for field Value", wireType) - } - m.Value = 0 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - m.Value |= int64(b&0x7F) << shift - if b < 0x80 { - break - } - } - case 3: - if wireType != 0 { - return fmt.Errorf("proto: wrong wireType = %d for field TtlSeconds", wireType) - } - m.TtlSeconds = 0 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - m.TtlSeconds |= int64(b&0x7F) << shift - if b < 0x80 { - break - } - } - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *SetFloatRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: SetFloatRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: SetFloatRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Key", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Key = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 1 { - return fmt.Errorf("proto: wrong wireType = %d for field Value", wireType) - } - var v uint64 - if (iNdEx + 8) > l { - return io.ErrUnexpectedEOF - } - v = uint64(binary.LittleEndian.Uint64(dAtA[iNdEx:])) - iNdEx += 8 - m.Value = float64(math.Float64frombits(v)) - case 3: - if wireType != 0 { - return fmt.Errorf("proto: wrong wireType = %d for field TtlSeconds", wireType) - } - m.TtlSeconds = 0 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - m.TtlSeconds |= int64(b&0x7F) << shift - if b < 0x80 { - break - } - } - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *SetBytesRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: SetBytesRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: SetBytesRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Key", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Key = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Value", wireType) - } - var byteLen int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - byteLen |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - if byteLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + byteLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Value = append(m.Value[:0], dAtA[iNdEx:postIndex]...) - if m.Value == nil { - m.Value = []byte{} - } - iNdEx = postIndex - case 3: - if wireType != 0 { - return fmt.Errorf("proto: wrong wireType = %d for field TtlSeconds", wireType) - } - m.TtlSeconds = 0 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - m.TtlSeconds |= int64(b&0x7F) << shift - if b < 0x80 { - break - } - } - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *SetResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: SetResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: SetResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 0 { - return fmt.Errorf("proto: wrong wireType = %d for field Success", wireType) - } - var v int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - v |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - m.Success = bool(v != 0) - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *GetRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: GetRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: GetRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Key", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Key = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *GetStringResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: GetStringResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: GetStringResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 0 { - return fmt.Errorf("proto: wrong wireType = %d for field Exists", wireType) - } - var v int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - v |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - m.Exists = bool(v != 0) - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Value", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Value = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *GetIntResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: GetIntResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: GetIntResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 0 { - return fmt.Errorf("proto: wrong wireType = %d for field Exists", wireType) - } - var v int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - v |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - m.Exists = bool(v != 0) - case 2: - if wireType != 0 { - return fmt.Errorf("proto: wrong wireType = %d for field Value", wireType) - } - m.Value = 0 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - m.Value |= int64(b&0x7F) << shift - if b < 0x80 { - break - } - } - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *GetFloatResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: GetFloatResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: GetFloatResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 0 { - return fmt.Errorf("proto: wrong wireType = %d for field Exists", wireType) - } - var v int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - v |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - m.Exists = bool(v != 0) - case 2: - if wireType != 1 { - return fmt.Errorf("proto: wrong wireType = %d for field Value", wireType) - } - var v uint64 - if (iNdEx + 8) > l { - return io.ErrUnexpectedEOF - } - v = uint64(binary.LittleEndian.Uint64(dAtA[iNdEx:])) - iNdEx += 8 - m.Value = float64(math.Float64frombits(v)) - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *GetBytesResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: GetBytesResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: GetBytesResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 0 { - return fmt.Errorf("proto: wrong wireType = %d for field Exists", wireType) - } - var v int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - v |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - m.Exists = bool(v != 0) - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Value", wireType) - } - var byteLen int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - byteLen |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - if byteLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + byteLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Value = append(m.Value[:0], dAtA[iNdEx:postIndex]...) - if m.Value == nil { - m.Value = []byte{} - } - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *RemoveRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: RemoveRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: RemoveRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Key", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Key = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *RemoveResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: RemoveResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: RemoveResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 0 { - return fmt.Errorf("proto: wrong wireType = %d for field Success", wireType) - } - var v int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - v |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - m.Success = bool(v != 0) - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *HasRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: HasRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: HasRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Key", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Key = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *HasResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: HasResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: HasResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 0 { - return fmt.Errorf("proto: wrong wireType = %d for field Exists", wireType) - } - var v int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - v |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - m.Exists = bool(v != 0) - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} - -func skip(dAtA []byte) (n int, err error) { - l := len(dAtA) - iNdEx := 0 - depth := 0 - for iNdEx < l { - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return 0, ErrIntOverflow - } - if iNdEx >= l { - return 0, io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= (uint64(b) & 0x7F) << shift - if b < 0x80 { - break - } - } - wireType := int(wire & 0x7) - switch wireType { - case 0: - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return 0, ErrIntOverflow - } - if iNdEx >= l { - return 0, io.ErrUnexpectedEOF - } - iNdEx++ - if dAtA[iNdEx-1] < 0x80 { - break - } - } - case 1: - iNdEx += 8 - case 2: - var length int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return 0, ErrIntOverflow - } - if iNdEx >= l { - return 0, io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - length |= (int(b) & 0x7F) << shift - if b < 0x80 { - break - } - } - if length < 0 { - return 0, ErrInvalidLength - } - iNdEx += length - case 3: - depth++ - case 4: - if depth == 0 { - return 0, ErrUnexpectedEndOfGroup - } - depth-- - case 5: - iNdEx += 4 - default: - return 0, fmt.Errorf("proto: illegal wireType %d", wireType) - } - if iNdEx < 0 { - return 0, ErrInvalidLength - } - if depth == 0 { - return iNdEx, nil - } - } - return 0, io.ErrUnexpectedEOF -} - -var ( - ErrInvalidLength = fmt.Errorf("proto: negative length found during unmarshaling") - ErrIntOverflow = fmt.Errorf("proto: integer overflow") - ErrUnexpectedEndOfGroup = fmt.Errorf("proto: unexpected end of group") -) diff --git a/plugins/host/cache_gen.go b/plugins/host/cache_gen.go new file mode 100644 index 000000000..5645c5495 --- /dev/null +++ b/plugins/host/cache_gen.go @@ -0,0 +1,498 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package host + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// CacheSetStringRequest is the request type for Cache.SetString. +type CacheSetStringRequest struct { + Key string `json:"key"` + Value string `json:"value"` + TtlSeconds int64 `json:"ttlSeconds"` +} + +// CacheSetStringResponse is the response type for Cache.SetString. +type CacheSetStringResponse struct { + Error string `json:"error,omitempty"` +} + +// CacheGetStringRequest is the request type for Cache.GetString. +type CacheGetStringRequest struct { + Key string `json:"key"` +} + +// CacheGetStringResponse is the response type for Cache.GetString. +type CacheGetStringResponse struct { + Value string `json:"value,omitempty"` + Exists bool `json:"exists,omitempty"` + Error string `json:"error,omitempty"` +} + +// CacheSetIntRequest is the request type for Cache.SetInt. +type CacheSetIntRequest struct { + Key string `json:"key"` + Value int64 `json:"value"` + TtlSeconds int64 `json:"ttlSeconds"` +} + +// CacheSetIntResponse is the response type for Cache.SetInt. +type CacheSetIntResponse struct { + Error string `json:"error,omitempty"` +} + +// CacheGetIntRequest is the request type for Cache.GetInt. +type CacheGetIntRequest struct { + Key string `json:"key"` +} + +// CacheGetIntResponse is the response type for Cache.GetInt. +type CacheGetIntResponse struct { + Value int64 `json:"value,omitempty"` + Exists bool `json:"exists,omitempty"` + Error string `json:"error,omitempty"` +} + +// CacheSetFloatRequest is the request type for Cache.SetFloat. +type CacheSetFloatRequest struct { + Key string `json:"key"` + Value float64 `json:"value"` + TtlSeconds int64 `json:"ttlSeconds"` +} + +// CacheSetFloatResponse is the response type for Cache.SetFloat. +type CacheSetFloatResponse struct { + Error string `json:"error,omitempty"` +} + +// CacheGetFloatRequest is the request type for Cache.GetFloat. +type CacheGetFloatRequest struct { + Key string `json:"key"` +} + +// CacheGetFloatResponse is the response type for Cache.GetFloat. +type CacheGetFloatResponse struct { + Value float64 `json:"value,omitempty"` + Exists bool `json:"exists,omitempty"` + Error string `json:"error,omitempty"` +} + +// CacheSetBytesRequest is the request type for Cache.SetBytes. +type CacheSetBytesRequest struct { + Key string `json:"key"` + Value []byte `json:"value"` + TtlSeconds int64 `json:"ttlSeconds"` +} + +// CacheSetBytesResponse is the response type for Cache.SetBytes. +type CacheSetBytesResponse struct { + Error string `json:"error,omitempty"` +} + +// CacheGetBytesRequest is the request type for Cache.GetBytes. +type CacheGetBytesRequest struct { + Key string `json:"key"` +} + +// CacheGetBytesResponse is the response type for Cache.GetBytes. +type CacheGetBytesResponse struct { + Value []byte `json:"value,omitempty"` + Exists bool `json:"exists,omitempty"` + Error string `json:"error,omitempty"` +} + +// CacheHasRequest is the request type for Cache.Has. +type CacheHasRequest struct { + Key string `json:"key"` +} + +// CacheHasResponse is the response type for Cache.Has. +type CacheHasResponse struct { + Exists bool `json:"exists,omitempty"` + Error string `json:"error,omitempty"` +} + +// CacheRemoveRequest is the request type for Cache.Remove. +type CacheRemoveRequest struct { + Key string `json:"key"` +} + +// CacheRemoveResponse is the response type for Cache.Remove. +type CacheRemoveResponse struct { + Error string `json:"error,omitempty"` +} + +// RegisterCacheHostFunctions registers Cache service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterCacheHostFunctions(service CacheService) []extism.HostFunction { + return []extism.HostFunction{ + newCacheSetStringHostFunction(service), + newCacheGetStringHostFunction(service), + newCacheSetIntHostFunction(service), + newCacheGetIntHostFunction(service), + newCacheSetFloatHostFunction(service), + newCacheGetFloatHostFunction(service), + newCacheSetBytesHostFunction(service), + newCacheGetBytesHostFunction(service), + newCacheHasHostFunction(service), + newCacheRemoveHostFunction(service), + } +} + +func newCacheSetStringHostFunction(service CacheService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "cache_setstring", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + cacheWriteError(p, stack, err) + return + } + var req CacheSetStringRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + cacheWriteError(p, stack, err) + return + } + + // Call the service method + if svcErr := service.SetString(ctx, req.Key, req.Value, req.TtlSeconds); svcErr != nil { + cacheWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := CacheSetStringResponse{} + cacheWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newCacheGetStringHostFunction(service CacheService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "cache_getstring", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + cacheWriteError(p, stack, err) + return + } + var req CacheGetStringRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + cacheWriteError(p, stack, err) + return + } + + // Call the service method + value, exists, svcErr := service.GetString(ctx, req.Key) + if svcErr != nil { + cacheWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := CacheGetStringResponse{ + Value: value, + Exists: exists, + } + cacheWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newCacheSetIntHostFunction(service CacheService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "cache_setint", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + cacheWriteError(p, stack, err) + return + } + var req CacheSetIntRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + cacheWriteError(p, stack, err) + return + } + + // Call the service method + if svcErr := service.SetInt(ctx, req.Key, req.Value, req.TtlSeconds); svcErr != nil { + cacheWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := CacheSetIntResponse{} + cacheWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newCacheGetIntHostFunction(service CacheService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "cache_getint", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + cacheWriteError(p, stack, err) + return + } + var req CacheGetIntRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + cacheWriteError(p, stack, err) + return + } + + // Call the service method + value, exists, svcErr := service.GetInt(ctx, req.Key) + if svcErr != nil { + cacheWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := CacheGetIntResponse{ + Value: value, + Exists: exists, + } + cacheWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newCacheSetFloatHostFunction(service CacheService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "cache_setfloat", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + cacheWriteError(p, stack, err) + return + } + var req CacheSetFloatRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + cacheWriteError(p, stack, err) + return + } + + // Call the service method + if svcErr := service.SetFloat(ctx, req.Key, req.Value, req.TtlSeconds); svcErr != nil { + cacheWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := CacheSetFloatResponse{} + cacheWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newCacheGetFloatHostFunction(service CacheService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "cache_getfloat", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + cacheWriteError(p, stack, err) + return + } + var req CacheGetFloatRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + cacheWriteError(p, stack, err) + return + } + + // Call the service method + value, exists, svcErr := service.GetFloat(ctx, req.Key) + if svcErr != nil { + cacheWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := CacheGetFloatResponse{ + Value: value, + Exists: exists, + } + cacheWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newCacheSetBytesHostFunction(service CacheService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "cache_setbytes", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + cacheWriteError(p, stack, err) + return + } + var req CacheSetBytesRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + cacheWriteError(p, stack, err) + return + } + + // Call the service method + if svcErr := service.SetBytes(ctx, req.Key, req.Value, req.TtlSeconds); svcErr != nil { + cacheWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := CacheSetBytesResponse{} + cacheWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newCacheGetBytesHostFunction(service CacheService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "cache_getbytes", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + cacheWriteError(p, stack, err) + return + } + var req CacheGetBytesRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + cacheWriteError(p, stack, err) + return + } + + // Call the service method + value, exists, svcErr := service.GetBytes(ctx, req.Key) + if svcErr != nil { + cacheWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := CacheGetBytesResponse{ + Value: value, + Exists: exists, + } + cacheWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newCacheHasHostFunction(service CacheService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "cache_has", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + cacheWriteError(p, stack, err) + return + } + var req CacheHasRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + cacheWriteError(p, stack, err) + return + } + + // Call the service method + exists, svcErr := service.Has(ctx, req.Key) + if svcErr != nil { + cacheWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := CacheHasResponse{ + Exists: exists, + } + cacheWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newCacheRemoveHostFunction(service CacheService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "cache_remove", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + cacheWriteError(p, stack, err) + return + } + var req CacheRemoveRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + cacheWriteError(p, stack, err) + return + } + + // Call the service method + if svcErr := service.Remove(ctx, req.Key); svcErr != nil { + cacheWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := CacheRemoveResponse{} + cacheWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// cacheWriteResponse writes a JSON response to plugin memory. +func cacheWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + cacheWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// cacheWriteError writes an error response to plugin memory. +func cacheWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/host/config.go b/plugins/host/config.go new file mode 100644 index 000000000..0a0a62ca7 --- /dev/null +++ b/plugins/host/config.go @@ -0,0 +1,44 @@ +package host + +import "context" + +// ConfigService provides access to plugin configuration values. +// +// This service allows plugins to retrieve configuration values and enumerate +// available configuration keys. Unlike the built-in pdk.GetConfig(key) which +// only retrieves individual values, this service provides methods to list all +// available keys, making it useful for plugins that need to discover dynamic +// configuration (e.g., user-to-token mappings). +// +// This service is always available and does not require a permission in the manifest. +// +//nd:hostservice name=Config +type ConfigService interface { + // Get retrieves a configuration value as a string. + // + // Parameters: + // - key: The configuration key + // + // Returns the value and whether the key exists. + //nd:hostfunc + Get(ctx context.Context, key string) (value string, exists bool) + + // GetInt retrieves a configuration value as an integer. + // + // Parameters: + // - key: The configuration key + // + // Returns the value and whether the key exists. If the key exists but the + // value cannot be parsed as an integer, exists will be false. + //nd:hostfunc + GetInt(ctx context.Context, key string) (value int64, exists bool) + + // Keys returns configuration keys matching the given prefix. + // + // Parameters: + // - prefix: Key prefix to filter by. If empty, returns all keys. + // + // Returns a sorted slice of matching configuration keys. + //nd:hostfunc + Keys(ctx context.Context, prefix string) (keys []string) +} diff --git a/plugins/host/config/config.pb.go b/plugins/host/config/config.pb.go deleted file mode 100644 index dfc70af19..000000000 --- a/plugins/host/config/config.pb.go +++ /dev/null @@ -1,54 +0,0 @@ -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: host/config/config.proto - -package config - -import ( - context "context" - protoreflect "google.golang.org/protobuf/reflect/protoreflect" - protoimpl "google.golang.org/protobuf/runtime/protoimpl" -) - -const ( - // Verify that this generated code is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion) - // Verify that runtime/protoimpl is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) -) - -type GetPluginConfigRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields -} - -func (x *GetPluginConfigRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -type GetPluginConfigResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Config map[string]string `protobuf:"bytes,1,rep,name=config,proto3" json:"config,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"` -} - -func (x *GetPluginConfigResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *GetPluginConfigResponse) GetConfig() map[string]string { - if x != nil { - return x.Config - } - return nil -} - -// go:plugin type=host version=1 -type ConfigService interface { - GetPluginConfig(context.Context, *GetPluginConfigRequest) (*GetPluginConfigResponse, error) -} diff --git a/plugins/host/config/config.proto b/plugins/host/config/config.proto deleted file mode 100644 index 76076b47b..000000000 --- a/plugins/host/config/config.proto +++ /dev/null @@ -1,18 +0,0 @@ -syntax = "proto3"; - -package config; - -option go_package = "github.com/navidrome/navidrome/plugins/host/config;config"; - -// go:plugin type=host version=1 -service ConfigService { - rpc GetPluginConfig(GetPluginConfigRequest) returns (GetPluginConfigResponse); -} - -message GetPluginConfigRequest { - // No fields needed; plugin name is inferred from context -} - -message GetPluginConfigResponse { - map<string, string> config = 1; -} \ No newline at end of file diff --git a/plugins/host/config/config_host.pb.go b/plugins/host/config/config_host.pb.go deleted file mode 100644 index 87894f1a2..000000000 --- a/plugins/host/config/config_host.pb.go +++ /dev/null @@ -1,66 +0,0 @@ -//go:build !wasip1 - -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: host/config/config.proto - -package config - -import ( - context "context" - wasm "github.com/knqyf263/go-plugin/wasm" - wazero "github.com/tetratelabs/wazero" - api "github.com/tetratelabs/wazero/api" -) - -const ( - i32 = api.ValueTypeI32 - i64 = api.ValueTypeI64 -) - -type _configService struct { - ConfigService -} - -// Instantiate a Go-defined module named "env" that exports host functions. -func Instantiate(ctx context.Context, r wazero.Runtime, hostFunctions ConfigService) error { - envBuilder := r.NewHostModuleBuilder("env") - h := _configService{hostFunctions} - - envBuilder.NewFunctionBuilder(). - WithGoModuleFunction(api.GoModuleFunc(h._GetPluginConfig), []api.ValueType{i32, i32}, []api.ValueType{i64}). - WithParameterNames("offset", "size"). - Export("get_plugin_config") - - _, err := envBuilder.Instantiate(ctx) - return err -} - -func (h _configService) _GetPluginConfig(ctx context.Context, m api.Module, stack []uint64) { - offset, size := uint32(stack[0]), uint32(stack[1]) - buf, err := wasm.ReadMemory(m.Memory(), offset, size) - if err != nil { - panic(err) - } - request := new(GetPluginConfigRequest) - err = request.UnmarshalVT(buf) - if err != nil { - panic(err) - } - resp, err := h.GetPluginConfig(ctx, request) - if err != nil { - panic(err) - } - buf, err = resp.MarshalVT() - if err != nil { - panic(err) - } - ptr, err := wasm.WriteMemory(ctx, m, buf) - if err != nil { - panic(err) - } - ptrLen := (ptr << uint64(32)) | uint64(len(buf)) - stack[0] = ptrLen -} diff --git a/plugins/host/config/config_plugin.pb.go b/plugins/host/config/config_plugin.pb.go deleted file mode 100644 index 45c60d13a..000000000 --- a/plugins/host/config/config_plugin.pb.go +++ /dev/null @@ -1,44 +0,0 @@ -//go:build wasip1 - -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: host/config/config.proto - -package config - -import ( - context "context" - wasm "github.com/knqyf263/go-plugin/wasm" - _ "unsafe" -) - -type configService struct{} - -func NewConfigService() ConfigService { - return configService{} -} - -//go:wasmimport env get_plugin_config -func _get_plugin_config(ptr uint32, size uint32) uint64 - -func (h configService) GetPluginConfig(ctx context.Context, request *GetPluginConfigRequest) (*GetPluginConfigResponse, error) { - buf, err := request.MarshalVT() - if err != nil { - return nil, err - } - ptr, size := wasm.ByteToPtr(buf) - ptrSize := _get_plugin_config(ptr, size) - wasm.Free(ptr) - - ptr = uint32(ptrSize >> 32) - size = uint32(ptrSize) - buf = wasm.PtrToByte(ptr, size) - - response := new(GetPluginConfigResponse) - if err = response.UnmarshalVT(buf); err != nil { - return nil, err - } - return response, nil -} diff --git a/plugins/host/config/config_plugin_dev.go b/plugins/host/config/config_plugin_dev.go deleted file mode 100644 index dddbc9ceb..000000000 --- a/plugins/host/config/config_plugin_dev.go +++ /dev/null @@ -1,7 +0,0 @@ -//go:build !wasip1 - -package config - -func NewConfigService() ConfigService { - panic("not implemented") -} diff --git a/plugins/host/config/config_vtproto.pb.go b/plugins/host/config/config_vtproto.pb.go deleted file mode 100644 index 295da164d..000000000 --- a/plugins/host/config/config_vtproto.pb.go +++ /dev/null @@ -1,466 +0,0 @@ -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: host/config/config.proto - -package config - -import ( - fmt "fmt" - protoimpl "google.golang.org/protobuf/runtime/protoimpl" - io "io" - bits "math/bits" -) - -const ( - // Verify that this generated code is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion) - // Verify that runtime/protoimpl is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) -) - -func (m *GetPluginConfigRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *GetPluginConfigRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *GetPluginConfigRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - return len(dAtA) - i, nil -} - -func (m *GetPluginConfigResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *GetPluginConfigResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *GetPluginConfigResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Config) > 0 { - for k := range m.Config { - v := m.Config[k] - baseI := i - i -= len(v) - copy(dAtA[i:], v) - i = encodeVarint(dAtA, i, uint64(len(v))) - i-- - dAtA[i] = 0x12 - i -= len(k) - copy(dAtA[i:], k) - i = encodeVarint(dAtA, i, uint64(len(k))) - i-- - dAtA[i] = 0xa - i = encodeVarint(dAtA, i, uint64(baseI-i)) - i-- - dAtA[i] = 0xa - } - } - return len(dAtA) - i, nil -} - -func encodeVarint(dAtA []byte, offset int, v uint64) int { - offset -= sov(v) - base := offset - for v >= 1<<7 { - dAtA[offset] = uint8(v&0x7f | 0x80) - v >>= 7 - offset++ - } - dAtA[offset] = uint8(v) - return base -} -func (m *GetPluginConfigRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - n += len(m.unknownFields) - return n -} - -func (m *GetPluginConfigResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - if len(m.Config) > 0 { - for k, v := range m.Config { - _ = k - _ = v - mapEntrySize := 1 + len(k) + sov(uint64(len(k))) + 1 + len(v) + sov(uint64(len(v))) - n += mapEntrySize + 1 + sov(uint64(mapEntrySize)) - } - } - n += len(m.unknownFields) - return n -} - -func sov(x uint64) (n int) { - return (bits.Len64(x|1) + 6) / 7 -} -func soz(x uint64) (n int) { - return sov(uint64((x << 1) ^ uint64((int64(x) >> 63)))) -} -func (m *GetPluginConfigRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: GetPluginConfigRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: GetPluginConfigRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *GetPluginConfigResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: GetPluginConfigResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: GetPluginConfigResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Config", wireType) - } - var msglen int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - msglen |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - if msglen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + msglen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - if m.Config == nil { - m.Config = make(map[string]string) - } - var mapkey string - var mapvalue string - for iNdEx < postIndex { - entryPreIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - if fieldNum == 1 { - var stringLenmapkey uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLenmapkey |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLenmapkey := int(stringLenmapkey) - if intStringLenmapkey < 0 { - return ErrInvalidLength - } - postStringIndexmapkey := iNdEx + intStringLenmapkey - if postStringIndexmapkey < 0 { - return ErrInvalidLength - } - if postStringIndexmapkey > l { - return io.ErrUnexpectedEOF - } - mapkey = string(dAtA[iNdEx:postStringIndexmapkey]) - iNdEx = postStringIndexmapkey - } else if fieldNum == 2 { - var stringLenmapvalue uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLenmapvalue |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLenmapvalue := int(stringLenmapvalue) - if intStringLenmapvalue < 0 { - return ErrInvalidLength - } - postStringIndexmapvalue := iNdEx + intStringLenmapvalue - if postStringIndexmapvalue < 0 { - return ErrInvalidLength - } - if postStringIndexmapvalue > l { - return io.ErrUnexpectedEOF - } - mapvalue = string(dAtA[iNdEx:postStringIndexmapvalue]) - iNdEx = postStringIndexmapvalue - } else { - iNdEx = entryPreIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > postIndex { - return io.ErrUnexpectedEOF - } - iNdEx += skippy - } - } - m.Config[mapkey] = mapvalue - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} - -func skip(dAtA []byte) (n int, err error) { - l := len(dAtA) - iNdEx := 0 - depth := 0 - for iNdEx < l { - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return 0, ErrIntOverflow - } - if iNdEx >= l { - return 0, io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= (uint64(b) & 0x7F) << shift - if b < 0x80 { - break - } - } - wireType := int(wire & 0x7) - switch wireType { - case 0: - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return 0, ErrIntOverflow - } - if iNdEx >= l { - return 0, io.ErrUnexpectedEOF - } - iNdEx++ - if dAtA[iNdEx-1] < 0x80 { - break - } - } - case 1: - iNdEx += 8 - case 2: - var length int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return 0, ErrIntOverflow - } - if iNdEx >= l { - return 0, io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - length |= (int(b) & 0x7F) << shift - if b < 0x80 { - break - } - } - if length < 0 { - return 0, ErrInvalidLength - } - iNdEx += length - case 3: - depth++ - case 4: - if depth == 0 { - return 0, ErrUnexpectedEndOfGroup - } - depth-- - case 5: - iNdEx += 4 - default: - return 0, fmt.Errorf("proto: illegal wireType %d", wireType) - } - if iNdEx < 0 { - return 0, ErrInvalidLength - } - if depth == 0 { - return iNdEx, nil - } - } - return 0, io.ErrUnexpectedEOF -} - -var ( - ErrInvalidLength = fmt.Errorf("proto: negative length found during unmarshaling") - ErrIntOverflow = fmt.Errorf("proto: integer overflow") - ErrUnexpectedEndOfGroup = fmt.Errorf("proto: unexpected end of group") -) diff --git a/plugins/host/config_gen.go b/plugins/host/config_gen.go new file mode 100644 index 000000000..0fd1b6ef4 --- /dev/null +++ b/plugins/host/config_gen.go @@ -0,0 +1,169 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package host + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// ConfigGetRequest is the request type for Config.Get. +type ConfigGetRequest struct { + Key string `json:"key"` +} + +// ConfigGetResponse is the response type for Config.Get. +type ConfigGetResponse struct { + Value string `json:"value,omitempty"` + Exists bool `json:"exists,omitempty"` +} + +// ConfigGetIntRequest is the request type for Config.GetInt. +type ConfigGetIntRequest struct { + Key string `json:"key"` +} + +// ConfigGetIntResponse is the response type for Config.GetInt. +type ConfigGetIntResponse struct { + Value int64 `json:"value,omitempty"` + Exists bool `json:"exists,omitempty"` +} + +// ConfigKeysRequest is the request type for Config.Keys. +type ConfigKeysRequest struct { + Prefix string `json:"prefix"` +} + +// ConfigKeysResponse is the response type for Config.Keys. +type ConfigKeysResponse struct { + Keys []string `json:"keys,omitempty"` +} + +// RegisterConfigHostFunctions registers Config service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterConfigHostFunctions(service ConfigService) []extism.HostFunction { + return []extism.HostFunction{ + newConfigGetHostFunction(service), + newConfigGetIntHostFunction(service), + newConfigKeysHostFunction(service), + } +} + +func newConfigGetHostFunction(service ConfigService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "config_get", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + configWriteError(p, stack, err) + return + } + var req ConfigGetRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + configWriteError(p, stack, err) + return + } + + // Call the service method + value, exists := service.Get(ctx, req.Key) + + // Write JSON response to plugin memory + resp := ConfigGetResponse{ + Value: value, + Exists: exists, + } + configWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newConfigGetIntHostFunction(service ConfigService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "config_getint", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + configWriteError(p, stack, err) + return + } + var req ConfigGetIntRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + configWriteError(p, stack, err) + return + } + + // Call the service method + value, exists := service.GetInt(ctx, req.Key) + + // Write JSON response to plugin memory + resp := ConfigGetIntResponse{ + Value: value, + Exists: exists, + } + configWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newConfigKeysHostFunction(service ConfigService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "config_keys", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + configWriteError(p, stack, err) + return + } + var req ConfigKeysRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + configWriteError(p, stack, err) + return + } + + // Call the service method + keys := service.Keys(ctx, req.Prefix) + + // Write JSON response to plugin memory + resp := ConfigKeysResponse{ + Keys: keys, + } + configWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// configWriteResponse writes a JSON response to plugin memory. +func configWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + configWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// configWriteError writes an error response to plugin memory. +func configWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/host/doc.go b/plugins/host/doc.go new file mode 100644 index 000000000..10e2b846b --- /dev/null +++ b/plugins/host/doc.go @@ -0,0 +1,39 @@ +// Package host provides host services that can be called by plugins via Extism host functions. +// +// Host services allow plugins to access Navidrome functionality like the Subsonic API, +// scheduler, and other internal services. Services are defined as Go interfaces with +// special annotations that enable automatic code generation of Extism host function wrappers. +// +// # Annotation Format +// +// Host services use Go doc comment annotations to mark interfaces and methods for code generation: +// +// // MyService provides some functionality. +// //nd:hostservice name=MyService permission=myservice +// type MyService interface { +// // DoSomething performs an action. +// //nd:hostfunc +// DoSomething(ctx context.Context, input string) (output string, err error) +// } +// +// Service-level annotations: +// - //nd:hostservice - Marks an interface as a host service +// - name=<ServiceName> - Service identifier used in generated code +// - permission=<key> - Manifest permission key (e.g., "subsonicapi", "scheduler") +// +// Method-level annotations: +// - //nd:hostfunc - Marks a method for host function wrapper generation +// - name=<CustomName> - Optional: override the export name +// +// # Generated Code +// +// The ndpgen tool reads annotated interfaces and generates Extism host function wrappers +// that handle: +// - JSON serialization/deserialization of request/response types +// - Memory operations (ReadBytes, WriteBytes, Alloc) +// - Error handling and propagation +// - Service registration functions +// +// Generated files follow the pattern <servicename>_gen.go and include a header comment +// indicating they should not be edited manually. +package host diff --git a/plugins/host/http.go b/plugins/host/http.go new file mode 100644 index 000000000..96e832a0e --- /dev/null +++ b/plugins/host/http.go @@ -0,0 +1,41 @@ +package host + +import "context" + +// HTTPRequest represents an outbound HTTP request from a plugin. +type HTTPRequest struct { + Method string `json:"method"` + URL string `json:"url"` + Headers map[string]string `json:"headers,omitempty"` + NoFollowRedirects bool `json:"noFollowRedirects,omitempty"` + Body []byte `json:"body,omitempty"` + TimeoutMs int32 `json:"timeoutMs,omitempty"` +} + +// HTTPResponse represents the response from an outbound HTTP request. +type HTTPResponse struct { + StatusCode int32 `json:"statusCode"` + Headers map[string]string `json:"headers,omitempty"` + Body []byte `json:"body,omitempty"` +} + +// HTTPService provides outbound HTTP request capabilities for plugins. +// +// This service allows plugins to make HTTP requests to external services. +// Requests are validated against the plugin's declared requiredHosts patterns +// from the http permission in the manifest. Redirects are followed but each +// redirect destination is also validated against the allowed hosts. +// +//nd:hostservice name=HTTP permission=http +type HTTPService interface { + // Send executes an HTTP request and returns the response. + // + // Parameters: + // - request: The HTTP request to execute, including method, URL, headers, body, and timeout + // + // Returns the HTTP response with status code, headers, and body. + // Network errors, timeouts, and permission failures are returned as Go errors. + // Successful HTTP calls (including 4xx/5xx status codes) return a non-nil response with nil error. + //nd:hostfunc + Send(ctx context.Context, request HTTPRequest) (*HTTPResponse, error) +} diff --git a/plugins/host/http/http.pb.go b/plugins/host/http/http.pb.go deleted file mode 100644 index 0bc2c5040..000000000 --- a/plugins/host/http/http.pb.go +++ /dev/null @@ -1,117 +0,0 @@ -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: host/http/http.proto - -package http - -import ( - context "context" - protoreflect "google.golang.org/protobuf/reflect/protoreflect" - protoimpl "google.golang.org/protobuf/runtime/protoimpl" -) - -const ( - // Verify that this generated code is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion) - // Verify that runtime/protoimpl is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) -) - -type HttpRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"` - Headers map[string]string `protobuf:"bytes,2,rep,name=headers,proto3" json:"headers,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"` - TimeoutMs int32 `protobuf:"varint,3,opt,name=timeout_ms,json=timeoutMs,proto3" json:"timeout_ms,omitempty"` - Body []byte `protobuf:"bytes,4,opt,name=body,proto3" json:"body,omitempty"` // Ignored for GET/DELETE/HEAD/OPTIONS -} - -func (x *HttpRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *HttpRequest) GetUrl() string { - if x != nil { - return x.Url - } - return "" -} - -func (x *HttpRequest) GetHeaders() map[string]string { - if x != nil { - return x.Headers - } - return nil -} - -func (x *HttpRequest) GetTimeoutMs() int32 { - if x != nil { - return x.TimeoutMs - } - return 0 -} - -func (x *HttpRequest) GetBody() []byte { - if x != nil { - return x.Body - } - return nil -} - -type HttpResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Status int32 `protobuf:"varint,1,opt,name=status,proto3" json:"status,omitempty"` - Body []byte `protobuf:"bytes,2,opt,name=body,proto3" json:"body,omitempty"` - Headers map[string]string `protobuf:"bytes,3,rep,name=headers,proto3" json:"headers,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"` - Error string `protobuf:"bytes,4,opt,name=error,proto3" json:"error,omitempty"` // Non-empty if network/protocol error -} - -func (x *HttpResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *HttpResponse) GetStatus() int32 { - if x != nil { - return x.Status - } - return 0 -} - -func (x *HttpResponse) GetBody() []byte { - if x != nil { - return x.Body - } - return nil -} - -func (x *HttpResponse) GetHeaders() map[string]string { - if x != nil { - return x.Headers - } - return nil -} - -func (x *HttpResponse) GetError() string { - if x != nil { - return x.Error - } - return "" -} - -// go:plugin type=host version=1 -type HttpService interface { - Get(context.Context, *HttpRequest) (*HttpResponse, error) - Post(context.Context, *HttpRequest) (*HttpResponse, error) - Put(context.Context, *HttpRequest) (*HttpResponse, error) - Delete(context.Context, *HttpRequest) (*HttpResponse, error) - Patch(context.Context, *HttpRequest) (*HttpResponse, error) - Head(context.Context, *HttpRequest) (*HttpResponse, error) - Options(context.Context, *HttpRequest) (*HttpResponse, error) -} diff --git a/plugins/host/http/http.proto b/plugins/host/http/http.proto deleted file mode 100644 index 2ed7a4262..000000000 --- a/plugins/host/http/http.proto +++ /dev/null @@ -1,30 +0,0 @@ -syntax = "proto3"; - -package http; - -option go_package = "github.com/navidrome/navidrome/plugins/host/http;http"; - -// go:plugin type=host version=1 -service HttpService { - rpc Get(HttpRequest) returns (HttpResponse); - rpc Post(HttpRequest) returns (HttpResponse); - rpc Put(HttpRequest) returns (HttpResponse); - rpc Delete(HttpRequest) returns (HttpResponse); - rpc Patch(HttpRequest) returns (HttpResponse); - rpc Head(HttpRequest) returns (HttpResponse); - rpc Options(HttpRequest) returns (HttpResponse); -} - -message HttpRequest { - string url = 1; - map<string, string> headers = 2; - int32 timeout_ms = 3; - bytes body = 4; // Ignored for GET/DELETE/HEAD/OPTIONS -} - -message HttpResponse { - int32 status = 1; - bytes body = 2; - map<string, string> headers = 3; - string error = 4; // Non-empty if network/protocol error -} \ No newline at end of file diff --git a/plugins/host/http/http_host.pb.go b/plugins/host/http/http_host.pb.go deleted file mode 100644 index 326aba508..000000000 --- a/plugins/host/http/http_host.pb.go +++ /dev/null @@ -1,258 +0,0 @@ -//go:build !wasip1 - -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: host/http/http.proto - -package http - -import ( - context "context" - wasm "github.com/knqyf263/go-plugin/wasm" - wazero "github.com/tetratelabs/wazero" - api "github.com/tetratelabs/wazero/api" -) - -const ( - i32 = api.ValueTypeI32 - i64 = api.ValueTypeI64 -) - -type _httpService struct { - HttpService -} - -// Instantiate a Go-defined module named "env" that exports host functions. -func Instantiate(ctx context.Context, r wazero.Runtime, hostFunctions HttpService) error { - envBuilder := r.NewHostModuleBuilder("env") - h := _httpService{hostFunctions} - - envBuilder.NewFunctionBuilder(). - WithGoModuleFunction(api.GoModuleFunc(h._Get), []api.ValueType{i32, i32}, []api.ValueType{i64}). - WithParameterNames("offset", "size"). - Export("get") - - envBuilder.NewFunctionBuilder(). - WithGoModuleFunction(api.GoModuleFunc(h._Post), []api.ValueType{i32, i32}, []api.ValueType{i64}). - WithParameterNames("offset", "size"). - Export("post") - - envBuilder.NewFunctionBuilder(). - WithGoModuleFunction(api.GoModuleFunc(h._Put), []api.ValueType{i32, i32}, []api.ValueType{i64}). - WithParameterNames("offset", "size"). - Export("put") - - envBuilder.NewFunctionBuilder(). - WithGoModuleFunction(api.GoModuleFunc(h._Delete), []api.ValueType{i32, i32}, []api.ValueType{i64}). - WithParameterNames("offset", "size"). - Export("delete") - - envBuilder.NewFunctionBuilder(). - WithGoModuleFunction(api.GoModuleFunc(h._Patch), []api.ValueType{i32, i32}, []api.ValueType{i64}). - WithParameterNames("offset", "size"). - Export("patch") - - envBuilder.NewFunctionBuilder(). - WithGoModuleFunction(api.GoModuleFunc(h._Head), []api.ValueType{i32, i32}, []api.ValueType{i64}). - WithParameterNames("offset", "size"). - Export("head") - - envBuilder.NewFunctionBuilder(). - WithGoModuleFunction(api.GoModuleFunc(h._Options), []api.ValueType{i32, i32}, []api.ValueType{i64}). - WithParameterNames("offset", "size"). - Export("options") - - _, err := envBuilder.Instantiate(ctx) - return err -} - -func (h _httpService) _Get(ctx context.Context, m api.Module, stack []uint64) { - offset, size := uint32(stack[0]), uint32(stack[1]) - buf, err := wasm.ReadMemory(m.Memory(), offset, size) - if err != nil { - panic(err) - } - request := new(HttpRequest) - err = request.UnmarshalVT(buf) - if err != nil { - panic(err) - } - resp, err := h.Get(ctx, request) - if err != nil { - panic(err) - } - buf, err = resp.MarshalVT() - if err != nil { - panic(err) - } - ptr, err := wasm.WriteMemory(ctx, m, buf) - if err != nil { - panic(err) - } - ptrLen := (ptr << uint64(32)) | uint64(len(buf)) - stack[0] = ptrLen -} - -func (h _httpService) _Post(ctx context.Context, m api.Module, stack []uint64) { - offset, size := uint32(stack[0]), uint32(stack[1]) - buf, err := wasm.ReadMemory(m.Memory(), offset, size) - if err != nil { - panic(err) - } - request := new(HttpRequest) - err = request.UnmarshalVT(buf) - if err != nil { - panic(err) - } - resp, err := h.Post(ctx, request) - if err != nil { - panic(err) - } - buf, err = resp.MarshalVT() - if err != nil { - panic(err) - } - ptr, err := wasm.WriteMemory(ctx, m, buf) - if err != nil { - panic(err) - } - ptrLen := (ptr << uint64(32)) | uint64(len(buf)) - stack[0] = ptrLen -} - -func (h _httpService) _Put(ctx context.Context, m api.Module, stack []uint64) { - offset, size := uint32(stack[0]), uint32(stack[1]) - buf, err := wasm.ReadMemory(m.Memory(), offset, size) - if err != nil { - panic(err) - } - request := new(HttpRequest) - err = request.UnmarshalVT(buf) - if err != nil { - panic(err) - } - resp, err := h.Put(ctx, request) - if err != nil { - panic(err) - } - buf, err = resp.MarshalVT() - if err != nil { - panic(err) - } - ptr, err := wasm.WriteMemory(ctx, m, buf) - if err != nil { - panic(err) - } - ptrLen := (ptr << uint64(32)) | uint64(len(buf)) - stack[0] = ptrLen -} - -func (h _httpService) _Delete(ctx context.Context, m api.Module, stack []uint64) { - offset, size := uint32(stack[0]), uint32(stack[1]) - buf, err := wasm.ReadMemory(m.Memory(), offset, size) - if err != nil { - panic(err) - } - request := new(HttpRequest) - err = request.UnmarshalVT(buf) - if err != nil { - panic(err) - } - resp, err := h.Delete(ctx, request) - if err != nil { - panic(err) - } - buf, err = resp.MarshalVT() - if err != nil { - panic(err) - } - ptr, err := wasm.WriteMemory(ctx, m, buf) - if err != nil { - panic(err) - } - ptrLen := (ptr << uint64(32)) | uint64(len(buf)) - stack[0] = ptrLen -} - -func (h _httpService) _Patch(ctx context.Context, m api.Module, stack []uint64) { - offset, size := uint32(stack[0]), uint32(stack[1]) - buf, err := wasm.ReadMemory(m.Memory(), offset, size) - if err != nil { - panic(err) - } - request := new(HttpRequest) - err = request.UnmarshalVT(buf) - if err != nil { - panic(err) - } - resp, err := h.Patch(ctx, request) - if err != nil { - panic(err) - } - buf, err = resp.MarshalVT() - if err != nil { - panic(err) - } - ptr, err := wasm.WriteMemory(ctx, m, buf) - if err != nil { - panic(err) - } - ptrLen := (ptr << uint64(32)) | uint64(len(buf)) - stack[0] = ptrLen -} - -func (h _httpService) _Head(ctx context.Context, m api.Module, stack []uint64) { - offset, size := uint32(stack[0]), uint32(stack[1]) - buf, err := wasm.ReadMemory(m.Memory(), offset, size) - if err != nil { - panic(err) - } - request := new(HttpRequest) - err = request.UnmarshalVT(buf) - if err != nil { - panic(err) - } - resp, err := h.Head(ctx, request) - if err != nil { - panic(err) - } - buf, err = resp.MarshalVT() - if err != nil { - panic(err) - } - ptr, err := wasm.WriteMemory(ctx, m, buf) - if err != nil { - panic(err) - } - ptrLen := (ptr << uint64(32)) | uint64(len(buf)) - stack[0] = ptrLen -} - -func (h _httpService) _Options(ctx context.Context, m api.Module, stack []uint64) { - offset, size := uint32(stack[0]), uint32(stack[1]) - buf, err := wasm.ReadMemory(m.Memory(), offset, size) - if err != nil { - panic(err) - } - request := new(HttpRequest) - err = request.UnmarshalVT(buf) - if err != nil { - panic(err) - } - resp, err := h.Options(ctx, request) - if err != nil { - panic(err) - } - buf, err = resp.MarshalVT() - if err != nil { - panic(err) - } - ptr, err := wasm.WriteMemory(ctx, m, buf) - if err != nil { - panic(err) - } - ptrLen := (ptr << uint64(32)) | uint64(len(buf)) - stack[0] = ptrLen -} diff --git a/plugins/host/http/http_plugin.pb.go b/plugins/host/http/http_plugin.pb.go deleted file mode 100644 index 2e8c21891..000000000 --- a/plugins/host/http/http_plugin.pb.go +++ /dev/null @@ -1,182 +0,0 @@ -//go:build wasip1 - -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: host/http/http.proto - -package http - -import ( - context "context" - wasm "github.com/knqyf263/go-plugin/wasm" - _ "unsafe" -) - -type httpService struct{} - -func NewHttpService() HttpService { - return httpService{} -} - -//go:wasmimport env get -func _get(ptr uint32, size uint32) uint64 - -func (h httpService) Get(ctx context.Context, request *HttpRequest) (*HttpResponse, error) { - buf, err := request.MarshalVT() - if err != nil { - return nil, err - } - ptr, size := wasm.ByteToPtr(buf) - ptrSize := _get(ptr, size) - wasm.Free(ptr) - - ptr = uint32(ptrSize >> 32) - size = uint32(ptrSize) - buf = wasm.PtrToByte(ptr, size) - - response := new(HttpResponse) - if err = response.UnmarshalVT(buf); err != nil { - return nil, err - } - return response, nil -} - -//go:wasmimport env post -func _post(ptr uint32, size uint32) uint64 - -func (h httpService) Post(ctx context.Context, request *HttpRequest) (*HttpResponse, error) { - buf, err := request.MarshalVT() - if err != nil { - return nil, err - } - ptr, size := wasm.ByteToPtr(buf) - ptrSize := _post(ptr, size) - wasm.Free(ptr) - - ptr = uint32(ptrSize >> 32) - size = uint32(ptrSize) - buf = wasm.PtrToByte(ptr, size) - - response := new(HttpResponse) - if err = response.UnmarshalVT(buf); err != nil { - return nil, err - } - return response, nil -} - -//go:wasmimport env put -func _put(ptr uint32, size uint32) uint64 - -func (h httpService) Put(ctx context.Context, request *HttpRequest) (*HttpResponse, error) { - buf, err := request.MarshalVT() - if err != nil { - return nil, err - } - ptr, size := wasm.ByteToPtr(buf) - ptrSize := _put(ptr, size) - wasm.Free(ptr) - - ptr = uint32(ptrSize >> 32) - size = uint32(ptrSize) - buf = wasm.PtrToByte(ptr, size) - - response := new(HttpResponse) - if err = response.UnmarshalVT(buf); err != nil { - return nil, err - } - return response, nil -} - -//go:wasmimport env delete -func _delete(ptr uint32, size uint32) uint64 - -func (h httpService) Delete(ctx context.Context, request *HttpRequest) (*HttpResponse, error) { - buf, err := request.MarshalVT() - if err != nil { - return nil, err - } - ptr, size := wasm.ByteToPtr(buf) - ptrSize := _delete(ptr, size) - wasm.Free(ptr) - - ptr = uint32(ptrSize >> 32) - size = uint32(ptrSize) - buf = wasm.PtrToByte(ptr, size) - - response := new(HttpResponse) - if err = response.UnmarshalVT(buf); err != nil { - return nil, err - } - return response, nil -} - -//go:wasmimport env patch -func _patch(ptr uint32, size uint32) uint64 - -func (h httpService) Patch(ctx context.Context, request *HttpRequest) (*HttpResponse, error) { - buf, err := request.MarshalVT() - if err != nil { - return nil, err - } - ptr, size := wasm.ByteToPtr(buf) - ptrSize := _patch(ptr, size) - wasm.Free(ptr) - - ptr = uint32(ptrSize >> 32) - size = uint32(ptrSize) - buf = wasm.PtrToByte(ptr, size) - - response := new(HttpResponse) - if err = response.UnmarshalVT(buf); err != nil { - return nil, err - } - return response, nil -} - -//go:wasmimport env head -func _head(ptr uint32, size uint32) uint64 - -func (h httpService) Head(ctx context.Context, request *HttpRequest) (*HttpResponse, error) { - buf, err := request.MarshalVT() - if err != nil { - return nil, err - } - ptr, size := wasm.ByteToPtr(buf) - ptrSize := _head(ptr, size) - wasm.Free(ptr) - - ptr = uint32(ptrSize >> 32) - size = uint32(ptrSize) - buf = wasm.PtrToByte(ptr, size) - - response := new(HttpResponse) - if err = response.UnmarshalVT(buf); err != nil { - return nil, err - } - return response, nil -} - -//go:wasmimport env options -func _options(ptr uint32, size uint32) uint64 - -func (h httpService) Options(ctx context.Context, request *HttpRequest) (*HttpResponse, error) { - buf, err := request.MarshalVT() - if err != nil { - return nil, err - } - ptr, size := wasm.ByteToPtr(buf) - ptrSize := _options(ptr, size) - wasm.Free(ptr) - - ptr = uint32(ptrSize >> 32) - size = uint32(ptrSize) - buf = wasm.PtrToByte(ptr, size) - - response := new(HttpResponse) - if err = response.UnmarshalVT(buf); err != nil { - return nil, err - } - return response, nil -} diff --git a/plugins/host/http/http_plugin_dev.go b/plugins/host/http/http_plugin_dev.go deleted file mode 100644 index 04e3c2508..000000000 --- a/plugins/host/http/http_plugin_dev.go +++ /dev/null @@ -1,7 +0,0 @@ -//go:build !wasip1 - -package http - -func NewHttpService() HttpService { - panic("not implemented") -} diff --git a/plugins/host/http/http_vtproto.pb.go b/plugins/host/http/http_vtproto.pb.go deleted file mode 100644 index 064fdb08a..000000000 --- a/plugins/host/http/http_vtproto.pb.go +++ /dev/null @@ -1,850 +0,0 @@ -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: host/http/http.proto - -package http - -import ( - fmt "fmt" - protoimpl "google.golang.org/protobuf/runtime/protoimpl" - io "io" - bits "math/bits" -) - -const ( - // Verify that this generated code is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion) - // Verify that runtime/protoimpl is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) -) - -func (m *HttpRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *HttpRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *HttpRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Body) > 0 { - i -= len(m.Body) - copy(dAtA[i:], m.Body) - i = encodeVarint(dAtA, i, uint64(len(m.Body))) - i-- - dAtA[i] = 0x22 - } - if m.TimeoutMs != 0 { - i = encodeVarint(dAtA, i, uint64(m.TimeoutMs)) - i-- - dAtA[i] = 0x18 - } - if len(m.Headers) > 0 { - for k := range m.Headers { - v := m.Headers[k] - baseI := i - i -= len(v) - copy(dAtA[i:], v) - i = encodeVarint(dAtA, i, uint64(len(v))) - i-- - dAtA[i] = 0x12 - i -= len(k) - copy(dAtA[i:], k) - i = encodeVarint(dAtA, i, uint64(len(k))) - i-- - dAtA[i] = 0xa - i = encodeVarint(dAtA, i, uint64(baseI-i)) - i-- - dAtA[i] = 0x12 - } - } - if len(m.Url) > 0 { - i -= len(m.Url) - copy(dAtA[i:], m.Url) - i = encodeVarint(dAtA, i, uint64(len(m.Url))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *HttpResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *HttpResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *HttpResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Error) > 0 { - i -= len(m.Error) - copy(dAtA[i:], m.Error) - i = encodeVarint(dAtA, i, uint64(len(m.Error))) - i-- - dAtA[i] = 0x22 - } - if len(m.Headers) > 0 { - for k := range m.Headers { - v := m.Headers[k] - baseI := i - i -= len(v) - copy(dAtA[i:], v) - i = encodeVarint(dAtA, i, uint64(len(v))) - i-- - dAtA[i] = 0x12 - i -= len(k) - copy(dAtA[i:], k) - i = encodeVarint(dAtA, i, uint64(len(k))) - i-- - dAtA[i] = 0xa - i = encodeVarint(dAtA, i, uint64(baseI-i)) - i-- - dAtA[i] = 0x1a - } - } - if len(m.Body) > 0 { - i -= len(m.Body) - copy(dAtA[i:], m.Body) - i = encodeVarint(dAtA, i, uint64(len(m.Body))) - i-- - dAtA[i] = 0x12 - } - if m.Status != 0 { - i = encodeVarint(dAtA, i, uint64(m.Status)) - i-- - dAtA[i] = 0x8 - } - return len(dAtA) - i, nil -} - -func encodeVarint(dAtA []byte, offset int, v uint64) int { - offset -= sov(v) - base := offset - for v >= 1<<7 { - dAtA[offset] = uint8(v&0x7f | 0x80) - v >>= 7 - offset++ - } - dAtA[offset] = uint8(v) - return base -} -func (m *HttpRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Url) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - if len(m.Headers) > 0 { - for k, v := range m.Headers { - _ = k - _ = v - mapEntrySize := 1 + len(k) + sov(uint64(len(k))) + 1 + len(v) + sov(uint64(len(v))) - n += mapEntrySize + 1 + sov(uint64(mapEntrySize)) - } - } - if m.TimeoutMs != 0 { - n += 1 + sov(uint64(m.TimeoutMs)) - } - l = len(m.Body) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *HttpResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - if m.Status != 0 { - n += 1 + sov(uint64(m.Status)) - } - l = len(m.Body) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - if len(m.Headers) > 0 { - for k, v := range m.Headers { - _ = k - _ = v - mapEntrySize := 1 + len(k) + sov(uint64(len(k))) + 1 + len(v) + sov(uint64(len(v))) - n += mapEntrySize + 1 + sov(uint64(mapEntrySize)) - } - } - l = len(m.Error) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func sov(x uint64) (n int) { - return (bits.Len64(x|1) + 6) / 7 -} -func soz(x uint64) (n int) { - return sov(uint64((x << 1) ^ uint64((int64(x) >> 63)))) -} -func (m *HttpRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: HttpRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: HttpRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Url", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Url = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Headers", wireType) - } - var msglen int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - msglen |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - if msglen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + msglen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - if m.Headers == nil { - m.Headers = make(map[string]string) - } - var mapkey string - var mapvalue string - for iNdEx < postIndex { - entryPreIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - if fieldNum == 1 { - var stringLenmapkey uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLenmapkey |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLenmapkey := int(stringLenmapkey) - if intStringLenmapkey < 0 { - return ErrInvalidLength - } - postStringIndexmapkey := iNdEx + intStringLenmapkey - if postStringIndexmapkey < 0 { - return ErrInvalidLength - } - if postStringIndexmapkey > l { - return io.ErrUnexpectedEOF - } - mapkey = string(dAtA[iNdEx:postStringIndexmapkey]) - iNdEx = postStringIndexmapkey - } else if fieldNum == 2 { - var stringLenmapvalue uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLenmapvalue |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLenmapvalue := int(stringLenmapvalue) - if intStringLenmapvalue < 0 { - return ErrInvalidLength - } - postStringIndexmapvalue := iNdEx + intStringLenmapvalue - if postStringIndexmapvalue < 0 { - return ErrInvalidLength - } - if postStringIndexmapvalue > l { - return io.ErrUnexpectedEOF - } - mapvalue = string(dAtA[iNdEx:postStringIndexmapvalue]) - iNdEx = postStringIndexmapvalue - } else { - iNdEx = entryPreIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > postIndex { - return io.ErrUnexpectedEOF - } - iNdEx += skippy - } - } - m.Headers[mapkey] = mapvalue - iNdEx = postIndex - case 3: - if wireType != 0 { - return fmt.Errorf("proto: wrong wireType = %d for field TimeoutMs", wireType) - } - m.TimeoutMs = 0 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - m.TimeoutMs |= int32(b&0x7F) << shift - if b < 0x80 { - break - } - } - case 4: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Body", wireType) - } - var byteLen int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - byteLen |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - if byteLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + byteLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Body = append(m.Body[:0], dAtA[iNdEx:postIndex]...) - if m.Body == nil { - m.Body = []byte{} - } - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *HttpResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: HttpResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: HttpResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 0 { - return fmt.Errorf("proto: wrong wireType = %d for field Status", wireType) - } - m.Status = 0 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - m.Status |= int32(b&0x7F) << shift - if b < 0x80 { - break - } - } - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Body", wireType) - } - var byteLen int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - byteLen |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - if byteLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + byteLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Body = append(m.Body[:0], dAtA[iNdEx:postIndex]...) - if m.Body == nil { - m.Body = []byte{} - } - iNdEx = postIndex - case 3: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Headers", wireType) - } - var msglen int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - msglen |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - if msglen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + msglen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - if m.Headers == nil { - m.Headers = make(map[string]string) - } - var mapkey string - var mapvalue string - for iNdEx < postIndex { - entryPreIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - if fieldNum == 1 { - var stringLenmapkey uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLenmapkey |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLenmapkey := int(stringLenmapkey) - if intStringLenmapkey < 0 { - return ErrInvalidLength - } - postStringIndexmapkey := iNdEx + intStringLenmapkey - if postStringIndexmapkey < 0 { - return ErrInvalidLength - } - if postStringIndexmapkey > l { - return io.ErrUnexpectedEOF - } - mapkey = string(dAtA[iNdEx:postStringIndexmapkey]) - iNdEx = postStringIndexmapkey - } else if fieldNum == 2 { - var stringLenmapvalue uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLenmapvalue |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLenmapvalue := int(stringLenmapvalue) - if intStringLenmapvalue < 0 { - return ErrInvalidLength - } - postStringIndexmapvalue := iNdEx + intStringLenmapvalue - if postStringIndexmapvalue < 0 { - return ErrInvalidLength - } - if postStringIndexmapvalue > l { - return io.ErrUnexpectedEOF - } - mapvalue = string(dAtA[iNdEx:postStringIndexmapvalue]) - iNdEx = postStringIndexmapvalue - } else { - iNdEx = entryPreIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > postIndex { - return io.ErrUnexpectedEOF - } - iNdEx += skippy - } - } - m.Headers[mapkey] = mapvalue - iNdEx = postIndex - case 4: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Error", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Error = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} - -func skip(dAtA []byte) (n int, err error) { - l := len(dAtA) - iNdEx := 0 - depth := 0 - for iNdEx < l { - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return 0, ErrIntOverflow - } - if iNdEx >= l { - return 0, io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= (uint64(b) & 0x7F) << shift - if b < 0x80 { - break - } - } - wireType := int(wire & 0x7) - switch wireType { - case 0: - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return 0, ErrIntOverflow - } - if iNdEx >= l { - return 0, io.ErrUnexpectedEOF - } - iNdEx++ - if dAtA[iNdEx-1] < 0x80 { - break - } - } - case 1: - iNdEx += 8 - case 2: - var length int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return 0, ErrIntOverflow - } - if iNdEx >= l { - return 0, io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - length |= (int(b) & 0x7F) << shift - if b < 0x80 { - break - } - } - if length < 0 { - return 0, ErrInvalidLength - } - iNdEx += length - case 3: - depth++ - case 4: - if depth == 0 { - return 0, ErrUnexpectedEndOfGroup - } - depth-- - case 5: - iNdEx += 4 - default: - return 0, fmt.Errorf("proto: illegal wireType %d", wireType) - } - if iNdEx < 0 { - return 0, ErrInvalidLength - } - if depth == 0 { - return iNdEx, nil - } - } - return 0, io.ErrUnexpectedEOF -} - -var ( - ErrInvalidLength = fmt.Errorf("proto: negative length found during unmarshaling") - ErrIntOverflow = fmt.Errorf("proto: integer overflow") - ErrUnexpectedEndOfGroup = fmt.Errorf("proto: unexpected end of group") -) diff --git a/plugins/host/http_gen.go b/plugins/host/http_gen.go new file mode 100644 index 000000000..c14a533d0 --- /dev/null +++ b/plugins/host/http_gen.go @@ -0,0 +1,88 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package host + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// HTTPSendRequest is the request type for HTTP.Send. +type HTTPSendRequest struct { + Request HTTPRequest `json:"request"` +} + +// HTTPSendResponse is the response type for HTTP.Send. +type HTTPSendResponse struct { + Result *HTTPResponse `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// RegisterHTTPHostFunctions registers HTTP service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterHTTPHostFunctions(service HTTPService) []extism.HostFunction { + return []extism.HostFunction{ + newHTTPSendHostFunction(service), + } +} + +func newHTTPSendHostFunction(service HTTPService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "http_send", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + httpWriteError(p, stack, err) + return + } + var req HTTPSendRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + httpWriteError(p, stack, err) + return + } + + // Call the service method + result, svcErr := service.Send(ctx, req.Request) + if svcErr != nil { + httpWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := HTTPSendResponse{ + Result: result, + } + httpWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// httpWriteResponse writes a JSON response to plugin memory. +func httpWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + httpWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// httpWriteError writes an error response to plugin memory. +func httpWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/host/kvstore.go b/plugins/host/kvstore.go new file mode 100644 index 000000000..aa2597f27 --- /dev/null +++ b/plugins/host/kvstore.go @@ -0,0 +1,98 @@ +package host + +import "context" + +// KVStoreService provides persistent key-value storage for plugins. +// +// Unlike CacheService which is in-memory only, KVStoreService persists data +// to disk and survives server restarts. Each plugin has its own isolated +// storage with configurable size limits. +// +// Values are stored as raw bytes, giving plugins full control over +// serialization (JSON, protobuf, etc.). +// +//nd:hostservice name=KVStore permission=kvstore +type KVStoreService interface { + // Set stores a byte value with the given key. + // + // Parameters: + // - key: The storage key (max 256 bytes, UTF-8) + // - value: The byte slice to store + // + // Returns an error if the storage limit would be exceeded or the operation fails. + //nd:hostfunc + Set(ctx context.Context, key string, value []byte) error + + // SetWithTTL stores a byte value with the given key and a time-to-live. + // + // After ttlSeconds, the key is treated as non-existent and will be + // cleaned up lazily. ttlSeconds must be greater than 0. + // + // Parameters: + // - key: The storage key (max 256 bytes, UTF-8) + // - value: The byte slice to store + // - ttlSeconds: Time-to-live in seconds (must be > 0) + // + // Returns an error if the storage limit would be exceeded or the operation fails. + //nd:hostfunc + SetWithTTL(ctx context.Context, key string, value []byte, ttlSeconds int64) error + + // Get retrieves a byte value from storage. + // + // Parameters: + // - key: The storage key + // + // Returns the value and whether the key exists. + //nd:hostfunc + Get(ctx context.Context, key string) (value []byte, exists bool, err error) + + // GetMany retrieves multiple values in a single call. + // + // Parameters: + // - keys: The storage keys to retrieve + // + // Returns a map of key to value for keys that exist and have not expired. + // Missing or expired keys are omitted from the result. + //nd:hostfunc + GetMany(ctx context.Context, keys []string) (values map[string][]byte, err error) + + // Has checks if a key exists in storage. + // + // Parameters: + // - key: The storage key + // + // Returns true if the key exists. + //nd:hostfunc + Has(ctx context.Context, key string) (exists bool, err error) + + // List returns all keys matching the given prefix. + // + // Parameters: + // - prefix: Key prefix to filter by (empty string returns all keys) + // + // Returns a slice of matching keys. + //nd:hostfunc + List(ctx context.Context, prefix string) (keys []string, err error) + + // Delete removes a value from storage. + // + // Parameters: + // - key: The storage key + // + // Returns an error if the operation fails. Does not return an error if the key doesn't exist. + //nd:hostfunc + Delete(ctx context.Context, key string) error + + // DeleteByPrefix removes all keys matching the given prefix. + // + // Parameters: + // - prefix: Key prefix to match (must not be empty) + // + // Returns the number of keys deleted. Includes expired keys. + //nd:hostfunc + DeleteByPrefix(ctx context.Context, prefix string) (deletedCount int64, err error) + + // GetStorageUsed returns the total storage used by this plugin in bytes. + //nd:hostfunc + GetStorageUsed(ctx context.Context) (bytes int64, err error) +} diff --git a/plugins/host/kvstore_gen.go b/plugins/host/kvstore_gen.go new file mode 100644 index 000000000..44ee3b131 --- /dev/null +++ b/plugins/host/kvstore_gen.go @@ -0,0 +1,433 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package host + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// KVStoreSetRequest is the request type for KVStore.Set. +type KVStoreSetRequest struct { + Key string `json:"key"` + Value []byte `json:"value"` +} + +// KVStoreSetResponse is the response type for KVStore.Set. +type KVStoreSetResponse struct { + Error string `json:"error,omitempty"` +} + +// KVStoreSetWithTTLRequest is the request type for KVStore.SetWithTTL. +type KVStoreSetWithTTLRequest struct { + Key string `json:"key"` + Value []byte `json:"value"` + TtlSeconds int64 `json:"ttlSeconds"` +} + +// KVStoreSetWithTTLResponse is the response type for KVStore.SetWithTTL. +type KVStoreSetWithTTLResponse struct { + Error string `json:"error,omitempty"` +} + +// KVStoreGetRequest is the request type for KVStore.Get. +type KVStoreGetRequest struct { + Key string `json:"key"` +} + +// KVStoreGetResponse is the response type for KVStore.Get. +type KVStoreGetResponse struct { + Value []byte `json:"value,omitempty"` + Exists bool `json:"exists,omitempty"` + Error string `json:"error,omitempty"` +} + +// KVStoreGetManyRequest is the request type for KVStore.GetMany. +type KVStoreGetManyRequest struct { + Keys []string `json:"keys"` +} + +// KVStoreGetManyResponse is the response type for KVStore.GetMany. +type KVStoreGetManyResponse struct { + Values map[string][]byte `json:"values,omitempty"` + Error string `json:"error,omitempty"` +} + +// KVStoreHasRequest is the request type for KVStore.Has. +type KVStoreHasRequest struct { + Key string `json:"key"` +} + +// KVStoreHasResponse is the response type for KVStore.Has. +type KVStoreHasResponse struct { + Exists bool `json:"exists,omitempty"` + Error string `json:"error,omitempty"` +} + +// KVStoreListRequest is the request type for KVStore.List. +type KVStoreListRequest struct { + Prefix string `json:"prefix"` +} + +// KVStoreListResponse is the response type for KVStore.List. +type KVStoreListResponse struct { + Keys []string `json:"keys,omitempty"` + Error string `json:"error,omitempty"` +} + +// KVStoreDeleteRequest is the request type for KVStore.Delete. +type KVStoreDeleteRequest struct { + Key string `json:"key"` +} + +// KVStoreDeleteResponse is the response type for KVStore.Delete. +type KVStoreDeleteResponse struct { + Error string `json:"error,omitempty"` +} + +// KVStoreDeleteByPrefixRequest is the request type for KVStore.DeleteByPrefix. +type KVStoreDeleteByPrefixRequest struct { + Prefix string `json:"prefix"` +} + +// KVStoreDeleteByPrefixResponse is the response type for KVStore.DeleteByPrefix. +type KVStoreDeleteByPrefixResponse struct { + DeletedCount int64 `json:"deletedCount,omitempty"` + Error string `json:"error,omitempty"` +} + +// KVStoreGetStorageUsedResponse is the response type for KVStore.GetStorageUsed. +type KVStoreGetStorageUsedResponse struct { + Bytes int64 `json:"bytes,omitempty"` + Error string `json:"error,omitempty"` +} + +// RegisterKVStoreHostFunctions registers KVStore service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterKVStoreHostFunctions(service KVStoreService) []extism.HostFunction { + return []extism.HostFunction{ + newKVStoreSetHostFunction(service), + newKVStoreSetWithTTLHostFunction(service), + newKVStoreGetHostFunction(service), + newKVStoreGetManyHostFunction(service), + newKVStoreHasHostFunction(service), + newKVStoreListHostFunction(service), + newKVStoreDeleteHostFunction(service), + newKVStoreDeleteByPrefixHostFunction(service), + newKVStoreGetStorageUsedHostFunction(service), + } +} + +func newKVStoreSetHostFunction(service KVStoreService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "kvstore_set", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + kvstoreWriteError(p, stack, err) + return + } + var req KVStoreSetRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + kvstoreWriteError(p, stack, err) + return + } + + // Call the service method + if svcErr := service.Set(ctx, req.Key, req.Value); svcErr != nil { + kvstoreWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := KVStoreSetResponse{} + kvstoreWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newKVStoreSetWithTTLHostFunction(service KVStoreService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "kvstore_setwithttl", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + kvstoreWriteError(p, stack, err) + return + } + var req KVStoreSetWithTTLRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + kvstoreWriteError(p, stack, err) + return + } + + // Call the service method + if svcErr := service.SetWithTTL(ctx, req.Key, req.Value, req.TtlSeconds); svcErr != nil { + kvstoreWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := KVStoreSetWithTTLResponse{} + kvstoreWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newKVStoreGetHostFunction(service KVStoreService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "kvstore_get", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + kvstoreWriteError(p, stack, err) + return + } + var req KVStoreGetRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + kvstoreWriteError(p, stack, err) + return + } + + // Call the service method + value, exists, svcErr := service.Get(ctx, req.Key) + if svcErr != nil { + kvstoreWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := KVStoreGetResponse{ + Value: value, + Exists: exists, + } + kvstoreWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newKVStoreGetManyHostFunction(service KVStoreService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "kvstore_getmany", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + kvstoreWriteError(p, stack, err) + return + } + var req KVStoreGetManyRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + kvstoreWriteError(p, stack, err) + return + } + + // Call the service method + values, svcErr := service.GetMany(ctx, req.Keys) + if svcErr != nil { + kvstoreWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := KVStoreGetManyResponse{ + Values: values, + } + kvstoreWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newKVStoreHasHostFunction(service KVStoreService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "kvstore_has", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + kvstoreWriteError(p, stack, err) + return + } + var req KVStoreHasRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + kvstoreWriteError(p, stack, err) + return + } + + // Call the service method + exists, svcErr := service.Has(ctx, req.Key) + if svcErr != nil { + kvstoreWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := KVStoreHasResponse{ + Exists: exists, + } + kvstoreWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newKVStoreListHostFunction(service KVStoreService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "kvstore_list", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + kvstoreWriteError(p, stack, err) + return + } + var req KVStoreListRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + kvstoreWriteError(p, stack, err) + return + } + + // Call the service method + keys, svcErr := service.List(ctx, req.Prefix) + if svcErr != nil { + kvstoreWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := KVStoreListResponse{ + Keys: keys, + } + kvstoreWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newKVStoreDeleteHostFunction(service KVStoreService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "kvstore_delete", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + kvstoreWriteError(p, stack, err) + return + } + var req KVStoreDeleteRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + kvstoreWriteError(p, stack, err) + return + } + + // Call the service method + if svcErr := service.Delete(ctx, req.Key); svcErr != nil { + kvstoreWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := KVStoreDeleteResponse{} + kvstoreWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newKVStoreDeleteByPrefixHostFunction(service KVStoreService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "kvstore_deletebyprefix", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + kvstoreWriteError(p, stack, err) + return + } + var req KVStoreDeleteByPrefixRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + kvstoreWriteError(p, stack, err) + return + } + + // Call the service method + deletedcount, svcErr := service.DeleteByPrefix(ctx, req.Prefix) + if svcErr != nil { + kvstoreWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := KVStoreDeleteByPrefixResponse{ + DeletedCount: deletedcount, + } + kvstoreWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newKVStoreGetStorageUsedHostFunction(service KVStoreService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "kvstore_getstorageused", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + + // Call the service method + bytes, svcErr := service.GetStorageUsed(ctx) + if svcErr != nil { + kvstoreWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := KVStoreGetStorageUsedResponse{ + Bytes: bytes, + } + kvstoreWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// kvstoreWriteResponse writes a JSON response to plugin memory. +func kvstoreWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + kvstoreWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// kvstoreWriteError writes an error response to plugin memory. +func kvstoreWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/host/library.go b/plugins/host/library.go new file mode 100644 index 000000000..ed86b8b3d --- /dev/null +++ b/plugins/host/library.go @@ -0,0 +1,41 @@ +package host + +import "context" + +// Library represents a music library with metadata. +type Library struct { + ID int32 `json:"id"` + Name string `json:"name"` + Path string `json:"path,omitempty"` + MountPoint string `json:"mountPoint,omitempty"` + LastScanAt int64 `json:"lastScanAt"` + TotalSongs int32 `json:"totalSongs"` + TotalAlbums int32 `json:"totalAlbums"` + TotalArtists int32 `json:"totalArtists"` + TotalSize int64 `json:"totalSize"` + TotalDuration float64 `json:"totalDuration"` +} + +// LibraryService provides access to music library metadata for plugins. +// +// This service allows plugins to query information about configured music libraries, +// including statistics and optionally filesystem access to library directories. +// Filesystem access is controlled via the `filesystem` permission flag. +// +//nd:hostservice name=Library permission=library +type LibraryService interface { + // GetLibrary retrieves metadata for a specific library by ID. + // + // Parameters: + // - id: The library's unique identifier + // + // Returns the library metadata, or an error if the library is not found. + //nd:hostfunc + GetLibrary(ctx context.Context, id int32) (*Library, error) + + // GetAllLibraries retrieves metadata for all configured libraries. + // + // Returns a slice of all libraries with their metadata. + //nd:hostfunc + GetAllLibraries(ctx context.Context) ([]Library, error) +} diff --git a/plugins/host/library_gen.go b/plugins/host/library_gen.go new file mode 100644 index 000000000..27195e85c --- /dev/null +++ b/plugins/host/library_gen.go @@ -0,0 +1,118 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package host + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// LibraryGetLibraryRequest is the request type for Library.GetLibrary. +type LibraryGetLibraryRequest struct { + Id int32 `json:"id"` +} + +// LibraryGetLibraryResponse is the response type for Library.GetLibrary. +type LibraryGetLibraryResponse struct { + Result *Library `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// LibraryGetAllLibrariesResponse is the response type for Library.GetAllLibraries. +type LibraryGetAllLibrariesResponse struct { + Result []Library `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// RegisterLibraryHostFunctions registers Library service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterLibraryHostFunctions(service LibraryService) []extism.HostFunction { + return []extism.HostFunction{ + newLibraryGetLibraryHostFunction(service), + newLibraryGetAllLibrariesHostFunction(service), + } +} + +func newLibraryGetLibraryHostFunction(service LibraryService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "library_getlibrary", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + libraryWriteError(p, stack, err) + return + } + var req LibraryGetLibraryRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + libraryWriteError(p, stack, err) + return + } + + // Call the service method + result, svcErr := service.GetLibrary(ctx, req.Id) + if svcErr != nil { + libraryWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := LibraryGetLibraryResponse{ + Result: result, + } + libraryWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newLibraryGetAllLibrariesHostFunction(service LibraryService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "library_getalllibraries", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + + // Call the service method + result, svcErr := service.GetAllLibraries(ctx) + if svcErr != nil { + libraryWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := LibraryGetAllLibrariesResponse{ + Result: result, + } + libraryWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// libraryWriteResponse writes a JSON response to plugin memory. +func libraryWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + libraryWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// libraryWriteError writes an error response to plugin memory. +func libraryWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/host/scheduler.go b/plugins/host/scheduler.go new file mode 100644 index 000000000..d640bc97b --- /dev/null +++ b/plugins/host/scheduler.go @@ -0,0 +1,44 @@ +package host + +import "context" + +// SchedulerService provides task scheduling capabilities for plugins. +// +// This service allows plugins to schedule both one-time and recurring tasks using +// cron expressions. All scheduled tasks can be cancelled using their schedule ID. +// +//nd:hostservice name=Scheduler permission=scheduler +type SchedulerService interface { + // ScheduleOneTime schedules a one-time event to be triggered after the specified delay. + // Plugins that use this function must also implement the SchedulerCallback capability + // + // Parameters: + // - delaySeconds: Number of seconds to wait before triggering the event + // - payload: Data to be passed to the scheduled event handler + // - scheduleID: Optional unique identifier for the scheduled job. If empty, one will be generated + // + // Returns the schedule ID that can be used to cancel the job, or an error if scheduling fails. + //nd:hostfunc + ScheduleOneTime(ctx context.Context, delaySeconds int32, payload string, scheduleID string) (newScheduleID string, err error) + + // ScheduleRecurring schedules a recurring event using a cron expression. + // Plugins that use this function must also implement the SchedulerCallback capability + // + // Parameters: + // - cronExpression: Standard cron format expression (e.g., "0 0 * * *" for daily at midnight) + // - payload: Data to be passed to each scheduled event handler invocation + // - scheduleID: Optional unique identifier for the scheduled job. If empty, one will be generated + // + // Returns the schedule ID that can be used to cancel the job, or an error if scheduling fails. + //nd:hostfunc + ScheduleRecurring(ctx context.Context, cronExpression string, payload string, scheduleID string) (newScheduleID string, err error) + + // CancelSchedule cancels a scheduled job identified by its schedule ID. + // + // This works for both one-time and recurring schedules. Once cancelled, the job will not trigger + // any future events. + // + // Returns an error if the schedule ID is not found or if cancellation fails. + //nd:hostfunc + CancelSchedule(ctx context.Context, scheduleID string) error +} diff --git a/plugins/host/scheduler/scheduler.pb.go b/plugins/host/scheduler/scheduler.pb.go deleted file mode 100644 index 07d250cc5..000000000 --- a/plugins/host/scheduler/scheduler.pb.go +++ /dev/null @@ -1,212 +0,0 @@ -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: host/scheduler/scheduler.proto - -package scheduler - -import ( - context "context" - protoreflect "google.golang.org/protobuf/reflect/protoreflect" - protoimpl "google.golang.org/protobuf/runtime/protoimpl" -) - -const ( - // Verify that this generated code is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion) - // Verify that runtime/protoimpl is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) -) - -type ScheduleOneTimeRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - DelaySeconds int32 `protobuf:"varint,1,opt,name=delay_seconds,json=delaySeconds,proto3" json:"delay_seconds,omitempty"` // Delay in seconds - Payload []byte `protobuf:"bytes,2,opt,name=payload,proto3" json:"payload,omitempty"` // Serialized data to pass to the callback - ScheduleId string `protobuf:"bytes,3,opt,name=schedule_id,json=scheduleId,proto3" json:"schedule_id,omitempty"` // Optional custom ID (if not provided, one will be generated) -} - -func (x *ScheduleOneTimeRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *ScheduleOneTimeRequest) GetDelaySeconds() int32 { - if x != nil { - return x.DelaySeconds - } - return 0 -} - -func (x *ScheduleOneTimeRequest) GetPayload() []byte { - if x != nil { - return x.Payload - } - return nil -} - -func (x *ScheduleOneTimeRequest) GetScheduleId() string { - if x != nil { - return x.ScheduleId - } - return "" -} - -type ScheduleRecurringRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - CronExpression string `protobuf:"bytes,1,opt,name=cron_expression,json=cronExpression,proto3" json:"cron_expression,omitempty"` // Cron expression (e.g. "0 0 * * *" for daily at midnight) - Payload []byte `protobuf:"bytes,2,opt,name=payload,proto3" json:"payload,omitempty"` // Serialized data to pass to the callback - ScheduleId string `protobuf:"bytes,3,opt,name=schedule_id,json=scheduleId,proto3" json:"schedule_id,omitempty"` // Optional custom ID (if not provided, one will be generated) -} - -func (x *ScheduleRecurringRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *ScheduleRecurringRequest) GetCronExpression() string { - if x != nil { - return x.CronExpression - } - return "" -} - -func (x *ScheduleRecurringRequest) GetPayload() []byte { - if x != nil { - return x.Payload - } - return nil -} - -func (x *ScheduleRecurringRequest) GetScheduleId() string { - if x != nil { - return x.ScheduleId - } - return "" -} - -type ScheduleResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - ScheduleId string `protobuf:"bytes,1,opt,name=schedule_id,json=scheduleId,proto3" json:"schedule_id,omitempty"` // ID to reference this scheduled job -} - -func (x *ScheduleResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *ScheduleResponse) GetScheduleId() string { - if x != nil { - return x.ScheduleId - } - return "" -} - -type CancelRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - ScheduleId string `protobuf:"bytes,1,opt,name=schedule_id,json=scheduleId,proto3" json:"schedule_id,omitempty"` // ID of the schedule to cancel -} - -func (x *CancelRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *CancelRequest) GetScheduleId() string { - if x != nil { - return x.ScheduleId - } - return "" -} - -type CancelResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Success bool `protobuf:"varint,1,opt,name=success,proto3" json:"success,omitempty"` // Whether cancellation was successful - Error string `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"` // Error message if cancellation failed -} - -func (x *CancelResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *CancelResponse) GetSuccess() bool { - if x != nil { - return x.Success - } - return false -} - -func (x *CancelResponse) GetError() string { - if x != nil { - return x.Error - } - return "" -} - -type TimeNowRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields -} - -func (x *TimeNowRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -type TimeNowResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Rfc3339Nano string `protobuf:"bytes,1,opt,name=rfc3339_nano,json=rfc3339Nano,proto3" json:"rfc3339_nano,omitempty"` // Current time in RFC3339Nano format - UnixMilli int64 `protobuf:"varint,2,opt,name=unix_milli,json=unixMilli,proto3" json:"unix_milli,omitempty"` // Current time as Unix milliseconds timestamp - LocalTimeZone string `protobuf:"bytes,3,opt,name=local_time_zone,json=localTimeZone,proto3" json:"local_time_zone,omitempty"` // Local timezone name (e.g., "America/New_York", "UTC") -} - -func (x *TimeNowResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *TimeNowResponse) GetRfc3339Nano() string { - if x != nil { - return x.Rfc3339Nano - } - return "" -} - -func (x *TimeNowResponse) GetUnixMilli() int64 { - if x != nil { - return x.UnixMilli - } - return 0 -} - -func (x *TimeNowResponse) GetLocalTimeZone() string { - if x != nil { - return x.LocalTimeZone - } - return "" -} - -// go:plugin type=host version=1 -type SchedulerService interface { - // One-time event scheduling - ScheduleOneTime(context.Context, *ScheduleOneTimeRequest) (*ScheduleResponse, error) - // Recurring event scheduling - ScheduleRecurring(context.Context, *ScheduleRecurringRequest) (*ScheduleResponse, error) - // Cancel any scheduled job - CancelSchedule(context.Context, *CancelRequest) (*CancelResponse, error) - // Get current time in multiple formats - TimeNow(context.Context, *TimeNowRequest) (*TimeNowResponse, error) -} diff --git a/plugins/host/scheduler/scheduler.proto b/plugins/host/scheduler/scheduler.proto deleted file mode 100644 index d164b4f90..000000000 --- a/plugins/host/scheduler/scheduler.proto +++ /dev/null @@ -1,55 +0,0 @@ -syntax = "proto3"; - -package scheduler; - -option go_package = "github.com/navidrome/navidrome/plugins/host/scheduler;scheduler"; - -// go:plugin type=host version=1 -service SchedulerService { - // One-time event scheduling - rpc ScheduleOneTime(ScheduleOneTimeRequest) returns (ScheduleResponse); - - // Recurring event scheduling - rpc ScheduleRecurring(ScheduleRecurringRequest) returns (ScheduleResponse); - - // Cancel any scheduled job - rpc CancelSchedule(CancelRequest) returns (CancelResponse); - - // Get current time in multiple formats - rpc TimeNow(TimeNowRequest) returns (TimeNowResponse); -} - -message ScheduleOneTimeRequest { - int32 delay_seconds = 1; // Delay in seconds - bytes payload = 2; // Serialized data to pass to the callback - string schedule_id = 3; // Optional custom ID (if not provided, one will be generated) -} - -message ScheduleRecurringRequest { - string cron_expression = 1; // Cron expression (e.g. "0 0 * * *" for daily at midnight) - bytes payload = 2; // Serialized data to pass to the callback - string schedule_id = 3; // Optional custom ID (if not provided, one will be generated) -} - -message ScheduleResponse { - string schedule_id = 1; // ID to reference this scheduled job -} - -message CancelRequest { - string schedule_id = 1; // ID of the schedule to cancel -} - -message CancelResponse { - bool success = 1; // Whether cancellation was successful - string error = 2; // Error message if cancellation failed -} - -message TimeNowRequest { - // Empty request - no parameters needed -} - -message TimeNowResponse { - string rfc3339_nano = 1; // Current time in RFC3339Nano format - int64 unix_milli = 2; // Current time as Unix milliseconds timestamp - string local_time_zone = 3; // Local timezone name (e.g., "America/New_York", "UTC") -} \ No newline at end of file diff --git a/plugins/host/scheduler/scheduler_host.pb.go b/plugins/host/scheduler/scheduler_host.pb.go deleted file mode 100644 index 714603a3b..000000000 --- a/plugins/host/scheduler/scheduler_host.pb.go +++ /dev/null @@ -1,170 +0,0 @@ -//go:build !wasip1 - -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: host/scheduler/scheduler.proto - -package scheduler - -import ( - context "context" - wasm "github.com/knqyf263/go-plugin/wasm" - wazero "github.com/tetratelabs/wazero" - api "github.com/tetratelabs/wazero/api" -) - -const ( - i32 = api.ValueTypeI32 - i64 = api.ValueTypeI64 -) - -type _schedulerService struct { - SchedulerService -} - -// Instantiate a Go-defined module named "env" that exports host functions. -func Instantiate(ctx context.Context, r wazero.Runtime, hostFunctions SchedulerService) error { - envBuilder := r.NewHostModuleBuilder("env") - h := _schedulerService{hostFunctions} - - envBuilder.NewFunctionBuilder(). - WithGoModuleFunction(api.GoModuleFunc(h._ScheduleOneTime), []api.ValueType{i32, i32}, []api.ValueType{i64}). - WithParameterNames("offset", "size"). - Export("schedule_one_time") - - envBuilder.NewFunctionBuilder(). - WithGoModuleFunction(api.GoModuleFunc(h._ScheduleRecurring), []api.ValueType{i32, i32}, []api.ValueType{i64}). - WithParameterNames("offset", "size"). - Export("schedule_recurring") - - envBuilder.NewFunctionBuilder(). - WithGoModuleFunction(api.GoModuleFunc(h._CancelSchedule), []api.ValueType{i32, i32}, []api.ValueType{i64}). - WithParameterNames("offset", "size"). - Export("cancel_schedule") - - envBuilder.NewFunctionBuilder(). - WithGoModuleFunction(api.GoModuleFunc(h._TimeNow), []api.ValueType{i32, i32}, []api.ValueType{i64}). - WithParameterNames("offset", "size"). - Export("time_now") - - _, err := envBuilder.Instantiate(ctx) - return err -} - -// One-time event scheduling - -func (h _schedulerService) _ScheduleOneTime(ctx context.Context, m api.Module, stack []uint64) { - offset, size := uint32(stack[0]), uint32(stack[1]) - buf, err := wasm.ReadMemory(m.Memory(), offset, size) - if err != nil { - panic(err) - } - request := new(ScheduleOneTimeRequest) - err = request.UnmarshalVT(buf) - if err != nil { - panic(err) - } - resp, err := h.ScheduleOneTime(ctx, request) - if err != nil { - panic(err) - } - buf, err = resp.MarshalVT() - if err != nil { - panic(err) - } - ptr, err := wasm.WriteMemory(ctx, m, buf) - if err != nil { - panic(err) - } - ptrLen := (ptr << uint64(32)) | uint64(len(buf)) - stack[0] = ptrLen -} - -// Recurring event scheduling - -func (h _schedulerService) _ScheduleRecurring(ctx context.Context, m api.Module, stack []uint64) { - offset, size := uint32(stack[0]), uint32(stack[1]) - buf, err := wasm.ReadMemory(m.Memory(), offset, size) - if err != nil { - panic(err) - } - request := new(ScheduleRecurringRequest) - err = request.UnmarshalVT(buf) - if err != nil { - panic(err) - } - resp, err := h.ScheduleRecurring(ctx, request) - if err != nil { - panic(err) - } - buf, err = resp.MarshalVT() - if err != nil { - panic(err) - } - ptr, err := wasm.WriteMemory(ctx, m, buf) - if err != nil { - panic(err) - } - ptrLen := (ptr << uint64(32)) | uint64(len(buf)) - stack[0] = ptrLen -} - -// Cancel any scheduled job - -func (h _schedulerService) _CancelSchedule(ctx context.Context, m api.Module, stack []uint64) { - offset, size := uint32(stack[0]), uint32(stack[1]) - buf, err := wasm.ReadMemory(m.Memory(), offset, size) - if err != nil { - panic(err) - } - request := new(CancelRequest) - err = request.UnmarshalVT(buf) - if err != nil { - panic(err) - } - resp, err := h.CancelSchedule(ctx, request) - if err != nil { - panic(err) - } - buf, err = resp.MarshalVT() - if err != nil { - panic(err) - } - ptr, err := wasm.WriteMemory(ctx, m, buf) - if err != nil { - panic(err) - } - ptrLen := (ptr << uint64(32)) | uint64(len(buf)) - stack[0] = ptrLen -} - -// Get current time in multiple formats - -func (h _schedulerService) _TimeNow(ctx context.Context, m api.Module, stack []uint64) { - offset, size := uint32(stack[0]), uint32(stack[1]) - buf, err := wasm.ReadMemory(m.Memory(), offset, size) - if err != nil { - panic(err) - } - request := new(TimeNowRequest) - err = request.UnmarshalVT(buf) - if err != nil { - panic(err) - } - resp, err := h.TimeNow(ctx, request) - if err != nil { - panic(err) - } - buf, err = resp.MarshalVT() - if err != nil { - panic(err) - } - ptr, err := wasm.WriteMemory(ctx, m, buf) - if err != nil { - panic(err) - } - ptrLen := (ptr << uint64(32)) | uint64(len(buf)) - stack[0] = ptrLen -} diff --git a/plugins/host/scheduler/scheduler_plugin.pb.go b/plugins/host/scheduler/scheduler_plugin.pb.go deleted file mode 100644 index ab7f8cd48..000000000 --- a/plugins/host/scheduler/scheduler_plugin.pb.go +++ /dev/null @@ -1,113 +0,0 @@ -//go:build wasip1 - -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: host/scheduler/scheduler.proto - -package scheduler - -import ( - context "context" - wasm "github.com/knqyf263/go-plugin/wasm" - _ "unsafe" -) - -type schedulerService struct{} - -func NewSchedulerService() SchedulerService { - return schedulerService{} -} - -//go:wasmimport env schedule_one_time -func _schedule_one_time(ptr uint32, size uint32) uint64 - -func (h schedulerService) ScheduleOneTime(ctx context.Context, request *ScheduleOneTimeRequest) (*ScheduleResponse, error) { - buf, err := request.MarshalVT() - if err != nil { - return nil, err - } - ptr, size := wasm.ByteToPtr(buf) - ptrSize := _schedule_one_time(ptr, size) - wasm.Free(ptr) - - ptr = uint32(ptrSize >> 32) - size = uint32(ptrSize) - buf = wasm.PtrToByte(ptr, size) - - response := new(ScheduleResponse) - if err = response.UnmarshalVT(buf); err != nil { - return nil, err - } - return response, nil -} - -//go:wasmimport env schedule_recurring -func _schedule_recurring(ptr uint32, size uint32) uint64 - -func (h schedulerService) ScheduleRecurring(ctx context.Context, request *ScheduleRecurringRequest) (*ScheduleResponse, error) { - buf, err := request.MarshalVT() - if err != nil { - return nil, err - } - ptr, size := wasm.ByteToPtr(buf) - ptrSize := _schedule_recurring(ptr, size) - wasm.Free(ptr) - - ptr = uint32(ptrSize >> 32) - size = uint32(ptrSize) - buf = wasm.PtrToByte(ptr, size) - - response := new(ScheduleResponse) - if err = response.UnmarshalVT(buf); err != nil { - return nil, err - } - return response, nil -} - -//go:wasmimport env cancel_schedule -func _cancel_schedule(ptr uint32, size uint32) uint64 - -func (h schedulerService) CancelSchedule(ctx context.Context, request *CancelRequest) (*CancelResponse, error) { - buf, err := request.MarshalVT() - if err != nil { - return nil, err - } - ptr, size := wasm.ByteToPtr(buf) - ptrSize := _cancel_schedule(ptr, size) - wasm.Free(ptr) - - ptr = uint32(ptrSize >> 32) - size = uint32(ptrSize) - buf = wasm.PtrToByte(ptr, size) - - response := new(CancelResponse) - if err = response.UnmarshalVT(buf); err != nil { - return nil, err - } - return response, nil -} - -//go:wasmimport env time_now -func _time_now(ptr uint32, size uint32) uint64 - -func (h schedulerService) TimeNow(ctx context.Context, request *TimeNowRequest) (*TimeNowResponse, error) { - buf, err := request.MarshalVT() - if err != nil { - return nil, err - } - ptr, size := wasm.ByteToPtr(buf) - ptrSize := _time_now(ptr, size) - wasm.Free(ptr) - - ptr = uint32(ptrSize >> 32) - size = uint32(ptrSize) - buf = wasm.PtrToByte(ptr, size) - - response := new(TimeNowResponse) - if err = response.UnmarshalVT(buf); err != nil { - return nil, err - } - return response, nil -} diff --git a/plugins/host/scheduler/scheduler_plugin_dev.go b/plugins/host/scheduler/scheduler_plugin_dev.go deleted file mode 100644 index b6feaa8e4..000000000 --- a/plugins/host/scheduler/scheduler_plugin_dev.go +++ /dev/null @@ -1,7 +0,0 @@ -//go:build !wasip1 - -package scheduler - -func NewSchedulerService() SchedulerService { - panic("not implemented") -} diff --git a/plugins/host/scheduler/scheduler_vtproto.pb.go b/plugins/host/scheduler/scheduler_vtproto.pb.go deleted file mode 100644 index ee6421783..000000000 --- a/plugins/host/scheduler/scheduler_vtproto.pb.go +++ /dev/null @@ -1,1303 +0,0 @@ -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: host/scheduler/scheduler.proto - -package scheduler - -import ( - fmt "fmt" - protoimpl "google.golang.org/protobuf/runtime/protoimpl" - io "io" - bits "math/bits" -) - -const ( - // Verify that this generated code is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion) - // Verify that runtime/protoimpl is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) -) - -func (m *ScheduleOneTimeRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *ScheduleOneTimeRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *ScheduleOneTimeRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.ScheduleId) > 0 { - i -= len(m.ScheduleId) - copy(dAtA[i:], m.ScheduleId) - i = encodeVarint(dAtA, i, uint64(len(m.ScheduleId))) - i-- - dAtA[i] = 0x1a - } - if len(m.Payload) > 0 { - i -= len(m.Payload) - copy(dAtA[i:], m.Payload) - i = encodeVarint(dAtA, i, uint64(len(m.Payload))) - i-- - dAtA[i] = 0x12 - } - if m.DelaySeconds != 0 { - i = encodeVarint(dAtA, i, uint64(m.DelaySeconds)) - i-- - dAtA[i] = 0x8 - } - return len(dAtA) - i, nil -} - -func (m *ScheduleRecurringRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *ScheduleRecurringRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *ScheduleRecurringRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.ScheduleId) > 0 { - i -= len(m.ScheduleId) - copy(dAtA[i:], m.ScheduleId) - i = encodeVarint(dAtA, i, uint64(len(m.ScheduleId))) - i-- - dAtA[i] = 0x1a - } - if len(m.Payload) > 0 { - i -= len(m.Payload) - copy(dAtA[i:], m.Payload) - i = encodeVarint(dAtA, i, uint64(len(m.Payload))) - i-- - dAtA[i] = 0x12 - } - if len(m.CronExpression) > 0 { - i -= len(m.CronExpression) - copy(dAtA[i:], m.CronExpression) - i = encodeVarint(dAtA, i, uint64(len(m.CronExpression))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *ScheduleResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *ScheduleResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *ScheduleResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.ScheduleId) > 0 { - i -= len(m.ScheduleId) - copy(dAtA[i:], m.ScheduleId) - i = encodeVarint(dAtA, i, uint64(len(m.ScheduleId))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *CancelRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *CancelRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *CancelRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.ScheduleId) > 0 { - i -= len(m.ScheduleId) - copy(dAtA[i:], m.ScheduleId) - i = encodeVarint(dAtA, i, uint64(len(m.ScheduleId))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *CancelResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *CancelResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *CancelResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Error) > 0 { - i -= len(m.Error) - copy(dAtA[i:], m.Error) - i = encodeVarint(dAtA, i, uint64(len(m.Error))) - i-- - dAtA[i] = 0x12 - } - if m.Success { - i-- - if m.Success { - dAtA[i] = 1 - } else { - dAtA[i] = 0 - } - i-- - dAtA[i] = 0x8 - } - return len(dAtA) - i, nil -} - -func (m *TimeNowRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *TimeNowRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *TimeNowRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - return len(dAtA) - i, nil -} - -func (m *TimeNowResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *TimeNowResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *TimeNowResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.LocalTimeZone) > 0 { - i -= len(m.LocalTimeZone) - copy(dAtA[i:], m.LocalTimeZone) - i = encodeVarint(dAtA, i, uint64(len(m.LocalTimeZone))) - i-- - dAtA[i] = 0x1a - } - if m.UnixMilli != 0 { - i = encodeVarint(dAtA, i, uint64(m.UnixMilli)) - i-- - dAtA[i] = 0x10 - } - if len(m.Rfc3339Nano) > 0 { - i -= len(m.Rfc3339Nano) - copy(dAtA[i:], m.Rfc3339Nano) - i = encodeVarint(dAtA, i, uint64(len(m.Rfc3339Nano))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func encodeVarint(dAtA []byte, offset int, v uint64) int { - offset -= sov(v) - base := offset - for v >= 1<<7 { - dAtA[offset] = uint8(v&0x7f | 0x80) - v >>= 7 - offset++ - } - dAtA[offset] = uint8(v) - return base -} -func (m *ScheduleOneTimeRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - if m.DelaySeconds != 0 { - n += 1 + sov(uint64(m.DelaySeconds)) - } - l = len(m.Payload) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.ScheduleId) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *ScheduleRecurringRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.CronExpression) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Payload) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.ScheduleId) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *ScheduleResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.ScheduleId) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *CancelRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.ScheduleId) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *CancelResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - if m.Success { - n += 2 - } - l = len(m.Error) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *TimeNowRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - n += len(m.unknownFields) - return n -} - -func (m *TimeNowResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Rfc3339Nano) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - if m.UnixMilli != 0 { - n += 1 + sov(uint64(m.UnixMilli)) - } - l = len(m.LocalTimeZone) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func sov(x uint64) (n int) { - return (bits.Len64(x|1) + 6) / 7 -} -func soz(x uint64) (n int) { - return sov(uint64((x << 1) ^ uint64((int64(x) >> 63)))) -} -func (m *ScheduleOneTimeRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: ScheduleOneTimeRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: ScheduleOneTimeRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 0 { - return fmt.Errorf("proto: wrong wireType = %d for field DelaySeconds", wireType) - } - m.DelaySeconds = 0 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - m.DelaySeconds |= int32(b&0x7F) << shift - if b < 0x80 { - break - } - } - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Payload", wireType) - } - var byteLen int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - byteLen |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - if byteLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + byteLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Payload = append(m.Payload[:0], dAtA[iNdEx:postIndex]...) - if m.Payload == nil { - m.Payload = []byte{} - } - iNdEx = postIndex - case 3: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field ScheduleId", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.ScheduleId = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *ScheduleRecurringRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: ScheduleRecurringRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: ScheduleRecurringRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field CronExpression", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.CronExpression = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Payload", wireType) - } - var byteLen int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - byteLen |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - if byteLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + byteLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Payload = append(m.Payload[:0], dAtA[iNdEx:postIndex]...) - if m.Payload == nil { - m.Payload = []byte{} - } - iNdEx = postIndex - case 3: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field ScheduleId", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.ScheduleId = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *ScheduleResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: ScheduleResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: ScheduleResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field ScheduleId", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.ScheduleId = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *CancelRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: CancelRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: CancelRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field ScheduleId", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.ScheduleId = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *CancelResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: CancelResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: CancelResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 0 { - return fmt.Errorf("proto: wrong wireType = %d for field Success", wireType) - } - var v int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - v |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - m.Success = bool(v != 0) - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Error", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Error = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *TimeNowRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: TimeNowRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: TimeNowRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *TimeNowResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: TimeNowResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: TimeNowResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Rfc3339Nano", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Rfc3339Nano = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 0 { - return fmt.Errorf("proto: wrong wireType = %d for field UnixMilli", wireType) - } - m.UnixMilli = 0 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - m.UnixMilli |= int64(b&0x7F) << shift - if b < 0x80 { - break - } - } - case 3: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field LocalTimeZone", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.LocalTimeZone = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} - -func skip(dAtA []byte) (n int, err error) { - l := len(dAtA) - iNdEx := 0 - depth := 0 - for iNdEx < l { - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return 0, ErrIntOverflow - } - if iNdEx >= l { - return 0, io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= (uint64(b) & 0x7F) << shift - if b < 0x80 { - break - } - } - wireType := int(wire & 0x7) - switch wireType { - case 0: - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return 0, ErrIntOverflow - } - if iNdEx >= l { - return 0, io.ErrUnexpectedEOF - } - iNdEx++ - if dAtA[iNdEx-1] < 0x80 { - break - } - } - case 1: - iNdEx += 8 - case 2: - var length int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return 0, ErrIntOverflow - } - if iNdEx >= l { - return 0, io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - length |= (int(b) & 0x7F) << shift - if b < 0x80 { - break - } - } - if length < 0 { - return 0, ErrInvalidLength - } - iNdEx += length - case 3: - depth++ - case 4: - if depth == 0 { - return 0, ErrUnexpectedEndOfGroup - } - depth-- - case 5: - iNdEx += 4 - default: - return 0, fmt.Errorf("proto: illegal wireType %d", wireType) - } - if iNdEx < 0 { - return 0, ErrInvalidLength - } - if depth == 0 { - return iNdEx, nil - } - } - return 0, io.ErrUnexpectedEOF -} - -var ( - ErrInvalidLength = fmt.Errorf("proto: negative length found during unmarshaling") - ErrIntOverflow = fmt.Errorf("proto: integer overflow") - ErrUnexpectedEndOfGroup = fmt.Errorf("proto: unexpected end of group") -) diff --git a/plugins/host/scheduler_gen.go b/plugins/host/scheduler_gen.go new file mode 100644 index 000000000..d3845419c --- /dev/null +++ b/plugins/host/scheduler_gen.go @@ -0,0 +1,180 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package host + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// SchedulerScheduleOneTimeRequest is the request type for Scheduler.ScheduleOneTime. +type SchedulerScheduleOneTimeRequest struct { + DelaySeconds int32 `json:"delaySeconds"` + Payload string `json:"payload"` + ScheduleID string `json:"scheduleId"` +} + +// SchedulerScheduleOneTimeResponse is the response type for Scheduler.ScheduleOneTime. +type SchedulerScheduleOneTimeResponse struct { + NewScheduleID string `json:"newScheduleId,omitempty"` + Error string `json:"error,omitempty"` +} + +// SchedulerScheduleRecurringRequest is the request type for Scheduler.ScheduleRecurring. +type SchedulerScheduleRecurringRequest struct { + CronExpression string `json:"cronExpression"` + Payload string `json:"payload"` + ScheduleID string `json:"scheduleId"` +} + +// SchedulerScheduleRecurringResponse is the response type for Scheduler.ScheduleRecurring. +type SchedulerScheduleRecurringResponse struct { + NewScheduleID string `json:"newScheduleId,omitempty"` + Error string `json:"error,omitempty"` +} + +// SchedulerCancelScheduleRequest is the request type for Scheduler.CancelSchedule. +type SchedulerCancelScheduleRequest struct { + ScheduleID string `json:"scheduleId"` +} + +// SchedulerCancelScheduleResponse is the response type for Scheduler.CancelSchedule. +type SchedulerCancelScheduleResponse struct { + Error string `json:"error,omitempty"` +} + +// RegisterSchedulerHostFunctions registers Scheduler service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterSchedulerHostFunctions(service SchedulerService) []extism.HostFunction { + return []extism.HostFunction{ + newSchedulerScheduleOneTimeHostFunction(service), + newSchedulerScheduleRecurringHostFunction(service), + newSchedulerCancelScheduleHostFunction(service), + } +} + +func newSchedulerScheduleOneTimeHostFunction(service SchedulerService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "scheduler_scheduleonetime", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + schedulerWriteError(p, stack, err) + return + } + var req SchedulerScheduleOneTimeRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + schedulerWriteError(p, stack, err) + return + } + + // Call the service method + newscheduleid, svcErr := service.ScheduleOneTime(ctx, req.DelaySeconds, req.Payload, req.ScheduleID) + if svcErr != nil { + schedulerWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := SchedulerScheduleOneTimeResponse{ + NewScheduleID: newscheduleid, + } + schedulerWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newSchedulerScheduleRecurringHostFunction(service SchedulerService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "scheduler_schedulerecurring", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + schedulerWriteError(p, stack, err) + return + } + var req SchedulerScheduleRecurringRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + schedulerWriteError(p, stack, err) + return + } + + // Call the service method + newscheduleid, svcErr := service.ScheduleRecurring(ctx, req.CronExpression, req.Payload, req.ScheduleID) + if svcErr != nil { + schedulerWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := SchedulerScheduleRecurringResponse{ + NewScheduleID: newscheduleid, + } + schedulerWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newSchedulerCancelScheduleHostFunction(service SchedulerService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "scheduler_cancelschedule", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + schedulerWriteError(p, stack, err) + return + } + var req SchedulerCancelScheduleRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + schedulerWriteError(p, stack, err) + return + } + + // Call the service method + if svcErr := service.CancelSchedule(ctx, req.ScheduleID); svcErr != nil { + schedulerWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := SchedulerCancelScheduleResponse{} + schedulerWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// schedulerWriteResponse writes a JSON response to plugin memory. +func schedulerWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + schedulerWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// schedulerWriteError writes an error response to plugin memory. +func schedulerWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/host/subsonicapi.go b/plugins/host/subsonicapi.go new file mode 100644 index 000000000..32de75e77 --- /dev/null +++ b/plugins/host/subsonicapi.go @@ -0,0 +1,24 @@ +package host + +import "context" + +// SubsonicAPIService provides access to Navidrome's Subsonic API from plugins. +// +// This service allows plugins to make Subsonic API requests on behalf of the plugin's user, +// enabling access to library data, user preferences, and other Subsonic-compatible operations. +// +//nd:hostservice name=SubsonicAPI permission=subsonicapi +type SubsonicAPIService interface { + // Call executes a Subsonic API request and returns the JSON response. + // + // The uri parameter should be the Subsonic API path without the server prefix, + // e.g., "getAlbumList2?type=random&size=10". The response is returned as raw JSON. + //nd:hostfunc + Call(ctx context.Context, uri string) (responseJSON string, err error) + + // CallRaw executes a Subsonic API request and returns the raw binary response. + // Designed for binary endpoints like getCoverArt and stream that return + // non-JSON data. The data is base64-encoded over JSON on the wire. + //nd:hostfunc + CallRaw(ctx context.Context, uri string) (contentType string, data []byte, err error) +} diff --git a/plugins/host/subsonicapi/subsonicapi.pb.go b/plugins/host/subsonicapi/subsonicapi.pb.go deleted file mode 100644 index 0dbd9054f..000000000 --- a/plugins/host/subsonicapi/subsonicapi.pb.go +++ /dev/null @@ -1,71 +0,0 @@ -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: host/subsonicapi/subsonicapi.proto - -package subsonicapi - -import ( - context "context" - protoreflect "google.golang.org/protobuf/reflect/protoreflect" - protoimpl "google.golang.org/protobuf/runtime/protoimpl" -) - -const ( - // Verify that this generated code is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion) - // Verify that runtime/protoimpl is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) -) - -type CallRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"` -} - -func (x *CallRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *CallRequest) GetUrl() string { - if x != nil { - return x.Url - } - return "" -} - -type CallResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Json string `protobuf:"bytes,1,opt,name=json,proto3" json:"json,omitempty"` - Error string `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"` // Non-empty if operation failed -} - -func (x *CallResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *CallResponse) GetJson() string { - if x != nil { - return x.Json - } - return "" -} - -func (x *CallResponse) GetError() string { - if x != nil { - return x.Error - } - return "" -} - -// go:plugin type=host version=1 -type SubsonicAPIService interface { - Call(context.Context, *CallRequest) (*CallResponse, error) -} diff --git a/plugins/host/subsonicapi/subsonicapi.proto b/plugins/host/subsonicapi/subsonicapi.proto deleted file mode 100644 index 29dc365ca..000000000 --- a/plugins/host/subsonicapi/subsonicapi.proto +++ /dev/null @@ -1,19 +0,0 @@ -syntax = "proto3"; - -package subsonicapi; - -option go_package = "github.com/navidrome/navidrome/plugins/host/subsonicapi;subsonicapi"; - -// go:plugin type=host version=1 -service SubsonicAPIService { - rpc Call(CallRequest) returns (CallResponse); -} - -message CallRequest { - string url = 1; -} - -message CallResponse { - string json = 1; - string error = 2; // Non-empty if operation failed -} \ No newline at end of file diff --git a/plugins/host/subsonicapi/subsonicapi_host.pb.go b/plugins/host/subsonicapi/subsonicapi_host.pb.go deleted file mode 100644 index b7c0f042e..000000000 --- a/plugins/host/subsonicapi/subsonicapi_host.pb.go +++ /dev/null @@ -1,66 +0,0 @@ -//go:build !wasip1 - -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: host/subsonicapi/subsonicapi.proto - -package subsonicapi - -import ( - context "context" - wasm "github.com/knqyf263/go-plugin/wasm" - wazero "github.com/tetratelabs/wazero" - api "github.com/tetratelabs/wazero/api" -) - -const ( - i32 = api.ValueTypeI32 - i64 = api.ValueTypeI64 -) - -type _subsonicAPIService struct { - SubsonicAPIService -} - -// Instantiate a Go-defined module named "env" that exports host functions. -func Instantiate(ctx context.Context, r wazero.Runtime, hostFunctions SubsonicAPIService) error { - envBuilder := r.NewHostModuleBuilder("env") - h := _subsonicAPIService{hostFunctions} - - envBuilder.NewFunctionBuilder(). - WithGoModuleFunction(api.GoModuleFunc(h._Call), []api.ValueType{i32, i32}, []api.ValueType{i64}). - WithParameterNames("offset", "size"). - Export("call") - - _, err := envBuilder.Instantiate(ctx) - return err -} - -func (h _subsonicAPIService) _Call(ctx context.Context, m api.Module, stack []uint64) { - offset, size := uint32(stack[0]), uint32(stack[1]) - buf, err := wasm.ReadMemory(m.Memory(), offset, size) - if err != nil { - panic(err) - } - request := new(CallRequest) - err = request.UnmarshalVT(buf) - if err != nil { - panic(err) - } - resp, err := h.Call(ctx, request) - if err != nil { - panic(err) - } - buf, err = resp.MarshalVT() - if err != nil { - panic(err) - } - ptr, err := wasm.WriteMemory(ctx, m, buf) - if err != nil { - panic(err) - } - ptrLen := (ptr << uint64(32)) | uint64(len(buf)) - stack[0] = ptrLen -} diff --git a/plugins/host/subsonicapi/subsonicapi_plugin.pb.go b/plugins/host/subsonicapi/subsonicapi_plugin.pb.go deleted file mode 100644 index 1ffdbf526..000000000 --- a/plugins/host/subsonicapi/subsonicapi_plugin.pb.go +++ /dev/null @@ -1,44 +0,0 @@ -//go:build wasip1 - -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: host/subsonicapi/subsonicapi.proto - -package subsonicapi - -import ( - context "context" - wasm "github.com/knqyf263/go-plugin/wasm" - _ "unsafe" -) - -type subsonicAPIService struct{} - -func NewSubsonicAPIService() SubsonicAPIService { - return subsonicAPIService{} -} - -//go:wasmimport env call -func _call(ptr uint32, size uint32) uint64 - -func (h subsonicAPIService) Call(ctx context.Context, request *CallRequest) (*CallResponse, error) { - buf, err := request.MarshalVT() - if err != nil { - return nil, err - } - ptr, size := wasm.ByteToPtr(buf) - ptrSize := _call(ptr, size) - wasm.Free(ptr) - - ptr = uint32(ptrSize >> 32) - size = uint32(ptrSize) - buf = wasm.PtrToByte(ptr, size) - - response := new(CallResponse) - if err = response.UnmarshalVT(buf); err != nil { - return nil, err - } - return response, nil -} diff --git a/plugins/host/subsonicapi/subsonicapi_vtproto.pb.go b/plugins/host/subsonicapi/subsonicapi_vtproto.pb.go deleted file mode 100644 index 05403216b..000000000 --- a/plugins/host/subsonicapi/subsonicapi_vtproto.pb.go +++ /dev/null @@ -1,441 +0,0 @@ -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: host/subsonicapi/subsonicapi.proto - -package subsonicapi - -import ( - fmt "fmt" - protoimpl "google.golang.org/protobuf/runtime/protoimpl" - io "io" - bits "math/bits" -) - -const ( - // Verify that this generated code is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion) - // Verify that runtime/protoimpl is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) -) - -func (m *CallRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *CallRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *CallRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Url) > 0 { - i -= len(m.Url) - copy(dAtA[i:], m.Url) - i = encodeVarint(dAtA, i, uint64(len(m.Url))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *CallResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *CallResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *CallResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Error) > 0 { - i -= len(m.Error) - copy(dAtA[i:], m.Error) - i = encodeVarint(dAtA, i, uint64(len(m.Error))) - i-- - dAtA[i] = 0x12 - } - if len(m.Json) > 0 { - i -= len(m.Json) - copy(dAtA[i:], m.Json) - i = encodeVarint(dAtA, i, uint64(len(m.Json))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func encodeVarint(dAtA []byte, offset int, v uint64) int { - offset -= sov(v) - base := offset - for v >= 1<<7 { - dAtA[offset] = uint8(v&0x7f | 0x80) - v >>= 7 - offset++ - } - dAtA[offset] = uint8(v) - return base -} -func (m *CallRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Url) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *CallResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Json) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Error) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func sov(x uint64) (n int) { - return (bits.Len64(x|1) + 6) / 7 -} -func soz(x uint64) (n int) { - return sov(uint64((x << 1) ^ uint64((int64(x) >> 63)))) -} -func (m *CallRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: CallRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: CallRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Url", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Url = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *CallResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: CallResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: CallResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Json", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Json = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Error", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Error = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} - -func skip(dAtA []byte) (n int, err error) { - l := len(dAtA) - iNdEx := 0 - depth := 0 - for iNdEx < l { - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return 0, ErrIntOverflow - } - if iNdEx >= l { - return 0, io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= (uint64(b) & 0x7F) << shift - if b < 0x80 { - break - } - } - wireType := int(wire & 0x7) - switch wireType { - case 0: - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return 0, ErrIntOverflow - } - if iNdEx >= l { - return 0, io.ErrUnexpectedEOF - } - iNdEx++ - if dAtA[iNdEx-1] < 0x80 { - break - } - } - case 1: - iNdEx += 8 - case 2: - var length int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return 0, ErrIntOverflow - } - if iNdEx >= l { - return 0, io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - length |= (int(b) & 0x7F) << shift - if b < 0x80 { - break - } - } - if length < 0 { - return 0, ErrInvalidLength - } - iNdEx += length - case 3: - depth++ - case 4: - if depth == 0 { - return 0, ErrUnexpectedEndOfGroup - } - depth-- - case 5: - iNdEx += 4 - default: - return 0, fmt.Errorf("proto: illegal wireType %d", wireType) - } - if iNdEx < 0 { - return 0, ErrInvalidLength - } - if depth == 0 { - return iNdEx, nil - } - } - return 0, io.ErrUnexpectedEOF -} - -var ( - ErrInvalidLength = fmt.Errorf("proto: negative length found during unmarshaling") - ErrIntOverflow = fmt.Errorf("proto: integer overflow") - ErrUnexpectedEndOfGroup = fmt.Errorf("proto: unexpected end of group") -) diff --git a/plugins/host/subsonicapi_gen.go b/plugins/host/subsonicapi_gen.go new file mode 100644 index 000000000..52474030e --- /dev/null +++ b/plugins/host/subsonicapi_gen.go @@ -0,0 +1,136 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package host + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// SubsonicAPICallRequest is the request type for SubsonicAPI.Call. +type SubsonicAPICallRequest struct { + Uri string `json:"uri"` +} + +// SubsonicAPICallResponse is the response type for SubsonicAPI.Call. +type SubsonicAPICallResponse struct { + ResponseJSON string `json:"responseJson,omitempty"` + Error string `json:"error,omitempty"` +} + +// SubsonicAPICallRawRequest is the request type for SubsonicAPI.CallRaw. +type SubsonicAPICallRawRequest struct { + Uri string `json:"uri"` +} + +// SubsonicAPICallRawResponse is the response type for SubsonicAPI.CallRaw. +type SubsonicAPICallRawResponse struct { + ContentType string `json:"contentType,omitempty"` + Data []byte `json:"data,omitempty"` + Error string `json:"error,omitempty"` +} + +// RegisterSubsonicAPIHostFunctions registers SubsonicAPI service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterSubsonicAPIHostFunctions(service SubsonicAPIService) []extism.HostFunction { + return []extism.HostFunction{ + newSubsonicAPICallHostFunction(service), + newSubsonicAPICallRawHostFunction(service), + } +} + +func newSubsonicAPICallHostFunction(service SubsonicAPIService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "subsonicapi_call", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + subsonicapiWriteError(p, stack, err) + return + } + var req SubsonicAPICallRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + subsonicapiWriteError(p, stack, err) + return + } + + // Call the service method + responsejson, svcErr := service.Call(ctx, req.Uri) + if svcErr != nil { + subsonicapiWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := SubsonicAPICallResponse{ + ResponseJSON: responsejson, + } + subsonicapiWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newSubsonicAPICallRawHostFunction(service SubsonicAPIService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "subsonicapi_callraw", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + subsonicapiWriteError(p, stack, err) + return + } + var req SubsonicAPICallRawRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + subsonicapiWriteError(p, stack, err) + return + } + + // Call the service method + contenttype, data, svcErr := service.CallRaw(ctx, req.Uri) + if svcErr != nil { + subsonicapiWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := SubsonicAPICallRawResponse{ + ContentType: contenttype, + Data: data, + } + subsonicapiWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// subsonicapiWriteResponse writes a JSON response to plugin memory. +func subsonicapiWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + subsonicapiWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// subsonicapiWriteError writes an error response to plugin memory. +func subsonicapiWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/host/task.go b/plugins/host/task.go new file mode 100644 index 000000000..dcaf7197e --- /dev/null +++ b/plugins/host/task.go @@ -0,0 +1,73 @@ +package host + +import "context" + +// TaskInfo holds the current state of a task. +type TaskInfo struct { + // Status is the current task status: "pending", "running", + // "completed", "failed", or "cancelled". + Status string `json:"status"` + // Message is the status/result message returned by the plugin callback. + Message string `json:"message"` + // Attempt is the current or last attempt number (1-based). + Attempt int32 `json:"attempt"` +} + +// QueueConfig holds configuration for a task queue. +type QueueConfig struct { + // Concurrency is the max number of parallel workers. Default: 1. + // Capped by the plugin's manifest maxConcurrency. + Concurrency int32 `json:"concurrency"` + + // MaxRetries is the number of times to retry a failed task. Default: 0. + MaxRetries int32 `json:"maxRetries"` + + // BackoffMs is the initial backoff between retries in milliseconds. + // Doubles each retry (exponential: backoffMs * 2^(attempt-1)). Default: 1000. + BackoffMs int64 `json:"backoffMs"` + + // DelayMs is the minimum delay between starting consecutive tasks + // in milliseconds. Useful for rate limiting. Default: 0. + DelayMs int64 `json:"delayMs"` + + // RetentionMs is how long completed/failed/cancelled tasks are kept + // in milliseconds. Default: 3600000 (1h). Min: 60000 (1m). Max: 604800000 (1w). + RetentionMs int64 `json:"retentionMs"` +} + +// TaskService provides persistent task queues for plugins. +// +// This service allows plugins to create named queues with configurable concurrency, +// retry policies, and rate limiting. Tasks are persisted to SQLite and survive +// server restarts. When a task is ready to execute, the host calls the plugin's +// nd_task_execute callback function. +// +//nd:hostservice name=Task permission=taskqueue +type TaskService interface { + // CreateQueue creates a named task queue with the given configuration. + // Zero-value fields in config use sensible defaults. + // If a queue with the same name already exists, returns an error. + // On startup, this also recovers any stale "running" tasks from a previous crash. + //nd:hostfunc + CreateQueue(ctx context.Context, name string, config QueueConfig) error + + // Enqueue adds a task to the named queue. Returns the task ID. + // payload is opaque bytes passed back to the plugin on execution. + //nd:hostfunc + Enqueue(ctx context.Context, queueName string, payload []byte) (string, error) + + // Get returns the current state of a task including its status, + // message, and attempt count. + //nd:hostfunc + Get(ctx context.Context, taskID string) (*TaskInfo, error) + + // Cancel cancels a pending task. Returns error if already + // running, completed, or failed. + //nd:hostfunc + Cancel(ctx context.Context, taskID string) error + + // ClearQueue removes all pending tasks from the named queue. + // Running tasks are not affected. Returns the number of tasks removed. + //nd:hostfunc + ClearQueue(ctx context.Context, queueName string) (int64, error) +} diff --git a/plugins/host/task_gen.go b/plugins/host/task_gen.go new file mode 100644 index 000000000..e4864bb5b --- /dev/null +++ b/plugins/host/task_gen.go @@ -0,0 +1,266 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package host + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// TaskCreateQueueRequest is the request type for Task.CreateQueue. +type TaskCreateQueueRequest struct { + Name string `json:"name"` + Config QueueConfig `json:"config"` +} + +// TaskCreateQueueResponse is the response type for Task.CreateQueue. +type TaskCreateQueueResponse struct { + Error string `json:"error,omitempty"` +} + +// TaskEnqueueRequest is the request type for Task.Enqueue. +type TaskEnqueueRequest struct { + QueueName string `json:"queueName"` + Payload []byte `json:"payload"` +} + +// TaskEnqueueResponse is the response type for Task.Enqueue. +type TaskEnqueueResponse struct { + Result string `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// TaskGetRequest is the request type for Task.Get. +type TaskGetRequest struct { + TaskID string `json:"taskId"` +} + +// TaskGetResponse is the response type for Task.Get. +type TaskGetResponse struct { + Result *TaskInfo `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// TaskCancelRequest is the request type for Task.Cancel. +type TaskCancelRequest struct { + TaskID string `json:"taskId"` +} + +// TaskCancelResponse is the response type for Task.Cancel. +type TaskCancelResponse struct { + Error string `json:"error,omitempty"` +} + +// TaskClearQueueRequest is the request type for Task.ClearQueue. +type TaskClearQueueRequest struct { + QueueName string `json:"queueName"` +} + +// TaskClearQueueResponse is the response type for Task.ClearQueue. +type TaskClearQueueResponse struct { + Result int64 `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// RegisterTaskHostFunctions registers Task service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterTaskHostFunctions(service TaskService) []extism.HostFunction { + return []extism.HostFunction{ + newTaskCreateQueueHostFunction(service), + newTaskEnqueueHostFunction(service), + newTaskGetHostFunction(service), + newTaskCancelHostFunction(service), + newTaskClearQueueHostFunction(service), + } +} + +func newTaskCreateQueueHostFunction(service TaskService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "task_createqueue", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + taskWriteError(p, stack, err) + return + } + var req TaskCreateQueueRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + taskWriteError(p, stack, err) + return + } + + // Call the service method + if svcErr := service.CreateQueue(ctx, req.Name, req.Config); svcErr != nil { + taskWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := TaskCreateQueueResponse{} + taskWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newTaskEnqueueHostFunction(service TaskService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "task_enqueue", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + taskWriteError(p, stack, err) + return + } + var req TaskEnqueueRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + taskWriteError(p, stack, err) + return + } + + // Call the service method + result, svcErr := service.Enqueue(ctx, req.QueueName, req.Payload) + if svcErr != nil { + taskWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := TaskEnqueueResponse{ + Result: result, + } + taskWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newTaskGetHostFunction(service TaskService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "task_get", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + taskWriteError(p, stack, err) + return + } + var req TaskGetRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + taskWriteError(p, stack, err) + return + } + + // Call the service method + result, svcErr := service.Get(ctx, req.TaskID) + if svcErr != nil { + taskWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := TaskGetResponse{ + Result: result, + } + taskWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newTaskCancelHostFunction(service TaskService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "task_cancel", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + taskWriteError(p, stack, err) + return + } + var req TaskCancelRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + taskWriteError(p, stack, err) + return + } + + // Call the service method + if svcErr := service.Cancel(ctx, req.TaskID); svcErr != nil { + taskWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := TaskCancelResponse{} + taskWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newTaskClearQueueHostFunction(service TaskService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "task_clearqueue", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + taskWriteError(p, stack, err) + return + } + var req TaskClearQueueRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + taskWriteError(p, stack, err) + return + } + + // Call the service method + result, svcErr := service.ClearQueue(ctx, req.QueueName) + if svcErr != nil { + taskWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := TaskClearQueueResponse{ + Result: result, + } + taskWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// taskWriteResponse writes a JSON response to plugin memory. +func taskWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + taskWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// taskWriteError writes an error response to plugin memory. +func taskWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/host/users.go b/plugins/host/users.go new file mode 100644 index 000000000..c05a0c797 --- /dev/null +++ b/plugins/host/users.go @@ -0,0 +1,35 @@ +package host + +import "context" + +// User represents a Navidrome user with minimal information exposed to plugins. +// Sensitive fields like password, email, and internal IDs are intentionally excluded. +type User struct { + UserName string `json:"userName"` + Name string `json:"name"` + IsAdmin bool `json:"isAdmin"` +} + +// UsersService provides access to user information for plugins. +// +// This service allows plugins to query information about users that the plugin +// has been granted access to. Access is controlled by the administrator who +// configures which users each plugin can see. +// +//nd:hostservice name=Users permission=users +type UsersService interface { + // GetUsers returns all users the plugin has been granted access to. + // Only minimal user information (userName, name, isAdmin) is returned. + // Sensitive fields like password and email are never exposed. + // + // Returns a slice of users the plugin can access, or an empty slice if none configured. + //nd:hostfunc + GetUsers(ctx context.Context) ([]User, error) + + // GetAdmins returns only admin users the plugin has been granted access to. + // This is a convenience method that filters GetUsers results to include only admins. + // + // Returns a slice of admin users the plugin can access, or an empty slice if none. + //nd:hostfunc + GetAdmins(ctx context.Context) ([]User, error) +} diff --git a/plugins/host/users_gen.go b/plugins/host/users_gen.go new file mode 100644 index 000000000..4e7210991 --- /dev/null +++ b/plugins/host/users_gen.go @@ -0,0 +1,102 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package host + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// UsersGetUsersResponse is the response type for Users.GetUsers. +type UsersGetUsersResponse struct { + Result []User `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// UsersGetAdminsResponse is the response type for Users.GetAdmins. +type UsersGetAdminsResponse struct { + Result []User `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// RegisterUsersHostFunctions registers Users service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterUsersHostFunctions(service UsersService) []extism.HostFunction { + return []extism.HostFunction{ + newUsersGetUsersHostFunction(service), + newUsersGetAdminsHostFunction(service), + } +} + +func newUsersGetUsersHostFunction(service UsersService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "users_getusers", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + + // Call the service method + result, svcErr := service.GetUsers(ctx) + if svcErr != nil { + usersWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := UsersGetUsersResponse{ + Result: result, + } + usersWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newUsersGetAdminsHostFunction(service UsersService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "users_getadmins", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + + // Call the service method + result, svcErr := service.GetAdmins(ctx) + if svcErr != nil { + usersWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := UsersGetAdminsResponse{ + Result: result, + } + usersWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// usersWriteResponse writes a JSON response to plugin memory. +func usersWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + usersWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// usersWriteError writes an error response to plugin memory. +func usersWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/host/websocket.go b/plugins/host/websocket.go new file mode 100644 index 000000000..434a28a8a --- /dev/null +++ b/plugins/host/websocket.go @@ -0,0 +1,59 @@ +package host + +import "context" + +// WebSocketService provides WebSocket communication capabilities for plugins. +// +// This service allows plugins to establish WebSocket connections to external services, +// send and receive messages, and manage connection lifecycle. Plugins using this service +// must implement the WebSocketCallback capability to receive incoming messages and +// connection state changes. +// +//nd:hostservice name=WebSocket permission=websocket +type WebSocketService interface { + // Connect establishes a WebSocket connection to the specified URL. + // + // Plugins that use this function must also implement the WebSocketCallback capability + // to receive incoming messages and connection events. + // + // Parameters: + // - url: The WebSocket URL to connect to (ws:// or wss://) + // - headers: Optional HTTP headers to include in the handshake request + // - connectionID: Optional unique identifier for the connection. If empty, one will be generated + // + // Returns the connection ID that can be used to send messages or close the connection, + // or an error if the connection fails. + //nd:hostfunc + Connect(ctx context.Context, url string, headers map[string]string, connectionID string) (newConnectionID string, err error) + + // SendText sends a text message over an established WebSocket connection. + // + // Parameters: + // - connectionID: The connection identifier returned by Connect + // - message: The text message to send + // + // Returns an error if the connection is not found or if sending fails. + //nd:hostfunc + SendText(ctx context.Context, connectionID, message string) error + + // SendBinary sends binary data over an established WebSocket connection. + // + // Parameters: + // - connectionID: The connection identifier returned by Connect + // - data: The binary data to send + // + // Returns an error if the connection is not found or if sending fails. + //nd:hostfunc + SendBinary(ctx context.Context, connectionID string, data []byte) error + + // CloseConnection gracefully closes a WebSocket connection. + // + // Parameters: + // - connectionID: The connection identifier returned by Connect + // - code: WebSocket close status code (e.g., 1000 for normal closure) + // - reason: Optional human-readable reason for closing + // + // Returns an error if the connection is not found or if closing fails. + //nd:hostfunc + CloseConnection(ctx context.Context, connectionID string, code int32, reason string) error +} diff --git a/plugins/host/websocket/websocket.pb.go b/plugins/host/websocket/websocket.pb.go deleted file mode 100644 index f3ab68963..000000000 --- a/plugins/host/websocket/websocket.pb.go +++ /dev/null @@ -1,240 +0,0 @@ -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: host/websocket/websocket.proto - -package websocket - -import ( - context "context" - protoreflect "google.golang.org/protobuf/reflect/protoreflect" - protoimpl "google.golang.org/protobuf/runtime/protoimpl" -) - -const ( - // Verify that this generated code is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion) - // Verify that runtime/protoimpl is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) -) - -type ConnectRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"` - Headers map[string]string `protobuf:"bytes,2,rep,name=headers,proto3" json:"headers,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"` - ConnectionId string `protobuf:"bytes,3,opt,name=connection_id,json=connectionId,proto3" json:"connection_id,omitempty"` -} - -func (x *ConnectRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *ConnectRequest) GetUrl() string { - if x != nil { - return x.Url - } - return "" -} - -func (x *ConnectRequest) GetHeaders() map[string]string { - if x != nil { - return x.Headers - } - return nil -} - -func (x *ConnectRequest) GetConnectionId() string { - if x != nil { - return x.ConnectionId - } - return "" -} - -type ConnectResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - ConnectionId string `protobuf:"bytes,1,opt,name=connection_id,json=connectionId,proto3" json:"connection_id,omitempty"` - Error string `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"` -} - -func (x *ConnectResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *ConnectResponse) GetConnectionId() string { - if x != nil { - return x.ConnectionId - } - return "" -} - -func (x *ConnectResponse) GetError() string { - if x != nil { - return x.Error - } - return "" -} - -type SendTextRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - ConnectionId string `protobuf:"bytes,1,opt,name=connection_id,json=connectionId,proto3" json:"connection_id,omitempty"` - Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"` -} - -func (x *SendTextRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *SendTextRequest) GetConnectionId() string { - if x != nil { - return x.ConnectionId - } - return "" -} - -func (x *SendTextRequest) GetMessage() string { - if x != nil { - return x.Message - } - return "" -} - -type SendTextResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Error string `protobuf:"bytes,1,opt,name=error,proto3" json:"error,omitempty"` -} - -func (x *SendTextResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *SendTextResponse) GetError() string { - if x != nil { - return x.Error - } - return "" -} - -type SendBinaryRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - ConnectionId string `protobuf:"bytes,1,opt,name=connection_id,json=connectionId,proto3" json:"connection_id,omitempty"` - Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"` -} - -func (x *SendBinaryRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *SendBinaryRequest) GetConnectionId() string { - if x != nil { - return x.ConnectionId - } - return "" -} - -func (x *SendBinaryRequest) GetData() []byte { - if x != nil { - return x.Data - } - return nil -} - -type SendBinaryResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Error string `protobuf:"bytes,1,opt,name=error,proto3" json:"error,omitempty"` -} - -func (x *SendBinaryResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *SendBinaryResponse) GetError() string { - if x != nil { - return x.Error - } - return "" -} - -type CloseRequest struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - ConnectionId string `protobuf:"bytes,1,opt,name=connection_id,json=connectionId,proto3" json:"connection_id,omitempty"` - Code int32 `protobuf:"varint,2,opt,name=code,proto3" json:"code,omitempty"` - Reason string `protobuf:"bytes,3,opt,name=reason,proto3" json:"reason,omitempty"` -} - -func (x *CloseRequest) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *CloseRequest) GetConnectionId() string { - if x != nil { - return x.ConnectionId - } - return "" -} - -func (x *CloseRequest) GetCode() int32 { - if x != nil { - return x.Code - } - return 0 -} - -func (x *CloseRequest) GetReason() string { - if x != nil { - return x.Reason - } - return "" -} - -type CloseResponse struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Error string `protobuf:"bytes,1,opt,name=error,proto3" json:"error,omitempty"` -} - -func (x *CloseResponse) ProtoReflect() protoreflect.Message { - panic(`not implemented`) -} - -func (x *CloseResponse) GetError() string { - if x != nil { - return x.Error - } - return "" -} - -// go:plugin type=host version=1 -type WebSocketService interface { - // Connect to a WebSocket endpoint - Connect(context.Context, *ConnectRequest) (*ConnectResponse, error) - // Send a text message - SendText(context.Context, *SendTextRequest) (*SendTextResponse, error) - // Send binary data - SendBinary(context.Context, *SendBinaryRequest) (*SendBinaryResponse, error) - // Close a connection - Close(context.Context, *CloseRequest) (*CloseResponse, error) -} diff --git a/plugins/host/websocket/websocket.proto b/plugins/host/websocket/websocket.proto deleted file mode 100644 index 53adaca95..000000000 --- a/plugins/host/websocket/websocket.proto +++ /dev/null @@ -1,57 +0,0 @@ -syntax = "proto3"; -package websocket; -option go_package = "github.com/navidrome/navidrome/plugins/host/websocket"; - -// go:plugin type=host version=1 -service WebSocketService { - // Connect to a WebSocket endpoint - rpc Connect(ConnectRequest) returns (ConnectResponse); - - // Send a text message - rpc SendText(SendTextRequest) returns (SendTextResponse); - - // Send binary data - rpc SendBinary(SendBinaryRequest) returns (SendBinaryResponse); - - // Close a connection - rpc Close(CloseRequest) returns (CloseResponse); -} - -message ConnectRequest { - string url = 1; - map<string, string> headers = 2; - string connection_id = 3; -} - -message ConnectResponse { - string connection_id = 1; - string error = 2; -} - -message SendTextRequest { - string connection_id = 1; - string message = 2; -} - -message SendTextResponse { - string error = 1; -} - -message SendBinaryRequest { - string connection_id = 1; - bytes data = 2; -} - -message SendBinaryResponse { - string error = 1; -} - -message CloseRequest { - string connection_id = 1; - int32 code = 2; - string reason = 3; -} - -message CloseResponse { - string error = 1; -} \ No newline at end of file diff --git a/plugins/host/websocket/websocket_host.pb.go b/plugins/host/websocket/websocket_host.pb.go deleted file mode 100644 index b95eb451c..000000000 --- a/plugins/host/websocket/websocket_host.pb.go +++ /dev/null @@ -1,170 +0,0 @@ -//go:build !wasip1 - -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: host/websocket/websocket.proto - -package websocket - -import ( - context "context" - wasm "github.com/knqyf263/go-plugin/wasm" - wazero "github.com/tetratelabs/wazero" - api "github.com/tetratelabs/wazero/api" -) - -const ( - i32 = api.ValueTypeI32 - i64 = api.ValueTypeI64 -) - -type _webSocketService struct { - WebSocketService -} - -// Instantiate a Go-defined module named "env" that exports host functions. -func Instantiate(ctx context.Context, r wazero.Runtime, hostFunctions WebSocketService) error { - envBuilder := r.NewHostModuleBuilder("env") - h := _webSocketService{hostFunctions} - - envBuilder.NewFunctionBuilder(). - WithGoModuleFunction(api.GoModuleFunc(h._Connect), []api.ValueType{i32, i32}, []api.ValueType{i64}). - WithParameterNames("offset", "size"). - Export("connect") - - envBuilder.NewFunctionBuilder(). - WithGoModuleFunction(api.GoModuleFunc(h._SendText), []api.ValueType{i32, i32}, []api.ValueType{i64}). - WithParameterNames("offset", "size"). - Export("send_text") - - envBuilder.NewFunctionBuilder(). - WithGoModuleFunction(api.GoModuleFunc(h._SendBinary), []api.ValueType{i32, i32}, []api.ValueType{i64}). - WithParameterNames("offset", "size"). - Export("send_binary") - - envBuilder.NewFunctionBuilder(). - WithGoModuleFunction(api.GoModuleFunc(h._Close), []api.ValueType{i32, i32}, []api.ValueType{i64}). - WithParameterNames("offset", "size"). - Export("close") - - _, err := envBuilder.Instantiate(ctx) - return err -} - -// Connect to a WebSocket endpoint - -func (h _webSocketService) _Connect(ctx context.Context, m api.Module, stack []uint64) { - offset, size := uint32(stack[0]), uint32(stack[1]) - buf, err := wasm.ReadMemory(m.Memory(), offset, size) - if err != nil { - panic(err) - } - request := new(ConnectRequest) - err = request.UnmarshalVT(buf) - if err != nil { - panic(err) - } - resp, err := h.Connect(ctx, request) - if err != nil { - panic(err) - } - buf, err = resp.MarshalVT() - if err != nil { - panic(err) - } - ptr, err := wasm.WriteMemory(ctx, m, buf) - if err != nil { - panic(err) - } - ptrLen := (ptr << uint64(32)) | uint64(len(buf)) - stack[0] = ptrLen -} - -// Send a text message - -func (h _webSocketService) _SendText(ctx context.Context, m api.Module, stack []uint64) { - offset, size := uint32(stack[0]), uint32(stack[1]) - buf, err := wasm.ReadMemory(m.Memory(), offset, size) - if err != nil { - panic(err) - } - request := new(SendTextRequest) - err = request.UnmarshalVT(buf) - if err != nil { - panic(err) - } - resp, err := h.SendText(ctx, request) - if err != nil { - panic(err) - } - buf, err = resp.MarshalVT() - if err != nil { - panic(err) - } - ptr, err := wasm.WriteMemory(ctx, m, buf) - if err != nil { - panic(err) - } - ptrLen := (ptr << uint64(32)) | uint64(len(buf)) - stack[0] = ptrLen -} - -// Send binary data - -func (h _webSocketService) _SendBinary(ctx context.Context, m api.Module, stack []uint64) { - offset, size := uint32(stack[0]), uint32(stack[1]) - buf, err := wasm.ReadMemory(m.Memory(), offset, size) - if err != nil { - panic(err) - } - request := new(SendBinaryRequest) - err = request.UnmarshalVT(buf) - if err != nil { - panic(err) - } - resp, err := h.SendBinary(ctx, request) - if err != nil { - panic(err) - } - buf, err = resp.MarshalVT() - if err != nil { - panic(err) - } - ptr, err := wasm.WriteMemory(ctx, m, buf) - if err != nil { - panic(err) - } - ptrLen := (ptr << uint64(32)) | uint64(len(buf)) - stack[0] = ptrLen -} - -// Close a connection - -func (h _webSocketService) _Close(ctx context.Context, m api.Module, stack []uint64) { - offset, size := uint32(stack[0]), uint32(stack[1]) - buf, err := wasm.ReadMemory(m.Memory(), offset, size) - if err != nil { - panic(err) - } - request := new(CloseRequest) - err = request.UnmarshalVT(buf) - if err != nil { - panic(err) - } - resp, err := h.Close(ctx, request) - if err != nil { - panic(err) - } - buf, err = resp.MarshalVT() - if err != nil { - panic(err) - } - ptr, err := wasm.WriteMemory(ctx, m, buf) - if err != nil { - panic(err) - } - ptrLen := (ptr << uint64(32)) | uint64(len(buf)) - stack[0] = ptrLen -} diff --git a/plugins/host/websocket/websocket_plugin.pb.go b/plugins/host/websocket/websocket_plugin.pb.go deleted file mode 100644 index e7d5c3fe0..000000000 --- a/plugins/host/websocket/websocket_plugin.pb.go +++ /dev/null @@ -1,113 +0,0 @@ -//go:build wasip1 - -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: host/websocket/websocket.proto - -package websocket - -import ( - context "context" - wasm "github.com/knqyf263/go-plugin/wasm" - _ "unsafe" -) - -type webSocketService struct{} - -func NewWebSocketService() WebSocketService { - return webSocketService{} -} - -//go:wasmimport env connect -func _connect(ptr uint32, size uint32) uint64 - -func (h webSocketService) Connect(ctx context.Context, request *ConnectRequest) (*ConnectResponse, error) { - buf, err := request.MarshalVT() - if err != nil { - return nil, err - } - ptr, size := wasm.ByteToPtr(buf) - ptrSize := _connect(ptr, size) - wasm.Free(ptr) - - ptr = uint32(ptrSize >> 32) - size = uint32(ptrSize) - buf = wasm.PtrToByte(ptr, size) - - response := new(ConnectResponse) - if err = response.UnmarshalVT(buf); err != nil { - return nil, err - } - return response, nil -} - -//go:wasmimport env send_text -func _send_text(ptr uint32, size uint32) uint64 - -func (h webSocketService) SendText(ctx context.Context, request *SendTextRequest) (*SendTextResponse, error) { - buf, err := request.MarshalVT() - if err != nil { - return nil, err - } - ptr, size := wasm.ByteToPtr(buf) - ptrSize := _send_text(ptr, size) - wasm.Free(ptr) - - ptr = uint32(ptrSize >> 32) - size = uint32(ptrSize) - buf = wasm.PtrToByte(ptr, size) - - response := new(SendTextResponse) - if err = response.UnmarshalVT(buf); err != nil { - return nil, err - } - return response, nil -} - -//go:wasmimport env send_binary -func _send_binary(ptr uint32, size uint32) uint64 - -func (h webSocketService) SendBinary(ctx context.Context, request *SendBinaryRequest) (*SendBinaryResponse, error) { - buf, err := request.MarshalVT() - if err != nil { - return nil, err - } - ptr, size := wasm.ByteToPtr(buf) - ptrSize := _send_binary(ptr, size) - wasm.Free(ptr) - - ptr = uint32(ptrSize >> 32) - size = uint32(ptrSize) - buf = wasm.PtrToByte(ptr, size) - - response := new(SendBinaryResponse) - if err = response.UnmarshalVT(buf); err != nil { - return nil, err - } - return response, nil -} - -//go:wasmimport env close -func _close(ptr uint32, size uint32) uint64 - -func (h webSocketService) Close(ctx context.Context, request *CloseRequest) (*CloseResponse, error) { - buf, err := request.MarshalVT() - if err != nil { - return nil, err - } - ptr, size := wasm.ByteToPtr(buf) - ptrSize := _close(ptr, size) - wasm.Free(ptr) - - ptr = uint32(ptrSize >> 32) - size = uint32(ptrSize) - buf = wasm.PtrToByte(ptr, size) - - response := new(CloseResponse) - if err = response.UnmarshalVT(buf); err != nil { - return nil, err - } - return response, nil -} diff --git a/plugins/host/websocket/websocket_plugin_dev.go b/plugins/host/websocket/websocket_plugin_dev.go deleted file mode 100644 index cfb72462a..000000000 --- a/plugins/host/websocket/websocket_plugin_dev.go +++ /dev/null @@ -1,7 +0,0 @@ -//go:build !wasip1 - -package websocket - -func NewWebSocketService() WebSocketService { - panic("not implemented") -} diff --git a/plugins/host/websocket/websocket_vtproto.pb.go b/plugins/host/websocket/websocket_vtproto.pb.go deleted file mode 100644 index fb15a22b7..000000000 --- a/plugins/host/websocket/websocket_vtproto.pb.go +++ /dev/null @@ -1,1618 +0,0 @@ -// Code generated by protoc-gen-go-plugin. DO NOT EDIT. -// versions: -// protoc-gen-go-plugin v0.1.0 -// protoc v5.29.3 -// source: host/websocket/websocket.proto - -package websocket - -import ( - fmt "fmt" - protoimpl "google.golang.org/protobuf/runtime/protoimpl" - io "io" - bits "math/bits" -) - -const ( - // Verify that this generated code is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion) - // Verify that runtime/protoimpl is sufficiently up-to-date. - _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) -) - -func (m *ConnectRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *ConnectRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *ConnectRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.ConnectionId) > 0 { - i -= len(m.ConnectionId) - copy(dAtA[i:], m.ConnectionId) - i = encodeVarint(dAtA, i, uint64(len(m.ConnectionId))) - i-- - dAtA[i] = 0x1a - } - if len(m.Headers) > 0 { - for k := range m.Headers { - v := m.Headers[k] - baseI := i - i -= len(v) - copy(dAtA[i:], v) - i = encodeVarint(dAtA, i, uint64(len(v))) - i-- - dAtA[i] = 0x12 - i -= len(k) - copy(dAtA[i:], k) - i = encodeVarint(dAtA, i, uint64(len(k))) - i-- - dAtA[i] = 0xa - i = encodeVarint(dAtA, i, uint64(baseI-i)) - i-- - dAtA[i] = 0x12 - } - } - if len(m.Url) > 0 { - i -= len(m.Url) - copy(dAtA[i:], m.Url) - i = encodeVarint(dAtA, i, uint64(len(m.Url))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *ConnectResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *ConnectResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *ConnectResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Error) > 0 { - i -= len(m.Error) - copy(dAtA[i:], m.Error) - i = encodeVarint(dAtA, i, uint64(len(m.Error))) - i-- - dAtA[i] = 0x12 - } - if len(m.ConnectionId) > 0 { - i -= len(m.ConnectionId) - copy(dAtA[i:], m.ConnectionId) - i = encodeVarint(dAtA, i, uint64(len(m.ConnectionId))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *SendTextRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *SendTextRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *SendTextRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Message) > 0 { - i -= len(m.Message) - copy(dAtA[i:], m.Message) - i = encodeVarint(dAtA, i, uint64(len(m.Message))) - i-- - dAtA[i] = 0x12 - } - if len(m.ConnectionId) > 0 { - i -= len(m.ConnectionId) - copy(dAtA[i:], m.ConnectionId) - i = encodeVarint(dAtA, i, uint64(len(m.ConnectionId))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *SendTextResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *SendTextResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *SendTextResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Error) > 0 { - i -= len(m.Error) - copy(dAtA[i:], m.Error) - i = encodeVarint(dAtA, i, uint64(len(m.Error))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *SendBinaryRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *SendBinaryRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *SendBinaryRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Data) > 0 { - i -= len(m.Data) - copy(dAtA[i:], m.Data) - i = encodeVarint(dAtA, i, uint64(len(m.Data))) - i-- - dAtA[i] = 0x12 - } - if len(m.ConnectionId) > 0 { - i -= len(m.ConnectionId) - copy(dAtA[i:], m.ConnectionId) - i = encodeVarint(dAtA, i, uint64(len(m.ConnectionId))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *SendBinaryResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *SendBinaryResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *SendBinaryResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Error) > 0 { - i -= len(m.Error) - copy(dAtA[i:], m.Error) - i = encodeVarint(dAtA, i, uint64(len(m.Error))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *CloseRequest) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *CloseRequest) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *CloseRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Reason) > 0 { - i -= len(m.Reason) - copy(dAtA[i:], m.Reason) - i = encodeVarint(dAtA, i, uint64(len(m.Reason))) - i-- - dAtA[i] = 0x1a - } - if m.Code != 0 { - i = encodeVarint(dAtA, i, uint64(m.Code)) - i-- - dAtA[i] = 0x10 - } - if len(m.ConnectionId) > 0 { - i -= len(m.ConnectionId) - copy(dAtA[i:], m.ConnectionId) - i = encodeVarint(dAtA, i, uint64(len(m.ConnectionId))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func (m *CloseResponse) MarshalVT() (dAtA []byte, err error) { - if m == nil { - return nil, nil - } - size := m.SizeVT() - dAtA = make([]byte, size) - n, err := m.MarshalToSizedBufferVT(dAtA[:size]) - if err != nil { - return nil, err - } - return dAtA[:n], nil -} - -func (m *CloseResponse) MarshalToVT(dAtA []byte) (int, error) { - size := m.SizeVT() - return m.MarshalToSizedBufferVT(dAtA[:size]) -} - -func (m *CloseResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error) { - if m == nil { - return 0, nil - } - i := len(dAtA) - _ = i - var l int - _ = l - if m.unknownFields != nil { - i -= len(m.unknownFields) - copy(dAtA[i:], m.unknownFields) - } - if len(m.Error) > 0 { - i -= len(m.Error) - copy(dAtA[i:], m.Error) - i = encodeVarint(dAtA, i, uint64(len(m.Error))) - i-- - dAtA[i] = 0xa - } - return len(dAtA) - i, nil -} - -func encodeVarint(dAtA []byte, offset int, v uint64) int { - offset -= sov(v) - base := offset - for v >= 1<<7 { - dAtA[offset] = uint8(v&0x7f | 0x80) - v >>= 7 - offset++ - } - dAtA[offset] = uint8(v) - return base -} -func (m *ConnectRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Url) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - if len(m.Headers) > 0 { - for k, v := range m.Headers { - _ = k - _ = v - mapEntrySize := 1 + len(k) + sov(uint64(len(k))) + 1 + len(v) + sov(uint64(len(v))) - n += mapEntrySize + 1 + sov(uint64(mapEntrySize)) - } - } - l = len(m.ConnectionId) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *ConnectResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.ConnectionId) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Error) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *SendTextRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.ConnectionId) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Message) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *SendTextResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Error) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *SendBinaryRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.ConnectionId) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - l = len(m.Data) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *SendBinaryResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Error) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *CloseRequest) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.ConnectionId) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - if m.Code != 0 { - n += 1 + sov(uint64(m.Code)) - } - l = len(m.Reason) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func (m *CloseResponse) SizeVT() (n int) { - if m == nil { - return 0 - } - var l int - _ = l - l = len(m.Error) - if l > 0 { - n += 1 + l + sov(uint64(l)) - } - n += len(m.unknownFields) - return n -} - -func sov(x uint64) (n int) { - return (bits.Len64(x|1) + 6) / 7 -} -func soz(x uint64) (n int) { - return sov(uint64((x << 1) ^ uint64((int64(x) >> 63)))) -} -func (m *ConnectRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: ConnectRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: ConnectRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Url", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Url = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Headers", wireType) - } - var msglen int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - msglen |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - if msglen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + msglen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - if m.Headers == nil { - m.Headers = make(map[string]string) - } - var mapkey string - var mapvalue string - for iNdEx < postIndex { - entryPreIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - if fieldNum == 1 { - var stringLenmapkey uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLenmapkey |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLenmapkey := int(stringLenmapkey) - if intStringLenmapkey < 0 { - return ErrInvalidLength - } - postStringIndexmapkey := iNdEx + intStringLenmapkey - if postStringIndexmapkey < 0 { - return ErrInvalidLength - } - if postStringIndexmapkey > l { - return io.ErrUnexpectedEOF - } - mapkey = string(dAtA[iNdEx:postStringIndexmapkey]) - iNdEx = postStringIndexmapkey - } else if fieldNum == 2 { - var stringLenmapvalue uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLenmapvalue |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLenmapvalue := int(stringLenmapvalue) - if intStringLenmapvalue < 0 { - return ErrInvalidLength - } - postStringIndexmapvalue := iNdEx + intStringLenmapvalue - if postStringIndexmapvalue < 0 { - return ErrInvalidLength - } - if postStringIndexmapvalue > l { - return io.ErrUnexpectedEOF - } - mapvalue = string(dAtA[iNdEx:postStringIndexmapvalue]) - iNdEx = postStringIndexmapvalue - } else { - iNdEx = entryPreIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > postIndex { - return io.ErrUnexpectedEOF - } - iNdEx += skippy - } - } - m.Headers[mapkey] = mapvalue - iNdEx = postIndex - case 3: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field ConnectionId", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.ConnectionId = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *ConnectResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: ConnectResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: ConnectResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field ConnectionId", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.ConnectionId = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Error", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Error = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *SendTextRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: SendTextRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: SendTextRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field ConnectionId", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.ConnectionId = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Message", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Message = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *SendTextResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: SendTextResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: SendTextResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Error", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Error = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *SendBinaryRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: SendBinaryRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: SendBinaryRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field ConnectionId", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.ConnectionId = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Data", wireType) - } - var byteLen int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - byteLen |= int(b&0x7F) << shift - if b < 0x80 { - break - } - } - if byteLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + byteLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Data = append(m.Data[:0], dAtA[iNdEx:postIndex]...) - if m.Data == nil { - m.Data = []byte{} - } - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *SendBinaryResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: SendBinaryResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: SendBinaryResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Error", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Error = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *CloseRequest) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: CloseRequest: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: CloseRequest: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field ConnectionId", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.ConnectionId = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - case 2: - if wireType != 0 { - return fmt.Errorf("proto: wrong wireType = %d for field Code", wireType) - } - m.Code = 0 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - m.Code |= int32(b&0x7F) << shift - if b < 0x80 { - break - } - } - case 3: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Reason", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Reason = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} -func (m *CloseResponse) UnmarshalVT(dAtA []byte) error { - l := len(dAtA) - iNdEx := 0 - for iNdEx < l { - preIndex := iNdEx - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - fieldNum := int32(wire >> 3) - wireType := int(wire & 0x7) - if wireType == 4 { - return fmt.Errorf("proto: CloseResponse: wiretype end group for non-group") - } - if fieldNum <= 0 { - return fmt.Errorf("proto: CloseResponse: illegal tag %d (wire type %d)", fieldNum, wire) - } - switch fieldNum { - case 1: - if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Error", wireType) - } - var stringLen uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return ErrIntOverflow - } - if iNdEx >= l { - return io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - stringLen |= uint64(b&0x7F) << shift - if b < 0x80 { - break - } - } - intStringLen := int(stringLen) - if intStringLen < 0 { - return ErrInvalidLength - } - postIndex := iNdEx + intStringLen - if postIndex < 0 { - return ErrInvalidLength - } - if postIndex > l { - return io.ErrUnexpectedEOF - } - m.Error = string(dAtA[iNdEx:postIndex]) - iNdEx = postIndex - default: - iNdEx = preIndex - skippy, err := skip(dAtA[iNdEx:]) - if err != nil { - return err - } - if (skippy < 0) || (iNdEx+skippy) < 0 { - return ErrInvalidLength - } - if (iNdEx + skippy) > l { - return io.ErrUnexpectedEOF - } - m.unknownFields = append(m.unknownFields, dAtA[iNdEx:iNdEx+skippy]...) - iNdEx += skippy - } - } - - if iNdEx > l { - return io.ErrUnexpectedEOF - } - return nil -} - -func skip(dAtA []byte) (n int, err error) { - l := len(dAtA) - iNdEx := 0 - depth := 0 - for iNdEx < l { - var wire uint64 - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return 0, ErrIntOverflow - } - if iNdEx >= l { - return 0, io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - wire |= (uint64(b) & 0x7F) << shift - if b < 0x80 { - break - } - } - wireType := int(wire & 0x7) - switch wireType { - case 0: - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return 0, ErrIntOverflow - } - if iNdEx >= l { - return 0, io.ErrUnexpectedEOF - } - iNdEx++ - if dAtA[iNdEx-1] < 0x80 { - break - } - } - case 1: - iNdEx += 8 - case 2: - var length int - for shift := uint(0); ; shift += 7 { - if shift >= 64 { - return 0, ErrIntOverflow - } - if iNdEx >= l { - return 0, io.ErrUnexpectedEOF - } - b := dAtA[iNdEx] - iNdEx++ - length |= (int(b) & 0x7F) << shift - if b < 0x80 { - break - } - } - if length < 0 { - return 0, ErrInvalidLength - } - iNdEx += length - case 3: - depth++ - case 4: - if depth == 0 { - return 0, ErrUnexpectedEndOfGroup - } - depth-- - case 5: - iNdEx += 4 - default: - return 0, fmt.Errorf("proto: illegal wireType %d", wireType) - } - if iNdEx < 0 { - return 0, ErrInvalidLength - } - if depth == 0 { - return iNdEx, nil - } - } - return 0, io.ErrUnexpectedEOF -} - -var ( - ErrInvalidLength = fmt.Errorf("proto: negative length found during unmarshaling") - ErrIntOverflow = fmt.Errorf("proto: integer overflow") - ErrUnexpectedEndOfGroup = fmt.Errorf("proto: unexpected end of group") -) diff --git a/plugins/host/websocket_gen.go b/plugins/host/websocket_gen.go new file mode 100644 index 000000000..b7b630674 --- /dev/null +++ b/plugins/host/websocket_gen.go @@ -0,0 +1,220 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package host + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// WebSocketConnectRequest is the request type for WebSocket.Connect. +type WebSocketConnectRequest struct { + Url string `json:"url"` + Headers map[string]string `json:"headers"` + ConnectionID string `json:"connectionId"` +} + +// WebSocketConnectResponse is the response type for WebSocket.Connect. +type WebSocketConnectResponse struct { + NewConnectionID string `json:"newConnectionId,omitempty"` + Error string `json:"error,omitempty"` +} + +// WebSocketSendTextRequest is the request type for WebSocket.SendText. +type WebSocketSendTextRequest struct { + ConnectionID string `json:"connectionId"` + Message string `json:"message"` +} + +// WebSocketSendTextResponse is the response type for WebSocket.SendText. +type WebSocketSendTextResponse struct { + Error string `json:"error,omitempty"` +} + +// WebSocketSendBinaryRequest is the request type for WebSocket.SendBinary. +type WebSocketSendBinaryRequest struct { + ConnectionID string `json:"connectionId"` + Data []byte `json:"data"` +} + +// WebSocketSendBinaryResponse is the response type for WebSocket.SendBinary. +type WebSocketSendBinaryResponse struct { + Error string `json:"error,omitempty"` +} + +// WebSocketCloseConnectionRequest is the request type for WebSocket.CloseConnection. +type WebSocketCloseConnectionRequest struct { + ConnectionID string `json:"connectionId"` + Code int32 `json:"code"` + Reason string `json:"reason"` +} + +// WebSocketCloseConnectionResponse is the response type for WebSocket.CloseConnection. +type WebSocketCloseConnectionResponse struct { + Error string `json:"error,omitempty"` +} + +// RegisterWebSocketHostFunctions registers WebSocket service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterWebSocketHostFunctions(service WebSocketService) []extism.HostFunction { + return []extism.HostFunction{ + newWebSocketConnectHostFunction(service), + newWebSocketSendTextHostFunction(service), + newWebSocketSendBinaryHostFunction(service), + newWebSocketCloseConnectionHostFunction(service), + } +} + +func newWebSocketConnectHostFunction(service WebSocketService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "websocket_connect", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + websocketWriteError(p, stack, err) + return + } + var req WebSocketConnectRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + websocketWriteError(p, stack, err) + return + } + + // Call the service method + newconnectionid, svcErr := service.Connect(ctx, req.Url, req.Headers, req.ConnectionID) + if svcErr != nil { + websocketWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := WebSocketConnectResponse{ + NewConnectionID: newconnectionid, + } + websocketWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newWebSocketSendTextHostFunction(service WebSocketService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "websocket_sendtext", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + websocketWriteError(p, stack, err) + return + } + var req WebSocketSendTextRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + websocketWriteError(p, stack, err) + return + } + + // Call the service method + if svcErr := service.SendText(ctx, req.ConnectionID, req.Message); svcErr != nil { + websocketWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := WebSocketSendTextResponse{} + websocketWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newWebSocketSendBinaryHostFunction(service WebSocketService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "websocket_sendbinary", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + websocketWriteError(p, stack, err) + return + } + var req WebSocketSendBinaryRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + websocketWriteError(p, stack, err) + return + } + + // Call the service method + if svcErr := service.SendBinary(ctx, req.ConnectionID, req.Data); svcErr != nil { + websocketWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := WebSocketSendBinaryResponse{} + websocketWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newWebSocketCloseConnectionHostFunction(service WebSocketService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "websocket_closeconnection", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + websocketWriteError(p, stack, err) + return + } + var req WebSocketCloseConnectionRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + websocketWriteError(p, stack, err) + return + } + + // Call the service method + if svcErr := service.CloseConnection(ctx, req.ConnectionID, req.Code, req.Reason); svcErr != nil { + websocketWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := WebSocketCloseConnectionResponse{} + websocketWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// websocketWriteResponse writes a JSON response to plugin memory. +func websocketWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + websocketWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// websocketWriteError writes an error response to plugin memory. +func websocketWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/host_artwork.go b/plugins/host_artwork.go index dac622206..49b9a285d 100644 --- a/plugins/host_artwork.go +++ b/plugins/host_artwork.go @@ -2,46 +2,36 @@ package plugins import ( "context" - "fmt" - "net/http" - "net/url" - "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/core/publicurl" "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/plugins/host/artwork" - "github.com/navidrome/navidrome/server/public" + "github.com/navidrome/navidrome/plugins/host" ) type artworkServiceImpl struct{} -func (a *artworkServiceImpl) GetArtistUrl(_ context.Context, req *artwork.GetArtworkUrlRequest) (*artwork.GetArtworkUrlResponse, error) { - artID := model.ArtworkID{Kind: model.KindArtistArtwork, ID: req.Id} - imageURL := public.ImageURL(a.createRequest(), artID, int(req.Size)) - return &artwork.GetArtworkUrlResponse{Url: imageURL}, nil +func newArtworkService() host.ArtworkService { + return &artworkServiceImpl{} } -func (a *artworkServiceImpl) GetAlbumUrl(_ context.Context, req *artwork.GetArtworkUrlRequest) (*artwork.GetArtworkUrlResponse, error) { - artID := model.ArtworkID{Kind: model.KindAlbumArtwork, ID: req.Id} - imageURL := public.ImageURL(a.createRequest(), artID, int(req.Size)) - return &artwork.GetArtworkUrlResponse{Url: imageURL}, nil +func (a *artworkServiceImpl) GetArtistUrl(_ context.Context, id string, size int32) (string, error) { + artID := model.ArtworkID{Kind: model.KindArtistArtwork, ID: id} + return publicurl.ImageURL(nil, artID, int(size)), nil } -func (a *artworkServiceImpl) GetTrackUrl(_ context.Context, req *artwork.GetArtworkUrlRequest) (*artwork.GetArtworkUrlResponse, error) { - artID := model.ArtworkID{Kind: model.KindMediaFileArtwork, ID: req.Id} - imageURL := public.ImageURL(a.createRequest(), artID, int(req.Size)) - return &artwork.GetArtworkUrlResponse{Url: imageURL}, nil +func (a *artworkServiceImpl) GetAlbumUrl(_ context.Context, id string, size int32) (string, error) { + artID := model.ArtworkID{Kind: model.KindAlbumArtwork, ID: id} + return publicurl.ImageURL(nil, artID, int(size)), nil } -func (a *artworkServiceImpl) createRequest() *http.Request { - var scheme, host string - if conf.Server.ShareURL != "" { - shareURL, _ := url.Parse(conf.Server.ShareURL) - scheme = shareURL.Scheme - host = shareURL.Host - } else { - scheme = "http" - host = "localhost" - } - r, _ := http.NewRequest("GET", fmt.Sprintf("%s://%s", scheme, host), nil) - return r +func (a *artworkServiceImpl) GetTrackUrl(_ context.Context, id string, size int32) (string, error) { + artID := model.ArtworkID{Kind: model.KindMediaFileArtwork, ID: id} + return publicurl.ImageURL(nil, artID, int(size)), nil } + +func (a *artworkServiceImpl) GetPlaylistUrl(_ context.Context, id string, size int32) (string, error) { + artID := model.ArtworkID{Kind: model.KindPlaylistArtwork, ID: id} + return publicurl.ImageURL(nil, artID, int(size)), nil +} + +var _ host.ArtworkService = (*artworkServiceImpl)(nil) diff --git a/plugins/host_artwork_test.go b/plugins/host_artwork_test.go index b6667bde3..151a0d03c 100644 --- a/plugins/host_artwork_test.go +++ b/plugins/host_artwork_test.go @@ -1,58 +1,240 @@ +//go:build !windows + package plugins import ( "context" + "crypto/sha256" + "encoding/hex" + "encoding/json" + "net/http" + "os" + "path/filepath" + "strings" - "github.com/go-chi/jwtauth/v5" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/conf/configtest" "github.com/navidrome/navidrome/core/auth" - "github.com/navidrome/navidrome/plugins/host/artwork" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) -var _ = Describe("ArtworkService", func() { - var svc *artworkServiceImpl +var _ = Describe("ArtworkService", Ordered, func() { + var ( + manager *Manager + tmpDir string + ) - BeforeEach(func() { + BeforeAll(func() { + var err error + tmpDir, err = os.MkdirTemp("", "artwork-test-*") + Expect(err).ToNot(HaveOccurred()) + + // Copy the test-artwork plugin + srcPath := filepath.Join(testdataDir, "test-artwork"+PackageExtension) + destPath := filepath.Join(tmpDir, "test-artwork"+PackageExtension) + data, err := os.ReadFile(srcPath) + Expect(err).ToNot(HaveOccurred()) + err = os.WriteFile(destPath, data, 0600) + Expect(err).ToNot(HaveOccurred()) + + // Compute SHA256 for the plugin + hash := sha256.Sum256(data) + hashHex := hex.EncodeToString(hash[:]) + + // Setup config DeferCleanup(configtest.SetupConfig()) - // Setup auth for tests - auth.TokenAuth = jwtauth.New("HS256", []byte("super secret"), nil) - svc = &artworkServiceImpl{} - }) + conf.Server.Plugins.Enabled = true + conf.Server.Plugins.Folder = tmpDir + conf.Server.Plugins.AutoReload = false - Context("with ShareURL configured", func() { - BeforeEach(func() { - conf.Server.ShareURL = "https://music.example.com" - }) + // Initialize auth (required for token generation) + ds := &tests.MockDataStore{MockedProperty: &tests.MockedPropertyRepo{}} + auth.Init(ds) - It("returns artist artwork URL", func() { - resp, err := svc.GetArtistUrl(context.Background(), &artwork.GetArtworkUrlRequest{Id: "123", Size: 300}) - Expect(err).ToNot(HaveOccurred()) - Expect(resp.Url).To(ContainSubstring("https://music.example.com")) - Expect(resp.Url).To(ContainSubstring("size=300")) - }) + // Setup mock DataStore with pre-enabled plugin + mockPluginRepo := tests.CreateMockPluginRepo() + mockPluginRepo.Permitted = true + mockPluginRepo.SetData(model.Plugins{{ + ID: "test-artwork", + Path: destPath, + SHA256: hashHex, + Enabled: true, + }}) + dataStore := &tests.MockDataStore{ + MockedProperty: &tests.MockedPropertyRepo{}, + MockedPlugin: mockPluginRepo, + } - It("returns album artwork URL", func() { - resp, err := svc.GetAlbumUrl(context.Background(), &artwork.GetArtworkUrlRequest{Id: "456"}) - Expect(err).ToNot(HaveOccurred()) - Expect(resp.Url).To(ContainSubstring("https://music.example.com")) - }) + // Create and start manager + manager = &Manager{ + plugins: make(map[string]*plugin), + ds: dataStore, + subsonicRouter: http.NotFoundHandler(), + } + err = manager.Start(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) - It("returns track artwork URL", func() { - resp, err := svc.GetTrackUrl(context.Background(), &artwork.GetArtworkUrlRequest{Id: "789", Size: 150}) - Expect(err).ToNot(HaveOccurred()) - Expect(resp.Url).To(ContainSubstring("https://music.example.com")) - Expect(resp.Url).To(ContainSubstring("size=150")) + DeferCleanup(func() { + _ = manager.Stop() + _ = os.RemoveAll(tmpDir) }) }) - Context("without ShareURL configured", func() { - It("returns localhost URLs", func() { - resp, err := svc.GetArtistUrl(context.Background(), &artwork.GetArtworkUrlRequest{Id: "123"}) + Describe("Plugin Loading", func() { + It("should load plugin with artwork permission", func() { + manager.mu.RLock() + p, ok := manager.plugins["test-artwork"] + manager.mu.RUnlock() + Expect(ok).To(BeTrue()) + Expect(p.manifest.Permissions).ToNot(BeNil()) + Expect(p.manifest.Permissions.Artwork).ToNot(BeNil()) + }) + }) + + Describe("Artwork URL Generation", func() { + type testArtworkInput struct { + ArtworkType string `json:"artwork_type"` + ID string `json:"id"` + Size int32 `json:"size"` + } + type testArtworkOutput struct { + URL string `json:"url,omitempty"` + Error *string `json:"error,omitempty"` + } + + callTestArtwork := func(ctx context.Context, artworkType, id string, size int32) (string, error) { + manager.mu.RLock() + p := manager.plugins["test-artwork"] + manager.mu.RUnlock() + + instance, err := p.instance(ctx) + if err != nil { + return "", err + } + defer instance.Close(ctx) + + input := testArtworkInput{ + ArtworkType: artworkType, + ID: id, + Size: size, + } + inputBytes, _ := json.Marshal(input) + _, outputBytes, err := instance.Call("nd_test_artwork", inputBytes) + if err != nil { + return "", err + } + + var output testArtworkOutput + if err := json.Unmarshal(outputBytes, &output); err != nil { + return "", err + } + if output.Error != nil { + return "", Errorf(*output.Error) + } + return output.URL, nil + } + + It("should generate artist artwork URL", func() { + url, err := callTestArtwork(GinkgoT().Context(), "artist", "ar-123", 0) Expect(err).ToNot(HaveOccurred()) - Expect(resp.Url).To(ContainSubstring("http://localhost")) + Expect(url).To(ContainSubstring("/img/")) + Expect(url).ToNot(ContainSubstring("size=")) + + // Decode JWT and verify artwork ID + artID := decodeArtworkURL(url) + Expect(artID.Kind).To(Equal(model.KindArtistArtwork)) + Expect(artID.ID).To(Equal("ar-123")) + }) + + It("should generate album artwork URL", func() { + url, err := callTestArtwork(GinkgoT().Context(), "album", "al-456", 0) + Expect(err).ToNot(HaveOccurred()) + Expect(url).To(ContainSubstring("/img/")) + + artID := decodeArtworkURL(url) + Expect(artID.Kind).To(Equal(model.KindAlbumArtwork)) + Expect(artID.ID).To(Equal("al-456")) + }) + + It("should generate track artwork URL", func() { + url, err := callTestArtwork(GinkgoT().Context(), "track", "mf-789", 0) + Expect(err).ToNot(HaveOccurred()) + Expect(url).To(ContainSubstring("/img/")) + + artID := decodeArtworkURL(url) + Expect(artID.Kind).To(Equal(model.KindMediaFileArtwork)) + Expect(artID.ID).To(Equal("mf-789")) + }) + + It("should generate playlist artwork URL", func() { + url, err := callTestArtwork(GinkgoT().Context(), "playlist", "pl-abc", 0) + Expect(err).ToNot(HaveOccurred()) + Expect(url).To(ContainSubstring("/img/")) + + artID := decodeArtworkURL(url) + Expect(artID.Kind).To(Equal(model.KindPlaylistArtwork)) + Expect(artID.ID).To(Equal("pl-abc")) + }) + + It("should include size parameter when specified", func() { + url, err := callTestArtwork(GinkgoT().Context(), "album", "al-456", 300) + Expect(err).ToNot(HaveOccurred()) + Expect(url).To(ContainSubstring("size=300")) + + artID := decodeArtworkURL(url) + Expect(artID.Kind).To(Equal(model.KindAlbumArtwork)) + Expect(artID.ID).To(Equal("al-456")) + }) + + It("should handle unknown artwork type", func() { + _, err := callTestArtwork(GinkgoT().Context(), "unknown", "id-123", 0) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("unknown artwork type")) }) }) }) + +// Errorf creates an error from a format string (helper for tests) +func Errorf(format string, args ...any) error { + return &errorString{s: format} +} + +type errorString struct { + s string +} + +func (e *errorString) Error() string { + return e.s +} + +// decodeArtworkURL extracts and decodes the JWT token from an artwork URL, +// returning the parsed ArtworkID. Panics on error (test helper). +func decodeArtworkURL(artworkURL string) model.ArtworkID { + // URL format: http://localhost/img/<token>?size=... + // Extract token from path after /img/ + idx := strings.Index(artworkURL, "/img/") + Expect(idx).To(BeNumerically(">=", 0), "URL should contain /img/") + + tokenPart := artworkURL[idx+5:] // skip "/img/" + // Remove query string if present + if qIdx := strings.Index(tokenPart, "?"); qIdx >= 0 { + tokenPart = tokenPart[:qIdx] + } + + // Decode JWT token + token, err := auth.TokenAuth.Decode(tokenPart) + Expect(err).ToNot(HaveOccurred(), "Failed to decode JWT token") + + c := auth.ClaimsFromToken(token) + + id := c.ID + Expect(id).ToNot(BeEmpty(), "Token should contain 'id' claim") + + artID, err := model.ParseArtworkID(id) + Expect(err).ToNot(HaveOccurred(), "Failed to parse artwork ID from token") + + return artID +} diff --git a/plugins/host_cache.go b/plugins/host_cache.go index 291a17870..b90d790cf 100644 --- a/plugins/host_cache.go +++ b/plugins/host_cache.go @@ -2,53 +2,41 @@ package plugins import ( "context" - "sync" "time" "github.com/jellydator/ttlcache/v3" "github.com/navidrome/navidrome/log" - cacheproto "github.com/navidrome/navidrome/plugins/host/cache" + "github.com/navidrome/navidrome/plugins/host" ) const ( defaultCacheTTL = 24 * time.Hour ) -// cacheServiceImpl implements the cache.CacheService interface +// cacheServiceImpl implements the host.CacheService interface. +// Each plugin gets its own cache instance for isolation. type cacheServiceImpl struct { - pluginID string + pluginName string + cache *ttlcache.Cache[string, any] defaultTTL time.Duration } -var ( - _cache *ttlcache.Cache[string, any] - initCacheOnce sync.Once -) - -// newCacheService creates a new cacheServiceImpl instance -func newCacheService(pluginID string) *cacheServiceImpl { - initCacheOnce.Do(func() { - opts := []ttlcache.Option[string, any]{ - ttlcache.WithTTL[string, any](defaultCacheTTL), - } - _cache = ttlcache.New[string, any](opts...) - - // Start the janitor goroutine to clean up expired entries - go _cache.Start() - }) +// newCacheService creates a new cacheServiceImpl instance with its own cache. +func newCacheService(pluginName string) *cacheServiceImpl { + cache := ttlcache.New[string, any]( + ttlcache.WithTTL[string, any](defaultCacheTTL), + ) + // Start the janitor goroutine to clean up expired entries + go cache.Start() return &cacheServiceImpl{ - pluginID: pluginID, + pluginName: pluginName, + cache: cache, defaultTTL: defaultCacheTTL, } } -// mapKey combines the plugin name and a provided key to create a unique cache key. -func (s *cacheServiceImpl) mapKey(key string) string { - return s.pluginID + ":" + key -} - -// getTTL converts seconds to a duration, using default if 0 +// getTTL converts seconds to a duration, using default if 0 or negative func (s *cacheServiceImpl) getTTL(seconds int64) time.Duration { if seconds <= 0 { return s.defaultTTL @@ -56,97 +44,110 @@ func (s *cacheServiceImpl) getTTL(seconds int64) time.Duration { return time.Duration(seconds) * time.Second } -// setCacheValue is a generic function to set a value in the cache -func setCacheValue[T any](ctx context.Context, cs *cacheServiceImpl, key string, value T, ttlSeconds int64) (*cacheproto.SetResponse, error) { - ttl := cs.getTTL(ttlSeconds) - key = cs.mapKey(key) - _cache.Set(key, value, ttl) - return &cacheproto.SetResponse{Success: true}, nil +// SetString stores a string value in the cache. +func (s *cacheServiceImpl) SetString(ctx context.Context, key string, value string, ttlSeconds int64) error { + s.cache.Set(key, value, s.getTTL(ttlSeconds)) + return nil } -// getCacheValue is a generic function to get a value from the cache -func getCacheValue[T any](ctx context.Context, cs *cacheServiceImpl, key string, typeName string) (T, bool, error) { - key = cs.mapKey(key) - var zero T - item := _cache.Get(key) +// GetString retrieves a string value from the cache. +func (s *cacheServiceImpl) GetString(ctx context.Context, key string) (string, bool, error) { + item := s.cache.Get(key) if item == nil { - return zero, false, nil + return "", false, nil } - value, ok := item.Value().(T) + value, ok := item.Value().(string) if !ok { - log.Debug(ctx, "Type mismatch in cache", "plugin", cs.pluginID, "key", key, "expected", typeName) - return zero, false, nil + log.Debug(ctx, "Cache type mismatch", "plugin", s.pluginName, "key", key, "expected", "string") + return "", false, nil } return value, true, nil } -// SetString sets a string value in the cache -func (s *cacheServiceImpl) SetString(ctx context.Context, req *cacheproto.SetStringRequest) (*cacheproto.SetResponse, error) { - return setCacheValue(ctx, s, req.Key, req.Value, req.TtlSeconds) +// SetInt stores an integer value in the cache. +func (s *cacheServiceImpl) SetInt(ctx context.Context, key string, value int64, ttlSeconds int64) error { + s.cache.Set(key, value, s.getTTL(ttlSeconds)) + return nil } -// GetString gets a string value from the cache -func (s *cacheServiceImpl) GetString(ctx context.Context, req *cacheproto.GetRequest) (*cacheproto.GetStringResponse, error) { - value, exists, err := getCacheValue[string](ctx, s, req.Key, "string") - if err != nil { - return nil, err +// GetInt retrieves an integer value from the cache. +func (s *cacheServiceImpl) GetInt(ctx context.Context, key string) (int64, bool, error) { + item := s.cache.Get(key) + if item == nil { + return 0, false, nil } - return &cacheproto.GetStringResponse{Exists: exists, Value: value}, nil -} -// SetInt sets an integer value in the cache -func (s *cacheServiceImpl) SetInt(ctx context.Context, req *cacheproto.SetIntRequest) (*cacheproto.SetResponse, error) { - return setCacheValue(ctx, s, req.Key, req.Value, req.TtlSeconds) -} - -// GetInt gets an integer value from the cache -func (s *cacheServiceImpl) GetInt(ctx context.Context, req *cacheproto.GetRequest) (*cacheproto.GetIntResponse, error) { - value, exists, err := getCacheValue[int64](ctx, s, req.Key, "int64") - if err != nil { - return nil, err + value, ok := item.Value().(int64) + if !ok { + log.Debug(ctx, "Cache type mismatch", "plugin", s.pluginName, "key", key, "expected", "int64") + return 0, false, nil } - return &cacheproto.GetIntResponse{Exists: exists, Value: value}, nil + return value, true, nil } -// SetFloat sets a float value in the cache -func (s *cacheServiceImpl) SetFloat(ctx context.Context, req *cacheproto.SetFloatRequest) (*cacheproto.SetResponse, error) { - return setCacheValue(ctx, s, req.Key, req.Value, req.TtlSeconds) +// SetFloat stores a float value in the cache. +func (s *cacheServiceImpl) SetFloat(ctx context.Context, key string, value float64, ttlSeconds int64) error { + s.cache.Set(key, value, s.getTTL(ttlSeconds)) + return nil } -// GetFloat gets a float value from the cache -func (s *cacheServiceImpl) GetFloat(ctx context.Context, req *cacheproto.GetRequest) (*cacheproto.GetFloatResponse, error) { - value, exists, err := getCacheValue[float64](ctx, s, req.Key, "float64") - if err != nil { - return nil, err +// GetFloat retrieves a float value from the cache. +func (s *cacheServiceImpl) GetFloat(ctx context.Context, key string) (float64, bool, error) { + item := s.cache.Get(key) + if item == nil { + return 0, false, nil } - return &cacheproto.GetFloatResponse{Exists: exists, Value: value}, nil -} -// SetBytes sets a byte slice value in the cache -func (s *cacheServiceImpl) SetBytes(ctx context.Context, req *cacheproto.SetBytesRequest) (*cacheproto.SetResponse, error) { - return setCacheValue(ctx, s, req.Key, req.Value, req.TtlSeconds) -} - -// GetBytes gets a byte slice value from the cache -func (s *cacheServiceImpl) GetBytes(ctx context.Context, req *cacheproto.GetRequest) (*cacheproto.GetBytesResponse, error) { - value, exists, err := getCacheValue[[]byte](ctx, s, req.Key, "[]byte") - if err != nil { - return nil, err + value, ok := item.Value().(float64) + if !ok { + log.Debug(ctx, "Cache type mismatch", "plugin", s.pluginName, "key", key, "expected", "float64") + return 0, false, nil } - return &cacheproto.GetBytesResponse{Exists: exists, Value: value}, nil + return value, true, nil } -// Remove removes a value from the cache -func (s *cacheServiceImpl) Remove(ctx context.Context, req *cacheproto.RemoveRequest) (*cacheproto.RemoveResponse, error) { - key := s.mapKey(req.Key) - _cache.Delete(key) - return &cacheproto.RemoveResponse{Success: true}, nil +// SetBytes stores a byte slice in the cache. +func (s *cacheServiceImpl) SetBytes(ctx context.Context, key string, value []byte, ttlSeconds int64) error { + s.cache.Set(key, value, s.getTTL(ttlSeconds)) + return nil } -// Has checks if a key exists in the cache -func (s *cacheServiceImpl) Has(ctx context.Context, req *cacheproto.HasRequest) (*cacheproto.HasResponse, error) { - key := s.mapKey(req.Key) - item := _cache.Get(key) - return &cacheproto.HasResponse{Exists: item != nil}, nil +// GetBytes retrieves a byte slice from the cache. +func (s *cacheServiceImpl) GetBytes(ctx context.Context, key string) ([]byte, bool, error) { + item := s.cache.Get(key) + if item == nil { + return nil, false, nil + } + + value, ok := item.Value().([]byte) + if !ok { + log.Debug(ctx, "Cache type mismatch", "plugin", s.pluginName, "key", key, "expected", "[]byte") + return nil, false, nil + } + return value, true, nil } + +// Has checks if a key exists in the cache. +func (s *cacheServiceImpl) Has(ctx context.Context, key string) (bool, error) { + item := s.cache.Get(key) + return item != nil, nil +} + +// Remove deletes a value from the cache. +func (s *cacheServiceImpl) Remove(ctx context.Context, key string) error { + s.cache.Delete(key) + return nil +} + +// Close stops the cache's janitor goroutine and clears all entries. +// This is called when the plugin is unloaded. +func (s *cacheServiceImpl) Close() error { + s.cache.Stop() + s.cache.DeleteAll() + log.Debug("Closed plugin cache", "plugin", s.pluginName) + return nil +} + +// Ensure cacheServiceImpl implements host.CacheService +var _ host.CacheService = (*cacheServiceImpl)(nil) diff --git a/plugins/host_cache_test.go b/plugins/host_cache_test.go index efb03e289..0f55bcfda 100644 --- a/plugins/host_cache_test.go +++ b/plugins/host_cache_test.go @@ -1,10 +1,22 @@ +//go:build !windows + package plugins import ( "context" + "crypto/sha256" + "encoding/hex" + "encoding/json" + "errors" + "net/http" + "os" + "path/filepath" "time" - "github.com/navidrome/navidrome/plugins/host/cache" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) @@ -18,6 +30,12 @@ var _ = Describe("CacheService", func() { service = newCacheService("test_plugin") }) + AfterEach(func() { + if service != nil { + service.Close() + } + }) + Describe("getTTL", func() { It("returns default TTL when seconds is 0", func() { ttl := service.getTTL(0) @@ -35,137 +53,549 @@ var _ = Describe("CacheService", func() { }) }) + Describe("Plugin Isolation", func() { + It("isolates keys between plugins", func() { + service1 := newCacheService("plugin1") + defer service1.Close() + service2 := newCacheService("plugin2") + defer service2.Close() + + // Both plugins set same key + err := service1.SetString(ctx, "shared", "value1", 0) + Expect(err).ToNot(HaveOccurred()) + err = service2.SetString(ctx, "shared", "value2", 0) + Expect(err).ToNot(HaveOccurred()) + + // Each plugin should get their own value + val1, exists1, err := service1.GetString(ctx, "shared") + Expect(err).ToNot(HaveOccurred()) + Expect(exists1).To(BeTrue()) + Expect(val1).To(Equal("value1")) + + val2, exists2, err := service2.GetString(ctx, "shared") + Expect(err).ToNot(HaveOccurred()) + Expect(exists2).To(BeTrue()) + Expect(val2).To(Equal("value2")) + }) + }) + Describe("String Operations", func() { It("sets and gets a string value", func() { - _, err := service.SetString(ctx, &cache.SetStringRequest{ - Key: "string_key", - Value: "test_value", - TtlSeconds: 300, - }) - Expect(err).NotTo(HaveOccurred()) + err := service.SetString(ctx, "string_key", "test_value", 300) + Expect(err).ToNot(HaveOccurred()) - res, err := service.GetString(ctx, &cache.GetRequest{Key: "string_key"}) - Expect(err).NotTo(HaveOccurred()) - Expect(res.Exists).To(BeTrue()) - Expect(res.Value).To(Equal("test_value")) + value, exists, err := service.GetString(ctx, "string_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + Expect(value).To(Equal("test_value")) }) It("returns not exists for missing key", func() { - res, err := service.GetString(ctx, &cache.GetRequest{Key: "missing_key"}) - Expect(err).NotTo(HaveOccurred()) - Expect(res.Exists).To(BeFalse()) + value, exists, err := service.GetString(ctx, "missing_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + Expect(value).To(Equal("")) }) }) Describe("Integer Operations", func() { It("sets and gets an integer value", func() { - _, err := service.SetInt(ctx, &cache.SetIntRequest{ - Key: "int_key", - Value: 42, - TtlSeconds: 300, - }) - Expect(err).NotTo(HaveOccurred()) + err := service.SetInt(ctx, "int_key", 42, 300) + Expect(err).ToNot(HaveOccurred()) - res, err := service.GetInt(ctx, &cache.GetRequest{Key: "int_key"}) - Expect(err).NotTo(HaveOccurred()) - Expect(res.Exists).To(BeTrue()) - Expect(res.Value).To(Equal(int64(42))) + value, exists, err := service.GetInt(ctx, "int_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + Expect(value).To(Equal(int64(42))) + }) + + It("returns not exists for missing key", func() { + value, exists, err := service.GetInt(ctx, "missing_int_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + Expect(value).To(Equal(int64(0))) }) }) Describe("Float Operations", func() { It("sets and gets a float value", func() { - _, err := service.SetFloat(ctx, &cache.SetFloatRequest{ - Key: "float_key", - Value: 3.14, - TtlSeconds: 300, - }) - Expect(err).NotTo(HaveOccurred()) + err := service.SetFloat(ctx, "float_key", 3.14, 300) + Expect(err).ToNot(HaveOccurred()) - res, err := service.GetFloat(ctx, &cache.GetRequest{Key: "float_key"}) - Expect(err).NotTo(HaveOccurred()) - Expect(res.Exists).To(BeTrue()) - Expect(res.Value).To(Equal(3.14)) + value, exists, err := service.GetFloat(ctx, "float_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + Expect(value).To(Equal(3.14)) + }) + + It("returns not exists for missing key", func() { + value, exists, err := service.GetFloat(ctx, "missing_float_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + Expect(value).To(Equal(float64(0))) }) }) Describe("Bytes Operations", func() { It("sets and gets a bytes value", func() { byteData := []byte("hello world") - _, err := service.SetBytes(ctx, &cache.SetBytesRequest{ - Key: "bytes_key", - Value: byteData, - TtlSeconds: 300, - }) - Expect(err).NotTo(HaveOccurred()) + err := service.SetBytes(ctx, "bytes_key", byteData, 300) + Expect(err).ToNot(HaveOccurred()) - res, err := service.GetBytes(ctx, &cache.GetRequest{Key: "bytes_key"}) - Expect(err).NotTo(HaveOccurred()) - Expect(res.Exists).To(BeTrue()) - Expect(res.Value).To(Equal(byteData)) + value, exists, err := service.GetBytes(ctx, "bytes_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + Expect(value).To(Equal(byteData)) + }) + + It("returns not exists for missing key", func() { + value, exists, err := service.GetBytes(ctx, "missing_bytes_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + Expect(value).To(BeNil()) }) }) Describe("Type mismatch handling", func() { It("returns not exists when type doesn't match the getter", func() { // Set string - _, err := service.SetString(ctx, &cache.SetStringRequest{ - Key: "mixed_key", - Value: "string value", - }) - Expect(err).NotTo(HaveOccurred()) + err := service.SetString(ctx, "mixed_key", "string value", 0) + Expect(err).ToNot(HaveOccurred()) // Try to get as int - res, err := service.GetInt(ctx, &cache.GetRequest{Key: "mixed_key"}) - Expect(err).NotTo(HaveOccurred()) - Expect(res.Exists).To(BeFalse()) + value, exists, err := service.GetInt(ctx, "mixed_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + Expect(value).To(Equal(int64(0))) + }) + + It("returns not exists when getting string as float", func() { + err := service.SetString(ctx, "str_as_float", "not a float", 0) + Expect(err).ToNot(HaveOccurred()) + + value, exists, err := service.GetFloat(ctx, "str_as_float") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + Expect(value).To(Equal(float64(0))) + }) + + It("returns not exists when getting int as bytes", func() { + err := service.SetInt(ctx, "int_as_bytes", 123, 0) + Expect(err).ToNot(HaveOccurred()) + + value, exists, err := service.GetBytes(ctx, "int_as_bytes") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + Expect(value).To(BeNil()) + }) + }) + + Describe("Has Operation", func() { + It("returns true for existing key", func() { + err := service.SetString(ctx, "existing_key", "exists", 0) + Expect(err).ToNot(HaveOccurred()) + + exists, err := service.Has(ctx, "existing_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + }) + + It("returns false for non-existing key", func() { + exists, err := service.Has(ctx, "non_existing_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) }) }) Describe("Remove Operation", func() { It("removes a value from the cache", func() { // Set a value - _, err := service.SetString(ctx, &cache.SetStringRequest{ - Key: "remove_key", - Value: "to be removed", - }) - Expect(err).NotTo(HaveOccurred()) + err := service.SetString(ctx, "remove_key", "to be removed", 0) + Expect(err).ToNot(HaveOccurred()) // Verify it exists - res, err := service.Has(ctx, &cache.HasRequest{Key: "remove_key"}) - Expect(err).NotTo(HaveOccurred()) - Expect(res.Exists).To(BeTrue()) + exists, err := service.Has(ctx, "remove_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) // Remove it - _, err = service.Remove(ctx, &cache.RemoveRequest{Key: "remove_key"}) - Expect(err).NotTo(HaveOccurred()) + err = service.Remove(ctx, "remove_key") + Expect(err).ToNot(HaveOccurred()) // Verify it's gone - res, err = service.Has(ctx, &cache.HasRequest{Key: "remove_key"}) - Expect(err).NotTo(HaveOccurred()) - Expect(res.Exists).To(BeFalse()) + exists, err = service.Has(ctx, "remove_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + }) + + It("does not error when removing non-existing key", func() { + err := service.Remove(ctx, "never_existed") + Expect(err).ToNot(HaveOccurred()) }) }) - Describe("Has Operation", func() { - It("returns true for existing key", func() { - // Set a value - _, err := service.SetString(ctx, &cache.SetStringRequest{ - Key: "existing_key", - Value: "exists", - }) - Expect(err).NotTo(HaveOccurred()) + Describe("TTL Behavior", func() { + It("uses default TTL when 0 is provided", func() { + err := service.SetString(ctx, "default_ttl", "value", 0) + Expect(err).ToNot(HaveOccurred()) - // Check if it exists - res, err := service.Has(ctx, &cache.HasRequest{Key: "existing_key"}) - Expect(err).NotTo(HaveOccurred()) - Expect(res.Exists).To(BeTrue()) + // Value should exist immediately + exists, err := service.Has(ctx, "default_ttl") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) }) - It("returns false for non-existing key", func() { - res, err := service.Has(ctx, &cache.HasRequest{Key: "non_existing_key"}) - Expect(err).NotTo(HaveOccurred()) - Expect(res.Exists).To(BeFalse()) + It("uses custom TTL when provided", func() { + err := service.SetString(ctx, "custom_ttl", "value", 300) + Expect(err).ToNot(HaveOccurred()) + + // Value should exist immediately + exists, err := service.Has(ctx, "custom_ttl") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + }) + }) + + Describe("Close", func() { + It("removes all cache entries for the plugin", func() { + // Use a dedicated service for this test + closeService := newCacheService("close_test_plugin") + + // Set multiple values + err := closeService.SetString(ctx, "key1", "value1", 0) + Expect(err).ToNot(HaveOccurred()) + err = closeService.SetInt(ctx, "key2", 42, 0) + Expect(err).ToNot(HaveOccurred()) + err = closeService.SetFloat(ctx, "key3", 3.14, 0) + Expect(err).ToNot(HaveOccurred()) + + // Verify they exist + exists, _ := closeService.Has(ctx, "key1") + Expect(exists).To(BeTrue()) + exists, _ = closeService.Has(ctx, "key2") + Expect(exists).To(BeTrue()) + exists, _ = closeService.Has(ctx, "key3") + Expect(exists).To(BeTrue()) + + // Close the service + err = closeService.Close() + Expect(err).ToNot(HaveOccurred()) + + // All entries should be gone + exists, _ = closeService.Has(ctx, "key1") + Expect(exists).To(BeFalse()) + exists, _ = closeService.Has(ctx, "key2") + Expect(exists).To(BeFalse()) + exists, _ = closeService.Has(ctx, "key3") + Expect(exists).To(BeFalse()) + }) + + It("does not affect other plugins' cache entries", func() { + // Create two services for different plugins + service1 := newCacheService("plugin_close_test1") + service2 := newCacheService("plugin_close_test2") + defer service2.Close() + + // Set values for both plugins + err := service1.SetString(ctx, "key", "value1", 0) + Expect(err).ToNot(HaveOccurred()) + err = service2.SetString(ctx, "key", "value2", 0) + Expect(err).ToNot(HaveOccurred()) + + // Close only service1 + err = service1.Close() + Expect(err).ToNot(HaveOccurred()) + + // service1's key should be gone + exists, _ := service1.Has(ctx, "key") + Expect(exists).To(BeFalse()) + + // service2's key should still exist + exists, _ = service2.Has(ctx, "key") + Expect(exists).To(BeTrue()) + }) + }) +}) + +var _ = Describe("CacheService Integration", Ordered, func() { + var ( + manager *Manager + tmpDir string + ) + + BeforeAll(func() { + var err error + tmpDir, err = os.MkdirTemp("", "cache-test-*") + Expect(err).ToNot(HaveOccurred()) + + // Copy the test-cache-plugin + srcPath := filepath.Join(testdataDir, "test-cache-plugin"+PackageExtension) + destPath := filepath.Join(tmpDir, "test-cache-plugin"+PackageExtension) + data, err := os.ReadFile(srcPath) + Expect(err).ToNot(HaveOccurred()) + err = os.WriteFile(destPath, data, 0600) + Expect(err).ToNot(HaveOccurred()) + + // Compute SHA256 for the plugin + hash := sha256.Sum256(data) + hashHex := hex.EncodeToString(hash[:]) + + // Setup config + DeferCleanup(configtest.SetupConfig()) + conf.Server.Plugins.Enabled = true + conf.Server.Plugins.Folder = tmpDir + conf.Server.Plugins.AutoReload = false + + // Setup mock DataStore with pre-enabled plugin + mockPluginRepo := tests.CreateMockPluginRepo() + mockPluginRepo.Permitted = true + mockPluginRepo.SetData(model.Plugins{{ + ID: "test-cache-plugin", + Path: destPath, + SHA256: hashHex, + Enabled: true, + }}) + dataStore := &tests.MockDataStore{MockedPlugin: mockPluginRepo} + + // Create and start manager + manager = &Manager{ + plugins: make(map[string]*plugin), + ds: dataStore, + subsonicRouter: http.NotFoundHandler(), + } + err = manager.Start(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + + DeferCleanup(func() { + _ = manager.Stop() + _ = os.RemoveAll(tmpDir) + }) + }) + + Describe("Plugin Loading", func() { + It("should load plugin with cache permission", func() { + manager.mu.RLock() + p, ok := manager.plugins["test-cache-plugin"] + manager.mu.RUnlock() + Expect(ok).To(BeTrue()) + Expect(p.manifest.Permissions).ToNot(BeNil()) + Expect(p.manifest.Permissions.Cache).ToNot(BeNil()) + }) + }) + + Describe("Cache Operations via Plugin", func() { + type testCacheInput struct { + Operation string `json:"operation"` + Key string `json:"key"` + StringVal string `json:"string_val,omitempty"` + IntVal int64 `json:"int_val,omitempty"` + FloatVal float64 `json:"float_val,omitempty"` + BytesVal []byte `json:"bytes_val,omitempty"` + TTLSeconds int64 `json:"ttl_seconds,omitempty"` + } + type testCacheOutput struct { + StringVal string `json:"string_val,omitempty"` + IntVal int64 `json:"int_val,omitempty"` + FloatVal float64 `json:"float_val,omitempty"` + BytesVal []byte `json:"bytes_val,omitempty"` + Exists bool `json:"exists,omitempty"` + Error *string `json:"error,omitempty"` + } + + callTestCache := func(ctx context.Context, input testCacheInput) (*testCacheOutput, error) { + manager.mu.RLock() + p := manager.plugins["test-cache-plugin"] + manager.mu.RUnlock() + + instance, err := p.instance(ctx) + if err != nil { + return nil, err + } + defer instance.Close(ctx) + + inputBytes, _ := json.Marshal(input) + _, outputBytes, err := instance.Call("nd_test_cache", inputBytes) + if err != nil { + return nil, err + } + + var output testCacheOutput + if err := json.Unmarshal(outputBytes, &output); err != nil { + return nil, err + } + if output.Error != nil { + return nil, errors.New(*output.Error) + } + return &output, nil + } + + It("should set and get string value", func() { + ctx := GinkgoT().Context() + + // Set string + _, err := callTestCache(ctx, testCacheInput{ + Operation: "set_string", + Key: "test_string", + StringVal: "hello world", + TTLSeconds: 300, + }) + Expect(err).ToNot(HaveOccurred()) + + // Get string + output, err := callTestCache(ctx, testCacheInput{ + Operation: "get_string", + Key: "test_string", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeTrue()) + Expect(output.StringVal).To(Equal("hello world")) + }) + + It("should set and get integer value", func() { + ctx := GinkgoT().Context() + + // Set int + _, err := callTestCache(ctx, testCacheInput{ + Operation: "set_int", + Key: "test_int", + IntVal: 42, + TTLSeconds: 300, + }) + Expect(err).ToNot(HaveOccurred()) + + // Get int + output, err := callTestCache(ctx, testCacheInput{ + Operation: "get_int", + Key: "test_int", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeTrue()) + Expect(output.IntVal).To(Equal(int64(42))) + }) + + It("should set and get float value", func() { + ctx := GinkgoT().Context() + + // Set float + _, err := callTestCache(ctx, testCacheInput{ + Operation: "set_float", + Key: "test_float", + FloatVal: 3.14159, + TTLSeconds: 300, + }) + Expect(err).ToNot(HaveOccurred()) + + // Get float + output, err := callTestCache(ctx, testCacheInput{ + Operation: "get_float", + Key: "test_float", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeTrue()) + Expect(output.FloatVal).To(Equal(3.14159)) + }) + + It("should set and get bytes value", func() { + ctx := GinkgoT().Context() + testBytes := []byte{0x01, 0x02, 0x03, 0x04} + + // Set bytes + _, err := callTestCache(ctx, testCacheInput{ + Operation: "set_bytes", + Key: "test_bytes", + BytesVal: testBytes, + TTLSeconds: 300, + }) + Expect(err).ToNot(HaveOccurred()) + + // Get bytes + output, err := callTestCache(ctx, testCacheInput{ + Operation: "get_bytes", + Key: "test_bytes", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeTrue()) + Expect(output.BytesVal).To(Equal(testBytes)) + }) + + It("should handle binary data with null bytes through WASM", func() { + ctx := GinkgoT().Context() + + // Binary data with null bytes, high bytes, and other edge cases + binaryData := []byte{0x00, 0x01, 0x02, 0xFF, 0xFE, 0x00, 0x80, 0x7F} + + // Set binary bytes + _, err := callTestCache(ctx, testCacheInput{ + Operation: "set_bytes", + Key: "binary_test", + BytesVal: binaryData, + TTLSeconds: 300, + }) + Expect(err).ToNot(HaveOccurred()) + + // Get binary bytes and verify exact match + output, err := callTestCache(ctx, testCacheInput{ + Operation: "get_bytes", + Key: "binary_test", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeTrue()) + Expect(output.BytesVal).To(Equal(binaryData)) + }) + + It("should check if key exists", func() { + ctx := GinkgoT().Context() + + // Set a value + _, err := callTestCache(ctx, testCacheInput{ + Operation: "set_string", + Key: "exists_test", + StringVal: "value", + }) + Expect(err).ToNot(HaveOccurred()) + + // Check has + output, err := callTestCache(ctx, testCacheInput{ + Operation: "has", + Key: "exists_test", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeTrue()) + + // Check non-existent + output, err = callTestCache(ctx, testCacheInput{ + Operation: "has", + Key: "nonexistent", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeFalse()) + }) + + It("should remove a key", func() { + ctx := GinkgoT().Context() + + // Set a value + _, err := callTestCache(ctx, testCacheInput{ + Operation: "set_string", + Key: "remove_test", + StringVal: "value", + }) + Expect(err).ToNot(HaveOccurred()) + + // Remove it + _, err = callTestCache(ctx, testCacheInput{ + Operation: "remove", + Key: "remove_test", + }) + Expect(err).ToNot(HaveOccurred()) + + // Verify it's gone + output, err := callTestCache(ctx, testCacheInput{ + Operation: "has", + Key: "remove_test", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeFalse()) }) }) }) diff --git a/plugins/host_config.go b/plugins/host_config.go index baee6a00c..9e71db72f 100644 --- a/plugins/host_config.go +++ b/plugins/host_config.go @@ -2,21 +2,68 @@ package plugins import ( "context" + "sort" + "strconv" + "strings" - "github.com/navidrome/navidrome/conf" - "github.com/navidrome/navidrome/plugins/host/config" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/plugins/host" ) +// configServiceImpl implements the host.ConfigService interface. +// It provides access to plugin configuration values set in the Navidrome config file. type configServiceImpl struct { - pluginID string + pluginName string + config map[string]string } -func (c *configServiceImpl) GetPluginConfig(ctx context.Context, req *config.GetPluginConfigRequest) (*config.GetPluginConfigResponse, error) { - cfg, ok := conf.Server.PluginConfig[c.pluginID] - if !ok { - cfg = map[string]string{} +// newConfigService creates a new configServiceImpl instance. +func newConfigService(pluginName string, config map[string]string) *configServiceImpl { + if config == nil { + config = make(map[string]string) + } + return &configServiceImpl{ + pluginName: pluginName, + config: config, } - return &config.GetPluginConfigResponse{ - Config: cfg, - }, nil } + +// Get retrieves a configuration value as a string. +func (s *configServiceImpl) Get(ctx context.Context, key string) (string, bool) { + value, exists := s.config[key] + log.Trace(ctx, "Config.Get", "plugin", s.pluginName, "key", key, "exists", exists) + return value, exists +} + +// GetInt retrieves a configuration value as an integer. +func (s *configServiceImpl) GetInt(ctx context.Context, key string) (int64, bool) { + value, exists := s.config[key] + if !exists { + log.Trace(ctx, "Config.GetInt", "plugin", s.pluginName, "key", key, "exists", false) + return 0, false + } + + intValue, err := strconv.ParseInt(value, 10, 64) + if err != nil { + log.Trace(ctx, "Config.GetInt parse error", "plugin", s.pluginName, "key", key, "value", value, "error", err) + return 0, false + } + + log.Trace(ctx, "Config.GetInt", "plugin", s.pluginName, "key", key, "value", intValue) + return intValue, true +} + +// Keys returns configuration keys matching the given prefix. +func (s *configServiceImpl) Keys(ctx context.Context, prefix string) []string { + keys := make([]string, 0, len(s.config)) + for k := range s.config { + if prefix == "" || strings.HasPrefix(k, prefix) { + keys = append(keys, k) + } + } + sort.Strings(keys) + log.Trace(ctx, "Config.Keys", "plugin", s.pluginName, "prefix", prefix, "keyCount", len(keys)) + return keys +} + +var _ host.ConfigService = (*configServiceImpl)(nil) diff --git a/plugins/host_config_test.go b/plugins/host_config_test.go index bae7043be..bd3368a67 100644 --- a/plugins/host_config_test.go +++ b/plugins/host_config_test.go @@ -1,46 +1,381 @@ +//go:build !windows + package plugins import ( "context" + "crypto/sha256" + "encoding/hex" + "encoding/json" + "errors" + "net/http" + "os" + "path/filepath" "github.com/navidrome/navidrome/conf" - hostconfig "github.com/navidrome/navidrome/plugins/host/config" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) -var _ = Describe("configServiceImpl", func() { - var ( - svc *configServiceImpl - pluginName string - ) +// testConfigInput is the input for nd_test_config callback. +type testConfigInput struct { + Operation string `json:"operation"` + Key string `json:"key,omitempty"` + Prefix string `json:"prefix,omitempty"` +} + +// testConfigOutput is the output from nd_test_config callback. +type testConfigOutput struct { + StringVal string `json:"string_val,omitempty"` + IntVal int64 `json:"int_val,omitempty"` + Keys []string `json:"keys,omitempty"` + Exists bool `json:"exists,omitempty"` + Error *string `json:"error,omitempty"` +} + +// setupTestConfigPlugin sets up a test environment with the test-config plugin loaded. +// Returns a cleanup function and a helper to call the plugin's nd_test_config function. +func setupTestConfigPlugin(configJSON string) (*Manager, func(context.Context, testConfigInput) (*testConfigOutput, error)) { + tmpDir, err := os.MkdirTemp("", "config-test-*") + Expect(err).ToNot(HaveOccurred()) + + // Copy the test-config plugin + srcPath := filepath.Join(testdataDir, "test-config"+PackageExtension) + destPath := filepath.Join(tmpDir, "test-config"+PackageExtension) + data, err := os.ReadFile(srcPath) + Expect(err).ToNot(HaveOccurred()) + err = os.WriteFile(destPath, data, 0600) + Expect(err).ToNot(HaveOccurred()) + + // Compute SHA256 for the plugin + hash := sha256.Sum256(data) + hashHex := hex.EncodeToString(hash[:]) + + // Setup config + DeferCleanup(configtest.SetupConfig()) + conf.Server.Plugins.Enabled = true + conf.Server.Plugins.Folder = tmpDir + conf.Server.Plugins.AutoReload = false + + // Setup mock DataStore + mockPluginRepo := tests.CreateMockPluginRepo() + mockPluginRepo.Permitted = true + mockPluginRepo.SetData(model.Plugins{{ + ID: "test-config", + Path: destPath, + SHA256: hashHex, + Enabled: true, + AllUsers: true, + Config: configJSON, + }}) + dataStore := &tests.MockDataStore{MockedPlugin: mockPluginRepo} + + // Create and start manager + manager := &Manager{ + plugins: make(map[string]*plugin), + ds: dataStore, + subsonicRouter: http.NotFoundHandler(), + } + err = manager.Start(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + + DeferCleanup(func() { + _ = manager.Stop() + _ = os.RemoveAll(tmpDir) + }) + + // Helper to call test plugin's exported function + callTestConfig := func(ctx context.Context, input testConfigInput) (*testConfigOutput, error) { + manager.mu.RLock() + p := manager.plugins["test-config"] + manager.mu.RUnlock() + + instance, err := p.instance(ctx) + if err != nil { + return nil, err + } + defer instance.Close(ctx) + + inputBytes, _ := json.Marshal(input) + _, outputBytes, err := instance.Call("nd_test_config", inputBytes) + if err != nil { + return nil, err + } + + var output testConfigOutput + if err := json.Unmarshal(outputBytes, &output); err != nil { + return nil, err + } + if output.Error != nil { + return nil, errors.New(*output.Error) + } + return &output, nil + } + + return manager, callTestConfig +} + +var _ = Describe("ConfigService", func() { + var service *configServiceImpl + var ctx context.Context BeforeEach(func() { - pluginName = "testplugin" - svc = &configServiceImpl{pluginID: pluginName} - conf.Server.PluginConfig = map[string]map[string]string{ - pluginName: {"foo": "bar", "baz": "qux"}, - } + ctx = context.Background() }) - It("returns config for known plugin", func() { - resp, err := svc.GetPluginConfig(context.Background(), &hostconfig.GetPluginConfigRequest{}) - Expect(err).To(BeNil()) - Expect(resp.Config).To(HaveKeyWithValue("foo", "bar")) - Expect(resp.Config).To(HaveKeyWithValue("baz", "qux")) + Describe("newConfigService", func() { + It("creates service with provided config", func() { + config := map[string]string{"key1": "value1", "key2": "value2"} + service = newConfigService("test_plugin", config) + Expect(service.pluginName).To(Equal("test_plugin")) + Expect(service.config).To(Equal(config)) + }) + + It("creates service with empty config when nil", func() { + service = newConfigService("test_plugin", nil) + Expect(service.config).ToNot(BeNil()) + Expect(service.config).To(BeEmpty()) + }) }) - It("returns error for unknown plugin", func() { - svc.pluginID = "unknown" - resp, err := svc.GetPluginConfig(context.Background(), &hostconfig.GetPluginConfigRequest{}) - Expect(err).To(BeNil()) - Expect(resp.Config).To(BeEmpty()) + Describe("Get", func() { + BeforeEach(func() { + service = newConfigService("test_plugin", map[string]string{ + "api_key": "secret123", + "debug_mode": "true", + "max_items": "100", + }) + }) + + It("returns value for existing key", func() { + value, exists := service.Get(ctx, "api_key") + Expect(exists).To(BeTrue()) + Expect(value).To(Equal("secret123")) + }) + + It("returns not exists for missing key", func() { + value, exists := service.Get(ctx, "missing_key") + Expect(exists).To(BeFalse()) + Expect(value).To(Equal("")) + }) }) - It("returns empty config if plugin config is empty", func() { - conf.Server.PluginConfig[pluginName] = map[string]string{} - resp, err := svc.GetPluginConfig(context.Background(), &hostconfig.GetPluginConfigRequest{}) - Expect(err).To(BeNil()) - Expect(resp.Config).To(BeEmpty()) + Describe("GetInt", func() { + BeforeEach(func() { + service = newConfigService("test_plugin", map[string]string{ + "max_items": "100", + "timeout": "30", + "negative": "-50", + "not_a_number": "abc", + "float": "3.14", + }) + }) + + It("returns integer for valid numeric value", func() { + value, exists := service.GetInt(ctx, "max_items") + Expect(exists).To(BeTrue()) + Expect(value).To(Equal(int64(100))) + }) + + It("returns negative integer", func() { + value, exists := service.GetInt(ctx, "negative") + Expect(exists).To(BeTrue()) + Expect(value).To(Equal(int64(-50))) + }) + + It("returns not exists for non-numeric value", func() { + value, exists := service.GetInt(ctx, "not_a_number") + Expect(exists).To(BeFalse()) + Expect(value).To(Equal(int64(0))) + }) + + It("returns not exists for float value", func() { + value, exists := service.GetInt(ctx, "float") + Expect(exists).To(BeFalse()) + Expect(value).To(Equal(int64(0))) + }) + + It("returns not exists for missing key", func() { + value, exists := service.GetInt(ctx, "missing_key") + Expect(exists).To(BeFalse()) + Expect(value).To(Equal(int64(0))) + }) + }) + + Describe("Keys", func() { + BeforeEach(func() { + service = newConfigService("test_plugin", map[string]string{ + "zebra": "z", + "apple": "a", + "banana": "b", + "user_alice": "token1", + "user_bob": "token2", + "user_charlie": "token3", + }) + }) + + It("returns all keys in sorted order when prefix is empty", func() { + keys := service.Keys(ctx, "") + Expect(keys).To(Equal([]string{"apple", "banana", "user_alice", "user_bob", "user_charlie", "zebra"})) + }) + + It("returns only keys matching prefix", func() { + keys := service.Keys(ctx, "user_") + Expect(keys).To(Equal([]string{"user_alice", "user_bob", "user_charlie"})) + }) + + It("returns empty slice when no keys match prefix", func() { + keys := service.Keys(ctx, "nonexistent_") + Expect(keys).To(BeEmpty()) + }) + + It("returns empty slice for empty config", func() { + service = newConfigService("test_plugin", nil) + keys := service.Keys(ctx, "") + Expect(keys).To(BeEmpty()) + }) + }) +}) + +var _ = Describe("ConfigService Integration", Ordered, func() { + var ( + manager *Manager + callTestConfig func(context.Context, testConfigInput) (*testConfigOutput, error) + ) + + BeforeAll(func() { + manager, callTestConfig = setupTestConfigPlugin(`{"api_key":"test_secret","max_retries":"5","timeout":"30"}`) + }) + + Describe("Plugin Loading", func() { + It("should load plugin without config permission", func() { + manager.mu.RLock() + p, ok := manager.plugins["test-config"] + manager.mu.RUnlock() + Expect(ok).To(BeTrue()) + Expect(p.manifest.Name).To(Equal("Test Config Plugin")) + }) + }) + + Describe("Config Operations via Plugin", func() { + It("should get string value", func() { + output, err := callTestConfig(GinkgoT().Context(), testConfigInput{ + Operation: "get", + Key: "api_key", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.StringVal).To(Equal("test_secret")) + Expect(output.Exists).To(BeTrue()) + }) + + It("should return not exists for missing key", func() { + output, err := callTestConfig(GinkgoT().Context(), testConfigInput{ + Operation: "get", + Key: "nonexistent", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeFalse()) + }) + + It("should get integer value", func() { + output, err := callTestConfig(GinkgoT().Context(), testConfigInput{ + Operation: "get_int", + Key: "max_retries", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.IntVal).To(Equal(int64(5))) + Expect(output.Exists).To(BeTrue()) + }) + + It("should return not exists for non-integer value", func() { + output, err := callTestConfig(GinkgoT().Context(), testConfigInput{ + Operation: "get_int", + Key: "api_key", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeFalse()) + }) + + It("should list all config keys with empty prefix", func() { + output, err := callTestConfig(GinkgoT().Context(), testConfigInput{ + Operation: "list", + Prefix: "", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Keys).To(ConsistOf("api_key", "max_retries", "timeout")) + }) + + It("should list config keys with prefix filter", func() { + output, err := callTestConfig(GinkgoT().Context(), testConfigInput{ + Operation: "list", + Prefix: "max", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Keys).To(ConsistOf("max_retries")) + }) + }) +}) + +var _ = Describe("Complex Config Values Integration", Ordered, func() { + var callTestConfig func(context.Context, testConfigInput) (*testConfigOutput, error) + + BeforeAll(func() { + // Config with arrays and objects - these should be properly serialized as JSON strings + _, callTestConfig = setupTestConfigPlugin(`{"api_key":"secret123","users":[{"username":"admin","token":"tok1"},{"username":"user2","token":"tok2"}],"settings":{"enabled":true,"count":5}}`) + }) + + Describe("Config Serialization", func() { + It("should make simple string config values accessible to plugin", func() { + output, err := callTestConfig(GinkgoT().Context(), testConfigInput{ + Operation: "get", + Key: "api_key", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeTrue()) + Expect(output.StringVal).To(Equal("secret123")) + }) + + It("should serialize array config values as JSON strings", func() { + output, err := callTestConfig(GinkgoT().Context(), testConfigInput{ + Operation: "get", + Key: "users", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeTrue()) + // Array values are serialized as JSON strings - parse to verify structure + var users []map[string]string + Expect(json.Unmarshal([]byte(output.StringVal), &users)).To(Succeed()) + Expect(users).To(HaveLen(2)) + Expect(users[0]).To(HaveKeyWithValue("username", "admin")) + Expect(users[0]).To(HaveKeyWithValue("token", "tok1")) + Expect(users[1]).To(HaveKeyWithValue("username", "user2")) + Expect(users[1]).To(HaveKeyWithValue("token", "tok2")) + }) + + It("should serialize object config values as JSON strings", func() { + output, err := callTestConfig(GinkgoT().Context(), testConfigInput{ + Operation: "get", + Key: "settings", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeTrue()) + // Object values are serialized as JSON strings - parse to verify structure + var settings map[string]any + Expect(json.Unmarshal([]byte(output.StringVal), &settings)).To(Succeed()) + Expect(settings).To(HaveKeyWithValue("enabled", true)) + Expect(settings).To(HaveKeyWithValue("count", float64(5))) + }) + + It("should list all config keys including complex values", func() { + output, err := callTestConfig(GinkgoT().Context(), testConfigInput{ + Operation: "list", + Prefix: "", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Keys).To(ConsistOf("api_key", "users", "settings")) + }) }) }) diff --git a/plugins/host_http.go b/plugins/host_http.go deleted file mode 100644 index 24fc77b18..000000000 --- a/plugins/host_http.go +++ /dev/null @@ -1,114 +0,0 @@ -package plugins - -import ( - "bytes" - "cmp" - "context" - "io" - "net/http" - "time" - - "github.com/navidrome/navidrome/log" - hosthttp "github.com/navidrome/navidrome/plugins/host/http" -) - -type httpServiceImpl struct { - pluginID string - permissions *httpPermissions -} - -const defaultTimeout = 10 * time.Second - -func (s *httpServiceImpl) Get(ctx context.Context, req *hosthttp.HttpRequest) (*hosthttp.HttpResponse, error) { - return s.doHttp(ctx, http.MethodGet, req) -} - -func (s *httpServiceImpl) Post(ctx context.Context, req *hosthttp.HttpRequest) (*hosthttp.HttpResponse, error) { - return s.doHttp(ctx, http.MethodPost, req) -} - -func (s *httpServiceImpl) Put(ctx context.Context, req *hosthttp.HttpRequest) (*hosthttp.HttpResponse, error) { - return s.doHttp(ctx, http.MethodPut, req) -} - -func (s *httpServiceImpl) Delete(ctx context.Context, req *hosthttp.HttpRequest) (*hosthttp.HttpResponse, error) { - return s.doHttp(ctx, http.MethodDelete, req) -} - -func (s *httpServiceImpl) Patch(ctx context.Context, req *hosthttp.HttpRequest) (*hosthttp.HttpResponse, error) { - return s.doHttp(ctx, http.MethodPatch, req) -} - -func (s *httpServiceImpl) Head(ctx context.Context, req *hosthttp.HttpRequest) (*hosthttp.HttpResponse, error) { - return s.doHttp(ctx, http.MethodHead, req) -} - -func (s *httpServiceImpl) Options(ctx context.Context, req *hosthttp.HttpRequest) (*hosthttp.HttpResponse, error) { - return s.doHttp(ctx, http.MethodOptions, req) -} - -func (s *httpServiceImpl) doHttp(ctx context.Context, method string, req *hosthttp.HttpRequest) (*hosthttp.HttpResponse, error) { - // Check permissions if they exist - if s.permissions != nil { - if err := s.permissions.IsRequestAllowed(req.Url, method); err != nil { - log.Warn(ctx, "HTTP request blocked by permissions", "plugin", s.pluginID, "url", req.Url, "method", method, err) - return &hosthttp.HttpResponse{Error: "Request blocked by plugin permissions: " + err.Error()}, nil - } - } - client := &http.Client{ - Timeout: cmp.Or(time.Duration(req.TimeoutMs)*time.Millisecond, defaultTimeout), - } - - // Configure redirect policy based on permissions - if s.permissions != nil { - client.CheckRedirect = func(req *http.Request, via []*http.Request) error { - // Enforce maximum redirect limit - if len(via) >= httpMaxRedirects { - log.Warn(ctx, "HTTP redirect limit exceeded", "plugin", s.pluginID, "url", req.URL.String(), "redirectCount", len(via)) - return http.ErrUseLastResponse - } - - // Check if redirect destination is allowed - if err := s.permissions.IsRequestAllowed(req.URL.String(), req.Method); err != nil { - log.Warn(ctx, "HTTP redirect blocked by permissions", "plugin", s.pluginID, "url", req.URL.String(), "method", req.Method, err) - return http.ErrUseLastResponse - } - - return nil // Allow redirect - } - } - var body io.Reader - if method == http.MethodPost || method == http.MethodPut || method == http.MethodPatch { - body = bytes.NewReader(req.Body) - } - httpReq, err := http.NewRequestWithContext(ctx, method, req.Url, body) - if err != nil { - return nil, err - } - for k, v := range req.Headers { - httpReq.Header.Set(k, v) - } - resp, err := client.Do(httpReq) - if err != nil { - log.Trace(ctx, "HttpService request error", "method", method, "url", req.Url, "headers", req.Headers, err) - return &hosthttp.HttpResponse{Error: err.Error()}, nil - } - log.Trace(ctx, "HttpService request", "method", method, "url", req.Url, "headers", req.Headers, "resp.status", resp.StatusCode) - defer resp.Body.Close() - respBody, err := io.ReadAll(resp.Body) - if err != nil { - log.Trace(ctx, "HttpService request error", "method", method, "url", req.Url, "headers", req.Headers, "resp.status", resp.StatusCode, err) - return &hosthttp.HttpResponse{Error: err.Error()}, nil - } - headers := map[string]string{} - for k, v := range resp.Header { - if len(v) > 0 { - headers[k] = v[0] - } - } - return &hosthttp.HttpResponse{ - Status: int32(resp.StatusCode), - Body: respBody, - Headers: headers, - }, nil -} diff --git a/plugins/host_http_permissions.go b/plugins/host_http_permissions.go deleted file mode 100644 index 158bdb105..000000000 --- a/plugins/host_http_permissions.go +++ /dev/null @@ -1,90 +0,0 @@ -package plugins - -import ( - "fmt" - "strings" - - "github.com/navidrome/navidrome/plugins/schema" -) - -// Maximum number of HTTP redirects allowed for plugin requests -const httpMaxRedirects = 5 - -// HTTPPermissions represents granular HTTP access permissions for plugins -type httpPermissions struct { - *networkPermissionsBase - AllowedUrls map[string][]string `json:"allowedUrls"` - matcher *urlMatcher -} - -// parseHTTPPermissions extracts HTTP permissions from the schema -func parseHTTPPermissions(permData *schema.PluginManifestPermissionsHttp) (*httpPermissions, error) { - base := &networkPermissionsBase{ - AllowLocalNetwork: permData.AllowLocalNetwork, - } - - if len(permData.AllowedUrls) == 0 { - return nil, fmt.Errorf("allowedUrls must contain at least one URL pattern") - } - - allowedUrls := make(map[string][]string) - for urlPattern, methodEnums := range permData.AllowedUrls { - methods := make([]string, len(methodEnums)) - for i, methodEnum := range methodEnums { - methods[i] = string(methodEnum) - } - allowedUrls[urlPattern] = methods - } - - return &httpPermissions{ - networkPermissionsBase: base, - AllowedUrls: allowedUrls, - matcher: newURLMatcher(), - }, nil -} - -// IsRequestAllowed checks if a specific network request is allowed by the permissions -func (p *httpPermissions) IsRequestAllowed(requestURL, operation string) error { - if _, err := checkURLPolicy(requestURL, p.AllowLocalNetwork); err != nil { - return err - } - - // allowedUrls is now required - no fallback to allow all URLs - if p.AllowedUrls == nil || len(p.AllowedUrls) == 0 { - return fmt.Errorf("no allowed URLs configured for plugin") - } - - matcher := newURLMatcher() - - // Check URL patterns and operations - // First try exact matches, then wildcard matches - operation = strings.ToUpper(operation) - - // Phase 1: Check for exact matches first - for urlPattern, allowedOperations := range p.AllowedUrls { - if !strings.Contains(urlPattern, "*") && matcher.MatchesURLPattern(requestURL, urlPattern) { - // Check if operation is allowed - for _, allowedOperation := range allowedOperations { - if allowedOperation == "*" || allowedOperation == operation { - return nil - } - } - return fmt.Errorf("operation %s not allowed for URL pattern %s", operation, urlPattern) - } - } - - // Phase 2: Check wildcard patterns - for urlPattern, allowedOperations := range p.AllowedUrls { - if strings.Contains(urlPattern, "*") && matcher.MatchesURLPattern(requestURL, urlPattern) { - // Check if operation is allowed - for _, allowedOperation := range allowedOperations { - if allowedOperation == "*" || allowedOperation == operation { - return nil - } - } - return fmt.Errorf("operation %s not allowed for URL pattern %s", operation, urlPattern) - } - } - - return fmt.Errorf("URL %s does not match any allowed URL patterns", requestURL) -} diff --git a/plugins/host_http_permissions_test.go b/plugins/host_http_permissions_test.go deleted file mode 100644 index 3385ffc03..000000000 --- a/plugins/host_http_permissions_test.go +++ /dev/null @@ -1,187 +0,0 @@ -package plugins - -import ( - "github.com/navidrome/navidrome/plugins/schema" - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" -) - -var _ = Describe("HTTP Permissions", func() { - Describe("parseHTTPPermissions", func() { - It("should parse valid HTTP permissions", func() { - permData := &schema.PluginManifestPermissionsHttp{ - Reason: "Need to fetch album artwork", - AllowLocalNetwork: false, - AllowedUrls: map[string][]schema.PluginManifestPermissionsHttpAllowedUrlsValueElem{ - "https://api.example.com/*": { - schema.PluginManifestPermissionsHttpAllowedUrlsValueElemGET, - schema.PluginManifestPermissionsHttpAllowedUrlsValueElemPOST, - }, - "https://cdn.example.com/*": { - schema.PluginManifestPermissionsHttpAllowedUrlsValueElemGET, - }, - }, - } - - perms, err := parseHTTPPermissions(permData) - Expect(err).To(BeNil()) - Expect(perms).ToNot(BeNil()) - Expect(perms.AllowLocalNetwork).To(BeFalse()) - Expect(perms.AllowedUrls).To(HaveLen(2)) - Expect(perms.AllowedUrls["https://api.example.com/*"]).To(Equal([]string{"GET", "POST"})) - Expect(perms.AllowedUrls["https://cdn.example.com/*"]).To(Equal([]string{"GET"})) - }) - - It("should fail if allowedUrls is empty", func() { - permData := &schema.PluginManifestPermissionsHttp{ - Reason: "Need to fetch album artwork", - AllowLocalNetwork: false, - AllowedUrls: map[string][]schema.PluginManifestPermissionsHttpAllowedUrlsValueElem{}, - } - - _, err := parseHTTPPermissions(permData) - Expect(err).To(HaveOccurred()) - Expect(err.Error()).To(ContainSubstring("allowedUrls must contain at least one URL pattern")) - }) - - It("should handle method enum types correctly", func() { - permData := &schema.PluginManifestPermissionsHttp{ - Reason: "Need to fetch album artwork", - AllowLocalNetwork: false, - AllowedUrls: map[string][]schema.PluginManifestPermissionsHttpAllowedUrlsValueElem{ - "https://api.example.com/*": { - schema.PluginManifestPermissionsHttpAllowedUrlsValueElemWildcard, // "*" - }, - }, - } - - perms, err := parseHTTPPermissions(permData) - Expect(err).To(BeNil()) - Expect(perms.AllowedUrls["https://api.example.com/*"]).To(Equal([]string{"*"})) - }) - }) - - Describe("IsRequestAllowed", func() { - var perms *httpPermissions - - Context("HTTP method-specific validation", func() { - BeforeEach(func() { - perms = &httpPermissions{ - networkPermissionsBase: &networkPermissionsBase{ - Reason: "Test permissions", - AllowLocalNetwork: false, - }, - AllowedUrls: map[string][]string{ - "https://api.example.com": {"GET", "POST"}, - "https://upload.example.com": {"PUT", "PATCH"}, - "https://admin.example.com": {"DELETE"}, - "https://webhook.example.com": {"*"}, - }, - matcher: newURLMatcher(), - } - }) - - DescribeTable("method-specific access control", - func(url, method string, shouldSucceed bool) { - err := perms.IsRequestAllowed(url, method) - if shouldSucceed { - Expect(err).ToNot(HaveOccurred()) - } else { - Expect(err).To(HaveOccurred()) - } - }, - // Allowed methods - Entry("GET to api", "https://api.example.com", "GET", true), - Entry("POST to api", "https://api.example.com", "POST", true), - Entry("PUT to upload", "https://upload.example.com", "PUT", true), - Entry("PATCH to upload", "https://upload.example.com", "PATCH", true), - Entry("DELETE to admin", "https://admin.example.com", "DELETE", true), - Entry("any method to webhook", "https://webhook.example.com", "OPTIONS", true), - Entry("any method to webhook", "https://webhook.example.com", "HEAD", true), - - // Disallowed methods - Entry("DELETE to api", "https://api.example.com", "DELETE", false), - Entry("GET to upload", "https://upload.example.com", "GET", false), - Entry("POST to admin", "https://admin.example.com", "POST", false), - ) - }) - - Context("case insensitive method handling", func() { - BeforeEach(func() { - perms = &httpPermissions{ - networkPermissionsBase: &networkPermissionsBase{ - Reason: "Test permissions", - AllowLocalNetwork: false, - }, - AllowedUrls: map[string][]string{ - "https://api.example.com": {"GET", "POST"}, // Both uppercase for consistency - }, - matcher: newURLMatcher(), - } - }) - - DescribeTable("case insensitive method matching", - func(method string, shouldSucceed bool) { - err := perms.IsRequestAllowed("https://api.example.com", method) - if shouldSucceed { - Expect(err).ToNot(HaveOccurred()) - } else { - Expect(err).To(HaveOccurred()) - } - }, - Entry("uppercase GET", "GET", true), - Entry("lowercase get", "get", true), - Entry("mixed case Get", "Get", true), - Entry("uppercase POST", "POST", true), - Entry("lowercase post", "post", true), - Entry("mixed case Post", "Post", true), - Entry("disallowed method", "DELETE", false), - ) - }) - - Context("with complex URL patterns and HTTP methods", func() { - BeforeEach(func() { - perms = &httpPermissions{ - networkPermissionsBase: &networkPermissionsBase{ - Reason: "Test permissions", - AllowLocalNetwork: false, - }, - AllowedUrls: map[string][]string{ - "https://api.example.com/v1/*": {"GET"}, - "https://api.example.com/v1/users": {"POST", "PUT"}, - "https://*.example.com/public/*": {"GET", "HEAD"}, - "https://admin.*.example.com": {"*"}, - }, - matcher: newURLMatcher(), - } - }) - - DescribeTable("complex pattern and method combinations", - func(url, method string, shouldSucceed bool) { - err := perms.IsRequestAllowed(url, method) - if shouldSucceed { - Expect(err).ToNot(HaveOccurred()) - } else { - Expect(err).To(HaveOccurred()) - } - }, - // Path wildcards with specific methods - Entry("GET to v1 path", "https://api.example.com/v1/posts", "GET", true), - Entry("POST to v1 path", "https://api.example.com/v1/posts", "POST", false), - Entry("POST to specific users endpoint", "https://api.example.com/v1/users", "POST", true), - Entry("PUT to specific users endpoint", "https://api.example.com/v1/users", "PUT", true), - Entry("DELETE to specific users endpoint", "https://api.example.com/v1/users", "DELETE", false), - - // Subdomain wildcards with specific methods - Entry("GET to public path on subdomain", "https://cdn.example.com/public/assets", "GET", true), - Entry("HEAD to public path on subdomain", "https://static.example.com/public/files", "HEAD", true), - Entry("POST to public path on subdomain", "https://api.example.com/public/upload", "POST", false), - - // Admin subdomain with all methods - Entry("GET to admin subdomain", "https://admin.prod.example.com", "GET", true), - Entry("POST to admin subdomain", "https://admin.staging.example.com", "POST", true), - Entry("DELETE to admin subdomain", "https://admin.dev.example.com", "DELETE", true), - ) - }) - }) -}) diff --git a/plugins/host_http_test.go b/plugins/host_http_test.go deleted file mode 100644 index b6f823a07..000000000 --- a/plugins/host_http_test.go +++ /dev/null @@ -1,190 +0,0 @@ -package plugins - -import ( - "context" - "net/http" - "net/http/httptest" - "time" - - hosthttp "github.com/navidrome/navidrome/plugins/host/http" - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" -) - -var _ = Describe("httpServiceImpl", func() { - var ( - svc *httpServiceImpl - ts *httptest.Server - ) - - BeforeEach(func() { - svc = &httpServiceImpl{} - }) - - AfterEach(func() { - if ts != nil { - ts.Close() - } - }) - - It("should handle GET requests", func() { - ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - w.Header().Set("X-Test", "ok") - w.WriteHeader(201) - _, _ = w.Write([]byte("hello")) - })) - resp, err := svc.Get(context.Background(), &hosthttp.HttpRequest{ - Url: ts.URL, - Headers: map[string]string{"A": "B"}, - TimeoutMs: 1000, - }) - Expect(err).To(BeNil()) - Expect(resp.Error).To(BeEmpty()) - Expect(resp.Status).To(Equal(int32(201))) - Expect(string(resp.Body)).To(Equal("hello")) - Expect(resp.Headers["X-Test"]).To(Equal("ok")) - }) - - It("should handle POST requests with body", func() { - ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - b := make([]byte, r.ContentLength) - _, _ = r.Body.Read(b) - _, _ = w.Write([]byte("got:" + string(b))) - })) - resp, err := svc.Post(context.Background(), &hosthttp.HttpRequest{ - Url: ts.URL, - Body: []byte("abc"), - TimeoutMs: 1000, - }) - Expect(err).To(BeNil()) - Expect(resp.Error).To(BeEmpty()) - Expect(string(resp.Body)).To(Equal("got:abc")) - }) - - It("should handle PUT requests with body", func() { - ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - b := make([]byte, r.ContentLength) - _, _ = r.Body.Read(b) - _, _ = w.Write([]byte("put:" + string(b))) - })) - resp, err := svc.Put(context.Background(), &hosthttp.HttpRequest{ - Url: ts.URL, - Body: []byte("xyz"), - TimeoutMs: 1000, - }) - Expect(err).To(BeNil()) - Expect(resp.Error).To(BeEmpty()) - Expect(string(resp.Body)).To(Equal("put:xyz")) - }) - - It("should handle DELETE requests", func() { - ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - w.WriteHeader(204) - })) - resp, err := svc.Delete(context.Background(), &hosthttp.HttpRequest{ - Url: ts.URL, - TimeoutMs: 1000, - }) - Expect(err).To(BeNil()) - Expect(resp.Error).To(BeEmpty()) - Expect(resp.Status).To(Equal(int32(204))) - }) - - It("should handle PATCH requests with body", func() { - ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - b := make([]byte, r.ContentLength) - _, _ = r.Body.Read(b) - _, _ = w.Write([]byte("patch:" + string(b))) - })) - resp, err := svc.Patch(context.Background(), &hosthttp.HttpRequest{ - Url: ts.URL, - Body: []byte("test-patch"), - TimeoutMs: 1000, - }) - Expect(err).To(BeNil()) - Expect(resp.Error).To(BeEmpty()) - Expect(string(resp.Body)).To(Equal("patch:test-patch")) - }) - - It("should handle HEAD requests", func() { - ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - w.Header().Set("Content-Type", "application/json") - w.Header().Set("Content-Length", "42") - w.WriteHeader(200) - // HEAD responses shouldn't have a body, but the headers should be present - })) - resp, err := svc.Head(context.Background(), &hosthttp.HttpRequest{ - Url: ts.URL, - TimeoutMs: 1000, - }) - Expect(err).To(BeNil()) - Expect(resp.Error).To(BeEmpty()) - Expect(resp.Status).To(Equal(int32(200))) - Expect(resp.Headers["Content-Type"]).To(Equal("application/json")) - Expect(resp.Headers["Content-Length"]).To(Equal("42")) - Expect(resp.Body).To(BeEmpty()) // HEAD responses have no body - }) - - It("should handle OPTIONS requests", func() { - ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - w.Header().Set("Allow", "GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS") - w.Header().Set("Access-Control-Allow-Methods", "GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS") - w.WriteHeader(200) - })) - resp, err := svc.Options(context.Background(), &hosthttp.HttpRequest{ - Url: ts.URL, - TimeoutMs: 1000, - }) - Expect(err).To(BeNil()) - Expect(resp.Error).To(BeEmpty()) - Expect(resp.Status).To(Equal(int32(200))) - Expect(resp.Headers["Allow"]).To(Equal("GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS")) - Expect(resp.Headers["Access-Control-Allow-Methods"]).To(Equal("GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS")) - }) - - It("should handle timeouts and errors", func() { - ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - time.Sleep(50 * time.Millisecond) - })) - resp, err := svc.Get(context.Background(), &hosthttp.HttpRequest{ - Url: ts.URL, - TimeoutMs: 1, - }) - Expect(err).To(BeNil()) - Expect(resp).NotTo(BeNil()) - Expect(resp.Error).To(ContainSubstring("deadline exceeded")) - }) - - It("should return error on context timeout", func() { - ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - time.Sleep(50 * time.Millisecond) - })) - ctx, cancel := context.WithTimeout(context.Background(), 1*time.Millisecond) - defer cancel() - resp, err := svc.Get(ctx, &hosthttp.HttpRequest{ - Url: ts.URL, - TimeoutMs: 1000, - }) - Expect(err).To(BeNil()) - Expect(resp).NotTo(BeNil()) - Expect(resp.Error).To(ContainSubstring("context deadline exceeded")) - }) - - It("should return error on context cancellation", func() { - ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - time.Sleep(50 * time.Millisecond) - })) - ctx, cancel := context.WithCancel(context.Background()) - go func() { - time.Sleep(1 * time.Millisecond) - cancel() - }() - resp, err := svc.Get(ctx, &hosthttp.HttpRequest{ - Url: ts.URL, - TimeoutMs: 1000, - }) - Expect(err).To(BeNil()) - Expect(resp).NotTo(BeNil()) - Expect(resp.Error).To(ContainSubstring("context canceled")) - }) -}) diff --git a/plugins/host_httpclient.go b/plugins/host_httpclient.go new file mode 100644 index 000000000..f1d64deb7 --- /dev/null +++ b/plugins/host_httpclient.go @@ -0,0 +1,204 @@ +package plugins + +import ( + "bytes" + "cmp" + "context" + "fmt" + "io" + "net" + "net/http" + "net/url" + "strings" + "time" + + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/plugins/host" +) + +const ( + httpClientDefaultTimeout = 10 * time.Second + httpClientMaxRedirects = 5 + httpClientMaxResponseBodyLen = 10 * 1024 * 1024 // 10 MB +) + +// contextKey is used for per-request redirect control via context. +type contextKey struct{} + +// noFollowRedirectsKey signals the CheckRedirect callback to stop following redirects. +var noFollowRedirectsKey = contextKey{} + +// httpServiceImpl implements host.HTTPService. +type httpServiceImpl struct { + pluginName string + requiredHosts []string + client *http.Client +} + +// newHTTPService creates a new HTTPService for a plugin. +func newHTTPService(pluginName string, permission *HTTPPermission) *httpServiceImpl { + var requiredHosts []string + if permission != nil { + requiredHosts = permission.RequiredHosts + } + svc := &httpServiceImpl{ + pluginName: pluginName, + requiredHosts: requiredHosts, + } + svc.client = &http.Client{ + Transport: http.DefaultTransport, + // Timeout is set per-request via context deadline, not here. + // CheckRedirect validates hosts and enforces redirect limits. + CheckRedirect: func(req *http.Request, via []*http.Request) error { + if req.Context().Value(noFollowRedirectsKey) != nil { + return http.ErrUseLastResponse + } + if len(via) >= httpClientMaxRedirects { + log.Warn(req.Context(), "HTTP redirect limit exceeded", "plugin", svc.pluginName, "url", req.URL.String(), "redirectCount", len(via)) + return http.ErrUseLastResponse + } + if err := svc.validateHost(req.Context(), req.URL.Host); err != nil { + log.Warn(req.Context(), "HTTP redirect blocked", "plugin", svc.pluginName, "url", req.URL.String(), "err", err) + return err + } + return nil + }, + } + return svc +} + +func (s *httpServiceImpl) Send(ctx context.Context, request host.HTTPRequest) (*host.HTTPResponse, error) { + // Parse and validate URL + parsedURL, err := url.Parse(request.URL) + if err != nil { + return nil, fmt.Errorf("invalid URL: %w", err) + } + + // Validate URL scheme + if parsedURL.Scheme != "http" && parsedURL.Scheme != "https" { + return nil, fmt.Errorf("invalid URL scheme %q: must be http or https", parsedURL.Scheme) + } + + // Validate host against allowed hosts and private IP restrictions + if err := s.validateHost(ctx, parsedURL.Host); err != nil { + return nil, err + } + + // Apply per-request timeout via context deadline + timeout := cmp.Or(time.Duration(request.TimeoutMs)*time.Millisecond, httpClientDefaultTimeout) + ctx, cancel := context.WithTimeout(ctx, timeout) + defer cancel() + + // Signal CheckRedirect to not follow redirects for this request + if request.NoFollowRedirects { + ctx = context.WithValue(ctx, noFollowRedirectsKey, true) + } + + // Build request body + method := strings.ToUpper(request.Method) + var body io.Reader + if len(request.Body) > 0 { + body = bytes.NewReader(request.Body) + } + + // Create HTTP request + httpReq, err := http.NewRequestWithContext(ctx, method, request.URL, body) + if err != nil { + return nil, fmt.Errorf("creating request: %w", err) + } + for k, v := range request.Headers { + httpReq.Header.Set(k, v) + } + + // Execute request + resp, err := s.client.Do(httpReq) //nolint:gosec // URL is validated against requiredHosts + if err != nil { + return nil, err + } + defer resp.Body.Close() + + log.Trace(ctx, "HTTP request", "plugin", s.pluginName, "method", method, "url", request.URL, "status", resp.StatusCode) + + // Read response body (with size limit to prevent memory exhaustion) + respBody, err := io.ReadAll(io.LimitReader(resp.Body, httpClientMaxResponseBodyLen)) + if err != nil { + return nil, fmt.Errorf("reading response body: %w", err) + } + + // Flatten response headers (first value only) + headers := make(map[string]string, len(resp.Header)) + for k, v := range resp.Header { + if len(v) > 0 { + headers[k] = v[0] + } + } + + return &host.HTTPResponse{ + StatusCode: int32(resp.StatusCode), + Headers: headers, + Body: respBody, + }, nil +} + +// validateHost checks whether a request to the given host is permitted. +// When requiredHosts is set, it checks against the allowlist. +// When requiredHosts is empty, it blocks private/loopback IPs to prevent SSRF. +func (s *httpServiceImpl) validateHost(ctx context.Context, hostStr string) error { + hostname := extractHostname(hostStr) + + if len(s.requiredHosts) > 0 { + if !s.isHostAllowed(hostname) { + return fmt.Errorf("host %q is not allowed", hostStr) + } + return nil + } + + // No explicit allowlist: block private/loopback IPs + if isPrivateOrLoopback(hostname) { + log.Warn(ctx, "HTTP request to private/loopback address blocked", "plugin", s.pluginName, "host", hostStr) + return fmt.Errorf("host %q is not allowed: private/loopback addresses require explicit requiredHosts in manifest", hostStr) + } + return nil +} + +func (s *httpServiceImpl) isHostAllowed(hostname string) bool { + for _, pattern := range s.requiredHosts { + if matchHostPattern(pattern, hostname) { + return true + } + } + return false +} + +// extractHostname returns the hostname portion of a host string, stripping +// any port number and IPv6 brackets. It handles IPv6 addresses correctly +// (e.g. "[::1]:8080" → "::1", "[::1]" → "::1"). +func extractHostname(hostStr string) string { + if h, _, err := net.SplitHostPort(hostStr); err == nil { + return h + } + // Strip IPv6 brackets when no port is present (e.g. "[::1]" → "::1") + if strings.HasPrefix(hostStr, "[") && strings.HasSuffix(hostStr, "]") { + return hostStr[1 : len(hostStr)-1] + } + return hostStr +} + +// isPrivateOrLoopback returns true if the given hostname resolves to or is +// a private, loopback, or link-local IP address. This includes: +// IPv4: 127.0.0.0/8, 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16, 169.254.0.0/16 +// IPv6: ::1, fc00::/7, fe80::/10 +// It also blocks "localhost" by name. +func isPrivateOrLoopback(hostname string) bool { + if strings.EqualFold(hostname, "localhost") { + return true + } + ip := net.ParseIP(hostname) + if ip == nil { + return false + } + return ip.IsLoopback() || ip.IsPrivate() || ip.IsLinkLocalUnicast() || ip.IsLinkLocalMulticast() +} + +// Verify interface implementation +var _ host.HTTPService = (*httpServiceImpl)(nil) diff --git a/plugins/host_httpclient_test.go b/plugins/host_httpclient_test.go new file mode 100644 index 000000000..27e92d59d --- /dev/null +++ b/plugins/host_httpclient_test.go @@ -0,0 +1,585 @@ +//go:build !windows + +package plugins + +import ( + "context" + "io" + "net/http" + "net/http/httptest" + "strings" + "time" + + "github.com/navidrome/navidrome/plugins/host" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("httpServiceImpl", func() { + var ( + svc *httpServiceImpl + ts *httptest.Server + ) + + AfterEach(func() { + if ts != nil { + ts.Close() + } + }) + + Context("without host restrictions (default SSRF protection)", func() { + BeforeEach(func() { + svc = newHTTPService("test-plugin", nil) + }) + + It("should block requests to loopback IPs", func() { + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + w.WriteHeader(200) + })) + _, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: ts.URL, + TimeoutMs: 1000, + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("private/loopback")) + }) + + It("should block requests to localhost by name", func() { + _, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: "http://localhost:12345/test", + TimeoutMs: 1000, + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("private/loopback")) + }) + + It("should block requests to private IPs (10.x)", func() { + _, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: "http://10.0.0.1/test", + TimeoutMs: 1000, + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("private/loopback")) + }) + + It("should block requests to private IPs (192.168.x)", func() { + _, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: "http://192.168.1.1/test", + TimeoutMs: 1000, + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("private/loopback")) + }) + + It("should block requests to private IPs (172.16.x)", func() { + _, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: "http://172.16.0.1/test", + TimeoutMs: 1000, + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("private/loopback")) + }) + + It("should block requests to link-local IPs (169.254.x)", func() { + _, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: "http://169.254.169.254/latest/meta-data/", + TimeoutMs: 1000, + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("private/loopback")) + }) + + It("should block requests to IPv6 loopback with port", func() { + _, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: "http://[::1]:8080/test", + TimeoutMs: 1000, + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("private/loopback")) + }) + + It("should block requests to IPv6 loopback without port", func() { + _, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: "http://[::1]/test", + TimeoutMs: 1000, + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("private/loopback")) + }) + + It("should allow requests to public hostnames", func() { + // This will fail at the network level (connection refused or DNS), + // but it should NOT fail with a "private/loopback" error + _, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: "http://203.0.113.1:1/test", // TEST-NET-3, non-routable but not private + TimeoutMs: 100, + }) + // Should get a network error, not a permission error + if err != nil { + Expect(err.Error()).ToNot(ContainSubstring("private/loopback")) + } + }) + + It("should return error for invalid URL", func() { + _, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: "://bad-url", + }) + Expect(err).To(HaveOccurred()) + }) + + It("should reject non-http/https URL schemes", func() { + _, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: "ftp://example.com/file", + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("must be http or https")) + }) + }) + + Context("with explicit requiredHosts allowing loopback", func() { + BeforeEach(func() { + svc = newHTTPService("test-plugin", &HTTPPermission{ + RequiredHosts: []string{"127.0.0.1"}, + }) + }) + + It("should handle GET requests", func() { + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + Expect(r.Method).To(Equal("GET")) + w.Header().Set("X-Test", "ok") + w.WriteHeader(201) + _, _ = w.Write([]byte("hello")) + })) + resp, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: ts.URL, + Headers: map[string]string{"Accept": "text/plain"}, + TimeoutMs: 1000, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(resp.StatusCode).To(Equal(int32(201))) + Expect(string(resp.Body)).To(Equal("hello")) + Expect(resp.Headers["X-Test"]).To(Equal("ok")) + }) + + It("should handle POST requests with body", func() { + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + Expect(r.Method).To(Equal("POST")) + b, _ := io.ReadAll(r.Body) + _, _ = w.Write([]byte("got:" + string(b))) + })) + resp, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "POST", + URL: ts.URL, + Body: []byte("abc"), + TimeoutMs: 1000, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(string(resp.Body)).To(Equal("got:abc")) + }) + + It("should handle PUT requests with body", func() { + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + Expect(r.Method).To(Equal("PUT")) + b, _ := io.ReadAll(r.Body) + _, _ = w.Write([]byte("put:" + string(b))) + })) + resp, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "PUT", + URL: ts.URL, + Body: []byte("xyz"), + TimeoutMs: 1000, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(string(resp.Body)).To(Equal("put:xyz")) + }) + + It("should handle DELETE requests", func() { + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + Expect(r.Method).To(Equal("DELETE")) + w.WriteHeader(204) + })) + resp, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "DELETE", + URL: ts.URL, + TimeoutMs: 1000, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(resp.StatusCode).To(Equal(int32(204))) + }) + + It("should handle DELETE requests with body", func() { + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + Expect(r.Method).To(Equal("DELETE")) + b, _ := io.ReadAll(r.Body) + _, _ = w.Write([]byte("del:" + string(b))) + })) + resp, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "DELETE", + URL: ts.URL, + Body: []byte(`{"id":"123"}`), + TimeoutMs: 1000, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(string(resp.Body)).To(Equal(`del:{"id":"123"}`)) + }) + + It("should handle PATCH requests with body", func() { + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + Expect(r.Method).To(Equal("PATCH")) + b, _ := io.ReadAll(r.Body) + _, _ = w.Write([]byte("patch:" + string(b))) + })) + resp, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "PATCH", + URL: ts.URL, + Body: []byte("data"), + TimeoutMs: 1000, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(string(resp.Body)).To(Equal("patch:data")) + }) + + It("should handle HEAD requests", func() { + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + Expect(r.Method).To(Equal("HEAD")) + w.Header().Set("Content-Type", "application/json") + w.WriteHeader(200) + })) + resp, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "HEAD", + URL: ts.URL, + TimeoutMs: 1000, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(resp.StatusCode).To(Equal(int32(200))) + Expect(resp.Headers["Content-Type"]).To(Equal("application/json")) + Expect(resp.Body).To(BeEmpty()) + }) + + It("should use default timeout when TimeoutMs is 0", func() { + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + w.WriteHeader(200) + })) + resp, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: ts.URL, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(resp.StatusCode).To(Equal(int32(200))) + }) + + It("should return error on timeout", func() { + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + time.Sleep(50 * time.Millisecond) + })) + _, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: ts.URL, + TimeoutMs: 1, + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("deadline exceeded")) + }) + + It("should return error on context cancellation", func() { + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + time.Sleep(50 * time.Millisecond) + })) + ctx, cancel := context.WithCancel(context.Background()) + go func() { + time.Sleep(1 * time.Millisecond) + cancel() + }() + _, err := svc.Send(ctx, host.HTTPRequest{ + Method: "GET", + URL: ts.URL, + TimeoutMs: 5000, + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("context canceled")) + }) + + It("should not follow redirects when NoFollowRedirects is true", func() { + dest := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + _, _ = w.Write([]byte("final")) + })) + defer dest.Close() + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + http.Redirect(w, r, dest.URL, http.StatusFound) + })) + resp, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: ts.URL, + TimeoutMs: 1000, + NoFollowRedirects: true, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(resp.StatusCode).To(Equal(int32(302))) + Expect(resp.Headers["Location"]).To(Equal(dest.URL)) + Expect(string(resp.Body)).ToNot(Equal("final")) + }) + + It("should send request headers", func() { + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + _, _ = w.Write([]byte(r.Header.Get("X-Custom"))) + })) + resp, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: ts.URL, + Headers: map[string]string{"X-Custom": "myvalue"}, + TimeoutMs: 1000, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(string(resp.Body)).To(Equal("myvalue")) + }) + }) + + Context("with host restrictions", func() { + BeforeEach(func() { + svc = newHTTPService("test-plugin", &HTTPPermission{ + RequiredHosts: []string{"allowed.example.com", "*.allowed.org"}, + }) + }) + + It("should block requests to non-allowed hosts", func() { + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + w.WriteHeader(200) + })) + // httptest server is on 127.0.0.1 which is not in requiredHosts + _, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: ts.URL, + TimeoutMs: 1000, + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("not allowed")) + }) + + It("should follow redirects to allowed hosts", func() { + // Create a destination server + dest := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + _, _ = w.Write([]byte("final")) + })) + defer dest.Close() + // Create a redirect server + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + http.Redirect(w, r, dest.URL, http.StatusFound) + })) + // Allow both servers (both on 127.0.0.1) + svc.requiredHosts = []string{"127.0.0.1"} + resp, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: ts.URL, + TimeoutMs: 1000, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(resp.StatusCode).To(Equal(int32(200))) + Expect(string(resp.Body)).To(Equal("final")) + }) + + It("should block redirects to non-allowed hosts", func() { + // Server that redirects to a disallowed host + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + http.Redirect(w, r, "http://evil.example.com/steal", http.StatusFound) + })) + // Override requiredHosts to allow the test server + svc.requiredHosts = []string{"127.0.0.1"} + _, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: ts.URL, + TimeoutMs: 1000, + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("not allowed")) + }) + + It("should block redirects to private IPs when allowlist is set", func() { + // Server that redirects to a private IP + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + http.Redirect(w, r, "http://10.0.0.1/internal", http.StatusFound) + })) + // Allow the test server; redirect to 10.0.0.1 is blocked by allowlist + svc.requiredHosts = []string{"127.0.0.1"} + resp, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: ts.URL, + TimeoutMs: 1000, + }) + Expect(err).To(HaveOccurred()) + Expect(resp).To(BeNil()) + }) + + It("should allow wildcard host patterns", func() { + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + _, _ = w.Write([]byte("wildcard")) + })) + // *.allowed.org is in the requiredHosts from BeforeEach, but test server is 127.0.0.1 + // Override with a wildcard that matches the test server + svc.requiredHosts = []string{"*.0.0.1"} + resp, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: ts.URL, + TimeoutMs: 1000, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(string(resp.Body)).To(Equal("wildcard")) + }) + + It("should reject hosts not matching wildcard patterns", func() { + svc.requiredHosts = []string{"*.example.com"} + _, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: "http://evil.other.com/test", + TimeoutMs: 1000, + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("not allowed")) + }) + }) + + Context("response body size limit", func() { + BeforeEach(func() { + svc = newHTTPService("test-plugin", &HTTPPermission{ + RequiredHosts: []string{"127.0.0.1"}, + }) + }) + + It("should truncate response body at the size limit", func() { + // Serve a body larger than the limit + oversizedBody := strings.Repeat("x", httpClientMaxResponseBodyLen+1024) + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + _, _ = w.Write([]byte(oversizedBody)) + })) + resp, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: ts.URL, + TimeoutMs: 5000, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(len(resp.Body)).To(Equal(httpClientMaxResponseBodyLen)) + }) + }) + + Context("edge cases", func() { + BeforeEach(func() { + svc = newHTTPService("test-plugin", &HTTPPermission{ + RequiredHosts: []string{"127.0.0.1"}, + }) + }) + + It("should default empty method to GET", func() { + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + _, _ = w.Write([]byte("method:" + r.Method)) + })) + // Empty method — Go's http.NewRequestWithContext normalizes "" to "GET" + resp, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "", + URL: ts.URL, + TimeoutMs: 1000, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(string(resp.Body)).To(Equal("method:GET")) + }) + }) +}) + +var _ = Describe("extractHostname", func() { + It("should extract hostname from host:port", func() { + Expect(extractHostname("example.com:8080")).To(Equal("example.com")) + }) + + It("should return hostname when no port", func() { + Expect(extractHostname("example.com")).To(Equal("example.com")) + }) + + It("should handle IPv6 with port", func() { + Expect(extractHostname("[::1]:8080")).To(Equal("::1")) + }) + + It("should handle IPv6 without port", func() { + Expect(extractHostname("::1")).To(Equal("::1")) + }) + + It("should strip brackets from IPv6 without port", func() { + Expect(extractHostname("[::1]")).To(Equal("::1")) + }) + + It("should handle IPv4 with port", func() { + Expect(extractHostname("127.0.0.1:9090")).To(Equal("127.0.0.1")) + }) + + It("should handle IPv4 without port", func() { + Expect(extractHostname("127.0.0.1")).To(Equal("127.0.0.1")) + }) +}) + +var _ = Describe("isPrivateOrLoopback", func() { + It("should detect IPv4 loopback", func() { + Expect(isPrivateOrLoopback("127.0.0.1")).To(BeTrue()) + Expect(isPrivateOrLoopback("127.0.0.2")).To(BeTrue()) + }) + + It("should detect IPv6 loopback", func() { + Expect(isPrivateOrLoopback("::1")).To(BeTrue()) + }) + + It("should detect localhost by name", func() { + Expect(isPrivateOrLoopback("localhost")).To(BeTrue()) + Expect(isPrivateOrLoopback("LOCALHOST")).To(BeTrue()) + }) + + It("should detect 10.x.x.x private range", func() { + Expect(isPrivateOrLoopback("10.0.0.1")).To(BeTrue()) + Expect(isPrivateOrLoopback("10.255.255.255")).To(BeTrue()) + }) + + It("should detect 172.16.x.x private range", func() { + Expect(isPrivateOrLoopback("172.16.0.1")).To(BeTrue()) + Expect(isPrivateOrLoopback("172.31.255.255")).To(BeTrue()) + }) + + It("should detect 192.168.x.x private range", func() { + Expect(isPrivateOrLoopback("192.168.0.1")).To(BeTrue()) + Expect(isPrivateOrLoopback("192.168.255.255")).To(BeTrue()) + }) + + It("should detect link-local addresses", func() { + Expect(isPrivateOrLoopback("169.254.169.254")).To(BeTrue()) + Expect(isPrivateOrLoopback("169.254.0.1")).To(BeTrue()) + }) + + It("should detect IPv6 private (fc00::/7)", func() { + Expect(isPrivateOrLoopback("fd00::1")).To(BeTrue()) + }) + + It("should detect IPv6 link-local (fe80::/10)", func() { + Expect(isPrivateOrLoopback("fe80::1")).To(BeTrue()) + }) + + It("should allow public IPs", func() { + Expect(isPrivateOrLoopback("8.8.8.8")).To(BeFalse()) + Expect(isPrivateOrLoopback("203.0.113.1")).To(BeFalse()) + Expect(isPrivateOrLoopback("2001:db8::1")).To(BeFalse()) + }) + + It("should allow non-IP hostnames (DNS names)", func() { + Expect(isPrivateOrLoopback("example.com")).To(BeFalse()) + Expect(isPrivateOrLoopback("api.example.com")).To(BeFalse()) + }) + + It("should not treat 172.32.x.x as private", func() { + Expect(isPrivateOrLoopback("172.32.0.1")).To(BeFalse()) + }) +}) diff --git a/plugins/host_kvstore.go b/plugins/host_kvstore.go new file mode 100644 index 000000000..248e43c4d --- /dev/null +++ b/plugins/host_kvstore.go @@ -0,0 +1,376 @@ +package plugins + +import ( + "context" + "database/sql" + "errors" + "fmt" + "os" + "path/filepath" + "slices" + "strings" + "time" + + "github.com/dustin/go-humanize" + _ "github.com/mattn/go-sqlite3" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/plugins/host" + "github.com/navidrome/navidrome/utils/slice" +) + +const ( + defaultMaxKVStoreSize = 1 * 1024 * 1024 // 1MB default + maxKeyLength = 256 // Max key length in bytes +) + +// notExpiredFilter is the SQL condition to exclude expired keys. +const notExpiredFilter = "(expires_at IS NULL OR expires_at >= datetime('now'))" + +const cleanupInterval = 1 * time.Hour + +// kvstoreServiceImpl implements the host.KVStoreService interface. +// Each plugin gets its own SQLite database for isolation. +type kvstoreServiceImpl struct { + pluginName string + db *sql.DB + maxSize int64 +} + +// newKVStoreService creates a new kvstoreServiceImpl instance with its own SQLite database. +// The provided context controls the lifetime of the background cleanup goroutine. +func newKVStoreService(ctx context.Context, pluginName string, perm *KVStorePermission) (*kvstoreServiceImpl, error) { + // Parse max size from permission, default to 1MB + maxSize := int64(defaultMaxKVStoreSize) + if perm != nil && perm.MaxSize != nil && *perm.MaxSize != "" { + parsed, err := humanize.ParseBytes(*perm.MaxSize) + if err != nil { + return nil, fmt.Errorf("invalid maxSize %q: %w", *perm.MaxSize, err) + } + maxSize = int64(parsed) + } + + // Create plugin data directory + dataDir := filepath.Join(conf.Server.DataFolder, "plugins", pluginName) + if err := os.MkdirAll(dataDir, 0700); err != nil { + return nil, fmt.Errorf("creating plugin data directory: %w", err) + } + + // Open SQLite database + dbPath := filepath.Join(dataDir, "kvstore.db") + db, err := sql.Open("sqlite3", dbPath+"?_busy_timeout=5000&_journal_mode=WAL&_foreign_keys=off") + if err != nil { + return nil, fmt.Errorf("opening kvstore database: %w", err) + } + + db.SetMaxOpenConns(3) + db.SetMaxIdleConns(1) + + // Apply schema migrations + if err := createKVStoreSchema(db); err != nil { + db.Close() + return nil, fmt.Errorf("migrating kvstore schema: %w", err) + } + + log.Debug("Initialized plugin kvstore", "plugin", pluginName, "path", dbPath, "maxSize", humanize.Bytes(uint64(maxSize))) + + svc := &kvstoreServiceImpl{ + pluginName: pluginName, + db: db, + maxSize: maxSize, + } + go svc.cleanupLoop(ctx) + return svc, nil +} + +// createKVStoreSchema applies schema migrations to the kvstore database. +// New migrations must be appended at the end of the slice. +func createKVStoreSchema(db *sql.DB) error { + return migrateDB(db, []string{ + `CREATE TABLE IF NOT EXISTS kvstore ( + key TEXT PRIMARY KEY NOT NULL, + value BLOB NOT NULL, + size INTEGER NOT NULL, + created_at DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP, + updated_at DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP + )`, + `ALTER TABLE kvstore ADD COLUMN expires_at DATETIME DEFAULT NULL`, + `CREATE INDEX idx_kvstore_expires_at ON kvstore(expires_at)`, + }) +} + +// storageUsed returns the current total storage used by non-expired keys. +func (s *kvstoreServiceImpl) storageUsed(ctx context.Context) (int64, error) { + var used int64 + err := s.db.QueryRowContext(ctx, `SELECT COALESCE(SUM(size), 0) FROM kvstore WHERE `+notExpiredFilter).Scan(&used) + if err != nil { + return 0, fmt.Errorf("calculating storage used: %w", err) + } + return used, nil +} + +// checkStorageLimit verifies that adding delta bytes would not exceed the storage limit. +func (s *kvstoreServiceImpl) checkStorageLimit(ctx context.Context, delta int64) error { + if delta <= 0 { + return nil + } + used, err := s.storageUsed(ctx) + if err != nil { + return err + } + newTotal := used + delta + if newTotal > s.maxSize { + return fmt.Errorf("storage limit exceeded: would use %s of %s allowed", + humanize.Bytes(uint64(newTotal)), humanize.Bytes(uint64(s.maxSize))) + } + return nil +} + +// setValue is the shared implementation for Set and SetWithTTL. +// A ttlSeconds of 0 means no expiration. +func (s *kvstoreServiceImpl) setValue(ctx context.Context, key string, value []byte, ttlSeconds int64) error { + if len(key) == 0 { + return fmt.Errorf("key cannot be empty") + } + if len(key) > maxKeyLength { + return fmt.Errorf("key exceeds maximum length of %d bytes", maxKeyLength) + } + + newValueSize := int64(len(value)) + + // Get current size of this key (if it exists and not expired) to calculate delta + var oldSize int64 + err := s.db.QueryRowContext(ctx, `SELECT COALESCE(size, 0) FROM kvstore WHERE key = ? AND `+notExpiredFilter, key).Scan(&oldSize) + if err != nil && !errors.Is(err, sql.ErrNoRows) { + return fmt.Errorf("checking existing key: %w", err) + } + + if err := s.checkStorageLimit(ctx, newValueSize-oldSize); err != nil { + return err + } + + // Compute expires_at: sql.NullString{Valid:false} sends NULL (no expiration), + // otherwise we send a concrete timestamp. + var expiresAt sql.NullString + if ttlSeconds > 0 { + expiresAt = sql.NullString{String: fmt.Sprintf("+%d seconds", ttlSeconds), Valid: true} + } + + _, err = s.db.ExecContext(ctx, ` + INSERT INTO kvstore (key, value, size, created_at, updated_at, expires_at) + VALUES (?, ?, ?, CURRENT_TIMESTAMP, CURRENT_TIMESTAMP, datetime('now', ?)) + ON CONFLICT(key) DO UPDATE SET + value = excluded.value, + size = excluded.size, + updated_at = CURRENT_TIMESTAMP, + expires_at = excluded.expires_at + `, key, value, newValueSize, expiresAt) + if err != nil { + return fmt.Errorf("storing value: %w", err) + } + + log.Trace(ctx, "KVStore.Set", "plugin", s.pluginName, "key", key, "size", newValueSize, "ttlSeconds", ttlSeconds) + return nil +} + +// Set stores a byte value with the given key. +func (s *kvstoreServiceImpl) Set(ctx context.Context, key string, value []byte) error { + return s.setValue(ctx, key, value, 0) +} + +// SetWithTTL stores a byte value with the given key and a time-to-live. +func (s *kvstoreServiceImpl) SetWithTTL(ctx context.Context, key string, value []byte, ttlSeconds int64) error { + if ttlSeconds <= 0 { + return fmt.Errorf("ttlSeconds must be greater than 0") + } + return s.setValue(ctx, key, value, ttlSeconds) +} + +// Get retrieves a byte value from storage. +func (s *kvstoreServiceImpl) Get(ctx context.Context, key string) ([]byte, bool, error) { + var value []byte + err := s.db.QueryRowContext(ctx, `SELECT value FROM kvstore WHERE key = ? AND `+notExpiredFilter, key).Scan(&value) + if errors.Is(err, sql.ErrNoRows) { + return nil, false, nil + } + if err != nil { + return nil, false, fmt.Errorf("reading value: %w", err) + } + + log.Trace(ctx, "KVStore.Get", "plugin", s.pluginName, "key", key, "found", true) + return value, true, nil +} + +// Delete removes a value from storage. +func (s *kvstoreServiceImpl) Delete(ctx context.Context, key string) error { + _, err := s.db.ExecContext(ctx, `DELETE FROM kvstore WHERE key = ?`, key) + if err != nil { + return fmt.Errorf("deleting value: %w", err) + } + + log.Trace(ctx, "KVStore.Delete", "plugin", s.pluginName, "key", key) + return nil +} + +// Has checks if a key exists in storage. +func (s *kvstoreServiceImpl) Has(ctx context.Context, key string) (bool, error) { + var count int + err := s.db.QueryRowContext(ctx, `SELECT COUNT(*) FROM kvstore WHERE key = ? AND `+notExpiredFilter, key).Scan(&count) + if err != nil { + return false, fmt.Errorf("checking key: %w", err) + } + + return count > 0, nil +} + +// List returns all keys matching the given prefix. +func (s *kvstoreServiceImpl) List(ctx context.Context, prefix string) ([]string, error) { + var rows *sql.Rows + var err error + + if prefix == "" { + rows, err = s.db.QueryContext(ctx, `SELECT key FROM kvstore WHERE `+notExpiredFilter+` ORDER BY key`) + } else { + // Escape special LIKE characters in prefix + escapedPrefix := strings.ReplaceAll(prefix, "%", "\\%") + escapedPrefix = strings.ReplaceAll(escapedPrefix, "_", "\\_") + rows, err = s.db.QueryContext(ctx, `SELECT key FROM kvstore WHERE key LIKE ? ESCAPE '\' AND `+notExpiredFilter+` ORDER BY key`, escapedPrefix+"%") + } + if err != nil { + return nil, fmt.Errorf("listing keys: %w", err) + } + defer rows.Close() + + var keys []string + for rows.Next() { + var key string + if err := rows.Scan(&key); err != nil { + return nil, fmt.Errorf("scanning key: %w", err) + } + keys = append(keys, key) + } + + if err := rows.Err(); err != nil { + return nil, fmt.Errorf("iterating keys: %w", err) + } + + log.Trace(ctx, "KVStore.List", "plugin", s.pluginName, "prefix", prefix, "count", len(keys)) + return keys, nil +} + +// GetStorageUsed returns the total storage used by this plugin in bytes. +func (s *kvstoreServiceImpl) GetStorageUsed(ctx context.Context) (int64, error) { + used, err := s.storageUsed(ctx) + if err != nil { + return 0, err + } + log.Trace(ctx, "KVStore.GetStorageUsed", "plugin", s.pluginName, "bytes", used) + return used, nil +} + +// DeleteByPrefix removes all keys matching the given prefix. +func (s *kvstoreServiceImpl) DeleteByPrefix(ctx context.Context, prefix string) (int64, error) { + if prefix == "" { + return 0, fmt.Errorf("prefix cannot be empty") + } + + escapedPrefix := strings.ReplaceAll(prefix, "%", "\\%") + escapedPrefix = strings.ReplaceAll(escapedPrefix, "_", "\\_") + result, err := s.db.ExecContext(ctx, `DELETE FROM kvstore WHERE key LIKE ? ESCAPE '\'`, escapedPrefix+"%") + if err != nil { + return 0, fmt.Errorf("deleting keys: %w", err) + } + + count, err := result.RowsAffected() + if err != nil { + return 0, fmt.Errorf("getting deleted count: %w", err) + } + + log.Trace(ctx, "KVStore.DeleteByPrefix", "plugin", s.pluginName, "prefix", prefix, "deletedCount", count) + return count, nil +} + +// GetMany retrieves multiple values in a single call, processing keys in batches. +func (s *kvstoreServiceImpl) GetMany(ctx context.Context, keys []string) (map[string][]byte, error) { + if len(keys) == 0 { + return map[string][]byte{}, nil + } + + const batchSize = 200 + result := make(map[string][]byte) + for chunk := range slice.CollectChunks(slices.Values(keys), batchSize) { + placeholders := make([]string, len(chunk)) + args := make([]any, len(chunk)) + for i, key := range chunk { + placeholders[i] = "?" + args[i] = key + } + + query := `SELECT key, value FROM kvstore WHERE key IN (` + strings.Join(placeholders, ",") + `) AND ` + notExpiredFilter //nolint:gosec // placeholders are always "?" + rows, err := s.db.QueryContext(ctx, query, args...) + if err != nil { + return nil, fmt.Errorf("querying values: %w", err) + } + + for rows.Next() { + var key string + var value []byte + if err := rows.Scan(&key, &value); err != nil { + rows.Close() + return nil, fmt.Errorf("scanning value: %w", err) + } + result[key] = value + } + if err := rows.Err(); err != nil { + rows.Close() + return nil, fmt.Errorf("iterating values: %w", err) + } + rows.Close() + } + + log.Trace(ctx, "KVStore.GetMany", "plugin", s.pluginName, "requested", len(keys), "found", len(result)) + return result, nil +} + +// cleanupLoop periodically removes expired keys from the database. +// It stops when the provided context is cancelled. +func (s *kvstoreServiceImpl) cleanupLoop(ctx context.Context) { + ticker := time.NewTicker(cleanupInterval) + defer ticker.Stop() + for { + select { + case <-ctx.Done(): + return + case <-ticker.C: + s.cleanupExpired(ctx) + } + } +} + +// cleanupExpired removes all expired keys from the database to reclaim disk space. +func (s *kvstoreServiceImpl) cleanupExpired(ctx context.Context) { + result, err := s.db.ExecContext(ctx, `DELETE FROM kvstore WHERE expires_at IS NOT NULL AND expires_at < datetime('now')`) + if err != nil { + log.Error(ctx, "KVStore cleanup: failed to delete expired keys", "plugin", s.pluginName, err) + return + } + if count, err := result.RowsAffected(); err == nil && count > 0 { + log.Debug("KVStore cleanup completed", "plugin", s.pluginName, "deletedKeys", count) + } +} + +// Close runs a final cleanup and closes the SQLite database connection. +// The cleanup goroutine is stopped by the context passed to newKVStoreService. +func (s *kvstoreServiceImpl) Close() error { + if s.db != nil { + log.Debug("Closing plugin kvstore", "plugin", s.pluginName) + ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) + defer cancel() + s.cleanupExpired(ctx) + return s.db.Close() + } + return nil +} + +// Compile-time verification +var _ host.KVStoreService = (*kvstoreServiceImpl)(nil) diff --git a/plugins/host_kvstore_test.go b/plugins/host_kvstore_test.go new file mode 100644 index 000000000..4928825ef --- /dev/null +++ b/plugins/host_kvstore_test.go @@ -0,0 +1,1013 @@ +//go:build !windows + +package plugins + +import ( + "context" + "crypto/sha256" + "encoding/hex" + "encoding/json" + "errors" + "net/http" + "os" + "path/filepath" + "strings" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("KVStoreService", func() { + var tmpDir string + var service *kvstoreServiceImpl + var ctx context.Context + + BeforeEach(func() { + ctx = GinkgoT().Context() + var err error + tmpDir, err = os.MkdirTemp("", "kvstore-test-*") + Expect(err).ToNot(HaveOccurred()) + + DeferCleanup(configtest.SetupConfig()) + conf.Server.DataFolder = tmpDir + + // Create service with 1KB limit for testing + maxSize := "1KB" + service, err = newKVStoreService(ctx, "test_plugin", &KVStorePermission{MaxSize: &maxSize}) + Expect(err).ToNot(HaveOccurred()) + }) + + AfterEach(func() { + if service != nil { + service.Close() + } + os.RemoveAll(tmpDir) + }) + + Describe("Basic Operations", func() { + It("sets and gets a value", func() { + err := service.Set(ctx, "key1", []byte("value1")) + Expect(err).ToNot(HaveOccurred()) + + value, exists, err := service.Get(ctx, "key1") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + Expect(value).To(Equal([]byte("value1"))) + }) + + It("returns not exists for missing key", func() { + value, exists, err := service.Get(ctx, "missing_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + Expect(value).To(BeNil()) + }) + + It("overwrites existing key", func() { + err := service.Set(ctx, "key1", []byte("value1")) + Expect(err).ToNot(HaveOccurred()) + + err = service.Set(ctx, "key1", []byte("value2")) + Expect(err).ToNot(HaveOccurred()) + + value, exists, err := service.Get(ctx, "key1") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + Expect(value).To(Equal([]byte("value2"))) + }) + + It("handles binary data", func() { + binaryData := []byte{0x00, 0x01, 0x02, 0xFF, 0xFE, 0xFD} + err := service.Set(ctx, "binary", binaryData) + Expect(err).ToNot(HaveOccurred()) + + value, exists, err := service.Get(ctx, "binary") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + Expect(value).To(Equal(binaryData)) + }) + }) + + Describe("Delete Operation", func() { + It("deletes a value", func() { + err := service.Set(ctx, "delete_me", []byte("value")) + Expect(err).ToNot(HaveOccurred()) + + err = service.Delete(ctx, "delete_me") + Expect(err).ToNot(HaveOccurred()) + + _, exists, err := service.Get(ctx, "delete_me") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + }) + + It("does not error when deleting non-existing key", func() { + err := service.Delete(ctx, "never_existed") + Expect(err).ToNot(HaveOccurred()) + }) + }) + + Describe("Has Operation", func() { + It("returns true for existing key", func() { + err := service.Set(ctx, "exists_key", []byte("value")) + Expect(err).ToNot(HaveOccurred()) + + exists, err := service.Has(ctx, "exists_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + }) + + It("returns false for non-existing key", func() { + exists, err := service.Has(ctx, "non_existing_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + }) + }) + + Describe("List Operation", func() { + BeforeEach(func() { + Expect(service.Set(ctx, "user:1:name", []byte("Alice"))).To(Succeed()) + Expect(service.Set(ctx, "user:1:email", []byte("alice@test.com"))).To(Succeed()) + Expect(service.Set(ctx, "user:2:name", []byte("Bob"))).To(Succeed()) + Expect(service.Set(ctx, "config:theme", []byte("dark"))).To(Succeed()) + }) + + It("lists all keys with empty prefix", func() { + keys, err := service.List(ctx, "") + Expect(err).ToNot(HaveOccurred()) + Expect(keys).To(HaveLen(4)) + Expect(keys).To(ContainElements("config:theme", "user:1:email", "user:1:name", "user:2:name")) + }) + + It("lists keys matching prefix", func() { + keys, err := service.List(ctx, "user:1:") + Expect(err).ToNot(HaveOccurred()) + Expect(keys).To(HaveLen(2)) + Expect(keys).To(ContainElements("user:1:name", "user:1:email")) + }) + + It("lists keys matching partial prefix", func() { + keys, err := service.List(ctx, "user:") + Expect(err).ToNot(HaveOccurred()) + Expect(keys).To(HaveLen(3)) + }) + + It("returns empty list for non-matching prefix", func() { + keys, err := service.List(ctx, "notfound:") + Expect(err).ToNot(HaveOccurred()) + Expect(keys).To(BeEmpty()) + }) + + It("handles special LIKE characters in prefix", func() { + // Add keys with special characters + Expect(service.Set(ctx, "test%key", []byte("value1"))).To(Succeed()) + Expect(service.Set(ctx, "test_key", []byte("value2"))).To(Succeed()) + Expect(service.Set(ctx, "testXkey", []byte("value3"))).To(Succeed()) + + // Search for "test%" + keys, err := service.List(ctx, "test%") + Expect(err).ToNot(HaveOccurred()) + Expect(keys).To(HaveLen(1)) + Expect(keys).To(ContainElement("test%key")) + }) + }) + + Describe("Storage Usage", func() { + It("reports correct storage used", func() { + used, err := service.GetStorageUsed(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(used).To(Equal(int64(0))) + + err = service.Set(ctx, "key1", []byte("12345")) + Expect(err).ToNot(HaveOccurred()) + + used, err = service.GetStorageUsed(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(used).To(Equal(int64(5))) + + err = service.Set(ctx, "key2", []byte("67890")) + Expect(err).ToNot(HaveOccurred()) + + used, err = service.GetStorageUsed(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(used).To(Equal(int64(10))) + }) + + It("updates storage when value is overwritten", func() { + err := service.Set(ctx, "key1", []byte("12345")) + Expect(err).ToNot(HaveOccurred()) + + used, _ := service.GetStorageUsed(ctx) + Expect(used).To(Equal(int64(5))) + + // Overwrite with smaller value + err = service.Set(ctx, "key1", []byte("ab")) + Expect(err).ToNot(HaveOccurred()) + + used, _ = service.GetStorageUsed(ctx) + Expect(used).To(Equal(int64(2))) + }) + + It("decreases storage when key is deleted", func() { + Expect(service.Set(ctx, "key1", []byte("12345"))).To(Succeed()) + Expect(service.Set(ctx, "key2", []byte("67890"))).To(Succeed()) + + used, err := service.GetStorageUsed(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(used).To(Equal(int64(10))) + + Expect(service.Delete(ctx, "key1")).To(Succeed()) + + used, err = service.GetStorageUsed(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(used).To(Equal(int64(5))) + }) + + It("updates storage when value is overwritten with larger value", func() { + err := service.Set(ctx, "key1", []byte("ab")) + Expect(err).ToNot(HaveOccurred()) + + used, _ := service.GetStorageUsed(ctx) + Expect(used).To(Equal(int64(2))) + + // Overwrite with larger value + err = service.Set(ctx, "key1", []byte("12345")) + Expect(err).ToNot(HaveOccurred()) + + used, _ = service.GetStorageUsed(ctx) + Expect(used).To(Equal(int64(5))) + }) + + It("restores correct size after service restart", func() { + // Add some data + Expect(service.Set(ctx, "key1", []byte("12345"))).To(Succeed()) + Expect(service.Set(ctx, "key2", []byte("67890"))).To(Succeed()) + + used, _ := service.GetStorageUsed(ctx) + Expect(used).To(Equal(int64(10))) + + // Close and reopen the service (simulating restart) + Expect(service.Close()).To(Succeed()) + + maxSize := "1KB" + service2, err := newKVStoreService(ctx, "test_plugin", &KVStorePermission{MaxSize: &maxSize}) + Expect(err).ToNot(HaveOccurred()) + defer service2.Close() + + // Size should be restored from database + used, err = service2.GetStorageUsed(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(used).To(Equal(int64(10))) + }) + }) + + Describe("Size Limits", func() { + It("rejects value when storage limit would be exceeded", func() { + // Service has 1KB limit + bigValue := make([]byte, 2048) + err := service.Set(ctx, "big", bigValue) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("storage limit exceeded")) + }) + + It("allows updating existing key even if total would exceed limit", func() { + // Fill up most of the storage + almostFull := make([]byte, 900) + err := service.Set(ctx, "big", almostFull) + Expect(err).ToNot(HaveOccurred()) + + // Overwrite with same size should work + err = service.Set(ctx, "big", almostFull) + Expect(err).ToNot(HaveOccurred()) + }) + }) + + Describe("Key Validation", func() { + It("rejects empty key", func() { + err := service.Set(ctx, "", []byte("value")) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("key cannot be empty")) + }) + + It("rejects key exceeding max length", func() { + longKey := strings.Repeat("a", 300) + err := service.Set(ctx, longKey, []byte("value")) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("key exceeds maximum length")) + }) + }) + + Describe("Plugin Isolation", func() { + It("isolates data between plugins", func() { + service2, err := newKVStoreService(ctx, "other_plugin", &KVStorePermission{}) + Expect(err).ToNot(HaveOccurred()) + defer service2.Close() + + // Set same key in both plugins + err = service.Set(ctx, "shared", []byte("value1")) + Expect(err).ToNot(HaveOccurred()) + err = service2.Set(ctx, "shared", []byte("value2")) + Expect(err).ToNot(HaveOccurred()) + + // Each plugin should get their own value + val1, _, _ := service.Get(ctx, "shared") + Expect(val1).To(Equal([]byte("value1"))) + + val2, _, _ := service2.Get(ctx, "shared") + Expect(val2).To(Equal([]byte("value2"))) + }) + + It("creates separate database files per plugin", func() { + service2, err := newKVStoreService(ctx, "other_plugin", &KVStorePermission{}) + Expect(err).ToNot(HaveOccurred()) + defer service2.Close() + + // Check that separate directories exist + _, err = os.Stat(filepath.Join(tmpDir, "plugins", "test_plugin", "kvstore.db")) + Expect(err).ToNot(HaveOccurred()) + _, err = os.Stat(filepath.Join(tmpDir, "plugins", "other_plugin", "kvstore.db")) + Expect(err).ToNot(HaveOccurred()) + }) + }) + + Describe("Close", func() { + It("closes database connection", func() { + err := service.Close() + Expect(err).ToNot(HaveOccurred()) + + // After close, operations should fail + _, _, err = service.Get(ctx, "any") + Expect(err).To(HaveOccurred()) + }) + }) + + Describe("TTL Expiration", func() { + It("Get returns not-exists for expired keys", func() { + _, err := service.db.Exec(` + INSERT INTO kvstore (key, value, size, expires_at) + VALUES ('expired_key', 'old', 3, datetime('now', '-1 seconds')) + `) + Expect(err).ToNot(HaveOccurred()) + value, exists, err := service.Get(ctx, "expired_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + Expect(value).To(BeNil()) + }) + It("Has returns false for expired keys", func() { + _, err := service.db.Exec(` + INSERT INTO kvstore (key, value, size, expires_at) + VALUES ('expired_has', 'old', 3, datetime('now', '-1 seconds')) + `) + Expect(err).ToNot(HaveOccurred()) + exists, err := service.Has(ctx, "expired_has") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + }) + It("List excludes expired keys", func() { + Expect(service.Set(ctx, "live:1", []byte("alive"))).To(Succeed()) + _, err := service.db.Exec(` + INSERT INTO kvstore (key, value, size, expires_at) + VALUES ('live:expired', 'dead', 4, datetime('now', '-1 seconds')) + `) + Expect(err).ToNot(HaveOccurred()) + keys, err := service.List(ctx, "live:") + Expect(err).ToNot(HaveOccurred()) + Expect(keys).To(HaveLen(1)) + Expect(keys).To(ContainElement("live:1")) + }) + It("Get returns value for non-expired keys with TTL", func() { + _, err := service.db.Exec(` + INSERT INTO kvstore (key, value, size, expires_at) + VALUES ('future_key', 'still alive', 11, datetime('now', '+3600 seconds')) + `) + Expect(err).ToNot(HaveOccurred()) + value, exists, err := service.Get(ctx, "future_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + Expect(value).To(Equal([]byte("still alive"))) + }) + It("Set clears expires_at from a key previously set with TTL", func() { + // Insert a key with a TTL that has already expired + _, err := service.db.Exec(` + INSERT INTO kvstore (key, value, size, expires_at) + VALUES ('ttl_then_set', 'temp', 4, datetime('now', '-1 seconds')) + `) + Expect(err).ToNot(HaveOccurred()) + + // Overwrite with Set (no TTL) — should become permanent + err = service.Set(ctx, "ttl_then_set", []byte("permanent")) + Expect(err).ToNot(HaveOccurred()) + + // Should exist because Set cleared expires_at + value, exists, err := service.Get(ctx, "ttl_then_set") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + Expect(value).To(Equal([]byte("permanent"))) + + // Verify expires_at is actually NULL + var expiresAt *string + Expect(service.db.QueryRow(`SELECT expires_at FROM kvstore WHERE key = 'ttl_then_set'`).Scan(&expiresAt)).To(Succeed()) + Expect(expiresAt).To(BeNil()) + }) + It("expired keys are not counted in storage used", func() { + _, err := service.db.Exec(` + INSERT INTO kvstore (key, value, size, expires_at) + VALUES ('expired_key', '12345', 5, datetime('now', '-1 seconds')) + `) + Expect(err).ToNot(HaveOccurred()) + + // Expired keys should not be counted + used, err := service.GetStorageUsed(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(used).To(Equal(int64(0))) + }) + It("cleanup removes expired rows from disk", func() { + _, err := service.db.Exec(` + INSERT INTO kvstore (key, value, size, expires_at) + VALUES ('cleanup_me', '12345', 5, datetime('now', '-1 seconds')) + `) + Expect(err).ToNot(HaveOccurred()) + + // Row exists in DB but is logically expired + var count int + Expect(service.db.QueryRow(`SELECT COUNT(*) FROM kvstore`).Scan(&count)).To(Succeed()) + Expect(count).To(Equal(1)) + + service.cleanupExpired(ctx) + + // Row should be physically deleted + Expect(service.db.QueryRow(`SELECT COUNT(*) FROM kvstore`).Scan(&count)).To(Succeed()) + Expect(count).To(Equal(0)) + }) + }) + + Describe("SetWithTTL", func() { + It("stores value that is retrievable before expiry", func() { + err := service.SetWithTTL(ctx, "ttl_key", []byte("ttl_value"), 3600) + Expect(err).ToNot(HaveOccurred()) + + value, exists, err := service.Get(ctx, "ttl_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + Expect(value).To(Equal([]byte("ttl_value"))) + }) + + It("value is not retrievable after expiry", func() { + // Insert a key with an already-expired TTL + _, err := service.db.Exec(` + INSERT INTO kvstore (key, value, size, expires_at) + VALUES ('short_ttl', 'gone_soon', 9, datetime('now', '-1 seconds')) + `) + Expect(err).ToNot(HaveOccurred()) + + _, exists, err := service.Get(ctx, "short_ttl") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + }) + + It("rejects ttlSeconds <= 0", func() { + err := service.SetWithTTL(ctx, "bad_ttl", []byte("value"), 0) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("ttlSeconds must be greater than 0")) + + err = service.SetWithTTL(ctx, "bad_ttl", []byte("value"), -5) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("ttlSeconds must be greater than 0")) + }) + + It("validates key same as Set", func() { + err := service.SetWithTTL(ctx, "", []byte("value"), 60) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("key cannot be empty")) + }) + + It("enforces size limits same as Set", func() { + bigValue := make([]byte, 2048) + err := service.SetWithTTL(ctx, "big_ttl", bigValue, 60) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("storage limit exceeded")) + }) + + It("overwrites existing key and updates TTL", func() { + // Insert a key with an already-expired TTL + _, err := service.db.Exec(` + INSERT INTO kvstore (key, value, size, expires_at) + VALUES ('overwrite_ttl', 'first', 5, datetime('now', '-1 seconds')) + `) + Expect(err).ToNot(HaveOccurred()) + + // Overwrite with a long TTL — should be retrievable + err = service.SetWithTTL(ctx, "overwrite_ttl", []byte("second"), 3600) + Expect(err).ToNot(HaveOccurred()) + + value, exists, err := service.Get(ctx, "overwrite_ttl") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + Expect(value).To(Equal([]byte("second"))) + }) + + It("tracks storage correctly", func() { + err := service.SetWithTTL(ctx, "sized_ttl", []byte("12345"), 3600) + Expect(err).ToNot(HaveOccurred()) + + used, err := service.GetStorageUsed(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(used).To(Equal(int64(5))) + }) + }) + + Describe("DeleteByPrefix", func() { + BeforeEach(func() { + Expect(service.Set(ctx, "cache:user:1", []byte("Alice"))).To(Succeed()) + Expect(service.Set(ctx, "cache:user:2", []byte("Bob"))).To(Succeed()) + Expect(service.Set(ctx, "cache:item:1", []byte("Widget"))).To(Succeed()) + Expect(service.Set(ctx, "data:important", []byte("keep"))).To(Succeed()) + }) + + It("deletes all keys with the given prefix", func() { + deleted, err := service.DeleteByPrefix(ctx, "cache:user:") + Expect(err).ToNot(HaveOccurred()) + Expect(deleted).To(Equal(int64(2))) + + keys, err := service.List(ctx, "") + Expect(err).ToNot(HaveOccurred()) + Expect(keys).To(HaveLen(2)) + Expect(keys).To(ContainElements("cache:item:1", "data:important")) + }) + + It("rejects empty prefix", func() { + _, err := service.DeleteByPrefix(ctx, "") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("prefix cannot be empty")) + }) + + It("returns 0 when no keys match", func() { + deleted, err := service.DeleteByPrefix(ctx, "nonexistent:") + Expect(err).ToNot(HaveOccurred()) + Expect(deleted).To(Equal(int64(0))) + }) + + It("updates storage size correctly", func() { + usedBefore, _ := service.GetStorageUsed(ctx) + Expect(usedBefore).To(BeNumerically(">", 0)) + + _, err := service.DeleteByPrefix(ctx, "cache:") + Expect(err).ToNot(HaveOccurred()) + + usedAfter, _ := service.GetStorageUsed(ctx) + Expect(usedAfter).To(Equal(int64(4))) + }) + + It("handles special LIKE characters in prefix", func() { + Expect(service.Set(ctx, "test%special", []byte("v1"))).To(Succeed()) + Expect(service.Set(ctx, "test_special", []byte("v2"))).To(Succeed()) + Expect(service.Set(ctx, "testXspecial", []byte("v3"))).To(Succeed()) + + deleted, err := service.DeleteByPrefix(ctx, "test%") + Expect(err).ToNot(HaveOccurred()) + Expect(deleted).To(Equal(int64(1))) + + exists, _ := service.Has(ctx, "test_special") + Expect(exists).To(BeTrue()) + exists, _ = service.Has(ctx, "testXspecial") + Expect(exists).To(BeTrue()) + }) + + It("also deletes expired keys matching prefix", func() { + _, err := service.db.Exec(` + INSERT INTO kvstore (key, value, size, expires_at) + VALUES ('cache:expired', 'old', 3, datetime('now', '-1 seconds')) + `) + Expect(err).ToNot(HaveOccurred()) + + deleted, err := service.DeleteByPrefix(ctx, "cache:") + Expect(err).ToNot(HaveOccurred()) + Expect(deleted).To(Equal(int64(4))) + }) + }) + + Describe("GetMany", func() { + BeforeEach(func() { + Expect(service.Set(ctx, "key1", []byte("value1"))).To(Succeed()) + Expect(service.Set(ctx, "key2", []byte("value2"))).To(Succeed()) + Expect(service.Set(ctx, "key3", []byte("value3"))).To(Succeed()) + }) + + It("retrieves multiple values at once", func() { + values, err := service.GetMany(ctx, []string{"key1", "key2", "key3"}) + Expect(err).ToNot(HaveOccurred()) + Expect(values).To(HaveLen(3)) + Expect(values["key1"]).To(Equal([]byte("value1"))) + Expect(values["key2"]).To(Equal([]byte("value2"))) + Expect(values["key3"]).To(Equal([]byte("value3"))) + }) + + It("omits missing keys from result", func() { + values, err := service.GetMany(ctx, []string{"key1", "missing", "key3"}) + Expect(err).ToNot(HaveOccurred()) + Expect(values).To(HaveLen(2)) + Expect(values["key1"]).To(Equal([]byte("value1"))) + Expect(values["key3"]).To(Equal([]byte("value3"))) + _, hasMissing := values["missing"] + Expect(hasMissing).To(BeFalse()) + }) + + It("returns empty map for empty keys slice", func() { + values, err := service.GetMany(ctx, []string{}) + Expect(err).ToNot(HaveOccurred()) + Expect(values).To(BeEmpty()) + }) + + It("returns empty map for nil keys slice", func() { + values, err := service.GetMany(ctx, nil) + Expect(err).ToNot(HaveOccurred()) + Expect(values).To(BeEmpty()) + }) + + It("excludes expired keys", func() { + _, err := service.db.Exec(` + INSERT INTO kvstore (key, value, size, expires_at) + VALUES ('expired_many', 'old', 3, datetime('now', '-1 seconds')) + `) + Expect(err).ToNot(HaveOccurred()) + + values, err := service.GetMany(ctx, []string{"key1", "expired_many"}) + Expect(err).ToNot(HaveOccurred()) + Expect(values).To(HaveLen(1)) + Expect(values["key1"]).To(Equal([]byte("value1"))) + }) + + It("handles all keys missing", func() { + values, err := service.GetMany(ctx, []string{"nope1", "nope2"}) + Expect(err).ToNot(HaveOccurred()) + Expect(values).To(BeEmpty()) + }) + }) +}) + +var _ = Describe("KVStoreService Integration", Ordered, func() { + var ( + manager *Manager + tmpDir string + ) + + BeforeAll(func() { + var err error + tmpDir, err = os.MkdirTemp("", "kvstore-integration-test-*") + Expect(err).ToNot(HaveOccurred()) + + // Copy the test-kvstore plugin + srcPath := filepath.Join(testdataDir, "test-kvstore"+PackageExtension) + destPath := filepath.Join(tmpDir, "test-kvstore"+PackageExtension) + data, err := os.ReadFile(srcPath) + Expect(err).ToNot(HaveOccurred()) + err = os.WriteFile(destPath, data, 0600) + Expect(err).ToNot(HaveOccurred()) + + // Compute SHA256 for the plugin + hash := sha256.Sum256(data) + hashHex := hex.EncodeToString(hash[:]) + + // Setup config + DeferCleanup(configtest.SetupConfig()) + conf.Server.Plugins.Enabled = true + conf.Server.Plugins.Folder = tmpDir + conf.Server.Plugins.AutoReload = false + conf.Server.DataFolder = tmpDir + + // Setup mock DataStore with pre-enabled plugin + mockPluginRepo := tests.CreateMockPluginRepo() + mockPluginRepo.Permitted = true + mockPluginRepo.SetData(model.Plugins{{ + ID: "test-kvstore", + Path: destPath, + SHA256: hashHex, + Enabled: true, + }}) + dataStore := &tests.MockDataStore{MockedPlugin: mockPluginRepo} + + // Create and start manager + manager = &Manager{ + plugins: make(map[string]*plugin), + ds: dataStore, + subsonicRouter: http.NotFoundHandler(), + } + err = manager.Start(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + + DeferCleanup(func() { + _ = manager.Stop() + _ = os.RemoveAll(tmpDir) + }) + }) + + Describe("Plugin Loading", func() { + It("should load plugin with kvstore permission", func() { + manager.mu.RLock() + p, ok := manager.plugins["test-kvstore"] + manager.mu.RUnlock() + Expect(ok).To(BeTrue()) + Expect(p.manifest.Permissions).ToNot(BeNil()) + Expect(p.manifest.Permissions.Kvstore).ToNot(BeNil()) + Expect(*p.manifest.Permissions.Kvstore.MaxSize).To(Equal("10KB")) + }) + }) + + Describe("KVStore Operations via Plugin", func() { + type testKVStoreInput struct { + Operation string `json:"operation"` + Key string `json:"key"` + Value []byte `json:"value,omitempty"` + Prefix string `json:"prefix,omitempty"` + TTLSeconds int64 `json:"ttl_seconds,omitempty"` + Keys []string `json:"keys,omitempty"` + } + type testKVStoreOutput struct { + Value []byte `json:"value,omitempty"` + Values map[string][]byte `json:"values,omitempty"` + Exists bool `json:"exists,omitempty"` + Keys []string `json:"keys,omitempty"` + StorageUsed int64 `json:"storage_used,omitempty"` + DeletedCount int64 `json:"deleted_count,omitempty"` + Error *string `json:"error,omitempty"` + } + + callTestKVStore := func(ctx context.Context, input testKVStoreInput) (*testKVStoreOutput, error) { + manager.mu.RLock() + p := manager.plugins["test-kvstore"] + manager.mu.RUnlock() + + instance, err := p.instance(ctx) + if err != nil { + return nil, err + } + defer instance.Close(ctx) + + inputBytes, _ := json.Marshal(input) + _, outputBytes, err := instance.Call("nd_test_kvstore", inputBytes) + if err != nil { + return nil, err + } + + var output testKVStoreOutput + if err := json.Unmarshal(outputBytes, &output); err != nil { + return nil, err + } + if output.Error != nil { + return nil, errors.New(*output.Error) + } + return &output, nil + } + + It("should set and get value", func() { + ctx := GinkgoT().Context() + + // Set value + _, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "set", + Key: "test_key", + Value: []byte("hello kvstore"), + }) + Expect(err).ToNot(HaveOccurred()) + + // Get value + output, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "get", + Key: "test_key", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeTrue()) + Expect(output.Value).To(Equal([]byte("hello kvstore"))) + }) + + It("should check key existence with has", func() { + ctx := GinkgoT().Context() + + // Check existing key + output, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "has", + Key: "test_key", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeTrue()) + + // Check non-existing key + output, err = callTestKVStore(ctx, testKVStoreInput{ + Operation: "has", + Key: "non_existing", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeFalse()) + }) + + It("should delete value", func() { + ctx := GinkgoT().Context() + + // Set another key + _, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "set", + Key: "to_delete", + Value: []byte("delete me"), + }) + Expect(err).ToNot(HaveOccurred()) + + // Delete it + _, err = callTestKVStore(ctx, testKVStoreInput{ + Operation: "delete", + Key: "to_delete", + }) + Expect(err).ToNot(HaveOccurred()) + + // Verify it's gone + output, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "has", + Key: "to_delete", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeFalse()) + }) + + It("should list keys with prefix", func() { + ctx := GinkgoT().Context() + + // Set some keys + for _, key := range []string{"prefix:1", "prefix:2", "other:1"} { + _, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "set", + Key: key, + Value: []byte("value"), + }) + Expect(err).ToNot(HaveOccurred()) + } + + // List with prefix + output, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "list", + Prefix: "prefix:", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Keys).To(HaveLen(2)) + Expect(output.Keys).To(ContainElements("prefix:1", "prefix:2")) + }) + + It("should report storage used", func() { + ctx := GinkgoT().Context() + + output, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "get_storage_used", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.StorageUsed).To(BeNumerically(">", 0)) + }) + + It("should enforce size limits", func() { + ctx := GinkgoT().Context() + + // Plugin has 10KB limit, try to exceed it + bigValue := make([]byte, 15*1024) + _, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "set", + Key: "too_big", + Value: bigValue, + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("storage limit exceeded")) + }) + + It("should handle binary data with null bytes through WASM", func() { + ctx := GinkgoT().Context() + + // Binary data with null bytes, high bytes, and other edge cases + binaryData := []byte{0x00, 0x01, 0x02, 0xFF, 0xFE, 0x00, 0x80, 0x7F} + + // Set binary value + _, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "set", + Key: "binary_test", + Value: binaryData, + }) + Expect(err).ToNot(HaveOccurred()) + + // Get binary value and verify exact match + output, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "get", + Key: "binary_test", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeTrue()) + Expect(output.Value).To(Equal(binaryData)) + }) + + It("should set value with TTL and expire it", func() { + ctx := GinkgoT().Context() + + // Set value with 1 second TTL + _, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "set_with_ttl", + Key: "ttl_key", + Value: []byte("temporary"), + TTLSeconds: 1, + }) + Expect(err).ToNot(HaveOccurred()) + + // Immediately should exist + output, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "get", + Key: "ttl_key", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeTrue()) + Expect(output.Value).To(Equal([]byte("temporary"))) + + // Poll until the key expires (1s TTL) + Eventually(func(g Gomega) { + output, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "get", + Key: "ttl_key", + }) + g.Expect(err).ToNot(HaveOccurred()) + g.Expect(output.Exists).To(BeFalse()) + }).WithTimeout(3 * time.Second).WithPolling(200 * time.Millisecond).Should(Succeed()) + }) + + It("should delete keys by prefix", func() { + ctx := GinkgoT().Context() + + // Set multiple keys with shared prefix + for _, key := range []string{"del_prefix:a", "del_prefix:b", "keep:c"} { + _, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "set", + Key: key, + Value: []byte("value"), + }) + Expect(err).ToNot(HaveOccurred()) + } + + // Delete by prefix + output, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "delete_by_prefix", + Prefix: "del_prefix:", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.DeletedCount).To(Equal(int64(2))) + + // Verify remaining key + getOutput, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "has", + Key: "keep:c", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(getOutput.Exists).To(BeTrue()) + + // Verify deleted keys are gone + getOutput, err = callTestKVStore(ctx, testKVStoreInput{ + Operation: "has", + Key: "del_prefix:a", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(getOutput.Exists).To(BeFalse()) + }) + + It("should get many values at once", func() { + ctx := GinkgoT().Context() + + // Set multiple keys + for _, kv := range []struct{ k, v string }{ + {"many:1", "val1"}, + {"many:2", "val2"}, + {"many:3", "val3"}, + } { + _, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "set", + Key: kv.k, + Value: []byte(kv.v), + }) + Expect(err).ToNot(HaveOccurred()) + } + + // Get many, including a missing key + output, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "get_many", + Keys: []string{"many:1", "many:3", "many:missing"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Values).To(HaveLen(2)) + Expect(output.Values["many:1"]).To(Equal([]byte("val1"))) + Expect(output.Values["many:3"]).To(Equal([]byte("val3"))) + _, hasMissing := output.Values["many:missing"] + Expect(hasMissing).To(BeFalse()) + }) + }) + + Describe("Database Isolation", func() { + It("should create separate database file for plugin", func() { + dbPath := filepath.Join(tmpDir, "plugins", "test-kvstore", "kvstore.db") + _, err := os.Stat(dbPath) + Expect(err).ToNot(HaveOccurred()) + }) + }) +}) diff --git a/plugins/host_library.go b/plugins/host_library.go new file mode 100644 index 000000000..3d9f61b4f --- /dev/null +++ b/plugins/host_library.go @@ -0,0 +1,99 @@ +package plugins + +import ( + "context" + "fmt" + + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/plugins/host" +) + +type libraryServiceImpl struct { + ds model.DataStore + hasFilesystemPerm bool + allowedLibraryIDs []int + allLibraries bool + libraryIDMap map[int]struct{} +} + +func newLibraryService(ds model.DataStore, perm *LibraryPermission, allowedLibraryIDs []int, allLibraries bool) host.LibraryService { + hasFS := perm != nil && perm.Filesystem + libraryIDMap := make(map[int]struct{}) + for _, id := range allowedLibraryIDs { + libraryIDMap[id] = struct{}{} + } + return &libraryServiceImpl{ + ds: ds, + hasFilesystemPerm: hasFS, + allowedLibraryIDs: allowedLibraryIDs, + allLibraries: allLibraries, + libraryIDMap: libraryIDMap, + } +} + +func (s *libraryServiceImpl) GetLibrary(ctx context.Context, id int32) (*host.Library, error) { + // Check if the library is accessible + if !s.isLibraryAccessible(int(id)) { + return nil, fmt.Errorf("library not accessible: library ID %d is not in the allowed list", id) + } + + lib, err := s.ds.Library(ctx).Get(int(id)) + if err != nil { + return nil, fmt.Errorf("library not found: %w", err) + } + + return s.convertLibrary(lib), nil +} + +// isLibraryAccessible checks if a library ID is accessible to this plugin. +func (s *libraryServiceImpl) isLibraryAccessible(id int) bool { + if s.allLibraries { + return true + } + _, ok := s.libraryIDMap[id] + return ok +} + +func (s *libraryServiceImpl) GetAllLibraries(ctx context.Context) ([]host.Library, error) { + libs, err := s.ds.Library(ctx).GetAll() + if err != nil { + return nil, fmt.Errorf("failed to get libraries: %w", err) + } + + // Filter libraries based on allowed list + var result []host.Library + for _, lib := range libs { + if s.isLibraryAccessible(lib.ID) { + result = append(result, *s.convertLibrary(&lib)) + } + } + + return result, nil +} + +func (s *libraryServiceImpl) convertLibrary(lib *model.Library) *host.Library { + hostLib := &host.Library{ + ID: int32(lib.ID), + Name: lib.Name, + LastScanAt: lib.LastScanAt.Unix(), + TotalSongs: int32(lib.TotalSongs), + TotalAlbums: int32(lib.TotalAlbums), + TotalArtists: int32(lib.TotalArtists), + TotalSize: lib.TotalSize, + TotalDuration: lib.TotalDuration, + } + + // Only include path and mount point if filesystem permission is granted + if s.hasFilesystemPerm { + hostLib.Path = lib.Path + hostLib.MountPoint = toPluginMountPoint(int32(lib.ID)) + } + + return hostLib +} + +func toPluginMountPoint(libID int32) string { + return fmt.Sprintf("/libraries/%d", libID) +} + +var _ host.LibraryService = (*libraryServiceImpl)(nil) diff --git a/plugins/host_library_test.go b/plugins/host_library_test.go new file mode 100644 index 000000000..5746a3bed --- /dev/null +++ b/plugins/host_library_test.go @@ -0,0 +1,582 @@ +//go:build !windows + +package plugins + +import ( + "context" + "crypto/sha256" + "encoding/hex" + "encoding/json" + "errors" + "net/http" + "os" + "path/filepath" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("LibraryService", Ordered, func() { + var ( + ctx context.Context + ds model.DataStore + service *libraryServiceImpl + ) + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + ctx = context.Background() + ds = &tests.MockDataStore{} + }) + + Describe("GetLibrary", func() { + It("should return library metadata without filesystem permission", func() { + reason := "test" + service = newLibraryService(ds, &LibraryPermission{Reason: &reason, Filesystem: false}, nil, true).(*libraryServiceImpl) + + lib := &model.Library{ + ID: 1, + Name: "Test Library", + Path: "/music/test", + TotalSongs: 100, + TotalAlbums: 10, + TotalArtists: 5, + TotalSize: 1024000, + TotalDuration: 3600.5, + } + lib.LastScanAt = lib.LastScanAt.Add(0) // Ensure time is set + + mockLibRepo := ds.Library(ctx).(*tests.MockLibraryRepo) + mockLibRepo.SetData(model.Libraries{*lib}) + + result, err := service.GetLibrary(ctx, 1) + Expect(err).ToNot(HaveOccurred()) + Expect(result.ID).To(Equal(int32(1))) + Expect(result.Name).To(Equal("Test Library")) + Expect(result.TotalSongs).To(Equal(int32(100))) + Expect(result.TotalAlbums).To(Equal(int32(10))) + Expect(result.TotalArtists).To(Equal(int32(5))) + Expect(result.TotalSize).To(Equal(int64(1024000))) + Expect(result.TotalDuration).To(Equal(3600.5)) + Expect(result.Path).To(BeEmpty(), "Path should not be included without filesystem permission") + Expect(result.MountPoint).To(BeEmpty(), "MountPoint should not be included without filesystem permission") + }) + + It("should return library metadata with filesystem permission", func() { + reason := "test" + service = newLibraryService(ds, &LibraryPermission{Reason: &reason, Filesystem: true}, nil, true).(*libraryServiceImpl) + + lib := &model.Library{ + ID: 2, + Name: "FS Library", + Path: "/music/fs", + TotalSongs: 50, + TotalAlbums: 5, + TotalArtists: 3, + TotalSize: 512000, + TotalDuration: 1800.0, + } + + mockLibRepo := ds.Library(ctx).(*tests.MockLibraryRepo) + mockLibRepo.SetData(model.Libraries{*lib}) + + result, err := service.GetLibrary(ctx, 2) + Expect(err).ToNot(HaveOccurred()) + Expect(result.ID).To(Equal(int32(2))) + Expect(result.Name).To(Equal("FS Library")) + Expect(result.Path).To(Equal("/music/fs"), "Path should be included with filesystem permission") + Expect(result.MountPoint).To(Equal("/libraries/2"), "MountPoint should be included with filesystem permission") + }) + + It("should return error for non-existent library", func() { + reason := "test" + service = newLibraryService(ds, &LibraryPermission{Reason: &reason}, nil, true).(*libraryServiceImpl) + + mockLibRepo := ds.Library(ctx).(*tests.MockLibraryRepo) + mockLibRepo.SetData(model.Libraries{}) + + _, err := service.GetLibrary(ctx, 999) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("library not found")) + }) + }) + + Describe("GetAllLibraries", func() { + It("should return all libraries without filesystem permission", func() { + reason := "test" + service = newLibraryService(ds, &LibraryPermission{Reason: &reason, Filesystem: false}, nil, true).(*libraryServiceImpl) + + libs := model.Libraries{ + {ID: 1, Name: "Rock", Path: "/music/rock", TotalSongs: 100}, + {ID: 2, Name: "Jazz", Path: "/music/jazz", TotalSongs: 50}, + } + + mockLibRepo := ds.Library(ctx).(*tests.MockLibraryRepo) + mockLibRepo.SetData(libs) + + results, err := service.GetAllLibraries(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(2)) + Expect(results[0].Name).To(Equal("Rock")) + Expect(results[0].Path).To(BeEmpty()) + Expect(results[0].MountPoint).To(BeEmpty()) + Expect(results[1].Name).To(Equal("Jazz")) + Expect(results[1].Path).To(BeEmpty()) + Expect(results[1].MountPoint).To(BeEmpty()) + }) + + It("should return all libraries with filesystem permission", func() { + reason := "test" + service = newLibraryService(ds, &LibraryPermission{Reason: &reason, Filesystem: true}, nil, true).(*libraryServiceImpl) + + libs := model.Libraries{ + {ID: 1, Name: "Rock", Path: "/music/rock", TotalSongs: 100}, + {ID: 2, Name: "Jazz", Path: "/music/jazz", TotalSongs: 50}, + } + + mockLibRepo := ds.Library(ctx).(*tests.MockLibraryRepo) + mockLibRepo.SetData(libs) + + results, err := service.GetAllLibraries(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(2)) + Expect(results[0].Path).To(Equal("/music/rock")) + Expect(results[0].MountPoint).To(Equal("/libraries/1")) + Expect(results[1].Path).To(Equal("/music/jazz")) + Expect(results[1].MountPoint).To(Equal("/libraries/2")) + }) + }) + + Describe("Library Access Filtering", func() { + It("should only return libraries in the allowed list", func() { + reason := "test" + // Only allow library ID 2 + service = newLibraryService(ds, &LibraryPermission{Reason: &reason, Filesystem: false}, []int{2}, false).(*libraryServiceImpl) + + libs := model.Libraries{ + {ID: 1, Name: "Rock", Path: "/music/rock", TotalSongs: 100}, + {ID: 2, Name: "Jazz", Path: "/music/jazz", TotalSongs: 50}, + {ID: 3, Name: "Classical", Path: "/music/classical", TotalSongs: 75}, + } + + mockLibRepo := ds.Library(ctx).(*tests.MockLibraryRepo) + mockLibRepo.SetData(libs) + + results, err := service.GetAllLibraries(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].ID).To(Equal(int32(2))) + Expect(results[0].Name).To(Equal("Jazz")) + }) + + It("should return error when getting a library not in the allowed list", func() { + reason := "test" + // Only allow library ID 2 + service = newLibraryService(ds, &LibraryPermission{Reason: &reason, Filesystem: false}, []int{2}, false).(*libraryServiceImpl) + + libs := model.Libraries{ + {ID: 1, Name: "Rock", Path: "/music/rock", TotalSongs: 100}, + {ID: 2, Name: "Jazz", Path: "/music/jazz", TotalSongs: 50}, + } + + mockLibRepo := ds.Library(ctx).(*tests.MockLibraryRepo) + mockLibRepo.SetData(libs) + + // Requesting library 1 which is not in the allowed list + _, err := service.GetLibrary(ctx, 1) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("not accessible")) + }) + + It("should allow access to a library in the allowed list", func() { + reason := "test" + // Only allow library ID 2 + service = newLibraryService(ds, &LibraryPermission{Reason: &reason, Filesystem: false}, []int{2}, false).(*libraryServiceImpl) + + libs := model.Libraries{ + {ID: 1, Name: "Rock", Path: "/music/rock", TotalSongs: 100}, + {ID: 2, Name: "Jazz", Path: "/music/jazz", TotalSongs: 50}, + } + + mockLibRepo := ds.Library(ctx).(*tests.MockLibraryRepo) + mockLibRepo.SetData(libs) + + result, err := service.GetLibrary(ctx, 2) + Expect(err).ToNot(HaveOccurred()) + Expect(result.ID).To(Equal(int32(2))) + Expect(result.Name).To(Equal("Jazz")) + }) + + It("should return empty list when no libraries are allowed and allLibraries is false", func() { + reason := "test" + // No libraries allowed + service = newLibraryService(ds, &LibraryPermission{Reason: &reason, Filesystem: false}, []int{}, false).(*libraryServiceImpl) + + libs := model.Libraries{ + {ID: 1, Name: "Rock", Path: "/music/rock", TotalSongs: 100}, + {ID: 2, Name: "Jazz", Path: "/music/jazz", TotalSongs: 50}, + } + + mockLibRepo := ds.Library(ctx).(*tests.MockLibraryRepo) + mockLibRepo.SetData(libs) + + results, err := service.GetAllLibraries(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(0)) + }) + + It("should return all libraries when allLibraries is true regardless of allowed list", func() { + reason := "test" + // allLibraries=true should ignore the allowed list + service = newLibraryService(ds, &LibraryPermission{Reason: &reason, Filesystem: false}, []int{1}, true).(*libraryServiceImpl) + + libs := model.Libraries{ + {ID: 1, Name: "Rock", Path: "/music/rock", TotalSongs: 100}, + {ID: 2, Name: "Jazz", Path: "/music/jazz", TotalSongs: 50}, + } + + mockLibRepo := ds.Library(ctx).(*tests.MockLibraryRepo) + mockLibRepo.SetData(libs) + + results, err := service.GetAllLibraries(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(2)) + }) + }) + + Describe("Plugin Integration", func() { + var ( + manager *Manager + tmpDir string + ) + + BeforeEach(func() { + var err error + tmpDir, err = os.MkdirTemp("", "library-test-*") + Expect(err).ToNot(HaveOccurred()) + + // Note: Since we don't have WASM test plugins yet, we can test + // the service registration and configuration without full plugin execution + DeferCleanup(configtest.SetupConfig()) + conf.Server.Plugins.Enabled = true + conf.Server.Plugins.Folder = tmpDir + + // Create mock &tests.MockLibraryRepo{} + mockLibRepo := &tests.MockLibraryRepo{} + mockLibRepo.SetData(model.Libraries{ + {ID: 1, Name: "Test", Path: "/tmp/test-music", TotalSongs: 10}, + }) + + ds := &tests.MockDataStore{ + MockedProperty: &tests.MockedPropertyRepo{}, + MockedPlugin: tests.CreateMockPluginRepo(), + MockedLibrary: mockLibRepo, + } + + manager = &Manager{ + plugins: make(map[string]*plugin), + ds: ds, + } + + DeferCleanup(func() { + if manager != nil { + _ = manager.Stop() + } + _ = os.RemoveAll(tmpDir) + }) + }) + + It("should register library service in hostServices table", func() { + // Verify the library service is in the hostServices table + found := false + for _, entry := range hostServices { + if entry.name == "Library" { + found = true + break + } + } + Expect(found).To(BeTrue(), "Library service should be registered in hostServices") + }) + + It("should configure AllowedPaths when filesystem permission is granted", func() { + // This test verifies the AllowedPaths configuration logic + // We can't fully test without a real WASM plugin, but we can verify the setup + Expect(manager.ds).ToNot(BeNil()) + + ctx := context.Background() + libs, err := manager.ds.Library(adminContext(ctx)).GetAll() + Expect(err).ToNot(HaveOccurred()) + Expect(libs).To(HaveLen(1)) + Expect(libs[0].Path).To(Equal("/tmp/test-music")) + + // Verify mount point format + mountPoint := "/libraries/1" + Expect(mountPoint).To(MatchRegexp(`^/libraries/\d+$`)) + }) + }) +}) + +var _ = Describe("LibraryService Integration", Ordered, func() { + var ( + manager *Manager + tmpDir string + libraryDir string + ) + + BeforeAll(func() { + var err error + tmpDir, err = os.MkdirTemp("", "library-integration-test-*") + Expect(err).ToNot(HaveOccurred()) + + // Create a library directory with a test file + libraryDir = filepath.Join(tmpDir, "music-library") + err = os.MkdirAll(libraryDir, 0755) + Expect(err).ToNot(HaveOccurred()) + + // Create a test file in the library + testFile := filepath.Join(libraryDir, "test-track.txt") + err = os.WriteFile(testFile, []byte("test audio file content"), 0600) + Expect(err).ToNot(HaveOccurred()) + + // Copy the test-library plugin + srcPath := filepath.Join(testdataDir, "test-library"+PackageExtension) + destPath := filepath.Join(tmpDir, "test-library"+PackageExtension) + data, err := os.ReadFile(srcPath) + Expect(err).ToNot(HaveOccurred()) + err = os.WriteFile(destPath, data, 0600) + Expect(err).ToNot(HaveOccurred()) + + // Compute SHA256 for the plugin + hash := sha256.Sum256(data) + hashHex := hex.EncodeToString(hash[:]) + + // Setup config + DeferCleanup(configtest.SetupConfig()) + conf.Server.Plugins.Enabled = true + conf.Server.Plugins.Folder = tmpDir + conf.Server.Plugins.AutoReload = false + + // Setup mock DataStore with pre-enabled plugin and library + mockPluginRepo := tests.CreateMockPluginRepo() + mockPluginRepo.Permitted = true + mockPluginRepo.SetData(model.Plugins{{ + ID: "test-library", + Path: destPath, + SHA256: hashHex, + Enabled: true, + AllLibraries: true, // Grant access to all libraries for testing + }}) + + mockLibraryRepo := &tests.MockLibraryRepo{} + mockLibraryRepo.SetData(model.Libraries{ + { + ID: 1, + Name: "Test Library", + Path: libraryDir, + TotalSongs: 100, + TotalAlbums: 10, + TotalArtists: 5, + TotalSize: 1024000, + TotalDuration: 3600.5, + }, + { + ID: 2, + Name: "Jazz Collection", + Path: "/nonexistent/jazz", + TotalSongs: 50, + TotalAlbums: 5, + TotalArtists: 3, + TotalSize: 512000, + TotalDuration: 1800.0, + }, + }) + + dataStore := &tests.MockDataStore{ + MockedPlugin: mockPluginRepo, + MockedLibrary: mockLibraryRepo, + } + + // Create and start manager + manager = &Manager{ + plugins: make(map[string]*plugin), + ds: dataStore, + subsonicRouter: http.NotFoundHandler(), + } + err = manager.Start(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + + DeferCleanup(func() { + _ = manager.Stop() + _ = os.RemoveAll(tmpDir) + }) + }) + + Describe("Plugin Loading", func() { + It("should load plugin with library permission", func() { + manager.mu.RLock() + p, ok := manager.plugins["test-library"] + manager.mu.RUnlock() + Expect(ok).To(BeTrue()) + Expect(p.manifest.Permissions).ToNot(BeNil()) + Expect(p.manifest.Permissions.Library).ToNot(BeNil()) + Expect(p.manifest.Permissions.Library.Filesystem).To(BeTrue()) + }) + }) + + Describe("Library Operations via Plugin", func() { + type testLibraryInput struct { + Operation string `json:"operation"` + LibraryID int32 `json:"library_id,omitempty"` + MountPoint string `json:"mount_point,omitempty"` + FilePath string `json:"file_path,omitempty"` + } + type library struct { + ID int32 `json:"id"` + Name string `json:"name"` + Path string `json:"path,omitempty"` + MountPoint string `json:"mountPoint,omitempty"` + LastScanAt int64 `json:"lastScanAt"` + TotalSongs int32 `json:"totalSongs"` + TotalAlbums int32 `json:"totalAlbums"` + TotalArtists int32 `json:"totalArtists"` + TotalSize int64 `json:"totalSize"` + TotalDuration float64 `json:"totalDuration"` + } + type testLibraryOutput struct { + Library *library `json:"library,omitempty"` + Libraries []library `json:"libraries,omitempty"` + FileContent string `json:"file_content,omitempty"` + DirEntries []string `json:"dir_entries,omitempty"` + Error *string `json:"error,omitempty"` + } + + callTestLibrary := func(ctx context.Context, input testLibraryInput) (*testLibraryOutput, error) { + manager.mu.RLock() + p := manager.plugins["test-library"] + manager.mu.RUnlock() + + instance, err := p.instance(ctx) + if err != nil { + return nil, err + } + defer instance.Close(ctx) + + inputBytes, _ := json.Marshal(input) + _, outputBytes, err := instance.Call("nd_test_library", inputBytes) + if err != nil { + return nil, err + } + + var output testLibraryOutput + if err := json.Unmarshal(outputBytes, &output); err != nil { + return nil, err + } + if output.Error != nil { + return nil, errors.New(*output.Error) + } + return &output, nil + } + + It("should get library by ID with metadata", func() { + ctx := GinkgoT().Context() + + output, err := callTestLibrary(ctx, testLibraryInput{ + Operation: "get_library", + LibraryID: 1, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Library).ToNot(BeNil()) + Expect(output.Library.ID).To(Equal(int32(1))) + Expect(output.Library.Name).To(Equal("Test Library")) + Expect(output.Library.TotalSongs).To(Equal(int32(100))) + Expect(output.Library.TotalAlbums).To(Equal(int32(10))) + Expect(output.Library.TotalArtists).To(Equal(int32(5))) + }) + + It("should include path and mount point with filesystem permission", func() { + ctx := GinkgoT().Context() + + output, err := callTestLibrary(ctx, testLibraryInput{ + Operation: "get_library", + LibraryID: 1, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Library).ToNot(BeNil()) + Expect(output.Library.Path).To(Equal(libraryDir)) + Expect(output.Library.MountPoint).To(Equal("/libraries/1")) + }) + + It("should get all libraries", func() { + ctx := GinkgoT().Context() + + output, err := callTestLibrary(ctx, testLibraryInput{ + Operation: "get_all_libraries", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Libraries).To(HaveLen(2)) + + // First library + Expect(output.Libraries[0].ID).To(Equal(int32(1))) + Expect(output.Libraries[0].Name).To(Equal("Test Library")) + Expect(output.Libraries[0].MountPoint).To(Equal("/libraries/1")) + + // Second library + Expect(output.Libraries[1].ID).To(Equal(int32(2))) + Expect(output.Libraries[1].Name).To(Equal("Jazz Collection")) + Expect(output.Libraries[1].MountPoint).To(Equal("/libraries/2")) + }) + + It("should return error for non-existent library", func() { + ctx := GinkgoT().Context() + + _, err := callTestLibrary(ctx, testLibraryInput{ + Operation: "get_library", + LibraryID: 999, + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("library not found")) + }) + + // Note: This test is slightly flaky due to a potential race condition in wazero's + // WASI filesystem mounting. The test passes ~85% of the time. Using FlakeAttempts + // to automatically retry on failure. + It("should read file from mounted library directory", FlakeAttempts(5), func() { + ctx := GinkgoT().Context() + + output, err := callTestLibrary(ctx, testLibraryInput{ + Operation: "read_file", + MountPoint: "/libraries/1", + FilePath: "test-track.txt", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.FileContent).To(Equal("test audio file content")) + }) + + // Note: Uses FlakeAttempts for the same reason as the read_file test above + It("should list files in mounted library directory", FlakeAttempts(5), func() { + ctx := GinkgoT().Context() + + output, err := callTestLibrary(ctx, testLibraryInput{ + Operation: "list_dir", + MountPoint: "/libraries/1", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.DirEntries).To(ContainElement("test-track.txt")) + }) + + It("should fail to access unmapped library directory", func() { + ctx := GinkgoT().Context() + + // Try to access a path outside the mapped libraries + _, err := callTestLibrary(ctx, testLibraryInput{ + Operation: "list_dir", + MountPoint: "/etc", + }) + Expect(err).To(HaveOccurred()) + }) + }) +}) diff --git a/plugins/host_network_permissions_base.go b/plugins/host_network_permissions_base.go deleted file mode 100644 index c3224fe2a..000000000 --- a/plugins/host_network_permissions_base.go +++ /dev/null @@ -1,192 +0,0 @@ -package plugins - -import ( - "fmt" - "net" - "net/url" - "regexp" - "strings" -) - -// NetworkPermissionsBase contains common functionality for network-based permissions -type networkPermissionsBase struct { - Reason string `json:"reason"` - AllowLocalNetwork bool `json:"allowLocalNetwork,omitempty"` -} - -// URLMatcher provides URL pattern matching functionality -type urlMatcher struct{} - -// newURLMatcher creates a new URL matcher instance -func newURLMatcher() *urlMatcher { - return &urlMatcher{} -} - -// checkURLPolicy performs common checks for a URL against network policies. -func checkURLPolicy(requestURL string, allowLocalNetwork bool) (*url.URL, error) { - parsedURL, err := url.Parse(requestURL) - if err != nil { - return nil, fmt.Errorf("invalid URL: %w", err) - } - - // Check local network restrictions - if !allowLocalNetwork { - if err := checkLocalNetwork(parsedURL); err != nil { - return nil, err - } - } - return parsedURL, nil -} - -// MatchesURLPattern checks if a URL matches a given pattern -func (m *urlMatcher) MatchesURLPattern(requestURL, pattern string) bool { - // Handle wildcard pattern - if pattern == "*" { - return true - } - - // Parse both URLs to handle path matching correctly - reqURL, err := url.Parse(requestURL) - if err != nil { - return false - } - - patternURL, err := url.Parse(pattern) - if err != nil { - // If pattern is not a valid URL, treat it as a simple string pattern - regexPattern := m.urlPatternToRegex(pattern) - matched, err := regexp.MatchString(regexPattern, requestURL) - if err != nil { - return false - } - return matched - } - - // Match scheme - if patternURL.Scheme != "" && patternURL.Scheme != reqURL.Scheme { - return false - } - - // Match host with wildcard support - if !m.matchesHost(reqURL.Host, patternURL.Host) { - return false - } - - // Match path with wildcard support - // Special case: if pattern URL has empty path and contains wildcards, allow any path (domain-only wildcard matching) - if (patternURL.Path == "" || patternURL.Path == "/") && strings.Contains(pattern, "*") { - // This is a domain-only wildcard pattern, allow any path - return true - } - if !m.matchesPath(reqURL.Path, patternURL.Path) { - return false - } - - return true -} - -// urlPatternToRegex converts a URL pattern with wildcards to a regex pattern -func (m *urlMatcher) urlPatternToRegex(pattern string) string { - // Escape special regex characters except * - escaped := regexp.QuoteMeta(pattern) - - // Replace escaped \* with regex pattern for wildcard matching - // For subdomain: *.example.com -> [^.]*\.example\.com - // For path: /api/* -> /api/.* - escaped = strings.ReplaceAll(escaped, "\\*", ".*") - - // Anchor the pattern to match the full URL - return "^" + escaped + "$" -} - -// matchesHost checks if a host matches a pattern with wildcard support -func (m *urlMatcher) matchesHost(host, pattern string) bool { - if pattern == "" { - return true - } - - if pattern == "*" { - return true - } - - // Handle wildcard patterns anywhere in the host - if strings.Contains(pattern, "*") { - patterns := []string{ - strings.ReplaceAll(regexp.QuoteMeta(pattern), "\\*", "[0-9.]+"), // IP pattern - strings.ReplaceAll(regexp.QuoteMeta(pattern), "\\*", "[^.]*"), // Domain pattern - } - - for _, regexPattern := range patterns { - fullPattern := "^" + regexPattern + "$" - if matched, err := regexp.MatchString(fullPattern, host); err == nil && matched { - return true - } - } - return false - } - - return host == pattern -} - -// matchesPath checks if a path matches a pattern with wildcard support -func (m *urlMatcher) matchesPath(path, pattern string) bool { - // Normalize empty paths to "/" - if path == "" { - path = "/" - } - if pattern == "" { - pattern = "/" - } - - if pattern == "*" { - return true - } - - // Handle wildcard paths - if strings.HasSuffix(pattern, "/*") { - prefix := pattern[:len(pattern)-2] // Remove "/*" - if prefix == "" { - prefix = "/" - } - return strings.HasPrefix(path, prefix) - } - - return path == pattern -} - -// CheckLocalNetwork checks if the URL is accessing local network resources -func checkLocalNetwork(parsedURL *url.URL) error { - host := parsedURL.Hostname() - - // Check for localhost variants - if host == "localhost" || host == "127.0.0.1" || host == "::1" { - return fmt.Errorf("requests to localhost are not allowed") - } - - // Try to parse as IP address - ip := net.ParseIP(host) - if ip != nil && isPrivateIP(ip) { - return fmt.Errorf("requests to private IP addresses are not allowed") - } - - return nil -} - -// IsPrivateIP checks if an IP is loopback, private, or link-local (IPv4/IPv6). -func isPrivateIP(ip net.IP) bool { - if ip == nil { - return false - } - if ip.IsLoopback() || ip.IsPrivate() { - return true - } - // IPv4 link-local: 169.254.0.0/16 - if ip4 := ip.To4(); ip4 != nil { - return ip4[0] == 169 && ip4[1] == 254 - } - // IPv6 link-local: fe80::/10 - if ip16 := ip.To16(); ip16 != nil && ip.To4() == nil { - return ip16[0] == 0xfe && (ip16[1]&0xc0) == 0x80 - } - return false -} diff --git a/plugins/host_network_permissions_base_test.go b/plugins/host_network_permissions_base_test.go deleted file mode 100644 index 9147e99ac..000000000 --- a/plugins/host_network_permissions_base_test.go +++ /dev/null @@ -1,119 +0,0 @@ -package plugins - -import ( - "net" - "net/url" - - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" -) - -var _ = Describe("networkPermissionsBase", func() { - Describe("urlMatcher", func() { - var matcher *urlMatcher - - BeforeEach(func() { - matcher = newURLMatcher() - }) - - Describe("MatchesURLPattern", func() { - DescribeTable("exact URL matching", - func(requestURL, pattern string, expected bool) { - result := matcher.MatchesURLPattern(requestURL, pattern) - Expect(result).To(Equal(expected)) - }, - Entry("exact match", "https://api.example.com", "https://api.example.com", true), - Entry("different domain", "https://api.example.com", "https://api.other.com", false), - Entry("different scheme", "http://api.example.com", "https://api.example.com", false), - Entry("different path", "https://api.example.com/v1", "https://api.example.com/v2", false), - ) - - DescribeTable("wildcard pattern matching", - func(requestURL, pattern string, expected bool) { - result := matcher.MatchesURLPattern(requestURL, pattern) - Expect(result).To(Equal(expected)) - }, - Entry("universal wildcard", "https://api.example.com", "*", true), - Entry("subdomain wildcard match", "https://api.example.com", "https://*.example.com", true), - Entry("subdomain wildcard non-match", "https://api.other.com", "https://*.example.com", false), - Entry("path wildcard match", "https://api.example.com/v1/users", "https://api.example.com/*", true), - Entry("path wildcard non-match", "https://other.example.com/v1", "https://api.example.com/*", false), - Entry("port wildcard match", "https://api.example.com:8080", "https://api.example.com:*", true), - ) - }) - }) - - Describe("isPrivateIP", func() { - DescribeTable("IPv4 private IP detection", - func(ip string, expected bool) { - parsedIP := net.ParseIP(ip) - Expect(parsedIP).ToNot(BeNil(), "Failed to parse IP: %s", ip) - result := isPrivateIP(parsedIP) - Expect(result).To(Equal(expected)) - }, - // Private IPv4 ranges - Entry("10.0.0.1 (10.0.0.0/8)", "10.0.0.1", true), - Entry("10.255.255.255 (10.0.0.0/8)", "10.255.255.255", true), - Entry("172.16.0.1 (172.16.0.0/12)", "172.16.0.1", true), - Entry("172.31.255.255 (172.16.0.0/12)", "172.31.255.255", true), - Entry("192.168.1.1 (192.168.0.0/16)", "192.168.1.1", true), - Entry("192.168.255.255 (192.168.0.0/16)", "192.168.255.255", true), - Entry("127.0.0.1 (localhost)", "127.0.0.1", true), - Entry("127.255.255.255 (localhost)", "127.255.255.255", true), - Entry("169.254.1.1 (link-local)", "169.254.1.1", true), - Entry("169.254.255.255 (link-local)", "169.254.255.255", true), - - // Public IPv4 addresses - Entry("8.8.8.8 (Google DNS)", "8.8.8.8", false), - Entry("1.1.1.1 (Cloudflare DNS)", "1.1.1.1", false), - Entry("208.67.222.222 (OpenDNS)", "208.67.222.222", false), - Entry("172.15.255.255 (just outside 172.16.0.0/12)", "172.15.255.255", false), - Entry("172.32.0.1 (just outside 172.16.0.0/12)", "172.32.0.1", false), - ) - - DescribeTable("IPv6 private IP detection", - func(ip string, expected bool) { - parsedIP := net.ParseIP(ip) - Expect(parsedIP).ToNot(BeNil(), "Failed to parse IP: %s", ip) - result := isPrivateIP(parsedIP) - Expect(result).To(Equal(expected)) - }, - // Private IPv6 ranges - Entry("::1 (IPv6 localhost)", "::1", true), - Entry("fe80::1 (link-local)", "fe80::1", true), - Entry("fc00::1 (unique local)", "fc00::1", true), - Entry("fd00::1 (unique local)", "fd00::1", true), - - // Public IPv6 addresses - Entry("2001:4860:4860::8888 (Google DNS)", "2001:4860:4860::8888", false), - Entry("2606:4700:4700::1111 (Cloudflare DNS)", "2606:4700:4700::1111", false), - ) - }) - - Describe("checkLocalNetwork", func() { - DescribeTable("local network detection", - func(urlStr string, shouldError bool, expectedErrorSubstring string) { - parsedURL, err := url.Parse(urlStr) - Expect(err).ToNot(HaveOccurred()) - - err = checkLocalNetwork(parsedURL) - if shouldError { - Expect(err).To(HaveOccurred()) - if expectedErrorSubstring != "" { - Expect(err.Error()).To(ContainSubstring(expectedErrorSubstring)) - } - } else { - Expect(err).ToNot(HaveOccurred()) - } - }, - Entry("localhost", "http://localhost:8080", true, "localhost"), - Entry("127.0.0.1", "http://127.0.0.1:3000", true, "localhost"), - Entry("::1", "http://[::1]:8080", true, "localhost"), - Entry("private IP 192.168.1.100", "http://192.168.1.100", true, "private IP"), - Entry("private IP 10.0.0.1", "http://10.0.0.1", true, "private IP"), - Entry("private IP 172.16.0.1", "http://172.16.0.1", true, "private IP"), - Entry("public IP 8.8.8.8", "http://8.8.8.8", false, ""), - Entry("public domain", "https://api.example.com", false, ""), - ) - }) -}) diff --git a/plugins/host_scheduler.go b/plugins/host_scheduler.go index 26c5e92f8..131f56521 100644 --- a/plugins/host_scheduler.go +++ b/plugins/host_scheduler.go @@ -3,336 +3,207 @@ package plugins import ( "context" "fmt" + "maps" "sync" "time" - gonanoid "github.com/matoous/go-nanoid/v2" "github.com/navidrome/navidrome/log" - "github.com/navidrome/navidrome/plugins/host/scheduler" - navidsched "github.com/navidrome/navidrome/scheduler" + "github.com/navidrome/navidrome/model/id" + "github.com/navidrome/navidrome/plugins/capabilities" + "github.com/navidrome/navidrome/plugins/host" + "github.com/navidrome/navidrome/scheduler" ) -const ( - ScheduleTypeOneTime = "one-time" - ScheduleTypeRecurring = "recurring" -) +// CapabilityScheduler indicates the plugin can receive scheduled event callbacks. +// Detected when the plugin exports the scheduler callback function. +const CapabilityScheduler Capability = "Scheduler" -// ScheduledCallback represents a registered schedule callback -type ScheduledCallback struct { - ID string - PluginID string - Type string // "one-time" or "recurring" - Payload []byte - EntryID int // Used for recurring schedules via the scheduler - Cancel context.CancelFunc // Used for one-time schedules +const FuncSchedulerCallback = "nd_scheduler_callback" + +func init() { + registerCapability( + CapabilityScheduler, + FuncSchedulerCallback, + ) } -// SchedulerHostFunctions implements the scheduler.SchedulerService interface -type SchedulerHostFunctions struct { - ss *schedulerService - pluginID string +// timeAfterFunc is a variable for time.AfterFunc, allowing tests to override it. +var timeAfterFunc = time.AfterFunc + +// scheduleEntry stores metadata about a scheduled task. +type scheduleEntry struct { + pluginName string + payload string + isRecurring bool + entryID int // Internal scheduler entry ID (for recurring tasks) + timer *time.Timer // Timer for one-time tasks (nil for recurring) } -func (s SchedulerHostFunctions) ScheduleOneTime(ctx context.Context, req *scheduler.ScheduleOneTimeRequest) (*scheduler.ScheduleResponse, error) { - return s.ss.scheduleOneTime(ctx, s.pluginID, req) +// schedulerServiceImpl implements host.SchedulerService. +// It provides plugins with scheduling capabilities and invokes callbacks when schedules fire. +type schedulerServiceImpl struct { + pluginName string + manager *Manager + scheduler scheduler.Scheduler + + mu sync.Mutex + schedules map[string]*scheduleEntry } -func (s SchedulerHostFunctions) ScheduleRecurring(ctx context.Context, req *scheduler.ScheduleRecurringRequest) (*scheduler.ScheduleResponse, error) { - return s.ss.scheduleRecurring(ctx, s.pluginID, req) -} - -func (s SchedulerHostFunctions) CancelSchedule(ctx context.Context, req *scheduler.CancelRequest) (*scheduler.CancelResponse, error) { - return s.ss.cancelSchedule(ctx, s.pluginID, req) -} - -func (s SchedulerHostFunctions) TimeNow(ctx context.Context, req *scheduler.TimeNowRequest) (*scheduler.TimeNowResponse, error) { - return s.ss.timeNow(ctx, req) -} - -type schedulerService struct { - // Map of schedule IDs to their callback info - schedules map[string]*ScheduledCallback - manager *managerImpl - navidSched navidsched.Scheduler // Navidrome scheduler for recurring jobs - mu sync.Mutex -} - -// newSchedulerService creates a new schedulerService instance -func newSchedulerService(manager *managerImpl) *schedulerService { - return &schedulerService{ - schedules: make(map[string]*ScheduledCallback), +// newSchedulerService creates a new SchedulerService for a plugin. +func newSchedulerService(pluginName string, manager *Manager, sched scheduler.Scheduler) *schedulerServiceImpl { + return &schedulerServiceImpl{ + pluginName: pluginName, manager: manager, - navidSched: navidsched.GetInstance(), + scheduler: sched, + schedules: make(map[string]*scheduleEntry), } } -func (s *schedulerService) HostFunctions(pluginID string) SchedulerHostFunctions { - return SchedulerHostFunctions{ - ss: s, - pluginID: pluginID, - } -} - -// Safe accessor methods for tests - -// hasSchedule safely checks if a schedule exists -func (s *schedulerService) hasSchedule(id string) bool { - s.mu.Lock() - defer s.mu.Unlock() - _, exists := s.schedules[id] - return exists -} - -// scheduleCount safely returns the number of schedules -func (s *schedulerService) scheduleCount() int { - s.mu.Lock() - defer s.mu.Unlock() - return len(s.schedules) -} - -// getScheduleType safely returns the type of a schedule -func (s *schedulerService) getScheduleType(id string) string { - s.mu.Lock() - defer s.mu.Unlock() - if cb, exists := s.schedules[id]; exists { - return cb.Type - } - return "" -} - -// scheduleJob is a helper function that handles the common logic for scheduling jobs -func (s *schedulerService) scheduleJob(pluginID string, scheduleId string, jobType string, payload []byte) (string, *ScheduledCallback, context.CancelFunc, error) { - if s.manager == nil { - return "", nil, nil, fmt.Errorf("scheduler service not properly initialized") +func (s *schedulerServiceImpl) ScheduleOneTime(ctx context.Context, delaySeconds int32, payload string, scheduleID string) (string, error) { + if scheduleID == "" { + scheduleID = id.NewRandom() } - // Original scheduleId (what the plugin will see) - originalScheduleId := scheduleId - if originalScheduleId == "" { - // Generate a random ID if one wasn't provided - originalScheduleId, _ = gonanoid.New(10) - } - - // Internal scheduleId (prefixed with plugin name to avoid conflicts) - internalScheduleId := pluginID + ":" + originalScheduleId - - // Store any existing cancellation function to call after we've updated the map - var cancelExisting context.CancelFunc - - // Check if there's an existing schedule with the same ID, we'll cancel it after updating the map - if existingSchedule, ok := s.schedules[internalScheduleId]; ok { - log.Debug("Replacing existing schedule with same ID", "plugin", pluginID, "scheduleID", originalScheduleId) - - // Store cancel information but don't call it yet - if existingSchedule.Type == ScheduleTypeOneTime && existingSchedule.Cancel != nil { - // We'll set the Cancel to nil to prevent the old job from removing the new one - cancelExisting = existingSchedule.Cancel - existingSchedule.Cancel = nil - } else if existingSchedule.Type == ScheduleTypeRecurring { - existingRecurringEntryID := existingSchedule.EntryID - if existingRecurringEntryID != 0 { - s.navidSched.Remove(existingRecurringEntryID) - } - } - } - - // Create the callback object - callback := &ScheduledCallback{ - ID: originalScheduleId, - PluginID: pluginID, - Type: jobType, - Payload: payload, - } - - return internalScheduleId, callback, cancelExisting, nil -} - -// scheduleOneTime registers a new one-time scheduled job -func (s *schedulerService) scheduleOneTime(_ context.Context, pluginID string, req *scheduler.ScheduleOneTimeRequest) (*scheduler.ScheduleResponse, error) { s.mu.Lock() defer s.mu.Unlock() - internalScheduleId, callback, cancelExisting, err := s.scheduleJob(pluginID, req.ScheduleId, ScheduleTypeOneTime, req.Payload) - if err != nil { - return nil, err + if _, exists := s.schedules[scheduleID]; exists { + return "", fmt.Errorf("schedule ID %q already exists", scheduleID) } - // Create a context with cancel for this one-time schedule - scheduleCtx, cancel := context.WithCancel(context.Background()) - callback.Cancel = cancel - - // Store the callback info - s.schedules[internalScheduleId] = callback - - // Now that the new job is in the map, we can safely cancel the old one - if cancelExisting != nil { - // Cancel in a goroutine to avoid deadlock since we're already holding the lock - go cancelExisting() - } - - log.Debug("One-time schedule registered", "plugin", pluginID, "scheduleID", callback.ID, "internalID", internalScheduleId) - - // Start the timer goroutine with the internal ID - go s.runOneTimeSchedule(scheduleCtx, internalScheduleId, time.Duration(req.DelaySeconds)*time.Second) - - // Return the original ID to the plugin - return &scheduler.ScheduleResponse{ - ScheduleId: callback.ID, - }, nil -} - -// scheduleRecurring registers a new recurring scheduled job -func (s *schedulerService) scheduleRecurring(_ context.Context, pluginID string, req *scheduler.ScheduleRecurringRequest) (*scheduler.ScheduleResponse, error) { - s.mu.Lock() - defer s.mu.Unlock() - - internalScheduleId, callback, cancelExisting, err := s.scheduleJob(pluginID, req.ScheduleId, ScheduleTypeRecurring, req.Payload) - if err != nil { - return nil, err - } - - // Schedule the job with the Navidrome scheduler - entryID, err := s.navidSched.Add(req.CronExpression, func() { - s.executeCallback(context.Background(), internalScheduleId, true) + capturedID := scheduleID + timer := timeAfterFunc(time.Duration(delaySeconds)*time.Second, func() { + s.invokeCallback(context.Background(), capturedID) + // Clean up the entry after firing + s.mu.Lock() + delete(s.schedules, capturedID) + s.mu.Unlock() }) - if err != nil { - return nil, fmt.Errorf("failed to schedule recurring job: %w", err) + + s.schedules[scheduleID] = &scheduleEntry{ + pluginName: s.pluginName, + payload: payload, + isRecurring: false, + timer: timer, } - // Store the entry ID so we can cancel it later - callback.EntryID = entryID - - // Store the callback info - s.schedules[internalScheduleId] = callback - - // Now that the new job is in the map, we can safely cancel the old one - if cancelExisting != nil { - // Cancel in a goroutine to avoid deadlock since we're already holding the lock - go cancelExisting() - } - - log.Debug("Recurring schedule registered", "plugin", pluginID, "scheduleID", callback.ID, "internalID", internalScheduleId, "cron", req.CronExpression) - - // Return the original ID to the plugin - return &scheduler.ScheduleResponse{ - ScheduleId: callback.ID, - }, nil + log.Debug(ctx, "Scheduled one-time task", "plugin", s.pluginName, "scheduleID", scheduleID, "delaySeconds", delaySeconds) + return scheduleID, nil } -// cancelSchedule cancels a scheduled job (either one-time or recurring) -func (s *schedulerService) cancelSchedule(_ context.Context, pluginID string, req *scheduler.CancelRequest) (*scheduler.CancelResponse, error) { +func (s *schedulerServiceImpl) ScheduleRecurring(ctx context.Context, cronExpression string, payload string, scheduleID string) (string, error) { + if scheduleID == "" { + scheduleID = id.NewRandom() + } + + capturedID := scheduleID + callback := func() { + s.invokeCallback(context.Background(), capturedID) + } + s.mu.Lock() defer s.mu.Unlock() - internalScheduleId := pluginID + ":" + req.ScheduleId - callback, exists := s.schedules[internalScheduleId] - if !exists { - return &scheduler.CancelResponse{ - Success: false, - Error: "schedule not found", - }, nil + if _, exists := s.schedules[scheduleID]; exists { + return "", fmt.Errorf("schedule ID %q already exists", scheduleID) } - // Store the cancel functions to call after we've updated the schedule map - var cancelFunc context.CancelFunc - var recurringEntryID int - - // Store cancel information but don't call it yet - if callback.Type == ScheduleTypeOneTime && callback.Cancel != nil { - cancelFunc = callback.Cancel - callback.Cancel = nil // Set to nil to prevent the cancel handler from removing the job - } else if callback.Type == ScheduleTypeRecurring { - recurringEntryID = callback.EntryID + entryID, err := s.scheduler.Add(cronExpression, callback) + if err != nil { + return "", fmt.Errorf("failed to schedule task: %w", err) } - // First remove from the map - delete(s.schedules, internalScheduleId) - - // Now perform the cancellation safely - if cancelFunc != nil { - // Execute in a goroutine to avoid deadlock since we're already holding the lock - go cancelFunc() - } - if recurringEntryID != 0 { - s.navidSched.Remove(recurringEntryID) + s.schedules[scheduleID] = &scheduleEntry{ + pluginName: s.pluginName, + payload: payload, + isRecurring: true, + entryID: entryID, } - log.Debug("Schedule canceled", "plugin", pluginID, "scheduleID", req.ScheduleId, "internalID", internalScheduleId, "type", callback.Type) - - return &scheduler.CancelResponse{ - Success: true, - }, nil + log.Debug(ctx, "Scheduled recurring task", "plugin", s.pluginName, "scheduleID", scheduleID, "cron", cronExpression) + return scheduleID, nil } -// timeNow returns the current time in multiple formats -func (s *schedulerService) timeNow(_ context.Context, req *scheduler.TimeNowRequest) (*scheduler.TimeNowResponse, error) { - now := time.Now() - - return &scheduler.TimeNowResponse{ - Rfc3339Nano: now.Format(time.RFC3339Nano), - UnixMilli: now.UnixMilli(), - LocalTimeZone: now.Location().String(), - }, nil -} - -// runOneTimeSchedule handles the one-time schedule execution and callback -func (s *schedulerService) runOneTimeSchedule(ctx context.Context, internalScheduleId string, delay time.Duration) { - tmr := time.NewTimer(delay) - defer tmr.Stop() - - select { - case <-ctx.Done(): - // Schedule was cancelled via its context - // We're no longer removing the schedule here because that's handled by the code that - // cancelled the context - log.Debug("One-time schedule context canceled", "internalID", internalScheduleId) - return - - case <-tmr.C: - // Timer fired, execute the callback - s.executeCallback(ctx, internalScheduleId, false) - } -} - -// executeCallback calls the plugin's OnSchedulerCallback method -func (s *schedulerService) executeCallback(ctx context.Context, internalScheduleId string, isRecurring bool) { +func (s *schedulerServiceImpl) CancelSchedule(ctx context.Context, scheduleID string) error { s.mu.Lock() - callback := s.schedules[internalScheduleId] - // Only remove one-time schedules from the map after execution - if callback != nil && callback.Type == ScheduleTypeOneTime { - delete(s.schedules, internalScheduleId) + entry, exists := s.schedules[scheduleID] + if !exists { + s.mu.Unlock() + return fmt.Errorf("schedule ID %q not found", scheduleID) } + delete(s.schedules, scheduleID) s.mu.Unlock() - if callback == nil { - log.Error("Schedule not found for callback", "internalID", internalScheduleId) - return + if entry.timer != nil { + entry.timer.Stop() + } else { + s.scheduler.Remove(entry.entryID) } - - ctx = log.NewContext(ctx, "plugin", callback.PluginID, "scheduleID", callback.ID, "type", callback.Type) - log.Debug("Executing schedule callback") - start := time.Now() - - // Get the plugin - p := s.manager.LoadPlugin(callback.PluginID, CapabilitySchedulerCallback) - if p == nil { - log.Error("Plugin not found for callback", "plugin", callback.PluginID) - return - } - - // Type-check the plugin - plugin, ok := p.(*wasmSchedulerCallback) - if !ok { - log.Error("Plugin does not implement SchedulerCallback", "plugin", callback.PluginID) - return - } - - // Call the plugin's OnSchedulerCallback method - log.Trace(ctx, "Executing schedule callback") - err := plugin.OnSchedulerCallback(ctx, callback.ID, callback.Payload, isRecurring) - if err != nil { - log.Error("Error executing schedule callback", "elapsed", time.Since(start), err) - return - } - log.Debug("Schedule callback executed", "elapsed", time.Since(start)) + log.Debug(ctx, "Cancelled schedule", "plugin", s.pluginName, "scheduleID", scheduleID) + return nil } + +// Close cancels all schedules for this plugin. +// This is called when the plugin is unloaded. +func (s *schedulerServiceImpl) Close() error { + s.mu.Lock() + schedules := maps.Clone(s.schedules) + s.schedules = make(map[string]*scheduleEntry) + s.mu.Unlock() + + for scheduleID, entry := range schedules { + if entry.timer != nil { + entry.timer.Stop() + } else { + s.scheduler.Remove(entry.entryID) + } + log.Debug("Cancelled schedule on plugin unload", "plugin", s.pluginName, "scheduleID", scheduleID) + } + return nil +} + +// invokeCallback calls the plugin's nd_scheduler_callback function. +func (s *schedulerServiceImpl) invokeCallback(ctx context.Context, scheduleID string) { + log.Debug(ctx, "Scheduler callback invoked", "plugin", s.pluginName, "scheduleID", scheduleID) + + s.mu.Lock() + entry, exists := s.schedules[scheduleID] + if !exists { + s.mu.Unlock() + log.Warn(ctx, "Schedule entry not found during callback", "plugin", s.pluginName, "scheduleID", scheduleID) + return + } + payload := entry.payload + isRecurring := entry.isRecurring + s.mu.Unlock() + + // Get the plugin instance from the manager + s.manager.mu.RLock() + instance, ok := s.manager.plugins[s.pluginName] + s.manager.mu.RUnlock() + + if !ok { + log.Warn(ctx, "Plugin not loaded when scheduler callback fired", "plugin", s.pluginName, "scheduleID", scheduleID) + return + } + + // Prepare callback input + input := capabilities.SchedulerCallbackRequest{ + ScheduleID: scheduleID, + Payload: payload, + IsRecurring: isRecurring, + } + + start := time.Now() + err := callPluginFunctionNoOutput(ctx, instance, FuncSchedulerCallback, input) + if err != nil { + log.Error(ctx, "Scheduler callback failed", "plugin", s.pluginName, "scheduleID", scheduleID, "duration", time.Since(start), err) + return + } + + log.Debug(ctx, "Scheduler callback completed", "plugin", s.pluginName, "scheduleID", scheduleID, "duration", time.Since(start)) +} + +// Verify interface implementation +var _ host.SchedulerService = (*schedulerServiceImpl)(nil) diff --git a/plugins/host_scheduler_test.go b/plugins/host_scheduler_test.go index 1a3efaae9..334d9b738 100644 --- a/plugins/host_scheduler_test.go +++ b/plugins/host_scheduler_test.go @@ -1,192 +1,462 @@ +//go:build !windows + package plugins import ( "context" + "crypto/sha256" + "encoding/hex" + "net/http" + "os" + "path/filepath" + "sync" "time" - "github.com/navidrome/navidrome/core/metrics" - "github.com/navidrome/navidrome/plugins/host/scheduler" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/scheduler" + "github.com/navidrome/navidrome/tests" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) -var _ = Describe("SchedulerService", func() { +var _ = Describe("SchedulerService", Ordered, func() { var ( - ss *schedulerService - manager *managerImpl - pluginName = "test_plugin" + manager *Manager + tmpDir string + mockSched *mockScheduler + mockTimers *mockTimerRegistry + testService *testableSchedulerService + origAfterFn func(time.Duration, func()) *time.Timer ) + BeforeAll(func() { + var err error + tmpDir, err = os.MkdirTemp("", "scheduler-test-*") + Expect(err).ToNot(HaveOccurred()) + + // Copy the test-scheduler plugin + srcPath := filepath.Join(testdataDir, "test-scheduler"+PackageExtension) + destPath := filepath.Join(tmpDir, "test-scheduler"+PackageExtension) + data, err := os.ReadFile(srcPath) + Expect(err).ToNot(HaveOccurred()) + err = os.WriteFile(destPath, data, 0600) + Expect(err).ToNot(HaveOccurred()) + + // Compute SHA256 for the plugin + hash := sha256.Sum256(data) + hashHex := hex.EncodeToString(hash[:]) + + // Setup config + DeferCleanup(configtest.SetupConfig()) + conf.Server.Plugins.Enabled = true + conf.Server.Plugins.Folder = tmpDir + conf.Server.Plugins.AutoReload = false + + // Create mock scheduler and timer registry + mockSched = newMockScheduler() + mockTimers = newMockTimerRegistry() + + // Replace timeAfterFunc with mock + origAfterFn = timeAfterFunc + timeAfterFunc = mockTimers.AfterFunc + + // Setup mock DataStore with pre-enabled plugin + mockPluginRepo := tests.CreateMockPluginRepo() + mockPluginRepo.Permitted = true + mockPluginRepo.SetData(model.Plugins{{ + ID: "test-scheduler", + Path: destPath, + SHA256: hashHex, + Enabled: true, + }}) + dataStore := &tests.MockDataStore{MockedPlugin: mockPluginRepo} + + // Create and start manager + manager = &Manager{ + plugins: make(map[string]*plugin), + ds: dataStore, + subsonicRouter: http.NotFoundHandler(), + metrics: noopMetricsRecorder{}, + } + err = manager.Start(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + + // Get scheduler service from plugin's closers and wrap it for testing + service := findSchedulerService(manager, "test-scheduler") + Expect(service).ToNot(BeNil()) + testService = &testableSchedulerService{schedulerServiceImpl: service} + testService.scheduler = mockSched + + DeferCleanup(func() { + timeAfterFunc = origAfterFn + _ = manager.Stop() + _ = os.RemoveAll(tmpDir) + }) + }) + BeforeEach(func() { - manager = createManager(nil, metrics.NewNoopInstance()) - ss = manager.schedulerService + mockSched.Reset() + mockTimers.Reset() + testService.ClearSchedules() }) - Describe("One-time scheduling", func() { - It("schedules one-time jobs successfully", func() { - req := &scheduler.ScheduleOneTimeRequest{ - DelaySeconds: 1, - Payload: []byte("test payload"), - ScheduleId: "test-job", - } - - resp, err := ss.scheduleOneTime(context.Background(), pluginName, req) - Expect(err).ToNot(HaveOccurred()) - Expect(resp.ScheduleId).To(Equal("test-job")) - Expect(ss.hasSchedule(pluginName + ":" + "test-job")).To(BeTrue()) - Expect(ss.getScheduleType(pluginName + ":" + "test-job")).To(Equal(ScheduleTypeOneTime)) - - // Test auto-generated ID - req.ScheduleId = "" - resp, err = ss.scheduleOneTime(context.Background(), pluginName, req) - Expect(err).ToNot(HaveOccurred()) - Expect(resp.ScheduleId).ToNot(BeEmpty()) + Describe("Plugin Loading", func() { + It("should detect scheduler capability", func() { + names := manager.PluginNames(string(CapabilityScheduler)) + Expect(names).To(ContainElement("test-scheduler")) }) - It("cancels one-time jobs successfully", func() { - req := &scheduler.ScheduleOneTimeRequest{ - DelaySeconds: 10, - ScheduleId: "test-job", - } - - _, err := ss.scheduleOneTime(context.Background(), pluginName, req) - Expect(err).ToNot(HaveOccurred()) - - cancelReq := &scheduler.CancelRequest{ - ScheduleId: "test-job", - } - - resp, err := ss.cancelSchedule(context.Background(), pluginName, cancelReq) - Expect(err).ToNot(HaveOccurred()) - Expect(resp.Success).To(BeTrue()) - Expect(ss.hasSchedule(pluginName + ":" + "test-job")).To(BeFalse()) + It("should register scheduler service for plugin", func() { + service := findSchedulerService(manager, "test-scheduler") + Expect(service).ToNot(BeNil()) }) }) - Describe("Recurring scheduling", func() { - It("schedules recurring jobs successfully", func() { - req := &scheduler.ScheduleRecurringRequest{ - CronExpression: "* * * * *", // Every minute - Payload: []byte("test payload"), - ScheduleId: "test-cron", - } - - resp, err := ss.scheduleRecurring(context.Background(), pluginName, req) + Describe("ScheduleOneTime", func() { + It("should schedule a one-time task", func() { + scheduleID, err := testService.ScheduleOneTime(GinkgoT().Context(), 1, "test-payload", "test-id") Expect(err).ToNot(HaveOccurred()) - Expect(resp.ScheduleId).To(Equal("test-cron")) - Expect(ss.hasSchedule(pluginName + ":" + "test-cron")).To(BeTrue()) - Expect(ss.getScheduleType(pluginName + ":" + "test-cron")).To(Equal(ScheduleTypeRecurring)) + Expect(scheduleID).To(Equal("test-id")) - // Test auto-generated ID - req.ScheduleId = "" - resp, err = ss.scheduleRecurring(context.Background(), pluginName, req) - Expect(err).ToNot(HaveOccurred()) - Expect(resp.ScheduleId).ToNot(BeEmpty()) + // Verify schedule was registered + Expect(testService.GetScheduleCount()).To(Equal(1)) + Expect(mockTimers.GetTimerCount()).To(Equal(1)) }) - It("cancels recurring jobs successfully", func() { - req := &scheduler.ScheduleRecurringRequest{ - CronExpression: "* * * * *", // Every minute - ScheduleId: "test-cron", - } + It("should invoke plugin callback and auto-cleanup after firing", func() { + _, err := testService.ScheduleOneTime(GinkgoT().Context(), 1, "data", "cleanup-id") + Expect(err).ToNot(HaveOccurred()) + Expect(testService.GetScheduleCount()).To(Equal(1)) - _, err := ss.scheduleRecurring(context.Background(), pluginName, req) + // Trigger fires the callback which calls the plugin's nd_scheduler_callback + // One-time schedules clean up after the callback completes + mockTimers.TriggerAll() + + // One-time schedules should self-cleanup + Expect(testService.GetScheduleCount()).To(Equal(0)) + }) + + It("should reject duplicate schedule ID", func() { + _, err := testService.ScheduleOneTime(GinkgoT().Context(), 60, "data", "dup-id") Expect(err).ToNot(HaveOccurred()) - cancelReq := &scheduler.CancelRequest{ - ScheduleId: "test-cron", - } + _, err = testService.ScheduleOneTime(GinkgoT().Context(), 60, "data2", "dup-id") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("already exists")) + }) - resp, err := ss.cancelSchedule(context.Background(), pluginName, cancelReq) + It("should auto-generate schedule ID when empty", func() { + scheduleID, err := testService.ScheduleOneTime(GinkgoT().Context(), 1, "data", "") Expect(err).ToNot(HaveOccurred()) - Expect(resp.Success).To(BeTrue()) - Expect(ss.hasSchedule(pluginName + ":" + "test-cron")).To(BeFalse()) + Expect(scheduleID).ToNot(BeEmpty()) }) }) - Describe("Replace existing schedules", func() { - It("replaces one-time jobs with new ones", func() { - // Create first job - req1 := &scheduler.ScheduleOneTimeRequest{ - DelaySeconds: 10, - Payload: []byte("test payload 1"), - ScheduleId: "replace-job", - } - _, err := ss.scheduleOneTime(context.Background(), pluginName, req1) + Describe("ScheduleRecurring", func() { + It("should schedule recurring tasks", func() { + scheduleID, err := testService.ScheduleRecurring(GinkgoT().Context(), "@every 1s", "recurring-data", "recurring-id") Expect(err).ToNot(HaveOccurred()) + Expect(scheduleID).To(Equal("recurring-id")) - // Verify that the initial job exists - scheduleId := pluginName + ":" + "replace-job" - Expect(ss.hasSchedule(scheduleId)).To(BeTrue(), "Initial schedule should exist") - - beforeCount := ss.scheduleCount() - - // Replace with second job using same ID - req2 := &scheduler.ScheduleOneTimeRequest{ - DelaySeconds: 60, // Use a longer delay to ensure it doesn't execute during the test - Payload: []byte("test payload 2"), - ScheduleId: "replace-job", - } - - _, err = ss.scheduleOneTime(context.Background(), pluginName, req2) - Expect(err).ToNot(HaveOccurred()) - - Eventually(func() bool { - return ss.hasSchedule(scheduleId) - }).Should(BeTrue(), "Schedule should exist after replacement") - Expect(ss.scheduleCount()).To(Equal(beforeCount), "Job count should remain the same after replacement") + // Verify schedule was registered + Expect(testService.GetScheduleCount()).To(Equal(1)) + entry := testService.GetSchedule("recurring-id") + Expect(entry).ToNot(BeNil()) + Expect(entry.isRecurring).To(BeTrue()) }) - It("replaces recurring jobs with new ones", func() { - // Create first job - req1 := &scheduler.ScheduleRecurringRequest{ - CronExpression: "0 * * * *", - Payload: []byte("test payload 1"), - ScheduleId: "replace-cron", - } - _, err := ss.scheduleRecurring(context.Background(), pluginName, req1) + It("should invoke plugin callback multiple times without self-canceling", func() { + _, err := testService.ScheduleRecurring(GinkgoT().Context(), "@every 1s", "data", "persist-id") Expect(err).ToNot(HaveOccurred()) - beforeCount := ss.scheduleCount() + // Trigger multiple times - recurring schedules should persist + mockSched.TriggerAll() + mockSched.TriggerAll() - // Replace with second job using same ID - req2 := &scheduler.ScheduleRecurringRequest{ - CronExpression: "*/5 * * * *", - Payload: []byte("test payload 2"), - ScheduleId: "replace-cron", - } - - _, err = ss.scheduleRecurring(context.Background(), pluginName, req2) - Expect(err).ToNot(HaveOccurred()) - - Eventually(func() bool { - return ss.hasSchedule(pluginName + ":" + "replace-cron") - }).Should(BeTrue(), "Schedule should exist after replacement") - Expect(ss.scheduleCount()).To(Equal(beforeCount), "Job count should remain the same after replacement") + // Recurring schedules should persist + Expect(testService.GetScheduleCount()).To(Equal(1)) }) }) - Describe("TimeNow", func() { - It("returns current time in RFC3339Nano, Unix milliseconds, and local timezone", func() { - now := time.Now() - req := &scheduler.TimeNowRequest{} - resp, err := ss.timeNow(context.Background(), req) - + Describe("Plugin Calling Host Functions", func() { + It("should allow plugin to schedule a one-time task from callback", func() { + // Schedule with magic payload that triggers plugin to call SchedulerScheduleOneTime + _, err := testService.ScheduleRecurring(GinkgoT().Context(), "@every 1s", "schedule-followup", "trigger-id") Expect(err).ToNot(HaveOccurred()) - Expect(resp.UnixMilli).To(BeNumerically(">=", now.UnixMilli())) - Expect(resp.LocalTimeZone).ToNot(BeEmpty()) + Expect(testService.GetScheduleCount()).To(Equal(1)) - // Validate RFC3339Nano format can be parsed - parsedTime, parseErr := time.Parse(time.RFC3339Nano, resp.Rfc3339Nano) - Expect(parseErr).ToNot(HaveOccurred()) + // Trigger - plugin callback will schedule a follow-up task + mockSched.TriggerAll() - // Validate that Unix milliseconds is reasonably close to the RFC3339Nano time - expectedMillis := parsedTime.UnixMilli() - Expect(resp.UnixMilli).To(Equal(expectedMillis)) + // Verify the plugin created a new schedule via host function + Expect(testService.GetScheduleCount()).To(Equal(2)) // original + followup - // Validate local timezone matches the current system timezone - expectedTimezone := now.Location().String() - Expect(resp.LocalTimeZone).To(Equal(expectedTimezone)) + // Verify the follow-up schedule was created with correct ID and properties + followup := testService.GetSchedule("followup-id") + Expect(followup).ToNot(BeNil()) + Expect(followup.payload).To(Equal("followup-created")) + Expect(followup.isRecurring).To(BeFalse()) + Expect(followup.timer).ToNot(BeNil()) // One-time tasks use timers + }) + + It("should allow plugin to schedule a recurring task from callback", func() { + _, err := testService.ScheduleRecurring(GinkgoT().Context(), "@every 1s", "schedule-recurring", "trigger-id") + Expect(err).ToNot(HaveOccurred()) + + mockSched.TriggerAll() + + // Verify the plugin created a recurring schedule + entry := testService.GetSchedule("recurring-from-plugin") + Expect(entry).ToNot(BeNil()) + Expect(entry.isRecurring).To(BeTrue()) + Expect(entry.payload).To(Equal("recurring-created")) + }) + }) + + Describe("CancelSchedule", func() { + It("should cancel a recurring task", func() { + _, err := testService.ScheduleRecurring(GinkgoT().Context(), "@every 1s", "data", "cancel-id") + Expect(err).ToNot(HaveOccurred()) + Expect(testService.GetScheduleCount()).To(Equal(1)) + + err = testService.CancelSchedule(GinkgoT().Context(), "cancel-id") + Expect(err).ToNot(HaveOccurred()) + Expect(testService.GetScheduleCount()).To(Equal(0)) + }) + + It("should cancel a one-time task", func() { + _, err := testService.ScheduleOneTime(GinkgoT().Context(), 60, "data", "cancel-onetime-id") + Expect(err).ToNot(HaveOccurred()) + Expect(testService.GetScheduleCount()).To(Equal(1)) + Expect(mockTimers.GetTimerCount()).To(Equal(1)) + + err = testService.CancelSchedule(GinkgoT().Context(), "cancel-onetime-id") + Expect(err).ToNot(HaveOccurred()) + Expect(testService.GetScheduleCount()).To(Equal(0)) + }) + + It("should remove callback from scheduler for recurring tasks", func() { + _, err := testService.ScheduleRecurring(GinkgoT().Context(), "@every 1s", "data", "cancel-id") + Expect(err).ToNot(HaveOccurred()) + Expect(mockSched.GetCallbackCount()).To(Equal(1)) + + err = testService.CancelSchedule(GinkgoT().Context(), "cancel-id") + Expect(err).ToNot(HaveOccurred()) + Expect(mockSched.GetCallbackCount()).To(Equal(0)) + }) + + It("should return error for non-existent schedule", func() { + err := testService.CancelSchedule(GinkgoT().Context(), "non-existent") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("not found")) + }) + }) + + Describe("Scheduler Service Isolation", func() { + It("should share the same scheduler service across multiple plugin instances", func() { + // This test verifies that when we call plugin.instance() multiple times + // (creating multiple instances from the same compiled plugin), they all + // share the same scheduler service. This is the expected behavior since + // the scheduler service is registered once per plugin at compile time. + + // Get the plugin + manager.mu.RLock() + plugin, ok := manager.plugins["test-scheduler"] + manager.mu.RUnlock() + Expect(ok).To(BeTrue()) + + // Schedule a task using the service directly + _, err := testService.ScheduleOneTime(GinkgoT().Context(), 60, "shared-data", "shared-id") + Expect(err).ToNot(HaveOccurred()) + Expect(testService.GetScheduleCount()).To(Equal(1)) + + // Create a plugin instance + instance, err := plugin.instance(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + defer instance.Close(GinkgoT().Context()) + + // The scheduler service is shared, so the schedule ID should clash + // if another instance tries to use the same ID + _, err = testService.ScheduleOneTime(GinkgoT().Context(), 60, "other-data", "shared-id") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("already exists")) + + // But different IDs should work fine + _, err = testService.ScheduleOneTime(GinkgoT().Context(), 60, "instance2-data", "otherx-id") + Expect(err).ToNot(HaveOccurred()) + Expect(testService.GetScheduleCount()).To(Equal(2)) + }) + }) + + Describe("Plugin Unload", func() { + It("should cancel all schedules when plugin is unloaded", func() { + _, err := testService.ScheduleRecurring(GinkgoT().Context(), "@every 10s", "data1", "unload-1") + Expect(err).ToNot(HaveOccurred()) + _, err = testService.ScheduleOneTime(GinkgoT().Context(), 60, "data2", "unload-2") + Expect(err).ToNot(HaveOccurred()) + Expect(testService.GetScheduleCount()).To(Equal(2)) + Expect(mockSched.GetCallbackCount()).To(Equal(1)) // Only recurring task uses scheduler + Expect(mockTimers.GetTimerCount()).To(Equal(1)) // Only one-time task uses timer + + err = manager.unloadPlugin("test-scheduler") + Expect(err).ToNot(HaveOccurred()) + + Expect(findSchedulerService(manager, "test-scheduler")).To(BeNil()) + Expect(mockSched.GetCallbackCount()).To(Equal(0)) // Recurring task removed }) }) }) + +// testableSchedulerService wraps schedulerServiceImpl with test helpers. +type testableSchedulerService struct { + *schedulerServiceImpl +} + +func (t *testableSchedulerService) GetScheduleCount() int { + t.mu.Lock() + defer t.mu.Unlock() + return len(t.schedules) +} + +func (t *testableSchedulerService) GetSchedule(id string) *scheduleEntry { + t.mu.Lock() + defer t.mu.Unlock() + return t.schedules[id] +} + +func (t *testableSchedulerService) ClearSchedules() { + t.mu.Lock() + defer t.mu.Unlock() + t.schedules = make(map[string]*scheduleEntry) +} + +// mockScheduler implements scheduler.Scheduler for testing without timing dependencies. +type mockScheduler struct { + mu sync.Mutex + callbacks map[int]func() + nextID int +} + +func newMockScheduler() *mockScheduler { + return &mockScheduler{ + callbacks: make(map[int]func()), + nextID: 1, + } +} + +func (s *mockScheduler) Run(_ context.Context) {} + +func (s *mockScheduler) Add(_ string, cmd func()) (int, error) { + s.mu.Lock() + defer s.mu.Unlock() + id := s.nextID + s.nextID++ + s.callbacks[id] = cmd + return id, nil +} + +func (s *mockScheduler) Remove(id int) { + s.mu.Lock() + defer s.mu.Unlock() + delete(s.callbacks, id) +} + +func (s *mockScheduler) TriggerAll() { + s.mu.Lock() + callbacks := make([]func(), 0, len(s.callbacks)) + for _, cb := range s.callbacks { + callbacks = append(callbacks, cb) + } + s.mu.Unlock() + for _, cb := range callbacks { + cb() + } +} + +func (s *mockScheduler) GetCallbackCount() int { + s.mu.Lock() + defer s.mu.Unlock() + return len(s.callbacks) +} + +func (s *mockScheduler) Reset() { + s.mu.Lock() + defer s.mu.Unlock() + s.callbacks = make(map[int]func()) + s.nextID = 1 +} + +var _ scheduler.Scheduler = (*mockScheduler)(nil) + +// mockTimerRegistry tracks mock timers created during tests. +type mockTimerRegistry struct { + mu sync.Mutex + callbacks []func() + timers []*time.Timer +} + +func newMockTimerRegistry() *mockTimerRegistry { + return &mockTimerRegistry{ + callbacks: make([]func(), 0), + timers: make([]*time.Timer, 0), + } +} + +// AfterFunc creates a timer that we control for testing. +func (r *mockTimerRegistry) AfterFunc(_ time.Duration, f func()) *time.Timer { + r.mu.Lock() + defer r.mu.Unlock() + + // Store callback for TriggerAll + r.callbacks = append(r.callbacks, f) + + // Create a real timer that won't fire (very long duration, immediately stopped) + t := time.NewTimer(time.Hour * 24 * 365) + t.Stop() + r.timers = append(r.timers, t) + + return t +} + +// TriggerAll fires all pending timer callbacks. +func (r *mockTimerRegistry) TriggerAll() { + r.mu.Lock() + callbacks := make([]func(), len(r.callbacks)) + copy(callbacks, r.callbacks) + r.mu.Unlock() + + for _, cb := range callbacks { + cb() + } +} + +func (r *mockTimerRegistry) GetTimerCount() int { + r.mu.Lock() + defer r.mu.Unlock() + return len(r.callbacks) +} + +func (r *mockTimerRegistry) Reset() { + r.mu.Lock() + defer r.mu.Unlock() + r.callbacks = make([]func(), 0) + r.timers = make([]*time.Timer, 0) +} + +// findSchedulerService finds the scheduler service from a plugin's closers. +func findSchedulerService(m *Manager, pluginName string) *schedulerServiceImpl { + m.mu.RLock() + instance, ok := m.plugins[pluginName] + m.mu.RUnlock() + if !ok { + return nil + } + for _, closer := range instance.closers { + if svc, ok := closer.(*schedulerServiceImpl); ok { + return svc + } + } + return nil +} diff --git a/plugins/host_subsonicapi.go b/plugins/host_subsonicapi.go index d3008798a..01a33c039 100644 --- a/plugins/host_subsonicapi.go +++ b/plugins/host_subsonicapi.go @@ -8,59 +8,60 @@ import ( "net/http/httptest" "net/url" "path" - "strings" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/request" - "github.com/navidrome/navidrome/plugins/host/subsonicapi" - "github.com/navidrome/navidrome/plugins/schema" - "github.com/navidrome/navidrome/server/subsonic" + "github.com/navidrome/navidrome/plugins/host" ) -// SubsonicAPIService is the interface for the Subsonic API service +// subsonicAPIVersion is the Subsonic API version used for plugin calls. +// This is defined locally to avoid import cycle with server/subsonic. +const subsonicAPIVersion = "1.16.1" + +// subsonicAPIServiceImpl implements host.SubsonicAPIService. +// It provides plugins with access to Navidrome's Subsonic API. // -// Authentication: The plugin must provide valid authentication parameters in the URL: -// - Required: `u` (username) - The service validates this parameter is present -// - Example: `"/rest/ping?u=admin"` -// -// URL Format: Only the path and query parameters from the URL are used - host, protocol, and method are ignored -// -// Automatic Parameters: The service automatically adds: -// - `c`: Plugin name (client identifier) -// - `v`: Subsonic API version (1.16.1) -// - `f`: Response format (json) -// -// See example usage in the `plugins/examples/subsonicapi-demo` plugin +// Authentication: The plugin must provide a valid 'u' (username) parameter in the URL. +// URL Format: Only the path and query parameters are used - host/protocol are ignored. +// Automatic Parameters: The service adds 'c' (client), 'v' (version), and optionally 'f' (format). type subsonicAPIServiceImpl struct { - pluginID string - router SubsonicRouter - ds model.DataStore - permissions *subsonicAPIPermissions + pluginID string + router SubsonicRouter + ds model.DataStore + allowedUserIDs []string // User IDs this plugin can access (from DB configuration) + allUsers bool // If true, plugin can access all users + userIDMap map[string]struct{} } -func newSubsonicAPIService(pluginID string, router *SubsonicRouter, ds model.DataStore, permissions *schema.PluginManifestPermissionsSubsonicapi) subsonicapi.SubsonicAPIService { +// newSubsonicAPIService creates a new SubsonicAPIService for a plugin. +func newSubsonicAPIService(pluginID string, router SubsonicRouter, ds model.DataStore, allowedUserIDs []string, allUsers bool) host.SubsonicAPIService { + userIDMap := make(map[string]struct{}) + for _, id := range allowedUserIDs { + userIDMap[id] = struct{}{} + } return &subsonicAPIServiceImpl{ - pluginID: pluginID, - router: *router, - ds: ds, - permissions: parseSubsonicAPIPermissions(permissions), + pluginID: pluginID, + router: router, + ds: ds, + allowedUserIDs: allowedUserIDs, + allUsers: allUsers, + userIDMap: userIDMap, } } -func (s *subsonicAPIServiceImpl) Call(ctx context.Context, req *subsonicapi.CallRequest) (*subsonicapi.CallResponse, error) { +// executeRequest handles URL parsing, validation, permission checks, HTTP request creation, +// and router invocation. Shared between Call and CallRaw. +// If setJSON is true, the 'f=json' query parameter is added. +func (s *subsonicAPIServiceImpl) executeRequest(ctx context.Context, uri string, setJSON bool) (*httptest.ResponseRecorder, error) { if s.router == nil { - return &subsonicapi.CallResponse{ - Error: "SubsonicAPI router not available", - }, nil + return nil, fmt.Errorf("SubsonicAPI router not available") } // Parse the input URL - parsedURL, err := url.Parse(req.Url) + parsedURL, err := url.Parse(uri) if err != nil { - return &subsonicapi.CallResponse{ - Error: fmt.Sprintf("invalid URL format: %v", err), - }, nil + return nil, fmt.Errorf("invalid URL format: %w", err) } // Extract query parameters @@ -69,20 +70,20 @@ func (s *subsonicAPIServiceImpl) Call(ctx context.Context, req *subsonicapi.Call // Validate that 'u' (username) parameter is present username := query.Get("u") if username == "" { - return &subsonicapi.CallResponse{ - Error: "missing required parameter 'u' (username)", - }, nil + return nil, fmt.Errorf("missing required parameter 'u' (username)") } if err := s.checkPermissions(ctx, username); err != nil { log.Warn(ctx, "SubsonicAPI call blocked by permissions", "plugin", s.pluginID, "user", username, err) - return &subsonicapi.CallResponse{Error: err.Error()}, nil + return nil, err } // Add required Subsonic API parameters - query.Set("c", s.pluginID) // Client name (plugin ID) - query.Set("f", "json") // Response format - query.Set("v", subsonic.Version) // API version + query.Set("c", s.pluginID) // Client name (plugin ID) + query.Set("v", subsonicAPIVersion) // API version + if setJSON { + query.Set("f", "json") // Response format + } // Extract the endpoint from the path endpoint := path.Base(parsedURL.Path) @@ -93,12 +94,14 @@ func (s *subsonicAPIServiceImpl) Call(ctx context.Context, req *subsonicapi.Call RawQuery: query.Encode(), } - // Create HTTP request with internal authentication - httpReq, err := http.NewRequestWithContext(ctx, "GET", finalURL.String(), nil) + // Create HTTP request with a fresh context to avoid Chi RouteContext pollution. + // Using http.NewRequest (instead of http.NewRequestWithContext) ensures the internal + // SubsonicAPI call doesn't inherit routing information from the parent handler, + // which would cause Chi to invoke the wrong handler. Authentication context is + // explicitly added in the next step via request.WithInternalAuth. + httpReq, err := http.NewRequest("GET", finalURL.String(), nil) if err != nil { - return &subsonicapi.CallResponse{ - Error: fmt.Sprintf("failed to create HTTP request: %v", err), - }, nil + return nil, fmt.Errorf("failed to create HTTP request: %w", err) } // Set internal authentication context using the username from the 'u' parameter @@ -111,56 +114,50 @@ func (s *subsonicAPIServiceImpl) Call(ctx context.Context, req *subsonicapi.Call // Call the subsonic router s.router.ServeHTTP(recorder, httpReq) - // Return the response body as JSON - return &subsonicapi.CallResponse{ - Json: recorder.Body.String(), - }, nil + return recorder, nil +} + +func (s *subsonicAPIServiceImpl) Call(ctx context.Context, uri string) (string, error) { + recorder, err := s.executeRequest(ctx, uri, true) + if err != nil { + return "", err + } + return recorder.Body.String(), nil +} + +func (s *subsonicAPIServiceImpl) CallRaw(ctx context.Context, uri string) (string, []byte, error) { + recorder, err := s.executeRequest(ctx, uri, false) + if err != nil { + return "", nil, err + } + contentType := recorder.Header().Get("Content-Type") + return contentType, recorder.Body.Bytes(), nil } func (s *subsonicAPIServiceImpl) checkPermissions(ctx context.Context, username string) error { - if s.permissions == nil { + // If allUsers is true, allow any user + if s.allUsers { return nil } - if len(s.permissions.AllowedUsernames) > 0 { - if _, ok := s.permissions.usernameMap[strings.ToLower(username)]; !ok { - return fmt.Errorf("username %s is not allowed", username) - } + + // Must have at least one allowed user ID configured + if len(s.allowedUserIDs) == 0 { + return fmt.Errorf("no users configured for plugin %s", s.pluginID) } - if !s.permissions.AllowAdmins { - if s.router == nil { - return fmt.Errorf("permissions check failed: router not available") - } - usr, err := s.ds.User(ctx).FindByUsername(username) - if err != nil { - if errors.Is(err, model.ErrNotFound) { - return fmt.Errorf("username %s not found", username) - } - return err - } - if usr.IsAdmin { - return fmt.Errorf("calling SubsonicAPI as admin user is not allowed") + + // Look up the user by username to get their ID + usr, err := s.ds.User(ctx).FindByUsername(username) + if err != nil { + if errors.Is(err, model.ErrNotFound) { + return fmt.Errorf("username %s not found", username) } + return err } + + // Check if the user's ID is in the allowed list + if _, ok := s.userIDMap[usr.ID]; !ok { + return fmt.Errorf("user %s is not authorized for this plugin", username) + } + return nil } - -type subsonicAPIPermissions struct { - AllowedUsernames []string - AllowAdmins bool - usernameMap map[string]struct{} -} - -func parseSubsonicAPIPermissions(data *schema.PluginManifestPermissionsSubsonicapi) *subsonicAPIPermissions { - if data == nil { - return &subsonicAPIPermissions{} - } - perms := &subsonicAPIPermissions{ - AllowedUsernames: data.AllowedUsernames, - AllowAdmins: data.AllowAdmins, - usernameMap: make(map[string]struct{}), - } - for _, u := range data.AllowedUsernames { - perms.usernameMap[strings.ToLower(u)] = struct{}{} - } - return perms -} diff --git a/plugins/host_subsonicapi_test.go b/plugins/host_subsonicapi_test.go index a3161ff06..607f3a64b 100644 --- a/plugins/host_subsonicapi_test.go +++ b/plugins/host_subsonicapi_test.go @@ -1,218 +1,480 @@ +//go:build !windows + package plugins import ( - "context" + "crypto/sha256" + "encoding/hex" + "encoding/json" "net/http" + "os" + "path" + "path/filepath" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/model/request" - "github.com/navidrome/navidrome/plugins/host/subsonicapi" - "github.com/navidrome/navidrome/plugins/schema" "github.com/navidrome/navidrome/tests" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) -var _ = Describe("SubsonicAPI Host Service", func() { +var _ = Describe("SubsonicAPI Host Function", Ordered, func() { var ( - service *subsonicAPIServiceImpl - mockRouter http.Handler - userRepo *tests.MockedUserRepo + manager *Manager + tmpDir string + router *fakeSubsonicRouter + userRepo *tests.MockedUserRepo + dataStore *tests.MockDataStore ) - BeforeEach(func() { - // Setup mock datastore with users - userRepo = tests.CreateMockUserRepo() - _ = userRepo.Put(&model.User{UserName: "admin", IsAdmin: true}) - _ = userRepo.Put(&model.User{UserName: "user", IsAdmin: false}) - ds := &tests.MockDataStore{MockedUser: userRepo} + BeforeAll(func() { + var err error + tmpDir, err = os.MkdirTemp("", "subsonicapi-test-*") + Expect(err).ToNot(HaveOccurred()) - // Create a mock router - mockRouter = http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - w.Header().Set("Content-Type", "application/json") - w.WriteHeader(http.StatusOK) - _, _ = w.Write([]byte(`{"subsonic-response":{"status":"ok","version":"1.16.1"}}`)) + // Copy test plugin to temp dir + srcPath := filepath.Join(testdataDir, "test-subsonicapi-plugin"+PackageExtension) + destPath := filepath.Join(tmpDir, "test-subsonicapi-plugin"+PackageExtension) + data, err := os.ReadFile(srcPath) + Expect(err).ToNot(HaveOccurred()) + err = os.WriteFile(destPath, data, 0600) + Expect(err).ToNot(HaveOccurred()) + + // Setup config + DeferCleanup(configtest.SetupConfig()) + conf.Server.Plugins.Enabled = true + conf.Server.Plugins.Folder = tmpDir + conf.Server.Plugins.AutoReload = false + + // Setup mock router and data store + router = &fakeSubsonicRouter{} + userRepo = tests.CreateMockUserRepo() + dataStore = &tests.MockDataStore{MockedUser: userRepo} + + // Add test users + _ = userRepo.Put(&model.User{ + ID: "user1", + UserName: "testuser", + IsAdmin: false, + }) + _ = userRepo.Put(&model.User{ + ID: "admin1", + UserName: "adminuser", + IsAdmin: true, }) - // Create service implementation - service = &subsonicAPIServiceImpl{ - pluginID: "test-plugin", - router: mockRouter, - ds: ds, + // Create and configure manager + manager = &Manager{ + plugins: make(map[string]*plugin), + ds: dataStore, } + manager.SetSubsonicRouter(router) + + // Pre-enable the plugin in the mock repo so it loads on startup + // Compute SHA256 of the plugin file to match what syncPlugins will compute + pluginPath := filepath.Join(tmpDir, "test-subsonicapi-plugin"+PackageExtension) + wasmData, err := os.ReadFile(pluginPath) + Expect(err).ToNot(HaveOccurred()) + hash := sha256.Sum256(wasmData) + hashHex := hex.EncodeToString(hash[:]) + + mockPluginRepo := dataStore.Plugin(GinkgoT().Context()).(*tests.MockPluginRepo) + mockPluginRepo.Permitted = true + enabledPlugin := model.Plugin{ + ID: "test-subsonicapi-plugin", + Path: pluginPath, + SHA256: hashHex, + Enabled: true, + AllUsers: true, // Allow all users for test plugin + } + mockPluginRepo.SetData(model.Plugins{enabledPlugin}) + + // Start the manager + err = manager.Start(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + + DeferCleanup(func() { + _ = manager.Stop() + _ = os.RemoveAll(tmpDir) + }) }) - // Helper function to create a mock router that captures the request - setupRequestCapture := func() **http.Request { - var capturedRequest *http.Request - mockRouter = http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - capturedRequest = r - w.WriteHeader(http.StatusOK) - _, _ = w.Write([]byte(`{}`)) - }) - service.router = mockRouter - return &capturedRequest - } + Describe("Plugin Loading", func() { + It("loads the plugin with SubsonicAPI permission", func() { + manager.mu.RLock() + plugin := manager.plugins["test-subsonicapi-plugin"] + manager.mu.RUnlock() - Describe("Call", func() { - Context("when subsonic router is available", func() { - It("should process the request successfully", func() { - req := &subsonicapi.CallRequest{ - Url: "/rest/ping?u=admin", - } - - resp, err := service.Call(context.Background(), req) - - Expect(err).ToNot(HaveOccurred()) - Expect(resp).ToNot(BeNil()) - Expect(resp.Error).To(BeEmpty()) - Expect(resp.Json).To(ContainSubstring("subsonic-response")) - Expect(resp.Json).To(ContainSubstring("ok")) - }) - - It("should add required parameters to the URL", func() { - capturedRequestPtr := setupRequestCapture() - - req := &subsonicapi.CallRequest{ - Url: "/rest/getAlbum.view?id=123&u=admin", - } - - _, err := service.Call(context.Background(), req) - - Expect(err).ToNot(HaveOccurred()) - Expect(*capturedRequestPtr).ToNot(BeNil()) - - query := (*capturedRequestPtr).URL.Query() - Expect(query.Get("c")).To(Equal("test-plugin")) - Expect(query.Get("f")).To(Equal("json")) - Expect(query.Get("v")).To(Equal("1.16.1")) - Expect(query.Get("id")).To(Equal("123")) - Expect(query.Get("u")).To(Equal("admin")) - }) - - It("should only use path and query from the input URL", func() { - capturedRequestPtr := setupRequestCapture() - - req := &subsonicapi.CallRequest{ - Url: "https://external.example.com:8080/rest/ping?u=admin", - } - - _, err := service.Call(context.Background(), req) - - Expect(err).ToNot(HaveOccurred()) - Expect(*capturedRequestPtr).ToNot(BeNil()) - Expect((*capturedRequestPtr).URL.Path).To(Equal("/ping")) - Expect((*capturedRequestPtr).URL.Host).To(BeEmpty()) - Expect((*capturedRequestPtr).URL.Scheme).To(BeEmpty()) - }) - - It("ignores the path prefix in the URL", func() { - capturedRequestPtr := setupRequestCapture() - - req := &subsonicapi.CallRequest{ - Url: "/basepath/rest/ping?u=admin", - } - - _, err := service.Call(context.Background(), req) - - Expect(err).ToNot(HaveOccurred()) - Expect(*capturedRequestPtr).ToNot(BeNil()) - Expect((*capturedRequestPtr).URL.Path).To(Equal("/ping")) - }) - - It("should set internal authentication with username from 'u' parameter", func() { - capturedRequestPtr := setupRequestCapture() - - req := &subsonicapi.CallRequest{ - Url: "/rest/ping?u=testuser", - } - - _, err := service.Call(context.Background(), req) - - Expect(err).ToNot(HaveOccurred()) - Expect(*capturedRequestPtr).ToNot(BeNil()) - - // Verify that internal authentication is set in the context - username, ok := request.InternalAuthFrom((*capturedRequestPtr).Context()) - Expect(ok).To(BeTrue()) - Expect(username).To(Equal("testuser")) - }) + Expect(plugin).ToNot(BeNil()) }) - Context("when subsonic router is not available", func() { - BeforeEach(func() { - service.router = nil - }) + It("has the correct manifest", func() { + manager.mu.RLock() + plugin := manager.plugins["test-subsonicapi-plugin"] + manager.mu.RUnlock() - It("should return an error", func() { - req := &subsonicapi.CallRequest{ - Url: "/rest/ping?u=admin", - } + Expect(plugin).ToNot(BeNil()) + Expect(plugin.manifest.Name).To(Equal("Test SubsonicAPI Plugin")) + Expect(plugin.manifest.Permissions.Subsonicapi).ToNot(BeNil()) + }) + }) - resp, err := service.Call(context.Background(), req) + Describe("SubsonicAPI Call", func() { + var plugin *plugin - Expect(err).ToNot(HaveOccurred()) - Expect(resp).ToNot(BeNil()) - Expect(resp.Error).To(Equal("SubsonicAPI router not available")) - Expect(resp.Json).To(BeEmpty()) - }) + BeforeEach(func() { + manager.mu.RLock() + plugin = manager.plugins["test-subsonicapi-plugin"] + manager.mu.RUnlock() + Expect(plugin).ToNot(BeNil()) }) - Context("when URL is invalid", func() { - It("should return an error for malformed URLs", func() { - req := &subsonicapi.CallRequest{ - Url: "://invalid-url", - } + It("successfully calls the ping endpoint", func() { + instance, err := plugin.instance(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + defer instance.Close(GinkgoT().Context()) - resp, err := service.Call(context.Background(), req) + exit, output, err := instance.Call("call_subsonic_api", []byte("/ping?u=testuser")) + Expect(err).ToNot(HaveOccurred()) + Expect(exit).To(Equal(uint32(0))) - Expect(err).ToNot(HaveOccurred()) - Expect(resp).ToNot(BeNil()) - Expect(resp.Error).To(ContainSubstring("invalid URL format")) - Expect(resp.Json).To(BeEmpty()) - }) + // Verify the response contains the expected structure + var response map[string]any + err = json.Unmarshal(output, &response) + Expect(err).ToNot(HaveOccurred()) - It("should return an error when 'u' parameter is missing", func() { - req := &subsonicapi.CallRequest{ - Url: "/rest/ping?p=password", - } - - resp, err := service.Call(context.Background(), req) - - Expect(err).ToNot(HaveOccurred()) - Expect(resp).ToNot(BeNil()) - Expect(resp.Error).To(Equal("missing required parameter 'u' (username)")) - Expect(resp.Json).To(BeEmpty()) - }) + subsonicResponse, ok := response["subsonic-response"].(map[string]any) + Expect(ok).To(BeTrue()) + Expect(subsonicResponse["status"]).To(Equal("ok")) }) - Context("permission checks", func() { - It("rejects disallowed username", func() { - service.permissions = parseSubsonicAPIPermissions(&schema.PluginManifestPermissionsSubsonicapi{ - Reason: "test", - AllowedUsernames: []string{"user"}, - }) + It("adds required parameters (c, f, v) to the request", func() { + instance, err := plugin.instance(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + defer instance.Close(GinkgoT().Context()) - resp, err := service.Call(context.Background(), &subsonicapi.CallRequest{Url: "/rest/ping?u=admin"}) - Expect(err).ToNot(HaveOccurred()) - Expect(resp.Error).To(ContainSubstring("not allowed")) - }) + _, _, err = instance.Call("call_subsonic_api", []byte("/getAlbumList?u=testuser&type=newest")) + Expect(err).ToNot(HaveOccurred()) - It("rejects admin when allowAdmins is false", func() { - service.permissions = parseSubsonicAPIPermissions(&schema.PluginManifestPermissionsSubsonicapi{Reason: "test"}) + // Verify the parameters were added + Expect(router.lastRequest).ToNot(BeNil()) + query := router.lastRequest.URL.Query() + Expect(query.Get("c")).To(Equal("test-subsonicapi-plugin")) + Expect(query.Get("f")).To(Equal("json")) + Expect(query.Get("v")).To(Equal("1.16.1")) + Expect(query.Get("type")).To(Equal("newest")) + }) - resp, err := service.Call(context.Background(), &subsonicapi.CallRequest{Url: "/rest/ping?u=admin"}) - Expect(err).ToNot(HaveOccurred()) - Expect(resp.Error).To(ContainSubstring("not allowed")) - }) + It("returns error when username is missing", func() { + instance, err := plugin.instance(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + defer instance.Close(GinkgoT().Context()) - It("allows admin when allowAdmins is true", func() { - service.permissions = parseSubsonicAPIPermissions(&schema.PluginManifestPermissionsSubsonicapi{Reason: "test", AllowAdmins: true}) + exit, _, err := instance.Call("call_subsonic_api", []byte("/ping")) + Expect(err).To(HaveOccurred()) + Expect(exit).To(Equal(uint32(1))) + Expect(err.Error()).To(ContainSubstring("missing required parameter")) + }) + }) - resp, err := service.Call(context.Background(), &subsonicapi.CallRequest{Url: "/rest/ping?u=admin"}) - Expect(err).ToNot(HaveOccurred()) - Expect(resp.Error).To(BeEmpty()) - }) + Describe("SubsonicAPI CallRaw", func() { + var plugin *plugin + + BeforeEach(func() { + manager.mu.RLock() + plugin = manager.plugins["test-subsonicapi-plugin"] + manager.mu.RUnlock() + Expect(plugin).ToNot(BeNil()) + }) + + It("successfully calls getCoverArt and returns binary data", func() { + instance, err := plugin.instance(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + defer instance.Close(GinkgoT().Context()) + + exit, output, err := instance.Call("call_subsonic_api_raw", []byte("/getCoverArt?u=testuser&id=al-1")) + Expect(err).ToNot(HaveOccurred()) + Expect(exit).To(Equal(uint32(0))) + + // Parse the metadata response from the test plugin + var result map[string]any + err = json.Unmarshal(output, &result) + Expect(err).ToNot(HaveOccurred()) + Expect(result["contentType"]).To(Equal("image/png")) + Expect(result["size"]).To(BeNumerically("==", len(fakePNGHeader))) + Expect(result["firstByte"]).To(BeNumerically("==", 0x89)) // PNG magic byte + }) + + It("does NOT set f=json parameter for raw calls", func() { + instance, err := plugin.instance(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + defer instance.Close(GinkgoT().Context()) + + _, _, err = instance.Call("call_subsonic_api_raw", []byte("/getCoverArt?u=testuser&id=al-1")) + Expect(err).ToNot(HaveOccurred()) + + Expect(router.lastRequest).ToNot(BeNil()) + query := router.lastRequest.URL.Query() + Expect(query.Get("f")).To(BeEmpty()) + Expect(query.Get("c")).To(Equal("test-subsonicapi-plugin")) + Expect(query.Get("v")).To(Equal("1.16.1")) + }) + + It("returns error when username is missing", func() { + instance, err := plugin.instance(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + defer instance.Close(GinkgoT().Context()) + + exit, _, err := instance.Call("call_subsonic_api_raw", []byte("/getCoverArt")) + Expect(err).To(HaveOccurred()) + Expect(exit).To(Equal(uint32(1))) + Expect(err.Error()).To(ContainSubstring("missing required parameter")) }) }) }) + +var _ = Describe("SubsonicAPIService", func() { + var ( + router *fakeSubsonicRouter + userRepo *tests.MockedUserRepo + dataStore *tests.MockDataStore + ) + + BeforeEach(func() { + router = &fakeSubsonicRouter{} + userRepo = tests.CreateMockUserRepo() + dataStore = &tests.MockDataStore{MockedUser: userRepo} + + _ = userRepo.Put(&model.User{ + ID: "user1", + UserName: "testuser", + IsAdmin: false, + }) + _ = userRepo.Put(&model.User{ + ID: "admin1", + UserName: "adminuser", + IsAdmin: true, + }) + _ = userRepo.Put(&model.User{ + ID: "user2", + UserName: "alloweduser", + IsAdmin: false, + }) + }) + + Describe("Permission Enforcement", func() { + Context("with specific user IDs allowed", func() { + It("blocks users not in the allowed list", func() { + // allowedUserIDs contains "user2", but testuser is "user1" + service := newSubsonicAPIService("test-plugin", router, dataStore, []string{"user2"}, false) + + ctx := GinkgoT().Context() + _, err := service.Call(ctx, "/ping?u=testuser") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("not authorized")) + }) + + It("allows users in the allowed list", func() { + // allowedUserIDs contains "user2" which is "alloweduser" + service := newSubsonicAPIService("test-plugin", router, dataStore, []string{"user2"}, false) + + ctx := GinkgoT().Context() + response, err := service.Call(ctx, "/ping?u=alloweduser") + Expect(err).ToNot(HaveOccurred()) + Expect(response).To(ContainSubstring("ok")) + }) + + It("blocks admin users when not in allowed list", func() { + // allowedUserIDs only contains "user1" (testuser), not "admin1" + service := newSubsonicAPIService("test-plugin", router, dataStore, []string{"user1"}, false) + + ctx := GinkgoT().Context() + _, err := service.Call(ctx, "/ping?u=adminuser") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("not authorized")) + }) + + It("allows admin users when in allowed list", func() { + // allowedUserIDs contains "admin1" + service := newSubsonicAPIService("test-plugin", router, dataStore, []string{"admin1"}, false) + + ctx := GinkgoT().Context() + response, err := service.Call(ctx, "/ping?u=adminuser") + Expect(err).ToNot(HaveOccurred()) + Expect(response).To(ContainSubstring("ok")) + }) + }) + + Context("with allUsers=true", func() { + It("allows all users regardless of allowed list", func() { + service := newSubsonicAPIService("test-plugin", router, dataStore, nil, true) + + ctx := GinkgoT().Context() + response, err := service.Call(ctx, "/ping?u=testuser") + Expect(err).ToNot(HaveOccurred()) + Expect(response).To(ContainSubstring("ok")) + }) + + It("allows admin users when allUsers is true", func() { + service := newSubsonicAPIService("test-plugin", router, dataStore, nil, true) + + ctx := GinkgoT().Context() + response, err := service.Call(ctx, "/ping?u=adminuser") + Expect(err).ToNot(HaveOccurred()) + Expect(response).To(ContainSubstring("ok")) + }) + }) + + Context("with no users configured", func() { + It("returns error when no users are configured", func() { + service := newSubsonicAPIService("test-plugin", router, dataStore, nil, false) + + ctx := GinkgoT().Context() + _, err := service.Call(ctx, "/ping?u=testuser") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("no users configured")) + }) + + It("returns error for empty user list", func() { + service := newSubsonicAPIService("test-plugin", router, dataStore, []string{}, false) + + ctx := GinkgoT().Context() + _, err := service.Call(ctx, "/ping?u=testuser") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("no users configured")) + }) + }) + }) + + Describe("URL Handling", func() { + It("returns error for missing username parameter", func() { + service := newSubsonicAPIService("test-plugin", router, dataStore, nil, true) + + ctx := GinkgoT().Context() + _, err := service.Call(ctx, "/ping") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("missing required parameter")) + }) + + It("returns error for invalid URL", func() { + service := newSubsonicAPIService("test-plugin", router, dataStore, nil, true) + + ctx := GinkgoT().Context() + _, err := service.Call(ctx, "://invalid") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("invalid URL")) + }) + + It("extracts endpoint from path correctly", func() { + service := newSubsonicAPIService("test-plugin", router, dataStore, []string{"user1"}, false) + + ctx := GinkgoT().Context() + _, err := service.Call(ctx, "/rest/ping.view?u=testuser") + Expect(err).ToNot(HaveOccurred()) + + // The endpoint should be extracted as "ping.view" + Expect(router.lastRequest.URL.Path).To(Equal("/ping.view")) + }) + }) + + Describe("CallRaw", func() { + It("returns binary data and content-type", func() { + service := newSubsonicAPIService("test-plugin", router, dataStore, nil, true) + + ctx := GinkgoT().Context() + contentType, data, err := service.CallRaw(ctx, "/getCoverArt?u=testuser&id=al-1") + Expect(err).ToNot(HaveOccurred()) + Expect(contentType).To(Equal("image/png")) + Expect(data).To(Equal(fakePNGHeader)) + }) + + It("does not set f=json parameter", func() { + service := newSubsonicAPIService("test-plugin", router, dataStore, nil, true) + + ctx := GinkgoT().Context() + _, _, err := service.CallRaw(ctx, "/getCoverArt?u=testuser&id=al-1") + Expect(err).ToNot(HaveOccurred()) + + Expect(router.lastRequest).ToNot(BeNil()) + query := router.lastRequest.URL.Query() + Expect(query.Get("f")).To(BeEmpty()) + }) + + It("enforces permission checks", func() { + service := newSubsonicAPIService("test-plugin", router, dataStore, []string{"user2"}, false) + + ctx := GinkgoT().Context() + _, _, err := service.CallRaw(ctx, "/getCoverArt?u=testuser&id=al-1") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("not authorized")) + }) + + It("returns error when username is missing", func() { + service := newSubsonicAPIService("test-plugin", router, dataStore, nil, true) + + ctx := GinkgoT().Context() + _, _, err := service.CallRaw(ctx, "/getCoverArt") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("missing required parameter")) + }) + + It("returns error when router is nil", func() { + service := newSubsonicAPIService("test-plugin", nil, dataStore, nil, true) + + ctx := GinkgoT().Context() + _, _, err := service.CallRaw(ctx, "/getCoverArt?u=testuser") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("router not available")) + }) + + It("returns error for invalid URL", func() { + service := newSubsonicAPIService("test-plugin", router, dataStore, nil, true) + + ctx := GinkgoT().Context() + _, _, err := service.CallRaw(ctx, "://invalid") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("invalid URL")) + }) + }) + + Describe("Router Availability", func() { + It("returns error when router is nil", func() { + service := newSubsonicAPIService("test-plugin", nil, dataStore, nil, true) + + ctx := GinkgoT().Context() + _, err := service.Call(ctx, "/ping?u=testuser") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("router not available")) + }) + }) +}) + +// fakePNGHeader is a minimal PNG file header used in tests. +var fakePNGHeader = []byte{0x89, 0x50, 0x4E, 0x47, 0x0D, 0x0A, 0x1A, 0x0A} + +// fakeSubsonicRouter is a mock Subsonic router that returns predictable responses. +type fakeSubsonicRouter struct { + lastRequest *http.Request +} + +func (r *fakeSubsonicRouter) ServeHTTP(w http.ResponseWriter, req *http.Request) { + r.lastRequest = req + + endpoint := path.Base(req.URL.Path) + switch endpoint { + case "getCoverArt": + w.Header().Set("Content-Type", "image/png") + _, _ = w.Write(fakePNGHeader) + default: + // Return a successful ping response + response := map[string]any{ + "subsonic-response": map[string]any{ + "status": "ok", + "version": "1.16.1", + }, + } + w.Header().Set("Content-Type", "application/json") + _ = json.NewEncoder(w).Encode(response) + } +} diff --git a/plugins/host_taskqueue.go b/plugins/host_taskqueue.go new file mode 100644 index 000000000..9f2ed85f6 --- /dev/null +++ b/plugins/host_taskqueue.go @@ -0,0 +1,595 @@ +package plugins + +import ( + "context" + "database/sql" + "errors" + "fmt" + "io" + "os" + "path/filepath" + "sync" + "time" + + _ "github.com/mattn/go-sqlite3" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model/id" + "github.com/navidrome/navidrome/plugins/capabilities" + "github.com/navidrome/navidrome/plugins/host" + "golang.org/x/time/rate" +) + +const ( + defaultConcurrency int32 = 1 + defaultBackoffMs int64 = 1000 + defaultRetentionMs int64 = 3_600_000 // 1 hour + minRetentionMs int64 = 60_000 // 1 minute + maxRetentionMs int64 = 604_800_000 // 1 week + maxQueueNameLength = 128 + maxPayloadSize = 1 * 1024 * 1024 // 1MB + maxBackoffMs int64 = 3_600_000 // 1 hour + taskCleanupInterval = 5 * time.Minute + pollInterval = 5 * time.Second + shutdownTimeout = 10 * time.Second + + taskStatusPending = "pending" + taskStatusRunning = "running" + taskStatusCompleted = "completed" + taskStatusFailed = "failed" + taskStatusCancelled = "cancelled" +) + +// CapabilityTaskWorker indicates the plugin can receive task execution callbacks. +const CapabilityTaskWorker Capability = "TaskWorker" + +const FuncTaskWorkerCallback = "nd_task_execute" + +func init() { + registerCapability(CapabilityTaskWorker, FuncTaskWorkerCallback) +} + +type queueState struct { + config host.QueueConfig + signal chan struct{} + limiter *rate.Limiter +} + +// notifyWorkers sends a non-blocking signal to wake up queue workers. +func (qs *queueState) notifyWorkers() { + select { + case qs.signal <- struct{}{}: + default: + } +} + +// taskQueueServiceImpl implements host.TaskQueueService with SQLite persistence +// and background worker goroutines for task execution. +type taskQueueServiceImpl struct { + pluginName string + manager *Manager + maxConcurrency int32 + db *sql.DB + ctx context.Context + cancel context.CancelFunc + wg sync.WaitGroup + mu sync.Mutex + queues map[string]*queueState + + // For testing: override how callbacks are invoked + invokeCallbackFn func(ctx context.Context, queueName, taskID string, payload []byte, attempt int32) (string, error) +} + +// newTaskQueueService creates a new taskQueueServiceImpl with its own SQLite database. +func newTaskQueueService(pluginName string, manager *Manager, maxConcurrency int32) (*taskQueueServiceImpl, error) { + dataDir := filepath.Join(conf.Server.DataFolder, "plugins", pluginName) + if err := os.MkdirAll(dataDir, 0700); err != nil { + return nil, fmt.Errorf("creating plugin data directory: %w", err) + } + + dbPath := filepath.Join(dataDir, "taskqueue.db") + db, err := sql.Open("sqlite3", dbPath+"?_busy_timeout=5000&_journal_mode=WAL&_foreign_keys=off") + if err != nil { + return nil, fmt.Errorf("opening taskqueue database: %w", err) + } + + db.SetMaxOpenConns(3) + db.SetMaxIdleConns(1) + + if err := createTaskQueueSchema(db); err != nil { + db.Close() + return nil, fmt.Errorf("creating taskqueue schema: %w", err) + } + + ctx, cancel := context.WithCancel(manager.ctx) //nolint:gosec // cancel is stored in struct and called in Close() + + s := &taskQueueServiceImpl{ + pluginName: pluginName, + manager: manager, + maxConcurrency: maxConcurrency, + db: db, + ctx: ctx, + cancel: cancel, + queues: make(map[string]*queueState), + } + s.invokeCallbackFn = s.defaultInvokeCallback + + s.wg.Go(s.cleanupLoop) + + log.Debug("Initialized plugin taskqueue", "plugin", pluginName, "path", dbPath, "maxConcurrency", maxConcurrency) + return s, nil +} + +// createTaskQueueSchema applies schema migrations to the taskqueue database. +// New migrations must be appended at the end of the slice. +func createTaskQueueSchema(db *sql.DB) error { + return migrateDB(db, []string{ + `CREATE TABLE IF NOT EXISTS queues ( + name TEXT PRIMARY KEY, + concurrency INTEGER NOT NULL DEFAULT 1, + max_retries INTEGER NOT NULL DEFAULT 0, + backoff_ms INTEGER NOT NULL DEFAULT 1000, + delay_ms INTEGER NOT NULL DEFAULT 0, + retention_ms INTEGER NOT NULL DEFAULT 3600000 + )`, + `CREATE TABLE IF NOT EXISTS tasks ( + id TEXT PRIMARY KEY, + queue_name TEXT NOT NULL REFERENCES queues(name), + payload BLOB NOT NULL, + status TEXT NOT NULL DEFAULT 'pending', + attempt INTEGER NOT NULL DEFAULT 0, + max_retries INTEGER NOT NULL, + next_run_at INTEGER NOT NULL, + created_at INTEGER NOT NULL, + updated_at INTEGER NOT NULL, + message TEXT NOT NULL DEFAULT '' + )`, + `CREATE INDEX IF NOT EXISTS idx_tasks_dequeue ON tasks(queue_name, status, next_run_at)`, + }) +} + +// applyConfigDefaults fills zero-value config fields with sensible defaults +// and clamps values to valid ranges, logging warnings for clamped values. +func (s *taskQueueServiceImpl) applyConfigDefaults(ctx context.Context, name string, config *host.QueueConfig) { + if config.Concurrency <= 0 { + config.Concurrency = defaultConcurrency + } + if config.BackoffMs <= 0 { + config.BackoffMs = defaultBackoffMs + } + if config.RetentionMs <= 0 { + config.RetentionMs = defaultRetentionMs + } + + if config.RetentionMs < minRetentionMs { + log.Warn(ctx, "TaskQueue retention clamped to minimum", "plugin", s.pluginName, "queue", name, + "requested", config.RetentionMs, "min", minRetentionMs) + config.RetentionMs = minRetentionMs + } + if config.RetentionMs > maxRetentionMs { + log.Warn(ctx, "TaskQueue retention clamped to maximum", "plugin", s.pluginName, "queue", name, + "requested", config.RetentionMs, "max", maxRetentionMs) + config.RetentionMs = maxRetentionMs + } +} + +// clampConcurrency reduces config.Concurrency if it exceeds the remaining budget. +// Returns an error when the concurrency budget is fully exhausted. +// Must be called with s.mu held. +func (s *taskQueueServiceImpl) clampConcurrency(ctx context.Context, name string, config *host.QueueConfig) error { + var allocated int32 + for _, qs := range s.queues { + allocated += qs.config.Concurrency + } + available := s.maxConcurrency - allocated + if available <= 0 { + log.Warn(ctx, "TaskQueue concurrency budget exhausted", "plugin", s.pluginName, "queue", name, + "allocated", allocated, "maxConcurrency", s.maxConcurrency) + return fmt.Errorf("concurrency budget exhausted (%d/%d allocated)", allocated, s.maxConcurrency) + } + if config.Concurrency > available { + log.Warn(ctx, "TaskQueue concurrency clamped", "plugin", s.pluginName, "queue", name, + "requested", config.Concurrency, "available", available, "maxConcurrency", s.maxConcurrency) + config.Concurrency = available + } + return nil +} + +func (s *taskQueueServiceImpl) CreateQueue(ctx context.Context, name string, config host.QueueConfig) error { + if len(name) == 0 { + return fmt.Errorf("queue name cannot be empty") + } + if len(name) > maxQueueNameLength { + return fmt.Errorf("queue name exceeds maximum length of %d bytes", maxQueueNameLength) + } + + s.applyConfigDefaults(ctx, name, &config) + + s.mu.Lock() + defer s.mu.Unlock() + + if err := s.clampConcurrency(ctx, name, &config); err != nil { + return err + } + + if _, exists := s.queues[name]; exists { + return fmt.Errorf("queue %q already exists", name) + } + + // Upsert into queues table (idempotent across restarts) + _, err := s.db.ExecContext(ctx, ` + INSERT INTO queues (name, concurrency, max_retries, backoff_ms, delay_ms, retention_ms) + VALUES (?, ?, ?, ?, ?, ?) + ON CONFLICT(name) DO UPDATE SET + concurrency = excluded.concurrency, + max_retries = excluded.max_retries, + backoff_ms = excluded.backoff_ms, + delay_ms = excluded.delay_ms, + retention_ms = excluded.retention_ms + `, name, config.Concurrency, config.MaxRetries, config.BackoffMs, config.DelayMs, config.RetentionMs) + if err != nil { + return fmt.Errorf("creating queue: %w", err) + } + + // Reset stale running tasks from previous crash + now := time.Now().UnixMilli() + _, err = s.db.ExecContext(ctx, ` + UPDATE tasks SET status = ?, updated_at = ? WHERE queue_name = ? AND status = ? + `, taskStatusPending, now, name, taskStatusRunning) + if err != nil { + return fmt.Errorf("resetting stale tasks: %w", err) + } + + qs := &queueState{ + config: config, + signal: make(chan struct{}, 1), + } + if config.DelayMs > 0 { + // Rate limit dispatches to enforce delay between tasks. + // Burst of 1 allows one immediate dispatch, then enforces the delay interval. + qs.limiter = rate.NewLimiter(rate.Every(time.Duration(config.DelayMs)*time.Millisecond), 1) + } + s.queues[name] = qs + + for i := int32(0); i < config.Concurrency; i++ { + s.wg.Go(func() { s.worker(name, qs) }) + } + + log.Debug(ctx, "Created task queue", "plugin", s.pluginName, "queue", name, + "concurrency", config.Concurrency, "maxRetries", config.MaxRetries, + "backoffMs", config.BackoffMs, "delayMs", config.DelayMs, "retentionMs", config.RetentionMs) + return nil +} + +func (s *taskQueueServiceImpl) Enqueue(ctx context.Context, queueName string, payload []byte) (string, error) { + s.mu.Lock() + qs, exists := s.queues[queueName] + s.mu.Unlock() + + if !exists { + return "", fmt.Errorf("queue %q does not exist", queueName) + } + if len(payload) > maxPayloadSize { + return "", fmt.Errorf("payload size %d exceeds maximum of %d bytes", len(payload), maxPayloadSize) + } + + taskID := id.NewRandom() + now := time.Now().UnixMilli() + + _, err := s.db.ExecContext(ctx, ` + INSERT INTO tasks (id, queue_name, payload, status, attempt, max_retries, next_run_at, created_at, updated_at) + VALUES (?, ?, ?, ?, 0, ?, ?, ?, ?) + `, taskID, queueName, payload, taskStatusPending, qs.config.MaxRetries, now, now, now) + if err != nil { + return "", fmt.Errorf("enqueuing task: %w", err) + } + + qs.notifyWorkers() + log.Trace(ctx, "Enqueued task", "plugin", s.pluginName, "queue", queueName, "taskID", taskID) + return taskID, nil +} + +// Get returns the current state of a task. +func (s *taskQueueServiceImpl) Get(ctx context.Context, taskID string) (*host.TaskInfo, error) { + var info host.TaskInfo + err := s.db.QueryRowContext(ctx, `SELECT status, message, attempt FROM tasks WHERE id = ?`, taskID). + Scan(&info.Status, &info.Message, &info.Attempt) + if errors.Is(err, sql.ErrNoRows) { + return nil, fmt.Errorf("task %q not found", taskID) + } + if err != nil { + return nil, fmt.Errorf("getting task info: %w", err) + } + return &info, nil +} + +// Cancel cancels a pending task. +func (s *taskQueueServiceImpl) Cancel(ctx context.Context, taskID string) error { + now := time.Now().UnixMilli() + result, err := s.db.ExecContext(ctx, ` + UPDATE tasks SET status = ?, updated_at = ? WHERE id = ? AND status = ? + `, taskStatusCancelled, now, taskID, taskStatusPending) + if err != nil { + return fmt.Errorf("cancelling task: %w", err) + } + + rowsAffected, err := result.RowsAffected() + if err != nil { + return fmt.Errorf("checking cancel result: %w", err) + } + + if rowsAffected == 0 { + // Check if task exists at all + var status string + err := s.db.QueryRowContext(ctx, `SELECT status FROM tasks WHERE id = ?`, taskID).Scan(&status) + if errors.Is(err, sql.ErrNoRows) { + return fmt.Errorf("task %q not found", taskID) + } + if err != nil { + return fmt.Errorf("checking task existence: %w", err) + } + return fmt.Errorf("task %q cannot be cancelled (status: %s)", taskID, status) + } + + log.Trace(ctx, "Cancelled task", "plugin", s.pluginName, "taskID", taskID) + return nil +} + +// ClearQueue removes all pending tasks from the named queue. +// Running tasks are not affected. Returns the number of tasks removed. +func (s *taskQueueServiceImpl) ClearQueue(ctx context.Context, queueName string) (int64, error) { + s.mu.Lock() + _, exists := s.queues[queueName] + s.mu.Unlock() + + if !exists { + return 0, fmt.Errorf("queue %q does not exist", queueName) + } + + now := time.Now().UnixMilli() + result, err := s.db.ExecContext(ctx, ` + UPDATE tasks SET status = ?, updated_at = ? WHERE queue_name = ? AND status = ? + `, taskStatusCancelled, now, queueName, taskStatusPending) + if err != nil { + return 0, fmt.Errorf("clearing queue: %w", err) + } + + cleared, err := result.RowsAffected() + if err != nil { + return 0, fmt.Errorf("checking clear result: %w", err) + } + + if cleared > 0 { + log.Debug(ctx, "Cleared pending tasks from queue", "plugin", s.pluginName, "queue", queueName, "cleared", cleared) + } + return cleared, nil +} + +// worker is the main loop for a single worker goroutine. +func (s *taskQueueServiceImpl) worker(queueName string, qs *queueState) { + // Process any existing pending tasks immediately on startup + s.drainQueue(queueName, qs) + + ticker := time.NewTicker(pollInterval) + defer ticker.Stop() + + for { + select { + case <-s.ctx.Done(): + return + case <-qs.signal: + s.drainQueue(queueName, qs) + case <-ticker.C: + s.drainQueue(queueName, qs) + } + } +} + +func (s *taskQueueServiceImpl) drainQueue(queueName string, qs *queueState) { + for s.ctx.Err() == nil && s.processTask(queueName, qs) { + } +} + +// processTask dequeues and processes a single task. Returns true if a task was processed. +func (s *taskQueueServiceImpl) processTask(queueName string, qs *queueState) bool { + now := time.Now().UnixMilli() + + // Atomically dequeue a task + var taskID string + var payload []byte + var attempt, maxRetries int32 + err := s.db.QueryRowContext(s.ctx, ` + UPDATE tasks SET status = ?, attempt = attempt + 1, updated_at = ? + WHERE id = ( + SELECT id FROM tasks + WHERE queue_name = ? AND status = ? AND next_run_at <= ? + ORDER BY next_run_at, created_at LIMIT 1 + ) + RETURNING id, payload, attempt, max_retries + `, taskStatusRunning, now, queueName, taskStatusPending, now).Scan(&taskID, &payload, &attempt, &maxRetries) + if errors.Is(err, sql.ErrNoRows) { + return false + } + if err != nil { + log.Error(s.ctx, "Failed to dequeue task", "plugin", s.pluginName, "queue", queueName, err) + return false + } + + // Enforce delay between task dispatches using a rate limiter. + // This is done after dequeue so that empty polls don't consume rate tokens. + if qs.limiter != nil { + if err := qs.limiter.Wait(s.ctx); err != nil { + // Context cancelled during wait — revert task to pending for recovery + s.revertTaskToPending(taskID) + return false + } + } + + // Invoke callback + log.Debug(s.ctx, "Executing task", "plugin", s.pluginName, "queue", queueName, "taskID", taskID, "attempt", attempt) + message, callbackErr := s.invokeCallbackFn(s.ctx, queueName, taskID, payload, attempt) + + // If context was cancelled (shutdown), revert task to pending for recovery + if s.ctx.Err() != nil { + s.revertTaskToPending(taskID) + return false + } + + if callbackErr == nil { + s.completeTask(queueName, taskID, message) + } else { + s.handleTaskFailure(queueName, taskID, attempt, maxRetries, qs, callbackErr, message) + } + return true +} + +func (s *taskQueueServiceImpl) completeTask(queueName, taskID, message string) { + now := time.Now().UnixMilli() + if _, err := s.db.ExecContext(s.ctx, `UPDATE tasks SET status = ?, message = ?, updated_at = ? WHERE id = ?`, taskStatusCompleted, message, now, taskID); err != nil { + log.Error(s.ctx, "Failed to mark task as completed", "plugin", s.pluginName, "taskID", taskID, err) + } + log.Debug(s.ctx, "Task completed", "plugin", s.pluginName, "queue", queueName, "taskID", taskID) +} + +func (s *taskQueueServiceImpl) handleTaskFailure(queueName, taskID string, attempt, maxRetries int32, qs *queueState, callbackErr error, message string) { + log.Warn(s.ctx, "Task execution failed", "plugin", s.pluginName, "queue", queueName, + "taskID", taskID, "attempt", attempt, "maxRetries", maxRetries, "err", callbackErr) + + // Use error message as fallback if no message was provided + if message == "" { + message = callbackErr.Error() + } + + now := time.Now().UnixMilli() + if attempt > maxRetries { + if _, err := s.db.ExecContext(s.ctx, `UPDATE tasks SET status = ?, message = ?, updated_at = ? WHERE id = ?`, taskStatusFailed, message, now, taskID); err != nil { + log.Error(s.ctx, "Failed to mark task as failed", "plugin", s.pluginName, "taskID", taskID, err) + } + log.Warn(s.ctx, "Task failed after all retries", "plugin", s.pluginName, "queue", queueName, "taskID", taskID) + return + } + + // Exponential backoff: backoffMs * 2^(attempt-1) + backoff := qs.config.BackoffMs << (attempt - 1) + if backoff <= 0 || backoff > maxBackoffMs { + backoff = maxBackoffMs + } + nextRunAt := now + backoff + if _, err := s.db.ExecContext(s.ctx, ` + UPDATE tasks SET status = ?, next_run_at = ?, updated_at = ? WHERE id = ? + `, taskStatusPending, nextRunAt, now, taskID); err != nil { + log.Error(s.ctx, "Failed to reschedule task for retry", "plugin", s.pluginName, "taskID", taskID, err) + } + + // Wake worker after backoff expires + time.AfterFunc(time.Duration(backoff)*time.Millisecond, func() { + qs.notifyWorkers() + }) +} + +// revertTaskToPending puts a running task back to pending status and decrements the attempt +// counter (used during shutdown to ensure the interrupted attempt doesn't count). +func (s *taskQueueServiceImpl) revertTaskToPending(taskID string) { + now := time.Now().UnixMilli() + _, err := s.db.Exec(`UPDATE tasks SET status = ?, attempt = MAX(attempt - 1, 0), updated_at = ? WHERE id = ? AND status = ?`, taskStatusPending, now, taskID, taskStatusRunning) + if err != nil { + log.Error("Failed to revert task to pending", "plugin", s.pluginName, "taskID", taskID, err) + } +} + +// defaultInvokeCallback calls the plugin's nd_task_execute function. +func (s *taskQueueServiceImpl) defaultInvokeCallback(ctx context.Context, queueName, taskID string, payload []byte, attempt int32) (string, error) { + s.manager.mu.RLock() + p, ok := s.manager.plugins[s.pluginName] + s.manager.mu.RUnlock() + + if !ok { + return "", fmt.Errorf("plugin %s not loaded", s.pluginName) + } + + input := capabilities.TaskExecuteRequest{ + QueueName: queueName, + TaskID: taskID, + Payload: payload, + Attempt: attempt, + } + + message, err := callPluginFunction[capabilities.TaskExecuteRequest, string](ctx, p, FuncTaskWorkerCallback, input) + if err != nil { + return "", err + } + return message, nil +} + +// cleanupLoop periodically removes terminal tasks past their retention period. +func (s *taskQueueServiceImpl) cleanupLoop() { + ticker := time.NewTicker(taskCleanupInterval) + defer ticker.Stop() + + for { + select { + case <-s.ctx.Done(): + return + case <-ticker.C: + s.runCleanup() + } + } +} + +// runCleanup deletes terminal tasks past their retention period. +func (s *taskQueueServiceImpl) runCleanup() { + s.mu.Lock() + queues := make(map[string]*queueState, len(s.queues)) + for k, v := range s.queues { + queues[k] = v + } + s.mu.Unlock() + + now := time.Now().UnixMilli() + for name, qs := range queues { + result, err := s.db.ExecContext(s.ctx, ` + DELETE FROM tasks WHERE queue_name = ? AND status IN (?, ?, ?) AND updated_at + ? < ? + `, name, taskStatusCompleted, taskStatusFailed, taskStatusCancelled, qs.config.RetentionMs, now) + if err != nil { + log.Error(s.ctx, "Failed to cleanup tasks", "plugin", s.pluginName, "queue", name, err) + continue + } + if deleted, _ := result.RowsAffected(); deleted > 0 { + log.Debug(s.ctx, "Cleaned up terminal tasks", "plugin", s.pluginName, "queue", name, "deleted", deleted) + } + } +} + +// Close shuts down the task queue service, stopping all workers and closing the database. +func (s *taskQueueServiceImpl) Close() error { + // Cancel context to signal all goroutines + s.cancel() + + // Wait for goroutines with timeout + done := make(chan struct{}) + go func() { + s.wg.Wait() + close(done) + }() + + select { + case <-done: + case <-time.After(shutdownTimeout): + log.Warn("TaskQueue shutdown timed out", "plugin", s.pluginName) + } + + // Mark running tasks as pending for recovery on next startup + if s.db != nil { + now := time.Now().UnixMilli() + if _, err := s.db.Exec(`UPDATE tasks SET status = ?, updated_at = ? WHERE status = ?`, taskStatusPending, now, taskStatusRunning); err != nil { + log.Error("Failed to reset running tasks on shutdown", "plugin", s.pluginName, err) + } + log.Debug("Closing plugin taskqueue", "plugin", s.pluginName) + return s.db.Close() + } + return nil +} + +// Compile-time verification +var _ host.TaskService = (*taskQueueServiceImpl)(nil) +var _ io.Closer = (*taskQueueServiceImpl)(nil) diff --git a/plugins/host_taskqueue_test.go b/plugins/host_taskqueue_test.go new file mode 100644 index 000000000..c3ab8d119 --- /dev/null +++ b/plugins/host_taskqueue_test.go @@ -0,0 +1,1221 @@ +//go:build !windows + +package plugins + +import ( + "context" + "crypto/sha256" + "encoding/hex" + "encoding/json" + "errors" + "fmt" + "net/http" + "os" + "path/filepath" + "sort" + "strings" + "sync" + "sync/atomic" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/plugins/host" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("TaskQueueService", func() { + var tmpDir string + var service *taskQueueServiceImpl + var ctx context.Context + var manager *Manager + + BeforeEach(func() { + ctx = GinkgoT().Context() + var err error + tmpDir, err = os.MkdirTemp("", "taskqueue-test-*") + Expect(err).ToNot(HaveOccurred()) + + DeferCleanup(configtest.SetupConfig()) + conf.Server.DataFolder = tmpDir + + // Create a mock manager with context + managerCtx, cancel := context.WithCancel(ctx) + manager = &Manager{ + plugins: make(map[string]*plugin), + ctx: managerCtx, + } + DeferCleanup(cancel) + + service, err = newTaskQueueService("test_plugin", manager, 5) + Expect(err).ToNot(HaveOccurred()) + }) + + AfterEach(func() { + if service != nil { + service.Close() + } + os.RemoveAll(tmpDir) + }) + + Describe("CreateQueue", func() { + It("creates a queue successfully", func() { + err := service.CreateQueue(ctx, "my-queue", host.QueueConfig{ + Concurrency: 2, + MaxRetries: 3, + BackoffMs: 2000, + RetentionMs: 7200000, + }) + Expect(err).ToNot(HaveOccurred()) + + service.mu.Lock() + qs, exists := service.queues["my-queue"] + service.mu.Unlock() + Expect(exists).To(BeTrue()) + Expect(qs.config.Concurrency).To(Equal(int32(2))) + Expect(qs.config.MaxRetries).To(Equal(int32(3))) + Expect(qs.config.BackoffMs).To(Equal(int64(2000))) + Expect(qs.config.RetentionMs).To(Equal(int64(7200000))) + }) + + It("returns error for duplicate queue name", func() { + err := service.CreateQueue(ctx, "dup-queue", host.QueueConfig{}) + Expect(err).ToNot(HaveOccurred()) + + err = service.CreateQueue(ctx, "dup-queue", host.QueueConfig{}) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("already exists")) + }) + }) + + Describe("CreateQueue name validation", func() { + It("rejects empty queue name", func() { + err := service.CreateQueue(ctx, "", host.QueueConfig{}) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("queue name cannot be empty")) + }) + + It("rejects over-length queue name", func() { + longName := strings.Repeat("a", maxQueueNameLength+1) + err := service.CreateQueue(ctx, longName, host.QueueConfig{}) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("exceeds maximum length")) + }) + + It("accepts queue name at maximum length", func() { + service.invokeCallbackFn = func(_ context.Context, _, _ string, _ []byte, _ int32) (string, error) { + return "", nil + } + exactName := strings.Repeat("a", maxQueueNameLength) + err := service.CreateQueue(ctx, exactName, host.QueueConfig{}) + Expect(err).ToNot(HaveOccurred()) + }) + }) + + Describe("CreateQueue defaults", func() { + It("applies defaults for zero-value config", func() { + err := service.CreateQueue(ctx, "defaults-queue", host.QueueConfig{}) + Expect(err).ToNot(HaveOccurred()) + + service.mu.Lock() + qs := service.queues["defaults-queue"] + service.mu.Unlock() + Expect(qs.config.Concurrency).To(Equal(defaultConcurrency)) + Expect(qs.config.BackoffMs).To(Equal(defaultBackoffMs)) + Expect(qs.config.RetentionMs).To(Equal(defaultRetentionMs)) + }) + }) + + Describe("CreateQueue defaults with negative values", func() { + It("applies default RetentionMs for negative value", func() { + service.invokeCallbackFn = func(_ context.Context, _, _ string, _ []byte, _ int32) (string, error) { + return "", nil + } + err := service.CreateQueue(ctx, "neg-retention", host.QueueConfig{ + RetentionMs: -500, + }) + Expect(err).ToNot(HaveOccurred()) + + service.mu.Lock() + qs := service.queues["neg-retention"] + service.mu.Unlock() + Expect(qs.config.RetentionMs).To(Equal(defaultRetentionMs)) + }) + }) + + Describe("CreateQueue clamping", func() { + It("clamps concurrency exceeding maxConcurrency", func() { + // maxConcurrency is 5; request 10 + err := service.CreateQueue(ctx, "clamped-queue", host.QueueConfig{ + Concurrency: 10, + }) + Expect(err).ToNot(HaveOccurred()) + + service.mu.Lock() + qs := service.queues["clamped-queue"] + service.mu.Unlock() + Expect(qs.config.Concurrency).To(Equal(int32(5))) + }) + + It("returns error when concurrency budget is exhausted", func() { + // maxConcurrency is 5; create a queue that uses all 5 + err := service.CreateQueue(ctx, "full-budget", host.QueueConfig{ + Concurrency: 5, + }) + Expect(err).ToNot(HaveOccurred()) + + // Next queue should fail — no budget remaining + err = service.CreateQueue(ctx, "over-budget", host.QueueConfig{ + Concurrency: 1, + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("concurrency budget exhausted")) + }) + + It("clamps retention below minimum", func() { + err := service.CreateQueue(ctx, "low-retention", host.QueueConfig{ + RetentionMs: 100, // below minRetentionMs + }) + Expect(err).ToNot(HaveOccurred()) + + service.mu.Lock() + qs := service.queues["low-retention"] + service.mu.Unlock() + Expect(qs.config.RetentionMs).To(Equal(minRetentionMs)) + }) + + It("clamps retention above maximum", func() { + err := service.CreateQueue(ctx, "high-retention", host.QueueConfig{ + RetentionMs: 999_999_999_999, // above maxRetentionMs + }) + Expect(err).ToNot(HaveOccurred()) + + service.mu.Lock() + qs := service.queues["high-retention"] + service.mu.Unlock() + Expect(qs.config.RetentionMs).To(Equal(maxRetentionMs)) + }) + }) + + Describe("Enqueue", func() { + BeforeEach(func() { + // Use a no-op callback to prevent actual execution attempts + service.invokeCallbackFn = func(_ context.Context, _, _ string, _ []byte, _ int32) (string, error) { + return "", nil + } + err := service.CreateQueue(ctx, "enqueue-test", host.QueueConfig{}) + Expect(err).ToNot(HaveOccurred()) + }) + + It("enqueues a task and returns task ID", func() { + taskID, err := service.Enqueue(ctx, "enqueue-test", []byte("payload")) + Expect(err).ToNot(HaveOccurred()) + Expect(taskID).ToNot(BeEmpty()) + }) + + It("returns error for non-existent queue", func() { + _, err := service.Enqueue(ctx, "no-such-queue", []byte("payload")) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("does not exist")) + }) + + It("rejects payload exceeding maximum size", func() { + bigPayload := make([]byte, maxPayloadSize+1) + _, err := service.Enqueue(ctx, "enqueue-test", bigPayload) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("exceeds maximum")) + }) + + It("accepts payload at maximum size", func() { + exactPayload := make([]byte, maxPayloadSize) + taskID, err := service.Enqueue(ctx, "enqueue-test", exactPayload) + Expect(err).ToNot(HaveOccurred()) + Expect(taskID).ToNot(BeEmpty()) + }) + }) + + Describe("GetTaskStatus", func() { + BeforeEach(func() { + // Use a callback that blocks until context is cancelled so tasks stay pending + service.invokeCallbackFn = func(ctx context.Context, _, _ string, _ []byte, _ int32) (string, error) { + <-ctx.Done() + return "", ctx.Err() + } + }) + + It("returns pending for a new task", func() { + err := service.CreateQueue(ctx, "status-test", host.QueueConfig{}) + Expect(err).ToNot(HaveOccurred()) + + taskID, err := service.Enqueue(ctx, "status-test", []byte("data")) + Expect(err).ToNot(HaveOccurred()) + + // The task may get picked up quickly; check initial status + // Since the callback blocks, it should be either pending or running + info, err := service.Get(ctx, taskID) + Expect(err).ToNot(HaveOccurred()) + Expect(info).ToNot(BeNil()) + Expect(info.Status).To(BeElementOf("pending", "running")) + }) + + It("returns error for unknown task ID", func() { + _, err := service.Get(ctx, "nonexistent-id") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("not found")) + }) + }) + + Describe("CancelTask", func() { + BeforeEach(func() { + // Block callback so tasks stay in pending/running + service.invokeCallbackFn = func(ctx context.Context, _, _ string, _ []byte, _ int32) (string, error) { + <-ctx.Done() + return "", ctx.Err() + } + }) + + It("cancels a pending task", func() { + // Block the callback so the first task occupies the worker + started := make(chan struct{}) + service.invokeCallbackFn = func(ctx context.Context, _, _ string, _ []byte, _ int32) (string, error) { + close(started) + <-ctx.Done() + return "", ctx.Err() + } + + err := service.CreateQueue(ctx, "cancel-test", host.QueueConfig{ + Concurrency: 1, + }) + Expect(err).ToNot(HaveOccurred()) + + // Enqueue a blocker task to occupy the single worker + _, err = service.Enqueue(ctx, "cancel-test", []byte("blocker")) + Expect(err).ToNot(HaveOccurred()) + + // Wait for the blocker task to start running + Eventually(started).WithTimeout(5 * time.Second).Should(BeClosed()) + + // Enqueue a second task — it stays pending since the worker is busy + taskID, err := service.Enqueue(ctx, "cancel-test", []byte("cancel-me")) + Expect(err).ToNot(HaveOccurred()) + + err = service.Cancel(ctx, taskID) + Expect(err).ToNot(HaveOccurred()) + + info, err := service.Get(ctx, taskID) + Expect(err).ToNot(HaveOccurred()) + Expect(info.Status).To(Equal("cancelled")) + }) + + It("returns error for unknown task ID", func() { + err := service.Cancel(ctx, "nonexistent-id") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("not found")) + }) + + It("returns error for non-pending task", func() { + // Create a queue where tasks complete immediately + service.invokeCallbackFn = func(_ context.Context, _, _ string, _ []byte, _ int32) (string, error) { + return "", nil + } + err := service.CreateQueue(ctx, "completed-test", host.QueueConfig{}) + Expect(err).ToNot(HaveOccurred()) + + taskID, err := service.Enqueue(ctx, "completed-test", []byte("data")) + Expect(err).ToNot(HaveOccurred()) + + // Wait for task to complete + Eventually(func() string { + info, err := service.Get(ctx, taskID) + if err != nil || info == nil { + return "" + } + return info.Status + }).WithTimeout(5 * time.Second).WithPolling(50 * time.Millisecond).Should(Equal("completed")) + + // Try to cancel completed task + err = service.Cancel(ctx, taskID) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("cannot be cancelled")) + }) + }) + + Describe("ClearQueue", func() { + It("clears all pending tasks from a queue", func() { + // Block the callback so the first task occupies the worker + started := make(chan struct{}) + service.invokeCallbackFn = func(ctx context.Context, _, _ string, _ []byte, _ int32) (string, error) { + close(started) + <-ctx.Done() + return "", ctx.Err() + } + + err := service.CreateQueue(ctx, "clear-test", host.QueueConfig{ + Concurrency: 1, + }) + Expect(err).ToNot(HaveOccurred()) + + // Enqueue a blocker task to occupy the single worker + _, err = service.Enqueue(ctx, "clear-test", []byte("blocker")) + Expect(err).ToNot(HaveOccurred()) + + // Wait for the blocker task to start running + Eventually(started).WithTimeout(5 * time.Second).Should(BeClosed()) + + // Enqueue several more tasks — they stay pending since the worker is busy + var pendingIDs []string + for i := 0; i < 3; i++ { + taskID, err := service.Enqueue(ctx, "clear-test", []byte(fmt.Sprintf("task-%d", i))) + Expect(err).ToNot(HaveOccurred()) + pendingIDs = append(pendingIDs, taskID) + } + + // Clear the queue + cleared, err := service.ClearQueue(ctx, "clear-test") + Expect(err).ToNot(HaveOccurred()) + Expect(cleared).To(Equal(int64(3))) + + // Verify all pending tasks are now cancelled + for _, id := range pendingIDs { + info, err := service.Get(ctx, id) + Expect(err).ToNot(HaveOccurred()) + Expect(info.Status).To(Equal("cancelled")) + } + }) + + It("returns zero when queue has no pending tasks", func() { + service.invokeCallbackFn = func(_ context.Context, _, _ string, _ []byte, _ int32) (string, error) { + return "", nil + } + err := service.CreateQueue(ctx, "empty-clear", host.QueueConfig{}) + Expect(err).ToNot(HaveOccurred()) + + cleared, err := service.ClearQueue(ctx, "empty-clear") + Expect(err).ToNot(HaveOccurred()) + Expect(cleared).To(Equal(int64(0))) + }) + + It("returns error for non-existent queue", func() { + _, err := service.ClearQueue(ctx, "no-such-queue") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("does not exist")) + }) + + It("does not affect running tasks", func() { + // Block the callback so tasks stay running + started := make(chan struct{}, 1) + service.invokeCallbackFn = func(ctx context.Context, _, _ string, _ []byte, _ int32) (string, error) { + select { + case started <- struct{}{}: + default: + } + <-ctx.Done() + return "", ctx.Err() + } + + err := service.CreateQueue(ctx, "clear-running", host.QueueConfig{ + Concurrency: 1, + }) + Expect(err).ToNot(HaveOccurred()) + + // Enqueue a task that will start running + runningID, err := service.Enqueue(ctx, "clear-running", []byte("running-task")) + Expect(err).ToNot(HaveOccurred()) + + // Wait for it to start running + Eventually(started).WithTimeout(5 * time.Second).Should(Receive()) + + // Clear the queue — should not affect the running task + cleared, err := service.ClearQueue(ctx, "clear-running") + Expect(err).ToNot(HaveOccurred()) + Expect(cleared).To(Equal(int64(0))) + + // Verify the running task is still running + info, err := service.Get(ctx, runningID) + Expect(err).ToNot(HaveOccurred()) + Expect(info.Status).To(Equal("running")) + }) + }) + + Describe("Worker execution", func() { + It("invokes callback and completes task", func() { + var callCount atomic.Int32 + var receivedQueueName, receivedTaskID string + var receivedPayload []byte + var receivedAttempt int32 + + service.invokeCallbackFn = func(_ context.Context, queueName, taskID string, payload []byte, attempt int32) (string, error) { + callCount.Add(1) + receivedQueueName = queueName + receivedTaskID = taskID + receivedPayload = payload + receivedAttempt = attempt + return "", nil + } + + err := service.CreateQueue(ctx, "worker-test", host.QueueConfig{}) + Expect(err).ToNot(HaveOccurred()) + + taskID, err := service.Enqueue(ctx, "worker-test", []byte("test-payload")) + Expect(err).ToNot(HaveOccurred()) + + Eventually(func() string { + info, err := service.Get(ctx, taskID) + if err != nil || info == nil { + return "" + } + return info.Status + }).WithTimeout(5 * time.Second).WithPolling(50 * time.Millisecond).Should(Equal("completed")) + + Expect(callCount.Load()).To(Equal(int32(1))) + Expect(receivedQueueName).To(Equal("worker-test")) + Expect(receivedTaskID).To(Equal(taskID)) + Expect(receivedPayload).To(Equal([]byte("test-payload"))) + Expect(receivedAttempt).To(Equal(int32(1))) + }) + }) + + Describe("Message storage", func() { + It("stores message on successful completion", func() { + service.invokeCallbackFn = func(_ context.Context, _, _ string, _ []byte, _ int32) (string, error) { + return "task completed successfully", nil + } + + err := service.CreateQueue(ctx, "msg-success", host.QueueConfig{}) + Expect(err).ToNot(HaveOccurred()) + + taskID, err := service.Enqueue(ctx, "msg-success", []byte("data")) + Expect(err).ToNot(HaveOccurred()) + + Eventually(func() string { + info, err := service.Get(ctx, taskID) + if err != nil || info == nil { + return "" + } + return info.Status + }).WithTimeout(5 * time.Second).WithPolling(50 * time.Millisecond).Should(Equal("completed")) + + info, err := service.Get(ctx, taskID) + Expect(err).ToNot(HaveOccurred()) + Expect(info.Message).To(Equal("task completed successfully")) + Expect(info.Attempt).To(Equal(int32(1))) + }) + + It("stores error message on failure", func() { + service.invokeCallbackFn = func(_ context.Context, _, _ string, _ []byte, _ int32) (string, error) { + return "", fmt.Errorf("something went wrong") + } + + err := service.CreateQueue(ctx, "msg-fail", host.QueueConfig{ + MaxRetries: 0, + }) + Expect(err).ToNot(HaveOccurred()) + + taskID, err := service.Enqueue(ctx, "msg-fail", []byte("data")) + Expect(err).ToNot(HaveOccurred()) + + Eventually(func() string { + info, err := service.Get(ctx, taskID) + if err != nil || info == nil { + return "" + } + return info.Status + }).WithTimeout(5 * time.Second).WithPolling(50 * time.Millisecond).Should(Equal("failed")) + + info, err := service.Get(ctx, taskID) + Expect(err).ToNot(HaveOccurred()) + Expect(info.Message).To(Equal("something went wrong")) + }) + + It("uses explicit message over error message on failure", func() { + service.invokeCallbackFn = func(_ context.Context, _, _ string, _ []byte, _ int32) (string, error) { + return "partial progress made", fmt.Errorf("timeout exceeded") + } + + err := service.CreateQueue(ctx, "msg-fail-with-msg", host.QueueConfig{ + MaxRetries: 0, + }) + Expect(err).ToNot(HaveOccurred()) + + taskID, err := service.Enqueue(ctx, "msg-fail-with-msg", []byte("data")) + Expect(err).ToNot(HaveOccurred()) + + Eventually(func() string { + info, err := service.Get(ctx, taskID) + if err != nil || info == nil { + return "" + } + return info.Status + }).WithTimeout(5 * time.Second).WithPolling(50 * time.Millisecond).Should(Equal("failed")) + + info, err := service.Get(ctx, taskID) + Expect(err).ToNot(HaveOccurred()) + Expect(info.Message).To(Equal("partial progress made")) + }) + }) + + Describe("Retry on failure", func() { + It("retries and eventually fails after exhausting retries", func() { + var callCount atomic.Int32 + + service.invokeCallbackFn = func(_ context.Context, _, _ string, _ []byte, _ int32) (string, error) { + callCount.Add(1) + return "", fmt.Errorf("task failed") + } + + err := service.CreateQueue(ctx, "retry-test", host.QueueConfig{ + MaxRetries: 2, + BackoffMs: 10, // Very short for testing + }) + Expect(err).ToNot(HaveOccurred()) + + taskID, err := service.Enqueue(ctx, "retry-test", []byte("retry-payload")) + Expect(err).ToNot(HaveOccurred()) + + Eventually(func() string { + info, err := service.Get(ctx, taskID) + if err != nil || info == nil { + return "" + } + return info.Status + }).WithTimeout(10 * time.Second).WithPolling(50 * time.Millisecond).Should(Equal("failed")) + + // 1 initial attempt + 2 retries = 3 total calls + Expect(callCount.Load()).To(Equal(int32(3))) + }) + }) + + Describe("Retry then succeed", func() { + It("retries and succeeds on second attempt", func() { + var callCount atomic.Int32 + + service.invokeCallbackFn = func(_ context.Context, _, _ string, _ []byte, attempt int32) (string, error) { + callCount.Add(1) + if attempt == 1 { + return "", fmt.Errorf("temporary error") + } + return "success", nil + } + + err := service.CreateQueue(ctx, "retry-succeed", host.QueueConfig{ + MaxRetries: 1, + BackoffMs: 10, // Very short for testing + }) + Expect(err).ToNot(HaveOccurred()) + + taskID, err := service.Enqueue(ctx, "retry-succeed", []byte("data")) + Expect(err).ToNot(HaveOccurred()) + + Eventually(func() string { + info, err := service.Get(ctx, taskID) + if err != nil || info == nil { + return "" + } + return info.Status + }).WithTimeout(10 * time.Second).WithPolling(50 * time.Millisecond).Should(Equal("completed")) + + Expect(callCount.Load()).To(Equal(int32(2))) + }) + }) + + Describe("Backoff overflow cap", func() { + It("caps backoff at maxRetentionMs to prevent overflow", func() { + var callCount atomic.Int32 + + service.invokeCallbackFn = func(_ context.Context, _, _ string, _ []byte, _ int32) (string, error) { + callCount.Add(1) + return "", fmt.Errorf("always fail") + } + + err := service.CreateQueue(ctx, "backoff-overflow", host.QueueConfig{ + MaxRetries: 3, + BackoffMs: 1_000_000_000, // Very large backoff to trigger overflow on exponentiation + }) + Expect(err).ToNot(HaveOccurred()) + + taskID, err := service.Enqueue(ctx, "backoff-overflow", []byte("overflow-test")) + Expect(err).ToNot(HaveOccurred()) + + // Wait for first attempt to fail + Eventually(func() int32 { + return callCount.Load() + }).WithTimeout(5 * time.Second).WithPolling(50 * time.Millisecond).Should(BeNumerically(">=", int32(1))) + + // Check next_run_at is positive and reasonable (capped at maxRetentionMs from now) + var nextRunAt int64 + err = service.db.QueryRow(`SELECT next_run_at FROM tasks WHERE id = ?`, taskID).Scan(&nextRunAt) + Expect(err).ToNot(HaveOccurred()) + + now := time.Now().UnixMilli() + Expect(nextRunAt).To(BeNumerically(">", int64(0)), "next_run_at should be positive") + Expect(nextRunAt).To(BeNumerically("<=", now+maxBackoffMs+1000), "next_run_at should be at most maxBackoffMs from now") + }) + }) + + Describe("Delay enforcement with concurrent workers", func() { + It("enforces delay between dispatches even with multiple workers", func() { + var mu sync.Mutex + var dispatchTimes []time.Time + + service.invokeCallbackFn = func(_ context.Context, _, _ string, _ []byte, _ int32) (string, error) { + mu.Lock() + dispatchTimes = append(dispatchTimes, time.Now()) + mu.Unlock() + return "", nil + } + + err := service.CreateQueue(ctx, "delay-concurrent", host.QueueConfig{ + Concurrency: 3, + DelayMs: 200, + }) + Expect(err).ToNot(HaveOccurred()) + + // Enqueue 5 tasks + for i := 0; i < 5; i++ { + _, err := service.Enqueue(ctx, "delay-concurrent", []byte(fmt.Sprintf("task-%d", i))) + Expect(err).ToNot(HaveOccurred()) + } + + // Wait for all tasks to complete + Eventually(func() int { + mu.Lock() + defer mu.Unlock() + return len(dispatchTimes) + }).WithTimeout(10 * time.Second).WithPolling(50 * time.Millisecond).Should(Equal(5)) + + // Sort dispatch times and verify gaps + mu.Lock() + sort.Slice(dispatchTimes, func(i, j int) bool { + return dispatchTimes[i].Before(dispatchTimes[j]) + }) + times := make([]time.Time, len(dispatchTimes)) + copy(times, dispatchTimes) + mu.Unlock() + + // Consecutive dispatches should have at least ~160ms gap (80% of 200ms) + for i := 1; i < len(times); i++ { + gap := times[i].Sub(times[i-1]) + Expect(gap).To(BeNumerically(">=", 160*time.Millisecond), + fmt.Sprintf("gap between dispatch %d and %d was %v, expected >= 160ms", i-1, i, gap)) + } + }) + }) + + Describe("Shutdown recovery", func() { + It("resets stale running tasks on CreateQueue", func() { + // Create a first service and queue, enqueue a task + service.invokeCallbackFn = func(ctx context.Context, _, _ string, _ []byte, _ int32) (string, error) { + <-ctx.Done() + return "", ctx.Err() + } + err := service.CreateQueue(ctx, "recovery-queue", host.QueueConfig{}) + Expect(err).ToNot(HaveOccurred()) + + taskID, err := service.Enqueue(ctx, "recovery-queue", []byte("stale-task")) + Expect(err).ToNot(HaveOccurred()) + + // Wait for the task to start running + Eventually(func() string { + info, err := service.Get(ctx, taskID) + if err != nil || info == nil { + return "" + } + return info.Status + }).WithTimeout(5 * time.Second).WithPolling(50 * time.Millisecond).Should(Equal("running")) + + // Close the service (simulates crash - tasks left in running state) + service.Close() + + // Create a new service pointing to the same DB + managerCtx2, cancel2 := context.WithCancel(ctx) + DeferCleanup(cancel2) + manager2 := &Manager{ + plugins: make(map[string]*plugin), + ctx: managerCtx2, + } + + service, err = newTaskQueueService("test_plugin", manager2, 5) + Expect(err).ToNot(HaveOccurred()) + + // Override callback to succeed + service.invokeCallbackFn = func(_ context.Context, _, _ string, _ []byte, _ int32) (string, error) { + return "", nil + } + + // Re-create the queue - the upsert handles the existing row from the old service + err = service.CreateQueue(ctx, "recovery-queue", host.QueueConfig{}) + Expect(err).ToNot(HaveOccurred()) + + // The stale running task should now be reset to pending and eventually completed + Eventually(func() string { + info, err := service.Get(ctx, taskID) + if err != nil || info == nil { + return "" + } + return info.Status + }).WithTimeout(10 * time.Second).WithPolling(50 * time.Millisecond).Should(Equal("completed")) + }) + }) + + Describe("Close", func() { + It("prevents subsequent operations after close", func() { + err := service.CreateQueue(ctx, "close-test", host.QueueConfig{}) + Expect(err).ToNot(HaveOccurred()) + + service.Close() + + // After close, operations should fail + _, err = service.Enqueue(ctx, "close-test", []byte("data")) + Expect(err).To(HaveOccurred()) + }) + }) + + Describe("Plugin isolation", func() { + It("uses separate databases for different plugins", func() { + managerCtx2, cancel2 := context.WithCancel(ctx) + DeferCleanup(cancel2) + manager2 := &Manager{ + plugins: make(map[string]*plugin), + ctx: managerCtx2, + } + + service2, err := newTaskQueueService("other_plugin", manager2, 5) + Expect(err).ToNot(HaveOccurred()) + defer service2.Close() + + // Check that separate database files exist + _, err = os.Stat(filepath.Join(tmpDir, "plugins", "test_plugin", "taskqueue.db")) + Expect(err).ToNot(HaveOccurred()) + _, err = os.Stat(filepath.Join(tmpDir, "plugins", "other_plugin", "taskqueue.db")) + Expect(err).ToNot(HaveOccurred()) + + // Both services should be able to create queues with the same name independently + service.invokeCallbackFn = func(_ context.Context, _, _ string, _ []byte, _ int32) (string, error) { return "", nil } + service2.invokeCallbackFn = func(_ context.Context, _, _ string, _ []byte, _ int32) (string, error) { return "", nil } + + err = service.CreateQueue(ctx, "shared-name", host.QueueConfig{}) + Expect(err).ToNot(HaveOccurred()) + err = service2.CreateQueue(ctx, "shared-name", host.QueueConfig{}) + Expect(err).ToNot(HaveOccurred()) + + // Enqueue to each and verify they work independently + taskID1, err := service.Enqueue(ctx, "shared-name", []byte("plugin1")) + Expect(err).ToNot(HaveOccurred()) + taskID2, err := service2.Enqueue(ctx, "shared-name", []byte("plugin2")) + Expect(err).ToNot(HaveOccurred()) + + Expect(taskID1).ToNot(Equal(taskID2)) + + // Both should complete + Eventually(func() string { + info, err := service.Get(ctx, taskID1) + if err != nil || info == nil { + return "" + } + return info.Status + }).WithTimeout(5 * time.Second).WithPolling(50 * time.Millisecond).Should(Equal("completed")) + + Eventually(func() string { + info, err := service2.Get(ctx, taskID2) + if err != nil || info == nil { + return "" + } + return info.Status + }).WithTimeout(5 * time.Second).WithPolling(50 * time.Millisecond).Should(Equal("completed")) + }) + }) +}) + +var _ = Describe("TaskQueueService Integration", Ordered, func() { + var manager *Manager + var tmpDir string + + BeforeAll(func() { + var err error + tmpDir, err = os.MkdirTemp("", "taskqueue-integration-test-*") + Expect(err).ToNot(HaveOccurred()) + + // Copy the test-taskqueue plugin + srcPath := filepath.Join(testdataDir, "test-taskqueue"+PackageExtension) + destPath := filepath.Join(tmpDir, "test-taskqueue"+PackageExtension) + data, err := os.ReadFile(srcPath) + Expect(err).ToNot(HaveOccurred()) + err = os.WriteFile(destPath, data, 0600) + Expect(err).ToNot(HaveOccurred()) + + // Compute SHA256 for the plugin + hash := sha256.Sum256(data) + hashHex := hex.EncodeToString(hash[:]) + + // Setup config + DeferCleanup(configtest.SetupConfig()) + conf.Server.Plugins.Enabled = true + conf.Server.Plugins.Folder = tmpDir + conf.Server.Plugins.AutoReload = false + conf.Server.CacheFolder = filepath.Join(tmpDir, "cache") + conf.Server.DataFolder = tmpDir + + // Setup mock DataStore with pre-enabled plugin + mockPluginRepo := tests.CreateMockPluginRepo() + mockPluginRepo.Permitted = true + mockPluginRepo.SetData(model.Plugins{{ + ID: "test-taskqueue", + Path: destPath, + SHA256: hashHex, + Enabled: true, + }}) + dataStore := &tests.MockDataStore{MockedPlugin: mockPluginRepo} + + // Create and start manager + manager = &Manager{ + plugins: make(map[string]*plugin), + ds: dataStore, + metrics: noopMetricsRecorder{}, + subsonicRouter: http.NotFoundHandler(), + } + err = manager.Start(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + + DeferCleanup(func() { + _ = manager.Stop() + _ = os.RemoveAll(tmpDir) + }) + }) + + // Helper types for calling the test plugin + type testQueueConfig struct { + Concurrency int32 `json:"concurrency,omitempty"` + MaxRetries int32 `json:"maxRetries,omitempty"` + BackoffMs int64 `json:"backoffMs,omitempty"` + DelayMs int64 `json:"delayMs,omitempty"` + RetentionMs int64 `json:"retentionMs,omitempty"` + } + + type testTaskQueueInput struct { + Operation string `json:"operation"` + QueueName string `json:"queueName,omitempty"` + Config *testQueueConfig `json:"config,omitempty"` + Payload []byte `json:"payload,omitempty"` + TaskID string `json:"taskId,omitempty"` + } + + type testTaskQueueOutput struct { + TaskID string `json:"taskId,omitempty"` + Status string `json:"status,omitempty"` + Message string `json:"message,omitempty"` + Attempt int32 `json:"attempt,omitempty"` + Cleared int64 `json:"cleared,omitempty"` + Error *string `json:"error,omitempty"` + } + + callTestTaskQueue := func(ctx context.Context, input testTaskQueueInput) (*testTaskQueueOutput, error) { + manager.mu.RLock() + p := manager.plugins["test-taskqueue"] + manager.mu.RUnlock() + + instance, err := p.instance(ctx) + if err != nil { + return nil, err + } + defer instance.Close(ctx) + + inputBytes, _ := json.Marshal(input) + _, outputBytes, err := instance.Call("nd_test_taskqueue", inputBytes) + if err != nil { + return nil, err + } + + var output testTaskQueueOutput + if err := json.Unmarshal(outputBytes, &output); err != nil { + return nil, err + } + if output.Error != nil { + return nil, errors.New(*output.Error) + } + return &output, nil + } + + Describe("Plugin Loading", func() { + It("should load plugin with taskqueue permission and TaskWorker capability", func() { + manager.mu.RLock() + p, ok := manager.plugins["test-taskqueue"] + manager.mu.RUnlock() + Expect(ok).To(BeTrue()) + Expect(p.manifest.Permissions).ToNot(BeNil()) + Expect(p.manifest.Permissions.Taskqueue).ToNot(BeNil()) + Expect(p.manifest.Permissions.Taskqueue.MaxConcurrency).To(Equal(10)) + Expect(p.capabilities).To(ContainElement(CapabilityTaskWorker)) + }) + }) + + Describe("Create Queue", func() { + It("should create a queue without error", func() { + ctx := GinkgoT().Context() + _, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "create_queue", + QueueName: "test-create", + }) + Expect(err).ToNot(HaveOccurred()) + }) + + It("should return error for duplicate queue name", func() { + ctx := GinkgoT().Context() + _, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "create_queue", + QueueName: "test-dup", + }) + Expect(err).ToNot(HaveOccurred()) + + _, err = callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "create_queue", + QueueName: "test-dup", + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("already exists")) + }) + }) + + Describe("Enqueue and Task Completion", func() { + It("should enqueue a task and complete successfully", func() { + ctx := GinkgoT().Context() + + // Create queue + _, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "create_queue", + QueueName: "test-complete", + }) + Expect(err).ToNot(HaveOccurred()) + + // Enqueue task with payload "hello" + output, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "enqueue", + QueueName: "test-complete", + Payload: []byte("hello"), + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.TaskID).ToNot(BeEmpty()) + + taskID := output.TaskID + + // Poll until completed + Eventually(func() string { + out, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "get_task_status", + TaskID: taskID, + }) + if err != nil { + return "error" + } + return out.Status + }).WithTimeout(5 * time.Second).WithPolling(100 * time.Millisecond).Should(Equal("completed")) + }) + }) + + Describe("Enqueue with Failure, No Retries", func() { + It("should fail when payload is 'fail' and maxRetries is 0", func() { + ctx := GinkgoT().Context() + + // Create queue with no retries + _, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "create_queue", + QueueName: "test-fail-no-retry", + Config: &testQueueConfig{ + MaxRetries: 0, + }, + }) + Expect(err).ToNot(HaveOccurred()) + + // Enqueue task that will fail + output, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "enqueue", + QueueName: "test-fail-no-retry", + Payload: []byte("fail"), + }) + Expect(err).ToNot(HaveOccurred()) + + taskID := output.TaskID + + // Poll until failed + Eventually(func() string { + out, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "get_task_status", + TaskID: taskID, + }) + if err != nil { + return "error" + } + return out.Status + }).WithTimeout(5 * time.Second).WithPolling(100 * time.Millisecond).Should(Equal("failed")) + }) + }) + + Describe("Enqueue with Retry Then Success", func() { + It("should retry and eventually succeed with 'fail-then-succeed' payload", func() { + ctx := GinkgoT().Context() + + // Create queue with retries and short backoff + _, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "create_queue", + QueueName: "test-retry-succeed", + Config: &testQueueConfig{ + MaxRetries: 2, + BackoffMs: 100, + }, + }) + Expect(err).ToNot(HaveOccurred()) + + // Enqueue task that fails on attempt < 2, then succeeds + output, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "enqueue", + QueueName: "test-retry-succeed", + Payload: []byte("fail-then-succeed"), + }) + Expect(err).ToNot(HaveOccurred()) + + taskID := output.TaskID + + // Poll until completed + Eventually(func() string { + out, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "get_task_status", + TaskID: taskID, + }) + if err != nil { + return "error" + } + return out.Status + }).WithTimeout(5 * time.Second).WithPolling(100 * time.Millisecond).Should(Equal("completed")) + }) + }) + + Describe("Cancel Pending Task", func() { + It("should cancel a pending task", func() { + ctx := GinkgoT().Context() + + // Create queue with concurrency=1 and a large delay between dispatches. + // The first task completes immediately (burst token), the second is dequeued + // but blocks on the rate limiter. Tasks 3+ remain in 'pending' and can be cancelled. + _, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "create_queue", + QueueName: "test-cancel", + Config: &testQueueConfig{ + Concurrency: 1, + DelayMs: 60000, + }, + }) + Expect(err).ToNot(HaveOccurred()) + + // Enqueue several tasks - the first will complete immediately, + // the second will be dequeued but block on the rate limiter (status=running), + // the rest will stay pending. + var taskIDs []string + for i := 0; i < 5; i++ { + output, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "enqueue", + QueueName: "test-cancel", + Payload: []byte("hello"), + }) + Expect(err).ToNot(HaveOccurred()) + taskIDs = append(taskIDs, output.TaskID) + } + + // Wait for the first task to complete (it has no delay) + Eventually(func() string { + out, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "get_task_status", + TaskID: taskIDs[0], + }) + if err != nil { + return "error" + } + return out.Status + }).WithTimeout(5 * time.Second).WithPolling(50 * time.Millisecond).Should(Equal("completed")) + + // Give the worker a moment to dequeue the second task (which will + // block on the delay) so tasks 3+ stay in 'pending' + time.Sleep(100 * time.Millisecond) + + // Cancel the last task - it should still be pending + lastTaskID := taskIDs[len(taskIDs)-1] + _, err = callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "cancel_task", + TaskID: lastTaskID, + }) + Expect(err).ToNot(HaveOccurred()) + + // Verify status is cancelled + statusOut, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "get_task_status", + TaskID: lastTaskID, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(statusOut.Status).To(Equal("cancelled")) + }) + }) + + Describe("Enqueue to Non-Existent Queue", func() { + It("should return error when enqueueing to a queue that does not exist", func() { + ctx := GinkgoT().Context() + + _, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "enqueue", + QueueName: "nonexistent-queue", + Payload: []byte("payload"), + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("does not exist")) + }) + }) + + Describe("Clear Queue", func() { + It("should clear pending tasks and return the count", func() { + ctx := GinkgoT().Context() + + // Create queue with large delay so tasks stay pending after the first completes + _, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "create_queue", + QueueName: "test-clear", + Config: &testQueueConfig{ + Concurrency: 1, + DelayMs: 60000, + }, + }) + Expect(err).ToNot(HaveOccurred()) + + // Enqueue several tasks + for i := 0; i < 4; i++ { + _, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "enqueue", + QueueName: "test-clear", + Payload: []byte(fmt.Sprintf("task-%d", i)), + }) + Expect(err).ToNot(HaveOccurred()) + } + + // Wait for the first task to complete (burst token) + time.Sleep(200 * time.Millisecond) + + // Clear the queue — should cancel remaining pending tasks + output, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "clear_queue", + QueueName: "test-clear", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Cleared).To(BeNumerically(">=", int64(1))) + }) + + It("should return error for non-existent queue", func() { + ctx := GinkgoT().Context() + + _, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "clear_queue", + QueueName: "nonexistent-clear", + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("does not exist")) + }) + }) +}) diff --git a/plugins/host_users.go b/plugins/host_users.go new file mode 100644 index 000000000..a56c8f866 --- /dev/null +++ b/plugins/host_users.go @@ -0,0 +1,64 @@ +package plugins + +import ( + "context" + + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/plugins/host" + "github.com/navidrome/navidrome/utils/slice" +) + +type usersServiceImpl struct { + ds model.DataStore + allowedUsers []string // User IDs this plugin can access + allUsers bool // If true, plugin can access all users +} + +func newUsersService(ds model.DataStore, allowedUsers []string, allUsers bool) host.UsersService { + return &usersServiceImpl{ + ds: ds, + allowedUsers: allowedUsers, + allUsers: allUsers, + } +} + +func (s *usersServiceImpl) GetUsers(ctx context.Context) ([]host.User, error) { + users, err := s.ds.User(ctx).GetAll() + if err != nil { + return nil, err + } + + // Build allowed users map for efficient lookup + allowedMap := make(map[string]bool, len(s.allowedUsers)) + for _, id := range s.allowedUsers { + allowedMap[id] = true + } + + var result []host.User + for _, u := range users { + // If allUsers is true, include all users + // Otherwise, only include users in the allowed list + if s.allUsers || allowedMap[u.ID] { + result = append(result, host.User{ + UserName: u.UserName, + Name: u.Name, + IsAdmin: u.IsAdmin, + }) + } + } + + return result, nil +} + +func (s *usersServiceImpl) GetAdmins(ctx context.Context) ([]host.User, error) { + users, err := s.GetUsers(ctx) + if err != nil { + return nil, err + } + + return slice.Filter(users, func(u host.User) bool { + return u.IsAdmin + }), nil +} + +var _ host.UsersService = (*usersServiceImpl)(nil) diff --git a/plugins/host_users_test.go b/plugins/host_users_test.go new file mode 100644 index 000000000..1c0de7d03 --- /dev/null +++ b/plugins/host_users_test.go @@ -0,0 +1,588 @@ +//go:build !windows + +package plugins + +import ( + "context" + "crypto/sha256" + "encoding/hex" + "encoding/json" + "errors" + "net/http" + "os" + "path/filepath" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/plugins/host" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("UsersService", Ordered, func() { + var ( + ctx context.Context + ds model.DataStore + service host.UsersService + ) + + BeforeEach(func() { + ctx = GinkgoT().Context() + ds = &tests.MockDataStore{} + }) + + Describe("GetUsers", func() { + var mockUserRepo *tests.MockedUserRepo + + BeforeEach(func() { + mockUserRepo = ds.User(ctx).(*tests.MockedUserRepo) + // Add test users + _ = mockUserRepo.Put(&model.User{ + ID: "user1", + UserName: "alice", + Name: "Alice Admin", + IsAdmin: true, + }) + _ = mockUserRepo.Put(&model.User{ + ID: "user2", + UserName: "bob", + Name: "Bob User", + IsAdmin: false, + }) + _ = mockUserRepo.Put(&model.User{ + ID: "user3", + UserName: "charlie", + Name: "Charlie User", + IsAdmin: false, + }) + }) + + Context("with allUsers=true", func() { + BeforeEach(func() { + service = newUsersService(ds, nil, true) + }) + + It("should return all users", func() { + users, err := service.GetUsers(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(users).To(HaveLen(3)) + + // Verify that the correct fields are returned + userNames := make([]string, len(users)) + for i, u := range users { + userNames[i] = u.UserName + } + Expect(userNames).To(ContainElements("alice", "bob", "charlie")) + }) + + It("should return correct user properties", func() { + users, err := service.GetUsers(ctx) + Expect(err).ToNot(HaveOccurred()) + + // Find alice + var alice *host.User + for i := range users { + if users[i].UserName == "alice" { + alice = &users[i] + break + } + } + + Expect(alice).ToNot(BeNil()) + Expect(alice.UserName).To(Equal("alice")) + Expect(alice.Name).To(Equal("Alice Admin")) + Expect(alice.IsAdmin).To(BeTrue()) + }) + }) + + Context("with specific allowed users", func() { + BeforeEach(func() { + // Only allow access to user1 and user3 + service = newUsersService(ds, []string{"user1", "user3"}, false) + }) + + It("should return only allowed users", func() { + users, err := service.GetUsers(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(users).To(HaveLen(2)) + + userNames := make([]string, len(users)) + for i, u := range users { + userNames[i] = u.UserName + } + Expect(userNames).To(ContainElements("alice", "charlie")) + Expect(userNames).ToNot(ContainElement("bob")) + }) + }) + + Context("with empty allowed users and allUsers=false", func() { + BeforeEach(func() { + service = newUsersService(ds, []string{}, false) + }) + + It("should return no users", func() { + users, err := service.GetUsers(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(users).To(BeEmpty()) + }) + }) + + Context("when datastore returns error", func() { + BeforeEach(func() { + mockUserRepo.Error = model.ErrNotFound + service = newUsersService(ds, nil, true) + }) + + It("should propagate the error", func() { + _, err := service.GetUsers(ctx) + Expect(err).To(HaveOccurred()) + }) + }) + }) + + Describe("GetAdmins", func() { + var mockUserRepo *tests.MockedUserRepo + + BeforeEach(func() { + mockUserRepo = ds.User(ctx).(*tests.MockedUserRepo) + // Add test users - alice is admin, bob and charlie are not + _ = mockUserRepo.Put(&model.User{ + ID: "user1", + UserName: "alice", + Name: "Alice Admin", + IsAdmin: true, + }) + _ = mockUserRepo.Put(&model.User{ + ID: "user2", + UserName: "bob", + Name: "Bob User", + IsAdmin: false, + }) + _ = mockUserRepo.Put(&model.User{ + ID: "user3", + UserName: "charlie", + Name: "Charlie User", + IsAdmin: false, + }) + }) + + Context("with allUsers=true", func() { + BeforeEach(func() { + service = newUsersService(ds, nil, true) + }) + + It("should return only admin users", func() { + admins, err := service.GetAdmins(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(admins).To(HaveLen(1)) + Expect(admins[0].UserName).To(Equal("alice")) + Expect(admins[0].IsAdmin).To(BeTrue()) + }) + }) + + Context("with specific allowed users including admin", func() { + BeforeEach(func() { + // Allow access to user1 (admin) and user2 (non-admin) + service = newUsersService(ds, []string{"user1", "user2"}, false) + }) + + It("should return only admin users from allowed list", func() { + admins, err := service.GetAdmins(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(admins).To(HaveLen(1)) + Expect(admins[0].UserName).To(Equal("alice")) + }) + }) + + Context("with specific allowed users excluding admin", func() { + BeforeEach(func() { + // Only allow access to non-admin users + service = newUsersService(ds, []string{"user2", "user3"}, false) + }) + + It("should return empty when no admins in allowed list", func() { + admins, err := service.GetAdmins(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(admins).To(BeEmpty()) + }) + }) + + Context("when datastore returns error", func() { + BeforeEach(func() { + mockUserRepo.Error = model.ErrNotFound + service = newUsersService(ds, nil, true) + }) + + It("should propagate the error", func() { + _, err := service.GetAdmins(ctx) + Expect(err).To(HaveOccurred()) + }) + }) + }) +}) + +var _ = Describe("UsersService Integration", Ordered, func() { + var manager *Manager + + BeforeAll(func() { + var cleanup func() + manager, cleanup = setupUsersIntegrationManager(true, "") + DeferCleanup(cleanup) + }) + + Describe("Plugin Loading", func() { + It("should load plugin with users permission", func() { + manager.mu.RLock() + p, ok := manager.plugins["test-users"] + manager.mu.RUnlock() + Expect(ok).To(BeTrue()) + Expect(p.manifest.Permissions).ToNot(BeNil()) + Expect(p.manifest.Permissions.Users).ToNot(BeNil()) + }) + }) + + Describe("Users Operations via Plugin", func() { + It("should get all users when allUsers is true", func() { + output, err := callTestUsersPlugin(GinkgoT().Context(), manager, testUsersInput{Operation: "get_users"}) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Users).To(HaveLen(3)) + + // Verify user names + userNames := make([]string, len(output.Users)) + for i, u := range output.Users { + userNames[i] = u.UserName + } + Expect(userNames).To(ContainElements("alice", "bob", "charlie")) + }) + + It("should return correct user properties", func() { + output, err := callTestUsersPlugin(GinkgoT().Context(), manager, testUsersInput{Operation: "get_users"}) + Expect(err).ToNot(HaveOccurred()) + + // Find alice + var alice *testUser + for i := range output.Users { + if output.Users[i].UserName == "alice" { + alice = &output.Users[i] + break + } + } + + Expect(alice).ToNot(BeNil()) + Expect(alice.UserName).To(Equal("alice")) + Expect(alice.Name).To(Equal("Alice Admin")) + Expect(alice.IsAdmin).To(BeTrue()) + }) + + It("should return non-admin user correctly", func() { + output, err := callTestUsersPlugin(GinkgoT().Context(), manager, testUsersInput{Operation: "get_users"}) + Expect(err).ToNot(HaveOccurred()) + + // Find bob + var bob *testUser + for i := range output.Users { + if output.Users[i].UserName == "bob" { + bob = &output.Users[i] + break + } + } + + Expect(bob).ToNot(BeNil()) + Expect(bob.UserName).To(Equal("bob")) + Expect(bob.Name).To(Equal("Bob User")) + Expect(bob.IsAdmin).To(BeFalse()) + }) + }) + + Describe("GetAdmins Operations via Plugin", func() { + It("should get only admin users when allUsers is true", func() { + output, err := callTestUsersPlugin(GinkgoT().Context(), manager, testUsersInput{Operation: "get_admins"}) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Users).To(HaveLen(1)) + Expect(output.Users[0].UserName).To(Equal("alice")) + Expect(output.Users[0].IsAdmin).To(BeTrue()) + }) + }) +}) + +var _ = Describe("UsersService Integration with Specific Users", Ordered, func() { + var manager *Manager + + BeforeAll(func() { + var cleanup func() + manager, cleanup = setupUsersIntegrationManager(false, `["user1", "user3"]`) + DeferCleanup(cleanup) + }) + + Describe("Users Operations with Specific Allowed Users", func() { + It("should only return allowed users", func() { + output, err := callTestUsersPlugin(GinkgoT().Context(), manager, testUsersInput{Operation: "get_users"}) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Users).To(HaveLen(2)) + + // Verify only alice and charlie are returned, not bob + userNames := make([]string, len(output.Users)) + for i, u := range output.Users { + userNames[i] = u.UserName + } + Expect(userNames).To(ContainElements("alice", "charlie")) + Expect(userNames).ToNot(ContainElement("bob")) + }) + + It("should only return admin users from allowed list via GetAdmins", func() { + output, err := callTestUsersPlugin(GinkgoT().Context(), manager, testUsersInput{Operation: "get_admins"}) + Expect(err).ToNot(HaveOccurred()) + // Only alice (user1) is admin, charlie (user3) is not + Expect(output.Users).To(HaveLen(1)) + Expect(output.Users[0].UserName).To(Equal("alice")) + Expect(output.Users[0].IsAdmin).To(BeTrue()) + }) + }) +}) + +var _ = Describe("UsersService Integration GetAdmins with No Admins", Ordered, func() { + var manager *Manager + + BeforeAll(func() { + var cleanup func() + // Only allow user2 (bob) and user3 (charlie), both non-admins + manager, cleanup = setupUsersIntegrationManager(false, `["user2", "user3"]`) + DeferCleanup(cleanup) + }) + + Describe("GetAdmins with no admin users in allowed list", func() { + It("should return empty when no admins in allowed list", func() { + output, err := callTestUsersPlugin(GinkgoT().Context(), manager, testUsersInput{Operation: "get_admins"}) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Users).To(BeEmpty()) + }) + }) +}) + +var _ = Describe("UsersService Enable Gate", Ordered, func() { + var manager *Manager + + BeforeAll(func() { + var cleanup func() + // Start with disabled plugin, no users configured + manager, cleanup = setupUsersIntegrationManagerWithEnabled(false, false, "") + DeferCleanup(cleanup) + }) + + Describe("Enable Gate Behavior", func() { + It("should block enabling when no users configured and allUsers is false", func() { + ctx := GinkgoT().Context() + err := manager.EnablePlugin(ctx, "test-users") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("users permission requires configuration")) + }) + + It("should allow enabling when allUsers is true", func() { + ctx := GinkgoT().Context() + + // Update the plugin to have allUsers=true + err := manager.UpdatePluginUsers(ctx, "test-users", "", true) + Expect(err).ToNot(HaveOccurred()) + + // Now enabling should succeed + err = manager.EnablePlugin(ctx, "test-users") + Expect(err).ToNot(HaveOccurred()) + + // Verify plugin is loaded + manager.mu.RLock() + _, ok := manager.plugins["test-users"] + manager.mu.RUnlock() + Expect(ok).To(BeTrue()) + }) + + It("should allow enabling when specific users are configured", func() { + ctx := GinkgoT().Context() + + // First disable the plugin + err := manager.DisablePlugin(ctx, "test-users") + Expect(err).ToNot(HaveOccurred()) + + // Update to have specific users (and allUsers=false) + err = manager.UpdatePluginUsers(ctx, "test-users", `["user1"]`, false) + Expect(err).ToNot(HaveOccurred()) + + // Now enabling should succeed + err = manager.EnablePlugin(ctx, "test-users") + Expect(err).ToNot(HaveOccurred()) + + // Verify plugin is loaded + manager.mu.RLock() + _, ok := manager.plugins["test-users"] + manager.mu.RUnlock() + Expect(ok).To(BeTrue()) + }) + }) +}) + +// testUsersSetup contains common setup data for users integration tests +type testUsersSetup struct { + tmpDir string + destPath string + hashHex string +} + +// setupTestUsersPlugin creates a temporary directory with the test-users plugin and returns setup info +func setupTestUsersPlugin() (*testUsersSetup, error) { + tmpDir, err := os.MkdirTemp("", "users-integration-test-*") + if err != nil { + return nil, err + } + + // Copy the test-users plugin + srcPath := filepath.Join(testdataDir, "test-users"+PackageExtension) + destPath := filepath.Join(tmpDir, "test-users"+PackageExtension) + data, err := os.ReadFile(srcPath) + if err != nil { + _ = os.RemoveAll(tmpDir) + return nil, err + } + if err := os.WriteFile(destPath, data, 0600); err != nil { + _ = os.RemoveAll(tmpDir) + return nil, err + } + + // Compute SHA256 for the plugin + hash := sha256.Sum256(data) + hashHex := hex.EncodeToString(hash[:]) + + return &testUsersSetup{ + tmpDir: tmpDir, + destPath: destPath, + hashHex: hashHex, + }, nil +} + +// createTestUsers creates standard test users in the mock repo +func createTestUsers(mockUserRepo *tests.MockedUserRepo) { + _ = mockUserRepo.Put(&model.User{ + ID: "user1", + UserName: "alice", + Name: "Alice Admin", + IsAdmin: true, + }) + _ = mockUserRepo.Put(&model.User{ + ID: "user2", + UserName: "bob", + Name: "Bob User", + IsAdmin: false, + }) + _ = mockUserRepo.Put(&model.User{ + ID: "user3", + UserName: "charlie", + Name: "Charlie User", + IsAdmin: false, + }) +} + +// setupTestUsersConfig sets up common plugin configuration +func setupTestUsersConfig(tmpDir string) { + conf.Server.Plugins.Enabled = true + conf.Server.Plugins.Folder = tmpDir + conf.Server.Plugins.AutoReload = false +} + +// testUsersInput represents input for test-users plugin calls +type testUsersInput struct { + Operation string `json:"operation"` +} + +// testUser represents a user returned from test-users plugin +type testUser struct { + UserName string `json:"userName"` + Name string `json:"name"` + IsAdmin bool `json:"isAdmin"` +} + +// testUsersOutput represents output from test-users plugin +type testUsersOutput struct { + Users []testUser `json:"users,omitempty"` + Error *string `json:"error,omitempty"` +} + +// callTestUsersPlugin calls the test-users plugin with given input +func callTestUsersPlugin(ctx context.Context, manager *Manager, input testUsersInput) (*testUsersOutput, error) { + manager.mu.RLock() + p := manager.plugins["test-users"] + manager.mu.RUnlock() + + instance, err := p.instance(ctx) + if err != nil { + return nil, err + } + defer instance.Close(ctx) + + inputBytes, _ := json.Marshal(input) + _, outputBytes, err := instance.Call("nd_test_users", inputBytes) + if err != nil { + return nil, err + } + + var output testUsersOutput + if err := json.Unmarshal(outputBytes, &output); err != nil { + return nil, err + } + if output.Error != nil { + return nil, errors.New(*output.Error) + } + return &output, nil +} + +// setupUsersIntegrationManager creates a Manager for users integration tests with the given plugin settings. +// The plugin is enabled by default. +func setupUsersIntegrationManager(allUsers bool, allowedUsers string) (*Manager, func()) { + return setupUsersIntegrationManagerWithEnabled(true, allUsers, allowedUsers) +} + +// setupUsersIntegrationManagerWithEnabled creates a Manager for users integration tests with full control over plugin state +func setupUsersIntegrationManagerWithEnabled(enabled, allUsers bool, allowedUsers string) (*Manager, func()) { + setup, err := setupTestUsersPlugin() + Expect(err).ToNot(HaveOccurred()) + + // Setup config + cleanupConfig := configtest.SetupConfig() + setupTestUsersConfig(setup.tmpDir) + + // Setup mock DataStore with plugin and users + mockPluginRepo := tests.CreateMockPluginRepo() + mockPluginRepo.Permitted = true + mockPluginRepo.SetData(model.Plugins{{ + ID: "test-users", + Path: setup.destPath, + SHA256: setup.hashHex, + Enabled: enabled, + AllUsers: allUsers, + Users: allowedUsers, + }}) + + mockUserRepo := tests.CreateMockUserRepo() + createTestUsers(mockUserRepo) + + dataStore := &tests.MockDataStore{ + MockedPlugin: mockPluginRepo, + MockedUser: mockUserRepo, + } + + // Create and start manager + manager := &Manager{ + plugins: make(map[string]*plugin), + ds: dataStore, + subsonicRouter: http.NotFoundHandler(), + } + err = manager.Start(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + + cleanup := func() { + _ = manager.Stop() + _ = os.RemoveAll(setup.tmpDir) + cleanupConfig() + } + + return manager, cleanup +} diff --git a/plugins/host_websocket.go b/plugins/host_websocket.go index e90d1363d..74238a422 100644 --- a/plugins/host_websocket.go +++ b/plugins/host_websocket.go @@ -2,399 +2,389 @@ package plugins import ( "context" - "encoding/binary" + "errors" "fmt" + "maps" + "net/http" + "net/url" "strings" "sync" "time" - gorillaws "github.com/gorilla/websocket" - gonanoid "github.com/matoous/go-nanoid/v2" + "github.com/gorilla/websocket" "github.com/navidrome/navidrome/log" - "github.com/navidrome/navidrome/plugins/api" - "github.com/navidrome/navidrome/plugins/host/websocket" + "github.com/navidrome/navidrome/model/id" + "github.com/navidrome/navidrome/plugins/capabilities" + "github.com/navidrome/navidrome/plugins/host" ) -// WebSocketConnection represents a WebSocket connection -type WebSocketConnection struct { - Conn *gorillaws.Conn - PluginName string - ConnectionID string - Done chan struct{} - mu sync.Mutex +// CapabilityWebSocket indicates the plugin can receive WebSocket callbacks. +// Detected when the plugin exports any of the WebSocket callback functions. +const CapabilityWebSocket Capability = "WebSocket" + +// webSocketCallbackTimeout is the maximum duration allowed for a WebSocket callback. +const webSocketCallbackTimeout = 30 * time.Second + +// WebSocket callback function names +const ( + FuncWebSocketOnTextMessage = "nd_websocket_on_text_message" + FuncWebSocketOnBinaryMessage = "nd_websocket_on_binary_message" + FuncWebSocketOnError = "nd_websocket_on_error" + FuncWebSocketOnClose = "nd_websocket_on_close" +) + +func init() { + registerCapability( + CapabilityWebSocket, + FuncWebSocketOnTextMessage, + FuncWebSocketOnBinaryMessage, + FuncWebSocketOnError, + FuncWebSocketOnClose, + ) } -// WebSocketHostFunctions implements the websocket.WebSocketService interface -type WebSocketHostFunctions struct { - ws *websocketService - pluginID string - permissions *webSocketPermissions +// wsConnection represents an active WebSocket connection. +type wsConnection struct { + conn *websocket.Conn + done chan struct{} + closeMu sync.Mutex + isClosed bool } -func (s WebSocketHostFunctions) Connect(ctx context.Context, req *websocket.ConnectRequest) (*websocket.ConnectResponse, error) { - return s.ws.connect(ctx, s.pluginID, req, s.permissions) -} +// webSocketServiceImpl implements host.WebSocketService. +// It provides plugins with WebSocket communication capabilities. +type webSocketServiceImpl struct { + pluginName string + manager *Manager + requiredHosts []string -func (s WebSocketHostFunctions) SendText(ctx context.Context, req *websocket.SendTextRequest) (*websocket.SendTextResponse, error) { - return s.ws.sendText(ctx, s.pluginID, req) -} - -func (s WebSocketHostFunctions) SendBinary(ctx context.Context, req *websocket.SendBinaryRequest) (*websocket.SendBinaryResponse, error) { - return s.ws.sendBinary(ctx, s.pluginID, req) -} - -func (s WebSocketHostFunctions) Close(ctx context.Context, req *websocket.CloseRequest) (*websocket.CloseResponse, error) { - return s.ws.close(ctx, s.pluginID, req) -} - -// websocketService implements the WebSocket service functionality -type websocketService struct { - connections map[string]*WebSocketConnection - manager *managerImpl mu sync.RWMutex + connections map[string]*wsConnection } -// newWebsocketService creates a new websocketService instance -func newWebsocketService(manager *managerImpl) *websocketService { - return &websocketService{ - connections: make(map[string]*WebSocketConnection), - manager: manager, +// newWebSocketService creates a new WebSocketService for a plugin. +func newWebSocketService(pluginName string, manager *Manager, permission *WebSocketPermission) *webSocketServiceImpl { + return &webSocketServiceImpl{ + pluginName: pluginName, + manager: manager, + requiredHosts: permission.RequiredHosts, + connections: make(map[string]*wsConnection), } } -// HostFunctions returns the WebSocketHostFunctions for the given plugin -func (s *websocketService) HostFunctions(pluginID string, permissions *webSocketPermissions) WebSocketHostFunctions { - return WebSocketHostFunctions{ - ws: s, - pluginID: pluginID, - permissions: permissions, - } -} - -// Safe accessor methods - -// hasConnection safely checks if a connection exists -func (s *websocketService) hasConnection(id string) bool { - s.mu.RLock() - defer s.mu.RUnlock() - _, exists := s.connections[id] - return exists -} - -// connectionCount safely returns the number of connections -func (s *websocketService) connectionCount() int { - s.mu.RLock() - defer s.mu.RUnlock() - return len(s.connections) -} - -// getConnection safely retrieves a connection by internal ID -func (s *websocketService) getConnection(internalConnectionID string) (*WebSocketConnection, error) { - s.mu.RLock() - defer s.mu.RUnlock() - conn, exists := s.connections[internalConnectionID] - - if !exists { - return nil, fmt.Errorf("connection not found") - } - return conn, nil -} - -// internalConnectionID builds the internal connection ID from plugin and connection ID -func internalConnectionID(pluginName, connectionID string) string { - return pluginName + ":" + connectionID -} - -// extractConnectionID extracts the original connection ID from an internal ID -func extractConnectionID(internalID string) (string, error) { - parts := strings.Split(internalID, ":") - if len(parts) != 2 { - return "", fmt.Errorf("invalid internal connection ID format: %s", internalID) - } - return parts[1], nil -} - -// connect establishes a new WebSocket connection -func (s *websocketService) connect(ctx context.Context, pluginID string, req *websocket.ConnectRequest, permissions *webSocketPermissions) (*websocket.ConnectResponse, error) { - if s.manager == nil { - return nil, fmt.Errorf("websocket service not properly initialized") - } - - // Check permissions if they exist - if permissions != nil { - if err := permissions.IsConnectionAllowed(req.Url); err != nil { - log.Warn(ctx, "WebSocket connection blocked by permissions", "plugin", pluginID, "url", req.Url, err) - return &websocket.ConnectResponse{Error: "Connection blocked by plugin permissions: " + err.Error()}, nil - } - } - - // Create websocket dialer with the headers - dialer := gorillaws.DefaultDialer - header := make(map[string][]string) - for k, v := range req.Headers { - header[k] = []string{v} - } - - // Connect to the WebSocket server - conn, resp, err := dialer.DialContext(ctx, req.Url, header) +func (s *webSocketServiceImpl) Connect(ctx context.Context, urlStr string, headers map[string]string, connectionID string) (string, error) { + // Parse and validate URL + parsedURL, err := url.Parse(urlStr) if err != nil { - return nil, fmt.Errorf("failed to connect to WebSocket server: %w", err) - } - defer resp.Body.Close() - - // Generate a connection ID - if req.ConnectionId == "" { - req.ConnectionId, _ = gonanoid.New(10) - } - connectionID := req.ConnectionId - internal := internalConnectionID(pluginID, connectionID) - - // Create the connection object - wsConn := &WebSocketConnection{ - Conn: conn, - PluginName: pluginID, - ConnectionID: connectionID, - Done: make(chan struct{}), + return "", fmt.Errorf("invalid URL: %w", err) + } + + // Validate scheme + if parsedURL.Scheme != "ws" && parsedURL.Scheme != "wss" { + return "", fmt.Errorf("invalid URL scheme: must be ws:// or wss://") + } + + // Validate host against allowed hosts + if !s.isHostAllowed(parsedURL.Host) { + return "", fmt.Errorf("host %q is not allowed", parsedURL.Host) + } + + // Generate connection ID if not provided + if connectionID == "" { + connectionID = id.NewRandom() } - // Store the connection s.mu.Lock() - defer s.mu.Unlock() - s.connections[internal] = wsConn + if _, exists := s.connections[connectionID]; exists { + s.mu.Unlock() + return "", fmt.Errorf("connection ID %q already exists", connectionID) + } + s.mu.Unlock() - log.Debug("WebSocket connection established", "plugin", pluginID, "connectionID", connectionID, "url", req.Url) + // Create HTTP headers for handshake + httpHeaders := http.Header{} + for k, v := range headers { + httpHeaders.Set(k, v) + } - // Start the message handling goroutine - go s.handleMessages(internal, wsConn) + // Establish WebSocket connection + dialer := websocket.Dialer{ + HandshakeTimeout: 30 * time.Second, + } - return &websocket.ConnectResponse{ - ConnectionId: connectionID, - }, nil + conn, resp, err := dialer.DialContext(ctx, urlStr, httpHeaders) + if resp != nil && resp.Body != nil { + _ = resp.Body.Close() + } + if err != nil { + return "", fmt.Errorf("failed to connect: %w", err) + } + + wsConn := &wsConnection{ + conn: conn, + done: make(chan struct{}), + } + + s.mu.Lock() + s.connections[connectionID] = wsConn + s.mu.Unlock() + + // Start read goroutine with manager's context. + // We use manager.ctx instead of the caller's ctx because the readLoop must + // outlive the Connect() call. The manager's context is cancelled during + // application shutdown, ensuring graceful cleanup. + go s.readLoop(s.manager.ctx, connectionID, wsConn) + + log.Debug(ctx, "WebSocket connected", "plugin", s.pluginName, "connectionID", connectionID, "url", urlStr) + return connectionID, nil } -// writeMessage is a helper to send messages to a websocket connection -func (s *websocketService) writeMessage(pluginID string, connID string, messageType int, data []byte) error { - internal := internalConnectionID(pluginID, connID) - - conn, err := s.getConnection(internal) +func (s *webSocketServiceImpl) SendText(ctx context.Context, connectionID, message string) error { + wsConn, err := s.getConnection(connectionID) if err != nil { return err } - conn.mu.Lock() - defer conn.mu.Unlock() - - if err := conn.Conn.WriteMessage(messageType, data); err != nil { - return fmt.Errorf("failed to send message: %w", err) + if err := wsConn.conn.WriteMessage(websocket.TextMessage, []byte(message)); err != nil { + return fmt.Errorf("failed to send text message: %w", err) } return nil } -// sendText sends a text message over a WebSocket connection -func (s *websocketService) sendText(ctx context.Context, pluginID string, req *websocket.SendTextRequest) (*websocket.SendTextResponse, error) { - if err := s.writeMessage(pluginID, req.ConnectionId, gorillaws.TextMessage, []byte(req.Message)); err != nil { - return &websocket.SendTextResponse{Error: err.Error()}, nil //nolint:nilerr +func (s *webSocketServiceImpl) SendBinary(ctx context.Context, connectionID string, data []byte) error { + wsConn, err := s.getConnection(connectionID) + if err != nil { + return err } - return &websocket.SendTextResponse{}, nil + + if err := wsConn.conn.WriteMessage(websocket.BinaryMessage, data); err != nil { + return fmt.Errorf("failed to send binary message: %w", err) + } + + return nil } -// sendBinary sends binary data over a WebSocket connection -func (s *websocketService) sendBinary(ctx context.Context, pluginID string, req *websocket.SendBinaryRequest) (*websocket.SendBinaryResponse, error) { - if err := s.writeMessage(pluginID, req.ConnectionId, gorillaws.BinaryMessage, req.Data); err != nil { - return &websocket.SendBinaryResponse{Error: err.Error()}, nil //nolint:nilerr - } - return &websocket.SendBinaryResponse{}, nil -} - -// close closes a WebSocket connection -func (s *websocketService) close(ctx context.Context, pluginID string, req *websocket.CloseRequest) (*websocket.CloseResponse, error) { - internal := internalConnectionID(pluginID, req.ConnectionId) - +func (s *webSocketServiceImpl) CloseConnection(ctx context.Context, connectionID string, code int32, reason string) error { s.mu.Lock() - conn, exists := s.connections[internal] + wsConn, exists := s.connections[connectionID] if !exists { s.mu.Unlock() - return &websocket.CloseResponse{Error: "connection not found"}, nil + return fmt.Errorf("connection ID %q not found", connectionID) } - delete(s.connections, internal) + delete(s.connections, connectionID) s.mu.Unlock() - // Signal the message handling goroutine to stop - close(conn.Done) + // Mark as closed to prevent callback + wsConn.closeMu.Lock() + wsConn.isClosed = true + wsConn.closeMu.Unlock() - // Close the connection with the specified code and reason - conn.mu.Lock() - defer conn.mu.Unlock() + // Send close message + closeMsg := websocket.FormatCloseMessage(int(code), reason) + _ = wsConn.conn.WriteControl(websocket.CloseMessage, closeMsg, time.Now().Add(5*time.Second)) + _ = wsConn.conn.Close() - err := conn.Conn.WriteControl( - gorillaws.CloseMessage, - gorillaws.FormatCloseMessage(int(req.Code), req.Reason), - time.Now().Add(time.Second), - ) - if err != nil { - log.Error("Error sending close message", "plugin", pluginID, "error", err) - } + // Signal read goroutine to stop + close(wsConn.done) - if err := conn.Conn.Close(); err != nil { - return nil, fmt.Errorf("error closing connection: %w", err) - } + // Invoke close callback + s.invokeOnClose(ctx, connectionID, code, reason) - log.Debug("WebSocket connection closed", "plugin", pluginID, "connectionID", req.ConnectionId) - return &websocket.CloseResponse{}, nil + log.Debug(ctx, "WebSocket connection closed", "plugin", s.pluginName, "connectionID", connectionID, "code", code) + return nil } -// handleMessages processes incoming WebSocket messages -func (s *websocketService) handleMessages(internalID string, conn *WebSocketConnection) { - // Get the original connection ID (without plugin prefix) - connectionID, err := extractConnectionID(internalID) - if err != nil { - log.Error("Invalid internal connection ID", "id", internalID, "error", err) - return +// Close closes all connections for this plugin. +// This is called when the plugin is unloaded. +func (s *webSocketServiceImpl) Close() error { + s.mu.Lock() + connections := make(map[string]*wsConnection, len(s.connections)) + maps.Copy(connections, s.connections) + s.connections = make(map[string]*wsConnection) + s.mu.Unlock() + + ctx := context.Background() + for connID, wsConn := range connections { + wsConn.closeMu.Lock() + wsConn.isClosed = true + wsConn.closeMu.Unlock() + + closeMsg := websocket.FormatCloseMessage(websocket.CloseGoingAway, "plugin unloaded") + err := wsConn.conn.WriteControl(websocket.CloseMessage, closeMsg, time.Now().Add(2*time.Second)) + if err != nil { + log.Warn("Failed to send WebSocket close message on plugin unload", "plugin", s.pluginName, "connectionID", connID, "error", err) + } + err = wsConn.conn.Close() + if err != nil { + log.Warn("Failed to close WebSocket connection on plugin unload", "plugin", s.pluginName, "connectionID", connID, "error", err) + } + close(wsConn.done) + + s.invokeOnClose(ctx, connID, websocket.CloseGoingAway, "plugin unloaded") + log.Debug("WebSocket connection closed on plugin unload", "plugin", s.pluginName, "connectionID", connID) } - ctx, cancel := context.WithCancel(context.Background()) - defer cancel() + return nil +} +func (s *webSocketServiceImpl) getConnection(connectionID string) (*wsConnection, error) { + s.mu.RLock() + defer s.mu.RUnlock() + + wsConn, exists := s.connections[connectionID] + if !exists { + return nil, fmt.Errorf("connection ID %q not found", connectionID) + } + return wsConn, nil +} + +func (s *webSocketServiceImpl) isHostAllowed(host string) bool { + // Strip port from host if present + hostWithoutPort := host + if idx := strings.LastIndex(host, ":"); idx != -1 { + hostWithoutPort = host[:idx] + } + + for _, pattern := range s.requiredHosts { + if matchHostPattern(pattern, hostWithoutPort) { + return true + } + } + return false +} + +// matchHostPattern matches a host against a pattern. +// Supports "*" (allow all) and wildcards like "*.example.com". +func matchHostPattern(pattern, host string) bool { + if pattern == "*" { + return true + } + if pattern == host { + return true + } + + // Handle wildcard patterns like *.example.com + if strings.HasPrefix(pattern, "*.") { + suffix := pattern[1:] // Get .example.com + return strings.HasSuffix(host, suffix) + } + + return false +} + +func (s *webSocketServiceImpl) readLoop(ctx context.Context, connectionID string, wsConn *wsConnection) { defer func() { - // Ensure the connection is removed from the map if not already removed + // Remove connection if still present s.mu.Lock() - defer s.mu.Unlock() - delete(s.connections, internalID) - - log.Debug("WebSocket message handler stopped", "plugin", conn.PluginName, "connectionID", connectionID) + delete(s.connections, connectionID) + s.mu.Unlock() }() - // Add connection info to context - ctx = log.NewContext(ctx, - "connectionID", connectionID, - "plugin", conn.PluginName, - ) - for { select { - case <-conn.Done: - // Connection was closed by a Close call + case <-wsConn.done: return default: - // Set a read deadline - _ = conn.Conn.SetReadDeadline(time.Now().Add(time.Second * 60)) + } - // Read the next message - messageType, message, err := conn.Conn.ReadMessage() - if err != nil { - s.notifyErrorCallback(ctx, connectionID, conn, err.Error()) + messageType, data, err := wsConn.conn.ReadMessage() + if err != nil { + wsConn.closeMu.Lock() + isClosed := wsConn.isClosed + wsConn.closeMu.Unlock() + + if isClosed { return } - // Reset the read deadline - _ = conn.Conn.SetReadDeadline(time.Time{}) - - // Process the message based on its type - switch messageType { - case gorillaws.TextMessage: - s.notifyTextCallback(ctx, connectionID, conn, string(message)) - case gorillaws.BinaryMessage: - s.notifyBinaryCallback(ctx, connectionID, conn, message) - case gorillaws.CloseMessage: - code := gorillaws.CloseNormalClosure - reason := "" - if len(message) >= 2 { - code = int(binary.BigEndian.Uint16(message[:2])) - if len(message) > 2 { - reason = string(message[2:]) - } + // Check if it's a close error + if websocket.IsCloseError(err, websocket.CloseNormalClosure, websocket.CloseGoingAway, websocket.CloseNoStatusReceived) { + closeCode := websocket.CloseNoStatusReceived + closeReason := "" + var ce *websocket.CloseError + if errors.As(err, &ce) { + closeCode = ce.Code + closeReason = ce.Text } - s.notifyCloseCallback(ctx, connectionID, conn, code, reason) + s.invokeOnClose(ctx, connectionID, int32(closeCode), closeReason) return } + + // Other read error + s.invokeOnError(ctx, connectionID, err.Error()) + return + } + + switch messageType { + case websocket.TextMessage: + s.invokeOnTextMessage(ctx, connectionID, string(data)) + case websocket.BinaryMessage: + s.invokeOnBinaryMessage(ctx, connectionID, data) } } } -// executeCallback is a common function that handles the plugin loading and execution -// for all types of callbacks -func (s *websocketService) executeCallback(ctx context.Context, pluginID, methodName string, fn func(context.Context, api.WebSocketCallback) error) { - log.Debug(ctx, "WebSocket received") - - start := time.Now() - - // Get the plugin - p := s.manager.LoadPlugin(pluginID, CapabilityWebSocketCallback) - if p == nil { - log.Error(ctx, "Plugin not found for WebSocket callback") +// invokeWebSocketCallback is a generic helper that handles the common callback invocation pattern. +func invokeWebSocketCallback[I any](ctx context.Context, s *webSocketServiceImpl, funcName string, input I, callbackName string, connectionID string) { + instance := s.getPluginInstance() + if instance == nil { return } - _, _ = callMethod(ctx, p, methodName, func(inst api.WebSocketCallback) (struct{}, error) { - // Call the appropriate callback function - log.Trace(ctx, "Executing WebSocket callback") - if err := fn(ctx, inst); err != nil { - log.Error(ctx, "Error executing WebSocket callback", "elapsed", time.Since(start), err) - return struct{}{}, fmt.Errorf("error executing WebSocket callback: %w", err) + callbackCtx, cancel := context.WithTimeout(ctx, webSocketCallbackTimeout) + defer cancel() + + start := time.Now() + err := callPluginFunctionNoOutput(callbackCtx, instance, funcName, input) + if err != nil { + if !errors.Is(errFunctionNotFound, err) { + log.Error(ctx, "WebSocket "+callbackName+" callback failed", "plugin", s.pluginName, "connectionID", connectionID, "duration", time.Since(start), err) } - log.Debug(ctx, "WebSocket callback executed", "elapsed", time.Since(start)) - return struct{}{}, nil - }) + } } -// notifyTextCallback notifies the plugin of a text message -func (s *websocketService) notifyTextCallback(ctx context.Context, connectionID string, conn *WebSocketConnection, message string) { - req := &api.OnTextMessageRequest{ - ConnectionId: connectionID, +func (s *webSocketServiceImpl) invokeOnTextMessage(ctx context.Context, connectionID, message string) { + invokeWebSocketCallback(ctx, s, FuncWebSocketOnTextMessage, capabilities.OnTextMessageRequest{ + ConnectionID: connectionID, Message: message, - } - - ctx = log.NewContext(ctx, "callback", "OnTextMessage", "size", len(message)) - - s.executeCallback(ctx, conn.PluginName, "OnTextMessage", func(ctx context.Context, plugin api.WebSocketCallback) error { - _, err := checkErr(plugin.OnTextMessage(ctx, req)) - return err - }) + }, "text message", connectionID) } -// notifyBinaryCallback notifies the plugin of a binary message -func (s *websocketService) notifyBinaryCallback(ctx context.Context, connectionID string, conn *WebSocketConnection, data []byte) { - req := &api.OnBinaryMessageRequest{ - ConnectionId: connectionID, +func (s *webSocketServiceImpl) invokeOnBinaryMessage(ctx context.Context, connectionID string, data []byte) { + invokeWebSocketCallback(ctx, s, FuncWebSocketOnBinaryMessage, capabilities.OnBinaryMessageRequest{ + ConnectionID: connectionID, Data: data, - } - - ctx = log.NewContext(ctx, "callback", "OnBinaryMessage", "size", len(data)) - - s.executeCallback(ctx, conn.PluginName, "OnBinaryMessage", func(ctx context.Context, plugin api.WebSocketCallback) error { - _, err := checkErr(plugin.OnBinaryMessage(ctx, req)) - return err - }) + }, "binary message", connectionID) } -// notifyErrorCallback notifies the plugin of an error -func (s *websocketService) notifyErrorCallback(ctx context.Context, connectionID string, conn *WebSocketConnection, errorMsg string) { - req := &api.OnErrorRequest{ - ConnectionId: connectionID, +func (s *webSocketServiceImpl) invokeOnError(ctx context.Context, connectionID, errorMsg string) { + invokeWebSocketCallback(ctx, s, FuncWebSocketOnError, capabilities.OnErrorRequest{ + ConnectionID: connectionID, Error: errorMsg, - } - - ctx = log.NewContext(ctx, "callback", "OnError", "error", errorMsg) - - s.executeCallback(ctx, conn.PluginName, "OnError", func(ctx context.Context, plugin api.WebSocketCallback) error { - _, err := checkErr(plugin.OnError(ctx, req)) - return err - }) + }, "error", connectionID) } -// notifyCloseCallback notifies the plugin that the connection was closed -func (s *websocketService) notifyCloseCallback(ctx context.Context, connectionID string, conn *WebSocketConnection, code int, reason string) { - req := &api.OnCloseRequest{ - ConnectionId: connectionID, - Code: int32(code), +func (s *webSocketServiceImpl) invokeOnClose(ctx context.Context, connectionID string, code int32, reason string) { + invokeWebSocketCallback(ctx, s, FuncWebSocketOnClose, capabilities.OnCloseRequest{ + ConnectionID: connectionID, + Code: code, Reason: reason, + }, "close", connectionID) +} + +func (s *webSocketServiceImpl) getPluginInstance() *plugin { + s.manager.mu.RLock() + instance, ok := s.manager.plugins[s.pluginName] + s.manager.mu.RUnlock() + + if !ok { + log.Warn("Plugin not loaded for WebSocket callback", "plugin", s.pluginName) + return nil } - ctx = log.NewContext(ctx, "callback", "OnClose", "code", code, "reason", reason) - - s.executeCallback(ctx, conn.PluginName, "OnClose", func(ctx context.Context, plugin api.WebSocketCallback) error { - _, err := checkErr(plugin.OnClose(ctx, req)) - return err - }) + return instance } + +// Verify interface implementation +var _ host.WebSocketService = (*webSocketServiceImpl)(nil) diff --git a/plugins/host_websocket_permissions.go b/plugins/host_websocket_permissions.go deleted file mode 100644 index 53f6a127b..000000000 --- a/plugins/host_websocket_permissions.go +++ /dev/null @@ -1,76 +0,0 @@ -package plugins - -import ( - "fmt" - - "github.com/navidrome/navidrome/plugins/schema" -) - -// WebSocketPermissions represents granular WebSocket access permissions for plugins -type webSocketPermissions struct { - *networkPermissionsBase - AllowedUrls []string `json:"allowedUrls"` - matcher *urlMatcher -} - -// parseWebSocketPermissions extracts WebSocket permissions from the schema -func parseWebSocketPermissions(permData *schema.PluginManifestPermissionsWebsocket) (*webSocketPermissions, error) { - if len(permData.AllowedUrls) == 0 { - return nil, fmt.Errorf("allowedUrls must contain at least one URL pattern") - } - - return &webSocketPermissions{ - networkPermissionsBase: &networkPermissionsBase{ - AllowLocalNetwork: permData.AllowLocalNetwork, - }, - AllowedUrls: permData.AllowedUrls, - matcher: newURLMatcher(), - }, nil -} - -// IsConnectionAllowed checks if a WebSocket connection is allowed -func (w *webSocketPermissions) IsConnectionAllowed(requestURL string) error { - if _, err := checkURLPolicy(requestURL, w.AllowLocalNetwork); err != nil { - return err - } - - // allowedUrls is required - no fallback to allow all URLs - if len(w.AllowedUrls) == 0 { - return fmt.Errorf("no allowed URLs configured for plugin") - } - - // Check URL patterns - // First try exact matches, then wildcard matches - - // Phase 1: Check for exact matches first - for _, urlPattern := range w.AllowedUrls { - if urlPattern == "*" || (!containsWildcard(urlPattern) && w.matcher.MatchesURLPattern(requestURL, urlPattern)) { - return nil - } - } - - // Phase 2: Check wildcard patterns - for _, urlPattern := range w.AllowedUrls { - if containsWildcard(urlPattern) && w.matcher.MatchesURLPattern(requestURL, urlPattern) { - return nil - } - } - - return fmt.Errorf("URL %s does not match any allowed URL patterns", requestURL) -} - -// containsWildcard checks if a URL pattern contains wildcard characters -func containsWildcard(pattern string) bool { - if pattern == "*" { - return true - } - - // Check for wildcards anywhere in the pattern - for _, char := range pattern { - if char == '*' { - return true - } - } - - return false -} diff --git a/plugins/host_websocket_permissions_test.go b/plugins/host_websocket_permissions_test.go deleted file mode 100644 index e794ca6ad..000000000 --- a/plugins/host_websocket_permissions_test.go +++ /dev/null @@ -1,79 +0,0 @@ -package plugins - -import ( - "github.com/navidrome/navidrome/plugins/schema" - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" -) - -var _ = Describe("WebSocket Permissions", func() { - Describe("parseWebSocketPermissions", func() { - It("should parse valid WebSocket permissions", func() { - permData := &schema.PluginManifestPermissionsWebsocket{ - Reason: "Need to connect to WebSocket API", - AllowLocalNetwork: false, - AllowedUrls: []string{"wss://api.example.com/ws", "wss://cdn.example.com/*"}, - } - - perms, err := parseWebSocketPermissions(permData) - Expect(err).To(BeNil()) - Expect(perms).ToNot(BeNil()) - Expect(perms.AllowLocalNetwork).To(BeFalse()) - Expect(perms.AllowedUrls).To(Equal([]string{"wss://api.example.com/ws", "wss://cdn.example.com/*"})) - }) - - It("should fail if allowedUrls is empty", func() { - permData := &schema.PluginManifestPermissionsWebsocket{ - Reason: "Need to connect to WebSocket API", - AllowLocalNetwork: false, - AllowedUrls: []string{}, - } - - _, err := parseWebSocketPermissions(permData) - Expect(err).To(HaveOccurred()) - Expect(err.Error()).To(ContainSubstring("allowedUrls must contain at least one URL pattern")) - }) - - It("should handle wildcard patterns", func() { - permData := &schema.PluginManifestPermissionsWebsocket{ - Reason: "Need to connect to any WebSocket", - AllowLocalNetwork: true, - AllowedUrls: []string{"wss://*"}, - } - - perms, err := parseWebSocketPermissions(permData) - Expect(err).To(BeNil()) - Expect(perms.AllowLocalNetwork).To(BeTrue()) - Expect(perms.AllowedUrls).To(Equal([]string{"wss://*"})) - }) - - Context("URL matching", func() { - var perms *webSocketPermissions - - BeforeEach(func() { - permData := &schema.PluginManifestPermissionsWebsocket{ - Reason: "Need to connect to external services", - AllowLocalNetwork: true, - AllowedUrls: []string{"wss://api.example.com/*", "ws://localhost:8080"}, - } - var err error - perms, err = parseWebSocketPermissions(permData) - Expect(err).To(BeNil()) - }) - - It("should allow connections to URLs matching patterns", func() { - err := perms.IsConnectionAllowed("wss://api.example.com/v1/stream") - Expect(err).To(BeNil()) - - err = perms.IsConnectionAllowed("ws://localhost:8080") - Expect(err).To(BeNil()) - }) - - It("should deny connections to URLs not matching patterns", func() { - err := perms.IsConnectionAllowed("wss://malicious.com/stream") - Expect(err).To(HaveOccurred()) - Expect(err.Error()).To(ContainSubstring("does not match any allowed URL patterns")) - }) - }) - }) -}) diff --git a/plugins/host_websocket_test.go b/plugins/host_websocket_test.go index ecadc6463..83fca9898 100644 --- a/plugins/host_websocket_test.go +++ b/plugins/host_websocket_test.go @@ -1,231 +1,616 @@ +//go:build !windows + package plugins import ( "context" + "crypto/sha256" + + "encoding/hex" + "maps" "net/http" "net/http/httptest" + "os" + "path/filepath" "strings" "sync" - "testing" - "time" - gorillaws "github.com/gorilla/websocket" - "github.com/navidrome/navidrome/core/metrics" - "github.com/navidrome/navidrome/plugins/host/websocket" + "github.com/gorilla/websocket" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) -var _ = Describe("WebSocket Host Service", func() { +var _ = Describe("WebSocketService", Ordered, func() { var ( - wsService *websocketService - manager *managerImpl - ctx context.Context - server *httptest.Server - upgrader gorillaws.Upgrader - serverMessages []string - serverMu sync.Mutex + manager *Manager + tmpDir string + testService *testableWebSocketService ) - // WebSocket echo server handler - echoHandler := func(w http.ResponseWriter, r *http.Request) { - // Check headers - if r.Header.Get("X-Test-Header") != "test-value" { - http.Error(w, "Missing or invalid X-Test-Header", http.StatusBadRequest) - return + BeforeAll(func() { + var err error + tmpDir, err = os.MkdirTemp("", "websocket-test-*") + Expect(err).ToNot(HaveOccurred()) + + // Copy the test-websocket plugin + srcPath := filepath.Join(testdataDir, "test-websocket"+PackageExtension) + destPath := filepath.Join(tmpDir, "test-websocket"+PackageExtension) + data, err := os.ReadFile(srcPath) + Expect(err).ToNot(HaveOccurred()) + err = os.WriteFile(destPath, data, 0600) + Expect(err).ToNot(HaveOccurred()) + + // Compute SHA256 for the plugin + hash := sha256.Sum256(data) + hashHex := hex.EncodeToString(hash[:]) + + // Setup config + DeferCleanup(configtest.SetupConfig()) + conf.Server.Plugins.Enabled = true + conf.Server.Plugins.Folder = tmpDir + conf.Server.Plugins.AutoReload = false + + // Setup mock DataStore with pre-enabled plugin + mockPluginRepo := tests.CreateMockPluginRepo() + mockPluginRepo.Permitted = true + mockPluginRepo.SetData(model.Plugins{{ + ID: "test-websocket", + Path: destPath, + SHA256: hashHex, + Enabled: true, + }}) + dataStore := &tests.MockDataStore{MockedPlugin: mockPluginRepo} + + // Create and start manager + manager = &Manager{ + plugins: make(map[string]*plugin), + ds: dataStore, + subsonicRouter: http.NotFoundHandler(), + metrics: noopMetricsRecorder{}, } + err = manager.Start(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) - // Upgrade connection to WebSocket - conn, err := upgrader.Upgrade(w, r, nil) - if err != nil { - return - } - defer conn.Close() + // Get WebSocket service from plugin's closers and wrap it for testing + service := findWebSocketService(manager, "test-websocket") + Expect(service).ToNot(BeNil()) + testService = &testableWebSocketService{webSocketServiceImpl: service} - // Echo messages back - for { - mt, message, err := conn.ReadMessage() - if err != nil { - break - } - - // Store the received message for verification - if mt == gorillaws.TextMessage { - msg := string(message) - serverMu.Lock() - serverMessages = append(serverMessages, msg) - serverMu.Unlock() - } - - // Echo it back - err = conn.WriteMessage(mt, message) - if err != nil { - break - } - - // If message is "close", close the connection - if mt == gorillaws.TextMessage && string(message) == "close" { - _ = conn.WriteControl( - gorillaws.CloseMessage, - gorillaws.FormatCloseMessage(gorillaws.CloseNormalClosure, "bye"), - time.Now().Add(time.Second), - ) - break - } - } - } - - BeforeEach(func() { - ctx = context.Background() - serverMessages = make([]string, 0) - serverMu = sync.Mutex{} - - // Create a test WebSocket server - //upgrader = gorillaws.Upgrader{} - server = httptest.NewServer(http.HandlerFunc(echoHandler)) - DeferCleanup(server.Close) - - // Create a new manager and websocket service - manager = createManager(nil, metrics.NewNoopInstance()) - wsService = newWebsocketService(manager) + DeferCleanup(func() { + _ = manager.Stop() + _ = os.RemoveAll(tmpDir) + }) }) - Describe("WebSocket operations", func() { - var ( - pluginName string - connectionID string - wsURL string - ) + BeforeEach(func() { + // Clean up any connections from previous tests + testService.closeAllConnections() + }) + + Describe("Plugin Loading", func() { + It("should detect WebSocket capability", func() { + names := manager.PluginNames(string(CapabilityWebSocket)) + Expect(names).To(ContainElement("test-websocket")) + }) + + It("should register WebSocket service for plugin", func() { + service := findWebSocketService(manager, "test-websocket") + Expect(service).ToNot(BeNil()) + }) + }) + + Describe("URL Validation", func() { + It("should reject invalid URL schemes", func() { + ctx := GinkgoT().Context() + _, err := testService.Connect(ctx, "http://example.com", nil, "test-conn") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("invalid URL scheme")) + }) + + It("should reject disallowed hosts", func() { + ctx := GinkgoT().Context() + _, err := testService.Connect(ctx, "wss://evil.com/socket", nil, "test-conn") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("not allowed")) + }) + + It("should allow hosts matching wildcard patterns", func() { + // test-websocket manifest allows *.example.com + // The pattern *.example.com matches any host ending with .example.com + ctx := context.Background() + allowed := testService.isHostAllowed("api.example.com") + Expect(allowed).To(BeTrue()) + + // Deep subdomains also match (ends with .example.com) + allowed = testService.isHostAllowed("sub.api.example.com") + Expect(allowed).To(BeTrue()) + + // But exact match without subdomain doesn't match *.example.com + allowed = testService.isHostAllowed("example.com") + Expect(allowed).To(BeFalse()) + _ = ctx + }) + + It("should allow exact host matches", func() { + // test-websocket manifest allows echo.websocket.org + allowed := testService.isHostAllowed("echo.websocket.org") + Expect(allowed).To(BeTrue()) + + allowed = testService.isHostAllowed("other.org") + Expect(allowed).To(BeFalse()) + }) + + It("should strip port before checking host", func() { + // Implementation strips port before matching against patterns + // test-websocket manifest has "localhost:*" which matches "localhost" + // after port stripping + // Note: The port wildcard pattern isn't actually implemented, but + // since port is stripped, "localhost:*" is compared against "localhost" + // which won't match. To make localhost work, we'd need exact "localhost" + // in the allowed hosts list. + + // Testing that port is properly stripped + // The pattern "localhost:*" won't match "localhost" due to exact match + allowed := testService.isHostAllowed("localhost:8080") + Expect(allowed).To(BeFalse()) + }) + }) + + Describe("Connection Management", func() { + var wsServer *httptest.Server + var serverMessages []string + var serverMu sync.Mutex BeforeEach(func() { - pluginName = "test-plugin" - connectionID = "test-connection-id" - wsURL = "ws" + strings.TrimPrefix(server.URL, "http") + serverMessages = nil + + upgrader := websocket.Upgrader{ + CheckOrigin: func(r *http.Request) bool { return true }, + } + wsServer = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + conn, err := upgrader.Upgrade(w, r, nil) + if err != nil { + return + } + + // Read messages until connection closes + for { + _, msg, err := conn.ReadMessage() + if err != nil { + break + } + serverMu.Lock() + serverMessages = append(serverMessages, string(msg)) + serverMu.Unlock() + } + })) + + // Add the server's host to allowed hosts for testing + // Since the implementation strips port before matching, we need to add + // the host without port + serverURL := strings.TrimPrefix(wsServer.URL, "http://") + hostOnly := serverURL + if idx := strings.LastIndex(serverURL, ":"); idx != -1 { + hostOnly = serverURL[:idx] + } + testService.requiredHosts = append(testService.requiredHosts, hostOnly) }) - It("connects to a WebSocket server", func() { - // Connect to the WebSocket server - req := &websocket.ConnectRequest{ - Url: wsURL, - Headers: map[string]string{ - "X-Test-Header": "test-value", - }, - ConnectionId: connectionID, + AfterEach(func() { + testService.closeAllConnections() + if wsServer != nil { + wsServer.Close() } - - resp, err := wsService.connect(ctx, pluginName, req, nil) - Expect(err).ToNot(HaveOccurred()) - Expect(resp.ConnectionId).ToNot(BeEmpty()) - connectionID = resp.ConnectionId - - // Verify that the connection was added to the service - internalID := pluginName + ":" + connectionID - Expect(wsService.hasConnection(internalID)).To(BeTrue()) }) - It("sends and receives text messages", func() { - // Connect to the WebSocket server - req := &websocket.ConnectRequest{ - Url: wsURL, - Headers: map[string]string{ - "X-Test-Header": "test-value", - }, - ConnectionId: connectionID, - } - - resp, err := wsService.connect(ctx, pluginName, req, nil) + It("should connect to WebSocket server", func() { + ctx := GinkgoT().Context() + wsURL := "ws://" + strings.TrimPrefix(wsServer.URL, "http://") + connID, err := testService.Connect(ctx, wsURL, nil, "test-conn") Expect(err).ToNot(HaveOccurred()) - connectionID = resp.ConnectionId + Expect(connID).To(Equal("test-conn")) + Expect(testService.getConnectionCount()).To(Equal(1)) + }) - // Send a text message - textReq := &websocket.SendTextRequest{ - ConnectionId: connectionID, - Message: "hello websocket", - } + It("should generate connection ID when not provided", func() { + ctx := GinkgoT().Context() + wsURL := "ws://" + strings.TrimPrefix(wsServer.URL, "http://") + connID, err := testService.Connect(ctx, wsURL, nil, "") + Expect(err).ToNot(HaveOccurred()) + Expect(connID).ToNot(BeEmpty()) + }) - _, err = wsService.sendText(ctx, pluginName, textReq) + It("should reject duplicate connection IDs", func() { + ctx := GinkgoT().Context() + wsURL := "ws://" + strings.TrimPrefix(wsServer.URL, "http://") + _, err := testService.Connect(ctx, wsURL, nil, "dup-conn") Expect(err).ToNot(HaveOccurred()) - // Wait a bit for the message to be processed + _, err = testService.Connect(ctx, wsURL, nil, "dup-conn") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("already exists")) + }) + + It("should send text messages", func() { + ctx := GinkgoT().Context() + wsURL := "ws://" + strings.TrimPrefix(wsServer.URL, "http://") + connID, err := testService.Connect(ctx, wsURL, nil, "send-text-conn") + Expect(err).ToNot(HaveOccurred()) + + err = testService.SendText(ctx, connID, "hello world") + Expect(err).ToNot(HaveOccurred()) + + // Give server time to receive the message Eventually(func() []string { serverMu.Lock() defer serverMu.Unlock() return serverMessages - }, "1s").Should(ContainElement("hello websocket")) + }).Should(ContainElement("hello world")) }) - It("closes a WebSocket connection", func() { - // Connect to the WebSocket server - req := &websocket.ConnectRequest{ - Url: wsURL, - Headers: map[string]string{ - "X-Test-Header": "test-value", - }, - ConnectionId: connectionID, - } - - resp, err := wsService.connect(ctx, pluginName, req, nil) - Expect(err).ToNot(HaveOccurred()) - connectionID = resp.ConnectionId - - initialCount := wsService.connectionCount() - - // Close the connection - closeReq := &websocket.CloseRequest{ - ConnectionId: connectionID, - Code: 1000, // Normal closure - Reason: "test complete", - } - - _, err = wsService.close(ctx, pluginName, closeReq) + It("should send binary messages", func() { + ctx := GinkgoT().Context() + wsURL := "ws://" + strings.TrimPrefix(wsServer.URL, "http://") + connID, err := testService.Connect(ctx, wsURL, nil, "send-binary-conn") Expect(err).ToNot(HaveOccurred()) - // Verify that the connection was removed - Eventually(func() int { - return wsService.connectionCount() - }, "1s").Should(Equal(initialCount - 1)) + binaryData := []byte{0x00, 0x01, 0x02, 0x03} + err = testService.SendBinary(ctx, connID, binaryData) + Expect(err).ToNot(HaveOccurred()) - internalID := pluginName + ":" + connectionID - Expect(wsService.hasConnection(internalID)).To(BeFalse()) + // Give server time to receive the message + Eventually(func() []string { + serverMu.Lock() + defer serverMu.Unlock() + return serverMessages + }).Should(ContainElement(string(binaryData))) }) - It("handles connection errors gracefully", func() { - if testing.Short() { - GinkgoT().Skip("skipping test in short mode.") - } + It("should close connections", func() { + ctx := GinkgoT().Context() + wsURL := "ws://" + strings.TrimPrefix(wsServer.URL, "http://") + connID, err := testService.Connect(ctx, wsURL, nil, "close-conn") + Expect(err).ToNot(HaveOccurred()) + Expect(testService.getConnectionCount()).To(Equal(1)) - // Try to connect to an invalid URL - req := &websocket.ConnectRequest{ - Url: "ws://invalid-url-that-does-not-exist", - Headers: map[string]string{}, - ConnectionId: connectionID, - } + err = testService.CloseConnection(ctx, connID, 1000, "normal close") + Expect(err).ToNot(HaveOccurred()) + Expect(testService.getConnectionCount()).To(Equal(0)) + }) - _, err := wsService.connect(ctx, pluginName, req, nil) + It("should return error for non-existent connection", func() { + ctx := GinkgoT().Context() + err := testService.SendText(ctx, "non-existent", "message") Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("not found")) + }) + }) + + Describe("Plugin Callbacks", func() { + var wsServer *httptest.Server + var serverConn *websocket.Conn + var serverMessages []string + var serverBinaryMessages [][]byte + var serverMu sync.Mutex + + BeforeEach(func() { + serverConn = nil + serverMessages = nil + serverBinaryMessages = nil + + upgrader := websocket.Upgrader{ + CheckOrigin: func(r *http.Request) bool { return true }, + } + wsServer = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + conn, err := upgrader.Upgrade(w, r, nil) + if err != nil { + return + } + serverMu.Lock() + serverConn = conn + serverMu.Unlock() + + // Read and store messages + for { + msgType, msg, err := conn.ReadMessage() + if err != nil { + break + } + serverMu.Lock() + if msgType == websocket.BinaryMessage { + serverBinaryMessages = append(serverBinaryMessages, msg) + } else { + serverMessages = append(serverMessages, string(msg)) + } + serverMu.Unlock() + } + })) + + serverURL := strings.TrimPrefix(wsServer.URL, "http://") + hostOnly := serverURL + if idx := strings.LastIndex(serverURL, ":"); idx != -1 { + hostOnly = serverURL[:idx] + } + testService.requiredHosts = append(testService.requiredHosts, hostOnly) }) - It("returns error when attempting to use non-existent connection", func() { - // Try to send a message to a non-existent connection - textReq := &websocket.SendTextRequest{ - ConnectionId: "non-existent-connection", - Message: "this should fail", + AfterEach(func() { + testService.closeAllConnections() + if wsServer != nil { + wsServer.Close() } + }) - sendResp, err := wsService.sendText(ctx, pluginName, textReq) + It("should invoke OnBinaryMessage callback when receiving binary", func() { + ctx := GinkgoT().Context() + wsURL := "ws://" + strings.TrimPrefix(wsServer.URL, "http://") + _, err := testService.Connect(ctx, wsURL, nil, "binary-cb-conn") Expect(err).ToNot(HaveOccurred()) - Expect(sendResp.Error).To(ContainSubstring("connection not found")) - // Try to close a non-existent connection - closeReq := &websocket.CloseRequest{ - ConnectionId: "non-existent-connection", - Code: 1000, - Reason: "test complete", + // Wait for server to have the connection + Eventually(func() *websocket.Conn { + serverMu.Lock() + defer serverMu.Unlock() + return serverConn + }).ShouldNot(BeNil()) + + // Send binary message from server to plugin + binaryData := []byte{0xDE, 0xAD, 0xBE, 0xEF} + serverMu.Lock() + err = serverConn.WriteMessage(websocket.BinaryMessage, binaryData) + serverMu.Unlock() + Expect(err).ToNot(HaveOccurred()) + + // Plugin echoes binary data back as a binary message + Eventually(func() [][]byte { + serverMu.Lock() + defer serverMu.Unlock() + return serverBinaryMessages + }).Should(ContainElement(binaryData)) + }) + + It("should invoke OnClose callback when server closes connection", func() { + ctx := GinkgoT().Context() + wsURL := "ws://" + strings.TrimPrefix(wsServer.URL, "http://") + _, err := testService.Connect(ctx, wsURL, nil, "close-cb-conn") + Expect(err).ToNot(HaveOccurred()) + + // Wait for server to have the connection + Eventually(func() *websocket.Conn { + serverMu.Lock() + defer serverMu.Unlock() + return serverConn + }).ShouldNot(BeNil()) + + // Close from server side + serverMu.Lock() + _ = serverConn.WriteMessage(websocket.CloseMessage, + websocket.FormatCloseMessage(websocket.CloseNormalClosure, "goodbye")) + serverConn.Close() + serverMu.Unlock() + + // Connection should be removed after close callback + Eventually(func() int { + return testService.getConnectionCount() + }).Should(Equal(0)) + }) + }) + + Describe("Plugin Host Function Calls", func() { + var wsServer *httptest.Server + var serverConn *websocket.Conn + var serverMessages []string + var serverMu sync.Mutex + + BeforeEach(func() { + serverMessages = nil + serverConn = nil + + upgrader := websocket.Upgrader{ + CheckOrigin: func(r *http.Request) bool { return true }, } + wsServer = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + conn, err := upgrader.Upgrade(w, r, nil) + if err != nil { + return + } + serverMu.Lock() + serverConn = conn + serverMu.Unlock() - closeResp, err := wsService.close(ctx, pluginName, closeReq) + // Read and store messages + for { + _, msg, err := conn.ReadMessage() + if err != nil { + break + } + serverMu.Lock() + serverMessages = append(serverMessages, string(msg)) + serverMu.Unlock() + } + })) + + serverURL := strings.TrimPrefix(wsServer.URL, "http://") + hostOnly := serverURL + if idx := strings.LastIndex(serverURL, ":"); idx != -1 { + hostOnly = serverURL[:idx] + } + testService.requiredHosts = append(testService.requiredHosts, hostOnly) + }) + + AfterEach(func() { + testService.closeAllConnections() + if wsServer != nil { + wsServer.Close() + } + }) + + It("should allow plugin to send messages via host function", func() { + ctx := GinkgoT().Context() + wsURL := "ws://" + strings.TrimPrefix(wsServer.URL, "http://") + _, err := testService.Connect(ctx, wsURL, nil, "host-send-conn") Expect(err).ToNot(HaveOccurred()) - Expect(closeResp.Error).To(ContainSubstring("connection not found")) + + // Wait for server to have the connection + Eventually(func() *websocket.Conn { + serverMu.Lock() + defer serverMu.Unlock() + return serverConn + }).ShouldNot(BeNil()) + + // Server sends "echo" message to trigger plugin to echo back + serverMu.Lock() + err = serverConn.WriteMessage(websocket.TextMessage, []byte("echo")) + serverMu.Unlock() + Expect(err).ToNot(HaveOccurred()) + + // Plugin should have echoed back via host function + Eventually(func() []string { + serverMu.Lock() + defer serverMu.Unlock() + return serverMessages + }).Should(ContainElement("echo:echo")) + }) + + It("should allow plugin to close connection via host function", func() { + ctx := GinkgoT().Context() + wsURL := "ws://" + strings.TrimPrefix(wsServer.URL, "http://") + _, err := testService.Connect(ctx, wsURL, nil, "host-close-conn") + Expect(err).ToNot(HaveOccurred()) + Expect(testService.getConnectionCount()).To(Equal(1)) + + // Wait for server to have the connection + Eventually(func() *websocket.Conn { + serverMu.Lock() + defer serverMu.Unlock() + return serverConn + }).ShouldNot(BeNil()) + + // Server sends "close" message to trigger plugin to close connection + serverMu.Lock() + err = serverConn.WriteMessage(websocket.TextMessage, []byte("close")) + serverMu.Unlock() + Expect(err).ToNot(HaveOccurred()) + + // Connection should be closed by plugin + Eventually(func() int { + return testService.getConnectionCount() + }).Should(Equal(0)) + }) + }) + + Describe("Plugin Unload", func() { + It("should close all connections when plugin is unloaded", func() { + // Create a fresh server for this test + upgrader := websocket.Upgrader{ + CheckOrigin: func(r *http.Request) bool { return true }, + } + wsServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + conn, err := upgrader.Upgrade(w, r, nil) + if err != nil { + return + } + // Keep alive + for { + _, _, err := conn.ReadMessage() + if err != nil { + break + } + } + })) + defer wsServer.Close() + + serverURL := strings.TrimPrefix(wsServer.URL, "http://") + hostOnly := serverURL + if idx := strings.LastIndex(serverURL, ":"); idx != -1 { + hostOnly = serverURL[:idx] + } + testService.requiredHosts = append(testService.requiredHosts, hostOnly) + + ctx := GinkgoT().Context() + wsURL := "ws://" + serverURL + + // Create multiple connections + _, err := testService.Connect(ctx, wsURL, nil, "unload-conn-1") + Expect(err).ToNot(HaveOccurred()) + _, err = testService.Connect(ctx, wsURL, nil, "unload-conn-2") + Expect(err).ToNot(HaveOccurred()) + Expect(testService.getConnectionCount()).To(Equal(2)) + + // Close the service (simulates plugin unload) + err = testService.Close() + Expect(err).ToNot(HaveOccurred()) + Expect(testService.getConnectionCount()).To(Equal(0)) + }) + }) + + Describe("matchHostPattern", func() { + It("should match exact hosts", func() { + Expect(matchHostPattern("example.com", "example.com")).To(BeTrue()) + Expect(matchHostPattern("example.com", "other.com")).To(BeFalse()) + }) + + It("should match wildcard patterns", func() { + Expect(matchHostPattern("*.example.com", "api.example.com")).To(BeTrue()) + Expect(matchHostPattern("*.example.com", "example.com")).To(BeFalse()) + Expect(matchHostPattern("*.example.com", "deep.api.example.com")).To(BeTrue()) + }) + + It("should match bare '*' as allow-all", func() { + Expect(matchHostPattern("*", "anything.example.com")).To(BeTrue()) + Expect(matchHostPattern("*", "127.0.0.1")).To(BeTrue()) + Expect(matchHostPattern("*", "::1")).To(BeTrue()) + }) + + It("should not match partial patterns", func() { + Expect(matchHostPattern("*.example.com", "example.com.evil.org")).To(BeFalse()) }) }) }) + +// testableWebSocketService wraps webSocketServiceImpl with test helpers. +type testableWebSocketService struct { + *webSocketServiceImpl +} + +func (t *testableWebSocketService) getConnectionCount() int { + t.mu.RLock() + defer t.mu.RUnlock() + return len(t.connections) +} + +func (t *testableWebSocketService) closeAllConnections() { + t.mu.Lock() + conns := make(map[string]*wsConnection, len(t.connections)) + maps.Copy(conns, t.connections) + t.connections = make(map[string]*wsConnection) + t.mu.Unlock() + + for _, conn := range conns { + conn.closeMu.Lock() + conn.isClosed = true + conn.closeMu.Unlock() + _ = conn.conn.Close() + close(conn.done) + } +} + +// findWebSocketService finds the WebSocket service from a plugin's closers. +func findWebSocketService(m *Manager, pluginName string) *webSocketServiceImpl { + m.mu.RLock() + instance, ok := m.plugins[pluginName] + m.mu.RUnlock() + if !ok { + return nil + } + for _, closer := range instance.closers { + if svc, ok := closer.(*webSocketServiceImpl); ok { + return svc + } + } + return nil +} diff --git a/plugins/lyrics_adapter.go b/plugins/lyrics_adapter.go new file mode 100644 index 000000000..aa9930664 --- /dev/null +++ b/plugins/lyrics_adapter.go @@ -0,0 +1,59 @@ +package plugins + +import ( + "context" + + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/plugins/capabilities" +) + +const CapabilityLyrics Capability = "Lyrics" + +const ( + FuncLyricsGetLyrics = "nd_lyrics_get_lyrics" +) + +func init() { + registerCapability( + CapabilityLyrics, + FuncLyricsGetLyrics, + ) +} + +// LyricsPlugin adapts a WASM plugin with the Lyrics capability. +type LyricsPlugin struct { + name string + plugin *plugin +} + +// GetLyrics calls the plugin to fetch lyrics, then parses the raw text responses +// using model.ToLyrics. +func (l *LyricsPlugin) GetLyrics(ctx context.Context, mf *model.MediaFile) (model.LyricList, error) { + req := capabilities.GetLyricsRequest{ + Track: mediaFileToTrackInfo(mf), + } + resp, err := callPluginFunction[capabilities.GetLyricsRequest, capabilities.GetLyricsResponse]( + ctx, l.plugin, FuncLyricsGetLyrics, req, + ) + if err != nil { + return nil, err + } + + var result model.LyricList + for _, lt := range resp.Lyrics { + lang := lt.Lang + if lang == "" { + lang = "xxx" + } + parsed, err := model.ToLyrics(lang, lt.Text) + if err != nil { + log.Warn(ctx, "Error parsing plugin lyrics", "plugin", l.name, err) + continue + } + if parsed != nil && !parsed.IsEmpty() { + result = append(result, *parsed) + } + } + return result, nil +} diff --git a/plugins/lyrics_adapter_test.go b/plugins/lyrics_adapter_test.go new file mode 100644 index 000000000..a1a6c1809 --- /dev/null +++ b/plugins/lyrics_adapter_test.go @@ -0,0 +1,99 @@ +//go:build !windows + +package plugins + +import ( + "github.com/navidrome/navidrome/model" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("LyricsPlugin", Ordered, func() { + var ( + lyricsManager *Manager + provider *LyricsPlugin + ) + + BeforeAll(func() { + lyricsManager, _ = createTestManagerWithPlugins(nil, + "test-lyrics"+PackageExtension, + "test-metadata-agent"+PackageExtension, + ) + + p, ok := lyricsManager.LoadLyricsProvider("test-lyrics") + Expect(ok).To(BeTrue()) + provider = p.(*LyricsPlugin) + }) + + Describe("LoadLyricsProvider", func() { + It("returns a lyrics provider for a plugin with Lyrics capability", func() { + Expect(provider).ToNot(BeNil()) + }) + + It("returns false for a plugin without Lyrics capability", func() { + _, ok := lyricsManager.LoadLyricsProvider("test-metadata-agent") + Expect(ok).To(BeFalse()) + }) + + It("returns false for non-existent plugin", func() { + _, ok := lyricsManager.LoadLyricsProvider("non-existent") + Expect(ok).To(BeFalse()) + }) + }) + + Describe("GetLyrics", func() { + It("successfully returns lyrics from the plugin", func() { + track := &model.MediaFile{ + ID: "track-1", + Title: "Test Song", + Artist: "Test Artist", + } + + result, err := provider.GetLyrics(GinkgoT().Context(), track) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result[0].Line).ToNot(BeEmpty()) + Expect(result[0].Line[0].Value).To(ContainSubstring("Test Song")) + }) + + It("defaults language to 'xxx' when plugin does not provide one", func() { + manager, _ := createTestManagerWithPlugins(map[string]map[string]string{ + "test-lyrics": {"no_lang": "true"}, + }, "test-lyrics"+PackageExtension) + + p, ok := manager.LoadLyricsProvider("test-lyrics") + Expect(ok).To(BeTrue()) + + track := &model.MediaFile{ID: "track-1", Title: "Test Song", Artist: "Test Artist"} + result, err := p.GetLyrics(GinkgoT().Context(), track) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result[0].Lang).To(Equal("xxx")) + }) + + It("returns error when plugin returns error", func() { + manager, _ := createTestManagerWithPlugins(map[string]map[string]string{ + "test-lyrics": {"error": "service unavailable"}, + }, "test-lyrics"+PackageExtension) + + p, ok := manager.LoadLyricsProvider("test-lyrics") + Expect(ok).To(BeTrue()) + + track := &model.MediaFile{ID: "track-1", Title: "Test Song"} + _, err := p.GetLyrics(GinkgoT().Context(), track) + Expect(err).To(HaveOccurred()) + }) + }) + + Describe("PluginNames", func() { + It("returns plugin names with Lyrics capability", func() { + names := lyricsManager.PluginNames("Lyrics") + Expect(names).To(ContainElement("test-lyrics")) + }) + + It("does not return metadata agent plugins for Lyrics capability", func() { + names := lyricsManager.PluginNames("Lyrics") + Expect(names).ToNot(ContainElement("test-metadata-agent")) + }) + }) +}) diff --git a/plugins/manager.go b/plugins/manager.go index 35a1130fd..0c7c91ed8 100644 --- a/plugins/manager.go +++ b/plugins/manager.go @@ -1,421 +1,684 @@ package plugins -//go:generate protoc --go-plugin_out=. --go-plugin_opt=paths=source_relative api/api.proto -//go:generate protoc --go-plugin_out=. --go-plugin_opt=paths=source_relative host/http/http.proto -//go:generate protoc --go-plugin_out=. --go-plugin_opt=paths=source_relative host/config/config.proto -//go:generate protoc --go-plugin_out=. --go-plugin_opt=paths=source_relative host/websocket/websocket.proto -//go:generate protoc --go-plugin_out=. --go-plugin_opt=paths=source_relative host/scheduler/scheduler.proto -//go:generate protoc --go-plugin_out=. --go-plugin_opt=paths=source_relative host/cache/cache.proto -//go:generate protoc --go-plugin_out=. --go-plugin_opt=paths=source_relative host/artwork/artwork.proto -//go:generate protoc --go-plugin_out=. --go-plugin_opt=paths=source_relative host/subsonicapi/subsonicapi.proto - import ( + "context" + "encoding/json" "fmt" "net/http" "os" - "slices" + "path/filepath" + "runtime" "sync" "sync/atomic" "time" + "github.com/Masterminds/squirrel" + extism "github.com/extism/go-sdk" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/core/agents" - "github.com/navidrome/navidrome/core/metrics" + "github.com/navidrome/navidrome/core/lyrics" "github.com/navidrome/navidrome/core/scrobbler" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/plugins/api" - "github.com/navidrome/navidrome/plugins/schema" + "github.com/navidrome/navidrome/server/events" "github.com/navidrome/navidrome/utils/singleton" - "github.com/navidrome/navidrome/utils/slice" + "github.com/rjeczalik/notify" "github.com/tetratelabs/wazero" ) const ( - CapabilityMetadataAgent = "MetadataAgent" - CapabilityScrobbler = "Scrobbler" - CapabilitySchedulerCallback = "SchedulerCallback" - CapabilityWebSocketCallback = "WebSocketCallback" - CapabilityLifecycleManagement = "LifecycleManagement" + // defaultTimeout is the default timeout for plugin function calls + defaultTimeout = 30 * time.Second + + // maxPluginLoadConcurrency is the maximum number of plugins that can be + // compiled/loaded in parallel during startup + maxPluginLoadConcurrency = 3 ) -// pluginCreators maps capability types to their respective creator functions -type pluginConstructor func(wasmPath, pluginID string, m *managerImpl, runtime api.WazeroNewRuntime, mc wazero.ModuleConfig) WasmPlugin +// SubsonicRouter is an http.Handler that serves Subsonic API requests. +type SubsonicRouter = http.Handler -var pluginCreators = map[string]pluginConstructor{ - CapabilityMetadataAgent: newWasmMediaAgent, - CapabilityScrobbler: newWasmScrobblerPlugin, - CapabilitySchedulerCallback: newWasmSchedulerCallback, - CapabilityWebSocketCallback: newWasmWebSocketCallback, +// PluginMetricsRecorder is an interface for recording plugin metrics. +// This is satisfied by core/metrics.Metrics but defined here to avoid import cycles. +type PluginMetricsRecorder interface { + RecordPluginRequest(ctx context.Context, plugin, method string, ok bool, elapsed int64) } -// WasmPlugin is the base interface that all WASM plugins implement -type WasmPlugin interface { - // PluginID returns the unique identifier of the plugin (folder name) - PluginID() string +// Manager manages loading and lifecycle of WebAssembly plugins. +// It implements both agents.PluginLoader and scrobbler.PluginLoader interfaces. +type Manager struct { + mu sync.RWMutex + plugins map[string]*plugin + ctx context.Context + cancel context.CancelFunc + cache wazero.CompilationCache + stopped atomic.Bool // Set to true when Stop() is called + loadWg sync.WaitGroup // Tracks in-flight plugin load operations + + // File watcher fields (used when AutoReload is enabled) + watcherEvents chan notify.EventInfo + watcherDone chan struct{} + debounceTimers map[string]*time.Timer + debounceMu sync.Mutex + + // SubsonicAPI host function dependencies (set once before Start, not modified after) + subsonicRouter SubsonicRouter + ds model.DataStore + broker events.Broker + metrics PluginMetricsRecorder } -type plugin struct { - ID string - Path string - Capabilities []string - WasmPath string - Manifest *schema.PluginManifest // Loaded manifest - Runtime api.WazeroNewRuntime - ModConfig wazero.ModuleConfig - compilationReady chan struct{} - compilationErr error -} - -func (p *plugin) waitForCompilation() error { - timeout := pluginCompilationTimeout() - select { - case <-p.compilationReady: - case <-time.After(timeout): - err := fmt.Errorf("timed out waiting for plugin %s to compile", p.ID) - log.Error("Timed out waiting for plugin compilation", "name", p.ID, "path", p.WasmPath, "timeout", timeout, "err", err) - return err - } - if p.compilationErr != nil { - log.Error("Failed to compile plugin", "name", p.ID, "path", p.WasmPath, p.compilationErr) - } - return p.compilationErr -} - -type SubsonicRouter http.Handler - -type Manager interface { - SetSubsonicRouter(router SubsonicRouter) - EnsureCompiled(name string) error - PluginList() map[string]schema.PluginManifest - PluginNames(capability string) []string - LoadPlugin(name string, capability string) WasmPlugin - LoadMediaAgent(name string) (agents.Interface, bool) - LoadScrobbler(name string) (scrobbler.Scrobbler, bool) - ScanPlugins() -} - -// managerImpl is a singleton that manages plugins -type managerImpl struct { - plugins map[string]*plugin // Map of plugin folder name to plugin info - pluginsMu sync.RWMutex // Protects plugins map - subsonicRouter atomic.Pointer[SubsonicRouter] // Subsonic API router - schedulerService *schedulerService // Service for handling scheduled tasks - websocketService *websocketService // Service for handling WebSocket connections - lifecycle *pluginLifecycleManager // Manages plugin lifecycle and initialization - adapters map[string]WasmPlugin // Map of plugin folder name + capability to adapter - ds model.DataStore // DataStore for accessing persistent data - metrics metrics.Metrics -} - -// GetManager returns the singleton instance of managerImpl -func GetManager(ds model.DataStore, metrics metrics.Metrics) Manager { - if !conf.Server.Plugins.Enabled { - return &noopManager{} - } - return singleton.GetInstance(func() *managerImpl { - return createManager(ds, metrics) +// GetManager returns a singleton instance of the plugin manager. +// The manager is not started automatically; call Start() to begin loading plugins. +func GetManager(ds model.DataStore, broker events.Broker, m PluginMetricsRecorder) *Manager { + return singleton.GetInstance(func() *Manager { + return &Manager{ + ds: ds, + broker: broker, + metrics: m, + plugins: make(map[string]*plugin), + } }) } -// createManager creates a new managerImpl instance. Used in tests -func createManager(ds model.DataStore, metrics metrics.Metrics) *managerImpl { - m := &managerImpl{ - plugins: make(map[string]*plugin), - lifecycle: newPluginLifecycleManager(metrics), - ds: ds, - metrics: metrics, - } - - // Create the host services - m.schedulerService = newSchedulerService(m) - m.websocketService = newWebsocketService(m) - - return m -} - -// SetSubsonicRouter sets the SubsonicRouter after managerImpl initialization -func (m *managerImpl) SetSubsonicRouter(router SubsonicRouter) { - m.subsonicRouter.Store(&router) -} - -// registerPlugin adds a plugin to the registry with the given parameters -// Used internally by ScanPlugins to register plugins -func (m *managerImpl) registerPlugin(pluginID, pluginDir, wasmPath string, manifest *schema.PluginManifest) *plugin { - // Create custom runtime function - customRuntime := m.createRuntime(pluginID, manifest.Permissions) - - // Configure module and determine plugin name - mc := newWazeroModuleConfig() - - // Check if it's a symlink, indicating development mode - isSymlink := false - if fileInfo, err := os.Lstat(pluginDir); err == nil { - isSymlink = fileInfo.Mode()&os.ModeSymlink != 0 - } - - // Store plugin info - p := &plugin{ - ID: pluginID, - Path: pluginDir, - Capabilities: slice.Map(manifest.Capabilities, func(cap schema.PluginManifestCapabilitiesElem) string { return string(cap) }), - WasmPath: wasmPath, - Manifest: manifest, - Runtime: customRuntime, - ModConfig: mc, - compilationReady: make(chan struct{}), - } - - // Register the plugin first - m.pluginsMu.Lock() - m.plugins[pluginID] = p - - // Register one plugin adapter for each capability - for _, capability := range manifest.Capabilities { - capabilityStr := string(capability) - constructor := pluginCreators[capabilityStr] - if constructor == nil { - // Warn about unknown capabilities, except for LifecycleManagement (it does not have an adapter) - if capability != CapabilityLifecycleManagement { - log.Warn("Unknown plugin capability type", "capability", capability, "plugin", pluginID) - } - continue - } - adapter := constructor(wasmPath, pluginID, m, customRuntime, mc) - if adapter == nil { - log.Error("Failed to create plugin adapter", "plugin", pluginID, "capability", capabilityStr, "path", wasmPath) - continue - } - m.adapters[pluginID+"_"+capabilityStr] = adapter - } - m.pluginsMu.Unlock() - - log.Info("Discovered plugin", "folder", pluginID, "name", manifest.Name, "capabilities", manifest.Capabilities, "wasm", wasmPath, "dev_mode", isSymlink) - return m.plugins[pluginID] -} - -// initializePluginIfNeeded calls OnInit on plugins that implement LifecycleManagement -func (m *managerImpl) initializePluginIfNeeded(plugin *plugin) { - // Skip if already initialized - if m.lifecycle.isInitialized(plugin) { +// sendPluginRefreshEvent broadcasts a refresh event for the plugin resource. +// This notifies connected UI clients that plugin data has changed. +func (m *Manager) sendPluginRefreshEvent(ctx context.Context, pluginIDs ...string) { + if m.broker == nil { return } - - // Check if the plugin implements LifecycleManagement - if slices.Contains(plugin.Manifest.Capabilities, CapabilityLifecycleManagement) { - if err := m.lifecycle.callOnInit(plugin); err != nil { - m.unregisterPlugin(plugin.ID) - } - } + event := (&events.RefreshResource{}).With("plugin", pluginIDs...) + m.broker.SendBroadcastMessage(ctx, event) } -// unregisterPlugin removes a plugin from the manager -func (m *managerImpl) unregisterPlugin(pluginID string) { - m.pluginsMu.Lock() - defer m.pluginsMu.Unlock() - - plugin, ok := m.plugins[pluginID] - if !ok { - return - } - - // Clear initialization state from lifecycle manager - m.lifecycle.clearInitialized(plugin) - - // Unregister plugin adapters - for _, capability := range plugin.Manifest.Capabilities { - delete(m.adapters, pluginID+"_"+string(capability)) - } - - // Unregister plugin - delete(m.plugins, pluginID) - log.Info("Unregistered plugin", "plugin", pluginID) +// SetSubsonicRouter sets the Subsonic router for SubsonicAPI host functions. +// This should be called after the subsonic router is created but before plugins +// that require SubsonicAPI access are loaded. +func (m *Manager) SetSubsonicRouter(router SubsonicRouter) { + m.subsonicRouter = router } -// ScanPlugins scans the plugins directory, discovers all valid plugins, and registers them for use. -func (m *managerImpl) ScanPlugins() { - // Clear existing plugins - m.pluginsMu.Lock() - m.plugins = make(map[string]*plugin) - m.adapters = make(map[string]WasmPlugin) - m.pluginsMu.Unlock() +// Start initializes the plugin manager and loads plugins from the configured folder. +// It should be called once during application startup when plugins are enabled. +// The startup flow is: +// 1. Sync plugins folder with DB (discover new, update changed, remove deleted) +// 2. Load only enabled plugins from DB +func (m *Manager) Start(ctx context.Context) error { + if !conf.Server.Plugins.Enabled { + log.Debug(ctx, "Plugin system is disabled") + return nil + } - // Get plugins directory from config - root := conf.Server.Plugins.Folder - log.Debug("Scanning plugins folder", "root", root) + if m.subsonicRouter == nil { + log.Fatal(ctx, "Plugin manager requires DataStore to be configured") + } - // Fail fast if the compilation cache cannot be initialized - _, err := getCompilationCache() + // Set extism log level based on plugin-specific config or global log level + pluginLogLevel := conf.Server.Plugins.LogLevel + if pluginLogLevel == "" { + pluginLogLevel = conf.Server.LogLevel + } + extism.SetLogLevel(toExtismLogLevel(log.ParseLogLevel(pluginLogLevel))) + + m.ctx, m.cancel = context.WithCancel(ctx) + + // Initialize wazero compilation cache for better performance + cacheDir := filepath.Join(conf.Server.CacheFolder, "plugins") + purgeCacheBySize(ctx, cacheDir, conf.Server.Plugins.CacheSize) + + var err error + m.cache, err = wazero.NewCompilationCacheWithDir(cacheDir) if err != nil { - log.Error("Failed to initialize plugins compilation cache. Disabling plugins", err) - return + log.Error(ctx, "Failed to create wazero compilation cache", err) + return fmt.Errorf("creating wazero compilation cache: %w", err) } - // Discover all plugins using the shared discovery function - discoveries := DiscoverPlugins(root) + folder := conf.Server.Plugins.Folder + if folder == "" { + log.Debug(ctx, "No plugins folder configured") + return nil + } - var validPluginNames []string - var registeredPlugins []*plugin - for _, discovery := range discoveries { - if discovery.Error != nil { - // Handle global errors (like directory read failure) - if discovery.ID == "" { - log.Error("Plugin discovery failed", discovery.Error) - return - } - // Handle individual plugin errors - log.Error("Failed to process plugin", "plugin", discovery.ID, discovery.Error) - continue - } + // Create plugins folder if it doesn't exist + if err := os.MkdirAll(folder, 0755); err != nil { + log.Error(ctx, "Failed to create plugins folder", "folder", folder, err) + return fmt.Errorf("creating plugins folder: %w", err) + } - // Log discovery details - log.Debug("Processing entry", "name", discovery.ID, "isSymlink", discovery.IsSymlink) - if discovery.IsSymlink { - log.Debug("Processing symlinked plugin directory", "name", discovery.ID, "target", discovery.Path) - } - log.Debug("Checking for plugin.wasm", "wasmPath", discovery.WasmPath) - log.Debug("Manifest loaded successfully", "folder", discovery.ID, "name", discovery.Manifest.Name, "capabilities", discovery.Manifest.Capabilities) + log.Info(ctx, "Starting plugin manager", "folder", folder) - validPluginNames = append(validPluginNames, discovery.ID) + // Clear previous error states so plugins can be retried on restart + adminCtx := adminContext(ctx) + if err := m.ds.Plugin(adminCtx).ClearErrors(); err != nil { + log.Error(ctx, "Error clearing plugin errors", err) + } - // Register the plugin - plugin := m.registerPlugin(discovery.ID, discovery.Path, discovery.WasmPath, discovery.Manifest) - if plugin != nil { - registeredPlugins = append(registeredPlugins, plugin) + // Sync plugins folder with DB + if err := m.syncPlugins(ctx, folder); err != nil { + log.Error(ctx, "Error syncing plugins with DB", err) + // Continue - we can still try to load plugins + } + + // Load enabled plugins from DB + if err := m.loadEnabledPlugins(ctx); err != nil { + log.Error(ctx, "Error loading enabled plugins", err) + return fmt.Errorf("loading enabled plugins: %w", err) + } + + // Start file watcher if auto-reload is enabled + if conf.Server.Plugins.AutoReload { + if err := m.startWatcher(); err != nil { + log.Error(ctx, "Failed to start plugin file watcher", err) + // Non-fatal - plugins are still loaded, just no auto-reload } } - // Start background processing for all registered plugins after registration is complete - // This avoids race conditions between registration and goroutines that might unregister plugins - for _, p := range registeredPlugins { - go func(plugin *plugin) { - precompilePlugin(plugin) - // Check if this plugin implements InitService and hasn't been initialized yet - m.initializePluginIfNeeded(plugin) - }(p) - } - - log.Debug("Found valid plugins", "count", len(validPluginNames), "plugins", validPluginNames) + return nil } -// PluginList returns a map of all registered plugins with their manifests -func (m *managerImpl) PluginList() map[string]schema.PluginManifest { - m.pluginsMu.RLock() - defer m.pluginsMu.RUnlock() +// Stop shuts down the plugin manager and releases all resources. +func (m *Manager) Stop() error { + // Mark as stopped first to prevent new operations + m.stopped.Store(true) - // Create a map to hold the plugin manifests - pluginList := make(map[string]schema.PluginManifest, len(m.plugins)) + // Cancel context to signal all goroutines to stop + if m.cancel != nil { + m.cancel() + } + + // Stop file watcher + m.stopWatcher() + + // Wait for all in-flight plugin load operations to complete + // This is critical to avoid races with cache.Close() + m.loadWg.Wait() + + m.mu.Lock() + defer m.mu.Unlock() + + // Close all plugins for name, plugin := range m.plugins { - // Use the plugin ID as the key and the manifest as the value - pluginList[name] = *plugin.Manifest + err := plugin.Close() + if err != nil { + log.Error("Error during plugin cleanup", "plugin", name, err) + } + if plugin.compiled != nil { + if err := plugin.compiled.Close(context.Background()); err != nil { + log.Error("Error closing plugin", "plugin", name, err) + } + } } - return pluginList + m.plugins = make(map[string]*plugin) + + // Close compilation cache + if m.cache != nil { + if err := m.cache.Close(context.Background()); err != nil { + log.Error("Error closing wazero cache", err) + } + m.cache = nil + } + + return nil } -// PluginNames returns the folder names of all plugins that implement the specified capability -func (m *managerImpl) PluginNames(capability string) []string { - m.pluginsMu.RLock() - defer m.pluginsMu.RUnlock() +// PluginNames returns the names of all plugins that implement a particular capability. +// This is used by both agents and scrobbler systems to discover available plugins. +// Capabilities are auto-detected from the plugin's exported functions. +func (m *Manager) PluginNames(capability string) []string { + m.mu.RLock() + defer m.mu.RUnlock() var names []string + cap := Capability(capability) for name, plugin := range m.plugins { - for _, c := range plugin.Manifest.Capabilities { - if string(c) == capability { - names = append(names, name) - break - } + if hasCapability(plugin.capabilities, cap) { + names = append(names, name) } } return names } -func (m *managerImpl) getPlugin(name string, capability string) (*plugin, WasmPlugin, error) { - m.pluginsMu.RLock() - defer m.pluginsMu.RUnlock() - info, infoOk := m.plugins[name] - adapter, adapterOk := m.adapters[name+"_"+capability] - - if !infoOk { - return nil, nil, fmt.Errorf("plugin not registered: %s", name) - } - if !adapterOk { - return nil, nil, fmt.Errorf("plugin adapter not registered: %s, capability: %s", name, capability) - } - return info, adapter, nil -} - -// LoadPlugin instantiates and returns a plugin by folder name -func (m *managerImpl) LoadPlugin(name string, capability string) WasmPlugin { - info, adapter, err := m.getPlugin(name, capability) - if err != nil { - log.Warn("Error loading plugin", err) - return nil - } - - log.Debug("Loading plugin", "name", name, "path", info.Path) - - // Wait for the plugin to be ready before using it. - if err := info.waitForCompilation(); err != nil { - log.Error("Plugin is not ready, cannot be loaded", "plugin", name, "capability", capability, "err", err) - return nil - } - - if adapter == nil { - log.Warn("Plugin adapter not found", "name", name, "capability", capability) - return nil - } - return adapter -} - -// EnsureCompiled waits for a plugin to finish compilation and returns any compilation error. -// This is useful when you need to wait for compilation without loading a specific capability, -// such as during plugin refresh operations or health checks. -func (m *managerImpl) EnsureCompiled(name string) error { - m.pluginsMu.RLock() +// LoadMediaAgent loads and returns a media agent plugin by name. +// Returns false if the plugin is not found or doesn't have the MetadataAgent capability. +func (m *Manager) LoadMediaAgent(name string) (agents.Interface, bool) { + m.mu.RLock() plugin, ok := m.plugins[name] - m.pluginsMu.RUnlock() + m.mu.RUnlock() + if !ok || !hasCapability(plugin.capabilities, CapabilityMetadataAgent) { + return nil, false + } + + // Create a new metadata agent adapter for this plugin + return &MetadataAgent{ + name: plugin.name, + plugin: plugin, + }, true +} + +// LoadScrobbler loads and returns a scrobbler plugin by name. +// Returns false if the plugin is not found or doesn't have the Scrobbler capability. +func (m *Manager) LoadScrobbler(name string) (scrobbler.Scrobbler, bool) { + m.mu.RLock() + plugin, ok := m.plugins[name] + m.mu.RUnlock() + + if !ok || !hasCapability(plugin.capabilities, CapabilityScrobbler) { + return nil, false + } + + // Build user ID map for fast lookups + userIDMap := make(map[string]struct{}) + for _, id := range plugin.allowedUserIDs { + userIDMap[id] = struct{}{} + } + + // Create a new scrobbler adapter for this plugin with user authorization config + return &ScrobblerPlugin{ + name: plugin.name, + plugin: plugin, + allowedUserIDs: plugin.allowedUserIDs, + allUsers: plugin.allUsers, + userIDMap: userIDMap, + }, true +} + +// LoadLyricsProvider loads and returns a lyrics provider plugin by name. +func (m *Manager) LoadLyricsProvider(name string) (lyrics.Lyrics, bool) { + m.mu.RLock() + plugin, ok := m.plugins[name] + m.mu.RUnlock() + + if !ok || !hasCapability(plugin.capabilities, CapabilityLyrics) { + return nil, false + } + + return &LyricsPlugin{ + name: plugin.name, + plugin: plugin, + }, true +} + +// PluginInfo contains basic information about a plugin for metrics/insights. +type PluginInfo struct { + Name string + Version string +} + +// GetPluginInfo returns information about all loaded plugins. +func (m *Manager) GetPluginInfo() map[string]PluginInfo { + m.mu.RLock() + defer m.mu.RUnlock() + + info := make(map[string]PluginInfo, len(m.plugins)) + for name, plugin := range m.plugins { + info[name] = PluginInfo{ + Name: plugin.manifest.Name, + Version: plugin.manifest.Version, + } + } + return info +} + +// EnablePlugin enables a plugin by loading it and updating the DB. +// Returns an error if the plugin is not found in DB or fails to load. +func (m *Manager) EnablePlugin(ctx context.Context, id string) error { + if m.ds == nil { + return fmt.Errorf("datastore not configured") + } + + adminCtx := adminContext(ctx) + repo := m.ds.Plugin(adminCtx) + + plugin, err := repo.Get(id) + if err != nil { + return fmt.Errorf("getting plugin from DB: %w", err) + } + + if plugin.Enabled { + return nil // Already enabled + } + + // Check permission gates before enabling + if err := m.checkPermissionGates(plugin); err != nil { + return err + } + + // Try to load the plugin + if err := m.loadPluginWithConfig(plugin); err != nil { + // Store error and return + plugin.LastError = err.Error() + plugin.UpdatedAt = time.Now() + _ = repo.Put(plugin) + return fmt.Errorf("loading plugin: %w", err) + } + + // Update DB + plugin.Enabled = true + plugin.LastError = "" + plugin.UpdatedAt = time.Now() + if err := repo.Put(plugin); err != nil { + // Unload since we couldn't update DB + _ = m.unloadPlugin(id) + return fmt.Errorf("updating plugin in DB: %w", err) + } + + log.Info(ctx, "Enabled plugin", "plugin", id) + m.sendPluginRefreshEvent(ctx, id) + return nil +} + +// DisablePlugin disables a plugin by unloading it and updating the DB. +// Returns an error if the plugin is not found in DB. +func (m *Manager) DisablePlugin(ctx context.Context, id string) error { + if m.ds == nil { + return fmt.Errorf("datastore not configured") + } + + adminCtx := adminContext(ctx) + repo := m.ds.Plugin(adminCtx) + + plugin, err := repo.Get(id) + if err != nil { + return fmt.Errorf("getting plugin from DB: %w", err) + } + + if !plugin.Enabled { + return nil // Already disabled + } + + // Unload the plugin + if err := m.unloadPlugin(id); err != nil { + log.Debug(ctx, "Plugin was not loaded", "plugin", id) + } + + // Update DB + plugin.Enabled = false + plugin.UpdatedAt = time.Now() + if err := repo.Put(plugin); err != nil { + return fmt.Errorf("updating plugin in DB: %w", err) + } + + log.Info(ctx, "Disabled plugin", "plugin", id) + m.sendPluginRefreshEvent(ctx, id) + return nil +} + +// ValidatePluginConfig validates a config JSON string against the plugin's config schema. +// If the plugin has no config schema defined, it returns an error. +// Returns nil if validation passes, or an error describing the validation failure. +func (m *Manager) ValidatePluginConfig(ctx context.Context, id, configJSON string) error { + if m.ds == nil { + return fmt.Errorf("datastore not configured") + } + + adminCtx := adminContext(ctx) + repo := m.ds.Plugin(adminCtx) + + plugin, err := repo.Get(id) + if err != nil { + return fmt.Errorf("getting plugin from DB: %w", err) + } + + manifest, err := readManifest(plugin.Path) + if err != nil { + return fmt.Errorf("reading manifest: %w", err) + } + + return ValidateConfig(manifest, configJSON) +} + +// UpdatePluginConfig updates the configuration for a plugin. +// If the plugin is enabled, it will be reloaded with the new config. +func (m *Manager) UpdatePluginConfig(ctx context.Context, id, configJSON string) error { + return m.updatePluginSettings(ctx, id, func(p *model.Plugin) { + p.Config = configJSON + }) +} + +// UpdatePluginUsers updates the users permission settings for a plugin. +// If the plugin is enabled, it will be reloaded with the new settings. +// If the plugin requires users permission and no users are configured (and allUsers is false), +// the plugin will be automatically disabled. +func (m *Manager) UpdatePluginUsers(ctx context.Context, id, usersJSON string, allUsers bool) error { + return m.updatePluginSettings(ctx, id, func(p *model.Plugin) { + p.Users = usersJSON + p.AllUsers = allUsers + }) +} + +// UpdatePluginLibraries updates the libraries permission settings for a plugin. +// If the plugin is enabled, it will be reloaded with the new settings. +// If the plugin requires library permission and no libraries are configured (and allLibraries is false), +// the plugin will be automatically disabled. +func (m *Manager) UpdatePluginLibraries(ctx context.Context, id, librariesJSON string, allLibraries, allowWriteAccess bool) error { + return m.updatePluginSettings(ctx, id, func(p *model.Plugin) { + p.Libraries = librariesJSON + p.AllLibraries = allLibraries + p.AllowWriteAccess = allowWriteAccess + }) +} + +// RescanPlugins triggers a manual rescan of the plugins folder. +// This synchronizes the database with the filesystem, discovering new plugins, +// updating changed ones, and removing deleted ones. +func (m *Manager) RescanPlugins(ctx context.Context) error { + folder := conf.Server.Plugins.Folder + if folder == "" { + return fmt.Errorf("plugins folder not configured") + } + log.Info(ctx, "Manual plugin rescan requested", "folder", folder) + return m.syncPlugins(ctx, folder) +} + +// updatePluginSettings is a common implementation for updating plugin settings. +// The updateFn is called to apply the specific field updates to the plugin. +// If the plugin is enabled, it will be reloaded. If users permission is required +// but no longer satisfied, the plugin will be disabled. +func (m *Manager) updatePluginSettings(ctx context.Context, id string, updateFn func(*model.Plugin)) error { + if m.ds == nil { + return fmt.Errorf("datastore not configured") + } + + adminCtx := adminContext(ctx) + repo := m.ds.Plugin(adminCtx) + + plugin, err := repo.Get(id) + if err != nil { + return fmt.Errorf("getting plugin from DB: %w", err) + } + + wasEnabled := plugin.Enabled + + // Apply the specific updates + updateFn(plugin) + plugin.UpdatedAt = time.Now() + + // Check if plugin requires permission and if it's still satisfied + shouldDisable := false + disableReason := "" + if wasEnabled { + manifest, err := readManifest(plugin.Path) + if err == nil && manifest.Permissions != nil { + if manifest.Permissions.Users != nil && !hasValidUsersConfig(plugin.Users, plugin.AllUsers) { + shouldDisable = true + disableReason = "users permission removal" + } + if manifest.Permissions.Library != nil && !hasValidLibrariesConfig(plugin.Libraries, plugin.AllLibraries) { + shouldDisable = true + disableReason = "library permission removal" + } + } + } + + if shouldDisable { + // Disable the plugin since permission is no longer satisfied + if err := m.unloadPlugin(id); err != nil { + log.Debug(ctx, "Plugin was not loaded", "plugin", id) + } + plugin.Enabled = false + if err := repo.Put(plugin); err != nil { + return fmt.Errorf("updating plugin in DB: %w", err) + } + log.Info(ctx, "Disabled plugin due to "+disableReason, "plugin", id) + m.sendPluginRefreshEvent(ctx, id) + return nil + } + + if err := repo.Put(plugin); err != nil { + return fmt.Errorf("updating plugin in DB: %w", err) + } + + // Reload if enabled + if wasEnabled { + if err := m.unloadPlugin(id); err != nil { + log.Debug(ctx, "Plugin was not loaded", "plugin", id) + } + if err := m.loadPluginWithConfig(plugin); err != nil { + plugin.LastError = err.Error() + plugin.Enabled = false + _ = repo.Put(plugin) + return fmt.Errorf("reloading plugin: %w", err) + } + } + + log.Info(ctx, "Updated plugin settings", "plugin", id) + m.sendPluginRefreshEvent(ctx, id) + return nil +} + +// unloadPlugin removes a plugin from the manager and closes its resources. +// Returns an error if the plugin is not found. +func (m *Manager) unloadPlugin(name string) error { + m.mu.Lock() + plugin, ok := m.plugins[name] if !ok { - return fmt.Errorf("plugin not found: %s", name) + m.mu.Unlock() + return fmt.Errorf("plugin %q not found", name) + } + delete(m.plugins, name) + m.mu.Unlock() + + // Run cleanup functions + err := plugin.Close() + if err != nil { + log.Error("Error during plugin cleanup", "plugin", name, err) } - return plugin.waitForCompilation() -} - -// LoadMediaAgent instantiates and returns a media agent plugin by folder name -func (m *managerImpl) LoadMediaAgent(name string) (agents.Interface, bool) { - plugin := m.LoadPlugin(name, CapabilityMetadataAgent) - if plugin == nil { - return nil, false + // Close the compiled plugin outside the lock with a grace period + // to allow in-flight requests to complete + if plugin.compiled != nil { + // Use a brief timeout for cleanup + ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) + defer cancel() + if err := plugin.compiled.Close(ctx); err != nil { + log.Error("Error closing plugin during unload", "plugin", name, err) + } } - agent, ok := plugin.(*wasmMediaAgent) - return agent, ok + + runtime.GC() + log.Info(m.ctx, "Unloaded plugin", "plugin", name) + return nil } -// LoadScrobbler instantiates and returns a scrobbler plugin by folder name -func (m *managerImpl) LoadScrobbler(name string) (scrobbler.Scrobbler, bool) { - plugin := m.LoadPlugin(name, CapabilityScrobbler) - if plugin == nil { - return nil, false +// UnloadDisabledPlugins checks for plugins that are disabled in the database +// but still loaded in memory, and unloads them. This is called after user or +// library deletion to clean up plugins that were auto-disabled due to +// permission loss. +func (m *Manager) UnloadDisabledPlugins(ctx context.Context) { + if m.ds == nil { + return + } + + adminCtx := adminContext(ctx) + repo := m.ds.Plugin(adminCtx) + + // Get all disabled plugins from the database + plugins, err := repo.GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"enabled": false}, + }) + if err != nil { + log.Error(ctx, "Failed to get disabled plugins", err) + return + } + + // Check each disabled plugin and unload if still in memory + var unloaded []string + for _, p := range plugins { + m.mu.RLock() + _, loaded := m.plugins[p.ID] + m.mu.RUnlock() + + if loaded { + if err := m.unloadPlugin(p.ID); err != nil { + log.Warn(ctx, "Failed to unload disabled plugin", "plugin", p.ID, err) + } else { + unloaded = append(unloaded, p.ID) + log.Info(ctx, "Unloaded disabled plugin", "plugin", p.ID) + } + } + } + + // Send refresh events for unloaded plugins + if len(unloaded) > 0 { + m.sendPluginRefreshEvent(ctx, unloaded...) } - s, ok := plugin.(scrobbler.Scrobbler) - return s, ok } -type noopManager struct{} +// checkPermissionGates validates that all permission-based requirements are met +// before a plugin can be enabled. Returns an error if any gate condition fails. +func (m *Manager) checkPermissionGates(p *model.Plugin) error { + // Parse manifest to check permissions + manifest, err := readManifest(p.Path) + if err != nil { + return fmt.Errorf("reading manifest: %w", err) + } -func (n noopManager) SetSubsonicRouter(router SubsonicRouter) {} + // Check users permission gate + if manifest.Permissions != nil && manifest.Permissions.Users != nil { + if !hasValidUsersConfig(p.Users, p.AllUsers) { + return fmt.Errorf("users permission requires configuration: select users or enable 'all users' access") + } + } -func (n noopManager) EnsureCompiled(name string) error { return nil } + // Check library permission gate + if manifest.Permissions != nil && manifest.Permissions.Library != nil { + if !hasValidLibrariesConfig(p.Libraries, p.AllLibraries) { + return fmt.Errorf("library permission requires configuration: select libraries or enable 'all libraries' access") + } + } -func (n noopManager) PluginList() map[string]schema.PluginManifest { return nil } + return nil +} -func (n noopManager) PluginNames(capability string) []string { return nil } +// hasValidUsersConfig checks if a plugin has valid users configuration. +// Returns true if allUsers is true, or if usersJSON contains at least one user. +func hasValidUsersConfig(usersJSON string, allUsers bool) bool { + if allUsers { + return true + } + if usersJSON == "" { + return false + } + var users []string + if err := json.Unmarshal([]byte(usersJSON), &users); err != nil { + return false + } + return len(users) > 0 +} -func (n noopManager) LoadPlugin(name string, capability string) WasmPlugin { return nil } - -func (n noopManager) LoadMediaAgent(name string) (agents.Interface, bool) { return nil, false } - -func (n noopManager) LoadScrobbler(name string) (scrobbler.Scrobbler, bool) { return nil, false } - -func (n noopManager) ScanPlugins() {} +// hasValidLibrariesConfig checks if a plugin has valid libraries configuration. +// Returns true if allLibraries is true, or if librariesJSON contains at least one library. +func hasValidLibrariesConfig(librariesJSON string, allLibraries bool) bool { + if allLibraries { + return true + } + if librariesJSON == "" { + return false + } + var libraries []int + if err := json.Unmarshal([]byte(librariesJSON), &libraries); err != nil { + return false + } + return len(libraries) > 0 +} diff --git a/plugins/manager_cache.go b/plugins/manager_cache.go new file mode 100644 index 000000000..74b27171f --- /dev/null +++ b/plugins/manager_cache.go @@ -0,0 +1,92 @@ +package plugins + +import ( + "cmp" + "context" + "io/fs" + "os" + "path/filepath" + "slices" + "time" + + "github.com/dustin/go-humanize" + "github.com/navidrome/navidrome/log" +) + +// purgeCacheBySize removes the oldest files in dir until its total size is +// lower than or equal to maxSize. maxSize should be a human-readable string +// like "10MB" or "200K". If parsing fails or maxSize is "0", the function is +// a no-op. +func purgeCacheBySize(ctx context.Context, dir, maxSize string) { + sizeLimit, err := humanize.ParseBytes(maxSize) + if err != nil || sizeLimit == 0 { + return + } + + type fileInfo struct { + path string + size uint64 + mod int64 + } + + var files []fileInfo + var total uint64 + + walk := func(path string, d fs.DirEntry, err error) error { + if err != nil { + log.Trace(ctx, "Failed to access plugin cache entry", "path", path, err) + return nil //nolint:nilerr + } + if d.IsDir() { + return nil + } + info, err := d.Info() + if err != nil { + log.Trace(ctx, "Failed to get file info for plugin cache entry", "path", path, err) + return nil //nolint:nilerr + } + files = append(files, fileInfo{ + path: path, + size: uint64(info.Size()), + mod: info.ModTime().UnixMilli(), + }) + total += uint64(info.Size()) + return nil + } + + if err := filepath.WalkDir(dir, walk); err != nil { + if !os.IsNotExist(err) { + log.Warn(ctx, "Failed to traverse plugin cache directory", "path", dir, err) + } + return + } + + log.Trace(ctx, "Current plugin cache size", "path", dir, "size", humanize.Bytes(total), "sizeLimit", humanize.Bytes(sizeLimit)) + if total <= sizeLimit { + return + } + + log.Debug(ctx, "Purging plugin cache", "path", dir, "sizeLimit", humanize.Bytes(sizeLimit), "currentSize", humanize.Bytes(total)) + slices.SortFunc(files, func(i, j fileInfo) int { return cmp.Compare(i.mod, j.mod) }) + + for _, f := range files { + if total <= sizeLimit { + break + } + if err := os.Remove(f.path); err != nil { + log.Warn(ctx, "Failed to remove plugin cache entry", "path", f.path, "size", humanize.Bytes(f.size), err) + continue + } + total -= f.size + log.Debug(ctx, "Removed plugin cache entry", "path", f.path, "size", humanize.Bytes(f.size), "time", time.UnixMilli(f.mod), "remainingSize", humanize.Bytes(total)) + + // Remove empty parent directories + dirPath := filepath.Dir(f.path) + for dirPath != dir { + if err := os.Remove(dirPath); err != nil { + break + } + dirPath = filepath.Dir(dirPath) + } + } +} diff --git a/plugins/manager_cache_test.go b/plugins/manager_cache_test.go new file mode 100644 index 000000000..f985fcd84 --- /dev/null +++ b/plugins/manager_cache_test.go @@ -0,0 +1,187 @@ +package plugins + +import ( + "context" + "os" + "path/filepath" + "time" + + "github.com/dustin/go-humanize" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("purgeCacheBySize", func() { + var ( + tmpDir string + ctx context.Context + ) + + BeforeEach(func() { + var err error + ctx = GinkgoT().Context() + tmpDir, err = os.MkdirTemp("", "cache-purge-test-*") + Expect(err).ToNot(HaveOccurred()) + }) + + AfterEach(func() { + os.RemoveAll(tmpDir) + }) + + createFileWithSize := func(path string, sizeBytes int64, modTime time.Time) { + dir := filepath.Dir(path) + err := os.MkdirAll(dir, 0755) + Expect(err).ToNot(HaveOccurred()) + + f, err := os.Create(path) + Expect(err).ToNot(HaveOccurred()) + defer f.Close() + + // Write random data to reach desired size + if sizeBytes > 0 { + err = f.Truncate(sizeBytes) + Expect(err).ToNot(HaveOccurred()) + } + + // Set modification time + err = os.Chtimes(path, modTime, modTime) + Expect(err).ToNot(HaveOccurred()) + } + + getDirSize := func(dir string) uint64 { + var total uint64 + err := filepath.WalkDir(dir, func(path string, d os.DirEntry, err error) error { + if err != nil || d.IsDir() { + return nil + } + info, err := d.Info() + if err != nil { + return nil + } + total += uint64(info.Size()) + return nil + }) + Expect(err).ToNot(HaveOccurred()) + return total + } + + Context("when maxSize is invalid or zero", func() { + It("should not remove any files with invalid size", func() { + cacheDir := filepath.Join(tmpDir, "cache") + createFileWithSize(filepath.Join(cacheDir, "file1.bin"), 1000, time.Now()) + createFileWithSize(filepath.Join(cacheDir, "file2.bin"), 1000, time.Now()) + + purgeCacheBySize(ctx, cacheDir, "invalid") + + Expect(getDirSize(cacheDir)).To(Equal(uint64(2000))) + }) + + It("should not remove any files when maxSize is 0", func() { + cacheDir := filepath.Join(tmpDir, "cache") + createFileWithSize(filepath.Join(cacheDir, "file1.bin"), 1000, time.Now()) + createFileWithSize(filepath.Join(cacheDir, "file2.bin"), 1000, time.Now()) + + purgeCacheBySize(ctx, cacheDir, "0") + + Expect(getDirSize(cacheDir)).To(Equal(uint64(2000))) + }) + }) + + Context("when cache directory doesn't exist", func() { + It("should not error", func() { + nonExistentDir := filepath.Join(tmpDir, "nonexistent") + Expect(func() { + purgeCacheBySize(ctx, nonExistentDir, "100MB") + }).ToNot(Panic()) + }) + }) + + Context("when total size is under limit", func() { + It("should not remove any files", func() { + cacheDir := filepath.Join(tmpDir, "cache") + createFileWithSize(filepath.Join(cacheDir, "file1.bin"), 1000, time.Now()) + createFileWithSize(filepath.Join(cacheDir, "file2.bin"), 1000, time.Now()) + + purgeCacheBySize(ctx, cacheDir, "10KB") + + Expect(getDirSize(cacheDir)).To(Equal(uint64(2000))) + }) + }) + + Context("when total size exceeds limit", func() { + It("should remove oldest files first", func() { + cacheDir := filepath.Join(tmpDir, "cache") + now := time.Now() + + // Create files with different ages (1MB each) + oldestFile := filepath.Join(cacheDir, "old.bin") + middleFile := filepath.Join(cacheDir, "middle.bin") + newestFile := filepath.Join(cacheDir, "new.bin") + + createFileWithSize(oldestFile, 1*1024*1024, now.Add(-3*time.Hour)) + createFileWithSize(middleFile, 1*1024*1024, now.Add(-2*time.Hour)) + createFileWithSize(newestFile, 1*1024*1024, now.Add(-1*time.Hour)) + + // Set limit to 2MiB - should remove oldest file + purgeCacheBySize(ctx, cacheDir, "2MiB") + + // Oldest should be removed + _, err := os.Stat(oldestFile) + Expect(os.IsNotExist(err)).To(BeTrue(), "oldest file should be removed") + + // Others should remain + _, err = os.Stat(middleFile) + Expect(err).ToNot(HaveOccurred(), "middle file should remain") + + _, err = os.Stat(newestFile) + Expect(err).ToNot(HaveOccurred(), "newest file should remain") + }) + + It("should remove multiple files to get under limit", func() { + cacheDir := filepath.Join(tmpDir, "cache") + now := time.Now() + + // Create 5 files, 1MiB each (total 5MiB) + for i := range 5 { + path := filepath.Join(cacheDir, filepath.Join("dir", "file"+string(rune('0'+i))+".bin")) + createFileWithSize(path, 1*1024*1024, now.Add(-time.Duration(5-i)*time.Hour)) + } + + // Set limit to 2.5MiB - should remove oldest 3 files (leaving 2MiB) + purgeCacheBySize(ctx, cacheDir, "2.5MiB") + + finalSize := getDirSize(cacheDir) + limit, _ := humanize.ParseBytes("2.5MiB") + Expect(finalSize).To(BeNumerically("<=", limit)) + }) + + It("should remove empty parent directories after removing files", func() { + cacheDir := filepath.Join(tmpDir, "cache") + now := time.Now() + + // Create files in subdirectories + oldFile := filepath.Join(cacheDir, "subdir1", "old.bin") + newFile := filepath.Join(cacheDir, "subdir2", "new.bin") + + createFileWithSize(oldFile, 2*1024*1024, now.Add(-2*time.Hour)) + createFileWithSize(newFile, 2*1024*1024, now.Add(-1*time.Hour)) + + // Set limit to 2MiB - should remove old file and its parent dir + purgeCacheBySize(ctx, cacheDir, "2MiB") + + // Old file and its parent dir should be removed + _, err := os.Stat(oldFile) + Expect(os.IsNotExist(err)).To(BeTrue()) + + _, err = os.Stat(filepath.Join(cacheDir, "subdir1")) + Expect(os.IsNotExist(err)).To(BeTrue(), "empty parent directory should be removed") + + // New file and its parent dir should remain + _, err = os.Stat(newFile) + Expect(err).ToNot(HaveOccurred()) + + _, err = os.Stat(filepath.Join(cacheDir, "subdir2")) + Expect(err).ToNot(HaveOccurred()) + }) + }) +}) diff --git a/plugins/manager_call.go b/plugins/manager_call.go new file mode 100644 index 000000000..b5c7536b6 --- /dev/null +++ b/plugins/manager_call.go @@ -0,0 +1,124 @@ +package plugins + +import ( + "context" + "encoding/json" + "errors" + "fmt" + "time" + + extism "github.com/extism/go-sdk" + "github.com/navidrome/navidrome/log" +) + +var errFunctionNotFound = errors.New("function not found") +var errNotImplemented = errors.New("function not implemented") + +// notImplementedCode is the standard return code from plugin PDKs +// indicating a function exists but is not implemented by this plugin. +// The plugin returns -2 as int32, which becomes 0xFFFFFFFE as uint32. +const notImplementedCode uint32 = 0xFFFFFFFE + +// callPluginFunctionNoInput is a helper to call a plugin function with no input and output. +func callPluginFunctionNoInput(ctx context.Context, plugin *plugin, funcName string) error { + _, err := callPluginFunction[struct{}, struct{}](ctx, plugin, funcName, struct{}{}) + return err +} + +// callPluginFunctionNoOutput is a helper to call a plugin function with input and no output. +func callPluginFunctionNoOutput[I any](ctx context.Context, plugin *plugin, funcName string, input I) error { + _, err := callPluginFunction[I, struct{}](ctx, plugin, funcName, input) + return err +} + +// callPluginFunction is a helper to call a plugin function with input and output types. +// It handles JSON marshalling/unmarshalling and error checking. +// The context is used for cancellation - if cancelled during the call, the plugin +// instance will be terminated and context.Canceled or context.DeadlineExceeded will be returned. +func callPluginFunction[I any, O any](ctx context.Context, plugin *plugin, funcName string, input I) (O, error) { + start := time.Now() + + var result O + + // Create plugin instance with context for cancellation support + p, err := plugin.instance(ctx) + if err != nil { + return result, fmt.Errorf("failed to create plugin: %w", err) + } + defer p.Close(ctx) + + if !p.FunctionExists(funcName) { + log.Trace(ctx, "Plugin function not found", "plugin", plugin.name, "function", funcName) + return result, fmt.Errorf("%w: %s", errFunctionNotFound, funcName) + } + + inputBytes, err := json.Marshal(input) + if err != nil { + return result, fmt.Errorf("failed to marshal input: %w", err) + } + + startCall := time.Now() + exit, output, err := p.CallWithContext(ctx, funcName, inputBytes) + elapsed := time.Since(startCall) + if err != nil { + // If context was cancelled, return that error instead of the plugin error + if ctx.Err() != nil { + log.Debug(ctx, "Plugin call cancelled", "plugin", plugin.name, "function", funcName, "pluginDuration", elapsed) + return result, ctx.Err() + } + plugin.metrics.RecordPluginRequest(ctx, plugin.name, funcName, false, elapsed.Milliseconds()) + log.Trace(ctx, "Plugin call failed", "plugin", plugin.name, "function", funcName, "pluginDuration", elapsed, "navidromeDuration", startCall.Sub(start), err) + return result, fmt.Errorf("plugin call failed: %w", err) + } + if exit != 0 { + if exit == notImplementedCode { + log.Trace(ctx, "Plugin function not implemented", "plugin", plugin.name, "function", funcName, "pluginDuration", elapsed, "navidromeDuration", startCall.Sub(start)) + // TODO Should we record metrics for not implemented calls? + //plugin.metrics.RecordPluginRequest(ctx, plugin.name, funcName, true, elapsed.Milliseconds()) + return result, fmt.Errorf("%w: %s", errNotImplemented, funcName) + } + plugin.metrics.RecordPluginRequest(ctx, plugin.name, funcName, false, elapsed.Milliseconds()) + return result, fmt.Errorf("plugin call exited with code %d", exit) + } + + if len(output) > 0 { + err = json.Unmarshal(output, &result) + if err != nil { + log.Trace(ctx, "Plugin call failed", "plugin", plugin.name, "function", funcName, "pluginDuration", elapsed, "navidromeDuration", startCall.Sub(start), err) + } + } + + // Record metrics for successful calls (or JSON unmarshal failures) + plugin.metrics.RecordPluginRequest(ctx, plugin.name, funcName, err == nil, elapsed.Milliseconds()) + + log.Trace(ctx, "Plugin call succeeded", "plugin", plugin.name, "function", funcName, "pluginDuration", time.Since(startCall), "navidromeDuration", startCall.Sub(start)) + return result, err +} + +// extismLogger is a helper to log messages from Extism plugins +func extismLogger(pluginName string) func(level extism.LogLevel, msg string) { + return func(level extism.LogLevel, msg string) { + if level == extism.LogLevelOff { + return + } + log.Log(log.ParseLogLevel(level.String()), msg, "plugin", pluginName) + } +} + +// toExtismLogLevel converts a Navidrome log level to an extism LogLevel +func toExtismLogLevel(level log.Level) extism.LogLevel { + switch level { + case log.LevelTrace: + return extism.LogLevelTrace + case log.LevelDebug: + return extism.LogLevelDebug + case log.LevelInfo: + return extism.LogLevelInfo + case log.LevelWarn: + return extism.LogLevelWarn + case log.LevelError, log.LevelFatal: + return extism.LogLevelError + default: + return extism.LogLevelInfo + } +} diff --git a/plugins/manager_call_test.go b/plugins/manager_call_test.go new file mode 100644 index 000000000..3e64f1cee --- /dev/null +++ b/plugins/manager_call_test.go @@ -0,0 +1,146 @@ +//go:build !windows + +package plugins + +import ( + "context" + "sync" + + "github.com/navidrome/navidrome/core/agents" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +// mockMetricsRecorder tracks calls to RecordPluginRequest for testing +type mockMetricsRecorder struct { + mu sync.Mutex + calls []metricsCall +} + +type metricsCall struct { + plugin string + method string + ok bool + elapsed int64 +} + +func (m *mockMetricsRecorder) RecordPluginRequest(_ context.Context, plugin, method string, ok bool, elapsed int64) { + m.mu.Lock() + defer m.mu.Unlock() + m.calls = append(m.calls, metricsCall{plugin: plugin, method: method, ok: ok, elapsed: elapsed}) +} + +func (m *mockMetricsRecorder) getCalls() []metricsCall { + m.mu.Lock() + defer m.mu.Unlock() + return append([]metricsCall{}, m.calls...) +} + +func (m *mockMetricsRecorder) reset() { + m.mu.Lock() + defer m.mu.Unlock() + m.calls = nil +} + +var _ = Describe("callPluginFunction metrics", Ordered, func() { + var ( + metricsManager *Manager + metricsRecorder *mockMetricsRecorder + agent agents.Interface + ) + + BeforeAll(func() { + metricsRecorder = &mockMetricsRecorder{} + + // Create a manager with the metrics recorder + metricsManager, _ = createTestManagerWithPluginsAndMetrics( + nil, + metricsRecorder, + "test-metadata-agent"+PackageExtension, + ) + + var ok bool + agent, ok = metricsManager.LoadMediaAgent("test-metadata-agent") + Expect(ok).To(BeTrue()) + }) + + BeforeEach(func() { + metricsRecorder.reset() + }) + + It("records metrics for successful plugin calls", func() { + retriever := agent.(agents.ArtistBiographyRetriever) + _, err := retriever.GetArtistBiography(GinkgoT().Context(), "artist-1", "Test Artist", "mbid") + Expect(err).ToNot(HaveOccurred()) + + calls := metricsRecorder.getCalls() + Expect(calls).To(HaveLen(1)) + Expect(calls[0].plugin).To(Equal("test-metadata-agent")) + Expect(calls[0].method).To(Equal(FuncGetArtistBiography)) + Expect(calls[0].ok).To(BeTrue()) + Expect(calls[0].elapsed).To(BeNumerically(">=", 0)) + }) + + Context("with error config", Ordered, func() { + var ( + errorRecorder *mockMetricsRecorder + errorAgent agents.Interface + ) + + BeforeAll(func() { + errorRecorder = &mockMetricsRecorder{} + errorManager, _ := createTestManagerWithPluginsAndMetrics( + map[string]map[string]string{ + "test-metadata-agent": {"error": "simulated error"}, + }, + errorRecorder, + "test-metadata-agent"+PackageExtension, + ) + + var ok bool + errorAgent, ok = errorManager.LoadMediaAgent("test-metadata-agent") + Expect(ok).To(BeTrue()) + }) + + It("records metrics for failed plugin calls (error returned)", func() { + retriever := errorAgent.(agents.ArtistBiographyRetriever) + _, err := retriever.GetArtistBiography(GinkgoT().Context(), "artist-1", "Test Artist", "mbid") + Expect(err).To(HaveOccurred()) + + calls := errorRecorder.getCalls() + Expect(calls).To(HaveLen(1)) + Expect(calls[0].plugin).To(Equal("test-metadata-agent")) + Expect(calls[0].method).To(Equal(FuncGetArtistBiography)) + Expect(calls[0].ok).To(BeFalse()) + }) + }) + + Context("with partial metadata agent", Ordered, func() { + var ( + partialRecorder *mockMetricsRecorder + partialAgent agents.Interface + ) + + BeforeAll(func() { + partialRecorder = &mockMetricsRecorder{} + partialManager, _ := createTestManagerWithPluginsAndMetrics( + nil, + partialRecorder, + "partial-metadata-agent"+PackageExtension, + ) + + var ok bool + partialAgent, ok = partialManager.LoadMediaAgent("partial-metadata-agent") + Expect(ok).To(BeTrue()) + }) + + It("does not record metrics for not-implemented functions", func() { + retriever := partialAgent.(agents.ArtistMBIDRetriever) + _, err := retriever.GetArtistMBID(GinkgoT().Context(), "artist-1", "Test Artist") + Expect(err).To(MatchError(errNotImplemented)) + + calls := partialRecorder.getCalls() + Expect(calls).To(HaveLen(0)) + }) + }) +}) diff --git a/plugins/manager_loader.go b/plugins/manager_loader.go new file mode 100644 index 000000000..59f48453f --- /dev/null +++ b/plugins/manager_loader.go @@ -0,0 +1,450 @@ +package plugins + +import ( + "context" + "encoding/json" + "fmt" + "io" + "time" + + extism "github.com/extism/go-sdk" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/plugins/host" + "github.com/navidrome/navidrome/scheduler" + "github.com/tetratelabs/wazero" + "github.com/tetratelabs/wazero/api" + "github.com/tetratelabs/wazero/experimental" + "golang.org/x/sync/errgroup" +) + +// serviceContext provides dependencies needed by host service factories. +type serviceContext struct { + pluginName string + manager *Manager + permissions *Permissions + config map[string]string + allowedUsers []string // User IDs this plugin can access + allUsers bool // If true, plugin can access all users + allowedLibraries []int // Library IDs this plugin can access + allLibraries bool // If true, plugin can access all libraries +} + +// hostServiceEntry defines a host service for table-driven registration. +type hostServiceEntry struct { + name string + hasPermission func(*Permissions) bool + create func(*serviceContext) ([]extism.HostFunction, io.Closer) +} + +// hostServices defines all available host services. +// Adding a new host service only requires adding an entry here. +var hostServices = []hostServiceEntry{ + { + name: "Config", + hasPermission: func(p *Permissions) bool { return true }, // Always available, no permission required + create: func(ctx *serviceContext) ([]extism.HostFunction, io.Closer) { + service := newConfigService(ctx.pluginName, ctx.config) + return host.RegisterConfigHostFunctions(service), nil + }, + }, + { + name: "SubsonicAPI", + hasPermission: func(p *Permissions) bool { return p != nil && p.Subsonicapi != nil }, + create: func(ctx *serviceContext) ([]extism.HostFunction, io.Closer) { + service := newSubsonicAPIService(ctx.pluginName, ctx.manager.subsonicRouter, ctx.manager.ds, ctx.allowedUsers, ctx.allUsers) + return host.RegisterSubsonicAPIHostFunctions(service), nil + }, + }, + { + name: "Scheduler", + hasPermission: func(p *Permissions) bool { return p != nil && p.Scheduler != nil }, + create: func(ctx *serviceContext) ([]extism.HostFunction, io.Closer) { + service := newSchedulerService(ctx.pluginName, ctx.manager, scheduler.GetInstance()) + return host.RegisterSchedulerHostFunctions(service), service + }, + }, + { + name: "WebSocket", + hasPermission: func(p *Permissions) bool { return p != nil && p.Websocket != nil }, + create: func(ctx *serviceContext) ([]extism.HostFunction, io.Closer) { + perm := ctx.permissions.Websocket + service := newWebSocketService(ctx.pluginName, ctx.manager, perm) + return host.RegisterWebSocketHostFunctions(service), service + }, + }, + { + name: "Artwork", + hasPermission: func(p *Permissions) bool { return p != nil && p.Artwork != nil }, + create: func(ctx *serviceContext) ([]extism.HostFunction, io.Closer) { + service := newArtworkService() + return host.RegisterArtworkHostFunctions(service), nil + }, + }, + { + name: "Cache", + hasPermission: func(p *Permissions) bool { return p != nil && p.Cache != nil }, + create: func(ctx *serviceContext) ([]extism.HostFunction, io.Closer) { + service := newCacheService(ctx.pluginName) + return host.RegisterCacheHostFunctions(service), service + }, + }, + { + name: "Library", + hasPermission: func(p *Permissions) bool { return p != nil && p.Library != nil }, + create: func(ctx *serviceContext) ([]extism.HostFunction, io.Closer) { + perm := ctx.permissions.Library + service := newLibraryService(ctx.manager.ds, perm, ctx.allowedLibraries, ctx.allLibraries) + return host.RegisterLibraryHostFunctions(service), nil + }, + }, + { + name: "KVStore", + hasPermission: func(p *Permissions) bool { return p != nil && p.Kvstore != nil }, + create: func(ctx *serviceContext) ([]extism.HostFunction, io.Closer) { + perm := ctx.permissions.Kvstore + service, err := newKVStoreService(ctx.manager.ctx, ctx.pluginName, perm) + if err != nil { + log.Error("Failed to create KVStore service", "plugin", ctx.pluginName, err) + return nil, nil + } + return host.RegisterKVStoreHostFunctions(service), service + }, + }, + { + name: "Users", + hasPermission: func(p *Permissions) bool { return p != nil && p.Users != nil }, + create: func(ctx *serviceContext) ([]extism.HostFunction, io.Closer) { + service := newUsersService(ctx.manager.ds, ctx.allowedUsers, ctx.allUsers) + return host.RegisterUsersHostFunctions(service), nil + }, + }, + { + name: "HTTP", + hasPermission: func(p *Permissions) bool { return p != nil && p.Http != nil }, + create: func(ctx *serviceContext) ([]extism.HostFunction, io.Closer) { + perm := ctx.permissions.Http + service := newHTTPService(ctx.pluginName, perm) + return host.RegisterHTTPHostFunctions(service), nil + }, + }, + { + name: "Task", + hasPermission: func(p *Permissions) bool { return p != nil && p.Taskqueue != nil }, + create: func(ctx *serviceContext) ([]extism.HostFunction, io.Closer) { + perm := ctx.permissions.Taskqueue + maxConcurrency := int32(1) + if perm.MaxConcurrency > 0 { + maxConcurrency = int32(perm.MaxConcurrency) + } + service, err := newTaskQueueService(ctx.pluginName, ctx.manager, maxConcurrency) + if err != nil { + log.Error("Failed to create Task service", "plugin", ctx.pluginName, err) + return nil, nil + } + return host.RegisterTaskHostFunctions(service), service + }, + }, +} + +// extractManifest reads manifest from an .ndp package and computes its SHA-256 hash. +// This is a lightweight operation used for plugin discovery and change detection. +// Unlike the old implementation, this does NOT compile the wasm - just reads the manifest JSON. +func (m *Manager) extractManifest(ndpPath string) (*PluginMetadata, error) { + if m.stopped.Load() { + return nil, fmt.Errorf("manager is stopped") + } + + manifest, err := readManifest(ndpPath) + if err != nil { + return nil, err + } + + sha256Hash, err := computeFileSHA256(ndpPath) + if err != nil { + return nil, fmt.Errorf("computing hash: %w", err) + } + + return &PluginMetadata{ + Manifest: manifest, + SHA256: sha256Hash, + }, nil +} + +// loadEnabledPlugins loads all enabled plugins from the database. +func (m *Manager) loadEnabledPlugins(ctx context.Context) error { + if m.ds == nil { + return fmt.Errorf("datastore not configured") + } + + adminCtx := adminContext(ctx) + repo := m.ds.Plugin(adminCtx) + + plugins, err := repo.GetAll() + if err != nil { + return fmt.Errorf("reading plugins from DB: %w", err) + } + + g := errgroup.Group{} + g.SetLimit(maxPluginLoadConcurrency) + + for _, p := range plugins { + if !p.Enabled { + continue + } + + plugin := p // Capture for goroutine + g.Go(func() error { + start := time.Now() + log.Debug(ctx, "Loading enabled plugin", "plugin", plugin.ID, "path", plugin.Path) + + // Panic recovery + defer func() { + if r := recover(); r != nil { + log.Error(ctx, "Panic while loading plugin", "plugin", plugin.ID, "panic", r) + } + }() + + if err := m.loadPluginWithConfig(&plugin); err != nil { + // Store error in DB + plugin.LastError = err.Error() + plugin.Enabled = false + plugin.UpdatedAt = time.Now() + if putErr := repo.Put(&plugin); putErr != nil { + log.Error(ctx, "Failed to update plugin error in DB", "plugin", plugin.ID, putErr) + } + log.Error(ctx, "Failed to load plugin", "plugin", plugin.ID, err) + return nil + } + + // Clear any previous error + if plugin.LastError != "" { + plugin.LastError = "" + plugin.UpdatedAt = time.Now() + if putErr := repo.Put(&plugin); putErr != nil { + log.Error(ctx, "Failed to clear plugin error in DB", "plugin", plugin.ID, putErr) + } + } + + m.mu.RLock() + loadedPlugin := m.plugins[plugin.ID] + m.mu.RUnlock() + if loadedPlugin != nil { + log.Info(ctx, "Loaded plugin", "plugin", plugin.ID, "manifest", loadedPlugin.manifest.Name, + "capabilities", loadedPlugin.capabilities, "duration", time.Since(start)) + } + return nil + }) + } + + return g.Wait() +} + +// loadPluginWithConfig loads a plugin with configuration from DB. +// The p.Path should point to an .ndp package file. +func (m *Manager) loadPluginWithConfig(p *model.Plugin) error { + ctx := log.NewContext(m.ctx, "plugin", p.ID) + + if m.stopped.Load() { + return fmt.Errorf("manager is stopped") + } + + // Track this operation + m.loadWg.Add(1) + defer m.loadWg.Done() + + if m.stopped.Load() { + return fmt.Errorf("manager is stopped") + } + + // Parse config from JSON + pluginConfig, err := parsePluginConfig(p.Config) + if err != nil { + return err + } + + // Parse users from JSON + var allowedUsers []string + if p.Users != "" { + if err := json.Unmarshal([]byte(p.Users), &allowedUsers); err != nil { + return fmt.Errorf("parsing plugin users: %w", err) + } + } + + // Parse libraries from JSON + var allowedLibraries []int + if p.Libraries != "" { + if err := json.Unmarshal([]byte(p.Libraries), &allowedLibraries); err != nil { + return fmt.Errorf("parsing plugin libraries: %w", err) + } + } + + // Open the .ndp package to get manifest and wasm bytes + pkg, err := openPackage(p.Path) + if err != nil { + return fmt.Errorf("opening package: %w", err) + } + + // Build extism manifest + pluginManifest := extism.Manifest{ + Wasm: []extism.Wasm{ + extism.WasmData{Data: pkg.WasmBytes, Name: "main"}, + }, + Config: pluginConfig, + Timeout: uint64(defaultTimeout.Milliseconds()), + } + + if pkg.Manifest.Permissions != nil && pkg.Manifest.Permissions.Http != nil { + if hosts := pkg.Manifest.Permissions.Http.RequiredHosts; len(hosts) > 0 { + pluginManifest.AllowedHosts = hosts + } + } + + // Configure filesystem access for library permission + if pkg.Manifest.Permissions != nil && pkg.Manifest.Permissions.Library != nil && pkg.Manifest.Permissions.Library.Filesystem { + adminCtx := adminContext(ctx) + libraries, err := m.ds.Library(adminCtx).GetAll() + if err != nil { + return fmt.Errorf("failed to get libraries for filesystem access: %w", err) + } + + allowedPaths := buildAllowedPaths(ctx, libraries, allowedLibraries, p.AllLibraries, p.AllowWriteAccess) + pluginManifest.AllowedPaths = allowedPaths + } + + // Build host functions based on permissions from manifest + var hostFunctions []extism.HostFunction + var closers []io.Closer + + svcCtx := &serviceContext{ + pluginName: p.ID, + manager: m, + permissions: pkg.Manifest.Permissions, + config: pluginConfig, + allowedUsers: allowedUsers, + allUsers: p.AllUsers, + allowedLibraries: allowedLibraries, + allLibraries: p.AllLibraries, + } + for _, entry := range hostServices { + if entry.hasPermission(pkg.Manifest.Permissions) { + funcs, closer := entry.create(svcCtx) + hostFunctions = append(hostFunctions, funcs...) + if closer != nil { + closers = append(closers, closer) + } + } + } + + // Compile the plugin with all host functions + runtimeConfig := wazero.NewRuntimeConfig(). + WithCompilationCache(m.cache). + WithCloseOnContextDone(true) + + // Enable experimental threads if requested in manifest + if pkg.Manifest.HasExperimentalThreads() { + runtimeConfig = runtimeConfig.WithCoreFeatures(api.CoreFeaturesV2 | experimental.CoreFeaturesThreads) + log.Debug(ctx, "Enabling experimental threads support") + } + + extismConfig := extism.PluginConfig{ + EnableWasi: true, + RuntimeConfig: runtimeConfig, + EnableHttpResponseHeaders: true, + } + compiled, err := extism.NewCompiledPlugin(ctx, pluginManifest, extismConfig, hostFunctions) + if err != nil { + return fmt.Errorf("compiling plugin: %w", err) + } + + // Create instance to detect capabilities + instance, err := compiled.Instance(ctx, extism.PluginInstanceConfig{}) + if err != nil { + compiled.Close(ctx) + return fmt.Errorf("creating instance: %w", err) + } + instance.SetLogger(extismLogger(p.ID)) + capabilities := detectCapabilities(instance) + instance.Close(ctx) + + // Validate manifest against detected capabilities + if err := ValidateWithCapabilities(pkg.Manifest, capabilities); err != nil { + compiled.Close(ctx) + return fmt.Errorf("manifest validation: %w", err) + } + + m.mu.Lock() + m.plugins[p.ID] = &plugin{ + name: p.ID, + path: p.Path, + manifest: pkg.Manifest, + compiled: compiled, + capabilities: capabilities, + closers: closers, + metrics: m.metrics, + allowedUserIDs: allowedUsers, + allUsers: p.AllUsers, + } + m.mu.Unlock() + + // Call plugin init function + callPluginInit(ctx, m.plugins[p.ID]) + + return nil +} + +// parsePluginConfig parses a JSON config string into a map of string values. +// For Extism, all config values must be strings, so non-string values are serialized as JSON. +func parsePluginConfig(configJSON string) (map[string]string, error) { + if configJSON == "" { + return nil, nil + } + var rawConfig map[string]any + if err := json.Unmarshal([]byte(configJSON), &rawConfig); err != nil { + return nil, fmt.Errorf("parsing plugin config: %w", err) + } + pluginConfig := make(map[string]string) + for key, value := range rawConfig { + switch v := value.(type) { + case string: + pluginConfig[key] = v + default: + // Serialize non-string values as JSON + jsonBytes, err := json.Marshal(v) + if err != nil { + return nil, fmt.Errorf("serializing config value %q: %w", key, err) + } + pluginConfig[key] = string(jsonBytes) + } + } + return pluginConfig, nil +} + +// buildAllowedPaths constructs the extism AllowedPaths map for filesystem access. +// When allowWriteAccess is false (default), paths are prefixed with "ro:" for read-only. +// Only libraries that match the allowed set (or all libraries if allLibraries is true) are included. +func buildAllowedPaths(ctx context.Context, libraries model.Libraries, allowedLibraryIDs []int, allLibraries, allowWriteAccess bool) map[string]string { + allowedLibrarySet := make(map[int]struct{}, len(allowedLibraryIDs)) + for _, id := range allowedLibraryIDs { + allowedLibrarySet[id] = struct{}{} + } + allowedPaths := make(map[string]string) + for _, lib := range libraries { + _, allowed := allowedLibrarySet[lib.ID] + if allLibraries || allowed { + mountPoint := toPluginMountPoint(int32(lib.ID)) + hostPath := lib.Path + if !allowWriteAccess { + hostPath = "ro:" + hostPath + } + allowedPaths[hostPath] = mountPoint + log.Trace(ctx, "Added library to allowed paths", "libraryID", lib.ID, "mountPoint", mountPoint, "writeAccess", allowWriteAccess, "hostPath", hostPath) + } + } + if allowWriteAccess { + log.Info(ctx, "Granting read-write filesystem access to libraries", "libraryCount", len(allowedPaths), "allLibraries", allLibraries) + } else { + log.Debug(ctx, "Granting read-only filesystem access to libraries", "libraryCount", len(allowedPaths), "allLibraries", allLibraries) + } + return allowedPaths +} diff --git a/plugins/manager_loader_test.go b/plugins/manager_loader_test.go new file mode 100644 index 000000000..3a00b07b7 --- /dev/null +++ b/plugins/manager_loader_test.go @@ -0,0 +1,124 @@ +//go:build !windows + +package plugins + +import ( + "github.com/navidrome/navidrome/model" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("parsePluginConfig", func() { + It("returns nil for empty string", func() { + result, err := parsePluginConfig("") + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(BeNil()) + }) + + It("serializes object values as JSON strings", func() { + result, err := parsePluginConfig(`{"settings": {"enabled": true, "count": 5}}`) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result["settings"]).To(Equal(`{"count":5,"enabled":true}`)) + }) + + It("handles mixed value types", func() { + result, err := parsePluginConfig(`{"api_key": "secret", "timeout": 30, "rate": 1.5, "enabled": true, "tags": ["a", "b"]}`) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(5)) + Expect(result["api_key"]).To(Equal("secret")) + Expect(result["timeout"]).To(Equal("30")) + Expect(result["rate"]).To(Equal("1.5")) + Expect(result["enabled"]).To(Equal("true")) + Expect(result["tags"]).To(Equal(`["a","b"]`)) + }) + + It("returns error for invalid JSON", func() { + _, err := parsePluginConfig(`{invalid json}`) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("parsing plugin config")) + }) + + It("returns error for non-object JSON", func() { + _, err := parsePluginConfig(`["array", "not", "object"]`) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("parsing plugin config")) + }) + + It("handles null values", func() { + result, err := parsePluginConfig(`{"key": null}`) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result["key"]).To(Equal("null")) + }) + + It("handles empty object", func() { + result, err := parsePluginConfig(`{}`) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(0)) + Expect(result).ToNot(BeNil()) + }) +}) + +var _ = Describe("buildAllowedPaths", func() { + var libraries model.Libraries + + BeforeEach(func() { + libraries = model.Libraries{ + {ID: 1, Path: "/music/library1"}, + {ID: 2, Path: "/music/library2"}, + {ID: 3, Path: "/music/library3"}, + } + }) + + Context("read-only (default)", func() { + It("mounts all libraries with ro: prefix when allLibraries is true", func() { + result := buildAllowedPaths(nil, libraries, nil, true, false) + Expect(result).To(HaveLen(3)) + Expect(result).To(HaveKeyWithValue("ro:/music/library1", "/libraries/1")) + Expect(result).To(HaveKeyWithValue("ro:/music/library2", "/libraries/2")) + Expect(result).To(HaveKeyWithValue("ro:/music/library3", "/libraries/3")) + }) + + It("mounts only selected libraries with ro: prefix", func() { + result := buildAllowedPaths(nil, libraries, []int{1, 3}, false, false) + Expect(result).To(HaveLen(2)) + Expect(result).To(HaveKeyWithValue("ro:/music/library1", "/libraries/1")) + Expect(result).To(HaveKeyWithValue("ro:/music/library3", "/libraries/3")) + Expect(result).ToNot(HaveKey("ro:/music/library2")) + }) + }) + + Context("read-write (allowWriteAccess=true)", func() { + It("mounts all libraries without ro: prefix when allLibraries is true", func() { + result := buildAllowedPaths(nil, libraries, nil, true, true) + Expect(result).To(HaveLen(3)) + Expect(result).To(HaveKeyWithValue("/music/library1", "/libraries/1")) + Expect(result).To(HaveKeyWithValue("/music/library2", "/libraries/2")) + Expect(result).To(HaveKeyWithValue("/music/library3", "/libraries/3")) + }) + + It("mounts only selected libraries without ro: prefix", func() { + result := buildAllowedPaths(nil, libraries, []int{2}, false, true) + Expect(result).To(HaveLen(1)) + Expect(result).To(HaveKeyWithValue("/music/library2", "/libraries/2")) + }) + }) + + Context("edge cases", func() { + It("returns empty map when no libraries match", func() { + result := buildAllowedPaths(nil, libraries, []int{99}, false, false) + Expect(result).To(BeEmpty()) + }) + + It("returns empty map when libraries list is empty", func() { + result := buildAllowedPaths(nil, nil, []int{1}, false, false) + Expect(result).To(BeEmpty()) + }) + + It("returns empty map when allLibraries is false and no IDs provided", func() { + result := buildAllowedPaths(nil, libraries, nil, false, false) + Expect(result).To(BeEmpty()) + }) + }) +}) diff --git a/plugins/manager_plugin.go b/plugins/manager_plugin.go new file mode 100644 index 000000000..08c0073b6 --- /dev/null +++ b/plugins/manager_plugin.go @@ -0,0 +1,49 @@ +package plugins + +import ( + "context" + "crypto/rand" + "errors" + "io" + + extism "github.com/extism/go-sdk" + "github.com/tetratelabs/wazero" +) + +// plugin represents a loaded plugin +type plugin struct { + name string // Plugin name (from filename) + path string // Path to the wasm file + manifest *Manifest + compiled *extism.CompiledPlugin + capabilities []Capability // Auto-detected capabilities based on exported functions + closers []io.Closer // Cleanup functions to call on unload + metrics PluginMetricsRecorder + allowedUserIDs []string // User IDs this plugin can access (from DB configuration) + allUsers bool // If true, plugin can access all users +} + +// instance creates a new plugin instance for the given context. +// The context is used for cancellation - if cancelled during a call, +// the module will be terminated and the instance becomes unusable. +func (p *plugin) instance(ctx context.Context) (*extism.Plugin, error) { + instance, err := p.compiled.Instance(ctx, extism.PluginInstanceConfig{ + ModuleConfig: wazero.NewModuleConfig().WithSysWalltime().WithRandSource(rand.Reader), + }) + if err != nil { + return nil, err + } + instance.SetLogger(extismLogger(p.name)) + return instance, nil +} + +func (p *plugin) Close() error { + var errs []error + for _, f := range p.closers { + err := f.Close() + if err != nil { + errs = append(errs, err) + } + } + return errors.Join(errs...) +} diff --git a/plugins/manager_sync.go b/plugins/manager_sync.go new file mode 100644 index 000000000..2e024ca37 --- /dev/null +++ b/plugins/manager_sync.go @@ -0,0 +1,231 @@ +package plugins + +import ( + "context" + "crypto/sha256" + "encoding/hex" + "encoding/json" + "fmt" + "io" + "os" + "path/filepath" + "strings" + "time" + + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/server/events" +) + +// PluginMetadata holds the extracted information from a plugin file +// without fully initializing the plugin. +type PluginMetadata struct { + Manifest *Manifest + SHA256 string +} + +// adminContext returns a context with admin privileges for DB operations. +func adminContext(ctx context.Context) context.Context { + return request.WithUser(ctx, model.User{IsAdmin: true}) +} + +// marshalManifest marshals a manifest to JSON string, returning empty string on error. +func marshalManifest(m *Manifest) string { + b, _ := json.Marshal(m) + return string(b) +} + +// computeFileSHA256 computes the SHA-256 hash of a file without loading it into memory. +// This is used for quick change detection before full plugin compilation. +func computeFileSHA256(path string) (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 "", err + } + return hex.EncodeToString(h.Sum(nil)), nil +} + +// addPluginToDB adds a new plugin to the database as disabled. +func (m *Manager) addPluginToDB(ctx context.Context, repo model.PluginRepository, name, path string, metadata *PluginMetadata) error { + now := time.Now() + newPlugin := &model.Plugin{ + ID: name, + Path: path, + Manifest: marshalManifest(metadata.Manifest), + SHA256: metadata.SHA256, + Enabled: false, + CreatedAt: now, + UpdatedAt: now, + } + if err := repo.Put(newPlugin); err != nil { + return fmt.Errorf("adding plugin to DB: %w", err) + } + log.Info(ctx, "Discovered new plugin", "plugin", name) + m.sendPluginRefreshEvent(ctx, events.Any) + return nil +} + +// updatePluginInDB updates an existing plugin in the database after a file change. +// If the plugin was enabled, it will be unloaded and disabled. +func (m *Manager) updatePluginInDB(ctx context.Context, repo model.PluginRepository, dbPlugin *model.Plugin, path string, metadata *PluginMetadata) error { + wasEnabled := dbPlugin.Enabled + if wasEnabled { + if err := m.unloadPlugin(dbPlugin.ID); err != nil { + log.Debug(ctx, "Plugin not loaded during change", "plugin", dbPlugin.ID, err) + } + } + dbPlugin.Path = path + dbPlugin.Manifest = marshalManifest(metadata.Manifest) + dbPlugin.SHA256 = metadata.SHA256 + dbPlugin.Enabled = false + dbPlugin.LastError = "" + dbPlugin.UpdatedAt = time.Now() + if err := repo.Put(dbPlugin); err != nil { + return fmt.Errorf("updating plugin in DB: %w", err) + } + log.Info(ctx, "Plugin file changed", "plugin", dbPlugin.ID, "wasEnabled", wasEnabled) + m.sendPluginRefreshEvent(ctx, dbPlugin.ID) + return nil +} + +// removePluginFromDB removes a plugin from the database. +// If the plugin was enabled, it will be unloaded first. +func (m *Manager) removePluginFromDB(ctx context.Context, repo model.PluginRepository, dbPlugin *model.Plugin) error { + pluginID := dbPlugin.ID + if dbPlugin.Enabled { + if err := m.unloadPlugin(pluginID); err != nil { + log.Debug(ctx, "Plugin not loaded during removal", "plugin", pluginID, err) + } + } + if err := repo.Delete(pluginID); err != nil { + return fmt.Errorf("deleting plugin from DB: %w", err) + } + log.Info(ctx, "Plugin removed", "plugin", pluginID) + m.sendPluginRefreshEvent(ctx, events.Any) + return nil +} + +// syncPlugins scans the plugins folder and synchronizes with the database. +// It handles new, changed, and removed plugins by comparing SHA-256 hashes. +// - New plugins are added to DB as disabled +// - Changed plugins are updated in DB and disabled if they were enabled +// - Removed plugins are deleted from DB (after unloading if enabled) +func (m *Manager) syncPlugins(ctx context.Context, folder string) error { + if m.ds == nil { + return fmt.Errorf("datastore not configured") + } + + adminCtx := adminContext(ctx) + + // Read current plugins from folder + entries, err := os.ReadDir(folder) + if err != nil { + if os.IsNotExist(err) { + log.Debug(ctx, "Plugins folder does not exist", "folder", folder) + return nil + } + return fmt.Errorf("reading plugins folder: %w", err) + } + + // Build map of files in folder + filesOnDisk := make(map[string]string) // name -> path + for _, entry := range entries { + if entry.IsDir() || !strings.HasSuffix(entry.Name(), PackageExtension) { + continue + } + name := strings.TrimSuffix(entry.Name(), PackageExtension) + filesOnDisk[name] = filepath.Join(folder, entry.Name()) + } + + // Get all plugins from DB + repo := m.ds.Plugin(adminCtx) + dbPlugins, err := repo.GetAll() + if err != nil { + return fmt.Errorf("reading plugins from DB: %w", err) + } + pluginsInDB := make(map[string]*model.Plugin) + for i := range dbPlugins { + pluginsInDB[dbPlugins[i].ID] = &dbPlugins[i] + } + + now := time.Now() + + // Process files on disk + for name, path := range filesOnDisk { + dbPlugin, exists := pluginsInDB[name] + + // Compute SHA256 first (lightweight operation) to check if plugin changed + sha256Hash, err := computeFileSHA256(path) + if err != nil { + log.Error(ctx, "Failed to compute SHA256 for plugin", "plugin", name, "path", path, err) + continue + } + + // If plugin exists in DB with same hash, skip full manifest extraction + if exists && dbPlugin.SHA256 == sha256Hash { + // Plugin unchanged - just update path in case folder moved + if dbPlugin.Path != path { + dbPlugin.Path = path + dbPlugin.UpdatedAt = now + if err := repo.Put(dbPlugin); err != nil { + log.Error(ctx, "Failed to update plugin path in DB", "plugin", name, err) + } + } + delete(pluginsInDB, name) + continue + } + + // Plugin is new or changed - need full manifest extraction + metadata, err := m.extractManifest(path) + if err != nil { + log.Error(ctx, "Failed to extract manifest from plugin", "plugin", name, "path", path, err) + // Store error in DB if plugin exists + if exists { + dbPlugin.LastError = err.Error() + dbPlugin.UpdatedAt = now + if dbPlugin.Enabled { + // Unload broken plugin + if unloadErr := m.unloadPlugin(name); unloadErr != nil { + log.Debug(ctx, "Plugin not loaded", "plugin", name) + } + dbPlugin.Enabled = false + } + if putErr := repo.Put(dbPlugin); putErr != nil { + log.Error(ctx, "Failed to update plugin in DB", "plugin", name, err) + } + } + delete(pluginsInDB, name) + continue + } + + if !exists { + // New plugin - add to DB as disabled + if err := m.addPluginToDB(ctx, repo, name, path, metadata); err != nil { + log.Error(ctx, "Failed to add plugin to DB", "plugin", name, err) + } + } else { + // Plugin changed - update DB + if err := m.updatePluginInDB(ctx, repo, dbPlugin, path, metadata); err != nil { + log.Error(ctx, "Failed to update plugin in DB", "plugin", name, err) + } + } + // Mark as processed + delete(pluginsInDB, name) + } + + // Remove plugins no longer on disk + for _, dbPlugin := range pluginsInDB { + if err := m.removePluginFromDB(ctx, repo, dbPlugin); err != nil { + log.Error(ctx, "Failed to delete plugin from DB", "plugin", dbPlugin.ID, err) + } + } + + return nil +} diff --git a/plugins/manager_test.go b/plugins/manager_test.go index 207908ebc..6cf90994a 100644 --- a/plugins/manager_test.go +++ b/plugins/manager_test.go @@ -2,362 +2,195 @@ package plugins import ( "context" - "os" - "path/filepath" + "fmt" + "net/http" + "sync" - "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/core/agents" - "github.com/navidrome/navidrome/core/metrics" - "github.com/navidrome/navidrome/plugins/schema" + "github.com/navidrome/navidrome/server/events" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) -var _ = Describe("Plugin Manager", func() { - var mgr *managerImpl +var _ = Describe("Manager", Ordered, func() { var ctx context.Context - BeforeEach(func() { - // We change the plugins folder to random location to avoid conflicts with other tests, - // but, as this is an integration test, we can't use configtest.SetupConfig() as it causes - // data races. - originalPluginsFolder := conf.Server.Plugins.Folder - DeferCleanup(func() { - conf.Server.Plugins.Folder = originalPluginsFolder - }) - conf.Server.Plugins.Enabled = true - conf.Server.Plugins.Folder = testDataDir - + BeforeAll(func() { ctx = GinkgoT().Context() - mgr = createManager(nil, metrics.NewNoopInstance()) - mgr.ScanPlugins() - - // Wait for all plugins to compile to avoid race conditions - err := mgr.EnsureCompiled("fake_artist_agent") - Expect(err).NotTo(HaveOccurred(), "fake_artist_agent should compile successfully") - err = mgr.EnsureCompiled("fake_album_agent") - Expect(err).NotTo(HaveOccurred(), "fake_album_agent should compile successfully") - err = mgr.EnsureCompiled("multi_plugin") - Expect(err).NotTo(HaveOccurred(), "multi_plugin should compile successfully") - err = mgr.EnsureCompiled("unauthorized_plugin") - Expect(err).NotTo(HaveOccurred(), "unauthorized_plugin should compile successfully") }) - It("should scan and discover plugins from the testdata folder", func() { - Expect(mgr).NotTo(BeNil()) - - mediaAgentNames := mgr.PluginNames("MetadataAgent") - Expect(mediaAgentNames).To(HaveLen(4)) - Expect(mediaAgentNames).To(ContainElements( - "fake_artist_agent", - "fake_album_agent", - "multi_plugin", - "unauthorized_plugin", - )) - - scrobblerNames := mgr.PluginNames("Scrobbler") - Expect(scrobblerNames).To(ContainElement("fake_scrobbler")) - - initServiceNames := mgr.PluginNames("LifecycleManagement") - Expect(initServiceNames).To(ContainElements("multi_plugin", "fake_init_service")) - - schedulerCallbackNames := mgr.PluginNames("SchedulerCallback") - Expect(schedulerCallbackNames).To(ContainElement("multi_plugin")) - }) - - It("should load all plugins from folder", func() { - all := mgr.PluginList() - Expect(all).To(HaveLen(6)) - Expect(all["fake_artist_agent"].Name).To(Equal("fake_artist_agent")) - Expect(all["unauthorized_plugin"].Capabilities).To(HaveExactElements(schema.PluginManifestCapabilitiesElem("MetadataAgent"))) - }) - - It("should load a MetadataAgent plugin and invoke artist-related methods", func() { - plugin := mgr.LoadPlugin("fake_artist_agent", CapabilityMetadataAgent) - Expect(plugin).NotTo(BeNil()) - - agent, ok := plugin.(agents.Interface) - Expect(ok).To(BeTrue(), "plugin should implement agents.Interface") - Expect(agent.AgentName()).To(Equal("fake_artist_agent")) - - mbidRetriever, ok := agent.(agents.ArtistMBIDRetriever) - Expect(ok).To(BeTrue()) - mbid, err := mbidRetriever.GetArtistMBID(ctx, "123", "The Beatles") - Expect(err).NotTo(HaveOccurred()) - Expect(mbid).To(Equal("1234567890")) - }) - - It("should load all MetadataAgent plugins", func() { - mediaAgentNames := mgr.PluginNames("MetadataAgent") - Expect(mediaAgentNames).To(HaveLen(4)) - - var agentNames []string - for _, name := range mediaAgentNames { - agent, ok := mgr.LoadMediaAgent(name) - if ok { - agentNames = append(agentNames, agent.AgentName()) - } - } - - Expect(agentNames).To(ContainElements("fake_artist_agent", "fake_album_agent", "multi_plugin", "unauthorized_plugin")) - }) - - Describe("ScanPlugins", func() { - var tempPluginsDir string - var m *managerImpl - - BeforeEach(func() { - tempPluginsDir, _ = os.MkdirTemp("", "navidrome-plugins-test-*") - DeferCleanup(func() { - _ = os.RemoveAll(tempPluginsDir) - }) - - conf.Server.Plugins.Folder = tempPluginsDir - m = createManager(nil, metrics.NewNoopInstance()) + Describe("Plugin Loading", func() { + It("loads enabled plugins from DB on Start", func() { + // Plugin is already loaded by testManager.Start() via loadEnabledPlugins + names := testManager.PluginNames(string(CapabilityMetadataAgent)) + Expect(names).To(ContainElement("test-metadata-agent")) }) + }) - // Helper to create a complete valid plugin for manager testing - createValidPlugin := func(folderName, manifestName string) { - pluginDir := filepath.Join(tempPluginsDir, folderName) - Expect(os.MkdirAll(pluginDir, 0755)).To(Succeed()) - - // Copy real WASM file from testdata - sourceWasmPath := filepath.Join(testDataDir, "fake_artist_agent", "plugin.wasm") - targetWasmPath := filepath.Join(pluginDir, "plugin.wasm") - sourceWasm, err := os.ReadFile(sourceWasmPath) + Describe("unloadPlugin", func() { + It("removes a loaded plugin", func() { + // Plugin is already loaded from Start + err := testManager.unloadPlugin("test-metadata-agent") Expect(err).ToNot(HaveOccurred()) - Expect(os.WriteFile(targetWasmPath, sourceWasm, 0600)).To(Succeed()) - manifest := `{ - "name": "` + manifestName + `", - "version": "1.0.0", - "capabilities": ["MetadataAgent"], - "author": "Test Author", - "description": "Test Plugin", - "website": "https://test.navidrome.org/` + manifestName + `", - "permissions": {} - }` - Expect(os.WriteFile(filepath.Join(pluginDir, "manifest.json"), []byte(manifest), 0600)).To(Succeed()) - } - - It("should register and compile discovered plugins", func() { - createValidPlugin("test-plugin", "test-plugin") - - m.ScanPlugins() - - // Focus on manager behavior: registration and compilation - Expect(m.plugins).To(HaveLen(1)) - Expect(m.plugins).To(HaveKey("test-plugin")) - - plugin := m.plugins["test-plugin"] - Expect(plugin.ID).To(Equal("test-plugin")) - Expect(plugin.Manifest.Name).To(Equal("test-plugin")) - - // Verify plugin can be loaded (compilation successful) - loadedPlugin := m.LoadPlugin("test-plugin", CapabilityMetadataAgent) - Expect(loadedPlugin).NotTo(BeNil()) + names := testManager.PluginNames(string(CapabilityMetadataAgent)) + Expect(names).ToNot(ContainElement("test-metadata-agent")) }) - It("should handle multiple plugins with different IDs but same manifest names", func() { - // This tests manager-specific behavior: how it handles ID conflicts - createValidPlugin("lastfm-official", "lastfm") - createValidPlugin("lastfm-custom", "lastfm") - - m.ScanPlugins() - - // Both should be registered with their folder names as IDs - Expect(m.plugins).To(HaveLen(2)) - Expect(m.plugins).To(HaveKey("lastfm-official")) - Expect(m.plugins).To(HaveKey("lastfm-custom")) - - // Both should be loadable independently - official := m.LoadPlugin("lastfm-official", CapabilityMetadataAgent) - custom := m.LoadPlugin("lastfm-custom", CapabilityMetadataAgent) - Expect(official).NotTo(BeNil()) - Expect(custom).NotTo(BeNil()) - Expect(official.PluginID()).To(Equal("lastfm-official")) - Expect(custom.PluginID()).To(Equal("lastfm-custom")) - }) - }) - - Describe("LoadPlugin", func() { - It("should load a MetadataAgent plugin and invoke artist-related methods", func() { - plugin := mgr.LoadPlugin("fake_artist_agent", CapabilityMetadataAgent) - Expect(plugin).NotTo(BeNil()) - - agent, ok := plugin.(agents.Interface) - Expect(ok).To(BeTrue(), "plugin should implement agents.Interface") - Expect(agent.AgentName()).To(Equal("fake_artist_agent")) - - mbidRetriever, ok := agent.(agents.ArtistMBIDRetriever) - Expect(ok).To(BeTrue()) - mbid, err := mbidRetriever.GetArtistMBID(ctx, "id", "Test Artist") - Expect(err).NotTo(HaveOccurred()) - Expect(mbid).To(Equal("1234567890")) - }) - }) - - Describe("EnsureCompiled", func() { - It("should successfully wait for plugin compilation", func() { - err := mgr.EnsureCompiled("fake_artist_agent") - Expect(err).NotTo(HaveOccurred()) - }) - - It("should return error for non-existent plugin", func() { - err := mgr.EnsureCompiled("non-existent-plugin") + It("returns error when plugin not found", func() { + err := testManager.unloadPlugin("nonexistent") Expect(err).To(HaveOccurred()) - Expect(err.Error()).To(ContainSubstring("plugin not found: non-existent-plugin")) - }) - - It("should wait for compilation to complete for all valid plugins", func() { - pluginNames := []string{"fake_artist_agent", "fake_album_agent", "multi_plugin", "fake_scrobbler"} - - for _, name := range pluginNames { - err := mgr.EnsureCompiled(name) - Expect(err).NotTo(HaveOccurred(), "plugin %s should compile successfully", name) - } + Expect(err.Error()).To(ContainSubstring("not found")) }) }) - Describe("Invoke Methods", func() { - It("should load all MetadataAgent plugins and invoke methods", func() { - fakeAlbumPlugin, isMediaAgent := mgr.LoadMediaAgent("fake_album_agent") - Expect(isMediaAgent).To(BeTrue()) + Describe("EnablePlugin", func() { + It("enables and loads a disabled plugin", func() { + // First disable the plugin (which also unloads it) + err := testManager.DisablePlugin(ctx, "test-metadata-agent") + Expect(err).ToNot(HaveOccurred()) + Expect(testManager.PluginNames(string(CapabilityMetadataAgent))).ToNot(ContainElement("test-metadata-agent")) - Expect(fakeAlbumPlugin).NotTo(BeNil(), "fake_album_agent should be loaded") + // Enable it + err = testManager.EnablePlugin(ctx, "test-metadata-agent") + Expect(err).ToNot(HaveOccurred()) - // Test GetAlbumInfo method - need to cast to the specific interface - albumRetriever, ok := fakeAlbumPlugin.(agents.AlbumInfoRetriever) - Expect(ok).To(BeTrue(), "fake_album_agent should implement AlbumInfoRetriever") - - info, err := albumRetriever.GetAlbumInfo(ctx, "Test Album", "Test Artist", "123") - Expect(err).NotTo(HaveOccurred()) - Expect(info).NotTo(BeNil()) - Expect(info.Name).To(Equal("Test Album")) + names := testManager.PluginNames(string(CapabilityMetadataAgent)) + Expect(names).To(ContainElement("test-metadata-agent")) }) }) - Describe("Permission Enforcement Integration", func() { - It("should fail when plugin tries to access unauthorized services", func() { - // This plugin tries to access config service but has no permissions - plugin := mgr.LoadPlugin("unauthorized_plugin", CapabilityMetadataAgent) - Expect(plugin).NotTo(BeNil()) + Describe("DisablePlugin", func() { + It("disables and unloads an enabled plugin", func() { + // Ensure the plugin is loaded first + _ = testManager.EnablePlugin(ctx, "test-metadata-agent") - agent, ok := plugin.(agents.Interface) - Expect(ok).To(BeTrue()) + err := testManager.DisablePlugin(ctx, "test-metadata-agent") + Expect(err).ToNot(HaveOccurred()) - // This should fail because the plugin tries to access unauthorized config service - // The exact behavior depends on the plugin implementation, but it should either: - // 1. Fail during instantiation, or - // 2. Return an error when trying to call config methods - - // Try to use one of the available methods - let's test with GetArtistMBID - mbidRetriever, isMBIDRetriever := agent.(agents.ArtistMBIDRetriever) - if isMBIDRetriever { - _, err := mbidRetriever.GetArtistMBID(ctx, "id", "Test Artist") - if err == nil { - // If no error, the plugin should still be working - // but any config access should fail silently or return default values - Expect(agent.AgentName()).To(Equal("unauthorized_plugin")) - } else { - // If there's an error, it should be related to missing permissions - Expect(err.Error()).To(ContainSubstring("")) - } - } else { - // If the plugin doesn't implement the interface, that's also acceptable - Expect(agent.AgentName()).To(Equal("unauthorized_plugin")) - } + names := testManager.PluginNames(string(CapabilityMetadataAgent)) + Expect(names).ToNot(ContainElement("test-metadata-agent")) }) }) - Describe("Plugin Initialization Lifecycle", func() { + Describe("GetPluginInfo", func() { BeforeEach(func() { - conf.Server.Plugins.Enabled = true - conf.Server.Plugins.Folder = testDataDir + // Ensure plugin is loaded for this test + _ = testManager.EnablePlugin(ctx, "test-metadata-agent") }) - Context("when OnInit is successful", func() { - It("should register and initialize the plugin", func() { - conf.Server.PluginConfig = nil - mgr = createManager(nil, metrics.NewNoopInstance()) // Create manager after setting config - mgr.ScanPlugins() - - plugin := mgr.plugins["fake_init_service"] - Expect(plugin).NotTo(BeNil()) - - Eventually(func() bool { - return mgr.lifecycle.isInitialized(plugin) - }).Should(BeTrue()) - - // Check that the plugin is still registered - names := mgr.PluginNames(CapabilityLifecycleManagement) - Expect(names).To(ContainElement("fake_init_service")) - }) + It("returns information about all loaded plugins", func() { + info := testManager.GetPluginInfo() + Expect(info).To(HaveKey("test-metadata-agent")) + Expect(info["test-metadata-agent"].Name).To(Equal("Test Plugin")) + Expect(info["test-metadata-agent"].Version).To(Equal("1.0.0")) }) + }) - Context("when OnInit fails", func() { - It("should unregister the plugin if OnInit returns an error string", func() { - conf.Server.PluginConfig = map[string]map[string]string{ - "fake_init_service": { - "returnError": "response_error", - }, + It("can call the plugin concurrently", func() { + // Ensure plugin is loaded + _ = testManager.EnablePlugin(ctx, "test-metadata-agent") + + const concurrency = 30 + errs := make(chan error, concurrency) + bios := make(chan string, concurrency) + + g := sync.WaitGroup{} + g.Add(concurrency) + for i := range concurrency { + go func(i int) { + defer g.Done() + a, ok := testManager.LoadMediaAgent("test-metadata-agent") + Expect(ok).To(BeTrue()) + agent := a.(agents.ArtistBiographyRetriever) + bio, err := agent.GetArtistBiography(ctx, fmt.Sprintf("artist-%d", i), fmt.Sprintf("Artist %d", i), "") + if err != nil { + errs <- err + return } - mgr = createManager(nil, metrics.NewNoopInstance()) // Create manager after setting config - mgr.ScanPlugins() + bios <- bio + }(i) + } + g.Wait() - Eventually(func() []string { - return mgr.PluginNames(CapabilityLifecycleManagement) - }).ShouldNot(ContainElement("fake_init_service")) - }) - - It("should unregister the plugin if OnInit returns a Go error", func() { - conf.Server.PluginConfig = map[string]map[string]string{ - "fake_init_service": { - "returnError": "go_error", - }, - } - mgr = createManager(nil, metrics.NewNoopInstance()) // Create manager after setting config - mgr.ScanPlugins() - - Eventually(func() []string { - return mgr.PluginNames(CapabilityLifecycleManagement) - }).ShouldNot(ContainElement("fake_init_service")) - }) - }) - - It("should clear lifecycle state when unregistering a plugin", func() { - // Create a manager and register a plugin - mgr := createManager(nil, metrics.NewNoopInstance()) - - // Create a mock plugin with LifecycleManagement capability - plugin := &plugin{ - ID: "test-plugin", - Capabilities: []string{CapabilityLifecycleManagement}, - Manifest: &schema.PluginManifest{ - Version: "1.0.0", - }, + // Collect results + for range concurrency { + select { + case err := <-errs: + Expect(err).ToNot(HaveOccurred()) + case bio := <-bios: + Expect(bio).To(ContainSubstring("Biography for Artist")) } + } + }) - // Register the plugin in the manager - mgr.pluginsMu.Lock() - mgr.plugins[plugin.ID] = plugin - mgr.pluginsMu.Unlock() + Describe("sendPluginRefreshEvent", func() { + var broker *testBroker + var manager *Manager - // Mark the plugin as initialized in the lifecycle manager - mgr.lifecycle.markInitialized(plugin) - Expect(mgr.lifecycle.isInitialized(plugin)).To(BeTrue()) + BeforeEach(func() { + broker = &testBroker{} + manager = &Manager{ + broker: broker, + } + }) - // Unregister the plugin - mgr.unregisterPlugin(plugin.ID) + It("sends refresh event with single plugin ID", func() { + manager.sendPluginRefreshEvent(ctx, "test-plugin") - // Verify that the plugin is no longer in the manager - mgr.pluginsMu.RLock() - _, exists := mgr.plugins[plugin.ID] - mgr.pluginsMu.RUnlock() - Expect(exists).To(BeFalse()) + Expect(broker.broadcastCalled).To(BeTrue()) + Expect(broker.lastEvent).ToNot(BeNil()) + Expect(broker.lastEventCtx).To(Equal(ctx)) - // Verify that the lifecycle state has been cleared - Expect(mgr.lifecycle.isInitialized(plugin)).To(BeFalse()) + refreshEvent, ok := broker.lastEvent.(*events.RefreshResource) + Expect(ok).To(BeTrue(), "event should be a RefreshResource") + Expect(refreshEvent.Data(refreshEvent)).To(Equal(`{"plugin":["test-plugin"]}`)) + }) + + It("sends refresh event with multiple plugin IDs", func() { + manager.sendPluginRefreshEvent(ctx, "plugin-1", "plugin-2", "plugin-3") + + Expect(broker.broadcastCalled).To(BeTrue()) + refreshEvent, ok := broker.lastEvent.(*events.RefreshResource) + Expect(ok).To(BeTrue()) + Expect(refreshEvent.Data(refreshEvent)).To(Equal(`{"plugin":["plugin-1","plugin-2","plugin-3"]}`)) + }) + + It("sends refresh event with wildcard when using events.Any", func() { + manager.sendPluginRefreshEvent(ctx, events.Any) + + Expect(broker.broadcastCalled).To(BeTrue()) + refreshEvent, ok := broker.lastEvent.(*events.RefreshResource) + Expect(ok).To(BeTrue()) + Expect(refreshEvent.Data(refreshEvent)).To(Equal(`{"plugin":["*"]}`)) + }) + + It("does not panic when broker is nil", func() { + manager.broker = nil + Expect(func() { + manager.sendPluginRefreshEvent(ctx, "test-plugin") + }).ToNot(Panic()) }) }) }) + +// testBroker is a simple mock implementation of events.Broker for testing +type testBroker struct { + lastEvent events.Event + lastEventCtx context.Context + broadcastCalled bool +} + +func (m *testBroker) ServeHTTP(w http.ResponseWriter, r *http.Request) { + // Not used in tests +} + +func (m *testBroker) SendMessage(ctx context.Context, event events.Event) { + // Not used in tests +} + +func (m *testBroker) SendBroadcastMessage(ctx context.Context, event events.Event) { + m.lastEvent = event + m.lastEventCtx = ctx + m.broadcastCalled = true +} diff --git a/plugins/manager_watcher.go b/plugins/manager_watcher.go new file mode 100644 index 000000000..4f266bda1 --- /dev/null +++ b/plugins/manager_watcher.go @@ -0,0 +1,217 @@ +package plugins + +import ( + "os" + "path/filepath" + "strings" + "sync" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/log" + "github.com/rjeczalik/notify" +) + +// debounceDuration is the time to wait before acting on file events +// to handle multiple rapid events for the same file. +const debounceDuration = 2 * time.Second + +// startWatcher starts the file watcher for the plugins folder. +// It watches for CREATE, WRITE, and REMOVE events on .wasm files. +func (m *Manager) startWatcher() error { + folder := conf.Server.Plugins.Folder + if folder == "" { + return nil + } + + m.watcherEvents = make(chan notify.EventInfo, 10) + m.watcherDone = make(chan struct{}) + m.debounceTimers = make(map[string]*time.Timer) + m.debounceMu = sync.Mutex{} + + // Watch the plugins folder (not recursive) + // We filter for .wasm files in the event handler + if err := notify.Watch(folder, m.watcherEvents, notify.Create, notify.Write, notify.Remove, notify.Rename); err != nil { + close(m.watcherEvents) + return err + } + + log.Info(m.ctx, "Started plugin file watcher", "folder", folder) + + go m.watcherLoop() + + return nil +} + +// stopWatcher stops the file watcher +func (m *Manager) stopWatcher() { + if m.watcherEvents == nil { + return + } + + notify.Stop(m.watcherEvents) + close(m.watcherDone) + + // Cancel any pending debounce timers + m.debounceMu.Lock() + for _, timer := range m.debounceTimers { + timer.Stop() + } + m.debounceTimers = nil + m.debounceMu.Unlock() + + log.Debug(m.ctx, "Stopped plugin file watcher") +} + +// watcherLoop processes file watcher events +func (m *Manager) watcherLoop() { + for { + select { + case event, ok := <-m.watcherEvents: + if !ok { + return + } + m.handleWatcherEvent(event) + case <-m.ctx.Done(): + return + case <-m.watcherDone: + return + } + } +} + +// handleWatcherEvent processes a single file watcher event with debouncing +func (m *Manager) handleWatcherEvent(event notify.EventInfo) { + path := event.Path() + + // Only process .ndp package files + if !strings.HasSuffix(path, PackageExtension) { + return + } + + pluginName := strings.TrimSuffix(filepath.Base(path), PackageExtension) + + log.Trace(m.ctx, "Plugin file event", "plugin", pluginName, "event", event.Event(), "path", path) + + // Debounce: cancel any pending timer for this plugin and start a new one + m.debounceMu.Lock() + if timer, exists := m.debounceTimers[pluginName]; exists { + timer.Stop() + } + + // Note: We don't capture the event type here. Instead, processPluginEvent + // checks if the file exists when the timer fires. This handles sequences like + // Remove+Create+Rename correctly by checking actual file state after debounce. + m.debounceTimers[pluginName] = time.AfterFunc(debounceDuration, func() { + m.processPluginEvent(pluginName) + }) + m.debounceMu.Unlock() +} + +// pluginAction represents the action to take on a plugin based on file state +type pluginAction int + +const ( + actionNone pluginAction = iota // No action needed + actionUpdate // File exists: add new or update existing plugin in DB + actionRemove // File gone: remove plugin from DB (unload if enabled) +) + +// determinePluginAction decides what action to take based on file existence. +// We check file existence rather than relying on event type because: +// 1. Events can be coalesced on some systems (macOS FSEvents) +// 2. Rename events can mean either "renamed away" (remove) or "renamed to" (add) +// 3. Build tools often do atomic writes (write temp file, rename to target) +// By checking existence, we handle all these cases correctly. +func determinePluginAction(path string) pluginAction { + if _, err := os.Stat(path); err == nil { + // File exists - treat as add/update + return actionUpdate + } + // File doesn't exist - it was removed + return actionRemove +} + +// processPluginEvent handles the actual plugin load/unload/reload after debouncing. +// - If file exists: extract manifest, add or update plugin in DB +// - If file gone: unload if enabled, delete from DB +func (m *Manager) processPluginEvent(pluginName string) { + // Don't process if manager is stopping/stopped (atomic check to avoid race with Stop()) + if m.stopped.Load() { + return + } + + // Clean up debounce timer entry + m.debounceMu.Lock() + delete(m.debounceTimers, pluginName) + m.debounceMu.Unlock() + + folder := conf.Server.Plugins.Folder + ndpPath := filepath.Join(folder, pluginName+PackageExtension) + + action := determinePluginAction(ndpPath) + log.Debug(m.ctx, "Plugin event action", "plugin", pluginName, "action", action, "path", ndpPath) + + ctx := adminContext(m.ctx) + repo := m.ds.Plugin(ctx) + + switch action { + case actionUpdate: + // File changed - check SHA256 first, then extract manifest if needed + sha256Hash, err := computeFileSHA256(ndpPath) + if err != nil { + log.Error(m.ctx, "Failed to compute SHA256 for changed plugin", "plugin", pluginName, err) + return + } + + dbPlugin, err := repo.Get(pluginName) + if err != nil { + // Plugin not in DB yet, need full manifest extraction to add it + metadata, extractErr := m.extractManifest(ndpPath) + if extractErr != nil { + log.Error(m.ctx, "Failed to extract manifest from new plugin", "plugin", pluginName, extractErr) + return + } + if addErr := m.addPluginToDB(m.ctx, repo, pluginName, ndpPath, metadata); addErr != nil { + log.Error(m.ctx, "Failed to add plugin to DB", "plugin", pluginName, addErr) + } + return + } + + // Check if actually changed using lightweight SHA256 comparison + if dbPlugin.SHA256 == sha256Hash { + return // No actual change + } + + // Plugin changed - now extract full manifest + metadata, err := m.extractManifest(ndpPath) + if err != nil { + log.Error(m.ctx, "Failed to extract manifest from changed plugin", "plugin", pluginName, err) + // Update error in DB + dbPlugin.LastError = err.Error() + dbPlugin.UpdatedAt = time.Now() + if dbPlugin.Enabled { + _ = m.unloadPlugin(pluginName) + dbPlugin.Enabled = false + } + _ = repo.Put(dbPlugin) + return + } + + if err := m.updatePluginInDB(m.ctx, repo, dbPlugin, ndpPath, metadata); err != nil { + log.Error(m.ctx, "Failed to update plugin in DB", "plugin", pluginName, err) + } + + case actionRemove: + // File removed - unload if enabled, delete from DB + dbPlugin, err := repo.Get(pluginName) + if err != nil { + log.Debug(m.ctx, "Removed plugin not in DB", "plugin", pluginName) + return + } + + if err := m.removePluginFromDB(m.ctx, repo, dbPlugin); err != nil { + log.Error(m.ctx, "Failed to delete plugin from DB", "plugin", pluginName, err) + } + } +} diff --git a/plugins/manager_watcher_test.go b/plugins/manager_watcher_test.go new file mode 100644 index 000000000..99326bde1 --- /dev/null +++ b/plugins/manager_watcher_test.go @@ -0,0 +1,181 @@ +package plugins + +import ( + "context" + "net/http" + "os" + "path/filepath" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Plugin Watcher", func() { + Describe("Integration Tests", Ordered, func() { + // Uses testdataDir and createTestManager from BeforeSuite + var ( + manager *Manager + tmpDir string + ctx context.Context + ) + + BeforeAll(func() { + ctx = GinkgoT().Context() + + // Create manager for watcher lifecycle tests (no plugin preloaded - tests copy plugin as needed) + manager, tmpDir = createTestManager(nil) + + // Remove the auto-loaded plugin so tests can control loading + _ = manager.unloadPlugin("test-metadata-agent") + _ = os.Remove(filepath.Join(tmpDir, "test-metadata-agent"+PackageExtension)) + // Also remove from DB so tests start with a clean slate + _ = manager.ds.Plugin(ctx).Delete("test-metadata-agent") + }) + + // Helper to copy test plugin into the temp folder + copyTestPlugin := func() { + srcPath := filepath.Join(testdataDir, "test-metadata-agent"+PackageExtension) + destPath := filepath.Join(tmpDir, "test-metadata-agent"+PackageExtension) + data, err := os.ReadFile(srcPath) + Expect(err).ToNot(HaveOccurred()) + err = os.WriteFile(destPath, data, 0600) + Expect(err).ToNot(HaveOccurred()) + } + + Describe("Plugin event processing (integration)", func() { + // These tests verify the DB-driven flow with actual WASM plugin loading. + + AfterEach(func() { + // Clean up: unload plugin if loaded, remove copied file, delete from DB + _ = manager.unloadPlugin("test-metadata-agent") + _ = os.Remove(filepath.Join(tmpDir, "test-metadata-agent"+PackageExtension)) + _ = manager.ds.Plugin(ctx).Delete("test-metadata-agent") + }) + + It("adds plugin to DB when file exists", func() { + copyTestPlugin() + manager.processPluginEvent("test-metadata-agent") + + // Plugin should be in DB but not loaded (starts disabled) + Expect(manager.PluginNames(string(CapabilityMetadataAgent))).ToNot(ContainElement("test-metadata-agent")) + + // Verify it was added to DB + repo := manager.ds.Plugin(ctx) + plugin, err := repo.Get("test-metadata-agent") + Expect(err).ToNot(HaveOccurred()) + Expect(plugin.ID).To(Equal("test-metadata-agent")) + Expect(plugin.Enabled).To(BeFalse()) + }) + + It("updates DB and disables plugin when file changes", func() { + copyTestPlugin() + + // First add and enable the plugin + manager.processPluginEvent("test-metadata-agent") + err := manager.EnablePlugin(ctx, "test-metadata-agent") + Expect(err).ToNot(HaveOccurred()) + Expect(manager.PluginNames(string(CapabilityMetadataAgent))).To(ContainElement("test-metadata-agent")) + + // Modify the stored SHA256 in DB to simulate a file change + // (In reality, the file would have different content) + repo := manager.ds.Plugin(ctx) + plugin, err := repo.Get("test-metadata-agent") + Expect(err).ToNot(HaveOccurred()) + plugin.SHA256 = "different-hash-to-simulate-change" + err = repo.Put(plugin) + Expect(err).ToNot(HaveOccurred()) + + // Simulate modification - the plugin should be disabled and unloaded + manager.processPluginEvent("test-metadata-agent") + + // Should be unloaded + Expect(manager.PluginNames(string(CapabilityMetadataAgent))).ToNot(ContainElement("test-metadata-agent")) + + // But still in DB (just disabled) + plugin, err = repo.Get("test-metadata-agent") + Expect(err).ToNot(HaveOccurred()) + Expect(plugin.Enabled).To(BeFalse()) + }) + + It("removes plugin from DB when file is removed", func() { + copyTestPlugin() + + // First add and enable the plugin + manager.processPluginEvent("test-metadata-agent") + err := manager.EnablePlugin(ctx, "test-metadata-agent") + Expect(err).ToNot(HaveOccurred()) + + // Remove the file - plugin should be unloaded and removed from DB + _ = os.Remove(filepath.Join(tmpDir, "test-metadata-agent"+PackageExtension)) + manager.processPluginEvent("test-metadata-agent") + + // Should be unloaded + Expect(manager.PluginNames(string(CapabilityMetadataAgent))).ToNot(ContainElement("test-metadata-agent")) + + // And removed from DB + repo := manager.ds.Plugin(ctx) + _, err = repo.Get("test-metadata-agent") + Expect(err).To(HaveOccurred()) + }) + }) + + Describe("Watcher lifecycle", func() { + It("does not start file watcher when AutoReload is disabled", func() { + Expect(manager.watcherEvents).To(BeNil()) + Expect(manager.watcherDone).To(BeNil()) + }) + + It("starts file watcher when AutoReload is enabled", func() { + _ = manager.Stop() + + conf.Server.Plugins.AutoReload = true + + // Set up a mock DataStore for the auto-reload manager + mockPluginRepo := tests.CreateMockPluginRepo() + mockPluginRepo.Permitted = true + dataStore := &tests.MockDataStore{MockedPlugin: mockPluginRepo} + + autoReloadManager := &Manager{ + plugins: make(map[string]*plugin), + ds: dataStore, + subsonicRouter: http.NotFoundHandler(), + } + err := autoReloadManager.Start(ctx) + Expect(err).ToNot(HaveOccurred()) + DeferCleanup(autoReloadManager.Stop) + + Expect(autoReloadManager.watcherEvents).ToNot(BeNil()) + Expect(autoReloadManager.watcherDone).ToNot(BeNil()) + }) + }) + }) + + Describe("determinePluginAction", func() { + var tmpDir string + + BeforeEach(func() { + var err error + tmpDir, err = os.MkdirTemp("", "plugin-action-test-*") + Expect(err).ToNot(HaveOccurred()) + }) + + AfterEach(func() { + os.RemoveAll(tmpDir) + }) + + It("returns actionUpdate when file exists", func() { + filePath := filepath.Join(tmpDir, "test.ndp") + err := os.WriteFile(filePath, []byte("test"), 0600) + Expect(err).ToNot(HaveOccurred()) + + Expect(determinePluginAction(filePath)).To(Equal(actionUpdate)) + }) + + It("returns actionRemove when file does not exist", func() { + filePath := filepath.Join(tmpDir, "nonexistent.ndp") + Expect(determinePluginAction(filePath)).To(Equal(actionRemove)) + }) + }) +}) diff --git a/plugins/manifest-schema.json b/plugins/manifest-schema.json new file mode 100644 index 000000000..c15a3bf3d --- /dev/null +++ b/plugins/manifest-schema.json @@ -0,0 +1,259 @@ +{ + "$schema": "https://json-schema.org/draft/2020-12/schema", + "$id": "https://navidrome.org/schemas/Manifest.json", + "title": "Manifest", + "description": "Plugin manifest for Navidrome plugins", + "type": "object", + "additionalProperties": false, + "required": ["name", "author", "version"], + "properties": { + "name": { + "type": "string", + "description": "The display name of the plugin", + "minLength": 1 + }, + "author": { + "type": "string", + "description": "The author of the plugin", + "minLength": 1 + }, + "version": { + "type": "string", + "description": "The version of the plugin (semver recommended)", + "minLength": 1 + }, + "description": { + "type": "string", + "description": "A brief description of what the plugin does" + }, + "website": { + "type": "string", + "description": "URL to the plugin's website or repository", + "format": "uri" + }, + "permissions": { + "$ref": "#/$defs/Permissions" + }, + "experimental": { + "$ref": "#/$defs/Experimental" + }, + "config": { + "$ref": "#/$defs/ConfigDefinition" + } + }, + "$defs": { + "ConfigDefinition": { + "type": "object", + "description": "Configuration schema for the plugin using JSON Schema (draft-07) and optional JSONForms UI Schema", + "additionalProperties": false, + "required": ["schema"], + "properties": { + "schema": { + "type": "object", + "description": "JSON Schema (draft-07) defining the plugin's configuration options" + }, + "uiSchema": { + "type": "object", + "description": "Optional JSONForms UI Schema for customizing form layout" + } + } + }, + "Experimental": { + "type": "object", + "description": "Experimental features that may change or be removed in future versions", + "additionalProperties": false, + "properties": { + "threads": { + "$ref": "#/$defs/ThreadsFeature" + } + } + }, + "ThreadsFeature": { + "type": "object", + "description": "Enable experimental WebAssembly threads support", + "additionalProperties": false, + "properties": { + "reason": { + "type": "string", + "description": "Explanation for why threads support is needed" + } + } + }, + "Permissions": { + "type": "object", + "description": "Permissions required by the plugin", + "additionalProperties": false, + "properties": { + "http": { + "$ref": "#/$defs/HTTPPermission" + }, + "subsonicapi": { + "$ref": "#/$defs/SubsonicAPIPermission" + }, + "scheduler": { + "$ref": "#/$defs/SchedulerPermission" + }, + "websocket": { + "$ref": "#/$defs/WebSocketPermission" + }, + "artwork": { + "$ref": "#/$defs/ArtworkPermission" + }, + "cache": { + "$ref": "#/$defs/CachePermission" + }, + "library": { + "$ref": "#/$defs/LibraryPermission" + }, + "kvstore": { + "$ref": "#/$defs/KVStorePermission" + }, + "users": { + "$ref": "#/$defs/UsersPermission" + }, + "taskqueue": { + "$ref": "#/$defs/TaskQueuePermission" + } + } + }, + "ArtworkPermission": { + "type": "object", + "description": "Artwork service permissions for generating artwork URLs", + "additionalProperties": false, + "properties": { + "reason": { + "type": "string", + "description": "Explanation for why artwork access is needed" + } + } + }, + "CachePermission": { + "type": "object", + "description": "Cache service permissions for storing and retrieving data", + "additionalProperties": false, + "properties": { + "reason": { + "type": "string", + "description": "Explanation for why cache access is needed" + } + } + }, + "HTTPPermission": { + "type": "object", + "description": "HTTP access permissions for a plugin", + "additionalProperties": false, + "properties": { + "reason": { + "type": "string", + "description": "Explanation for why HTTP access is needed" + }, + "requiredHosts": { + "type": "array", + "description": "List of required host patterns for HTTP requests (e.g., 'api.example.com', '*.musicbrainz.org')", + "items": { + "type": "string" + } + } + } + }, + "SubsonicAPIPermission": { + "type": "object", + "description": "SubsonicAPI service permissions. Requires 'users' permission to be declared.", + "additionalProperties": false, + "properties": { + "reason": { + "type": "string", + "description": "Explanation for why SubsonicAPI access is needed" + } + } + }, + "SchedulerPermission": { + "type": "object", + "description": "Scheduler service permissions for scheduling tasks", + "additionalProperties": false, + "properties": { + "reason": { + "type": "string", + "description": "Explanation for why scheduler access is needed" + } + } + }, + "WebSocketPermission": { + "type": "object", + "description": "WebSocket service permissions for establishing WebSocket connections", + "additionalProperties": false, + "properties": { + "reason": { + "type": "string", + "description": "Explanation for why WebSocket access is needed" + }, + "requiredHosts": { + "type": "array", + "description": "List of required host patterns for WebSocket connections (e.g., 'api.example.com', '*.musicbrainz.org')", + "items": { + "type": "string" + } + } + } + }, + "LibraryPermission": { + "type": "object", + "description": "Library service permissions for accessing library metadata and optionally filesystem", + "additionalProperties": false, + "properties": { + "reason": { + "type": "string", + "description": "Explanation for why library access is needed" + }, + "filesystem": { + "type": "boolean", + "description": "Whether the plugin requires read-only filesystem access to library directories", + "default": false + } + } + }, + "KVStorePermission": { + "type": "object", + "description": "Key-value store permissions for persistent plugin storage", + "additionalProperties": false, + "properties": { + "reason": { + "type": "string", + "description": "Explanation for why key-value store access is needed" + }, + "maxSize": { + "type": "string", + "description": "Maximum storage size (e.g., '1MB', '500KB'). Default: 1MB" + } + } + }, + "TaskQueuePermission": { + "type": "object", + "description": "Task queue permissions for background task processing", + "additionalProperties": false, + "properties": { + "reason": { + "type": "string", + "description": "Explanation for why task queue access is needed" + }, + "maxConcurrency": { + "type": "integer", + "description": "Maximum total concurrent workers across all queues. Default: 1", + "minimum": 1, + "default": 1 + } + } + }, + "UsersPermission": { + "type": "object", + "description": "Users service permissions for accessing user information", + "additionalProperties": false, + "properties": { + "reason": { + "type": "string", + "description": "Explanation for why users access is needed" + } + } + } + } +} diff --git a/plugins/manifest.go b/plugins/manifest.go index b56187bcc..375e73e7f 100644 --- a/plugins/manifest.go +++ b/plugins/manifest.go @@ -1,30 +1,88 @@ package plugins -//go:generate go tool go-jsonschema --schema-root-type navidrome://plugins/manifest=PluginManifest -p schema --output schema/manifest_gen.go schema/manifest.schema.json - import ( - _ "embed" "encoding/json" "fmt" - "os" - "path/filepath" - "github.com/navidrome/navidrome/plugins/schema" + "github.com/santhosh-tekuri/jsonschema/v6" ) -// LoadManifest loads and parses the manifest.json file from the given plugin directory. -// Returns the generated schema.PluginManifest type with full validation and type safety. -func LoadManifest(pluginDir string) (*schema.PluginManifest, error) { - manifestPath := filepath.Join(pluginDir, "manifest.json") - data, err := os.ReadFile(manifestPath) - if err != nil { - return nil, fmt.Errorf("failed to read manifest file: %w", err) - } +//go:generate go tool go-jsonschema -p plugins --struct-name-from-title -o manifest_gen.go manifest-schema.json - var manifest schema.PluginManifest - if err := json.Unmarshal(data, &manifest); err != nil { - return nil, fmt.Errorf("invalid manifest: %w", err) +// ParseManifest unmarshals manifest JSON and performs cross-field validation. +// This is the single entry point for manifest parsing after reading from a file. +func ParseManifest(data []byte) (*Manifest, error) { + var m Manifest + if err := json.Unmarshal(data, &m); err != nil { + return nil, fmt.Errorf("parsing manifest JSON: %w", err) } - - return &manifest, nil + if err := m.Validate(); err != nil { + return nil, fmt.Errorf("validating manifest: %w", err) + } + return &m, nil +} + +// Validate performs cross-field validation that cannot be expressed in JSON Schema. +// This validates rules like "SubsonicAPI permission requires users permission". +func (m *Manifest) Validate() error { + // SubsonicAPI permission requires users permission + if m.Permissions != nil && m.Permissions.Subsonicapi != nil { + if m.Permissions.Users == nil { + return fmt.Errorf("'subsonicapi' permission requires 'users' permission to be declared") + } + } + + // Validate config schema if present + if m.Config != nil && m.Config.Schema != nil { + if err := validateConfigSchema(m.Config.Schema); err != nil { + return fmt.Errorf("invalid config schema: %w", err) + } + } + + return nil +} + +// validateConfigSchema validates that the schema is a valid JSON Schema that can be compiled. +func validateConfigSchema(schema map[string]any) error { + compiler := jsonschema.NewCompiler() + if err := compiler.AddResource("schema.json", schema); err != nil { + return fmt.Errorf("invalid schema structure: %w", err) + } + if _, err := compiler.Compile("schema.json"); err != nil { + return err + } + return nil +} + +// ValidateWithCapabilities validates the manifest against detected capabilities. +// This must be called after WASM capability detection since Scrobbler capability +// is detected from exported functions, not manifest declarations. +func ValidateWithCapabilities(m *Manifest, capabilities []Capability) error { + // Scrobbler capability requires users permission + if hasCapability(capabilities, CapabilityScrobbler) { + if m.Permissions == nil || m.Permissions.Users == nil { + return fmt.Errorf("scrobbler capability requires 'users' permission to be declared in manifest") + } + } + + // Scheduler permission requires SchedulerCallback capability + if m.Permissions != nil && m.Permissions.Scheduler != nil { + if !hasCapability(capabilities, CapabilityScheduler) { + return fmt.Errorf("'scheduler' permission requires plugin to export '%s' function", FuncSchedulerCallback) + } + } + + // Task (taskqueue) permission requires TaskWorker capability + if m.Permissions != nil && m.Permissions.Taskqueue != nil { + if !hasCapability(capabilities, CapabilityTaskWorker) { + return fmt.Errorf("'taskqueue' permission requires plugin to export '%s' function", FuncTaskWorkerCallback) + } + } + + return nil +} + +// HasExperimentalThreads returns true if the manifest requests experimental threads support. +func (m *Manifest) HasExperimentalThreads() bool { + return m.Experimental != nil && m.Experimental.Threads != nil } diff --git a/plugins/manifest_gen.go b/plugins/manifest_gen.go new file mode 100644 index 000000000..efe93e05f --- /dev/null +++ b/plugins/manifest_gen.go @@ -0,0 +1,256 @@ +// Code generated by github.com/atombender/go-jsonschema, DO NOT EDIT. + +package plugins + +import "encoding/json" +import "fmt" + +// Artwork service permissions for generating artwork URLs +type ArtworkPermission struct { + // Explanation for why artwork access is needed + Reason *string `json:"reason,omitempty" yaml:"reason,omitempty" mapstructure:"reason,omitempty"` +} + +// Cache service permissions for storing and retrieving data +type CachePermission struct { + // Explanation for why cache access is needed + Reason *string `json:"reason,omitempty" yaml:"reason,omitempty" mapstructure:"reason,omitempty"` +} + +// Configuration schema for the plugin using JSON Schema (draft-07) and optional +// JSONForms UI Schema +type ConfigDefinition struct { + // JSON Schema (draft-07) defining the plugin's configuration options + Schema map[string]interface{} `json:"schema" yaml:"schema" mapstructure:"schema"` + + // Optional JSONForms UI Schema for customizing form layout + UiSchema map[string]interface{} `json:"uiSchema,omitempty" yaml:"uiSchema,omitempty" mapstructure:"uiSchema,omitempty"` +} + +// UnmarshalJSON implements json.Unmarshaler. +func (j *ConfigDefinition) UnmarshalJSON(value []byte) error { + var raw map[string]interface{} + if err := json.Unmarshal(value, &raw); err != nil { + return err + } + if _, ok := raw["schema"]; raw != nil && !ok { + return fmt.Errorf("field schema in ConfigDefinition: required") + } + type Plain ConfigDefinition + var plain Plain + if err := json.Unmarshal(value, &plain); err != nil { + return err + } + *j = ConfigDefinition(plain) + return nil +} + +// Experimental features that may change or be removed in future versions +type Experimental struct { + // Threads corresponds to the JSON schema field "threads". + Threads *ThreadsFeature `json:"threads,omitempty" yaml:"threads,omitempty" mapstructure:"threads,omitempty"` +} + +// HTTP access permissions for a plugin +type HTTPPermission struct { + // Explanation for why HTTP access is needed + Reason *string `json:"reason,omitempty" yaml:"reason,omitempty" mapstructure:"reason,omitempty"` + + // List of required host patterns for HTTP requests (e.g., 'api.example.com', + // '*.musicbrainz.org') + RequiredHosts []string `json:"requiredHosts,omitempty" yaml:"requiredHosts,omitempty" mapstructure:"requiredHosts,omitempty"` +} + +// Key-value store permissions for persistent plugin storage +type KVStorePermission struct { + // Maximum storage size (e.g., '1MB', '500KB'). Default: 1MB + MaxSize *string `json:"maxSize,omitempty" yaml:"maxSize,omitempty" mapstructure:"maxSize,omitempty"` + + // Explanation for why key-value store access is needed + Reason *string `json:"reason,omitempty" yaml:"reason,omitempty" mapstructure:"reason,omitempty"` +} + +// Library service permissions for accessing library metadata and optionally +// filesystem +type LibraryPermission struct { + // Whether the plugin requires read-only filesystem access to library directories + Filesystem bool `json:"filesystem,omitempty" yaml:"filesystem,omitempty" mapstructure:"filesystem,omitempty"` + + // Explanation for why library access is needed + Reason *string `json:"reason,omitempty" yaml:"reason,omitempty" mapstructure:"reason,omitempty"` +} + +// UnmarshalJSON implements json.Unmarshaler. +func (j *LibraryPermission) UnmarshalJSON(value []byte) error { + var raw map[string]interface{} + if err := json.Unmarshal(value, &raw); err != nil { + return err + } + type Plain LibraryPermission + var plain Plain + if err := json.Unmarshal(value, &plain); err != nil { + return err + } + if v, ok := raw["filesystem"]; !ok || v == nil { + plain.Filesystem = false + } + *j = LibraryPermission(plain) + return nil +} + +// Plugin manifest for Navidrome plugins +type Manifest struct { + // The author of the plugin + Author string `json:"author" yaml:"author" mapstructure:"author"` + + // Config corresponds to the JSON schema field "config". + Config *ConfigDefinition `json:"config,omitempty" yaml:"config,omitempty" mapstructure:"config,omitempty"` + + // A brief description of what the plugin does + Description *string `json:"description,omitempty" yaml:"description,omitempty" mapstructure:"description,omitempty"` + + // Experimental corresponds to the JSON schema field "experimental". + Experimental *Experimental `json:"experimental,omitempty" yaml:"experimental,omitempty" mapstructure:"experimental,omitempty"` + + // The display name of the plugin + Name string `json:"name" yaml:"name" mapstructure:"name"` + + // Permissions corresponds to the JSON schema field "permissions". + Permissions *Permissions `json:"permissions,omitempty" yaml:"permissions,omitempty" mapstructure:"permissions,omitempty"` + + // The version of the plugin (semver recommended) + Version string `json:"version" yaml:"version" mapstructure:"version"` + + // URL to the plugin's website or repository + Website *string `json:"website,omitempty" yaml:"website,omitempty" mapstructure:"website,omitempty"` +} + +// UnmarshalJSON implements json.Unmarshaler. +func (j *Manifest) UnmarshalJSON(value []byte) error { + var raw map[string]interface{} + if err := json.Unmarshal(value, &raw); err != nil { + return err + } + if _, ok := raw["author"]; raw != nil && !ok { + return fmt.Errorf("field author in Manifest: required") + } + if _, ok := raw["name"]; raw != nil && !ok { + return fmt.Errorf("field name in Manifest: required") + } + if _, ok := raw["version"]; raw != nil && !ok { + return fmt.Errorf("field version in Manifest: required") + } + type Plain Manifest + var plain Plain + if err := json.Unmarshal(value, &plain); err != nil { + return err + } + if len(plain.Author) < 1 { + return fmt.Errorf("field %s length: must be >= %d", "author", 1) + } + if len(plain.Name) < 1 { + return fmt.Errorf("field %s length: must be >= %d", "name", 1) + } + if len(plain.Version) < 1 { + return fmt.Errorf("field %s length: must be >= %d", "version", 1) + } + *j = Manifest(plain) + return nil +} + +// Permissions required by the plugin +type Permissions struct { + // Artwork corresponds to the JSON schema field "artwork". + Artwork *ArtworkPermission `json:"artwork,omitempty" yaml:"artwork,omitempty" mapstructure:"artwork,omitempty"` + + // Cache corresponds to the JSON schema field "cache". + Cache *CachePermission `json:"cache,omitempty" yaml:"cache,omitempty" mapstructure:"cache,omitempty"` + + // Http corresponds to the JSON schema field "http". + Http *HTTPPermission `json:"http,omitempty" yaml:"http,omitempty" mapstructure:"http,omitempty"` + + // Kvstore corresponds to the JSON schema field "kvstore". + Kvstore *KVStorePermission `json:"kvstore,omitempty" yaml:"kvstore,omitempty" mapstructure:"kvstore,omitempty"` + + // Library corresponds to the JSON schema field "library". + Library *LibraryPermission `json:"library,omitempty" yaml:"library,omitempty" mapstructure:"library,omitempty"` + + // Scheduler corresponds to the JSON schema field "scheduler". + Scheduler *SchedulerPermission `json:"scheduler,omitempty" yaml:"scheduler,omitempty" mapstructure:"scheduler,omitempty"` + + // Subsonicapi corresponds to the JSON schema field "subsonicapi". + Subsonicapi *SubsonicAPIPermission `json:"subsonicapi,omitempty" yaml:"subsonicapi,omitempty" mapstructure:"subsonicapi,omitempty"` + + // Taskqueue corresponds to the JSON schema field "taskqueue". + Taskqueue *TaskQueuePermission `json:"taskqueue,omitempty" yaml:"taskqueue,omitempty" mapstructure:"taskqueue,omitempty"` + + // Users corresponds to the JSON schema field "users". + Users *UsersPermission `json:"users,omitempty" yaml:"users,omitempty" mapstructure:"users,omitempty"` + + // Websocket corresponds to the JSON schema field "websocket". + Websocket *WebSocketPermission `json:"websocket,omitempty" yaml:"websocket,omitempty" mapstructure:"websocket,omitempty"` +} + +// Scheduler service permissions for scheduling tasks +type SchedulerPermission struct { + // Explanation for why scheduler access is needed + Reason *string `json:"reason,omitempty" yaml:"reason,omitempty" mapstructure:"reason,omitempty"` +} + +// SubsonicAPI service permissions. Requires 'users' permission to be declared. +type SubsonicAPIPermission struct { + // Explanation for why SubsonicAPI access is needed + Reason *string `json:"reason,omitempty" yaml:"reason,omitempty" mapstructure:"reason,omitempty"` +} + +// Task queue permissions for background task processing +type TaskQueuePermission struct { + // Maximum total concurrent workers across all queues. Default: 1 + MaxConcurrency int `json:"maxConcurrency,omitempty" yaml:"maxConcurrency,omitempty" mapstructure:"maxConcurrency,omitempty"` + + // Explanation for why task queue access is needed + Reason *string `json:"reason,omitempty" yaml:"reason,omitempty" mapstructure:"reason,omitempty"` +} + +// UnmarshalJSON implements json.Unmarshaler. +func (j *TaskQueuePermission) UnmarshalJSON(value []byte) error { + var raw map[string]interface{} + if err := json.Unmarshal(value, &raw); err != nil { + return err + } + type Plain TaskQueuePermission + var plain Plain + if err := json.Unmarshal(value, &plain); err != nil { + return err + } + if v, ok := raw["maxConcurrency"]; !ok || v == nil { + plain.MaxConcurrency = 1.0 + } + if 1 > plain.MaxConcurrency { + return fmt.Errorf("field %s: must be >= %v", "maxConcurrency", 1) + } + *j = TaskQueuePermission(plain) + return nil +} + +// Enable experimental WebAssembly threads support +type ThreadsFeature struct { + // Explanation for why threads support is needed + Reason *string `json:"reason,omitempty" yaml:"reason,omitempty" mapstructure:"reason,omitempty"` +} + +// Users service permissions for accessing user information +type UsersPermission struct { + // Explanation for why users access is needed + Reason *string `json:"reason,omitempty" yaml:"reason,omitempty" mapstructure:"reason,omitempty"` +} + +// WebSocket service permissions for establishing WebSocket connections +type WebSocketPermission struct { + // Explanation for why WebSocket access is needed + Reason *string `json:"reason,omitempty" yaml:"reason,omitempty" mapstructure:"reason,omitempty"` + + // List of required host patterns for WebSocket connections (e.g., + // 'api.example.com', '*.musicbrainz.org') + RequiredHosts []string `json:"requiredHosts,omitempty" yaml:"requiredHosts,omitempty" mapstructure:"requiredHosts,omitempty"` +} diff --git a/plugins/manifest_permissions_test.go b/plugins/manifest_permissions_test.go deleted file mode 100644 index 7a3df5f2d..000000000 --- a/plugins/manifest_permissions_test.go +++ /dev/null @@ -1,526 +0,0 @@ -package plugins - -import ( - "context" - "encoding/json" - "os" - "path/filepath" - - "github.com/navidrome/navidrome/conf" - "github.com/navidrome/navidrome/conf/configtest" - "github.com/navidrome/navidrome/core/metrics" - "github.com/navidrome/navidrome/plugins/schema" - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" -) - -// Helper function to create test plugins with typed permissions -func createTestPlugin(tempDir, name string, permissions schema.PluginManifestPermissions) string { - pluginDir := filepath.Join(tempDir, name) - Expect(os.MkdirAll(pluginDir, 0755)).To(Succeed()) - - // Use the generated PluginManifest type directly - it handles JSON marshaling automatically - manifest := schema.PluginManifest{ - Name: name, - Author: "Test Author", - Version: "1.0.0", - Description: "Test plugin for permissions", - Website: "https://test.navidrome.org/" + name, - Capabilities: []schema.PluginManifestCapabilitiesElem{ - schema.PluginManifestCapabilitiesElemMetadataAgent, - }, - Permissions: permissions, - } - - // Marshal the typed manifest directly - gets all validation for free - manifestData, err := json.Marshal(manifest) - Expect(err).NotTo(HaveOccurred()) - - manifestPath := filepath.Join(pluginDir, "manifest.json") - Expect(os.WriteFile(manifestPath, manifestData, 0600)).To(Succeed()) - - // Create fake WASM file (since plugin discovery checks for it) - wasmPath := filepath.Join(pluginDir, "plugin.wasm") - Expect(os.WriteFile(wasmPath, []byte("fake wasm content"), 0600)).To(Succeed()) - - return pluginDir -} - -var _ = Describe("Plugin Permissions", func() { - var ( - mgr *managerImpl - tempDir string - ctx context.Context - ) - - BeforeEach(func() { - DeferCleanup(configtest.SetupConfig()) - ctx = context.Background() - mgr = createManager(nil, metrics.NewNoopInstance()) - tempDir = GinkgoT().TempDir() - }) - - Describe("Permission Enforcement in createRuntime", func() { - It("should only load services specified in permissions", func() { - // Test with limited permissions using typed structs - permissions := schema.PluginManifestPermissions{ - Http: &schema.PluginManifestPermissionsHttp{ - Reason: "To fetch data from external APIs", - AllowedUrls: map[string][]schema.PluginManifestPermissionsHttpAllowedUrlsValueElem{ - "*": {schema.PluginManifestPermissionsHttpAllowedUrlsValueElemWildcard}, - }, - AllowLocalNetwork: false, - }, - Config: &schema.PluginManifestPermissionsConfig{ - Reason: "To read configuration settings", - }, - } - - runtimeFunc := mgr.createRuntime("test-plugin", permissions) - - // Create runtime to test service availability - runtime, err := runtimeFunc(ctx) - Expect(err).NotTo(HaveOccurred()) - defer runtime.Close(ctx) - - // The runtime was created successfully with the specified permissions - Expect(runtime).NotTo(BeNil()) - - // Note: The actual verification of which specific host functions are available - // would require introspecting the WASM runtime, which is complex. - // The key test is that the runtime creation succeeds with valid permissions. - }) - - It("should create runtime with empty permissions", func() { - permissions := schema.PluginManifestPermissions{} - - runtimeFunc := mgr.createRuntime("empty-permissions-plugin", permissions) - - runtime, err := runtimeFunc(ctx) - Expect(err).NotTo(HaveOccurred()) - defer runtime.Close(ctx) - - // Should succeed but with no host services available - Expect(runtime).NotTo(BeNil()) - }) - - It("should handle all available permissions", func() { - // Test with all possible permissions using typed structs - permissions := schema.PluginManifestPermissions{ - Http: &schema.PluginManifestPermissionsHttp{ - Reason: "To fetch data from external APIs", - AllowedUrls: map[string][]schema.PluginManifestPermissionsHttpAllowedUrlsValueElem{ - "*": {schema.PluginManifestPermissionsHttpAllowedUrlsValueElemWildcard}, - }, - AllowLocalNetwork: false, - }, - Config: &schema.PluginManifestPermissionsConfig{ - Reason: "To read configuration settings", - }, - Scheduler: &schema.PluginManifestPermissionsScheduler{ - Reason: "To schedule periodic tasks", - }, - Websocket: &schema.PluginManifestPermissionsWebsocket{ - Reason: "To handle real-time communication", - AllowedUrls: []string{"wss://api.example.com"}, - AllowLocalNetwork: false, - }, - Cache: &schema.PluginManifestPermissionsCache{ - Reason: "To cache data and reduce API calls", - }, - Artwork: &schema.PluginManifestPermissionsArtwork{ - Reason: "To generate artwork URLs", - }, - } - - runtimeFunc := mgr.createRuntime("full-permissions-plugin", permissions) - - runtime, err := runtimeFunc(ctx) - Expect(err).NotTo(HaveOccurred()) - defer runtime.Close(ctx) - - Expect(runtime).NotTo(BeNil()) - }) - }) - - Describe("Plugin Discovery with Permissions", func() { - BeforeEach(func() { - conf.Server.Plugins.Folder = tempDir - }) - - It("should discover plugin with valid permissions manifest", func() { - // Create plugin with http permission using typed structs - permissions := schema.PluginManifestPermissions{ - Http: &schema.PluginManifestPermissionsHttp{ - Reason: "To fetch metadata from external APIs", - AllowedUrls: map[string][]schema.PluginManifestPermissionsHttpAllowedUrlsValueElem{ - "*": {schema.PluginManifestPermissionsHttpAllowedUrlsValueElemWildcard}, - }, - }, - } - createTestPlugin(tempDir, "valid-plugin", permissions) - - // Scan for plugins - mgr.ScanPlugins() - - // Verify plugin was discovered (even without valid WASM) - pluginNames := mgr.PluginNames("MetadataAgent") - Expect(pluginNames).To(ContainElement("valid-plugin")) - }) - - It("should discover plugin with no permissions", func() { - // Create plugin with empty permissions using typed structs - permissions := schema.PluginManifestPermissions{} - createTestPlugin(tempDir, "no-perms-plugin", permissions) - - mgr.ScanPlugins() - - pluginNames := mgr.PluginNames("MetadataAgent") - Expect(pluginNames).To(ContainElement("no-perms-plugin")) - }) - - It("should discover plugin with multiple permissions", func() { - // Create plugin with multiple permissions using typed structs - permissions := schema.PluginManifestPermissions{ - Http: &schema.PluginManifestPermissionsHttp{ - Reason: "To fetch metadata from external APIs", - AllowedUrls: map[string][]schema.PluginManifestPermissionsHttpAllowedUrlsValueElem{ - "*": {schema.PluginManifestPermissionsHttpAllowedUrlsValueElemWildcard}, - }, - }, - Config: &schema.PluginManifestPermissionsConfig{ - Reason: "To read plugin configuration settings", - }, - Scheduler: &schema.PluginManifestPermissionsScheduler{ - Reason: "To schedule periodic data updates", - }, - } - createTestPlugin(tempDir, "multi-perms-plugin", permissions) - - mgr.ScanPlugins() - - pluginNames := mgr.PluginNames("MetadataAgent") - Expect(pluginNames).To(ContainElement("multi-perms-plugin")) - }) - }) - - Describe("Existing Plugin Permissions", func() { - BeforeEach(func() { - // Use the testdata directory with updated plugins - conf.Server.Plugins.Folder = testDataDir - mgr.ScanPlugins() - }) - - It("should discover fake_scrobbler with empty permissions", func() { - scrobblerNames := mgr.PluginNames(CapabilityScrobbler) - Expect(scrobblerNames).To(ContainElement("fake_scrobbler")) - }) - - It("should discover multi_plugin with scheduler permissions", func() { - agentNames := mgr.PluginNames(CapabilityMetadataAgent) - Expect(agentNames).To(ContainElement("multi_plugin")) - }) - - It("should discover all test plugins successfully", func() { - // All test plugins should be discovered with their updated permissions - testPlugins := []struct { - name string - capability string - }{ - {"fake_album_agent", CapabilityMetadataAgent}, - {"fake_artist_agent", CapabilityMetadataAgent}, - {"fake_scrobbler", CapabilityScrobbler}, - {"multi_plugin", CapabilityMetadataAgent}, - {"fake_init_service", CapabilityLifecycleManagement}, - } - - for _, testPlugin := range testPlugins { - pluginNames := mgr.PluginNames(testPlugin.capability) - Expect(pluginNames).To(ContainElement(testPlugin.name), "Plugin %s should be discovered", testPlugin.name) - } - }) - }) - - Describe("Permission Validation", func() { - It("should enforce permissions are required in manifest", func() { - // Create a manifest JSON string without the permissions field - manifestContent := `{ - "name": "test-plugin", - "author": "Test Author", - "version": "1.0.0", - "description": "A test plugin", - "website": "https://test.navidrome.org/test-plugin", - "capabilities": ["MetadataAgent"] - }` - - manifestPath := filepath.Join(tempDir, "manifest.json") - err := os.WriteFile(manifestPath, []byte(manifestContent), 0600) - Expect(err).NotTo(HaveOccurred()) - - _, err = LoadManifest(tempDir) - Expect(err).To(HaveOccurred()) - Expect(err.Error()).To(ContainSubstring("field permissions in PluginManifest: required")) - }) - - It("should allow unknown permission keys", func() { - // Create manifest with both known and unknown permission types - pluginDir := filepath.Join(tempDir, "unknown-perms") - Expect(os.MkdirAll(pluginDir, 0755)).To(Succeed()) - - manifestContent := `{ - "name": "unknown-perms", - "author": "Test Author", - "version": "1.0.0", - "description": "Manifest with unknown permissions", - "website": "https://test.navidrome.org/unknown-perms", - "capabilities": ["MetadataAgent"], - "permissions": { - "http": { - "reason": "To fetch data from external APIs", - "allowedUrls": { - "*": ["*"] - } - }, - "unknown": { - "customField": "customValue" - } - } - }` - - Expect(os.WriteFile(filepath.Join(pluginDir, "manifest.json"), []byte(manifestContent), 0600)).To(Succeed()) - - // Test manifest loading directly - should succeed even with unknown permissions - loadedManifest, err := LoadManifest(pluginDir) - Expect(err).NotTo(HaveOccurred()) - Expect(loadedManifest).NotTo(BeNil()) - // With typed permissions, we check the specific fields - Expect(loadedManifest.Permissions.Http).NotTo(BeNil()) - Expect(loadedManifest.Permissions.Http.Reason).To(Equal("To fetch data from external APIs")) - // The key point is that the manifest loads successfully despite unknown permissions - // The actual handling of AdditionalProperties depends on the JSON schema implementation - }) - }) - - Describe("Runtime Pool with Permissions", func() { - It("should create separate runtimes for different permission sets", func() { - // Create two different permission sets using typed structs - permissions1 := schema.PluginManifestPermissions{ - Http: &schema.PluginManifestPermissionsHttp{ - Reason: "To fetch data from external APIs", - AllowedUrls: map[string][]schema.PluginManifestPermissionsHttpAllowedUrlsValueElem{ - "*": {schema.PluginManifestPermissionsHttpAllowedUrlsValueElemWildcard}, - }, - AllowLocalNetwork: false, - }, - } - permissions2 := schema.PluginManifestPermissions{ - Config: &schema.PluginManifestPermissionsConfig{ - Reason: "To read configuration settings", - }, - } - - runtimeFunc1 := mgr.createRuntime("plugin1", permissions1) - runtimeFunc2 := mgr.createRuntime("plugin2", permissions2) - - runtime1, err1 := runtimeFunc1(ctx) - Expect(err1).NotTo(HaveOccurred()) - defer runtime1.Close(ctx) - - runtime2, err2 := runtimeFunc2(ctx) - Expect(err2).NotTo(HaveOccurred()) - defer runtime2.Close(ctx) - - // Should be different runtime instances - Expect(runtime1).NotTo(BeIdenticalTo(runtime2)) - }) - }) - - Describe("Permission System Integration", func() { - It("should successfully validate manifests with permissions", func() { - // Create a valid manifest with permissions - pluginDir := filepath.Join(tempDir, "valid-manifest") - Expect(os.MkdirAll(pluginDir, 0755)).To(Succeed()) - - manifestContent := `{ - "name": "valid-manifest", - "author": "Test Author", - "version": "1.0.0", - "description": "Valid manifest with permissions", - "website": "https://test.navidrome.org/valid-manifest", - "capabilities": ["MetadataAgent"], - "permissions": { - "http": { - "reason": "To fetch metadata from external APIs", - "allowedUrls": { - "*": ["*"] - } - }, - "config": { - "reason": "To read plugin configuration settings" - } - } - }` - - Expect(os.WriteFile(filepath.Join(pluginDir, "manifest.json"), []byte(manifestContent), 0600)).To(Succeed()) - - // Load the manifest - should succeed - manifest, err := LoadManifest(pluginDir) - Expect(err).NotTo(HaveOccurred()) - Expect(manifest).NotTo(BeNil()) - // With typed permissions, check the specific permission fields - Expect(manifest.Permissions.Http).NotTo(BeNil()) - Expect(manifest.Permissions.Http.Reason).To(Equal("To fetch metadata from external APIs")) - Expect(manifest.Permissions.Config).NotTo(BeNil()) - Expect(manifest.Permissions.Config.Reason).To(Equal("To read plugin configuration settings")) - }) - - It("should track which services are requested per plugin", func() { - // Test that different plugins can have different permission sets - permissions1 := schema.PluginManifestPermissions{ - Http: &schema.PluginManifestPermissionsHttp{ - Reason: "To fetch data from external APIs", - AllowedUrls: map[string][]schema.PluginManifestPermissionsHttpAllowedUrlsValueElem{ - "*": {schema.PluginManifestPermissionsHttpAllowedUrlsValueElemWildcard}, - }, - AllowLocalNetwork: false, - }, - Config: &schema.PluginManifestPermissionsConfig{ - Reason: "To read configuration settings", - }, - } - permissions2 := schema.PluginManifestPermissions{ - Scheduler: &schema.PluginManifestPermissionsScheduler{ - Reason: "To schedule periodic tasks", - }, - Config: &schema.PluginManifestPermissionsConfig{ - Reason: "To read configuration for scheduler", - }, - } - permissions3 := schema.PluginManifestPermissions{} // Empty permissions - - createTestPlugin(tempDir, "plugin-with-http", permissions1) - createTestPlugin(tempDir, "plugin-with-scheduler", permissions2) - createTestPlugin(tempDir, "plugin-with-none", permissions3) - - conf.Server.Plugins.Folder = tempDir - mgr.ScanPlugins() - - // All should be discovered - pluginNames := mgr.PluginNames(CapabilityMetadataAgent) - Expect(pluginNames).To(ContainElement("plugin-with-http")) - Expect(pluginNames).To(ContainElement("plugin-with-scheduler")) - Expect(pluginNames).To(ContainElement("plugin-with-none")) - }) - }) - - Describe("Runtime Service Access Control", func() { - It("should successfully create runtime with permitted services", func() { - // Create runtime with HTTP permission using typed struct - permissions := schema.PluginManifestPermissions{ - Http: &schema.PluginManifestPermissionsHttp{ - Reason: "To fetch data from external APIs", - AllowedUrls: map[string][]schema.PluginManifestPermissionsHttpAllowedUrlsValueElem{ - "*": {schema.PluginManifestPermissionsHttpAllowedUrlsValueElemWildcard}, - }, - AllowLocalNetwork: false, - }, - } - - runtimeFunc := mgr.createRuntime("http-only-plugin", permissions) - runtime, err := runtimeFunc(ctx) - Expect(err).NotTo(HaveOccurred()) - defer runtime.Close(ctx) - - // Runtime should be created successfully - host functions are loaded during runtime creation - Expect(runtime).NotTo(BeNil()) - }) - - It("should successfully create runtime with multiple permitted services", func() { - // Create runtime with multiple permissions using typed structs - permissions := schema.PluginManifestPermissions{ - Http: &schema.PluginManifestPermissionsHttp{ - Reason: "To fetch data from external APIs", - AllowedUrls: map[string][]schema.PluginManifestPermissionsHttpAllowedUrlsValueElem{ - "*": {schema.PluginManifestPermissionsHttpAllowedUrlsValueElemWildcard}, - }, - AllowLocalNetwork: false, - }, - Config: &schema.PluginManifestPermissionsConfig{ - Reason: "To read configuration settings", - }, - Scheduler: &schema.PluginManifestPermissionsScheduler{ - Reason: "To schedule periodic tasks", - }, - } - - runtimeFunc := mgr.createRuntime("multi-service-plugin", permissions) - runtime, err := runtimeFunc(ctx) - Expect(err).NotTo(HaveOccurred()) - defer runtime.Close(ctx) - - // Runtime should be created successfully - Expect(runtime).NotTo(BeNil()) - }) - - It("should create runtime with no services when no permissions granted", func() { - // Create runtime with empty permissions using typed struct - emptyPermissions := schema.PluginManifestPermissions{} - - runtimeFunc := mgr.createRuntime("no-service-plugin", emptyPermissions) - runtime, err := runtimeFunc(ctx) - Expect(err).NotTo(HaveOccurred()) - defer runtime.Close(ctx) - - // Runtime should still be created, but with no host services - Expect(runtime).NotTo(BeNil()) - }) - - It("should demonstrate secure-by-default behavior", func() { - // Test that default (empty permissions) provides no services - defaultPermissions := schema.PluginManifestPermissions{} - runtimeFunc := mgr.createRuntime("default-plugin", defaultPermissions) - runtime, err := runtimeFunc(ctx) - Expect(err).NotTo(HaveOccurred()) - defer runtime.Close(ctx) - - // Runtime should be created but with no host services - Expect(runtime).NotTo(BeNil()) - }) - - It("should test permission enforcement by simulating unauthorized service access", func() { - // This test demonstrates that plugins would fail at runtime when trying to call - // host functions they don't have permission for, since those functions are simply - // not loaded into the WASM runtime environment. - - // Create two different runtimes with different permissions using typed structs - httpOnlyPermissions := schema.PluginManifestPermissions{ - Http: &schema.PluginManifestPermissionsHttp{ - Reason: "To fetch data from external APIs", - AllowedUrls: map[string][]schema.PluginManifestPermissionsHttpAllowedUrlsValueElem{ - "*": {schema.PluginManifestPermissionsHttpAllowedUrlsValueElemWildcard}, - }, - AllowLocalNetwork: false, - }, - } - configOnlyPermissions := schema.PluginManifestPermissions{ - Config: &schema.PluginManifestPermissionsConfig{ - Reason: "To read configuration settings", - }, - } - - httpRuntime, err := mgr.createRuntime("http-only", httpOnlyPermissions)(ctx) - Expect(err).NotTo(HaveOccurred()) - defer httpRuntime.Close(ctx) - - configRuntime, err := mgr.createRuntime("config-only", configOnlyPermissions)(ctx) - Expect(err).NotTo(HaveOccurred()) - defer configRuntime.Close(ctx) - - // Both runtimes should be created successfully, but they will have different - // sets of host functions available. A plugin trying to call unauthorized - // functions would get "function not found" errors during instantiation or execution. - Expect(httpRuntime).NotTo(BeNil()) - Expect(configRuntime).NotTo(BeNil()) - }) - }) -}) diff --git a/plugins/manifest_test.go b/plugins/manifest_test.go index 2ec3edd19..c45a480eb 100644 --- a/plugins/manifest_test.go +++ b/plugins/manifest_test.go @@ -1,144 +1,467 @@ package plugins import ( - "os" - "path/filepath" + "encoding/json" - "github.com/navidrome/navidrome/plugins/schema" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) -var _ = Describe("Plugin Manifest", func() { - var tempDir string - - BeforeEach(func() { - tempDir = GinkgoT().TempDir() - }) - - It("should load and parse a valid manifest", func() { - manifestPath := filepath.Join(tempDir, "manifest.json") - manifestContent := []byte(`{ - "name": "test-plugin", - "author": "Test Author", - "version": "1.0.0", - "description": "A test plugin", - "website": "https://test.navidrome.org/test-plugin", - "capabilities": ["MetadataAgent", "Scrobbler"], - "permissions": { - "http": { - "reason": "To fetch metadata", - "allowedUrls": { - "https://api.example.com/*": ["GET"] +var _ = Describe("Manifest", func() { + Describe("UnmarshalJSON", func() { + It("parses a valid manifest", func() { + data := []byte(`{ + "name": "Test Plugin", + "author": "Test Author", + "version": "1.0.0", + "description": "A test plugin", + "website": "https://example.com", + "permissions": { + "http": { + "reason": "Fetch metadata", + "requiredHosts": ["api.example.com", "*.musicbrainz.org"] } } + }`) + + var m Manifest + err := json.Unmarshal(data, &m) + Expect(err).ToNot(HaveOccurred()) + Expect(m.Name).To(Equal("Test Plugin")) + Expect(m.Author).To(Equal("Test Author")) + Expect(m.Version).To(Equal("1.0.0")) + Expect(*m.Description).To(Equal("A test plugin")) + Expect(*m.Website).To(Equal("https://example.com")) + Expect(m.Permissions.Http).ToNot(BeNil()) + Expect(*m.Permissions.Http.Reason).To(Equal("Fetch metadata")) + Expect(m.Permissions.Http.RequiredHosts).To(ContainElements("api.example.com", "*.musicbrainz.org")) + }) + + It("parses a minimal manifest", func() { + data := []byte(`{ + "name": "Minimal Plugin", + "author": "Author", + "version": "1.0.0" + }`) + + var m Manifest + err := json.Unmarshal(data, &m) + Expect(err).ToNot(HaveOccurred()) + Expect(m.Name).To(Equal("Minimal Plugin")) + Expect(m.Author).To(Equal("Author")) + Expect(m.Version).To(Equal("1.0.0")) + Expect(m.Description).To(BeNil()) + Expect(m.Permissions).To(BeNil()) + }) + + It("returns an error for invalid JSON", func() { + data := []byte(`{invalid json}`) + + var m Manifest + err := json.Unmarshal(data, &m) + Expect(err).To(HaveOccurred()) + }) + + It("returns an error when name is missing", func() { + data := []byte(`{"author": "Test Author", "version": "1.0.0"}`) + + var m Manifest + err := json.Unmarshal(data, &m) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("name")) + }) + + It("returns an error when author is missing", func() { + data := []byte(`{"name": "Test Plugin", "version": "1.0.0"}`) + + var m Manifest + err := json.Unmarshal(data, &m) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("author")) + }) + + It("returns an error when version is missing", func() { + data := []byte(`{"name": "Test Plugin", "author": "Test Author"}`) + + var m Manifest + err := json.Unmarshal(data, &m) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("version")) + }) + + It("returns an error when name is empty", func() { + data := []byte(`{"name": "", "author": "Test Author", "version": "1.0.0"}`) + + var m Manifest + err := json.Unmarshal(data, &m) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("name")) + }) + + It("returns an error when author is empty", func() { + data := []byte(`{"name": "Test Plugin", "author": "", "version": "1.0.0"}`) + + var m Manifest + err := json.Unmarshal(data, &m) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("author")) + }) + + It("returns an error when version is empty", func() { + data := []byte(`{"name": "Test Plugin", "author": "Test Author", "version": ""}`) + + var m Manifest + err := json.Unmarshal(data, &m) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("version")) + }) + }) + + Describe("HasExperimentalThreads", func() { + It("returns false when no experimental section", func() { + m := &Manifest{} + Expect(m.HasExperimentalThreads()).To(BeFalse()) + }) + + It("returns false when experimental section has no threads", func() { + m := &Manifest{ + Experimental: &Experimental{}, } - }`) + Expect(m.HasExperimentalThreads()).To(BeFalse()) + }) - err := os.WriteFile(manifestPath, manifestContent, 0600) - Expect(err).NotTo(HaveOccurred()) + It("returns true when threads feature is present", func() { + m := &Manifest{ + Experimental: &Experimental{ + Threads: &ThreadsFeature{}, + }, + } + Expect(m.HasExperimentalThreads()).To(BeTrue()) + }) - manifest, err := LoadManifest(tempDir) - Expect(err).NotTo(HaveOccurred()) - Expect(manifest).NotTo(BeNil()) - Expect(manifest.Name).To(Equal("test-plugin")) - Expect(manifest.Author).To(Equal("Test Author")) - Expect(manifest.Version).To(Equal("1.0.0")) - Expect(manifest.Description).To(Equal("A test plugin")) - Expect(manifest.Capabilities).To(HaveLen(2)) - Expect(manifest.Capabilities[0]).To(Equal(schema.PluginManifestCapabilitiesElemMetadataAgent)) - Expect(manifest.Capabilities[1]).To(Equal(schema.PluginManifestCapabilitiesElemScrobbler)) - Expect(manifest.Permissions.Http).NotTo(BeNil()) - Expect(manifest.Permissions.Http.Reason).To(Equal("To fetch metadata")) + It("returns true when threads feature has a reason", func() { + reason := "Required for concurrent processing" + m := &Manifest{ + Experimental: &Experimental{ + Threads: &ThreadsFeature{ + Reason: &reason, + }, + }, + } + Expect(m.HasExperimentalThreads()).To(BeTrue()) + }) + + It("parses experimental.threads from JSON", func() { + data := []byte(`{ + "name": "Threaded Plugin", + "author": "Test Author", + "version": "1.0.0", + "experimental": { + "threads": { + "reason": "To use multi-threaded WASM module" + } + } + }`) + + var m Manifest + err := json.Unmarshal(data, &m) + Expect(err).ToNot(HaveOccurred()) + Expect(m.HasExperimentalThreads()).To(BeTrue()) + Expect(m.Experimental.Threads.Reason).ToNot(BeNil()) + Expect(*m.Experimental.Threads.Reason).To(Equal("To use multi-threaded WASM module")) + }) + + It("parses experimental.threads without reason from JSON", func() { + data := []byte(`{ + "name": "Threaded Plugin", + "author": "Test Author", + "version": "1.0.0", + "experimental": { + "threads": {} + } + }`) + + var m Manifest + err := json.Unmarshal(data, &m) + Expect(err).ToNot(HaveOccurred()) + Expect(m.HasExperimentalThreads()).To(BeTrue()) + }) }) - It("should fail with proper error for non-existent manifest", func() { - _, err := LoadManifest(filepath.Join(tempDir, "non-existent")) - Expect(err).To(HaveOccurred()) - Expect(err.Error()).To(ContainSubstring("failed to read manifest file")) + Describe("ParseManifest", func() { + It("parses a valid manifest with users permission", func() { + data := []byte(`{ + "name": "Test Plugin", + "author": "Test Author", + "version": "1.0.0", + "permissions": { + "subsonicapi": {}, + "users": {} + } + }`) + + m, err := ParseManifest(data) + Expect(err).ToNot(HaveOccurred()) + Expect(m.Name).To(Equal("Test Plugin")) + Expect(m.Permissions.Subsonicapi).ToNot(BeNil()) + Expect(m.Permissions.Users).ToNot(BeNil()) + }) + + It("returns error for invalid JSON", func() { + data := []byte(`{invalid}`) + + _, err := ParseManifest(data) + Expect(err).To(HaveOccurred()) + }) + + It("returns error when subsonicapi is requested without users permission", func() { + data := []byte(`{ + "name": "Test Plugin", + "author": "Test Author", + "version": "1.0.0", + "permissions": { + "subsonicapi": {} + } + }`) + + _, err := ParseManifest(data) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("subsonicapi")) + Expect(err.Error()).To(ContainSubstring("users")) + }) }) - It("should fail with JSON parse error for invalid JSON", func() { - // Create invalid JSON - invalidJSON := `{ - "name": "test-plugin", - "author": "Test Author" - "version": "1.0.0" - "description": "A test plugin", - "capabilities": ["MetadataAgent"], - "permissions": {} - }` + Describe("Validate", func() { + It("validates manifest with subsonicapi and users permissions", func() { + m := &Manifest{ + Name: "Test", + Author: "Author", + Version: "1.0.0", + Permissions: &Permissions{ + Subsonicapi: &SubsonicAPIPermission{}, + Users: &UsersPermission{}, + }, + } - pluginDir := filepath.Join(tempDir, "invalid-json") - Expect(os.MkdirAll(pluginDir, 0755)).To(Succeed()) - Expect(os.WriteFile(filepath.Join(pluginDir, "manifest.json"), []byte(invalidJSON), 0600)).To(Succeed()) + err := m.Validate() + Expect(err).ToNot(HaveOccurred()) + }) - // Test validation fails - _, err := LoadManifest(pluginDir) - Expect(err).To(HaveOccurred()) - Expect(err.Error()).To(ContainSubstring("invalid manifest")) + It("returns error when subsonicapi without users permission", func() { + m := &Manifest{ + Name: "Test", + Author: "Author", + Version: "1.0.0", + Permissions: &Permissions{ + Subsonicapi: &SubsonicAPIPermission{}, + }, + } + + err := m.Validate() + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("subsonicapi")) + }) + + It("validates manifest without subsonicapi", func() { + m := &Manifest{ + Name: "Test", + Author: "Author", + Version: "1.0.0", + Permissions: &Permissions{ + Http: &HTTPPermission{}, + }, + } + + err := m.Validate() + Expect(err).ToNot(HaveOccurred()) + }) + + It("validates manifest without any permissions", func() { + m := &Manifest{ + Name: "Test", + Author: "Author", + Version: "1.0.0", + } + + err := m.Validate() + Expect(err).ToNot(HaveOccurred()) + }) + + It("validates manifest with valid config schema", func() { + m := &Manifest{ + Name: "Test", + Author: "Author", + Version: "1.0.0", + Config: &ConfigDefinition{ + Schema: map[string]any{ + "type": "object", + "properties": map[string]any{ + "api_key": map[string]any{ + "type": "string", + }, + }, + }, + }, + } + + err := m.Validate() + Expect(err).ToNot(HaveOccurred()) + }) + + It("validates manifest with complex config schema", func() { + m := &Manifest{ + Name: "Test", + Author: "Author", + Version: "1.0.0", + Config: &ConfigDefinition{ + Schema: map[string]any{ + "type": "object", + "properties": map[string]any{ + "users": map[string]any{ + "type": "array", + "items": map[string]any{ + "type": "object", + "properties": map[string]any{ + "username": map[string]any{"type": "string"}, + "token": map[string]any{"type": "string"}, + }, + "required": []any{"username", "token"}, + }, + }, + }, + }, + }, + } + + err := m.Validate() + Expect(err).ToNot(HaveOccurred()) + }) + + It("returns error for invalid config schema - bad type", func() { + m := &Manifest{ + Name: "Test", + Author: "Author", + Version: "1.0.0", + Config: &ConfigDefinition{ + Schema: map[string]any{ + "type": "invalid_type", + }, + }, + } + + err := m.Validate() + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("config schema")) + }) + + It("returns error for invalid config schema - bad minLength", func() { + m := &Manifest{ + Name: "Test", + Author: "Author", + Version: "1.0.0", + Config: &ConfigDefinition{ + Schema: map[string]any{ + "type": "object", + "properties": map[string]any{ + "name": map[string]any{ + "type": "string", + "minLength": "not_a_number", + }, + }, + }, + }, + } + + err := m.Validate() + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("config schema")) + }) + + It("validates manifest without config", func() { + m := &Manifest{ + Name: "Test", + Author: "Author", + Version: "1.0.0", + } + + err := m.Validate() + Expect(err).ToNot(HaveOccurred()) + }) }) - It("should validate manifest against schema with detailed error for missing required field", func() { - // Create manifest missing required name field - manifestContent := `{ - "author": "Test Author", - "version": "1.0.0", - "description": "A test plugin", - "website": "https://test.navidrome.org/test-plugin", - "capabilities": ["MetadataAgent"], - "permissions": {} - }` + Describe("ValidateWithCapabilities", func() { + It("validates scrobbler capability with users permission", func() { + m := &Manifest{ + Name: "Test", + Author: "Author", + Version: "1.0.0", + Permissions: &Permissions{ + Users: &UsersPermission{}, + }, + } - pluginDir := filepath.Join(tempDir, "test-plugin") - Expect(os.MkdirAll(pluginDir, 0755)).To(Succeed()) - Expect(os.WriteFile(filepath.Join(pluginDir, "manifest.json"), []byte(manifestContent), 0600)).To(Succeed()) + err := ValidateWithCapabilities(m, []Capability{CapabilityScrobbler}) + Expect(err).ToNot(HaveOccurred()) + }) - _, err := LoadManifest(pluginDir) - Expect(err).To(HaveOccurred()) - Expect(err.Error()).To(ContainSubstring("field name in PluginManifest: required")) - }) + It("returns error when scrobbler capability without users permission", func() { + m := &Manifest{ + Name: "Test", + Author: "Author", + Version: "1.0.0", + } - It("should validate manifest with wrong capability type", func() { - // Create manifest with invalid capability - manifestContent := `{ - "name": "test-plugin", - "author": "Test Author", - "version": "1.0.0", - "description": "A test plugin", - "website": "https://test.navidrome.org/test-plugin", - "capabilities": ["UnsupportedService"], - "permissions": {} - }` + err := ValidateWithCapabilities(m, []Capability{CapabilityScrobbler}) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("scrobbler")) + Expect(err.Error()).To(ContainSubstring("users")) + }) - pluginDir := filepath.Join(tempDir, "test-plugin") - Expect(os.MkdirAll(pluginDir, 0755)).To(Succeed()) - Expect(os.WriteFile(filepath.Join(pluginDir, "manifest.json"), []byte(manifestContent), 0600)).To(Succeed()) + It("validates non-scrobbler capability without users permission", func() { + m := &Manifest{ + Name: "Test", + Author: "Author", + Version: "1.0.0", + } - _, err := LoadManifest(pluginDir) - Expect(err).To(HaveOccurred()) - Expect(err.Error()).To(ContainSubstring("invalid value")) - Expect(err.Error()).To(ContainSubstring("UnsupportedService")) - }) + err := ValidateWithCapabilities(m, []Capability{CapabilityMetadataAgent}) + Expect(err).ToNot(HaveOccurred()) + }) - It("should validate manifest with empty capabilities array", func() { - // Create manifest with empty capabilities array - manifestContent := `{ - "name": "test-plugin", - "author": "Test Author", - "version": "1.0.0", - "description": "A test plugin", - "website": "https://test.navidrome.org/test-plugin", - "capabilities": [], - "permissions": {} - }` + It("validates multiple capabilities including scrobbler", func() { + m := &Manifest{ + Name: "Test", + Author: "Author", + Version: "1.0.0", + Permissions: &Permissions{ + Users: &UsersPermission{}, + }, + } - pluginDir := filepath.Join(tempDir, "test-plugin") - Expect(os.MkdirAll(pluginDir, 0755)).To(Succeed()) - Expect(os.WriteFile(filepath.Join(pluginDir, "manifest.json"), []byte(manifestContent), 0600)).To(Succeed()) + err := ValidateWithCapabilities(m, []Capability{CapabilityMetadataAgent, CapabilityScrobbler}) + Expect(err).ToNot(HaveOccurred()) + }) - _, err := LoadManifest(pluginDir) - Expect(err).To(HaveOccurred()) - Expect(err.Error()).To(ContainSubstring("field capabilities length: must be >= 1")) + It("validates with nil capabilities", func() { + m := &Manifest{ + Name: "Test", + Author: "Author", + Version: "1.0.0", + } + + err := ValidateWithCapabilities(m, nil) + Expect(err).ToNot(HaveOccurred()) + }) + + It("validates with empty capabilities", func() { + m := &Manifest{ + Name: "Test", + Author: "Author", + Version: "1.0.0", + } + + err := ValidateWithCapabilities(m, []Capability{}) + Expect(err).ToNot(HaveOccurred()) + }) }) }) diff --git a/plugins/metadata_agent.go b/plugins/metadata_agent.go new file mode 100644 index 000000000..451ef26d1 --- /dev/null +++ b/plugins/metadata_agent.go @@ -0,0 +1,258 @@ +package plugins + +import ( + "context" + "errors" + + "github.com/navidrome/navidrome/core/agents" + "github.com/navidrome/navidrome/plugins/capabilities" +) + +// CapabilityMetadataAgent indicates the plugin can provide artist/album metadata. +// Detected when the plugin exports at least one of the metadata agent functions. +const CapabilityMetadataAgent Capability = "MetadataAgent" + +// Export function names (snake_case as per design) +const ( + FuncGetArtistMBID = "nd_get_artist_mbid" + FuncGetArtistURL = "nd_get_artist_url" + FuncGetArtistBiography = "nd_get_artist_biography" + FuncGetSimilarArtists = "nd_get_similar_artists" + FuncGetArtistImages = "nd_get_artist_images" + FuncGetArtistTopSongs = "nd_get_artist_top_songs" + FuncGetAlbumInfo = "nd_get_album_info" + FuncGetAlbumImages = "nd_get_album_images" + FuncGetSimilarSongsByTrack = "nd_get_similar_songs_by_track" + FuncGetSimilarSongsByAlbum = "nd_get_similar_songs_by_album" + FuncGetSimilarSongsByArtist = "nd_get_similar_songs_by_artist" +) + +func init() { + registerCapability( + CapabilityMetadataAgent, + FuncGetArtistMBID, + FuncGetArtistURL, + FuncGetArtistBiography, + FuncGetSimilarArtists, + FuncGetArtistImages, + FuncGetArtistTopSongs, + FuncGetAlbumInfo, + FuncGetAlbumImages, + FuncGetSimilarSongsByTrack, + FuncGetSimilarSongsByAlbum, + FuncGetSimilarSongsByArtist, + ) +} + +// MetadataAgent is an adapter that wraps an Extism plugin and implements +// the agents interfaces for metadata retrieval. +type MetadataAgent struct { + name string + plugin *plugin +} + +// AgentName returns the plugin name +func (a *MetadataAgent) AgentName() string { + return a.name +} + +// --- Interface implementations --- + +// GetArtistMBID retrieves the MusicBrainz ID for an artist +func (a *MetadataAgent) GetArtistMBID(ctx context.Context, id string, name string) (string, error) { + input := capabilities.ArtistMBIDRequest{ID: id, Name: name} + result, err := callPluginFunction[capabilities.ArtistMBIDRequest, *capabilities.ArtistMBIDResponse](ctx, a.plugin, FuncGetArtistMBID, input) + if err != nil { + return "", errors.Join(agents.ErrNotFound, err) + } + + if result == nil || result.MBID == "" { + return "", agents.ErrNotFound + } + + return result.MBID, nil +} + +// GetArtistURL retrieves the external URL for an artist +func (a *MetadataAgent) GetArtistURL(ctx context.Context, id, name, mbid string) (string, error) { + input := capabilities.ArtistRequest{ID: id, Name: name, MBID: mbid} + result, err := callPluginFunction[capabilities.ArtistRequest, *capabilities.ArtistURLResponse](ctx, a.plugin, FuncGetArtistURL, input) + if err != nil { + return "", errors.Join(agents.ErrNotFound, err) + } + if result == nil || result.URL == "" { + return "", agents.ErrNotFound + } + return result.URL, nil +} + +// GetArtistBiography retrieves the biography for an artist +func (a *MetadataAgent) GetArtistBiography(ctx context.Context, id, name, mbid string) (string, error) { + input := capabilities.ArtistRequest{ID: id, Name: name, MBID: mbid} + result, err := callPluginFunction[capabilities.ArtistRequest, *capabilities.ArtistBiographyResponse](ctx, a.plugin, FuncGetArtistBiography, input) + if err != nil { + return "", errors.Join(agents.ErrNotFound, err) + } + + if result == nil || result.Biography == "" { + return "", agents.ErrNotFound + } + + return result.Biography, nil +} + +// GetSimilarArtists retrieves similar artists +func (a *MetadataAgent) GetSimilarArtists(ctx context.Context, id, name, mbid string, limit int) ([]agents.Artist, error) { + input := capabilities.SimilarArtistsRequest{ID: id, Name: name, MBID: mbid, Limit: int32(limit)} + result, err := callPluginFunction[capabilities.SimilarArtistsRequest, *capabilities.SimilarArtistsResponse](ctx, a.plugin, FuncGetSimilarArtists, input) + if err != nil { + return nil, errors.Join(agents.ErrNotFound, err) + } + + if result == nil || len(result.Artists) == 0 { + return nil, agents.ErrNotFound + } + + artists := make([]agents.Artist, len(result.Artists)) + for i, ar := range result.Artists { + artists[i] = agents.Artist{ID: ar.ID, Name: ar.Name, MBID: ar.MBID} + } + + return artists, nil +} + +// GetArtistImages retrieves images for an artist +func (a *MetadataAgent) GetArtistImages(ctx context.Context, id, name, mbid string) ([]agents.ExternalImage, error) { + input := capabilities.ArtistRequest{ID: id, Name: name, MBID: mbid} + result, err := callPluginFunction[capabilities.ArtistRequest, *capabilities.ArtistImagesResponse](ctx, a.plugin, FuncGetArtistImages, input) + if err != nil { + return nil, errors.Join(agents.ErrNotFound, err) + } + + if result == nil || len(result.Images) == 0 { + return nil, agents.ErrNotFound + } + + images := make([]agents.ExternalImage, len(result.Images)) + for i, img := range result.Images { + images[i] = agents.ExternalImage{URL: img.URL, Size: int(img.Size)} + } + + return images, nil +} + +// GetArtistTopSongs retrieves top songs for an artist +func (a *MetadataAgent) GetArtistTopSongs(ctx context.Context, id, artistName, mbid string, count int) ([]agents.Song, error) { + input := capabilities.TopSongsRequest{ID: id, Name: artistName, MBID: mbid, Count: int32(count)} + result, err := callPluginFunction[capabilities.TopSongsRequest, *capabilities.TopSongsResponse](ctx, a.plugin, FuncGetArtistTopSongs, input) + if err != nil { + return nil, errors.Join(agents.ErrNotFound, err) + } + + if result == nil || len(result.Songs) == 0 { + return nil, agents.ErrNotFound + } + + return songRefsToAgentSongs(result.Songs), nil +} + +// GetAlbumInfo retrieves album information +func (a *MetadataAgent) GetAlbumInfo(ctx context.Context, name, artist, mbid string) (*agents.AlbumInfo, error) { + input := capabilities.AlbumRequest{Name: name, Artist: artist, MBID: mbid} + result, err := callPluginFunction[capabilities.AlbumRequest, *capabilities.AlbumInfoResponse](ctx, a.plugin, FuncGetAlbumInfo, input) + if err != nil { + return nil, errors.Join(agents.ErrNotFound, err) + } + + if result == nil { + return nil, agents.ErrNotFound + } + + return &agents.AlbumInfo{ + Name: result.Name, + MBID: result.MBID, + Description: result.Description, + URL: result.URL, + }, nil +} + +// GetAlbumImages retrieves images for an album +func (a *MetadataAgent) GetAlbumImages(ctx context.Context, name, artist, mbid string) ([]agents.ExternalImage, error) { + input := capabilities.AlbumRequest{Name: name, Artist: artist, MBID: mbid} + result, err := callPluginFunction[capabilities.AlbumRequest, *capabilities.AlbumImagesResponse](ctx, a.plugin, FuncGetAlbumImages, input) + if err != nil { + return nil, errors.Join(agents.ErrNotFound, err) + } + + if result == nil || len(result.Images) == 0 { + return nil, agents.ErrNotFound + } + + images := make([]agents.ExternalImage, len(result.Images)) + for i, img := range result.Images { + images[i] = agents.ExternalImage{URL: img.URL, Size: int(img.Size)} + } + + return images, nil +} + +func callSimilarSongsPluginFunction[T any](ctx context.Context, plugin *plugin, funcName string, input T) ([]agents.Song, error) { + result, err := callPluginFunction[T, *capabilities.SimilarSongsResponse](ctx, plugin, funcName, input) + if err != nil { + return nil, err + } + if result == nil || len(result.Songs) == 0 { + return nil, agents.ErrNotFound + } + return songRefsToAgentSongs(result.Songs), nil +} + +// GetSimilarSongsByTrack retrieves songs similar to a specific track +func (a *MetadataAgent) GetSimilarSongsByTrack(ctx context.Context, id, name, artist, mbid string, count int) ([]agents.Song, error) { + return callSimilarSongsPluginFunction[capabilities.SimilarSongsByTrackRequest](ctx, a.plugin, FuncGetSimilarSongsByTrack, capabilities.SimilarSongsByTrackRequest{ID: id, Name: name, Artist: artist, MBID: mbid, Count: int32(count)}) +} + +// GetSimilarSongsByAlbum retrieves songs similar to tracks on an album +func (a *MetadataAgent) GetSimilarSongsByAlbum(ctx context.Context, id, name, artist, mbid string, count int) ([]agents.Song, error) { + return callSimilarSongsPluginFunction[capabilities.SimilarSongsByAlbumRequest](ctx, a.plugin, FuncGetSimilarSongsByAlbum, capabilities.SimilarSongsByAlbumRequest{ID: id, Name: name, Artist: artist, MBID: mbid, Count: int32(count)}) +} + +// GetSimilarSongsByArtist retrieves songs similar to an artist's catalog +func (a *MetadataAgent) GetSimilarSongsByArtist(ctx context.Context, id, name, mbid string, count int) ([]agents.Song, error) { + return callSimilarSongsPluginFunction[capabilities.SimilarSongsByArtistRequest](ctx, a.plugin, FuncGetSimilarSongsByArtist, capabilities.SimilarSongsByArtistRequest{ID: id, Name: name, MBID: mbid, Count: int32(count)}) +} + +// songRefsToAgentSongs converts a slice of SongRef to agents.Song +func songRefsToAgentSongs(refs []capabilities.SongRef) []agents.Song { + songs := make([]agents.Song, len(refs)) + for i, s := range refs { + songs[i] = agents.Song{ + ID: s.ID, + Name: s.Name, + MBID: s.MBID, + ISRC: s.ISRC, + Artist: s.Artist, + ArtistMBID: s.ArtistMBID, + Album: s.Album, + AlbumMBID: s.AlbumMBID, + Duration: uint32(s.Duration * 1000), + } + } + return songs +} + +// Verify interface implementations at compile time +var ( + _ agents.Interface = (*MetadataAgent)(nil) + _ agents.ArtistMBIDRetriever = (*MetadataAgent)(nil) + _ agents.ArtistURLRetriever = (*MetadataAgent)(nil) + _ agents.ArtistBiographyRetriever = (*MetadataAgent)(nil) + _ agents.ArtistSimilarRetriever = (*MetadataAgent)(nil) + _ agents.ArtistImageRetriever = (*MetadataAgent)(nil) + _ agents.ArtistTopSongsRetriever = (*MetadataAgent)(nil) + _ agents.AlbumInfoRetriever = (*MetadataAgent)(nil) + _ agents.AlbumImageRetriever = (*MetadataAgent)(nil) + _ agents.SimilarSongsByTrackRetriever = (*MetadataAgent)(nil) + _ agents.SimilarSongsByAlbumRetriever = (*MetadataAgent)(nil) + _ agents.SimilarSongsByArtistRetriever = (*MetadataAgent)(nil) +) diff --git a/plugins/metadata_agent_test.go b/plugins/metadata_agent_test.go new file mode 100644 index 000000000..694cef716 --- /dev/null +++ b/plugins/metadata_agent_test.go @@ -0,0 +1,329 @@ +package plugins + +import ( + "github.com/navidrome/navidrome/core/agents" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("MetadataAgent", Ordered, func() { + var agent agents.Interface + + BeforeAll(func() { + // Load the agent via shared manager + var ok bool + agent, ok = testManager.LoadMediaAgent("test-metadata-agent") + Expect(ok).To(BeTrue()) + }) + + Describe("AgentName", func() { + It("returns the plugin name", func() { + Expect(agent.AgentName()).To(Equal("test-metadata-agent")) + }) + }) + + Describe("GetArtistMBID", func() { + It("returns the MBID from the plugin", func() { + retriever := agent.(agents.ArtistMBIDRetriever) + mbid, err := retriever.GetArtistMBID(GinkgoT().Context(), "artist-1", "The Beatles") + Expect(err).ToNot(HaveOccurred()) + Expect(mbid).To(Equal("test-mbid-The Beatles")) + }) + }) + + Describe("GetArtistURL", func() { + It("returns the URL from the plugin", func() { + retriever := agent.(agents.ArtistURLRetriever) + url, err := retriever.GetArtistURL(GinkgoT().Context(), "artist-1", "The Beatles", "some-mbid") + Expect(err).ToNot(HaveOccurred()) + Expect(url).To(Equal("https://test.example.com/artist/The Beatles")) + }) + }) + + Describe("GetArtistBiography", func() { + It("returns the biography from the plugin", func() { + retriever := agent.(agents.ArtistBiographyRetriever) + bio, err := retriever.GetArtistBiography(GinkgoT().Context(), "artist-1", "The Beatles", "some-mbid") + Expect(err).ToNot(HaveOccurred()) + Expect(bio).To(Equal("Biography for The Beatles")) + }) + }) + + Describe("GetArtistImages", func() { + It("returns images from the plugin", func() { + retriever := agent.(agents.ArtistImageRetriever) + images, err := retriever.GetArtistImages(GinkgoT().Context(), "artist-1", "The Beatles", "some-mbid") + Expect(err).ToNot(HaveOccurred()) + Expect(images).To(HaveLen(2)) + Expect(images[0].URL).To(Equal("https://test.example.com/images/The Beatles/large.jpg")) + Expect(images[0].Size).To(Equal(500)) + Expect(images[1].URL).To(Equal("https://test.example.com/images/The Beatles/small.jpg")) + Expect(images[1].Size).To(Equal(100)) + }) + }) + + Describe("GetSimilarArtists", func() { + It("returns similar artists from the plugin", func() { + retriever := agent.(agents.ArtistSimilarRetriever) + artists, err := retriever.GetSimilarArtists(GinkgoT().Context(), "artist-1", "The Beatles", "some-mbid", 3) + Expect(err).ToNot(HaveOccurred()) + Expect(artists).To(HaveLen(3)) + Expect(artists[0].Name).To(Equal("The Beatles Similar A")) + Expect(artists[1].Name).To(Equal("The Beatles Similar B")) + Expect(artists[2].Name).To(Equal("The Beatles Similar C")) + }) + }) + + Describe("GetArtistTopSongs", func() { + It("returns top songs from the plugin", func() { + retriever := agent.(agents.ArtistTopSongsRetriever) + songs, err := retriever.GetArtistTopSongs(GinkgoT().Context(), "artist-1", "The Beatles", "some-mbid", 3) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(3)) + Expect(songs[0].Name).To(Equal("The Beatles Song 1")) + Expect(songs[1].Name).To(Equal("The Beatles Song 2")) + Expect(songs[2].Name).To(Equal("The Beatles Song 3")) + }) + }) + + Describe("GetAlbumInfo", func() { + It("returns album info from the plugin", func() { + retriever := agent.(agents.AlbumInfoRetriever) + info, err := retriever.GetAlbumInfo(GinkgoT().Context(), "Abbey Road", "The Beatles", "album-mbid") + Expect(err).ToNot(HaveOccurred()) + Expect(info.Name).To(Equal("Abbey Road")) + Expect(info.MBID).To(Equal("test-album-mbid-Abbey Road")) + Expect(info.Description).To(Equal("Description for Abbey Road by The Beatles")) + Expect(info.URL).To(Equal("https://test.example.com/album/Abbey Road")) + }) + }) + + Describe("GetAlbumImages", func() { + It("returns album images from the plugin", func() { + retriever := agent.(agents.AlbumImageRetriever) + images, err := retriever.GetAlbumImages(GinkgoT().Context(), "Abbey Road", "The Beatles", "album-mbid") + Expect(err).ToNot(HaveOccurred()) + Expect(images).To(HaveLen(1)) + Expect(images[0].URL).To(Equal("https://test.example.com/albums/Abbey Road/cover.jpg")) + Expect(images[0].Size).To(Equal(500)) + }) + }) + + Describe("GetSimilarSongsByTrack", func() { + It("returns similar songs from the plugin", func() { + retriever := agent.(agents.SimilarSongsByTrackRetriever) + songs, err := retriever.GetSimilarSongsByTrack(GinkgoT().Context(), "track-1", "Yesterday", "The Beatles", "some-mbid", 3) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(3)) + Expect(songs[0].Name).To(Equal("Similar to Yesterday #1")) + Expect(songs[0].Artist).To(Equal("The Beatles")) + }) + }) + + Describe("GetSimilarSongsByAlbum", func() { + It("returns similar songs from the plugin", func() { + retriever := agent.(agents.SimilarSongsByAlbumRetriever) + songs, err := retriever.GetSimilarSongsByAlbum(GinkgoT().Context(), "album-1", "Abbey Road", "The Beatles", "album-mbid", 3) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(3)) + Expect(songs[0].Album).To(Equal("Abbey Road")) + }) + }) + + Describe("GetSimilarSongsByArtist", func() { + It("returns similar songs from the plugin", func() { + retriever := agent.(agents.SimilarSongsByArtistRetriever) + songs, err := retriever.GetSimilarSongsByArtist(GinkgoT().Context(), "artist-1", "The Beatles", "some-mbid", 3) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(3)) + Expect(songs[0].Name).To(ContainSubstring("The Beatles Style Song")) + }) + }) +}) + +var _ = Describe("MetadataAgent error handling", Ordered, func() { + // Tests error paths when plugin is configured to return errors + var ( + errorManager *Manager + errorAgent agents.Interface + ) + + BeforeAll(func() { + // Create manager with error injection config + errorManager, _ = createTestManager(map[string]map[string]string{ + "test-metadata-agent": { + "error": "simulated plugin error", + }, + }) + + // Load the agent + var ok bool + errorAgent, ok = errorManager.LoadMediaAgent("test-metadata-agent") + Expect(ok).To(BeTrue()) + }) + + It("returns error from GetArtistMBID", func() { + retriever := errorAgent.(agents.ArtistMBIDRetriever) + _, err := retriever.GetArtistMBID(GinkgoT().Context(), "artist-1", "Test") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("simulated plugin error")) + }) + + It("returns error from GetArtistURL", func() { + retriever := errorAgent.(agents.ArtistURLRetriever) + _, err := retriever.GetArtistURL(GinkgoT().Context(), "artist-1", "Test", "mbid") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("simulated plugin error")) + }) + + It("returns error from GetArtistBiography", func() { + retriever := errorAgent.(agents.ArtistBiographyRetriever) + _, err := retriever.GetArtistBiography(GinkgoT().Context(), "artist-1", "Test", "mbid") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("simulated plugin error")) + }) + + It("returns error from GetArtistImages", func() { + retriever := errorAgent.(agents.ArtistImageRetriever) + _, err := retriever.GetArtistImages(GinkgoT().Context(), "artist-1", "Test", "mbid") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("simulated plugin error")) + }) + + It("returns error from GetSimilarArtists", func() { + retriever := errorAgent.(agents.ArtistSimilarRetriever) + _, err := retriever.GetSimilarArtists(GinkgoT().Context(), "artist-1", "Test", "mbid", 5) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("simulated plugin error")) + }) + + It("returns error from GetArtistTopSongs", func() { + retriever := errorAgent.(agents.ArtistTopSongsRetriever) + _, err := retriever.GetArtistTopSongs(GinkgoT().Context(), "artist-1", "Test", "mbid", 5) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("simulated plugin error")) + }) + + It("returns error from GetAlbumInfo", func() { + retriever := errorAgent.(agents.AlbumInfoRetriever) + _, err := retriever.GetAlbumInfo(GinkgoT().Context(), "Album", "Artist", "mbid") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("simulated plugin error")) + }) + + It("returns error from GetAlbumImages", func() { + retriever := errorAgent.(agents.AlbumImageRetriever) + _, err := retriever.GetAlbumImages(GinkgoT().Context(), "Album", "Artist", "mbid") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("simulated plugin error")) + }) + + It("returns error from GetSimilarSongsByTrack", func() { + retriever := errorAgent.(agents.SimilarSongsByTrackRetriever) + _, err := retriever.GetSimilarSongsByTrack(GinkgoT().Context(), "track-1", "Test", "Artist", "mbid", 5) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("simulated plugin error")) + }) + + It("returns error from GetSimilarSongsByAlbum", func() { + retriever := errorAgent.(agents.SimilarSongsByAlbumRetriever) + _, err := retriever.GetSimilarSongsByAlbum(GinkgoT().Context(), "album-1", "Album", "Artist", "mbid", 5) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("simulated plugin error")) + }) + + It("returns error from GetSimilarSongsByArtist", func() { + retriever := errorAgent.(agents.SimilarSongsByArtistRetriever) + _, err := retriever.GetSimilarSongsByArtist(GinkgoT().Context(), "artist-1", "Artist", "mbid", 5) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("simulated plugin error")) + }) +}) + +var _ = Describe("MetadataAgent partial implementation", Ordered, func() { + // Tests the "not implemented" code path when a plugin only implements some methods + var ( + partialManager *Manager + partialAgent agents.Interface + ) + + BeforeAll(func() { + // Create manager with the partial metadata agent plugin + partialManager, _ = createTestManagerWithPlugins(nil, "partial-metadata-agent"+PackageExtension) + + // Load the agent + var ok bool + partialAgent, ok = partialManager.LoadMediaAgent("partial-metadata-agent") + Expect(ok).To(BeTrue()) + }) + + It("returns data from implemented method (GetArtistBiography)", func() { + retriever := partialAgent.(agents.ArtistBiographyRetriever) + bio, err := retriever.GetArtistBiography(GinkgoT().Context(), "artist-1", "Test Artist", "mbid") + Expect(err).ToNot(HaveOccurred()) + Expect(bio).To(Equal("Partial agent biography for Test Artist")) + }) + + It("returns ErrNotFound for unimplemented method (GetArtistMBID)", func() { + retriever := partialAgent.(agents.ArtistMBIDRetriever) + _, err := retriever.GetArtistMBID(GinkgoT().Context(), "artist-1", "Test Artist") + Expect(err).To(MatchError(errNotImplemented)) + }) + + It("returns ErrNotFound for unimplemented method (GetArtistURL)", func() { + retriever := partialAgent.(agents.ArtistURLRetriever) + _, err := retriever.GetArtistURL(GinkgoT().Context(), "artist-1", "Test Artist", "mbid") + Expect(err).To(MatchError(errNotImplemented)) + }) + + It("returns ErrNotFound for unimplemented method (GetArtistImages)", func() { + retriever := partialAgent.(agents.ArtistImageRetriever) + _, err := retriever.GetArtistImages(GinkgoT().Context(), "artist-1", "Test Artist", "mbid") + Expect(err).To(MatchError(errNotImplemented)) + }) + + It("returns ErrNotFound for unimplemented method (GetSimilarArtists)", func() { + retriever := partialAgent.(agents.ArtistSimilarRetriever) + _, err := retriever.GetSimilarArtists(GinkgoT().Context(), "artist-1", "Test Artist", "mbid", 5) + Expect(err).To(MatchError(errNotImplemented)) + + }) + + It("returns ErrNotFound for unimplemented method (GetArtistTopSongs)", func() { + retriever := partialAgent.(agents.ArtistTopSongsRetriever) + _, err := retriever.GetArtistTopSongs(GinkgoT().Context(), "artist-1", "Test Artist", "mbid", 5) + Expect(err).To(MatchError(errNotImplemented)) + + }) + + It("returns ErrNotFound for unimplemented method (GetAlbumInfo)", func() { + retriever := partialAgent.(agents.AlbumInfoRetriever) + _, err := retriever.GetAlbumInfo(GinkgoT().Context(), "Album", "Artist", "mbid") + Expect(err).To(MatchError(errNotImplemented)) + + }) + + It("returns ErrNotFound for unimplemented method (GetAlbumImages)", func() { + retriever := partialAgent.(agents.AlbumImageRetriever) + _, err := retriever.GetAlbumImages(GinkgoT().Context(), "Album", "Artist", "mbid") + Expect(err).To(MatchError(errNotImplemented)) + }) + + It("returns ErrNotFound for unimplemented method (GetSimilarSongsByTrack)", func() { + retriever := partialAgent.(agents.SimilarSongsByTrackRetriever) + _, err := retriever.GetSimilarSongsByTrack(GinkgoT().Context(), "track-1", "Test", "Artist", "mbid", 5) + Expect(err).To(MatchError(errNotImplemented)) + }) + + It("returns ErrNotFound for unimplemented method (GetSimilarSongsByAlbum)", func() { + retriever := partialAgent.(agents.SimilarSongsByAlbumRetriever) + _, err := retriever.GetSimilarSongsByAlbum(GinkgoT().Context(), "album-1", "Album", "Artist", "mbid", 5) + Expect(err).To(MatchError(errNotImplemented)) + }) + + It("returns ErrNotFound for unimplemented method (GetSimilarSongsByArtist)", func() { + retriever := partialAgent.(agents.SimilarSongsByArtistRetriever) + _, err := retriever.GetSimilarSongsByArtist(GinkgoT().Context(), "artist-1", "Artist", "mbid", 5) + Expect(err).To(MatchError(errNotImplemented)) + }) +}) diff --git a/plugins/migrate.go b/plugins/migrate.go new file mode 100644 index 000000000..332e34838 --- /dev/null +++ b/plugins/migrate.go @@ -0,0 +1,47 @@ +package plugins + +import ( + "database/sql" + "fmt" +) + +// migrateDB applies schema migrations to a SQLite database. +// +// Each entry in migrations is a single SQL statement. The current schema version +// is tracked using SQLite's built-in PRAGMA user_version. Only statements after +// the current version are executed, within a single transaction. +func migrateDB(db *sql.DB, migrations []string) error { + var version int + if err := db.QueryRow(`PRAGMA user_version`).Scan(&version); err != nil { + return fmt.Errorf("reading schema version: %w", err) + } + + if version >= len(migrations) { + return nil + } + + tx, err := db.Begin() + if err != nil { + return fmt.Errorf("starting migration transaction: %w", err) + } + defer func() { _ = tx.Rollback() }() + + for i := version; i < len(migrations); i++ { + if _, err := tx.Exec(migrations[i]); err != nil { + return fmt.Errorf("migration %d failed: %w", i+1, err) + } + } + + // PRAGMA statements cannot be executed inside a transaction in some SQLite + // drivers, but with mattn/go-sqlite3 this works. We set it inside the tx + // so that a failed commit leaves the version unchanged. + if _, err := tx.Exec(fmt.Sprintf(`PRAGMA user_version = %d`, len(migrations))); err != nil { + return fmt.Errorf("updating schema version: %w", err) + } + + if err := tx.Commit(); err != nil { + return fmt.Errorf("committing migrations: %w", err) + } + + return nil +} diff --git a/plugins/migrate_test.go b/plugins/migrate_test.go new file mode 100644 index 000000000..17ed43c5c --- /dev/null +++ b/plugins/migrate_test.go @@ -0,0 +1,99 @@ +//go:build !windows + +package plugins + +import ( + "database/sql" + + _ "github.com/mattn/go-sqlite3" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("migrateDB", func() { + var db *sql.DB + + BeforeEach(func() { + var err error + db, err = sql.Open("sqlite3", ":memory:") + Expect(err).ToNot(HaveOccurred()) + }) + + AfterEach(func() { + if db != nil { + db.Close() + } + }) + + getUserVersion := func() int { + var version int + Expect(db.QueryRow(`PRAGMA user_version`).Scan(&version)).To(Succeed()) + return version + } + + It("applies all migrations on a fresh database", func() { + migrations := []string{ + `CREATE TABLE test (id INTEGER PRIMARY KEY, name TEXT)`, + `ALTER TABLE test ADD COLUMN email TEXT`, + } + + Expect(migrateDB(db, migrations)).To(Succeed()) + Expect(getUserVersion()).To(Equal(2)) + + // Verify schema + _, err := db.Exec(`INSERT INTO test (id, name, email) VALUES (1, 'Alice', 'alice@test.com')`) + Expect(err).ToNot(HaveOccurred()) + }) + + It("skips already applied migrations", func() { + migrations1 := []string{ + `CREATE TABLE test (id INTEGER PRIMARY KEY, name TEXT)`, + } + Expect(migrateDB(db, migrations1)).To(Succeed()) + Expect(getUserVersion()).To(Equal(1)) + + // Add a new migration + migrations2 := []string{ + `CREATE TABLE test (id INTEGER PRIMARY KEY, name TEXT)`, + `ALTER TABLE test ADD COLUMN email TEXT`, + } + Expect(migrateDB(db, migrations2)).To(Succeed()) + Expect(getUserVersion()).To(Equal(2)) + + // Verify the new column exists + _, err := db.Exec(`INSERT INTO test (id, name, email) VALUES (1, 'Alice', 'alice@test.com')`) + Expect(err).ToNot(HaveOccurred()) + }) + + It("is a no-op when all migrations are applied", func() { + migrations := []string{ + `CREATE TABLE test (id INTEGER PRIMARY KEY)`, + } + Expect(migrateDB(db, migrations)).To(Succeed()) + Expect(migrateDB(db, migrations)).To(Succeed()) + Expect(getUserVersion()).To(Equal(1)) + }) + + It("is a no-op with empty migrations slice", func() { + Expect(migrateDB(db, nil)).To(Succeed()) + Expect(getUserVersion()).To(Equal(0)) + }) + + It("rolls back on failure", func() { + migrations := []string{ + `CREATE TABLE test (id INTEGER PRIMARY KEY)`, + `INVALID SQL STATEMENT`, + } + + err := migrateDB(db, migrations) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("migration 2 failed")) + + // Version should remain 0 (rolled back) + Expect(getUserVersion()).To(Equal(0)) + + // Table should not exist (rolled back) + _, err = db.Exec(`INSERT INTO test (id) VALUES (1)`) + Expect(err).To(HaveOccurred()) + }) +}) diff --git a/plugins/package.go b/plugins/package.go index 5273b0431..475761231 100644 --- a/plugins/package.go +++ b/plugins/package.go @@ -2,176 +2,111 @@ package plugins import ( "archive/zip" - "encoding/json" "errors" "fmt" "io" - "os" - "path/filepath" - "strings" - - "github.com/navidrome/navidrome/plugins/schema" ) -// PluginPackage represents a Navidrome Plugin Package (.ndp file) -type PluginPackage struct { - ManifestJSON []byte - Manifest *schema.PluginManifest - WasmBytes []byte - Docs map[string][]byte +const ( + // PackageExtension is the file extension for Navidrome plugin packages. + PackageExtension = ".ndp" + + // manifestFileName is the name of the manifest file inside the package. + manifestFileName = "manifest.json" + + // wasmFileName is the name of the WebAssembly module inside the package. + wasmFileName = "plugin.wasm" +) + +// ndpPackage represents a loaded .ndp plugin package. +// It contains the manifest and wasm bytes read from the archive. +type ndpPackage struct { + Manifest *Manifest + WasmBytes []byte } -// ExtractPackage extracts a .ndp file to the target directory -func ExtractPackage(ndpPath, targetDir string) error { - r, err := zip.OpenReader(ndpPath) +// openPackage opens an .ndp file and extracts the manifest and wasm bytes. +// The caller does not need to call Close() - all resources are read into memory. +func openPackage(ndpPath string) (*ndpPackage, error) { + // Open the zip archive + zr, err := zip.OpenReader(ndpPath) if err != nil { - return fmt.Errorf("error opening .ndp file: %w", err) + return nil, fmt.Errorf("opening package: %w", err) } - defer r.Close() + defer zr.Close() - // Create target directory if it doesn't exist - if err := os.MkdirAll(targetDir, 0755); err != nil { - return fmt.Errorf("error creating plugin directory: %w", err) - } + var manifestBytes []byte + var wasmBytes []byte - // Define a reasonable size limit for plugin files to prevent decompression bombs - const maxFileSize = 10 * 1024 * 1024 // 10 MB limit - - // Extract all files from the zip - for _, f := range r.File { - // Skip directories (they will be created as needed) - if f.FileInfo().IsDir() { - continue - } - - // Create the file path for extraction - // Validate the file name to prevent directory traversal or absolute paths - if strings.Contains(f.Name, "..") || filepath.IsAbs(f.Name) { - return fmt.Errorf("illegal file path in plugin package: %s", f.Name) - } - - // Create the file path for extraction - targetPath := filepath.Join(targetDir, f.Name) // #nosec G305 - - // Clean the path to prevent directory traversal. - cleanedPath := filepath.Clean(targetPath) - // Ensure the cleaned path is still within the target directory. - // We resolve both paths to absolute paths to be sure. - absTargetDir, err := filepath.Abs(targetDir) - if err != nil { - return fmt.Errorf("failed to resolve target directory path: %w", err) - } - absTargetPath, err := filepath.Abs(cleanedPath) - if err != nil { - return fmt.Errorf("failed to resolve extracted file path: %w", err) - } - if !strings.HasPrefix(absTargetPath, absTargetDir+string(os.PathSeparator)) && absTargetPath != absTargetDir { - return fmt.Errorf("illegal file path in plugin package: %s", f.Name) - } - - // Open the file inside the zip - rc, err := f.Open() - if err != nil { - return fmt.Errorf("error opening file in plugin package: %w", err) - } - - // Create parent directories if they don't exist - if err := os.MkdirAll(filepath.Dir(targetPath), 0755); err != nil { - rc.Close() - return fmt.Errorf("error creating directory structure: %w", err) - } - - // Create the file - outFile, err := os.Create(targetPath) - if err != nil { - rc.Close() - return fmt.Errorf("error creating extracted file: %w", err) - } - - // Copy the file contents with size limit - if _, err := io.CopyN(outFile, rc, maxFileSize); err != nil && !errors.Is(err, io.EOF) { - outFile.Close() - rc.Close() - if errors.Is(err, io.ErrUnexpectedEOF) { // File size exceeds limit - return fmt.Errorf("error extracting file: size exceeds limit (%d bytes) for %s", maxFileSize, f.Name) + for _, f := range zr.File { + switch f.Name { + case manifestFileName: + manifestBytes, err = readZipFile(f) + if err != nil { + return nil, fmt.Errorf("reading manifest: %w", err) + } + case wasmFileName: + wasmBytes, err = readZipFile(f) + if err != nil { + return nil, fmt.Errorf("reading wasm: %w", err) } - return fmt.Errorf("error writing extracted file: %w", err) - } - - outFile.Close() - rc.Close() - - // Set appropriate file permissions (0600 - readable only by owner) - if err := os.Chmod(targetPath, 0600); err != nil { - return fmt.Errorf("error setting permissions on extracted file: %w", err) } } - return nil -} + if manifestBytes == nil { + return nil, errors.New("package missing manifest.json") + } + if wasmBytes == nil { + return nil, errors.New("package missing plugin.wasm") + } -// LoadPackage loads and validates an .ndp file without extracting it -func LoadPackage(ndpPath string) (*PluginPackage, error) { - r, err := zip.OpenReader(ndpPath) + // Parse and validate manifest + manifest, err := ParseManifest(manifestBytes) if err != nil { - return nil, fmt.Errorf("error opening .ndp file: %w", err) - } - defer r.Close() - - pkg := &PluginPackage{ - Docs: make(map[string][]byte), + return nil, fmt.Errorf("parsing manifest: %w", err) } - // Required files - var hasManifest, hasWasm bool - - // Read all files in the zip - for _, f := range r.File { - // Skip directories - if f.FileInfo().IsDir() { - continue - } - - // Get file content - rc, err := f.Open() - if err != nil { - return nil, fmt.Errorf("error opening file in plugin package: %w", err) - } - - content, err := io.ReadAll(rc) - rc.Close() - if err != nil { - return nil, fmt.Errorf("error reading file in plugin package: %w", err) - } - - // Process based on file name - switch strings.ToLower(f.Name) { - case "manifest.json": - pkg.ManifestJSON = content - hasManifest = true - case "plugin.wasm": - pkg.WasmBytes = content - hasWasm = true - default: - // Store other files as documentation - pkg.Docs[f.Name] = content - } - } - - // Ensure required files exist - if !hasManifest { - return nil, fmt.Errorf("plugin package missing required manifest.json") - } - if !hasWasm { - return nil, fmt.Errorf("plugin package missing required plugin.wasm") - } - - // Parse and validate the manifest - var manifest schema.PluginManifest - if err := json.Unmarshal(pkg.ManifestJSON, &manifest); err != nil { - return nil, fmt.Errorf("invalid manifest: %w", err) - } - - pkg.Manifest = &manifest - return pkg, nil + return &ndpPackage{ + Manifest: manifest, + WasmBytes: wasmBytes, + }, nil +} + +// readManifest reads only the manifest from an .ndp file without loading the wasm bytes. +// This is useful for quick plugin discovery. +func readManifest(ndpPath string) (*Manifest, error) { + // Open the zip archive + zr, err := zip.OpenReader(ndpPath) + if err != nil { + return nil, fmt.Errorf("opening package: %w", err) + } + defer zr.Close() + + for _, f := range zr.File { + if f.Name == manifestFileName { + manifestBytes, err := readZipFile(f) + if err != nil { + return nil, fmt.Errorf("reading manifest: %w", err) + } + + manifest, err := ParseManifest(manifestBytes) + if err != nil { + return nil, fmt.Errorf("parsing manifest: %w", err) + } + + return manifest, nil + } + } + + return nil, errors.New("package missing manifest.json") +} + +// readZipFile reads the contents of a file from a zip archive. +func readZipFile(f *zip.File) ([]byte, error) { + rc, err := f.Open() + if err != nil { + return nil, err + } + defer rc.Close() + return io.ReadAll(rc) } diff --git a/plugins/package_test.go b/plugins/package_test.go index 8ff4b354a..fa76ddd94 100644 --- a/plugins/package_test.go +++ b/plugins/package_test.go @@ -2,115 +2,269 @@ package plugins import ( "archive/zip" + "encoding/json" + "fmt" "os" "path/filepath" - "github.com/navidrome/navidrome/plugins/schema" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) -var _ = Describe("Plugin Package", func() { - var tempDir string - var ndpPath string +var _ = Describe("ndpPackage", func() { + var tmpDir string BeforeEach(func() { - tempDir = GinkgoT().TempDir() - - // Create a test .ndp file - ndpPath = filepath.Join(tempDir, "test-plugin.ndp") - - // Create the required plugin files - manifestContent := []byte(`{ - "name": "test-plugin", - "author": "Test Author", - "version": "1.0.0", - "description": "A test plugin", - "website": "https://test.navidrome.org/test-plugin", - "capabilities": ["MetadataAgent"], - "permissions": {} - }`) - - wasmContent := []byte("dummy wasm content") - readmeContent := []byte("# Test Plugin\nThis is a test plugin") - - // Create the zip file - zipFile, err := os.Create(ndpPath) - Expect(err).NotTo(HaveOccurred()) - defer zipFile.Close() - - zipWriter := zip.NewWriter(zipFile) - defer zipWriter.Close() - - // Add manifest.json - manifestWriter, err := zipWriter.Create("manifest.json") - Expect(err).NotTo(HaveOccurred()) - _, err = manifestWriter.Write(manifestContent) - Expect(err).NotTo(HaveOccurred()) - - // Add plugin.wasm - wasmWriter, err := zipWriter.Create("plugin.wasm") - Expect(err).NotTo(HaveOccurred()) - _, err = wasmWriter.Write(wasmContent) - Expect(err).NotTo(HaveOccurred()) - - // Add README.md - readmeWriter, err := zipWriter.Create("README.md") - Expect(err).NotTo(HaveOccurred()) - _, err = readmeWriter.Write(readmeContent) - Expect(err).NotTo(HaveOccurred()) + var err error + tmpDir, err = os.MkdirTemp("", "plugin-package-test-*") + Expect(err).ToNot(HaveOccurred()) }) - It("should load and validate a plugin package", func() { - pkg, err := LoadPackage(ndpPath) - Expect(err).NotTo(HaveOccurred()) - Expect(pkg).NotTo(BeNil()) - - // Check manifest was parsed - Expect(pkg.Manifest).NotTo(BeNil()) - Expect(pkg.Manifest.Name).To(Equal("test-plugin")) - Expect(pkg.Manifest.Author).To(Equal("Test Author")) - Expect(pkg.Manifest.Version).To(Equal("1.0.0")) - Expect(pkg.Manifest.Description).To(Equal("A test plugin")) - Expect(pkg.Manifest.Capabilities).To(HaveLen(1)) - Expect(pkg.Manifest.Capabilities[0]).To(Equal(schema.PluginManifestCapabilitiesElemMetadataAgent)) - - // Check WASM file was loaded - Expect(pkg.WasmBytes).NotTo(BeEmpty()) - - // Check docs were loaded - Expect(pkg.Docs).To(HaveKey("README.md")) + AfterEach(func() { + os.RemoveAll(tmpDir) }) - It("should extract a plugin package to a directory", func() { - targetDir := filepath.Join(tempDir, "extracted") + Describe("openPackage", func() { + It("should load a valid .ndp package", func() { + ndpPath := filepath.Join(tmpDir, "test.ndp") + manifest := &Manifest{ + Name: "Test Plugin", + Author: "Test Author", + Version: "1.0.0", + } + wasmBytes := []byte{0x00, 0x61, 0x73, 0x6d} // Minimal wasm header - err := ExtractPackage(ndpPath, targetDir) - Expect(err).NotTo(HaveOccurred()) + err := createTestPackage(ndpPath, manifest, wasmBytes) + Expect(err).ToNot(HaveOccurred()) - // Check files were extracted - Expect(filepath.Join(targetDir, "manifest.json")).To(BeARegularFile()) - Expect(filepath.Join(targetDir, "plugin.wasm")).To(BeARegularFile()) - Expect(filepath.Join(targetDir, "README.md")).To(BeARegularFile()) + pkg, err := openPackage(ndpPath) + Expect(err).ToNot(HaveOccurred()) + Expect(pkg.Manifest.Name).To(Equal("Test Plugin")) + Expect(pkg.Manifest.Author).To(Equal("Test Author")) + Expect(pkg.Manifest.Version).To(Equal("1.0.0")) + Expect(pkg.WasmBytes).To(Equal(wasmBytes)) + }) + + It("should return error for missing manifest.json", func() { + ndpPath := filepath.Join(tmpDir, "no-manifest.ndp") + + // Create a zip with only plugin.wasm + f, err := os.Create(ndpPath) + Expect(err).ToNot(HaveOccurred()) + defer f.Close() + + zw := newTestZipWriter(f) + err = zw.addFile("plugin.wasm", []byte{0x00}) + Expect(err).ToNot(HaveOccurred()) + err = zw.close() + Expect(err).ToNot(HaveOccurred()) + + _, err = openPackage(ndpPath) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("missing manifest.json")) + }) + + It("should return error for missing plugin.wasm", func() { + ndpPath := filepath.Join(tmpDir, "no-wasm.ndp") + + // Create a zip with only manifest.json + f, err := os.Create(ndpPath) + Expect(err).ToNot(HaveOccurred()) + defer f.Close() + + zw := newTestZipWriter(f) + err = zw.addFile("manifest.json", []byte(`{"name":"Test","author":"Test","version":"1.0.0"}`)) + Expect(err).ToNot(HaveOccurred()) + err = zw.close() + Expect(err).ToNot(HaveOccurred()) + + _, err = openPackage(ndpPath) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("missing plugin.wasm")) + }) + + It("should return error for invalid manifest JSON", func() { + ndpPath := filepath.Join(tmpDir, "invalid-json.ndp") + + f, err := os.Create(ndpPath) + Expect(err).ToNot(HaveOccurred()) + defer f.Close() + + zw := newTestZipWriter(f) + err = zw.addFile("manifest.json", []byte(`{invalid json}`)) + Expect(err).ToNot(HaveOccurred()) + err = zw.addFile("plugin.wasm", []byte{0x00}) + Expect(err).ToNot(HaveOccurred()) + err = zw.close() + Expect(err).ToNot(HaveOccurred()) + + _, err = openPackage(ndpPath) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("parsing manifest")) + }) + + It("should return error for manifest missing required fields", func() { + ndpPath := filepath.Join(tmpDir, "invalid-manifest.ndp") + + f, err := os.Create(ndpPath) + Expect(err).ToNot(HaveOccurred()) + defer f.Close() + + zw := newTestZipWriter(f) + err = zw.addFile("manifest.json", []byte(`{"name":"Test"}`)) // Missing author and version + Expect(err).ToNot(HaveOccurred()) + err = zw.addFile("plugin.wasm", []byte{0x00}) + Expect(err).ToNot(HaveOccurred()) + err = zw.close() + Expect(err).ToNot(HaveOccurred()) + + _, err = openPackage(ndpPath) + Expect(err).To(HaveOccurred()) + // JSON schema validation happens during unmarshaling + Expect(err.Error()).To(ContainSubstring("parsing manifest")) + Expect(err.Error()).To(ContainSubstring("author")) + }) + + It("should return error for non-existent file", func() { + _, err := openPackage(filepath.Join(tmpDir, "nonexistent.ndp")) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("opening package")) + }) }) - It("should fail to load an invalid package", func() { - // Create an invalid package (missing required files) - invalidPath := filepath.Join(tempDir, "invalid.ndp") - zipFile, err := os.Create(invalidPath) - Expect(err).NotTo(HaveOccurred()) + Describe("readManifest", func() { + It("should read only the manifest without loading wasm", func() { + ndpPath := filepath.Join(tmpDir, "test.ndp") + desc := "A test plugin" + manifest := &Manifest{ + Name: "Test Plugin", + Author: "Test Author", + Version: "1.0.0", + Description: &desc, + } + wasmBytes := make([]byte, 1024*1024) // 1MB of zeros - zipWriter := zip.NewWriter(zipFile) - // Only add a README, missing manifest and wasm - readmeWriter, err := zipWriter.Create("README.md") - Expect(err).NotTo(HaveOccurred()) - _, err = readmeWriter.Write([]byte("Invalid package")) - Expect(err).NotTo(HaveOccurred()) - zipWriter.Close() - zipFile.Close() + err := createTestPackage(ndpPath, manifest, wasmBytes) + Expect(err).ToNot(HaveOccurred()) - // Test loading fails - _, err = LoadPackage(invalidPath) - Expect(err).To(HaveOccurred()) + m, err := readManifest(ndpPath) + Expect(err).ToNot(HaveOccurred()) + Expect(m.Name).To(Equal("Test Plugin")) + Expect(*m.Description).To(Equal("A test plugin")) + }) + + It("should return error for missing manifest", func() { + ndpPath := filepath.Join(tmpDir, "no-manifest.ndp") + + f, err := os.Create(ndpPath) + Expect(err).ToNot(HaveOccurred()) + defer f.Close() + + zw := newTestZipWriter(f) + err = zw.addFile("plugin.wasm", []byte{0x00}) + Expect(err).ToNot(HaveOccurred()) + err = zw.close() + Expect(err).ToNot(HaveOccurred()) + + _, err = readManifest(ndpPath) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("missing manifest.json")) + }) + }) + + Describe("ComputePackageSHA256", func() { + It("should compute consistent hash for same file", func() { + ndpPath := filepath.Join(tmpDir, "test.ndp") + manifest := &Manifest{ + Name: "Test Plugin", + Author: "Test Author", + Version: "1.0.0", + } + wasmBytes := []byte{0x00, 0x61, 0x73, 0x6d} + + err := createTestPackage(ndpPath, manifest, wasmBytes) + Expect(err).ToNot(HaveOccurred()) + + hash1, err := computeFileSHA256(ndpPath) + Expect(err).ToNot(HaveOccurred()) + + hash2, err := computeFileSHA256(ndpPath) + Expect(err).ToNot(HaveOccurred()) + + Expect(hash1).To(Equal(hash2)) + Expect(hash1).To(HaveLen(64)) // SHA-256 produces 64 hex characters + }) }) }) + +// testZipHelper is a helper for creating test zip files with specific contents +type testZipHelper struct { + f *os.File + entries []zipEntry +} + +type zipEntry struct { + name string + data []byte +} + +func newTestZipWriter(f *os.File) *testZipHelper { + return &testZipHelper{f: f} +} + +func (h *testZipHelper) addFile(name string, data []byte) error { + h.entries = append(h.entries, zipEntry{name: name, data: data}) + return nil +} + +func (h *testZipHelper) close() error { + zw := zip.NewWriter(h.f) + for _, e := range h.entries { + w, err := zw.Create(e.name) + if err != nil { + return err + } + if _, err := w.Write(e.data); err != nil { + return err + } + } + return zw.Close() +} + +// createTestPackage creates an .ndp package file from a manifest and wasm bytes. +// This is primarily used for testing. +func createTestPackage(ndpPath string, manifest *Manifest, wasmBytes []byte) error { + f, err := os.Create(ndpPath) + if err != nil { + return fmt.Errorf("creating package file: %w", err) + } + defer f.Close() + + zw := zip.NewWriter(f) + defer zw.Close() + + // Write manifest.json + manifestBytes, err := json.Marshal(manifest) + if err != nil { + return fmt.Errorf("marshaling manifest: %w", err) + } + + mw, err := zw.Create(manifestFileName) + if err != nil { + return fmt.Errorf("creating manifest in zip: %w", err) + } + if _, err := mw.Write(manifestBytes); err != nil { + return fmt.Errorf("writing manifest: %w", err) + } + + // Write plugin.wasm + ww, err := zw.Create(wasmFileName) + if err != nil { + return fmt.Errorf("creating wasm in zip: %w", err) + } + if _, err := ww.Write(wasmBytes); err != nil { + return fmt.Errorf("writing wasm: %w", err) + } + + return nil +} diff --git a/plugins/pdk/go/README.md b/plugins/pdk/go/README.md new file mode 100644 index 000000000..70c680b1f --- /dev/null +++ b/plugins/pdk/go/README.md @@ -0,0 +1,379 @@ +# Navidrome Plugin Development Kit for Go + +This directory contains the auto-generated Go PDK (Plugin Development Kit) for building Navidrome plugins. +The PDK provides both **host function wrappers** for interacting with Navidrome and +**capability interfaces** for implementing plugin functionality. + +## ⚠️ Auto-Generated Code + +**Do not edit files in this directory manually.** They are generated by the `ndpgen` tool. + +To regenerate: + +```bash +make gen +``` + +## Module Structure + +This is a consolidated Go module that includes: + +- `host/` - Host function wrappers for calling Navidrome services from plugins +- `lifecycle/` - Plugin lifecycle hooks (initialization) +- `metadata/` - Metadata agent capability for artist/album info +- `scheduler/` - Scheduler callback capability for scheduled tasks +- `scrobbler/` - Scrobbler capability for play tracking +- `websocket/` - WebSocket callback capability for real-time messages + +## Usage + +Add this module as a dependency in your plugin's `go.mod`: + +```go +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go +``` + +Then import the packages you need: + +```go +package main + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/host" + "github.com/navidrome/navidrome/plugins/pdk/go/lifecycle" + "github.com/navidrome/navidrome/plugins/pdk/go/scheduler" +) + +func init() { + lifecycle.Register(&myPlugin{}) + scheduler.Register(&myPlugin{}) +} + +type myPlugin struct{} + +func (p *myPlugin) OnInit() error { + // Initialize your plugin + return nil +} + +func (p *myPlugin) OnCallback(req scheduler.SchedulerCallbackRequest) error { + // Handle scheduled task + return host.WebSocketBroadcast("task-complete", req.ScheduleID) +} + +func main() {} +``` + +## Host Services + +The `host` package provides wrappers for calling Navidrome's host services: + +| Service | Description | +|---------------|----------------------------------------------------| +| `Artwork` | Access album and artist artwork | +| `Cache` | Temporary key-value storage with TTL | +| `KVStore` | Persistent key-value storage | +| `Library` | Access the music library (albums, artists, tracks) | +| `Scheduler` | Schedule one-time and recurring tasks | +| `SubsonicAPI` | Make Subsonic API calls | +| `WebSocket` | Send real-time messages to clients | + +### Example: Using Host Services + +```go +package main + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/host" +) + +func myPluginFunction() error { + // Use the cache service + _, err := host.CacheSetString("my_key", "my_value", 3600) + if err != nil { + return err + } + + // Schedule a recurring task + _, err = host.SchedulerScheduleRecurring("@every 5m", "payload", "task_id") + if err != nil { + return err + } + + // Access library data with typed structs + resp, err := host.LibraryGetAllLibraries() + if err != nil { + return err + } + for _, lib := range resp.Result { + // Library: %s with %d songs", lib.Name, lib.TotalSongs + } + + return nil +} +``` + +## Capabilities + +Capabilities define what functionality your plugin implements. Register your implementations +in the `init()` function. + +### Lifecycle + +Provides plugin initialization hooks. + +```go +import "github.com/navidrome/navidrome/plugins/pdk/go/lifecycle" + +func init() { + lifecycle.Register(&myPlugin{}) +} + +type myPlugin struct{} + +func (p *myPlugin) OnInit() error { + // Called once when plugin is loaded + return nil +} +``` + +### MetadataAgent + +Provides artist and album metadata from external sources. + +```go +import "github.com/navidrome/navidrome/plugins/pdk/go/metadata" + +func init() { + metadata.Register(&myAgent{}) +} + +type myAgent struct{} + +func (a *myAgent) GetArtistBiography(req metadata.ArtistRequest) (*metadata.ArtistBiographyResponse, error) { + return &metadata.ArtistBiographyResponse{ + Biography: "Artist biography text...", + }, nil +} + +func (a *myAgent) GetArtistImages(req metadata.ArtistRequest) (*metadata.ArtistImagesResponse, error) { + return &metadata.ArtistImagesResponse{ + Images: []metadata.ImageInfo{ + {URL: "https://example.com/image.jpg", Size: 1000}, + }, + }, nil +} +``` + +### Scheduler + +Handles callbacks from scheduled tasks. + +```go +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/host" + "github.com/navidrome/navidrome/plugins/pdk/go/scheduler" +) + +func init() { + scheduler.Register(&myScheduler{}) +} + +type myScheduler struct{} + +func (s *myScheduler) OnCallback(req scheduler.SchedulerCallbackRequest) error { + // Handle the scheduled task + if req.Payload == "update-data" { + // Do work... + return host.WebSocketBroadcast("data-updated", "") + } + return nil +} +``` + +### Scrobbler + +Tracks play activity. + +```go +import "github.com/navidrome/navidrome/plugins/pdk/go/scrobbler" + +func init() { + scrobbler.Register(&myScrobbler{}) +} + +type myScrobbler struct{} + +func (s *myScrobbler) Scrobble(req scrobbler.ScrobbleRequest) error { + // Track the play + return nil +} + +func (s *myScrobbler) NowPlaying(req scrobbler.NowPlayingRequest) error { + // Update now playing status + return nil +} +``` + +### WebSocket + +Handles incoming WebSocket messages. + +```go +import "github.com/navidrome/navidrome/plugins/pdk/go/websocket" + +func init() { + websocket.Register(&myHandler{}) +} + +type myHandler struct{} + +func (h *myHandler) OnWebSocketMessage(req websocket.WebSocketMessageRequest) error { + // Handle incoming message + return nil +} +``` + +## Building Plugins + +Go plugins must be compiled to WebAssembly using TinyGo: + +```bash +tinygo build -o plugin.wasm -target=wasip1 -buildmode=c-shared . +``` + +Or use the provided Makefile targets in plugin examples: + +```bash +make plugin.wasm +``` + +## Testing Plugins + +The PDK includes [testify/mock](https://github.com/stretchr/testify) implementations for all host services, +allowing you to unit test your plugin code on non-WASM platforms (your development machine). + +### PDK Abstraction Layer + +The `pdk` subpackage provides a testable wrapper around the Extism PDK functions. Instead of importing +`github.com/extism/go-pdk` directly, import the abstraction layer: + +```go +import "github.com/navidrome/navidrome/plugins/pdk/go/pdk" + +func myFunction() { + // Use pdk functions - same API as extism/go-pdk + config, ok := pdk.GetConfig("my_setting") + if ok { + pdk.Log(pdk.LogInfo, "Setting: " + config) + } + + var input MyInput + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return + } + + output := processInput(input) + pdk.OutputJSON(output) +} +``` + +For WASM builds, these functions delegate directly to `extism/go-pdk` with zero overhead. +For native builds (tests), they use mocks that you can configure: + +```go +package myplugin + +import ( + "testing" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +func TestMyFunction(t *testing.T) { + // Reset mock state before each test + pdk.ResetMock() + + // Set up expectations + pdk.PDKMock.On("GetConfig", "my_setting").Return("test_value", true) + pdk.PDKMock.On("Log", pdk.LogInfo, "Setting: test_value").Return() + pdk.PDKMock.On("InputJSON", mock.Anything).Return(nil).Run(func(args mock.Arguments) { + // Populate the input struct + input := args.Get(0).(*MyInput) + input.Name = "test" + }) + pdk.PDKMock.On("OutputJSON", mock.Anything).Return(nil) + + // Call your function + myFunction() + + // Verify expectations + pdk.PDKMock.AssertExpectations(t) +} +``` + +### Mock Instances + +Each host service has an auto-instantiated mock instance: + +| Service | Mock Instance | +|---------------|--------------------------| +| `Artwork` | `host.ArtworkMock` | +| `Cache` | `host.CacheMock` | +| `Config` | `host.ConfigMock` | +| `KVStore` | `host.KVStoreMock` | +| `Library` | `host.LibraryMock` | +| `Scheduler` | `host.SchedulerMock` | +| `SubsonicAPI` | `host.SubsonicAPIMock` | +| `WebSocket` | `host.WebSocketMock` | + +### Example Test + +```go +package myplugin + +import ( + "testing" + + "github.com/navidrome/navidrome/plugins/pdk/go/host" +) + +func TestMyPluginFunction(t *testing.T) { + // Set expectations on the mock + host.CacheMock.On("GetString", "my-key").Return("cached-value", true, nil) + host.CacheMock.On("SetString", "new-key", "new-value", int64(3600)).Return(nil) + + // Call your plugin code that uses host.CacheGetString / host.CacheSetString + result, err := myPluginFunction() + if err != nil { + t.Fatalf("unexpected error: %v", err) + } + + // Assert the result + if result != "expected" { + t.Errorf("unexpected result: %s", result) + } + + // Verify all expected calls were made + host.CacheMock.AssertExpectations(t) +} +``` + +### Running Tests + +Since tests run on your development machine (not WASM), use standard Go testing: + +```bash +go test ./... +``` + +The stub files with mocks are only compiled for non-WASM builds (`//go:build !wasip1`), +so they won't affect your production WASM binary. + +### Complete Examples + +For more comprehensive examples including HTTP requests, Memory handling, and various testing patterns, +see [pdk/example_test.go](pdk/example_test.go). diff --git a/plugins/pdk/go/go.mod b/plugins/pdk/go/go.mod new file mode 100644 index 000000000..4d5fcddfc --- /dev/null +++ b/plugins/pdk/go/go.mod @@ -0,0 +1,15 @@ +module github.com/navidrome/navidrome/plugins/pdk/go + +go 1.25 + +require ( + github.com/extism/go-pdk v1.1.3 + github.com/stretchr/testify v1.11.1 +) + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) diff --git a/plugins/pdk/go/go.sum b/plugins/pdk/go/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/pdk/go/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/pdk/go/host/doc.go b/plugins/pdk/go/host/doc.go new file mode 100644 index 000000000..5781a04c1 --- /dev/null +++ b/plugins/pdk/go/host/doc.go @@ -0,0 +1,58 @@ +// Code generated by ndpgen. DO NOT EDIT. + +/* +Package host provides Navidrome Plugin Development Kit wrappers for Go/TinyGo plugins. + +This package is auto-generated by the ndpgen tool and should not be edited manually. + +# Usage + +Add this module as a dependency in your plugin's go.mod: + + require github.com/navidrome/navidrome/plugins/pdk/go/host v0.0.0 + +Then import the package in your plugin code: + + import host "github.com/navidrome/navidrome/plugins/pdk/go/host" + + func myPluginFunction() error { + // Use the cache service + _, err := host.CacheSetString("my_key", "my_value", 3600) + if err != nil { + return err + } + + // Schedule a recurring task + _, err = host.SchedulerScheduleRecurring("@every 5m", "payload", "task_id") + if err != nil { + return err + } + + return nil + } + +# Available Services + +The following host services are available: + + - Artwork: provides artwork public URL generation capabilities for plugins. + - Cache: provides in-memory TTL-based caching capabilities for plugins. + - Config: provides access to plugin configuration values. + - HTTP: provides outbound HTTP request capabilities for plugins. + - KVStore: provides persistent key-value storage for plugins. + - Library: provides access to music library metadata for plugins. + - Scheduler: provides task scheduling capabilities for plugins. + - SubsonicAPI: provides access to Navidrome's Subsonic API from plugins. + - Task: provides persistent task queues for plugins. + - Users: provides access to user information for plugins. + - WebSocket: provides WebSocket communication capabilities for plugins. + +# Building Plugins + +Go plugins must be compiled to WebAssembly using TinyGo: + + tinygo build -o plugin.wasm -target=wasip1 -buildmode=c-shared . + +See the examples directory for complete plugin implementations. +*/ +package host diff --git a/plugins/pdk/go/host/nd_host_artwork.go b/plugins/pdk/go/host/nd_host_artwork.go new file mode 100644 index 000000000..05fcdebe2 --- /dev/null +++ b/plugins/pdk/go/host/nd_host_artwork.go @@ -0,0 +1,243 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Artwork host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package host + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// artwork_getartisturl is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user artwork_getartisturl +func artwork_getartisturl(uint64) uint64 + +// artwork_getalbumurl is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user artwork_getalbumurl +func artwork_getalbumurl(uint64) uint64 + +// artwork_gettrackurl is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user artwork_gettrackurl +func artwork_gettrackurl(uint64) uint64 + +// artwork_getplaylisturl is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user artwork_getplaylisturl +func artwork_getplaylisturl(uint64) uint64 + +type artworkGetArtistUrlRequest struct { + Id string `json:"id"` + Size int32 `json:"size"` +} + +type artworkGetArtistUrlResponse struct { + Url string `json:"url,omitempty"` + Error string `json:"error,omitempty"` +} + +type artworkGetAlbumUrlRequest struct { + Id string `json:"id"` + Size int32 `json:"size"` +} + +type artworkGetAlbumUrlResponse struct { + Url string `json:"url,omitempty"` + Error string `json:"error,omitempty"` +} + +type artworkGetTrackUrlRequest struct { + Id string `json:"id"` + Size int32 `json:"size"` +} + +type artworkGetTrackUrlResponse struct { + Url string `json:"url,omitempty"` + Error string `json:"error,omitempty"` +} + +type artworkGetPlaylistUrlRequest struct { + Id string `json:"id"` + Size int32 `json:"size"` +} + +type artworkGetPlaylistUrlResponse struct { + Url string `json:"url,omitempty"` + Error string `json:"error,omitempty"` +} + +// ArtworkGetArtistUrl calls the artwork_getartisturl host function. +// GetArtistUrl generates a public URL for an artist's artwork. +// +// Parameters: +// - id: The artist's unique identifier +// - size: Desired image size in pixels (0 for original size) +// +// Returns the public URL for the artwork, or an error if generation fails. +func ArtworkGetArtistUrl(id string, size int32) (string, error) { + // Marshal request to JSON + req := artworkGetArtistUrlRequest{ + Id: id, + Size: size, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return "", err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := artwork_getartisturl(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response artworkGetArtistUrlResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return "", err + } + + // Convert Error field to Go error + if response.Error != "" { + return "", errors.New(response.Error) + } + + return response.Url, nil +} + +// ArtworkGetAlbumUrl calls the artwork_getalbumurl host function. +// GetAlbumUrl generates a public URL for an album's artwork. +// +// Parameters: +// - id: The album's unique identifier +// - size: Desired image size in pixels (0 for original size) +// +// Returns the public URL for the artwork, or an error if generation fails. +func ArtworkGetAlbumUrl(id string, size int32) (string, error) { + // Marshal request to JSON + req := artworkGetAlbumUrlRequest{ + Id: id, + Size: size, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return "", err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := artwork_getalbumurl(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response artworkGetAlbumUrlResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return "", err + } + + // Convert Error field to Go error + if response.Error != "" { + return "", errors.New(response.Error) + } + + return response.Url, nil +} + +// ArtworkGetTrackUrl calls the artwork_gettrackurl host function. +// GetTrackUrl generates a public URL for a track's artwork. +// +// Parameters: +// - id: The track's (media file) unique identifier +// - size: Desired image size in pixels (0 for original size) +// +// Returns the public URL for the artwork, or an error if generation fails. +func ArtworkGetTrackUrl(id string, size int32) (string, error) { + // Marshal request to JSON + req := artworkGetTrackUrlRequest{ + Id: id, + Size: size, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return "", err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := artwork_gettrackurl(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response artworkGetTrackUrlResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return "", err + } + + // Convert Error field to Go error + if response.Error != "" { + return "", errors.New(response.Error) + } + + return response.Url, nil +} + +// ArtworkGetPlaylistUrl calls the artwork_getplaylisturl host function. +// GetPlaylistUrl generates a public URL for a playlist's artwork. +// +// Parameters: +// - id: The playlist's unique identifier +// - size: Desired image size in pixels (0 for original size) +// +// Returns the public URL for the artwork, or an error if generation fails. +func ArtworkGetPlaylistUrl(id string, size int32) (string, error) { + // Marshal request to JSON + req := artworkGetPlaylistUrlRequest{ + Id: id, + Size: size, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return "", err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := artwork_getplaylisturl(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response artworkGetPlaylistUrlResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return "", err + } + + // Convert Error field to Go error + if response.Error != "" { + return "", errors.New(response.Error) + } + + return response.Url, nil +} diff --git a/plugins/pdk/go/host/nd_host_artwork_stub.go b/plugins/pdk/go/host/nd_host_artwork_stub.go new file mode 100644 index 000000000..aa41e440c --- /dev/null +++ b/plugins/pdk/go/host/nd_host_artwork_stub.go @@ -0,0 +1,92 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains mock implementations for non-WASM builds. +// These mocks allow IDE support, compilation, and unit testing on non-WASM platforms. +// Plugin authors can use the exported mock instances to set expectations in tests. +// +//go:build !wasip1 + +package host + +import "github.com/stretchr/testify/mock" + +// mockArtworkService is the mock implementation for testing. +type mockArtworkService struct { + mock.Mock +} + +// ArtworkMock is the auto-instantiated mock instance for testing. +// Use this to set expectations: host.ArtworkMock.On("MethodName", args...).Return(values...) +var ArtworkMock = &mockArtworkService{} + +// GetArtistUrl is the mock method for ArtworkGetArtistUrl. +func (m *mockArtworkService) GetArtistUrl(id string, size int32) (string, error) { + args := m.Called(id, size) + return args.String(0), args.Error(1) +} + +// ArtworkGetArtistUrl delegates to the mock instance. +// GetArtistUrl generates a public URL for an artist's artwork. +// +// Parameters: +// - id: The artist's unique identifier +// - size: Desired image size in pixels (0 for original size) +// +// Returns the public URL for the artwork, or an error if generation fails. +func ArtworkGetArtistUrl(id string, size int32) (string, error) { + return ArtworkMock.GetArtistUrl(id, size) +} + +// GetAlbumUrl is the mock method for ArtworkGetAlbumUrl. +func (m *mockArtworkService) GetAlbumUrl(id string, size int32) (string, error) { + args := m.Called(id, size) + return args.String(0), args.Error(1) +} + +// ArtworkGetAlbumUrl delegates to the mock instance. +// GetAlbumUrl generates a public URL for an album's artwork. +// +// Parameters: +// - id: The album's unique identifier +// - size: Desired image size in pixels (0 for original size) +// +// Returns the public URL for the artwork, or an error if generation fails. +func ArtworkGetAlbumUrl(id string, size int32) (string, error) { + return ArtworkMock.GetAlbumUrl(id, size) +} + +// GetTrackUrl is the mock method for ArtworkGetTrackUrl. +func (m *mockArtworkService) GetTrackUrl(id string, size int32) (string, error) { + args := m.Called(id, size) + return args.String(0), args.Error(1) +} + +// ArtworkGetTrackUrl delegates to the mock instance. +// GetTrackUrl generates a public URL for a track's artwork. +// +// Parameters: +// - id: The track's (media file) unique identifier +// - size: Desired image size in pixels (0 for original size) +// +// Returns the public URL for the artwork, or an error if generation fails. +func ArtworkGetTrackUrl(id string, size int32) (string, error) { + return ArtworkMock.GetTrackUrl(id, size) +} + +// GetPlaylistUrl is the mock method for ArtworkGetPlaylistUrl. +func (m *mockArtworkService) GetPlaylistUrl(id string, size int32) (string, error) { + args := m.Called(id, size) + return args.String(0), args.Error(1) +} + +// ArtworkGetPlaylistUrl delegates to the mock instance. +// GetPlaylistUrl generates a public URL for a playlist's artwork. +// +// Parameters: +// - id: The playlist's unique identifier +// - size: Desired image size in pixels (0 for original size) +// +// Returns the public URL for the artwork, or an error if generation fails. +func ArtworkGetPlaylistUrl(id string, size int32) (string, error) { + return ArtworkMock.GetPlaylistUrl(id, size) +} diff --git a/plugins/pdk/go/host/nd_host_cache.go b/plugins/pdk/go/host/nd_host_cache.go new file mode 100644 index 000000000..7fd9d10fa --- /dev/null +++ b/plugins/pdk/go/host/nd_host_cache.go @@ -0,0 +1,557 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Cache host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package host + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// cache_setstring is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user cache_setstring +func cache_setstring(uint64) uint64 + +// cache_getstring is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user cache_getstring +func cache_getstring(uint64) uint64 + +// cache_setint is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user cache_setint +func cache_setint(uint64) uint64 + +// cache_getint is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user cache_getint +func cache_getint(uint64) uint64 + +// cache_setfloat is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user cache_setfloat +func cache_setfloat(uint64) uint64 + +// cache_getfloat is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user cache_getfloat +func cache_getfloat(uint64) uint64 + +// cache_setbytes is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user cache_setbytes +func cache_setbytes(uint64) uint64 + +// cache_getbytes is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user cache_getbytes +func cache_getbytes(uint64) uint64 + +// cache_has is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user cache_has +func cache_has(uint64) uint64 + +// cache_remove is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user cache_remove +func cache_remove(uint64) uint64 + +type cacheSetStringRequest struct { + Key string `json:"key"` + Value string `json:"value"` + TtlSeconds int64 `json:"ttlSeconds"` +} + +type cacheGetStringRequest struct { + Key string `json:"key"` +} + +type cacheGetStringResponse struct { + Value string `json:"value,omitempty"` + Exists bool `json:"exists,omitempty"` + Error string `json:"error,omitempty"` +} + +type cacheSetIntRequest struct { + Key string `json:"key"` + Value int64 `json:"value"` + TtlSeconds int64 `json:"ttlSeconds"` +} + +type cacheGetIntRequest struct { + Key string `json:"key"` +} + +type cacheGetIntResponse struct { + Value int64 `json:"value,omitempty"` + Exists bool `json:"exists,omitempty"` + Error string `json:"error,omitempty"` +} + +type cacheSetFloatRequest struct { + Key string `json:"key"` + Value float64 `json:"value"` + TtlSeconds int64 `json:"ttlSeconds"` +} + +type cacheGetFloatRequest struct { + Key string `json:"key"` +} + +type cacheGetFloatResponse struct { + Value float64 `json:"value,omitempty"` + Exists bool `json:"exists,omitempty"` + Error string `json:"error,omitempty"` +} + +type cacheSetBytesRequest struct { + Key string `json:"key"` + Value []byte `json:"value"` + TtlSeconds int64 `json:"ttlSeconds"` +} + +type cacheGetBytesRequest struct { + Key string `json:"key"` +} + +type cacheGetBytesResponse struct { + Value []byte `json:"value,omitempty"` + Exists bool `json:"exists,omitempty"` + Error string `json:"error,omitempty"` +} + +type cacheHasRequest struct { + Key string `json:"key"` +} + +type cacheHasResponse struct { + Exists bool `json:"exists,omitempty"` + Error string `json:"error,omitempty"` +} + +type cacheRemoveRequest struct { + Key string `json:"key"` +} + +// CacheSetString calls the cache_setstring host function. +// SetString stores a string value in the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// - value: The string value to store +// - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) +// +// Returns an error if the operation fails. +func CacheSetString(key string, value string, ttlSeconds int64) error { + // Marshal request to JSON + req := cacheSetStringRequest{ + Key: key, + Value: value, + TtlSeconds: ttlSeconds, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := cache_setstring(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} + +// CacheGetString calls the cache_getstring host function. +// GetString retrieves a string value from the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// +// Returns the value and whether the key exists. If the key doesn't exist +// or the stored value is not a string, exists will be false. +func CacheGetString(key string) (string, bool, error) { + // Marshal request to JSON + req := cacheGetStringRequest{ + Key: key, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return "", false, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := cache_getstring(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response cacheGetStringResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return "", false, err + } + + // Convert Error field to Go error + if response.Error != "" { + return "", false, errors.New(response.Error) + } + + return response.Value, response.Exists, nil +} + +// CacheSetInt calls the cache_setint host function. +// SetInt stores an integer value in the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// - value: The integer value to store +// - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) +// +// Returns an error if the operation fails. +func CacheSetInt(key string, value int64, ttlSeconds int64) error { + // Marshal request to JSON + req := cacheSetIntRequest{ + Key: key, + Value: value, + TtlSeconds: ttlSeconds, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := cache_setint(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} + +// CacheGetInt calls the cache_getint host function. +// GetInt retrieves an integer value from the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// +// Returns the value and whether the key exists. If the key doesn't exist +// or the stored value is not an integer, exists will be false. +func CacheGetInt(key string) (int64, bool, error) { + // Marshal request to JSON + req := cacheGetIntRequest{ + Key: key, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return 0, false, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := cache_getint(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response cacheGetIntResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return 0, false, err + } + + // Convert Error field to Go error + if response.Error != "" { + return 0, false, errors.New(response.Error) + } + + return response.Value, response.Exists, nil +} + +// CacheSetFloat calls the cache_setfloat host function. +// SetFloat stores a float value in the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// - value: The float value to store +// - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) +// +// Returns an error if the operation fails. +func CacheSetFloat(key string, value float64, ttlSeconds int64) error { + // Marshal request to JSON + req := cacheSetFloatRequest{ + Key: key, + Value: value, + TtlSeconds: ttlSeconds, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := cache_setfloat(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} + +// CacheGetFloat calls the cache_getfloat host function. +// GetFloat retrieves a float value from the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// +// Returns the value and whether the key exists. If the key doesn't exist +// or the stored value is not a float, exists will be false. +func CacheGetFloat(key string) (float64, bool, error) { + // Marshal request to JSON + req := cacheGetFloatRequest{ + Key: key, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return 0, false, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := cache_getfloat(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response cacheGetFloatResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return 0, false, err + } + + // Convert Error field to Go error + if response.Error != "" { + return 0, false, errors.New(response.Error) + } + + return response.Value, response.Exists, nil +} + +// CacheSetBytes calls the cache_setbytes host function. +// SetBytes stores a byte slice in the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// - value: The byte slice to store +// - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) +// +// Returns an error if the operation fails. +func CacheSetBytes(key string, value []byte, ttlSeconds int64) error { + // Marshal request to JSON + req := cacheSetBytesRequest{ + Key: key, + Value: value, + TtlSeconds: ttlSeconds, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := cache_setbytes(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} + +// CacheGetBytes calls the cache_getbytes host function. +// GetBytes retrieves a byte slice from the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// +// Returns the value and whether the key exists. If the key doesn't exist +// or the stored value is not a byte slice, exists will be false. +func CacheGetBytes(key string) ([]byte, bool, error) { + // Marshal request to JSON + req := cacheGetBytesRequest{ + Key: key, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return nil, false, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := cache_getbytes(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response cacheGetBytesResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return nil, false, err + } + + // Convert Error field to Go error + if response.Error != "" { + return nil, false, errors.New(response.Error) + } + + return response.Value, response.Exists, nil +} + +// CacheHas calls the cache_has host function. +// Has checks if a key exists in the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// +// Returns true if the key exists and has not expired. +func CacheHas(key string) (bool, error) { + // Marshal request to JSON + req := cacheHasRequest{ + Key: key, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return false, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := cache_has(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response cacheHasResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return false, err + } + + // Convert Error field to Go error + if response.Error != "" { + return false, errors.New(response.Error) + } + + return response.Exists, nil +} + +// CacheRemove calls the cache_remove host function. +// Remove deletes a value from the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// +// Returns an error if the operation fails. Does not return an error if the key doesn't exist. +func CacheRemove(key string) error { + // Marshal request to JSON + req := cacheRemoveRequest{ + Key: key, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := cache_remove(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} diff --git a/plugins/pdk/go/host/nd_host_cache_stub.go b/plugins/pdk/go/host/nd_host_cache_stub.go new file mode 100644 index 000000000..fbd80d13f --- /dev/null +++ b/plugins/pdk/go/host/nd_host_cache_stub.go @@ -0,0 +1,202 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains mock implementations for non-WASM builds. +// These mocks allow IDE support, compilation, and unit testing on non-WASM platforms. +// Plugin authors can use the exported mock instances to set expectations in tests. +// +//go:build !wasip1 + +package host + +import "github.com/stretchr/testify/mock" + +// mockCacheService is the mock implementation for testing. +type mockCacheService struct { + mock.Mock +} + +// CacheMock is the auto-instantiated mock instance for testing. +// Use this to set expectations: host.CacheMock.On("MethodName", args...).Return(values...) +var CacheMock = &mockCacheService{} + +// SetString is the mock method for CacheSetString. +func (m *mockCacheService) SetString(key string, value string, ttlSeconds int64) error { + args := m.Called(key, value, ttlSeconds) + return args.Error(0) +} + +// CacheSetString delegates to the mock instance. +// SetString stores a string value in the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// - value: The string value to store +// - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) +// +// Returns an error if the operation fails. +func CacheSetString(key string, value string, ttlSeconds int64) error { + return CacheMock.SetString(key, value, ttlSeconds) +} + +// GetString is the mock method for CacheGetString. +func (m *mockCacheService) GetString(key string) (string, bool, error) { + args := m.Called(key) + return args.String(0), args.Bool(1), args.Error(2) +} + +// CacheGetString delegates to the mock instance. +// GetString retrieves a string value from the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// +// Returns the value and whether the key exists. If the key doesn't exist +// or the stored value is not a string, exists will be false. +func CacheGetString(key string) (string, bool, error) { + return CacheMock.GetString(key) +} + +// SetInt is the mock method for CacheSetInt. +func (m *mockCacheService) SetInt(key string, value int64, ttlSeconds int64) error { + args := m.Called(key, value, ttlSeconds) + return args.Error(0) +} + +// CacheSetInt delegates to the mock instance. +// SetInt stores an integer value in the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// - value: The integer value to store +// - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) +// +// Returns an error if the operation fails. +func CacheSetInt(key string, value int64, ttlSeconds int64) error { + return CacheMock.SetInt(key, value, ttlSeconds) +} + +// GetInt is the mock method for CacheGetInt. +func (m *mockCacheService) GetInt(key string) (int64, bool, error) { + args := m.Called(key) + return args.Get(0).(int64), args.Bool(1), args.Error(2) +} + +// CacheGetInt delegates to the mock instance. +// GetInt retrieves an integer value from the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// +// Returns the value and whether the key exists. If the key doesn't exist +// or the stored value is not an integer, exists will be false. +func CacheGetInt(key string) (int64, bool, error) { + return CacheMock.GetInt(key) +} + +// SetFloat is the mock method for CacheSetFloat. +func (m *mockCacheService) SetFloat(key string, value float64, ttlSeconds int64) error { + args := m.Called(key, value, ttlSeconds) + return args.Error(0) +} + +// CacheSetFloat delegates to the mock instance. +// SetFloat stores a float value in the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// - value: The float value to store +// - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) +// +// Returns an error if the operation fails. +func CacheSetFloat(key string, value float64, ttlSeconds int64) error { + return CacheMock.SetFloat(key, value, ttlSeconds) +} + +// GetFloat is the mock method for CacheGetFloat. +func (m *mockCacheService) GetFloat(key string) (float64, bool, error) { + args := m.Called(key) + return args.Get(0).(float64), args.Bool(1), args.Error(2) +} + +// CacheGetFloat delegates to the mock instance. +// GetFloat retrieves a float value from the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// +// Returns the value and whether the key exists. If the key doesn't exist +// or the stored value is not a float, exists will be false. +func CacheGetFloat(key string) (float64, bool, error) { + return CacheMock.GetFloat(key) +} + +// SetBytes is the mock method for CacheSetBytes. +func (m *mockCacheService) SetBytes(key string, value []byte, ttlSeconds int64) error { + args := m.Called(key, value, ttlSeconds) + return args.Error(0) +} + +// CacheSetBytes delegates to the mock instance. +// SetBytes stores a byte slice in the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// - value: The byte slice to store +// - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) +// +// Returns an error if the operation fails. +func CacheSetBytes(key string, value []byte, ttlSeconds int64) error { + return CacheMock.SetBytes(key, value, ttlSeconds) +} + +// GetBytes is the mock method for CacheGetBytes. +func (m *mockCacheService) GetBytes(key string) ([]byte, bool, error) { + args := m.Called(key) + return args.Get(0).([]byte), args.Bool(1), args.Error(2) +} + +// CacheGetBytes delegates to the mock instance. +// GetBytes retrieves a byte slice from the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// +// Returns the value and whether the key exists. If the key doesn't exist +// or the stored value is not a byte slice, exists will be false. +func CacheGetBytes(key string) ([]byte, bool, error) { + return CacheMock.GetBytes(key) +} + +// Has is the mock method for CacheHas. +func (m *mockCacheService) Has(key string) (bool, error) { + args := m.Called(key) + return args.Bool(0), args.Error(1) +} + +// CacheHas delegates to the mock instance. +// Has checks if a key exists in the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// +// Returns true if the key exists and has not expired. +func CacheHas(key string) (bool, error) { + return CacheMock.Has(key) +} + +// Remove is the mock method for CacheRemove. +func (m *mockCacheService) Remove(key string) error { + args := m.Called(key) + return args.Error(0) +} + +// CacheRemove delegates to the mock instance. +// Remove deletes a value from the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// +// Returns an error if the operation fails. Does not return an error if the key doesn't exist. +func CacheRemove(key string) error { + return CacheMock.Remove(key) +} diff --git a/plugins/pdk/go/host/nd_host_config.go b/plugins/pdk/go/host/nd_host_config.go new file mode 100644 index 000000000..1d913e626 --- /dev/null +++ b/plugins/pdk/go/host/nd_host_config.go @@ -0,0 +1,161 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Config host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package host + +import ( + "encoding/json" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// config_get is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user config_get +func config_get(uint64) uint64 + +// config_getint is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user config_getint +func config_getint(uint64) uint64 + +// config_keys is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user config_keys +func config_keys(uint64) uint64 + +type configGetRequest struct { + Key string `json:"key"` +} + +type configGetResponse struct { + Value string `json:"value,omitempty"` + Exists bool `json:"exists,omitempty"` +} + +type configGetIntRequest struct { + Key string `json:"key"` +} + +type configGetIntResponse struct { + Value int64 `json:"value,omitempty"` + Exists bool `json:"exists,omitempty"` +} + +type configKeysRequest struct { + Prefix string `json:"prefix"` +} + +type configKeysResponse struct { + Keys []string `json:"keys,omitempty"` +} + +// ConfigGet calls the config_get host function. +// Get retrieves a configuration value as a string. +// +// Parameters: +// - key: The configuration key +// +// Returns the value and whether the key exists. +func ConfigGet(key string) (string, bool) { + // Marshal request to JSON + req := configGetRequest{ + Key: key, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return "", false + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := config_get(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response configGetResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return "", false + } + + return response.Value, response.Exists +} + +// ConfigGetInt calls the config_getint host function. +// GetInt retrieves a configuration value as an integer. +// +// Parameters: +// - key: The configuration key +// +// Returns the value and whether the key exists. If the key exists but the +// value cannot be parsed as an integer, exists will be false. +func ConfigGetInt(key string) (int64, bool) { + // Marshal request to JSON + req := configGetIntRequest{ + Key: key, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return 0, false + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := config_getint(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response configGetIntResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return 0, false + } + + return response.Value, response.Exists +} + +// ConfigKeys calls the config_keys host function. +// Keys returns configuration keys matching the given prefix. +// +// Parameters: +// - prefix: Key prefix to filter by. If empty, returns all keys. +// +// Returns a sorted slice of matching configuration keys. +func ConfigKeys(prefix string) []string { + // Marshal request to JSON + req := configKeysRequest{ + Prefix: prefix, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return nil + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := config_keys(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response configKeysResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return nil + } + + return response.Keys +} diff --git a/plugins/pdk/go/host/nd_host_config_stub.go b/plugins/pdk/go/host/nd_host_config_stub.go new file mode 100644 index 000000000..2b8485ce9 --- /dev/null +++ b/plugins/pdk/go/host/nd_host_config_stub.go @@ -0,0 +1,72 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains mock implementations for non-WASM builds. +// These mocks allow IDE support, compilation, and unit testing on non-WASM platforms. +// Plugin authors can use the exported mock instances to set expectations in tests. +// +//go:build !wasip1 + +package host + +import "github.com/stretchr/testify/mock" + +// mockConfigService is the mock implementation for testing. +type mockConfigService struct { + mock.Mock +} + +// ConfigMock is the auto-instantiated mock instance for testing. +// Use this to set expectations: host.ConfigMock.On("MethodName", args...).Return(values...) +var ConfigMock = &mockConfigService{} + +// Get is the mock method for ConfigGet. +func (m *mockConfigService) Get(key string) (string, bool) { + args := m.Called(key) + return args.String(0), args.Bool(1) +} + +// ConfigGet delegates to the mock instance. +// Get retrieves a configuration value as a string. +// +// Parameters: +// - key: The configuration key +// +// Returns the value and whether the key exists. +func ConfigGet(key string) (string, bool) { + return ConfigMock.Get(key) +} + +// GetInt is the mock method for ConfigGetInt. +func (m *mockConfigService) GetInt(key string) (int64, bool) { + args := m.Called(key) + return args.Get(0).(int64), args.Bool(1) +} + +// ConfigGetInt delegates to the mock instance. +// GetInt retrieves a configuration value as an integer. +// +// Parameters: +// - key: The configuration key +// +// Returns the value and whether the key exists. If the key exists but the +// value cannot be parsed as an integer, exists will be false. +func ConfigGetInt(key string) (int64, bool) { + return ConfigMock.GetInt(key) +} + +// Keys is the mock method for ConfigKeys. +func (m *mockConfigService) Keys(prefix string) []string { + args := m.Called(prefix) + return args.Get(0).([]string) +} + +// ConfigKeys delegates to the mock instance. +// Keys returns configuration keys matching the given prefix. +// +// Parameters: +// - prefix: Key prefix to filter by. If empty, returns all keys. +// +// Returns a sorted slice of matching configuration keys. +func ConfigKeys(prefix string) []string { + return ConfigMock.Keys(prefix) +} diff --git a/plugins/pdk/go/host/nd_host_http.go b/plugins/pdk/go/host/nd_host_http.go new file mode 100644 index 000000000..d999d3718 --- /dev/null +++ b/plugins/pdk/go/host/nd_host_http.go @@ -0,0 +1,90 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the HTTP host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package host + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// HTTPRequest represents the HTTPRequest data structure. +// HTTPRequest represents an outbound HTTP request from a plugin. +type HTTPRequest struct { + Method string `json:"method"` + URL string `json:"url"` + Headers map[string]string `json:"headers"` + NoFollowRedirects bool `json:"noFollowRedirects"` + Body []byte `json:"body"` + TimeoutMs int32 `json:"timeoutMs"` +} + +// HTTPResponse represents the HTTPResponse data structure. +// HTTPResponse represents the response from an outbound HTTP request. +type HTTPResponse struct { + StatusCode int32 `json:"statusCode"` + Headers map[string]string `json:"headers"` + Body []byte `json:"body"` +} + +// http_send is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user http_send +func http_send(uint64) uint64 + +type hTTPSendRequest struct { + Request HTTPRequest `json:"request"` +} + +type hTTPSendResponse struct { + Result *HTTPResponse `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// HTTPSend calls the http_send host function. +// Send executes an HTTP request and returns the response. +// +// Parameters: +// - request: The HTTP request to execute, including method, URL, headers, body, and timeout +// +// Returns the HTTP response with status code, headers, and body. +// Network errors, timeouts, and permission failures are returned as Go errors. +// Successful HTTP calls (including 4xx/5xx status codes) return a non-nil response with nil error. +func HTTPSend(request HTTPRequest) (*HTTPResponse, error) { + // Marshal request to JSON + req := hTTPSendRequest{ + Request: request, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return nil, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := http_send(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response hTTPSendResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return nil, err + } + + // Convert Error field to Go error + if response.Error != "" { + return nil, errors.New(response.Error) + } + + return response.Result, nil +} diff --git a/plugins/pdk/go/host/nd_host_http_stub.go b/plugins/pdk/go/host/nd_host_http_stub.go new file mode 100644 index 000000000..2f15a91a9 --- /dev/null +++ b/plugins/pdk/go/host/nd_host_http_stub.go @@ -0,0 +1,58 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains mock implementations for non-WASM builds. +// These mocks allow IDE support, compilation, and unit testing on non-WASM platforms. +// Plugin authors can use the exported mock instances to set expectations in tests. +// +//go:build !wasip1 + +package host + +import "github.com/stretchr/testify/mock" + +// HTTPRequest represents the HTTPRequest data structure. +// HTTPRequest represents an outbound HTTP request from a plugin. +type HTTPRequest struct { + Method string `json:"method"` + URL string `json:"url"` + Headers map[string]string `json:"headers"` + NoFollowRedirects bool `json:"noFollowRedirects"` + Body []byte `json:"body"` + TimeoutMs int32 `json:"timeoutMs"` +} + +// HTTPResponse represents the HTTPResponse data structure. +// HTTPResponse represents the response from an outbound HTTP request. +type HTTPResponse struct { + StatusCode int32 `json:"statusCode"` + Headers map[string]string `json:"headers"` + Body []byte `json:"body"` +} + +// mockHTTPService is the mock implementation for testing. +type mockHTTPService struct { + mock.Mock +} + +// HTTPMock is the auto-instantiated mock instance for testing. +// Use this to set expectations: host.HTTPMock.On("MethodName", args...).Return(values...) +var HTTPMock = &mockHTTPService{} + +// Send is the mock method for HTTPSend. +func (m *mockHTTPService) Send(request HTTPRequest) (*HTTPResponse, error) { + args := m.Called(request) + return args.Get(0).(*HTTPResponse), args.Error(1) +} + +// HTTPSend delegates to the mock instance. +// Send executes an HTTP request and returns the response. +// +// Parameters: +// - request: The HTTP request to execute, including method, URL, headers, body, and timeout +// +// Returns the HTTP response with status code, headers, and body. +// Network errors, timeouts, and permission failures are returned as Go errors. +// Successful HTTP calls (including 4xx/5xx status codes) return a non-nil response with nil error. +func HTTPSend(request HTTPRequest) (*HTTPResponse, error) { + return HTTPMock.Send(request) +} diff --git a/plugins/pdk/go/host/nd_host_kvstore.go b/plugins/pdk/go/host/nd_host_kvstore.go new file mode 100644 index 000000000..15e1e366a --- /dev/null +++ b/plugins/pdk/go/host/nd_host_kvstore.go @@ -0,0 +1,481 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the KVStore host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package host + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// kvstore_set is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user kvstore_set +func kvstore_set(uint64) uint64 + +// kvstore_setwithttl is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user kvstore_setwithttl +func kvstore_setwithttl(uint64) uint64 + +// kvstore_get is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user kvstore_get +func kvstore_get(uint64) uint64 + +// kvstore_getmany is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user kvstore_getmany +func kvstore_getmany(uint64) uint64 + +// kvstore_has is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user kvstore_has +func kvstore_has(uint64) uint64 + +// kvstore_list is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user kvstore_list +func kvstore_list(uint64) uint64 + +// kvstore_delete is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user kvstore_delete +func kvstore_delete(uint64) uint64 + +// kvstore_deletebyprefix is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user kvstore_deletebyprefix +func kvstore_deletebyprefix(uint64) uint64 + +// kvstore_getstorageused is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user kvstore_getstorageused +func kvstore_getstorageused(uint64) uint64 + +type kVStoreSetRequest struct { + Key string `json:"key"` + Value []byte `json:"value"` +} + +type kVStoreSetWithTTLRequest struct { + Key string `json:"key"` + Value []byte `json:"value"` + TtlSeconds int64 `json:"ttlSeconds"` +} + +type kVStoreGetRequest struct { + Key string `json:"key"` +} + +type kVStoreGetResponse struct { + Value []byte `json:"value,omitempty"` + Exists bool `json:"exists,omitempty"` + Error string `json:"error,omitempty"` +} + +type kVStoreGetManyRequest struct { + Keys []string `json:"keys"` +} + +type kVStoreGetManyResponse struct { + Values map[string][]byte `json:"values,omitempty"` + Error string `json:"error,omitempty"` +} + +type kVStoreHasRequest struct { + Key string `json:"key"` +} + +type kVStoreHasResponse struct { + Exists bool `json:"exists,omitempty"` + Error string `json:"error,omitempty"` +} + +type kVStoreListRequest struct { + Prefix string `json:"prefix"` +} + +type kVStoreListResponse struct { + Keys []string `json:"keys,omitempty"` + Error string `json:"error,omitempty"` +} + +type kVStoreDeleteRequest struct { + Key string `json:"key"` +} + +type kVStoreDeleteByPrefixRequest struct { + Prefix string `json:"prefix"` +} + +type kVStoreDeleteByPrefixResponse struct { + DeletedCount int64 `json:"deletedCount,omitempty"` + Error string `json:"error,omitempty"` +} + +type kVStoreGetStorageUsedResponse struct { + Bytes int64 `json:"bytes,omitempty"` + Error string `json:"error,omitempty"` +} + +// KVStoreSet calls the kvstore_set host function. +// Set stores a byte value with the given key. +// +// Parameters: +// - key: The storage key (max 256 bytes, UTF-8) +// - value: The byte slice to store +// +// Returns an error if the storage limit would be exceeded or the operation fails. +func KVStoreSet(key string, value []byte) error { + // Marshal request to JSON + req := kVStoreSetRequest{ + Key: key, + Value: value, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := kvstore_set(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} + +// KVStoreSetWithTTL calls the kvstore_setwithttl host function. +// SetWithTTL stores a byte value with the given key and a time-to-live. +// +// After ttlSeconds, the key is treated as non-existent and will be +// cleaned up lazily. ttlSeconds must be greater than 0. +// +// Parameters: +// - key: The storage key (max 256 bytes, UTF-8) +// - value: The byte slice to store +// - ttlSeconds: Time-to-live in seconds (must be > 0) +// +// Returns an error if the storage limit would be exceeded or the operation fails. +func KVStoreSetWithTTL(key string, value []byte, ttlSeconds int64) error { + // Marshal request to JSON + req := kVStoreSetWithTTLRequest{ + Key: key, + Value: value, + TtlSeconds: ttlSeconds, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := kvstore_setwithttl(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} + +// KVStoreGet calls the kvstore_get host function. +// Get retrieves a byte value from storage. +// +// Parameters: +// - key: The storage key +// +// Returns the value and whether the key exists. +func KVStoreGet(key string) ([]byte, bool, error) { + // Marshal request to JSON + req := kVStoreGetRequest{ + Key: key, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return nil, false, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := kvstore_get(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response kVStoreGetResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return nil, false, err + } + + // Convert Error field to Go error + if response.Error != "" { + return nil, false, errors.New(response.Error) + } + + return response.Value, response.Exists, nil +} + +// KVStoreGetMany calls the kvstore_getmany host function. +// GetMany retrieves multiple values in a single call. +// +// Parameters: +// - keys: The storage keys to retrieve +// +// Returns a map of key to value for keys that exist and have not expired. +// Missing or expired keys are omitted from the result. +func KVStoreGetMany(keys []string) (map[string][]byte, error) { + // Marshal request to JSON + req := kVStoreGetManyRequest{ + Keys: keys, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return nil, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := kvstore_getmany(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response kVStoreGetManyResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return nil, err + } + + // Convert Error field to Go error + if response.Error != "" { + return nil, errors.New(response.Error) + } + + return response.Values, nil +} + +// KVStoreHas calls the kvstore_has host function. +// Has checks if a key exists in storage. +// +// Parameters: +// - key: The storage key +// +// Returns true if the key exists. +func KVStoreHas(key string) (bool, error) { + // Marshal request to JSON + req := kVStoreHasRequest{ + Key: key, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return false, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := kvstore_has(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response kVStoreHasResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return false, err + } + + // Convert Error field to Go error + if response.Error != "" { + return false, errors.New(response.Error) + } + + return response.Exists, nil +} + +// KVStoreList calls the kvstore_list host function. +// List returns all keys matching the given prefix. +// +// Parameters: +// - prefix: Key prefix to filter by (empty string returns all keys) +// +// Returns a slice of matching keys. +func KVStoreList(prefix string) ([]string, error) { + // Marshal request to JSON + req := kVStoreListRequest{ + Prefix: prefix, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return nil, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := kvstore_list(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response kVStoreListResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return nil, err + } + + // Convert Error field to Go error + if response.Error != "" { + return nil, errors.New(response.Error) + } + + return response.Keys, nil +} + +// KVStoreDelete calls the kvstore_delete host function. +// Delete removes a value from storage. +// +// Parameters: +// - key: The storage key +// +// Returns an error if the operation fails. Does not return an error if the key doesn't exist. +func KVStoreDelete(key string) error { + // Marshal request to JSON + req := kVStoreDeleteRequest{ + Key: key, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := kvstore_delete(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} + +// KVStoreDeleteByPrefix calls the kvstore_deletebyprefix host function. +// DeleteByPrefix removes all keys matching the given prefix. +// +// Parameters: +// - prefix: Key prefix to match (must not be empty) +// +// Returns the number of keys deleted. Includes expired keys. +func KVStoreDeleteByPrefix(prefix string) (int64, error) { + // Marshal request to JSON + req := kVStoreDeleteByPrefixRequest{ + Prefix: prefix, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return 0, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := kvstore_deletebyprefix(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response kVStoreDeleteByPrefixResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return 0, err + } + + // Convert Error field to Go error + if response.Error != "" { + return 0, errors.New(response.Error) + } + + return response.DeletedCount, nil +} + +// KVStoreGetStorageUsed calls the kvstore_getstorageused host function. +// GetStorageUsed returns the total storage used by this plugin in bytes. +func KVStoreGetStorageUsed() (int64, error) { + // No parameters - allocate empty JSON object + reqMem := pdk.AllocateBytes([]byte("{}")) + defer reqMem.Free() + + // Call the host function + responsePtr := kvstore_getstorageused(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response kVStoreGetStorageUsedResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return 0, err + } + + // Convert Error field to Go error + if response.Error != "" { + return 0, errors.New(response.Error) + } + + return response.Bytes, nil +} diff --git a/plugins/pdk/go/host/nd_host_kvstore_stub.go b/plugins/pdk/go/host/nd_host_kvstore_stub.go new file mode 100644 index 000000000..83b55d3a8 --- /dev/null +++ b/plugins/pdk/go/host/nd_host_kvstore_stub.go @@ -0,0 +1,175 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains mock implementations for non-WASM builds. +// These mocks allow IDE support, compilation, and unit testing on non-WASM platforms. +// Plugin authors can use the exported mock instances to set expectations in tests. +// +//go:build !wasip1 + +package host + +import "github.com/stretchr/testify/mock" + +// mockKVStoreService is the mock implementation for testing. +type mockKVStoreService struct { + mock.Mock +} + +// KVStoreMock is the auto-instantiated mock instance for testing. +// Use this to set expectations: host.KVStoreMock.On("MethodName", args...).Return(values...) +var KVStoreMock = &mockKVStoreService{} + +// Set is the mock method for KVStoreSet. +func (m *mockKVStoreService) Set(key string, value []byte) error { + args := m.Called(key, value) + return args.Error(0) +} + +// KVStoreSet delegates to the mock instance. +// Set stores a byte value with the given key. +// +// Parameters: +// - key: The storage key (max 256 bytes, UTF-8) +// - value: The byte slice to store +// +// Returns an error if the storage limit would be exceeded or the operation fails. +func KVStoreSet(key string, value []byte) error { + return KVStoreMock.Set(key, value) +} + +// SetWithTTL is the mock method for KVStoreSetWithTTL. +func (m *mockKVStoreService) SetWithTTL(key string, value []byte, ttlSeconds int64) error { + args := m.Called(key, value, ttlSeconds) + return args.Error(0) +} + +// KVStoreSetWithTTL delegates to the mock instance. +// SetWithTTL stores a byte value with the given key and a time-to-live. +// +// After ttlSeconds, the key is treated as non-existent and will be +// cleaned up lazily. ttlSeconds must be greater than 0. +// +// Parameters: +// - key: The storage key (max 256 bytes, UTF-8) +// - value: The byte slice to store +// - ttlSeconds: Time-to-live in seconds (must be > 0) +// +// Returns an error if the storage limit would be exceeded or the operation fails. +func KVStoreSetWithTTL(key string, value []byte, ttlSeconds int64) error { + return KVStoreMock.SetWithTTL(key, value, ttlSeconds) +} + +// Get is the mock method for KVStoreGet. +func (m *mockKVStoreService) Get(key string) ([]byte, bool, error) { + args := m.Called(key) + return args.Get(0).([]byte), args.Bool(1), args.Error(2) +} + +// KVStoreGet delegates to the mock instance. +// Get retrieves a byte value from storage. +// +// Parameters: +// - key: The storage key +// +// Returns the value and whether the key exists. +func KVStoreGet(key string) ([]byte, bool, error) { + return KVStoreMock.Get(key) +} + +// GetMany is the mock method for KVStoreGetMany. +func (m *mockKVStoreService) GetMany(keys []string) (map[string][]byte, error) { + args := m.Called(keys) + return args.Get(0).(map[string][]byte), args.Error(1) +} + +// KVStoreGetMany delegates to the mock instance. +// GetMany retrieves multiple values in a single call. +// +// Parameters: +// - keys: The storage keys to retrieve +// +// Returns a map of key to value for keys that exist and have not expired. +// Missing or expired keys are omitted from the result. +func KVStoreGetMany(keys []string) (map[string][]byte, error) { + return KVStoreMock.GetMany(keys) +} + +// Has is the mock method for KVStoreHas. +func (m *mockKVStoreService) Has(key string) (bool, error) { + args := m.Called(key) + return args.Bool(0), args.Error(1) +} + +// KVStoreHas delegates to the mock instance. +// Has checks if a key exists in storage. +// +// Parameters: +// - key: The storage key +// +// Returns true if the key exists. +func KVStoreHas(key string) (bool, error) { + return KVStoreMock.Has(key) +} + +// List is the mock method for KVStoreList. +func (m *mockKVStoreService) List(prefix string) ([]string, error) { + args := m.Called(prefix) + return args.Get(0).([]string), args.Error(1) +} + +// KVStoreList delegates to the mock instance. +// List returns all keys matching the given prefix. +// +// Parameters: +// - prefix: Key prefix to filter by (empty string returns all keys) +// +// Returns a slice of matching keys. +func KVStoreList(prefix string) ([]string, error) { + return KVStoreMock.List(prefix) +} + +// Delete is the mock method for KVStoreDelete. +func (m *mockKVStoreService) Delete(key string) error { + args := m.Called(key) + return args.Error(0) +} + +// KVStoreDelete delegates to the mock instance. +// Delete removes a value from storage. +// +// Parameters: +// - key: The storage key +// +// Returns an error if the operation fails. Does not return an error if the key doesn't exist. +func KVStoreDelete(key string) error { + return KVStoreMock.Delete(key) +} + +// DeleteByPrefix is the mock method for KVStoreDeleteByPrefix. +func (m *mockKVStoreService) DeleteByPrefix(prefix string) (int64, error) { + args := m.Called(prefix) + return args.Get(0).(int64), args.Error(1) +} + +// KVStoreDeleteByPrefix delegates to the mock instance. +// DeleteByPrefix removes all keys matching the given prefix. +// +// Parameters: +// - prefix: Key prefix to match (must not be empty) +// +// Returns the number of keys deleted. Includes expired keys. +func KVStoreDeleteByPrefix(prefix string) (int64, error) { + return KVStoreMock.DeleteByPrefix(prefix) +} + +// GetStorageUsed is the mock method for KVStoreGetStorageUsed. +func (m *mockKVStoreService) GetStorageUsed() (int64, error) { + args := m.Called() + return args.Get(0).(int64), args.Error(1) +} + +// KVStoreGetStorageUsed delegates to the mock instance. +// GetStorageUsed returns the total storage used by this plugin in bytes. +func KVStoreGetStorageUsed() (int64, error) { + return KVStoreMock.GetStorageUsed() +} diff --git a/plugins/pdk/go/host/nd_host_library.go b/plugins/pdk/go/host/nd_host_library.go new file mode 100644 index 000000000..0107d1afe --- /dev/null +++ b/plugins/pdk/go/host/nd_host_library.go @@ -0,0 +1,124 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Library host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package host + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// Library represents the Library data structure. +// Library represents a music library with metadata. +type Library struct { + ID int32 `json:"id"` + Name string `json:"name"` + Path string `json:"path"` + MountPoint string `json:"mountPoint"` + LastScanAt int64 `json:"lastScanAt"` + TotalSongs int32 `json:"totalSongs"` + TotalAlbums int32 `json:"totalAlbums"` + TotalArtists int32 `json:"totalArtists"` + TotalSize int64 `json:"totalSize"` + TotalDuration float64 `json:"totalDuration"` +} + +// library_getlibrary is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user library_getlibrary +func library_getlibrary(uint64) uint64 + +// library_getalllibraries is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user library_getalllibraries +func library_getalllibraries(uint64) uint64 + +type libraryGetLibraryRequest struct { + Id int32 `json:"id"` +} + +type libraryGetLibraryResponse struct { + Result *Library `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +type libraryGetAllLibrariesResponse struct { + Result []Library `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// LibraryGetLibrary calls the library_getlibrary host function. +// GetLibrary retrieves metadata for a specific library by ID. +// +// Parameters: +// - id: The library's unique identifier +// +// Returns the library metadata, or an error if the library is not found. +func LibraryGetLibrary(id int32) (*Library, error) { + // Marshal request to JSON + req := libraryGetLibraryRequest{ + Id: id, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return nil, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := library_getlibrary(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response libraryGetLibraryResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return nil, err + } + + // Convert Error field to Go error + if response.Error != "" { + return nil, errors.New(response.Error) + } + + return response.Result, nil +} + +// LibraryGetAllLibraries calls the library_getalllibraries host function. +// GetAllLibraries retrieves metadata for all configured libraries. +// +// Returns a slice of all libraries with their metadata. +func LibraryGetAllLibraries() ([]Library, error) { + // No parameters - allocate empty JSON object + reqMem := pdk.AllocateBytes([]byte("{}")) + defer reqMem.Free() + + // Call the host function + responsePtr := library_getalllibraries(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response libraryGetAllLibrariesResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return nil, err + } + + // Convert Error field to Go error + if response.Error != "" { + return nil, errors.New(response.Error) + } + + return response.Result, nil +} diff --git a/plugins/pdk/go/host/nd_host_library_stub.go b/plugins/pdk/go/host/nd_host_library_stub.go new file mode 100644 index 000000000..9ad0d97e7 --- /dev/null +++ b/plugins/pdk/go/host/nd_host_library_stub.go @@ -0,0 +1,66 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains mock implementations for non-WASM builds. +// These mocks allow IDE support, compilation, and unit testing on non-WASM platforms. +// Plugin authors can use the exported mock instances to set expectations in tests. +// +//go:build !wasip1 + +package host + +import "github.com/stretchr/testify/mock" + +// Library represents the Library data structure. +// Library represents a music library with metadata. +type Library struct { + ID int32 `json:"id"` + Name string `json:"name"` + Path string `json:"path"` + MountPoint string `json:"mountPoint"` + LastScanAt int64 `json:"lastScanAt"` + TotalSongs int32 `json:"totalSongs"` + TotalAlbums int32 `json:"totalAlbums"` + TotalArtists int32 `json:"totalArtists"` + TotalSize int64 `json:"totalSize"` + TotalDuration float64 `json:"totalDuration"` +} + +// mockLibraryService is the mock implementation for testing. +type mockLibraryService struct { + mock.Mock +} + +// LibraryMock is the auto-instantiated mock instance for testing. +// Use this to set expectations: host.LibraryMock.On("MethodName", args...).Return(values...) +var LibraryMock = &mockLibraryService{} + +// GetLibrary is the mock method for LibraryGetLibrary. +func (m *mockLibraryService) GetLibrary(id int32) (*Library, error) { + args := m.Called(id) + return args.Get(0).(*Library), args.Error(1) +} + +// LibraryGetLibrary delegates to the mock instance. +// GetLibrary retrieves metadata for a specific library by ID. +// +// Parameters: +// - id: The library's unique identifier +// +// Returns the library metadata, or an error if the library is not found. +func LibraryGetLibrary(id int32) (*Library, error) { + return LibraryMock.GetLibrary(id) +} + +// GetAllLibraries is the mock method for LibraryGetAllLibraries. +func (m *mockLibraryService) GetAllLibraries() ([]Library, error) { + args := m.Called() + return args.Get(0).([]Library), args.Error(1) +} + +// LibraryGetAllLibraries delegates to the mock instance. +// GetAllLibraries retrieves metadata for all configured libraries. +// +// Returns a slice of all libraries with their metadata. +func LibraryGetAllLibraries() ([]Library, error) { + return LibraryMock.GetAllLibraries() +} diff --git a/plugins/pdk/go/host/nd_host_scheduler.go b/plugins/pdk/go/host/nd_host_scheduler.go new file mode 100644 index 000000000..0159533ce --- /dev/null +++ b/plugins/pdk/go/host/nd_host_scheduler.go @@ -0,0 +1,185 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Scheduler host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package host + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// scheduler_scheduleonetime is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user scheduler_scheduleonetime +func scheduler_scheduleonetime(uint64) uint64 + +// scheduler_schedulerecurring is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user scheduler_schedulerecurring +func scheduler_schedulerecurring(uint64) uint64 + +// scheduler_cancelschedule is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user scheduler_cancelschedule +func scheduler_cancelschedule(uint64) uint64 + +type schedulerScheduleOneTimeRequest struct { + DelaySeconds int32 `json:"delaySeconds"` + Payload string `json:"payload"` + ScheduleID string `json:"scheduleId"` +} + +type schedulerScheduleOneTimeResponse struct { + NewScheduleID string `json:"newScheduleId,omitempty"` + Error string `json:"error,omitempty"` +} + +type schedulerScheduleRecurringRequest struct { + CronExpression string `json:"cronExpression"` + Payload string `json:"payload"` + ScheduleID string `json:"scheduleId"` +} + +type schedulerScheduleRecurringResponse struct { + NewScheduleID string `json:"newScheduleId,omitempty"` + Error string `json:"error,omitempty"` +} + +type schedulerCancelScheduleRequest struct { + ScheduleID string `json:"scheduleId"` +} + +// SchedulerScheduleOneTime calls the scheduler_scheduleonetime host function. +// ScheduleOneTime schedules a one-time event to be triggered after the specified delay. +// Plugins that use this function must also implement the SchedulerCallback capability +// +// Parameters: +// - delaySeconds: Number of seconds to wait before triggering the event +// - payload: Data to be passed to the scheduled event handler +// - scheduleID: Optional unique identifier for the scheduled job. If empty, one will be generated +// +// Returns the schedule ID that can be used to cancel the job, or an error if scheduling fails. +func SchedulerScheduleOneTime(delaySeconds int32, payload string, scheduleID string) (string, error) { + // Marshal request to JSON + req := schedulerScheduleOneTimeRequest{ + DelaySeconds: delaySeconds, + Payload: payload, + ScheduleID: scheduleID, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return "", err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := scheduler_scheduleonetime(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response schedulerScheduleOneTimeResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return "", err + } + + // Convert Error field to Go error + if response.Error != "" { + return "", errors.New(response.Error) + } + + return response.NewScheduleID, nil +} + +// SchedulerScheduleRecurring calls the scheduler_schedulerecurring host function. +// ScheduleRecurring schedules a recurring event using a cron expression. +// Plugins that use this function must also implement the SchedulerCallback capability +// +// Parameters: +// - cronExpression: Standard cron format expression (e.g., "0 0 * * *" for daily at midnight) +// - payload: Data to be passed to each scheduled event handler invocation +// - scheduleID: Optional unique identifier for the scheduled job. If empty, one will be generated +// +// Returns the schedule ID that can be used to cancel the job, or an error if scheduling fails. +func SchedulerScheduleRecurring(cronExpression string, payload string, scheduleID string) (string, error) { + // Marshal request to JSON + req := schedulerScheduleRecurringRequest{ + CronExpression: cronExpression, + Payload: payload, + ScheduleID: scheduleID, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return "", err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := scheduler_schedulerecurring(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response schedulerScheduleRecurringResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return "", err + } + + // Convert Error field to Go error + if response.Error != "" { + return "", errors.New(response.Error) + } + + return response.NewScheduleID, nil +} + +// SchedulerCancelSchedule calls the scheduler_cancelschedule host function. +// CancelSchedule cancels a scheduled job identified by its schedule ID. +// +// This works for both one-time and recurring schedules. Once cancelled, the job will not trigger +// any future events. +// +// Returns an error if the schedule ID is not found or if cancellation fails. +func SchedulerCancelSchedule(scheduleID string) error { + // Marshal request to JSON + req := schedulerCancelScheduleRequest{ + ScheduleID: scheduleID, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := scheduler_cancelschedule(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} diff --git a/plugins/pdk/go/host/nd_host_scheduler_stub.go b/plugins/pdk/go/host/nd_host_scheduler_stub.go new file mode 100644 index 000000000..3eaa0087a --- /dev/null +++ b/plugins/pdk/go/host/nd_host_scheduler_stub.go @@ -0,0 +1,77 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains mock implementations for non-WASM builds. +// These mocks allow IDE support, compilation, and unit testing on non-WASM platforms. +// Plugin authors can use the exported mock instances to set expectations in tests. +// +//go:build !wasip1 + +package host + +import "github.com/stretchr/testify/mock" + +// mockSchedulerService is the mock implementation for testing. +type mockSchedulerService struct { + mock.Mock +} + +// SchedulerMock is the auto-instantiated mock instance for testing. +// Use this to set expectations: host.SchedulerMock.On("MethodName", args...).Return(values...) +var SchedulerMock = &mockSchedulerService{} + +// ScheduleOneTime is the mock method for SchedulerScheduleOneTime. +func (m *mockSchedulerService) ScheduleOneTime(delaySeconds int32, payload string, scheduleID string) (string, error) { + args := m.Called(delaySeconds, payload, scheduleID) + return args.String(0), args.Error(1) +} + +// SchedulerScheduleOneTime delegates to the mock instance. +// ScheduleOneTime schedules a one-time event to be triggered after the specified delay. +// Plugins that use this function must also implement the SchedulerCallback capability +// +// Parameters: +// - delaySeconds: Number of seconds to wait before triggering the event +// - payload: Data to be passed to the scheduled event handler +// - scheduleID: Optional unique identifier for the scheduled job. If empty, one will be generated +// +// Returns the schedule ID that can be used to cancel the job, or an error if scheduling fails. +func SchedulerScheduleOneTime(delaySeconds int32, payload string, scheduleID string) (string, error) { + return SchedulerMock.ScheduleOneTime(delaySeconds, payload, scheduleID) +} + +// ScheduleRecurring is the mock method for SchedulerScheduleRecurring. +func (m *mockSchedulerService) ScheduleRecurring(cronExpression string, payload string, scheduleID string) (string, error) { + args := m.Called(cronExpression, payload, scheduleID) + return args.String(0), args.Error(1) +} + +// SchedulerScheduleRecurring delegates to the mock instance. +// ScheduleRecurring schedules a recurring event using a cron expression. +// Plugins that use this function must also implement the SchedulerCallback capability +// +// Parameters: +// - cronExpression: Standard cron format expression (e.g., "0 0 * * *" for daily at midnight) +// - payload: Data to be passed to each scheduled event handler invocation +// - scheduleID: Optional unique identifier for the scheduled job. If empty, one will be generated +// +// Returns the schedule ID that can be used to cancel the job, or an error if scheduling fails. +func SchedulerScheduleRecurring(cronExpression string, payload string, scheduleID string) (string, error) { + return SchedulerMock.ScheduleRecurring(cronExpression, payload, scheduleID) +} + +// CancelSchedule is the mock method for SchedulerCancelSchedule. +func (m *mockSchedulerService) CancelSchedule(scheduleID string) error { + args := m.Called(scheduleID) + return args.Error(0) +} + +// SchedulerCancelSchedule delegates to the mock instance. +// CancelSchedule cancels a scheduled job identified by its schedule ID. +// +// This works for both one-time and recurring schedules. Once cancelled, the job will not trigger +// any future events. +// +// Returns an error if the schedule ID is not found or if cancellation fails. +func SchedulerCancelSchedule(scheduleID string) error { + return SchedulerMock.CancelSchedule(scheduleID) +} diff --git a/plugins/pdk/go/host/nd_host_subsonicapi.go b/plugins/pdk/go/host/nd_host_subsonicapi.go new file mode 100644 index 000000000..e6e56ce6b --- /dev/null +++ b/plugins/pdk/go/host/nd_host_subsonicapi.go @@ -0,0 +1,119 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the SubsonicAPI host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package host + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// subsonicapi_call is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user subsonicapi_call +func subsonicapi_call(uint64) uint64 + +// subsonicapi_callraw is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user subsonicapi_callraw +func subsonicapi_callraw(uint64) uint64 + +type subsonicAPICallRequest struct { + Uri string `json:"uri"` +} + +type subsonicAPICallResponse struct { + ResponseJSON string `json:"responseJson,omitempty"` + Error string `json:"error,omitempty"` +} + +type subsonicAPICallRawRequest struct { + Uri string `json:"uri"` +} + +type subsonicAPICallRawResponse struct { + ContentType string `json:"contentType,omitempty"` + Data []byte `json:"data,omitempty"` + Error string `json:"error,omitempty"` +} + +// SubsonicAPICall calls the subsonicapi_call host function. +// Call executes a Subsonic API request and returns the JSON response. +// +// The uri parameter should be the Subsonic API path without the server prefix, +// e.g., "getAlbumList2?type=random&size=10". The response is returned as raw JSON. +func SubsonicAPICall(uri string) (string, error) { + // Marshal request to JSON + req := subsonicAPICallRequest{ + Uri: uri, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return "", err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := subsonicapi_call(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response subsonicAPICallResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return "", err + } + + // Convert Error field to Go error + if response.Error != "" { + return "", errors.New(response.Error) + } + + return response.ResponseJSON, nil +} + +// SubsonicAPICallRaw calls the subsonicapi_callraw host function. +// CallRaw executes a Subsonic API request and returns the raw binary response. +// Designed for binary endpoints like getCoverArt and stream that return +// non-JSON data. The data is base64-encoded over JSON on the wire. +func SubsonicAPICallRaw(uri string) (string, []byte, error) { + // Marshal request to JSON + req := subsonicAPICallRawRequest{ + Uri: uri, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return "", nil, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := subsonicapi_callraw(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response subsonicAPICallRawResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return "", nil, err + } + + // Convert Error field to Go error + if response.Error != "" { + return "", nil, errors.New(response.Error) + } + + return response.ContentType, response.Data, nil +} diff --git a/plugins/pdk/go/host/nd_host_subsonicapi_stub.go b/plugins/pdk/go/host/nd_host_subsonicapi_stub.go new file mode 100644 index 000000000..2fdaf2403 --- /dev/null +++ b/plugins/pdk/go/host/nd_host_subsonicapi_stub.go @@ -0,0 +1,49 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains mock implementations for non-WASM builds. +// These mocks allow IDE support, compilation, and unit testing on non-WASM platforms. +// Plugin authors can use the exported mock instances to set expectations in tests. +// +//go:build !wasip1 + +package host + +import "github.com/stretchr/testify/mock" + +// mockSubsonicAPIService is the mock implementation for testing. +type mockSubsonicAPIService struct { + mock.Mock +} + +// SubsonicAPIMock is the auto-instantiated mock instance for testing. +// Use this to set expectations: host.SubsonicAPIMock.On("MethodName", args...).Return(values...) +var SubsonicAPIMock = &mockSubsonicAPIService{} + +// Call is the mock method for SubsonicAPICall. +func (m *mockSubsonicAPIService) Call(uri string) (string, error) { + args := m.Called(uri) + return args.String(0), args.Error(1) +} + +// SubsonicAPICall delegates to the mock instance. +// Call executes a Subsonic API request and returns the JSON response. +// +// The uri parameter should be the Subsonic API path without the server prefix, +// e.g., "getAlbumList2?type=random&size=10". The response is returned as raw JSON. +func SubsonicAPICall(uri string) (string, error) { + return SubsonicAPIMock.Call(uri) +} + +// CallRaw is the mock method for SubsonicAPICallRaw. +func (m *mockSubsonicAPIService) CallRaw(uri string) (string, []byte, error) { + args := m.Called(uri) + return args.String(0), args.Get(1).([]byte), args.Error(2) +} + +// SubsonicAPICallRaw delegates to the mock instance. +// CallRaw executes a Subsonic API request and returns the raw binary response. +// Designed for binary endpoints like getCoverArt and stream that return +// non-JSON data. The data is base64-encoded over JSON on the wire. +func SubsonicAPICallRaw(uri string) (string, []byte, error) { + return SubsonicAPIMock.CallRaw(uri) +} diff --git a/plugins/pdk/go/host/nd_host_task.go b/plugins/pdk/go/host/nd_host_task.go new file mode 100644 index 000000000..92a41c5bc --- /dev/null +++ b/plugins/pdk/go/host/nd_host_task.go @@ -0,0 +1,277 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Task host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package host + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// QueueConfig represents the QueueConfig data structure. +// QueueConfig holds configuration for a task queue. +type QueueConfig struct { + Concurrency int32 `json:"concurrency"` + MaxRetries int32 `json:"maxRetries"` + BackoffMs int64 `json:"backoffMs"` + DelayMs int64 `json:"delayMs"` + RetentionMs int64 `json:"retentionMs"` +} + +// TaskInfo represents the TaskInfo data structure. +// TaskInfo holds the current state of a task. +type TaskInfo struct { + Status string `json:"status"` + Message string `json:"message"` + Attempt int32 `json:"attempt"` +} + +// task_createqueue is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user task_createqueue +func task_createqueue(uint64) uint64 + +// task_enqueue is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user task_enqueue +func task_enqueue(uint64) uint64 + +// task_get is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user task_get +func task_get(uint64) uint64 + +// task_cancel is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user task_cancel +func task_cancel(uint64) uint64 + +// task_clearqueue is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user task_clearqueue +func task_clearqueue(uint64) uint64 + +type taskCreateQueueRequest struct { + Name string `json:"name"` + Config QueueConfig `json:"config"` +} + +type taskEnqueueRequest struct { + QueueName string `json:"queueName"` + Payload []byte `json:"payload"` +} + +type taskEnqueueResponse struct { + Result string `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +type taskGetRequest struct { + TaskID string `json:"taskId"` +} + +type taskGetResponse struct { + Result *TaskInfo `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +type taskCancelRequest struct { + TaskID string `json:"taskId"` +} + +type taskClearQueueRequest struct { + QueueName string `json:"queueName"` +} + +type taskClearQueueResponse struct { + Result int64 `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// TaskCreateQueue calls the task_createqueue host function. +// CreateQueue creates a named task queue with the given configuration. +// Zero-value fields in config use sensible defaults. +// If a queue with the same name already exists, returns an error. +// On startup, this also recovers any stale "running" tasks from a previous crash. +func TaskCreateQueue(name string, config QueueConfig) error { + // Marshal request to JSON + req := taskCreateQueueRequest{ + Name: name, + Config: config, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := task_createqueue(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} + +// TaskEnqueue calls the task_enqueue host function. +// Enqueue adds a task to the named queue. Returns the task ID. +// payload is opaque bytes passed back to the plugin on execution. +func TaskEnqueue(queueName string, payload []byte) (string, error) { + // Marshal request to JSON + req := taskEnqueueRequest{ + QueueName: queueName, + Payload: payload, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return "", err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := task_enqueue(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response taskEnqueueResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return "", err + } + + // Convert Error field to Go error + if response.Error != "" { + return "", errors.New(response.Error) + } + + return response.Result, nil +} + +// TaskGet calls the task_get host function. +// Get returns the current state of a task including its status, +// message, and attempt count. +func TaskGet(taskID string) (*TaskInfo, error) { + // Marshal request to JSON + req := taskGetRequest{ + TaskID: taskID, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return nil, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := task_get(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response taskGetResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return nil, err + } + + // Convert Error field to Go error + if response.Error != "" { + return nil, errors.New(response.Error) + } + + return response.Result, nil +} + +// TaskCancel calls the task_cancel host function. +// Cancel cancels a pending task. Returns error if already +// running, completed, or failed. +func TaskCancel(taskID string) error { + // Marshal request to JSON + req := taskCancelRequest{ + TaskID: taskID, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := task_cancel(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} + +// TaskClearQueue calls the task_clearqueue host function. +// ClearQueue removes all pending tasks from the named queue. +// Running tasks are not affected. Returns the number of tasks removed. +func TaskClearQueue(queueName string) (int64, error) { + // Marshal request to JSON + req := taskClearQueueRequest{ + QueueName: queueName, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return 0, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := task_clearqueue(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response taskClearQueueResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return 0, err + } + + // Convert Error field to Go error + if response.Error != "" { + return 0, errors.New(response.Error) + } + + return response.Result, nil +} diff --git a/plugins/pdk/go/host/nd_host_task_stub.go b/plugins/pdk/go/host/nd_host_task_stub.go new file mode 100644 index 000000000..4dde0e234 --- /dev/null +++ b/plugins/pdk/go/host/nd_host_task_stub.go @@ -0,0 +1,105 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains mock implementations for non-WASM builds. +// These mocks allow IDE support, compilation, and unit testing on non-WASM platforms. +// Plugin authors can use the exported mock instances to set expectations in tests. +// +//go:build !wasip1 + +package host + +import "github.com/stretchr/testify/mock" + +// QueueConfig represents the QueueConfig data structure. +// QueueConfig holds configuration for a task queue. +type QueueConfig struct { + Concurrency int32 `json:"concurrency"` + MaxRetries int32 `json:"maxRetries"` + BackoffMs int64 `json:"backoffMs"` + DelayMs int64 `json:"delayMs"` + RetentionMs int64 `json:"retentionMs"` +} + +// TaskInfo represents the TaskInfo data structure. +// TaskInfo holds the current state of a task. +type TaskInfo struct { + Status string `json:"status"` + Message string `json:"message"` + Attempt int32 `json:"attempt"` +} + +// mockTaskService is the mock implementation for testing. +type mockTaskService struct { + mock.Mock +} + +// TaskMock is the auto-instantiated mock instance for testing. +// Use this to set expectations: host.TaskMock.On("MethodName", args...).Return(values...) +var TaskMock = &mockTaskService{} + +// CreateQueue is the mock method for TaskCreateQueue. +func (m *mockTaskService) CreateQueue(name string, config QueueConfig) error { + args := m.Called(name, config) + return args.Error(0) +} + +// TaskCreateQueue delegates to the mock instance. +// CreateQueue creates a named task queue with the given configuration. +// Zero-value fields in config use sensible defaults. +// If a queue with the same name already exists, returns an error. +// On startup, this also recovers any stale "running" tasks from a previous crash. +func TaskCreateQueue(name string, config QueueConfig) error { + return TaskMock.CreateQueue(name, config) +} + +// Enqueue is the mock method for TaskEnqueue. +func (m *mockTaskService) Enqueue(queueName string, payload []byte) (string, error) { + args := m.Called(queueName, payload) + return args.String(0), args.Error(1) +} + +// TaskEnqueue delegates to the mock instance. +// Enqueue adds a task to the named queue. Returns the task ID. +// payload is opaque bytes passed back to the plugin on execution. +func TaskEnqueue(queueName string, payload []byte) (string, error) { + return TaskMock.Enqueue(queueName, payload) +} + +// Get is the mock method for TaskGet. +func (m *mockTaskService) Get(taskID string) (*TaskInfo, error) { + args := m.Called(taskID) + return args.Get(0).(*TaskInfo), args.Error(1) +} + +// TaskGet delegates to the mock instance. +// Get returns the current state of a task including its status, +// message, and attempt count. +func TaskGet(taskID string) (*TaskInfo, error) { + return TaskMock.Get(taskID) +} + +// Cancel is the mock method for TaskCancel. +func (m *mockTaskService) Cancel(taskID string) error { + args := m.Called(taskID) + return args.Error(0) +} + +// TaskCancel delegates to the mock instance. +// Cancel cancels a pending task. Returns error if already +// running, completed, or failed. +func TaskCancel(taskID string) error { + return TaskMock.Cancel(taskID) +} + +// ClearQueue is the mock method for TaskClearQueue. +func (m *mockTaskService) ClearQueue(queueName string) (int64, error) { + args := m.Called(queueName) + return args.Get(0).(int64), args.Error(1) +} + +// TaskClearQueue delegates to the mock instance. +// ClearQueue removes all pending tasks from the named queue. +// Running tasks are not affected. Returns the number of tasks removed. +func TaskClearQueue(queueName string) (int64, error) { + return TaskMock.ClearQueue(queueName) +} diff --git a/plugins/pdk/go/host/nd_host_users.go b/plugins/pdk/go/host/nd_host_users.go new file mode 100644 index 000000000..21b6ad0ed --- /dev/null +++ b/plugins/pdk/go/host/nd_host_users.go @@ -0,0 +1,107 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Users host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package host + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// User represents the User data structure. +// User represents a Navidrome user with minimal information exposed to plugins. +// Sensitive fields like password, email, and internal IDs are intentionally excluded. +type User struct { + UserName string `json:"userName"` + Name string `json:"name"` + IsAdmin bool `json:"isAdmin"` +} + +// users_getusers is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user users_getusers +func users_getusers(uint64) uint64 + +// users_getadmins is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user users_getadmins +func users_getadmins(uint64) uint64 + +type usersGetUsersResponse struct { + Result []User `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +type usersGetAdminsResponse struct { + Result []User `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// UsersGetUsers calls the users_getusers host function. +// GetUsers returns all users the plugin has been granted access to. +// Only minimal user information (userName, name, isAdmin) is returned. +// Sensitive fields like password and email are never exposed. +// +// Returns a slice of users the plugin can access, or an empty slice if none configured. +func UsersGetUsers() ([]User, error) { + // No parameters - allocate empty JSON object + reqMem := pdk.AllocateBytes([]byte("{}")) + defer reqMem.Free() + + // Call the host function + responsePtr := users_getusers(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response usersGetUsersResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return nil, err + } + + // Convert Error field to Go error + if response.Error != "" { + return nil, errors.New(response.Error) + } + + return response.Result, nil +} + +// UsersGetAdmins calls the users_getadmins host function. +// GetAdmins returns only admin users the plugin has been granted access to. +// This is a convenience method that filters GetUsers results to include only admins. +// +// Returns a slice of admin users the plugin can access, or an empty slice if none. +func UsersGetAdmins() ([]User, error) { + // No parameters - allocate empty JSON object + reqMem := pdk.AllocateBytes([]byte("{}")) + defer reqMem.Free() + + // Call the host function + responsePtr := users_getadmins(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response usersGetAdminsResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return nil, err + } + + // Convert Error field to Go error + if response.Error != "" { + return nil, errors.New(response.Error) + } + + return response.Result, nil +} diff --git a/plugins/pdk/go/host/nd_host_users_stub.go b/plugins/pdk/go/host/nd_host_users_stub.go new file mode 100644 index 000000000..f76854894 --- /dev/null +++ b/plugins/pdk/go/host/nd_host_users_stub.go @@ -0,0 +1,60 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains mock implementations for non-WASM builds. +// These mocks allow IDE support, compilation, and unit testing on non-WASM platforms. +// Plugin authors can use the exported mock instances to set expectations in tests. +// +//go:build !wasip1 + +package host + +import "github.com/stretchr/testify/mock" + +// User represents the User data structure. +// User represents a Navidrome user with minimal information exposed to plugins. +// Sensitive fields like password, email, and internal IDs are intentionally excluded. +type User struct { + UserName string `json:"userName"` + Name string `json:"name"` + IsAdmin bool `json:"isAdmin"` +} + +// mockUsersService is the mock implementation for testing. +type mockUsersService struct { + mock.Mock +} + +// UsersMock is the auto-instantiated mock instance for testing. +// Use this to set expectations: host.UsersMock.On("MethodName", args...).Return(values...) +var UsersMock = &mockUsersService{} + +// GetUsers is the mock method for UsersGetUsers. +func (m *mockUsersService) GetUsers() ([]User, error) { + args := m.Called() + return args.Get(0).([]User), args.Error(1) +} + +// UsersGetUsers delegates to the mock instance. +// GetUsers returns all users the plugin has been granted access to. +// Only minimal user information (userName, name, isAdmin) is returned. +// Sensitive fields like password and email are never exposed. +// +// Returns a slice of users the plugin can access, or an empty slice if none configured. +func UsersGetUsers() ([]User, error) { + return UsersMock.GetUsers() +} + +// GetAdmins is the mock method for UsersGetAdmins. +func (m *mockUsersService) GetAdmins() ([]User, error) { + args := m.Called() + return args.Get(0).([]User), args.Error(1) +} + +// UsersGetAdmins delegates to the mock instance. +// GetAdmins returns only admin users the plugin has been granted access to. +// This is a convenience method that filters GetUsers results to include only admins. +// +// Returns a slice of admin users the plugin can access, or an empty slice if none. +func UsersGetAdmins() ([]User, error) { + return UsersMock.GetAdmins() +} diff --git a/plugins/pdk/go/host/nd_host_websocket.go b/plugins/pdk/go/host/nd_host_websocket.go new file mode 100644 index 000000000..956f63c21 --- /dev/null +++ b/plugins/pdk/go/host/nd_host_websocket.go @@ -0,0 +1,235 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the WebSocket host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package host + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// websocket_connect is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user websocket_connect +func websocket_connect(uint64) uint64 + +// websocket_sendtext is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user websocket_sendtext +func websocket_sendtext(uint64) uint64 + +// websocket_sendbinary is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user websocket_sendbinary +func websocket_sendbinary(uint64) uint64 + +// websocket_closeconnection is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user websocket_closeconnection +func websocket_closeconnection(uint64) uint64 + +type webSocketConnectRequest struct { + Url string `json:"url"` + Headers map[string]string `json:"headers"` + ConnectionID string `json:"connectionId"` +} + +type webSocketConnectResponse struct { + NewConnectionID string `json:"newConnectionId,omitempty"` + Error string `json:"error,omitempty"` +} + +type webSocketSendTextRequest struct { + ConnectionID string `json:"connectionId"` + Message string `json:"message"` +} + +type webSocketSendBinaryRequest struct { + ConnectionID string `json:"connectionId"` + Data []byte `json:"data"` +} + +type webSocketCloseConnectionRequest struct { + ConnectionID string `json:"connectionId"` + Code int32 `json:"code"` + Reason string `json:"reason"` +} + +// WebSocketConnect calls the websocket_connect host function. +// Connect establishes a WebSocket connection to the specified URL. +// +// Plugins that use this function must also implement the WebSocketCallback capability +// to receive incoming messages and connection events. +// +// Parameters: +// - url: The WebSocket URL to connect to (ws:// or wss://) +// - headers: Optional HTTP headers to include in the handshake request +// - connectionID: Optional unique identifier for the connection. If empty, one will be generated +// +// Returns the connection ID that can be used to send messages or close the connection, +// or an error if the connection fails. +func WebSocketConnect(url string, headers map[string]string, connectionID string) (string, error) { + // Marshal request to JSON + req := webSocketConnectRequest{ + Url: url, + Headers: headers, + ConnectionID: connectionID, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return "", err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := websocket_connect(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response webSocketConnectResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return "", err + } + + // Convert Error field to Go error + if response.Error != "" { + return "", errors.New(response.Error) + } + + return response.NewConnectionID, nil +} + +// WebSocketSendText calls the websocket_sendtext host function. +// SendText sends a text message over an established WebSocket connection. +// +// Parameters: +// - connectionID: The connection identifier returned by Connect +// - message: The text message to send +// +// Returns an error if the connection is not found or if sending fails. +func WebSocketSendText(connectionID string, message string) error { + // Marshal request to JSON + req := webSocketSendTextRequest{ + ConnectionID: connectionID, + Message: message, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := websocket_sendtext(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} + +// WebSocketSendBinary calls the websocket_sendbinary host function. +// SendBinary sends binary data over an established WebSocket connection. +// +// Parameters: +// - connectionID: The connection identifier returned by Connect +// - data: The binary data to send +// +// Returns an error if the connection is not found or if sending fails. +func WebSocketSendBinary(connectionID string, data []byte) error { + // Marshal request to JSON + req := webSocketSendBinaryRequest{ + ConnectionID: connectionID, + Data: data, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := websocket_sendbinary(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} + +// WebSocketCloseConnection calls the websocket_closeconnection host function. +// CloseConnection gracefully closes a WebSocket connection. +// +// Parameters: +// - connectionID: The connection identifier returned by Connect +// - code: WebSocket close status code (e.g., 1000 for normal closure) +// - reason: Optional human-readable reason for closing +// +// Returns an error if the connection is not found or if closing fails. +func WebSocketCloseConnection(connectionID string, code int32, reason string) error { + // Marshal request to JSON + req := webSocketCloseConnectionRequest{ + ConnectionID: connectionID, + Code: code, + Reason: reason, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := websocket_closeconnection(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} diff --git a/plugins/pdk/go/host/nd_host_websocket_stub.go b/plugins/pdk/go/host/nd_host_websocket_stub.go new file mode 100644 index 000000000..23ac382f0 --- /dev/null +++ b/plugins/pdk/go/host/nd_host_websocket_stub.go @@ -0,0 +1,98 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains mock implementations for non-WASM builds. +// These mocks allow IDE support, compilation, and unit testing on non-WASM platforms. +// Plugin authors can use the exported mock instances to set expectations in tests. +// +//go:build !wasip1 + +package host + +import "github.com/stretchr/testify/mock" + +// mockWebSocketService is the mock implementation for testing. +type mockWebSocketService struct { + mock.Mock +} + +// WebSocketMock is the auto-instantiated mock instance for testing. +// Use this to set expectations: host.WebSocketMock.On("MethodName", args...).Return(values...) +var WebSocketMock = &mockWebSocketService{} + +// Connect is the mock method for WebSocketConnect. +func (m *mockWebSocketService) Connect(url string, headers map[string]string, connectionID string) (string, error) { + args := m.Called(url, headers, connectionID) + return args.String(0), args.Error(1) +} + +// WebSocketConnect delegates to the mock instance. +// Connect establishes a WebSocket connection to the specified URL. +// +// Plugins that use this function must also implement the WebSocketCallback capability +// to receive incoming messages and connection events. +// +// Parameters: +// - url: The WebSocket URL to connect to (ws:// or wss://) +// - headers: Optional HTTP headers to include in the handshake request +// - connectionID: Optional unique identifier for the connection. If empty, one will be generated +// +// Returns the connection ID that can be used to send messages or close the connection, +// or an error if the connection fails. +func WebSocketConnect(url string, headers map[string]string, connectionID string) (string, error) { + return WebSocketMock.Connect(url, headers, connectionID) +} + +// SendText is the mock method for WebSocketSendText. +func (m *mockWebSocketService) SendText(connectionID string, message string) error { + args := m.Called(connectionID, message) + return args.Error(0) +} + +// WebSocketSendText delegates to the mock instance. +// SendText sends a text message over an established WebSocket connection. +// +// Parameters: +// - connectionID: The connection identifier returned by Connect +// - message: The text message to send +// +// Returns an error if the connection is not found or if sending fails. +func WebSocketSendText(connectionID string, message string) error { + return WebSocketMock.SendText(connectionID, message) +} + +// SendBinary is the mock method for WebSocketSendBinary. +func (m *mockWebSocketService) SendBinary(connectionID string, data []byte) error { + args := m.Called(connectionID, data) + return args.Error(0) +} + +// WebSocketSendBinary delegates to the mock instance. +// SendBinary sends binary data over an established WebSocket connection. +// +// Parameters: +// - connectionID: The connection identifier returned by Connect +// - data: The binary data to send +// +// Returns an error if the connection is not found or if sending fails. +func WebSocketSendBinary(connectionID string, data []byte) error { + return WebSocketMock.SendBinary(connectionID, data) +} + +// CloseConnection is the mock method for WebSocketCloseConnection. +func (m *mockWebSocketService) CloseConnection(connectionID string, code int32, reason string) error { + args := m.Called(connectionID, code, reason) + return args.Error(0) +} + +// WebSocketCloseConnection delegates to the mock instance. +// CloseConnection gracefully closes a WebSocket connection. +// +// Parameters: +// - connectionID: The connection identifier returned by Connect +// - code: WebSocket close status code (e.g., 1000 for normal closure) +// - reason: Optional human-readable reason for closing +// +// Returns an error if the connection is not found or if closing fails. +func WebSocketCloseConnection(connectionID string, code int32, reason string) error { + return WebSocketMock.CloseConnection(connectionID, code, reason) +} diff --git a/plugins/pdk/go/lifecycle/lifecycle.go b/plugins/pdk/go/lifecycle/lifecycle.go new file mode 100644 index 000000000..93b5cf37b --- /dev/null +++ b/plugins/pdk/go/lifecycle/lifecycle.go @@ -0,0 +1,59 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the Lifecycle capability. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package lifecycle + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// Lifecycle is the marker interface for lifecycle plugins. +// Implement one or more of the provider interfaces below. +// Lifecycle provides plugin lifecycle hooks. +// This capability allows plugins to perform initialization when loaded, +// such as establishing connections, starting background processes, or +// validating configuration. +// +// The OnInit function is called once when the plugin is loaded, and is NOT +// called when the plugin is hot-reloaded. Plugins should not assume this +// function will be called on every startup. +type Lifecycle interface{} + +// InitProvider provides the OnInit function. +type InitProvider interface { + OnInit() error +} // Internal implementation holders +var ( + initImpl func() error +) + +// Register registers a lifecycle implementation. +// The implementation is checked for optional provider interfaces. +func Register(impl Lifecycle) { + if p, ok := impl.(InitProvider); ok { + initImpl = p.OnInit + } +} + +// NotImplementedCode is the standard return code for unimplemented functions. +// The host recognizes this and skips the plugin gracefully. +const NotImplementedCode int32 = -2 + +//go:wasmexport nd_on_init +func _NdOnInit() int32 { + if initImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + if err := initImpl(); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} diff --git a/plugins/pdk/go/lifecycle/lifecycle_stub.go b/plugins/pdk/go/lifecycle/lifecycle_stub.go new file mode 100644 index 000000000..8d392f6c6 --- /dev/null +++ b/plugins/pdk/go/lifecycle/lifecycle_stub.go @@ -0,0 +1,33 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file provides stub implementations for non-WASM platforms. +// It allows Go plugins to compile and run tests outside of WASM, +// but the actual functionality is only available in WASM builds. +// +//go:build !wasip1 + +package lifecycle + +// Lifecycle is the marker interface for lifecycle plugins. +// Implement one or more of the provider interfaces below. +// Lifecycle provides plugin lifecycle hooks. +// This capability allows plugins to perform initialization when loaded, +// such as establishing connections, starting background processes, or +// validating configuration. +// +// The OnInit function is called once when the plugin is loaded, and is NOT +// called when the plugin is hot-reloaded. Plugins should not assume this +// function will be called on every startup. +type Lifecycle interface{} + +// InitProvider provides the OnInit function. +type InitProvider interface { + OnInit() error +} + +// NotImplementedCode is the standard return code for unimplemented functions. +const NotImplementedCode int32 = -2 + +// Register is a no-op on non-WASM platforms. +// This stub allows code to compile outside of WASM. +func Register(_ Lifecycle) {} diff --git a/plugins/pdk/go/lyrics/lyrics.go b/plugins/pdk/go/lyrics/lyrics.go new file mode 100644 index 000000000..4f5aa6302 --- /dev/null +++ b/plugins/pdk/go/lyrics/lyrics.go @@ -0,0 +1,118 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the Lyrics capability. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package lyrics + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// ArtistRef is a reference to an artist with name and optional MBID. +type ArtistRef struct { + // ID is the internal Navidrome artist ID (if known). + ID string `json:"id,omitempty"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the artist. + MBID string `json:"mbid,omitempty"` +} + +// GetLyricsRequest contains the track information for lyrics lookup. +type GetLyricsRequest struct { + Track TrackInfo `json:"track"` +} + +// GetLyricsResponse contains the lyrics returned by the plugin. +type GetLyricsResponse struct { + Lyrics []LyricsText `json:"lyrics"` +} + +// LyricsText represents a single set of lyrics in raw text format. +// Text can be plain text or LRC format — Navidrome will parse it. +type LyricsText struct { + Lang string `json:"lang,omitempty"` + Text string `json:"text"` +} + +// TrackInfo contains track metadata. +type TrackInfo struct { + // ID is the internal Navidrome track ID. + ID string `json:"id"` + // Title is the track title. + Title string `json:"title"` + // Album is the album name. + Album string `json:"album"` + // Artist is the formatted artist name for display (e.g., "Artist1 • Artist2"). + Artist string `json:"artist"` + // AlbumArtist is the formatted album artist name for display. + AlbumArtist string `json:"albumArtist"` + // Artists is the list of track artists. + Artists []ArtistRef `json:"artists"` + // AlbumArtists is the list of album artists. + AlbumArtists []ArtistRef `json:"albumArtists"` + // Duration is the track duration in seconds. + Duration float32 `json:"duration"` + // TrackNumber is the track number on the album. + TrackNumber int32 `json:"trackNumber"` + // DiscNumber is the disc number. + DiscNumber int32 `json:"discNumber"` + // MBZRecordingID is the MusicBrainz recording ID. + MBZRecordingID string `json:"mbzRecordingId,omitempty"` + // MBZAlbumID is the MusicBrainz album/release ID. + MBZAlbumID string `json:"mbzAlbumId,omitempty"` + // MBZReleaseGroupID is the MusicBrainz release group ID. + MBZReleaseGroupID string `json:"mbzReleaseGroupId,omitempty"` + // MBZReleaseTrackID is the MusicBrainz release track ID. + MBZReleaseTrackID string `json:"mbzReleaseTrackId,omitempty"` +} + +// Lyrics requires all methods to be implemented. +// Lyrics provides lyrics for a given track from external sources. +type Lyrics interface { + // GetLyrics + GetLyrics(GetLyricsRequest) (GetLyricsResponse, error) +} // Internal implementation holders +var ( + lyricsImpl func(GetLyricsRequest) (GetLyricsResponse, error) +) + +// Register registers a lyrics implementation. +// All methods are required. +func Register(impl Lyrics) { + lyricsImpl = impl.GetLyrics +} + +// NotImplementedCode is the standard return code for unimplemented functions. +// The host recognizes this and skips the plugin gracefully. +const NotImplementedCode int32 = -2 + +//go:wasmexport nd_lyrics_get_lyrics +func _NdLyricsGetLyrics() int32 { + if lyricsImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input GetLyricsRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := lyricsImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} diff --git a/plugins/pdk/go/lyrics/lyrics_stub.go b/plugins/pdk/go/lyrics/lyrics_stub.go new file mode 100644 index 000000000..1fdf184e5 --- /dev/null +++ b/plugins/pdk/go/lyrics/lyrics_stub.go @@ -0,0 +1,82 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file provides stub implementations for non-WASM platforms. +// It allows Go plugins to compile and run tests outside of WASM, +// but the actual functionality is only available in WASM builds. +// +//go:build !wasip1 + +package lyrics + +// ArtistRef is a reference to an artist with name and optional MBID. +type ArtistRef struct { + // ID is the internal Navidrome artist ID (if known). + ID string `json:"id,omitempty"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the artist. + MBID string `json:"mbid,omitempty"` +} + +// GetLyricsRequest contains the track information for lyrics lookup. +type GetLyricsRequest struct { + Track TrackInfo `json:"track"` +} + +// GetLyricsResponse contains the lyrics returned by the plugin. +type GetLyricsResponse struct { + Lyrics []LyricsText `json:"lyrics"` +} + +// LyricsText represents a single set of lyrics in raw text format. +// Text can be plain text or LRC format — Navidrome will parse it. +type LyricsText struct { + Lang string `json:"lang,omitempty"` + Text string `json:"text"` +} + +// TrackInfo contains track metadata. +type TrackInfo struct { + // ID is the internal Navidrome track ID. + ID string `json:"id"` + // Title is the track title. + Title string `json:"title"` + // Album is the album name. + Album string `json:"album"` + // Artist is the formatted artist name for display (e.g., "Artist1 • Artist2"). + Artist string `json:"artist"` + // AlbumArtist is the formatted album artist name for display. + AlbumArtist string `json:"albumArtist"` + // Artists is the list of track artists. + Artists []ArtistRef `json:"artists"` + // AlbumArtists is the list of album artists. + AlbumArtists []ArtistRef `json:"albumArtists"` + // Duration is the track duration in seconds. + Duration float32 `json:"duration"` + // TrackNumber is the track number on the album. + TrackNumber int32 `json:"trackNumber"` + // DiscNumber is the disc number. + DiscNumber int32 `json:"discNumber"` + // MBZRecordingID is the MusicBrainz recording ID. + MBZRecordingID string `json:"mbzRecordingId,omitempty"` + // MBZAlbumID is the MusicBrainz album/release ID. + MBZAlbumID string `json:"mbzAlbumId,omitempty"` + // MBZReleaseGroupID is the MusicBrainz release group ID. + MBZReleaseGroupID string `json:"mbzReleaseGroupId,omitempty"` + // MBZReleaseTrackID is the MusicBrainz release track ID. + MBZReleaseTrackID string `json:"mbzReleaseTrackId,omitempty"` +} + +// Lyrics requires all methods to be implemented. +// Lyrics provides lyrics for a given track from external sources. +type Lyrics interface { + // GetLyrics + GetLyrics(GetLyricsRequest) (GetLyricsResponse, error) +} + +// NotImplementedCode is the standard return code for unimplemented functions. +const NotImplementedCode int32 = -2 + +// Register is a no-op on non-WASM platforms. +// This stub allows code to compile outside of WASM. +func Register(_ Lyrics) {} diff --git a/plugins/pdk/go/metadata/metadata.go b/plugins/pdk/go/metadata/metadata.go new file mode 100644 index 000000000..7cd63865b --- /dev/null +++ b/plugins/pdk/go/metadata/metadata.go @@ -0,0 +1,621 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the MetadataAgent capability. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package metadata + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// AlbumImagesResponse is the response for GetAlbumImages. +type AlbumImagesResponse struct { + // Images is the list of album images. + Images []ImageInfo `json:"images"` +} + +// AlbumInfoResponse is the response for GetAlbumInfo. +type AlbumInfoResponse struct { + // Name is the album name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the album. + MBID string `json:"mbid"` + // Description is the album description/notes. + Description string `json:"description"` + // URL is the external URL for the album. + URL string `json:"url"` +} + +// AlbumRequest is the common request for album-related functions. +type AlbumRequest struct { + // Name is the album name. + Name string `json:"name"` + // Artist is the album artist name. + Artist string `json:"artist"` + // MBID is the MusicBrainz ID for the album (if known). + MBID string `json:"mbid,omitempty"` +} + +// ArtistBiographyResponse is the response for GetArtistBiography. +type ArtistBiographyResponse struct { + // Biography is the artist biography text. + Biography string `json:"biography"` +} + +// ArtistImagesResponse is the response for GetArtistImages. +type ArtistImagesResponse struct { + // Images is the list of artist images. + Images []ImageInfo `json:"images"` +} + +// ArtistMBIDRequest is the request for GetArtistMBID. +type ArtistMBIDRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` +} + +// ArtistMBIDResponse is the response for GetArtistMBID. +type ArtistMBIDResponse struct { + // MBID is the MusicBrainz ID for the artist. + MBID string `json:"mbid"` +} + +// ArtistRef is a reference to an artist with name and optional MBID. +type ArtistRef struct { + // ID is the internal Navidrome artist ID (if known). + ID string `json:"id,omitempty"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the artist. + MBID string `json:"mbid,omitempty"` +} + +// ArtistRequest is the common request for artist-related functions. +type ArtistRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the artist (if known). + MBID string `json:"mbid,omitempty"` +} + +// ArtistURLResponse is the response for GetArtistURL. +type ArtistURLResponse struct { + // URL is the external URL for the artist. + URL string `json:"url"` +} + +// ImageInfo represents an image with URL and size. +type ImageInfo struct { + // URL is the URL of the image. + URL string `json:"url"` + // Size is the size of the image in pixels (width or height). + Size int32 `json:"size"` +} + +// SimilarArtistsRequest is the request for GetSimilarArtists. +type SimilarArtistsRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the artist (if known). + MBID string `json:"mbid,omitempty"` + // Limit is the maximum number of similar artists to return. + Limit int32 `json:"limit"` +} + +// SimilarArtistsResponse is the response for GetSimilarArtists. +type SimilarArtistsResponse struct { + // Artists is the list of similar artists. + Artists []ArtistRef `json:"artists"` +} + +// SimilarSongsByAlbumRequest is the request for GetSimilarSongsByAlbum. +type SimilarSongsByAlbumRequest struct { + // ID is the internal Navidrome album ID. + ID string `json:"id"` + // Name is the album name. + Name string `json:"name"` + // Artist is the album artist name. + Artist string `json:"artist"` + // MBID is the MusicBrainz release ID (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of similar songs to return. + Count int32 `json:"count"` +} + +// SimilarSongsByArtistRequest is the request for GetSimilarSongsByArtist. +type SimilarSongsByArtistRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz artist ID (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of similar songs to return. + Count int32 `json:"count"` +} + +// SimilarSongsByTrackRequest is the request for GetSimilarSongsByTrack. +type SimilarSongsByTrackRequest struct { + // ID is the internal Navidrome mediafile ID. + ID string `json:"id"` + // Name is the track title. + Name string `json:"name"` + // Artist is the artist name. + Artist string `json:"artist"` + // MBID is the MusicBrainz recording ID (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of similar songs to return. + Count int32 `json:"count"` +} + +// SimilarSongsResponse is the response for GetSimilarSongsBy* functions. +type SimilarSongsResponse struct { + // Songs is the list of similar songs. + Songs []SongRef `json:"songs"` +} + +// SongRef is a reference to a song with metadata for matching. +type SongRef struct { + // ID is the internal Navidrome mediafile ID (if known). + ID string `json:"id,omitempty"` + // Name is the song name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the song. + MBID string `json:"mbid,omitempty"` + // ISRC is the International Standard Recording Code for the song. + ISRC string `json:"isrc,omitempty"` + // Artist is the artist name. + Artist string `json:"artist,omitempty"` + // ArtistMBID is the MusicBrainz artist ID. + ArtistMBID string `json:"artistMbid,omitempty"` + // Album is the album name. + Album string `json:"album,omitempty"` + // AlbumMBID is the MusicBrainz release ID. + AlbumMBID string `json:"albumMbid,omitempty"` + // Duration is the song duration in seconds. + Duration float32 `json:"duration,omitempty"` +} + +// TopSongsRequest is the request for GetArtistTopSongs. +type TopSongsRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the artist (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of top songs to return. + Count int32 `json:"count"` +} + +// TopSongsResponse is the response for GetArtistTopSongs. +type TopSongsResponse struct { + // Songs is the list of top songs. + Songs []SongRef `json:"songs"` +} + +// Metadata is the marker interface for metadata plugins. +// Implement one or more of the provider interfaces below. +// MetadataAgent provides artist and album metadata retrieval. +// This capability allows plugins to provide external metadata for artists and albums, +// such as biographies, images, similar artists, and top songs. +// +// Plugins implementing this capability can choose which methods to implement. +// Each method is optional - plugins only need to provide the functionality they support. +type Metadata interface{} + +// ArtistMBIDProvider provides the GetArtistMBID function. +type ArtistMBIDProvider interface { + GetArtistMBID(ArtistMBIDRequest) (*ArtistMBIDResponse, error) +} + +// ArtistURLProvider provides the GetArtistURL function. +type ArtistURLProvider interface { + GetArtistURL(ArtistRequest) (*ArtistURLResponse, error) +} + +// ArtistBiographyProvider provides the GetArtistBiography function. +type ArtistBiographyProvider interface { + GetArtistBiography(ArtistRequest) (*ArtistBiographyResponse, error) +} + +// SimilarArtistsProvider provides the GetSimilarArtists function. +type SimilarArtistsProvider interface { + GetSimilarArtists(SimilarArtistsRequest) (*SimilarArtistsResponse, error) +} + +// ArtistImagesProvider provides the GetArtistImages function. +type ArtistImagesProvider interface { + GetArtistImages(ArtistRequest) (*ArtistImagesResponse, error) +} + +// ArtistTopSongsProvider provides the GetArtistTopSongs function. +type ArtistTopSongsProvider interface { + GetArtistTopSongs(TopSongsRequest) (*TopSongsResponse, error) +} + +// AlbumInfoProvider provides the GetAlbumInfo function. +type AlbumInfoProvider interface { + GetAlbumInfo(AlbumRequest) (*AlbumInfoResponse, error) +} + +// AlbumImagesProvider provides the GetAlbumImages function. +type AlbumImagesProvider interface { + GetAlbumImages(AlbumRequest) (*AlbumImagesResponse, error) +} + +// SimilarSongsByTrackProvider provides the GetSimilarSongsByTrack function. +type SimilarSongsByTrackProvider interface { + GetSimilarSongsByTrack(SimilarSongsByTrackRequest) (*SimilarSongsResponse, error) +} + +// SimilarSongsByAlbumProvider provides the GetSimilarSongsByAlbum function. +type SimilarSongsByAlbumProvider interface { + GetSimilarSongsByAlbum(SimilarSongsByAlbumRequest) (*SimilarSongsResponse, error) +} + +// SimilarSongsByArtistProvider provides the GetSimilarSongsByArtist function. +type SimilarSongsByArtistProvider interface { + GetSimilarSongsByArtist(SimilarSongsByArtistRequest) (*SimilarSongsResponse, error) +} // Internal implementation holders +var ( + artistMBIDImpl func(ArtistMBIDRequest) (*ArtistMBIDResponse, error) + artistURLImpl func(ArtistRequest) (*ArtistURLResponse, error) + artistBiographyImpl func(ArtistRequest) (*ArtistBiographyResponse, error) + similarArtistsImpl func(SimilarArtistsRequest) (*SimilarArtistsResponse, error) + artistImagesImpl func(ArtistRequest) (*ArtistImagesResponse, error) + artistTopSongsImpl func(TopSongsRequest) (*TopSongsResponse, error) + albumInfoImpl func(AlbumRequest) (*AlbumInfoResponse, error) + albumImagesImpl func(AlbumRequest) (*AlbumImagesResponse, error) + similarSongsByTrackImpl func(SimilarSongsByTrackRequest) (*SimilarSongsResponse, error) + similarSongsByAlbumImpl func(SimilarSongsByAlbumRequest) (*SimilarSongsResponse, error) + similarSongsByArtistImpl func(SimilarSongsByArtistRequest) (*SimilarSongsResponse, error) +) + +// Register registers a metadata implementation. +// The implementation is checked for optional provider interfaces. +func Register(impl Metadata) { + if p, ok := impl.(ArtistMBIDProvider); ok { + artistMBIDImpl = p.GetArtistMBID + } + if p, ok := impl.(ArtistURLProvider); ok { + artistURLImpl = p.GetArtistURL + } + if p, ok := impl.(ArtistBiographyProvider); ok { + artistBiographyImpl = p.GetArtistBiography + } + if p, ok := impl.(SimilarArtistsProvider); ok { + similarArtistsImpl = p.GetSimilarArtists + } + if p, ok := impl.(ArtistImagesProvider); ok { + artistImagesImpl = p.GetArtistImages + } + if p, ok := impl.(ArtistTopSongsProvider); ok { + artistTopSongsImpl = p.GetArtistTopSongs + } + if p, ok := impl.(AlbumInfoProvider); ok { + albumInfoImpl = p.GetAlbumInfo + } + if p, ok := impl.(AlbumImagesProvider); ok { + albumImagesImpl = p.GetAlbumImages + } + if p, ok := impl.(SimilarSongsByTrackProvider); ok { + similarSongsByTrackImpl = p.GetSimilarSongsByTrack + } + if p, ok := impl.(SimilarSongsByAlbumProvider); ok { + similarSongsByAlbumImpl = p.GetSimilarSongsByAlbum + } + if p, ok := impl.(SimilarSongsByArtistProvider); ok { + similarSongsByArtistImpl = p.GetSimilarSongsByArtist + } +} + +// NotImplementedCode is the standard return code for unimplemented functions. +// The host recognizes this and skips the plugin gracefully. +const NotImplementedCode int32 = -2 + +//go:wasmexport nd_get_artist_mbid +func _NdGetArtistMbid() int32 { + if artistMBIDImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input ArtistMBIDRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := artistMBIDImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_get_artist_url +func _NdGetArtistUrl() int32 { + if artistURLImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input ArtistRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := artistURLImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_get_artist_biography +func _NdGetArtistBiography() int32 { + if artistBiographyImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input ArtistRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := artistBiographyImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_get_similar_artists +func _NdGetSimilarArtists() int32 { + if similarArtistsImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input SimilarArtistsRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := similarArtistsImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_get_artist_images +func _NdGetArtistImages() int32 { + if artistImagesImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input ArtistRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := artistImagesImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_get_artist_top_songs +func _NdGetArtistTopSongs() int32 { + if artistTopSongsImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input TopSongsRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := artistTopSongsImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_get_album_info +func _NdGetAlbumInfo() int32 { + if albumInfoImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input AlbumRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := albumInfoImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_get_album_images +func _NdGetAlbumImages() int32 { + if albumImagesImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input AlbumRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := albumImagesImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_get_similar_songs_by_track +func _NdGetSimilarSongsByTrack() int32 { + if similarSongsByTrackImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input SimilarSongsByTrackRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := similarSongsByTrackImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_get_similar_songs_by_album +func _NdGetSimilarSongsByAlbum() int32 { + if similarSongsByAlbumImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input SimilarSongsByAlbumRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := similarSongsByAlbumImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_get_similar_songs_by_artist +func _NdGetSimilarSongsByArtist() int32 { + if similarSongsByArtistImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input SimilarSongsByArtistRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := similarSongsByArtistImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} diff --git a/plugins/pdk/go/metadata/metadata_stub.go b/plugins/pdk/go/metadata/metadata_stub.go new file mode 100644 index 000000000..bdcd06fcb --- /dev/null +++ b/plugins/pdk/go/metadata/metadata_stub.go @@ -0,0 +1,273 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file provides stub implementations for non-WASM platforms. +// It allows Go plugins to compile and run tests outside of WASM, +// but the actual functionality is only available in WASM builds. +// +//go:build !wasip1 + +package metadata + +// AlbumImagesResponse is the response for GetAlbumImages. +type AlbumImagesResponse struct { + // Images is the list of album images. + Images []ImageInfo `json:"images"` +} + +// AlbumInfoResponse is the response for GetAlbumInfo. +type AlbumInfoResponse struct { + // Name is the album name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the album. + MBID string `json:"mbid"` + // Description is the album description/notes. + Description string `json:"description"` + // URL is the external URL for the album. + URL string `json:"url"` +} + +// AlbumRequest is the common request for album-related functions. +type AlbumRequest struct { + // Name is the album name. + Name string `json:"name"` + // Artist is the album artist name. + Artist string `json:"artist"` + // MBID is the MusicBrainz ID for the album (if known). + MBID string `json:"mbid,omitempty"` +} + +// ArtistBiographyResponse is the response for GetArtistBiography. +type ArtistBiographyResponse struct { + // Biography is the artist biography text. + Biography string `json:"biography"` +} + +// ArtistImagesResponse is the response for GetArtistImages. +type ArtistImagesResponse struct { + // Images is the list of artist images. + Images []ImageInfo `json:"images"` +} + +// ArtistMBIDRequest is the request for GetArtistMBID. +type ArtistMBIDRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` +} + +// ArtistMBIDResponse is the response for GetArtistMBID. +type ArtistMBIDResponse struct { + // MBID is the MusicBrainz ID for the artist. + MBID string `json:"mbid"` +} + +// ArtistRef is a reference to an artist with name and optional MBID. +type ArtistRef struct { + // ID is the internal Navidrome artist ID (if known). + ID string `json:"id,omitempty"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the artist. + MBID string `json:"mbid,omitempty"` +} + +// ArtistRequest is the common request for artist-related functions. +type ArtistRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the artist (if known). + MBID string `json:"mbid,omitempty"` +} + +// ArtistURLResponse is the response for GetArtistURL. +type ArtistURLResponse struct { + // URL is the external URL for the artist. + URL string `json:"url"` +} + +// ImageInfo represents an image with URL and size. +type ImageInfo struct { + // URL is the URL of the image. + URL string `json:"url"` + // Size is the size of the image in pixels (width or height). + Size int32 `json:"size"` +} + +// SimilarArtistsRequest is the request for GetSimilarArtists. +type SimilarArtistsRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the artist (if known). + MBID string `json:"mbid,omitempty"` + // Limit is the maximum number of similar artists to return. + Limit int32 `json:"limit"` +} + +// SimilarArtistsResponse is the response for GetSimilarArtists. +type SimilarArtistsResponse struct { + // Artists is the list of similar artists. + Artists []ArtistRef `json:"artists"` +} + +// SimilarSongsByAlbumRequest is the request for GetSimilarSongsByAlbum. +type SimilarSongsByAlbumRequest struct { + // ID is the internal Navidrome album ID. + ID string `json:"id"` + // Name is the album name. + Name string `json:"name"` + // Artist is the album artist name. + Artist string `json:"artist"` + // MBID is the MusicBrainz release ID (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of similar songs to return. + Count int32 `json:"count"` +} + +// SimilarSongsByArtistRequest is the request for GetSimilarSongsByArtist. +type SimilarSongsByArtistRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz artist ID (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of similar songs to return. + Count int32 `json:"count"` +} + +// SimilarSongsByTrackRequest is the request for GetSimilarSongsByTrack. +type SimilarSongsByTrackRequest struct { + // ID is the internal Navidrome mediafile ID. + ID string `json:"id"` + // Name is the track title. + Name string `json:"name"` + // Artist is the artist name. + Artist string `json:"artist"` + // MBID is the MusicBrainz recording ID (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of similar songs to return. + Count int32 `json:"count"` +} + +// SimilarSongsResponse is the response for GetSimilarSongsBy* functions. +type SimilarSongsResponse struct { + // Songs is the list of similar songs. + Songs []SongRef `json:"songs"` +} + +// SongRef is a reference to a song with metadata for matching. +type SongRef struct { + // ID is the internal Navidrome mediafile ID (if known). + ID string `json:"id,omitempty"` + // Name is the song name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the song. + MBID string `json:"mbid,omitempty"` + // ISRC is the International Standard Recording Code for the song. + ISRC string `json:"isrc,omitempty"` + // Artist is the artist name. + Artist string `json:"artist,omitempty"` + // ArtistMBID is the MusicBrainz artist ID. + ArtistMBID string `json:"artistMbid,omitempty"` + // Album is the album name. + Album string `json:"album,omitempty"` + // AlbumMBID is the MusicBrainz release ID. + AlbumMBID string `json:"albumMbid,omitempty"` + // Duration is the song duration in seconds. + Duration float32 `json:"duration,omitempty"` +} + +// TopSongsRequest is the request for GetArtistTopSongs. +type TopSongsRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the artist (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of top songs to return. + Count int32 `json:"count"` +} + +// TopSongsResponse is the response for GetArtistTopSongs. +type TopSongsResponse struct { + // Songs is the list of top songs. + Songs []SongRef `json:"songs"` +} + +// Metadata is the marker interface for metadata plugins. +// Implement one or more of the provider interfaces below. +// MetadataAgent provides artist and album metadata retrieval. +// This capability allows plugins to provide external metadata for artists and albums, +// such as biographies, images, similar artists, and top songs. +// +// Plugins implementing this capability can choose which methods to implement. +// Each method is optional - plugins only need to provide the functionality they support. +type Metadata interface{} + +// ArtistMBIDProvider provides the GetArtistMBID function. +type ArtistMBIDProvider interface { + GetArtistMBID(ArtistMBIDRequest) (*ArtistMBIDResponse, error) +} + +// ArtistURLProvider provides the GetArtistURL function. +type ArtistURLProvider interface { + GetArtistURL(ArtistRequest) (*ArtistURLResponse, error) +} + +// ArtistBiographyProvider provides the GetArtistBiography function. +type ArtistBiographyProvider interface { + GetArtistBiography(ArtistRequest) (*ArtistBiographyResponse, error) +} + +// SimilarArtistsProvider provides the GetSimilarArtists function. +type SimilarArtistsProvider interface { + GetSimilarArtists(SimilarArtistsRequest) (*SimilarArtistsResponse, error) +} + +// ArtistImagesProvider provides the GetArtistImages function. +type ArtistImagesProvider interface { + GetArtistImages(ArtistRequest) (*ArtistImagesResponse, error) +} + +// ArtistTopSongsProvider provides the GetArtistTopSongs function. +type ArtistTopSongsProvider interface { + GetArtistTopSongs(TopSongsRequest) (*TopSongsResponse, error) +} + +// AlbumInfoProvider provides the GetAlbumInfo function. +type AlbumInfoProvider interface { + GetAlbumInfo(AlbumRequest) (*AlbumInfoResponse, error) +} + +// AlbumImagesProvider provides the GetAlbumImages function. +type AlbumImagesProvider interface { + GetAlbumImages(AlbumRequest) (*AlbumImagesResponse, error) +} + +// SimilarSongsByTrackProvider provides the GetSimilarSongsByTrack function. +type SimilarSongsByTrackProvider interface { + GetSimilarSongsByTrack(SimilarSongsByTrackRequest) (*SimilarSongsResponse, error) +} + +// SimilarSongsByAlbumProvider provides the GetSimilarSongsByAlbum function. +type SimilarSongsByAlbumProvider interface { + GetSimilarSongsByAlbum(SimilarSongsByAlbumRequest) (*SimilarSongsResponse, error) +} + +// SimilarSongsByArtistProvider provides the GetSimilarSongsByArtist function. +type SimilarSongsByArtistProvider interface { + GetSimilarSongsByArtist(SimilarSongsByArtistRequest) (*SimilarSongsResponse, error) +} + +// NotImplementedCode is the standard return code for unimplemented functions. +const NotImplementedCode int32 = -2 + +// Register is a no-op on non-WASM platforms. +// This stub allows code to compile outside of WASM. +func Register(_ Metadata) {} diff --git a/plugins/pdk/go/pdk/example_test.go b/plugins/pdk/go/pdk/example_test.go new file mode 100644 index 000000000..5678bddd4 --- /dev/null +++ b/plugins/pdk/go/pdk/example_test.go @@ -0,0 +1,324 @@ +// Example test demonstrating how to use the PDK mock for unit testing. +// This file is only compiled for non-WASM builds. +// +//go:build !wasip1 + +package pdk_test + +import ( + "testing" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" + "github.com/stretchr/testify/mock" +) + +// ExamplePlugin demonstrates a simple plugin that uses PDK functions. +type ExamplePlugin struct{} + +// ProcessMessage reads input, logs it, and outputs a response. +func (p *ExamplePlugin) ProcessMessage() error { + // Get configuration + prefix, ok := pdk.GetConfig("message_prefix") + if !ok { + prefix = "Hello" + } + + // Read input + message := pdk.InputString() + + // Log the message + pdk.Log(pdk.LogInfo, "Processing: "+message) + + // Output the response + pdk.OutputString(prefix + ", " + message + "!") + + return nil +} + +func TestExamplePlugin_ProcessMessage(t *testing.T) { + // Reset mock state before the test + pdk.ResetMock() + + // Set up expectations + pdk.PDKMock.On("GetConfig", "message_prefix").Return("Hi", true) + pdk.PDKMock.On("InputString").Return("World") + pdk.PDKMock.On("Log", pdk.LogInfo, "Processing: World").Return() + pdk.PDKMock.On("OutputString", "Hi, World!").Return() + + // Call the plugin function + plugin := &ExamplePlugin{} + err := plugin.ProcessMessage() + + // Verify no error + if err != nil { + t.Fatalf("unexpected error: %v", err) + } + + // Verify all expected calls were made + pdk.PDKMock.AssertExpectations(t) +} + +func TestExamplePlugin_ProcessMessage_DefaultPrefix(t *testing.T) { + // Reset mock state before the test + pdk.ResetMock() + + // Set up expectations - config key not found + pdk.PDKMock.On("GetConfig", "message_prefix").Return("", false) + pdk.PDKMock.On("InputString").Return("Test") + pdk.PDKMock.On("Log", pdk.LogInfo, "Processing: Test").Return() + pdk.PDKMock.On("OutputString", "Hello, Test!").Return() + + // Call the plugin function + plugin := &ExamplePlugin{} + err := plugin.ProcessMessage() + + // Verify no error + if err != nil { + t.Fatalf("unexpected error: %v", err) + } + + // Verify all expected calls were made + pdk.PDKMock.AssertExpectations(t) +} + +// Example of testing JSON input/output +type Request struct { + Name string `json:"name"` + Count int `json:"count"` +} + +type Response struct { + Message string `json:"message"` + Total int `json:"total"` +} + +func ProcessJSONRequest() error { + var req Request + if err := pdk.InputJSON(&req); err != nil { + pdk.SetError(err) + return err + } + + resp := Response{ + Message: "Hello, " + req.Name, + Total: req.Count * 2, + } + + return pdk.OutputJSON(resp) +} + +func TestProcessJSONRequest(t *testing.T) { + pdk.ResetMock() + + // Mock InputJSON to populate the request struct + pdk.PDKMock.On("InputJSON", mock.AnythingOfType("*pdk_test.Request")). + Return(nil). + Run(func(args mock.Arguments) { + req := args.Get(0).(*Request) + req.Name = "Alice" + req.Count = 5 + }) + + // Expect OutputJSON with the correct response + pdk.PDKMock.On("OutputJSON", Response{ + Message: "Hello, Alice", + Total: 10, + }).Return(nil) + + // Call the function + err := ProcessJSONRequest() + + if err != nil { + t.Fatalf("unexpected error: %v", err) + } + + pdk.PDKMock.AssertExpectations(t) +} + +// ============================================================================= +// Examples using stub types (Memory, HTTPRequest, HTTPResponse) +// ============================================================================= + +// FetchData demonstrates a plugin function that makes an HTTP request. +func FetchData(url string) ([]byte, error) { + // Create and configure the HTTP request + // Note: SetHeader and SetBody work directly on the stub - no mocking needed! + req := pdk.NewHTTPRequest(pdk.MethodGet, url) + req.SetHeader("Accept", "application/json") + req.SetHeader("User-Agent", "MyPlugin/1.0") + + // Send the request - this is mocked because it requires host interaction + resp := req.Send() + + // Check status - works directly on the stub + if resp.Status() != 200 { + return nil, nil + } + + // Return body - works directly on the stub + return resp.Body(), nil +} + +func TestFetchData(t *testing.T) { + pdk.ResetMock() + + // Create a stub response with test data + expectedBody := []byte(`{"result": "success"}`) + stubResponse := pdk.NewStubHTTPResponse(200, map[string]string{ + "Content-Type": "application/json", + }, expectedBody) + + // Mock NewHTTPRequest to return a real HTTPRequest struct + // The struct methods (SetHeader, SetBody) work without mocking + pdk.PDKMock.On("NewHTTPRequest", pdk.MethodGet, "https://api.example.com/data"). + Return(&pdk.HTTPRequest{}) + + // Mock Send to return our stub response + pdk.PDKMock.On("Send", mock.AnythingOfType("*pdk.HTTPRequest")). + Return(stubResponse) + + // Call the function + body, err := FetchData("https://api.example.com/data") + + if err != nil { + t.Fatalf("unexpected error: %v", err) + } + + if string(body) != string(expectedBody) { + t.Errorf("expected body %q, got %q", expectedBody, body) + } + + pdk.PDKMock.AssertExpectations(t) +} + +func TestFetchData_NonOKStatus(t *testing.T) { + pdk.ResetMock() + + // Create a stub response with 404 status + stubResponse := pdk.NewStubHTTPResponse(404, nil, []byte("Not Found")) + + pdk.PDKMock.On("NewHTTPRequest", pdk.MethodGet, "https://api.example.com/missing"). + Return(&pdk.HTTPRequest{}) + pdk.PDKMock.On("Send", mock.AnythingOfType("*pdk.HTTPRequest")). + Return(stubResponse) + + // Call the function + body, err := FetchData("https://api.example.com/missing") + + if err != nil { + t.Fatalf("unexpected error: %v", err) + } + + // Should return nil for non-200 status + if body != nil { + t.Errorf("expected nil body for 404, got %q", body) + } + + pdk.PDKMock.AssertExpectations(t) +} + +// ProcessMemoryData demonstrates working with Memory type. +func ProcessMemoryData(mem pdk.Memory) string { + // Memory methods work directly on the stub - no mocking needed! + data := mem.ReadBytes() + return "Processed " + string(data) + " (length: " + formatUint64(mem.Length()) + ")" +} + +func formatUint64(n uint64) string { + return string(rune('0' + n%10)) // Simplified for demo +} + +func TestProcessMemoryData(t *testing.T) { + // Create stub memory with test data - no mocking needed! + mem := pdk.NewStubMemory(0, 5, []byte("hello")) + + result := ProcessMemoryData(mem) + + expected := "Processed hello (length: 5)" + if result != expected { + t.Errorf("expected %q, got %q", expected, result) + } +} + +// StoreAndRetrieve demonstrates Memory Store/Load methods. +func TestMemoryStoreAndLoad(t *testing.T) { + // Create empty memory + mem := pdk.NewStubMemory(100, 0, nil) + + // Store data - works directly, no mock needed + mem.Store([]byte("test data")) + + // Verify the data was stored + if mem.Length() != 9 { + t.Errorf("expected length 9, got %d", mem.Length()) + } + + // Load into buffer + buffer := make([]byte, 9) + mem.Load(buffer) + + if string(buffer) != "test data" { + t.Errorf("expected 'test data', got %q", buffer) + } + + // Free the memory + mem.Free() + + if mem.Length() != 0 { + t.Errorf("expected length 0 after free, got %d", mem.Length()) + } +} + +// HTTPMethodString demonstrates that HTTPMethod.String() works without mocking. +func TestHTTPMethodString(t *testing.T) { + // These work directly - no mocking needed! + tests := []struct { + method pdk.HTTPMethod + expected string + }{ + {pdk.MethodGet, "GET"}, + {pdk.MethodPost, "POST"}, + {pdk.MethodPut, "PUT"}, + {pdk.MethodDelete, "DELETE"}, + } + + for _, tc := range tests { + result := tc.method.String() + if result != tc.expected { + t.Errorf("expected %q for method %d, got %q", tc.expected, tc.method, result) + } + } +} + +// PostJSON demonstrates a more complex HTTP request with body. +func PostJSON(url string, data []byte) (int, error) { + req := pdk.NewHTTPRequest(pdk.MethodPost, url) + req.SetHeader("Content-Type", "application/json") + req.SetBody(data) // Works directly on stub + + resp := req.Send() // This is mocked + return int(resp.Status()), nil +} + +func TestPostJSON(t *testing.T) { + pdk.ResetMock() + + stubResponse := pdk.NewStubHTTPResponse(201, nil, nil) + + pdk.PDKMock.On("NewHTTPRequest", pdk.MethodPost, "https://api.example.com/items"). + Return(&pdk.HTTPRequest{}) + pdk.PDKMock.On("Send", mock.AnythingOfType("*pdk.HTTPRequest")). + Return(stubResponse) + + status, err := PostJSON("https://api.example.com/items", []byte(`{"name":"test"}`)) + + if err != nil { + t.Fatalf("unexpected error: %v", err) + } + + if status != 201 { + t.Errorf("expected status 201, got %d", status) + } + + pdk.PDKMock.AssertExpectations(t) +} diff --git a/plugins/pdk/go/pdk/pdk.go b/plugins/pdk/go/pdk/pdk.go new file mode 100644 index 000000000..35394d700 --- /dev/null +++ b/plugins/pdk/go/pdk/pdk.go @@ -0,0 +1,204 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains wrapper functions for the extism/go-pdk package. +// For WASM builds, it provides type aliases and function wrappers that delegate +// to the real extism/go-pdk package with zero overhead. +// +//go:build wasip1 + +package pdk + +import ( + extism "github.com/extism/go-pdk" +) + +// Type aliases - zero overhead, full compatibility +type HTTPMethod = extism.HTTPMethod +type HTTPRequest = extism.HTTPRequest +type HTTPRequestMeta = extism.HTTPRequestMeta +type HTTPResponse = extism.HTTPResponse +type LogLevel = extism.LogLevel +type Memory = extism.Memory + +// Constants + +const ( + LogDebug = extism.LogDebug + LogError = extism.LogError + LogInfo = extism.LogInfo + LogTrace = extism.LogTrace + LogWarn = extism.LogWarn +) + +const ( + MethodConnect = extism.MethodConnect + MethodDelete = extism.MethodDelete + MethodGet = extism.MethodGet + MethodHead = extism.MethodHead + MethodOptions = extism.MethodOptions + MethodPatch = extism.MethodPatch + MethodPost = extism.MethodPost + MethodPut = extism.MethodPut + MethodTrace = extism.MethodTrace +) + +// Functions +func Allocate(length int) Memory { + return extism.Allocate(length) +} +func AllocateBytes(data []byte) Memory { + return extism.AllocateBytes(data) +} + +// AllocateJSON AllocateJSON allocates and saves the type `any` into Memory on the host. +func AllocateJSON(v any) (Memory, error) { + return extism.AllocateJSON(v) +} + +// AllocateString AllocateString allocates and saves the UTF-8 string `data` into Memory on the host. +func AllocateString(data string) Memory { + return extism.AllocateString(data) +} + +// FindMemory FindMemory finds the host memory block at the given `offset`. +func FindMemory(offset uint64) Memory { + return extism.FindMemory(offset) +} + +// GetConfig GetConfig returns the config string associated with `key` (if any). +func GetConfig(key string) (string, bool) { + return extism.GetConfig(key) +} + +// GetVar GetVar returns the byte slice (if any) associated with `key`. +func GetVar(key string) []byte { + return extism.GetVar(key) +} + +// GetVarInt GetVarInt returns the int associated with `key` (or 0 if none). +func GetVarInt(key string) int { + return extism.GetVarInt(key) +} + +// Input Input returns a slice of bytes from the host. +func Input() []byte { + return extism.Input() +} + +// InputJSON InputJSON returns unmartialed JSON data from the host "input". +func InputJSON(v any) error { + return extism.InputJSON(v) +} + +// InputString InputString returns the input data from the host as a UTF-8 string. +func InputString() string { + return extism.InputString() +} + +// JSONFrom JSONFrom unmarshals a `Memory` block located at `offset` from the host into the provided data `v`. +func JSONFrom(offset uint64, v any) error { + return extism.JSONFrom(offset, v) +} + +// Log Log logs the provided UTF-8 string `s` on the host using the provided log `level`. +func Log(level LogLevel, s string) { + extism.Log(level, s) +} + +// LogMemory LogMemory logs the `memory` block on the host using the provided log `level`. +func LogMemory(level LogLevel, m Memory) { + extism.LogMemory(level, m) +} + +// NewHTTPRequest NewHTTPRequest returns a new `HTTPRequest`. +func NewHTTPRequest(method HTTPMethod, url string) *HTTPRequest { + return extism.NewHTTPRequest(method, url) +} +func NewMemory(offset uint64, length uint64) Memory { + return extism.NewMemory(offset, length) +} + +// Output Output sends the `data` slice of bytes to the host output. +func Output(data []byte) { + extism.Output(data) +} + +// OutputJSON OutputJSON marshals the provided data `v` as output to the host. +func OutputJSON(v any) error { + return extism.OutputJSON(v) +} + +// OutputMemory OutputMemory sends the `mem` Memory to the host output. +func OutputMemory(mem Memory) { + extism.OutputMemory(mem) +} + +// OutputString OutputString sends the UTF-8 string `s` to the host output. +func OutputString(s string) { + extism.OutputString(s) +} + +// ParamBytes ParamBytes returns bytes from Extism host memory given an offset. +func ParamBytes(offset uint64) []byte { + return extism.ParamBytes(offset) +} + +// ParamString ParamString returns UTF-8 string data from Extism host memory given an offset. +func ParamString(offset uint64) string { + return extism.ParamString(offset) +} + +// ParamU32 ParamU32 returns a uint32 from Extism host memory given an offset. +func ParamU32(offset uint64) uint32 { + return extism.ParamU32(offset) +} + +// ParamU64 ParamU64 returns a uint64 from Extism host memory given an offset. +func ParamU64(offset uint64) uint64 { + return extism.ParamU64(offset) +} + +// RemoveVar RemoveVar removes (and frees) the host variable associated with `key`. +func RemoveVar(key string) { + extism.RemoveVar(key) +} + +// ResultBytes ResultBytes allocates bytes and returns the offset in Extism host memory. +func ResultBytes(d []byte) uint64 { + return extism.ResultBytes(d) +} + +// ResultString ResultString allocates a UTF-8 string and returns the offset in Extism host memory. +func ResultString(s string) uint64 { + return extism.ResultString(s) +} + +// ResultU32 ResultU32 allocates a uint32 and returns the offset in Extism host memory. +func ResultU32(d uint32) uint64 { + return extism.ResultU32(d) +} + +// ResultU64 ResultU64 allocates a uint64 and returns the offset in Extism host memory. +func ResultU64(d uint64) uint64 { + return extism.ResultU64(d) +} + +// SetError SetError sets the host error string from `err`. +func SetError(err error) { + extism.SetError(err) +} + +// SetErrorString SetErrorString sets the host error string from `err`. +func SetErrorString(err string) { + extism.SetErrorString(err) +} + +// SetVar SetVar sets the host variable associated with `key` to the `value` byte slice. +func SetVar(key string, value []byte) { + extism.SetVar(key, value) +} + +// SetVarInt SetVarInt sets the host variable associated with `key` to the `value` int. +func SetVarInt(key string, value int) { + extism.SetVarInt(key, value) +} diff --git a/plugins/pdk/go/pdk/pdk_stub.go b/plugins/pdk/go/pdk/pdk_stub.go new file mode 100644 index 000000000..3bdbb1cb7 --- /dev/null +++ b/plugins/pdk/go/pdk/pdk_stub.go @@ -0,0 +1,210 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains mock implementations for non-WASM builds. +// These mocks allow IDE support, compilation, and unit testing on non-WASM platforms. +// Plugin authors can use the exported PDKMock instance to set expectations in tests. +// +//go:build !wasip1 + +package pdk + +import "github.com/stretchr/testify/mock" + +// mockPDK is the mock implementation for testing PDK functions. +type mockPDK struct { + mock.Mock +} + +// PDKMock is the auto-instantiated mock instance for testing. +// Use this to set expectations: pdk.PDKMock.On("GetConfig", "key").Return("value", true) +var PDKMock = &mockPDK{} + +// ResetMock resets the mock to its initial state. +// Call this in test setup/teardown to ensure clean state between tests. +func ResetMock() { + PDKMock = &mockPDK{} +} + +// Functions +func Allocate(length int) Memory { + args := PDKMock.Called(length) + return args.Get(0).(Memory) +} +func AllocateBytes(data []byte) Memory { + args := PDKMock.Called(data) + return args.Get(0).(Memory) +} + +// AllocateJSON AllocateJSON allocates and saves the type `any` into Memory on the host. +func AllocateJSON(v any) (Memory, error) { + args := PDKMock.Called(v) + return args.Get(0).(Memory), args.Error(1) +} + +// AllocateString AllocateString allocates and saves the UTF-8 string `data` into Memory on the host. +func AllocateString(data string) Memory { + args := PDKMock.Called(data) + return args.Get(0).(Memory) +} + +// FindMemory FindMemory finds the host memory block at the given `offset`. +func FindMemory(offset uint64) Memory { + args := PDKMock.Called(offset) + return args.Get(0).(Memory) +} + +// GetConfig GetConfig returns the config string associated with `key` (if any). +func GetConfig(key string) (string, bool) { + args := PDKMock.Called(key) + return args.String(0), args.Bool(1) +} + +// GetVar GetVar returns the byte slice (if any) associated with `key`. +func GetVar(key string) []byte { + args := PDKMock.Called(key) + return args.Get(0).([]byte) +} + +// GetVarInt GetVarInt returns the int associated with `key` (or 0 if none). +func GetVarInt(key string) int { + args := PDKMock.Called(key) + return args.Int(0) +} + +// Input Input returns a slice of bytes from the host. +func Input() []byte { + args := PDKMock.Called() + return args.Get(0).([]byte) +} + +// InputJSON InputJSON returns unmartialed JSON data from the host "input". +func InputJSON(v any) error { + args := PDKMock.Called(v) + return args.Error(0) +} + +// InputString InputString returns the input data from the host as a UTF-8 string. +func InputString() string { + args := PDKMock.Called() + return args.String(0) +} + +// JSONFrom JSONFrom unmarshals a `Memory` block located at `offset` from the host into the provided data `v`. +func JSONFrom(offset uint64, v any) error { + args := PDKMock.Called(offset, v) + return args.Error(0) +} + +// Log Log logs the provided UTF-8 string `s` on the host using the provided log `level`. +func Log(level LogLevel, s string) { + PDKMock.Called(level, s) +} + +// LogMemory LogMemory logs the `memory` block on the host using the provided log `level`. +func LogMemory(level LogLevel, m Memory) { + PDKMock.Called(level, m) +} + +// NewHTTPRequest NewHTTPRequest returns a new `HTTPRequest`. +func NewHTTPRequest(method HTTPMethod, url string) *HTTPRequest { + args := PDKMock.Called(method, url) + return args.Get(0).(*HTTPRequest) +} +func NewMemory(offset uint64, length uint64) Memory { + args := PDKMock.Called(offset, length) + return args.Get(0).(Memory) +} + +// Output Output sends the `data` slice of bytes to the host output. +func Output(data []byte) { + PDKMock.Called(data) +} + +// OutputJSON OutputJSON marshals the provided data `v` as output to the host. +func OutputJSON(v any) error { + args := PDKMock.Called(v) + return args.Error(0) +} + +// OutputMemory OutputMemory sends the `mem` Memory to the host output. +func OutputMemory(mem Memory) { + PDKMock.Called(mem) +} + +// OutputString OutputString sends the UTF-8 string `s` to the host output. +func OutputString(s string) { + PDKMock.Called(s) +} + +// ParamBytes ParamBytes returns bytes from Extism host memory given an offset. +func ParamBytes(offset uint64) []byte { + args := PDKMock.Called(offset) + return args.Get(0).([]byte) +} + +// ParamString ParamString returns UTF-8 string data from Extism host memory given an offset. +func ParamString(offset uint64) string { + args := PDKMock.Called(offset) + return args.String(0) +} + +// ParamU32 ParamU32 returns a uint32 from Extism host memory given an offset. +func ParamU32(offset uint64) uint32 { + args := PDKMock.Called(offset) + return args.Get(0).(uint32) +} + +// ParamU64 ParamU64 returns a uint64 from Extism host memory given an offset. +func ParamU64(offset uint64) uint64 { + args := PDKMock.Called(offset) + return args.Get(0).(uint64) +} + +// RemoveVar RemoveVar removes (and frees) the host variable associated with `key`. +func RemoveVar(key string) { + PDKMock.Called(key) +} + +// ResultBytes ResultBytes allocates bytes and returns the offset in Extism host memory. +func ResultBytes(d []byte) uint64 { + args := PDKMock.Called(d) + return args.Get(0).(uint64) +} + +// ResultString ResultString allocates a UTF-8 string and returns the offset in Extism host memory. +func ResultString(s string) uint64 { + args := PDKMock.Called(s) + return args.Get(0).(uint64) +} + +// ResultU32 ResultU32 allocates a uint32 and returns the offset in Extism host memory. +func ResultU32(d uint32) uint64 { + args := PDKMock.Called(d) + return args.Get(0).(uint64) +} + +// ResultU64 ResultU64 allocates a uint64 and returns the offset in Extism host memory. +func ResultU64(d uint64) uint64 { + args := PDKMock.Called(d) + return args.Get(0).(uint64) +} + +// SetError SetError sets the host error string from `err`. +func SetError(err error) { + PDKMock.Called(err) +} + +// SetErrorString SetErrorString sets the host error string from `err`. +func SetErrorString(err string) { + PDKMock.Called(err) +} + +// SetVar SetVar sets the host variable associated with `key` to the `value` byte slice. +func SetVar(key string, value []byte) { + PDKMock.Called(key, value) +} + +// SetVarInt SetVarInt sets the host variable associated with `key` to the `value` int. +func SetVarInt(key string, value int) { + PDKMock.Called(key, value) +} diff --git a/plugins/pdk/go/pdk/types_stub.go b/plugins/pdk/go/pdk/types_stub.go new file mode 100644 index 000000000..06cbb4f1f --- /dev/null +++ b/plugins/pdk/go/pdk/types_stub.go @@ -0,0 +1,192 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains type definitions for non-WASM builds. +// These types match the extism/go-pdk signatures to allow compilation and testing +// on native platforms without importing the WASM-only extism package. +// +//go:build !wasip1 + +package pdk + +// LogLevel represents a logging level. +type LogLevel int + +// Log level constants +const ( + LogTrace LogLevel = iota + LogDebug + LogInfo + LogWarn + LogError +) + +// HTTPMethod represents an HTTP method. +type HTTPMethod int32 + +// HTTP method constants +const ( + MethodGet HTTPMethod = iota + MethodHead + MethodPost + MethodPut + MethodPatch + MethodDelete + MethodConnect + MethodOptions + MethodTrace +) + +// String returns the string representation of the HTTP method. +func (m HTTPMethod) String() string { + switch m { + case MethodGet: + return "GET" + case MethodHead: + return "HEAD" + case MethodPost: + return "POST" + case MethodPut: + return "PUT" + case MethodPatch: + return "PATCH" + case MethodDelete: + return "DELETE" + case MethodConnect: + return "CONNECT" + case MethodOptions: + return "OPTIONS" + case MethodTrace: + return "TRACE" + default: + return "UNKNOWN" + } +} + +// Memory represents memory allocated by (and shared with) the host. +// This is a stub implementation for non-WASM platforms. +type Memory struct { + offset uint64 + length uint64 + data []byte +} + +// Offset returns the offset of the memory block. +func (m Memory) Offset() uint64 { + return m.offset +} + +// Length returns the length of the memory block. +func (m Memory) Length() uint64 { + return m.length +} + +// ReadBytes reads all bytes from the memory block. +func (m Memory) ReadBytes() []byte { + return m.data +} + +// Load reads the memory block into the provided buffer. +func (m *Memory) Load(buffer []byte) { + copy(buffer, m.data) +} + +// Store writes data to the memory block. +func (m *Memory) Store(data []byte) { + m.data = make([]byte, len(data)) + copy(m.data, data) + m.length = uint64(len(data)) +} + +// Free frees the memory block. +func (m *Memory) Free() { + m.data = nil + m.length = 0 +} + +// NewStubMemory creates a new stub Memory for testing. +// This is a helper function not present in the real PDK. +func NewStubMemory(offset, length uint64, data []byte) Memory { + return Memory{ + offset: offset, + length: length, + data: data, + } +} + +// HTTPRequest represents an HTTP request sent by the host. +// This is a stub implementation for non-WASM platforms. +type HTTPRequest struct { + method HTTPMethod + url string + headers map[string]string + body []byte +} + +// SetHeader sets an HTTP header key to value. +func (r *HTTPRequest) SetHeader(key string, value string) *HTTPRequest { + if r.headers == nil { + r.headers = make(map[string]string) + } + r.headers[key] = value + return r +} + +// SetBody sets the HTTP request body. +func (r *HTTPRequest) SetBody(body []byte) *HTTPRequest { + r.body = body + return r +} + +// Send sends the HTTP request and returns the response. +// In the stub implementation, this delegates to the mock. +func (r *HTTPRequest) Send() HTTPResponse { + args := PDKMock.Called(r) + return args.Get(0).(HTTPResponse) +} + +// HTTPRequestMeta represents the metadata associated with an HTTP request. +type HTTPRequestMeta struct { + URL string `json:"url"` + Method string `json:"method"` + Headers map[string]string `json:"headers"` +} + +// HTTPResponse represents an HTTP response returned from the host. +// This is a stub implementation for non-WASM platforms. +type HTTPResponse struct { + status uint16 + headers map[string]string + body []byte + memory Memory +} + +// Status returns the status code from the response. +func (r HTTPResponse) Status() uint16 { + return r.status +} + +// Headers returns the HTTP response headers. +func (r *HTTPResponse) Headers() map[string]string { + return r.headers +} + +// Body returns the body byte slice from the response. +func (r HTTPResponse) Body() []byte { + return r.body +} + +// Memory returns the memory associated with the response. +func (r HTTPResponse) Memory() Memory { + return r.memory +} + +// NewStubHTTPResponse creates a new stub HTTPResponse for testing. +// This is a helper function not present in the real PDK. +func NewStubHTTPResponse(status uint16, headers map[string]string, body []byte) HTTPResponse { + return HTTPResponse{ + status: status, + headers: headers, + body: body, + memory: NewStubMemory(0, uint64(len(body)), body), + } +} diff --git a/plugins/pdk/go/scheduler/scheduler.go b/plugins/pdk/go/scheduler/scheduler.go new file mode 100644 index 000000000..b3dd67bd2 --- /dev/null +++ b/plugins/pdk/go/scheduler/scheduler.go @@ -0,0 +1,74 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the SchedulerCallback capability. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package scheduler + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// SchedulerCallbackRequest is the request provided when a scheduled task fires. +type SchedulerCallbackRequest struct { + // ScheduleID is the unique identifier for this scheduled task. + // This is either the ID provided when scheduling, or an auto-generated UUID if none was specified. + ScheduleID string `json:"scheduleId"` + // Payload is the payload data that was provided when the task was scheduled. + // Can be used to pass context or parameters to the callback handler. + Payload string `json:"payload"` + // IsRecurring is true if this is a recurring schedule (created via ScheduleRecurring), + // false if it's a one-time schedule (created via ScheduleOneTime). + IsRecurring bool `json:"isRecurring"` +} + +// Scheduler is the marker interface for scheduler plugins. +// Implement one or more of the provider interfaces below. +// SchedulerCallback provides scheduled task handling. +// This capability allows plugins to receive callbacks when their scheduled tasks execute. +// Plugins that use the scheduler host service must implement this capability +// to handle task execution. +type Scheduler interface{} + +// CallbackProvider provides the OnCallback function. +type CallbackProvider interface { + OnCallback(SchedulerCallbackRequest) error +} // Internal implementation holders +var ( + callbackImpl func(SchedulerCallbackRequest) error +) + +// Register registers a scheduler implementation. +// The implementation is checked for optional provider interfaces. +func Register(impl Scheduler) { + if p, ok := impl.(CallbackProvider); ok { + callbackImpl = p.OnCallback + } +} + +// NotImplementedCode is the standard return code for unimplemented functions. +// The host recognizes this and skips the plugin gracefully. +const NotImplementedCode int32 = -2 + +//go:wasmexport nd_scheduler_callback +func _NdSchedulerCallback() int32 { + if callbackImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input SchedulerCallbackRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + if err := callbackImpl(input); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} diff --git a/plugins/pdk/go/scheduler/scheduler_stub.go b/plugins/pdk/go/scheduler/scheduler_stub.go new file mode 100644 index 000000000..44b79c800 --- /dev/null +++ b/plugins/pdk/go/scheduler/scheduler_stub.go @@ -0,0 +1,42 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file provides stub implementations for non-WASM platforms. +// It allows Go plugins to compile and run tests outside of WASM, +// but the actual functionality is only available in WASM builds. +// +//go:build !wasip1 + +package scheduler + +// SchedulerCallbackRequest is the request provided when a scheduled task fires. +type SchedulerCallbackRequest struct { + // ScheduleID is the unique identifier for this scheduled task. + // This is either the ID provided when scheduling, or an auto-generated UUID if none was specified. + ScheduleID string `json:"scheduleId"` + // Payload is the payload data that was provided when the task was scheduled. + // Can be used to pass context or parameters to the callback handler. + Payload string `json:"payload"` + // IsRecurring is true if this is a recurring schedule (created via ScheduleRecurring), + // false if it's a one-time schedule (created via ScheduleOneTime). + IsRecurring bool `json:"isRecurring"` +} + +// Scheduler is the marker interface for scheduler plugins. +// Implement one or more of the provider interfaces below. +// SchedulerCallback provides scheduled task handling. +// This capability allows plugins to receive callbacks when their scheduled tasks execute. +// Plugins that use the scheduler host service must implement this capability +// to handle task execution. +type Scheduler interface{} + +// CallbackProvider provides the OnCallback function. +type CallbackProvider interface { + OnCallback(SchedulerCallbackRequest) error +} + +// NotImplementedCode is the standard return code for unimplemented functions. +const NotImplementedCode int32 = -2 + +// Register is a no-op on non-WASM platforms. +// This stub allows code to compile outside of WASM. +func Register(_ Scheduler) {} diff --git a/plugins/pdk/go/scrobbler/scrobbler.go b/plugins/pdk/go/scrobbler/scrobbler.go new file mode 100644 index 000000000..c694f59d8 --- /dev/null +++ b/plugins/pdk/go/scrobbler/scrobbler.go @@ -0,0 +1,197 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the Scrobbler capability. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package scrobbler + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// ScrobblerError represents an error type for scrobbling operations. +type ScrobblerError string + +const ( + // ScrobblerErrorNotAuthorized indicates the user is not authorized. + ScrobblerErrorNotAuthorized ScrobblerError = "scrobbler(not_authorized)" + // ScrobblerErrorRetryLater indicates the operation should be retried later. + ScrobblerErrorRetryLater ScrobblerError = "scrobbler(retry_later)" + // ScrobblerErrorUnrecoverable indicates an unrecoverable error. + ScrobblerErrorUnrecoverable ScrobblerError = "scrobbler(unrecoverable)" +) + +// Error implements the error interface for ScrobblerError. +func (e ScrobblerError) Error() string { return string(e) } + +// ArtistRef is a reference to an artist with name and optional MBID. +type ArtistRef struct { + // ID is the internal Navidrome artist ID (if known). + ID string `json:"id,omitempty"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the artist. + MBID string `json:"mbid,omitempty"` +} + +// IsAuthorizedRequest is the request for authorization check. +type IsAuthorizedRequest struct { + // Username is the username of the user. + Username string `json:"username"` +} + +// NowPlayingRequest is the request for now playing notification. +type NowPlayingRequest struct { + // Username is the username of the user. + Username string `json:"username"` + // Track is the track currently playing. + Track TrackInfo `json:"track"` + // Position is the current playback position in seconds. + Position int32 `json:"position"` +} + +// ScrobbleRequest is the request for submitting a scrobble. +type ScrobbleRequest struct { + // Username is the username of the user. + Username string `json:"username"` + // Track is the track that was played. + Track TrackInfo `json:"track"` + // Timestamp is the Unix timestamp when the track started playing. + Timestamp int64 `json:"timestamp"` +} + +// TrackInfo contains track metadata. +type TrackInfo struct { + // ID is the internal Navidrome track ID. + ID string `json:"id"` + // Title is the track title. + Title string `json:"title"` + // Album is the album name. + Album string `json:"album"` + // Artist is the formatted artist name for display (e.g., "Artist1 • Artist2"). + Artist string `json:"artist"` + // AlbumArtist is the formatted album artist name for display. + AlbumArtist string `json:"albumArtist"` + // Artists is the list of track artists. + Artists []ArtistRef `json:"artists"` + // AlbumArtists is the list of album artists. + AlbumArtists []ArtistRef `json:"albumArtists"` + // Duration is the track duration in seconds. + Duration float32 `json:"duration"` + // TrackNumber is the track number on the album. + TrackNumber int32 `json:"trackNumber"` + // DiscNumber is the disc number. + DiscNumber int32 `json:"discNumber"` + // MBZRecordingID is the MusicBrainz recording ID. + MBZRecordingID string `json:"mbzRecordingId,omitempty"` + // MBZAlbumID is the MusicBrainz album/release ID. + MBZAlbumID string `json:"mbzAlbumId,omitempty"` + // MBZReleaseGroupID is the MusicBrainz release group ID. + MBZReleaseGroupID string `json:"mbzReleaseGroupId,omitempty"` + // MBZReleaseTrackID is the MusicBrainz release track ID. + MBZReleaseTrackID string `json:"mbzReleaseTrackId,omitempty"` +} + +// Scrobbler requires all methods to be implemented. +// Scrobbler provides scrobbling functionality to external services. +// This capability allows plugins to submit listening history to services like Last.fm, +// ListenBrainz, or custom scrobbling backends. +// +// All methods are required - plugins implementing this capability must provide +// all three functions: IsAuthorized, NowPlaying, and Scrobble. +type Scrobbler interface { + // IsAuthorized - IsAuthorized checks if a user is authorized to scrobble to this service. + IsAuthorized(IsAuthorizedRequest) (bool, error) + // NowPlaying - NowPlaying sends a now playing notification to the scrobbling service. + NowPlaying(NowPlayingRequest) error + // Scrobble - Scrobble submits a completed scrobble to the scrobbling service. + Scrobble(ScrobbleRequest) error +} // Internal implementation holders +var ( + isAuthorizedImpl func(IsAuthorizedRequest) (bool, error) + nowPlayingImpl func(NowPlayingRequest) error + scrobbleImpl func(ScrobbleRequest) error +) + +// Register registers a scrobbler implementation. +// All methods are required. +func Register(impl Scrobbler) { + isAuthorizedImpl = impl.IsAuthorized + nowPlayingImpl = impl.NowPlaying + scrobbleImpl = impl.Scrobble +} + +// NotImplementedCode is the standard return code for unimplemented functions. +// The host recognizes this and skips the plugin gracefully. +const NotImplementedCode int32 = -2 + +//go:wasmexport nd_scrobbler_is_authorized +func _NdScrobblerIsAuthorized() int32 { + if isAuthorizedImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input IsAuthorizedRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := isAuthorizedImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_scrobbler_now_playing +func _NdScrobblerNowPlaying() int32 { + if nowPlayingImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input NowPlayingRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + if err := nowPlayingImpl(input); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_scrobbler_scrobble +func _NdScrobblerScrobble() int32 { + if scrobbleImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input ScrobbleRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + if err := scrobbleImpl(input); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} diff --git a/plugins/pdk/go/scrobbler/scrobbler_stub.go b/plugins/pdk/go/scrobbler/scrobbler_stub.go new file mode 100644 index 000000000..6d4afd818 --- /dev/null +++ b/plugins/pdk/go/scrobbler/scrobbler_stub.go @@ -0,0 +1,115 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file provides stub implementations for non-WASM platforms. +// It allows Go plugins to compile and run tests outside of WASM, +// but the actual functionality is only available in WASM builds. +// +//go:build !wasip1 + +package scrobbler + +// ScrobblerError represents an error type for scrobbling operations. +type ScrobblerError string + +const ( + // ScrobblerErrorNotAuthorized indicates the user is not authorized. + ScrobblerErrorNotAuthorized ScrobblerError = "scrobbler(not_authorized)" + // ScrobblerErrorRetryLater indicates the operation should be retried later. + ScrobblerErrorRetryLater ScrobblerError = "scrobbler(retry_later)" + // ScrobblerErrorUnrecoverable indicates an unrecoverable error. + ScrobblerErrorUnrecoverable ScrobblerError = "scrobbler(unrecoverable)" +) + +// Error implements the error interface for ScrobblerError. +func (e ScrobblerError) Error() string { return string(e) } + +// ArtistRef is a reference to an artist with name and optional MBID. +type ArtistRef struct { + // ID is the internal Navidrome artist ID (if known). + ID string `json:"id,omitempty"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the artist. + MBID string `json:"mbid,omitempty"` +} + +// IsAuthorizedRequest is the request for authorization check. +type IsAuthorizedRequest struct { + // Username is the username of the user. + Username string `json:"username"` +} + +// NowPlayingRequest is the request for now playing notification. +type NowPlayingRequest struct { + // Username is the username of the user. + Username string `json:"username"` + // Track is the track currently playing. + Track TrackInfo `json:"track"` + // Position is the current playback position in seconds. + Position int32 `json:"position"` +} + +// ScrobbleRequest is the request for submitting a scrobble. +type ScrobbleRequest struct { + // Username is the username of the user. + Username string `json:"username"` + // Track is the track that was played. + Track TrackInfo `json:"track"` + // Timestamp is the Unix timestamp when the track started playing. + Timestamp int64 `json:"timestamp"` +} + +// TrackInfo contains track metadata. +type TrackInfo struct { + // ID is the internal Navidrome track ID. + ID string `json:"id"` + // Title is the track title. + Title string `json:"title"` + // Album is the album name. + Album string `json:"album"` + // Artist is the formatted artist name for display (e.g., "Artist1 • Artist2"). + Artist string `json:"artist"` + // AlbumArtist is the formatted album artist name for display. + AlbumArtist string `json:"albumArtist"` + // Artists is the list of track artists. + Artists []ArtistRef `json:"artists"` + // AlbumArtists is the list of album artists. + AlbumArtists []ArtistRef `json:"albumArtists"` + // Duration is the track duration in seconds. + Duration float32 `json:"duration"` + // TrackNumber is the track number on the album. + TrackNumber int32 `json:"trackNumber"` + // DiscNumber is the disc number. + DiscNumber int32 `json:"discNumber"` + // MBZRecordingID is the MusicBrainz recording ID. + MBZRecordingID string `json:"mbzRecordingId,omitempty"` + // MBZAlbumID is the MusicBrainz album/release ID. + MBZAlbumID string `json:"mbzAlbumId,omitempty"` + // MBZReleaseGroupID is the MusicBrainz release group ID. + MBZReleaseGroupID string `json:"mbzReleaseGroupId,omitempty"` + // MBZReleaseTrackID is the MusicBrainz release track ID. + MBZReleaseTrackID string `json:"mbzReleaseTrackId,omitempty"` +} + +// Scrobbler requires all methods to be implemented. +// Scrobbler provides scrobbling functionality to external services. +// This capability allows plugins to submit listening history to services like Last.fm, +// ListenBrainz, or custom scrobbling backends. +// +// All methods are required - plugins implementing this capability must provide +// all three functions: IsAuthorized, NowPlaying, and Scrobble. +type Scrobbler interface { + // IsAuthorized - IsAuthorized checks if a user is authorized to scrobble to this service. + IsAuthorized(IsAuthorizedRequest) (bool, error) + // NowPlaying - NowPlaying sends a now playing notification to the scrobbling service. + NowPlaying(NowPlayingRequest) error + // Scrobble - Scrobble submits a completed scrobble to the scrobbling service. + Scrobble(ScrobbleRequest) error +} + +// NotImplementedCode is the standard return code for unimplemented functions. +const NotImplementedCode int32 = -2 + +// Register is a no-op on non-WASM platforms. +// This stub allows code to compile outside of WASM. +func Register(_ Scrobbler) {} diff --git a/plugins/pdk/go/taskworker/taskworker.go b/plugins/pdk/go/taskworker/taskworker.go new file mode 100644 index 000000000..5d09a3209 --- /dev/null +++ b/plugins/pdk/go/taskworker/taskworker.go @@ -0,0 +1,79 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the TaskWorker capability. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package taskworker + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// TaskExecuteRequest is the request provided when a task is ready to execute. +type TaskExecuteRequest struct { + // QueueName is the name of the queue this task belongs to. + QueueName string `json:"queueName"` + // TaskID is the unique identifier for this task. + TaskID string `json:"taskId"` + // Payload is the opaque data provided when the task was enqueued. + Payload []byte `json:"payload"` + // Attempt is the current attempt number (1-based: first attempt = 1). + Attempt int32 `json:"attempt"` +} + +// TaskWorker is the marker interface for taskworker plugins. +// Implement one or more of the provider interfaces below. +// TaskWorker provides task execution handling. +// This capability allows plugins to receive callbacks when their queued tasks +// are ready to execute. Plugins that use the taskqueue host service must +// implement this capability. +type TaskWorker interface{} + +// TaskExecuteProvider provides the OnTaskExecute function. +type TaskExecuteProvider interface { + OnTaskExecute(TaskExecuteRequest) (string, error) +} // Internal implementation holders +var ( + taskExecuteImpl func(TaskExecuteRequest) (string, error) +) + +// Register registers a taskworker implementation. +// The implementation is checked for optional provider interfaces. +func Register(impl TaskWorker) { + if p, ok := impl.(TaskExecuteProvider); ok { + taskExecuteImpl = p.OnTaskExecute + } +} + +// NotImplementedCode is the standard return code for unimplemented functions. +// The host recognizes this and skips the plugin gracefully. +const NotImplementedCode int32 = -2 + +//go:wasmexport nd_task_execute +func _NdTaskExecute() int32 { + if taskExecuteImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input TaskExecuteRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := taskExecuteImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} diff --git a/plugins/pdk/go/taskworker/taskworker_stub.go b/plugins/pdk/go/taskworker/taskworker_stub.go new file mode 100644 index 000000000..e45054e8e --- /dev/null +++ b/plugins/pdk/go/taskworker/taskworker_stub.go @@ -0,0 +1,41 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file provides stub implementations for non-WASM platforms. +// It allows Go plugins to compile and run tests outside of WASM, +// but the actual functionality is only available in WASM builds. +// +//go:build !wasip1 + +package taskworker + +// TaskExecuteRequest is the request provided when a task is ready to execute. +type TaskExecuteRequest struct { + // QueueName is the name of the queue this task belongs to. + QueueName string `json:"queueName"` + // TaskID is the unique identifier for this task. + TaskID string `json:"taskId"` + // Payload is the opaque data provided when the task was enqueued. + Payload []byte `json:"payload"` + // Attempt is the current attempt number (1-based: first attempt = 1). + Attempt int32 `json:"attempt"` +} + +// TaskWorker is the marker interface for taskworker plugins. +// Implement one or more of the provider interfaces below. +// TaskWorker provides task execution handling. +// This capability allows plugins to receive callbacks when their queued tasks +// are ready to execute. Plugins that use the taskqueue host service must +// implement this capability. +type TaskWorker interface{} + +// TaskExecuteProvider provides the OnTaskExecute function. +type TaskExecuteProvider interface { + OnTaskExecute(TaskExecuteRequest) (string, error) +} + +// NotImplementedCode is the standard return code for unimplemented functions. +const NotImplementedCode int32 = -2 + +// Register is a no-op on non-WASM platforms. +// This stub allows code to compile outside of WASM. +func Register(_ TaskWorker) {} diff --git a/plugins/pdk/go/websocket/websocket.go b/plugins/pdk/go/websocket/websocket.go new file mode 100644 index 000000000..47a53b7b3 --- /dev/null +++ b/plugins/pdk/go/websocket/websocket.go @@ -0,0 +1,187 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the WebSocketCallback capability. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package websocket + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// OnBinaryMessageRequest is the request provided when a binary message is received. +type OnBinaryMessageRequest struct { + // ConnectionID is the unique identifier for the WebSocket connection that received the message. + ConnectionID string `json:"connectionId"` + // Data is the binary data received from the WebSocket, encoded as base64. + Data []byte `json:"data"` +} + +// OnCloseRequest is the request provided when a WebSocket connection is closed. +type OnCloseRequest struct { + // ConnectionID is the unique identifier for the WebSocket connection that was closed. + ConnectionID string `json:"connectionId"` + // Code is the WebSocket close status code (e.g., 1000 for normal closure, + // 1001 for going away, 1006 for abnormal closure). + Code int32 `json:"code"` + // Reason is the human-readable reason for the connection closure, if provided. + Reason string `json:"reason"` +} + +// OnErrorRequest is the request provided when an error occurs on a WebSocket connection. +type OnErrorRequest struct { + // ConnectionID is the unique identifier for the WebSocket connection where the error occurred. + ConnectionID string `json:"connectionId"` + // Error is the error message describing what went wrong. + Error string `json:"error"` +} + +// OnTextMessageRequest is the request provided when a text message is received. +type OnTextMessageRequest struct { + // ConnectionID is the unique identifier for the WebSocket connection that received the message. + ConnectionID string `json:"connectionId"` + // Message is the text message content received from the WebSocket. + Message string `json:"message"` +} + +// WebSocket is the marker interface for websocket plugins. +// Implement one or more of the provider interfaces below. +// WebSocketCallback provides WebSocket message handling. +// This capability allows plugins to receive callbacks for WebSocket events +// such as text messages, binary messages, errors, and connection closures. +// Plugins that use the WebSocket host service must implement this capability +// to handle incoming events. +type WebSocket interface{} + +// TextMessageProvider provides the OnTextMessage function. +type TextMessageProvider interface { + OnTextMessage(OnTextMessageRequest) error +} + +// BinaryMessageProvider provides the OnBinaryMessage function. +type BinaryMessageProvider interface { + OnBinaryMessage(OnBinaryMessageRequest) error +} + +// ErrorProvider provides the OnError function. +type ErrorProvider interface { + OnError(OnErrorRequest) error +} + +// CloseProvider provides the OnClose function. +type CloseProvider interface { + OnClose(OnCloseRequest) error +} // Internal implementation holders +var ( + textMessageImpl func(OnTextMessageRequest) error + binaryMessageImpl func(OnBinaryMessageRequest) error + errorImpl func(OnErrorRequest) error + closeImpl func(OnCloseRequest) error +) + +// Register registers a websocket implementation. +// The implementation is checked for optional provider interfaces. +func Register(impl WebSocket) { + if p, ok := impl.(TextMessageProvider); ok { + textMessageImpl = p.OnTextMessage + } + if p, ok := impl.(BinaryMessageProvider); ok { + binaryMessageImpl = p.OnBinaryMessage + } + if p, ok := impl.(ErrorProvider); ok { + errorImpl = p.OnError + } + if p, ok := impl.(CloseProvider); ok { + closeImpl = p.OnClose + } +} + +// NotImplementedCode is the standard return code for unimplemented functions. +// The host recognizes this and skips the plugin gracefully. +const NotImplementedCode int32 = -2 + +//go:wasmexport nd_websocket_on_text_message +func _NdWebsocketOnTextMessage() int32 { + if textMessageImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input OnTextMessageRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + if err := textMessageImpl(input); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_websocket_on_binary_message +func _NdWebsocketOnBinaryMessage() int32 { + if binaryMessageImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input OnBinaryMessageRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + if err := binaryMessageImpl(input); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_websocket_on_error +func _NdWebsocketOnError() int32 { + if errorImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input OnErrorRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + if err := errorImpl(input); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_websocket_on_close +func _NdWebsocketOnClose() int32 { + if closeImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input OnCloseRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + if err := closeImpl(input); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} diff --git a/plugins/pdk/go/websocket/websocket_stub.go b/plugins/pdk/go/websocket/websocket_stub.go new file mode 100644 index 000000000..214118a89 --- /dev/null +++ b/plugins/pdk/go/websocket/websocket_stub.go @@ -0,0 +1,80 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file provides stub implementations for non-WASM platforms. +// It allows Go plugins to compile and run tests outside of WASM, +// but the actual functionality is only available in WASM builds. +// +//go:build !wasip1 + +package websocket + +// OnBinaryMessageRequest is the request provided when a binary message is received. +type OnBinaryMessageRequest struct { + // ConnectionID is the unique identifier for the WebSocket connection that received the message. + ConnectionID string `json:"connectionId"` + // Data is the binary data received from the WebSocket, encoded as base64. + Data []byte `json:"data"` +} + +// OnCloseRequest is the request provided when a WebSocket connection is closed. +type OnCloseRequest struct { + // ConnectionID is the unique identifier for the WebSocket connection that was closed. + ConnectionID string `json:"connectionId"` + // Code is the WebSocket close status code (e.g., 1000 for normal closure, + // 1001 for going away, 1006 for abnormal closure). + Code int32 `json:"code"` + // Reason is the human-readable reason for the connection closure, if provided. + Reason string `json:"reason"` +} + +// OnErrorRequest is the request provided when an error occurs on a WebSocket connection. +type OnErrorRequest struct { + // ConnectionID is the unique identifier for the WebSocket connection where the error occurred. + ConnectionID string `json:"connectionId"` + // Error is the error message describing what went wrong. + Error string `json:"error"` +} + +// OnTextMessageRequest is the request provided when a text message is received. +type OnTextMessageRequest struct { + // ConnectionID is the unique identifier for the WebSocket connection that received the message. + ConnectionID string `json:"connectionId"` + // Message is the text message content received from the WebSocket. + Message string `json:"message"` +} + +// WebSocket is the marker interface for websocket plugins. +// Implement one or more of the provider interfaces below. +// WebSocketCallback provides WebSocket message handling. +// This capability allows plugins to receive callbacks for WebSocket events +// such as text messages, binary messages, errors, and connection closures. +// Plugins that use the WebSocket host service must implement this capability +// to handle incoming events. +type WebSocket interface{} + +// TextMessageProvider provides the OnTextMessage function. +type TextMessageProvider interface { + OnTextMessage(OnTextMessageRequest) error +} + +// BinaryMessageProvider provides the OnBinaryMessage function. +type BinaryMessageProvider interface { + OnBinaryMessage(OnBinaryMessageRequest) error +} + +// ErrorProvider provides the OnError function. +type ErrorProvider interface { + OnError(OnErrorRequest) error +} + +// CloseProvider provides the OnClose function. +type CloseProvider interface { + OnClose(OnCloseRequest) error +} + +// NotImplementedCode is the standard return code for unimplemented functions. +const NotImplementedCode int32 = -2 + +// Register is a no-op on non-WASM platforms. +// This stub allows code to compile outside of WASM. +func Register(_ WebSocket) {} diff --git a/plugins/pdk/python/host/nd_host_artwork.py b/plugins/pdk/python/host/nd_host_artwork.py new file mode 100644 index 000000000..9bcb529ae --- /dev/null +++ b/plugins/pdk/python/host/nd_host_artwork.py @@ -0,0 +1,183 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Artwork host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "artwork_getartisturl") +def _artwork_getartisturl(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "artwork_getalbumurl") +def _artwork_getalbumurl(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "artwork_gettrackurl") +def _artwork_gettrackurl(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "artwork_getplaylisturl") +def _artwork_getplaylisturl(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def artwork_get_artist_url(id: str, size: int) -> str: + """GetArtistUrl generates a public URL for an artist's artwork. + +Parameters: + - id: The artist's unique identifier + - size: Desired image size in pixels (0 for original size) + +Returns the public URL for the artwork, or an error if generation fails. + + Args: + id: str parameter. + size: int parameter. + + Returns: + str: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "id": id, + "size": size, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _artwork_getartisturl(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("url", "") + + +def artwork_get_album_url(id: str, size: int) -> str: + """GetAlbumUrl generates a public URL for an album's artwork. + +Parameters: + - id: The album's unique identifier + - size: Desired image size in pixels (0 for original size) + +Returns the public URL for the artwork, or an error if generation fails. + + Args: + id: str parameter. + size: int parameter. + + Returns: + str: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "id": id, + "size": size, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _artwork_getalbumurl(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("url", "") + + +def artwork_get_track_url(id: str, size: int) -> str: + """GetTrackUrl generates a public URL for a track's artwork. + +Parameters: + - id: The track's (media file) unique identifier + - size: Desired image size in pixels (0 for original size) + +Returns the public URL for the artwork, or an error if generation fails. + + Args: + id: str parameter. + size: int parameter. + + Returns: + str: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "id": id, + "size": size, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _artwork_gettrackurl(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("url", "") + + +def artwork_get_playlist_url(id: str, size: int) -> str: + """GetPlaylistUrl generates a public URL for a playlist's artwork. + +Parameters: + - id: The playlist's unique identifier + - size: Desired image size in pixels (0 for original size) + +Returns the public URL for the artwork, or an error if generation fails. + + Args: + id: str parameter. + size: int parameter. + + Returns: + str: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "id": id, + "size": size, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _artwork_getplaylisturl(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("url", "") diff --git a/plugins/pdk/python/host/nd_host_cache.py b/plugins/pdk/python/host/nd_host_cache.py new file mode 100644 index 000000000..b24e983cc --- /dev/null +++ b/plugins/pdk/python/host/nd_host_cache.py @@ -0,0 +1,448 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Cache host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json +import base64 + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "cache_setstring") +def _cache_setstring(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "cache_getstring") +def _cache_getstring(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "cache_setint") +def _cache_setint(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "cache_getint") +def _cache_getint(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "cache_setfloat") +def _cache_setfloat(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "cache_getfloat") +def _cache_getfloat(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "cache_setbytes") +def _cache_setbytes(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "cache_getbytes") +def _cache_getbytes(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "cache_has") +def _cache_has(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "cache_remove") +def _cache_remove(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@dataclass +class CacheGetStringResult: + """Result type for cache_get_string.""" + value: str + exists: bool + + +@dataclass +class CacheGetIntResult: + """Result type for cache_get_int.""" + value: int + exists: bool + + +@dataclass +class CacheGetFloatResult: + """Result type for cache_get_float.""" + value: float + exists: bool + + +@dataclass +class CacheGetBytesResult: + """Result type for cache_get_bytes.""" + value: bytes + exists: bool + + +def cache_set_string(key: str, value: str, ttl_seconds: int) -> None: + """SetString stores a string value in the cache. + +Parameters: + - key: The cache key (will be namespaced with plugin ID) + - value: The string value to store + - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) + +Returns an error if the operation fails. + + Args: + key: str parameter. + value: str parameter. + ttl_seconds: int parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + "value": value, + "ttlSeconds": ttl_seconds, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _cache_setstring(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + + +def cache_get_string(key: str) -> CacheGetStringResult: + """GetString retrieves a string value from the cache. + +Parameters: + - key: The cache key (will be namespaced with plugin ID) + +Returns the value and whether the key exists. If the key doesn't exist +or the stored value is not a string, exists will be false. + + Args: + key: str parameter. + + Returns: + CacheGetStringResult containing value, exists,. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _cache_getstring(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return CacheGetStringResult( + value=response.get("value", ""), + exists=response.get("exists", False), + ) + + +def cache_set_int(key: str, value: int, ttl_seconds: int) -> None: + """SetInt stores an integer value in the cache. + +Parameters: + - key: The cache key (will be namespaced with plugin ID) + - value: The integer value to store + - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) + +Returns an error if the operation fails. + + Args: + key: str parameter. + value: int parameter. + ttl_seconds: int parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + "value": value, + "ttlSeconds": ttl_seconds, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _cache_setint(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + + +def cache_get_int(key: str) -> CacheGetIntResult: + """GetInt retrieves an integer value from the cache. + +Parameters: + - key: The cache key (will be namespaced with plugin ID) + +Returns the value and whether the key exists. If the key doesn't exist +or the stored value is not an integer, exists will be false. + + Args: + key: str parameter. + + Returns: + CacheGetIntResult containing value, exists,. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _cache_getint(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return CacheGetIntResult( + value=response.get("value", 0), + exists=response.get("exists", False), + ) + + +def cache_set_float(key: str, value: float, ttl_seconds: int) -> None: + """SetFloat stores a float value in the cache. + +Parameters: + - key: The cache key (will be namespaced with plugin ID) + - value: The float value to store + - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) + +Returns an error if the operation fails. + + Args: + key: str parameter. + value: float parameter. + ttl_seconds: int parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + "value": value, + "ttlSeconds": ttl_seconds, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _cache_setfloat(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + + +def cache_get_float(key: str) -> CacheGetFloatResult: + """GetFloat retrieves a float value from the cache. + +Parameters: + - key: The cache key (will be namespaced with plugin ID) + +Returns the value and whether the key exists. If the key doesn't exist +or the stored value is not a float, exists will be false. + + Args: + key: str parameter. + + Returns: + CacheGetFloatResult containing value, exists,. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _cache_getfloat(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return CacheGetFloatResult( + value=response.get("value", 0.0), + exists=response.get("exists", False), + ) + + +def cache_set_bytes(key: str, value: bytes, ttl_seconds: int) -> None: + """SetBytes stores a byte slice in the cache. + +Parameters: + - key: The cache key (will be namespaced with plugin ID) + - value: The byte slice to store + - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) + +Returns an error if the operation fails. + + Args: + key: str parameter. + value: bytes parameter. + ttl_seconds: int parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + "value": base64.b64encode(value).decode("ascii"), + "ttlSeconds": ttl_seconds, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _cache_setbytes(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + + +def cache_get_bytes(key: str) -> CacheGetBytesResult: + """GetBytes retrieves a byte slice from the cache. + +Parameters: + - key: The cache key (will be namespaced with plugin ID) + +Returns the value and whether the key exists. If the key doesn't exist +or the stored value is not a byte slice, exists will be false. + + Args: + key: str parameter. + + Returns: + CacheGetBytesResult containing value, exists,. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _cache_getbytes(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return CacheGetBytesResult( + value=base64.b64decode(response.get("value", "")), + exists=response.get("exists", False), + ) + + +def cache_has(key: str) -> bool: + """Has checks if a key exists in the cache. + +Parameters: + - key: The cache key (will be namespaced with plugin ID) + +Returns true if the key exists and has not expired. + + Args: + key: str parameter. + + Returns: + bool: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _cache_has(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("exists", False) + + +def cache_remove(key: str) -> None: + """Remove deletes a value from the cache. + +Parameters: + - key: The cache key (will be namespaced with plugin ID) + +Returns an error if the operation fails. Does not return an error if the key doesn't exist. + + Args: + key: str parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _cache_remove(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + diff --git a/plugins/pdk/python/host/nd_host_config.py b/plugins/pdk/python/host/nd_host_config.py new file mode 100644 index 000000000..1dab2fe0e --- /dev/null +++ b/plugins/pdk/python/host/nd_host_config.py @@ -0,0 +1,145 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Config host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "config_get") +def _config_get(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "config_getint") +def _config_getint(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "config_keys") +def _config_keys(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@dataclass +class ConfigGetResult: + """Result type for config_get.""" + value: str + exists: bool + + +@dataclass +class ConfigGetIntResult: + """Result type for config_get_int.""" + value: int + exists: bool + + +def config_get(key: str) -> ConfigGetResult: + """Get retrieves a configuration value as a string. + +Parameters: + - key: The configuration key + +Returns the value and whether the key exists. + + Args: + key: str parameter. + + Returns: + ConfigGetResult containing value, exists,. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _config_get(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + return ConfigGetResult( + value=response.get("value", ""), + exists=response.get("exists", False), + ) + + +def config_get_int(key: str) -> ConfigGetIntResult: + """GetInt retrieves a configuration value as an integer. + +Parameters: + - key: The configuration key + +Returns the value and whether the key exists. If the key exists but the +value cannot be parsed as an integer, exists will be false. + + Args: + key: str parameter. + + Returns: + ConfigGetIntResult containing value, exists,. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _config_getint(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + return ConfigGetIntResult( + value=response.get("value", 0), + exists=response.get("exists", False), + ) + + +def config_keys(prefix: str) -> Any: + """Keys returns configuration keys matching the given prefix. + +Parameters: + - prefix: Key prefix to filter by. If empty, returns all keys. + +Returns a sorted slice of matching configuration keys. + + Args: + prefix: str parameter. + + Returns: + Any: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "prefix": prefix, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _config_keys(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + return response.get("keys", None) diff --git a/plugins/pdk/python/host/nd_host_http.py b/plugins/pdk/python/host/nd_host_http.py new file mode 100644 index 000000000..a806c8456 --- /dev/null +++ b/plugins/pdk/python/host/nd_host_http.py @@ -0,0 +1,60 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the HTTP host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json +import base64 + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "http_send") +def _http_send(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def http_send(request: Any) -> Any: + """Send executes an HTTP request and returns the response. + +Parameters: + - request: The HTTP request to execute, including method, URL, headers, body, and timeout + +Returns the HTTP response with status code, headers, and body. +Network errors, timeouts, and permission failures are returned as Go errors. +Successful HTTP calls (including 4xx/5xx status codes) return a non-nil response with nil error. + + Args: + request: Any parameter. + + Returns: + Any: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "request": request, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _http_send(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("result", None) diff --git a/plugins/pdk/python/host/nd_host_httpclient.py b/plugins/pdk/python/host/nd_host_httpclient.py new file mode 100644 index 000000000..c6bfb77c0 --- /dev/null +++ b/plugins/pdk/python/host/nd_host_httpclient.py @@ -0,0 +1,59 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the HTTP host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "http_send") +def _http_send(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def http_send(request: Any) -> Any: + """Send executes an HTTP request and returns the response. + +Parameters: + - request: The HTTP request to execute, including method, URL, headers, body, and timeout + +Returns the HTTP response with status code, headers, and body. +Network errors, timeouts, and permission failures are returned as errors. +Successful HTTP calls (including 4xx/5xx status codes) return a non-nil response with nil error. + + Args: + request: Any parameter. + + Returns: + Any: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "request": request, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _http_send(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("result", None) diff --git a/plugins/pdk/python/host/nd_host_kvstore.py b/plugins/pdk/python/host/nd_host_kvstore.py new file mode 100644 index 000000000..33eaffc52 --- /dev/null +++ b/plugins/pdk/python/host/nd_host_kvstore.py @@ -0,0 +1,362 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the KVStore host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json +import base64 + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "kvstore_set") +def _kvstore_set(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "kvstore_setwithttl") +def _kvstore_setwithttl(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "kvstore_get") +def _kvstore_get(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "kvstore_getmany") +def _kvstore_getmany(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "kvstore_has") +def _kvstore_has(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "kvstore_list") +def _kvstore_list(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "kvstore_delete") +def _kvstore_delete(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "kvstore_deletebyprefix") +def _kvstore_deletebyprefix(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "kvstore_getstorageused") +def _kvstore_getstorageused(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@dataclass +class KVStoreGetResult: + """Result type for kvstore_get.""" + value: bytes + exists: bool + + +def kvstore_set(key: str, value: bytes) -> None: + """Set stores a byte value with the given key. + +Parameters: + - key: The storage key (max 256 bytes, UTF-8) + - value: The byte slice to store + +Returns an error if the storage limit would be exceeded or the operation fails. + + Args: + key: str parameter. + value: bytes parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + "value": base64.b64encode(value).decode("ascii"), + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _kvstore_set(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + + +def kvstore_set_with_ttl(key: str, value: bytes, ttl_seconds: int) -> None: + """SetWithTTL stores a byte value with the given key and a time-to-live. + +After ttlSeconds, the key is treated as non-existent and will be +cleaned up lazily. ttlSeconds must be greater than 0. + +Parameters: + - key: The storage key (max 256 bytes, UTF-8) + - value: The byte slice to store + - ttlSeconds: Time-to-live in seconds (must be > 0) + +Returns an error if the storage limit would be exceeded or the operation fails. + + Args: + key: str parameter. + value: bytes parameter. + ttl_seconds: int parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + "value": base64.b64encode(value).decode("ascii"), + "ttlSeconds": ttl_seconds, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _kvstore_setwithttl(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + + +def kvstore_get(key: str) -> KVStoreGetResult: + """Get retrieves a byte value from storage. + +Parameters: + - key: The storage key + +Returns the value and whether the key exists. + + Args: + key: str parameter. + + Returns: + KVStoreGetResult containing value, exists,. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _kvstore_get(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return KVStoreGetResult( + value=base64.b64decode(response.get("value", "")), + exists=response.get("exists", False), + ) + + +def kvstore_get_many(keys: Any) -> Any: + """GetMany retrieves multiple values in a single call. + +Parameters: + - keys: The storage keys to retrieve + +Returns a map of key to value for keys that exist and have not expired. +Missing or expired keys are omitted from the result. + + Args: + keys: Any parameter. + + Returns: + Any: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "keys": keys, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _kvstore_getmany(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("values", None) + + +def kvstore_has(key: str) -> bool: + """Has checks if a key exists in storage. + +Parameters: + - key: The storage key + +Returns true if the key exists. + + Args: + key: str parameter. + + Returns: + bool: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _kvstore_has(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("exists", False) + + +def kvstore_list(prefix: str) -> Any: + """List returns all keys matching the given prefix. + +Parameters: + - prefix: Key prefix to filter by (empty string returns all keys) + +Returns a slice of matching keys. + + Args: + prefix: str parameter. + + Returns: + Any: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "prefix": prefix, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _kvstore_list(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("keys", None) + + +def kvstore_delete(key: str) -> None: + """Delete removes a value from storage. + +Parameters: + - key: The storage key + +Returns an error if the operation fails. Does not return an error if the key doesn't exist. + + Args: + key: str parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _kvstore_delete(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + + +def kvstore_delete_by_prefix(prefix: str) -> int: + """DeleteByPrefix removes all keys matching the given prefix. + +Parameters: + - prefix: Key prefix to match (must not be empty) + +Returns the number of keys deleted. Includes expired keys. + + Args: + prefix: str parameter. + + Returns: + int: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "prefix": prefix, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _kvstore_deletebyprefix(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("deletedCount", 0) + + +def kvstore_get_storage_used() -> int: + """GetStorageUsed returns the total storage used by this plugin in bytes. + + Returns: + int: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request_bytes = b"{}" + request_mem = extism.memory.alloc(request_bytes) + response_offset = _kvstore_getstorageused(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("bytes", 0) diff --git a/plugins/pdk/python/host/nd_host_library.py b/plugins/pdk/python/host/nd_host_library.py new file mode 100644 index 000000000..12e1bc4eb --- /dev/null +++ b/plugins/pdk/python/host/nd_host_library.py @@ -0,0 +1,86 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Library host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "library_getlibrary") +def _library_getlibrary(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "library_getalllibraries") +def _library_getalllibraries(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def library_get_library(id: int) -> Any: + """GetLibrary retrieves metadata for a specific library by ID. + +Parameters: + - id: The library's unique identifier + +Returns the library metadata, or an error if the library is not found. + + Args: + id: int parameter. + + Returns: + Any: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "id": id, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _library_getlibrary(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("result", None) + + +def library_get_all_libraries() -> Any: + """GetAllLibraries retrieves metadata for all configured libraries. + +Returns a slice of all libraries with their metadata. + + Returns: + Any: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request_bytes = b"{}" + request_mem = extism.memory.alloc(request_bytes) + response_offset = _library_getalllibraries(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("result", None) diff --git a/plugins/pdk/python/host/nd_host_scheduler.py b/plugins/pdk/python/host/nd_host_scheduler.py new file mode 100644 index 000000000..7f0d19241 --- /dev/null +++ b/plugins/pdk/python/host/nd_host_scheduler.py @@ -0,0 +1,143 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Scheduler host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "scheduler_scheduleonetime") +def _scheduler_scheduleonetime(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "scheduler_schedulerecurring") +def _scheduler_schedulerecurring(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "scheduler_cancelschedule") +def _scheduler_cancelschedule(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def scheduler_schedule_one_time(delay_seconds: int, payload: str, schedule_id: str) -> str: + """ScheduleOneTime schedules a one-time event to be triggered after the specified delay. +Plugins that use this function must also implement the SchedulerCallback capability + +Parameters: + - delaySeconds: Number of seconds to wait before triggering the event + - payload: Data to be passed to the scheduled event handler + - scheduleID: Optional unique identifier for the scheduled job. If empty, one will be generated + +Returns the schedule ID that can be used to cancel the job, or an error if scheduling fails. + + Args: + delay_seconds: int parameter. + payload: str parameter. + schedule_id: str parameter. + + Returns: + str: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "delaySeconds": delay_seconds, + "payload": payload, + "scheduleId": schedule_id, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _scheduler_scheduleonetime(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("newScheduleId", "") + + +def scheduler_schedule_recurring(cron_expression: str, payload: str, schedule_id: str) -> str: + """ScheduleRecurring schedules a recurring event using a cron expression. +Plugins that use this function must also implement the SchedulerCallback capability + +Parameters: + - cronExpression: Standard cron format expression (e.g., "0 0 * * *" for daily at midnight) + - payload: Data to be passed to each scheduled event handler invocation + - scheduleID: Optional unique identifier for the scheduled job. If empty, one will be generated + +Returns the schedule ID that can be used to cancel the job, or an error if scheduling fails. + + Args: + cron_expression: str parameter. + payload: str parameter. + schedule_id: str parameter. + + Returns: + str: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "cronExpression": cron_expression, + "payload": payload, + "scheduleId": schedule_id, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _scheduler_schedulerecurring(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("newScheduleId", "") + + +def scheduler_cancel_schedule(schedule_id: str) -> None: + """CancelSchedule cancels a scheduled job identified by its schedule ID. + +This works for both one-time and recurring schedules. Once cancelled, the job will not trigger +any future events. + +Returns an error if the schedule ID is not found or if cancellation fails. + + Args: + schedule_id: str parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "scheduleId": schedule_id, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _scheduler_cancelschedule(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + diff --git a/plugins/pdk/python/host/nd_host_subsonicapi.py b/plugins/pdk/python/host/nd_host_subsonicapi.py new file mode 100644 index 000000000..cf35bc043 --- /dev/null +++ b/plugins/pdk/python/host/nd_host_subsonicapi.py @@ -0,0 +1,101 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the SubsonicAPI host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json +import base64 + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "subsonicapi_call") +def _subsonicapi_call(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "subsonicapi_callraw") +def _subsonicapi_callraw(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@dataclass +class SubsonicAPICallRawResult: + """Result type for subsonicapi_call_raw.""" + content_type: str + data: bytes + + +def subsonicapi_call(uri: str) -> str: + """Call executes a Subsonic API request and returns the JSON response. + +The uri parameter should be the Subsonic API path without the server prefix, +e.g., "getAlbumList2?type=random&size=10". The response is returned as raw JSON. + + Args: + uri: str parameter. + + Returns: + str: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "uri": uri, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _subsonicapi_call(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("responseJson", "") + + +def subsonicapi_call_raw(uri: str) -> SubsonicAPICallRawResult: + """CallRaw executes a Subsonic API request and returns the raw binary response. +Designed for binary endpoints like getCoverArt and stream that return +non-JSON data. The data is base64-encoded over JSON on the wire. + + Args: + uri: str parameter. + + Returns: + SubsonicAPICallRawResult containing content_type, data,. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "uri": uri, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _subsonicapi_callraw(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return SubsonicAPICallRawResult( + content_type=response.get("contentType", ""), + data=base64.b64decode(response.get("data", "")), + ) diff --git a/plugins/pdk/python/host/nd_host_task.py b/plugins/pdk/python/host/nd_host_task.py new file mode 100644 index 000000000..5d6e7474c --- /dev/null +++ b/plugins/pdk/python/host/nd_host_task.py @@ -0,0 +1,188 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Task host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json +import base64 + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "task_createqueue") +def _task_createqueue(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "task_enqueue") +def _task_enqueue(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "task_get") +def _task_get(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "task_cancel") +def _task_cancel(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "task_clearqueue") +def _task_clearqueue(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def task_create_queue(name: str, config: Any) -> None: + """CreateQueue creates a named task queue with the given configuration. +Zero-value fields in config use sensible defaults. +If a queue with the same name already exists, returns an error. +On startup, this also recovers any stale "running" tasks from a previous crash. + + Args: + name: str parameter. + config: Any parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "name": name, + "config": config, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _task_createqueue(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + + +def task_enqueue(queue_name: str, payload: bytes) -> str: + """Enqueue adds a task to the named queue. Returns the task ID. +payload is opaque bytes passed back to the plugin on execution. + + Args: + queue_name: str parameter. + payload: bytes parameter. + + Returns: + str: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "queueName": queue_name, + "payload": base64.b64encode(payload).decode("ascii"), + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _task_enqueue(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("result", "") + + +def task_get(task_id: str) -> Any: + """Get returns the current state of a task including its status, +message, and attempt count. + + Args: + task_id: str parameter. + + Returns: + Any: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "taskId": task_id, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _task_get(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("result", None) + + +def task_cancel(task_id: str) -> None: + """Cancel cancels a pending task. Returns error if already +running, completed, or failed. + + Args: + task_id: str parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "taskId": task_id, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _task_cancel(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + + +def task_clear_queue(queue_name: str) -> int: + """ClearQueue removes all pending tasks from the named queue. +Running tasks are not affected. Returns the number of tasks removed. + + Args: + queue_name: str parameter. + + Returns: + int: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "queueName": queue_name, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _task_clearqueue(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("result", 0) diff --git a/plugins/pdk/python/host/nd_host_users.py b/plugins/pdk/python/host/nd_host_users.py new file mode 100644 index 000000000..a325156a7 --- /dev/null +++ b/plugins/pdk/python/host/nd_host_users.py @@ -0,0 +1,80 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Users host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "users_getusers") +def _users_getusers(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "users_getadmins") +def _users_getadmins(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def users_get_users() -> Any: + """GetUsers returns all users the plugin has been granted access to. +Only minimal user information (userName, name, isAdmin) is returned. +Sensitive fields like password and email are never exposed. + +Returns a slice of users the plugin can access, or an empty slice if none configured. + + Returns: + Any: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request_bytes = b"{}" + request_mem = extism.memory.alloc(request_bytes) + response_offset = _users_getusers(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("result", None) + + +def users_get_admins() -> Any: + """GetAdmins returns only admin users the plugin has been granted access to. +This is a convenience method that filters GetUsers results to include only admins. + +Returns a slice of admin users the plugin can access, or an empty slice if none. + + Returns: + Any: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request_bytes = b"{}" + request_mem = extism.memory.alloc(request_bytes) + response_offset = _users_getadmins(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("result", None) diff --git a/plugins/pdk/python/host/nd_host_websocket.py b/plugins/pdk/python/host/nd_host_websocket.py new file mode 100644 index 000000000..4e882914c --- /dev/null +++ b/plugins/pdk/python/host/nd_host_websocket.py @@ -0,0 +1,182 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the WebSocket host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json +import base64 + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "websocket_connect") +def _websocket_connect(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "websocket_sendtext") +def _websocket_sendtext(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "websocket_sendbinary") +def _websocket_sendbinary(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "websocket_closeconnection") +def _websocket_closeconnection(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def websocket_connect(url: str, headers: Any, connection_id: str) -> str: + """Connect establishes a WebSocket connection to the specified URL. + +Plugins that use this function must also implement the WebSocketCallback capability +to receive incoming messages and connection events. + +Parameters: + - url: The WebSocket URL to connect to (ws:// or wss://) + - headers: Optional HTTP headers to include in the handshake request + - connectionID: Optional unique identifier for the connection. If empty, one will be generated + +Returns the connection ID that can be used to send messages or close the connection, +or an error if the connection fails. + + Args: + url: str parameter. + headers: Any parameter. + connection_id: str parameter. + + Returns: + str: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "url": url, + "headers": headers, + "connectionId": connection_id, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _websocket_connect(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("newConnectionId", "") + + +def websocket_send_text(connection_id: str, message: str) -> None: + """SendText sends a text message over an established WebSocket connection. + +Parameters: + - connectionID: The connection identifier returned by Connect + - message: The text message to send + +Returns an error if the connection is not found or if sending fails. + + Args: + connection_id: str parameter. + message: str parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "connectionId": connection_id, + "message": message, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _websocket_sendtext(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + + +def websocket_send_binary(connection_id: str, data: bytes) -> None: + """SendBinary sends binary data over an established WebSocket connection. + +Parameters: + - connectionID: The connection identifier returned by Connect + - data: The binary data to send + +Returns an error if the connection is not found or if sending fails. + + Args: + connection_id: str parameter. + data: bytes parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "connectionId": connection_id, + "data": base64.b64encode(data).decode("ascii"), + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _websocket_sendbinary(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + + +def websocket_close_connection(connection_id: str, code: int, reason: str) -> None: + """CloseConnection gracefully closes a WebSocket connection. + +Parameters: + - connectionID: The connection identifier returned by Connect + - code: WebSocket close status code (e.g., 1000 for normal closure) + - reason: Optional human-readable reason for closing + +Returns an error if the connection is not found or if closing fails. + + Args: + connection_id: str parameter. + code: int parameter. + reason: str parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "connectionId": connection_id, + "code": code, + "reason": reason, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _websocket_closeconnection(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + diff --git a/plugins/pdk/rust/README.md b/plugins/pdk/rust/README.md new file mode 100644 index 000000000..891465cc5 --- /dev/null +++ b/plugins/pdk/rust/README.md @@ -0,0 +1,145 @@ +# Navidrome Plugin Development Kit for Rust + +This directory contains the Rust PDK crates for building Navidrome plugins. + +## Crate Structure + +``` +plugins/pdk/rust/ +├── nd-pdk/ # Umbrella crate - use this as your dependency +├── nd-pdk-host/ # Host function wrappers (call Navidrome services) +└── nd-pdk-capabilities/ # Capability traits and types (generated) +``` + +## Usage + +Add the `nd-pdk` crate as a dependency in your plugin's `Cargo.toml`: + +```toml +[package] +name = "my-plugin" +edition = "2021" + +[lib] +crate-type = ["cdylib"] + +[dependencies] +nd-pdk = { path = "../../pdk/rust/nd-pdk" } +extism-pdk = "1.2" +``` + +### Implementing a Scrobbler (Required-All Pattern) + +The Scrobbler capability requires all methods to be implemented: + +```rust +use nd_pdk::scrobbler::{ + Error, IsAuthorizedRequest, + NowPlayingRequest, ScrobbleRequest, Scrobbler, +}; + +// Register WASM exports for all Scrobbler methods +nd_pdk::register_scrobbler!(MyPlugin); + +#[derive(Default)] +struct MyPlugin; + +impl Scrobbler for MyPlugin { + fn is_authorized(&self, req: IsAuthorizedRequest) -> Result<bool, Error> { + Ok(true) + } + + fn now_playing(&self, req: NowPlayingRequest) -> Result<(), Error> { + // Handle now playing notification + Ok(()) + } + + fn scrobble(&self, req: ScrobbleRequest) -> Result<(), Error> { + // Submit scrobble + Ok(()) + } +} +``` + +### Implementing Metadata Agent (Optional Pattern) + +The MetadataAgent capability allows implementing individual methods: + +```rust +use nd_pdk::metadata::{ + ArtistBiographyProvider, GetArtistBiographyRequest, ArtistBiography, Error, +}; + +// Register only the methods you implement +nd_pdk::register_artist_biography!(MyPlugin); + +#[derive(Default)] +struct MyPlugin; + +impl ArtistBiographyProvider for MyPlugin { + fn get_artist_biography(&self, req: GetArtistBiographyRequest) + -> Result<ArtistBiography, Error> + { + // Return artist biography + Ok(ArtistBiography { + biography: "Artist bio text...".into(), + ..Default::default() + }) + } +} +``` + +### Using Host Services + +Access Navidrome services via the host module: + +```rust +use nd_pdk::host::{artwork, scheduler, library}; + +// Get artwork URL for a track +let url = artwork::get_track_url("track-id", 300)?; + +// Schedule a one-time callback +scheduler::schedule_one_time(60, "my-payload", "schedule-id")?; + +// Get library information +let libs = library::get_all()?; +``` + +## Available Capabilities + +| Capability | Pattern | Description | +|-------------|--------------|-----------------------------------------------------| +| `scrobbler` | Required-all | Submit listening history to external services | +| `metadata` | Optional | Provide artist/album metadata from external sources | +| `lifecycle` | Optional | Handle plugin initialization | +| `scheduler` | Optional | Receive scheduled callbacks | +| `websocket` | Optional | Handle WebSocket messages | + +## Building + +Rust plugins must be compiled to WASM using the `wasm32-wasip1` target: + +```bash +cargo build --release --target wasm32-wasip1 +``` + +The resulting `.wasm` file can be packaged into an `.ndp` plugin package. + +## Examples + +See the example plugins for complete implementations: + +- [webhook-rs](../../examples/webhook-rs/) - Simple scrobbler using the PDK +- [discord-rich-presence-rs](../../examples/discord-rich-presence-rs/) - Complex plugin with multiple capabilities +- [library-inspector-rs](../../examples/library-inspector-rs/) - Host service demonstration + +## Code Generation + +The capability modules in `nd-pdk-capabilities` are auto-generated from the Go capability definitions. To regenerate after capability changes: + +```bash +make gen +``` + +This generates both Go and Rust PDK code. diff --git a/plugins/pdk/rust/nd-pdk-capabilities/Cargo.toml b/plugins/pdk/rust/nd-pdk-capabilities/Cargo.toml new file mode 100644 index 000000000..443f19da5 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-capabilities/Cargo.toml @@ -0,0 +1,17 @@ +[package] +name = "nd-pdk-capabilities" +version = "0.1.0" +edition = "2021" +description = "Navidrome capability wrappers for Rust plugins" +authors = ["Navidrome Team"] +license = "GPL-3.0" + +[lib] +path = "src/lib.rs" +crate-type = ["rlib"] + +[dependencies] +base64 = "0.22" +extism-pdk = "1.2" +serde = { version = "1.0", features = ["derive"] } +serde_json = "1.0" diff --git a/plugins/pdk/rust/nd-pdk-capabilities/src/lib.rs b/plugins/pdk/rust/nd-pdk-capabilities/src/lib.rs new file mode 100644 index 000000000..85375b525 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-capabilities/src/lib.rs @@ -0,0 +1,14 @@ +// Code generated by ndpgen. DO NOT EDIT. + +//! Navidrome Plugin Development Kit - Capability Wrappers +//! +//! This crate provides type definitions, traits, and registration macros +//! for implementing Navidrome plugin capabilities in Rust. + +pub mod lifecycle; +pub mod lyrics; +pub mod metadata; +pub mod scheduler; +pub mod scrobbler; +pub mod taskworker; +pub mod websocket; diff --git a/plugins/pdk/rust/nd-pdk-capabilities/src/lifecycle.rs b/plugins/pdk/rust/nd-pdk-capabilities/src/lifecycle.rs new file mode 100644 index 000000000..87b5485ba --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-capabilities/src/lifecycle.rs @@ -0,0 +1,45 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the Lifecycle capability. +// It is intended for use in Navidrome plugins built with extism-pdk. + + +/// Error represents an error from a capability method. +#[derive(Debug)] +pub struct Error { + pub message: String, +} + +impl std::fmt::Display for Error { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.message) + } +} + +impl std::error::Error for Error {} + +impl Error { + pub fn new(message: impl Into<String>) -> Self { + Self { message: message.into() } + } +} + +/// InitProvider provides the OnInit function. +pub trait InitProvider { + fn on_init(&self) -> Result<(), Error>; +} + +/// Register the on_init export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_lifecycle_init { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_on_init( + ) -> extism_pdk::FnResult<()> { + let plugin = <$plugin_type>::default(); + $crate::lifecycle::InitProvider::on_init(&plugin)?; + Ok(()) + } + }; +} diff --git a/plugins/pdk/rust/nd-pdk-capabilities/src/lyrics.rs b/plugins/pdk/rust/nd-pdk-capabilities/src/lyrics.rs new file mode 100644 index 000000000..16882abae --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-capabilities/src/lyrics.rs @@ -0,0 +1,148 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the Lyrics capability. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use serde::{Deserialize, Serialize}; + +// Helper functions for skip_serializing_if with numeric types +#[allow(dead_code)] +fn is_zero_i32(value: &i32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u32(value: &u32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_i64(value: &i64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u64(value: &u64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_f32(value: &f32) -> bool { *value == 0.0 } +#[allow(dead_code)] +fn is_zero_f64(value: &f64) -> bool { *value == 0.0 } +/// ArtistRef is a reference to an artist with name and optional MBID. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ArtistRef { + /// ID is the internal Navidrome artist ID (if known). + #[serde(default, skip_serializing_if = "String::is_empty")] + pub id: String, + /// Name is the artist name. + #[serde(default)] + pub name: String, + /// MBID is the MusicBrainz ID for the artist. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbid: String, +} +/// GetLyricsRequest contains the track information for lyrics lookup. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct GetLyricsRequest { + #[serde(default)] + pub track: TrackInfo, +} +/// GetLyricsResponse contains the lyrics returned by the plugin. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct GetLyricsResponse { + #[serde(default)] + pub lyrics: Vec<LyricsText>, +} +/// LyricsText represents a single set of lyrics in raw text format. +/// Text can be plain text or LRC format — Navidrome will parse it. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct LyricsText { + #[serde(default, skip_serializing_if = "String::is_empty")] + pub lang: String, + #[serde(default)] + pub text: String, +} +/// TrackInfo contains track metadata. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TrackInfo { + /// ID is the internal Navidrome track ID. + #[serde(default)] + pub id: String, + /// Title is the track title. + #[serde(default)] + pub title: String, + /// Album is the album name. + #[serde(default)] + pub album: String, + /// Artist is the formatted artist name for display (e.g., "Artist1 • Artist2"). + #[serde(default)] + pub artist: String, + /// AlbumArtist is the formatted album artist name for display. + #[serde(default)] + pub album_artist: String, + /// Artists is the list of track artists. + #[serde(default)] + pub artists: Vec<ArtistRef>, + /// AlbumArtists is the list of album artists. + #[serde(default)] + pub album_artists: Vec<ArtistRef>, + /// Duration is the track duration in seconds. + #[serde(default)] + pub duration: f32, + /// TrackNumber is the track number on the album. + #[serde(default)] + pub track_number: i32, + /// DiscNumber is the disc number. + #[serde(default)] + pub disc_number: i32, + /// MBZRecordingID is the MusicBrainz recording ID. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbz_recording_id: String, + /// MBZAlbumID is the MusicBrainz album/release ID. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbz_album_id: String, + /// MBZReleaseGroupID is the MusicBrainz release group ID. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbz_release_group_id: String, + /// MBZReleaseTrackID is the MusicBrainz release track ID. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbz_release_track_id: String, +} + +/// Error represents an error from a capability method. +#[derive(Debug)] +pub struct Error { + pub message: String, +} + +impl std::fmt::Display for Error { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.message) + } +} + +impl std::error::Error for Error {} + +impl Error { + pub fn new(message: impl Into<String>) -> Self { + Self { message: message.into() } + } +} + +/// Lyrics requires all methods to be implemented. +/// Lyrics provides lyrics for a given track from external sources. +pub trait Lyrics { + /// GetLyrics + fn get_lyrics(&self, req: GetLyricsRequest) -> Result<GetLyricsResponse, Error>; +} + +/// Register all exports for the Lyrics capability. +/// This macro generates the WASM export functions for all trait methods. +#[macro_export] +macro_rules! register_lyrics { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_lyrics_get_lyrics( + req: extism_pdk::Json<$crate::lyrics::GetLyricsRequest> + ) -> extism_pdk::FnResult<extism_pdk::Json<$crate::lyrics::GetLyricsResponse>> { + let plugin = <$plugin_type>::default(); + let result = $crate::lyrics::Lyrics::get_lyrics(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + } + }; +} diff --git a/plugins/pdk/rust/nd-pdk-capabilities/src/metadata.rs b/plugins/pdk/rust/nd-pdk-capabilities/src/metadata.rs new file mode 100644 index 000000000..463e52c37 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-capabilities/src/metadata.rs @@ -0,0 +1,539 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the MetadataAgent capability. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use serde::{Deserialize, Serialize}; + +// Helper functions for skip_serializing_if with numeric types +#[allow(dead_code)] +fn is_zero_i32(value: &i32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u32(value: &u32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_i64(value: &i64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u64(value: &u64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_f32(value: &f32) -> bool { *value == 0.0 } +#[allow(dead_code)] +fn is_zero_f64(value: &f64) -> bool { *value == 0.0 } +/// AlbumImagesResponse is the response for GetAlbumImages. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AlbumImagesResponse { + /// Images is the list of album images. + #[serde(default)] + pub images: Vec<ImageInfo>, +} +/// AlbumInfoResponse is the response for GetAlbumInfo. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AlbumInfoResponse { + /// Name is the album name. + #[serde(default)] + pub name: String, + /// MBID is the MusicBrainz ID for the album. + #[serde(default)] + pub mbid: String, + /// Description is the album description/notes. + #[serde(default)] + pub description: String, + /// URL is the external URL for the album. + #[serde(default)] + pub url: String, +} +/// AlbumRequest is the common request for album-related functions. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AlbumRequest { + /// Name is the album name. + #[serde(default)] + pub name: String, + /// Artist is the album artist name. + #[serde(default)] + pub artist: String, + /// MBID is the MusicBrainz ID for the album (if known). + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbid: String, +} +/// ArtistBiographyResponse is the response for GetArtistBiography. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ArtistBiographyResponse { + /// Biography is the artist biography text. + #[serde(default)] + pub biography: String, +} +/// ArtistImagesResponse is the response for GetArtistImages. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ArtistImagesResponse { + /// Images is the list of artist images. + #[serde(default)] + pub images: Vec<ImageInfo>, +} +/// ArtistMBIDRequest is the request for GetArtistMBID. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ArtistMBIDRequest { + /// ID is the internal Navidrome artist ID. + #[serde(default)] + pub id: String, + /// Name is the artist name. + #[serde(default)] + pub name: String, +} +/// ArtistMBIDResponse is the response for GetArtistMBID. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ArtistMBIDResponse { + /// MBID is the MusicBrainz ID for the artist. + #[serde(default)] + pub mbid: String, +} +/// ArtistRef is a reference to an artist with name and optional MBID. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ArtistRef { + /// ID is the internal Navidrome artist ID (if known). + #[serde(default, skip_serializing_if = "String::is_empty")] + pub id: String, + /// Name is the artist name. + #[serde(default)] + pub name: String, + /// MBID is the MusicBrainz ID for the artist. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbid: String, +} +/// ArtistRequest is the common request for artist-related functions. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ArtistRequest { + /// ID is the internal Navidrome artist ID. + #[serde(default)] + pub id: String, + /// Name is the artist name. + #[serde(default)] + pub name: String, + /// MBID is the MusicBrainz ID for the artist (if known). + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbid: String, +} +/// ArtistURLResponse is the response for GetArtistURL. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ArtistURLResponse { + /// URL is the external URL for the artist. + #[serde(default)] + pub url: String, +} +/// ImageInfo represents an image with URL and size. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ImageInfo { + /// URL is the URL of the image. + #[serde(default)] + pub url: String, + /// Size is the size of the image in pixels (width or height). + #[serde(default)] + pub size: i32, +} +/// SimilarArtistsRequest is the request for GetSimilarArtists. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SimilarArtistsRequest { + /// ID is the internal Navidrome artist ID. + #[serde(default)] + pub id: String, + /// Name is the artist name. + #[serde(default)] + pub name: String, + /// MBID is the MusicBrainz ID for the artist (if known). + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbid: String, + /// Limit is the maximum number of similar artists to return. + #[serde(default)] + pub limit: i32, +} +/// SimilarArtistsResponse is the response for GetSimilarArtists. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SimilarArtistsResponse { + /// Artists is the list of similar artists. + #[serde(default)] + pub artists: Vec<ArtistRef>, +} +/// SimilarSongsByAlbumRequest is the request for GetSimilarSongsByAlbum. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SimilarSongsByAlbumRequest { + /// ID is the internal Navidrome album ID. + #[serde(default)] + pub id: String, + /// Name is the album name. + #[serde(default)] + pub name: String, + /// Artist is the album artist name. + #[serde(default)] + pub artist: String, + /// MBID is the MusicBrainz release ID (if known). + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbid: String, + /// Count is the maximum number of similar songs to return. + #[serde(default)] + pub count: i32, +} +/// SimilarSongsByArtistRequest is the request for GetSimilarSongsByArtist. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SimilarSongsByArtistRequest { + /// ID is the internal Navidrome artist ID. + #[serde(default)] + pub id: String, + /// Name is the artist name. + #[serde(default)] + pub name: String, + /// MBID is the MusicBrainz artist ID (if known). + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbid: String, + /// Count is the maximum number of similar songs to return. + #[serde(default)] + pub count: i32, +} +/// SimilarSongsByTrackRequest is the request for GetSimilarSongsByTrack. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SimilarSongsByTrackRequest { + /// ID is the internal Navidrome mediafile ID. + #[serde(default)] + pub id: String, + /// Name is the track title. + #[serde(default)] + pub name: String, + /// Artist is the artist name. + #[serde(default)] + pub artist: String, + /// MBID is the MusicBrainz recording ID (if known). + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbid: String, + /// Count is the maximum number of similar songs to return. + #[serde(default)] + pub count: i32, +} +/// SimilarSongsResponse is the response for GetSimilarSongsBy* functions. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SimilarSongsResponse { + /// Songs is the list of similar songs. + #[serde(default)] + pub songs: Vec<SongRef>, +} +/// SongRef is a reference to a song with metadata for matching. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SongRef { + /// ID is the internal Navidrome mediafile ID (if known). + #[serde(default, skip_serializing_if = "String::is_empty")] + pub id: String, + /// Name is the song name. + #[serde(default)] + pub name: String, + /// MBID is the MusicBrainz ID for the song. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbid: String, + /// ISRC is the International Standard Recording Code for the song. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub isrc: String, + /// Artist is the artist name. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub artist: String, + /// ArtistMBID is the MusicBrainz artist ID. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub artist_mbid: String, + /// Album is the album name. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub album: String, + /// AlbumMBID is the MusicBrainz release ID. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub album_mbid: String, + /// Duration is the song duration in seconds. + #[serde(default, skip_serializing_if = "is_zero_f32")] + pub duration: f32, +} +/// TopSongsRequest is the request for GetArtistTopSongs. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TopSongsRequest { + /// ID is the internal Navidrome artist ID. + #[serde(default)] + pub id: String, + /// Name is the artist name. + #[serde(default)] + pub name: String, + /// MBID is the MusicBrainz ID for the artist (if known). + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbid: String, + /// Count is the maximum number of top songs to return. + #[serde(default)] + pub count: i32, +} +/// TopSongsResponse is the response for GetArtistTopSongs. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TopSongsResponse { + /// Songs is the list of top songs. + #[serde(default)] + pub songs: Vec<SongRef>, +} + +/// Error represents an error from a capability method. +#[derive(Debug)] +pub struct Error { + pub message: String, +} + +impl std::fmt::Display for Error { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.message) + } +} + +impl std::error::Error for Error {} + +impl Error { + pub fn new(message: impl Into<String>) -> Self { + Self { message: message.into() } + } +} + +/// ArtistMBIDProvider provides the GetArtistMBID function. +pub trait ArtistMBIDProvider { + fn get_artist_mbid(&self, req: ArtistMBIDRequest) -> Result<ArtistMBIDResponse, Error>; +} + +/// Register the get_artist_mbid export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_metadata_artist_mbid { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_get_artist_mbid( + req: extism_pdk::Json<$crate::metadata::ArtistMBIDRequest> + ) -> extism_pdk::FnResult<extism_pdk::Json<$crate::metadata::ArtistMBIDResponse>> { + let plugin = <$plugin_type>::default(); + let result = $crate::metadata::ArtistMBIDProvider::get_artist_mbid(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + } + }; +} + +/// ArtistURLProvider provides the GetArtistURL function. +pub trait ArtistURLProvider { + fn get_artist_url(&self, req: ArtistRequest) -> Result<ArtistURLResponse, Error>; +} + +/// Register the get_artist_url export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_metadata_artist_url { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_get_artist_url( + req: extism_pdk::Json<$crate::metadata::ArtistRequest> + ) -> extism_pdk::FnResult<extism_pdk::Json<$crate::metadata::ArtistURLResponse>> { + let plugin = <$plugin_type>::default(); + let result = $crate::metadata::ArtistURLProvider::get_artist_url(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + } + }; +} + +/// ArtistBiographyProvider provides the GetArtistBiography function. +pub trait ArtistBiographyProvider { + fn get_artist_biography(&self, req: ArtistRequest) -> Result<ArtistBiographyResponse, Error>; +} + +/// Register the get_artist_biography export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_metadata_artist_biography { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_get_artist_biography( + req: extism_pdk::Json<$crate::metadata::ArtistRequest> + ) -> extism_pdk::FnResult<extism_pdk::Json<$crate::metadata::ArtistBiographyResponse>> { + let plugin = <$plugin_type>::default(); + let result = $crate::metadata::ArtistBiographyProvider::get_artist_biography(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + } + }; +} + +/// SimilarArtistsProvider provides the GetSimilarArtists function. +pub trait SimilarArtistsProvider { + fn get_similar_artists(&self, req: SimilarArtistsRequest) -> Result<SimilarArtistsResponse, Error>; +} + +/// Register the get_similar_artists export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_metadata_similar_artists { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_get_similar_artists( + req: extism_pdk::Json<$crate::metadata::SimilarArtistsRequest> + ) -> extism_pdk::FnResult<extism_pdk::Json<$crate::metadata::SimilarArtistsResponse>> { + let plugin = <$plugin_type>::default(); + let result = $crate::metadata::SimilarArtistsProvider::get_similar_artists(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + } + }; +} + +/// ArtistImagesProvider provides the GetArtistImages function. +pub trait ArtistImagesProvider { + fn get_artist_images(&self, req: ArtistRequest) -> Result<ArtistImagesResponse, Error>; +} + +/// Register the get_artist_images export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_metadata_artist_images { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_get_artist_images( + req: extism_pdk::Json<$crate::metadata::ArtistRequest> + ) -> extism_pdk::FnResult<extism_pdk::Json<$crate::metadata::ArtistImagesResponse>> { + let plugin = <$plugin_type>::default(); + let result = $crate::metadata::ArtistImagesProvider::get_artist_images(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + } + }; +} + +/// ArtistTopSongsProvider provides the GetArtistTopSongs function. +pub trait ArtistTopSongsProvider { + fn get_artist_top_songs(&self, req: TopSongsRequest) -> Result<TopSongsResponse, Error>; +} + +/// Register the get_artist_top_songs export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_metadata_artist_top_songs { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_get_artist_top_songs( + req: extism_pdk::Json<$crate::metadata::TopSongsRequest> + ) -> extism_pdk::FnResult<extism_pdk::Json<$crate::metadata::TopSongsResponse>> { + let plugin = <$plugin_type>::default(); + let result = $crate::metadata::ArtistTopSongsProvider::get_artist_top_songs(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + } + }; +} + +/// AlbumInfoProvider provides the GetAlbumInfo function. +pub trait AlbumInfoProvider { + fn get_album_info(&self, req: AlbumRequest) -> Result<AlbumInfoResponse, Error>; +} + +/// Register the get_album_info export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_metadata_album_info { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_get_album_info( + req: extism_pdk::Json<$crate::metadata::AlbumRequest> + ) -> extism_pdk::FnResult<extism_pdk::Json<$crate::metadata::AlbumInfoResponse>> { + let plugin = <$plugin_type>::default(); + let result = $crate::metadata::AlbumInfoProvider::get_album_info(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + } + }; +} + +/// AlbumImagesProvider provides the GetAlbumImages function. +pub trait AlbumImagesProvider { + fn get_album_images(&self, req: AlbumRequest) -> Result<AlbumImagesResponse, Error>; +} + +/// Register the get_album_images export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_metadata_album_images { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_get_album_images( + req: extism_pdk::Json<$crate::metadata::AlbumRequest> + ) -> extism_pdk::FnResult<extism_pdk::Json<$crate::metadata::AlbumImagesResponse>> { + let plugin = <$plugin_type>::default(); + let result = $crate::metadata::AlbumImagesProvider::get_album_images(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + } + }; +} + +/// SimilarSongsByTrackProvider provides the GetSimilarSongsByTrack function. +pub trait SimilarSongsByTrackProvider { + fn get_similar_songs_by_track(&self, req: SimilarSongsByTrackRequest) -> Result<SimilarSongsResponse, Error>; +} + +/// Register the get_similar_songs_by_track export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_metadata_similar_songs_by_track { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_get_similar_songs_by_track( + req: extism_pdk::Json<$crate::metadata::SimilarSongsByTrackRequest> + ) -> extism_pdk::FnResult<extism_pdk::Json<$crate::metadata::SimilarSongsResponse>> { + let plugin = <$plugin_type>::default(); + let result = $crate::metadata::SimilarSongsByTrackProvider::get_similar_songs_by_track(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + } + }; +} + +/// SimilarSongsByAlbumProvider provides the GetSimilarSongsByAlbum function. +pub trait SimilarSongsByAlbumProvider { + fn get_similar_songs_by_album(&self, req: SimilarSongsByAlbumRequest) -> Result<SimilarSongsResponse, Error>; +} + +/// Register the get_similar_songs_by_album export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_metadata_similar_songs_by_album { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_get_similar_songs_by_album( + req: extism_pdk::Json<$crate::metadata::SimilarSongsByAlbumRequest> + ) -> extism_pdk::FnResult<extism_pdk::Json<$crate::metadata::SimilarSongsResponse>> { + let plugin = <$plugin_type>::default(); + let result = $crate::metadata::SimilarSongsByAlbumProvider::get_similar_songs_by_album(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + } + }; +} + +/// SimilarSongsByArtistProvider provides the GetSimilarSongsByArtist function. +pub trait SimilarSongsByArtistProvider { + fn get_similar_songs_by_artist(&self, req: SimilarSongsByArtistRequest) -> Result<SimilarSongsResponse, Error>; +} + +/// Register the get_similar_songs_by_artist export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_metadata_similar_songs_by_artist { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_get_similar_songs_by_artist( + req: extism_pdk::Json<$crate::metadata::SimilarSongsByArtistRequest> + ) -> extism_pdk::FnResult<extism_pdk::Json<$crate::metadata::SimilarSongsResponse>> { + let plugin = <$plugin_type>::default(); + let result = $crate::metadata::SimilarSongsByArtistProvider::get_similar_songs_by_artist(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + } + }; +} diff --git a/plugins/pdk/rust/nd-pdk-capabilities/src/scheduler.rs b/plugins/pdk/rust/nd-pdk-capabilities/src/scheduler.rs new file mode 100644 index 000000000..53b8564ee --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-capabilities/src/scheduler.rs @@ -0,0 +1,78 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the SchedulerCallback capability. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use serde::{Deserialize, Serialize}; + +// Helper functions for skip_serializing_if with numeric types +#[allow(dead_code)] +fn is_zero_i32(value: &i32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u32(value: &u32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_i64(value: &i64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u64(value: &u64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_f32(value: &f32) -> bool { *value == 0.0 } +#[allow(dead_code)] +fn is_zero_f64(value: &f64) -> bool { *value == 0.0 } +/// SchedulerCallbackRequest is the request provided when a scheduled task fires. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SchedulerCallbackRequest { + /// ScheduleID is the unique identifier for this scheduled task. + /// This is either the ID provided when scheduling, or an auto-generated UUID if none was specified. + #[serde(default)] + pub schedule_id: String, + /// Payload is the payload data that was provided when the task was scheduled. + /// Can be used to pass context or parameters to the callback handler. + #[serde(default)] + pub payload: String, + /// IsRecurring is true if this is a recurring schedule (created via ScheduleRecurring), + /// false if it's a one-time schedule (created via ScheduleOneTime). + #[serde(default)] + pub is_recurring: bool, +} + +/// Error represents an error from a capability method. +#[derive(Debug)] +pub struct Error { + pub message: String, +} + +impl std::fmt::Display for Error { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.message) + } +} + +impl std::error::Error for Error {} + +impl Error { + pub fn new(message: impl Into<String>) -> Self { + Self { message: message.into() } + } +} + +/// CallbackProvider provides the OnCallback function. +pub trait CallbackProvider { + fn on_callback(&self, req: SchedulerCallbackRequest) -> Result<(), Error>; +} + +/// Register the on_callback export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_scheduler_callback { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_scheduler_callback( + req: extism_pdk::Json<$crate::scheduler::SchedulerCallbackRequest> + ) -> extism_pdk::FnResult<()> { + let plugin = <$plugin_type>::default(); + $crate::scheduler::CallbackProvider::on_callback(&plugin, req.into_inner())?; + Ok(()) + } + }; +} diff --git a/plugins/pdk/rust/nd-pdk-capabilities/src/scrobbler.rs b/plugins/pdk/rust/nd-pdk-capabilities/src/scrobbler.rs new file mode 100644 index 000000000..2572712d1 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-capabilities/src/scrobbler.rs @@ -0,0 +1,193 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the Scrobbler capability. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use serde::{Deserialize, Serialize}; + +// Helper functions for skip_serializing_if with numeric types +#[allow(dead_code)] +fn is_zero_i32(value: &i32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u32(value: &u32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_i64(value: &i64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u64(value: &u64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_f32(value: &f32) -> bool { *value == 0.0 } +#[allow(dead_code)] +fn is_zero_f64(value: &f64) -> bool { *value == 0.0 } +/// ScrobblerError represents an error type for scrobbling operations. +pub type ScrobblerError = &'static str; +/// ScrobblerErrorNotAuthorized indicates the user is not authorized. +pub const SCROBBLER_ERROR_NOT_AUTHORIZED: ScrobblerError = "scrobbler(not_authorized)"; +/// ScrobblerErrorRetryLater indicates the operation should be retried later. +pub const SCROBBLER_ERROR_RETRY_LATER: ScrobblerError = "scrobbler(retry_later)"; +/// ScrobblerErrorUnrecoverable indicates an unrecoverable error. +pub const SCROBBLER_ERROR_UNRECOVERABLE: ScrobblerError = "scrobbler(unrecoverable)"; +/// ArtistRef is a reference to an artist with name and optional MBID. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ArtistRef { + /// ID is the internal Navidrome artist ID (if known). + #[serde(default, skip_serializing_if = "String::is_empty")] + pub id: String, + /// Name is the artist name. + #[serde(default)] + pub name: String, + /// MBID is the MusicBrainz ID for the artist. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbid: String, +} +/// IsAuthorizedRequest is the request for authorization check. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct IsAuthorizedRequest { + /// Username is the username of the user. + #[serde(default)] + pub username: String, +} +/// NowPlayingRequest is the request for now playing notification. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct NowPlayingRequest { + /// Username is the username of the user. + #[serde(default)] + pub username: String, + /// Track is the track currently playing. + #[serde(default)] + pub track: TrackInfo, + /// Position is the current playback position in seconds. + #[serde(default)] + pub position: i32, +} +/// ScrobbleRequest is the request for submitting a scrobble. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ScrobbleRequest { + /// Username is the username of the user. + #[serde(default)] + pub username: String, + /// Track is the track that was played. + #[serde(default)] + pub track: TrackInfo, + /// Timestamp is the Unix timestamp when the track started playing. + #[serde(default)] + pub timestamp: i64, +} +/// TrackInfo contains track metadata. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TrackInfo { + /// ID is the internal Navidrome track ID. + #[serde(default)] + pub id: String, + /// Title is the track title. + #[serde(default)] + pub title: String, + /// Album is the album name. + #[serde(default)] + pub album: String, + /// Artist is the formatted artist name for display (e.g., "Artist1 • Artist2"). + #[serde(default)] + pub artist: String, + /// AlbumArtist is the formatted album artist name for display. + #[serde(default)] + pub album_artist: String, + /// Artists is the list of track artists. + #[serde(default)] + pub artists: Vec<ArtistRef>, + /// AlbumArtists is the list of album artists. + #[serde(default)] + pub album_artists: Vec<ArtistRef>, + /// Duration is the track duration in seconds. + #[serde(default)] + pub duration: f32, + /// TrackNumber is the track number on the album. + #[serde(default)] + pub track_number: i32, + /// DiscNumber is the disc number. + #[serde(default)] + pub disc_number: i32, + /// MBZRecordingID is the MusicBrainz recording ID. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbz_recording_id: String, + /// MBZAlbumID is the MusicBrainz album/release ID. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbz_album_id: String, + /// MBZReleaseGroupID is the MusicBrainz release group ID. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbz_release_group_id: String, + /// MBZReleaseTrackID is the MusicBrainz release track ID. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbz_release_track_id: String, +} + +/// Error represents an error from a capability method. +#[derive(Debug)] +pub struct Error { + pub message: String, +} + +impl std::fmt::Display for Error { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.message) + } +} + +impl std::error::Error for Error {} + +impl Error { + pub fn new(message: impl Into<String>) -> Self { + Self { message: message.into() } + } +} + +/// Scrobbler requires all methods to be implemented. +/// Scrobbler provides scrobbling functionality to external services. +/// This capability allows plugins to submit listening history to services like Last.fm, +/// ListenBrainz, or custom scrobbling backends. +/// +/// All methods are required - plugins implementing this capability must provide +/// all three functions: IsAuthorized, NowPlaying, and Scrobble. +pub trait Scrobbler { + /// IsAuthorized - IsAuthorized checks if a user is authorized to scrobble to this service. + fn is_authorized(&self, req: IsAuthorizedRequest) -> Result<bool, Error>; + /// NowPlaying - NowPlaying sends a now playing notification to the scrobbling service. + fn now_playing(&self, req: NowPlayingRequest) -> Result<(), Error>; + /// Scrobble - Scrobble submits a completed scrobble to the scrobbling service. + fn scrobble(&self, req: ScrobbleRequest) -> Result<(), Error>; +} + +/// Register all exports for the Scrobbler capability. +/// This macro generates the WASM export functions for all trait methods. +#[macro_export] +macro_rules! register_scrobbler { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_scrobbler_is_authorized( + req: extism_pdk::Json<$crate::scrobbler::IsAuthorizedRequest> + ) -> extism_pdk::FnResult<extism_pdk::Json<bool>> { + let plugin = <$plugin_type>::default(); + let result = $crate::scrobbler::Scrobbler::is_authorized(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + } + #[extism_pdk::plugin_fn] + pub fn nd_scrobbler_now_playing( + req: extism_pdk::Json<$crate::scrobbler::NowPlayingRequest> + ) -> extism_pdk::FnResult<()> { + let plugin = <$plugin_type>::default(); + $crate::scrobbler::Scrobbler::now_playing(&plugin, req.into_inner())?; + Ok(()) + } + #[extism_pdk::plugin_fn] + pub fn nd_scrobbler_scrobble( + req: extism_pdk::Json<$crate::scrobbler::ScrobbleRequest> + ) -> extism_pdk::FnResult<()> { + let plugin = <$plugin_type>::default(); + $crate::scrobbler::Scrobbler::scrobble(&plugin, req.into_inner())?; + Ok(()) + } + }; +} diff --git a/plugins/pdk/rust/nd-pdk-capabilities/src/taskworker.rs b/plugins/pdk/rust/nd-pdk-capabilities/src/taskworker.rs new file mode 100644 index 000000000..e8aa106a2 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-capabilities/src/taskworker.rs @@ -0,0 +1,102 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the TaskWorker capability. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use serde::{Deserialize, Serialize}; +use base64::Engine as _; +use base64::engine::general_purpose::STANDARD as BASE64; + +mod base64_bytes { + use serde::{self, Deserialize, Deserializer, Serializer}; + use base64::Engine as _; + use base64::engine::general_purpose::STANDARD as BASE64; + + pub fn serialize<S>(bytes: &Vec<u8>, serializer: S) -> Result<S::Ok, S::Error> + where + S: Serializer, + { + serializer.serialize_str(&BASE64.encode(bytes)) + } + + pub fn deserialize<'de, D>(deserializer: D) -> Result<Vec<u8>, D::Error> + where + D: Deserializer<'de>, + { + let s = String::deserialize(deserializer)?; + BASE64.decode(&s).map_err(serde::de::Error::custom) + } +} + +// Helper functions for skip_serializing_if with numeric types +#[allow(dead_code)] +fn is_zero_i32(value: &i32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u32(value: &u32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_i64(value: &i64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u64(value: &u64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_f32(value: &f32) -> bool { *value == 0.0 } +#[allow(dead_code)] +fn is_zero_f64(value: &f64) -> bool { *value == 0.0 } +/// TaskExecuteRequest is the request provided when a task is ready to execute. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TaskExecuteRequest { + /// QueueName is the name of the queue this task belongs to. + #[serde(default)] + pub queue_name: String, + /// TaskID is the unique identifier for this task. + #[serde(default)] + pub task_id: String, + /// Payload is the opaque data provided when the task was enqueued. + #[serde(default)] + #[serde(with = "base64_bytes")] + pub payload: Vec<u8>, + /// Attempt is the current attempt number (1-based: first attempt = 1). + #[serde(default)] + pub attempt: i32, +} + +/// Error represents an error from a capability method. +#[derive(Debug)] +pub struct Error { + pub message: String, +} + +impl std::fmt::Display for Error { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.message) + } +} + +impl std::error::Error for Error {} + +impl Error { + pub fn new(message: impl Into<String>) -> Self { + Self { message: message.into() } + } +} + +/// TaskExecuteProvider provides the OnTaskExecute function. +pub trait TaskExecuteProvider { + fn on_task_execute(&self, req: TaskExecuteRequest) -> Result<String, Error>; +} + +/// Register the on_task_execute export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_taskworker_task_execute { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_task_execute( + req: extism_pdk::Json<$crate::taskworker::TaskExecuteRequest> + ) -> extism_pdk::FnResult<extism_pdk::Json<String>> { + let plugin = <$plugin_type>::default(); + let result = $crate::taskworker::TaskExecuteProvider::on_task_execute(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + } + }; +} diff --git a/plugins/pdk/rust/nd-pdk-capabilities/src/websocket.rs b/plugins/pdk/rust/nd-pdk-capabilities/src/websocket.rs new file mode 100644 index 000000000..672233e4b --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-capabilities/src/websocket.rs @@ -0,0 +1,196 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the WebSocketCallback capability. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use serde::{Deserialize, Serialize}; +use base64::Engine as _; +use base64::engine::general_purpose::STANDARD as BASE64; + +mod base64_bytes { + use serde::{self, Deserialize, Deserializer, Serializer}; + use base64::Engine as _; + use base64::engine::general_purpose::STANDARD as BASE64; + + pub fn serialize<S>(bytes: &Vec<u8>, serializer: S) -> Result<S::Ok, S::Error> + where + S: Serializer, + { + serializer.serialize_str(&BASE64.encode(bytes)) + } + + pub fn deserialize<'de, D>(deserializer: D) -> Result<Vec<u8>, D::Error> + where + D: Deserializer<'de>, + { + let s = String::deserialize(deserializer)?; + BASE64.decode(&s).map_err(serde::de::Error::custom) + } +} + +// Helper functions for skip_serializing_if with numeric types +#[allow(dead_code)] +fn is_zero_i32(value: &i32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u32(value: &u32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_i64(value: &i64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u64(value: &u64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_f32(value: &f32) -> bool { *value == 0.0 } +#[allow(dead_code)] +fn is_zero_f64(value: &f64) -> bool { *value == 0.0 } +/// OnBinaryMessageRequest is the request provided when a binary message is received. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct OnBinaryMessageRequest { + /// ConnectionID is the unique identifier for the WebSocket connection that received the message. + #[serde(default)] + pub connection_id: String, + /// Data is the binary data received from the WebSocket, encoded as base64. + #[serde(default)] + #[serde(with = "base64_bytes")] + pub data: Vec<u8>, +} +/// OnCloseRequest is the request provided when a WebSocket connection is closed. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct OnCloseRequest { + /// ConnectionID is the unique identifier for the WebSocket connection that was closed. + #[serde(default)] + pub connection_id: String, + /// Code is the WebSocket close status code (e.g., 1000 for normal closure, + /// 1001 for going away, 1006 for abnormal closure). + #[serde(default)] + pub code: i32, + /// Reason is the human-readable reason for the connection closure, if provided. + #[serde(default)] + pub reason: String, +} +/// OnErrorRequest is the request provided when an error occurs on a WebSocket connection. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct OnErrorRequest { + /// ConnectionID is the unique identifier for the WebSocket connection where the error occurred. + #[serde(default)] + pub connection_id: String, + /// Error is the error message describing what went wrong. + #[serde(default)] + pub error: String, +} +/// OnTextMessageRequest is the request provided when a text message is received. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct OnTextMessageRequest { + /// ConnectionID is the unique identifier for the WebSocket connection that received the message. + #[serde(default)] + pub connection_id: String, + /// Message is the text message content received from the WebSocket. + #[serde(default)] + pub message: String, +} + +/// Error represents an error from a capability method. +#[derive(Debug)] +pub struct Error { + pub message: String, +} + +impl std::fmt::Display for Error { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.message) + } +} + +impl std::error::Error for Error {} + +impl Error { + pub fn new(message: impl Into<String>) -> Self { + Self { message: message.into() } + } +} + +/// TextMessageProvider provides the OnTextMessage function. +pub trait TextMessageProvider { + fn on_text_message(&self, req: OnTextMessageRequest) -> Result<(), Error>; +} + +/// Register the on_text_message export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_websocket_text_message { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_websocket_on_text_message( + req: extism_pdk::Json<$crate::websocket::OnTextMessageRequest> + ) -> extism_pdk::FnResult<()> { + let plugin = <$plugin_type>::default(); + $crate::websocket::TextMessageProvider::on_text_message(&plugin, req.into_inner())?; + Ok(()) + } + }; +} + +/// BinaryMessageProvider provides the OnBinaryMessage function. +pub trait BinaryMessageProvider { + fn on_binary_message(&self, req: OnBinaryMessageRequest) -> Result<(), Error>; +} + +/// Register the on_binary_message export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_websocket_binary_message { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_websocket_on_binary_message( + req: extism_pdk::Json<$crate::websocket::OnBinaryMessageRequest> + ) -> extism_pdk::FnResult<()> { + let plugin = <$plugin_type>::default(); + $crate::websocket::BinaryMessageProvider::on_binary_message(&plugin, req.into_inner())?; + Ok(()) + } + }; +} + +/// ErrorProvider provides the OnError function. +pub trait ErrorProvider { + fn on_error(&self, req: OnErrorRequest) -> Result<(), Error>; +} + +/// Register the on_error export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_websocket_error { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_websocket_on_error( + req: extism_pdk::Json<$crate::websocket::OnErrorRequest> + ) -> extism_pdk::FnResult<()> { + let plugin = <$plugin_type>::default(); + $crate::websocket::ErrorProvider::on_error(&plugin, req.into_inner())?; + Ok(()) + } + }; +} + +/// CloseProvider provides the OnClose function. +pub trait CloseProvider { + fn on_close(&self, req: OnCloseRequest) -> Result<(), Error>; +} + +/// Register the on_close export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_websocket_close { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_websocket_on_close( + req: extism_pdk::Json<$crate::websocket::OnCloseRequest> + ) -> extism_pdk::FnResult<()> { + let plugin = <$plugin_type>::default(); + $crate::websocket::CloseProvider::on_close(&plugin, req.into_inner())?; + Ok(()) + } + }; +} diff --git a/plugins/pdk/rust/nd-pdk-host/.gitignore b/plugins/pdk/rust/nd-pdk-host/.gitignore new file mode 100644 index 000000000..9da4a887b --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-host/.gitignore @@ -0,0 +1 @@ +!Cargo.lock diff --git a/plugins/pdk/rust/nd-pdk-host/Cargo.lock b/plugins/pdk/rust/nd-pdk-host/Cargo.lock new file mode 100644 index 000000000..b4d9042d0 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-host/Cargo.lock @@ -0,0 +1,380 @@ +# This file is automatically @generated by Cargo. +# It is not intended for manual editing. +version = 4 + +[[package]] +name = "anyhow" +version = "1.0.100" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a23eb6b1614318a8071c9b2521f36b424b2c83db5eb3a0fead4a6c0809af6e61" + +[[package]] +name = "autocfg" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c08606f8c3cbf4ce6ec8e28fb0014a2c086708fe954eaa885384a6165172e7e8" + +[[package]] +name = "base64" +version = "0.22.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "72b3254f16251a8381aa12e40e3c4d2f0199f8c6508fbecb9d91f575e0fbb8c6" + +[[package]] +name = "bytemuck" +version = "1.24.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1fbdf580320f38b612e485521afda1ee26d10cc9884efaaa750d383e13e3c5f4" + +[[package]] +name = "bytes" +version = "1.11.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1e748733b7cbc798e1434b6ac524f0c1ff2ab456fe201501e6497c8417a4fc33" + +[[package]] +name = "either" +version = "1.15.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "48c757948c5ede0e46177b7add2e67155f70e33c07fea8284df6576da70b3719" + +[[package]] +name = "equivalent" +version = "1.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "877a4ace8713b0bcf2a4e7eec82529c029f1d0619886d18145fea96c3ffe5c0f" + +[[package]] +name = "extism-convert" +version = "1.13.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4f6612b4e92559eeb4c2dac88a53ee8b4729bea64025befcdeb2b3677e62fc1d" +dependencies = [ + "anyhow", + "base64", + "bytemuck", + "extism-convert-macros", + "prost", + "rmp-serde", + "serde", + "serde_json", +] + +[[package]] +name = "extism-convert-macros" +version = "1.13.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "525831f1f15079a7c43514905579aac10f90fee46bc6353b683ed632029dd945" +dependencies = [ + "manyhow", + "proc-macro-crate", + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "extism-manifest" +version = "1.13.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e60e36345a96ad0d74adfca64dc22d93eb4979ab15a6c130cded5e0585f31b10" +dependencies = [ + "base64", + "serde", + "serde_json", +] + +[[package]] +name = "extism-pdk" +version = "1.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "352fcb5a66eb74145a1c4a01f2bd15d59c62c85be73aac8471880c65b26b798f" +dependencies = [ + "anyhow", + "base64", + "extism-convert", + "extism-manifest", + "extism-pdk-derive", + "serde", + "serde_json", +] + +[[package]] +name = "extism-pdk-derive" +version = "1.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d086daea5fd844e3c5ac69ddfe36df4a9a43e7218cf7d1f888182b089b09806c" +dependencies = [ + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "hashbrown" +version = "0.16.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "841d1cc9bed7f9236f321df977030373f4a4163ae1a7dbfe1a51a2c1a51d9100" + +[[package]] +name = "indexmap" +version = "2.12.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0ad4bb2b565bca0645f4d68c5c9af97fba094e9791da685bf83cb5f3ce74acf2" +dependencies = [ + "equivalent", + "hashbrown", +] + +[[package]] +name = "itertools" +version = "0.14.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2b192c782037fadd9cfa75548310488aabdbf3d2da73885b31bd0abd03351285" +dependencies = [ + "either", +] + +[[package]] +name = "itoa" +version = "1.0.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "92ecc6618181def0457392ccd0ee51198e065e016d1d527a7ac1b6dc7c1f09d2" + +[[package]] +name = "manyhow" +version = "0.11.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b33efb3ca6d3b07393750d4030418d594ab1139cee518f0dc88db70fec873587" +dependencies = [ + "manyhow-macros", + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "manyhow-macros" +version = "0.11.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "46fce34d199b78b6e6073abf984c9cf5fd3e9330145a93ee0738a7443e371495" +dependencies = [ + "proc-macro-utils", + "proc-macro2", + "quote", +] + +[[package]] +name = "memchr" +version = "2.7.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f52b00d39961fc5b2736ea853c9cc86238e165017a493d1d5c8eac6bdc4cc273" + +[[package]] +name = "nd-pdk-host" +version = "0.1.0" +dependencies = [ + "extism-pdk", + "serde", + "serde_json", +] + +[[package]] +name = "num-traits" +version = "0.2.19" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "071dfc062690e90b734c0b2273ce72ad0ffa95f0c74596bc250dcfd960262841" +dependencies = [ + "autocfg", +] + +[[package]] +name = "proc-macro-crate" +version = "3.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "219cb19e96be00ab2e37d6e299658a0cfa83e52429179969b0f0121b4ac46983" +dependencies = [ + "toml_edit", +] + +[[package]] +name = "proc-macro-utils" +version = "0.10.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "eeaf08a13de400bc215877b5bdc088f241b12eb42f0a548d3390dc1c56bb7071" +dependencies = [ + "proc-macro2", + "quote", + "smallvec", +] + +[[package]] +name = "proc-macro2" +version = "1.0.104" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9695f8df41bb4f3d222c95a67532365f569318332d03d5f3f67f37b20e6ebdf0" +dependencies = [ + "unicode-ident", +] + +[[package]] +name = "prost" +version = "0.14.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7231bd9b3d3d33c86b58adbac74b5ec0ad9f496b19d22801d773636feaa95f3d" +dependencies = [ + "bytes", + "prost-derive", +] + +[[package]] +name = "prost-derive" +version = "0.14.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9120690fafc389a67ba3803df527d0ec9cbbc9cc45e4cc20b332996dfb672425" +dependencies = [ + "anyhow", + "itertools", + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "quote" +version = "1.0.42" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a338cc41d27e6cc6dce6cefc13a0729dfbb81c262b1f519331575dd80ef3067f" +dependencies = [ + "proc-macro2", +] + +[[package]] +name = "rmp" +version = "0.8.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4ba8be72d372b2c9b35542551678538b562e7cf86c3315773cae48dfbfe7790c" +dependencies = [ + "num-traits", +] + +[[package]] +name = "rmp-serde" +version = "1.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "72f81bee8c8ef9b577d1681a70ebbc962c232461e397b22c208c43c04b67a155" +dependencies = [ + "rmp", + "serde", +] + +[[package]] +name = "serde" +version = "1.0.228" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9a8e94ea7f378bd32cbbd37198a4a91436180c5bb472411e48b5ec2e2124ae9e" +dependencies = [ + "serde_core", + "serde_derive", +] + +[[package]] +name = "serde_core" +version = "1.0.228" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "41d385c7d4ca58e59fc732af25c3983b67ac852c1a25000afe1175de458b67ad" +dependencies = [ + "serde_derive", +] + +[[package]] +name = "serde_derive" +version = "1.0.228" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d540f220d3187173da220f885ab66608367b6574e925011a9353e4badda91d79" +dependencies = [ + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "serde_json" +version = "1.0.148" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3084b546a1dd6289475996f182a22aba973866ea8e8b02c51d9f46b1336a22da" +dependencies = [ + "itoa", + "memchr", + "serde", + "serde_core", + "zmij", +] + +[[package]] +name = "smallvec" +version = "1.15.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "67b1b7a3b5fe4f1376887184045fcf45c69e92af734b7aaddc05fb777b6fbd03" + +[[package]] +name = "syn" +version = "2.0.111" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "390cc9a294ab71bdb1aa2e99d13be9c753cd2d7bd6560c77118597410c4d2e87" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + +[[package]] +name = "toml_datetime" +version = "0.7.5+spec-1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "92e1cfed4a3038bc5a127e35a2d360f145e1f4b971b551a2ba5fd7aedf7e1347" +dependencies = [ + "serde_core", +] + +[[package]] +name = "toml_edit" +version = "0.23.10+spec-1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "84c8b9f757e028cee9fa244aea147aab2a9ec09d5325a9b01e0a49730c2b5269" +dependencies = [ + "indexmap", + "toml_datetime", + "toml_parser", + "winnow", +] + +[[package]] +name = "toml_parser" +version = "1.0.6+spec-1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a3198b4b0a8e11f09dd03e133c0280504d0801269e9afa46362ffde1cbeebf44" +dependencies = [ + "winnow", +] + +[[package]] +name = "unicode-ident" +version = "1.0.22" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9312f7c4f6ff9069b165498234ce8be658059c6728633667c526e27dc2cf1df5" + +[[package]] +name = "winnow" +version = "0.7.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5a5364e9d77fcdeeaa6062ced926ee3381faa2ee02d3eb83a5c27a8825540829" +dependencies = [ + "memchr", +] + +[[package]] +name = "zmij" +version = "1.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0f4a4e8e9dc5c62d159f04fcdbe07f4c3fb710415aab4754bf11505501e3251d" diff --git a/plugins/pdk/rust/nd-pdk-host/Cargo.toml b/plugins/pdk/rust/nd-pdk-host/Cargo.toml new file mode 100644 index 000000000..519096110 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-host/Cargo.toml @@ -0,0 +1,17 @@ +[package] +name = "nd-pdk-host" +version = "0.1.0" +edition = "2021" +description = "Navidrome host function wrappers for Rust plugins" +authors = ["Navidrome Team"] +license = "GPL-3.0" +readme = "README.md" + +[lib] +crate-type = ["rlib"] + +[dependencies] +base64 = "0.22" +extism-pdk = "1.2" +serde = { version = "1.0", features = ["derive"] } +serde_json = "1.0" diff --git a/plugins/pdk/rust/nd-pdk-host/README.md b/plugins/pdk/rust/nd-pdk-host/README.md new file mode 100644 index 000000000..f722b2e5a --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-host/README.md @@ -0,0 +1,87 @@ +# Navidrome Host Function Wrappers for Rust + +This directory contains auto-generated Rust wrappers for Navidrome's host services. +These wrappers provide idiomatic Rust APIs for interacting with Navidrome from WASM plugins. + +## ⚠️ Auto-Generated Code + +**Do not edit these files manually.** They are generated by the `ndpgen` tool. + +To regenerate: + +```bash +make gen +``` + +## Usage + +Add this crate as a dependency in your plugin's `Cargo.toml`: + +```toml +[dependencies] +nd-host = { path = "../../pdk/rust/host" } +``` + +Then import the services you need: + +```rust +use nd_host::{cache, scheduler, library}; +use nd_host::library::Library; // Import the typed struct + +#[plugin_fn] +pub fn my_callback(input: String) -> FnResult<String> { + // Use the cache service + cache::set("my_key", b"my_value", 3600)?; + + // Schedule a recurring task + scheduler::schedule_recurring("@every 5m", "payload", "task_id")?; + + // Access library data with typed structs + let libraries: Vec<Library> = library::get_all_libraries()?; + for lib in &libraries { + info!("Library: {} with {} songs", lib.name, lib.total_songs); + } + + Ok("done".to_string()) +} +``` + +## Typed Structs + +Services that work with domain objects provide typed Rust structs instead of +`serde_json::Value`. This enables compile-time type checking and IDE +autocompletion. + +For example, the `library` module provides a `Library` struct: + +```rust +use nd_host::library::Library; + +let libs: Vec<Library> = library::get_all_libraries()?; +println!("First library: {} ({} songs)", libs[0].name, libs[0].total_songs); +``` + +All structs derive `Debug`, `Clone`, `Serialize`, and `Deserialize` for +convenient use with logging and serialization. + +## Available Services + +| Module | Description | +|---------------|----------------------------------------------------| +| `artwork` | Access album and artist artwork | +| `cache` | Temporary key-value storage with TTL | +| `kvstore` | Persistent key-value storage | +| `library` | Access the music library (albums, artists, tracks) | +| `scheduler` | Schedule one-time and recurring tasks | +| `subsonicapi` | Make Subsonic API calls | +| `websocket` | Send real-time messages to clients | + +## Building Plugins + +Rust plugins must be compiled to WebAssembly: + +```bash +cargo build --target wasm32-wasip1 --release +``` + +See the [webhook-rs](../../examples/webhook-rs/) example for a complete plugin implementation. diff --git a/plugins/pdk/rust/nd-pdk-host/src/lib.rs b/plugins/pdk/rust/nd-pdk-host/src/lib.rs new file mode 100644 index 000000000..3a31bc489 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-host/src/lib.rs @@ -0,0 +1,125 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +//! Navidrome Host Function Wrappers for Rust Plugins +//! +//! This crate provides idiomatic Rust wrappers for all Navidrome host services. +//! It is auto-generated by the ndpgen tool and should not be edited manually. +//! +//! # Usage +//! +//! Add this crate as a dependency in your plugin's Cargo.toml: +//! +//! ```toml +//! [dependencies] +//! nd-host = { path = "../../host/rust" } +//! ``` +//! +//! Then import the services you need: +//! +//! ```ignore +//! use nd_host::{cache, scheduler}; +//! +//! fn my_plugin_function() -> Result<(), extism_pdk::Error> { +//! // Use the cache service +//! cache::set_string("my_key", "my_value", 3600)?; +//! +//! // Schedule a recurring task +//! scheduler::schedule_recurring("@every 5m", "payload", "task_id")?; +//! +//! Ok(()) +//! } +//! ``` +//! +//! # Available Services +//! +//! - [`artwork`] - provides artwork public URL generation capabilities for plugins. +//! - [`cache`] - provides in-memory TTL-based caching capabilities for plugins. +//! - [`config`] - provides access to plugin configuration values. +//! - [`http`] - provides outbound HTTP request capabilities for plugins. +//! - [`kvstore`] - provides persistent key-value storage for plugins. +//! - [`library`] - provides access to music library metadata for plugins. +//! - [`scheduler`] - provides task scheduling capabilities for plugins. +//! - [`subsonicapi`] - provides access to Navidrome's Subsonic API from plugins. +//! - [`task`] - provides persistent task queues for plugins. +//! - [`users`] - provides access to user information for plugins. +//! - [`websocket`] - provides WebSocket communication capabilities for plugins. + +#[doc(hidden)] +mod nd_host_artwork; +/// provides artwork public URL generation capabilities for plugins. +pub mod artwork { + pub use super::nd_host_artwork::*; +} + +#[doc(hidden)] +mod nd_host_cache; +/// provides in-memory TTL-based caching capabilities for plugins. +pub mod cache { + pub use super::nd_host_cache::*; +} + +#[doc(hidden)] +mod nd_host_config; +/// provides access to plugin configuration values. +pub mod config { + pub use super::nd_host_config::*; +} + +#[doc(hidden)] +mod nd_host_http; +/// provides outbound HTTP request capabilities for plugins. +pub mod http { + pub use super::nd_host_http::*; +} + +#[doc(hidden)] +mod nd_host_kvstore; +/// provides persistent key-value storage for plugins. +pub mod kvstore { + pub use super::nd_host_kvstore::*; +} + +#[doc(hidden)] +mod nd_host_library; +/// provides access to music library metadata for plugins. +pub mod library { + pub use super::nd_host_library::*; +} + +#[doc(hidden)] +mod nd_host_scheduler; +/// provides task scheduling capabilities for plugins. +pub mod scheduler { + pub use super::nd_host_scheduler::*; +} + +#[doc(hidden)] +mod nd_host_subsonicapi; +/// provides access to Navidrome's Subsonic API from plugins. +pub mod subsonicapi { + pub use super::nd_host_subsonicapi::*; +} + +#[doc(hidden)] +mod nd_host_task; +/// provides persistent task queues for plugins. +pub mod task { + pub use super::nd_host_task::*; +} + +#[doc(hidden)] +mod nd_host_users; +/// provides access to user information for plugins. +pub mod users { + pub use super::nd_host_users::*; +} + +#[doc(hidden)] +mod nd_host_websocket; +/// provides WebSocket communication capabilities for plugins. +pub mod websocket { + pub use super::nd_host_websocket::*; +} + +// Re-export commonly used types from extism-pdk for convenience +pub use extism_pdk::Error; diff --git a/plugins/pdk/rust/nd-pdk-host/src/nd_host_artwork.rs b/plugins/pdk/rust/nd-pdk-host/src/nd_host_artwork.rs new file mode 100644 index 000000000..e565e0956 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-host/src/nd_host_artwork.rs @@ -0,0 +1,207 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Artwork host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ArtworkGetArtistUrlRequest { + id: String, + size: i32, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ArtworkGetArtistUrlResponse { + #[serde(default)] + url: String, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ArtworkGetAlbumUrlRequest { + id: String, + size: i32, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ArtworkGetAlbumUrlResponse { + #[serde(default)] + url: String, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ArtworkGetTrackUrlRequest { + id: String, + size: i32, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ArtworkGetTrackUrlResponse { + #[serde(default)] + url: String, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ArtworkGetPlaylistUrlRequest { + id: String, + size: i32, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ArtworkGetPlaylistUrlResponse { + #[serde(default)] + url: String, + #[serde(default)] + error: Option<String>, +} + +#[host_fn] +extern "ExtismHost" { + fn artwork_getartisturl(input: Json<ArtworkGetArtistUrlRequest>) -> Json<ArtworkGetArtistUrlResponse>; + fn artwork_getalbumurl(input: Json<ArtworkGetAlbumUrlRequest>) -> Json<ArtworkGetAlbumUrlResponse>; + fn artwork_gettrackurl(input: Json<ArtworkGetTrackUrlRequest>) -> Json<ArtworkGetTrackUrlResponse>; + fn artwork_getplaylisturl(input: Json<ArtworkGetPlaylistUrlRequest>) -> Json<ArtworkGetPlaylistUrlResponse>; +} + +/// GetArtistUrl generates a public URL for an artist's artwork. +/// +/// Parameters: +/// - id: The artist's unique identifier +/// - size: Desired image size in pixels (0 for original size) +/// +/// Returns the public URL for the artwork, or an error if generation fails. +/// +/// # Arguments +/// * `id` - String parameter. +/// * `size` - i32 parameter. +/// +/// # Returns +/// The url value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get_artist_url(id: &str, size: i32) -> Result<String, Error> { + let response = unsafe { + artwork_getartisturl(Json(ArtworkGetArtistUrlRequest { + id: id.to_owned(), + size: size, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.url) +} + +/// GetAlbumUrl generates a public URL for an album's artwork. +/// +/// Parameters: +/// - id: The album's unique identifier +/// - size: Desired image size in pixels (0 for original size) +/// +/// Returns the public URL for the artwork, or an error if generation fails. +/// +/// # Arguments +/// * `id` - String parameter. +/// * `size` - i32 parameter. +/// +/// # Returns +/// The url value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get_album_url(id: &str, size: i32) -> Result<String, Error> { + let response = unsafe { + artwork_getalbumurl(Json(ArtworkGetAlbumUrlRequest { + id: id.to_owned(), + size: size, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.url) +} + +/// GetTrackUrl generates a public URL for a track's artwork. +/// +/// Parameters: +/// - id: The track's (media file) unique identifier +/// - size: Desired image size in pixels (0 for original size) +/// +/// Returns the public URL for the artwork, or an error if generation fails. +/// +/// # Arguments +/// * `id` - String parameter. +/// * `size` - i32 parameter. +/// +/// # Returns +/// The url value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get_track_url(id: &str, size: i32) -> Result<String, Error> { + let response = unsafe { + artwork_gettrackurl(Json(ArtworkGetTrackUrlRequest { + id: id.to_owned(), + size: size, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.url) +} + +/// GetPlaylistUrl generates a public URL for a playlist's artwork. +/// +/// Parameters: +/// - id: The playlist's unique identifier +/// - size: Desired image size in pixels (0 for original size) +/// +/// Returns the public URL for the artwork, or an error if generation fails. +/// +/// # Arguments +/// * `id` - String parameter. +/// * `size` - i32 parameter. +/// +/// # Returns +/// The url value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get_playlist_url(id: &str, size: i32) -> Result<String, Error> { + let response = unsafe { + artwork_getplaylisturl(Json(ArtworkGetPlaylistUrlRequest { + id: id.to_owned(), + size: size, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.url) +} diff --git a/plugins/pdk/rust/nd-pdk-host/src/nd_host_cache.rs b/plugins/pdk/rust/nd-pdk-host/src/nd_host_cache.rs new file mode 100644 index 000000000..267654136 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-host/src/nd_host_cache.rs @@ -0,0 +1,521 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Cache host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; +use base64::Engine as _; +use base64::engine::general_purpose::STANDARD as BASE64; + +mod base64_bytes { + use serde::{self, Deserialize, Deserializer, Serializer}; + use base64::Engine as _; + use base64::engine::general_purpose::STANDARD as BASE64; + + pub fn serialize<S>(bytes: &Vec<u8>, serializer: S) -> Result<S::Ok, S::Error> + where + S: Serializer, + { + serializer.serialize_str(&BASE64.encode(bytes)) + } + + pub fn deserialize<'de, D>(deserializer: D) -> Result<Vec<u8>, D::Error> + where + D: Deserializer<'de>, + { + let s = String::deserialize(deserializer)?; + BASE64.decode(&s).map_err(serde::de::Error::custom) + } +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct CacheSetStringRequest { + key: String, + value: String, + ttl_seconds: i64, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct CacheSetStringResponse { + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct CacheGetStringRequest { + key: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct CacheGetStringResponse { + #[serde(default)] + value: String, + #[serde(default)] + exists: bool, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct CacheSetIntRequest { + key: String, + value: i64, + ttl_seconds: i64, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct CacheSetIntResponse { + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct CacheGetIntRequest { + key: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct CacheGetIntResponse { + #[serde(default)] + value: i64, + #[serde(default)] + exists: bool, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct CacheSetFloatRequest { + key: String, + value: f64, + ttl_seconds: i64, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct CacheSetFloatResponse { + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct CacheGetFloatRequest { + key: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct CacheGetFloatResponse { + #[serde(default)] + value: f64, + #[serde(default)] + exists: bool, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct CacheSetBytesRequest { + key: String, + #[serde(with = "base64_bytes")] + value: Vec<u8>, + ttl_seconds: i64, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct CacheSetBytesResponse { + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct CacheGetBytesRequest { + key: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct CacheGetBytesResponse { + #[serde(default)] + #[serde(with = "base64_bytes")] + value: Vec<u8>, + #[serde(default)] + exists: bool, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct CacheHasRequest { + key: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct CacheHasResponse { + #[serde(default)] + exists: bool, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct CacheRemoveRequest { + key: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct CacheRemoveResponse { + #[serde(default)] + error: Option<String>, +} + +#[host_fn] +extern "ExtismHost" { + fn cache_setstring(input: Json<CacheSetStringRequest>) -> Json<CacheSetStringResponse>; + fn cache_getstring(input: Json<CacheGetStringRequest>) -> Json<CacheGetStringResponse>; + fn cache_setint(input: Json<CacheSetIntRequest>) -> Json<CacheSetIntResponse>; + fn cache_getint(input: Json<CacheGetIntRequest>) -> Json<CacheGetIntResponse>; + fn cache_setfloat(input: Json<CacheSetFloatRequest>) -> Json<CacheSetFloatResponse>; + fn cache_getfloat(input: Json<CacheGetFloatRequest>) -> Json<CacheGetFloatResponse>; + fn cache_setbytes(input: Json<CacheSetBytesRequest>) -> Json<CacheSetBytesResponse>; + fn cache_getbytes(input: Json<CacheGetBytesRequest>) -> Json<CacheGetBytesResponse>; + fn cache_has(input: Json<CacheHasRequest>) -> Json<CacheHasResponse>; + fn cache_remove(input: Json<CacheRemoveRequest>) -> Json<CacheRemoveResponse>; +} + +/// SetString stores a string value in the cache. +/// +/// Parameters: +/// - key: The cache key (will be namespaced with plugin ID) +/// - value: The string value to store +/// - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) +/// +/// Returns an error if the operation fails. +/// +/// # Arguments +/// * `key` - String parameter. +/// * `value` - String parameter. +/// * `ttl_seconds` - i64 parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn set_string(key: &str, value: &str, ttl_seconds: i64) -> Result<(), Error> { + let response = unsafe { + cache_setstring(Json(CacheSetStringRequest { + key: key.to_owned(), + value: value.to_owned(), + ttl_seconds: ttl_seconds, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} + +/// GetString retrieves a string value from the cache. +/// +/// Parameters: +/// - key: The cache key (will be namespaced with plugin ID) +/// +/// Returns the value and whether the key exists. If the key doesn't exist +/// or the stored value is not a string, exists will be false. +/// +/// # Arguments +/// * `key` - String parameter. +/// +/// # Returns +/// `Some(value)` if found, `None` otherwise. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get_string(key: &str) -> Result<Option<String>, Error> { + let response = unsafe { + cache_getstring(Json(CacheGetStringRequest { + key: key.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + if response.0.exists { + Ok(Some(response.0.value)) + } else { + Ok(None) + } +} + +/// SetInt stores an integer value in the cache. +/// +/// Parameters: +/// - key: The cache key (will be namespaced with plugin ID) +/// - value: The integer value to store +/// - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) +/// +/// Returns an error if the operation fails. +/// +/// # Arguments +/// * `key` - String parameter. +/// * `value` - i64 parameter. +/// * `ttl_seconds` - i64 parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn set_int(key: &str, value: i64, ttl_seconds: i64) -> Result<(), Error> { + let response = unsafe { + cache_setint(Json(CacheSetIntRequest { + key: key.to_owned(), + value: value, + ttl_seconds: ttl_seconds, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} + +/// GetInt retrieves an integer value from the cache. +/// +/// Parameters: +/// - key: The cache key (will be namespaced with plugin ID) +/// +/// Returns the value and whether the key exists. If the key doesn't exist +/// or the stored value is not an integer, exists will be false. +/// +/// # Arguments +/// * `key` - String parameter. +/// +/// # Returns +/// `Some(value)` if found, `None` otherwise. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get_int(key: &str) -> Result<Option<i64>, Error> { + let response = unsafe { + cache_getint(Json(CacheGetIntRequest { + key: key.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + if response.0.exists { + Ok(Some(response.0.value)) + } else { + Ok(None) + } +} + +/// SetFloat stores a float value in the cache. +/// +/// Parameters: +/// - key: The cache key (will be namespaced with plugin ID) +/// - value: The float value to store +/// - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) +/// +/// Returns an error if the operation fails. +/// +/// # Arguments +/// * `key` - String parameter. +/// * `value` - f64 parameter. +/// * `ttl_seconds` - i64 parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn set_float(key: &str, value: f64, ttl_seconds: i64) -> Result<(), Error> { + let response = unsafe { + cache_setfloat(Json(CacheSetFloatRequest { + key: key.to_owned(), + value: value, + ttl_seconds: ttl_seconds, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} + +/// GetFloat retrieves a float value from the cache. +/// +/// Parameters: +/// - key: The cache key (will be namespaced with plugin ID) +/// +/// Returns the value and whether the key exists. If the key doesn't exist +/// or the stored value is not a float, exists will be false. +/// +/// # Arguments +/// * `key` - String parameter. +/// +/// # Returns +/// `Some(value)` if found, `None` otherwise. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get_float(key: &str) -> Result<Option<f64>, Error> { + let response = unsafe { + cache_getfloat(Json(CacheGetFloatRequest { + key: key.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + if response.0.exists { + Ok(Some(response.0.value)) + } else { + Ok(None) + } +} + +/// SetBytes stores a byte slice in the cache. +/// +/// Parameters: +/// - key: The cache key (will be namespaced with plugin ID) +/// - value: The byte slice to store +/// - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) +/// +/// Returns an error if the operation fails. +/// +/// # Arguments +/// * `key` - String parameter. +/// * `value` - Vec<u8> parameter. +/// * `ttl_seconds` - i64 parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn set_bytes(key: &str, value: Vec<u8>, ttl_seconds: i64) -> Result<(), Error> { + let response = unsafe { + cache_setbytes(Json(CacheSetBytesRequest { + key: key.to_owned(), + value: value, + ttl_seconds: ttl_seconds, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} + +/// GetBytes retrieves a byte slice from the cache. +/// +/// Parameters: +/// - key: The cache key (will be namespaced with plugin ID) +/// +/// Returns the value and whether the key exists. If the key doesn't exist +/// or the stored value is not a byte slice, exists will be false. +/// +/// # Arguments +/// * `key` - String parameter. +/// +/// # Returns +/// `Some(value)` if found, `None` otherwise. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get_bytes(key: &str) -> Result<Option<Vec<u8>>, Error> { + let response = unsafe { + cache_getbytes(Json(CacheGetBytesRequest { + key: key.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + if response.0.exists { + Ok(Some(response.0.value)) + } else { + Ok(None) + } +} + +/// Has checks if a key exists in the cache. +/// +/// Parameters: +/// - key: The cache key (will be namespaced with plugin ID) +/// +/// Returns true if the key exists and has not expired. +/// +/// # Arguments +/// * `key` - String parameter. +/// +/// # Returns +/// The exists value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn has(key: &str) -> Result<bool, Error> { + let response = unsafe { + cache_has(Json(CacheHasRequest { + key: key.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.exists) +} + +/// Remove deletes a value from the cache. +/// +/// Parameters: +/// - key: The cache key (will be namespaced with plugin ID) +/// +/// Returns an error if the operation fails. Does not return an error if the key doesn't exist. +/// +/// # Arguments +/// * `key` - String parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn remove(key: &str) -> Result<(), Error> { + let response = unsafe { + cache_remove(Json(CacheRemoveRequest { + key: key.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} diff --git a/plugins/pdk/rust/nd-pdk-host/src/nd_host_config.rs b/plugins/pdk/rust/nd-pdk-host/src/nd_host_config.rs new file mode 100644 index 000000000..effd5923e --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-host/src/nd_host_config.rs @@ -0,0 +1,141 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Config host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ConfigGetRequest { + key: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ConfigGetResponse { + #[serde(default)] + value: String, + #[serde(default)] + exists: bool, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ConfigGetIntRequest { + key: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ConfigGetIntResponse { + #[serde(default)] + value: i64, + #[serde(default)] + exists: bool, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ConfigKeysRequest { + prefix: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ConfigKeysResponse { + #[serde(default)] + keys: Vec<String>, +} + +#[host_fn] +extern "ExtismHost" { + fn config_get(input: Json<ConfigGetRequest>) -> Json<ConfigGetResponse>; + fn config_getint(input: Json<ConfigGetIntRequest>) -> Json<ConfigGetIntResponse>; + fn config_keys(input: Json<ConfigKeysRequest>) -> Json<ConfigKeysResponse>; +} + +/// Get retrieves a configuration value as a string. +/// +/// Parameters: +/// - key: The configuration key +/// +/// Returns the value and whether the key exists. +/// +/// # Arguments +/// * `key` - String parameter. +/// +/// # Returns +/// `Some(value)` if found, `None` otherwise. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get(key: &str) -> Result<Option<String>, Error> { + let response = unsafe { + config_get(Json(ConfigGetRequest { + key: key.to_owned(), + }))? + }; + + if response.0.exists { + Ok(Some(response.0.value)) + } else { + Ok(None) + } +} + +/// GetInt retrieves a configuration value as an integer. +/// +/// Parameters: +/// - key: The configuration key +/// +/// Returns the value and whether the key exists. If the key exists but the +/// value cannot be parsed as an integer, exists will be false. +/// +/// # Arguments +/// * `key` - String parameter. +/// +/// # Returns +/// `Some(value)` if found, `None` otherwise. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get_int(key: &str) -> Result<Option<i64>, Error> { + let response = unsafe { + config_getint(Json(ConfigGetIntRequest { + key: key.to_owned(), + }))? + }; + + if response.0.exists { + Ok(Some(response.0.value)) + } else { + Ok(None) + } +} + +/// Keys returns configuration keys matching the given prefix. +/// +/// Parameters: +/// - prefix: Key prefix to filter by. If empty, returns all keys. +/// +/// Returns a sorted slice of matching configuration keys. +/// +/// # Arguments +/// * `prefix` - String parameter. +/// +/// # Returns +/// The keys value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn keys(prefix: &str) -> Result<Vec<String>, Error> { + let response = unsafe { + config_keys(Json(ConfigKeysRequest { + prefix: prefix.to_owned(), + }))? + }; + + Ok(response.0.keys) +} diff --git a/plugins/pdk/rust/nd-pdk-host/src/nd_host_http.rs b/plugins/pdk/rust/nd-pdk-host/src/nd_host_http.rs new file mode 100644 index 000000000..1c44cd2f3 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-host/src/nd_host_http.rs @@ -0,0 +1,110 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the HTTP host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; +use base64::Engine as _; +use base64::engine::general_purpose::STANDARD as BASE64; + +mod base64_bytes { + use serde::{self, Deserialize, Deserializer, Serializer}; + use base64::Engine as _; + use base64::engine::general_purpose::STANDARD as BASE64; + + pub fn serialize<S>(bytes: &Vec<u8>, serializer: S) -> Result<S::Ok, S::Error> + where + S: Serializer, + { + serializer.serialize_str(&BASE64.encode(bytes)) + } + + pub fn deserialize<'de, D>(deserializer: D) -> Result<Vec<u8>, D::Error> + where + D: Deserializer<'de>, + { + let s = String::deserialize(deserializer)?; + BASE64.decode(&s).map_err(serde::de::Error::custom) + } +} + +/// HTTPRequest represents an outbound HTTP request from a plugin. +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct HTTPRequest { + pub method: String, + pub url: String, + #[serde(default)] + pub headers: std::collections::HashMap<String, String>, + #[serde(default)] + pub no_follow_redirects: bool, + #[serde(default)] + #[serde(with = "base64_bytes")] + pub body: Vec<u8>, + #[serde(default)] + pub timeout_ms: i32, +} + +/// HTTPResponse represents the response from an outbound HTTP request. +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct HTTPResponse { + pub status_code: i32, + #[serde(default)] + pub headers: std::collections::HashMap<String, String>, + #[serde(default)] + #[serde(with = "base64_bytes")] + pub body: Vec<u8>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct HTTPSendRequest { + request: HTTPRequest, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct HTTPSendResponse { + #[serde(default)] + result: Option<HTTPResponse>, + #[serde(default)] + error: Option<String>, +} + +#[host_fn] +extern "ExtismHost" { + fn http_send(input: Json<HTTPSendRequest>) -> Json<HTTPSendResponse>; +} + +/// Send executes an HTTP request and returns the response. +/// +/// Parameters: +/// - request: The HTTP request to execute, including method, URL, headers, body, and timeout +/// +/// Returns the HTTP response with status code, headers, and body. +/// Network errors, timeouts, and permission failures are returned as Go errors. +/// Successful HTTP calls (including 4xx/5xx status codes) return a non-nil response with nil error. +/// +/// # Arguments +/// * `request` - HTTPRequest parameter. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn send(request: HTTPRequest) -> Result<Option<HTTPResponse>, Error> { + let response = unsafe { + http_send(Json(HTTPSendRequest { + request: request, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} diff --git a/plugins/pdk/rust/nd-pdk-host/src/nd_host_kvstore.rs b/plugins/pdk/rust/nd-pdk-host/src/nd_host_kvstore.rs new file mode 100644 index 000000000..a85e72895 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-host/src/nd_host_kvstore.rs @@ -0,0 +1,433 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the KVStore host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; +use base64::Engine as _; +use base64::engine::general_purpose::STANDARD as BASE64; + +mod base64_bytes { + use serde::{self, Deserialize, Deserializer, Serializer}; + use base64::Engine as _; + use base64::engine::general_purpose::STANDARD as BASE64; + + pub fn serialize<S>(bytes: &Vec<u8>, serializer: S) -> Result<S::Ok, S::Error> + where + S: Serializer, + { + serializer.serialize_str(&BASE64.encode(bytes)) + } + + pub fn deserialize<'de, D>(deserializer: D) -> Result<Vec<u8>, D::Error> + where + D: Deserializer<'de>, + { + let s = String::deserialize(deserializer)?; + BASE64.decode(&s).map_err(serde::de::Error::custom) + } +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreSetRequest { + key: String, + #[serde(with = "base64_bytes")] + value: Vec<u8>, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreSetResponse { + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreSetWithTTLRequest { + key: String, + #[serde(with = "base64_bytes")] + value: Vec<u8>, + ttl_seconds: i64, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreSetWithTTLResponse { + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreGetRequest { + key: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreGetResponse { + #[serde(default)] + #[serde(with = "base64_bytes")] + value: Vec<u8>, + #[serde(default)] + exists: bool, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreGetManyRequest { + keys: Vec<String>, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreGetManyResponse { + #[serde(default)] + values: std::collections::HashMap<String, Vec<u8>>, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreHasRequest { + key: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreHasResponse { + #[serde(default)] + exists: bool, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreListRequest { + prefix: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreListResponse { + #[serde(default)] + keys: Vec<String>, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreDeleteRequest { + key: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreDeleteResponse { + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreDeleteByPrefixRequest { + prefix: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreDeleteByPrefixResponse { + #[serde(default)] + deleted_count: i64, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreGetStorageUsedResponse { + #[serde(default)] + bytes: i64, + #[serde(default)] + error: Option<String>, +} + +#[host_fn] +extern "ExtismHost" { + fn kvstore_set(input: Json<KVStoreSetRequest>) -> Json<KVStoreSetResponse>; + fn kvstore_setwithttl(input: Json<KVStoreSetWithTTLRequest>) -> Json<KVStoreSetWithTTLResponse>; + fn kvstore_get(input: Json<KVStoreGetRequest>) -> Json<KVStoreGetResponse>; + fn kvstore_getmany(input: Json<KVStoreGetManyRequest>) -> Json<KVStoreGetManyResponse>; + fn kvstore_has(input: Json<KVStoreHasRequest>) -> Json<KVStoreHasResponse>; + fn kvstore_list(input: Json<KVStoreListRequest>) -> Json<KVStoreListResponse>; + fn kvstore_delete(input: Json<KVStoreDeleteRequest>) -> Json<KVStoreDeleteResponse>; + fn kvstore_deletebyprefix(input: Json<KVStoreDeleteByPrefixRequest>) -> Json<KVStoreDeleteByPrefixResponse>; + fn kvstore_getstorageused(input: Json<serde_json::Value>) -> Json<KVStoreGetStorageUsedResponse>; +} + +/// Set stores a byte value with the given key. +/// +/// Parameters: +/// - key: The storage key (max 256 bytes, UTF-8) +/// - value: The byte slice to store +/// +/// Returns an error if the storage limit would be exceeded or the operation fails. +/// +/// # Arguments +/// * `key` - String parameter. +/// * `value` - Vec<u8> parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn set(key: &str, value: Vec<u8>) -> Result<(), Error> { + let response = unsafe { + kvstore_set(Json(KVStoreSetRequest { + key: key.to_owned(), + value: value, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} + +/// SetWithTTL stores a byte value with the given key and a time-to-live. +/// +/// After ttlSeconds, the key is treated as non-existent and will be +/// cleaned up lazily. ttlSeconds must be greater than 0. +/// +/// Parameters: +/// - key: The storage key (max 256 bytes, UTF-8) +/// - value: The byte slice to store +/// - ttlSeconds: Time-to-live in seconds (must be > 0) +/// +/// Returns an error if the storage limit would be exceeded or the operation fails. +/// +/// # Arguments +/// * `key` - String parameter. +/// * `value` - Vec<u8> parameter. +/// * `ttl_seconds` - i64 parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn set_with_ttl(key: &str, value: Vec<u8>, ttl_seconds: i64) -> Result<(), Error> { + let response = unsafe { + kvstore_setwithttl(Json(KVStoreSetWithTTLRequest { + key: key.to_owned(), + value: value, + ttl_seconds: ttl_seconds, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} + +/// Get retrieves a byte value from storage. +/// +/// Parameters: +/// - key: The storage key +/// +/// Returns the value and whether the key exists. +/// +/// # Arguments +/// * `key` - String parameter. +/// +/// # Returns +/// `Some(value)` if found, `None` otherwise. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get(key: &str) -> Result<Option<Vec<u8>>, Error> { + let response = unsafe { + kvstore_get(Json(KVStoreGetRequest { + key: key.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + if response.0.exists { + Ok(Some(response.0.value)) + } else { + Ok(None) + } +} + +/// GetMany retrieves multiple values in a single call. +/// +/// Parameters: +/// - keys: The storage keys to retrieve +/// +/// Returns a map of key to value for keys that exist and have not expired. +/// Missing or expired keys are omitted from the result. +/// +/// # Arguments +/// * `keys` - Vec<String> parameter. +/// +/// # Returns +/// The values value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get_many(keys: Vec<String>) -> Result<std::collections::HashMap<String, Vec<u8>>, Error> { + let response = unsafe { + kvstore_getmany(Json(KVStoreGetManyRequest { + keys: keys, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.values) +} + +/// Has checks if a key exists in storage. +/// +/// Parameters: +/// - key: The storage key +/// +/// Returns true if the key exists. +/// +/// # Arguments +/// * `key` - String parameter. +/// +/// # Returns +/// The exists value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn has(key: &str) -> Result<bool, Error> { + let response = unsafe { + kvstore_has(Json(KVStoreHasRequest { + key: key.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.exists) +} + +/// List returns all keys matching the given prefix. +/// +/// Parameters: +/// - prefix: Key prefix to filter by (empty string returns all keys) +/// +/// Returns a slice of matching keys. +/// +/// # Arguments +/// * `prefix` - String parameter. +/// +/// # Returns +/// The keys value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn list(prefix: &str) -> Result<Vec<String>, Error> { + let response = unsafe { + kvstore_list(Json(KVStoreListRequest { + prefix: prefix.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.keys) +} + +/// Delete removes a value from storage. +/// +/// Parameters: +/// - key: The storage key +/// +/// Returns an error if the operation fails. Does not return an error if the key doesn't exist. +/// +/// # Arguments +/// * `key` - String parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn delete(key: &str) -> Result<(), Error> { + let response = unsafe { + kvstore_delete(Json(KVStoreDeleteRequest { + key: key.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} + +/// DeleteByPrefix removes all keys matching the given prefix. +/// +/// Parameters: +/// - prefix: Key prefix to match (must not be empty) +/// +/// Returns the number of keys deleted. Includes expired keys. +/// +/// # Arguments +/// * `prefix` - String parameter. +/// +/// # Returns +/// The deleted_count value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn delete_by_prefix(prefix: &str) -> Result<i64, Error> { + let response = unsafe { + kvstore_deletebyprefix(Json(KVStoreDeleteByPrefixRequest { + prefix: prefix.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.deleted_count) +} + +/// GetStorageUsed returns the total storage used by this plugin in bytes. +/// +/// # Returns +/// The bytes value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get_storage_used() -> Result<i64, Error> { + let response = unsafe { + kvstore_getstorageused(Json(serde_json::json!({})))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.bytes) +} diff --git a/plugins/pdk/rust/nd-pdk-host/src/nd_host_library.rs b/plugins/pdk/rust/nd-pdk-host/src/nd_host_library.rs new file mode 100644 index 000000000..b4b9b3fb0 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-host/src/nd_host_library.rs @@ -0,0 +1,105 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Library host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; + +/// Library represents a music library with metadata. +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct Library { + pub id: i32, + pub name: String, + #[serde(default)] + pub path: String, + #[serde(default)] + pub mount_point: String, + pub last_scan_at: i64, + pub total_songs: i32, + pub total_albums: i32, + pub total_artists: i32, + pub total_size: i64, + pub total_duration: f64, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct LibraryGetLibraryRequest { + id: i32, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct LibraryGetLibraryResponse { + #[serde(default)] + result: Option<Library>, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct LibraryGetAllLibrariesResponse { + #[serde(default)] + result: Vec<Library>, + #[serde(default)] + error: Option<String>, +} + +#[host_fn] +extern "ExtismHost" { + fn library_getlibrary(input: Json<LibraryGetLibraryRequest>) -> Json<LibraryGetLibraryResponse>; + fn library_getalllibraries(input: Json<serde_json::Value>) -> Json<LibraryGetAllLibrariesResponse>; +} + +/// GetLibrary retrieves metadata for a specific library by ID. +/// +/// Parameters: +/// - id: The library's unique identifier +/// +/// Returns the library metadata, or an error if the library is not found. +/// +/// # Arguments +/// * `id` - i32 parameter. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get_library(id: i32) -> Result<Option<Library>, Error> { + let response = unsafe { + library_getlibrary(Json(LibraryGetLibraryRequest { + id: id, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} + +/// GetAllLibraries retrieves metadata for all configured libraries. +/// +/// Returns a slice of all libraries with their metadata. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get_all_libraries() -> Result<Vec<Library>, Error> { + let response = unsafe { + library_getalllibraries(Json(serde_json::json!({})))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} diff --git a/plugins/pdk/rust/nd-pdk-host/src/nd_host_scheduler.rs b/plugins/pdk/rust/nd-pdk-host/src/nd_host_scheduler.rs new file mode 100644 index 000000000..042f97410 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-host/src/nd_host_scheduler.rs @@ -0,0 +1,159 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Scheduler host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct SchedulerScheduleOneTimeRequest { + delay_seconds: i32, + payload: String, + schedule_id: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct SchedulerScheduleOneTimeResponse { + #[serde(default)] + new_schedule_id: String, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct SchedulerScheduleRecurringRequest { + cron_expression: String, + payload: String, + schedule_id: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct SchedulerScheduleRecurringResponse { + #[serde(default)] + new_schedule_id: String, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct SchedulerCancelScheduleRequest { + schedule_id: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct SchedulerCancelScheduleResponse { + #[serde(default)] + error: Option<String>, +} + +#[host_fn] +extern "ExtismHost" { + fn scheduler_scheduleonetime(input: Json<SchedulerScheduleOneTimeRequest>) -> Json<SchedulerScheduleOneTimeResponse>; + fn scheduler_schedulerecurring(input: Json<SchedulerScheduleRecurringRequest>) -> Json<SchedulerScheduleRecurringResponse>; + fn scheduler_cancelschedule(input: Json<SchedulerCancelScheduleRequest>) -> Json<SchedulerCancelScheduleResponse>; +} + +/// ScheduleOneTime schedules a one-time event to be triggered after the specified delay. +/// Plugins that use this function must also implement the SchedulerCallback capability +/// +/// Parameters: +/// - delaySeconds: Number of seconds to wait before triggering the event +/// - payload: Data to be passed to the scheduled event handler +/// - scheduleID: Optional unique identifier for the scheduled job. If empty, one will be generated +/// +/// Returns the schedule ID that can be used to cancel the job, or an error if scheduling fails. +/// +/// # Arguments +/// * `delay_seconds` - i32 parameter. +/// * `payload` - String parameter. +/// * `schedule_id` - String parameter. +/// +/// # Returns +/// The new_schedule_id value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn schedule_one_time(delay_seconds: i32, payload: &str, schedule_id: &str) -> Result<String, Error> { + let response = unsafe { + scheduler_scheduleonetime(Json(SchedulerScheduleOneTimeRequest { + delay_seconds: delay_seconds, + payload: payload.to_owned(), + schedule_id: schedule_id.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.new_schedule_id) +} + +/// ScheduleRecurring schedules a recurring event using a cron expression. +/// Plugins that use this function must also implement the SchedulerCallback capability +/// +/// Parameters: +/// - cronExpression: Standard cron format expression (e.g., "0 0 * * *" for daily at midnight) +/// - payload: Data to be passed to each scheduled event handler invocation +/// - scheduleID: Optional unique identifier for the scheduled job. If empty, one will be generated +/// +/// Returns the schedule ID that can be used to cancel the job, or an error if scheduling fails. +/// +/// # Arguments +/// * `cron_expression` - String parameter. +/// * `payload` - String parameter. +/// * `schedule_id` - String parameter. +/// +/// # Returns +/// The new_schedule_id value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn schedule_recurring(cron_expression: &str, payload: &str, schedule_id: &str) -> Result<String, Error> { + let response = unsafe { + scheduler_schedulerecurring(Json(SchedulerScheduleRecurringRequest { + cron_expression: cron_expression.to_owned(), + payload: payload.to_owned(), + schedule_id: schedule_id.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.new_schedule_id) +} + +/// CancelSchedule cancels a scheduled job identified by its schedule ID. +/// +/// This works for both one-time and recurring schedules. Once cancelled, the job will not trigger +/// any future events. +/// +/// Returns an error if the schedule ID is not found or if cancellation fails. +/// +/// # Arguments +/// * `schedule_id` - String parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn cancel_schedule(schedule_id: &str) -> Result<(), Error> { + let response = unsafe { + scheduler_cancelschedule(Json(SchedulerCancelScheduleRequest { + schedule_id: schedule_id.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} diff --git a/plugins/pdk/rust/nd-pdk-host/src/nd_host_subsonicapi.rs b/plugins/pdk/rust/nd-pdk-host/src/nd_host_subsonicapi.rs new file mode 100644 index 000000000..56ba1066e --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-host/src/nd_host_subsonicapi.rs @@ -0,0 +1,122 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the SubsonicAPI host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; +use base64::Engine as _; +use base64::engine::general_purpose::STANDARD as BASE64; + +mod base64_bytes { + use serde::{self, Deserialize, Deserializer, Serializer}; + use base64::Engine as _; + use base64::engine::general_purpose::STANDARD as BASE64; + + pub fn serialize<S>(bytes: &Vec<u8>, serializer: S) -> Result<S::Ok, S::Error> + where + S: Serializer, + { + serializer.serialize_str(&BASE64.encode(bytes)) + } + + pub fn deserialize<'de, D>(deserializer: D) -> Result<Vec<u8>, D::Error> + where + D: Deserializer<'de>, + { + let s = String::deserialize(deserializer)?; + BASE64.decode(&s).map_err(serde::de::Error::custom) + } +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct SubsonicAPICallRequest { + uri: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct SubsonicAPICallResponse { + #[serde(default)] + response_json: String, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct SubsonicAPICallRawRequest { + uri: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct SubsonicAPICallRawResponse { + #[serde(default)] + content_type: String, + #[serde(default)] + #[serde(with = "base64_bytes")] + data: Vec<u8>, + #[serde(default)] + error: Option<String>, +} + +#[host_fn] +extern "ExtismHost" { + fn subsonicapi_call(input: Json<SubsonicAPICallRequest>) -> Json<SubsonicAPICallResponse>; + fn subsonicapi_callraw(input: Json<SubsonicAPICallRawRequest>) -> Json<SubsonicAPICallRawResponse>; +} + +/// Call executes a Subsonic API request and returns the JSON response. +/// +/// The uri parameter should be the Subsonic API path without the server prefix, +/// e.g., "getAlbumList2?type=random&size=10". The response is returned as raw JSON. +/// +/// # Arguments +/// * `uri` - String parameter. +/// +/// # Returns +/// The response_json value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn call(uri: &str) -> Result<String, Error> { + let response = unsafe { + subsonicapi_call(Json(SubsonicAPICallRequest { + uri: uri.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.response_json) +} + +/// CallRaw executes a Subsonic API request and returns the raw binary response. +/// Designed for binary endpoints like getCoverArt and stream that return +/// non-JSON data. The data is base64-encoded over JSON on the wire. +/// +/// # Arguments +/// * `uri` - String parameter. +/// +/// # Returns +/// A tuple of (content_type, data). +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn call_raw(uri: &str) -> Result<(String, Vec<u8>), Error> { + let response = unsafe { + subsonicapi_callraw(Json(SubsonicAPICallRawRequest { + uri: uri.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok((response.0.content_type, response.0.data)) +} diff --git a/plugins/pdk/rust/nd-pdk-host/src/nd_host_task.rs b/plugins/pdk/rust/nd-pdk-host/src/nd_host_task.rs new file mode 100644 index 000000000..4f43e165c --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-host/src/nd_host_task.rs @@ -0,0 +1,258 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Task host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; +use base64::Engine as _; +use base64::engine::general_purpose::STANDARD as BASE64; + +mod base64_bytes { + use serde::{self, Deserialize, Deserializer, Serializer}; + use base64::Engine as _; + use base64::engine::general_purpose::STANDARD as BASE64; + + pub fn serialize<S>(bytes: &Vec<u8>, serializer: S) -> Result<S::Ok, S::Error> + where + S: Serializer, + { + serializer.serialize_str(&BASE64.encode(bytes)) + } + + pub fn deserialize<'de, D>(deserializer: D) -> Result<Vec<u8>, D::Error> + where + D: Deserializer<'de>, + { + let s = String::deserialize(deserializer)?; + BASE64.decode(&s).map_err(serde::de::Error::custom) + } +} + +/// QueueConfig holds configuration for a task queue. +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct QueueConfig { + pub concurrency: i32, + pub max_retries: i32, + pub backoff_ms: i64, + pub delay_ms: i64, + pub retention_ms: i64, +} + +/// TaskInfo holds the current state of a task. +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TaskInfo { + pub status: String, + pub message: String, + pub attempt: i32, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct TaskCreateQueueRequest { + name: String, + config: QueueConfig, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct TaskCreateQueueResponse { + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct TaskEnqueueRequest { + queue_name: String, + #[serde(with = "base64_bytes")] + payload: Vec<u8>, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct TaskEnqueueResponse { + #[serde(default)] + result: String, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct TaskGetRequest { + task_id: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct TaskGetResponse { + #[serde(default)] + result: Option<TaskInfo>, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct TaskCancelRequest { + task_id: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct TaskCancelResponse { + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct TaskClearQueueRequest { + queue_name: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct TaskClearQueueResponse { + #[serde(default)] + result: i64, + #[serde(default)] + error: Option<String>, +} + +#[host_fn] +extern "ExtismHost" { + fn task_createqueue(input: Json<TaskCreateQueueRequest>) -> Json<TaskCreateQueueResponse>; + fn task_enqueue(input: Json<TaskEnqueueRequest>) -> Json<TaskEnqueueResponse>; + fn task_get(input: Json<TaskGetRequest>) -> Json<TaskGetResponse>; + fn task_cancel(input: Json<TaskCancelRequest>) -> Json<TaskCancelResponse>; + fn task_clearqueue(input: Json<TaskClearQueueRequest>) -> Json<TaskClearQueueResponse>; +} + +/// CreateQueue creates a named task queue with the given configuration. +/// Zero-value fields in config use sensible defaults. +/// If a queue with the same name already exists, returns an error. +/// On startup, this also recovers any stale "running" tasks from a previous crash. +/// +/// # Arguments +/// * `name` - String parameter. +/// * `config` - QueueConfig parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn create_queue(name: &str, config: QueueConfig) -> Result<(), Error> { + let response = unsafe { + task_createqueue(Json(TaskCreateQueueRequest { + name: name.to_owned(), + config: config, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} + +/// Enqueue adds a task to the named queue. Returns the task ID. +/// payload is opaque bytes passed back to the plugin on execution. +/// +/// # Arguments +/// * `queue_name` - String parameter. +/// * `payload` - Vec<u8> parameter. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn enqueue(queue_name: &str, payload: Vec<u8>) -> Result<String, Error> { + let response = unsafe { + task_enqueue(Json(TaskEnqueueRequest { + queue_name: queue_name.to_owned(), + payload: payload, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} + +/// Get returns the current state of a task including its status, +/// message, and attempt count. +/// +/// # Arguments +/// * `task_id` - String parameter. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get(task_id: &str) -> Result<Option<TaskInfo>, Error> { + let response = unsafe { + task_get(Json(TaskGetRequest { + task_id: task_id.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} + +/// Cancel cancels a pending task. Returns error if already +/// running, completed, or failed. +/// +/// # Arguments +/// * `task_id` - String parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn cancel(task_id: &str) -> Result<(), Error> { + let response = unsafe { + task_cancel(Json(TaskCancelRequest { + task_id: task_id.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} + +/// ClearQueue removes all pending tasks from the named queue. +/// Running tasks are not affected. Returns the number of tasks removed. +/// +/// # Arguments +/// * `queue_name` - String parameter. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn clear_queue(queue_name: &str) -> Result<i64, Error> { + let response = unsafe { + task_clearqueue(Json(TaskClearQueueRequest { + queue_name: queue_name.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} diff --git a/plugins/pdk/rust/nd-pdk-host/src/nd_host_users.rs b/plugins/pdk/rust/nd-pdk-host/src/nd_host_users.rs new file mode 100644 index 000000000..faa795bb9 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-host/src/nd_host_users.rs @@ -0,0 +1,86 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Users host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; + +/// User represents a Navidrome user with minimal information exposed to plugins. +/// Sensitive fields like password, email, and internal IDs are intentionally excluded. +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct User { + pub user_name: String, + pub name: String, + pub is_admin: bool, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct UsersGetUsersResponse { + #[serde(default)] + result: Vec<User>, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct UsersGetAdminsResponse { + #[serde(default)] + result: Vec<User>, + #[serde(default)] + error: Option<String>, +} + +#[host_fn] +extern "ExtismHost" { + fn users_getusers(input: Json<serde_json::Value>) -> Json<UsersGetUsersResponse>; + fn users_getadmins(input: Json<serde_json::Value>) -> Json<UsersGetAdminsResponse>; +} + +/// GetUsers returns all users the plugin has been granted access to. +/// Only minimal user information (userName, name, isAdmin) is returned. +/// Sensitive fields like password and email are never exposed. +/// +/// Returns a slice of users the plugin can access, or an empty slice if none configured. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get_users() -> Result<Vec<User>, Error> { + let response = unsafe { + users_getusers(Json(serde_json::json!({})))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} + +/// GetAdmins returns only admin users the plugin has been granted access to. +/// This is a convenience method that filters GetUsers results to include only admins. +/// +/// Returns a slice of admin users the plugin can access, or an empty slice if none. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get_admins() -> Result<Vec<User>, Error> { + let response = unsafe { + users_getadmins(Json(serde_json::json!({})))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} diff --git a/plugins/pdk/rust/nd-pdk-host/src/nd_host_websocket.rs b/plugins/pdk/rust/nd-pdk-host/src/nd_host_websocket.rs new file mode 100644 index 000000000..05ceb5407 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-host/src/nd_host_websocket.rs @@ -0,0 +1,228 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the WebSocket host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; +use base64::Engine as _; +use base64::engine::general_purpose::STANDARD as BASE64; + +mod base64_bytes { + use serde::{self, Deserialize, Deserializer, Serializer}; + use base64::Engine as _; + use base64::engine::general_purpose::STANDARD as BASE64; + + pub fn serialize<S>(bytes: &Vec<u8>, serializer: S) -> Result<S::Ok, S::Error> + where + S: Serializer, + { + serializer.serialize_str(&BASE64.encode(bytes)) + } + + pub fn deserialize<'de, D>(deserializer: D) -> Result<Vec<u8>, D::Error> + where + D: Deserializer<'de>, + { + let s = String::deserialize(deserializer)?; + BASE64.decode(&s).map_err(serde::de::Error::custom) + } +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct WebSocketConnectRequest { + url: String, + headers: std::collections::HashMap<String, String>, + connection_id: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct WebSocketConnectResponse { + #[serde(default)] + new_connection_id: String, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct WebSocketSendTextRequest { + connection_id: String, + message: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct WebSocketSendTextResponse { + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct WebSocketSendBinaryRequest { + connection_id: String, + #[serde(with = "base64_bytes")] + data: Vec<u8>, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct WebSocketSendBinaryResponse { + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct WebSocketCloseConnectionRequest { + connection_id: String, + code: i32, + reason: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct WebSocketCloseConnectionResponse { + #[serde(default)] + error: Option<String>, +} + +#[host_fn] +extern "ExtismHost" { + fn websocket_connect(input: Json<WebSocketConnectRequest>) -> Json<WebSocketConnectResponse>; + fn websocket_sendtext(input: Json<WebSocketSendTextRequest>) -> Json<WebSocketSendTextResponse>; + fn websocket_sendbinary(input: Json<WebSocketSendBinaryRequest>) -> Json<WebSocketSendBinaryResponse>; + fn websocket_closeconnection(input: Json<WebSocketCloseConnectionRequest>) -> Json<WebSocketCloseConnectionResponse>; +} + +/// Connect establishes a WebSocket connection to the specified URL. +/// +/// Plugins that use this function must also implement the WebSocketCallback capability +/// to receive incoming messages and connection events. +/// +/// Parameters: +/// - url: The WebSocket URL to connect to (ws:// or wss://) +/// - headers: Optional HTTP headers to include in the handshake request +/// - connectionID: Optional unique identifier for the connection. If empty, one will be generated +/// +/// Returns the connection ID that can be used to send messages or close the connection, +/// or an error if the connection fails. +/// +/// # Arguments +/// * `url` - String parameter. +/// * `headers` - std::collections::HashMap<String, String> parameter. +/// * `connection_id` - String parameter. +/// +/// # Returns +/// The new_connection_id value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn connect(url: &str, headers: std::collections::HashMap<String, String>, connection_id: &str) -> Result<String, Error> { + let response = unsafe { + websocket_connect(Json(WebSocketConnectRequest { + url: url.to_owned(), + headers: headers, + connection_id: connection_id.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.new_connection_id) +} + +/// SendText sends a text message over an established WebSocket connection. +/// +/// Parameters: +/// - connectionID: The connection identifier returned by Connect +/// - message: The text message to send +/// +/// Returns an error if the connection is not found or if sending fails. +/// +/// # Arguments +/// * `connection_id` - String parameter. +/// * `message` - String parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn send_text(connection_id: &str, message: &str) -> Result<(), Error> { + let response = unsafe { + websocket_sendtext(Json(WebSocketSendTextRequest { + connection_id: connection_id.to_owned(), + message: message.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} + +/// SendBinary sends binary data over an established WebSocket connection. +/// +/// Parameters: +/// - connectionID: The connection identifier returned by Connect +/// - data: The binary data to send +/// +/// Returns an error if the connection is not found or if sending fails. +/// +/// # Arguments +/// * `connection_id` - String parameter. +/// * `data` - Vec<u8> parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn send_binary(connection_id: &str, data: Vec<u8>) -> Result<(), Error> { + let response = unsafe { + websocket_sendbinary(Json(WebSocketSendBinaryRequest { + connection_id: connection_id.to_owned(), + data: data, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} + +/// CloseConnection gracefully closes a WebSocket connection. +/// +/// Parameters: +/// - connectionID: The connection identifier returned by Connect +/// - code: WebSocket close status code (e.g., 1000 for normal closure) +/// - reason: Optional human-readable reason for closing +/// +/// Returns an error if the connection is not found or if closing fails. +/// +/// # Arguments +/// * `connection_id` - String parameter. +/// * `code` - i32 parameter. +/// * `reason` - String parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn close_connection(connection_id: &str, code: i32, reason: &str) -> Result<(), Error> { + let response = unsafe { + websocket_closeconnection(Json(WebSocketCloseConnectionRequest { + connection_id: connection_id.to_owned(), + code: code, + reason: reason.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} diff --git a/plugins/pdk/rust/nd-pdk/Cargo.toml b/plugins/pdk/rust/nd-pdk/Cargo.toml new file mode 100644 index 000000000..34fe9f032 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk/Cargo.toml @@ -0,0 +1,18 @@ +[package] +name = "nd-pdk" +version = "0.1.0" +edition = "2021" +description = "Navidrome Plugin Development Kit for Rust" +authors = ["Navidrome Team"] +license = "GPL-3.0" +readme = "../README.md" + +[lib] +crate-type = ["rlib"] + +[dependencies] +nd-pdk-host = { path = "../nd-pdk-host" } +nd-pdk-capabilities = { path = "../nd-pdk-capabilities" } +extism-pdk = "1.2" +serde = { version = "1.0", features = ["derive"] } +serde_json = "1.0" diff --git a/plugins/pdk/rust/nd-pdk/src/lib.rs b/plugins/pdk/rust/nd-pdk/src/lib.rs new file mode 100644 index 000000000..b1389938b --- /dev/null +++ b/plugins/pdk/rust/nd-pdk/src/lib.rs @@ -0,0 +1,35 @@ +//! Navidrome Plugin Development Kit for Rust +//! +//! This crate provides a unified API for building Navidrome plugins in Rust. +//! It re-exports all functionality from the host and capabilities sub-crates. +//! +//! # Example +//! +//! ```rust,no_run +//! use nd_pdk::scrobbler::{Scrobbler, IsAuthorizedRequest, Error}; +//! use nd_pdk::register_scrobbler; +//! +//! struct MyPlugin; +//! +//! impl Default for MyPlugin { +//! fn default() -> Self { MyPlugin } +//! } +//! +//! impl Scrobbler for MyPlugin { +//! fn is_authorized(&self, req: IsAuthorizedRequest) -> Result<bool, Error> { +//! Ok(true) +//! } +//! // ... implement other required methods +//! } +//! +//! register_scrobbler!(MyPlugin); +//! ``` + +/// Host function wrappers for calling Navidrome services from plugins. +pub use nd_pdk_host as host; + +/// Capability wrappers for implementing plugin exports. +pub use nd_pdk_capabilities::*; + +/// Re-export extism-pdk for convenience. +pub use extism_pdk; diff --git a/plugins/plugin_lifecycle_manager.go b/plugins/plugin_lifecycle_manager.go deleted file mode 100644 index e00e7e5f3..000000000 --- a/plugins/plugin_lifecycle_manager.go +++ /dev/null @@ -1,95 +0,0 @@ -package plugins - -import ( - "context" - "maps" - "sync" - "time" - - "github.com/navidrome/navidrome/conf" - "github.com/navidrome/navidrome/consts" - "github.com/navidrome/navidrome/core/metrics" - "github.com/navidrome/navidrome/log" - "github.com/navidrome/navidrome/plugins/api" -) - -// pluginLifecycleManager tracks which plugins have been initialized and manages their lifecycle -type pluginLifecycleManager struct { - plugins sync.Map // string -> bool - config map[string]map[string]string - metrics metrics.Metrics -} - -// newPluginLifecycleManager creates a new plugin lifecycle manager -func newPluginLifecycleManager(metrics metrics.Metrics) *pluginLifecycleManager { - config := maps.Clone(conf.Server.PluginConfig) - return &pluginLifecycleManager{ - config: config, - metrics: metrics, - } -} - -// isInitialized checks if a plugin has been initialized -func (m *pluginLifecycleManager) isInitialized(plugin *plugin) bool { - key := plugin.ID + consts.Zwsp + plugin.Manifest.Version - value, exists := m.plugins.Load(key) - return exists && value.(bool) -} - -// markInitialized marks a plugin as initialized -func (m *pluginLifecycleManager) markInitialized(plugin *plugin) { - key := plugin.ID + consts.Zwsp + plugin.Manifest.Version - m.plugins.Store(key, true) -} - -// clearInitialized removes the initialization state of a plugin -func (m *pluginLifecycleManager) clearInitialized(plugin *plugin) { - key := plugin.ID + consts.Zwsp + plugin.Manifest.Version - m.plugins.Delete(key) -} - -// callOnInit calls the OnInit method on a plugin that implements LifecycleManagement -func (m *pluginLifecycleManager) callOnInit(plugin *plugin) error { - ctx := context.Background() - log.Debug("Initializing plugin", "name", plugin.ID) - start := time.Now() - - // Create LifecycleManagement plugin instance - loader, err := api.NewLifecycleManagementPlugin(ctx, api.WazeroRuntime(plugin.Runtime), api.WazeroModuleConfig(plugin.ModConfig)) - if loader == nil || err != nil { - log.Error("Error creating LifecycleManagement plugin", "plugin", plugin.ID, err) - return err - } - - initPlugin, err := loader.Load(ctx, plugin.WasmPath) - if err != nil { - log.Error("Error loading LifecycleManagement plugin", "plugin", plugin.ID, "path", plugin.WasmPath, err) - return err - } - defer initPlugin.Close(ctx) - - // Prepare the request with plugin-specific configuration - req := &api.InitRequest{} - - // Add plugin configuration if available - if m.config != nil { - if pluginConfig, ok := m.config[plugin.ID]; ok && len(pluginConfig) > 0 { - req.Config = maps.Clone(pluginConfig) - log.Debug("Passing configuration to plugin", "plugin", plugin.ID, "configKeys", len(pluginConfig)) - } - } - - // Call OnInit - callStart := time.Now() - _, err = checkErr(initPlugin.OnInit(ctx, req)) - m.metrics.RecordPluginRequest(ctx, plugin.ID, "OnInit", err == nil, time.Since(callStart).Milliseconds()) - if err != nil { - log.Error("Error initializing plugin", "plugin", plugin.ID, "elapsed", time.Since(start), err) - return err - } - - // Mark the plugin as initialized - m.markInitialized(plugin) - log.Debug("Plugin initialized successfully", "plugin", plugin.ID, "elapsed", time.Since(start)) - return nil -} diff --git a/plugins/plugin_lifecycle_manager_test.go b/plugins/plugin_lifecycle_manager_test.go deleted file mode 100644 index 800630ce9..000000000 --- a/plugins/plugin_lifecycle_manager_test.go +++ /dev/null @@ -1,166 +0,0 @@ -package plugins - -import ( - "github.com/navidrome/navidrome/consts" - "github.com/navidrome/navidrome/core/metrics" - "github.com/navidrome/navidrome/plugins/schema" - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" -) - -// Helper function to check if a plugin implements LifecycleManagement -func hasInitService(info *plugin) bool { - for _, c := range info.Capabilities { - if c == CapabilityLifecycleManagement { - return true - } - } - return false -} - -var _ = Describe("LifecycleManagement", func() { - Describe("Plugin Lifecycle Manager", func() { - var lifecycleManager *pluginLifecycleManager - - BeforeEach(func() { - lifecycleManager = newPluginLifecycleManager(metrics.NewNoopInstance()) - }) - - It("should track initialization state of plugins", func() { - // Create test plugins - plugin1 := &plugin{ - ID: "test-plugin", - Capabilities: []string{CapabilityLifecycleManagement}, - Manifest: &schema.PluginManifest{ - Version: "1.0.0", - }, - } - - plugin2 := &plugin{ - ID: "another-plugin", - Capabilities: []string{CapabilityLifecycleManagement}, - Manifest: &schema.PluginManifest{ - Version: "0.5.0", - }, - } - - // Initially, no plugins should be initialized - Expect(lifecycleManager.isInitialized(plugin1)).To(BeFalse()) - Expect(lifecycleManager.isInitialized(plugin2)).To(BeFalse()) - - // Mark first plugin as initialized - lifecycleManager.markInitialized(plugin1) - - // Check state - Expect(lifecycleManager.isInitialized(plugin1)).To(BeTrue()) - Expect(lifecycleManager.isInitialized(plugin2)).To(BeFalse()) - - // Mark second plugin as initialized - lifecycleManager.markInitialized(plugin2) - - // Both should be initialized now - Expect(lifecycleManager.isInitialized(plugin1)).To(BeTrue()) - Expect(lifecycleManager.isInitialized(plugin2)).To(BeTrue()) - }) - - It("should handle plugins with same name but different versions", func() { - plugin1 := &plugin{ - ID: "test-plugin", - Capabilities: []string{CapabilityLifecycleManagement}, - Manifest: &schema.PluginManifest{ - Version: "1.0.0", - }, - } - - plugin2 := &plugin{ - ID: "test-plugin", // Same name - Capabilities: []string{CapabilityLifecycleManagement}, - Manifest: &schema.PluginManifest{ - Version: "2.0.0", // Different version - }, - } - - // Mark v1 as initialized - lifecycleManager.markInitialized(plugin1) - - // v1 should be initialized but not v2 - Expect(lifecycleManager.isInitialized(plugin1)).To(BeTrue()) - Expect(lifecycleManager.isInitialized(plugin2)).To(BeFalse()) - - // Mark v2 as initialized - lifecycleManager.markInitialized(plugin2) - - // Both versions should be initialized now - Expect(lifecycleManager.isInitialized(plugin1)).To(BeTrue()) - Expect(lifecycleManager.isInitialized(plugin2)).To(BeTrue()) - - // Verify the keys used for tracking - key1 := plugin1.ID + consts.Zwsp + plugin1.Manifest.Version - key2 := plugin1.ID + consts.Zwsp + plugin2.Manifest.Version - _, exists1 := lifecycleManager.plugins.Load(key1) - _, exists2 := lifecycleManager.plugins.Load(key2) - Expect(exists1).To(BeTrue()) - Expect(exists2).To(BeTrue()) - Expect(key1).NotTo(Equal(key2)) - }) - - It("should only consider plugins that implement LifecycleManagement", func() { - // Plugin that implements LifecycleManagement - initPlugin := &plugin{ - ID: "init-plugin", - Capabilities: []string{CapabilityLifecycleManagement}, - Manifest: &schema.PluginManifest{ - Version: "1.0.0", - }, - } - - // Plugin that doesn't implement LifecycleManagement - regularPlugin := &plugin{ - ID: "regular-plugin", - Capabilities: []string{"MetadataAgent"}, - Manifest: &schema.PluginManifest{ - Version: "1.0.0", - }, - } - - // Check if plugins can be initialized - Expect(hasInitService(initPlugin)).To(BeTrue()) - Expect(hasInitService(regularPlugin)).To(BeFalse()) - }) - - It("should properly construct the plugin key", func() { - plugin := &plugin{ - ID: "test-plugin", - Manifest: &schema.PluginManifest{ - Version: "1.0.0", - }, - } - - expectedKey := "test-plugin" + consts.Zwsp + "1.0.0" - actualKey := plugin.ID + consts.Zwsp + plugin.Manifest.Version - - Expect(actualKey).To(Equal(expectedKey)) - }) - - It("should clear initialization state when requested", func() { - plugin := &plugin{ - ID: "test-plugin", - Capabilities: []string{CapabilityLifecycleManagement}, - Manifest: &schema.PluginManifest{ - Version: "1.0.0", - }, - } - - // Initially not initialized - Expect(lifecycleManager.isInitialized(plugin)).To(BeFalse()) - - // Mark as initialized - lifecycleManager.markInitialized(plugin) - Expect(lifecycleManager.isInitialized(plugin)).To(BeTrue()) - - // Clear initialization state - lifecycleManager.clearInitialized(plugin) - Expect(lifecycleManager.isInitialized(plugin)).To(BeFalse()) - }) - }) -}) diff --git a/plugins/plugins_suite_test.go b/plugins/plugins_suite_test.go index 153426317..1799ba3ce 100644 --- a/plugins/plugins_suite_test.go +++ b/plugins/plugins_suite_test.go @@ -1,10 +1,24 @@ +//go:build !windows + package plugins import ( + "context" + "crypto/sha256" + "encoding/hex" + "encoding/json" + "net/http" + "os" "os/exec" + "path/filepath" + "runtime" "testing" + "time" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/tests" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" @@ -12,9 +26,30 @@ import ( const testDataDir = "plugins/testdata" +// Shared test state initialized in BeforeSuite +var ( + testdataDir string // Path to testdata folder with test plugin .ndp packages + tmpPluginsDir string // Temp directory for plugin tests that modify files + testManager *Manager +) + func TestPlugins(t *testing.T) { tests.Init(t, false) buildTestPlugins(t, testDataDir) + + // Create a shared wazero compilation cache directory. + // All test managers will point CacheFolder here so that WASM compilation + // is done once per binary and then reused from disk cache. + sharedCacheDir, err := os.MkdirTemp("", "plugins-shared-cache-*") + if err != nil { + t.Fatalf("Failed to create shared cache dir: %v", err) + } + t.Cleanup(func() { os.RemoveAll(sharedCacheDir) }) + + // Set CacheFolder globally so all tests (including those using + // configtest.SetupConfig) inherit it without needing to set it manually. + conf.Server.CacheFolder = sharedCacheDir + log.SetLevel(log.LevelFatal) RegisterFailHandler(Fail) RunSpecs(t, "Plugins Suite") @@ -22,11 +57,122 @@ func TestPlugins(t *testing.T) { func buildTestPlugins(t *testing.T, path string) { t.Helper() + start := time.Now() t.Logf("[BeforeSuite] Current working directory: %s", path) cmd := exec.Command("make", "-C", path) out, err := cmd.CombinedOutput() - t.Logf("[BeforeSuite] Make output: %s", string(out)) + t.Logf("[BeforeSuite] Make output: %s elapsed: %s", string(out), time.Since(start)) if err != nil { t.Fatalf("Failed to build test plugins: %v", err) } } + +// createTestManager creates a new plugin Manager with the given plugin config. +// It creates a temp directory, copies the test-metadata-agent plugin, and starts the manager. +// Returns the manager, temp directory path, and a cleanup function. +func createTestManager(pluginConfig map[string]map[string]string) (*Manager, string) { + return createTestManagerWithPlugins(pluginConfig, "test-metadata-agent"+PackageExtension) +} + +// createTestManagerWithPlugins creates a new plugin Manager with the given plugin config +// and specified plugins. It creates a temp directory, copies the specified plugins, and starts the manager. +// Returns the manager and temp directory path. +func createTestManagerWithPlugins(pluginConfig map[string]map[string]string, plugins ...string) (*Manager, string) { + return createTestManagerWithPluginsAndMetrics(pluginConfig, noopMetricsRecorder{}, plugins...) +} + +// createTestManagerWithPluginsAndMetrics creates a new plugin Manager with the given plugin config, +// metrics recorder, and specified plugins. It creates a temp directory, copies the specified plugins, and starts the manager. +// Returns the manager and temp directory path. +func createTestManagerWithPluginsAndMetrics(pluginConfig map[string]map[string]string, metrics PluginMetricsRecorder, plugins ...string) (*Manager, string) { + // Create temp directory + tmpDir, err := os.MkdirTemp("", "plugins-test-*") + Expect(err).ToNot(HaveOccurred()) + + // Copy test plugins to temp dir and build plugin list with SHA256 + var enabledPlugins model.Plugins + for _, plugin := range plugins { + srcPath := filepath.Join(testdataDir, plugin) + destPath := filepath.Join(tmpDir, plugin) + data, err := os.ReadFile(srcPath) + Expect(err).ToNot(HaveOccurred()) + err = os.WriteFile(destPath, data, 0600) + Expect(err).ToNot(HaveOccurred()) + + // Compute SHA256 for the plugin + hash := sha256.Sum256(data) + hashHex := hex.EncodeToString(hash[:]) + pluginName := plugin[:len(plugin)-len(PackageExtension)] // Remove .ndp extension + + // Build config JSON if provided + configJSON := "" + if pluginConfig != nil && pluginConfig[pluginName] != nil { + // Encode config to JSON + configBytes, err := json.Marshal(pluginConfig[pluginName]) + Expect(err).ToNot(HaveOccurred()) + configJSON = string(configBytes) + } + + enabledPlugins = append(enabledPlugins, model.Plugin{ + ID: pluginName, + Path: destPath, + SHA256: hashHex, + Enabled: true, + Config: configJSON, + AllUsers: true, // Allow all users by default in tests + }) + } + + // Setup config + DeferCleanup(configtest.SetupConfig()) + conf.Server.Plugins.Enabled = true + conf.Server.Plugins.Folder = tmpDir + conf.Server.Plugins.AutoReload = false + + // Setup mock DataStore with pre-enabled plugins + mockPluginRepo := tests.CreateMockPluginRepo() + mockPluginRepo.Permitted = true + mockPluginRepo.SetData(enabledPlugins) + dataStore := &tests.MockDataStore{MockedPlugin: mockPluginRepo} + + // Create and start manager + manager := &Manager{ + plugins: make(map[string]*plugin), + ds: dataStore, + metrics: metrics, + subsonicRouter: http.NotFoundHandler(), // Stub router for tests + } + err = manager.Start(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + + DeferCleanup(func() { + _ = manager.Stop() + _ = os.RemoveAll(tmpDir) + }) + + return manager, tmpDir +} + +var _ = BeforeSuite(func() { + // Get testdata directory (where test plugin .ndp packages live) + _, currentFile, _, ok := runtime.Caller(0) + Expect(ok).To(BeTrue()) + testdataDir = filepath.Join(filepath.Dir(currentFile), "testdata") + + // Create shared manager for most tests + testManager, tmpPluginsDir = createTestManager(nil) +}) + +var _ = AfterSuite(func() { + if testManager != nil { + _ = testManager.Stop() + } + if tmpPluginsDir != "" { + _ = os.RemoveAll(tmpPluginsDir) + } +}) + +// noopMetricsRecorder is a no-op implementation of PluginMetricsRecorder for tests +type noopMetricsRecorder struct{} + +func (noopMetricsRecorder) RecordPluginRequest(context.Context, string, string, bool, int64) {} diff --git a/plugins/runtime.go b/plugins/runtime.go deleted file mode 100644 index ee298e63d..000000000 --- a/plugins/runtime.go +++ /dev/null @@ -1,626 +0,0 @@ -package plugins - -import ( - "context" - "crypto/md5" - "fmt" - "io/fs" - "maps" - "os" - "path/filepath" - "sort" - "sync" - "sync/atomic" - "time" - - "github.com/dustin/go-humanize" - "github.com/navidrome/navidrome/conf" - "github.com/navidrome/navidrome/log" - "github.com/navidrome/navidrome/plugins/api" - "github.com/navidrome/navidrome/plugins/host/artwork" - "github.com/navidrome/navidrome/plugins/host/cache" - "github.com/navidrome/navidrome/plugins/host/config" - "github.com/navidrome/navidrome/plugins/host/http" - "github.com/navidrome/navidrome/plugins/host/scheduler" - "github.com/navidrome/navidrome/plugins/host/subsonicapi" - "github.com/navidrome/navidrome/plugins/host/websocket" - "github.com/navidrome/navidrome/plugins/schema" - "github.com/tetratelabs/wazero" - wazeroapi "github.com/tetratelabs/wazero/api" - "github.com/tetratelabs/wazero/imports/wasi_snapshot_preview1" -) - -const maxParallelCompilations = 2 // Limit to 2 concurrent compilations - -var ( - compileSemaphore = make(chan struct{}, maxParallelCompilations) - compilationCache wazero.CompilationCache - cacheOnce sync.Once - runtimePool sync.Map // map[string]*cachingRuntime -) - -// createRuntime returns a function that creates a new wazero runtime and instantiates the required host functions -// based on the given plugin permissions -func (m *managerImpl) createRuntime(pluginID string, permissions schema.PluginManifestPermissions) api.WazeroNewRuntime { - return func(ctx context.Context) (wazero.Runtime, error) { - // Check if runtime already exists - if rt, ok := runtimePool.Load(pluginID); ok { - log.Trace(ctx, "Using existing runtime", "plugin", pluginID, "runtime", fmt.Sprintf("%p", rt)) - // Return a new wrapper for each call, so each instance gets its own module capture - return newScopedRuntime(rt.(wazero.Runtime)), nil - } - - // Create new runtime with all the setup - cachingRT, err := m.createCachingRuntime(ctx, pluginID, permissions) - if err != nil { - return nil, err - } - - // Use LoadOrStore to atomically check and store, preventing race conditions - if existing, loaded := runtimePool.LoadOrStore(pluginID, cachingRT); loaded { - // Another goroutine created the runtime first, close ours and return the existing one - log.Trace(ctx, "Race condition detected, using existing runtime", "plugin", pluginID, "runtime", fmt.Sprintf("%p", existing)) - _ = cachingRT.Close(ctx) - return newScopedRuntime(existing.(wazero.Runtime)), nil - } - - log.Trace(ctx, "Created new runtime", "plugin", pluginID, "runtime", fmt.Sprintf("%p", cachingRT)) - return newScopedRuntime(cachingRT), nil - } -} - -// createCachingRuntime handles the complex logic of setting up a new cachingRuntime -func (m *managerImpl) createCachingRuntime(ctx context.Context, pluginID string, permissions schema.PluginManifestPermissions) (*cachingRuntime, error) { - // Get compilation cache - compCache, err := getCompilationCache() - if err != nil { - return nil, fmt.Errorf("failed to get compilation cache: %w", err) - } - - // Create the runtime - runtimeConfig := wazero.NewRuntimeConfig().WithCompilationCache(compCache) - r := wazero.NewRuntimeWithConfig(ctx, runtimeConfig) - if _, err := wasi_snapshot_preview1.Instantiate(ctx, r); err != nil { - return nil, err - } - - // Setup host services - if err := m.setupHostServices(ctx, r, pluginID, permissions); err != nil { - _ = r.Close(ctx) - return nil, err - } - - return newCachingRuntime(r, pluginID), nil -} - -// setupHostServices configures all the permitted host services for a plugin -func (m *managerImpl) setupHostServices(ctx context.Context, r wazero.Runtime, pluginID string, permissions schema.PluginManifestPermissions) error { - // Define all available host services - type hostService struct { - name string - isPermitted bool - loadFunc func() (map[string]wazeroapi.FunctionDefinition, error) - } - - // List of all available host services with their permissions and loading functions - availableServices := []hostService{ - {"config", permissions.Config != nil, func() (map[string]wazeroapi.FunctionDefinition, error) { - return loadHostLibrary[config.ConfigService](ctx, config.Instantiate, &configServiceImpl{pluginID: pluginID}) - }}, - {"scheduler", permissions.Scheduler != nil, func() (map[string]wazeroapi.FunctionDefinition, error) { - return loadHostLibrary[scheduler.SchedulerService](ctx, scheduler.Instantiate, m.schedulerService.HostFunctions(pluginID)) - }}, - {"cache", permissions.Cache != nil, func() (map[string]wazeroapi.FunctionDefinition, error) { - return loadHostLibrary[cache.CacheService](ctx, cache.Instantiate, newCacheService(pluginID)) - }}, - {"artwork", permissions.Artwork != nil, func() (map[string]wazeroapi.FunctionDefinition, error) { - return loadHostLibrary[artwork.ArtworkService](ctx, artwork.Instantiate, &artworkServiceImpl{}) - }}, - {"http", permissions.Http != nil, func() (map[string]wazeroapi.FunctionDefinition, error) { - httpPerms, err := parseHTTPPermissions(permissions.Http) - if err != nil { - return nil, fmt.Errorf("invalid http permissions for plugin %s: %w", pluginID, err) - } - return loadHostLibrary[http.HttpService](ctx, http.Instantiate, &httpServiceImpl{ - pluginID: pluginID, - permissions: httpPerms, - }) - }}, - {"websocket", permissions.Websocket != nil, func() (map[string]wazeroapi.FunctionDefinition, error) { - wsPerms, err := parseWebSocketPermissions(permissions.Websocket) - if err != nil { - return nil, fmt.Errorf("invalid websocket permissions for plugin %s: %w", pluginID, err) - } - return loadHostLibrary[websocket.WebSocketService](ctx, websocket.Instantiate, m.websocketService.HostFunctions(pluginID, wsPerms)) - }}, - {"subsonicapi", permissions.Subsonicapi != nil, func() (map[string]wazeroapi.FunctionDefinition, error) { - if router := m.subsonicRouter.Load(); router != nil { - service := newSubsonicAPIService(pluginID, m.subsonicRouter.Load(), m.ds, permissions.Subsonicapi) - return loadHostLibrary[subsonicapi.SubsonicAPIService](ctx, subsonicapi.Instantiate, service) - } - log.Error(ctx, "SubsonicAPI service requested but router not available", "plugin", pluginID) - return nil, fmt.Errorf("SubsonicAPI router not available for plugin %s", pluginID) - }}, - } - - // Load only permitted services - var grantedPermissions []string - var libraries []map[string]wazeroapi.FunctionDefinition - for _, service := range availableServices { - if service.isPermitted { - lib, err := service.loadFunc() - if err != nil { - return fmt.Errorf("error loading %s lib: %w", service.name, err) - } - libraries = append(libraries, lib) - grantedPermissions = append(grantedPermissions, service.name) - } - } - log.Trace(ctx, "Granting permissions for plugin", "plugin", pluginID, "permissions", grantedPermissions) - - // Combine the permitted libraries - return combineLibraries(ctx, r, libraries...) -} - -// purgeCacheBySize removes the oldest files in dir until its total size is -// lower than or equal to maxSize. maxSize should be a human-readable string -// like "10MB" or "200K". If parsing fails or maxSize is "0", the function is -// a no-op. -func purgeCacheBySize(dir, maxSize string) { - sizeLimit, err := humanize.ParseBytes(maxSize) - if err != nil || sizeLimit == 0 { - return - } - - type fileInfo struct { - path string - size uint64 - mod int64 - } - - var files []fileInfo - var total uint64 - - walk := func(path string, d fs.DirEntry, err error) error { - if err != nil { - log.Trace("Failed to access plugin cache entry", "path", path, err) - return nil //nolint:nilerr - } - if d.IsDir() { - return nil - } - info, err := d.Info() - if err != nil { - log.Trace("Failed to get file info for plugin cache entry", "path", path, err) - return nil //nolint:nilerr - } - files = append(files, fileInfo{ - path: path, - size: uint64(info.Size()), - mod: info.ModTime().UnixMilli(), - }) - total += uint64(info.Size()) - return nil - } - - if err := filepath.WalkDir(dir, walk); err != nil { - if !os.IsNotExist(err) { - log.Warn("Failed to traverse plugin cache directory", "path", dir, err) - } - return - } - - log.Trace("Current plugin cache size", "path", dir, "size", humanize.Bytes(total), "sizeLimit", humanize.Bytes(sizeLimit)) - if total <= sizeLimit { - return - } - - log.Debug("Purging plugin cache", "path", dir, "sizeLimit", humanize.Bytes(sizeLimit), "currentSize", humanize.Bytes(total)) - sort.Slice(files, func(i, j int) bool { return files[i].mod < files[j].mod }) - for _, f := range files { - if total <= sizeLimit { - break - } - if err := os.Remove(f.path); err != nil { - log.Warn("Failed to remove plugin cache entry", "path", f.path, "size", humanize.Bytes(f.size), err) - continue - } - total -= f.size - log.Debug("Removed plugin cache entry", "path", f.path, "size", humanize.Bytes(f.size), "time", time.UnixMilli(f.mod), "remainingSize", humanize.Bytes(total)) - - // Remove empty parent directories - dirPath := filepath.Dir(f.path) - for dirPath != dir { - if err := os.Remove(dirPath); err != nil { - break - } - dirPath = filepath.Dir(dirPath) - } - } -} - -// getCompilationCache returns the global compilation cache, creating it if necessary -func getCompilationCache() (wazero.CompilationCache, error) { - var err error - cacheOnce.Do(func() { - cacheDir := filepath.Join(conf.Server.CacheFolder, "plugins") - purgeCacheBySize(cacheDir, conf.Server.Plugins.CacheSize) - compilationCache, err = wazero.NewCompilationCacheWithDir(cacheDir) - }) - return compilationCache, err -} - -// newWazeroModuleConfig creates the correct ModuleConfig for plugins -func newWazeroModuleConfig() wazero.ModuleConfig { - return wazero.NewModuleConfig().WithStartFunctions("_initialize").WithStderr(log.Writer()) -} - -// pluginCompilationTimeout returns the timeout for plugin compilation -func pluginCompilationTimeout() time.Duration { - if conf.Server.DevPluginCompilationTimeout > 0 { - return conf.Server.DevPluginCompilationTimeout - } - return time.Minute -} - -// precompilePlugin compiles the WASM module in the background and updates the pluginState. -func precompilePlugin(p *plugin) { - compileSemaphore <- struct{}{} - defer func() { <-compileSemaphore }() - ctx := context.Background() - r, err := p.Runtime(ctx) - if err != nil { - p.compilationErr = fmt.Errorf("failed to create runtime for plugin %s: %w", p.ID, err) - close(p.compilationReady) - return - } - - b, err := os.ReadFile(p.WasmPath) - if err != nil { - p.compilationErr = fmt.Errorf("failed to read wasm file: %w", err) - close(p.compilationReady) - return - } - - // We know r is always a *scopedRuntime from createRuntime - scopedRT := r.(*scopedRuntime) - cachingRT := scopedRT.GetCachingRuntime() - if cachingRT == nil { - p.compilationErr = fmt.Errorf("failed to get cachingRuntime for plugin %s", p.ID) - close(p.compilationReady) - return - } - - _, err = cachingRT.CompileModule(ctx, b) - if err != nil { - p.compilationErr = fmt.Errorf("failed to compile WASM for plugin %s: %w", p.ID, err) - log.Warn("Plugin compilation failed", "name", p.ID, "path", p.WasmPath, "err", err) - } else { - p.compilationErr = nil - log.Debug("Plugin compilation completed", "name", p.ID, "path", p.WasmPath) - } - close(p.compilationReady) -} - -// loadHostLibrary loads the given host library and returns its exported functions -func loadHostLibrary[S any]( - ctx context.Context, - instantiateFn func(context.Context, wazero.Runtime, S) error, - service S, -) (map[string]wazeroapi.FunctionDefinition, error) { - r := wazero.NewRuntime(ctx) - if err := instantiateFn(ctx, r, service); err != nil { - return nil, err - } - m := r.Module("env") - return m.ExportedFunctionDefinitions(), nil -} - -// combineLibraries combines the given host libraries into a single "env" module -func combineLibraries(ctx context.Context, r wazero.Runtime, libs ...map[string]wazeroapi.FunctionDefinition) error { - // Merge the libraries - hostLib := map[string]wazeroapi.FunctionDefinition{} - for _, lib := range libs { - maps.Copy(hostLib, lib) - } - - // Create the combined host module - envBuilder := r.NewHostModuleBuilder("env") - for name, fd := range hostLib { - fn, ok := fd.GoFunction().(wazeroapi.GoModuleFunction) - if !ok { - return fmt.Errorf("invalid function definition: %s", fd.DebugName()) - } - envBuilder.NewFunctionBuilder(). - WithGoModuleFunction(fn, fd.ParamTypes(), fd.ResultTypes()). - WithParameterNames(fd.ParamNames()...).Export(name) - } - - // Instantiate the combined host module - if _, err := envBuilder.Instantiate(ctx); err != nil { - return err - } - return nil -} - -const ( - // WASM Instance pool configuration - // defaultPoolSize is the maximum number of instances per plugin that are kept in the pool for reuse - defaultPoolSize = 8 - // defaultInstanceTTL is the time after which an instance is considered stale and can be evicted - defaultInstanceTTL = time.Minute - // defaultMaxConcurrentInstances is the hard limit on total instances that can exist simultaneously - defaultMaxConcurrentInstances = 10 - // defaultGetTimeout is the maximum time to wait when getting an instance if at the concurrent limit - defaultGetTimeout = 5 * time.Second - - // Compiled module cache configuration - // defaultCompiledModuleTTL is the time after which a compiled module is evicted from the cache - defaultCompiledModuleTTL = 5 * time.Minute -) - -// cachedCompiledModule encapsulates a compiled WebAssembly module with TTL management -type cachedCompiledModule struct { - module wazero.CompiledModule - hash [16]byte - lastAccess time.Time - timer *time.Timer - mu sync.Mutex - pluginID string // for logging purposes -} - -// newCachedCompiledModule creates a new cached compiled module with TTL management -func newCachedCompiledModule(module wazero.CompiledModule, wasmBytes []byte, pluginID string) *cachedCompiledModule { - c := &cachedCompiledModule{ - module: module, - hash: md5.Sum(wasmBytes), - lastAccess: time.Now(), - pluginID: pluginID, - } - - // Set up the TTL timer - c.timer = time.AfterFunc(defaultCompiledModuleTTL, c.evict) - - return c -} - -// get returns the cached module if the hash matches, nil otherwise -// Also resets the TTL timer on successful access -func (c *cachedCompiledModule) get(wasmHash [16]byte) wazero.CompiledModule { - c.mu.Lock() // Use write lock because we modify state in resetTimer - defer c.mu.Unlock() - - if c.module != nil && c.hash == wasmHash { - // Reset TTL timer on access - c.resetTimer() - return c.module - } - - return nil -} - -// resetTimer resets the TTL timer (must be called with lock held) -func (c *cachedCompiledModule) resetTimer() { - c.lastAccess = time.Now() - - if c.timer != nil { - c.timer.Stop() - c.timer = time.AfterFunc(defaultCompiledModuleTTL, c.evict) - } -} - -// evict removes the cached module and cleans up resources -func (c *cachedCompiledModule) evict() { - c.mu.Lock() - defer c.mu.Unlock() - - if c.module != nil { - log.Trace("cachedCompiledModule: evicting due to TTL expiry", "plugin", c.pluginID, "ttl", defaultCompiledModuleTTL) - c.module.Close(context.Background()) - c.module = nil - c.hash = [16]byte{} - c.lastAccess = time.Time{} - } - - if c.timer != nil { - c.timer.Stop() - c.timer = nil - } -} - -// close cleans up the cached module and stops the timer -func (c *cachedCompiledModule) close(ctx context.Context) { - c.mu.Lock() - defer c.mu.Unlock() - - if c.timer != nil { - c.timer.Stop() - c.timer = nil - } - - if c.module != nil { - c.module.Close(ctx) - c.module = nil - } -} - -// pooledModule wraps a wazero Module and returns it to the pool when closed. -type pooledModule struct { - wazeroapi.Module - pool *wasmInstancePool[wazeroapi.Module] - closed bool -} - -func (m *pooledModule) Close(ctx context.Context) error { - if !m.closed { - m.closed = true - m.pool.Put(ctx, m.Module) - } - return nil -} - -func (m *pooledModule) CloseWithExitCode(ctx context.Context, exitCode uint32) error { - return m.Close(ctx) -} - -func (m *pooledModule) IsClosed() bool { - return m.closed -} - -// newScopedRuntime creates a new scopedRuntime that wraps the given runtime -func newScopedRuntime(runtime wazero.Runtime) *scopedRuntime { - return &scopedRuntime{Runtime: runtime} -} - -// scopedRuntime wraps a cachingRuntime and captures a specific module -// so that Close() only affects that module, not the entire shared runtime -type scopedRuntime struct { - wazero.Runtime - capturedModule wazeroapi.Module -} - -func (w *scopedRuntime) InstantiateModule(ctx context.Context, code wazero.CompiledModule, config wazero.ModuleConfig) (wazeroapi.Module, error) { - module, err := w.Runtime.InstantiateModule(ctx, code, config) - if err != nil { - return nil, err - } - // Capture the module for later cleanup - w.capturedModule = module - log.Trace(ctx, "scopedRuntime: captured module", "moduleID", getInstanceID(module)) - return module, nil -} - -func (w *scopedRuntime) Close(ctx context.Context) error { - // Close only the captured module, not the entire runtime - if w.capturedModule != nil { - log.Trace(ctx, "scopedRuntime: closing captured module", "moduleID", getInstanceID(w.capturedModule)) - return w.capturedModule.Close(ctx) - } - log.Trace(ctx, "scopedRuntime: no captured module to close") - return nil -} - -func (w *scopedRuntime) CloseWithExitCode(ctx context.Context, exitCode uint32) error { - return w.Close(ctx) -} - -// GetCachingRuntime returns the underlying cachingRuntime for internal use -func (w *scopedRuntime) GetCachingRuntime() *cachingRuntime { - if cr, ok := w.Runtime.(*cachingRuntime); ok { - return cr - } - return nil -} - -// cachingRuntime wraps wazero.Runtime and pools module instances per plugin, -// while also caching the compiled module in memory. -type cachingRuntime struct { - wazero.Runtime - - // pluginID is required to differentiate between different plugins that use the same file to initialize their - // runtime. The runtime will serve as a singleton for all instances of a given plugin. - pluginID string - - // cachedModule manages the compiled module cache with TTL - cachedModule atomic.Pointer[cachedCompiledModule] - - // pool manages reusable module instances - pool *wasmInstancePool[wazeroapi.Module] - - // poolInitOnce ensures the pool is initialized only once - poolInitOnce sync.Once - - // compilationMu ensures only one compilation happens at a time per runtime - compilationMu sync.Mutex -} - -func newCachingRuntime(runtime wazero.Runtime, pluginID string) *cachingRuntime { - return &cachingRuntime{ - Runtime: runtime, - pluginID: pluginID, - } -} - -func (r *cachingRuntime) initPool(code wazero.CompiledModule, config wazero.ModuleConfig) { - r.poolInitOnce.Do(func() { - r.pool = newWasmInstancePool[wazeroapi.Module](r.pluginID, defaultPoolSize, defaultMaxConcurrentInstances, defaultGetTimeout, defaultInstanceTTL, func(ctx context.Context) (wazeroapi.Module, error) { - log.Trace(ctx, "cachingRuntime: creating new module instance", "plugin", r.pluginID) - return r.Runtime.InstantiateModule(ctx, code, config) - }) - }) -} - -func (r *cachingRuntime) InstantiateModule(ctx context.Context, code wazero.CompiledModule, config wazero.ModuleConfig) (wazeroapi.Module, error) { - r.initPool(code, config) - mod, err := r.pool.Get(ctx) - if err != nil { - return nil, err - } - wrapped := &pooledModule{Module: mod, pool: r.pool} - log.Trace(ctx, "cachingRuntime: created wrapper for module", "plugin", r.pluginID, "underlyingModuleID", fmt.Sprintf("%p", mod), "wrapperID", fmt.Sprintf("%p", wrapped)) - return wrapped, nil -} - -func (r *cachingRuntime) Close(ctx context.Context) error { - log.Trace(ctx, "cachingRuntime: closing runtime", "plugin", r.pluginID) - - // Clean up compiled module cache - if cached := r.cachedModule.Swap(nil); cached != nil { - cached.close(ctx) - } - - // Close the instance pool - if r.pool != nil { - r.pool.Close(ctx) - } - // Close the underlying runtime - return r.Runtime.Close(ctx) -} - -// setCachedModule stores a newly compiled module in the cache with TTL management -func (r *cachingRuntime) setCachedModule(module wazero.CompiledModule, wasmBytes []byte) { - newCached := newCachedCompiledModule(module, wasmBytes, r.pluginID) - - // Replace old cached module and clean it up - if old := r.cachedModule.Swap(newCached); old != nil { - old.close(context.Background()) - } -} - -// CompileModule checks if the provided bytes match our cached hash and returns -// the cached compiled module if so, avoiding both file read and compilation. -func (r *cachingRuntime) CompileModule(ctx context.Context, wasmBytes []byte) (wazero.CompiledModule, error) { - incomingHash := md5.Sum(wasmBytes) - - // Try to get from cache first (without lock for performance) - if cached := r.cachedModule.Load(); cached != nil { - if module := cached.get(incomingHash); module != nil { - log.Trace(ctx, "cachingRuntime: using cached compiled module", "plugin", r.pluginID) - return module, nil - } - } - - // Synchronize compilation to prevent concurrent compilation issues - r.compilationMu.Lock() - defer r.compilationMu.Unlock() - - // Double-check cache after acquiring lock (another goroutine might have compiled it) - if cached := r.cachedModule.Load(); cached != nil { - if module := cached.get(incomingHash); module != nil { - log.Trace(ctx, "cachingRuntime: using cached compiled module (after lock)", "plugin", r.pluginID) - return module, nil - } - } - - // Fall back to normal compilation for different bytes - log.Trace(ctx, "cachingRuntime: hash doesn't match cache, compiling normally", "plugin", r.pluginID) - module, err := r.Runtime.CompileModule(ctx, wasmBytes) - if err != nil { - return nil, err - } - - // Cache the newly compiled module - r.setCachedModule(module, wasmBytes) - - return module, nil -} diff --git a/plugins/runtime_test.go b/plugins/runtime_test.go deleted file mode 100644 index 05efe1d1d..000000000 --- a/plugins/runtime_test.go +++ /dev/null @@ -1,173 +0,0 @@ -package plugins - -import ( - "context" - "fmt" - "os" - "path/filepath" - "time" - - "github.com/navidrome/navidrome/conf" - "github.com/navidrome/navidrome/core/metrics" - "github.com/navidrome/navidrome/plugins/schema" - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" - "github.com/tetratelabs/wazero" -) - -var _ = Describe("Runtime", func() { - Describe("pluginCompilationTimeout", func() { - It("should use DevPluginCompilationTimeout config for plugin compilation timeout", func() { - originalTimeout := conf.Server.DevPluginCompilationTimeout - DeferCleanup(func() { - conf.Server.DevPluginCompilationTimeout = originalTimeout - }) - - conf.Server.DevPluginCompilationTimeout = 123 * time.Second - Expect(pluginCompilationTimeout()).To(Equal(123 * time.Second)) - - conf.Server.DevPluginCompilationTimeout = 0 - Expect(pluginCompilationTimeout()).To(Equal(time.Minute)) - }) - }) -}) - -var _ = Describe("CachingRuntime", func() { - var ( - ctx context.Context - mgr *managerImpl - plugin *wasmScrobblerPlugin - ) - - BeforeEach(func() { - ctx = GinkgoT().Context() - mgr = createManager(nil, metrics.NewNoopInstance()) - // Add permissions for the test plugin using typed struct - permissions := schema.PluginManifestPermissions{ - Http: &schema.PluginManifestPermissionsHttp{ - Reason: "For testing HTTP functionality", - AllowedUrls: map[string][]schema.PluginManifestPermissionsHttpAllowedUrlsValueElem{ - "*": {schema.PluginManifestPermissionsHttpAllowedUrlsValueElemWildcard}, - }, - AllowLocalNetwork: false, - }, - Config: &schema.PluginManifestPermissionsConfig{ - Reason: "For testing config functionality", - }, - } - rtFunc := mgr.createRuntime("fake_scrobbler", permissions) - plugin = newWasmScrobblerPlugin( - filepath.Join(testDataDir, "fake_scrobbler", "plugin.wasm"), - "fake_scrobbler", - mgr, - rtFunc, - wazero.NewModuleConfig().WithStartFunctions("_initialize"), - ).(*wasmScrobblerPlugin) - // runtime will be created on first plugin load - }) - - It("reuses module instances across calls", func() { - // First call to create the runtime and pool - _, done, err := plugin.getInstance(ctx, "first") - Expect(err).ToNot(HaveOccurred()) - done() - - val, ok := runtimePool.Load("fake_scrobbler") - Expect(ok).To(BeTrue()) - cachingRT := val.(*cachingRuntime) - - // Verify the pool exists and is initialized - Expect(cachingRT.pool).ToNot(BeNil()) - - // Test that multiple calls work without error (indicating pool reuse) - for i := 0; i < 5; i++ { - inst, done, err := plugin.getInstance(ctx, fmt.Sprintf("call_%d", i)) - Expect(err).ToNot(HaveOccurred()) - Expect(inst).ToNot(BeNil()) - done() - } - - // Test concurrent access to verify pool handles concurrency - const numGoroutines = 3 - errChan := make(chan error, numGoroutines) - - for i := 0; i < numGoroutines; i++ { - go func(id int) { - inst, done, err := plugin.getInstance(ctx, fmt.Sprintf("concurrent_%d", id)) - if err != nil { - errChan <- err - return - } - defer done() - - // Verify we got a valid instance - if inst == nil { - errChan <- fmt.Errorf("got nil instance") - return - } - errChan <- nil - }(i) - } - - // Check all goroutines succeeded - for i := 0; i < numGoroutines; i++ { - err := <-errChan - Expect(err).To(BeNil()) - } - }) -}) - -var _ = Describe("purgeCacheBySize", func() { - var tmpDir string - - BeforeEach(func() { - var err error - tmpDir, err = os.MkdirTemp("", "cache_test") - Expect(err).ToNot(HaveOccurred()) - DeferCleanup(os.RemoveAll, tmpDir) - }) - - It("removes oldest entries when above the size limit", func() { - oldDir := filepath.Join(tmpDir, "d1") - newDir := filepath.Join(tmpDir, "d2") - Expect(os.Mkdir(oldDir, 0700)).To(Succeed()) - Expect(os.Mkdir(newDir, 0700)).To(Succeed()) - - oldFile := filepath.Join(oldDir, "old") - newFile := filepath.Join(newDir, "new") - Expect(os.WriteFile(oldFile, []byte("xx"), 0600)).To(Succeed()) - Expect(os.WriteFile(newFile, []byte("xx"), 0600)).To(Succeed()) - - oldTime := time.Now().Add(-2 * time.Hour) - Expect(os.Chtimes(oldFile, oldTime, oldTime)).To(Succeed()) - - purgeCacheBySize(tmpDir, "3") - - _, err := os.Stat(oldFile) - Expect(os.IsNotExist(err)).To(BeTrue()) - _, err = os.Stat(oldDir) - Expect(os.IsNotExist(err)).To(BeTrue()) - - _, err = os.Stat(newFile) - Expect(err).ToNot(HaveOccurred()) - }) - - It("does nothing when below the size limit", func() { - dir1 := filepath.Join(tmpDir, "a") - dir2 := filepath.Join(tmpDir, "b") - Expect(os.Mkdir(dir1, 0700)).To(Succeed()) - Expect(os.Mkdir(dir2, 0700)).To(Succeed()) - - file1 := filepath.Join(dir1, "f1") - file2 := filepath.Join(dir2, "f2") - Expect(os.WriteFile(file1, []byte("x"), 0600)).To(Succeed()) - Expect(os.WriteFile(file2, []byte("x"), 0600)).To(Succeed()) - - purgeCacheBySize(tmpDir, "10MB") - - _, err := os.Stat(file1) - Expect(err).ToNot(HaveOccurred()) - _, err = os.Stat(file2) - Expect(err).ToNot(HaveOccurred()) - }) -}) diff --git a/plugins/schema/manifest.schema.json b/plugins/schema/manifest.schema.json deleted file mode 100644 index 0c323126b..000000000 --- a/plugins/schema/manifest.schema.json +++ /dev/null @@ -1,199 +0,0 @@ -{ - "$id": "navidrome://plugins/manifest", - "$schema": "http://json-schema.org/draft-07/schema#", - "title": "Navidrome Plugin Manifest", - "description": "Schema for Navidrome Plugin manifest.json files", - "type": "object", - "required": [ - "name", - "author", - "version", - "description", - "website", - "capabilities", - "permissions" - ], - "properties": { - "name": { - "type": "string", - "description": "Name of the plugin" - }, - "author": { - "type": "string", - "description": "Author or organization that created the plugin" - }, - "version": { - "type": "string", - "description": "Plugin version using semantic versioning format" - }, - "description": { - "type": "string", - "description": "A brief description of the plugin's functionality" - }, - "website": { - "type": "string", - "format": "uri", - "description": "Website URL for the plugin or its documentation" - }, - "capabilities": { - "type": "array", - "description": "List of capabilities implemented by this plugin", - "minItems": 1, - "items": { - "type": "string", - "enum": [ - "MetadataAgent", - "Scrobbler", - "SchedulerCallback", - "LifecycleManagement", - "WebSocketCallback" - ] - } - }, - "permissions": { - "type": "object", - "description": "Host services the plugin is allowed to access", - "additionalProperties": true, - "properties": { - "http": { - "allOf": [ - { "$ref": "#/$defs/basePermission" }, - { - "type": "object", - "description": "HTTP service permissions", - "required": ["allowedUrls"], - "properties": { - "allowedUrls": { - "type": "object", - "description": "Map of URL patterns (e.g., 'https://api.example.com/*') to allowed HTTP methods. Redirect destinations must also be included.", - "additionalProperties": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE", - "PATCH", - "HEAD", - "OPTIONS", - "*" - ] - }, - "minItems": 1, - "uniqueItems": true - }, - "minProperties": 1 - }, - "allowLocalNetwork": { - "type": "boolean", - "description": "Whether to allow requests to local/private network addresses", - "default": false - } - } - } - ] - }, - "config": { - "allOf": [ - { "$ref": "#/$defs/basePermission" }, - { - "type": "object", - "description": "Configuration service permissions" - } - ] - }, - "scheduler": { - "allOf": [ - { "$ref": "#/$defs/basePermission" }, - { - "type": "object", - "description": "Scheduler service permissions" - } - ] - }, - "websocket": { - "allOf": [ - { "$ref": "#/$defs/basePermission" }, - { - "type": "object", - "description": "WebSocket service permissions", - "required": ["allowedUrls"], - "properties": { - "allowedUrls": { - "type": "array", - "description": "List of WebSocket URL patterns that the plugin is allowed to connect to", - "items": { - "type": "string", - "pattern": "^wss?://.*$" - }, - "minItems": 1, - "uniqueItems": true - }, - "allowLocalNetwork": { - "type": "boolean", - "description": "Whether to allow connections to local/private network addresses", - "default": false - } - } - } - ] - }, - "cache": { - "allOf": [ - { "$ref": "#/$defs/basePermission" }, - { - "type": "object", - "description": "Cache service permissions" - } - ] - }, - "artwork": { - "allOf": [ - { "$ref": "#/$defs/basePermission" }, - { - "type": "object", - "description": "Artwork service permissions" - } - ] - }, - "subsonicapi": { - "allOf": [ - { "$ref": "#/$defs/basePermission" }, - { - "type": "object", - "description": "SubsonicAPI service permissions", - "properties": { - "allowedUsernames": { - "type": "array", - "description": "List of usernames the plugin can pass as u. Any user if empty", - "items": { "type": "string" } - }, - "allowAdmins": { - "type": "boolean", - "description": "If false, reject calls where the u is an admin", - "default": false - } - } - } - ] - } - } - } - }, - "$defs": { - "basePermission": { - "type": "object", - "required": ["reason"], - "properties": { - "reason": { - "type": "string", - "minLength": 1, - "description": "Explanation of why this permission is needed" - } - }, - "additionalProperties": false - } - } -} diff --git a/plugins/schema/manifest_gen.go b/plugins/schema/manifest_gen.go deleted file mode 100644 index 97e07a077..000000000 --- a/plugins/schema/manifest_gen.go +++ /dev/null @@ -1,426 +0,0 @@ -// Code generated by github.com/atombender/go-jsonschema, DO NOT EDIT. - -package schema - -import "encoding/json" -import "fmt" -import "reflect" - -type BasePermission struct { - // Explanation of why this permission is needed - Reason string `json:"reason" yaml:"reason" mapstructure:"reason"` -} - -// UnmarshalJSON implements json.Unmarshaler. -func (j *BasePermission) UnmarshalJSON(value []byte) error { - var raw map[string]interface{} - if err := json.Unmarshal(value, &raw); err != nil { - return err - } - if _, ok := raw["reason"]; raw != nil && !ok { - return fmt.Errorf("field reason in BasePermission: required") - } - type Plain BasePermission - var plain Plain - if err := json.Unmarshal(value, &plain); err != nil { - return err - } - if len(plain.Reason) < 1 { - return fmt.Errorf("field %s length: must be >= %d", "reason", 1) - } - *j = BasePermission(plain) - return nil -} - -// Schema for Navidrome Plugin manifest.json files -type PluginManifest struct { - // Author or organization that created the plugin - Author string `json:"author" yaml:"author" mapstructure:"author"` - - // List of capabilities implemented by this plugin - Capabilities []PluginManifestCapabilitiesElem `json:"capabilities" yaml:"capabilities" mapstructure:"capabilities"` - - // A brief description of the plugin's functionality - Description string `json:"description" yaml:"description" mapstructure:"description"` - - // Name of the plugin - Name string `json:"name" yaml:"name" mapstructure:"name"` - - // Host services the plugin is allowed to access - Permissions PluginManifestPermissions `json:"permissions" yaml:"permissions" mapstructure:"permissions"` - - // Plugin version using semantic versioning format - Version string `json:"version" yaml:"version" mapstructure:"version"` - - // Website URL for the plugin or its documentation - Website string `json:"website" yaml:"website" mapstructure:"website"` -} - -type PluginManifestCapabilitiesElem string - -const PluginManifestCapabilitiesElemLifecycleManagement PluginManifestCapabilitiesElem = "LifecycleManagement" -const PluginManifestCapabilitiesElemMetadataAgent PluginManifestCapabilitiesElem = "MetadataAgent" -const PluginManifestCapabilitiesElemSchedulerCallback PluginManifestCapabilitiesElem = "SchedulerCallback" -const PluginManifestCapabilitiesElemScrobbler PluginManifestCapabilitiesElem = "Scrobbler" -const PluginManifestCapabilitiesElemWebSocketCallback PluginManifestCapabilitiesElem = "WebSocketCallback" - -var enumValues_PluginManifestCapabilitiesElem = []interface{}{ - "MetadataAgent", - "Scrobbler", - "SchedulerCallback", - "LifecycleManagement", - "WebSocketCallback", -} - -// UnmarshalJSON implements json.Unmarshaler. -func (j *PluginManifestCapabilitiesElem) UnmarshalJSON(value []byte) error { - var v string - if err := json.Unmarshal(value, &v); err != nil { - return err - } - var ok bool - for _, expected := range enumValues_PluginManifestCapabilitiesElem { - if reflect.DeepEqual(v, expected) { - ok = true - break - } - } - if !ok { - return fmt.Errorf("invalid value (expected one of %#v): %#v", enumValues_PluginManifestCapabilitiesElem, v) - } - *j = PluginManifestCapabilitiesElem(v) - return nil -} - -// Host services the plugin is allowed to access -type PluginManifestPermissions struct { - // Artwork corresponds to the JSON schema field "artwork". - Artwork *PluginManifestPermissionsArtwork `json:"artwork,omitempty" yaml:"artwork,omitempty" mapstructure:"artwork,omitempty"` - - // Cache corresponds to the JSON schema field "cache". - Cache *PluginManifestPermissionsCache `json:"cache,omitempty" yaml:"cache,omitempty" mapstructure:"cache,omitempty"` - - // Config corresponds to the JSON schema field "config". - Config *PluginManifestPermissionsConfig `json:"config,omitempty" yaml:"config,omitempty" mapstructure:"config,omitempty"` - - // Http corresponds to the JSON schema field "http". - Http *PluginManifestPermissionsHttp `json:"http,omitempty" yaml:"http,omitempty" mapstructure:"http,omitempty"` - - // Scheduler corresponds to the JSON schema field "scheduler". - Scheduler *PluginManifestPermissionsScheduler `json:"scheduler,omitempty" yaml:"scheduler,omitempty" mapstructure:"scheduler,omitempty"` - - // Subsonicapi corresponds to the JSON schema field "subsonicapi". - Subsonicapi *PluginManifestPermissionsSubsonicapi `json:"subsonicapi,omitempty" yaml:"subsonicapi,omitempty" mapstructure:"subsonicapi,omitempty"` - - // Websocket corresponds to the JSON schema field "websocket". - Websocket *PluginManifestPermissionsWebsocket `json:"websocket,omitempty" yaml:"websocket,omitempty" mapstructure:"websocket,omitempty"` - - AdditionalProperties interface{} `mapstructure:",remain"` -} - -// Artwork service permissions -type PluginManifestPermissionsArtwork struct { - // Explanation of why this permission is needed - Reason string `json:"reason" yaml:"reason" mapstructure:"reason"` -} - -// UnmarshalJSON implements json.Unmarshaler. -func (j *PluginManifestPermissionsArtwork) UnmarshalJSON(value []byte) error { - var raw map[string]interface{} - if err := json.Unmarshal(value, &raw); err != nil { - return err - } - if _, ok := raw["reason"]; raw != nil && !ok { - return fmt.Errorf("field reason in PluginManifestPermissionsArtwork: required") - } - type Plain PluginManifestPermissionsArtwork - var plain Plain - if err := json.Unmarshal(value, &plain); err != nil { - return err - } - if len(plain.Reason) < 1 { - return fmt.Errorf("field %s length: must be >= %d", "reason", 1) - } - *j = PluginManifestPermissionsArtwork(plain) - return nil -} - -// Cache service permissions -type PluginManifestPermissionsCache struct { - // Explanation of why this permission is needed - Reason string `json:"reason" yaml:"reason" mapstructure:"reason"` -} - -// UnmarshalJSON implements json.Unmarshaler. -func (j *PluginManifestPermissionsCache) UnmarshalJSON(value []byte) error { - var raw map[string]interface{} - if err := json.Unmarshal(value, &raw); err != nil { - return err - } - if _, ok := raw["reason"]; raw != nil && !ok { - return fmt.Errorf("field reason in PluginManifestPermissionsCache: required") - } - type Plain PluginManifestPermissionsCache - var plain Plain - if err := json.Unmarshal(value, &plain); err != nil { - return err - } - if len(plain.Reason) < 1 { - return fmt.Errorf("field %s length: must be >= %d", "reason", 1) - } - *j = PluginManifestPermissionsCache(plain) - return nil -} - -// Configuration service permissions -type PluginManifestPermissionsConfig struct { - // Explanation of why this permission is needed - Reason string `json:"reason" yaml:"reason" mapstructure:"reason"` -} - -// UnmarshalJSON implements json.Unmarshaler. -func (j *PluginManifestPermissionsConfig) UnmarshalJSON(value []byte) error { - var raw map[string]interface{} - if err := json.Unmarshal(value, &raw); err != nil { - return err - } - if _, ok := raw["reason"]; raw != nil && !ok { - return fmt.Errorf("field reason in PluginManifestPermissionsConfig: required") - } - type Plain PluginManifestPermissionsConfig - var plain Plain - if err := json.Unmarshal(value, &plain); err != nil { - return err - } - if len(plain.Reason) < 1 { - return fmt.Errorf("field %s length: must be >= %d", "reason", 1) - } - *j = PluginManifestPermissionsConfig(plain) - return nil -} - -// HTTP service permissions -type PluginManifestPermissionsHttp struct { - // Whether to allow requests to local/private network addresses - AllowLocalNetwork bool `json:"allowLocalNetwork,omitempty" yaml:"allowLocalNetwork,omitempty" mapstructure:"allowLocalNetwork,omitempty"` - - // Map of URL patterns (e.g., 'https://api.example.com/*') to allowed HTTP - // methods. Redirect destinations must also be included. - AllowedUrls map[string][]PluginManifestPermissionsHttpAllowedUrlsValueElem `json:"allowedUrls" yaml:"allowedUrls" mapstructure:"allowedUrls"` - - // Explanation of why this permission is needed - Reason string `json:"reason" yaml:"reason" mapstructure:"reason"` -} - -type PluginManifestPermissionsHttpAllowedUrlsValueElem string - -const PluginManifestPermissionsHttpAllowedUrlsValueElemDELETE PluginManifestPermissionsHttpAllowedUrlsValueElem = "DELETE" -const PluginManifestPermissionsHttpAllowedUrlsValueElemGET PluginManifestPermissionsHttpAllowedUrlsValueElem = "GET" -const PluginManifestPermissionsHttpAllowedUrlsValueElemHEAD PluginManifestPermissionsHttpAllowedUrlsValueElem = "HEAD" -const PluginManifestPermissionsHttpAllowedUrlsValueElemOPTIONS PluginManifestPermissionsHttpAllowedUrlsValueElem = "OPTIONS" -const PluginManifestPermissionsHttpAllowedUrlsValueElemPATCH PluginManifestPermissionsHttpAllowedUrlsValueElem = "PATCH" -const PluginManifestPermissionsHttpAllowedUrlsValueElemPOST PluginManifestPermissionsHttpAllowedUrlsValueElem = "POST" -const PluginManifestPermissionsHttpAllowedUrlsValueElemPUT PluginManifestPermissionsHttpAllowedUrlsValueElem = "PUT" -const PluginManifestPermissionsHttpAllowedUrlsValueElemWildcard PluginManifestPermissionsHttpAllowedUrlsValueElem = "*" - -var enumValues_PluginManifestPermissionsHttpAllowedUrlsValueElem = []interface{}{ - "GET", - "POST", - "PUT", - "DELETE", - "PATCH", - "HEAD", - "OPTIONS", - "*", -} - -// UnmarshalJSON implements json.Unmarshaler. -func (j *PluginManifestPermissionsHttpAllowedUrlsValueElem) UnmarshalJSON(value []byte) error { - var v string - if err := json.Unmarshal(value, &v); err != nil { - return err - } - var ok bool - for _, expected := range enumValues_PluginManifestPermissionsHttpAllowedUrlsValueElem { - if reflect.DeepEqual(v, expected) { - ok = true - break - } - } - if !ok { - return fmt.Errorf("invalid value (expected one of %#v): %#v", enumValues_PluginManifestPermissionsHttpAllowedUrlsValueElem, v) - } - *j = PluginManifestPermissionsHttpAllowedUrlsValueElem(v) - return nil -} - -// UnmarshalJSON implements json.Unmarshaler. -func (j *PluginManifestPermissionsHttp) UnmarshalJSON(value []byte) error { - var raw map[string]interface{} - if err := json.Unmarshal(value, &raw); err != nil { - return err - } - if _, ok := raw["allowedUrls"]; raw != nil && !ok { - return fmt.Errorf("field allowedUrls in PluginManifestPermissionsHttp: required") - } - if _, ok := raw["reason"]; raw != nil && !ok { - return fmt.Errorf("field reason in PluginManifestPermissionsHttp: required") - } - type Plain PluginManifestPermissionsHttp - var plain Plain - if err := json.Unmarshal(value, &plain); err != nil { - return err - } - if v, ok := raw["allowLocalNetwork"]; !ok || v == nil { - plain.AllowLocalNetwork = false - } - if len(plain.Reason) < 1 { - return fmt.Errorf("field %s length: must be >= %d", "reason", 1) - } - *j = PluginManifestPermissionsHttp(plain) - return nil -} - -// Scheduler service permissions -type PluginManifestPermissionsScheduler struct { - // Explanation of why this permission is needed - Reason string `json:"reason" yaml:"reason" mapstructure:"reason"` -} - -// UnmarshalJSON implements json.Unmarshaler. -func (j *PluginManifestPermissionsScheduler) UnmarshalJSON(value []byte) error { - var raw map[string]interface{} - if err := json.Unmarshal(value, &raw); err != nil { - return err - } - if _, ok := raw["reason"]; raw != nil && !ok { - return fmt.Errorf("field reason in PluginManifestPermissionsScheduler: required") - } - type Plain PluginManifestPermissionsScheduler - var plain Plain - if err := json.Unmarshal(value, &plain); err != nil { - return err - } - if len(plain.Reason) < 1 { - return fmt.Errorf("field %s length: must be >= %d", "reason", 1) - } - *j = PluginManifestPermissionsScheduler(plain) - return nil -} - -// SubsonicAPI service permissions -type PluginManifestPermissionsSubsonicapi struct { - // If false, reject calls where the u is an admin - AllowAdmins bool `json:"allowAdmins,omitempty" yaml:"allowAdmins,omitempty" mapstructure:"allowAdmins,omitempty"` - - // List of usernames the plugin can pass as u. Any user if empty - AllowedUsernames []string `json:"allowedUsernames,omitempty" yaml:"allowedUsernames,omitempty" mapstructure:"allowedUsernames,omitempty"` - - // Explanation of why this permission is needed - Reason string `json:"reason" yaml:"reason" mapstructure:"reason"` -} - -// UnmarshalJSON implements json.Unmarshaler. -func (j *PluginManifestPermissionsSubsonicapi) UnmarshalJSON(value []byte) error { - var raw map[string]interface{} - if err := json.Unmarshal(value, &raw); err != nil { - return err - } - if _, ok := raw["reason"]; raw != nil && !ok { - return fmt.Errorf("field reason in PluginManifestPermissionsSubsonicapi: required") - } - type Plain PluginManifestPermissionsSubsonicapi - var plain Plain - if err := json.Unmarshal(value, &plain); err != nil { - return err - } - if v, ok := raw["allowAdmins"]; !ok || v == nil { - plain.AllowAdmins = false - } - if len(plain.Reason) < 1 { - return fmt.Errorf("field %s length: must be >= %d", "reason", 1) - } - *j = PluginManifestPermissionsSubsonicapi(plain) - return nil -} - -// WebSocket service permissions -type PluginManifestPermissionsWebsocket struct { - // Whether to allow connections to local/private network addresses - AllowLocalNetwork bool `json:"allowLocalNetwork,omitempty" yaml:"allowLocalNetwork,omitempty" mapstructure:"allowLocalNetwork,omitempty"` - - // List of WebSocket URL patterns that the plugin is allowed to connect to - AllowedUrls []string `json:"allowedUrls" yaml:"allowedUrls" mapstructure:"allowedUrls"` - - // Explanation of why this permission is needed - Reason string `json:"reason" yaml:"reason" mapstructure:"reason"` -} - -// UnmarshalJSON implements json.Unmarshaler. -func (j *PluginManifestPermissionsWebsocket) UnmarshalJSON(value []byte) error { - var raw map[string]interface{} - if err := json.Unmarshal(value, &raw); err != nil { - return err - } - if _, ok := raw["allowedUrls"]; raw != nil && !ok { - return fmt.Errorf("field allowedUrls in PluginManifestPermissionsWebsocket: required") - } - if _, ok := raw["reason"]; raw != nil && !ok { - return fmt.Errorf("field reason in PluginManifestPermissionsWebsocket: required") - } - type Plain PluginManifestPermissionsWebsocket - var plain Plain - if err := json.Unmarshal(value, &plain); err != nil { - return err - } - if v, ok := raw["allowLocalNetwork"]; !ok || v == nil { - plain.AllowLocalNetwork = false - } - if plain.AllowedUrls != nil && len(plain.AllowedUrls) < 1 { - return fmt.Errorf("field %s length: must be >= %d", "allowedUrls", 1) - } - if len(plain.Reason) < 1 { - return fmt.Errorf("field %s length: must be >= %d", "reason", 1) - } - *j = PluginManifestPermissionsWebsocket(plain) - return nil -} - -// UnmarshalJSON implements json.Unmarshaler. -func (j *PluginManifest) UnmarshalJSON(value []byte) error { - var raw map[string]interface{} - if err := json.Unmarshal(value, &raw); err != nil { - return err - } - if _, ok := raw["author"]; raw != nil && !ok { - return fmt.Errorf("field author in PluginManifest: required") - } - if _, ok := raw["capabilities"]; raw != nil && !ok { - return fmt.Errorf("field capabilities in PluginManifest: required") - } - if _, ok := raw["description"]; raw != nil && !ok { - return fmt.Errorf("field description in PluginManifest: required") - } - if _, ok := raw["name"]; raw != nil && !ok { - return fmt.Errorf("field name in PluginManifest: required") - } - if _, ok := raw["permissions"]; raw != nil && !ok { - return fmt.Errorf("field permissions in PluginManifest: required") - } - if _, ok := raw["version"]; raw != nil && !ok { - return fmt.Errorf("field version in PluginManifest: required") - } - if _, ok := raw["website"]; raw != nil && !ok { - return fmt.Errorf("field website in PluginManifest: required") - } - type Plain PluginManifest - var plain Plain - if err := json.Unmarshal(value, &plain); err != nil { - return err - } - if plain.Capabilities != nil && len(plain.Capabilities) < 1 { - return fmt.Errorf("field %s length: must be >= %d", "capabilities", 1) - } - *j = PluginManifest(plain) - return nil -} diff --git a/plugins/scrobbler_adapter.go b/plugins/scrobbler_adapter.go new file mode 100644 index 000000000..874c6603a --- /dev/null +++ b/plugins/scrobbler_adapter.go @@ -0,0 +1,165 @@ +package plugins + +import ( + "context" + "strings" + + "github.com/navidrome/navidrome/core/scrobbler" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/plugins/capabilities" +) + +// CapabilityScrobbler indicates the plugin can receive scrobble events. +// Detected when the plugin exports at least one of the scrobbler functions. +const CapabilityScrobbler Capability = "Scrobbler" + +// Scrobbler function names (snake_case as per design) +const ( + FuncScrobblerIsAuthorized = "nd_scrobbler_is_authorized" + FuncScrobblerNowPlaying = "nd_scrobbler_now_playing" + FuncScrobblerScrobble = "nd_scrobbler_scrobble" +) + +func init() { + registerCapability( + CapabilityScrobbler, + FuncScrobblerIsAuthorized, + FuncScrobblerNowPlaying, + FuncScrobblerScrobble, + ) +} + +// ScrobblerPlugin is an adapter that wraps an Extism plugin and implements +// the scrobbler.Scrobbler interface for scrobbling to external services. +type ScrobblerPlugin struct { + name string + plugin *plugin + allowedUserIDs []string // User IDs this plugin can access (from DB configuration) + allUsers bool // If true, plugin can access all users + userIDMap map[string]struct{} // Cached map for fast lookups +} + +// IsAuthorized checks if the user is authorized with this scrobbler. +// First checks if the user is allowed to use this plugin (server-side), +// then delegates to the plugin for service-specific authorization. +func (s *ScrobblerPlugin) IsAuthorized(ctx context.Context, userId string) bool { + // First check server-side authorization based on plugin configuration + if !s.isUserAllowed(userId) { + return false + } + + // Then delegate to the plugin for service-specific authorization + username := getUsernameFromContext(ctx) + input := capabilities.IsAuthorizedRequest{ + Username: username, + } + + result, err := callPluginFunction[capabilities.IsAuthorizedRequest, bool](ctx, s.plugin, FuncScrobblerIsAuthorized, input) + if err != nil { + return false + } + + return result +} + +// isUserAllowed checks if the given user ID is allowed to use this plugin. +func (s *ScrobblerPlugin) isUserAllowed(userId string) bool { + if s.allUsers { + return true + } + if len(s.allowedUserIDs) == 0 { + return false + } + _, ok := s.userIDMap[userId] + return ok +} + +// NowPlaying sends a now playing notification to the scrobbler +func (s *ScrobblerPlugin) NowPlaying(ctx context.Context, userId string, track *model.MediaFile, position int) error { + username := getUsernameFromContext(ctx) + input := capabilities.NowPlayingRequest{ + Username: username, + Track: mediaFileToTrackInfo(track), + Position: int32(position), + } + + err := callPluginFunctionNoOutput(ctx, s.plugin, FuncScrobblerNowPlaying, input) + return mapScrobblerError(err) +} + +// Scrobble submits a scrobble to the scrobbler +func (s *ScrobblerPlugin) Scrobble(ctx context.Context, userId string, sc scrobbler.Scrobble) error { + username := getUsernameFromContext(ctx) + input := capabilities.ScrobbleRequest{ + Username: username, + Track: mediaFileToTrackInfo(&sc.MediaFile), + Timestamp: sc.TimeStamp.Unix(), + } + + err := callPluginFunctionNoOutput(ctx, s.plugin, FuncScrobblerScrobble, input) + return mapScrobblerError(err) +} + +// getUsernameFromContext extracts the username from the request context +func getUsernameFromContext(ctx context.Context) string { + if user, ok := request.UserFrom(ctx); ok { + return user.UserName + } + return "" +} + +// mediaFileToTrackInfo converts a model.MediaFile to capabilities.TrackInfo +func mediaFileToTrackInfo(mf *model.MediaFile) capabilities.TrackInfo { + return capabilities.TrackInfo{ + ID: mf.ID, + Title: mf.Title, + Album: mf.Album, + Artist: mf.Artist, + AlbumArtist: mf.AlbumArtist, + Artists: participantsToArtistRefs(mf.Participants[model.RoleArtist]), + AlbumArtists: participantsToArtistRefs(mf.Participants[model.RoleAlbumArtist]), + Duration: mf.Duration, + TrackNumber: int32(mf.TrackNumber), + DiscNumber: int32(mf.DiscNumber), + MBZRecordingID: mf.MbzRecordingID, + MBZAlbumID: mf.MbzAlbumID, + MBZReleaseGroupID: mf.MbzReleaseGroupID, + MBZReleaseTrackID: mf.MbzReleaseTrackID, + } +} + +// participantsToArtistRefs converts a ParticipantList to a slice of ArtistRef +func participantsToArtistRefs(participants model.ParticipantList) []capabilities.ArtistRef { + refs := make([]capabilities.ArtistRef, len(participants)) + for i, p := range participants { + refs[i] = capabilities.ArtistRef{ + ID: p.ID, + Name: p.Name, + MBID: p.MbzArtistID, + } + } + return refs +} + +// mapScrobblerError converts plugin errors to scrobbler errors based on error message, as errors are returned as +// strings from plugins. +func mapScrobblerError(err error) error { + if err == nil { + return nil + } + errMsg := err.Error() + switch { + case strings.Contains(errMsg, capabilities.ScrobblerErrorNotAuthorized.Error()): + return scrobbler.ErrNotAuthorized + case strings.Contains(errMsg, capabilities.ScrobblerErrorRetryLater.Error()): + return scrobbler.ErrRetryLater + case strings.Contains(errMsg, capabilities.ScrobblerErrorUnrecoverable.Error()): + return scrobbler.ErrUnrecoverable + default: + return scrobbler.ErrUnrecoverable + } +} + +// Verify interface implementation at compile time +var _ scrobbler.Scrobbler = (*ScrobblerPlugin)(nil) diff --git a/plugins/scrobbler_adapter_test.go b/plugins/scrobbler_adapter_test.go new file mode 100644 index 000000000..ab8dc6f88 --- /dev/null +++ b/plugins/scrobbler_adapter_test.go @@ -0,0 +1,269 @@ +//go:build !windows + +package plugins + +import ( + "context" + "errors" + "time" + + "github.com/navidrome/navidrome/core/scrobbler" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +// ctxWithUser returns a fresh context with the test user. +// Must be called within each test, not in BeforeAll, because the context +// from BeforeAll gets cancelled before tests run. +func ctxWithUser() context.Context { + return request.WithUser(GinkgoT().Context(), model.User{ID: "user-1", UserName: "testuser"}) +} + +var _ = Describe("ScrobblerPlugin", Ordered, func() { + var ( + scrobblerManager *Manager + s scrobbler.Scrobbler + ) + + BeforeAll(func() { + // Load the scrobbler via a new manager with the test-scrobbler plugin + scrobblerManager, _ = createTestManagerWithPlugins(nil, "test-scrobbler"+PackageExtension) + + var ok bool + s, ok = scrobblerManager.LoadScrobbler("test-scrobbler") + Expect(ok).To(BeTrue()) + }) + + Describe("LoadScrobbler", func() { + It("returns a scrobbler for a plugin with Scrobbler capability", func() { + Expect(s).ToNot(BeNil()) + }) + + It("returns false for a plugin without Scrobbler capability", func() { + _, ok := testManager.LoadScrobbler("test-metadata-agent") + Expect(ok).To(BeFalse()) + }) + + It("returns false for non-existent plugin", func() { + _, ok := scrobblerManager.LoadScrobbler("non-existent") + Expect(ok).To(BeFalse()) + }) + }) + + Describe("IsAuthorized", func() { + It("returns true when plugin is configured to authorize", func() { + result := s.IsAuthorized(ctxWithUser(), "user-1") + Expect(result).To(BeTrue()) + }) + + Context("when plugin is configured to not authorize", Ordered, func() { + var notAuthScrobbler scrobbler.Scrobbler + + BeforeAll(func() { + mgr, _ := createTestManagerWithPlugins(map[string]map[string]string{ + "test-scrobbler": {"authorized": "false"}, + }, "test-scrobbler"+PackageExtension) + + var ok bool + notAuthScrobbler, ok = mgr.LoadScrobbler("test-scrobbler") + Expect(ok).To(BeTrue()) + }) + + It("returns false", func() { + result := notAuthScrobbler.IsAuthorized(ctxWithUser(), "user-1") + Expect(result).To(BeFalse()) + }) + }) + }) + + Describe("isUserAllowed", func() { + It("returns true when allUsers is true", func() { + sp := &ScrobblerPlugin{allUsers: true} + Expect(sp.isUserAllowed("any-user")).To(BeTrue()) + }) + + It("returns false when allowedUserIDs is empty and allUsers is false", func() { + sp := &ScrobblerPlugin{allUsers: false, allowedUserIDs: []string{}} + Expect(sp.isUserAllowed("user-1")).To(BeFalse()) + }) + + It("returns false when allowedUserIDs is nil and allUsers is false", func() { + sp := &ScrobblerPlugin{allUsers: false} + Expect(sp.isUserAllowed("user-1")).To(BeFalse()) + }) + + It("returns true when user is in allowedUserIDs", func() { + sp := &ScrobblerPlugin{ + allUsers: false, + allowedUserIDs: []string{"user-1", "user-2"}, + userIDMap: map[string]struct{}{"user-1": {}, "user-2": {}}, + } + Expect(sp.isUserAllowed("user-1")).To(BeTrue()) + }) + + It("returns false when user is not in allowedUserIDs", func() { + sp := &ScrobblerPlugin{ + allUsers: false, + allowedUserIDs: []string{"user-1", "user-2"}, + userIDMap: map[string]struct{}{"user-1": {}, "user-2": {}}, + } + Expect(sp.isUserAllowed("user-3")).To(BeFalse()) + }) + }) + + Describe("NowPlaying", func() { + It("successfully calls the plugin", func() { + track := &model.MediaFile{ + ID: "track-1", + Title: "Test Song", + Album: "Test Album", + Artist: "Test Artist", + AlbumArtist: "Test Album Artist", + Duration: 180, + TrackNumber: 1, + DiscNumber: 1, + Participants: model.Participants{ + model.RoleArtist: {{Artist: model.Artist{ID: "artist-1", Name: "Test Artist"}}}, + model.RoleAlbumArtist: {{Artist: model.Artist{ID: "album-artist-1", Name: "Test Album Artist"}}}, + }, + } + + err := s.NowPlaying(ctxWithUser(), "user-1", track, 30) + Expect(err).ToNot(HaveOccurred()) + }) + + Context("when plugin returns error", Ordered, func() { + var retryScrobbler scrobbler.Scrobbler + + BeforeAll(func() { + mgr, _ := createTestManagerWithPlugins(map[string]map[string]string{ + "test-scrobbler": {"error": "service unavailable", "error_type": "scrobbler(retry_later)"}, + }, "test-scrobbler"+PackageExtension) + + var ok bool + retryScrobbler, ok = mgr.LoadScrobbler("test-scrobbler") + Expect(ok).To(BeTrue()) + }) + + It("returns ErrRetryLater", func() { + track := &model.MediaFile{ID: "track-1", Title: "Test Song"} + err := retryScrobbler.NowPlaying(ctxWithUser(), "user-1", track, 30) + Expect(err).To(HaveOccurred()) + Expect(err).To(MatchError(scrobbler.ErrRetryLater)) + }) + }) + }) + + Describe("Scrobble", func() { + It("successfully calls the plugin", func() { + sc := scrobbler.Scrobble{ + MediaFile: model.MediaFile{ + ID: "track-1", + Title: "Test Song", + Album: "Test Album", + Artist: "Test Artist", + AlbumArtist: "Test Album Artist", + Duration: 180, + TrackNumber: 1, + DiscNumber: 1, + Participants: model.Participants{ + model.RoleArtist: {{Artist: model.Artist{ID: "artist-1", Name: "Test Artist"}}}, + model.RoleAlbumArtist: {{Artist: model.Artist{ID: "album-artist-1", Name: "Test Album Artist"}}}, + }, + }, + TimeStamp: time.Now(), + } + + err := s.Scrobble(ctxWithUser(), "user-1", sc) + Expect(err).ToNot(HaveOccurred()) + }) + + Context("when plugin returns not_authorized error", Ordered, func() { + var notAuthScrobbler scrobbler.Scrobbler + + BeforeAll(func() { + mgr, _ := createTestManagerWithPlugins(map[string]map[string]string{ + "test-scrobbler": {"error": "user not linked", "error_type": "scrobbler(not_authorized)"}, + }, "test-scrobbler"+PackageExtension) + + var ok bool + notAuthScrobbler, ok = mgr.LoadScrobbler("test-scrobbler") + Expect(ok).To(BeTrue()) + }) + + It("returns ErrNotAuthorized", func() { + scrobble := scrobbler.Scrobble{ + MediaFile: model.MediaFile{ID: "track-1", Title: "Test Song"}, + TimeStamp: time.Now(), + } + err := notAuthScrobbler.Scrobble(ctxWithUser(), "user-1", scrobble) + Expect(err).To(HaveOccurred()) + Expect(err).To(MatchError(scrobbler.ErrNotAuthorized)) + }) + }) + + Context("when plugin returns unrecoverable error", Ordered, func() { + var unrecoverableScrobbler scrobbler.Scrobbler + + BeforeAll(func() { + mgr, _ := createTestManagerWithPlugins(map[string]map[string]string{ + "test-scrobbler": {"error": "track rejected", "error_type": "scrobbler(unrecoverable)"}, + }, "test-scrobbler"+PackageExtension) + + var ok bool + unrecoverableScrobbler, ok = mgr.LoadScrobbler("test-scrobbler") + Expect(ok).To(BeTrue()) + }) + + It("returns ErrUnrecoverable", func() { + scrobble := scrobbler.Scrobble{ + MediaFile: model.MediaFile{ID: "track-1", Title: "Test Song"}, + TimeStamp: time.Now(), + } + err := unrecoverableScrobbler.Scrobble(ctxWithUser(), "user-1", scrobble) + Expect(err).To(HaveOccurred()) + Expect(err).To(MatchError(scrobbler.ErrUnrecoverable)) + }) + }) + }) + + Describe("PluginNames", func() { + It("returns plugin names with Scrobbler capability", func() { + names := scrobblerManager.PluginNames("Scrobbler") + Expect(names).To(ContainElement("test-scrobbler")) + }) + + It("does not return metadata agent plugins for Scrobbler capability", func() { + names := testManager.PluginNames("Scrobbler") + Expect(names).ToNot(ContainElement("test-metadata-agent")) + }) + }) +}) + +var _ = Describe("mapScrobblerError", func() { + It("returns nil for nil error", func() { + Expect(mapScrobblerError(nil)).ToNot(HaveOccurred()) + }) + + It("returns ErrNotAuthorized for error containing 'not_authorized'", func() { + err := mapScrobblerError(errors.New("plugin error: scrobbler(not_authorized)")) + Expect(err).To(MatchError(scrobbler.ErrNotAuthorized)) + }) + + It("returns ErrRetryLater for error containing 'retry_later'", func() { + err := mapScrobblerError(errors.New("temporary failure: scrobbler(retry_later)")) + Expect(err).To(MatchError(scrobbler.ErrRetryLater)) + }) + + It("returns ErrUnrecoverable for error containing 'unrecoverable'", func() { + err := mapScrobblerError(errors.New("fatal error: scrobbler(unrecoverable)")) + Expect(err).To(MatchError(scrobbler.ErrUnrecoverable)) + }) + + It("returns ErrUnrecoverable for unknown error", func() { + err := mapScrobblerError(errors.New("some unknown error")) + Expect(err).To(MatchError(scrobbler.ErrUnrecoverable)) + }) +}) diff --git a/plugins/testdata/.gitignore b/plugins/testdata/.gitignore deleted file mode 100644 index 917660a34..000000000 --- a/plugins/testdata/.gitignore +++ /dev/null @@ -1 +0,0 @@ -*.wasm \ No newline at end of file diff --git a/plugins/testdata/Makefile b/plugins/testdata/Makefile index f569cfce5..d53f2aaee 100644 --- a/plugins/testdata/Makefile +++ b/plugins/testdata/Makefile @@ -1,10 +1,31 @@ -# Fake sample plugins used for testing -PLUGINS := fake_album_agent fake_artist_agent fake_scrobbler multi_plugin fake_init_service unauthorized_plugin +# Build test plugins used for integration testing +# Auto-discover all plugin folders (folders containing go.mod) +PLUGINS := $(patsubst %/go.mod,%,$(wildcard */go.mod)) -all: $(PLUGINS:%=%/plugin.wasm) +# Prefer tinygo if available, it produces smaller wasm binaries and +# makes the tests faster. +TINYGO := $(shell command -v tinygo 2> /dev/null) + +all: $(PLUGINS:%=%.ndp) clean: - rm -f $(PLUGINS:%=%/plugin.wasm) + rm -f $(PLUGINS:%=%.ndp) $(PLUGINS:%=%.wasm) -%/plugin.wasm: %/plugin.go - GOOS=wasip1 GOARCH=wasm go build -buildmode=c-shared -o $@ ./$* \ No newline at end of file +# PDK source files that trigger rebuild when changed (recursive) +PDK_SOURCES := $(shell find ../pdk/go -name '*.go' 2>/dev/null) + +# Build the .ndp package (zip containing manifest.json + plugin.wasm) +%.ndp: %.wasm %/manifest.json + @rm -f $@ + @cp $< plugin.wasm + zip -j $@ $*/manifest.json plugin.wasm + @rm -f plugin.wasm + @mv $< $<.tmp && mv $<.tmp $< # Touch wasm to ensure it's older than ndp + +# Build the wasm binary +%.wasm: %/*.go %/go.mod $(PDK_SOURCES) +ifdef TINYGO + cd $* && tinygo build -target wasip1 -buildmode=c-shared -o ../$@ . +else + cd $* && GOOS=wasip1 GOARCH=wasm go build -buildmode=c-shared -o ../$@ . +endif \ No newline at end of file diff --git a/plugins/testdata/README.md b/plugins/testdata/README.md deleted file mode 100644 index abe840ff8..000000000 --- a/plugins/testdata/README.md +++ /dev/null @@ -1,17 +0,0 @@ -# Plugin Test Data - -This directory contains test data and mock implementations used for testing the Navidrome plugin system. - -## Contents - -Each of these directories contains the source code for a simple Go plugin that implements a specific agent interface -(or multiple interfaces in the case of `multi_plugin`). These are compiled into WASM modules using the -`Makefile` and used in integration tests for the plugin adapters (e.g., `adapter_media_agent_test.go`). - -Running `make` within this directory will build all test plugins. - -## Usage - -The primary use of this directory is during the development and testing phase. The `Makefile` is used to build the -necessary WASM plugin binaries. The tests within the `plugins` package (and potentially other packages that interact -with plugins) then utilize these compiled plugins and other test fixtures found here. diff --git a/plugins/testdata/fake_album_agent/manifest.json b/plugins/testdata/fake_album_agent/manifest.json deleted file mode 100644 index e8dfb1fb3..000000000 --- a/plugins/testdata/fake_album_agent/manifest.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "name": "fake_album_agent", - "author": "Navidrome Test", - "version": "1.0.0", - "description": "Test data for album agent", - "website": "https://test.navidrome.org/fake-album-agent", - "capabilities": ["MetadataAgent"], - "permissions": {} -} diff --git a/plugins/testdata/fake_album_agent/plugin.go b/plugins/testdata/fake_album_agent/plugin.go deleted file mode 100644 index c35e90397..000000000 --- a/plugins/testdata/fake_album_agent/plugin.go +++ /dev/null @@ -1,70 +0,0 @@ -//go:build wasip1 - -package main - -import ( - "context" - - "github.com/navidrome/navidrome/plugins/api" -) - -type FakeAlbumAgent struct{} - -var ErrNotFound = api.ErrNotFound - -func (FakeAlbumAgent) GetAlbumInfo(ctx context.Context, req *api.AlbumInfoRequest) (*api.AlbumInfoResponse, error) { - if req.Name != "" && req.Artist != "" { - return &api.AlbumInfoResponse{ - Info: &api.AlbumInfo{ - Name: req.Name, - Mbid: "album-mbid-123", - Description: "This is a test album description", - Url: "https://example.com/album", - }, - }, nil - } - return nil, ErrNotFound -} - -func (FakeAlbumAgent) GetAlbumImages(ctx context.Context, req *api.AlbumImagesRequest) (*api.AlbumImagesResponse, error) { - if req.Name != "" && req.Artist != "" { - return &api.AlbumImagesResponse{ - Images: []*api.ExternalImage{ - {Url: "https://example.com/album1.jpg", Size: 300}, - {Url: "https://example.com/album2.jpg", Size: 400}, - }, - }, nil - } - return nil, ErrNotFound -} - -func (FakeAlbumAgent) GetArtistMBID(ctx context.Context, req *api.ArtistMBIDRequest) (*api.ArtistMBIDResponse, error) { - return nil, api.ErrNotImplemented -} - -func (FakeAlbumAgent) GetArtistURL(ctx context.Context, req *api.ArtistURLRequest) (*api.ArtistURLResponse, error) { - return nil, api.ErrNotImplemented -} - -func (FakeAlbumAgent) GetArtistBiography(ctx context.Context, req *api.ArtistBiographyRequest) (*api.ArtistBiographyResponse, error) { - return nil, api.ErrNotImplemented -} - -func (FakeAlbumAgent) GetSimilarArtists(ctx context.Context, req *api.ArtistSimilarRequest) (*api.ArtistSimilarResponse, error) { - return nil, api.ErrNotImplemented -} - -func (FakeAlbumAgent) GetArtistImages(ctx context.Context, req *api.ArtistImageRequest) (*api.ArtistImageResponse, error) { - return nil, api.ErrNotImplemented -} - -func (FakeAlbumAgent) GetArtistTopSongs(ctx context.Context, req *api.ArtistTopSongsRequest) (*api.ArtistTopSongsResponse, error) { - return nil, api.ErrNotImplemented -} - -func main() {} - -// Register the plugin implementation -func init() { - api.RegisterMetadataAgent(FakeAlbumAgent{}) -} diff --git a/plugins/testdata/fake_artist_agent/manifest.json b/plugins/testdata/fake_artist_agent/manifest.json deleted file mode 100644 index c5db72565..000000000 --- a/plugins/testdata/fake_artist_agent/manifest.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "name": "fake_artist_agent", - "author": "Navidrome Test", - "version": "1.0.0", - "description": "Test data for artist agent", - "website": "https://test.navidrome.org/fake-artist-agent", - "capabilities": ["MetadataAgent"], - "permissions": {} -} diff --git a/plugins/testdata/fake_artist_agent/plugin.go b/plugins/testdata/fake_artist_agent/plugin.go deleted file mode 100644 index bd6b0f771..000000000 --- a/plugins/testdata/fake_artist_agent/plugin.go +++ /dev/null @@ -1,82 +0,0 @@ -//go:build wasip1 - -package main - -import ( - "context" - - "github.com/navidrome/navidrome/plugins/api" -) - -type FakeArtistAgent struct{} - -var ErrNotFound = api.ErrNotFound - -func (FakeArtistAgent) GetArtistMBID(ctx context.Context, req *api.ArtistMBIDRequest) (*api.ArtistMBIDResponse, error) { - if req.Name != "" { - return &api.ArtistMBIDResponse{Mbid: "1234567890"}, nil - } - return nil, ErrNotFound -} -func (FakeArtistAgent) GetArtistURL(ctx context.Context, req *api.ArtistURLRequest) (*api.ArtistURLResponse, error) { - if req.Name != "" { - return &api.ArtistURLResponse{Url: "https://example.com"}, nil - } - return nil, ErrNotFound -} -func (FakeArtistAgent) GetArtistBiography(ctx context.Context, req *api.ArtistBiographyRequest) (*api.ArtistBiographyResponse, error) { - if req.Name != "" { - return &api.ArtistBiographyResponse{Biography: "This is a test biography"}, nil - } - return nil, ErrNotFound -} -func (FakeArtistAgent) GetSimilarArtists(ctx context.Context, req *api.ArtistSimilarRequest) (*api.ArtistSimilarResponse, error) { - if req.Name != "" { - return &api.ArtistSimilarResponse{ - Artists: []*api.Artist{ - {Name: "Similar Artist 1", Mbid: "mbid1"}, - {Name: "Similar Artist 2", Mbid: "mbid2"}, - }, - }, nil - } - return nil, ErrNotFound -} -func (FakeArtistAgent) GetArtistImages(ctx context.Context, req *api.ArtistImageRequest) (*api.ArtistImageResponse, error) { - if req.Name != "" { - return &api.ArtistImageResponse{ - Images: []*api.ExternalImage{ - {Url: "https://example.com/image1.jpg", Size: 100}, - {Url: "https://example.com/image2.jpg", Size: 200}, - }, - }, nil - } - return nil, ErrNotFound -} -func (FakeArtistAgent) GetArtistTopSongs(ctx context.Context, req *api.ArtistTopSongsRequest) (*api.ArtistTopSongsResponse, error) { - if req.ArtistName != "" { - return &api.ArtistTopSongsResponse{ - Songs: []*api.Song{ - {Name: "Song 1", Mbid: "mbid1"}, - {Name: "Song 2", Mbid: "mbid2"}, - }, - }, nil - } - return nil, ErrNotFound -} - -// Add empty implementations for the album methods to satisfy the MetadataAgent interface -func (FakeArtistAgent) GetAlbumInfo(ctx context.Context, req *api.AlbumInfoRequest) (*api.AlbumInfoResponse, error) { - return nil, api.ErrNotImplemented -} - -func (FakeArtistAgent) GetAlbumImages(ctx context.Context, req *api.AlbumImagesRequest) (*api.AlbumImagesResponse, error) { - return nil, api.ErrNotImplemented -} - -// main is required by Go WASI build -func main() {} - -// init is used by go-plugin to register the implementation -func init() { - api.RegisterMetadataAgent(FakeArtistAgent{}) -} diff --git a/plugins/testdata/fake_init_service/manifest.json b/plugins/testdata/fake_init_service/manifest.json deleted file mode 100644 index ea8c45f58..000000000 --- a/plugins/testdata/fake_init_service/manifest.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "name": "fake_init_service", - "version": "1.0.0", - "capabilities": ["LifecycleManagement"], - "author": "Test Author", - "description": "Test LifecycleManagement Callback", - "website": "https://test.navidrome.org/fake-init-service", - "permissions": {} -} diff --git a/plugins/testdata/fake_init_service/plugin.go b/plugins/testdata/fake_init_service/plugin.go deleted file mode 100644 index 9e6171623..000000000 --- a/plugins/testdata/fake_init_service/plugin.go +++ /dev/null @@ -1,42 +0,0 @@ -//go:build wasip1 - -package main - -import ( - "context" - "errors" - "log" - - "github.com/navidrome/navidrome/plugins/api" -) - -type initServicePlugin struct{} - -func (p *initServicePlugin) OnInit(ctx context.Context, req *api.InitRequest) (*api.InitResponse, error) { - log.Printf("OnInit called with %v", req) - - // Check for specific error conditions in the config - if req.Config != nil { - if errorType, exists := req.Config["returnError"]; exists { - switch errorType { - case "go_error": - return nil, errors.New("initialization failed with Go error") - case "response_error": - return &api.InitResponse{ - Error: "initialization failed with response error", - }, nil - } - } - } - - // Default: successful initialization - return &api.InitResponse{}, nil -} - -// Required by Go WASI build -func main() {} - -// Register the LifecycleManagement implementation -func init() { - api.RegisterLifecycleManagement(&initServicePlugin{}) -} diff --git a/plugins/testdata/fake_scrobbler/manifest.json b/plugins/testdata/fake_scrobbler/manifest.json deleted file mode 100644 index 6fa41aa31..000000000 --- a/plugins/testdata/fake_scrobbler/manifest.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "name": "fake_scrobbler", - "author": "Navidrome Test", - "version": "1.0.0", - "description": "Test data for scrobbler", - "website": "https://test.navidrome.org/fake-scrobbler", - "capabilities": ["Scrobbler"], - "permissions": {} -} diff --git a/plugins/testdata/fake_scrobbler/plugin.go b/plugins/testdata/fake_scrobbler/plugin.go deleted file mode 100644 index 5a5c76699..000000000 --- a/plugins/testdata/fake_scrobbler/plugin.go +++ /dev/null @@ -1,33 +0,0 @@ -//go:build wasip1 - -package main - -import ( - "context" - "log" - - "github.com/navidrome/navidrome/plugins/api" -) - -type FakeScrobbler struct{} - -func (FakeScrobbler) IsAuthorized(ctx context.Context, req *api.ScrobblerIsAuthorizedRequest) (*api.ScrobblerIsAuthorizedResponse, error) { - log.Printf("[FakeScrobbler] IsAuthorized called for user: %s (%s)", req.Username, req.UserId) - return &api.ScrobblerIsAuthorizedResponse{Authorized: true}, nil -} - -func (FakeScrobbler) NowPlaying(ctx context.Context, req *api.ScrobblerNowPlayingRequest) (*api.ScrobblerNowPlayingResponse, error) { - log.Printf("[FakeScrobbler] NowPlaying called for user: %s (%s), track: %s", req.Username, req.UserId, req.Track.Name) - return &api.ScrobblerNowPlayingResponse{}, nil -} - -func (FakeScrobbler) Scrobble(ctx context.Context, req *api.ScrobblerScrobbleRequest) (*api.ScrobblerScrobbleResponse, error) { - log.Printf("[FakeScrobbler] Scrobble called for user: %s (%s), track: %s, timestamp: %d", req.Username, req.UserId, req.Track.Name, req.Timestamp) - return &api.ScrobblerScrobbleResponse{}, nil -} - -func main() {} - -func init() { - api.RegisterScrobbler(FakeScrobbler{}) -} diff --git a/plugins/testdata/multi_plugin/manifest.json b/plugins/testdata/multi_plugin/manifest.json deleted file mode 100644 index dc9e0a9a8..000000000 --- a/plugins/testdata/multi_plugin/manifest.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "name": "multi_plugin", - "author": "Navidrome Test", - "version": "1.0.0", - "description": "Test data for multiple services", - "website": "https://test.navidrome.org/multi-plugin", - "capabilities": ["MetadataAgent", "SchedulerCallback", "LifecycleManagement"], - "permissions": { - "scheduler": { - "reason": "For testing scheduled callback functionality" - } - } -} diff --git a/plugins/testdata/multi_plugin/plugin.go b/plugins/testdata/multi_plugin/plugin.go deleted file mode 100644 index 3c28bd214..000000000 --- a/plugins/testdata/multi_plugin/plugin.go +++ /dev/null @@ -1,124 +0,0 @@ -//go:build wasip1 - -package main - -import ( - "context" - "log" - "strings" - - "github.com/navidrome/navidrome/plugins/api" - "github.com/navidrome/navidrome/plugins/host/scheduler" -) - -// MultiPlugin implements the MetadataAgent interface for testing -type MultiPlugin struct{} - -var ErrNotFound = api.ErrNotFound - -var sched = scheduler.NewSchedulerService() - -// Artist-related methods -func (MultiPlugin) GetArtistMBID(ctx context.Context, req *api.ArtistMBIDRequest) (*api.ArtistMBIDResponse, error) { - if req.Name != "" { - return &api.ArtistMBIDResponse{Mbid: "multi-artist-mbid"}, nil - } - return nil, ErrNotFound -} - -func (MultiPlugin) GetArtistURL(ctx context.Context, req *api.ArtistURLRequest) (*api.ArtistURLResponse, error) { - log.Printf("GetArtistURL received: %v", req) - - // Use an ID that could potentially clash with other plugins - // The host will ensure this doesn't conflict by prefixing with plugin name - customId := "artist:" + req.Name - log.Printf("Registering scheduler with custom ID: %s", customId) - - // Use the scheduler service for one-time scheduling - resp, err := sched.ScheduleOneTime(ctx, &scheduler.ScheduleOneTimeRequest{ - ScheduleId: customId, - DelaySeconds: 6, - Payload: []byte("test-payload"), - }) - if err != nil { - log.Printf("Error scheduling one-time job: %v", err) - } else { - log.Printf("One-time schedule registered with ID: %s", resp.ScheduleId) - } - - return &api.ArtistURLResponse{Url: "https://multi.example.com/artist"}, nil -} - -func (MultiPlugin) GetArtistBiography(ctx context.Context, req *api.ArtistBiographyRequest) (*api.ArtistBiographyResponse, error) { - return &api.ArtistBiographyResponse{Biography: "Multi agent artist bio"}, nil -} - -func (MultiPlugin) GetSimilarArtists(ctx context.Context, req *api.ArtistSimilarRequest) (*api.ArtistSimilarResponse, error) { - return &api.ArtistSimilarResponse{}, nil -} - -func (MultiPlugin) GetArtistImages(ctx context.Context, req *api.ArtistImageRequest) (*api.ArtistImageResponse, error) { - return &api.ArtistImageResponse{}, nil -} - -func (MultiPlugin) GetArtistTopSongs(ctx context.Context, req *api.ArtistTopSongsRequest) (*api.ArtistTopSongsResponse, error) { - return &api.ArtistTopSongsResponse{}, nil -} - -// Album-related methods -func (MultiPlugin) GetAlbumInfo(ctx context.Context, req *api.AlbumInfoRequest) (*api.AlbumInfoResponse, error) { - if req.Name != "" && req.Artist != "" { - return &api.AlbumInfoResponse{ - Info: &api.AlbumInfo{ - Name: req.Name, - Mbid: "multi-album-mbid", - Description: "Multi agent album description", - Url: "https://multi.example.com/album", - }, - }, nil - } - return nil, ErrNotFound -} - -func (MultiPlugin) GetAlbumImages(ctx context.Context, req *api.AlbumImagesRequest) (*api.AlbumImagesResponse, error) { - return &api.AlbumImagesResponse{}, nil -} - -// Scheduler callback -func (MultiPlugin) OnSchedulerCallback(ctx context.Context, req *api.SchedulerCallbackRequest) (*api.SchedulerCallbackResponse, error) { - log.Printf("Scheduler callback received with ID: %s, payload: '%s', isRecurring: %v", - req.ScheduleId, string(req.Payload), req.IsRecurring) - - // Demonstrate how to parse the custom ID format - if strings.HasPrefix(req.ScheduleId, "artist:") { - parts := strings.Split(req.ScheduleId, ":") - if len(parts) == 2 { - artistName := parts[1] - log.Printf("This schedule was for artist: %s", artistName) - } - } - - return &api.SchedulerCallbackResponse{}, nil -} - -func (MultiPlugin) OnInit(ctx context.Context, req *api.InitRequest) (*api.InitResponse, error) { - log.Printf("OnInit called with %v", req) - - // Schedule a recurring every 5 seconds - _, _ = sched.ScheduleRecurring(ctx, &scheduler.ScheduleRecurringRequest{ - CronExpression: "@every 5s", - Payload: []byte("every 5 seconds"), - }) - - return &api.InitResponse{}, nil -} - -// Required by Go WASI build -func main() {} - -// Register the service implementations -func init() { - api.RegisterLifecycleManagement(MultiPlugin{}) - api.RegisterMetadataAgent(MultiPlugin{}) - api.RegisterSchedulerCallback(MultiPlugin{}) -} diff --git a/plugins/testdata/partial-metadata-agent/go.mod b/plugins/testdata/partial-metadata-agent/go.mod new file mode 100644 index 000000000..b37144d9a --- /dev/null +++ b/plugins/testdata/partial-metadata-agent/go.mod @@ -0,0 +1,16 @@ +module partial-metadata-agent + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/testdata/partial-metadata-agent/go.sum b/plugins/testdata/partial-metadata-agent/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/testdata/partial-metadata-agent/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/testdata/partial-metadata-agent/main.go b/plugins/testdata/partial-metadata-agent/main.go new file mode 100644 index 000000000..c11febf00 --- /dev/null +++ b/plugins/testdata/partial-metadata-agent/main.go @@ -0,0 +1,23 @@ +// Test plugin that only implements some metadata methods. +// Used to test the "not implemented" code path (-2 return code). +// Build with: tinygo build -o ../partial-metadata-agent.wasm -target wasip1 -buildmode=c-shared . +package main + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/metadata" +) + +func init() { + metadata.Register(&partialMetadataAgent{}) +} + +// partialMetadataAgent only implements GetArtistBiography. +// All other methods will return NotImplementedCode (-2). +type partialMetadataAgent struct{} + +// GetArtistBiography is the only method we implement. +func (t *partialMetadataAgent) GetArtistBiography(input metadata.ArtistRequest) (*metadata.ArtistBiographyResponse, error) { + return &metadata.ArtistBiographyResponse{Biography: "Partial agent biography for " + input.Name}, nil +} + +func main() {} diff --git a/plugins/testdata/partial-metadata-agent/manifest.json b/plugins/testdata/partial-metadata-agent/manifest.json new file mode 100644 index 000000000..a600985a8 --- /dev/null +++ b/plugins/testdata/partial-metadata-agent/manifest.json @@ -0,0 +1,6 @@ +{ + "name": "Partial Metadata Agent", + "author": "Navidrome Test", + "version": "1.0.0", + "description": "A test plugin that only implements some metadata methods" +} diff --git a/plugins/testdata/test-artwork/go.mod b/plugins/testdata/test-artwork/go.mod new file mode 100644 index 000000000..553f5e575 --- /dev/null +++ b/plugins/testdata/test-artwork/go.mod @@ -0,0 +1,16 @@ +module test-artwork + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/testdata/test-artwork/go.sum b/plugins/testdata/test-artwork/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/testdata/test-artwork/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/testdata/test-artwork/main.go b/plugins/testdata/test-artwork/main.go new file mode 100644 index 000000000..de857dd97 --- /dev/null +++ b/plugins/testdata/test-artwork/main.go @@ -0,0 +1,64 @@ +// Test Artwork plugin for Navidrome plugin system integration tests. +// Build with: tinygo build -o ../test-artwork.wasm -target wasip1 -buildmode=c-shared . +package main + +import ( + "strings" + + "github.com/navidrome/navidrome/plugins/pdk/go/host" + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// TestInput is the input for nd_test_artwork callback. +type TestInput struct { + ArtworkType string `json:"artwork_type"` // "artist", "album", "track", "playlist" + ID string `json:"id"` + Size int32 `json:"size"` +} + +// TestOutput is the output from nd_test_artwork callback. +type TestOutput struct { + URL string `json:"url,omitempty"` + Error *string `json:"error,omitempty"` +} + +// nd_test_artwork is the test callback that tests the artwork host functions. +// +//go:wasmexport nd_test_artwork +func ndTestArtwork() int32 { + var input TestInput + if err := pdk.InputJSON(&input); err != nil { + errStr := err.Error() + pdk.OutputJSON(TestOutput{Error: &errStr}) + return 0 + } + + var url string + var err error + + switch strings.ToLower(input.ArtworkType) { + case "artist": + url, err = host.ArtworkGetArtistUrl(input.ID, input.Size) + case "album": + url, err = host.ArtworkGetAlbumUrl(input.ID, input.Size) + case "track": + url, err = host.ArtworkGetTrackUrl(input.ID, input.Size) + case "playlist": + url, err = host.ArtworkGetPlaylistUrl(input.ID, input.Size) + default: + errStr := "unknown artwork type: " + input.ArtworkType + pdk.OutputJSON(TestOutput{Error: &errStr}) + return 0 + } + + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestOutput{Error: &errStr}) + return 0 + } + + pdk.OutputJSON(TestOutput{URL: url}) + return 0 +} + +func main() {} diff --git a/plugins/testdata/test-artwork/manifest.json b/plugins/testdata/test-artwork/manifest.json new file mode 100644 index 000000000..c6ddbcb05 --- /dev/null +++ b/plugins/testdata/test-artwork/manifest.json @@ -0,0 +1,11 @@ +{ + "name": "Test Artwork", + "author": "Navidrome Test", + "version": "1.0.0", + "description": "A test artwork plugin for integration testing", + "permissions": { + "artwork": { + "reason": "For testing artwork URL generation" + } + } +} diff --git a/plugins/testdata/test-cache-plugin/go.mod b/plugins/testdata/test-cache-plugin/go.mod new file mode 100644 index 000000000..c41110b70 --- /dev/null +++ b/plugins/testdata/test-cache-plugin/go.mod @@ -0,0 +1,16 @@ +module test-cache-plugin + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/testdata/test-cache-plugin/go.sum b/plugins/testdata/test-cache-plugin/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/testdata/test-cache-plugin/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/testdata/test-cache-plugin/main.go b/plugins/testdata/test-cache-plugin/main.go new file mode 100644 index 000000000..1d193ac39 --- /dev/null +++ b/plugins/testdata/test-cache-plugin/main.go @@ -0,0 +1,150 @@ +// Test Cache plugin for Navidrome plugin system integration tests. +// Build with: tinygo build -o ../test-cache-plugin.wasm -target wasip1 -buildmode=c-shared . +package main + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/host" + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// TestCacheInput is the input for nd_test_cache callback. +type TestCacheInput struct { + Operation string `json:"operation"` // "set_string", "get_string", "set_int", "get_int", "set_float", "get_float", "set_bytes", "get_bytes", "has", "remove" + Key string `json:"key"` // Cache key + StringVal string `json:"string_val"` // For string operations + IntVal int64 `json:"int_val"` // For int operations + FloatVal float64 `json:"float_val"` // For float operations + BytesVal []byte `json:"bytes_val"` // For bytes operations + TTLSeconds int64 `json:"ttl_seconds"` // TTL in seconds +} + +// TestCacheOutput is the output from nd_test_cache callback. +type TestCacheOutput struct { + StringVal string `json:"string_val,omitempty"` + IntVal int64 `json:"int_val,omitempty"` + FloatVal float64 `json:"float_val,omitempty"` + BytesVal []byte `json:"bytes_val,omitempty"` + Exists bool `json:"exists,omitempty"` + Error *string `json:"error,omitempty"` +} + +// nd_test_cache is the test callback that tests the cache host functions. +// +//go:wasmexport nd_test_cache +func ndTestCache() int32 { + var input TestCacheInput + if err := pdk.InputJSON(&input); err != nil { + errStr := err.Error() + pdk.OutputJSON(TestCacheOutput{Error: &errStr}) + return 0 + } + + switch input.Operation { + case "set_string": + err := host.CacheSetString(input.Key, input.StringVal, input.TTLSeconds) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestCacheOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestCacheOutput{}) + return 0 + + case "get_string": + value, exists, err := host.CacheGetString(input.Key) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestCacheOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestCacheOutput{StringVal: value, Exists: exists}) + return 0 + + case "set_int": + err := host.CacheSetInt(input.Key, input.IntVal, input.TTLSeconds) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestCacheOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestCacheOutput{}) + return 0 + + case "get_int": + value, exists, err := host.CacheGetInt(input.Key) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestCacheOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestCacheOutput{IntVal: value, Exists: exists}) + return 0 + + case "set_float": + err := host.CacheSetFloat(input.Key, input.FloatVal, input.TTLSeconds) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestCacheOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestCacheOutput{}) + return 0 + + case "get_float": + value, exists, err := host.CacheGetFloat(input.Key) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestCacheOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestCacheOutput{FloatVal: value, Exists: exists}) + return 0 + + case "set_bytes": + err := host.CacheSetBytes(input.Key, input.BytesVal, input.TTLSeconds) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestCacheOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestCacheOutput{}) + return 0 + + case "get_bytes": + value, exists, err := host.CacheGetBytes(input.Key) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestCacheOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestCacheOutput{BytesVal: value, Exists: exists}) + return 0 + + case "has": + exists, err := host.CacheHas(input.Key) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestCacheOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestCacheOutput{Exists: exists}) + return 0 + + case "remove": + err := host.CacheRemove(input.Key) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestCacheOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestCacheOutput{}) + return 0 + + default: + errStr := "unknown operation: " + input.Operation + pdk.OutputJSON(TestCacheOutput{Error: &errStr}) + return 0 + } +} + +func main() {} diff --git a/plugins/testdata/test-cache-plugin/manifest.json b/plugins/testdata/test-cache-plugin/manifest.json new file mode 100644 index 000000000..8c0d16a8b --- /dev/null +++ b/plugins/testdata/test-cache-plugin/manifest.json @@ -0,0 +1,11 @@ +{ + "name": "Test Cache Plugin", + "author": "Navidrome Test", + "version": "1.0.0", + "description": "A test cache plugin for integration testing", + "permissions": { + "cache": { + "reason": "For testing cache operations" + } + } +} diff --git a/plugins/testdata/test-config/go.mod b/plugins/testdata/test-config/go.mod new file mode 100644 index 000000000..7fa19b41e --- /dev/null +++ b/plugins/testdata/test-config/go.mod @@ -0,0 +1,16 @@ +module test-config + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/testdata/test-config/go.sum b/plugins/testdata/test-config/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/testdata/test-config/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/testdata/test-config/main.go b/plugins/testdata/test-config/main.go new file mode 100644 index 000000000..1d058db11 --- /dev/null +++ b/plugins/testdata/test-config/main.go @@ -0,0 +1,60 @@ +// Test Config plugin for Navidrome plugin system integration tests. +// Build with: tinygo build -o ../test-config.wasm -target wasip1 -buildmode=c-shared . +package main + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/host" + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// TestConfigInput is the input for nd_test_config callback. +type TestConfigInput struct { + Operation string `json:"operation"` // "get", "get_int", "list" + Key string `json:"key"` // For get/get_int operations + Prefix string `json:"prefix"` // For list operation +} + +// TestConfigOutput is the output from nd_test_config callback. +type TestConfigOutput struct { + StringVal string `json:"string_val,omitempty"` + IntVal int64 `json:"int_val,omitempty"` + Keys []string `json:"keys,omitempty"` + Exists bool `json:"exists,omitempty"` + Error *string `json:"error,omitempty"` +} + +// nd_test_config is the test callback that tests the config host functions. +// +//go:wasmexport nd_test_config +func ndTestConfig() int32 { + var input TestConfigInput + if err := pdk.InputJSON(&input); err != nil { + errStr := err.Error() + pdk.OutputJSON(TestConfigOutput{Error: &errStr}) + return 0 + } + + switch input.Operation { + case "get": + value, exists := host.ConfigGet(input.Key) + pdk.OutputJSON(TestConfigOutput{StringVal: value, Exists: exists}) + return 0 + + case "get_int": + value, exists := host.ConfigGetInt(input.Key) + pdk.OutputJSON(TestConfigOutput{IntVal: value, Exists: exists}) + return 0 + + case "list": + keys := host.ConfigKeys(input.Prefix) + pdk.OutputJSON(TestConfigOutput{Keys: keys}) + return 0 + + default: + errStr := "unknown operation: " + input.Operation + pdk.OutputJSON(TestConfigOutput{Error: &errStr}) + return 0 + } +} + +func main() {} diff --git a/plugins/testdata/test-config/manifest.json b/plugins/testdata/test-config/manifest.json new file mode 100644 index 000000000..b5ed5dd86 --- /dev/null +++ b/plugins/testdata/test-config/manifest.json @@ -0,0 +1,61 @@ +{ + "name": "Test Config Plugin", + "author": "Navidrome Test", + "version": "1.0.0", + "description": "A test plugin for config service integration testing", + "config": { + "schema": { + "type": "object", + "properties": { + "api_key": { + "type": "string", + "title": "API Key", + "minLength": 1 + }, + "max_retries": { + "type": "string", + "title": "Max Retries" + }, + "timeout": { + "type": "string", + "title": "Timeout" + }, + "users": { + "type": "array", + "title": "Users", + "items": { + "type": "object", + "properties": { + "username": { + "type": "string", + "title": "Username", + "minLength": 1 + }, + "token": { + "type": "string", + "title": "Token", + "minLength": 1 + } + }, + "required": ["username", "token"] + } + }, + "settings": { + "type": "object", + "title": "Settings", + "properties": { + "enabled": { + "type": "boolean", + "title": "Enabled" + }, + "count": { + "type": "integer", + "title": "Count" + } + } + } + }, + "required": ["api_key"] + } + } +} diff --git a/plugins/testdata/test-kvstore/go.mod b/plugins/testdata/test-kvstore/go.mod new file mode 100644 index 000000000..19fa0a47c --- /dev/null +++ b/plugins/testdata/test-kvstore/go.mod @@ -0,0 +1,16 @@ +module test-kvstore + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/testdata/test-kvstore/go.sum b/plugins/testdata/test-kvstore/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/testdata/test-kvstore/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/testdata/test-kvstore/main.go b/plugins/testdata/test-kvstore/main.go new file mode 100644 index 000000000..7fba14abe --- /dev/null +++ b/plugins/testdata/test-kvstore/main.go @@ -0,0 +1,140 @@ +// Test KVStore plugin for Navidrome plugin system integration tests. +// Build with: tinygo build -o ../test-kvstore.wasm -target wasip1 -buildmode=c-shared . +package main + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/host" + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// TestKVStoreInput is the input for nd_test_kvstore callback. +type TestKVStoreInput struct { + Operation string `json:"operation"` // "set", "get", "delete", "has", "list", "get_storage_used", "set_with_ttl", "delete_by_prefix", "get_many" + Key string `json:"key"` // Storage key + Value []byte `json:"value"` // For set operations + Prefix string `json:"prefix"` // For list/delete_by_prefix operations + TTLSeconds int64 `json:"ttl_seconds,omitempty"` // For set_with_ttl + Keys []string `json:"keys,omitempty"` // For get_many +} + +// TestKVStoreOutput is the output from nd_test_kvstore callback. +type TestKVStoreOutput struct { + Value []byte `json:"value,omitempty"` + Values map[string][]byte `json:"values,omitempty"` + Exists bool `json:"exists,omitempty"` + Keys []string `json:"keys,omitempty"` + StorageUsed int64 `json:"storage_used,omitempty"` + DeletedCount int64 `json:"deleted_count,omitempty"` + Error *string `json:"error,omitempty"` +} + +// nd_test_kvstore is the test callback that tests the kvstore host functions. +// +//go:wasmexport nd_test_kvstore +func ndTestKVStore() int32 { + var input TestKVStoreInput + if err := pdk.InputJSON(&input); err != nil { + errStr := err.Error() + pdk.OutputJSON(TestKVStoreOutput{Error: &errStr}) + return 0 + } + + switch input.Operation { + case "set": + err := host.KVStoreSet(input.Key, input.Value) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestKVStoreOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestKVStoreOutput{}) + return 0 + + case "get": + value, exists, err := host.KVStoreGet(input.Key) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestKVStoreOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestKVStoreOutput{Value: value, Exists: exists}) + return 0 + + case "delete": + err := host.KVStoreDelete(input.Key) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestKVStoreOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestKVStoreOutput{}) + return 0 + + case "has": + exists, err := host.KVStoreHas(input.Key) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestKVStoreOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestKVStoreOutput{Exists: exists}) + return 0 + + case "list": + keys, err := host.KVStoreList(input.Prefix) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestKVStoreOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestKVStoreOutput{Keys: keys}) + return 0 + + case "get_storage_used": + bytesUsed, err := host.KVStoreGetStorageUsed() + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestKVStoreOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestKVStoreOutput{StorageUsed: bytesUsed}) + return 0 + + case "set_with_ttl": + err := host.KVStoreSetWithTTL(input.Key, input.Value, input.TTLSeconds) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestKVStoreOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestKVStoreOutput{}) + return 0 + + case "delete_by_prefix": + deletedCount, err := host.KVStoreDeleteByPrefix(input.Prefix) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestKVStoreOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestKVStoreOutput{DeletedCount: deletedCount}) + return 0 + + case "get_many": + values, err := host.KVStoreGetMany(input.Keys) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestKVStoreOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestKVStoreOutput{Values: values}) + return 0 + + default: + errStr := "unknown operation: " + input.Operation + pdk.OutputJSON(TestKVStoreOutput{Error: &errStr}) + return 0 + } +} + +func main() {} diff --git a/plugins/testdata/test-kvstore/manifest.json b/plugins/testdata/test-kvstore/manifest.json new file mode 100644 index 000000000..d2a411d93 --- /dev/null +++ b/plugins/testdata/test-kvstore/manifest.json @@ -0,0 +1,12 @@ +{ + "name": "Test KVStore Plugin", + "author": "Navidrome Test", + "version": "1.0.0", + "description": "A test kvstore plugin for integration testing", + "permissions": { + "kvstore": { + "reason": "For testing kvstore operations", + "maxSize": "10KB" + } + } +} diff --git a/plugins/testdata/test-library/go.mod b/plugins/testdata/test-library/go.mod new file mode 100644 index 000000000..d3efcf2fd --- /dev/null +++ b/plugins/testdata/test-library/go.mod @@ -0,0 +1,16 @@ +module test-library + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/testdata/test-library/go.sum b/plugins/testdata/test-library/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/testdata/test-library/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/testdata/test-library/main.go b/plugins/testdata/test-library/main.go new file mode 100644 index 000000000..9c04c5f9b --- /dev/null +++ b/plugins/testdata/test-library/main.go @@ -0,0 +1,98 @@ +// Test Library plugin for Navidrome plugin system integration tests. +// This plugin tests library metadata access WITH filesystem permission, +// allowing tests for both metadata and filesystem access. +// Build with: tinygo build -o ../test-library.wasm -target wasip1 -buildmode=c-shared . +package main + +import ( + "os" + "path/filepath" + + "github.com/navidrome/navidrome/plugins/pdk/go/host" + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// TestLibraryInput is the input for nd_test_library callback. +type TestLibraryInput struct { + Operation string `json:"operation"` // "get_library", "get_all_libraries", "read_file", "list_dir" + LibraryID int32 `json:"library_id,omitempty"` + MountPoint string `json:"mount_point,omitempty"` // For filesystem operations + FilePath string `json:"file_path,omitempty"` // For read_file operation (relative to mount point) +} + +// TestLibraryOutput is the output from nd_test_library callback. +type TestLibraryOutput struct { + Library *host.Library `json:"library,omitempty"` + Libraries []host.Library `json:"libraries,omitempty"` + FileContent string `json:"file_content,omitempty"` + DirEntries []string `json:"dir_entries,omitempty"` + Error *string `json:"error,omitempty"` +} + +// nd_test_library is the test callback that tests the library host functions. +// +//go:wasmexport nd_test_library +func ndTestLibrary() int32 { + var input TestLibraryInput + if err := pdk.InputJSON(&input); err != nil { + errStr := err.Error() + pdk.OutputJSON(TestLibraryOutput{Error: &errStr}) + return 0 + } + + switch input.Operation { + case "get_library": + library, err := host.LibraryGetLibrary(input.LibraryID) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestLibraryOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestLibraryOutput{Library: library}) + return 0 + + case "get_all_libraries": + libraries, err := host.LibraryGetAllLibraries() + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestLibraryOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestLibraryOutput{Libraries: libraries}) + return 0 + + case "read_file": + // Read a file from the mounted library directory + fullPath := filepath.Join(input.MountPoint, input.FilePath) + content, err := os.ReadFile(fullPath) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestLibraryOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestLibraryOutput{FileContent: string(content)}) + return 0 + + case "list_dir": + // List files in the mounted library directory + entries, err := os.ReadDir(input.MountPoint) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestLibraryOutput{Error: &errStr}) + return 0 + } + var names []string + for _, entry := range entries { + names = append(names, entry.Name()) + } + pdk.OutputJSON(TestLibraryOutput{DirEntries: names}) + return 0 + + default: + errStr := "unknown operation: " + input.Operation + pdk.OutputJSON(TestLibraryOutput{Error: &errStr}) + return 0 + } +} + +func main() {} diff --git a/plugins/testdata/test-library/manifest.json b/plugins/testdata/test-library/manifest.json new file mode 100644 index 000000000..b06b3bbec --- /dev/null +++ b/plugins/testdata/test-library/manifest.json @@ -0,0 +1,12 @@ +{ + "name": "Test Library Plugin", + "author": "Navidrome Test", + "version": "1.0.0", + "description": "A test library plugin for integration testing", + "permissions": { + "library": { + "reason": "For testing library metadata and filesystem access", + "filesystem": true + } + } +} diff --git a/plugins/testdata/test-lyrics/go.mod b/plugins/testdata/test-lyrics/go.mod new file mode 100644 index 000000000..fbbb23fc0 --- /dev/null +++ b/plugins/testdata/test-lyrics/go.mod @@ -0,0 +1,16 @@ +module test-lyrics + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/testdata/test-lyrics/go.sum b/plugins/testdata/test-lyrics/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/testdata/test-lyrics/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/testdata/test-lyrics/main.go b/plugins/testdata/test-lyrics/main.go new file mode 100644 index 000000000..0e485ceba --- /dev/null +++ b/plugins/testdata/test-lyrics/main.go @@ -0,0 +1,42 @@ +// Test lyrics plugin for Navidrome plugin system integration tests. +package main + +import ( + "fmt" + + "github.com/navidrome/navidrome/plugins/pdk/go/lyrics" + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +func init() { + lyrics.Register(&testLyrics{}) +} + +type testLyrics struct{} + +func (t *testLyrics) GetLyrics(input lyrics.GetLyricsRequest) (lyrics.GetLyricsResponse, error) { + // Check for configured error + errMsg, hasErr := pdk.GetConfig("error") + if hasErr && errMsg != "" { + return lyrics.GetLyricsResponse{}, fmt.Errorf("%s", errMsg) + } + + // Check if we should omit language (to test default language handling) + noLang, hasNoLang := pdk.GetConfig("no_lang") + lang := "eng" + if hasNoLang && noLang == "true" { + lang = "" + } + + // Return test lyrics based on track info + return lyrics.GetLyricsResponse{ + Lyrics: []lyrics.LyricsText{ + { + Lang: lang, + Text: "Test lyrics for " + input.Track.Title + "\nBy " + input.Track.Artist, + }, + }, + }, nil +} + +func main() {} diff --git a/plugins/testdata/test-lyrics/manifest.json b/plugins/testdata/test-lyrics/manifest.json new file mode 100644 index 000000000..a61299e92 --- /dev/null +++ b/plugins/testdata/test-lyrics/manifest.json @@ -0,0 +1,6 @@ +{ + "name": "Test Lyrics", + "author": "Navidrome Test", + "version": "1.0.0", + "description": "A test lyrics plugin for integration testing" +} diff --git a/plugins/testdata/test-metadata-agent/go.mod b/plugins/testdata/test-metadata-agent/go.mod new file mode 100644 index 000000000..02aff736c --- /dev/null +++ b/plugins/testdata/test-metadata-agent/go.mod @@ -0,0 +1,16 @@ +module test-metadata-agent + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/testdata/test-metadata-agent/go.sum b/plugins/testdata/test-metadata-agent/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/testdata/test-metadata-agent/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/testdata/test-metadata-agent/main.go b/plugins/testdata/test-metadata-agent/main.go new file mode 100644 index 000000000..23e933eb3 --- /dev/null +++ b/plugins/testdata/test-metadata-agent/main.go @@ -0,0 +1,184 @@ +// Test plugin for Navidrome plugin system integration tests. +// Build with: tinygo build -o ../test-metadata-agent.wasm -target wasip1 -buildmode=c-shared . +package main + +import ( + "errors" + "strconv" + + "github.com/navidrome/navidrome/plugins/pdk/go/metadata" + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +func init() { + metadata.Register(&testMetadataAgent{}) +} + +type testMetadataAgent struct{} + +// checkConfigError checks if the plugin is configured to return an error. +// If "error" config is set, it returns an error with that message. +func checkConfigError() error { + errMsg, hasErr := pdk.GetConfig("error") + if !hasErr || errMsg == "" { + return nil + } + return errors.New(errMsg) +} + +func (t *testMetadataAgent) GetArtistMBID(input metadata.ArtistMBIDRequest) (*metadata.ArtistMBIDResponse, error) { + if err := checkConfigError(); err != nil { + return nil, err + } + return &metadata.ArtistMBIDResponse{MBID: "test-mbid-" + input.Name}, nil +} + +func (t *testMetadataAgent) GetArtistURL(input metadata.ArtistRequest) (*metadata.ArtistURLResponse, error) { + if err := checkConfigError(); err != nil { + return nil, err + } + return &metadata.ArtistURLResponse{URL: "https://test.example.com/artist/" + input.Name}, nil +} + +func (t *testMetadataAgent) GetArtistBiography(input metadata.ArtistRequest) (*metadata.ArtistBiographyResponse, error) { + if err := checkConfigError(); err != nil { + return nil, err + } + return &metadata.ArtistBiographyResponse{Biography: "Biography for " + input.Name}, nil +} + +func (t *testMetadataAgent) GetArtistImages(input metadata.ArtistRequest) (*metadata.ArtistImagesResponse, error) { + if err := checkConfigError(); err != nil { + return nil, err + } + return &metadata.ArtistImagesResponse{ + Images: []metadata.ImageInfo{ + {URL: "https://test.example.com/images/" + input.Name + "/large.jpg", Size: 500}, + {URL: "https://test.example.com/images/" + input.Name + "/small.jpg", Size: 100}, + }, + }, nil +} + +func (t *testMetadataAgent) GetSimilarArtists(input metadata.SimilarArtistsRequest) (*metadata.SimilarArtistsResponse, error) { + if err := checkConfigError(); err != nil { + return nil, err + } + limit := int(input.Limit) + if limit == 0 { + limit = 5 + } + artists := make([]metadata.ArtistRef, 0, limit) + for i := range limit { + artists = append(artists, metadata.ArtistRef{ + ID: "similar-artist-id-" + strconv.Itoa(i+1), + Name: input.Name + " Similar " + string(rune('A'+i)), + MBID: "similar-mbid-" + strconv.Itoa(i+1), + }) + } + return &metadata.SimilarArtistsResponse{Artists: artists}, nil +} + +func (t *testMetadataAgent) GetArtistTopSongs(input metadata.TopSongsRequest) (*metadata.TopSongsResponse, error) { + if err := checkConfigError(); err != nil { + return nil, err + } + count := int(input.Count) + if count == 0 { + count = 5 + } + songs := make([]metadata.SongRef, 0, count) + for i := range count { + songs = append(songs, metadata.SongRef{ + ID: "song-id-" + strconv.Itoa(i+1), + Name: input.Name + " Song " + strconv.Itoa(i+1), + MBID: "song-mbid-" + strconv.Itoa(i+1), + }) + } + return &metadata.TopSongsResponse{Songs: songs}, nil +} + +func (t *testMetadataAgent) GetAlbumInfo(input metadata.AlbumRequest) (*metadata.AlbumInfoResponse, error) { + if err := checkConfigError(); err != nil { + return nil, err + } + return &metadata.AlbumInfoResponse{ + Name: input.Name, + MBID: "test-album-mbid-" + input.Name, + Description: "Description for " + input.Name + " by " + input.Artist, + URL: "https://test.example.com/album/" + input.Name, + }, nil +} + +func (t *testMetadataAgent) GetAlbumImages(input metadata.AlbumRequest) (*metadata.AlbumImagesResponse, error) { + if err := checkConfigError(); err != nil { + return nil, err + } + return &metadata.AlbumImagesResponse{ + Images: []metadata.ImageInfo{ + {URL: "https://test.example.com/albums/" + input.Name + "/cover.jpg", Size: 500}, + }, + }, nil +} + +func (t *testMetadataAgent) GetSimilarSongsByTrack(input metadata.SimilarSongsByTrackRequest) (*metadata.SimilarSongsResponse, error) { + if err := checkConfigError(); err != nil { + return nil, err + } + count := int(input.Count) + if count == 0 { + count = 5 + } + songs := make([]metadata.SongRef, 0, count) + for i := range count { + songs = append(songs, metadata.SongRef{ + ID: "similar-track-id-" + strconv.Itoa(i+1), + Name: "Similar to " + input.Name + " #" + strconv.Itoa(i+1), + MBID: "similar-mbid-" + strconv.Itoa(i+1), + ISRC: "similar-isrc-" + strconv.Itoa(i+1), + Artist: input.Artist, + ArtistMBID: "artist-mbid-" + strconv.Itoa(i+1), + }) + } + return &metadata.SimilarSongsResponse{Songs: songs}, nil +} + +func (t *testMetadataAgent) GetSimilarSongsByAlbum(input metadata.SimilarSongsByAlbumRequest) (*metadata.SimilarSongsResponse, error) { + if err := checkConfigError(); err != nil { + return nil, err + } + count := int(input.Count) + if count == 0 { + count = 5 + } + songs := make([]metadata.SongRef, 0, count) + for i := range count { + songs = append(songs, metadata.SongRef{ + ID: "album-similar-id-" + strconv.Itoa(i+1), + Name: "Album Similar #" + strconv.Itoa(i+1), + Artist: input.Artist, + Album: input.Name, + }) + } + return &metadata.SimilarSongsResponse{Songs: songs}, nil +} + +func (t *testMetadataAgent) GetSimilarSongsByArtist(input metadata.SimilarSongsByArtistRequest) (*metadata.SimilarSongsResponse, error) { + if err := checkConfigError(); err != nil { + return nil, err + } + count := int(input.Count) + if count == 0 { + count = 5 + } + songs := make([]metadata.SongRef, 0, count) + for i := range count { + songs = append(songs, metadata.SongRef{ + ID: "artist-similar-id-" + strconv.Itoa(i+1), + Name: input.Name + " Style Song #" + strconv.Itoa(i+1), + Artist: input.Name + " Similar Artist", + }) + } + return &metadata.SimilarSongsResponse{Songs: songs}, nil +} + +func main() {} diff --git a/plugins/testdata/test-metadata-agent/manifest.json b/plugins/testdata/test-metadata-agent/manifest.json new file mode 100644 index 000000000..3a1838730 --- /dev/null +++ b/plugins/testdata/test-metadata-agent/manifest.json @@ -0,0 +1,15 @@ +{ + "name": "Test Plugin", + "author": "Navidrome Test", + "version": "1.0.0", + "description": "A test plugin for integration testing", + "capabilities": ["MetadataAgent"], + "permissions": { + "http": { + "reason": "Test HTTP access", + "allowedURLs": { + "https://test.example.com/*": ["GET"] + } + } + } +} diff --git a/plugins/testdata/test-scheduler/go.mod b/plugins/testdata/test-scheduler/go.mod new file mode 100644 index 000000000..337cc9650 --- /dev/null +++ b/plugins/testdata/test-scheduler/go.mod @@ -0,0 +1,16 @@ +module test-scheduler + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/testdata/test-scheduler/go.sum b/plugins/testdata/test-scheduler/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/testdata/test-scheduler/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/testdata/test-scheduler/main.go b/plugins/testdata/test-scheduler/main.go new file mode 100644 index 000000000..5276f9215 --- /dev/null +++ b/plugins/testdata/test-scheduler/main.go @@ -0,0 +1,40 @@ +// Test scheduler plugin for Navidrome plugin system integration tests. +// Build with: tinygo build -o ../test-scheduler.wasm -target wasip1 -buildmode=c-shared . +package main + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/host" + "github.com/navidrome/navidrome/plugins/pdk/go/scheduler" +) + +func init() { + scheduler.Register(&testScheduler{}) +} + +type testScheduler struct{} + +// OnCallback is called when a scheduled task fires. +// Magic payloads trigger specific behaviors to test host functions: +// - "schedule-followup": schedules a one-time task via host function +// - "schedule-recurring": schedules a recurring task via host function +// - "schedule-duplicate:<id>": attempts to schedule with the given ID (for testing duplicate detection) +func (t *testScheduler) OnCallback(input scheduler.SchedulerCallbackRequest) error { + switch { + case input.Payload == "schedule-followup": + if _, err := host.SchedulerScheduleOneTime(1, "followup-created", "followup-id"); err != nil { + return err + } + case input.Payload == "schedule-recurring": + if _, err := host.SchedulerScheduleRecurring("@every 1s", "recurring-created", "recurring-from-plugin"); err != nil { + return err + } + case len(input.Payload) > 19 && input.Payload[:19] == "schedule-duplicate:": + duplicateID := input.Payload[19:] + if _, err := host.SchedulerScheduleOneTime(60, "duplicate-attempt", duplicateID); err != nil { + return err + } + } + return nil +} + +func main() {} diff --git a/plugins/testdata/test-scheduler/manifest.json b/plugins/testdata/test-scheduler/manifest.json new file mode 100644 index 000000000..b001ff2ad --- /dev/null +++ b/plugins/testdata/test-scheduler/manifest.json @@ -0,0 +1,11 @@ +{ + "name": "Test Scheduler", + "author": "Navidrome Test", + "version": "1.0.0", + "description": "A test scheduler plugin for integration testing", + "permissions": { + "scheduler": { + "reason": "For testing scheduler callbacks" + } + } +} diff --git a/plugins/testdata/test-scrobbler/go.mod b/plugins/testdata/test-scrobbler/go.mod new file mode 100644 index 000000000..b9e2c3887 --- /dev/null +++ b/plugins/testdata/test-scrobbler/go.mod @@ -0,0 +1,16 @@ +module test-scrobbler + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/testdata/test-scrobbler/go.sum b/plugins/testdata/test-scrobbler/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/testdata/test-scrobbler/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/testdata/test-scrobbler/main.go b/plugins/testdata/test-scrobbler/main.go new file mode 100644 index 000000000..d9c142d51 --- /dev/null +++ b/plugins/testdata/test-scrobbler/main.go @@ -0,0 +1,90 @@ +// Test scrobbler plugin for Navidrome plugin system integration tests. +// Build with: tinygo build -o ../test-scrobbler.wasm -target wasip1 -buildmode=c-shared ./main.go +package main + +import ( + "fmt" + "strconv" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" + "github.com/navidrome/navidrome/plugins/pdk/go/scrobbler" +) + +func init() { + scrobbler.Register(&testScrobbler{}) +} + +type testScrobbler struct{} + +// IsAuthorized checks if a user is authorized. +func (t *testScrobbler) IsAuthorized(scrobbler.IsAuthorizedRequest) (bool, error) { + return checkAuthConfig(), nil +} + +// NowPlaying sends a now playing notification. +func (t *testScrobbler) NowPlaying(input scrobbler.NowPlayingRequest) error { + // Check for configured error + if err := checkConfigError(); err != nil { + return err + } + + // Log the now playing (for potential debugging) + artistName := "" + if len(input.Track.Artists) > 0 { + artistName = input.Track.Artists[0].Name + } + pdk.Log(pdk.LogInfo, "NowPlaying: "+input.Track.Title+" by "+artistName) + return nil +} + +// Scrobble submits a scrobble. +func (t *testScrobbler) Scrobble(input scrobbler.ScrobbleRequest) error { + // Check for configured error + if err := checkConfigError(); err != nil { + return err + } + + // Log the scrobble (for potential debugging) + artistName := "" + if len(input.Track.Artists) > 0 { + artistName = input.Track.Artists[0].Name + } + pdk.Log(pdk.LogInfo, "Scrobble: "+input.Track.Title+" by "+artistName) + return nil +} + +// checkConfigError checks if the plugin is configured to return an error. +// If "error" config is set, it returns the appropriate ScrobblerError. +// Error types: "not_authorized", "retry_later", "unrecoverable" +func checkConfigError() error { + errMsg, hasErr := pdk.GetConfig("error") + if !hasErr || errMsg == "" { + return nil + } + errType, _ := pdk.GetConfig("error_type") + switch errType { + case scrobbler.ScrobblerErrorNotAuthorized.Error(): + return fmt.Errorf("%w: %s", scrobbler.ScrobblerErrorNotAuthorized, errMsg) + case scrobbler.ScrobblerErrorRetryLater.Error(): + return fmt.Errorf("%w: %s", scrobbler.ScrobblerErrorRetryLater, errMsg) + default: + return fmt.Errorf("%w: %s", scrobbler.ScrobblerErrorUnrecoverable, errMsg) + } +} + +// checkAuthConfig returns whether the plugin is configured to authorize users. +// If "authorized" config is set to "false", users are not authorized. +// Default is true (authorized). +func checkAuthConfig() bool { + authStr, hasAuth := pdk.GetConfig("authorized") + if !hasAuth { + return true // Default: authorized + } + auth, err := strconv.ParseBool(authStr) + if err != nil { + return true // Default on parse error + } + return auth +} + +func main() {} diff --git a/plugins/testdata/test-scrobbler/manifest.json b/plugins/testdata/test-scrobbler/manifest.json new file mode 100644 index 000000000..6a6ec48ed --- /dev/null +++ b/plugins/testdata/test-scrobbler/manifest.json @@ -0,0 +1,11 @@ +{ + "name": "Test Scrobbler", + "author": "Navidrome Test", + "version": "1.0.0", + "description": "A test scrobbler plugin for integration testing", + "permissions": { + "users": { + "reason": "Receive scrobble events for users assigned to this plugin" + } + } +} diff --git a/plugins/testdata/test-subsonicapi-plugin/go.mod b/plugins/testdata/test-subsonicapi-plugin/go.mod new file mode 100644 index 000000000..1fb943418 --- /dev/null +++ b/plugins/testdata/test-subsonicapi-plugin/go.mod @@ -0,0 +1,16 @@ +module test-subsonicapi-plugin + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/testdata/test-subsonicapi-plugin/go.sum b/plugins/testdata/test-subsonicapi-plugin/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/testdata/test-subsonicapi-plugin/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/testdata/test-subsonicapi-plugin/main.go b/plugins/testdata/test-subsonicapi-plugin/main.go new file mode 100644 index 000000000..573036b95 --- /dev/null +++ b/plugins/testdata/test-subsonicapi-plugin/main.go @@ -0,0 +1,57 @@ +// Test plugin for SubsonicAPI host function integration tests. +// Build with: tinygo build -o ../test-subsonicapi-plugin.wasm -target wasip1 -buildmode=c-shared ./main.go +package main + +import ( + "fmt" + + "github.com/navidrome/navidrome/plugins/pdk/go/host" + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// call_subsonic_api is the exported function that tests the SubsonicAPI host function. +// Input: URI string (e.g., "/ping?u=testuser") +// Output: The raw JSON response from the Subsonic API +// +//go:wasmexport call_subsonic_api +func callSubsonicAPIExport() int32 { + // Get the URI from input + uri := pdk.InputString() + + // Call the Subsonic API via host function + responseJSON, err := host.SubsonicAPICall(uri) + if err != nil { + pdk.SetErrorString("failed to call SubsonicAPI: " + err.Error()) + return 1 + } + + // Return the response + pdk.OutputString(responseJSON) + return 0 +} + +// call_subsonic_api_raw is the exported function that tests the SubsonicAPI CallRaw host function. +// Input: URI string (e.g., "/getCoverArt?u=testuser&id=al-1") +// Output: JSON with contentType, size, and first bytes of the raw response +// +//go:wasmexport call_subsonic_api_raw +func callSubsonicAPIRawExport() int32 { + uri := pdk.InputString() + + contentType, data, err := host.SubsonicAPICallRaw(uri) + if err != nil { + pdk.SetErrorString("failed to call SubsonicAPI raw: " + err.Error()) + return 1 + } + + // Return metadata about the raw response as JSON + firstByte := 0 + if len(data) > 0 { + firstByte = int(data[0]) + } + result := fmt.Sprintf(`{"contentType":%q,"size":%d,"firstByte":%d}`, contentType, len(data), firstByte) + pdk.OutputString(result) + return 0 +} + +func main() {} diff --git a/plugins/testdata/test-subsonicapi-plugin/manifest.json b/plugins/testdata/test-subsonicapi-plugin/manifest.json new file mode 100644 index 000000000..027e17761 --- /dev/null +++ b/plugins/testdata/test-subsonicapi-plugin/manifest.json @@ -0,0 +1,14 @@ +{ + "name": "Test SubsonicAPI Plugin", + "author": "Navidrome Test", + "version": "1.0.0", + "description": "Test plugin for SubsonicAPI host function", + "permissions": { + "subsonicapi": { + "reason": "Testing SubsonicAPI access" + }, + "users": { + "reason": "Access user information for SubsonicAPI authorization" + } + } +} diff --git a/plugins/testdata/test-taskqueue/go.mod b/plugins/testdata/test-taskqueue/go.mod new file mode 100644 index 000000000..37f857e5a --- /dev/null +++ b/plugins/testdata/test-taskqueue/go.mod @@ -0,0 +1,16 @@ +module test-taskqueue + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/testdata/test-taskqueue/go.sum b/plugins/testdata/test-taskqueue/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/testdata/test-taskqueue/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/testdata/test-taskqueue/main.go b/plugins/testdata/test-taskqueue/main.go new file mode 100644 index 000000000..9b734ed67 --- /dev/null +++ b/plugins/testdata/test-taskqueue/main.go @@ -0,0 +1,114 @@ +// Test TaskQueue plugin for Navidrome plugin system integration tests. +// Build with: tinygo build -o ../test-taskqueue.wasm -target wasip1 -buildmode=c-shared . +package main + +import ( + "fmt" + + "github.com/navidrome/navidrome/plugins/pdk/go/host" + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" + "github.com/navidrome/navidrome/plugins/pdk/go/taskworker" +) + +func init() { + taskworker.Register(&handler{}) +} + +type handler struct{} + +func (h *handler) OnTaskExecute(req taskworker.TaskExecuteRequest) (string, error) { + payload := string(req.Payload) + if payload == "fail" { + return "", fmt.Errorf("task failed as instructed") + } + if payload == "fail-then-succeed" && req.Attempt < 2 { + return "", fmt.Errorf("transient failure") + } + return "completed successfully", nil +} + +// Test helper types +type TestInput struct { + Operation string `json:"operation"` + QueueName string `json:"queueName,omitempty"` + Config *host.QueueConfig `json:"config,omitempty"` + Payload []byte `json:"payload,omitempty"` + TaskID string `json:"taskId,omitempty"` +} + +type TestOutput struct { + TaskID string `json:"taskId,omitempty"` + Status string `json:"status,omitempty"` + Message string `json:"message,omitempty"` + Attempt int32 `json:"attempt,omitempty"` + Cleared int64 `json:"cleared,omitempty"` + Error *string `json:"error,omitempty"` +} + +//go:wasmexport nd_test_taskqueue +func ndTestTaskQueue() int32 { + var input TestInput + if err := pdk.InputJSON(&input); err != nil { + errStr := err.Error() + pdk.OutputJSON(TestOutput{Error: &errStr}) + return 0 + } + + switch input.Operation { + case "create_queue": + config := host.QueueConfig{} + if input.Config != nil { + config = *input.Config + } + err := host.TaskCreateQueue(input.QueueName, config) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestOutput{}) + + case "enqueue": + taskID, err := host.TaskEnqueue(input.QueueName, input.Payload) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestOutput{TaskID: taskID}) + + case "get_task_status": + info, err := host.TaskGet(input.TaskID) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestOutput{Status: info.Status, Message: info.Message, Attempt: info.Attempt}) + + case "cancel_task": + err := host.TaskCancel(input.TaskID) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestOutput{}) + + case "clear_queue": + cleared, err := host.TaskClearQueue(input.QueueName) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestOutput{Cleared: cleared}) + + default: + errStr := "unknown operation: " + input.Operation + pdk.OutputJSON(TestOutput{Error: &errStr}) + } + return 0 +} + +func main() {} diff --git a/plugins/testdata/test-taskqueue/manifest.json b/plugins/testdata/test-taskqueue/manifest.json new file mode 100644 index 000000000..3cd3b0f0b --- /dev/null +++ b/plugins/testdata/test-taskqueue/manifest.json @@ -0,0 +1,12 @@ +{ + "name": "Test TaskQueue Plugin", + "author": "Navidrome Test", + "version": "1.0.0", + "description": "A test plugin for TaskQueue integration testing", + "permissions": { + "taskqueue": { + "reason": "For testing task queue operations", + "maxConcurrency": 10 + } + } +} diff --git a/plugins/testdata/test-users/go.mod b/plugins/testdata/test-users/go.mod new file mode 100644 index 000000000..973f29c9c --- /dev/null +++ b/plugins/testdata/test-users/go.mod @@ -0,0 +1,16 @@ +module test-users + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/testdata/test-users/go.sum b/plugins/testdata/test-users/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/testdata/test-users/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/testdata/test-users/main.go b/plugins/testdata/test-users/main.go new file mode 100644 index 000000000..08d07b360 --- /dev/null +++ b/plugins/testdata/test-users/main.go @@ -0,0 +1,61 @@ +// Test Users plugin for Navidrome plugin system integration tests. +// This plugin tests user metadata access via the Users host service. +// Build with: tinygo build -o ../test-users.wasm -target wasip1 -buildmode=c-shared . +package main + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/host" + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// TestUsersInput is the input for nd_test_users callback. +type TestUsersInput struct { + Operation string `json:"operation"` // "get_users", "get_admins" +} + +// TestUsersOutput is the output from nd_test_users callback. +type TestUsersOutput struct { + Users []host.User `json:"users,omitempty"` + Error *string `json:"error,omitempty"` +} + +// nd_test_users is the test callback that tests the users host functions. +// +//go:wasmexport nd_test_users +func ndTestUsers() int32 { + var input TestUsersInput + if err := pdk.InputJSON(&input); err != nil { + errStr := err.Error() + pdk.OutputJSON(TestUsersOutput{Error: &errStr}) + return 0 + } + + switch input.Operation { + case "get_users": + users, err := host.UsersGetUsers() + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestUsersOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestUsersOutput{Users: users}) + return 0 + + case "get_admins": + admins, err := host.UsersGetAdmins() + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestUsersOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestUsersOutput{Users: admins}) + return 0 + + default: + errStr := "unknown operation: " + input.Operation + pdk.OutputJSON(TestUsersOutput{Error: &errStr}) + return 0 + } +} + +func main() {} diff --git a/plugins/testdata/test-users/manifest.json b/plugins/testdata/test-users/manifest.json new file mode 100644 index 000000000..787260785 --- /dev/null +++ b/plugins/testdata/test-users/manifest.json @@ -0,0 +1,11 @@ +{ + "name": "Test Users Plugin", + "author": "Navidrome Test", + "version": "1.0.0", + "description": "A test users plugin for integration testing", + "permissions": { + "users": { + "reason": "For testing user metadata access" + } + } +} diff --git a/plugins/testdata/test-websocket/go.mod b/plugins/testdata/test-websocket/go.mod new file mode 100644 index 000000000..f786b8658 --- /dev/null +++ b/plugins/testdata/test-websocket/go.mod @@ -0,0 +1,16 @@ +module test-websocket + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/testdata/test-websocket/go.sum b/plugins/testdata/test-websocket/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/testdata/test-websocket/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/testdata/test-websocket/main.go b/plugins/testdata/test-websocket/main.go new file mode 100644 index 000000000..270f36a11 --- /dev/null +++ b/plugins/testdata/test-websocket/main.go @@ -0,0 +1,80 @@ +// Test WebSocket plugin for Navidrome plugin system integration tests. +// Build with: tinygo build -o ../test-websocket.wasm -target wasip1 -buildmode=c-shared . +package main + +import ( + "encoding/base64" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/host" + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" + "github.com/navidrome/navidrome/plugins/pdk/go/websocket" +) + +func init() { + websocket.Register(&testWebSocket{}) +} + +type testWebSocket struct{} + +// OnTextMessage is called when a text message is received. +// Magic messages trigger specific behaviors to test host functions: +// - "echo": sends back the same message using SendText host function +// - "close": closes the connection using CloseConnection host function +// - "store:MESSAGE": stores MESSAGE in plugin config for later retrieval +// - "fail": returns an error to test error handling +func (t *testWebSocket) OnTextMessage(input websocket.OnTextMessageRequest) error { + // Store all received messages for test verification + storeReceivedMessage("text:" + input.Message) + + switch input.Message { + case "echo": + if err := host.WebSocketSendText(input.ConnectionID, "echo:"+input.Message); err != nil { + return err + } + + case "close": + if err := host.WebSocketCloseConnection(input.ConnectionID, 1000, "closed by plugin"); err != nil { + return err + } + + case "fail": + return errors.New("intentional test failure") + } + + return nil +} + +// OnBinaryMessage is called when a binary message is received. +// Echoes the data back as a binary message so tests can observe the callback fired. +func (t *testWebSocket) OnBinaryMessage(input websocket.OnBinaryMessageRequest) error { + encoded := base64.StdEncoding.EncodeToString(input.Data) + storeReceivedMessage("binary:" + encoded) + return host.WebSocketSendBinary(input.ConnectionID, input.Data) +} + +// OnError is called when an error occurs on a WebSocket connection. +func (t *testWebSocket) OnError(input websocket.OnErrorRequest) error { + // Store error for test verification + storeReceivedMessage("error:" + input.Error) + return nil +} + +// OnClose is called when a WebSocket connection is closed. +func (t *testWebSocket) OnClose(input websocket.OnCloseRequest) error { + // Store close event for test verification + storeReceivedMessage("close:" + input.Reason) + return nil +} + +// storeReceivedMessage stores messages in plugin variable storage for test verification. +// Messages are appended to an existing list. +func storeReceivedMessage(msg string) { + // Use Extism var storage for plugin state + if existingVar := pdk.GetVar("_received_messages"); existingVar != nil { + msg = string(existingVar) + "\n" + msg + } + pdk.SetVar("_received_messages", []byte(msg)) +} + +func main() {} diff --git a/plugins/testdata/test-websocket/manifest.json b/plugins/testdata/test-websocket/manifest.json new file mode 100644 index 000000000..0ac756470 --- /dev/null +++ b/plugins/testdata/test-websocket/manifest.json @@ -0,0 +1,12 @@ +{ + "name": "Test WebSocket", + "author": "Navidrome Test", + "version": "1.0.0", + "description": "A test WebSocket plugin for integration testing", + "permissions": { + "websocket": { + "reason": "For testing WebSocket callbacks", + "requiredHosts": ["*.example.com", "localhost:*", "echo.websocket.org"] + } + } +} diff --git a/plugins/testdata/unauthorized_plugin/manifest.json b/plugins/testdata/unauthorized_plugin/manifest.json deleted file mode 100644 index 38a00e0ea..000000000 --- a/plugins/testdata/unauthorized_plugin/manifest.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "name": "unauthorized_plugin", - "author": "Navidrome Test", - "version": "1.0.0", - "description": "Test plugin that tries to access unauthorized services", - "website": "https://test.navidrome.org/unauthorized-plugin", - "capabilities": ["MetadataAgent"], - "permissions": {} -} diff --git a/plugins/testdata/unauthorized_plugin/plugin.go b/plugins/testdata/unauthorized_plugin/plugin.go deleted file mode 100644 index 07c3e0f6b..000000000 --- a/plugins/testdata/unauthorized_plugin/plugin.go +++ /dev/null @@ -1,78 +0,0 @@ -//go:build wasip1 - -package main - -import ( - "context" - - "github.com/navidrome/navidrome/plugins/api" - "github.com/navidrome/navidrome/plugins/host/http" -) - -type UnauthorizedPlugin struct{} - -var ErrNotFound = api.ErrNotFound - -func (UnauthorizedPlugin) GetAlbumInfo(ctx context.Context, req *api.AlbumInfoRequest) (*api.AlbumInfoResponse, error) { - // This plugin attempts to make an HTTP call without having HTTP permission - // This should fail since the plugin has no permissions in its manifest - httpClient := http.NewHttpService() - - request := &http.HttpRequest{ - Url: "https://example.com/test", - Headers: map[string]string{ - "Accept": "application/json", - }, - TimeoutMs: 5000, - } - - _, err := httpClient.Get(ctx, request) - if err != nil { - // Expected to fail due to missing permission - return nil, err - } - - return &api.AlbumInfoResponse{ - Info: &api.AlbumInfo{ - Name: req.Name, - Mbid: "unauthorized-test", - Description: "This should not work", - Url: "https://example.com/unauthorized", - }, - }, nil -} - -func (UnauthorizedPlugin) GetAlbumImages(ctx context.Context, req *api.AlbumImagesRequest) (*api.AlbumImagesResponse, error) { - return nil, api.ErrNotImplemented -} - -func (UnauthorizedPlugin) GetArtistMBID(ctx context.Context, req *api.ArtistMBIDRequest) (*api.ArtistMBIDResponse, error) { - return nil, api.ErrNotImplemented -} - -func (UnauthorizedPlugin) GetArtistURL(ctx context.Context, req *api.ArtistURLRequest) (*api.ArtistURLResponse, error) { - return nil, api.ErrNotImplemented -} - -func (UnauthorizedPlugin) GetArtistBiography(ctx context.Context, req *api.ArtistBiographyRequest) (*api.ArtistBiographyResponse, error) { - return nil, api.ErrNotImplemented -} - -func (UnauthorizedPlugin) GetSimilarArtists(ctx context.Context, req *api.ArtistSimilarRequest) (*api.ArtistSimilarResponse, error) { - return nil, api.ErrNotImplemented -} - -func (UnauthorizedPlugin) GetArtistImages(ctx context.Context, req *api.ArtistImageRequest) (*api.ArtistImageResponse, error) { - return nil, api.ErrNotImplemented -} - -func (UnauthorizedPlugin) GetArtistTopSongs(ctx context.Context, req *api.ArtistTopSongsRequest) (*api.ArtistTopSongsResponse, error) { - return nil, api.ErrNotImplemented -} - -func main() {} - -// Register the plugin implementation -func init() { - api.RegisterMetadataAgent(UnauthorizedPlugin{}) -} diff --git a/plugins/wasm_instance_pool.go b/plugins/wasm_instance_pool.go deleted file mode 100644 index 5ea1a82a6..000000000 --- a/plugins/wasm_instance_pool.go +++ /dev/null @@ -1,223 +0,0 @@ -package plugins - -import ( - "context" - "fmt" - "sync" - "time" - - "github.com/navidrome/navidrome/log" -) - -// wasmInstancePool is a generic pool using channels for simplicity and Go idioms -type wasmInstancePool[T any] struct { - name string - new func(ctx context.Context) (T, error) - poolSize int - getTimeout time.Duration - ttl time.Duration - - mu sync.RWMutex - instances chan poolItem[T] - semaphore chan struct{} - closing chan struct{} - closed bool -} - -type poolItem[T any] struct { - value T - created time.Time -} - -func newWasmInstancePool[T any](name string, poolSize int, maxConcurrentInstances int, getTimeout time.Duration, ttl time.Duration, newFn func(ctx context.Context) (T, error)) *wasmInstancePool[T] { - p := &wasmInstancePool[T]{ - name: name, - new: newFn, - poolSize: poolSize, - getTimeout: getTimeout, - ttl: ttl, - instances: make(chan poolItem[T], poolSize), - semaphore: make(chan struct{}, maxConcurrentInstances), - closing: make(chan struct{}), - } - - // Fill semaphore to allow maxConcurrentInstances - for i := 0; i < maxConcurrentInstances; i++ { - p.semaphore <- struct{}{} - } - - log.Debug(context.Background(), "wasmInstancePool: created new pool", "pool", p.name, "poolSize", p.poolSize, "maxConcurrentInstances", maxConcurrentInstances, "getTimeout", p.getTimeout, "ttl", p.ttl) - go p.cleanupLoop() - return p -} - -func getInstanceID(inst any) string { - return fmt.Sprintf("%p", inst) //nolint:govet -} - -func (p *wasmInstancePool[T]) Get(ctx context.Context) (T, error) { - // First acquire a semaphore slot (concurrent limit) - select { - case <-p.semaphore: - // Got slot, continue - case <-ctx.Done(): - var zero T - return zero, ctx.Err() - case <-time.After(p.getTimeout): - var zero T - return zero, fmt.Errorf("timeout waiting for available instance after %v", p.getTimeout) - case <-p.closing: - var zero T - return zero, fmt.Errorf("pool is closing") - } - - // Try to get from pool first - p.mu.RLock() - instances := p.instances - p.mu.RUnlock() - - select { - case item := <-instances: - log.Trace(ctx, "wasmInstancePool: got instance from pool", "pool", p.name, "instanceID", getInstanceID(item.value)) - return item.value, nil - default: - // Pool empty, create new instance - instance, err := p.new(ctx) - if err != nil { - // Failed to create, return semaphore slot - log.Trace(ctx, "wasmInstancePool: failed to create new instance", "pool", p.name, err) - p.semaphore <- struct{}{} - var zero T - return zero, err - } - log.Trace(ctx, "wasmInstancePool: new instance created", "pool", p.name, "instanceID", getInstanceID(instance)) - return instance, nil - } -} - -func (p *wasmInstancePool[T]) Put(ctx context.Context, v T) { - p.mu.RLock() - instances := p.instances - closed := p.closed - p.mu.RUnlock() - - if closed { - log.Trace(ctx, "wasmInstancePool: pool closed, closing instance", "pool", p.name, "instanceID", getInstanceID(v)) - p.closeItem(ctx, v) - // Return semaphore slot only if this instance came from Get() - select { - case p.semaphore <- struct{}{}: - case <-p.closing: - default: - // Semaphore full, this instance didn't come from Get() - } - return - } - - // Try to return to pool - item := poolItem[T]{value: v, created: time.Now()} - select { - case instances <- item: - log.Trace(ctx, "wasmInstancePool: returned instance to pool", "pool", p.name, "instanceID", getInstanceID(v)) - default: - // Pool full, close instance - log.Trace(ctx, "wasmInstancePool: pool full, closing instance", "pool", p.name, "instanceID", getInstanceID(v)) - p.closeItem(ctx, v) - } - - // Return semaphore slot only if this instance came from Get() - // If semaphore is full, this instance didn't come from Get(), so don't block - select { - case p.semaphore <- struct{}{}: - // Successfully returned token - case <-p.closing: - // Pool closing, don't block - default: - // Semaphore full, this instance didn't come from Get() - } -} - -func (p *wasmInstancePool[T]) Close(ctx context.Context) { - p.mu.Lock() - if p.closed { - p.mu.Unlock() - return - } - p.closed = true - close(p.closing) - instances := p.instances - p.mu.Unlock() - - log.Trace(ctx, "wasmInstancePool: closing pool and all instances", "pool", p.name) - - // Drain and close all instances - for { - select { - case item := <-instances: - p.closeItem(ctx, item.value) - default: - return - } - } -} - -func (p *wasmInstancePool[T]) cleanupLoop() { - ticker := time.NewTicker(p.ttl / 3) - defer ticker.Stop() - for { - select { - case <-ticker.C: - p.cleanupExpired() - case <-p.closing: - return - } - } -} - -func (p *wasmInstancePool[T]) cleanupExpired() { - ctx := context.Background() - now := time.Now() - - // Create new channel with same capacity - newInstances := make(chan poolItem[T], p.poolSize) - - // Atomically swap channels - p.mu.Lock() - oldInstances := p.instances - p.instances = newInstances - p.mu.Unlock() - - // Drain old channel, keeping fresh items - var expiredCount int - for { - select { - case item := <-oldInstances: - if now.Sub(item.created) <= p.ttl { - // Item is still fresh, move to new channel - select { - case newInstances <- item: - // Successfully moved - default: - // New channel full, close excess item - p.closeItem(ctx, item.value) - } - } else { - // Item expired, close it - expiredCount++ - p.closeItem(ctx, item.value) - } - default: - // Old channel drained - if expiredCount > 0 { - log.Trace(ctx, "wasmInstancePool: cleaned up expired instances", "pool", p.name, "expiredCount", expiredCount) - } - return - } - } -} - -func (p *wasmInstancePool[T]) closeItem(ctx context.Context, v T) { - if closer, ok := any(v).(interface{ Close(context.Context) error }); ok { - _ = closer.Close(ctx) - } -} diff --git a/plugins/wasm_instance_pool_test.go b/plugins/wasm_instance_pool_test.go deleted file mode 100644 index 141210473..000000000 --- a/plugins/wasm_instance_pool_test.go +++ /dev/null @@ -1,193 +0,0 @@ -package plugins - -import ( - "context" - "sync/atomic" - "time" - - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" -) - -type testInstance struct { - closed atomic.Bool -} - -func (t *testInstance) Close(ctx context.Context) error { - t.closed.Store(true) - return nil -} - -var _ = Describe("wasmInstancePool", func() { - var ( - ctx = context.Background() - ) - - It("should Get and Put instances", func() { - pool := newWasmInstancePool[*testInstance]("test", 2, 10, 5*time.Second, time.Second, func(ctx context.Context) (*testInstance, error) { - return &testInstance{}, nil - }) - inst, err := pool.Get(ctx) - Expect(err).To(BeNil()) - Expect(inst).ToNot(BeNil()) - pool.Put(ctx, inst) - inst2, err := pool.Get(ctx) - Expect(err).To(BeNil()) - Expect(inst2).To(Equal(inst)) - pool.Close(ctx) - }) - - It("should not exceed max instances", func() { - pool := newWasmInstancePool[*testInstance]("test", 1, 10, 5*time.Second, time.Second, func(ctx context.Context) (*testInstance, error) { - return &testInstance{}, nil - }) - inst1, err := pool.Get(ctx) - Expect(err).To(BeNil()) - inst2 := &testInstance{} - pool.Put(ctx, inst1) - pool.Put(ctx, inst2) // should close inst2 - Expect(inst2.closed.Load()).To(BeTrue()) - pool.Close(ctx) - }) - - It("should expire and close instances after TTL", func() { - pool := newWasmInstancePool[*testInstance]("test", 2, 10, 5*time.Second, 100*time.Millisecond, func(ctx context.Context) (*testInstance, error) { - return &testInstance{}, nil - }) - inst, err := pool.Get(ctx) - Expect(err).To(BeNil()) - pool.Put(ctx, inst) - // Wait for TTL cleanup - time.Sleep(300 * time.Millisecond) - Expect(inst.closed.Load()).To(BeTrue()) - pool.Close(ctx) - }) - - It("should close all on pool Close", func() { - pool := newWasmInstancePool[*testInstance]("test", 2, 10, 5*time.Second, time.Second, func(ctx context.Context) (*testInstance, error) { - return &testInstance{}, nil - }) - inst1, err := pool.Get(ctx) - Expect(err).To(BeNil()) - inst2, err := pool.Get(ctx) - Expect(err).To(BeNil()) - pool.Put(ctx, inst1) - pool.Put(ctx, inst2) - pool.Close(ctx) - Expect(inst1.closed.Load()).To(BeTrue()) - Expect(inst2.closed.Load()).To(BeTrue()) - }) - - It("should be safe for concurrent Get/Put", func() { - pool := newWasmInstancePool[*testInstance]("test", 4, 10, 5*time.Second, time.Second, func(ctx context.Context) (*testInstance, error) { - return &testInstance{}, nil - }) - done := make(chan struct{}) - for i := 0; i < 8; i++ { - go func() { - inst, err := pool.Get(ctx) - Expect(err).To(BeNil()) - pool.Put(ctx, inst) - done <- struct{}{} - }() - } - for i := 0; i < 8; i++ { - <-done - } - pool.Close(ctx) - }) - - It("should enforce max concurrent instances limit", func() { - callCount := atomic.Int32{} - pool := newWasmInstancePool[*testInstance]("test", 2, 3, 100*time.Millisecond, time.Second, func(ctx context.Context) (*testInstance, error) { - callCount.Add(1) - return &testInstance{}, nil - }) - - // Get 3 instances (should hit the limit) - inst1, err := pool.Get(ctx) - Expect(err).To(BeNil()) - inst2, err := pool.Get(ctx) - Expect(err).To(BeNil()) - inst3, err := pool.Get(ctx) - Expect(err).To(BeNil()) - - // Should have created exactly 3 instances at this point - Expect(callCount.Load()).To(Equal(int32(3))) - - // Fourth call should timeout without creating a new instance - start := time.Now() - _, err = pool.Get(ctx) - duration := time.Since(start) - Expect(err).To(HaveOccurred()) - Expect(err.Error()).To(ContainSubstring("timeout waiting for available instance")) - Expect(duration).To(BeNumerically(">=", 100*time.Millisecond)) - Expect(duration).To(BeNumerically("<", 200*time.Millisecond)) - - // Still should have only 3 instances (timeout didn't create new one) - Expect(callCount.Load()).To(Equal(int32(3))) - - // Return one instance and try again - should succeed by reusing returned instance - pool.Put(ctx, inst1) - inst4, err := pool.Get(ctx) - Expect(err).To(BeNil()) - Expect(inst4).To(Equal(inst1)) // Should be the same instance we returned - - // Still should have only 3 instances total (reused inst1) - Expect(callCount.Load()).To(Equal(int32(3))) - - pool.Put(ctx, inst2) - pool.Put(ctx, inst3) - pool.Put(ctx, inst4) - pool.Close(ctx) - }) - - It("should handle concurrent waiters properly", func() { - pool := newWasmInstancePool[*testInstance]("test", 1, 2, time.Second, time.Second, func(ctx context.Context) (*testInstance, error) { - return &testInstance{}, nil - }) - - // Fill up the concurrent slots - inst1, err := pool.Get(ctx) - Expect(err).To(BeNil()) - inst2, err := pool.Get(ctx) - Expect(err).To(BeNil()) - - // Start multiple waiters - waiterResults := make(chan error, 3) - for i := 0; i < 3; i++ { - go func() { - _, err := pool.Get(ctx) - waiterResults <- err - }() - } - - // Wait a bit to ensure waiters are queued - time.Sleep(50 * time.Millisecond) - - // Return instances one by one - pool.Put(ctx, inst1) - pool.Put(ctx, inst2) - - // Two waiters should succeed, one should timeout - successCount := 0 - timeoutCount := 0 - for i := 0; i < 3; i++ { - select { - case err := <-waiterResults: - if err == nil { - successCount++ - } else { - timeoutCount++ - } - case <-time.After(2 * time.Second): - Fail("Test timed out waiting for waiter results") - } - } - - Expect(successCount).To(Equal(2)) - Expect(timeoutCount).To(Equal(1)) - - pool.Close(ctx) - }) -}) diff --git a/reflex.conf b/reflex.conf index 4cd64baf9..47dd775ab 100644 --- a/reflex.conf +++ b/reflex.conf @@ -1 +1 @@ --s -r "(\.go$$|\.cpp$$|\.h$$|\.wasm$$|navidrome.toml|resources|token_received.html)" -R "(^ui|^data|^db/migrations)" -- go run -race -tags netgo . +-s -r "(\.go$$|\.cpp$$|\.h$$|navidrome.toml|resources|token_received.html)" -R "(^ui|^data|^db/migrations)" -R "_test\.go$$" -- go run -race -tags netgo,sqlite_fts5 . diff --git a/release/goreleaser.yml b/release/goreleaser.yml index f71c38f31..e5035adda 100644 --- a/release/goreleaser.yml +++ b/release/goreleaser.yml @@ -19,6 +19,7 @@ builds: - linux_arm_v6 - linux_arm_v7 - linux_arm64 + - linux_riscv64 - windows_386 - windows_amd64 @@ -83,6 +84,15 @@ nfpms: owner: navidrome group: navidrome + - src: release/linux/.package.rpm # contents: "rpm" + dst: /var/lib/navidrome/.package + type: "config|noreplace" + packager: rpm + - src: release/linux/.package.deb # contents: "deb" + dst: /var/lib/navidrome/.package + type: "config|noreplace" + packager: deb + scripts: preinstall: "release/linux/preinstall.sh" postinstall: "release/linux/postinstall.sh" diff --git a/release/linux/.package.deb b/release/linux/.package.deb new file mode 100644 index 000000000..811c85f42 --- /dev/null +++ b/release/linux/.package.deb @@ -0,0 +1 @@ +deb \ No newline at end of file diff --git a/release/linux/.package.rpm b/release/linux/.package.rpm new file mode 100644 index 000000000..7c88ef3c0 --- /dev/null +++ b/release/linux/.package.rpm @@ -0,0 +1 @@ +rpm \ No newline at end of file diff --git a/release/linux/postinstall.sh b/release/linux/postinstall.sh index f3d9c9277..ed39fb127 100644 --- a/release/linux/postinstall.sh +++ b/release/linux/postinstall.sh @@ -23,6 +23,8 @@ if [ ! -f "$postinstall_flag" ]; then # and not by root chown navidrome:navidrome /var/lib/navidrome/cache touch "$postinstall_flag" +else + navidrome service stop --configfile /etc/navidrome/navidrome.toml && navidrome service start --configfile /etc/navidrome/navidrome.toml fi diff --git a/release/wix/build_msi.sh b/release/wix/build_msi.sh index 9fc008446..7e595311e 100755 --- a/release/wix/build_msi.sh +++ b/release/wix/build_msi.sh @@ -49,6 +49,9 @@ cp "${DOWNLOAD_FOLDER}"/extracted_ffmpeg/${FFMPEG_FILE}/bin/ffmpeg.exe "$MSI_OUT cp "$WORKSPACE"/LICENSE "$WORKSPACE"/README.md "$MSI_OUTPUT_DIR" cp "$BINARY" "$MSI_OUTPUT_DIR" +# package type indicator file +echo "msi" > "$MSI_OUTPUT_DIR/.package" + # workaround for wixl WixVariable not working to override bmp locations cp "$WORKSPACE"/release/wix/bmp/banner.bmp /usr/share/wixl-*/ext/ui/bitmaps/bannrbmp.bmp cp "$WORKSPACE"/release/wix/bmp/dialogue.bmp /usr/share/wixl-*/ext/ui/bitmaps/dlgbmp.bmp diff --git a/release/wix/navidrome.wxs b/release/wix/navidrome.wxs index ec8b164e8..8ebba4632 100644 --- a/release/wix/navidrome.wxs +++ b/release/wix/navidrome.wxs @@ -69,6 +69,12 @@ </Directory> </Directory> + + <Directory Id="ND_DATAFOLDER" name="[ND_DATAFOLDER]"> + <Component Id='PackageFile' Guid='9eec0697-803c-4629-858f-20dc376c960b' Win64="$(var.Win64)"> + <File Id='package' Name='.package' DiskId='1' Source='.package' KeyPath='no' /> + </Component> + </Directory> </Directory> <InstallUISequence> @@ -81,6 +87,7 @@ <ComponentRef Id='Configuration'/> <ComponentRef Id='MainExecutable' /> <ComponentRef Id='FFMpegExecutable' /> + <ComponentRef Id='PackageFile' /> </Feature> </Product> </Wix> diff --git a/resources/i18n/bg.json b/resources/i18n/bg.json index ea97d1d1b..7a0281f33 100644 --- a/resources/i18n/bg.json +++ b/resources/i18n/bg.json @@ -1,460 +1,715 @@ { - "languageName": "Български", - "resources": { - "song": { - "name": "Песен |||| Песни", - "fields": { - "albumArtist": "Изпълнител албум", - "duration": "Време", - "trackNumber": "#", - "playCount": "Пускания", - "title": "Заглавие", - "artist": "Изпълнител", - "album": "Албум", - "path": "Път до файл", - "genre": "Жанр", - "compilation": "Компилация", - "year": "Година", - "size": "Размер на файла", - "updatedAt": "Актуализирана", - "bitRate": "Битрейт", - "discSubtitle": "Субтитри на диска", - "starred": "Любима", - "comment": "Коментар", - "rating": "Рейтинг", - "quality": "Качество", - "bpm": "BPM", - "playDate": "Последно слушана", - "channels": "Канала", - "createdAt": "Добавено на" - }, - "actions": { - "addToQueue": "Пусни по-късно", - "playNow": "Пусни сега", - "addToPlaylist": "Добави към плейлист", - "shuffleAll": "Разбъркай всички", - "download": "Свали", - "playNext": "Следваща", - "info": "Информация" - } - }, - "album": { - "name": "Албум |||| Албуми", - "fields": { - "albumArtist": "Изпълнител албум", - "artist": "Изпълнител", - "duration": "Време", - "songCount": "Песни", - "playCount": "Пускания", - "name": "Име", - "genre": "Жанр", - "compilation": "Компилация", - "year": "Година", - "updatedAt": "Актуализиран", - "comment": "Коментар", - "rating": "Рейтинг", - "createdAt": "Добавено на", - "size": "Размер", - "originalDate": "Оригинал", - "releaseDate": "Издаден", - "releases": "Издание |||| Издания", - "released": "Издаден" - }, - "actions": { - "playAll": "Пусни", - "playNext": "Пусни следваща", - "addToQueue": "Пусни по-късно", - "shuffle": "Разбъркай", - "addToPlaylist": "Добави към плейлист", - "download": "Свали", - "info": "Информация", - "share": "Сподели" - }, - "lists": { - "all": "Всички", - "random": "Случайни", - "recentlyAdded": "Последно добавени", - "recentlyPlayed": "Последно слушани", - "mostPlayed": "Най-слушани", - "starred": "Любими", - "topRated": "Най-висок рейтинг" - } - }, - "artist": { - "name": "Изпълнител |||| Изпълнители", - "fields": { - "name": "Име", - "albumCount": "Брой албуми", - "songCount": "Брой песни", - "playCount": "Пускания", - "rating": "Рейтинг", - "genre": "Жанр", - "size": "Размер" - } - }, - "user": { - "name": "Потребител |||| Потребители", - "fields": { - "userName": "Потребителско име", - "isAdmin": "Администратор", - "lastLoginAt": "Последен вход", - "updatedAt": "Актуализиран", - "name": "Име", - "password": "Парола", - "createdAt": "Създаден на", - "changePassword": "Промяна на паролата?", - "currentPassword": "Текуща парола", - "newPassword": "Нова парола", - "token": "Токен" - }, - "helperTexts": { - "name": "Промените в името ще бъдат отразени при следващото влизане" - }, - "notifications": { - "created": "Потребителят е създаден", - "updated": "Потребителят е актуализиран", - "deleted": "Потребителят е изтрит" - }, - "message": { - "listenBrainzToken": "Въведете Вашия токен за ListenBrainz.", - "clickHereForToken": "Кликнете тук, за да получите Вашия токен" - } - }, - "player": { - "name": "Плейър |||| Плейъри", - "fields": { - "name": "Име", - "transcodingId": "Транскодиране", - "maxBitRate": "Макс. битрейт", - "client": "Клиент", - "userName": "Потребителско име", - "lastSeen": "Последно видян", - "reportRealPath": "Докладвай реален път", - "scrobbleEnabled": "Изпрати Scrobbles към външни услуги" - } - }, - "transcoding": { - "name": "Транскодиране |||| Транскодинг", - "fields": { - "name": "Име", - "targetFormat": "Целеви формат", - "defaultBitRate": "Битрейт по подразбиране", - "command": "Команда" - } - }, - "playlist": { - "name": "Плейлист |||| Плейлисти", - "fields": { - "name": "Име", - "duration": "Продължителност", - "ownerName": "Собственик", - "public": "Публичен", - "updatedAt": "Актуализиран", - "createdAt": "Създаден на", - "songCount": "Песни", - "comment": "Коментар", - "sync": "Автоматично импортиране", - "path": "Импортиране от" - }, - "actions": { - "selectPlaylist": "Изберете плейлист:", - "addNewPlaylist": "Създай \"%{name}\"", - "export": "Експорт", - "makePublic": "Направи публичен", - "makePrivate": "Направи личен" - }, - "message": { - "duplicate_song": "Добави дублирани песни", - "song_exist": "Към плейлиста се добавят дублиращи. Желаете ли да ги добавите или предпочитате да ги пропуснете?" - } - }, - "radio": { - "name": "Радиостанция |||| Радиостанции", - "fields": { - "name": "Име", - "streamUrl": "Стрийм адрес", - "homePageUrl": "Начална страница адрес", - "updatedAt": "Актуализиранa на", - "createdAt": "Създаденa на" - }, - "actions": { - "playNow": "Възпроизвеждане сега" - } - }, - "share": { - "name": "Сподели |||| Споделени", - "fields": { - "username": "Споделено от", - "url": "Адрес", - "description": "Описание", - "contents": "Съдържание", - "expiresAt": "Изтича", - "lastVisitedAt": "Последно посетен", - "visitCount": "Посещения", - "format": "Формат", - "maxBitRate": "Макс. Bit Rate", - "updatedAt": "Актуализирана на", - "createdAt": "Създадена на", - "downloadable": "Разреши изтегляния?" - } - } + "languageName": "Български", + "resources": { + "song": { + "name": "Песен |||| Песни", + "fields": { + "albumArtist": "Изпълнител албум", + "duration": "Време", + "trackNumber": "#", + "playCount": "Пускания", + "title": "Заглавие", + "artist": "Изпълнител", + "album": "Албум", + "path": "Път до файл", + "genre": "Жанр", + "compilation": "Компилация", + "year": "Година", + "size": "Размер на файла", + "updatedAt": "Актуализирана", + "bitRate": "Битрейт", + "discSubtitle": "Субтитри на диска", + "starred": "Любима", + "comment": "Коментар", + "rating": "Рейтинг", + "quality": "Качество", + "bpm": "BPM", + "playDate": "Последно слушана", + "channels": "Канала", + "createdAt": "Добавено на", + "grouping": "Групиране", + "mood": "Настроение", + "participants": "Допълнителни участници", + "tags": "Допълнителни етикети", + "mappedTags": "Картирани тагове", + "rawTags": "Сурови тагове", + "bitDepth": "Битова дълбочина", + "sampleRate": "Честота на семплиране", + "missing": "Липсва", + "libraryName": "Библиотека", + "composer": "Композитор", + "disc": "" + }, + "actions": { + "addToQueue": "Пусни по-късно", + "playNow": "Пусни сега", + "addToPlaylist": "Добави към плейлист", + "shuffleAll": "Разбъркай всички", + "download": "Свали", + "playNext": "Следваща", + "info": "Информация", + "showInPlaylist": "Показване в плейлиста", + "instantMix": "Незабавен микс" + } }, - "ra": { - "auth": { - "welcome1": "Благодаря, че инсталирахте Navidrome!", - "welcome2": "За да започнете, създайте администраторски профил", - "confirmPassword": "Потвърдете паролата", - "buttonCreateAdmin": "Създaй администратор", - "auth_check_error": "Моля, влезте за да продължите", - "user_menu": "Профил", - "username": "Потребителско име", - "password": "Парола", - "sign_in": "Вход", - "sign_in_error": "Грешка при удостоверяването. Моля, опитайте отново", - "logout": "Изход" - }, - "validation": { - "invalidChars": "Моля, използвайте само букви и цифри", - "passwordDoesNotMatch": "Паролата не съвпада", - "required": "Задължително", - "minLength": "Трябва да съдържа поне %{min} знака", - "maxLength": "Трябва да съдържа %{max} знака или по-малко", - "minValue": "Трябва да е поне %{min}", - "maxValue": "Трябва да бъде %{max} или по-малко", - "number": "Трябва да е число", - "email": "Трябва да е валиден имейл", - "oneOf": "Трябва да е едно от: %{options}", - "regex": "Трябва да съответства на конкретен формат (regexp): %{pattern}", - "unique": "Трябва да е уникално", - "url": "Трябва да бъде валиден адрес" - }, - "action": { - "add_filter": "Добави филтър", - "add": "Добави", - "back": "Назад", - "bulk_actions": "Избран е 1 елемент |||| Избрани са %{smart_count} елемента", - "cancel": "Отмени", - "clear_input_value": "Изчисти въведеното", - "clone": "Клонирай", - "confirm": "Потвърди", - "create": "Създай", - "delete": "Изтрий", - "edit": "Редактирай", - "export": "Експорт", - "list": "Списък", - "refresh": "Обнови", - "remove_filter": "Премахни този филтър", - "remove": "Премахни", - "save": "Запази", - "search": "Търси", - "show": "Покажи", - "sort": "Сортирай", - "undo": "Отмени", - "expand": "Разгърни", - "close": "Затвори", - "open_menu": "Отвори меню", - "close_menu": "Затвори меню", - "unselect": "Премахни избора", - "skip": "Пропусни", - "bulk_actions_mobile": "1 |||| %{smart_count}", - "share": "Споделяне", - "download": "Сваляне" - }, - "boolean": { - "true": "Да", - "false": "Не" - }, - "page": { - "create": "Създаване на %{name}", - "dashboard": "Табло", - "edit": "%{name} #%{id}", - "error": "Нещо се обърка", - "list": "%{name}", - "loading": "Зареждане", - "not_found": "Не е намерен", - "show": "%{name} #%{id}", - "empty": "Все още няма %{name}.", - "invite": "Желаете ли да добавите?" - }, - "input": { - "file": { - "upload_several": "Пуснете файл за да качите, или кликнете за да изберете.", - "upload_single": "Пуснете файл за да качите, или кликнете за да изберете." - }, - "image": { - "upload_several": "Пуснете снимки за качване, или кликнете, за да изберете.", - "upload_single": "Пуснете снимка за качване, или кликнете за да изберете." - }, - "references": { - "all_missing": "Не намирам свързаните данни.", - "many_missing": "Изглежда, че поне една от свързаните препратки, вече не е налична.", - "single_missing": "Изглежда, че връзката вече не е налична." - }, - "password": { - "toggle_visible": "Скрий паролата", - "toggle_hidden": "Покажи паролата" - } - }, - "message": { - "about": "Относно", - "are_you_sure": "Сигурни ли сте?", - "bulk_delete_content": "Наистина ли желаете да изтриете това %{name}? |||| Наистина ли желаете да изтриете тези %{smart_count} елементи?", - "bulk_delete_title": "Изтрий %{name} |||| Изтрий %{smart_count} %{name}", - "delete_content": "Наистина ли желаете да изтриете този елемент?", - "delete_title": "Изтрий %{name} #%{id}", - "details": "Описание", - "error": "Възникна грешка с клиента и заявката Ви не може да бъде изпълнена.", - "invalid_form": "Формата не е валидна. Моля, проверете за грешки", - "loading": "Страницата се зарежда, моля изчакайте", - "no": "Не", - "not_found": "Или сте въвели грешен URL адрес, или сте следвали грешна връзка.", - "yes": "Да", - "unsaved_changes": "Някои от промените не бяха запазени. Сигурни ли сте, че желаете да ги игнорирате?" - }, - "navigation": { - "no_results": "Няма намерени резултати", - "no_more_results": "Страница %{page} е извън границите. Опитайте предишната страница.", - "page_out_of_boundaries": "Страница %{page} е извън границите", - "page_out_from_end": "Не може да отидете след последната страница", - "page_out_from_begin": "Не може да се премине преди страница 1", - "page_range_info": "%{offsetBegin}-%{offsetEnd} от %{total}", - "page_rows_per_page": "Елемента на страница:", - "next": "Следваща", - "prev": "Предишна", - "skip_nav": "Премини към съдържанието" - }, - "notification": { - "updated": "Елементът е актуализиран |||| %{smart_count} елемента са актуализирани", - "created": "Елементът е създаден", - "deleted": "Елементът е изтрит |||| %{smart_count} елемента са изтрити", - "bad_item": "Неправилен елемент", - "item_doesnt_exist": "Елементът не съществува", - "http_error": "Грешка в комуникацията със сървъра", - "data_provider_error": "Грешка в доставчика на данни. Проверете конзолата за подробности.", - "i18n_error": "Не мога да заредя преводите за посочения език", - "canceled": "Действието е отменено", - "logged_out": "Вашата сесия приключи. Моля, влезте отново.", - "new_version": "Налична е нова версия! Моля, опреснете този прозорец." - }, - "toggleFieldsMenu": { - "columnsToDisplay": "Колони за показване", - "layout": "Оформление", - "grid": "Решетка", - "table": "Таблица" - } + "album": { + "name": "Албум |||| Албуми", + "fields": { + "albumArtist": "Изпълнител албум", + "artist": "Изпълнител", + "duration": "Време", + "songCount": "Песни", + "playCount": "Пускания", + "name": "Име", + "genre": "Жанр", + "compilation": "Компилация", + "year": "Година", + "updatedAt": "Актуализиран", + "comment": "Коментар", + "rating": "Рейтинг", + "createdAt": "Добавено на", + "size": "Размер", + "originalDate": "Оригинал", + "releaseDate": "Издаден", + "releases": "Издание |||| Издания", + "released": "Издаден", + "recordLabel": "Лейбъл", + "catalogNum": "Каталожен номер", + "releaseType": "Тип", + "grouping": "Групиране", + "media": "Медия", + "mood": "Настроение", + "date": "Дата на запис", + "missing": "Липсва", + "libraryName": "Библиотека" + }, + "actions": { + "playAll": "Пусни", + "playNext": "Пусни следваща", + "addToQueue": "Пусни по-късно", + "shuffle": "Разбъркай", + "addToPlaylist": "Добави към плейлист", + "download": "Свали", + "info": "Информация", + "share": "Сподели" + }, + "lists": { + "all": "Всички", + "random": "Случайни", + "recentlyAdded": "Последно добавени", + "recentlyPlayed": "Последно слушани", + "mostPlayed": "Най-слушани", + "starred": "Любими", + "topRated": "Най-висок рейтинг" + } }, - "message": { - "note": "ЗАБЕЛЕЖКА", - "transcodingDisabled": "Промяната на конфигурацията за транскодиране през уеб интерфейса е забранена от съображения за сигурност. Ако желаете да промените (редактирате или добавите) опциите за транскодиране, рестартирайте сървъра с конфигурационната опция %{config}.", - "transcodingEnabled": "Navidrome в момента работи с %{config}, което прави възможно стартирането на системни команди от настройките за транскодиране с помощта на уеб интерфейса. Препоръчваме да го деактивирате от съображения за сигурност и да го активирате само при конфигуриране на опциите за транскодиране.", - "songsAddedToPlaylist": "Добавена 1 песен към плейлиста |||| Добавени %{smart_count} песни към плейлиста", - "noPlaylistsAvailable": "Няма налични", - "delete_user_title": "Изтрий потребителя '%{name}'", - "delete_user_content": "Наистина ли желаете да изтриете този потребител и всичките му данни (включително плейлисти и предпочитания)?", - "notifications_blocked": "В настройките на браузъра сте блокирали известията за този сайт", - "notifications_not_available": "Този браузър не поддържа известия на работния плот или нямате достъп до Navidrome през https", - "lastfmLinkSuccess": "Връзката с Last.fm е успешна! Scrobbling е активиран", - "lastfmLinkFailure": "Last.fm не можа да бъде свързан", - "lastfmUnlinkSuccess": "Връзката с Last.fm е прекъсната! Scrobbling е деактивиран", - "lastfmUnlinkFailure": "Last.fm връзката не можа да бъде премахната", - "openIn": { - "lastfm": "Отвори в Last.fm", - "musicbrainz": "Отвори в MusicBrainz" - }, - "lastfmLink": "Прочетете още...", - "listenBrainzLinkSuccess": "Връзката с ListenBrainz е успешна! Scrobbling е активиран от името на потребителя: %{user}", - "listenBrainzLinkFailure": "ListenBrainz не можа да бъде свързан: %{error}", - "listenBrainzUnlinkSuccess": "Връзката с ListenBrainz е прекъсната! Scrobbling е деактивиран", - "listenBrainzUnlinkFailure": "Връзката с ListenBrainz не можа да бъде прекратена", - "downloadOriginalFormat": "Свали в оригиналния формат", - "shareOriginalFormat": "Сподели в оригинален формат", - "shareDialogTitle": "Сподели %{resource} '%{name}'", - "shareBatchDialogTitle": "Сподели 1 %{resource} |||| Сподели %{smart_count} %{resource}", - "shareSuccess": "Адресът е копиран в клипборда: %{url}", - "shareFailure": "Грешка при копиране на адрес %{url} в клипборда", - "downloadDialogTitle": "Сваляне %{resource} '%{name}' (%{size})", - "shareCopyToClipboard": "Копиране в клипборда: Ctrl+C, Enter" + "artist": { + "name": "Изпълнител |||| Изпълнители", + "fields": { + "name": "Име", + "albumCount": "Брой албуми", + "songCount": "Брой песни", + "playCount": "Пускания", + "rating": "Рейтинг", + "genre": "Жанр", + "size": "Размер", + "role": "Роля", + "missing": "Липсва" + }, + "roles": { + "albumartist": "Изпълнител на албума |||| Изпълнители на албума", + "artist": "Изпълнител |||| Изпълнители", + "composer": "Композитор |||| Композитори", + "conductor": "Диригент |||| Диригенти", + "lyricist": "Текстописец |||| Текстописци", + "arranger": "Аранжор |||| Аранжори", + "producer": "Продуцент |||| Продуценти", + "director": "Директор |||| Директори", + "engineer": "Инженер |||| Инженери", + "mixer": "Миксер |||| Миксери", + "remixer": "Ремиксер |||| Ремиксери", + "djmixer": "DJ миксер |||| DJ миксери", + "performer": "Изпълнител |||| Изпълнители", + "maincredit": "Изпълнител на албума или изпълнител |||| Изпълнители на албума или изпълнители" + }, + "actions": { + "shuffle": "Разбъркване", + "radio": "Радио", + "topSongs": "Топ песни" + } }, - "menu": { - "library": "Библиотека", - "settings": "Настройки", - "version": "Версия", - "theme": "Тема", - "personal": { - "name": "Лични", - "options": { - "theme": "Тема", - "language": "Език", - "defaultView": "Изглед по подразбиране", - "desktop_notifications": "Известия на работния плот", - "lastfmScrobbling": "Scrobble към Last.fm", - "listenBrainzScrobbling": "Scrobble към ListenBrainz", - "replaygain": "Режим ReplayGain", - "preAmp": "ReplayGain PreAmp (dB)", - "gain": { - "none": "Изключен", - "album": "Използвай Album Gain", - "track": "Използвай Track Gain" - } - } - }, - "albumList": "Албуми", - "about": "Относно", - "playlists": "Плейлисти", - "sharedPlaylists": "Споделени плейлисти" + "user": { + "name": "Потребител |||| Потребители", + "fields": { + "userName": "Потребителско име", + "isAdmin": "Администратор", + "lastLoginAt": "Последен вход", + "updatedAt": "Актуализиран", + "name": "Име", + "password": "Парола", + "createdAt": "Създаден на", + "changePassword": "Промяна на паролата?", + "currentPassword": "Текуща парола", + "newPassword": "Нова парола", + "token": "Токен", + "lastAccessAt": "Последен достъп", + "libraries": "Библиотеки" + }, + "helperTexts": { + "name": "Промените в името ще бъдат отразени при следващото влизане", + "libraries": "Изберете конкретни библиотеки за този потребител или оставете празно, за да използвате библиотеки по подразбиране" + }, + "notifications": { + "created": "Потребителят е създаден", + "updated": "Потребителят е актуализиран", + "deleted": "Потребителят е изтрит" + }, + "message": { + "listenBrainzToken": "Въведете Вашия токен за ListenBrainz.", + "clickHereForToken": "Кликнете тук, за да получите Вашия токен", + "selectAllLibraries": "Изберете всички библиотеки", + "adminAutoLibraries": "Администраторите автоматично получават достъп до всички библиотеки" + }, + "validation": { + "librariesRequired": "Трябва да бъде избрана поне една библиотека за потребители без администраторски права" + } }, "player": { - "playListsText": "Списък с песни", - "openText": "Отвори", - "closeText": "Затвори", - "notContentText": "Няма песни", - "clickToPlayText": "Пускане", - "clickToPauseText": "Пауза", - "nextTrackText": "Следваща песен", - "previousTrackText": "Предишна песен", - "reloadText": "Презареди", - "volumeText": "Сила на звука", - "toggleLyricText": "Текст на песен", - "toggleMiniModeText": "Минимизирай", - "destroyText": "Унищожи", - "downloadText": "Свали", - "removeAudioListsText": "Изтриване на плейлисти", - "clickToDeleteText": "Кликнете, за да изтриете %{name}", - "emptyLyricText": "Няма текст", - "playModeText": { - "order": "По ред", - "orderLoop": "Повтаряй всички", - "singleLoop": "Повтаряй същата", - "shufflePlay": "Разбъркай" - } + "name": "Плейър |||| Плейъри", + "fields": { + "name": "Име", + "transcodingId": "Транскодиране", + "maxBitRate": "Макс. битрейт", + "client": "Клиент", + "userName": "Потребителско име", + "lastSeen": "Последно видян", + "reportRealPath": "Докладвай реален път", + "scrobbleEnabled": "Изпрати Scrobbles към външни услуги" + } }, - "about": { - "links": { - "homepage": "Начална страница", - "source": "Програмен код", - "featureRequests": "Заявете функционалност" - } + "transcoding": { + "name": "Транскодиране |||| Транскодинг", + "fields": { + "name": "Име", + "targetFormat": "Целеви формат", + "defaultBitRate": "Битрейт по подразбиране", + "command": "Команда" + } }, - "activity": { - "title": "Действия", - "totalScanned": "Сканирани папки", - "quickScan": "Бързо сканиране", - "fullScan": "Пълно сканиране", - "serverUptime": "Сървърът работи", - "serverDown": "ОФЛАЙН" + "playlist": { + "name": "Плейлист |||| Плейлисти", + "fields": { + "name": "Име", + "duration": "Продължителност", + "ownerName": "Собственик", + "public": "Публичен", + "updatedAt": "Актуализиран", + "createdAt": "Създаден на", + "songCount": "Песни", + "comment": "Коментар", + "sync": "Автоматично импортиране", + "path": "Импортиране от" + }, + "actions": { + "selectPlaylist": "Изберете плейлист:", + "addNewPlaylist": "Създай \"%{name}\"", + "export": "Експорт", + "makePublic": "Направи публичен", + "makePrivate": "Направи личен", + "saveQueue": "Запазване на опашката в плейлист", + "searchOrCreate": "Търсете в плейлисти или пишете, за да създадете нови...", + "pressEnterToCreate": "Натиснете Enter, за да създадете нов плейлист", + "removeFromSelection": "Премахване от селекцията" + }, + "message": { + "duplicate_song": "Добави дублирани песни", + "song_exist": "Към плейлиста се добавят дублиращи. Желаете ли да ги добавите или предпочитате да ги пропуснете?", + "noPlaylistsFound": "Няма намерени плейлисти", + "noPlaylists": "Няма налични плейлисти" + } }, - "help": { - "title": "Бързи клавиши на Navidrome", - "hotkeys": { - "show_help": "Показва този помощен текст", - "toggle_menu": "Превключване на страничната меню лента", - "toggle_play": "Пусни / Пауза", - "prev_song": "Предишна песен", - "next_song": "Следваща песен", - "vol_up": "Увеличи звука", - "vol_down": "Намали звука", - "toggle_love": "Добави песента към любими", - "current_song": "Премини към текущата песен" - } + "radio": { + "name": "Радиостанция |||| Радиостанции", + "fields": { + "name": "Име", + "streamUrl": "Стрийм адрес", + "homePageUrl": "Начална страница адрес", + "updatedAt": "Актуализиранa на", + "createdAt": "Създаденa на" + }, + "actions": { + "playNow": "Възпроизвеждане сега" + } + }, + "share": { + "name": "Сподели |||| Споделени", + "fields": { + "username": "Споделено от", + "url": "Адрес", + "description": "Описание", + "contents": "Съдържание", + "expiresAt": "Изтича", + "lastVisitedAt": "Последно посетен", + "visitCount": "Посещения", + "format": "Формат", + "maxBitRate": "Макс. Bit Rate", + "updatedAt": "Актуализирана на", + "createdAt": "Създадена на", + "downloadable": "Разреши изтегляния?" + } + }, + "missing": { + "name": "Липсващ файл |||| Липсващи файлове", + "fields": { + "path": "Път", + "size": "Размер", + "updatedAt": "Изчезнал на", + "libraryName": "Библиотека" + }, + "actions": { + "remove": "Премахни", + "remove_all": "Премахни всички" + }, + "notifications": { + "removed": "Липсващите файлове са премахнати" + }, + "empty": "Няма липсващи файлове" + }, + "library": { + "name": "Библиотека |||| Библиотеки", + "fields": { + "name": "Име", + "path": "Път", + "remotePath": "Отдалечен път", + "lastScanAt": "Последно сканиране", + "songCount": "Песни", + "albumCount": "Албуми", + "artistCount": "Изпълнители", + "totalSongs": "Песни", + "totalAlbums": "Албуми", + "totalArtists": "Изпълнители", + "totalFolders": "Папки", + "totalFiles": "Файлове", + "totalMissingFiles": "Липсващи файлове", + "totalSize": "Общ размер", + "totalDuration": "Продължителност", + "defaultNewUsers": "По подразбиране за нови потребители", + "createdAt": "Създаден", + "updatedAt": "Актуализиран" + }, + "sections": { + "basic": "Основна информация", + "statistics": "Статистика" + }, + "actions": { + "scan": "Сканирай библиотеката", + "manageUsers": "Управление на потребителския достъп", + "viewDetails": "Преглед на подробности", + "quickScan": "Quick Scan", + "fullScan": "Пълно сканиране" + }, + "notifications": { + "created": "Библиотеката е създадена успешно", + "updated": "Библиотеката е актуализирана успешно", + "deleted": "Библиотеката е изтрита успешно", + "scanStarted": "Сканирането на библиотеката започна", + "scanCompleted": "Сканирането на библиотеката е завършено", + "quickScanStarted": "Бързото сканиране започна", + "fullScanStarted": "Пълното сканиране започна", + "scanError": "Грешка при стартиране на сканирането. Проверете лог файловете" + }, + "validation": { + "nameRequired": "Името на библиотеката е задължително", + "pathRequired": "Пътят към библиотеката е задължителен", + "pathNotDirectory": "Пътят до библиотеката трябва да е директория", + "pathNotFound": "Пътят към библиотеката не е намерен", + "pathNotAccessible": "Пътят до библиотеката не е достъпен", + "pathInvalid": "Невалиден път към библиотеката" + }, + "messages": { + "deleteConfirm": "Сигурни ли сте, че желаете да изтриете тази библиотека? Това ще премахне всички свързани данни и потребителски достъп.", + "scanInProgress": "Сканирането е в ход...", + "noLibrariesAssigned": "Няма библиотеки, присвоени на този потребител" + } + }, + "plugin": { + "name": "Плъгин |||| Плъгини", + "fields": { + "id": "ID номер", + "name": "Име", + "description": "Описание", + "version": "Версия", + "author": "Автор", + "website": "Уебсайт", + "permissions": "Разрешения", + "enabled": "Активирано", + "status": "Статус", + "path": "Път", + "lastError": "Грешка", + "hasError": "Грешка", + "updatedAt": "Актуализирано", + "createdAt": "Инсталирано", + "configKey": "Ключ", + "configValue": "Стойност", + "allUsers": "Разрешаване на всички потребители", + "selectedUsers": "Избрани потребители", + "allLibraries": "Разрешаване на всички библиотеки", + "selectedLibraries": "Избрани библиотеки", + "allowWriteAccess": "" + }, + "sections": { + "status": "Статус", + "info": "Информация за плъгина", + "configuration": "Конфигурация", + "manifest": "Манифест", + "usersPermission": "Права за потребители", + "libraryPermission": "Права за библиотека" + }, + "status": { + "enabled": "Активирано", + "disabled": "Деактивирано" + }, + "actions": { + "enable": "Активирай", + "disable": "Деактивирай", + "disabledDueToError": "Поправете грешката преди активиране", + "disabledUsersRequired": "Изберете потребители преди активиране", + "disabledLibrariesRequired": "Изберете библиотеки преди активиране", + "addConfig": "Добавяне на конфигурация", + "rescan": "Повторно сканиране" + }, + "notifications": { + "enabled": "Плъгинът е активиран", + "disabled": "Плъгинът е деактивиран", + "updated": "Плъгинът е актуализиран", + "error": "Грешка при актуализиране на плъгина" + }, + "validation": { + "invalidJson": "Конфигурацията трябва да е валиден JSON" + }, + "messages": { + "configHelp": "Конфигурирайте плъгина, използвайки двойки ключ-стойност. Оставете празно, ако плъгинът не изисква конфигурация.", + "clickPermissions": "Кликнете върху разрешение за подробности", + "noConfig": "Няма зададена конфигурация", + "allUsersHelp": "Когато е активиран, плъгинът ще има достъп до всички потребители, включително тези, създадени в бъдеще.", + "noUsers": "Няма избрани потребители", + "permissionReason": "Причина", + "usersRequired": "Този плъгин изисква достъп до потребителска информация. Изберете до кои потребители плъгинът може да има достъп или активирайте „Разрешаване на всички потребители“.", + "allLibrariesHelp": "Когато е активиран, плъгинът ще има достъп до всички библиотеки, включително тези, създадени в бъдеще.", + "noLibraries": "Няма избрани библиотеки", + "librariesRequired": "Този плъгин изисква достъп до информация за библиотеката. Изберете до кои библиотеки плъгинът може да има достъп или активирайте „Разрешаване на всички библиотеки“.", + "requiredHosts": "Необходими хостове", + "configValidationError": "Валидирането на конфигурацията не бе успешно:", + "schemaRenderError": "Не може да се изобрази формята за конфигурация. Схемата на плъгина може да е невалидна.", + "allowWriteAccessHelp": "" + }, + "placeholders": { + "configKey": "ключ", + "configValue": "стойност" + } } -} \ No newline at end of file + }, + "ra": { + "auth": { + "welcome1": "Благодаря, че инсталирахте Navidrome!", + "welcome2": "За да започнете, създайте администраторски профил", + "confirmPassword": "Потвърдете паролата", + "buttonCreateAdmin": "Създaй администратор", + "auth_check_error": "Моля, влезте за да продължите", + "user_menu": "Профил", + "username": "Потребителско име", + "password": "Парола", + "sign_in": "Вход", + "sign_in_error": "Грешка при удостоверяването. Моля, опитайте отново", + "logout": "Изход", + "insightsCollectionNote": "Navidrome събира анонимни данни, за да помогне\nподобряването на проекта. Кликнете [тук], за да\nнаучите повече и да се откажете, ако желаете" + }, + "validation": { + "invalidChars": "Моля, използвайте само букви и цифри", + "passwordDoesNotMatch": "Паролата не съвпада", + "required": "Задължително", + "minLength": "Трябва да съдържа поне %{min} знака", + "maxLength": "Трябва да съдържа %{max} знака или по-малко", + "minValue": "Трябва да е поне %{min}", + "maxValue": "Трябва да бъде %{max} или по-малко", + "number": "Трябва да е число", + "email": "Трябва да е валиден имейл", + "oneOf": "Трябва да е едно от: %{options}", + "regex": "Трябва да съответства на конкретен формат (regexp): %{pattern}", + "unique": "Трябва да е уникално", + "url": "Трябва да бъде валиден адрес" + }, + "action": { + "add_filter": "Добави филтър", + "add": "Добави", + "back": "Назад", + "bulk_actions": "Избран е 1 елемент |||| Избрани са %{smart_count} елемента", + "cancel": "Отмени", + "clear_input_value": "Изчисти въведеното", + "clone": "Клонирай", + "confirm": "Потвърди", + "create": "Създай", + "delete": "Изтрий", + "edit": "Редактирай", + "export": "Експорт", + "list": "Списък", + "refresh": "Обнови", + "remove_filter": "Премахни този филтър", + "remove": "Премахни", + "save": "Запази", + "search": "Търси", + "show": "Покажи", + "sort": "Сортирай", + "undo": "Отмени", + "expand": "Разгърни", + "close": "Затвори", + "open_menu": "Отвори меню", + "close_menu": "Затвори меню", + "unselect": "Премахни избора", + "skip": "Пропусни", + "bulk_actions_mobile": "1 |||| %{smart_count}", + "share": "Споделяне", + "download": "Сваляне" + }, + "boolean": { + "true": "Да", + "false": "Не" + }, + "page": { + "create": "Създаване на %{name}", + "dashboard": "Табло", + "edit": "%{name} #%{id}", + "error": "Нещо се обърка", + "list": "%{name}", + "loading": "Зареждане", + "not_found": "Не е намерен", + "show": "%{name} #%{id}", + "empty": "Все още няма %{name}.", + "invite": "Желаете ли да добавите?" + }, + "input": { + "file": { + "upload_several": "Пуснете файл за да качите, или кликнете за да изберете.", + "upload_single": "Пуснете файл за да качите, или кликнете за да изберете." + }, + "image": { + "upload_several": "Пуснете снимки за качване, или кликнете, за да изберете.", + "upload_single": "Пуснете снимка за качване, или кликнете за да изберете." + }, + "references": { + "all_missing": "Не намирам свързаните данни.", + "many_missing": "Изглежда, че поне една от свързаните препратки, вече не е налична.", + "single_missing": "Изглежда, че връзката вече не е налична." + }, + "password": { + "toggle_visible": "Скрий паролата", + "toggle_hidden": "Покажи паролата" + } + }, + "message": { + "about": "Относно", + "are_you_sure": "Сигурни ли сте?", + "bulk_delete_content": "Наистина ли желаете да изтриете това %{name}? |||| Наистина ли желаете да изтриете тези %{smart_count} елементи?", + "bulk_delete_title": "Изтрий %{name} |||| Изтрий %{smart_count} %{name}", + "delete_content": "Наистина ли желаете да изтриете този елемент?", + "delete_title": "Изтрий %{name} #%{id}", + "details": "Описание", + "error": "Възникна грешка с клиента и заявката Ви не може да бъде изпълнена.", + "invalid_form": "Формата не е валидна. Моля, проверете за грешки", + "loading": "Страницата се зарежда, моля изчакайте", + "no": "Не", + "not_found": "Или сте въвели грешен URL адрес, или сте следвали грешна връзка.", + "yes": "Да", + "unsaved_changes": "Някои от промените не бяха запазени. Сигурни ли сте, че желаете да ги игнорирате?" + }, + "navigation": { + "no_results": "Няма намерени резултати", + "no_more_results": "Страница %{page} е извън границите. Опитайте предишната страница.", + "page_out_of_boundaries": "Страница %{page} е извън границите", + "page_out_from_end": "Не може да отидете след последната страница", + "page_out_from_begin": "Не може да се премине преди страница 1", + "page_range_info": "%{offsetBegin}-%{offsetEnd} от %{total}", + "page_rows_per_page": "Елемента на страница:", + "next": "Следваща", + "prev": "Предишна", + "skip_nav": "Премини към съдържанието" + }, + "notification": { + "updated": "Елементът е актуализиран |||| %{smart_count} елемента са актуализирани", + "created": "Елементът е създаден", + "deleted": "Елементът е изтрит |||| %{smart_count} елемента са изтрити", + "bad_item": "Неправилен елемент", + "item_doesnt_exist": "Елементът не съществува", + "http_error": "Грешка в комуникацията със сървъра", + "data_provider_error": "Грешка в доставчика на данни. Проверете конзолата за подробности.", + "i18n_error": "Не мога да заредя преводите за посочения език", + "canceled": "Действието е отменено", + "logged_out": "Вашата сесия приключи. Моля, влезте отново.", + "new_version": "Налична е нова версия! Моля, опреснете този прозорец." + }, + "toggleFieldsMenu": { + "columnsToDisplay": "Колони за показване", + "layout": "Оформление", + "grid": "Решетка", + "table": "Таблица" + } + }, + "message": { + "note": "ЗАБЕЛЕЖКА", + "transcodingDisabled": "Промяната на конфигурацията за транскодиране през уеб интерфейса е забранена от съображения за сигурност. Ако желаете да промените (редактирате или добавите) опциите за транскодиране, рестартирайте сървъра с конфигурационната опция %{config}.", + "transcodingEnabled": "Navidrome в момента работи с %{config}, което прави възможно стартирането на системни команди от настройките за транскодиране с помощта на уеб интерфейса. Препоръчваме да го деактивирате от съображения за сигурност и да го активирате само при конфигуриране на опциите за транскодиране.", + "songsAddedToPlaylist": "Добавена 1 песен към плейлиста |||| Добавени %{smart_count} песни към плейлиста", + "noPlaylistsAvailable": "Няма налични", + "delete_user_title": "Изтрий потребителя '%{name}'", + "delete_user_content": "Наистина ли желаете да изтриете този потребител и всичките му данни (включително плейлисти и предпочитания)?", + "notifications_blocked": "В настройките на браузъра сте блокирали известията за този сайт", + "notifications_not_available": "Този браузър не поддържа известия на работния плот или нямате достъп до Navidrome през https", + "lastfmLinkSuccess": "Връзката с Last.fm е успешна! Scrobbling е активиран", + "lastfmLinkFailure": "Last.fm не можа да бъде свързан", + "lastfmUnlinkSuccess": "Връзката с Last.fm е прекъсната! Scrobbling е деактивиран", + "lastfmUnlinkFailure": "Last.fm връзката не можа да бъде премахната", + "openIn": { + "lastfm": "Отвори в Last.fm", + "musicbrainz": "Отвори в MusicBrainz" + }, + "lastfmLink": "Прочетете още...", + "listenBrainzLinkSuccess": "Връзката с ListenBrainz е успешна! Scrobbling е активиран от името на потребителя: %{user}", + "listenBrainzLinkFailure": "ListenBrainz не можа да бъде свързан: %{error}", + "listenBrainzUnlinkSuccess": "Връзката с ListenBrainz е прекъсната! Scrobbling е деактивиран", + "listenBrainzUnlinkFailure": "Връзката с ListenBrainz не можа да бъде прекратена", + "downloadOriginalFormat": "Свали в оригиналния формат", + "shareOriginalFormat": "Сподели в оригинален формат", + "shareDialogTitle": "Сподели %{resource} '%{name}'", + "shareBatchDialogTitle": "Сподели 1 %{resource} |||| Сподели %{smart_count} %{resource}", + "shareSuccess": "Адресът е копиран в клипборда: %{url}", + "shareFailure": "Грешка при копиране на адрес %{url} в клипборда", + "downloadDialogTitle": "Сваляне %{resource} '%{name}' (%{size})", + "shareCopyToClipboard": "Копиране в клипборда: Ctrl+C, Enter", + "remove_missing_title": "Премахни липсващите файлове", + "remove_missing_content": "Сигурни ли сте, че желаете да премахнете избраните липсващи файлове от базата данни? Това ще премахне завинаги всички препратки към тях, включително броя на възпроизвежданията и оценките им.", + "remove_all_missing_title": "Премахни всички липсващи файлове", + "remove_all_missing_content": "Сигурни ли сте, че желаете да премахнете всички липсващи файлове от базата данни? Това ще премахне завинаги всички препратки към тях, включително броя на възпроизвежданията и оценките им.", + "noSimilarSongsFound": "Не са намерени подобни песни", + "noTopSongsFound": "Няма намерени топ песни", + "startingInstantMix": "Зареждане на незабавен микс..." + }, + "menu": { + "library": "Библиотека", + "settings": "Настройки", + "version": "Версия", + "theme": "Тема", + "personal": { + "name": "Лични", + "options": { + "theme": "Тема", + "language": "Език", + "defaultView": "Изглед по подразбиране", + "desktop_notifications": "Известия на работния плот", + "lastfmScrobbling": "Scrobble към Last.fm", + "listenBrainzScrobbling": "Scrobble към ListenBrainz", + "replaygain": "Режим ReplayGain", + "preAmp": "ReplayGain PreAmp (dB)", + "gain": { + "none": "Изключен", + "album": "Използвай Album Gain", + "track": "Използвай Track Gain" + }, + "lastfmNotConfigured": "API ключът на Last.fm не е конфигуриран" + } + }, + "albumList": "Албуми", + "about": "Относно", + "playlists": "Плейлисти", + "sharedPlaylists": "Споделени плейлисти", + "librarySelector": { + "allLibraries": "Всички библиотеки (%{count})", + "multipleLibraries": "%{selected} от %{total} библиотеки", + "selectLibraries": "Изберете библиотеки", + "none": "Няма" + } + }, + "player": { + "playListsText": "Списък с песни", + "openText": "Отвори", + "closeText": "Затвори", + "notContentText": "Няма песни", + "clickToPlayText": "Пускане", + "clickToPauseText": "Пауза", + "nextTrackText": "Следваща песен", + "previousTrackText": "Предишна песен", + "reloadText": "Презареди", + "volumeText": "Сила на звука", + "toggleLyricText": "Текст на песен", + "toggleMiniModeText": "Минимизирай", + "destroyText": "Унищожи", + "downloadText": "Свали", + "removeAudioListsText": "Изтриване на плейлисти", + "clickToDeleteText": "Кликнете, за да изтриете %{name}", + "emptyLyricText": "Няма текст", + "playModeText": { + "order": "По ред", + "orderLoop": "Повтаряй всички", + "singleLoop": "Повтаряй същата", + "shufflePlay": "Разбъркай" + } + }, + "about": { + "links": { + "homepage": "Начална страница", + "source": "Програмен код", + "featureRequests": "Заявете функционалност", + "lastInsightsCollection": "Последна колекция от анализи", + "insights": { + "disabled": "Деактивиран", + "waiting": "Изчакване" + } + }, + "tabs": { + "about": "Относно", + "config": "Конфигурация" + }, + "config": { + "configName": "Име на конфигурация", + "environmentVariable": "Променлива на средата", + "currentValue": "Текуща стойност", + "configurationFile": "Конфигурационен файл", + "exportToml": "Експортиране на конфигурация (TOML)", + "exportSuccess": "Конфигурация, експортирана в клипборда във формат TOML", + "exportFailed": "Неуспешно копиране на конфигурация", + "devFlagsHeader": "Флагове за разработка (подлежащи на промяна/премахване)", + "devFlagsComment": "Това са експериментални настройки и е възможно да бъдат премахнати в бъдещи версии.", + "downloadToml": "Изтегляне на конфигурация (TOML)" + } + }, + "activity": { + "title": "Действия", + "totalScanned": "Сканирани папки", + "quickScan": "Бързо сканиране", + "fullScan": "Пълно сканиране", + "serverUptime": "Сървърът работи", + "serverDown": "ОФЛАЙН", + "scanType": "Последно сканиране", + "status": "Грешка при сканиране", + "elapsedTime": "Изминало време", + "selectiveScan": "Селективен" + }, + "help": { + "title": "Бързи клавиши на Navidrome", + "hotkeys": { + "show_help": "Показва този помощен текст", + "toggle_menu": "Превключване на страничната меню лента", + "toggle_play": "Пусни / Пауза", + "prev_song": "Предишна песен", + "next_song": "Следваща песен", + "vol_up": "Увеличи звука", + "vol_down": "Намали звука", + "toggle_love": "Добави песента към любими", + "current_song": "Премини към текущата песен" + } + }, + "nowPlaying": { + "title": "Сега свири", + "empty": "Нищо не се възпроизвежда", + "minutesAgo": "преди %{smart_count} минута |||| преди %{smart_count} минути" + } +} diff --git a/resources/i18n/ca.json b/resources/i18n/ca.json index e3e7b544e..1ef2ce016 100644 --- a/resources/i18n/ca.json +++ b/resources/i18n/ca.json @@ -1,518 +1,715 @@ { - "languageName": "Català", - "resources": { - "song": { - "name": "Cançó |||| Cançons", - "fields": { - "albumArtist": "Artista de l'àlbum", - "duration": "Durada", - "trackNumber": "#", - "playCount": "Reproduccions", - "title": "Títol", - "artist": "Artista", - "album": "Àlbum", - "path": "Ruta del fitxer", - "genre": "Gènere", - "compilation": "Compilació", - "year": "Any", - "size": "Mida del fitxer", - "updatedAt": "Actualitzat", - "bitRate": "Taxa de bits", - "bitDepth": "Bits", - "sampleRate": "Freqüencia de mostreig", - "channels": "Canals", - "discSubtitle": "Subtítol del disc", - "starred": "Preferit", - "comment": "Comentari", - "rating": "Valoració", - "quality": "Qualitat", - "bpm": "tempo", - "playDate": "Darrer resproduït", - "createdAt": "Creat el", - "grouping": "Agrupació", - "mood": "Sentiment", - "participants": "Participants", - "tags": "Etiquetes", - "mappedTags": "Etiquetes assignades", - "rawTags": "Etiquetes sense processar" - }, - "actions": { - "addToQueue": "Reprodueix després", - "playNow": "Reprodueix ara", - "addToPlaylist": "Afegeix a la llista", - "shuffleAll": "Aleatori", - "download": "Descarrega", - "playNext": "Reprodueix següent", - "info": "Obtén informació" - } - }, - "album": { - "name": "Àlbum |||| Àlbums", - "fields": { - "albumArtist": "Artista de l'àlbum", - "artist": "Artista", - "duration": "Durada", - "songCount": "Cançons", - "playCount": "Reproduccions", - "size": "Mida", - "name": "Nom", - "genre": "Gènere", - "compilation": "Compilació", - "year": "Any", - "updatedAt": "Actualitzat ", - "comment": "Comentari", - "rating": "Valoració", - "createdAt": "Creat el", - "size": "Mida", - "originalDate": "Original", - "releaseDate": "Publicat", - "releases": "LLançament |||| Llançaments", - "released": "Publicat", - "recordLabel": "Discogràfica", - "catalogNum": "Número de catàleg", - "releaseType": "Tipus de publicació", - "grouping": "Agrupació", - "media": "Mitjà", - "mood": "Sentiment" - }, - "actions": { - "playAll": "Reprodueix", - "playNext": "Reprodueix la següent", - "addToQueue": "Reprodueix després", - "share": "Compartir", - "shuffle": "Aleatori", - "addToPlaylist": "Afegeix a la llista", - "download": "Descarrega", - "info": "Obtén informació" - }, - "lists": { - "all": "Tot", - "random": "Aleatori", - "recentlyAdded": "Afegit fa poc", - "recentlyPlayed": "Reproduït fa poc", - "mostPlayed": "Més reproduït", - "starred": "Preferits", - "topRated": "Més ben valorades" - } - }, - "artist": { - "name": "Artista |||| Artistes", - "fields": { - "name": "Nom", - "albumCount": "Nombre d'àlbums", - "songCount": "Nombre de cançons", - "size": "Mida", - "playCount": "Reproduccions", - "rating": "Valoració", - "genre": "Gènere", - "role": "Rol" - }, - "roles": { - "albumartist": "Artista de l'Àlbum |||| Artistes de l'Àlbum", - "artist": "Artista |||| Artistes", - "composer": "Compositor |||| Compositors", - "conductor": "Conductor |||| Conductors", - "lyricist": "Lletrista |||| Lletristes", - "arranger": "Arranjador |||| Arranjadors", - "producer": "Productor |||| Productors", - "director": "Director |||| Directors", - "engineer": "Enginyer |||| Enginyers", - "mixer": "Mesclador |||| Mescladors", - "remixer": "Remesclador |||| Remescladors", - "djmixer": "DJ Mesclador |||| DJ Mescladors", - "performer": "Intèrpret |||| Intèrprets" - } - }, - "user": { - "name": "Usuari |||| Usuaris", - "fields": { - "userName": "Nom d'usuari", - "isAdmin": "És admin", - "lastLoginAt": "Última connexió", - "lastAccessAt": "Últim Accés", - "updatedAt": "Actualitzat", - "name": "Nom", - "password": "Contrasenya", - "createdAt": "Creat", - "changePassword": "Canviar la contrasenya?", - "currentPassword": "Contrasenya actual", - "newPassword": "Contrasenya nova", - "token": "Token" - }, - "helperTexts": { - "name": "Els canvis en el nom s'hi aplicaran en la següent connexió" - }, - "notifications": { - "created": "Usuari creat", - "updated": "Usuari actualitzat", - "deleted": "Usuari eliminat" - }, - "message": { - "listenBrainzToken": "Introduïu el vostre token d'usuari de ListenBrainz", - "clickHereForToken": "Feu clic ací per a obtenir el vostre token" - } - }, - "player": { - "name": "Reproductor |||| Reproductors", - "fields": { - "name": "Nom", - "transcodingId": "Transcodificador", - "maxBitRate": "Taxa de bits màx.", - "client": "Client", - "userName": "Nom d'usuari", - "lastSeen": "Vist", - "reportRealPath": "Informa de la ruta real", - "scrobbleEnabled": "Activa el seguiment des de serveis externs" - } - }, - "transcoding": { - "name": "Transcodificador |||| Transcodificadors", - "fields": { - "name": "Nom", - "targetFormat": "Format desitjat", - "defaultBitRate": "Taxa de bits per defecte", - "command": "Ordre" - } - }, - "playlist": { - "name": "Llista |||| Llistes", - "fields": { - "name": "Nom", - "duration": "Durada", - "ownerName": "Propietari", - "public": "Públic", - "updatedAt": "Actualitzat ", - "createdAt": "Creat", - "songCount": "Cançons", - "comment": "Comentari", - "sync": "Auto-importació", - "path": "Importa de" - }, - "actions": { - "selectPlaylist": "Selecciona una llista:", - "addNewPlaylist": "Crea \"%{nom}", - "export": "Exporta", - "makePublic": "Fes públic", - "makePrivate": "Fes privat" - }, - "message": { - "duplicate_song": "Afegeix cançons duplicades", - "song_exist": "Heu afegit duplicats a la llista. Voleu afegir-los o ignorar-los?" - } - }, - "radio": { - "name": "Ràdio |||| Ràdios", - "fields": { - "name": "Nom", - "streamUrl": "URL del flux", - "homePageUrl": "URL principal", - "updatedAt": "Actualitzat", - "createdAt": "Creat" - }, - "actions": { - "playNow": "Reprodueix" - } - }, - "share": { - "name": "Compartir |||| Compartits", - "fields": { - "username": "Compartit per", - "url": "URL", - "description": "Descripció", - "downloadable": "Permet descarregar?", - "contents": "Continguts", - "expiresAt": "Caduca", - "lastVisitedAt": "Última Visita", - "visitCount": "Visites", - "format": "Format", - "maxBitRate": "Taxa de bits màx.", - "updatedAt": "Actualitzat", - "createdAt": "Creat" - }, - "notifications": {}, - "actions": {} - }, - "missing": { + "languageName": "Català", + "resources": { + "song": { + "name": "Cançó |||| Cançons", + "fields": { + "albumArtist": "Artista de l'àlbum", + "duration": "Durada", + "trackNumber": "#", + "playCount": "Reproduccions", + "title": "Títol", + "artist": "Artista", + "album": "Àlbum", + "path": "Ruta del fitxer", + "genre": "Gènere", + "compilation": "Compilació", + "year": "Any", + "size": "Mida del fitxer", + "updatedAt": "Actualitzat", + "bitRate": "Taxa de bits", + "discSubtitle": "Subtítol del disc", + "starred": "Preferit", + "comment": "Comentari", + "rating": "Valoració", + "quality": "Qualitat", + "bpm": "tempo", + "playDate": "Darrer resproduït", + "channels": "Canals", + "createdAt": "Data d'addició", + "grouping": "Agrupació", + "mood": "Sentiment", + "participants": "Participants", + "tags": "Etiquetes", + "mappedTags": "Etiquetes assignades", + "rawTags": "Etiquetes sense processar", + "bitDepth": "Bits", + "sampleRate": "Freqüencia de mostreig", + "missing": "Desaparegut", + "libraryName": "Biblioteca", + "composer": "Compositor", + "disc": "" + }, + "actions": { + "addToQueue": "Reprodueix després", + "playNow": "Reprodueix ara", + "addToPlaylist": "Afegeix a la llista", + "shuffleAll": "Aleatori", + "download": "Descarrega", + "playNext": "Reprodueix següent", + "info": "Obtén informació", + "showInPlaylist": "Mostra a la llista", + "instantMix": "Mescla immediata" + } + }, + "album": { + "name": "Àlbum |||| Àlbums", + "fields": { + "albumArtist": "Artista de l'àlbum", + "artist": "Artista", + "duration": "Durada", + "songCount": "Cançons", + "playCount": "Reproduccions", + "name": "Nom", + "genre": "Gènere", + "compilation": "Compilació", + "year": "Any", + "updatedAt": "Actualitzat ", + "comment": "Comentari", + "rating": "Valoració", + "createdAt": "Data d'addició", + "size": "Mida", + "originalDate": "Original", + "releaseDate": "Publicat", + "releases": "LLançament |||| Llançaments", + "released": "Publicat", + "recordLabel": "Discogràfica", + "catalogNum": "Número de catàleg", + "releaseType": "Tipus de publicació", + "grouping": "Agrupació", + "media": "Mitjà", + "mood": "Sentiment", + "date": "Data d'enregistrament", + "missing": "Desaparegut", + "libraryName": "Biblioteca" + }, + "actions": { + "playAll": "Reprodueix", + "playNext": "Reprodueix la següent", + "addToQueue": "Reprodueix després", + "shuffle": "Aleatori", + "addToPlaylist": "Afegeix a la llista", + "download": "Descarrega", + "info": "Obtén informació", + "share": "Compartir" + }, + "lists": { + "all": "Tot", + "random": "Aleatori", + "recentlyAdded": "Afegits recentment", + "recentlyPlayed": "Reproduïts recentment", + "mostPlayed": "Més reproduïts", + "starred": "Preferits", + "topRated": "Més ben valorats" + } + }, + "artist": { + "name": "Artista |||| Artistes", + "fields": { + "name": "Nom", + "albumCount": "Nombre d'àlbums", + "songCount": "Nombre de cançons", + "playCount": "Reproduccions", + "rating": "Valoració", + "genre": "Gènere", + "size": "Mida", + "role": "Rol", + "missing": "Desaparegut" + }, + "roles": { + "albumartist": "Artista de l'Àlbum |||| Artistes de l'Àlbum", + "artist": "Artista |||| Artistes", + "composer": "Compositor |||| Compositors", + "conductor": "Director |||| Directors", + "lyricist": "Lletrista |||| Lletristes", + "arranger": "Arranjador |||| Arranjadors", + "producer": "Productor |||| Productors", + "director": "Director |||| Directors", + "engineer": "Enginyer |||| Enginyers", + "mixer": "Mesclador |||| Mescladors", + "remixer": "Remesclador |||| Remescladors", + "djmixer": "Mesclador DJ |||| Mescladors DJ", + "performer": "Intèrpret |||| Intèrprets", + "maincredit": "Artista de l'àlbum or Artista |||| Artistes de l'àlbum or Artistes" + }, + "actions": { + "shuffle": "Barreja", + "radio": "Ràdio", + "topSongs": "Cançons populars" + } + }, + "user": { + "name": "Usuari |||| Usuaris", + "fields": { + "userName": "Nom d'usuari", + "isAdmin": "És admin", + "lastLoginAt": "Última connexió", + "updatedAt": "Actualitzat", + "name": "Nom", + "password": "Contrasenya", + "createdAt": "Creat", + "changePassword": "Canviar la contrasenya?", + "currentPassword": "Contrasenya actual", + "newPassword": "Contrasenya nova", + "token": "Token", + "lastAccessAt": "Últim accés", + "libraries": "Biblioteques" + }, + "helperTexts": { + "name": "Els canvis en el nom s'hi aplicaran en la següent connexió", + "libraries": "Seleccioneu biblioteques específiques per a aquest usuari o deixeu-ho buit per utilitzar les biblioteques predeterminades" + }, + "notifications": { + "created": "Usuari creat", + "updated": "Usuari actualitzat", + "deleted": "Usuari eliminat" + }, + "message": { + "listenBrainzToken": "Introduïu el vostre token d'usuari de ListenBrainz", + "clickHereForToken": "Feu clic ací per a obtenir el vostre token", + "selectAllLibraries": "Selecciona totes les biblioteques", + "adminAutoLibraries": "Els administradors tenen accés a totes les biblioteques automàticament" + }, + "validation": { + "librariesRequired": "Cal que trieu almenys una biblioteca per als usuaris que no siguin administradors" + } + }, + "player": { + "name": "Reproductor |||| Reproductors", + "fields": { + "name": "Nom", + "transcodingId": "Transcodificador", + "maxBitRate": "Taxa de bits màx.", + "client": "Client", + "userName": "Nom d'usuari", + "lastSeen": "Vist", + "reportRealPath": "Informa de la ruta real", + "scrobbleEnabled": "Activa el seguiment des de serveis externs" + } + }, + "transcoding": { + "name": "Transcodificador |||| Transcodificadors", + "fields": { + "name": "Nom", + "targetFormat": "Format desitjat", + "defaultBitRate": "Taxa de bits per defecte", + "command": "Ordre" + } + }, + "playlist": { + "name": "Llista |||| Llistes", + "fields": { + "name": "Nom", + "duration": "Durada", + "ownerName": "Propietari", + "public": "Públic", + "updatedAt": "Actualitzat ", + "createdAt": "Creat", + "songCount": "Cançons", + "comment": "Comentari", + "sync": "Auto-importació", + "path": "Importa de" + }, + "actions": { + "selectPlaylist": "Selecciona una llista:", + "addNewPlaylist": "Crea \"%{nom}", + "export": "Exporta", + "makePublic": "Fes públic", + "makePrivate": "Fes privat", + "saveQueue": "Desar la cua a una llista", + "searchOrCreate": "Cerca llistes o escriu per crear-ne de noves...", + "pressEnterToCreate": "Prem Retorn per crear una nova llista", + "removeFromSelection": "Elimina de la selecció" + }, + "message": { + "duplicate_song": "Afegeix cançons duplicades", + "song_exist": "Heu afegit duplicats a la llista. Voleu afegir-los o ignorar-los?", + "noPlaylistsFound": "No s'ha trobat cap llista", + "noPlaylists": "No hi ha cap llista disponible" + } + }, + "radio": { + "name": "Ràdio |||| Ràdios", + "fields": { + "name": "Nom", + "streamUrl": "URL del flux", + "homePageUrl": "URL principal", + "updatedAt": "Actualitzat", + "createdAt": "Creat" + }, + "actions": { + "playNow": "Reprodueix" + } + }, + "share": { + "name": "Compartir |||| Compartits", + "fields": { + "username": "Compartit per", + "url": "URL", + "description": "Descripció", + "contents": "Continguts", + "expiresAt": "Caduca", + "lastVisitedAt": "Última Visita", + "visitCount": "Visites", + "format": "Format", + "maxBitRate": "Taxa de bits màx.", + "updatedAt": "Actualitzat", + "createdAt": "Creat", + "downloadable": "Permet descarregar?" + } + }, + "missing": { "name": "Fitxer faltant |||| Fitxers Faltants", - "empty": "No falten fitxers", "fields": { "path": "Directori", "size": "Mida", - "updatedAt": "Desaparegut" + "updatedAt": "Desaparegut", + "libraryName": "Biblioteca" }, "actions": { - "remove": "Eliminar" + "remove": "Eliminar", + "remove_all": "Suprimeix-ho tot" }, "notifications": { "removed": "Fitxers faltants eliminats" + }, + "empty": "No falten fitxers" + }, + "library": { + "name": "Biblioteca |||| Biblioteques\n", + "fields": { + "name": "Nom", + "path": "Camí", + "remotePath": "Camí remot", + "lastScanAt": "Últim escaneig", + "songCount": "Cançons", + "albumCount": "Àlbums", + "artistCount": "Artistes", + "totalSongs": "Cançons", + "totalAlbums": "Àlbums", + "totalArtists": "Artistes", + "totalFolders": "Carpetes", + "totalFiles": "Fitxers", + "totalMissingFiles": "Fitxers desapareguts", + "totalSize": "Mida total", + "totalDuration": "Durada", + "defaultNewUsers": "Predeterminat per a usuaris nous", + "createdAt": "Creat", + "updatedAt": "Actualitzat" + }, + "sections": { + "basic": "Informació bàsica", + "statistics": "Estadístiques" + }, + "actions": { + "scan": "Escaneja la biblioteca", + "manageUsers": "Gestiona l'accés d'usuari", + "viewDetails": "Mostra els detalls", + "quickScan": "Escaneig ràpid", + "fullScan": "Escaneig complet" + }, + "notifications": { + "created": "La biblioteca s'ha creat correctament", + "updated": "La biblioteca s'ha actualitzat correctament", + "deleted": "La biblioteca s'ha suprimit correctament", + "scanStarted": "Començant l'escaneig de la biblioteca", + "scanCompleted": "S'ha completat l'escaneig de la biblioteca", + "quickScanStarted": "Començant escaneig ràpid", + "fullScanStarted": "Començant escaneig complet", + "scanError": "S'ha produït un error en començar l'escaneig. Comproveu els registres" + }, + "validation": { + "nameRequired": "Es requereix un nom per la biblioteca", + "pathRequired": "Es requereix un camí a la biblioteca", + "pathNotDirectory": "El camí a la biblioteca ha de ser un directori", + "pathNotFound": "No s'ha trobat el camí a la biblioteca", + "pathNotAccessible": "No es pot accedir al camí de la biblioteca ", + "pathInvalid": "Camí a la llibreria no vàlid" + }, + "messages": { + "deleteConfirm": "Esteu segur que voleu suprimir aquesta biblioteca? Se'n suprimiran totes les dades associades i els accessos d'usuari.", + "scanInProgress": "Escaneig en curs...", + "noLibrariesAssigned": "Aquest usuari no té cap biblioteca assignada" + } + }, + "plugin": { + "name": "\nConnector |||| Connectors", + "fields": { + "id": "ID", + "name": "Nom", + "description": "Descripció", + "version": "Versió", + "author": "Autor", + "website": "Lloc web", + "permissions": "Permissos", + "enabled": "Activat", + "status": "Estat", + "path": "Camí", + "lastError": "Error", + "hasError": "Error", + "updatedAt": "Actualitzat", + "createdAt": "Instal·lat", + "configKey": "Clau", + "configValue": "Valor", + "allUsers": "Permet tots els usuaris", + "selectedUsers": "Usuaris seleccionats", + "allLibraries": "Permet totes les llibreries", + "selectedLibraries": "Biblioteques seleccionades", + "allowWriteAccess": "" + }, + "sections": { + "status": "Estat", + "info": "Informació del controlador", + "configuration": "Configuració", + "manifest": "Manifest", + "usersPermission": "Permís dels usuaris", + "libraryPermission": "Permís de la llibreria" + }, + "status": { + "enabled": "Activat", + "disabled": "Desactivat" + }, + "actions": { + "enable": "Activa", + "disable": "Desactiva", + "disabledDueToError": "Arregleu l'error abans de l'activació", + "disabledUsersRequired": "Seleccioneu els usuaris abans de l'activació", + "disabledLibrariesRequired": "Seleccioneu les biblioteques abans de l'activació", + "addConfig": "Afegeix una configuració", + "rescan": "Torna a escanejar" + }, + "notifications": { + "enabled": "Controlador activat", + "disabled": "Controlador desactivat", + "updated": "Controlador activat", + "error": "S'ha produït un error en actualitzar el controlador" + }, + "validation": { + "invalidJson": "El fitxer Configuració ha de ser un JSON vàlid" + }, + "messages": { + "configHelp": "Configureu el controlador utilitzant parelles clau-valor. Deixeu-ho buit si el controlador no requereix cap configuració.", + "clickPermissions": "Feu clic en un permís per veure’n els detalls", + "noConfig": "No s'ha establert cap configuració", + "allUsersHelp": "Quan està activat, el controlador té accés a tots els usuaris, inclosos els creats a posteriori.", + "noUsers": "No s'ha seleccionat cap usuari", + "permissionReason": "Motiu", + "usersRequired": "Aquest controlador necessita accedir a la informació de la biblioteca. Selecciona a quines biblioteques pot accedir o activa «Permet tots els usuaris».", + "allLibrariesHelp": "Quan està activat, el controlador té accés a totes les llibreries, incloses les creades a posteriori.", + "noLibraries": "No s'ha seleccionat cap biblioteca", + "librariesRequired": "Aquest controlador necessita accedir a la informació de la biblioteca. Selecciona a quines biblioteques pot accedir o activa «Permet totes les biblioteques».", + "requiredHosts": "Hosts requerits", + "configValidationError": "Ha fallat la validació de la configuració:", + "schemaRenderError": "No s'ha pogut renderitzar el formulari de configuració. És possible que l'esquema del controlador sigui invàlid.", + "allowWriteAccessHelp": "" + }, + "placeholders": { + "configKey": "clau", + "configValue": "valor" } } }, - "ra": { - "auth": { - "welcome1": "Gràcies d'haver instal·lat Navidrome!", - "welcome2": "Per a començar, creeu un usuari administrador", - "confirmPassword": "Confirmeu la contrasenya", - "buttonCreateAdmin": "Crea un administrador", - "auth_check_error": "Si us plau, inicieu sessió per a continuar", - "user_menu": "Perfil", - "username": "Nom d'usuari", - "password": "Contrasenya", - "sign_in": "Inicia sessió", - "sign_in_error": "L'autenticació ha fallat, torneu-ho a intentar", - "logout": "Sortida", - "insightsCollectionNote": "Navidrome recull dades d'us anonimitzades per\najudar a millorar el projecte. Clica [aquí] per a saber-ne\nmés i no participar-hi si no vols" - }, - "validation": { - "invalidChars": "Si us plau, useu només lletres i nombres", - "passwordDoesNotMatch": "Les contrasenyes no coincideixen", - "required": "Obligatori", - "minLength": "Ha de tenir, si més no, %{min} caràcters", - "maxLength": "Ha de tenir %{max} caràcters o menys", - "minValue": "Ha de ser com a mínim %{min}", - "maxValue": "Ha de ser %{max} o menys", - "number": "Ha de ser un nombre", - "email": "Ha de ser un correu vàlid", - "oneOf": "Ha de ser un de: %{options}", - "regex": "Ha de tenir el format (regexp): %{pattern}", - "unique": "Ha de ser únic", - "url": "Ha de ser una URL vàlida" - }, - "action": { - "add_filter": "Afegeix un filtre", - "add": "Afegeix", - "back": "Enrere", - "bulk_actions": "1 element seleccionat |||| %{smart_count} elements seleccionats", - "bulk_actions_mobile": "1 |||| %{smart_count}", - "cancel": "Cancel·la", - "clear_input_value": "Neteja el valor", - "clone": "Clona", - "confirm": "Confirma", - "create": "Crea", - "delete": "Suprimeix", - "edit": "Edita", - "export": "Exporta", - "list": "Llista", - "refresh": "Refresca", - "remove_filter": "Suprimeix aquest filtre", - "remove": "Elimina", - "save": "Desa", - "search": "Cerca", - "show": "Mostra", - "sort": "Ordena", - "undo": "Desfés", - "expand": "Expandeix", - "close": "Tanca", - "open_menu": "Obre el menú", - "close_menu": "Tanca el menú", - "unselect": "Anul·la la selecció", - "skip": "Omet", - "share": "Compartir", - "download": "Descarregar" - }, - "boolean": { - "true": "Sí", - "false": "No" - }, - "page": { - "create": "Crea %{nom}", - "dashboard": "Tauler", - "edit": "%{name} #%{id}", - "error": "Alguna cosa ha fallat", - "list": "%{name}", - "loading": "Ara es carrega", - "not_found": "No s'ha trobat", - "show": "%{name} #%{id}", - "empty": "No hi ha %{name} encara.", - "invite": "Voleu afegir-ne una?" - }, - "input": { - "file": { - "upload_several": "Deixeu caure-hi fitxers per a carregar-los o feu clic per a seleccionar-ne un.", - "upload_single": "Deixeu caure-hi un fitxer per a carregar o feu clic per a seleccionar-lo." - }, - "image": { - "upload_several": "Deixeu caure-hi imatges per a carregar-les o feu clic per a seleccionar-ne una.", - "upload_single": "Deixeu caure-hi una imatge per a carregar-la o feu clic per a seleccionar-la." - }, - "references": { - "all_missing": "No ha estat possible trobar les dades de referència.", - "many_missing": "Sembla que almenys una de les referències associades ja no està disponible.", - "single_missing": "Sembla que la referència associada ja no està disponible." - }, - "password": { - "toggle_visible": "Amaga la contrasenya", - "toggle_hidden": "Mostra la contrasenya" - } - }, - "message": { - "about": "Quant a...", - "are_you_sure": "N'esteu segur?", - "bulk_delete_content": "Voleu eliminar aquest %{name}? |||| Voleu eliminar aquests %{smart_count} element?\n", - "bulk_delete_title": "Esborra %{name} |||| Esborra %{smart_count} %{name}", - "delete_content": "Segur que voleu eliminar aquest element?", - "delete_title": "Elimina %{name} #%{id}", - "details": "Detalls", - "error": "S'ha produït un error en un client i la vostra sol·licitud no ha pogut ser completada.", - "invalid_form": "El formulari no és vàlid.", - "loading": "La pàgina es carrega, un moment si us plau.", - "no": "No", - "not_found": "La URL és incorrecta o heu seguit un enllaç erroni.", - "yes": "Sí", - "unsaved_changes": "Alguns canvis no s'hi han desat. Segur que voleu ignorar-los?" - }, - "navigation": { - "no_results": "No s'ha trobat", - "no_more_results": "La pàgina número %{page} no existeix. Proveu l'anterior.", - "page_out_of_boundaries": "La pàgina número %{page} no existeix", - "page_out_from_end": "No podeu anar més enllà de la darrera pàgina", - "page_out_from_begin": "No podeu anar més enllà de la primera pàgina", - "page_range_info": "%{offsetBegin}-%{offsetEnd} de %{total}", - "page_rows_per_page": "Elements per pàgina:", - "next": "Següent", - "prev": "Anterior", - "skip_nav": "Salta al contingut" - }, - "notification": { - "updated": "Element actualitzat |||| %{smart_count} elements actualitzats", - "created": "Element creat", - "deleted": "Element actualitzat |||| %{smart_count} elements actualitzats", - "bad_item": "Element incorrecte", - "item_doesnt_exist": "L'element no existeix", - "http_error": "Error de comunicació del servidor", - "data_provider_error": "dataProvider error. Vegeu la consola si en voleu més detalls.", - "i18n_error": "No ha estat possible carregar les traduccions per a l'idioma indicat", - "canceled": "Acció cancel·lada", - "logged_out": "La sessió ha acabat, si us plau reconnecteu", - "new_version": "Hi ha una versió nova disponible! Si us plau actualitzeu aquesta finestra." - }, - "toggleFieldsMenu": { - "columnsToDisplay": "Columnes a mostrar", - "layout": "Disposició", - "grid": "Quadrícula", - "table": "Taula" - } + "ra": { + "auth": { + "welcome1": "Gràcies d'haver instal·lat Navidrome!", + "welcome2": "Per a començar, creeu un usuari administrador", + "confirmPassword": "Confirmeu la contrasenya", + "buttonCreateAdmin": "Crea un administrador", + "auth_check_error": "Si us plau, inicieu sessió per a continuar", + "user_menu": "Perfil", + "username": "Nom d'usuari", + "password": "Contrasenya", + "sign_in": "Inicia sessió", + "sign_in_error": "L'autenticació ha fallat, torneu-ho a intentar", + "logout": "Sortida", + "insightsCollectionNote": "Navidrome recull dades d'us anonimitzades per\najudar a millorar el projecte. Clica [aquí] per a saber-ne\nmés i no participar-hi si no vols" + }, + "validation": { + "invalidChars": "Si us plau, utilitzeu només lletres i nombres", + "passwordDoesNotMatch": "Les contrasenyes no coincideixen", + "required": "Obligatori", + "minLength": "Ha de tenir, si més no, %{min} caràcters", + "maxLength": "Ha de tenir %{max} caràcters o menys", + "minValue": "Ha de ser com a mínim %{min}", + "maxValue": "Ha de ser %{max} o menys", + "number": "Ha de ser un nombre", + "email": "Ha de ser un correu vàlid", + "oneOf": "Ha de ser un de: %{options}", + "regex": "Ha de tenir el format (regexp): %{pattern}", + "unique": "Ha de ser únic", + "url": "Ha de ser una URL vàlida" + }, + "action": { + "add_filter": "Afegeix un filtre", + "add": "Afegeix", + "back": "Enrere", + "bulk_actions": "1 element seleccionat |||| %{smart_count} elements seleccionats", + "cancel": "Cancel·la", + "clear_input_value": "Neteja el valor", + "clone": "Clona", + "confirm": "Confirma", + "create": "Crea", + "delete": "Suprimeix", + "edit": "Edita", + "export": "Exporta", + "list": "Llista", + "refresh": "Refresca", + "remove_filter": "Suprimeix aquest filtre", + "remove": "Elimina", + "save": "Desa", + "search": "Cerca", + "show": "Mostra", + "sort": "Ordena", + "undo": "Desfés", + "expand": "Expandeix", + "close": "Tanca", + "open_menu": "Obre el menú", + "close_menu": "Tanca el menú", + "unselect": "Anul·la la selecció", + "skip": "Omet", + "bulk_actions_mobile": "1 |||| %{smart_count}", + "share": "Compartir", + "download": "Descarregar" + }, + "boolean": { + "true": "Sí", + "false": "No" + }, + "page": { + "create": "Crea %{nom}", + "dashboard": "Tauler", + "edit": "%{name} #%{id}", + "error": "Alguna cosa ha fallat", + "list": "%{name}", + "loading": "Ara es carrega", + "not_found": "No s'ha trobat", + "show": "%{name} #%{id}", + "empty": "No hi ha %{name} encara.", + "invite": "Voleu afegir-ne una?" + }, + "input": { + "file": { + "upload_several": "Deixeu caure-hi fitxers per a carregar-los o feu clic per a seleccionar-ne un.", + "upload_single": "Deixeu caure-hi un fitxer per a carregar o feu clic per a seleccionar-lo." + }, + "image": { + "upload_several": "Deixeu caure-hi imatges per a carregar-les o feu clic per a seleccionar-ne una.", + "upload_single": "Deixeu caure-hi una imatge per a carregar-la o feu clic per a seleccionar-la." + }, + "references": { + "all_missing": "No ha estat possible trobar les dades de referència.", + "many_missing": "Sembla que almenys una de les referències associades ja no està disponible.", + "single_missing": "Sembla que la referència associada ja no està disponible." + }, + "password": { + "toggle_visible": "Amaga la contrasenya", + "toggle_hidden": "Mostra la contrasenya" + } }, "message": { - "note": "NOTA", - "transcodingDisabled": "Per motius de seguretat, el canvi de configuració del trasnscodificador amb la interfície web no està habilitat. Si voleu canviar les opcions de transcodificació (sia editar-les sia afegir-ne), reinicieu el servidor amb l'opció %{config}.", - "transcodingEnabled": "Ara Navidrome s'executa amb %{config}, cosa que fa possible executar ordres del sistema des de les opcions de transcodificació usant la interfície web. Per motius de seguretat us recomanem que només l'activeu quan necessiteu configurar les opcions de transcodificació.", - "songsAddedToPlaylist": "S'ha afegit 1 cançó a la llista |||| S'han afegit %{smart_count} a la llista", - "noPlaylistsAvailable": "No n'hi ha cap disponible", - "delete_user_title": "Esborra usuari '%{nom}'", - "delete_user_content": "Segur que voleu eliminar aquest usuari i les seues dades\n(incloent-hi llistes i preferències)", - "remove_missing_title": "Eliminar fitxers faltants", - "remove_missing_content": "Segur que vols eliminar els fitxers faltants seleccionats de la base de dades? Això eliminarà permanentment les referències a ells, incloent-hi el nombre de reproduccions i les valoracions.", - "notifications_blocked": "Heu blocat les notificacions d'escriptori en les preferències del navegador", - "notifications_not_available": "El navegador no suporta les notificacions o no heu connectat a Navidrome per https", - "lastfmLinkSuccess": "Ha reexit la vinculació amb Last.fm i se n'ha activat el seguiment", - "lastfmLinkFailure": "No ha estat possible la vinculació amb Last.fm", - "lastfmUnlinkSuccess": "Desvinculat de Last.fm i desactivat el seguiment", - "lastfmUnlinkFailure": "No s'ha pogut desvincular de Last.fm", - "listenBrainzLinkSuccess": "Connectat correctament a ListenBrainz i seguiment activat com a: %{user}", - "listenBrainzLinkFailure": "No s'ha pogut connectar a ListenBrainz: %{error}", - "listenBrainzUnlinkSuccess": "ListenBrainz desconnectat i seguiment desactivat", - "listenBrainzUnlinkFailure": "No s'ha pogut desconnectar de ListenBrainz", - "openIn": { - "lastfm": "Obri en Last.fm", - "musicbrainz": "Obri en MusicBrainz" - }, - "lastfmLink": "Llegeix més...", - "shareOriginalFormat": "Compartir en format original", - "shareDialogTitle": "Compartir %{resource} '%{name}'", - "shareBatchDialogTitle": "Compartir 1 %{resource} |||| Compartir %{smart_count} %{resource}", - "shareCopyToClipboard": "Copiar al porta-retalls: Ctrl+C, Enter", - "shareSuccess": "URL copiada al porta-retalls: %{url}", - "shareFailure": "Error copiant URL %{url} al porta-retalls", - "downloadDialogTitle": "Deascarregar %{resource} '%{name}' (%{size})", - "downloadOriginalFormat": "Descarregar en format original" + "about": "Quant a...", + "are_you_sure": "N'esteu segur?", + "bulk_delete_content": "Voleu eliminar aquest %{name}? |||| Voleu eliminar aquests %{smart_count} element?\n", + "bulk_delete_title": "Esborra %{name} |||| Esborra %{smart_count} %{name}", + "delete_content": "Segur que voleu eliminar aquest element?", + "delete_title": "Elimina %{name} #%{id}", + "details": "Detalls", + "error": "S'ha produït un error en un client i la vostra sol·licitud no ha pogut ser completada.", + "invalid_form": "El formulari no és vàlid.", + "loading": "La pàgina es carrega, un moment si us plau.", + "no": "No", + "not_found": "La URL és incorrecta o heu seguit un enllaç erroni.", + "yes": "Sí", + "unsaved_changes": "Alguns canvis no s'hi han desat. Segur que voleu ignorar-los?" }, - "menu": { - "library": "Discoteca", - "settings": "Configuració", - "version": "Versió", - "theme": "Tema", - "personal": { - "name": "Personal", - "options": { - "theme": "Tema", - "language": "Llengua", - "defaultView": "Vista per defecte", - "desktop_notifications": "Notificacions d'escriptori", - "lastfmNotConfigured": "No s'ha configurat l'API de Last.fm", - "lastfmScrobbling": "Activa el seguiment de Last.fm", - "listenBrainzScrobbling": "Activa el seguiment de ListenBrainz", - "replaygain": "Mode ReplayGain", - "preAmp": "PreAmp de ReplayGain (dB)", - "gain": { - "none": "Cap", - "album": "Guany de l'àlbum", - "track": "Guany de la pista" - } - } - }, - "albumList": "Àlbums", - "about": "Quant a...", - "playlists": "Llistes", - "sharedPlaylists": "Llistes compartides" + "navigation": { + "no_results": "No s'ha trobat", + "no_more_results": "La pàgina número %{page} no existeix. Proveu l'anterior.", + "page_out_of_boundaries": "La pàgina número %{page} no existeix", + "page_out_from_end": "No podeu anar més enllà de la darrera pàgina", + "page_out_from_begin": "No podeu anar més enllà de la primera pàgina", + "page_range_info": "%{offsetBegin}-%{offsetEnd} de %{total}", + "page_rows_per_page": "Elements per pàgina:", + "next": "Següent", + "prev": "Anterior", + "skip_nav": "Salta al contingut" }, - "player": { - "playListsText": "Reprodueix la cua", - "openText": "Obre", - "closeText": "Tanca", - "notContentText": "No hi ha música", - "clickToPlayText": "Feu clic per a reproduir", - "clickToPauseText": "Feu clic per a posar en pausa", - "nextTrackText": "Pista següent", - "previousTrackText": "Pista anterior", - "reloadText": "Recarrega", - "volumeText": "Volum", - "toggleLyricText": "Activa / desactiva lletra", - "toggleMiniModeText": "Minimitza", - "destroyText": "Destrueix", - "downloadText": "Descarrega", - "removeAudioListsText": "Elimina llistes d'àudio", - "clickToDeleteText": "Feu clic per a eliminar %{name}", - "emptyLyricText": "Sense lletra", - "playModeText": { - "order": "En ordre", - "orderLoop": "Repeteix", - "singleLoop": "Repeteix una vegada", - "shufflePlay": "Aleatori" - } + "notification": { + "updated": "Element actualitzat |||| %{smart_count} elements actualitzats", + "created": "Element creat", + "deleted": "Element actualitzat |||| %{smart_count} elements actualitzats", + "bad_item": "Element incorrecte", + "item_doesnt_exist": "L'element no existeix", + "http_error": "Error de comunicació del servidor", + "data_provider_error": "dataProvider error. Vegeu la consola si en voleu més detalls.", + "i18n_error": "No ha estat possible carregar les traduccions per a l'idioma indicat", + "canceled": "Acció cancel·lada", + "logged_out": "La sessió ha acabat, si us plau reconnecteu", + "new_version": "Hi ha una versió nova disponible! Si us plau actualitzeu aquesta finestra." }, - "about": { - "links": { - "homepage": "Inici", - "source": "Codi font", - "featureRequests": "Sol·licitud de funcionalitats", - "lastInsightsCollection": "Última recolecció d'informació", - "insights": { - "disabled": "Desactivada", - "waiting": "Esperant" - } - } - }, - "activity": { - "title": "Activitat", - "totalScanned": "Carpetes escanejades en total", - "quickScan": "Escaneig ràpid", - "fullScan": "Escaneig complet", - "serverUptime": "Temps de funcionament del servidor", - "serverDown": "Sense connexió" - }, - "help": { - "title": "Dreceres de teclat de Navidrome", - "hotkeys": { - "show_help": "Mostra aquesta ajuda", - "toggle_menu": "Commuta la barra lateral", - "toggle_play": "Reprodueix / Pausa", - "prev_song": "Cançó anterior", - "next_song": "Cançó següent", - "vol_up": "Apuja el volum", - "vol_down": "Abaixa el volum", - "toggle_love": "Afegeix la pista a favorits", - "current_song": "Anar a la cançó actual" - } + "toggleFieldsMenu": { + "columnsToDisplay": "Columnes a mostrar", + "layout": "Disposició", + "grid": "Quadrícula", + "table": "Taula" } + }, + "message": { + "note": "NOTA", + "transcodingDisabled": "Per motius de seguretat, el canvi de configuració del transcodificador amb la interfície web està desactivat. Si voleu canviar les opcions de transcodificació (sia editar-les sia afegir-ne), reinicieu el servidor amb l'opció %{config}.", + "transcodingEnabled": "Navidrome s'executa amb %{config}, cosa que fa possible executar ordres del sistema des de les opcions de transcodificació usant la interfície web. Per motius de seguretat us recomanem que només l'activeu quan necessiteu configurar les opcions de transcodificació.", + "songsAddedToPlaylist": "S'ha afegit 1 cançó a la llista |||| S'han afegit %{smart_count} a la llista", + "noPlaylistsAvailable": "No n'hi ha cap disponible", + "delete_user_title": "Esborra usuari '%{nom}'", + "delete_user_content": "Segur que voleu eliminar aquest usuari i les seues dades\n(incloent-hi llistes i preferències)", + "notifications_blocked": "Heu blocat les notificacions d'escriptori en les preferències del navegador", + "notifications_not_available": "El navegador no és compatible amb les notificacions o no us heu connectat a Navidrome per https", + "lastfmLinkSuccess": "Ha reexit la vinculació amb Last.fm i se n'ha activat el seguiment", + "lastfmLinkFailure": "No ha estat possible la vinculació amb Last.fm", + "lastfmUnlinkSuccess": "Desvinculat de Last.fm i desactivat el seguiment", + "lastfmUnlinkFailure": "No s'ha pogut desvincular de Last.fm", + "openIn": { + "lastfm": "Obri en Last.fm", + "musicbrainz": "Obri en MusicBrainz" + }, + "lastfmLink": "Llegeix més...", + "listenBrainzLinkSuccess": "Connectat correctament a ListenBrainz i seguiment activat com a: %{user}", + "listenBrainzLinkFailure": "No s'ha pogut connectar a ListenBrainz: %{error}", + "listenBrainzUnlinkSuccess": "ListenBrainz desconnectat i seguiment desactivat", + "listenBrainzUnlinkFailure": "No s'ha pogut desconnectar de ListenBrainz", + "downloadOriginalFormat": "Descarregar en el format original", + "shareOriginalFormat": "Compartir en format original", + "shareDialogTitle": "Compartir %{resource} '%{name}'", + "shareBatchDialogTitle": "Compartir 1 %{resource} |||| Compartir %{smart_count} %{resource}", + "shareSuccess": "URL copiada al porta-retalls: %{url}", + "shareFailure": "Error copiant URL %{url} al porta-retalls", + "downloadDialogTitle": "Deascarregar %{resource} '%{name}' (%{size})", + "shareCopyToClipboard": "Copiar al porta-retalls: Ctrl+C, Enter", + "remove_missing_title": "Eliminar fitxers faltants", + "remove_missing_content": "Segur que vols eliminar els fitxers faltants seleccionats de la base de dades? Això eliminarà permanentment les referències a ells, incloent-hi el nombre de reproduccions i les valoracions.", + "remove_all_missing_title": "Suprimir tots els fitxers perduts", + "remove_all_missing_content": "Esteu segur que voleu eliminar tots els fitxers desapareguts de la base de dades? Se n'eliminarà permanentment qualsevol referència, inclosos el nombre de reproduccions i les puntuacions.", + "noSimilarSongsFound": "No s'ha trobat cap cançó similar", + "noTopSongsFound": "No s'ha trobat cap cançó popular", + "startingInstantMix": "S'està carregant la mescla immediata..." + }, + "menu": { + "library": "Biblioteca", + "settings": "Configuració", + "version": "Versió", + "theme": "Tema", + "personal": { + "name": "Personal", + "options": { + "theme": "Tema", + "language": "Llengua", + "defaultView": "Vista per defecte", + "desktop_notifications": "Notificacions d'escriptori", + "lastfmScrobbling": "Activa el seguiment de Last.fm", + "listenBrainzScrobbling": "Activa el seguiment de ListenBrainz", + "replaygain": "Mode ReplayGain", + "preAmp": "PreAmp de ReplayGain (dB)", + "gain": { + "none": "Cap", + "album": "Guany de l'àlbum", + "track": "Guany de la pista" + }, + "lastfmNotConfigured": "No s'ha configurat l'API de Last.fm" + } + }, + "albumList": "Àlbums", + "about": "Quant a...", + "playlists": "Llistes", + "sharedPlaylists": "Llistes compartides", + "librarySelector": { + "allLibraries": "Totes les llibreries (%{count})", + "multipleLibraries": "%{selected} de %{total} Biblioteques", + "selectLibraries": "Selecciona les biblioteques", + "none": "Cap" + } + }, + "player": { + "playListsText": "Reprodueix la cua", + "openText": "Obre", + "closeText": "Tanca", + "notContentText": "No hi ha música", + "clickToPlayText": "Feu clic per a reproduir", + "clickToPauseText": "Feu clic per a posar en pausa", + "nextTrackText": "Pista següent", + "previousTrackText": "Pista anterior", + "reloadText": "Recarrega", + "volumeText": "Volum", + "toggleLyricText": "Activa / desactiva lletra", + "toggleMiniModeText": "Minimitza", + "destroyText": "Destrueix", + "downloadText": "Descarrega", + "removeAudioListsText": "Elimina llistes d'àudio", + "clickToDeleteText": "Feu clic per a eliminar %{name}", + "emptyLyricText": "Sense lletra", + "playModeText": { + "order": "En ordre", + "orderLoop": "Repeteix", + "singleLoop": "Repeteix una vegada", + "shufflePlay": "Aleatori" + } + }, + "about": { + "links": { + "homepage": "Inici", + "source": "Codi font", + "featureRequests": "Sol·licita funcionalitats", + "lastInsightsCollection": "Última recolecció d'informació", + "insights": { + "disabled": "Desactivada", + "waiting": "Esperant" + } + }, + "tabs": { + "about": "Quant a", + "config": "Configuració" + }, + "config": { + "configName": "Nom de Config", + "environmentVariable": "Variable d'entorn", + "currentValue": "Valor actual", + "configurationFile": "Fitxer de configuració", + "exportToml": "Exporta la configuració (TOML)", + "exportSuccess": "Configuració exportada al porta-retalls en format TOML", + "exportFailed": "La còpia de la configuració ha fallat", + "devFlagsHeader": "Indicadors de desenvolupament (subjecte a canvis o eliminació)", + "devFlagsComment": "Aquests paràmetres són experimentals i és possible que s'eliminin en versions futures", + "downloadToml": "Descarrega la configuració (TOML)" + } + }, + "activity": { + "title": "Activitat", + "totalScanned": "Carpetes escanejades en total", + "quickScan": "Escaneig ràpid", + "fullScan": "Escaneig complet", + "serverUptime": "Temps de funcionament del servidor", + "serverDown": "Sense connexió", + "scanType": "Últim escaneig", + "status": "Error d'escaneig", + "elapsedTime": "Temps transcorregut", + "selectiveScan": "Selectiu" + }, + "help": { + "title": "Dreceres de teclat de Navidrome", + "hotkeys": { + "show_help": "Mostra aquesta ajuda", + "toggle_menu": "Commuta la barra lateral", + "toggle_play": "Reprodueix / Pausa", + "prev_song": "Cançó anterior", + "next_song": "Cançó següent", + "vol_up": "Apuja el volum", + "vol_down": "Abaixa el volum", + "toggle_love": "Afegeix la pista a favorits", + "current_song": "Anar a la cançó actual" + } + }, + "nowPlaying": { + "title": "Està sonant", + "empty": "No s'està reproduint res", + "minutesAgo": "Fa %{smart_count} minut |||| Fa %{smart_count} minuts" + } } diff --git a/resources/i18n/da.json b/resources/i18n/da.json index 105a20732..a47b30bbc 100644 --- a/resources/i18n/da.json +++ b/resources/i18n/da.json @@ -36,7 +36,9 @@ "bitDepth": "Bitdybde", "sampleRate": "Samplingfrekvens", "missing": "Manglende", - "libraryName": "Bibliotek" + "libraryName": "Bibliotek", + "composer": "Komponist", + "disc": "" }, "actions": { "addToQueue": "Afspil senere", @@ -46,7 +48,8 @@ "download": "Download", "playNext": "Afspil næste", "info": "Hent info", - "showInPlaylist": "Vis i afspilningsliste" + "showInPlaylist": "Vis i afspilningsliste", + "instantMix": "Instant Mix" } }, "album": { @@ -83,7 +86,7 @@ "actions": { "playAll": "Afspil", "playNext": "Afspil næste", - "addToQueue": "Afspil senere", + "addToQueue": "Føj til kø", "shuffle": "Bland", "addToPlaylist": "Føj til afspilningsliste", "download": "Download", @@ -301,14 +304,19 @@ "actions": { "scan": "Scanningsbibliotek", "manageUsers": "Administrer brugeradgang", - "viewDetails": "Se detaljer" + "viewDetails": "Se detaljer", + "quickScan": "hurtig skanning", + "fullScan": "Fuld skanning" }, "notifications": { "created": "Bibliotek oprettet", "updated": "Biblioteket er blevet opdateret", "deleted": "Biblioteket er blevet slettet", "scanStarted": "Biblioteksscanning startet", - "scanCompleted": "Biblioteksscanning fuldført" + "scanCompleted": "Biblioteksscanning fuldført", + "quickScanStarted": "hurtig skanning startet", + "fullScanStarted": "Fuld skanning startet", + "scanError": "Kan ikke starte skanning. Tjek loggen" }, "validation": { "nameRequired": "Biblioteksnavn er påkrævet", @@ -323,6 +331,82 @@ "scanInProgress": "Scanning i gang...", "noLibrariesAssigned": "Ingen biblioteker tildelt denne bruger" } + }, + "plugin": { + "name": "Plugin |||| Plugins", + "fields": { + "id": "ID", + "name": "Navn", + "description": "Beskrivelse", + "version": "Version", + "author": "Forfatter", + "website": "Hjemmeside", + "permissions": "Tilladelser", + "enabled": "Aktiveret", + "status": "Status", + "path": "Sti", + "lastError": "Fejl", + "hasError": "Fejl", + "updatedAt": "Opdateret", + "createdAt": "Installeret", + "configKey": "Nøgle", + "configValue": "Værdi", + "allUsers": "Tillad alle brugere", + "selectedUsers": "Valgte brugere", + "allLibraries": "Tillad alle biblioteker", + "selectedLibraries": "Valgte biblioteker", + "allowWriteAccess": "" + }, + "sections": { + "status": "Status", + "info": "Pluginoplysninger", + "configuration": "Konfiguration", + "manifest": "Manifest", + "usersPermission": "Brugertilladelse", + "libraryPermission": "Bibliotekstilladelse" + }, + "status": { + "enabled": "Aktiveret", + "disabled": "Deaktiveret" + }, + "actions": { + "enable": "Aktivér", + "disable": "Deaktivér", + "disabledDueToError": "Ret fejlen før aktivering", + "disabledUsersRequired": "Vælg brugere før aktivering", + "disabledLibrariesRequired": "Vælg biblioteker før aktivering", + "addConfig": "Tilføj konfiguration", + "rescan": "Genskan" + }, + "notifications": { + "enabled": "Plugin aktiveret", + "disabled": "Plugin deaktiveret", + "updated": "Plugin opdateret", + "error": "Fejl ved opdatering af plugin" + }, + "validation": { + "invalidJson": "Konfigurationen skal være gyldig JSON" + }, + "messages": { + "configHelp": "Konfigurér pluginet med nøgle-værdi-par. Lad stå tomt, hvis pluginet ikke kræver konfiguration.", + "clickPermissions": "Klik på en tilladelse for detaljer", + "noConfig": "Ingen konfiguration angivet", + "allUsersHelp": "Når aktiveret, vil pluginet have adgang til alle brugere, inklusiv dem der oprettes i fremtiden.", + "noUsers": "Ingen brugere valgt", + "permissionReason": "Årsag", + "usersRequired": "Dette plugin kræver adgang til brugeroplysninger. Vælg hvilke brugere pluginet kan tilgå, eller aktivér 'Tillad alle brugere'.", + "allLibrariesHelp": "Når aktiveret, vil pluginet have adgang til alle biblioteker, inklusiv dem der oprettes i fremtiden.", + "noLibraries": "Ingen biblioteker valgt", + "librariesRequired": "Dette plugin kræver adgang til biblioteksoplysninger. Vælg hvilke biblioteker pluginet kan tilgå, eller aktivér 'Tillad alle biblioteker'.", + "requiredHosts": "Påkrævede hosts", + "configValidationError": "Konfigurationsvalidering mislykkedes:", + "schemaRenderError": "Kan ikke vise konfigurationsformularen. Pluginets skema er muligvis ugyldigt.", + "allowWriteAccessHelp": "" + }, + "placeholders": { + "configKey": "nøgle", + "configValue": "værdi" + } } }, "ra": { @@ -506,7 +590,8 @@ "remove_all_missing_title": "Fjern alle manglende filer", "remove_all_missing_content": "Er du sikker på, at du vil fjerne alle manglende filer fra databasen? Dét vil permanent fjerne alle referencer til dem, inklusive deres afspilningstællere og vurderinger.", "noSimilarSongsFound": "Ingen lignende sange fundet", - "noTopSongsFound": "Ingen topsange fundet" + "noTopSongsFound": "Ingen topsange fundet", + "startingInstantMix": "Indlæser Instant Mix..." }, "menu": { "library": "Bibliotek", @@ -549,7 +634,7 @@ "closeText": "Luk", "notContentText": "Ingen musik", "clickToPlayText": "Tryk for at afspille", - "clickToPauseText": "Tryk for at pause", + "clickToPauseText": "Tryk for at sætte på pause", "nextTrackText": "Næste nummer", "previousTrackText": "Forrige nummer", "reloadText": "Genindlæs", @@ -592,7 +677,8 @@ "exportSuccess": "Konfigurationen eksporteret til udklipsholder i TOML-format", "exportFailed": "Kunne ikke kopiere konfigurationen", "devFlagsHeader": "Udviklingsflagget (med forbehold for ændring/fjernelse)", - "devFlagsComment": "Disse er eksperimental-indstillinger og kan blive fjernet i fremtidige udgaver" + "devFlagsComment": "Disse er eksperimental-indstillinger og kan blive fjernet i fremtidige udgaver", + "downloadToml": "Download konfigurationen (TOML)" } }, "activity": { @@ -604,7 +690,8 @@ "serverDown": "OFFLINE", "scanType": "Type", "status": "Scanningsfejl", - "elapsedTime": "Medgået tid" + "elapsedTime": "Medgået tid", + "selectiveScan": "Selektiv" }, "help": { "title": "Navidrome genvejstaster", @@ -625,4 +712,4 @@ "empty": "Intet afspilles nu", "minutesAgo": "for %{smart_count} minut siden |||| for %{smart_count} minutter siden" } -} \ No newline at end of file +} diff --git a/resources/i18n/de.json b/resources/i18n/de.json index c9c7fa7f5..ab1760ed5 100644 --- a/resources/i18n/de.json +++ b/resources/i18n/de.json @@ -36,7 +36,9 @@ "bitDepth": "Bittiefe", "sampleRate": "Samplerate", "missing": "Fehlend", - "libraryName": "Bibliothek" + "libraryName": "Bibliothek", + "composer": "Komponist", + "disc": "" }, "actions": { "addToQueue": "Später abspielen", @@ -46,7 +48,8 @@ "download": "Herunterladen", "playNext": "Als nächstes abspielen", "info": "Mehr Informationen", - "showInPlaylist": "In Wiedergabeliste anzeigen" + "showInPlaylist": "In Wiedergabeliste anzeigen", + "instantMix": "Sofort-Mix" } }, "album": { @@ -301,14 +304,19 @@ "actions": { "scan": "Bibliothek scannen", "manageUsers": "Zugriff verwalten", - "viewDetails": "Details ansehen" + "viewDetails": "Details ansehen", + "quickScan": "Schneller Scan", + "fullScan": "Kompletter Scan" }, "notifications": { "created": "Bibliothek erfolgreich erstellt", "updated": "Bibliothek erfolgreich geändert", "deleted": "Bibliothek erfolgreich gelöscht", "scanStarted": "Bibliothek Scan gestartet", - "scanCompleted": "Bibliothek Scan vollständig" + "scanCompleted": "Bibliothek Scan vollständig", + "quickScanStarted": "Schneller Scan gestartet", + "fullScanStarted": "Kompletter Scan gestartet", + "scanError": "Fehler beim Starten des Scans. Logs prüfen" }, "validation": { "nameRequired": "Bibliotheksname ist Pflichtfeld", @@ -323,6 +331,82 @@ "scanInProgress": "Bibliothek Scan läuft...", "noLibrariesAssigned": "Keine Bibliotheken zugeordnet" } + }, + "plugin": { + "name": "Plugin |||| Plugins", + "fields": { + "id": "ID", + "name": "Name", + "description": "Beschreibung", + "version": "Version", + "author": "Autor", + "website": "Website", + "permissions": "Berechtigungen", + "enabled": "Aktiv", + "status": "Status", + "path": "Pfad", + "lastError": "Fehler", + "hasError": "Fehler", + "updatedAt": "Aktualisiert am", + "createdAt": "Installiert", + "configKey": "Schlüssel", + "configValue": "Wert", + "allUsers": "Alle Benutzer", + "selectedUsers": "Ausgewählte Benutzer", + "allLibraries": "Alle Bibliotheken", + "selectedLibraries": "Ausgewählte Bibliotheken", + "allowWriteAccess": "Schreibzugriff erlauben" + }, + "sections": { + "status": "Status", + "info": "Plugin Information", + "configuration": "Konfiguration", + "manifest": "Manifest", + "usersPermission": "Benutzer Zugriff", + "libraryPermission": "Bibliotheken Zugriff" + }, + "status": { + "enabled": "Aktiv", + "disabled": "Inaktiv" + }, + "actions": { + "enable": "Aktivieren", + "disable": "Deaktivieren", + "disabledDueToError": "Fehler beheben um Plugin zu aktivieren", + "disabledUsersRequired": "Wähle Benutzer Zugriff um Plugin zu aktivieren", + "disabledLibrariesRequired": "Wähle Bibliotheken Zugriff um Plugin zu aktivieren", + "addConfig": "Konfiguration hinzufügen", + "rescan": "Scan" + }, + "notifications": { + "enabled": "Plugin aktiv", + "disabled": "Plugin inaktiv", + "updated": "Plugin aktualisiert", + "error": "Fehler beim aktualisieren des Plugins" + }, + "validation": { + "invalidJson": "Konfiguration muss valides JSON sein" + }, + "messages": { + "configHelp": "Plugin mit Schlüssel-Werte Paaren konfigurieren. Leer lassen wenn das Plugin keine Konfiguration benötigt.", + "clickPermissions": "Berechtigung anklicken für mehr Details", + "noConfig": "Keine Konfiguration gesetzt", + "allUsersHelp": "Wenn aktiviert, erhält das Plugin Zugriff auf alle Benutzer, inklusive solcher, die in Zukunft erstellt werden.", + "noUsers": "Keine Benutzer ausgewählt", + "permissionReason": "Begründung", + "usersRequired": "Dieses Plugin benötigt Zugriff auf Benutzerinformationen. Wähle aus, auf welche Nutzer das Plugin zugreifen darf oder wähle 'Alle Benutzer'.", + "allLibrariesHelp": "Wenn aktiviert, erhält das Plugin Zugriff auf alle Bibliotheken, inklusive solcher, die in Zukunft erstellt werden.", + "noLibraries": "Keine Bibliotheken ausgewählt", + "librariesRequired": "Dieses Plugin benötigt Zugriff auf Bibliotheken. Wähle aus, auf welche Bibliotheken das Plugin zugreifen darf oder wähle 'Alle Bibliotheken'.", + "requiredHosts": "Benötigte Hosts", + "configValidationError": "Validierung der Konfiguration fehlgeschlagen:", + "schemaRenderError": "Rendern der Konfiguration fehlgeschlagen. Das Schema das Plugins ist eventuell nicht korrekt.", + "allowWriteAccessHelp": "Wenn aktiviert, kann das Plugin Dateien in den Bibliotheken verändern. Als Standard haben Plugins nur Lesezugriff." + }, + "placeholders": { + "configKey": "Schlüssel", + "configValue": "Wert" + } } }, "ra": { @@ -506,7 +590,14 @@ "remove_all_missing_title": "Alle fehlenden Dateien entfernen", "remove_all_missing_content": "Möchtest du wirklich alle Fehlenden Dateien aus der Datenbank entfernen? Alle Referenzen zu den Dateien wie Anzahl Wiedergaben und Bewertungen werden permanent gelöscht.", "noSimilarSongsFound": "Keine ähnlichen Titel gefunden", - "noTopSongsFound": "Keine beliebten Titel gefunden" + "noTopSongsFound": "Keine beliebten Titel gefunden", + "startingInstantMix": "Lade Sofort-Mix...", + "uploadCover": "Cover hochladen", + "removeCover": "Cover entfernen", + "coverUploaded": "Cover aktualisiert", + "coverRemoved": "Cover entfernt", + "coverUploadError": "Fehler beim Hochladen des Covers", + "coverRemoveError": "Fehler beim Entfernen des Covers" }, "menu": { "library": "Bibliothek", @@ -592,7 +683,8 @@ "exportSuccess": "Konfiguration im TOML Format in die Zwischenablage kopiert", "exportFailed": "Fehler beim Kopieren der Konfiguration", "devFlagsHeader": "Entwicklungseinstellungen (können sich ändern)", - "devFlagsComment": "Experimentelle Einstellungen, die eventuell in Zukunft entfernt oder geändert werden" + "devFlagsComment": "Experimentelle Einstellungen, die eventuell in Zukunft entfernt oder geändert werden", + "downloadToml": "Konfiguration Herunterladen (TOML)" } }, "activity": { @@ -604,7 +696,8 @@ "serverDown": "OFFLINE", "scanType": "Typ", "status": "Scan Fehler", - "elapsedTime": "Laufzeit" + "elapsedTime": "Laufzeit", + "selectiveScan": "Selektiver Scan" }, "help": { "title": "Navidrome Hotkeys", @@ -625,4 +718,4 @@ "empty": "Keine Wiedergabe", "minutesAgo": "Vor %{smart_count} Minute |||| Vor %{smart_count} Minuten" } -} \ No newline at end of file +} diff --git a/resources/i18n/el.json b/resources/i18n/el.json index 0d9ee05c5..019d05978 100644 --- a/resources/i18n/el.json +++ b/resources/i18n/el.json @@ -36,7 +36,9 @@ "bitDepth": "Λίγο βάθος", "sampleRate": "Ποσοστό δειγματοληψίας", "missing": "Απών", - "libraryName": "Βιβλιοθήκη" + "libraryName": "Βιβλιοθήκη", + "composer": "Συνθέτης", + "disc": "" }, "actions": { "addToQueue": "Αναπαραγωγη Μετα", @@ -46,7 +48,8 @@ "download": "Ληψη", "playNext": "Επόμενη Αναπαραγωγή", "info": "Εμφάνιση Πληροφοριών", - "showInPlaylist": "Εμφάνιση στη λίστα αναπαραγωγής" + "showInPlaylist": "Εμφάνιση στη λίστα αναπαραγωγής", + "instantMix": "Άμεση Μίξη" } }, "album": { @@ -301,14 +304,19 @@ "actions": { "scan": "Σάρωση βιβλιοθήκης", "manageUsers": "Διαχείριση πρόσβασης χρήστη", - "viewDetails": "Προβολή λεπτομερειών" + "viewDetails": "Προβολή λεπτομερειών", + "quickScan": "Γρήγορη σάρωση", + "fullScan": "Πλήρης σάρωση" }, "notifications": { "created": "Η βιβλιοθήκη δημιουργήθηκε με επιτυχία", "updated": "Η βιβλιοθήκη ενημερώθηκε με επιτυχία", "deleted": "Η βιβλιοθήκη διαγράφηκε με επιτυχία", "scanStarted": "Ξεκίνησε η σάρωση της βιβλιοθήκης", - "scanCompleted": "Η σάρωση της βιβλιοθήκης ολοκληρώθηκε" + "scanCompleted": "Η σάρωση της βιβλιοθήκης ολοκληρώθηκε", + "quickScanStarted": "Η Γρήγορη Σάρωση ξεκίνησε", + "fullScanStarted": "Η πλήρης σάρωση ξεκίνησε", + "scanError": "Σφάλμα κατά την έναρξη της σάρωσης. Ελέγξτε τα αρχεία καταγραφής." }, "validation": { "nameRequired": "Απαιτείται όνομα βιβλιοθήκης", @@ -323,6 +331,82 @@ "scanInProgress": "Σάρωση σε εξέλιξη...", "noLibrariesAssigned": "Δεν έχουν αντιστοιχιστεί βιβλιοθήκες σε αυτόν τον χρήστη" } + }, + "plugin": { + "name": "Πρόσθετο |||| Πρόσθετα", + "fields": { + "id": "ID", + "name": "Όνομα", + "description": "Περιγραφή", + "version": "Έκδοση", + "author": "Καλλιτέχνης", + "website": "Ιστοσελίδα", + "permissions": "Άδειες", + "enabled": "Ενεργό", + "status": "Κατάσταση", + "path": "Διαδρομή", + "lastError": "Σφάλμα", + "hasError": "Σφάλμα", + "updatedAt": "Ενημερώθηκε", + "createdAt": "Εγκατασταθηκε", + "configKey": "Κλειδί", + "configValue": "Τιμή", + "allUsers": "Επιτρέψτε όλους τους χρήστες", + "selectedUsers": "Επιλογή χρηστών", + "allLibraries": "Επιτρέψτε όλες τις βιβλιοθήκες", + "selectedLibraries": "Επιλεγμένες βιβλιοθήκες", + "allowWriteAccess": "" + }, + "sections": { + "status": "Κατάσταση", + "info": "Πληροφορίες Πρόσθετου", + "configuration": "Παραμετροποίηση", + "manifest": "Manifest", + "usersPermission": "Άδειες Χρηστών", + "libraryPermission": "Άδειες Βιβλιοθηκών" + }, + "status": { + "enabled": "Ενεργό", + "disabled": "Ανενεργό" + }, + "actions": { + "enable": "Ενεργοποίηση", + "disable": "Απενεργοποίηση", + "disabledDueToError": "Διορθώστε το σφάλμα πριν την ενεργοποίηση", + "disabledUsersRequired": "Επιλέξτε χρήστες πριν την ενεργοποίηση", + "disabledLibrariesRequired": "Επιλέξτε βιβλιοθήκες πριν την ενεργοποίηση", + "addConfig": "Προσθήκη παραμετροποίησης", + "rescan": "Σάρωση ξανά" + }, + "notifications": { + "enabled": "Πρόσθετο ενεργοποιημένο", + "disabled": "Πρόσθετο απενεργοποιημένο", + "updated": "Πρόσθετο ενημερωμένο", + "error": "Σφάλμα κατά την ενημέρωση του πρόσθετου" + }, + "validation": { + "invalidJson": "Η παραμετροποίηση πρέπει να είναι συμβατό JSON" + }, + "messages": { + "configHelp": "Παραμετροποιήστε το πρόσθετο με χρήση ζεύγων κλειδιών-τιμών. Αφήστε κενό αν το πρόσθετο δεν απαιτεί παραμετροποίηση", + "clickPermissions": "Κάνετε κλικ για λεπτομέρειες αδειών", + "noConfig": "Δεν ορίστηκε παραμετροποίηση", + "allUsersHelp": "Όταν είναι ενεργό, το πρόσθετο θα έχει πρόσβαση σε όλους τους χρήστες, συμπεριλαμβανομένων και όσων δημιουργηθούν στο μέλλον.", + "noUsers": "Δεν επιλέχθηκαν χρήστες", + "permissionReason": "Αιτία", + "usersRequired": "Το πρόσθετο απαιτεί πρόσβαση στις πληροφορίες χρηστών. Ορίστε τους χρήστες που θα έχει πρόσβαση το πρόσθετο, ή ενεργοποιήστε το 'Επιτρέψτε όλους τους χρήστες'", + "allLibrariesHelp": "Όταν είναι ενεργό, το πρόσθετο θα έχει πρόσβαση σε όλες τις βιβλιοθήκες, συμπεριλαμβανομένων και όσων δημιουργηθούν στο μέλλον.", + "noLibraries": "Δεν επιλέχθηκαν βιβλιοθήκες", + "librariesRequired": "Αυτό το πρόσθετο απαιτεί πρόσβαση στις πληροφορίες βιβλιοθήκης. Επιλέξτε σε ποιές βιβλιοθήκες μπορεί να έχει πρόσβαση το πρόσθετο, ή ενεργοποιήστε το 'Επιτρέψτε όλες τις βιβλιοθήκες'", + "requiredHosts": "Απαιτούμενοι hosts", + "configValidationError": "Η επικύρωση διαμόρφωσης απέτυχε:", + "schemaRenderError": "Δεν είναι δυνατή η απόδοση της φόρμας διαμόρφωσης. Το σχήμα της προσθήκης ενδέχεται να μην είναι έγκυρο.", + "allowWriteAccessHelp": "" + }, + "placeholders": { + "configKey": "κλειδί", + "configValue": "τιμή" + } } }, "ra": { @@ -506,7 +590,8 @@ "remove_all_missing_title": "Αφαίρεση όλων των αρχείων που λείπουν", "remove_all_missing_content": "Είστε βέβαιοι ότι θέλετε να καταργήσετε όλα τα αρχεία που λείπουν από τη βάση δεδομένων? Αυτό θα καταργήσει οριστικά τυχόν αναφορές σε αυτά, συμπεριλαμβανομένου του αριθμού αναπαραγωγών και των αξιολογήσεών τους.", "noSimilarSongsFound": "Δεν βρέθηκαν παρόμοια τραγούδια", - "noTopSongsFound": "Δεν βρέθηκαν κορυφαία τραγούδια" + "noTopSongsFound": "Δεν βρέθηκαν κορυφαία τραγούδια", + "startingInstantMix": "Φόρτωση Άμεσης Μίξης..." }, "menu": { "library": "Βιβλιοθήκη", @@ -592,7 +677,8 @@ "exportSuccess": "Η διαμόρφωση εξήχθη στο πρόχειρο σε μορφή TOML", "exportFailed": "Η αντιγραφή της διαμόρφωσης απέτυχε", "devFlagsHeader": "Σημαίες Ανάπτυξης (υπόκειται σε αλλαγές / αφαίρεση)", - "devFlagsComment": "Αυτές είναι πειραματικές ρυθμίσεις και ενδέχεται να καταργηθούν σε μελλοντικές εκδόσεις" + "devFlagsComment": "Αυτές είναι πειραματικές ρυθμίσεις και ενδέχεται να καταργηθούν σε μελλοντικές εκδόσεις", + "downloadToml": "Λήψη διαμόρφωσης (TOML)" } }, "activity": { @@ -604,7 +690,8 @@ "serverDown": "ΕΚΤΟΣ ΣΥΝΔΕΣΗΣ", "scanType": "Τύπος", "status": "Σφάλμα σάρωσης", - "elapsedTime": "Χρόνος που πέρασε" + "elapsedTime": "Χρόνος που πέρασε", + "selectiveScan": "Εκλεκτικός" }, "help": { "title": "Συντομεύσεις του Navidrome", @@ -625,4 +712,4 @@ "empty": "Δεν παίζει τίποτα", "minutesAgo": "%{smart_count} λεπτό πριν |||| %{smart_count} λεπτά πριν" } -} \ No newline at end of file +} diff --git a/resources/i18n/eo.json b/resources/i18n/eo.json index bdf143969..7a13c471d 100644 --- a/resources/i18n/eo.json +++ b/resources/i18n/eo.json @@ -27,15 +27,16 @@ "playDate": "Laste Ludita", "channels": "Kanaloj", "createdAt": "Dato de aligo", - "grouping": "", + "grouping": "Grupo", "mood": "Humoro", - "participants": "", + "participants": "Aldonaj partoprenantoj", "tags": "Aldonaj Etikedoj", "mappedTags": "Mapigitaj etikedoj", "rawTags": "Krudaj etikedoj", - "bitDepth": "", - "sampleRate": "", - "missing": "" + "bitDepth": "Bitprofundo", + "sampleRate": "Elprena rapido", + "missing": "Mankaj", + "libraryName": "Biblioteko" }, "actions": { "addToQueue": "Ludi Poste", @@ -44,7 +45,8 @@ "shuffleAll": "Miksu Ĉiujn", "download": "Elŝuti", "playNext": "Ludu Poste", - "info": "Akiri Informon" + "info": "Akiri Informon", + "showInPlaylist": "Montri en Ludlisto" } }, "album": { @@ -68,14 +70,15 @@ "releaseDate": "Publikiĝis", "releases": "Publikiĝo |||| Publikiĝoj", "released": "Publikiĝis", - "recordLabel": "", - "catalogNum": "", + "recordLabel": "Eldonejo", + "catalogNum": "Kataloga Numero", "releaseType": "Tipo", - "grouping": "", - "media": "", + "grouping": "Grupo", + "media": "Aŭdvidaĵo", "mood": "Humoro", - "date": "", - "missing": "" + "date": "Registraĵa Dato", + "missing": "Mankaj", + "libraryName": "Biblioteko" }, "actions": { "playAll": "Ludi", @@ -107,8 +110,8 @@ "rating": "Takso", "genre": "Ĝenro", "size": "Grando", - "role": "", - "missing": "" + "role": "Rolo", + "missing": "Mankaj" }, "roles": { "albumartist": "Albuma Artisto |||| Albumaj Artistoj", @@ -117,13 +120,19 @@ "conductor": "Dirigento |||| Dirigentoj", "lyricist": "Kantoteksisto |||| Kantotekstistoj", "arranger": "Aranĝisto |||| Aranĝistoj", - "producer": "", - "director": "", - "engineer": "", + "producer": "Produktisto |||| Produktistoj", + "director": "Direktoro |||| Direktoroj", + "engineer": "Inĝeniero |||| Inĝenieroj", "mixer": "Miksisto |||| Miksistoj", "remixer": "Remiksisto |||| Remiksistoj", - "djmixer": "", - "performer": "" + "djmixer": "Dĵ-a Miksisto |||| Dĵ-a Miksistoj", + "performer": "Plenumisto |||| Plenumistoj", + "maincredit": "Albuma Artisto aŭ Artisto |||| Albumaj Artistoj aŭ Artistoj" + }, + "actions": { + "shuffle": "Miksi", + "radio": "Radio", + "topSongs": "Plej Luditaj Kantoj" } }, "user": { @@ -140,10 +149,12 @@ "currentPassword": "Nuna Pasvorto", "newPassword": "Nova Pasvorto", "token": "Ĵetono", - "lastAccessAt": "Lasta Atingo" + "lastAccessAt": "Lasta Atingo", + "libraries": "Bibliotekoj" }, "helperTexts": { - "name": "Ŝanĝoj de via nomo nur ĝisdatiĝs je via sekvanta ensaluto" + "name": "Ŝanĝoj de via nomo nur ĝisdatiĝs je via sekvanta ensaluto", + "libraries": "Elekti specifajn bibliotekojn por ĉi tiu uzanto, aŭ lasi malplena por uzi defaŭltajn bibliotekojn" }, "notifications": { "created": "Uzanto farita", @@ -152,7 +163,12 @@ }, "message": { "listenBrainzToken": "Enigi vian uzantan ĵetonon de ListenBrainz.", - "clickHereForToken": "Alkakli ĉi tie por akiri vian ĵetonon" + "clickHereForToken": "Alkakli ĉi tie por akiri vian ĵetonon", + "selectAllLibraries": "Elekti ĉiujn bibliotekojn", + "adminAutoLibraries": "Administrantoj aŭtomate havas aliron al ĉiuj bibliotekoj" + }, + "validation": { + "librariesRequired": "Almenaŭ unu biblioteko devas esti elektita por neadministrantoj" } }, "player": { @@ -197,11 +213,16 @@ "export": "Eksporti", "makePublic": "Publikigi", "makePrivate": "Malpublikigi", - "saveQueue": "" + "saveQueue": "Konservi Ludvicon al Ludlisto", + "searchOrCreate": "Serĉi ludlistojn aŭ tajpi por krei novan...", + "pressEnterToCreate": "Premu je Enter por krei novan ludliston", + "removeFromSelection": "Forigi de elekto" }, "message": { "duplicate_song": "Aldoni duobligitajn kantojn", - "song_exist": "Estas duoblaĵoj kiuj aldoniĝas al la kantolisto. Ĉu vi ŝatus aldoni la duoblaĵojn aŭ pasigi ilin?" + "song_exist": "Estas duoblaĵoj kiuj aldoniĝas al la kantolisto. Ĉu vi ŝatus aldoni la duoblaĵojn aŭ pasigi ilin?", + "noPlaylistsFound": "Neniuj ludlistoj trovitaj", + "noPlaylists": "Neniuj ludlistoj haveblaj" } }, "radio": { @@ -235,20 +256,78 @@ } }, "missing": { - "name": "", + "name": "Manka Dosiero |||| Mankaj Dosieroj", "fields": { - "path": "", - "size": "", - "updatedAt": "" + "path": "Vojo", + "size": "Grando", + "updatedAt": "Malaperis je", + "libraryName": "Biblioteko" }, "actions": { - "remove": "", - "remove_all": "" + "remove": "Forigi", + "remove_all": "Forigi Ĉiujn" }, "notifications": { - "removed": "" + "removed": "Manka(j) dosiero(j) forigite" }, - "empty": "" + "empty": "Neniuj Mankaj Dosieroj" + }, + "library": { + "name": "Biblioteko |||| Bibliotekoj", + "fields": { + "name": "Nomo", + "path": "Vojo", + "remotePath": "Fora Vojo", + "lastScanAt": "Plej Lasta Skano", + "songCount": "Kantoj", + "albumCount": "Albumoj", + "artistCount": "Artistoj", + "totalSongs": "Kantoj", + "totalAlbums": "Albumoj", + "totalArtists": "Artistoj", + "totalFolders": "Dosierujoj", + "totalFiles": "Dosieroj", + "totalMissingFiles": "Mankaj Dosieroj", + "totalSize": "Totala Grando", + "totalDuration": "Daŭro", + "defaultNewUsers": "Defaŭlto por Novaj Uzantoj", + "createdAt": "Farite je", + "updatedAt": "Ĝisdatiĝis je" + }, + "sections": { + "basic": "Bazaj Informoj", + "statistics": "Statistikaĵoj" + }, + "actions": { + "scan": "Skani Bibliotekon", + "manageUsers": "Agordi Uzantan Aliron", + "viewDetails": "Montri Informojn", + "quickScan": "Rapida Skano", + "fullScan": "Plena Skano" + }, + "notifications": { + "created": "Biblioteko kreiĝis sukcese", + "updated": "Biblioteko ĝisdatiĝis sukcese", + "deleted": "Biblioteko foriĝis sukcese", + "scanStarted": "Biblioteka skano komenciĝis", + "scanCompleted": "Biblioteka skano finiĝis", + "quickScanStarted": "Rapida skano komenciĝis", + "fullScanStarted": "Plena skano komenciĝis", + "scanError": "Eraro de skana komenco. Kontrolu la protokolojn" + }, + "validation": { + "nameRequired": "Biblioteka nomo estas necesa", + "pathRequired": "Biblioteka vojo estas necesa", + "pathNotDirectory": "Biblioteka vojo devas esti dosierujo", + "pathNotFound": "Biblioteka vojo ne trovite", + "pathNotAccessible": "Biblioteka vojo ne estas alirebla", + "pathInvalid": "Nevalida biblioteka vojo" + }, + "messages": { + "deleteConfirm": "Ĉu vi certas, ke vi volas forigi ĉi tiun bibliotekon? Ĉi tio forigos ĉiujn rilatajn datumojn kaj uzantan aliron.", + "scanInProgress": "Skano progresas...", + "noLibrariesAssigned": "Neniuj bibliotekoj asignitaj por ĉi tiu uzanto" + } } }, "ra": { @@ -427,10 +506,12 @@ "shareFailure": "Eraro de kopio de ligilo %{url} al la tondujo", "downloadDialogTitle": "Elŝuti %{resource} '%{name}' (%{size})", "shareCopyToClipboard": "Kopii al la tondujo: Ctrl+C, Enter", - "remove_missing_title": "", + "remove_missing_title": "Forigi mankajn dosierojn", "remove_missing_content": "Ĉu vi certas, ke vi volas forigi la elektitajn mankajn dosierojn de la datumbazo? Ĉi tio forigos eterne ĉiujn referencojn de ili, inkluzive iliajn ludkvantojn kaj taksojn.", - "remove_all_missing_title": "", - "remove_all_missing_content": "" + "remove_all_missing_title": "Forigi ĉiujn mankajn dosierojn", + "remove_all_missing_content": "Ĉu vi certas, ke vi volas forigi ĉiujn mankajn dosierojn de la datumbazo? Ĉi tio permanante forigos ĉiujn referencojn al ili, inkluzive iliajn ludnombrojn kaj taksojn.", + "noSimilarSongsFound": "Neniuj similaj kantoj trovitaj", + "noTopSongsFound": "Neniuj plej luditaj kantoj trovitaj" }, "menu": { "library": "Biblioteko", @@ -453,13 +534,19 @@ "album": "Uzi Albuman Songajnon", "track": "Uzi Kantan Songajnon" }, - "lastfmNotConfigured": "" + "lastfmNotConfigured": "API-ŝlosilo de Last.fm ne agordita" } }, "albumList": "Albumoj", "about": "Pri", "playlists": "Ludlistoj", - "sharedPlaylists": "Diskonigitaj Ludistoj" + "sharedPlaylists": "Diskonigitaj Ludistoj", + "librarySelector": { + "allLibraries": "Ĉiuj Bibliotekoj (%{count})", + "multipleLibraries": "%{selected} el %{total} Bibliotekoj", + "selectLibraries": "Elekti Bibliotekojn", + "none": "Neniu" + } }, "player": { "playListsText": "Atendovico", @@ -491,11 +578,26 @@ "homepage": "Hejmpaĝo", "source": "Fontkodo", "featureRequests": "Trajta peto", - "lastInsightsCollection": "", + "lastInsightsCollection": "Plej lasta kolekto de datumoj", "insights": { "disabled": "Malebligita", - "waiting": "" + "waiting": "Atendante" } + }, + "tabs": { + "about": "Pri", + "config": "Agordo" + }, + "config": { + "configName": "Agorda Nomo", + "environmentVariable": "Medivariablo", + "currentValue": "Nuna Valoro", + "configurationFile": "Agorda Dosiero", + "exportToml": "Eksporti Agordojn (TOML)", + "exportSuccess": "Agordoj eksportiĝis al la tondujo en TOML-a formato", + "exportFailed": "Malsukcesis kopii agordojn", + "devFlagsHeader": "Programadaj Flagoj (povas ŝanĝiĝi/foriĝi)", + "devFlagsComment": "Ĉi tiuj estas eksperimentaj agordoj kaj eble foriĝos en estontaj versioj" } }, "activity": { @@ -505,9 +607,10 @@ "fullScan": "Plena Skanado", "serverUptime": "Servila daŭro de funkciado", "serverDown": "SENKONEKTA", - "scanType": "", - "status": "", - "elapsedTime": "" + "scanType": "Plej Lasta Skano", + "status": "Skana Eraro", + "elapsedTime": "Pasinta Tempo", + "selectiveScan": "Selektema" }, "help": { "title": "Navidrome klavkomando", @@ -519,8 +622,13 @@ "next_song": "Sekva kanto", "vol_up": "Pli volumo", "vol_down": "Malpli volumo", - "toggle_love": "Baskuli la stelon de nuna kanto", + "toggle_love": "Aldoni ĉi tiun kanton al plej ŝatataj", "current_song": "Iri al Nuna Kanto" } + }, + "nowPlaying": { + "title": "Nun Ludanta", + "empty": "Nenio ludas", + "minutesAgo": "Antaŭ %{smart_count} minuto |||| Antaŭ %{smart_count} minutoj" } } \ No newline at end of file diff --git a/resources/i18n/es.json b/resources/i18n/es.json index 4c53b8986..29d1a367f 100644 --- a/resources/i18n/es.json +++ b/resources/i18n/es.json @@ -36,7 +36,9 @@ "bitDepth": "Profundidad de bits", "sampleRate": "Frecuencia de muestreo", "missing": "Faltante", - "libraryName": "" + "libraryName": "Biblioteca", + "composer": "Compositor", + "disc": "" }, "actions": { "addToQueue": "Reproducir después", @@ -46,7 +48,8 @@ "download": "Descarga", "playNext": "Siguiente", "info": "Obtener información", - "showInPlaylist": "Mostrar en la lista de reproducción" + "showInPlaylist": "Mostrar en la lista de reproducción", + "instantMix": "Mezcla instantánea" } }, "album": { @@ -78,7 +81,7 @@ "mood": "Estado de ánimo", "date": "Fecha de grabación", "missing": "Faltante", - "libraryName": "" + "libraryName": "Biblioteca" }, "actions": { "playAll": "Reproducir", @@ -114,25 +117,25 @@ "missing": "Faltante" }, "roles": { - "albumartist": "Artista del álbum", - "artist": "Artista", - "composer": "Compositor", - "conductor": "Director de orquesta", - "lyricist": "Letrista", - "arranger": "Arreglista", - "producer": "Productor", - "director": "Director", - "engineer": "Ingeniero de sonido", - "mixer": "Mezclador", - "remixer": "Remixer", - "djmixer": "DJ Mixer", - "performer": "Intérprete", - "maincredit": "" + "albumartist": "Artista del álbum |||| Artistas del álbum", + "artist": "Artista |||| Artistas", + "composer": "Compositor |||| Compositores", + "conductor": "Director de orquesta |||| Directores de orquesta", + "lyricist": "Letrista |||| Letristas", + "arranger": "Arreglista |||| Arreglistas", + "producer": "Productor |||| Productores", + "director": "Director |||| Directores", + "engineer": "Ingeniero de sonido |||| Ingenieros de sonido", + "mixer": "Mezclador |||| Mezcladores", + "remixer": "Remezclador |||| Remezcladores", + "djmixer": "DJ Mezclador |||| DJ Mezcladores", + "performer": "Intérprete |||| Intérpretes", + "maincredit": "Artista del álbum o Artista |||| Artistas del álbum o Artistas" }, "actions": { "shuffle": "Aleatorio", "radio": "Radio", - "topSongs": "" + "topSongs": "Más destacadas" } }, "user": { @@ -150,11 +153,11 @@ "newPassword": "Nueva contraseña", "token": "Token", "lastAccessAt": "Último acceso", - "libraries": "" + "libraries": "Bibliotecas" }, "helperTexts": { "name": "Los cambios a tu nombre se verán en el próximo inicio de sesión", - "libraries": "" + "libraries": "Selecciona bibliotecas específicas para este usuario o déjalo vacío para usar las bibliotecas por defecto" }, "notifications": { "created": "Usuario creado", @@ -164,11 +167,11 @@ "message": { "listenBrainzToken": "Escribe tu token de usuario de ListenBrainz", "clickHereForToken": "Click aquí para obtener tu token", - "selectAllLibraries": "", - "adminAutoLibraries": "" + "selectAllLibraries": "Seleccionar todas las bibliotecas", + "adminAutoLibraries": "Los usuarios administradores tienen acceso a todas las bibliotecas automáticamente" }, "validation": { - "librariesRequired": "" + "librariesRequired": "Se debe seleccionar al menos una biblioteca para los usuarios que no sean administradores" } }, "player": { @@ -189,7 +192,7 @@ "fields": { "name": "Nombre", "targetFormat": "Formato de destino", - "defaultBitRate": "Tasa de bits default", + "defaultBitRate": "Tasa de bits por defecto", "command": "Comando" } }, @@ -239,9 +242,9 @@ } }, "share": { - "name": "Compartir", + "name": "Compartir |||| Compartidos", "fields": { - "username": "Nombre de usuario", + "username": "Compartido por", "url": "URL", "description": "Descripción", "contents": "Contenido", @@ -256,12 +259,12 @@ } }, "missing": { - "name": "Faltante", + "name": "Fichero faltante |||| Ficheros faltantes", "fields": { "path": "Ruta", "size": "Tamaño", "updatedAt": "Actualizado el", - "libraryName": "" + "libraryName": "Biblioteca" }, "actions": { "remove": "Eliminar", @@ -270,58 +273,139 @@ "notifications": { "removed": "Eliminado" }, - "empty": "No hay archivos perdidos" + "empty": "No faltan archivos" }, "library": { - "name": "", + "name": "Biblioteca |||| Bibliotecas", "fields": { - "name": "", - "path": "", - "remotePath": "", - "lastScanAt": "", - "songCount": "", - "albumCount": "", - "artistCount": "", - "totalSongs": "", - "totalAlbums": "", - "totalArtists": "", - "totalFolders": "", - "totalFiles": "", - "totalMissingFiles": "", - "totalSize": "", - "totalDuration": "", - "defaultNewUsers": "", - "createdAt": "", - "updatedAt": "" + "name": "Nombre", + "path": "Ruta", + "remotePath": "Ruta remota", + "lastScanAt": "Último escaneo", + "songCount": "Canciones", + "albumCount": "Álbumes", + "artistCount": "Artistas", + "totalSongs": "Canciones", + "totalAlbums": "Álbumes", + "totalArtists": "Artistas", + "totalFolders": "Carpetas", + "totalFiles": "Archivos", + "totalMissingFiles": "Archivos faltantes", + "totalSize": "Tamaño total", + "totalDuration": "Duración", + "defaultNewUsers": "Por defecto para nuevos usuarios", + "createdAt": "Creado", + "updatedAt": "Actualizado" }, "sections": { - "basic": "", - "statistics": "" + "basic": "Información básica", + "statistics": "Estadísticas" }, "actions": { - "scan": "", - "manageUsers": "", - "viewDetails": "" + "scan": "Escanear biblioteca", + "manageUsers": "Gestionar el acceso de usarios", + "viewDetails": "Ver detalles", + "quickScan": "Escaneo rápido", + "fullScan": "Escaneo completo" }, "notifications": { - "created": "", - "updated": "", - "deleted": "", - "scanStarted": "", - "scanCompleted": "" + "created": "La biblioteca se creó correctamente", + "updated": "La biblioteca se actualizó correctamente", + "deleted": "La biblioteca se eliminó correctamente", + "scanStarted": "El escaneo de la biblioteca ha comenzado", + "scanCompleted": "El escaneo de la biblioteca se completó", + "quickScanStarted": "Escaneo rápido ha comenzado", + "fullScanStarted": "Escaneo completo ha comenzado", + "scanError": "Error al iniciar el escaneo. Revisa los registros" }, "validation": { - "nameRequired": "", - "pathRequired": "", - "pathNotDirectory": "", - "pathNotFound": "", - "pathNotAccessible": "", - "pathInvalid": "" + "nameRequired": "El nombre de la biblioteca es obligatorio", + "pathRequired": "La ruta de la biblioteca es obligatoria", + "pathNotDirectory": "La ruta de la biblioteca debe ser un directorio", + "pathNotFound": "Ruta de la biblioteca no encontrada", + "pathNotAccessible": "La ruta de la biblioteca no es accesible", + "pathInvalid": "Ruta de la biblioteca no válida" }, "messages": { - "deleteConfirm": "", - "scanInProgress": "", - "noLibrariesAssigned": "" + "deleteConfirm": "¿Estás seguro/a de que quieres eliminar esta biblioteca? Esto eliminará todos los datos asociados y el acceso de les usuaries.", + "scanInProgress": "Escaneo en curso...", + "noLibrariesAssigned": "No hay bibliotecas asignadas a este usuario" + } + }, + "plugin": { + "name": "Plugin |||| Plugins", + "fields": { + "id": "ID", + "name": "Nombre", + "description": "Descripción", + "version": "Versión", + "author": "Autor", + "website": "Web", + "permissions": "Permisos", + "enabled": "Activado", + "status": "Estado", + "path": "Ruta", + "lastError": "Error", + "hasError": "Error", + "updatedAt": "Actualizado", + "createdAt": "Instalado", + "configKey": "Clave", + "configValue": "Valor", + "allUsers": "Permitir todos los usuarios", + "selectedUsers": "Usuarios seleccionados", + "allLibraries": "Permitir todas las bibliotecas", + "selectedLibraries": "Bibliotecas seleccionadas", + "allowWriteAccess": "" + }, + "sections": { + "status": "Estado", + "info": "Información del Plugin", + "configuration": "Configuración", + "manifest": "Manifiesto", + "usersPermission": "Permiso del usuario", + "libraryPermission": "Permiso de la biblioteca" + }, + "status": { + "enabled": "Activado", + "disabled": "Deshabilitado" + }, + "actions": { + "enable": "Activar", + "disable": "Desactivar", + "disabledDueToError": "Corrige el error antes de activar", + "disabledUsersRequired": "Selecciona usuarios antes de activar", + "disabledLibrariesRequired": "Selecciona bibliotecas antes de activar", + "addConfig": "Añadir configuración", + "rescan": "Reescanear" + }, + "notifications": { + "enabled": "Plugin activado", + "disabled": "Plugin deshabilitado", + "updated": "Plugin actualizado", + "error": "Error al actualizar el plugin" + }, + "validation": { + "invalidJson": "La configuración debe ser un JSON válido" + }, + "messages": { + "configHelp": "Configura el plugin utilizando pares de clave-valor. Déjalo en blanco si el plugin no requiere configuración.", + "clickPermissions": "Haz clic en un permiso para ver los detalles", + "noConfig": "No hay configuración establecida", + "allUsersHelp": "Cuando se active, el plugin tendrá acceso a todos los usuarios, incluidos los que se creen en el futuro.", + "noUsers": "Ningún usuario seleccionado", + "permissionReason": "Razón", + "usersRequired": "Este plugin requiere acceso a la información de los usuarios. Selecciona a qué usuarios puede acceder el plugin, o activa 'Permitir todos los usuarios'.", + "allLibrariesHelp": "Cuando se active, el plugin tendrá acceso a todas las bibliotecas, incluidas las que se creen en el futuro.", + "noLibraries": "Ninguna biblioteca seleccionada", + "librariesRequired": "Este plugin requiere acceso a la información de las bibliotecas. Selecciona a qué bibliotecas puede acceder el plugin, o activa 'Permitir todas las bibliotecas'.", + "requiredHosts": "Hosts requeridos", + "configValidationError": "La validación de la configuración falló:", + "schemaRenderError": "No se pudo renderizar el formulario de configuración. Es posible que el esquema del complemento no sea válido.", + "allowWriteAccessHelp": "" + }, + "placeholders": { + "configKey": "clave", + "configValue": "valor" } } }, @@ -489,9 +573,9 @@ "musicbrainz": "Ver en MusicBrainz" }, "lastfmLink": "Leer más...", - "listenBrainzLinkSuccess": "Se ha conectado correctamente a ListenBrainz y se activo el scrobbling como el usuario: %{user}", + "listenBrainzLinkSuccess": "Se ha conectado correctamente a ListenBrainz y se activó el scrobbling como el usuario: %{user}", "listenBrainzLinkFailure": "No se pudo conectar con ListenBrainz: %{error}", - "listenBrainzUnlinkSuccess": "Se desconecto ListenBrainz y se desactivo el scrobbling", + "listenBrainzUnlinkSuccess": "Se desconectó ListenBrainz y se desactivó el scrobbling", "listenBrainzUnlinkFailure": "No se pudo desconectar ListenBrainz", "downloadOriginalFormat": "Descargar formato original", "shareOriginalFormat": "Compartir formato original", @@ -501,12 +585,13 @@ "shareFailure": "Error al copiar la URL %{url} al portapapeles", "downloadDialogTitle": "Descargar %{resource} '%{name}' (%{size})", "shareCopyToClipboard": "Copiar al portapapeles: Ctrl+C, Intro", - "remove_missing_title": "Eliminar elemento faltante", + "remove_missing_title": "Eliminar archivos faltantes", "remove_missing_content": "¿Realmente desea eliminar los archivos faltantes seleccionados de la base de datos? Esto eliminará permanentemente cualquier referencia a ellos, incluidas sus reproducciones y valoraciones.", - "remove_all_missing_title": "Eliminar todos los archivos perdidos", + "remove_all_missing_title": "Eliminar todos los archivos faltantes", "remove_all_missing_content": "¿Realmente desea eliminar todos los archivos faltantes de la base de datos? Esto eliminará permanentemente cualquier referencia a ellos, incluidas sus reproducciones y valoraciones.", "noSimilarSongsFound": "No se encontraron canciones similares", - "noTopSongsFound": "" + "noTopSongsFound": "No se encontraron canciones destacadas", + "startingInstantMix": "Cargando la mezcla instantánea..." }, "menu": { "library": "Biblioteca", @@ -525,9 +610,9 @@ "replaygain": "Modo de ReplayGain", "preAmp": "ReplayGain PreAmp (dB)", "gain": { - "none": "Ninguno", - "album": "Álbum", - "track": "Pista" + "none": "Desactivado", + "album": "Ganancia del álbum", + "track": "Ganancia de pista" }, "lastfmNotConfigured": "La clave API de Last.fm no está configurada" } @@ -537,10 +622,10 @@ "playlists": "Playlists", "sharedPlaylists": "Playlists Compartidas", "librarySelector": { - "allLibraries": "", - "multipleLibraries": "", - "selectLibraries": "", - "none": "" + "allLibraries": "Todas las bibliotecas (%{count})", + "multipleLibraries": "%{selected} de %{total} bibliotecas", + "selectLibraries": "Seleccionar bibliotecas", + "none": "Ninguno" } }, "player": { @@ -592,7 +677,8 @@ "exportSuccess": "Configuración exportada al portapapeles en formato TOML", "exportFailed": "Error al copiar la configuración", "devFlagsHeader": "Indicadores de desarrollo (sujetos a cambios o eliminación)", - "devFlagsComment": "Estas son configuraciones experimentales y pueden eliminarse en versiones futuras" + "devFlagsComment": "Estas son configuraciones experimentales y pueden eliminarse en versiones futuras", + "downloadToml": "Descargar la configuración (TOML)" } }, "activity": { @@ -604,7 +690,8 @@ "serverDown": "OFFLINE", "scanType": "Tipo", "status": "Error de escaneo", - "elapsedTime": "Tiempo transcurrido" + "elapsedTime": "Tiempo transcurrido", + "selectiveScan": "Selectivo" }, "help": { "title": "Atajos de teclado de Navidrome", @@ -621,8 +708,8 @@ } }, "nowPlaying": { - "title": "", - "empty": "", - "minutesAgo": "" + "title": "En reproducción", + "empty": "Nada en reproducción", + "minutesAgo": "Hace %{smart_count} minuto |||| Hace %{smart_count} minutos" } -} \ No newline at end of file +} diff --git a/resources/i18n/eu.json b/resources/i18n/eu.json index cb5927a74..58954c9dc 100644 --- a/resources/i18n/eu.json +++ b/resources/i18n/eu.json @@ -2,7 +2,7 @@ "languageName": "Euskara", "resources": { "song": { - "name": "Abestia |||| Abestiak", + "name": "Abestia |||| Abesti", "fields": { "albumArtist": "Albumaren artista", "duration": "Iraupena", @@ -10,8 +10,10 @@ "playCount": "Erreprodukzioak", "title": "Titulua", "artist": "Artista", + "composer": "Konpositorea", "album": "Albuma", "path": "Fitxategiaren bidea", + "libraryName": "Liburutegia", "genre": "Generoa", "compilation": "Konpilazioa", "year": "Urtea", @@ -32,9 +34,9 @@ "grouping": "Multzokatzea", "mood": "Aldartea", "participants": "Partaide gehiago", - "tags": "Traola gehiago", - "mappedTags": "Esleitutako traolak", - "rawTags": "Traola gordinak", + "tags": "Etiketa gehiago", + "mappedTags": "Esleitutako etiketak", + "rawTags": "Etiketa gordinak", "missing": "Ez da aurkitu" }, "actions": { @@ -45,11 +47,12 @@ "shuffleAll": "Erreprodukzio aleatorioa", "download": "Deskargatu", "playNext": "Hurrengoa", - "info": "Erakutsi informazioa" + "info": "Erakutsi informazioa", + "instantMix": "Berehalako nahastea" } }, "album": { - "name": "Albuma |||| Albumak", + "name": "Albuma |||| Album", "fields": { "albumArtist": "Albumaren artista", "artist": "Artista", @@ -58,13 +61,14 @@ "playCount": "Erreprodukzioak", "size": "Fitxategiaren tamaina", "name": "Izena", + "libraryName": "Liburutegia", "genre": "Generoa", "compilation": "Konpilazioa", "year": "Urtea", "date": "Recording Date", "originalDate": "Jatorrizkoa", "releaseDate": "Argitaratze-data", - "releases": "Argitaratzea |||| Argitaratzeak", + "releases": "Argitaratzea |||| Argitaratze", "released": "Argitaratua", "updatedAt": "Aktualizatze-data:", "comment": "Iruzkina", @@ -99,7 +103,7 @@ } }, "artist": { - "name": "Artista |||| Artistak", + "name": "Artista |||| Artista", "fields": { "name": "Izena", "albumCount": "Album kopurua", @@ -147,19 +151,26 @@ "currentPassword": "Uneko pasahitza", "newPassword": "Pasahitz berria", "token": "Tokena", - "lastAccessAt": "Azken sarbidea" + "lastAccessAt": "Azken sarbidea", + "libraries": "Liburutegiak" }, "helperTexts": { - "name": "Aldaketak saioa hasten duzun hurrengoan islatuko dira" + "name": "Aldaketak saioa hasten duzun hurrengoan islatuko dira", + "libraries": "Hautatu erabiltzaile honentzat liburutegi jakinak, edo utzi hutsik defektuzko liburutegiak erabiltzeko" }, "notifications": { "created": "Erabiltzailea sortu da", "updated": "Erabiltzailea eguneratu da", "deleted": "Erabiltzailea ezabatu da" }, + "validation": { + "librariesRequired": "Gutxienez liburutegi bat hautatu behar da administratzaile ez diren erabiltzaileentzat" + }, "message": { "listenBrainzToken": "Idatzi zure ListenBrainz erabiltzailearen tokena", - "clickHereForToken": "Egin klik hemen tokena lortzeko" + "clickHereForToken": "Egin klik hemen tokena lortzeko", + "selectAllLibraries": "Hautatu liburutegi guztiak", + "adminAutoLibraries": "Administratzaileek automatikoki dute liburutegi guztietara sarbidea" } }, "player": { @@ -254,6 +265,7 @@ "fields": { "path": "Bidea", "size": "Tamaina", + "libraryName": "Liburutegia", "updatedAt": "Desagertze-data:" }, "actions": { @@ -263,6 +275,137 @@ "notifications": { "removed": "Aurkitzen ez ziren fitxategiak kendu dira" } + }, + "library": { + "name": "Liburutegia |||| Liburutegiak", + "fields": { + "name": "Izena", + "path": "Fitxategiaren bidea", + "remotePath": "Urruneko bidea", + "lastScanAt": "Azken araketa", + "songCount": "Abestiak", + "albumCount": "Albumak", + "artistCount": "Artistak", + "totalSongs": "Abestiak", + "totalAlbums": "Albumak", + "totalArtists": "Artistak", + "totalFolders": "Karpetak", + "totalFiles": "Fitxategiak", + "totalMissingFiles": "Fitxategiak faltan", + "totalSize": "Tamaina guztira", + "totalDuration": "Iraupena", + "defaultNewUsers": "Defektuz erabiltzaile berrientzat", + "createdAt": "Sortze-data", + "updatedAt": "Eguneratze-data" + }, + "sections": { + "basic": "Oinarrizko informazioa", + "statistics": "Estatistikak" + }, + "actions": { + "scan": "Arakatu liburutegia", + "quickScan": "Araketa bizkorra", + "fullScan": "Araketa sakona", + "manageUsers": "Kudeatu erabiltzaileen sarbidea", + "viewDetails": "Ikusi xehetasunak" + }, + "notifications": { + "created": "Liburutegia ondo sortu da", + "updated": "Liburutegia ondo eguneratu da", + "deleted": "Liburutegia ondo ezabatu da", + "scanStarted": "Liburutegiaren araketa hasi da", + "quickScanStarted": "Araketa bizkorra hasi da", + "fullScanStarted": "Araketa sakona hasi da", + "scanError": "Errorea araketa abiaraztean. Aztertu erregistroak", + "scanCompleted": "Liburutegiaren araketa amaitu da" + }, + "validation": { + "nameRequired": "Liburutegiaren izena beharrezkoa da", + "pathRequired": "Liburutegiaren bidea beharrezkoa da", + "pathNotDirectory": "Liburutegiaren bidea direktorio bat izan behar da", + "pathNotFound": "Ez da liburutegiaren bidea aurkitu", + "pathNotAccessible": "Liburutegiaren bidea ez dago eskuragai", + "pathInvalid": "Liburutegiaren bidea ez da baliozkoa" + }, + "messages": { + "deleteConfirm": "Ziur liburutegia ezabatu nahi duzula? Erlazionatutako datu guztiak eta erabiltzaileen sarbidea kenduko ditu.", + "scanInProgress": "Araketa abian da…", + "noLibrariesAssigned": "Ez da liburutegirik egokitu erabiltzaile honentzat" + } + }, + "plugin": { + "name": "Plugina |||| Plugin", + "fields": { + "id": "IDa", + "name": "Izena", + "description": "Deskribapena", + "version": "Bertsioa", + "author": "Autorea", + "website": "Webgunea", + "permissions": "Baimenak", + "enabled": "Gaituta", + "status": "Egoera", + "path": "Bidea", + "lastError": "Errorea", + "hasError": "Errorea", + "updatedAt": "Eguneratuta", + "createdAt": "Instalatuta", + "configKey": "Gakoa", + "configValue": "Balioa", + "allUsers": "Baimendu erabiltzaile guztiak", + "selectedUsers": "Hautatutako erabiltzaileak", + "allLibraries": "Baimendu liburutegi guztiak", + "selectedLibraries": "Hautatutako liburutegiak" + }, + "sections": { + "status": "Egoera", + "info": "Pluginaren informazioa", + "configuration": "Konfigurazioa", + "manifest": "Manifestua", + "usersPermission": "Erabiltzaileen baimenak", + "libraryPermission": "Liburutegien baimenak" + }, + "status": { + "enabled": "Gaituta", + "disabled": "Ezgaituta" + }, + "actions": { + "enable": "Gaitu", + "disable": "Ezgaitu", + "disabledDueToError": "Konpondu errorea gaitu baino lehen", + "disabledUsersRequired": "Hautatu erabiltzaileak gaitu baino lehen", + "disabledLibrariesRequired": "Hautatu liburutegiak gaitu baino lehen", + "addConfig": "Gehitu konfigurazioa", + "rescan": "Arakatu berriro" + }, + "notifications": { + "enabled": "Plugina gaituta", + "disabled": "Plugina ezgaituta", + "updated": "Plugina eguneratuta", + "error": "Errorea plugina eguneratzean" + }, + "validation": { + "invalidJson": "Konfigurazioa baliozko JSON-a izan behar da" + }, + "messages": { + "configHelp": "Konfiguratu plugina gako-balio bikoteak erabiliz. Utzi hutsik pluginak konfiguraziorik behar ez badu.", + "configValidationError": "Huts egin du konfigurazioaren balidazioak:", + "schemaRenderError": "Ezin izan da konfigurazioaren formularioa bihurtu. Litekeena da pluginaren eskema baliozkoa ez izatea.", + "clickPermissions": "Sakatu baimen batean xehetasunetarako", + "noConfig": "Ez da konfiguraziorik ezarri", + "allUsersHelp": "Gaituta dagoenean, pluginak erabiltzaile guztiak atzitu ditzazke, baita etorkizunean sortuko direnak ere.", + "noUsers": "Ez da erabiltzailerik hautatu", + "permissionReason": "Arrazoia", + "usersRequired": "Plugin honek erabiltzaileen informaziora sarbidea behar du. Hautatu zein erabiltzaile atzitu dezakeen pluginak, edo gaitu 'Baimendu erabiltzaile guztiak'.", + "allLibrariesHelp": "Gaituta dagoenean, pluginak liburutegi guztietara izango du sarbidea, baita etorkizunean sortuko direnetara ere.", + "noLibraries": "Ez da liburutegirik hautatu", + "librariesRequired": "Plugin honek liburutegien informaziora sarbidea behar du. Hautatu zein liburutegi atzitu dezakeen pluginak, edo gaitu 'Baimendu liburutegi guztiak'.", + "requiredHosts": "Beharrezko ostatatzaileak" + }, + "placeholders": { + "configKey": "gakoa", + "configValue": "balioa" + } } }, "ra": { @@ -397,7 +540,7 @@ "bad_item": "Elementu okerra", "item_doesnt_exist": "Elementua ez dago", "http_error": "Errorea zerbitzariarekin komunikatzerakoan", - "data_provider_error": "Errorea datuen hornitzailean. Berrikusi kontsola xehetasun gehiagorako.", + "data_provider_error": "Errorea datuen hornitzailean. Aztertu kontsola xehetasun gehiagorako.", "i18n_error": "Ezin izan dira zehaztutako hizkuntzaren itzulpenak kargatu", "canceled": "Ekintza bertan behera utzi da", "logged_out": "Saioa amaitu da, konektatu berriro.", @@ -416,6 +559,7 @@ "transcodingEnabled": "Navidrome %{config}-ekin martxan dago eta, beraz, web-interfazeko transkodeketa-ataletik sistema-komandoak exekuta daitezke. Segurtasun arrazoiak tarteko, ezgaitzea gomendatzen dugu, eta transkodeketa-aukerak konfiguratzen ari zarenean bakarrik gaitzea.", "songsAddedToPlaylist": "Abesti bat zerrendara gehitu da |||| %{smart_count} abesti zerrendara gehitu dira", "noSimilarSongsFound": "Ez da antzeko abestirik aurkitu", + "startingInstantMix": "Berehalako nahastea kargatzen…", "noTopSongsFound": "Ez da aparteko abestirik aurkitu", "noPlaylistsAvailable": "Ez dago zerrendarik erabilgarri", "delete_user_title": "Ezabatu '%{name}' erabiltzailea", @@ -450,6 +594,12 @@ }, "menu": { "library": "Liburutegia", + "librarySelector": { + "allLibraries": "Liburutegi guztiak (%{count})", + "multipleLibraries": "%{total} liburutegitik %{selected} hautatuta", + "selectLibraries": "Hautatu liburutegiak", + "none": "Bat ere ez" + }, "settings": "Ezarpenak", "version": "Bertsioa", "theme": "Itxura", @@ -532,8 +682,9 @@ "activity": { "title": "Ekintzak", "totalScanned": "Arakatutako karpeta guztiak", - "quickScan": "Arakatze azkarra", + "quickScan": "Arakatze bizkorra", "fullScan": "Arakatze sakona", + "selectiveScan": "Arakatze selektiboa", "serverUptime": "Zerbitzariak piztuta daraman denbora", "serverDown": "LINEAZ KANPO", "scanType": "Mota", diff --git a/resources/i18n/fi.json b/resources/i18n/fi.json index e5ecea2ce..59f353350 100644 --- a/resources/i18n/fi.json +++ b/resources/i18n/fi.json @@ -31,12 +31,14 @@ "mood": "Tunnelma", "participants": "Lisäosallistujat", "tags": "Lisätunnisteet", - "mappedTags": "Mäpättyt tunnisteet", + "mappedTags": "Mäpätyt tunnisteet", "rawTags": "Raakatunnisteet", "bitDepth": "Bittisyvyys", "sampleRate": "Näytteenottotaajuus", "missing": "Puuttuva", - "libraryName": "Kirjasto" + "libraryName": "Kirjasto", + "composer": "Säveltäjä", + "disc": "" }, "actions": { "addToQueue": "Lisää jonoon", @@ -46,7 +48,8 @@ "download": "Lataa", "playNext": "Soita seuraavaksi", "info": "Info", - "showInPlaylist": "Näytä soittolistassa" + "showInPlaylist": "Näytä soittolistassa", + "instantMix": "Pikasekoitus" } }, "album": { @@ -301,14 +304,19 @@ "actions": { "scan": "Skannaa kirjasto", "manageUsers": "Hallitse käyttäjien pääsyä", - "viewDetails": "Näytä tiedot" + "viewDetails": "Näytä tiedot", + "quickScan": "Nopea skannaus", + "fullScan": "Täysi skannaus" }, "notifications": { "created": "Kirjasto luotu onnistuneesti", "updated": "Kirjasto päivitetty onnistuneesti", "deleted": "Kirjasto poistettu onnistuneesti", "scanStarted": "Kirjaston skannaus aloitettu", - "scanCompleted": "Kirjaston skannaus valmistunut" + "scanCompleted": "Kirjaston skannaus valmistunut", + "quickScanStarted": "Nopea skannaus aloitettu", + "fullScanStarted": "Täysi skannaus aloitettu", + "scanError": "Virhe skannauksen käynnistyksessä. Tarkista lokit" }, "validation": { "nameRequired": "Kirjaston nimi vaaditaan", @@ -319,10 +327,86 @@ "pathInvalid": "Virheellinen kirjaston polku" }, "messages": { - "deleteConfirm": "Oletko varma, että haluat poistaa tämän kirjaston? Tämä poistaa kaikki liittyvät tiedot ja käyttäjien pääsyn.", + "deleteConfirm": "Haluatko varmasti poistaa tämän kirjaston? Kaikki siihen liittyvät tiedot ja käyttäjien pääsy poistetaan.", "scanInProgress": "Skannaus käynnissä...", "noLibrariesAssigned": "Tälle käyttäjälle ei ole määritetty kirjastoja" } + }, + "plugin": { + "name": "Liitännäinen |||| Liitännäiset", + "fields": { + "id": "ID", + "name": "Nimi", + "description": "Kuvaus", + "version": "Versio", + "author": "Tekijä", + "website": "Verkkosivusto", + "permissions": "Oikeudet", + "enabled": "Käytössä", + "status": "Tila", + "path": "Polku", + "lastError": "Virhe", + "hasError": "Virhe", + "updatedAt": "Päivitetty", + "createdAt": "Asennettu", + "configKey": "Avain", + "configValue": "Arvo", + "allUsers": "Salli kaikki käyttäjät", + "selectedUsers": "Valitut käyttäjät", + "allLibraries": "Salli kaikki kirjastot", + "selectedLibraries": "Valitut kirjastot", + "allowWriteAccess": "Salli kirjoitusoikeus" + }, + "sections": { + "status": "Tila", + "info": "Lisäosan tiedot", + "configuration": "Määritykset", + "manifest": "Luettelo", + "usersPermission": "Käyttäjäoikeudet", + "libraryPermission": "Kirjaston oikeudet" + }, + "status": { + "enabled": "Käytössä", + "disabled": "Ei käytössä" + }, + "actions": { + "enable": "Ota käyttöön", + "disable": "Poista käytöstä", + "disabledDueToError": "Korjaa virhe ennen käyttöönottoa", + "disabledUsersRequired": "Valitse käyttäjät ennen käyttöönottoa", + "disabledLibrariesRequired": "Valitse kirjastot ennen käyttöönottoa", + "addConfig": "Lisää määritykset", + "rescan": "Skannaa uudelleen" + }, + "notifications": { + "enabled": "Lisäosa käytössä", + "disabled": "Lisäosa ei käytössä", + "updated": "Lisäosa päivitetty", + "error": "Virhe lisäosaa päivitettäessä" + }, + "validation": { + "invalidJson": "Määrityksen on oltava kelvollinen JSON" + }, + "messages": { + "configHelp": "Määritä lisäosa avain-arvo-parien avulla. Jätä tyhjäksi, jos lisäosa ei vaadi määrityksiä.", + "clickPermissions": "Napsauta käyttöoikeutta saadaksesi lisätietoja", + "noConfig": "Ei määritettyjä asetuksia", + "allUsersHelp": "Kun tämä on käytössä, laajennuksella on pääsy kaikkiin käyttäjiin, myös tulevaisuudessa luotaviin.", + "noUsers": "Ei valittuja käyttäjiä", + "permissionReason": "Syy", + "usersRequired": "Tämä laajennus vaatii pääsyn käyttäjätietoihin. Valitse käyttäjät, joihin laajennus voi päästä, tai ota käyttöön 'Salli kaikki käyttäjät'.", + "allLibrariesHelp": "Kun tämä on käytössä, laajennuksella on pääsy kaikkiin kirjastoihin, myös tulevaisuudessa luotaviin.", + "noLibraries": "Ei valittuja kirjastoja", + "librariesRequired": "Tämä laajennus vaatii pääsyn kirjastotietoihin. Valitse, mihin kirjastoihin laajennus voi käyttää, tai ota käyttöön 'Salli kaikki kirjastot'.", + "requiredHosts": "Vaaditut palvelimet", + "configValidationError": "Määrityksen validointi epäonnistui:", + "schemaRenderError": "Konfiguraatiolomaketta ei voi näyttää. Lisäosan skeema saattaa olla virheellinen.", + "allowWriteAccessHelp": "Kun otettu käyttöön, liitännäinen voi muokata tiedostoja kirjastohakemistoissa. Oletuksena liitännäisillä on vain luku -oikeus." + }, + "placeholders": { + "configKey": "avain", + "configValue": "arvo" + } } }, "ra": { @@ -336,7 +420,7 @@ "username": "Käyttäjänimi", "password": "Salasana", "sign_in": "Kirjaudu", - "sign_in_error": "Autentikointi epäonnistui. Yritä uudelleen", + "sign_in_error": "Kirjautuminen epäonnistui. Yritä uudelleen", "logout": "Kirjaudu ulos", "insightsCollectionNote": "Navidrome kerää anonyymejä käyttötietoja auttaakseen parantamaan\nprojektia. Paina [tästä] saadaksesi lisätietoa\nja halutessasi kieltäytyä" }, @@ -346,7 +430,7 @@ "required": "Pakollinen", "minLength": "Pitää vähintään olla %{min} merkkiä", "maxLength": "Saa olla enintään %{max} merkkiä", - "minValue": "pitää olla vähintään %{min}", + "minValue": "Pitää olla vähintään %{min}", "maxValue": "Saa olla enentään %{max}", "number": "Pitää olla numero", "email": "Pitää olla oikea sähköpostiosoite", @@ -440,7 +524,7 @@ }, "navigation": { "no_results": "Ei tuloksia", - "no_more_results": "Sivunumero %{page} on rajojen ulkopuolella. Kokeile edellinen sivu.", + "no_more_results": "Sivunumeroa %{page} ei löydy. Yritä edellistä sivua.", "page_out_of_boundaries": "Sivunumero %{page} on rajojen ulkopuolella", "page_out_from_end": "Viimeinen sivu, ei voi edetä", "page_out_from_begin": "Ensimmäinen sivu, ei voi palata", @@ -506,7 +590,14 @@ "remove_all_missing_title": "Poista kaikki puuttuvat tiedostot", "remove_all_missing_content": "Haluatko varmasti poistaa kaikki puuttuvat tiedostot tietokannasta? Tämä poistaa pysyvästi kaikki viittaukset niihin, mukaan lukien toistomäärät ja arvostelut.", "noSimilarSongsFound": "Samankaltaisia kappaleita ei löytynyt", - "noTopSongsFound": "Suosituimpia kappaleita ei löytynyt" + "noTopSongsFound": "Suosituimpia kappaleita ei löytynyt", + "startingInstantMix": "Ladataan Pikasekoitus...", + "uploadCover": "Lataa kansikuva", + "removeCover": "Poista kansikuva", + "coverUploaded": "Kansikuva päivitetty", + "coverRemoved": "Kansikuva poistettu", + "coverUploadError": "Virhe ladattaessa kansikuvaa", + "coverRemoveError": "Virhe poistettaessa kansikuvaa" }, "menu": { "library": "Kirjasto", @@ -522,7 +613,7 @@ "desktop_notifications": "Työpöytäilmoitukset", "lastfmScrobbling": "Kuuntelutottumuksen lähetys Last.fm-palveluun", "listenBrainzScrobbling": "Kuuntelutottumuksen lähetys ListenBrainz-palveluun", - "replaygain": "RepleyGain -tila", + "replaygain": "ReplayGain -tila", "preAmp": "ReplayGain esivahvistus (dB)", "gain": { "none": "Pois käytöstä", @@ -554,7 +645,7 @@ "previousTrackText": "Edellinen kappale", "reloadText": "Päivitä", "volumeText": "Äänenvoimakkuus", - "toggleLyricText": "Toggle lyric", + "toggleLyricText": "Näytä/piilota sanat", "toggleMiniModeText": "Minimoi", "destroyText": "Poista", "downloadText": "Lataa", @@ -581,18 +672,19 @@ }, "tabs": { "about": "Tietoja", - "config": "Kokoonpano" + "config": "Määritykset" }, "config": { "configName": "Konfiguraation nimi", "environmentVariable": "Ympäristömuuttuja", "currentValue": "Nykyinen arvo", - "configurationFile": "Konfiguraatiotiedosto", - "exportToml": "Vie konfiguraatio (TOML)", - "exportSuccess": "Konfiguraatio viety leikepöydälle TOML-muodossa", - "exportFailed": "Konfiguraation kopiointi epäonnistui", + "configurationFile": "Määritystiedosto", + "exportToml": "Vie määritys (TOML)", + "exportSuccess": "Määritykset viety leikepöydälle TOML-muodossa", + "exportFailed": "Määritysten kopiointi epäonnistui", "devFlagsHeader": "Kehitysliput (voivat muuttua/poistua)", - "devFlagsComment": "Nämä ovat kokeellisia asetuksia ja ne voidaan poistaa tulevissa versioissa" + "devFlagsComment": "Nämä ovat kokeellisia asetuksia ja ne voidaan poistaa tulevissa versioissa", + "downloadToml": "Lataa määritykset (TOML)" } }, "activity": { @@ -604,7 +696,8 @@ "serverDown": "SAMMUTETTU", "scanType": "Tyyppi", "status": "Skannausvirhe", - "elapsedTime": "Kulunut aika" + "elapsedTime": "Kulunut aika", + "selectiveScan": "Valikoiva" }, "help": { "title": "Navidrome pikapainikkeet", @@ -612,7 +705,7 @@ "show_help": "Näytä tämä apuvalikko", "toggle_menu": "Menuvalikko päälle ja pois", "toggle_play": "Toista / Tauko", - "prev_song": "Esellinen kappale", + "prev_song": "Edellinen kappale", "next_song": "Seuraava kappale", "vol_up": "Kovemmalle", "vol_down": "Hiljemmalle", @@ -625,4 +718,4 @@ "empty": "Ei soita mitään", "minutesAgo": "%{smart_count} minuutti sitten |||| %{smart_count} minuuttia sitten" } -} \ No newline at end of file +} diff --git a/resources/i18n/fr.json b/resources/i18n/fr.json index af3a8dd31..891fde03a 100644 --- a/resources/i18n/fr.json +++ b/resources/i18n/fr.json @@ -36,7 +36,9 @@ "bitDepth": "Profondeur de bits", "sampleRate": "Fréquence d'échantillonnage", "missing": "Manquant", - "libraryName": "Bibliothèque" + "libraryName": "Bibliothèque", + "composer": "Compositeur·e", + "disc": "" }, "actions": { "addToQueue": "Ajouter à la file", @@ -46,7 +48,8 @@ "download": "Télécharger", "playNext": "Jouer ensuite", "info": "Plus d'informations", - "showInPlaylist": "Montrer dans la playlist" + "showInPlaylist": "Montrer dans la playlist", + "instantMix": "Mix instantanné" } }, "album": { @@ -301,14 +304,19 @@ "actions": { "scan": "Scanner la bibliothèque", "manageUsers": "Gérer les accès utilisateurs", - "viewDetails": "Voir les détails" + "viewDetails": "Voir les détails", + "quickScan": "Scan Rapide", + "fullScan": "Scan Complet" }, "notifications": { "created": "Bibliothèque créée avec succès", "updated": "Bibliothèque mise à jour avec succès", "deleted": "Bibliothèque supprimée avec succès", "scanStarted": "Le scan de la bibliothèque a commencé", - "scanCompleted": "Le scan de la bibliothèque est terminé" + "scanCompleted": "Le scan de la bibliothèque est terminé", + "quickScanStarted": "Scan rapide démarré", + "fullScanStarted": "Scan complet démarré", + "scanError": "Une erreur est survenue en démarrant le scan. Veuillez regarder les logs" }, "validation": { "nameRequired": "La bibliothèque doit obligatoirement avoir un nom", @@ -323,6 +331,82 @@ "scanInProgress": "Scan en cours...", "noLibrariesAssigned": "Aucune bibliothèque pour cet utilisateur" } + }, + "plugin": { + "name": "Extension |||| Extensions", + "fields": { + "id": "ID", + "name": "Nom", + "description": "Description", + "version": "Version", + "author": "Auteur.e", + "website": "Site web", + "permissions": "Permissions", + "enabled": "Activée", + "status": "Statut", + "path": "Chemin", + "lastError": "Erreur", + "hasError": "Erreur", + "updatedAt": "Mise à jour", + "createdAt": "Installée", + "configKey": "Clef", + "configValue": "Valeur", + "allUsers": "Autoriser tous les utilisateur·rices", + "selectedUsers": "Utilisateur·rices sélectionné.e.s", + "allLibraries": "Autoriser toutes les bibliothèques", + "selectedLibraries": "Bibliothèques sélectionnées", + "allowWriteAccess": "" + }, + "sections": { + "status": "Statut", + "info": "Informations de l'extension", + "configuration": "Configuration", + "manifest": "Manifeste", + "usersPermission": "Permissions utilisateur·ices", + "libraryPermission": "Permissions des bibliothèques" + }, + "status": { + "enabled": "Activées", + "disabled": "Désactivées" + }, + "actions": { + "enable": "Activer", + "disable": "Désactiver", + "disabledDueToError": "L'erreur doit être réglée avant de pouvoir activer la bibliothèque", + "disabledUsersRequired": "Sélectionner des utilisateur·ices avant d'activer la bibliothèque", + "disabledLibrariesRequired": "Sélectionner au moins une bibliothèque", + "addConfig": "Ajouter une configuration", + "rescan": "Rescanner" + }, + "notifications": { + "enabled": "Extension activée", + "disabled": "Extension désactivée", + "updated": "Extension mise à jour", + "error": "Erreur pendant la mise à jour de l'extension" + }, + "validation": { + "invalidJson": "La configuration doit être un JSON valide" + }, + "messages": { + "configHelp": "Configurer l'extension en utilisant des paires clef/valeurs. Laisser vide si l'extension ne requiert aucune configuration.", + "clickPermissions": "Cliquer sur une permission pour plus de détails", + "noConfig": "Aucune configuration", + "allUsersHelp": "Quand sélectionnée, l'extension aura accès à l'ensemble des utilisateur·rices, y compris ceux créé.e.s dans le future.", + "noUsers": "Aucun.e utilisateur·rice sélectionné.e", + "permissionReason": "Raison", + "usersRequired": "Cette extension nécessite un accès aux informations utilisateurs. Sélectionnez les utilisateur·rices autorisé.e.s ou sélectionnez 'Tout autoriser'.", + "allLibrariesHelp": "Quand sélectionnée, cette extension aura accès à l'ensemble des bibliothèques, y compris celles créées dans le futur.", + "noLibraries": "Aucune bibliothèque sélectionnée", + "librariesRequired": "Cette extension nécessite l'accès aux information de la bibliothèque. Sélectionnez à quelles bibliothèque cette extension a accès, ou sélectionnez 'Autoriser toutes les bibliothèques'.", + "requiredHosts": "Hôtes requis", + "configValidationError": "Erreur lors de la validation de la configuration", + "schemaRenderError": "Impossible de processer la configuration. Le schéma de l'extension n'est peut-être pas valide.", + "allowWriteAccessHelp": "" + }, + "placeholders": { + "configKey": "clef", + "configValue": "valeur" + } } }, "ra": { @@ -506,7 +590,8 @@ "remove_all_missing_title": "Supprimer tous les fichiers manquants", "remove_all_missing_content": "Êtes-vous sûr(e) de vouloir supprimer tous les fichiers manquants de la base de données ? Cette action est permanente et supprimera leurs nombres d'écoutes, leur notations et tout ce qui y fait référence.", "noSimilarSongsFound": "Aucun titre similaire n'a été trouvé", - "noTopSongsFound": "Aucun meilleur titre n'a été trouvé" + "noTopSongsFound": "Aucun meilleur titre n'a été trouvé", + "startingInstantMix": "Chargement du mix instantanné..." }, "menu": { "library": "Bibliothèque", @@ -592,7 +677,8 @@ "exportSuccess": "La configuration a été copiée vers le presse-papier au format TOML", "exportFailed": "Une erreur est survenue en copiant la configuration", "devFlagsHeader": "Options de développement (peuvent être amenés à changer / être supprimés)", - "devFlagsComment": "Ces paramètres sont expérimentaux et peuvent être amenés à changer dans le futur" + "devFlagsComment": "Ces paramètres sont expérimentaux et peuvent être amenés à changer dans le futur", + "downloadToml": "Télécharger la configuration (TOML)" } }, "activity": { @@ -604,7 +690,8 @@ "serverDown": "HORS LIGNE", "scanType": "Type", "status": "Erreur de scan", - "elapsedTime": "Temps écoulé" + "elapsedTime": "Temps écoulé", + "selectiveScan": "Sélectif" }, "help": { "title": "Raccourcis Navidrome", @@ -625,4 +712,4 @@ "empty": "Aucun titre en cours de lecture", "minutesAgo": "Il y a %{smart_count} minute |||| Il y a %{smart_count} minutes" } -} \ No newline at end of file +} diff --git a/resources/i18n/gl.json b/resources/i18n/gl.json index 8cde597cc..aba22b714 100644 --- a/resources/i18n/gl.json +++ b/resources/i18n/gl.json @@ -31,8 +31,14 @@ "mood": "Estado", "participants": "Participantes adicionais", "tags": "Etiquetas adicionais", - "mappedTags": "", - "rawTags": "Etiquetas en cru" + "mappedTags": "Etiquetas mapeadas", + "rawTags": "Etiquetas en cru", + "bitDepth": "Calidade de Bit", + "sampleRate": "Taxa de mostra", + "missing": "Falta", + "libraryName": "Biblioteca", + "composer": "Composición", + "disc": "" }, "actions": { "addToQueue": "Ao final da cola", @@ -41,7 +47,9 @@ "shuffleAll": "Remexer todo", "download": "Descargar", "playNext": "A continuación", - "info": "Obter info" + "info": "Obter info", + "showInPlaylist": "Mostrar en Lista de reprodución", + "instantMix": "Mestura Súbita" } }, "album": { @@ -70,7 +78,10 @@ "releaseType": "Tipo", "grouping": "Grupos", "media": "Multimedia", - "mood": "Estado" + "mood": "Estado", + "date": "Data de gravación", + "missing": "Falta", + "libraryName": "Biblioteca" }, "actions": { "playAll": "Reproducir", @@ -102,7 +113,8 @@ "rating": "Valoración", "genre": "Xénero", "size": "Tamaño", - "role": "Rol" + "role": "Rol", + "missing": "Falta" }, "roles": { "albumartist": "Artista do álbum |||| Artistas do álbum", @@ -117,7 +129,13 @@ "mixer": "Mistura |||| Mistura", "remixer": "Remezcla |||| Remezcla", "djmixer": "Mezcla DJs |||| Mezcla DJs", - "performer": "Intérprete |||| Intérpretes" + "performer": "Intérprete |||| Intérpretes", + "maincredit": "Artista do álbum ou Artista |||| Artistas do álbum ou Artistas" + }, + "actions": { + "shuffle": "Barallar", + "radio": "Radio", + "topSongs": "Cancións destacadas" } }, "user": { @@ -134,10 +152,12 @@ "currentPassword": "Contrasinal actual", "newPassword": "Novo contrasinal", "token": "Token", - "lastAccessAt": "Último acceso" + "lastAccessAt": "Último acceso", + "libraries": "Bibliotecas" }, "helperTexts": { - "name": "Os cambios no nome aplicaranse a próxima vez que accedas" + "name": "Os cambios no nome aplicaranse a próxima vez que accedas", + "libraries": "Selecciona bibliotecas específicas para esta usuaria, ou deixa baleiro para usar as bibliotecas por defecto" }, "notifications": { "created": "Creouse a usuaria", @@ -146,7 +166,12 @@ }, "message": { "listenBrainzToken": "Escribe o token de usuaria de ListenBrainz", - "clickHereForToken": "Preme aquí para obter o token" + "clickHereForToken": "Preme aquí para obter o token", + "selectAllLibraries": "Seleccionar todas as bibliotecas", + "adminAutoLibraries": "As usuarias Admin teñen acceso por defecto a todas as bibliotecas" + }, + "validation": { + "librariesRequired": "Debes seleccionar polo menos unha biblioteca para usuarias non admins" } }, "player": { @@ -190,11 +215,17 @@ "addNewPlaylist": "Crear \"%{name}\"", "export": "Exportar", "makePublic": "Facela Pública", - "makePrivate": "Facela Privada" + "makePrivate": "Facela Privada", + "saveQueue": "Salvar a Cola como Lista de reprodución", + "searchOrCreate": "Buscar listas ou escribe para crear nova…", + "pressEnterToCreate": "Preme Enter para crear nova lista", + "removeFromSelection": "Retirar da selección" }, "message": { "duplicate_song": "Engadir cancións duplicadas", - "song_exist": "Hai duplicadas que serán engadidas á lista de reprodución. Desexas engadir as duplicadas ou omitilas?" + "song_exist": "Hai duplicadas que serán engadidas á lista de reprodución. Desexas engadir as duplicadas ou omitilas?", + "noPlaylistsFound": "Sen listas de reprodución", + "noPlaylists": "Sen listas dispoñibles" } }, "radio": { @@ -232,13 +263,149 @@ "fields": { "path": "Ruta", "size": "Tamaño", - "updatedAt": "Desapareceu o" + "updatedAt": "Desapareceu o", + "libraryName": "Biblioteca" }, "actions": { - "remove": "Retirar" + "remove": "Retirar", + "remove_all": "Retirar todo" }, "notifications": { "removed": "Ficheiro(s) faltantes retirados" + }, + "empty": "Sen ficheiros faltantes" + }, + "library": { + "name": "Biblioteca |||| Bibliotecas", + "fields": { + "name": "Nome", + "path": "Ruta", + "remotePath": "Ruta remota", + "lastScanAt": "Último escaneado", + "songCount": "Cancións", + "albumCount": "Álbums", + "artistCount": "Artistas", + "totalSongs": "Cancións", + "totalAlbums": "Álbums", + "totalArtists": "Artistas", + "totalFolders": "Cartafoles", + "totalFiles": "Ficheiros", + "totalMissingFiles": "Ficheiros que faltan", + "totalSize": "Tamaño total", + "totalDuration": "Duración", + "defaultNewUsers": "Por defecto para novas usuarias", + "createdAt": "Creada", + "updatedAt": "Actualizada" + }, + "sections": { + "basic": "Información básica", + "statistics": "Estatísticas" + }, + "actions": { + "scan": "Escanear Biblioteca", + "manageUsers": "Xestionar acceso das usuarias", + "viewDetails": "Ver detalles", + "quickScan": "Escaneado rápido", + "fullScan": "Escaneado completo" + }, + "notifications": { + "created": "Biblioteca creada correctamente", + "updated": "Biblioteca actualizada correctamente", + "deleted": "Biblioteca eliminada correctamente", + "scanStarted": "Comezou o escaneo da biblioteca", + "scanCompleted": "Completouse o escaneado da biblioteca", + "quickScanStarted": "Iniciado o escaneado rápido", + "fullScanStarted": "Iniciado o escaneado completo", + "scanError": "Erro ao escanear. Comproba o rexistro" + }, + "validation": { + "nameRequired": "Requírese un nome para a biblioteca", + "pathRequired": "Requírese unha ruta para a biblioteca", + "pathNotDirectory": "A ruta á biblioteca ten que ser un directorio", + "pathNotFound": "Non se atopa a ruta á biblioteca", + "pathNotAccessible": "A ruta á biblioteca non é accesible", + "pathInvalid": "Ruta non válida á biblioteca" + }, + "messages": { + "deleteConfirm": "Tes certeza de querer eliminar esta biblioteca? Isto eliminará todos os datos asociados e accesos de usuarias.", + "scanInProgress": "Escaneo en progreso…", + "noLibrariesAssigned": "Sen bibliotecas asignadas a esta usuaria" + } + }, + "plugin": { + "name": "Complemento |||| Complementos", + "fields": { + "id": "ID", + "name": "Nome", + "description": "Descrición", + "version": "Versión", + "author": "Autoría", + "website": "Sitio web", + "permissions": "Permisos", + "enabled": "Activado", + "status": "Estado", + "path": "Ruta", + "lastError": "Erro", + "hasError": "Erro", + "updatedAt": "Actualizado", + "createdAt": "Instalado", + "configKey": "Clave", + "configValue": "Valor", + "allUsers": "Para todas as usuarias", + "selectedUsers": "Usuarias seleccionadas", + "allLibraries": "Permitir todas as bibliotecas", + "selectedLibraries": "Selecciona bibliotecas", + "allowWriteAccess": "" + }, + "sections": { + "status": "Estado", + "info": "Info do complemento", + "configuration": "Configuración", + "manifest": "Manifesto", + "usersPermission": "Permiso sobre usuarias", + "libraryPermission": "Permiso sobre bibliotecas" + }, + "status": { + "enabled": "Activado", + "disabled": "Desactivado" + }, + "actions": { + "enable": "Activar", + "disable": "Desactivar", + "disabledDueToError": "Arranxar erro antes de activar", + "disabledUsersRequired": "Selección de usuarias antes de activar", + "disabledLibrariesRequired": "Selección de bibliotecas antes de activar", + "addConfig": "Engadir configuración", + "rescan": "Volver a escanear" + }, + "notifications": { + "enabled": "Complemento activado", + "disabled": "Complemento desactivado", + "updated": "Complemento actualizado", + "error": "Erro ao actualizar o complemento" + }, + "validation": { + "invalidJson": "A configuración debe ser un JSON válido" + }, + "messages": { + "configHelp": "Configura o complemento usando pares clave-valor. Deixa baleiro se o complemento non require configuración.", + "clickPermissions": "Preme nun permiso para ver detalles", + "noConfig": "Sen configuración establecida", + "allUsersHelp": "Ao activalo, o complemento terá acceso a todas as usuarias, incluíndo aquelas que se creen no futuro.", + "noUsers": "Sen usuarias seleccionadas", + "permissionReason": "Motivo", + "usersRequired": "O complemento precisa acceso á información sobre a usuaria. Selecciona as usuarias ás que pode acceder, ou activa 'Todas as usuarias'.", + "allLibrariesHelp": "Ao activalo, o complemento terá acceso a todas as bibliotecas, incluíndo aquelas que se creen no futuro.", + "noLibraries": "Sen bibliotecas seleccionadas", + "librariesRequired": "O complemento precisa acceso á información sobre a biblioteca. Selecciona as bibliotecas ás que pode acceder, ou activa 'Todas as bibliotecas'.", + "requiredHosts": "Servidores requeridos", + "configValidationError": "Fallou a comprobación da configuración:", + "schemaRenderError": "Non se puido aplicar a configuración. O esquema do complemento podería non ser válido.", + "allowWriteAccessHelp": "" + }, + "placeholders": { + "configKey": "clave", + "configValue": "valor" } } }, @@ -419,7 +586,12 @@ "downloadDialogTitle": "Descargar %{resource} '%{name}' (%{size})", "shareCopyToClipboard": "Copiar ao portapapeis: Ctrl+C, Enter", "remove_missing_title": "Retirar ficheiros que faltan", - "remove_missing_content": "Tes certeza de querer retirar da base de datos os ficheiros que faltan? Isto retirará de xeito permanente todas a referencias a eles, incluíndo a conta de reproducións e valoracións." + "remove_missing_content": "Tes certeza de querer retirar da base de datos os ficheiros que faltan? Isto retirará de xeito permanente todas a referencias a eles, incluíndo a conta de reproducións e valoracións.", + "remove_all_missing_title": "Retirar todos os ficheiros que faltan", + "remove_all_missing_content": "Tes certeza de querer retirar da base de datos todos os ficheiros que faltan? Isto eliminará todas as referencias a eles, incluíndo o número de reproducións e valoracións.", + "noSimilarSongsFound": "Sen cancións parecidas", + "noTopSongsFound": "Sen cancións destacadas", + "startingInstantMix": "Cargando Mestura Súbita…" }, "menu": { "library": "Biblioteca", @@ -448,7 +620,13 @@ "albumList": "Álbums", "about": "Acerca de", "playlists": "Listas de reprodución", - "sharedPlaylists": "Listas compartidas" + "sharedPlaylists": "Listas compartidas", + "librarySelector": { + "allLibraries": "Todas as bibliotecas (%{count})", + "multipleLibraries": "%{selected} de %{total} Bibliotecas", + "selectLibraries": "Seleccionar Bibliotecas", + "none": "Ningunha" + } }, "player": { "playListsText": "Reproducir cola", @@ -485,6 +663,22 @@ "disabled": "Desactivado", "waiting": "Agardando" } + }, + "tabs": { + "about": "Sobre", + "config": "Configuración" + }, + "config": { + "configName": "Nome", + "environmentVariable": "Variable de entorno", + "currentValue": "Valor actual", + "configurationFile": "Ficheiro de configuración", + "exportToml": "Exportar configuración (TOML)", + "exportSuccess": "Configuración exportada ao portapapeis no formato TOML", + "exportFailed": "Fallou a copia da configuración", + "devFlagsHeader": "Configuracións de Desenvolvemento (suxeitas a cambio/retirada)", + "devFlagsComment": "Son axustes experimentais e poden retirarse en futuras versións", + "downloadToml": "Descargar configuración (TOML)" } }, "activity": { @@ -493,7 +687,11 @@ "quickScan": "Escaneo rápido", "fullScan": "Escaneo completo", "serverUptime": "Servidor a funcionar", - "serverDown": "SEN CONEXIÓN" + "serverDown": "SEN CONEXIÓN", + "scanType": "Tipo", + "status": "Erro de escaneado", + "elapsedTime": "Tempo transcurrido", + "selectiveScan": "Selectivo" }, "help": { "title": "Atallos de Navidrome", @@ -508,5 +706,10 @@ "toggle_love": "Engadir canción a favoritas", "current_song": "Ir á Canción actual " } + }, + "nowPlaying": { + "title": "En reprodución", + "empty": "Sen reprodución", + "minutesAgo": "hai %{smart_count} minuto |||| hai %{smart_count} minutos" } -} \ No newline at end of file +} diff --git a/resources/i18n/hu.json b/resources/i18n/hu.json index a2037eb54..115b2d1a4 100644 --- a/resources/i18n/hu.json +++ b/resources/i18n/hu.json @@ -10,6 +10,7 @@ "playCount": "Lejátszások", "title": "Cím", "artist": "Előadó", + "composer": "Zeneszerző", "album": "Album", "path": "Elérési út", "libraryName": "Könyvtár", @@ -46,7 +47,8 @@ "shuffleAll": "Keverés", "download": "Letöltés", "playNext": "Lejátszás következőként", - "info": "Részletek" + "info": "Részletek", + "instantMix": "Instant keverés" } }, "album": { @@ -300,7 +302,9 @@ }, "actions": { "scan": "Könyvtár szkennelése", - "manageUsers": "Elérés kezelése", + "quickScan": "Gyors szkennelés", + "fullScan": "Teljes szkennelés", + "manageUsers": "Hozzáférés kezelése", "viewDetails": "Részletek" }, "notifications": { @@ -323,6 +327,80 @@ "scanInProgress": "Szkennelés folyamatban...", "noLibrariesAssigned": "Ehhez a felhasználóhoz nincsenek könyvtárak adva" } + }, + "plugin": { + "name": "Kiegészítő |||| Kiegészítők", + "fields": { + "id": "ID", + "name": "Név", + "description": "Leírás", + "version": "Verzió", + "author": "Fejlesztő", + "website": "Weboldal", + "permissions": "Engedélyek", + "enabled": "Engedélyezve", + "status": "Státusz", + "path": "Útvonal", + "lastError": "Hiba", + "hasError": "Hiba", + "updatedAt": "Frissítve", + "createdAt": "Telepítve", + "configKey": "Kulcs", + "configValue": "Érték", + "allUsers": "Összes felhasználó engedélyezése", + "selectedUsers": "Kiválasztott felhasználók engedélyezése", + "allLibraries": "Összes könyvtár engedélyezése", + "selectedLibraries": "Kiválasztott könyvtárak engedélyezése" + }, + "sections": { + "status": "Státusz", + "info": "Kiegészítő információi", + "configuration": "Konfiguráció", + "manifest": "Manifest", + "usersPermission": "Felhasználói engedélyek", + "libraryPermission": "Könyvtári engedélyek" + }, + "status": { + "enabled": "Engedélyezve", + "disabled": "Letiltva" + }, + "actions": { + "enable": "Engedélyezés", + "disable": "Letiltás", + "disabledDueToError": "Javítsd ki a kiegészítő hibáját", + "disabledUsersRequired": "Válassz felhasználókat", + "disabledLibrariesRequired": "Válassz könyvtárakat", + "addConfig": "Konfiguráció hozzáadása", + "rescan": "Újraszkennelés" + }, + "notifications": { + "enabled": "Kiegészítő engedélyezve", + "disabled": "Kiegészítő letiltva", + "updated": "Kiegészítő frissítve", + "error": "Hiba történt a kiegészítő frissítése közben" + }, + "validation": { + "invalidJson": "A konfigurációs JSON érvénytelen" + }, + "messages": { + "configHelp": "Konfiguráld a kiegészítőt kulcs-érték párokkal. Hagyd a mezőt üresen, ha nincs szükség konfigurációra.", + "configValidationError": "Helytelen konfiguráció:", + "schemaRenderError": "Nem sikerült megjeleníteni a konfigurációs űrlapot. A bővítmény sémája érvénytelen lehet.", + "clickPermissions": "Kattints egy engedélyre a részletekért", + "noConfig": "Nincs konfiguráció beállítva", + "allUsersHelp": "Engedélyezés esetén ez a kiegészítő hozzá fog férni minden jelenlegi és jövőben létrehozott felhasználóhoz.", + "noUsers": "Nincsenek kiválasztott felhasználók", + "permissionReason": "Indok", + "usersRequired": "Ez a kiegészítő hozzáférést kér felhasználói információkhoz. Válaszd ki, melyik felhasználókat érheti el, vagy az 'Összes felhasználó engedélyezése' opciót.", + "allLibrariesHelp": "Engedélyezés esetén ez a kiegészítő hozzá fog férni minden jelenlegi és jövőben létrehozott könyvtárhoz.", + "noLibraries": "Nincs kiválasztott könyvtár", + "librariesRequired": "Ez a kiegészítő hozzáférést kér könyvtárinformációkhoz. Válaszd ki, melyik könyvtárakat érheti el, vagy az 'Összes könyvtár engedélyezése' opciót.", + "requiredHosts": "Szükséges hostok" + }, + "placeholders": { + "configKey": "kulcs", + "configValue": "érték" + } } }, "ra": { @@ -400,7 +478,7 @@ "loading": "Betöltés", "not_found": "Nem található", "show": "%{name} #%{id}", - "empty": "Nincs %{name} még.", + "empty": "Nincsenek %{name}.", "invite": "Szeretnél egyet hozzáadni?" }, "input": { @@ -476,6 +554,7 @@ "transcodingEnabled": "A Navidrome jelenleg a következőkkel fut %{config}, ez lehetővé teszi a rendszerparancsok futtatását az átkódolási beállításokból a webes felület segítségével. Javasoljuk, hogy biztonsági okokból tiltsd ezt le, és csak az átkódolási beállítások konfigurálásának idejére kapcsold be.", "songsAddedToPlaylist": "1 szám hozzáadva a lejátszási listához |||| %{smart_count} szám hozzáadva a lejátszási listához", "noSimilarSongsFound": "Nem találhatóak hasonló számok", + "startingInstantMix": "Instant keverés töltődik...", "noTopSongsFound": "Nincsenek top számok", "noPlaylistsAvailable": "Nem áll rendelkezésre", "delete_user_title": "Felhasználó törlése '%{name}'", @@ -589,6 +668,7 @@ "currentValue": "Jelenlegi érték", "configurationFile": "Konfigurációs fájl", "exportToml": "Konfiguráció exportálása (TOML)", + "downloadToml": "Konfiguráció letöltése (TOML)", "exportSuccess": "Konfiguráció kiexportálva a vágólapra, TOML formában", "exportFailed": "Nem sikerült kimásolni a konfigurációt", "devFlagsHeader": "Fejlesztői beállítások (változások/eltávolítás jogát fenntartjuk)", @@ -598,11 +678,12 @@ "activity": { "title": "Aktivitás", "totalScanned": "Összes beolvasott mappa:", - "quickScan": "Gyors szkennelés", - "fullScan": "Teljes szkennelés", + "quickScan": "Gyors", + "fullScan": "Teljes", + "selectiveScan": "Szelektív", "serverUptime": "Szerver üzemidő", "serverDown": "OFFLINE", - "scanType": "Típus", + "scanType": "Legutóbbi szkennelés", "status": "Szkennelési hiba", "elapsedTime": "Eltelt idő" }, diff --git a/resources/i18n/id.json b/resources/i18n/id.json index 38ee2fff9..cdba66663 100644 --- a/resources/i18n/id.json +++ b/resources/i18n/id.json @@ -36,7 +36,8 @@ "bitDepth": "Bit depth", "sampleRate": "Sample rate", "missing": "Hilang", - "libraryName": "Pustaka" + "libraryName": "Pustaka", + "composer": "Komposer" }, "actions": { "addToQueue": "Tambah ke antrean", @@ -46,7 +47,8 @@ "download": "Unduh", "playNext": "Putar Berikutnya", "info": "Lihat Info", - "showInPlaylist": "Tampilkan di Playlist" + "showInPlaylist": "Tampilkan di Playlist", + "instantMix": "Mix Instan" } }, "album": { @@ -301,14 +303,19 @@ "actions": { "scan": "Pindai Pustaka", "manageUsers": "Kelola Akses Pengguna", - "viewDetails": "Lihat Detail" + "viewDetails": "Lihat Detail", + "quickScan": "Pindai Cepat", + "fullScan": "Pindai Keseluruhan" }, "notifications": { "created": "Pustaka berhasil dibuat", "updated": "Pustaka berhasil dibuat", "deleted": "Berhasil menghapus pustaka", "scanStarted": "Memindai pustaka dimulai", - "scanCompleted": "Memindai pustaka selesai" + "scanCompleted": "Memindai pustaka selesai", + "quickScanStarted": "Pemindaian cepat dimulai", + "fullScanStarted": "Pemindaian keseluruhan dimulai", + "scanError": "Kesalahan saat memulai pemindaian. Periksa log" }, "validation": { "nameRequired": "Nama pustaka diperlukan", @@ -323,6 +330,80 @@ "scanInProgress": "Pemindaian sedang berlangsung...", "noLibrariesAssigned": "Tidak ada pustaka yang ditugaskan ke pengguna ini" } + }, + "plugin": { + "name": "Plugin |||| Plugin", + "fields": { + "id": "ID", + "name": "Nama", + "description": "Deskripsi", + "version": "Versi", + "author": "Pembuat", + "website": "Situs Web", + "permissions": "Perizinan", + "enabled": "Diaktifkan", + "status": "Status", + "path": "Jalur", + "lastError": "Kesalahan", + "hasError": "Kesalahan", + "updatedAt": "Diperbarui", + "createdAt": "Terinstal", + "configKey": "Key", + "configValue": "Value", + "allUsers": "Izinkan semua pengguna", + "selectedUsers": "Pengguna yang dipilih", + "allLibraries": "Izinkan semua pustaka", + "selectedLibraries": "Pustaka dipilih" + }, + "sections": { + "status": "Status", + "info": "Informasi plugin", + "configuration": "Konfigurasi", + "manifest": "Manifes", + "usersPermission": "Pengguna yang Diizinkan", + "libraryPermission": "Pustaka yang Diizinkan" + }, + "status": { + "enabled": "Diaktifkan", + "disabled": "Dinonaktifkan" + }, + "actions": { + "enable": "Aktifkan", + "disable": "Nonaktifkan", + "disabledDueToError": "Perbaiki kesalahan sebelum diaktifkan", + "disabledUsersRequired": "Pilih pengguna sebelum diaktifkan", + "disabledLibrariesRequired": "Pilih pustaka sebelum diaktifkan", + "addConfig": "Tambahkan Konfigurasi", + "rescan": "Pindai ulang" + }, + "notifications": { + "enabled": "Plugin diaktifkan", + "disabled": "Plugin dinonaktifkan", + "updated": "Plugin diperbarui", + "error": "Kesalahan saat memperbarui plugin" + }, + "validation": { + "invalidJson": "Konfigurasi harus berupa JSON yang valid" + }, + "messages": { + "configHelp": "Konfigurasikan plugin menggunakan key-value pairs. Biarkan kosong jika plugin tidak membutuhkan konfigurasi.", + "clickPermissions": "Klik perizinan untuk detail", + "noConfig": "Konfigurasi tidak diatur", + "allUsersHelp": "Ketika diaktifkan, plugin akan mengakses untuk semua pengguna, termasuk yang akan dibuat di masa depan.", + "noUsers": "Tidak ada pengguna yang dipilih", + "permissionReason": "Alasan", + "usersRequired": "Plugin ini membutuhkan akses ke informasi pengguna. Pilih pengguna yang bisa mengakses plugin, atau aktifkan 'Izinkan semua pengguna'.", + "allLibrariesHelp": "Ketika diaktifkan, plugin akan memiliki akses ke semua pustaka, termasuk yang dibuat di masa depan.", + "noLibraries": "Tidak ada pustaka yang dipilih", + "librariesRequired": "Plugin ini membutuhkan akses ke informasi pustaka. Pilih beberapa pustaka yang bisa diakses, atau aktifkan 'Izinkan semua pustaka'.", + "requiredHosts": "Hosts diperlukan", + "configValidationError": "Validasi konfigurasi gagal:", + "schemaRenderError": "Tidak dapat menampilkan form konfigurasi. Skema plugin mungkin tidak valid." + }, + "placeholders": { + "configKey": "key", + "configValue": "value" + } } }, "ra": { @@ -506,7 +587,8 @@ "remove_all_missing_title": "Hapus semua file yang hilang", "remove_all_missing_content": "Apa kamu yakin ingin menghapus semua file dari database? Ini akan menghapus permanen dan apapun referensi ke mereka, termasuk hitungan pemutaran dan rating mereka.", "noSimilarSongsFound": "Tidak ada lagu yang serupa ditemukan", - "noTopSongsFound": "Tidak ada lagu teratas ditemukan" + "noTopSongsFound": "Tidak ada lagu teratas ditemukan", + "startingInstantMix": "Memuat Mix Instan..." }, "menu": { "library": "Pustaka", @@ -604,7 +686,8 @@ "serverDown": "LURING", "scanType": "Tipe", "status": "Kesalahan Memindai", - "elapsedTime": "Waktu Berakhir" + "elapsedTime": "Waktu Berakhir", + "selectiveScan": "Selektif" }, "help": { "title": "Tombol Pintasan Navidrome", diff --git a/resources/i18n/it.json b/resources/i18n/it.json index 9d1c2bb74..11fadb46b 100644 --- a/resources/i18n/it.json +++ b/resources/i18n/it.json @@ -400,8 +400,8 @@ }, "albumList": "Album", "about": "Info", - "playlists": "Scalette", - "sharedPlaylists": "Scalette Condivise" + "playlists": "Playlist", + "sharedPlaylists": "Playlist Condivise" }, "player": { "playListsText": "Coda", @@ -457,4 +457,4 @@ "current_song": "" } } -} \ No newline at end of file +} diff --git a/resources/i18n/ja.json b/resources/i18n/ja.json index fbf8cefd2..29975b92b 100644 --- a/resources/i18n/ja.json +++ b/resources/i18n/ja.json @@ -27,12 +27,16 @@ "playDate": "最後の再生", "channels": "チャンネル", "createdAt": "追加日", - "grouping": "", - "mood": "", - "participants": "", - "tags": "", - "mappedTags": "", - "rawTags": "" + "grouping": "グループ分け", + "mood": "ムード", + "participants": "追加参加者", + "tags": "追加タグ", + "mappedTags": "マッピング済みタグ", + "rawTags": "未処理タグ", + "bitDepth": "ビット深度", + "sampleRate": "サンプリングレート", + "missing": "不明", + "libraryName": "ライブラリ" }, "actions": { "addToQueue": "最後に再生", @@ -41,7 +45,8 @@ "shuffleAll": "全曲シャッフル", "download": "ダウンロード", "playNext": "次に再生", - "info": "詳細" + "info": "詳細", + "showInPlaylist": "含まれるプレイリスト" } }, "album": { @@ -65,12 +70,15 @@ "releaseDate": "リリース日", "releases": "リリース", "released": "リリース", - "recordLabel": "", - "catalogNum": "", - "releaseType": "", - "grouping": "", - "media": "", - "mood": "" + "recordLabel": "ラベル", + "catalogNum": "カタログ番号", + "releaseType": "タイプ", + "grouping": "グループ分け", + "media": "メディア", + "mood": "ムード", + "date": "録音日", + "missing": "不明", + "libraryName": "ライブラリ" }, "actions": { "playAll": "再生", @@ -102,22 +110,29 @@ "rating": "レート", "genre": "ジャンル", "size": "サイズ", - "role": "" + "role": "役割", + "missing": "不明" }, "roles": { - "albumartist": "", - "artist": "", - "composer": "", - "conductor": "", - "lyricist": "", - "arranger": "", - "producer": "", - "director": "", - "engineer": "", - "mixer": "", - "remixer": "", - "djmixer": "", - "performer": "" + "albumartist": "アルバムアーティスト", + "artist": "アーティスト", + "composer": "作曲家", + "conductor": "指揮者", + "lyricist": "作詞家", + "arranger": "編曲者", + "producer": "プロデューサー", + "director": "ディレクター", + "engineer": "エンジニア", + "mixer": "ミキサー", + "remixer": "リミキサー", + "djmixer": "DJ ミキサー", + "performer": "演奏者", + "maincredit": "アルバムアーティストもしくはアーティスト" + }, + "actions": { + "shuffle": "シャッフル", + "radio": "ラジオ", + "topSongs": "トップソング" } }, "user": { @@ -134,10 +149,12 @@ "currentPassword": "現在のパスワード", "newPassword": "新しいパスワード", "token": "トークン", - "lastAccessAt": "最終アクセス" + "lastAccessAt": "最終アクセス", + "libraries": "ライブラリ" }, "helperTexts": { - "name": "名前の変更は次回ログイン以降反映されます" + "name": "名前の変更は次回ログイン以降反映されます", + "libraries": "このユーザーに対して特定ライブラリを選択するか、デフォルトのライブラリを使用する場合は空欄のままにします" }, "notifications": { "created": "ユーザーが作成されました", @@ -146,7 +163,12 @@ }, "message": { "listenBrainzToken": "ListenBrainzユーザートークンを入力", - "clickHereForToken": "ここをクリックしトークンを入手" + "clickHereForToken": "ここをクリックしトークンを入手", + "selectAllLibraries": "全てのライブラリを選択", + "adminAutoLibraries": "管理者ユーザーは自動的にすべてのライブラリにアクセスできます" + }, + "validation": { + "librariesRequired": "管理者以外のユーザーには少なくとも1つのライブラリを選択する必要があります" } }, "player": { @@ -190,11 +212,17 @@ "addNewPlaylist": "'%{name}' を作成", "export": "エクスポート", "makePublic": "公開する", - "makePrivate": "非公開にする" + "makePrivate": "非公開にする", + "saveQueue": "キューをプレイリストに保存", + "searchOrCreate": "プレイリストを検索または入力して新規作成...", + "pressEnterToCreate": "Enterキーを押して新しいプレイリストを作成", + "removeFromSelection": "選択から削除" }, "message": { "duplicate_song": "重複する曲を追加", - "song_exist": "既にプレイリストに存在する曲です。追加しますか？" + "song_exist": "既にプレイリストに存在する曲です。追加しますか？", + "noPlaylistsFound": "プレイリストが見つかりません", + "noPlaylists": "利用可能なプレイリストはありません" } }, "radio": { @@ -228,17 +256,77 @@ } }, "missing": { - "name": "", + "name": "欠落したファイル", "fields": { - "path": "", - "size": "", - "updatedAt": "" + "path": "パス", + "size": "サイズ", + "updatedAt": "欠落日", + "libraryName": "ライブラリ" }, "actions": { - "remove": "" + "remove": "削除", + "remove_all": "全て削除" }, "notifications": { - "removed": "" + "removed": "欠落ファイルが削除されました" + }, + "empty": "ファイルの欠落はありません" + }, + "library": { + "name": "ライブラリ", + "fields": { + "name": "名前", + "path": "パス", + "remotePath": "リモートパス", + "lastScanAt": "最終スキャン", + "songCount": "曲数", + "albumCount": "アルバム数", + "artistCount": "アーティスト数", + "totalSongs": "曲数", + "totalAlbums": "アルバム数", + "totalArtists": "アーティスト数", + "totalFolders": "フォルダー数", + "totalFiles": "ファイル数", + "totalMissingFiles": "欠落したファイル", + "totalSize": "合計サイズ", + "totalDuration": "合計時間", + "defaultNewUsers": "新規ユーザーに対するデフォルト", + "createdAt": "作成日", + "updatedAt": "更新日" + }, + "sections": { + "basic": "基本情報", + "statistics": "統計" + }, + "actions": { + "scan": "ライブラリをスキャン", + "manageUsers": "ユーザーアクセス管理", + "viewDetails": "詳細を表示", + "quickScan": "クイックスキャン", + "fullScan": "フルスキャン" + }, + "notifications": { + "created": "ライブラリが正常に作成されました", + "updated": "ライブラリが正常に更新されました", + "deleted": "ライブラリが正常に削除されました", + "scanStarted": "スキャンを開始しました", + "scanCompleted": "スキャンが完了しました", + "quickScanStarted": "クイックスキャンを開始しました", + "fullScanStarted": "フルスキャンを開始しました", + "scanError": "スキャン開始中にエラーが発生。ログを確認してください" + }, + "validation": { + "nameRequired": "ライブラリの名前が必要です", + "pathRequired": "ライブラリのパスが必要です", + "pathNotDirectory": "ライブラリパスはディレクトリである必要があります", + "pathNotFound": "ライブラリのパスが見つかりません", + "pathNotAccessible": "ライブラリパスへアクセスできません", + "pathInvalid": "無効なライブラリパス" + }, + "messages": { + "deleteConfirm": "このライブラリを削除しますか？関連する全てのデータとユーザーアクセスが削除されます。", + "scanInProgress": "スキャン中...", + "noLibrariesAssigned": "このユーザーに割り当てられているライブラリはありません" } } }, @@ -418,8 +506,12 @@ "shareFailure": "コピーに失敗しました %{url}", "downloadDialogTitle": "ダウンロード %{resource} '%{name}' (%{size})", "shareCopyToClipboard": "クリップボードへコピー: Ctrl+C, Enter", - "remove_missing_title": "", - "remove_missing_content": "" + "remove_missing_title": "欠落ファイルを削除", + "remove_missing_content": "選択した欠落ファイルをデータベースから削除してもよろしいですか？これにより、再生数や評価を含むそれらのファイルへの参照が完全に削除されます。", + "remove_all_missing_title": "全ての欠落ファイルを削除", + "remove_all_missing_content": "データベースから欠落ファイルをすべて削除してもよろしいですか？これにより、再生数や評価を含むそれらのファイルへの参照が永久に削除されます。", + "noSimilarSongsFound": "類似の曲が見つかりませんでした", + "noTopSongsFound": "トップソングが見つかりません" }, "menu": { "library": "ライブラリ", @@ -448,7 +540,13 @@ "albumList": "アルバム", "about": "詳細", "playlists": "プレイリスト", - "sharedPlaylists": "共有プレイリスト" + "sharedPlaylists": "共有プレイリスト", + "librarySelector": { + "allLibraries": "全てのライブラリ( %{count} )", + "multipleLibraries": "%{selected} 個 / %{total} 個のライブラリ", + "selectLibraries": "ライブラリを選択", + "none": "無し" + } }, "player": { "playListsText": "再生リスト", @@ -485,15 +583,34 @@ "disabled": "無効", "waiting": "待機中" } + }, + "tabs": { + "about": "詳細", + "config": "設定" + }, + "config": { + "configName": "設定名", + "environmentVariable": "環境変数", + "currentValue": "現在値", + "configurationFile": "設定ファイル", + "exportToml": "設定をエクスポート(TOML)", + "exportSuccess": "設定をTOML形式でクリップボードへエクスポートしました", + "exportFailed": "設定のコピーに失敗しました", + "devFlagsHeader": "開発フラグ(変更・削除の可能性あり)", + "devFlagsComment": "これらは実験的な設定であり、将来のバージョンで削除される可能性があります" } }, "activity": { "title": "活動", "totalScanned": "スキャン済みフォルダー", - "quickScan": "クイックスキャン", - "fullScan": "フルスキャン", + "quickScan": "クイック", + "fullScan": "フル", "serverUptime": "サーバー稼働時間", - "serverDown": "サーバーオフライン" + "serverDown": "サーバーオフライン", + "scanType": "最終スキャン", + "status": "スキャンエラー", + "elapsedTime": "経過時間", + "selectiveScan": "選択的スキャン" }, "help": { "title": "ホットキー", @@ -508,5 +625,10 @@ "toggle_love": "星の付け外し", "current_song": "現在の曲へ移動" } + }, + "nowPlaying": { + "title": "再生中", + "empty": "何も再生されていません", + "minutesAgo": "%{smart_count} 分前 |||| %{smart_count} 分前" } } \ No newline at end of file diff --git a/resources/i18n/ko.json b/resources/i18n/ko.json index a8b26df6d..6b81e02d8 100644 --- a/resources/i18n/ko.json +++ b/resources/i18n/ko.json @@ -12,6 +12,7 @@ "artist": "아티스트", "album": "앨범", "path": "파일 경로", + "libraryName": "라이브러리", "genre": "장르", "compilation": "컴필레이션", "year": "년", @@ -34,7 +35,8 @@ "participants": "추가 참가자", "tags": "추가 태그", "mappedTags": "매핑된 태그", - "rawTags": "원시 태그" + "rawTags": "원시 태그", + "missing": "누락" }, "actions": { "addToQueue": "나중에 재생", @@ -56,6 +58,7 @@ "playCount": "재생 횟수", "size": "크기", "name": "이름", + "libraryName": "라이브러리", "genre": "장르", "compilation": "컴필레이션", "year": "년", @@ -73,7 +76,8 @@ "releaseType": "유형", "grouping": "그룹", "media": "미디어", - "mood": "분위기" + "mood": "분위기", + "missing": "누락" }, "actions": { "playAll": "재생", @@ -105,7 +109,8 @@ "playCount": "재생 횟수", "rating": "평가", "genre": "장르", - "role": "역할" + "role": "역할", + "missing": "누락" }, "roles": { "albumartist": "앨범 아티스트 |||| 앨범 아티스트들", @@ -120,7 +125,13 @@ "mixer": "믹서 |||| 믹서들", "remixer": "리믹서 |||| 리믹서들", "djmixer": "DJ 믹서 |||| DJ 믹서들", - "performer": "공연자 |||| 공연자들" + "performer": "공연자 |||| 공연자들", + "maincredit": "앨범 아티스트 또는 아티스트 |||| 앨범 아티스트들 또는 아티스트들" + }, + "actions": { + "topSongs": "인기곡", + "shuffle": "셔플", + "radio": "라디오" } }, "user": { @@ -137,19 +148,26 @@ "changePassword": "비밀번호를 변경할까요?", "currentPassword": "현재 비밀번호", "newPassword": "새 비밀번호", - "token": "토큰" + "token": "토큰", + "libraries": "라이브러리" }, "helperTexts": { - "name": "이름 변경 사항은 다음 로그인 시에만 반영됨" + "name": "이름 변경 사항은 다음 로그인 시에만 반영됨", + "libraries": "이 사용자에 대한 특정 라이브러리를 선택하거나 기본 라이브러리를 사용하려면 비움" }, "notifications": { "created": "사용자 생성됨", "updated": "사용자 업데이트됨", "deleted": "사용자 삭제됨" }, + "validation": { + "librariesRequired": "관리자가 아닌 사용자의 경우 최소한 하나의 라이브러리를 선택해야 함" + }, "message": { "listenBrainzToken": "ListenBrainz 사용자 토큰을 입력하세요.", - "clickHereForToken": "여기를 클릭하여 토큰을 얻으세요" + "clickHereForToken": "여기를 클릭하여 토큰을 얻으세요", + "selectAllLibraries": "모든 라이브러리 선택", + "adminAutoLibraries": "관리자 사용자는 자동으로 모든 라이브러리에 접속할 수 있음" } }, "player": { @@ -192,12 +210,18 @@ "selectPlaylist": "재생목록 선택:", "addNewPlaylist": "\"%{name}\" 만들기", "export": "내보내기", + "saveQueue": "재생목록에 대기열 저장", "makePublic": "공개 만들기", - "makePrivate": "비공개 만들기" + "makePrivate": "비공개 만들기", + "searchOrCreate": "재생목록을 검색하거나 입력하여 새 재생목록을 만드세요...", + "pressEnterToCreate": "새 재생목록을 만드려면 Enter 키를 누름", + "removeFromSelection": "선택에서 제거" }, "message": { "duplicate_song": "중복된 노래 추가", - "song_exist": "이미 재생목록에 존재하는 노래입니다. 중복을 추가할까요 아니면 건너뛸까요?" + "song_exist": "이미 재생목록에 존재하는 노래입니다. 중복을 추가할까요 아니면 건너뛸까요?", + "noPlaylistsFound": "재생목록을 찾을 수 없음", + "noPlaylists": "사용 가능한 재생 목록이 없음" } }, "radio": { @@ -238,14 +262,68 @@ "fields": { "path": "경로", "size": "크기", + "libraryName": "라이브러리", "updatedAt": "사라짐" }, "actions": { - "remove": "제거" + "remove": "제거", + "remove_all": "모두 제거" }, "notifications": { "removed": "누락된 파일이 제거되었음" } + }, + "library": { + "name": "라이브러리 |||| 라이브러리들", + "fields": { + "name": "이름", + "path": "경로", + "remotePath": "원격 경로", + "lastScanAt": "최근 스캔", + "songCount": "노래", + "albumCount": "앨범", + "artistCount": "아티스트", + "totalSongs": "노래", + "totalAlbums": "앨범", + "totalArtists": "아티스트", + "totalFolders": "폴더", + "totalFiles": "파일", + "totalMissingFiles": "누락된 파일", + "totalSize": "총 크기", + "totalDuration": "기간", + "defaultNewUsers": "신규 사용자 기본값", + "createdAt": "생성됨", + "updatedAt": "업데이트됨" + }, + "sections": { + "basic": "기본 정보", + "statistics": "통계" + }, + "actions": { + "scan": "라이브러리 스캔", + "manageUsers": "자용자 접속 관리", + "viewDetails": "상세 보기" + }, + "notifications": { + "created": "라이브러리가 성공적으로 생성됨", + "updated": "라이브러리가 성공적으로 업데이트됨", + "deleted": "라이브러리가 성공적으로 삭제됨", + "scanStarted": "라이브러리 스캔 스작됨", + "scanCompleted": "라이브러리 스캔 완료됨" + }, + "validation": { + "nameRequired": "라이브러리 이름이 필요함", + "pathRequired": "라이브러리 경로가 필요함", + "pathNotDirectory": "라이브러리 경로는 디렉터리여야 함", + "pathNotFound": "라이브러리 경로를 찾을 수 없음", + "pathNotAccessible": "라이브러리 경로에 접근할 수 없음", + "pathInvalid": "잘못된 라이브러리 경로" + }, + "messages": { + "deleteConfirm": "이 라이브러리를 삭제할까요? 삭제하면 연결된 모든 데이터와 사용자 접속 권한이 제거됩니다.", + "scanInProgress": "스캔 진행 중...", + "noLibrariesAssigned": "이 사용자에게 할당된 라이브러리가 없음" + } } }, "ra": { @@ -398,11 +476,15 @@ "transcodingDisabled": "웹 인터페이스를 통한 트랜스코딩 구성 변경은 보안상의 이유로 비활성화되어 있습니다. 트랜스코딩 옵션을 변경(편집 또는 추가)하려면, %{config} 구성 옵션으로 서버를 다시 시작하세요.", "transcodingEnabled": "Navidrome은 현재 %{config}로 실행 중이므로 웹 인터페이스를 사용하여 트랜스코딩 설정에서 시스템 명령을 실행할 수 있습니다. 보안상의 이유로 비활성화하고 트랜스코딩 옵션을 구성할 때만 활성화하는 것이 좋습니다.", "songsAddedToPlaylist": "1 개의 노래를 재생목록에 추가하였음 |||| %{smart_count} 개의 노래를 재생 목록에 추가하였음", + "noSimilarSongsFound": "비슷한 노래를 찾을 수 없음", + "noTopSongsFound": "인기곡을 찾을 수 없음", "noPlaylistsAvailable": "사용 가능한 노래 없음", "delete_user_title": "사용자 '%{name}' 삭제", "delete_user_content": "이 사용자와 해당 사용자의 모든 데이터(재생 목록 및 환경 설정 포함)를 삭제할까요?", "remove_missing_title": "누락된 파일들 제거", "remove_missing_content": "선택한 누락된 파일을 데이터베이스에서 삭제할까요? 삭제하면 재생 횟수 및 평점을 포함하여 해당 파일에 대한 모든 참조가 영구적으로 삭제됩니다.", + "remove_all_missing_title": "누락된 모든 파일 제거", + "remove_all_missing_content": "데이터베이스에서 누락된 모든 파일을 제거할까요? 이렇게 하면 해당 게임의 플레이 횟수와 평점을 포함한 모든 참조 내용이 영구적으로 삭제됩니다.", "notifications_blocked": "브라우저 설정에서 이 사이트의 알림을 차단하였음", "notifications_not_available": "이 브라우저는 데스크톱 알림을 지원하지 않거나 https를 통해 Navidrome에 접속하고 있지 않음", "lastfmLinkSuccess": "Last.fm이 성공적으로 연결되었고 스크로블링이 활성화되었음", @@ -429,6 +511,12 @@ }, "menu": { "library": "라이브러리", + "librarySelector": { + "allLibraries": "모든 라이브러리 (%{count})", + "multipleLibraries": "%{selected} / %{total} 라이브러리", + "selectLibraries": "라이브러리 선택", + "none": "없음" + }, "settings": "설정", "version": "버전", "theme": "테마", @@ -491,6 +579,21 @@ "disabled": "비활성화", "waiting": "대기중" } + }, + "tabs": { + "about": "정보", + "config": "구성" + }, + "config": { + "configName": "구성 이름", + "environmentVariable": "환경 변수", + "currentValue": "현재 값", + "configurationFile": "구성 파일", + "exportToml": "구성 내보내기 (TOML)", + "exportSuccess": "TOML 형식으로 클립보드로 내보낸 구성", + "exportFailed": "구성 복사 실패", + "devFlagsHeader": "개발 플래그 (변경/삭제 가능)", + "devFlagsComment": "이는 실험적 설정이므로 향후 버전에서 제거될 수 있음" } }, "activity": { @@ -499,7 +602,15 @@ "quickScan": "빠른 스캔", "fullScan": "전체 스캔", "serverUptime": "서버 가동 시간", - "serverDown": "오프라인" + "serverDown": "오프라인", + "scanType": "유형", + "status": "스캔 오류", + "elapsedTime": "경과 시간" + }, + "nowPlaying": { + "title": "현재 재생 중", + "empty": "재생 중인 콘텐츠 없음", + "minutesAgo": "%{smart_count} 분 전" }, "help": { "title": "Navidrome 단축키", diff --git a/resources/i18n/nl.json b/resources/i18n/nl.json index 4737cb33a..86793ee19 100644 --- a/resources/i18n/nl.json +++ b/resources/i18n/nl.json @@ -5,7 +5,7 @@ "name": "Nummer |||| Nummers", "fields": { "albumArtist": "Album Artiest", - "duration": "Lengte", + "duration": "Afspeelduur", "trackNumber": "Nummer #", "playCount": "Aantal keren afgespeeld", "title": "Titel", @@ -35,7 +35,9 @@ "rawTags": "Onbewerkte tags", "bitDepth": "Bit diepte", "sampleRate": "Sample waarde", - "missing": "Ontbrekend" + "missing": "Ontbrekend", + "libraryName": "Bibliotheek", + "composer": "" }, "actions": { "addToQueue": "Voeg toe aan wachtrij", @@ -44,7 +46,9 @@ "shuffleAll": "Shuffle alles", "download": "Downloaden", "playNext": "Volgende", - "info": "Meer info" + "info": "Meer info", + "showInPlaylist": "Toon in afspeellijst", + "instantMix": "" } }, "album": { @@ -55,7 +59,7 @@ "duration": "Afspeelduur", "songCount": "Nummers", "playCount": "Aantal keren afgespeeld", - "name": "Naam", + "name": "Titel", "genre": "Genre", "compilation": "Compilatie", "year": "Jaar", @@ -65,9 +69,9 @@ "createdAt": "Datum toegevoegd", "size": "Grootte", "originalDate": "Origineel", - "releaseDate": "Uitgegeven", + "releaseDate": "Uitgave", "releases": "Uitgave |||| Uitgaven", - "released": "Uitgegeven", + "released": "Uitgave", "recordLabel": "Label", "catalogNum": "Catalogus nummer", "releaseType": "Type", @@ -75,7 +79,8 @@ "media": "Media", "mood": "Sfeer", "date": "Opnamedatum", - "missing": "Ontbrekend" + "missing": "Ontbrekend", + "libraryName": "Bibliotheek" }, "actions": { "playAll": "Afspelen", @@ -123,7 +128,13 @@ "mixer": "Mixer |||| Mixers", "remixer": "Remixer |||| Remixers", "djmixer": "DJ Mixer |||| DJ Mixers", - "performer": "Performer |||| Performers" + "performer": "Performer |||| Performers", + "maincredit": "Album Artiest of Artiest |||| Album Artiesten or Artiesten" + }, + "actions": { + "shuffle": "Shuffle", + "radio": "Radio", + "topSongs": "Beste nummers" } }, "user": { @@ -132,7 +143,7 @@ "userName": "Gebruikersnaam", "isAdmin": "Is beheerder", "lastLoginAt": "Laatst ingelogd op", - "updatedAt": "Laatst gewijzigd op", + "updatedAt": "Laatst bijgewerkt op", "name": "Naam", "password": "Wachtwoord", "createdAt": "Aangemaakt op", @@ -140,19 +151,26 @@ "currentPassword": "Huidig wachtwoord", "newPassword": "Nieuw wachtwoord", "token": "Token", - "lastAccessAt": "Meest recente toegang" + "lastAccessAt": "Meest recente toegang", + "libraries": "Bibliotheken" }, "helperTexts": { - "name": "Naamswijziging wordt pas zichtbaar bij de volgende login" + "name": "Naamswijziging wordt pas zichtbaar bij de volgende login", + "libraries": "Selecteer specifieke bibliotheken voor deze gebruiker, of laat leeg om de standaardbiblliotheken te gebruiken" }, "notifications": { "created": "Aangemaakt door gebruiker", - "updated": "Gewijzigd door gebruiker", - "deleted": "Gewist door gebruiker" + "updated": "Bijgewerkt door gebruiker", + "deleted": "Gebruiker verwijderd" }, "message": { "listenBrainzToken": "Vul je ListenBrainz gebruikers-token in.", - "clickHereForToken": "Klik hier voor je token" + "clickHereForToken": "Klik hier voor je token", + "selectAllLibraries": "Selecteer alle bibliotheken", + "adminAutoLibraries": "Admin gebruikers hebben automatisch toegang tot alle bibliotheken" + }, + "validation": { + "librariesRequired": "Minstens één bibliotheek moet geselecteerd worden voor niet-admin gebruikers" } }, "player": { @@ -181,10 +199,10 @@ "name": "Afspeellijst |||| Afspeellijsten", "fields": { "name": "Titel", - "duration": "Lengte", + "duration": "Afspeelduur", "ownerName": "Eigenaar", "public": "Publiek", - "updatedAt": "Laatst gewijzigd op", + "updatedAt": "Laatst bijgewerkt op", "createdAt": "Aangemaakt op", "songCount": "Nummers", "comment": "Commentaar", @@ -197,11 +215,16 @@ "export": "Exporteer", "makePublic": "Openbaar maken", "makePrivate": "Privé maken", - "saveQueue": "Bewaar wachtrij als playlist" + "saveQueue": "Bewaar wachtrij als playlist", + "searchOrCreate": "Zoek afspeellijsten of typ om een nieuwe te starten...", + "pressEnterToCreate": "Druk Enter om nieuwe afspeellijst te maken", + "removeFromSelection": "Verwijder van selectie" }, "message": { "duplicate_song": "Dubbele nummers toevoegen", - "song_exist": "Er komen nummers dubbel in de afspeellijst. Wil je de dubbele nummers toevoegen of overslaan?" + "song_exist": "Er komen nummers dubbel in de afspeellijst. Wil je de dubbele nummers toevoegen of overslaan?", + "noPlaylistsFound": "Geen playlists gevonden", + "noPlaylists": "Geen playlists beschikbaar" } }, "radio": { @@ -210,8 +233,8 @@ "name": "Naam", "streamUrl": "Stream URL", "homePageUrl": "Hoofdpagina URL", - "updatedAt": "Geüpdate op", - "createdAt": "Gecreëerd op" + "updatedAt": "Bijgewerkt op", + "createdAt": "Aangemaakt op" }, "actions": { "playNow": "Speel nu" @@ -229,8 +252,8 @@ "visitCount": "Bezocht", "format": "Formaat", "maxBitRate": "Max. bitrate", - "updatedAt": "Geüpdatet op", - "createdAt": "Gecreëerd op", + "updatedAt": "Bijgewerkt op", + "createdAt": "Aangemaakt op", "downloadable": "Downloads toestaan?" } }, @@ -239,7 +262,8 @@ "fields": { "path": "Pad", "size": "Grootte", - "updatedAt": "Verdwenen op" + "updatedAt": "Verdwenen op", + "libraryName": "Bibliotheek" }, "actions": { "remove": "Verwijder", @@ -249,6 +273,137 @@ "removed": "Ontbrekende bestanden verwijderd" }, "empty": "Geen ontbrekende bestanden" + }, + "library": { + "name": "Bibliotheek |||| Bibliotheken", + "fields": { + "name": "Naam", + "path": "Pad", + "remotePath": "Extern pad", + "lastScanAt": "Laatste scan", + "songCount": "Nummers", + "albumCount": "Albums", + "artistCount": "Artiesten", + "totalSongs": "Nummers", + "totalAlbums": "Albums", + "totalArtists": "Artiesten", + "totalFolders": "Mappen", + "totalFiles": "Bestanden", + "totalMissingFiles": "Ontbrekende bestanden", + "totalSize": "Totale bestandsgrootte", + "totalDuration": "Afspeelduur", + "defaultNewUsers": "Standaard voor nieuwe gebruikers", + "createdAt": "Aangemaakt", + "updatedAt": "Bijgewerkt" + }, + "sections": { + "basic": "Basisinformatie", + "statistics": "Statistieken" + }, + "actions": { + "scan": "Scan bibliotheek", + "manageUsers": "Beheer gebruikerstoegang", + "viewDetails": "Bekijk details", + "quickScan": "Snelle scan", + "fullScan": "Volledige scan" + }, + "notifications": { + "created": "Bibliotheek succesvol aangemaakt", + "updated": "Bibliotheek succesvol bijgewerkt", + "deleted": "Bibliotheek succesvol verwijderd", + "scanStarted": "Bibliotheekscan is gestart", + "scanCompleted": "Bibliotheekscan is voltooid", + "quickScanStarted": "Snelle scan gestart", + "fullScanStarted": "Volledige scan gestart", + "scanError": "Fout bij start van scan. Check de logs" + }, + "validation": { + "nameRequired": "Bibliotheek naam is vereist", + "pathRequired": "Pad naar bibliotheek is vereist", + "pathNotDirectory": "Pad naar bibliotheek moet een map zijn", + "pathNotFound": "Pad naar bibliotheek niet gevonden", + "pathNotAccessible": "Pad naar bibliotheek is niet toegankelijk", + "pathInvalid": "Ongeldig pad naar bibliotheek" + }, + "messages": { + "deleteConfirm": "Weet je zeker dat je deze bibliotheek wil verwijderen? Dit verwijdert ook alle gerelateerde data en gebruikerstoegang.", + "scanInProgress": "Scan is bezig...", + "noLibrariesAssigned": "Geen bibliotheken aan deze gebruiker toegewezen" + } + }, + "plugin": { + "name": "Plugin |||| Plugins", + "fields": { + "id": "ID", + "name": "Naam", + "description": "Omschrijving", + "version": "Versie", + "author": "Auteur", + "website": "Website", + "permissions": "Permissies", + "enabled": "Aangezet", + "status": "Status", + "path": "Pad", + "lastError": "Fout", + "hasError": "Fout", + "updatedAt": "Geupdate", + "createdAt": "Geinstalleerd", + "configKey": "Sleutel", + "configValue": "Waarde", + "allUsers": "Alle gebruikers toelaten", + "selectedUsers": "Geselecteerde gebruikers", + "allLibraries": "Alle bibliotheken toestaan", + "selectedLibraries": "Geselecteerde bibliotheken" + }, + "sections": { + "status": "Status", + "info": "Plugin informatie", + "configuration": "Configuratie", + "manifest": "Manifest", + "usersPermission": "Gebruikers permissie", + "libraryPermission": "Bibliotheekpermissie" + }, + "status": { + "enabled": "Aangezet", + "disabled": "Uitgezet" + }, + "actions": { + "enable": "Aanzetten", + "disable": "Uitzetten", + "disabledDueToError": "Herstel de fout voor aanzetten", + "disabledUsersRequired": "Selecteer gebruikers voor aanzetten", + "disabledLibrariesRequired": "Selecteer bibliotheek voor aanzetten", + "addConfig": "Configuratie toevoegen", + "rescan": "Opnieuw scannen" + }, + "notifications": { + "enabled": "Plugin actief", + "disabled": "Plugin niet actief", + "updated": "Plugin geupdate", + "error": "Fout bij updaten plugin" + }, + "validation": { + "invalidJson": "Configuratie moet geldige JSON zijn" + }, + "messages": { + "configHelp": "", + "clickPermissions": "Klik op permissie voor details", + "noConfig": "Geen configuratie ingesteld", + "allUsersHelp": "", + "noUsers": "Geen gebruikers geselecteerd", + "permissionReason": "Reden", + "usersRequired": "", + "allLibrariesHelp": "", + "noLibraries": "Geen bibliotheken geselecteerd", + "librariesRequired": "", + "requiredHosts": "Benodigde hosts", + "configValidationError": "", + "schemaRenderError": "" + }, + "placeholders": { + "configKey": "Sleutel", + "configValue": "Waarde" + } } }, "ra": { @@ -430,7 +585,10 @@ "remove_missing_title": "Verwijder ontbrekende bestanden", "remove_missing_content": "Weet je zeker dat je alle ontbrekende bestanden van de database wil verwijderen? Dit wist permanent al hun referenties inclusief afspeel tellers en beoordelingen.", "remove_all_missing_title": "Verwijder alle ontbrekende bestanden", - "remove_all_missing_content": "Weet je zeker dat je alle ontbrekende bestanden van de database wil verwijderen? Dit wist permanent al hun referenties inclusief afspeel tellers en beoordelingen." + "remove_all_missing_content": "Weet je zeker dat je alle ontbrekende bestanden van de database wil verwijderen? Dit wist permanent al hun referenties inclusief afspeel tellers en beoordelingen.", + "noSimilarSongsFound": "Geen vergelijkbare nummers gevonden", + "noTopSongsFound": "Geen beste nummers gevonden", + "startingInstantMix": "" }, "menu": { "library": "Bibliotheek", @@ -459,7 +617,13 @@ "albumList": "Albums", "about": "Over", "playlists": "Afspeellijsten", - "sharedPlaylists": "Gedeelde afspeellijsten" + "sharedPlaylists": "Gedeelde afspeellijsten", + "librarySelector": { + "allLibraries": "Alle bibliotheken (%{count})", + "multipleLibraries": "%{selected} van %{total} bibliotheken", + "selectLibraries": "Selecteer bibliotheken", + "none": "Geen" + } }, "player": { "playListsText": "Wachtrij", @@ -468,7 +632,7 @@ "notContentText": "Geen muziek", "clickToPlayText": "Klik om af te spelen", "clickToPauseText": "Klik om te pauzeren", - "nextTrackText": "Volgende", + "nextTrackText": "Volgend nummer", "previousTrackText": "Vorige", "reloadText": "Herladen", "volumeText": "Volume", @@ -496,18 +660,34 @@ "disabled": "Uitgeschakeld", "waiting": "Wachten" } + }, + "tabs": { + "about": "Over", + "config": "Configuratie" + }, + "config": { + "configName": "Config Naam", + "environmentVariable": "Omgevingsvariabele", + "currentValue": "Huidige waarde", + "configurationFile": "Configuratiebestand", + "exportToml": "Exporteer configuratie (TOML)", + "exportSuccess": "Configuratie geëxporteerd naar klembord in TOML formaat", + "exportFailed": "Kopiëren van configuratie mislukt", + "devFlagsHeader": "Ontwikkelaarsinstellingen (onder voorbehoud)", + "devFlagsComment": "Dit zijn experimentele instellingen en worden mogelijk in latere versies verwijderd" } }, "activity": { "title": "Activiteit", - "totalScanned": "Totaal gescande folders", + "totalScanned": "Totaal gescande mappen", "quickScan": "Snelle scan", "fullScan": "Volledige scan", "serverUptime": "Server uptime", "serverDown": "Offline", "scanType": "Type", "status": "Scan fout", - "elapsedTime": "Verlopen tijd" + "elapsedTime": "Verlopen tijd", + "selectiveScan": "Selectief" }, "help": { "title": "Navidrome sneltoetsen", @@ -522,5 +702,10 @@ "toggle_love": "Voeg toe aan favorieten", "current_song": "Ga naar huidig nummer" } + }, + "nowPlaying": { + "title": "Speelt nu", + "empty": "Er wordt niets afgespeed", + "minutesAgo": "%{smart_count} minuut geleden |||| %{smart_count} minuten geleden" } } \ No newline at end of file diff --git a/resources/i18n/no.json b/resources/i18n/no.json index 84198fca7..3b75bab25 100644 --- a/resources/i18n/no.json +++ b/resources/i18n/no.json @@ -18,8 +18,6 @@ "size": "Filstørrelse", "updatedAt": "Oppdatert", "bitRate": "Bit rate", - "bitDepth": "Bit depth", - "channels": "Kanaler", "discSubtitle": "Disk Undertittel", "starred": "Favoritt", "comment": "Kommentar", @@ -27,13 +25,18 @@ "quality": "Kvalitet", "bpm": "BPM", "playDate": "Sist Avspilt", + "channels": "Kanaler", "createdAt": "Lagt til", "grouping": "Gruppering", "mood": "Stemning", "participants": "Ytterlige deltakere", "tags": "Ytterlige Tags", "mappedTags": "Kartlagte tags", - "rawTags": "Rå tags" + "rawTags": "Rå tags", + "bitDepth": "Bit depth", + "sampleRate": "", + "missing": "", + "libraryName": "" }, "actions": { "addToQueue": "Avspill senere", @@ -42,7 +45,8 @@ "shuffleAll": "Shuffle Alle", "download": "Last ned", "playNext": "Avspill neste", - "info": "Få Info" + "info": "Få Info", + "showInPlaylist": "" } }, "album": { @@ -53,36 +57,38 @@ "duration": "Tid", "songCount": "Sanger", "playCount": "Avspillinger", - "size": "Størrelse", "name": "Navn", "genre": "Sjanger", "compilation": "Samling", "year": "År", - "date": "Inspillingsdato", - "originalDate": "Original", - "releaseDate": "Utgitt", - "releases": "Utgivelse |||| Utgivelser", - "released": "Utgitt", "updatedAt": "Oppdatert", "comment": "Kommentar", "rating": "Rangering", "createdAt": "Lagt Til", + "size": "Størrelse", + "originalDate": "Original", + "releaseDate": "Utgitt", + "releases": "Utgivelse |||| Utgivelser", + "released": "Utgitt", "recordLabel": "Plateselskap", "catalogNum": "Katalognummer", "releaseType": "Type", "grouping": "Gruppering", "media": "Media", - "mood": "Stemning" + "mood": "Stemning", + "date": "Inspillingsdato", + "missing": "", + "libraryName": "" }, "actions": { "playAll": "Avspill", "playNext": "Avspill Neste", "addToQueue": "Avspill Senere", - "share": "Del", "shuffle": "Shuffle", "addToPlaylist": "Legg til i spilleliste", "download": "Last ned", - "info": "Få Info" + "info": "Få Info", + "share": "Del" }, "lists": { "all": "Alle", @@ -100,11 +106,12 @@ "name": "Navn", "albumCount": "Album Antall", "songCount": "Song Antall", - "size": "Størrelse", "playCount": "Avspillinger", "rating": "Rangering", "genre": "Sjanger", - "role": "Rolle" + "size": "Størrelse", + "role": "Rolle", + "missing": "" }, "roles": { "albumartist": "Album Artist |||| Album Artister", @@ -119,7 +126,13 @@ "mixer": "Mixer |||| Mixers", "remixer": "Remixer |||| Remixers", "djmixer": "DJ Mixer |||| DJ Mixers", - "performer": "Performer |||| Performers" + "performer": "Performer |||| Performers", + "maincredit": "" + }, + "actions": { + "shuffle": "", + "radio": "", + "topSongs": "" } }, "user": { @@ -128,7 +141,6 @@ "userName": "Brukernavn", "isAdmin": "Admin", "lastLoginAt": "Sist Pålogging", - "lastAccessAt": "Sist Tilgang", "updatedAt": "Oppdatert", "name": "Navn", "password": "Passord", @@ -136,10 +148,13 @@ "changePassword": "Bytt Passord?", "currentPassword": "Nåværende Passord", "newPassword": "Nytt Passord", - "token": "Token" + "token": "Token", + "lastAccessAt": "Sist Tilgang", + "libraries": "" }, "helperTexts": { - "name": "Navnendringer vil ikke være synlig før neste pålogging" + "name": "Navnendringer vil ikke være synlig før neste pålogging", + "libraries": "" }, "notifications": { "created": "Bruker opprettet", @@ -148,7 +163,12 @@ }, "message": { "listenBrainzToken": "Fyll inn din ListenBrainz bruker token.", - "clickHereForToken": "Klikk her for å hente din token" + "clickHereForToken": "Klikk her for å hente din token", + "selectAllLibraries": "", + "adminAutoLibraries": "" + }, + "validation": { + "librariesRequired": "" } }, "player": { @@ -192,11 +212,17 @@ "addNewPlaylist": "Opprett \"%{name}\"", "export": "Eksporter", "makePublic": "Gjør Offentlig", - "makePrivate": "Gjør Privat" + "makePrivate": "Gjør Privat", + "saveQueue": "", + "searchOrCreate": "", + "pressEnterToCreate": "", + "removeFromSelection": "" }, "message": { "duplicate_song": "Legg til Duplikater", - "song_exist": "Duplikater har blitt lagt til i spillelisten. Ønsker du å legge til duplikater eller hoppe over de?" + "song_exist": "Duplikater har blitt lagt til i spillelisten. Ønsker du å legge til duplikater eller hoppe over de?", + "noPlaylistsFound": "", + "noPlaylists": "" } }, "radio": { @@ -218,7 +244,6 @@ "username": "Delt Av", "url": "URL", "description": "Beskrivelse", - "downloadable": "Tillat Nedlastinger?", "contents": "Innhold", "expiresAt": "Utløper", "lastVisitedAt": "Sist Besøkt", @@ -226,24 +251,82 @@ "format": "Format", "maxBitRate": "Maks. Bit Rate", "updatedAt": "Oppdatert", - "createdAt": "Opprettet" - }, - "notifications": {}, - "actions": {} + "createdAt": "Opprettet", + "downloadable": "Tillat Nedlastinger?" + } }, "missing": { "name": "Manglende Fil|||| Manglende Filer", - "empty": "Ingen Manglende Filer", "fields": { "path": "Filsti", "size": "Størrelse", - "updatedAt": "Ble borte" + "updatedAt": "Ble borte", + "libraryName": "" }, "actions": { - "remove": "Fjern" + "remove": "Fjern", + "remove_all": "" }, "notifications": { "removed": "Manglende fil(er) fjernet" + }, + "empty": "Ingen Manglende Filer" + }, + "library": { + "name": "", + "fields": { + "name": "", + "path": "", + "remotePath": "", + "lastScanAt": "", + "songCount": "", + "albumCount": "", + "artistCount": "", + "totalSongs": "", + "totalAlbums": "", + "totalArtists": "", + "totalFolders": "", + "totalFiles": "", + "totalMissingFiles": "", + "totalSize": "", + "totalDuration": "", + "defaultNewUsers": "", + "createdAt": "", + "updatedAt": "" + }, + "sections": { + "basic": "", + "statistics": "" + }, + "actions": { + "scan": "", + "manageUsers": "", + "viewDetails": "", + "quickScan": "", + "fullScan": "" + }, + "notifications": { + "created": "", + "updated": "", + "deleted": "Biblioteket slettet", + "scanStarted": "Skanning startet", + "scanCompleted": "", + "quickScanStarted": "", + "fullScanStarted": "", + "scanError": "Error starte skanning. Sjekk loggene" + }, + "validation": { + "nameRequired": "", + "pathRequired": "", + "pathNotDirectory": "", + "pathNotFound": "", + "pathNotAccessible": "", + "pathInvalid": "" + }, + "messages": { + "deleteConfirm": "", + "scanInProgress": "", + "noLibrariesAssigned": "" } } }, @@ -282,7 +365,6 @@ "add": "Legg Til", "back": "Tilbake", "bulk_actions": "1 element valgt |||| %{smart_count} elementer valgt", - "bulk_actions_mobile": "1 |||| %{smart_count}", "cancel": "Avbryt", "clear_input_value": "Nullstill verdi", "clone": "Klone", @@ -306,6 +388,7 @@ "close_menu": "Lukk meny", "unselect": "Avvelg", "skip": "Hopp over", + "bulk_actions_mobile": "1 |||| %{smart_count}", "share": "Del", "download": "Last Ned" }, @@ -400,31 +483,35 @@ "noPlaylistsAvailable": "Ingen tilgjengelig", "delete_user_title": "Slett bruker '%{name}'", "delete_user_content": "Er du sikker på at du vil slette denne brukeren og all tilhørlig data (inkludert spillelister og preferanser)?", - "remove_missing_title": "Fjern manglende filer", - "remove_missing_content": "Er du sikker på at du ønsker å fjerne de valgte manglende filene fra databasen? Dette vil permanent fjerne alle referanser til de, inkludert antall avspillinger og rangeringer.", "notifications_blocked": "Du har blokkert notifikasjoner for denne nettsiden i din nettleser.", "notifications_not_available": "Denne nettleseren støtter ikke skrivebordsnotifikasjoner, eller så er du ikke tilkoblet Navidrome via https.", "lastfmLinkSuccess": "Last.fm er tilkoblet og scrobbling er aktivert", "lastfmLinkFailure": "Last.fm kunne ikke koble til", "lastfmUnlinkSuccess": "Last.fm er avkoblet og scrobbling er deaktivert", "lastfmUnlinkFailure": "Last.fm kunne ikke avkobles", - "listenBrainzLinkSuccess": "ListenBrainz er koblet til og scrobbling er aktivert som bruker: %{user}", - "listenBrainzLinkFailure": "ListenBrainz kunne ikke koble til: %{error}", - "listenBrainzUnlinkSuccess": "ListenBrainz er avkoblet og scrobbling er deaktivert", - "listenBrainzUnlinkFailure": "ListenBrainz kunne ikke avkobles", "openIn": { "lastfm": "Åpne i Last.fm", "musicbrainz": "Åpne i MusicBrainz" }, "lastfmLink": "Les Mer...", + "listenBrainzLinkSuccess": "ListenBrainz er koblet til og scrobbling er aktivert som bruker: %{user}", + "listenBrainzLinkFailure": "ListenBrainz kunne ikke koble til: %{error}", + "listenBrainzUnlinkSuccess": "ListenBrainz er avkoblet og scrobbling er deaktivert", + "listenBrainzUnlinkFailure": "ListenBrainz kunne ikke avkobles", + "downloadOriginalFormat": "Last ned i originalformat", "shareOriginalFormat": "Del i originalformat", "shareDialogTitle": "Del %{resource} '%{name}'", "shareBatchDialogTitle": "Del 1 %{resource} |||| Del %{smart_count} %{resource}", - "shareCopyToClipboard": "Kopier til utklippstavle: Ctrl+C, Enter", "shareSuccess": "URL kopiert til utklippstavle: %{url}", "shareFailure": "Error ved kopiering av URL %{url} til utklippstavle", "downloadDialogTitle": "Last ned %{resource} '%{name}' (%{size})", - "downloadOriginalFormat": "Last ned i originalformat" + "shareCopyToClipboard": "Kopier til utklippstavle: Ctrl+C, Enter", + "remove_missing_title": "Fjern manglende filer", + "remove_missing_content": "Er du sikker på at du ønsker å fjerne de valgte manglende filene fra databasen? Dette vil permanent fjerne alle referanser til de, inkludert antall avspillinger og rangeringer.", + "remove_all_missing_title": "", + "remove_all_missing_content": "", + "noSimilarSongsFound": "", + "noTopSongsFound": "" }, "menu": { "library": "Bibliotek", @@ -438,7 +525,6 @@ "language": "Språk", "defaultView": "Standardvisning", "desktop_notifications": "Skrivebordsnotifikasjoner", - "lastfmNotConfigured": "Last.fm API-Key er ikke konfigurert", "lastfmScrobbling": "Scrobble til Last.fm", "listenBrainzScrobbling": "Scrobble til ListenBrainz", "replaygain": "ReplayGain Mode", @@ -447,13 +533,20 @@ "none": "Deaktivert", "album": "Bruk Album Gain", "track": "Bruk Track Gain" - } + }, + "lastfmNotConfigured": "Last.fm API-Key er ikke konfigurert" } }, "albumList": "Album", + "about": "Om", "playlists": "Spillelister", "sharedPlaylists": "Delte Spillelister", - "about": "Om" + "librarySelector": { + "allLibraries": "", + "multipleLibraries": "", + "selectLibraries": "", + "none": "" + } }, "player": { "playListsText": "Spill Av Kø", @@ -490,6 +583,21 @@ "disabled": "Deaktivert", "waiting": "Venter" } + }, + "tabs": { + "about": "", + "config": "" + }, + "config": { + "configName": "", + "environmentVariable": "", + "currentValue": "", + "configurationFile": "", + "exportToml": "", + "exportSuccess": "", + "exportFailed": "", + "devFlagsHeader": "", + "devFlagsComment": "" } }, "activity": { @@ -498,7 +606,11 @@ "quickScan": "Hurtigskann", "fullScan": "Full Skann", "serverUptime": "Server Oppetid", - "serverDown": "OFFLINE" + "serverDown": "OFFLINE", + "scanType": "", + "status": "", + "elapsedTime": "", + "selectiveScan": "Utvalgt" }, "help": { "title": "Navidrome Hurtigtaster", @@ -508,10 +620,15 @@ "toggle_play": "Avspill / Pause", "prev_song": "Forrige Sang", "next_song": "Neste Sang", - "current_song": "Gå til Nåværende Sang", "vol_up": "Volum Opp", "vol_down": "Volum Ned", - "toggle_love": "Legg til spor i favoritter" + "toggle_love": "Legg til spor i favoritter", + "current_song": "Gå til Nåværende Sang" } + }, + "nowPlaying": { + "title": "", + "empty": "", + "minutesAgo": "" } -} +} \ No newline at end of file diff --git a/resources/i18n/pl.json b/resources/i18n/pl.json index 4d78c7599..6229798e9 100644 --- a/resources/i18n/pl.json +++ b/resources/i18n/pl.json @@ -36,7 +36,8 @@ "bitDepth": "Głębokość próbkowania", "sampleRate": "Częstotliwość próbkowania", "missing": "Brak", - "libraryName": "Biblioteka" + "libraryName": "Biblioteka", + "composer": "Kompozytor" }, "actions": { "addToQueue": "Odtwarzaj Później", @@ -46,7 +47,8 @@ "download": "Pobierz", "playNext": "Odtwarzaj Następny", "info": "Zdobądź Informacje", - "showInPlaylist": "Pokaż w Liście Odtwarzania" + "showInPlaylist": "Pokaż w Liście Odtwarzania", + "instantMix": "Natychmiastowy Miks" } }, "album": { @@ -301,14 +303,19 @@ "actions": { "scan": "Skanuj Bibliotekę", "manageUsers": "Zarządzaj Dostępami Użytkownika", - "viewDetails": "Zobacz Szczegóły" + "viewDetails": "Zobacz Szczegóły", + "quickScan": "Szybkie Skanowanie", + "fullScan": "Pełne Skanowanie" }, "notifications": { "created": "Biblioteka utworzona prawidłowo", "updated": "Biblioteka zaktualizowana prawidłowo", "deleted": "Biblioteka usunięta prawidłowo", "scanStarted": "Rozpoczęto skan biblioteki", - "scanCompleted": "Zakończono skan biblioteki" + "scanCompleted": "Zakończono skan biblioteki", + "quickScanStarted": "Szybkie skanowanie rozpoczęte", + "fullScanStarted": "Pełne skanowanie rozpoczęte", + "scanError": "Błąd podczas startu skanowania. Sprawdź logi" }, "validation": { "nameRequired": "Nazwa biblioteki jest wymagana", @@ -323,6 +330,80 @@ "scanInProgress": "Skanowanie w trakcie...", "noLibrariesAssigned": "Brak bibliotek przypisanych do tego użytkownika" } + }, + "plugin": { + "name": "\nWtyczka |||| Wtyczki", + "fields": { + "id": "ID", + "name": "Nazwa", + "description": "Opis", + "version": "Wersja", + "author": "Autor", + "website": "Witryna", + "permissions": "Uprawnienia", + "enabled": "Aktywny", + "status": "Status", + "path": "Ścieżka", + "lastError": "Błąd", + "hasError": "Błąd", + "updatedAt": "Zaktualizowana", + "createdAt": "Zainstalowana", + "configKey": "Klucz", + "configValue": "Wartość", + "allUsers": "Zezwalaj wszystkim użytkownikom", + "selectedUsers": "Wybrani użytkownicy", + "allLibraries": "Zezwalaj dla wszystkich bibliotek", + "selectedLibraries": "Wybrane biblioteki" + }, + "sections": { + "status": "Status", + "info": "Informacje O Wtyczce", + "configuration": "Konfiguracja", + "manifest": "Manifest", + "usersPermission": "Uprawnienia Użytkowników", + "libraryPermission": "Uprawnienia Biblioteki" + }, + "status": { + "enabled": "Włączona", + "disabled": "Wyłączona" + }, + "actions": { + "enable": "Włącz", + "disable": "Wyłącz", + "disabledDueToError": "Napraw błąd przed włączeniem", + "disabledUsersRequired": "Wybierz użytkowników przed włączeniem", + "disabledLibrariesRequired": "Wybierz biblioteki przed włączaniem", + "addConfig": "Dodaj Konfigurację", + "rescan": "Przeskanuj Ponownie" + }, + "notifications": { + "enabled": "Wtyczka włączona", + "disabled": "Wtyczka wyłączona", + "updated": "Wtyczka zaktualizowana", + "error": "Błąd aktualizacji wtyczki" + }, + "validation": { + "invalidJson": "Konfiguracja musić być w poprawnym formacie JSON" + }, + "messages": { + "configHelp": "Użyj par klucz-wartość, aby skonfigurować wtyczkę. Pozostaw puste, jeśli wtyczka nie wymaga konfiguracji.", + "clickPermissions": "Kliknij uprawnienie, aby uzyskać szczegółowe informacje", + "noConfig": "Nie wybrano konfiguracji", + "allUsersHelp": "Po włączeniu wtyczka będzie miała dostęp do wszystkich użytkowników, także tych utworzonych w przyszłości.", + "noUsers": "Nie wybrano użytkowników", + "permissionReason": "Powód", + "usersRequired": "Ta wtyczka wymaga dostępu do informacji o użytkowniku. Wybierz użytkowników, do których wtyczka ma mieć dostęp, lub włącz opcję „Zezwól wszystkim użytkownikom”.", + "allLibrariesHelp": "Po włączeniu wtyczka będzie miała dostęp do wszystkich bibliotek, także tych utworzonych w przyszłości.", + "noLibraries": "Nie wybrano biblioteki", + "librariesRequired": "Wtyczka wymaga dostępu do informacji o bibliotece. Wybierz, dla której biblioteki zezwolić dostęp, lub włącz 'Zezwalaj dla wszystkich bibliotek'.", + "requiredHosts": "Wymagane hosty", + "configValidationError": "Weryfikacja konfiguracji nie powiodła się:", + "schemaRenderError": "Nie można wyrenderować formularza konfiguracji. Schemat wtyczki może być nieprawidłowy." + }, + "placeholders": { + "configKey": "klucz", + "configValue": "wartość" + } } }, "ra": { @@ -506,7 +587,8 @@ "remove_all_missing_title": "Usuń wszystkie brakujące pliki", "remove_all_missing_content": "Czy chcesz usunąć wszystkie brakujące pliki z bazy danych? Spowoduje to trwałe usunięcie wszelkich odniesień do tych plików, takich jak liczba odtworzeń, czy oceny.", "noSimilarSongsFound": "Brak podobnych utworów", - "noTopSongsFound": "Brak najlepszych utworów" + "noTopSongsFound": "Brak najlepszych utworów", + "startingInstantMix": "Ładowanie Natychmiastowego Miksu..." }, "menu": { "library": "Biblioteka", @@ -604,7 +686,8 @@ "serverDown": "NIEDOSTĘPNY", "scanType": "Typ", "status": "Błąd Skanowania", - "elapsedTime": "Upłynięty Czas" + "elapsedTime": "Upłynięty Czas", + "selectiveScan": "Selektywne" }, "help": { "title": "Skróty Klawiszowe Navidrome", diff --git a/resources/i18n/pt-br.json b/resources/i18n/pt-br.json index 9c22d509f..bc2a5f85e 100644 --- a/resources/i18n/pt-br.json +++ b/resources/i18n/pt-br.json @@ -12,7 +12,6 @@ "artist": "Artista", "album": "Álbum", "path": "Arquivo", - "libraryName": "Biblioteca", "genre": "Gênero", "compilation": "Coletânea", "year": "Ano", @@ -36,7 +35,9 @@ "rawTags": "Tags originais", "bitDepth": "Profundidade de bits", "sampleRate": "Taxa de amostragem", - "missing": "Ausente" + "missing": "Ausente", + "libraryName": "Biblioteca", + "composer": "Compositor" }, "actions": { "addToQueue": "Adicionar à fila", @@ -46,7 +47,8 @@ "download": "Baixar", "playNext": "Toca a seguir", "info": "Detalhes", - "showInPlaylist": "Ir para playlist" + "showInPlaylist": "Ir para playlist", + "instantMix": "Mix Instantâneo" } }, "album": { @@ -58,7 +60,6 @@ "songCount": "Músicas", "playCount": "Execuções", "name": "Nome", - "libraryName": "Biblioteca", "genre": "Gênero", "compilation": "Coletânea", "year": "Ano", @@ -78,7 +79,8 @@ "media": "Mídia", "mood": "Mood", "date": "Data de Lançamento", - "missing": "Ausente" + "missing": "Ausente", + "libraryName": "Biblioteca" }, "actions": { "playAll": "Tocar", @@ -130,9 +132,9 @@ "maincredit": "Artista do Álbum ou Artista |||| Artistas do Álbum ou Artistas" }, "actions": { - "topSongs": "Mais tocadas", "shuffle": "Aleatório", - "radio": "Rádio" + "radio": "Rádio", + "topSongs": "Mais tocadas" } }, "user": { @@ -161,14 +163,14 @@ "updated": "Usuário atualizado com sucesso", "deleted": "Usuário deletado com sucesso" }, - "validation": { - "librariesRequired": "Pelo menos uma biblioteca deve ser selecionada para usuários não-administradores" - }, "message": { "listenBrainzToken": "Entre seu token do ListenBrainz", "clickHereForToken": "Clique aqui para obter seu token", "selectAllLibraries": "Selecionar todas as bibliotecas", "adminAutoLibraries": "Usuários administradores têm acesso automático a todas as bibliotecas" + }, + "validation": { + "librariesRequired": "Pelo menos uma biblioteca deve ser selecionada para usuários não-administradores" } }, "player": { @@ -260,8 +262,8 @@ "fields": { "path": "Caminho", "size": "Tamanho", - "libraryName": "Biblioteca", - "updatedAt": "Desaparecido em" + "updatedAt": "Desaparecido em", + "libraryName": "Biblioteca" }, "actions": { "remove": "Remover", @@ -301,14 +303,19 @@ "actions": { "scan": "Scanear Biblioteca", "manageUsers": "Gerenciar Acesso do Usuário", - "viewDetails": "Ver Detalhes" + "viewDetails": "Ver Detalhes", + "quickScan": "Scan Rápido", + "fullScan": "Scan Completo" }, "notifications": { "created": "Biblioteca criada com sucesso", "updated": "Biblioteca atualizada com sucesso", "deleted": "Biblioteca excluída com sucesso", "scanStarted": "Scan da biblioteca iniciada", - "scanCompleted": "Scan da biblioteca concluída" + "scanCompleted": "Scan da biblioteca concluída", + "quickScanStarted": "Scan rápido iniciado", + "fullScanStarted": "Scan completo iniciado", + "scanError": "Erro ao iniciar o scan. Verifique os logs" }, "validation": { "nameRequired": "Nome da biblioteca é obrigatório", @@ -323,6 +330,82 @@ "scanInProgress": "Scan em progresso...", "noLibrariesAssigned": "Nenhuma biblioteca atribuída a este usuário" } + }, + "plugin": { + "name": "Plugin |||| Plugins", + "fields": { + "id": "ID", + "name": "Nome", + "description": "Descrição", + "version": "Versão", + "author": "Autor", + "website": "Website", + "permissions": "Permissões", + "enabled": "Habilitado", + "status": "Status", + "path": "Caminho", + "lastError": "Erro", + "hasError": "Erro", + "updatedAt": "Atualizado", + "createdAt": "Instalado", + "configKey": "Chave", + "configValue": "Valor", + "allUsers": "Permitir todos os usuários", + "selectedUsers": "Usuários selecionados", + "allLibraries": "Permitir todas as bibliotecas", + "selectedLibraries": "Bibliotecas selecionadas", + "allowWriteAccess": "Permitir acesso de escrita" + }, + "sections": { + "status": "Status", + "info": "Informações do Plugin", + "configuration": "Configuração", + "manifest": "Manifesto", + "usersPermission": "Permissão de Usuários", + "libraryPermission": "Permissão de Bibliotecas" + }, + "status": { + "enabled": "Habilitado", + "disabled": "Desabilitado" + }, + "actions": { + "enable": "Habilitar", + "disable": "Desabilitar", + "disabledDueToError": "Corrija o erro antes de habilitar", + "disabledUsersRequired": "Selecione usuários antes de habilitar", + "disabledLibrariesRequired": "Selecione bibliotecas antes de habilitar", + "addConfig": "Adicionar configuração", + "rescan": "Rescanear" + }, + "notifications": { + "enabled": "Plugin habilitado", + "disabled": "Plugin desabilitado", + "updated": "Plugin atualizado", + "error": "Erro ao atualizar plugin" + }, + "validation": { + "invalidJson": "A configuração deve ser um JSON válido" + }, + "messages": { + "configHelp": "Configure o plugin usando pares chave-valor. Deixe vazio se o plugin não precisa de configuração.", + "clickPermissions": "Clique em uma permissão para ver detalhes", + "noConfig": "Nenhuma configuração definida", + "allUsersHelp": "Quando habilitado, o plugin terá acesso a todos os usuários, incluindo os criados no futuro.", + "noUsers": "Nenhum usuário selecionado", + "permissionReason": "Motivo", + "usersRequired": "Este plugin requer acesso a informações de usuário. Selecione quais usuários o plugin pode acessar, ou habilite 'Permitir todos os usuários'.", + "allLibrariesHelp": "Quando habilitado, o plugin terá acesso a todas as bibliotecas, incluindo as criadas no futuro.", + "noLibraries": "Nenhuma biblioteca selecionada", + "librariesRequired": "Este plugin requer acesso a informações de bibliotecas. Selecione quais bibliotecas o plugin pode acessar, ou habilite 'Permitir todas as bibliotecas'.", + "allowWriteAccessHelp": "Quando habilitado, o plugin pode modificar arquivos nos diretórios das bibliotecas. Por padrão, plugins têm acesso somente leitura.", + "requiredHosts": "Hosts necessários", + "configValidationError": "Falha na validação da configuração:", + "schemaRenderError": "Não foi possível renderizar o formulário de configuração. O schema do plugin pode estar inválido." + }, + "placeholders": { + "configKey": "chave", + "configValue": "valor" + } } }, "ra": { @@ -471,12 +554,16 @@ } }, "message": { + "uploadCover": "Enviar Capa", + "removeCover": "Remover Capa", + "coverUploaded": "Capa atualizada", + "coverRemoved": "Capa removida", + "coverUploadError": "Erro ao enviar capa", + "coverRemoveError": "Erro ao remover capa", "note": "ATENÇÃO", "transcodingDisabled": "Por questão de segurança, esta tela de configuração está desabilitada. Se você quiser alterar estas configurações, reinicie o servidor com a opção %{config}", "transcodingEnabled": "Navidrome está sendo executado com a opção %{config}. Isto permite que potencialmente se execute comandos do sistema pela interface Web. É recomendado que vc mantenha esta opção desabilitada, e só a habilite quando precisar configurar opções de Conversão", "songsAddedToPlaylist": "Música adicionada à playlist |||| %{smart_count} músicas adicionadas à playlist", - "noSimilarSongsFound": "Nenhuma música semelhante encontrada", - "noTopSongsFound": "Nenhuma música mais tocada encontrada", "noPlaylistsAvailable": "Nenhuma playlist", "delete_user_title": "Excluir usuário '%{name}'", "delete_user_content": "Você tem certeza que deseja excluir o usuário e todos os seus dados (incluindo suas playlists e preferências)?", @@ -506,16 +593,13 @@ "remove_missing_title": "Remover arquivos ausentes", "remove_missing_content": "Você tem certeza que deseja remover os arquivos selecionados do banco de dados? Isso removerá permanentemente qualquer referência a eles, incluindo suas contagens de reprodução e classificações.", "remove_all_missing_title": "Remover todos os arquivos ausentes", - "remove_all_missing_content": "Você tem certeza que deseja remover todos os arquivos ausentes do banco de dados? Isso removerá permanentemente qualquer referência a eles, incluindo suas contagens de reprodução e classificações." + "remove_all_missing_content": "Você tem certeza que deseja remover todos os arquivos ausentes do banco de dados? Isso removerá permanentemente qualquer referência a eles, incluindo suas contagens de reprodução e classificações.", + "noSimilarSongsFound": "Nenhuma música semelhante encontrada", + "noTopSongsFound": "Nenhuma música mais tocada encontrada", + "startingInstantMix": "Carregando Mix Instantâneo..." }, "menu": { "library": "Biblioteca", - "librarySelector": { - "allLibraries": "Todas as Bibliotecas (%{count})", - "multipleLibraries": "%{selected} de %{total} Bibliotecas", - "selectLibraries": "Selecionar Bibliotecas", - "none": "Nenhuma" - }, "settings": "Configurações", "version": "Versão", "theme": "Tema", @@ -541,7 +625,13 @@ "albumList": "Álbuns", "about": "Info", "playlists": "Playlists", - "sharedPlaylists": "Compartilhadas" + "sharedPlaylists": "Compartilhadas", + "librarySelector": { + "allLibraries": "Todas as Bibliotecas (%{count})", + "multipleLibraries": "%{selected} de %{total} Bibliotecas", + "selectLibraries": "Selecionar Bibliotecas", + "none": "Nenhuma" + } }, "player": { "playListsText": "Fila de Execução", @@ -592,24 +682,21 @@ "exportSuccess": "Configuração exportada para o clipboard em formato TOML", "exportFailed": "Falha ao copiar configuração", "devFlagsHeader": "Flags de Desenvolvimento (sujeitas a mudança/remoção)", - "devFlagsComment": "Estas são configurações experimentais e podem ser removidas em versões futuras" + "devFlagsComment": "Estas são configurações experimentais e podem ser removidas em versões futuras", + "downloadToml": "Baixar configuração (TOML)" } }, "activity": { "title": "Atividade", "totalScanned": "Total de pastas scaneadas", - "quickScan": "Scan rápido", - "fullScan": "Scan completo", + "quickScan": "Rápido", + "fullScan": "Completo", "serverUptime": "Uptime do servidor", "serverDown": "DESCONECTADO", - "scanType": "Tipo", + "scanType": "Último Scan", "status": "Erro", - "elapsedTime": "Duração" - }, - "nowPlaying": { - "title": "Tocando agora", - "empty": "Nada tocando", - "minutesAgo": "%{smart_count} minuto atrás |||| %{smart_count} minutos atrás" + "elapsedTime": "Duração", + "selectiveScan": "Seletivo" }, "help": { "title": "Teclas de atalho", @@ -624,5 +711,10 @@ "toggle_love": "Marcar/desmarcar favorita", "current_song": "Vai para música atual" } + }, + "nowPlaying": { + "title": "Tocando agora", + "empty": "Nada tocando", + "minutesAgo": "%{smart_count} minuto atrás |||| %{smart_count} minutos atrás" } -} +} \ No newline at end of file diff --git a/resources/i18n/ru.json b/resources/i18n/ru.json index e29996275..78e7cfa26 100644 --- a/resources/i18n/ru.json +++ b/resources/i18n/ru.json @@ -36,7 +36,9 @@ "bitDepth": "Битовая глубина (Bit)", "sampleRate": "Частота дискретизации (Hz)", "missing": "Поле отсутствует", - "libraryName": "Библиотека" + "libraryName": "Библиотека", + "composer": "Композитор", + "disc": "" }, "actions": { "addToQueue": "В очередь", @@ -46,7 +48,8 @@ "download": "Скачать", "playNext": "Следующий", "info": "Информация", - "showInPlaylist": "Показать в плейлисте" + "showInPlaylist": "Показать в плейлисте", + "instantMix": "Быстрый микс" } }, "album": { @@ -93,7 +96,7 @@ "lists": { "all": "Все", "random": "Случайные", - "recentlyAdded": "Свежие", + "recentlyAdded": "Новые", "recentlyPlayed": "Проигранные", "mostPlayed": "Популярные", "starred": "Избранные", @@ -301,20 +304,25 @@ "actions": { "scan": "Сканировать библиотеку", "manageUsers": "Управление доступом пользователей", - "viewDetails": "Просмотреть подробности" + "viewDetails": "Просмотреть подробности", + "quickScan": "Быстрое сканирование", + "fullScan": "Полное сканирование" }, "notifications": { "created": "Библиотека успешно создана", "updated": "Библиотека успешно обновлена", "deleted": "Библиотека успешно удалена", "scanStarted": "Сканирование библиотеки начато", - "scanCompleted": "Сканирование библиотеки закончено" + "scanCompleted": "Сканирование библиотеки закончено", + "quickScanStarted": "Быстрое сканирование началось", + "fullScanStarted": "Началось полное сканирование", + "scanError": "Ошибка при запуске сканирования. Проверьте логи" }, "validation": { "nameRequired": "Имя библиотеки обязательно", "pathRequired": "Путь к библиотеке обязателен", "pathNotDirectory": "Путь к библиотеке должен быть директорией", - "pathNotFound": "Путь к библиотеке не найдено", + "pathNotFound": "Путь к библиотеке не найден", "pathNotAccessible": "Путь к библиотеке недоступен", "pathInvalid": "Неверный путь к библиотеке" }, @@ -323,6 +331,82 @@ "scanInProgress": "Сканирование продолжается...", "noLibrariesAssigned": "Нет библиотек, назначенных этому пользователю" } + }, + "plugin": { + "name": "Плагин |||| Плагины", + "fields": { + "id": "ID", + "name": "Имя", + "description": "Описание", + "version": "Версия", + "author": "Автор", + "website": "Вебсайт", + "permissions": "Разрешения", + "enabled": "Включено", + "status": "Статус", + "path": "Путь", + "lastError": "Ошибка", + "hasError": "Ошибка", + "updatedAt": "Обновлено", + "createdAt": "Установленный", + "configKey": "Ключ", + "configValue": "Значение", + "allUsers": "Разрешить всем пользователям", + "selectedUsers": "Выбранные пользователи", + "allLibraries": "Разрешить доступ ко всем библиотекам", + "selectedLibraries": "Избранные библиотеки", + "allowWriteAccess": "" + }, + "sections": { + "status": "Статус", + "info": "Информация о плагине", + "configuration": "Конфигурация", + "manifest": "Манифест", + "usersPermission": "Разрешение пользователей", + "libraryPermission": "Разрешение на использование библиотеки" + }, + "status": { + "enabled": "Включено", + "disabled": "Отключить" + }, + "actions": { + "enable": "Включить", + "disable": "Отключить", + "disabledDueToError": "Исправьте ошибку перед включением", + "disabledUsersRequired": "Выберите пользователей перед включением", + "disabledLibrariesRequired": "Выберите библиотеки перед включением", + "addConfig": "Добавить конфигурацию", + "rescan": "Повторное сканирование" + }, + "notifications": { + "enabled": "Плагин включен", + "disabled": "Плагин отключен", + "updated": "Плагин обновлен", + "error": "Ошибка обновления плагина" + }, + "validation": { + "invalidJson": "Конфигурация должна быть в формате JSON, допустимом для всех пользователей" + }, + "messages": { + "configHelp": "Настройте плагин, используя пары ключ-значение. Оставьте поле пустым, если плагин не требует настройки.", + "clickPermissions": "Нажмите на разрешение для получения подробной информации", + "noConfig": "Конфигурация не задана", + "allUsersHelp": "При включении плагин получит доступ ко всем пользователям, включая тех, кто будет создан в будущем.", + "noUsers": "Не выбрано ни одного пользователя", + "permissionReason": "Причина", + "usersRequired": "Этому плагину требуется доступ к пользовательской информации. Выберите, к каким пользователям плагин может получить доступ, или включите \"Разрешить всем пользователям\".", + "allLibrariesHelp": "После включения плагин будет иметь доступ ко всем библиотекам, включая те, которые будут созданы в будущем.", + "noLibraries": "Библиотеки не выбраны", + "librariesRequired": "Этому плагину требуется доступ к библиотечной информации. Выберите, к каким библиотекам плагин может получить доступ, или включите \"Разрешить все библиотеки\".", + "requiredHosts": "Необходимые хосты", + "configValidationError": "Проверка конфигурации завершилась неудачей:", + "schemaRenderError": "Не удалось отобразить форму конфигурации. Возможно, схема плагина недействительна.", + "allowWriteAccessHelp": "" + }, + "placeholders": { + "configKey": "ключ", + "configValue": "значение" + } } }, "ra": { @@ -506,7 +590,8 @@ "remove_all_missing_title": "Удалите все отсутствующие файлы", "remove_all_missing_content": "Вы уверены, что хотите удалить все отсутствующие файлы из базы данных? Это навсегда удалит все упоминания о них, включая количество игр и рейтинг.", "noSimilarSongsFound": "Похожих треков не найдено", - "noTopSongsFound": "Лучших треков не найдено" + "noTopSongsFound": "Лучших треков не найдено", + "startingInstantMix": "Загрузка быстрого микса" }, "menu": { "library": "Библиотека", @@ -533,7 +618,7 @@ } }, "albumList": "Альбомы", - "about": "О нас", + "about": "О программе", "playlists": "Плейлисты", "sharedPlaylists": "Поделиться плейлистом", "librarySelector": { @@ -592,7 +677,8 @@ "exportSuccess": "Конфигурация экспортирована в буфер обмена в формате TOML", "exportFailed": "Не удалось скопировать конфигурацию", "devFlagsHeader": "Флаги разработки (могут быть изменены/удалены)", - "devFlagsComment": "Это экспериментальные настройки, которые могут быть удалены в будущих версиях." + "devFlagsComment": "Это экспериментальные настройки, которые могут быть удалены в будущих версиях.", + "downloadToml": "Скачать конфигурацию (TOML)" } }, "activity": { @@ -604,7 +690,8 @@ "serverDown": "Оффлайн", "scanType": "Тип", "status": "Ошибка сканирования", - "elapsedTime": "Прошедшее время" + "elapsedTime": "Прошедшее время", + "selectiveScan": "Избирательный" }, "help": { "title": "Горячие клавиши Navidrome", @@ -625,4 +712,4 @@ "empty": "Ничего не играет", "minutesAgo": "%{smart_count} минут назад |||| %{smart_count} минут назад" } -} \ No newline at end of file +} diff --git a/resources/i18n/sk.json b/resources/i18n/sk.json new file mode 100644 index 000000000..af5afade7 --- /dev/null +++ b/resources/i18n/sk.json @@ -0,0 +1,723 @@ +{ + "languageName": "Slovenčina", + "resources": { + "song": { + "name": "Skladba |||| Skladieb", + "fields": { + "albumArtist": "Interpret albumu", + "duration": "Dĺžka", + "trackNumber": "#", + "playCount": "Počet prehratí", + "title": "Názov", + "artist": "Interpret", + "composer": "Skladateľ", + "album": "Album", + "path": "Cesta k súboru", + "libraryName": "Knižnica", + "genre": "Žáner", + "compilation": "Kompilácia", + "year": "Rok", + "size": "Veľkosť súboru", + "updatedAt": "Nahrané", + "bitRate": "Prenosová rýchlosť", + "bitDepth": "Bitová hĺbka", + "sampleRate": "Vzorkovacia frekvencia", + "channels": "Kanály", + "disc": "Disk %{discNumber}", + "discSubtitle": "Podtitul disku", + "starred": "Obľúbené", + "comment": "Komentár", + "rating": "Hodnotenie", + "quality": "Kvalita", + "bpm": "BPM", + "playDate": "Naposledy prehraná skladba", + "createdAt": "Pridané", + "grouping": "Zoskupovanie", + "mood": "Nálada", + "participants": "Ďalší účastníci", + "tags": "Ďalšie značky", + "mappedTags": "Mapované značky", + "rawTags": "Nespracované značky", + "missing": "Chýbajúce" + }, + "actions": { + "addToQueue": "Prehrať neskôr", + "playNow": "Prehrať teraz", + "addToPlaylist": "Pridať do zoznamu skladieb", + "showInPlaylist": "Zobraziť v zozname skladieb", + "shuffleAll": "Zamiešať všetko", + "download": "Stiahnuť", + "playNext": "Prehrať ako ďalšie", + "info": "Získať informácie", + "instantMix": "Okamžitý mix" + } + }, + "album": { + "name": "Album |||| Albumy", + "fields": { + "albumArtist": "Interpret albumu", + "artist": "Interpret", + "duration": "Dĺžka", + "songCount": "Skladby", + "playCount": "Počet prehratí", + "size": "Veľkosť", + "name": "Názov", + "libraryName": "Knižnica", + "genre": "Žáner", + "compilation": "Kompilácia", + "year": "Rok", + "date": "Dátum záznamu", + "originalDate": "Pôvodné", + "releaseDate": "Vydané", + "releases": "Vydanie |||| Vydania", + "released": "Vydané", + "updatedAt": "Aktualizované", + "comment": "Komentár", + "rating": "Hodnotenie", + "createdAt": "Pridané", + "recordLabel": "Štítok", + "catalogNum": "Katalógové číslo", + "releaseType": "Typ vydania", + "grouping": "Zoskupovanie", + "media": "Médiá", + "mood": "Nálada", + "missing": "Chýbajúce" + }, + "actions": { + "playAll": "Prehrať", + "playNext": "Prehrať ako ďalšie", + "addToQueue": "Prehrať neskôr", + "share": "Zdieľať", + "shuffle": "Zamiešať", + "addToPlaylist": "Pridať do zoznamu skladieb", + "download": "Stiahnuť", + "info": "Získať informácie" + }, + "lists": { + "all": "Všetko", + "random": "Náhodné", + "recentlyAdded": "Nedávno pridané", + "recentlyPlayed": "Nedávno prehrané", + "mostPlayed": "Najviac prehrávané", + "starred": "Obľúbené", + "topRated": "Najlepšie hodnotené" + } + }, + "artist": { + "name": "Interpret |||| Interpreti", + "fields": { + "name": "Názov", + "albumCount": "Počet albumov", + "songCount": "Počet skladieb", + "size": "Veľkosť", + "playCount": "Prehrania", + "rating": "Hodnotenie", + "genre": "Žáner", + "role": "Rola", + "missing": "Chýbajúci" + }, + "roles": { + "albumartist": "Interpret albumu |||| Interpreti albumov", + "artist": "Interpret |||| Interpreti", + "composer": "Skladateľ |||| Skladatelia", + "conductor": "Dirigent |||| Dirigenti", + "lyricist": "Textár |||| Textári", + "arranger": "Aranžér |||| Aranžéri", + "producer": "Producent |||| Producenti", + "director": "Režisér |||| Režiséri", + "engineer": "Zvukový technik |||| Zvukoví technici", + "mixer": "Mixér |||| Mixéri", + "remixer": "Remixér |||| Remixéri", + "djmixer": "DJ Mixér |||| DJ Mixéri", + "performer": "Účinkujúci |||| Účinkujúci", + "maincredit": "Interpret albumu alebo interpret |||| Interpreti albumov alebo interpreti" + }, + "actions": { + "topSongs": "Najpopulárnejšie skladby", + "shuffle": "Zamiešať", + "radio": "Rádio" + } + }, + "user": { + "name": "Používateľ |||| Používatelia", + "fields": { + "userName": "Používateľské meno", + "isAdmin": "Správca", + "lastLoginAt": "Naposledy prihlásený", + "lastAccessAt": "Posledný Prístup", + "updatedAt": "Upravený", + "name": "Meno", + "password": "Heslo", + "createdAt": "Vytvorený", + "changePassword": "Zmeniť heslo?", + "currentPassword": "Súčastné heslo", + "newPassword": "Nové heslo", + "token": "Token", + "libraries": "Knižnice" + }, + "helperTexts": { + "name": "Zmena mena sa zobrazí až po ďalšom prihlásení", + "libraries": "Vyberte konkrétne knižnice pre tohto používateľa alebo nechajte pole prázdne, ak chcete použiť predvolené knižnice" + }, + "notifications": { + "created": "Používateľ vytvorený", + "updated": "Používateľ upravený", + "deleted": "Používateľ odstránený" + }, + "validation": { + "librariesRequired": "Pre používateľov bez administrátorských práv musí byť vybratá aspoň jedna knižnica" + }, + "message": { + "listenBrainzToken": "Vložte svoj používateľský ListenBrainz token.", + "clickHereForToken": "Kliknite sem pre získanie svojho tokenu", + "selectAllLibraries": "Vybrať všetky knižnice", + "adminAutoLibraries": "Administrátori majú automaticky prístup ku všetkým knižniciam" + } + }, + "player": { + "name": "Prehrávač |||| Prehrávače", + "fields": { + "name": "Názov", + "transcodingId": "ID transkódovania", + "maxBitRate": "Max. prenosová rýchlosť", + "client": "Klient", + "userName": "Používateľské meno", + "lastSeen": "Naposledy videný", + "reportRealPath": "Skutočná cesta hlásenia", + "scrobbleEnabled": "Odosielať scrobbling na externé služby" + } + }, + "transcoding": { + "name": "Transkódovanie |||| Transkódovania", + "fields": { + "name": "Názov", + "targetFormat": "Cieľový formát", + "defaultBitRate": "Predvolená prenosová rýchlosť", + "command": "Príkaz" + } + }, + "playlist": { + "name": "Zoznam skladieb |||| Zoznamy skladieb", + "fields": { + "name": "Názov", + "duration": "Dĺžka", + "ownerName": "Autor", + "public": "Verejný", + "updatedAt": "Nahraný", + "createdAt": "Vytvorený", + "songCount": "Skladby", + "comment": "Komentár", + "sync": "Auto-import", + "path": "Importovať z" + }, + "actions": { + "selectPlaylist": "Vybrať zoznam skladieb:", + "addNewPlaylist": "Vytvoriť \"%{name}\"", + "export": "Export", + "saveQueue": "Uložiť rad do zoznamu skladieb", + "makePublic": "Zverejniť", + "makePrivate": "Nastaviť ako súkromné", + "searchOrCreate": "Vyhľadajte zoznamy skladieb alebo napíšte pre vytvorenie nového...", + "pressEnterToCreate": "Stlačte Enter pre vytvorenie nového zoznamu skladieb", + "removeFromSelection": "Odstrániť z výberu" + }, + "message": { + "duplicate_song": "Pridať duplicitné položky", + "song_exist": "Pridávate duplikát už existujúcej položky v zozname skladieb. Chcete pridať duplikát alebo ho preskočiť?", + "noPlaylistsFound": "Žiadne zoznamy skladieb sa nenašli", + "noPlaylists": "Žiadne zoznamy skladieb nie sú dostupné" + } + }, + "radio": { + "name": "Rádio |||| Rádiá", + "fields": { + "name": "Názov", + "streamUrl": "URL streamu", + "homePageUrl": "URL stránky", + "updatedAt": "Nahrané", + "createdAt": "Vytvorené" + }, + "actions": { + "playNow": "Spustiť" + } + }, + "share": { + "name": "Zdieľanie |||| Zdieľania", + "fields": { + "username": "Zdieľané", + "url": "URL", + "description": "Popis", + "downloadable": "Povoliť sťahovanie?", + "contents": "Obsah", + "expiresAt": "Vyprší", + "lastVisitedAt": "Naposledy navštívené", + "visitCount": "Počet návštev", + "format": "Formát", + "maxBitRate": "Max. Bit Rate", + "updatedAt": "Nahrané", + "createdAt": "Vytvorené" + }, + "notifications": {}, + "actions": {} + }, + "missing": { + "name": "Chýbajúci súbor |||| Chýbajúce súbory", + "empty": "Žiadne chýbajúce súbory", + "fields": { + "path": "Cesta", + "size": "Veľkosť", + "libraryName": "Knižnica", + "updatedAt": "Zmizol dňa" + }, + "actions": { + "remove": "Odstrániť", + "remove_all": "Odstrániť všetky" + }, + "notifications": { + "removed": "Chýbajúce súbory odstránené" + } + }, + "library": { + "name": "Knižnica |||| Knižnice", + "fields": { + "name": "Názov", + "path": "Cesta", + "remotePath": "Vzdialená cesta", + "lastScanAt": "Posledný sken", + "songCount": "Skladby", + "albumCount": "Albumy", + "artistCount": "Interpreti", + "totalSongs": "Skladby", + "totalAlbums": "Albumy", + "totalArtists": "Interpreti", + "totalFolders": "Priečinky", + "totalFiles": "Súbory", + "totalMissingFiles": "Chýbajúce súbory", + "totalSize": "Celková veľkosť", + "totalDuration": "Dĺžka", + "defaultNewUsers": "Predvolené pre nových používateľov", + "createdAt": "Vytvorené", + "updatedAt": "Aktualizované" + }, + "sections": { + "basic": "Základné informácie", + "statistics": "Štatistiky" + }, + "actions": { + "scan": "Skenovať knižnicu", + "quickScan": "Rýchly sken", + "fullScan": "Úplný sken", + "manageUsers": "Spravovať prístup používateľov", + "viewDetails": "Zobraziť detaily" + }, + "notifications": { + "created": "Knižnica úspešne vytvorená", + "updated": "Knižnica úspešne aktualizovaná", + "deleted": "Knižnica úspešne odstránená", + "scanStarted": "Skenovanie knižnice spustené", + "quickScanStarted": "Rýchly sken spustený", + "fullScanStarted": "Úplný sken spustený", + "scanError": "Chyba pri spustení skenu. Skontrolujte logy", + "scanCompleted": "Skenovanie knižnice dokončené" + }, + "validation": { + "nameRequired": "Názov knižnice je povinný", + "pathRequired": "Cesta ku knižnici je povinná", + "pathNotDirectory": "Cesta ku knižnici musí byť priečinok", + "pathNotFound": "Cesta ku knižnici sa nenašla", + "pathNotAccessible": "Cesta ku knižnici nie je dostupná", + "pathInvalid": "Neplatná cesta ku knižnici" + }, + "messages": { + "deleteConfirm": "Ste si istý, že chcete odstrániť túto knižnicu? Tým sa odstránia všetky súvisiace dáta a prístupy používateľov.", + "scanInProgress": "Skenovanie prebieha...", + "noLibrariesAssigned": "Tomuto používateľovi nie sú priradené žiadne knižnice" + } + }, + "plugin": { + "name": "Plugin |||| Pluginy", + "fields": { + "id": "ID", + "name": "Názov", + "description": "Popis", + "version": "Verzia", + "author": "Autor", + "website": "Webová stránka", + "permissions": "Oprávnenia", + "enabled": "Povolený", + "status": "Stav", + "path": "Cesta", + "lastError": "Chyba", + "hasError": "Chyba", + "updatedAt": "Aktualizovaný", + "createdAt": "Nainštalovaný", + "configKey": "Kľúč", + "configValue": "Hodnota", + "allUsers": "Povoliť všetkých používateľov", + "selectedUsers": "Vybraní používatelia", + "allLibraries": "Povoliť všetky knižnice", + "selectedLibraries": "Vybrané knižnice", + "allowWriteAccess": "Povoliť prístup na zápis" + }, + "sections": { + "status": "Stav", + "info": "Informácie o plugine", + "configuration": "Konfigurácia", + "manifest": "Manifest", + "usersPermission": "Oprávnenia používateľov", + "libraryPermission": "Oprávnenia knižnice" + }, + "status": { + "enabled": "Povolený", + "disabled": "Zakázaný" + }, + "actions": { + "enable": "Povoliť", + "disable": "Zakázať", + "disabledDueToError": "Opravte chybu pred povolením", + "disabledUsersRequired": "Vyberte používateľov pred povolením", + "disabledLibrariesRequired": "Vyberte knižnice pred povolením", + "addConfig": "Pridať konfiguráciu", + "rescan": "Znovu skenovať" + }, + "notifications": { + "enabled": "Plugin povolený", + "disabled": "Plugin zakázaný", + "updated": "Plugin aktualizovaný", + "error": "Chyba pri aktualizácii pluginu" + }, + "validation": { + "invalidJson": "Konfigurácia musí byť platný JSON" + }, + "messages": { + "configHelp": "Nakonfigurujte plugin pomocou párov kľúč-hodnota. Nechajte prázdne, ak plugin nevyžaduje žiadnu konfiguráciu.", + "configValidationError": "Overenie konfigurácie zlyhalo:", + "schemaRenderError": "Nie je možné zobraziť konfiguračný formulár. Schéma pluginu môže byť neplatná.", + "clickPermissions": "Kliknite na oprávnenie pre detaily", + "noConfig": "Žiadna konfigurácia nastavená", + "allUsersHelp": "Keď je povolené, plugin bude mať prístup ku všetkým používateľom, vrátane tých vytvorených v budúcnosti.", + "noUsers": "Žiadni používatelia nevybraní", + "permissionReason": "Dôvod", + "usersRequired": "Tento plugin vyžaduje prístup k informáciám o používateľoch. Vyberte, ku ktorým používateľom má plugin prístup, alebo povolte 'Povoliť všetkých používateľov'.", + "allLibrariesHelp": "Keď je povolené, plugin bude mať prístup ku všetkým knižniciam, vrátane tých vytvorených v budúcnosti.", + "noLibraries": "Žiadne knižnice nevybrané", + "librariesRequired": "Tento plugin vyžaduje prístup k informáciám o knižniciach. Vyberte, ku ktorým knižniciam má plugin prístup, alebo povolte 'Povoliť všetky knižnice'.", + "allowWriteAccessHelp": "Keď je povolené, plugin môže upravovať súbory v adresároch knižníc. Predvolene majú pluginy prístup iba na čítanie.", + "requiredHosts": "Požadovaní hostitelia" + }, + "placeholders": { + "configKey": "kľúč", + "configValue": "hodnota" + } + } + }, + "ra": { + "auth": { + "welcome1": "Ďakujeme, že ste si nainštalovali Navidrome!", + "welcome2": "Najskôr vytvorte účet správcu", + "confirmPassword": "Potvrďte heslo", + "buttonCreateAdmin": "Vytvoriť správcu", + "auth_check_error": "Pre pokračovanie sa prosím prihláste", + "user_menu": "Profil", + "username": "Používateľské meno", + "password": "Heslo", + "sign_in": "Prihlásiť sa", + "sign_in_error": "Overenie zlyhalo, skúste to znova", + "logout": "Odhlásiť sa", + "insightsCollectionNote": "Navidrome zhromažďuje anonymné údaje\n o používaní, aby pomohol zlepšiť projekt.\nKliknite [sem] a dozviete sa viac a v prípade\npotreby sa odhláste." + }, + "validation": { + "invalidChars": "Prosím, používajte iba písmená a čísla", + "passwordDoesNotMatch": "Heslá sa nezhodujú", + "required": "Povinné pole", + "minLength": "Musí obsahovať najmenej %{min} znakov", + "maxLength": "Môže obsahovať maximálne %{max} znakov", + "minValue": "Musí byť aspoň %{min}", + "maxValue": "Môže byť maximálne %{max}", + "number": "Musí byť číslo", + "email": "Musí byť platná e-mailová adresa", + "oneOf": "Musí spĺňať jedno z: %{options}", + "regex": "Musí byť v špecifickom formáte (regexp): %{pattern}", + "unique": "Musí byť jedinečný", + "url": "Musí byť platná URL" + }, + "action": { + "add_filter": "Pridať filter", + "add": "Pridať", + "back": "Ísť späť", + "bulk_actions": "1 vybraná |||| %{smart_count} vybraných", + "bulk_actions_mobile": "1 |||| %{smart_count}", + "cancel": "Zrušiť", + "clear_input_value": "Vymazať hodnotu", + "clone": "Klonovať", + "confirm": "Potvrdiť", + "create": "Vytvoriť", + "delete": "Vymazať", + "edit": "Upraviť", + "export": "Exportovať", + "list": "Zoznam", + "refresh": "Obnoviť", + "remove_filter": "Odstrániť filter", + "remove": "Odstrániť", + "save": "Uložiť", + "search": "Vyhľadať", + "show": "Zobraziť", + "sort": "Zoradiť", + "undo": "Vrátiť", + "expand": "Rozbaliť", + "close": "Zavrieť", + "open_menu": "Otvoriť ponuku", + "close_menu": "Zavrieť ponuku", + "unselect": "Zrušiť výber", + "skip": "Preskočiť", + "share": "Zdieľať", + "download": "Stiahnuť" + }, + "boolean": { + "true": "Áno", + "false": "Nie" + }, + "page": { + "create": "Vytvoriť %{name}", + "dashboard": "Dashboard", + "edit": "%{name} #%{id}", + "error": "Niečo sa pokazilo", + "list": "%{name}", + "loading": "Načítavanie", + "not_found": "Nenájdené", + "show": "%{name} #%{id}", + "empty": "Zatiaľ žiaden %{name}.", + "invite": "Chcete pridať nové?" + }, + "input": { + "file": { + "upload_several": "Presuňte súbory pre nahranie alebo kliknite pre výber.", + "upload_single": "Presuňte súbor pre nahranie alebo kliknite pre jeho výber." + }, + "image": { + "upload_several": "Presuňte obrázky pre nahranie alebo kliknite pre výber.", + "upload_single": "Presuňte obrázok pre nahranie alebo kliknite pre jeho výber." + }, + "references": { + "all_missing": "Referencované dáta sa nenašli.", + "many_missing": "Aspoň jedna z referencií už nie je dostupná.", + "single_missing": "Referencia sa zdá byť nedostupná." + }, + "password": { + "toggle_visible": "Skryť heslo", + "toggle_hidden": "Zobraziť heslo" + } + }, + "message": { + "about": "O Navidrome", + "are_you_sure": "Ste si istý?", + "bulk_delete_content": "Ste si istý, že chcete vymazať %{name}? |||| Ste si istý, že chcete vymazať týchto %{smart_count} položiek?", + "bulk_delete_title": "Vymazať %{name} |||| Vymazať %{smart_count} %{name} položiek", + "delete_content": "Ste si istý, že chcete vymazať túto položku?", + "delete_title": "Vymazať %{name} #%{id}", + "details": "Detaily", + "error": "Vyskytla sa chyba klienta a vaša požiadavka nemohla byť splnená.", + "invalid_form": "Formulár nie je platný. Prosím skontrolujte ho.", + "loading": "Stránka sa načítava, prosím počkajte", + "no": "Nie", + "not_found": "Zadali ste nesprávnu adresu URL, alebo ste nasledovali nesprávny odkaz.", + "yes": "Áno", + "unsaved_changes": "Niektoré vaše zmeny neboli uložené. Ste si istí, že ich chcete ignorovať?" + }, + "navigation": { + "no_results": "Nenašli sa žiadne výsledky", + "no_more_results": "Stránka číslo %{page} je mimo rozsah. Skúste predchádzajúcu.", + "page_out_of_boundaries": "Stránka číslo %{page} je mimo rozsah", + "page_out_from_end": "Nemožno ísť za poslednú stranu", + "page_out_from_begin": "Nemožno ísť pred prvú stranu", + "page_range_info": "%{offsetBegin}-%{offsetEnd} z %{total}", + "page_rows_per_page": "Položiek na stránke:", + "next": "Ďalší", + "prev": "Predchádzajúci", + "skip_nav": "Preskočiť na obsah" + }, + "notification": { + "updated": "Prvok aktualizovaný |||| %{smart_count} prvkov aktualizovaných", + "created": "Prvok vytvorený", + "deleted": "Prvok vymazaný |||| %{smart_count} prvkov vymazaných", + "bad_item": "Nesprávny prvok", + "item_doesnt_exist": "Prvok neexistuje", + "http_error": "Chyba komunikácie servera", + "data_provider_error": "Chyba dataProvideru. Detaily nájdete v konzole.", + "i18n_error": "Nemožno načítať preklady pre vybraný jazyk", + "canceled": "Akcia zrušená", + "logged_out": "Vaša relácia skončila, prosím pripojte sa znova.", + "new_version": "Je dostupná nová verzia! Prosím obnovte toto okno." + }, + "toggleFieldsMenu": { + "columnsToDisplay": "Stĺpce na zobrazenie", + "layout": "Rozloženie", + "grid": "Mriežka", + "table": "Tabuľka" + } + }, + "message": { + "uploadCover": "Nahrať obrázok obalu", + "removeCover": "Odstrániť obrázok obalu", + "coverUploaded": "Obrázok obalu albumu aktualizovaný", + "coverRemoved": "Obrázok obalu albumu odstránený", + "coverUploadError": "Chyba pri nahrávaní obrázku obalu albumu", + "coverRemoveError": "Chyba pri odstraňovaní obrázku obalu albumu", + "note": "POZNÁMKA", + "transcodingDisabled": "Zmena nastavení transkódovania je vo webovom prostredí vypnutá z bezpečnostných dôvodov. Ak chcete zmeniť (upraviť alebo pridať) možnosti transkódovania, reštartujte server s možnosťou %{config}.", + "transcodingEnabled": "Navidrome práve beží s možnosťou %{config}, ktorá umožňuje spúšťanie systémových príkazov z nastavení transkódovania pomocou webového rozhrania. Odporúčame ju vypnúť z bezpečnostných dôvodov a používať ju iba pri úprave nastavení transkódovania.", + "songsAddedToPlaylist": "1 skladba pridaná do zoznamu skladieb |||| %{smart_count} skladieb pridaných do zoznamu skladieb", + "noSimilarSongsFound": "Nenašli sa žiadne podobné skladby", + "startingInstantMix": "Načítava sa Instant Mix...", + "noTopSongsFound": "Nenašli sa žiadne top skladby", + "noPlaylistsAvailable": "Žiadne nie sú dostupné", + "delete_user_title": "Odstrániť používateľa '%{name}'", + "delete_user_content": "Ste si istí, že chcete odstrániť tohto používateľa a všetky jeho dáta (vrátane zoznamov skladieb a nastavení)?", + "remove_missing_title": "Odstráňte chýbajúce súbory", + "remove_missing_content": "Naozaj chcete odstrániť vybraté chýbajúce súbory z databázy? Týmto sa natrvalo odstránia všetky odkazy na ne vrátane ich počtu prehratí a hodnotení.", + "remove_all_missing_title": "Odstráňte všetky chýbajúce súbory", + "remove_all_missing_content": "Naozaj chcete z databázy odstrániť všetky chýbajúce súbory? Týmto sa natrvalo odstránia všetky odkazy na ne vrátane ich počtu prehratí a hodnotení.", + "notifications_blocked": "Zablokovali ste si oznámenia pre túto stránku v nastaveniach vášho prehliadača", + "notifications_not_available": "Tento prehliadač nepodporuje oznámenia na ploche alebo nepristupujete k Navidrome cez https", + "lastfmLinkSuccess": "Last.fm úspešne pripojené a scrobbling zapnutý", + "lastfmLinkFailure": "Last.fm sa nepodarilo pripojiť", + "lastfmUnlinkSuccess": "Last.fm odpojené a scrobbling vypnutý", + "lastfmUnlinkFailure": "Last.fm sa nepodarilo odpojiť", + "listenBrainzLinkSuccess": "ListenBrainz úspešne pripojený a scrobbling zapnutý ako používateľ: %{user}", + "listenBrainzLinkFailure": "ListenBrainz sa nepodarilo pripojiť: %{error}", + "listenBrainzUnlinkSuccess": "ListenBrainz odpojený a scrobbling vypnutý", + "listenBrainzUnlinkFailure": "ListenBrainz sa nepodarilo odpojiť", + "openIn": { + "lastfm": "Otvoriť na Last.fm", + "musicbrainz": "Otvoriť na MusicBrainz" + }, + "lastfmLink": "Čítať ďalej...", + "shareOriginalFormat": "Zdieľať v pôvodnom formáte", + "shareDialogTitle": "Zdieľať %{resource} '%{name}'", + "shareBatchDialogTitle": "Zdieľať 1 %{resource} |||| Zdieľať %{smart_count} %{resource}", + "shareCopyToClipboard": "Skopírovať do schránky: Ctrl+C, Enter", + "shareSuccess": "URL skopírovaná do schránky: %{url}", + "shareFailure": "Chyba pri kopírovaní URL %{url} do schránky", + "downloadDialogTitle": "Stiahnuť %{resource} '%{name}' (%{size})", + "downloadOriginalFormat": "Stiahnuť v pôvodnom formáte" + }, + "menu": { + "library": "Knižnica", + "librarySelector": { + "allLibraries": "Všetky knižnice (%{count})", + "multipleLibraries": "%{selected} z %{total} knižníc", + "selectLibraries": "Vyberte knižnice", + "none": "Žiadne" + }, + "settings": "Nastavenia", + "version": "Verzia", + "theme": "Téma", + "personal": { + "name": "Osobné", + "options": { + "theme": "Téma", + "language": "Jazyk", + "defaultView": "Predvolená stránka", + "desktop_notifications": "Oznámenia na ploche", + "lastfmNotConfigured": "Kľúč API Last.fm nie je nakonfigurovaný", + "lastfmScrobbling": "Scrobblovať na Last.fm", + "listenBrainzScrobbling": "Scrobblovať na ListenBrainz", + "replaygain": "Mód ReplayGain", + "preAmp": "ReplayGain PreAmp (dB)", + "gain": { + "none": "Vypnuté", + "album": "Použiť Album Gain", + "track": "Použiť Track Gain" + } + } + }, + "albumList": "Albumy", + "playlists": "Zoznamy skladieb", + "sharedPlaylists": "Zdieľané zoznamy skladieb", + "about": "O Navidrome" + }, + "player": { + "playListsText": "Rad", + "openText": "Otvoriť", + "closeText": "Zavrieť", + "notContentText": "Žiadne skladby", + "clickToPlayText": "Kliknite pre prehranie", + "clickToPauseText": "Kliknite pre pozastavenie", + "nextTrackText": "Ďalšia skladba", + "previousTrackText": "Predchádzajúca skladba", + "reloadText": "Znovu načítať", + "volumeText": "Hlasitosť", + "toggleLyricText": "Prepnúť text", + "toggleMiniModeText": "Zmenšiť", + "destroyText": "Zničiť", + "downloadText": "Stiahnuť", + "removeAudioListsText": "Vymazať zoznam", + "clickToDeleteText": "Kliknite pre odstránenie %{name}", + "emptyLyricText": "Bez textu", + "playModeText": { + "order": "Po poradí", + "orderLoop": "Opakovať", + "singleLoop": "Opakovať raz", + "shufflePlay": "Zamiešať" + } + }, + "about": { + "links": { + "homepage": "Domovská stránka", + "source": "Zdrojový kód", + "featureRequests": "Požiadavky na funkcie", + "lastInsightsCollection": "Posledný zber štatistík", + "insights": { + "disabled": "Zakázané", + "waiting": "Čakanie" + } + }, + "tabs": { + "about": "O aplikácii", + "config": "Konfigurácia" + }, + "config": { + "configName": "Názov konfigurácie", + "environmentVariable": "Premenná prostredia", + "currentValue": "Aktuálna hodnota", + "configurationFile": "Konfiguračný súbor", + "exportToml": "Exportovať konfiguráciu (TOML)", + "downloadToml": "Stiahnuť konfiguráciu (TOML)", + "exportSuccess": "Konfigurácia exportovaná do schránky vo formáte TOML", + "exportFailed": "Nepodarilo sa skopírovať konfiguráciu", + "devFlagsHeader": "Vývojové príznaky (môžu byť zmenené/odstránené)", + "devFlagsComment": "Toto sú experimentálne nastavenia a môžu byť odstránené v budúcich verziách" + } + }, + "activity": { + "title": "Aktivita", + "totalScanned": "Naskenované priečinky", + "quickScan": "Rýchly sken", + "fullScan": "Úplný sken", + "selectiveScan": "Selektívne", + "serverUptime": "Doba od spustenia", + "serverDown": "OFFLINE", + "scanType": "Posledný Sken", + "status": "Chyba skenovania", + "elapsedTime": "Uplynutý čas" + }, + "nowPlaying": { + "title": "Práve hrá", + "empty": "Nič sa neprehráva", + "minutesAgo": "pred %{smart_count} minútou |||| pred %{smart_count} minútami" + }, + "help": { + "title": "Klávesové skratky Navidrome", + "hotkeys": { + "show_help": "Zobraziť túto nápovedu", + "toggle_menu": "Prepnúť bočné menu", + "toggle_play": "Prehrať / Pozastaviť", + "prev_song": "Predchádzajúca skladba", + "next_song": "Nasledujúca skladba", + "current_song": "Prejsť na aktuálnu skladbu", + "vol_up": "Zvýšiť hlasitosť", + "vol_down": "Znížiť hlasitosť", + "toggle_love": "Pridať túto skladbu do obľúbených" + } + } +} \ No newline at end of file diff --git a/resources/i18n/sl.json b/resources/i18n/sl.json index 80bd8e4a3..ceb56e9b7 100644 --- a/resources/i18n/sl.json +++ b/resources/i18n/sl.json @@ -36,7 +36,9 @@ "bitDepth": "Bitna globina", "sampleRate": "Frekvenca vzorčenja", "missing": "Manjka", - "libraryName": "Knjižnica" + "libraryName": "Knjižnica", + "composer": "Skladatelj", + "disc": "" }, "actions": { "addToQueue": "Predvajaj kasneje", @@ -46,7 +48,8 @@ "download": "Naloži", "playNext": "Naslednji", "info": "Več informacij", - "showInPlaylist": "Prikaži na seznamu predvajanja" + "showInPlaylist": "Prikaži na seznamu predvajanja", + "instantMix": "Instant Mix" } }, "album": { @@ -301,14 +304,19 @@ "actions": { "scan": "Skeniraj knjižnico", "manageUsers": "Upravljanje dostopa uporabnikov", - "viewDetails": "Ogled podrobnosti" + "viewDetails": "Ogled podrobnosti", + "quickScan": "Hitro skeniranje", + "fullScan": "Popolno skeniranje" }, "notifications": { "created": "Knjižnica je uspešno ustvarjena", "updated": "Knjižnica je bila uspešno posodobljena", "deleted": "Knjižnica je uspešno izbrisana", "scanStarted": "Skeniranje knjižnice se je začelo", - "scanCompleted": "Skeniranje knjižnice končano" + "scanCompleted": "Skeniranje knjižnice končano", + "quickScanStarted": "Hitro skeniranje se je začelo", + "fullScanStarted": "Popolno skeniranje se je začelo", + "scanError": "Napaka pri začetku skeniranja. Preverite dnevnike" }, "validation": { "nameRequired": "Ime knjižnice je obvezno", @@ -323,6 +331,82 @@ "scanInProgress": "Skeniranje v teku...", "noLibrariesAssigned": "Uporabnik nima dodeljenih knjižnic" } + }, + "plugin": { + "name": "Vtičnik |||| Vtičniki", + "fields": { + "id": "ID", + "name": "Ime", + "description": "Opis", + "version": "Verzija", + "author": "Avtor", + "website": "Spletna stran", + "permissions": "Dovoljenja", + "enabled": "Vključeno", + "status": "Status", + "path": "Pot", + "lastError": "Napaka", + "hasError": "Napaka", + "updatedAt": "Posodobljeno", + "createdAt": "Inštalirano", + "configKey": "Ključ", + "configValue": "Vrednost", + "allUsers": "Dovoli vsem uporabnikom", + "selectedUsers": "Izbrani uporabniki", + "allLibraries": "Dovoli vse knjižnice", + "selectedLibraries": "Izbrane knjižnice", + "allowWriteAccess": "" + }, + "sections": { + "status": "Status", + "info": "Informacije o vtičniku", + "configuration": "Konfiguracija", + "manifest": "Manifest", + "usersPermission": "Uporabniška dovoljenja", + "libraryPermission": "Knjižnična dovoljenja" + }, + "status": { + "enabled": "Vključeno", + "disabled": "Izključeno" + }, + "actions": { + "enable": "Vključi", + "disable": "Izključi", + "disabledDueToError": "Popravi napako pred vključitvijo", + "disabledUsersRequired": "Izberi uporabnike pred vključitvijo", + "disabledLibrariesRequired": "Izberi knjižnice pred vključitvijo", + "addConfig": "Dodaj konfiguracijo", + "rescan": "Ponovi skeniranje" + }, + "notifications": { + "enabled": "Vtičnik vključen", + "disabled": "Vtičnik izključen", + "updated": "Vtičnik posodobljen", + "error": "Napaka pri posodobitvi vtičnika" + }, + "validation": { + "invalidJson": "Konfiguracija mora biti pravilen JSON" + }, + "messages": { + "configHelp": "Konfiguriraj vtičnik z uporabo key-value parov. Pusti prazno, če vtičnik ne potrebuje konfiguracije.", + "clickPermissions": "Klikni za dovoljenje o podrobnostih", + "noConfig": "Konfiguracija ni nastavljena", + "allUsersHelp": "Ko vključeno, bo vtičnik imel dostop do vseh uporabnikov, tudi prihodnjih.", + "noUsers": "Uporabniki niso izbrani", + "permissionReason": "Razlog", + "usersRequired": "Vtičnik potrebuje dostop do uporabnikovih informacij. Izberi uporabnike ali vključi dostop vsem uporabnikom.", + "allLibrariesHelp": "Ko vključeno, bo vtičnik imel dostop do vseh knjižnic, tudi prihodnjih.", + "noLibraries": "Ni izbranih knjižnic", + "librariesRequired": "Vtičnik zahteva dostop do knjižnih informacij. Izberi do katerih knjižnic lahko dostopa, ali vključi dostop do vseh knjižnic.", + "requiredHosts": "Zahtevani gostitelji", + "configValidationError": "Validacija konfiguracije neuspešna:", + "schemaRenderError": "Konfiguracijskega obrazca ni mogoče upodobiti. Shema vtičnika je morda neveljavna.", + "allowWriteAccessHelp": "" + }, + "placeholders": { + "configKey": "ključ", + "configValue": "vrednost" + } } }, "ra": { @@ -506,7 +590,8 @@ "remove_all_missing_title": "Odstrani vse manjkajoče datoteke", "remove_all_missing_content": "Ste prepričani, da želite odstraniti vse manjkajoče datoteke iz baze? Trajno boste odstranili vse reference nanje, vključno s številom predvajanj in ocenami.", "noSimilarSongsFound": "Ni najdenih podobnih pesmi", - "noTopSongsFound": "Ni najdenih najboljših pesmi" + "noTopSongsFound": "Ni najdenih najboljših pesmi", + "startingInstantMix": "Nalaganje Instant Mix..." }, "menu": { "library": "Knjižnica", @@ -592,7 +677,8 @@ "exportSuccess": "Konfiguracija izvožena v odložišče v formatu TOML", "exportFailed": "Kopiranje konfiguracije ni uspelo", "devFlagsHeader": "Razvojne zastavice (lahko se spremenijo/odstranijo)", - "devFlagsComment": "To so eksperimentalne nastavitve in bodo morda odstranjene v prihodnjih različicah" + "devFlagsComment": "To so eksperimentalne nastavitve in bodo morda odstranjene v prihodnjih različicah", + "downloadToml": "Naloži konfiguracijo (TOML)" } }, "activity": { @@ -604,7 +690,8 @@ "serverDown": "NEPOVEZAN", "scanType": "Tip", "status": "Napaka pri skeniranju", - "elapsedTime": "Pretečeni čas" + "elapsedTime": "Pretečeni čas", + "selectiveScan": "Selektivno" }, "help": { "title": "Hitre tipke", @@ -625,4 +712,4 @@ "empty": "Nič se ne predvaja", "minutesAgo": "Pred %{smart_count} minuto |||| Pred %{smart_count} minutami" } -} \ No newline at end of file +} diff --git a/resources/i18n/sv.json b/resources/i18n/sv.json index 521f997a8..23bd5fbc2 100644 --- a/resources/i18n/sv.json +++ b/resources/i18n/sv.json @@ -36,7 +36,9 @@ "bitDepth": "Bitdjup", "sampleRate": "Samplingsfrekvens", "missing": "Saknade", - "libraryName": "Bibliotek" + "libraryName": "Bibliotek", + "composer": "Kompositör", + "disc": "" }, "actions": { "addToQueue": "Lägg till i kön", @@ -46,7 +48,8 @@ "download": "Ladda ner", "playNext": "Spela nästa", "info": "Mer information", - "showInPlaylist": "Visa i spellista" + "showInPlaylist": "Visa i spellista", + "instantMix": "Direktmix" } }, "album": { @@ -301,14 +304,19 @@ "actions": { "scan": "Scanna bibliotek", "manageUsers": "Hantera användaråtkomst", - "viewDetails": "Se detaljer" + "viewDetails": "Se detaljer", + "quickScan": "Snabbscan", + "fullScan": "Komplett scan" }, "notifications": { "created": "Biblioteket har skapats", "updated": "Biblioteket har uppdaterats", "deleted": "Biblioteket har raderats", "scanStarted": "Biblioteksscan startad", - "scanCompleted": "Biblioteksscan avslutad" + "scanCompleted": "Biblioteksscan avslutad", + "quickScanStarted": "Snabbscan startad", + "fullScanStarted": "Komplett scan startad", + "scanError": "Fel vid start av scan. Se loggarna" }, "validation": { "nameRequired": "Biblioteksnamn krävs", @@ -323,6 +331,82 @@ "scanInProgress": "Scanning pågår...", "noLibrariesAssigned": "Inga bibliotek har tilldelats den här användaren" } + }, + "plugin": { + "name": "Tillägg |||| Tillägg", + "fields": { + "id": "ID", + "name": "Namn", + "description": "Beskrivning", + "version": "Version", + "author": "Författare", + "website": "Website", + "permissions": "Behörigheter", + "enabled": "Aktiverad", + "status": "Status", + "path": "Sökväg", + "lastError": "Fel", + "hasError": "Fel", + "updatedAt": "Uppdaterad", + "createdAt": "Installerad", + "configKey": "Nyckel", + "configValue": "Värde", + "allUsers": "Tillåt alla användare", + "selectedUsers": "Valda användare", + "allLibraries": "Tillåt alla bibliotek", + "selectedLibraries": "Valda bibliotek", + "allowWriteAccess": "" + }, + "sections": { + "status": "Status", + "info": "Tilläggsinformation", + "configuration": "Konfiguration", + "manifest": "Manifest", + "usersPermission": "Användarbehörigheter", + "libraryPermission": "Biblioteksbehörigheter" + }, + "status": { + "enabled": "Aktiverad", + "disabled": "Inaktiverad" + }, + "actions": { + "enable": "Aktivera", + "disable": "Inaktivera", + "disabledDueToError": "Åtgärda felet innan aktivering", + "disabledUsersRequired": "Välj användare före aktivering", + "disabledLibrariesRequired": "Välj bibliotek före aktivering", + "addConfig": "Lägg till konfiguration", + "rescan": "Scanna om" + }, + "notifications": { + "enabled": "Tillägg aktiverat", + "disabled": "Tillägg inaktiverat", + "updated": "Tillägg uppdaterat", + "error": "Fel vid uppdatering av tillägg" + }, + "validation": { + "invalidJson": "Konfigurationen måste vara giltig JSON" + }, + "messages": { + "configHelp": "Konfigurera tillägget med nyckel–värde-par. Lämna tomt om tillägget inte kräver någon konfiguration.", + "clickPermissions": "Klicka på en behörighet för mer information", + "noConfig": "Ingen konfiguration angiven", + "allUsersHelp": "När den är aktiverad får tillägget tillgång till alla användare, inklusive de som skapas i framtiden.", + "noUsers": "Inga användare valda", + "permissionReason": "Orsak", + "usersRequired": "Detta tillägg kräver åtkomst till användarinformation. Välj vilka användare insticksprogrammet ska ha åtkomst till, eller aktivera 'Tillåt alla användare'.", + "allLibrariesHelp": "När den är aktiverad får tillägget tillgång till alla bibliotek, inklusive de som skapas i framtiden.", + "noLibraries": "Inga bibliotek valda", + "librariesRequired": "Detta tillägg kräver tillgång till biblioteksinformation. Välj vilka bibliotek tillägget kan komma åt eller aktivera 'Tillåt alla bibliotek'.", + "requiredHosts": "Krävda värdar", + "configValidationError": "Validering av konfigurationen misslyckades:", + "schemaRenderError": "Kunde inte rendera konfigurationsformuläret. Tilläggets schema kan vara ogiltigt.", + "allowWriteAccessHelp": "" + }, + "placeholders": { + "configKey": "nyckel", + "configValue": "värde" + } } }, "ra": { @@ -506,7 +590,8 @@ "remove_all_missing_title": "Ta bort alla saknade filer", "remove_all_missing_content": "Är du säker på att du vill ta bort alla saknade filer från databasen? Detta kommer permanent radera alla referenser till dem, inklusive antal spelningar och betyg.", "noSimilarSongsFound": "Hittade inga liknande låtar", - "noTopSongsFound": "Hittade inga topplåtar" + "noTopSongsFound": "Hittade inga topplåtar", + "startingInstantMix": "Laddar direktmix..." }, "menu": { "library": "Bibliotek", @@ -539,7 +624,7 @@ "librarySelector": { "allLibraries": "Alla bibliotek (%{count})", "multipleLibraries": "%{selected} av %{total} bibliotek", - "selectLibraries": "Valda bibliotek", + "selectLibraries": "Välj bibliotek", "none": "Inga" } }, @@ -592,7 +677,8 @@ "exportSuccess": "Inställningarna kopierade till urklippet i TOML-format", "exportFailed": "Kopiering av inställningarna misslyckades", "devFlagsHeader": "Utvecklingsflaggor (kan ändras eller tas bort)", - "devFlagsComment": "Dessa inställningar är experimentella och kan tas bort i framtida versioner" + "devFlagsComment": "Dessa inställningar är experimentella och kan tas bort i framtida versioner", + "downloadToml": "Ladda ner konfiguration (TOML)" } }, "activity": { @@ -604,7 +690,8 @@ "serverDown": "OFFLINE", "scanType": "Typ", "status": "Fel vid scanning", - "elapsedTime": "Spelad tid" + "elapsedTime": "Spelad tid", + "selectiveScan": "Urval" }, "help": { "title": "Navidrome kortkommandon", @@ -625,4 +712,4 @@ "empty": "Inget spelas", "minutesAgo": "%{smart_count} minut sedan |||| %{smart_count} minuter sedan" } -} \ No newline at end of file +} diff --git a/resources/i18n/th.json b/resources/i18n/th.json index 2f96f4958..b445d7464 100644 --- a/resources/i18n/th.json +++ b/resources/i18n/th.json @@ -26,7 +26,19 @@ "bpm": "BPM", "playDate": "เล่นล่าสุด", "channels": "ช่อง", - "createdAt": "เพิ่มเมื่อ" + "createdAt": "เพิ่มเมื่อ", + "grouping": "จัดกลุ่ม", + "mood": "อารมณ์", + "participants": "ผู้มีส่วนร่วม", + "tags": "แทกเพิ่มเติม", + "mappedTags": "แมพแทก", + "rawTags": "แทกเริ่มต้น", + "bitDepth": "Bit depth", + "sampleRate": "แซมเปิ้ลเรต", + "missing": "หายไป", + "libraryName": "ห้องสมุด", + "composer": "ผู้แต่ง", + "disc": "" }, "actions": { "addToQueue": "เพิ่มในคิว", @@ -35,7 +47,9 @@ "shuffleAll": "สุ่มทั้งหมด", "download": "ดาวน์โหลด", "playNext": "เล่นถัดไป", - "info": "ดูรายละเอียด" + "info": "ดูรายละเอียด", + "showInPlaylist": "แสดงในเพลย์ลิสต์", + "instantMix": "อินสแตนต์ มิก" } }, "album": { @@ -58,7 +72,16 @@ "originalDate": "วันที่เริ่ม", "releaseDate": "เผยแพร่เมื่อ", "releases": "เผยแพร่ |||| เผยแพร่", - "released": "เผยแพร่เมื่อ" + "released": "เผยแพร่เมื่อ", + "recordLabel": "ป้าย", + "catalogNum": "หมายเลขแคตาล็อก", + "releaseType": "ประเภท", + "grouping": "จัดกลุ่ม", + "media": "มีเดีย", + "mood": "อารมณ์", + "date": "บันทึกเมื่อ", + "missing": "หายไป", + "libraryName": "ห้องสมุด" }, "actions": { "playAll": "เล่นทั้งหมด", @@ -89,7 +112,30 @@ "playCount": "เล่นแล้ว", "rating": "ความนิยม", "genre": "ประเภท", - "size": "ขนาด" + "size": "ขนาด", + "role": "Role", + "missing": "หายไป" + }, + "roles": { + "albumartist": "ศิลปินอัลบั้ม |||| ศิลปินอัลบั้ม", + "artist": "ศิลปิน |||| ศิลปิน", + "composer": "ผู้แต่ง |||| ผู้แต่ง", + "conductor": "คอนดักเตอร์ |||| คอนดักเตอร์", + "lyricist": "เนื้อเพลง |||| เนื้อเพลง", + "arranger": "ผู้ดำเนินการ |||| ผู้ดำเนินการ", + "producer": "ผู้จัด |||| ผู้จัด", + "director": "ไดเรกเตอร์ |||| ไดเรกเตอร์", + "engineer": "วิศวกร |||| วิศวกร", + "mixer": "มิกเซอร์ |||| มิกเซอร์", + "remixer": "รีมิกเซอร์ |||| รีมิกเซอร์", + "djmixer": "ดีเจมิกเซอร์ |||| ดีเจมิกเซอร์", + "performer": "ผู้เล่น |||| ผู้เล่น", + "maincredit": "ศิลปิน |||| ศิลปิน" + }, + "actions": { + "shuffle": "เล่นสุ่ม", + "radio": "วิทยุ", + "topSongs": "เพลงยอดนิยม" } }, "user": { @@ -106,10 +152,12 @@ "currentPassword": "รหัสผ่านปัจจุบัน", "newPassword": "รหัสผ่านใหม่", "token": "โทเคน", - "lastAccessAt": "เข้าใช้ล่าสุด" + "lastAccessAt": "เข้าใช้ล่าสุด", + "libraries": "ห้องสมุด" }, "helperTexts": { - "name": "การเปลี่ยนชื่อจะมีผลในการล็อกอินครั้งถัดไป" + "name": "การเปลี่ยนชื่อจะมีผลในการล็อกอินครั้งถัดไป", + "libraries": "เลือกห้องสมุดสำหรับผู้ใช้นี้หรือปล่อยว่างเพื่อใช้ห้องสมุดเริ่มต้น" }, "notifications": { "created": "สร้างชื่อผู้ใช้", @@ -118,7 +166,12 @@ }, "message": { "listenBrainzToken": "ใส่โทเคน ListenBrainz ของคุณ", - "clickHereForToken": "กดที่นี่เพื่อรับโทเคนของคุณ" + "clickHereForToken": "กดที่นี่เพื่อรับโทเคนของคุณ", + "selectAllLibraries": "เลือกห้องสมุดทั้งหมด", + "adminAutoLibraries": "ผู้ดูแลเข้าถึงห้องสมุดทั้งหมดโดยอัตโนมัติ" + }, + "validation": { + "librariesRequired": "ต้องเลือกห้องสมุด 1 ห้อง สำหรับผู้ใช้ที่ไม่ใช่ผู้ดูแล" } }, "player": { @@ -162,11 +215,17 @@ "addNewPlaylist": "สร้าง \"%{name}\"", "export": "ส่งออก", "makePublic": "ทำเป็นสาธารณะ", - "makePrivate": "ทำเป็นส่วนตัว" + "makePrivate": "ทำเป็นส่วนตัว", + "saveQueue": "บันทึกคิวลงเพลย์ลิสต์", + "searchOrCreate": "ค้นหาเพลย์ลิสต์หรือพิมพ์เพื่อสร้างใหม่", + "pressEnterToCreate": "กด Enter เพื่อสร้างเพลย์ลิสต์", + "removeFromSelection": "เอาออกจากที่เลือกไว้" }, "message": { "duplicate_song": "เพิ่มเพลงซ้ำ", - "song_exist": "เพิ่มเพลงซ้ำกันในเพลย์ลิสต์ คุณจะเพิ่มเพลงต่อหรือข้าม" + "song_exist": "เพิ่มเพลงซ้ำกันในเพลย์ลิสต์ คุณจะเพิ่มเพลงต่อหรือข้าม", + "noPlaylistsFound": "ไม่พบเพลย์ลิสต์", + "noPlaylists": "ไม่มีเพลย์ลิสต์อยู่" } }, "radio": { @@ -198,6 +257,156 @@ "createdAt": "สร้างเมื่อ", "downloadable": "อนุญาตให้ดาวโหลด?" } + }, + "missing": { + "name": "ไฟล์ที่หายไป |||| ไฟล์ที่หายไป", + "fields": { + "path": "พาร์ท", + "size": "ขนาด", + "updatedAt": "หายไปจาก", + "libraryName": "ห้องสมุด" + }, + "actions": { + "remove": "เอาออก", + "remove_all": "เอาออกทั้งหมด" + }, + "notifications": { + "removed": "เอาไฟล์ที่หายไปออกแล้ว" + }, + "empty": "ไม่มีไฟล์หาย" + }, + "library": { + "name": "ห้องสมุด |||| ห้องสมุด", + "fields": { + "name": "ชื่อ", + "path": "พาร์ท", + "remotePath": "รีโมทพาร์ท", + "lastScanAt": "สแกนล่าสุด", + "songCount": "เพลง", + "albumCount": "อัลบัม", + "artistCount": "ศิลปิน", + "totalSongs": "เพลง", + "totalAlbums": "อัลบัม", + "totalArtists": "ศิลปิน", + "totalFolders": "แฟ้ม", + "totalFiles": "ไฟล์", + "totalMissingFiles": "ไฟล์ที่หายไป", + "totalSize": "ขนาดทั้งหมด", + "totalDuration": "ความยาว", + "defaultNewUsers": "ค่าเริ่มต้นผู้ใช้ใหม่", + "createdAt": "สร้าง", + "updatedAt": "อัพเดท" + }, + "sections": { + "basic": "ข้อมูลเบื้องต้น", + "statistics": "สถิติ" + }, + "actions": { + "scan": "สแกนห้องสมุด", + "manageUsers": "ตั้งค่าการเข้าถึง", + "viewDetails": "ดูรายละเอียด", + "quickScan": "สแกนแบบเร็ว", + "fullScan": "สแกนแบบเต็ม" + }, + "notifications": { + "created": "สร้างห้องสมุดเรียบร้อย", + "updated": "อัพเดทห้องสมุดเรียบร้อย", + "deleted": "ลบห้องสมุดเพลงเรียบร้อยแล้ว", + "scanStarted": "เริ่มสแกนห้องสมุด", + "scanCompleted": "สแกนห้องสมุดเสร็จแล้ว", + "quickScanStarted": "เริ่มสแกนแบบเร็ว", + "fullScanStarted": "เริ่มสแกนแบบเต็ม", + "scanError": "การเริ่มสแกนผิดพลาด ดูในบันทึก" + }, + "validation": { + "nameRequired": "ต้องใส่ชื่อห้องสมุดเพลง", + "pathRequired": "ต้องใส่พาร์ทของห้องสมุด", + "pathNotDirectory": "พาร์ทของห้องสมุดต้องเป็นแฟ้ม", + "pathNotFound": "ไม่เจอพาร์ทของห้องสมุด", + "pathNotAccessible": "ไม่สามารถเข้าพาร์ทของห้องสมุด", + "pathInvalid": "พาร์ทห้องสมุดไม่ถูก" + }, + "messages": { + "deleteConfirm": "คุณแน่ใจว่าจะลบห้องสมุดนี้? นี่จะลบข้อมูลและการเข้าถึงของผู้ใช้ที่เกี่ยวข้องทั้งหมด", + "scanInProgress": "กำลังสแกน...", + "noLibrariesAssigned": "ไม่มีห้องสมุดสำหรับผู้ใช้นี้" + } + }, + "plugin": { + "name": "ปลั๊กอิน |||| ปลั๊กอิน", + "fields": { + "id": "ID", + "name": "ชื่อ", + "description": "รายละเอียด", + "version": "เวอร์ชั่น", + "author": "ผู้สร้าง", + "website": "เว็บไซต์", + "permissions": "การอนุญาติ", + "enabled": "เปิดใช้", + "status": "สถานะ", + "path": "เส้นทาง", + "lastError": "ผิดพลาด", + "hasError": "ผิดพลาด", + "updatedAt": "อัพเดทแล้ว", + "createdAt": "ติดตั้งแล้ว", + "configKey": "คีย์", + "configValue": "ค่า", + "allUsers": "อนุญาติผู้ใช้ทั้งหมด", + "selectedUsers": "ผู้ใช้ถูกเลือก", + "allLibraries": "อนุญาติห้องสมุดเพลงทั้งหมด", + "selectedLibraries": "ห้องสมุดเพลงถูกเลือก", + "allowWriteAccess": "" + }, + "sections": { + "status": "สถานะ", + "info": "ข้อมูลปลั๊กอิน", + "configuration": "การตั้งค่า", + "manifest": "แสดง", + "usersPermission": "สิทธิของผู้ใช้", + "libraryPermission": "สิทธิของห้องสมุดเพลง" + }, + "status": { + "enabled": "เปิดใช้งานแล้ว", + "disabled": "ปิดใช้งานแล้ว" + }, + "actions": { + "enable": "เปิดใช้งาน", + "disable": "ปิดใช้งาน", + "disabledDueToError": "แก้ไขข้อผิดพลาดก่อนเปิดใช้งาน", + "disabledUsersRequired": "เลือกผู้ใช้ที่จะเปิดใช้งาน", + "disabledLibrariesRequired": "เลือกห้องสมุดเพลงที่จะเปิดใช้งาน", + "addConfig": "เพิ่มการตั้งค่า", + "rescan": "สแกนซ้ำ" + }, + "notifications": { + "enabled": "เปิดใช้ปลั๊กอินแล้ว", + "disabled": "ปิดใช้ปลั๊กอินแล้ว", + "updated": "ปลั๊กอินอัพเดท", + "error": "อัพเดทผิดพลาด" + }, + "validation": { + "invalidJson": "ต้องตั้งค่าตามไวยากรณ์ JSON" + }, + "messages": { + "configHelp": "ใส่ค่าให้เข้าคู่กับคีย์ของปลั๊กอิน ปล่อยว่างถ้าปลั๊กอินไม่ต้องการใช้", + "clickPermissions": "กดดูรายละเอียดของการอนุญาติ", + "noConfig": "ไม่ได้ตั้งค่า", + "allUsersHelp": "เมื่อเปิดใช้ ปลั๊กอินจะใช้กับผู้ใช้ทุกคน รวมถึงผู้ใช้ใหม่ในอนาคต", + "noUsers": "ไม่ได้เลือกผู้ใช้", + "permissionReason": "เหตุผล", + "usersRequired": "ปลั๊กอินนี้ต้องการเข้าถึงข้อมูลผู้ใช้ เลือกผู้ใช้ที่ต้องการให้ปลั๊กอินเข้าถึงหรือเปิดใช้งานกับผู้ใช้ทั้งหมด", + "allLibrariesHelp": "เมื่อเปิดใช้งาน ปลั๊กอินจะเข้าถึงทุกห้องสมุดเพลง รวมถึงของผู้ใช้ใหม่ในอนาคต", + "noLibraries": "ไม่มีห้องสมุดเพลงถูกเลือก", + "librariesRequired": "ปลั๊กอินนี้ต้องการเข้าถึงข้อมูลห้องสมุดเพลง เลือกห้องสมุดเพลงที่ต้องการให้ปลั๊กอินเข้าถึงหรือเปิดใช้งานกับห้องสมุดเพลงทั้งหมด", + "requiredHosts": "ต้องการ Host", + "configValidationError": "การตั้งค่าเกิดความผิดพลาด", + "schemaRenderError": "ไม่สามารถแสดงหน้าจอการตั้งค่า อาจเกิดจากความผิดพลาดจากปลั๊กอิน", + "allowWriteAccessHelp": "" + }, + "placeholders": { + "configKey": "คีย์", + "configValue": "ค่า" + } } }, "ra": { @@ -375,7 +584,14 @@ "shareSuccess": "คัดลอก URL ไปคลิปบอร์ด: %{url}", "shareFailure": "คัดลอก URL %{url} ไปคลิปบอร์ดผิดพลาด", "downloadDialogTitle": "ดาวโหลด %{resource} '%{name}' (%{size})", - "shareCopyToClipboard": "คัดลอกไปคลิปบอร์ด: Ctrl+C, Enter" + "shareCopyToClipboard": "คัดลอกไปคลิปบอร์ด: Ctrl+C, Enter", + "remove_missing_title": "ลบรายการไฟล์ที่หายไป", + "remove_missing_content": "คุณแน่ใจว่าจะเอารายการไฟล์ที่หายไปออกจากดาต้าเบส นี่จะเป็นการลบข้อมูลอ้างอิงทั้งหมดของไฟล์ออกอย่างถาวร", + "remove_all_missing_title": "เอารายการไฟล์ที่หายไปออกทั้งหมด", + "remove_all_missing_content": "คุณแน่ใจว่าจะเอารายการไฟล์ที่หายไปออกจากดาต้าเบส นี่จะเป็นการลบข้อมูลอ้างอิงทั้งหมดของไฟล์ออกอย่างถาวร", + "noSimilarSongsFound": "ไม่มีเพลงคล้ายกัน", + "noTopSongsFound": "ไม่พบเพลงยอดนิยม", + "startingInstantMix": "กำลังโหลดอินสแตนท์ มิก..." }, "menu": { "library": "ห้องสมุดเพลง", @@ -404,7 +620,13 @@ "albumList": "อัลบั้ม", "about": "เกี่ยวกับ", "playlists": "เพลย์ลิสต์", - "sharedPlaylists": "เพลย์ลิสต์ที่แบ่งปัน" + "sharedPlaylists": "เพลย์ลิสต์ที่แบ่งปัน", + "librarySelector": { + "allLibraries": "ห้องสมุด (%{count}) ห้อง", + "multipleLibraries": "%{selected} ของ %{total} ห้องสมุด", + "selectLibraries": "เลือกห้องสมุด", + "none": "ไม่มี" + } }, "player": { "playListsText": "คิวเล่น", @@ -441,6 +663,22 @@ "disabled": "ปิดการทำงาน", "waiting": "รอ" } + }, + "tabs": { + "about": "เกี่ยวกับ", + "config": "การตั้งค่า" + }, + "config": { + "configName": "ชื่อการตั้งค่า", + "environmentVariable": "ค่าทั่วไป", + "currentValue": "ค่าปัจจุบัน", + "configurationFile": "ไฟล์การตั้งค่า", + "exportToml": "นำออกการตั้งค่า (TOML)", + "exportSuccess": "นำออกการตั้งค่าไปยังคลิปบอร์ดในรูปแบบ TOML แล้ว", + "exportFailed": "คัดลอกการตั้งค่าล้มเหลว", + "devFlagsHeader": "ปักธงการพัฒนา (อาจมีการเปลี่ยน/เอาออก)", + "devFlagsComment": "การตั้งค่านี้อยู่ในช่วงทดลองและอาจจะมีการเอาออกในเวอร์ชั่นหลัง", + "downloadToml": "ดาวน์โหลดการตั้งค่า (TOML)" } }, "activity": { @@ -449,7 +687,11 @@ "quickScan": "สแกนแบบเร็ว", "fullScan": "สแกนทั้งหมด", "serverUptime": "เซิร์ฟเวอร์ออนไลน์นาน", - "serverDown": "ออฟไลน์" + "serverDown": "ออฟไลน์", + "scanType": "ประเภท", + "status": "สแกนผิดพลาด", + "elapsedTime": "เวลาที่ใช้", + "selectiveScan": "เลือก" }, "help": { "title": "คีย์ลัด Navidrome", @@ -464,5 +706,10 @@ "toggle_love": "เพิ่มเพลงนี้ไปยังรายการโปรด", "current_song": "ไปยังเพลงปัจจุบัน" } + }, + "nowPlaying": { + "title": "กำลังเล่น", + "empty": "ไม่มีเพลงเล่น", + "minutesAgo": "%{smart_count} นาทีที่แล้ว |||| %{smart_count} นาทีที่แล้ว" } -} \ No newline at end of file +} diff --git a/resources/i18n/tr.json b/resources/i18n/tr.json index 7c1a82c08..d1fdb2ed4 100644 --- a/resources/i18n/tr.json +++ b/resources/i18n/tr.json @@ -301,14 +301,19 @@ "actions": { "scan": "Kütüphaneyi Tara", "manageUsers": "Kullanıcı Erişimini Yönet", - "viewDetails": "Ayrıntıları Görüntüle" + "viewDetails": "Ayrıntıları Görüntüle", + "quickScan": "Hızlı Tarama", + "fullScan": "Tam Tarama" }, "notifications": { "created": "Kütüphane başarıyla oluşturuldu", "updated": "Kütüphane başarıyla güncellendi", "deleted": "Kütüphane başarıyla silindi", "scanStarted": "Kütüphane taraması başladı", - "scanCompleted": "Kütüphane taraması tamamlandı" + "scanCompleted": "Kütüphane taraması tamamlandı", + "quickScanStarted": "Hızlı tarama başlatıldı", + "fullScanStarted": "Tam tarama başlatıldı", + "scanError": "Tarama başlatılırken hata oluştu. Günlükleri kontrol edin." }, "validation": { "nameRequired": "Kütüphane adı gereklidir", @@ -604,7 +609,8 @@ "serverDown": "ÇEVRİMDIŞI", "scanType": "Tür", "status": "Tarama Hatası", - "elapsedTime": "Geçen Süre" + "elapsedTime": "Geçen Süre", + "selectiveScan": "Seçmeli" }, "help": { "title": "Navidrome Kısayolları", diff --git a/resources/i18n/uk.json b/resources/i18n/uk.json index c500a7457..2c74c890a 100644 --- a/resources/i18n/uk.json +++ b/resources/i18n/uk.json @@ -301,14 +301,19 @@ "actions": { "scan": "Сканувати бібліотеку", "manageUsers": "Керування доступом користувачів", - "viewDetails": "Переглянути подробиці" + "viewDetails": "Переглянути подробиці", + "quickScan": "Швидке сканування", + "fullScan": "Повне сканування" }, "notifications": { "created": "Бібліотеку успішно створено", "updated": "Бібліотеку успішно оновлено", "deleted": "Бібліотеку успішно видалено", "scanStarted": "Сканування бібліотеки розпочато", - "scanCompleted": "Сканування бібліотеки закінчено" + "scanCompleted": "Сканування бібліотеки закінчено", + "quickScanStarted": "Швидке сканування виконується", + "fullScanStarted": "Повне сканування виконується", + "scanError": "Помилка при виконанні сканування. Перевірте лоґи" }, "validation": { "nameRequired": "Ім'я бібліотеки обов'язкове", @@ -604,7 +609,8 @@ "serverDown": "Оффлайн", "scanType": "Тип", "status": "Помилка сканування", - "elapsedTime": "Пройдений час" + "elapsedTime": "Пройдений час", + "selectiveScan": "Вибірковий" }, "help": { "title": "Гарячі клавіші Navidrome", diff --git a/resources/i18n/zh-Hans.json b/resources/i18n/zh-Hans.json index cde28c4f3..e26c2b664 100644 --- a/resources/i18n/zh-Hans.json +++ b/resources/i18n/zh-Hans.json @@ -1,630 +1,713 @@ { - "languageName": "简体中文", - "resources": { - "song": { - "name": "歌曲", - "fields": { - "albumArtist": "专辑歌手", - "duration": "时长", - "trackNumber": "歌曲序号", - "playCount": "播放次数", - "title": "曲名", - "artist": "歌手", - "album": "专辑", - "path": "文件路径", - "genre": "流派", - "libraryName": "媒体库", - "compilation": "合辑", - "year": "发行年份", - "size": "文件大小", - "updatedAt": "更新于", - "bitRate": "比特率", - "bitDepth": "比特深度", - "sampleRate": "采样率", - "channels": "声道", - "discSubtitle": "字幕", - "starred": "收藏", - "comment": "注释", - "rating": "评分", - "quality": "品质", - "bpm": "BPM", - "playDate": "最后一次播放", - "createdAt": "创建于", - "grouping": "分组", - "mood": "情绪", - "participants": "其他参与人员", - "tags": "附加标签", - "mappedTags": "映射标签", - "rawTags": "原始标签", - "missing": "缺失" - }, - "actions": { - "addToQueue": "加入播放列表", - "playNow": "立即播放", - "addToPlaylist": "加入歌单", - "showInPlaylist": "定位到播放列表", - "shuffleAll": "全部随机播放", - "download": "下载", - "playNext": "下一首播放", - "info": "查看信息" - } - }, - "album": { - "name": "专辑", - "fields": { - "albumArtist": "专辑歌手", - "artist": "歌手", - "duration": "时长", - "songCount": "歌曲数量", - "playCount": "播放次数", - "size": "文件大小", - "name": "名称", - "genre": "流派", - "libraryName": "媒体库", - "compilation": "合辑", - "year": "发行年份", - "date": "录制日期", - "originalDate": "原始日期", - "releaseDate": "发⾏日期", - "releases": "发⾏", - "released": "已发⾏", - "updatedAt": "更新于", - "comment": "注释", - "rating": "评分", - "createdAt": "创建于", - "recordLabel": "厂牌", - "catalogNum": "目录编号", - "releaseType": "发行类型", - "grouping": "分组", - "media": "媒体类型", - "mood": "情绪", - "missing": "缺失" - }, - "actions": { - "playAll": "立即播放", - "playNext": "下首播放", - "addToQueue": "加入播放列表", - "share": "分享", - "shuffle": "随机播放", - "addToPlaylist": "加入歌单", - "download": "下载", - "info": "查看信息" - }, - "lists": { - "all": "所有", - "random": "随机", - "recentlyAdded": "最近添加", - "recentlyPlayed": "最近播放", - "mostPlayed": "最多播放", - "starred": "收藏", - "topRated": "评分排行" - } - }, - "artist": { - "name": "艺术家", - "fields": { - "name": "名称", - "albumCount": "专辑数", - "songCount": "歌曲数", - "size": "文件大小", - "playCount": "播放次数", - "rating": "评分", - "genre": "流派", - "role": "参与角色", - "missing": "缺失" - }, - "roles": { - "albumartist": "专辑歌手", - "artist": "歌手", - "composer": "作曲", - "conductor": "指挥", - "lyricist": "作词", - "arranger": "编曲", - "producer": "制作人", - "director": "总监", - "engineer": "工程师", - "mixer": "混音师", - "remixer": "重混师", - "djmixer": "DJ混音师", - "performer": "演奏家", - "maincredit": "主要艺术家" - }, - "actions": { - "topSongs": "热门歌曲", - "shuffle": "随机播放", - "radio": "电台" - } - }, - "user": { - "name": "用户", - "fields": { - "userName": "用户名", - "isAdmin": "是否管理员", - "lastLoginAt": "上次登录", - "lastAccessAt": "上次访问", - "updatedAt": "更新于", - "name": "名称", - "password": "密码", - "createdAt": "创建于", - "changePassword": "修改密码？", - "currentPassword": "当前密码", - "newPassword": "新密码", - "token": "令牌", - "libraries": "媒体库" - }, - "helperTexts": { - "name": "名称的更改将在下次登录时生效", - "libraries": "为该用户选择指定媒体库，留空则使用默认媒体库" - }, - "notifications": { - "created": "用户已创建", - "updated": "用户已更新", - "deleted": "用户已删除" - }, - "validation": { - "librariesRequired": "普通用户必须至少选择一个媒体库" - }, - "message": { - "listenBrainzToken": "输入您的 ListenBrainz 用户令牌", - "clickHereForToken": "点击这里来获得你的 ListenBrainz 令牌", - "selectAllLibraries": "选择全部媒体库", - "adminAutoLibraries": "管理员默认可访问所有媒体库" - } - }, - "player": { - "name": "客户端", - "fields": { - "name": "名称", - "transcodingId": "转码编号", - "maxBitRate": "最大比特率", - "client": "客户端", - "userName": "用户名", - "lastSeen": "上次浏览", - "reportRealPath": "回报实际路径", - "scrobbleEnabled": "发送喜好记录到外部服务" - } - }, - "transcoding": { - "name": "转码", - "fields": { - "name": "名称", - "targetFormat": "目标格式", - "defaultBitRate": "默认比特率", - "command": "命令" - } - }, - "playlist": { - "name": "歌单", - "fields": { - "name": "名称", - "duration": "时长", - "ownerName": "所有者", - "public": "公开", - "updatedAt": "更新于", - "createdAt": "创建于", - "songCount": "歌曲数", - "comment": "注释", - "sync": "自动导入", - "path": "导入" - }, - "actions": { - "selectPlaylist": "选择歌单", - "addNewPlaylist": "新建 %{name}", - "export": "导出", - "saveQueue": "保存为歌单", - "makePublic": "设为公开", - "makePrivate": "设为私有", - "searchOrCreate": "搜索歌单，或输入名称新建…", - "pressEnterToCreate": "按 Enter 键新建歌单", - "removeFromSelection": "移除选中项" - }, - "message": { - "duplicate_song": "添加重复的歌曲", - "song_exist": "部分选定的歌曲已存在歌单中，继续添加或是跳过它们？", - "noPlaylistsFound": "未找到歌单", - "noPlaylists": "暂无可用歌单" - } - }, - "radio": { - "name": "电台", - "fields": { - "name": "名称", - "streamUrl": "推流地址", - "homePageUrl": "首页链接", - "updatedAt": "更新于", - "createdAt": "创建于" - }, - "actions": { - "playNow": "开始播放" - } - }, - "share": { - "name": "分享", - "fields": { - "username": "分享者", - "url": "链接", - "description": "描述", - "downloadable": "是否允许下载？", - "contents": "目录", - "expiresAt": "过期于", - "lastVisitedAt": "上次访问于", - "visitCount": "访问数", - "format": "格式", - "maxBitRate": "最大比特率", - "updatedAt": "更新于", - "createdAt": "创建于" - }, - "notifications": {}, - "actions": {} - }, - "missing": { - "name": "丢失文件", - "empty": "无丢失文件", - "fields": { - "path": "路径", - "size": "文件大小", - "libraryName": "媒体库", - "updatedAt": "丢失于" - }, - "actions": { - "remove": "移除", - "remove_all": "移除所有" - }, - "notifications": { - "removed": "丢失文件已移除" - } - }, - "library": { - "name": "媒体库", - "fields": { - "name": "名称", - "path": "路径", - "remotePath": "远程路径", - "lastScanAt": "上次扫描", - "songCount": "歌曲", - "albumCount": "专辑", - "artistCount": "艺术家", - "totalSongs": "歌曲", - "totalAlbums": "专辑", - "totalArtists": "艺术家", - "totalFolders": "目录", - "totalFiles": "文件", - "totalMissingFiles": "缺失的文件", - "totalSize": "总大小", - "totalDuration": "时长", - "defaultNewUsers": "新用户默认", - "createdAt": "创建于", - "updatedAt": "更新于" - }, - "sections": { - "basic": "基本信息", - "statistics": "统计数据" - }, - "actions": { - "scan": "扫描媒体库", - "manageUsers": "管理用户权限", - "viewDetails": "查看详情" - }, - "notifications": { - "created": "媒体库已创建", - "updated": "媒体库已更新", - "deleted": "媒体库已删除", - "scanStarted": "开始扫描媒体库", - "scanCompleted": "媒体库扫描已完成" - }, - "validation": { - "nameRequired": "媒体库名称不能为空！", - "pathRequired": "媒体库路径不能为空！", - "pathNotDirectory": "媒体库路径必须为目录！", - "pathNotFound": "媒体库路径不存在！", - "pathNotAccessible": "媒体库路径无法访问！", - "pathInvalid": "媒体库路径无效！" - }, - "messages": { - "deleteConfirm": "您确定要删除此媒体库吗？此操作将删除所有关联数据及用户访问权限！", - "scanInProgress": "正在扫描...", - "noLibrariesAssigned": "该用户未分配任何媒体库！" - } - } + "languageName": "简体中文", + "resources": { + "song": { + "name": "歌曲", + "fields": { + "albumArtist": "专辑艺人", + "duration": "时长", + "trackNumber": "音轨号", + "playCount": "播放次数", + "title": "标题", + "artist": "艺人", + "composer": "作曲者", + "album": "专辑", + "path": "文件路径", + "genre": "流派", + "libraryName": "媒体库", + "compilation": "合辑", + "year": "发行年份", + "size": "文件大小", + "updatedAt": "更新于", + "bitRate": "比特率", + "bitDepth": "位深度", + "sampleRate": "采样率", + "channels": "声道", + "discSubtitle": "碟片副标题", + "starred": "收藏", + "comment": "注释", + "rating": "评分", + "quality": "品质", + "bpm": "BPM", + "playDate": "最后一次播放", + "createdAt": "加入日期", + "grouping": "分组", + "mood": "情绪", + "participants": "其他参与人员", + "tags": "附加标签", + "mappedTags": "映射标签", + "rawTags": "原始标签", + "missing": "丢失" + }, + "actions": { + "addToQueue": "添加到播放队列", + "playNow": "立即播放", + "addToPlaylist": "添加到歌单", + "showInPlaylist": "在歌单中显示", + "shuffleAll": "全部随机播放", + "download": "下载", + "playNext": "下一首播放", + "info": "查看信息", + "instantMix": "即兴推荐" + } }, - "ra": { - "auth": { - "welcome1": "感谢您安装 Navidrome！", - "welcome2": "开始使用前，请创建一个管理员账户", - "confirmPassword": "确认密码", - "buttonCreateAdmin": "创建管理员", - "auth_check_error": "请登录访问更多内容", - "user_menu": "配置", - "username": "用户名", - "password": "密码", - "sign_in": "登录", - "sign_in_error": "验证失败，请重试", - "logout": "注销", - "insightsCollectionNote": "Navidrome 会收集匿名使用数据以协助改进项目。\n点击[此处]了解详情或选择退出。" - }, - "validation": { - "invalidChars": "请使用字母和数字", - "passwordDoesNotMatch": "密码不匹配", - "required": "必填", - "minLength": "必须不少于 %{min} 个字符", - "maxLength": "必须不多于 %{max} 个字符", - "minValue": "必须不小于 %{min}", - "maxValue": "必须不大于 %{max}", - "number": "必须为数字", - "email": "必须是有效的电子邮箱", - "oneOf": "必须为: %{options} 其中一项", - "regex": "必须符合指定的格式（正则表达式）：%{pattern}", - "unique": "必须唯一", - "url": "必须是有效的链接" - }, - "action": { - "add_filter": "添加筛选", - "add": "添加", - "back": "返回", - "bulk_actions": "选中 %{smart_count} 项", - "bulk_actions_mobile": "%{smart_count}", - "cancel": "取消", - "clear_input_value": "清除", - "clone": "复制", - "confirm": "确认", - "create": "新建", - "delete": "删除", - "edit": "编辑", - "export": "导出", - "list": "列表", - "refresh": "刷新", - "remove_filter": "取消筛选", - "remove": "删除", - "save": "保存", - "search": "搜索", - "show": "显示", - "sort": "排序", - "undo": "撤销", - "expand": "展开", - "close": "关闭", - "open_menu": "打开菜单", - "close_menu": "关闭菜单", - "unselect": "未选择", - "skip": "跳过", - "share": "分享", - "download": "下载" - }, - "boolean": { - "true": "是", - "false": "否" - }, - "page": { - "create": "新建 %{name}", - "dashboard": "仪表盘", - "edit": "%{name} #%{id}", - "error": "发生错误", - "list": "%{name}", - "loading": "加载中", - "not_found": "未找到", - "show": "%{name} #%{id}", - "empty": "还没有 %{name}。", - "invite": "您要创建一个吗？" - }, - "input": { - "file": { - "upload_several": "拖拽多个文件上传或点击选择一个", - "upload_single": "拖拽单个文件上传或点击选择一个" - }, - "image": { - "upload_several": "拖拽多个图片上传或点击选择一个", - "upload_single": "拖拽单个图片上传或点击选择一个" - }, - "references": { - "all_missing": "未找到参考数据", - "many_missing": "至少有一条参考数据不再可用", - "single_missing": "关联的参考数据不再可用" - }, - "password": { - "toggle_visible": "隐藏密码", - "toggle_hidden": "显示密码" - } - }, - "message": { - "about": "关于", - "are_you_sure": "您确定要进行此操作？", - "bulk_delete_content": "您确定要删除 %{smart_count} 项 %{name}？", - "bulk_delete_title": "删除 %{smart_count} 项 %{name}", - "delete_content": "您确定要删除该条目？", - "delete_title": "删除 %{name} #%{id}", - "details": "详情", - "error": "发生一个客户端错误，您的请求无法完成", - "invalid_form": "提交内容无效，请检查错误", - "loading": "正在加载页面，请稍候", - "no": "否", - "not_found": "您输入的链接格式不对或链接丢失", - "yes": "是", - "unsaved_changes": "某些更改尚未保存，您确定要离开此页面吗？" - }, - "navigation": { - "no_results": "无内容", - "no_more_results": "页码 %{page} 超出范围，尝试返回上一页", - "page_out_of_boundaries": "页码 %{page} 超出范围", - "page_out_from_end": "已经最后一页", - "page_out_from_begin": "已经是第一页", - "page_range_info": "%{offsetBegin}-%{offsetEnd} / %{total}", - "page_rows_per_page": "每页行数：", - "next": "下一页", - "prev": "上一页", - "skip_nav": "跳过" - }, - "notification": { - "updated": "已更新 %{smart_count} 项", - "created": "已新建 1 项", - "deleted": "已删除 %{smart_count} 项", - "bad_item": "不正确的项", - "item_doesnt_exist": "该项不存在", - "http_error": "与服务通信出错", - "data_provider_error": "数据来源错误，请检查控制台的详细信息", - "i18n_error": "加载所选语言时出错", - "canceled": "操作已取消", - "logged_out": "您的会话已结束，请重新登录", - "new_version": "发现新版本！请刷新此页面" - }, - "toggleFieldsMenu": { - "columnsToDisplay": "显示的项", - "layout": "布局", - "grid": "网格", - "table": "表格" - } + "album": { + "name": "专辑", + "fields": { + "albumArtist": "专辑艺人", + "artist": "艺人", + "duration": "时长", + "songCount": "歌曲数", + "playCount": "播放次数", + "size": "文件大小", + "name": "名称", + "genre": "流派", + "libraryName": "媒体库", + "compilation": "合辑", + "year": "发行年份", + "date": "录制日期", + "originalDate": "原始日期", + "releaseDate": "发⾏日期", + "releases": "发行版本", + "released": "已发⾏", + "updatedAt": "更新于", + "comment": "注释", + "rating": "评分", + "createdAt": "加入日期", + "recordLabel": "厂牌", + "catalogNum": "目录编号", + "releaseType": "发行类型", + "grouping": "分组", + "media": "发行媒介", + "mood": "情绪", + "missing": "丢失" + }, + "actions": { + "playAll": "立即播放", + "playNext": "下一首播放", + "addToQueue": "添加到播放队列", + "share": "分享", + "shuffle": "随机播放", + "addToPlaylist": "添加到歌单", + "download": "下载", + "info": "查看信息" + }, + "lists": { + "all": "全部", + "random": "随机", + "recentlyAdded": "最近加入", + "recentlyPlayed": "最近播放", + "mostPlayed": "最多播放", + "starred": "收藏", + "topRated": "评分榜单" + } }, - "message": { - "note": "说明", - "transcodingDisabled": "出于安全原因，从 Web 界面更改转码配置的功能已被禁用。要更改（编辑或新增）转码选项，请在启用 %{config} 选项的情况下重新启动服务器。", - "transcodingEnabled": "Navidrome 当前与 %{config} 一起使用，可以通过配置转码选项来执行任意命令，建议仅在配置转码选项时启用此功能。", - "songsAddedToPlaylist": "已添加 %{smart_count} 首歌到歌单", - "noSimilarSongsFound": "未找到相似歌曲", - "noTopSongsFound": "未找到热门歌曲", - "noPlaylistsAvailable": "没有有效的歌单", - "delete_user_title": "删除用户 %{name}", - "delete_user_content": "您确定要删除该用户及其相关数据（包括歌单和用户配置）吗？", - "remove_missing_title": "移除丢失文件", - "remove_missing_content": "您确定要将选中的丢失文件从数据库中永久移除吗？此操作将删除所有相关信息，包括播放次数和评分。", - "remove_all_missing_title": "删除所有丢失文件", - "remove_all_missing_content": "您确定要从数据库中删除所有丢失文件吗？这将永久删除对它们的所有引用，包括它们的播放次数和评分。", - "notifications_blocked": "您已在浏览器的设置中屏蔽了此网站的通知", - "notifications_not_available": "此浏览器不支持桌面通知", - "lastfmLinkSuccess": "Last.fm 已关联并启用喜好记录", - "lastfmLinkFailure": "Last.fm 无法关联", - "lastfmUnlinkSuccess": "已成功解除与 Last.fm 的链接，且喜好记录已禁用", - "lastfmUnlinkFailure": "Last.fm 无法取消关联", - "listenBrainzLinkSuccess": "ListenBrainz 已关联并启用喜好记录", - "listenBrainzLinkFailure": "ListenBrainz 无法关联：%{error}", - "listenBrainzUnlinkSuccess": "已成功解除与 ListenBrainz 的链接，且喜好记录已禁用", - "listenBrainzUnlinkFailure": "ListenBrainz 无法取消关联", - "openIn": { - "lastfm": "在 Last.fm 中打开", - "musicbrainz": "在 MusicBrainz 中打开" - }, - "lastfmLink": "查看更多…", - "shareOriginalFormat": "分享原始格式", - "shareDialogTitle": "分享 %{resource} '%{name}'", - "shareBatchDialogTitle": "分享 %{smart_count} 个 %{resource}", - "shareCopyToClipboard": "复制到剪切板: Ctrl+C, Enter", - "shareSuccess": "分享链接已复制: %{url}", - "shareFailure": "分享链接复制失败: %{url}", - "downloadDialogTitle": "下载 %{resource} '%{name}' (%{size})", - "downloadOriginalFormat": "下载原始格式" + "artist": { + "name": "艺人", + "fields": { + "name": "名称", + "albumCount": "专辑数", + "songCount": "歌曲数", + "size": "文件大小", + "playCount": "播放次数", + "rating": "评分", + "genre": "流派", + "role": "参与角色", + "missing": "丢失" + }, + "roles": { + "albumartist": "专辑艺人", + "artist": "艺人", + "composer": "作曲者", + "conductor": "指挥家", + "lyricist": "作词者", + "arranger": "编曲者", + "producer": "制作人", + "director": "总监", + "engineer": "工程师", + "mixer": "混音师", + "remixer": "重混师", + "djmixer": "DJ混音师", + "performer": "演奏家", + "maincredit": "专辑艺人或艺人" + }, + "actions": { + "topSongs": "热门歌曲", + "shuffle": "随机播放", + "radio": "电台" + } }, - "menu": { - "library": "曲库", - "librarySelector": { - "allLibraries": "全部媒体库 (%{count})", - "multipleLibraries": "已选 %{selected} 共 %{total} 媒体库", - "selectLibraries": "选择媒体库", - "none": "无" - }, - "settings": "设置", - "version": "版本", - "theme": "主题", - "personal": { - "name": "个性化", - "options": { - "theme": "主题", - "language": "语言", - "defaultView": "默认界面", - "desktop_notifications": "桌面通知", - "lastfmNotConfigured": "没有配置 Last.fm 的 API-Key", - "lastfmScrobbling": "启用 Last.fm 的喜好记录", - "listenBrainzScrobbling": "启用 ListenBrainz 的喜好记录", - "replaygain": "回放增益", - "preAmp": "前置放大器 (dB)", - "gain": { - "none": "禁用增益", - "album": "使用专辑增益信息", - "track": "使用歌曲增益信息" - } - } - }, - "albumList": "专辑", - "playlists": "歌单", - "sharedPlaylists": "共享的歌单", - "about": "关于" + "user": { + "name": "用户", + "fields": { + "userName": "用户名", + "isAdmin": "是否管理员", + "lastLoginAt": "上次登录", + "lastAccessAt": "上次访问", + "updatedAt": "更新于", + "name": "名称", + "password": "密码", + "createdAt": "创建于", + "changePassword": "修改密码？", + "currentPassword": "当前密码", + "newPassword": "新密码", + "token": "令牌", + "libraries": "媒体库" + }, + "helperTexts": { + "name": "名称的更改将在下次登录时生效", + "libraries": "为此用户选择指定媒体库，留空则使用默认媒体库" + }, + "notifications": { + "created": "用户已创建", + "updated": "用户已更新", + "deleted": "用户已删除" + }, + "validation": { + "librariesRequired": "至少为非管理员用户选择一个媒体库" + }, + "message": { + "listenBrainzToken": "输入您的 ListenBrainz 用户令牌", + "clickHereForToken": "点此获得您的令牌", + "selectAllLibraries": "选择全部媒体库", + "adminAutoLibraries": "管理员用户自动拥有所有媒体库的访问权限" + } }, "player": { - "playListsText": "播放列表", - "openText": "打开", - "closeText": "关闭", - "notContentText": "没有音乐", - "clickToPlayText": "点击播放", - "clickToPauseText": "点击暂停", - "nextTrackText": "下一首", - "previousTrackText": "上一首", - "reloadText": "重新播放", - "volumeText": "音量", - "toggleLyricText": "切换歌词", - "toggleMiniModeText": "最小化", - "destroyText": "关闭", - "downloadText": "下载", - "removeAudioListsText": "清空播放列表", - "clickToDeleteText": "点击删除 %{name}", - "emptyLyricText": "无歌词", - "playModeText": { - "order": "顺序播放", - "orderLoop": "列表循环", - "singleLoop": "单曲循环", - "shufflePlay": "随机播放" - } + "name": "播放器", + "fields": { + "name": "名称", + "transcodingId": "转码", + "maxBitRate": "最大比特率", + "client": "客户端", + "userName": "用户名", + "lastSeen": "上次浏览", + "reportRealPath": "报告真实路径", + "scrobbleEnabled": "发送个性化记录到外部服务" + } }, - "about": { - "links": { - "homepage": "主页", - "source": "源代码", - "featureRequests": "功能需求", - "lastInsightsCollection": " 最近的分析收集", - "insights": { - "disabled": "禁用", - "waiting": "等待" - } - }, - "tabs": { - "about": "关于", - "config": "配置" - }, - "config": { - "configName": "配置名称", - "environmentVariable": "环境变量", - "currentValue": "当前值", - "configurationFile": "配置文件", - "exportToml": "导出配置（TOML）", - "exportSuccess": "配置以 TOML 格式导出到剪贴板", - "exportFailed": "复制配置失败", - "devFlagsHeader": "开发标志（可能会更改/删除）", - "devFlagsComment": "这些是实验性设置，可能会在未来版本中删除" - } + "transcoding": { + "name": "转码", + "fields": { + "name": "名称", + "targetFormat": "目标格式", + "defaultBitRate": "默认比特率", + "command": "命令" + } }, - "activity": { - "title": "运行情况", - "totalScanned": "已完成扫描的目录", + "playlist": { + "name": "歌单", + "fields": { + "name": "名称", + "duration": "时长", + "ownerName": "所有者", + "public": "公开", + "updatedAt": "更新于", + "createdAt": "创建于", + "songCount": "歌曲数", + "comment": "注释", + "sync": "自动导入", + "path": "导入路径" + }, + "actions": { + "selectPlaylist": "选择歌单", + "addNewPlaylist": "创建%{name}", + "export": "导出", + "saveQueue": "保存为歌单", + "makePublic": "设为公开", + "makePrivate": "设为私有", + "searchOrCreate": "搜索歌单，或输入名称以创建…", + "pressEnterToCreate": "按 Enter 键创建歌单", + "removeFromSelection": "移除选中项" + }, + "message": { + "duplicate_song": "添加了重复的歌曲", + "song_exist": "部分选定的歌曲已存在歌单中，继续添加或是跳过它们？", + "noPlaylistsFound": "未找到歌单", + "noPlaylists": "暂无可用歌单" + } + }, + "radio": { + "name": "电台", + "fields": { + "name": "名称", + "streamUrl": "推流 URL", + "homePageUrl": "首页 URL", + "updatedAt": "更新于", + "createdAt": "创建于" + }, + "actions": { + "playNow": "开始播放" + } + }, + "share": { + "name": "分享", + "fields": { + "username": "分享者", + "url": "URL", + "description": "描述", + "downloadable": "是否允许下载？", + "contents": "目录", + "expiresAt": "过期于", + "lastVisitedAt": "上次访问", + "visitCount": "访问数", + "format": "格式", + "maxBitRate": "最大比特率", + "updatedAt": "更新于", + "createdAt": "创建于" + }, + "notifications": {}, + "actions": {} + }, + "missing": { + "name": "丢失文件", + "empty": "无丢失文件", + "fields": { + "path": "路径", + "size": "文件大小", + "libraryName": "媒体库", + "updatedAt": "丢失于" + }, + "actions": { + "remove": "移除", + "remove_all": "移除所有" + }, + "notifications": { + "removed": "丢失文件已移除" + } + }, + "library": { + "name": "媒体库", + "fields": { + "name": "名称", + "path": "路径", + "remotePath": "远程路径", + "lastScanAt": "上次扫描", + "songCount": "歌曲数", + "albumCount": "专辑数", + "artistCount": "艺人数", + "totalSongs": "歌曲数", + "totalAlbums": "专辑数", + "totalArtists": "艺人数", + "totalFolders": "目录数", + "totalFiles": "文件数", + "totalMissingFiles": "丢失的文件数", + "totalSize": "总大小", + "totalDuration": "时长", + "defaultNewUsers": "新用户默认", + "createdAt": "创建于", + "updatedAt": "更新于" + }, + "sections": { + "basic": "基本信息", + "statistics": "统计数据" + }, + "actions": { + "scan": "扫描媒体库", "quickScan": "快速扫描", "fullScan": "完全扫描", - "serverUptime": "服务器已运行", - "serverDown": "服务器已离线", - "scanType": "扫描类型", - "status": "扫描状态", - "elapsedTime": "用时" + "manageUsers": "管理用户权限", + "viewDetails": "查看详情" + }, + "notifications": { + "created": "媒体库创建成功", + "updated": "媒体库更新成功", + "deleted": "媒体库删除成功", + "scanStarted": "媒体库扫描已开始", + "quickScanStarted": "快速扫描已开始", + "fullScanStarted": "完全扫描已开始", + "scanError": "开始扫描时出错，请检查日志", + "scanCompleted": "媒体库扫描已完成" + }, + "validation": { + "nameRequired": "媒体库名称不能为空", + "pathRequired": "媒体库路径不能为空", + "pathNotDirectory": "媒体库路径必须为目录", + "pathNotFound": "媒体库路径未找到", + "pathNotAccessible": "媒体库路径无法访问", + "pathInvalid": "媒体库路径无效" + }, + "messages": { + "deleteConfirm": "您确定要删除此媒体库吗？这将删除所有关联数据及用户访问权限。", + "scanInProgress": "正在扫描...", + "noLibrariesAssigned": "未向此用户分配媒体库" + } }, - "nowPlaying": { - "title": "正在播放", - "empty": "无播放内容", - "minutesAgo": "%{smart_count} 分钟前" - }, - "help": { - "title": "Navidrome 快捷键", - "hotkeys": { - "show_help": "显示此帮助", - "toggle_menu": "显示/隐藏菜单侧栏", - "toggle_play": "播放/暂停", - "prev_song": "上一首歌", - "next_song": "下一首歌", - "current_song": "转到当前播放", - "vol_up": "增大音量", - "vol_down": "减小音量", - "toggle_love": "添加/移除星标" - } + "plugin": { + "name": "插件", + "fields": { + "id": "ID", + "name": "名称", + "description": "描述", + "version": "版本", + "author": "作者", + "website": "网页", + "permissions": "权限", + "enabled": "已启用", + "status": "状态", + "path": "路径", + "lastError": "错误", + "hasError": "错误", + "updatedAt": "更新于", + "createdAt": "安装于", + "configKey": "键", + "configValue": "值", + "allUsers": "允许所有用户", + "selectedUsers": "指定用户", + "allLibraries": "允许所有媒体库", + "selectedLibraries": "指定媒体库" + }, + "sections": { + "status": "状态", + "info": "插件信息", + "configuration": "配置", + "manifest": "清单", + "usersPermission": "用户权限", + "libraryPermission": "媒体库权限" + }, + "status": { + "enabled": "已启用", + "disabled": "已禁用" + }, + "actions": { + "enable": "启用", + "disable": "禁用", + "disabledDueToError": "需要在启用前解决错误", + "disabledUsersRequired": "需要在启用前选择用户", + "disabledLibrariesRequired": "需要在启用前选择媒体库", + "addConfig": "添加配置", + "rescan": "重新扫描" + }, + "notifications": { + "enabled": "插件已启用", + "disabled": "插件已禁用", + "updated": "插件已更新", + "error": "插件更新时出错" + }, + "validation": { + "invalidJson": "配置必须是有效的 JSON" + }, + "messages": { + "configHelp": "使用键值对配置插件。如果插件无需配置则留空。", + "configValidationError": "配置验证失败：", + "schemaRenderError": "无法渲染配置表单。此插件的 schema 定义可能无效。", + "clickPermissions": "点击权限以查看详情", + "noConfig": "未设定配置", + "allUsersHelp": "启用时，插件将可以访问所有用户，包括将来创建的。", + "noUsers": "未选择用户", + "permissionReason": "原因", + "usersRequired": "此插件需要访问用户信息。请选择允许此插件访问的用户, 或启用 '允许所有用户'。", + "allLibrariesHelp": "启用时，插件将可以访问所有媒体库，包括将来创建的。", + "noLibraries": "未选择媒体库", + "librariesRequired": "此插件需要访问媒体库信息。请选择允许此插件访问的媒体库, 或启用 '允许所有媒体库'。", + "requiredHosts": "必需的主机" + }, + "placeholders": { + "configKey": "键", + "configValue": "值" + } } + }, + "ra": { + "auth": { + "welcome1": "感谢您安装 Navidrome！", + "welcome2": "开始使用前，请创建一个管理员账户", + "confirmPassword": "确认密码", + "buttonCreateAdmin": "创建管理员", + "auth_check_error": "请登录以继续", + "user_menu": "用户档案", + "username": "用户名", + "password": "密码", + "sign_in": "登录", + "sign_in_error": "验证失败，请重试", + "logout": "注销", + "insightsCollectionNote": "Navidrome 会收集匿名使用数据以帮助改进项目。\n点击[此处]了解详情或选择不参与收集。" + }, + "validation": { + "invalidChars": "请只使用字母和数字", + "passwordDoesNotMatch": "密码不匹配", + "required": "必填", + "minLength": "不得少于 %{min} 个字符", + "maxLength": "不得多于 %{max} 个字符", + "minValue": "不得小于 %{min}", + "maxValue": "不得大于 %{max}", + "number": "必须为数字", + "email": "必须为有效的电子邮箱", + "oneOf": "必须为: %{options} 其中一项", + "regex": "必须符合指定的格式（正则表达式）：%{pattern}", + "unique": "必须唯一", + "url": "必须为有效的 URL" + }, + "action": { + "add_filter": "添加筛选", + "add": "添加", + "back": "返回", + "bulk_actions": "选中 %{smart_count} 项", + "bulk_actions_mobile": "%{smart_count}", + "cancel": "取消", + "clear_input_value": "清除", + "clone": "复制", + "confirm": "确认", + "create": "创建", + "delete": "删除", + "edit": "编辑", + "export": "导出", + "list": "列表", + "refresh": "刷新", + "remove_filter": "取消筛选", + "remove": "移除", + "save": "保存", + "search": "搜索", + "show": "显示", + "sort": "排序", + "undo": "撤销", + "expand": "展开", + "close": "关闭", + "open_menu": "打开菜单", + "close_menu": "关闭菜单", + "unselect": "取消选择", + "skip": "跳过", + "share": "分享", + "download": "下载" + }, + "boolean": { + "true": "是", + "false": "否" + }, + "page": { + "create": "创建%{name}", + "dashboard": "仪表盘", + "edit": "%{name} #%{id}", + "error": "发生错误", + "list": "%{name}", + "loading": "加载中", + "not_found": "未找到", + "show": "%{name} #%{id}", + "empty": "还没有%{name}。", + "invite": "您要创建一个吗？" + }, + "input": { + "file": { + "upload_several": "拖拽多个文件上传或点击以选择", + "upload_single": "拖拽文件上传或点击以选择" + }, + "image": { + "upload_several": "拖拽多个图片上传或点击以选择", + "upload_single": "拖拽图片上传或点击以选择" + }, + "references": { + "all_missing": "未找到引用数据", + "many_missing": "至少有一条关联的引用不再可用", + "single_missing": "关联的引用不再可用" + }, + "password": { + "toggle_visible": "隐藏密码", + "toggle_hidden": "显示密码" + } + }, + "message": { + "about": "关于", + "are_you_sure": "您确定要进行此操作？", + "bulk_delete_content": "您确定要删除这 %{smart_count} 项%{name}？", + "bulk_delete_title": "删除 %{smart_count} 项%{name}", + "delete_content": "您确定要删除此项？", + "delete_title": "删除 %{name} #%{id}", + "details": "详情", + "error": "发生一个客户端错误，您的请求无法完成", + "invalid_form": "提交内容无效，请检查错误", + "loading": "页面加载中，请稍候", + "no": "否", + "not_found": "您输入了错误的 URL，或 URL 无效", + "yes": "是", + "unsaved_changes": "某些更改尚未保存，您确定要忽视吗？" + }, + "navigation": { + "no_results": "未找到结果", + "no_more_results": "页码 %{page} 超出范围，尝试返回上一页", + "page_out_of_boundaries": "页码 %{page} 超出范围", + "page_out_from_end": "已经最后一页", + "page_out_from_begin": "已经是第一页", + "page_range_info": "%{offsetBegin}-%{offsetEnd} / %{total}", + "page_rows_per_page": "每页项目数：", + "next": "下一页", + "prev": "上一页", + "skip_nav": "跳转到内容" + }, + "notification": { + "updated": "项目已更新 |||| 已更新 %{smart_count} 项", + "created": "项目已创建", + "deleted": "项目已删除 |||| 已删除 %{smart_count} 项", + "bad_item": "不正确的项", + "item_doesnt_exist": "项目不存在", + "http_error": "与服务器通信出错", + "data_provider_error": "dataProvider 错误，请检查控制台以查看详情。", + "i18n_error": "加载所选语言时出错", + "canceled": "操作已取消", + "logged_out": "您的会话已结束，请重新登录。", + "new_version": "发现新版本！请刷新此页面。" + }, + "toggleFieldsMenu": { + "columnsToDisplay": "显示的列", + "layout": "布局", + "grid": "网格", + "table": "表格" + } + }, + "message": { + "note": "注意", + "transcodingDisabled": "出于安全原因，从 Web 界面更改转码配置的功能已被禁用。要更改（编辑或新增）转码选项，请在启用 %{config} 选项的情况下重新启动服务器。", + "transcodingEnabled": "Navidrome 当前与 %{config} 一起使用，可以通过从 Web 界面配置转码选项来执行任意命令。建议禁用此选项，并且仅在需要配置转码选项时启用此功能。", + "songsAddedToPlaylist": "已添加 %{smart_count} 首歌到歌单", + "noSimilarSongsFound": "未找到相似歌曲", + "startingInstantMix": "即兴推荐加载中...", + "noTopSongsFound": "未找到热门歌曲", + "noPlaylistsAvailable": "没有有效的歌单", + "delete_user_title": "删除用户%{name}", + "delete_user_content": "您确定要删除此用户及其相关数据（包括歌单和用户配置）吗？", + "remove_missing_title": "移除丢失文件", + "remove_missing_content": "您确定要从数据库中移除选中的丢失文件吗？这将永久删除对它们的所有引用，包括播放次数和评分。", + "remove_all_missing_title": "移除所有丢失文件", + "remove_all_missing_content": "您确定要从数据库中移除所有丢失文件吗？这将永久删除对它们的所有引用，包括播放次数和评分。", + "notifications_blocked": "您已在浏览器的设置中屏蔽了此网站的通知", + "notifications_not_available": "此浏览器不支持桌面通知，或者您未通过 https 访问 Navidrome", + "lastfmLinkSuccess": "Last.fm 成功关联并启用个性化记录", + "lastfmLinkFailure": "Last.fm 无法关联", + "lastfmUnlinkSuccess": "Last.fm 已取消关联并禁用个性化记录", + "lastfmUnlinkFailure": "Last.fm 无法取消关联", + "listenBrainzLinkSuccess": "ListenBrainz 成功关联并启用个性化记录，用户：%{user}", + "listenBrainzLinkFailure": "ListenBrainz 无法关联：%{error}", + "listenBrainzUnlinkSuccess": "ListenBrainz 已取消关联并禁用个性化记录", + "listenBrainzUnlinkFailure": "ListenBrainz 无法取消关联", + "openIn": { + "lastfm": "在 Last.fm 中打开", + "musicbrainz": "在 MusicBrainz 中打开" + }, + "lastfmLink": "查看更多…", + "shareOriginalFormat": "分享原始格式", + "shareDialogTitle": "分享 %{resource} '%{name}'", + "shareBatchDialogTitle": "分享 %{smart_count} 项 %{resource}", + "shareCopyToClipboard": "复制到剪切板: Ctrl+C, Enter", + "shareSuccess": "URL 已复制: %{url}", + "shareFailure": "URL 复制失败: %{url}", + "downloadDialogTitle": "下载 %{resource} '%{name}' (%{size})", + "downloadOriginalFormat": "下载原始格式" + }, + "menu": { + "library": "媒体库", + "librarySelector": { + "allLibraries": "全部媒体库 (%{count})", + "multipleLibraries": "已选 %{selected} 共 %{total} 个媒体库", + "selectLibraries": "选择媒体库", + "none": "无" + }, + "settings": "设置", + "version": "版本", + "theme": "主题", + "personal": { + "name": "个性化", + "options": { + "theme": "主题", + "language": "语言", + "defaultView": "默认视图", + "desktop_notifications": "桌面通知", + "lastfmNotConfigured": "未配置 Last.fm 的 API-Key", + "lastfmScrobbling": "启用 Last.fm 的个性化记录", + "listenBrainzScrobbling": "启用 ListenBrainz 的个性化记录", + "replaygain": "回放增益", + "preAmp": "前置放大器 (dB)", + "gain": { + "none": "禁用增益", + "album": "使用专辑增益信息", + "track": "使用歌曲增益信息" + } + } + }, + "albumList": "专辑", + "playlists": "歌单", + "sharedPlaylists": "共享的歌单", + "about": "关于" + }, + "player": { + "playListsText": "播放队列", + "openText": "打开", + "closeText": "关闭", + "notContentText": "没有音乐", + "clickToPlayText": "点击播放", + "clickToPauseText": "点击暂停", + "nextTrackText": "下一首", + "previousTrackText": "上一首", + "reloadText": "重新播放", + "volumeText": "音量", + "toggleLyricText": "切换歌词", + "toggleMiniModeText": "最小化", + "destroyText": "关闭", + "downloadText": "下载", + "removeAudioListsText": "清空播放队列", + "clickToDeleteText": "点击删除%{name}", + "emptyLyricText": "无歌词", + "playModeText": { + "order": "顺序播放", + "orderLoop": "列表循环", + "singleLoop": "单曲循环", + "shufflePlay": "随机播放" + } + }, + "about": { + "links": { + "homepage": "主页", + "source": "源代码", + "featureRequests": "功能需求", + "lastInsightsCollection": "最近的分析收集", + "insights": { + "disabled": "禁用", + "waiting": "等待" + } + }, + "tabs": { + "about": "关于", + "config": "配置" + }, + "config": { + "configName": "配置名称", + "environmentVariable": "环境变量", + "currentValue": "当前值", + "configurationFile": "配置文件", + "exportToml": "导出配置（TOML）", + "exportSuccess": "配置以 TOML 格式导出到剪贴板完成", + "exportFailed": "复制配置失败", + "devFlagsHeader": "开发标志（可能会更改/删除）", + "devFlagsComment": "这些是实验性设置，可能会在未来版本中删除" + } + }, + "activity": { + "title": "运行情况", + "totalScanned": "已完成扫描的文件夹", + "quickScan": "快速扫描", + "fullScan": "完全扫描", + "selectiveScan": "选择性扫描", + "serverUptime": "服务器已运行", + "serverDown": "服务器已离线", + "scanType": "上次扫描", + "status": "扫描错误", + "elapsedTime": "用时" + }, + "nowPlaying": { + "title": "正在播放", + "empty": "无播放内容", + "minutesAgo": "%{smart_count} 分钟前" + }, + "help": { + "title": "Navidrome 快捷键", + "hotkeys": { + "show_help": "显示此帮助", + "toggle_menu": "显示/隐藏菜单侧栏", + "toggle_play": "播放/暂停", + "prev_song": "上一首", + "next_song": "下一首", + "current_song": "转到当前播放", + "vol_up": "增大音量", + "vol_down": "减小音量", + "toggle_love": "添加/移除收藏" + } + } } diff --git a/resources/i18n/zh-Hant.json b/resources/i18n/zh-Hant.json index 3d6bbd268..dabf61bdb 100644 --- a/resources/i18n/zh-Hant.json +++ b/resources/i18n/zh-Hant.json @@ -1,463 +1,721 @@ { - "languageName": "繁體中文", - "resources": { - "song": { - "name": "歌曲 |||| 歌曲", - "fields": { - "albumArtist": "專輯藝人", - "duration": "長度", - "trackNumber": "#", - "playCount": "播放次數", - "title": "標題", - "artist": "藝人", - "album": "專輯", - "path": "文件路徑", - "genre": "類型", - "compilation": "合輯", - "year": "發行年份", - "size": "檔案大小", - "updatedAt": "更新於", - "bitRate": "位元率", - "discSubtitle": "字幕", - "starred": "收藏", - "comment": "註解", - "rating": "評分", - "quality": "品質", - "bpm": "BPM", - "playDate": "上次播放", - "channels": "聲道", - "createdAt": "創建於" - }, - "actions": { - "addToQueue": "加入至播放佇列", - "playNow": "立即播放", - "addToPlaylist": "加入至播放清單", - "shuffleAll": "全部隨機播放", - "download": "下載", - "playNext": "下一首播放", - "info": "取得資訊" - } - }, - "album": { - "name": "專輯 |||| 專輯", - "fields": { - "albumArtist": "專輯藝人", - "artist": "藝人", - "duration": "長度", - "songCount": "歌曲數量", - "playCount": "播放次數", - "name": "名稱", - "genre": "類型", - "compilation": "合輯", - "year": "發行年份", - "updatedAt": "更新於", - "comment": "註解", - "rating": "評分", - "createdAt": "創建於", - "size": "檔案大小", - "originalDate": "原始日期", - "releaseDate": "發行日期", - "releases": "發行", - "released": "已發行" - }, - "actions": { - "playAll": "立即播放", - "playNext": "下首播放", - "addToQueue": "加入至播放佇列", - "shuffle": "隨機播放", - "addToPlaylist": "加入播放清單", - "download": "下載", - "info": "取得資訊", - "share": "分享" - }, - "lists": { - "all": "所有", - "random": "隨機", - "recentlyAdded": "最近加入", - "recentlyPlayed": "最近播放", - "mostPlayed": "最多播放的", - "starred": "收藏", - "topRated": "最高評分" - } - }, - "artist": { - "name": "藝人 |||| 藝人", - "fields": { - "name": "名稱", - "albumCount": "專輯數", - "songCount": "歌曲數", - "playCount": "播放次數", - "rating": "評分", - "genre": "類型", - "size": "檔案大小" - } - }, - "user": { - "name": "使用者 |||| 使用者", - "fields": { - "userName": "使用者名稱", - "isAdmin": "是否管理員", - "lastLoginAt": "上次登入", - "lastAccessAt": "上此訪問", - "updatedAt": "更新於", - "name": "名稱", - "password": "密碼", - "createdAt": "創建於", - "changePassword": "變更密碼？", - "currentPassword": "現在的密碼", - "newPassword": "新密碼", - "token": "權杖" - }, - "helperTexts": { - "name": "你的名稱會在下次登入時生效" - }, - "notifications": { - "created": "使用者已創建", - "updated": "使用者已更新", - "deleted": "使用者已刪除" - }, - "message": { - "listenBrainzToken": "輸入您的 ListenBrainz 使用者權杖", - "clickHereForToken": "點擊此處來獲得你的 ListenBrainz 權杖" - } - }, - "player": { - "name": "用戶端 |||| 用戶端", - "fields": { - "name": "名稱", - "transcodingId": "轉碼", - "maxBitRate": "最大位元率", - "client": "用戶端", - "userName": "使用者名稱", - "lastSeen": "上次瀏覽", - "reportRealPath": "回報實際路徑", - "scrobbleEnabled": "傳送音樂記錄至外部服務" - } - }, - "transcoding": { - "name": "轉碼 |||| 轉碼", - "fields": { - "name": "名稱", - "targetFormat": "目標格式", - "defaultBitRate": "預設位元率", - "command": "命令" - } - }, - "playlist": { - "name": "播放清單 |||| 播放清單", - "fields": { - "name": "名稱", - "duration": "長度", - "ownerName": "擁有者", - "public": "公開", - "updatedAt": "更新於", - "createdAt": "創建於", - "songCount": "歌曲數", - "comment": "註解", - "sync": "自動導入", - "path": "導入" - }, - "actions": { - "selectPlaylist": "選擇播放清單", - "addNewPlaylist": "創建 %{name}", - "export": "導出", - "makePublic": "設為公開", - "makePrivate": "設為私人" - }, - "message": { - "duplicate_song": "加入重複的歌曲", - "song_exist": "有重複歌曲正在播放清單裡，您要加入或略過重複歌曲？" - } - }, - "radio": { - "name": "電台", - "fields": { - "name": "名稱", - "streamUrl": "串流網址", - "homePageUrl": "首頁網址", - "updatedAt": "更新於", - "createdAt": "創建於" - }, - "actions": { - "playNow": "立即播放" - } - }, - "share": { - "name": "分享", - "fields": { - "username": "使用者名稱", - "url": "網址", - "description": "描述", - "contents": "內容", - "expiresAt": "過期時間", - "lastVisitedAt": "上次訪問時間", - "visitCount": "訪問次數", - "format": "格式", - "maxBitRate": "最大位元率", - "updatedAt": "更新於", - "createdAt": "創建於", - "downloadable": "可下載" - }, - "notifications": {}, - "actions": {} - } + "languageName": "繁體中文", + "resources": { + "song": { + "name": "歌曲 |||| 歌曲", + "fields": { + "albumArtist": "專輯藝人", + "duration": "長度", + "trackNumber": "#", + "playCount": "播放次數", + "title": "標題", + "artist": "藝人", + "album": "專輯", + "path": "檔案路徑", + "genre": "曲風", + "compilation": "合輯", + "year": "發行年份", + "size": "檔案大小", + "updatedAt": "更新於", + "bitRate": "位元率", + "discSubtitle": "光碟副標題", + "starred": "收藏", + "comment": "註解", + "rating": "評分", + "quality": "品質", + "bpm": "BPM", + "playDate": "上次播放", + "channels": "聲道", + "createdAt": "建立於", + "grouping": "分組", + "mood": "情緒", + "participants": "其他參與人員", + "tags": "額外標籤", + "mappedTags": "分類後標籤", + "rawTags": "原始標籤", + "bitDepth": "位元深度", + "sampleRate": "取樣率", + "missing": "遺失", + "libraryName": "媒體庫", + "composer": "作曲者", + "disc": "" + }, + "actions": { + "addToQueue": "加入至播放佇列", + "playNow": "立即播放", + "addToPlaylist": "加入至播放清單", + "shuffleAll": "全部隨機播放", + "download": "下載", + "playNext": "下一首播放", + "info": "取得資訊", + "showInPlaylist": "在播放清單中顯示", + "instantMix": "即時混音" + } }, - "ra": { - "auth": { - "welcome1": "感謝您安裝 Navidrome！", - "welcome2": "開始前，請創建一個管理員帳戶", - "confirmPassword": "確認密碼", - "buttonCreateAdmin": "創建管理員", - "auth_check_error": "請登入以訪問更多內容", - "user_menu": "配置", - "username": "使用者名稱", - "password": "密碼", - "sign_in": "登入", - "sign_in_error": "驗證失敗，請重試", - "logout": "登出" - }, - "validation": { - "invalidChars": "請使用字母和數字", - "passwordDoesNotMatch": "密碼不相符", - "required": "必填", - "minLength": "必須不少於 %{min} 個字元", - "maxLength": "必須不多於 %{max} 個字元", - "minValue": "必須不小於 %{min}", - "maxValue": "必須不大於 %{max}", - "number": "必須為數字", - "email": "必須是有效的電子郵件", - "oneOf": "必須為: %{options}其中一項", - "regex": "必須符合指定的格式（正規表達式）：%{pattern}", - "unique": "必須是唯一的", - "url": "網址" - }, - "action": { - "add_filter": "加入篩選", - "add": "加入", - "back": "返回", - "bulk_actions": "選中 %{smart_count} 項", - "cancel": "取消", - "clear_input_value": "清除", - "clone": "複製", - "confirm": "確認", - "create": "創建", - "delete": "刪除", - "edit": "編輯", - "export": "匯出", - "list": "列表", - "refresh": "重新整理", - "remove_filter": "清除此條件", - "remove": "清除", - "save": "保存", - "search": "搜尋", - "show": "顯示", - "sort": "排序", - "undo": "撤銷", - "expand": "展開", - "close": "關閉", - "open_menu": "打開選單", - "close_menu": "關閉選單", - "unselect": "未選擇", - "skip": "略過", - "bulk_actions_mobile": "%{smart_count}", - "share": "分享", - "download": "下載" - }, - "boolean": { - "true": "是", - "false": "否" - }, - "page": { - "create": "創建 %{name}", - "dashboard": "儀表板", - "edit": "%{name} #%{id}", - "error": "發生錯誤", - "list": "%{name}", - "loading": "載入中", - "not_found": "未發現", - "show": "%{name} #%{id}", - "empty": "還沒有 %{name}。", - "invite": "你要創建一個嗎？" - }, - "input": { - "file": { - "upload_several": "拖拽多個文件上傳或點擊選擇一個", - "upload_single": "拖拽單個文件上傳或點擊選擇一個" - }, - "image": { - "upload_several": "拖拽多個圖片上傳或點擊選擇一個", - "upload_single": "拖拽單個圖片上傳或點擊選擇一個" - }, - "references": { - "all_missing": "未找到參考數據", - "many_missing": "至少有一條參考數據不再可用", - "single_missing": "關聯的參考數據不再可用" - }, - "password": { - "toggle_visible": "隱藏密碼", - "toggle_hidden": "顯示密碼" - } - }, - "message": { - "about": "關於", - "are_you_sure": "確定進行此操作？", - "bulk_delete_content": "您確定要刪除 %{name}？ |||| 您確定要刪除 %{smart_count} 項？", - "bulk_delete_title": "刪除 %{name} |||| 刪除 %{smart_count} 項 %{name}", - "delete_content": "您確定要刪除該項目？", - "delete_title": "刪除 %{name} #%{id}", - "details": "詳細資訊", - "error": "發生一個用戶端錯誤，您的請求無法完成", - "invalid_form": "提交內容無效，請檢查錯誤", - "loading": "正在載入頁面，請稍候", - "no": "否", - "not_found": "您輸入的連結格式不對或連結遺失", - "yes": "是", - "unsaved_changes": "某些更改尚未保存，您確定要離開此頁面嗎？" - }, - "navigation": { - "no_results": "無內容", - "no_more_results": "頁碼 %{page} 超出邊界，嘗試返回上一頁", - "page_out_of_boundaries": "頁碼 %{page} 超出邊界", - "page_out_from_end": "已經最後一頁", - "page_out_from_begin": "已經是第一頁", - "page_range_info": "%{offsetBegin}-%{offsetEnd} / %{total}", - "page_rows_per_page": "每頁行數：", - "next": "下一頁", - "prev": "上一頁", - "skip_nav": "跳過" - }, - "notification": { - "updated": "項已更新 |||| %{smart_count} 項已更新", - "created": "項已創建", - "deleted": "項已刪除 |||| %{smart_count} 項已刪除", - "bad_item": "不確定的項", - "item_doesnt_exist": "項不存在", - "http_error": "伺服器通訊錯誤", - "data_provider_error": "資料來源錯誤，請檢查控制台的詳細資訊", - "i18n_error": "無法載入所選語言", - "canceled": "操作已取消", - "logged_out": "您的會話已結束，請重新登入", - "new_version": "發現新版本！請重新整理視窗" - }, - "toggleFieldsMenu": { - "columnsToDisplay": "顯示欄目", - "layout": "版面", - "grid": "框格", - "table": "表格" - } + "album": { + "name": "專輯 |||| 專輯", + "fields": { + "albumArtist": "專輯藝人", + "artist": "藝人", + "duration": "長度", + "songCount": "歌曲數", + "playCount": "播放次數", + "name": "名稱", + "genre": "曲風", + "compilation": "合輯", + "year": "發行年份", + "updatedAt": "更新於", + "comment": "註解", + "rating": "評分", + "createdAt": "建立於", + "size": "檔案大小", + "originalDate": "原始日期", + "releaseDate": "發行日期", + "releases": "發行", + "released": "已發行", + "recordLabel": "唱片公司", + "catalogNum": "目錄編號", + "releaseType": "發行類型", + "grouping": "分組", + "media": "媒體類型", + "mood": "情緒", + "date": "錄製日期", + "missing": "遺失", + "libraryName": "媒體庫" + }, + "actions": { + "playAll": "播放全部", + "playNext": "下一首播放", + "addToQueue": "加入至播放佇列", + "shuffle": "隨機播放", + "addToPlaylist": "加入至播放清單", + "download": "下載", + "info": "取得資訊", + "share": "分享" + }, + "lists": { + "all": "所有", + "random": "隨機", + "recentlyAdded": "最近加入", + "recentlyPlayed": "最近播放", + "mostPlayed": "最常播放", + "starred": "收藏", + "topRated": "最高評分" + } }, - "message": { - "note": "註解", - "transcodingDisabled": "出於安全原因，禁用了從 Web 介面更改參數。要更改（編輯或新增）轉檔選項，請在啟用 %{config} 選項的情況下重新啟動伺服器。", - "transcodingEnabled": "Navidrome 當前與 %{config} 一起使用，可以通過配置轉檔參數執行任意命令，建議僅在配置轉檔選項時啟用此功能。", - "songsAddedToPlaylist": "已加入一首歌到播放清單 |||| 已添加 %{smart_count} 首歌到播放清單", - "noPlaylistsAvailable": "沒有可用的播放清單", - "delete_user_title": "刪除使用者 %{name}", - "delete_user_content": "您確定要刪除該使用者及其相關數據（包括播放清單和使用者配置）嗎？", - "notifications_blocked": "您已在瀏覽器的設置中封鎖了此網站的通知", - "notifications_not_available": "此瀏覽器不支援桌面通知", - "lastfmLinkSuccess": "Last.fm 成功連接並開啟音樂記錄", - "lastfmLinkFailure": "Last.fm 無法連接", - "lastfmUnlinkSuccess": "Last.fm 已無連接並停用音樂記錄", - "lastfmUnlinkFailure": "Last.fm 無法取消連接", - "openIn": { - "lastfm": "在 Last.fm 打開", - "musicbrainz": "在 MusicBrainz 打開" - }, - "lastfmLink": "繼續閱讀…", - "listenBrainzLinkSuccess": "ListenBrainz 成功連接並開啟音樂記錄", - "listenBrainzLinkFailure": "ListenBrainz 無法連接：%{error}", - "listenBrainzUnlinkSuccess": "ListenBrainz 已無連接並停用音樂記錄", - "listenBrainzUnlinkFailure": "ListenBrainz 無法取消連接", - "downloadOriginalFormat": "下載原始格式", - "shareOriginalFormat": "分享原始格式", - "shareDialogTitle": "分享", - "shareBatchDialogTitle": "批次分享", - "shareSuccess": "分享成功", - "shareFailure": "分享失敗", - "downloadDialogTitle": "下載", - "shareCopyToClipboard": "複製到剪貼簿" + "artist": { + "name": "藝人 |||| 藝人", + "fields": { + "name": "名稱", + "albumCount": "專輯數", + "songCount": "歌曲數", + "playCount": "播放次數", + "rating": "評分", + "genre": "曲風", + "size": "檔案大小", + "role": "參與角色", + "missing": "遺失" + }, + "roles": { + "albumartist": "專輯藝人 |||| 專輯藝人", + "artist": "藝人 |||| 藝人", + "composer": "作曲 |||| 作曲", + "conductor": "指揮 |||| 指揮", + "lyricist": "作詞 |||| 作詞", + "arranger": "編曲 |||| 編曲", + "producer": "製作人 |||| 製作人", + "director": "導演 |||| 導演", + "engineer": "工程師 |||| 工程師", + "mixer": "混音師 |||| 混音師", + "remixer": "重混師 |||| 重混師", + "djmixer": "DJ 混音師 |||| DJ 混音師", + "performer": "表演者 |||| 表演者", + "maincredit": "專輯藝人或藝人 |||| 專輯藝人或藝人" + }, + "actions": { + "shuffle": "隨機播放", + "radio": "電台", + "topSongs": "熱門歌曲" + } }, - "menu": { - "library": "音樂庫", - "settings": "設定", - "version": "版本", - "theme": "主題", - "personal": { - "name": "個人化", - "options": { - "theme": "主題", - "language": "語言", - "defaultView": "預設畫面", - "desktop_notifications": "桌面通知", - "lastfmScrobbling": "啟用 Last.fm 音樂記錄", - "listenBrainzScrobbling": "啟用 ListenBrainz 音樂記錄", - "replaygain": "重播增益", - "preAmp": "前置放大器 (dB)", - "gain": { - "none": "無", - "album": "專輯增益", - "track": "曲目增益" - } - } - }, - "albumList": "專輯", - "about": "關於", - "playlists": "播放清單", - "sharedPlaylists": "分享的播放清單" + "user": { + "name": "使用者 |||| 使用者", + "fields": { + "userName": "使用者名稱", + "isAdmin": "管理員", + "lastLoginAt": "上次登入", + "updatedAt": "更新於", + "name": "名稱", + "password": "密碼", + "createdAt": "建立於", + "changePassword": "變更密碼？", + "currentPassword": "目前密碼", + "newPassword": "新密碼", + "token": "權杖", + "lastAccessAt": "上次存取", + "libraries": "媒體庫" + }, + "helperTexts": { + "name": "您的名稱會在下次登入時生效", + "libraries": "為該使用者選擇指定媒體庫，留空則使用預設媒體庫" + }, + "notifications": { + "created": "使用者已建立", + "updated": "使用者已更新", + "deleted": "使用者已刪除" + }, + "message": { + "listenBrainzToken": "輸入您的 ListenBrainz 使用者權杖", + "clickHereForToken": "點擊此處來獲得您的 ListenBrainz 權杖", + "selectAllLibraries": "選取全部媒體庫", + "adminAutoLibraries": "管理員預設可存取所有媒體庫" + }, + "validation": { + "librariesRequired": "非管理員使用者必須至少選擇一個媒體庫" + } }, "player": { - "playListsText": "播放佇列", - "openText": "打開", - "closeText": "關閉", - "notContentText": "沒有音樂", - "clickToPlayText": "點擊播放", - "clickToPauseText": "點擊暫停", - "nextTrackText": "下一首", - "previousTrackText": "上一首", - "reloadText": "重新播放", - "volumeText": "音量", - "toggleLyricText": "切換歌詞", - "toggleMiniModeText": "最小化", - "destroyText": "關閉", - "downloadText": "下載", - "removeAudioListsText": "清空播放佇列", - "clickToDeleteText": "點擊刪除 %{name}", - "emptyLyricText": "無歌詞", - "playModeText": { - "order": "順序播放", - "orderLoop": "列表循環", - "singleLoop": "單曲循環", - "shufflePlay": "隨機播放" - } + "name": "播放器 |||| 播放器", + "fields": { + "name": "名稱", + "transcodingId": "轉碼", + "maxBitRate": "最大位元率", + "client": "客戶端", + "userName": "使用者名稱", + "lastSeen": "上次上線", + "reportRealPath": "回報實際路徑", + "scrobbleEnabled": "傳送音樂記錄至外部服務" + } }, - "about": { - "links": { - "homepage": "主頁", - "source": "原始碼", - "featureRequests": "功能請求" - } + "transcoding": { + "name": "轉碼 |||| 轉碼", + "fields": { + "name": "名稱", + "targetFormat": "目標格式", + "defaultBitRate": "預設位元率", + "command": "指令" + } }, - "activity": { - "title": "運作狀況", - "totalScanned": "已完成掃描的目錄", + "playlist": { + "name": "播放清單 |||| 播放清單", + "fields": { + "name": "名稱", + "duration": "長度", + "ownerName": "擁有者", + "public": "公開", + "updatedAt": "更新於", + "createdAt": "建立於", + "songCount": "歌曲數", + "comment": "註解", + "sync": "自動匯入", + "path": "匯入來源" + }, + "actions": { + "selectPlaylist": "選取播放清單：", + "addNewPlaylist": "建立「%{name}」", + "export": "匯出", + "makePublic": "設為公開", + "makePrivate": "設為私人", + "saveQueue": "將播放佇列儲存到播放清單", + "searchOrCreate": "搜尋播放清單，或輸入名稱來新建…", + "pressEnterToCreate": "按 Enter 鍵建立新的播放清單", + "removeFromSelection": "移除選取項目" + }, + "message": { + "duplicate_song": "加入重複的歌曲", + "song_exist": "有重複歌曲正要加入播放清單，您要加入或略過重複歌曲？", + "noPlaylistsFound": "找不到播放清單", + "noPlaylists": "暫無播放清單" + } + }, + "radio": { + "name": "電台 |||| 電台", + "fields": { + "name": "名稱", + "streamUrl": "串流網址", + "homePageUrl": "首頁網址", + "updatedAt": "更新於", + "createdAt": "建立於" + }, + "actions": { + "playNow": "立即播放" + } + }, + "share": { + "name": "分享 |||| 分享", + "fields": { + "username": "分享者", + "url": "網址", + "description": "描述", + "contents": "內容", + "expiresAt": "過期時間", + "lastVisitedAt": "上次造訪時間", + "visitCount": "造訪次數", + "format": "格式", + "maxBitRate": "最大位元率", + "updatedAt": "更新於", + "createdAt": "建立於", + "downloadable": "允許下載？" + } + }, + "missing": { + "name": "遺失檔案 |||| 遺失檔案", + "fields": { + "path": "路徑", + "size": "檔案大小", + "updatedAt": "遺失於", + "libraryName": "媒體庫" + }, + "actions": { + "remove": "刪除", + "remove_all": "刪除所有" + }, + "notifications": { + "removed": "遺失檔案已刪除" + }, + "empty": "無遺失檔案" + }, + "library": { + "name": "媒體庫 |||| 媒體庫", + "fields": { + "name": "名稱", + "path": "路徑", + "remotePath": "遠端路徑", + "lastScanAt": "上次掃描", + "songCount": "歌曲", + "albumCount": "專輯", + "artistCount": "藝人", + "totalSongs": "歌曲", + "totalAlbums": "專輯", + "totalArtists": "藝人", + "totalFolders": "資料夾", + "totalFiles": "檔案", + "totalMissingFiles": "遺失檔案", + "totalSize": "總大小", + "totalDuration": "時長", + "defaultNewUsers": "新使用者預設媒體庫", + "createdAt": "建立於", + "updatedAt": "更新於" + }, + "sections": { + "basic": "基本資訊", + "statistics": "統計" + }, + "actions": { + "scan": "掃描媒體庫", + "manageUsers": "管理使用者權限", + "viewDetails": "查看詳細資料", "quickScan": "快速掃描", - "fullScan": "完全掃描", - "serverUptime": "伺服器已運作時間", - "serverDown": "伺服器離線" + "fullScan": "完整掃描" + }, + "notifications": { + "created": "成功建立媒體庫", + "updated": "成功更新媒體庫", + "deleted": "成功刪除媒體庫", + "scanStarted": "開始掃描媒體庫", + "scanCompleted": "媒體庫掃描完成", + "quickScanStarted": "快速掃描已開始", + "fullScanStarted": "完整掃描已開始", + "scanError": "掃描啟動失敗，請檢查日誌" + }, + "validation": { + "nameRequired": "請輸入媒體庫名稱", + "pathRequired": "請提供媒體庫路徑", + "pathNotDirectory": "媒體庫路徑必須為目錄", + "pathNotFound": "媒體庫路徑不存在", + "pathNotAccessible": "無法存取媒體庫路徑", + "pathInvalid": "媒體庫路徑無效" + }, + "messages": { + "deleteConfirm": "您確定要刪除此媒體庫嗎？這將刪除所有相關資料和使用者存取權限。", + "scanInProgress": "正在掃描...", + "noLibrariesAssigned": "沒有為該使用者指派任何媒體庫" + } }, - "help": { - "title": "Navidrome 快捷鍵", - "hotkeys": { - "show_help": "顯示此幫助", - "toggle_menu": "顯示/隱藏選單側欄", - "toggle_play": "播放/暫停", - "prev_song": "上一首歌", - "next_song": "下一首歌", - "vol_up": "提高音量", - "vol_down": "降低音量", - "toggle_love": "添加或移除星標", - "current_song": "目前歌曲" - } + "plugin": { + "name": "插件 |||| 插件", + "fields": { + "id": "ID", + "name": "名稱", + "description": "描述", + "version": "版本", + "author": "作者", + "website": "網站", + "permissions": "權限", + "enabled": "已啟用", + "status": "狀態", + "path": "路徑", + "lastError": "錯誤", + "hasError": "錯誤", + "updatedAt": "更新於", + "createdAt": "安裝於", + "configKey": "鍵", + "configValue": "值", + "allUsers": "允許所有使用者", + "selectedUsers": "選定的使用者", + "allLibraries": "允許所有媒體庫", + "selectedLibraries": "選定的媒體庫", + "allowWriteAccess": "允許寫入權限" + }, + "sections": { + "status": "狀態", + "info": "插件資訊", + "configuration": "設定", + "manifest": "資訊清單", + "usersPermission": "使用者權限", + "libraryPermission": "媒體庫權限" + }, + "status": { + "enabled": "已啟用", + "disabled": "已停用" + }, + "actions": { + "enable": "啟用", + "disable": "停用", + "disabledDueToError": "修復錯誤後才能啟用", + "disabledUsersRequired": "啟用前請先選擇使用者", + "disabledLibrariesRequired": "啟用前請先選擇媒體庫", + "addConfig": "新增設定", + "rescan": "重新掃描" + }, + "notifications": { + "enabled": "插件已啟用", + "disabled": "插件已停用", + "updated": "插件已更新", + "error": "更新插件時發生錯誤" + }, + "validation": { + "invalidJson": "設定必須是有效的 JSON" + }, + "messages": { + "configHelp": "使用鍵值對設定插件。若插件無需設定則留空。", + "clickPermissions": "點擊權限以查看詳細資訊", + "noConfig": "無設定", + "allUsersHelp": "啟用後，插件將可存取所有使用者，包含未來建立的使用者。", + "noUsers": "未選擇使用者", + "permissionReason": "原因", + "usersRequired": "此插件需要存取使用者資訊。請選擇插件可存取的使用者，或啟用「允許所有使用者」。", + "allLibrariesHelp": "啟用後，插件將可存取所有媒體庫，包含未來建立的媒體庫。", + "noLibraries": "未選擇媒體庫", + "librariesRequired": "此插件需要存取媒體庫資訊。請選擇插件可存取的媒體庫，或啟用「允許所有媒體庫」。", + "requiredHosts": "必要的 Hosts", + "configValidationError": "設定驗證失敗：", + "schemaRenderError": "無法顯示設定表單。插件的 schema 可能無效。", + "allowWriteAccessHelp": "啟用後，插件可以修改媒體庫目錄中的檔案。 預設情況下，插件具有唯讀權限。" + }, + "placeholders": { + "configKey": "鍵", + "configValue": "值" + } } + }, + "ra": { + "auth": { + "welcome1": "感謝您安裝 Navidrome！", + "welcome2": "開始前，請先建立一個管理員帳號", + "confirmPassword": "確認密碼", + "buttonCreateAdmin": "建立管理員", + "auth_check_error": "請登入以繼續", + "user_menu": "個人檔案", + "username": "使用者名稱", + "password": "密碼", + "sign_in": "登入", + "sign_in_error": "驗證失敗，請重試", + "logout": "登出", + "insightsCollectionNote": "Navidrome 會收集匿名使用資料以協助改善項目。\n點擊[此處]了解更多資訊或選擇退出。" + }, + "validation": { + "invalidChars": "請使用字母和數字", + "passwordDoesNotMatch": "密碼不相符", + "required": "必填", + "minLength": "必須不少於 %{min} 個字元", + "maxLength": "必須不多於 %{max} 個字元", + "minValue": "必須不小於 %{min}", + "maxValue": "必須不大於 %{max}", + "number": "必須為數字", + "email": "必須為有效的電子郵件", + "oneOf": "必須為以下其中一項：%{options}", + "regex": "必須符合指定的格式（正規表達式）：%{pattern}", + "unique": "必須是唯一的", + "url": "必須為有效的網址" + }, + "action": { + "add_filter": "加入篩選", + "add": "加入", + "back": "返回", + "bulk_actions": "選中 1 項 |||| 選中 %{smart_count} 項", + "cancel": "取消", + "clear_input_value": "清除", + "clone": "複製", + "confirm": "確認", + "create": "建立", + "delete": "刪除", + "edit": "編輯", + "export": "匯出", + "list": "列表", + "refresh": "重新整理", + "remove_filter": "清除此條件", + "remove": "移除", + "save": "儲存", + "search": "搜尋", + "show": "顯示", + "sort": "排序", + "undo": "復原", + "expand": "展開", + "close": "關閉", + "open_menu": "開啟選單", + "close_menu": "關閉選單", + "unselect": "取消選取", + "skip": "略過", + "bulk_actions_mobile": "1 |||| %{smart_count}", + "share": "分享", + "download": "下載" + }, + "boolean": { + "true": "是", + "false": "否" + }, + "page": { + "create": "建立 %{name}", + "dashboard": "儀表板", + "edit": "%{name} #%{id}", + "error": "發生錯誤", + "list": "%{name}", + "loading": "載入中", + "not_found": "找不到", + "show": "%{name} #%{id}", + "empty": "還沒有 %{name}。", + "invite": "您要建立一個嗎？" + }, + "input": { + "file": { + "upload_several": "拖曳多個檔案上傳或點擊選擇一個", + "upload_single": "拖曳單個檔案上傳或點擊選擇一個" + }, + "image": { + "upload_several": "拖曳多個圖片上傳或點擊選擇一個", + "upload_single": "拖曳單個圖片上傳或點擊選擇一個" + }, + "references": { + "all_missing": "未找到參考數據", + "many_missing": "至少有一條參考數據不再可用", + "single_missing": "關聯的參考數據不再可用" + }, + "password": { + "toggle_visible": "隱藏密碼", + "toggle_hidden": "顯示密碼" + } + }, + "message": { + "about": "關於", + "are_you_sure": "您確定嗎？", + "bulk_delete_content": "您確定要刪除 %{name}？ |||| 您確定要刪除這 %{smart_count} 個項目嗎？", + "bulk_delete_title": "刪除 %{name} |||| 刪除 %{smart_count} 項 %{name}", + "delete_content": "您確定要刪除該項目？", + "delete_title": "刪除 %{name} #%{id}", + "details": "詳細資訊", + "error": "發生客戶端錯誤，您的請求無法完成", + "invalid_form": "提交內容無效，請檢查錯誤", + "loading": "正在載入頁面，請稍候", + "no": "否", + "not_found": "您輸入了錯誤的連結或連結遺失", + "yes": "是", + "unsaved_changes": "某些更改尚未儲存，您確定要離開此頁面嗎？" + }, + "navigation": { + "no_results": "沒有找到結果", + "no_more_results": "頁碼 %{page} 超出邊界，嘗試返回上一頁", + "page_out_of_boundaries": "頁碼 %{page} 超出邊界", + "page_out_from_end": "已經是最後一頁", + "page_out_from_begin": "已經是第一頁", + "page_range_info": "%{offsetBegin}-%{offsetEnd} / %{total}", + "page_rows_per_page": "每頁項目數：", + "next": "下一頁", + "prev": "上一頁", + "skip_nav": "跳至內容" + }, + "notification": { + "updated": "項目已更新 |||| %{smart_count} 項已更新", + "created": "項目已建立", + "deleted": "項目已刪除 |||| %{smart_count} 項已刪除", + "bad_item": "項目不正確", + "item_doesnt_exist": "項目不存在", + "http_error": "伺服器通訊錯誤", + "data_provider_error": "資料來源錯誤，請檢查控制台的詳細資訊", + "i18n_error": "無法載入所選語言", + "canceled": "操作已取消", + "logged_out": "您的工作階段已結束，請重新登入", + "new_version": "發現新版本！請重新整理視窗" + }, + "toggleFieldsMenu": { + "columnsToDisplay": "顯示欄位", + "layout": "版面", + "grid": "網格", + "table": "表格" + } + }, + "message": { + "note": "注意", + "transcodingDisabled": "出於安全原因，已禁用了從 Web 介面更改參數。要更改（編輯或新增）轉碼選項，請在啟用 %{config} 設定選項的情況下重新啟動伺服器。", + "transcodingEnabled": "Navidrome 目前與 %{config} 一起使用，因此可以透過 Web 介面從轉碼設定中執行系統命令。出於安全考慮，我們建議停用此功能，並僅在設定轉碼選項時啟用。", + "songsAddedToPlaylist": "已加入一首歌到播放清單 |||| 已新增 %{smart_count} 首歌到播放清單", + "noPlaylistsAvailable": "沒有可用的播放清單", + "delete_user_title": "刪除使用者「%{name}」", + "delete_user_content": "您確定要刪除此使用者及其所有資料（包括播放清單和偏好設定）嗎？", + "notifications_blocked": "您已在瀏覽器設定中封鎖了此網站的通知", + "notifications_not_available": "此瀏覽器不支援桌面通知，或您並非透過 HTTPS 存取 Navidrome", + "lastfmLinkSuccess": "已成功連接 Last.fm 並開啟音樂記錄", + "lastfmLinkFailure": "無法連接 Last.fm", + "lastfmUnlinkSuccess": "已取消與 Last.fm 的連接並停用音樂記錄", + "lastfmUnlinkFailure": "無法取消與 Last.fm 的連接", + "openIn": { + "lastfm": "在 Last.fm 中開啟", + "musicbrainz": "在 MusicBrainz 中開啟" + }, + "lastfmLink": "查看更多…", + "listenBrainzLinkSuccess": "已成功以 %{user} 的身份連接 ListenBrainz 並開啟音樂記錄", + "listenBrainzLinkFailure": "無法連接 ListenBrainz：%{error}", + "listenBrainzUnlinkSuccess": "已取消與 ListenBrainz 的連接並停用音樂記錄", + "listenBrainzUnlinkFailure": "無法取消與 ListenBrainz 的連接", + "downloadOriginalFormat": "下載原始格式", + "shareOriginalFormat": "分享原始格式", + "shareDialogTitle": "分享 %{resource} '%{name}'", + "shareBatchDialogTitle": "分享 1 個%{resource} |||| 分享 %{smart_count} 個%{resource}", + "shareSuccess": "分享成功，連結已複製到剪貼簿：%{url}", + "shareFailure": "分享連結複製失敗：%{url}", + "downloadDialogTitle": "下載 %{resource} '%{name}' (%{size})", + "shareCopyToClipboard": "複製到剪貼簿：Ctrl+C, Enter", + "remove_missing_title": "刪除遺失檔案", + "remove_missing_content": "您確定要從媒體庫中刪除所選的遺失的檔案嗎？這將永久刪除它們的所有相關資訊，包括其播放次數和評分。", + "remove_all_missing_title": "刪除所有遺失檔案", + "remove_all_missing_content": "您確定要從媒體庫中刪除所有遺失的檔案嗎？這將永久刪除它們的所有相關資訊，包括它們的播放次數和評分。", + "noSimilarSongsFound": "找不到相似歌曲", + "noTopSongsFound": "找不到熱門歌曲", + "startingInstantMix": "正在載入即時混音...", + "uploadCover": "上傳封面", + "removeCover": "移除封面", + "coverUploaded": "已更新封面圖", + "coverRemoved": "已移除封面圖", + "coverUploadError": "上傳封面圖時發生錯誤", + "coverRemoveError": "移除封面圖時發生錯誤" + }, + "menu": { + "library": "媒體庫", + "settings": "設定", + "version": "版本", + "theme": "主題", + "personal": { + "name": "個人化", + "options": { + "theme": "主題", + "language": "語言", + "defaultView": "預設畫面", + "desktop_notifications": "桌面通知", + "lastfmScrobbling": "啟用 Last.fm 音樂記錄", + "listenBrainzScrobbling": "啟用 ListenBrainz 音樂記錄", + "replaygain": "重播增益模式", + "preAmp": "重播增益前置放大器 (dB)", + "gain": { + "none": "無", + "album": "專輯增益", + "track": "曲目增益" + }, + "lastfmNotConfigured": "Last.fm API 金鑰未設定" + } + }, + "albumList": "專輯", + "about": "關於", + "playlists": "播放清單", + "sharedPlaylists": "分享的播放清單", + "librarySelector": { + "allLibraries": "所有媒體庫 (%{count})", + "multipleLibraries": "已選 %{selected} 共 %{total} 媒體庫", + "selectLibraries": "選取媒體庫", + "none": "無" + } + }, + "player": { + "playListsText": "播放佇列", + "openText": "開啟", + "closeText": "關閉", + "notContentText": "沒有音樂", + "clickToPlayText": "點擊播放", + "clickToPauseText": "點擊暫停", + "nextTrackText": "下一首", + "previousTrackText": "上一首", + "reloadText": "重新載入", + "volumeText": "音量", + "toggleLyricText": "歌詞顯示", + "toggleMiniModeText": "最小化", + "destroyText": "關閉", + "downloadText": "下載", + "removeAudioListsText": "清空播放佇列", + "clickToDeleteText": "點擊刪除 %{name}", + "emptyLyricText": "無歌詞", + "playModeText": { + "order": "順序播放", + "orderLoop": "循環播放", + "singleLoop": "單曲循環", + "shufflePlay": "隨機播放" + } + }, + "about": { + "links": { + "homepage": "首頁", + "source": "原始碼", + "featureRequests": "功能請求", + "lastInsightsCollection": "最近一次洞察資料收集", + "insights": { + "disabled": "已停用", + "waiting": "等待中" + } + }, + "tabs": { + "about": "關於", + "config": "設定" + }, + "config": { + "configName": "設定名稱", + "environmentVariable": "環境變數", + "currentValue": "目前值", + "configurationFile": "設定檔案", + "exportToml": "匯出設定（TOML 格式）", + "exportSuccess": "設定已以 TOML 格式匯出至剪貼簿", + "exportFailed": "設定複製失敗", + "devFlagsHeader": "開發旗標（可能會更改/刪除）", + "devFlagsComment": "這些是實驗性設定，可能會在未來版本中刪除", + "downloadToml": "下載設定檔 (TOML)" + } + }, + "activity": { + "title": "運作狀況", + "totalScanned": "已掃描的資料夾總數", + "quickScan": "快速掃描", + "fullScan": "完全掃描", + "serverUptime": "伺服器運作時間", + "serverDown": "伺服器已離線", + "scanType": "掃描類型", + "status": "掃描錯誤", + "elapsedTime": "經過時間", + "selectiveScan": "選擇性掃描" + }, + "help": { + "title": "Navidrome 快捷鍵", + "hotkeys": { + "show_help": "顯示此說明", + "toggle_menu": "顯示/隱藏選單側欄", + "toggle_play": "播放/暫停", + "prev_song": "上一首歌", + "next_song": "下一首歌", + "vol_up": "提高音量", + "vol_down": "降低音量", + "toggle_love": "新增此歌曲至收藏", + "current_song": "前往目前歌曲" + } + }, + "nowPlaying": { + "title": "正在播放", + "empty": "無播放內容", + "minutesAgo": "1 分鐘前 |||| %{smart_count} 分鐘前" + } } diff --git a/resources/mappings.yaml b/resources/mappings.yaml index d1da5c620..19ba0b090 100644 --- a/resources/mappings.yaml +++ b/resources/mappings.yaml @@ -81,7 +81,7 @@ main: albumsort: aliases: [ tsoa, albumsort, soal, wm/albumsortorder ] albumversion: - aliases: [albumversion, musicbrainz_albumcomment, musicbrainz album comment, version] + aliases: [albumversion, musicbrainz_albumcomment, musicbrainz album comment] album: true genre: aliases: [ tcon, genre, ©gen, wm/genre, ignr ] diff --git a/scanner/controller.go b/scanner/controller.go index c1347077a..94248ffd0 100644 --- a/scanner/controller.go +++ b/scanner/controller.go @@ -9,10 +9,10 @@ import ( "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/consts" - "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/core/artwork" "github.com/navidrome/navidrome/core/auth" "github.com/navidrome/navidrome/core/metrics" + "github.com/navidrome/navidrome/core/playlists" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/request" @@ -26,48 +26,34 @@ var ( ErrAlreadyScanning = errors.New("already scanning") ) -type Scanner interface { - // ScanAll starts a full scan of the music library. This is a blocking operation. - ScanAll(ctx context.Context, fullScan bool) (warnings []string, err error) - Status(context.Context) (*StatusInfo, error) -} - -type StatusInfo struct { - Scanning bool - LastScan time.Time - Count uint32 - FolderCount uint32 - LastError string - ScanType string - ElapsedTime time.Duration -} - func New(rootCtx context.Context, ds model.DataStore, cw artwork.CacheWarmer, broker events.Broker, - pls core.Playlists, m metrics.Metrics) Scanner { + pls playlists.Playlists, m metrics.Metrics) model.Scanner { c := &controller{ - rootCtx: rootCtx, - ds: ds, - cw: cw, - broker: broker, - pls: pls, - metrics: m, + rootCtx: rootCtx, + ds: ds, + cw: cw, + broker: broker, + pls: pls, + metrics: m, + devExternalScanner: conf.Server.DevExternalScanner, } - if !conf.Server.DevExternalScanner { + if !c.devExternalScanner { c.limiter = P(rate.Sometimes{Interval: conf.Server.DevActivityPanelUpdateRate}) } return c } func (s *controller) getScanner() scanner { - if conf.Server.DevExternalScanner { + if s.devExternalScanner { return &scannerExternal{} } return &scannerImpl{ds: s.ds, cw: s.cw, pls: s.pls} } -// CallScan starts an in-process scan of the music library. +// CallScan starts an in-process scan of specific library/folder pairs. +// If targets is empty, it scans all libraries. // This is meant to be called from the command line (see cmd/scan.go). -func CallScan(ctx context.Context, ds model.DataStore, pls core.Playlists, fullScan bool) (<-chan *ProgressInfo, error) { +func CallScan(ctx context.Context, ds model.DataStore, pls playlists.Playlists, fullScan bool, targets []model.ScanTarget) (<-chan *ProgressInfo, error) { release, err := lockScan(ctx) if err != nil { return nil, err @@ -79,7 +65,7 @@ func CallScan(ctx context.Context, ds model.DataStore, pls core.Playlists, fullS go func() { defer close(progress) scanner := &scannerImpl{ds: ds, cw: artwork.NoopCacheWarmer(), pls: pls} - scanner.scanAll(ctx, fullScan, progress) + scanner.scanFolders(ctx, fullScan, targets, progress) }() return progress, nil } @@ -99,21 +85,25 @@ type ProgressInfo struct { ForceUpdate bool } +// scanner defines the interface for different scanner implementations. +// This allows for swapping between in-process and external scanners. type scanner interface { - scanAll(ctx context.Context, fullScan bool, progress chan<- *ProgressInfo) + // scanFolders performs the actual scanning of folders. If targets is nil, it scans all libraries. + scanFolders(ctx context.Context, fullScan bool, targets []model.ScanTarget, progress chan<- *ProgressInfo) } type controller struct { - rootCtx context.Context - ds model.DataStore - cw artwork.CacheWarmer - broker events.Broker - metrics metrics.Metrics - pls core.Playlists - limiter *rate.Sometimes - count atomic.Uint32 - folderCount atomic.Uint32 - changesDetected bool + rootCtx context.Context + ds model.DataStore + cw artwork.CacheWarmer + broker events.Broker + metrics metrics.Metrics + pls playlists.Playlists + limiter *rate.Sometimes + devExternalScanner bool + count atomic.Uint32 + folderCount atomic.Uint32 + changesDetected bool } // getLastScanTime returns the most recent scan time across all libraries @@ -158,7 +148,7 @@ func (s *controller) getScanInfo(ctx context.Context) (scanType string, elapsed return scanType, elapsed, lastErr } -func (s *controller) Status(ctx context.Context) (*StatusInfo, error) { +func (s *controller) Status(ctx context.Context) (*model.ScannerStatus, error) { lastScanTime, err := s.getLastScanTime(ctx) if err != nil { return nil, fmt.Errorf("getting last scan time: %w", err) @@ -167,7 +157,7 @@ func (s *controller) Status(ctx context.Context) (*StatusInfo, error) { scanType, elapsed, lastErr := s.getScanInfo(ctx) if running.Load() { - status := &StatusInfo{ + status := &model.ScannerStatus{ Scanning: true, LastScan: lastScanTime, Count: s.count.Load(), @@ -183,7 +173,7 @@ func (s *controller) Status(ctx context.Context) (*StatusInfo, error) { if err != nil { return nil, fmt.Errorf("getting library stats: %w", err) } - return &StatusInfo{ + return &model.ScannerStatus{ Scanning: false, LastScan: lastScanTime, Count: uint32(count), @@ -208,6 +198,10 @@ func (s *controller) getCounters(ctx context.Context) (int64, int64, error) { } func (s *controller) ScanAll(requestCtx context.Context, fullScan bool) ([]string, error) { + return s.ScanFolders(requestCtx, fullScan, nil) +} + +func (s *controller) ScanFolders(requestCtx context.Context, fullScan bool, targets []model.ScanTarget) ([]string, error) { release, err := lockScan(requestCtx) if err != nil { return nil, err @@ -224,7 +218,7 @@ func (s *controller) ScanAll(requestCtx context.Context, fullScan bool) ([]strin go func() { defer close(progress) scanner := s.getScanner() - scanner.scanAll(ctx, fullScan, progress) + scanner.scanFolders(ctx, fullScan, targets, progress) }() // Wait for the scan to finish, sending progress events to all connected clients @@ -232,6 +226,10 @@ func (s *controller) ScanAll(requestCtx context.Context, fullScan bool) ([]strin for _, w := range scanWarnings { log.Warn(ctx, fmt.Sprintf("Scan warning: %s", w)) } + // Store scan error in database so it can be displayed in the UI + if scanError != nil { + _ = s.ds.Property(ctx).Put(consts.LastScanErrorKey, scanError.Error()) + } // If changes were detected, send a refresh event to all clients if s.changesDetected { log.Debug(ctx, "Library changes imported. Sending refresh event") diff --git a/scanner/controller_test.go b/scanner/controller_test.go index e551e15b1..d60d432b4 100644 --- a/scanner/controller_test.go +++ b/scanner/controller_test.go @@ -8,7 +8,9 @@ import ( "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/core/artwork" "github.com/navidrome/navidrome/core/metrics" + "github.com/navidrome/navidrome/core/playlists" "github.com/navidrome/navidrome/db" + "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/persistence" "github.com/navidrome/navidrome/scanner" "github.com/navidrome/navidrome/server/events" @@ -20,7 +22,7 @@ import ( var _ = Describe("Controller", func() { var ctx context.Context var ds *tests.MockDataStore - var ctrl scanner.Scanner + var ctrl model.Scanner Describe("Status", func() { BeforeEach(func() { @@ -30,7 +32,7 @@ var _ = Describe("Controller", func() { DeferCleanup(configtest.SetupConfig()) ds = &tests.MockDataStore{RealDS: persistence.New(db.Db())} ds.MockedProperty = &tests.MockedPropertyRepo{} - ctrl = scanner.New(ctx, ds, artwork.NoopCacheWarmer(), events.NoopBroker(), core.NewPlaylists(ds), metrics.NewNoopInstance()) + ctrl = scanner.New(ctx, ds, artwork.NoopCacheWarmer(), events.NoopBroker(), playlists.NewPlaylists(ds, core.NewImageUploadService()), metrics.NewNoopInstance()) }) It("includes last scan error", func() { diff --git a/scanner/external.go b/scanner/external.go index c4a29efa3..29ca90be6 100644 --- a/scanner/external.go +++ b/scanner/external.go @@ -11,7 +11,13 @@ import ( "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/log" - . "github.com/navidrome/navidrome/utils/gg" + "github.com/navidrome/navidrome/model" +) + +const ( + // argLengthThreshold is the threshold for switching from command-line args to file-based target passing. + // Set conservatively at 24KB to support Windows (~32KB limit) with margin for env vars. + argLengthThreshold = 24 * 1024 ) // scannerExternal is a scanner that runs an external process to do the scanning. It is used to avoid @@ -23,19 +29,46 @@ import ( // process will forward them to the caller. type scannerExternal struct{} -func (s *scannerExternal) scanAll(ctx context.Context, fullScan bool, progress chan<- *ProgressInfo) { +func (s *scannerExternal) scanFolders(ctx context.Context, fullScan bool, targets []model.ScanTarget, progress chan<- *ProgressInfo) { + s.scan(ctx, fullScan, targets, progress) +} + +func (s *scannerExternal) scan(ctx context.Context, fullScan bool, targets []model.ScanTarget, progress chan<- *ProgressInfo) { exe, err := os.Executable() if err != nil { progress <- &ProgressInfo{Error: fmt.Sprintf("failed to get executable path: %s", err)} return } - log.Debug(ctx, "Spawning external scanner process", "fullScan", fullScan, "path", exe) - cmd := exec.CommandContext(ctx, exe, "scan", + + // Build command arguments + args := []string{ + "scan", "--nobanner", "--subprocess", "--configfile", conf.Server.ConfigFile, "--datafolder", conf.Server.DataFolder, "--cachefolder", conf.Server.CacheFolder, - If(fullScan, "--full", "")) + } + + // Add targets if provided + if len(targets) > 0 { + targetArgs, cleanup, err := targetArguments(ctx, targets, argLengthThreshold) + if err != nil { + progress <- &ProgressInfo{Error: err.Error()} + return + } + defer cleanup() + log.Debug(ctx, "Spawning external scanner process with target file", "fullScan", fullScan, "path", exe, "numTargets", len(targets)) + args = append(args, targetArgs...) + } else { + log.Debug(ctx, "Spawning external scanner process", "fullScan", fullScan, "path", exe) + } + + // Add full scan flag if needed + if fullScan { + args = append(args, "--full") + } + + cmd := exec.CommandContext(ctx, exe, args...) in, out := io.Pipe() defer in.Close() @@ -75,4 +108,62 @@ func (s *scannerExternal) wait(cmd *exec.Cmd, out *io.PipeWriter) { _ = out.Close() } +// targetArguments builds command-line arguments for the given scan targets. +// If the estimated argument length exceeds a threshold, it writes the targets to a temp file +// and returns the --target-file argument instead. +// Returns the arguments, a cleanup function to remove any temp file created, and an error if any. +func targetArguments(ctx context.Context, targets []model.ScanTarget, lengthThreshold int) ([]string, func(), error) { + var args []string + + // Estimate argument length to decide whether to use file-based approach + argLength := estimateArgLength(targets) + + if argLength > lengthThreshold { + // Write targets to temp file and pass via --target-file + targetFile, err := writeTargetsToFile(targets) + if err != nil { + return nil, nil, fmt.Errorf("failed to write targets to file: %w", err) + } + args = append(args, "--target-file", targetFile) + return args, func() { + os.Remove(targetFile) // Clean up temp file + }, nil + } + + // Use command-line arguments for small target lists + for _, target := range targets { + args = append(args, "-t", target.String()) + } + return args, func() {}, nil +} + +// estimateArgLength estimates the total length of command-line arguments for the given targets. +func estimateArgLength(targets []model.ScanTarget) int { + length := 0 + for _, target := range targets { + // Each target adds: "-t " + target string + space + length += 3 + len(target.String()) + 1 + } + return length +} + +// writeTargetsToFile writes the targets to a temporary file, one per line. +// Returns the path to the temp file, which the caller should clean up. +func writeTargetsToFile(targets []model.ScanTarget) (string, error) { + tmpFile, err := os.CreateTemp("", "navidrome-scan-targets-*.txt") + if err != nil { + return "", fmt.Errorf("failed to create temp file: %w", err) + } + defer tmpFile.Close() + + for _, target := range targets { + if _, err := fmt.Fprintln(tmpFile, target.String()); err != nil { + os.Remove(tmpFile.Name()) //nolint:gosec + return "", fmt.Errorf("failed to write to temp file: %w", err) + } + } + + return tmpFile.Name(), nil +} + var _ scanner = (*scannerExternal)(nil) diff --git a/scanner/external_test.go b/scanner/external_test.go new file mode 100644 index 000000000..55f103f4d --- /dev/null +++ b/scanner/external_test.go @@ -0,0 +1,160 @@ +package scanner + +import ( + "context" + "os" + "strings" + + "github.com/navidrome/navidrome/model" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("targetArguments", func() { + var ctx context.Context + + BeforeEach(func() { + ctx = GinkgoT().Context() + }) + + Context("with small target list", func() { + It("returns command-line arguments for single target", func() { + targets := []model.ScanTarget{ + {LibraryID: 1, FolderPath: "Music/Rock"}, + } + + args, cleanup, err := targetArguments(ctx, targets, argLengthThreshold) + Expect(err).ToNot(HaveOccurred()) + defer cleanup() + Expect(args).To(Equal([]string{"-t", "1:Music/Rock"})) + }) + + It("returns command-line arguments for multiple targets", func() { + targets := []model.ScanTarget{ + {LibraryID: 1, FolderPath: "Music/Rock"}, + {LibraryID: 2, FolderPath: "Music/Jazz"}, + {LibraryID: 3, FolderPath: "Classical"}, + } + + args, cleanup, err := targetArguments(ctx, targets, argLengthThreshold) + Expect(err).ToNot(HaveOccurred()) + defer cleanup() + Expect(args).To(Equal([]string{ + "-t", "1:Music/Rock", + "-t", "2:Music/Jazz", + "-t", "3:Classical", + })) + }) + + It("handles targets with special characters", func() { + targets := []model.ScanTarget{ + {LibraryID: 1, FolderPath: "Music/Rock & Roll"}, + {LibraryID: 2, FolderPath: "Music/Jazz (Modern)"}, + } + + args, cleanup, err := targetArguments(ctx, targets, argLengthThreshold) + Expect(err).ToNot(HaveOccurred()) + defer cleanup() + Expect(args).To(Equal([]string{ + "-t", "1:Music/Rock & Roll", + "-t", "2:Music/Jazz (Modern)", + })) + }) + }) + + Context("with large target list exceeding threshold", func() { + It("returns --target-file argument when exceeding threshold", func() { + // Create enough targets to exceed the threshold + var targets []model.ScanTarget + for i := 1; i <= 600; i++ { + targets = append(targets, model.ScanTarget{ + LibraryID: 1, + FolderPath: "Music/VeryLongFolderPathToSimulateRealScenario/SubFolder", + }) + } + + args, cleanup, err := targetArguments(ctx, targets, argLengthThreshold) + Expect(err).ToNot(HaveOccurred()) + defer cleanup() + Expect(args).To(HaveLen(2)) + Expect(args[0]).To(Equal("--target-file")) + + // Verify the file exists and has correct format + filePath := args[1] + Expect(filePath).To(ContainSubstring("navidrome-scan-targets-")) + Expect(filePath).To(HaveSuffix(".txt")) + + // Verify file actually exists + _, err = os.Stat(filePath) + Expect(err).ToNot(HaveOccurred()) + }) + + It("creates temp file with correct format", func() { + // Use custom threshold to easily exceed it + targets := []model.ScanTarget{ + {LibraryID: 1, FolderPath: "Music/Rock"}, + {LibraryID: 2, FolderPath: "Music/Jazz"}, + {LibraryID: 3, FolderPath: "Classical"}, + } + + // Set threshold very low to force file usage + args, cleanup, err := targetArguments(ctx, targets, 10) + Expect(err).ToNot(HaveOccurred()) + defer cleanup() + Expect(args[0]).To(Equal("--target-file")) + + // Verify file exists with correct format + filePath := args[1] + Expect(filePath).To(ContainSubstring("navidrome-scan-targets-")) + Expect(filePath).To(HaveSuffix(".txt")) + + // Verify file content + content, err := os.ReadFile(filePath) + Expect(err).ToNot(HaveOccurred()) + lines := strings.Split(strings.TrimSpace(string(content)), "\n") + Expect(lines).To(HaveLen(3)) + Expect(lines[0]).To(Equal("1:Music/Rock")) + Expect(lines[1]).To(Equal("2:Music/Jazz")) + Expect(lines[2]).To(Equal("3:Classical")) + }) + }) + + Context("edge cases", func() { + It("handles empty target list", func() { + var targets []model.ScanTarget + + args, cleanup, err := targetArguments(ctx, targets, argLengthThreshold) + Expect(err).ToNot(HaveOccurred()) + defer cleanup() + Expect(args).To(BeEmpty()) + }) + + It("uses command-line args when exactly at threshold", func() { + // Create targets that are exactly at threshold + targets := []model.ScanTarget{ + {LibraryID: 1, FolderPath: "Music"}, + } + + // Estimate length should be 11 bytes + estimatedLength := estimateArgLength(targets) + + args, cleanup, err := targetArguments(ctx, targets, estimatedLength) + Expect(err).ToNot(HaveOccurred()) + defer cleanup() + Expect(args).To(Equal([]string{"-t", "1:Music"})) + }) + + It("uses file when one byte over threshold", func() { + targets := []model.ScanTarget{ + {LibraryID: 1, FolderPath: "Music"}, + } + + // Set threshold just below the estimated length + estimatedLength := estimateArgLength(targets) + args, cleanup, err := targetArguments(ctx, targets, estimatedLength-1) + Expect(err).ToNot(HaveOccurred()) + defer cleanup() + Expect(args[0]).To(Equal("--target-file")) + }) + }) +}) diff --git a/scanner/folder_entry.go b/scanner/folder_entry.go index fc68cb561..c7cc88ee1 100644 --- a/scanner/folder_entry.go +++ b/scanner/folder_entry.go @@ -10,14 +10,12 @@ import ( "slices" "time" - "github.com/navidrome/navidrome/core" + "github.com/navidrome/navidrome/core/playlists" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/utils/chrono" ) -func newFolderEntry(job *scanJob, path string) *folderEntry { - id := model.FolderID(job.lib, path) - info := job.popLastUpdate(id) +func newFolderEntry(job *scanJob, id, path string, updTime time.Time, hash string) *folderEntry { f := &folderEntry{ id: id, job: job, @@ -25,8 +23,8 @@ func newFolderEntry(job *scanJob, path string) *folderEntry { audioFiles: make(map[string]fs.DirEntry), imageFiles: make(map[string]fs.DirEntry), albumIDMap: make(map[string]string), - updTime: info.UpdatedAt, - prevHash: info.Hash, + updTime: updTime, + prevHash: hash, } return f } @@ -74,7 +72,7 @@ func (f *folderEntry) isOutdated() bool { func (f *folderEntry) toFolder() *model.Folder { folder := model.NewFolder(f.job.lib, f.path) folder.NumAudioFiles = len(f.audioFiles) - if core.InPlaylistsPath(*folder) { + if playlists.InPath(*folder) { folder.NumPlaylists = f.numPlaylists } folder.ImageFiles = slices.Collect(maps.Keys(f.imageFiles)) diff --git a/scanner/folder_entry_test.go b/scanner/folder_entry_test.go index c6d1b2ce4..0328c6653 100644 --- a/scanner/folder_entry_test.go +++ b/scanner/folder_entry_test.go @@ -40,9 +40,8 @@ var _ = Describe("folder_entry", func() { UpdatedAt: time.Now().Add(-30 * time.Minute), Hash: "previous-hash", } - job.lastUpdates[folderID] = updateInfo - entry := newFolderEntry(job, path) + entry := newFolderEntry(job, folderID, path, updateInfo.UpdatedAt, updateInfo.Hash) Expect(entry.id).To(Equal(folderID)) Expect(entry.job).To(Equal(job)) @@ -53,15 +52,10 @@ var _ = Describe("folder_entry", func() { Expect(entry.updTime).To(Equal(updateInfo.UpdatedAt)) Expect(entry.prevHash).To(Equal(updateInfo.Hash)) }) + }) - It("creates a new folder entry with zero time when no previous update exists", func() { - entry := newFolderEntry(job, path) - - Expect(entry.updTime).To(BeZero()) - Expect(entry.prevHash).To(BeEmpty()) - }) - - It("removes the lastUpdate from the job after popping", func() { + Describe("createFolderEntry", func() { + It("removes the lastUpdate from the job after creation", func() { folderID := model.FolderID(lib, path) updateInfo := model.FolderUpdateInfo{ UpdatedAt: time.Now().Add(-30 * time.Minute), @@ -69,8 +63,10 @@ var _ = Describe("folder_entry", func() { } job.lastUpdates[folderID] = updateInfo - newFolderEntry(job, path) + entry := job.createFolderEntry(path) + Expect(entry.updTime).To(Equal(updateInfo.UpdatedAt)) + Expect(entry.prevHash).To(Equal(updateInfo.Hash)) Expect(job.lastUpdates).ToNot(HaveKey(folderID)) }) }) @@ -79,7 +75,8 @@ var _ = Describe("folder_entry", func() { var entry *folderEntry BeforeEach(func() { - entry = newFolderEntry(job, path) + folderID := model.FolderID(lib, path) + entry = newFolderEntry(job, folderID, path, time.Time{}, "") }) Describe("hasNoFiles", func() { @@ -458,7 +455,9 @@ var _ = Describe("folder_entry", func() { Describe("integration scenarios", func() { It("handles complete folder lifecycle", func() { // Create new folder entry - entry := newFolderEntry(job, "music/rock/album") + folderPath := "music/rock/album" + folderID := model.FolderID(lib, folderPath) + entry := newFolderEntry(job, folderID, folderPath, time.Time{}, "") // Initially new and has no files Expect(entry.isNew()).To(BeTrue()) diff --git a/scanner/ignore_checker.go b/scanner/ignore_checker.go new file mode 100644 index 000000000..f0aedb079 --- /dev/null +++ b/scanner/ignore_checker.go @@ -0,0 +1,163 @@ +package scanner + +import ( + "bufio" + "context" + "io/fs" + "path" + "strings" + + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/log" + ignore "github.com/sabhiram/go-gitignore" +) + +// IgnoreChecker manages .ndignore patterns using a stack-based approach. +// Use Push() to add patterns when entering a folder, Pop() when leaving, +// and ShouldIgnore() to check if a path should be ignored. +type IgnoreChecker struct { + fsys fs.FS + patternStack [][]string // Stack of patterns for each folder level + currentPatterns []string // Flattened current patterns + matcher *ignore.GitIgnore // Compiled matcher for current patterns +} + +// newIgnoreChecker creates a new IgnoreChecker for the given filesystem. +func newIgnoreChecker(fsys fs.FS) *IgnoreChecker { + return &IgnoreChecker{ + fsys: fsys, + patternStack: make([][]string, 0), + } +} + +// Push loads .ndignore patterns from the specified folder and adds them to the pattern stack. +// Use this when entering a folder during directory tree traversal. +func (ic *IgnoreChecker) Push(ctx context.Context, folder string) error { + patterns := ic.loadPatternsFromFolder(ctx, folder) + ic.patternStack = append(ic.patternStack, patterns) + ic.rebuildCurrentPatterns() + return nil +} + +// Pop removes the most recent patterns from the stack. +// Use this when leaving a folder during directory tree traversal. +func (ic *IgnoreChecker) Pop() { + if len(ic.patternStack) > 0 { + ic.patternStack = ic.patternStack[:len(ic.patternStack)-1] + ic.rebuildCurrentPatterns() + } +} + +// PushAllParents pushes patterns from root down to the target path. +// This is a convenience method for when you need to check a specific path +// without recursively walking the tree. It handles the common pattern of +// pushing all parent directories from root to the target. +// This method is optimized to compile patterns only once at the end. +func (ic *IgnoreChecker) PushAllParents(ctx context.Context, targetPath string) error { + if targetPath == "." || targetPath == "" { + // Simple case: just push root + return ic.Push(ctx, ".") + } + + // Load patterns for root + patterns := ic.loadPatternsFromFolder(ctx, ".") + ic.patternStack = append(ic.patternStack, patterns) + + // Load patterns for each parent directory + currentPath := "." + parts := strings.SplitSeq(path.Clean(targetPath), "/") + for part := range parts { + if part == "." || part == "" { + continue + } + currentPath = path.Join(currentPath, part) + patterns = ic.loadPatternsFromFolder(ctx, currentPath) + ic.patternStack = append(ic.patternStack, patterns) + } + + // Rebuild and compile patterns only once at the end + ic.rebuildCurrentPatterns() + return nil +} + +// ShouldIgnore checks if the given path should be ignored based on the current patterns. +// Returns true if the path matches any ignore pattern, false otherwise. +func (ic *IgnoreChecker) ShouldIgnore(ctx context.Context, relPath string) bool { + // Handle root/empty path - never ignore + if relPath == "" || relPath == "." { + return false + } + + // If no patterns loaded, nothing to ignore + if ic.matcher == nil { + return false + } + + matches := ic.matcher.MatchesPath(relPath) + if matches { + log.Trace(ctx, "Scanner: Ignoring entry matching .ndignore", "path", relPath) + } + return matches +} + +// loadPatternsFromFolder reads the .ndignore file in the specified folder and returns the patterns. +// If the file doesn't exist, returns an empty slice. +// If the file exists but is empty, returns a pattern to ignore everything ("**/*"). +func (ic *IgnoreChecker) loadPatternsFromFolder(ctx context.Context, folder string) []string { + ignoreFilePath := path.Join(folder, consts.ScanIgnoreFile) + var patterns []string + + // Check if .ndignore file exists + if _, err := fs.Stat(ic.fsys, ignoreFilePath); err != nil { + // No .ndignore file in this folder + return patterns + } + + // Read and parse the .ndignore file + ignoreFile, err := ic.fsys.Open(ignoreFilePath) + if err != nil { + log.Warn(ctx, "Scanner: Error opening .ndignore file", "path", ignoreFilePath, err) + return patterns + } + defer ignoreFile.Close() + + lineScanner := bufio.NewScanner(ignoreFile) + for lineScanner.Scan() { + line := strings.TrimSpace(lineScanner.Text()) + if line == "" || strings.HasPrefix(line, "#") { + continue // Skip empty lines, whitespace-only lines, and comments + } + patterns = append(patterns, line) + } + + if err := lineScanner.Err(); err != nil { + log.Warn(ctx, "Scanner: Error reading .ndignore file", "path", ignoreFilePath, err) + return patterns + } + + // If the .ndignore file is empty, ignore everything + if len(patterns) == 0 { + log.Trace(ctx, "Scanner: .ndignore file is empty, ignoring everything", "path", folder) + patterns = []string{"**/*"} + } + + return patterns +} + +// rebuildCurrentPatterns flattens the pattern stack into currentPatterns and recompiles the matcher. +func (ic *IgnoreChecker) rebuildCurrentPatterns() { + ic.currentPatterns = make([]string, 0) + for _, patterns := range ic.patternStack { + ic.currentPatterns = append(ic.currentPatterns, patterns...) + } + ic.compilePatterns() +} + +// compilePatterns compiles the current patterns into a GitIgnore matcher. +func (ic *IgnoreChecker) compilePatterns() { + if len(ic.currentPatterns) == 0 { + ic.matcher = nil + return + } + ic.matcher = ignore.CompileIgnoreLines(ic.currentPatterns...) +} diff --git a/scanner/ignore_checker_test.go b/scanner/ignore_checker_test.go new file mode 100644 index 000000000..5378ed4fa --- /dev/null +++ b/scanner/ignore_checker_test.go @@ -0,0 +1,313 @@ +package scanner + +import ( + "context" + "testing/fstest" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("IgnoreChecker", func() { + Describe("loadPatternsFromFolder", func() { + var ic *IgnoreChecker + var ctx context.Context + + BeforeEach(func() { + ctx = context.Background() + }) + + Context("when .ndignore file does not exist", func() { + It("should return empty patterns", func() { + fsys := fstest.MapFS{} + ic = newIgnoreChecker(fsys) + patterns := ic.loadPatternsFromFolder(ctx, ".") + Expect(patterns).To(BeEmpty()) + }) + }) + + Context("when .ndignore file is empty", func() { + It("should return wildcard to ignore everything", func() { + fsys := fstest.MapFS{ + ".ndignore": &fstest.MapFile{Data: []byte("")}, + } + ic = newIgnoreChecker(fsys) + patterns := ic.loadPatternsFromFolder(ctx, ".") + Expect(patterns).To(Equal([]string{"**/*"})) + }) + }) + + DescribeTable("parsing .ndignore content", + func(content string, expectedPatterns []string) { + fsys := fstest.MapFS{ + ".ndignore": &fstest.MapFile{Data: []byte(content)}, + } + ic = newIgnoreChecker(fsys) + patterns := ic.loadPatternsFromFolder(ctx, ".") + Expect(patterns).To(Equal(expectedPatterns)) + }, + Entry("single pattern", "*.txt", []string{"*.txt"}), + Entry("multiple patterns", "*.txt\n*.log", []string{"*.txt", "*.log"}), + Entry("with comments", "# comment\n*.txt\n# another\n*.log", []string{"*.txt", "*.log"}), + Entry("with empty lines", "*.txt\n\n*.log\n\n", []string{"*.txt", "*.log"}), + Entry("mixed content", "# header\n\n*.txt\n# middle\n*.log\n\n", []string{"*.txt", "*.log"}), + Entry("only comments and empty lines", "# comment\n\n# another\n", []string{"**/*"}), + Entry("trailing newline", "*.txt\n*.log\n", []string{"*.txt", "*.log"}), + Entry("directory pattern", "temp/", []string{"temp/"}), + Entry("wildcard pattern", "**/*.mp3", []string{"**/*.mp3"}), + Entry("multiple wildcards", "**/*.mp3\n**/*.flac\n*.log", []string{"**/*.mp3", "**/*.flac", "*.log"}), + Entry("negation pattern", "!important.txt", []string{"!important.txt"}), + Entry("comment with hash not at start is pattern", "not#comment", []string{"not#comment"}), + Entry("whitespace-only lines skipped", "*.txt\n \n*.log\n\t\n", []string{"*.txt", "*.log"}), + Entry("patterns with whitespace trimmed", " *.txt \n\t*.log\t", []string{"*.txt", "*.log"}), + ) + }) + + Describe("Push and Pop", func() { + var ic *IgnoreChecker + var fsys fstest.MapFS + var ctx context.Context + + BeforeEach(func() { + ctx = context.Background() + fsys = fstest.MapFS{ + ".ndignore": &fstest.MapFile{Data: []byte("*.txt")}, + "folder1/.ndignore": &fstest.MapFile{Data: []byte("*.mp3")}, + "folder2/.ndignore": &fstest.MapFile{Data: []byte("*.flac")}, + } + ic = newIgnoreChecker(fsys) + }) + + Context("Push", func() { + It("should add patterns to stack", func() { + err := ic.Push(ctx, ".") + Expect(err).ToNot(HaveOccurred()) + Expect(len(ic.patternStack)).To(Equal(1)) + Expect(ic.currentPatterns).To(ContainElement("*.txt")) + }) + + It("should compile matcher after push", func() { + err := ic.Push(ctx, ".") + Expect(err).ToNot(HaveOccurred()) + Expect(ic.matcher).ToNot(BeNil()) + }) + + It("should accumulate patterns from multiple levels", func() { + err := ic.Push(ctx, ".") + Expect(err).ToNot(HaveOccurred()) + err = ic.Push(ctx, "folder1") + Expect(err).ToNot(HaveOccurred()) + Expect(len(ic.patternStack)).To(Equal(2)) + Expect(ic.currentPatterns).To(ConsistOf("*.txt", "*.mp3")) + }) + + It("should handle push when no .ndignore exists", func() { + err := ic.Push(ctx, "nonexistent") + Expect(err).ToNot(HaveOccurred()) + Expect(len(ic.patternStack)).To(Equal(1)) + Expect(ic.currentPatterns).To(BeEmpty()) + }) + }) + + Context("Pop", func() { + It("should remove most recent patterns", func() { + err := ic.Push(ctx, ".") + Expect(err).ToNot(HaveOccurred()) + err = ic.Push(ctx, "folder1") + Expect(err).ToNot(HaveOccurred()) + ic.Pop() + Expect(len(ic.patternStack)).To(Equal(1)) + Expect(ic.currentPatterns).To(Equal([]string{"*.txt"})) + }) + + It("should handle Pop on empty stack gracefully", func() { + Expect(func() { ic.Pop() }).ToNot(Panic()) + Expect(ic.patternStack).To(BeEmpty()) + }) + + It("should set matcher to nil when all patterns popped", func() { + err := ic.Push(ctx, ".") + Expect(err).ToNot(HaveOccurred()) + Expect(ic.matcher).ToNot(BeNil()) + ic.Pop() + Expect(ic.matcher).To(BeNil()) + }) + + It("should update matcher after pop", func() { + err := ic.Push(ctx, ".") + Expect(err).ToNot(HaveOccurred()) + err = ic.Push(ctx, "folder1") + Expect(err).ToNot(HaveOccurred()) + matcher1 := ic.matcher + ic.Pop() + matcher2 := ic.matcher + Expect(matcher1).ToNot(Equal(matcher2)) + }) + }) + + Context("multiple Push/Pop cycles", func() { + It("should maintain correct state through cycles", func() { + err := ic.Push(ctx, ".") + Expect(err).ToNot(HaveOccurred()) + Expect(ic.currentPatterns).To(Equal([]string{"*.txt"})) + + err = ic.Push(ctx, "folder1") + Expect(err).ToNot(HaveOccurred()) + Expect(ic.currentPatterns).To(ConsistOf("*.txt", "*.mp3")) + + ic.Pop() + Expect(ic.currentPatterns).To(Equal([]string{"*.txt"})) + + err = ic.Push(ctx, "folder2") + Expect(err).ToNot(HaveOccurred()) + Expect(ic.currentPatterns).To(ConsistOf("*.txt", "*.flac")) + + ic.Pop() + Expect(ic.currentPatterns).To(Equal([]string{"*.txt"})) + + ic.Pop() + Expect(ic.currentPatterns).To(BeEmpty()) + }) + }) + }) + + Describe("PushAllParents", func() { + var ic *IgnoreChecker + var ctx context.Context + + BeforeEach(func() { + ctx = context.Background() + fsys := fstest.MapFS{ + ".ndignore": &fstest.MapFile{Data: []byte("root.txt")}, + "folder1/.ndignore": &fstest.MapFile{Data: []byte("level1.txt")}, + "folder1/folder2/.ndignore": &fstest.MapFile{Data: []byte("level2.txt")}, + "folder1/folder2/folder3/.ndignore": &fstest.MapFile{Data: []byte("level3.txt")}, + } + ic = newIgnoreChecker(fsys) + }) + + DescribeTable("loading parent patterns", + func(targetPath string, expectedStackDepth int, expectedPatterns []string) { + err := ic.PushAllParents(ctx, targetPath) + Expect(err).ToNot(HaveOccurred()) + Expect(len(ic.patternStack)).To(Equal(expectedStackDepth)) + Expect(ic.currentPatterns).To(ConsistOf(expectedPatterns)) + }, + Entry("root path", ".", 1, []string{"root.txt"}), + Entry("empty path", "", 1, []string{"root.txt"}), + Entry("single level", "folder1", 2, []string{"root.txt", "level1.txt"}), + Entry("two levels", "folder1/folder2", 3, []string{"root.txt", "level1.txt", "level2.txt"}), + Entry("three levels", "folder1/folder2/folder3", 4, []string{"root.txt", "level1.txt", "level2.txt", "level3.txt"}), + ) + + It("should only compile patterns once at the end", func() { + // This is more of a behavioral test - we verify the matcher is not nil after PushAllParents + err := ic.PushAllParents(ctx, "folder1/folder2") + Expect(err).ToNot(HaveOccurred()) + Expect(ic.matcher).ToNot(BeNil()) + }) + + It("should handle paths with dot", func() { + err := ic.PushAllParents(ctx, "./folder1") + Expect(err).ToNot(HaveOccurred()) + Expect(len(ic.patternStack)).To(Equal(2)) + }) + + Context("when some parent folders have no .ndignore", func() { + BeforeEach(func() { + fsys := fstest.MapFS{ + ".ndignore": &fstest.MapFile{Data: []byte("root.txt")}, + "folder1/folder2/.ndignore": &fstest.MapFile{Data: []byte("level2.txt")}, + } + ic = newIgnoreChecker(fsys) + }) + + It("should still push all parent levels", func() { + err := ic.PushAllParents(ctx, "folder1/folder2") + Expect(err).ToNot(HaveOccurred()) + Expect(len(ic.patternStack)).To(Equal(3)) // root, folder1 (empty), folder2 + Expect(ic.currentPatterns).To(ConsistOf("root.txt", "level2.txt")) + }) + }) + }) + + Describe("ShouldIgnore", func() { + var ic *IgnoreChecker + var ctx context.Context + + BeforeEach(func() { + ctx = context.Background() + }) + + Context("with no patterns loaded", func() { + It("should not ignore any path", func() { + fsys := fstest.MapFS{} + ic = newIgnoreChecker(fsys) + Expect(ic.ShouldIgnore(ctx, "anything.txt")).To(BeFalse()) + Expect(ic.ShouldIgnore(ctx, "folder/file.mp3")).To(BeFalse()) + }) + }) + + Context("special paths", func() { + BeforeEach(func() { + fsys := fstest.MapFS{ + ".ndignore": &fstest.MapFile{Data: []byte("**/*")}, + } + ic = newIgnoreChecker(fsys) + err := ic.Push(ctx, ".") + Expect(err).ToNot(HaveOccurred()) + }) + + It("should never ignore root or empty paths", func() { + Expect(ic.ShouldIgnore(ctx, "")).To(BeFalse()) + Expect(ic.ShouldIgnore(ctx, ".")).To(BeFalse()) + }) + + It("should ignore all other paths with wildcard", func() { + Expect(ic.ShouldIgnore(ctx, "file.txt")).To(BeTrue()) + Expect(ic.ShouldIgnore(ctx, "folder/file.mp3")).To(BeTrue()) + }) + }) + + DescribeTable("pattern matching", + func(pattern string, path string, shouldMatch bool) { + fsys := fstest.MapFS{ + ".ndignore": &fstest.MapFile{Data: []byte(pattern)}, + } + ic = newIgnoreChecker(fsys) + err := ic.Push(ctx, ".") + Expect(err).ToNot(HaveOccurred()) + Expect(ic.ShouldIgnore(ctx, path)).To(Equal(shouldMatch)) + }, + Entry("glob match", "*.txt", "file.txt", true), + Entry("glob no match", "*.txt", "file.mp3", false), + Entry("directory pattern match", "tmp/", "tmp/file.txt", true), + Entry("directory pattern no match", "tmp/", "temporary/file.txt", false), + Entry("nested glob match", "**/*.log", "deep/nested/file.log", true), + Entry("nested glob no match", "**/*.log", "deep/nested/file.txt", false), + Entry("specific file match", "ignore.me", "ignore.me", true), + Entry("specific file no match", "ignore.me", "keep.me", false), + Entry("wildcard all", "**/*", "any/path/file.txt", true), + Entry("nested specific match", "temp/*", "temp/cache.db", true), + Entry("nested specific no match", "temp/*", "temporary/cache.db", false), + ) + + Context("with multiple patterns", func() { + BeforeEach(func() { + fsys := fstest.MapFS{ + ".ndignore": &fstest.MapFile{Data: []byte("*.txt\n*.log\ntemp/")}, + } + ic = newIgnoreChecker(fsys) + err := ic.Push(ctx, ".") + Expect(err).ToNot(HaveOccurred()) + }) + + It("should match any of the patterns", func() { + Expect(ic.ShouldIgnore(ctx, "file.txt")).To(BeTrue()) + Expect(ic.ShouldIgnore(ctx, "debug.log")).To(BeTrue()) + Expect(ic.ShouldIgnore(ctx, "temp/cache")).To(BeTrue()) + Expect(ic.ShouldIgnore(ctx, "music.mp3")).To(BeFalse()) + }) + }) + }) +}) diff --git a/scanner/metadata_old/metadata.go b/scanner/metadata_old/metadata.go index 6530ee8d1..3ccbd8961 100644 --- a/scanner/metadata_old/metadata.go +++ b/scanner/metadata_old/metadata.go @@ -215,8 +215,8 @@ func (t Tags) Lyrics() string { } for tag, value := range t.Tags { - if strings.HasPrefix(tag, "lyrics-") { - language := strings.TrimSpace(strings.TrimPrefix(tag, "lyrics-")) + if after, ok := strings.CutPrefix(tag, "lyrics-"); ok { + language := strings.TrimSpace(after) if language == "" { language = "xxx" diff --git a/scanner/phase_1_folders.go b/scanner/phase_1_folders.go index e04f10c70..38967832c 100644 --- a/scanner/phase_1_folders.go +++ b/scanner/phase_1_folders.go @@ -26,58 +26,46 @@ import ( "github.com/navidrome/navidrome/utils/slice" ) -func createPhaseFolders(ctx context.Context, state *scanState, ds model.DataStore, cw artwork.CacheWarmer, libs []model.Library) *phaseFolders { +func createPhaseFolders(ctx context.Context, state *scanState, ds model.DataStore, cw artwork.CacheWarmer) *phaseFolders { var jobs []*scanJob - var updatedLibs []model.Library - for _, lib := range libs { - if lib.LastScanStartedAt.IsZero() { - err := ds.Library(ctx).ScanBegin(lib.ID, state.fullScan) - if err != nil { - log.Error(ctx, "Scanner: Error updating last scan started at", "lib", lib.Name, err) - state.sendWarning(err.Error()) - continue - } - // Reload library to get updated state - l, err := ds.Library(ctx).Get(lib.ID) - if err != nil { - log.Error(ctx, "Scanner: Error reloading library", "lib", lib.Name, err) - state.sendWarning(err.Error()) - continue - } - lib = *l - } else { - log.Debug(ctx, "Scanner: Resuming previous scan", "lib", lib.Name, "lastScanStartedAt", lib.LastScanStartedAt, "fullScan", lib.FullScanInProgress) + + // Create scan jobs for all libraries + for _, lib := range state.libraries { + // Get target folders for this library if selective scan + var targetFolders []string + if state.isSelectiveScan() { + targetFolders = state.targets[lib.ID] } - job, err := newScanJob(ctx, ds, cw, lib, state.fullScan) + + job, err := newScanJob(ctx, ds, cw, lib, state.fullScan, targetFolders) if err != nil { log.Error(ctx, "Scanner: Error creating scan context", "lib", lib.Name, err) - state.sendWarning(err.Error()) + state.sendError(err) continue } jobs = append(jobs, job) - updatedLibs = append(updatedLibs, lib) } - // Update the state with the libraries that have been processed and have their scan timestamps set - state.libraries = updatedLibs - return &phaseFolders{jobs: jobs, ctx: ctx, ds: ds, state: state} } type scanJob struct { - lib model.Library - fs storage.MusicFS - cw artwork.CacheWarmer - lastUpdates map[string]model.FolderUpdateInfo - lock sync.Mutex - numFolders atomic.Int64 + lib model.Library + fs storage.MusicFS + cw artwork.CacheWarmer + lastUpdates map[string]model.FolderUpdateInfo // Holds last update info for all (DB) folders in this library + targetFolders []string // Specific folders to scan (including all descendants) + lock sync.Mutex + numFolders atomic.Int64 } -func newScanJob(ctx context.Context, ds model.DataStore, cw artwork.CacheWarmer, lib model.Library, fullScan bool) (*scanJob, error) { - lastUpdates, err := ds.Folder(ctx).GetLastUpdates(lib) +func newScanJob(ctx context.Context, ds model.DataStore, cw artwork.CacheWarmer, lib model.Library, fullScan bool, targetFolders []string) (*scanJob, error) { + // Get folder updates, optionally filtered to specific target folders + lastUpdates, err := ds.Folder(ctx).GetFolderUpdateInfo(lib, targetFolders...) if err != nil { return nil, fmt.Errorf("getting last updates: %w", err) } + fileStore, err := storage.For(lib.Path) if err != nil { log.Error(ctx, "Error getting storage for library", "library", lib.Name, "path", lib.Path, err) @@ -88,15 +76,23 @@ func newScanJob(ctx context.Context, ds model.DataStore, cw artwork.CacheWarmer, log.Error(ctx, "Error getting fs for library", "library", lib.Name, "path", lib.Path, err) return nil, fmt.Errorf("getting fs for library: %w", err) } + + // Ensure FullScanInProgress reflects the current scan request. + // This is important when resuming an interrupted quick scan as a full scan: + // the DB may have FullScanInProgress=false, but we need it true for isOutdated() to work correctly. lib.FullScanInProgress = lib.FullScanInProgress || fullScan + return &scanJob{ - lib: lib, - fs: fsys, - cw: cw, - lastUpdates: lastUpdates, + lib: lib, + fs: fsys, + cw: cw, + lastUpdates: lastUpdates, + targetFolders: targetFolders, }, nil } +// popLastUpdate retrieves and removes the last update info for the given folder ID +// This is used to track which folders have been found during the walk_dir_tree func (j *scanJob) popLastUpdate(folderID string) model.FolderUpdateInfo { j.lock.Lock() defer j.lock.Unlock() @@ -106,6 +102,15 @@ func (j *scanJob) popLastUpdate(folderID string) model.FolderUpdateInfo { return lastUpdate } +// createFolderEntry creates a new folderEntry for the given path, using the last update info from the job +// to populate the previous update time and hash. It also removes the folder from the job's lastUpdates map. +// This is used to track which folders have been found during the walk_dir_tree. +func (j *scanJob) createFolderEntry(path string) *folderEntry { + id := model.FolderID(j.lib, path) + info := j.popLastUpdate(id) + return newFolderEntry(j, id, path, info.UpdatedAt, info.Hash) +} + // phaseFolders represents the first phase of the scanning process, which is responsible // for scanning all libraries and importing new or updated files. This phase involves // traversing the directory tree of each library, identifying new or modified media files, @@ -144,7 +149,8 @@ func (p *phaseFolders) producer() ppl.Producer[*folderEntry] { if utils.IsCtxDone(p.ctx) { break } - outputChan, err := walkDirTree(p.ctx, job) + + outputChan, err := walkDirTree(p.ctx, job, job.targetFolders...) if err != nil { log.Warn(p.ctx, "Scanner: Error scanning library", "lib", job.lib.Name, err) } @@ -324,6 +330,9 @@ func (p *phaseFolders) persistChanges(entry *folderEntry) (*folderEntry, error) defer p.measure(entry)() p.state.changesDetected.Store(true) + // Collect artwork IDs to pre-cache after the transaction commits + var artworkIDs []model.ArtworkID + err := p.ds.WithTx(func(tx model.DataStore) error { // Instantiate all repositories just once per folder folderRepo := tx.Folder(p.ctx) @@ -362,7 +371,7 @@ func (p *phaseFolders) persistChanges(entry *folderEntry) (*folderEntry, error) return err } if entry.artists[i].Name != consts.UnknownArtist && entry.artists[i].Name != consts.VariousArtists { - entry.job.cw.PreCache(entry.artists[i].CoverArtID()) + artworkIDs = append(artworkIDs, entry.artists[i].CoverArtID()) } } @@ -374,7 +383,7 @@ func (p *phaseFolders) persistChanges(entry *folderEntry) (*folderEntry, error) return err } if entry.albums[i].Name != consts.UnknownAlbum { - entry.job.cw.PreCache(entry.albums[i].CoverArtID()) + artworkIDs = append(artworkIDs, entry.albums[i].CoverArtID()) } } @@ -411,6 +420,14 @@ func (p *phaseFolders) persistChanges(entry *folderEntry) (*folderEntry, error) if err != nil { log.Error(p.ctx, "Scanner: Error persisting changes to DB", "folder", entry.path, err) } + + // Pre-cache artwork after the transaction commits successfully + if err == nil { + for _, artID := range artworkIDs { + entry.job.cw.PreCache(artID) + } + } + return entry, err } diff --git a/scanner/phase_2_missing_tracks.go b/scanner/phase_2_missing_tracks.go index a6c0e261e..8c258b833 100644 --- a/scanner/phase_2_missing_tracks.go +++ b/scanner/phase_2_missing_tracks.go @@ -2,6 +2,7 @@ package scanner import ( "context" + "errors" "fmt" "sync" "sync/atomic" @@ -69,9 +70,6 @@ func (p *phaseMissingTracks) produce(put func(tracks *missingTracks)) error { } } for _, lib := range p.state.libraries { - if lib.LastScanStartedAt.IsZero() { - continue - } log.Debug(p.ctx, "Scanner: Checking missing tracks", "libraryId", lib.ID, "libraryName", lib.Name) cursor, err := p.ds.MediaFile(p.ctx).GetMissingAndMatching(lib.ID) if err != nil { @@ -116,6 +114,10 @@ func (p *phaseMissingTracks) stages() []ppl.Stage[*missingTracks] { func (p *phaseMissingTracks) processMissingTracks(in *missingTracks) (*missingTracks, error) { hasMatches := false + // Track which matched entries have already been consumed, so each matched track + // is only used once. Without this, the same matched track could be paired with + // multiple missing tracks, creating duplicate records with the same path. + usedMatched := make(map[string]bool, len(in.matched)) for _, ms := range in.missing { var exactMatch model.MediaFile @@ -123,6 +125,9 @@ func (p *phaseMissingTracks) processMissingTracks(in *missingTracks) (*missingTr // Identify exact and equivalent matches for _, mt := range in.matched { + if usedMatched[mt.ID] { + continue + } if ms.Equals(mt) { exactMatch = mt break // Prioritize exact match @@ -140,13 +145,14 @@ func (p *phaseMissingTracks) processMissingTracks(in *missingTracks) (*missingTr log.Error(p.ctx, "Scanner: Error moving matched track", "missing", ms.Path, "movedTo", exactMatch.Path, "lib", in.lib.Name, err) return nil, err } + usedMatched[exactMatch.ID] = true p.totalMatched.Add(1) hasMatches = true continue } // If there is only one missing and one matched track, consider them equivalent (same PID) - if len(in.missing) == 1 && len(in.matched) == 1 { + if len(in.missing) == 1 && len(in.matched) == 1 && !usedMatched[in.matched[0].ID] { singleMatch := in.matched[0] log.Debug(p.ctx, "Scanner: Found track with same persistent ID in a new place", "missing", ms.Path, "movedTo", singleMatch.Path, "lib", in.lib.Name) err := p.moveMatched(singleMatch, ms) @@ -154,6 +160,7 @@ func (p *phaseMissingTracks) processMissingTracks(in *missingTracks) (*missingTr log.Error(p.ctx, "Scanner: Error updating matched track", "missing", ms.Path, "movedTo", singleMatch.Path, "lib", in.lib.Name, err) return nil, err } + usedMatched[singleMatch.ID] = true p.totalMatched.Add(1) hasMatches = true continue @@ -167,6 +174,7 @@ func (p *phaseMissingTracks) processMissingTracks(in *missingTracks) (*missingTr log.Error(p.ctx, "Scanner: Error updating matched track", "missing", ms.Path, "movedTo", equivalentMatch.Path, "lib", in.lib.Name, err) return nil, err } + usedMatched[equivalentMatch.ID] = true p.totalMatched.Add(1) hasMatches = true } @@ -190,6 +198,13 @@ func (p *phaseMissingTracks) processCrossLibraryMoves(in *missingTracks) (*missi return nil, nil } + // Skip cross-library move detection when only one library is configured + // since there are no other libraries to search in. + if p.state.totalLibraryCount == 1 { + log.Debug(p.ctx, "Scanner: Skipping cross-library move detection (single library)") + return in, nil + } + log.Debug(p.ctx, "Scanner: Processing cross-library moves", "pid", in.pid, "missing", len(in.missing), "lib", in.lib.Name) for _, missing := range in.missing { @@ -263,6 +278,10 @@ func (p *phaseMissingTracks) moveMatched(target, missing model.MediaFile) error oldAlbumID := missing.AlbumID newAlbumID := target.AlbumID + // Preserve the original created_at from the missing file, so moved tracks + // don't appear in "Recently Added" + target.CreatedAt = missing.CreatedAt + // Update the target media file with the missing file's ID. This effectively "moves" the track // to the new location while keeping its annotations and references intact. target.ID = missing.ID @@ -294,6 +313,14 @@ func (p *phaseMissingTracks) moveMatched(target, missing model.MediaFile) error log.Warn(p.ctx, "Scanner: Could not reassign album annotations", "from", oldAlbumID, "to", newAlbumID, err) } + // Keep created_at field from previous instance of the album, so moved albums + // don't appear in "Recently Added" + if err := tx.Album(p.ctx).CopyAttributes(oldAlbumID, newAlbumID, "created_at"); err != nil { + if !errors.Is(err, model.ErrNotFound) { + log.Warn(p.ctx, "Scanner: Could not copy album created_at", "from", oldAlbumID, "to", newAlbumID, err) + } + } + // Note: RefreshPlayCounts will be called in later phases, so we don't need to call it here p.processedAlbumAnnotations[newAlbumID] = true } diff --git a/scanner/phase_2_missing_tracks_test.go b/scanner/phase_2_missing_tracks_test.go index e709004c9..d54ceee40 100644 --- a/scanner/phase_2_missing_tracks_test.go +++ b/scanner/phase_2_missing_tracks_test.go @@ -29,7 +29,8 @@ var _ = Describe("phaseMissingTracks", func() { lr.SetData(model.Libraries{{ID: 1, LastScanStartedAt: time.Date(2021, 1, 1, 0, 0, 0, 0, time.UTC)}}) ds = &tests.MockDataStore{MockedMediaFile: mr, MockedLibrary: lr} state = &scanState{ - libraries: model.Libraries{{ID: 1, LastScanStartedAt: time.Date(2021, 1, 1, 0, 0, 0, 0, time.UTC)}}, + libraries: model.Libraries{{ID: 1, LastScanStartedAt: time.Date(2021, 1, 1, 0, 0, 0, 0, time.UTC)}}, + totalLibraryCount: 1, } phase = createPhaseMissingTracks(ctx, state, ds) }) @@ -240,6 +241,39 @@ var _ = Describe("phaseMissingTracks", func() { Expect(movedTrack.Size).To(Equal(missingTrack.Size)) }) + It("should not match the same target to multiple missing tracks (prevents duplicate paths)", func() { + // Simulate a scenario where two missing tracks from different locations have the same + // base filename and match the same newly imported track via IsEquivalent. + // Without deduplication, both missing tracks would be "moved" to the same target, + // creating two non-missing records with the same path. + missingTrack1 := model.MediaFile{ID: "1", PID: "A", Path: "old_dir1/song.mp3", Title: "title1", Size: 100} + missingTrack2 := model.MediaFile{ID: "2", PID: "A", Path: "old_dir2/song.mp3", Title: "title1", Size: 100} + matchedTrack := model.MediaFile{ID: "3", PID: "A", Path: "new_dir/song.mp3", Title: "title1", Size: 200} + + _ = ds.MediaFile(ctx).Put(&missingTrack1) + _ = ds.MediaFile(ctx).Put(&missingTrack2) + _ = ds.MediaFile(ctx).Put(&matchedTrack) + + in := &missingTracks{ + missing: []model.MediaFile{missingTrack1, missingTrack2}, + matched: []model.MediaFile{matchedTrack}, + } + + _, err := phase.processMissingTracks(in) + Expect(err).ToNot(HaveOccurred()) + // Only one of the missing tracks should be matched + Expect(phase.totalMatched.Load()).To(Equal(uint32(1))) + Expect(state.changesDetected.Load()).To(BeTrue()) + + // The matched track should have been consumed by the first missing track + movedTrack, _ := ds.MediaFile(ctx).Get("1") + Expect(movedTrack.Path).To(Equal(matchedTrack.Path)) + + // The second missing track should remain unchanged + unmatchedTrack, _ := ds.MediaFile(ctx).Get("2") + Expect(unmatchedTrack.Path).To(Equal(missingTrack2.Path)) + }) + It("should return an error when there's an error moving the matched track", func() { missingTrack := model.MediaFile{ID: "1", PID: "A", Path: "path1.mp3", Tags: model.Tags{"title": []string{"title1"}}} matchedTrack := model.MediaFile{ID: "2", PID: "A", Path: "path1.mp3", Tags: model.Tags{"title": []string{"title1"}}} @@ -330,8 +364,10 @@ var _ = Describe("phaseMissingTracks", func() { Expect(result).To(BeNil()) }) - It("should process cross-library moves using MusicBrainz Track ID", func() { - scanStartTime := time.Now().Add(-1 * time.Hour) + It("should skip cross-library move detection when only one library is configured", func() { + // Default BeforeEach sets up single library, so we just need to verify skip behavior + Expect(state.totalLibraryCount).To(Equal(1)) + missingTrack := model.MediaFile{ ID: "missing1", LibraryID: 1, @@ -341,329 +377,6 @@ var _ = Describe("phaseMissingTracks", func() { Suffix: "mp3", Path: "/lib1/track.mp3", Missing: true, - CreatedAt: scanStartTime.Add(-30 * time.Minute), - } - - movedTrack := model.MediaFile{ - ID: "moved1", - LibraryID: 2, - MbzReleaseTrackID: "mbz-track-123", - Title: "Test Track", - Size: 1000, - Suffix: "mp3", - Path: "/lib2/track.mp3", - Missing: false, - CreatedAt: scanStartTime.Add(-10 * time.Minute), - } - - _ = ds.MediaFile(ctx).Put(&missingTrack) - _ = ds.MediaFile(ctx).Put(&movedTrack) - - in := &missingTracks{ - lib: model.Library{ID: 1, Name: "Library 1"}, - missing: []model.MediaFile{missingTrack}, - } - - result, err := phase.processCrossLibraryMoves(in) - Expect(err).ToNot(HaveOccurred()) - Expect(result).To(Equal(in)) - Expect(phase.totalMatched.Load()).To(Equal(uint32(1))) - Expect(state.changesDetected.Load()).To(BeTrue()) - - // Verify the move was performed - updatedTrack, _ := ds.MediaFile(ctx).Get("missing1") - Expect(updatedTrack.Path).To(Equal("/lib2/track.mp3")) - Expect(updatedTrack.LibraryID).To(Equal(2)) - }) - - It("should fall back to intrinsic properties when MBZ Track ID is empty", func() { - scanStartTime := time.Now().Add(-1 * time.Hour) - missingTrack := model.MediaFile{ - ID: "missing2", - LibraryID: 1, - MbzReleaseTrackID: "", - Title: "Test Track 2", - Size: 2000, - Suffix: "flac", - DiscNumber: 1, - TrackNumber: 1, - Album: "Test Album", - Path: "/lib1/track2.flac", - Missing: true, - CreatedAt: scanStartTime.Add(-30 * time.Minute), - } - - movedTrack := model.MediaFile{ - ID: "moved2", - LibraryID: 2, - MbzReleaseTrackID: "", - Title: "Test Track 2", - Size: 2000, - Suffix: "flac", - DiscNumber: 1, - TrackNumber: 1, - Album: "Test Album", - Path: "/lib2/track2.flac", - Missing: false, - CreatedAt: scanStartTime.Add(-10 * time.Minute), - } - - _ = ds.MediaFile(ctx).Put(&missingTrack) - _ = ds.MediaFile(ctx).Put(&movedTrack) - - in := &missingTracks{ - lib: model.Library{ID: 1, Name: "Library 1"}, - missing: []model.MediaFile{missingTrack}, - } - - result, err := phase.processCrossLibraryMoves(in) - Expect(err).ToNot(HaveOccurred()) - Expect(result).To(Equal(in)) - Expect(phase.totalMatched.Load()).To(Equal(uint32(1))) - Expect(state.changesDetected.Load()).To(BeTrue()) - - // Verify the move was performed - updatedTrack, _ := ds.MediaFile(ctx).Get("missing2") - Expect(updatedTrack.Path).To(Equal("/lib2/track2.flac")) - Expect(updatedTrack.LibraryID).To(Equal(2)) - }) - - It("should not match files in the same library", func() { - scanStartTime := time.Now().Add(-1 * time.Hour) - missingTrack := model.MediaFile{ - ID: "missing3", - LibraryID: 1, - MbzReleaseTrackID: "mbz-track-456", - Title: "Test Track 3", - Size: 3000, - Suffix: "mp3", - Path: "/lib1/track3.mp3", - Missing: true, - CreatedAt: scanStartTime.Add(-30 * time.Minute), - } - - sameLibTrack := model.MediaFile{ - ID: "same1", - LibraryID: 1, // Same library - MbzReleaseTrackID: "mbz-track-456", - Title: "Test Track 3", - Size: 3000, - Suffix: "mp3", - Path: "/lib1/other/track3.mp3", - Missing: false, - CreatedAt: scanStartTime.Add(-10 * time.Minute), - } - - _ = ds.MediaFile(ctx).Put(&missingTrack) - _ = ds.MediaFile(ctx).Put(&sameLibTrack) - - in := &missingTracks{ - lib: model.Library{ID: 1, Name: "Library 1"}, - missing: []model.MediaFile{missingTrack}, - } - - result, err := phase.processCrossLibraryMoves(in) - Expect(err).ToNot(HaveOccurred()) - Expect(result).To(Equal(in)) - Expect(phase.totalMatched.Load()).To(Equal(uint32(0))) - Expect(state.changesDetected.Load()).To(BeFalse()) - }) - - It("should prioritize MBZ Track ID over intrinsic properties", func() { - scanStartTime := time.Now().Add(-1 * time.Hour) - missingTrack := model.MediaFile{ - ID: "missing4", - LibraryID: 1, - MbzReleaseTrackID: "mbz-track-789", - Title: "Test Track 4", - Size: 4000, - Suffix: "mp3", - Path: "/lib1/track4.mp3", - Missing: true, - CreatedAt: scanStartTime.Add(-30 * time.Minute), - } - - // Track with same MBZ ID - mbzTrack := model.MediaFile{ - ID: "mbz1", - LibraryID: 2, - MbzReleaseTrackID: "mbz-track-789", - Title: "Test Track 4", - Size: 4000, - Suffix: "mp3", - Path: "/lib2/track4.mp3", - Missing: false, - CreatedAt: scanStartTime.Add(-10 * time.Minute), - } - - // Track with same intrinsic properties but no MBZ ID - intrinsicTrack := model.MediaFile{ - ID: "intrinsic1", - LibraryID: 3, - MbzReleaseTrackID: "", - Title: "Test Track 4", - Size: 4000, - Suffix: "mp3", - DiscNumber: 1, - TrackNumber: 1, - Album: "Test Album", - Path: "/lib3/track4.mp3", - Missing: false, - CreatedAt: scanStartTime.Add(-5 * time.Minute), - } - - _ = ds.MediaFile(ctx).Put(&missingTrack) - _ = ds.MediaFile(ctx).Put(&mbzTrack) - _ = ds.MediaFile(ctx).Put(&intrinsicTrack) - - in := &missingTracks{ - lib: model.Library{ID: 1, Name: "Library 1"}, - missing: []model.MediaFile{missingTrack}, - } - - result, err := phase.processCrossLibraryMoves(in) - Expect(err).ToNot(HaveOccurred()) - Expect(result).To(Equal(in)) - Expect(phase.totalMatched.Load()).To(Equal(uint32(1))) - Expect(state.changesDetected.Load()).To(BeTrue()) - - // Verify the MBZ track was chosen (not the intrinsic one) - updatedTrack, _ := ds.MediaFile(ctx).Get("missing4") - Expect(updatedTrack.Path).To(Equal("/lib2/track4.mp3")) - Expect(updatedTrack.LibraryID).To(Equal(2)) - }) - - It("should handle equivalent matches correctly", func() { - scanStartTime := time.Now().Add(-1 * time.Hour) - missingTrack := model.MediaFile{ - ID: "missing5", - LibraryID: 1, - MbzReleaseTrackID: "", - Title: "Test Track 5", - Size: 5000, - Suffix: "mp3", - Path: "/lib1/path/track5.mp3", - Missing: true, - CreatedAt: scanStartTime.Add(-30 * time.Minute), - } - - // Equivalent match (same filename, different directory) - equivalentTrack := model.MediaFile{ - ID: "equiv1", - LibraryID: 2, - MbzReleaseTrackID: "", - Title: "Test Track 5", - Size: 5000, - Suffix: "mp3", - Path: "/lib2/different/track5.mp3", - Missing: false, - CreatedAt: scanStartTime.Add(-10 * time.Minute), - } - - _ = ds.MediaFile(ctx).Put(&missingTrack) - _ = ds.MediaFile(ctx).Put(&equivalentTrack) - - in := &missingTracks{ - lib: model.Library{ID: 1, Name: "Library 1"}, - missing: []model.MediaFile{missingTrack}, - } - - result, err := phase.processCrossLibraryMoves(in) - Expect(err).ToNot(HaveOccurred()) - Expect(result).To(Equal(in)) - Expect(phase.totalMatched.Load()).To(Equal(uint32(1))) - Expect(state.changesDetected.Load()).To(BeTrue()) - - // Verify the equivalent match was accepted - updatedTrack, _ := ds.MediaFile(ctx).Get("missing5") - Expect(updatedTrack.Path).To(Equal("/lib2/different/track5.mp3")) - Expect(updatedTrack.LibraryID).To(Equal(2)) - }) - - It("should skip matching when multiple matches are found but none are exact", func() { - scanStartTime := time.Now().Add(-1 * time.Hour) - missingTrack := model.MediaFile{ - ID: "missing6", - LibraryID: 1, - MbzReleaseTrackID: "", - Title: "Test Track 6", - Size: 6000, - Suffix: "mp3", - DiscNumber: 1, - TrackNumber: 1, - Album: "Test Album", - Path: "/lib1/track6.mp3", - Missing: true, - CreatedAt: scanStartTime.Add(-30 * time.Minute), - } - - // Multiple matches with different metadata (not exact matches) - match1 := model.MediaFile{ - ID: "match1", - LibraryID: 2, - MbzReleaseTrackID: "", - Title: "Test Track 6", - Size: 6000, - Suffix: "mp3", - DiscNumber: 1, - TrackNumber: 1, - Album: "Test Album", - Path: "/lib2/different_track.mp3", - Artist: "Different Artist", // This makes it non-exact - Missing: false, - CreatedAt: scanStartTime.Add(-10 * time.Minute), - } - - match2 := model.MediaFile{ - ID: "match2", - LibraryID: 3, - MbzReleaseTrackID: "", - Title: "Test Track 6", - Size: 6000, - Suffix: "mp3", - DiscNumber: 1, - TrackNumber: 1, - Album: "Test Album", - Path: "/lib3/another_track.mp3", - Artist: "Another Artist", // This makes it non-exact - Missing: false, - CreatedAt: scanStartTime.Add(-5 * time.Minute), - } - - _ = ds.MediaFile(ctx).Put(&missingTrack) - _ = ds.MediaFile(ctx).Put(&match1) - _ = ds.MediaFile(ctx).Put(&match2) - - in := &missingTracks{ - lib: model.Library{ID: 1, Name: "Library 1"}, - missing: []model.MediaFile{missingTrack}, - } - - result, err := phase.processCrossLibraryMoves(in) - Expect(err).ToNot(HaveOccurred()) - Expect(result).To(Equal(in)) - Expect(phase.totalMatched.Load()).To(Equal(uint32(0))) - Expect(state.changesDetected.Load()).To(BeFalse()) - - // Verify no move was performed - unchangedTrack, _ := ds.MediaFile(ctx).Get("missing6") - Expect(unchangedTrack.Path).To(Equal("/lib1/track6.mp3")) - Expect(unchangedTrack.LibraryID).To(Equal(1)) - }) - - It("should handle errors gracefully", func() { - // Set up mock to return error - mr.Err = true - - missingTrack := model.MediaFile{ - ID: "missing7", - LibraryID: 1, - MbzReleaseTrackID: "mbz-track-error", - Title: "Test Track 7", - Size: 7000, - Suffix: "mp3", - Path: "/lib1/track7.mp3", - Missing: true, CreatedAt: time.Now().Add(-30 * time.Minute), } @@ -672,13 +385,490 @@ var _ = Describe("phaseMissingTracks", func() { missing: []model.MediaFile{missingTrack}, } - // Should not fail completely, just skip the problematic file result, err := phase.processCrossLibraryMoves(in) Expect(err).ToNot(HaveOccurred()) + // Should return input unchanged (no processing done) Expect(result).To(Equal(in)) + // No matches should be found since cross-library search was skipped Expect(phase.totalMatched.Load()).To(Equal(uint32(0))) + // No changes should be detected Expect(state.changesDetected.Load()).To(BeFalse()) }) + + Context("with multiple libraries", func() { + BeforeEach(func() { + // Set up multiple libraries for cross-library move tests + state.libraries = model.Libraries{ + {ID: 1, LastScanStartedAt: time.Date(2021, 1, 1, 0, 0, 0, 0, time.UTC)}, + {ID: 2, LastScanStartedAt: time.Date(2021, 1, 1, 0, 0, 0, 0, time.UTC)}, + } + state.totalLibraryCount = 2 + }) + + It("should process cross-library moves using MusicBrainz Track ID", func() { + scanStartTime := time.Now().Add(-1 * time.Hour) + missingTrack := model.MediaFile{ + ID: "missing1", + LibraryID: 1, + MbzReleaseTrackID: "mbz-track-123", + Title: "Test Track", + Size: 1000, + Suffix: "mp3", + Path: "/lib1/track.mp3", + Missing: true, + CreatedAt: scanStartTime.Add(-30 * time.Minute), + } + + movedTrack := model.MediaFile{ + ID: "moved1", + LibraryID: 2, + MbzReleaseTrackID: "mbz-track-123", + Title: "Test Track", + Size: 1000, + Suffix: "mp3", + Path: "/lib2/track.mp3", + Missing: false, + CreatedAt: scanStartTime.Add(-10 * time.Minute), + } + + _ = ds.MediaFile(ctx).Put(&missingTrack) + _ = ds.MediaFile(ctx).Put(&movedTrack) + + in := &missingTracks{ + lib: model.Library{ID: 1, Name: "Library 1"}, + missing: []model.MediaFile{missingTrack}, + } + + result, err := phase.processCrossLibraryMoves(in) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(Equal(in)) + Expect(phase.totalMatched.Load()).To(Equal(uint32(1))) + Expect(state.changesDetected.Load()).To(BeTrue()) + + // Verify the move was performed + updatedTrack, _ := ds.MediaFile(ctx).Get("missing1") + Expect(updatedTrack.Path).To(Equal("/lib2/track.mp3")) + Expect(updatedTrack.LibraryID).To(Equal(2)) + }) + + It("should fall back to intrinsic properties when MBZ Track ID is empty", func() { + scanStartTime := time.Now().Add(-1 * time.Hour) + missingTrack := model.MediaFile{ + ID: "missing2", + LibraryID: 1, + MbzReleaseTrackID: "", + Title: "Test Track 2", + Size: 2000, + Suffix: "flac", + DiscNumber: 1, + TrackNumber: 1, + Album: "Test Album", + Path: "/lib1/track2.flac", + Missing: true, + CreatedAt: scanStartTime.Add(-30 * time.Minute), + } + + movedTrack := model.MediaFile{ + ID: "moved2", + LibraryID: 2, + MbzReleaseTrackID: "", + Title: "Test Track 2", + Size: 2000, + Suffix: "flac", + DiscNumber: 1, + TrackNumber: 1, + Album: "Test Album", + Path: "/lib2/track2.flac", + Missing: false, + CreatedAt: scanStartTime.Add(-10 * time.Minute), + } + + _ = ds.MediaFile(ctx).Put(&missingTrack) + _ = ds.MediaFile(ctx).Put(&movedTrack) + + in := &missingTracks{ + lib: model.Library{ID: 1, Name: "Library 1"}, + missing: []model.MediaFile{missingTrack}, + } + + result, err := phase.processCrossLibraryMoves(in) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(Equal(in)) + Expect(phase.totalMatched.Load()).To(Equal(uint32(1))) + Expect(state.changesDetected.Load()).To(BeTrue()) + + // Verify the move was performed + updatedTrack, _ := ds.MediaFile(ctx).Get("missing2") + Expect(updatedTrack.Path).To(Equal("/lib2/track2.flac")) + Expect(updatedTrack.LibraryID).To(Equal(2)) + }) + + It("should not match files in the same library", func() { + scanStartTime := time.Now().Add(-1 * time.Hour) + missingTrack := model.MediaFile{ + ID: "missing3", + LibraryID: 1, + MbzReleaseTrackID: "mbz-track-456", + Title: "Test Track 3", + Size: 3000, + Suffix: "mp3", + Path: "/lib1/track3.mp3", + Missing: true, + CreatedAt: scanStartTime.Add(-30 * time.Minute), + } + + sameLibTrack := model.MediaFile{ + ID: "same1", + LibraryID: 1, // Same library + MbzReleaseTrackID: "mbz-track-456", + Title: "Test Track 3", + Size: 3000, + Suffix: "mp3", + Path: "/lib1/other/track3.mp3", + Missing: false, + CreatedAt: scanStartTime.Add(-10 * time.Minute), + } + + _ = ds.MediaFile(ctx).Put(&missingTrack) + _ = ds.MediaFile(ctx).Put(&sameLibTrack) + + in := &missingTracks{ + lib: model.Library{ID: 1, Name: "Library 1"}, + missing: []model.MediaFile{missingTrack}, + } + + result, err := phase.processCrossLibraryMoves(in) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(Equal(in)) + Expect(phase.totalMatched.Load()).To(Equal(uint32(0))) + Expect(state.changesDetected.Load()).To(BeFalse()) + }) + + It("should prioritize MBZ Track ID over intrinsic properties", func() { + scanStartTime := time.Now().Add(-1 * time.Hour) + missingTrack := model.MediaFile{ + ID: "missing4", + LibraryID: 1, + MbzReleaseTrackID: "mbz-track-789", + Title: "Test Track 4", + Size: 4000, + Suffix: "mp3", + Path: "/lib1/track4.mp3", + Missing: true, + CreatedAt: scanStartTime.Add(-30 * time.Minute), + } + + // Track with same MBZ ID + mbzTrack := model.MediaFile{ + ID: "mbz1", + LibraryID: 2, + MbzReleaseTrackID: "mbz-track-789", + Title: "Test Track 4", + Size: 4000, + Suffix: "mp3", + Path: "/lib2/track4.mp3", + Missing: false, + CreatedAt: scanStartTime.Add(-10 * time.Minute), + } + + // Track with same intrinsic properties but no MBZ ID + intrinsicTrack := model.MediaFile{ + ID: "intrinsic1", + LibraryID: 3, + MbzReleaseTrackID: "", + Title: "Test Track 4", + Size: 4000, + Suffix: "mp3", + DiscNumber: 1, + TrackNumber: 1, + Album: "Test Album", + Path: "/lib3/track4.mp3", + Missing: false, + CreatedAt: scanStartTime.Add(-5 * time.Minute), + } + + _ = ds.MediaFile(ctx).Put(&missingTrack) + _ = ds.MediaFile(ctx).Put(&mbzTrack) + _ = ds.MediaFile(ctx).Put(&intrinsicTrack) + + in := &missingTracks{ + lib: model.Library{ID: 1, Name: "Library 1"}, + missing: []model.MediaFile{missingTrack}, + } + + result, err := phase.processCrossLibraryMoves(in) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(Equal(in)) + Expect(phase.totalMatched.Load()).To(Equal(uint32(1))) + Expect(state.changesDetected.Load()).To(BeTrue()) + + // Verify the MBZ track was chosen (not the intrinsic one) + updatedTrack, _ := ds.MediaFile(ctx).Get("missing4") + Expect(updatedTrack.Path).To(Equal("/lib2/track4.mp3")) + Expect(updatedTrack.LibraryID).To(Equal(2)) + }) + + It("should handle equivalent matches correctly", func() { + scanStartTime := time.Now().Add(-1 * time.Hour) + missingTrack := model.MediaFile{ + ID: "missing5", + LibraryID: 1, + MbzReleaseTrackID: "", + Title: "Test Track 5", + Size: 5000, + Suffix: "mp3", + Path: "/lib1/path/track5.mp3", + Missing: true, + CreatedAt: scanStartTime.Add(-30 * time.Minute), + } + + // Equivalent match (same filename, different directory) + equivalentTrack := model.MediaFile{ + ID: "equiv1", + LibraryID: 2, + MbzReleaseTrackID: "", + Title: "Test Track 5", + Size: 5000, + Suffix: "mp3", + Path: "/lib2/different/track5.mp3", + Missing: false, + CreatedAt: scanStartTime.Add(-10 * time.Minute), + } + + _ = ds.MediaFile(ctx).Put(&missingTrack) + _ = ds.MediaFile(ctx).Put(&equivalentTrack) + + in := &missingTracks{ + lib: model.Library{ID: 1, Name: "Library 1"}, + missing: []model.MediaFile{missingTrack}, + } + + result, err := phase.processCrossLibraryMoves(in) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(Equal(in)) + Expect(phase.totalMatched.Load()).To(Equal(uint32(1))) + Expect(state.changesDetected.Load()).To(BeTrue()) + + // Verify the equivalent match was accepted + updatedTrack, _ := ds.MediaFile(ctx).Get("missing5") + Expect(updatedTrack.Path).To(Equal("/lib2/different/track5.mp3")) + Expect(updatedTrack.LibraryID).To(Equal(2)) + }) + + It("should skip matching when multiple matches are found but none are exact", func() { + scanStartTime := time.Now().Add(-1 * time.Hour) + missingTrack := model.MediaFile{ + ID: "missing6", + LibraryID: 1, + MbzReleaseTrackID: "", + Title: "Test Track 6", + Size: 6000, + Suffix: "mp3", + DiscNumber: 1, + TrackNumber: 1, + Album: "Test Album", + Path: "/lib1/track6.mp3", + Missing: true, + CreatedAt: scanStartTime.Add(-30 * time.Minute), + } + + // Multiple matches with different metadata (not exact matches) + match1 := model.MediaFile{ + ID: "match1", + LibraryID: 2, + MbzReleaseTrackID: "", + Title: "Test Track 6", + Size: 6000, + Suffix: "mp3", + DiscNumber: 1, + TrackNumber: 1, + Album: "Test Album", + Path: "/lib2/different_track.mp3", + Artist: "Different Artist", // This makes it non-exact + Missing: false, + CreatedAt: scanStartTime.Add(-10 * time.Minute), + } + + match2 := model.MediaFile{ + ID: "match2", + LibraryID: 3, + MbzReleaseTrackID: "", + Title: "Test Track 6", + Size: 6000, + Suffix: "mp3", + DiscNumber: 1, + TrackNumber: 1, + Album: "Test Album", + Path: "/lib3/another_track.mp3", + Artist: "Another Artist", // This makes it non-exact + Missing: false, + CreatedAt: scanStartTime.Add(-5 * time.Minute), + } + + _ = ds.MediaFile(ctx).Put(&missingTrack) + _ = ds.MediaFile(ctx).Put(&match1) + _ = ds.MediaFile(ctx).Put(&match2) + + in := &missingTracks{ + lib: model.Library{ID: 1, Name: "Library 1"}, + missing: []model.MediaFile{missingTrack}, + } + + result, err := phase.processCrossLibraryMoves(in) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(Equal(in)) + Expect(phase.totalMatched.Load()).To(Equal(uint32(0))) + Expect(state.changesDetected.Load()).To(BeFalse()) + + // Verify no move was performed + unchangedTrack, _ := ds.MediaFile(ctx).Get("missing6") + Expect(unchangedTrack.Path).To(Equal("/lib1/track6.mp3")) + Expect(unchangedTrack.LibraryID).To(Equal(1)) + }) + + It("should handle errors gracefully", func() { + // Set up mock to return error + mr.Err = true + + missingTrack := model.MediaFile{ + ID: "missing7", + LibraryID: 1, + MbzReleaseTrackID: "mbz-track-error", + Title: "Test Track 7", + Size: 7000, + Suffix: "mp3", + Path: "/lib1/track7.mp3", + Missing: true, + CreatedAt: time.Now().Add(-30 * time.Minute), + } + + in := &missingTracks{ + lib: model.Library{ID: 1, Name: "Library 1"}, + missing: []model.MediaFile{missingTrack}, + } + + // Should not fail completely, just skip the problematic file + result, err := phase.processCrossLibraryMoves(in) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(Equal(in)) + Expect(phase.totalMatched.Load()).To(Equal(uint32(0))) + Expect(state.changesDetected.Load()).To(BeFalse()) + }) + }) // End of Context "with multiple libraries" + }) + + Describe("CreatedAt preservation (#5050)", func() { + var albumRepo *tests.MockAlbumRepo + + BeforeEach(func() { + albumRepo = ds.Album(ctx).(*tests.MockAlbumRepo) + albumRepo.ReassignAnnotationCalls = make(map[string]string) + albumRepo.CopyAttributesCalls = make(map[string]string) + }) + + It("should preserve the missing track's created_at when moving within a library", func() { + originalTime := time.Date(2020, 3, 15, 10, 0, 0, 0, time.UTC) + missingTrack := model.MediaFile{ + ID: "1", PID: "A", Path: "old/song.mp3", + AlbumID: "album-1", + LibraryID: 1, + CreatedAt: originalTime, + Tags: model.Tags{"title": []string{"My Song"}}, + Size: 100, + } + matchedTrack := model.MediaFile{ + ID: "2", PID: "A", Path: "new/song.mp3", + AlbumID: "album-1", // Same album + LibraryID: 1, + CreatedAt: time.Now(), // Much newer + Tags: model.Tags{"title": []string{"My Song"}}, + Size: 100, + } + + _ = ds.MediaFile(ctx).Put(&missingTrack) + _ = ds.MediaFile(ctx).Put(&matchedTrack) + + in := &missingTracks{ + missing: []model.MediaFile{missingTrack}, + matched: []model.MediaFile{matchedTrack}, + } + + _, err := phase.processMissingTracks(in) + Expect(err).ToNot(HaveOccurred()) + + movedTrack, _ := ds.MediaFile(ctx).Get("1") + Expect(movedTrack.Path).To(Equal("new/song.mp3")) + Expect(movedTrack.CreatedAt).To(Equal(originalTime)) + }) + + It("should preserve created_at during cross-library moves with album change", func() { + originalTime := time.Date(2019, 6, 1, 12, 0, 0, 0, time.UTC) + missingTrack := model.MediaFile{ + ID: "missing-ca", PID: "B", Path: "lib1/song.mp3", + AlbumID: "old-album", + LibraryID: 1, + CreatedAt: originalTime, + } + matchedTrack := model.MediaFile{ + ID: "matched-ca", PID: "B", Path: "lib2/song.mp3", + AlbumID: "new-album", + LibraryID: 2, + CreatedAt: time.Now(), + } + + // Set up albums so CopyAttributes can find them + albumRepo.SetData(model.Albums{ + {ID: "old-album", LibraryID: 1, CreatedAt: originalTime}, + {ID: "new-album", LibraryID: 2, CreatedAt: time.Now()}, + }) + + _ = ds.MediaFile(ctx).Put(&missingTrack) + _ = ds.MediaFile(ctx).Put(&matchedTrack) + + err := phase.moveMatched(matchedTrack, missingTrack) + Expect(err).ToNot(HaveOccurred()) + + // Track's created_at should be preserved from the missing file + movedTrack, _ := ds.MediaFile(ctx).Get("missing-ca") + Expect(movedTrack.CreatedAt).To(Equal(originalTime)) + + // Album's created_at should be copied from old to new + Expect(albumRepo.CopyAttributesCalls).To(HaveKeyWithValue("old-album", "new-album")) + + // Verify the new album's CreatedAt was actually updated + newAlbum, err := albumRepo.Get("new-album") + Expect(err).ToNot(HaveOccurred()) + Expect(newAlbum.CreatedAt).To(Equal(originalTime)) + }) + + It("should not copy album created_at when album ID does not change", func() { + originalTime := time.Date(2020, 1, 1, 0, 0, 0, 0, time.UTC) + missingTrack := model.MediaFile{ + ID: "missing-same", PID: "C", Path: "dir1/song.mp3", + AlbumID: "same-album", + LibraryID: 1, + CreatedAt: originalTime, + } + matchedTrack := model.MediaFile{ + ID: "matched-same", PID: "C", Path: "dir2/song.mp3", + AlbumID: "same-album", // Same album + LibraryID: 1, + CreatedAt: time.Now(), + } + + _ = ds.MediaFile(ctx).Put(&missingTrack) + _ = ds.MediaFile(ctx).Put(&matchedTrack) + + err := phase.moveMatched(matchedTrack, missingTrack) + Expect(err).ToNot(HaveOccurred()) + + // Track's created_at should still be preserved + movedTrack, _ := ds.MediaFile(ctx).Get("missing-same") + Expect(movedTrack.CreatedAt).To(Equal(originalTime)) + + // CopyAttributes should NOT have been called (same album) + Expect(albumRepo.CopyAttributesCalls).To(BeEmpty()) + }) }) Describe("Album Annotation Reassignment", func() { diff --git a/scanner/phase_3_refresh_albums.go b/scanner/phase_3_refresh_albums.go index f51aa8f4b..33e0fed01 100644 --- a/scanner/phase_3_refresh_albums.go +++ b/scanner/phase_3_refresh_albums.go @@ -27,14 +27,13 @@ import ( type phaseRefreshAlbums struct { ds model.DataStore ctx context.Context - libs model.Libraries refreshed atomic.Uint32 skipped atomic.Uint32 state *scanState } -func createPhaseRefreshAlbums(ctx context.Context, state *scanState, ds model.DataStore, libs model.Libraries) *phaseRefreshAlbums { - return &phaseRefreshAlbums{ctx: ctx, ds: ds, libs: libs, state: state} +func createPhaseRefreshAlbums(ctx context.Context, state *scanState, ds model.DataStore) *phaseRefreshAlbums { + return &phaseRefreshAlbums{ctx: ctx, ds: ds, state: state} } func (p *phaseRefreshAlbums) description() string { @@ -47,7 +46,7 @@ func (p *phaseRefreshAlbums) producer() ppl.Producer[*model.Album] { func (p *phaseRefreshAlbums) produce(put func(album *model.Album)) error { count := 0 - for _, lib := range p.libs { + for _, lib := range p.state.libraries { cursor, err := p.ds.Album(p.ctx).GetTouchedAlbums(lib.ID) if err != nil { return fmt.Errorf("loading touched albums: %w", err) diff --git a/scanner/phase_3_refresh_albums_test.go b/scanner/phase_3_refresh_albums_test.go index dea2556f0..1f0baf428 100644 --- a/scanner/phase_3_refresh_albums_test.go +++ b/scanner/phase_3_refresh_albums_test.go @@ -32,8 +32,8 @@ var _ = Describe("phaseRefreshAlbums", func() { {ID: 1, Name: "Library 1"}, {ID: 2, Name: "Library 2"}, } - state = &scanState{} - phase = createPhaseRefreshAlbums(ctx, state, ds, libs) + state = &scanState{libraries: libs} + phase = createPhaseRefreshAlbums(ctx, state, ds) }) Describe("description", func() { diff --git a/scanner/phase_4_playlists.go b/scanner/phase_4_playlists.go index c98b51ee6..ab5f77ae0 100644 --- a/scanner/phase_4_playlists.go +++ b/scanner/phase_4_playlists.go @@ -10,8 +10,8 @@ import ( ppl "github.com/google/go-pipeline/pkg/pipeline" "github.com/navidrome/navidrome/conf" - "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/core/artwork" + "github.com/navidrome/navidrome/core/playlists" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/request" @@ -21,12 +21,12 @@ type phasePlaylists struct { ctx context.Context scanState *scanState ds model.DataStore - pls core.Playlists + pls playlists.Playlists cw artwork.CacheWarmer refreshed atomic.Uint32 } -func createPhasePlaylists(ctx context.Context, scanState *scanState, ds model.DataStore, pls core.Playlists, cw artwork.CacheWarmer) *phasePlaylists { +func createPhasePlaylists(ctx context.Context, scanState *scanState, ds model.DataStore, pls playlists.Playlists, cw artwork.CacheWarmer) *phasePlaylists { return &phasePlaylists{ ctx: ctx, scanState: scanState, diff --git a/scanner/phase_4_playlists_test.go b/scanner/phase_4_playlists_test.go index 218aa3c7b..0b50d39cb 100644 --- a/scanner/phase_4_playlists_test.go +++ b/scanner/phase_4_playlists_test.go @@ -9,8 +9,8 @@ import ( "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/conf/configtest" - "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/core/artwork" + "github.com/navidrome/navidrome/core/playlists" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/request" "github.com/navidrome/navidrome/tests" @@ -130,7 +130,7 @@ var _ = Describe("phasePlaylists", func() { type mockPlaylists struct { mock.Mock - core.Playlists + playlists.Playlists } func (p *mockPlaylists) ImportFile(ctx context.Context, folder *model.Folder, filename string) (*model.Playlist, error) { diff --git a/scanner/scanner.go b/scanner/scanner.go index 04a5c2456..871b0c696 100644 --- a/scanner/scanner.go +++ b/scanner/scanner.go @@ -3,32 +3,37 @@ package scanner import ( "context" "fmt" + "maps" + "slices" "sync/atomic" "time" ppl "github.com/google/go-pipeline/pkg/pipeline" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/consts" - "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/core/artwork" + "github.com/navidrome/navidrome/core/playlists" "github.com/navidrome/navidrome/db" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/utils/run" + "github.com/navidrome/navidrome/utils/slice" ) type scannerImpl struct { ds model.DataStore cw artwork.CacheWarmer - pls core.Playlists + pls playlists.Playlists } // scanState holds the state of an in-progress scan, to be passed to the various phases type scanState struct { - progress chan<- *ProgressInfo - fullScan bool - changesDetected atomic.Bool - libraries model.Libraries // Store libraries list for consistency across phases + progress chan<- *ProgressInfo + fullScan bool + changesDetected atomic.Bool + libraries model.Libraries // Store libraries list for consistency across phases + targets map[int][]string // Optional: map[libraryID][]folderPaths for selective scans + totalLibraryCount int // Total number of libraries (unfiltered), for cross-library move detection } func (s *scanState) sendProgress(info *ProgressInfo) { @@ -37,6 +42,10 @@ func (s *scanState) sendProgress(info *ProgressInfo) { } } +func (s *scanState) isSelectiveScan() bool { + return len(s.targets) > 0 +} + func (s *scanState) sendWarning(msg string) { s.sendProgress(&ProgressInfo{Warning: msg}) } @@ -45,7 +54,7 @@ func (s *scanState) sendError(err error) { s.sendProgress(&ProgressInfo{Error: err.Error()}) } -func (s *scannerImpl) scanAll(ctx context.Context, fullScan bool, progress chan<- *ProgressInfo) { +func (s *scannerImpl) scanFolders(ctx context.Context, fullScan bool, targets []model.ScanTarget, progress chan<- *ProgressInfo) { startTime := time.Now() state := scanState{ @@ -59,38 +68,76 @@ func (s *scannerImpl) scanAll(ctx context.Context, fullScan bool, progress chan< state.changesDetected.Store(true) } - libs, err := s.ds.Library(ctx).GetAll() + // Get libraries and optionally filter by targets + allLibs, err := s.ds.Library(ctx).GetAll() if err != nil { state.sendWarning(fmt.Sprintf("getting libraries: %s", err)) return } - state.libraries = libs + state.totalLibraryCount = len(allLibs) - log.Info(ctx, "Scanner: Starting scan", "fullScan", state.fullScan, "numLibraries", len(libs)) + if len(targets) > 0 { + // Selective scan: filter libraries and build targets map + state.targets = make(map[int][]string) + + for _, target := range targets { + folderPath := target.FolderPath + if folderPath == "" { + folderPath = "." + } + state.targets[target.LibraryID] = append(state.targets[target.LibraryID], folderPath) + } + + // Filter libraries to only those in targets + state.libraries = slice.Filter(allLibs, func(lib model.Library) bool { + return len(state.targets[lib.ID]) > 0 + }) + + log.Info(ctx, "Scanner: Starting selective scan", "fullScan", state.fullScan, "numLibraries", len(state.libraries), "numTargets", len(targets)) + } else { + // Full library scan + state.libraries = allLibs + log.Info(ctx, "Scanner: Starting scan", "fullScan", state.fullScan, "numLibraries", len(state.libraries)) + } // Store scan type and start time scanType := "quick" if state.fullScan { scanType = "full" } + if state.isSelectiveScan() { + scanType += "-selective" + } _ = s.ds.Property(ctx).Put(consts.LastScanTypeKey, scanType) _ = s.ds.Property(ctx).Put(consts.LastScanStartTimeKey, startTime.Format(time.RFC3339)) // if there was a full scan in progress, force a full scan if !state.fullScan { - for _, lib := range libs { + for _, lib := range state.libraries { if lib.FullScanInProgress { log.Info(ctx, "Scanner: Interrupted full scan detected", "lib", lib.Name) state.fullScan = true - _ = s.ds.Property(ctx).Put(consts.LastScanTypeKey, "full") + if state.isSelectiveScan() { + _ = s.ds.Property(ctx).Put(consts.LastScanTypeKey, "full-selective") + } else { + _ = s.ds.Property(ctx).Put(consts.LastScanTypeKey, "full") + } break } } } + // Prepare libraries for scanning (initialize LastScanStartedAt if needed) + err = s.prepareLibrariesForScan(ctx, &state) + if err != nil { + log.Error(ctx, "Scanner: Error preparing libraries for scan", err) + state.sendError(err) + return + } + err = run.Sequentially( // Phase 1: Scan all libraries and import new/updated files - runPhase[*folderEntry](ctx, 1, createPhaseFolders(ctx, &state, s.ds, s.cw, libs)), + runPhase[*folderEntry](ctx, 1, createPhaseFolders(ctx, &state, s.ds, s.cw)), // Phase 2: Process missing files, checking for moves runPhase[*missingTracks](ctx, 2, createPhaseMissingTracks(ctx, &state, s.ds)), @@ -98,7 +145,7 @@ func (s *scannerImpl) scanAll(ctx context.Context, fullScan bool, progress chan< // Phases 3 and 4 can be run in parallel run.Parallel( // Phase 3: Refresh all new/changed albums and update artists - runPhase[*model.Album](ctx, 3, createPhaseRefreshAlbums(ctx, &state, s.ds, libs)), + runPhase[*model.Album](ctx, 3, createPhaseRefreshAlbums(ctx, &state, s.ds)), // Phase 4: Import/update playlists runPhase[*model.Folder](ctx, 4, createPhasePlaylists(ctx, &state, s.ds, s.pls, s.cw)), @@ -131,7 +178,53 @@ func (s *scannerImpl) scanAll(ctx context.Context, fullScan bool, progress chan< state.sendProgress(&ProgressInfo{ChangesDetected: true}) } - log.Info(ctx, "Scanner: Finished scanning all libraries", "duration", time.Since(startTime)) + if state.isSelectiveScan() { + log.Info(ctx, "Scanner: Finished scanning selected folders", "duration", time.Since(startTime), "numTargets", len(targets)) + } else { + log.Info(ctx, "Scanner: Finished scanning all libraries", "duration", time.Since(startTime)) + } +} + +// prepareLibrariesForScan initializes the scan for all libraries in the state. +// It calls ScanBegin for libraries that haven't started scanning yet (LastScanStartedAt is zero), +// reloads them to get the updated state, and filters out any libraries that fail to initialize. +func (s *scannerImpl) prepareLibrariesForScan(ctx context.Context, state *scanState) error { + var successfulLibs []model.Library + + for _, lib := range state.libraries { + if lib.LastScanStartedAt.IsZero() { + // This is a new scan - mark it as started + err := s.ds.Library(ctx).ScanBegin(lib.ID, state.fullScan) + if err != nil { + log.Error(ctx, "Scanner: Error marking scan start", "lib", lib.Name, err) + state.sendWarning(err.Error()) + continue + } + + // Reload library to get updated state (timestamps, etc.) + reloadedLib, err := s.ds.Library(ctx).Get(lib.ID) + if err != nil { + log.Error(ctx, "Scanner: Error reloading library", "lib", lib.Name, err) + state.sendWarning(err.Error()) + continue + } + lib = *reloadedLib + } else { + // This is a resumed scan + log.Debug(ctx, "Scanner: Resuming previous scan", "lib", lib.Name, + "lastScanStartedAt", lib.LastScanStartedAt, "fullScan", lib.FullScanInProgress) + } + + successfulLibs = append(successfulLibs, lib) + } + + if len(successfulLibs) == 0 { + return fmt.Errorf("no libraries available for scanning") + } + + // Update state with only successfully initialized libraries + state.libraries = successfulLibs + return nil } func (s *scannerImpl) runGC(ctx context.Context, state *scanState) func() error { @@ -140,7 +233,15 @@ func (s *scannerImpl) runGC(ctx context.Context, state *scanState) func() error return s.ds.WithTx(func(tx model.DataStore) error { if state.changesDetected.Load() { start := time.Now() - err := tx.GC(ctx) + + // For selective scans, extract library IDs to scope GC operations + var libraryIDs []int + if state.isSelectiveScan() { + libraryIDs = slices.Collect(maps.Keys(state.targets)) + log.Debug(ctx, "Scanner: Running selective GC", "libraryIDs", libraryIDs) + } + + err := tx.GC(ctx, libraryIDs...) if err != nil { log.Error(ctx, "Scanner: Error running GC", err) return fmt.Errorf("running GC: %w", err) diff --git a/scanner/scanner_benchmark_test.go b/scanner/scanner_benchmark_test.go index 2b1c0a140..8f0dcd340 100644 --- a/scanner/scanner_benchmark_test.go +++ b/scanner/scanner_benchmark_test.go @@ -15,6 +15,7 @@ import ( "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/core/artwork" "github.com/navidrome/navidrome/core/metrics" + "github.com/navidrome/navidrome/core/playlists" "github.com/navidrome/navidrome/core/storage/storagetest" "github.com/navidrome/navidrome/db" "github.com/navidrome/navidrome/model" @@ -40,7 +41,7 @@ func BenchmarkScan(b *testing.B) { ds := persistence.New(db.Db()) conf.Server.DevExternalScanner = false s := scanner.New(context.Background(), ds, artwork.NoopCacheWarmer(), events.NoopBroker(), - core.NewPlaylists(ds), metrics.NewNoopInstance()) + playlists.NewPlaylists(ds, core.NewImageUploadService()), metrics.NewNoopInstance()) fs := storagetest.FakeFS{} storagetest.Register("fake", &fs) diff --git a/scanner/scanner_multilibrary_test.go b/scanner/scanner_multilibrary_test.go index f27ad52fc..856015239 100644 --- a/scanner/scanner_multilibrary_test.go +++ b/scanner/scanner_multilibrary_test.go @@ -14,6 +14,7 @@ import ( "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/core/artwork" "github.com/navidrome/navidrome/core/metrics" + "github.com/navidrome/navidrome/core/playlists" "github.com/navidrome/navidrome/core/storage/storagetest" "github.com/navidrome/navidrome/db" "github.com/navidrome/navidrome/log" @@ -32,7 +33,7 @@ var _ = Describe("Scanner - Multi-Library", Ordered, func() { var ctx context.Context var lib1, lib2 model.Library var ds *tests.MockDataStore - var s scanner.Scanner + var s model.Scanner createFS := func(path string, files fstest.MapFS) storagetest.FakeFS { fs := storagetest.FakeFS{} @@ -51,8 +52,14 @@ var _ = Describe("Scanner - Multi-Library", Ordered, func() { BeforeEach(func() { DeferCleanup(configtest.SetupConfig()) + conf.Server.MusicFolder = "default:///music" // Use a distinct schema for the default library conf.Server.DevExternalScanner = false + // Register an empty fake storage for the default library + emptyFS := storagetest.FakeFS{} + emptyFS.SetFiles(fstest.MapFS{}) + storagetest.Register("default", &emptyFS) + db.Init(ctx) DeferCleanup(func() { Expect(tests.ClearDB()).To(Succeed()) @@ -71,7 +78,7 @@ var _ = Describe("Scanner - Multi-Library", Ordered, func() { Expect(ds.User(ctx).Put(&adminUser)).To(Succeed()) s = scanner.New(ctx, ds, artwork.NoopCacheWarmer(), events.NoopBroker(), - core.NewPlaylists(ds), metrics.NewNoopInstance()) + playlists.NewPlaylists(ds, core.NewImageUploadService()), metrics.NewNoopInstance()) // Create two test libraries (let DB auto-assign IDs) lib1 = model.Library{Name: "Rock Collection", Path: "rock:///music"} @@ -770,7 +777,7 @@ var _ = Describe("Scanner - Multi-Library", Ordered, func() { // Second scan should recover and import all rock content warnings, err = s.ScanAll(ctx, true) Expect(err).ToNot(HaveOccurred()) - Expect(warnings).ToNot(BeEmpty(), "Should have warnings for temporary disk error") + Expect(warnings).To(BeEmpty(), "Should have no warnings after error recovery") // Verify both libraries now have content (at least jazz should work) rockFiles, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ diff --git a/scanner/scanner_selective_test.go b/scanner/scanner_selective_test.go new file mode 100644 index 000000000..594b74e38 --- /dev/null +++ b/scanner/scanner_selective_test.go @@ -0,0 +1,294 @@ +package scanner_test + +import ( + "context" + "path/filepath" + "testing/fstest" + + "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/core" + "github.com/navidrome/navidrome/core/artwork" + "github.com/navidrome/navidrome/core/metrics" + "github.com/navidrome/navidrome/core/playlists" + "github.com/navidrome/navidrome/core/storage/storagetest" + "github.com/navidrome/navidrome/db" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/persistence" + "github.com/navidrome/navidrome/scanner" + "github.com/navidrome/navidrome/server/events" + "github.com/navidrome/navidrome/tests" + "github.com/navidrome/navidrome/utils/slice" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("ScanFolders", Ordered, func() { + var ctx context.Context + var lib model.Library + var ds model.DataStore + var s model.Scanner + var fsys storagetest.FakeFS + + BeforeAll(func() { + ctx = request.WithUser(GinkgoT().Context(), model.User{ID: "123", IsAdmin: true}) + tmpDir := GinkgoT().TempDir() + conf.Server.DbPath = filepath.Join(tmpDir, "test-selective-scan.db?_journal_mode=WAL") + log.Warn("Using DB at " + conf.Server.DbPath) + db.Db().SetMaxOpenConns(1) + }) + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.MusicFolder = "fake:///music" + conf.Server.DevExternalScanner = false + + db.Init(ctx) + DeferCleanup(func() { + Expect(tests.ClearDB()).To(Succeed()) + }) + + ds = persistence.New(db.Db()) + + // Create the admin user in the database to match the context + adminUser := model.User{ + ID: "123", + UserName: "admin", + Name: "Admin User", + IsAdmin: true, + NewPassword: "password", + } + Expect(ds.User(ctx).Put(&adminUser)).To(Succeed()) + + s = scanner.New(ctx, ds, artwork.NoopCacheWarmer(), events.NoopBroker(), + playlists.NewPlaylists(ds, core.NewImageUploadService()), metrics.NewNoopInstance()) + + lib = model.Library{ID: 1, Name: "Fake Library", Path: "fake:///music"} + Expect(ds.Library(ctx).Put(&lib)).To(Succeed()) + + // Initialize fake filesystem + fsys = storagetest.FakeFS{} + storagetest.Register("fake", &fsys) + }) + + Describe("Adding tracks to the library", func() { + It("scans specified folders recursively including all subdirectories", func() { + rock := template(_t{"albumartist": "Rock Artist", "album": "Rock Album"}) + jazz := template(_t{"albumartist": "Jazz Artist", "album": "Jazz Album"}) + pop := template(_t{"albumartist": "Pop Artist", "album": "Pop Album"}) + createFS(fstest.MapFS{ + "rock/track1.mp3": rock(track(1, "Rock Track 1")), + "rock/track2.mp3": rock(track(2, "Rock Track 2")), + "rock/subdir/track3.mp3": rock(track(3, "Rock Track 3")), + "jazz/track4.mp3": jazz(track(1, "Jazz Track 1")), + "jazz/subdir/track5.mp3": jazz(track(2, "Jazz Track 2")), + "pop/track6.mp3": pop(track(1, "Pop Track 1")), + }) + + // Scan only the "rock" and "jazz" folders (including their subdirectories) + targets := []model.ScanTarget{ + {LibraryID: lib.ID, FolderPath: "rock"}, + {LibraryID: lib.ID, FolderPath: "jazz"}, + } + + warnings, err := s.ScanFolders(ctx, false, targets) + Expect(err).ToNot(HaveOccurred()) + Expect(warnings).To(BeEmpty()) + + // Verify all tracks in rock and jazz folders (including subdirectories) were imported + allFiles, err := ds.MediaFile(ctx).GetAll() + Expect(err).ToNot(HaveOccurred()) + + // Should have 5 tracks (all rock and jazz tracks including subdirectories) + Expect(allFiles).To(HaveLen(5)) + + // Get the file paths + paths := slice.Map(allFiles, func(mf model.MediaFile) string { + return filepath.ToSlash(mf.Path) + }) + + // Verify the correct files were scanned (including subdirectories) + Expect(paths).To(ContainElements( + "rock/track1.mp3", + "rock/track2.mp3", + "rock/subdir/track3.mp3", + "jazz/track4.mp3", + "jazz/subdir/track5.mp3", + )) + + // Verify files in the pop folder were NOT scanned + Expect(paths).ToNot(ContainElement("pop/track6.mp3")) + }) + }) + + Describe("Deleting folders", func() { + Context("when a child folder is deleted", func() { + var ( + revolver, help func(...map[string]any) *fstest.MapFile + artistFolderID string + album1FolderID string + album2FolderID string + album1TrackIDs []string + album2TrackIDs []string + ) + + BeforeEach(func() { + // Setup template functions for creating test files + revolver = storagetest.Template(_t{"albumartist": "The Beatles", "album": "Revolver", "year": 1966}) + help = storagetest.Template(_t{"albumartist": "The Beatles", "album": "Help!", "year": 1965}) + + // Initial filesystem with nested folders + fsys.SetFiles(fstest.MapFS{ + "The Beatles/Revolver/01 - Taxman.mp3": revolver(storagetest.Track(1, "Taxman")), + "The Beatles/Revolver/02 - Eleanor Rigby.mp3": revolver(storagetest.Track(2, "Eleanor Rigby")), + "The Beatles/Help!/01 - Help!.mp3": help(storagetest.Track(1, "Help!")), + "The Beatles/Help!/02 - The Night Before.mp3": help(storagetest.Track(2, "The Night Before")), + }) + + // First scan - import everything + _, err := s.ScanAll(ctx, true) + Expect(err).ToNot(HaveOccurred()) + + // Verify initial state - all folders exist + folders, err := ds.Folder(ctx).GetAll(model.QueryOptions{Filters: squirrel.Eq{"library_id": lib.ID}}) + Expect(err).ToNot(HaveOccurred()) + Expect(folders).To(HaveLen(4)) // root, Artist, Album1, Album2 + + // Store folder IDs for later verification + for _, f := range folders { + switch f.Name { + case "The Beatles": + artistFolderID = f.ID + case "Revolver": + album1FolderID = f.ID + case "Help!": + album2FolderID = f.ID + } + } + + // Verify all tracks exist + allTracks, err := ds.MediaFile(ctx).GetAll() + Expect(err).ToNot(HaveOccurred()) + Expect(allTracks).To(HaveLen(4)) + + // Store track IDs for later verification + for _, t := range allTracks { + if t.Album == "Revolver" { + album1TrackIDs = append(album1TrackIDs, t.ID) + } else if t.Album == "Help!" { + album2TrackIDs = append(album2TrackIDs, t.ID) + } + } + + // Verify no tracks are missing initially + for _, t := range allTracks { + Expect(t.Missing).To(BeFalse()) + } + }) + + It("should mark child folder and its tracks as missing when parent is scanned", func() { + // Delete the child folder (Help!) from the filesystem + fsys.SetFiles(fstest.MapFS{ + "The Beatles/Revolver/01 - Taxman.mp3": revolver(storagetest.Track(1, "Taxman")), + "The Beatles/Revolver/02 - Eleanor Rigby.mp3": revolver(storagetest.Track(2, "Eleanor Rigby")), + // "The Beatles/Help!" folder and its contents are DELETED + }) + + // Run selective scan on the parent folder (Artist) + // This simulates what the watcher does when a child folder is deleted + _, err := s.ScanFolders(ctx, false, []model.ScanTarget{ + {LibraryID: lib.ID, FolderPath: "The Beatles"}, + }) + Expect(err).ToNot(HaveOccurred()) + + // Verify the deleted child folder is now marked as missing + deletedFolder, err := ds.Folder(ctx).Get(album2FolderID) + Expect(err).ToNot(HaveOccurred()) + Expect(deletedFolder.Missing).To(BeTrue(), "Deleted child folder should be marked as missing") + + // Verify the deleted folder's tracks are marked as missing + for _, trackID := range album2TrackIDs { + track, err := ds.MediaFile(ctx).Get(trackID) + Expect(err).ToNot(HaveOccurred()) + Expect(track.Missing).To(BeTrue(), "Track in deleted folder should be marked as missing") + } + + // Verify the parent folder is still present and not marked as missing + parentFolder, err := ds.Folder(ctx).Get(artistFolderID) + Expect(err).ToNot(HaveOccurred()) + Expect(parentFolder.Missing).To(BeFalse(), "Parent folder should not be marked as missing") + + // Verify the sibling folder and its tracks are still present and not missing + siblingFolder, err := ds.Folder(ctx).Get(album1FolderID) + Expect(err).ToNot(HaveOccurred()) + Expect(siblingFolder.Missing).To(BeFalse(), "Sibling folder should not be marked as missing") + + for _, trackID := range album1TrackIDs { + track, err := ds.MediaFile(ctx).Get(trackID) + Expect(err).ToNot(HaveOccurred()) + Expect(track.Missing).To(BeFalse(), "Track in sibling folder should not be marked as missing") + } + }) + + It("should mark deeply nested child folders as missing", func() { + // Add a deeply nested folder structure + fsys.SetFiles(fstest.MapFS{ + "The Beatles/Revolver/01 - Taxman.mp3": revolver(storagetest.Track(1, "Taxman")), + "The Beatles/Revolver/02 - Eleanor Rigby.mp3": revolver(storagetest.Track(2, "Eleanor Rigby")), + "The Beatles/Help!/01 - Help!.mp3": help(storagetest.Track(1, "Help!")), + "The Beatles/Help!/02 - The Night Before.mp3": help(storagetest.Track(2, "The Night Before")), + "The Beatles/Help!/Bonus/01 - Bonus Track.mp3": help(storagetest.Track(99, "Bonus Track")), + "The Beatles/Help!/Bonus/Nested/01 - Deep Track.mp3": help(storagetest.Track(100, "Deep Track")), + }) + + // Rescan to import the new nested structure + _, err := s.ScanAll(ctx, true) + Expect(err).ToNot(HaveOccurred()) + + // Verify nested folders were created + allFolders, err := ds.Folder(ctx).GetAll(model.QueryOptions{Filters: squirrel.Eq{"library_id": lib.ID}}) + Expect(err).ToNot(HaveOccurred()) + Expect(len(allFolders)).To(BeNumerically(">", 4), "Should have more folders with nested structure") + + // Now delete the entire Help! folder including nested children + fsys.SetFiles(fstest.MapFS{ + "The Beatles/Revolver/01 - Taxman.mp3": revolver(storagetest.Track(1, "Taxman")), + "The Beatles/Revolver/02 - Eleanor Rigby.mp3": revolver(storagetest.Track(2, "Eleanor Rigby")), + // All Help! subfolders are deleted + }) + + // Run selective scan on parent + _, err = s.ScanFolders(ctx, false, []model.ScanTarget{ + {LibraryID: lib.ID, FolderPath: "The Beatles"}, + }) + Expect(err).ToNot(HaveOccurred()) + + // Verify all Help! folders (including nested ones) are marked as missing + missingFolders, err := ds.Folder(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.And{ + squirrel.Eq{"library_id": lib.ID}, + squirrel.Eq{"missing": true}, + }, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(len(missingFolders)).To(BeNumerically(">", 0), "At least one folder should be marked as missing") + + // Verify all tracks in deleted folders are marked as missing + allTracks, err := ds.MediaFile(ctx).GetAll() + Expect(err).ToNot(HaveOccurred()) + Expect(allTracks).To(HaveLen(6)) + + for _, track := range allTracks { + if track.Album == "Help!" { + Expect(track.Missing).To(BeTrue(), "All tracks in deleted Help! folder should be marked as missing") + } else if track.Album == "Revolver" { + Expect(track.Missing).To(BeFalse(), "Tracks in Revolver folder should not be marked as missing") + } + } + }) + }) + }) +}) diff --git a/scanner/scanner_suite_test.go b/scanner/scanner_suite_test.go index 8a2c6b260..9ee6fc89b 100644 --- a/scanner/scanner_suite_test.go +++ b/scanner/scanner_suite_test.go @@ -2,6 +2,7 @@ package scanner_test import ( "context" + "os" "testing" "github.com/navidrome/navidrome/db" @@ -13,10 +14,16 @@ import ( ) func TestScanner(t *testing.T) { - // Detect any goroutine leaks in the scanner code under test - defer goleak.VerifyNone(t, - goleak.IgnoreTopFunction("github.com/onsi/ginkgo/v2/internal/interrupt_handler.(*InterruptHandler).registerForInterrupts.func2"), - ) + // Only run goleak checks when the GOLEAK env var is set + if os.Getenv("GOLEAK") != "" { + // Detect any goroutine leaks in the scanner code under test + defer goleak.VerifyNone(t, + goleak.IgnoreTopFunction("github.com/onsi/ginkgo/v2/internal/interrupt_handler.(*InterruptHandler).registerForInterrupts.func2"), + // The notify library creates internal goroutines for file watching that persist after Stop() is called. + // These are created by the plugins package tests and are expected behavior. + goleak.IgnoreTopFunction("github.com/rjeczalik/notify.(*recursiveTree).dispatch"), + ) + } tests.Init(t, true) defer db.Close(context.Background()) diff --git a/scanner/scanner_test.go b/scanner/scanner_test.go index e7e354f21..922d21e62 100644 --- a/scanner/scanner_test.go +++ b/scanner/scanner_test.go @@ -14,6 +14,7 @@ import ( "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/core/artwork" "github.com/navidrome/navidrome/core/metrics" + "github.com/navidrome/navidrome/core/playlists" "github.com/navidrome/navidrome/core/storage/storagetest" "github.com/navidrome/navidrome/db" "github.com/navidrome/navidrome/log" @@ -34,19 +35,19 @@ type _t = map[string]any var template = storagetest.Template var track = storagetest.Track +func createFS(files fstest.MapFS) storagetest.FakeFS { + fs := storagetest.FakeFS{} + fs.SetFiles(files) + storagetest.Register("fake", &fs) + return fs +} + var _ = Describe("Scanner", Ordered, func() { var ctx context.Context var lib model.Library var ds *tests.MockDataStore var mfRepo *mockMediaFileRepo - var s scanner.Scanner - - createFS := func(files fstest.MapFS) storagetest.FakeFS { - fs := storagetest.FakeFS{} - fs.SetFiles(files) - storagetest.Register("fake", &fs) - return fs - } + var s model.Scanner BeforeAll(func() { ctx = request.WithUser(GinkgoT().Context(), model.User{ID: "123", IsAdmin: true}) @@ -84,7 +85,7 @@ var _ = Describe("Scanner", Ordered, func() { Expect(ds.User(ctx).Put(&adminUser)).To(Succeed()) s = scanner.New(ctx, ds, artwork.NoopCacheWarmer(), events.NoopBroker(), - core.NewPlaylists(ds), metrics.NewNoopInstance()) + playlists.NewPlaylists(ds, core.NewImageUploadService()), metrics.NewNoopInstance()) lib = model.Library{ID: 1, Name: "Fake Library", Path: "fake:///music"} Expect(ds.Library(ctx).Put(&lib)).To(Succeed()) @@ -478,6 +479,56 @@ var _ = Describe("Scanner", Ordered, func() { Expect(mf.Missing).To(BeFalse()) }) + It("marks tracks as missing when scanning a deleted folder with ScanFolders", func() { + By("Adding a third track to Revolver to have more test data") + fsys.Add("The Beatles/Revolver/03 - I'm Only Sleeping.mp3", revolver(track(3, "I'm Only Sleeping"))) + Expect(runScanner(ctx, false)).To(Succeed()) + + By("Verifying initial state has 5 tracks") + Expect(ds.MediaFile(ctx).CountAll(model.QueryOptions{ + Filters: squirrel.Eq{"missing": false}, + })).To(Equal(int64(5))) + + By("Removing the entire Revolver folder from filesystem") + fsys.Remove("The Beatles/Revolver/01 - Taxman.mp3") + fsys.Remove("The Beatles/Revolver/02 - Eleanor Rigby.mp3") + fsys.Remove("The Beatles/Revolver/03 - I'm Only Sleeping.mp3") + + By("Scanning the parent folder (simulating watcher behavior)") + targets := []model.ScanTarget{ + {LibraryID: lib.ID, FolderPath: "The Beatles"}, + } + _, err := s.ScanFolders(ctx, false, targets) + Expect(err).To(Succeed()) + + By("Checking all Revolver tracks are marked as missing") + mf, err := findByPath("The Beatles/Revolver/01 - Taxman.mp3") + Expect(err).ToNot(HaveOccurred()) + Expect(mf.Missing).To(BeTrue()) + + mf, err = findByPath("The Beatles/Revolver/02 - Eleanor Rigby.mp3") + Expect(err).ToNot(HaveOccurred()) + Expect(mf.Missing).To(BeTrue()) + + mf, err = findByPath("The Beatles/Revolver/03 - I'm Only Sleeping.mp3") + Expect(err).ToNot(HaveOccurred()) + Expect(mf.Missing).To(BeTrue()) + + By("Checking the Help! tracks are not affected") + mf, err = findByPath("The Beatles/Help!/01 - Help!.mp3") + Expect(err).ToNot(HaveOccurred()) + Expect(mf.Missing).To(BeFalse()) + + mf, err = findByPath("The Beatles/Help!/02 - The Night Before.mp3") + Expect(err).ToNot(HaveOccurred()) + Expect(mf.Missing).To(BeFalse()) + + By("Verifying only 2 non-missing tracks remain (Help! tracks)") + Expect(ds.MediaFile(ctx).CountAll(model.QueryOptions{ + Filters: squirrel.Eq{"missing": false}, + })).To(Equal(int64(2))) + }) + It("does not override artist fields when importing an undertagged file", func() { By("Making sure artist in the DB contains MBID and sort name") aa, err := ds.Artist(ctx).GetAll(model.QueryOptions{ @@ -625,6 +676,155 @@ var _ = Describe("Scanner", Ordered, func() { }) }) + Describe("Interrupted scan resumption", func() { + var fsys storagetest.FakeFS + var help func(...map[string]any) *fstest.MapFile + + BeforeEach(func() { + help = template(_t{"albumartist": "The Beatles", "album": "Help!", "year": 1965}) + fsys = createFS(fstest.MapFS{ + "The Beatles/Help!/01 - Help!.mp3": help(track(1, "Help!")), + "The Beatles/Help!/02 - The Night Before.mp3": help(track(2, "The Night Before")), + }) + }) + + simulateInterruptedScan := func(fullScan bool) { + // Call ScanBegin to properly set LastScanStartedAt and FullScanInProgress + // This simulates what would happen if a scan was interrupted (ScanBegin called but ScanEnd not) + Expect(ds.Library(ctx).ScanBegin(lib.ID, fullScan)).To(Succeed()) + + // Verify the update was persisted + reloaded, err := ds.Library(ctx).Get(lib.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(reloaded.LastScanStartedAt).ToNot(BeZero()) + Expect(reloaded.FullScanInProgress).To(Equal(fullScan)) + } + + Context("when a quick scan is interrupted and resumed with a full scan request", func() { + BeforeEach(func() { + // First, complete a full scan to populate the database + Expect(runScanner(ctx, true)).To(Succeed()) + + // Verify files were imported + mfs, err := ds.MediaFile(ctx).GetAll() + Expect(err).ToNot(HaveOccurred()) + Expect(mfs).To(HaveLen(2)) + + // Now simulate an interrupted quick scan + // (LastScanStartedAt is set, FullScanInProgress is false) + simulateInterruptedScan(false) + }) + + It("should rescan all folders when resumed as full scan", func() { + // Update a tag without changing the folder hash by preserving the original modtime. + // In a quick scan, this wouldn't be detected because the folder hash hasn't changed. + // But in a full scan, all files should be re-read regardless of hash. + origModTime := fsys.MapFS["The Beatles/Help!/01 - Help!.mp3"].ModTime + fsys.UpdateTags("The Beatles/Help!/01 - Help!.mp3", _t{"comment": "updated comment"}, origModTime) + + // Resume with a full scan - this should process all folders + // even though folder hashes haven't changed + Expect(runScanner(ctx, true)).To(Succeed()) + + // Verify the comment was updated (which means the folder was processed and file re-imported) + mfs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"title": "Help!"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(mfs).To(HaveLen(1)) + Expect(mfs[0].Comment).To(Equal("updated comment")) + }) + }) + + Context("when a full scan is interrupted and resumed with a quick scan request", func() { + BeforeEach(func() { + // First, complete a full scan to populate the database + Expect(runScanner(ctx, true)).To(Succeed()) + + // Verify files were imported + mfs, err := ds.MediaFile(ctx).GetAll() + Expect(err).ToNot(HaveOccurred()) + Expect(mfs).To(HaveLen(2)) + + // Now simulate an interrupted full scan + // (LastScanStartedAt is set, FullScanInProgress is true) + simulateInterruptedScan(true) + }) + + It("should continue as full scan even when quick scan is requested", func() { + // Update a tag without changing the folder hash by preserving the original modtime. + origModTime := fsys.MapFS["The Beatles/Help!/01 - Help!.mp3"].ModTime + fsys.UpdateTags("The Beatles/Help!/01 - Help!.mp3", _t{"comment": "full scan comment"}, origModTime) + + // Request a quick scan - but because a full scan was in progress, + // it should continue as a full scan + Expect(runScanner(ctx, false)).To(Succeed()) + + // Verify the comment was updated (folder was processed despite unchanged hash) + mfs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"title": "Help!"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(mfs).To(HaveLen(1)) + Expect(mfs[0].Comment).To(Equal("full scan comment")) + }) + }) + + Context("when no scan was in progress", func() { + BeforeEach(func() { + // First, complete a full scan to populate the database + Expect(runScanner(ctx, true)).To(Succeed()) + + // Verify files were imported + mfs, err := ds.MediaFile(ctx).GetAll() + Expect(err).ToNot(HaveOccurred()) + Expect(mfs).To(HaveLen(2)) + + // Library should have LastScanStartedAt cleared after successful scan + updatedLib, err := ds.Library(ctx).Get(lib.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(updatedLib.LastScanStartedAt).To(BeZero()) + Expect(updatedLib.FullScanInProgress).To(BeFalse()) + }) + + It("should respect the full scan flag for new scans", func() { + // Update a tag without changing the folder hash by preserving the original modtime. + origModTime := fsys.MapFS["The Beatles/Help!/01 - Help!.mp3"].ModTime + fsys.UpdateTags("The Beatles/Help!/01 - Help!.mp3", _t{"comment": "new full scan"}, origModTime) + + // Start a new full scan + Expect(runScanner(ctx, true)).To(Succeed()) + + // Verify the comment was updated + mfs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"title": "Help!"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(mfs).To(HaveLen(1)) + Expect(mfs[0].Comment).To(Equal("new full scan")) + }) + + It("should not rescan unchanged folders during quick scan", func() { + // Update a tag without changing the folder hash by preserving the original modtime. + // This simulates editing tags in a file (e.g., with a tag editor) without modifying its timestamp. + // In a quick scan, this should NOT be detected because the folder hash remains unchanged. + origModTime := fsys.MapFS["The Beatles/Help!/01 - Help!.mp3"].ModTime + fsys.UpdateTags("The Beatles/Help!/01 - Help!.mp3", _t{"comment": "should not appear"}, origModTime) + + // Do a quick scan - unchanged folders should be skipped + Expect(runScanner(ctx, false)).To(Succeed()) + + // Verify the comment was NOT updated (folder was skipped) + mfs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"title": "Help!"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(mfs).To(HaveLen(1)) + Expect(mfs[0].Comment).To(BeEmpty()) + }) + }) + }) + Describe("RefreshStats", func() { var refreshStatsCalls []bool var fsys storagetest.FakeFS diff --git a/scanner/walk_dir_tree.go b/scanner/walk_dir_tree.go index 63854d262..e6a694f2b 100644 --- a/scanner/walk_dir_tree.go +++ b/scanner/walk_dir_tree.go @@ -1,7 +1,6 @@ package scanner import ( - "bufio" "context" "io/fs" "maps" @@ -11,37 +10,69 @@ import ( "strings" "github.com/navidrome/navidrome/conf" - "github.com/navidrome/navidrome/consts" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/utils" - ignore "github.com/sabhiram/go-gitignore" ) -func walkDirTree(ctx context.Context, job *scanJob) (<-chan *folderEntry, error) { +// walkDirTree recursively walks the directory tree starting from the given targetFolders. +// If no targetFolders are provided, it starts from the root folder ("."). +// It returns a channel of folderEntry pointers representing each folder found. +func walkDirTree(ctx context.Context, job *scanJob, targetFolders ...string) (<-chan *folderEntry, error) { results := make(chan *folderEntry) + folders := targetFolders + if len(targetFolders) == 0 { + // No specific folders provided, scan the root folder + folders = []string{"."} + } go func() { defer close(results) - err := walkFolder(ctx, job, ".", nil, results) - if err != nil { - log.Error(ctx, "Scanner: There were errors reading directories from filesystem", "path", job.lib.Path, err) - return + for _, folderPath := range folders { + if utils.IsCtxDone(ctx) { + return + } + + // Check if target folder exists before walking it + // If it doesn't exist (e.g., deleted between watcher detection and scan execution), + // skip it so it remains in job.lastUpdates and gets handled in following steps + _, err := fs.Stat(job.fs, folderPath) + if err != nil { + log.Warn(ctx, "Scanner: Target folder does not exist.", "path", folderPath, err) + continue + } + + // Create checker and push patterns from root to this folder + checker := newIgnoreChecker(job.fs) + err = checker.PushAllParents(ctx, folderPath) + if err != nil { + log.Error(ctx, "Scanner: Error pushing ignore patterns for target folder", "path", folderPath, err) + continue + } + + // Recursively walk this folder and all its children + err = walkFolder(ctx, job, folderPath, checker, results) + if err != nil { + log.Error(ctx, "Scanner: Error walking target folder", "path", folderPath, err) + continue + } } - log.Debug(ctx, "Scanner: Finished reading folders", "lib", job.lib.Name, "path", job.lib.Path, "numFolders", job.numFolders.Load()) + log.Debug(ctx, "Scanner: Finished reading target folders", "lib", job.lib.Name, "path", job.lib.Path, "numFolders", job.numFolders.Load()) }() return results, nil } -func walkFolder(ctx context.Context, job *scanJob, currentFolder string, ignorePatterns []string, results chan<- *folderEntry) error { - ignorePatterns = loadIgnoredPatterns(ctx, job.fs, currentFolder, ignorePatterns) +func walkFolder(ctx context.Context, job *scanJob, currentFolder string, checker *IgnoreChecker, results chan<- *folderEntry) error { + // Push patterns for this folder onto the stack + _ = checker.Push(ctx, currentFolder) + defer checker.Pop() // Pop patterns when leaving this folder - folder, children, err := loadDir(ctx, job, currentFolder, ignorePatterns) + folder, children, err := loadDir(ctx, job, currentFolder, checker) if err != nil { log.Warn(ctx, "Scanner: Error loading dir. Skipping", "path", currentFolder, err) return nil } for _, c := range children { - err := walkFolder(ctx, job, c, ignorePatterns, results) + err := walkFolder(ctx, job, c, checker, results) if err != nil { return err } @@ -59,50 +90,17 @@ func walkFolder(ctx context.Context, job *scanJob, currentFolder string, ignoreP return nil } -func loadIgnoredPatterns(ctx context.Context, fsys fs.FS, currentFolder string, currentPatterns []string) []string { - ignoreFilePath := path.Join(currentFolder, consts.ScanIgnoreFile) - var newPatterns []string - if _, err := fs.Stat(fsys, ignoreFilePath); err == nil { - // Read and parse the .ndignore file - ignoreFile, err := fsys.Open(ignoreFilePath) - if err != nil { - log.Warn(ctx, "Scanner: Error opening .ndignore file", "path", ignoreFilePath, err) - // Continue with previous patterns - } else { - defer ignoreFile.Close() - scanner := bufio.NewScanner(ignoreFile) - for scanner.Scan() { - line := scanner.Text() - if line == "" || strings.HasPrefix(line, "#") { - continue // Skip empty lines and comments - } - newPatterns = append(newPatterns, line) - } - if err := scanner.Err(); err != nil { - log.Warn(ctx, "Scanner: Error reading .ignore file", "path", ignoreFilePath, err) - } - } - // If the .ndignore file is empty, mimic the current behavior and ignore everything - if len(newPatterns) == 0 { - log.Trace(ctx, "Scanner: .ndignore file is empty, ignoring everything", "path", currentFolder) - newPatterns = []string{"**/*"} - } else { - log.Trace(ctx, "Scanner: .ndignore file found ", "path", ignoreFilePath, "patterns", newPatterns) - } - } - // Combine the patterns from the .ndignore file with the ones passed as argument - combinedPatterns := append([]string{}, currentPatterns...) - return append(combinedPatterns, newPatterns...) -} - -func loadDir(ctx context.Context, job *scanJob, dirPath string, ignorePatterns []string) (folder *folderEntry, children []string, err error) { - folder = newFolderEntry(job, dirPath) - +func loadDir(ctx context.Context, job *scanJob, dirPath string, checker *IgnoreChecker) (folder *folderEntry, children []string, err error) { + // Check if directory exists before creating the folder entry + // This is important to avoid removing the folder from lastUpdates if it doesn't exist dirInfo, err := fs.Stat(job.fs, dirPath) if err != nil { log.Warn(ctx, "Scanner: Error stating dir", "path", dirPath, err) return nil, nil, err } + + // Now that we know the folder exists, create the entry (which removes it from lastUpdates) + folder = job.createFolderEntry(dirPath) folder.modTime = dirInfo.ModTime() dir, err := job.fs.Open(dirPath) @@ -117,12 +115,11 @@ func loadDir(ctx context.Context, job *scanJob, dirPath string, ignorePatterns [ return folder, children, err } - ignoreMatcher := ignore.CompileIgnoreLines(ignorePatterns...) entries := fullReadDir(ctx, dirFile) children = make([]string, 0, len(entries)) for _, entry := range entries { entryPath := path.Join(dirPath, entry.Name()) - if len(ignorePatterns) > 0 && isScanIgnored(ctx, ignoreMatcher, entryPath) { + if checker.ShouldIgnore(ctx, entryPath) { log.Trace(ctx, "Scanner: Ignoring entry", "path", entryPath) continue } @@ -234,6 +231,7 @@ func isDirReadable(ctx context.Context, fsys fs.FS, dirPath string) bool { var ignoredDirs = []string{ "$RECYCLE.BIN", "#snapshot", + "@Recycle", "@Recently-Snapshot", ".streams", "lost+found", @@ -254,11 +252,3 @@ func isDirIgnored(name string) bool { func isEntryIgnored(name string) bool { return strings.HasPrefix(name, ".") && !strings.HasPrefix(name, "..") } - -func isScanIgnored(ctx context.Context, matcher *ignore.GitIgnore, entryPath string) bool { - matches := matcher.MatchesPath(entryPath) - if matches { - log.Trace(ctx, "Scanner: Ignoring entry matching .ndignore: ", "path", entryPath) - } - return matches -} diff --git a/scanner/walk_dir_tree_test.go b/scanner/walk_dir_tree_test.go index c4278ef82..c9add0bd1 100644 --- a/scanner/walk_dir_tree_test.go +++ b/scanner/walk_dir_tree_test.go @@ -25,82 +25,196 @@ var _ = Describe("walk_dir_tree", func() { ctx context.Context ) - BeforeEach(func() { - DeferCleanup(configtest.SetupConfig()) - ctx = GinkgoT().Context() - fsys = &mockMusicFS{ - FS: fstest.MapFS{ - "root/a/.ndignore": {Data: []byte("ignored/*")}, - "root/a/f1.mp3": {}, - "root/a/f2.mp3": {}, - "root/a/ignored/bad.mp3": {}, - "root/b/cover.jpg": {}, - "root/c/f3": {}, - "root/d": {}, - "root/d/.ndignore": {}, - "root/d/f1.mp3": {}, - "root/d/f2.mp3": {}, - "root/d/f3.mp3": {}, - "root/e/original/f1.mp3": {}, - "root/e/symlink": {Mode: fs.ModeSymlink, Data: []byte("root/e/original")}, + Context("full library", func() { + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + ctx = GinkgoT().Context() + fsys = &mockMusicFS{ + FS: fstest.MapFS{ + "root/a/.ndignore": {Data: []byte("ignored/*")}, + "root/a/f1.mp3": {}, + "root/a/f2.mp3": {}, + "root/a/ignored/bad.mp3": {}, + "root/b/cover.jpg": {}, + "root/c/f3": {}, + "root/d": {}, + "root/d/.ndignore": {}, + "root/d/f1.mp3": {}, + "root/d/f2.mp3": {}, + "root/d/f3.mp3": {}, + "root/e/original/f1.mp3": {}, + "root/e/symlink": {Mode: fs.ModeSymlink, Data: []byte("original")}, + }, + } + job = &scanJob{ + fs: fsys, + lib: model.Library{Path: "/music"}, + } + }) + + // Helper function to call walkDirTree and collect folders from the results channel + getFolders := func() map[string]*folderEntry { + results, err := walkDirTree(ctx, job) + Expect(err).ToNot(HaveOccurred()) + + folders := map[string]*folderEntry{} + g := errgroup.Group{} + g.Go(func() error { + for folder := range results { + folders[folder.path] = folder + } + return nil + }) + _ = g.Wait() + return folders + } + + DescribeTable("symlink handling", + func(followSymlinks bool, expectedFolderCount int) { + conf.Server.Scanner.FollowSymlinks = followSymlinks + folders := getFolders() + + Expect(folders).To(HaveLen(expectedFolderCount + 2)) // +2 for `.` and `root` + + // Basic folder structure checks + Expect(folders["root/a"].audioFiles).To(SatisfyAll( + HaveLen(2), + HaveKey("f1.mp3"), + HaveKey("f2.mp3"), + )) + Expect(folders["root/a"].imageFiles).To(BeEmpty()) + Expect(folders["root/b"].audioFiles).To(BeEmpty()) + Expect(folders["root/b"].imageFiles).To(SatisfyAll( + HaveLen(1), + HaveKey("cover.jpg"), + )) + Expect(folders["root/c"].audioFiles).To(BeEmpty()) + Expect(folders["root/c"].imageFiles).To(BeEmpty()) + Expect(folders).ToNot(HaveKey("root/d")) + + // Symlink specific checks + if followSymlinks { + Expect(folders["root/e/symlink"].audioFiles).To(HaveLen(1)) + } else { + Expect(folders).ToNot(HaveKey("root/e/symlink")) + } }, - } - job = &scanJob{ - fs: fsys, - lib: model.Library{Path: "/music"}, - } + Entry("with symlinks enabled", true, 7), + Entry("with symlinks disabled", false, 6), + ) }) - // Helper function to call walkDirTree and collect folders from the results channel - getFolders := func() map[string]*folderEntry { - results, err := walkDirTree(ctx, job) - Expect(err).ToNot(HaveOccurred()) - - folders := map[string]*folderEntry{} - g := errgroup.Group{} - g.Go(func() error { - for folder := range results { - folders[folder.path] = folder + Context("with target folders", func() { + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + ctx = GinkgoT().Context() + fsys = &mockMusicFS{ + FS: fstest.MapFS{ + "Artist/Album1/track1.mp3": {}, + "Artist/Album1/track2.mp3": {}, + "Artist/Album2/track1.mp3": {}, + "Artist/Album2/track2.mp3": {}, + "Artist/Album2/Sub/track3.mp3": {}, + "OtherArtist/Album3/track1.mp3": {}, + }, + } + job = &scanJob{ + fs: fsys, + lib: model.Library{Path: "/music"}, } - return nil }) - _ = g.Wait() - return folders - } - DescribeTable("symlink handling", - func(followSymlinks bool, expectedFolderCount int) { - conf.Server.Scanner.FollowSymlinks = followSymlinks - folders := getFolders() + It("should recursively walk all subdirectories of target folders", func() { + results, err := walkDirTree(ctx, job, "Artist") + Expect(err).ToNot(HaveOccurred()) - Expect(folders).To(HaveLen(expectedFolderCount + 2)) // +2 for `.` and `root` + folders := map[string]*folderEntry{} + g := errgroup.Group{} + g.Go(func() error { + for folder := range results { + folders[folder.path] = folder + } + return nil + }) + _ = g.Wait() - // Basic folder structure checks - Expect(folders["root/a"].audioFiles).To(SatisfyAll( - HaveLen(2), - HaveKey("f1.mp3"), - HaveKey("f2.mp3"), + // Should include the target folder and all its descendants + Expect(folders).To(SatisfyAll( + HaveKey("Artist"), + HaveKey("Artist/Album1"), + HaveKey("Artist/Album2"), + HaveKey("Artist/Album2/Sub"), )) - Expect(folders["root/a"].imageFiles).To(BeEmpty()) - Expect(folders["root/b"].audioFiles).To(BeEmpty()) - Expect(folders["root/b"].imageFiles).To(SatisfyAll( - HaveLen(1), - HaveKey("cover.jpg"), - )) - Expect(folders["root/c"].audioFiles).To(BeEmpty()) - Expect(folders["root/c"].imageFiles).To(BeEmpty()) - Expect(folders).ToNot(HaveKey("root/d")) - // Symlink specific checks - if followSymlinks { - Expect(folders["root/e/symlink"].audioFiles).To(HaveLen(1)) - } else { - Expect(folders).ToNot(HaveKey("root/e/symlink")) + // Should not include folders outside the target + Expect(folders).ToNot(HaveKey("OtherArtist")) + Expect(folders).ToNot(HaveKey("OtherArtist/Album3")) + + // Verify audio files are present + Expect(folders["Artist/Album1"].audioFiles).To(HaveLen(2)) + Expect(folders["Artist/Album2"].audioFiles).To(HaveLen(2)) + Expect(folders["Artist/Album2/Sub"].audioFiles).To(HaveLen(1)) + }) + + It("should handle multiple target folders", func() { + results, err := walkDirTree(ctx, job, "Artist/Album1", "OtherArtist") + Expect(err).ToNot(HaveOccurred()) + + folders := map[string]*folderEntry{} + g := errgroup.Group{} + g.Go(func() error { + for folder := range results { + folders[folder.path] = folder + } + return nil + }) + _ = g.Wait() + + // Should include both target folders and their descendants + Expect(folders).To(SatisfyAll( + HaveKey("Artist/Album1"), + HaveKey("OtherArtist"), + HaveKey("OtherArtist/Album3"), + )) + + // Should not include other folders + Expect(folders).ToNot(HaveKey("Artist")) + Expect(folders).ToNot(HaveKey("Artist/Album2")) + Expect(folders).ToNot(HaveKey("Artist/Album2/Sub")) + }) + + It("should skip non-existent target folders and preserve them in lastUpdates", func() { + // Setup job with lastUpdates for both existing and non-existing folders + job.lastUpdates = map[string]model.FolderUpdateInfo{ + model.FolderID(job.lib, "Artist/Album1"): {}, + model.FolderID(job.lib, "NonExistent/DeletedFolder"): {}, + model.FolderID(job.lib, "OtherArtist/Album3"): {}, } - }, - Entry("with symlinks enabled", true, 7), - Entry("with symlinks disabled", false, 6), - ) + + // Try to scan existing folder and non-existing folder + results, err := walkDirTree(ctx, job, "Artist/Album1", "NonExistent/DeletedFolder") + Expect(err).ToNot(HaveOccurred()) + + // Collect results + folders := map[string]struct{}{} + for folder := range results { + folders[folder.path] = struct{}{} + } + + // Should only include the existing folder + Expect(folders).To(HaveKey("Artist/Album1")) + Expect(folders).ToNot(HaveKey("NonExistent/DeletedFolder")) + + // The non-existent folder should still be in lastUpdates (not removed by popLastUpdate) + Expect(job.lastUpdates).To(HaveKey(model.FolderID(job.lib, "NonExistent/DeletedFolder"))) + + // The existing folder should have been removed from lastUpdates + Expect(job.lastUpdates).ToNot(HaveKey(model.FolderID(job.lib, "Artist/Album1"))) + + // Folders not in targets should remain in lastUpdates + Expect(job.lastUpdates).To(HaveKey(model.FolderID(job.lib, "OtherArtist/Album3"))) + }) + }) }) Describe("helper functions", func() { diff --git a/scanner/watcher.go b/scanner/watcher.go index 37cfb5e22..376db910c 100644 --- a/scanner/watcher.go +++ b/scanner/watcher.go @@ -24,9 +24,9 @@ type Watcher interface { type watcher struct { mainCtx context.Context ds model.DataStore - scanner Scanner + scanner model.Scanner triggerWait time.Duration - watcherNotify chan model.Library + watcherNotify chan scanNotification libraryWatchers map[int]*libraryWatcherInstance mu sync.RWMutex } @@ -36,14 +36,19 @@ type libraryWatcherInstance struct { cancel context.CancelFunc } +type scanNotification struct { + Library *model.Library + FolderPath string +} + // GetWatcher returns the watcher singleton -func GetWatcher(ds model.DataStore, s Scanner) Watcher { +func GetWatcher(ds model.DataStore, s model.Scanner) Watcher { return singleton.GetInstance(func() *watcher { return &watcher{ ds: ds, scanner: s, triggerWait: conf.Server.Scanner.WatcherWait, - watcherNotify: make(chan model.Library, 1), + watcherNotify: make(chan scanNotification, 500), libraryWatchers: make(map[int]*libraryWatcherInstance), } }) @@ -68,11 +73,11 @@ func (w *watcher) Run(ctx context.Context) error { // Main scan triggering loop trigger := time.NewTimer(w.triggerWait) trigger.Stop() - waiting := false + targets := make(map[model.ScanTarget]struct{}) for { select { case <-trigger.C: - log.Info("Watcher: Triggering scan") + log.Info("Watcher: Triggering scan for changed folders", "numTargets", len(targets)) status, err := w.scanner.Status(ctx) if err != nil { log.Error(ctx, "Watcher: Error retrieving Scanner status", err) @@ -83,9 +88,23 @@ func (w *watcher) Run(ctx context.Context) error { trigger.Reset(w.triggerWait * 3) continue } - waiting = false + + // Convert targets map to slice + targetSlice := make([]model.ScanTarget, 0, len(targets)) + for target := range targets { + targetSlice = append(targetSlice, target) + } + + // Clear targets for next batch + targets = make(map[model.ScanTarget]struct{}) + go func() { - _, err := w.scanner.ScanAll(ctx, false) + var err error + if conf.Server.DevSelectiveWatcher { + _, err = w.scanner.ScanFolders(ctx, false, targetSlice) + } else { + _, err = w.scanner.ScanAll(ctx, false) + } if err != nil { log.Error(ctx, "Watcher: Error scanning", err) } else { @@ -102,13 +121,22 @@ func (w *watcher) Run(ctx context.Context) error { w.libraryWatchers = make(map[int]*libraryWatcherInstance) w.mu.Unlock() return nil - case lib := <-w.watcherNotify: - if !waiting { - log.Debug(ctx, "Watcher: Detected changes. Waiting for more changes before triggering scan", - "libraryID", lib.ID, "name", lib.Name, "path", lib.Path) - waiting = true - } + case notification := <-w.watcherNotify: + // Reset the trigger timer for debounce trigger.Reset(w.triggerWait) + + lib := notification.Library + folderPath := notification.FolderPath + + // If already scheduled for scan, skip + target := model.ScanTarget{LibraryID: lib.ID, FolderPath: folderPath} + if _, exists := targets[target]; exists { + continue + } + targets[target] = struct{}{} + + log.Debug(ctx, "Watcher: Detected changes. Waiting for more changes before triggering scan", + "libraryID", lib.ID, "name", lib.Name, "path", lib.Path, "folderPath", folderPath) } } } @@ -117,6 +145,12 @@ func (w *watcher) Watch(ctx context.Context, lib *model.Library) error { w.mu.Lock() defer w.mu.Unlock() + // If Run() hasn't been called yet, mainCtx will be nil - skip watching + if w.mainCtx == nil { + log.Debug(ctx, "Watcher not started yet, skipping watch for library", "libraryID", lib.ID, "name", lib.Name) + return nil + } + // Stop existing watcher if any if existingInstance, exists := w.libraryWatchers[lib.ID]; exists { log.Debug(ctx, "Stopping existing watcher before starting new one", "libraryID", lib.ID, "name", lib.Name) @@ -124,7 +158,7 @@ func (w *watcher) Watch(ctx context.Context, lib *model.Library) error { } // Start new watcher - watcherCtx, cancel := context.WithCancel(w.mainCtx) + watcherCtx, cancel := context.WithCancel(w.mainCtx) //nolint:gosec // cancel is stored in instance and called on shutdown instance := &libraryWatcherInstance{ library: lib, cancel: cancel, @@ -199,13 +233,18 @@ func (w *watcher) watchLibrary(ctx context.Context, lib *model.Library) error { log.Info(ctx, "Watcher started for library", "libraryID", lib.ID, "name", lib.Name, "path", lib.Path, "absoluteLibPath", absLibPath) + return w.processLibraryEvents(ctx, lib, fsys, c, absLibPath) +} + +// processLibraryEvents processes filesystem events for a library. +func (w *watcher) processLibraryEvents(ctx context.Context, lib *model.Library, fsys storage.MusicFS, events <-chan string, absLibPath string) error { for { select { case <-ctx.Done(): log.Debug(ctx, "Watcher stopped due to context cancellation", "libraryID", lib.ID, "name", lib.Name) return nil - case path := <-c: - path, err = filepath.Rel(absLibPath, path) + case path := <-events: + path, err := filepath.Rel(absLibPath, path) if err != nil { log.Error(ctx, "Error getting relative path", "libraryID", lib.ID, "absolutePath", absLibPath, "path", path, err) continue @@ -215,19 +254,71 @@ func (w *watcher) watchLibrary(ctx context.Context, lib *model.Library) error { log.Trace(ctx, "Ignoring change", "libraryID", lib.ID, "path", path) continue } - log.Trace(ctx, "Detected change", "libraryID", lib.ID, "path", path, "absoluteLibPath", absLibPath) - // Notify the main watcher of changes - select { - case w.watcherNotify <- *lib: - default: - // Channel is full, notification already pending + // Check if the original path (before resolution) matches .ndignore patterns + // This is crucial for deleted folders - if a deleted folder matches .ndignore, + // we should ignore it BEFORE resolveFolderPath walks up to the parent + if w.shouldIgnoreFolderPath(ctx, fsys, path) { + log.Debug(ctx, "Ignoring change matching .ndignore pattern", "libraryID", lib.ID, "path", path) + continue } + + // Find the folder to scan - validate path exists as directory, walk up if needed + folderPath := resolveFolderPath(fsys, path) + // Double-check after resolution in case the resolved path is different and also matches patterns + if folderPath != path && w.shouldIgnoreFolderPath(ctx, fsys, folderPath) { + log.Trace(ctx, "Ignoring change in folder matching .ndignore pattern", "libraryID", lib.ID, "folderPath", folderPath) + continue + } + + // Notify the main watcher of changes. This will trigger a scan after the debounce period. + w.watcherNotify <- scanNotification{Library: lib, FolderPath: folderPath} } } } +// resolveFolderPath takes a path (which may be a file or directory) and returns +// the folder path to scan. If the path is a file, it walks up to find the parent +// directory. Returns empty string if the path should scan the library root. +func resolveFolderPath(fsys fs.FS, path string) string { + // Handle root paths immediately + if path == "." || path == "" { + return "" + } + + folderPath := path + for { + info, err := fs.Stat(fsys, folderPath) + if err == nil && info.IsDir() { + // Found a valid directory + return folderPath + } + if folderPath == "." || folderPath == "" { + // Reached root, scan entire library + return "" + } + // Walk up the tree + dir, _ := filepath.Split(folderPath) + if dir == "" || dir == "." { + return "" + } + // Remove trailing slash + folderPath = filepath.Clean(dir) + } +} + +// shouldIgnoreFolderPath checks if the given folderPath should be ignored based on .ndignore patterns +// in the library. It pushes all parent folders onto the IgnoreChecker stack before checking. +func (w *watcher) shouldIgnoreFolderPath(ctx context.Context, fsys storage.MusicFS, folderPath string) bool { + checker := newIgnoreChecker(fsys) + err := checker.PushAllParents(ctx, folderPath) + if err != nil { + log.Warn(ctx, "Watcher: Error pushing ignore patterns for folder", "path", folderPath, err) + } + return checker.ShouldIgnore(ctx, folderPath) +} + func isIgnoredPath(_ context.Context, _ fs.FS, path string) bool { baseDir, name := filepath.Split(path) switch { diff --git a/scanner/watcher_test.go b/scanner/watcher_test.go new file mode 100644 index 000000000..e1600db32 --- /dev/null +++ b/scanner/watcher_test.go @@ -0,0 +1,500 @@ +package scanner + +import ( + "context" + "io/fs" + "path/filepath" + "testing/fstest" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Watcher", func() { + var ctx context.Context + var cancel context.CancelFunc + var mockScanner *tests.MockScanner + var mockDS *tests.MockDataStore + var w *watcher + var lib *model.Library + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Scanner.WatcherWait = 50 * time.Millisecond // Short wait for tests + + ctx, cancel = context.WithCancel(GinkgoT().Context()) + DeferCleanup(cancel) + + lib = &model.Library{ + ID: 1, + Name: "Test Library", + Path: "/test/library", + } + + // Set up mocks + mockScanner = tests.NewMockScanner() + mockDS = &tests.MockDataStore{} + mockLibRepo := &tests.MockLibraryRepo{} + mockLibRepo.SetData(model.Libraries{*lib}) + mockDS.MockedLibrary = mockLibRepo + + // Create a new watcher instance (not singleton) for testing + w = &watcher{ + ds: mockDS, + scanner: mockScanner, + triggerWait: conf.Server.Scanner.WatcherWait, + watcherNotify: make(chan scanNotification, 10), + libraryWatchers: make(map[int]*libraryWatcherInstance), + mainCtx: ctx, + } + }) + + Describe("Watch before Run", func() { + It("returns nil and does not panic when mainCtx is nil", func() { + w.mainCtx = nil + err := w.Watch(ctx, lib) + Expect(err).ToNot(HaveOccurred()) + Expect(w.libraryWatchers).To(BeEmpty()) + }) + }) + + Describe("Target Collection and Deduplication", func() { + BeforeEach(func() { + // Start watcher in background + go func() { + _ = w.Run(ctx) + }() + + // Give watcher time to initialize + time.Sleep(10 * time.Millisecond) + }) + + It("creates separate targets for different folders", func() { + // Send notifications for different folders + w.watcherNotify <- scanNotification{Library: lib, FolderPath: "artist1"} + time.Sleep(10 * time.Millisecond) + w.watcherNotify <- scanNotification{Library: lib, FolderPath: "artist2"} + + // Wait for watcher to process and trigger scan + Eventually(func() int { + return mockScanner.GetScanFoldersCallCount() + }, 200*time.Millisecond, 10*time.Millisecond).Should(Equal(1)) + + // Verify two targets + calls := mockScanner.GetScanFoldersCalls() + Expect(calls).To(HaveLen(1)) + Expect(calls[0].Targets).To(HaveLen(2)) + + // Extract folder paths + folderPaths := make(map[string]bool) + for _, target := range calls[0].Targets { + Expect(target.LibraryID).To(Equal(1)) + folderPaths[target.FolderPath] = true + } + Expect(folderPaths).To(HaveKey("artist1")) + Expect(folderPaths).To(HaveKey("artist2")) + }) + + It("handles different folder paths correctly", func() { + // Send notification for nested folder + w.watcherNotify <- scanNotification{Library: lib, FolderPath: "artist1/album1"} + + // Wait for watcher to process and trigger scan + Eventually(func() int { + return mockScanner.GetScanFoldersCallCount() + }, 200*time.Millisecond, 10*time.Millisecond).Should(Equal(1)) + + // Verify the target + calls := mockScanner.GetScanFoldersCalls() + Expect(calls).To(HaveLen(1)) + Expect(calls[0].Targets).To(HaveLen(1)) + Expect(calls[0].Targets[0].FolderPath).To(Equal("artist1/album1")) + }) + + It("deduplicates folder and file within same folder", func() { + // Send notification for a folder + w.watcherNotify <- scanNotification{Library: lib, FolderPath: "artist1/album1"} + time.Sleep(10 * time.Millisecond) + // Send notification for same folder (as if file change was detected there) + // In practice, watchLibrary() would walk up from file path to folder + w.watcherNotify <- scanNotification{Library: lib, FolderPath: "artist1/album1"} + time.Sleep(10 * time.Millisecond) + // Send another for same folder + w.watcherNotify <- scanNotification{Library: lib, FolderPath: "artist1/album1"} + + // Wait for watcher to process and trigger scan + Eventually(func() int { + return mockScanner.GetScanFoldersCallCount() + }, 200*time.Millisecond, 10*time.Millisecond).Should(Equal(1)) + + // Verify only one target despite multiple file/folder changes + calls := mockScanner.GetScanFoldersCalls() + Expect(calls).To(HaveLen(1)) + Expect(calls[0].Targets).To(HaveLen(1)) + Expect(calls[0].Targets[0].FolderPath).To(Equal("artist1/album1")) + }) + }) + + Describe("Timer Behavior", func() { + BeforeEach(func() { + // Start watcher in background + go func() { + _ = w.Run(ctx) + }() + + // Give watcher time to initialize + time.Sleep(10 * time.Millisecond) + }) + + It("resets timer on each change (debouncing)", func() { + // Send first notification + w.watcherNotify <- scanNotification{Library: lib, FolderPath: "artist1"} + + // Wait a bit less than half the watcher wait time to ensure timer doesn't fire + time.Sleep(20 * time.Millisecond) + + // No scan should have been triggered yet + Expect(mockScanner.GetScanFoldersCallCount()).To(Equal(0)) + + // Send another notification (resets timer) + w.watcherNotify <- scanNotification{Library: lib, FolderPath: "artist1"} + + // Wait a bit less than half the watcher wait time again + time.Sleep(20 * time.Millisecond) + + // Still no scan + Expect(mockScanner.GetScanFoldersCallCount()).To(Equal(0)) + + // Wait for full timer to expire after last notification (plus margin) + time.Sleep(60 * time.Millisecond) + + // Now scan should have been triggered + Eventually(func() int { + return mockScanner.GetScanFoldersCallCount() + }, 100*time.Millisecond, 10*time.Millisecond).Should(Equal(1)) + }) + + It("triggers scan after quiet period", func() { + // Send notification + w.watcherNotify <- scanNotification{Library: lib, FolderPath: "artist1"} + + // No scan immediately + Expect(mockScanner.GetScanFoldersCallCount()).To(Equal(0)) + + // Wait for quiet period + Eventually(func() int { + return mockScanner.GetScanFoldersCallCount() + }, 200*time.Millisecond, 10*time.Millisecond).Should(Equal(1)) + }) + }) + + Describe("Empty and Root Paths", func() { + BeforeEach(func() { + // Start watcher in background + go func() { + _ = w.Run(ctx) + }() + + // Give watcher time to initialize + time.Sleep(10 * time.Millisecond) + }) + + It("handles empty folder path (library root)", func() { + // Send notification with empty folder path + w.watcherNotify <- scanNotification{Library: lib, FolderPath: ""} + + // Wait for scan + Eventually(func() int { + return mockScanner.GetScanFoldersCallCount() + }, 200*time.Millisecond, 10*time.Millisecond).Should(Equal(1)) + + // Should scan the library root + calls := mockScanner.GetScanFoldersCalls() + Expect(calls).To(HaveLen(1)) + Expect(calls[0].Targets).To(HaveLen(1)) + Expect(calls[0].Targets[0].FolderPath).To(Equal("")) + }) + + It("deduplicates empty and dot paths", func() { + // Send notifications with empty and dot paths + w.watcherNotify <- scanNotification{Library: lib, FolderPath: ""} + time.Sleep(10 * time.Millisecond) + w.watcherNotify <- scanNotification{Library: lib, FolderPath: ""} + + // Wait for scan + Eventually(func() int { + return mockScanner.GetScanFoldersCallCount() + }, 200*time.Millisecond, 10*time.Millisecond).Should(Equal(1)) + + // Should have only one target + calls := mockScanner.GetScanFoldersCalls() + Expect(calls).To(HaveLen(1)) + Expect(calls[0].Targets).To(HaveLen(1)) + }) + }) + + Describe("Multiple Libraries", func() { + var lib2 *model.Library + + BeforeEach(func() { + // Create second library + lib2 = &model.Library{ + ID: 2, + Name: "Test Library 2", + Path: "/test/library2", + } + + mockLibRepo := mockDS.MockedLibrary.(*tests.MockLibraryRepo) + mockLibRepo.SetData(model.Libraries{*lib, *lib2}) + + // Start watcher in background + go func() { + _ = w.Run(ctx) + }() + + // Give watcher time to initialize + time.Sleep(10 * time.Millisecond) + }) + + It("creates separate targets for different libraries", func() { + // Send notifications for both libraries + w.watcherNotify <- scanNotification{Library: lib, FolderPath: "artist1"} + time.Sleep(10 * time.Millisecond) + w.watcherNotify <- scanNotification{Library: lib2, FolderPath: "artist2"} + + // Wait for scan + Eventually(func() int { + return mockScanner.GetScanFoldersCallCount() + }, 200*time.Millisecond, 10*time.Millisecond).Should(Equal(1)) + + // Verify two targets for different libraries + calls := mockScanner.GetScanFoldersCalls() + Expect(calls).To(HaveLen(1)) + Expect(calls[0].Targets).To(HaveLen(2)) + + // Verify library IDs are different + libraryIDs := make(map[int]bool) + for _, target := range calls[0].Targets { + libraryIDs[target.LibraryID] = true + } + Expect(libraryIDs).To(HaveKey(1)) + Expect(libraryIDs).To(HaveKey(2)) + }) + }) + + Describe(".ndignore handling", func() { + var ctx context.Context + var cancel context.CancelFunc + var w *watcher + var mockFS *mockMusicFS + var lib *model.Library + var eventChan chan string + var absLibPath string + + BeforeEach(func() { + ctx, cancel = context.WithCancel(GinkgoT().Context()) + DeferCleanup(cancel) + + // Set up library + var err error + absLibPath, err = filepath.Abs(".") + Expect(err).NotTo(HaveOccurred()) + + lib = &model.Library{ + ID: 1, + Name: "Test Library", + Path: absLibPath, + } + + // Create watcher with notification channel + w = &watcher{ + watcherNotify: make(chan scanNotification, 10), + } + + eventChan = make(chan string, 10) + }) + + // Helper to send an event - converts relative path to absolute + sendEvent := func(relativePath string) { + path := filepath.Join(absLibPath, relativePath) + eventChan <- path + } + + // Helper to start the real event processing loop + startEventProcessing := func() { + go func() { + defer GinkgoRecover() + // Call the actual processLibraryEvents method - testing the real implementation! + _ = w.processLibraryEvents(ctx, lib, mockFS, eventChan, absLibPath) + }() + } + + Context("when a folder matching .ndignore is deleted", func() { + BeforeEach(func() { + // Create filesystem with .ndignore containing _TEMP pattern + // The deleted folder (_TEMP) will NOT exist in the filesystem + mockFS = &mockMusicFS{ + FS: fstest.MapFS{ + "rock": &fstest.MapFile{Mode: fs.ModeDir}, + "rock/.ndignore": &fstest.MapFile{Data: []byte("_TEMP\n")}, + "rock/valid_album": &fstest.MapFile{Mode: fs.ModeDir}, + "rock/valid_album/track.mp3": &fstest.MapFile{Data: []byte("audio")}, + }, + } + }) + + It("should NOT send scan notification when deleted folder matches .ndignore", func() { + startEventProcessing() + + // Simulate deletion event for rock/_TEMP + sendEvent("rock/_TEMP") + + // Wait a bit to ensure event is processed + time.Sleep(50 * time.Millisecond) + + // No notification should have been sent + Consistently(eventChan, 100*time.Millisecond).Should(BeEmpty()) + }) + + It("should send scan notification for valid folder deletion", func() { + startEventProcessing() + + // Simulate deletion event for rock/other_folder (not in .ndignore and doesn't exist) + // Since it doesn't exist in mockFS, resolveFolderPath will walk up to "rock" + sendEvent("rock/other_folder") + + // Should receive notification for parent folder + Eventually(w.watcherNotify, 200*time.Millisecond).Should(Receive(Equal(scanNotification{ + Library: lib, + FolderPath: "rock", + }))) + }) + }) + + Context("with nested folder patterns", func() { + BeforeEach(func() { + mockFS = &mockMusicFS{ + FS: fstest.MapFS{ + "music": &fstest.MapFile{Mode: fs.ModeDir}, + "music/.ndignore": &fstest.MapFile{Data: []byte("**/temp\n**/cache\n")}, + "music/rock": &fstest.MapFile{Mode: fs.ModeDir}, + "music/rock/artist": &fstest.MapFile{Mode: fs.ModeDir}, + }, + } + }) + + It("should NOT send notification when nested ignored folder is deleted", func() { + startEventProcessing() + + // Simulate deletion of music/rock/artist/temp (matches **/temp) + sendEvent("music/rock/artist/temp") + + // Wait to ensure event is processed + time.Sleep(50 * time.Millisecond) + + // No notification should be sent + Expect(w.watcherNotify).To(BeEmpty(), "Expected no scan notification for nested ignored folder") + }) + + It("should send notification for non-ignored nested folder", func() { + startEventProcessing() + + // Simulate change in music/rock/artist (doesn't match any pattern) + sendEvent("music/rock/artist") + + // Should receive notification + Eventually(w.watcherNotify, 200*time.Millisecond).Should(Receive(Equal(scanNotification{ + Library: lib, + FolderPath: "music/rock/artist", + }))) + }) + }) + + Context("with file events in ignored folders", func() { + BeforeEach(func() { + mockFS = &mockMusicFS{ + FS: fstest.MapFS{ + "rock": &fstest.MapFile{Mode: fs.ModeDir}, + "rock/.ndignore": &fstest.MapFile{Data: []byte("_TEMP\n")}, + }, + } + }) + + It("should NOT send notification for file changes in ignored folders", func() { + startEventProcessing() + + // Simulate file change in rock/_TEMP/file.mp3 + sendEvent("rock/_TEMP/file.mp3") + + // Wait to ensure event is processed + time.Sleep(50 * time.Millisecond) + + // No notification should be sent + Expect(w.watcherNotify).To(BeEmpty(), "Expected no scan notification for file in ignored folder") + }) + }) + }) +}) + +var _ = Describe("resolveFolderPath", func() { + var mockFS fs.FS + + BeforeEach(func() { + // Create a mock filesystem with some directories and files + mockFS = fstest.MapFS{ + "artist1": &fstest.MapFile{Mode: fs.ModeDir}, + "artist1/album1": &fstest.MapFile{Mode: fs.ModeDir}, + "artist1/album1/track1.mp3": &fstest.MapFile{Data: []byte("audio")}, + "artist1/album1/track2.mp3": &fstest.MapFile{Data: []byte("audio")}, + "artist1/album2": &fstest.MapFile{Mode: fs.ModeDir}, + "artist1/album2/song.flac": &fstest.MapFile{Data: []byte("audio")}, + "artist2": &fstest.MapFile{Mode: fs.ModeDir}, + "artist2/cover.jpg": &fstest.MapFile{Data: []byte("image")}, + } + }) + + It("returns directory path when given a directory", func() { + result := resolveFolderPath(mockFS, "artist1/album1") + Expect(result).To(Equal("artist1/album1")) + }) + + It("walks up to parent directory when given a file path", func() { + result := resolveFolderPath(mockFS, "artist1/album1/track1.mp3") + Expect(result).To(Equal("artist1/album1")) + }) + + It("walks up multiple levels if needed", func() { + result := resolveFolderPath(mockFS, "artist1/album1/nonexistent/file.mp3") + Expect(result).To(Equal("artist1/album1")) + }) + + It("returns empty string for non-existent paths at root", func() { + result := resolveFolderPath(mockFS, "nonexistent/path/file.mp3") + Expect(result).To(Equal("")) + }) + + It("returns empty string for dot path", func() { + result := resolveFolderPath(mockFS, ".") + Expect(result).To(Equal("")) + }) + + It("returns empty string for empty path", func() { + result := resolveFolderPath(mockFS, "") + Expect(result).To(Equal("")) + }) + + It("handles nested file paths correctly", func() { + result := resolveFolderPath(mockFS, "artist1/album2/song.flac") + Expect(result).To(Equal("artist1/album2")) + }) + + It("resolves to top-level directory", func() { + result := resolveFolderPath(mockFS, "artist2/cover.jpg") + Expect(result).To(Equal("artist2")) + }) +}) diff --git a/scheduler/crontab_schedule.go b/scheduler/crontab_schedule.go new file mode 100644 index 000000000..5de1ae145 --- /dev/null +++ b/scheduler/crontab_schedule.go @@ -0,0 +1,133 @@ +package scheduler + +import ( + "fmt" + "math/rand/v2" + "strconv" + "strings" + "time" + + "github.com/robfig/cron/v3" +) + +var parser = cron.NewParser( + cron.SecondOptional | cron.Minute | cron.Hour | cron.Dom | cron.Month | cron.Dow | cron.Descriptor, +) + +// ParseCrontab parses a cron expression with support for the crontab(5) random ~ syntax. +// Random values are resolved once at parse time. If no ~ is present, it delegates to +// robfig/cron's standard parser. Duration strings (e.g., "5m") are converted to "@every 5m". +func ParseCrontab(spec string) (cron.Schedule, error) { + if spec == "" { + return nil, fmt.Errorf("empty spec string") + } + + if _, err := time.ParseDuration(spec); err == nil { + spec = "@every " + spec + } + + if !strings.Contains(spec, "~") { + return parser.Parse(spec) + } + + // Handle TZ=/CRON_TZ= prefix + var tzPrefix string + if strings.HasPrefix(spec, "TZ=") || strings.HasPrefix(spec, "CRON_TZ=") { + i := strings.Index(spec, " ") + if i == -1 { + return nil, fmt.Errorf("missing spec after timezone") + } + tzPrefix = spec[:i] + " " + spec = strings.TrimSpace(spec[i:]) + } + + // @ descriptors cannot contain ~ + if strings.HasPrefix(spec, "@") { + return nil, fmt.Errorf("random ~ syntax cannot be used with descriptors: %s", spec) + } + + fields := strings.Fields(spec) + fields, err := normalizeFields(fields) + if err != nil { + return nil, err + } + + // Resolve each ~ field to a concrete random value + for i, field := range fields { + if !strings.Contains(field, "~") { + continue + } + if strings.ContainsAny(field, ",/") { + return nil, fmt.Errorf("random ~ cannot be combined with lists or steps: %s", field) + } + v, parseErr := resolveRandomField(field, fieldBounds[i]) + if parseErr != nil { + return nil, parseErr + } + fields[i] = strconv.FormatUint(uint64(v), 10) + } + + // Re-assemble and parse with robfig + resolved := tzPrefix + strings.Join(fields, " ") + return parser.Parse(resolved) +} + +type bounds struct { + min, max uint +} + +var fieldBounds = [6]bounds{ + {0, 59}, // Second + {0, 59}, // Minute + {0, 23}, // Hour + {1, 31}, // Dom + {1, 12}, // Month + {0, 6}, // Dow +} + +// resolveRandomField parses a ~ field and returns a random value within the range. +func resolveRandomField(field string, b bounds) (uint, error) { + parts := strings.SplitN(field, "~", 2) + + min := b.min + max := b.max + + if parts[0] != "" { + v, err := strconv.ParseUint(parts[0], 10, 0) + if err != nil { + return 0, fmt.Errorf("invalid random range start: %s", parts[0]) + } + min = uint(v) + } + + if parts[1] != "" { + v, err := strconv.ParseUint(parts[1], 10, 0) + if err != nil { + return 0, fmt.Errorf("invalid random range end: %s", parts[1]) + } + max = uint(v) + } + + if min < b.min { + return 0, fmt.Errorf("random range start (%d) below minimum (%d): %s", min, b.min, field) + } + if max > b.max { + return 0, fmt.Errorf("random range end (%d) above maximum (%d): %s", max, b.max, field) + } + if min > max { + return 0, fmt.Errorf("random range start (%d) beyond end (%d): %s", min, max, field) + } + + return min + uint(rand.IntN(int(max-min+1))), nil //nolint:gosec // Cryptographic randomness not needed for schedule jitter +} + +func normalizeFields(fields []string) ([]string, error) { + switch len(fields) { + case 5: + return append([]string{"0"}, fields...), nil + case 6: + return fields, nil + default: + return nil, fmt.Errorf("expected 5 or 6 fields, found %d: %v", len(fields), fields) + } +} diff --git a/scheduler/crontab_schedule_test.go b/scheduler/crontab_schedule_test.go new file mode 100644 index 000000000..b1e26f1de --- /dev/null +++ b/scheduler/crontab_schedule_test.go @@ -0,0 +1,194 @@ +package scheduler + +import ( + "time" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + "github.com/robfig/cron/v3" +) + +var _ = Describe("ParseCrontab", func() { + Describe("standard expressions", func() { + It("parses a 5-field expression", func() { + sched, err := ParseCrontab("5 * * * *") + Expect(err).ToNot(HaveOccurred()) + Expect(sched).To(BeAssignableToTypeOf(&cron.SpecSchedule{})) + }) + + It("parses a 6-field expression with seconds", func() { + sched, err := ParseCrontab("30 5 * * * *") + Expect(err).ToNot(HaveOccurred()) + Expect(sched).To(BeAssignableToTypeOf(&cron.SpecSchedule{})) + }) + + It("converts duration string to @every", func() { + sched, err := ParseCrontab("5m") + Expect(err).ToNot(HaveOccurred()) + Expect(sched).To(BeAssignableToTypeOf(cron.ConstantDelaySchedule{})) + }) + + It("returns error for empty string", func() { + _, err := ParseCrontab("") + Expect(err).To(HaveOccurred()) + }) + }) + + Describe("random ~ syntax", func() { + It("resolves A~B to a value within range", func() { + sched, err := ParseCrontab("0~30 * * * *") + Expect(err).ToNot(HaveOccurred()) + spec := sched.(*cron.SpecSchedule) + minute := findSetBit(spec.Minute) + Expect(minute).To(BeNumerically(">=", 0)) + Expect(minute).To(BeNumerically("<=", 30)) + }) + + It("resolves ~ alone to full field range", func() { + sched, err := ParseCrontab("~ * * * *") + Expect(err).ToNot(HaveOccurred()) + spec := sched.(*cron.SpecSchedule) + minute := findSetBit(spec.Minute) + Expect(minute).To(BeNumerically(">=", 0)) + Expect(minute).To(BeNumerically("<=", 59)) + }) + + It("resolves ~B as min~B", func() { + sched, err := ParseCrontab("~15 * * * *") + Expect(err).ToNot(HaveOccurred()) + spec := sched.(*cron.SpecSchedule) + minute := findSetBit(spec.Minute) + Expect(minute).To(BeNumerically(">=", 0)) + Expect(minute).To(BeNumerically("<=", 15)) + }) + + It("resolves A~ as A~max", func() { + sched, err := ParseCrontab("15~ * * * *") + Expect(err).ToNot(HaveOccurred()) + spec := sched.(*cron.SpecSchedule) + minute := findSetBit(spec.Minute) + Expect(minute).To(BeNumerically(">=", 15)) + Expect(minute).To(BeNumerically("<=", 59)) + }) + + It("resolves multiple random fields independently", func() { + sched, err := ParseCrontab("0~30 0~12 * * *") + Expect(err).ToNot(HaveOccurred()) + spec := sched.(*cron.SpecSchedule) + Expect(findSetBit(spec.Minute)).To(BeNumerically("<=", 30)) + Expect(findSetBit(spec.Hour)).To(BeNumerically("<=", 12)) + }) + + It("resolves ~ in DOM field with correct bounds", func() { + sched, err := ParseCrontab("0 0 ~ * *") + Expect(err).ToNot(HaveOccurred()) + spec := sched.(*cron.SpecSchedule) + dom := findSetBit(spec.Dom) + Expect(dom).To(BeNumerically(">=", 1)) + Expect(dom).To(BeNumerically("<=", 31)) + }) + + It("resolves ~ in month field with correct bounds", func() { + sched, err := ParseCrontab("0 0 1 ~ *") + Expect(err).ToNot(HaveOccurred()) + spec := sched.(*cron.SpecSchedule) + month := findSetBit(spec.Month) + Expect(month).To(BeNumerically(">=", 1)) + Expect(month).To(BeNumerically("<=", 12)) + }) + + It("resolves ~ in DOW field with correct bounds", func() { + sched, err := ParseCrontab("0 0 * * ~") + Expect(err).ToNot(HaveOccurred()) + spec := sched.(*cron.SpecSchedule) + dow := findSetBit(spec.Dow) + Expect(dow).To(BeNumerically(">=", 0)) + Expect(dow).To(BeNumerically("<=", 6)) + }) + + It("preserves TZ= prefix through resolution", func() { + sched, err := ParseCrontab("TZ=America/New_York 0~30 * * * *") + Expect(err).ToNot(HaveOccurred()) + spec := sched.(*cron.SpecSchedule) + nyc, _ := time.LoadLocation("America/New_York") + Expect(spec.Location).To(Equal(nyc)) + }) + + It("preserves non-random fields", func() { + sched, err := ParseCrontab("0~30 10 * * *") + Expect(err).ToNot(HaveOccurred()) + spec := sched.(*cron.SpecSchedule) + Expect(spec.Hour & (1 << 10)).ToNot(BeZero()) + }) + + It("resolves to a stable value across repeated Next calls", func() { + sched, err := ParseCrontab("0~30 * * * *") + Expect(err).ToNot(HaveOccurred()) + + ref := time.Date(2025, 1, 1, 12, 0, 0, 0, time.UTC) + first := sched.Next(ref) + for range 50 { + Expect(sched.Next(ref)).To(Equal(first)) + } + }) + }) + + Describe("error cases", func() { + It("rejects min > max", func() { + _, err := ParseCrontab("30~0 * * * *") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("beyond end")) + }) + + It("rejects value above field maximum", func() { + _, err := ParseCrontab("0~60 * * * *") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("above maximum")) + }) + + It("rejects value below field minimum", func() { + _, err := ParseCrontab("0 0 0~15 * *") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("below minimum")) + }) + + It("rejects ~ mixed with comma (list)", func() { + _, err := ParseCrontab("0~30,45 * * * *") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("cannot be combined")) + }) + + It("rejects ~ mixed with slash (step)", func() { + _, err := ParseCrontab("0~30/5 * * * *") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("cannot be combined")) + }) + + It("rejects @ descriptor with ~", func() { + _, err := ParseCrontab("@every 0~30m") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("descriptor")) + }) + + It("rejects wrong number of fields", func() { + _, err := ParseCrontab("0~30 * *") + Expect(err).To(HaveOccurred()) + }) + + It("rejects non-numeric range values", func() { + _, err := ParseCrontab("a~b * * * *") + Expect(err).To(HaveOccurred()) + }) + }) +}) + +// findSetBit returns the lowest bit position set in v, ignoring the starBit (bit 63). +func findSetBit(v uint64) int { + v &^= 1 << 63 // clear starBit + for i := 0; i < 63; i++ { + if v&(1<<uint(i)) != 0 { + return i + } + } + return -1 +} diff --git a/scheduler/log_adapter.go b/scheduler/log_adapter.go index ccaab0cd4..057818785 100644 --- a/scheduler/log_adapter.go +++ b/scheduler/log_adapter.go @@ -6,16 +6,16 @@ import ( type logger struct{} -func (l *logger) Info(msg string, keysAndValues ...interface{}) { - args := []interface{}{ +func (l *logger) Info(msg string, keysAndValues ...any) { + args := []any{ "Scheduler: " + msg, } args = append(args, keysAndValues...) log.Debug(args...) } -func (l *logger) Error(err error, msg string, keysAndValues ...interface{}) { - args := []interface{}{ +func (l *logger) Error(err error, msg string, keysAndValues ...any) { + args := []any{ "Scheduler: " + msg, } args = append(args, keysAndValues...) diff --git a/scheduler/scheduler.go b/scheduler/scheduler.go index b377e7947..cb53af421 100644 --- a/scheduler/scheduler.go +++ b/scheduler/scheduler.go @@ -33,10 +33,11 @@ func (s *scheduler) Run(ctx context.Context) { } func (s *scheduler) Add(crontab string, cmd func()) (int, error) { - entryID, err := s.c.AddFunc(crontab, cmd) + schedule, err := ParseCrontab(crontab) if err != nil { return 0, err } + entryID := s.c.Schedule(schedule, cron.FuncJob(cmd)) return int(entryID), nil } diff --git a/scheduler/scheduler_test.go b/scheduler/scheduler_test.go index 4737ae389..1a134a7f3 100644 --- a/scheduler/scheduler_test.go +++ b/scheduler/scheduler_test.go @@ -1,19 +1,15 @@ package scheduler import ( - "sync" "testing" - "time" "github.com/navidrome/navidrome/log" - "github.com/navidrome/navidrome/tests" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" "github.com/robfig/cron/v3" ) func TestScheduler(t *testing.T) { - tests.Init(t, false) log.SetLevel(log.LevelFatal) RegisterFailHandler(Fail) RunSpecs(t, "Scheduler Suite") @@ -33,54 +29,22 @@ var _ = Describe("Scheduler", func() { }) It("adds and executes a job", func() { - wg := sync.WaitGroup{} - wg.Add(1) + done := make(chan struct{}) - executed := false - id, err := s.Add("@every 100ms", func() { - executed = true - wg.Done() + id, err := s.Add("@every 50ms", func() { + close(done) }) Expect(err).ToNot(HaveOccurred()) Expect(id).ToNot(BeZero()) - wg.Wait() - Expect(executed).To(BeTrue()) + Eventually(done).Should(BeClosed()) }) - It("removes a job", func() { - // Use a WaitGroup to ensure the job executes once - wg := sync.WaitGroup{} - wg.Add(1) - - counter := 0 - id, err := s.Add("@every 100ms", func() { - counter++ - if counter == 1 { - wg.Done() // Signal that the job has executed once - } - }) - + It("adds a job with random ~ syntax", func() { + id, err := s.Add("0~59 * * * *", func() {}) Expect(err).ToNot(HaveOccurred()) Expect(id).ToNot(BeZero()) - - // Wait for the job to execute at least once - wg.Wait() - - // Verify job executed - Expect(counter).To(Equal(1)) - - // Remove the job s.Remove(id) - - // Store the counter value - currentCount := counter - - // Wait some time to ensure job doesn't execute again - time.Sleep(200 * time.Millisecond) - - // Verify counter didn't increase - Expect(counter).To(Equal(currentCount)) }) }) diff --git a/scripts/setup-worktree.sh b/scripts/setup-worktree.sh new file mode 100755 index 000000000..65113f3b2 --- /dev/null +++ b/scripts/setup-worktree.sh @@ -0,0 +1,57 @@ +#!/usr/bin/env bash +# +# Setup a git worktree for Navidrome development. +# This script is called automatically by `make worktree` and by Claude Code's +# worktree isolation, but can also be run standalone: +# +# ./scripts/setup-worktree.sh <worktree-path> [--go-only] +# +# Options: +# --go-only Skip frontend (npm) setup. Useful for agents working only on Go code. +# +set -euo pipefail + +WORKTREE_PATH="${1:?Usage: $0 <worktree-path> [--go-only]}" +GO_ONLY="${2:-}" + +# Resolve the main worktree root (where the original repo lives) +MAIN_WORKTREE="$(git -C "$WORKTREE_PATH" worktree list --porcelain | head -1 | sed 's/^worktree //')" + +if [ ! -d "$WORKTREE_PATH" ]; then + echo "ERROR: Worktree path does not exist: $WORKTREE_PATH" + exit 1 +fi + +cd "$WORKTREE_PATH" + +echo "==> Setting up worktree at $WORKTREE_PATH" + +# 1. Download Go dependencies +echo "==> Downloading Go dependencies..." +go mod download + +# 2. Install frontend dependencies (unless --go-only) +if [ "$GO_ONLY" != "--go-only" ]; then + echo "==> Installing frontend dependencies..." + (cd ui && npm ci --prefer-offline --no-audit 2>/dev/null || npm ci) +else + echo "==> Skipping frontend setup (--go-only)" +fi + +# 3. Create required directories +mkdir -p data + +# 4. Copy navidrome.toml from main worktree if it exists and not already present +if [ ! -f navidrome.toml ] && [ -f "$MAIN_WORKTREE/navidrome.toml" ]; then + echo "==> Copying navidrome.toml from main worktree..." + cp "$MAIN_WORKTREE/navidrome.toml" navidrome.toml +fi + +# 5. Copy existing database from main worktree (already migrated and scanned) +# This is much faster than running migrations + a full scan from scratch. +if [ ! -f data/navidrome.db ] && [ -f "$MAIN_WORKTREE/data/navidrome.db" ]; then + echo "==> Copying database from main worktree (pre-migrated, pre-scanned)..." + cp "$MAIN_WORKTREE/data/navidrome.db" data/navidrome.db +fi + +echo "==> Worktree setup complete: $WORKTREE_PATH" diff --git a/server/auth.go b/server/auth.go index ed43974dd..a7edaab0a 100644 --- a/server/auth.go +++ b/server/auth.go @@ -68,8 +68,8 @@ func doLogin(ds model.DataStore, username string, password string, w http.Respon _ = rest.RespondWithJSON(w, http.StatusOK, payload) } -func buildAuthPayload(user *model.User) map[string]interface{} { - payload := map[string]interface{}{ +func buildAuthPayload(user *model.User) map[string]any { + payload := map[string]any{ "id": user.ID, "name": user.Name, "username": user.UserName, @@ -185,32 +185,36 @@ func tokenFromHeader(r *http.Request) string { } func UsernameFromToken(r *http.Request) string { - token, claims, err := jwtauth.FromContext(r.Context()) - if err != nil || claims["sub"] == nil || token == nil { + token, _, err := jwtauth.FromContext(r.Context()) + if err != nil || token == nil { return "" } - log.Trace(r, "Found username in JWT token", "username", token.Subject()) - return token.Subject() + sub, _ := token.Subject() + if sub == "" { + return "" + } + log.Trace(r, "Found username in JWT token", "username", sub) + return sub } -func UsernameFromReverseProxyHeader(r *http.Request) string { - if conf.Server.ReverseProxyWhitelist == "" { +func UsernameFromExtAuthHeader(r *http.Request) string { + if conf.Server.ExtAuth.TrustedSources == "" { return "" } reverseProxyIp, ok := request.ReverseProxyIpFrom(r.Context()) if !ok { - log.Error("ReverseProxyWhitelist enabled but no proxy IP found in request context. Please report this error.") + log.Error("ExtAuth enabled but no proxy IP found in request context. Please report this error.") return "" } - if !validateIPAgainstList(reverseProxyIp, conf.Server.ReverseProxyWhitelist) { - log.Warn(r.Context(), "IP is not whitelisted for reverse proxy login", "proxy-ip", reverseProxyIp, "client-ip", r.RemoteAddr) + if !validateIPAgainstList(reverseProxyIp, conf.Server.ExtAuth.TrustedSources) { + log.Warn(r.Context(), "IP is not whitelisted for external authentication", "proxy-ip", reverseProxyIp, "client-ip", r.RemoteAddr) return "" } - username := r.Header.Get(conf.Server.ReverseProxyUserHeader) + username := r.Header.Get(conf.Server.ExtAuth.UserHeader) if username == "" { return "" } - log.Trace(r, "Found username in ReverseProxyUserHeader", "username", username) + log.Trace(r, "Found username in ExtAuth.UserHeader", "username", username) return username } @@ -256,7 +260,7 @@ func authenticateRequest(ds model.DataStore, r *http.Request, findUsernameFns .. func Authenticator(ds model.DataStore) func(next http.Handler) http.Handler { return func(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - ctx, err := authenticateRequest(ds, r, UsernameFromConfig, UsernameFromToken, UsernameFromReverseProxyHeader) + ctx, err := authenticateRequest(ds, r, UsernameFromConfig, UsernameFromToken, UsernameFromExtAuthHeader) if err != nil { _ = rest.RespondWithError(w, http.StatusUnauthorized, "Not authenticated") return @@ -288,10 +292,10 @@ func JWTRefresher(next http.Handler) http.Handler { }) } -func handleLoginFromHeaders(ds model.DataStore, r *http.Request) map[string]interface{} { +func handleLoginFromHeaders(ds model.DataStore, r *http.Request) map[string]any { username := UsernameFromConfig(r) if username == "" { - username = UsernameFromReverseProxyHeader(r) + username = UsernameFromExtAuthHeader(r) if username == "" { return nil } diff --git a/server/auth_test.go b/server/auth_test.go index 06ca2ea39..f6af6f0d6 100644 --- a/server/auth_test.go +++ b/server/auth_test.go @@ -53,7 +53,7 @@ var _ = Describe("Auth", func() { It("returns the expected payload", func() { Expect(resp.Code).To(Equal(http.StatusOK)) - var parsed map[string]interface{} + var parsed map[string]any Expect(json.Unmarshal(resp.Body.Bytes(), &parsed)).To(BeNil()) Expect(parsed["isAdmin"]).To(Equal(true)) Expect(parsed["username"]).To(Equal("johndoe")) @@ -80,7 +80,7 @@ var _ = Describe("Auth", func() { req.Header.Add("Remote-User", "janedoe") resp = httptest.NewRecorder() conf.Server.UILoginBackgroundURL = "" - conf.Server.ReverseProxyWhitelist = "192.168.0.0/16,2001:4860:4860::/48" + conf.Server.ExtAuth.TrustedSources = "192.168.0.0/16,2001:4860:4860::/48" }) It("sets auth data if IPv4 matches whitelist", func() { @@ -88,7 +88,7 @@ var _ = Describe("Auth", func() { serveIndex(ds, fs, nil)(resp, req) config := extractAppConfig(resp.Body.String()) - parsed := config["auth"].(map[string]interface{}) + parsed := config["auth"].(map[string]any) Expect(parsed["id"]).To(Equal("111")) }) @@ -106,7 +106,7 @@ var _ = Describe("Auth", func() { serveIndex(ds, fs, nil)(resp, req) config := extractAppConfig(resp.Body.String()) - parsed := config["auth"].(map[string]interface{}) + parsed := config["auth"].(map[string]any) Expect(parsed["id"]).To(Equal("111")) }) @@ -127,7 +127,7 @@ var _ = Describe("Auth", func() { serveIndex(ds, fs, nil)(resp, req) config := extractAppConfig(resp.Body.String()) - parsed := config["auth"].(map[string]interface{}) + parsed := config["auth"].(map[string]any) Expect(parsed["username"]).To(Equal(newUser)) }) @@ -137,7 +137,7 @@ var _ = Describe("Auth", func() { serveIndex(ds, fs, nil)(resp, req) config := extractAppConfig(resp.Body.String()) - parsed := config["auth"].(map[string]interface{}) + parsed := config["auth"].(map[string]any) Expect(parsed["id"]).To(Equal("111")) Expect(parsed["isAdmin"]).To(BeFalse()) @@ -155,7 +155,7 @@ var _ = Describe("Auth", func() { It("does not set auth data when listening on unix socket without whitelist", func() { conf.Server.Address = "unix:/tmp/navidrome-test" - conf.Server.ReverseProxyWhitelist = "" + conf.Server.ExtAuth.TrustedSources = "" // No ReverseProxyIp in request context serveIndex(ds, fs, nil)(resp, req) @@ -176,13 +176,13 @@ var _ = Describe("Auth", func() { It("sets auth data when listening on unix socket with correct whitelist", func() { conf.Server.Address = "unix:/tmp/navidrome-test" - conf.Server.ReverseProxyWhitelist = conf.Server.ReverseProxyWhitelist + ",@" + conf.Server.ExtAuth.TrustedSources = conf.Server.ExtAuth.TrustedSources + ",@" req = req.WithContext(request.WithReverseProxyIp(req.Context(), "@")) serveIndex(ds, fs, nil)(resp, req) config := extractAppConfig(resp.Body.String()) - parsed := config["auth"].(map[string]interface{}) + parsed := config["auth"].(map[string]any) Expect(parsed["id"]).To(Equal("111")) }) @@ -206,7 +206,7 @@ var _ = Describe("Auth", func() { login(ds)(resp, req) Expect(resp.Code).To(Equal(http.StatusOK)) - var parsed map[string]interface{} + var parsed map[string]any Expect(json.Unmarshal(resp.Body.Bytes(), &parsed)).To(BeNil()) Expect(parsed["isAdmin"]).To(Equal(false)) Expect(parsed["username"]).To(Equal("janedoe")) @@ -302,8 +302,8 @@ var _ = Describe("Auth", func() { ds = &tests.MockDataStore{} req = httptest.NewRequest("GET", "/", nil) req = req.WithContext(request.WithReverseProxyIp(req.Context(), trustedIP)) - conf.Server.ReverseProxyWhitelist = "192.168.0.0/16" - conf.Server.ReverseProxyUserHeader = "Remote-User" + conf.Server.ExtAuth.TrustedSources = "192.168.0.0/16" + conf.Server.ExtAuth.UserHeader = "Remote-User" }) It("makes the first user an admin", func() { diff --git a/server/backgrounds/handler.go b/server/backgrounds/handler.go index 61b7d48b8..b00a51696 100644 --- a/server/backgrounds/handler.go +++ b/server/backgrounds/handler.go @@ -80,7 +80,7 @@ func (h *Handler) serveImage(ctx context.Context, item cache.Item) (io.Reader, e } c := http.Client{Timeout: imageRequestTimeout} req, _ := http.NewRequestWithContext(ctx, http.MethodGet, imageURL(image), nil) - resp, err := c.Do(req) //nolint:bodyclose // No need to close resp.Body, it will be closed via the CachedStream wrapper + resp, err := c.Do(req) //nolint:bodyclose,gosec // No need to close resp.Body, it will be closed via the CachedStream wrapper if errors.Is(err, context.DeadlineExceeded) { defaultImage, _ := base64.StdEncoding.DecodeString(consts.DefaultUILoginBackgroundOffline) return strings.NewReader(string(defaultImage)), nil diff --git a/server/e2e/doc.go b/server/e2e/doc.go new file mode 100644 index 000000000..51ee6f047 --- /dev/null +++ b/server/e2e/doc.go @@ -0,0 +1,113 @@ +// Package e2e provides end-to-end integration tests for the Navidrome Subsonic API. +// +// These tests exercise the full HTTP request/response cycle through the Subsonic API router, +// using a real SQLite database and real repository implementations while stubbing out external +// services (artwork, streaming, scrobbling, etc.) with noop implementations. +// +// # Test Infrastructure +// +// The suite uses [Ginkgo] v2 as the test runner and [Gomega] for assertions. It is invoked +// through the standard Go test entry point [TestSubsonicE2E], which initializes the test +// environment, creates a temporary SQLite database, and runs the specs. +// +// # Setup and Teardown +// +// During [BeforeSuite], the test infrastructure: +// +// 1. Creates a temporary SQLite database with WAL journal mode. +// 2. Initializes the schema via [db.Init]. +// 3. Creates two test users: an admin ("admin") and a regular user ("regular"), +// both with the password "password". +// 4. Creates a single library ("Music Library") backed by a fake in-memory filesystem +// (scheme "fake:///music") using the [storagetest] package. +// 5. Populates the filesystem with a set of test tracks spanning multiple artists, +// albums, genres, and years. +// 6. Runs the scanner to import all metadata into the database. +// 7. Takes a snapshot of the database to serve as a golden baseline for test isolation. +// +// # Test Data +// +// The fake filesystem contains the following music library structure: +// +// Rock/The Beatles/Abbey Road/ +// 01 - Come Together.mp3 (1969, Rock) +// 02 - Something.mp3 (1969, Rock) +// Rock/The Beatles/Help!/ +// 01 - Help.mp3 (1965, Rock) +// Rock/Led Zeppelin/IV/ +// 01 - Stairway To Heaven.mp3 (1971, Rock) +// Jazz/Miles Davis/Kind of Blue/ +// 01 - So What.mp3 (1959, Jazz) +// Pop/ +// 01 - Standalone Track.mp3 (2020, Pop) +// +// # Database Isolation +// +// Before each top-level Describe block, the [setupTestDB] function restores the database +// to its golden snapshot state using SQLite's ATTACH DATABASE mechanism. This copies all +// table data from the snapshot back into the main database, providing each test group with +// a clean, consistent starting state without the overhead of re-scanning the filesystem. +// +// A fresh [subsonic.Router] is also created for each test group, wired with real data store +// repositories and noop stubs for external services: +// +// - noopArtwork: returns [model.ErrNotFound] for all artwork requests. +// - noopStreamer: returns [model.ErrNotFound] for all stream requests. +// - noopArchiver: returns [model.ErrNotFound] for all archive requests. +// - noopProvider: returns empty results for all external metadata lookups. +// - noopPlayTracker: silently discards all scrobble events. +// +// # Request Helpers +// +// Tests build HTTP requests using the [buildReq] helper, which constructs a Subsonic API +// request with authentication parameters (username, password, API version "1.16.1", client +// name "test-client", and JSON format). Convenience wrappers include: +// +// - [doReq]: sends a request as the admin user and returns the parsed JSON response. +// - [doReqWithUser]: sends a request as a specific user. +// - [doRawReq] / [doRawReqWithUser]: returns the raw [httptest.ResponseRecorder] for +// binary content or status code inspection. +// +// Responses are parsed via [parseJSONResponse], which unwraps the Subsonic JSON envelope +// and returns the inner response map. +// +// # Test Organization +// +// Each test file covers a logical group of Subsonic API endpoints: +// +// - subsonic_system_test.go: ping, getLicense, getOpenSubsonicExtensions +// - subsonic_browsing_test.go: getMusicFolders, getIndexes, getArtists, getMusicDirectory, +// getArtist, getAlbum, getSong, getGenres +// - subsonic_searching_test.go: search2, search3 +// - subsonic_album_lists_test.go: getAlbumList, getAlbumList2 +// - subsonic_playlists_test.go: createPlaylist, getPlaylist, getPlaylists, +// updatePlaylist, deletePlaylist +// - subsonic_media_annotation_test.go: star, unstar, getStarred, setRating, scrobble +// - subsonic_media_retrieval_test.go: stream, download, getCoverArt, getAvatar, +// getLyrics, getLyricsBySongId +// - subsonic_bookmarks_test.go: createBookmark, getBookmarks, deleteBookmark, +// savePlayQueue, getPlayQueue +// - subsonic_radio_test.go: getInternetRadioStations, createInternetRadioStation, +// updateInternetRadioStation, deleteInternetRadioStation +// - subsonic_sharing_test.go: createShare, getShares, updateShare, deleteShare +// - subsonic_users_test.go: getUser, getUsers +// - subsonic_scan_test.go: getScanStatus, startScan +// - subsonic_multiuser_test.go: multi-user isolation and permission enforcement +// - subsonic_multilibrary_test.go: multi-library access control and data isolation +// +// Some test groups use Ginkgo's Ordered decorator to run tests sequentially within a block, +// allowing later tests to depend on state created by earlier ones (e.g., creating a playlist +// and then verifying it can be retrieved). +// +// # Running +// +// The e2e tests are included in the standard test suite and can be run with: +// +// make test PKG=./server/e2e # Run only e2e tests +// make test # Run all tests including e2e +// make test-race # Run with race detector +// +// [Ginkgo]: https://onsi.github.io/ginkgo/ +// [Gomega]: https://onsi.github.io/gomega/ +// [storagetest]: /core/storage/storagetest +package e2e diff --git a/server/e2e/e2e_suite_test.go b/server/e2e/e2e_suite_test.go new file mode 100644 index 000000000..262a5ed36 --- /dev/null +++ b/server/e2e/e2e_suite_test.go @@ -0,0 +1,547 @@ +package e2e + +import ( + "bytes" + "context" + "encoding/json" + "errors" + "io" + "net/http" + "net/http/httptest" + "net/url" + "os" + "path/filepath" + "strings" + "testing" + "testing/fstest" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/core" + "github.com/navidrome/navidrome/core/artwork" + "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/core/external" + "github.com/navidrome/navidrome/core/ffmpeg" + "github.com/navidrome/navidrome/core/lyrics" + "github.com/navidrome/navidrome/core/metrics" + "github.com/navidrome/navidrome/core/playback" + "github.com/navidrome/navidrome/core/playlists" + "github.com/navidrome/navidrome/core/scrobbler" + "github.com/navidrome/navidrome/core/storage/storagetest" + "github.com/navidrome/navidrome/core/stream" + "github.com/navidrome/navidrome/db" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/persistence" + "github.com/navidrome/navidrome/scanner" + "github.com/navidrome/navidrome/server/events" + "github.com/navidrome/navidrome/server/subsonic" + "github.com/navidrome/navidrome/server/subsonic/responses" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestSubsonicE2E(t *testing.T) { + tests.Init(t, false) + defer db.Close(t.Context()) + log.SetLevel(log.LevelFatal) + RegisterFailHandler(Fail) + RunSpecs(t, "Subsonic API E2E Suite") +} + +// Easy aliases for the storagetest package +type _t = map[string]any + +var template = storagetest.Template +var track = storagetest.Track +var file = storagetest.File + +// MusicBrainz ID constants for test data (valid UUID v4 values) +const ( + mbidBeatlesArtist = "b10bbbfc-cf9e-42e0-be17-e2c3e1d2600d" + mbidAbbeyRoadAlbum = "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d" + mbidAbbeyRoadRelGroup = "d4c3b2a1-f6e5-4b7a-9d8c-1f0e3a2b5c4d" + mbidComeTogether = "11111111-1111-4111-a111-111111111111" // mbz_release_track_id + mbidComeTogetherRec = "22222222-2222-4222-a222-222222222222" // mbz_recording_id + mbidSomething = "33333333-3333-4333-a333-333333333333" // mbz_release_track_id + mbidSomethingRec = "44444444-4444-4444-a444-444444444444" // mbz_recording_id +) + +// Shared test state +var ( + ctx context.Context + ds *tests.MockDataStore + router *subsonic.Router + streamerSpy *spyStreamer + lib model.Library + + // Snapshot paths for fast DB restore + dbFilePath string + snapshotPath string + + // Admin user used for most tests + adminUser = model.User{ + ID: "admin-1", + UserName: "admin", + Name: "Admin User", + IsAdmin: true, + } + + // Regular (non-admin) user for permission tests + regularUser = model.User{ + ID: "regular-1", + UserName: "regular", + Name: "Regular User", + IsAdmin: false, + } +) + +func createFS(files fstest.MapFS) storagetest.FakeFS { + fs := storagetest.FakeFS{} + fs.SetFiles(files) + storagetest.Register("fake", &fs) + return fs +} + +// buildTestFS creates the full test filesystem matching the plan +func buildTestFS() storagetest.FakeFS { + abbeyRoad := template(_t{ + "albumartist": "The Beatles", + "artist": "The Beatles", + "album": "Abbey Road", + "year": 1969, + "genre": "Rock", + "musicbrainz_artistid": mbidBeatlesArtist, + "musicbrainz_albumartistid": mbidBeatlesArtist, + "musicbrainz_albumid": mbidAbbeyRoadAlbum, + "musicbrainz_releasegroupid": mbidAbbeyRoadRelGroup, + }) + help := template(_t{"albumartist": "The Beatles", "artist": "The Beatles", "album": "Help!", "year": 1965, "genre": "Rock"}) + ledZepIV := template(_t{"albumartist": "Led Zeppelin", "artist": "Led Zeppelin", "album": "IV", "year": 1971, "genre": "Rock"}) + kindOfBlue := template(_t{"albumartist": "Miles Davis", "artist": "Miles Davis", "album": "Kind of Blue", "year": 1959, "genre": "Jazz"}) + popTrack := template(_t{"albumartist": "Various", "artist": "Various", "album": "Pop", "year": 2020, "genre": "Pop"}) + cowboyBebop := template(_t{"albumartist": "シートベルツ", "artist": "シートベルツ", "album": "COWBOY BEBOP", "year": 1998, "genre": "Jazz"}) + + // Template for diverse-format transcode test tracks + tcBase := _t{"albumartist": "Test Artist", "artist": "Test Artist", "album": "Transcode Formats", "year": 2024, "genre": "Test"} + + return createFS(fstest.MapFS{ + // Rock / The Beatles / Abbey Road (with MBIDs) + // Note: "musicbrainz_trackid" is an alias for the musicbrainz_recordingid tag (populates MbzRecordingID), + // "musicbrainz_releasetrackid" is an alias for the musicbrainz_trackid tag (populates MbzReleaseTrackID). + "Rock/The Beatles/Abbey Road/01 - Come Together.mp3": abbeyRoad(track(1, "Come Together", + _t{"musicbrainz_releasetrackid": mbidComeTogether, "musicbrainz_trackid": mbidComeTogetherRec})), + "Rock/The Beatles/Abbey Road/02 - Something.mp3": abbeyRoad(track(2, "Something", + _t{"musicbrainz_releasetrackid": mbidSomething, "musicbrainz_trackid": mbidSomethingRec})), + // Rock / The Beatles / Help! (no MBIDs) + "Rock/The Beatles/Help!/01 - Help.mp3": help(track(1, "Help!")), + // Rock / Led Zeppelin / IV (no MBIDs) + "Rock/Led Zeppelin/IV/01 - Stairway To Heaven.mp3": ledZepIV(track(1, "Stairway To Heaven")), + // Jazz / Miles Davis / Kind of Blue (no MBIDs) + "Jazz/Miles Davis/Kind of Blue/01 - So What.mp3": kindOfBlue(track(1, "So What")), + // Pop (standalone track, no MBIDs) + "Pop/01 - Standalone Track.mp3": popTrack(track(1, "Standalone Track")), + // CJK / シートベルツ / COWBOY BEBOP (Japanese artist, for CJK search tests) + "CJK/シートベルツ/COWBOY BEBOP/01 - プラチナ・ジェット.mp3": cowboyBebop(track(1, "プラチナ・ジェット")), + + // Diverse audio format tracks for transcode e2e tests + "Test/Transcode Formats/01 - TC FLAC Standard.flac": file(tcBase, _t{ + "title": "TC FLAC Standard", "track": 1, "suffix": "flac", + "bitrate": 900, "samplerate": 44100, "bitdepth": 16, "channels": 2, "duration": int64(240), + }), + "Test/Transcode Formats/02 - TC FLAC HiRes.flac": file(tcBase, _t{ + "title": "TC FLAC HiRes", "track": 2, "suffix": "flac", + "bitrate": 3000, "samplerate": 96000, "bitdepth": 24, "channels": 2, "duration": int64(180), + }), + "Test/Transcode Formats/03 - TC ALAC Track.m4a": file(tcBase, _t{ + "title": "TC ALAC Track", "track": 3, "suffix": "m4a", + "bitrate": 900, "samplerate": 44100, "bitdepth": 16, "channels": 2, "duration": int64(200), + }), + "Test/Transcode Formats/04 - TC DSD Track.dsf": file(tcBase, _t{ + "title": "TC DSD Track", "track": 4, "suffix": "dsf", + "bitrate": 5645, "samplerate": 2822400, "bitdepth": 1, "channels": 2, "duration": int64(300), + }), + "Test/Transcode Formats/05 - TC Opus Track.opus": file(tcBase, _t{ + "title": "TC Opus Track", "track": 5, "suffix": "opus", + "bitrate": 128, "samplerate": 48000, "bitdepth": 0, "channels": 2, "duration": int64(210), + }), + "Test/Transcode Formats/06 - TC MKA Opus.mka": file(tcBase, _t{ + "title": "TC MKA Opus", "track": 6, "suffix": "mka", "codec": "opus", + "bitrate": 128, "samplerate": 48000, "bitdepth": 0, "channels": 2, "duration": int64(220), + }), + + // _empty folder (directory with no audio) + "_empty/.keep": &fstest.MapFile{Data: []byte{}, ModTime: time.Now()}, + }) +} + +// createUser creates a user in the database with the given properties, assigns them to the test +// library, and returns the fully-loaded user (with Libraries populated). +func createUser(id, username, name string, isAdmin bool) model.User { + user := model.User{ + ID: id, + UserName: username, + Name: name, + IsAdmin: isAdmin, + NewPassword: "password", + } + Expect(ds.User(ctx).Put(&user)).To(Succeed()) + Expect(ds.User(ctx).SetUserLibraries(user.ID, []int{lib.ID})).To(Succeed()) + + loadedUser, err := ds.User(ctx).FindByUsername(user.UserName) + Expect(err).ToNot(HaveOccurred()) + user.Libraries = loadedUser.Libraries + return user +} + +// doReq makes a full HTTP round-trip through the router and returns the parsed Subsonic response. +func doReq(endpoint string, params ...string) *responses.Subsonic { + return doReqWithUser(adminUser, endpoint, params...) +} + +// doReqWithUser makes a full HTTP round-trip for the given user and returns the parsed Subsonic response. +func doReqWithUser(user model.User, endpoint string, params ...string) *responses.Subsonic { + w := httptest.NewRecorder() + r := buildReq(user, endpoint, params...) + router.ServeHTTP(w, r) + return parseJSONResponse(w) +} + +// doRawReq returns the raw ResponseRecorder for endpoints that write binary data (stream, download, getCoverArt). +func doRawReq(endpoint string, params ...string) *httptest.ResponseRecorder { + return doRawReqWithUser(adminUser, endpoint, params...) +} + +// doRawReqWithUser returns the raw ResponseRecorder for the given user. +func doRawReqWithUser(user model.User, endpoint string, params ...string) *httptest.ResponseRecorder { + w := httptest.NewRecorder() + r := buildReq(user, endpoint, params...) + router.ServeHTTP(w, r) + return w +} + +// buildReq creates a GET request with Subsonic auth params (u, p, v, c, f=json). +func buildReq(user model.User, endpoint string, params ...string) *http.Request { + if len(params)%2 != 0 { + panic("buildReq: odd number of parameters") + } + q := url.Values{} + q.Add("u", user.UserName) + q.Add("p", "password") + q.Add("v", "1.16.1") + q.Add("c", "test-client") + q.Add("f", "json") + for i := 0; i < len(params); i += 2 { + q.Add(params[i], params[i+1]) + } + return httptest.NewRequest("GET", "/"+endpoint+"?"+q.Encode(), nil) +} + +// buildPostReq creates a POST request with a JSON body and Subsonic auth params in the query string. +func buildPostReq(user model.User, endpoint string, body string, params ...string) *http.Request { + getReq := buildReq(user, endpoint, params...) + r := httptest.NewRequest("POST", getReq.URL.RequestURI(), bytes.NewReader([]byte(body))) + r.Header.Set("Content-Type", "application/json") + return r +} + +// doPostReq makes a POST round-trip as admin and returns the parsed Subsonic response. +func doPostReq(endpoint string, body string, params ...string) *responses.Subsonic { + w := httptest.NewRecorder() + r := buildPostReq(adminUser, endpoint, body, params...) + router.ServeHTTP(w, r) + return parseJSONResponse(w) +} + +// doRawPostReq makes a POST round-trip as admin and returns the raw recorder. +func doRawPostReq(endpoint string, body string, params ...string) *httptest.ResponseRecorder { + w := httptest.NewRecorder() + r := buildPostReq(adminUser, endpoint, body, params...) + router.ServeHTTP(w, r) + return w +} + +// parseJSONResponse parses the JSON response body into a Subsonic response struct. +func parseJSONResponse(w *httptest.ResponseRecorder) *responses.Subsonic { + Expect(w.Code).To(Equal(http.StatusOK)) + var wrapper responses.JsonWrapper + Expect(json.Unmarshal(w.Body.Bytes(), &wrapper)).To(Succeed()) + return &wrapper.Subsonic +} + +// --- Noop stub implementations for Router dependencies --- + +// noopArtwork implements artwork.Artwork +type noopArtwork struct{} + +func (n noopArtwork) Get(context.Context, model.ArtworkID, int, bool) (io.ReadCloser, time.Time, error) { + return nil, time.Time{}, model.ErrNotFound +} + +func (n noopArtwork) GetOrPlaceholder(_ context.Context, _ string, _ int, _ bool) (io.ReadCloser, time.Time, error) { + return io.NopCloser(io.LimitReader(nil, 0)), time.Time{}, nil +} + +// spyStreamer captures the Request passed to NewStream for test assertions, +// then returns a minimal fake Stream so the handler completes without error. +type spyStreamer struct { + LastRequest stream.Request + LastMediaFile *model.MediaFile + SimulateError error // When set, NewStream returns this error + SimulateEmptyStream bool // When true, returns a 0-byte stream (simulates ffmpeg producing no output) +} + +func (s *spyStreamer) NewStream(_ context.Context, mf *model.MediaFile, req stream.Request) (*stream.Stream, error) { + s.LastRequest = req + s.LastMediaFile = mf + if s.SimulateError != nil { + return nil, s.SimulateError + } + format := req.Format + if format == "" || format == "raw" { + format = mf.Suffix + } + content := "fake audio data" + if s.SimulateEmptyStream { + content = "" + } + r := io.NopCloser(strings.NewReader(content)) + return stream.NewStream(mf, format, req.BitRate, r), nil +} + +// noopFFmpeg implements ffmpeg.FFmpeg with no-op methods. +type noopFFmpeg struct{} + +func (n noopFFmpeg) Transcode(context.Context, ffmpeg.TranscodeOptions) (io.ReadCloser, error) { + return nil, errors.New("noop ffmpeg: transcode not supported") +} + +func (n noopFFmpeg) ExtractImage(context.Context, string) (io.ReadCloser, error) { + return nil, errors.New("noop ffmpeg: extract image not supported") +} + +func (n noopFFmpeg) Probe(context.Context, []string) (string, error) { + return "", nil +} + +func (n noopFFmpeg) ProbeAudioStream(context.Context, string) (*ffmpeg.AudioProbeResult, error) { + return nil, errors.New("noop ffmpeg: probe not supported") +} + +func (n noopFFmpeg) ConvertAnimatedImage(context.Context, io.Reader, int, int) (io.ReadCloser, error) { + return nil, errors.New("noop ffmpeg: convert animated image not supported") +} + +func (n noopFFmpeg) CmdPath() (string, error) { return "", nil } +func (n noopFFmpeg) IsAvailable() bool { return false } +func (n noopFFmpeg) Version() string { return "noop" } + +// noopArchiver implements core.Archiver +type noopArchiver struct{} + +func (n noopArchiver) ZipAlbum(context.Context, string, string, int, io.Writer) error { + return model.ErrNotFound +} + +func (n noopArchiver) ZipArtist(context.Context, string, string, int, io.Writer) error { + return model.ErrNotFound +} + +func (n noopArchiver) ZipShare(context.Context, string, io.Writer) error { + return model.ErrNotFound +} + +func (n noopArchiver) ZipPlaylist(context.Context, string, string, int, io.Writer) error { + return model.ErrNotFound +} + +// noopProvider implements external.Provider +type noopProvider struct{} + +func (n noopProvider) UpdateAlbumInfo(_ context.Context, _ string) (*model.Album, error) { + return &model.Album{}, nil +} + +func (n noopProvider) UpdateArtistInfo(_ context.Context, _ string, _ int, _ bool) (*model.Artist, error) { + return &model.Artist{}, nil +} + +func (n noopProvider) SimilarSongs(context.Context, string, int) (model.MediaFiles, error) { + return nil, nil +} + +func (n noopProvider) TopSongs(context.Context, string, int) (model.MediaFiles, error) { + return nil, nil +} + +func (n noopProvider) ArtistImage(context.Context, string) (*url.URL, error) { + return nil, model.ErrNotFound +} + +func (n noopProvider) AlbumImage(context.Context, string) (*url.URL, error) { + return nil, model.ErrNotFound +} + +// noopPlayTracker implements scrobbler.PlayTracker +type noopPlayTracker struct{} + +func (n noopPlayTracker) NowPlaying(context.Context, string, string, string, int) error { + return nil +} + +func (n noopPlayTracker) GetNowPlaying(context.Context) ([]scrobbler.NowPlayingInfo, error) { + return nil, nil +} + +func (n noopPlayTracker) Submit(context.Context, []scrobbler.Submission) error { + return nil +} + +// Compile-time interface checks +var ( + _ artwork.Artwork = noopArtwork{} + _ stream.MediaStreamer = &spyStreamer{} + _ core.Archiver = noopArchiver{} + _ external.Provider = noopProvider{} + _ scrobbler.PlayTracker = noopPlayTracker{} + _ ffmpeg.FFmpeg = noopFFmpeg{} +) + +var _ = BeforeSuite(func() { + ctx = request.WithUser(GinkgoT().Context(), adminUser) + tmpDir := GinkgoT().TempDir() + dbFilePath = filepath.Join(tmpDir, "test-e2e.db") + snapshotPath = filepath.Join(tmpDir, "test-e2e.db.snapshot") + conf.Server.DbPath = dbFilePath + "?_journal_mode=WAL" + db.Db().SetMaxOpenConns(1) + + // Initial setup: schema, user, library, and full scan (runs once for the entire suite) + conf.Server.MusicFolder = "fake:///music" + conf.Server.DevExternalScanner = false + + db.Init(ctx) + + initDS := &tests.MockDataStore{RealDS: persistence.New(db.Db())} + auth.Init(initDS) + + adminUserWithPass := adminUser + adminUserWithPass.NewPassword = "password" + Expect(initDS.User(ctx).Put(&adminUserWithPass)).To(Succeed()) + + regularUserWithPass := regularUser + regularUserWithPass.NewPassword = "password" + Expect(initDS.User(ctx).Put(®ularUserWithPass)).To(Succeed()) + + lib = model.Library{ID: 1, Name: "Music Library", Path: "fake:///music"} + Expect(initDS.Library(ctx).Put(&lib)).To(Succeed()) + + Expect(initDS.User(ctx).SetUserLibraries(adminUser.ID, []int{lib.ID})).To(Succeed()) + Expect(initDS.User(ctx).SetUserLibraries(regularUser.ID, []int{lib.ID})).To(Succeed()) + + loadedUser, err := initDS.User(ctx).FindByUsername(adminUser.UserName) + Expect(err).ToNot(HaveOccurred()) + adminUser.Libraries = loadedUser.Libraries + + loadedRegular, err := initDS.User(ctx).FindByUsername(regularUser.UserName) + Expect(err).ToNot(HaveOccurred()) + regularUser.Libraries = loadedRegular.Libraries + + ctx = request.WithUser(GinkgoT().Context(), adminUser) + + buildTestFS() + s := scanner.New(ctx, initDS, artwork.NoopCacheWarmer(), events.NoopBroker(), + playlists.NewPlaylists(initDS, core.NewImageUploadService()), metrics.NewNoopInstance()) + _, err = s.ScanAll(ctx, true) + Expect(err).ToNot(HaveOccurred()) + + // Checkpoint WAL and snapshot the golden DB state + _, err = db.Db().Exec("PRAGMA wal_checkpoint(TRUNCATE)") + Expect(err).ToNot(HaveOccurred()) + data, err := os.ReadFile(dbFilePath) + Expect(err).ToNot(HaveOccurred()) + Expect(os.WriteFile(snapshotPath, data, 0600)).To(Succeed()) +}) + +// setupTestDB restores the database from the golden snapshot and creates the +// Subsonic Router. Call this from BeforeEach/BeforeAll in each test container. +func setupTestDB() { + ctx = request.WithUser(GinkgoT().Context(), adminUser) + + DeferCleanup(configtest.SetupConfig()) + DeferCleanup(func() { + // Wait for any background scan (e.g. from startScan endpoint) to finish + // before config cleanup runs, to avoid a data race on conf.Server. + Eventually(scanner.IsScanning).Should(BeFalse()) + }) + conf.Server.MusicFolder = "fake:///music" + conf.Server.DevExternalScanner = false + conf.Server.DevEnableMediaFileProbe = false + + // Restore DB to golden state (no scan needed) + restoreDB() + + ds = &tests.MockDataStore{RealDS: persistence.New(db.Db())} + auth.Init(ds) + + // Create the Subsonic Router with real DS, streamer spy, and real Decider + streamerSpy = &spyStreamer{} + decider := stream.NewTranscodeDecider(ds, noopFFmpeg{}) + s := scanner.New(ctx, ds, artwork.NoopCacheWarmer(), events.NoopBroker(), + playlists.NewPlaylists(ds, core.NewImageUploadService()), metrics.NewNoopInstance()) + router = subsonic.New( + ds, + noopArtwork{}, + streamerSpy, + noopArchiver{}, + core.NewPlayers(ds), + noopProvider{}, + s, + events.NoopBroker(), + playlists.NewPlaylists(ds, core.NewImageUploadService()), + noopPlayTracker{}, + core.NewShare(ds), + playback.PlaybackServer(nil), + metrics.NewNoopInstance(), + lyrics.NewLyrics(nil), + decider, + ) +} + +// restoreDB restores all table data from the snapshot using ATTACH DATABASE. +// This is much faster than re-running the scanner for each test. +func restoreDB() { + sqlDB := db.Db() + + _, err := sqlDB.Exec("PRAGMA foreign_keys = OFF") + Expect(err).ToNot(HaveOccurred()) + + _, err = sqlDB.Exec("ATTACH DATABASE ? AS snapshot", snapshotPath) + Expect(err).ToNot(HaveOccurred()) + + rows, err := sqlDB.Query("SELECT name FROM main.sqlite_master WHERE type='table' AND name NOT LIKE 'sqlite_%' AND name NOT LIKE '%_fts' AND name NOT LIKE '%_fts_%'") + Expect(err).ToNot(HaveOccurred()) + var tables []string + for rows.Next() { + var name string + Expect(rows.Scan(&name)).To(Succeed()) + tables = append(tables, name) + } + Expect(rows.Err()).ToNot(HaveOccurred()) + rows.Close() + + for _, table := range tables { + // Table names come from sqlite_master, not user input, so concatenation is safe here + _, err = sqlDB.Exec(`DELETE FROM main."` + table + `"`) //nolint:gosec + Expect(err).ToNot(HaveOccurred()) + _, err = sqlDB.Exec(`INSERT INTO main."` + table + `" SELECT * FROM snapshot."` + table + `"`) //nolint:gosec + Expect(err).ToNot(HaveOccurred()) + } + + _, err = sqlDB.Exec("DETACH DATABASE snapshot") + Expect(err).ToNot(HaveOccurred()) + _, err = sqlDB.Exec("PRAGMA foreign_keys = ON") + Expect(err).ToNot(HaveOccurred()) +} diff --git a/server/e2e/subsonic_album_lists_test.go b/server/e2e/subsonic_album_lists_test.go new file mode 100644 index 000000000..d41d17dbc --- /dev/null +++ b/server/e2e/subsonic_album_lists_test.go @@ -0,0 +1,303 @@ +package e2e + +import ( + "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Album List Endpoints", func() { + BeforeEach(func() { + setupTestDB() + }) + + Describe("GetAlbumList", func() { + It("type=newest returns albums sorted by creation date", func() { + resp := doReq("getAlbumList", "type", "newest") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.AlbumList).ToNot(BeNil()) + Expect(resp.AlbumList.Album).To(HaveLen(7)) + }) + + It("type=alphabeticalByName sorts albums by name", func() { + resp := doReq("getAlbumList", "type", "alphabeticalByName") + + Expect(resp.AlbumList).ToNot(BeNil()) + albums := resp.AlbumList.Album + Expect(albums).To(HaveLen(7)) + // Verify alphabetical order: Abbey Road, COWBOY BEBOP, Help!, IV, Kind of Blue, Pop, Transcode Formats + Expect(albums[0].Title).To(Equal("Abbey Road")) + Expect(albums[1].Title).To(Equal("COWBOY BEBOP")) + Expect(albums[2].Title).To(Equal("Help!")) + Expect(albums[3].Title).To(Equal("IV")) + Expect(albums[4].Title).To(Equal("Kind of Blue")) + Expect(albums[5].Title).To(Equal("Pop")) + Expect(albums[6].Title).To(Equal("Transcode Formats")) + }) + + It("type=alphabeticalByArtist sorts albums by artist name", func() { + resp := doReq("getAlbumList", "type", "alphabeticalByArtist") + + Expect(resp.AlbumList).ToNot(BeNil()) + albums := resp.AlbumList.Album + Expect(albums).To(HaveLen(7)) + // Articles like "The" are stripped for sorting, so "The Beatles" sorts as "Beatles" + // Non-compilations first: Beatles (x2), Led Zeppelin, Miles Davis, Test Artist, then compilations: Various, then CJK: シートベルツ + Expect(albums[0].Artist).To(Equal("The Beatles")) + Expect(albums[1].Artist).To(Equal("The Beatles")) + Expect(albums[2].Artist).To(Equal("Led Zeppelin")) + Expect(albums[3].Artist).To(Equal("Miles Davis")) + Expect(albums[4].Artist).To(Equal("Test Artist")) + Expect(albums[5].Artist).To(Equal("Various")) + Expect(albums[6].Artist).To(Equal("シートベルツ")) + }) + + It("type=random returns albums", func() { + resp := doReq("getAlbumList", "type", "random") + + Expect(resp.AlbumList).ToNot(BeNil()) + Expect(resp.AlbumList.Album).To(HaveLen(7)) + }) + + It("type=byGenre filters by genre parameter", func() { + resp := doReq("getAlbumList", "type", "byGenre", "genre", "Jazz") + + Expect(resp.AlbumList).ToNot(BeNil()) + Expect(resp.AlbumList.Album).To(HaveLen(2)) + for _, a := range resp.AlbumList.Album { + Expect(a.Genre).To(Equal("Jazz")) + } + }) + + It("type=byYear filters by fromYear/toYear range", func() { + resp := doReq("getAlbumList", "type", "byYear", "fromYear", "1965", "toYear", "1970") + + Expect(resp.AlbumList).ToNot(BeNil()) + // Should include Abbey Road (1969) and Help! (1965) + Expect(resp.AlbumList.Album).To(HaveLen(2)) + years := make([]int32, len(resp.AlbumList.Album)) + for i, a := range resp.AlbumList.Album { + years[i] = a.Year + } + Expect(years).To(ConsistOf(int32(1965), int32(1969))) + }) + + It("respects size parameter", func() { + resp := doReq("getAlbumList", "type", "newest", "size", "2") + + Expect(resp.AlbumList).ToNot(BeNil()) + Expect(resp.AlbumList.Album).To(HaveLen(2)) + }) + + It("supports offset for pagination", func() { + // First get all albums sorted by name to know the expected order + resp1 := doReq("getAlbumList", "type", "alphabeticalByName", "size", "5") + allAlbums := resp1.AlbumList.Album + + // Now get with offset=2, size=2 + resp2 := doReq("getAlbumList", "type", "alphabeticalByName", "size", "2", "offset", "2") + + Expect(resp2.AlbumList).ToNot(BeNil()) + Expect(resp2.AlbumList.Album).To(HaveLen(2)) + Expect(resp2.AlbumList.Album[0].Title).To(Equal(allAlbums[2].Title)) + Expect(resp2.AlbumList.Album[1].Title).To(Equal(allAlbums[3].Title)) + }) + + It("returns error when type parameter is missing", func() { + resp := doReq("getAlbumList") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("returns error for unknown type", func() { + resp := doReq("getAlbumList", "type", "invalid_type") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("type=frequent returns empty when no albums have been played", func() { + resp := doReq("getAlbumList", "type", "frequent") + + Expect(resp.AlbumList).ToNot(BeNil()) + Expect(resp.AlbumList.Album).To(BeEmpty()) + }) + + It("type=recent returns empty when no albums have been played", func() { + resp := doReq("getAlbumList", "type", "recent") + + Expect(resp.AlbumList).ToNot(BeNil()) + Expect(resp.AlbumList.Album).To(BeEmpty()) + }) + }) + + Describe("GetAlbumList - starred type", Ordered, func() { + BeforeAll(func() { + setupTestDB() + + // Star an album so the starred filter returns results + albums, err := ds.Album(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"album.name": "Abbey Road"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(albums).ToNot(BeEmpty()) + + resp := doReq("star", "albumId", albums[0].ID) + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + + It("type=starred returns only starred albums", func() { + resp := doReq("getAlbumList", "type", "starred") + + Expect(resp.AlbumList).ToNot(BeNil()) + Expect(resp.AlbumList.Album).To(HaveLen(1)) + Expect(resp.AlbumList.Album[0].Title).To(Equal("Abbey Road")) + }) + }) + + Describe("GetAlbumList - highest type", Ordered, func() { + BeforeAll(func() { + setupTestDB() + + // Rate an album so the highest filter returns results + albums, err := ds.Album(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"album.name": "Kind of Blue"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(albums).ToNot(BeEmpty()) + + resp := doReq("setRating", "id", albums[0].ID, "rating", "5") + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + + It("type=highest returns only rated albums", func() { + resp := doReq("getAlbumList", "type", "highest") + + Expect(resp.AlbumList).ToNot(BeNil()) + Expect(resp.AlbumList.Album).To(HaveLen(1)) + Expect(resp.AlbumList.Album[0].Title).To(Equal("Kind of Blue")) + }) + }) + + Describe("GetAlbumList2", func() { + It("returns albums in AlbumID3 format", func() { + resp := doReq("getAlbumList2", "type", "alphabeticalByName") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.AlbumList2).ToNot(BeNil()) + albums := resp.AlbumList2.Album + Expect(albums).To(HaveLen(7)) + // Verify AlbumID3 format fields + Expect(albums[0].Name).To(Equal("Abbey Road")) + Expect(albums[0].Id).ToNot(BeEmpty()) + Expect(albums[0].Artist).ToNot(BeEmpty()) + }) + + It("type=newest works correctly", func() { + resp := doReq("getAlbumList2", "type", "newest") + + Expect(resp.AlbumList2).ToNot(BeNil()) + Expect(resp.AlbumList2.Album).To(HaveLen(7)) + }) + }) + + Describe("GetStarred", func() { + It("returns empty lists when nothing is starred", func() { + resp := doReq("getStarred") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Starred).ToNot(BeNil()) + Expect(resp.Starred.Artist).To(BeEmpty()) + Expect(resp.Starred.Album).To(BeEmpty()) + Expect(resp.Starred.Song).To(BeEmpty()) + }) + }) + + Describe("GetStarred2", func() { + It("returns empty lists when nothing is starred", func() { + resp := doReq("getStarred2") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Starred2).ToNot(BeNil()) + Expect(resp.Starred2.Artist).To(BeEmpty()) + Expect(resp.Starred2.Album).To(BeEmpty()) + Expect(resp.Starred2.Song).To(BeEmpty()) + }) + }) + + Describe("GetNowPlaying", func() { + It("returns empty list when nobody is playing", func() { + resp := doReq("getNowPlaying") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.NowPlaying).ToNot(BeNil()) + Expect(resp.NowPlaying.Entry).To(BeEmpty()) + }) + }) + + Describe("GetRandomSongs", func() { + It("returns random songs from library", func() { + resp := doReq("getRandomSongs") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.RandomSongs).ToNot(BeNil()) + Expect(resp.RandomSongs.Songs).ToNot(BeEmpty()) + Expect(resp.RandomSongs.Songs).To(HaveLen(10)) + }) + + It("respects size parameter", func() { + resp := doReq("getRandomSongs", "size", "2") + + Expect(resp.RandomSongs).ToNot(BeNil()) + Expect(resp.RandomSongs.Songs).To(HaveLen(2)) + }) + + It("filters by genre when specified", func() { + resp := doReq("getRandomSongs", "size", "500", "genre", "Jazz") + + Expect(resp.RandomSongs).ToNot(BeNil()) + Expect(resp.RandomSongs.Songs).To(HaveLen(2)) + for _, s := range resp.RandomSongs.Songs { + Expect(s.Genre).To(Equal("Jazz")) + } + }) + }) + + Describe("GetSongsByGenre", func() { + It("returns songs matching the genre", func() { + resp := doReq("getSongsByGenre", "genre", "Rock") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SongsByGenre).ToNot(BeNil()) + // 4 Rock songs: Come Together, Something, Help!, Stairway To Heaven + Expect(resp.SongsByGenre.Songs).To(HaveLen(4)) + for _, song := range resp.SongsByGenre.Songs { + Expect(song.Genre).To(Equal("Rock")) + } + }) + + It("supports count and offset parameters", func() { + // First get all Rock songs + resp1 := doReq("getSongsByGenre", "genre", "Rock", "count", "500") + allSongs := resp1.SongsByGenre.Songs + + // Now get with count=2, offset=1 + resp2 := doReq("getSongsByGenre", "genre", "Rock", "count", "2", "offset", "1") + + Expect(resp2.SongsByGenre).ToNot(BeNil()) + Expect(resp2.SongsByGenre.Songs).To(HaveLen(2)) + Expect(resp2.SongsByGenre.Songs[0].Id).To(Equal(allSongs[1].Id)) + }) + + It("returns empty for non-existent genre", func() { + resp := doReq("getSongsByGenre", "genre", "NonExistentGenre") + + Expect(resp.SongsByGenre).ToNot(BeNil()) + Expect(resp.SongsByGenre.Songs).To(BeEmpty()) + }) + }) +}) diff --git a/server/e2e/subsonic_bookmarks_test.go b/server/e2e/subsonic_bookmarks_test.go new file mode 100644 index 000000000..726b41743 --- /dev/null +++ b/server/e2e/subsonic_bookmarks_test.go @@ -0,0 +1,158 @@ +package e2e + +import ( + "fmt" + + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Bookmark and PlayQueue Endpoints", Ordered, func() { + BeforeAll(func() { + setupTestDB() + }) + + Describe("Bookmark Endpoints", Ordered, func() { + var trackID string + + BeforeAll(func() { + // Get a media file ID from the database to use for bookmarks + mfs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{Max: 1}) + Expect(err).ToNot(HaveOccurred()) + Expect(mfs).ToNot(BeEmpty()) + trackID = mfs[0].ID + }) + + It("getBookmarks returns empty initially", func() { + resp := doReq("getBookmarks") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Bookmarks).ToNot(BeNil()) + Expect(resp.Bookmarks.Bookmark).To(BeEmpty()) + }) + + It("createBookmark creates a bookmark with position", func() { + resp := doReq("createBookmark", "id", trackID, "position", "12345", "comment", "test bookmark") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + + It("getBookmarks shows the created bookmark", func() { + resp := doReq("getBookmarks") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Bookmarks).ToNot(BeNil()) + Expect(resp.Bookmarks.Bookmark).To(HaveLen(1)) + + bmk := resp.Bookmarks.Bookmark[0] + Expect(bmk.Entry.Id).To(Equal(trackID)) + Expect(bmk.Position).To(Equal(int64(12345))) + Expect(bmk.Comment).To(Equal("test bookmark")) + Expect(bmk.Username).To(Equal(adminUser.UserName)) + }) + + It("deleteBookmark removes the bookmark", func() { + resp := doReq("deleteBookmark", "id", trackID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + + // Verify it's gone + resp = doReq("getBookmarks") + Expect(resp.Bookmarks.Bookmark).To(BeEmpty()) + }) + }) + + Describe("PlayQueue Endpoints", Ordered, func() { + var trackIDs []string + + BeforeAll(func() { + // Get multiple media file IDs from the database + mfs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{Max: 3, Sort: "title"}) + Expect(err).ToNot(HaveOccurred()) + Expect(len(mfs)).To(BeNumerically(">=", 2)) + for _, mf := range mfs { + trackIDs = append(trackIDs, mf.ID) + } + }) + + It("getPlayQueue returns minimum required fields when nothing specified", func() { + resp := doReq("getPlayQueue") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.PlayQueue).ToNot(BeNil()) + Expect(resp.PlayQueue.Entry).To(HaveLen(0)) + Expect(resp.PlayQueue.Current).To(BeEmpty()) + Expect(resp.PlayQueue.Position).To(Equal(int64(0))) + Expect(resp.PlayQueue.Username).To(Equal(adminUser.UserName)) + Expect(resp.PlayQueue.ChangedBy).To(BeEmpty()) + }) + + It("getPlayQueueByIndex returns minimum required fields when nothing specified", func() { + resp := doReq("getPlayQueueByIndex") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.PlayQueueByIndex).ToNot(BeNil()) + Expect(resp.PlayQueueByIndex.Entry).To(HaveLen(0)) + Expect(resp.PlayQueueByIndex.CurrentIndex).To(BeNil()) + Expect(resp.PlayQueueByIndex.Position).To(Equal(int64(0))) + Expect(resp.PlayQueueByIndex.Username).To(Equal(adminUser.UserName)) + Expect(resp.PlayQueueByIndex.ChangedBy).To(BeEmpty()) + }) + + It("savePlayQueue stores current play queue", func() { + resp := doReq("savePlayQueue", + "id", trackIDs[0], + "id", trackIDs[1], + "current", trackIDs[1], + "position", "5000", + ) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + + It("getPlayQueue returns saved queue with tracks", func() { + resp := doReq("getPlayQueue") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.PlayQueue).ToNot(BeNil()) + Expect(resp.PlayQueue.Entry).To(HaveLen(2)) + Expect(resp.PlayQueue.Current).To(Equal(trackIDs[1])) + Expect(resp.PlayQueue.Position).To(Equal(int64(5000))) + Expect(resp.PlayQueue.Username).To(Equal(adminUser.UserName)) + Expect(resp.PlayQueue.ChangedBy).To(Equal("test-client")) + }) + + It("getPlayQueueByIndex returns data with current index", func() { + resp := doReq("getPlayQueueByIndex") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.PlayQueueByIndex).ToNot(BeNil()) + Expect(resp.PlayQueueByIndex.Entry).To(HaveLen(2)) + Expect(resp.PlayQueueByIndex.CurrentIndex).ToNot(BeNil()) + Expect(*resp.PlayQueueByIndex.CurrentIndex).To(Equal(1)) + Expect(resp.PlayQueueByIndex.Position).To(Equal(int64(5000))) + }) + + It("savePlayQueueByIndex stores queue by index", func() { + resp := doReq("savePlayQueueByIndex", + "id", trackIDs[0], + "id", trackIDs[1], + "id", trackIDs[2], + "currentIndex", fmt.Sprintf("%d", 0), + "position", "9999", + ) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + + // Verify with getPlayQueueByIndex + resp = doReq("getPlayQueueByIndex") + Expect(resp.PlayQueueByIndex).ToNot(BeNil()) + Expect(resp.PlayQueueByIndex.Entry).To(HaveLen(3)) + Expect(resp.PlayQueueByIndex.CurrentIndex).ToNot(BeNil()) + Expect(*resp.PlayQueueByIndex.CurrentIndex).To(Equal(0)) + Expect(resp.PlayQueueByIndex.Position).To(Equal(int64(9999))) + }) + }) +}) diff --git a/server/e2e/subsonic_browsing_test.go b/server/e2e/subsonic_browsing_test.go new file mode 100644 index 000000000..55aeb8e9e --- /dev/null +++ b/server/e2e/subsonic_browsing_test.go @@ -0,0 +1,464 @@ +package e2e + +import ( + "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Browsing Endpoints", func() { + BeforeEach(func() { + setupTestDB() + }) + + Describe("getMusicFolders", func() { + It("returns the configured music library", func() { + resp := doReq("getMusicFolders") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.MusicFolders).ToNot(BeNil()) + Expect(resp.MusicFolders.Folders).To(HaveLen(1)) + Expect(resp.MusicFolders.Folders[0].Name).To(Equal("Music Library")) + Expect(resp.MusicFolders.Folders[0].Id).To(Equal(int32(lib.ID))) + }) + }) + + Describe("getIndexes", func() { + It("returns artist indexes", func() { + resp := doReq("getIndexes") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Indexes).ToNot(BeNil()) + Expect(resp.Indexes.Index).ToNot(BeEmpty()) + }) + + It("includes all artists across indexes", func() { + resp := doReq("getIndexes") + + var allArtistNames []string + for _, idx := range resp.Indexes.Index { + for _, a := range idx.Artists { + allArtistNames = append(allArtistNames, a.Name) + } + } + Expect(allArtistNames).To(ContainElements("The Beatles", "Led Zeppelin", "Miles Davis", "Various")) + }) + }) + + Describe("getArtists", func() { + It("returns artist indexes in ID3 format", func() { + resp := doReq("getArtists") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Artist).ToNot(BeNil()) + Expect(resp.Artist.Index).ToNot(BeEmpty()) + }) + + It("includes all artists across ID3 indexes", func() { + resp := doReq("getArtists") + + var allArtistNames []string + for _, idx := range resp.Artist.Index { + for _, a := range idx.Artists { + allArtistNames = append(allArtistNames, a.Name) + } + } + Expect(allArtistNames).To(ContainElements("The Beatles", "Led Zeppelin", "Miles Davis", "Various")) + }) + + It("reports correct album counts for artists", func() { + resp := doReq("getArtists") + + var beatlesAlbumCount int32 + for _, idx := range resp.Artist.Index { + for _, a := range idx.Artists { + if a.Name == "The Beatles" { + beatlesAlbumCount = a.AlbumCount + } + } + } + Expect(beatlesAlbumCount).To(Equal(int32(2))) + }) + }) + + Describe("getMusicDirectory", func() { + It("returns an artist directory with its albums as children", func() { + artists, err := ds.Artist(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"name": "The Beatles"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(artists).ToNot(BeEmpty()) + beatlesID := artists[0].ID + + resp := doReq("getMusicDirectory", "id", beatlesID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Directory).ToNot(BeNil()) + Expect(resp.Directory.Name).To(Equal("The Beatles")) + Expect(resp.Directory.Child).To(HaveLen(2)) // Abbey Road, Help! + }) + + It("returns an album directory with its tracks as children", func() { + albums, err := ds.Album(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"album.name": "Abbey Road"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(albums).ToNot(BeEmpty()) + abbeyRoadID := albums[0].ID + + resp := doReq("getMusicDirectory", "id", abbeyRoadID) + + Expect(resp.Directory).ToNot(BeNil()) + Expect(resp.Directory.Name).To(Equal("Abbey Road")) + Expect(resp.Directory.Child).To(HaveLen(2)) // Come Together, Something + }) + + It("returns an error for a non-existent ID", func() { + resp := doReq("getMusicDirectory", "id", "non-existent-id") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + }) + + Describe("getArtist", func() { + It("returns artist with albums in ID3 format", func() { + artists, err := ds.Artist(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"name": "The Beatles"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(artists).ToNot(BeEmpty()) + beatlesID := artists[0].ID + + resp := doReq("getArtist", "id", beatlesID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.ArtistWithAlbumsID3).ToNot(BeNil()) + Expect(resp.ArtistWithAlbumsID3.Name).To(Equal("The Beatles")) + Expect(resp.ArtistWithAlbumsID3.Album).To(HaveLen(2)) + }) + + It("returns album names for the artist", func() { + artists, err := ds.Artist(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"name": "The Beatles"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(artists).ToNot(BeEmpty()) + beatlesID := artists[0].ID + + resp := doReq("getArtist", "id", beatlesID) + + var albumNames []string + for _, a := range resp.ArtistWithAlbumsID3.Album { + albumNames = append(albumNames, a.Name) + } + Expect(albumNames).To(ContainElements("Abbey Road", "Help!")) + }) + + It("returns an error for a non-existent artist", func() { + resp := doReq("getArtist", "id", "non-existent-id") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("returns artist with a single album", func() { + artists, err := ds.Artist(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"name": "Led Zeppelin"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(artists).ToNot(BeEmpty()) + ledZepID := artists[0].ID + + resp := doReq("getArtist", "id", ledZepID) + + Expect(resp.ArtistWithAlbumsID3).ToNot(BeNil()) + Expect(resp.ArtistWithAlbumsID3.Name).To(Equal("Led Zeppelin")) + Expect(resp.ArtistWithAlbumsID3.Album).To(HaveLen(1)) + Expect(resp.ArtistWithAlbumsID3.Album[0].Name).To(Equal("IV")) + }) + }) + + Describe("getAlbum", func() { + It("returns album with its tracks", func() { + albums, err := ds.Album(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"album.name": "Abbey Road"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(albums).ToNot(BeEmpty()) + abbeyRoadID := albums[0].ID + + resp := doReq("getAlbum", "id", abbeyRoadID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.AlbumWithSongsID3).ToNot(BeNil()) + Expect(resp.AlbumWithSongsID3.Name).To(Equal("Abbey Road")) + Expect(resp.AlbumWithSongsID3.Song).To(HaveLen(2)) + }) + + It("includes correct track metadata", func() { + albums, err := ds.Album(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"album.name": "Abbey Road"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(albums).ToNot(BeEmpty()) + abbeyRoadID := albums[0].ID + + resp := doReq("getAlbum", "id", abbeyRoadID) + + var trackTitles []string + for _, s := range resp.AlbumWithSongsID3.Song { + trackTitles = append(trackTitles, s.Title) + } + Expect(trackTitles).To(ContainElements("Come Together", "Something")) + }) + + It("returns album with correct artist and year", func() { + albums, err := ds.Album(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"album.name": "Kind of Blue"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(albums).ToNot(BeEmpty()) + kindOfBlueID := albums[0].ID + + resp := doReq("getAlbum", "id", kindOfBlueID) + + Expect(resp.AlbumWithSongsID3).ToNot(BeNil()) + Expect(resp.AlbumWithSongsID3.Name).To(Equal("Kind of Blue")) + Expect(resp.AlbumWithSongsID3.Artist).To(Equal("Miles Davis")) + Expect(resp.AlbumWithSongsID3.Year).To(Equal(int32(1959))) + Expect(resp.AlbumWithSongsID3.Song).To(HaveLen(1)) + }) + + It("returns an error for a non-existent album", func() { + resp := doReq("getAlbum", "id", "non-existent-id") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + }) + + Describe("getSong", func() { + It("returns a song by its ID", func() { + songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"title": "Come Together"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).ToNot(BeEmpty()) + songID := songs[0].ID + + resp := doReq("getSong", "id", songID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Song).ToNot(BeNil()) + Expect(resp.Song.Title).To(Equal("Come Together")) + Expect(resp.Song.Album).To(Equal("Abbey Road")) + Expect(resp.Song.Artist).To(Equal("The Beatles")) + }) + + It("returns an error for a non-existent song", func() { + resp := doReq("getSong", "id", "non-existent-id") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("returns correct metadata for a jazz track", func() { + songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"title": "So What"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).ToNot(BeEmpty()) + songID := songs[0].ID + + resp := doReq("getSong", "id", songID) + + Expect(resp.Song).ToNot(BeNil()) + Expect(resp.Song.Title).To(Equal("So What")) + Expect(resp.Song.Album).To(Equal("Kind of Blue")) + Expect(resp.Song.Artist).To(Equal("Miles Davis")) + }) + }) + + Describe("getGenres", func() { + It("returns all genres", func() { + resp := doReq("getGenres") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Genres).ToNot(BeNil()) + Expect(resp.Genres.Genre).To(HaveLen(4)) + }) + + It("includes correct genre names", func() { + resp := doReq("getGenres") + + var genreNames []string + for _, g := range resp.Genres.Genre { + genreNames = append(genreNames, g.Name) + } + Expect(genreNames).To(ContainElements("Rock", "Jazz", "Pop")) + }) + + It("reports correct song and album counts for Rock", func() { + resp := doReq("getGenres") + + var rockGenre *responses.Genre + for i, g := range resp.Genres.Genre { + if g.Name == "Rock" { + rockGenre = &resp.Genres.Genre[i] + break + } + } + Expect(rockGenre).ToNot(BeNil()) + Expect(rockGenre.SongCount).To(Equal(int32(4))) + Expect(rockGenre.AlbumCount).To(Equal(int32(3))) + }) + + It("reports correct song and album counts for Jazz", func() { + resp := doReq("getGenres") + + var jazzGenre *responses.Genre + for i, g := range resp.Genres.Genre { + if g.Name == "Jazz" { + jazzGenre = &resp.Genres.Genre[i] + break + } + } + Expect(jazzGenre).ToNot(BeNil()) + Expect(jazzGenre.SongCount).To(Equal(int32(2))) + Expect(jazzGenre.AlbumCount).To(Equal(int32(2))) + }) + + It("reports correct song and album counts for Pop", func() { + resp := doReq("getGenres") + + var popGenre *responses.Genre + for i, g := range resp.Genres.Genre { + if g.Name == "Pop" { + popGenre = &resp.Genres.Genre[i] + break + } + } + Expect(popGenre).ToNot(BeNil()) + Expect(popGenre.SongCount).To(Equal(int32(1))) + Expect(popGenre.AlbumCount).To(Equal(int32(1))) + }) + }) + + Describe("getAlbumInfo", func() { + It("returns album info for a valid album", func() { + albums, err := ds.Album(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"album.name": "Abbey Road"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(albums).ToNot(BeEmpty()) + abbeyRoadID := albums[0].ID + + resp := doReq("getAlbumInfo", "id", abbeyRoadID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.AlbumInfo).ToNot(BeNil()) + }) + }) + + Describe("getAlbumInfo2", func() { + It("returns album info for a valid album", func() { + albums, err := ds.Album(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"album.name": "Abbey Road"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(albums).ToNot(BeEmpty()) + abbeyRoadID := albums[0].ID + + resp := doReq("getAlbumInfo2", "id", abbeyRoadID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.AlbumInfo).ToNot(BeNil()) + }) + }) + + Describe("getArtistInfo", func() { + It("returns artist info for a valid artist", func() { + artists, err := ds.Artist(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"name": "The Beatles"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(artists).ToNot(BeEmpty()) + beatlesID := artists[0].ID + + resp := doReq("getArtistInfo", "id", beatlesID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.ArtistInfo).ToNot(BeNil()) + }) + }) + + Describe("getArtistInfo2", func() { + It("returns artist info2 for a valid artist", func() { + artists, err := ds.Artist(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"name": "The Beatles"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(artists).ToNot(BeEmpty()) + beatlesID := artists[0].ID + + resp := doReq("getArtistInfo2", "id", beatlesID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.ArtistInfo2).ToNot(BeNil()) + }) + }) + + Describe("getTopSongs", func() { + It("returns a response for a known artist name", func() { + resp := doReq("getTopSongs", "artist", "The Beatles") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TopSongs).ToNot(BeNil()) + // noopProvider returns empty list, so Songs may be empty + }) + + It("returns an empty list for an unknown artist", func() { + resp := doReq("getTopSongs", "artist", "Unknown Artist") + + Expect(resp.TopSongs).ToNot(BeNil()) + Expect(resp.TopSongs.Song).To(BeEmpty()) + }) + }) + + Describe("getSimilarSongs", func() { + It("returns a response for a valid song ID", func() { + songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"title": "Come Together"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).ToNot(BeEmpty()) + songID := songs[0].ID + + resp := doReq("getSimilarSongs", "id", songID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SimilarSongs).ToNot(BeNil()) + // noopProvider returns empty list + }) + }) + + Describe("getSimilarSongs2", func() { + It("returns a response for a valid song ID", func() { + songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"title": "Come Together"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).ToNot(BeEmpty()) + songID := songs[0].ID + + resp := doReq("getSimilarSongs2", "id", songID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SimilarSongs2).ToNot(BeNil()) + // noopProvider returns empty list + }) + }) +}) diff --git a/server/e2e/subsonic_media_annotation_test.go b/server/e2e/subsonic_media_annotation_test.go new file mode 100644 index 000000000..0f7e92083 --- /dev/null +++ b/server/e2e/subsonic_media_annotation_test.go @@ -0,0 +1,160 @@ +package e2e + +import ( + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Media Annotation Endpoints", Ordered, func() { + BeforeAll(func() { + setupTestDB() + }) + + Describe("Star/Unstar", Ordered, func() { + var songID, albumID, artistID string + + BeforeAll(func() { + // Look up a song from the scanned data + songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{Max: 1, Sort: "title"}) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).ToNot(BeEmpty()) + songID = songs[0].ID + + // Look up an album + albums, err := ds.Album(ctx).GetAll(model.QueryOptions{Max: 1, Sort: "name"}) + Expect(err).ToNot(HaveOccurred()) + Expect(albums).ToNot(BeEmpty()) + albumID = albums[0].ID + + // Look up an artist + artists, err := ds.Artist(ctx).GetAll(model.QueryOptions{Max: 1, Sort: "name"}) + Expect(err).ToNot(HaveOccurred()) + Expect(artists).ToNot(BeEmpty()) + artistID = artists[0].ID + }) + + It("stars a song by id", func() { + resp := doReq("star", "id", songID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + + It("starred song appears in getStarred response", func() { + resp := doReq("getStarred") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Starred).ToNot(BeNil()) + Expect(resp.Starred.Song).To(HaveLen(1)) + Expect(resp.Starred.Song[0].Id).To(Equal(songID)) + }) + + It("unstars a previously starred song", func() { + resp := doReq("unstar", "id", songID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + + // Verify song no longer appears in starred + resp = doReq("getStarred") + + Expect(resp.Starred.Song).To(BeEmpty()) + }) + + It("stars an album by albumId", func() { + resp := doReq("star", "albumId", albumID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + + // Verify album appears in starred + resp = doReq("getStarred") + + Expect(resp.Starred.Album).To(HaveLen(1)) + Expect(resp.Starred.Album[0].Id).To(Equal(albumID)) + }) + + It("stars an artist by artistId", func() { + resp := doReq("star", "artistId", artistID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + + // Verify artist appears in starred + resp = doReq("getStarred") + + Expect(resp.Starred.Artist).To(HaveLen(1)) + Expect(resp.Starred.Artist[0].Id).To(Equal(artistID)) + }) + + It("returns error when no id provided", func() { + resp := doReq("star") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + }) + + Describe("SetRating", Ordered, func() { + var songID, albumID string + + BeforeAll(func() { + songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{Max: 1, Sort: "title"}) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).ToNot(BeEmpty()) + songID = songs[0].ID + + albums, err := ds.Album(ctx).GetAll(model.QueryOptions{Max: 1, Sort: "name"}) + Expect(err).ToNot(HaveOccurred()) + Expect(albums).ToNot(BeEmpty()) + albumID = albums[0].ID + }) + + It("sets rating on a song", func() { + resp := doReq("setRating", "id", songID, "rating", "4") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + + It("rated song has correct userRating in getSong", func() { + resp := doReq("getSong", "id", songID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Song).ToNot(BeNil()) + Expect(resp.Song.UserRating).To(Equal(int32(4))) + }) + + It("sets rating on an album", func() { + resp := doReq("setRating", "id", albumID, "rating", "3") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + + It("returns error for missing parameters", func() { + // Missing both id and rating + resp := doReq("setRating") + Expect(resp.Status).To(Equal(responses.StatusFailed)) + + // Missing rating + resp = doReq("setRating", "id", songID) + Expect(resp.Status).To(Equal(responses.StatusFailed)) + }) + }) + + Describe("Scrobble", func() { + It("submits a scrobble for a song", func() { + songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{Max: 1, Sort: "title"}) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).ToNot(BeEmpty()) + + resp := doReq("scrobble", "id", songs[0].ID, "submission", "true") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + + It("returns error when id is missing", func() { + resp := doReq("scrobble") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + }) +}) diff --git a/server/e2e/subsonic_media_retrieval_test.go b/server/e2e/subsonic_media_retrieval_test.go new file mode 100644 index 000000000..079b131ff --- /dev/null +++ b/server/e2e/subsonic_media_retrieval_test.go @@ -0,0 +1,199 @@ +package e2e + +import ( + "net/http" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Media Retrieval Endpoints", Ordered, func() { + BeforeAll(func() { + setupTestDB() + }) + + Describe("Stream", func() { + var trackID string + + BeforeAll(func() { + // All test tracks are mp3 at 320kbps + songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{Max: 1, Sort: "title"}) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).ToNot(BeEmpty()) + trackID = songs[0].ID + }) + + It("returns error when id parameter is missing", func() { + resp := doReq("stream") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("streams raw when no format or bitrate specified", func() { + w := doRawReq("stream", "id", trackID) + + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("raw")) + }) + + It("streams raw when format=raw", func() { + w := doRawReq("stream", "id", trackID, "format", "raw") + + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("raw")) + }) + + It("transcodes to different format with bitrate", func() { + w := doRawReq("stream", "id", trackID, "format", "opus", "maxBitRate", "128") + + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("opus")) + Expect(streamerSpy.LastRequest.BitRate).To(Equal(128)) + }) + + It("downsamples when only maxBitRate is specified (lower than source)", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.DefaultDownsamplingFormat = "opus" + + w := doRawReq("stream", "id", trackID, "maxBitRate", "128") + + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("opus")) + Expect(streamerSpy.LastRequest.BitRate).To(Equal(128)) + }) + + It("streams raw when maxBitRate is higher than source", func() { + w := doRawReq("stream", "id", trackID, "maxBitRate", "999") + + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("raw")) + }) + + It("streams raw when format matches source and no bitrate reduction", func() { + w := doRawReq("stream", "id", trackID, "format", "mp3", "maxBitRate", "320") + + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("raw")) + }) + + It("transcodes when same format but lower bitrate", func() { + w := doRawReq("stream", "id", trackID, "format", "mp3", "maxBitRate", "128") + + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("mp3")) + Expect(streamerSpy.LastRequest.BitRate).To(Equal(128)) + }) + + It("falls back to default downsampling format for unknown format", func() { + w := doRawReq("stream", "id", trackID, "format", "xyz") + + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("opus")) + }) + + It("passes timeOffset through", func() { + w := doRawReq("stream", "id", trackID, "format", "opus", "maxBitRate", "128", "timeOffset", "30") + + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("opus")) + Expect(streamerSpy.LastRequest.Offset).To(Equal(30)) + }) + }) + + Describe("Download", func() { + var trackID string + + BeforeAll(func() { + // All test tracks are mp3 at 320kbps + songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{Max: 1, Sort: "title"}) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).ToNot(BeEmpty()) + trackID = songs[0].ID + }) + + It("returns error when id parameter is missing", func() { + resp := doReq("download") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("downloads raw when no format specified and AutoTranscodeDownload is false", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.EnableDownloads = true + conf.Server.AutoTranscodeDownload = false + + w := doRawReq("download", "id", trackID) + + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("raw")) + }) + + It("downloads with explicit format and bitrate", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.EnableDownloads = true + + w := doRawReq("download", "id", trackID, "format", "opus", "bitrate", "128") + + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("opus")) + Expect(streamerSpy.LastRequest.BitRate).To(Equal(128)) + }) + + It("returns error when downloads are disabled", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.EnableDownloads = false + + resp := doReq("download", "id", trackID) + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + }) + }) + + Describe("GetCoverArt", func() { + It("handles request without error", func() { + w := doRawReq("getCoverArt") + + Expect(w.Code).To(Equal(http.StatusOK)) + }) + }) + + Describe("GetAvatar", func() { + It("returns placeholder avatar when gravatar disabled", func() { + w := doRawReq("getAvatar", "username", "admin") + + Expect(w.Code).To(Equal(http.StatusOK)) + }) + }) + + Describe("GetLyrics", func() { + It("returns empty lyrics when no match found", func() { + resp := doReq("getLyrics", "artist", "NonExistentArtist", "title", "NonExistentTitle") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Lyrics).ToNot(BeNil()) + Expect(resp.Lyrics.Value).To(BeEmpty()) + }) + }) + + Describe("GetLyricsBySongId", func() { + It("returns error when id parameter is missing", func() { + resp := doReq("getLyricsBySongId") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("returns error for non-existent song id", func() { + resp := doReq("getLyricsBySongId", "id", "non-existent-id") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + }) +}) diff --git a/server/e2e/subsonic_multilibrary_test.go b/server/e2e/subsonic_multilibrary_test.go new file mode 100644 index 000000000..a837da124 --- /dev/null +++ b/server/e2e/subsonic_multilibrary_test.go @@ -0,0 +1,296 @@ +package e2e + +import ( + "fmt" + "testing/fstest" + + "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/core" + "github.com/navidrome/navidrome/core/artwork" + "github.com/navidrome/navidrome/core/metrics" + "github.com/navidrome/navidrome/core/playlists" + "github.com/navidrome/navidrome/core/storage/storagetest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/scanner" + "github.com/navidrome/navidrome/server/events" + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Multi-Library Support", Ordered, func() { + var lib2 model.Library + var adminWithLibs model.User // admin reloaded with both libraries + var userLib1Only model.User // non-admin with lib1 access only + + BeforeAll(func() { + conf.Server.EnableSharing = true + setupTestDB() + + // Create a second FakeFS with Classical music content + classical := template(_t{ + "albumartist": "Ludwig van Beethoven", + "artist": "Ludwig van Beethoven", + "album": "Symphony No. 9", + "year": 1824, + "genre": "Classical", + }) + classicalFS := storagetest.FakeFS{} + classicalFS.SetFiles(fstest.MapFS{ + "Classical/Beethoven/Symphony No. 9/01 - Allegro ma non troppo.mp3": classical(track(1, "Allegro ma non troppo")), + "Classical/Beethoven/Symphony No. 9/02 - Ode to Joy.mp3": classical(track(2, "Ode to Joy")), + }) + storagetest.Register("fake2", &classicalFS) + + // Create the second library in the DB (Put auto-assigns admin users) + lib2 = model.Library{ID: 2, Name: "Classical Library", Path: "fake2:///classical"} + Expect(ds.Library(ctx).Put(&lib2)).To(Succeed()) + + // Reload admin user to get both libraries in the Libraries field + loadedAdmin, err := ds.User(ctx).FindByUsername(adminUser.UserName) + Expect(err).ToNot(HaveOccurred()) + adminWithLibs = *loadedAdmin + + // Run incremental scan to import lib2 content (lib1 files unchanged → skipped) + s := scanner.New(ctx, ds, artwork.NoopCacheWarmer(), events.NoopBroker(), + playlists.NewPlaylists(ds, core.NewImageUploadService()), metrics.NewNoopInstance()) + _, err = s.ScanAll(ctx, false) + Expect(err).ToNot(HaveOccurred()) + + // Create a non-admin user with access only to lib1 + userLib1Only = model.User{ + ID: "multilib-user-1", + UserName: "lib1user", + Name: "Lib1 User", + IsAdmin: false, + NewPassword: "password", + } + Expect(ds.User(ctx).Put(&userLib1Only)).To(Succeed()) + Expect(ds.User(ctx).SetUserLibraries(userLib1Only.ID, []int{lib.ID})).To(Succeed()) + + loadedUser, err := ds.User(ctx).FindByUsername(userLib1Only.UserName) + Expect(err).ToNot(HaveOccurred()) + userLib1Only.Libraries = loadedUser.Libraries + }) + + Describe("getMusicFolders", func() { + It("returns both libraries for admin user", func() { + resp := doReqWithUser(adminWithLibs, "getMusicFolders") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.MusicFolders.Folders).To(HaveLen(2)) + + names := make([]string, len(resp.MusicFolders.Folders)) + for i, f := range resp.MusicFolders.Folders { + names[i] = f.Name + } + Expect(names).To(ConsistOf("Music Library", "Classical Library")) + }) + }) + + Describe("getArtists - library filtering", func() { + It("returns only lib1 artists when musicFolderId=1", func() { + resp := doReqWithUser(adminWithLibs, "getArtists", "musicFolderId", fmt.Sprintf("%d", lib.ID)) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Artist).ToNot(BeNil()) + + var artistNames []string + for _, idx := range resp.Artist.Index { + for _, a := range idx.Artists { + artistNames = append(artistNames, a.Name) + } + } + Expect(artistNames).To(ContainElements("The Beatles", "Led Zeppelin", "Miles Davis")) + Expect(artistNames).ToNot(ContainElement("Ludwig van Beethoven")) + }) + + It("returns only lib2 artists when musicFolderId=2", func() { + resp := doReqWithUser(adminWithLibs, "getArtists", "musicFolderId", fmt.Sprintf("%d", lib2.ID)) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Artist).ToNot(BeNil()) + + var artistNames []string + for _, idx := range resp.Artist.Index { + for _, a := range idx.Artists { + artistNames = append(artistNames, a.Name) + } + } + Expect(artistNames).To(ContainElement("Ludwig van Beethoven")) + Expect(artistNames).ToNot(ContainElements("The Beatles", "Led Zeppelin", "Miles Davis")) + }) + + It("returns artists from all libraries when no musicFolderId is specified", func() { + resp := doReqWithUser(adminWithLibs, "getArtists") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + + var artistNames []string + for _, idx := range resp.Artist.Index { + for _, a := range idx.Artists { + artistNames = append(artistNames, a.Name) + } + } + Expect(artistNames).To(ContainElements("The Beatles", "Led Zeppelin", "Miles Davis", "Ludwig van Beethoven")) + }) + }) + + Describe("getAlbumList - library filtering", func() { + It("returns only lib1 albums when musicFolderId=1", func() { + resp := doReqWithUser(adminWithLibs, "getAlbumList", "type", "alphabeticalByName", "musicFolderId", fmt.Sprintf("%d", lib.ID)) + + Expect(resp.AlbumList).ToNot(BeNil()) + Expect(resp.AlbumList.Album).To(HaveLen(7)) + for _, a := range resp.AlbumList.Album { + Expect(a.Title).ToNot(Equal("Symphony No. 9")) + } + }) + + It("returns only lib2 albums when musicFolderId=2", func() { + resp := doReqWithUser(adminWithLibs, "getAlbumList", "type", "alphabeticalByName", "musicFolderId", fmt.Sprintf("%d", lib2.ID)) + + Expect(resp.AlbumList).ToNot(BeNil()) + Expect(resp.AlbumList.Album).To(HaveLen(1)) + Expect(resp.AlbumList.Album[0].Title).To(Equal("Symphony No. 9")) + }) + }) + + Describe("search3 - library filtering", func() { + It("does not find lib1 content when searching in lib2 only", func() { + resp := doReqWithUser(adminWithLibs, "search3", "query", "Beatles", "musicFolderId", fmt.Sprintf("%d", lib2.ID)) + + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Artist).To(BeEmpty()) + Expect(resp.SearchResult3.Album).To(BeEmpty()) + Expect(resp.SearchResult3.Song).To(BeEmpty()) + }) + + It("finds lib2 content when searching in lib2", func() { + resp := doReqWithUser(adminWithLibs, "search3", "query", "Beethoven", "musicFolderId", fmt.Sprintf("%d", lib2.ID)) + + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Artist).ToNot(BeEmpty()) + Expect(resp.SearchResult3.Artist[0].Name).To(Equal("Ludwig van Beethoven")) + }) + }) + + Describe("Cross-library playlists", Ordered, func() { + var playlistID string + var lib1SongID, lib2SongID string + + BeforeAll(func() { + // Look up one song from each library + lib1Songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"media_file.library_id": lib.ID}, + Max: 1, Sort: "title", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(lib1Songs).ToNot(BeEmpty()) + lib1SongID = lib1Songs[0].ID + + lib2Songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"media_file.library_id": lib2.ID}, + Max: 1, Sort: "title", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(lib2Songs).ToNot(BeEmpty()) + lib2SongID = lib2Songs[0].ID + }) + + It("admin creates a playlist with songs from both libraries", func() { + resp := doReqWithUser(adminWithLibs, "createPlaylist", + "name", "Cross-Library Playlist", "songId", lib1SongID, "songId", lib2SongID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Playlist).ToNot(BeNil()) + Expect(resp.Playlist.SongCount).To(Equal(int32(2))) + Expect(resp.Playlist.Entry).To(HaveLen(2)) + playlistID = resp.Playlist.Id + }) + + It("admin makes the playlist public", func() { + resp := doReqWithUser(adminWithLibs, "updatePlaylist", + "playlistId", playlistID, "public", "true") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + + It("non-admin user with lib1 only sees only lib1 tracks in the playlist", func() { + resp := doReqWithUser(userLib1Only, "getPlaylist", "id", playlistID) + + Expect(resp.Playlist).ToNot(BeNil()) + // The playlist has 2 songs total, but the non-admin user only has access to lib1 + Expect(resp.Playlist.Entry).To(HaveLen(1)) + Expect(resp.Playlist.Entry[0].Id).To(Equal(lib1SongID)) + }) + }) + + Describe("Cross-library shares", Ordered, func() { + var lib2AlbumID string + + BeforeAll(func() { + lib2Albums, err := ds.Album(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"album.library_id": lib2.ID}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(lib2Albums).ToNot(BeEmpty()) + lib2AlbumID = lib2Albums[0].ID + }) + + It("admin creates a share for a lib2 album", func() { + resp := doReqWithUser(adminWithLibs, "createShare", + "id", lib2AlbumID, "description", "Classical album share") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Shares).ToNot(BeNil()) + Expect(resp.Shares.Share).To(HaveLen(1)) + + share := resp.Shares.Share[0] + Expect(share.Description).To(Equal("Classical album share")) + Expect(share.Entry).ToNot(BeEmpty()) + Expect(share.Entry[0].Title).To(Equal("Symphony No. 9")) + }) + }) + + Describe("Library access control", func() { + It("returns error when non-admin user requests inaccessible library", func() { + resp := doReqWithUser(userLib1Only, "getArtists", "musicFolderId", fmt.Sprintf("%d", lib2.ID)) + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("non-admin user sees only their library's content without musicFolderId", func() { + resp := doReqWithUser(userLib1Only, "getArtists") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + + var artistNames []string + for _, idx := range resp.Artist.Index { + for _, a := range idx.Artists { + artistNames = append(artistNames, a.Name) + } + } + Expect(artistNames).To(ContainElements("The Beatles", "Led Zeppelin", "Miles Davis")) + Expect(artistNames).ToNot(ContainElement("Ludwig van Beethoven")) + }) + + It("non-admin user search returns only their library's content", func() { + resp := doReqWithUser(userLib1Only, "search3", "query", "Beethoven") + + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Artist).To(BeEmpty(), "userLib1Only should not see Beethoven (lib2)") + Expect(resp.SearchResult3.Album).To(BeEmpty()) + Expect(resp.SearchResult3.Song).To(BeEmpty()) + }) + + It("non-admin user search finds content from their library", func() { + resp := doReqWithUser(userLib1Only, "search3", "query", "Beatles") + + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Artist).ToNot(BeEmpty(), "userLib1Only should find Beatles (lib1)") + }) + }) +}) diff --git a/server/e2e/subsonic_multiuser_test.go b/server/e2e/subsonic_multiuser_test.go new file mode 100644 index 000000000..4a5c35a7e --- /dev/null +++ b/server/e2e/subsonic_multiuser_test.go @@ -0,0 +1,74 @@ +package e2e + +import ( + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Multi-User Isolation", Ordered, func() { + var regularUser model.User + + BeforeAll(func() { + setupTestDB() + + regularUser = createUser("regular-1", "regular", "Regular User", false) + }) + + Describe("Admin-only endpoint restrictions", func() { + It("startScan fails for regular user", func() { + resp := doReqWithUser(regularUser, "startScan") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + }) + + Describe("Browsing as regular user", func() { + It("regular user can browse the library", func() { + resp := doReqWithUser(regularUser, "getArtists") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Artist).ToNot(BeNil()) + Expect(resp.Artist.Index).ToNot(BeEmpty()) + }) + + It("regular user can search", func() { + resp := doReqWithUser(regularUser, "search3", "query", "Beatles") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Artist).ToNot(BeEmpty()) + }) + }) + + Describe("getUser authorization", func() { + It("regular user can get their own info", func() { + resp := doReqWithUser(regularUser, "getUser", "username", "regular") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.User.Username).To(Equal("regular")) + Expect(resp.User.AdminRole).To(BeFalse()) + }) + + It("regular user cannot get another user's info", func() { + resp := doReqWithUser(regularUser, "getUser", "username", "admin") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + }) + + Describe("getUsers for regular user", func() { + It("returns only the requesting user's info", func() { + resp := doReqWithUser(regularUser, "getUsers") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Users).ToNot(BeNil()) + Expect(resp.Users.User).To(HaveLen(1)) + Expect(resp.Users.User[0].Username).To(Equal("regular")) + Expect(resp.Users.User[0].AdminRole).To(BeFalse()) + }) + }) +}) diff --git a/server/e2e/subsonic_playlists_test.go b/server/e2e/subsonic_playlists_test.go new file mode 100644 index 000000000..3468979f4 --- /dev/null +++ b/server/e2e/subsonic_playlists_test.go @@ -0,0 +1,520 @@ +package e2e + +import ( + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/criteria" + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Playlist Endpoints", Ordered, func() { + var playlistID string + var songIDs []string + + BeforeAll(func() { + setupTestDB() + + // Look up song IDs from scanned data for playlist operations + songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{Sort: "title", Max: 6}) + Expect(err).ToNot(HaveOccurred()) + Expect(len(songs)).To(BeNumerically(">=", 5)) + for _, s := range songs { + songIDs = append(songIDs, s.ID) + } + }) + + It("getPlaylists returns empty list initially", func() { + resp := doReq("getPlaylists") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Playlists).ToNot(BeNil()) + Expect(resp.Playlists.Playlist).To(BeEmpty()) + }) + + It("createPlaylist creates a new playlist with songs", func() { + resp := doReq("createPlaylist", "name", "Test Playlist", + "songId", songIDs[0], "songId", songIDs[1], "songId", songIDs[2]) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Playlist).ToNot(BeNil()) + Expect(resp.Playlist.Name).To(Equal("Test Playlist")) + Expect(resp.Playlist.SongCount).To(Equal(int32(3))) + Expect(resp.Playlist.Entry).To(HaveLen(3)) + Expect(resp.Playlist.Entry[0].Id).To(Equal(songIDs[0])) + Expect(resp.Playlist.Entry[1].Id).To(Equal(songIDs[1])) + Expect(resp.Playlist.Entry[2].Id).To(Equal(songIDs[2])) + playlistID = resp.Playlist.Id + }) + + It("getPlaylist returns playlist with tracks in order", func() { + resp := doReq("getPlaylist", "id", playlistID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Playlist).ToNot(BeNil()) + Expect(resp.Playlist.Name).To(Equal("Test Playlist")) + Expect(resp.Playlist.Entry).To(HaveLen(3)) + Expect(resp.Playlist.Entry[0].Id).To(Equal(songIDs[0])) + Expect(resp.Playlist.Entry[1].Id).To(Equal(songIDs[1])) + Expect(resp.Playlist.Entry[2].Id).To(Equal(songIDs[2])) + }) + + It("createPlaylist without name or playlistId returns error", func() { + resp := doReq("createPlaylist", "songId", songIDs[0]) + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("createPlaylist with playlistId replaces tracks on existing playlist", func() { + // Replace tracks: the playlist had [song0, song1, song2], replace with [song3, song4] + resp := doReq("createPlaylist", "playlistId", playlistID, + "songId", songIDs[3], "songId", songIDs[4]) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Playlist).ToNot(BeNil()) + Expect(resp.Playlist.Id).To(Equal(playlistID)) + Expect(resp.Playlist.SongCount).To(Equal(int32(2))) + Expect(resp.Playlist.Entry).To(HaveLen(2)) + Expect(resp.Playlist.Entry[0].Id).To(Equal(songIDs[3])) + Expect(resp.Playlist.Entry[1].Id).To(Equal(songIDs[4])) + }) + + It("updatePlaylist can rename the playlist", func() { + resp := doReq("updatePlaylist", "playlistId", playlistID, "name", "Renamed Playlist") + Expect(resp.Status).To(Equal(responses.StatusOK)) + + // Verify the rename + resp = doReq("getPlaylist", "id", playlistID) + Expect(resp.Playlist.Name).To(Equal("Renamed Playlist")) + // Tracks should be unchanged + Expect(resp.Playlist.SongCount).To(Equal(int32(2))) + }) + + It("updatePlaylist can set comment", func() { + resp := doReq("updatePlaylist", "playlistId", playlistID, "comment", "My favorite songs") + Expect(resp.Status).To(Equal(responses.StatusOK)) + + resp = doReq("getPlaylist", "id", playlistID) + Expect(resp.Playlist.Comment).To(Equal("My favorite songs")) + }) + + It("updatePlaylist can set public visibility", func() { + resp := doReq("updatePlaylist", "playlistId", playlistID, "public", "true") + Expect(resp.Status).To(Equal(responses.StatusOK)) + + resp = doReq("getPlaylist", "id", playlistID) + Expect(resp.Playlist.Public).To(BeTrue()) + }) + + It("updatePlaylist can add songs", func() { + // Playlist currently has [song3, song4], add song0 + resp := doReq("updatePlaylist", "playlistId", playlistID, "songIdToAdd", songIDs[0]) + Expect(resp.Status).To(Equal(responses.StatusOK)) + + resp = doReq("getPlaylist", "id", playlistID) + Expect(resp.Playlist.SongCount).To(Equal(int32(3))) + Expect(resp.Playlist.Entry).To(HaveLen(3)) + Expect(resp.Playlist.Entry[0].Id).To(Equal(songIDs[3])) + Expect(resp.Playlist.Entry[1].Id).To(Equal(songIDs[4])) + Expect(resp.Playlist.Entry[2].Id).To(Equal(songIDs[0])) + }) + + It("updatePlaylist can add multiple songs at once", func() { + // Playlist currently has [song3, song4, song0], add song1 and song2 + resp := doReq("updatePlaylist", "playlistId", playlistID, + "songIdToAdd", songIDs[1], "songIdToAdd", songIDs[2]) + Expect(resp.Status).To(Equal(responses.StatusOK)) + + resp = doReq("getPlaylist", "id", playlistID) + Expect(resp.Playlist.SongCount).To(Equal(int32(5))) + Expect(resp.Playlist.Entry).To(HaveLen(5)) + }) + + It("updatePlaylist can remove songs by index and verifies correct songs remain", func() { + // Playlist has [song3, song4, song0, song1, song2] + // Remove index 0 (song3) and index 2 (song0) + resp := doReq("updatePlaylist", "playlistId", playlistID, + "songIndexToRemove", "0", "songIndexToRemove", "2") + Expect(resp.Status).To(Equal(responses.StatusOK)) + + resp = doReq("getPlaylist", "id", playlistID) + Expect(resp.Playlist.SongCount).To(Equal(int32(3))) + Expect(resp.Playlist.Entry).To(HaveLen(3)) + Expect(resp.Playlist.Entry[0].Id).To(Equal(songIDs[4])) + Expect(resp.Playlist.Entry[1].Id).To(Equal(songIDs[1])) + Expect(resp.Playlist.Entry[2].Id).To(Equal(songIDs[2])) + }) + + It("updatePlaylist can remove and add songs in a single call", func() { + // Playlist has [song4, song1, song2] + // Remove index 1 (song1) and add song3 + resp := doReq("updatePlaylist", "playlistId", playlistID, + "songIndexToRemove", "1", "songIdToAdd", songIDs[3]) + Expect(resp.Status).To(Equal(responses.StatusOK)) + + resp = doReq("getPlaylist", "id", playlistID) + Expect(resp.Playlist.SongCount).To(Equal(int32(3))) + Expect(resp.Playlist.Entry).To(HaveLen(3)) + Expect(resp.Playlist.Entry[0].Id).To(Equal(songIDs[4])) + Expect(resp.Playlist.Entry[1].Id).To(Equal(songIDs[2])) + Expect(resp.Playlist.Entry[2].Id).To(Equal(songIDs[3])) + }) + + It("updatePlaylist can combine metadata change with track removal", func() { + // Playlist has [song4, song2, song3] + // Rename + remove index 0 (song4) + resp := doReq("updatePlaylist", "playlistId", playlistID, + "name", "Final Playlist", "songIndexToRemove", "0") + Expect(resp.Status).To(Equal(responses.StatusOK)) + + resp = doReq("getPlaylist", "id", playlistID) + Expect(resp.Playlist.Name).To(Equal("Final Playlist")) + Expect(resp.Playlist.SongCount).To(Equal(int32(2))) + Expect(resp.Playlist.Entry[0].Id).To(Equal(songIDs[2])) + Expect(resp.Playlist.Entry[1].Id).To(Equal(songIDs[3])) + }) + + It("updatePlaylist can remove all songs from playlist", func() { + // Playlist has [song2, song3] — remove both + resp := doReq("updatePlaylist", "playlistId", playlistID, + "songIndexToRemove", "0", "songIndexToRemove", "1") + Expect(resp.Status).To(Equal(responses.StatusOK)) + + resp = doReq("getPlaylist", "id", playlistID) + Expect(resp.Playlist.SongCount).To(Equal(int32(0))) + Expect(resp.Playlist.Entry).To(BeEmpty()) + }) + + It("updatePlaylist can add songs to an empty playlist", func() { + resp := doReq("updatePlaylist", "playlistId", playlistID, + "songIdToAdd", songIDs[0]) + Expect(resp.Status).To(Equal(responses.StatusOK)) + + resp = doReq("getPlaylist", "id", playlistID) + Expect(resp.Playlist.SongCount).To(Equal(int32(1))) + Expect(resp.Playlist.Entry).To(HaveLen(1)) + Expect(resp.Playlist.Entry[0].Id).To(Equal(songIDs[0])) + }) + + It("updatePlaylist without playlistId returns error", func() { + resp := doReq("updatePlaylist", "name", "No ID") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("getPlaylists shows the playlist", func() { + resp := doReq("getPlaylists") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Playlists.Playlist).To(HaveLen(1)) + Expect(resp.Playlists.Playlist[0].Id).To(Equal(playlistID)) + }) + + It("deletePlaylist removes the playlist", func() { + resp := doReq("deletePlaylist", "id", playlistID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + + It("getPlaylist on deleted playlist returns error", func() { + resp := doReq("getPlaylist", "id", playlistID) + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("getPlaylists returns empty after deletion", func() { + resp := doReq("getPlaylists") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Playlists.Playlist).To(BeEmpty()) + }) + + Describe("Playlist Permissions", Ordered, func() { + var songIDs []string + var adminPrivateID string + var adminPublicID string + var regularPlaylistID string + + BeforeAll(func() { + setupTestDB() + + songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{Sort: "title", Max: 6}) + Expect(err).ToNot(HaveOccurred()) + Expect(len(songs)).To(BeNumerically(">=", 3)) + for _, s := range songs { + songIDs = append(songIDs, s.ID) + } + }) + + It("admin creates a private playlist", func() { + resp := doReqWithUser(adminUser, "createPlaylist", "name", "Admin Private", + "songId", songIDs[0], "songId", songIDs[1]) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + adminPrivateID = resp.Playlist.Id + }) + + It("admin creates a public playlist", func() { + resp := doReqWithUser(adminUser, "createPlaylist", "name", "Admin Public", + "songId", songIDs[0], "songId", songIDs[1]) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + adminPublicID = resp.Playlist.Id + + // Make it public + resp = doReqWithUser(adminUser, "updatePlaylist", + "playlistId", adminPublicID, "public", "true") + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + + It("regular user creates a playlist", func() { + resp := doReqWithUser(regularUser, "createPlaylist", "name", "Regular Playlist", + "songId", songIDs[0]) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + regularPlaylistID = resp.Playlist.Id + }) + + // --- Private playlist: regular user gets "not found" (repo hides it entirely) --- + + It("regular user cannot see admin's private playlist", func() { + resp := doReqWithUser(regularUser, "getPlaylist", "id", adminPrivateID) + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("regular user cannot update admin's private playlist (not found)", func() { + resp := doReqWithUser(regularUser, "updatePlaylist", + "playlistId", adminPrivateID, "name", "Hacked") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("regular user cannot delete admin's private playlist (not found)", func() { + resp := doReqWithUser(regularUser, "deletePlaylist", "id", adminPrivateID) + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + // --- Public playlist: regular user can see but cannot modify (authorization fail, code 50) --- + + It("regular user can see admin's public playlist", func() { + resp := doReqWithUser(regularUser, "getPlaylist", "id", adminPublicID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Playlist.Name).To(Equal("Admin Public")) + }) + + It("regular user cannot update admin's public playlist", func() { + resp := doReqWithUser(regularUser, "updatePlaylist", + "playlistId", adminPublicID, "name", "Hacked") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + Expect(resp.Error.Code).To(Equal(int32(50))) + }) + + It("regular user cannot add songs to admin's public playlist", func() { + resp := doReqWithUser(regularUser, "updatePlaylist", + "playlistId", adminPublicID, "songIdToAdd", songIDs[2]) + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error.Code).To(Equal(int32(50))) + }) + + It("regular user cannot remove songs from admin's public playlist", func() { + resp := doReqWithUser(regularUser, "updatePlaylist", + "playlistId", adminPublicID, "songIndexToRemove", "0") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error.Code).To(Equal(int32(50))) + }) + + It("regular user cannot delete admin's public playlist", func() { + resp := doReqWithUser(regularUser, "deletePlaylist", "id", adminPublicID) + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error.Code).To(Equal(int32(50))) + }) + + It("regular user cannot replace tracks on admin's public playlist via createPlaylist", func() { + resp := doReqWithUser(regularUser, "createPlaylist", + "playlistId", adminPublicID, "songId", songIDs[2]) + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + // --- Regular user can manage their own playlists --- + + It("regular user can update their own playlist", func() { + resp := doReqWithUser(regularUser, "updatePlaylist", + "playlistId", regularPlaylistID, "name", "My Updated Playlist") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + + resp = doReqWithUser(regularUser, "getPlaylist", "id", regularPlaylistID) + Expect(resp.Playlist.Name).To(Equal("My Updated Playlist")) + }) + + It("regular user can add songs to their own playlist", func() { + resp := doReqWithUser(regularUser, "updatePlaylist", + "playlistId", regularPlaylistID, "songIdToAdd", songIDs[1]) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + + resp = doReqWithUser(regularUser, "getPlaylist", "id", regularPlaylistID) + Expect(resp.Playlist.SongCount).To(Equal(int32(2))) + }) + + It("regular user can delete their own playlist", func() { + resp := doReqWithUser(regularUser, "deletePlaylist", "id", regularPlaylistID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + + // --- Admin can manage any user's playlists --- + + It("admin can update any user's playlist", func() { + resp := doReqWithUser(regularUser, "createPlaylist", "name", "To Be Admin-Edited", + "songId", songIDs[0]) + Expect(resp.Status).To(Equal(responses.StatusOK)) + plsID := resp.Playlist.Id + + resp = doReqWithUser(adminUser, "updatePlaylist", + "playlistId", plsID, "name", "Admin Edited") + Expect(resp.Status).To(Equal(responses.StatusOK)) + + resp = doReqWithUser(adminUser, "getPlaylist", "id", plsID) + Expect(resp.Playlist.Name).To(Equal("Admin Edited")) + }) + + It("admin can delete any user's playlist", func() { + resp := doReqWithUser(regularUser, "createPlaylist", "name", "To Be Admin-Deleted", + "songId", songIDs[0]) + Expect(resp.Status).To(Equal(responses.StatusOK)) + plsID := resp.Playlist.Id + + resp = doReqWithUser(adminUser, "deletePlaylist", "id", plsID) + Expect(resp.Status).To(Equal(responses.StatusOK)) + + resp = doReqWithUser(adminUser, "getPlaylist", "id", plsID) + Expect(resp.Status).To(Equal(responses.StatusFailed)) + }) + + // --- Verify admin's playlists are unchanged --- + + It("admin's private playlist is unchanged after failed regular user operations", func() { + resp := doReqWithUser(adminUser, "getPlaylist", "id", adminPrivateID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Playlist.Name).To(Equal("Admin Private")) + Expect(resp.Playlist.SongCount).To(Equal(int32(2))) + }) + + It("admin's public playlist is unchanged after failed regular user operations", func() { + resp := doReqWithUser(adminUser, "getPlaylist", "id", adminPublicID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Playlist.Name).To(Equal("Admin Public")) + Expect(resp.Playlist.SongCount).To(Equal(int32(2))) + }) + }) + + Describe("Smart Playlist Protection", Ordered, func() { + var smartPlaylistID string + var songID string + + BeforeAll(func() { + setupTestDB() + + // Look up a song ID for mutation tests + songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{Sort: "title", Max: 1}) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).ToNot(BeEmpty()) + songID = songs[0].ID + + // Insert a smart playlist directly into the DB + smartPls := &model.Playlist{ + Name: "Smart Playlist", + OwnerID: adminUser.ID, + Public: false, + Rules: &criteria.Criteria{Expression: criteria.Contains{"title": ""}}, + } + Expect(ds.Playlist(ctx).Put(smartPls)).To(Succeed()) + smartPlaylistID = smartPls.ID + }) + + It("getPlaylist returns smart playlist with readonly flag and validUntil", func() { + resp := doReq("getPlaylist", "id", smartPlaylistID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Playlist.Name).To(Equal("Smart Playlist")) + Expect(resp.Playlist.OpenSubsonicPlaylist).ToNot(BeNil()) + Expect(resp.Playlist.OpenSubsonicPlaylist.Readonly).To(BeTrue()) + expectedValidUntil := time.Now().Add(conf.Server.SmartPlaylistRefreshDelay) + Expect(*resp.Playlist.OpenSubsonicPlaylist.ValidUntil).To(BeTemporally("~", expectedValidUntil, time.Second)) + }) + + It("createPlaylist rejects replacing tracks on smart playlist", func() { + resp := doReq("createPlaylist", "playlistId", smartPlaylistID, "songId", songID) + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + Expect(resp.Error.Code).To(Equal(int32(50))) + }) + + It("updatePlaylist rejects adding songs to smart playlist", func() { + resp := doReq("updatePlaylist", "playlistId", smartPlaylistID, + "songIdToAdd", songID) + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + Expect(resp.Error.Code).To(Equal(int32(50))) + }) + + It("updatePlaylist rejects removing songs from smart playlist", func() { + resp := doReq("updatePlaylist", "playlistId", smartPlaylistID, + "songIndexToRemove", "0") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + Expect(resp.Error.Code).To(Equal(int32(50))) + }) + + It("updatePlaylist allows renaming smart playlist", func() { + resp := doReq("updatePlaylist", "playlistId", smartPlaylistID, + "name", "Renamed Smart") + Expect(resp.Status).To(Equal(responses.StatusOK)) + + resp = doReq("getPlaylist", "id", smartPlaylistID) + Expect(resp.Playlist.Name).To(Equal("Renamed Smart")) + }) + + It("updatePlaylist allows setting comment on smart playlist", func() { + resp := doReq("updatePlaylist", "playlistId", smartPlaylistID, + "comment", "Auto-generated playlist") + Expect(resp.Status).To(Equal(responses.StatusOK)) + + resp = doReq("getPlaylist", "id", smartPlaylistID) + Expect(resp.Playlist.Comment).To(Equal("Auto-generated playlist")) + }) + + It("deletePlaylist can delete smart playlist", func() { + resp := doReq("deletePlaylist", "id", smartPlaylistID) + Expect(resp.Status).To(Equal(responses.StatusOK)) + + resp = doReq("getPlaylist", "id", smartPlaylistID) + Expect(resp.Status).To(Equal(responses.StatusFailed)) + }) + }) +}) diff --git a/server/e2e/subsonic_radio_test.go b/server/e2e/subsonic_radio_test.go new file mode 100644 index 000000000..ce64c31a1 --- /dev/null +++ b/server/e2e/subsonic_radio_test.go @@ -0,0 +1,80 @@ +package e2e + +import ( + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Internet Radio Endpoints", Ordered, func() { + var radioID string + + BeforeAll(func() { + setupTestDB() + }) + + It("getInternetRadioStations returns empty initially", func() { + resp := doReq("getInternetRadioStations") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.InternetRadioStations).ToNot(BeNil()) + Expect(resp.InternetRadioStations.Radios).To(BeEmpty()) + }) + + It("createInternetRadioStation adds a station", func() { + resp := doReq("createInternetRadioStation", + "streamUrl", "https://stream.example.com/radio", + "name", "Test Radio", + "homepageUrl", "https://example.com", + ) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + + It("getInternetRadioStations returns the created station", func() { + resp := doReq("getInternetRadioStations") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.InternetRadioStations).ToNot(BeNil()) + Expect(resp.InternetRadioStations.Radios).To(HaveLen(1)) + + radio := resp.InternetRadioStations.Radios[0] + Expect(radio.Name).To(Equal("Test Radio")) + Expect(radio.StreamUrl).To(Equal("https://stream.example.com/radio")) + Expect(radio.HomepageUrl).To(Equal("https://example.com")) + radioID = radio.ID + Expect(radioID).ToNot(BeEmpty()) + }) + + It("updateInternetRadioStation modifies the station", func() { + resp := doReq("updateInternetRadioStation", + "id", radioID, + "streamUrl", "https://stream.example.com/radio-v2", + "name", "Updated Radio", + "homepageUrl", "https://updated.example.com", + ) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + + // Verify update + resp = doReq("getInternetRadioStations") + Expect(resp.InternetRadioStations.Radios).To(HaveLen(1)) + Expect(resp.InternetRadioStations.Radios[0].Name).To(Equal("Updated Radio")) + Expect(resp.InternetRadioStations.Radios[0].StreamUrl).To(Equal("https://stream.example.com/radio-v2")) + Expect(resp.InternetRadioStations.Radios[0].HomepageUrl).To(Equal("https://updated.example.com")) + }) + + It("deleteInternetRadioStation removes it", func() { + resp := doReq("deleteInternetRadioStation", "id", radioID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + + It("getInternetRadioStations returns empty after deletion", func() { + resp := doReq("getInternetRadioStations") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.InternetRadioStations).ToNot(BeNil()) + Expect(resp.InternetRadioStations.Radios).To(BeEmpty()) + }) +}) diff --git a/server/e2e/subsonic_scan_test.go b/server/e2e/subsonic_scan_test.go new file mode 100644 index 000000000..8bac6fe96 --- /dev/null +++ b/server/e2e/subsonic_scan_test.go @@ -0,0 +1,37 @@ +package e2e + +import ( + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Scan Endpoints", func() { + BeforeEach(func() { + setupTestDB() + }) + + It("getScanStatus returns status", func() { + resp := doReq("getScanStatus") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.ScanStatus).ToNot(BeNil()) + Expect(resp.ScanStatus.Scanning).To(BeFalse()) + Expect(resp.ScanStatus.Count).To(BeNumerically(">", 0)) + Expect(resp.ScanStatus.LastScan).ToNot(BeNil()) + }) + + It("startScan requires admin user", func() { + resp := doReqWithUser(regularUser, "startScan") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("startScan returns scan status response", func() { + resp := doReq("startScan") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.ScanStatus).ToNot(BeNil()) + }) +}) diff --git a/server/e2e/subsonic_searching_test.go b/server/e2e/subsonic_searching_test.go new file mode 100644 index 000000000..7f6aaf57a --- /dev/null +++ b/server/e2e/subsonic_searching_test.go @@ -0,0 +1,274 @@ +package e2e + +import ( + "github.com/google/uuid" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Search Endpoints", func() { + BeforeEach(func() { + setupTestDB() + }) + + Describe("Search2", func() { + It("finds artists by name", func() { + resp := doReq("search2", "query", "Beatles") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SearchResult2).ToNot(BeNil()) + Expect(resp.SearchResult2.Artist).ToNot(BeEmpty()) + + found := false + for _, a := range resp.SearchResult2.Artist { + if a.Name == "The Beatles" { + found = true + break + } + } + Expect(found).To(BeTrue(), "expected to find artist 'The Beatles'") + }) + + It("finds albums by name", func() { + resp := doReq("search2", "query", "Abbey Road") + + Expect(resp.SearchResult2).ToNot(BeNil()) + Expect(resp.SearchResult2.Album).ToNot(BeEmpty()) + + found := false + for _, a := range resp.SearchResult2.Album { + if a.Title == "Abbey Road" { + found = true + break + } + } + Expect(found).To(BeTrue(), "expected to find album 'Abbey Road'") + }) + + It("finds songs by title", func() { + resp := doReq("search2", "query", "Come Together") + + Expect(resp.SearchResult2).ToNot(BeNil()) + Expect(resp.SearchResult2.Song).ToNot(BeEmpty()) + + found := false + for _, s := range resp.SearchResult2.Song { + if s.Title == "Come Together" { + found = true + break + } + } + Expect(found).To(BeTrue(), "expected to find song 'Come Together'") + }) + + It("respects artistCount/albumCount/songCount limits", func() { + resp := doReq("search2", "query", "Beatles", + "artistCount", "1", "albumCount", "1", "songCount", "1") + + Expect(resp.SearchResult2).ToNot(BeNil()) + Expect(len(resp.SearchResult2.Artist)).To(BeNumerically("<=", 1)) + Expect(len(resp.SearchResult2.Album)).To(BeNumerically("<=", 1)) + Expect(len(resp.SearchResult2.Song)).To(BeNumerically("<=", 1)) + }) + + It("supports offset parameters", func() { + // First get all results for Beatles + resp1 := doReq("search2", "query", "Beatles", "songCount", "500") + allSongs := resp1.SearchResult2.Song + + if len(allSongs) > 1 { + // Get with offset to skip the first song + resp2 := doReq("search2", "query", "Beatles", "songOffset", "1", "songCount", "500") + + Expect(resp2.SearchResult2).ToNot(BeNil()) + Expect(len(resp2.SearchResult2.Song)).To(Equal(len(allSongs) - 1)) + } + }) + + It("returns empty results for non-matching query", func() { + resp := doReq("search2", "query", "ZZZZNONEXISTENT99999") + + Expect(resp.SearchResult2).ToNot(BeNil()) + Expect(resp.SearchResult2.Artist).To(BeEmpty()) + Expect(resp.SearchResult2.Album).To(BeEmpty()) + Expect(resp.SearchResult2.Song).To(BeEmpty()) + }) + }) + + Describe("Search3", func() { + It("returns results in ID3 format", func() { + resp := doReq("search3", "query", "Beatles") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SearchResult3).ToNot(BeNil()) + // Verify ID3 format: Artist should be ArtistID3 with Name and AlbumCount + Expect(resp.SearchResult3.Artist).ToNot(BeEmpty()) + Expect(resp.SearchResult3.Artist[0].Name).ToNot(BeEmpty()) + Expect(resp.SearchResult3.Artist[0].Id).ToNot(BeEmpty()) + }) + + It("returns all results when query is empty (OpenSubsonic)", func() { + resp := doReq("search3", "query", "") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Artist).To(HaveLen(6)) + Expect(resp.SearchResult3.Album).To(HaveLen(7)) + Expect(resp.SearchResult3.Song).To(HaveLen(13)) + }) + + It("finds across all entity types simultaneously", func() { + // "Beatles" should match artist, albums, and songs by The Beatles + resp := doReq("search3", "query", "Beatles") + + Expect(resp.SearchResult3).ToNot(BeNil()) + + // Should find at least the artist "The Beatles" + artistFound := false + for _, a := range resp.SearchResult3.Artist { + if a.Name == "The Beatles" { + artistFound = true + break + } + } + Expect(artistFound).To(BeTrue(), "expected to find artist 'The Beatles'") + + // Should find albums by The Beatles (albums contain "Beatles" in artist field) + // Albums are returned as AlbumID3 type + for _, a := range resp.SearchResult3.Album { + Expect(a.Id).ToNot(BeEmpty()) + Expect(a.Name).ToNot(BeEmpty()) + } + + // Songs are returned as Child type + for _, s := range resp.SearchResult3.Song { + Expect(s.Id).ToNot(BeEmpty()) + Expect(s.Title).ToNot(BeEmpty()) + } + }) + + Describe("MBID search", func() { + It("finds songs by mbz_recording_id", func() { + resp := doReq("search3", "query", mbidComeTogetherRec) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Song).To(HaveLen(1)) + Expect(resp.SearchResult3.Song[0].Title).To(Equal("Come Together")) + }) + + It("finds songs by mbz_release_track_id", func() { + resp := doReq("search3", "query", mbidSomething) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Song).To(HaveLen(1)) + Expect(resp.SearchResult3.Song[0].Title).To(Equal("Something")) + }) + + It("finds albums by mbz_album_id", func() { + resp := doReq("search3", "query", mbidAbbeyRoadAlbum) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Album).To(HaveLen(1)) + Expect(resp.SearchResult3.Album[0].Name).To(Equal("Abbey Road")) + }) + + It("finds albums by mbz_release_group_id", func() { + resp := doReq("search3", "query", mbidAbbeyRoadRelGroup) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Album).To(HaveLen(1)) + Expect(resp.SearchResult3.Album[0].Name).To(Equal("Abbey Road")) + }) + + It("finds artists by mbz_artist_id", func() { + resp := doReq("search3", "query", mbidBeatlesArtist) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Artist).To(HaveLen(1)) + Expect(resp.SearchResult3.Artist[0].Name).To(Equal("The Beatles")) + }) + + It("returns empty results for non-matching UUID", func() { + nonMatchingUUID := uuid.NewString() + resp := doReq("search3", "query", nonMatchingUUID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Artist).To(BeEmpty()) + Expect(resp.SearchResult3.Album).To(BeEmpty()) + Expect(resp.SearchResult3.Song).To(BeEmpty()) + }) + + It("does not return songs for artist MBID", func() { + // media_file MBID search only checks mbz_recording_id and mbz_release_track_id, + // so an artist MBID should return only the artist, not songs + resp := doReq("search3", "query", mbidBeatlesArtist) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Artist).To(HaveLen(1)) + Expect(resp.SearchResult3.Artist[0].Name).To(Equal("The Beatles")) + Expect(resp.SearchResult3.Song).To(BeEmpty()) + }) + }) + + Describe("CJK search", func() { + It("finds songs by CJK title", func() { + resp := doReq("search3", "query", "プラチナ") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Song).To(HaveLen(1)) + Expect(resp.SearchResult3.Song[0].Title).To(Equal("プラチナ・ジェット")) + }) + + It("finds artists by CJK name", func() { + resp := doReq("search3", "query", "シートベルツ") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Artist).To(HaveLen(1)) + Expect(resp.SearchResult3.Artist[0].Name).To(Equal("シートベルツ")) + }) + + It("finds albums by CJK artist name", func() { + resp := doReq("search3", "query", "シートベルツ") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Album).To(HaveLen(1)) + Expect(resp.SearchResult3.Album[0].Name).To(Equal("COWBOY BEBOP")) + }) + }) + + Describe("Legacy backend", func() { + It("returns results using legacy LIKE-based search when configured", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Search.Backend = "legacy" + + resp := doReq("search3", "query", "Beatles") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Artist).ToNot(BeEmpty()) + + found := false + for _, a := range resp.SearchResult3.Artist { + if a.Name == "The Beatles" { + found = true + break + } + } + Expect(found).To(BeTrue(), "expected to find artist 'The Beatles' with legacy backend") + }) + }) + }) +}) diff --git a/server/e2e/subsonic_sharing_test.go b/server/e2e/subsonic_sharing_test.go new file mode 100644 index 000000000..1a082ba0f --- /dev/null +++ b/server/e2e/subsonic_sharing_test.go @@ -0,0 +1,127 @@ +package e2e + +import ( + "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Sharing Endpoints", Ordered, func() { + var shareID string + var albumID string + var songID string + + BeforeAll(func() { + conf.Server.EnableSharing = true + setupTestDB() + + albums, err := ds.Album(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"album.name": "Abbey Road"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(albums).ToNot(BeEmpty()) + albumID = albums[0].ID + + songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"title": "Come Together"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).ToNot(BeEmpty()) + songID = songs[0].ID + }) + + It("getShares returns empty initially", func() { + resp := doReq("getShares") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Shares).ToNot(BeNil()) + Expect(resp.Shares.Share).To(BeEmpty()) + }) + + It("createShare creates a share for an album", func() { + resp := doReq("createShare", "id", albumID, "description", "Check out this album") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Shares).ToNot(BeNil()) + Expect(resp.Shares.Share).To(HaveLen(1)) + + share := resp.Shares.Share[0] + Expect(share.ID).ToNot(BeEmpty()) + Expect(share.Description).To(Equal("Check out this album")) + Expect(share.Username).To(Equal(adminUser.UserName)) + shareID = share.ID + }) + + It("getShares returns the created share", func() { + resp := doReq("getShares") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Shares).ToNot(BeNil()) + Expect(resp.Shares.Share).To(HaveLen(1)) + + share := resp.Shares.Share[0] + Expect(share.ID).To(Equal(shareID)) + Expect(share.Description).To(Equal("Check out this album")) + Expect(share.Username).To(Equal(adminUser.UserName)) + Expect(share.Entry).ToNot(BeEmpty()) + }) + + It("updateShare modifies the description", func() { + resp := doReq("updateShare", "id", shareID, "description", "Updated description") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + + // Verify update + resp = doReq("getShares") + Expect(resp.Shares.Share).To(HaveLen(1)) + Expect(resp.Shares.Share[0].Description).To(Equal("Updated description")) + }) + + It("deleteShare removes it", func() { + resp := doReq("deleteShare", "id", shareID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + + It("getShares returns empty after deletion", func() { + resp := doReq("getShares") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Shares).ToNot(BeNil()) + Expect(resp.Shares.Share).To(BeEmpty()) + }) + + It("createShare works with a song ID", func() { + resp := doReq("createShare", "id", songID, "description", "Great song") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Shares).ToNot(BeNil()) + Expect(resp.Shares.Share).To(HaveLen(1)) + Expect(resp.Shares.Share[0].Description).To(Equal("Great song")) + Expect(resp.Shares.Share[0].Entry).To(HaveLen(1)) + }) + + It("createShare returns error when id parameter is missing", func() { + resp := doReq("createShare") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("updateShare returns error when id parameter is missing", func() { + resp := doReq("updateShare") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("deleteShare returns error when id parameter is missing", func() { + resp := doReq("deleteShare") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) +}) diff --git a/server/e2e/subsonic_stream_test.go b/server/e2e/subsonic_stream_test.go new file mode 100644 index 000000000..6a11c1740 --- /dev/null +++ b/server/e2e/subsonic_stream_test.go @@ -0,0 +1,182 @@ +package e2e + +import ( + "encoding/json" + "errors" + "net/http" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("stream.view (legacy streaming)", Ordered, func() { + var ( + mp3TrackID string // Come Together (mp3, 320kbps) + flacTrackID string // TC FLAC Standard (flac, 900kbps) + ) + + BeforeAll(func() { + setupTestDB() + + songs, err := ds.MediaFile(ctx).GetAll() + Expect(err).ToNot(HaveOccurred()) + byTitle := map[string]string{} + for _, s := range songs { + byTitle[s.Title] = s.ID + } + mp3TrackID = byTitle["Come Together"] + Expect(mp3TrackID).ToNot(BeEmpty()) + flacTrackID = byTitle["TC FLAC Standard"] + Expect(flacTrackID).ToNot(BeEmpty()) + }) + + Describe("raw / direct play", func() { + It("streams raw when no format or maxBitRate is specified", func() { + w := doRawReq("stream", "id", flacTrackID) + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(BeElementOf("raw", "")) + }) + + It("streams raw when format=raw is explicitly requested", func() { + w := doRawReq("stream", "id", flacTrackID, "format", "raw") + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(BeElementOf("raw", "")) + }) + + It("streams raw when maxBitRate is >= source bitrate", func() { + w := doRawReq("stream", "id", flacTrackID, "maxBitRate", "1000") + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(BeElementOf("raw", "")) + }) + + It("streams raw when format matches source and bitrate is not lower", func() { + w := doRawReq("stream", "id", mp3TrackID, "format", "mp3", "maxBitRate", "320") + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("raw")) + }) + }) + + Describe("transcoding with explicit format", func() { + It("transcodes to mp3 when format=mp3 is requested", func() { + w := doRawReq("stream", "id", flacTrackID, "format", "mp3") + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("mp3")) + // Should use the mp3 default bitrate (192kbps) + Expect(streamerSpy.LastRequest.BitRate).To(Equal(192)) + }) + + It("transcodes to opus when format=opus is requested (no maxBitRate)", func() { + w := doRawReq("stream", "id", flacTrackID, "format", "opus") + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("opus")) + // Should use the opus default bitrate (128kbps) + Expect(streamerSpy.LastRequest.BitRate).To(Equal(128)) + }) + + It("transcodes to opus with specified maxBitRate", func() { + w := doRawReq("stream", "id", flacTrackID, "format", "opus", "maxBitRate", "192") + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("opus")) + Expect(streamerSpy.LastRequest.BitRate).To(Equal(192)) + }) + + It("transcodes to mp3 with specified maxBitRate", func() { + w := doRawReq("stream", "id", flacTrackID, "format", "mp3", "maxBitRate", "128") + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("mp3")) + Expect(streamerSpy.LastRequest.BitRate).To(Equal(128)) + }) + + It("transcodes MP3 to opus when format=opus is requested", func() { + w := doRawReq("stream", "id", mp3TrackID, "format", "opus") + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("opus")) + }) + + It("transcodes same format when maxBitRate is lower than source", func() { + w := doRawReq("stream", "id", mp3TrackID, "format", "mp3", "maxBitRate", "128") + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("mp3")) + Expect(streamerSpy.LastRequest.BitRate).To(Equal(128)) + }) + }) + + Describe("downsampling with maxBitRate only", func() { + It("transcodes using default downsampling format when maxBitRate < source bitrate", func() { + conf.Server.DefaultDownsamplingFormat = "opus" + w := doRawReq("stream", "id", flacTrackID, "maxBitRate", "192") + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("opus")) + Expect(streamerSpy.LastRequest.BitRate).To(Equal(192)) + }) + + It("streams raw when maxBitRate >= source bitrate (no downsampling needed)", func() { + conf.Server.DefaultDownsamplingFormat = "opus" + w := doRawReq("stream", "id", mp3TrackID, "maxBitRate", "320") + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(BeElementOf("raw", "")) + }) + }) + + Describe("timeOffset", func() { + It("passes timeOffset to the stream request", func() { + w := doRawReq("stream", "id", flacTrackID, "format", "mp3", "timeOffset", "30") + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Offset).To(Equal(30)) + }) + }) + + Describe("stream creation failure", func() { + BeforeEach(func() { + streamerSpy.SimulateError = errors.New("ffmpeg exited with non-zero status code: 1: Unknown encoder 'libopus'") + }) + AfterEach(func() { + streamerSpy.SimulateError = nil + }) + + It("returns a Subsonic error for stream endpoint", func() { + w := doRawReq("stream", "id", flacTrackID, "format", "opus") + Expect(w.Code).To(Equal(http.StatusOK)) // Subsonic errors are returned as 200 + + var wrapper responses.JsonWrapper + Expect(json.Unmarshal(w.Body.Bytes(), &wrapper)).To(Succeed()) + Expect(wrapper.Subsonic.Status).To(Equal(responses.StatusFailed)) + Expect(wrapper.Subsonic.Error).ToNot(BeNil()) + }) + + It("returns a Subsonic error for download endpoint", func() { + conf.Server.EnableDownloads = true + w := doRawReq("download", "id", flacTrackID, "format", "opus") + Expect(w.Code).To(Equal(http.StatusOK)) + + var wrapper responses.JsonWrapper + Expect(json.Unmarshal(w.Body.Bytes(), &wrapper)).To(Succeed()) + Expect(wrapper.Subsonic.Status).To(Equal(responses.StatusFailed)) + Expect(wrapper.Subsonic.Error).ToNot(BeNil()) + }) + }) + + Describe("empty transcoded output", func() { + BeforeEach(func() { + streamerSpy.SimulateEmptyStream = true + }) + AfterEach(func() { + streamerSpy.SimulateEmptyStream = false + }) + + It("returns 200 with empty body for stream endpoint", func() { + w := doRawReq("stream", "id", flacTrackID, "format", "opus") + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(w.Body.Len()).To(Equal(0)) + }) + + It("returns 200 with empty body for download endpoint", func() { + conf.Server.EnableDownloads = true + w := doRawReq("download", "id", flacTrackID, "format", "opus") + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(w.Body.Len()).To(Equal(0)) + }) + }) +}) diff --git a/server/e2e/subsonic_system_test.go b/server/e2e/subsonic_system_test.go new file mode 100644 index 000000000..16078f702 --- /dev/null +++ b/server/e2e/subsonic_system_test.go @@ -0,0 +1,74 @@ +package e2e + +import ( + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("System Endpoints", func() { + BeforeEach(func() { + setupTestDB() + }) + + Describe("ping", func() { + It("returns a successful response", func() { + resp := doReq("ping") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + }) + + Describe("getLicense", func() { + It("returns a valid license", func() { + resp := doReq("getLicense") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.License).ToNot(BeNil()) + Expect(resp.License.Valid).To(BeTrue()) + }) + }) + + Describe("getOpenSubsonicExtensions", func() { + It("returns a list of supported extensions", func() { + resp := doReq("getOpenSubsonicExtensions") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.OpenSubsonicExtensions).ToNot(BeNil()) + Expect(*resp.OpenSubsonicExtensions).ToNot(BeEmpty()) + }) + + It("includes the transcodeOffset extension", func() { + resp := doReq("getOpenSubsonicExtensions") + + extensions := *resp.OpenSubsonicExtensions + var names []string + for _, ext := range extensions { + names = append(names, ext.Name) + } + Expect(names).To(ContainElement("transcodeOffset")) + }) + + It("includes the formPost extension", func() { + resp := doReq("getOpenSubsonicExtensions") + + extensions := *resp.OpenSubsonicExtensions + var names []string + for _, ext := range extensions { + names = append(names, ext.Name) + } + Expect(names).To(ContainElement("formPost")) + }) + + It("includes the songLyrics extension", func() { + resp := doReq("getOpenSubsonicExtensions") + + extensions := *resp.OpenSubsonicExtensions + var names []string + for _, ext := range extensions { + names = append(names, ext.Name) + } + Expect(names).To(ContainElement("songLyrics")) + }) + }) +}) diff --git a/server/e2e/subsonic_transcode_test.go b/server/e2e/subsonic_transcode_test.go new file mode 100644 index 000000000..f134448df --- /dev/null +++ b/server/e2e/subsonic_transcode_test.go @@ -0,0 +1,683 @@ +package e2e + +import ( + "errors" + "net/http" + "time" + + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +// Client profile JSON bodies for getTranscodeDecision requests. +// All bitrate values are in bps (per OpenSubsonic spec). +const ( + // mp3OnlyClient can direct-play mp3 and transcode to mp3 + mp3OnlyClient = `{ + "name": "test-mp3-only", + "directPlayProfiles": [ + {"containers": ["mp3"], "audioCodecs": ["mp3"], "protocols": ["http"]} + ], + "transcodingProfiles": [ + {"container": "mp3", "audioCodec": "mp3", "protocol": "http"} + ] + }` + + // flacAndMp3Client can direct-play flac and mp3, transcode to mp3 + flacAndMp3Client = `{ + "name": "test-flac-mp3", + "directPlayProfiles": [ + {"containers": ["flac"], "audioCodecs": ["flac"], "protocols": ["http"]}, + {"containers": ["mp3"], "audioCodecs": ["mp3"], "protocols": ["http"]} + ], + "transcodingProfiles": [ + {"container": "mp3", "audioCodec": "mp3", "protocol": "http"} + ] + }` + + // universalClient can direct-play most formats + universalClient = `{ + "name": "test-universal", + "directPlayProfiles": [ + {"containers": ["mp3"], "audioCodecs": ["mp3"], "protocols": ["http"]}, + {"containers": ["flac"], "audioCodecs": ["flac"], "protocols": ["http"]}, + {"containers": ["m4a"], "audioCodecs": ["alac", "aac"], "protocols": ["http"]}, + {"containers": ["opus", "ogg"], "audioCodecs": ["opus"], "protocols": ["http"]}, + {"containers": ["wav"], "audioCodecs": ["pcm"], "protocols": ["http"]}, + {"containers": ["dsf"], "audioCodecs": ["dsd"], "protocols": ["http"]} + ], + "transcodingProfiles": [ + {"container": "mp3", "audioCodec": "mp3", "protocol": "http"} + ] + }` + + // bitrateCapClient has maxAudioBitrate set to 320000 bps (320 kbps) + bitrateCapClient = `{ + "name": "test-bitrate-cap", + "maxAudioBitrate": 320000, + "directPlayProfiles": [ + {"containers": ["mp3"], "audioCodecs": ["mp3"], "protocols": ["http"]}, + {"containers": ["flac"], "audioCodecs": ["flac"], "protocols": ["http"]} + ], + "transcodingProfiles": [ + {"container": "mp3", "audioCodec": "mp3", "protocol": "http"} + ] + }` + + // opusTranscodeClient can direct-play mp3, transcode to opus + opusTranscodeClient = `{ + "name": "test-opus-transcode", + "directPlayProfiles": [ + {"containers": ["mp3"], "audioCodecs": ["mp3"], "protocols": ["http"]} + ], + "transcodingProfiles": [ + {"container": "opus", "audioCodec": "opus", "protocol": "http"} + ] + }` + + // flacOnlyClient can direct-play flac, transcode to flac (no mp3 support at all) + flacOnlyClient = `{ + "name": "test-flac-only", + "directPlayProfiles": [ + {"containers": ["flac"], "audioCodecs": ["flac"], "protocols": ["http"]} + ], + "transcodingProfiles": [ + {"container": "flac", "audioCodec": "flac", "protocol": "http"} + ] + }` + + // maxTranscodeBitrateClient has maxTranscodingAudioBitrate set + maxTranscodeBitrateClient = `{ + "name": "test-max-transcode-bitrate", + "maxTranscodingAudioBitrate": 192000, + "directPlayProfiles": [ + {"containers": ["mp3"], "audioCodecs": ["mp3"], "protocols": ["http"]} + ], + "transcodingProfiles": [ + {"container": "mp3", "audioCodec": "mp3", "protocol": "http"} + ] + }` + + // dsdToFlacClient can direct-play mp3, transcode to flac + dsdToFlacClient = `{ + "name": "test-dsd-to-flac", + "directPlayProfiles": [ + {"containers": ["mp3"], "audioCodecs": ["mp3"], "protocols": ["http"]} + ], + "transcodingProfiles": [ + {"container": "flac", "audioCodec": "flac", "protocol": "http"} + ] + }` +) + +var _ = Describe("Transcode Endpoints", Ordered, func() { + // Track IDs resolved in BeforeAll + var ( + mp3TrackID string // Come Together (mp3, 320kbps) + flacTrackID string // TC FLAC Standard (flac, 900kbps) + flacHiResTrackID string // TC FLAC HiRes (flac, 3000kbps) + alacTrackID string // TC ALAC Track (m4a, alac) + dsdTrackID string // TC DSD Track (dsf, dsd) + opusTrackID string // TC Opus Track (opus, 128kbps) + mkaOpusTrackID string // TC MKA Opus (mka, opus via codec tag) + ) + + BeforeAll(func() { + setupTestDB() + + songs, err := ds.MediaFile(ctx).GetAll() + Expect(err).ToNot(HaveOccurred()) + byTitle := map[string]string{} + for _, s := range songs { + byTitle[s.Title] = s.ID + } + ensureGetTrackID := func(title string) string { + id := byTitle[title] + Expect(id).ToNot(BeEmpty()) + return id + } + mp3TrackID = ensureGetTrackID("Come Together") + flacTrackID = ensureGetTrackID("TC FLAC Standard") + flacHiResTrackID = ensureGetTrackID("TC FLAC HiRes") + alacTrackID = ensureGetTrackID("TC ALAC Track") + dsdTrackID = ensureGetTrackID("TC DSD Track") + opusTrackID = ensureGetTrackID("TC Opus Track") + mkaOpusTrackID = ensureGetTrackID("TC MKA Opus") + }) + + Describe("getTranscodeDecision", func() { + // setPlayerMaxBitRate ensures a player exists for the test-client and sets its MaxBitRate. + // It makes a dummy request to register the player, then updates it via the repository. + setPlayerMaxBitRate := func(maxBitRate int) { + doReq("ping") + player, err := ds.Player(ctx).FindMatch(adminUser.ID, "test-client", "") + Expect(err).ToNot(HaveOccurred()) + player.MaxBitRate = maxBitRate + Expect(ds.Player(ctx).Put(player)).To(Succeed()) + } + + AfterEach(func() { + // Reset player MaxBitRate to 0 after each test + player, err := ds.Player(ctx).FindMatch(adminUser.ID, "test-client", "") + if err == nil { + player.MaxBitRate = 0 + _ = ds.Player(ctx).Put(player) + } + }) + + Describe("error cases", func() { + It("returns 405 for GET request", func() { + w := doRawReq("getTranscodeDecision", "mediaId", mp3TrackID, "mediaType", "song") + Expect(w.Code).To(Equal(http.StatusMethodNotAllowed)) + }) + + It("returns error when mediaId is missing", func() { + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + Expect(resp.Error.Code).To(Equal(responses.ErrorMissingParameter)) + }) + + It("returns error when mediaType is missing", func() { + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaId", mp3TrackID) + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + Expect(resp.Error.Code).To(Equal(responses.ErrorMissingParameter)) + }) + + It("returns error for unsupported mediaType", func() { + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaId", mp3TrackID, "mediaType", "video") + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + Expect(resp.Error.Code).To(Equal(responses.ErrorGeneric)) + }) + + It("returns error for invalid JSON body", func() { + resp := doPostReq("getTranscodeDecision", "{invalid-json", "mediaId", mp3TrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("returns error for empty JSON body", func() { + w := doRawPostReq("getTranscodeDecision", "", "mediaId", mp3TrackID, "mediaType", "song") + Expect(w.Code).To(Equal(http.StatusOK)) // Subsonic errors are returned as 200 with error status + resp := parseJSONResponse(w) + Expect(resp.Status).To(Equal(responses.StatusFailed)) + }) + + It("returns error for non-existent media ID", func() { + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaId", "non-existent-id", "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + Expect(resp.Error.Code).To(Equal(responses.ErrorDataNotFound)) + }) + + It("returns error for invalid protocol in body", func() { + invalidBody := `{ + "directPlayProfiles": [ + {"containers": ["mp3"], "audioCodecs": ["mp3"], "protocols": ["invalid-protocol"]} + ] + }` + resp := doPostReq("getTranscodeDecision", invalidBody, "mediaId", mp3TrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("returns error for invalid comparison operator in body", func() { + invalidBody := `{ + "directPlayProfiles": [ + {"containers": ["mp3"], "audioCodecs": ["mp3"], "protocols": ["http"]} + ], + "codecProfiles": [{ + "type": "AudioCodec", "name": "mp3", + "limitations": [{"name": "audioBitrate", "comparison": "InvalidOp", "values": ["320000"]}] + }] + }` + resp := doPostReq("getTranscodeDecision", invalidBody, "mediaId", mp3TrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + }) + + Describe("direct play decisions", func() { + It("allows MP3 direct play when client supports mp3", func() { + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaId", mp3TrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanDirectPlay).To(BeTrue()) + Expect(resp.TranscodeDecision.TranscodeStream).To(BeNil()) + Expect(resp.TranscodeDecision.TranscodeParams).ToNot(BeEmpty()) + }) + + It("allows FLAC direct play when client supports flac", func() { + resp := doPostReq("getTranscodeDecision", flacAndMp3Client, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanDirectPlay).To(BeTrue()) + }) + + It("allows ALAC direct play via m4a container + alac codec matching", func() { + resp := doPostReq("getTranscodeDecision", universalClient, "mediaId", alacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanDirectPlay).To(BeTrue()) + }) + + It("allows Opus direct play when client supports opus", func() { + resp := doPostReq("getTranscodeDecision", universalClient, "mediaId", opusTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanDirectPlay).To(BeTrue()) + }) + + It("denies direct play when container mismatches", func() { + // mp3OnlyClient cannot play FLAC container + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanDirectPlay).To(BeFalse()) + }) + + It("denies direct play when codec mismatches", func() { + // MKA container with opus codec — client only supports mp3 + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaId", mkaOpusTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanDirectPlay).To(BeFalse()) + }) + + It("denies direct play when maxAudioBitrate exceeded", func() { + // bitrateCapClient caps at 320kbps, FLAC is 900kbps + resp := doPostReq("getTranscodeDecision", bitrateCapClient, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanDirectPlay).To(BeFalse()) + }) + }) + + Describe("transcode decisions", func() { + It("transcodes FLAC to MP3 when client only supports MP3", func() { + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanDirectPlay).To(BeFalse()) + Expect(resp.TranscodeDecision.CanTranscode).To(BeTrue()) + Expect(resp.TranscodeDecision.TranscodeStream).ToNot(BeNil()) + Expect(resp.TranscodeDecision.TranscodeStream.Container).To(Equal("mp3")) + Expect(resp.TranscodeDecision.TranscodeStream.Codec).To(Equal("mp3")) + Expect(resp.TranscodeDecision.TranscodeParams).ToNot(BeEmpty()) + }) + + It("transcodes FLAC hi-res to Opus with correct sample rate", func() { + resp := doPostReq("getTranscodeDecision", opusTranscodeClient, "mediaId", flacHiResTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanTranscode).To(BeTrue()) + Expect(resp.TranscodeDecision.TranscodeStream).ToNot(BeNil()) + Expect(resp.TranscodeDecision.TranscodeStream.Codec).To(Equal("opus")) + // Opus always outputs 48000 Hz + Expect(resp.TranscodeDecision.TranscodeStream.AudioSamplerate).To(Equal(int32(48000))) + }) + + It("transcodes DSD to FLAC with normalized sample rate and bit depth", func() { + resp := doPostReq("getTranscodeDecision", dsdToFlacClient, "mediaId", dsdTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanTranscode).To(BeTrue()) + Expect(resp.TranscodeDecision.TranscodeStream).ToNot(BeNil()) + Expect(resp.TranscodeDecision.TranscodeStream.Codec).To(Equal("flac")) + // DSD sample rate normalized: 2822400 / 8 = 352800 + Expect(resp.TranscodeDecision.TranscodeStream.AudioSamplerate).To(Equal(int32(352800))) + // DSD 1-bit → 24-bit PCM + Expect(resp.TranscodeDecision.TranscodeStream.AudioBitdepth).To(Equal(int32(24))) + }) + + It("refuses lossy to lossless transcoding: MP3 to FLAC", func() { + // flacOnlyClient can't direct-play mp3, and lossy→lossless transcode is rejected + resp := doPostReq("getTranscodeDecision", flacOnlyClient, "mediaId", mp3TrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + // MP3 is lossy, FLAC is lossless — should not allow transcoding + Expect(resp.TranscodeDecision.CanTranscode).To(BeFalse()) + Expect(resp.TranscodeDecision.CanDirectPlay).To(BeFalse()) + Expect(resp.TranscodeDecision.TranscodeParams).To(BeEmpty()) + }) + + It("caps transcode bitrate via maxTranscodingAudioBitrate", func() { + resp := doPostReq("getTranscodeDecision", maxTranscodeBitrateClient, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanTranscode).To(BeTrue()) + Expect(resp.TranscodeDecision.TranscodeStream).ToNot(BeNil()) + // maxTranscodingAudioBitrate is 192000 bps = 192 kbps → response in bps + Expect(resp.TranscodeDecision.TranscodeStream.AudioBitrate).To(Equal(int32(192000))) + }) + }) + + Describe("response structure", func() { + It("has correct sourceStream details", func() { + resp := doPostReq("getTranscodeDecision", universalClient, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + src := resp.TranscodeDecision.SourceStream + Expect(src).ToNot(BeNil()) + Expect(src.Container).To(Equal("flac")) + Expect(src.Codec).To(Equal("flac")) + // AudioBitrate is in bps: 900 kbps * 1000 = 900000 bps + Expect(src.AudioBitrate).To(Equal(int32(900000))) + Expect(src.AudioSamplerate).To(Equal(int32(44100))) + Expect(src.AudioChannels).To(Equal(int32(2))) + Expect(src.Protocol).To(Equal("http")) + }) + + It("reports audioBitrate in bps (kbps * 1000)", func() { + resp := doPostReq("getTranscodeDecision", universalClient, "mediaId", mp3TrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + src := resp.TranscodeDecision.SourceStream + Expect(src).ToNot(BeNil()) + // MP3 is 320 kbps → 320000 bps + Expect(src.AudioBitrate).To(Equal(int32(320000))) + }) + }) + + Describe("player MaxBitRate cap", func() { + It("forces transcode when source bitrate exceeds player MaxBitRate", func() { + setPlayerMaxBitRate(320) // 320 kbps cap + + // FLAC is 900kbps, client has no bitrate limit but player cap is 320 + resp := doPostReq("getTranscodeDecision", flacAndMp3Client, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanDirectPlay).To(BeFalse()) + Expect(resp.TranscodeDecision.CanTranscode).To(BeTrue()) + Expect(resp.TranscodeDecision.TranscodeStream).ToNot(BeNil()) + Expect(resp.TranscodeDecision.TranscodeStream.Container).To(Equal("mp3")) + // Target bitrate should be capped at player's 320kbps = 320000 bps + Expect(resp.TranscodeDecision.TranscodeStream.AudioBitrate).To(Equal(int32(320000))) + }) + + It("does not affect direct play when source bitrate is under player MaxBitRate", func() { + setPlayerMaxBitRate(500) // 500 kbps cap + + // MP3 is 320kbps, under the 500kbps player cap → direct play + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaId", mp3TrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanDirectPlay).To(BeTrue()) + }) + + It("uses client limit when more restrictive than player MaxBitRate", func() { + setPlayerMaxBitRate(500) // 500 kbps player cap + + // Client caps at 320kbps (bitrateCapClient), which is more restrictive than 500 + // FLAC is 900kbps → exceeds both limits → transcode + resp := doPostReq("getTranscodeDecision", bitrateCapClient, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanTranscode).To(BeTrue()) + Expect(resp.TranscodeDecision.TranscodeStream).ToNot(BeNil()) + // Client limit (320kbps) is more restrictive → 320000 bps + Expect(resp.TranscodeDecision.TranscodeStream.AudioBitrate).To(Equal(int32(320000))) + }) + + It("uses player MaxBitRate when more restrictive than client limit", func() { + setPlayerMaxBitRate(192) // 192 kbps player cap + + // Client caps at 320kbps (bitrateCapClient), player is more restrictive at 192 + // FLAC is 900kbps → transcode at 192kbps + resp := doPostReq("getTranscodeDecision", bitrateCapClient, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanTranscode).To(BeTrue()) + Expect(resp.TranscodeDecision.TranscodeStream).ToNot(BeNil()) + // Player limit (192kbps) is more restrictive → 192000 bps + Expect(resp.TranscodeDecision.TranscodeStream.AudioBitrate).To(Equal(int32(192000))) + }) + + It("has no effect when player MaxBitRate is 0", func() { + setPlayerMaxBitRate(0) // No player cap + + // FLAC with flac+mp3 client → direct play (no bitrate constraint) + resp := doPostReq("getTranscodeDecision", flacAndMp3Client, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanDirectPlay).To(BeTrue()) + }) + }) + + Describe("format-aware default bitrate", func() { + It("uses mp3 format default (192kbps) for lossless-to-mp3 with no bitrate limits", func() { + // mp3OnlyClient has no maxAudioBitrate or maxTranscodingAudioBitrate + // FLAC → MP3 should use the mp3 default bitrate (192kbps), not hardcoded 256 + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanTranscode).To(BeTrue()) + Expect(resp.TranscodeDecision.TranscodeStream).ToNot(BeNil()) + Expect(resp.TranscodeDecision.TranscodeStream.Container).To(Equal("mp3")) + // mp3 default is 192kbps = 192000 bps + Expect(resp.TranscodeDecision.TranscodeStream.AudioBitrate).To(Equal(int32(192000))) + }) + + It("uses opus format default (128kbps) for lossless-to-opus with no bitrate limits", func() { + // opusTranscodeClient has no maxAudioBitrate or maxTranscodingAudioBitrate + // FLAC → Opus should use the opus default bitrate (128kbps) + resp := doPostReq("getTranscodeDecision", opusTranscodeClient, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanTranscode).To(BeTrue()) + Expect(resp.TranscodeDecision.TranscodeStream).ToNot(BeNil()) + Expect(resp.TranscodeDecision.TranscodeStream.Codec).To(Equal("opus")) + // opus default is 128kbps = 128000 bps + Expect(resp.TranscodeDecision.TranscodeStream.AudioBitrate).To(Equal(int32(128000))) + }) + + It("uses maxAudioBitrate as fallback for lossless-to-lossy when no maxTranscodingAudioBitrate", func() { + // bitrateCapClient has maxAudioBitrate=320000 but no maxTranscodingAudioBitrate + // FLAC → MP3: maxAudioBitrate (320kbps) should be used as the target + resp := doPostReq("getTranscodeDecision", bitrateCapClient, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanTranscode).To(BeTrue()) + Expect(resp.TranscodeDecision.TranscodeStream).ToNot(BeNil()) + // maxAudioBitrate is 320kbps = 320000 bps + Expect(resp.TranscodeDecision.TranscodeStream.AudioBitrate).To(Equal(int32(320000))) + }) + + It("prefers maxTranscodingAudioBitrate over maxAudioBitrate for lossless-to-lossy", func() { + // maxTranscodeBitrateClient has maxTranscodingAudioBitrate=192000 + // FLAC → MP3: should use 192kbps, not format default or maxAudioBitrate + resp := doPostReq("getTranscodeDecision", maxTranscodeBitrateClient, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanTranscode).To(BeTrue()) + Expect(resp.TranscodeDecision.TranscodeStream).ToNot(BeNil()) + // maxTranscodingAudioBitrate is 192kbps = 192000 bps + Expect(resp.TranscodeDecision.TranscodeStream.AudioBitrate).To(Equal(int32(192000))) + }) + }) + + Describe("player MaxBitRate + client limits combined", func() { + It("player MaxBitRate injects maxAudioBitrate, format default used for transcode target", func() { + setPlayerMaxBitRate(320) + + // opusTranscodeClient has no client bitrate limits + // Player cap injects maxAudioBitrate=320 + // FLAC (900kbps) → exceeds 320 → transcode to opus + // Lossless→lossy: maxTranscodingAudioBitrate=0, so falls back to maxAudioBitrate=320 + resp := doPostReq("getTranscodeDecision", opusTranscodeClient, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanTranscode).To(BeTrue()) + Expect(resp.TranscodeDecision.TranscodeStream).ToNot(BeNil()) + Expect(resp.TranscodeDecision.TranscodeStream.Codec).To(Equal("opus")) + // maxAudioBitrate=320 used as fallback → 320000 bps + Expect(resp.TranscodeDecision.TranscodeStream.AudioBitrate).To(Equal(int32(320000))) + }) + + It("player MaxBitRate + client maxTranscodingAudioBitrate work together", func() { + setPlayerMaxBitRate(320) + + // maxTranscodeBitrateClient: maxTranscodingAudioBitrate=192000 (192kbps), no maxAudioBitrate + // Player cap injects maxAudioBitrate=320 + // FLAC (900kbps) → exceeds 320 → transcode to mp3 + // Lossless→lossy: maxTranscodingAudioBitrate=192 takes priority + resp := doPostReq("getTranscodeDecision", maxTranscodeBitrateClient, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanTranscode).To(BeTrue()) + Expect(resp.TranscodeDecision.TranscodeStream).ToNot(BeNil()) + // maxTranscodingAudioBitrate=192 is preferred → 192000 bps + Expect(resp.TranscodeDecision.TranscodeStream.AudioBitrate).To(Equal(int32(192000))) + }) + + It("streams with correct bitrate after player MaxBitRate-triggered transcode", func() { + setPlayerMaxBitRate(128) + + // Get decision: FLAC (900kbps) with player cap 128 → transcode + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision.CanTranscode).To(BeTrue()) + token := resp.TranscodeDecision.TranscodeParams + Expect(token).ToNot(BeEmpty()) + + // Stream using the token + w := doRawReq("getTranscodeStream", "mediaId", flacTrackID, "mediaType", "song", "transcodeParams", token) + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("mp3")) + Expect(streamerSpy.LastRequest.BitRate).To(Equal(128)) + }) + }) + }) + + Describe("getTranscodeStream", func() { + Describe("error cases", func() { + It("returns 400 when mediaId is missing", func() { + w := doRawReq("getTranscodeStream", "mediaType", "song", "transcodeParams", "some-token") + Expect(w.Code).To(Equal(http.StatusBadRequest)) + }) + + It("returns 400 when mediaType is missing", func() { + w := doRawReq("getTranscodeStream", "mediaId", mp3TrackID, "transcodeParams", "some-token") + Expect(w.Code).To(Equal(http.StatusBadRequest)) + }) + + It("returns 400 when transcodeParams is missing", func() { + w := doRawReq("getTranscodeStream", "mediaId", mp3TrackID, "mediaType", "song") + Expect(w.Code).To(Equal(http.StatusBadRequest)) + }) + + It("returns 400 for unsupported mediaType", func() { + w := doRawReq("getTranscodeStream", "mediaId", mp3TrackID, "mediaType", "video", "transcodeParams", "some-token") + Expect(w.Code).To(Equal(http.StatusBadRequest)) + }) + + It("returns 410 for malformed token", func() { + w := doRawReq("getTranscodeStream", "mediaId", mp3TrackID, "mediaType", "song", "transcodeParams", "invalid-token") + Expect(w.Code).To(Equal(http.StatusGone)) + }) + + It("returns 410 for stale token (media file updated after token issued)", func() { + // Get a valid decision token + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaId", mp3TrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + token := resp.TranscodeDecision.TranscodeParams + Expect(token).ToNot(BeEmpty()) + + // Save original UpdatedAt and restore after test + mf, err := ds.MediaFile(ctx).Get(mp3TrackID) + Expect(err).ToNot(HaveOccurred()) + originalUpdatedAt := mf.UpdatedAt + + // Update the media file's UpdatedAt to simulate a change after token issuance + mf.UpdatedAt = time.Now().Add(time.Hour) + Expect(ds.MediaFile(ctx).Put(mf)).To(Succeed()) + + // Attempt to stream with the now-stale token + w := doRawReq("getTranscodeStream", "mediaId", mp3TrackID, "mediaType", "song", "transcodeParams", token) + Expect(w.Code).To(Equal(http.StatusGone)) + + // Restore original UpdatedAt + mf.UpdatedAt = originalUpdatedAt + Expect(ds.MediaFile(ctx).Put(mf)).To(Succeed()) + }) + + It("returns 500 when stream creation fails", func() { + // Get a valid decision token + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + token := resp.TranscodeDecision.TranscodeParams + Expect(token).ToNot(BeEmpty()) + + // Simulate streamer failure (e.g., ffmpeg missing codec) + streamerSpy.SimulateError = errors.New("ffmpeg exited with non-zero status code: 1: Unknown encoder 'libopus'") + defer func() { streamerSpy.SimulateError = nil }() + + w := doRawReq("getTranscodeStream", "mediaId", flacTrackID, "mediaType", "song", "transcodeParams", token) + Expect(w.Code).To(Equal(http.StatusInternalServerError)) + }) + + It("returns 500 when transcoded stream is empty", func() { + // Get a valid decision token + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + token := resp.TranscodeDecision.TranscodeParams + Expect(token).ToNot(BeEmpty()) + + // Simulate ffmpeg producing 0 bytes + streamerSpy.SimulateEmptyStream = true + defer func() { streamerSpy.SimulateEmptyStream = false }() + + w := doRawReq("getTranscodeStream", "mediaId", flacTrackID, "mediaType", "song", "transcodeParams", token) + Expect(w.Code).To(Equal(http.StatusInternalServerError)) + }) + }) + + Describe("round-trip: decision then stream", func() { + It("streams direct play for MP3", func() { + // Get decision + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaId", mp3TrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision.CanDirectPlay).To(BeTrue()) + token := resp.TranscodeDecision.TranscodeParams + Expect(token).ToNot(BeEmpty()) + + // Stream using the token + w := doRawReq("getTranscodeStream", "mediaId", mp3TrackID, "mediaType", "song", "transcodeParams", token) + Expect(w.Code).To(Equal(http.StatusOK)) + // Direct play: format should be "raw" or empty + Expect(streamerSpy.LastRequest.Format).To(BeElementOf("raw", "")) + }) + + It("streams transcoded FLAC to MP3", func() { + // Get decision + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision.CanTranscode).To(BeTrue()) + token := resp.TranscodeDecision.TranscodeParams + Expect(token).ToNot(BeEmpty()) + + // Stream using the token + w := doRawReq("getTranscodeStream", "mediaId", flacTrackID, "mediaType", "song", "transcodeParams", token) + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("mp3")) + }) + + It("passes offset through to stream request", func() { + // Get decision + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaId", mp3TrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + token := resp.TranscodeDecision.TranscodeParams + Expect(token).ToNot(BeEmpty()) + + // Stream with offset + w := doRawReq("getTranscodeStream", "mediaId", mp3TrackID, "mediaType", "song", + "transcodeParams", token, "offset", "30") + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Offset).To(Equal(30)) + }) + }) + }) +}) diff --git a/server/e2e/subsonic_users_test.go b/server/e2e/subsonic_users_test.go new file mode 100644 index 000000000..849089f11 --- /dev/null +++ b/server/e2e/subsonic_users_test.go @@ -0,0 +1,49 @@ +package e2e + +import ( + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("User Endpoints", func() { + BeforeEach(func() { + setupTestDB() + }) + + It("getUser returns current user info", func() { + resp := doReq("getUser", "username", adminUser.UserName) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.User).ToNot(BeNil()) + Expect(resp.User.Username).To(Equal(adminUser.UserName)) + Expect(resp.User.AdminRole).To(BeTrue()) + Expect(resp.User.StreamRole).To(BeTrue()) + Expect(resp.User.Folder).ToNot(BeEmpty()) + }) + + It("getUser with matching username case-insensitive succeeds", func() { + resp := doReq("getUser", "username", "Admin") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.User).ToNot(BeNil()) + Expect(resp.User.Username).To(Equal(adminUser.UserName)) + }) + + It("getUser with different username returns authorization error", func() { + resp := doReq("getUser", "username", "otheruser") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("getUsers returns list with current user only", func() { + resp := doReq("getUsers") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Users).ToNot(BeNil()) + Expect(resp.Users.User).To(HaveLen(1)) + Expect(resp.Users.User[0].Username).To(Equal(adminUser.UserName)) + Expect(resp.Users.User[0].AdminRole).To(BeTrue()) + }) +}) diff --git a/server/events/sse.go b/server/events/sse.go index 54a602985..565d8c016 100644 --- a/server/events/sse.go +++ b/server/events/sse.go @@ -24,8 +24,9 @@ type Broker interface { const ( keepAliveFrequency = 15 * time.Second - writeTimeOut = 5 * time.Second - bufferSize = 1 + // The timeout must be higher than the keepAliveFrequency, or the lack of activity will cause the channel to close. + writeTimeOut = keepAliveFrequency + 5*time.Second + bufferSize = 1 ) type ( @@ -104,7 +105,7 @@ func writeEvent(ctx context.Context, w io.Writer, event message, timeout time.Du log.Debug(ctx, "Error setting write timeout", err) } - _, err := fmt.Fprintf(w, "id: %d\nevent: %s\ndata: %s\n\n", event.id, event.event, event.data) + _, err := fmt.Fprintf(w, "id: %d\nevent: %s\ndata: %s\n\n", event.id, event.event, event.data) //nolint:gosec if err != nil { return err } diff --git a/server/initial_setup.go b/server/initial_setup.go index ebfdad47a..d50f25958 100644 --- a/server/initial_setup.go +++ b/server/initial_setup.go @@ -91,11 +91,5 @@ func checkExternalCredentials() { } else { log.Debug("ListenBrainz integration is ENABLED", "ListenBrainz.BaseURL", conf.Server.ListenBrainz.BaseURL) } - - if conf.Server.Spotify.ID == "" || conf.Server.Spotify.Secret == "" { - log.Info("Spotify integration is not enabled: missing ID/Secret") - } else { - log.Debug("Spotify integration is ENABLED") - } } } diff --git a/server/middlewares.go b/server/middlewares.go index 2afe09a5a..5d6a1e59c 100644 --- a/server/middlewares.go +++ b/server/middlewares.go @@ -37,7 +37,7 @@ func requestLogger(next http.Handler) http.Handler { status := ww.Status() message := fmt.Sprintf("HTTP: %s %s://%s%s", r.Method, scheme, r.Host, r.RequestURI) - logArgs := []interface{}{ + logArgs := []any{ r.Context(), message, "remoteAddr", r.RemoteAddr, @@ -107,7 +107,7 @@ func secureMiddleware() func(http.Handler) http.Handler { FrameDeny: true, ReferrerPolicy: "same-origin", PermissionsPolicy: "autoplay=(), camera=(), microphone=(), usb=()", - CustomFrameOptionsValue: conf.Server.HTTPSecurityHeaders.CustomFrameOptionsValue, + CustomFrameOptionsValue: conf.Server.HTTPHeaders.FrameOptions, //ContentSecurityPolicy: "script-src 'self' 'unsafe-inline'", }) return sec.Handler @@ -168,7 +168,7 @@ func clientUniqueIDMiddleware(next http.Handler) http.Handler { // realIPMiddleware applies middleware.RealIP, and additionally saves the request's original RemoteAddr to the request's // context if navidrome is behind a trusted reverse proxy. func realIPMiddleware(next http.Handler) http.Handler { - if conf.Server.ReverseProxyWhitelist != "" { + if conf.Server.ExtAuth.TrustedSources != "" { return chi.Chain( reqToCtx(request.ReverseProxyIp, func(r *http.Request) any { return r.RemoteAddr }), middleware.RealIP, diff --git a/server/nativeapi/artists.go b/server/nativeapi/artists.go new file mode 100644 index 000000000..1b78bb93e --- /dev/null +++ b/server/nativeapi/artists.go @@ -0,0 +1,72 @@ +package nativeapi + +import ( + "context" + "errors" + "io" + "net/http" + "time" + + "github.com/deluan/rest" + "github.com/go-chi/chi/v5" + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/server" +) + +func (api *Router) addArtistRoute(r chi.Router) { + constructor := func(ctx context.Context) rest.Repository { + return api.ds.Resource(ctx, model.Artist{}) + } + r.Route("/artist", func(r chi.Router) { + r.Get("/", rest.GetAll(constructor)) + r.Route("/{id}", func(r chi.Router) { + r.Use(server.URLParamsMiddleware) + r.Get("/", rest.Get(constructor)) + r.Post("/image", api.uploadArtistImage()) + r.Delete("/image", api.deleteArtistImage()) + }) + }) +} + +func (api *Router) uploadArtistImage() http.HandlerFunc { + return handleImageUpload(func(ctx context.Context, reader io.Reader, ext string) error { + artistID := chi.URLParamFromCtx(ctx, "id") + ar, err := api.ds.Artist(ctx).Get(artistID) + if err != nil { + if errors.Is(err, model.ErrNotFound) { + return model.ErrNotFound + } + return err + } + oldPath := ar.UploadedImagePath() + filename, err := api.imgUpload.SetImage(ctx, consts.EntityArtist, ar.ID, ar.Name, oldPath, reader, ext) + if err != nil { + return err + } + ar.UploadedImage = filename + now := time.Now() + ar.UpdatedAt = &now + return api.ds.Artist(ctx).Put(ar, "uploaded_image", "updated_at") + }) +} + +func (api *Router) deleteArtistImage() http.HandlerFunc { + return handleImageDelete(func(ctx context.Context) error { + artistID := chi.URLParamFromCtx(ctx, "id") + ar, err := api.ds.Artist(ctx).Get(artistID) + if err != nil { + if errors.Is(err, model.ErrNotFound) { + return model.ErrNotFound + } + return err + } + if err := api.imgUpload.RemoveImage(ctx, ar.UploadedImagePath()); err != nil { + return err + } + ar.UploadedImage = "" + now := time.Now() + ar.UpdatedAt = &now + return api.ds.Artist(ctx).Put(ar, "uploaded_image", "updated_at") + }) +} diff --git a/server/nativeapi/config.go b/server/nativeapi/config.go index 9a86a9add..02626a4ee 100644 --- a/server/nativeapi/config.go +++ b/server/nativeapi/config.go @@ -5,6 +5,7 @@ import ( "encoding/json" "fmt" "net/http" + "slices" "strings" "github.com/navidrome/navidrome/conf" @@ -15,13 +16,11 @@ import ( // using partial masking (first and last character visible, middle replaced with *). // For values with 7+ characters: "secretvalue123" becomes "s***********3" // For values with <7 characters: "short" becomes "****" -// Add field paths using dot notation (e.g., "LastFM.ApiKey", "Spotify.Secret") +// Add field paths using dot notation (e.g., "LastFM.ApiKey") var sensitiveFieldsPartialMask = []string{ "LastFM.ApiKey", "LastFM.Secret", "Prometheus.MetricsPath", - "Spotify.ID", - "Spotify.Secret", "DevAutoLoginUsername", } @@ -35,9 +34,9 @@ var sensitiveFieldsFullMask = []string{ } type configResponse struct { - ID string `json:"id"` - ConfigFile string `json:"configFile"` - Config map[string]interface{} `json:"config"` + ID string `json:"id"` + ConfigFile string `json:"configFile"` + Config map[string]any `json:"config"` } func redactValue(key string, value string) string { @@ -47,10 +46,8 @@ func redactValue(key string, value string) string { } // Check if this field should be fully masked - for _, field := range sensitiveFieldsFullMask { - if field == key { - return "****" - } + if slices.Contains(sensitiveFieldsFullMask, key) { + return "****" } // Check if this field should be partially masked @@ -69,7 +66,7 @@ func redactValue(key string, value string) string { } // applySensitiveFieldMasking recursively applies masking to sensitive fields in the configuration map -func applySensitiveFieldMasking(ctx context.Context, config map[string]interface{}, prefix string) { +func applySensitiveFieldMasking(ctx context.Context, config map[string]any, prefix string) { for key, value := range config { fullKey := key if prefix != "" { @@ -77,7 +74,7 @@ func applySensitiveFieldMasking(ctx context.Context, config map[string]interface } switch v := value.(type) { - case map[string]interface{}: + case map[string]any: // Recursively process nested maps applySensitiveFieldMasking(ctx, v, fullKey) case string: @@ -108,7 +105,7 @@ func getConfig(w http.ResponseWriter, r *http.Request) { } // Unmarshal back to map to get the structure with proper field names - var configMap map[string]interface{} + var configMap map[string]any err = json.Unmarshal(configBytes, &configMap) if err != nil { log.Error(ctx, "Error unmarshaling config to map", err) diff --git a/server/nativeapi/config_test.go b/server/nativeapi/config_test.go index 60f7c3394..4e6e9e89b 100644 --- a/server/nativeapi/config_test.go +++ b/server/nativeapi/config_test.go @@ -10,7 +10,6 @@ import ( "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/conf/configtest" "github.com/navidrome/navidrome/consts" - "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/core/auth" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/server" @@ -29,7 +28,7 @@ var _ = Describe("Config API", func() { conf.Server.DevUIShowConfig = true // Enable config endpoint for tests ds = &tests.MockDataStore{} auth.Init(ds) - nativeRouter := New(ds, nil, nil, nil, core.NewMockLibraryService()) + nativeRouter := New(ds, nil, nil, nil, tests.NewMockLibraryService(), tests.NewMockUserService(), nil, nil, nil) router = server.JWTVerifier(nativeRouter) // Create test users @@ -79,7 +78,6 @@ var _ = Describe("Config API", func() { It("redacts sensitive fields", func() { conf.Server.LastFM.ApiKey = "secretapikey123" - conf.Server.Spotify.Secret = "spotifysecret456" conf.Server.PasswordEncryptionKey = "encryptionkey789" conf.Server.DevAutoCreateAdminPassword = "adminpassword123" conf.Server.Prometheus.Password = "prometheuspass" @@ -94,15 +92,10 @@ var _ = Describe("Config API", func() { Expect(json.Unmarshal(w.Body.Bytes(), &resp)).To(Succeed()) // Check LastFM.ApiKey (partially masked) - lastfm, ok := resp.Config["LastFM"].(map[string]interface{}) + lastfm, ok := resp.Config["LastFM"].(map[string]any) Expect(ok).To(BeTrue()) Expect(lastfm["ApiKey"]).To(Equal("s*************3")) - // Check Spotify.Secret (partially masked) - spotify, ok := resp.Config["Spotify"].(map[string]interface{}) - Expect(ok).To(BeTrue()) - Expect(spotify["Secret"]).To(Equal("s**************6")) - // Check PasswordEncryptionKey (fully masked) Expect(resp.Config["PasswordEncryptionKey"]).To(Equal("****")) @@ -110,7 +103,7 @@ var _ = Describe("Config API", func() { Expect(resp.Config["DevAutoCreateAdminPassword"]).To(Equal("****")) // Check Prometheus.Password (fully masked) - prometheus, ok := resp.Config["Prometheus"].(map[string]interface{}) + prometheus, ok := resp.Config["Prometheus"].(map[string]any) Expect(ok).To(BeTrue()) Expect(prometheus["Password"]).To(Equal("****")) }) @@ -129,7 +122,7 @@ var _ = Describe("Config API", func() { Expect(json.Unmarshal(w.Body.Bytes(), &resp)).To(Succeed()) // Check LastFM.ApiKey - should be preserved because it's sensitive - lastfm, ok := resp.Config["LastFM"].(map[string]interface{}) + lastfm, ok := resp.Config["LastFM"].(map[string]any) Expect(ok).To(BeTrue()) Expect(lastfm["ApiKey"]).To(Equal("")) @@ -173,7 +166,6 @@ var _ = Describe("Config API", func() { var _ = Describe("redactValue function", func() { It("partially masks long sensitive values", func() { Expect(redactValue("LastFM.ApiKey", "ba46f0e84a")).To(Equal("b********a")) - Expect(redactValue("Spotify.Secret", "verylongsecret123")).To(Equal("v***************3")) }) It("fully masks long sensitive values that should be completely hidden", func() { @@ -184,7 +176,6 @@ var _ = Describe("redactValue function", func() { It("fully masks short sensitive values", func() { Expect(redactValue("LastFM.Secret", "short")).To(Equal("****")) - Expect(redactValue("Spotify.ID", "abc")).To(Equal("****")) Expect(redactValue("PasswordEncryptionKey", "12345")).To(Equal("****")) Expect(redactValue("DevAutoCreateAdminPassword", "short")).To(Equal("****")) Expect(redactValue("Prometheus.Password", "short")).To(Equal("****")) diff --git a/server/nativeapi/image_upload.go b/server/nativeapi/image_upload.go new file mode 100644 index 000000000..c29f14bdc --- /dev/null +++ b/server/nativeapi/image_upload.go @@ -0,0 +1,120 @@ +package nativeapi + +import ( + "context" + "errors" + "fmt" + "image" + _ "image/gif" + _ "image/jpeg" + _ "image/png" + "io" + "net/http" + "path/filepath" + "strings" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + _ "golang.org/x/image/webp" +) + +const maxImageSize = 10 << 20 // 10MB + +func checkImageUploadPermission(w http.ResponseWriter, r *http.Request) bool { + user, _ := request.UserFrom(r.Context()) + if !conf.Server.EnableCoverArtUpload && !user.IsAdmin { + http.Error(w, "cover art upload is disabled", http.StatusForbidden) + return false + } + return true +} + +func handleImageUpload(saveFn func(ctx context.Context, reader io.Reader, ext string) error) http.HandlerFunc { + return func(w http.ResponseWriter, r *http.Request) { + ctx := r.Context() + if !checkImageUploadPermission(w, r) { + return + } + r.Body = http.MaxBytesReader(w, r.Body, maxImageSize) + if err := r.ParseMultipartForm(maxImageSize / 2); err != nil { + log.Error(ctx, "Error parsing multipart form", err) + http.Error(w, "file too large or invalid form", http.StatusBadRequest) + return + } + defer func() { + if r.MultipartForm != nil { + if err := r.MultipartForm.RemoveAll(); err != nil { + log.Warn(ctx, "Error removing multipart temp files", err) + } + } + }() + file, header, err := r.FormFile("image") + if err != nil { + log.Error(ctx, "Error reading uploaded file", err) + http.Error(w, "missing image file", http.StatusBadRequest) + return + } + defer file.Close() + _, format, err := image.DecodeConfig(file) + if err != nil { + log.Error(ctx, "Uploaded file is not a valid image", err) + http.Error(w, "invalid image file", http.StatusBadRequest) + return + } + if seeker, ok := file.(io.Seeker); ok { + if _, err := seeker.Seek(0, io.SeekStart); err != nil { + log.Error(ctx, "Error seeking file", err) + http.Error(w, err.Error(), http.StatusInternalServerError) + return + } + } + ext := "." + format + if ext == "." { + ext = strings.ToLower(filepath.Ext(header.Filename)) + } + if ext == "" || ext == "." { + log.Error(ctx, "Could not determine image type", "filename", header.Filename) + http.Error(w, "could not determine image type", http.StatusBadRequest) + return + } + if err := saveFn(ctx, file, ext); err != nil { + if errors.Is(err, model.ErrNotAuthorized) { + http.Error(w, "not authorized", http.StatusForbidden) + return + } + if errors.Is(err, model.ErrNotFound) { + http.Error(w, "not found", http.StatusNotFound) + return + } + log.Error(ctx, "Error saving image", err) + http.Error(w, err.Error(), http.StatusInternalServerError) + return + } + _, _ = fmt.Fprintf(w, `{"status":"ok"}`) + } +} + +func handleImageDelete(deleteFn func(ctx context.Context) error) http.HandlerFunc { + return func(w http.ResponseWriter, r *http.Request) { + ctx := r.Context() + if !checkImageUploadPermission(w, r) { + return + } + if err := deleteFn(ctx); err != nil { + if errors.Is(err, model.ErrNotAuthorized) { + http.Error(w, "not authorized", http.StatusForbidden) + return + } + if errors.Is(err, model.ErrNotFound) { + http.Error(w, "not found", http.StatusNotFound) + return + } + log.Error(ctx, "Error removing image", err) + http.Error(w, err.Error(), http.StatusInternalServerError) + return + } + _, _ = fmt.Fprintf(w, `{"status":"ok"}`) + } +} diff --git a/server/nativeapi/inspect.go b/server/nativeapi/inspect.go index 3178395ce..7c96312ed 100644 --- a/server/nativeapi/inspect.go +++ b/server/nativeapi/inspect.go @@ -60,7 +60,7 @@ func inspect(ds model.DataStore) http.HandlerFunc { w.Header().Set("Content-Type", "application/json") - if _, err := w.Write(response); err != nil { + if _, err := w.Write(response); err != nil { //nolint:gosec log.Error(ctx, "Error sending response to client", err) } } diff --git a/server/nativeapi/library.go b/server/nativeapi/library.go index f081eca78..1636e1dbb 100644 --- a/server/nativeapi/library.go +++ b/server/nativeapi/library.go @@ -13,11 +13,11 @@ import ( ) // User-library association endpoints (admin only) -func (n *Router) addUserLibraryRoute(r chi.Router) { +func (api *Router) addUserLibraryRoute(r chi.Router) { r.Route("/user/{id}/library", func(r chi.Router) { r.Use(parseUserIDMiddleware) - r.Get("/", getUserLibraries(n.libs)) - r.Put("/", setUserLibraries(n.libs)) + r.Get("/", getUserLibraries(api.libs)) + r.Put("/", setUserLibraries(api.libs)) }) } diff --git a/server/nativeapi/library_test.go b/server/nativeapi/library_test.go index 4e6d34582..ed5564a41 100644 --- a/server/nativeapi/library_test.go +++ b/server/nativeapi/library_test.go @@ -11,7 +11,6 @@ import ( "github.com/navidrome/navidrome/conf/configtest" "github.com/navidrome/navidrome/consts" - "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/core/auth" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/server" @@ -30,7 +29,7 @@ var _ = Describe("Library API", func() { DeferCleanup(configtest.SetupConfig()) ds = &tests.MockDataStore{} auth.Init(ds) - nativeRouter := New(ds, nil, nil, nil, core.NewMockLibraryService()) + nativeRouter := New(ds, nil, nil, nil, tests.NewMockLibraryService(), tests.NewMockUserService(), nil, nil, nil) router = server.JWTVerifier(nativeRouter) // Create test users diff --git a/server/nativeapi/missing.go b/server/nativeapi/missing.go index 0d311f492..2b455e622 100644 --- a/server/nativeapi/missing.go +++ b/server/nativeapi/missing.go @@ -8,9 +8,9 @@ import ( "github.com/Masterminds/squirrel" "github.com/deluan/rest" + "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/model/request" "github.com/navidrome/navidrome/utils/req" ) @@ -63,45 +63,32 @@ func (r *missingRepository) EntityName() string { return "missing_files" } -func deleteMissingFiles(ds model.DataStore, w http.ResponseWriter, r *http.Request) { - ctx := r.Context() - p := req.Params(r) - ids, _ := p.Strings("id") - err := ds.WithTx(func(tx model.DataStore) error { +func deleteMissingFiles(maintenance core.Maintenance) http.HandlerFunc { + return func(w http.ResponseWriter, r *http.Request) { + ctx := r.Context() + + p := req.Params(r) + ids, _ := p.Strings("id") + + var err error if len(ids) == 0 { - _, err := tx.MediaFile(ctx).DeleteAllMissing() - return err - } - return tx.MediaFile(ctx).DeleteMissing(ids) - }) - if len(ids) == 1 && errors.Is(err, model.ErrNotFound) { - log.Warn(ctx, "Missing file not found", "id", ids[0]) - http.Error(w, "not found", http.StatusNotFound) - return - } - if err != nil { - log.Error(ctx, "Error deleting missing tracks from DB", "ids", ids, err) - http.Error(w, err.Error(), http.StatusInternalServerError) - return - } - err = ds.GC(ctx) - if err != nil { - log.Error(ctx, "Error running GC after deleting missing tracks", err) - http.Error(w, err.Error(), http.StatusInternalServerError) - return - } - - // Refresh artist stats in background after deleting missing files - go func() { - bgCtx := request.AddValues(context.Background(), r.Context()) - if _, err := ds.Artist(bgCtx).RefreshStats(true); err != nil { - log.Error(bgCtx, "Error refreshing artist stats after deleting missing files", err) + err = maintenance.DeleteAllMissingFiles(ctx) } else { - log.Debug(bgCtx, "Successfully refreshed artist stats after deleting missing files") + err = maintenance.DeleteMissingFiles(ctx, ids) } - }() - writeDeleteManyResponse(w, r, ids) + if len(ids) == 1 && errors.Is(err, model.ErrNotFound) { + log.Warn(ctx, "Missing file not found", "id", ids[0]) + http.Error(w, "not found", http.StatusNotFound) + return + } + if err != nil { + http.Error(w, "failed to delete missing files", http.StatusInternalServerError) + return + } + + writeDeleteManyResponse(w, r, ids) + } } var _ model.ResourceRepository = &missingRepository{} diff --git a/server/nativeapi/native_api.go b/server/nativeapi/native_api.go index 370bdbd1e..669c4d7b5 100644 --- a/server/nativeapi/native_api.go +++ b/server/nativeapi/native_api.go @@ -14,78 +14,97 @@ import ( "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/core/metrics" + playlistsvc "github.com/navidrome/navidrome/core/playlists" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/request" "github.com/navidrome/navidrome/server" ) -type Router struct { - http.Handler - ds model.DataStore - share core.Share - playlists core.Playlists - insights metrics.Insights - libs core.Library +// PluginManager defines the interface for plugin management operations. +// This interface is used by the API handlers to enable/disable plugins and update configuration. +type PluginManager interface { + EnablePlugin(ctx context.Context, id string) error + DisablePlugin(ctx context.Context, id string) error + ValidatePluginConfig(ctx context.Context, id, configJSON string) error + UpdatePluginConfig(ctx context.Context, id, configJSON string) error + UpdatePluginUsers(ctx context.Context, id, usersJSON string, allUsers bool) error + UpdatePluginLibraries(ctx context.Context, id, librariesJSON string, allLibraries, allowWriteAccess bool) error + RescanPlugins(ctx context.Context) error + UnloadDisabledPlugins(ctx context.Context) } -func New(ds model.DataStore, share core.Share, playlists core.Playlists, insights metrics.Insights, libraryService core.Library) *Router { - r := &Router{ds: ds, share: share, playlists: playlists, insights: insights, libs: libraryService} +type Router struct { + http.Handler + ds model.DataStore + share core.Share + playlists playlistsvc.Playlists + insights metrics.Insights + libs core.Library + users core.User + maintenance core.Maintenance + pluginManager PluginManager + imgUpload core.ImageUploadService +} + +func New(ds model.DataStore, share core.Share, playlists playlistsvc.Playlists, insights metrics.Insights, libraryService core.Library, userService core.User, maintenance core.Maintenance, pluginManager PluginManager, imgUpload core.ImageUploadService) *Router { + r := &Router{ds: ds, share: share, playlists: playlists, insights: insights, libs: libraryService, users: userService, maintenance: maintenance, pluginManager: pluginManager, imgUpload: imgUpload} r.Handler = r.routes() return r } -func (n *Router) routes() http.Handler { +func (api *Router) routes() http.Handler { r := chi.NewRouter() // Public - n.RX(r, "/translation", newTranslationRepository, false) + api.RX(r, "/translation", newTranslationRepository, false) // Protected r.Group(func(r chi.Router) { - r.Use(server.Authenticator(n.ds)) + r.Use(server.Authenticator(api.ds)) r.Use(server.JWTRefresher) - r.Use(server.UpdateLastAccessMiddleware(n.ds)) - n.R(r, "/user", model.User{}, true) - n.R(r, "/song", model.MediaFile{}, false) - n.R(r, "/album", model.Album{}, false) - n.R(r, "/artist", model.Artist{}, false) - n.R(r, "/genre", model.Genre{}, false) - n.R(r, "/player", model.Player{}, true) - n.R(r, "/transcoding", model.Transcoding{}, conf.Server.EnableTranscodingConfig) - n.R(r, "/radio", model.Radio{}, true) - n.R(r, "/tag", model.Tag{}, true) + r.Use(server.UpdateLastAccessMiddleware(api.ds)) + api.RX(r, "/user", api.users.NewRepository, true) + api.R(r, "/song", model.MediaFile{}, false) + api.R(r, "/album", model.Album{}, false) + api.addArtistRoute(r) + api.R(r, "/genre", model.Genre{}, false) + api.R(r, "/player", model.Player{}, true) + api.R(r, "/transcoding", model.Transcoding{}, conf.Server.EnableTranscodingConfig) + api.addRadioRoute(r) + api.R(r, "/tag", model.Tag{}, true) if conf.Server.EnableSharing { - n.RX(r, "/share", n.share.NewRepository, true) + api.RX(r, "/share", api.share.NewRepository, true) } - n.addPlaylistRoute(r) - n.addPlaylistTrackRoute(r) - n.addSongPlaylistsRoute(r) - n.addQueueRoute(r) - n.addMissingFilesRoute(r) - n.addKeepAliveRoute(r) - n.addInsightsRoute(r) + api.addPlaylistRoute(r) + api.addPlaylistTrackRoute(r) + api.addSongPlaylistsRoute(r) + api.addQueueRoute(r) + api.addMissingFilesRoute(r) + api.addKeepAliveRoute(r) + api.addInsightsRoute(r) r.With(adminOnlyMiddleware).Group(func(r chi.Router) { - n.addInspectRoute(r) - n.addConfigRoute(r) - n.addUserLibraryRoute(r) - n.RX(r, "/library", n.libs.NewRepository, true) + api.addInspectRoute(r) + api.addConfigRoute(r) + api.addUserLibraryRoute(r) + api.addPluginRoute(r) + api.RX(r, "/library", api.libs.NewRepository, true) }) }) return r } -func (n *Router) R(r chi.Router, pathPrefix string, model interface{}, persistable bool) { +func (api *Router) R(r chi.Router, pathPrefix string, model any, persistable bool) { constructor := func(ctx context.Context) rest.Repository { - return n.ds.Resource(ctx, model) + return api.ds.Resource(ctx, model) } - n.RX(r, pathPrefix, constructor, persistable) + api.RX(r, pathPrefix, constructor, persistable) } -func (n *Router) RX(r chi.Router, pathPrefix string, constructor rest.RepositoryConstructor, persistable bool) { +func (api *Router) RX(r chi.Router, pathPrefix string, constructor rest.RepositoryConstructor, persistable bool) { r.Route(pathPrefix, func(r chi.Router) { r.Get("/", rest.GetAll(constructor)) if persistable { @@ -102,9 +121,9 @@ func (n *Router) RX(r chi.Router, pathPrefix string, constructor rest.Repository }) } -func (n *Router) addPlaylistRoute(r chi.Router) { +func (api *Router) addPlaylistRoute(r chi.Router) { constructor := func(ctx context.Context) rest.Repository { - return n.ds.Resource(ctx, model.Playlist{}) + return api.playlists.NewRepository(ctx) } r.Route("/playlist", func(r chi.Router) { @@ -114,7 +133,7 @@ func (n *Router) addPlaylistRoute(r chi.Router) { rest.Post(constructor)(w, r) return } - createPlaylistFromM3U(n.playlists)(w, r) + createPlaylistFromM3U(api.playlists)(w, r) }) r.Route("/{id}", func(r chi.Router) { @@ -122,59 +141,59 @@ func (n *Router) addPlaylistRoute(r chi.Router) { r.Get("/", rest.Get(constructor)) r.Put("/", rest.Put(constructor)) r.Delete("/", rest.Delete(constructor)) + r.Post("/image", uploadPlaylistImage(api.playlists)) + r.Delete("/image", deletePlaylistImage(api.playlists)) }) }) } -func (n *Router) addPlaylistTrackRoute(r chi.Router) { +func (api *Router) addPlaylistTrackRoute(r chi.Router) { r.Route("/playlist/{playlistId}/tracks", func(r chi.Router) { r.Get("/", func(w http.ResponseWriter, r *http.Request) { - getPlaylist(n.ds)(w, r) + getPlaylist(api.playlists)(w, r) }) r.With(server.URLParamsMiddleware).Route("/", func(r chi.Router) { r.Delete("/", func(w http.ResponseWriter, r *http.Request) { - deleteFromPlaylist(n.ds)(w, r) + deleteFromPlaylist(api.playlists)(w, r) }) r.Post("/", func(w http.ResponseWriter, r *http.Request) { - addToPlaylist(n.ds)(w, r) + addToPlaylist(api.playlists)(w, r) }) }) r.Route("/{id}", func(r chi.Router) { r.Use(server.URLParamsMiddleware) r.Get("/", func(w http.ResponseWriter, r *http.Request) { - getPlaylistTrack(n.ds)(w, r) + getPlaylistTrack(api.playlists)(w, r) }) r.Put("/", func(w http.ResponseWriter, r *http.Request) { - reorderItem(n.ds)(w, r) + reorderItem(api.playlists)(w, r) }) r.Delete("/", func(w http.ResponseWriter, r *http.Request) { - deleteFromPlaylist(n.ds)(w, r) + deleteFromPlaylist(api.playlists)(w, r) }) }) }) } -func (n *Router) addSongPlaylistsRoute(r chi.Router) { +func (api *Router) addSongPlaylistsRoute(r chi.Router) { r.With(server.URLParamsMiddleware).Get("/song/{id}/playlists", func(w http.ResponseWriter, r *http.Request) { - getSongPlaylists(n.ds)(w, r) + getSongPlaylists(api.playlists)(w, r) }) } -func (n *Router) addQueueRoute(r chi.Router) { +func (api *Router) addQueueRoute(r chi.Router) { r.Route("/queue", func(r chi.Router) { - r.Get("/", getQueue(n.ds)) - r.Post("/", saveQueue(n.ds)) - r.Put("/", updateQueue(n.ds)) - r.Delete("/", clearQueue(n.ds)) + r.Get("/", getQueue(api.ds)) + r.Post("/", saveQueue(api.ds)) + r.Put("/", updateQueue(api.ds)) + r.Delete("/", clearQueue(api.ds)) }) } -func (n *Router) addMissingFilesRoute(r chi.Router) { +func (api *Router) addMissingFilesRoute(r chi.Router) { r.Route("/missing", func(r chi.Router) { - n.RX(r, "/", newMissingRepository(n.ds), false) - r.Delete("/", func(w http.ResponseWriter, r *http.Request) { - deleteMissingFiles(n.ds, w, r) - }) + api.RX(r, "/", newMissingRepository(api.ds), false) + r.Delete("/", deleteMissingFiles(api.maintenance)) }) } @@ -192,13 +211,13 @@ func writeDeleteManyResponse(w http.ResponseWriter, r *http.Request, ids []strin http.Error(w, err.Error(), http.StatusInternalServerError) } } - _, err = w.Write(resp) + _, err = w.Write(resp) //nolint:gosec if err != nil { http.Error(w, err.Error(), http.StatusInternalServerError) } } -func (n *Router) addInspectRoute(r chi.Router) { +func (api *Router) addInspectRoute(r chi.Router) { if conf.Server.Inspect.Enabled { r.Group(func(r chi.Router) { if conf.Server.Inspect.MaxRequests > 0 { @@ -207,28 +226,28 @@ func (n *Router) addInspectRoute(r chi.Router) { conf.Server.Inspect.BacklogTimeout) r.Use(middleware.ThrottleBacklog(conf.Server.Inspect.MaxRequests, conf.Server.Inspect.BacklogLimit, time.Duration(conf.Server.Inspect.BacklogTimeout))) } - r.Get("/inspect", inspect(n.ds)) + r.Get("/inspect", inspect(api.ds)) }) } } -func (n *Router) addConfigRoute(r chi.Router) { +func (api *Router) addConfigRoute(r chi.Router) { if conf.Server.DevUIShowConfig { r.Get("/config/*", getConfig) } } -func (n *Router) addKeepAliveRoute(r chi.Router) { +func (api *Router) addKeepAliveRoute(r chi.Router) { r.Get("/keepalive/*", func(w http.ResponseWriter, r *http.Request) { _, _ = w.Write([]byte(`{"response":"ok", "id":"keepalive"}`)) }) } -func (n *Router) addInsightsRoute(r chi.Router) { +func (api *Router) addInsightsRoute(r chi.Router) { r.Get("/insights/*", func(w http.ResponseWriter, r *http.Request) { - last, success := n.insights.LastRun(r.Context()) + last, success := api.insights.LastRun(r.Context()) if conf.Server.EnableInsightsCollector { - _, _ = w.Write([]byte(`{"id":"insights_status", "lastRun":"` + last.Format("2006-01-02 15:04:05") + `", "success":` + strconv.FormatBool(success) + `}`)) + _, _ = w.Write([]byte(`{"id":"insights_status", "lastRun":"` + last.Format("2006-01-02 15:04:05") + `", "success":` + strconv.FormatBool(success) + `}`)) //nolint:gosec } else { _, _ = w.Write([]byte(`{"id":"insights_status", "lastRun":"disabled", "success":false}`)) } diff --git a/server/nativeapi/native_api_song_test.go b/server/nativeapi/native_api_song_test.go index d7209a164..f0ee50ebb 100644 --- a/server/nativeapi/native_api_song_test.go +++ b/server/nativeapi/native_api_song_test.go @@ -11,7 +11,6 @@ import ( "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/conf/configtest" "github.com/navidrome/navidrome/consts" - "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/core/auth" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/server" @@ -95,7 +94,7 @@ var _ = Describe("Song Endpoints", func() { mfRepo.SetData(testSongs) // Create the native API router and wrap it with the JWTVerifier middleware - nativeRouter := New(ds, nil, nil, nil, core.NewMockLibraryService()) + nativeRouter := New(ds, nil, nil, nil, tests.NewMockLibraryService(), tests.NewMockUserService(), nil, nil, nil) router = server.JWTVerifier(nativeRouter) w = httptest.NewRecorder() }) diff --git a/server/nativeapi/playlists.go b/server/nativeapi/playlists.go index 17af19475..ea1cf579b 100644 --- a/server/nativeapi/playlists.go +++ b/server/nativeapi/playlists.go @@ -5,13 +5,14 @@ import ( "encoding/json" "errors" "fmt" + "io" "net/http" "strconv" "strings" "github.com/deluan/rest" "github.com/go-chi/chi/v5" - "github.com/navidrome/navidrome/core" + "github.com/navidrome/navidrome/core/playlists" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/utils/req" @@ -19,53 +20,39 @@ import ( type restHandler = func(rest.RepositoryConstructor, ...rest.Logger) http.HandlerFunc -func getPlaylist(ds model.DataStore) http.HandlerFunc { - // Add a middleware to capture the playlistId - wrapper := func(handler restHandler) http.HandlerFunc { - return func(w http.ResponseWriter, r *http.Request) { - constructor := func(ctx context.Context) rest.Repository { - plsRepo := ds.Playlist(ctx) - plsId := chi.URLParam(r, "playlistId") - p := req.Params(r) - start := p.Int64Or("_start", 0) - return plsRepo.Tracks(plsId, start == 0) - } - - handler(constructor).ServeHTTP(w, r) - } - } - +func playlistTracksHandler(pls playlists.Playlists, handler restHandler, refreshSmartPlaylist func(*http.Request) bool) http.HandlerFunc { return func(w http.ResponseWriter, r *http.Request) { - accept := r.Header.Get("accept") - if strings.ToLower(accept) == "audio/x-mpegurl" { - handleExportPlaylist(ds)(w, r) + plsId := chi.URLParam(r, "playlistId") + tracks := pls.TracksRepository(r.Context(), plsId, refreshSmartPlaylist(r)) + if tracks == nil { + http.Error(w, "not found", http.StatusNotFound) return } - wrapper(rest.GetAll)(w, r) + handler(func(ctx context.Context) rest.Repository { return tracks }).ServeHTTP(w, r) } } -func getPlaylistTrack(ds model.DataStore) http.HandlerFunc { - // Add a middleware to capture the playlistId - wrapper := func(handler restHandler) http.HandlerFunc { - return func(w http.ResponseWriter, r *http.Request) { - constructor := func(ctx context.Context) rest.Repository { - plsRepo := ds.Playlist(ctx) - plsId := chi.URLParam(r, "playlistId") - return plsRepo.Tracks(plsId, true) - } - - handler(constructor).ServeHTTP(w, r) +func getPlaylist(pls playlists.Playlists) http.HandlerFunc { + handler := playlistTracksHandler(pls, rest.GetAll, func(r *http.Request) bool { + return req.Params(r).Int64Or("_start", 0) == 0 + }) + return func(w http.ResponseWriter, r *http.Request) { + if strings.ToLower(r.Header.Get("accept")) == "audio/x-mpegurl" { + handleExportPlaylist(pls)(w, r) + return } + handler(w, r) } - - return wrapper(rest.Get) } -func createPlaylistFromM3U(playlists core.Playlists) http.HandlerFunc { +func getPlaylistTrack(pls playlists.Playlists) http.HandlerFunc { + return playlistTracksHandler(pls, rest.Get, func(*http.Request) bool { return true }) +} + +func createPlaylistFromM3U(pls playlists.Playlists) http.HandlerFunc { return func(w http.ResponseWriter, r *http.Request) { ctx := r.Context() - pls, err := playlists.ImportM3U(ctx, r.Body) + pl, err := pls.ImportM3U(ctx, r.Body) if err != nil { log.Error(r.Context(), "Error parsing playlist", err) // TODO: consider returning StatusBadRequest for playlists that are malformed @@ -73,7 +60,7 @@ func createPlaylistFromM3U(playlists core.Playlists) http.HandlerFunc { return } w.WriteHeader(http.StatusCreated) - _, err = w.Write([]byte(pls.ToM3U8())) + _, err = w.Write([]byte(pl.ToM3U8())) //nolint:gosec if err != nil { log.Error(ctx, "Error sending m3u contents", err) http.Error(w, err.Error(), http.StatusInternalServerError) @@ -82,45 +69,41 @@ func createPlaylistFromM3U(playlists core.Playlists) http.HandlerFunc { } } -func handleExportPlaylist(ds model.DataStore) http.HandlerFunc { +func handleExportPlaylist(pls playlists.Playlists) http.HandlerFunc { return func(w http.ResponseWriter, r *http.Request) { ctx := r.Context() - plsRepo := ds.Playlist(ctx) plsId := chi.URLParam(r, "playlistId") - pls, err := plsRepo.GetWithTracks(plsId, true, false) + playlist, err := pls.GetWithTracks(ctx, plsId) if errors.Is(err, model.ErrNotFound) { - log.Warn(r.Context(), "Playlist not found", "playlistId", plsId) + log.Warn(ctx, "Playlist not found", "playlistId", plsId) http.Error(w, "not found", http.StatusNotFound) return } if err != nil { - log.Error(r.Context(), "Error retrieving the playlist", "playlistId", plsId, err) + log.Error(ctx, "Error retrieving the playlist", "playlistId", plsId, err) http.Error(w, err.Error(), http.StatusInternalServerError) return } - log.Debug(ctx, "Exporting playlist as M3U", "playlistId", plsId, "name", pls.Name) + log.Debug(ctx, "Exporting playlist as M3U", "playlistId", plsId, "name", playlist.Name) w.Header().Set("Content-Type", "audio/x-mpegurl") - disposition := fmt.Sprintf("attachment; filename=\"%s.m3u\"", pls.Name) + disposition := fmt.Sprintf("attachment; filename=\"%s.m3u\"", playlist.Name) w.Header().Set("Content-Disposition", disposition) - _, err = w.Write([]byte(pls.ToM3U8())) + _, err = w.Write([]byte(playlist.ToM3U8())) //nolint:gosec if err != nil { - log.Error(ctx, "Error sending playlist", "name", pls.Name) + log.Error(ctx, "Error sending playlist", "name", playlist.Name) return } } } -func deleteFromPlaylist(ds model.DataStore) http.HandlerFunc { +func deleteFromPlaylist(pls playlists.Playlists) http.HandlerFunc { return func(w http.ResponseWriter, r *http.Request) { p := req.Params(r) playlistId, _ := p.String(":playlistId") ids, _ := p.Strings("id") - err := ds.WithTxImmediate(func(tx model.DataStore) error { - tracksRepo := tx.Playlist(r.Context()).Tracks(playlistId, true) - return tracksRepo.Delete(ids...) - }) + err := pls.RemoveTracks(r.Context(), playlistId, ids) if len(ids) == 1 && errors.Is(err, model.ErrNotFound) { log.Warn(r.Context(), "Track not found in playlist", "playlistId", playlistId, "id", ids[0]) http.Error(w, "not found", http.StatusNotFound) @@ -135,7 +118,7 @@ func deleteFromPlaylist(ds model.DataStore) http.HandlerFunc { } } -func addToPlaylist(ds model.DataStore) http.HandlerFunc { +func addToPlaylist(pls playlists.Playlists) http.HandlerFunc { type addTracksPayload struct { Ids []string `json:"ids"` AlbumIds []string `json:"albumIds"` @@ -144,6 +127,7 @@ func addToPlaylist(ds model.DataStore) http.HandlerFunc { } return func(w http.ResponseWriter, r *http.Request) { + ctx := r.Context() p := req.Params(r) playlistId, _ := p.String(":playlistId") var payload addTracksPayload @@ -152,43 +136,43 @@ func addToPlaylist(ds model.DataStore) http.HandlerFunc { http.Error(w, err.Error(), http.StatusBadRequest) return } - tracksRepo := ds.Playlist(r.Context()).Tracks(playlistId, true) count, c := 0, 0 - if c, err = tracksRepo.Add(payload.Ids); err != nil { + if c, err = pls.AddTracks(ctx, playlistId, payload.Ids); err != nil { http.Error(w, err.Error(), http.StatusBadRequest) return } count += c - if c, err = tracksRepo.AddAlbums(payload.AlbumIds); err != nil { + if c, err = pls.AddAlbums(ctx, playlistId, payload.AlbumIds); err != nil { http.Error(w, err.Error(), http.StatusBadRequest) return } count += c - if c, err = tracksRepo.AddArtists(payload.ArtistIds); err != nil { + if c, err = pls.AddArtists(ctx, playlistId, payload.ArtistIds); err != nil { http.Error(w, err.Error(), http.StatusBadRequest) return } count += c - if c, err = tracksRepo.AddDiscs(payload.Discs); err != nil { + if c, err = pls.AddDiscs(ctx, playlistId, payload.Discs); err != nil { http.Error(w, err.Error(), http.StatusBadRequest) return } count += c // Must return an object with an ID, to satisfy ReactAdmin `create` call - _, err = fmt.Fprintf(w, `{"added":%d}`, count) + _, err = fmt.Fprintf(w, `{"added":%d}`, count) //nolint:gosec if err != nil { http.Error(w, err.Error(), http.StatusInternalServerError) } } } -func reorderItem(ds model.DataStore) http.HandlerFunc { +func reorderItem(pls playlists.Playlists) http.HandlerFunc { type reorderPayload struct { InsertBefore string `json:"insert_before"` } return func(w http.ResponseWriter, r *http.Request) { + ctx := r.Context() p := req.Params(r) playlistId, _ := p.String(":playlistId") id := p.IntOr(":id", 0) @@ -207,9 +191,8 @@ func reorderItem(ds model.DataStore) http.HandlerFunc { http.Error(w, err.Error(), http.StatusBadRequest) return } - tracksRepo := ds.Playlist(r.Context()).Tracks(playlistId, true) - err = tracksRepo.Reorder(id, newPos) - if errors.Is(err, rest.ErrPermissionDenied) { + err = pls.ReorderTrack(ctx, playlistId, id, newPos) + if errors.Is(err, model.ErrNotAuthorized) { http.Error(w, err.Error(), http.StatusForbidden) return } @@ -218,18 +201,18 @@ func reorderItem(ds model.DataStore) http.HandlerFunc { return } - _, err = w.Write([]byte(fmt.Sprintf(`{"id":"%d"}`, id))) + _, err = w.Write(fmt.Appendf(nil, `{"id":"%d"}`, id)) //nolint:gosec if err != nil { http.Error(w, err.Error(), http.StatusInternalServerError) } } } -func getSongPlaylists(ds model.DataStore) http.HandlerFunc { +func getSongPlaylists(svc playlists.Playlists) http.HandlerFunc { return func(w http.ResponseWriter, r *http.Request) { p := req.Params(r) trackId, _ := p.String(":id") - playlists, err := ds.Playlist(r.Context()).GetPlaylists(trackId) + playlists, err := svc.GetPlaylists(r.Context(), trackId) if err != nil { http.Error(w, err.Error(), http.StatusInternalServerError) return @@ -239,6 +222,20 @@ func getSongPlaylists(ds model.DataStore) http.HandlerFunc { http.Error(w, err.Error(), http.StatusInternalServerError) return } - _, _ = w.Write(data) + _, _ = w.Write(data) //nolint:gosec } } + +func uploadPlaylistImage(pls playlists.Playlists) http.HandlerFunc { + return handleImageUpload(func(ctx context.Context, reader io.Reader, ext string) error { + playlistId := chi.URLParamFromCtx(ctx, "id") + return pls.SetImage(ctx, playlistId, reader, ext) + }) +} + +func deletePlaylistImage(pls playlists.Playlists) http.HandlerFunc { + return handleImageDelete(func(ctx context.Context) error { + playlistId := chi.URLParamFromCtx(ctx, "id") + return pls.RemoveImage(ctx, playlistId) + }) +} diff --git a/server/nativeapi/playlists_test.go b/server/nativeapi/playlists_test.go new file mode 100644 index 000000000..dfe6b9296 --- /dev/null +++ b/server/nativeapi/playlists_test.go @@ -0,0 +1,238 @@ +package nativeapi + +import ( + "context" + "encoding/json" + "io" + "net/http" + "net/http/httptest" + "time" + + "github.com/deluan/rest" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/core/playlists" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/server" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Playlist Image Endpoints", func() { + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + }) + + DescribeTable("uploadPlaylistImage guard", + func(enableCoverArtUpload, isAdmin bool, expectedStatus int) { + conf.Server.EnableCoverArtUpload = enableCoverArtUpload + handler := uploadPlaylistImage(&mockPlaylistsService{}) + + req := httptest.NewRequest("POST", "/playlist/pls-1/image", nil) + ctx := request.WithUser(GinkgoT().Context(), model.User{ID: "user-1", IsAdmin: isAdmin}) + req = req.WithContext(ctx) + + w := httptest.NewRecorder() + handler.ServeHTTP(w, req) + Expect(w.Code).To(Equal(expectedStatus)) + }, + Entry("enabled, regular user passes guard", true, false, http.StatusBadRequest), + Entry("enabled, admin passes guard", true, true, http.StatusBadRequest), + Entry("disabled, admin passes guard", false, true, http.StatusBadRequest), + Entry("disabled, regular user is forbidden", false, false, http.StatusForbidden), + ) + + DescribeTable("deletePlaylistImage guard", + func(enableCoverArtUpload, isAdmin bool, expectedStatus int) { + conf.Server.EnableCoverArtUpload = enableCoverArtUpload + handler := deletePlaylistImage(&mockPlaylistsService{}) + + req := httptest.NewRequest("DELETE", "/playlist/pls-1/image", nil) + ctx := request.WithUser(GinkgoT().Context(), model.User{ID: "user-1", IsAdmin: isAdmin}) + req = req.WithContext(ctx) + + w := httptest.NewRecorder() + handler.ServeHTTP(w, req) + Expect(w.Code).To(Equal(expectedStatus)) + }, + Entry("enabled, regular user passes guard", true, false, http.StatusNotFound), + Entry("enabled, admin passes guard", true, true, http.StatusNotFound), + Entry("disabled, admin passes guard", false, true, http.StatusNotFound), + Entry("disabled, regular user is forbidden", false, false, http.StatusForbidden), + ) +}) + +var _ = Describe("Playlist Tracks Endpoint", func() { + var ( + router http.Handler + plsSvc *mockPlaylistsService + userRepo *tests.MockedUserRepo + w *httptest.ResponseRecorder + ) + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.SessionTimeout = time.Minute + + plsSvc = &mockPlaylistsService{} + userRepo = tests.CreateMockUserRepo() + + ds := &tests.MockDataStore{ + MockedUser: userRepo, + MockedProperty: &tests.MockedPropertyRepo{}, + } + + auth.Init(ds) + + testUser := model.User{ + ID: "user-1", + UserName: "testuser", + Name: "Test User", + IsAdmin: false, + NewPassword: "testpass", + } + err := userRepo.Put(&testUser) + Expect(err).ToNot(HaveOccurred()) + + nativeRouter := New(ds, nil, plsSvc, nil, tests.NewMockLibraryService(), tests.NewMockUserService(), nil, nil, nil) + router = server.JWTVerifier(nativeRouter) + w = httptest.NewRecorder() + }) + + createAuthenticatedRequest := func(method, path string) *http.Request { + req := httptest.NewRequest(method, path, nil) + testUser := model.User{ID: "user-1", UserName: "testuser"} + token, err := auth.CreateToken(&testUser) + Expect(err).ToNot(HaveOccurred()) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+token) + return req + } + + Describe("GET /playlist/{playlistId}/tracks", func() { + It("returns 404 when playlist does not exist", func() { + req := createAuthenticatedRequest("GET", "/playlist/non-existent/tracks") + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusNotFound)) + }) + + It("returns tracks when playlist exists", func() { + plsSvc.tracksRepo = &mockPlaylistTrackRepo{ + tracks: model.PlaylistTracks{ + {ID: "1", MediaFileID: "mf-1", PlaylistID: "pls-1"}, + {ID: "2", MediaFileID: "mf-2", PlaylistID: "pls-1"}, + }, + } + + req := createAuthenticatedRequest("GET", "/playlist/pls-1/tracks") + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var response []model.PlaylistTrack + err := json.Unmarshal(w.Body.Bytes(), &response) + Expect(err).ToNot(HaveOccurred()) + Expect(response).To(HaveLen(2)) + Expect(response[0].ID).To(Equal("1")) + Expect(response[1].ID).To(Equal("2")) + }) + }) + + Describe("GET /playlist/{playlistId}/tracks/{id}", func() { + It("returns 404 when playlist does not exist", func() { + req := createAuthenticatedRequest("GET", "/playlist/non-existent/tracks/1") + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusNotFound)) + }) + + It("returns the track when playlist exists", func() { + plsSvc.tracksRepo = &mockPlaylistTrackRepo{ + tracks: model.PlaylistTracks{ + {ID: "1", MediaFileID: "mf-1", PlaylistID: "pls-1"}, + }, + } + + req := createAuthenticatedRequest("GET", "/playlist/pls-1/tracks/1") + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var response model.PlaylistTrack + err := json.Unmarshal(w.Body.Bytes(), &response) + Expect(err).ToNot(HaveOccurred()) + Expect(response.ID).To(Equal("1")) + Expect(response.MediaFileID).To(Equal("mf-1")) + }) + + It("returns 404 when track does not exist in playlist", func() { + plsSvc.tracksRepo = &mockPlaylistTrackRepo{ + tracks: model.PlaylistTracks{}, + } + + req := createAuthenticatedRequest("GET", "/playlist/pls-1/tracks/999") + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusNotFound)) + }) + }) +}) + +type mockPlaylistTrackRepo struct { + model.PlaylistTrackRepository + tracks model.PlaylistTracks +} + +func (m *mockPlaylistTrackRepo) Count(...rest.QueryOptions) (int64, error) { + return int64(len(m.tracks)), nil +} + +func (m *mockPlaylistTrackRepo) ReadAll(...rest.QueryOptions) (any, error) { + return m.tracks, nil +} + +func (m *mockPlaylistTrackRepo) EntityName() string { + return "playlist_track" +} + +func (m *mockPlaylistTrackRepo) NewInstance() any { + return &model.PlaylistTrack{} +} + +func (m *mockPlaylistTrackRepo) Read(id string) (any, error) { + for _, t := range m.tracks { + if t.ID == id { + return &t, nil + } + } + return nil, rest.ErrNotFound +} + +type mockPlaylistsService struct { + playlists.Playlists + tracksRepo rest.Repository + removeImageFn func(ctx context.Context, id string) error + setImageFn func(ctx context.Context, id string, reader io.Reader, ext string) error +} + +func (m *mockPlaylistsService) RemoveImage(ctx context.Context, id string) error { + if m.removeImageFn != nil { + return m.removeImageFn(ctx, id) + } + return model.ErrNotFound +} + +func (m *mockPlaylistsService) SetImage(ctx context.Context, id string, reader io.Reader, ext string) error { + if m.setImageFn != nil { + return m.setImageFn(ctx, id, reader, ext) + } + return model.ErrNotFound +} + +func (m *mockPlaylistsService) TracksRepository(_ context.Context, _ string, _ bool) rest.Repository { + return m.tracksRepo +} diff --git a/server/nativeapi/plugin.go b/server/nativeapi/plugin.go new file mode 100644 index 000000000..a7d261681 --- /dev/null +++ b/server/nativeapi/plugin.go @@ -0,0 +1,271 @@ +package nativeapi + +import ( + "context" + "encoding/json" + "errors" + "net/http" + + "github.com/deluan/rest" + "github.com/go-chi/chi/v5" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/server" +) + +func (api *Router) addPluginRoute(r chi.Router) { + constructor := func(ctx context.Context) rest.Repository { + return api.ds.Plugin(ctx) + } + + r.Route("/plugin", func(r chi.Router) { + r.Use(pluginsEnabledMiddleware) + r.Get("/", rest.GetAll(constructor)) + r.Post("/rescan", api.rescanPlugins) + r.Route("/{id}", func(r chi.Router) { + r.Use(server.URLParamsMiddleware) + r.Get("/", rest.Get(constructor)) + r.Put("/", api.updatePlugin) + }) + }) +} + +func (api *Router) rescanPlugins(w http.ResponseWriter, r *http.Request) { + ctx := r.Context() + + if err := api.pluginManager.RescanPlugins(ctx); err != nil { + log.Error(ctx, "Error rescanning plugins", err) + http.Error(w, "Error rescanning plugins: "+err.Error(), http.StatusInternalServerError) + return + } + + w.WriteHeader(http.StatusOK) +} + +// Middleware to check if plugins feature is enabled +func pluginsEnabledMiddleware(next http.Handler) http.Handler { + return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + if !conf.Server.Plugins.Enabled { + http.Error(w, "Not found", http.StatusNotFound) + return + } + next.ServeHTTP(w, r) + }) +} + +// PluginUpdateRequest represents the fields that can be updated via the API +type PluginUpdateRequest struct { + Enabled *bool `json:"enabled,omitempty"` + Config *string `json:"config,omitempty"` + Users *string `json:"users,omitempty"` + AllUsers *bool `json:"allUsers,omitempty"` + Libraries *string `json:"libraries,omitempty"` + AllLibraries *bool `json:"allLibraries,omitempty"` + AllowWriteAccess *bool `json:"allowWriteAccess,omitempty"` +} + +func (api *Router) updatePlugin(w http.ResponseWriter, r *http.Request) { + id := chi.URLParam(r, "id") + ctx := r.Context() + repo := api.ds.Plugin(ctx) + + // Get existing plugin to verify it exists + if _, err := repo.Get(id); err != nil { + if errors.Is(err, rest.ErrPermissionDenied) { + http.Error(w, "Access denied: admin privileges required", http.StatusForbidden) + return + } + if errors.Is(err, model.ErrNotFound) { + http.Error(w, "Plugin not found", http.StatusNotFound) + return + } + log.Error(ctx, "Error getting plugin", "id", id, err) + http.Error(w, "Internal server error", http.StatusInternalServerError) + return + } + + // Parse update request + var req PluginUpdateRequest + if err := json.NewDecoder(r.Body).Decode(&req); err != nil { + log.Error(ctx, "Error decoding request", err) + http.Error(w, "Invalid request body", http.StatusBadRequest) + return + } + + // Handle config update (if provided) + if req.Config != nil { + if err := validateAndUpdateConfig(ctx, api.pluginManager, id, *req.Config, w); err != nil { + log.Error(ctx, "Error updating plugin config", err) + return + } + } + + // Handle users permission update (if provided) + if req.Users != nil || req.AllUsers != nil { + if err := validateAndUpdateUsers(ctx, api.pluginManager, repo, id, req, w); err != nil { + log.Error(ctx, "Error updating plugin users", err) + return + } + } + + // Handle libraries permission update (if provided) + if req.Libraries != nil || req.AllLibraries != nil || req.AllowWriteAccess != nil { + if err := validateAndUpdateLibraries(ctx, api.pluginManager, repo, id, req, w); err != nil { + log.Error(ctx, "Error updating plugin libraries", err) + return + } + } + + // Handle enable/disable + if req.Enabled != nil { + if *req.Enabled { + if enableErr := api.pluginManager.EnablePlugin(ctx, id); enableErr != nil { + log.Error(ctx, "Error enabling plugin", "id", id, enableErr) + // Refresh plugin from DB to get the error + plugin, err := repo.Get(id) + if err != nil { + log.Error(ctx, "Error getting updated plugin after enable failure", "id", id, err) + http.Error(w, "Internal server error", http.StatusInternalServerError) + return + } + // Return error response with message field for React-Admin compatibility + // and include the plugin data so UI can update its state + errorResponse := struct { + Message string `json:"message"` + Plugin *model.Plugin `json:"plugin"` + }{ + Message: enableErr.Error(), + Plugin: plugin, + } + w.Header().Set("Content-Type", "application/json") + w.WriteHeader(http.StatusUnprocessableEntity) + _ = json.NewEncoder(w).Encode(errorResponse) + return + } + } else { + if err := api.pluginManager.DisablePlugin(ctx, id); err != nil { + log.Error(ctx, "Error disabling plugin", "id", id, err) + http.Error(w, "Error disabling plugin: "+err.Error(), http.StatusInternalServerError) + return + } + } + } + + // Refresh and return updated plugin + plugin, err := repo.Get(id) + if err != nil { + log.Error(ctx, "Error getting updated plugin", "id", id, err) + http.Error(w, "Internal server error", http.StatusInternalServerError) + return + } + + w.Header().Set("Content-Type", "application/json") + if err := json.NewEncoder(w).Encode(plugin); err != nil { + log.Error(ctx, "Error encoding plugin response", err) + } +} + +// isValidJSON checks if a string is valid JSON +func isValidJSON(s string) bool { + var js json.RawMessage + return json.Unmarshal([]byte(s), &js) == nil +} + +// validateAndUpdateConfig validates the config JSON against the plugin's schema and updates the plugin. +// Returns an error if validation or update fails (error response already written). +func validateAndUpdateConfig(ctx context.Context, pm PluginManager, id, configJSON string, w http.ResponseWriter) error { + // Basic JSON syntax check + if configJSON != "" && !isValidJSON(configJSON) { + http.Error(w, "Invalid JSON in config field", http.StatusBadRequest) + return errors.New("invalid JSON") + } + + // Validate against plugin's config schema + if err := pm.ValidatePluginConfig(ctx, id, configJSON); err != nil { + log.Warn(ctx, "Config validation failed", "id", id, err) + w.Header().Set("Content-Type", "application/json") + w.WriteHeader(http.StatusBadRequest) + // Try to return structured validation errors if available + response := map[string]any{"message": err.Error()} + _ = json.NewEncoder(w).Encode(response) + return err + } + + if err := pm.UpdatePluginConfig(ctx, id, configJSON); err != nil { + log.Error(ctx, "Error updating plugin config", "id", id, err) + http.Error(w, "Error updating plugin configuration: "+err.Error(), http.StatusInternalServerError) + return err + } + return nil +} + +// validateAndUpdateUsers validates the users JSON and updates the plugin. +// Returns an error if validation or update fails (error response already written). +func validateAndUpdateUsers(ctx context.Context, pm PluginManager, repo model.PluginRepository, id string, req PluginUpdateRequest, w http.ResponseWriter) error { + // Get current values if not provided in request + plugin, err := repo.Get(id) + if err != nil { + log.Error(ctx, "Error getting plugin for users update", "id", id, err) + http.Error(w, "Internal server error", http.StatusInternalServerError) + return err + } + + usersJSON := plugin.Users + allUsers := plugin.AllUsers + + if req.Users != nil { + if *req.Users != "" && !isValidJSON(*req.Users) { + http.Error(w, "Invalid JSON in users field", http.StatusBadRequest) + return errors.New("invalid JSON") + } + usersJSON = *req.Users + } + if req.AllUsers != nil { + allUsers = *req.AllUsers + } + + if err := pm.UpdatePluginUsers(ctx, id, usersJSON, allUsers); err != nil { + log.Error(ctx, "Error updating plugin users", "id", id, err) + http.Error(w, "Error updating plugin users: "+err.Error(), http.StatusInternalServerError) + return err + } + return nil +} + +// validateAndUpdateLibraries validates the libraries JSON and updates the plugin. +// Returns an error if validation or update fails (error response already written). +func validateAndUpdateLibraries(ctx context.Context, pm PluginManager, repo model.PluginRepository, id string, req PluginUpdateRequest, w http.ResponseWriter) error { + // Get current values if not provided in request + plugin, err := repo.Get(id) + if err != nil { + log.Error(ctx, "Error getting plugin for libraries update", "id", id, err) + http.Error(w, "Internal server error", http.StatusInternalServerError) + return err + } + + librariesJSON := plugin.Libraries + allLibraries := plugin.AllLibraries + allowWriteAccess := plugin.AllowWriteAccess + + if req.Libraries != nil { + if *req.Libraries != "" && !isValidJSON(*req.Libraries) { + http.Error(w, "Invalid JSON in libraries field", http.StatusBadRequest) + return errors.New("invalid JSON") + } + librariesJSON = *req.Libraries + } + if req.AllLibraries != nil { + allLibraries = *req.AllLibraries + } + if req.AllowWriteAccess != nil { + allowWriteAccess = *req.AllowWriteAccess + } + + if err := pm.UpdatePluginLibraries(ctx, id, librariesJSON, allLibraries, allowWriteAccess); err != nil { + log.Error(ctx, "Error updating plugin libraries", "id", id, err) + http.Error(w, "Error updating plugin libraries: "+err.Error(), http.StatusInternalServerError) + return err + } + return nil +} diff --git a/server/nativeapi/plugin_test.go b/server/nativeapi/plugin_test.go new file mode 100644 index 000000000..8fc88e09c --- /dev/null +++ b/server/nativeapi/plugin_test.go @@ -0,0 +1,487 @@ +package nativeapi + +import ( + "bytes" + "context" + "encoding/json" + "errors" + "net/http" + "net/http/httptest" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/server" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Plugin API", func() { + var ds *tests.MockDataStore + var mockManager *tests.MockPluginManager + var router http.Handler + var adminUser, regularUser model.User + var testPlugin1, testPlugin2 model.Plugin + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Plugins.Enabled = true + ds = &tests.MockDataStore{} + mockManager = &tests.MockPluginManager{} + auth.Init(ds) + nativeRouter := New(ds, nil, nil, nil, tests.NewMockLibraryService(), tests.NewMockUserService(), nil, mockManager, nil) + router = server.JWTVerifier(nativeRouter) + + // Create test users + adminUser = model.User{ + ID: "admin-1", + UserName: "admin", + Name: "Admin User", + IsAdmin: true, + NewPassword: "adminpass", + } + regularUser = model.User{ + ID: "user-1", + UserName: "regular", + Name: "Regular User", + IsAdmin: false, + NewPassword: "userpass", + } + + // Create test plugins + testPlugin1 = model.Plugin{ + ID: "test-plugin-1", + Path: "/plugins/test1.wasm", + Manifest: `{"name":"Test Plugin 1","version":"1.0.0"}`, + SHA256: "abc123", + Enabled: false, + } + testPlugin2 = model.Plugin{ + ID: "test-plugin-2", + Path: "/plugins/test2.wasm", + Manifest: `{"name":"Test Plugin 2","version":"2.0.0"}`, + Config: `{"setting":"value"}`, + SHA256: "def456", + Enabled: true, + } + + // Store users in mock datastore + Expect(ds.User(GinkgoT().Context()).Put(&adminUser)).To(Succeed()) + Expect(ds.User(GinkgoT().Context()).Put(®ularUser)).To(Succeed()) + }) + + Context("when plugins are disabled", func() { + BeforeEach(func() { + conf.Server.Plugins.Enabled = false + }) + + It("returns 404 for all plugin endpoints", func() { + adminToken, err := auth.CreateToken(&adminUser) + Expect(err).ToNot(HaveOccurred()) + + req := httptest.NewRequest("GET", "/plugin", nil) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusNotFound)) + }) + }) + + Context("when plugins are enabled", func() { + Describe("as admin user", func() { + var adminToken string + + BeforeEach(func() { + var err error + adminToken, err = auth.CreateToken(&adminUser) + Expect(err).ToNot(HaveOccurred()) + + // Store test plugins as admin + ctx := GinkgoT().Context() + adminCtx := request.WithUser(ctx, adminUser) + Expect(ds.Plugin(adminCtx).Put(&testPlugin1)).To(Succeed()) + Expect(ds.Plugin(adminCtx).Put(&testPlugin2)).To(Succeed()) + }) + + Describe("GET /api/plugin", func() { + It("returns all plugins", func() { + req := httptest.NewRequest("GET", "/plugin", nil) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var plugins []model.Plugin + err := json.Unmarshal(w.Body.Bytes(), &plugins) + Expect(err).ToNot(HaveOccurred()) + Expect(plugins).To(HaveLen(2)) + }) + }) + + Describe("GET /api/plugin/{id}", func() { + It("returns a specific plugin", func() { + req := httptest.NewRequest("GET", "/plugin/test-plugin-1", nil) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var plugin model.Plugin + err := json.Unmarshal(w.Body.Bytes(), &plugin) + Expect(err).ToNot(HaveOccurred()) + Expect(plugin.ID).To(Equal("test-plugin-1")) + Expect(plugin.Path).To(Equal("/plugins/test1.wasm")) + }) + + It("returns 404 for non-existent plugin", func() { + req := httptest.NewRequest("GET", "/plugin/non-existent", nil) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusNotFound)) + }) + }) + + Describe("PUT /api/plugin/{id}", func() { + It("updates plugin enabled state", func() { + // Configure mock to update the repo when EnablePlugin is called + mockManager.EnablePluginFn = func(ctx context.Context, id string) error { + adminCtx := request.WithUser(ctx, adminUser) + p, _ := ds.Plugin(adminCtx).Get(id) + p.Enabled = true + return ds.Plugin(adminCtx).Put(p) + } + + body := bytes.NewBufferString(`{"enabled":true}`) + req := httptest.NewRequest("PUT", "/plugin/test-plugin-1", body) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + req.Header.Set("Content-Type", "application/json") + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var plugin model.Plugin + err := json.Unmarshal(w.Body.Bytes(), &plugin) + Expect(err).ToNot(HaveOccurred()) + Expect(plugin.Enabled).To(BeTrue()) + Expect(mockManager.EnablePluginCalls).To(ContainElement("test-plugin-1")) + }) + + It("updates plugin config with valid JSON", func() { + // Configure mock to update the repo when UpdatePluginConfig is called + mockManager.UpdatePluginConfigFn = func(ctx context.Context, id, configJSON string) error { + adminCtx := request.WithUser(ctx, adminUser) + p, _ := ds.Plugin(adminCtx).Get(id) + p.Config = configJSON + return ds.Plugin(adminCtx).Put(p) + } + + body := bytes.NewBufferString(`{"config":"{\"key\":\"value\"}"}`) + req := httptest.NewRequest("PUT", "/plugin/test-plugin-1", body) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + req.Header.Set("Content-Type", "application/json") + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var plugin model.Plugin + err := json.Unmarshal(w.Body.Bytes(), &plugin) + Expect(err).ToNot(HaveOccurred()) + Expect(plugin.Config).To(Equal(`{"key":"value"}`)) + Expect(mockManager.UpdatePluginConfigCalls).To(HaveLen(1)) + Expect(mockManager.UpdatePluginConfigCalls[0].ConfigJSON).To(Equal(`{"key":"value"}`)) + }) + + It("rejects invalid JSON in config field", func() { + body := bytes.NewBufferString(`{"config":"not valid json"}`) + req := httptest.NewRequest("PUT", "/plugin/test-plugin-1", body) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + req.Header.Set("Content-Type", "application/json") + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusBadRequest)) + Expect(w.Body.String()).To(ContainSubstring("Invalid JSON")) + }) + + It("allows empty config", func() { + // Configure mock to update the repo when UpdatePluginConfig is called + mockManager.UpdatePluginConfigFn = func(ctx context.Context, id, configJSON string) error { + adminCtx := request.WithUser(ctx, adminUser) + p, _ := ds.Plugin(adminCtx).Get(id) + p.Config = configJSON + return ds.Plugin(adminCtx).Put(p) + } + + body := bytes.NewBufferString(`{"config":""}`) + req := httptest.NewRequest("PUT", "/plugin/test-plugin-1", body) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + req.Header.Set("Content-Type", "application/json") + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var plugin model.Plugin + err := json.Unmarshal(w.Body.Bytes(), &plugin) + Expect(err).ToNot(HaveOccurred()) + Expect(plugin.Config).To(Equal("")) + }) + + It("updates users field", func() { + // Configure mock to update the repo when UpdatePluginUsers is called + mockManager.UpdatePluginUsersFn = func(ctx context.Context, id, usersJSON string, allUsers bool) error { + adminCtx := request.WithUser(ctx, adminUser) + p, _ := ds.Plugin(adminCtx).Get(id) + p.Users = usersJSON + p.AllUsers = allUsers + return ds.Plugin(adminCtx).Put(p) + } + + body := bytes.NewBufferString(`{"users":"[\"user1\",\"user2\"]"}`) + req := httptest.NewRequest("PUT", "/plugin/test-plugin-1", body) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + req.Header.Set("Content-Type", "application/json") + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var plugin model.Plugin + err := json.Unmarshal(w.Body.Bytes(), &plugin) + Expect(err).ToNot(HaveOccurred()) + Expect(plugin.Users).To(Equal(`["user1","user2"]`)) + Expect(mockManager.UpdatePluginUsersCalls).To(HaveLen(1)) + Expect(mockManager.UpdatePluginUsersCalls[0].UsersJSON).To(Equal(`["user1","user2"]`)) + }) + + It("updates allUsers field", func() { + // Configure mock to update the repo when UpdatePluginUsers is called + mockManager.UpdatePluginUsersFn = func(ctx context.Context, id, usersJSON string, allUsers bool) error { + adminCtx := request.WithUser(ctx, adminUser) + p, _ := ds.Plugin(adminCtx).Get(id) + p.Users = usersJSON + p.AllUsers = allUsers + return ds.Plugin(adminCtx).Put(p) + } + + body := bytes.NewBufferString(`{"allUsers":true}`) + req := httptest.NewRequest("PUT", "/plugin/test-plugin-1", body) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + req.Header.Set("Content-Type", "application/json") + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var plugin model.Plugin + err := json.Unmarshal(w.Body.Bytes(), &plugin) + Expect(err).ToNot(HaveOccurred()) + Expect(plugin.AllUsers).To(BeTrue()) + Expect(mockManager.UpdatePluginUsersCalls).To(HaveLen(1)) + Expect(mockManager.UpdatePluginUsersCalls[0].AllUsers).To(BeTrue()) + }) + + It("updates both users and allUsers fields together", func() { + // Configure mock to update the repo when UpdatePluginUsers is called + mockManager.UpdatePluginUsersFn = func(ctx context.Context, id, usersJSON string, allUsers bool) error { + adminCtx := request.WithUser(ctx, adminUser) + p, _ := ds.Plugin(adminCtx).Get(id) + p.Users = usersJSON + p.AllUsers = allUsers + return ds.Plugin(adminCtx).Put(p) + } + + body := bytes.NewBufferString(`{"users":"[\"user1\"]","allUsers":false}`) + req := httptest.NewRequest("PUT", "/plugin/test-plugin-1", body) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + req.Header.Set("Content-Type", "application/json") + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var plugin model.Plugin + err := json.Unmarshal(w.Body.Bytes(), &plugin) + Expect(err).ToNot(HaveOccurred()) + Expect(plugin.Users).To(Equal(`["user1"]`)) + Expect(plugin.AllUsers).To(BeFalse()) + Expect(mockManager.UpdatePluginUsersCalls).To(HaveLen(1)) + }) + + It("rejects invalid JSON in users field", func() { + body := bytes.NewBufferString(`{"users":"not valid json"}`) + req := httptest.NewRequest("PUT", "/plugin/test-plugin-1", body) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + req.Header.Set("Content-Type", "application/json") + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusBadRequest)) + Expect(w.Body.String()).To(ContainSubstring("Invalid JSON")) + }) + + It("allows empty users", func() { + // Configure mock to update the repo when UpdatePluginUsers is called + mockManager.UpdatePluginUsersFn = func(ctx context.Context, id, usersJSON string, allUsers bool) error { + adminCtx := request.WithUser(ctx, adminUser) + p, _ := ds.Plugin(adminCtx).Get(id) + p.Users = usersJSON + p.AllUsers = allUsers + return ds.Plugin(adminCtx).Put(p) + } + + body := bytes.NewBufferString(`{"users":""}`) + req := httptest.NewRequest("PUT", "/plugin/test-plugin-1", body) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + req.Header.Set("Content-Type", "application/json") + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var plugin model.Plugin + err := json.Unmarshal(w.Body.Bytes(), &plugin) + Expect(err).ToNot(HaveOccurred()) + Expect(plugin.Users).To(Equal("")) + }) + + It("returns 404 for non-existent plugin", func() { + body := bytes.NewBufferString(`{"enabled":true}`) + req := httptest.NewRequest("PUT", "/plugin/non-existent", body) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + req.Header.Set("Content-Type", "application/json") + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusNotFound)) + }) + + It("returns 400 for invalid request body", func() { + body := bytes.NewBufferString(`not json`) + req := httptest.NewRequest("PUT", "/plugin/test-plugin-1", body) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + req.Header.Set("Content-Type", "application/json") + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusBadRequest)) + }) + }) + + Describe("POST /api/plugin/rescan", func() { + It("triggers plugin rescan", func() { + req := httptest.NewRequest("POST", "/plugin/rescan", nil) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(mockManager.RescanPluginsCalls).To(Equal(1)) + }) + + It("returns error when rescan fails", func() { + mockManager.RescanError = errors.New("folder not configured") + + req := httptest.NewRequest("POST", "/plugin/rescan", nil) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusInternalServerError)) + Expect(w.Body.String()).To(ContainSubstring("folder not configured")) + }) + }) + }) + + Describe("as regular user", func() { + var userToken string + + BeforeEach(func() { + var err error + userToken, err = auth.CreateToken(®ularUser) + Expect(err).ToNot(HaveOccurred()) + }) + + It("denies access to GET /api/plugin", func() { + req := httptest.NewRequest("GET", "/plugin", nil) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+userToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusForbidden)) + }) + + It("denies access to GET /api/plugin/{id}", func() { + req := httptest.NewRequest("GET", "/plugin/test-plugin-1", nil) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+userToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusForbidden)) + }) + + It("denies access to PUT /api/plugin/{id}", func() { + body := bytes.NewBufferString(`{"enabled":true}`) + req := httptest.NewRequest("PUT", "/plugin/test-plugin-1", body) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+userToken) + req.Header.Set("Content-Type", "application/json") + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusForbidden)) + }) + + It("denies access to POST /api/plugin/rescan", func() { + req := httptest.NewRequest("POST", "/plugin/rescan", nil) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+userToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusForbidden)) + }) + }) + + Describe("without authentication", func() { + It("denies access to plugin endpoints", func() { + req := httptest.NewRequest("GET", "/plugin", nil) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusUnauthorized)) + }) + }) + }) +}) diff --git a/server/nativeapi/queue.go b/server/nativeapi/queue.go index 0a3136660..a7700c02c 100644 --- a/server/nativeapi/queue.go +++ b/server/nativeapi/queue.go @@ -87,7 +87,7 @@ func getQueue(ds model.DataStore) http.HandlerFunc { return } w.Header().Set("Content-Type", "application/json") - _, _ = w.Write(resp) + _, _ = w.Write(resp) //nolint:gosec } } diff --git a/server/nativeapi/radios.go b/server/nativeapi/radios.go new file mode 100644 index 000000000..701c6c926 --- /dev/null +++ b/server/nativeapi/radios.go @@ -0,0 +1,70 @@ +package nativeapi + +import ( + "context" + "errors" + "io" + "net/http" + + "github.com/deluan/rest" + "github.com/go-chi/chi/v5" + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/server" +) + +func (api *Router) addRadioRoute(r chi.Router) { + constructor := func(ctx context.Context) rest.Repository { + return api.ds.Resource(ctx, model.Radio{}) + } + r.Route("/radio", func(r chi.Router) { + r.Get("/", rest.GetAll(constructor)) + r.Post("/", rest.Post(constructor)) + r.Route("/{id}", func(r chi.Router) { + r.Use(server.URLParamsMiddleware) + r.Get("/", rest.Get(constructor)) + r.Put("/", rest.Put(constructor)) + r.Delete("/", rest.Delete(constructor)) + r.Post("/image", api.uploadRadioImage()) + r.Delete("/image", api.deleteRadioImage()) + }) + }) +} + +func (api *Router) uploadRadioImage() http.HandlerFunc { + return handleImageUpload(func(ctx context.Context, reader io.Reader, ext string) error { + radioID := chi.URLParamFromCtx(ctx, "id") + radio, err := api.ds.Radio(ctx).Get(radioID) + if err != nil { + if errors.Is(err, model.ErrNotFound) { + return model.ErrNotFound + } + return err + } + oldPath := radio.UploadedImagePath() + filename, err := api.imgUpload.SetImage(ctx, consts.EntityRadio, radio.ID, radio.Name, oldPath, reader, ext) + if err != nil { + return err + } + radio.UploadedImage = filename + return api.ds.Radio(ctx).Put(radio, "UploadedImage") + }) +} + +func (api *Router) deleteRadioImage() http.HandlerFunc { + return handleImageDelete(func(ctx context.Context) error { + radioID := chi.URLParamFromCtx(ctx, "id") + radio, err := api.ds.Radio(ctx).Get(radioID) + if err != nil { + if errors.Is(err, model.ErrNotFound) { + return model.ErrNotFound + } + return err + } + if err := api.imgUpload.RemoveImage(ctx, radio.UploadedImagePath()); err != nil { + return err + } + radio.UploadedImage = "" + return api.ds.Radio(ctx).Put(radio, "UploadedImage") + }) +} diff --git a/server/nativeapi/translations.go b/server/nativeapi/translations.go index d47b6e224..685713083 100644 --- a/server/nativeapi/translations.go +++ b/server/nativeapi/translations.go @@ -28,7 +28,7 @@ func newTranslationRepository(context.Context) rest.Repository { type translationRepository struct{} -func (r *translationRepository) Read(id string) (interface{}, error) { +func (r *translationRepository) Read(id string) (any, error) { translations, _ := loadTranslations() if t, ok := translations[id]; ok { return t, nil @@ -43,7 +43,7 @@ func (r *translationRepository) Count(...rest.QueryOptions) (int64, error) { } // ReadAll simple implementation, only returns IDs. Does not support any `options` -func (r *translationRepository) ReadAll(...rest.QueryOptions) (interface{}, error) { +func (r *translationRepository) ReadAll(...rest.QueryOptions) (any, error) { translations, _ := loadTranslations() var result []translation for _, t := range translations { @@ -57,7 +57,7 @@ func (r *translationRepository) EntityName() string { return "translation" } -func (r *translationRepository) NewInstance() interface{} { +func (r *translationRepository) NewInstance() any { return &translation{} } @@ -103,7 +103,7 @@ func loadTranslation(fsys fs.FS, fileName string) (translation translation, err if err != nil { return } - var out map[string]interface{} + var out map[string]any if err = json.Unmarshal(data, &out); err != nil { return } diff --git a/server/nativeapi/translations_test.go b/server/nativeapi/translations_test.go index c49c26c67..06ad7addf 100644 --- a/server/nativeapi/translations_test.go +++ b/server/nativeapi/translations_test.go @@ -24,7 +24,7 @@ var _ = Describe("Translations", func() { filePath := filepath.Join(consts.I18nFolder, name) file, _ := fsys.Open(filePath) data, _ := io.ReadAll(file) - var out map[string]interface{} + var out map[string]any Expect(filepath.Ext(filePath)).To(Equal(".json"), filePath) Expect(json.Unmarshal(data, &out)).To(BeNil(), filePath) @@ -40,7 +40,7 @@ var _ = Describe("Translations", func() { Expect(err).To(BeNil()) Expect(tr.ID).To(Equal("en")) Expect(tr.Name).To(Equal("English")) - var out map[string]interface{} + var out map[string]any Expect(json.Unmarshal([]byte(tr.Data), &out)).To(BeNil()) }) }) diff --git a/server/public/encode_id.go b/server/public/encode_id.go deleted file mode 100644 index 6adf0e71f..000000000 --- a/server/public/encode_id.go +++ /dev/null @@ -1,71 +0,0 @@ -package public - -import ( - "context" - "errors" - "net/http" - "net/url" - "path" - "strconv" - - "github.com/lestrrat-go/jwx/v2/jwt" - "github.com/navidrome/navidrome/consts" - "github.com/navidrome/navidrome/core/auth" - "github.com/navidrome/navidrome/model" - . "github.com/navidrome/navidrome/utils/gg" -) - -func ImageURL(r *http.Request, artID model.ArtworkID, size int) string { - token := encodeArtworkID(artID) - uri := path.Join(consts.URLPathPublicImages, token) - params := url.Values{} - if size > 0 { - params.Add("size", strconv.Itoa(size)) - } - return publicURL(r, uri, params) -} - -func encodeArtworkID(artID model.ArtworkID) string { - token, _ := auth.CreatePublicToken(map[string]any{"id": artID.String()}) - return token -} - -func decodeArtworkID(tokenString string) (model.ArtworkID, error) { - token, err := auth.TokenAuth.Decode(tokenString) - if err != nil { - return model.ArtworkID{}, err - } - if token == nil { - return model.ArtworkID{}, errors.New("unauthorized") - } - err = jwt.Validate(token, jwt.WithRequiredClaim("id")) - if err != nil { - return model.ArtworkID{}, err - } - claims, err := token.AsMap(context.Background()) - if err != nil { - return model.ArtworkID{}, err - } - id, ok := claims["id"].(string) - if !ok { - return model.ArtworkID{}, errors.New("invalid id type") - } - artID, err := model.ParseArtworkID(id) - if err == nil { - return artID, nil - } - // Try to default to mediafile artworkId (if used with a mediafileShare token) - return model.ParseArtworkID("mf-" + id) -} - -func encodeMediafileShare(s model.Share, id string) string { - claims := map[string]any{"id": id} - if s.Format != "" { - claims["f"] = s.Format - } - if s.MaxBitRate != 0 { - claims["b"] = s.MaxBitRate - } - token, _ := auth.CreateExpiringPublicToken(V(s.ExpiresAt), claims) - return token -} diff --git a/server/public/encode_id_test.go b/server/public/encode_id_test.go deleted file mode 100644 index efd252e4e..000000000 --- a/server/public/encode_id_test.go +++ /dev/null @@ -1,39 +0,0 @@ -package public - -import ( - "github.com/go-chi/jwtauth/v5" - "github.com/navidrome/navidrome/core/auth" - "github.com/navidrome/navidrome/model" - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" -) - -var _ = Describe("encodeArtworkID", func() { - Context("Public ID Encoding", func() { - BeforeEach(func() { - auth.TokenAuth = jwtauth.New("HS256", []byte("super secret"), nil) - }) - It("returns a reversible string representation", func() { - id := model.NewArtworkID(model.KindArtistArtwork, "1234", nil) - encoded := encodeArtworkID(id) - decoded, err := decodeArtworkID(encoded) - Expect(err).ToNot(HaveOccurred()) - Expect(decoded).To(Equal(id)) - }) - It("fails to decode an invalid token", func() { - _, err := decodeArtworkID("xx-123") - Expect(err).To(MatchError("invalid JWT")) - }) - It("defaults to kind mediafile", func() { - encoded := encodeArtworkID(model.ArtworkID{}) - id, err := decodeArtworkID(encoded) - Expect(err).ToNot(HaveOccurred()) - Expect(id.Kind).To(Equal(model.KindMediaFileArtwork)) - }) - It("fails to decode a token without an id", func() { - token, _ := auth.CreatePublicToken(map[string]any{}) - _, err := decodeArtworkID(token) - Expect(err).To(HaveOccurred()) - }) - }) -}) diff --git a/server/public/handle_images.go b/server/public/handle_images.go index 55a851c6f..50f9238e5 100644 --- a/server/public/handle_images.go +++ b/server/public/handle_images.go @@ -8,6 +8,7 @@ import ( "time" "github.com/navidrome/navidrome/core/artwork" + "github.com/navidrome/navidrome/core/auth" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/utils/req" @@ -33,7 +34,7 @@ func (pub *Router) handleImages(w http.ResponseWriter, r *http.Request) { artId, err := decodeArtworkID(id) if err != nil { log.Error(r, "Error decoding artwork id", "id", id, err) - http.Error(w, err.Error(), http.StatusBadRequest) + http.Error(w, "invalid request", http.StatusBadRequest) return } size := p.IntOr("size", 0) @@ -59,9 +60,29 @@ func (pub *Router) handleImages(w http.ResponseWriter, r *http.Request) { defer imgReader.Close() w.Header().Set("Cache-Control", "public, max-age=315360000") - w.Header().Set("Last-Modified", lastUpdate.Format(time.RFC1123)) + w.Header().Set("Last-Modified", lastUpdate.Format(http.TimeFormat)) cnt, err := io.Copy(w, imgReader) if err != nil { log.Warn(ctx, "Error sending image", "count", cnt, err) } } + +func decodeArtworkID(tokenString string) (model.ArtworkID, error) { + token, err := auth.TokenAuth.Decode(tokenString) + if err != nil { + return model.ArtworkID{}, err + } + if token == nil { + return model.ArtworkID{}, errors.New("unauthorized") + } + c := auth.ClaimsFromToken(token) + if c.ID == "" { + return model.ArtworkID{}, errors.New("required claim \"id\" not found") + } + artID, err := model.ParseArtworkID(c.ID) + if err == nil { + return artID, nil + } + // Try to default to mediafile artworkId (if used with a mediafileShare token) + return model.ParseArtworkID("mf-" + c.ID) +} diff --git a/server/public/handle_images_test.go b/server/public/handle_images_test.go new file mode 100644 index 000000000..6895241f6 --- /dev/null +++ b/server/public/handle_images_test.go @@ -0,0 +1,25 @@ +package public + +import ( + "github.com/go-chi/jwtauth/v5" + "github.com/navidrome/navidrome/core/auth" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("decodeArtworkID", func() { + BeforeEach(func() { + auth.TokenAuth = jwtauth.New("HS256", []byte("super secret"), nil) + }) + + It("fails to decode an invalid token", func() { + _, err := decodeArtworkID("xx-123") + Expect(err).To(HaveOccurred()) + }) + + It("fails to decode a token without an id", func() { + token, _ := auth.CreatePublicToken(auth.Claims{}) + _, err := decodeArtworkID(token) + Expect(err).To(HaveOccurred()) + }) +}) diff --git a/server/public/handle_shares.go b/server/public/handle_shares.go index 61f3fba71..15e63d4db 100644 --- a/server/public/handle_shares.go +++ b/server/public/handle_shares.go @@ -7,10 +7,13 @@ import ( "path" "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/core/publicurl" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/server" "github.com/navidrome/navidrome/ui" + . "github.com/navidrome/navidrome/utils/gg" "github.com/navidrome/navidrome/utils/req" ) @@ -56,7 +59,7 @@ func (pub *Router) handleM3U(w http.ResponseWriter, r *http.Request) { s = pub.mapShareToM3U(r, *s) w.WriteHeader(http.StatusOK) w.Header().Set("Content-Type", "audio/x-mpegurl") - _, _ = w.Write([]byte(s.ToM3U8())) + _, _ = w.Write([]byte(s.ToM3U8())) //nolint:gosec } func checkShareError(ctx context.Context, w http.ResponseWriter, err error, id string) { @@ -78,7 +81,7 @@ func checkShareError(ctx context.Context, w http.ResponseWriter, err error, id s func (pub *Router) mapShareInfo(r *http.Request, s model.Share) *model.Share { s.URL = ShareURL(r, s.ID) - s.ImageURL = ImageURL(r, s.CoverArtID(), consts.UICoverArtSize) + s.ImageURL = publicurl.ImageURL(r, s.CoverArtID(), consts.UICoverArtSize) for i := range s.Tracks { s.Tracks[i].ID = encodeMediafileShare(s, s.Tracks[i].ID) } @@ -88,7 +91,17 @@ func (pub *Router) mapShareInfo(r *http.Request, s model.Share) *model.Share { func (pub *Router) mapShareToM3U(r *http.Request, s model.Share) *model.Share { for i := range s.Tracks { id := encodeMediafileShare(s, s.Tracks[i].ID) - s.Tracks[i].Path = publicURL(r, path.Join(consts.URLPathPublic, "s", id), nil) + s.Tracks[i].Path = publicurl.PublicURL(r, path.Join(consts.URLPathPublic, "s", id), nil) } return &s } + +func encodeMediafileShare(s model.Share, id string) string { + claims := auth.Claims{ + ID: id, + Format: s.Format, + BitRate: s.MaxBitRate, + } + token, _ := auth.CreateExpiringPublicToken(V(s.ExpiresAt), claims) + return token +} diff --git a/server/public/handle_streams.go b/server/public/handle_streams.go index cf120f0b5..daa09c375 100644 --- a/server/public/handle_streams.go +++ b/server/public/handle_streams.go @@ -1,15 +1,14 @@ package public import ( - "context" "errors" - "io" "net/http" "strconv" - "github.com/lestrrat-go/jwx/v2/jwt" "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/core/stream" "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/utils/req" ) @@ -24,10 +23,24 @@ func (pub *Router) handleStream(w http.ResponseWriter, r *http.Request) { return } - stream, err := pub.streamer.NewStream(ctx, info.id, info.format, info.bitrate, 0) + mf, err := pub.ds.MediaFile(ctx).Get(info.id) + if err != nil { + if errors.Is(err, model.ErrNotFound) { + http.Error(w, "not found", http.StatusNotFound) + } else { + log.Error(ctx, "Error retrieving media file for shared stream", "id", info.id, err) + http.Error(w, "internal error", http.StatusInternalServerError) + } + return + } + + stream, err := pub.streamer.NewStream(ctx, mf, stream.Request{ + Format: info.format, BitRate: info.bitrate, + }) if err != nil { log.Error(ctx, "Error starting shared stream", err) http.Error(w, "invalid request", http.StatusInternalServerError) + return } // Make sure the stream will be closed at the end, to avoid leakage @@ -40,34 +53,9 @@ func (pub *Router) handleStream(w http.ResponseWriter, r *http.Request) { w.Header().Set("X-Content-Type-Options", "nosniff") w.Header().Set("X-Content-Duration", strconv.FormatFloat(float64(stream.Duration()), 'G', -1, 32)) - if stream.Seekable() { - http.ServeContent(w, r, stream.Name(), stream.ModTime(), stream) - } else { - // If the stream doesn't provide a size (i.e. is not seekable), we can't support ranges/content-length - w.Header().Set("Accept-Ranges", "none") - w.Header().Set("Content-Type", stream.ContentType()) - - estimateContentLength := p.BoolOr("estimateContentLength", false) - - // if Client requests the estimated content-length, send it - if estimateContentLength { - length := strconv.Itoa(stream.EstimatedContentLength()) - log.Trace(ctx, "Estimated content-length", "contentLength", length) - w.Header().Set("Content-Length", length) - } - - if r.Method == http.MethodHead { - go func() { _, _ = io.Copy(io.Discard, stream) }() - } else { - c, err := io.Copy(w, stream) - if log.IsGreaterOrEqualTo(log.LevelDebug) { - if err != nil { - log.Error(ctx, "Error sending shared transcoded file", "id", info.id, err) - } else { - log.Trace(ctx, "Success sending shared transcode file", "id", info.id, "size", c) - } - } - } + n, err := stream.Serve(ctx, w, r) + if err != nil || n == 0 { + http.Error(w, "internal error", http.StatusInternalServerError) } } @@ -85,21 +73,13 @@ func decodeStreamInfo(tokenString string) (shareTrackInfo, error) { if token == nil { return shareTrackInfo{}, errors.New("unauthorized") } - err = jwt.Validate(token, jwt.WithRequiredClaim("id")) - if err != nil { - return shareTrackInfo{}, err + c := auth.ClaimsFromToken(token) + if c.ID == "" { + return shareTrackInfo{}, errors.New("required claim \"id\" not found") } - claims, err := token.AsMap(context.Background()) - if err != nil { - return shareTrackInfo{}, err - } - id, ok := claims["id"].(string) - if !ok { - return shareTrackInfo{}, errors.New("invalid id type") - } - resp := shareTrackInfo{} - resp.id = id - resp.format, _ = claims["f"].(string) - resp.bitrate, _ = claims["b"].(int) - return resp, nil + return shareTrackInfo{ + id: c.ID, + format: c.Format, + bitrate: c.BitRate, + }, nil } diff --git a/server/public/public.go b/server/public/public.go index 03ccaeebe..5e3407c19 100644 --- a/server/public/public.go +++ b/server/public/public.go @@ -2,7 +2,6 @@ package public import ( "net/http" - "net/url" "path" "github.com/go-chi/chi/v5" @@ -11,6 +10,8 @@ import ( "github.com/navidrome/navidrome/consts" "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/core/artwork" + "github.com/navidrome/navidrome/core/publicurl" + "github.com/navidrome/navidrome/core/stream" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/server" @@ -20,14 +21,14 @@ import ( type Router struct { http.Handler artwork artwork.Artwork - streamer core.MediaStreamer + streamer stream.MediaStreamer archiver core.Archiver share core.Share assetsHandler http.Handler ds model.DataStore } -func New(ds model.DataStore, artwork artwork.Artwork, streamer core.MediaStreamer, share core.Share, archiver core.Archiver) *Router { +func New(ds model.DataStore, artwork artwork.Artwork, streamer stream.MediaStreamer, share core.Share, archiver core.Archiver) *Router { p := &Router{ds: ds, artwork: artwork, streamer: streamer, share: share, archiver: archiver} shareRoot := path.Join(conf.Server.BasePath, consts.URLPathPublic) p.assetsHandler = http.StripPrefix(shareRoot, http.FileServer(http.FS(ui.BuildAssets()))) @@ -67,19 +68,5 @@ func (pub *Router) routes() http.Handler { func ShareURL(r *http.Request, id string) string { uri := path.Join(consts.URLPathPublic, id) - return publicURL(r, uri, nil) -} - -func publicURL(r *http.Request, u string, params url.Values) string { - if conf.Server.ShareURL != "" { - shareUrl, _ := url.Parse(conf.Server.ShareURL) - buildUrl, _ := url.Parse(u) - buildUrl.Scheme = shareUrl.Scheme - buildUrl.Host = shareUrl.Host - if len(params) > 0 { - buildUrl.RawQuery = params.Encode() - } - return buildUrl.String() - } - return server.AbsoluteURL(r, u, params) + return publicurl.PublicURL(r, uri, nil) } diff --git a/server/public/public_test.go b/server/public/public_test.go deleted file mode 100644 index c45fadf65..000000000 --- a/server/public/public_test.go +++ /dev/null @@ -1,56 +0,0 @@ -package public - -import ( - "net/http" - "net/url" - "path" - - "github.com/navidrome/navidrome/conf" - "github.com/navidrome/navidrome/consts" - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" -) - -var _ = Describe("publicURL", func() { - When("ShareURL is set", func() { - BeforeEach(func() { - conf.Server.ShareURL = "http://share.myotherserver.com" - }) - It("uses the config value instead of AbsoluteURL", func() { - r, _ := http.NewRequest("GET", "https://myserver.com/share/123", nil) - uri := path.Join(consts.URLPathPublic, "123") - actual := publicURL(r, uri, nil) - Expect(actual).To(Equal("http://share.myotherserver.com/share/123")) - }) - It("concatenates params if provided", func() { - r, _ := http.NewRequest("GET", "https://myserver.com/share/123", nil) - uri := path.Join(consts.URLPathPublicImages, "123") - params := url.Values{ - "size": []string{"300"}, - } - actual := publicURL(r, uri, params) - Expect(actual).To(Equal("http://share.myotherserver.com/share/img/123?size=300")) - - }) - }) - When("ShareURL is not set", func() { - BeforeEach(func() { - conf.Server.ShareURL = "" - }) - It("uses AbsoluteURL", func() { - r, _ := http.NewRequest("GET", "https://myserver.com/share/123", nil) - uri := path.Join(consts.URLPathPublic, "123") - actual := publicURL(r, uri, nil) - Expect(actual).To(Equal("https://myserver.com/share/123")) - }) - It("concatenates params if provided", func() { - r, _ := http.NewRequest("GET", "https://myserver.com/share/123", nil) - uri := path.Join(consts.URLPathPublicImages, "123") - params := url.Values{ - "size": []string{"300"}, - } - actual := publicURL(r, uri, params) - Expect(actual).To(Equal("https://myserver.com/share/img/123?size=300")) - }) - }) -}) diff --git a/server/serve_index.go b/server/serve_index.go index 38e646982..6b0c890a6 100644 --- a/server/serve_index.go +++ b/server/serve_index.go @@ -39,7 +39,7 @@ func serveIndex(ds model.DataStore, fs fs.FS, shareInfo *model.Share) http.Handl http.NotFound(w, r) return } - appConfig := map[string]interface{}{ + appConfig := map[string]any{ "version": consts.Version, "firstTime": firstTime, "variousArtistsId": consts.VariousArtistsID, @@ -54,12 +54,14 @@ func serveIndex(ds model.DataStore, fs fs.FS, shareInfo *model.Share) http.Handl "defaultTheme": conf.Server.DefaultTheme, "defaultLanguage": conf.Server.DefaultLanguage, "defaultUIVolume": conf.Server.DefaultUIVolume, + "uiSearchDebounceMs": conf.Server.UISearchDebounceMs, "enableCoverAnimation": conf.Server.EnableCoverAnimation, "enableNowPlaying": conf.Server.EnableNowPlaying, "gaTrackingId": conf.Server.GATrackingID, "losslessFormats": strings.ToUpper(strings.Join(mime.LosslessFormats, ",")), "devActivityPanel": conf.Server.DevActivityPanel, "enableUserEditing": conf.Server.EnableUserEditing, + "enableCoverArtUpload": conf.Server.EnableCoverArtUpload, "enableSharing": conf.Server.EnableSharing, "shareURL": conf.Server.ShareURL, "defaultDownloadableShare": conf.Server.DefaultDownloadableShare, @@ -74,6 +76,8 @@ func serveIndex(ds model.DataStore, fs fs.FS, shareInfo *model.Share) http.Handl "defaultDownsamplingFormat": conf.Server.DefaultDownsamplingFormat, "separator": string(os.PathSeparator), "enableInspect": conf.Server.Inspect.Enabled, + "pluginsEnabled": conf.Server.Plugins.Enabled, + "extAuthLogoutURL": conf.Server.ExtAuth.LogoutURL, } if strings.HasPrefix(conf.Server.UILoginBackgroundURL, "/") { appConfig["loginBackgroundURL"] = path.Join(conf.Server.BasePath, conf.Server.UILoginBackgroundURL) @@ -94,7 +98,7 @@ func serveIndex(ds model.DataStore, fs fs.FS, shareInfo *model.Share) http.Handl if version != "dev" { version = "v" + version } - data := map[string]interface{}{ + data := map[string]any{ "AppConfig": string(appConfigJson), "Version": version, } @@ -144,7 +148,7 @@ type shareTrack struct { Duration float32 `json:"duration,omitempty"` } -func addShareData(r *http.Request, data map[string]interface{}, shareInfo *model.Share) { +func addShareData(r *http.Request, data map[string]any, shareInfo *model.Share) { ctx := r.Context() if shareInfo == nil || shareInfo.ID == "" { return diff --git a/server/serve_index_test.go b/server/serve_index_test.go index 4f179f22a..e08a42643 100644 --- a/server/serve_index_test.go +++ b/server/serve_index_test.go @@ -85,6 +85,7 @@ var _ = Describe("serveIndex", func() { Entry("defaultTheme", func() { conf.Server.DefaultTheme = "Light" }, "defaultTheme", "Light"), Entry("defaultLanguage", func() { conf.Server.DefaultLanguage = "pt" }, "defaultLanguage", "pt"), Entry("defaultUIVolume", func() { conf.Server.DefaultUIVolume = 45 }, "defaultUIVolume", float64(45)), + Entry("uiSearchDebounceMs", func() { conf.Server.UISearchDebounceMs = 500 }, "uiSearchDebounceMs", float64(500)), Entry("enableCoverAnimation", func() { conf.Server.EnableCoverAnimation = true }, "enableCoverAnimation", true), Entry("enableNowPlaying", func() { conf.Server.EnableNowPlaying = true }, "enableNowPlaying", true), Entry("gaTrackingId", func() { conf.Server.GATrackingID = "UA-12345" }, "gaTrackingId", "UA-12345"), @@ -103,6 +104,7 @@ var _ = Describe("serveIndex", func() { Entry("enableUserEditing", func() { conf.Server.EnableUserEditing = false }, "enableUserEditing", false), Entry("enableSharing", func() { conf.Server.EnableSharing = true }, "enableSharing", true), Entry("devNewEventStream", func() { conf.Server.DevNewEventStream = true }, "devNewEventStream", true), + Entry("extAuthLogoutURL", func() { conf.Server.ExtAuth.LogoutURL = "https://auth.example.com/logout" }, "extAuthLogoutURL", "https://auth.example.com/logout"), ) DescribeTable("sets other UI configuration values", diff --git a/server/server.go b/server/server.go index 49391e2b6..b05c20cc5 100644 --- a/server/server.go +++ b/server/server.go @@ -1,13 +1,14 @@ package server import ( - "cmp" + "bytes" "context" + "crypto/tls" + "encoding/pem" "errors" "fmt" "net" "net/http" - "net/url" "os" "path" "strconv" @@ -69,11 +70,18 @@ func (s *Server) Run(ctx context.Context, addr string, port int, tlsCert string, // Determine if TLS is enabled tlsEnabled := tlsCert != "" && tlsKey != "" + // Validate TLS certificates before starting the server + if tlsEnabled { + if err := validateTLSCertificates(tlsCert, tlsKey); err != nil { + return err + } + } + // Create a listener based on the address type (either Unix socket or TCP) var listener net.Listener var err error - if strings.HasPrefix(addr, "unix:") { - socketPath := strings.TrimPrefix(addr, "unix:") + if after, ok := strings.CutPrefix(addr, "unix:"); ok { + socketPath := after listener, err = createUnixSocketFile(socketPath, conf.Server.UnixSocketPerm) if err != nil { return err @@ -89,17 +97,17 @@ func (s *Server) Run(ctx context.Context, addr string, port int, tlsCert string, // Start the server in a new goroutine and send an error signal to errC if there's an error errC := make(chan error) go func() { + var err error if tlsEnabled { // Start the HTTPS server log.Info("Starting server with TLS (HTTPS) enabled", "tlsCert", tlsCert, "tlsKey", tlsKey) - if err := server.ServeTLS(listener, tlsCert, tlsKey); !errors.Is(err, http.ErrServerClosed) { - errC <- err - } + err = server.ServeTLS(listener, tlsCert, tlsKey) } else { // Start the HTTP server - if err := server.Serve(listener); !errors.Is(err, http.ErrServerClosed) { - errC <- err - } + err = server.Serve(listener) + } + if !errors.Is(err, http.ErrServerClosed) { + errC <- err } }() @@ -232,20 +240,55 @@ func (s *Server) frontendAssetsHandler() http.Handler { return r } -func AbsoluteURL(r *http.Request, u string, params url.Values) string { - buildUrl, _ := url.Parse(u) - if strings.HasPrefix(u, "/") { - buildUrl.Path = path.Join(conf.Server.BasePath, buildUrl.Path) - if conf.Server.BaseHost != "" { - buildUrl.Scheme = cmp.Or(conf.Server.BaseScheme, "http") - buildUrl.Host = conf.Server.BaseHost - } else { - buildUrl.Scheme = r.URL.Scheme - buildUrl.Host = r.Host +// validateTLSCertificates validates the TLS certificate and key files before starting the server. +// It provides detailed error messages for common issues like encrypted private keys. +func validateTLSCertificates(certFile, keyFile string) error { + // Read the key file to check for encryption + keyData, err := os.ReadFile(keyFile) //nolint:gosec + if err != nil { + return fmt.Errorf("reading TLS key file: %w", err) + } + + // Parse PEM blocks and check for encryption + block, _ := pem.Decode(keyData) + if block == nil { + return errors.New("TLS key file does not contain a valid PEM block") + } + + // Check for encrypted private key indicators + if isEncryptedPEM(block, keyData) { + return errors.New("TLS private key is encrypted (password-protected). " + + "Navidrome does not support encrypted private keys. " + + "Please decrypt your key using: openssl pkey -in <encrypted-key> -out <decrypted-key>") + } + + // Try to load the certificate pair to validate it + _, err = tls.LoadX509KeyPair(certFile, keyFile) + if err != nil { + return fmt.Errorf("loading TLS certificate/key pair: %w", err) + } + + return nil +} + +// isEncryptedPEM checks if a PEM block represents an encrypted private key. +func isEncryptedPEM(block *pem.Block, rawData []byte) bool { + // Check for PKCS#8 encrypted format (BEGIN ENCRYPTED PRIVATE KEY) + if block.Type == "ENCRYPTED PRIVATE KEY" { + return true + } + + // Check for legacy encrypted format with Proc-Type header + if block.Headers != nil { + if procType, ok := block.Headers["Proc-Type"]; ok && strings.Contains(procType, "ENCRYPTED") { + return true } } - if len(params) > 0 { - buildUrl.RawQuery = params.Encode() + + // Also check raw data for DEK-Info header (in case pem.Decode doesn't parse headers correctly) + if bytes.Contains(rawData, []byte("DEK-Info:")) || bytes.Contains(rawData, []byte("Proc-Type: 4,ENCRYPTED")) { + return true } - return buildUrl.String() + + return false } diff --git a/server/server_test.go b/server/server_test.go index f9a43a802..245fa013a 100644 --- a/server/server_test.go +++ b/server/server_test.go @@ -1,67 +1,22 @@ package server import ( + "context" + "crypto/tls" + "crypto/x509" + "fmt" "io/fs" "net/http" - "net/url" "os" "path/filepath" + "time" - "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/tests" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) -var _ = Describe("AbsoluteURL", func() { - When("BaseURL is empty", func() { - BeforeEach(func() { - conf.Server.BasePath = "" - }) - It("uses the scheme/host from the request", func() { - r, _ := http.NewRequest("GET", "https://myserver.com/rest/ping?id=123", nil) - actual := AbsoluteURL(r, "/share/img/123", url.Values{"a": []string{"xyz"}}) - Expect(actual).To(Equal("https://myserver.com/share/img/123?a=xyz")) - }) - It("does not override provided schema/host", func() { - r, _ := http.NewRequest("GET", "http://localhost/rest/ping?id=123", nil) - actual := AbsoluteURL(r, "http://public.myserver.com/share/img/123", url.Values{"a": []string{"xyz"}}) - Expect(actual).To(Equal("http://public.myserver.com/share/img/123?a=xyz")) - }) - }) - When("BaseURL has only path", func() { - BeforeEach(func() { - conf.Server.BasePath = "/music" - }) - It("uses the scheme/host from the request", func() { - r, _ := http.NewRequest("GET", "https://myserver.com/rest/ping?id=123", nil) - actual := AbsoluteURL(r, "/share/img/123", url.Values{"a": []string{"xyz"}}) - Expect(actual).To(Equal("https://myserver.com/music/share/img/123?a=xyz")) - }) - It("does not override provided schema/host", func() { - r, _ := http.NewRequest("GET", "http://localhost/rest/ping?id=123", nil) - actual := AbsoluteURL(r, "http://public.myserver.com/share/img/123", url.Values{"a": []string{"xyz"}}) - Expect(actual).To(Equal("http://public.myserver.com/share/img/123?a=xyz")) - }) - }) - When("BaseURL has full URL", func() { - BeforeEach(func() { - conf.Server.BaseScheme = "https" - conf.Server.BaseHost = "myserver.com:8080" - conf.Server.BasePath = "/music" - }) - It("use the configured scheme/host/path", func() { - r, _ := http.NewRequest("GET", "https://localhost:4533/rest/ping?id=123", nil) - actual := AbsoluteURL(r, "/share/img/123", url.Values{"a": []string{"xyz"}}) - Expect(actual).To(Equal("https://myserver.com:8080/music/share/img/123?a=xyz")) - }) - It("does not override provided schema/host", func() { - r, _ := http.NewRequest("GET", "http://localhost/rest/ping?id=123", nil) - actual := AbsoluteURL(r, "http://public.myserver.com/share/img/123", url.Values{"a": []string{"xyz"}}) - Expect(actual).To(Equal("http://public.myserver.com/share/img/123?a=xyz")) - }) - }) -}) - var _ = Describe("createUnixSocketFile", func() { var socketPath string @@ -107,3 +62,146 @@ var _ = Describe("createUnixSocketFile", func() { }) }) }) + +var _ = Describe("TLS support", func() { + Describe("validateTLSCertificates", func() { + const testDataDir = "server/testdata" + + When("certificate and key are valid and unencrypted", func() { + It("returns nil", func() { + certFile := filepath.Join(testDataDir, "test_cert.pem") + keyFile := filepath.Join(testDataDir, "test_key.pem") + err := validateTLSCertificates(certFile, keyFile) + Expect(err).ToNot(HaveOccurred()) + }) + }) + + When("private key is encrypted with PKCS#8 format", func() { + It("returns an error with helpful message", func() { + certFile := filepath.Join(testDataDir, "test_cert_encrypted.pem") + keyFile := filepath.Join(testDataDir, "test_key_encrypted.pem") + err := validateTLSCertificates(certFile, keyFile) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("encrypted")) + Expect(err.Error()).To(ContainSubstring("openssl")) + }) + }) + + When("private key is encrypted with legacy format (Proc-Type header)", func() { + It("returns an error with helpful message", func() { + certFile := filepath.Join(testDataDir, "test_cert.pem") + keyFile := filepath.Join(testDataDir, "test_key_encrypted_legacy.pem") + err := validateTLSCertificates(certFile, keyFile) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("encrypted")) + Expect(err.Error()).To(ContainSubstring("openssl")) + }) + }) + + When("key file does not exist", func() { + It("returns an error", func() { + certFile := filepath.Join(testDataDir, "test_cert.pem") + keyFile := filepath.Join(testDataDir, "nonexistent.pem") + err := validateTLSCertificates(certFile, keyFile) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("reading TLS key file")) + }) + }) + + When("key file does not contain valid PEM", func() { + It("returns an error", func() { + // Create a temp file with invalid PEM content + tmpFile, err := os.CreateTemp("", "invalid_key*.pem") + Expect(err).ToNot(HaveOccurred()) + DeferCleanup(func() { + _ = os.Remove(tmpFile.Name()) + }) + _, err = tmpFile.WriteString("not a valid PEM file") + Expect(err).ToNot(HaveOccurred()) + _ = tmpFile.Close() + + certFile := filepath.Join(testDataDir, "test_cert.pem") + err = validateTLSCertificates(certFile, tmpFile.Name()) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("valid PEM block")) + }) + }) + + When("certificate file does not exist", func() { + It("returns an error from tls.LoadX509KeyPair", func() { + certFile := filepath.Join(testDataDir, "nonexistent_cert.pem") + keyFile := filepath.Join(testDataDir, "test_key.pem") + err := validateTLSCertificates(certFile, keyFile) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("loading TLS certificate/key pair")) + }) + }) + }) + + Describe("Server TLS", func() { + const testDataDir = "server/testdata" + + When("server is started with valid TLS certificates", func() { + It("accepts HTTPS connections", func() { + DeferCleanup(configtest.SetupConfig()) + + // Create server with mock dependencies + ds := &tests.MockDataStore{} + server := New(ds, nil, nil) + + // Load the test certificate to create a trusted CA pool + certFile := filepath.Join(testDataDir, "test_cert.pem") + keyFile := filepath.Join(testDataDir, "test_key.pem") + caCert, err := os.ReadFile(certFile) + Expect(err).ToNot(HaveOccurred()) + + caCertPool := x509.NewCertPool() + caCertPool.AppendCertsFromPEM(caCert) + + // Create an HTTPS client that trusts our test certificate + httpClient := &http.Client{ + Timeout: 5 * time.Second, + Transport: &http.Transport{ + TLSClientConfig: &tls.Config{ + RootCAs: caCertPool, + MinVersion: tls.VersionTLS12, + }, + }, + } + + // Start the server in a goroutine + ctx, cancel := context.WithCancel(GinkgoT().Context()) + defer cancel() + + errChan := make(chan error, 1) + go func() { + errChan <- server.Run(ctx, "127.0.0.1", 14534, certFile, keyFile) + }() + + Eventually(func() error { + // Make an HTTPS request to the server + resp, err := httpClient.Get("https://127.0.0.1:14534/ping") + if err != nil { + return err + } + defer resp.Body.Close() + if resp.StatusCode != http.StatusOK { + return fmt.Errorf("unexpected status code: %d", resp.StatusCode) + } + return nil + }, 2*time.Second, 100*time.Millisecond).Should(Succeed()) + + // Stop the server + cancel() + + // Wait for server to stop (with timeout) + select { + case <-errChan: + // Server stopped + case <-time.After(2 * time.Second): + Fail("Server did not stop in time") + } + }) + }) + }) +}) diff --git a/server/subsonic/album_lists_test.go b/server/subsonic/album_lists_test.go index 63c2614cd..ae4ef9bb9 100644 --- a/server/subsonic/album_lists_test.go +++ b/server/subsonic/album_lists_test.go @@ -27,7 +27,7 @@ var _ = Describe("Album Lists", func() { ds = &tests.MockDataStore{} auth.Init(ds) mockRepo = ds.Album(ctx).(*tests.MockAlbumRepo) - router = New(ds, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil) + router = New(ds, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil) w = httptest.NewRecorder() }) diff --git a/server/subsonic/api.go b/server/subsonic/api.go index bb3d20e5c..e91c02aa4 100644 --- a/server/subsonic/api.go +++ b/server/subsonic/api.go @@ -6,6 +6,7 @@ import ( "errors" "fmt" "net/http" + "regexp" "github.com/go-chi/chi/v5" "github.com/go-chi/chi/v5/middleware" @@ -13,12 +14,14 @@ import ( "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/core/artwork" "github.com/navidrome/navidrome/core/external" + lyricssvc "github.com/navidrome/navidrome/core/lyrics" "github.com/navidrome/navidrome/core/metrics" "github.com/navidrome/navidrome/core/playback" + playlistsvc "github.com/navidrome/navidrome/core/playlists" "github.com/navidrome/navidrome/core/scrobbler" + "github.com/navidrome/navidrome/core/stream" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/scanner" "github.com/navidrome/navidrome/server" "github.com/navidrome/navidrome/server/events" "github.com/navidrome/navidrome/server/subsonic/responses" @@ -27,45 +30,51 @@ import ( const Version = "1.16.1" +var validJSIdentifier = regexp.MustCompile(`^[a-zA-Z_$][a-zA-Z0-9_$.]*$`) + type handler = func(*http.Request) (*responses.Subsonic, error) type handlerRaw = func(http.ResponseWriter, *http.Request) (*responses.Subsonic, error) type Router struct { http.Handler - ds model.DataStore - artwork artwork.Artwork - streamer core.MediaStreamer - archiver core.Archiver - players core.Players - provider external.Provider - playlists core.Playlists - scanner scanner.Scanner - broker events.Broker - scrobbler scrobbler.PlayTracker - share core.Share - playback playback.PlaybackServer - metrics metrics.Metrics + ds model.DataStore + artwork artwork.Artwork + streamer stream.MediaStreamer + archiver core.Archiver + players core.Players + provider external.Provider + playlists playlistsvc.Playlists + scanner model.Scanner + broker events.Broker + scrobbler scrobbler.PlayTracker + share core.Share + playback playback.PlaybackServer + metrics metrics.Metrics + lyrics lyricssvc.Lyrics + transcodeDecision stream.TranscodeDecider } -func New(ds model.DataStore, artwork artwork.Artwork, streamer core.MediaStreamer, archiver core.Archiver, - players core.Players, provider external.Provider, scanner scanner.Scanner, broker events.Broker, - playlists core.Playlists, scrobbler scrobbler.PlayTracker, share core.Share, playback playback.PlaybackServer, - metrics metrics.Metrics, +func New(ds model.DataStore, artwork artwork.Artwork, streamer stream.MediaStreamer, archiver core.Archiver, + players core.Players, provider external.Provider, scanner model.Scanner, broker events.Broker, + playlists playlistsvc.Playlists, scrobbler scrobbler.PlayTracker, share core.Share, playback playback.PlaybackServer, + metrics metrics.Metrics, lyrics lyricssvc.Lyrics, transcodeDecision stream.TranscodeDecider, ) *Router { r := &Router{ - ds: ds, - artwork: artwork, - streamer: streamer, - archiver: archiver, - players: players, - provider: provider, - playlists: playlists, - scanner: scanner, - broker: broker, - scrobbler: scrobbler, - share: share, - playback: playback, - metrics: metrics, + ds: ds, + artwork: artwork, + streamer: streamer, + archiver: archiver, + players: players, + provider: provider, + playlists: playlists, + scanner: scanner, + broker: broker, + scrobbler: scrobbler, + share: share, + playback: playback, + metrics: metrics, + lyrics: lyrics, + transcodeDecision: transcodeDecision, } r.Handler = r.routes() return r @@ -119,11 +128,7 @@ func (api *Router) routes() http.Handler { hr(r, "getAlbumList2", api.GetAlbumList2) h(r, "getStarred", api.GetStarred) h(r, "getStarred2", api.GetStarred2) - if conf.Server.EnableNowPlaying { - h(r, "getNowPlaying", api.GetNowPlaying) - } else { - h501(r, "getNowPlaying") - } + h(r, "getNowPlaying", api.GetNowPlaying) h(r, "getRandomSongs", api.GetRandomSongs) h(r, "getSongsByGenre", api.GetSongsByGenre) }) @@ -148,7 +153,9 @@ func (api *Router) routes() http.Handler { h(r, "createBookmark", api.CreateBookmark) h(r, "deleteBookmark", api.DeleteBookmark) h(r, "getPlayQueue", api.GetPlayQueue) + h(r, "getPlayQueueByIndex", api.GetPlayQueueByIndex) h(r, "savePlayQueue", api.SavePlayQueue) + h(r, "savePlayQueueByIndex", api.SavePlayQueueByIndex) }) r.Group(func(r chi.Router) { r.Use(getPlayer(api.players)) @@ -172,6 +179,8 @@ func (api *Router) routes() http.Handler { h(r, "getLyricsBySongId", api.GetLyricsBySongId) hr(r, "stream", api.Stream) hr(r, "download", api.Download) + hr(r, "getTranscodeDecision", api.GetTranscodeDecision) + hr(r, "getTranscodeStream", api.GetTranscodeStream) }) r.Group(func(r chi.Router) { // configure request throttling @@ -290,6 +299,8 @@ func mapToSubsonicError(err error) subError { err = newError(responses.ErrorGeneric, err.Error()) case errors.Is(err, model.ErrNotFound): err = newError(responses.ErrorDataNotFound, "data not found") + case errors.Is(err, model.ErrNotAuthorized): + err = newError(responses.ErrorAuthorizationFail) default: err = newError(responses.ErrorGeneric, fmt.Sprintf("Internal Server Error: %s", err)) } @@ -318,11 +329,20 @@ func sendResponse(w http.ResponseWriter, r *http.Request, payload *responses.Sub wrapper := &responses.JsonWrapper{Subsonic: *payload} response, err = json.Marshal(wrapper) case "jsonp": - w.Header().Set("Content-Type", "application/javascript") callback, _ := p.String("callback") + if !validJSIdentifier.MatchString(callback) { + log.Warn(r.Context(), "Invalid JSONP callback parameter", "callback", callback) + w.Header().Set("Content-Type", "application/json") + errResp := newResponse() + errResp.Status = responses.StatusFailed + errResp.Error = &responses.Error{Code: responses.ErrorGeneric, Message: "invalid callback parameter"} + response, _ = json.Marshal(responses.JsonWrapper{Subsonic: *errResp}) + break + } + w.Header().Set("Content-Type", "application/javascript") wrapper := &responses.JsonWrapper{Subsonic: *payload} response, err = json.Marshal(wrapper) - response = []byte(fmt.Sprintf("%s(%s)", callback, response)) + response = fmt.Appendf(nil, "%s(%s)", callback, response) default: w.Header().Set("Content-Type", "application/xml") response, err = xml.Marshal(payload) @@ -354,7 +374,7 @@ func sendResponse(w http.ResponseWriter, r *http.Request, payload *responses.Sub } } - if _, err := w.Write(response); err != nil { + if _, err := w.Write(response); err != nil { //nolint:gosec log.Error(r, "Error sending response to client", "endpoint", r.URL.Path, "payload", string(response), err) } } diff --git a/server/subsonic/api_test.go b/server/subsonic/api_test.go index eaecd7c06..3b88704b1 100644 --- a/server/subsonic/api_test.go +++ b/server/subsonic/api_test.go @@ -73,6 +73,49 @@ var _ = Describe("sendResponse", func() { Expect(err).NotTo(HaveOccurred()) Expect(wrapper.Subsonic.Status).To(Equal(payload.Status)) }) + + It("should accept valid callback names with dots", func() { + q := r.URL.Query() + q.Add("f", "jsonp") + q.Add("callback", "jQuery.callback_123") + r.URL.RawQuery = q.Encode() + + sendResponse(w, r, payload) + + body := w.Body.String() + Expect(body).To(HavePrefix("jQuery.callback_123(")) + }) + + It("should reject callback with invalid characters", func() { + q := r.URL.Query() + q.Add("f", "jsonp") + q.Add("callback", "alert(1)//") + r.URL.RawQuery = q.Encode() + + sendResponse(w, r, payload) + + Expect(w.Header().Get("Content-Type")).To(Equal("application/json")) + var wrapper responses.JsonWrapper + err := json.Unmarshal(w.Body.Bytes(), &wrapper) + Expect(err).NotTo(HaveOccurred()) + Expect(wrapper.Subsonic.Status).To(Equal(responses.StatusFailed)) + Expect(wrapper.Subsonic.Error.Message).To(ContainSubstring("invalid callback parameter")) + }) + + It("should reject empty callback parameter", func() { + q := r.URL.Query() + q.Add("f", "jsonp") + q.Add("callback", "") + r.URL.RawQuery = q.Encode() + + sendResponse(w, r, payload) + + Expect(w.Header().Get("Content-Type")).To(Equal("application/json")) + var wrapper responses.JsonWrapper + err := json.Unmarshal(w.Body.Bytes(), &wrapper) + Expect(err).NotTo(HaveOccurred()) + Expect(wrapper.Subsonic.Status).To(Equal(responses.StatusFailed)) + }) }) When("format is XML or unspecified", func() { diff --git a/server/subsonic/bookmarks.go b/server/subsonic/bookmarks.go index d7286c20c..337712750 100644 --- a/server/subsonic/bookmarks.go +++ b/server/subsonic/bookmarks.go @@ -78,7 +78,11 @@ func (api *Router) GetPlayQueue(r *http.Request) (*responses.Subsonic, error) { return nil, err } if pq == nil || len(pq.Items) == 0 { - return newResponse(), nil + response := newResponse() + response.PlayQueue = &responses.PlayQueue{ + Username: user.UserName, + } + return response, nil } response := newResponse() @@ -91,7 +95,7 @@ func (api *Router) GetPlayQueue(r *http.Request) (*responses.Subsonic, error) { Current: currentID, Position: pq.Position, Username: user.UserName, - Changed: &pq.UpdatedAt, + Changed: pq.UpdatedAt, ChangedBy: pq.ChangedBy, } return response, nil @@ -135,3 +139,78 @@ func (api *Router) SavePlayQueue(r *http.Request) (*responses.Subsonic, error) { } return newResponse(), nil } + +func (api *Router) GetPlayQueueByIndex(r *http.Request) (*responses.Subsonic, error) { + user, _ := request.UserFrom(r.Context()) + + repo := api.ds.PlayQueue(r.Context()) + pq, err := repo.RetrieveWithMediaFiles(user.ID) + if err != nil && !errors.Is(err, model.ErrNotFound) { + return nil, err + } + if pq == nil || len(pq.Items) == 0 { + response := newResponse() + response.PlayQueueByIndex = &responses.PlayQueueByIndex{ + Username: user.UserName, + } + return response, nil + } + + response := newResponse() + + var index *int + if len(pq.Items) > 0 { + index = &pq.Current + } + + response.PlayQueueByIndex = &responses.PlayQueueByIndex{ + Entry: slice.MapWithArg(pq.Items, r.Context(), childFromMediaFile), + CurrentIndex: index, + Position: pq.Position, + Username: user.UserName, + Changed: pq.UpdatedAt, + ChangedBy: pq.ChangedBy, + } + return response, nil +} + +func (api *Router) SavePlayQueueByIndex(r *http.Request) (*responses.Subsonic, error) { + p := req.Params(r) + ids, _ := p.Strings("id") + + position := p.Int64Or("position", 0) + + var err error + var currentIndex int + + if len(ids) > 0 { + currentIndex, err = p.Int("currentIndex") + if err != nil || currentIndex < 0 || currentIndex >= len(ids) { + return nil, newError(responses.ErrorMissingParameter, "missing parameter index, err: %s", err) + } + } + + items := slice.Map(ids, func(id string) model.MediaFile { + return model.MediaFile{ID: id} + }) + + user, _ := request.UserFrom(r.Context()) + client, _ := request.ClientFrom(r.Context()) + + pq := &model.PlayQueue{ + UserID: user.ID, + Current: currentIndex, + Position: position, + ChangedBy: client, + Items: items, + CreatedAt: time.Time{}, + UpdatedAt: time.Time{}, + } + + repo := api.ds.PlayQueue(r.Context()) + err = repo.Store(pq) + if err != nil { + return nil, err + } + return newResponse(), nil +} diff --git a/server/subsonic/browsing.go b/server/subsonic/browsing.go index c8584543d..5b9c4f3c9 100644 --- a/server/subsonic/browsing.go +++ b/server/subsonic/browsing.go @@ -8,9 +8,9 @@ import ( "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/core/publicurl" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/server/public" "github.com/navidrome/navidrome/server/subsonic/filter" "github.com/navidrome/navidrome/server/subsonic/responses" "github.com/navidrome/navidrome/utils/req" @@ -230,9 +230,9 @@ func (api *Router) GetAlbumInfo(r *http.Request) (*responses.Subsonic, error) { response := newResponse() response.AlbumInfo = &responses.AlbumInfo{} response.AlbumInfo.Notes = album.Description - response.AlbumInfo.SmallImageUrl = public.ImageURL(r, album.CoverArtID(), 300) - response.AlbumInfo.MediumImageUrl = public.ImageURL(r, album.CoverArtID(), 600) - response.AlbumInfo.LargeImageUrl = public.ImageURL(r, album.CoverArtID(), 1200) + response.AlbumInfo.SmallImageUrl = publicurl.ImageURL(r, album.CoverArtID(), 300) + response.AlbumInfo.MediumImageUrl = publicurl.ImageURL(r, album.CoverArtID(), 600) + response.AlbumInfo.LargeImageUrl = publicurl.ImageURL(r, album.CoverArtID(), 1200) response.AlbumInfo.LastFmUrl = album.ExternalUrl response.AlbumInfo.MusicBrainzID = album.MbzAlbumID @@ -296,9 +296,9 @@ func (api *Router) getArtistInfo(r *http.Request) (*responses.ArtistInfoBase, *m base := responses.ArtistInfoBase{} base.Biography = artist.Biography - base.SmallImageUrl = public.ImageURL(r, artist.CoverArtID(), 300) - base.MediumImageUrl = public.ImageURL(r, artist.CoverArtID(), 600) - base.LargeImageUrl = public.ImageURL(r, artist.CoverArtID(), 1200) + base.SmallImageUrl = publicurl.ImageURL(r, artist.CoverArtID(), 300) + base.MediumImageUrl = publicurl.ImageURL(r, artist.CoverArtID(), 600) + base.LargeImageUrl = publicurl.ImageURL(r, artist.CoverArtID(), 1200) base.LastFmUrl = artist.ExternalUrl base.MusicBrainzID = artist.MbzArtistID @@ -354,7 +354,7 @@ func (api *Router) GetSimilarSongs(r *http.Request) (*responses.Subsonic, error) } count := p.IntOr("count", 50) - songs, err := api.provider.ArtistRadio(ctx, id, count) + songs, err := api.provider.SimilarSongs(ctx, id, count) if err != nil { return nil, err } @@ -410,6 +410,9 @@ func (api *Router) buildArtistDirectory(ctx context.Context, artist *model.Artis } dir.AlbumCount = getArtistAlbumCount(artist) dir.UserRating = int32(artist.Rating) + if conf.Server.Subsonic.EnableAverageRating { + dir.AverageRating = artist.AverageRating + } if artist.Starred { dir.Starred = artist.StarredAt } @@ -440,13 +443,16 @@ func (api *Router) buildArtist(r *http.Request, artist *model.Artist) (*response func (api *Router) buildAlbumDirectory(ctx context.Context, album *model.Album) (*responses.Directory, error) { dir := &responses.Directory{} dir.Id = album.ID - dir.Name = album.Name + dir.Name = album.FullName() dir.Parent = album.AlbumArtistID dir.PlayCount = album.PlayCount if album.PlayCount > 0 { dir.Played = album.PlayDate } dir.UserRating = int32(album.Rating) + if conf.Server.Subsonic.EnableAverageRating { + dir.AverageRating = album.AverageRating + } dir.SongCount = int32(album.SongCount) dir.CoverArt = album.CoverArtID().String() if album.Starred { diff --git a/server/subsonic/helpers.go b/server/subsonic/helpers.go index f9733bb3f..e930aa630 100644 --- a/server/subsonic/helpers.go +++ b/server/subsonic/helpers.go @@ -13,9 +13,9 @@ import ( "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/core/publicurl" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/request" - "github.com/navidrome/navidrome/server/public" "github.com/navidrome/navidrome/server/subsonic/responses" "github.com/navidrome/navidrome/utils/number" "github.com/navidrome/navidrome/utils/req" @@ -34,10 +34,10 @@ func newResponse() *responses.Subsonic { type subError struct { code int32 - messages []interface{} + messages []any } -func newError(code int32, message ...interface{}) error { +func newError(code int32, message ...any) error { return subError{ code: code, messages: message, @@ -99,7 +99,10 @@ func toArtist(r *http.Request, a model.Artist) responses.Artist { Name: a.Name, UserRating: int32(a.Rating), CoverArt: a.CoverArtID().String(), - ArtistImageUrl: public.ImageURL(r, a.CoverArtID(), 600), + ArtistImageUrl: publicurl.ImageURL(r, a.CoverArtID(), 600), + } + if conf.Server.Subsonic.EnableAverageRating { + artist.AverageRating = a.AverageRating } if a.Starred { artist.Starred = a.StarredAt @@ -113,9 +116,12 @@ func toArtistID3(r *http.Request, a model.Artist) responses.ArtistID3 { Name: a.Name, AlbumCount: getArtistAlbumCount(&a), CoverArt: a.CoverArtID().String(), - ArtistImageUrl: public.ImageURL(r, a.CoverArtID(), 600), + ArtistImageUrl: publicurl.ImageURL(r, a.CoverArtID(), 600), UserRating: int32(a.Rating), } + if conf.Server.Subsonic.EnableAverageRating { + artist.AverageRating = a.AverageRating + } if a.Starred { artist.Starred = a.StarredAt } @@ -166,13 +172,32 @@ func getTranscoding(ctx context.Context) (format string, bitRate int) { return } +func isClientInList(clientList, client string) bool { + if clientList == "" || client == "" { + return false + } + clients := strings.SplitSeq(clientList, ",") + for c := range clients { + if strings.TrimSpace(c) == client { + return true + } + } + return false +} + func childFromMediaFile(ctx context.Context, mf model.MediaFile) responses.Child { child := responses.Child{} child.Id = mf.ID child.Title = mf.FullTitle() child.IsDir = false + + player, ok := request.PlayerFrom(ctx) + if ok && isClientInList(conf.Server.Subsonic.MinimalClients, player.Client) { + return child + } + child.Parent = mf.AlbumID - child.Album = mf.Album + child.Album = mf.FullAlbumName() child.Year = int32(mf.Year) child.Artist = mf.Artist child.Genre = mf.Genre @@ -183,7 +208,7 @@ func childFromMediaFile(ctx context.Context, mf model.MediaFile) responses.Child child.BitRate = int32(mf.BitRate) child.CoverArt = mf.CoverArtID().String() child.ContentType = mf.ContentType() - player, ok := request.PlayerFrom(ctx) + if ok && player.ReportRealPath { child.Path = mf.AbsolutePath() } else { @@ -199,6 +224,9 @@ func childFromMediaFile(ctx context.Context, mf model.MediaFile) responses.Child child.Starred = mf.StarredAt } child.UserRating = int32(mf.Rating) + if conf.Server.Subsonic.EnableAverageRating { + child.AverageRating = mf.AverageRating + } format, _ := getTranscoding(ctx) if mf.Suffix != "" && format != "" && mf.Suffix != format { @@ -211,8 +239,8 @@ func childFromMediaFile(ctx context.Context, mf model.MediaFile) responses.Child } func osChildFromMediaFile(ctx context.Context, mf model.MediaFile) *responses.OpenSubsonicChild { - player, _ := request.PlayerFrom(ctx) - if strings.Contains(conf.Server.Subsonic.LegacyClients, player.Client) { + player, ok := request.PlayerFrom(ctx) + if ok && isClientInList(conf.Server.Subsonic.LegacyClients, player.Client) { return nil } child := responses.OpenSubsonicChild{} @@ -274,7 +302,7 @@ func artistRefs(participants model.ParticipantList) []responses.ArtistID3Ref { func fakePath(mf model.MediaFile) string { builder := strings.Builder{} - builder.WriteString(fmt.Sprintf("%s/%s/", sanitizeSlashes(mf.AlbumArtist), sanitizeSlashes(mf.Album))) + builder.WriteString(fmt.Sprintf("%s/%s/", sanitizeSlashes(mf.AlbumArtist), sanitizeSlashes(mf.FullAlbumName()))) if mf.DiscNumber != 0 { builder.WriteString(fmt.Sprintf("%02d-", mf.DiscNumber)) } @@ -293,9 +321,10 @@ func childFromAlbum(ctx context.Context, al model.Album) responses.Child { child := responses.Child{} child.Id = al.ID child.IsDir = true - child.Title = al.Name - child.Name = al.Name - child.Album = al.Name + fullName := al.FullName() + child.Title = fullName + child.Name = fullName + child.Album = fullName child.Artist = al.AlbumArtist child.Year = int32(cmp.Or(al.MaxOriginalYear, al.MaxYear)) child.Genre = al.Genre @@ -310,6 +339,9 @@ func childFromAlbum(ctx context.Context, al model.Album) responses.Child { } child.PlayCount = al.PlayCount child.UserRating = int32(al.Rating) + if conf.Server.Subsonic.EnableAverageRating { + child.AverageRating = al.AverageRating + } child.OpenSubsonicChild = osChildFromAlbum(ctx, al) return child } @@ -360,7 +392,13 @@ func buildDiscSubtitles(a model.Album) []responses.DiscTitle { } var discTitles []responses.DiscTitle for num, title := range a.Discs { - discTitles = append(discTitles, responses.DiscTitle{Disc: int32(num), Title: title}) + artID := model.NewArtworkID(model.KindDiscArtwork, + model.DiscArtworkID(a.ID, num), &a.UpdatedAt) + discTitles = append(discTitles, responses.DiscTitle{ + Disc: int32(num), + Title: title, + CoverArt: artID.String(), + }) } if len(discTitles) == 1 && discTitles[0].Title == "" { return nil @@ -374,7 +412,7 @@ func buildDiscSubtitles(a model.Album) []responses.DiscTitle { func buildAlbumID3(ctx context.Context, album model.Album) responses.AlbumID3 { dir := responses.AlbumID3{} dir.Id = album.ID - dir.Name = album.Name + dir.Name = album.FullName() dir.Artist = album.AlbumArtist dir.ArtistId = album.AlbumArtistID dir.CoverArt = album.CoverArtID().String() @@ -403,6 +441,9 @@ func buildOSAlbumID3(ctx context.Context, album model.Album) *responses.OpenSubs dir.Played = album.PlayDate } dir.UserRating = int32(album.Rating) + if conf.Server.Subsonic.EnableAverageRating { + dir.AverageRating = album.AverageRating + } dir.RecordLabels = slice.Map(album.Tags.Values(model.TagRecordLabel), func(s string) responses.RecordLabel { return responses.RecordLabel{Name: s} }) diff --git a/server/subsonic/helpers_test.go b/server/subsonic/helpers_test.go index a6508d4bb..4eb756b98 100644 --- a/server/subsonic/helpers_test.go +++ b/server/subsonic/helpers_test.go @@ -3,9 +3,12 @@ package subsonic import ( "context" "net/http/httptest" + "time" + "github.com/go-chi/jwtauth/v5" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/core/auth" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/request" "github.com/navidrome/navidrome/server/subsonic/responses" @@ -17,6 +20,7 @@ import ( var _ = Describe("helpers", func() { BeforeEach(func() { DeferCleanup(configtest.SetupConfig()) + auth.TokenAuth = jwtauth.New("HS256", []byte("test secret"), nil) }) Describe("fakePath", func() { @@ -100,27 +104,43 @@ var _ = Describe("helpers", func() { Expect(buildDiscSubtitles(album)).To(BeNil()) }) - It("should return the disc title for a single disc", func() { + It("should return the disc title with cover art for a single disc", func() { + updatedAt := time.Now().Truncate(time.Second) album := model.Album{ + ID: "album1", + UpdatedAt: updatedAt, Discs: map[int]string{ 1: "Special Edition", }, } - Expect(buildDiscSubtitles(album)).To(Equal([]responses.DiscTitle{{Disc: 1, Title: "Special Edition"}})) + result := buildDiscSubtitles(album) + Expect(result).To(HaveLen(1)) + Expect(result[0].Disc).To(Equal(int32(1))) + Expect(result[0].Title).To(Equal("Special Edition")) + expectedArtID := model.NewArtworkID(model.KindDiscArtwork, "album1:1", &updatedAt) + Expect(result[0].CoverArt).To(Equal(expectedArtID.String())) }) - It("should return correct disc titles when album has discs with valid disc numbers", func() { + It("should return correct disc titles with cover art when album has multiple discs", func() { + updatedAt := time.Now().Truncate(time.Second) album := model.Album{ + ID: "album1", + UpdatedAt: updatedAt, Discs: map[int]string{ 1: "Disc 1", 2: "Disc 2", }, } - expected := []responses.DiscTitle{ - {Disc: 1, Title: "Disc 1"}, - {Disc: 2, Title: "Disc 2"}, - } - Expect(buildDiscSubtitles(album)).To(Equal(expected)) + result := buildDiscSubtitles(album) + Expect(result).To(HaveLen(2)) + Expect(result[0].Disc).To(Equal(int32(1))) + Expect(result[0].Title).To(Equal("Disc 1")) + expectedArtID1 := model.NewArtworkID(model.KindDiscArtwork, "album1:1", &updatedAt) + Expect(result[0].CoverArt).To(Equal(expectedArtID1.String())) + Expect(result[1].Disc).To(Equal(int32(2))) + Expect(result[1].Title).To(Equal("Disc 2")) + expectedArtID2 := model.NewArtworkID(model.KindDiscArtwork, "album1:2", &updatedAt) + Expect(result[1].CoverArt).To(Equal(expectedArtID2.String())) }) }) @@ -169,6 +189,198 @@ var _ = Describe("helpers", func() { }) }) + DescribeTable("isClientInList", + func(list, client string, expected bool) { + Expect(isClientInList(list, client)).To(Equal(expected)) + }, + Entry("returns false when clientList is empty", "", "some-client", false), + Entry("returns false when client is empty", "client1,client2", "", false), + Entry("returns false when both are empty", "", "", false), + Entry("returns true when client matches single entry", "my-client", "my-client", true), + Entry("returns true when client matches first in list", "client1,client2,client3", "client1", true), + Entry("returns true when client matches middle in list", "client1,client2,client3", "client2", true), + Entry("returns true when client matches last in list", "client1,client2,client3", "client3", true), + Entry("returns false when client does not match", "client1,client2", "client3", false), + Entry("trims whitespace from client list entries", "client1, client2 , client3", "client2", true), + Entry("does not trim the client parameter", "client1,client2", " client1", false), + ) + + Describe("childFromMediaFile", func() { + var mf model.MediaFile + var ctx context.Context + + BeforeEach(func() { + mf = model.MediaFile{ + ID: "mf-1", + Title: "Test Song", + Album: "Test Album", + AlbumID: "album-1", + Artist: "Test Artist", + ArtistID: "artist-1", + Year: 2023, + Genre: "Rock", + TrackNumber: 5, + Duration: 180.5, + Size: 5000000, + Suffix: "mp3", + BitRate: 320, + } + ctx = context.Background() + }) + + Context("with minimal client", func() { + BeforeEach(func() { + conf.Server.Subsonic.MinimalClients = "minimal-client" + player := model.Player{Client: "minimal-client"} + ctx = request.WithPlayer(ctx, player) + }) + + It("returns only basic fields", func() { + child := childFromMediaFile(ctx, mf) + Expect(child.Id).To(Equal("mf-1")) + Expect(child.Title).To(Equal("Test Song")) + Expect(child.IsDir).To(BeFalse()) + + // These should not be set + Expect(child.Album).To(BeEmpty()) + Expect(child.Artist).To(BeEmpty()) + Expect(child.Parent).To(BeEmpty()) + Expect(child.Year).To(BeZero()) + Expect(child.Genre).To(BeEmpty()) + Expect(child.Track).To(BeZero()) + Expect(child.Duration).To(BeZero()) + Expect(child.Size).To(BeZero()) + Expect(child.Suffix).To(BeEmpty()) + Expect(child.BitRate).To(BeZero()) + Expect(child.CoverArt).To(BeEmpty()) + Expect(child.ContentType).To(BeEmpty()) + Expect(child.Path).To(BeEmpty()) + }) + + It("does not include OpenSubsonic extension", func() { + child := childFromMediaFile(ctx, mf) + Expect(child.OpenSubsonicChild).To(BeNil()) + }) + }) + + Context("with non-minimal client", func() { + BeforeEach(func() { + conf.Server.Subsonic.MinimalClients = "minimal-client" + player := model.Player{Client: "regular-client"} + ctx = request.WithPlayer(ctx, player) + }) + + It("returns all fields", func() { + child := childFromMediaFile(ctx, mf) + Expect(child.Id).To(Equal("mf-1")) + Expect(child.Title).To(Equal("Test Song")) + Expect(child.IsDir).To(BeFalse()) + Expect(child.Album).To(Equal("Test Album")) + Expect(child.Artist).To(Equal("Test Artist")) + Expect(child.Parent).To(Equal("album-1")) + Expect(child.Year).To(Equal(int32(2023))) + Expect(child.Genre).To(Equal("Rock")) + Expect(child.Track).To(Equal(int32(5))) + Expect(child.Duration).To(Equal(int32(180))) + Expect(child.Size).To(Equal(int64(5000000))) + Expect(child.Suffix).To(Equal("mp3")) + Expect(child.BitRate).To(Equal(int32(320))) + }) + }) + + Context("when minimal clients list is empty", func() { + BeforeEach(func() { + conf.Server.Subsonic.MinimalClients = "" + player := model.Player{Client: "any-client"} + ctx = request.WithPlayer(ctx, player) + }) + + It("returns all fields", func() { + child := childFromMediaFile(ctx, mf) + Expect(child.Album).To(Equal("Test Album")) + Expect(child.Artist).To(Equal("Test Artist")) + }) + }) + + Context("when no player in context", func() { + It("returns all fields", func() { + child := childFromMediaFile(ctx, mf) + Expect(child.Album).To(Equal("Test Album")) + Expect(child.Artist).To(Equal("Test Artist")) + }) + }) + + Context("when MediaFile has an empty title", func() { + It("still includes the title field in the response", func() { + mf.Title = "" + child := childFromMediaFile(ctx, mf) + Expect(child.Title).To(Equal("")) + }) + }) + }) + + Describe("osChildFromMediaFile", func() { + var mf model.MediaFile + var ctx context.Context + + BeforeEach(func() { + mf = model.MediaFile{ + ID: "mf-1", + Title: "Test Song", + Artist: "Test Artist", + Comment: "Test Comment", + } + ctx = context.Background() + }) + + Context("with legacy client", func() { + BeforeEach(func() { + conf.Server.Subsonic.LegacyClients = "legacy-client" + player := model.Player{Client: "legacy-client"} + ctx = request.WithPlayer(ctx, player) + }) + + It("returns nil", func() { + osChild := osChildFromMediaFile(ctx, mf) + Expect(osChild).To(BeNil()) + }) + }) + + Context("with non-legacy client", func() { + BeforeEach(func() { + conf.Server.Subsonic.LegacyClients = "legacy-client" + player := model.Player{Client: "regular-client"} + ctx = request.WithPlayer(ctx, player) + }) + + It("returns OpenSubsonic child fields", func() { + osChild := osChildFromMediaFile(ctx, mf) + Expect(osChild).ToNot(BeNil()) + Expect(osChild.Comment).To(Equal("Test Comment")) + }) + }) + + Context("when legacy clients list is empty", func() { + BeforeEach(func() { + conf.Server.Subsonic.LegacyClients = "" + player := model.Player{Client: "any-client"} + ctx = request.WithPlayer(ctx, player) + }) + + It("returns OpenSubsonic child fields", func() { + osChild := osChildFromMediaFile(ctx, mf) + Expect(osChild).ToNot(BeNil()) + }) + }) + + Context("when no player in context", func() { + It("returns OpenSubsonic child fields", func() { + osChild := osChildFromMediaFile(ctx, mf) + Expect(osChild).ToNot(BeNil()) + }) + }) + }) + Describe("selectedMusicFolderIds", func() { var user model.User var ctx context.Context @@ -272,4 +484,131 @@ var _ = Describe("helpers", func() { }) }) }) + + Describe("AverageRating in responses", func() { + var ctx context.Context + + BeforeEach(func() { + ctx = context.Background() + conf.Server.Subsonic.EnableAverageRating = true + }) + + Describe("childFromMediaFile", func() { + It("includes averageRating when set", func() { + mf := model.MediaFile{ + ID: "mf-avg-1", + Title: "Test Song", + Annotations: model.Annotations{ + AverageRating: 4.5, + }, + } + child := childFromMediaFile(ctx, mf) + Expect(child.AverageRating).To(Equal(4.5)) + }) + + It("returns 0 for averageRating when not set", func() { + mf := model.MediaFile{ + ID: "mf-avg-2", + Title: "Test Song No Rating", + } + child := childFromMediaFile(ctx, mf) + Expect(child.AverageRating).To(Equal(0.0)) + }) + }) + + Describe("childFromAlbum", func() { + It("includes averageRating when set", func() { + al := model.Album{ + ID: "al-avg-1", + Name: "Test Album", + Annotations: model.Annotations{ + AverageRating: 3.75, + }, + } + child := childFromAlbum(ctx, al) + Expect(child.AverageRating).To(Equal(3.75)) + }) + + It("returns 0 for averageRating when not set", func() { + al := model.Album{ + ID: "al-avg-2", + Name: "Test Album No Rating", + } + child := childFromAlbum(ctx, al) + Expect(child.AverageRating).To(Equal(0.0)) + }) + }) + + Describe("toArtist", func() { + It("includes averageRating when set", func() { + conf.Server.Subsonic.EnableAverageRating = true + r := httptest.NewRequest("GET", "/test", nil) + a := model.Artist{ + ID: "ar-avg-1", + Name: "Test Artist", + Annotations: model.Annotations{ + AverageRating: 5.0, + }, + } + artist := toArtist(r, a) + Expect(artist.AverageRating).To(Equal(5.0)) + }) + }) + + Describe("toArtistID3", func() { + It("includes averageRating when set", func() { + conf.Server.Subsonic.EnableAverageRating = true + r := httptest.NewRequest("GET", "/test", nil) + a := model.Artist{ + ID: "ar-avg-2", + Name: "Test Artist ID3", + Annotations: model.Annotations{ + AverageRating: 2.5, + }, + } + artist := toArtistID3(r, a) + Expect(artist.AverageRating).To(Equal(2.5)) + }) + }) + + Describe("EnableAverageRating config", func() { + It("excludes averageRating when disabled", func() { + conf.Server.Subsonic.EnableAverageRating = false + + mf := model.MediaFile{ + ID: "mf-cfg-1", + Title: "Test Song", + Annotations: model.Annotations{ + AverageRating: 4.5, + }, + } + child := childFromMediaFile(ctx, mf) + Expect(child.AverageRating).To(Equal(0.0)) + + al := model.Album{ + ID: "al-cfg-1", + Name: "Test Album", + Annotations: model.Annotations{ + AverageRating: 3.75, + }, + } + albumChild := childFromAlbum(ctx, al) + Expect(albumChild.AverageRating).To(Equal(0.0)) + + r := httptest.NewRequest("GET", "/test", nil) + a := model.Artist{ + ID: "ar-cfg-1", + Name: "Test Artist", + Annotations: model.Annotations{ + AverageRating: 5.0, + }, + } + artist := toArtist(r, a) + Expect(artist.AverageRating).To(Equal(0.0)) + + artistID3 := toArtistID3(r, a) + Expect(artistID3.AverageRating).To(Equal(0.0)) + }) + }) + }) }) diff --git a/server/subsonic/library_scanning.go b/server/subsonic/library_scanning.go index b6ccb9ae6..bac27f821 100644 --- a/server/subsonic/library_scanning.go +++ b/server/subsonic/library_scanning.go @@ -1,10 +1,13 @@ package subsonic import ( + "fmt" "net/http" + "slices" "time" "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/request" "github.com/navidrome/navidrome/server/subsonic/responses" "github.com/navidrome/navidrome/utils/req" @@ -44,16 +47,89 @@ func (api *Router) StartScan(r *http.Request) (*responses.Subsonic, error) { p := req.Params(r) fullScan := p.BoolOr("fullScan", false) + // Parse optional target parameters for selective scanning + var targets []model.ScanTarget + if targetParams, err := p.Strings("target"); err == nil && len(targetParams) > 0 { + targets, err = model.ParseTargets(targetParams) + if err != nil { + return nil, newError(responses.ErrorGeneric, fmt.Sprintf("Invalid target parameter: %v", err)) + } + + // Validate all libraries in targets exist and user has access to them + userLibraries, err := api.ds.User(ctx).GetUserLibraries(loggedUser.ID) + if err != nil { + return nil, newError(responses.ErrorGeneric, "Internal error") + } + + // Check each target library + for _, target := range targets { + if !slices.ContainsFunc(userLibraries, func(lib model.Library) bool { return lib.ID == target.LibraryID }) { + return nil, newError(responses.ErrorDataNotFound, fmt.Sprintf("Library with ID %d not found", target.LibraryID)) + } + } + + // Special case: if single library with empty path and it's the only library in DB, call ScanAll + if len(targets) == 1 && targets[0].FolderPath == "" { + allLibs, err := api.ds.Library(ctx).GetAll() + if err != nil { + return nil, newError(responses.ErrorGeneric, "Internal error") + } + if len(allLibs) == 1 { + targets = nil // This will trigger ScanAll below + } + } + } + + fastScanCompleted := make(chan struct{}) go func() { + defer close(fastScanCompleted) start := time.Now() - log.Info(ctx, "Triggering manual scan", "fullScan", fullScan, "user", loggedUser.UserName) - _, err := api.scanner.ScanAll(ctx, fullScan) + var err error + + if len(targets) > 0 { + log.Info(ctx, "Triggering on-demand scan", "fullScan", fullScan, "targets", len(targets), "user", loggedUser.UserName) + _, err = api.scanner.ScanFolders(ctx, fullScan, targets) + } else { + log.Info(ctx, "Triggering on-demand scan", "fullScan", fullScan, "user", loggedUser.UserName) + _, err = api.scanner.ScanAll(ctx, fullScan) + } + if err != nil { log.Error(ctx, "Error scanning", err) return } - log.Info(ctx, "Manual scan complete", "user", loggedUser.UserName, "elapsed", time.Since(start)) + log.Info(ctx, "On-demand scan complete", "user", loggedUser.UserName, "elapsed", time.Since(start)) }() + // Wait briefly for the scanner to start and update its status, so the response + // reflects the current scan (not stale data from a previous scan). + const ( + pollInterval = 50 * time.Millisecond + pollTimeout = 3 * time.Second + ) + ticker := time.NewTicker(pollInterval) + defer ticker.Stop() + timer := time.NewTimer(pollTimeout) + defer timer.Stop() + +loop: + for { + status, err := api.scanner.Status(ctx) + if err == nil && status.Scanning { + break + } + select { + case <-fastScanCompleted: + log.Info(ctx, "Fast scan completed", "user", loggedUser.UserName) + break loop + case <-timer.C: + log.Warn(ctx, "Timed out waiting for scanner to start; response may be stale") + break loop + case <-ctx.Done(): + return nil, newError(responses.ErrorGeneric, "Request cancelled while waiting for scanner to start") + case <-ticker.C: + } + } + return api.GetScanStatus(r) } diff --git a/server/subsonic/library_scanning_test.go b/server/subsonic/library_scanning_test.go new file mode 100644 index 000000000..c62c156bc --- /dev/null +++ b/server/subsonic/library_scanning_test.go @@ -0,0 +1,456 @@ +package subsonic + +import ( + "context" + "errors" + "net/http/httptest" + + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/server/subsonic/responses" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("LibraryScanning", func() { + var api *Router + var ms *tests.MockScanner + + BeforeEach(func() { + ms = tests.NewMockScanner() + api = &Router{scanner: ms} + }) + + Describe("StartScan", func() { + It("requires admin authentication", func() { + // Create non-admin user + ctx := request.WithUser(context.Background(), model.User{ + ID: "user-id", + IsAdmin: false, + }) + + // Create request + r := httptest.NewRequest("GET", "/rest/startScan", nil) + r = r.WithContext(ctx) + + // Call endpoint + response, err := api.StartScan(r) + + // Should return authorization error + Expect(err).To(HaveOccurred()) + Expect(response).To(BeNil()) + var subErr subError + ok := errors.As(err, &subErr) + Expect(ok).To(BeTrue()) + Expect(subErr.code).To(Equal(responses.ErrorAuthorizationFail)) + }) + + It("triggers a full scan with no parameters", func() { + // Create admin user + ctx := request.WithUser(context.Background(), model.User{ + ID: "admin-id", + IsAdmin: true, + }) + + // Create request with no parameters + r := httptest.NewRequest("GET", "/rest/startScan", nil) + r = r.WithContext(ctx) + + // Call endpoint + response, err := api.StartScan(r) + + // Should succeed + Expect(err).ToNot(HaveOccurred()) + Expect(response).ToNot(BeNil()) + + // Verify ScanAll was called (eventually, since it's in a goroutine) + Eventually(func() int { + return ms.GetScanAllCallCount() + }).Should(BeNumerically(">", 0)) + calls := ms.GetScanAllCalls() + Expect(calls).To(HaveLen(1)) + Expect(calls[0].FullScan).To(BeFalse()) + }) + + It("triggers a full scan with fullScan=true", func() { + // Create admin user + ctx := request.WithUser(context.Background(), model.User{ + ID: "admin-id", + IsAdmin: true, + }) + + // Create request with fullScan parameter + r := httptest.NewRequest("GET", "/rest/startScan?fullScan=true", nil) + r = r.WithContext(ctx) + + // Call endpoint + response, err := api.StartScan(r) + + // Should succeed + Expect(err).ToNot(HaveOccurred()) + Expect(response).ToNot(BeNil()) + + // Verify ScanAll was called with fullScan=true + Eventually(func() int { + return ms.GetScanAllCallCount() + }).Should(BeNumerically(">", 0)) + calls := ms.GetScanAllCalls() + Expect(calls).To(HaveLen(1)) + Expect(calls[0].FullScan).To(BeTrue()) + }) + + It("triggers a selective scan with single target parameter", func() { + // Setup mocks + mockUserRepo := tests.CreateMockUserRepo() + _ = mockUserRepo.SetUserLibraries("admin-id", []int{1, 2}) + mockDS := &tests.MockDataStore{MockedUser: mockUserRepo} + api.ds = mockDS + + // Create admin user + ctx := request.WithUser(context.Background(), model.User{ + ID: "admin-id", + IsAdmin: true, + }) + + // Create request with single target parameter + r := httptest.NewRequest("GET", "/rest/startScan?target=1:Music/Rock", nil) + r = r.WithContext(ctx) + + // Call endpoint + response, err := api.StartScan(r) + + // Should succeed + Expect(err).ToNot(HaveOccurred()) + Expect(response).ToNot(BeNil()) + + // Verify ScanFolders was called with correct targets + Eventually(func() int { + return ms.GetScanFoldersCallCount() + }).Should(BeNumerically(">", 0)) + calls := ms.GetScanFoldersCalls() + Expect(calls).To(HaveLen(1)) + targets := calls[0].Targets + Expect(targets).To(HaveLen(1)) + Expect(targets[0].LibraryID).To(Equal(1)) + Expect(targets[0].FolderPath).To(Equal("Music/Rock")) + }) + + It("triggers a selective scan with multiple target parameters", func() { + // Setup mocks + mockUserRepo := tests.CreateMockUserRepo() + _ = mockUserRepo.SetUserLibraries("admin-id", []int{1, 2}) + mockDS := &tests.MockDataStore{MockedUser: mockUserRepo} + api.ds = mockDS + + // Create admin user + ctx := request.WithUser(context.Background(), model.User{ + ID: "admin-id", + IsAdmin: true, + }) + + // Create request with multiple target parameters + r := httptest.NewRequest("GET", "/rest/startScan?target=1:Music/Reggae&target=2:Classical/Bach", nil) + r = r.WithContext(ctx) + + // Call endpoint + response, err := api.StartScan(r) + + // Should succeed + Expect(err).ToNot(HaveOccurred()) + Expect(response).ToNot(BeNil()) + + // Verify ScanFolders was called with correct targets + Eventually(func() int { + return ms.GetScanFoldersCallCount() + }).Should(BeNumerically(">", 0)) + calls := ms.GetScanFoldersCalls() + Expect(calls).To(HaveLen(1)) + targets := calls[0].Targets + Expect(targets).To(HaveLen(2)) + Expect(targets[0].LibraryID).To(Equal(1)) + Expect(targets[0].FolderPath).To(Equal("Music/Reggae")) + Expect(targets[1].LibraryID).To(Equal(2)) + Expect(targets[1].FolderPath).To(Equal("Classical/Bach")) + }) + + It("triggers a selective full scan with target and fullScan parameters", func() { + // Setup mocks + mockUserRepo := tests.CreateMockUserRepo() + _ = mockUserRepo.SetUserLibraries("admin-id", []int{1}) + mockDS := &tests.MockDataStore{MockedUser: mockUserRepo} + api.ds = mockDS + + // Create admin user + ctx := request.WithUser(context.Background(), model.User{ + ID: "admin-id", + IsAdmin: true, + }) + + // Create request with target and fullScan parameters + r := httptest.NewRequest("GET", "/rest/startScan?target=1:Music/Jazz&fullScan=true", nil) + r = r.WithContext(ctx) + + // Call endpoint + response, err := api.StartScan(r) + + // Should succeed + Expect(err).ToNot(HaveOccurred()) + Expect(response).ToNot(BeNil()) + + // Verify ScanFolders was called with fullScan=true + Eventually(func() int { + return ms.GetScanFoldersCallCount() + }).Should(BeNumerically(">", 0)) + calls := ms.GetScanFoldersCalls() + Expect(calls).To(HaveLen(1)) + Expect(calls[0].FullScan).To(BeTrue()) + targets := calls[0].Targets + Expect(targets).To(HaveLen(1)) + }) + + It("returns error for invalid target format", func() { + // Create admin user + ctx := request.WithUser(context.Background(), model.User{ + ID: "admin-id", + IsAdmin: true, + }) + + // Create request with invalid target format (missing colon) + r := httptest.NewRequest("GET", "/rest/startScan?target=1MusicRock", nil) + r = r.WithContext(ctx) + + // Call endpoint + response, err := api.StartScan(r) + + // Should return error + Expect(err).To(HaveOccurred()) + Expect(response).To(BeNil()) + var subErr subError + ok := errors.As(err, &subErr) + Expect(ok).To(BeTrue()) + Expect(subErr.code).To(Equal(responses.ErrorGeneric)) + }) + + It("returns error for invalid library ID in target", func() { + // Create admin user + ctx := request.WithUser(context.Background(), model.User{ + ID: "admin-id", + IsAdmin: true, + }) + + // Create request with invalid library ID + r := httptest.NewRequest("GET", "/rest/startScan?target=0:Music/Rock", nil) + r = r.WithContext(ctx) + + // Call endpoint + response, err := api.StartScan(r) + + // Should return error + Expect(err).To(HaveOccurred()) + Expect(response).To(BeNil()) + var subErr subError + ok := errors.As(err, &subErr) + Expect(ok).To(BeTrue()) + Expect(subErr.code).To(Equal(responses.ErrorGeneric)) + }) + + It("returns error when library does not exist", func() { + // Setup mocks - user has access to library 1 and 2 only + mockUserRepo := tests.CreateMockUserRepo() + _ = mockUserRepo.SetUserLibraries("admin-id", []int{1, 2}) + mockDS := &tests.MockDataStore{MockedUser: mockUserRepo} + api.ds = mockDS + + // Create admin user + ctx := request.WithUser(context.Background(), model.User{ + ID: "admin-id", + IsAdmin: true, + }) + + // Create request with library ID that doesn't exist + r := httptest.NewRequest("GET", "/rest/startScan?target=999:Music/Rock", nil) + r = r.WithContext(ctx) + + // Call endpoint + response, err := api.StartScan(r) + + // Should return ErrorDataNotFound + Expect(err).To(HaveOccurred()) + Expect(response).To(BeNil()) + var subErr subError + ok := errors.As(err, &subErr) + Expect(ok).To(BeTrue()) + Expect(subErr.code).To(Equal(responses.ErrorDataNotFound)) + }) + + It("calls ScanAll when single library with empty path and only one library exists", func() { + // Setup mocks - single library in DB + mockUserRepo := tests.CreateMockUserRepo() + _ = mockUserRepo.SetUserLibraries("admin-id", []int{1}) + mockLibraryRepo := &tests.MockLibraryRepo{} + mockLibraryRepo.SetData(model.Libraries{ + {ID: 1, Name: "Music Library", Path: "/music"}, + }) + mockDS := &tests.MockDataStore{ + MockedUser: mockUserRepo, + MockedLibrary: mockLibraryRepo, + } + api.ds = mockDS + + // Create admin user + ctx := request.WithUser(context.Background(), model.User{ + ID: "admin-id", + IsAdmin: true, + }) + + // Create request with single library and empty path + r := httptest.NewRequest("GET", "/rest/startScan?target=1:", nil) + r = r.WithContext(ctx) + + // Call endpoint + response, err := api.StartScan(r) + + // Should succeed + Expect(err).ToNot(HaveOccurred()) + Expect(response).ToNot(BeNil()) + + // Verify ScanAll was called instead of ScanFolders + Eventually(func() int { + return ms.GetScanAllCallCount() + }).Should(BeNumerically(">", 0)) + Expect(ms.GetScanFoldersCallCount()).To(Equal(0)) + }) + + It("calls ScanFolders when single library with empty path but multiple libraries exist", func() { + // Setup mocks - multiple libraries in DB + mockUserRepo := tests.CreateMockUserRepo() + _ = mockUserRepo.SetUserLibraries("admin-id", []int{1, 2}) + mockLibraryRepo := &tests.MockLibraryRepo{} + mockLibraryRepo.SetData(model.Libraries{ + {ID: 1, Name: "Music Library", Path: "/music"}, + {ID: 2, Name: "Audiobooks", Path: "/audiobooks"}, + }) + mockDS := &tests.MockDataStore{ + MockedUser: mockUserRepo, + MockedLibrary: mockLibraryRepo, + } + api.ds = mockDS + + // Create admin user + ctx := request.WithUser(context.Background(), model.User{ + ID: "admin-id", + IsAdmin: true, + }) + + // Create request with single library and empty path + r := httptest.NewRequest("GET", "/rest/startScan?target=1:", nil) + r = r.WithContext(ctx) + + // Call endpoint + response, err := api.StartScan(r) + + // Should succeed + Expect(err).ToNot(HaveOccurred()) + Expect(response).ToNot(BeNil()) + + // Verify ScanFolders was called (not ScanAll) + Eventually(func() int { + return ms.GetScanFoldersCallCount() + }).Should(BeNumerically(">", 0)) + calls := ms.GetScanFoldersCalls() + Expect(calls).To(HaveLen(1)) + targets := calls[0].Targets + Expect(targets).To(HaveLen(1)) + Expect(targets[0].LibraryID).To(Equal(1)) + Expect(targets[0].FolderPath).To(Equal("")) + }) + + It("returns correct scanType in response when fullScan=false", func() { + // Setup mock to update status when scan starts (simulating the real scanner) + ms.SetScanStatusFunc(func(fullScan bool, targets []model.ScanTarget) *model.ScannerStatus { + scanType := "quick" + if fullScan { + scanType = "full" + } + return &model.ScannerStatus{ + Scanning: true, + ScanType: scanType, + } + }) + + ctx := request.WithUser(context.Background(), model.User{ + ID: "admin-id", + IsAdmin: true, + }) + + r := httptest.NewRequest("GET", "/rest/startScan", nil) + r = r.WithContext(ctx) + + response, err := api.StartScan(r) + + Expect(err).ToNot(HaveOccurred()) + Expect(response).ToNot(BeNil()) + Expect(response.ScanStatus).ToNot(BeNil()) + Expect(response.ScanStatus.Scanning).To(BeTrue()) + Expect(response.ScanStatus.ScanType).To(Equal("quick")) + }) + + It("returns correct scanType in response when fullScan=true", func() { + // Setup mock to update status when scan starts (simulating the real scanner) + ms.SetScanStatusFunc(func(fullScan bool, targets []model.ScanTarget) *model.ScannerStatus { + scanType := "quick" + if fullScan { + scanType = "full" + } + return &model.ScannerStatus{ + Scanning: true, + ScanType: scanType, + } + }) + + ctx := request.WithUser(context.Background(), model.User{ + ID: "admin-id", + IsAdmin: true, + }) + + r := httptest.NewRequest("GET", "/rest/startScan?fullScan=true", nil) + r = r.WithContext(ctx) + + response, err := api.StartScan(r) + + Expect(err).ToNot(HaveOccurred()) + Expect(response).ToNot(BeNil()) + Expect(response.ScanStatus).ToNot(BeNil()) + Expect(response.ScanStatus.Scanning).To(BeTrue()) + Expect(response.ScanStatus.ScanType).To(Equal("full")) + }) + }) + + Describe("GetScanStatus", func() { + It("returns scan status", func() { + // Setup mock scanner status + ms.SetStatusResponse(&model.ScannerStatus{ + Scanning: false, + Count: 100, + FolderCount: 10, + }) + + // Create request + ctx := context.Background() + r := httptest.NewRequest("GET", "/rest/getScanStatus", nil) + r = r.WithContext(ctx) + + // Call endpoint + response, err := api.GetScanStatus(r) + + // Should succeed + Expect(err).ToNot(HaveOccurred()) + Expect(response).ToNot(BeNil()) + Expect(response.ScanStatus).ToNot(BeNil()) + Expect(response.ScanStatus.Scanning).To(BeFalse()) + Expect(response.ScanStatus.Count).To(Equal(int64(100))) + Expect(response.ScanStatus.FolderCount).To(Equal(int64(10))) + }) + }) +}) diff --git a/server/subsonic/media_annotation_test.go b/server/subsonic/media_annotation_test.go index 6f09f5349..fc767b0ff 100644 --- a/server/subsonic/media_annotation_test.go +++ b/server/subsonic/media_annotation_test.go @@ -27,7 +27,7 @@ var _ = Describe("MediaAnnotationController", func() { ds = &tests.MockDataStore{} playTracker = &fakePlayTracker{} eventBroker = &fakeEventBroker{} - router = New(ds, nil, nil, nil, nil, nil, nil, eventBroker, nil, playTracker, nil, nil, nil) + router = New(ds, nil, nil, nil, nil, nil, nil, eventBroker, nil, playTracker, nil, nil, nil, nil, nil) }) Describe("Scrobble", func() { diff --git a/server/subsonic/media_retrieval.go b/server/subsonic/media_retrieval.go index a72e4865f..3faae1650 100644 --- a/server/subsonic/media_retrieval.go +++ b/server/subsonic/media_retrieval.go @@ -5,11 +5,11 @@ import ( "errors" "io" "net/http" + "strings" "time" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/consts" - "github.com/navidrome/navidrome/core/lyrics" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/resources" @@ -81,7 +81,7 @@ func (api *Router) GetCoverArt(w http.ResponseWriter, r *http.Request) (*respons defer imgReader.Close() w.Header().Set("cache-control", "public, max-age=315360000") - w.Header().Set("last-modified", lastUpdate.Format(time.RFC1123)) + w.Header().Set("last-modified", lastUpdate.Format(http.TimeFormat)) cnt, err := io.Copy(w, imgReader) if err != nil { @@ -108,7 +108,7 @@ func (api *Router) GetLyrics(r *http.Request) (*responses.Subsonic, error) { return response, nil } - structuredLyrics, err := lyrics.GetLyrics(r.Context(), &mediaFiles[0]) + structuredLyrics, err := api.lyrics.GetLyrics(r.Context(), &mediaFiles[0]) if err != nil { return nil, err } @@ -120,12 +120,12 @@ func (api *Router) GetLyrics(r *http.Request) (*responses.Subsonic, error) { lyricsResponse.Artist = artist lyricsResponse.Title = title - lyricsText := "" + var lyricsText strings.Builder for _, line := range structuredLyrics[0].Line { - lyricsText += line.Value + "\n" + lyricsText.WriteString(line.Value + "\n") } - lyricsResponse.Value = lyricsText + lyricsResponse.Value = lyricsText.String() return response, nil } @@ -141,7 +141,7 @@ func (api *Router) GetLyricsBySongId(r *http.Request) (*responses.Subsonic, erro return nil, err } - structuredLyrics, err := lyrics.GetLyrics(r.Context(), mediaFile) + structuredLyrics, err := api.lyrics.GetLyrics(r.Context(), mediaFile) if err != nil { return nil, err } diff --git a/server/subsonic/media_retrieval_test.go b/server/subsonic/media_retrieval_test.go index 351b4e591..7f64fb47f 100644 --- a/server/subsonic/media_retrieval_test.go +++ b/server/subsonic/media_retrieval_test.go @@ -14,6 +14,7 @@ import ( "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/conf/configtest" "github.com/navidrome/navidrome/core/artwork" + "github.com/navidrome/navidrome/core/lyrics" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/server/subsonic/responses" "github.com/navidrome/navidrome/tests" @@ -33,7 +34,7 @@ var _ = Describe("MediaRetrievalController", func() { MockedMediaFile: mockRepo, } artwork = &fakeArtwork{data: "image data"} - router = New(ds, artwork, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil) + router = New(ds, artwork, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, lyrics.NewLyrics(nil), nil) w = httptest.NewRecorder() DeferCleanup(configtest.SetupConfig()) conf.Server.LyricsPriority = "embedded,.lrc" diff --git a/server/subsonic/middlewares.go b/server/subsonic/middlewares.go index af1ba448f..2d8b1fd94 100644 --- a/server/subsonic/middlewares.go +++ b/server/subsonic/middlewares.go @@ -31,9 +31,11 @@ import ( func postFormToQueryParams(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + r.Body = http.MaxBytesReader(w, r.Body, 10<<20) // 10MB err := r.ParseForm() if err != nil { sendError(w, r, newError(responses.ErrorGeneric, err.Error())) + return } var parts []string for key, values := range r.Form { @@ -56,7 +58,7 @@ func fromInternalOrProxyAuth(r *http.Request) (string, bool) { return username, true } - return server.UsernameFromReverseProxyHeader(r), false + return server.UsernameFromExtAuthHeader(r), false } func checkRequiredParameters(next http.Handler) http.Handler { @@ -159,7 +161,7 @@ func validateCredentials(user *model.User, pass, token, salt, jwt string) error switch { case jwt != "": claims, err := auth.Validate(jwt) - valid = err == nil && claims["sub"] == user.UserName + valid = err == nil && claims.Subject == user.UserName case pass != "": if strings.HasPrefix(pass, "enc:") { if dec, err := hex.DecodeString(pass[4:]); err == nil { diff --git a/server/subsonic/middlewares_test.go b/server/subsonic/middlewares_test.go index a30d5b3af..aba14a0aa 100644 --- a/server/subsonic/middlewares_test.go +++ b/server/subsonic/middlewares_test.go @@ -95,8 +95,8 @@ var _ = Describe("Middlewares", func() { }) It("passes when all required params are available (reverse-proxy case)", func() { - conf.Server.ReverseProxyWhitelist = "127.0.0.234/32" - conf.Server.ReverseProxyUserHeader = "Remote-User" + conf.Server.ExtAuth.TrustedSources = "127.0.0.234/32" + conf.Server.ExtAuth.UserHeader = "Remote-User" r := newGetRequest("v=1.15", "c=test") r.Header.Add("Remote-User", "user") @@ -254,8 +254,8 @@ var _ = Describe("Middlewares", func() { When("using reverse proxy authentication", func() { BeforeEach(func() { DeferCleanup(configtest.SetupConfig()) - conf.Server.ReverseProxyWhitelist = "192.168.1.1/24" - conf.Server.ReverseProxyUserHeader = "Remote-User" + conf.Server.ExtAuth.TrustedSources = "192.168.1.1/24" + conf.Server.ExtAuth.UserHeader = "Remote-User" }) It("passes authentication with correct IP and header", func() { diff --git a/server/subsonic/opensubsonic.go b/server/subsonic/opensubsonic.go index 17ce3c2b0..353cf1077 100644 --- a/server/subsonic/opensubsonic.go +++ b/server/subsonic/opensubsonic.go @@ -12,6 +12,8 @@ func (api *Router) GetOpenSubsonicExtensions(_ *http.Request) (*responses.Subson {Name: "transcodeOffset", Versions: []int32{1}}, {Name: "formPost", Versions: []int32{1}}, {Name: "songLyrics", Versions: []int32{1}}, + {Name: "indexBasedQueue", Versions: []int32{1}}, + {Name: "transcoding", Versions: []int32{1}}, } return response, nil } diff --git a/server/subsonic/opensubsonic_test.go b/server/subsonic/opensubsonic_test.go index 3cc680afe..92d1c3e84 100644 --- a/server/subsonic/opensubsonic_test.go +++ b/server/subsonic/opensubsonic_test.go @@ -19,7 +19,7 @@ var _ = Describe("GetOpenSubsonicExtensions", func() { ) BeforeEach(func() { - router = subsonic.New(nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil) + router = subsonic.New(nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil) w = httptest.NewRecorder() r = httptest.NewRequest("GET", "/getOpenSubsonicExtensions?f=json", nil) }) @@ -35,10 +35,12 @@ var _ = Describe("GetOpenSubsonicExtensions", func() { err := json.Unmarshal(w.Body.Bytes(), &response) Expect(err).NotTo(HaveOccurred()) Expect(*response.Subsonic.OpenSubsonicExtensions).To(SatisfyAll( - HaveLen(3), + HaveLen(5), ContainElement(responses.OpenSubsonicExtension{Name: "transcodeOffset", Versions: []int32{1}}), ContainElement(responses.OpenSubsonicExtension{Name: "formPost", Versions: []int32{1}}), ContainElement(responses.OpenSubsonicExtension{Name: "songLyrics", Versions: []int32{1}}), + ContainElement(responses.OpenSubsonicExtension{Name: "indexBasedQueue", Versions: []int32{1}}), + ContainElement(responses.OpenSubsonicExtension{Name: "transcoding", Versions: []int32{1}}), )) }) }) diff --git a/server/subsonic/playlists.go b/server/subsonic/playlists.go index 23fac6814..baae7514b 100644 --- a/server/subsonic/playlists.go +++ b/server/subsonic/playlists.go @@ -7,23 +7,26 @@ import ( "net/http" "time" + "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/navidrome/navidrome/utils/gg" "github.com/navidrome/navidrome/utils/req" "github.com/navidrome/navidrome/utils/slice" ) func (api *Router) GetPlaylists(r *http.Request) (*responses.Subsonic, error) { ctx := r.Context() - allPls, err := api.ds.Playlist(ctx).GetAll(model.QueryOptions{Sort: "name"}) + allPls, err := api.playlists.GetAll(ctx, model.QueryOptions{Sort: "name"}) if err != nil { log.Error(r, err) return nil, err } response := newResponse() response.Playlists = &responses.Playlists{ - Playlist: slice.Map(allPls, api.buildPlaylist), + Playlist: slice.MapWithArg(allPls, ctx, api.buildPlaylist), } return response, nil } @@ -39,7 +42,7 @@ func (api *Router) GetPlaylist(r *http.Request) (*responses.Subsonic, error) { } func (api *Router) getPlaylist(ctx context.Context, id string) (*responses.Subsonic, error) { - pls, err := api.ds.Playlist(ctx).GetWithTracks(id, true, false) + pls, err := api.playlists.GetWithTracks(ctx, id) if errors.Is(err, model.ErrNotFound) { log.Error(ctx, err.Error(), "id", id) return nil, newError(responses.ErrorDataNotFound, "playlist not found") @@ -51,40 +54,12 @@ func (api *Router) getPlaylist(ctx context.Context, id string) (*responses.Subso response := newResponse() response.Playlist = &responses.PlaylistWithSongs{ - Playlist: api.buildPlaylist(*pls), + Playlist: api.buildPlaylist(ctx, *pls), } response.Playlist.Entry = slice.MapWithArg(pls.MediaFiles(), ctx, childFromMediaFile) return response, nil } -func (api *Router) create(ctx context.Context, playlistId, name string, ids []string) (string, error) { - err := api.ds.WithTxImmediate(func(tx model.DataStore) error { - owner := getUser(ctx) - var pls *model.Playlist - var err error - - if playlistId != "" { - pls, err = tx.Playlist(ctx).Get(playlistId) - if err != nil { - return err - } - if owner.ID != pls.OwnerID { - return model.ErrNotAuthorized - } - } else { - pls = &model.Playlist{Name: name} - pls.OwnerID = owner.ID - } - pls.Tracks = nil - pls.AddMediaFilesByID(ids) - - err = tx.Playlist(ctx).Put(pls) - playlistId = pls.ID - return err - }) - return playlistId, err -} - func (api *Router) CreatePlaylist(r *http.Request) (*responses.Subsonic, error) { ctx := r.Context() p := req.Params(r) @@ -94,7 +69,7 @@ func (api *Router) CreatePlaylist(r *http.Request) (*responses.Subsonic, error) if playlistId == "" && name == "" { return nil, errors.New("required parameter name is missing") } - id, err := api.create(ctx, playlistId, name, songIds) + id, err := api.playlists.Create(ctx, playlistId, name, songIds) if err != nil { log.Error(r, err) return nil, err @@ -108,7 +83,7 @@ func (api *Router) DeletePlaylist(r *http.Request) (*responses.Subsonic, error) if err != nil { return nil, err } - err = api.ds.Playlist(r.Context()).Delete(id) + err = api.playlists.Delete(r.Context(), id) if errors.Is(err, model.ErrNotAuthorized) { return nil, newError(responses.ErrorAuthorizationFail) } @@ -152,21 +127,50 @@ func (api *Router) UpdatePlaylist(r *http.Request) (*responses.Subsonic, error) return newResponse(), nil } -func (api *Router) buildPlaylist(p model.Playlist) responses.Playlist { +func (api *Router) buildPlaylist(ctx context.Context, p model.Playlist) responses.Playlist { pls := responses.Playlist{} pls.Id = p.ID pls.Name = p.Name - pls.Comment = p.Comment pls.SongCount = int32(p.SongCount) - pls.Owner = p.OwnerName pls.Duration = int32(p.Duration) - pls.Public = p.Public pls.Created = p.CreatedAt - pls.CoverArt = p.CoverArtID().String() if p.IsSmartPlaylist() { - pls.Changed = time.Now() + if p.EvaluatedAt != nil { + pls.Changed = *p.EvaluatedAt + } else { + pls.Changed = time.Now() + } } else { pls.Changed = p.UpdatedAt } + + player, ok := request.PlayerFrom(ctx) + if ok && isClientInList(conf.Server.Subsonic.MinimalClients, player.Client) { + return pls + } + + pls.Comment = p.Comment + pls.Owner = p.OwnerName + pls.Public = p.Public + pls.CoverArt = p.CoverArtID().String() + pls.OpenSubsonicPlaylist = buildOSPlaylist(ctx, p) + return pls } + +func buildOSPlaylist(ctx context.Context, p model.Playlist) *responses.OpenSubsonicPlaylist { + pls := responses.OpenSubsonicPlaylist{} + + if p.IsSmartPlaylist() { + pls.Readonly = true + + if p.EvaluatedAt != nil { + pls.ValidUntil = P(p.EvaluatedAt.Add(conf.Server.SmartPlaylistRefreshDelay)) + } + } else { + user, ok := request.UserFrom(ctx) + pls.Readonly = !ok || p.OwnerID != user.ID + } + + return &pls +} diff --git a/server/subsonic/playlists_test.go b/server/subsonic/playlists_test.go index c0a007d6a..41701b4de 100644 --- a/server/subsonic/playlists_test.go +++ b/server/subsonic/playlists_test.go @@ -2,15 +2,219 @@ package subsonic import ( "context" + "time" - "github.com/navidrome/navidrome/core" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/core/playlists" "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/criteria" + "github.com/navidrome/navidrome/model/request" "github.com/navidrome/navidrome/tests" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) -var _ core.Playlists = (*fakePlaylists)(nil) +var _ playlists.Playlists = (*fakePlaylists)(nil) + +var _ = Describe("buildPlaylist", func() { + var router *Router + var ds model.DataStore + var ctx context.Context + var playlist model.Playlist + + BeforeEach(func() { + ds = &tests.MockDataStore{} + router = New(ds, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil) + ctx = context.Background() + }) + + Describe("normal playlist", func() { + BeforeEach(func() { + createdAt := time.Date(2023, 1, 15, 10, 30, 0, 0, time.UTC) + updatedAt := time.Date(2023, 2, 20, 14, 45, 0, 0, time.UTC) + + playlist = model.Playlist{ + ID: "pls-1", + Name: "My Playlist", + Comment: "Test comment", + OwnerName: "admin", + OwnerID: "1234", + Public: true, + SongCount: 10, + Duration: 600, + CreatedAt: createdAt, + UpdatedAt: updatedAt, + } + }) + + Context("with minimal client", func() { + BeforeEach(func() { + conf.Server.Subsonic.MinimalClients = "minimal-client" + player := model.Player{Client: "minimal-client"} + ctx = request.WithPlayer(ctx, player) + }) + + It("returns only basic fields", func() { + result := router.buildPlaylist(ctx, playlist) + + Expect(result.Id).To(Equal("pls-1")) + Expect(result.Name).To(Equal("My Playlist")) + Expect(result.SongCount).To(Equal(int32(10))) + Expect(result.Duration).To(Equal(int32(600))) + Expect(result.Created).To(Equal(playlist.CreatedAt)) + Expect(result.Changed).To(Equal(playlist.UpdatedAt)) + + // These should not be set + Expect(result.Comment).To(BeEmpty()) + Expect(result.Owner).To(BeEmpty()) + Expect(result.Public).To(BeFalse()) + Expect(result.CoverArt).To(BeEmpty()) + }) + }) + + Context("with non-minimal client", func() { + BeforeEach(func() { + conf.Server.Subsonic.MinimalClients = "minimal-client" + player := model.Player{Client: "regular-client"} + ctx = request.WithPlayer(ctx, player) + }) + + It("returns all fields", func() { + result := router.buildPlaylist(ctx, playlist) + + Expect(result.Id).To(Equal("pls-1")) + Expect(result.Name).To(Equal("My Playlist")) + Expect(result.SongCount).To(Equal(int32(10))) + Expect(result.Duration).To(Equal(int32(600))) + Expect(result.Created).To(Equal(playlist.CreatedAt)) + Expect(result.Changed).To(Equal(playlist.UpdatedAt)) + Expect(result.Comment).To(Equal("Test comment")) + Expect(result.Owner).To(Equal("admin")) + Expect(result.Public).To(BeTrue()) + Expect(result.Readonly).To(BeTrue()) + }) + + It("returns all fields when as owner", func() { + ctx = request.WithUser(ctx, model.User{ID: "1234", UserName: "admin"}) + + result := router.buildPlaylist(ctx, playlist) + + Expect(result.Id).To(Equal("pls-1")) + Expect(result.Name).To(Equal("My Playlist")) + Expect(result.SongCount).To(Equal(int32(10))) + Expect(result.Duration).To(Equal(int32(600))) + Expect(result.Created).To(Equal(playlist.CreatedAt)) + Expect(result.Changed).To(Equal(playlist.UpdatedAt)) + Expect(result.Comment).To(Equal("Test comment")) + Expect(result.Owner).To(Equal("admin")) + Expect(result.Public).To(BeTrue()) + Expect(result.Readonly).To(BeFalse()) + }) + }) + + Context("when minimal clients list is empty", func() { + BeforeEach(func() { + conf.Server.Subsonic.MinimalClients = "" + player := model.Player{Client: "any-client"} + ctx = request.WithPlayer(ctx, player) + }) + + It("returns all fields", func() { + result := router.buildPlaylist(ctx, playlist) + + Expect(result.Comment).To(Equal("Test comment")) + Expect(result.Owner).To(Equal("admin")) + Expect(result.Public).To(BeTrue()) + }) + }) + + Context("when no player in context", func() { + It("returns all fields", func() { + result := router.buildPlaylist(ctx, playlist) + + Expect(result.Comment).To(Equal("Test comment")) + Expect(result.Owner).To(Equal("admin")) + Expect(result.Public).To(BeTrue()) + }) + }) + }) + + Describe("smart playlist", func() { + evaluatedAt := time.Date(2023, 2, 20, 15, 45, 0, 0, time.UTC) + validUntil := evaluatedAt.Add(5 * time.Second) + + BeforeEach(func() { + createdAt := time.Date(2023, 1, 15, 10, 30, 0, 0, time.UTC) + updatedAt := time.Date(2023, 2, 20, 14, 45, 0, 0, time.UTC) + + playlist = model.Playlist{ + ID: "pls-1", + Name: "My Playlist", + Comment: "Test comment", + OwnerName: "admin", + OwnerID: "1234", + Public: true, + SongCount: 10, + Duration: 600, + CreatedAt: createdAt, + UpdatedAt: updatedAt, + EvaluatedAt: &evaluatedAt, + Rules: &criteria.Criteria{ + Expression: criteria.All{criteria.Contains{"title": "title"}}, + }, + } + }) + + Context("with minimal client", func() { + BeforeEach(func() { + conf.Server.Subsonic.MinimalClients = "minimal-client" + player := model.Player{Client: "minimal-client"} + ctx = request.WithPlayer(ctx, player) + }) + + It("returns only basic fields", func() { + result := router.buildPlaylist(ctx, playlist) + + Expect(result.Id).To(Equal("pls-1")) + Expect(result.Name).To(Equal("My Playlist")) + Expect(result.SongCount).To(Equal(int32(10))) + Expect(result.Duration).To(Equal(int32(600))) + Expect(result.Created).To(Equal(playlist.CreatedAt)) + Expect(result.Changed).To(Equal(evaluatedAt)) + + // These should not be set + Expect(result.Comment).To(BeEmpty()) + Expect(result.Owner).To(BeEmpty()) + Expect(result.Public).To(BeFalse()) + Expect(result.CoverArt).To(BeEmpty()) + Expect(result.OpenSubsonicPlaylist).To(BeNil()) + }) + }) + + Context("with non-minimal client", func() { + BeforeEach(func() { + conf.Server.Subsonic.MinimalClients = "minimal-client" + player := model.Player{Client: "regular-client"} + ctx = request.WithPlayer(ctx, player) + }) + + It("returns all fields", func() { + result := router.buildPlaylist(ctx, playlist) + Expect(result.Id).To(Equal("pls-1")) + Expect(result.Name).To(Equal("My Playlist")) + Expect(result.SongCount).To(Equal(int32(10))) + Expect(result.Duration).To(Equal(int32(600))) + Expect(result.Created).To(Equal(playlist.CreatedAt)) + Expect(result.Changed).To(Equal(*playlist.EvaluatedAt)) + Expect(result.Comment).To(Equal("Test comment")) + Expect(result.Owner).To(Equal("admin")) + Expect(result.Public).To(BeTrue()) + Expect(result.Readonly).To(BeTrue()) + Expect(result.ValidUntil).To(Equal(&validUntil)) + }) + }) + }) +}) var _ = Describe("UpdatePlaylist", func() { var router *Router @@ -20,7 +224,7 @@ var _ = Describe("UpdatePlaylist", func() { BeforeEach(func() { ds = &tests.MockDataStore{} playlists = &fakePlaylists{} - router = New(ds, nil, nil, nil, nil, nil, nil, nil, playlists, nil, nil, nil, nil) + router = New(ds, nil, nil, nil, nil, nil, nil, nil, playlists, nil, nil, nil, nil, nil, nil) }) It("clears the comment when parameter is empty", func() { @@ -68,7 +272,7 @@ var _ = Describe("UpdatePlaylist", func() { }) type fakePlaylists struct { - core.Playlists + playlists.Playlists lastPlaylistID string lastName *string lastComment *string diff --git a/server/subsonic/radio.go b/server/subsonic/radio.go index 9f2cd48f6..7121566f9 100644 --- a/server/subsonic/radio.go +++ b/server/subsonic/radio.go @@ -2,8 +2,11 @@ package subsonic import ( "net/http" + "strings" + "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" "github.com/navidrome/navidrome/server/subsonic/responses" "github.com/navidrome/navidrome/utils/req" ) @@ -66,6 +69,15 @@ func (api *Router) GetInternetRadios(r *http.Request) (*responses.Subsonic, erro StreamUrl: g.StreamUrl, HomepageUrl: g.HomePageUrl, } + + player, _ := request.PlayerFrom(ctx) + if strings.Contains(conf.Server.Subsonic.LegacyClients, player.Client) { + continue + } + // Add coverArt if not legacy client + res[i].OpenSubsonicRadio = &responses.OpenSubsonicRadio{ + CoverArt: g.UploadedImage, + } } response := newResponse() @@ -103,7 +115,7 @@ func (api *Router) UpdateInternetRadio(r *http.Request) (*responses.Subsonic, er Name: name, } - err = api.ds.Radio(ctx).Put(radio) + err = api.ds.Radio(ctx).Put(radio, "StreamUrl", "HomePageUrl", "Name") if err != nil { return nil, err } diff --git a/server/subsonic/radio_test.go b/server/subsonic/radio_test.go new file mode 100644 index 000000000..d5b764f60 --- /dev/null +++ b/server/subsonic/radio_test.go @@ -0,0 +1,146 @@ +package subsonic + +import ( + "context" + "net/http/httptest" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Radio", func() { + var api *Router + var ds *tests.MockDataStore + var ctx context.Context + var radioRepo *tests.MockedRadioRepo + + BeforeEach(func() { + ds = &tests.MockDataStore{} + auth.Init(ds) + api = &Router{ds: ds} + ctx = context.Background() + radioRepo = tests.CreateMockedRadioRepo() + ds.MockedRadio = radioRepo + }) + + Describe("GetInternetRadios", func() { + BeforeEach(func() { + radioRepo.All = model.Radios{ + {ID: "rd-1", Name: "Radio 1", StreamUrl: "http://stream1.example.com", HomePageUrl: "http://home1.example.com", UploadedImage: "rd-1_cover.jpg"}, + {ID: "rd-2", Name: "Radio 2", StreamUrl: "http://stream2.example.com"}, + } + }) + + It("returns all radios with basic fields", func() { + r := httptest.NewRequest("GET", "/rest/getInternetRadios", nil) + r = r.WithContext(ctx) + + response, err := api.GetInternetRadios(r) + + Expect(err).ToNot(HaveOccurred()) + Expect(response.InternetRadioStations).ToNot(BeNil()) + Expect(response.InternetRadioStations.Radios).To(HaveLen(2)) + Expect(response.InternetRadioStations.Radios[0].ID).To(Equal("rd-1")) + Expect(response.InternetRadioStations.Radios[0].Name).To(Equal("Radio 1")) + Expect(response.InternetRadioStations.Radios[0].StreamUrl).To(Equal("http://stream1.example.com")) + Expect(response.InternetRadioStations.Radios[0].HomepageUrl).To(Equal("http://home1.example.com")) + Expect(response.InternetRadioStations.Radios[1].ID).To(Equal("rd-2")) + Expect(response.InternetRadioStations.Radios[1].HomepageUrl).To(BeEmpty()) + }) + + Context("with a non-legacy client", func() { + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Subsonic.LegacyClients = "legacy-client" + player := model.Player{Client: "modern-client"} + ctx = request.WithPlayer(ctx, player) + }) + + It("includes coverArt from UploadedImage", func() { + r := httptest.NewRequest("GET", "/rest/getInternetRadios", nil) + r = r.WithContext(ctx) + + response, err := api.GetInternetRadios(r) + + Expect(err).ToNot(HaveOccurred()) + Expect(response.InternetRadioStations.Radios).To(HaveLen(2)) + Expect(response.InternetRadioStations.Radios[0].OpenSubsonicRadio).ToNot(BeNil()) + Expect(response.InternetRadioStations.Radios[0].CoverArt).To(Equal("rd-1_cover.jpg")) + Expect(response.InternetRadioStations.Radios[1].OpenSubsonicRadio).ToNot(BeNil()) + Expect(response.InternetRadioStations.Radios[1].CoverArt).To(BeEmpty()) + }) + }) + + Context("with a legacy client", func() { + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Subsonic.LegacyClients = "legacy-client" + player := model.Player{Client: "legacy-client"} + ctx = request.WithPlayer(ctx, player) + }) + + It("does not include coverArt", func() { + r := httptest.NewRequest("GET", "/rest/getInternetRadios", nil) + r = r.WithContext(ctx) + + response, err := api.GetInternetRadios(r) + + Expect(err).ToNot(HaveOccurred()) + Expect(response.InternetRadioStations.Radios).To(HaveLen(2)) + Expect(response.InternetRadioStations.Radios[0].OpenSubsonicRadio).To(BeNil()) + Expect(response.InternetRadioStations.Radios[1].OpenSubsonicRadio).To(BeNil()) + }) + }) + + Context("when no player in context", func() { + It("does not include coverArt (empty client matches legacy list)", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Subsonic.LegacyClients = "legacy-client" + + r := httptest.NewRequest("GET", "/rest/getInternetRadios", nil) + r = r.WithContext(ctx) + + response, err := api.GetInternetRadios(r) + + Expect(err).ToNot(HaveOccurred()) + Expect(response.InternetRadioStations.Radios[0].OpenSubsonicRadio).To(BeNil()) + }) + }) + + Context("when legacy clients list is empty", func() { + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Subsonic.LegacyClients = "" + player := model.Player{Client: "any-client"} + ctx = request.WithPlayer(ctx, player) + }) + + It("includes coverArt for all clients", func() { + r := httptest.NewRequest("GET", "/rest/getInternetRadios", nil) + r = r.WithContext(ctx) + + response, err := api.GetInternetRadios(r) + + Expect(err).ToNot(HaveOccurred()) + Expect(response.InternetRadioStations.Radios[0].OpenSubsonicRadio).ToNot(BeNil()) + Expect(response.InternetRadioStations.Radios[0].CoverArt).To(Equal("rd-1_cover.jpg")) + }) + }) + + It("returns error when repository fails", func() { + radioRepo.SetError(true) + + r := httptest.NewRequest("GET", "/rest/getInternetRadios", nil) + r = r.WithContext(ctx) + + _, err := api.GetInternetRadios(r) + Expect(err).To(HaveOccurred()) + }) + }) +}) diff --git a/server/subsonic/responses/.snapshots/Responses AlbumList with OS data should match .JSON b/server/subsonic/responses/.snapshots/Responses AlbumList with OS data should match .JSON index 0e6425f6a..8491a577b 100644 --- a/server/subsonic/responses/.snapshots/Responses AlbumList with OS data should match .JSON +++ b/server/subsonic/responses/.snapshots/Responses AlbumList with OS data should match .JSON @@ -9,7 +9,7 @@ { "id": "1", "isDir": false, - "isVideo": false, + "title": "", "bpm": 0, "comment": "", "sortName": "sort name", diff --git a/server/subsonic/responses/.snapshots/Responses AlbumList with OS data should match .XML b/server/subsonic/responses/.snapshots/Responses AlbumList with OS data should match .XML index 07200c0c5..5d9e83f96 100644 --- a/server/subsonic/responses/.snapshots/Responses AlbumList with OS data should match .XML +++ b/server/subsonic/responses/.snapshots/Responses AlbumList with OS data should match .XML @@ -1,6 +1,6 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> <albumList> - <album id="1" isDir="false" isVideo="false" sortName="sort name" mediaType="album" musicBrainzId="00000000-0000-0000-0000-000000000000" displayArtist="Display artist" displayAlbumArtist="Display album artist" explicitStatus="explicit"> + <album id="1" isDir="false" title="" sortName="sort name" mediaType="album" musicBrainzId="00000000-0000-0000-0000-000000000000" displayArtist="Display artist" displayAlbumArtist="Display album artist" explicitStatus="explicit"> <genres name="Genre 1"></genres> <genres name="Genre 2"></genres> <moods>mood1</moods> diff --git a/server/subsonic/responses/.snapshots/Responses AlbumList with data should match .JSON b/server/subsonic/responses/.snapshots/Responses AlbumList with data should match .JSON index 946378755..7963b44f4 100644 --- a/server/subsonic/responses/.snapshots/Responses AlbumList with data should match .JSON +++ b/server/subsonic/responses/.snapshots/Responses AlbumList with data should match .JSON @@ -9,8 +9,7 @@ { "id": "1", "isDir": false, - "title": "title", - "isVideo": false + "title": "title" } ] } diff --git a/server/subsonic/responses/.snapshots/Responses AlbumList with data should match .XML b/server/subsonic/responses/.snapshots/Responses AlbumList with data should match .XML index 000b8c00c..693bbfa58 100644 --- a/server/subsonic/responses/.snapshots/Responses AlbumList with data should match .XML +++ b/server/subsonic/responses/.snapshots/Responses AlbumList with data should match .XML @@ -1,5 +1,5 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> <albumList> - <album id="1" isDir="false" title="title" isVideo="false"></album> + <album id="1" isDir="false" title="title"></album> </albumList> </subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 with data should match .JSON b/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 with data should match .JSON index c2a29b22a..07678407a 100644 --- a/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 with data should match .JSON +++ b/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 with data should match .JSON @@ -8,6 +8,7 @@ "id": "1", "name": "album", "artist": "artist", + "duration": 292, "genre": "rock", "userRating": 4, "genres": [ @@ -93,7 +94,6 @@ "transcodedSuffix": "mp3", "duration": 146, "bitRate": 320, - "isVideo": false, "bpm": 127, "comment": "a comment", "sortName": "sorted song", @@ -185,7 +185,6 @@ "transcodedSuffix": "mp3", "duration": 146, "bitRate": 320, - "isVideo": false, "bpm": 0, "comment": "", "sortName": "", diff --git a/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 with data should match .XML b/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 with data should match .XML index 1ad3e600c..f7b23cb4e 100644 --- a/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 with data should match .XML +++ b/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 with data should match .XML @@ -1,5 +1,5 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> - <album id="1" name="album" artist="artist" genre="rock" userRating="4" musicBrainzId="1234" isCompilation="true" sortName="sorted album" displayArtist="artist1 & artist2" explicitStatus="clean" version="Deluxe Edition"> + <album id="1" name="album" artist="artist" duration="292" genre="rock" userRating="4" musicBrainzId="1234" isCompilation="true" sortName="sorted album" displayArtist="artist1 & artist2" explicitStatus="clean" version="Deluxe Edition"> <genres name="rock"></genres> <genres name="progressive"></genres> <discTitles disc="1" title="disc 1"></discTitles> @@ -15,7 +15,7 @@ <moods>sad</moods> <artists id="1" name="artist1"></artists> <artists id="2" name="artist2"></artists> - <song id="1" isDir="true" title="title" album="album" artist="artist" track="1" year="1985" genre="Rock" coverArt="1" size="8421341" contentType="audio/flac" suffix="flac" starred="2016-03-02T20:30:00Z" transcodedContentType="audio/mpeg" transcodedSuffix="mp3" duration="146" bitRate="320" isVideo="false" bpm="127" comment="a comment" sortName="sorted song" mediaType="song" musicBrainzId="4321" channelCount="2" samplingRate="44100" bitDepth="16" displayArtist="artist1 & artist2" displayAlbumArtist="album artist1 & album artist2" displayComposer="composer 1 & composer 2" explicitStatus="clean"> + <song id="1" isDir="true" title="title" album="album" artist="artist" track="1" year="1985" genre="Rock" coverArt="1" size="8421341" contentType="audio/flac" suffix="flac" starred="2016-03-02T20:30:00Z" transcodedContentType="audio/mpeg" transcodedSuffix="mp3" duration="146" bitRate="320" bpm="127" comment="a comment" sortName="sorted song" mediaType="song" musicBrainzId="4321" channelCount="2" samplingRate="44100" bitDepth="16" displayArtist="artist1 & artist2" displayAlbumArtist="album artist1 & album artist2" displayComposer="composer 1 & composer 2" explicitStatus="clean"> <isrc>ISRC-1</isrc> <genres name="rock"></genres> <genres name="progressive"></genres> @@ -33,7 +33,7 @@ <artist id="2" name="artist2"></artist> </contributors> </song> - <song id="2" isDir="true" title="title" album="album" artist="artist" track="1" year="1985" genre="Rock" coverArt="1" size="8421341" contentType="audio/flac" suffix="flac" starred="2016-03-02T20:30:00Z" transcodedContentType="audio/mpeg" transcodedSuffix="mp3" duration="146" bitRate="320" isVideo="false"> + <song id="2" isDir="true" title="title" album="album" artist="artist" track="1" year="1985" genre="Rock" coverArt="1" size="8421341" contentType="audio/flac" suffix="flac" starred="2016-03-02T20:30:00Z" transcodedContentType="audio/mpeg" transcodedSuffix="mp3" duration="146" bitRate="320"> <replayGain trackGain="0" albumGain="0" trackPeak="0" albumPeak="0" baseGain="0" fallbackGain="0"></replayGain> </song> </album> diff --git a/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 without data should match .JSON b/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 without data should match .JSON index fbeded48a..14e96939e 100644 --- a/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 without data should match .JSON +++ b/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 without data should match .JSON @@ -6,6 +6,7 @@ "openSubsonic": true, "album": { "id": "", - "name": "" + "name": "", + "duration": 0 } } diff --git a/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 without data should match .XML b/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 without data should match .XML index 159967c1d..868265347 100644 --- a/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 without data should match .XML +++ b/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 without data should match .XML @@ -1,3 +1,3 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> - <album id="" name=""></album> + <album id="" name="" duration="0"></album> </subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 without data should match OpenSubsonic .JSON b/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 without data should match OpenSubsonic .JSON index 758aef0cb..446368fa5 100644 --- a/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 without data should match OpenSubsonic .JSON +++ b/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 without data should match OpenSubsonic .JSON @@ -7,6 +7,7 @@ "album": { "id": "", "name": "", + "duration": 0, "userRating": 0, "genres": [], "musicBrainzId": "", diff --git a/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 without data should match OpenSubsonic .XML b/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 without data should match OpenSubsonic .XML index 159967c1d..868265347 100644 --- a/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 without data should match OpenSubsonic .XML +++ b/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 without data should match OpenSubsonic .XML @@ -1,3 +1,3 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> - <album id="" name=""></album> + <album id="" name="" duration="0"></album> </subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses Bookmarks with data should match .JSON b/server/subsonic/responses/.snapshots/Responses Bookmarks with data should match .JSON index 7ca38d4db..5b3367e75 100644 --- a/server/subsonic/responses/.snapshots/Responses Bookmarks with data should match .JSON +++ b/server/subsonic/responses/.snapshots/Responses Bookmarks with data should match .JSON @@ -10,8 +10,7 @@ "entry": { "id": "1", "isDir": false, - "title": "title", - "isVideo": false + "title": "title" }, "position": 123, "username": "user2", diff --git a/server/subsonic/responses/.snapshots/Responses Bookmarks with data should match .XML b/server/subsonic/responses/.snapshots/Responses Bookmarks with data should match .XML index 66c57820e..79200bb63 100644 --- a/server/subsonic/responses/.snapshots/Responses Bookmarks with data should match .XML +++ b/server/subsonic/responses/.snapshots/Responses Bookmarks with data should match .XML @@ -1,7 +1,7 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> <bookmarks> <bookmark position="123" username="user2" comment="a comment" created="0001-01-01T00:00:00Z" changed="0001-01-01T00:00:00Z"> - <entry id="1" isDir="false" title="title" isVideo="false"></entry> + <entry id="1" isDir="false" title="title"></entry> </bookmark> </bookmarks> </subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses Child with data should match .JSON b/server/subsonic/responses/.snapshots/Responses Child with data should match .JSON index fde40646a..d20a6d48c 100644 --- a/server/subsonic/responses/.snapshots/Responses Child with data should match .JSON +++ b/server/subsonic/responses/.snapshots/Responses Child with data should match .JSON @@ -24,7 +24,6 @@ "transcodedSuffix": "mp3", "duration": 146, "bitRate": 320, - "isVideo": false, "bpm": 127, "comment": "a comment", "sortName": "sorted title", @@ -116,7 +115,7 @@ { "id": "", "isDir": false, - "isVideo": false, + "title": "", "bpm": 0, "comment": "", "sortName": "", diff --git a/server/subsonic/responses/.snapshots/Responses Child with data should match .XML b/server/subsonic/responses/.snapshots/Responses Child with data should match .XML index faea8ee93..1d307b0b9 100644 --- a/server/subsonic/responses/.snapshots/Responses Child with data should match .XML +++ b/server/subsonic/responses/.snapshots/Responses Child with data should match .XML @@ -1,6 +1,6 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> <directory id="1" name="N"> - <child id="1" isDir="true" title="title" album="album" artist="artist" track="1" year="1985" genre="Rock" coverArt="1" size="8421341" contentType="audio/flac" suffix="flac" starred="2016-03-02T20:30:00Z" transcodedContentType="audio/mpeg" transcodedSuffix="mp3" duration="146" bitRate="320" isVideo="false" bpm="127" comment="a comment" sortName="sorted title" mediaType="song" musicBrainzId="4321" channelCount="2" samplingRate="44100" bitDepth="16" displayArtist="artist 1 & artist 2" displayAlbumArtist="album artist 1 & album artist 2" displayComposer="composer 1 & composer 2" explicitStatus="clean"> + <child id="1" isDir="true" title="title" album="album" artist="artist" track="1" year="1985" genre="Rock" coverArt="1" size="8421341" contentType="audio/flac" suffix="flac" starred="2016-03-02T20:30:00Z" transcodedContentType="audio/mpeg" transcodedSuffix="mp3" duration="146" bitRate="320" bpm="127" comment="a comment" sortName="sorted title" mediaType="song" musicBrainzId="4321" channelCount="2" samplingRate="44100" bitDepth="16" displayArtist="artist 1 & artist 2" displayAlbumArtist="album artist 1 & album artist 2" displayComposer="composer 1 & composer 2" explicitStatus="clean"> <isrc>ISRC-1</isrc> <isrc>ISRC-2</isrc> <genres name="rock"></genres> @@ -25,7 +25,7 @@ <artist id="4" name="composer2"></artist> </contributors> </child> - <child id="" isDir="false" isVideo="false"> + <child id="" isDir="false" title=""> <replayGain trackGain="0" albumGain="0" trackPeak="0" albumPeak="0" baseGain="0" fallbackGain="0"></replayGain> </child> </directory> diff --git a/server/subsonic/responses/.snapshots/Responses Child without data should match .JSON b/server/subsonic/responses/.snapshots/Responses Child without data should match .JSON index 66b49830f..b66a2bdea 100644 --- a/server/subsonic/responses/.snapshots/Responses Child without data should match .JSON +++ b/server/subsonic/responses/.snapshots/Responses Child without data should match .JSON @@ -9,7 +9,7 @@ { "id": "1", "isDir": false, - "isVideo": false + "title": "" } ], "id": "", diff --git a/server/subsonic/responses/.snapshots/Responses Child without data should match .XML b/server/subsonic/responses/.snapshots/Responses Child without data should match .XML index d43b9d3ef..d64d526d6 100644 --- a/server/subsonic/responses/.snapshots/Responses Child without data should match .XML +++ b/server/subsonic/responses/.snapshots/Responses Child without data should match .XML @@ -1,5 +1,5 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> <directory id="" name=""> - <child id="1" isDir="false" isVideo="false"></child> + <child id="1" isDir="false" title=""></child> </directory> </subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses Child without data should match OpenSubsonic .JSON b/server/subsonic/responses/.snapshots/Responses Child without data should match OpenSubsonic .JSON index 1af2ec4a1..25284295e 100644 --- a/server/subsonic/responses/.snapshots/Responses Child without data should match OpenSubsonic .JSON +++ b/server/subsonic/responses/.snapshots/Responses Child without data should match OpenSubsonic .JSON @@ -9,7 +9,7 @@ { "id": "1", "isDir": false, - "isVideo": false, + "title": "", "bpm": 0, "comment": "", "sortName": "", diff --git a/server/subsonic/responses/.snapshots/Responses Child without data should match OpenSubsonic .XML b/server/subsonic/responses/.snapshots/Responses Child without data should match OpenSubsonic .XML index d43b9d3ef..d64d526d6 100644 --- a/server/subsonic/responses/.snapshots/Responses Child without data should match OpenSubsonic .XML +++ b/server/subsonic/responses/.snapshots/Responses Child without data should match OpenSubsonic .XML @@ -1,5 +1,5 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> <directory id="" name=""> - <child id="1" isDir="false" isVideo="false"></child> + <child id="1" isDir="false" title=""></child> </directory> </subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses Directory with data should match .JSON b/server/subsonic/responses/.snapshots/Responses Directory with data should match .JSON index daa7b9c7e..c984c70dc 100644 --- a/server/subsonic/responses/.snapshots/Responses Directory with data should match .JSON +++ b/server/subsonic/responses/.snapshots/Responses Directory with data should match .JSON @@ -9,8 +9,7 @@ { "id": "1", "isDir": false, - "title": "title", - "isVideo": false + "title": "title" } ], "id": "1", diff --git a/server/subsonic/responses/.snapshots/Responses Directory with data should match .XML b/server/subsonic/responses/.snapshots/Responses Directory with data should match .XML index 2ac4f9529..0b1191baf 100644 --- a/server/subsonic/responses/.snapshots/Responses Directory with data should match .XML +++ b/server/subsonic/responses/.snapshots/Responses Directory with data should match .XML @@ -1,5 +1,5 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> <directory id="1" name="N"> - <child id="1" isDir="false" title="title" isVideo="false"></child> + <child id="1" isDir="false" title="title"></child> </directory> </subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses PlayQueue with data should match .JSON b/server/subsonic/responses/.snapshots/Responses PlayQueue with data should match .JSON index eb771692b..e5875873d 100644 --- a/server/subsonic/responses/.snapshots/Responses PlayQueue with data should match .JSON +++ b/server/subsonic/responses/.snapshots/Responses PlayQueue with data should match .JSON @@ -9,8 +9,7 @@ { "id": "1", "isDir": false, - "title": "title", - "isVideo": false + "title": "title" } ], "current": "111", diff --git a/server/subsonic/responses/.snapshots/Responses PlayQueue with data should match .XML b/server/subsonic/responses/.snapshots/Responses PlayQueue with data should match .XML index 1156af0a8..b7a054b8c 100644 --- a/server/subsonic/responses/.snapshots/Responses PlayQueue with data should match .XML +++ b/server/subsonic/responses/.snapshots/Responses PlayQueue with data should match .XML @@ -1,5 +1,5 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> <playQueue current="111" position="243" username="user1" changed="0001-01-01T00:00:00Z" changedBy="a_client"> - <entry id="1" isDir="false" title="title" isVideo="false"></entry> + <entry id="1" isDir="false" title="title"></entry> </playQueue> </subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses PlayQueue without data should match .JSON b/server/subsonic/responses/.snapshots/Responses PlayQueue without data should match .JSON index 88eebb276..70b10c059 100644 --- a/server/subsonic/responses/.snapshots/Responses PlayQueue without data should match .JSON +++ b/server/subsonic/responses/.snapshots/Responses PlayQueue without data should match .JSON @@ -6,6 +6,7 @@ "openSubsonic": true, "playQueue": { "username": "", + "changed": "0001-01-01T00:00:00Z", "changedBy": "" } } diff --git a/server/subsonic/responses/.snapshots/Responses PlayQueue without data should match .XML b/server/subsonic/responses/.snapshots/Responses PlayQueue without data should match .XML index 5af3d9157..597781cbd 100644 --- a/server/subsonic/responses/.snapshots/Responses PlayQueue without data should match .XML +++ b/server/subsonic/responses/.snapshots/Responses PlayQueue without data should match .XML @@ -1,3 +1,3 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> - <playQueue username="" changedBy=""></playQueue> + <playQueue username="" changed="0001-01-01T00:00:00Z" changedBy=""></playQueue> </subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses PlayQueueByIndex with data should match .JSON b/server/subsonic/responses/.snapshots/Responses PlayQueueByIndex with data should match .JSON new file mode 100644 index 000000000..3fa5b6082 --- /dev/null +++ b/server/subsonic/responses/.snapshots/Responses PlayQueueByIndex with data should match .JSON @@ -0,0 +1,21 @@ +{ + "status": "ok", + "version": "1.16.1", + "type": "navidrome", + "serverVersion": "v0.55.0", + "openSubsonic": true, + "playQueueByIndex": { + "entry": [ + { + "id": "1", + "isDir": false, + "title": "title" + } + ], + "currentIndex": 0, + "position": 243, + "username": "user1", + "changed": "0001-01-01T00:00:00Z", + "changedBy": "a_client" + } +} diff --git a/server/subsonic/responses/.snapshots/Responses PlayQueueByIndex with data should match .XML b/server/subsonic/responses/.snapshots/Responses PlayQueueByIndex with data should match .XML new file mode 100644 index 000000000..20f4994da --- /dev/null +++ b/server/subsonic/responses/.snapshots/Responses PlayQueueByIndex with data should match .XML @@ -0,0 +1,5 @@ +<subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> + <playQueueByIndex currentIndex="0" position="243" username="user1" changed="0001-01-01T00:00:00Z" changedBy="a_client"> + <entry id="1" isDir="false" title="title"></entry> + </playQueueByIndex> +</subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses PlayQueueByIndex without data should match .JSON b/server/subsonic/responses/.snapshots/Responses PlayQueueByIndex without data should match .JSON new file mode 100644 index 000000000..ad49a35e5 --- /dev/null +++ b/server/subsonic/responses/.snapshots/Responses PlayQueueByIndex without data should match .JSON @@ -0,0 +1,12 @@ +{ + "status": "ok", + "version": "1.16.1", + "type": "navidrome", + "serverVersion": "v0.55.0", + "openSubsonic": true, + "playQueueByIndex": { + "username": "", + "changed": "0001-01-01T00:00:00Z", + "changedBy": "" + } +} diff --git a/server/subsonic/responses/.snapshots/Responses PlayQueueByIndex without data should match .XML b/server/subsonic/responses/.snapshots/Responses PlayQueueByIndex without data should match .XML new file mode 100644 index 000000000..d99681f4c --- /dev/null +++ b/server/subsonic/responses/.snapshots/Responses PlayQueueByIndex without data should match .XML @@ -0,0 +1,3 @@ +<subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> + <playQueueByIndex username="" changed="0001-01-01T00:00:00Z" changedBy=""></playQueueByIndex> +</subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses Playlists with data should match .JSON b/server/subsonic/responses/.snapshots/Responses Playlists with data should match .JSON index b6e996d6e..963a207d5 100644 --- a/server/subsonic/responses/.snapshots/Responses Playlists with data should match .JSON +++ b/server/subsonic/responses/.snapshots/Responses Playlists with data should match .JSON @@ -14,16 +14,26 @@ "duration": 120, "public": true, "owner": "admin", + "created": "2023-02-20T14:45:00Z", + "changed": "2023-02-20T14:45:00Z", + "coverArt": "pl-123123123123", + "readonly": true, + "validUntil": "2023-02-20T14:45:00Z" + }, + { + "id": "333", + "name": "ccc", + "songCount": 0, + "duration": 0, "created": "0001-01-01T00:00:00Z", "changed": "0001-01-01T00:00:00Z", - "coverArt": "pl-123123123123" + "readonly": false }, { "id": "222", "name": "bbb", "songCount": 0, "duration": 0, - "public": false, "created": "0001-01-01T00:00:00Z", "changed": "0001-01-01T00:00:00Z" } diff --git a/server/subsonic/responses/.snapshots/Responses Playlists with data should match .XML b/server/subsonic/responses/.snapshots/Responses Playlists with data should match .XML index 100301afe..38e0944cf 100644 --- a/server/subsonic/responses/.snapshots/Responses Playlists with data should match .XML +++ b/server/subsonic/responses/.snapshots/Responses Playlists with data should match .XML @@ -1,6 +1,7 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> <playlists> - <playlist id="111" name="aaa" comment="comment" songCount="2" duration="120" public="true" owner="admin" created="0001-01-01T00:00:00Z" changed="0001-01-01T00:00:00Z" coverArt="pl-123123123123"></playlist> + <playlist id="111" name="aaa" comment="comment" songCount="2" duration="120" public="true" owner="admin" created="2023-02-20T14:45:00Z" changed="2023-02-20T14:45:00Z" coverArt="pl-123123123123" readonly="true" validUntil="2023-02-20T14:45:00Z"></playlist> + <playlist id="333" name="ccc" songCount="0" duration="0" public="false" created="0001-01-01T00:00:00Z" changed="0001-01-01T00:00:00Z"></playlist> <playlist id="222" name="bbb" songCount="0" duration="0" public="false" created="0001-01-01T00:00:00Z" changed="0001-01-01T00:00:00Z"></playlist> </playlists> </subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses Shares with data should match .JSON b/server/subsonic/responses/.snapshots/Responses Shares with data should match .JSON index 0c08be37a..cca38ba52 100644 --- a/server/subsonic/responses/.snapshots/Responses Shares with data should match .JSON +++ b/server/subsonic/responses/.snapshots/Responses Shares with data should match .JSON @@ -14,8 +14,7 @@ "title": "title", "album": "album", "artist": "artist", - "duration": 120, - "isVideo": false + "duration": 120 }, { "id": "2", @@ -23,8 +22,7 @@ "title": "title 2", "album": "album", "artist": "artist", - "duration": 300, - "isVideo": false + "duration": 300 } ], "id": "ABC123", diff --git a/server/subsonic/responses/.snapshots/Responses Shares with data should match .XML b/server/subsonic/responses/.snapshots/Responses Shares with data should match .XML index 36cfc25fe..ba63071bf 100644 --- a/server/subsonic/responses/.snapshots/Responses Shares with data should match .XML +++ b/server/subsonic/responses/.snapshots/Responses Shares with data should match .XML @@ -1,8 +1,8 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> <shares> <share id="ABC123" url="http://localhost/p/ABC123" description="Check it out!" username="deluan" created="2016-03-02T20:30:00Z" expires="2016-03-02T20:30:00Z" lastVisited="2016-03-02T20:30:00Z" visitCount="2"> - <entry id="1" isDir="false" title="title" album="album" artist="artist" duration="120" isVideo="false"></entry> - <entry id="2" isDir="false" title="title 2" album="album" artist="artist" duration="300" isVideo="false"></entry> + <entry id="1" isDir="false" title="title" album="album" artist="artist" duration="120"></entry> + <entry id="2" isDir="false" title="title 2" album="album" artist="artist" duration="300"></entry> </share> </shares> </subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses SimilarSongs with data should match .JSON b/server/subsonic/responses/.snapshots/Responses SimilarSongs with data should match .JSON index 7df08ded1..ff30c1a25 100644 --- a/server/subsonic/responses/.snapshots/Responses SimilarSongs with data should match .JSON +++ b/server/subsonic/responses/.snapshots/Responses SimilarSongs with data should match .JSON @@ -9,8 +9,7 @@ { "id": "1", "isDir": false, - "title": "title", - "isVideo": false + "title": "title" } ] } diff --git a/server/subsonic/responses/.snapshots/Responses SimilarSongs with data should match .XML b/server/subsonic/responses/.snapshots/Responses SimilarSongs with data should match .XML index b05443a91..06f07a3bb 100644 --- a/server/subsonic/responses/.snapshots/Responses SimilarSongs with data should match .XML +++ b/server/subsonic/responses/.snapshots/Responses SimilarSongs with data should match .XML @@ -1,5 +1,5 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> <similarSongs> - <song id="1" isDir="false" title="title" isVideo="false"></song> + <song id="1" isDir="false" title="title"></song> </similarSongs> </subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses SimilarSongs2 with data should match .JSON b/server/subsonic/responses/.snapshots/Responses SimilarSongs2 with data should match .JSON index 73eda015e..49331cf11 100644 --- a/server/subsonic/responses/.snapshots/Responses SimilarSongs2 with data should match .JSON +++ b/server/subsonic/responses/.snapshots/Responses SimilarSongs2 with data should match .JSON @@ -9,8 +9,7 @@ { "id": "1", "isDir": false, - "title": "title", - "isVideo": false + "title": "title" } ] } diff --git a/server/subsonic/responses/.snapshots/Responses SimilarSongs2 with data should match .XML b/server/subsonic/responses/.snapshots/Responses SimilarSongs2 with data should match .XML index 0402f031e..4e80da12f 100644 --- a/server/subsonic/responses/.snapshots/Responses SimilarSongs2 with data should match .XML +++ b/server/subsonic/responses/.snapshots/Responses SimilarSongs2 with data should match .XML @@ -1,5 +1,5 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> <similarSongs2> - <song id="1" isDir="false" title="title" isVideo="false"></song> + <song id="1" isDir="false" title="title"></song> </similarSongs2> </subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses TopSongs with data should match .JSON b/server/subsonic/responses/.snapshots/Responses TopSongs with data should match .JSON index 575c9b7fd..1c871a43f 100644 --- a/server/subsonic/responses/.snapshots/Responses TopSongs with data should match .JSON +++ b/server/subsonic/responses/.snapshots/Responses TopSongs with data should match .JSON @@ -9,8 +9,7 @@ { "id": "1", "isDir": false, - "title": "title", - "isVideo": false + "title": "title" } ] } diff --git a/server/subsonic/responses/.snapshots/Responses TopSongs with data should match .XML b/server/subsonic/responses/.snapshots/Responses TopSongs with data should match .XML index 35a77cb6c..8991725b8 100644 --- a/server/subsonic/responses/.snapshots/Responses TopSongs with data should match .XML +++ b/server/subsonic/responses/.snapshots/Responses TopSongs with data should match .XML @@ -1,5 +1,5 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> <topSongs> - <song id="1" isDir="false" title="title" isVideo="false"></song> + <song id="1" isDir="false" title="title"></song> </topSongs> </subsonic-response> diff --git a/server/subsonic/responses/responses.go b/server/subsonic/responses/responses.go index ffda2aa43..f0bb26f66 100644 --- a/server/subsonic/responses/responses.go +++ b/server/subsonic/responses/responses.go @@ -60,6 +60,8 @@ type Subsonic struct { // OpenSubsonic extensions OpenSubsonicExtensions *OpenSubsonicExtensions `xml:"openSubsonicExtensions,omitempty" json:"openSubsonicExtensions,omitempty"` LyricsList *LyricsList `xml:"lyricsList,omitempty" json:"lyricsList,omitempty"` + PlayQueueByIndex *PlayQueueByIndex `xml:"playQueueByIndex,omitempty" json:"playQueueByIndex,omitempty"` + TranscodeDecision *TranscodeDecision `xml:"transcodeDecision,omitempty" json:"transcodeDecision,omitempty"` } const ( @@ -94,11 +96,9 @@ type Artist struct { Name string `xml:"name,attr" json:"name"` Starred *time.Time `xml:"starred,attr,omitempty" json:"starred,omitempty"` UserRating int32 `xml:"userRating,attr,omitempty" json:"userRating,omitempty"` + AverageRating float64 `xml:"averageRating,attr,omitempty" json:"averageRating,omitempty"` CoverArt string `xml:"coverArt,attr,omitempty" json:"coverArt,omitempty"` ArtistImageUrl string `xml:"artistImageUrl,attr,omitempty" json:"artistImageUrl,omitempty"` - /* TODO: - <xs:attribute name="averageRating" type="sub:AverageRating" use="optional"/> <!-- Added in 1.13.0 --> - */ } type Index struct { @@ -135,7 +135,7 @@ type Child struct { Id string `xml:"id,attr" json:"id"` Parent string `xml:"parent,attr,omitempty" json:"parent,omitempty"` IsDir bool `xml:"isDir,attr" json:"isDir"` - Title string `xml:"title,attr,omitempty" json:"title,omitempty"` + Title string `xml:"title,attr" json:"title"` Name string `xml:"name,attr,omitempty" json:"name,omitempty"` Album string `xml:"album,attr,omitempty" json:"album,omitempty"` Artist string `xml:"artist,attr,omitempty" json:"artist,omitempty"` @@ -159,13 +159,11 @@ type Child struct { ArtistId string `xml:"artistId,attr,omitempty" json:"artistId,omitempty"` Type string `xml:"type,attr,omitempty" json:"type,omitempty"` UserRating int32 `xml:"userRating,attr,omitempty" json:"userRating,omitempty"` + AverageRating float64 `xml:"averageRating,attr,omitempty" json:"averageRating,omitempty"` SongCount int32 `xml:"songCount,attr,omitempty" json:"songCount,omitempty"` - IsVideo bool `xml:"isVideo,attr" json:"isVideo"` + IsVideo bool `xml:"isVideo,attr,omitempty" json:"isVideo,omitempty"` BookmarkPosition int64 `xml:"bookmarkPosition,attr,omitempty" json:"bookmarkPosition,omitempty"` - /* - <xs:attribute name="averageRating" type="sub:AverageRating" use="optional"/> <!-- Added in 1.6.0 --> - */ - *OpenSubsonicChild `xml:",omitempty" json:",omitempty"` + *OpenSubsonicChild `xml:",omitempty" json:",omitempty"` } type OpenSubsonicChild struct { @@ -176,7 +174,7 @@ type OpenSubsonicChild struct { SortName string `xml:"sortName,attr,omitempty" json:"sortName"` MediaType MediaType `xml:"mediaType,attr,omitempty" json:"mediaType"` MusicBrainzId string `xml:"musicBrainzId,attr,omitempty" json:"musicBrainzId"` - Isrc Array[string] `xml:"isrc,omitempty" json:"isrc"` + Isrc Array[string] `xml:"isrc,omitempty" json:"isrc"` Genres Array[ItemGenre] `xml:"genres,omitempty" json:"genres"` ReplayGain ReplayGain `xml:"replayGain,omitempty" json:"replayGain"` ChannelCount int32 `xml:"channelCount,attr,omitempty" json:"channelCount"` @@ -197,14 +195,15 @@ type Songs struct { } type Directory struct { - Child []Child `xml:"child" json:"child,omitempty"` - Id string `xml:"id,attr" json:"id"` - Name string `xml:"name,attr" json:"name"` - Parent string `xml:"parent,attr,omitempty" json:"parent,omitempty"` - Starred *time.Time `xml:"starred,attr,omitempty" json:"starred,omitempty"` - PlayCount int64 `xml:"playCount,attr,omitempty" json:"playCount,omitempty"` - Played *time.Time `xml:"played,attr,omitempty" json:"played,omitempty"` - UserRating int32 `xml:"userRating,attr,omitempty" json:"userRating,omitempty"` + Child []Child `xml:"child" json:"child,omitempty"` + Id string `xml:"id,attr" json:"id"` + Name string `xml:"name,attr" json:"name"` + Parent string `xml:"parent,attr,omitempty" json:"parent,omitempty"` + Starred *time.Time `xml:"starred,attr,omitempty" json:"starred,omitempty"` + PlayCount int64 `xml:"playCount,attr,omitempty" json:"playCount,omitempty"` + Played *time.Time `xml:"played,attr,omitempty" json:"played,omitempty"` + UserRating int32 `xml:"userRating,attr,omitempty" json:"userRating,omitempty"` + AverageRating float64 `xml:"averageRating,attr,omitempty" json:"averageRating,omitempty"` // ID3 Artist string `xml:"artist,attr,omitempty" json:"artist,omitempty"` @@ -216,10 +215,6 @@ type Directory struct { Created *time.Time `xml:"created,attr,omitempty" json:"created,omitempty"` Year int32 `xml:"year,attr,omitempty" json:"year,omitempty"` Genre string `xml:"genre,attr,omitempty" json:"genre,omitempty"` - - /* - <xs:attribute name="averageRating" type="sub:AverageRating" use="optional"/> <!-- Added in 1.13.0 --> - */ } // ArtistID3Ref is a reference to an artist, a simplified version of ArtistID3. This is used to resolve the @@ -236,6 +231,7 @@ type ArtistID3 struct { AlbumCount int32 `xml:"albumCount,attr" json:"albumCount"` Starred *time.Time `xml:"starred,attr,omitempty" json:"starred,omitempty"` UserRating int32 `xml:"userRating,attr,omitempty" json:"userRating,omitempty"` + AverageRating float64 `xml:"averageRating,attr,omitempty" json:"averageRating,omitempty"` ArtistImageUrl string `xml:"artistImageUrl,attr,omitempty" json:"artistImageUrl,omitempty"` *OpenSubsonicArtistID3 `xml:",omitempty" json:",omitempty"` } @@ -254,7 +250,7 @@ type AlbumID3 struct { ArtistId string `xml:"artistId,attr,omitempty" json:"artistId,omitempty"` CoverArt string `xml:"coverArt,attr,omitempty" json:"coverArt,omitempty"` SongCount int32 `xml:"songCount,attr,omitempty" json:"songCount,omitempty"` - Duration int32 `xml:"duration,attr,omitempty" json:"duration,omitempty"` + Duration int32 `xml:"duration,attr" json:"duration"` PlayCount int64 `xml:"playCount,attr,omitempty" json:"playCount,omitempty"` Created *time.Time `xml:"created,attr,omitempty" json:"created,omitempty"` Starred *time.Time `xml:"starred,attr,omitempty" json:"starred,omitempty"` @@ -267,6 +263,7 @@ type OpenSubsonicAlbumID3 struct { // OpenSubsonic extensions Played *time.Time `xml:"played,attr,omitempty" json:"played,omitempty"` UserRating int32 `xml:"userRating,attr,omitempty" json:"userRating"` + AverageRating float64 `xml:"averageRating,attr,omitempty" json:"averageRating,omitempty"` Genres Array[ItemGenre] `xml:"genres,omitempty" json:"genres"` MusicBrainzId string `xml:"musicBrainzId,attr,omitempty" json:"musicBrainzId"` IsCompilation bool `xml:"isCompilation,attr,omitempty" json:"isCompilation"` @@ -302,16 +299,17 @@ type AlbumList2 struct { } type Playlist struct { - Id string `xml:"id,attr" json:"id"` - Name string `xml:"name,attr" json:"name"` - Comment string `xml:"comment,attr,omitempty" json:"comment,omitempty"` - SongCount int32 `xml:"songCount,attr" json:"songCount"` - Duration int32 `xml:"duration,attr" json:"duration"` - Public bool `xml:"public,attr" json:"public"` - Owner string `xml:"owner,attr,omitempty" json:"owner,omitempty"` - Created time.Time `xml:"created,attr" json:"created"` - Changed time.Time `xml:"changed,attr" json:"changed"` - CoverArt string `xml:"coverArt,attr,omitempty" json:"coverArt,omitempty"` + Id string `xml:"id,attr" json:"id"` + Name string `xml:"name,attr" json:"name"` + Comment string `xml:"comment,attr,omitempty" json:"comment,omitempty"` + SongCount int32 `xml:"songCount,attr" json:"songCount"` + Duration int32 `xml:"duration,attr" json:"duration"` + Public bool `xml:"public,attr" json:"public,omitempty"` + Owner string `xml:"owner,attr,omitempty" json:"owner,omitempty"` + Created time.Time `xml:"created,attr" json:"created"` + Changed time.Time `xml:"changed,attr" json:"changed"` + CoverArt string `xml:"coverArt,attr,omitempty" json:"coverArt,omitempty"` + *OpenSubsonicPlaylist `xml:",omitempty" json:",omitempty"` /* <xs:sequence> <xs:element name="allowedUser" type="xs:string" minOccurs="0" maxOccurs="unbounded"/> <!--Added in 1.8.0--> @@ -319,6 +317,11 @@ type Playlist struct { */ } +type OpenSubsonicPlaylist struct { + Readonly bool `xml:"readonly,attr,omitempty" json:"readonly"` + ValidUntil *time.Time `xml:"validUntil,attr,omitempty" json:"validUntil,omitempty"` +} + type Playlists struct { Playlist []Playlist `xml:"playlist" json:"playlist,omitempty"` } @@ -439,16 +442,25 @@ type TopSongs struct { } type PlayQueue struct { - Entry []Child `xml:"entry,omitempty" json:"entry,omitempty"` - Current string `xml:"current,attr,omitempty" json:"current,omitempty"` - Position int64 `xml:"position,attr,omitempty" json:"position,omitempty"` - Username string `xml:"username,attr" json:"username"` - Changed *time.Time `xml:"changed,attr,omitempty" json:"changed,omitempty"` - ChangedBy string `xml:"changedBy,attr" json:"changedBy"` + Entry []Child `xml:"entry,omitempty" json:"entry,omitempty"` + Current string `xml:"current,attr,omitempty" json:"current,omitempty"` + Position int64 `xml:"position,attr,omitempty" json:"position,omitempty"` + Username string `xml:"username,attr" json:"username"` + Changed time.Time `xml:"changed,attr" json:"changed"` + ChangedBy string `xml:"changedBy,attr" json:"changedBy"` +} + +type PlayQueueByIndex struct { + Entry []Child `xml:"entry,omitempty" json:"entry,omitempty"` + CurrentIndex *int `xml:"currentIndex,attr,omitempty" json:"currentIndex,omitempty"` + Position int64 `xml:"position,attr,omitempty" json:"position,omitempty"` + Username string `xml:"username,attr" json:"username"` + Changed time.Time `xml:"changed,attr" json:"changed"` + ChangedBy string `xml:"changedBy,attr" json:"changedBy"` } type Bookmark struct { - Entry Child `xml:"entry,omitempty" json:"entry,omitempty"` + Entry Child `xml:"entry,omitempty" json:"entry"` Position int64 `xml:"position,attr,omitempty" json:"position,omitempty"` Username string `xml:"username,attr" json:"username"` Comment string `xml:"comment,attr" json:"comment"` @@ -497,10 +509,15 @@ type InternetRadioStations struct { } type Radio struct { - ID string `xml:"id,attr" json:"id"` - Name string `xml:"name,attr" json:"name"` - StreamUrl string `xml:"streamUrl,attr" json:"streamUrl"` - HomepageUrl string `xml:"homePageUrl,omitempty,attr" json:"homePageUrl,omitempty"` + ID string `xml:"id,attr" json:"id"` + Name string `xml:"name,attr" json:"name"` + StreamUrl string `xml:"streamUrl,attr" json:"streamUrl"` + HomepageUrl string `xml:"homePageUrl,omitempty,attr" json:"homePageUrl,omitempty"` + *OpenSubsonicRadio `xml:",omitempty" json:",omitempty"` +} + +type OpenSubsonicRadio struct { + CoverArt string `xml:"coverArt,attr,omitempty" json:"coverArt"` } type JukeboxStatus struct { @@ -563,8 +580,9 @@ func (r ReplayGain) MarshalXML(e *xml.Encoder, start xml.StartElement) error { } type DiscTitle struct { - Disc int32 `xml:"disc,attr" json:"disc"` - Title string `xml:"title,attr" json:"title"` + Disc int32 `xml:"disc,attr" json:"disc"` + Title string `xml:"title,attr" json:"title"` + CoverArt string `xml:"coverArt,attr,omitempty" json:"coverArt,omitempty"` } type ItemDate struct { @@ -606,3 +624,26 @@ func marshalJSONArray[T any](v []T) ([]byte, error) { } return json.Marshal(v) } + +// TranscodeDecision represents the response for getTranscodeDecision (OpenSubsonic transcoding extension) +type TranscodeDecision struct { + CanDirectPlay bool `xml:"canDirectPlay,attr" json:"canDirectPlay"` + CanTranscode bool `xml:"canTranscode,attr" json:"canTranscode"` + TranscodeReasons []string `xml:"transcodeReason,omitempty" json:"transcodeReason,omitempty"` + ErrorReason string `xml:"errorReason,attr,omitempty" json:"errorReason,omitempty"` + TranscodeParams string `xml:"transcodeParams,attr,omitempty" json:"transcodeParams,omitempty"` + SourceStream *StreamDetails `xml:"sourceStream,omitempty" json:"sourceStream,omitempty"` + TranscodeStream *StreamDetails `xml:"transcodeStream,omitempty" json:"transcodeStream,omitempty"` +} + +// StreamDetails describes audio stream properties for transcoding decisions +type StreamDetails struct { + Protocol string `xml:"protocol,attr,omitempty" json:"protocol,omitempty"` + Container string `xml:"container,attr,omitempty" json:"container,omitempty"` + Codec string `xml:"codec,attr,omitempty" json:"codec,omitempty"` + AudioChannels int32 `xml:"audioChannels,attr,omitempty" json:"audioChannels,omitempty"` + AudioBitrate int32 `xml:"audioBitrate,attr,omitempty" json:"audioBitrate,omitempty"` + AudioProfile string `xml:"audioProfile,attr,omitempty" json:"audioProfile,omitempty"` + AudioSamplerate int32 `xml:"audioSamplerate,attr,omitempty" json:"audioSamplerate,omitempty"` + AudioBitdepth int32 `xml:"audioBitdepth,attr,omitempty" json:"audioBitdepth,omitempty"` +} diff --git a/server/subsonic/responses/responses_suite_test.go b/server/subsonic/responses/responses_suite_test.go index 8728b949a..e10957af2 100644 --- a/server/subsonic/responses/responses_suite_test.go +++ b/server/subsonic/responses/responses_suite_test.go @@ -26,17 +26,17 @@ type snapshotMatcher struct { c *cupaloy.Config } -func (matcher snapshotMatcher) Match(actual interface{}) (success bool, err error) { +func (matcher snapshotMatcher) Match(actual any) (success bool, err error) { actualJson := strings.TrimSpace(string(actual.([]byte))) err = matcher.c.SnapshotWithName(ginkgo.CurrentSpecReport().FullText(), actualJson) success = err == nil return } -func (matcher snapshotMatcher) FailureMessage(_ interface{}) (message string) { +func (matcher snapshotMatcher) FailureMessage(_ any) (message string) { return "Expected to match saved snapshot\n" } -func (matcher snapshotMatcher) NegatedFailureMessage(_ interface{}) (message string) { +func (matcher snapshotMatcher) NegatedFailureMessage(_ any) (message string) { return "Expected to not match saved snapshot\n" } diff --git a/server/subsonic/responses/responses_test.go b/server/subsonic/responses/responses_test.go index 7238665cf..15f2da9c6 100644 --- a/server/subsonic/responses/responses_test.go +++ b/server/subsonic/responses/responses_test.go @@ -11,6 +11,7 @@ import ( "time" "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/server/subsonic/responses" . "github.com/navidrome/navidrome/server/subsonic/responses" "github.com/navidrome/navidrome/utils/gg" . "github.com/onsi/ginkgo/v2" @@ -287,7 +288,7 @@ var _ = Describe("Responses", func() { Context("with data", func() { BeforeEach(func() { album := AlbumID3{ - Id: "1", Name: "album", Artist: "artist", Genre: "rock", + Id: "1", Name: "album", Artist: "artist", Duration: 292, Genre: "rock", } album.OpenSubsonicAlbumID3 = &OpenSubsonicAlbumID3{ Genres: []ItemGenre{{Name: "rock"}, {Name: "progressive"}}, @@ -531,9 +532,9 @@ var _ = Describe("Responses", func() { }) Context("with data", func() { - timestamp, _ := time.Parse(time.RFC3339, "2020-04-11T16:43:00Z04:00") + timestamp := time.Date(2023, 2, 20, 14, 45, 0, 0, time.UTC) BeforeEach(func() { - pls := make([]Playlist, 2) + pls := make([]Playlist, 3) pls[0] = Playlist{ Id: "111", Name: "aaa", @@ -545,8 +546,13 @@ var _ = Describe("Responses", func() { CoverArt: "pl-123123123123", Created: timestamp, Changed: timestamp, + OpenSubsonicPlaylist: &responses.OpenSubsonicPlaylist{ + Readonly: true, + ValidUntil: ×tamp, + }, } - pls[1] = Playlist{Id: "222", Name: "bbb"} + pls[1] = Playlist{Id: "333", Name: "ccc", OpenSubsonicPlaylist: &responses.OpenSubsonicPlaylist{}} + pls[2] = Playlist{Id: "222", Name: "bbb"} response.Playlists.Playlist = pls }) @@ -768,7 +774,7 @@ var _ = Describe("Responses", func() { response.PlayQueue.Username = "user1" response.PlayQueue.Current = "111" response.PlayQueue.Position = 243 - response.PlayQueue.Changed = &time.Time{} + response.PlayQueue.Changed = time.Time{} response.PlayQueue.ChangedBy = "a_client" child := make([]Child, 1) child[0] = Child{Id: "1", Title: "title", IsDir: false} @@ -783,6 +789,40 @@ var _ = Describe("Responses", func() { }) }) + Describe("PlayQueueByIndex", func() { + BeforeEach(func() { + response.PlayQueueByIndex = &PlayQueueByIndex{} + }) + + Context("without data", func() { + It("should match .XML", func() { + Expect(xml.MarshalIndent(response, "", " ")).To(MatchSnapshot()) + }) + It("should match .JSON", func() { + Expect(json.MarshalIndent(response, "", " ")).To(MatchSnapshot()) + }) + }) + + Context("with data", func() { + BeforeEach(func() { + response.PlayQueueByIndex.Username = "user1" + response.PlayQueueByIndex.CurrentIndex = gg.P(0) + response.PlayQueueByIndex.Position = 243 + response.PlayQueueByIndex.Changed = time.Time{} + response.PlayQueueByIndex.ChangedBy = "a_client" + child := make([]Child, 1) + child[0] = Child{Id: "1", Title: "title", IsDir: false} + response.PlayQueueByIndex.Entry = child + }) + It("should match .XML", func() { + Expect(xml.MarshalIndent(response, "", " ")).To(MatchSnapshot()) + }) + It("should match .JSON", func() { + Expect(json.MarshalIndent(response, "", " ")).To(MatchSnapshot()) + }) + }) + }) + Describe("Shares", func() { BeforeEach(func() { response.Shares = &Shares{} diff --git a/server/subsonic/searching.go b/server/subsonic/searching.go index ba1071320..fd7e29587 100644 --- a/server/subsonic/searching.go +++ b/server/subsonic/searching.go @@ -10,9 +10,9 @@ import ( . "github.com/Masterminds/squirrel" "github.com/deluan/sanitize" + "github.com/navidrome/navidrome/core/publicurl" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/server/public" "github.com/navidrome/navidrome/server/subsonic/responses" "github.com/navidrome/navidrome/utils/req" "github.com/navidrome/navidrome/utils/slice" @@ -42,17 +42,17 @@ func (api *Router) getSearchParams(r *http.Request) (*searchParams, error) { return sp, nil } -type searchFunc[T any] func(q string, offset int, size int, options ...model.QueryOptions) (T, error) +type searchFunc[T any] func(q string, options ...model.QueryOptions) (T, error) -func callSearch[T any](ctx context.Context, s searchFunc[T], q string, offset, size int, result *T, options ...model.QueryOptions) func() error { +func callSearch[T any](ctx context.Context, s searchFunc[T], q string, options model.QueryOptions, result *T) func() error { return func() error { - if size == 0 { + if options.Max == 0 { return nil } typ := strings.TrimPrefix(reflect.TypeOf(*result).String(), "model.") var err error start := time.Now() - *result, err = s(q, offset, size, options...) + *result, err = s(q, options) if err != nil { log.Error(ctx, "Error searching "+typ, "query", q, "elapsed", time.Since(start), err) } else { @@ -66,27 +66,22 @@ func (api *Router) searchAll(ctx context.Context, sp *searchParams, musicFolderI start := time.Now() q := sanitize.Accents(strings.ToLower(strings.TrimSuffix(sp.query, "*"))) - // Create query options for library filtering - var options []model.QueryOptions - var artistOptions []model.QueryOptions + // Build options with offset/size/filters packed in + songOpts := model.QueryOptions{Max: sp.songCount, Offset: sp.songOffset} + albumOpts := model.QueryOptions{Max: sp.albumCount, Offset: sp.albumOffset} + artistOpts := model.QueryOptions{Max: sp.artistCount, Offset: sp.artistOffset} + if len(musicFolderIds) > 0 { - // For MediaFiles and Albums, use direct library_id filter - options = append(options, model.QueryOptions{ - Filters: Eq{"library_id": musicFolderIds}, - }) - // For Artists, use the repository's built-in library filtering mechanism - // which properly handles the library_artist table joins - // TODO Revisit library filtering in sql_base_repository.go - artistOptions = append(artistOptions, model.QueryOptions{ - Filters: Eq{"library_artist.library_id": musicFolderIds}, - }) + songOpts.Filters = Eq{"library_id": musicFolderIds} + albumOpts.Filters = Eq{"library_id": musicFolderIds} + artistOpts.Filters = Eq{"library_artist.library_id": musicFolderIds} } // Run searches in parallel g, ctx := errgroup.WithContext(ctx) - g.Go(callSearch(ctx, api.ds.MediaFile(ctx).Search, q, sp.songOffset, sp.songCount, &mediaFiles, options...)) - g.Go(callSearch(ctx, api.ds.Album(ctx).Search, q, sp.albumOffset, sp.albumCount, &albums, options...)) - g.Go(callSearch(ctx, api.ds.Artist(ctx).Search, q, sp.artistOffset, sp.artistCount, &artists, artistOptions...)) + g.Go(callSearch(ctx, api.ds.MediaFile(ctx).Search, q, songOpts, &mediaFiles)) + g.Go(callSearch(ctx, api.ds.Album(ctx).Search, q, albumOpts, &albums)) + g.Go(callSearch(ctx, api.ds.Artist(ctx).Search, q, artistOpts, &artists)) err := g.Wait() if err == nil { log.Debug(ctx, fmt.Sprintf("Search resulted in %d songs, %d albums and %d artists", @@ -119,7 +114,7 @@ func (api *Router) Search2(r *http.Request) (*responses.Subsonic, error) { Name: artist.Name, UserRating: int32(artist.Rating), CoverArt: artist.CoverArtID().String(), - ArtistImageUrl: public.ImageURL(r, artist.CoverArtID(), 600), + ArtistImageUrl: publicurl.ImageURL(r, artist.CoverArtID(), 600), } if artist.Starred { a.Starred = artist.StarredAt diff --git a/server/subsonic/searching_test.go b/server/subsonic/searching_test.go index dfe3a45c4..ab40a726f 100644 --- a/server/subsonic/searching_test.go +++ b/server/subsonic/searching_test.go @@ -21,7 +21,7 @@ var _ = Describe("Search", func() { ds = &tests.MockDataStore{} auth.Init(ds) - router = New(ds, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil) + router = New(ds, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil) // Get references to the mock repositories so we can inspect their Options mockAlbumRepo = ds.Album(nil).(*tests.MockAlbumRepo) @@ -30,7 +30,7 @@ var _ = Describe("Search", func() { }) Context("musicFolderId parameter", func() { - assertQueryOptions := func(filter squirrel.Sqlizer, expectedQuery string, expectedArgs ...interface{}) { + assertQueryOptions := func(filter squirrel.Sqlizer, expectedQuery string, expectedArgs ...any) { GinkgoHelper() query, args, err := filter.ToSql() Expect(err).ToNot(HaveOccurred()) diff --git a/server/subsonic/stream.go b/server/subsonic/stream.go index d0cbe2086..b49af2b24 100644 --- a/server/subsonic/stream.go +++ b/server/subsonic/stream.go @@ -1,15 +1,12 @@ package subsonic import ( - "context" "fmt" - "io" "net/http" "strconv" "strings" "github.com/navidrome/navidrome/conf" - "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/request" @@ -17,38 +14,6 @@ import ( "github.com/navidrome/navidrome/utils/req" ) -func (api *Router) serveStream(ctx context.Context, w http.ResponseWriter, r *http.Request, stream *core.Stream, id string) { - if stream.Seekable() { - http.ServeContent(w, r, stream.Name(), stream.ModTime(), stream) - } else { - // If the stream doesn't provide a size (i.e. is not seekable), we can't support ranges/content-length - w.Header().Set("Accept-Ranges", "none") - w.Header().Set("Content-Type", stream.ContentType()) - - estimateContentLength := req.Params(r).BoolOr("estimateContentLength", false) - - // if Client requests the estimated content-length, send it - if estimateContentLength { - length := strconv.Itoa(stream.EstimatedContentLength()) - log.Trace(ctx, "Estimated content-length", "contentLength", length) - w.Header().Set("Content-Length", length) - } - - if r.Method == http.MethodHead { - go func() { _, _ = io.Copy(io.Discard, stream) }() - } else { - c, err := io.Copy(w, stream) - if log.IsGreaterOrEqualTo(log.LevelDebug) { - if err != nil { - log.Error(ctx, "Error sending transcoded file", "id", id, err) - } else { - log.Trace(ctx, "Success sending transcode file", "id", id, "size", c) - } - } - } - } -} - func (api *Router) Stream(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) { ctx := r.Context() p := req.Params(r) @@ -60,7 +25,13 @@ func (api *Router) Stream(w http.ResponseWriter, r *http.Request) (*responses.Su format, _ := p.String("format") timeOffset := p.IntOr("timeOffset", 0) - stream, err := api.streamer.NewStream(ctx, id, format, maxBitRate, timeOffset) + mf, err := api.ds.MediaFile(ctx).Get(id) + if err != nil { + return nil, err + } + + streamReq := api.transcodeDecision.ResolveRequest(ctx, mf, format, maxBitRate, timeOffset) + stream, err := api.streamer.NewStream(ctx, mf, streamReq) if err != nil { return nil, err } @@ -75,9 +46,8 @@ func (api *Router) Stream(w http.ResponseWriter, r *http.Request) (*responses.Su w.Header().Set("X-Content-Type-Options", "nosniff") w.Header().Set("X-Content-Duration", strconv.FormatFloat(float64(stream.Duration()), 'G', -1, 32)) - api.serveStream(ctx, w, r, stream, id) - - return nil, nil + _, err = stream.Serve(ctx, w, r) + return nil, err } func (api *Router) Download(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) { @@ -129,7 +99,8 @@ func (api *Router) Download(w http.ResponseWriter, r *http.Request) (*responses. switch v := entity.(type) { case *model.MediaFile: - stream, err := api.streamer.NewStream(ctx, id, format, maxBitRate, 0) + streamReq := api.transcodeDecision.ResolveRequest(ctx, v, format, maxBitRate, 0) + stream, err := api.streamer.NewStream(ctx, v, streamReq) if err != nil { return nil, err } @@ -144,20 +115,18 @@ func (api *Router) Download(w http.ResponseWriter, r *http.Request) (*responses. disposition := fmt.Sprintf("attachment; filename=\"%s\"", stream.Name()) w.Header().Set("Content-Disposition", disposition) - api.serveStream(ctx, w, r, stream, id) - return nil, nil + _, err = stream.Serve(ctx, w, r) + return nil, err case *model.Album: setHeaders(v.Name) - err = api.archiver.ZipAlbum(ctx, id, format, maxBitRate, w) + return nil, api.archiver.ZipAlbum(ctx, id, format, maxBitRate, w) case *model.Artist: setHeaders(v.Name) - err = api.archiver.ZipArtist(ctx, id, format, maxBitRate, w) + return nil, api.archiver.ZipArtist(ctx, id, format, maxBitRate, w) case *model.Playlist: setHeaders(v.Name) - err = api.archiver.ZipPlaylist(ctx, id, format, maxBitRate, w) + return nil, api.archiver.ZipPlaylist(ctx, id, format, maxBitRate, w) default: - err = model.ErrNotFound + return nil, model.ErrNotFound } - - return nil, err } diff --git a/server/subsonic/transcode.go b/server/subsonic/transcode.go new file mode 100644 index 000000000..4e494b324 --- /dev/null +++ b/server/subsonic/transcode.go @@ -0,0 +1,403 @@ +package subsonic + +import ( + "encoding/json" + "errors" + "fmt" + "net/http" + "slices" + "strconv" + + "github.com/navidrome/navidrome/core/stream" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/server/subsonic/responses" + "github.com/navidrome/navidrome/utils/req" +) + +// API-layer request structs for JSON unmarshaling (decoupled from core structs) + +// clientInfoRequest represents client playback capabilities from the request body +type clientInfoRequest struct { + Name string `json:"name,omitempty"` + Platform string `json:"platform,omitempty"` + MaxAudioBitrate int `json:"maxAudioBitrate,omitempty"` + MaxTranscodingAudioBitrate int `json:"maxTranscodingAudioBitrate,omitempty"` + DirectPlayProfiles []directPlayProfileRequest `json:"directPlayProfiles,omitempty"` + TranscodingProfiles []transcodingProfileRequest `json:"transcodingProfiles,omitempty"` + CodecProfiles []codecProfileRequest `json:"codecProfiles,omitempty"` +} + +// directPlayProfileRequest describes a format the client can play directly +type directPlayProfileRequest struct { + Containers []string `json:"containers,omitempty"` + AudioCodecs []string `json:"audioCodecs,omitempty"` + Protocols []string `json:"protocols,omitempty"` + MaxAudioChannels int `json:"maxAudioChannels,omitempty"` +} + +// transcodingProfileRequest describes a transcoding target the client supports +type transcodingProfileRequest struct { + Container string `json:"container,omitempty"` + AudioCodec string `json:"audioCodec,omitempty"` + Protocol string `json:"protocol,omitempty"` + MaxAudioChannels int `json:"maxAudioChannels,omitempty"` +} + +// codecProfileRequest describes codec-specific limitations +type codecProfileRequest struct { + Type string `json:"type,omitempty"` + Name string `json:"name,omitempty"` + Limitations []limitationRequest `json:"limitations,omitempty"` +} + +// limitationRequest describes a specific codec limitation +type limitationRequest struct { + Name string `json:"name,omitempty"` + Comparison string `json:"comparison,omitempty"` + Values []string `json:"values,omitempty"` + Required bool `json:"required,omitempty"` +} + +// toCoreClientInfo converts the API request struct to the stream.ClientInfo struct. +// The OpenSubsonic spec uses bps for bitrate values; core uses kbps. +func (r *clientInfoRequest) toCoreClientInfo() *stream.ClientInfo { + ci := &stream.ClientInfo{ + Name: r.Name, + Platform: r.Platform, + MaxAudioBitrate: bpsToKbps(r.MaxAudioBitrate), + MaxTranscodingAudioBitrate: bpsToKbps(r.MaxTranscodingAudioBitrate), + } + + for _, dp := range r.DirectPlayProfiles { + ci.DirectPlayProfiles = append(ci.DirectPlayProfiles, stream.DirectPlayProfile{ + Containers: dp.Containers, + AudioCodecs: dp.AudioCodecs, + Protocols: dp.Protocols, + MaxAudioChannels: dp.MaxAudioChannels, + }) + } + + for _, tp := range r.TranscodingProfiles { + ci.TranscodingProfiles = append(ci.TranscodingProfiles, stream.Profile{ + Container: tp.Container, + AudioCodec: tp.AudioCodec, + Protocol: tp.Protocol, + MaxAudioChannels: tp.MaxAudioChannels, + }) + } + + for _, cp := range r.CodecProfiles { + coreCP := stream.CodecProfile{ + Type: cp.Type, + Name: cp.Name, + } + for _, lim := range cp.Limitations { + coreLim := stream.Limitation{ + Name: lim.Name, + Comparison: lim.Comparison, + Values: lim.Values, + Required: lim.Required, + } + // Convert audioBitrate limitation values from bps to kbps + if lim.Name == stream.LimitationAudioBitrate { + coreLim.Values = convertBitrateValues(lim.Values) + } + coreCP.Limitations = append(coreCP.Limitations, coreLim) + } + ci.CodecProfiles = append(ci.CodecProfiles, coreCP) + } + + return ci +} + +// bpsToKbps converts bits per second to kilobits per second (rounded). +func bpsToKbps(bps int) int { + if bps < 0 { + return 0 + } + return (bps + 500) / 1000 +} + +// kbpsToBps converts kilobits per second to bits per second. +func kbpsToBps(kbps int) int { + return kbps * 1000 +} + +// convertBitrateValues converts a slice of bps string values to kbps string values. +func convertBitrateValues(bpsValues []string) []string { + result := make([]string, len(bpsValues)) + for i, v := range bpsValues { + n, err := strconv.Atoi(v) + if err == nil { + result[i] = strconv.Itoa(bpsToKbps(n)) + } else { + result[i] = v // preserve unparseable values as-is + } + } + return result +} + +// validate checks that all enum fields in the request contain valid values per the OpenSubsonic spec. +func (r *clientInfoRequest) validate() error { + for _, dp := range r.DirectPlayProfiles { + for _, p := range dp.Protocols { + if !isValidProtocol(p) { + return fmt.Errorf("invalid protocol: %s", p) + } + } + } + for _, tp := range r.TranscodingProfiles { + if tp.Protocol != "" && !isValidProtocol(tp.Protocol) { + return fmt.Errorf("invalid protocol: %s", tp.Protocol) + } + } + for _, cp := range r.CodecProfiles { + if !isValidCodecProfileType(cp.Type) { + return fmt.Errorf("invalid codec profile type: %s", cp.Type) + } + for _, lim := range cp.Limitations { + if !isValidLimitationName(lim.Name) { + return fmt.Errorf("invalid limitation name: %s", lim.Name) + } + if !isValidComparison(lim.Comparison) { + return fmt.Errorf("invalid comparison: %s", lim.Comparison) + } + } + } + return nil +} + +// Only support songs for now +var validMediaTypes = []string{ + "song", +} + +func isValidMediaType(mediaType string) bool { + return slices.Contains(validMediaTypes, mediaType) +} + +var validProtocols = []string{ + stream.ProtocolHTTP, + stream.ProtocolHLS, +} + +func isValidProtocol(p string) bool { + return slices.Contains(validProtocols, p) +} + +var validCodecProfileTypes = []string{ + stream.CodecProfileTypeAudio, +} + +func isValidCodecProfileType(t string) bool { + return slices.Contains(validCodecProfileTypes, t) +} + +var validLimitationNames = []string{ + stream.LimitationAudioChannels, + stream.LimitationAudioBitrate, + stream.LimitationAudioProfile, + stream.LimitationAudioSamplerate, + stream.LimitationAudioBitdepth, +} + +func isValidLimitationName(n string) bool { + return slices.Contains(validLimitationNames, n) +} + +var validComparisons = []string{ + stream.ComparisonEquals, + stream.ComparisonNotEquals, + stream.ComparisonLessThanEqual, + stream.ComparisonGreaterThanEqual, +} + +func isValidComparison(c string) bool { + return slices.Contains(validComparisons, c) +} + +// toResponseStreamDetails converts a core StreamDetails to the API response type. +func toResponseStreamDetails(sd *stream.Details) *responses.StreamDetails { + return &responses.StreamDetails{ + Protocol: stream.ProtocolHTTP, // TODO: derive from decision when HLS support is added + Container: sd.Container, + Codec: sd.Codec, + AudioBitrate: int32(kbpsToBps(sd.Bitrate)), + AudioProfile: sd.Profile, + AudioSamplerate: int32(sd.SampleRate), + AudioBitdepth: int32(sd.BitDepth), + AudioChannels: int32(sd.Channels), + } +} + +// GetTranscodeDecision handles the OpenSubsonic getTranscodeDecision endpoint. +// It receives client capabilities and returns a decision on whether to direct play or stream. +func (api *Router) GetTranscodeDecision(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) { + if r.Method != http.MethodPost { + w.Header().Set("Allow", "POST") + http.Error(w, "Method Not Allowed", http.StatusMethodNotAllowed) + return nil, nil + } + + ctx := r.Context() + p := req.Params(r) + + mediaID, err := p.String("mediaId") + if err != nil { + return nil, newError(responses.ErrorMissingParameter, "missing required parameter: mediaId") + } + + mediaType, err := p.String("mediaType") + if err != nil { + return nil, newError(responses.ErrorMissingParameter, "missing required parameter: mediaType") + } + + if !isValidMediaType(mediaType) { + return nil, newError(responses.ErrorGeneric, "mediaType '%s' is not yet supported", mediaType) + } + + // Parse and validate ClientInfo from request body (required per OpenSubsonic spec) + var clientInfoReq clientInfoRequest + r.Body = http.MaxBytesReader(w, r.Body, 1<<20) // 1 MB limit + if err := json.NewDecoder(r.Body).Decode(&clientInfoReq); err != nil { + return nil, newError(responses.ErrorGeneric, "invalid JSON request body") + } + if err := clientInfoReq.validate(); err != nil { + return nil, newError(responses.ErrorGeneric, "%v", err) + } + clientInfo := clientInfoReq.toCoreClientInfo() + + // TODO: Remove this filter once AAC transcoding works reliably + // with streaming clients (Sonos, etc). + // See https://github.com/navidrome/navidrome/discussions/4832#discussioncomment-16068231 + clientInfo.TranscodingProfiles = slices.DeleteFunc(clientInfo.TranscodingProfiles, func(p stream.Profile) bool { + if p.AudioCodec != "" { + return stream.IsAACCodec(p.AudioCodec) + } + return stream.IsAACCodec(p.Container) + }) + + // Get media file + mf, err := api.ds.MediaFile(ctx).Get(mediaID) + if err != nil { + if errors.Is(err, model.ErrNotFound) { + return nil, newError(responses.ErrorDataNotFound, "media file not found: %s", mediaID) + } + log.Error(ctx, "Error retrieving media file", "mediaID", mediaID, err) + return nil, newError(responses.ErrorGeneric, "error retrieving media file") + } + + // Make the decision + decision, err := api.transcodeDecision.MakeDecision(ctx, mf, clientInfo, stream.TranscodeOptions{}) + if err != nil { + log.Error(ctx, "Failed to make transcode decision", "mediaID", mediaID, err) + return nil, newError(responses.ErrorGeneric, "failed to make transcode decision") + } + + // Only create a token when there is a valid playback path + var transcodeParams string + if decision.CanDirectPlay || decision.CanTranscode { + transcodeParams, err = api.transcodeDecision.CreateTranscodeParams(decision) + if err != nil { + log.Error(ctx, "Failed to create transcode token", "mediaID", mediaID, err) + return nil, newError(responses.ErrorGeneric, "failed to create transcode token") + } + } + + // Build response (convert kbps from core to bps for the API) + response := newResponse() + response.TranscodeDecision = &responses.TranscodeDecision{ + CanDirectPlay: decision.CanDirectPlay, + CanTranscode: decision.CanTranscode, + TranscodeReasons: decision.TranscodeReasons, + ErrorReason: decision.ErrorReason, + TranscodeParams: transcodeParams, + SourceStream: toResponseStreamDetails(&decision.SourceStream), + } + + if decision.TranscodeStream != nil { + response.TranscodeDecision.TranscodeStream = toResponseStreamDetails(decision.TranscodeStream) + } + + return response, nil +} + +// GetTranscodeStream handles the OpenSubsonic getTranscodeStream endpoint. +// It streams media using the decision encoded in the transcodeParams JWT token. +// All errors are returned as proper HTTP status codes (not Subsonic error responses). +func (api *Router) GetTranscodeStream(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) { + ctx := r.Context() + p := req.Params(r) + + mediaID, err := p.String("mediaId") + if err != nil { + http.Error(w, "Bad Request", http.StatusBadRequest) + return nil, nil + } + + mediaType, err := p.String("mediaType") + if err != nil { + http.Error(w, "Bad Request", http.StatusBadRequest) + return nil, nil + } + + transcodeParamsToken, err := p.String("transcodeParams") + if err != nil { + http.Error(w, "Bad Request", http.StatusBadRequest) + return nil, nil + } + + if !isValidMediaType(mediaType) { + http.Error(w, "Bad Request", http.StatusBadRequest) + return nil, nil + } + + // Fetch the media file + mf, err := api.ds.MediaFile(ctx).Get(mediaID) + if err != nil { + if errors.Is(err, model.ErrNotFound) { + http.Error(w, "Not Found", http.StatusNotFound) + } else { + log.Error(ctx, "Error retrieving media file", "mediaID", mediaID, err) + http.Error(w, "Internal Server Error", http.StatusInternalServerError) + } + return nil, nil + } + + // Validate the token and resolve streaming parameters + streamReq, err := api.transcodeDecision.ResolveRequestFromToken(ctx, transcodeParamsToken, mf, p.IntOr("offset", 0)) + if err != nil { + switch { + case errors.Is(err, stream.ErrTokenInvalid), errors.Is(err, stream.ErrTokenStale): + http.Error(w, "Gone", http.StatusGone) + default: + log.Error(ctx, "Error validating transcode params", err) + http.Error(w, "Internal Server Error", http.StatusInternalServerError) + } + return nil, nil + } + + // Create stream + stream, err := api.streamer.NewStream(ctx, mf, streamReq) + if err != nil { + log.Error(ctx, "Error creating stream", "mediaID", mediaID, err) + http.Error(w, "Internal Server Error", http.StatusInternalServerError) + return nil, nil + } + + // Make sure the stream will be closed at the end + defer func() { + if err := stream.Close(); err != nil && log.IsGreaterOrEqualTo(log.LevelDebug) { + log.Error("Error closing stream", "id", mediaID, "file", stream.Name(), err) + } + }() + + w.Header().Set("X-Content-Type-Options", "nosniff") + + n, err := stream.Serve(ctx, w, r) + if err != nil || n == 0 { + http.Error(w, "Internal Server Error", http.StatusInternalServerError) + } + return nil, nil +} diff --git a/server/subsonic/transcode_test.go b/server/subsonic/transcode_test.go new file mode 100644 index 000000000..15ba168d7 --- /dev/null +++ b/server/subsonic/transcode_test.go @@ -0,0 +1,424 @@ +package subsonic + +import ( + "bytes" + "context" + "errors" + "net/http" + "net/http/httptest" + + "github.com/navidrome/navidrome/core/stream" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Transcode endpoints", func() { + var ( + router *Router + ds *tests.MockDataStore + mockTD *mockTranscodeDecision + w *httptest.ResponseRecorder + mockMFRepo *tests.MockMediaFileRepo + ) + + BeforeEach(func() { + mockMFRepo = &tests.MockMediaFileRepo{} + ds = &tests.MockDataStore{MockedMediaFile: mockMFRepo} + mockTD = &mockTranscodeDecision{} + router = New(ds, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, mockTD) + w = httptest.NewRecorder() + }) + + Describe("GetTranscodeDecision", func() { + It("returns 405 for non-POST requests", func() { + r := newGetRequest("mediaId=123", "mediaType=song") + resp, err := router.GetTranscodeDecision(w, r) + Expect(err).ToNot(HaveOccurred()) + Expect(resp).To(BeNil()) + Expect(w.Code).To(Equal(http.StatusMethodNotAllowed)) + Expect(w.Header().Get("Allow")).To(Equal("POST")) + }) + + It("returns error when mediaId is missing", func() { + r := newJSONPostRequest("mediaType=song", "{}") + _, err := router.GetTranscodeDecision(w, r) + Expect(err).To(HaveOccurred()) + }) + + It("returns error when mediaType is missing", func() { + r := newJSONPostRequest("mediaId=123", "{}") + _, err := router.GetTranscodeDecision(w, r) + Expect(err).To(HaveOccurred()) + }) + + It("returns error for unsupported mediaType", func() { + r := newJSONPostRequest("mediaId=123&mediaType=podcast", "{}") + _, err := router.GetTranscodeDecision(w, r) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("not yet supported")) + }) + + It("returns ErrorDataNotFound when media file does not exist", func() { + // mockMFRepo has no data set, so Get() returns model.ErrNotFound + r := newJSONPostRequest("mediaId=nonexistent&mediaType=song", "{}") + _, err := router.GetTranscodeDecision(w, r) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("media file not found")) + }) + + It("returns error when media file retrieval fails", func() { + mockMFRepo.SetError(true) + r := newJSONPostRequest("mediaId=song-1&mediaType=song", "{}") + _, err := router.GetTranscodeDecision(w, r) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("error retrieving media file")) + }) + + It("returns error when body is empty", func() { + r := newJSONPostRequest("mediaId=song-1&mediaType=song", "") + _, err := router.GetTranscodeDecision(w, r) + Expect(err).To(HaveOccurred()) + }) + + It("returns error when body contains invalid JSON", func() { + r := newJSONPostRequest("mediaId=song-1&mediaType=song", "not-json{{{") + _, err := router.GetTranscodeDecision(w, r) + Expect(err).To(HaveOccurred()) + }) + + It("returns error for invalid protocol in direct play profile", func() { + body := `{"directPlayProfiles":[{"containers":["mp3"],"audioCodecs":["mp3"],"protocols":["ftp"]}]}` + r := newJSONPostRequest("mediaId=song-1&mediaType=song", body) + _, err := router.GetTranscodeDecision(w, r) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("invalid protocol")) + }) + + It("returns error for invalid comparison operator", func() { + body := `{"codecProfiles":[{"type":"AudioCodec","name":"mp3","limitations":[{"name":"audioBitrate","comparison":"InvalidOp","values":["320"]}]}]}` + r := newJSONPostRequest("mediaId=song-1&mediaType=song", body) + _, err := router.GetTranscodeDecision(w, r) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("invalid comparison")) + }) + + It("returns error for invalid limitation name", func() { + body := `{"codecProfiles":[{"type":"AudioCodec","name":"mp3","limitations":[{"name":"unknownField","comparison":"Equals","values":["320"]}]}]}` + r := newJSONPostRequest("mediaId=song-1&mediaType=song", body) + _, err := router.GetTranscodeDecision(w, r) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("invalid limitation name")) + }) + + It("returns error for invalid codec profile type", func() { + body := `{"codecProfiles":[{"type":"VideoCodec","name":"mp3"}]}` + r := newJSONPostRequest("mediaId=song-1&mediaType=song", body) + _, err := router.GetTranscodeDecision(w, r) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("invalid codec profile type")) + }) + + It("rejects wrong-case protocol", func() { + body := `{"directPlayProfiles":[{"containers":["mp3"],"audioCodecs":["mp3"],"protocols":["HTTP"]}]}` + r := newJSONPostRequest("mediaId=song-1&mediaType=song", body) + _, err := router.GetTranscodeDecision(w, r) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("invalid protocol")) + }) + + It("rejects wrong-case codec profile type", func() { + body := `{"codecProfiles":[{"type":"audiocodec","name":"mp3"}]}` + r := newJSONPostRequest("mediaId=song-1&mediaType=song", body) + _, err := router.GetTranscodeDecision(w, r) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("invalid codec profile type")) + }) + + It("rejects wrong-case comparison operator", func() { + body := `{"codecProfiles":[{"type":"AudioCodec","name":"mp3","limitations":[{"name":"audioBitrate","comparison":"lessthanequal","values":["320"]}]}]}` + r := newJSONPostRequest("mediaId=song-1&mediaType=song", body) + _, err := router.GetTranscodeDecision(w, r) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("invalid comparison")) + }) + + It("rejects wrong-case limitation name", func() { + body := `{"codecProfiles":[{"type":"AudioCodec","name":"mp3","limitations":[{"name":"AudioBitrate","comparison":"Equals","values":["320"]}]}]}` + r := newJSONPostRequest("mediaId=song-1&mediaType=song", body) + _, err := router.GetTranscodeDecision(w, r) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("invalid limitation name")) + }) + + It("returns a valid decision response", func() { + mockMFRepo.SetData(model.MediaFiles{ + {ID: "song-1", Suffix: "mp3", Codec: "MP3", BitRate: 320, Channels: 2, SampleRate: 44100}, + }) + mockTD.decision = &stream.TranscodeDecision{ + MediaID: "song-1", + CanDirectPlay: true, + SourceStream: stream.Details{ + Container: "mp3", Codec: "mp3", Bitrate: 320, + SampleRate: 44100, Channels: 2, + }, + } + mockTD.token = "test-jwt-token" + + body := `{"directPlayProfiles":[{"containers":["mp3"],"protocols":["http"]}]}` + r := newJSONPostRequest("mediaId=song-1&mediaType=song", body) + resp, err := router.GetTranscodeDecision(w, r) + + Expect(err).ToNot(HaveOccurred()) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanDirectPlay).To(BeTrue()) + Expect(resp.TranscodeDecision.TranscodeParams).To(Equal("test-jwt-token")) + Expect(resp.TranscodeDecision.SourceStream).ToNot(BeNil()) + Expect(resp.TranscodeDecision.SourceStream.Protocol).To(Equal("http")) + Expect(resp.TranscodeDecision.SourceStream.Container).To(Equal("mp3")) + Expect(resp.TranscodeDecision.SourceStream.AudioBitrate).To(Equal(int32(320_000))) + }) + + It("filters AAC from transcoding profiles", func() { + mockMFRepo.SetData(model.MediaFiles{ + {ID: "song-1", Suffix: "opus", Codec: "opus", BitRate: 128, Channels: 2, SampleRate: 48000}, + }) + mockTD.decision = &stream.TranscodeDecision{MediaID: "song-1", CanDirectPlay: true} + mockTD.token = "token" + + body := `{ + "transcodingProfiles": [ + {"container": "aac", "audioCodec": "aac", "protocol": "http"}, + {"container": "mp3", "audioCodec": "mp3", "protocol": "http"}, + {"container": "m4a", "audioCodec": "aac", "protocol": "http"} + ] + }` + r := newJSONPostRequest("mediaId=song-1&mediaType=song", body) + _, err := router.GetTranscodeDecision(w, r) + + Expect(err).ToNot(HaveOccurred()) + Expect(mockTD.capturedClient).ToNot(BeNil()) + Expect(mockTD.capturedClient.TranscodingProfiles).To(HaveLen(1)) + Expect(mockTD.capturedClient.TranscodingProfiles[0].AudioCodec).To(Equal("mp3")) + }) + + It("includes transcode stream when transcoding", func() { + mockMFRepo.SetData(model.MediaFiles{ + {ID: "song-2", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 96000, BitDepth: 24}, + }) + mockTD.decision = &stream.TranscodeDecision{ + MediaID: "song-2", + CanDirectPlay: false, + CanTranscode: true, + TargetFormat: "mp3", + TargetBitrate: 256, + TranscodeReasons: []string{"container not supported"}, + SourceStream: stream.Details{ + Container: "flac", Codec: "flac", Bitrate: 1000, + SampleRate: 96000, BitDepth: 24, Channels: 2, + }, + TranscodeStream: &stream.Details{ + Container: "mp3", Codec: "mp3", Bitrate: 256, + SampleRate: 96000, Channels: 2, + }, + } + mockTD.token = "transcode-token" + + r := newJSONPostRequest("mediaId=song-2&mediaType=song", "{}") + resp, err := router.GetTranscodeDecision(w, r) + + Expect(err).ToNot(HaveOccurred()) + Expect(resp.TranscodeDecision.CanTranscode).To(BeTrue()) + Expect(resp.TranscodeDecision.TranscodeReasons).To(ConsistOf("container not supported")) + Expect(resp.TranscodeDecision.TranscodeStream).ToNot(BeNil()) + Expect(resp.TranscodeDecision.TranscodeStream.Container).To(Equal("mp3")) + }) + }) + + Describe("GetTranscodeStream", func() { + It("returns 400 when mediaId is missing", func() { + r := newGetRequest("mediaType=song", "transcodeParams=abc") + resp, err := router.GetTranscodeStream(w, r) + Expect(err).ToNot(HaveOccurred()) + Expect(resp).To(BeNil()) + Expect(w.Code).To(Equal(http.StatusBadRequest)) + }) + + It("returns 400 when transcodeParams is missing", func() { + r := newGetRequest("mediaId=123", "mediaType=song") + resp, err := router.GetTranscodeStream(w, r) + Expect(err).ToNot(HaveOccurred()) + Expect(resp).To(BeNil()) + Expect(w.Code).To(Equal(http.StatusBadRequest)) + }) + + It("returns 410 for invalid or mismatched token", func() { + mockMFRepo.SetData(model.MediaFiles{{ID: "123"}}) + mockTD.resolveErr = stream.ErrTokenInvalid + r := newGetRequest("mediaId=123", "mediaType=song", "transcodeParams=bad-token") + resp, err := router.GetTranscodeStream(w, r) + Expect(err).ToNot(HaveOccurred()) + Expect(resp).To(BeNil()) + Expect(w.Code).To(Equal(http.StatusGone)) + }) + + It("returns 404 when media file not found", func() { + // mockMFRepo has no data, so Get() returns ErrNotFound + r := newGetRequest("mediaId=gone-id", "mediaType=song", "transcodeParams=valid-token") + resp, err := router.GetTranscodeStream(w, r) + Expect(err).ToNot(HaveOccurred()) + Expect(resp).To(BeNil()) + Expect(w.Code).To(Equal(http.StatusNotFound)) + }) + + It("returns 410 when media file has changed (stale token)", func() { + mockMFRepo.SetData(model.MediaFiles{{ID: "song-1"}}) + mockTD.resolveErr = stream.ErrTokenStale + r := newGetRequest("mediaId=song-1", "mediaType=song", "transcodeParams=stale-token") + resp, err := router.GetTranscodeStream(w, r) + Expect(err).ToNot(HaveOccurred()) + Expect(resp).To(BeNil()) + Expect(w.Code).To(Equal(http.StatusGone)) + }) + + It("builds correct StreamRequest for direct play", func() { + fakeStreamer := &fakeMediaStreamer{} + router = New(ds, nil, fakeStreamer, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, mockTD) + mockMFRepo.SetData(model.MediaFiles{{ID: "song-1"}}) + mockTD.resolvedReq = stream.Request{} + + r := newGetRequest("mediaId=song-1", "mediaType=song", "transcodeParams=valid-token") + _, _ = router.GetTranscodeStream(w, r) + + Expect(fakeStreamer.captured).ToNot(BeNil()) + Expect(fakeStreamer.captured.Format).To(BeEmpty()) + Expect(fakeStreamer.captured.BitRate).To(BeZero()) + Expect(fakeStreamer.captured.SampleRate).To(BeZero()) + Expect(fakeStreamer.captured.BitDepth).To(BeZero()) + Expect(fakeStreamer.captured.Channels).To(BeZero()) + }) + + It("builds correct StreamRequest for transcoding", func() { + fakeStreamer := &fakeMediaStreamer{} + router = New(ds, nil, fakeStreamer, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, mockTD) + mockMFRepo.SetData(model.MediaFiles{{ID: "song-2"}}) + mockTD.resolvedReq = stream.Request{ + Format: "mp3", + BitRate: 256, + SampleRate: 44100, + BitDepth: 16, + Channels: 2, + } + + r := newGetRequest("mediaId=song-2", "mediaType=song", "transcodeParams=valid-token", "offset=10") + _, _ = router.GetTranscodeStream(w, r) + + Expect(fakeStreamer.captured).ToNot(BeNil()) + Expect(fakeStreamer.captured.Format).To(Equal("mp3")) + Expect(fakeStreamer.captured.BitRate).To(Equal(256)) + Expect(fakeStreamer.captured.SampleRate).To(Equal(44100)) + Expect(fakeStreamer.captured.BitDepth).To(Equal(16)) + Expect(fakeStreamer.captured.Channels).To(Equal(2)) + Expect(fakeStreamer.captured.Offset).To(Equal(10)) + }) + }) + + Describe("bpsToKbps", func() { + It("converts standard bitrates", func() { + Expect(bpsToKbps(128000)).To(Equal(128)) + Expect(bpsToKbps(320000)).To(Equal(320)) + Expect(bpsToKbps(256000)).To(Equal(256)) + }) + It("returns 0 for 0", func() { + Expect(bpsToKbps(0)).To(Equal(0)) + }) + It("rounds instead of truncating", func() { + Expect(bpsToKbps(999)).To(Equal(1)) + Expect(bpsToKbps(500)).To(Equal(1)) + Expect(bpsToKbps(499)).To(Equal(0)) + }) + It("returns 0 for negative values", func() { + Expect(bpsToKbps(-1)).To(Equal(0)) + Expect(bpsToKbps(-1000)).To(Equal(0)) + Expect(bpsToKbps(-1000000)).To(Equal(0)) + }) + }) + + Describe("kbpsToBps", func() { + It("converts standard bitrates", func() { + Expect(kbpsToBps(128)).To(Equal(128000)) + Expect(kbpsToBps(320)).To(Equal(320000)) + }) + It("returns 0 for 0", func() { + Expect(kbpsToBps(0)).To(Equal(0)) + }) + }) + + Describe("convertBitrateValues", func() { + It("converts valid bps strings to kbps", func() { + Expect(convertBitrateValues([]string{"128000", "320000"})).To(Equal([]string{"128", "320"})) + }) + It("preserves unparseable values", func() { + Expect(convertBitrateValues([]string{"128000", "bad", "320000"})).To(Equal([]string{"128", "bad", "320"})) + }) + It("handles empty slice", func() { + Expect(convertBitrateValues([]string{})).To(Equal([]string{})) + }) + }) +}) + +// newJSONPostRequest creates an HTTP POST request with JSON body and query params +func newJSONPostRequest(queryParams string, jsonBody string) *http.Request { + r := httptest.NewRequest("POST", "/getTranscodeDecision?"+queryParams, bytes.NewBufferString(jsonBody)) + r.Header.Set("Content-Type", "application/json") + return r +} + +// mockTranscodeDecision is a test double for stream.TranscodeDecider +type mockTranscodeDecision struct { + decision *stream.TranscodeDecision + token string + tokenErr error + resolvedReq stream.Request + resolveErr error + capturedClient *stream.ClientInfo +} + +func (m *mockTranscodeDecision) MakeDecision(_ context.Context, _ *model.MediaFile, ci *stream.ClientInfo, _ stream.TranscodeOptions) (*stream.TranscodeDecision, error) { + m.capturedClient = ci + if m.decision != nil { + return m.decision, nil + } + return &stream.TranscodeDecision{}, nil +} + +func (m *mockTranscodeDecision) ResolveRequest(_ context.Context, _ *model.MediaFile, _ string, _ int, _ int) stream.Request { + return stream.Request{Format: "raw"} +} + +func (m *mockTranscodeDecision) CreateTranscodeParams(_ *stream.TranscodeDecision) (string, error) { + return m.token, m.tokenErr +} + +func (m *mockTranscodeDecision) ResolveRequestFromToken(_ context.Context, _ string, _ *model.MediaFile, offset int) (stream.Request, error) { + if m.resolveErr != nil { + return stream.Request{}, m.resolveErr + } + req := m.resolvedReq + req.Offset = offset + return req, nil +} + +// fakeMediaStreamer captures the StreamRequest and returns a sentinel error, +// allowing tests to verify parameter passing without constructing a real Stream. +var errStreamCaptured = errors.New("stream request captured") + +type fakeMediaStreamer struct { + captured *stream.Request +} + +func (f *fakeMediaStreamer) NewStream(_ context.Context, _ *model.MediaFile, req stream.Request) (*stream.Stream, error) { + f.captured = &req + return nil, errStreamCaptured +} diff --git a/server/subsonic/users.go b/server/subsonic/users.go index 733f3fddb..4f6dccaac 100644 --- a/server/subsonic/users.go +++ b/server/subsonic/users.go @@ -2,11 +2,13 @@ package subsonic import ( "net/http" + "strings" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/request" "github.com/navidrome/navidrome/server/subsonic/responses" + "github.com/navidrome/navidrome/utils/req" "github.com/navidrome/navidrome/utils/slice" ) @@ -20,6 +22,7 @@ func buildUserResponse(user model.User) responses.User { ScrobblingEnabled: true, DownloadRole: conf.Server.EnableDownloads, ShareRole: conf.Server.EnableSharing, + CoverArtRole: conf.Server.EnableCoverArtUpload || user.IsAdmin, Folder: slice.Map(user.Libraries, func(lib model.Library) int32 { return int32(lib.ID) }), } @@ -35,7 +38,13 @@ func (api *Router) GetUser(r *http.Request) (*responses.Subsonic, error) { if !ok { return nil, newError(responses.ErrorGeneric, "Internal error") } - + username, err := req.Params(r).String("username") + if err != nil { + return nil, err + } + if !strings.EqualFold(username, loggedUser.UserName) { + return nil, newError(responses.ErrorAuthorizationFail) + } response := newResponse() user := buildUserResponse(loggedUser) response.User = &user diff --git a/server/subsonic/users_test.go b/server/subsonic/users_test.go index e41c1af63..1fd5dce71 100644 --- a/server/subsonic/users_test.go +++ b/server/subsonic/users_test.go @@ -1,7 +1,7 @@ package subsonic import ( - "context" + "errors" "net/http/httptest" "github.com/navidrome/navidrome/conf" @@ -43,8 +43,8 @@ var _ = Describe("Users", func() { } // Create request with user in context - req := httptest.NewRequest("GET", "/rest/getUser", nil) - ctx := request.WithUser(context.Background(), testUser) + req := httptest.NewRequest("GET", "/rest/getUser?username=testuser", nil) + ctx := request.WithUser(GinkgoT().Context(), testUser) req = req.WithContext(ctx) userResponse, err1 := router.GetUser(req) @@ -63,6 +63,7 @@ var _ = Describe("Users", func() { Expect(userResponse.User.ScrobblingEnabled).To(BeTrue()) Expect(userResponse.User.DownloadRole).To(BeTrue()) Expect(userResponse.User.ShareRole).To(BeTrue()) + Expect(userResponse.User.CoverArtRole).To(BeTrue()) Expect(userResponse.User.Folder).To(ContainElements(int32(10), int32(20))) // Verify GetUsers response structure @@ -81,6 +82,7 @@ var _ = Describe("Users", func() { Expect(singleUser.ScrobblingEnabled).To(Equal(userFromList.ScrobblingEnabled)) Expect(singleUser.DownloadRole).To(Equal(userFromList.DownloadRole)) Expect(singleUser.ShareRole).To(Equal(userFromList.ShareRole)) + Expect(singleUser.CoverArtRole).To(Equal(userFromList.CoverArtRole)) Expect(singleUser.JukeboxRole).To(Equal(userFromList.JukeboxRole)) Expect(singleUser.Folder).To(Equal(userFromList.Folder)) }) @@ -102,6 +104,20 @@ var _ = Describe("Users", func() { Entry("jukebox enabled, admin-only, admin user", true, true, true, true), ) + DescribeTable("CoverArt role permissions", + func(enableCoverArtUpload, isAdmin, expectedCoverArtRole bool) { + conf.Server.EnableCoverArtUpload = enableCoverArtUpload + testUser.IsAdmin = isAdmin + + response := buildUserResponse(testUser) + Expect(response.CoverArtRole).To(Equal(expectedCoverArtRole)) + }, + Entry("enabled, regular user", true, false, true), + Entry("enabled, admin user", true, true, true), + Entry("disabled, regular user", false, false, false), + Entry("disabled, admin user", false, true, true), + ) + Describe("Folder list population", func() { It("should populate Folder field with user's accessible library IDs", func() { testUser.Libraries = model.Libraries{ @@ -116,4 +132,60 @@ var _ = Describe("Users", func() { Expect(response.Folder).To(ContainElements(int32(1), int32(2), int32(5))) }) }) + + Describe("GetUser authorization", func() { + It("should allow user to request their own information", func() { + req := httptest.NewRequest("GET", "/rest/getUser?username=testuser", nil) + ctx := request.WithUser(GinkgoT().Context(), testUser) + req = req.WithContext(ctx) + + response, err := router.GetUser(req) + + Expect(err).ToNot(HaveOccurred()) + Expect(response).ToNot(BeNil()) + Expect(response.User).ToNot(BeNil()) + Expect(response.User.Username).To(Equal("testuser")) + }) + + It("should deny user from requesting another user's information", func() { + req := httptest.NewRequest("GET", "/rest/getUser?username=anotheruser", nil) + ctx := request.WithUser(GinkgoT().Context(), testUser) + req = req.WithContext(ctx) + + response, err := router.GetUser(req) + + Expect(err).To(HaveOccurred()) + Expect(response).To(BeNil()) + + var subErr subError + ok := errors.As(err, &subErr) + Expect(ok).To(BeTrue()) + Expect(subErr.code).To(Equal(responses.ErrorAuthorizationFail)) + }) + + It("should return error when username parameter is missing", func() { + req := httptest.NewRequest("GET", "/rest/getUser", nil) + ctx := request.WithUser(GinkgoT().Context(), testUser) + req = req.WithContext(ctx) + + response, err := router.GetUser(req) + + Expect(err).To(MatchError("missing parameter: 'username'")) + Expect(response).To(BeNil()) + }) + + It("should return error when user context is missing", func() { + req := httptest.NewRequest("GET", "/rest/getUser?username=testuser", nil) + + response, err := router.GetUser(req) + + Expect(err).To(HaveOccurred()) + Expect(response).To(BeNil()) + + var subErr subError + ok := errors.As(err, &subErr) + Expect(ok).To(BeTrue()) + Expect(subErr.code).To(Equal(responses.ErrorGeneric)) + }) + }) }) diff --git a/server/testdata/test_cert.pem b/server/testdata/test_cert.pem new file mode 100644 index 000000000..1dfa573d6 --- /dev/null +++ b/server/testdata/test_cert.pem @@ -0,0 +1,23 @@ +-----BEGIN CERTIFICATE----- +MIIDwzCCAqugAwIBAgIUXqdUxUOo8kmsDe71iTR+Vr7btP8wDQYJKoZIhvcNAQEL +BQAwYjELMAkGA1UEBhMCVVMxDTALBgNVBAgMBFRlc3QxDTALBgNVBAcMBFRlc3Qx +EjAQBgNVBAoMCU5hdmlkcm9tZTENMAsGA1UECwwEVGVzdDESMBAGA1UEAwwJbG9j +YWxob3N0MCAXDTI1MTEyODE5NTkxNVoYDzIxMjUxMTA0MTk1OTE1WjBiMQswCQYD +VQQGEwJVUzENMAsGA1UECAwEVGVzdDENMAsGA1UEBwwEVGVzdDESMBAGA1UECgwJ +TmF2aWRyb21lMQ0wCwYDVQQLDARUZXN0MRIwEAYDVQQDDAlsb2NhbGhvc3QwggEi +MA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCkB/TQgl5ei5KRSHt5OJim8rKS +MzRlkK4BjSEM4D9ESbebdpEVjX48QuBYACrCvgvVp7mQGF5anl8Hm89trvd8ooVQ +x9IPQQ6gRKM+4gLrt9FHvFGGzZQS8UTQXN5oBi11E+8/Vs47HLUNXC2TRtRLCMyK +LYXQIXbhdp9anImlt+IHUxIQUchK6Zkld/gCm56X1bbzN/Zq91PQLpx2FZ0eZTjN +KaNgztLa+K/BDnTuk3iTTs9GEp6VCvqQE/6fk/UN/tkk2dLwKIFvPVR/YeAhVdz/ +OHC4L3B36QN3+VQ2yDjsp1PVAPX07UnzXO3Oj7uGYnMQxwprGMEubm3nADDxAgMB +AAGjbzBtMB0GA1UdDgQWBBRAZHUVuLyzc0CfuZR9ApqMbawIqzAfBgNVHSMEGDAW +gBRAZHUVuLyzc0CfuZR9ApqMbawIqzAPBgNVHRMBAf8EBTADAQH/MBoGA1UdEQQT +MBGCCWxvY2FsaG9zdIcEfwAAATANBgkqhkiG9w0BAQsFAAOCAQEAmDLXcPx9LNHs +GxQIE6Q5BXbVO7c8qrWmJf5FK5VWaifNZ9U+IBi+VlB4jCLK/OkwsviN/jOnwRYx +owjq0QG0YdRT4uD9fEMrAj+EwbnrQYZQvT0yGEWA+KW5TW08wt+/qnGJDwEgbjYJ +HTdICVMhs/e8Ex48fAgO8WSsdTDekOrhuwzIfeJ1LU4ZptLsD2ePFxuzutdIuW51 +/mspQGsjXqZ1qnLsavLXh/lds2g602rTpYBNZVjV9WiOvaQS8vviOxBN6f+9vgRz +a8SEbHqBG6jeyVqVZ7MjxcYxaIkxeBwMyMwgb+wwDfVXo2FZzX2TVeB7ZppI+IKv +TXYurWPYsQ== +-----END CERTIFICATE----- diff --git a/server/testdata/test_cert_encrypted.pem b/server/testdata/test_cert_encrypted.pem new file mode 100644 index 000000000..6f8de623a --- /dev/null +++ b/server/testdata/test_cert_encrypted.pem @@ -0,0 +1,22 @@ +-----BEGIN CERTIFICATE----- +MIIDpzCCAo+gAwIBAgIUEa7gEJYwJqYEJjTY7otQ+oUyELwwDQYJKoZIhvcNAQEL +BQAwYjELMAkGA1UEBhMCVVMxDTALBgNVBAgMBFRlc3QxDTALBgNVBAcMBFRlc3Qx +EjAQBgNVBAoMCU5hdmlkcm9tZTENMAsGA1UECwwEVGVzdDESMBAGA1UEAwwJbG9j +YWxob3N0MCAXDTI1MTEyODE5NTI0OVoYDzIxMjUxMTA0MTk1MjQ5WjBiMQswCQYD +VQQGEwJVUzENMAsGA1UECAwEVGVzdDENMAsGA1UEBwwEVGVzdDESMBAGA1UECgwJ +TmF2aWRyb21lMQ0wCwYDVQQLDARUZXN0MRIwEAYDVQQDDAlsb2NhbGhvc3QwggEi +MA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDBHgqJ1d9EnNxqoSZ6xXrIz/mV +Y0nWJW16/qIAvCdovSeTZhG9iqG8dUqcuu2BdD9MMHndJ2oFn3iD8EJR92dH8KBA +8xOmtZ0BEEWgXPBivywZVd1ChIflEWj6m5wwLNjb57SPpUiwaLxBQB8ByEaAAZE/ +bLqvHI3vW/4s5apky17SPIqmkmqEYlRcg97tlRXsPuwoAVM9cvLMMEqtIR1CB/72 +gboY2Gi2r/plLF/Rg3Dom6QljMWi57XXWJFwGYSXaZuM0gvn04e3oLu+1E+WMoq/ +9rExWij2DlsmXd/RiScliFp6R4H84wQUyqrAUNytvgRO+oVnRjEA0l3oCYdRAgMB +AAGjUzBRMB0GA1UdDgQWBBQQKpB1UaKm98FnBdl8uKdRscrVTzAfBgNVHSMEGDAW +gBQQKpB1UaKm98FnBdl8uKdRscrVTzAPBgNVHRMBAf8EBTADAQH/MA0GCSqGSIb3 +DQEBCwUAA4IBAQBP07l+2LmpFtcxqMGmsiNYwFuHpQCxJd4YRZHjLX7O+oJExMgR +2yP4mpMKurgKOv7unTDLwvjQRa6ZTYJCsYtvC6hbyqlGc7AfNTu6DKz8r35/2/V5 +hPsG5lNb91HhvHE839mLAvpi02LoFH2Sr8BR7s6qxfNKYcP8PUOJQXltJ6yAa8YJ +syeXQQ3RIyGsJANeaC06S3UdkBM5H5BLfIHnHu3GybJjwL51va4WCdHe8QV6GI0g +RDiThDVkBSXAr136vnMdlrYCxMoxY56itJ0zbYg2ELQKU9o1w/ZJQo9uvmy9jCoZ +Hy1L5a2vUDbsdONdvRkYZRHqMpG4bdD8D3j2 +-----END CERTIFICATE----- diff --git a/server/testdata/test_key.pem b/server/testdata/test_key.pem new file mode 100644 index 000000000..bac61f4a4 --- /dev/null +++ b/server/testdata/test_key.pem @@ -0,0 +1,28 @@ +-----BEGIN PRIVATE KEY----- +MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQCkB/TQgl5ei5KR +SHt5OJim8rKSMzRlkK4BjSEM4D9ESbebdpEVjX48QuBYACrCvgvVp7mQGF5anl8H +m89trvd8ooVQx9IPQQ6gRKM+4gLrt9FHvFGGzZQS8UTQXN5oBi11E+8/Vs47HLUN +XC2TRtRLCMyKLYXQIXbhdp9anImlt+IHUxIQUchK6Zkld/gCm56X1bbzN/Zq91PQ +Lpx2FZ0eZTjNKaNgztLa+K/BDnTuk3iTTs9GEp6VCvqQE/6fk/UN/tkk2dLwKIFv +PVR/YeAhVdz/OHC4L3B36QN3+VQ2yDjsp1PVAPX07UnzXO3Oj7uGYnMQxwprGMEu +bm3nADDxAgMBAAECggEABqJFvesP2v4FEvgd+kSWM+ZL34rPmy3zQ5/MDuPA20ep +89EjQ/5hdRl1TknPcOnTu7PZVuENa9fM2xdrl7GEU9eU0bQLJE/KwiOUgJYObS8V +eTO+DlghHXUBhfXDjux1CS+htOuTUqOyFNS+CR9Lta8o6ou1xjmcP7kW78i17mxF +TuH5SZlS8W9PFLXHCInbMtqGFaT2ss09kvoPk2FDvHfxEdy6M9tKkguz02g+4bqI +aAMp2N7AOfmRpC0HvVa1ZfZo5Z8/KMoNcIm3pV9DEVM369J9EzhnMNpkGben90aT +FqO2JNsy52wmXFZUc9xe8uPdfDahALCkBGncLyLNmQKBgQDZREjocjdzOoPSlCdx +mRNe9suHz2FpUpsHCPOCotG63hFVKpah/ZvpHSsQx5rXs/mawDTmzGY9GQiBrSvg +OhfHIyT3NOhVaNcMxTqJX7rs7OG8D0MBacD9ASSeZ89MUn8q1EHZr5qxLtXl5Ikw +mHtiGRdiKGFFrG9H0zncbGhy7QKBgQDBRhQ9RAasTdmUiNQly9GVFkXto4T/9UHx +rVU44htCI2IVZUMTGlNfclfxpByDrzyA56rMzN9SAkiIp4nPpMDs5hayXaaPoojs +CPzV7r2OjemZ6CTeQ1ODImRL8L/E3jJSgWd6YYoHSQ5hjEX4yT6ft0u0tZUfdMKd +VENWIJ/hlQKBgQCo2hXjeOi5R8+tN3EUKwhP9HOnX7dv+D/9jqpZa5qdpPpJeyjI +SmYCHKYci1Q+sWOaLiiu+km20B65UVFZGSzjmd+fs+GghzMifKGKo/iNK2ggFKhZ +j8vplRrVdQ45XZ/xNDbdLEmHzEN2QE+Skd7KFYADzCgU0vdFFdbRBPuD3QKBgGIq +fQctMRJ9LCE0akSURGwr9vKflmMHKCpfdqTAu0WZgS0K1Mm0GlqlUiPKzizYaauz +f14sRNV7kWnPZsDPlqn8p9SKmpnj3RW97uWeMCtiyx6/+VHm8ljts/GaY1zT2s1r +KqrPNfNDWQmU3MljNeqbh9lOTWK/xEVy0gzB31MNAoGAQNWrZvVdAbL95XW6STUu +JmQlqJTlluuqS0Rrd/uVEQwW0Vd1dZjRQcFAFiSiCQWTbtId5gFZd6hiIQl53Xz0 +5cd+9mcyA/TaoCJYbMOFYsKbZMCBhefsovJlVQXedqJrIY6BdeGlet4GTAH5Qyl0 +ytEIUnvn5YmmbI7PDz80XpU= +-----END PRIVATE KEY----- diff --git a/server/testdata/test_key_encrypted.pem b/server/testdata/test_key_encrypted.pem new file mode 100644 index 000000000..0ac715890 --- /dev/null +++ b/server/testdata/test_key_encrypted.pem @@ -0,0 +1,30 @@ +-----BEGIN ENCRYPTED PRIVATE KEY----- +MIIFNTBfBgkqhkiG9w0BBQ0wUjAxBgkqhkiG9w0BBQwwJAQQPH9PYzryCI3smm81 +J8rm+QICCAAwDAYIKoZIhvcNAgkFADAdBglghkgBZQMEASoEEI+9XxNfKSiMYIVB +UfcGfncEggTQVw7tPslGy3mlofCNnhBSnMViv9kj6M11smD6Y8vHG0k9Kq+6g+Dx +mQE9ILrSZBzM0uS3y484u+vkdqlT4KehhjIx0IiezurOcM45UdTAwLFLPzeEDlHI +lOWQ3gOTB3J5AxiUQOa6QsDIM7AZilidQG0BxQYWyRBA5B8evJwJoAvdzzA9wGSm +2YdNm3tA6rU5U8cVG+qTJP9pjbtRx0medC/CBZdxGkrWBQH+aySfahJdU8X1JI2e +SY4WJRw1rLCow+DnHjZS/IVHFJivJSRYvnvw8fwjOMVtkf+dAVctKlb1Fj9X+RdG +T1sq3i6zwFLE/RRz4qM4DKZ6UaD9wRFLow8FmNWVuJJiPgCLx2rrNMe32quS/kQP +iOsXAUeA/Yg1fdMCJORxl0nWDmLYcNtBghCmS1lyk+t+AKWwJudrds5tQQe8ha2t +Q41is+tDKwGDC1wt4WXJvBhgAJzuqFtr30H0M1eBhwwDdaDd9v0Zr3r8V49WZM2c +i3qkwPPYkQD+pOcR12xBV8ptvDxaUl7RGlVqnEWHagT51BaIaXQ9teUrG6UPt8o2 +LELJXF6CiwkbN6Y9sYx5XiKrIGxVhlQSZ1nB3XSFRHbu6e7VHPjnVwUeeg87J2Am +MEwqDzPU5sjKRn84+M91Y4uFAIeinaOJAQ0/tZVrf1iSeCMQyMUhW/8m7JPfG19F +NbJSPRXQuKmYKbWfXcMW2UFbp0zDs7s7p4zzbfde9IbVdq/o2nv3ZrNbrLak6O7y +FVt9q/xG4Tty6hSK6xtqtNZWcmfiMcTlk1Qcz2STvScbXtqgcgR6WUZfkLuzi09I +EDYFnzU5JNSY3U3VTv2hAPeU4xjTNM6kjF7L9JFGvdjH8Ko9UdxG9RZMd8xhBM/n +hxdzdVba4bDDz2z+0A2blSObrPrNsKr/3ZbnfuUiSs5NmqmUOifZ1t1PqGGO2Y5S +/cDKtrPk226hGomsUBfHtiIJPG1VRl4UaZiduqK3GGhtF491KU1mAfYzueok3TPq +JhLtLDIvEaFgmOmitFzROI/ifm6s4ssUvcvtbjwJumbjkU38OxYZFwbhwbe268G2 +vgspJamlEGJNdGDzrCFQlA2+A9kazCttztikfh5QGV6WFfkc3Bt1XTPL51vtliQy +MS2gUnJUY2fuYCfz8rxLH1kQmyYsHQz5rUYyBkeDffrG9MzarmzSJXR63FRzVMf1 +LQ7BSzei7dF6+J4KVCxjbGWF3GUGmGeOP5g5vJ3xb3YPJNJLT4Vai103pay59TGP +tESM2Vn0gJEvYApi707noFH5uFTW1cp7lloF41ddIUkL/QO7j+sjvBww+4DqBB7J +BmvLMnswa23yw9egYRG5jOXyCgIr+1rnNcph1HGJsvxvgJ2gwwo5NKCG8SC6LcZQ +fbDjX+ssmobLE3ktN03FZPMp32/ciexzuZoamfyiPXh7xE++ckifNEKJlNhx+kCG +mSR2wh+UGigQkgp/JxOzl6C4fhUbrEZr17oBqGim2p8h+GE0zD5JSHcn1rP86gGU +8JG/ilG4I8uMxUwhGj7amrWXUlJBd1by7e1EAL+utCo14/Tx3otB9/JtqY+lm9Ey +1ptPhMRQxvDNWrCmYM2kyrGghdNfEMir6GKDWI6PY9cwAFv/PLOxr1c= +-----END ENCRYPTED PRIVATE KEY----- diff --git a/server/testdata/test_key_encrypted_legacy.pem b/server/testdata/test_key_encrypted_legacy.pem new file mode 100644 index 000000000..4b9215cdf --- /dev/null +++ b/server/testdata/test_key_encrypted_legacy.pem @@ -0,0 +1,30 @@ +-----BEGIN RSA PRIVATE KEY----- +Proc-Type: 4,ENCRYPTED +DEK-Info: AES-256-CBC,3C969050EAB73F121B7F0E6B75C42525 + +V6pSaAsrn9CQNo4p88QshJLbg8zkQJEom81dPbYSVqQSZa9YlPtpLZ9YtuLj/Ay0 +TScEKIj/gzQ32wNl6nhcSNIL9yy+X11r5gNv1kIHkecf+EbDW20VOiJsfD+6LUyW +hA96AIbPOwc76iCuvsKHPKU9MlEmjGipmk/C2RQLHCZJ3WkiDRgCM8KQ7vKhfACT +w908yj4cB1e/P0JPq8t/3F7kPJ+6SVM1vMEffHl0otQR3rAyrK8QikwJ0K9qX62d +cqchTVlEyyZBYovR8DrRRUDbsXS5j1ZmX3NQpvTSTFowr+33fMrY+4Oz8sdR4yx1 +CQc0A0sHHxSEIr2xu4KzczwOYVJN8PVdU0pgvFj9KEm66N6EY5CSFIBHyO/ycOt9 +U+wpkRjf3zS6ZaUU0NKdOcop4YX33i99/tZF2RNR1i7ETLYph+/LCf09286Bi3u/ +UCCuWedyECPdz0c6j0s27Fdfc/HEK90OEzeWh/fc+H2gJZhqJYK9V47HPTQNNMnB +U1a6FsJlrKE3E6nfSnTLxrSx9m/XTV7HV+HkgX+q8VhN7Q2VHUqkPzE7ZOPYpZ+A +dQzsm1TmEMxym6osYqFzQScXR1NZasrV2MTQ2J16dUgCdGAM2YMUD9JaoJR+u77M +WAjYzDiRg84rLr/KbJPAwHbsfo2KpiapJGSBBEDhz4W1/LOrFhsjaqIMSy4yZDGm +1KqXGHIlqmuHI7v4fD8vuzhj7GUujRx85HSZWakE/uc6s5WrhkSeVKYJWPfpsxTv +dT3oLOGJ+nRzWxM3aFtuJghX0nIGdKxT4EAUNXz0/vLT3OP1QCZR+oELrriFzmtj ++O30bGH2SAFZEQJ/uTQg6celoNh89IzH4DJkcn67hqpX6mUiU9CrIr/eR9C/en8Q +smTbbC1C1pDUaCwR26Z+zgM90amh4yfOFKK2geO2Kj+TmwFHUvi6ZnSzMzCvty3t ++wdIrUtf55Lw51JCpLGl70mg4b/zBj5hqBkU2YvAAnz/htjfH/wrD6ZAF1TCdlRO +gyODrJjGRnLd/v0XLk0wp+RkAjBcSlRlkUvZY5BtugL7dIdwiNGGQPcOni9IVeG0 +6vDUEQnDOLYDj4d/JcckTLuHdrP+SW+0RQl2HK5+/w1hScGXN4O48gccu7yR/MN8 +DmpCg5rD/nq8sxJosmSt07GrN36KppYt8LCXQbSg3NG2Ad715caS2C+0Qtdm5MPD +rM1UyTXQYSJXgUN9yZS/pmzlguCywnnvsBPU6j3ljZwcoD41QJ/1OU09/W6sIMQR +IAiM35JHiLJiccFgxSE1qx5F1UZqX4P47jF0Wzi/sE/DYXg5qw2DoauqXNzqnumH +71UDGK1V6wQIV7UCZDa0WUfFzu470XpuFb8VmMOuHSQxkZESc9cz8k/ueAuO438Q +jnlkF1Ge2EEPuaK2zeaTj/lGyYA1AUfHRRgt/EMUQSBntmhlpnwVPYTVvYtHO2N5 +wp7/y39KirnlTl99i3XiOJ4WF4gIU2IaSlqMo4+e/A32h2JFi9QfNyfItXe6Fm1X +d0j2XGHzwMfHEFKdWyrgtVZwc38/1d6xWYAhs02b2basV/0AQhFTaKf5Z268eBNJ +-----END RSA PRIVATE KEY----- diff --git a/tests/fixtures/bom-test.lrc b/tests/fixtures/bom-test.lrc new file mode 100644 index 000000000..223c37de0 --- /dev/null +++ b/tests/fixtures/bom-test.lrc @@ -0,0 +1,4 @@ +[00:00.00] 作曲 : 柏大輔 +NOTE: This file intentionally contains a UTF-8 BOM (Byte Order Mark) at byte 0. +This tests BOM handling in lyrics parsing (GitHub issue #4631). +The BOM bytes are: 0xEF 0xBB 0xBF \ No newline at end of file diff --git a/tests/fixtures/bom-utf16-test.lrc b/tests/fixtures/bom-utf16-test.lrc new file mode 100644 index 000000000..e40ea3255 Binary files /dev/null and b/tests/fixtures/bom-utf16-test.lrc differ diff --git a/tests/fixtures/deezer.artist.bio.empty.json b/tests/fixtures/deezer.artist.bio.empty.json new file mode 100644 index 000000000..8bc0f6932 --- /dev/null +++ b/tests/fixtures/deezer.artist.bio.empty.json @@ -0,0 +1,10 @@ +{ + "data": { + "artist": { + "bio": null + } + }, + "extensions": { + "queryCost": 3 + } +} diff --git a/tests/fixtures/deezer.artist.bio.en.json b/tests/fixtures/deezer.artist.bio.en.json new file mode 100644 index 000000000..a1b838aa4 --- /dev/null +++ b/tests/fixtures/deezer.artist.bio.en.json @@ -0,0 +1,12 @@ +{ + "data": { + "artist": { + "bio": { + "full": "<p>Schoolmates Thomas and Guy-Manuel began their career in 1992 with the indie rock trio Darlin' (named after The Beach Boys song) but were scathingly dismissed by Melody Maker magazine as \"daft punk.\" Turning to house-inspired electronica, they used the put down as a name for their DJ-ing partnership and became a hugely successful and influential dance act. First major single <em>\"Da Funk\"</em> was accompanied by a Spike Jonze-directed video and more success followed with global dance floor anthem <em>\"Around the World,\" \"One More Time,\"</em> and <em>\"Harder, Faster, Better, Stronger\"</em> - which was sampled by Kanye West for his hit <em>\"Stronger.\"</em> Albums <em>Homework</em> (1997), <em>Discovery</em> (2001) and <em>Human After All</em> (2005) all made the UK Top 10 establishing a style of simple, Chicago house-inspired grooves exploding into a robotic, rave sound.</p>" + } + } + }, + "extensions": { + "queryCost": 3 + } +} diff --git a/tests/fixtures/deezer.artist.bio.fr.json b/tests/fixtures/deezer.artist.bio.fr.json new file mode 100644 index 000000000..435f6fcf0 --- /dev/null +++ b/tests/fixtures/deezer.artist.bio.fr.json @@ -0,0 +1,12 @@ +{ + "data": { + "artist": { + "bio": { + "full": "Guy-Manuel de Homem Christo et Thomas Bangalter se rencontrent en 1987 au lycée Carnot de Paris. Partageant une même passion pour la musique, les deux amis fondent en 1992 Darlin', un groupe de rock influencé par les Stooges et MC5, dont la production sera taxée par un critique de la presse anglaise de «daft punk» (« punk idiot »). <br />\n<br />\nDécouragés face à l'apathie du milieu rock, ils décident un peu plus tard de se lancer à corps perdus dans le courant Techno alors en pleine explosion. Arrive alors la découverte de la House, des clubs et des raves, dont une en particulier qui déterminera leur avenir : en 1993 est organisé à EuroDisney une rave où notre duo rencontre les dirigeants du label techno écossais Soma." + } + } + }, + "extensions": { + "queryCost": 3 + } +} diff --git a/tests/fixtures/deezer.artist.related.json b/tests/fixtures/deezer.artist.related.json new file mode 100644 index 000000000..2a55b303e --- /dev/null +++ b/tests/fixtures/deezer.artist.related.json @@ -0,0 +1 @@ +{"data":[{"id":6404,"name":"Justice","link":"https:\/\/www.deezer.com\/artist\/6404","picture":"https:\/\/api.deezer.com\/artist\/6404\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/e5bf29cb99852f92a0079b184ace9479\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/e5bf29cb99852f92a0079b184ace9479\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/e5bf29cb99852f92a0079b184ace9479\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/e5bf29cb99852f92a0079b184ace9479\/1000x1000-000000-80-0-0.jpg","nb_album":41,"nb_fan":774236,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/6404\/top?limit=50","type":"artist"},{"id":2049,"name":"Cassius","link":"https:\/\/www.deezer.com\/artist\/2049","picture":"https:\/\/api.deezer.com\/artist\/2049\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/7ed91fa11a9785a82e63fd9058821d8a\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/7ed91fa11a9785a82e63fd9058821d8a\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/7ed91fa11a9785a82e63fd9058821d8a\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/7ed91fa11a9785a82e63fd9058821d8a\/1000x1000-000000-80-0-0.jpg","nb_album":25,"nb_fan":127692,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/2049\/top?limit=50","type":"artist"},{"id":2318,"name":"Etienne de Cr\u00e9cy","link":"https:\/\/www.deezer.com\/artist\/2318","picture":"https:\/\/api.deezer.com\/artist\/2318\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/b9efa1b51be3c2a506006a77517967f7\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/b9efa1b51be3c2a506006a77517967f7\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/b9efa1b51be3c2a506006a77517967f7\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/b9efa1b51be3c2a506006a77517967f7\/1000x1000-000000-80-0-0.jpg","nb_album":58,"nb_fan":104626,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/2318\/top?limit=50","type":"artist"},{"id":72041,"name":"Yuksek","link":"https:\/\/www.deezer.com\/artist\/72041","picture":"https:\/\/api.deezer.com\/artist\/72041\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/5e0fd4c6b670682861abcc825eb3db50\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/5e0fd4c6b670682861abcc825eb3db50\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/5e0fd4c6b670682861abcc825eb3db50\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/5e0fd4c6b670682861abcc825eb3db50\/1000x1000-000000-80-0-0.jpg","nb_album":102,"nb_fan":115772,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/72041\/top?limit=50","type":"artist"},{"id":81,"name":"The Chemical Brothers","link":"https:\/\/www.deezer.com\/artist\/81","picture":"https:\/\/api.deezer.com\/artist\/81\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/5294e68e9ef4f0359237935a4b8388f2\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/5294e68e9ef4f0359237935a4b8388f2\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/5294e68e9ef4f0359237935a4b8388f2\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/5294e68e9ef4f0359237935a4b8388f2\/1000x1000-000000-80-0-0.jpg","nb_album":83,"nb_fan":1433333,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/81\/top?limit=50","type":"artist"},{"id":3771,"name":"Mr. Oizo","link":"https:\/\/www.deezer.com\/artist\/3771","picture":"https:\/\/api.deezer.com\/artist\/3771\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/589305cb56ea3555b1f94341955bf875\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/589305cb56ea3555b1f94341955bf875\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/589305cb56ea3555b1f94341955bf875\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/589305cb56ea3555b1f94341955bf875\/1000x1000-000000-80-0-0.jpg","nb_album":31,"nb_fan":172085,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/3771\/top?limit=50","type":"artist"},{"id":9905,"name":"Alex Gopher","link":"https:\/\/www.deezer.com\/artist\/9905","picture":"https:\/\/api.deezer.com\/artist\/9905\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/c4676bdbf3259decd69491523a1ace8f\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/c4676bdbf3259decd69491523a1ace8f\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/c4676bdbf3259decd69491523a1ace8f\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/c4676bdbf3259decd69491523a1ace8f\/1000x1000-000000-80-0-0.jpg","nb_album":46,"nb_fan":10430,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/9905\/top?limit=50","type":"artist"},{"id":7914,"name":"Demon","link":"https:\/\/www.deezer.com\/artist\/7914","picture":"https:\/\/api.deezer.com\/artist\/7914\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/c7c1f4d1f1cf6bdf04a6fc54ea65ef78\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/c7c1f4d1f1cf6bdf04a6fc54ea65ef78\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/c7c1f4d1f1cf6bdf04a6fc54ea65ef78\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/c7c1f4d1f1cf6bdf04a6fc54ea65ef78\/1000x1000-000000-80-0-0.jpg","nb_album":21,"nb_fan":9286,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/7914\/top?limit=50","type":"artist"},{"id":8937,"name":"SebastiAn","link":"https:\/\/www.deezer.com\/artist\/8937","picture":"https:\/\/api.deezer.com\/artist\/8937\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/0151acdea8a8d5f8e3aefabf6f034575\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/0151acdea8a8d5f8e3aefabf6f034575\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/0151acdea8a8d5f8e3aefabf6f034575\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/0151acdea8a8d5f8e3aefabf6f034575\/1000x1000-000000-80-0-0.jpg","nb_album":48,"nb_fan":74884,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/8937\/top?limit=50","type":"artist"},{"id":2508,"name":"Digitalism","link":"https:\/\/www.deezer.com\/artist\/2508","picture":"https:\/\/api.deezer.com\/artist\/2508\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/21e56c7147508853dcdfd9997cd8d271\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/21e56c7147508853dcdfd9997cd8d271\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/21e56c7147508853dcdfd9997cd8d271\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/21e56c7147508853dcdfd9997cd8d271\/1000x1000-000000-80-0-0.jpg","nb_album":79,"nb_fan":158628,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/2508\/top?limit=50","type":"artist"},{"id":11703,"name":"Alan Braxe","link":"https:\/\/www.deezer.com\/artist\/11703","picture":"https:\/\/api.deezer.com\/artist\/11703\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/0de64f7a63728f09520f987249630d7e\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/0de64f7a63728f09520f987249630d7e\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/0de64f7a63728f09520f987249630d7e\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/0de64f7a63728f09520f987249630d7e\/1000x1000-000000-80-0-0.jpg","nb_album":25,"nb_fan":12595,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/11703\/top?limit=50","type":"artist"},{"id":574,"name":"Para One","link":"https:\/\/www.deezer.com\/artist\/574","picture":"https:\/\/api.deezer.com\/artist\/574\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/2560ff01d72f5e4a768e55892ad066e4\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/2560ff01d72f5e4a768e55892ad066e4\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/2560ff01d72f5e4a768e55892ad066e4\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/2560ff01d72f5e4a768e55892ad066e4\/1000x1000-000000-80-0-0.jpg","nb_album":40,"nb_fan":30828,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/574\/top?limit=50","type":"artist"},{"id":4397,"name":"Kojak","link":"https:\/\/www.deezer.com\/artist\/4397","picture":"https:\/\/api.deezer.com\/artist\/4397\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/817caeb7fa22eb511371ac260680d5fa\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/817caeb7fa22eb511371ac260680d5fa\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/817caeb7fa22eb511371ac260680d5fa\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/817caeb7fa22eb511371ac260680d5fa\/1000x1000-000000-80-0-0.jpg","nb_album":55,"nb_fan":1522,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/4397\/top?limit=50","type":"artist"},{"id":12439,"name":"Busy P","link":"https:\/\/www.deezer.com\/artist\/12439","picture":"https:\/\/api.deezer.com\/artist\/12439\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/6483408c3e46e8fa8872a805dfe6d5e0\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/6483408c3e46e8fa8872a805dfe6d5e0\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/6483408c3e46e8fa8872a805dfe6d5e0\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/6483408c3e46e8fa8872a805dfe6d5e0\/1000x1000-000000-80-0-0.jpg","nb_album":12,"nb_fan":65585,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/12439\/top?limit=50","type":"artist"},{"id":11656979,"name":"Mr Flash","link":"https:\/\/www.deezer.com\/artist\/11656979","picture":"https:\/\/api.deezer.com\/artist\/11656979\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/f953922c8caa74c5b48feaa07622b1ee\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/f953922c8caa74c5b48feaa07622b1ee\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/f953922c8caa74c5b48feaa07622b1ee\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/f953922c8caa74c5b48feaa07622b1ee\/1000x1000-000000-80-0-0.jpg","nb_album":7,"nb_fan":769,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/11656979\/top?limit=50","type":"artist"},{"id":76,"name":"Fatboy Slim","link":"https:\/\/www.deezer.com\/artist\/76","picture":"https:\/\/api.deezer.com\/artist\/76\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/f6ea7bd64ec1902feff17935fdfea263\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/f6ea7bd64ec1902feff17935fdfea263\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/f6ea7bd64ec1902feff17935fdfea263\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/f6ea7bd64ec1902feff17935fdfea263\/1000x1000-000000-80-0-0.jpg","nb_album":76,"nb_fan":1231355,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/76\/top?limit=50","type":"artist"},{"id":11265,"name":"Lifelike","link":"https:\/\/www.deezer.com\/artist\/11265","picture":"https:\/\/api.deezer.com\/artist\/11265\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/04f88199a69a646f6253808b58753629\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/04f88199a69a646f6253808b58753629\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/04f88199a69a646f6253808b58753629\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/04f88199a69a646f6253808b58753629\/1000x1000-000000-80-0-0.jpg","nb_album":38,"nb_fan":8316,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/11265\/top?limit=50","type":"artist"},{"id":2048,"name":"Groove Armada","link":"https:\/\/www.deezer.com\/artist\/2048","picture":"https:\/\/api.deezer.com\/artist\/2048\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/0acbb71c44e4ecdefd102630f4cfc808\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/0acbb71c44e4ecdefd102630f4cfc808\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/0acbb71c44e4ecdefd102630f4cfc808\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/0acbb71c44e4ecdefd102630f4cfc808\/1000x1000-000000-80-0-0.jpg","nb_album":92,"nb_fan":173879,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/2048\/top?limit=50","type":"artist"},{"id":71708,"name":"Surkin","link":"https:\/\/www.deezer.com\/artist\/71708","picture":"https:\/\/api.deezer.com\/artist\/71708\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/d2137c57fbdc9aa275b93e78b619b477\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/d2137c57fbdc9aa275b93e78b619b477\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/d2137c57fbdc9aa275b93e78b619b477\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/d2137c57fbdc9aa275b93e78b619b477\/1000x1000-000000-80-0-0.jpg","nb_album":15,"nb_fan":23101,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/71708\/top?limit=50","type":"artist"},{"id":166713,"name":"Fred Falke","link":"https:\/\/www.deezer.com\/artist\/166713","picture":"https:\/\/api.deezer.com\/artist\/166713\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/883821e7c5325cfa07fc660884a40624\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/883821e7c5325cfa07fc660884a40624\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/883821e7c5325cfa07fc660884a40624\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/883821e7c5325cfa07fc660884a40624\/1000x1000-000000-80-0-0.jpg","nb_album":67,"nb_fan":9688,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/166713\/top?limit=50","type":"artist"}],"total":20} \ No newline at end of file diff --git a/tests/fixtures/deezer.artist.top.json b/tests/fixtures/deezer.artist.top.json new file mode 100644 index 000000000..e3f22a1aa --- /dev/null +++ b/tests/fixtures/deezer.artist.top.json @@ -0,0 +1 @@ +{"data":[{"id":67238732,"readable":true,"title":"Instant Crush (feat. Julian Casablancas)","title_short":"Instant Crush","title_version":"(feat. Julian Casablancas)","link":"https:\/\/www.deezer.com\/track\/67238732","duration":337,"rank":944042,"explicit_lyrics":false,"explicit_content_lyrics":0,"explicit_content_cover":0,"preview":"https:\/\/cdnt-preview.dzcdn.net\/api\/1\/1\/d\/6\/b\/0\/d6bc80aadfa1d7625d59a6620f229371.mp3?hdnea=exp=1763672105~acl=\/api\/1\/1\/d\/6\/b\/0\/d6bc80aadfa1d7625d59a6620f229371.mp3*~data=user_id=0,application_id=42~hmac=66213cecf953c7ef8b4d89e3539a1355d318679c5ab54cac2007d4effa6c3bf4","contributors":[{"id":27,"name":"Daft Punk","link":"https:\/\/www.deezer.com\/artist\/27","share":"https:\/\/www.deezer.com\/artist\/27?utm_source=deezer&utm_content=artist-27&utm_term=0_1763671205&utm_medium=web","picture":"https:\/\/api.deezer.com\/artist\/27\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/1000x1000-000000-80-0-0.jpg","radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/27\/top?limit=50","type":"artist","role":"Main"},{"id":295821,"name":"Julian Casablancas","link":"https:\/\/www.deezer.com\/artist\/295821","share":"https:\/\/www.deezer.com\/artist\/295821?utm_source=deezer&utm_content=artist-295821&utm_term=0_1763671205&utm_medium=web","picture":"https:\/\/api.deezer.com\/artist\/295821\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/74e78538aefe2a6a49a851e569fc9f19\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/74e78538aefe2a6a49a851e569fc9f19\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/74e78538aefe2a6a49a851e569fc9f19\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/74e78538aefe2a6a49a851e569fc9f19\/1000x1000-000000-80-0-0.jpg","radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/295821\/top?limit=50","type":"artist","role":"Main"}],"md5_image":"311bba0fc112d15f72c8b5a65f0456c1","artist":{"id":27,"name":"Daft Punk","tracklist":"https:\/\/api.deezer.com\/artist\/27\/top?limit=50","type":"artist"},"album":{"id":6575789,"title":"Random Access Memories","cover":"https:\/\/api.deezer.com\/album\/6575789\/image","cover_small":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/311bba0fc112d15f72c8b5a65f0456c1\/56x56-000000-80-0-0.jpg","cover_medium":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/311bba0fc112d15f72c8b5a65f0456c1\/250x250-000000-80-0-0.jpg","cover_big":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/311bba0fc112d15f72c8b5a65f0456c1\/500x500-000000-80-0-0.jpg","cover_xl":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/311bba0fc112d15f72c8b5a65f0456c1\/1000x1000-000000-80-0-0.jpg","md5_image":"311bba0fc112d15f72c8b5a65f0456c1","tracklist":"https:\/\/api.deezer.com\/album\/6575789\/tracks","type":"album"},"type":"track"},{"id":3135553,"readable":true,"title":"One More Time","title_short":"One More Time","title_version":"","link":"https:\/\/www.deezer.com\/track\/3135553","duration":320,"rank":888570,"explicit_lyrics":false,"explicit_content_lyrics":0,"explicit_content_cover":0,"preview":"https:\/\/cdnt-preview.dzcdn.net\/api\/1\/1\/f\/8\/c\/0\/f8c5dc3837912dba37c9a1ab3170cc3f.mp3?hdnea=exp=1763672105~acl=\/api\/1\/1\/f\/8\/c\/0\/f8c5dc3837912dba37c9a1ab3170cc3f.mp3*~data=user_id=0,application_id=42~hmac=0824ec7ad045b82c04904fcd5f2a8ec2175acbe3d1649030d457023fdef45620","contributors":[{"id":27,"name":"Daft Punk","link":"https:\/\/www.deezer.com\/artist\/27","share":"https:\/\/www.deezer.com\/artist\/27?utm_source=deezer&utm_content=artist-27&utm_term=0_1763671205&utm_medium=web","picture":"https:\/\/api.deezer.com\/artist\/27\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/1000x1000-000000-80-0-0.jpg","radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/27\/top?limit=50","type":"artist","role":"Main"}],"md5_image":"5718f7c81c27e0b2417e2a4c45224f8a","artist":{"id":27,"name":"Daft Punk","tracklist":"https:\/\/api.deezer.com\/artist\/27\/top?limit=50","type":"artist"},"album":{"id":302127,"title":"Discovery","cover":"https:\/\/api.deezer.com\/album\/302127\/image","cover_small":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/5718f7c81c27e0b2417e2a4c45224f8a\/56x56-000000-80-0-0.jpg","cover_medium":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/5718f7c81c27e0b2417e2a4c45224f8a\/250x250-000000-80-0-0.jpg","cover_big":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/5718f7c81c27e0b2417e2a4c45224f8a\/500x500-000000-80-0-0.jpg","cover_xl":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/5718f7c81c27e0b2417e2a4c45224f8a\/1000x1000-000000-80-0-0.jpg","md5_image":"5718f7c81c27e0b2417e2a4c45224f8a","tracklist":"https:\/\/api.deezer.com\/album\/302127\/tracks","type":"album"},"type":"track"},{"id":66609426,"readable":true,"title":"Get Lucky (Radio Edit - feat. Pharrell Williams and Nile Rodgers)","title_short":"Get Lucky","title_version":"(Radio Edit - feat. Pharrell Williams and Nile Rodgers)","link":"https:\/\/www.deezer.com\/track\/66609426","duration":248,"rank":952197,"explicit_lyrics":false,"explicit_content_lyrics":0,"explicit_content_cover":0,"preview":"https:\/\/cdnt-preview.dzcdn.net\/api\/1\/1\/1\/b\/f\/0\/1bf80a82992903ff685ba1b7275223f8.mp3?hdnea=exp=1763672105~acl=\/api\/1\/1\/1\/b\/f\/0\/1bf80a82992903ff685ba1b7275223f8.mp3*~data=user_id=0,application_id=42~hmac=c6dfe58571df62f41e7b326dd9afebf87015541c06a521ebc88fc18671d8d06d","contributors":[{"id":27,"name":"Daft Punk","link":"https:\/\/www.deezer.com\/artist\/27","share":"https:\/\/www.deezer.com\/artist\/27?utm_source=deezer&utm_content=artist-27&utm_term=0_1763671205&utm_medium=web","picture":"https:\/\/api.deezer.com\/artist\/27\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/1000x1000-000000-80-0-0.jpg","radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/27\/top?limit=50","type":"artist","role":"Main"},{"id":103,"name":"Pharrell Williams","link":"https:\/\/www.deezer.com\/artist\/103","share":"https:\/\/www.deezer.com\/artist\/103?utm_source=deezer&utm_content=artist-103&utm_term=0_1763671205&utm_medium=web","picture":"https:\/\/api.deezer.com\/artist\/103\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/1267b8781c5bff065a20dca4a3c9fda7\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/1267b8781c5bff065a20dca4a3c9fda7\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/1267b8781c5bff065a20dca4a3c9fda7\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/1267b8781c5bff065a20dca4a3c9fda7\/1000x1000-000000-80-0-0.jpg","radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/103\/top?limit=50","type":"artist","role":"Main"},{"id":7207,"name":"Nile Rodgers","link":"https:\/\/www.deezer.com\/artist\/7207","share":"https:\/\/www.deezer.com\/artist\/7207?utm_source=deezer&utm_content=artist-7207&utm_term=0_1763671205&utm_medium=web","picture":"https:\/\/api.deezer.com\/artist\/7207\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/64f826f318c84ce50ff538c01f62f1ff\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/64f826f318c84ce50ff538c01f62f1ff\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/64f826f318c84ce50ff538c01f62f1ff\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/64f826f318c84ce50ff538c01f62f1ff\/1000x1000-000000-80-0-0.jpg","radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/7207\/top?limit=50","type":"artist","role":"Main"}],"md5_image":"bc49adb87758e0c8c4e508a9c5cce85d","artist":{"id":27,"name":"Daft Punk","tracklist":"https:\/\/api.deezer.com\/artist\/27\/top?limit=50","type":"artist"},"album":{"id":6516139,"title":"Get Lucky (Radio Edit - feat. Pharrell Williams and Nile Rodgers)","cover":"https:\/\/api.deezer.com\/album\/6516139\/image","cover_small":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/bc49adb87758e0c8c4e508a9c5cce85d\/56x56-000000-80-0-0.jpg","cover_medium":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/bc49adb87758e0c8c4e508a9c5cce85d\/250x250-000000-80-0-0.jpg","cover_big":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/bc49adb87758e0c8c4e508a9c5cce85d\/500x500-000000-80-0-0.jpg","cover_xl":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/bc49adb87758e0c8c4e508a9c5cce85d\/1000x1000-000000-80-0-0.jpg","md5_image":"bc49adb87758e0c8c4e508a9c5cce85d","tracklist":"https:\/\/api.deezer.com\/album\/6516139\/tracks","type":"album"},"type":"track"},{"id":67238735,"readable":true,"title":"Get Lucky (feat. Pharrell Williams and Nile Rodgers)","title_short":"Get Lucky","title_version":"(feat. Pharrell Williams and Nile Rodgers)","link":"https:\/\/www.deezer.com\/track\/67238735","duration":367,"rank":873875,"explicit_lyrics":false,"explicit_content_lyrics":0,"explicit_content_cover":0,"preview":"https:\/\/cdnt-preview.dzcdn.net\/api\/1\/1\/c\/8\/a\/0\/c8a61130657a2cf58e3ac751e7950617.mp3?hdnea=exp=1763672105~acl=\/api\/1\/1\/c\/8\/a\/0\/c8a61130657a2cf58e3ac751e7950617.mp3*~data=user_id=0,application_id=42~hmac=92002e6bade5ff82dd44751e8998beaa60844210df1d73b8f1bf7dafb02dc5c3","contributors":[{"id":27,"name":"Daft Punk","link":"https:\/\/www.deezer.com\/artist\/27","share":"https:\/\/www.deezer.com\/artist\/27?utm_source=deezer&utm_content=artist-27&utm_term=0_1763671205&utm_medium=web","picture":"https:\/\/api.deezer.com\/artist\/27\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/1000x1000-000000-80-0-0.jpg","radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/27\/top?limit=50","type":"artist","role":"Main"},{"id":103,"name":"Pharrell Williams","link":"https:\/\/www.deezer.com\/artist\/103","share":"https:\/\/www.deezer.com\/artist\/103?utm_source=deezer&utm_content=artist-103&utm_term=0_1763671205&utm_medium=web","picture":"https:\/\/api.deezer.com\/artist\/103\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/1267b8781c5bff065a20dca4a3c9fda7\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/1267b8781c5bff065a20dca4a3c9fda7\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/1267b8781c5bff065a20dca4a3c9fda7\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/1267b8781c5bff065a20dca4a3c9fda7\/1000x1000-000000-80-0-0.jpg","radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/103\/top?limit=50","type":"artist","role":"Main"},{"id":7207,"name":"Nile Rodgers","link":"https:\/\/www.deezer.com\/artist\/7207","share":"https:\/\/www.deezer.com\/artist\/7207?utm_source=deezer&utm_content=artist-7207&utm_term=0_1763671205&utm_medium=web","picture":"https:\/\/api.deezer.com\/artist\/7207\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/64f826f318c84ce50ff538c01f62f1ff\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/64f826f318c84ce50ff538c01f62f1ff\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/64f826f318c84ce50ff538c01f62f1ff\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/64f826f318c84ce50ff538c01f62f1ff\/1000x1000-000000-80-0-0.jpg","radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/7207\/top?limit=50","type":"artist","role":"Main"}],"md5_image":"311bba0fc112d15f72c8b5a65f0456c1","artist":{"id":27,"name":"Daft Punk","tracklist":"https:\/\/api.deezer.com\/artist\/27\/top?limit=50","type":"artist"},"album":{"id":6575789,"title":"Random Access Memories","cover":"https:\/\/api.deezer.com\/album\/6575789\/image","cover_small":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/311bba0fc112d15f72c8b5a65f0456c1\/56x56-000000-80-0-0.jpg","cover_medium":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/311bba0fc112d15f72c8b5a65f0456c1\/250x250-000000-80-0-0.jpg","cover_big":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/311bba0fc112d15f72c8b5a65f0456c1\/500x500-000000-80-0-0.jpg","cover_xl":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/311bba0fc112d15f72c8b5a65f0456c1\/1000x1000-000000-80-0-0.jpg","md5_image":"311bba0fc112d15f72c8b5a65f0456c1","tracklist":"https:\/\/api.deezer.com\/album\/6575789\/tracks","type":"album"},"type":"track"},{"id":3129775,"readable":true,"title":"Around the World","title_short":"Around the World","title_version":"","link":"https:\/\/www.deezer.com\/track\/3129775","duration":429,"rank":829911,"explicit_lyrics":false,"explicit_content_lyrics":0,"explicit_content_cover":0,"preview":"https:\/\/cdnt-preview.dzcdn.net\/api\/1\/1\/a\/4\/7\/0\/a47dbed01e6d9b0ac4e39a134f745ca2.mp3?hdnea=exp=1763672105~acl=\/api\/1\/1\/a\/4\/7\/0\/a47dbed01e6d9b0ac4e39a134f745ca2.mp3*~data=user_id=0,application_id=42~hmac=9b7aa12b647cabd3219779e0270e51e639dc326442071fceb6d723c331059a67","contributors":[{"id":27,"name":"Daft Punk","link":"https:\/\/www.deezer.com\/artist\/27","share":"https:\/\/www.deezer.com\/artist\/27?utm_source=deezer&utm_content=artist-27&utm_term=0_1763671205&utm_medium=web","picture":"https:\/\/api.deezer.com\/artist\/27\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/1000x1000-000000-80-0-0.jpg","radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/27\/top?limit=50","type":"artist","role":"Main"}],"md5_image":"b870579c8650cd59b1cce656dde2ef17","artist":{"id":27,"name":"Daft Punk","tracklist":"https:\/\/api.deezer.com\/artist\/27\/top?limit=50","type":"artist"},"album":{"id":301775,"title":"Homework","cover":"https:\/\/api.deezer.com\/album\/301775\/image","cover_small":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/b870579c8650cd59b1cce656dde2ef17\/56x56-000000-80-0-0.jpg","cover_medium":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/b870579c8650cd59b1cce656dde2ef17\/250x250-000000-80-0-0.jpg","cover_big":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/b870579c8650cd59b1cce656dde2ef17\/500x500-000000-80-0-0.jpg","cover_xl":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/b870579c8650cd59b1cce656dde2ef17\/1000x1000-000000-80-0-0.jpg","md5_image":"b870579c8650cd59b1cce656dde2ef17","tracklist":"https:\/\/api.deezer.com\/album\/301775\/tracks","type":"album"},"type":"track"}],"total":100,"next":"https:\/\/api.deezer.com\/artist\/27\/top?index=5"} \ No newline at end of file diff --git a/tests/fixtures/lastfm.album.getinfo.empty.json b/tests/fixtures/lastfm.album.getinfo.empty.json new file mode 100644 index 000000000..06403ff8c --- /dev/null +++ b/tests/fixtures/lastfm.album.getinfo.empty.json @@ -0,0 +1 @@ +{"album":{"artist":"Legião Urbana","mbid":"1749dd07-5aa9-436e-babc-e3e982deb273","tags":{"tag":[{"url":"https:\/\/www.last.fm\/tag\/rock","name":"rock"},{"url":"https:\/\/www.last.fm\/tag\/80s","name":"80s"},{"url":"https:\/\/www.last.fm\/tag\/brazilian","name":"brazilian"},{"url":"https:\/\/www.last.fm\/tag\/brasil","name":"brasil"},{"url":"https:\/\/www.last.fm\/tag\/brazilian+rock","name":"brazilian rock"}]},"name":"Dois","image":[{"size":"small","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/34s\/e7dbfc64cde5478484af18f0e30662e0.png"},{"size":"medium","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/64s\/e7dbfc64cde5478484af18f0e30662e0.png"},{"size":"large","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/174s\/e7dbfc64cde5478484af18f0e30662e0.png"},{"size":"extralarge","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/300x300\/e7dbfc64cde5478484af18f0e30662e0.png"},{"size":"mega","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/300x300\/e7dbfc64cde5478484af18f0e30662e0.png"},{"size":"","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/300x300\/e7dbfc64cde5478484af18f0e30662e0.png"}],"tracks":{"track":[{"streamable":{"fulltrack":"0","#text":"0"},"duration":232,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Daniel+na+Cova+dos+Le%C3%B5es","name":"Daniel na Cova dos Leões","@attr":{"rank":1},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":null,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Quase+Sem+Querer","name":"Quase Sem Querer","@attr":{"rank":2},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":280,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Acrilic+On+Canvas","name":"Acrilic On Canvas","@attr":{"rank":3},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":271,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Eduardo+e+M%C3%B4nica","name":"Eduardo e Mônica","@attr":{"rank":4},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":94,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Central+Do+Brasil","name":"Central Do Brasil","@attr":{"rank":5},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":302,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Tempo+Perdido","name":"Tempo Perdido","@attr":{"rank":6},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":170,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Metr%C3%B3pole","name":"Metrópole","@attr":{"rank":7},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":175,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Plantas+Em+Baixo+Do+Aqu%C3%A1rio","name":"Plantas Em Baixo Do Aquário","@attr":{"rank":8},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":162,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/M%C3%BAsica+urbana+2","name":"Música urbana 2","@attr":{"rank":9},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":184,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Andrea+Doria","name":"Andrea Doria","@attr":{"rank":10},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":231,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/F%C3%A1brica","name":"Fábrica","@attr":{"rank":11},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":258,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/%C3%8Dndios","name":"Índios","@attr":{"rank":12},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}}]},"listeners":"494356","playcount":"9833783","url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois"}} \ No newline at end of file diff --git a/tests/fixtures/lastfm.album.getinfo.en.json b/tests/fixtures/lastfm.album.getinfo.en.json new file mode 100644 index 000000000..f5444f35b --- /dev/null +++ b/tests/fixtures/lastfm.album.getinfo.en.json @@ -0,0 +1 @@ +{"album":{"artist":"Legião Urbana","mbid":"1749dd07-5aa9-436e-babc-e3e982deb273","tags":{"tag":[{"url":"https:\/\/www.last.fm\/tag\/rock","name":"rock"},{"url":"https:\/\/www.last.fm\/tag\/80s","name":"80s"},{"url":"https:\/\/www.last.fm\/tag\/brazilian","name":"brazilian"},{"url":"https:\/\/www.last.fm\/tag\/brasil","name":"brasil"},{"url":"https:\/\/www.last.fm\/tag\/brazilian+rock","name":"brazilian rock"}]},"playcount":"9833783","image":[{"size":"small","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/34s\/e7dbfc64cde5478484af18f0e30662e0.png"},{"size":"medium","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/64s\/e7dbfc64cde5478484af18f0e30662e0.png"},{"size":"large","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/174s\/e7dbfc64cde5478484af18f0e30662e0.png"},{"size":"extralarge","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/300x300\/e7dbfc64cde5478484af18f0e30662e0.png"},{"size":"mega","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/300x300\/e7dbfc64cde5478484af18f0e30662e0.png"},{"size":"","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/300x300\/e7dbfc64cde5478484af18f0e30662e0.png"}],"tracks":{"track":[{"streamable":{"fulltrack":"0","#text":"0"},"duration":232,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Daniel+na+Cova+dos+Le%C3%B5es","name":"Daniel na Cova dos Leões","@attr":{"rank":1},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":null,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Quase+Sem+Querer","name":"Quase Sem Querer","@attr":{"rank":2},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":280,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Acrilic+On+Canvas","name":"Acrilic On Canvas","@attr":{"rank":3},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":271,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Eduardo+e+M%C3%B4nica","name":"Eduardo e Mônica","@attr":{"rank":4},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":94,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Central+Do+Brasil","name":"Central Do Brasil","@attr":{"rank":5},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":302,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Tempo+Perdido","name":"Tempo Perdido","@attr":{"rank":6},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":170,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Metr%C3%B3pole","name":"Metrópole","@attr":{"rank":7},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":175,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Plantas+Em+Baixo+Do+Aqu%C3%A1rio","name":"Plantas Em Baixo Do Aquário","@attr":{"rank":8},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":162,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/M%C3%BAsica+urbana+2","name":"Música urbana 2","@attr":{"rank":9},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":184,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Andrea+Doria","name":"Andrea Doria","@attr":{"rank":10},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":231,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/F%C3%A1brica","name":"Fábrica","@attr":{"rank":11},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":258,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/%C3%8Dndios","name":"Índios","@attr":{"rank":12},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}}]},"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois","name":"Dois","listeners":"494356","wiki":{"published":"10 Oct 2023, 13:56","summary":"Dois é o segundo álbum de estúdio da banda brasileira de rock Legião Urbana, lançado em 20 de julho de 1986 pela EMI. Ocupa a 21ª posição da lista dos 100 maiores discos da música brasileira pela Rolling Stone Brasil. Em setembro de 2012, foi eleito pelo público da rádio Eldorado FM, do portal Estadao.com e do Caderno C2+Música (estes dois últimos pertencentes ao jornal O Estado de S. Paulo) como o terceiro melhor disco brasileiro da história. O álbum vendeu mais de 900 mil cópias no Brasil. \"Tempo Perdido\" fez um grande sucesso e se tornou num dos clássicos <a href=\"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\">Read more on Last.fm<\/a>.","content":"Dois é o segundo álbum de estúdio da banda brasileira de rock Legião Urbana, lançado em 20 de julho de 1986 pela EMI. Ocupa a 21ª posição da lista dos 100 maiores discos da música brasileira pela Rolling Stone Brasil. Em setembro de 2012, foi eleito pelo público da rádio Eldorado FM, do portal Estadao.com e do Caderno C2+Música (estes dois últimos pertencentes ao jornal O Estado de S. Paulo) como o terceiro melhor disco brasileiro da história. O álbum vendeu mais de 900 mil cópias no Brasil. \"Tempo Perdido\" fez um grande sucesso e se tornou num dos clássicos da Legião. \"Eduardo e Mônica\", \"\"Índios\"\" e \"Quase sem Querer\" também fizeram sucesso. <a href=\"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\">Read more on Last.fm<\/a>. User-contributed text is available under the Creative Commons By-SA License; additional terms may apply."}}} \ No newline at end of file diff --git a/tests/fixtures/lastfm.artist.getinfo.empty.json b/tests/fixtures/lastfm.artist.getinfo.empty.json new file mode 100644 index 000000000..015b51701 --- /dev/null +++ b/tests/fixtures/lastfm.artist.getinfo.empty.json @@ -0,0 +1 @@ +{"artist":{"name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99","url":"https://www.last.fm/music/+noredirect/Legi%C3%A3o+Urbana","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}],"streamable":"0","ontour":"0","stats":{"listeners":"740591","playcount":"44493504"},"similar":{"artist":[{"name":"Renato Russo","url":"https://www.last.fm/music/Renato+Russo","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}]},{"name":"Engenheiros Do Hawaii","url":"https://www.last.fm/music/Engenheiros+Do+Hawaii","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}]},{"name":"Os Paralamas Do Sucesso","url":"https://www.last.fm/music/Os+Paralamas+Do+Sucesso","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}]},{"name":"Barão Vermelho","url":"https://www.last.fm/music/Bar%C3%A3o+Vermelho","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}]},{"name":"Capital Inicial","url":"https://www.last.fm/music/Capital+Inicial","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}]}]},"tags":{"tag":[{"name":"rock","url":"https://www.last.fm/tag/rock"},{"name":"brazilian rock","url":"https://www.last.fm/tag/brazilian+rock"},{"name":"80s","url":"https://www.last.fm/tag/80s"},{"name":"brazilian","url":"https://www.last.fm/tag/brazilian"},{"name":"brasil","url":"https://www.last.fm/tag/brasil"}]},"bio":{"links":{"link":{"#text":"","rel":"original","href":"https://last.fm/music/+noredirect/Legi%C3%A3o+Urbana/+wiki"}},"published":"01 Jan 1970, 00:00","summary":" <a href=\"https://www.last.fm/music/+noredirect/Legi%C3%A3o+Urbana\">Read more on Last.fm</a>","content":""}}} \ No newline at end of file diff --git a/tests/fixtures/lastfm.artist.getinfo.en.json b/tests/fixtures/lastfm.artist.getinfo.en.json new file mode 100644 index 000000000..6c643b8e2 --- /dev/null +++ b/tests/fixtures/lastfm.artist.getinfo.en.json @@ -0,0 +1 @@ +{"artist":{"name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99","url":"https://www.last.fm/music/+noredirect/Legi%C3%A3o+Urbana","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}],"streamable":"0","ontour":"0","stats":{"listeners":"740367","playcount":"44476703"},"similar":{"artist":[{"name":"Renato Russo","url":"https://www.last.fm/music/Renato+Russo","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}]},{"name":"Engenheiros Do Hawaii","url":"https://www.last.fm/music/Engenheiros+Do+Hawaii","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}]},{"name":"Os Paralamas Do Sucesso","url":"https://www.last.fm/music/Os+Paralamas+Do+Sucesso","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}]},{"name":"Barão Vermelho","url":"https://www.last.fm/music/Bar%C3%A3o+Vermelho","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}]},{"name":"Capital Inicial","url":"https://www.last.fm/music/Capital+Inicial","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}]}]},"tags":{"tag":[{"name":"rock","url":"https://www.last.fm/tag/rock"},{"name":"brazilian rock","url":"https://www.last.fm/tag/brazilian+rock"},{"name":"80s","url":"https://www.last.fm/tag/80s"},{"name":"brazilian","url":"https://www.last.fm/tag/brazilian"},{"name":"brasil","url":"https://www.last.fm/tag/brasil"}]},"bio":{"links":{"link":{"#text":"","rel":"original","href":"https://last.fm/music/+noredirect/Legi%C3%A3o+Urbana/+wiki"}},"published":"03 Mar 2006, 04:04","summary":"Legião Urbana was a Brazilian post-punk band from Brasília, Distrito Federal, Brazil.\n\nFronted by lead singer and lyricist Renato Russo, Legião Urbana was founded in 1983 and existed until 1996, when Renato passed away due to complications caused by AIDS. Besides being the lead vocalist, Renato was an occasional guitar, bass and keyboards player. He also wrote most of the band's songs. In 13 years of career, they released 8 studio albums - the last being posthumous - and one live. <a href=\"https://www.last.fm/music/+noredirect/Legi%C3%A3o+Urbana\">Read more on Last.fm</a>","content":"Legião Urbana was a Brazilian post-punk band from Brasília, Distrito Federal, Brazil.\n\nFronted by lead singer and lyricist Renato Russo, Legião Urbana was founded in 1983 and existed until 1996, when Renato passed away due to complications caused by AIDS. Besides being the lead vocalist, Renato was an occasional guitar, bass and keyboards player. He also wrote most of the band's songs. In 13 years of career, they released 8 studio albums - the last being posthumous - and one live.\n\nLegião Urbana is probably the most famous Brazilian rock bands, especially known for Renato's poetic lyrics, which range from love and spiritualism to politics, family, sex and drugs.\n\nNowadays, Dado Villa-Lobos (ex-guitar player of Legião Urbana) has a solo career and recorded his first album, named \"Jardim De Cactus\", in 2005. Drum player Marcelo Bonfá also tried a solo career. <a href=\"https://www.last.fm/music/+noredirect/Legi%C3%A3o+Urbana\">Read more on Last.fm</a>. User-contributed text is available under the Creative Commons By-SA License; additional terms may apply."}}} \ No newline at end of file diff --git a/tests/fixtures/lastfm.artist.page.html b/tests/fixtures/lastfm.artist.page.html new file mode 100644 index 000000000..1922e313b --- /dev/null +++ b/tests/fixtures/lastfm.artist.page.html @@ -0,0 +1,7 @@ +<html> +<head> +<meta property="og:image" content="https://lastfm.freetls.fastly.net/i/u/ar0/818148bf682d429dc21b59a73ef6f68e.png" /> +</head> +<body> +</body> +</html> \ No newline at end of file diff --git a/tests/fixtures/lastfm.artist.page.ignored.html b/tests/fixtures/lastfm.artist.page.ignored.html new file mode 100644 index 000000000..96eda2377 --- /dev/null +++ b/tests/fixtures/lastfm.artist.page.ignored.html @@ -0,0 +1,7 @@ +<html> +<head> +<meta property="og:image" content="https://lastfm.freetls.fastly.net/i/u/ar0/2a96cbd8b46e442fc41c2b86b821562f.png" /> +</head> +<body> +</body> +</html> \ No newline at end of file diff --git a/tests/fixtures/lastfm.artist.page.no_meta.html b/tests/fixtures/lastfm.artist.page.no_meta.html new file mode 100644 index 000000000..aa7b9c934 --- /dev/null +++ b/tests/fixtures/lastfm.artist.page.no_meta.html @@ -0,0 +1,6 @@ +<html> +<head> +</head> +<body> +</body> +</html> \ No newline at end of file diff --git a/tests/fixtures/lastfm.track.getsimilar.json b/tests/fixtures/lastfm.track.getsimilar.json new file mode 100644 index 000000000..45041b289 --- /dev/null +++ b/tests/fixtures/lastfm.track.getsimilar.json @@ -0,0 +1 @@ +{"similartracks":{"track":[{"name":"Dreaming of Me","mbid":"027b553e-7c74-3ed4-a95e-1d4fea51f174","match":1.0,"url":"https://www.last.fm/music/Depeche+Mode/_/Dreaming+of+Me","artist":{"name":"Depeche Mode","mbid":"8538e728-ca0b-4321-b7e5-cff6565dd4c0","url":"https://www.last.fm/music/Depeche+Mode"}},{"name":"Everything Counts","mbid":"5a5a3ca4-bdb8-4641-a674-9b54b9b319a6","match":0.892602,"url":"https://www.last.fm/music/Depeche+Mode/_/Everything+Counts","artist":{"name":"Depeche Mode","mbid":"8538e728-ca0b-4321-b7e5-cff6565dd4c0","url":"https://www.last.fm/music/Depeche+Mode"}},{"name":"Don't You Want Me","mbid":"","match":0.491341,"url":"https://www.last.fm/music/The+Human+League/_/Don%27t+You+Want+Me","artist":{"name":"The Human League","mbid":"7adaabfb-acfb-47bc-8c7c-59471c2f0db8","url":"https://www.last.fm/music/The+Human+League"}},{"name":"Tainted Love","mbid":"","match":0.454811,"url":"https://www.last.fm/music/Soft+Cell/_/Tainted+Love","artist":{"name":"Soft Cell","mbid":"7fb50287-029d-47cc-825a-235ca28024b2","url":"https://www.last.fm/music/Soft+Cell"}},{"name":"Blue Monday","mbid":"727e84c6-1b56-31dd-a958-a5f46305cec0","match":0.381057,"url":"https://www.last.fm/music/New+Order/_/Blue+Monday","artist":{"name":"New Order","mbid":"f1106b17-dcbb-45f6-b938-199ccfab50cc","url":"https://www.last.fm/music/New+Order"}}],"@attr":{"artist":"Depeche Mode","track":"Just Can't Get Enough"}}} diff --git a/tests/fixtures/lastfm.track.getsimilar.unknown.json b/tests/fixtures/lastfm.track.getsimilar.unknown.json new file mode 100644 index 000000000..9b879fa05 --- /dev/null +++ b/tests/fixtures/lastfm.track.getsimilar.unknown.json @@ -0,0 +1 @@ +{"similartracks":{"track":[],"@attr":{"track":"UnknownTrack","artist":"UnknownArtist"}}} diff --git a/tests/fixtures/listenbrainz.artist.metadata.homepage.json b/tests/fixtures/listenbrainz.artist.metadata.homepage.json new file mode 100644 index 000000000..be15ea45f --- /dev/null +++ b/tests/fixtures/listenbrainz.artist.metadata.homepage.json @@ -0,0 +1,19 @@ +[ + { + "area": "Japan", + "artist_mbid": "d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56", + "begin_year": 2012, + "mbid": "d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56", + "name": "Mili", + "rels": { + "free streaming": "https://www.deezer.com/artist/56563392", + "official homepage": "http://projectmili.com/", + "purchase for download": "https://recochoku.jp/artist/2000285803/", + "social network": "https://www.instagram.com/projectmili/", + "streaming": "https://tidal.com/artist/3848902", + "wikidata": "https://www.wikidata.org/wiki/Q27309228", + "youtube": "https://www.youtube.com/channel/UCVh47EKH9VLresRqiYi9txw" + }, + "type": "Group" + } +] diff --git a/tests/fixtures/listenbrainz.artist.metadata.no_homepage.json b/tests/fixtures/listenbrainz.artist.metadata.no_homepage.json new file mode 100644 index 000000000..6105556a2 --- /dev/null +++ b/tests/fixtures/listenbrainz.artist.metadata.no_homepage.json @@ -0,0 +1,15 @@ +[ + { + "area": "Japan", + "artist_mbid": "7c2cc610-f998-43ef-a08f-dae3344b8973", + "mbid": "7c2cc610-f998-43ef-a08f-dae3344b8973", + "name": "Feryquitous", + "rels": { + "free streaming": "https://www.deezer.com/artist/9841008", + "purchase for download": "https://itunes.apple.com/jp/artist/id1083544578", + "social network": "https://twitter.com/Feryquitous_", + "youtube": "https://www.youtube.com/channel/UCj2nw_9puY3sJoDbkE-FCQA" + }, + "type": "Person" + } +] diff --git a/tests/fixtures/listenbrainz.labs.similar-artists.json b/tests/fixtures/listenbrainz.labs.similar-artists.json new file mode 100644 index 000000000..1cd2c85b5 --- /dev/null +++ b/tests/fixtures/listenbrainz.labs.similar-artists.json @@ -0,0 +1 @@ +[{"artist_mbid": "f27ec8db-af05-4f36-916e-3d57f91ecf5e", "name": "Michael Jackson", "comment": "\u201cKing of Pop\u201d", "type": "Person", "gender": "Male", "score": 800, "reference_mbid": "db92a151-1ac2-438b-bc43-b82e149ddd50"}, {"artist_mbid": "7364dea6-ca9a-48e3-be01-b44ad0d19897", "name": "a-ha", "comment": "Norwegian synth\u2010pop band", "type": "Group", "gender": null, "score": 792, "reference_mbid": "db92a151-1ac2-438b-bc43-b82e149ddd50"}] \ No newline at end of file diff --git a/tests/fixtures/listenbrainz.labs.similar-recordings-real-out-of-order.json b/tests/fixtures/listenbrainz.labs.similar-recordings-real-out-of-order.json new file mode 100644 index 000000000..61913bcf5 --- /dev/null +++ b/tests/fixtures/listenbrainz.labs.similar-recordings-real-out-of-order.json @@ -0,0 +1 @@ +[{"recording_mbid":"12f65dca-de8f-43fe-a65d-f12a02aaadf3","recording_name":"Take On Me","artist_credit_name":"a‐ha","artist_credit_mbids":null,"release_name":"Hunting High and Low","release_mbid":"4ec07fe8-e7c6-3106-a0aa-fdf92f13f7fc","caa_id":13015069966,"caa_release_mbid":"181b9a01-0446-4601-99be-b011ab615631","score":124,"reference_mbid":"8f3471b5-7e6a-48da-86a9-c1c07a0f47ae"},{"recording_mbid":"12f65dca-de8f-43fe-a65d-f12a02aaadf3","recording_name":"Take On Me","artist_credit_name":"a‐ha","artist_credit_mbids":null,"release_name":"Hunting High and Low","release_mbid":"4ec07fe8-e7c6-3106-a0aa-fdf92f13f7fc","caa_id":13015069966,"caa_release_mbid":"181b9a01-0446-4601-99be-b011ab615631","score":124,"reference_mbid":"8f3471b5-7e6a-48da-86a9-c1c07a0f47ae"},{"recording_mbid":"80033c72-aa19-4ba8-9227-afb075fec46e","recording_name":"Wake Me Up Before You Go‐Go","artist_credit_name":"Wham!","artist_credit_mbids":null,"release_name":"Make It Big","release_mbid":"c143d542-48dc-446b-b523-1762da721638","caa_id":2622532701,"caa_release_mbid":"ec01ad0c-a28f-4d45-bed7-d73014161c38","score":65,"reference_mbid":"8f3471b5-7e6a-48da-86a9-c1c07a0f47ae"},{"recording_mbid":"ef4c6855-949e-4e22-b41e-8e0a2d372d5f","recording_name":"Tainted Love","artist_credit_name":"Soft Cell","artist_credit_mbids":null,"release_name":"Non-Stop Erotic Cabaret","release_mbid":"1acaa870-6e0c-4b6e-9e91-fdec4e5ea4b1","caa_id":1031647403,"caa_release_mbid":"c3367d3a-2f6c-48d1-95c5-c1ee7a49c479","score":61,"reference_mbid":"8f3471b5-7e6a-48da-86a9-c1c07a0f47ae"},{"recording_mbid":"e4b347be-ecb2-44ff-aaa8-3d4c517d7ea5","recording_name":"Everybody Wants to Rule the World","artist_credit_name":"Tears for Fears","artist_credit_mbids":null,"release_name":"Songs From the Big Chair","release_mbid":"21f19b06-81f1-347a-add5-5d0c77696597","caa_id":19682986993,"caa_release_mbid":"9aefc6dd-216a-4271-ada1-d9cf67956f39","score":68,"reference_mbid":"8f3471b5-7e6a-48da-86a9-c1c07a0f47ae"}] \ No newline at end of file diff --git a/tests/fixtures/listenbrainz.labs.similar-recordings.json b/tests/fixtures/listenbrainz.labs.similar-recordings.json new file mode 100644 index 000000000..87323f426 --- /dev/null +++ b/tests/fixtures/listenbrainz.labs.similar-recordings.json @@ -0,0 +1 @@ +[{"recording_mbid":"12f65dca-de8f-43fe-a65d-f12a02aaadf3","recording_name":"Take On Me","artist_credit_name":"a‐ha","artist_credit_mbids":null,"release_name":"Hunting High and Low","release_mbid":"4ec07fe8-e7c6-3106-a0aa-fdf92f13f7fc","caa_id":13015069966,"caa_release_mbid":"181b9a01-0446-4601-99be-b011ab615631","score":124,"reference_mbid":"8f3471b5-7e6a-48da-86a9-c1c07a0f47ae"},{"recording_mbid":"80033c72-aa19-4ba8-9227-afb075fec46e","recording_name":"Wake Me Up Before You Go‐Go","artist_credit_name":"Wham!","artist_credit_mbids":null,"release_name":"Make It Big","release_mbid":"c143d542-48dc-446b-b523-1762da721638","caa_id":2622532701,"caa_release_mbid":"ec01ad0c-a28f-4d45-bed7-d73014161c38","score":65,"reference_mbid":"8f3471b5-7e6a-48da-86a9-c1c07a0f47ae"}] \ No newline at end of file diff --git a/tests/fixtures/listenbrainz.popularity.json b/tests/fixtures/listenbrainz.popularity.json new file mode 100644 index 000000000..ea459b120 --- /dev/null +++ b/tests/fixtures/listenbrainz.popularity.json @@ -0,0 +1,81 @@ +[ + { + "artist_mbids": ["d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56"], + "artist_name": "Mili", + "artists": [ + { + "artist_credit_name": "Mili", + "artist_mbid": "d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56", + "join_phrase": "" + } + ], + "caa_id": 14987576054, + "caa_release_mbid": "38a8f6e1-0e34-4418-a89d-78240a367408", + "length": 211912, + "recording_mbid": "9980309d-3480-4e7e-89ce-fce971a452be", + "recording_name": "world.execute(me);", + "release_color": { "blue": 109, "green": 94, "red": 95 }, + "release_mbid": "38a8f6e1-0e34-4418-a89d-78240a367408", + "release_name": "Miracle Milk", + "tags": [ + { + "count": 1, + "genre_mbid": "911c7bbb-172d-4df8-9478-dbff4296e791", + "tag": "pop" + }, + { + "count": 1, + "genre_mbid": "b739a895-85ed-4ad3-8717-4e9ef5387dd8", + "tag": "dance-pop" + }, + { + "count": 1, + "genre_mbid": "9c8ba153-740e-4b88-b7ff-31d004944c95", + "tag": "nerdcore" + }, + { + "count": 1, + "genre_mbid": "c4a69842-f891-4569-9506-1882aa5db433", + "tag": "electronic rock" + }, + { "count": 1, "tag": "hackercore" }, + { "count": 1, "tag": "meter:4/4" }, + { "count": 1, "tag": "vocal:true" }, + { "count": 1, "tag": "bpm:130" }, + { + "count": 1, + "genre_mbid": "e5bba957-8c91-496a-a675-c6d0c6b51c33", + "tag": "dance" + }, + { + "count": 1, + "genre_mbid": "89255676-1f14-4dd8-bbad-fca839d6aff4", + "tag": "electronic" + } + ], + "total_listen_count": 19440, + "total_user_count": 1102 + }, + { + "artist_mbids": ["d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56"], + "artist_name": "Mili", + "artists": [ + { + "artist_credit_name": "Mili", + "artist_mbid": "d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56", + "join_phrase": "" + } + ], + "caa_id": 31388973421, + "caa_release_mbid": "e58ed9ef-2bc1-4480-9d6d-2d799beb5ba9", + "length": 174000, + "recording_mbid": "afa2c83d-b17f-4029-b9da-790ea9250cf9", + "recording_name": "String Theocracy", + "release_color": { "blue": 92, "green": 147, "red": 164 }, + "release_mbid": "d79a38e3-7016-4f39-a31a-f495ce914b8e", + "release_name": "String Theocracy", + "tags": [], + "total_listen_count": 8986, + "total_user_count": 712 + } +] diff --git a/tests/fixtures/playlists/bom-test-utf16.m3u b/tests/fixtures/playlists/bom-test-utf16.m3u new file mode 100644 index 000000000..9c2e9d599 Binary files /dev/null and b/tests/fixtures/playlists/bom-test-utf16.m3u differ diff --git a/tests/fixtures/playlists/bom-test.m3u b/tests/fixtures/playlists/bom-test.m3u new file mode 100644 index 000000000..f5a00806c --- /dev/null +++ b/tests/fixtures/playlists/bom-test.m3u @@ -0,0 +1,6 @@ +#EXTM3U +# NOTE: This file intentionally contains a UTF-8 BOM (Byte Order Mark) at the beginning +# (bytes 0xEF 0xBB 0xBF) to test BOM handling in playlist parsing. +#PLAYLIST:Test Playlist +#EXTINF:123,Test Artist - Test Song +test.mp3 diff --git a/tests/fixtures/playlists/pls-with-art-url.m3u b/tests/fixtures/playlists/pls-with-art-url.m3u new file mode 100644 index 000000000..9dbf180f8 --- /dev/null +++ b/tests/fixtures/playlists/pls-with-art-url.m3u @@ -0,0 +1,5 @@ +#EXTM3U +#PLAYLIST:Playlist With Art +#EXTALBUMARTURL:https://example.com/cover.jpg +test.mp3 +test.ogg diff --git a/tests/fixtures/playlists/private_playlist.nsp b/tests/fixtures/playlists/private_playlist.nsp new file mode 100644 index 000000000..de73b369c --- /dev/null +++ b/tests/fixtures/playlists/private_playlist.nsp @@ -0,0 +1,11 @@ +{ + "name": "Private Playlist", + "comment": "A smart playlist that is explicitly private", + "public": false, + "all": [ + {"is": {"loved": true}} + ], + "sort": "title", + "order": "asc", + "limit": 100 +} diff --git a/tests/fixtures/playlists/public_playlist.nsp b/tests/fixtures/playlists/public_playlist.nsp new file mode 100644 index 000000000..e303169e1 --- /dev/null +++ b/tests/fixtures/playlists/public_playlist.nsp @@ -0,0 +1,11 @@ +{ + "name": "Public Playlist", + "comment": "A smart playlist that is public", + "public": true, + "all": [ + {"inTheLast": {"lastPlayed": 30}} + ], + "sort": "lastPlayed", + "order": "desc", + "limit": 50 +} diff --git a/tests/fixtures/test.opus b/tests/fixtures/test.opus new file mode 100644 index 000000000..5052c0e6e Binary files /dev/null and b/tests/fixtures/test.opus differ diff --git a/tests/mock_album_repo.go b/tests/mock_album_repo.go index 642ce6b41..3428813f6 100644 --- a/tests/mock_album_repo.go +++ b/tests/mock_album_repo.go @@ -21,6 +21,7 @@ type MockAlbumRepo struct { Err bool Options model.QueryOptions ReassignAnnotationCalls map[string]string // prevID -> newID + CopyAttributesCalls map[string]string // fromID -> toID } func (m *MockAlbumRepo) SetError(err bool) { @@ -118,7 +119,7 @@ func (m *MockAlbumRepo) UpdateExternalInfo(album *model.Album) error { return nil } -func (m *MockAlbumRepo) Search(q string, offset int, size int, options ...model.QueryOptions) (model.Albums, error) { +func (m *MockAlbumRepo) Search(q string, options ...model.QueryOptions) (model.Albums, error) { if len(options) > 0 { m.Options = options[0] } @@ -142,6 +143,32 @@ func (m *MockAlbumRepo) ReassignAnnotation(prevID string, newID string) error { return nil } +// CopyAttributes copies attributes from one album to another +func (m *MockAlbumRepo) CopyAttributes(fromID, toID string, columns ...string) error { + if m.Err { + return errors.New("unexpected error") + } + from, ok := m.Data[fromID] + if !ok { + return model.ErrNotFound + } + to, ok := m.Data[toID] + if !ok { + return model.ErrNotFound + } + for _, col := range columns { + switch col { + case "created_at": + to.CreatedAt = from.CreatedAt + } + } + if m.CopyAttributesCalls == nil { + m.CopyAttributesCalls = make(map[string]string) + } + m.CopyAttributesCalls[fromID] = toID + return nil +} + // SetRating sets the rating for an album func (m *MockAlbumRepo) SetRating(rating int, itemID string) error { if m.Err { diff --git a/tests/mock_artist_repo.go b/tests/mock_artist_repo.go index 6d4792f83..b7a6fb811 100644 --- a/tests/mock_artist_repo.go +++ b/tests/mock_artist_repo.go @@ -145,7 +145,7 @@ func (m *MockArtistRepo) GetIndex(includeMissing bool, libraryIds []int, roles . return result, nil } -func (m *MockArtistRepo) Search(q string, offset int, size int, options ...model.QueryOptions) (model.Artists, error) { +func (m *MockArtistRepo) Search(q string, options ...model.QueryOptions) (model.Artists, error) { if len(options) > 0 { m.Options = options[0] } diff --git a/tests/mock_data_store.go b/tests/mock_data_store.go index 56f68a74b..754f0c084 100644 --- a/tests/mock_data_store.go +++ b/tests/mock_data_store.go @@ -25,202 +25,228 @@ type MockDataStore struct { MockedTranscoding model.TranscodingRepository MockedUserProps model.UserPropsRepository MockedScrobbleBuffer model.ScrobbleBufferRepository + MockedScrobble model.ScrobbleRepository MockedRadio model.RadioRepository + MockedPlugin model.PluginRepository scrobbleBufferMu sync.Mutex repoMu sync.Mutex + + // GC tracking + GCCalled bool + GCError error } func (db *MockDataStore) Library(ctx context.Context) model.LibraryRepository { - if db.MockedLibrary == nil { - if db.RealDS != nil { - db.MockedLibrary = db.RealDS.Library(ctx) - } else { - db.MockedLibrary = &MockLibraryRepo{} - } + if db.MockedLibrary != nil { + return db.MockedLibrary } + if db.RealDS != nil { + return db.RealDS.Library(ctx) + } + db.MockedLibrary = &MockLibraryRepo{} return db.MockedLibrary } func (db *MockDataStore) Folder(ctx context.Context) model.FolderRepository { - if db.MockedFolder == nil { - if db.RealDS != nil { - db.MockedFolder = db.RealDS.Folder(ctx) - } else { - db.MockedFolder = struct{ model.FolderRepository }{} - } + if db.MockedFolder != nil { + return db.MockedFolder } + if db.RealDS != nil { + return db.RealDS.Folder(ctx) + } + db.MockedFolder = struct{ model.FolderRepository }{} return db.MockedFolder } func (db *MockDataStore) Tag(ctx context.Context) model.TagRepository { - if db.MockedTag == nil { - if db.RealDS != nil { - db.MockedTag = db.RealDS.Tag(ctx) - } else { - db.MockedTag = struct{ model.TagRepository }{} - } + if db.MockedTag != nil { + return db.MockedTag } + if db.RealDS != nil { + return db.RealDS.Tag(ctx) + } + db.MockedTag = struct{ model.TagRepository }{} return db.MockedTag } func (db *MockDataStore) Album(ctx context.Context) model.AlbumRepository { - if db.MockedAlbum == nil { - if db.RealDS != nil { - db.MockedAlbum = db.RealDS.Album(ctx) - } else { - db.MockedAlbum = CreateMockAlbumRepo() - } + if db.MockedAlbum != nil { + return db.MockedAlbum } + if db.RealDS != nil { + return db.RealDS.Album(ctx) + } + db.MockedAlbum = CreateMockAlbumRepo() return db.MockedAlbum } func (db *MockDataStore) Artist(ctx context.Context) model.ArtistRepository { - if db.MockedArtist == nil { - if db.RealDS != nil { - db.MockedArtist = db.RealDS.Artist(ctx) - } else { - db.MockedArtist = CreateMockArtistRepo() - } + if db.MockedArtist != nil { + return db.MockedArtist } + if db.RealDS != nil { + return db.RealDS.Artist(ctx) + } + db.MockedArtist = CreateMockArtistRepo() return db.MockedArtist } func (db *MockDataStore) MediaFile(ctx context.Context) model.MediaFileRepository { + if db.RealDS != nil && db.MockedMediaFile == nil { + return db.RealDS.MediaFile(ctx) + } db.repoMu.Lock() defer db.repoMu.Unlock() if db.MockedMediaFile == nil { - if db.RealDS != nil { - db.MockedMediaFile = db.RealDS.MediaFile(ctx) - } else { - db.MockedMediaFile = CreateMockMediaFileRepo() - } + db.MockedMediaFile = CreateMockMediaFileRepo() } return db.MockedMediaFile } func (db *MockDataStore) Genre(ctx context.Context) model.GenreRepository { - if db.MockedGenre == nil { - if db.RealDS != nil { - db.MockedGenre = db.RealDS.Genre(ctx) - } else { - db.MockedGenre = &MockedGenreRepo{} - } + if db.MockedGenre != nil { + return db.MockedGenre } + if db.RealDS != nil { + return db.RealDS.Genre(ctx) + } + db.MockedGenre = &MockedGenreRepo{} return db.MockedGenre } func (db *MockDataStore) Playlist(ctx context.Context) model.PlaylistRepository { - if db.MockedPlaylist == nil { - if db.RealDS != nil { - db.MockedPlaylist = db.RealDS.Playlist(ctx) - } else { - db.MockedPlaylist = &MockPlaylistRepo{} - } + if db.MockedPlaylist != nil { + return db.MockedPlaylist } + if db.RealDS != nil { + return db.RealDS.Playlist(ctx) + } + db.MockedPlaylist = CreateMockPlaylistRepo() return db.MockedPlaylist } func (db *MockDataStore) PlayQueue(ctx context.Context) model.PlayQueueRepository { - if db.MockedPlayQueue == nil { - if db.RealDS != nil { - db.MockedPlayQueue = db.RealDS.PlayQueue(ctx) - } else { - db.MockedPlayQueue = &MockPlayQueueRepo{} - } + if db.MockedPlayQueue != nil { + return db.MockedPlayQueue } + if db.RealDS != nil { + return db.RealDS.PlayQueue(ctx) + } + db.MockedPlayQueue = &MockPlayQueueRepo{} return db.MockedPlayQueue } func (db *MockDataStore) UserProps(ctx context.Context) model.UserPropsRepository { - if db.MockedUserProps == nil { - if db.RealDS != nil { - db.MockedUserProps = db.RealDS.UserProps(ctx) - } else { - db.MockedUserProps = &MockedUserPropsRepo{} - } + if db.MockedUserProps != nil { + return db.MockedUserProps } + if db.RealDS != nil { + return db.RealDS.UserProps(ctx) + } + db.MockedUserProps = &MockedUserPropsRepo{} return db.MockedUserProps } func (db *MockDataStore) Property(ctx context.Context) model.PropertyRepository { - if db.MockedProperty == nil { - if db.RealDS != nil { - db.MockedProperty = db.RealDS.Property(ctx) - } else { - db.MockedProperty = &MockedPropertyRepo{} - } + if db.MockedProperty != nil { + return db.MockedProperty } + if db.RealDS != nil { + return db.RealDS.Property(ctx) + } + db.MockedProperty = &MockedPropertyRepo{} return db.MockedProperty } func (db *MockDataStore) Share(ctx context.Context) model.ShareRepository { - if db.MockedShare == nil { - if db.RealDS != nil { - db.MockedShare = db.RealDS.Share(ctx) - } else { - db.MockedShare = &MockShareRepo{} - } + if db.MockedShare != nil { + return db.MockedShare } + if db.RealDS != nil { + return db.RealDS.Share(ctx) + } + db.MockedShare = &MockShareRepo{} return db.MockedShare } func (db *MockDataStore) User(ctx context.Context) model.UserRepository { - if db.MockedUser == nil { - if db.RealDS != nil { - db.MockedUser = db.RealDS.User(ctx) - } else { - db.MockedUser = CreateMockUserRepo() - } + if db.MockedUser != nil { + return db.MockedUser } + if db.RealDS != nil { + return db.RealDS.User(ctx) + } + db.MockedUser = CreateMockUserRepo() return db.MockedUser } func (db *MockDataStore) Transcoding(ctx context.Context) model.TranscodingRepository { - if db.MockedTranscoding == nil { - if db.RealDS != nil { - db.MockedTranscoding = db.RealDS.Transcoding(ctx) - } else { - db.MockedTranscoding = struct{ model.TranscodingRepository }{} - } + if db.MockedTranscoding != nil { + return db.MockedTranscoding } + if db.RealDS != nil { + return db.RealDS.Transcoding(ctx) + } + db.MockedTranscoding = struct{ model.TranscodingRepository }{} return db.MockedTranscoding } func (db *MockDataStore) Player(ctx context.Context) model.PlayerRepository { - if db.MockedPlayer == nil { - if db.RealDS != nil { - db.MockedPlayer = db.RealDS.Player(ctx) - } else { - db.MockedPlayer = struct{ model.PlayerRepository }{} - } + if db.MockedPlayer != nil { + return db.MockedPlayer } + if db.RealDS != nil { + return db.RealDS.Player(ctx) + } + db.MockedPlayer = struct{ model.PlayerRepository }{} return db.MockedPlayer } func (db *MockDataStore) ScrobbleBuffer(ctx context.Context) model.ScrobbleBufferRepository { + if db.RealDS != nil && db.MockedScrobbleBuffer == nil { + return db.RealDS.ScrobbleBuffer(ctx) + } db.scrobbleBufferMu.Lock() defer db.scrobbleBufferMu.Unlock() if db.MockedScrobbleBuffer == nil { - if db.RealDS != nil { - db.MockedScrobbleBuffer = db.RealDS.ScrobbleBuffer(ctx) - } else { - db.MockedScrobbleBuffer = CreateMockedScrobbleBufferRepo() - } + db.MockedScrobbleBuffer = &MockedScrobbleBufferRepo{} } return db.MockedScrobbleBuffer } -func (db *MockDataStore) Radio(ctx context.Context) model.RadioRepository { - if db.MockedRadio == nil { - if db.RealDS != nil { - db.MockedRadio = db.RealDS.Radio(ctx) - } else { - db.MockedRadio = CreateMockedRadioRepo() - } +func (db *MockDataStore) Scrobble(ctx context.Context) model.ScrobbleRepository { + if db.MockedScrobble != nil { + return db.MockedScrobble } + if db.RealDS != nil { + return db.RealDS.Scrobble(ctx) + } + db.MockedScrobble = &MockScrobbleRepo{ctx: ctx} + return db.MockedScrobble +} + +func (db *MockDataStore) Radio(ctx context.Context) model.RadioRepository { + if db.MockedRadio != nil { + return db.MockedRadio + } + if db.RealDS != nil { + return db.RealDS.Radio(ctx) + } + db.MockedRadio = CreateMockedRadioRepo() return db.MockedRadio } +func (db *MockDataStore) Plugin(ctx context.Context) model.PluginRepository { + if db.MockedPlugin != nil { + return db.MockedPlugin + } + if db.RealDS != nil { + return db.RealDS.Plugin(ctx) + } + db.MockedPlugin = CreateMockPluginRepo() + return db.MockedPlugin +} + func (db *MockDataStore) WithTx(block func(tx model.DataStore) error, label ...string) error { return block(db) } @@ -253,11 +279,17 @@ func (db *MockDataStore) Resource(ctx context.Context, m any) model.ResourceRepo return db.Transcoding(ctx).(model.ResourceRepository) case model.Player, *model.Player: return db.Player(ctx).(model.ResourceRepository) + case model.Plugin, *model.Plugin: + return db.Plugin(ctx).(model.ResourceRepository) default: return struct{ model.ResourceRepository }{} } } -func (db *MockDataStore) GC(context.Context) error { +func (db *MockDataStore) GC(context.Context, ...int) error { + db.GCCalled = true + if db.GCError != nil { + return db.GCError + } return nil } diff --git a/tests/mock_ffmpeg.go b/tests/mock_ffmpeg.go index a792ae9d3..346209b71 100644 --- a/tests/mock_ffmpeg.go +++ b/tests/mock_ffmpeg.go @@ -1,11 +1,14 @@ package tests import ( + "bytes" "context" "io" "strings" "sync" "sync/atomic" + + "github.com/navidrome/navidrome/core/ffmpeg" ) func NewMockFFmpeg(data string) *MockFFmpeg { @@ -14,16 +17,17 @@ func NewMockFFmpeg(data string) *MockFFmpeg { type MockFFmpeg struct { io.Reader - lock sync.Mutex - closed atomic.Bool - Error error + lock sync.Mutex + closed atomic.Bool + Error error + ProbeAudioResult *ffmpeg.AudioProbeResult } func (ff *MockFFmpeg) IsAvailable() bool { return true } -func (ff *MockFFmpeg) Transcode(context.Context, string, string, int, int) (io.ReadCloser, error) { +func (ff *MockFFmpeg) Transcode(_ context.Context, _ ffmpeg.TranscodeOptions) (io.ReadCloser, error) { if ff.Error != nil { return nil, ff.Error } @@ -37,12 +41,30 @@ func (ff *MockFFmpeg) ExtractImage(context.Context, string) (io.ReadCloser, erro return ff, nil } +func (ff *MockFFmpeg) ConvertAnimatedImage(_ context.Context, reader io.Reader, _ int, _ int) (io.ReadCloser, error) { + if ff.Error != nil { + return nil, ff.Error + } + data, err := io.ReadAll(reader) + if err != nil { + return nil, err + } + return io.NopCloser(bytes.NewReader(data)), nil +} + func (ff *MockFFmpeg) Probe(context.Context, []string) (string, error) { if ff.Error != nil { return "", ff.Error } return "", nil } +func (ff *MockFFmpeg) ProbeAudioStream(context.Context, string) (*ffmpeg.AudioProbeResult, error) { + if ff.Error != nil { + return nil, ff.Error + } + return ff.ProbeAudioResult, nil +} + func (ff *MockFFmpeg) CmdPath() (string, error) { if ff.Error != nil { return "", ff.Error diff --git a/tests/mock_library_repo.go b/tests/mock_library_repo.go index 4d7539aa9..3f0e576e9 100644 --- a/tests/mock_library_repo.go +++ b/tests/mock_library_repo.go @@ -168,7 +168,7 @@ func (m *MockLibraryRepo) Count(options ...rest.QueryOptions) (int64, error) { return m.CountAll() } -func (m *MockLibraryRepo) Read(id string) (interface{}, error) { +func (m *MockLibraryRepo) Read(id string) (any, error) { idInt, _ := strconv.Atoi(id) mf, err := m.Get(idInt) if errors.Is(err, model.ErrNotFound) { @@ -177,7 +177,7 @@ func (m *MockLibraryRepo) Read(id string) (interface{}, error) { return mf, err } -func (m *MockLibraryRepo) ReadAll(options ...rest.QueryOptions) (interface{}, error) { +func (m *MockLibraryRepo) ReadAll(options ...rest.QueryOptions) (any, error) { return m.GetAll() } @@ -185,13 +185,13 @@ func (m *MockLibraryRepo) EntityName() string { return "library" } -func (m *MockLibraryRepo) NewInstance() interface{} { +func (m *MockLibraryRepo) NewInstance() any { return &model.Library{} } // REST Repository methods (string-based IDs) -func (m *MockLibraryRepo) Save(entity interface{}) (string, error) { +func (m *MockLibraryRepo) Save(entity any) (string, error) { lib := entity.(*model.Library) if m.Err != nil { return "", m.Err @@ -216,7 +216,7 @@ func (m *MockLibraryRepo) Save(entity interface{}) (string, error) { return strconv.Itoa(lib.ID), nil } -func (m *MockLibraryRepo) Update(id string, entity interface{}, cols ...string) error { +func (m *MockLibraryRepo) Update(id string, entity any, cols ...string) error { lib := entity.(*model.Library) if m.Err != nil { return m.Err diff --git a/core/mock_library_service.go b/tests/mock_library_service.go similarity index 57% rename from core/mock_library_service.go rename to tests/mock_library_service.go index 56f2abd4c..78693197d 100644 --- a/core/mock_library_service.go +++ b/tests/mock_library_service.go @@ -1,27 +1,28 @@ -package core +package tests import ( "context" "github.com/deluan/rest" "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/tests" ) -// MockLibraryWrapper provides a simple wrapper around MockLibraryRepo -// that implements the core.Library interface for testing -type MockLibraryWrapper struct { - *tests.MockLibraryRepo +// MockLibraryService provides a simple wrapper around MockLibraryRepo +// that implements the core.Library interface for testing. +// Returns concrete type to avoid import cycles - callers assign to core.Library. +type MockLibraryService struct { + *MockLibraryRepo } // MockLibraryRestAdapter adapts MockLibraryRepo to rest.Repository interface type MockLibraryRestAdapter struct { - *tests.MockLibraryRepo + *MockLibraryRepo } -// NewMockLibraryService creates a new mock library service for testing -func NewMockLibraryService() Library { - repo := &tests.MockLibraryRepo{ +// NewMockLibraryService creates a new mock library service for testing. +// Returns concrete type - assign to core.Library at call site. +func NewMockLibraryService() *MockLibraryService { + repo := &MockLibraryRepo{ Data: make(map[int]model.Library), } // Set up default test data @@ -29,10 +30,10 @@ func NewMockLibraryService() Library { {ID: 1, Name: "Test Library 1", Path: "/music/library1"}, {ID: 2, Name: "Test Library 2", Path: "/music/library2"}, }) - return &MockLibraryWrapper{MockLibraryRepo: repo} + return &MockLibraryService{MockLibraryRepo: repo} } -func (m *MockLibraryWrapper) NewRepository(ctx context.Context) rest.Repository { +func (m *MockLibraryService) NewRepository(ctx context.Context) rest.Repository { return &MockLibraryRestAdapter{MockLibraryRepo: m.MockLibraryRepo} } @@ -41,6 +42,3 @@ func (m *MockLibraryWrapper) NewRepository(ctx context.Context) rest.Repository func (a *MockLibraryRestAdapter) Delete(id string) error { return a.DeleteByStringID(id) } - -var _ Library = (*MockLibraryWrapper)(nil) -var _ rest.Repository = (*MockLibraryRestAdapter)(nil) diff --git a/tests/mock_mediafile_repo.go b/tests/mock_mediafile_repo.go index 5b38a7187..01eacae30 100644 --- a/tests/mock_mediafile_repo.go +++ b/tests/mock_mediafile_repo.go @@ -76,6 +76,10 @@ func (m *MockMediaFileRepo) GetWithParticipants(id string) (*model.MediaFile, er return nil, model.ErrNotFound } +func (m *MockMediaFileRepo) GetAllByTags(_ model.TagName, _ []string, options ...model.QueryOptions) (model.MediaFiles, error) { + return m.GetAll(options...) +} + func (m *MockMediaFileRepo) GetAll(qo ...model.QueryOptions) (model.MediaFiles, error) { if len(qo) > 0 { m.Options = qo[0] @@ -105,6 +109,17 @@ func (m *MockMediaFileRepo) Put(mf *model.MediaFile) error { return nil } +func (m *MockMediaFileRepo) UpdateProbeData(id string, data string) error { + if m.Err { + return errors.New("error") + } + if d, ok := m.Data[id]; ok { + d.ProbeData = data + return nil + } + return model.ErrNotFound +} + func (m *MockMediaFileRepo) Delete(id string) error { if m.Err { return errors.New("error") @@ -214,7 +229,7 @@ func (m *MockMediaFileRepo) Count(...rest.QueryOptions) (int64, error) { return m.CountAll() } -func (m *MockMediaFileRepo) Read(id string) (interface{}, error) { +func (m *MockMediaFileRepo) Read(id string) (any, error) { mf, err := m.Get(id) if errors.Is(err, model.ErrNotFound) { return nil, rest.ErrNotFound @@ -222,7 +237,7 @@ func (m *MockMediaFileRepo) Read(id string) (interface{}, error) { return mf, err } -func (m *MockMediaFileRepo) ReadAll(...rest.QueryOptions) (interface{}, error) { +func (m *MockMediaFileRepo) ReadAll(...rest.QueryOptions) (any, error) { return m.GetAll() } @@ -230,11 +245,11 @@ func (m *MockMediaFileRepo) EntityName() string { return "mediafile" } -func (m *MockMediaFileRepo) NewInstance() interface{} { +func (m *MockMediaFileRepo) NewInstance() any { return &model.MediaFile{} } -func (m *MockMediaFileRepo) Search(q string, offset int, size int, options ...model.QueryOptions) (model.MediaFiles, error) { +func (m *MockMediaFileRepo) Search(q string, options ...model.QueryOptions) (model.MediaFiles, error) { if len(options) > 0 { m.Options = options[0] } diff --git a/tests/mock_playlist_repo.go b/tests/mock_playlist_repo.go index 60dc98be9..9bdc52152 100644 --- a/tests/mock_playlist_repo.go +++ b/tests/mock_playlist_repo.go @@ -1,33 +1,111 @@ package tests import ( + "errors" + "github.com/deluan/rest" "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/id" ) +func CreateMockPlaylistRepo() *MockPlaylistRepo { + return &MockPlaylistRepo{ + Data: make(map[string]*model.Playlist), + PathMap: make(map[string]*model.Playlist), + } +} + type MockPlaylistRepo struct { model.PlaylistRepository - - Entity *model.Playlist - Error error + Data map[string]*model.Playlist // keyed by ID + PathMap map[string]*model.Playlist // keyed by path + Last *model.Playlist + Deleted []string + Err bool + TracksRepo model.PlaylistTrackRepository } -func (m *MockPlaylistRepo) Get(_ string) (*model.Playlist, error) { - if m.Error != nil { - return nil, m.Error +func (m *MockPlaylistRepo) SetError(err bool) { + m.Err = err +} + +func (m *MockPlaylistRepo) Get(id string) (*model.Playlist, error) { + if m.Err { + return nil, errors.New("error") } - if m.Entity == nil { - return nil, model.ErrNotFound + if m.Data != nil { + if pls, ok := m.Data[id]; ok { + return pls, nil + } } - return m.Entity, nil + return nil, model.ErrNotFound +} + +func (m *MockPlaylistRepo) GetWithTracks(id string, _, _ bool) (*model.Playlist, error) { + return m.Get(id) +} + +func (m *MockPlaylistRepo) Put(pls *model.Playlist) error { + if m.Err { + return errors.New("error") + } + if pls.ID == "" { + pls.ID = id.NewRandom() + } + m.Last = pls + if m.Data != nil { + m.Data[pls.ID] = pls + } + return nil +} + +func (m *MockPlaylistRepo) FindByPath(path string) (*model.Playlist, error) { + if m.Err { + return nil, errors.New("error") + } + if m.PathMap != nil { + if pls, ok := m.PathMap[path]; ok { + return pls, nil + } + } + return nil, model.ErrNotFound +} + +func (m *MockPlaylistRepo) Delete(id string) error { + if m.Err { + return errors.New("error") + } + m.Deleted = append(m.Deleted, id) + return nil +} + +func (m *MockPlaylistRepo) Tracks(_ string, _ bool) model.PlaylistTrackRepository { + return m.TracksRepo +} + +func (m *MockPlaylistRepo) Exists(id string) (bool, error) { + if m.Err { + return false, errors.New("error") + } + if m.Data != nil { + _, found := m.Data[id] + return found, nil + } + return false, nil } func (m *MockPlaylistRepo) Count(_ ...rest.QueryOptions) (int64, error) { - if m.Error != nil { - return 0, m.Error + if m.Err { + return 0, errors.New("error") } - if m.Entity == nil { - return 0, nil - } - return 1, nil + return int64(len(m.Data)), nil } + +func (m *MockPlaylistRepo) CountAll(_ ...model.QueryOptions) (int64, error) { + if m.Err { + return 0, errors.New("error") + } + return int64(len(m.Data)), nil +} + +var _ model.PlaylistRepository = (*MockPlaylistRepo)(nil) diff --git a/tests/mock_playlist_track_repo.go b/tests/mock_playlist_track_repo.go new file mode 100644 index 000000000..c11b077d2 --- /dev/null +++ b/tests/mock_playlist_track_repo.go @@ -0,0 +1,53 @@ +package tests + +import "github.com/navidrome/navidrome/model" + +type MockPlaylistTrackRepo struct { + model.PlaylistTrackRepository + AddedIds []string + DeletedIds []string + Reordered bool + AddCount int + Err error +} + +func (m *MockPlaylistTrackRepo) Add(ids []string) (int, error) { + m.AddedIds = append(m.AddedIds, ids...) + if m.Err != nil { + return 0, m.Err + } + return m.AddCount, nil +} + +func (m *MockPlaylistTrackRepo) AddAlbums(_ []string) (int, error) { + if m.Err != nil { + return 0, m.Err + } + return m.AddCount, nil +} + +func (m *MockPlaylistTrackRepo) AddArtists(_ []string) (int, error) { + if m.Err != nil { + return 0, m.Err + } + return m.AddCount, nil +} + +func (m *MockPlaylistTrackRepo) AddDiscs(_ []model.DiscID) (int, error) { + if m.Err != nil { + return 0, m.Err + } + return m.AddCount, nil +} + +func (m *MockPlaylistTrackRepo) Delete(ids ...string) error { + m.DeletedIds = append(m.DeletedIds, ids...) + return m.Err +} + +func (m *MockPlaylistTrackRepo) Reorder(_, _ int) error { + m.Reordered = true + return m.Err +} + +var _ model.PlaylistTrackRepository = (*MockPlaylistTrackRepo)(nil) diff --git a/tests/mock_plugin_manager.go b/tests/mock_plugin_manager.go new file mode 100644 index 000000000..05375f31c --- /dev/null +++ b/tests/mock_plugin_manager.go @@ -0,0 +1,132 @@ +package tests + +import ( + "context" +) + +// MockPluginManager is a mock implementation of plugins.PluginManager for testing. +// It implements EnablePlugin, DisablePlugin, UpdatePluginConfig, ValidatePluginConfig, UpdatePluginUsers, UpdatePluginLibraries and RescanPlugins methods. +type MockPluginManager struct { + // EnablePluginFn is called when EnablePlugin is invoked. If nil, returns EnableError. + EnablePluginFn func(ctx context.Context, id string) error + // DisablePluginFn is called when DisablePlugin is invoked. If nil, returns DisableError. + DisablePluginFn func(ctx context.Context, id string) error + // UpdatePluginConfigFn is called when UpdatePluginConfig is invoked. If nil, returns ConfigError. + UpdatePluginConfigFn func(ctx context.Context, id, configJSON string) error + // ValidatePluginConfigFn is called when ValidatePluginConfig is invoked. If nil, returns ValidateError. + ValidatePluginConfigFn func(ctx context.Context, id, configJSON string) error + // UpdatePluginUsersFn is called when UpdatePluginUsers is invoked. If nil, returns UsersError. + UpdatePluginUsersFn func(ctx context.Context, id, usersJSON string, allUsers bool) error + // UpdatePluginLibrariesFn is called when UpdatePluginLibraries is invoked. If nil, returns LibrariesError. + UpdatePluginLibrariesFn func(ctx context.Context, id, librariesJSON string, allLibraries, allowWriteAccess bool) error + // RescanPluginsFn is called when RescanPlugins is invoked. If nil, returns RescanError. + RescanPluginsFn func(ctx context.Context) error + + // Default errors to return when Fn callbacks are not set + EnableError error + DisableError error + ConfigError error + ValidateError error + UsersError error + LibrariesError error + RescanError error + + // Track calls for assertions + EnablePluginCalls []string + DisablePluginCalls []string + UpdatePluginConfigCalls []struct { + ID string + ConfigJSON string + } + ValidatePluginConfigCalls []struct { + ID string + ConfigJSON string + } + UpdatePluginUsersCalls []struct { + ID string + UsersJSON string + AllUsers bool + } + UpdatePluginLibrariesCalls []struct { + ID string + LibrariesJSON string + AllLibraries bool + AllowWriteAccess bool + } + RescanPluginsCalls int +} + +func (m *MockPluginManager) EnablePlugin(ctx context.Context, id string) error { + m.EnablePluginCalls = append(m.EnablePluginCalls, id) + if m.EnablePluginFn != nil { + return m.EnablePluginFn(ctx, id) + } + return m.EnableError +} + +func (m *MockPluginManager) DisablePlugin(ctx context.Context, id string) error { + m.DisablePluginCalls = append(m.DisablePluginCalls, id) + if m.DisablePluginFn != nil { + return m.DisablePluginFn(ctx, id) + } + return m.DisableError +} + +func (m *MockPluginManager) UpdatePluginConfig(ctx context.Context, id, configJSON string) error { + m.UpdatePluginConfigCalls = append(m.UpdatePluginConfigCalls, struct { + ID string + ConfigJSON string + }{ID: id, ConfigJSON: configJSON}) + if m.UpdatePluginConfigFn != nil { + return m.UpdatePluginConfigFn(ctx, id, configJSON) + } + return m.ConfigError +} + +func (m *MockPluginManager) ValidatePluginConfig(ctx context.Context, id, configJSON string) error { + m.ValidatePluginConfigCalls = append(m.ValidatePluginConfigCalls, struct { + ID string + ConfigJSON string + }{ID: id, ConfigJSON: configJSON}) + if m.ValidatePluginConfigFn != nil { + return m.ValidatePluginConfigFn(ctx, id, configJSON) + } + return m.ValidateError +} + +func (m *MockPluginManager) UpdatePluginUsers(ctx context.Context, id, usersJSON string, allUsers bool) error { + m.UpdatePluginUsersCalls = append(m.UpdatePluginUsersCalls, struct { + ID string + UsersJSON string + AllUsers bool + }{ID: id, UsersJSON: usersJSON, AllUsers: allUsers}) + if m.UpdatePluginUsersFn != nil { + return m.UpdatePluginUsersFn(ctx, id, usersJSON, allUsers) + } + return m.UsersError +} + +func (m *MockPluginManager) UpdatePluginLibraries(ctx context.Context, id, librariesJSON string, allLibraries, allowWriteAccess bool) error { + m.UpdatePluginLibrariesCalls = append(m.UpdatePluginLibrariesCalls, struct { + ID string + LibrariesJSON string + AllLibraries bool + AllowWriteAccess bool + }{ID: id, LibrariesJSON: librariesJSON, AllLibraries: allLibraries, AllowWriteAccess: allowWriteAccess}) + if m.UpdatePluginLibrariesFn != nil { + return m.UpdatePluginLibrariesFn(ctx, id, librariesJSON, allLibraries, allowWriteAccess) + } + return m.LibrariesError +} + +func (m *MockPluginManager) RescanPlugins(ctx context.Context) error { + m.RescanPluginsCalls++ + if m.RescanPluginsFn != nil { + return m.RescanPluginsFn(ctx) + } + return m.RescanError +} + +func (m *MockPluginManager) UnloadDisabledPlugins(ctx context.Context) { + // No-op for mock - plugins are not actually loaded in tests +} diff --git a/tests/mock_plugin_repo.go b/tests/mock_plugin_repo.go new file mode 100644 index 000000000..5d22c26aa --- /dev/null +++ b/tests/mock_plugin_repo.go @@ -0,0 +1,188 @@ +package tests + +import ( + "errors" + "time" + + "github.com/deluan/rest" + "github.com/navidrome/navidrome/model" +) + +func CreateMockPluginRepo() *MockPluginRepo { + return &MockPluginRepo{ + Data: make(map[string]*model.Plugin), + IsAdmin: true, // Default to admin access + Permitted: true, + } +} + +type MockPluginRepo struct { + Data map[string]*model.Plugin + All model.Plugins + Err bool + Options model.QueryOptions + IsAdmin bool + Permitted bool +} + +func (m *MockPluginRepo) SetError(err bool) { + m.Err = err +} + +func (m *MockPluginRepo) ClearErrors() error { + if m.Err { + return errors.New("unexpected error") + } + for i := range m.All { + m.All[i].LastError = "" + } + for k, p := range m.Data { + p.LastError = "" + m.Data[k] = p + } + return nil +} + +func (m *MockPluginRepo) SetData(plugins model.Plugins) { + m.Data = make(map[string]*model.Plugin, len(plugins)) + m.All = plugins + for i, p := range m.All { + m.Data[p.ID] = &m.All[i] + } +} + +func (m *MockPluginRepo) SetPermitted(permitted bool) { + m.Permitted = permitted +} + +func (m *MockPluginRepo) Get(id string) (*model.Plugin, error) { + if !m.Permitted { + return nil, rest.ErrPermissionDenied + } + if m.Err { + return nil, errors.New("unexpected error") + } + if d, ok := m.Data[id]; ok { + return d, nil + } + return nil, model.ErrNotFound +} + +func (m *MockPluginRepo) Read(id string) (any, error) { + p, err := m.Get(id) + if errors.Is(err, model.ErrNotFound) { + return nil, rest.ErrNotFound + } + return p, err +} + +func (m *MockPluginRepo) Put(p *model.Plugin) error { + if !m.Permitted { + return rest.ErrPermissionDenied + } + if m.Err { + return errors.New("unexpected error") + } + if p.ID == "" { + return errors.New("plugin ID cannot be empty") + } + now := time.Now() + if existing, ok := m.Data[p.ID]; ok { + p.CreatedAt = existing.CreatedAt + } else { + p.CreatedAt = now + } + p.UpdatedAt = now + m.Data[p.ID] = p + // Update All slice + found := false + for i, existing := range m.All { + if existing.ID == p.ID { + m.All[i] = *p + found = true + break + } + } + if !found { + m.All = append(m.All, *p) + } + return nil +} + +func (m *MockPluginRepo) Delete(id string) error { + if !m.Permitted { + return rest.ErrPermissionDenied + } + if m.Err { + return errors.New("unexpected error") + } + delete(m.Data, id) + // Update All slice + for i, p := range m.All { + if p.ID == id { + m.All = append(m.All[:i], m.All[i+1:]...) + break + } + } + return nil +} + +func (m *MockPluginRepo) GetAll(qo ...model.QueryOptions) (model.Plugins, error) { + if len(qo) > 0 { + m.Options = qo[0] + } + if !m.Permitted { + return nil, rest.ErrPermissionDenied + } + if m.Err { + return nil, errors.New("unexpected error") + } + return m.All, nil +} + +func (m *MockPluginRepo) CountAll(qo ...model.QueryOptions) (int64, error) { + if len(qo) > 0 { + m.Options = qo[0] + } + if !m.Permitted { + return 0, rest.ErrPermissionDenied + } + if m.Err { + return 0, errors.New("unexpected error") + } + return int64(len(m.All)), nil +} + +// rest.Repository interface methods +func (m *MockPluginRepo) Count(options ...rest.QueryOptions) (int64, error) { + if !m.Permitted { + return 0, rest.ErrPermissionDenied + } + return int64(len(m.All)), nil +} + +func (m *MockPluginRepo) EntityName() string { + return "plugin" +} + +func (m *MockPluginRepo) NewInstance() any { + return &model.Plugin{} +} + +func (m *MockPluginRepo) ReadAll(options ...rest.QueryOptions) (any, error) { + return m.GetAll() +} + +func (m *MockPluginRepo) Save(entity any) (string, error) { + p := entity.(*model.Plugin) + err := m.Put(p) + return p.ID, err +} + +func (m *MockPluginRepo) Update(id string, entity any, cols ...string) error { + p := entity.(*model.Plugin) + p.ID = id + return m.Put(p) +} + +var _ model.PluginRepository = (*MockPluginRepo)(nil) diff --git a/tests/mock_radio_repository.go b/tests/mock_radio_repository.go index 279b735db..c50a529e5 100644 --- a/tests/mock_radio_repository.go +++ b/tests/mock_radio_repository.go @@ -73,7 +73,7 @@ func (m *MockedRadioRepo) GetAll(qo ...model.QueryOptions) (model.Radios, error) return m.All, nil } -func (m *MockedRadioRepo) Put(radio *model.Radio) error { +func (m *MockedRadioRepo) Put(radio *model.Radio, _ ...string) error { if m.Err { return errors.New("error") } diff --git a/tests/mock_scanner.go b/tests/mock_scanner.go new file mode 100644 index 000000000..495e8fe53 --- /dev/null +++ b/tests/mock_scanner.go @@ -0,0 +1,143 @@ +package tests + +import ( + "context" + "sync" + + "github.com/navidrome/navidrome/model" +) + +// MockScanner implements scanner.Scanner for testing with proper synchronization +type MockScanner struct { + mu sync.Mutex + scanAllCalls []ScanAllCall + scanFoldersCalls []ScanFoldersCall + scanningStatus bool + statusResponse *model.ScannerStatus + scanStatusFunc func(fullScan bool, targets []model.ScanTarget) *model.ScannerStatus +} + +type ScanAllCall struct { + FullScan bool +} + +type ScanFoldersCall struct { + FullScan bool + Targets []model.ScanTarget +} + +func NewMockScanner() *MockScanner { + return &MockScanner{ + scanAllCalls: make([]ScanAllCall, 0), + scanFoldersCalls: make([]ScanFoldersCall, 0), + } +} + +func (m *MockScanner) ScanAll(_ context.Context, fullScan bool) ([]string, error) { + m.mu.Lock() + defer m.mu.Unlock() + + m.scanAllCalls = append(m.scanAllCalls, ScanAllCall{FullScan: fullScan}) + + // Simulate the scanner updating its status when the scan starts + if m.scanStatusFunc != nil { + m.statusResponse = m.scanStatusFunc(fullScan, nil) + } else { + m.scanningStatus = true + } + + return nil, nil +} + +func (m *MockScanner) ScanFolders(_ context.Context, fullScan bool, targets []model.ScanTarget) ([]string, error) { + m.mu.Lock() + defer m.mu.Unlock() + + // Make a copy of targets to avoid race conditions + targetsCopy := make([]model.ScanTarget, len(targets)) + copy(targetsCopy, targets) + + m.scanFoldersCalls = append(m.scanFoldersCalls, ScanFoldersCall{ + FullScan: fullScan, + Targets: targetsCopy, + }) + + // Simulate the scanner updating its status when the scan starts + if m.scanStatusFunc != nil { + m.statusResponse = m.scanStatusFunc(fullScan, targetsCopy) + } else { + m.scanningStatus = true + } + + return nil, nil +} + +func (m *MockScanner) Status(_ context.Context) (*model.ScannerStatus, error) { + m.mu.Lock() + defer m.mu.Unlock() + + if m.statusResponse != nil { + return m.statusResponse, nil + } + + return &model.ScannerStatus{ + Scanning: m.scanningStatus, + }, nil +} + +func (m *MockScanner) GetScanAllCallCount() int { + m.mu.Lock() + defer m.mu.Unlock() + return len(m.scanAllCalls) +} + +func (m *MockScanner) GetScanAllCalls() []ScanAllCall { + m.mu.Lock() + defer m.mu.Unlock() + // Return a copy to avoid race conditions + calls := make([]ScanAllCall, len(m.scanAllCalls)) + copy(calls, m.scanAllCalls) + return calls +} + +func (m *MockScanner) GetScanFoldersCallCount() int { + m.mu.Lock() + defer m.mu.Unlock() + return len(m.scanFoldersCalls) +} + +func (m *MockScanner) GetScanFoldersCalls() []ScanFoldersCall { + m.mu.Lock() + defer m.mu.Unlock() + // Return a copy to avoid race conditions + calls := make([]ScanFoldersCall, len(m.scanFoldersCalls)) + copy(calls, m.scanFoldersCalls) + return calls +} + +func (m *MockScanner) Reset() { + m.mu.Lock() + defer m.mu.Unlock() + m.scanAllCalls = make([]ScanAllCall, 0) + m.scanFoldersCalls = make([]ScanFoldersCall, 0) +} + +func (m *MockScanner) SetScanning(scanning bool) { + m.mu.Lock() + defer m.mu.Unlock() + m.scanningStatus = scanning +} + +func (m *MockScanner) SetStatusResponse(status *model.ScannerStatus) { + m.mu.Lock() + defer m.mu.Unlock() + m.statusResponse = status +} + +// SetScanStatusFunc sets a function that will be called when ScanAll/ScanFolders is invoked, +// simulating the scanner updating its status when the scan starts. +func (m *MockScanner) SetScanStatusFunc(fn func(fullScan bool, targets []model.ScanTarget) *model.ScannerStatus) { + m.mu.Lock() + defer m.mu.Unlock() + m.scanStatusFunc = fn +} diff --git a/tests/mock_scrobble_repo.go b/tests/mock_scrobble_repo.go new file mode 100644 index 000000000..34561c257 --- /dev/null +++ b/tests/mock_scrobble_repo.go @@ -0,0 +1,24 @@ +package tests + +import ( + "context" + "time" + + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" +) + +type MockScrobbleRepo struct { + RecordedScrobbles []model.Scrobble + ctx context.Context +} + +func (m *MockScrobbleRepo) RecordScrobble(fileID string, submissionTime time.Time) error { + user, _ := request.UserFrom(m.ctx) + m.RecordedScrobbles = append(m.RecordedScrobbles, model.Scrobble{ + MediaFileID: fileID, + UserID: user.ID, + SubmissionTime: submissionTime, + }) + return nil +} diff --git a/tests/mock_share_repo.go b/tests/mock_share_repo.go index ef026ca34..22eb9446c 100644 --- a/tests/mock_share_repo.go +++ b/tests/mock_share_repo.go @@ -10,13 +10,13 @@ type MockShareRepo struct { rest.Repository rest.Persistable - Entity interface{} + Entity any ID string Cols []string Error error } -func (m *MockShareRepo) Save(entity interface{}) (string, error) { +func (m *MockShareRepo) Save(entity any) (string, error) { if m.Error != nil { return "", m.Error } @@ -28,7 +28,7 @@ func (m *MockShareRepo) Save(entity interface{}) (string, error) { return s.ID, nil } -func (m *MockShareRepo) Update(id string, entity interface{}, cols ...string) error { +func (m *MockShareRepo) Update(id string, entity any, cols ...string) error { if m.Error != nil { return m.Error } diff --git a/tests/mock_transcoding_repo.go b/tests/mock_transcoding_repo.go index 12db0d7be..796e84111 100644 --- a/tests/mock_transcoding_repo.go +++ b/tests/mock_transcoding_repo.go @@ -18,6 +18,10 @@ func (m *MockTranscodingRepo) FindByFormat(format string) (*model.Transcoding, e return &model.Transcoding{ID: "oga1", TargetFormat: "oga", DefaultBitRate: 128}, nil case "opus": return &model.Transcoding{ID: "opus1", TargetFormat: "opus", DefaultBitRate: 96}, nil + case "flac": + return &model.Transcoding{ID: "flac1", TargetFormat: "flac", DefaultBitRate: 0, Command: "ffmpeg -i %s -ss %t -map 0:a:0 -v 0 -c:a flac -f flac -"}, nil + case "aac": + return &model.Transcoding{ID: "aac1", TargetFormat: "aac", DefaultBitRate: 256, Command: "ffmpeg -i %s -ss %t -map 0:a:0 -b:a %bk -v 0 -c:a aac -f ipod -movflags frag_keyframe+empty_moov -"}, nil default: return nil, model.ErrNotFound } diff --git a/tests/mock_user_repo.go b/tests/mock_user_repo.go index 9f3dd672e..cc05829f6 100644 --- a/tests/mock_user_repo.go +++ b/tests/mock_user_repo.go @@ -70,6 +70,17 @@ func (u *MockedUserRepo) Get(id string) (*model.User, error) { return nil, model.ErrNotFound } +func (u *MockedUserRepo) GetAll(options ...model.QueryOptions) (model.Users, error) { + if u.Error != nil { + return nil, u.Error + } + var users model.Users + for _, usr := range u.Data { + users = append(users, *usr) + } + return users, nil +} + func (u *MockedUserRepo) UpdateLastLoginAt(id string) error { for _, usr := range u.Data { if usr.ID == id { @@ -123,3 +134,34 @@ func (u *MockedUserRepo) SetUserLibraries(userID string, libraryIDs []int) error u.UserLibraries[userID] = libraryIDs return nil } + +func (u *MockedUserRepo) Delete(id string) error { + if u.Error != nil { + return u.Error + } + for key, usr := range u.Data { + if usr.ID == id { + delete(u.Data, key) + delete(u.UserLibraries, id) + return nil + } + } + return model.ErrNotFound +} + +func (u *MockedUserRepo) Save(entity any) (string, error) { + usr := entity.(*model.User) + if err := u.Put(usr); err != nil { + return "", err + } + return usr.ID, nil +} + +func (u *MockedUserRepo) Update(id string, entity any, cols ...string) error { + if u.Error != nil { + return u.Error + } + usr := entity.(*model.User) + usr.ID = id + return u.Put(usr) +} diff --git a/tests/mock_user_service.go b/tests/mock_user_service.go new file mode 100644 index 000000000..f2700de45 --- /dev/null +++ b/tests/mock_user_service.go @@ -0,0 +1,30 @@ +package tests + +import ( + "context" + + "github.com/deluan/rest" +) + +// MockUserService provides a simple wrapper around MockedUserRepo +// that implements the core.User interface for testing. +// Returns concrete type to avoid import cycles - callers assign to core.User. +type MockUserService struct { + *MockedUserRepo +} + +// MockUserRestAdapter adapts MockedUserRepo to rest.Repository interface +type MockUserRestAdapter struct { + *MockedUserRepo +} + +// NewMockUserService creates a new mock user service for testing. +// Returns concrete type - assign to core.User at call site. +func NewMockUserService() *MockUserService { + repo := CreateMockUserRepo() + return &MockUserService{MockedUserRepo: repo} +} + +func (m *MockUserService) NewRepository(ctx context.Context) rest.Repository { + return &MockUserRestAdapter{MockedUserRepo: m.MockedUserRepo} +} diff --git a/tests/test_helpers.go b/tests/test_helpers.go index 1251c90cd..0a2cad4ad 100644 --- a/tests/test_helpers.go +++ b/tests/test_helpers.go @@ -6,7 +6,10 @@ import ( "path/filepath" "github.com/navidrome/navidrome/db" + "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model/id" + "github.com/sirupsen/logrus" + "github.com/sirupsen/logrus/hooks/test" ) type testingT interface { @@ -35,3 +38,23 @@ func ClearDB() error { `) return err } + +// LogHook sets up a logrus test hook and configures the default logger to use it. +// It returns the hook and a cleanup function to restore the default logger. +// Example usage: +// +// hook, cleanup := LogHook() +// defer cleanup() +// // ... perform logging operations ... +// Expect(hook.LastEntry()).ToNot(BeNil()) +// Expect(hook.LastEntry().Level).To(Equal(logrus.WarnLevel)) +// Expect(hook.LastEntry().Message).To(Equal("log message")) +func LogHook() (*test.Hook, func()) { + l, hook := test.NewNullLogger() + log.SetLevel(log.LevelWarn) + log.SetDefaultLogger(l) + return hook, func() { + // Restore default logger after test + log.SetDefaultLogger(logrus.New()) + } +} diff --git a/ui/index.html b/ui/index.html index 0e60ec678..827751856 100644 --- a/ui/index.html +++ b/ui/index.html @@ -27,6 +27,10 @@ <meta property="og:image:width" content="300"> <meta property="og:image:height" content="300"> <title>Navidrome + diff --git a/ui/package-lock.json b/ui/package-lock.json index 9e449c5e0..0e6183720 100644 --- a/ui/package-lock.json +++ b/ui/package-lock.json @@ -7,19 +7,23 @@ "name": "ui", "hasInstallScript": true, "dependencies": { + "@jsonforms/core": "^2.5.2", + "@jsonforms/material-renderers": "^2.5.2", + "@jsonforms/react": "^2.5.2", "@material-ui/core": "^4.12.4", "@material-ui/icons": "^4.11.3", - "@material-ui/lab": "^4.0.0-alpha.58", + "@material-ui/lab": "^4.0.0-alpha.61", "@material-ui/styles": "^4.11.5", "blueimp-md5": "^2.19.0", "clsx": "^2.1.1", "connected-react-router": "^6.9.3", "deepmerge": "^4.3.1", + "dompurify": "^3.3.2", "history": "^4.10.1", "inflection": "^3.0.2", "jwt-decode": "^4.0.0", "lodash.throttle": "^4.1.1", - "navidrome-music-player": "4.25.1", + "navidrome-music-player": "4.25.2", "prop-types": "^15.8.1", "ra-data-json-server": "^3.19.12", "ra-i18n-polyglot": "^3.19.12", @@ -37,8 +41,8 @@ "react-redux": "^7.2.9", "react-router-dom": "^5.3.4", "redux": "^4.2.1", - "redux-saga": "^1.3.0", - "uuid": "^11.1.0", + "redux-saga": "^1.4.2", + "uuid": "^13.0.0", "workbox-cli": "^7.3.0" }, "devDependencies": { @@ -46,52 +50,38 @@ "@testing-library/react": "^12.1.5", "@testing-library/react-hooks": "^7.0.2", "@testing-library/user-event": "^14.6.1", - "@types/node": "^22.15.21", - "@types/react": "^17.0.86", + "@types/node": "^24.9.1", + "@types/react": "^17.0.89", "@types/react-dom": "^17.0.26", "@typescript-eslint/eslint-plugin": "^6.21.0", "@typescript-eslint/parser": "^6.21.0", - "@vitejs/plugin-react": "^4.5.0", - "@vitest/coverage-v8": "^3.1.4", + "@vitejs/plugin-react": "^5.1.0", + "@vitest/coverage-v8": "^4.0.3", "eslint": "^8.57.1", - "eslint-config-prettier": "^10.1.5", + "eslint-config-prettier": "^10.1.8", "eslint-plugin-jsx-a11y": "^6.10.2", "eslint-plugin-react": "^7.37.5", "eslint-plugin-react-hooks": "^5.2.0", - "eslint-plugin-react-refresh": "^0.4.20", - "happy-dom": "^17.4.7", + "eslint-plugin-react-refresh": "^0.4.24", + "happy-dom": "^20.0.8", "jsdom": "^26.1.0", - "prettier": "^3.5.3", + "prettier": "^3.6.2", "ra-test": "^3.19.12", "typescript": "^5.8.3", - "vite": "^6.3.5", - "vite-plugin-pwa": "^0.21.2", - "vitest": "^3.1.4" + "vite": "^7.1.12", + "vite-plugin-pwa": "^1.1.0", + "vitest": "^4.0.3" } }, "node_modules/@adobe/css-tools": { - "version": "4.4.3", - "resolved": "https://registry.npmjs.org/@adobe/css-tools/-/css-tools-4.4.3.tgz", - "integrity": "sha512-VQKMkwriZbaOgVCby1UDY/LDk5fIjhQicCvVPFqfe+69fWaPWydbWJ3wRt59/YzIwda1I81loas3oCoHxnqvdA==", - "dev": true - }, - "node_modules/@ampproject/remapping": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/@ampproject/remapping/-/remapping-2.3.0.tgz", - "integrity": "sha512-30iZtAPgz+LTIYoeivqYo853f02jBYSd5uGnGpkFV0M3xOt9aN73erkgYAmZU43x4VfqcnLxW9Kpg3R5LC4YYw==", - "dependencies": { - "@jridgewell/gen-mapping": "^0.3.5", - "@jridgewell/trace-mapping": "^0.3.24" - }, - "engines": { - "node": ">=6.0.0" - } + "version": "4.4.4", + "dev": true, + "license": "MIT" }, "node_modules/@asamuzakjp/css-color": { "version": "3.2.0", - "resolved": "https://registry.npmjs.org/@asamuzakjp/css-color/-/css-color-3.2.0.tgz", - "integrity": "sha512-K1A6z8tS3XsmCMM86xoWdn7Fkdn9m6RSVtocUrJYIwZnFVkng/PvkEoWtOWmP+Scc6saYWHWZYbndEEXxl24jw==", "dev": true, + "license": "MIT", "dependencies": { "@csstools/css-calc": "^2.1.3", "@csstools/css-color-parser": "^3.0.9", @@ -102,16 +92,14 @@ }, "node_modules/@asamuzakjp/css-color/node_modules/lru-cache": { "version": "10.4.3", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-10.4.3.tgz", - "integrity": "sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ==", - "dev": true + "dev": true, + "license": "ISC" }, "node_modules/@babel/code-frame": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.27.1.tgz", - "integrity": "sha512-cjQ7ZlQ0Mv3b47hABuTevyTuYN4i+loJKGeV9flcCgIK37cCXRh+L1bd3iBHlynerhQ7BhCkn2BPbQUL+rGqFg==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/helper-validator-identifier": "^7.27.1", + "@babel/helper-validator-identifier": "^7.28.5", "js-tokens": "^4.0.0", "picocolors": "^1.1.1" }, @@ -120,28 +108,27 @@ } }, "node_modules/@babel/compat-data": { - "version": "7.27.2", - "resolved": "https://registry.npmjs.org/@babel/compat-data/-/compat-data-7.27.2.tgz", - "integrity": "sha512-TUtMJYRPyUb/9aU8f3K0mjmjf6M9N5Woshn2CS6nqJSeJtTtQcpLUXjGt9vbF8ZGff0El99sWkLgzwW3VXnxZQ==", + "version": "7.28.6", + "license": "MIT", "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/core": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.27.1.tgz", - "integrity": "sha512-IaaGWsQqfsQWVLqMn9OB92MNN7zukfVA4s7KKAI0KfrrDsZ0yhi5uV4baBuLuN7n3vsZpwP8asPPcVwApxvjBQ==", + "version": "7.28.6", + "license": "MIT", + "peer": true, "dependencies": { - "@ampproject/remapping": "^2.2.0", - "@babel/code-frame": "^7.27.1", - "@babel/generator": "^7.27.1", - "@babel/helper-compilation-targets": "^7.27.1", - "@babel/helper-module-transforms": "^7.27.1", - "@babel/helpers": "^7.27.1", - "@babel/parser": "^7.27.1", - "@babel/template": "^7.27.1", - "@babel/traverse": "^7.27.1", - "@babel/types": "^7.27.1", + "@babel/code-frame": "^7.28.6", + "@babel/generator": "^7.28.6", + "@babel/helper-compilation-targets": "^7.28.6", + "@babel/helper-module-transforms": "^7.28.6", + "@babel/helpers": "^7.28.6", + "@babel/parser": "^7.28.6", + "@babel/template": "^7.28.6", + "@babel/traverse": "^7.28.6", + "@babel/types": "^7.28.6", + "@jridgewell/remapping": "^2.3.5", "convert-source-map": "^2.0.0", "debug": "^4.1.0", "gensync": "^1.0.0-beta.2", @@ -158,21 +145,19 @@ }, "node_modules/@babel/core/node_modules/semver": { "version": "6.3.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", - "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "license": "ISC", "bin": { "semver": "bin/semver.js" } }, "node_modules/@babel/generator": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.27.1.tgz", - "integrity": "sha512-UnJfnIpc/+JO0/+KRVQNGU+y5taA5vCbwN8+azkX6beii/ZF+enZJSOKo11ZSzGJjlNfJHfQtmQT8H+9TXPG2w==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/parser": "^7.27.1", - "@babel/types": "^7.27.1", - "@jridgewell/gen-mapping": "^0.3.5", - "@jridgewell/trace-mapping": "^0.3.25", + "@babel/parser": "^7.28.6", + "@babel/types": "^7.28.6", + "@jridgewell/gen-mapping": "^0.3.12", + "@jridgewell/trace-mapping": "^0.3.28", "jsesc": "^3.0.2" }, "engines": { @@ -180,22 +165,20 @@ } }, "node_modules/@babel/helper-annotate-as-pure": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-annotate-as-pure/-/helper-annotate-as-pure-7.27.1.tgz", - "integrity": "sha512-WnuuDILl9oOBbKnb4L+DyODx7iC47XfzmNCpTttFsSp6hTG7XZxu60+4IO+2/hPfcGOoKbFiwoI/+zwARbNQow==", + "version": "7.27.3", + "license": "MIT", "dependencies": { - "@babel/types": "^7.27.1" + "@babel/types": "^7.27.3" }, "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/helper-compilation-targets": { - "version": "7.27.2", - "resolved": "https://registry.npmjs.org/@babel/helper-compilation-targets/-/helper-compilation-targets-7.27.2.tgz", - "integrity": "sha512-2+1thGUUWWjLTYTHZWK1n8Yga0ijBz1XAhUXcKy81rd5g6yh7hGqMp45v7cadSbEHc9G3OTv45SyneRN3ps4DQ==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/compat-data": "^7.27.2", + "@babel/compat-data": "^7.28.6", "@babel/helper-validator-option": "^7.27.1", "browserslist": "^4.24.0", "lru-cache": "^5.1.1", @@ -207,23 +190,21 @@ }, "node_modules/@babel/helper-compilation-targets/node_modules/semver": { "version": "6.3.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", - "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "license": "ISC", "bin": { "semver": "bin/semver.js" } }, "node_modules/@babel/helper-create-class-features-plugin": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-create-class-features-plugin/-/helper-create-class-features-plugin-7.27.1.tgz", - "integrity": "sha512-QwGAmuvM17btKU5VqXfb+Giw4JcN0hjuufz3DYnpeVDvZLAObloM77bhMXiqry3Iio+Ai4phVRDwl6WU10+r5A==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/helper-annotate-as-pure": "^7.27.1", - "@babel/helper-member-expression-to-functions": "^7.27.1", + "@babel/helper-annotate-as-pure": "^7.27.3", + "@babel/helper-member-expression-to-functions": "^7.28.5", "@babel/helper-optimise-call-expression": "^7.27.1", - "@babel/helper-replace-supers": "^7.27.1", + "@babel/helper-replace-supers": "^7.28.6", "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1", - "@babel/traverse": "^7.27.1", + "@babel/traverse": "^7.28.6", "semver": "^6.3.1" }, "engines": { @@ -235,19 +216,17 @@ }, "node_modules/@babel/helper-create-class-features-plugin/node_modules/semver": { "version": "6.3.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", - "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "license": "ISC", "bin": { "semver": "bin/semver.js" } }, "node_modules/@babel/helper-create-regexp-features-plugin": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-create-regexp-features-plugin/-/helper-create-regexp-features-plugin-7.27.1.tgz", - "integrity": "sha512-uVDC72XVf8UbrH5qQTc18Agb8emwjTiZrQE11Nv3CuBEZmVvTwwE9CBUEvHku06gQCAyYf8Nv6ja1IN+6LMbxQ==", + "version": "7.28.5", + "license": "MIT", "dependencies": { - "@babel/helper-annotate-as-pure": "^7.27.1", - "regexpu-core": "^6.2.0", + "@babel/helper-annotate-as-pure": "^7.27.3", + "regexpu-core": "^6.3.1", "semver": "^6.3.1" }, "engines": { @@ -259,33 +238,30 @@ }, "node_modules/@babel/helper-create-regexp-features-plugin/node_modules/semver": { "version": "6.3.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", - "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "license": "ISC", "bin": { "semver": "bin/semver.js" } }, "node_modules/@babel/helper-define-polyfill-provider": { - "version": "0.6.4", - "resolved": "https://registry.npmjs.org/@babel/helper-define-polyfill-provider/-/helper-define-polyfill-provider-0.6.4.tgz", - "integrity": "sha512-jljfR1rGnXXNWnmQg2K3+bvhkxB51Rl32QRaOTuwwjviGrHzIbSc8+x9CpraDtbT7mfyjXObULP4w/adunNwAw==", + "version": "0.6.5", + "license": "MIT", "dependencies": { - "@babel/helper-compilation-targets": "^7.22.6", - "@babel/helper-plugin-utils": "^7.22.5", - "debug": "^4.1.1", + "@babel/helper-compilation-targets": "^7.27.2", + "@babel/helper-plugin-utils": "^7.27.1", + "debug": "^4.4.1", "lodash.debounce": "^4.0.8", - "resolve": "^1.14.2" + "resolve": "^1.22.10" }, "peerDependencies": { "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" } }, "node_modules/@babel/helper-define-polyfill-provider/node_modules/resolve": { - "version": "1.22.10", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.10.tgz", - "integrity": "sha512-NPRy+/ncIMeDlTAsuqwKIiferiawhefFJtkNSW0qZJEqMEb+qBt/77B/jGeeek+F0uOeN05CDa6HXbbIgtVX4w==", + "version": "1.22.11", + "license": "MIT", "dependencies": { - "is-core-module": "^2.16.0", + "is-core-module": "^2.16.1", "path-parse": "^1.0.7", "supports-preserve-symlinks-flag": "^1.0.0" }, @@ -299,38 +275,42 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/@babel/helper-globals": { + "version": "7.28.0", + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, "node_modules/@babel/helper-member-expression-to-functions": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-member-expression-to-functions/-/helper-member-expression-to-functions-7.27.1.tgz", - "integrity": "sha512-E5chM8eWjTp/aNoVpcbfM7mLxu9XGLWYise2eBKGQomAk/Mb4XoxyqXTZbuTohbsl8EKqdlMhnDI2CCLfcs9wA==", + "version": "7.28.5", + "license": "MIT", "dependencies": { - "@babel/traverse": "^7.27.1", - "@babel/types": "^7.27.1" + "@babel/traverse": "^7.28.5", + "@babel/types": "^7.28.5" }, "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/helper-module-imports": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-module-imports/-/helper-module-imports-7.27.1.tgz", - "integrity": "sha512-0gSFWUPNXNopqtIPQvlD5WgXYI5GY2kP2cCvoT8kczjbfcfuIljTbcWrulD1CIPIX2gt1wghbDy08yE1p+/r3w==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/traverse": "^7.27.1", - "@babel/types": "^7.27.1" + "@babel/traverse": "^7.28.6", + "@babel/types": "^7.28.6" }, "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/helper-module-transforms": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-module-transforms/-/helper-module-transforms-7.27.1.tgz", - "integrity": "sha512-9yHn519/8KvTU5BjTVEEeIM3w9/2yXNKoD82JifINImhpKkARMJKPP59kLo+BafpdN5zgNeIcS4jsGDmd3l58g==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/helper-module-imports": "^7.27.1", - "@babel/helper-validator-identifier": "^7.27.1", - "@babel/traverse": "^7.27.1" + "@babel/helper-module-imports": "^7.28.6", + "@babel/helper-validator-identifier": "^7.28.5", + "@babel/traverse": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -341,8 +321,7 @@ }, "node_modules/@babel/helper-optimise-call-expression": { "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-optimise-call-expression/-/helper-optimise-call-expression-7.27.1.tgz", - "integrity": "sha512-URMGH08NzYFhubNSGJrpUEphGKQwMQYBySzat5cAByY1/YgIRkULnIy3tAMeszlL/so2HbeilYloUmSpd7GdVw==", + "license": "MIT", "dependencies": { "@babel/types": "^7.27.1" }, @@ -351,17 +330,15 @@ } }, "node_modules/@babel/helper-plugin-utils": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-plugin-utils/-/helper-plugin-utils-7.27.1.tgz", - "integrity": "sha512-1gn1Up5YXka3YYAHGKpbideQ5Yjf1tDa9qYcgysz+cNCXukyLl6DjPXhD3VRwSb8c0J9tA4b2+rHEZtc6R0tlw==", + "version": "7.28.6", + "license": "MIT", "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/helper-remap-async-to-generator": { "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-remap-async-to-generator/-/helper-remap-async-to-generator-7.27.1.tgz", - "integrity": "sha512-7fiA521aVw8lSPeI4ZOD3vRFkoqkJcS+z4hFo82bFSH/2tNd6eJ5qCVMS5OzDmZh/kaHQeBaeyxK6wljcPtveA==", + "license": "MIT", "dependencies": { "@babel/helper-annotate-as-pure": "^7.27.1", "@babel/helper-wrap-function": "^7.27.1", @@ -375,13 +352,12 @@ } }, "node_modules/@babel/helper-replace-supers": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-replace-supers/-/helper-replace-supers-7.27.1.tgz", - "integrity": "sha512-7EHz6qDZc8RYS5ElPoShMheWvEgERonFCs7IAonWLLUTXW59DP14bCZt89/GKyreYn8g3S83m21FelHKbeDCKA==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/helper-member-expression-to-functions": "^7.27.1", + "@babel/helper-member-expression-to-functions": "^7.28.5", "@babel/helper-optimise-call-expression": "^7.27.1", - "@babel/traverse": "^7.27.1" + "@babel/traverse": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -392,8 +368,7 @@ }, "node_modules/@babel/helper-skip-transparent-expression-wrappers": { "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-skip-transparent-expression-wrappers/-/helper-skip-transparent-expression-wrappers-7.27.1.tgz", - "integrity": "sha512-Tub4ZKEXqbPjXgWLl2+3JpQAYBJ8+ikpQ2Ocj/q/r0LwE3UhENh7EUabyHjz2kCEsrRY83ew2DQdHluuiDQFzg==", + "license": "MIT", "dependencies": { "@babel/traverse": "^7.27.1", "@babel/types": "^7.27.1" @@ -404,59 +379,53 @@ }, "node_modules/@babel/helper-string-parser": { "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.27.1.tgz", - "integrity": "sha512-qMlSxKbpRlAridDExk92nSobyDdpPijUq2DW6oDnUqd0iOGxmQjyqhMIihI9+zv4LPyZdRje2cavWPbCbWm3eA==", + "license": "MIT", "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/helper-validator-identifier": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.27.1.tgz", - "integrity": "sha512-D2hP9eA+Sqx1kBZgzxZh0y1trbuU+JoDkiEwqhQ36nodYqJwyEIhPSdMNd7lOm/4io72luTPWH20Yda0xOuUow==", + "version": "7.28.5", + "license": "MIT", "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/helper-validator-option": { "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-validator-option/-/helper-validator-option-7.27.1.tgz", - "integrity": "sha512-YvjJow9FxbhFFKDSuFnVCe2WxXk1zWc22fFePVNEaWJEu8IrZVlda6N0uHwzZrUM1il7NC9Mlp4MaJYbYd9JSg==", + "license": "MIT", "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/helper-wrap-function": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-wrap-function/-/helper-wrap-function-7.27.1.tgz", - "integrity": "sha512-NFJK2sHUvrjo8wAU/nQTWU890/zB2jj0qBcCbZbbf+005cAsv6tMjXz31fBign6M5ov1o0Bllu+9nbqkfsjjJQ==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/template": "^7.27.1", - "@babel/traverse": "^7.27.1", - "@babel/types": "^7.27.1" + "@babel/template": "^7.28.6", + "@babel/traverse": "^7.28.6", + "@babel/types": "^7.28.6" }, "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/helpers": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.27.1.tgz", - "integrity": "sha512-FCvFTm0sWV8Fxhpp2McP5/W53GPllQ9QeQ7SiqGWjMf/LVG07lFa5+pgK05IRhVwtvafT22KF+ZSnM9I545CvQ==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/template": "^7.27.1", - "@babel/types": "^7.27.1" + "@babel/template": "^7.28.6", + "@babel/types": "^7.28.6" }, "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/parser": { - "version": "7.27.2", - "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.27.2.tgz", - "integrity": "sha512-QYLs8299NA7WM/bZAdp+CviYYkVoYXlDW2rzliy3chxd1PQjej7JORuMJDJXJUb9g0TT+B99EwaVLKmX+sPXWw==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/types": "^7.27.1" + "@babel/types": "^7.28.6" }, "bin": { "parser": "bin/babel-parser.js" @@ -466,12 +435,11 @@ } }, "node_modules/@babel/plugin-bugfix-firefox-class-in-computed-class-key": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-firefox-class-in-computed-class-key/-/plugin-bugfix-firefox-class-in-computed-class-key-7.27.1.tgz", - "integrity": "sha512-QPG3C9cCVRQLxAVwmefEmwdTanECuUBMQZ/ym5kiw3XKCGA7qkuQLcjWWHcrD/GKbn/WmJwaezfuuAOcyKlRPA==", + "version": "7.28.5", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1", - "@babel/traverse": "^7.27.1" + "@babel/traverse": "^7.28.5" }, "engines": { "node": ">=6.9.0" @@ -482,8 +450,7 @@ }, "node_modules/@babel/plugin-bugfix-safari-class-field-initializer-scope": { "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-safari-class-field-initializer-scope/-/plugin-bugfix-safari-class-field-initializer-scope-7.27.1.tgz", - "integrity": "sha512-qNeq3bCKnGgLkEXUuFry6dPlGfCdQNZbn7yUAPCInwAJHMU7THJfrBSozkcWq5sNM6RcF3S8XyQL2A52KNR9IA==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -496,8 +463,7 @@ }, "node_modules/@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression": { "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression/-/plugin-bugfix-safari-id-destructuring-collision-in-function-expression-7.27.1.tgz", - "integrity": "sha512-g4L7OYun04N1WyqMNjldFwlfPCLVkgB54A/YCXICZYBsvJJE3kByKv9c9+R/nAfmIfjl2rKYLNyMHboYbZaWaA==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -510,8 +476,7 @@ }, "node_modules/@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining": { "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining/-/plugin-bugfix-v8-spread-parameters-in-optional-chaining-7.27.1.tgz", - "integrity": "sha512-oO02gcONcD5O1iTLi/6frMJBIwWEHceWGSGqrpCmEL8nogiS6J9PBlE48CaK20/Jx1LuRml9aDftLgdjXT8+Cw==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1", "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1", @@ -525,12 +490,11 @@ } }, "node_modules/@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly/-/plugin-bugfix-v8-static-class-fields-redefine-readonly-7.27.1.tgz", - "integrity": "sha512-6BpaYGDavZqkI6yT+KSPdpZFfpnd68UKXbcjI9pJ13pvHhPrCKWOOLp+ysvMeA+DxnhuPpgIaRpxRxo5A9t5jw==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/traverse": "^7.27.1" + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/traverse": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -541,8 +505,7 @@ }, "node_modules/@babel/plugin-proposal-private-property-in-object": { "version": "7.21.0-placeholder-for-preset-env.2", - "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-private-property-in-object/-/plugin-proposal-private-property-in-object-7.21.0-placeholder-for-preset-env.2.tgz", - "integrity": "sha512-SOSkfJDddaM7mak6cPEpswyTRnuRltl429hMraQEglW+OkovnCzsiszTmsrlY//qLFjCpQDFRvjdm2wA5pPm9w==", + "license": "MIT", "engines": { "node": ">=6.9.0" }, @@ -551,11 +514,10 @@ } }, "node_modules/@babel/plugin-syntax-import-assertions": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-assertions/-/plugin-syntax-import-assertions-7.27.1.tgz", - "integrity": "sha512-UT/Jrhw57xg4ILHLFnzFpPDlMbcdEicaAtjPQpbj9wa8T4r5KVWCimHcL/460g8Ht0DMxDyjsLgiWSkVjnwPFg==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -565,11 +527,10 @@ } }, "node_modules/@babel/plugin-syntax-import-attributes": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-attributes/-/plugin-syntax-import-attributes-7.27.1.tgz", - "integrity": "sha512-oFT0FrKHgF53f4vOsZGi2Hh3I35PfSmVs4IBFLFj4dnafP+hIWDLg3VyKmUHfLoLHlyxY4C7DGtmHuJgn+IGww==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -580,8 +541,7 @@ }, "node_modules/@babel/plugin-syntax-unicode-sets-regex": { "version": "7.18.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-unicode-sets-regex/-/plugin-syntax-unicode-sets-regex-7.18.6.tgz", - "integrity": "sha512-727YkEAPwSIQTv5im8QHz3upqp92JTWhidIC81Tdx4VJYIte/VndKf1qKrfnnhPLiPghStWfvC/iFaMCQu7Nqg==", + "license": "MIT", "dependencies": { "@babel/helper-create-regexp-features-plugin": "^7.18.6", "@babel/helper-plugin-utils": "^7.18.6" @@ -595,8 +555,7 @@ }, "node_modules/@babel/plugin-transform-arrow-functions": { "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-arrow-functions/-/plugin-transform-arrow-functions-7.27.1.tgz", - "integrity": "sha512-8Z4TGic6xW70FKThA5HYEKKyBpOOsucTOD1DjU3fZxDg+K3zBJcXMFnt/4yQiZnf5+MiOMSXQ9PaEK/Ilh1DeA==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -608,13 +567,12 @@ } }, "node_modules/@babel/plugin-transform-async-generator-functions": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-async-generator-functions/-/plugin-transform-async-generator-functions-7.27.1.tgz", - "integrity": "sha512-eST9RrwlpaoJBDHShc+DS2SG4ATTi2MYNb4OxYkf3n+7eb49LWpnS+HSpVfW4x927qQwgk8A2hGNVaajAEw0EA==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", + "@babel/helper-plugin-utils": "^7.28.6", "@babel/helper-remap-async-to-generator": "^7.27.1", - "@babel/traverse": "^7.27.1" + "@babel/traverse": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -624,12 +582,11 @@ } }, "node_modules/@babel/plugin-transform-async-to-generator": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-async-to-generator/-/plugin-transform-async-to-generator-7.27.1.tgz", - "integrity": "sha512-NREkZsZVJS4xmTr8qzE5y8AfIPqsdQfRuUiLRTEzb7Qii8iFWCyDKaUV2c0rCuh4ljDZ98ALHP/PetiBV2nddA==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/helper-module-imports": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1", + "@babel/helper-module-imports": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6", "@babel/helper-remap-async-to-generator": "^7.27.1" }, "engines": { @@ -641,8 +598,7 @@ }, "node_modules/@babel/plugin-transform-block-scoped-functions": { "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-block-scoped-functions/-/plugin-transform-block-scoped-functions-7.27.1.tgz", - "integrity": "sha512-cnqkuOtZLapWYZUYM5rVIdv1nXYuFVIltZ6ZJ7nIj585QsjKM5dhL2Fu/lICXZ1OyIAFc7Qy+bvDAtTXqGrlhg==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -654,11 +610,10 @@ } }, "node_modules/@babel/plugin-transform-block-scoping": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-block-scoping/-/plugin-transform-block-scoping-7.27.1.tgz", - "integrity": "sha512-QEcFlMl9nGTgh1rn2nIeU5bkfb9BAjaQcWbiP4LvKxUot52ABcTkpcyJ7f2Q2U2RuQ84BNLgts3jRme2dTx6Fw==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -668,12 +623,11 @@ } }, "node_modules/@babel/plugin-transform-class-properties": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-class-properties/-/plugin-transform-class-properties-7.27.1.tgz", - "integrity": "sha512-D0VcalChDMtuRvJIu3U/fwWjf8ZMykz5iZsg77Nuj821vCKI3zCyRLwRdWbsuJ/uRwZhZ002QtCqIkwC/ZkvbA==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/helper-create-class-features-plugin": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-create-class-features-plugin": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -683,12 +637,11 @@ } }, "node_modules/@babel/plugin-transform-class-static-block": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-class-static-block/-/plugin-transform-class-static-block-7.27.1.tgz", - "integrity": "sha512-s734HmYU78MVzZ++joYM+NkJusItbdRcbm+AGRgJCt3iA+yux0QpD9cBVdz3tKyrjVYWRl7j0mHSmv4lhV0aoA==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/helper-create-class-features-plugin": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-create-class-features-plugin": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -698,16 +651,15 @@ } }, "node_modules/@babel/plugin-transform-classes": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-classes/-/plugin-transform-classes-7.27.1.tgz", - "integrity": "sha512-7iLhfFAubmpeJe/Wo2TVuDrykh/zlWXLzPNdL0Jqn/Xu8R3QQ8h9ff8FQoISZOsw74/HFqFI7NX63HN7QFIHKA==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/helper-annotate-as-pure": "^7.27.1", - "@babel/helper-compilation-targets": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/helper-replace-supers": "^7.27.1", - "@babel/traverse": "^7.27.1", - "globals": "^11.1.0" + "@babel/helper-annotate-as-pure": "^7.27.3", + "@babel/helper-compilation-targets": "^7.28.6", + "@babel/helper-globals": "^7.28.0", + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/helper-replace-supers": "^7.28.6", + "@babel/traverse": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -717,12 +669,11 @@ } }, "node_modules/@babel/plugin-transform-computed-properties": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-computed-properties/-/plugin-transform-computed-properties-7.27.1.tgz", - "integrity": "sha512-lj9PGWvMTVksbWiDT2tW68zGS/cyo4AkZ/QTp0sQT0mjPopCmrSkzxeXkznjqBxzDI6TclZhOJbBmbBLjuOZUw==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/template": "^7.27.1" + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/template": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -732,11 +683,11 @@ } }, "node_modules/@babel/plugin-transform-destructuring": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-destructuring/-/plugin-transform-destructuring-7.27.1.tgz", - "integrity": "sha512-ttDCqhfvpE9emVkXbPD8vyxxh4TWYACVybGkDj+oReOGwnp066ITEivDlLwe0b1R0+evJ13IXQuLNB5w1fhC5Q==", + "version": "7.28.5", + "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.27.1", + "@babel/traverse": "^7.28.5" }, "engines": { "node": ">=6.9.0" @@ -746,12 +697,11 @@ } }, "node_modules/@babel/plugin-transform-dotall-regex": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-dotall-regex/-/plugin-transform-dotall-regex-7.27.1.tgz", - "integrity": "sha512-gEbkDVGRvjj7+T1ivxrfgygpT7GUd4vmODtYpbs0gZATdkX8/iSnOtZSxiZnsgm1YjTgjI6VKBGSJJevkrclzw==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-create-regexp-features-plugin": "^7.28.5", + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -762,8 +712,7 @@ }, "node_modules/@babel/plugin-transform-duplicate-keys": { "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-duplicate-keys/-/plugin-transform-duplicate-keys-7.27.1.tgz", - "integrity": "sha512-MTyJk98sHvSs+cvZ4nOauwTTG1JeonDjSGvGGUNHreGQns+Mpt6WX/dVzWBHgg+dYZhkC4X+zTDfkTU+Vy9y7Q==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -775,12 +724,11 @@ } }, "node_modules/@babel/plugin-transform-duplicate-named-capturing-groups-regex": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-duplicate-named-capturing-groups-regex/-/plugin-transform-duplicate-named-capturing-groups-regex-7.27.1.tgz", - "integrity": "sha512-hkGcueTEzuhB30B3eJCbCYeCaaEQOmQR0AdvzpD4LoN0GXMWzzGSuRrxR2xTnCrvNbVwK9N6/jQ92GSLfiZWoQ==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-create-regexp-features-plugin": "^7.28.5", + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -791,8 +739,7 @@ }, "node_modules/@babel/plugin-transform-dynamic-import": { "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-dynamic-import/-/plugin-transform-dynamic-import-7.27.1.tgz", - "integrity": "sha512-MHzkWQcEmjzzVW9j2q8LGjwGWpG2mjwaaB0BNQwst3FIjqsg8Ct/mIZlvSPJvfi9y2AC8mi/ktxbFVL9pZ1I4A==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -803,12 +750,25 @@ "@babel/core": "^7.0.0-0" } }, - "node_modules/@babel/plugin-transform-exponentiation-operator": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-exponentiation-operator/-/plugin-transform-exponentiation-operator-7.27.1.tgz", - "integrity": "sha512-uspvXnhHvGKf2r4VVtBpeFnuDWsJLQ6MF6lGJLC89jBR1uoVeqM416AZtTuhTezOfgHicpJQmoD5YUakO/YmXQ==", + "node_modules/@babel/plugin-transform-explicit-resource-management": { + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/plugin-transform-destructuring": "^7.28.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-exponentiation-operator": { + "version": "7.28.6", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -819,8 +779,7 @@ }, "node_modules/@babel/plugin-transform-export-namespace-from": { "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-export-namespace-from/-/plugin-transform-export-namespace-from-7.27.1.tgz", - "integrity": "sha512-tQvHWSZ3/jH2xuq/vZDy0jNn+ZdXJeM8gHvX4lnJmsc3+50yPlWdZXIc5ay+umX+2/tJIqHqiEqcJvxlmIvRvQ==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -833,8 +792,7 @@ }, "node_modules/@babel/plugin-transform-for-of": { "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-for-of/-/plugin-transform-for-of-7.27.1.tgz", - "integrity": "sha512-BfbWFFEJFQzLCQ5N8VocnCtA8J1CLkNTe2Ms2wocj75dd6VpiqS5Z5quTYcUoo4Yq+DN0rtikODccuv7RU81sw==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1", "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1" @@ -848,8 +806,7 @@ }, "node_modules/@babel/plugin-transform-function-name": { "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-function-name/-/plugin-transform-function-name-7.27.1.tgz", - "integrity": "sha512-1bQeydJF9Nr1eBCMMbC+hdwmRlsv5XYOMu03YSWFwNs0HsAmtSxxF1fyuYPqemVldVyFmlCU7w8UE14LupUSZQ==", + "license": "MIT", "dependencies": { "@babel/helper-compilation-targets": "^7.27.1", "@babel/helper-plugin-utils": "^7.27.1", @@ -863,11 +820,10 @@ } }, "node_modules/@babel/plugin-transform-json-strings": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-json-strings/-/plugin-transform-json-strings-7.27.1.tgz", - "integrity": "sha512-6WVLVJiTjqcQauBhn1LkICsR2H+zm62I3h9faTDKt1qP4jn2o72tSvqMwtGFKGTpojce0gJs+76eZ2uCHRZh0Q==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -878,8 +834,7 @@ }, "node_modules/@babel/plugin-transform-literals": { "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-literals/-/plugin-transform-literals-7.27.1.tgz", - "integrity": "sha512-0HCFSepIpLTkLcsi86GG3mTUzxV5jpmbv97hTETW3yzrAij8aqlD36toB1D0daVFJM8NK6GvKO0gslVQmm+zZA==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -891,11 +846,10 @@ } }, "node_modules/@babel/plugin-transform-logical-assignment-operators": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-logical-assignment-operators/-/plugin-transform-logical-assignment-operators-7.27.1.tgz", - "integrity": "sha512-SJvDs5dXxiae4FbSL1aBJlG4wvl594N6YEVVn9e3JGulwioy6z3oPjx/sQBO3Y4NwUu5HNix6KJ3wBZoewcdbw==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -906,8 +860,7 @@ }, "node_modules/@babel/plugin-transform-member-expression-literals": { "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-member-expression-literals/-/plugin-transform-member-expression-literals-7.27.1.tgz", - "integrity": "sha512-hqoBX4dcZ1I33jCSWcXrP+1Ku7kdqXf1oeah7ooKOIiAdKQ+uqftgCFNOSzA5AMS2XIHEYeGFg4cKRCdpxzVOQ==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -920,8 +873,7 @@ }, "node_modules/@babel/plugin-transform-modules-amd": { "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-amd/-/plugin-transform-modules-amd-7.27.1.tgz", - "integrity": "sha512-iCsytMg/N9/oFq6n+gFTvUYDZQOMK5kEdeYxmxt91fcJGycfxVP9CnrxoliM0oumFERba2i8ZtwRUCMhvP1LnA==", + "license": "MIT", "dependencies": { "@babel/helper-module-transforms": "^7.27.1", "@babel/helper-plugin-utils": "^7.27.1" @@ -934,12 +886,11 @@ } }, "node_modules/@babel/plugin-transform-modules-commonjs": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-commonjs/-/plugin-transform-modules-commonjs-7.27.1.tgz", - "integrity": "sha512-OJguuwlTYlN0gBZFRPqwOGNWssZjfIUdS7HMYtN8c1KmwpwHFBwTeFZrg9XZa+DFTitWOW5iTAG7tyCUPsCCyw==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/helper-module-transforms": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-module-transforms": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -949,14 +900,13 @@ } }, "node_modules/@babel/plugin-transform-modules-systemjs": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-systemjs/-/plugin-transform-modules-systemjs-7.27.1.tgz", - "integrity": "sha512-w5N1XzsRbc0PQStASMksmUeqECuzKuTJer7kFagK8AXgpCMkeDMO5S+aaFb7A51ZYDF7XI34qsTX+fkHiIm5yA==", + "version": "7.28.5", + "license": "MIT", "dependencies": { - "@babel/helper-module-transforms": "^7.27.1", + "@babel/helper-module-transforms": "^7.28.3", "@babel/helper-plugin-utils": "^7.27.1", - "@babel/helper-validator-identifier": "^7.27.1", - "@babel/traverse": "^7.27.1" + "@babel/helper-validator-identifier": "^7.28.5", + "@babel/traverse": "^7.28.5" }, "engines": { "node": ">=6.9.0" @@ -967,8 +917,7 @@ }, "node_modules/@babel/plugin-transform-modules-umd": { "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-umd/-/plugin-transform-modules-umd-7.27.1.tgz", - "integrity": "sha512-iQBE/xC5BV1OxJbp6WG7jq9IWiD+xxlZhLrdwpPkTX3ydmXdvoCpyfJN7acaIBZaOqTfr76pgzqBJflNbeRK+w==", + "license": "MIT", "dependencies": { "@babel/helper-module-transforms": "^7.27.1", "@babel/helper-plugin-utils": "^7.27.1" @@ -982,8 +931,7 @@ }, "node_modules/@babel/plugin-transform-named-capturing-groups-regex": { "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-named-capturing-groups-regex/-/plugin-transform-named-capturing-groups-regex-7.27.1.tgz", - "integrity": "sha512-SstR5JYy8ddZvD6MhV0tM/j16Qds4mIpJTOd1Yu9J9pJjH93bxHECF7pgtc28XvkzTD6Pxcm/0Z73Hvk7kb3Ng==", + "license": "MIT", "dependencies": { "@babel/helper-create-regexp-features-plugin": "^7.27.1", "@babel/helper-plugin-utils": "^7.27.1" @@ -997,8 +945,7 @@ }, "node_modules/@babel/plugin-transform-new-target": { "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-new-target/-/plugin-transform-new-target-7.27.1.tgz", - "integrity": "sha512-f6PiYeqXQ05lYq3TIfIDu/MtliKUbNwkGApPUvyo6+tc7uaR4cPjPe7DFPr15Uyycg2lZU6btZ575CuQoYh7MQ==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -1010,11 +957,10 @@ } }, "node_modules/@babel/plugin-transform-nullish-coalescing-operator": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-nullish-coalescing-operator/-/plugin-transform-nullish-coalescing-operator-7.27.1.tgz", - "integrity": "sha512-aGZh6xMo6q9vq1JGcw58lZ1Z0+i0xB2x0XaauNIUXd6O1xXc3RwoWEBlsTQrY4KQ9Jf0s5rgD6SiNkaUdJegTA==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -1024,11 +970,10 @@ } }, "node_modules/@babel/plugin-transform-numeric-separator": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-numeric-separator/-/plugin-transform-numeric-separator-7.27.1.tgz", - "integrity": "sha512-fdPKAcujuvEChxDBJ5c+0BTaS6revLV7CJL08e4m3de8qJfNIuCc2nc7XJYOjBoTMJeqSmwXJ0ypE14RCjLwaw==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -1038,14 +983,14 @@ } }, "node_modules/@babel/plugin-transform-object-rest-spread": { - "version": "7.27.2", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-object-rest-spread/-/plugin-transform-object-rest-spread-7.27.2.tgz", - "integrity": "sha512-AIUHD7xJ1mCrj3uPozvtngY3s0xpv7Nu7DoUSnzNY6Xam1Cy4rUznR//pvMHOhQ4AvbCexhbqXCtpxGHOGOO6g==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/helper-compilation-targets": "^7.27.2", - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/plugin-transform-destructuring": "^7.27.1", - "@babel/plugin-transform-parameters": "^7.27.1" + "@babel/helper-compilation-targets": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/plugin-transform-destructuring": "^7.28.5", + "@babel/plugin-transform-parameters": "^7.27.7", + "@babel/traverse": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -1056,8 +1001,7 @@ }, "node_modules/@babel/plugin-transform-object-super": { "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-object-super/-/plugin-transform-object-super-7.27.1.tgz", - "integrity": "sha512-SFy8S9plRPbIcxlJ8A6mT/CxFdJx/c04JEctz4jf8YZaVS2px34j7NXRrlGlHkN/M2gnpL37ZpGRGVFLd3l8Ng==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1", "@babel/helper-replace-supers": "^7.27.1" @@ -1070,11 +1014,10 @@ } }, "node_modules/@babel/plugin-transform-optional-catch-binding": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-optional-catch-binding/-/plugin-transform-optional-catch-binding-7.27.1.tgz", - "integrity": "sha512-txEAEKzYrHEX4xSZN4kJ+OfKXFVSWKB2ZxM9dpcE3wT7smwkNmXo5ORRlVzMVdJbD+Q8ILTgSD7959uj+3Dm3Q==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -1084,11 +1027,10 @@ } }, "node_modules/@babel/plugin-transform-optional-chaining": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-optional-chaining/-/plugin-transform-optional-chaining-7.27.1.tgz", - "integrity": "sha512-BQmKPPIuc8EkZgNKsv0X4bPmOoayeu4F1YCwx2/CfmDSXDbp7GnzlUH+/ul5VGfRg1AoFPsrIThlEBj2xb4CAg==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", + "@babel/helper-plugin-utils": "^7.28.6", "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1" }, "engines": { @@ -1099,9 +1041,8 @@ } }, "node_modules/@babel/plugin-transform-parameters": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-parameters/-/plugin-transform-parameters-7.27.1.tgz", - "integrity": "sha512-018KRk76HWKeZ5l4oTj2zPpSh+NbGdt0st5S6x0pga6HgrjBOJb24mMDHorFopOOd6YHkLgOZ+zaCjZGPO4aKg==", + "version": "7.27.7", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -1113,12 +1054,11 @@ } }, "node_modules/@babel/plugin-transform-private-methods": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-private-methods/-/plugin-transform-private-methods-7.27.1.tgz", - "integrity": "sha512-10FVt+X55AjRAYI9BrdISN9/AQWHqldOeZDUoLyif1Kn05a56xVBXb8ZouL8pZ9jem8QpXaOt8TS7RHUIS+GPA==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/helper-create-class-features-plugin": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-create-class-features-plugin": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -1128,13 +1068,12 @@ } }, "node_modules/@babel/plugin-transform-private-property-in-object": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-private-property-in-object/-/plugin-transform-private-property-in-object-7.27.1.tgz", - "integrity": "sha512-5J+IhqTi1XPa0DXF83jYOaARrX+41gOewWbkPyjMNRDqgOCqdffGh8L3f/Ek5utaEBZExjSAzcyjmV9SSAWObQ==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/helper-annotate-as-pure": "^7.27.1", - "@babel/helper-create-class-features-plugin": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-annotate-as-pure": "^7.27.3", + "@babel/helper-create-class-features-plugin": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -1145,8 +1084,7 @@ }, "node_modules/@babel/plugin-transform-property-literals": { "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-property-literals/-/plugin-transform-property-literals-7.27.1.tgz", - "integrity": "sha512-oThy3BCuCha8kDZ8ZkgOg2exvPYUlprMukKQXI1r1pJ47NCvxfkEy8vK+r/hT9nF0Aa4H1WUPZZjHTFtAhGfmQ==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -1159,9 +1097,8 @@ }, "node_modules/@babel/plugin-transform-react-jsx-self": { "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-jsx-self/-/plugin-transform-react-jsx-self-7.27.1.tgz", - "integrity": "sha512-6UzkCs+ejGdZ5mFFC/OCUrv028ab2fp1znZmCZjAOBKiBK2jXD1O+BPSfX8X2qjJ75fZBMSnQn3Rq2mrBJK2mw==", "dev": true, + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -1174,9 +1111,8 @@ }, "node_modules/@babel/plugin-transform-react-jsx-source": { "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-jsx-source/-/plugin-transform-react-jsx-source-7.27.1.tgz", - "integrity": "sha512-zbwoTsBruTeKB9hSq73ha66iFeJHuaFkUbwvqElnygoNbj/jHRsSeokowZFN3CZ64IvEqcmmkVe89OPXc7ldAw==", "dev": true, + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -1188,11 +1124,10 @@ } }, "node_modules/@babel/plugin-transform-regenerator": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-regenerator/-/plugin-transform-regenerator-7.27.1.tgz", - "integrity": "sha512-B19lbbL7PMrKr52BNPjCqg1IyNUIjTcxKj8uX9zHO+PmWN93s19NDr/f69mIkEp2x9nmDJ08a7lgHaTTzvW7mw==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -1202,12 +1137,11 @@ } }, "node_modules/@babel/plugin-transform-regexp-modifiers": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-regexp-modifiers/-/plugin-transform-regexp-modifiers-7.27.1.tgz", - "integrity": "sha512-TtEciroaiODtXvLZv4rmfMhkCv8jx3wgKpL68PuiPh2M4fvz5jhsA7697N1gMvkvr/JTF13DrFYyEbY9U7cVPA==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-create-regexp-features-plugin": "^7.28.5", + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -1218,8 +1152,7 @@ }, "node_modules/@babel/plugin-transform-reserved-words": { "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-reserved-words/-/plugin-transform-reserved-words-7.27.1.tgz", - "integrity": "sha512-V2ABPHIJX4kC7HegLkYoDpfg9PVmuWy/i6vUM5eGK22bx4YVFD3M5F0QQnWQoDs6AGsUWTVOopBiMFQgHaSkVw==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -1232,8 +1165,7 @@ }, "node_modules/@babel/plugin-transform-shorthand-properties": { "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-shorthand-properties/-/plugin-transform-shorthand-properties-7.27.1.tgz", - "integrity": "sha512-N/wH1vcn4oYawbJ13Y/FxcQrWk63jhfNa7jef0ih7PHSIHX2LB7GWE1rkPrOnka9kwMxb6hMl19p7lidA+EHmQ==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -1245,11 +1177,10 @@ } }, "node_modules/@babel/plugin-transform-spread": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-spread/-/plugin-transform-spread-7.27.1.tgz", - "integrity": "sha512-kpb3HUqaILBJcRFVhFUs6Trdd4mkrzcGXss+6/mxUd273PfbWqSDHRzMT2234gIg2QYfAjvXLSquP1xECSg09Q==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", + "@babel/helper-plugin-utils": "^7.28.6", "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1" }, "engines": { @@ -1261,8 +1192,7 @@ }, "node_modules/@babel/plugin-transform-sticky-regex": { "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-sticky-regex/-/plugin-transform-sticky-regex-7.27.1.tgz", - "integrity": "sha512-lhInBO5bi/Kowe2/aLdBAawijx+q1pQzicSgnkB6dUPc1+RC8QmJHKf2OjvU+NZWitguJHEaEmbV6VWEouT58g==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -1275,8 +1205,7 @@ }, "node_modules/@babel/plugin-transform-template-literals": { "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-template-literals/-/plugin-transform-template-literals-7.27.1.tgz", - "integrity": "sha512-fBJKiV7F2DxZUkg5EtHKXQdbsbURW3DZKQUWphDum0uRP6eHGGa/He9mc0mypL680pb+e/lDIthRohlv8NCHkg==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -1289,8 +1218,7 @@ }, "node_modules/@babel/plugin-transform-typeof-symbol": { "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-typeof-symbol/-/plugin-transform-typeof-symbol-7.27.1.tgz", - "integrity": "sha512-RiSILC+nRJM7FY5srIyc4/fGIwUhyDuuBSdWn4y6yT6gm652DpCHZjIipgn6B7MQ1ITOUnAKWixEUjQRIBIcLw==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -1303,8 +1231,7 @@ }, "node_modules/@babel/plugin-transform-unicode-escapes": { "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-escapes/-/plugin-transform-unicode-escapes-7.27.1.tgz", - "integrity": "sha512-Ysg4v6AmF26k9vpfFuTZg8HRfVWzsh1kVfowA23y9j/Gu6dOuahdUVhkLqpObp3JIv27MLSii6noRnuKN8H0Mg==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -1316,12 +1243,11 @@ } }, "node_modules/@babel/plugin-transform-unicode-property-regex": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-property-regex/-/plugin-transform-unicode-property-regex-7.27.1.tgz", - "integrity": "sha512-uW20S39PnaTImxp39O5qFlHLS9LJEmANjMG7SxIhap8rCHqu0Ik+tLEPX5DKmHn6CsWQ7j3lix2tFOa5YtL12Q==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-create-regexp-features-plugin": "^7.28.5", + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -1332,8 +1258,7 @@ }, "node_modules/@babel/plugin-transform-unicode-regex": { "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-regex/-/plugin-transform-unicode-regex-7.27.1.tgz", - "integrity": "sha512-xvINq24TRojDuyt6JGtHmkVkrfVV3FPT16uytxImLeBZqW3/H52yN+kM1MGuyPkIQxrzKwPHs5U/MP3qKyzkGw==", + "license": "MIT", "dependencies": { "@babel/helper-create-regexp-features-plugin": "^7.27.1", "@babel/helper-plugin-utils": "^7.27.1" @@ -1346,12 +1271,11 @@ } }, "node_modules/@babel/plugin-transform-unicode-sets-regex": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-sets-regex/-/plugin-transform-unicode-sets-regex-7.27.1.tgz", - "integrity": "sha512-EtkOujbc4cgvb0mlpQefi4NTPBzhSIevblFevACNLUspmrALgmEBdL/XfnyyITfd8fKBZrZys92zOWcik7j9Tw==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-create-regexp-features-plugin": "^7.28.5", + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -1361,78 +1285,78 @@ } }, "node_modules/@babel/preset-env": { - "version": "7.27.2", - "resolved": "https://registry.npmjs.org/@babel/preset-env/-/preset-env-7.27.2.tgz", - "integrity": "sha512-Ma4zSuYSlGNRlCLO+EAzLnCmJK2vdstgv+n7aUP+/IKZrOfWHOJVdSJtuub8RzHTj3ahD37k5OKJWvzf16TQyQ==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/compat-data": "^7.27.2", - "@babel/helper-compilation-targets": "^7.27.2", - "@babel/helper-plugin-utils": "^7.27.1", + "@babel/compat-data": "^7.28.6", + "@babel/helper-compilation-targets": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6", "@babel/helper-validator-option": "^7.27.1", - "@babel/plugin-bugfix-firefox-class-in-computed-class-key": "^7.27.1", + "@babel/plugin-bugfix-firefox-class-in-computed-class-key": "^7.28.5", "@babel/plugin-bugfix-safari-class-field-initializer-scope": "^7.27.1", "@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression": "^7.27.1", "@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining": "^7.27.1", - "@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly": "^7.27.1", + "@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly": "^7.28.6", "@babel/plugin-proposal-private-property-in-object": "7.21.0-placeholder-for-preset-env.2", - "@babel/plugin-syntax-import-assertions": "^7.27.1", - "@babel/plugin-syntax-import-attributes": "^7.27.1", + "@babel/plugin-syntax-import-assertions": "^7.28.6", + "@babel/plugin-syntax-import-attributes": "^7.28.6", "@babel/plugin-syntax-unicode-sets-regex": "^7.18.6", "@babel/plugin-transform-arrow-functions": "^7.27.1", - "@babel/plugin-transform-async-generator-functions": "^7.27.1", - "@babel/plugin-transform-async-to-generator": "^7.27.1", + "@babel/plugin-transform-async-generator-functions": "^7.28.6", + "@babel/plugin-transform-async-to-generator": "^7.28.6", "@babel/plugin-transform-block-scoped-functions": "^7.27.1", - "@babel/plugin-transform-block-scoping": "^7.27.1", - "@babel/plugin-transform-class-properties": "^7.27.1", - "@babel/plugin-transform-class-static-block": "^7.27.1", - "@babel/plugin-transform-classes": "^7.27.1", - "@babel/plugin-transform-computed-properties": "^7.27.1", - "@babel/plugin-transform-destructuring": "^7.27.1", - "@babel/plugin-transform-dotall-regex": "^7.27.1", + "@babel/plugin-transform-block-scoping": "^7.28.6", + "@babel/plugin-transform-class-properties": "^7.28.6", + "@babel/plugin-transform-class-static-block": "^7.28.6", + "@babel/plugin-transform-classes": "^7.28.6", + "@babel/plugin-transform-computed-properties": "^7.28.6", + "@babel/plugin-transform-destructuring": "^7.28.5", + "@babel/plugin-transform-dotall-regex": "^7.28.6", "@babel/plugin-transform-duplicate-keys": "^7.27.1", - "@babel/plugin-transform-duplicate-named-capturing-groups-regex": "^7.27.1", + "@babel/plugin-transform-duplicate-named-capturing-groups-regex": "^7.28.6", "@babel/plugin-transform-dynamic-import": "^7.27.1", - "@babel/plugin-transform-exponentiation-operator": "^7.27.1", + "@babel/plugin-transform-explicit-resource-management": "^7.28.6", + "@babel/plugin-transform-exponentiation-operator": "^7.28.6", "@babel/plugin-transform-export-namespace-from": "^7.27.1", "@babel/plugin-transform-for-of": "^7.27.1", "@babel/plugin-transform-function-name": "^7.27.1", - "@babel/plugin-transform-json-strings": "^7.27.1", + "@babel/plugin-transform-json-strings": "^7.28.6", "@babel/plugin-transform-literals": "^7.27.1", - "@babel/plugin-transform-logical-assignment-operators": "^7.27.1", + "@babel/plugin-transform-logical-assignment-operators": "^7.28.6", "@babel/plugin-transform-member-expression-literals": "^7.27.1", "@babel/plugin-transform-modules-amd": "^7.27.1", - "@babel/plugin-transform-modules-commonjs": "^7.27.1", - "@babel/plugin-transform-modules-systemjs": "^7.27.1", + "@babel/plugin-transform-modules-commonjs": "^7.28.6", + "@babel/plugin-transform-modules-systemjs": "^7.28.5", "@babel/plugin-transform-modules-umd": "^7.27.1", "@babel/plugin-transform-named-capturing-groups-regex": "^7.27.1", "@babel/plugin-transform-new-target": "^7.27.1", - "@babel/plugin-transform-nullish-coalescing-operator": "^7.27.1", - "@babel/plugin-transform-numeric-separator": "^7.27.1", - "@babel/plugin-transform-object-rest-spread": "^7.27.2", + "@babel/plugin-transform-nullish-coalescing-operator": "^7.28.6", + "@babel/plugin-transform-numeric-separator": "^7.28.6", + "@babel/plugin-transform-object-rest-spread": "^7.28.6", "@babel/plugin-transform-object-super": "^7.27.1", - "@babel/plugin-transform-optional-catch-binding": "^7.27.1", - "@babel/plugin-transform-optional-chaining": "^7.27.1", - "@babel/plugin-transform-parameters": "^7.27.1", - "@babel/plugin-transform-private-methods": "^7.27.1", - "@babel/plugin-transform-private-property-in-object": "^7.27.1", + "@babel/plugin-transform-optional-catch-binding": "^7.28.6", + "@babel/plugin-transform-optional-chaining": "^7.28.6", + "@babel/plugin-transform-parameters": "^7.27.7", + "@babel/plugin-transform-private-methods": "^7.28.6", + "@babel/plugin-transform-private-property-in-object": "^7.28.6", "@babel/plugin-transform-property-literals": "^7.27.1", - "@babel/plugin-transform-regenerator": "^7.27.1", - "@babel/plugin-transform-regexp-modifiers": "^7.27.1", + "@babel/plugin-transform-regenerator": "^7.28.6", + "@babel/plugin-transform-regexp-modifiers": "^7.28.6", "@babel/plugin-transform-reserved-words": "^7.27.1", "@babel/plugin-transform-shorthand-properties": "^7.27.1", - "@babel/plugin-transform-spread": "^7.27.1", + "@babel/plugin-transform-spread": "^7.28.6", "@babel/plugin-transform-sticky-regex": "^7.27.1", "@babel/plugin-transform-template-literals": "^7.27.1", "@babel/plugin-transform-typeof-symbol": "^7.27.1", "@babel/plugin-transform-unicode-escapes": "^7.27.1", - "@babel/plugin-transform-unicode-property-regex": "^7.27.1", + "@babel/plugin-transform-unicode-property-regex": "^7.28.6", "@babel/plugin-transform-unicode-regex": "^7.27.1", - "@babel/plugin-transform-unicode-sets-regex": "^7.27.1", + "@babel/plugin-transform-unicode-sets-regex": "^7.28.6", "@babel/preset-modules": "0.1.6-no-external-plugins", - "babel-plugin-polyfill-corejs2": "^0.4.10", - "babel-plugin-polyfill-corejs3": "^0.11.0", - "babel-plugin-polyfill-regenerator": "^0.6.1", - "core-js-compat": "^3.40.0", + "babel-plugin-polyfill-corejs2": "^0.4.14", + "babel-plugin-polyfill-corejs3": "^0.13.0", + "babel-plugin-polyfill-regenerator": "^0.6.5", + "core-js-compat": "^3.43.0", "semver": "^6.3.1" }, "engines": { @@ -1444,16 +1368,14 @@ }, "node_modules/@babel/preset-env/node_modules/semver": { "version": "6.3.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", - "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "license": "ISC", "bin": { "semver": "bin/semver.js" } }, "node_modules/@babel/preset-modules": { "version": "0.1.6-no-external-plugins", - "resolved": "https://registry.npmjs.org/@babel/preset-modules/-/preset-modules-0.1.6-no-external-plugins.tgz", - "integrity": "sha512-HrcgcIESLm9aIR842yhJ5RWan/gebQUJ6E/E5+rf0y9o6oj7w0Br+sWuL6kEQ/o/AdfvR1Je9jG18/gnpwjEyA==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.0.0", "@babel/types": "^7.4.4", @@ -1464,62 +1386,57 @@ } }, "node_modules/@babel/runtime": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.27.1.tgz", - "integrity": "sha512-1x3D2xEk2fRo3PAhwQwu5UubzgiVWSXTBfWpVd2Mx2AzRqJuDJCsgaDVZ7HB5iGzDW1Hl1sWN2mFyKjmR9uAog==", + "version": "7.28.6", + "license": "MIT", "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/runtime-corejs3": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/runtime-corejs3/-/runtime-corejs3-7.27.1.tgz", - "integrity": "sha512-909rVuj3phpjW6y0MCXAZ5iNeORePa6ldJvp2baWGcTjwqbBDDz6xoS5JHJ7lS88NlwLYj07ImL/8IUMtDZzTA==", + "version": "7.28.6", "dev": true, + "license": "MIT", "dependencies": { - "core-js-pure": "^3.30.2" + "core-js-pure": "^3.43.0" }, "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/template": { - "version": "7.27.2", - "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.27.2.tgz", - "integrity": "sha512-LPDZ85aEJyYSd18/DkjNh4/y1ntkE5KwUHWTiqgRxruuZL2F1yuHligVHLvcHY2vMHXttKFpJn6LwfI7cw7ODw==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/code-frame": "^7.27.1", - "@babel/parser": "^7.27.2", - "@babel/types": "^7.27.1" + "@babel/code-frame": "^7.28.6", + "@babel/parser": "^7.28.6", + "@babel/types": "^7.28.6" }, "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/traverse": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.27.1.tgz", - "integrity": "sha512-ZCYtZciz1IWJB4U61UPu4KEaqyfj+r5T1Q5mqPo+IBpcG9kHv30Z0aD8LXPgC1trYa6rK0orRyAhqUgk4MjmEg==", + "version": "7.28.6", + "license": "MIT", "dependencies": { - "@babel/code-frame": "^7.27.1", - "@babel/generator": "^7.27.1", - "@babel/parser": "^7.27.1", - "@babel/template": "^7.27.1", - "@babel/types": "^7.27.1", - "debug": "^4.3.1", - "globals": "^11.1.0" + "@babel/code-frame": "^7.28.6", + "@babel/generator": "^7.28.6", + "@babel/helper-globals": "^7.28.0", + "@babel/parser": "^7.28.6", + "@babel/template": "^7.28.6", + "@babel/types": "^7.28.6", + "debug": "^4.3.1" }, "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/types": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.27.1.tgz", - "integrity": "sha512-+EzkxvLNfiUeKMgy/3luqfsCWFRXLb7U6wNQTk60tovuckwB15B191tJWvpp4HjiQWdJkCxO3Wbvc6jlk3Xb2Q==", + "version": "7.28.6", + "license": "MIT", "dependencies": { "@babel/helper-string-parser": "^7.27.1", - "@babel/helper-validator-identifier": "^7.27.1" + "@babel/helper-validator-identifier": "^7.28.5" }, "engines": { "node": ">=6.9.0" @@ -1527,17 +1444,14 @@ }, "node_modules/@bcoe/v8-coverage": { "version": "1.0.2", - "resolved": "https://registry.npmjs.org/@bcoe/v8-coverage/-/v8-coverage-1.0.2.tgz", - "integrity": "sha512-6zABk/ECA/QYSCQ1NGiVwwbQerUCZ+TQbp64Q3AgmfNvurHH0j8TtXa1qbShXA6qqkpAj4V5W8pP6mLe1mcMqA==", "dev": true, + "license": "MIT", "engines": { "node": ">=18" } }, "node_modules/@csstools/color-helpers": { - "version": "5.0.2", - "resolved": "https://registry.npmjs.org/@csstools/color-helpers/-/color-helpers-5.0.2.tgz", - "integrity": "sha512-JqWH1vsgdGcw2RR6VliXXdA0/59LttzlU8UlRT/iUUsEeWfYq8I+K0yhihEUTTHLRm1EXvpsCx3083EU15ecsA==", + "version": "5.1.0", "dev": true, "funding": [ { @@ -1549,14 +1463,13 @@ "url": "https://opencollective.com/csstools" } ], + "license": "MIT-0", "engines": { "node": ">=18" } }, "node_modules/@csstools/css-calc": { - "version": "2.1.3", - "resolved": "https://registry.npmjs.org/@csstools/css-calc/-/css-calc-2.1.3.tgz", - "integrity": "sha512-XBG3talrhid44BY1x3MHzUx/aTG8+x/Zi57M4aTKK9RFB4aLlF3TTSzfzn8nWVHWL3FgAXAxmupmDd6VWww+pw==", + "version": "2.1.4", "dev": true, "funding": [ { @@ -1568,18 +1481,17 @@ "url": "https://opencollective.com/csstools" } ], + "license": "MIT", "engines": { "node": ">=18" }, "peerDependencies": { - "@csstools/css-parser-algorithms": "^3.0.4", - "@csstools/css-tokenizer": "^3.0.3" + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" } }, "node_modules/@csstools/css-color-parser": { - "version": "3.0.9", - "resolved": "https://registry.npmjs.org/@csstools/css-color-parser/-/css-color-parser-3.0.9.tgz", - "integrity": "sha512-wILs5Zk7BU86UArYBJTPy/FMPPKVKHMj1ycCEyf3VUptol0JNRLFU/BZsJ4aiIHJEbSLiizzRrw8Pc1uAEDrXw==", + "version": "3.1.0", "dev": true, "funding": [ { @@ -1591,22 +1503,21 @@ "url": "https://opencollective.com/csstools" } ], + "license": "MIT", "dependencies": { - "@csstools/color-helpers": "^5.0.2", - "@csstools/css-calc": "^2.1.3" + "@csstools/color-helpers": "^5.1.0", + "@csstools/css-calc": "^2.1.4" }, "engines": { "node": ">=18" }, "peerDependencies": { - "@csstools/css-parser-algorithms": "^3.0.4", - "@csstools/css-tokenizer": "^3.0.3" + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" } }, "node_modules/@csstools/css-parser-algorithms": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.4.tgz", - "integrity": "sha512-Up7rBoV77rv29d3uKHUIVubz1BTcgyUK72IvCQAbfbMv584xHcGKCKbWh7i8hPrRJ7qU4Y8IO3IY9m+iTB7P3A==", + "version": "3.0.5", "dev": true, "funding": [ { @@ -1618,17 +1529,17 @@ "url": "https://opencollective.com/csstools" } ], + "license": "MIT", + "peer": true, "engines": { "node": ">=18" }, "peerDependencies": { - "@csstools/css-tokenizer": "^3.0.3" + "@csstools/css-tokenizer": "^3.0.4" } }, "node_modules/@csstools/css-tokenizer": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.3.tgz", - "integrity": "sha512-UJnjoFsmxfKUdNYdWgOB0mWUypuLvAfQPH1+pyvRJs6euowbFkFC6P13w1l8mJyi3vxYMxc9kld5jZEGRQs6bw==", + "version": "3.0.4", "dev": true, "funding": [ { @@ -1640,23 +1551,39 @@ "url": "https://opencollective.com/csstools" } ], + "license": "MIT", + "peer": true, "engines": { "node": ">=18" } }, + "node_modules/@date-io/core": { + "version": "1.3.13", + "license": "MIT" + }, + "node_modules/@date-io/moment": { + "version": "1.3.11", + "license": "MIT", + "dependencies": { + "@date-io/core": "^1.3.11" + }, + "peerDependencies": { + "moment": "^2.24.0" + } + }, "node_modules/@emotion/hash": { "version": "0.8.0", - "resolved": "https://registry.npmjs.org/@emotion/hash/-/hash-0.8.0.tgz", - "integrity": "sha512-kBJtf7PH6aWwZ6fka3zQ0p6SBYzx4fl1LoZXE2RrnYST9Xljm7WfKJrU4g/Xr3Beg72MLrp1AWNUmuYJTL7Cow==" + "license": "MIT" }, "node_modules/@esbuild/aix-ppc64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.25.4.tgz", - "integrity": "sha512-1VCICWypeQKhVbE9oW/sJaAmjLxhVqacdkvPLEjwlttjfwENRSClS8EjBz0KzRyFSCPDIkuXW34Je/vk7zdB7Q==", + "version": "0.27.2", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.27.2.tgz", + "integrity": "sha512-GZMB+a0mOMZs4MpDbj8RJp4cw+w1WV5NYD6xzgvzUJ5Ek2jerwfO2eADyI6ExDSUED+1X8aMbegahsJi+8mgpw==", "cpu": [ "ppc64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "aix" @@ -1666,13 +1593,14 @@ } }, "node_modules/@esbuild/android-arm": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.25.4.tgz", - "integrity": "sha512-QNdQEps7DfFwE3hXiU4BZeOV68HHzYwGd0Nthhd3uCkkEKK7/R6MTgM0P7H7FAs5pU/DIWsviMmEGxEoxIZ+ZQ==", + "version": "0.27.2", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.27.2.tgz", + "integrity": "sha512-DVNI8jlPa7Ujbr1yjU2PfUSRtAUZPG9I1RwW4F4xFB1Imiu2on0ADiI/c3td+KmDtVKNbi+nffGDQMfcIMkwIA==", "cpu": [ "arm" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "android" @@ -1682,13 +1610,14 @@ } }, "node_modules/@esbuild/android-arm64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.25.4.tgz", - "integrity": "sha512-bBy69pgfhMGtCnwpC/x5QhfxAz/cBgQ9enbtwjf6V9lnPI/hMyT9iWpR1arm0l3kttTr4L0KSLpKmLp/ilKS9A==", + "version": "0.27.2", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.27.2.tgz", + "integrity": "sha512-pvz8ZZ7ot/RBphf8fv60ljmaoydPU12VuXHImtAs0XhLLw+EXBi2BLe3OYSBslR4rryHvweW5gmkKFwTiFy6KA==", "cpu": [ "arm64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "android" @@ -1698,13 +1627,14 @@ } }, "node_modules/@esbuild/android-x64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.25.4.tgz", - "integrity": "sha512-TVhdVtQIFuVpIIR282btcGC2oGQoSfZfmBdTip2anCaVYcqWlZXGcdcKIUklfX2wj0JklNYgz39OBqh2cqXvcQ==", + "version": "0.27.2", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.27.2.tgz", + "integrity": "sha512-z8Ank4Byh4TJJOh4wpz8g2vDy75zFL0TlZlkUkEwYXuPSgX8yzep596n6mT7905kA9uHZsf/o2OJZubl2l3M7A==", "cpu": [ "x64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "android" @@ -1714,13 +1644,12 @@ } }, "node_modules/@esbuild/darwin-arm64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.25.4.tgz", - "integrity": "sha512-Y1giCfM4nlHDWEfSckMzeWNdQS31BQGs9/rouw6Ub91tkK79aIMTH3q9xHvzH8d0wDru5Ci0kWB8b3up/nl16g==", + "version": "0.27.2", "cpu": [ "arm64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "darwin" @@ -1730,13 +1659,14 @@ } }, "node_modules/@esbuild/darwin-x64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.25.4.tgz", - "integrity": "sha512-CJsry8ZGM5VFVeyUYB3cdKpd/H69PYez4eJh1W/t38vzutdjEjtP7hB6eLKBoOdxcAlCtEYHzQ/PJ/oU9I4u0A==", + "version": "0.27.2", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.27.2.tgz", + "integrity": "sha512-ZxtijOmlQCBWGwbVmwOF/UCzuGIbUkqB1faQRf5akQmxRJ1ujusWsb3CVfk/9iZKr2L5SMU5wPBi1UWbvL+VQA==", "cpu": [ "x64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "darwin" @@ -1746,13 +1676,14 @@ } }, "node_modules/@esbuild/freebsd-arm64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.25.4.tgz", - "integrity": "sha512-yYq+39NlTRzU2XmoPW4l5Ifpl9fqSk0nAJYM/V/WUGPEFfek1epLHJIkTQM6bBs1swApjO5nWgvr843g6TjxuQ==", + "version": "0.27.2", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.27.2.tgz", + "integrity": "sha512-lS/9CN+rgqQ9czogxlMcBMGd+l8Q3Nj1MFQwBZJyoEKI50XGxwuzznYdwcav6lpOGv5BqaZXqvBSiB/kJ5op+g==", "cpu": [ "arm64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "freebsd" @@ -1762,13 +1693,14 @@ } }, "node_modules/@esbuild/freebsd-x64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.25.4.tgz", - "integrity": "sha512-0FgvOJ6UUMflsHSPLzdfDnnBBVoCDtBTVyn/MrWloUNvq/5SFmh13l3dvgRPkDihRxb77Y17MbqbCAa2strMQQ==", + "version": "0.27.2", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.27.2.tgz", + "integrity": "sha512-tAfqtNYb4YgPnJlEFu4c212HYjQWSO/w/h/lQaBK7RbwGIkBOuNKQI9tqWzx7Wtp7bTPaGC6MJvWI608P3wXYA==", "cpu": [ "x64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "freebsd" @@ -1778,13 +1710,14 @@ } }, "node_modules/@esbuild/linux-arm": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.25.4.tgz", - "integrity": "sha512-kro4c0P85GMfFYqW4TWOpvmF8rFShbWGnrLqlzp4X1TNWjRY3JMYUfDCtOxPKOIY8B0WC8HN51hGP4I4hz4AaQ==", + "version": "0.27.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.27.2.tgz", + "integrity": "sha512-vWfq4GaIMP9AIe4yj1ZUW18RDhx6EPQKjwe7n8BbIecFtCQG4CfHGaHuh7fdfq+y3LIA2vGS/o9ZBGVxIDi9hw==", "cpu": [ "arm" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" @@ -1794,13 +1727,14 @@ } }, "node_modules/@esbuild/linux-arm64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.25.4.tgz", - "integrity": "sha512-+89UsQTfXdmjIvZS6nUnOOLoXnkUTB9hR5QAeLrQdzOSWZvNSAXAtcRDHWtqAUtAmv7ZM1WPOOeSxDzzzMogiQ==", + "version": "0.27.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.27.2.tgz", + "integrity": "sha512-hYxN8pr66NsCCiRFkHUAsxylNOcAQaxSSkHMMjcpx0si13t1LHFphxJZUiGwojB1a/Hd5OiPIqDdXONia6bhTw==", "cpu": [ "arm64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" @@ -1810,13 +1744,14 @@ } }, "node_modules/@esbuild/linux-ia32": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.25.4.tgz", - "integrity": "sha512-yTEjoapy8UP3rv8dB0ip3AfMpRbyhSN3+hY8mo/i4QXFeDxmiYbEKp3ZRjBKcOP862Ua4b1PDfwlvbuwY7hIGQ==", + "version": "0.27.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.27.2.tgz", + "integrity": "sha512-MJt5BRRSScPDwG2hLelYhAAKh9imjHK5+NE/tvnRLbIqUWa+0E9N4WNMjmp/kXXPHZGqPLxggwVhz7QP8CTR8w==", "cpu": [ "ia32" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" @@ -1826,13 +1761,14 @@ } }, "node_modules/@esbuild/linux-loong64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.25.4.tgz", - "integrity": "sha512-NeqqYkrcGzFwi6CGRGNMOjWGGSYOpqwCjS9fvaUlX5s3zwOtn1qwg1s2iE2svBe4Q/YOG1q6875lcAoQK/F4VA==", + "version": "0.27.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.27.2.tgz", + "integrity": "sha512-lugyF1atnAT463aO6KPshVCJK5NgRnU4yb3FUumyVz+cGvZbontBgzeGFO1nF+dPueHD367a2ZXe1NtUkAjOtg==", "cpu": [ "loong64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" @@ -1842,13 +1778,14 @@ } }, "node_modules/@esbuild/linux-mips64el": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.25.4.tgz", - "integrity": "sha512-IcvTlF9dtLrfL/M8WgNI/qJYBENP3ekgsHbYUIzEzq5XJzzVEV/fXY9WFPfEEXmu3ck2qJP8LG/p3Q8f7Zc2Xg==", + "version": "0.27.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.27.2.tgz", + "integrity": "sha512-nlP2I6ArEBewvJ2gjrrkESEZkB5mIoaTswuqNFRv/WYd+ATtUpe9Y09RnJvgvdag7he0OWgEZWhviS1OTOKixw==", "cpu": [ "mips64el" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" @@ -1858,13 +1795,14 @@ } }, "node_modules/@esbuild/linux-ppc64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.25.4.tgz", - "integrity": "sha512-HOy0aLTJTVtoTeGZh4HSXaO6M95qu4k5lJcH4gxv56iaycfz1S8GO/5Jh6X4Y1YiI0h7cRyLi+HixMR+88swag==", + "version": "0.27.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.27.2.tgz", + "integrity": "sha512-C92gnpey7tUQONqg1n6dKVbx3vphKtTHJaNG2Ok9lGwbZil6DrfyecMsp9CrmXGQJmZ7iiVXvvZH6Ml5hL6XdQ==", "cpu": [ "ppc64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" @@ -1874,13 +1812,14 @@ } }, "node_modules/@esbuild/linux-riscv64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.25.4.tgz", - "integrity": "sha512-i8JUDAufpz9jOzo4yIShCTcXzS07vEgWzyX3NH2G7LEFVgrLEhjwL3ajFE4fZI3I4ZgiM7JH3GQ7ReObROvSUA==", + "version": "0.27.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.27.2.tgz", + "integrity": "sha512-B5BOmojNtUyN8AXlK0QJyvjEZkWwy/FKvakkTDCziX95AowLZKR6aCDhG7LeF7uMCXEJqwa8Bejz5LTPYm8AvA==", "cpu": [ "riscv64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" @@ -1890,13 +1829,14 @@ } }, "node_modules/@esbuild/linux-s390x": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.25.4.tgz", - "integrity": "sha512-jFnu+6UbLlzIjPQpWCNh5QtrcNfMLjgIavnwPQAfoGx4q17ocOU9MsQ2QVvFxwQoWpZT8DvTLooTvmOQXkO51g==", + "version": "0.27.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.27.2.tgz", + "integrity": "sha512-p4bm9+wsPwup5Z8f4EpfN63qNagQ47Ua2znaqGH6bqLlmJ4bx97Y9JdqxgGZ6Y8xVTixUnEkoKSHcpRlDnNr5w==", "cpu": [ "s390x" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" @@ -1906,13 +1846,14 @@ } }, "node_modules/@esbuild/linux-x64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.25.4.tgz", - "integrity": "sha512-6e0cvXwzOnVWJHq+mskP8DNSrKBr1bULBvnFLpc1KY+d+irZSgZ02TGse5FsafKS5jg2e4pbvK6TPXaF/A6+CA==", + "version": "0.27.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.27.2.tgz", + "integrity": "sha512-uwp2Tip5aPmH+NRUwTcfLb+W32WXjpFejTIOWZFw/v7/KnpCDKG66u4DLcurQpiYTiYwQ9B7KOeMJvLCu/OvbA==", "cpu": [ "x64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" @@ -1922,13 +1863,14 @@ } }, "node_modules/@esbuild/netbsd-arm64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.25.4.tgz", - "integrity": "sha512-vUnkBYxZW4hL/ie91hSqaSNjulOnYXE1VSLusnvHg2u3jewJBz3YzB9+oCw8DABeVqZGg94t9tyZFoHma8gWZQ==", + "version": "0.27.2", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.27.2.tgz", + "integrity": "sha512-Kj6DiBlwXrPsCRDeRvGAUb/LNrBASrfqAIok+xB0LxK8CHqxZ037viF13ugfsIpePH93mX7xfJp97cyDuTZ3cw==", "cpu": [ "arm64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "netbsd" @@ -1938,13 +1880,14 @@ } }, "node_modules/@esbuild/netbsd-x64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.25.4.tgz", - "integrity": "sha512-XAg8pIQn5CzhOB8odIcAm42QsOfa98SBeKUdo4xa8OvX8LbMZqEtgeWE9P/Wxt7MlG2QqvjGths+nq48TrUiKw==", + "version": "0.27.2", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.27.2.tgz", + "integrity": "sha512-HwGDZ0VLVBY3Y+Nw0JexZy9o/nUAWq9MlV7cahpaXKW6TOzfVno3y3/M8Ga8u8Yr7GldLOov27xiCnqRZf0tCA==", "cpu": [ "x64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "netbsd" @@ -1954,13 +1897,14 @@ } }, "node_modules/@esbuild/openbsd-arm64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.25.4.tgz", - "integrity": "sha512-Ct2WcFEANlFDtp1nVAXSNBPDxyU+j7+tId//iHXU2f/lN5AmO4zLyhDcpR5Cz1r08mVxzt3Jpyt4PmXQ1O6+7A==", + "version": "0.27.2", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.27.2.tgz", + "integrity": "sha512-DNIHH2BPQ5551A7oSHD0CKbwIA/Ox7+78/AWkbS5QoRzaqlev2uFayfSxq68EkonB+IKjiuxBFoV8ESJy8bOHA==", "cpu": [ "arm64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "openbsd" @@ -1970,13 +1914,14 @@ } }, "node_modules/@esbuild/openbsd-x64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.25.4.tgz", - "integrity": "sha512-xAGGhyOQ9Otm1Xu8NT1ifGLnA6M3sJxZ6ixylb+vIUVzvvd6GOALpwQrYrtlPouMqd/vSbgehz6HaVk4+7Afhw==", + "version": "0.27.2", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.27.2.tgz", + "integrity": "sha512-/it7w9Nb7+0KFIzjalNJVR5bOzA9Vay+yIPLVHfIQYG/j+j9VTH84aNB8ExGKPU4AzfaEvN9/V4HV+F+vo8OEg==", "cpu": [ "x64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "openbsd" @@ -1985,14 +1930,32 @@ "node": ">=18" } }, + "node_modules/@esbuild/openharmony-arm64": { + "version": "0.27.2", + "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.27.2.tgz", + "integrity": "sha512-LRBbCmiU51IXfeXk59csuX/aSaToeG7w48nMwA6049Y4J4+VbWALAuXcs+qcD04rHDuSCSRKdmY63sruDS5qag==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openharmony" + ], + "engines": { + "node": ">=18" + } + }, "node_modules/@esbuild/sunos-x64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.25.4.tgz", - "integrity": "sha512-Mw+tzy4pp6wZEK0+Lwr76pWLjrtjmJyUB23tHKqEDP74R3q95luY/bXqXZeYl4NYlvwOqoRKlInQialgCKy67Q==", + "version": "0.27.2", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.27.2.tgz", + "integrity": "sha512-kMtx1yqJHTmqaqHPAzKCAkDaKsffmXkPHThSfRwZGyuqyIeBvf08KSsYXl+abf5HDAPMJIPnbBfXvP2ZC2TfHg==", "cpu": [ "x64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "sunos" @@ -2002,13 +1965,14 @@ } }, "node_modules/@esbuild/win32-arm64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.25.4.tgz", - "integrity": "sha512-AVUP428VQTSddguz9dO9ngb+E5aScyg7nOeJDrF1HPYu555gmza3bDGMPhmVXL8svDSoqPCsCPjb265yG/kLKQ==", + "version": "0.27.2", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.27.2.tgz", + "integrity": "sha512-Yaf78O/B3Kkh+nKABUF++bvJv5Ijoy9AN1ww904rOXZFLWVc5OLOfL56W+C8F9xn5JQZa3UX6m+IktJnIb1Jjg==", "cpu": [ "arm64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "win32" @@ -2018,13 +1982,14 @@ } }, "node_modules/@esbuild/win32-ia32": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.25.4.tgz", - "integrity": "sha512-i1sW+1i+oWvQzSgfRcxxG2k4I9n3O9NRqy8U+uugaT2Dy7kLO9Y7wI72haOahxceMX8hZAzgGou1FhndRldxRg==", + "version": "0.27.2", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.27.2.tgz", + "integrity": "sha512-Iuws0kxo4yusk7sw70Xa2E2imZU5HoixzxfGCdxwBdhiDgt9vX9VUCBhqcwY7/uh//78A1hMkkROMJq9l27oLQ==", "cpu": [ "ia32" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "win32" @@ -2034,13 +1999,14 @@ } }, "node_modules/@esbuild/win32-x64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.25.4.tgz", - "integrity": "sha512-nOT2vZNw6hJ+z43oP1SPea/G/6AbN6X+bGNhNuq8NtRHy4wsMhw765IKLNmnjek7GvjWBYQ8Q5VBoYTFg9y1UQ==", + "version": "0.27.2", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.27.2.tgz", + "integrity": "sha512-sRdU18mcKf7F+YgheI/zGf5alZatMUTKj/jNS6l744f9u3WFu4v7twcUI9vu4mknF4Y9aDlblIie0IM+5xxaqQ==", "cpu": [ "x64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "win32" @@ -2050,10 +2016,9 @@ } }, "node_modules/@eslint-community/eslint-utils": { - "version": "4.7.0", - "resolved": "https://registry.npmjs.org/@eslint-community/eslint-utils/-/eslint-utils-4.7.0.tgz", - "integrity": "sha512-dyybb3AcajC7uha6CvhdVRJqaKyn7w2YKqKyAN37NKYgZT36w+iRb0Dymmc5qEJ549c/S31cMMSFd75bteCpCw==", + "version": "4.9.1", "dev": true, + "license": "MIT", "dependencies": { "eslint-visitor-keys": "^3.4.3" }, @@ -2068,19 +2033,17 @@ } }, "node_modules/@eslint-community/regexpp": { - "version": "4.12.1", - "resolved": "https://registry.npmjs.org/@eslint-community/regexpp/-/regexpp-4.12.1.tgz", - "integrity": "sha512-CCZCDJuduB9OUkFkY2IgppNZMi2lBQgD2qzwXkEia16cge2pijY/aXi96CJMquDMn3nJdlPV1A5KrJEXwfLNzQ==", + "version": "4.12.2", "dev": true, + "license": "MIT", "engines": { "node": "^12.0.0 || ^14.0.0 || >=16.0.0" } }, "node_modules/@eslint/eslintrc": { "version": "2.1.4", - "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-2.1.4.tgz", - "integrity": "sha512-269Z39MS6wVJtsoUl10L60WdkhJVdPG24Q4eZTH3nnF6lpvSShEK3wQjDX9JRWAUPvPh7COouPpU9IrqaZFvtQ==", "dev": true, + "license": "MIT", "dependencies": { "ajv": "^6.12.4", "debug": "^4.3.2", @@ -2100,35 +2063,18 @@ } }, "node_modules/@eslint/eslintrc/node_modules/brace-expansion": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", - "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "version": "1.1.12", "dev": true, + "license": "MIT", "dependencies": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" } }, - "node_modules/@eslint/eslintrc/node_modules/globals": { - "version": "13.24.0", - "resolved": "https://registry.npmjs.org/globals/-/globals-13.24.0.tgz", - "integrity": "sha512-AhO5QUcj8llrbG09iWhPU2B204J1xnPeL8kQmVorSsy+Sjj1sk8gIyh6cUocGmH4L0UuhAJy+hJMRA4mgA4mFQ==", - "dev": true, - "dependencies": { - "type-fest": "^0.20.2" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/@eslint/eslintrc/node_modules/minimatch": { "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", "dev": true, + "license": "ISC", "dependencies": { "brace-expansion": "^1.1.7" }, @@ -2136,33 +2082,18 @@ "node": "*" } }, - "node_modules/@eslint/eslintrc/node_modules/type-fest": { - "version": "0.20.2", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz", - "integrity": "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==", - "dev": true, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/@eslint/js": { "version": "8.57.1", - "resolved": "https://registry.npmjs.org/@eslint/js/-/js-8.57.1.tgz", - "integrity": "sha512-d9zaMRSTIKDLhctzH12MtXvJKSSUhaHcjV+2Z+GK+EEY7XKpP5yR4x+N3TAcHTcu963nIr+TMcCb4DBCYX1z6Q==", "dev": true, + "license": "MIT", "engines": { "node": "^12.22.0 || ^14.17.0 || >=16.0.0" } }, "node_modules/@humanwhocodes/config-array": { "version": "0.13.0", - "resolved": "https://registry.npmjs.org/@humanwhocodes/config-array/-/config-array-0.13.0.tgz", - "integrity": "sha512-DZLEEqFWQFiyK6h5YIeynKx7JlvCYWL0cImfSRXZ9l4Sg2efkFGTuFf6vzXjK1cq6IYkU+Eg/JizXw+TD2vRNw==", - "deprecated": "Use @eslint/config-array instead", "dev": true, + "license": "Apache-2.0", "dependencies": { "@humanwhocodes/object-schema": "^2.0.3", "debug": "^4.3.1", @@ -2173,10 +2104,9 @@ } }, "node_modules/@humanwhocodes/config-array/node_modules/brace-expansion": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", - "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "version": "1.1.12", "dev": true, + "license": "MIT", "dependencies": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" @@ -2184,9 +2114,8 @@ }, "node_modules/@humanwhocodes/config-array/node_modules/minimatch": { "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", "dev": true, + "license": "ISC", "dependencies": { "brace-expansion": "^1.1.7" }, @@ -2196,9 +2125,8 @@ }, "node_modules/@humanwhocodes/module-importer": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/@humanwhocodes/module-importer/-/module-importer-1.0.1.tgz", - "integrity": "sha512-bxveV4V8v5Yb4ncFTT3rPSgZBOpCkjfK0y4oVVVJwIuDVBRMDXrPyXRL988i5ap9m9bnyEEjWfm5WkBmtffLfA==", "dev": true, + "license": "Apache-2.0", "engines": { "node": ">=12.22" }, @@ -2209,16 +2137,29 @@ }, "node_modules/@humanwhocodes/object-schema": { "version": "2.0.3", - "resolved": "https://registry.npmjs.org/@humanwhocodes/object-schema/-/object-schema-2.0.3.tgz", - "integrity": "sha512-93zYdMES/c1D69yZiKDBj0V24vqNzB/koF26KPaagAfd3P/4gUlh3Dys5ogAK+Exi9QyzlD8x/08Zt7wIKcDcA==", - "deprecated": "Use @eslint/object-schema instead", - "dev": true + "dev": true, + "license": "BSD-3-Clause" + }, + "node_modules/@isaacs/balanced-match": { + "version": "4.0.1", + "license": "MIT", + "engines": { + "node": "20 || >=22" + } + }, + "node_modules/@isaacs/brace-expansion": { + "version": "5.0.1", + "license": "MIT", + "dependencies": { + "@isaacs/balanced-match": "^4.0.1" + }, + "engines": { + "node": "20 || >=22" + } }, "node_modules/@isaacs/cliui": { "version": "8.0.2", - "resolved": "https://registry.npmjs.org/@isaacs/cliui/-/cliui-8.0.2.tgz", - "integrity": "sha512-O8jcjabXaleOG9DQ0+ARXWZBTfnP4WNAqzuiJK7ll44AmxGKv/J2M4TPjxjY3znBCfvBXFzucm1twdyFybFqEA==", - "dev": true, + "license": "ISC", "dependencies": { "string-width": "^5.1.2", "string-width-cjs": "npm:string-width@^4.2.0", @@ -2232,10 +2173,8 @@ } }, "node_modules/@isaacs/cliui/node_modules/ansi-regex": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.1.0.tgz", - "integrity": "sha512-7HSX4QQb4CspciLpVFwyRe79O3xsIZDDLER21kERQ71oaPodF8jL725AgJMFAYbooIqolJoRLuM81SpeUkpkvA==", - "dev": true, + "version": "6.2.2", + "license": "MIT", "engines": { "node": ">=12" }, @@ -2243,11 +2182,19 @@ "url": "https://github.com/chalk/ansi-regex?sponsor=1" } }, + "node_modules/@isaacs/cliui/node_modules/ansi-styles": { + "version": "6.2.3", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, "node_modules/@isaacs/cliui/node_modules/string-width": { "version": "5.1.2", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz", - "integrity": "sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==", - "dev": true, + "license": "MIT", "dependencies": { "eastasianwidth": "^0.2.0", "emoji-regex": "^9.2.2", @@ -2261,10 +2208,8 @@ } }, "node_modules/@isaacs/cliui/node_modules/strip-ansi": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz", - "integrity": "sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==", - "dev": true, + "version": "7.1.2", + "license": "MIT", "dependencies": { "ansi-regex": "^6.0.1" }, @@ -2275,20 +2220,25 @@ "url": "https://github.com/chalk/strip-ansi?sponsor=1" } }, - "node_modules/@istanbuljs/schema": { - "version": "0.1.3", - "resolved": "https://registry.npmjs.org/@istanbuljs/schema/-/schema-0.1.3.tgz", - "integrity": "sha512-ZXRY4jNvVgSVQ8DL3LTcakaAtXwTVUxE81hslsyD2AtoXW/wVob10HkOJ1X/pAlcI7D+2YoZKg5do8G/w6RYgA==", - "dev": true, + "node_modules/@isaacs/cliui/node_modules/wrap-ansi": { + "version": "8.1.0", + "license": "MIT", + "dependencies": { + "ansi-styles": "^6.1.0", + "string-width": "^5.0.1", + "strip-ansi": "^7.0.1" + }, "engines": { - "node": ">=8" + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/wrap-ansi?sponsor=1" } }, "node_modules/@jest/types": { "version": "26.6.2", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-26.6.2.tgz", - "integrity": "sha512-fC6QCp7Sc5sX6g8Tvbmj4XUTbyrik0akgRy03yjXbQaBWWNWGE7SGtJk98m0N8nzegD/7SggrUlivxo5ax4KWQ==", "dev": true, + "license": "MIT", "dependencies": { "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", @@ -2301,62 +2251,109 @@ } }, "node_modules/@jridgewell/gen-mapping": { - "version": "0.3.8", - "resolved": "https://registry.npmjs.org/@jridgewell/gen-mapping/-/gen-mapping-0.3.8.tgz", - "integrity": "sha512-imAbBGkb+ebQyxKgzv5Hu2nmROxoDOXHh80evxdoXNOrvAnVx7zimzc1Oo5h9RlfV4vPXaE2iM5pOFbvOCClWA==", + "version": "0.3.13", + "license": "MIT", "dependencies": { - "@jridgewell/set-array": "^1.2.1", - "@jridgewell/sourcemap-codec": "^1.4.10", + "@jridgewell/sourcemap-codec": "^1.5.0", + "@jridgewell/trace-mapping": "^0.3.24" + } + }, + "node_modules/@jridgewell/remapping": { + "version": "2.3.5", + "license": "MIT", + "dependencies": { + "@jridgewell/gen-mapping": "^0.3.5", "@jridgewell/trace-mapping": "^0.3.24" - }, - "engines": { - "node": ">=6.0.0" } }, "node_modules/@jridgewell/resolve-uri": { "version": "3.1.2", - "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz", - "integrity": "sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw==", - "engines": { - "node": ">=6.0.0" - } - }, - "node_modules/@jridgewell/set-array": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/@jridgewell/set-array/-/set-array-1.2.1.tgz", - "integrity": "sha512-R8gLRTZeyp03ymzP/6Lil/28tGeGEzhx1q2k703KGWRAI1VdvPIXdG70VJc2pAMw3NA6JKL5hhFu1sJX0Mnn/A==", + "license": "MIT", "engines": { "node": ">=6.0.0" } }, "node_modules/@jridgewell/source-map": { - "version": "0.3.6", - "resolved": "https://registry.npmjs.org/@jridgewell/source-map/-/source-map-0.3.6.tgz", - "integrity": "sha512-1ZJTZebgqllO79ue2bm3rIGud/bOe0pP5BjSRCRxxYkEZS8STV7zN84UBbiYu7jy+eCKSnVIUgoWWE/tt+shMQ==", + "version": "0.3.11", + "license": "MIT", "dependencies": { "@jridgewell/gen-mapping": "^0.3.5", "@jridgewell/trace-mapping": "^0.3.25" } }, "node_modules/@jridgewell/sourcemap-codec": { - "version": "1.5.0", - "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.0.tgz", - "integrity": "sha512-gv3ZRaISU3fjPAgNsriBRqGWQL6quFx04YMPW/zD8XMLsU32mhCCbfbO6KZFLjvYpCZ8zyDEgqsgf+PwPaM7GQ==" + "version": "1.5.5", + "license": "MIT" }, "node_modules/@jridgewell/trace-mapping": { - "version": "0.3.25", - "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.25.tgz", - "integrity": "sha512-vNk6aEwybGtawWmy/PzwnGDOjCkLWSD2wqvjGGAgOAwCGWySYXfYoxt00IJkTF+8Lb57DwOb3Aa0o9CApepiYQ==", + "version": "0.3.31", + "license": "MIT", "dependencies": { "@jridgewell/resolve-uri": "^3.1.0", "@jridgewell/sourcemap-codec": "^1.4.14" } }, + "node_modules/@jsonforms/core": { + "version": "2.5.2", + "license": "MIT", + "peer": true, + "dependencies": { + "@types/json-schema": "^7.0.3", + "ajv": "^6.10.2", + "json-schema-ref-parser": "7.1.3", + "lodash": "^4.17.15", + "uri-js": "^4.2.2", + "uuid": "^3.3.3" + } + }, + "node_modules/@jsonforms/core/node_modules/uuid": { + "version": "3.4.0", + "license": "MIT", + "bin": { + "uuid": "bin/uuid" + } + }, + "node_modules/@jsonforms/material-renderers": { + "version": "2.5.2", + "license": "MIT", + "dependencies": { + "@date-io/moment": "1.3.11", + "@material-ui/pickers": "^3.2.8", + "@types/uuid": "^3.4.6", + "moment": "^2.24.0", + "uuid": "^3.3.3" + }, + "peerDependencies": { + "@jsonforms/core": "^2.5.2", + "@jsonforms/react": "^2.5.2", + "@material-ui/core": "^4.7.0", + "@material-ui/icons": "^4.5.1" + } + }, + "node_modules/@jsonforms/material-renderers/node_modules/uuid": { + "version": "3.4.0", + "license": "MIT", + "bin": { + "uuid": "bin/uuid" + } + }, + "node_modules/@jsonforms/react": { + "version": "2.5.2", + "license": "MIT", + "peer": true, + "dependencies": { + "lodash": "^4.17.15", + "object-hash": "^2.0.0" + }, + "peerDependencies": { + "@jsonforms/core": "^2.5.2", + "react": "^16.12.0 || ^17.0.0" + } + }, "node_modules/@material-ui/core": { "version": "4.12.4", - "resolved": "https://registry.npmjs.org/@material-ui/core/-/core-4.12.4.tgz", - "integrity": "sha512-tr7xekNlM9LjA6pagJmL8QCgZXaubWUwkJnoYcMKd4gw/t4XiyvnTkjdGrUVicyB2BsdaAv1tvow45bPM4sSwQ==", - "deprecated": "Material UI v4 doesn't receive active development since September 2021. See the guide https://mui.com/material-ui/migration/migration-v4/ to upgrade to v5.", + "license": "MIT", + "peer": true, "dependencies": { "@babel/runtime": "^7.4.4", "@material-ui/styles": "^4.11.5", @@ -2391,16 +2388,15 @@ }, "node_modules/@material-ui/core/node_modules/clsx": { "version": "1.2.1", - "resolved": "https://registry.npmjs.org/clsx/-/clsx-1.2.1.tgz", - "integrity": "sha512-EcR6r5a8bj6pu3ycsa/E/cKVGuTgZJZdsyUYHOksG/UHIiKfjxzRxYJpyVBwYaQeOvghal9fcc4PidlgzugAQg==", + "license": "MIT", "engines": { "node": ">=6" } }, "node_modules/@material-ui/icons": { "version": "4.11.3", - "resolved": "https://registry.npmjs.org/@material-ui/icons/-/icons-4.11.3.tgz", - "integrity": "sha512-IKHlyx6LDh8n19vzwH5RtHIOHl9Tu90aAAxcbWME6kp4dmvODM3UvOHJeMIDzUbd4muuJKHmlNoBN+mDY4XkBA==", + "license": "MIT", + "peer": true, "dependencies": { "@babel/runtime": "^7.4.4" }, @@ -2421,9 +2417,7 @@ }, "node_modules/@material-ui/lab": { "version": "4.0.0-alpha.61", - "resolved": "https://registry.npmjs.org/@material-ui/lab/-/lab-4.0.0-alpha.61.tgz", - "integrity": "sha512-rSzm+XKiNUjKegj8bzt5+pygZeckNLOr+IjykH8sYdVk7dE9y2ZuUSofiMV2bJk3qU+JHwexmw+q0RyNZB9ugg==", - "deprecated": "Material UI v4 doesn't receive active development since September 2021. See the guide https://mui.com/material-ui/migration/migration-v4/ to upgrade to v5.", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.4.4", "@material-ui/utils": "^4.11.3", @@ -2448,17 +2442,40 @@ }, "node_modules/@material-ui/lab/node_modules/clsx": { "version": "1.2.1", - "resolved": "https://registry.npmjs.org/clsx/-/clsx-1.2.1.tgz", - "integrity": "sha512-EcR6r5a8bj6pu3ycsa/E/cKVGuTgZJZdsyUYHOksG/UHIiKfjxzRxYJpyVBwYaQeOvghal9fcc4PidlgzugAQg==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/@material-ui/pickers": { + "version": "3.3.11", + "license": "MIT", + "dependencies": { + "@babel/runtime": "^7.6.0", + "@date-io/core": "1.x", + "@types/styled-jsx": "^2.2.8", + "clsx": "^1.0.2", + "react-transition-group": "^4.0.0", + "rifm": "^0.7.0" + }, + "peerDependencies": { + "@date-io/core": "^1.3.6", + "@material-ui/core": "^4.0.0", + "prop-types": "^15.6.0", + "react": "^16.8.0 || ^17.0.0", + "react-dom": "^16.8.0 || ^17.0.0" + } + }, + "node_modules/@material-ui/pickers/node_modules/clsx": { + "version": "1.2.1", + "license": "MIT", "engines": { "node": ">=6" } }, "node_modules/@material-ui/styles": { "version": "4.11.5", - "resolved": "https://registry.npmjs.org/@material-ui/styles/-/styles-4.11.5.tgz", - "integrity": "sha512-o/41ot5JJiUsIETME9wVLAJrmIWL3j0R0Bj2kCOLbSfqEkKf0fmaPt+5vtblUh5eXr2S+J/8J3DaCb10+CzPGA==", - "deprecated": "Material UI v4 doesn't receive active development since September 2021. See the guide https://mui.com/material-ui/migration/migration-v4/ to upgrade to v5.", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.4.4", "@emotion/hash": "^0.8.0", @@ -2497,16 +2514,14 @@ }, "node_modules/@material-ui/styles/node_modules/clsx": { "version": "1.2.1", - "resolved": "https://registry.npmjs.org/clsx/-/clsx-1.2.1.tgz", - "integrity": "sha512-EcR6r5a8bj6pu3ycsa/E/cKVGuTgZJZdsyUYHOksG/UHIiKfjxzRxYJpyVBwYaQeOvghal9fcc4PidlgzugAQg==", + "license": "MIT", "engines": { "node": ">=6" } }, "node_modules/@material-ui/system": { "version": "4.12.2", - "resolved": "https://registry.npmjs.org/@material-ui/system/-/system-4.12.2.tgz", - "integrity": "sha512-6CSKu2MtmiJgcCGf6nBQpM8fLkuB9F55EKfbdTC80NND5wpTmKzwdhLYLH3zL4cLlK0gVaaltW7/wMuyTnN0Lw==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.4.4", "@material-ui/utils": "^4.11.3", @@ -2533,8 +2548,7 @@ }, "node_modules/@material-ui/types": { "version": "5.1.0", - "resolved": "https://registry.npmjs.org/@material-ui/types/-/types-5.1.0.tgz", - "integrity": "sha512-7cqRjrY50b8QzRSYyhSpx4WRw2YuO0KKIGQEVk5J8uoz2BanawykgZGoWEqKm7pVIbzFDN0SpPcVV4IhOFkl8A==", + "license": "MIT", "peerDependencies": { "@types/react": "*" }, @@ -2546,8 +2560,7 @@ }, "node_modules/@material-ui/utils": { "version": "4.11.3", - "resolved": "https://registry.npmjs.org/@material-ui/utils/-/utils-4.11.3.tgz", - "integrity": "sha512-ZuQPV4rBK/V1j2dIkSSEcH5uT6AaHuKWFfotADHsC0wVL1NLd2WkFCm4ZZbX33iO4ydl6V0GPngKm8HZQ2oujg==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.4.4", "prop-types": "^15.7.2", @@ -2563,9 +2576,8 @@ }, "node_modules/@nodelib/fs.scandir": { "version": "2.1.5", - "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", - "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", "dev": true, + "license": "MIT", "dependencies": { "@nodelib/fs.stat": "2.0.5", "run-parallel": "^1.1.9" @@ -2576,18 +2588,16 @@ }, "node_modules/@nodelib/fs.stat": { "version": "2.0.5", - "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", - "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", "dev": true, + "license": "MIT", "engines": { "node": ">= 8" } }, "node_modules/@nodelib/fs.walk": { "version": "1.2.8", - "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", - "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", "dev": true, + "license": "MIT", "dependencies": { "@nodelib/fs.scandir": "2.1.5", "fastq": "^1.6.0" @@ -2596,50 +2606,70 @@ "node": ">= 8" } }, - "node_modules/@pkgjs/parseargs": { - "version": "0.11.0", - "resolved": "https://registry.npmjs.org/@pkgjs/parseargs/-/parseargs-0.11.0.tgz", - "integrity": "sha512-+1VkjdD0QBLPodGrJUeqarH8VAIvQODIbwh9XpP5Syisf7YoQgsJKPNFoqqLQlu+VQ/tVSshMR6loPMn8U+dPg==", - "dev": true, - "optional": true, + "node_modules/@pnpm/config.env-replace": { + "version": "1.1.0", + "license": "MIT", "engines": { - "node": ">=14" + "node": ">=12.22.0" + } + }, + "node_modules/@pnpm/network.ca-file": { + "version": "1.0.2", + "license": "MIT", + "dependencies": { + "graceful-fs": "4.2.10" + }, + "engines": { + "node": ">=12.22.0" + } + }, + "node_modules/@pnpm/network.ca-file/node_modules/graceful-fs": { + "version": "4.2.10", + "license": "ISC" + }, + "node_modules/@pnpm/npm-conf": { + "version": "3.0.2", + "license": "MIT", + "dependencies": { + "@pnpm/config.env-replace": "^1.1.0", + "@pnpm/network.ca-file": "^1.0.1", + "config-chain": "^1.1.11" + }, + "engines": { + "node": ">=12" } }, "node_modules/@react-dnd/asap": { "version": "4.0.1", - "resolved": "https://registry.npmjs.org/@react-dnd/asap/-/asap-4.0.1.tgz", - "integrity": "sha512-kLy0PJDDwvwwTXxqTFNAAllPHD73AycE9ypWeln/IguoGBEbvFcPDbCV03G52bEcC5E+YgupBE0VzHGdC8SIXg==" + "license": "MIT" }, "node_modules/@react-dnd/invariant": { "version": "2.0.0", - "resolved": "https://registry.npmjs.org/@react-dnd/invariant/-/invariant-2.0.0.tgz", - "integrity": "sha512-xL4RCQBCBDJ+GRwKTFhGUW8GXa4yoDfJrPbLblc3U09ciS+9ZJXJ3Qrcs/x2IODOdIE5kQxvMmE2UKyqUictUw==" + "license": "MIT" }, "node_modules/@react-dnd/shallowequal": { "version": "2.0.0", - "resolved": "https://registry.npmjs.org/@react-dnd/shallowequal/-/shallowequal-2.0.0.tgz", - "integrity": "sha512-Pc/AFTdwZwEKJxFJvlxrSmGe/di+aAOBn60sremrpLo6VI/6cmiUYNNwlI5KNYttg7uypzA3ILPMPgxB2GYZEg==" + "license": "MIT" }, "node_modules/@react-icons/all-files": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/@react-icons/all-files/-/all-files-4.1.0.tgz", "integrity": "sha512-hxBI2UOuVaI3O/BhQfhtb4kcGn9ft12RWAFVMUeNjqqhLsHvFtzIkFaptBJpFDANTKoDfdVoHTKZDlwKCACbMQ==", + "license": "MIT", "peerDependencies": { "react": "*" } }, "node_modules/@redux-saga/core": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/@redux-saga/core/-/core-1.3.0.tgz", - "integrity": "sha512-L+i+qIGuyWn7CIg7k1MteHGfttKPmxwZR5E7OsGikCL2LzYA0RERlaUY00Y3P3ZV2EYgrsYlBrGs6cJP5OKKqA==", + "version": "1.4.2", + "license": "MIT", "dependencies": { - "@babel/runtime": "^7.6.3", - "@redux-saga/deferred": "^1.2.1", - "@redux-saga/delay-p": "^1.2.1", - "@redux-saga/is": "^1.1.3", - "@redux-saga/symbols": "^1.1.3", - "@redux-saga/types": "^1.2.1", + "@babel/runtime": "^7.28.4", + "@redux-saga/deferred": "^1.3.1", + "@redux-saga/delay-p": "^1.3.1", + "@redux-saga/is": "^1.2.1", + "@redux-saga/symbols": "^1.2.1", + "@redux-saga/types": "^1.3.1", "typescript-tuple": "^2.2.1" }, "funding": { @@ -2648,47 +2678,40 @@ } }, "node_modules/@redux-saga/deferred": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/@redux-saga/deferred/-/deferred-1.2.1.tgz", - "integrity": "sha512-cmin3IuuzMdfQjA0lG4B+jX+9HdTgHZZ+6u3jRAOwGUxy77GSlTi4Qp2d6PM1PUoTmQUR5aijlA39scWWPF31g==" + "version": "1.3.1", + "license": "MIT" }, "node_modules/@redux-saga/delay-p": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/@redux-saga/delay-p/-/delay-p-1.2.1.tgz", - "integrity": "sha512-MdiDxZdvb1m+Y0s4/hgdcAXntpUytr9g0hpcOO1XFVyyzkrDu3SKPgBFOtHn7lhu7n24ZKIAT1qtKyQjHqRd+w==", + "version": "1.3.1", + "license": "MIT", "dependencies": { - "@redux-saga/symbols": "^1.1.3" + "@redux-saga/symbols": "^1.2.1" } }, "node_modules/@redux-saga/is": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/@redux-saga/is/-/is-1.1.3.tgz", - "integrity": "sha512-naXrkETG1jLRfVfhOx/ZdLj0EyAzHYbgJWkXbB3qFliPcHKiWbv/ULQryOAEKyjrhiclmr6AMdgsXFyx7/yE6Q==", + "version": "1.2.1", + "license": "MIT", "dependencies": { - "@redux-saga/symbols": "^1.1.3", - "@redux-saga/types": "^1.2.1" + "@redux-saga/symbols": "^1.2.1", + "@redux-saga/types": "^1.3.1" } }, "node_modules/@redux-saga/symbols": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/@redux-saga/symbols/-/symbols-1.1.3.tgz", - "integrity": "sha512-hCx6ZvU4QAEUojETnX8EVg4ubNLBFl1Lps4j2tX7o45x/2qg37m3c6v+kSp8xjDJY+2tJw4QB3j8o8dsl1FDXg==" + "version": "1.2.1", + "license": "MIT" }, "node_modules/@redux-saga/types": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/@redux-saga/types/-/types-1.2.1.tgz", - "integrity": "sha512-1dgmkh+3so0+LlBWRhGA33ua4MYr7tUOj+a9Si28vUi0IUFNbff1T3sgpeDJI/LaC75bBYnQ0A3wXjn0OrRNBA==" + "version": "1.3.1", + "license": "MIT" }, "node_modules/@rolldown/pluginutils": { - "version": "1.0.0-beta.9", - "resolved": "https://registry.npmjs.org/@rolldown/pluginutils/-/pluginutils-1.0.0-beta.9.tgz", - "integrity": "sha512-e9MeMtVWo186sgvFFJOPGy7/d2j2mZhLJIdVW0C/xDluuOvymEATqz6zKsP0ZmXGzQtqlyjz5sC1sYQUoJG98w==", - "dev": true + "version": "1.0.0-beta.53", + "dev": true, + "license": "MIT" }, "node_modules/@rollup/plugin-node-resolve": { "version": "15.3.1", - "resolved": "https://registry.npmjs.org/@rollup/plugin-node-resolve/-/plugin-node-resolve-15.3.1.tgz", - "integrity": "sha512-tgg6b91pAybXHJQMAAwW9VuWBO6Thi+q7BCNARLwSqlmsHz0XYURtGvh/AuwSADXSI4h/2uHbs7s4FzlZDGSGA==", + "license": "MIT", "dependencies": { "@rollup/pluginutils": "^5.0.1", "@types/resolve": "1.20.2", @@ -2709,11 +2732,10 @@ } }, "node_modules/@rollup/plugin-node-resolve/node_modules/resolve": { - "version": "1.22.10", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.10.tgz", - "integrity": "sha512-NPRy+/ncIMeDlTAsuqwKIiferiawhefFJtkNSW0qZJEqMEb+qBt/77B/jGeeek+F0uOeN05CDa6HXbbIgtVX4w==", + "version": "1.22.11", + "license": "MIT", "dependencies": { - "is-core-module": "^2.16.0", + "is-core-module": "^2.16.1", "path-parse": "^1.0.7", "supports-preserve-symlinks-flag": "^1.0.0" }, @@ -2729,8 +2751,7 @@ }, "node_modules/@rollup/plugin-terser": { "version": "0.4.4", - "resolved": "https://registry.npmjs.org/@rollup/plugin-terser/-/plugin-terser-0.4.4.tgz", - "integrity": "sha512-XHeJC5Bgvs8LfukDwWZp7yeqin6ns8RTl2B9avbejt6tZqsqvVoWI7ZTQrcNsfKEDWBTnTxM8nMDkO2IFFbd0A==", + "license": "MIT", "dependencies": { "serialize-javascript": "^6.0.1", "smob": "^1.0.0", @@ -2749,9 +2770,8 @@ } }, "node_modules/@rollup/pluginutils": { - "version": "5.1.4", - "resolved": "https://registry.npmjs.org/@rollup/pluginutils/-/pluginutils-5.1.4.tgz", - "integrity": "sha512-USm05zrsFxYLPdWWq+K3STlWiT/3ELn3RcV5hJMghpeAIhxfsUIg6mt12CBJBInWMV4VneoV7SfGv8xIwo2qNQ==", + "version": "5.3.0", + "license": "MIT", "dependencies": { "@types/estree": "^1.0.0", "estree-walker": "^2.0.2", @@ -2771,13 +2791,11 @@ }, "node_modules/@rollup/pluginutils/node_modules/estree-walker": { "version": "2.0.2", - "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-2.0.2.tgz", - "integrity": "sha512-Rfkk/Mp/DL7JVje3u18FxFujQlTNR2q6QfMSMB7AvCBx91NGj/ba3kCfza0f6dVDbw7YlRf/nDrn7pQrCCyQ/w==" + "license": "MIT" }, "node_modules/@rollup/pluginutils/node_modules/picomatch": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.2.tgz", - "integrity": "sha512-M7BAV6Rlcy5u+m6oPhAPFgJTzAioX/6B0DxyvDlo9l8+T3nLKbrczg2WLUyzd45L8RqfUMyGPzekbMvX2Ldkwg==", + "version": "4.0.3", + "license": "MIT", "engines": { "node": ">=12" }, @@ -2785,18 +2803,14 @@ "url": "https://github.com/sponsors/jonschlinkert" } }, - "node_modules/@sindresorhus/is": { - "version": "0.14.0", - "resolved": "https://registry.npmjs.org/@sindresorhus/is/-/is-0.14.0.tgz", - "integrity": "sha512-9NET910DNaIPngYnLLPeg+Ogzqsi9uM4mSboU5y6p8S5DzMTVEsJZrawi+BoDNUVBa2DhJqQYUFvMDfgU062LQ==", - "engines": { - "node": ">=6" - } + "node_modules/@standard-schema/spec": { + "version": "1.1.0", + "dev": true, + "license": "MIT" }, "node_modules/@surma/rollup-plugin-off-main-thread": { "version": "2.2.3", - "resolved": "https://registry.npmjs.org/@surma/rollup-plugin-off-main-thread/-/rollup-plugin-off-main-thread-2.2.3.tgz", - "integrity": "sha512-lR8q/9W7hZpMWweNiAKU7NQerBnzQQLvi8qnTDU/fxItPhtZVMbPV3lbCwjhIlNBe9Bbr5V+KHshvWmVSG9cxQ==", + "license": "Apache-2.0", "dependencies": { "ejs": "^3.1.6", "json5": "^2.2.0", @@ -2806,37 +2820,24 @@ }, "node_modules/@surma/rollup-plugin-off-main-thread/node_modules/magic-string": { "version": "0.25.9", - "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.25.9.tgz", - "integrity": "sha512-RmF0AsMzgt25qzqqLc1+MbHmhdx0ojF2Fvs4XnOqz2ZOBXzzkEwc/dJQZCYHAn7v1jbVOjAZfK8msRn4BxO4VQ==", + "license": "MIT", "dependencies": { "sourcemap-codec": "^1.4.8" } }, - "node_modules/@szmarczak/http-timer": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/@szmarczak/http-timer/-/http-timer-1.1.2.tgz", - "integrity": "sha512-XIB2XbzHTN6ieIjfIMV9hlVcfPU26s2vafYWQcZHWXHOxiaRZYEDKEwdl129Zyg50+foYV2jCgtrqSA6qNuNSA==", - "dependencies": { - "defer-to-connect": "^1.0.1" - }, - "engines": { - "node": ">=6" - } - }, "node_modules/@testing-library/dom": { - "version": "10.4.0", - "resolved": "https://registry.npmjs.org/@testing-library/dom/-/dom-10.4.0.tgz", - "integrity": "sha512-pemlzrSESWbdAloYml3bAJMEfNh1Z7EduzqPKprCH5S341frlpYnUEW0H72dLxa6IsYr+mPno20GiSm+h9dEdQ==", + "version": "10.4.1", "dev": true, + "license": "MIT", "peer": true, "dependencies": { "@babel/code-frame": "^7.10.4", "@babel/runtime": "^7.12.5", "@types/aria-query": "^5.0.1", "aria-query": "5.3.0", - "chalk": "^4.1.0", "dom-accessibility-api": "^0.5.9", "lz-string": "^1.5.0", + "picocolors": "1.1.1", "pretty-format": "^27.0.2" }, "engines": { @@ -2844,17 +2845,15 @@ } }, "node_modules/@testing-library/jest-dom": { - "version": "6.6.3", - "resolved": "https://registry.npmjs.org/@testing-library/jest-dom/-/jest-dom-6.6.3.tgz", - "integrity": "sha512-IteBhl4XqYNkM54f4ejhLRJiZNqcSCoXUOG2CPK7qbD322KjQozM4kHQOfkG2oln9b9HTYqs+Sae8vBATubxxA==", + "version": "6.9.1", "dev": true, + "license": "MIT", "dependencies": { "@adobe/css-tools": "^4.4.0", "aria-query": "^5.0.0", - "chalk": "^3.0.0", "css.escape": "^1.5.1", "dom-accessibility-api": "^0.6.3", - "lodash": "^4.17.21", + "picocolors": "^1.1.1", "redent": "^3.0.0" }, "engines": { @@ -2863,30 +2862,15 @@ "yarn": ">=1" } }, - "node_modules/@testing-library/jest-dom/node_modules/chalk": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz", - "integrity": "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg==", - "dev": true, - "dependencies": { - "ansi-styles": "^4.1.0", - "supports-color": "^7.1.0" - }, - "engines": { - "node": ">=8" - } - }, "node_modules/@testing-library/jest-dom/node_modules/dom-accessibility-api": { "version": "0.6.3", - "resolved": "https://registry.npmjs.org/dom-accessibility-api/-/dom-accessibility-api-0.6.3.tgz", - "integrity": "sha512-7ZgogeTnjuHbo+ct10G9Ffp0mif17idi0IyWNVA/wcwcm7NPOD/WEHVP3n7n3MhXqxoIYm8d6MuZohYWIZ4T3w==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/@testing-library/react": { "version": "12.1.5", - "resolved": "https://registry.npmjs.org/@testing-library/react/-/react-12.1.5.tgz", - "integrity": "sha512-OfTXCJUFgjd/digLUuPxa0+/3ZxsQmE7ub9kcbW/wi96Bh3o/p5vrETcBGfP17NWPGqeYYl5LTRpwyGoMC4ysg==", "dev": true, + "license": "MIT", "dependencies": { "@babel/runtime": "^7.12.5", "@testing-library/dom": "^8.0.0", @@ -2902,9 +2886,8 @@ }, "node_modules/@testing-library/react-hooks": { "version": "7.0.2", - "resolved": "https://registry.npmjs.org/@testing-library/react-hooks/-/react-hooks-7.0.2.tgz", - "integrity": "sha512-dYxpz8u9m4q1TuzfcUApqi8iFfR6R0FaMbr2hjZJy1uC8z+bO/K4v8Gs9eogGKYQop7QsrBTFkv/BCF7MzD2Cg==", "dev": true, + "license": "MIT", "dependencies": { "@babel/runtime": "^7.12.5", "@types/react": ">=16.9.0", @@ -2931,9 +2914,8 @@ }, "node_modules/@testing-library/react/node_modules/@testing-library/dom": { "version": "8.20.1", - "resolved": "https://registry.npmjs.org/@testing-library/dom/-/dom-8.20.1.tgz", - "integrity": "sha512-/DiOQ5xBxgdYRC8LNk7U+RWat0S3qRLeIw3ZIkMQ9kkVlRmwD/Eg8k8CqIpD6GW7u20JIUOfMKbxtiLutpjQ4g==", "dev": true, + "license": "MIT", "dependencies": { "@babel/code-frame": "^7.10.4", "@babel/runtime": "^7.12.5", @@ -2950,18 +2932,16 @@ }, "node_modules/@testing-library/react/node_modules/aria-query": { "version": "5.1.3", - "resolved": "https://registry.npmjs.org/aria-query/-/aria-query-5.1.3.tgz", - "integrity": "sha512-R5iJ5lkuHybztUfuOAznmboyjWq8O6sqNqtK7CLOqdydi54VNbORp49mb14KbWgG1QD3JFO9hJdZ+y4KutfdOQ==", "dev": true, + "license": "Apache-2.0", "dependencies": { "deep-equal": "^2.0.5" } }, "node_modules/@testing-library/user-event": { "version": "14.6.1", - "resolved": "https://registry.npmjs.org/@testing-library/user-event/-/user-event-14.6.1.tgz", - "integrity": "sha512-vq7fv0rnt+QTXgPxr5Hjc210p6YKq2kmdziLgnsZGgLJ9e6VAShx1pACLuRjd/AS/sr7phAR58OIIpf0LlmQNw==", "dev": true, + "license": "MIT", "engines": { "node": ">=12", "npm": ">=6" @@ -2972,15 +2952,13 @@ }, "node_modules/@types/aria-query": { "version": "5.0.4", - "resolved": "https://registry.npmjs.org/@types/aria-query/-/aria-query-5.0.4.tgz", - "integrity": "sha512-rfT93uj5s0PRL7EzccGMs3brplhcrghnDoV26NqKhCAS1hVo+WdNsPvE/yb6ilfr5hi2MEk6d5EWJTKdxg8jVw==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/@types/babel__core": { "version": "7.20.5", - "resolved": "https://registry.npmjs.org/@types/babel__core/-/babel__core-7.20.5.tgz", - "integrity": "sha512-qoQprZvz5wQFJwMDqeseRXWv3rqMvhgpbXFfVyWhbx9X47POIA6i/+dXefEmZKoAgOaTdaIgNSMqMIU61yRyzA==", "devOptional": true, + "license": "MIT", "dependencies": { "@babel/parser": "^7.20.7", "@babel/types": "^7.20.7", @@ -2991,123 +2969,125 @@ }, "node_modules/@types/babel__generator": { "version": "7.27.0", - "resolved": "https://registry.npmjs.org/@types/babel__generator/-/babel__generator-7.27.0.tgz", - "integrity": "sha512-ufFd2Xi92OAVPYsy+P4n7/U7e68fex0+Ee8gSG9KX7eo084CWiQ4sdxktvdl0bOPupXtVJPY19zk6EwWqUQ8lg==", "devOptional": true, + "license": "MIT", "dependencies": { "@babel/types": "^7.0.0" } }, "node_modules/@types/babel__template": { "version": "7.4.4", - "resolved": "https://registry.npmjs.org/@types/babel__template/-/babel__template-7.4.4.tgz", - "integrity": "sha512-h/NUaSyG5EyxBIp8YRxo4RMe2/qQgvyowRwVMzhYhBCONbW8PUsg4lkFMrhgZhUe5z3L3MiLDuvyJ/CaPa2A8A==", "devOptional": true, + "license": "MIT", "dependencies": { "@babel/parser": "^7.1.0", "@babel/types": "^7.0.0" } }, "node_modules/@types/babel__traverse": { - "version": "7.20.7", - "resolved": "https://registry.npmjs.org/@types/babel__traverse/-/babel__traverse-7.20.7.tgz", - "integrity": "sha512-dkO5fhS7+/oos4ciWxyEyjWe48zmG6wbCheo/G2ZnHx4fs3EU6YC6UM8rk56gAjNJ9P3MTH2jo5jb92/K6wbng==", + "version": "7.28.0", "devOptional": true, + "license": "MIT", "dependencies": { - "@babel/types": "^7.20.7" + "@babel/types": "^7.28.2" } }, + "node_modules/@types/chai": { + "version": "5.2.3", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/deep-eql": "*", + "assertion-error": "^2.0.1" + } + }, + "node_modules/@types/deep-eql": { + "version": "4.0.2", + "dev": true, + "license": "MIT" + }, "node_modules/@types/estree": { - "version": "1.0.7", - "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.7.tgz", - "integrity": "sha512-w28IoSUCJpidD/TGviZwwMJckNESJZXFu7NBZ5YJ4mEUnNraUn9Pm8HSZm/jDF1pDWYKspWE7oVphigUPRakIQ==" + "version": "1.0.8", + "license": "MIT" }, "node_modules/@types/hoist-non-react-statics": { - "version": "3.3.6", - "resolved": "https://registry.npmjs.org/@types/hoist-non-react-statics/-/hoist-non-react-statics-3.3.6.tgz", - "integrity": "sha512-lPByRJUer/iN/xa4qpyL0qmL11DqNW81iU/IG1S3uvRUq4oKagz8VCxZjiWkumgt66YT3vOdDgZ0o32sGKtCEw==", + "version": "3.3.7", + "license": "MIT", + "peer": true, "dependencies": { - "@types/react": "*", "hoist-non-react-statics": "^3.3.0" + }, + "peerDependencies": { + "@types/react": "*" } }, "node_modules/@types/istanbul-lib-coverage": { "version": "2.0.6", - "resolved": "https://registry.npmjs.org/@types/istanbul-lib-coverage/-/istanbul-lib-coverage-2.0.6.tgz", - "integrity": "sha512-2QF/t/auWm0lsy8XtKVPG19v3sSOQlJe/YHZgfjb/KBBHOGSV+J2q/S671rcq9uTBrLAXmZpqJiaQbMT+zNU1w==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/@types/istanbul-lib-report": { "version": "3.0.3", - "resolved": "https://registry.npmjs.org/@types/istanbul-lib-report/-/istanbul-lib-report-3.0.3.tgz", - "integrity": "sha512-NQn7AHQnk/RSLOxrBbGyJM/aVQ+pjj5HCgasFxc0K/KhoATfQ/47AyUl15I2yBUpihjmas+a+VJBOqecrFH+uA==", "dev": true, + "license": "MIT", "dependencies": { "@types/istanbul-lib-coverage": "*" } }, "node_modules/@types/istanbul-reports": { "version": "3.0.4", - "resolved": "https://registry.npmjs.org/@types/istanbul-reports/-/istanbul-reports-3.0.4.tgz", - "integrity": "sha512-pk2B1NWalF9toCRu6gjBzR69syFjP4Od8WRAX+0mmf9lAjCRicLOWc+ZrxZHx/0XRjotgkF9t6iaMJ+aXcOdZQ==", "dev": true, + "license": "MIT", "dependencies": { "@types/istanbul-lib-report": "*" } }, "node_modules/@types/json-schema": { "version": "7.0.15", - "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", - "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==", - "dev": true + "license": "MIT" }, "node_modules/@types/minimist": { "version": "1.2.5", - "resolved": "https://registry.npmjs.org/@types/minimist/-/minimist-1.2.5.tgz", - "integrity": "sha512-hov8bUuiLiyFPGyFPE1lwWhmzYbirOXQNNo40+y3zow8aFVTeyn3VWL0VFFfdNddA8S4Vf0Tc062rzyNr7Paag==" + "license": "MIT" }, "node_modules/@types/node": { - "version": "22.15.21", - "resolved": "https://registry.npmjs.org/@types/node/-/node-22.15.21.tgz", - "integrity": "sha512-EV/37Td6c+MgKAbkcLG6vqZ2zEYHD7bvSrzqqs2RIhbA6w3x+Dqz8MZM3sP6kGTeLrdoOgKZe+Xja7tUB2DNkQ==", + "version": "24.10.9", "devOptional": true, + "license": "MIT", + "peer": true, "dependencies": { - "undici-types": "~6.21.0" + "undici-types": "~7.16.0" } }, "node_modules/@types/normalize-package-data": { "version": "2.4.4", - "resolved": "https://registry.npmjs.org/@types/normalize-package-data/-/normalize-package-data-2.4.4.tgz", - "integrity": "sha512-37i+OaWTh9qeK4LSHPsyRC7NahnGotNuZvjLSgcPzblpHB3rrCJxAOgI5gCdKm7coonsaX1Of0ILiTcnZjbfxA==" + "license": "MIT" }, "node_modules/@types/prop-types": { - "version": "15.7.14", - "resolved": "https://registry.npmjs.org/@types/prop-types/-/prop-types-15.7.14.tgz", - "integrity": "sha512-gNMvNH49DJ7OJYv+KAKn0Xp45p8PLl6zo2YnvDIbTd4J6MER2BmWN49TG7n9LvkyihINxeKW8+3bfS2yDC9dzQ==" + "version": "15.7.15", + "license": "MIT" }, "node_modules/@types/react": { - "version": "17.0.86", - "resolved": "https://registry.npmjs.org/@types/react/-/react-17.0.86.tgz", - "integrity": "sha512-lPFuSjA85jecet6D4ZsPvCFuSrz6g2hkTSUw8MM0x5z2EndPV/itGnYQ39abjxd7F+cAcxLGtKQjnLn9cNUz3g==", + "version": "17.0.90", + "license": "MIT", + "peer": true, "dependencies": { "@types/prop-types": "*", "@types/scheduler": "^0.16", - "csstype": "^3.0.2" + "csstype": "^3.2.2" } }, "node_modules/@types/react-dom": { "version": "17.0.26", - "resolved": "https://registry.npmjs.org/@types/react-dom/-/react-dom-17.0.26.tgz", - "integrity": "sha512-Z+2VcYXJwOqQ79HreLU/1fyQ88eXSSFh6I3JdrEHQIfYSI0kCQpTGvOrbE6jFGGYXKsHuwY9tBa/w5Uo6KzrEg==", "dev": true, + "license": "MIT", "peerDependencies": { "@types/react": "^17.0.0" } }, "node_modules/@types/react-redux": { "version": "7.1.34", - "resolved": "https://registry.npmjs.org/@types/react-redux/-/react-redux-7.1.34.tgz", - "integrity": "sha512-GdFaVjEbYv4Fthm2ZLvj1VSCedV7TqE5y1kNwnjSdBOTXuRSgowux6J8TAct15T3CKBr63UMk+2CO7ilRhyrAQ==", + "license": "MIT", "dependencies": { "@types/hoist-non-react-statics": "^3.3.0", "@types/react": "*", @@ -3117,67 +3097,81 @@ }, "node_modules/@types/react-test-renderer": { "version": "19.1.0", - "resolved": "https://registry.npmjs.org/@types/react-test-renderer/-/react-test-renderer-19.1.0.tgz", - "integrity": "sha512-XD0WZrHqjNrxA/MaR9O22w/RNidWR9YZmBdRGI7wcnWGrv/3dA8wKCJ8m63Sn+tLJhcjmuhOi629N66W6kgWzQ==", "dev": true, + "license": "MIT", "dependencies": { "@types/react": "*" } }, "node_modules/@types/react-transition-group": { "version": "4.4.12", - "resolved": "https://registry.npmjs.org/@types/react-transition-group/-/react-transition-group-4.4.12.tgz", - "integrity": "sha512-8TV6R3h2j7a91c+1DXdJi3Syo69zzIZbz7Lg5tORM5LEJG7X/E6a1V3drRyBRZq7/utz7A+c4OgYLiLcYGHG6w==", + "license": "MIT", "peerDependencies": { "@types/react": "*" } }, "node_modules/@types/react/node_modules/csstype": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.1.3.tgz", - "integrity": "sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw==" + "version": "3.2.3", + "license": "MIT" }, "node_modules/@types/resolve": { "version": "1.20.2", - "resolved": "https://registry.npmjs.org/@types/resolve/-/resolve-1.20.2.tgz", - "integrity": "sha512-60BCwRFOZCQhDncwQdxxeOEEkbc5dIMccYLwbxsS4TUNeVECQ/pBJ0j09mrHOl/JJvpRPGwO9SvE4nR2Nb/a4Q==" + "license": "MIT" }, "node_modules/@types/scheduler": { "version": "0.16.8", - "resolved": "https://registry.npmjs.org/@types/scheduler/-/scheduler-0.16.8.tgz", - "integrity": "sha512-WZLiwShhwLRmeV6zH+GkbOFT6Z6VklCItrDioxUnv+u4Ll+8vKeFySoFyK/0ctcRpOmwAicELfmys1sDc/Rw+A==" + "license": "MIT" }, "node_modules/@types/semver": { - "version": "7.7.0", - "resolved": "https://registry.npmjs.org/@types/semver/-/semver-7.7.0.tgz", - "integrity": "sha512-k107IF4+Xr7UHjwDc7Cfd6PRQfbdkiRabXGRjo07b4WyPahFBZCZ1sE+BNxYIJPPg73UkfOsVOLwqVc/6ETrIA==", - "dev": true + "version": "7.7.1", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/styled-jsx": { + "version": "2.2.9", + "license": "MIT", + "dependencies": { + "@types/react": "*" + } }, "node_modules/@types/trusted-types": { "version": "2.0.7", - "resolved": "https://registry.npmjs.org/@types/trusted-types/-/trusted-types-2.0.7.tgz", - "integrity": "sha512-ScaPdn1dQczgbl0QFTeTOmVHFULt394XJgOQNoyVhZ6r2vLnMLJfBPd53SB52T/3G36VI1/g2MZaX0cwDuXsfw==" + "license": "MIT" + }, + "node_modules/@types/uuid": { + "version": "3.4.13", + "license": "MIT" + }, + "node_modules/@types/whatwg-mimetype": { + "version": "3.0.2", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/ws": { + "version": "8.18.1", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/node": "*" + } }, "node_modules/@types/yargs": { - "version": "15.0.19", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-15.0.19.tgz", - "integrity": "sha512-2XUaGVmyQjgyAZldf0D0c14vvo/yv0MhQBSTJcejMMaitsn3nxCB6TmH4G0ZQf+uxROOa9mpanoSm8h6SG/1ZA==", + "version": "15.0.20", "dev": true, + "license": "MIT", "dependencies": { "@types/yargs-parser": "*" } }, "node_modules/@types/yargs-parser": { "version": "21.0.3", - "resolved": "https://registry.npmjs.org/@types/yargs-parser/-/yargs-parser-21.0.3.tgz", - "integrity": "sha512-I4q9QU9MQv4oEOz4tAHJtNz1cwuLxn2F3xcc2iV5WdqLPpUnj30aUuxt1mAxYTG+oe8CZMV/+6rU4S4gRDzqtQ==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/@typescript-eslint/eslint-plugin": { "version": "6.21.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-6.21.0.tgz", - "integrity": "sha512-oy9+hTPCUFpngkEZUSzbf9MxI65wbKFoQYsgPdILTfbUldp5ovUuphZVe4i30emU9M/kP+T64Di0mxl7dSw3MA==", "dev": true, + "license": "MIT", "dependencies": { "@eslint-community/regexpp": "^4.5.1", "@typescript-eslint/scope-manager": "6.21.0", @@ -3210,9 +3204,9 @@ }, "node_modules/@typescript-eslint/parser": { "version": "6.21.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-6.21.0.tgz", - "integrity": "sha512-tbsV1jPne5CkFQCgPBcDOt30ItF7aJoZL997JSF7MhGQqOeT3svWRYxiqlfA5RUdlHN6Fi+EI9bxqbdyAUZjYQ==", "dev": true, + "license": "BSD-2-Clause", + "peer": true, "dependencies": { "@typescript-eslint/scope-manager": "6.21.0", "@typescript-eslint/types": "6.21.0", @@ -3238,9 +3232,8 @@ }, "node_modules/@typescript-eslint/scope-manager": { "version": "6.21.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-6.21.0.tgz", - "integrity": "sha512-OwLUIWZJry80O99zvqXVEioyniJMa+d2GrqpUTqi5/v5D5rOrppJVBPa0yKCblcigC0/aYAzxxqQ1B+DS2RYsg==", "dev": true, + "license": "MIT", "dependencies": { "@typescript-eslint/types": "6.21.0", "@typescript-eslint/visitor-keys": "6.21.0" @@ -3255,9 +3248,8 @@ }, "node_modules/@typescript-eslint/type-utils": { "version": "6.21.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-6.21.0.tgz", - "integrity": "sha512-rZQI7wHfao8qMX3Rd3xqeYSMCL3SoiSQLBATSiVKARdFGCYSRvmViieZjqc58jKgs8Y8i9YvVVhRbHSTA4VBag==", "dev": true, + "license": "MIT", "dependencies": { "@typescript-eslint/typescript-estree": "6.21.0", "@typescript-eslint/utils": "6.21.0", @@ -3282,9 +3274,8 @@ }, "node_modules/@typescript-eslint/types": { "version": "6.21.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-6.21.0.tgz", - "integrity": "sha512-1kFmZ1rOm5epu9NZEZm1kckCDGj5UJEf7P1kliH4LKu/RkwpsfqqGmY2OOcUs18lSlQBKLDYBOGxRVtrMN5lpg==", "dev": true, + "license": "MIT", "engines": { "node": "^16.0.0 || >=18.0.0" }, @@ -3295,9 +3286,8 @@ }, "node_modules/@typescript-eslint/typescript-estree": { "version": "6.21.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-6.21.0.tgz", - "integrity": "sha512-6npJTkZcO+y2/kr+z0hc4HwNfrrP4kNYh57ek7yCNlrBjWQ1Y0OS7jiZTkgumrvkX5HkEKXFZkkdFNkaW2wmUQ==", "dev": true, + "license": "BSD-2-Clause", "dependencies": { "@typescript-eslint/types": "6.21.0", "@typescript-eslint/visitor-keys": "6.21.0", @@ -3323,9 +3313,8 @@ }, "node_modules/@typescript-eslint/utils": { "version": "6.21.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-6.21.0.tgz", - "integrity": "sha512-NfWVaC8HP9T8cbKQxHcsJBY5YE1O33+jpMwN45qzWWaPDZgLIbo12toGMWnmhvCpd3sIxkpDw3Wv1B3dYrbDQQ==", "dev": true, + "license": "MIT", "dependencies": { "@eslint-community/eslint-utils": "^4.4.0", "@types/json-schema": "^7.0.12", @@ -3348,9 +3337,8 @@ }, "node_modules/@typescript-eslint/visitor-keys": { "version": "6.21.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-6.21.0.tgz", - "integrity": "sha512-JJtkDduxLi9bivAB+cYOVMtbkqdPOhZ+ZI5LC47MIRrDV4Yn2o+ZnW10Nkmr28xRpSpdJ6Sm42Hjf2+REYXm0A==", "dev": true, + "license": "MIT", "dependencies": { "@typescript-eslint/types": "6.21.0", "eslint-visitor-keys": "^3.4.1" @@ -3365,55 +3353,50 @@ }, "node_modules/@ungap/structured-clone": { "version": "1.3.0", - "resolved": "https://registry.npmjs.org/@ungap/structured-clone/-/structured-clone-1.3.0.tgz", - "integrity": "sha512-WmoN8qaIAo7WTYWbAZuG8PYEhn5fkz7dZrqTBZ7dtt//lL2Gwms1IcnQ5yHqjDfX8Ft5j4YzDM23f87zBfDe9g==", - "dev": true + "dev": true, + "license": "ISC" }, "node_modules/@vitejs/plugin-react": { - "version": "4.5.0", - "resolved": "https://registry.npmjs.org/@vitejs/plugin-react/-/plugin-react-4.5.0.tgz", - "integrity": "sha512-JuLWaEqypaJmOJPLWwO335Ig6jSgC1FTONCWAxnqcQthLTK/Yc9aH6hr9z/87xciejbQcnP3GnA1FWUSWeXaeg==", + "version": "5.1.2", "dev": true, + "license": "MIT", "dependencies": { - "@babel/core": "^7.26.10", - "@babel/plugin-transform-react-jsx-self": "^7.25.9", - "@babel/plugin-transform-react-jsx-source": "^7.25.9", - "@rolldown/pluginutils": "1.0.0-beta.9", + "@babel/core": "^7.28.5", + "@babel/plugin-transform-react-jsx-self": "^7.27.1", + "@babel/plugin-transform-react-jsx-source": "^7.27.1", + "@rolldown/pluginutils": "1.0.0-beta.53", "@types/babel__core": "^7.20.5", - "react-refresh": "^0.17.0" + "react-refresh": "^0.18.0" }, "engines": { - "node": "^14.18.0 || >=16.0.0" + "node": "^20.19.0 || >=22.12.0" }, "peerDependencies": { - "vite": "^4.2.0 || ^5.0.0 || ^6.0.0" + "vite": "^4.2.0 || ^5.0.0 || ^6.0.0 || ^7.0.0" } }, "node_modules/@vitest/coverage-v8": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/@vitest/coverage-v8/-/coverage-v8-3.1.4.tgz", - "integrity": "sha512-G4p6OtioySL+hPV7Y6JHlhpsODbJzt1ndwHAFkyk6vVjpK03PFsKnauZIzcd0PrK4zAbc5lc+jeZ+eNGiMA+iw==", + "version": "4.0.17", "dev": true, + "license": "MIT", "dependencies": { - "@ampproject/remapping": "^2.3.0", "@bcoe/v8-coverage": "^1.0.2", - "debug": "^4.4.0", + "@vitest/utils": "4.0.17", + "ast-v8-to-istanbul": "^0.3.10", "istanbul-lib-coverage": "^3.2.2", "istanbul-lib-report": "^3.0.1", - "istanbul-lib-source-maps": "^5.0.6", - "istanbul-reports": "^3.1.7", - "magic-string": "^0.30.17", - "magicast": "^0.3.5", - "std-env": "^3.9.0", - "test-exclude": "^7.0.1", - "tinyrainbow": "^2.0.0" + "istanbul-reports": "^3.2.0", + "magicast": "^0.5.1", + "obug": "^2.1.1", + "std-env": "^3.10.0", + "tinyrainbow": "^3.0.3" }, "funding": { "url": "https://opencollective.com/vitest" }, "peerDependencies": { - "@vitest/browser": "3.1.4", - "vitest": "3.1.4" + "@vitest/browser": "4.0.17", + "vitest": "4.0.17" }, "peerDependenciesMeta": { "@vitest/browser": { @@ -3422,36 +3405,36 @@ } }, "node_modules/@vitest/expect": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-3.1.4.tgz", - "integrity": "sha512-xkD/ljeliyaClDYqHPNCiJ0plY5YIcM0OlRiZizLhlPmpXWpxnGMyTZXOHFhFeG7w9P5PBeL4IdtJ/HeQwTbQA==", + "version": "4.0.17", "dev": true, + "license": "MIT", "dependencies": { - "@vitest/spy": "3.1.4", - "@vitest/utils": "3.1.4", - "chai": "^5.2.0", - "tinyrainbow": "^2.0.0" + "@standard-schema/spec": "^1.0.0", + "@types/chai": "^5.2.2", + "@vitest/spy": "4.0.17", + "@vitest/utils": "4.0.17", + "chai": "^6.2.1", + "tinyrainbow": "^3.0.3" }, "funding": { "url": "https://opencollective.com/vitest" } }, "node_modules/@vitest/mocker": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/@vitest/mocker/-/mocker-3.1.4.tgz", - "integrity": "sha512-8IJ3CvwtSw/EFXqWFL8aCMu+YyYXG2WUSrQbViOZkWTKTVicVwZ/YiEZDSqD00kX+v/+W+OnxhNWoeVKorHygA==", + "version": "4.0.17", "dev": true, + "license": "MIT", "dependencies": { - "@vitest/spy": "3.1.4", + "@vitest/spy": "4.0.17", "estree-walker": "^3.0.3", - "magic-string": "^0.30.17" + "magic-string": "^0.30.21" }, "funding": { "url": "https://opencollective.com/vitest" }, "peerDependencies": { "msw": "^2.4.9", - "vite": "^5.0.0 || ^6.0.0" + "vite": "^6.0.0 || ^7.0.0-0" }, "peerDependenciesMeta": { "msw": { @@ -3463,24 +3446,22 @@ } }, "node_modules/@vitest/pretty-format": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-3.1.4.tgz", - "integrity": "sha512-cqv9H9GvAEoTaoq+cYqUTCGscUjKqlJZC7PRwY5FMySVj5J+xOm1KQcCiYHJOEzOKRUhLH4R2pTwvFlWCEScsg==", + "version": "4.0.17", "dev": true, + "license": "MIT", "dependencies": { - "tinyrainbow": "^2.0.0" + "tinyrainbow": "^3.0.3" }, "funding": { "url": "https://opencollective.com/vitest" } }, "node_modules/@vitest/runner": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-3.1.4.tgz", - "integrity": "sha512-djTeF1/vt985I/wpKVFBMWUlk/I7mb5hmD5oP8K9ACRmVXgKTae3TUOtXAEBfslNKPzUQvnKhNd34nnRSYgLNQ==", + "version": "4.0.17", "dev": true, + "license": "MIT", "dependencies": { - "@vitest/utils": "3.1.4", + "@vitest/utils": "4.0.17", "pathe": "^2.0.3" }, "funding": { @@ -3488,13 +3469,12 @@ } }, "node_modules/@vitest/snapshot": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-3.1.4.tgz", - "integrity": "sha512-JPHf68DvuO7vilmvwdPr9TS0SuuIzHvxeaCkxYcCD4jTk67XwL45ZhEHFKIuCm8CYstgI6LZ4XbwD6ANrwMpFg==", + "version": "4.0.17", "dev": true, + "license": "MIT", "dependencies": { - "@vitest/pretty-format": "3.1.4", - "magic-string": "^0.30.17", + "@vitest/pretty-format": "4.0.17", + "magic-string": "^0.30.21", "pathe": "^2.0.3" }, "funding": { @@ -3502,35 +3482,29 @@ } }, "node_modules/@vitest/spy": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-3.1.4.tgz", - "integrity": "sha512-Xg1bXhu+vtPXIodYN369M86K8shGLouNjoVI78g8iAq2rFoHFdajNvJJ5A/9bPMFcfQqdaCpOgWKEoMQg/s0Yg==", + "version": "4.0.17", "dev": true, - "dependencies": { - "tinyspy": "^3.0.2" - }, + "license": "MIT", "funding": { "url": "https://opencollective.com/vitest" } }, "node_modules/@vitest/utils": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-3.1.4.tgz", - "integrity": "sha512-yriMuO1cfFhmiGc8ataN51+9ooHRuURdfAZfwFd3usWynjzpLslZdYnRegTv32qdgtJTsj15FoeZe2g15fY1gg==", + "version": "4.0.17", "dev": true, + "license": "MIT", "dependencies": { - "@vitest/pretty-format": "3.1.4", - "loupe": "^3.1.3", - "tinyrainbow": "^2.0.0" + "@vitest/pretty-format": "4.0.17", + "tinyrainbow": "^3.0.3" }, "funding": { "url": "https://opencollective.com/vitest" } }, "node_modules/acorn": { - "version": "8.14.1", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.14.1.tgz", - "integrity": "sha512-OvQ/2pUDKmgfCg++xsTX1wGxfTaszcHVcTctW4UJB4hibJx2HXxxO5UmVgyjMa+ZDsiaf5wWLXYpRWMmBI0QHg==", + "version": "8.15.0", + "license": "MIT", + "peer": true, "bin": { "acorn": "bin/acorn" }, @@ -3540,27 +3514,23 @@ }, "node_modules/acorn-jsx": { "version": "5.3.2", - "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.2.tgz", - "integrity": "sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ==", "dev": true, + "license": "MIT", "peerDependencies": { "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" } }, "node_modules/agent-base": { - "version": "7.1.3", - "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-7.1.3.tgz", - "integrity": "sha512-jRR5wdylq8CkOe6hei19GGZnxM6rBGwFl3Bg0YItGDimvjGtAvdZk4Pu6Cl4u4Igsws4a1fd1Vq3ezrhn4KmFw==", + "version": "7.1.4", "dev": true, + "license": "MIT", "engines": { "node": ">= 14" } }, "node_modules/ajv": { - "version": "6.12.6", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", - "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", - "dev": true, + "version": "6.14.0", + "license": "MIT", "dependencies": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", @@ -3574,16 +3544,14 @@ }, "node_modules/ansi-align": { "version": "3.0.1", - "resolved": "https://registry.npmjs.org/ansi-align/-/ansi-align-3.0.1.tgz", - "integrity": "sha512-IOfwwBF5iczOjp/WeY4YxyjqAFMQoZufdQWDd19SEExbVLNXqvpzSJ/M7Za4/sCPmQ0+GRquoA7bGcINcxew6w==", + "license": "ISC", "dependencies": { "string-width": "^4.1.0" } }, "node_modules/ansi-escapes": { "version": "4.3.2", - "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-4.3.2.tgz", - "integrity": "sha512-gKXj5ALrKWQLsYG9jlTRmR/xKluxHV+Z9QEwNIgCfM1/uwPMCuzVVnh5mwTd+OuBZcwSIMbqssNWRm1lE51QaQ==", + "license": "MIT", "dependencies": { "type-fest": "^0.21.3" }, @@ -3596,8 +3564,7 @@ }, "node_modules/ansi-escapes/node_modules/type-fest": { "version": "0.21.3", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.21.3.tgz", - "integrity": "sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w==", + "license": "(MIT OR CC0-1.0)", "engines": { "node": ">=10" }, @@ -3607,16 +3574,14 @@ }, "node_modules/ansi-regex": { "version": "5.0.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", - "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "license": "MIT", "engines": { "node": ">=8" } }, "node_modules/ansi-styles": { "version": "4.3.0", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", - "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "license": "MIT", "dependencies": { "color-convert": "^2.0.1" }, @@ -3629,8 +3594,7 @@ }, "node_modules/anymatch": { "version": "3.1.3", - "resolved": "https://registry.npmjs.org/anymatch/-/anymatch-3.1.3.tgz", - "integrity": "sha512-KMReFUr0B4t+D+OBkjR3KYqvocp2XaSzO55UcB6mgQMd3KbcE+mWTyvVV7D/zsdEbNnV6acZUutkiHQXvTr1Rw==", + "license": "ISC", "dependencies": { "normalize-path": "^3.0.0", "picomatch": "^2.0.4" @@ -3641,23 +3605,20 @@ }, "node_modules/argparse": { "version": "2.0.1", - "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", - "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", - "dev": true + "dev": true, + "license": "Python-2.0" }, "node_modules/aria-query": { "version": "5.3.0", - "resolved": "https://registry.npmjs.org/aria-query/-/aria-query-5.3.0.tgz", - "integrity": "sha512-b0P0sZPKtyu8HkeRAfCq0IfURZK+SuwMjY1UXGBU27wpAiTwQAIlq56IbIO+ytk/JjS1fMR14ee5WBBfKi5J6A==", "dev": true, + "license": "Apache-2.0", "dependencies": { "dequal": "^2.0.3" } }, "node_modules/array-buffer-byte-length": { "version": "1.0.2", - "resolved": "https://registry.npmjs.org/array-buffer-byte-length/-/array-buffer-byte-length-1.0.2.tgz", - "integrity": "sha512-LHE+8BuR7RYGDKvnrmcuSq3tDcKv9OFEXQt/HpbZhY7V6h0zlUXutnAD82GiFx9rdieCMjkvtcsPqBwgUl1Iiw==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.3", "is-array-buffer": "^3.0.5" @@ -3670,17 +3631,18 @@ } }, "node_modules/array-includes": { - "version": "3.1.8", - "resolved": "https://registry.npmjs.org/array-includes/-/array-includes-3.1.8.tgz", - "integrity": "sha512-itaWrbYbqpGXkGhZPGUulwnhVf5Hpy1xiCFsGqyIGglbBxmG5vSjxQen3/WGOjPpNEv1RtBLKxbmVXm8HpJStQ==", + "version": "3.1.9", "dev": true, + "license": "MIT", "dependencies": { - "call-bind": "^1.0.7", + "call-bind": "^1.0.8", + "call-bound": "^1.0.4", "define-properties": "^1.2.1", - "es-abstract": "^1.23.2", - "es-object-atoms": "^1.0.0", - "get-intrinsic": "^1.2.4", - "is-string": "^1.0.7" + "es-abstract": "^1.24.0", + "es-object-atoms": "^1.1.1", + "get-intrinsic": "^1.3.0", + "is-string": "^1.1.1", + "math-intrinsics": "^1.1.0" }, "engines": { "node": ">= 0.4" @@ -3691,18 +3653,16 @@ }, "node_modules/array-union": { "version": "2.1.0", - "resolved": "https://registry.npmjs.org/array-union/-/array-union-2.1.0.tgz", - "integrity": "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==", "dev": true, + "license": "MIT", "engines": { "node": ">=8" } }, "node_modules/array.prototype.findlast": { "version": "1.2.5", - "resolved": "https://registry.npmjs.org/array.prototype.findlast/-/array.prototype.findlast-1.2.5.tgz", - "integrity": "sha512-CVvd6FHg1Z3POpBLxO6E6zr+rSKEQ9L6rZHAaY7lLfhKsWYUBBOuMs0e9o24oopj6H+geRCX0YJ+TJLBK2eHyQ==", "dev": true, + "license": "MIT", "dependencies": { "call-bind": "^1.0.7", "define-properties": "^1.2.1", @@ -3720,9 +3680,8 @@ }, "node_modules/array.prototype.flat": { "version": "1.3.3", - "resolved": "https://registry.npmjs.org/array.prototype.flat/-/array.prototype.flat-1.3.3.tgz", - "integrity": "sha512-rwG/ja1neyLqCuGZ5YYrznA62D4mZXg0i1cIskIUKSiqF3Cje9/wXAls9B9s1Wa2fomMsIv8czB8jZcPmxCXFg==", "dev": true, + "license": "MIT", "dependencies": { "call-bind": "^1.0.8", "define-properties": "^1.2.1", @@ -3738,9 +3697,8 @@ }, "node_modules/array.prototype.flatmap": { "version": "1.3.3", - "resolved": "https://registry.npmjs.org/array.prototype.flatmap/-/array.prototype.flatmap-1.3.3.tgz", - "integrity": "sha512-Y7Wt51eKJSyi80hFrJCePGGNo5ktJCslFuboqJsbf57CCPcm5zztluPlc4/aD8sWsKvlwatezpV4U1efk8kpjg==", "dev": true, + "license": "MIT", "dependencies": { "call-bind": "^1.0.8", "define-properties": "^1.2.1", @@ -3756,9 +3714,8 @@ }, "node_modules/array.prototype.tosorted": { "version": "1.1.4", - "resolved": "https://registry.npmjs.org/array.prototype.tosorted/-/array.prototype.tosorted-1.1.4.tgz", - "integrity": "sha512-p6Fx8B7b7ZhL/gmUsAy0D15WhvDccw3mnGNbZpi3pmeJdxtWsj2jEaI4Y6oo3XiHfzuSgPwKc04MYt6KgvC/wA==", "dev": true, + "license": "MIT", "dependencies": { "call-bind": "^1.0.7", "define-properties": "^1.2.1", @@ -3772,8 +3729,7 @@ }, "node_modules/arraybuffer.prototype.slice": { "version": "1.0.4", - "resolved": "https://registry.npmjs.org/arraybuffer.prototype.slice/-/arraybuffer.prototype.slice-1.0.4.tgz", - "integrity": "sha512-BNoCY6SXXPQ7gF2opIP4GBE+Xw7U+pHMYKuzjgCN3GwiaIR09UUeKfheyIry77QtrCBlC0KK0q5/TER/tYh3PQ==", + "license": "MIT", "dependencies": { "array-buffer-byte-length": "^1.0.1", "call-bind": "^1.0.8", @@ -3792,68 +3748,82 @@ }, "node_modules/arrify": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/arrify/-/arrify-1.0.1.tgz", - "integrity": "sha512-3CYzex9M9FGQjCGMGyi6/31c8GJbgb0qGyrx5HWxPd0aCwh4cB2YjMb2Xf9UuoogrMrlO9cTqnB5rI5GHZTcUA==", + "license": "MIT", "engines": { "node": ">=0.10.0" } }, "node_modules/assertion-error": { "version": "2.0.1", - "resolved": "https://registry.npmjs.org/assertion-error/-/assertion-error-2.0.1.tgz", - "integrity": "sha512-Izi8RQcffqCeNVgFigKli1ssklIbpHnCYc6AknXGYoB6grJqyeby7jv12JUQgmTAnIDnbck1uxksT4dzN3PWBA==", "dev": true, + "license": "MIT", "engines": { "node": ">=12" } }, "node_modules/ast-types-flow": { "version": "0.0.8", - "resolved": "https://registry.npmjs.org/ast-types-flow/-/ast-types-flow-0.0.8.tgz", - "integrity": "sha512-OH/2E5Fg20h2aPrbe+QL8JZQFko0YZaF+j4mnQ7BGhfavO7OpSLa8a0y9sBwomHdSbkhTS8TQNayBfnW5DwbvQ==", - "dev": true + "dev": true, + "license": "MIT" + }, + "node_modules/ast-v8-to-istanbul": { + "version": "0.3.10", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/trace-mapping": "^0.3.31", + "estree-walker": "^3.0.3", + "js-tokens": "^9.0.1" + } + }, + "node_modules/ast-v8-to-istanbul/node_modules/js-tokens": { + "version": "9.0.1", + "dev": true, + "license": "MIT" }, "node_modules/async": { "version": "3.2.6", - "resolved": "https://registry.npmjs.org/async/-/async-3.2.6.tgz", - "integrity": "sha512-htCUDlxyyCLMgaM3xXg0C0LW2xqfuQ6p05pCEIsXuyQ+a1koYKTuBMzRNwmybfLgvJDMd0r1LTn4+E0Ti6C2AA==" + "license": "MIT" }, "node_modules/async-function": { "version": "1.0.0", - "resolved": "https://registry.npmjs.org/async-function/-/async-function-1.0.0.tgz", - "integrity": "sha512-hsU18Ae8CDTR6Kgu9DYf0EbCr/a5iGL0rytQDobUcdpYOKokk8LEjVphnXkDkgpi0wYVsqrXuP0bZxJaTqdgoA==", + "license": "MIT", "engines": { "node": ">= 0.4" } }, "node_modules/at-least-node": { "version": "1.0.0", - "resolved": "https://registry.npmjs.org/at-least-node/-/at-least-node-1.0.0.tgz", - "integrity": "sha512-+q/t7Ekv1EDY2l6Gda6LLiX14rU9TV20Wa3ofeQmwPFZbOMo9DXrLbOjFaaclkXKWidIaopwAObQDqwWtGUjqg==", + "license": "ISC", "engines": { "node": ">= 4.0.0" } }, + "node_modules/atomically": { + "version": "2.1.0", + "license": "MIT", + "dependencies": { + "stubborn-fs": "^2.0.0", + "when-exit": "^2.1.4" + } + }, "node_modules/attr-accept": { "version": "2.2.5", - "resolved": "https://registry.npmjs.org/attr-accept/-/attr-accept-2.2.5.tgz", - "integrity": "sha512-0bDNnY/u6pPwHDMoF0FieU354oBi0a8rD9FcsLwzcGWbc8KS8KPIi7y+s13OlVY+gMWc/9xEMUgNE6Qm8ZllYQ==", + "license": "MIT", "engines": { "node": ">=4" } }, "node_modules/autosuggest-highlight": { "version": "3.3.4", - "resolved": "https://registry.npmjs.org/autosuggest-highlight/-/autosuggest-highlight-3.3.4.tgz", - "integrity": "sha512-j6RETBD2xYnrVcoV1S5R4t3WxOlWZKyDQjkwnggDPSjF5L4jV98ZltBpvPvbkM1HtoSe5o+bNrTHyjPbieGeYA==", + "license": "MIT", "dependencies": { "remove-accents": "^0.4.2" } }, "node_modules/available-typed-arrays": { "version": "1.0.7", - "resolved": "https://registry.npmjs.org/available-typed-arrays/-/available-typed-arrays-1.0.7.tgz", - "integrity": "sha512-wvUjBtSGN7+7SjNpq/9M2Tg350UZD3q62IFZLbRAR1bSMlCo1ZaeW+BJ+D090e4hIIZLBcTDWe4Mh4jvUDajzQ==", + "license": "MIT", "dependencies": { "possible-typed-array-names": "^1.0.0" }, @@ -3865,30 +3835,27 @@ } }, "node_modules/axe-core": { - "version": "4.10.3", - "resolved": "https://registry.npmjs.org/axe-core/-/axe-core-4.10.3.tgz", - "integrity": "sha512-Xm7bpRXnDSX2YE2YFfBk2FnF0ep6tmG7xPh8iHee8MIcrgq762Nkce856dYtJYLkuIoYZvGfTs/PbZhideTcEg==", + "version": "4.11.1", "dev": true, + "license": "MPL-2.0", "engines": { "node": ">=4" } }, "node_modules/axobject-query": { "version": "4.1.0", - "resolved": "https://registry.npmjs.org/axobject-query/-/axobject-query-4.1.0.tgz", - "integrity": "sha512-qIj0G9wZbMGNLjLmg1PT6v2mE9AH2zlnADJD/2tC6E00hgmhUOfEB6greHPAfLRSufHqROIUTkw6E+M3lH0PTQ==", "dev": true, + "license": "Apache-2.0", "engines": { "node": ">= 0.4" } }, "node_modules/babel-plugin-polyfill-corejs2": { - "version": "0.4.13", - "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs2/-/babel-plugin-polyfill-corejs2-0.4.13.tgz", - "integrity": "sha512-3sX/eOms8kd3q2KZ6DAhKPc0dgm525Gqq5NtWKZ7QYYZEv57OQ54KtblzJzH1lQF/eQxO8KjWGIK9IPUJNus5g==", + "version": "0.4.14", + "license": "MIT", "dependencies": { - "@babel/compat-data": "^7.22.6", - "@babel/helper-define-polyfill-provider": "^0.6.4", + "@babel/compat-data": "^7.27.7", + "@babel/helper-define-polyfill-provider": "^0.6.5", "semver": "^6.3.1" }, "peerDependencies": { @@ -3897,30 +3864,27 @@ }, "node_modules/babel-plugin-polyfill-corejs2/node_modules/semver": { "version": "6.3.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", - "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "license": "ISC", "bin": { "semver": "bin/semver.js" } }, "node_modules/babel-plugin-polyfill-corejs3": { - "version": "0.11.1", - "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs3/-/babel-plugin-polyfill-corejs3-0.11.1.tgz", - "integrity": "sha512-yGCqvBT4rwMczo28xkH/noxJ6MZ4nJfkVYdoDaC/utLtWrXxv27HVrzAeSbqR8SxDsp46n0YF47EbHoixy6rXQ==", + "version": "0.13.0", + "license": "MIT", "dependencies": { - "@babel/helper-define-polyfill-provider": "^0.6.3", - "core-js-compat": "^3.40.0" + "@babel/helper-define-polyfill-provider": "^0.6.5", + "core-js-compat": "^3.43.0" }, "peerDependencies": { "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" } }, "node_modules/babel-plugin-polyfill-regenerator": { - "version": "0.6.4", - "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-regenerator/-/babel-plugin-polyfill-regenerator-0.6.4.tgz", - "integrity": "sha512-7gD3pRadPrbjhjLyxebmx/WrFYcuSjZ0XbdUujQMZ/fcE9oeewk2U/7PCvez84UeuK3oSjmPZ0Ch0dlupQvGzw==", + "version": "0.6.5", + "license": "MIT", "dependencies": { - "@babel/helper-define-polyfill-provider": "^0.6.4" + "@babel/helper-define-polyfill-provider": "^0.6.5" }, "peerDependencies": { "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" @@ -3928,8 +3892,7 @@ }, "node_modules/babel-runtime": { "version": "6.26.0", - "resolved": "https://registry.npmjs.org/babel-runtime/-/babel-runtime-6.26.0.tgz", - "integrity": "sha512-ITKNuq2wKlW1fJg9sSW52eepoYgZBggvOAHC0u/CYu/qxQ9EVzThCgR69BnSXLHjy2f7SY5zaQ4yt7H9ZVxY2g==", + "license": "MIT", "dependencies": { "core-js": "^2.4.0", "regenerator-runtime": "^0.11.0" @@ -3937,13 +3900,10 @@ }, "node_modules/balanced-match": { "version": "1.0.2", - "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", - "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==" + "license": "MIT" }, "node_modules/base64-js": { "version": "1.5.1", - "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.5.1.tgz", - "integrity": "sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==", "funding": [ { "type": "github", @@ -3957,12 +3917,19 @@ "type": "consulting", "url": "https://feross.org/support" } - ] + ], + "license": "MIT" + }, + "node_modules/baseline-browser-mapping": { + "version": "2.9.15", + "license": "Apache-2.0", + "bin": { + "baseline-browser-mapping": "dist/cli.js" + } }, "node_modules/binary-extensions": { "version": "2.3.0", - "resolved": "https://registry.npmjs.org/binary-extensions/-/binary-extensions-2.3.0.tgz", - "integrity": "sha512-Ceh+7ox5qe7LJuLHoY0feh3pHuUDHAcRUeyL2VYghZwfpkNIy/+8Ocg0a3UuSoYzavmylwuLWQOf3hl0jjMMIw==", + "license": "MIT", "engines": { "node": ">=8" }, @@ -3972,8 +3939,7 @@ }, "node_modules/bl": { "version": "4.1.0", - "resolved": "https://registry.npmjs.org/bl/-/bl-4.1.0.tgz", - "integrity": "sha512-1W07cM9gS6DcLperZfFSj+bWLtaPGSOHWhPiGzXmvVJbRLdG82sH/Kn8EtW1VqWVA54AKf2h5k5BbnIbwF3h6w==", + "license": "MIT", "dependencies": { "buffer": "^5.5.0", "inherits": "^2.0.4", @@ -3982,62 +3948,110 @@ }, "node_modules/blueimp-md5": { "version": "2.19.0", - "resolved": "https://registry.npmjs.org/blueimp-md5/-/blueimp-md5-2.19.0.tgz", - "integrity": "sha512-DRQrD6gJyy8FbiE4s+bDoXS9hiW3Vbx5uCdwvcCf3zLHL+Iv7LtGHLpr+GZV8rHG8tK766FGYBwRbu8pELTt+w==" + "license": "MIT" }, "node_modules/boxen": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/boxen/-/boxen-4.2.0.tgz", - "integrity": "sha512-eB4uT9RGzg2odpER62bBwSLvUeGC+WbRjjyyFhGsKnc8wp/m0+hQsMUvUe3H2V0D5vw0nBdO1hCJoZo5mKeuIQ==", + "version": "8.0.1", + "license": "MIT", "dependencies": { - "ansi-align": "^3.0.0", - "camelcase": "^5.3.1", - "chalk": "^3.0.0", - "cli-boxes": "^2.2.0", - "string-width": "^4.1.0", - "term-size": "^2.1.0", - "type-fest": "^0.8.1", - "widest-line": "^3.1.0" + "ansi-align": "^3.0.1", + "camelcase": "^8.0.0", + "chalk": "^5.3.0", + "cli-boxes": "^3.0.0", + "string-width": "^7.2.0", + "type-fest": "^4.21.0", + "widest-line": "^5.0.0", + "wrap-ansi": "^9.0.0" }, "engines": { - "node": ">=8" + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/boxen/node_modules/ansi-regex": { + "version": "6.2.2", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-regex?sponsor=1" + } + }, + "node_modules/boxen/node_modules/camelcase": { + "version": "8.0.0", + "license": "MIT", + "engines": { + "node": ">=16" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/boxen/node_modules/chalk": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz", - "integrity": "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg==", + "version": "5.6.2", + "license": "MIT", + "engines": { + "node": "^12.17.0 || ^14.13 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/boxen/node_modules/emoji-regex": { + "version": "10.6.0", + "license": "MIT" + }, + "node_modules/boxen/node_modules/string-width": { + "version": "7.2.0", + "license": "MIT", "dependencies": { - "ansi-styles": "^4.1.0", - "supports-color": "^7.1.0" + "emoji-regex": "^10.3.0", + "get-east-asian-width": "^1.0.0", + "strip-ansi": "^7.1.0" }, "engines": { - "node": ">=8" + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/boxen/node_modules/strip-ansi": { + "version": "7.1.2", + "license": "MIT", + "dependencies": { + "ansi-regex": "^6.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/strip-ansi?sponsor=1" } }, "node_modules/boxen/node_modules/type-fest": { - "version": "0.8.1", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.8.1.tgz", - "integrity": "sha512-4dbzIzqvjtgiM5rw1k5rEHtBANKmdudhGyBEajN01fEyhaAIhsoKNy6y7+IN93IfpFtwY9iqi7kD+xwKhQsNJA==", + "version": "4.41.0", + "license": "(MIT OR CC0-1.0)", "engines": { - "node": ">=8" + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/brace-expansion": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", - "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "version": "2.0.2", + "license": "MIT", "dependencies": { "balanced-match": "^1.0.0" } }, "node_modules/braces": { "version": "3.0.3", - "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", - "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", + "license": "MIT", "dependencies": { "fill-range": "^7.1.1" }, @@ -4046,9 +4060,7 @@ } }, "node_modules/browserslist": { - "version": "4.24.5", - "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.24.5.tgz", - "integrity": "sha512-FDToo4Wo82hIdgc1CQ+NQD0hEhmpPjrZ3hiUgwgOG6IuTdlpr8jdjyG24P6cNP1yJpTLzS5OcGgSw0xmDU1/Tw==", + "version": "4.28.1", "funding": [ { "type": "opencollective", @@ -4063,11 +4075,14 @@ "url": "https://github.com/sponsors/ai" } ], + "license": "MIT", + "peer": true, "dependencies": { - "caniuse-lite": "^1.0.30001716", - "electron-to-chromium": "^1.5.149", - "node-releases": "^2.0.19", - "update-browserslist-db": "^1.1.3" + "baseline-browser-mapping": "^2.9.0", + "caniuse-lite": "^1.0.30001759", + "electron-to-chromium": "^1.5.263", + "node-releases": "^2.0.27", + "update-browserslist-db": "^1.2.0" }, "bin": { "browserslist": "cli.js" @@ -4078,8 +4093,6 @@ }, "node_modules/buffer": { "version": "5.7.1", - "resolved": "https://registry.npmjs.org/buffer/-/buffer-5.7.1.tgz", - "integrity": "sha512-EHcyIPBQ4BSGlvjB16k5KgAJ27CIsHY/2JBmCRReo48y9rQ3MaUzWX3KVlBa4U7MyX02HdVj0K7C3WaB3ju7FQ==", "funding": [ { "type": "github", @@ -4094,6 +4107,7 @@ "url": "https://feross.org/support" } ], + "license": "MIT", "dependencies": { "base64-js": "^1.3.1", "ieee754": "^1.1.13" @@ -4101,74 +4115,11 @@ }, "node_modules/buffer-from": { "version": "1.1.2", - "resolved": "https://registry.npmjs.org/buffer-from/-/buffer-from-1.1.2.tgz", - "integrity": "sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==" - }, - "node_modules/cac": { - "version": "6.7.14", - "resolved": "https://registry.npmjs.org/cac/-/cac-6.7.14.tgz", - "integrity": "sha512-b6Ilus+c3RrdDk+JhLKUAQfzzgLEPy6wcXqS7f/xe1EETvsDP6GORG7SFuOs6cID5YkqchW/LXZbX5bc8j7ZcQ==", - "dev": true, - "engines": { - "node": ">=8" - } - }, - "node_modules/cacheable-request": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/cacheable-request/-/cacheable-request-6.1.0.tgz", - "integrity": "sha512-Oj3cAGPCqOZX7Rz64Uny2GYAZNliQSqfbePrgAQ1wKAihYmCUnraBtJtKcGR4xz7wF+LoJC+ssFZvv5BgF9Igg==", - "dependencies": { - "clone-response": "^1.0.2", - "get-stream": "^5.1.0", - "http-cache-semantics": "^4.0.0", - "keyv": "^3.0.0", - "lowercase-keys": "^2.0.0", - "normalize-url": "^4.1.0", - "responselike": "^1.0.2" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/cacheable-request/node_modules/get-stream": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-5.2.0.tgz", - "integrity": "sha512-nBF+F1rAZVCu/p7rjzgA+Yb4lfYXrpl7a6VmJrU8wF9I1CKvP/QwPNZHnOlwbTkY6dvtFIzFMSyQXbLoTQPRpA==", - "dependencies": { - "pump": "^3.0.0" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/cacheable-request/node_modules/json-buffer": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/json-buffer/-/json-buffer-3.0.0.tgz", - "integrity": "sha512-CuUqjv0FUZIdXkHPI8MezCnFCdaTAacej1TZYulLoAg1h/PhwkdXFN4V/gzY4g+fMBCOV2xF+rp7t2XD2ns/NQ==" - }, - "node_modules/cacheable-request/node_modules/keyv": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/keyv/-/keyv-3.1.0.tgz", - "integrity": "sha512-9ykJ/46SN/9KPM/sichzQ7OvXyGDYKGTaDlKMGCAlg2UK8KRy4jb0d8sFc+0Tt0YYnThq8X2RZgCg74RPxgcVA==", - "dependencies": { - "json-buffer": "3.0.0" - } - }, - "node_modules/cacheable-request/node_modules/lowercase-keys": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/lowercase-keys/-/lowercase-keys-2.0.0.tgz", - "integrity": "sha512-tqNXrS78oMOE73NMxK4EMLQsQowWf8jKooH9g7xPavRT706R6bkQJ6DY2Te7QukaZsulxa30wQ7bk0pm4XiHmA==", - "engines": { - "node": ">=8" - } + "license": "MIT" }, "node_modules/call-bind": { "version": "1.0.8", - "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.8.tgz", - "integrity": "sha512-oKlSFMcMwpUg2ednkhQ454wfWiU/ul3CkJe/PEHcTKuiX6RpbehUiFMXu13HalGZxfUwCQzZG747YXBn1im9ww==", + "license": "MIT", "dependencies": { "call-bind-apply-helpers": "^1.0.0", "es-define-property": "^1.0.0", @@ -4184,8 +4135,7 @@ }, "node_modules/call-bind-apply-helpers": { "version": "1.0.2", - "resolved": "https://registry.npmjs.org/call-bind-apply-helpers/-/call-bind-apply-helpers-1.0.2.tgz", - "integrity": "sha512-Sp1ablJ0ivDkSzjcaJdxEunN5/XvksFJ2sMBFfq6x0ryhQV/2b/KwFe21cMpmHtPOSij8K99/wSfoEuTObmuMQ==", + "license": "MIT", "dependencies": { "es-errors": "^1.3.0", "function-bind": "^1.1.2" @@ -4196,8 +4146,7 @@ }, "node_modules/call-bound": { "version": "1.0.4", - "resolved": "https://registry.npmjs.org/call-bound/-/call-bound-1.0.4.tgz", - "integrity": "sha512-+ys997U96po4Kx/ABpBCqhA9EuxJaQWDQg7295H4hBphv3IZg0boBKuwYpt4YXp6MZ5AmZQnU/tyMTlRpaSejg==", + "license": "MIT", "dependencies": { "call-bind-apply-helpers": "^1.0.2", "get-intrinsic": "^1.3.0" @@ -4209,27 +4158,28 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/call-me-maybe": { + "version": "1.0.2", + "license": "MIT" + }, "node_modules/callsites": { "version": "3.1.0", - "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", - "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==", "dev": true, + "license": "MIT", "engines": { "node": ">=6" } }, "node_modules/camelcase": { "version": "5.3.1", - "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-5.3.1.tgz", - "integrity": "sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg==", + "license": "MIT", "engines": { "node": ">=6" } }, "node_modules/camelcase-keys": { "version": "6.2.2", - "resolved": "https://registry.npmjs.org/camelcase-keys/-/camelcase-keys-6.2.2.tgz", - "integrity": "sha512-YrwaA0vEKazPBkn0ipTiMpSajYDSe+KjQfrjhcBMxJt/znbvlHd8Pw/Vamaz5EB4Wfhs3SUR3Z9mwRu/P3s3Yg==", + "license": "MIT", "dependencies": { "camelcase": "^5.3.1", "map-obj": "^4.0.0", @@ -4243,9 +4193,7 @@ } }, "node_modules/caniuse-lite": { - "version": "1.0.30001718", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001718.tgz", - "integrity": "sha512-AflseV1ahcSunK53NfEs9gFWgOEmzr0f+kaMFA4xiLZlr9Hzt7HxcSpIFcnNCUkz6R6dWKa54rUz3HUmI3nVcw==", + "version": "1.0.30001765", "funding": [ { "type": "opencollective", @@ -4259,28 +4207,20 @@ "type": "github", "url": "https://github.com/sponsors/ai" } - ] + ], + "license": "CC-BY-4.0" }, "node_modules/chai": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/chai/-/chai-5.2.0.tgz", - "integrity": "sha512-mCuXncKXk5iCLhfhwTc0izo0gtEmpz5CtG2y8GiOINBlMVS6v8TMRc5TaLWKS6692m9+dVVfzgeVxR5UxWHTYw==", + "version": "6.2.2", "dev": true, - "dependencies": { - "assertion-error": "^2.0.1", - "check-error": "^2.1.1", - "deep-eql": "^5.0.1", - "loupe": "^3.1.0", - "pathval": "^2.0.0" - }, + "license": "MIT", "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/chalk": { "version": "4.1.2", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", - "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "license": "MIT", "dependencies": { "ansi-styles": "^4.1.0", "supports-color": "^7.1.0" @@ -4294,22 +4234,11 @@ }, "node_modules/chardet": { "version": "0.7.0", - "resolved": "https://registry.npmjs.org/chardet/-/chardet-0.7.0.tgz", - "integrity": "sha512-mT8iDcrh03qDGRRmoA2hmBJnxpllMR+0/0qlzjqZES6NdiWDcZkCNAk4rPFZ9Q85r27unkiNNg8ZOiwZXBHwcA==" - }, - "node_modules/check-error": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/check-error/-/check-error-2.1.1.tgz", - "integrity": "sha512-OAlb+T7V4Op9OwdkjmguYRqncdlx5JiofwOAUkmTF+jNdHwzTaTs4sRAGpzLF3oOz5xAyDGrPgeIDFQmDOTiJw==", - "dev": true, - "engines": { - "node": ">= 16" - } + "license": "MIT" }, "node_modules/chokidar": { "version": "3.6.0", - "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.6.0.tgz", - "integrity": "sha512-7VT13fmjotKpGipCW9JEQAusEPE+Ei8nl6/g4FBAmIm0GOOLMua9NDDo/DWp0ZAxCr3cPq5ZpBqmPAQgDda2Pw==", + "license": "MIT", "dependencies": { "anymatch": "~3.1.2", "braces": "~3.0.2", @@ -4331,8 +4260,7 @@ }, "node_modules/chokidar/node_modules/glob-parent": { "version": "5.1.2", - "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", - "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", + "license": "ISC", "dependencies": { "is-glob": "^4.0.1" }, @@ -4340,22 +4268,17 @@ "node": ">= 6" } }, - "node_modules/ci-info": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-2.0.0.tgz", - "integrity": "sha512-5tK7EtrZ0N+OLFMthtqOj4fI2Jeb88C4CAZPu25LDVUgXJ0A3Js4PMGqrn0JU1W0Mh1/Z8wZzYPxqUrXeBboCQ==" - }, "node_modules/classnames": { "version": "2.5.1", "resolved": "https://registry.npmjs.org/classnames/-/classnames-2.5.1.tgz", - "integrity": "sha512-saHYOzhIQs6wy2sVxTM6bUDsQO4F50V9RQ22qBpEdCW+I+/Wmke2HOl6lS6dTpdxVhb88/I6+Hs+438c3lfUow==" + "integrity": "sha512-saHYOzhIQs6wy2sVxTM6bUDsQO4F50V9RQ22qBpEdCW+I+/Wmke2HOl6lS6dTpdxVhb88/I6+Hs+438c3lfUow==", + "license": "MIT" }, "node_modules/cli-boxes": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/cli-boxes/-/cli-boxes-2.2.1.tgz", - "integrity": "sha512-y4coMcylgSCdVinjiDBuR8PCC2bLjyGTwEmPb9NHR/QaNU6EUOXcTY/s6VjGMD6ENSEaeQYHCY0GNGS5jfMwPw==", + "version": "3.0.0", + "license": "MIT", "engines": { - "node": ">=6" + "node": ">=10" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" @@ -4363,8 +4286,7 @@ }, "node_modules/cli-cursor": { "version": "3.1.0", - "resolved": "https://registry.npmjs.org/cli-cursor/-/cli-cursor-3.1.0.tgz", - "integrity": "sha512-I/zHAwsKf9FqGoXM4WWRACob9+SNukZTd94DWF57E4toouRulbCxcUh6RKUEOQlYTHJnzkPMySvPNaaSLNfLZw==", + "license": "MIT", "dependencies": { "restore-cursor": "^3.1.0" }, @@ -4374,8 +4296,7 @@ }, "node_modules/cli-spinners": { "version": "2.9.2", - "resolved": "https://registry.npmjs.org/cli-spinners/-/cli-spinners-2.9.2.tgz", - "integrity": "sha512-ywqV+5MmyL4E7ybXgKys4DugZbX0FC6LnwrhjuykIjnK9k8OQacQ7axGKnjDXWNhns0xot3bZI5h55H8yo9cJg==", + "license": "MIT", "engines": { "node": ">=6" }, @@ -4385,43 +4306,28 @@ }, "node_modules/cli-width": { "version": "3.0.0", - "resolved": "https://registry.npmjs.org/cli-width/-/cli-width-3.0.0.tgz", - "integrity": "sha512-FxqpkPPwu1HjuN93Omfm4h8uIanXofW0RxVEW3k5RKx+mJJYSthzNhp32Kzxxy3YAEZ/Dc/EWN1vZRY0+kOhbw==", + "license": "ISC", "engines": { "node": ">= 10" } }, "node_modules/clone": { "version": "1.0.4", - "resolved": "https://registry.npmjs.org/clone/-/clone-1.0.4.tgz", - "integrity": "sha512-JQHZ2QMW6l3aH/j6xCqQThY/9OH4D/9ls34cgkUBiEeocRTU04tHfKPBsUK1PqZCUQM7GiA0IIXJSuXHI64Kbg==", + "license": "MIT", "engines": { "node": ">=0.8" } }, - "node_modules/clone-response": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/clone-response/-/clone-response-1.0.3.tgz", - "integrity": "sha512-ROoL94jJH2dUVML2Y/5PEDNaSHgeOdSDicUyS7izcF63G6sTc/FTjLub4b8Il9S8S0beOfYt0TaA5qvFK+w0wA==", - "dependencies": { - "mimic-response": "^1.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/clsx": { "version": "2.1.1", - "resolved": "https://registry.npmjs.org/clsx/-/clsx-2.1.1.tgz", - "integrity": "sha512-eYm0QWBtUrBWZWG0d386OGAw16Z995PiOVo2B7bjWSbHedGl5e0ZWaq65kOGgUSNesEIDkB9ISbTg/JK9dhCZA==", + "license": "MIT", "engines": { "node": ">=6" } }, "node_modules/color-convert": { "version": "2.0.1", - "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", - "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "license": "MIT", "dependencies": { "color-name": "~1.1.4" }, @@ -4431,74 +4337,60 @@ }, "node_modules/color-name": { "version": "1.1.4", - "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", - "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==" + "license": "MIT" }, "node_modules/commander": { "version": "2.20.3", - "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", - "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==" + "license": "MIT" }, "node_modules/common-tags": { "version": "1.8.2", - "resolved": "https://registry.npmjs.org/common-tags/-/common-tags-1.8.2.tgz", - "integrity": "sha512-gk/Z852D2Wtb//0I+kRFNKKE9dIIVirjoqPoA1wJU+XePVXZfGeBpk45+A1rKO4Q43prqWBNY/MiIeRLbPWUaA==", + "license": "MIT", "engines": { "node": ">=4.0.0" } }, "node_modules/compute-scroll-into-view": { "version": "1.0.20", - "resolved": "https://registry.npmjs.org/compute-scroll-into-view/-/compute-scroll-into-view-1.0.20.tgz", - "integrity": "sha512-UCB0ioiyj8CRjtrvaceBLqqhZCVP+1B8+NWQhmdsm0VXOJtobBCf1dBQmebCCo34qZmUwZfIH2MZLqNHazrfjg==" + "license": "MIT" }, "node_modules/concat-map": { "version": "0.0.1", - "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", - "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==" + "dev": true, + "license": "MIT" }, - "node_modules/configstore": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/configstore/-/configstore-5.0.1.tgz", - "integrity": "sha512-aMKprgk5YhBNyH25hj8wGt2+D52Sw1DRRIzqBwLp2Ya9mFmY8KPvvtvmna8SxVR9JMZ4kzMD68N22vlaRpkeFA==", + "node_modules/config-chain": { + "version": "1.1.13", + "license": "MIT", "dependencies": { - "dot-prop": "^5.2.0", - "graceful-fs": "^4.1.2", - "make-dir": "^3.0.0", - "unique-string": "^2.0.0", - "write-file-atomic": "^3.0.0", - "xdg-basedir": "^4.0.0" - }, - "engines": { - "node": ">=8" + "ini": "^1.3.4", + "proto-list": "~1.2.1" } }, - "node_modules/configstore/node_modules/make-dir": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-3.1.0.tgz", - "integrity": "sha512-g3FeP20LNwhALb/6Cz6Dd4F2ngze0jz7tbzrD2wAV+o9FeNHe4rL+yK2md0J/fiSf1sa1ADhXqi5+oVwOM/eGw==", + "node_modules/config-chain/node_modules/ini": { + "version": "1.3.8", + "license": "ISC" + }, + "node_modules/configstore": { + "version": "7.1.0", + "license": "BSD-2-Clause", "dependencies": { - "semver": "^6.0.0" + "atomically": "^2.0.3", + "dot-prop": "^9.0.0", + "graceful-fs": "^4.2.11", + "xdg-basedir": "^5.1.0" }, "engines": { - "node": ">=8" + "node": ">=18" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/configstore/node_modules/semver": { - "version": "6.3.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", - "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", - "bin": { - "semver": "bin/semver.js" - } - }, "node_modules/connected-react-router": { "version": "6.9.3", - "resolved": "https://registry.npmjs.org/connected-react-router/-/connected-react-router-6.9.3.tgz", - "integrity": "sha512-4ThxysOiv/R2Dc4Cke1eJwjKwH1Y51VDwlOrOfs1LjpdYOVvCNjNkZDayo7+sx42EeGJPQUNchWkjAIJdXGIOQ==", + "license": "MIT", + "peer": true, "dependencies": { "lodash.isequalwith": "^4.4.0", "prop-types": "^15.7.2" @@ -4517,22 +4409,18 @@ }, "node_modules/convert-source-map": { "version": "2.0.0", - "resolved": "https://registry.npmjs.org/convert-source-map/-/convert-source-map-2.0.0.tgz", - "integrity": "sha512-Kvp459HrV2FEJ1CAsi1Ku+MY3kasH19TFykTz2xWmMeq6bk2NU3XXvfJ+Q61m0xktWwt+1HSYf3JZsTms3aRJg==" + "license": "MIT" }, "node_modules/core-js": { "version": "2.6.12", - "resolved": "https://registry.npmjs.org/core-js/-/core-js-2.6.12.tgz", - "integrity": "sha512-Kb2wC0fvsWfQrgk8HU5lW6U/Lcs8+9aaYcy4ZFc6DDlo4nZ7n70dEgE5rtR0oG6ufKDUnrwfWL1mXR5ljDatrQ==", - "deprecated": "core-js@<3.23.3 is no longer maintained and not recommended for usage due to the number of issues. Because of the V8 engine whims, feature detection in old core-js versions could cause a slowdown up to 100x even if nothing is polyfilled. Some versions have web compatibility issues. Please, upgrade your dependencies to the actual version of core-js.", - "hasInstallScript": true + "hasInstallScript": true, + "license": "MIT" }, "node_modules/core-js-compat": { - "version": "3.42.0", - "resolved": "https://registry.npmjs.org/core-js-compat/-/core-js-compat-3.42.0.tgz", - "integrity": "sha512-bQasjMfyDGyaeWKBIu33lHh9qlSR0MFE/Nmc6nMjf/iU9b3rSMdAYz1Baxrv4lPdGUsTqZudHA4jIGSJy0SWZQ==", + "version": "3.47.0", + "license": "MIT", "dependencies": { - "browserslist": "^4.24.4" + "browserslist": "^4.28.0" }, "funding": { "type": "opencollective", @@ -4540,11 +4428,10 @@ } }, "node_modules/core-js-pure": { - "version": "3.42.0", - "resolved": "https://registry.npmjs.org/core-js-pure/-/core-js-pure-3.42.0.tgz", - "integrity": "sha512-007bM04u91fF4kMgwom2I5cQxAFIy8jVulgr9eozILl/SZE53QOqnW/+vviC+wQWLv+AunBG+8Q0TLoeSsSxRQ==", + "version": "3.47.0", "dev": true, "hasInstallScript": true, + "license": "MIT", "funding": { "type": "opencollective", "url": "https://opencollective.com/core-js" @@ -4552,9 +4439,7 @@ }, "node_modules/cross-spawn": { "version": "7.0.6", - "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.6.tgz", - "integrity": "sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==", - "dev": true, + "license": "MIT", "dependencies": { "path-key": "^3.1.0", "shebang-command": "^2.0.0", @@ -4566,21 +4451,18 @@ }, "node_modules/crypto-random-string": { "version": "2.0.0", - "resolved": "https://registry.npmjs.org/crypto-random-string/-/crypto-random-string-2.0.0.tgz", - "integrity": "sha512-v1plID3y9r/lPhviJ1wrXpLeyUIGAZ2SHNYTEapm7/8A9nLPoyvVp3RK/EPFqn5kEznyWgYZNsRtYYIWbuG8KA==", + "license": "MIT", "engines": { "node": ">=8" } }, "node_modules/css-mediaquery": { "version": "0.1.2", - "resolved": "https://registry.npmjs.org/css-mediaquery/-/css-mediaquery-0.1.2.tgz", - "integrity": "sha512-COtn4EROW5dBGlE/4PiKnh6rZpAPxDeFLaEEwt4i10jpDMFt2EhQGS79QmmrO+iKCHv0PU/HrOWEhijFd1x99Q==" + "license": "BSD" }, "node_modules/css-vendor": { "version": "2.0.8", - "resolved": "https://registry.npmjs.org/css-vendor/-/css-vendor-2.0.8.tgz", - "integrity": "sha512-x9Aq0XTInxrkuFeHKbYC7zWY8ai7qJ04Kxd9MnvbC1uO5DagxoHQjm4JvG+vCdXOoFtCjbL2XSZfxmoYa9uQVQ==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.8.3", "is-in-browser": "^1.0.2" @@ -4588,17 +4470,15 @@ }, "node_modules/css.escape": { "version": "1.5.1", - "resolved": "https://registry.npmjs.org/css.escape/-/css.escape-1.5.1.tgz", - "integrity": "sha512-YUifsXXuknHlUsmlgyY0PKzgPOr7/FjCePfHNt0jxm83wHZi44VDMQ7/fGNkjY3/jV1MC+1CmZbaHzugyeRtpg==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/cssstyle": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/cssstyle/-/cssstyle-4.3.1.tgz", - "integrity": "sha512-ZgW+Jgdd7i52AaLYCriF8Mxqft0gD/R9i9wi6RWBhs1pqdPEzPjym7rvRKi397WmQFf3SlyUsszhw+VVCbx79Q==", + "version": "4.6.0", "dev": true, + "license": "MIT", "dependencies": { - "@asamuzakjp/css-color": "^3.1.2", + "@asamuzakjp/css-color": "^3.2.0", "rrweb-cssom": "^0.8.0" }, "engines": { @@ -4607,20 +4487,17 @@ }, "node_modules/csstype": { "version": "2.6.21", - "resolved": "https://registry.npmjs.org/csstype/-/csstype-2.6.21.tgz", - "integrity": "sha512-Z1PhmomIfypOpoMjRQB70jfvy/wxT50qW08YXO5lMIJkrdq4yOTR+AW7FqutScmB9NkLwxo+jU+kZLbofZZq/w==" + "license": "MIT" }, "node_modules/damerau-levenshtein": { "version": "1.0.8", - "resolved": "https://registry.npmjs.org/damerau-levenshtein/-/damerau-levenshtein-1.0.8.tgz", - "integrity": "sha512-sdQSFB7+llfUcQHUQO3+B8ERRj0Oa4w9POWMI/puGtuf7gFywGmkaLCElnudfTiKZV+NvHqL0ifzdrI8Ro7ESA==", - "dev": true + "dev": true, + "license": "BSD-2-Clause" }, "node_modules/data-urls": { "version": "5.0.0", - "resolved": "https://registry.npmjs.org/data-urls/-/data-urls-5.0.0.tgz", - "integrity": "sha512-ZYP5VBHshaDAiVZxjbRVcFJpc+4xGgT0bK3vzy1HLN8jTO975HEbuYzZJcHoQEY5K1a0z8YayJkyVETa08eNTg==", "dev": true, + "license": "MIT", "dependencies": { "whatwg-mimetype": "^4.0.0", "whatwg-url": "^14.0.0" @@ -4631,17 +4508,15 @@ }, "node_modules/data-urls/node_modules/whatwg-mimetype": { "version": "4.0.0", - "resolved": "https://registry.npmjs.org/whatwg-mimetype/-/whatwg-mimetype-4.0.0.tgz", - "integrity": "sha512-QaKxh0eNIi2mE9p2vEdzfagOKHCcj1pJ56EEHGQOVxp8r9/iszLUUV7v89x9O1p/T+NlTM5W7jW6+cz4Fq1YVg==", "dev": true, + "license": "MIT", "engines": { "node": ">=18" } }, "node_modules/data-view-buffer": { "version": "1.0.2", - "resolved": "https://registry.npmjs.org/data-view-buffer/-/data-view-buffer-1.0.2.tgz", - "integrity": "sha512-EmKO5V3OLXh1rtK2wgXRansaK1/mtVdTUEiEI0W8RkvgT05kfxaH29PliLnpLP73yYO6142Q72QNa8Wx/A5CqQ==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.3", "es-errors": "^1.3.0", @@ -4656,8 +4531,7 @@ }, "node_modules/data-view-byte-length": { "version": "1.0.2", - "resolved": "https://registry.npmjs.org/data-view-byte-length/-/data-view-byte-length-1.0.2.tgz", - "integrity": "sha512-tuhGbE6CfTM9+5ANGf+oQb72Ky/0+s3xKUpHvShfiz2RxMFgFPjsXuRLBVMtvMs15awe45SRb83D6wH4ew6wlQ==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.3", "es-errors": "^1.3.0", @@ -4672,8 +4546,7 @@ }, "node_modules/data-view-byte-offset": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/data-view-byte-offset/-/data-view-byte-offset-1.0.1.tgz", - "integrity": "sha512-BS8PfmtDGnrgYdOonGZQdLZslWIeCGFP9tpan0hi1Co2Zr2NKADsvGYA8XxuG/4UWgJ6Cjtv+YJnB6MM69QGlQ==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.2", "es-errors": "^1.3.0", @@ -4688,13 +4561,11 @@ }, "node_modules/date-fns": { "version": "1.30.1", - "resolved": "https://registry.npmjs.org/date-fns/-/date-fns-1.30.1.tgz", - "integrity": "sha512-hBSVCvSmWC+QypYObzwGOd9wqdDpOt+0wl0KbU+R+uuZBS1jN8VsD1ss3irQDknRj5NvxiTF6oj/nDRnN/UQNw==" + "license": "MIT" }, "node_modules/debug": { - "version": "4.4.1", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.1.tgz", - "integrity": "sha512-KcKCqiftBJcZr++7ykoDIEwSa3XWowTfNPo92BYxjXiyYEVrUQh2aLyhxBCwww+heortUFxEJYcRzosstTEBYQ==", + "version": "4.4.3", + "license": "MIT", "dependencies": { "ms": "^2.1.3" }, @@ -4709,16 +4580,14 @@ }, "node_modules/decamelize": { "version": "1.2.0", - "resolved": "https://registry.npmjs.org/decamelize/-/decamelize-1.2.0.tgz", - "integrity": "sha512-z2S+W9X73hAUUki+N+9Za2lBlun89zigOyGrsax+KUQ6wKW4ZoWpEYBkGhQjwAjjDCkWxhY0VKEhk8wzY7F5cA==", + "license": "MIT", "engines": { "node": ">=0.10.0" } }, "node_modules/decamelize-keys": { "version": "1.1.1", - "resolved": "https://registry.npmjs.org/decamelize-keys/-/decamelize-keys-1.1.1.tgz", - "integrity": "sha512-WiPxgEirIV0/eIOMcnFBA3/IJZAZqKnwAwWyvvdi4lsr1WCN22nhdf/3db3DoZcUjTV2SqfzIwNyp6y2xs3nmg==", + "license": "MIT", "dependencies": { "decamelize": "^1.1.0", "map-obj": "^1.0.0" @@ -4732,51 +4601,27 @@ }, "node_modules/decamelize-keys/node_modules/map-obj": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/map-obj/-/map-obj-1.0.1.tgz", - "integrity": "sha512-7N/q3lyZ+LVCp7PzuxrJr4KMbBE2hW7BT7YNia330OFxIf4d3r5zVpicP2650l7CPN6RM9zOJRl3NGpqSiw3Eg==", + "license": "MIT", "engines": { "node": ">=0.10.0" } }, "node_modules/decimal.js": { - "version": "10.5.0", - "resolved": "https://registry.npmjs.org/decimal.js/-/decimal.js-10.5.0.tgz", - "integrity": "sha512-8vDa8Qxvr/+d94hSh5P3IJwI5t8/c0KsMp+g8bNw9cY2icONa5aPfvKeieW1WlG0WQYwwhJ7mjui2xtiePQSXw==", - "dev": true + "version": "10.6.0", + "dev": true, + "license": "MIT" }, "node_modules/decode-uri-component": { "version": "0.2.2", - "resolved": "https://registry.npmjs.org/decode-uri-component/-/decode-uri-component-0.2.2.tgz", - "integrity": "sha512-FqUYQ+8o158GyGTrMFJms9qh3CqTKvAqgqsTnkLI8sKu0028orqBhxNMFkFen0zGyg6epACD32pjVk58ngIErQ==", + "license": "MIT", "engines": { "node": ">=0.10" } }, - "node_modules/decompress-response": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/decompress-response/-/decompress-response-3.3.0.tgz", - "integrity": "sha512-BzRPQuY1ip+qDonAOz42gRm/pg9F768C+npV/4JOsxRC2sq+Rlk+Q4ZCAsOhnIaMrgarILY+RMUIvMmmX1qAEA==", - "dependencies": { - "mimic-response": "^1.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/deep-eql": { - "version": "5.0.2", - "resolved": "https://registry.npmjs.org/deep-eql/-/deep-eql-5.0.2.tgz", - "integrity": "sha512-h5k/5U50IJJFpzfL6nO9jaaumfjO/f2NjK/oYB2Djzm4p9L+3T9qWpZqZ2hAbLPuuYq9wrU08WQyBTL5GbPk5Q==", - "dev": true, - "engines": { - "node": ">=6" - } - }, "node_modules/deep-equal": { "version": "2.2.3", - "resolved": "https://registry.npmjs.org/deep-equal/-/deep-equal-2.2.3.tgz", - "integrity": "sha512-ZIwpnevOurS8bpT4192sqAowWM76JDKSHYzMLty3BZGSswgq6pBaH3DhCSW5xVAZICZyKdOBPjwww5wfgT/6PA==", "dev": true, + "license": "MIT", "dependencies": { "array-buffer-byte-length": "^1.0.0", "call-bind": "^1.0.5", @@ -4806,36 +4651,31 @@ }, "node_modules/deep-equal/node_modules/isarray": { "version": "2.0.5", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.5.tgz", - "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/deep-extend": { "version": "0.6.0", - "resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.6.0.tgz", - "integrity": "sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==", + "license": "MIT", "engines": { "node": ">=4.0.0" } }, "node_modules/deep-is": { "version": "0.1.4", - "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz", - "integrity": "sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/deepmerge": { "version": "4.3.1", - "resolved": "https://registry.npmjs.org/deepmerge/-/deepmerge-4.3.1.tgz", - "integrity": "sha512-3sUqbMEc77XqpdNO7FRyRog+eW3ph+GYCbj+rK+uYyRMuwsVy0rMiVtPn+QJlKFvWP/1PYpapqYn0Me2knFn+A==", + "license": "MIT", "engines": { "node": ">=0.10.0" } }, "node_modules/defaults": { "version": "1.0.4", - "resolved": "https://registry.npmjs.org/defaults/-/defaults-1.0.4.tgz", - "integrity": "sha512-eFuaLoy/Rxalv2kr+lqMlUnrDWV+3j4pljOIJgLIhI058IQfWJ7vXhyEIHu+HtC738klGALYxOKDO0bQP3tg8A==", + "license": "MIT", "dependencies": { "clone": "^1.0.2" }, @@ -4843,15 +4683,9 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/defer-to-connect": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/defer-to-connect/-/defer-to-connect-1.1.3.tgz", - "integrity": "sha512-0ISdNousHvZT2EiFlZeZAHBUvSxmKswVCEf8hW7KWgG4a8MVEu/3Vb6uWYozkjylyCxe0JBIiRB1jV45S70WVQ==" - }, "node_modules/define-data-property": { "version": "1.1.4", - "resolved": "https://registry.npmjs.org/define-data-property/-/define-data-property-1.1.4.tgz", - "integrity": "sha512-rBMvIzlpA8v6E+SJZoo++HAYqsLrkg7MSfIinMPFhmkorw7X+dOXVJQs+QT69zGkzMyfDnIMN2Wid1+NbL3T+A==", + "license": "MIT", "dependencies": { "es-define-property": "^1.0.0", "es-errors": "^1.3.0", @@ -4866,8 +4700,7 @@ }, "node_modules/define-properties": { "version": "1.2.1", - "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.2.1.tgz", - "integrity": "sha512-8QmQKqEASLd5nx0U1B1okLElbUuuttJ/AnYmRXbbbGDWh6uS208EjD4Xqq/I9wK7u0v6O08XhTWnt5XtEbR6Dg==", + "license": "MIT", "dependencies": { "define-data-property": "^1.0.1", "has-property-descriptors": "^1.0.0", @@ -4882,18 +4715,16 @@ }, "node_modules/dequal": { "version": "2.0.3", - "resolved": "https://registry.npmjs.org/dequal/-/dequal-2.0.3.tgz", - "integrity": "sha512-0je+qPKHEMohvfRTCEo3CrPG6cAzAYgmzKyxRiYSSDkS6eGJdyVJm7WaYA5ECaAD9wLB2T4EEeymA5aFVcYXCA==", "dev": true, + "license": "MIT", "engines": { "node": ">=6" } }, "node_modules/dir-glob": { "version": "3.0.1", - "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz", - "integrity": "sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==", "dev": true, + "license": "MIT", "dependencies": { "path-type": "^4.0.0" }, @@ -4903,8 +4734,7 @@ }, "node_modules/dnd-core": { "version": "14.0.1", - "resolved": "https://registry.npmjs.org/dnd-core/-/dnd-core-14.0.1.tgz", - "integrity": "sha512-+PVS2VPTgKFPYWo3vAFEA8WPbTf7/xo43TifH9G8S1KqnrQu0o77A3unrF5yOugy4mIz7K5wAVFHUcha7wsz6A==", + "license": "MIT", "dependencies": { "@react-dnd/asap": "^4.0.0", "@react-dnd/invariant": "^2.0.0", @@ -4913,9 +4743,8 @@ }, "node_modules/doctrine": { "version": "3.0.0", - "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-3.0.0.tgz", - "integrity": "sha512-yS+Q5i3hBf7GBkd4KG8a7eBNNWNGLTaEwwYWUijIYM7zrlYDM0BFXHjjPWlWZ1Rg7UaddZeIDmi9jF3HmqiQ2w==", "dev": true, + "license": "Apache-2.0", "dependencies": { "esutils": "^2.0.2" }, @@ -4925,62 +4754,69 @@ }, "node_modules/dom-accessibility-api": { "version": "0.5.16", - "resolved": "https://registry.npmjs.org/dom-accessibility-api/-/dom-accessibility-api-0.5.16.tgz", - "integrity": "sha512-X7BJ2yElsnOJ30pZF4uIIDfBEVgF4XEBxL9Bxhy6dnrm5hkzqmsWHGTiHqRiITNhMyFLyAiWndIJP7Z1NTteDg==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/dom-align": { "version": "1.12.4", "resolved": "https://registry.npmjs.org/dom-align/-/dom-align-1.12.4.tgz", - "integrity": "sha512-R8LUSEay/68zE5c8/3BDxiTEvgb4xZTF0RKmAHfiEVN3klfIpXfi2/QCoiWPccVQ0J/ZGdz9OjzL4uJEP/MRAw==" + "integrity": "sha512-R8LUSEay/68zE5c8/3BDxiTEvgb4xZTF0RKmAHfiEVN3klfIpXfi2/QCoiWPccVQ0J/ZGdz9OjzL4uJEP/MRAw==", + "license": "MIT" }, "node_modules/dom-helpers": { "version": "5.2.1", - "resolved": "https://registry.npmjs.org/dom-helpers/-/dom-helpers-5.2.1.tgz", - "integrity": "sha512-nRCa7CK3VTrM2NmGkIy4cbK7IZlgBE/PYMn55rrXefr5xXDP0LdtfPnblFDoVdcAfslJ7or6iqAUnx0CCGIWQA==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.8.7", "csstype": "^3.0.2" } }, "node_modules/dom-helpers/node_modules/csstype": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.1.3.tgz", - "integrity": "sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw==" + "version": "3.2.3", + "license": "MIT" }, "node_modules/dompurify": { - "version": "2.5.8", - "resolved": "https://registry.npmjs.org/dompurify/-/dompurify-2.5.8.tgz", - "integrity": "sha512-o1vSNgrmYMQObbSSvF/1brBYEQPHhV1+gsmrusO7/GXtp1T9rCS8cXFqVxK/9crT1jA6Ccv+5MTSjBNqr7Sovw==" - }, - "node_modules/dot-prop": { - "version": "5.3.0", - "resolved": "https://registry.npmjs.org/dot-prop/-/dot-prop-5.3.0.tgz", - "integrity": "sha512-QM8q3zDe58hqUqjraQOmzZ1LIH9SWQJTlEKCH4kJ2oQvLZk7RbQXvtDM2XEq3fwkV9CCvvH4LA0AV+ogFsBM2Q==", - "dependencies": { - "is-obj": "^2.0.0" - }, + "version": "3.3.2", + "license": "(MPL-2.0 OR Apache-2.0)", "engines": { - "node": ">=8" + "node": ">=20" + }, + "optionalDependencies": { + "@types/trusted-types": "^2.0.7" } }, - "node_modules/dot-prop/node_modules/is-obj": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/is-obj/-/is-obj-2.0.0.tgz", - "integrity": "sha512-drqDG3cbczxxEJRoOXcOjtdp1J/lyp1mNn0xaznRs8+muBhgQcrnbspox5X5fOw0HnMnbfDzvnEMEtqDEJEo8w==", + "node_modules/dot-prop": { + "version": "9.0.0", + "license": "MIT", + "dependencies": { + "type-fest": "^4.18.2" + }, "engines": { - "node": ">=8" + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/dot-prop/node_modules/type-fest": { + "version": "4.41.0", + "license": "(MIT OR CC0-1.0)", + "engines": { + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/downloadjs": { "version": "1.4.7", "resolved": "https://registry.npmjs.org/downloadjs/-/downloadjs-1.4.7.tgz", - "integrity": "sha512-LN1gO7+u9xjU5oEScGFKvXhYf7Y/empUIIEAGBs1LzUq/rg5duiDrkuH5A2lQGd5jfMOb9X9usDa2oVXwJ0U/Q==" + "integrity": "sha512-LN1gO7+u9xjU5oEScGFKvXhYf7Y/empUIIEAGBs1LzUq/rg5duiDrkuH5A2lQGd5jfMOb9X9usDa2oVXwJ0U/Q==", + "license": "MIT" }, "node_modules/downshift": { "version": "3.2.7", - "resolved": "https://registry.npmjs.org/downshift/-/downshift-3.2.7.tgz", - "integrity": "sha512-mbUO9ZFhMGtksIeVWRFFjNOPN237VsUqZSEYi0VS0Wj38XNLzpgOBTUcUjdjFeB8KVgmrcRa6GGFkTbACpG6FA==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.1.2", "compute-scroll-into-view": "^1.0.9", @@ -4993,13 +4829,11 @@ }, "node_modules/downshift/node_modules/react-is": { "version": "16.13.1", - "resolved": "https://registry.npmjs.org/react-is/-/react-is-16.13.1.tgz", - "integrity": "sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==" + "license": "MIT" }, "node_modules/dunder-proto": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/dunder-proto/-/dunder-proto-1.0.1.tgz", - "integrity": "sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A==", + "license": "MIT", "dependencies": { "call-bind-apply-helpers": "^1.0.1", "es-errors": "^1.3.0", @@ -5009,21 +4843,13 @@ "node": ">= 0.4" } }, - "node_modules/duplexer3": { - "version": "0.1.5", - "resolved": "https://registry.npmjs.org/duplexer3/-/duplexer3-0.1.5.tgz", - "integrity": "sha512-1A8za6ws41LQgv9HrE/66jyC5yuSjQ3L/KOpFtoBilsAK2iA2wuS5rTt1OCzIvtS2V7nVmedsUU+DGRcjBmOYA==" - }, "node_modules/eastasianwidth": { "version": "0.2.0", - "resolved": "https://registry.npmjs.org/eastasianwidth/-/eastasianwidth-0.2.0.tgz", - "integrity": "sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA==", - "dev": true + "license": "MIT" }, "node_modules/ejs": { "version": "3.1.10", - "resolved": "https://registry.npmjs.org/ejs/-/ejs-3.1.10.tgz", - "integrity": "sha512-UeJmFfOrAQS8OJWPZ4qtgHyWExa088/MtK5UEyoJGFH67cDEXkZSviOiKRCZ4Xij0zxI3JECgYs3oKx+AizQBA==", + "license": "Apache-2.0", "dependencies": { "jake": "^10.8.5" }, @@ -5035,29 +4861,17 @@ } }, "node_modules/electron-to-chromium": { - "version": "1.5.157", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.157.tgz", - "integrity": "sha512-/0ybgsQd1muo8QlnuTpKwtl0oX5YMlUGbm8xyqgDU00motRkKFFbUJySAQBWcY79rVqNLWIWa87BGVGClwAB2w==" + "version": "1.5.267", + "license": "ISC" }, "node_modules/emoji-regex": { "version": "9.2.2", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-9.2.2.tgz", - "integrity": "sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg==", - "dev": true - }, - "node_modules/end-of-stream": { - "version": "1.4.4", - "resolved": "https://registry.npmjs.org/end-of-stream/-/end-of-stream-1.4.4.tgz", - "integrity": "sha512-+uw1inIHVPQoaVuHzRyXd21icM+cnt4CzD5rW+NC1wjOUSTOs+Te7FOv7AhN7vS9x/oIyhLP5PR1H+phQAHu5Q==", - "dependencies": { - "once": "^1.4.0" - } + "license": "MIT" }, "node_modules/entities": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/entities/-/entities-6.0.0.tgz", - "integrity": "sha512-aKstq2TDOndCn4diEyp9Uq/Flu2i1GlLkc6XIDQSDMuaFE3OPW5OphLCyQ5SpSJZTb4reN+kTcYru5yIfXoRPw==", + "version": "4.5.0", "dev": true, + "license": "BSD-2-Clause", "engines": { "node": ">=0.12" }, @@ -5066,17 +4880,15 @@ } }, "node_modules/error-ex": { - "version": "1.3.2", - "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.2.tgz", - "integrity": "sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g==", + "version": "1.3.4", + "license": "MIT", "dependencies": { "is-arrayish": "^0.2.1" } }, "node_modules/es-abstract": { - "version": "1.23.10", - "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.23.10.tgz", - "integrity": "sha512-MtUbM072wlJNyeYAe0mhzrD+M6DIJa96CZAOBBrhDbgKnB4MApIKefcyAB1eOdYn8cUNZgvwBvEzdoAYsxgEIw==", + "version": "1.24.1", + "license": "MIT", "dependencies": { "array-buffer-byte-length": "^1.0.2", "arraybuffer.prototype.slice": "^1.0.4", @@ -5105,7 +4917,9 @@ "is-array-buffer": "^3.0.5", "is-callable": "^1.2.7", "is-data-view": "^1.0.2", + "is-negative-zero": "^2.0.3", "is-regex": "^1.2.1", + "is-set": "^2.0.3", "is-shared-array-buffer": "^1.0.4", "is-string": "^1.1.1", "is-typed-array": "^1.1.15", @@ -5120,6 +4934,7 @@ "safe-push-apply": "^1.0.0", "safe-regex-test": "^1.1.0", "set-proto": "^1.0.0", + "stop-iteration-iterator": "^1.1.0", "string.prototype.trim": "^1.2.10", "string.prototype.trimend": "^1.0.9", "string.prototype.trimstart": "^1.0.8", @@ -5139,25 +4954,22 @@ }, "node_modules/es-define-property": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.1.tgz", - "integrity": "sha512-e3nRfgfUZ4rNGL232gUgX06QNyyez04KdjFrF+LTRoOXmrOgFKDg4BCdsjW8EnT69eqdYGmRpJwiPVYNrCaW3g==", + "license": "MIT", "engines": { "node": ">= 0.4" } }, "node_modules/es-errors": { "version": "1.3.0", - "resolved": "https://registry.npmjs.org/es-errors/-/es-errors-1.3.0.tgz", - "integrity": "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==", + "license": "MIT", "engines": { "node": ">= 0.4" } }, "node_modules/es-get-iterator": { "version": "1.1.3", - "resolved": "https://registry.npmjs.org/es-get-iterator/-/es-get-iterator-1.1.3.tgz", - "integrity": "sha512-sPZmqHBe6JIiTfN5q2pEi//TwxmAFHwj/XEuYjTuse78i8KxaqMTTzxPoFKuzRpDpTJ+0NAbpfenkmH2rePtuw==", "dev": true, + "license": "MIT", "dependencies": { "call-bind": "^1.0.2", "get-intrinsic": "^1.1.3", @@ -5175,31 +4987,29 @@ }, "node_modules/es-get-iterator/node_modules/isarray": { "version": "2.0.5", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.5.tgz", - "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/es-iterator-helpers": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/es-iterator-helpers/-/es-iterator-helpers-1.2.1.tgz", - "integrity": "sha512-uDn+FE1yrDzyC0pCo961B2IHbdM8y/ACZsKD4dG6WqrjV53BADjwa7D+1aom2rsNVfLyDgU/eigvlJGJ08OQ4w==", + "version": "1.2.2", "dev": true, + "license": "MIT", "dependencies": { "call-bind": "^1.0.8", - "call-bound": "^1.0.3", + "call-bound": "^1.0.4", "define-properties": "^1.2.1", - "es-abstract": "^1.23.6", + "es-abstract": "^1.24.1", "es-errors": "^1.3.0", - "es-set-tostringtag": "^2.0.3", + "es-set-tostringtag": "^2.1.0", "function-bind": "^1.1.2", - "get-intrinsic": "^1.2.6", + "get-intrinsic": "^1.3.0", "globalthis": "^1.0.4", "gopd": "^1.2.0", "has-property-descriptors": "^1.0.2", "has-proto": "^1.2.0", "has-symbols": "^1.1.0", "internal-slot": "^1.1.0", - "iterator.prototype": "^1.1.4", + "iterator.prototype": "^1.1.5", "safe-array-concat": "^1.1.3" }, "engines": { @@ -5208,14 +5018,12 @@ }, "node_modules/es-module-lexer": { "version": "1.7.0", - "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-1.7.0.tgz", - "integrity": "sha512-jEQoCwk8hyb2AZziIOLhDqpm5+2ww5uIE6lkO/6jcOCusfk6LhMHpXXfBLXTZ7Ydyt0j4VoUQv6uGNYbdW+kBA==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/es-object-atoms": { "version": "1.1.1", - "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.1.1.tgz", - "integrity": "sha512-FGgH2h8zKNim9ljj7dankFPcICIK9Cp5bm+c2gQSYePhpaG5+esrLODihIorn+Pe6FGJzWhXQotPv73jTaldXA==", + "license": "MIT", "dependencies": { "es-errors": "^1.3.0" }, @@ -5225,8 +5033,7 @@ }, "node_modules/es-set-tostringtag": { "version": "2.1.0", - "resolved": "https://registry.npmjs.org/es-set-tostringtag/-/es-set-tostringtag-2.1.0.tgz", - "integrity": "sha512-j6vWzfrGVfyXxge+O0x5sh6cvxAog0a/4Rdd2K36zCMV5eJ+/+tOAngRO8cODMNWbVRdVlmGZQL2YS3yR8bIUA==", + "license": "MIT", "dependencies": { "es-errors": "^1.3.0", "get-intrinsic": "^1.2.6", @@ -5239,9 +5046,8 @@ }, "node_modules/es-shim-unscopables": { "version": "1.1.0", - "resolved": "https://registry.npmjs.org/es-shim-unscopables/-/es-shim-unscopables-1.1.0.tgz", - "integrity": "sha512-d9T8ucsEhh8Bi1woXCf+TIKDIROLG5WCkxg8geBCbvk22kzwC5G2OnXVMO6FUsvQlgUUXQ2itephWDLqDzbeCw==", "dev": true, + "license": "MIT", "dependencies": { "hasown": "^2.0.2" }, @@ -5251,8 +5057,7 @@ }, "node_modules/es-to-primitive": { "version": "1.3.0", - "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.3.0.tgz", - "integrity": "sha512-w+5mJ3GuFL+NjVtJlvydShqE1eN3h3PbI7/5LAsYJP/2qtuMXjfL2LpHSRqo4b4eSF5K/DH1JXKUAHSB2UW50g==", + "license": "MIT", "dependencies": { "is-callable": "^1.2.7", "is-date-object": "^1.0.5", @@ -5266,11 +5071,10 @@ } }, "node_modules/esbuild": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.25.4.tgz", - "integrity": "sha512-8pgjLUcUjcgDg+2Q4NYXnPbo/vncAY4UmyaCm0jZevERqCHZIaWwdJHkf8XQtu4AxSKCdvrUbT0XUr1IdZzI8Q==", + "version": "0.27.2", "dev": true, "hasInstallScript": true, + "license": "MIT", "bin": { "esbuild": "bin/esbuild" }, @@ -5278,54 +5082,55 @@ "node": ">=18" }, "optionalDependencies": { - "@esbuild/aix-ppc64": "0.25.4", - "@esbuild/android-arm": "0.25.4", - "@esbuild/android-arm64": "0.25.4", - "@esbuild/android-x64": "0.25.4", - "@esbuild/darwin-arm64": "0.25.4", - "@esbuild/darwin-x64": "0.25.4", - "@esbuild/freebsd-arm64": "0.25.4", - "@esbuild/freebsd-x64": "0.25.4", - "@esbuild/linux-arm": "0.25.4", - "@esbuild/linux-arm64": "0.25.4", - "@esbuild/linux-ia32": "0.25.4", - "@esbuild/linux-loong64": "0.25.4", - "@esbuild/linux-mips64el": "0.25.4", - "@esbuild/linux-ppc64": "0.25.4", - "@esbuild/linux-riscv64": "0.25.4", - "@esbuild/linux-s390x": "0.25.4", - "@esbuild/linux-x64": "0.25.4", - "@esbuild/netbsd-arm64": "0.25.4", - "@esbuild/netbsd-x64": "0.25.4", - "@esbuild/openbsd-arm64": "0.25.4", - "@esbuild/openbsd-x64": "0.25.4", - "@esbuild/sunos-x64": "0.25.4", - "@esbuild/win32-arm64": "0.25.4", - "@esbuild/win32-ia32": "0.25.4", - "@esbuild/win32-x64": "0.25.4" + "@esbuild/aix-ppc64": "0.27.2", + "@esbuild/android-arm": "0.27.2", + "@esbuild/android-arm64": "0.27.2", + "@esbuild/android-x64": "0.27.2", + "@esbuild/darwin-arm64": "0.27.2", + "@esbuild/darwin-x64": "0.27.2", + "@esbuild/freebsd-arm64": "0.27.2", + "@esbuild/freebsd-x64": "0.27.2", + "@esbuild/linux-arm": "0.27.2", + "@esbuild/linux-arm64": "0.27.2", + "@esbuild/linux-ia32": "0.27.2", + "@esbuild/linux-loong64": "0.27.2", + "@esbuild/linux-mips64el": "0.27.2", + "@esbuild/linux-ppc64": "0.27.2", + "@esbuild/linux-riscv64": "0.27.2", + "@esbuild/linux-s390x": "0.27.2", + "@esbuild/linux-x64": "0.27.2", + "@esbuild/netbsd-arm64": "0.27.2", + "@esbuild/netbsd-x64": "0.27.2", + "@esbuild/openbsd-arm64": "0.27.2", + "@esbuild/openbsd-x64": "0.27.2", + "@esbuild/openharmony-arm64": "0.27.2", + "@esbuild/sunos-x64": "0.27.2", + "@esbuild/win32-arm64": "0.27.2", + "@esbuild/win32-ia32": "0.27.2", + "@esbuild/win32-x64": "0.27.2" } }, "node_modules/escalade": { "version": "3.2.0", - "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.2.0.tgz", - "integrity": "sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA==", + "license": "MIT", "engines": { "node": ">=6" } }, "node_modules/escape-goat": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/escape-goat/-/escape-goat-2.1.1.tgz", - "integrity": "sha512-8/uIhbG12Csjy2JEW7D9pHbreaVaS/OpN3ycnyvElTdwM5n6GY6W6e2IPemfvGZeUMqZ9A/3GqIZMgKnBhAw/Q==", + "version": "4.0.0", + "license": "MIT", "engines": { - "node": ">=8" + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/escape-string-regexp": { "version": "4.0.0", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", - "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==", "dev": true, + "license": "MIT", "engines": { "node": ">=10" }, @@ -5335,10 +5140,9 @@ }, "node_modules/eslint": { "version": "8.57.1", - "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.57.1.tgz", - "integrity": "sha512-ypowyDxpVSYpkXr9WPv2PAZCtNip1Mv5KTW0SCurXv/9iOpcrH9PaqUElksqEB6pChqHGDRCFTyrZlGhnLNGiA==", - "deprecated": "This version is no longer supported. Please see https://eslint.org/version-support for other options.", "dev": true, + "license": "MIT", + "peer": true, "dependencies": { "@eslint-community/eslint-utils": "^4.2.0", "@eslint-community/regexpp": "^4.6.1", @@ -5390,9 +5194,7 @@ } }, "node_modules/eslint-config-prettier": { - "version": "10.1.5", - "resolved": "https://registry.npmjs.org/eslint-config-prettier/-/eslint-config-prettier-10.1.5.tgz", - "integrity": "sha512-zc1UmCpNltmVY34vuLRV61r1K27sWuX39E+uyUnY8xS2Bex88VV9cugG+UZbRSRGtGyFboj+D8JODyme1plMpw==", + "version": "10.1.8", "dev": true, "license": "MIT", "bin": { @@ -5407,9 +5209,8 @@ }, "node_modules/eslint-plugin-jsx-a11y": { "version": "6.10.2", - "resolved": "https://registry.npmjs.org/eslint-plugin-jsx-a11y/-/eslint-plugin-jsx-a11y-6.10.2.tgz", - "integrity": "sha512-scB3nz4WmG75pV8+3eRUQOHZlNSUhFNq37xnpgRkCCELU3XMvXAxLk1eqWWyE22Ki4Q01Fnsw9BA3cJHDPgn2Q==", "dev": true, + "license": "MIT", "dependencies": { "aria-query": "^5.3.2", "array-includes": "^3.1.8", @@ -5436,18 +5237,16 @@ }, "node_modules/eslint-plugin-jsx-a11y/node_modules/aria-query": { "version": "5.3.2", - "resolved": "https://registry.npmjs.org/aria-query/-/aria-query-5.3.2.tgz", - "integrity": "sha512-COROpnaoap1E2F000S62r6A60uHZnmlvomhfyT2DlTcrY1OrBKn2UhH7qn5wTC9zMvD0AY7csdPSNwKP+7WiQw==", "dev": true, + "license": "Apache-2.0", "engines": { "node": ">= 0.4" } }, "node_modules/eslint-plugin-jsx-a11y/node_modules/brace-expansion": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", - "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "version": "1.1.12", "dev": true, + "license": "MIT", "dependencies": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" @@ -5455,9 +5254,8 @@ }, "node_modules/eslint-plugin-jsx-a11y/node_modules/minimatch": { "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", "dev": true, + "license": "ISC", "dependencies": { "brace-expansion": "^1.1.7" }, @@ -5467,9 +5265,8 @@ }, "node_modules/eslint-plugin-react": { "version": "7.37.5", - "resolved": "https://registry.npmjs.org/eslint-plugin-react/-/eslint-plugin-react-7.37.5.tgz", - "integrity": "sha512-Qteup0SqU15kdocexFNAJMvCJEfa2xUKNV4CC1xsVMrIIqEy3SQ/rqyxCWNzfrd3/ldy6HMlD2e0JDVpDg2qIA==", "dev": true, + "license": "MIT", "dependencies": { "array-includes": "^3.1.8", "array.prototype.findlast": "^1.2.5", @@ -5499,9 +5296,8 @@ }, "node_modules/eslint-plugin-react-hooks": { "version": "5.2.0", - "resolved": "https://registry.npmjs.org/eslint-plugin-react-hooks/-/eslint-plugin-react-hooks-5.2.0.tgz", - "integrity": "sha512-+f15FfK64YQwZdJNELETdn5ibXEUQmW1DZL6KXhNnc2heoy/sg9VJJeT7n8TlMWouzWqSWavFkIhHyIbIAEapg==", "dev": true, + "license": "MIT", "engines": { "node": ">=10" }, @@ -5510,19 +5306,17 @@ } }, "node_modules/eslint-plugin-react-refresh": { - "version": "0.4.20", - "resolved": "https://registry.npmjs.org/eslint-plugin-react-refresh/-/eslint-plugin-react-refresh-0.4.20.tgz", - "integrity": "sha512-XpbHQ2q5gUF8BGOX4dHe+71qoirYMhApEPZ7sfhF/dNnOF1UXnCMGZf79SFTBO7Bz5YEIT4TMieSlJBWhP9WBA==", + "version": "0.4.26", "dev": true, + "license": "MIT", "peerDependencies": { "eslint": ">=8.40" } }, "node_modules/eslint-plugin-react/node_modules/brace-expansion": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", - "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "version": "1.1.12", "dev": true, + "license": "MIT", "dependencies": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" @@ -5530,9 +5324,8 @@ }, "node_modules/eslint-plugin-react/node_modules/doctrine": { "version": "2.1.0", - "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-2.1.0.tgz", - "integrity": "sha512-35mSku4ZXK0vfCuHEDAwt55dg2jNajHZ1odvF+8SSr82EsZY4QmXfuWso8oEd8zRhVObSN18aM0CjSdoBX7zIw==", "dev": true, + "license": "Apache-2.0", "dependencies": { "esutils": "^2.0.2" }, @@ -5542,9 +5335,8 @@ }, "node_modules/eslint-plugin-react/node_modules/minimatch": { "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", "dev": true, + "license": "ISC", "dependencies": { "brace-expansion": "^1.1.7" }, @@ -5554,18 +5346,16 @@ }, "node_modules/eslint-plugin-react/node_modules/semver": { "version": "6.3.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", - "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", "dev": true, + "license": "ISC", "bin": { "semver": "bin/semver.js" } }, "node_modules/eslint-scope": { "version": "7.2.2", - "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-7.2.2.tgz", - "integrity": "sha512-dOt21O7lTMhDM+X9mB4GX+DZrZtCUJPL/wlcTqxyrx5IvO0IYtILdtrQGQp+8n5S0gwSVmOf9NQrjMOgfQZlIg==", "dev": true, + "license": "BSD-2-Clause", "dependencies": { "esrecurse": "^4.3.0", "estraverse": "^5.2.0" @@ -5579,9 +5369,8 @@ }, "node_modules/eslint-visitor-keys": { "version": "3.4.3", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.4.3.tgz", - "integrity": "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag==", "dev": true, + "license": "Apache-2.0", "engines": { "node": "^12.22.0 || ^14.17.0 || >=16.0.0" }, @@ -5590,35 +5379,18 @@ } }, "node_modules/eslint/node_modules/brace-expansion": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", - "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "version": "1.1.12", "dev": true, + "license": "MIT", "dependencies": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" } }, - "node_modules/eslint/node_modules/globals": { - "version": "13.24.0", - "resolved": "https://registry.npmjs.org/globals/-/globals-13.24.0.tgz", - "integrity": "sha512-AhO5QUcj8llrbG09iWhPU2B204J1xnPeL8kQmVorSsy+Sjj1sk8gIyh6cUocGmH4L0UuhAJy+hJMRA4mgA4mFQ==", - "dev": true, - "dependencies": { - "type-fest": "^0.20.2" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/eslint/node_modules/minimatch": { "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", "dev": true, + "license": "ISC", "dependencies": { "brace-expansion": "^1.1.7" }, @@ -5626,23 +5398,10 @@ "node": "*" } }, - "node_modules/eslint/node_modules/type-fest": { - "version": "0.20.2", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz", - "integrity": "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==", - "dev": true, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/espree": { "version": "9.6.1", - "resolved": "https://registry.npmjs.org/espree/-/espree-9.6.1.tgz", - "integrity": "sha512-oruZaFkjorTpF32kDSI5/75ViwGeZginGGy2NoOSg3Q9bnwlnmDm4HLnkl0RE3n+njDXR037aY1+x58Z/zFdwQ==", "dev": true, + "license": "BSD-2-Clause", "dependencies": { "acorn": "^8.9.0", "acorn-jsx": "^5.3.2", @@ -5655,11 +5414,21 @@ "url": "https://opencollective.com/eslint" } }, + "node_modules/esprima": { + "version": "4.0.1", + "license": "BSD-2-Clause", + "bin": { + "esparse": "bin/esparse.js", + "esvalidate": "bin/esvalidate.js" + }, + "engines": { + "node": ">=4" + } + }, "node_modules/esquery": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.6.0.tgz", - "integrity": "sha512-ca9pw9fomFcKPvFLXhBKUK90ZvGibiGOvRJNbjljY7s7uq/5YO4BOzcYtJqExdx99rF6aAcnRxHmcUHcz6sQsg==", + "version": "1.7.0", "dev": true, + "license": "BSD-3-Clause", "dependencies": { "estraverse": "^5.1.0" }, @@ -5669,9 +5438,8 @@ }, "node_modules/esrecurse": { "version": "4.3.0", - "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz", - "integrity": "sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==", "dev": true, + "license": "BSD-2-Clause", "dependencies": { "estraverse": "^5.2.0" }, @@ -5681,53 +5449,46 @@ }, "node_modules/estraverse": { "version": "5.3.0", - "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz", - "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==", "dev": true, + "license": "BSD-2-Clause", "engines": { "node": ">=4.0" } }, "node_modules/estree-walker": { "version": "3.0.3", - "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-3.0.3.tgz", - "integrity": "sha512-7RUKfXgSMMkzt6ZuXmqapOurLGPPfgj6l9uRZ7lRGolvk0y2yocc35LdcxKC5PQZdn2DMqioAQ2NoWcrTKmm6g==", "dev": true, + "license": "MIT", "dependencies": { "@types/estree": "^1.0.0" } }, "node_modules/esutils": { "version": "2.0.3", - "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz", - "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==", + "license": "BSD-2-Clause", "engines": { "node": ">=0.10.0" } }, "node_modules/eventemitter3": { "version": "3.1.2", - "resolved": "https://registry.npmjs.org/eventemitter3/-/eventemitter3-3.1.2.tgz", - "integrity": "sha512-tvtQIeLVHjDkJYnzf2dgVMxfuSGJeM/7UCG17TT4EumTfNtF+0nebF/4zWOIkCreAbtNqhGEboB6BWrwqNaw4Q==" + "license": "MIT" }, "node_modules/exenv": { "version": "1.2.2", - "resolved": "https://registry.npmjs.org/exenv/-/exenv-1.2.2.tgz", - "integrity": "sha512-Z+ktTxTwv9ILfgKCk32OX3n/doe+OcLTRtqK9pcL+JsP3J1/VW8Uvl4ZjLlKqeW4rzK4oesDOGMEMRIZqtP4Iw==" + "license": "BSD-3-Clause" }, "node_modules/expect-type": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/expect-type/-/expect-type-1.2.1.tgz", - "integrity": "sha512-/kP8CAwxzLVEeFrMm4kMmy4CCDlpipyA7MYLVrdJIkV0fYF0UaigQHRsxHiuY/GEea+bh4KSv3TIlgr+2UL6bw==", + "version": "1.3.0", "dev": true, + "license": "Apache-2.0", "engines": { "node": ">=12.0.0" } }, "node_modules/external-editor": { "version": "3.1.0", - "resolved": "https://registry.npmjs.org/external-editor/-/external-editor-3.1.0.tgz", - "integrity": "sha512-hMQ4CX1p1izmuLYyZqLMO/qGNw10wSv9QDCPfzXfyFrOaCSSoRfqE1Kf1s5an66J5JZC62NewG+mK49jOCtQew==", + "license": "MIT", "dependencies": { "chardet": "^0.7.0", "iconv-lite": "^0.4.24", @@ -5739,8 +5500,7 @@ }, "node_modules/external-editor/node_modules/iconv-lite": { "version": "0.4.24", - "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", - "integrity": "sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==", + "license": "MIT", "dependencies": { "safer-buffer": ">= 2.1.2 < 3" }, @@ -5750,14 +5510,12 @@ }, "node_modules/fast-deep-equal": { "version": "3.1.3", - "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", - "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==" + "license": "MIT" }, "node_modules/fast-glob": { "version": "3.3.3", - "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.3.tgz", - "integrity": "sha512-7MptL8U0cqcFdzIzwOTHoilX9x5BrNqye7Z/LuC7kCMRio1EMSyqRK3BEAUD7sXRq4iT4AzTVuZdhgQ2TCvYLg==", "dev": true, + "license": "MIT", "dependencies": { "@nodelib/fs.stat": "^2.0.2", "@nodelib/fs.walk": "^1.2.3", @@ -5771,9 +5529,8 @@ }, "node_modules/fast-glob/node_modules/glob-parent": { "version": "5.1.2", - "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", - "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", "dev": true, + "license": "ISC", "dependencies": { "is-glob": "^4.0.1" }, @@ -5783,19 +5540,15 @@ }, "node_modules/fast-json-stable-stringify": { "version": "2.1.0", - "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", - "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==" + "license": "MIT" }, "node_modules/fast-levenshtein": { "version": "2.0.6", - "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz", - "integrity": "sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/fast-uri": { - "version": "3.0.6", - "resolved": "https://registry.npmjs.org/fast-uri/-/fast-uri-3.0.6.tgz", - "integrity": "sha512-Atfo14OibSv5wAp4VWNsFYE1AchQRTv9cBGWET4pZWHzYshFSS9NQI6I57rdKn9croWVMbYFbLhJ+yJvmZIIHw==", + "version": "3.1.0", "funding": [ { "type": "github", @@ -5805,21 +5558,20 @@ "type": "opencollective", "url": "https://opencollective.com/fastify" } - ] + ], + "license": "BSD-3-Clause" }, "node_modules/fastq": { - "version": "1.19.1", - "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.19.1.tgz", - "integrity": "sha512-GwLTyxkCXjXbxqIhTsMI2Nui8huMPtnxg7krajPJAjnEG/iiOS7i+zCtWGZR9G0NBKbXKh6X9m9UIsYX/N6vvQ==", + "version": "1.20.1", "dev": true, + "license": "ISC", "dependencies": { "reusify": "^1.0.4" } }, "node_modules/figures": { "version": "3.2.0", - "resolved": "https://registry.npmjs.org/figures/-/figures-3.2.0.tgz", - "integrity": "sha512-yaduQFRKLXYOGgEn6AZau90j3ggSOyiqXU0F9JZfeXYhNa+Jk4X+s45A2zg5jns87GAFa34BBm2kXw4XpNcbdg==", + "license": "MIT", "dependencies": { "escape-string-regexp": "^1.0.5" }, @@ -5832,17 +5584,15 @@ }, "node_modules/figures/node_modules/escape-string-regexp": { "version": "1.0.5", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", - "integrity": "sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==", + "license": "MIT", "engines": { "node": ">=0.8.0" } }, "node_modules/file-entry-cache": { "version": "6.0.1", - "resolved": "https://registry.npmjs.org/file-entry-cache/-/file-entry-cache-6.0.1.tgz", - "integrity": "sha512-7Gps/XWymbLk2QLYK4NzpMOrYjMhdIxXuIvy2QBsLE6ljuodKvdkWs/cpyJJ3CVIVpH0Oi1Hvg1ovbMzLdFBBg==", "dev": true, + "license": "MIT", "dependencies": { "flat-cache": "^3.0.4" }, @@ -5852,8 +5602,7 @@ }, "node_modules/file-selector": { "version": "0.1.19", - "resolved": "https://registry.npmjs.org/file-selector/-/file-selector-0.1.19.tgz", - "integrity": "sha512-kCWw3+Aai8Uox+5tHCNgMFaUdgidxvMnLWO6fM5sZ0hA2wlHP5/DHGF0ECe84BiB95qdJbKNEJhWKVDvMN+JDQ==", + "license": "MIT", "dependencies": { "tslib": "^2.0.1" }, @@ -5863,16 +5612,14 @@ }, "node_modules/filelist": { "version": "1.0.4", - "resolved": "https://registry.npmjs.org/filelist/-/filelist-1.0.4.tgz", - "integrity": "sha512-w1cEuf3S+DrLCQL7ET6kz+gmlJdbq9J7yXCSjK/OZCPA+qEN1WyF4ZAf0YYJa4/shHJra2t/d/r8SV4Ji+x+8Q==", + "license": "Apache-2.0", "dependencies": { "minimatch": "^5.0.1" } }, "node_modules/filelist/node_modules/minimatch": { "version": "5.1.6", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.6.tgz", - "integrity": "sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g==", + "license": "ISC", "dependencies": { "brace-expansion": "^2.0.1" }, @@ -5882,8 +5629,7 @@ }, "node_modules/fill-range": { "version": "7.1.1", - "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", - "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", + "license": "MIT", "dependencies": { "to-regex-range": "^5.0.1" }, @@ -5893,8 +5639,8 @@ }, "node_modules/final-form": { "version": "4.20.10", - "resolved": "https://registry.npmjs.org/final-form/-/final-form-4.20.10.tgz", - "integrity": "sha512-TL48Pi1oNHeMOHrKv1bCJUrWZDcD3DIG6AGYVNOnyZPr7Bd/pStN0pL+lfzF5BNoj/FclaoiaLenk4XUIFVYng==", + "license": "MIT", + "peer": true, "dependencies": { "@babel/runtime": "^7.10.0" }, @@ -5908,17 +5654,16 @@ }, "node_modules/final-form-arrays": { "version": "3.1.0", - "resolved": "https://registry.npmjs.org/final-form-arrays/-/final-form-arrays-3.1.0.tgz", - "integrity": "sha512-TWBvun+AopgBLw9zfTFHBllnKMVNEwCEyDawphPuBGGqNsuhGzhT7yewHys64KFFwzIs6KEteGLpKOwvTQEscQ==", + "license": "MIT", + "peer": true, "peerDependencies": { "final-form": "^4.20.8" } }, "node_modules/find-up": { "version": "5.0.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-5.0.0.tgz", - "integrity": "sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng==", "dev": true, + "license": "MIT", "dependencies": { "locate-path": "^6.0.0", "path-exists": "^4.0.0" @@ -5932,9 +5677,8 @@ }, "node_modules/flat-cache": { "version": "3.2.0", - "resolved": "https://registry.npmjs.org/flat-cache/-/flat-cache-3.2.0.tgz", - "integrity": "sha512-CYcENa+FtcUKLmhhqyctpclsq7QF38pKjZHsGNiSQF5r4FtoKDWabFDl3hzaEQMvT1LHEysw5twgLvpYYb4vbw==", "dev": true, + "license": "MIT", "dependencies": { "flatted": "^3.2.9", "keyv": "^4.5.3", @@ -5946,14 +5690,12 @@ }, "node_modules/flatted": { "version": "3.3.3", - "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.3.3.tgz", - "integrity": "sha512-GX+ysw4PBCz0PzosHDepZGANEuFCMLrnRTiEy9McGjmkCQYwRq4A/X786G/fjM/+OjsWSU1ZrY5qyARZmO/uwg==", - "dev": true + "dev": true, + "license": "ISC" }, "node_modules/for-each": { "version": "0.3.5", - "resolved": "https://registry.npmjs.org/for-each/-/for-each-0.3.5.tgz", - "integrity": "sha512-dKx12eRCVIzqCxFGplyFKJMPvLEWgmNtUrpTiJIR5u97zEhRG8ySrtboPHZXx7daLxQVrl643cTzbab2tkQjxg==", + "license": "MIT", "dependencies": { "is-callable": "^1.2.7" }, @@ -5966,9 +5708,7 @@ }, "node_modules/foreground-child": { "version": "3.3.1", - "resolved": "https://registry.npmjs.org/foreground-child/-/foreground-child-3.3.1.tgz", - "integrity": "sha512-gIXjKqtFuWEgzFRJA9WCQeSJLZDjgJUOMCMzxtvFq/37KojM1BFGufqsCy0r4qSQmYLsZYMeyRqzIWOMup03sw==", - "dev": true, + "license": "ISC", "dependencies": { "cross-spawn": "^7.0.6", "signal-exit": "^4.0.1" @@ -5982,9 +5722,7 @@ }, "node_modules/foreground-child/node_modules/signal-exit": { "version": "4.1.0", - "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz", - "integrity": "sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw==", - "dev": true, + "license": "ISC", "engines": { "node": ">=14" }, @@ -5994,8 +5732,7 @@ }, "node_modules/fs-extra": { "version": "9.1.0", - "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-9.1.0.tgz", - "integrity": "sha512-hcg3ZmepS30/7BSFqRvoo3DOMQu7IjqxO5nCDt+zM9XWjb33Wg7ziNT+Qvqbuc3+gWpzO02JubVyk2G4Zvo1OQ==", + "license": "MIT", "dependencies": { "at-least-node": "^1.0.0", "graceful-fs": "^4.2.0", @@ -6008,14 +5745,12 @@ }, "node_modules/fs.realpath": { "version": "1.0.0", - "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", - "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==" + "dev": true, + "license": "ISC" }, "node_modules/fsevents": { "version": "2.3.3", - "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", - "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", - "hasInstallScript": true, + "license": "MIT", "optional": true, "os": [ "darwin" @@ -6026,16 +5761,14 @@ }, "node_modules/function-bind": { "version": "1.1.2", - "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", - "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==", + "license": "MIT", "funding": { "url": "https://github.com/sponsors/ljharb" } }, "node_modules/function.prototype.name": { "version": "1.1.8", - "resolved": "https://registry.npmjs.org/function.prototype.name/-/function.prototype.name-1.1.8.tgz", - "integrity": "sha512-e5iwyodOHhbMr/yNrc7fDYG4qlbIvI5gajyzPnb5TCwyhjApznQh1BMFou9b30SevY43gCJKXycoCBjMbsuW0Q==", + "license": "MIT", "dependencies": { "call-bind": "^1.0.8", "call-bound": "^1.0.3", @@ -6053,24 +5786,38 @@ }, "node_modules/functions-have-names": { "version": "1.2.3", - "resolved": "https://registry.npmjs.org/functions-have-names/-/functions-have-names-1.2.3.tgz", - "integrity": "sha512-xckBUXyTIqT97tq2x2AMb+g163b5JFysYk0x4qxNFwbfQkmNZoiRHb6sPzI9/QV33WeuvVYBUIiD4NzNIyqaRQ==", + "license": "MIT", "funding": { "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/generator-function": { + "version": "2.0.1", + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, "node_modules/gensync": { "version": "1.0.0-beta.2", - "resolved": "https://registry.npmjs.org/gensync/-/gensync-1.0.0-beta.2.tgz", - "integrity": "sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg==", + "license": "MIT", "engines": { "node": ">=6.9.0" } }, + "node_modules/get-east-asian-width": { + "version": "1.4.0", + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/get-intrinsic": { "version": "1.3.0", - "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.3.0.tgz", - "integrity": "sha512-9fSjSaos/fRIVIp+xSJlE6lfwhES7LNtKaCBIamHsjr2na1BiABJPo0mOjjz8GJDURarmCPGqaiVg5mfjb98CQ==", + "license": "MIT", "dependencies": { "call-bind-apply-helpers": "^1.0.2", "es-define-property": "^1.0.1", @@ -6092,18 +5839,15 @@ }, "node_modules/get-node-dimensions": { "version": "1.2.1", - "resolved": "https://registry.npmjs.org/get-node-dimensions/-/get-node-dimensions-1.2.1.tgz", - "integrity": "sha512-2MSPMu7S1iOTL+BOa6K1S62hB2zUAYNF/lV0gSVlOaacd087lc6nR1H1r0e3B1CerTo+RceOmi1iJW+vp21xcQ==" + "license": "MIT" }, "node_modules/get-own-enumerable-property-symbols": { "version": "3.0.2", - "resolved": "https://registry.npmjs.org/get-own-enumerable-property-symbols/-/get-own-enumerable-property-symbols-3.0.2.tgz", - "integrity": "sha512-I0UBV/XOz1XkIJHEUDMZAbzCThU/H8DxmSfmdGcKPnVhu2VfFqr34jr9777IyaTYvxjedWhqVIilEDsCdP5G6g==" + "license": "ISC" }, "node_modules/get-proto": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/get-proto/-/get-proto-1.0.1.tgz", - "integrity": "sha512-sTSfBjoXBp89JvIKIefqw7U2CCebsc74kiY6awiGogKtoSGbgjYE/G/+l9sF3MWFPNc9IcoOC4ODfKHfxFmp0g==", + "license": "MIT", "dependencies": { "dunder-proto": "^1.0.1", "es-object-atoms": "^1.0.0" @@ -6112,21 +5856,9 @@ "node": ">= 0.4" } }, - "node_modules/get-stream": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-4.1.0.tgz", - "integrity": "sha512-GMat4EJ5161kIy2HevLlr4luNjBgvmj413KaQA7jt4V8B4RDsfpHk7WQ9GVqfYyyx8OS/L66Kox+rJRNklLK7w==", - "dependencies": { - "pump": "^3.0.0" - }, - "engines": { - "node": ">=6" - } - }, "node_modules/get-symbol-description": { "version": "1.1.0", - "resolved": "https://registry.npmjs.org/get-symbol-description/-/get-symbol-description-1.1.0.tgz", - "integrity": "sha512-w9UMqWwJxHNOvoNzSJ2oPF5wvYcvP7jUvYzhp67yEhTi17ZDBBC1z9pTdGuzjD+EFIqLSYRweZjqfiPzQ06Ebg==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.3", "es-errors": "^1.3.0", @@ -6141,9 +5873,8 @@ }, "node_modules/glob": { "version": "7.2.3", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", - "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", - "deprecated": "Glob versions prior to v9 are no longer supported", + "dev": true, + "license": "ISC", "dependencies": { "fs.realpath": "^1.0.0", "inflight": "^1.0.4", @@ -6161,9 +5892,8 @@ }, "node_modules/glob-parent": { "version": "6.0.2", - "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-6.0.2.tgz", - "integrity": "sha512-XxwI8EOhVQgWp6iDL+3b0r86f4d6AX6zSU55HfB4ydCEuXLXc5FcYeOu+nnGftS4TEju/11rt4KJPTMgbfmv4A==", "dev": true, + "license": "ISC", "dependencies": { "is-glob": "^4.0.3" }, @@ -6172,9 +5902,9 @@ } }, "node_modules/glob/node_modules/brace-expansion": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", - "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "version": "1.1.12", + "dev": true, + "license": "MIT", "dependencies": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" @@ -6182,8 +5912,8 @@ }, "node_modules/glob/node_modules/minimatch": { "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", + "dev": true, + "license": "ISC", "dependencies": { "brace-expansion": "^1.1.7" }, @@ -6191,12 +5921,25 @@ "node": "*" } }, - "node_modules/global-dirs": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/global-dirs/-/global-dirs-2.1.0.tgz", - "integrity": "sha512-MG6kdOUh/xBnyo9cJFeIKkLEc1AyFq42QTU4XiX51i2NEdxLxLWXIjEjmqKeSuKR7pAZjTqUVoT2b2huxVLgYQ==", + "node_modules/global-directory": { + "version": "4.0.1", + "license": "MIT", "dependencies": { - "ini": "1.3.7" + "ini": "4.1.1" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/globals": { + "version": "13.24.0", + "dev": true, + "license": "MIT", + "dependencies": { + "type-fest": "^0.20.2" }, "engines": { "node": ">=8" @@ -6205,18 +5948,9 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/globals": { - "version": "11.12.0", - "resolved": "https://registry.npmjs.org/globals/-/globals-11.12.0.tgz", - "integrity": "sha512-WOBp/EEGUiIsJSp7wcv/y6MO+lV9UoncWqxuFfm8eBwzWNgyfBd6Gz+IeKQ9jCmyhoH99g15M3T+QaVHFjizVA==", - "engines": { - "node": ">=4" - } - }, "node_modules/globalthis": { "version": "1.0.4", - "resolved": "https://registry.npmjs.org/globalthis/-/globalthis-1.0.4.tgz", - "integrity": "sha512-DpLKbNU4WylpxJykQujfCcwYWiV/Jhm50Goo0wrVILAv5jOr9d+H+UR3PhSCD2rCCEIg0uc+G+muBTwD54JhDQ==", + "license": "MIT", "dependencies": { "define-properties": "^1.2.1", "gopd": "^1.0.1" @@ -6230,9 +5964,8 @@ }, "node_modules/globby": { "version": "11.1.0", - "resolved": "https://registry.npmjs.org/globby/-/globby-11.1.0.tgz", - "integrity": "sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g==", "dev": true, + "license": "MIT", "dependencies": { "array-union": "^2.1.0", "dir-glob": "^3.0.1", @@ -6250,8 +5983,7 @@ }, "node_modules/gopd": { "version": "1.2.0", - "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.2.0.tgz", - "integrity": "sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg==", + "license": "MIT", "engines": { "node": ">= 0.4" }, @@ -6259,63 +5991,42 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/got": { - "version": "9.6.0", - "resolved": "https://registry.npmjs.org/got/-/got-9.6.0.tgz", - "integrity": "sha512-R7eWptXuGYxwijs0eV+v3o6+XH1IqVK8dJOEecQfTmkncw9AV4dcw/Dhxi8MdlqPthxxpZyizMzyg8RTmEsG+Q==", - "dependencies": { - "@sindresorhus/is": "^0.14.0", - "@szmarczak/http-timer": "^1.1.2", - "cacheable-request": "^6.0.0", - "decompress-response": "^3.3.0", - "duplexer3": "^0.1.4", - "get-stream": "^4.1.0", - "lowercase-keys": "^1.0.1", - "mimic-response": "^1.0.1", - "p-cancelable": "^1.0.0", - "to-readable-stream": "^1.0.0", - "url-parse-lax": "^3.0.0" - }, - "engines": { - "node": ">=8.6" - } - }, "node_modules/graceful-fs": { "version": "4.2.11", - "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz", - "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==" + "license": "ISC" }, "node_modules/graphemer": { "version": "1.4.0", - "resolved": "https://registry.npmjs.org/graphemer/-/graphemer-1.4.0.tgz", - "integrity": "sha512-EtKwoO6kxCL9WO5xipiHTZlSzBm7WLT627TqC/uVRd0HKmq8NXyebnNYxDoBi7wt8eTWrUrKXCOVaFq9x1kgag==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/happy-dom": { - "version": "17.4.7", - "resolved": "https://registry.npmjs.org/happy-dom/-/happy-dom-17.4.7.tgz", - "integrity": "sha512-NZypxadhCiV5NT4A+Y86aQVVKQ05KDmueja3sz008uJfDRwz028wd0aTiJPwo4RQlvlz0fznkEEBBCHVNWc08g==", + "version": "20.3.3", "dev": true, + "license": "MIT", + "peer": true, "dependencies": { - "webidl-conversions": "^7.0.0", - "whatwg-mimetype": "^3.0.0" + "@types/node": ">=20.0.0", + "@types/whatwg-mimetype": "^3.0.2", + "@types/ws": "^8.18.1", + "entities": "^4.5.0", + "whatwg-mimetype": "^3.0.0", + "ws": "^8.18.3" }, "engines": { - "node": ">=18.0.0" + "node": ">=20.0.0" } }, "node_modules/hard-rejection": { "version": "2.1.0", - "resolved": "https://registry.npmjs.org/hard-rejection/-/hard-rejection-2.1.0.tgz", - "integrity": "sha512-VIZB+ibDhx7ObhAe7OVtoEbuP4h/MuOTHJ+J8h/eBXotJYl0fBgR72xDFCKgIh22OJZIOVNxBMWuhAr10r8HdA==", + "license": "MIT", "engines": { "node": ">=6" } }, "node_modules/has-bigints": { "version": "1.1.0", - "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.1.0.tgz", - "integrity": "sha512-R3pbpkcIqv2Pm3dUwgjclDRVmWpTJW2DcMzcIhEXEx1oh/CEMObMm3KLmRJOdvhM7o4uQBnwr8pzRK2sJWIqfg==", + "license": "MIT", "engines": { "node": ">= 0.4" }, @@ -6325,16 +6036,14 @@ }, "node_modules/has-flag": { "version": "4.0.0", - "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", - "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "license": "MIT", "engines": { "node": ">=8" } }, "node_modules/has-property-descriptors": { "version": "1.0.2", - "resolved": "https://registry.npmjs.org/has-property-descriptors/-/has-property-descriptors-1.0.2.tgz", - "integrity": "sha512-55JNKuIW+vq4Ke1BjOTjM2YctQIvCT7GFzHwmfZPGo5wnrgkid0YQtnAleFSqumZm4az3n2BS+erby5ipJdgrg==", + "license": "MIT", "dependencies": { "es-define-property": "^1.0.0" }, @@ -6344,8 +6053,7 @@ }, "node_modules/has-proto": { "version": "1.2.0", - "resolved": "https://registry.npmjs.org/has-proto/-/has-proto-1.2.0.tgz", - "integrity": "sha512-KIL7eQPfHQRC8+XluaIw7BHUwwqL19bQn4hzNgdr+1wXoU0KKj6rufu47lhY7KbJR2C6T6+PfyN0Ea7wkSS+qQ==", + "license": "MIT", "dependencies": { "dunder-proto": "^1.0.0" }, @@ -6358,8 +6066,7 @@ }, "node_modules/has-symbols": { "version": "1.1.0", - "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.1.0.tgz", - "integrity": "sha512-1cDNdwJ2Jaohmb3sg4OmKaMBwuC48sYni5HUw2DvsC8LjGTLK9h+eb1X6RyuOHe4hT0ULCW68iomhjUoKUqlPQ==", + "license": "MIT", "engines": { "node": ">= 0.4" }, @@ -6369,8 +6076,7 @@ }, "node_modules/has-tostringtag": { "version": "1.0.2", - "resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.2.tgz", - "integrity": "sha512-NqADB8VjPFLM2V0VvHUewwwsw0ZWBaIdgo+ieHtK3hasLz4qeCRjYcqfB6AQrBggRKppKF8L52/VqdVsO47Dlw==", + "license": "MIT", "dependencies": { "has-symbols": "^1.0.3" }, @@ -6381,18 +6087,9 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/has-yarn": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/has-yarn/-/has-yarn-2.1.0.tgz", - "integrity": "sha512-UqBRqi4ju7T+TqGNdqAO0PaSVGsDGJUBQvk9eUWNGRY1CFGDzYhLWoM7JQEemnlvVcv/YEmc2wNW8BC24EnUsw==", - "engines": { - "node": ">=8" - } - }, "node_modules/hasown": { "version": "2.0.2", - "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", - "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==", + "license": "MIT", "dependencies": { "function-bind": "^1.1.2" }, @@ -6402,8 +6099,8 @@ }, "node_modules/history": { "version": "4.10.1", - "resolved": "https://registry.npmjs.org/history/-/history-4.10.1.tgz", - "integrity": "sha512-36nwAD620w12kuzPAsyINPWJqlNbij+hpK1k9XRloDtym8mxzGYl2c17LnV6IAGB2Dmg4tEa7G7DlawS0+qjew==", + "license": "MIT", + "peer": true, "dependencies": { "@babel/runtime": "^7.1.2", "loose-envify": "^1.2.0", @@ -6415,27 +6112,23 @@ }, "node_modules/hoist-non-react-statics": { "version": "3.3.2", - "resolved": "https://registry.npmjs.org/hoist-non-react-statics/-/hoist-non-react-statics-3.3.2.tgz", - "integrity": "sha512-/gGivxi8JPKWNm/W0jSmzcMPpfpPLc3dY/6GxhX2hQ9iGj3aDfklV4ET7NjKpSinLpJ5vafa9iiGIEZg10SfBw==", + "license": "BSD-3-Clause", "dependencies": { "react-is": "^16.7.0" } }, "node_modules/hoist-non-react-statics/node_modules/react-is": { "version": "16.13.1", - "resolved": "https://registry.npmjs.org/react-is/-/react-is-16.13.1.tgz", - "integrity": "sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==" + "license": "MIT" }, "node_modules/hosted-git-info": { "version": "2.8.9", - "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-2.8.9.tgz", - "integrity": "sha512-mxIDAb9Lsm6DoOJ7xH+5+X4y1LU/4Hi50L9C5sIswK3JzULS4bwk1FvjdBgvYR4bzT4tuUQiC15FE2f5HbLvYw==" + "license": "ISC" }, "node_modules/html-encoding-sniffer": { "version": "4.0.0", - "resolved": "https://registry.npmjs.org/html-encoding-sniffer/-/html-encoding-sniffer-4.0.0.tgz", - "integrity": "sha512-Y22oTqIU4uuPgEemfz7NDJz6OeKf12Lsu+QC+s3BVpda64lTiMYCyGwg5ki4vFxkMwQdeZDl2adZoqUgdFuTgQ==", "dev": true, + "license": "MIT", "dependencies": { "whatwg-encoding": "^3.1.1" }, @@ -6445,20 +6138,13 @@ }, "node_modules/html-escaper": { "version": "2.0.2", - "resolved": "https://registry.npmjs.org/html-escaper/-/html-escaper-2.0.2.tgz", - "integrity": "sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg==", - "dev": true - }, - "node_modules/http-cache-semantics": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/http-cache-semantics/-/http-cache-semantics-4.2.0.tgz", - "integrity": "sha512-dTxcvPXqPvXBQpq5dUr6mEMJX4oIEFv6bwom3FDwKRDsuIjjJGANqhBuoAn9c1RQJIdAKav33ED65E2ys+87QQ==" + "dev": true, + "license": "MIT" }, "node_modules/http-proxy-agent": { "version": "7.0.2", - "resolved": "https://registry.npmjs.org/http-proxy-agent/-/http-proxy-agent-7.0.2.tgz", - "integrity": "sha512-T1gkAiYYDWYx3V5Bmyu7HcfcvL7mUrTWiM6yOfa3PIphViJ/gFPbvidQ+veqSOHci/PxBcDabeUNCzpOODJZig==", "dev": true, + "license": "MIT", "dependencies": { "agent-base": "^7.1.0", "debug": "^4.3.4" @@ -6469,9 +6155,8 @@ }, "node_modules/https-proxy-agent": { "version": "7.0.6", - "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-7.0.6.tgz", - "integrity": "sha512-vK9P5/iUfdl95AI+JVyUuIcVtd4ofvtrOr3HNtM2yxC9bnMbEdp3x01OhQNnjb8IJYi38VlTE3mBXwcfvywuSw==", "dev": true, + "license": "MIT", "dependencies": { "agent-base": "^7.1.2", "debug": "4" @@ -6482,14 +6167,12 @@ }, "node_modules/hyphenate-style-name": { "version": "1.1.0", - "resolved": "https://registry.npmjs.org/hyphenate-style-name/-/hyphenate-style-name-1.1.0.tgz", - "integrity": "sha512-WDC/ui2VVRrz3jOVi+XtjqkDjiVjTtFaAGiW37k6b+ohyQ5wYDOGkvCZa8+H0nx3gyvv0+BST9xuOgIyGQ00gw==" + "license": "BSD-3-Clause" }, "node_modules/iconv-lite": { "version": "0.6.3", - "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz", - "integrity": "sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==", "dev": true, + "license": "MIT", "dependencies": { "safer-buffer": ">= 2.1.2 < 3.0.0" }, @@ -6499,13 +6182,10 @@ }, "node_modules/idb": { "version": "7.1.1", - "resolved": "https://registry.npmjs.org/idb/-/idb-7.1.1.tgz", - "integrity": "sha512-gchesWBzyvGHRO9W8tzUWFDycow5gwjvFKfyV9FF32Y7F50yZMp7mP+T2mJIWFx49zicqyC4uefHM17o6xKIVQ==" + "license": "ISC" }, "node_modules/ieee754": { "version": "1.2.1", - "resolved": "https://registry.npmjs.org/ieee754/-/ieee754-1.2.1.tgz", - "integrity": "sha512-dcyqhDvX1C46lXZcVqCpK+FtMRQVdIMN6/Df5js2zouUsqG7I6sFxitIC+7KYK29KdXOLHdu9zL4sFnoVQnqaA==", "funding": [ { "type": "github", @@ -6519,28 +6199,26 @@ "type": "consulting", "url": "https://feross.org/support" } - ] + ], + "license": "BSD-3-Clause" }, "node_modules/ignore": { "version": "5.3.2", - "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.2.tgz", - "integrity": "sha512-hsBTNUqQTDwkWtcdYI2i06Y/nUBEsNEDJKjWdigLvegy8kDuJAS8uRlpkkcQpyEXL0Z/pjDy5HBmMjRCJ2gq+g==", "dev": true, + "license": "MIT", "engines": { "node": ">= 4" } }, "node_modules/immutable": { - "version": "4.3.7", - "resolved": "https://registry.npmjs.org/immutable/-/immutable-4.3.7.tgz", - "integrity": "sha512-1hqclzwYwjRDFLjcFxOM5AYkkG0rpFPpr1RLPMEuGczoS7YA8gLhy8SWXYRAA/XwfEHpfo3cw5JGioS32fnMRw==", + "version": "4.3.8", + "license": "MIT", "optional": true }, "node_modules/import-fresh": { "version": "3.3.1", - "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.1.tgz", - "integrity": "sha512-TR3KfrTZTYLPB6jUjfx6MF9WcWrHL9su5TObK4ZkYgBdWKPOFoSoQIdEuTuR82pmtxH2spWG9h6etwfr1pLBqQ==", "dev": true, + "license": "MIT", "dependencies": { "parent-module": "^1.0.0", "resolve-from": "^4.0.0" @@ -6552,43 +6230,32 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/import-lazy": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/import-lazy/-/import-lazy-2.1.0.tgz", - "integrity": "sha512-m7ZEHgtw69qOGw+jwxXkHlrlIPdTGkyh66zXZ1ajZbxkDBNjSY/LGbmjc7h0s2ELsUDTAhFr55TrPSSqJGPG0A==", - "engines": { - "node": ">=4" - } - }, "node_modules/imurmurhash": { "version": "0.1.4", - "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", - "integrity": "sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA==", + "dev": true, + "license": "MIT", "engines": { "node": ">=0.8.19" } }, "node_modules/indent-string": { "version": "4.0.0", - "resolved": "https://registry.npmjs.org/indent-string/-/indent-string-4.0.0.tgz", - "integrity": "sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg==", + "license": "MIT", "engines": { "node": ">=8" } }, "node_modules/inflection": { "version": "3.0.2", - "resolved": "https://registry.npmjs.org/inflection/-/inflection-3.0.2.tgz", - "integrity": "sha512-+Bg3+kg+J6JUWn8J6bzFmOWkTQ6L/NHfDRSYU+EVvuKHDxUDHAXgqixHfVlzuBQaPOTac8hn43aPhMNk6rMe3g==", + "license": "MIT", "engines": { "node": ">=18.0.0" } }, "node_modules/inflight": { "version": "1.0.6", - "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", - "integrity": "sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA==", - "deprecated": "This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.", + "dev": true, + "license": "ISC", "dependencies": { "once": "^1.3.0", "wrappy": "1" @@ -6596,18 +6263,18 @@ }, "node_modules/inherits": { "version": "2.0.4", - "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", - "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==" + "license": "ISC" }, "node_modules/ini": { - "version": "1.3.7", - "resolved": "https://registry.npmjs.org/ini/-/ini-1.3.7.tgz", - "integrity": "sha512-iKpRpXP+CrP2jyrxvg1kMUpXDyRUFDWurxbnVT1vQPx+Wz9uCYsMIqYuSBLV+PAaZG/d7kRLKRFc9oDMsH+mFQ==" + "version": "4.1.1", + "license": "ISC", + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } }, "node_modules/inquirer": { "version": "7.3.3", - "resolved": "https://registry.npmjs.org/inquirer/-/inquirer-7.3.3.tgz", - "integrity": "sha512-JG3eIAj5V9CwcGvuOmoo6LB9kbAYT8HXffUl6memuszlwDC/qvFAJw49XJ5NROSFNPxp3iQg1GqkFhaY/CR0IA==", + "license": "MIT", "dependencies": { "ansi-escapes": "^4.2.1", "chalk": "^4.1.0", @@ -6629,8 +6296,7 @@ }, "node_modules/internal-slot": { "version": "1.1.0", - "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.1.0.tgz", - "integrity": "sha512-4gd7VpWNQNB4UKKCFFVcp1AVv+FMOgs9NKzjHKusc8jTMhd5eL1NqQqOpE0KzMds804/yHlglp3uxgluOqAPLw==", + "license": "MIT", "dependencies": { "es-errors": "^1.3.0", "hasown": "^2.0.2", @@ -6642,9 +6308,8 @@ }, "node_modules/is-arguments": { "version": "1.2.0", - "resolved": "https://registry.npmjs.org/is-arguments/-/is-arguments-1.2.0.tgz", - "integrity": "sha512-7bVbi0huj/wrIAOzb8U1aszg9kdi3KN/CyU19CTI7tAoZYEZoL9yCDXpbXN+uPsuWnP02cyug1gleqq+TU+YCA==", "dev": true, + "license": "MIT", "dependencies": { "call-bound": "^1.0.2", "has-tostringtag": "^1.0.2" @@ -6658,8 +6323,7 @@ }, "node_modules/is-array-buffer": { "version": "3.0.5", - "resolved": "https://registry.npmjs.org/is-array-buffer/-/is-array-buffer-3.0.5.tgz", - "integrity": "sha512-DDfANUiiG2wC1qawP66qlTugJeL5HyzMpfr8lLK+jMQirGzNod0B12cFB/9q838Ru27sBwfw78/rdoU7RERz6A==", + "license": "MIT", "dependencies": { "call-bind": "^1.0.8", "call-bound": "^1.0.3", @@ -6674,13 +6338,11 @@ }, "node_modules/is-arrayish": { "version": "0.2.1", - "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz", - "integrity": "sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg==" + "license": "MIT" }, "node_modules/is-async-function": { "version": "2.1.1", - "resolved": "https://registry.npmjs.org/is-async-function/-/is-async-function-2.1.1.tgz", - "integrity": "sha512-9dgM/cZBnNvjzaMYHVoxxfPj2QXt22Ev7SuuPrs+xav0ukGB0S6d4ydZdEiM48kLx5kDV+QBPrpVnFyefL8kkQ==", + "license": "MIT", "dependencies": { "async-function": "^1.0.0", "call-bound": "^1.0.3", @@ -6697,8 +6359,7 @@ }, "node_modules/is-bigint": { "version": "1.1.0", - "resolved": "https://registry.npmjs.org/is-bigint/-/is-bigint-1.1.0.tgz", - "integrity": "sha512-n4ZT37wG78iz03xPRKJrHTdZbe3IicyucEtdRsV5yglwc3GyUfbAfpSeD0FJ41NbUNSt5wbhqfp1fS+BgnvDFQ==", + "license": "MIT", "dependencies": { "has-bigints": "^1.0.2" }, @@ -6711,8 +6372,7 @@ }, "node_modules/is-binary-path": { "version": "2.1.0", - "resolved": "https://registry.npmjs.org/is-binary-path/-/is-binary-path-2.1.0.tgz", - "integrity": "sha512-ZMERYes6pDydyuGidse7OsHxtbI7WVeUEozgR/g7rd0xUimYNlvZRE/K2MgZTjWy725IfelLeVcEM97mmtRGXw==", + "license": "MIT", "dependencies": { "binary-extensions": "^2.0.0" }, @@ -6722,8 +6382,7 @@ }, "node_modules/is-boolean-object": { "version": "1.2.2", - "resolved": "https://registry.npmjs.org/is-boolean-object/-/is-boolean-object-1.2.2.tgz", - "integrity": "sha512-wa56o2/ElJMYqjCjGkXri7it5FbebW5usLw/nPmCMs5DeZ7eziSYZhSmPRn0txqeW4LnAmQQU7FgqLpsEFKM4A==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.3", "has-tostringtag": "^1.0.2" @@ -6737,8 +6396,7 @@ }, "node_modules/is-callable": { "version": "1.2.7", - "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.7.tgz", - "integrity": "sha512-1BC0BVFhS/p0qtw6enp8e+8OD0UrK0oFLztSjNzhcKA3WDuJxxAPXzPuPtKkjEY9UUoEWlX/8fgKeu2S8i9JTA==", + "license": "MIT", "engines": { "node": ">= 0.4" }, @@ -6746,21 +6404,9 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/is-ci": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/is-ci/-/is-ci-2.0.0.tgz", - "integrity": "sha512-YfJT7rkpQB0updsdHLGWrvhBJfcfzNNawYDNIyQXJz0IViGf75O8EBPKSdvw2rF+LGCsX4FZ8tcr3b19LcZq4w==", - "dependencies": { - "ci-info": "^2.0.0" - }, - "bin": { - "is-ci": "bin.js" - } - }, "node_modules/is-core-module": { "version": "2.16.1", - "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.16.1.tgz", - "integrity": "sha512-UfoeMA6fIJ8wTYFEUjelnaGI67v6+N7qXJEvQuIGa99l4xsCruSYOVSQ0uPANn4dAzm8lkYPaKLrrijLq7x23w==", + "license": "MIT", "dependencies": { "hasown": "^2.0.2" }, @@ -6773,8 +6419,7 @@ }, "node_modules/is-data-view": { "version": "1.0.2", - "resolved": "https://registry.npmjs.org/is-data-view/-/is-data-view-1.0.2.tgz", - "integrity": "sha512-RKtWF8pGmS87i2D6gqQu/l7EYRlVdfzemCJN/P3UOs//x1QE7mfhvzHIApBTRf7axvT6DMGwSwBXYCT0nfB9xw==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.2", "get-intrinsic": "^1.2.6", @@ -6789,8 +6434,7 @@ }, "node_modules/is-date-object": { "version": "1.1.0", - "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.1.0.tgz", - "integrity": "sha512-PwwhEakHVKTdRNVOw+/Gyh0+MzlCl4R6qKvkhuvLtPMggI1WAHt9sOwZxQLSGpUaDnrdyDsomoRgNnCfKNSXXg==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.2", "has-tostringtag": "^1.0.2" @@ -6804,16 +6448,14 @@ }, "node_modules/is-extglob": { "version": "2.1.1", - "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", - "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==", + "license": "MIT", "engines": { "node": ">=0.10.0" } }, "node_modules/is-finalizationregistry": { "version": "1.1.1", - "resolved": "https://registry.npmjs.org/is-finalizationregistry/-/is-finalizationregistry-1.1.1.tgz", - "integrity": "sha512-1pC6N8qWJbWoPtEjgcL2xyhQOP491EQjeUo3qTKcmV8YSDDJrOepfG8pcC7h/QgnQHYSv0mJ3Z/ZWxmatVrysg==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.3" }, @@ -6826,19 +6468,18 @@ }, "node_modules/is-fullwidth-code-point": { "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", - "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", + "license": "MIT", "engines": { "node": ">=8" } }, "node_modules/is-generator-function": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/is-generator-function/-/is-generator-function-1.1.0.tgz", - "integrity": "sha512-nPUB5km40q9e8UfN/Zc24eLlzdSf9OfKByBw9CIdw4H1giPMeA0OIJvbchsCu4npfI2QcMVBsGEBHKZ7wLTWmQ==", + "version": "1.1.2", + "license": "MIT", "dependencies": { - "call-bound": "^1.0.3", - "get-proto": "^1.0.0", + "call-bound": "^1.0.4", + "generator-function": "^2.0.0", + "get-proto": "^1.0.1", "has-tostringtag": "^1.0.2", "safe-regex-test": "^1.1.0" }, @@ -6851,8 +6492,7 @@ }, "node_modules/is-glob": { "version": "4.0.3", - "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", - "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", + "license": "MIT", "dependencies": { "is-extglob": "^2.1.1" }, @@ -6862,19 +6502,40 @@ }, "node_modules/is-in-browser": { "version": "1.1.3", - "resolved": "https://registry.npmjs.org/is-in-browser/-/is-in-browser-1.1.3.tgz", - "integrity": "sha512-FeXIBgG/CPGd/WUxuEyvgGTEfwiG9Z4EKGxjNMRqviiIIfsmgrpnHLffEDdwUHqNva1VEW91o3xBT/m8Elgl9g==" + "license": "MIT" }, - "node_modules/is-installed-globally": { - "version": "0.3.2", - "resolved": "https://registry.npmjs.org/is-installed-globally/-/is-installed-globally-0.3.2.tgz", - "integrity": "sha512-wZ8x1js7Ia0kecP/CHM/3ABkAmujX7WPvQk6uu3Fly/Mk44pySulQpnHG46OMjHGXApINnV4QhY3SWnECO2z5g==", - "dependencies": { - "global-dirs": "^2.0.1", - "is-path-inside": "^3.0.1" + "node_modules/is-in-ci": { + "version": "1.0.0", + "license": "MIT", + "bin": { + "is-in-ci": "cli.js" }, "engines": { - "node": ">=8" + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-installed-globally": { + "version": "1.0.0", + "license": "MIT", + "dependencies": { + "global-directory": "^4.0.1", + "is-path-inside": "^4.0.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-installed-globally/node_modules/is-path-inside": { + "version": "4.0.0", + "license": "MIT", + "engines": { + "node": ">=12" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" @@ -6882,16 +6543,14 @@ }, "node_modules/is-interactive": { "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-interactive/-/is-interactive-1.0.0.tgz", - "integrity": "sha512-2HvIEKRoqS62guEC+qBjpvRubdX910WCMuJTZ+I9yvqKU2/12eSL549HMwtabb4oupdj2sMP50k+XJfB/8JE6w==", + "license": "MIT", "engines": { "node": ">=8" } }, "node_modules/is-map": { "version": "2.0.3", - "resolved": "https://registry.npmjs.org/is-map/-/is-map-2.0.3.tgz", - "integrity": "sha512-1Qed0/Hr2m+YqxnM09CjA2d/i6YZNfF6R2oRAOj36eUdS6qIV/huPJNSEpKbupewFs+ZsJlxsjjPbc0/afW6Lw==", + "license": "MIT", "engines": { "node": ">= 0.4" }, @@ -6902,33 +6561,43 @@ "node_modules/is-mobile": { "version": "2.2.2", "resolved": "https://registry.npmjs.org/is-mobile/-/is-mobile-2.2.2.tgz", - "integrity": "sha512-wW/SXnYJkTjs++tVK5b6kVITZpAZPtUrt9SF80vvxGiF/Oywal+COk1jlRkiVq15RFNEQKQY31TkV24/1T5cVg==" + "integrity": "sha512-wW/SXnYJkTjs++tVK5b6kVITZpAZPtUrt9SF80vvxGiF/Oywal+COk1jlRkiVq15RFNEQKQY31TkV24/1T5cVg==", + "license": "MIT" }, "node_modules/is-module": { "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-module/-/is-module-1.0.0.tgz", - "integrity": "sha512-51ypPSPCoTEIN9dy5Oy+h4pShgJmPCygKfyRCISBI+JoWT/2oJvK8QPxmwv7b/p239jXrm9M1mlQbyKJ5A152g==" + "license": "MIT" + }, + "node_modules/is-negative-zero": { + "version": "2.0.3", + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } }, "node_modules/is-npm": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/is-npm/-/is-npm-4.0.0.tgz", - "integrity": "sha512-96ECIfh9xtDDlPylNPXhzjsykHsMJZ18ASpaWzQyBr4YRTcVjUvzaHayDAES2oU/3KpljhHUjtSRNiDwi0F0ig==", + "version": "6.1.0", + "license": "MIT", "engines": { - "node": ">=8" + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/is-number": { "version": "7.0.0", - "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", - "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "license": "MIT", "engines": { "node": ">=0.12.0" } }, "node_modules/is-number-object": { "version": "1.1.1", - "resolved": "https://registry.npmjs.org/is-number-object/-/is-number-object-1.1.1.tgz", - "integrity": "sha512-lZhclumE1G6VYD8VHe35wFaIif+CTy5SJIi5+3y4psDgWu4wPDoBhF8NxUOinEc7pHgiTsT6MaBb92rKhhD+Xw==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.3", "has-tostringtag": "^1.0.2" @@ -6942,38 +6611,34 @@ }, "node_modules/is-obj": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/is-obj/-/is-obj-1.0.1.tgz", - "integrity": "sha512-l4RyHgRqGN4Y3+9JHVrNqO+tN0rV5My76uW5/nuO4K1b6vw5G8d/cmFjP9tRfEsdhZNt0IFdZuK/c2Vr4Nb+Qg==", + "license": "MIT", "engines": { "node": ">=0.10.0" } }, "node_modules/is-path-inside": { "version": "3.0.3", - "resolved": "https://registry.npmjs.org/is-path-inside/-/is-path-inside-3.0.3.tgz", - "integrity": "sha512-Fd4gABb+ycGAmKou8eMftCupSir5lRxqf4aD/vd0cD2qc4HL07OjCeuHMr8Ro4CoMaeCKDB0/ECBOVWjTwUvPQ==", + "dev": true, + "license": "MIT", "engines": { "node": ">=8" } }, "node_modules/is-plain-obj": { "version": "1.1.0", - "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-1.1.0.tgz", - "integrity": "sha512-yvkRyxmFKEOQ4pNXCmJG5AEQNlXJS5LaONXo5/cLdTZdWvsZ1ioJEonLGAosKlMWE8lwUy/bJzMjcw8az73+Fg==", + "license": "MIT", "engines": { "node": ">=0.10.0" } }, "node_modules/is-potential-custom-element-name": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/is-potential-custom-element-name/-/is-potential-custom-element-name-1.0.1.tgz", - "integrity": "sha512-bCYeRA2rVibKZd+s2625gGnGF/t7DSqDs4dP7CrLA1m7jKWz6pps0LpYLJN8Q64HtmPKJ1hrN3nzPNKFEKOUiQ==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/is-regex": { "version": "1.2.1", - "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.2.1.tgz", - "integrity": "sha512-MjYsKHO5O7mCsmRGxWcLWheFqN9DJ/2TmngvjKXihe6efViPqc274+Fx/4fYj/r03+ESvBdTXK0V6tA3rgez1g==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.2", "gopd": "^1.2.0", @@ -6989,16 +6654,14 @@ }, "node_modules/is-regexp": { "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-regexp/-/is-regexp-1.0.0.tgz", - "integrity": "sha512-7zjFAPO4/gwyQAAgRRmqeEeyIICSdmCqa3tsVHMdBzaXXRiqopZL4Cyghg/XulGWrtABTpbnYYzzIRffLkP4oA==", + "license": "MIT", "engines": { "node": ">=0.10.0" } }, "node_modules/is-set": { "version": "2.0.3", - "resolved": "https://registry.npmjs.org/is-set/-/is-set-2.0.3.tgz", - "integrity": "sha512-iPAjerrse27/ygGLxw+EBR9agv9Y6uLeYVJMu+QNCoouJ1/1ri0mGrcWpfCqFZuzzx3WjtwxG098X+n4OuRkPg==", + "license": "MIT", "engines": { "node": ">= 0.4" }, @@ -7008,8 +6671,7 @@ }, "node_modules/is-shared-array-buffer": { "version": "1.0.4", - "resolved": "https://registry.npmjs.org/is-shared-array-buffer/-/is-shared-array-buffer-1.0.4.tgz", - "integrity": "sha512-ISWac8drv4ZGfwKl5slpHG9OwPNty4jOWPRIhBpxOoD+hqITiwuipOQ2bNthAzwA3B4fIjO4Nln74N0S9byq8A==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.3" }, @@ -7022,8 +6684,7 @@ }, "node_modules/is-stream": { "version": "2.0.1", - "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.1.tgz", - "integrity": "sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg==", + "license": "MIT", "engines": { "node": ">=8" }, @@ -7033,8 +6694,7 @@ }, "node_modules/is-string": { "version": "1.1.1", - "resolved": "https://registry.npmjs.org/is-string/-/is-string-1.1.1.tgz", - "integrity": "sha512-BtEeSsoaQjlSPBemMQIrY1MY0uM6vnS1g5fmufYOtnxLGUZM2178PKbhsk7Ffv58IX+ZtcvoGwccYsh0PglkAA==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.3", "has-tostringtag": "^1.0.2" @@ -7048,8 +6708,7 @@ }, "node_modules/is-symbol": { "version": "1.1.1", - "resolved": "https://registry.npmjs.org/is-symbol/-/is-symbol-1.1.1.tgz", - "integrity": "sha512-9gGx6GTtCQM73BgmHQXfDmLtfjjTUDSyoxTCbp5WtoixAhfgsDirWIcVQ/IHpvI5Vgd5i/J5F7B9cN/WlVbC/w==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.2", "has-symbols": "^1.1.0", @@ -7064,8 +6723,7 @@ }, "node_modules/is-typed-array": { "version": "1.1.15", - "resolved": "https://registry.npmjs.org/is-typed-array/-/is-typed-array-1.1.15.tgz", - "integrity": "sha512-p3EcsicXjit7SaskXHs1hA91QxgTw46Fv6EFKKGS5DRFLD8yKnohjF3hxoju94b/OcMZoQukzpPpBE9uLVKzgQ==", + "license": "MIT", "dependencies": { "which-typed-array": "^1.1.16" }, @@ -7076,15 +6734,9 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/is-typedarray": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-typedarray/-/is-typedarray-1.0.0.tgz", - "integrity": "sha512-cyA56iCMHAh5CdzjJIa4aohJyeO1YbwLi3Jc35MmRU6poroFjIGZzUzupGiRPOjgHg9TLu43xbpwXk523fMxKA==" - }, "node_modules/is-unicode-supported": { "version": "0.1.0", - "resolved": "https://registry.npmjs.org/is-unicode-supported/-/is-unicode-supported-0.1.0.tgz", - "integrity": "sha512-knxG2q4UC3u8stRGyAVJCOdxFmv5DZiRcdlIaAQXAbSfJya+OhopNotLQrstBhququ4ZpuKbDc/8S6mgXgPFPw==", + "license": "MIT", "engines": { "node": ">=10" }, @@ -7094,8 +6746,7 @@ }, "node_modules/is-weakmap": { "version": "2.0.2", - "resolved": "https://registry.npmjs.org/is-weakmap/-/is-weakmap-2.0.2.tgz", - "integrity": "sha512-K5pXYOm9wqY1RgjpL3YTkF39tni1XajUIkawTLUo9EZEVUFga5gSQJF8nNS7ZwJQ02y+1YCNYcMh+HIf1ZqE+w==", + "license": "MIT", "engines": { "node": ">= 0.4" }, @@ -7105,8 +6756,7 @@ }, "node_modules/is-weakref": { "version": "1.1.1", - "resolved": "https://registry.npmjs.org/is-weakref/-/is-weakref-1.1.1.tgz", - "integrity": "sha512-6i9mGWSlqzNMEqpCp93KwRS1uUOodk2OJ6b+sq7ZPDSy2WuI5NFIxp/254TytR8ftefexkWn5xNiHUNpPOfSew==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.3" }, @@ -7119,8 +6769,7 @@ }, "node_modules/is-weakset": { "version": "2.0.4", - "resolved": "https://registry.npmjs.org/is-weakset/-/is-weakset-2.0.4.tgz", - "integrity": "sha512-mfcwb6IzQyOKTs84CQMrOwW4gQcaTOAWJ0zzJCl2WSPDrWk/OzDaImWFH3djXhb24g4eudZfLRozAvPGw4d9hQ==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.3", "get-intrinsic": "^1.2.6" @@ -7132,36 +6781,26 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/is-yarn-global": { - "version": "0.3.0", - "resolved": "https://registry.npmjs.org/is-yarn-global/-/is-yarn-global-0.3.0.tgz", - "integrity": "sha512-VjSeb/lHmkoyd8ryPVIKvOCn4D1koMqY+vqyjjUfc3xyKtP4dYOxM44sZrnqQSzSds3xyOrUTLTC9LVCVgLngw==" - }, "node_modules/isarray": { "version": "0.0.1", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-0.0.1.tgz", - "integrity": "sha512-D2S+3GLxWH+uhrNEcoh/fnmYeP8E8/zHl644d/jdA0g2uyXvy3sb0qxotE+ne0LtccHknQzWwZEzhak7oJ0COQ==" + "license": "MIT" }, "node_modules/isexe": { "version": "2.0.0", - "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", - "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==", - "dev": true + "license": "ISC" }, "node_modules/istanbul-lib-coverage": { "version": "3.2.2", - "resolved": "https://registry.npmjs.org/istanbul-lib-coverage/-/istanbul-lib-coverage-3.2.2.tgz", - "integrity": "sha512-O8dpsF+r0WV/8MNRKfnmrtCWhuKjxrq2w+jpzBL5UZKTi2LeVWnWOmWRxFlesJONmc+wLAGvKQZEOanko0LFTg==", "dev": true, + "license": "BSD-3-Clause", "engines": { "node": ">=8" } }, "node_modules/istanbul-lib-report": { "version": "3.0.1", - "resolved": "https://registry.npmjs.org/istanbul-lib-report/-/istanbul-lib-report-3.0.1.tgz", - "integrity": "sha512-GCfE1mtsHGOELCU8e/Z7YWzpmybrx/+dSTfLrvY8qRmaY6zXTKWn6WQIjaAFw069icm6GVMNkgu0NzI4iPZUNw==", "dev": true, + "license": "BSD-3-Clause", "dependencies": { "istanbul-lib-coverage": "^3.0.0", "make-dir": "^4.0.0", @@ -7171,25 +6810,10 @@ "node": ">=10" } }, - "node_modules/istanbul-lib-source-maps": { - "version": "5.0.6", - "resolved": "https://registry.npmjs.org/istanbul-lib-source-maps/-/istanbul-lib-source-maps-5.0.6.tgz", - "integrity": "sha512-yg2d+Em4KizZC5niWhQaIomgf5WlL4vOOjZ5xGCmF8SnPE/mDWWXgvRExdcpCgh9lLRRa1/fSYp2ymmbJ1pI+A==", - "dev": true, - "dependencies": { - "@jridgewell/trace-mapping": "^0.3.23", - "debug": "^4.1.1", - "istanbul-lib-coverage": "^3.0.0" - }, - "engines": { - "node": ">=10" - } - }, "node_modules/istanbul-reports": { - "version": "3.1.7", - "resolved": "https://registry.npmjs.org/istanbul-reports/-/istanbul-reports-3.1.7.tgz", - "integrity": "sha512-BewmUXImeuRk2YY0PVbxgKAysvhRPUQE0h5QRM++nVWyubKGV0l8qQ5op8+B2DOmwSe63Jivj0BjkPQVf8fP5g==", + "version": "3.2.0", "dev": true, + "license": "BSD-3-Clause", "dependencies": { "html-escaper": "^2.0.0", "istanbul-lib-report": "^3.0.0" @@ -7200,9 +6824,8 @@ }, "node_modules/iterator.prototype": { "version": "1.1.5", - "resolved": "https://registry.npmjs.org/iterator.prototype/-/iterator.prototype-1.1.5.tgz", - "integrity": "sha512-H0dkQoCa3b2VEeKQBOxFph+JAbcrQdE7KC0UkqwpLmv2EC4P41QXP+rqo9wYodACiG5/WM5s9oDApTU8utwj9g==", "dev": true, + "license": "MIT", "dependencies": { "define-data-property": "^1.1.4", "es-object-atoms": "^1.0.0", @@ -7216,29 +6839,25 @@ } }, "node_modules/jackspeak": { - "version": "3.4.3", - "resolved": "https://registry.npmjs.org/jackspeak/-/jackspeak-3.4.3.tgz", - "integrity": "sha512-OGlZQpz2yfahA/Rd1Y8Cd9SIEsqvXkLVoSw/cgwhnhFMDbsQFeZYoJJ7bIZBS9BcamUW96asq/npPWugM+RQBw==", - "dev": true, + "version": "4.1.1", + "license": "BlueOak-1.0.0", "dependencies": { "@isaacs/cliui": "^8.0.2" }, + "engines": { + "node": "20 || >=22" + }, "funding": { "url": "https://github.com/sponsors/isaacs" - }, - "optionalDependencies": { - "@pkgjs/parseargs": "^0.11.0" } }, "node_modules/jake": { - "version": "10.9.2", - "resolved": "https://registry.npmjs.org/jake/-/jake-10.9.2.tgz", - "integrity": "sha512-2P4SQ0HrLQ+fw6llpLnOaGAvN2Zu6778SJMrCUwns4fOoG9ayrTiZk3VV8sCPkVZF8ab0zksVpS8FDY5pRCNBA==", + "version": "10.9.4", + "license": "Apache-2.0", "dependencies": { - "async": "^3.2.3", - "chalk": "^4.0.2", + "async": "^3.2.6", "filelist": "^1.0.4", - "minimatch": "^3.1.2" + "picocolors": "^1.1.1" }, "bin": { "jake": "bin/cli.js" @@ -7247,36 +6866,14 @@ "node": ">=10" } }, - "node_modules/jake/node_modules/brace-expansion": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", - "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", - "dependencies": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" - } - }, - "node_modules/jake/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dependencies": { - "brace-expansion": "^1.1.7" - }, - "engines": { - "node": "*" - } - }, "node_modules/js-tokens": { "version": "4.0.0", - "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", - "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==" + "license": "MIT" }, "node_modules/js-yaml": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", - "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", + "version": "4.1.1", "dev": true, + "license": "MIT", "dependencies": { "argparse": "^2.0.1" }, @@ -7286,9 +6883,8 @@ }, "node_modules/jsdom": { "version": "26.1.0", - "resolved": "https://registry.npmjs.org/jsdom/-/jsdom-26.1.0.tgz", - "integrity": "sha512-Cvc9WUhxSMEo4McES3P7oK3QaXldCfNWp7pl2NNeiIFlCoLr3kfq9kb1fxftiwk1FLV7CvpvDfonxtzUDeSOPg==", "dev": true, + "license": "MIT", "dependencies": { "cssstyle": "^4.2.1", "data-urls": "^5.0.0", @@ -7325,17 +6921,15 @@ }, "node_modules/jsdom/node_modules/whatwg-mimetype": { "version": "4.0.0", - "resolved": "https://registry.npmjs.org/whatwg-mimetype/-/whatwg-mimetype-4.0.0.tgz", - "integrity": "sha512-QaKxh0eNIi2mE9p2vEdzfagOKHCcj1pJ56EEHGQOVxp8r9/iszLUUV7v89x9O1p/T+NlTM5W7jW6+cz4Fq1YVg==", "dev": true, + "license": "MIT", "engines": { "node": ">=18" } }, "node_modules/jsesc": { "version": "3.1.0", - "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-3.1.0.tgz", - "integrity": "sha512-/sM3dO2FOzXjKQhJuo0Q173wf2KOo8t4I8vHy6lF9poUp7bKT0/NHE8fPX23PwfhnykfqnC2xRxOnVw5XuGIaA==", + "license": "MIT", "bin": { "jsesc": "bin/jsesc" }, @@ -7345,36 +6939,56 @@ }, "node_modules/json-buffer": { "version": "3.0.1", - "resolved": "https://registry.npmjs.org/json-buffer/-/json-buffer-3.0.1.tgz", - "integrity": "sha512-4bV5BfR2mqfQTJm+V5tPPdf+ZpuhiIvTuAB5g8kcrXOZpTT/QwwVRWBywX1ozr6lEuPdbHxwaJlm9G6mI2sfSQ==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/json-parse-even-better-errors": { "version": "2.3.1", - "resolved": "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz", - "integrity": "sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w==" + "license": "MIT" }, "node_modules/json-schema": { "version": "0.4.0", - "resolved": "https://registry.npmjs.org/json-schema/-/json-schema-0.4.0.tgz", - "integrity": "sha512-es94M3nTIfsEPisRafak+HDLfHXnKBhV3vU5eqPcS3flIWqcxJWgXHXiey3YrpaNsanY5ei1VoYEbOzijuq9BA==" + "license": "(AFL-2.1 OR BSD-3-Clause)" + }, + "node_modules/json-schema-ref-parser": { + "version": "7.1.3", + "license": "MIT", + "dependencies": { + "call-me-maybe": "^1.0.1", + "js-yaml": "^3.13.1", + "ono": "^6.0.0" + } + }, + "node_modules/json-schema-ref-parser/node_modules/argparse": { + "version": "1.0.10", + "license": "MIT", + "dependencies": { + "sprintf-js": "~1.0.2" + } + }, + "node_modules/json-schema-ref-parser/node_modules/js-yaml": { + "version": "3.14.2", + "license": "MIT", + "dependencies": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } }, "node_modules/json-schema-traverse": { "version": "0.4.1", - "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", - "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", - "dev": true + "license": "MIT" }, "node_modules/json-stable-stringify-without-jsonify": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/json-stable-stringify-without-jsonify/-/json-stable-stringify-without-jsonify-1.0.1.tgz", - "integrity": "sha512-Bdboy+l7tA3OGW6FjyFHWkP5LuByj1Tk33Ljyq0axyzdk9//JSi2u3fP1QSmd1KNwq6VOKYGlAu87CisVir6Pw==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/json5": { "version": "2.2.3", - "resolved": "https://registry.npmjs.org/json5/-/json5-2.2.3.tgz", - "integrity": "sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==", + "license": "MIT", "bin": { "json5": "lib/cli.js" }, @@ -7384,16 +6998,14 @@ }, "node_modules/jsonexport": { "version": "2.5.2", - "resolved": "https://registry.npmjs.org/jsonexport/-/jsonexport-2.5.2.tgz", - "integrity": "sha512-4joNLCxxUAmS22GN3GA5os/MYFnq8oqXOKvoCymmcT0MPz/QPZ5eA+Fh5sIPxUji45RKq8DdQ1yoKq91p4E9VA==", + "license": "Apache-2.0", "bin": { "jsonexport": "bin/jsonexport.js" } }, "node_modules/jsonfile": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", - "integrity": "sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==", + "version": "6.2.0", + "license": "MIT", "dependencies": { "universalify": "^2.0.0" }, @@ -7403,16 +7015,14 @@ }, "node_modules/jsonpointer": { "version": "5.0.1", - "resolved": "https://registry.npmjs.org/jsonpointer/-/jsonpointer-5.0.1.tgz", - "integrity": "sha512-p/nXbhSEcu3pZRdkW1OfJhpsVtW1gd4Wa1fnQc9YLiTfAjn0312eMKimbdIQzuZl9aa9xUGaRlP9T/CJE/ditQ==", + "license": "MIT", "engines": { "node": ">=0.10.0" } }, "node_modules/jss": { "version": "10.10.0", - "resolved": "https://registry.npmjs.org/jss/-/jss-10.10.0.tgz", - "integrity": "sha512-cqsOTS7jqPsPMjtKYDUpdFC0AbhYFLTcuGRqymgmdJIeQ8cH7+AgX7YSgQy79wXloZq2VvATYxUOUQEvS1V/Zw==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.3.1", "csstype": "^3.0.2", @@ -7426,8 +7036,7 @@ }, "node_modules/jss-plugin-camel-case": { "version": "10.10.0", - "resolved": "https://registry.npmjs.org/jss-plugin-camel-case/-/jss-plugin-camel-case-10.10.0.tgz", - "integrity": "sha512-z+HETfj5IYgFxh1wJnUAU8jByI48ED+v0fuTuhKrPR+pRBYS2EDwbusU8aFOpCdYhtRc9zhN+PJ7iNE8pAWyPw==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.3.1", "hyphenate-style-name": "^1.0.3", @@ -7436,8 +7045,7 @@ }, "node_modules/jss-plugin-default-unit": { "version": "10.10.0", - "resolved": "https://registry.npmjs.org/jss-plugin-default-unit/-/jss-plugin-default-unit-10.10.0.tgz", - "integrity": "sha512-SvpajxIECi4JDUbGLefvNckmI+c2VWmP43qnEy/0eiwzRUsafg5DVSIWSzZe4d2vFX1u9nRDP46WCFV/PXVBGQ==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.3.1", "jss": "10.10.0" @@ -7445,8 +7053,7 @@ }, "node_modules/jss-plugin-global": { "version": "10.10.0", - "resolved": "https://registry.npmjs.org/jss-plugin-global/-/jss-plugin-global-10.10.0.tgz", - "integrity": "sha512-icXEYbMufiNuWfuazLeN+BNJO16Ge88OcXU5ZDC2vLqElmMybA31Wi7lZ3lf+vgufRocvPj8443irhYRgWxP+A==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.3.1", "jss": "10.10.0" @@ -7454,8 +7061,7 @@ }, "node_modules/jss-plugin-nested": { "version": "10.10.0", - "resolved": "https://registry.npmjs.org/jss-plugin-nested/-/jss-plugin-nested-10.10.0.tgz", - "integrity": "sha512-9R4JHxxGgiZhurDo3q7LdIiDEgtA1bTGzAbhSPyIOWb7ZubrjQe8acwhEQ6OEKydzpl8XHMtTnEwHXCARLYqYA==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.3.1", "jss": "10.10.0", @@ -7464,8 +7070,7 @@ }, "node_modules/jss-plugin-props-sort": { "version": "10.10.0", - "resolved": "https://registry.npmjs.org/jss-plugin-props-sort/-/jss-plugin-props-sort-10.10.0.tgz", - "integrity": "sha512-5VNJvQJbnq/vRfje6uZLe/FyaOpzP/IH1LP+0fr88QamVrGJa0hpRRyAa0ea4U/3LcorJfBFVyC4yN2QC73lJg==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.3.1", "jss": "10.10.0" @@ -7473,8 +7078,7 @@ }, "node_modules/jss-plugin-rule-value-function": { "version": "10.10.0", - "resolved": "https://registry.npmjs.org/jss-plugin-rule-value-function/-/jss-plugin-rule-value-function-10.10.0.tgz", - "integrity": "sha512-uEFJFgaCtkXeIPgki8ICw3Y7VMkL9GEan6SqmT9tqpwM+/t+hxfMUdU4wQ0MtOiMNWhwnckBV0IebrKcZM9C0g==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.3.1", "jss": "10.10.0", @@ -7483,8 +7087,7 @@ }, "node_modules/jss-plugin-vendor-prefixer": { "version": "10.10.0", - "resolved": "https://registry.npmjs.org/jss-plugin-vendor-prefixer/-/jss-plugin-vendor-prefixer-10.10.0.tgz", - "integrity": "sha512-UY/41WumgjW8r1qMCO8l1ARg7NHnfRVWRhZ2E2m0DMYsr2DD91qIXLyNhiX83hHswR7Wm4D+oDYNC1zWCJWtqg==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.3.1", "css-vendor": "^2.0.8", @@ -7492,15 +7095,13 @@ } }, "node_modules/jss/node_modules/csstype": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.1.3.tgz", - "integrity": "sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw==" + "version": "3.2.3", + "license": "MIT" }, "node_modules/jsx-ast-utils": { "version": "3.3.5", - "resolved": "https://registry.npmjs.org/jsx-ast-utils/-/jsx-ast-utils-3.3.5.tgz", - "integrity": "sha512-ZZow9HBI5O6EPgSJLUb8n2NKgmVWTwCvHGwFuJlMjvLFqlGG6pjirPhtdsseaLZjSibD8eegzmYpUZwoIlj2cQ==", "dev": true, + "license": "MIT", "dependencies": { "array-includes": "^3.1.6", "array.prototype.flat": "^1.3.1", @@ -7513,40 +7114,45 @@ }, "node_modules/jwt-decode": { "version": "4.0.0", - "resolved": "https://registry.npmjs.org/jwt-decode/-/jwt-decode-4.0.0.tgz", - "integrity": "sha512-+KJGIyHgkGuIq3IEBNftfhW/LfWhXUIY6OmyVWjliu5KH1y0fw7VQ8YndE2O4qZdMSd9SqbnC8GOcZEy0Om7sA==", + "license": "MIT", "engines": { "node": ">=18" } }, "node_modules/keyv": { "version": "4.5.4", - "resolved": "https://registry.npmjs.org/keyv/-/keyv-4.5.4.tgz", - "integrity": "sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw==", "dev": true, + "license": "MIT", "dependencies": { "json-buffer": "3.0.1" } }, "node_modules/kind-of": { "version": "6.0.3", - "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.3.tgz", - "integrity": "sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==", + "license": "MIT", "engines": { "node": ">=0.10.0" } }, + "node_modules/ky": { + "version": "1.14.2", + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sindresorhus/ky?sponsor=1" + } + }, "node_modules/language-subtag-registry": { "version": "0.3.23", - "resolved": "https://registry.npmjs.org/language-subtag-registry/-/language-subtag-registry-0.3.23.tgz", - "integrity": "sha512-0K65Lea881pHotoGEa5gDlMxt3pctLi2RplBb7Ezh4rRdLEOtgi7n4EwK9lamnUCkKBqaeKRVebTq6BAxSkpXQ==", - "dev": true + "dev": true, + "license": "CC0-1.0" }, "node_modules/language-tags": { "version": "1.0.9", - "resolved": "https://registry.npmjs.org/language-tags/-/language-tags-1.0.9.tgz", - "integrity": "sha512-MbjN408fEndfiQXbFQ1vnd+1NoLDsnQW41410oQBXiyXDMYH5z505juWa4KUE1LqxRC7DgOgZDbKLxHIwm27hA==", "dev": true, + "license": "MIT", "dependencies": { "language-subtag-registry": "^0.3.20" }, @@ -7555,29 +7161,29 @@ } }, "node_modules/latest-version": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/latest-version/-/latest-version-5.1.0.tgz", - "integrity": "sha512-weT+r0kTkRQdCdYCNtkMwWXQTMEswKrFBkm4ckQOMVhhqhIMI1UT2hMj+1iigIhgSZm5gTmrRXBNoGUgaTY1xA==", + "version": "9.0.0", + "license": "MIT", "dependencies": { - "package-json": "^6.3.0" + "package-json": "^10.0.0" }, "engines": { - "node": ">=8" + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/leven": { "version": "3.1.0", - "resolved": "https://registry.npmjs.org/leven/-/leven-3.1.0.tgz", - "integrity": "sha512-qsda+H8jTaUaN/x5vzW2rzc+8Rw4TAQ/4KjB46IwK5VH+IlVeeeje/EoZRpiXvIqjFgK84QffqPztGI3VBLG1A==", + "license": "MIT", "engines": { "node": ">=6" } }, "node_modules/levn": { "version": "0.4.1", - "resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz", - "integrity": "sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ==", "dev": true, + "license": "MIT", "dependencies": { "prelude-ls": "^1.2.1", "type-check": "~0.4.0" @@ -7588,14 +7194,12 @@ }, "node_modules/lines-and-columns": { "version": "1.2.4", - "resolved": "https://registry.npmjs.org/lines-and-columns/-/lines-and-columns-1.2.4.tgz", - "integrity": "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==" + "license": "MIT" }, "node_modules/locate-path": { "version": "6.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz", - "integrity": "sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw==", "dev": true, + "license": "MIT", "dependencies": { "p-locate": "^5.0.0" }, @@ -7607,40 +7211,33 @@ } }, "node_modules/lodash": { - "version": "4.17.21", - "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", - "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==" + "version": "4.17.23", + "license": "MIT" }, "node_modules/lodash.debounce": { "version": "4.0.8", - "resolved": "https://registry.npmjs.org/lodash.debounce/-/lodash.debounce-4.0.8.tgz", - "integrity": "sha512-FT1yDzDYEoYWhnSGnpE/4Kj1fLZkDFyqRb7fNt6FdYOSxlUWAtp42Eh6Wb0rGIv/m9Bgo7x4GhQbm5Ys4SG5ow==" + "license": "MIT" }, "node_modules/lodash.isequalwith": { "version": "4.4.0", - "resolved": "https://registry.npmjs.org/lodash.isequalwith/-/lodash.isequalwith-4.4.0.tgz", - "integrity": "sha512-dcZON0IalGBpRmJBmMkaoV7d3I80R2O+FrzsZyHdNSFrANq/cgDqKQNmAHE8UEj4+QYWwwhkQOVdLHiAopzlsQ==" + "license": "MIT" }, "node_modules/lodash.merge": { "version": "4.6.2", - "resolved": "https://registry.npmjs.org/lodash.merge/-/lodash.merge-4.6.2.tgz", - "integrity": "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/lodash.sortby": { "version": "4.7.0", - "resolved": "https://registry.npmjs.org/lodash.sortby/-/lodash.sortby-4.7.0.tgz", - "integrity": "sha512-HDWXG8isMntAyRF5vZ7xKuEvOhT4AhlRt/3czTSjvGUxjYCBVRQY48ViDHyfYz9VIoBkW4TMGQNapx+l3RUwdA==" + "license": "MIT" }, "node_modules/lodash.throttle": { "version": "4.1.1", - "resolved": "https://registry.npmjs.org/lodash.throttle/-/lodash.throttle-4.1.1.tgz", - "integrity": "sha512-wIkUCfVKpVsWo3JSZlc+8MB5it+2AN5W8J7YVMST30UrvcQNZ1Okbj+rbVniijTWE6FGYy4XJq/rHkas8qJMLQ==" + "license": "MIT" }, "node_modules/log-symbols": { "version": "4.1.0", - "resolved": "https://registry.npmjs.org/log-symbols/-/log-symbols-4.1.0.tgz", - "integrity": "sha512-8XPvpAA8uyhfteu8pIvQxpJZ7SYYdpUivZpGy6sFsBuKRY/7rQGavedeB8aK+Zkyq6upMFVL/9AW6vOYzfRyLg==", + "license": "MIT", "dependencies": { "chalk": "^4.1.0", "is-unicode-supported": "^0.1.0" @@ -7654,8 +7251,7 @@ }, "node_modules/loose-envify": { "version": "1.4.0", - "resolved": "https://registry.npmjs.org/loose-envify/-/loose-envify-1.4.0.tgz", - "integrity": "sha512-lyuxPGr/Wfhrlem2CL/UcnUc1zcqKAImBDzukY7Y5F/yQiNdko6+fRLevlw1HgMySw7f611UIY408EtxRSoK3Q==", + "license": "MIT", "dependencies": { "js-tokens": "^3.0.0 || ^4.0.0" }, @@ -7663,62 +7259,43 @@ "loose-envify": "cli.js" } }, - "node_modules/loupe": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/loupe/-/loupe-3.1.3.tgz", - "integrity": "sha512-kkIp7XSkP78ZxJEsSxW3712C6teJVoeHHwgo9zJ380de7IYyJ2ISlxojcH2pC5OFLewESmnRi/+XCDIEEVyoug==", - "dev": true - }, - "node_modules/lowercase-keys": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/lowercase-keys/-/lowercase-keys-1.0.1.tgz", - "integrity": "sha512-G2Lj61tXDnVFFOi8VZds+SoQjtQC3dgokKdDG2mTm1tx4m50NUHBOZSBwQQHyy0V12A0JTG4icfZQH+xPyh8VA==", - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/lru-cache": { "version": "5.1.1", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", - "integrity": "sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==", + "license": "ISC", "dependencies": { "yallist": "^3.0.2" } }, "node_modules/lz-string": { "version": "1.5.0", - "resolved": "https://registry.npmjs.org/lz-string/-/lz-string-1.5.0.tgz", - "integrity": "sha512-h5bgJWpxJNswbU7qCrV0tIKQCaS3blPDrqKWx+QxzuzL1zGUzij9XCWLrSLsJPu5t+eWA/ycetzYAO5IOMcWAQ==", "dev": true, + "license": "MIT", "bin": { "lz-string": "bin/bin.js" } }, "node_modules/magic-string": { - "version": "0.30.17", - "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.17.tgz", - "integrity": "sha512-sNPKHvyjVf7gyjwS4xGTaW/mCnF8wnjtifKBEhxfZ7E/S8tQ0rssrwGNn6q8JH/ohItJfSQp9mBtQYuTlH5QnA==", + "version": "0.30.21", "dev": true, + "license": "MIT", "dependencies": { - "@jridgewell/sourcemap-codec": "^1.5.0" + "@jridgewell/sourcemap-codec": "^1.5.5" } }, "node_modules/magicast": { - "version": "0.3.5", - "resolved": "https://registry.npmjs.org/magicast/-/magicast-0.3.5.tgz", - "integrity": "sha512-L0WhttDl+2BOsybvEOLK7fW3UA0OQ0IQ2d6Zl2x/a6vVRs3bAY0ECOSHHeL5jD+SbOpOCUEi0y1DgHEn9Qn1AQ==", + "version": "0.5.1", "dev": true, + "license": "MIT", "dependencies": { - "@babel/parser": "^7.25.4", - "@babel/types": "^7.25.4", - "source-map-js": "^1.2.0" + "@babel/parser": "^7.28.5", + "@babel/types": "^7.28.5", + "source-map-js": "^1.2.1" } }, "node_modules/make-dir": { "version": "4.0.0", - "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-4.0.0.tgz", - "integrity": "sha512-hXdUTZYIVOt1Ex//jAQi+wTZZpUpwBj/0QsOzqegb3rGMMeJiSEu5xLHnYfBrRV4RH2+OCSOO95Is/7x1WJ4bw==", "dev": true, + "license": "MIT", "dependencies": { "semver": "^7.5.3" }, @@ -7731,8 +7308,7 @@ }, "node_modules/map-obj": { "version": "4.3.0", - "resolved": "https://registry.npmjs.org/map-obj/-/map-obj-4.3.0.tgz", - "integrity": "sha512-hdN1wVrZbb29eBGiGjJbeP8JbKjq1urkHJ/LIP/NY48MZ1QVXUsQBV1G1zvYFHn1XE06cwjBsOI2K3Ulnj1YXQ==", + "license": "MIT", "engines": { "node": ">=8" }, @@ -7742,16 +7318,14 @@ }, "node_modules/math-intrinsics": { "version": "1.1.0", - "resolved": "https://registry.npmjs.org/math-intrinsics/-/math-intrinsics-1.1.0.tgz", - "integrity": "sha512-/IXtbwEk5HTPyEwyKX6hGkYXxM9nbj64B+ilVJnC/R6B0pH5G4V3b0pVbL7DBj4tkhBAppbQUlf6F6Xl9LHu1g==", + "license": "MIT", "engines": { "node": ">= 0.4" } }, "node_modules/meow": { "version": "7.1.1", - "resolved": "https://registry.npmjs.org/meow/-/meow-7.1.1.tgz", - "integrity": "sha512-GWHvA5QOcS412WCo8vwKDlTelGLsCGBVevQB5Kva961rmNfun0PCbv5+xta2kUMFJyR8/oWnn7ddeKdosbAPbA==", + "license": "MIT", "dependencies": { "@types/minimist": "^1.2.0", "camelcase-keys": "^6.2.2", @@ -7774,8 +7348,7 @@ }, "node_modules/meow/node_modules/type-fest": { "version": "0.13.1", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.13.1.tgz", - "integrity": "sha512-34R7HTnG0XIJcBSn5XhDd7nNFPRcXYRZrBB2O2jdKqYODldSzBAqzsWoZYYvduky73toYS/ESqxPvkDf/F0XMg==", + "license": "(MIT OR CC0-1.0)", "engines": { "node": ">=10" }, @@ -7785,18 +7358,16 @@ }, "node_modules/merge2": { "version": "1.4.1", - "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", - "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", "dev": true, + "license": "MIT", "engines": { "node": ">= 8" } }, "node_modules/micromatch": { "version": "4.0.8", - "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", - "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", "dev": true, + "license": "MIT", "dependencies": { "braces": "^3.0.3", "picomatch": "^2.3.1" @@ -7807,33 +7378,22 @@ }, "node_modules/mimic-fn": { "version": "2.1.0", - "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz", - "integrity": "sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==", + "license": "MIT", "engines": { "node": ">=6" } }, - "node_modules/mimic-response": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/mimic-response/-/mimic-response-1.0.1.tgz", - "integrity": "sha512-j5EctnkH7amfV/q5Hgmoal1g2QHFJRraOtmx0JpIqkxhBhI/lJSl1nMpQ45hVarwNETOoWEimndZ4QK0RHxuxQ==", - "engines": { - "node": ">=4" - } - }, "node_modules/min-indent": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/min-indent/-/min-indent-1.0.1.tgz", - "integrity": "sha512-I9jwMn07Sy/IwOj3zVkVik2JTvgpaykDZEigL6Rx6N9LbMywwUSMtxET+7lVoDLLd3O3IXwJwvuuns8UB/HeAg==", + "license": "MIT", "engines": { "node": ">=4" } }, "node_modules/minimatch": { "version": "9.0.3", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.3.tgz", - "integrity": "sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==", "dev": true, + "license": "ISC", "dependencies": { "brace-expansion": "^2.0.1" }, @@ -7846,16 +7406,14 @@ }, "node_modules/minimist": { "version": "1.2.8", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz", - "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==", + "license": "MIT", "funding": { "url": "https://github.com/sponsors/ljharb" } }, "node_modules/minimist-options": { "version": "4.1.0", - "resolved": "https://registry.npmjs.org/minimist-options/-/minimist-options-4.1.0.tgz", - "integrity": "sha512-Q4r8ghd80yhO/0j1O3B2BjweX3fiHg9cdOwjJd2J76Q135c+NDxGCqdYKQ1SKBuFfgWbAUzBfvYjPUEeNgqN1A==", + "license": "MIT", "dependencies": { "arrify": "^1.0.1", "is-plain-obj": "^1.1.0", @@ -7867,27 +7425,29 @@ }, "node_modules/minipass": { "version": "7.1.2", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.1.2.tgz", - "integrity": "sha512-qOOzS1cBTWYF4BH8fVePDBOO9iptMnGUEZwNc/cMWnTV2nVLZ7VoNWEPHkYczZA0pdoA7dl6e7FL659nX9S2aw==", - "dev": true, + "license": "ISC", "engines": { "node": ">=16 || 14 >=14.17" } }, + "node_modules/moment": { + "version": "2.30.1", + "license": "MIT", + "peer": true, + "engines": { + "node": "*" + } + }, "node_modules/ms": { "version": "2.1.3", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", - "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==" + "license": "MIT" }, "node_modules/mute-stream": { "version": "0.0.8", - "resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-0.0.8.tgz", - "integrity": "sha512-nnbWWOkoWyUsTjKrhgD0dcz22mdkSnpYqbEjIm2nhwhuxlSkpywJmBo8h0ZqJdkp73mb90SssHkN4rsRaBAfAA==" + "license": "ISC" }, "node_modules/nanoid": { "version": "3.3.11", - "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.11.tgz", - "integrity": "sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w==", "dev": true, "funding": [ { @@ -7895,6 +7455,7 @@ "url": "https://github.com/sponsors/ai" } ], + "license": "MIT", "bin": { "nanoid": "bin/nanoid.cjs" }, @@ -7904,14 +7465,14 @@ }, "node_modules/natural-compare": { "version": "1.4.0", - "resolved": "https://registry.npmjs.org/natural-compare/-/natural-compare-1.4.0.tgz", - "integrity": "sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/navidrome-music-player": { - "version": "4.25.1", - "resolved": "https://registry.npmjs.org/navidrome-music-player/-/navidrome-music-player-4.25.1.tgz", - "integrity": "sha512-bHYr84ATUf/4+/PUoTpUSmpF4/igBx2UPhgnPqvda4FND+GJZtb1ikbMs1U+mhkNEUebe+2I29ob1zY7YZdtjg==", + "version": "4.25.2", + "resolved": "https://registry.npmjs.org/navidrome-music-player/-/navidrome-music-player-4.25.2.tgz", + "integrity": "sha512-k7RXHOOKHeJRCsfmpmQ+TkErndckFfvYMjzwVAKZvViw2PL9ubKWziPfruHZVQr4FiJd2oYKEuTNiWZgAK87CA==", + "license": "MIT", "dependencies": { "@react-icons/all-files": "^4.1.0", "classnames": "^2.3.1", @@ -7930,8 +7491,7 @@ }, "node_modules/node-polyglot": { "version": "2.6.0", - "resolved": "https://registry.npmjs.org/node-polyglot/-/node-polyglot-2.6.0.tgz", - "integrity": "sha512-ZZFkaYzIfGfBvSM6QhA9dM8EEaUJOVewzGSRcXWbJELXDj0lajAtKaENCYxvF5yE+TgHg6NQb0CmgYMsMdcNJQ==", + "license": "BSD-2-Clause", "dependencies": { "hasown": "^2.0.2", "object.entries": "^1.1.8", @@ -7942,14 +7502,12 @@ } }, "node_modules/node-releases": { - "version": "2.0.19", - "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.19.tgz", - "integrity": "sha512-xxOWJsBKtzAq7DY0J+DTzuz58K8e7sJbdgwkbMWQe8UYB6ekmsQ45q0M/tJDsGaZmbC+l7n57UV8Hl5tHxO9uw==" + "version": "2.0.27", + "license": "MIT" }, "node_modules/normalize-package-data": { "version": "2.5.0", - "resolved": "https://registry.npmjs.org/normalize-package-data/-/normalize-package-data-2.5.0.tgz", - "integrity": "sha512-/5CMN3T0R4XTj4DcGaexo+roZSdSFW/0AOOTROrjxzCG1wrWXEsGbRKevjlIL+ZDE4sZlJr5ED4YW0yqmkK+eA==", + "license": "BSD-2-Clause", "dependencies": { "hosted-git-info": "^2.1.4", "resolve": "^1.10.0", @@ -7958,11 +7516,10 @@ } }, "node_modules/normalize-package-data/node_modules/resolve": { - "version": "1.22.10", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.10.tgz", - "integrity": "sha512-NPRy+/ncIMeDlTAsuqwKIiferiawhefFJtkNSW0qZJEqMEb+qBt/77B/jGeeek+F0uOeN05CDa6HXbbIgtVX4w==", + "version": "1.22.11", + "license": "MIT", "dependencies": { - "is-core-module": "^2.16.0", + "is-core-module": "^2.16.1", "path-parse": "^1.0.7", "supports-preserve-symlinks-flag": "^1.0.0" }, @@ -7978,46 +7535,40 @@ }, "node_modules/normalize-package-data/node_modules/semver": { "version": "5.7.2", - "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.2.tgz", - "integrity": "sha512-cBznnQ9KjJqU67B52RMC65CMarK2600WFnbkcaiwWq3xy/5haFJlshgnpjovMVJ+Hff49d8GEn0b87C5pDQ10g==", + "license": "ISC", "bin": { "semver": "bin/semver" } }, "node_modules/normalize-path": { "version": "3.0.0", - "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz", - "integrity": "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==", + "license": "MIT", "engines": { "node": ">=0.10.0" } }, - "node_modules/normalize-url": { - "version": "4.5.1", - "resolved": "https://registry.npmjs.org/normalize-url/-/normalize-url-4.5.1.tgz", - "integrity": "sha512-9UZCFRHQdNrfTpGg8+1INIg93B6zE0aXMVFkw1WFwvO4SlZywU6aLg5Of0Ap/PgcbSw4LNxvMWXMeugwMCX0AA==", - "engines": { - "node": ">=8" - } - }, "node_modules/nwsapi": { - "version": "2.2.20", - "resolved": "https://registry.npmjs.org/nwsapi/-/nwsapi-2.2.20.tgz", - "integrity": "sha512-/ieB+mDe4MrrKMT8z+mQL8klXydZWGR5Dowt4RAGKbJ3kIGEx3X4ljUo+6V73IXtUPWgfOlU5B9MlGxFO5T+cA==", - "dev": true + "version": "2.2.23", + "dev": true, + "license": "MIT" }, "node_modules/object-assign": { "version": "4.1.1", - "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", - "integrity": "sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg==", + "license": "MIT", "engines": { "node": ">=0.10.0" } }, + "node_modules/object-hash": { + "version": "2.2.0", + "license": "MIT", + "engines": { + "node": ">= 6" + } + }, "node_modules/object-inspect": { "version": "1.13.4", - "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.13.4.tgz", - "integrity": "sha512-W67iLl4J2EXEGTbfeHCffrjDfitvLANg0UlX3wFUUSTx92KXRFegMHUVgSqE+wvhAbi4WqjGg9czysTV2Epbew==", + "license": "MIT", "engines": { "node": ">= 0.4" }, @@ -8027,9 +7578,8 @@ }, "node_modules/object-is": { "version": "1.1.6", - "resolved": "https://registry.npmjs.org/object-is/-/object-is-1.1.6.tgz", - "integrity": "sha512-F8cZ+KfGlSGi09lJT7/Nd6KJZ9ygtvYC0/UYYLI9nmQKLMnydpB9yvbv9K1uSkEu7FU9vYPmVwLg328tX+ot3Q==", "dev": true, + "license": "MIT", "dependencies": { "call-bind": "^1.0.7", "define-properties": "^1.2.1" @@ -8043,16 +7593,14 @@ }, "node_modules/object-keys": { "version": "1.1.1", - "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz", - "integrity": "sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==", + "license": "MIT", "engines": { "node": ">= 0.4" } }, "node_modules/object.assign": { "version": "4.1.7", - "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.7.tgz", - "integrity": "sha512-nK28WOo+QIjBkDduTINE4JkF/UJJKyf2EJxvJKfblDpyg0Q+pkOHNTL0Qwy6NP6FhE/EnzV73BxxqcJaXY9anw==", + "license": "MIT", "dependencies": { "call-bind": "^1.0.8", "call-bound": "^1.0.3", @@ -8070,8 +7618,7 @@ }, "node_modules/object.entries": { "version": "1.1.9", - "resolved": "https://registry.npmjs.org/object.entries/-/object.entries-1.1.9.tgz", - "integrity": "sha512-8u/hfXFRBD1O0hPUjioLhoWFHRmt6tKA4/vZPyckBr18l1KE9uHrFaFaUi8MDRTpi4uak2goyPTSNJLXX2k2Hw==", + "license": "MIT", "dependencies": { "call-bind": "^1.0.8", "call-bound": "^1.0.4", @@ -8084,9 +7631,8 @@ }, "node_modules/object.fromentries": { "version": "2.0.8", - "resolved": "https://registry.npmjs.org/object.fromentries/-/object.fromentries-2.0.8.tgz", - "integrity": "sha512-k6E21FzySsSK5a21KRADBd/NGneRegFO5pLHfdQLpRDETUNJueLXs3WCzyQ3tFRDYgbq3KHGXfTbi2bs8WQ6rQ==", "dev": true, + "license": "MIT", "dependencies": { "call-bind": "^1.0.7", "define-properties": "^1.2.1", @@ -8102,9 +7648,8 @@ }, "node_modules/object.values": { "version": "1.2.1", - "resolved": "https://registry.npmjs.org/object.values/-/object.values-1.2.1.tgz", - "integrity": "sha512-gXah6aZrcUxjWg2zR2MwouP2eHlCBzdV4pygudehaKXSGW4v2AsRQUK+lwwXhii6KFZcunEnmSUoYp5CXibxtA==", "dev": true, + "license": "MIT", "dependencies": { "call-bind": "^1.0.8", "call-bound": "^1.0.3", @@ -8118,18 +7663,26 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/obug": { + "version": "2.1.1", + "dev": true, + "funding": [ + "https://github.com/sponsors/sxzz", + "https://opencollective.com/debug" + ], + "license": "MIT" + }, "node_modules/once": { "version": "1.4.0", - "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", - "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==", + "dev": true, + "license": "ISC", "dependencies": { "wrappy": "1" } }, "node_modules/onetime": { "version": "5.1.2", - "resolved": "https://registry.npmjs.org/onetime/-/onetime-5.1.2.tgz", - "integrity": "sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg==", + "license": "MIT", "dependencies": { "mimic-fn": "^2.1.0" }, @@ -8140,11 +7693,14 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/ono": { + "version": "6.0.1", + "license": "MIT" + }, "node_modules/optionator": { "version": "0.9.4", - "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.4.tgz", - "integrity": "sha512-6IpQ7mKUxRcZNLIObR0hz7lxsapSSIYNZJwXPGeF0mTVqGKFIXj1DQcMoT22S3ROcLyY/rz0PWaWZ9ayWmad9g==", "dev": true, + "license": "MIT", "dependencies": { "deep-is": "^0.1.3", "fast-levenshtein": "^2.0.6", @@ -8159,8 +7715,7 @@ }, "node_modules/ora": { "version": "5.4.1", - "resolved": "https://registry.npmjs.org/ora/-/ora-5.4.1.tgz", - "integrity": "sha512-5b6Y85tPxZZ7QytO+BQzysW31HJku27cRIlkbAXaNx+BdcVi+LlRFmVXzeF6a7JCwJpyw5c4b+YSVImQIrBpuQ==", + "license": "MIT", "dependencies": { "bl": "^4.1.0", "chalk": "^4.1.0", @@ -8181,16 +7736,14 @@ }, "node_modules/os-tmpdir": { "version": "1.0.2", - "resolved": "https://registry.npmjs.org/os-tmpdir/-/os-tmpdir-1.0.2.tgz", - "integrity": "sha512-D2FR03Vir7FIu45XBY20mTb+/ZSWB00sjU9jdQXt83gDrI4Ztz5Fs7/yy74g2N5SVQY4xY1qDr4rNddwYRVX0g==", + "license": "MIT", "engines": { "node": ">=0.10.0" } }, "node_modules/own-keys": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/own-keys/-/own-keys-1.0.1.tgz", - "integrity": "sha512-qFOyK5PjiWZd+QQIh+1jhdb9LpxTF0qs7Pm8o5QHYZ0M3vKqSqzsZaEB6oWlxZ+q2sJBMI/Ktgd2N5ZwQoRHfg==", + "license": "MIT", "dependencies": { "get-intrinsic": "^1.2.6", "object-keys": "^1.1.1", @@ -8203,19 +7756,10 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/p-cancelable": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/p-cancelable/-/p-cancelable-1.1.0.tgz", - "integrity": "sha512-s73XxOZ4zpt1edZYZzvhqFa6uvQc1vwUa0K0BdtIZgQMAJj9IbebH+JkgKZc9h+B05PKHLOTl4ajG1BmNrVZlw==", - "engines": { - "node": ">=6" - } - }, "node_modules/p-limit": { "version": "3.1.0", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz", - "integrity": "sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==", "dev": true, + "license": "MIT", "dependencies": { "yocto-queue": "^0.1.0" }, @@ -8228,9 +7772,8 @@ }, "node_modules/p-locate": { "version": "5.0.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-5.0.0.tgz", - "integrity": "sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw==", "dev": true, + "license": "MIT", "dependencies": { "p-limit": "^3.0.2" }, @@ -8243,45 +7786,35 @@ }, "node_modules/p-try": { "version": "2.2.0", - "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", - "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", + "license": "MIT", "engines": { "node": ">=6" } }, "node_modules/package-json": { - "version": "6.5.0", - "resolved": "https://registry.npmjs.org/package-json/-/package-json-6.5.0.tgz", - "integrity": "sha512-k3bdm2n25tkyxcjSKzB5x8kfVxlMdgsbPr0GkZcwHsLpba6cBjqCt1KlcChKEvxHIcTB1FVMuwoijZ26xex5MQ==", + "version": "10.0.1", + "license": "MIT", "dependencies": { - "got": "^9.6.0", - "registry-auth-token": "^4.0.0", - "registry-url": "^5.0.0", - "semver": "^6.2.0" + "ky": "^1.2.0", + "registry-auth-token": "^5.0.2", + "registry-url": "^6.0.1", + "semver": "^7.6.0" }, "engines": { - "node": ">=8" + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/package-json-from-dist": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/package-json-from-dist/-/package-json-from-dist-1.0.1.tgz", - "integrity": "sha512-UEZIS3/by4OC8vL3P2dTXRETpebLI2NiI5vIrjaD/5UtrkFX/tNbwjTSRAGC/+7CAo2pIcBaRgWmcBBHcsaCIw==", - "dev": true - }, - "node_modules/package-json/node_modules/semver": { - "version": "6.3.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", - "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", - "bin": { - "semver": "bin/semver.js" - } + "license": "BlueOak-1.0.0" }, "node_modules/parent-module": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", - "integrity": "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==", "dev": true, + "license": "MIT", "dependencies": { "callsites": "^3.0.0" }, @@ -8291,8 +7824,7 @@ }, "node_modules/parse-json": { "version": "5.2.0", - "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-5.2.0.tgz", - "integrity": "sha512-ayCKvm/phCGxOkYRSCM82iDwct8/EonSEgCSxWxD7ve6jHggsFl4fZVQBPRNgQoKiuV/odhFrGzQXZwbifC8Rg==", + "license": "MIT", "dependencies": { "@babel/code-frame": "^7.0.0", "error-ex": "^1.3.1", @@ -8308,9 +7840,8 @@ }, "node_modules/parse5": { "version": "7.3.0", - "resolved": "https://registry.npmjs.org/parse5/-/parse5-7.3.0.tgz", - "integrity": "sha512-IInvU7fabl34qmi9gY8XOVxhYyMyuH2xUNpb2q8/Y+7552KlejkRvqvD19nMoUW/uQGGbqNpA6Tufu5FL5BZgw==", "dev": true, + "license": "MIT", "dependencies": { "entities": "^6.0.0" }, @@ -8318,99 +7849,91 @@ "url": "https://github.com/inikulin/parse5?sponsor=1" } }, + "node_modules/parse5/node_modules/entities": { + "version": "6.0.1", + "dev": true, + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, "node_modules/path-exists": { "version": "4.0.0", - "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz", - "integrity": "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==", + "license": "MIT", "engines": { "node": ">=8" } }, "node_modules/path-is-absolute": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", - "integrity": "sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==", + "dev": true, + "license": "MIT", "engines": { "node": ">=0.10.0" } }, "node_modules/path-key": { "version": "3.1.1", - "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", - "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", - "dev": true, + "license": "MIT", "engines": { "node": ">=8" } }, "node_modules/path-parse": { "version": "1.0.7", - "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz", - "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==" + "license": "MIT" }, "node_modules/path-scurry": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-1.11.1.tgz", - "integrity": "sha512-Xa4Nw17FS9ApQFJ9umLiJS4orGjm7ZzwUrwamcGQuHSzDyth9boKDaycYdDcZDuqYATXw4HFXgaqWTctW/v1HA==", - "dev": true, + "version": "2.0.1", + "license": "BlueOak-1.0.0", "dependencies": { - "lru-cache": "^10.2.0", - "minipass": "^5.0.0 || ^6.0.2 || ^7.0.0" + "lru-cache": "^11.0.0", + "minipass": "^7.1.2" }, "engines": { - "node": ">=16 || 14 >=14.18" + "node": "20 || >=22" }, "funding": { "url": "https://github.com/sponsors/isaacs" } }, "node_modules/path-scurry/node_modules/lru-cache": { - "version": "10.4.3", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-10.4.3.tgz", - "integrity": "sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ==", - "dev": true + "version": "11.2.4", + "license": "BlueOak-1.0.0", + "engines": { + "node": "20 || >=22" + } }, "node_modules/path-to-regexp": { "version": "1.9.0", - "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-1.9.0.tgz", - "integrity": "sha512-xIp7/apCFJuUHdDLWe8O1HIkb0kQrOMb/0u6FXQjemHn/ii5LrIzU6bdECnsiTF/GjZkMEKg1xdiZwNqDYlZ6g==", + "license": "MIT", "dependencies": { "isarray": "0.0.1" } }, "node_modules/path-type": { "version": "4.0.0", - "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz", - "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==", "dev": true, + "license": "MIT", "engines": { "node": ">=8" } }, "node_modules/pathe": { "version": "2.0.3", - "resolved": "https://registry.npmjs.org/pathe/-/pathe-2.0.3.tgz", - "integrity": "sha512-WUjGcAqP1gQacoQe+OBJsFA7Ld4DyXuUIjZ5cc75cLHvJ7dtNsTugphxIADwspS+AraAUePCKrSVtPLFj/F88w==", - "dev": true - }, - "node_modules/pathval": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/pathval/-/pathval-2.0.0.tgz", - "integrity": "sha512-vE7JKRyES09KiunauX7nd2Q9/L7lhok4smP9RZTDeD4MVs72Dp2qNFVz39Nz5a0FVEW0BJR6C0DYrq6unoziZA==", "dev": true, - "engines": { - "node": ">= 14.16" - } + "license": "MIT" }, "node_modules/picocolors": { "version": "1.1.1", - "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", - "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==" + "license": "ISC" }, "node_modules/picomatch": { "version": "2.3.1", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", - "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", + "license": "MIT", "engines": { "node": ">=8.6" }, @@ -8420,21 +7943,17 @@ }, "node_modules/popper.js": { "version": "1.16.1-lts", - "resolved": "https://registry.npmjs.org/popper.js/-/popper.js-1.16.1-lts.tgz", - "integrity": "sha512-Kjw8nKRl1m+VrSFCoVGPph93W/qrSO7ZkqPpTf7F4bk/sqcfWK019dWBUpE/fBOsOQY1dks/Bmcbfn1heM/IsA==" + "license": "MIT" }, "node_modules/possible-typed-array-names": { "version": "1.1.0", - "resolved": "https://registry.npmjs.org/possible-typed-array-names/-/possible-typed-array-names-1.1.0.tgz", - "integrity": "sha512-/+5VFTchJDoVj3bhoqi6UeymcD00DAwb1nJwamzPvHEszJ4FpF6SNNbUbOS8yI56qHzdV8eK0qEfOSiodkTdxg==", + "license": "MIT", "engines": { "node": ">= 0.4" } }, "node_modules/postcss": { - "version": "8.5.3", - "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.3.tgz", - "integrity": "sha512-dle9A3yYxlBSrt8Fu+IpjGT8SY8hN0mlaA6GY8t0P5PjIOZemULz/E2Bnm/2dcUOena75OTNkHI76uZBNUUq3A==", + "version": "8.5.6", "dev": true, "funding": [ { @@ -8450,8 +7969,9 @@ "url": "https://github.com/sponsors/ai" } ], + "license": "MIT", "dependencies": { - "nanoid": "^3.3.8", + "nanoid": "^3.3.11", "picocolors": "^1.1.1", "source-map-js": "^1.2.1" }, @@ -8461,26 +7981,16 @@ }, "node_modules/prelude-ls": { "version": "1.2.1", - "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz", - "integrity": "sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g==", "dev": true, + "license": "MIT", "engines": { "node": ">= 0.8.0" } }, - "node_modules/prepend-http": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/prepend-http/-/prepend-http-2.0.0.tgz", - "integrity": "sha512-ravE6m9Atw9Z/jjttRUZ+clIXogdghyZAuWJ3qEzjT+jI/dL1ifAqhZeC5VHzQp1MSt1+jxKkFNemj/iO7tVUA==", - "engines": { - "node": ">=4" - } - }, "node_modules/prettier": { - "version": "3.5.3", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.5.3.tgz", - "integrity": "sha512-QQtaxnoDJeAkDvDKWCLiwIXkTgRhwYDEQCghU9Z6q03iyek/rxRh/2lC3HB7P8sWT2xC/y5JDctPLBIGzHKbhw==", + "version": "3.8.0", "dev": true, + "license": "MIT", "bin": { "prettier": "bin/prettier.cjs" }, @@ -8493,9 +8003,8 @@ }, "node_modules/pretty-bytes": { "version": "6.1.1", - "resolved": "https://registry.npmjs.org/pretty-bytes/-/pretty-bytes-6.1.1.tgz", - "integrity": "sha512-mQUvGU6aUFQ+rNvTIAcZuWGRT9a6f6Yrg9bHs4ImKF+HZCEK+plBvnAZYSIQztknZF2qnzNtr6F8s0+IuptdlQ==", "dev": true, + "license": "MIT", "engines": { "node": "^14.13.1 || >=16.0.0" }, @@ -8505,9 +8014,8 @@ }, "node_modules/pretty-format": { "version": "27.5.1", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-27.5.1.tgz", - "integrity": "sha512-Qb1gy5OrP5+zDf2Bvnzdl3jsTf1qXVMazbvCoKhtKqVs4/YK4ozX4gKQJJVyNe+cajNPn0KoC0MC3FUmaHWEmQ==", "dev": true, + "license": "MIT", "dependencies": { "ansi-regex": "^5.0.1", "ansi-styles": "^5.0.0", @@ -8519,9 +8027,8 @@ }, "node_modules/pretty-format/node_modules/ansi-styles": { "version": "5.2.0", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-5.2.0.tgz", - "integrity": "sha512-Cxwpt2SfTzTtXcfOlzGEee8O+c+MmUgGrNiBcXnuWxuFJHe6a5Hz7qwhwe5OgaSYI0IJvkLqWX1ASG+cJOkEiA==", "dev": true, + "license": "MIT", "engines": { "node": ">=10" }, @@ -8531,8 +8038,8 @@ }, "node_modules/prop-types": { "version": "15.8.1", - "resolved": "https://registry.npmjs.org/prop-types/-/prop-types-15.8.1.tgz", - "integrity": "sha512-oj87CgZICdulUohogVAR7AjlC0327U4el4L6eAvOqCeudMDVU0NThNaV+b9Df4dXgSP1gXMTnPdhfe/2qDH5cg==", + "license": "MIT", + "peer": true, "dependencies": { "loose-envify": "^1.4.0", "object-assign": "^4.1.1", @@ -8541,41 +8048,35 @@ }, "node_modules/prop-types/node_modules/react-is": { "version": "16.13.1", - "resolved": "https://registry.npmjs.org/react-is/-/react-is-16.13.1.tgz", - "integrity": "sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==" + "license": "MIT" }, - "node_modules/pump": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/pump/-/pump-3.0.2.tgz", - "integrity": "sha512-tUPXtzlGM8FE3P0ZL6DVs/3P58k9nk8/jZeQCurTJylQA8qFYzHFfhBJkuqyE0FifOsQ0uKWekiZ5g8wtr28cw==", - "dependencies": { - "end-of-stream": "^1.1.0", - "once": "^1.3.1" - } + "node_modules/proto-list": { + "version": "1.2.4", + "license": "ISC" }, "node_modules/punycode": { "version": "2.3.1", - "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.1.tgz", - "integrity": "sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg==", + "license": "MIT", "engines": { "node": ">=6" } }, "node_modules/pupa": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/pupa/-/pupa-2.1.1.tgz", - "integrity": "sha512-l1jNAspIBSFqbT+y+5FosojNpVpF94nlI+wDUpqP9enwOTfHx9f0gh5nB96vl+6yTpsJsypeNrwfzPrKuHB41A==", + "version": "3.3.0", + "license": "MIT", "dependencies": { - "escape-goat": "^2.0.0" + "escape-goat": "^4.0.0" }, "engines": { - "node": ">=8" + "node": ">=12.20" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/query-string": { "version": "5.1.1", - "resolved": "https://registry.npmjs.org/query-string/-/query-string-5.1.1.tgz", - "integrity": "sha512-gjWOsm2SoGlgLEdAGt7a6slVOk9mGiXmPFMqrEhLQ68rhQuBnpfs3+EmlvqKyxnCo9/PPlF+9MtY02S1aFg+Jw==", + "license": "MIT", "dependencies": { "decode-uri-component": "^0.2.0", "object-assign": "^4.1.0", @@ -8587,8 +8088,6 @@ }, "node_modules/queue-microtask": { "version": "1.2.3", - "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", - "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", "dev": true, "funding": [ { @@ -8603,20 +8102,20 @@ "type": "consulting", "url": "https://feross.org/support" } - ] + ], + "license": "MIT" }, "node_modules/quick-lru": { "version": "4.0.1", - "resolved": "https://registry.npmjs.org/quick-lru/-/quick-lru-4.0.1.tgz", - "integrity": "sha512-ARhCpm70fzdcvNQfPoy49IaanKkTlRWF2JMzqhcJbhSFRZv7nPTvZJdcY7301IPmvW+/p0RgIWnQDLJxifsQ7g==", + "license": "MIT", "engines": { "node": ">=8" } }, "node_modules/ra-core": { "version": "3.19.12", - "resolved": "https://registry.npmjs.org/ra-core/-/ra-core-3.19.12.tgz", - "integrity": "sha512-E0cM6OjEUtccaR+dR5mL1MLiVVYML0Yf7aPhpLEq4iue73X3+CKcLztInoBhWgeevPbFQwgAtsXhlpedeyrNNg==", + "license": "MIT", + "peer": true, "dependencies": { "classnames": "~2.3.1", "date-fns": "^1.29.0", @@ -8643,21 +8142,18 @@ }, "node_modules/ra-core/node_modules/classnames": { "version": "2.3.3", - "resolved": "https://registry.npmjs.org/classnames/-/classnames-2.3.3.tgz", - "integrity": "sha512-1inzZmicIFcmUya7PGtUQeXtcF7zZpPnxtQoYOrz0uiOBGlLFa4ik4361seYL2JCcRDIyfdFHiwQolESFlw+Og==" + "license": "MIT" }, "node_modules/ra-core/node_modules/inflection": { "version": "1.13.4", - "resolved": "https://registry.npmjs.org/inflection/-/inflection-1.13.4.tgz", - "integrity": "sha512-6I/HUDeYFfuNCVS3td055BaXBwKYuzw7K3ExVMStBowKo9oOAMJIXIHvdyR3iboTCp1b+1i5DSkIZTcwIktuDw==", "engines": [ "node >= 0.4.0" - ] + ], + "license": "MIT" }, "node_modules/ra-data-json-server": { "version": "3.19.12", - "resolved": "https://registry.npmjs.org/ra-data-json-server/-/ra-data-json-server-3.19.12.tgz", - "integrity": "sha512-SEa0ueZd9LUG6iuPnHd+MHWf7BTgLKjx3Eky16VvTsqf6ueHkMU8AZiH1pHzrdxV6ku5VL34MCYWVSIbm2iDnw==", + "license": "MIT", "dependencies": { "query-string": "^5.1.1", "ra-core": "^3.19.12" @@ -8665,8 +8161,7 @@ }, "node_modules/ra-i18n-polyglot": { "version": "3.19.12", - "resolved": "https://registry.npmjs.org/ra-i18n-polyglot/-/ra-i18n-polyglot-3.19.12.tgz", - "integrity": "sha512-7VkNybY+RYVL5aDf8MdefYpRMkaELOjSXx7rrRY7PzVwmQzVe5ESoKBcH4Cob2M8a52pAlXY32dwmA3dZ91l/Q==", + "license": "MIT", "dependencies": { "node-polyglot": "^2.2.2", "ra-core": "^3.19.12" @@ -8674,17 +8169,15 @@ }, "node_modules/ra-language-english": { "version": "3.19.12", - "resolved": "https://registry.npmjs.org/ra-language-english/-/ra-language-english-3.19.12.tgz", - "integrity": "sha512-aYY0ma74eXLuflPT9iXEQtVEDZxebw1NiQZ5pPGiBCpsq+hoiDWuzerLU13OdBHbySD5FHLuk89SkyAdfMtUaQ==", + "license": "MIT", "dependencies": { "ra-core": "^3.19.12" } }, "node_modules/ra-test": { "version": "3.19.12", - "resolved": "https://registry.npmjs.org/ra-test/-/ra-test-3.19.12.tgz", - "integrity": "sha512-SX6oi+VPADIeQeQlGWUVj2kgEYgLbizpzYMq+oacCmnAqvHezwnQ2MXrLDRK6C56YIl+t8DyY/ipYBiRPZnHbA==", "dev": true, + "license": "MIT", "dependencies": { "@testing-library/react": "^11.2.3", "classnames": "~2.3.1", @@ -8702,9 +8195,8 @@ }, "node_modules/ra-test/node_modules/@testing-library/dom": { "version": "7.31.2", - "resolved": "https://registry.npmjs.org/@testing-library/dom/-/dom-7.31.2.tgz", - "integrity": "sha512-3UqjCpey6HiTZT92vODYLPxTBWlM8ZOOjr3LX5F37/VRipW2M1kX6I/Cm4VXzteZqfGfagg8yXywpcOgQBlNsQ==", "dev": true, + "license": "MIT", "dependencies": { "@babel/code-frame": "^7.10.4", "@babel/runtime": "^7.12.5", @@ -8721,9 +8213,8 @@ }, "node_modules/ra-test/node_modules/@testing-library/react": { "version": "11.2.7", - "resolved": "https://registry.npmjs.org/@testing-library/react/-/react-11.2.7.tgz", - "integrity": "sha512-tzRNp7pzd5QmbtXNG/mhdcl7Awfu/Iz1RaVHY75zTdOkmHCuzMhRL83gWHSgOAcjS3CCbyfwUHMZgRJb4kAfpA==", "dev": true, + "license": "MIT", "dependencies": { "@babel/runtime": "^7.12.5", "@testing-library/dom": "^7.28.1" @@ -8738,15 +8229,13 @@ }, "node_modules/ra-test/node_modules/@types/aria-query": { "version": "4.2.2", - "resolved": "https://registry.npmjs.org/@types/aria-query/-/aria-query-4.2.2.tgz", - "integrity": "sha512-HnYpAE1Y6kRyKM/XkEuiRQhTHvkzMBurTHnpFLYLBGPIylZNPs9jJcuOOYWxPLJCSEtmZT0Y8rHDokKN7rRTig==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/ra-test/node_modules/aria-query": { "version": "4.2.2", - "resolved": "https://registry.npmjs.org/aria-query/-/aria-query-4.2.2.tgz", - "integrity": "sha512-o/HelwhuKpTj/frsOsbNLNgnNGVIFsVP/SW2BSF14gVl7kAfMOJ6/8wUAUvG1R1NHKrfG+2sHZTu0yauT1qBrA==", "dev": true, + "license": "Apache-2.0", "dependencies": { "@babel/runtime": "^7.10.2", "@babel/runtime-corejs3": "^7.10.2" @@ -8757,15 +8246,13 @@ }, "node_modules/ra-test/node_modules/classnames": { "version": "2.3.3", - "resolved": "https://registry.npmjs.org/classnames/-/classnames-2.3.3.tgz", - "integrity": "sha512-1inzZmicIFcmUya7PGtUQeXtcF7zZpPnxtQoYOrz0uiOBGlLFa4ik4361seYL2JCcRDIyfdFHiwQolESFlw+Og==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/ra-test/node_modules/pretty-format": { "version": "26.6.2", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-26.6.2.tgz", - "integrity": "sha512-7AeGuCYNGmycyQbCqd/3PWH4eOoX/OiCa0uphp57NVTeAGdJGaAliecxwBDHYQCIvrW7aDBZCYeNTP/WX69mkg==", "dev": true, + "license": "MIT", "dependencies": { "@jest/types": "^26.6.2", "ansi-regex": "^5.0.0", @@ -8778,8 +8265,7 @@ }, "node_modules/ra-ui-materialui": { "version": "3.19.12", - "resolved": "https://registry.npmjs.org/ra-ui-materialui/-/ra-ui-materialui-3.19.12.tgz", - "integrity": "sha512-8Zz88r5yprmUxOw9/F0A/kjjVmFMb2n+sjpel8fuOWtS6y++JWonDsvTwo4yIuSF9mC0fht3f/hd2KEHQdmj6Q==", + "license": "MIT", "dependencies": { "autosuggest-highlight": "^3.1.1", "classnames": "~2.2.5", @@ -8814,29 +8300,29 @@ }, "node_modules/ra-ui-materialui/node_modules/classnames": { "version": "2.2.6", - "resolved": "https://registry.npmjs.org/classnames/-/classnames-2.2.6.tgz", - "integrity": "sha512-JR/iSQOSt+LQIWwrwEzJ9uk0xfN3mTVYMwt1Ir5mUcSN6pU+V4zQFFaJsclJbPuAUQH+yfWef6tm7l1quW3C8Q==" + "license": "MIT" + }, + "node_modules/ra-ui-materialui/node_modules/dompurify": { + "version": "2.5.9", + "license": "(MPL-2.0 OR Apache-2.0)" }, "node_modules/ra-ui-materialui/node_modules/inflection": { "version": "1.13.4", - "resolved": "https://registry.npmjs.org/inflection/-/inflection-1.13.4.tgz", - "integrity": "sha512-6I/HUDeYFfuNCVS3td055BaXBwKYuzw7K3ExVMStBowKo9oOAMJIXIHvdyR3iboTCp1b+1i5DSkIZTcwIktuDw==", "engines": [ "node >= 0.4.0" - ] + ], + "license": "MIT" }, "node_modules/randombytes": { "version": "2.1.0", - "resolved": "https://registry.npmjs.org/randombytes/-/randombytes-2.1.0.tgz", - "integrity": "sha512-vYl3iOX+4CKUWuxGi9Ukhie6fsqXqS9FE2Zaic4tNFD2N2QQaXOMFbuKK4QmDHC0JO6B1Zp41J0LpT0oR68amQ==", + "license": "MIT", "dependencies": { "safe-buffer": "^5.1.0" } }, "node_modules/rc": { "version": "1.2.8", - "resolved": "https://registry.npmjs.org/rc/-/rc-1.2.8.tgz", - "integrity": "sha512-y3bGgqKj3QBdxLbLkomlohkvsA8gdAiUQlSBJnBhfn+BPxg4bc62d8TcBW15wavDfgexCgccckhcZvywyQYPOw==", + "license": "(BSD-2-Clause OR MIT OR Apache-2.0)", "dependencies": { "deep-extend": "^0.6.0", "ini": "~1.3.0", @@ -8851,6 +8337,7 @@ "version": "4.0.15", "resolved": "https://registry.npmjs.org/rc-align/-/rc-align-4.0.15.tgz", "integrity": "sha512-wqJtVH60pka/nOX7/IspElA8gjPNQKIx/ZqJ6heATCkXpe1Zg4cPVrMD2vC96wjsFFL8WsmhPbx9tdMo1qqlIA==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.10.1", "classnames": "2.x", @@ -8867,6 +8354,7 @@ "version": "2.9.5", "resolved": "https://registry.npmjs.org/rc-motion/-/rc-motion-2.9.5.tgz", "integrity": "sha512-w+XTUrfh7ArbYEd2582uDrEhmBHwK1ZENJiSJVb7uRxdE7qJSYjbO2eksRXmndqyKqKoYPc9ClpPh5242mV1vA==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.11.1", "classnames": "^2.2.1", @@ -8881,6 +8369,7 @@ "version": "9.7.5", "resolved": "https://registry.npmjs.org/rc-slider/-/rc-slider-9.7.5.tgz", "integrity": "sha512-LV/MWcXFjco1epPbdw1JlLXlTgmWpB9/Y/P2yinf8Pg3wElHxA9uajN21lJiWtZjf5SCUekfSP6QMJfDo4t1hg==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.10.1", "classnames": "^2.2.5", @@ -8900,6 +8389,7 @@ "version": "3.2.2", "resolved": "https://registry.npmjs.org/rc-switch/-/rc-switch-3.2.2.tgz", "integrity": "sha512-+gUJClsZZzvAHGy1vZfnwySxj+MjLlGRyXKXScrtCTcmiYNPzxDFOxdQ/3pK1Kt/0POvwJ/6ALOR8gwdXGhs+A==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.10.1", "classnames": "^2.2.1", @@ -8914,6 +8404,7 @@ "version": "5.3.1", "resolved": "https://registry.npmjs.org/rc-tooltip/-/rc-tooltip-5.3.1.tgz", "integrity": "sha512-e6H0dMD38EPaSPD2XC8dRfct27VvT2TkPdoBSuNl3RRZ5tspiY/c5xYEmGC0IrABvMBgque4Mr2SMZuliCvoiQ==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.11.2", "classnames": "^2.3.1", @@ -8928,6 +8419,7 @@ "version": "5.3.4", "resolved": "https://registry.npmjs.org/rc-trigger/-/rc-trigger-5.3.4.tgz", "integrity": "sha512-mQv+vas0TwKcjAO2izNPkqR4j86OemLRmvL2nOzdP9OWNWA1ivoTt5hzFqYNW9zACwmTezRiN8bttrC7cZzYSw==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.18.3", "classnames": "^2.2.6", @@ -8947,6 +8439,7 @@ "version": "5.44.4", "resolved": "https://registry.npmjs.org/rc-util/-/rc-util-5.44.4.tgz", "integrity": "sha512-resueRJzmHG9Q6rI/DfK6Kdv9/Lfls05vzMs1Sk3M2P+3cJa+MakaZyWY8IPfehVuhPJFKrIY1IK4GqbiaiY5w==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.18.3", "react-is": "^18.2.0" @@ -8959,20 +8452,24 @@ "node_modules/rc-util/node_modules/react-is": { "version": "18.3.1", "resolved": "https://registry.npmjs.org/react-is/-/react-is-18.3.1.tgz", - "integrity": "sha512-/LLMVyas0ljjAtoYiPqYiL8VWXzUUdThrmU5+n20DZv+a+ClRoevUzw5JxU+Ieh5/c87ytoTBV9G1FiKfNJdmg==" + "integrity": "sha512-/LLMVyas0ljjAtoYiPqYiL8VWXzUUdThrmU5+n20DZv+a+ClRoevUzw5JxU+Ieh5/c87ytoTBV9G1FiKfNJdmg==", + "license": "MIT" + }, + "node_modules/rc/node_modules/ini": { + "version": "1.3.8", + "license": "ISC" }, "node_modules/rc/node_modules/strip-json-comments": { "version": "2.0.1", - "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-2.0.1.tgz", - "integrity": "sha512-4gB8na07fecVVkOI6Rs4e7T6NOTki5EmL7TUduTs6bu3EdnSycntVJ4re8kgZA+wx9IueI2Y11bfbgwtzuE0KQ==", + "license": "MIT", "engines": { "node": ">=0.10.0" } }, "node_modules/react": { "version": "17.0.2", - "resolved": "https://registry.npmjs.org/react/-/react-17.0.2.tgz", - "integrity": "sha512-gnhPt75i/dq/z3/6q/0asP78D0u592D5L1pd7M8P+dck6Fu/jJeL6iVVK23fptSUZj8Vjf++7wXA8UNclGQcbA==", + "license": "MIT", + "peer": true, "dependencies": { "loose-envify": "^1.1.0", "object-assign": "^4.1.1" @@ -8983,8 +8480,7 @@ }, "node_modules/react-admin": { "version": "3.19.12", - "resolved": "https://registry.npmjs.org/react-admin/-/react-admin-3.19.12.tgz", - "integrity": "sha512-LanWS3Yjie7n5GZI8v7oP73DSvQyCeZD0dpkC65IC0+UOhkInxa1zedJc8CyD3+ZwlgVC+CGqi6jQ1fo73Cdqw==", + "license": "MIT", "dependencies": { "@material-ui/core": "^4.12.1", "@material-ui/icons": "^4.11.2", @@ -9011,8 +8507,7 @@ }, "node_modules/react-dnd": { "version": "14.0.5", - "resolved": "https://registry.npmjs.org/react-dnd/-/react-dnd-14.0.5.tgz", - "integrity": "sha512-9i1jSgbyVw0ELlEVt/NkCUkxy1hmhJOkePoCH713u75vzHGyXhPDm28oLfc2NMSBjZRM1Y+wRjHXJT3sPrTy+A==", + "license": "MIT", "dependencies": { "@react-dnd/invariant": "^2.0.0", "@react-dnd/shallowequal": "^2.0.0", @@ -9040,16 +8535,15 @@ }, "node_modules/react-dnd-html5-backend": { "version": "14.1.0", - "resolved": "https://registry.npmjs.org/react-dnd-html5-backend/-/react-dnd-html5-backend-14.1.0.tgz", - "integrity": "sha512-6ONeqEC3XKVf4eVmMTe0oPds+c5B9Foyj8p/ZKLb7kL2qh9COYxiBHv3szd6gztqi/efkmriywLUVlPotqoJyw==", + "license": "MIT", "dependencies": { "dnd-core": "14.0.1" } }, "node_modules/react-dom": { "version": "17.0.2", - "resolved": "https://registry.npmjs.org/react-dom/-/react-dom-17.0.2.tgz", - "integrity": "sha512-s4h96KtLDUQlsENhMn1ar8t2bEa+q/YAtj8pPPdIjPDGBDIVNsrD9aXNWqspUe6AzKCIG0C1HZZLqLV7qpOBGA==", + "license": "MIT", + "peer": true, "dependencies": { "loose-envify": "^1.1.0", "object-assign": "^4.1.1", @@ -9061,19 +8555,19 @@ }, "node_modules/react-drag-listview": { "version": "0.1.9", - "resolved": "https://registry.npmjs.org/react-drag-listview/-/react-drag-listview-0.1.9.tgz", - "integrity": "sha512-/OsYevKtCUlw4FhJIfZPH7INHEmyl89sSC5COzonHW5Z2c8rHg4DNYFnUxOyqH+65o7sHweL13oaf6wr7dFvPA==", + "license": "MIT", "dependencies": { "babel-runtime": "^6.26.0", "prop-types": "^15.5.8" } }, "node_modules/react-draggable": { - "version": "4.4.6", - "resolved": "https://registry.npmjs.org/react-draggable/-/react-draggable-4.4.6.tgz", - "integrity": "sha512-LtY5Xw1zTPqHkVmtM3X8MUOxNDOUhv/khTgBgrUvwaS064bwVvxT+q5El0uUFNx5IEPKXuRejr7UqLwBIg5pdw==", + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/react-draggable/-/react-draggable-4.5.0.tgz", + "integrity": "sha512-VC+HBLEZ0XJxnOxVAZsdRi8rD04Iz3SiiKOoYzamjylUcju/hP9np/aZdLHf/7WOD268WMoNJMvYfB5yAK45cw==", + "license": "MIT", "dependencies": { - "clsx": "^1.1.1", + "clsx": "^2.1.1", "prop-types": "^15.8.1" }, "peerDependencies": { @@ -9081,18 +8575,9 @@ "react-dom": ">= 16.3.0" } }, - "node_modules/react-draggable/node_modules/clsx": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/clsx/-/clsx-1.2.1.tgz", - "integrity": "sha512-EcR6r5a8bj6pu3ycsa/E/cKVGuTgZJZdsyUYHOksG/UHIiKfjxzRxYJpyVBwYaQeOvghal9fcc4PidlgzugAQg==", - "engines": { - "node": ">=6" - } - }, "node_modules/react-dropzone": { "version": "10.2.2", - "resolved": "https://registry.npmjs.org/react-dropzone/-/react-dropzone-10.2.2.tgz", - "integrity": "sha512-U5EKckXVt6IrEyhMMsgmHQiWTGLudhajPPG77KFSvgsMqNEHSyGpqWvOMc5+DhEah/vH4E1n+J5weBNLd5VtyA==", + "license": "MIT", "dependencies": { "attr-accept": "^2.0.0", "file-selector": "^0.1.12", @@ -9107,9 +8592,8 @@ }, "node_modules/react-error-boundary": { "version": "3.1.4", - "resolved": "https://registry.npmjs.org/react-error-boundary/-/react-error-boundary-3.1.4.tgz", - "integrity": "sha512-uM9uPzZJTF6wRQORmSrvOIgt4lJ9MC1sNgEOj2XGsDTRE4kmpWxg7ENK9EWNKJRMAOY9z0MuF4yIfl6gp4sotA==", "dev": true, + "license": "MIT", "dependencies": { "@babel/runtime": "^7.12.5" }, @@ -9123,8 +8607,8 @@ }, "node_modules/react-final-form": { "version": "6.5.9", - "resolved": "https://registry.npmjs.org/react-final-form/-/react-final-form-6.5.9.tgz", - "integrity": "sha512-x3XYvozolECp3nIjly+4QqxdjSSWfcnpGEL5K8OBT6xmGrq5kBqbA6+/tOqoom9NwqIPPbxPNsOViFlbKgowbA==", + "license": "MIT", + "peer": true, "dependencies": { "@babel/runtime": "^7.15.4" }, @@ -9139,8 +8623,8 @@ }, "node_modules/react-final-form-arrays": { "version": "3.1.4", - "resolved": "https://registry.npmjs.org/react-final-form-arrays/-/react-final-form-arrays-3.1.4.tgz", - "integrity": "sha512-siVFAolUAe29rMR6u8VwepoysUcUdh6MLV2OWnCtKpsPRUdT9VUgECjAPaVMAH2GROZNiVB9On1H9MMrm9gdpg==", + "license": "MIT", + "peer": true, "dependencies": { "@babel/runtime": "^7.19.4" }, @@ -9153,8 +8637,7 @@ }, "node_modules/react-ga": { "version": "3.3.1", - "resolved": "https://registry.npmjs.org/react-ga/-/react-ga-3.3.1.tgz", - "integrity": "sha512-4Vc0W5EvXAXUN/wWyxvsAKDLLgtJ3oLmhYYssx+YzphJpejtOst6cbIHCIyF50Fdxuf5DDKqRYny24yJ2y7GFQ==", + "license": "Apache-2.0", "peerDependencies": { "prop-types": "^15.6.0", "react": "^15.6.2 || ^16.0 || ^17 || ^18" @@ -9162,8 +8645,7 @@ }, "node_modules/react-hotkeys": { "version": "2.0.0", - "resolved": "https://registry.npmjs.org/react-hotkeys/-/react-hotkeys-2.0.0.tgz", - "integrity": "sha512-3n3OU8vLX/pfcJrR3xJ1zlww6KS1kEJt0Whxc4FiGV+MJrQ1mYSYI3qS/11d2MJDFm8IhOXMTFQirfu6AVOF6Q==", + "license": "ISC", "dependencies": { "prop-types": "^15.6.1" }, @@ -9173,17 +8655,14 @@ }, "node_modules/react-icons": { "version": "5.5.0", - "resolved": "https://registry.npmjs.org/react-icons/-/react-icons-5.5.0.tgz", - "integrity": "sha512-MEFcXdkP3dLo8uumGI5xN3lDFNsRtrjbOEKDLD7yv76v4wpnEq2Lt2qeHaQOr34I/wPN3s3+N08WkQ+CW37Xiw==", + "license": "MIT", "peerDependencies": { "react": "*" } }, "node_modules/react-image-lightbox": { "version": "5.1.4", - "resolved": "https://registry.npmjs.org/react-image-lightbox/-/react-image-lightbox-5.1.4.tgz", - "integrity": "sha512-kTiAODz091bgT7SlWNHab0LSMZAPJtlNWDGKv7pLlLY1krmf7FuG1zxE0wyPpeA8gPdwfr3cu6sPwZRqWsc3Eg==", - "deprecated": "Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.", + "license": "MIT", "dependencies": { "prop-types": "^15.7.2", "react-modal": "^3.11.1" @@ -9195,18 +8674,15 @@ }, "node_modules/react-is": { "version": "17.0.2", - "resolved": "https://registry.npmjs.org/react-is/-/react-is-17.0.2.tgz", - "integrity": "sha512-w2GsyukL62IJnlaff/nRegPQR94C/XXamvMWmSHRJ4y7Ts/4ocGRmTHvOs8PSE6pB3dWOrD/nueuU5sduBsQ4w==" + "license": "MIT" }, "node_modules/react-lifecycles-compat": { "version": "3.0.4", - "resolved": "https://registry.npmjs.org/react-lifecycles-compat/-/react-lifecycles-compat-3.0.4.tgz", - "integrity": "sha512-fBASbA6LnOU9dOU2eW7aQ8xmYBSXUIWr+UmF9b1efZBazGNO+rcXT/icdKnYm2pTwcRylVUYwW7H1PHfLekVzA==" + "license": "MIT" }, "node_modules/react-measure": { "version": "2.5.2", - "resolved": "https://registry.npmjs.org/react-measure/-/react-measure-2.5.2.tgz", - "integrity": "sha512-M+rpbTLWJ3FD6FXvYV6YEGvQ5tMayQ3fGrZhRPHrE9bVlBYfDCLuDcgNttYfk8IqfOI03jz6cbpqMRTUclQnaA==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.2.0", "get-node-dimensions": "^1.2.1", @@ -9220,8 +8696,7 @@ }, "node_modules/react-modal": { "version": "3.16.3", - "resolved": "https://registry.npmjs.org/react-modal/-/react-modal-3.16.3.tgz", - "integrity": "sha512-yCYRJB5YkeQDQlTt17WGAgFJ7jr2QYcWa1SHqZ3PluDmnKJ/7+tVU+E6uKyZ0nODaeEj+xCpK4LcSnKXLMC0Nw==", + "license": "MIT", "dependencies": { "exenv": "^1.2.0", "prop-types": "^15.7.2", @@ -9235,8 +8710,8 @@ }, "node_modules/react-redux": { "version": "7.2.9", - "resolved": "https://registry.npmjs.org/react-redux/-/react-redux-7.2.9.tgz", - "integrity": "sha512-Gx4L3uM182jEEayZfRbI/G11ZpYdNAnBs70lFVMNdHJI76XYtR+7m0MN+eAs7UHBPhWXcnFPaS+9owSCJQHNpQ==", + "license": "MIT", + "peer": true, "dependencies": { "@babel/runtime": "^7.15.4", "@types/react-redux": "^7.1.20", @@ -9258,18 +8733,17 @@ } }, "node_modules/react-refresh": { - "version": "0.17.0", - "resolved": "https://registry.npmjs.org/react-refresh/-/react-refresh-0.17.0.tgz", - "integrity": "sha512-z6F7K9bV85EfseRCp2bzrpyQ0Gkw1uLoCel9XBVWPg/TjRj94SkJzUTGfOa4bs7iJvBWtQG0Wq7wnI0syw3EBQ==", + "version": "0.18.0", "dev": true, + "license": "MIT", "engines": { "node": ">=0.10.0" } }, "node_modules/react-router": { "version": "5.3.4", - "resolved": "https://registry.npmjs.org/react-router/-/react-router-5.3.4.tgz", - "integrity": "sha512-Ys9K+ppnJah3QuaRiLxk+jDWOR1MekYQrlytiXxC1RyfbdsZkS5pvKAzCCr031xHixZwpnsYNT5xysdFHQaYsA==", + "license": "MIT", + "peer": true, "dependencies": { "@babel/runtime": "^7.12.13", "history": "^4.9.0", @@ -9287,8 +8761,8 @@ }, "node_modules/react-router-dom": { "version": "5.3.4", - "resolved": "https://registry.npmjs.org/react-router-dom/-/react-router-dom-5.3.4.tgz", - "integrity": "sha512-m4EqFMHv/Ih4kpcBCONHbkT68KoAeHN4p3lAGoNryfHi0dMy0kCzEZakiKRsvg5wHZ/JLrLW8o8KomWiz/qbYQ==", + "license": "MIT", + "peer": true, "dependencies": { "@babel/runtime": "^7.12.13", "history": "^4.9.0", @@ -9304,13 +8778,11 @@ }, "node_modules/react-router/node_modules/react-is": { "version": "16.13.1", - "resolved": "https://registry.npmjs.org/react-is/-/react-is-16.13.1.tgz", - "integrity": "sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==" + "license": "MIT" }, "node_modules/react-transition-group": { "version": "4.4.5", - "resolved": "https://registry.npmjs.org/react-transition-group/-/react-transition-group-4.4.5.tgz", - "integrity": "sha512-pZcd1MCJoiKiBR2NRxeCRg13uCXbydPnmB4EOeRrY7480qNWO8IIgQG6zlDkm6uRMsURXPuKq0GWtiM59a5Q6g==", + "license": "BSD-3-Clause", "dependencies": { "@babel/runtime": "^7.5.5", "dom-helpers": "^5.0.1", @@ -9324,8 +8796,7 @@ }, "node_modules/read-pkg": { "version": "5.2.0", - "resolved": "https://registry.npmjs.org/read-pkg/-/read-pkg-5.2.0.tgz", - "integrity": "sha512-Ug69mNOpfvKDAc2Q8DRpMjjzdtrnv9HcSMX+4VsZxD1aZ6ZzrIE7rlzXBtWTyhULSMKg076AW6WR5iZpD0JiOg==", + "license": "MIT", "dependencies": { "@types/normalize-package-data": "^2.4.0", "normalize-package-data": "^2.5.0", @@ -9338,8 +8809,7 @@ }, "node_modules/read-pkg-up": { "version": "7.0.1", - "resolved": "https://registry.npmjs.org/read-pkg-up/-/read-pkg-up-7.0.1.tgz", - "integrity": "sha512-zK0TB7Xd6JpCLmlLmufqykGE+/TlOePD6qKClNW7hHDKFh/J7/7gCWGR7joEQEW1bKq3a3yUZSObOoWLFQ4ohg==", + "license": "MIT", "dependencies": { "find-up": "^4.1.0", "read-pkg": "^5.2.0", @@ -9354,8 +8824,7 @@ }, "node_modules/read-pkg-up/node_modules/find-up": { "version": "4.1.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-4.1.0.tgz", - "integrity": "sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw==", + "license": "MIT", "dependencies": { "locate-path": "^5.0.0", "path-exists": "^4.0.0" @@ -9366,8 +8835,7 @@ }, "node_modules/read-pkg-up/node_modules/locate-path": { "version": "5.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-5.0.0.tgz", - "integrity": "sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g==", + "license": "MIT", "dependencies": { "p-locate": "^4.1.0" }, @@ -9377,8 +8845,7 @@ }, "node_modules/read-pkg-up/node_modules/p-limit": { "version": "2.3.0", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", - "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", + "license": "MIT", "dependencies": { "p-try": "^2.0.0" }, @@ -9391,8 +8858,7 @@ }, "node_modules/read-pkg-up/node_modules/p-locate": { "version": "4.1.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-4.1.0.tgz", - "integrity": "sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A==", + "license": "MIT", "dependencies": { "p-limit": "^2.2.0" }, @@ -9402,24 +8868,21 @@ }, "node_modules/read-pkg-up/node_modules/type-fest": { "version": "0.8.1", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.8.1.tgz", - "integrity": "sha512-4dbzIzqvjtgiM5rw1k5rEHtBANKmdudhGyBEajN01fEyhaAIhsoKNy6y7+IN93IfpFtwY9iqi7kD+xwKhQsNJA==", + "license": "(MIT OR CC0-1.0)", "engines": { "node": ">=8" } }, "node_modules/read-pkg/node_modules/type-fest": { "version": "0.6.0", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.6.0.tgz", - "integrity": "sha512-q+MB8nYR1KDLrgr4G5yemftpMC7/QLqVndBmEEdqzmNj5dcFOO4Oo8qlwZE3ULT3+Zim1F8Kq4cBnikNhlCMlg==", + "license": "(MIT OR CC0-1.0)", "engines": { "node": ">=8" } }, "node_modules/readable-stream": { "version": "3.6.2", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz", - "integrity": "sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==", + "license": "MIT", "dependencies": { "inherits": "^2.0.3", "string_decoder": "^1.1.1", @@ -9431,8 +8894,7 @@ }, "node_modules/readdirp": { "version": "3.6.0", - "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-3.6.0.tgz", - "integrity": "sha512-hOS089on8RduqdbhvQ5Z37A0ESjsqz6qnRcffsMU3495FuTdqSm+7bhJ29JvIOsBDEEnan5DPu9t3To9VRlMzA==", + "license": "MIT", "dependencies": { "picomatch": "^2.2.1" }, @@ -9442,8 +8904,7 @@ }, "node_modules/redent": { "version": "3.0.0", - "resolved": "https://registry.npmjs.org/redent/-/redent-3.0.0.tgz", - "integrity": "sha512-6tDA8g98We0zd0GvVeMT9arEOnTw9qM03L9cJXaCjrip1OO764RDBLBfrB4cwzNGDj5OA5ioymC9GkizgWJDUg==", + "license": "MIT", "dependencies": { "indent-string": "^4.0.0", "strip-indent": "^3.0.0" @@ -9454,24 +8915,23 @@ }, "node_modules/redux": { "version": "4.2.1", - "resolved": "https://registry.npmjs.org/redux/-/redux-4.2.1.tgz", - "integrity": "sha512-LAUYz4lc+Do8/g7aeRa8JkyDErK6ekstQaqWQrNRW//MY1TvCEpMtpTWvlQ+FPbWCx+Xixu/6SHt5N0HR+SB4w==", + "license": "MIT", + "peer": true, "dependencies": { "@babel/runtime": "^7.9.2" } }, "node_modules/redux-saga": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/redux-saga/-/redux-saga-1.3.0.tgz", - "integrity": "sha512-J9RvCeAZXSTAibFY0kGw6Iy4EdyDNW7k6Q+liwX+bsck7QVsU78zz8vpBRweEfANxnnlG/xGGeOvf6r8UXzNJQ==", + "version": "1.4.2", + "license": "MIT", + "peer": true, "dependencies": { - "@redux-saga/core": "^1.3.0" + "@redux-saga/core": "^1.4.2" } }, "node_modules/reflect.getprototypeof": { "version": "1.0.10", - "resolved": "https://registry.npmjs.org/reflect.getprototypeof/-/reflect.getprototypeof-1.0.10.tgz", - "integrity": "sha512-00o4I+DVrefhv+nX0ulyi3biSHCPDe+yLv5o/p6d/UVlirijB8E16FtfwSAi4g3tcqrQ4lRAqQSoFEZJehYEcw==", + "license": "MIT", "dependencies": { "call-bind": "^1.0.8", "define-properties": "^1.2.1", @@ -9491,13 +8951,11 @@ }, "node_modules/regenerate": { "version": "1.4.2", - "resolved": "https://registry.npmjs.org/regenerate/-/regenerate-1.4.2.tgz", - "integrity": "sha512-zrceR/XhGYU/d/opr2EKO7aRHUeiBI8qjtfHqADTwZd6Szfy16la6kqD0MIUs5z5hx6AaKa+PixpPrR289+I0A==" + "license": "MIT" }, "node_modules/regenerate-unicode-properties": { - "version": "10.2.0", - "resolved": "https://registry.npmjs.org/regenerate-unicode-properties/-/regenerate-unicode-properties-10.2.0.tgz", - "integrity": "sha512-DqHn3DwbmmPVzeKj9woBadqmXxLvQoQIwu7nopMc72ztvxVmVk2SBhSnx67zuye5TP+lJsb/TBQsjLKhnDf3MA==", + "version": "10.2.2", + "license": "MIT", "dependencies": { "regenerate": "^1.4.2" }, @@ -9507,13 +8965,11 @@ }, "node_modules/regenerator-runtime": { "version": "0.11.1", - "resolved": "https://registry.npmjs.org/regenerator-runtime/-/regenerator-runtime-0.11.1.tgz", - "integrity": "sha512-MguG95oij0fC3QV3URf4V2SDYGJhJnJGqvIIgdECeODCT98wSWDAJ94SSuVpYQUoTcGUIL6L4yNB7j1DFFHSBg==" + "license": "MIT" }, "node_modules/regexp.prototype.flags": { "version": "1.5.4", - "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.5.4.tgz", - "integrity": "sha512-dYqgNSZbDwkaJ2ceRd9ojCGjBq+mOm9LmtXnAnEGyHhN/5R7iDW2TRw3h+o/jCFxus3P2LfWIIiwowAjANm7IA==", + "license": "MIT", "dependencies": { "call-bind": "^1.0.8", "define-properties": "^1.2.1", @@ -9530,98 +8986,80 @@ } }, "node_modules/regexpu-core": { - "version": "6.2.0", - "resolved": "https://registry.npmjs.org/regexpu-core/-/regexpu-core-6.2.0.tgz", - "integrity": "sha512-H66BPQMrv+V16t8xtmq+UC0CBpiTBA60V8ibS1QVReIp8T1z8hwFxqcGzm9K6lgsN7sB5edVH8a+ze6Fqm4weA==", + "version": "6.4.0", + "license": "MIT", "dependencies": { "regenerate": "^1.4.2", - "regenerate-unicode-properties": "^10.2.0", + "regenerate-unicode-properties": "^10.2.2", "regjsgen": "^0.8.0", - "regjsparser": "^0.12.0", + "regjsparser": "^0.13.0", "unicode-match-property-ecmascript": "^2.0.0", - "unicode-match-property-value-ecmascript": "^2.1.0" + "unicode-match-property-value-ecmascript": "^2.2.1" }, "engines": { "node": ">=4" } }, "node_modules/registry-auth-token": { - "version": "4.2.2", - "resolved": "https://registry.npmjs.org/registry-auth-token/-/registry-auth-token-4.2.2.tgz", - "integrity": "sha512-PC5ZysNb42zpFME6D/XlIgtNGdTl8bBOCw90xQLVMpzuuubJKYDWFAEuUNc+Cn8Z8724tg2SDhDRrkVEsqfDMg==", + "version": "5.1.1", + "license": "MIT", + "dependencies": { + "@pnpm/npm-conf": "^3.0.2" + }, + "engines": { + "node": ">=14" + } + }, + "node_modules/registry-url": { + "version": "6.0.1", + "license": "MIT", "dependencies": { "rc": "1.2.8" }, "engines": { - "node": ">=6.0.0" - } - }, - "node_modules/registry-url": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/registry-url/-/registry-url-5.1.0.tgz", - "integrity": "sha512-8acYXXTI0AkQv6RAOjE3vOaIXZkT9wo4LOFbBKYQEEnnMNBpKqdUrI6S4NT0KPIo/WVvJ5tE/X5LF/TQUf0ekw==", - "dependencies": { - "rc": "^1.2.8" + "node": ">=12" }, - "engines": { - "node": ">=8" + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/regjsgen": { "version": "0.8.0", - "resolved": "https://registry.npmjs.org/regjsgen/-/regjsgen-0.8.0.tgz", - "integrity": "sha512-RvwtGe3d7LvWiDQXeQw8p5asZUmfU1G/l6WbUXeHta7Y2PEIvBTwH6E2EfmYUK8pxcxEdEmaomqyp0vZZ7C+3Q==" + "license": "MIT" }, "node_modules/regjsparser": { - "version": "0.12.0", - "resolved": "https://registry.npmjs.org/regjsparser/-/regjsparser-0.12.0.tgz", - "integrity": "sha512-cnE+y8bz4NhMjISKbgeVJtqNbtf5QpjZP+Bslo+UqkIt9QPnX9q095eiRRASJG1/tz6dlNr6Z5NsBiWYokp6EQ==", + "version": "0.13.0", + "license": "BSD-2-Clause", "dependencies": { - "jsesc": "~3.0.2" + "jsesc": "~3.1.0" }, "bin": { "regjsparser": "bin/parser" } }, - "node_modules/regjsparser/node_modules/jsesc": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-3.0.2.tgz", - "integrity": "sha512-xKqzzWXDttJuOcawBt4KnKHHIf5oQ/Cxax+0PWFG+DFDgHNAdi+TXECADI+RYiFUMmx8792xsMbbgXj4CwnP4g==", - "bin": { - "jsesc": "bin/jsesc" - }, - "engines": { - "node": ">=6" - } - }, "node_modules/remove-accents": { "version": "0.4.4", - "resolved": "https://registry.npmjs.org/remove-accents/-/remove-accents-0.4.4.tgz", - "integrity": "sha512-EpFcOa/ISetVHEXqu+VwI96KZBmq+a8LJnGkaeFw45epGlxIZz5dhEEnNZMsQXgORu3qaMoLX4qJCzOik6ytAg==" + "license": "MIT" }, "node_modules/require-from-string": { "version": "2.0.2", - "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", - "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", + "license": "MIT", "engines": { "node": ">=0.10.0" } }, "node_modules/reselect": { "version": "3.0.1", - "resolved": "https://registry.npmjs.org/reselect/-/reselect-3.0.1.tgz", - "integrity": "sha512-b/6tFZCmRhtBMa4xGqiiRp9jh9Aqi2A687Lo265cN0/QohJQEBPiQ52f4QB6i0eF3yp3hmLL21LSGBcML2dlxA==" + "license": "MIT" }, "node_modules/resize-observer-polyfill": { "version": "1.5.1", - "resolved": "https://registry.npmjs.org/resize-observer-polyfill/-/resize-observer-polyfill-1.5.1.tgz", - "integrity": "sha512-LwZrotdHOo12nQuZlHEmtuXdqGoOD0OhaxopaNFxWzInpEgaLWoVuAMbTzixuosCx2nEG58ngzW3vxdWoxIgdg==" + "license": "MIT" }, "node_modules/resolve": { "version": "2.0.0-next.5", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-2.0.0-next.5.tgz", - "integrity": "sha512-U7WjGVG9sH8tvjW5SmGbQuui75FiyjAX72HX15DwBBwF9dNiQZRQAg9nnPhYy+TUnE0+VcrttuvNI8oSxZcocA==", "dev": true, + "license": "MIT", "dependencies": { "is-core-module": "^2.13.0", "path-parse": "^1.0.7", @@ -9636,30 +9074,19 @@ }, "node_modules/resolve-from": { "version": "4.0.0", - "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", - "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==", "dev": true, + "license": "MIT", "engines": { "node": ">=4" } }, "node_modules/resolve-pathname": { "version": "3.0.0", - "resolved": "https://registry.npmjs.org/resolve-pathname/-/resolve-pathname-3.0.0.tgz", - "integrity": "sha512-C7rARubxI8bXFNB/hqcp/4iUeIXJhJZvFPFPiSPRnhU5UPxzMFIl+2E6yY6c4k9giDJAhtV+enfA+G89N6Csng==" - }, - "node_modules/responselike": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/responselike/-/responselike-1.0.2.tgz", - "integrity": "sha512-/Fpe5guzJk1gPqdJLJR5u7eG/gNY4nImjbRDaVWVMRhne55TCmj2i9Q+54PBRfatRC8v/rIiv9BN0pMd9OV5EQ==", - "dependencies": { - "lowercase-keys": "^1.0.0" - } + "license": "MIT" }, "node_modules/restore-cursor": { "version": "3.1.0", - "resolved": "https://registry.npmjs.org/restore-cursor/-/restore-cursor-3.1.0.tgz", - "integrity": "sha512-l+sSefzHpj5qimhFSE5a8nufZYAM3sBSVMAPtYkmC+4EH2anSGaEMXSD0izRQbu9nfyQ9y5JrVmp7E8oZrUjvA==", + "license": "MIT", "dependencies": { "onetime": "^5.1.0", "signal-exit": "^3.0.2" @@ -9670,20 +9097,27 @@ }, "node_modules/reusify": { "version": "1.1.0", - "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.1.0.tgz", - "integrity": "sha512-g6QUff04oZpHs0eG5p83rFLhHeV00ug/Yf9nZM6fLeUrPguBTkTQOdpAWWspMh55TZfVQDPaN3NQJfbVRAxdIw==", "dev": true, + "license": "MIT", "engines": { "iojs": ">=1.0.0", "node": ">=0.10.0" } }, + "node_modules/rifm": { + "version": "0.7.0", + "license": "MIT", + "dependencies": { + "@babel/runtime": "^7.3.1" + }, + "peerDependencies": { + "react": ">=16.8" + } + }, "node_modules/rimraf": { "version": "3.0.2", - "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz", - "integrity": "sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==", - "deprecated": "Rimraf versions prior to v4 are no longer supported", "dev": true, + "license": "ISC", "dependencies": { "glob": "^7.1.3" }, @@ -9696,12 +9130,12 @@ }, "node_modules/rollup": { "name": "@rollup/wasm-node", - "version": "4.41.1", - "resolved": "https://registry.npmjs.org/@rollup/wasm-node/-/wasm-node-4.41.1.tgz", - "integrity": "sha512-70qfem+U3hAgwNgOlnUQiIdfKHLELUxsEWbFWg3aErPUvsyXYF1HALJBwoDgMUhRWyn+SqWVneDTnO/Kbey9hg==", + "version": "4.55.2", "devOptional": true, + "license": "MIT", + "peer": true, "dependencies": { - "@types/estree": "1.0.7" + "@types/estree": "1.0.8" }, "bin": { "rollup": "dist/bin/rollup" @@ -9716,22 +9150,18 @@ }, "node_modules/rrweb-cssom": { "version": "0.8.0", - "resolved": "https://registry.npmjs.org/rrweb-cssom/-/rrweb-cssom-0.8.0.tgz", - "integrity": "sha512-guoltQEx+9aMf2gDZ0s62EcV8lsXR+0w8915TC3ITdn2YueuNjdAYh/levpU9nFaoChh9RUS5ZdQMrKfVEN9tw==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/run-async": { "version": "2.4.1", - "resolved": "https://registry.npmjs.org/run-async/-/run-async-2.4.1.tgz", - "integrity": "sha512-tvVnVv01b8c1RrA6Ep7JkStj85Guv/YrMcwqYQnwjsAS2cTmmPGBBjAjpCW7RrSodNSoE2/qg9O4bceNvUuDgQ==", + "license": "MIT", "engines": { "node": ">=0.12.0" } }, "node_modules/run-parallel": { "version": "1.2.0", - "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", - "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", "dev": true, "funding": [ { @@ -9747,14 +9177,14 @@ "url": "https://feross.org/support" } ], + "license": "MIT", "dependencies": { "queue-microtask": "^1.2.2" } }, "node_modules/rxjs": { "version": "6.6.7", - "resolved": "https://registry.npmjs.org/rxjs/-/rxjs-6.6.7.tgz", - "integrity": "sha512-hTdwr+7yYNIT5n4AMYp85KA6yw2Va0FLa3Rguvbpa4W3I5xynaBZo41cM3XM+4Q6fRMj3sBYIR1VAmZMXYJvRQ==", + "license": "Apache-2.0", "dependencies": { "tslib": "^1.9.0" }, @@ -9764,13 +9194,11 @@ }, "node_modules/rxjs/node_modules/tslib": { "version": "1.14.1", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", - "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==" + "license": "0BSD" }, "node_modules/safe-array-concat": { "version": "1.1.3", - "resolved": "https://registry.npmjs.org/safe-array-concat/-/safe-array-concat-1.1.3.tgz", - "integrity": "sha512-AURm5f0jYEOydBj7VQlVvDrjeFgthDdEF5H1dP+6mNpoXOMo1quQqJ4wvJDyRZ9+pO3kGWoOdmV08cSv2aJV6Q==", + "license": "MIT", "dependencies": { "call-bind": "^1.0.8", "call-bound": "^1.0.2", @@ -9787,13 +9215,10 @@ }, "node_modules/safe-array-concat/node_modules/isarray": { "version": "2.0.5", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.5.tgz", - "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==" + "license": "MIT" }, "node_modules/safe-buffer": { "version": "5.2.1", - "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", - "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==", "funding": [ { "type": "github", @@ -9807,12 +9232,12 @@ "type": "consulting", "url": "https://feross.org/support" } - ] + ], + "license": "MIT" }, "node_modules/safe-push-apply": { "version": "1.0.0", - "resolved": "https://registry.npmjs.org/safe-push-apply/-/safe-push-apply-1.0.0.tgz", - "integrity": "sha512-iKE9w/Z7xCzUMIZqdBsp6pEQvwuEebH4vdpjcDWnyzaI6yl6O9FHvVpmGelvEHNsoY6wGblkxR6Zty/h00WiSA==", + "license": "MIT", "dependencies": { "es-errors": "^1.3.0", "isarray": "^2.0.5" @@ -9826,13 +9251,11 @@ }, "node_modules/safe-push-apply/node_modules/isarray": { "version": "2.0.5", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.5.tgz", - "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==" + "license": "MIT" }, "node_modules/safe-regex-test": { "version": "1.1.0", - "resolved": "https://registry.npmjs.org/safe-regex-test/-/safe-regex-test-1.1.0.tgz", - "integrity": "sha512-x/+Cz4YrimQxQccJf5mKEbIa1NzeCRNI5Ecl/ekmlYaampdNLPalVyIcCZNNH3MvmqBugV5TMYZXv0ljslUlaw==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.2", "es-errors": "^1.3.0", @@ -9847,14 +9270,12 @@ }, "node_modules/safer-buffer": { "version": "2.1.2", - "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", - "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==" + "license": "MIT" }, "node_modules/saxes": { "version": "6.0.0", - "resolved": "https://registry.npmjs.org/saxes/-/saxes-6.0.0.tgz", - "integrity": "sha512-xAg7SOnEhrm5zI3puOOKyy1OMcMlIJZYNJY7xLBwSze0UjhPLnWfj2GF2EpT0jmzaJKIWKHLsaSSajf35bcYnA==", "dev": true, + "license": "ISC", "dependencies": { "xmlchars": "^2.2.0" }, @@ -9864,8 +9285,7 @@ }, "node_modules/scheduler": { "version": "0.20.2", - "resolved": "https://registry.npmjs.org/scheduler/-/scheduler-0.20.2.tgz", - "integrity": "sha512-2eWfGgAqqWFGqtdMmcL5zCMK1U8KlXv8SQFGglL3CEtd0aDVDWgeF/YoCmvln55m5zSk3J/20hTaSBeSObsQDQ==", + "license": "MIT", "dependencies": { "loose-envify": "^1.1.0", "object-assign": "^4.1.1" @@ -9873,15 +9293,12 @@ }, "node_modules/seamless-immutable": { "version": "7.1.4", - "resolved": "https://registry.npmjs.org/seamless-immutable/-/seamless-immutable-7.1.4.tgz", - "integrity": "sha512-XiUO1QP4ki4E2PHegiGAlu6r82o5A+6tRh7IkGGTVg/h+UoeX4nFBeCGPOhb4CYjvkqsfm/TUtvOMYC1xmV30A==", + "license": "BSD-3-Clause", "optional": true }, "node_modules/semver": { - "version": "7.7.2", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.2.tgz", - "integrity": "sha512-RF0Fw+rO5AMf9MAyaRXI4AV0Ulj5lMHqVxxdSgiVbixSCXoEmmX/jk0CuJw4+3SqroYO9VoUh+HcuJivvtJemA==", - "dev": true, + "version": "7.7.3", + "license": "ISC", "bin": { "semver": "bin/semver.js" }, @@ -9889,37 +9306,16 @@ "node": ">=10" } }, - "node_modules/semver-diff": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/semver-diff/-/semver-diff-3.1.1.tgz", - "integrity": "sha512-GX0Ix/CJcHyB8c4ykpHGIAvLyOwOobtM/8d+TQkAd81/bEjgPHrfba41Vpesr7jX/t8Uh+R3EX9eAS5be+jQYg==", - "dependencies": { - "semver": "^6.3.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/semver-diff/node_modules/semver": { - "version": "6.3.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", - "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", - "bin": { - "semver": "bin/semver.js" - } - }, "node_modules/serialize-javascript": { "version": "6.0.2", - "resolved": "https://registry.npmjs.org/serialize-javascript/-/serialize-javascript-6.0.2.tgz", - "integrity": "sha512-Saa1xPByTTq2gdeFZYLLo+RFE35NHZkAbqZeWNd3BpzppeVisAqpDjcp8dyf6uIvEqJRd46jemmyA4iFIeVk8g==", + "license": "BSD-3-Clause", "dependencies": { "randombytes": "^2.1.0" } }, "node_modules/set-function-length": { "version": "1.2.2", - "resolved": "https://registry.npmjs.org/set-function-length/-/set-function-length-1.2.2.tgz", - "integrity": "sha512-pgRc4hJ4/sNjWCSS9AmnS40x3bNMDTknHgL5UaMBTMyJnU90EgWh1Rz+MC9eFu4BuN/UwZjKQuY/1v3rM7HMfg==", + "license": "MIT", "dependencies": { "define-data-property": "^1.1.4", "es-errors": "^1.3.0", @@ -9934,8 +9330,7 @@ }, "node_modules/set-function-name": { "version": "2.0.2", - "resolved": "https://registry.npmjs.org/set-function-name/-/set-function-name-2.0.2.tgz", - "integrity": "sha512-7PGFlmtwsEADb0WYyvCMa1t+yke6daIG4Wirafur5kcf+MhUnPms1UeR0CKQdTZD81yESwMHbtn+TR+dMviakQ==", + "license": "MIT", "dependencies": { "define-data-property": "^1.1.4", "es-errors": "^1.3.0", @@ -9948,8 +9343,7 @@ }, "node_modules/set-proto": { "version": "1.0.0", - "resolved": "https://registry.npmjs.org/set-proto/-/set-proto-1.0.0.tgz", - "integrity": "sha512-RJRdvCo6IAnPdsvP/7m6bsQqNnn1FCBX5ZNtFL98MmFF/4xAIJTIg1YbHW5DC2W5SKZanrC6i4HsJqlajw/dZw==", + "license": "MIT", "dependencies": { "dunder-proto": "^1.0.1", "es-errors": "^1.3.0", @@ -9962,13 +9356,12 @@ "node_modules/shallowequal": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/shallowequal/-/shallowequal-1.1.0.tgz", - "integrity": "sha512-y0m1JoUZSlPAjXVtPPW70aZWfIL/dSP7AFkRnniLCrK/8MDKog3TySTBmckD+RObVxH0v4Tox67+F14PdED2oQ==" + "integrity": "sha512-y0m1JoUZSlPAjXVtPPW70aZWfIL/dSP7AFkRnniLCrK/8MDKog3TySTBmckD+RObVxH0v4Tox67+F14PdED2oQ==", + "license": "MIT" }, "node_modules/shebang-command": { "version": "2.0.0", - "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", - "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", - "dev": true, + "license": "MIT", "dependencies": { "shebang-regex": "^3.0.0" }, @@ -9978,17 +9371,14 @@ }, "node_modules/shebang-regex": { "version": "3.0.0", - "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", - "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", - "dev": true, + "license": "MIT", "engines": { "node": ">=8" } }, "node_modules/side-channel": { "version": "1.1.0", - "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.1.0.tgz", - "integrity": "sha512-ZX99e6tRweoUXqR+VBrslhda51Nh5MTQwou5tnUDgbtyM0dBgmhEDtWGP/xbKn6hqfPRHujUNwz5fy/wbbhnpw==", + "license": "MIT", "dependencies": { "es-errors": "^1.3.0", "object-inspect": "^1.13.3", @@ -10005,8 +9395,7 @@ }, "node_modules/side-channel-list": { "version": "1.0.0", - "resolved": "https://registry.npmjs.org/side-channel-list/-/side-channel-list-1.0.0.tgz", - "integrity": "sha512-FCLHtRD/gnpCiCHEiJLOwdmFP+wzCmDEkc9y7NsYxeF4u7Btsn1ZuwgwJGxImImHicJArLP4R0yX4c2KCrMrTA==", + "license": "MIT", "dependencies": { "es-errors": "^1.3.0", "object-inspect": "^1.13.3" @@ -10020,8 +9409,7 @@ }, "node_modules/side-channel-map": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/side-channel-map/-/side-channel-map-1.0.1.tgz", - "integrity": "sha512-VCjCNfgMsby3tTdo02nbjtM/ewra6jPHmpThenkTYh8pG9ucZ/1P8So4u4FGBek/BjpOVsDCMoLA/iuBKIFXRA==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.2", "es-errors": "^1.3.0", @@ -10037,8 +9425,7 @@ }, "node_modules/side-channel-weakmap": { "version": "1.0.2", - "resolved": "https://registry.npmjs.org/side-channel-weakmap/-/side-channel-weakmap-1.0.2.tgz", - "integrity": "sha512-WPS/HvHQTYnHisLo9McqBHOJk2FkHO/tlpvldyrnem4aeQp4hai3gythswg6p01oSoTl58rcpiFAjF2br2Ak2A==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.2", "es-errors": "^1.3.0", @@ -10055,38 +9442,34 @@ }, "node_modules/siginfo": { "version": "2.0.0", - "resolved": "https://registry.npmjs.org/siginfo/-/siginfo-2.0.0.tgz", - "integrity": "sha512-ybx0WO1/8bSBLEWXZvEd7gMW3Sn3JFlW3TvX1nREbDLRNQNaeNN8WK0meBwPdAaOI7TtRRRJn/Es1zhrrCHu7g==", - "dev": true + "dev": true, + "license": "ISC" }, "node_modules/signal-exit": { "version": "3.0.7", - "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz", - "integrity": "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==" + "license": "ISC" }, "node_modules/slash": { "version": "3.0.0", - "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz", - "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==", "dev": true, + "license": "MIT", "engines": { "node": ">=8" } }, "node_modules/smob": { "version": "1.5.0", - "resolved": "https://registry.npmjs.org/smob/-/smob-1.5.0.tgz", - "integrity": "sha512-g6T+p7QO8npa+/hNx9ohv1E5pVCmWrVCUzUXJyLdMmftX6ER0oiWY/w9knEonLpnOp6b6FenKnMfR8gqwWdwig==" + "license": "MIT" }, "node_modules/sortablejs": { - "version": "1.15.6", - "resolved": "https://registry.npmjs.org/sortablejs/-/sortablejs-1.15.6.tgz", - "integrity": "sha512-aNfiuwMEpfBM/CN6LY0ibyhxPfPbyFeBTYJKCvzkJ2GkUpazIt3H+QIPAMHwqQ7tMKaHz1Qj+rJJCqljnf4p3A==" + "version": "1.15.7", + "resolved": "https://registry.npmjs.org/sortablejs/-/sortablejs-1.15.7.tgz", + "integrity": "sha512-Kk8wLQPlS+yi1ZEf48a4+fzHa4yxjC30M/Sr2AnQu+f/MPwvvX9XjZ6OWejiz8crBsLwSq8GHqaxaET7u6ux0A==", + "license": "MIT" }, "node_modules/source-map": { "version": "0.8.0-beta.0", - "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.8.0-beta.0.tgz", - "integrity": "sha512-2ymg6oRBpebeZi9UUNsgQ89bhx01TcTkmNTGnNO88imTmbSgy4nfujrgVEFKWpMTEGA11EDkTt7mqObTPdigIA==", + "license": "BSD-3-Clause", "dependencies": { "whatwg-url": "^7.0.0" }, @@ -10096,17 +9479,15 @@ }, "node_modules/source-map-js": { "version": "1.2.1", - "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.1.tgz", - "integrity": "sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==", "dev": true, + "license": "BSD-3-Clause", "engines": { "node": ">=0.10.0" } }, "node_modules/source-map-support": { "version": "0.5.21", - "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.21.tgz", - "integrity": "sha512-uBHU3L3czsIyYXKX88fdrGovxdSCoTGDRZ6SYXtSRxLZUzHg5P/66Ht6uoUlHu9EZod+inXhKo3qQgwXUT/y1w==", + "license": "MIT", "dependencies": { "buffer-from": "^1.0.0", "source-map": "^0.6.0" @@ -10114,29 +9495,25 @@ }, "node_modules/source-map-support/node_modules/source-map": { "version": "0.6.1", - "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", - "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "license": "BSD-3-Clause", "engines": { "node": ">=0.10.0" } }, "node_modules/source-map/node_modules/tr46": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/tr46/-/tr46-1.0.1.tgz", - "integrity": "sha512-dTpowEjclQ7Kgx5SdBkqRzVhERQXov8/l9Ft9dVM9fmg0W0KQSVaXX9T4i6twCPNtYiZM53lpSSUAwJbFPOHxA==", + "license": "MIT", "dependencies": { "punycode": "^2.1.0" } }, "node_modules/source-map/node_modules/webidl-conversions": { "version": "4.0.2", - "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-4.0.2.tgz", - "integrity": "sha512-YQ+BmxuTgd6UXZW3+ICGfyqRyHXVlD5GtQr5+qjiNW7bF0cqrzX500HVXPBOvgXb5YnzDd+h0zqyv61KUD7+Sg==" + "license": "BSD-2-Clause" }, "node_modules/source-map/node_modules/whatwg-url": { "version": "7.1.0", - "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-7.1.0.tgz", - "integrity": "sha512-WUu7Rg1DroM7oQvGWfOiAK21n74Gg+T4elXEQYkOhtyLeWiJFoOGLXPKI/9gzIie9CtwVLm8wtw6YJdKyxSjeg==", + "license": "MIT", "dependencies": { "lodash.sortby": "^4.7.0", "tr46": "^1.0.1", @@ -10145,14 +9522,11 @@ }, "node_modules/sourcemap-codec": { "version": "1.4.8", - "resolved": "https://registry.npmjs.org/sourcemap-codec/-/sourcemap-codec-1.4.8.tgz", - "integrity": "sha512-9NykojV5Uih4lgo5So5dtw+f0JgJX30KCNI8gwhz2J9A15wD0Ml6tjHKwf6fTSa6fAdVBdZeNOs9eJ71qCk8vA==", - "deprecated": "Please use @jridgewell/sourcemap-codec instead" + "license": "MIT" }, "node_modules/spdx-correct": { "version": "3.2.0", - "resolved": "https://registry.npmjs.org/spdx-correct/-/spdx-correct-3.2.0.tgz", - "integrity": "sha512-kN9dJbvnySHULIluDHy32WHRUu3Og7B9sbY7tsFLctQkIqnMh3hErYgdMjTYuqmcXX+lK5T1lnUt3G7zNswmZA==", + "license": "Apache-2.0", "dependencies": { "spdx-expression-parse": "^3.0.0", "spdx-license-ids": "^3.0.0" @@ -10160,40 +9534,37 @@ }, "node_modules/spdx-exceptions": { "version": "2.5.0", - "resolved": "https://registry.npmjs.org/spdx-exceptions/-/spdx-exceptions-2.5.0.tgz", - "integrity": "sha512-PiU42r+xO4UbUS1buo3LPJkjlO7430Xn5SVAhdpzzsPHsjbYVflnnFdATgabnLude+Cqu25p6N+g2lw/PFsa4w==" + "license": "CC-BY-3.0" }, "node_modules/spdx-expression-parse": { "version": "3.0.1", - "resolved": "https://registry.npmjs.org/spdx-expression-parse/-/spdx-expression-parse-3.0.1.tgz", - "integrity": "sha512-cbqHunsQWnJNE6KhVSMsMeH5H/L9EpymbzqTQ3uLwNCLZ1Q481oWaofqH7nO6V07xlXwY6PhQdQ2IedWx/ZK4Q==", + "license": "MIT", "dependencies": { "spdx-exceptions": "^2.1.0", "spdx-license-ids": "^3.0.0" } }, "node_modules/spdx-license-ids": { - "version": "3.0.21", - "resolved": "https://registry.npmjs.org/spdx-license-ids/-/spdx-license-ids-3.0.21.tgz", - "integrity": "sha512-Bvg/8F5XephndSK3JffaRqdT+gyhfqIPwDHpX80tJrF8QQRYMo8sNMeaZ2Dp5+jhwKnUmIOyFFQfHRkjJm5nXg==" + "version": "3.0.22", + "license": "CC0-1.0" + }, + "node_modules/sprintf-js": { + "version": "1.0.3", + "license": "BSD-3-Clause" }, "node_modules/stackback": { "version": "0.0.2", - "resolved": "https://registry.npmjs.org/stackback/-/stackback-0.0.2.tgz", - "integrity": "sha512-1XMJE5fQo1jGH6Y/7ebnwPOBEkIEnT4QF32d5R1+VXdXveM0IBMJt8zfaxX1P3QhVwrYe+576+jkANtSS2mBbw==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/std-env": { - "version": "3.9.0", - "resolved": "https://registry.npmjs.org/std-env/-/std-env-3.9.0.tgz", - "integrity": "sha512-UGvjygr6F6tpH7o2qyqR6QYpwraIjKSdtzyBdyytFOHmPZY917kwdwLG0RbOjWOnKmnm3PeHjaoLLMie7kPLQw==", - "dev": true + "version": "3.10.0", + "dev": true, + "license": "MIT" }, "node_modules/stop-iteration-iterator": { "version": "1.1.0", - "resolved": "https://registry.npmjs.org/stop-iteration-iterator/-/stop-iteration-iterator-1.1.0.tgz", - "integrity": "sha512-eLoXW/DHyl62zxY4SCaIgnRhuMr6ri4juEYARS8E6sCEqzKpOiE521Ucofdx+KnDZl5xmvGYaaKCk5FEOxJCoQ==", - "dev": true, + "license": "MIT", "dependencies": { "es-errors": "^1.3.0", "internal-slot": "^1.1.0" @@ -10204,24 +9575,21 @@ }, "node_modules/strict-uri-encode": { "version": "1.1.0", - "resolved": "https://registry.npmjs.org/strict-uri-encode/-/strict-uri-encode-1.1.0.tgz", - "integrity": "sha512-R3f198pcvnB+5IpnBlRkphuE9n46WyVl8I39W/ZUTZLz4nqSP/oLYUrcnJrw462Ds8he4YKMov2efsTIw1BDGQ==", + "license": "MIT", "engines": { "node": ">=0.10.0" } }, "node_modules/string_decoder": { "version": "1.3.0", - "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz", - "integrity": "sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==", + "license": "MIT", "dependencies": { "safe-buffer": "~5.2.0" } }, "node_modules/string-width": { "version": "4.2.3", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", - "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "license": "MIT", "dependencies": { "emoji-regex": "^8.0.0", "is-fullwidth-code-point": "^3.0.0", @@ -10234,9 +9602,7 @@ "node_modules/string-width-cjs": { "name": "string-width", "version": "4.2.3", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", - "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", - "dev": true, + "license": "MIT", "dependencies": { "emoji-regex": "^8.0.0", "is-fullwidth-code-point": "^3.0.0", @@ -10248,20 +9614,16 @@ }, "node_modules/string-width-cjs/node_modules/emoji-regex": { "version": "8.0.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", - "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", - "dev": true + "license": "MIT" }, "node_modules/string-width/node_modules/emoji-regex": { "version": "8.0.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", - "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==" + "license": "MIT" }, "node_modules/string.prototype.includes": { "version": "2.0.1", - "resolved": "https://registry.npmjs.org/string.prototype.includes/-/string.prototype.includes-2.0.1.tgz", - "integrity": "sha512-o7+c9bW6zpAdJHTtujeePODAhkuicdAryFsfVKwA+wGw89wJ4GTY484WTucM9hLtDEOpOvI+aHnzqnC5lHp4Rg==", "dev": true, + "license": "MIT", "dependencies": { "call-bind": "^1.0.7", "define-properties": "^1.2.1", @@ -10273,8 +9635,7 @@ }, "node_modules/string.prototype.matchall": { "version": "4.0.12", - "resolved": "https://registry.npmjs.org/string.prototype.matchall/-/string.prototype.matchall-4.0.12.tgz", - "integrity": "sha512-6CC9uyBL+/48dYizRf7H7VAYCMCNTBeM78x/VTUe9bFEaxBepPJDa1Ow99LqI/1yF7kuy7Q3cQsYMrcjGUcskA==", + "license": "MIT", "dependencies": { "call-bind": "^1.0.8", "call-bound": "^1.0.3", @@ -10299,9 +9660,8 @@ }, "node_modules/string.prototype.repeat": { "version": "1.0.0", - "resolved": "https://registry.npmjs.org/string.prototype.repeat/-/string.prototype.repeat-1.0.0.tgz", - "integrity": "sha512-0u/TldDbKD8bFCQ/4f5+mNRrXwZ8hg2w7ZR8wa16e8z9XpePWl3eGEcUD0OXpEH/VJH/2G3gjUtR3ZOiBe2S/w==", "dev": true, + "license": "MIT", "dependencies": { "define-properties": "^1.1.3", "es-abstract": "^1.17.5" @@ -10309,8 +9669,7 @@ }, "node_modules/string.prototype.trim": { "version": "1.2.10", - "resolved": "https://registry.npmjs.org/string.prototype.trim/-/string.prototype.trim-1.2.10.tgz", - "integrity": "sha512-Rs66F0P/1kedk5lyYyH9uBzuiI/kNRmwJAR9quK6VOtIpZ2G+hMZd+HQbbv25MgCA6gEffoMZYxlTod4WcdrKA==", + "license": "MIT", "dependencies": { "call-bind": "^1.0.8", "call-bound": "^1.0.2", @@ -10329,8 +9688,7 @@ }, "node_modules/string.prototype.trimend": { "version": "1.0.9", - "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.9.tgz", - "integrity": "sha512-G7Ok5C6E/j4SGfyLCloXTrngQIQU3PWtXGst3yM7Bea9FRURf1S42ZHlZZtsNque2FN2PoUhfZXYLNWwEr4dLQ==", + "license": "MIT", "dependencies": { "call-bind": "^1.0.8", "call-bound": "^1.0.2", @@ -10346,8 +9704,7 @@ }, "node_modules/string.prototype.trimstart": { "version": "1.0.8", - "resolved": "https://registry.npmjs.org/string.prototype.trimstart/-/string.prototype.trimstart-1.0.8.tgz", - "integrity": "sha512-UXSH262CSZY1tfu3G3Secr6uGLCFVPMhIqHjlgCUtCCcgihYc/xKs9djMTMUOb2j1mVSeU8EU6NWc/iQKU6Gfg==", + "license": "MIT", "dependencies": { "call-bind": "^1.0.7", "define-properties": "^1.2.1", @@ -10362,8 +9719,7 @@ }, "node_modules/stringify-object": { "version": "3.3.0", - "resolved": "https://registry.npmjs.org/stringify-object/-/stringify-object-3.3.0.tgz", - "integrity": "sha512-rHqiFh1elqCQ9WPLIC8I0Q/g/wj5J1eMkyoiD6eoQApWHP0FtlK7rqnhmabL5VUY9JQCcqwwvlOaSuutekgyrw==", + "license": "BSD-2-Clause", "dependencies": { "get-own-enumerable-property-symbols": "^3.0.0", "is-obj": "^1.0.1", @@ -10375,8 +9731,7 @@ }, "node_modules/strip-ansi": { "version": "6.0.1", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", - "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "license": "MIT", "dependencies": { "ansi-regex": "^5.0.1" }, @@ -10387,9 +9742,7 @@ "node_modules/strip-ansi-cjs": { "name": "strip-ansi", "version": "6.0.1", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", - "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", - "dev": true, + "license": "MIT", "dependencies": { "ansi-regex": "^5.0.1" }, @@ -10399,16 +9752,14 @@ }, "node_modules/strip-comments": { "version": "2.0.1", - "resolved": "https://registry.npmjs.org/strip-comments/-/strip-comments-2.0.1.tgz", - "integrity": "sha512-ZprKx+bBLXv067WTCALv8SSz5l2+XhpYCsVtSqlMnkAXMWDq+/ekVbl1ghqP9rUHTzv6sm/DwCOiYutU/yp1fw==", + "license": "MIT", "engines": { "node": ">=10" } }, "node_modules/strip-indent": { "version": "3.0.0", - "resolved": "https://registry.npmjs.org/strip-indent/-/strip-indent-3.0.0.tgz", - "integrity": "sha512-laJTa3Jb+VQpaC6DseHhF7dXVqHTfJPCRDaEbid/drOhgitgYku/letMUqOXFoWV0zIIUbjpdH2t+tYj4bQMRQ==", + "license": "MIT", "dependencies": { "min-indent": "^1.0.0" }, @@ -10418,9 +9769,8 @@ }, "node_modules/strip-json-comments": { "version": "3.1.1", - "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", - "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", "dev": true, + "license": "MIT", "engines": { "node": ">=8" }, @@ -10428,10 +9778,20 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/stubborn-fs": { + "version": "2.0.0", + "license": "MIT", + "dependencies": { + "stubborn-utils": "^1.0.1" + } + }, + "node_modules/stubborn-utils": { + "version": "1.0.2", + "license": "MIT" + }, "node_modules/supports-color": { "version": "7.2.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", - "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "license": "MIT", "dependencies": { "has-flag": "^4.0.0" }, @@ -10441,8 +9801,7 @@ }, "node_modules/supports-preserve-symlinks-flag": { "version": "1.0.0", - "resolved": "https://registry.npmjs.org/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz", - "integrity": "sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==", + "license": "MIT", "engines": { "node": ">= 0.4" }, @@ -10452,22 +9811,19 @@ }, "node_modules/symbol-tree": { "version": "3.2.4", - "resolved": "https://registry.npmjs.org/symbol-tree/-/symbol-tree-3.2.4.tgz", - "integrity": "sha512-9QNk5KwDF+Bvz+PyObkmSYjI5ksVUYtjW7AU22r2NKcfLJcXp96hkDWU3+XndOsUb+AQ9QhfzfCT2O+CNWT5Tw==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/temp-dir": { "version": "2.0.0", - "resolved": "https://registry.npmjs.org/temp-dir/-/temp-dir-2.0.0.tgz", - "integrity": "sha512-aoBAniQmmwtcKp/7BzsH8Cxzv8OL736p7v1ihGb5e9DJ9kTwGWHrQrVB5+lfVDzfGrdRzXch+ig7LHaY1JTOrg==", + "license": "MIT", "engines": { "node": ">=8" } }, "node_modules/tempy": { "version": "0.6.0", - "resolved": "https://registry.npmjs.org/tempy/-/tempy-0.6.0.tgz", - "integrity": "sha512-G13vtMYPT/J8A4X2SjdtBTphZlrp1gKv6hZiOjw14RCWg6GbHuQBGtjlx75xLbYV/wEc0D7G5K4rxKP/cXk8Bw==", + "license": "MIT", "dependencies": { "is-stream": "^2.0.0", "temp-dir": "^2.0.0", @@ -10481,24 +9837,22 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/term-size": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/term-size/-/term-size-2.2.1.tgz", - "integrity": "sha512-wK0Ri4fOGjv/XPy8SBHZChl8CM7uMc5VML7SqiQ0zG7+J5Vr+RMQDoHa2CNT6KHUnTGIXH34UDMkPzAUyapBZg==", + "node_modules/tempy/node_modules/type-fest": { + "version": "0.16.0", + "license": "(MIT OR CC0-1.0)", "engines": { - "node": ">=8" + "node": ">=10" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/terser": { - "version": "5.39.2", - "resolved": "https://registry.npmjs.org/terser/-/terser-5.39.2.tgz", - "integrity": "sha512-yEPUmWve+VA78bI71BW70Dh0TuV4HHd+I5SHOAfS1+QBOmvmCiiffgjR8ryyEd3KIfvPGFqoADt8LdQ6XpXIvg==", + "version": "5.46.0", + "license": "BSD-2-Clause", "dependencies": { "@jridgewell/source-map": "^0.3.3", - "acorn": "^8.14.0", + "acorn": "^8.15.0", "commander": "^2.20.0", "source-map-support": "~0.5.20" }, @@ -10509,96 +9863,43 @@ "node": ">=10" } }, - "node_modules/test-exclude": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/test-exclude/-/test-exclude-7.0.1.tgz", - "integrity": "sha512-pFYqmTw68LXVjeWJMST4+borgQP2AyMNbg1BpZh9LbyhUeNkeaPF9gzfPGUAnSMV3qPYdWUwDIjjCLiSDOl7vg==", + "node_modules/text-table": { + "version": "0.2.0", "dev": true, - "dependencies": { - "@istanbuljs/schema": "^0.1.2", - "glob": "^10.4.1", - "minimatch": "^9.0.4" - }, + "license": "MIT" + }, + "node_modules/through": { + "version": "2.3.8", + "license": "MIT" + }, + "node_modules/tiny-invariant": { + "version": "1.3.3", + "license": "MIT" + }, + "node_modules/tiny-warning": { + "version": "1.0.3", + "license": "MIT" + }, + "node_modules/tinybench": { + "version": "2.9.0", + "dev": true, + "license": "MIT" + }, + "node_modules/tinyexec": { + "version": "1.0.2", + "dev": true, + "license": "MIT", "engines": { "node": ">=18" } }, - "node_modules/test-exclude/node_modules/glob": { - "version": "10.4.5", - "resolved": "https://registry.npmjs.org/glob/-/glob-10.4.5.tgz", - "integrity": "sha512-7Bv8RF0k6xjo7d4A/PxYLbUCfb6c+Vpd2/mB2yRDlew7Jb5hEXiCD9ibfO7wpk8i4sevK6DFny9h7EYbM3/sHg==", - "dev": true, - "dependencies": { - "foreground-child": "^3.1.0", - "jackspeak": "^3.1.2", - "minimatch": "^9.0.4", - "minipass": "^7.1.2", - "package-json-from-dist": "^1.0.0", - "path-scurry": "^1.11.1" - }, - "bin": { - "glob": "dist/esm/bin.mjs" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/test-exclude/node_modules/minimatch": { - "version": "9.0.5", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", - "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==", - "dev": true, - "dependencies": { - "brace-expansion": "^2.0.1" - }, - "engines": { - "node": ">=16 || 14 >=14.17" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/text-table": { - "version": "0.2.0", - "resolved": "https://registry.npmjs.org/text-table/-/text-table-0.2.0.tgz", - "integrity": "sha512-N+8UisAXDGk8PFXP4HAzVR9nbfmVJ3zYLAWiTIoqC5v5isinhr+r5uaO8+7r3BMfuNIufIsA7RdpVgacC2cSpw==", - "dev": true - }, - "node_modules/through": { - "version": "2.3.8", - "resolved": "https://registry.npmjs.org/through/-/through-2.3.8.tgz", - "integrity": "sha512-w89qg7PI8wAdvX60bMDP+bFoD5Dvhm9oLheFp5O4a2QF0cSBGsBX4qZmadPMvVqlLJBBci+WqGGOAPvcDeNSVg==" - }, - "node_modules/tiny-invariant": { - "version": "1.3.3", - "resolved": "https://registry.npmjs.org/tiny-invariant/-/tiny-invariant-1.3.3.tgz", - "integrity": "sha512-+FbBPE1o9QAYvviau/qC5SE3caw21q3xkvWKBtja5vgqOWIHHJ3ioaq1VPfn/Szqctz2bU/oYeKd9/z5BL+PVg==" - }, - "node_modules/tiny-warning": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/tiny-warning/-/tiny-warning-1.0.3.tgz", - "integrity": "sha512-lBN9zLN/oAf68o3zNXYrdCt1kP8WsiGW8Oo2ka41b2IM5JL/S1CTyX1rW0mb/zSuJun0ZUrDxx4sqvYS2FWzPA==" - }, - "node_modules/tinybench": { - "version": "2.9.0", - "resolved": "https://registry.npmjs.org/tinybench/-/tinybench-2.9.0.tgz", - "integrity": "sha512-0+DUvqWMValLmha6lr4kD8iAMK1HzV0/aKnCtWb9v9641TnP/MFb7Pc2bxoxQjTXAErryXVgUOfv2YqNllqGeg==", - "dev": true - }, - "node_modules/tinyexec": { - "version": "0.3.2", - "resolved": "https://registry.npmjs.org/tinyexec/-/tinyexec-0.3.2.tgz", - "integrity": "sha512-KQQR9yN7R5+OSwaK0XQoj22pwHoTlgYqmUscPYoknOoWCWfj/5/ABTMRi69FrKU5ffPVh5QcFikpWJI/P1ocHA==", - "dev": true - }, "node_modules/tinyglobby": { - "version": "0.2.13", - "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.13.tgz", - "integrity": "sha512-mEwzpUgrLySlveBwEVDMKk5B57bhLPYovRfPAXD5gA/98Opn0rCDj3GtLwFvCvH5RK9uPCExUROW5NjDwvqkxw==", + "version": "0.2.15", "dev": true, + "license": "MIT", "dependencies": { - "fdir": "^6.4.4", - "picomatch": "^4.0.2" + "fdir": "^6.5.0", + "picomatch": "^4.0.3" }, "engines": { "node": ">=12.0.0" @@ -10608,10 +9909,12 @@ } }, "node_modules/tinyglobby/node_modules/fdir": { - "version": "6.4.4", - "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.4.4.tgz", - "integrity": "sha512-1NZP+GK4GfuAv3PqKvxQRDMjdSRZjnkq7KfhlNrCNNlZ0ygQFpebfrnfnq/W7fpUnAv9aGWmY1zKx7FYL3gwhg==", + "version": "6.5.0", "dev": true, + "license": "MIT", + "engines": { + "node": ">=12.0.0" + }, "peerDependencies": { "picomatch": "^3 || ^4" }, @@ -10622,10 +9925,10 @@ } }, "node_modules/tinyglobby/node_modules/picomatch": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.2.tgz", - "integrity": "sha512-M7BAV6Rlcy5u+m6oPhAPFgJTzAioX/6B0DxyvDlo9l8+T3nLKbrczg2WLUyzd45L8RqfUMyGPzekbMvX2Ldkwg==", + "version": "4.0.3", "dev": true, + "license": "MIT", + "peer": true, "engines": { "node": ">=12" }, @@ -10633,38 +9936,18 @@ "url": "https://github.com/sponsors/jonschlinkert" } }, - "node_modules/tinypool": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/tinypool/-/tinypool-1.0.2.tgz", - "integrity": "sha512-al6n+QEANGFOMf/dmUMsuS5/r9B06uwlyNjZZql/zv8J7ybHCgoihBNORZCY2mzUuAnomQa2JdhyHKzZxPCrFA==", - "dev": true, - "engines": { - "node": "^18.0.0 || >=20.0.0" - } - }, "node_modules/tinyrainbow": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/tinyrainbow/-/tinyrainbow-2.0.0.tgz", - "integrity": "sha512-op4nsTR47R6p0vMUUoYl/a+ljLFVtlfaXkLQmqfLR1qHma1h/ysYk4hEXZ880bf2CYgTskvTa/e196Vd5dDQXw==", - "dev": true, - "engines": { - "node": ">=14.0.0" - } - }, - "node_modules/tinyspy": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/tinyspy/-/tinyspy-3.0.2.tgz", - "integrity": "sha512-n1cw8k1k0x4pgA2+9XrOkFydTerNcJ1zWCO5Nn9scWHTD+5tp8dghT2x1uduQePZTZgd3Tupf+x9BxJjeJi77Q==", + "version": "3.0.3", "dev": true, + "license": "MIT", "engines": { "node": ">=14.0.0" } }, "node_modules/tldts": { "version": "6.1.86", - "resolved": "https://registry.npmjs.org/tldts/-/tldts-6.1.86.tgz", - "integrity": "sha512-WMi/OQ2axVTf/ykqCQgXiIct+mSQDFdH2fkwhPwgEwvJ1kSzZRiinb0zF2Xb8u4+OqPChmyI6MEu4EezNJz+FQ==", "dev": true, + "license": "MIT", "dependencies": { "tldts-core": "^6.1.86" }, @@ -10674,14 +9957,12 @@ }, "node_modules/tldts-core": { "version": "6.1.86", - "resolved": "https://registry.npmjs.org/tldts-core/-/tldts-core-6.1.86.tgz", - "integrity": "sha512-Je6p7pkk+KMzMv2XXKmAE3McmolOQFdxkKw0R8EYNr7sELW46JqnNeTX8ybPiQgvg1ymCoF8LXs5fzFaZvJPTA==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/tmp": { "version": "0.0.33", - "resolved": "https://registry.npmjs.org/tmp/-/tmp-0.0.33.tgz", - "integrity": "sha512-jRCJlojKnZ3addtTOjdIqoRuPEKBvNXcGYqzO6zWZX8KfKEpnGY5jfggJQ3EjKuu8D4bJRr0y+cYJFmYbImXGw==", + "license": "MIT", "dependencies": { "os-tmpdir": "~1.0.2" }, @@ -10689,18 +9970,9 @@ "node": ">=0.6.0" } }, - "node_modules/to-readable-stream": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/to-readable-stream/-/to-readable-stream-1.0.0.tgz", - "integrity": "sha512-Iq25XBt6zD5npPhlLVXGFN3/gyR2/qODcKNNyTMd4vbm39HUaOiAM4PMq0eMVC/Tkxz+Zjdsc55g9yyz+Yq00Q==", - "engines": { - "node": ">=6" - } - }, "node_modules/to-regex-range": { "version": "5.0.1", - "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", - "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "license": "MIT", "dependencies": { "is-number": "^7.0.0" }, @@ -10710,9 +9982,8 @@ }, "node_modules/tough-cookie": { "version": "5.1.2", - "resolved": "https://registry.npmjs.org/tough-cookie/-/tough-cookie-5.1.2.tgz", - "integrity": "sha512-FVDYdxtnj0G6Qm/DhNPSb8Ju59ULcup3tuJxkFb5K8Bv2pUXILbf0xZWU8PX8Ov19OXljbUyveOFwRMwkXzO+A==", "dev": true, + "license": "BSD-3-Clause", "dependencies": { "tldts": "^6.1.32" }, @@ -10722,9 +9993,8 @@ }, "node_modules/tr46": { "version": "5.1.1", - "resolved": "https://registry.npmjs.org/tr46/-/tr46-5.1.1.tgz", - "integrity": "sha512-hdF5ZgjTqgAntKkklYw0R03MG2x/bSzTtkxmIRw/sTNV8YXsCJ1tfLAX23lhxhHJlEf3CRCOCGGWw3vI3GaSPw==", "dev": true, + "license": "MIT", "dependencies": { "punycode": "^2.3.1" }, @@ -10734,17 +10004,15 @@ }, "node_modules/trim-newlines": { "version": "3.0.1", - "resolved": "https://registry.npmjs.org/trim-newlines/-/trim-newlines-3.0.1.tgz", - "integrity": "sha512-c1PTsA3tYrIsLGkJkzHF+w9F2EyxfXGo4UyJc4pFL++FMjnq0HJS69T3M7d//gKrFKwy429bouPescbjecU+Zw==", + "license": "MIT", "engines": { "node": ">=8" } }, "node_modules/ts-api-utils": { "version": "1.4.3", - "resolved": "https://registry.npmjs.org/ts-api-utils/-/ts-api-utils-1.4.3.tgz", - "integrity": "sha512-i3eMG77UTMD0hZhgRS562pv83RC6ukSAC2GMNWc+9dieh/+jDM5u5YG+NHX6VNDRHQcHwmsTHctP9LhbC3WxVw==", "dev": true, + "license": "MIT", "engines": { "node": ">=16" }, @@ -10754,14 +10022,12 @@ }, "node_modules/tslib": { "version": "2.8.1", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz", - "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==" + "license": "0BSD" }, "node_modules/type-check": { "version": "0.4.0", - "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz", - "integrity": "sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew==", "dev": true, + "license": "MIT", "dependencies": { "prelude-ls": "^1.2.1" }, @@ -10770,9 +10036,9 @@ } }, "node_modules/type-fest": { - "version": "0.16.0", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.16.0.tgz", - "integrity": "sha512-eaBzG6MxNzEn9kiwvtre90cXaNLkmadMWa1zQMs3XORCXNbsH/OewwbxC5ia9dCxIxnTAsSxXJaa/p5y8DlvJg==", + "version": "0.20.2", + "dev": true, + "license": "(MIT OR CC0-1.0)", "engines": { "node": ">=10" }, @@ -10782,8 +10048,7 @@ }, "node_modules/typed-array-buffer": { "version": "1.0.3", - "resolved": "https://registry.npmjs.org/typed-array-buffer/-/typed-array-buffer-1.0.3.tgz", - "integrity": "sha512-nAYYwfY3qnzX30IkA6AQZjVbtK6duGontcQm1WSG1MD94YLqK0515GNApXkoxKOWMusVssAHWLh9SeaoefYFGw==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.3", "es-errors": "^1.3.0", @@ -10795,8 +10060,7 @@ }, "node_modules/typed-array-byte-length": { "version": "1.0.3", - "resolved": "https://registry.npmjs.org/typed-array-byte-length/-/typed-array-byte-length-1.0.3.tgz", - "integrity": "sha512-BaXgOuIxz8n8pIq3e7Atg/7s+DpiYrxn4vdot3w9KbnBhcRQq6o3xemQdIfynqSeXeDrF32x+WvfzmOjPiY9lg==", + "license": "MIT", "dependencies": { "call-bind": "^1.0.8", "for-each": "^0.3.3", @@ -10813,8 +10077,7 @@ }, "node_modules/typed-array-byte-offset": { "version": "1.0.4", - "resolved": "https://registry.npmjs.org/typed-array-byte-offset/-/typed-array-byte-offset-1.0.4.tgz", - "integrity": "sha512-bTlAFB/FBYMcuX81gbL4OcpH5PmlFHqlCCpAl8AlEzMz5k53oNDvN8p1PNOWLEmI2x4orp3raOFB51tv9X+MFQ==", + "license": "MIT", "dependencies": { "available-typed-arrays": "^1.0.7", "call-bind": "^1.0.8", @@ -10833,8 +10096,7 @@ }, "node_modules/typed-array-length": { "version": "1.0.7", - "resolved": "https://registry.npmjs.org/typed-array-length/-/typed-array-length-1.0.7.tgz", - "integrity": "sha512-3KS2b+kL7fsuk/eJZ7EQdnEmQoaho/r6KUef7hxvltNA5DR8NAUM+8wJMbJyZ4G9/7i3v5zPBIMN5aybAh2/Jg==", + "license": "MIT", "dependencies": { "call-bind": "^1.0.7", "for-each": "^0.3.3", @@ -10850,19 +10112,11 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/typedarray-to-buffer": { - "version": "3.1.5", - "resolved": "https://registry.npmjs.org/typedarray-to-buffer/-/typedarray-to-buffer-3.1.5.tgz", - "integrity": "sha512-zdu8XMNEDepKKR+XYOXAVPtWui0ly0NtohUscw+UmaHiAWT8hrV1rr//H6V+0DvJ3OQ19S979M0laLfX8rm82Q==", - "dependencies": { - "is-typedarray": "^1.0.0" - } - }, "node_modules/typescript": { - "version": "5.8.3", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.8.3.tgz", - "integrity": "sha512-p1diW6TqL9L07nNxvRMM7hMMw4c5XOo/1ibL4aAIGmSAt9slTE1Xgw5KWuof2uTOvCg9BY7ZRi+GaF+7sfgPeQ==", + "version": "5.9.3", "dev": true, + "license": "Apache-2.0", + "peer": true, "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" @@ -10873,29 +10127,25 @@ }, "node_modules/typescript-compare": { "version": "0.0.2", - "resolved": "https://registry.npmjs.org/typescript-compare/-/typescript-compare-0.0.2.tgz", - "integrity": "sha512-8ja4j7pMHkfLJQO2/8tut7ub+J3Lw2S3061eJLFQcvs3tsmJKp8KG5NtpLn7KcY2w08edF74BSVN7qJS0U6oHA==", + "license": "MIT", "dependencies": { "typescript-logic": "^0.0.0" } }, "node_modules/typescript-logic": { "version": "0.0.0", - "resolved": "https://registry.npmjs.org/typescript-logic/-/typescript-logic-0.0.0.tgz", - "integrity": "sha512-zXFars5LUkI3zP492ls0VskH3TtdeHCqu0i7/duGt60i5IGPIpAHE/DWo5FqJ6EjQ15YKXrt+AETjv60Dat34Q==" + "license": "MIT" }, "node_modules/typescript-tuple": { "version": "2.2.1", - "resolved": "https://registry.npmjs.org/typescript-tuple/-/typescript-tuple-2.2.1.tgz", - "integrity": "sha512-Zcr0lbt8z5ZdEzERHAMAniTiIKerFCMgd7yjq1fPnDJ43et/k9twIFQMUYff9k5oXcsQ0WpvFcgzK2ZKASoW6Q==", + "license": "MIT", "dependencies": { "typescript-compare": "^0.0.2" } }, "node_modules/unbox-primitive": { "version": "1.1.0", - "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.1.0.tgz", - "integrity": "sha512-nWJ91DjeOkej/TA8pXQ3myruKpKEYgqvpw9lz4OPHj/NWFNluYrjbz9j01CJ8yKQd2g4jFoOkINCTW2I5LEEyw==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.3", "has-bigints": "^1.0.2", @@ -10910,23 +10160,20 @@ } }, "node_modules/undici-types": { - "version": "6.21.0", - "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.21.0.tgz", - "integrity": "sha512-iwDZqg0QAGrg9Rav5H4n0M64c3mkR59cJ6wQp+7C4nI0gsmExaedaYLNO44eT4AtBBwjbTiGPMlt2Md0T9H9JQ==", - "devOptional": true + "version": "7.16.0", + "devOptional": true, + "license": "MIT" }, "node_modules/unicode-canonical-property-names-ecmascript": { "version": "2.0.1", - "resolved": "https://registry.npmjs.org/unicode-canonical-property-names-ecmascript/-/unicode-canonical-property-names-ecmascript-2.0.1.tgz", - "integrity": "sha512-dA8WbNeb2a6oQzAQ55YlT5vQAWGV9WXOsi3SskE3bcCdM0P4SDd+24zS/OCacdRq5BkdsRj9q3Pg6YyQoxIGqg==", + "license": "MIT", "engines": { "node": ">=4" } }, "node_modules/unicode-match-property-ecmascript": { "version": "2.0.0", - "resolved": "https://registry.npmjs.org/unicode-match-property-ecmascript/-/unicode-match-property-ecmascript-2.0.0.tgz", - "integrity": "sha512-5kaZCrbp5mmbz5ulBkDkbY0SsPOjKqVS35VpL9ulMPfSl0J0Xsm+9Evphv9CoIZFwre7aJoa94AY6seMKGVN5Q==", + "license": "MIT", "dependencies": { "unicode-canonical-property-names-ecmascript": "^2.0.0", "unicode-property-aliases-ecmascript": "^2.0.0" @@ -10936,25 +10183,22 @@ } }, "node_modules/unicode-match-property-value-ecmascript": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/unicode-match-property-value-ecmascript/-/unicode-match-property-value-ecmascript-2.2.0.tgz", - "integrity": "sha512-4IehN3V/+kkr5YeSSDDQG8QLqO26XpL2XP3GQtqwlT/QYSECAwFztxVHjlbh0+gjJ3XmNLS0zDsbgs9jWKExLg==", + "version": "2.2.1", + "license": "MIT", "engines": { "node": ">=4" } }, "node_modules/unicode-property-aliases-ecmascript": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/unicode-property-aliases-ecmascript/-/unicode-property-aliases-ecmascript-2.1.0.tgz", - "integrity": "sha512-6t3foTQI9qne+OZoVQB/8x8rk2k1eVy1gRXhV3oFQ5T6R1dqQ1xtin3XqSlx3+ATBkliTaR/hHyJBm+LVPNM8w==", + "version": "2.2.0", + "license": "MIT", "engines": { "node": ">=4" } }, "node_modules/unique-string": { "version": "2.0.0", - "resolved": "https://registry.npmjs.org/unique-string/-/unique-string-2.0.0.tgz", - "integrity": "sha512-uNaeirEPvpZWSgzwsPGtU2zVSTrn/8L5q/IexZmH0eH6SA73CmAA5U4GwORTxQAZs95TAXLNqeLoPPNO5gZfWg==", + "license": "MIT", "dependencies": { "crypto-random-string": "^2.0.0" }, @@ -10964,25 +10208,21 @@ }, "node_modules/universalify": { "version": "2.0.1", - "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.1.tgz", - "integrity": "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==", + "license": "MIT", "engines": { "node": ">= 10.0.0" } }, "node_modules/upath": { "version": "1.2.0", - "resolved": "https://registry.npmjs.org/upath/-/upath-1.2.0.tgz", - "integrity": "sha512-aZwGpamFO61g3OlfT7OQCHqhGnW43ieH9WZeP7QxN/G/jS4jfqUkZxoryvJgVPEcrl5NL/ggHsSmLMHuH64Lhg==", + "license": "MIT", "engines": { "node": ">=4", "yarn": "*" } }, "node_modules/update-browserslist-db": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.1.3.tgz", - "integrity": "sha512-UxhIZQ+QInVdunkDAaiazvvT/+fXL5Osr0JZlJulepYu6Jd7qJtDZjlur0emRlT71EN3ScPoE7gvsuIKKNavKw==", + "version": "1.2.3", "funding": [ { "type": "opencollective", @@ -10997,6 +10237,7 @@ "url": "https://github.com/sponsors/ai" } ], + "license": "MIT", "dependencies": { "escalade": "^3.2.0", "picocolors": "^1.1.1" @@ -11009,84 +10250,62 @@ } }, "node_modules/update-notifier": { - "version": "4.1.3", - "resolved": "https://registry.npmjs.org/update-notifier/-/update-notifier-4.1.3.tgz", - "integrity": "sha512-Yld6Z0RyCYGB6ckIjffGOSOmHXj1gMeE7aROz4MG+XMkmixBX4jUngrGXNYz7wPKBmtoD4MnBa2Anu7RSKht/A==", + "version": "7.3.1", + "license": "BSD-2-Clause", "dependencies": { - "boxen": "^4.2.0", - "chalk": "^3.0.0", - "configstore": "^5.0.1", - "has-yarn": "^2.1.0", - "import-lazy": "^2.1.0", - "is-ci": "^2.0.0", - "is-installed-globally": "^0.3.1", - "is-npm": "^4.0.0", - "is-yarn-global": "^0.3.0", - "latest-version": "^5.0.0", - "pupa": "^2.0.1", - "semver-diff": "^3.1.1", - "xdg-basedir": "^4.0.0" + "boxen": "^8.0.1", + "chalk": "^5.3.0", + "configstore": "^7.0.0", + "is-in-ci": "^1.0.0", + "is-installed-globally": "^1.0.0", + "is-npm": "^6.0.0", + "latest-version": "^9.0.0", + "pupa": "^3.1.0", + "semver": "^7.6.3", + "xdg-basedir": "^5.1.0" }, "engines": { - "node": ">=8" + "node": ">=18" }, "funding": { "url": "https://github.com/yeoman/update-notifier?sponsor=1" } }, "node_modules/update-notifier/node_modules/chalk": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz", - "integrity": "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg==", - "dependencies": { - "ansi-styles": "^4.1.0", - "supports-color": "^7.1.0" - }, + "version": "5.6.2", + "license": "MIT", "engines": { - "node": ">=8" + "node": "^12.17.0 || ^14.13 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" } }, "node_modules/uri-js": { "version": "4.4.1", - "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", - "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", - "dev": true, + "license": "BSD-2-Clause", "dependencies": { "punycode": "^2.1.0" } }, - "node_modules/url-parse-lax": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/url-parse-lax/-/url-parse-lax-3.0.0.tgz", - "integrity": "sha512-NjFKA0DidqPa5ciFcSrXnAltTtzz84ogy+NebPvfEgAck0+TNg4UJ4IN+fB7zRZfbgUf0syOo9MDxFkDSMuFaQ==", - "dependencies": { - "prepend-http": "^2.0.0" - }, - "engines": { - "node": ">=4" - } - }, "node_modules/util-deprecate": { "version": "1.0.2", - "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", - "integrity": "sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==" + "license": "MIT" }, "node_modules/uuid": { - "version": "11.1.0", - "resolved": "https://registry.npmjs.org/uuid/-/uuid-11.1.0.tgz", - "integrity": "sha512-0/A9rDy9P7cJ+8w1c9WD9V//9Wj15Ce2MPz8Ri6032usz+NfePxx5AcN3bN+r6ZL6jEo066/yNYB3tn4pQEx+A==", + "version": "13.0.0", "funding": [ "https://github.com/sponsors/broofa", "https://github.com/sponsors/ctavan" ], + "license": "MIT", "bin": { - "uuid": "dist/esm/bin/uuid" + "uuid": "dist-node/bin/uuid" } }, "node_modules/validate-npm-package-license": { "version": "3.0.4", - "resolved": "https://registry.npmjs.org/validate-npm-package-license/-/validate-npm-package-license-3.0.4.tgz", - "integrity": "sha512-DpKm2Ui/xN7/HQKCtpZxoRWBhZ9Z0kqtygG8XCgNQ8ZlDnxuQmWhj566j8fN4Cu3/JmbhsDo7fcAJq4s9h27Ew==", + "license": "Apache-2.0", "dependencies": { "spdx-correct": "^3.0.0", "spdx-expression-parse": "^3.0.0" @@ -11094,27 +10313,26 @@ }, "node_modules/value-equal": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/value-equal/-/value-equal-1.0.1.tgz", - "integrity": "sha512-NOJ6JZCAWr0zlxZt+xqCHNTEKOsrks2HQd4MqhP1qy4z1SkbEP467eNx6TgDKXMvUOb+OENfJCZwM+16n7fRfw==" + "license": "MIT" }, "node_modules/vite": { - "version": "6.3.5", - "resolved": "https://registry.npmjs.org/vite/-/vite-6.3.5.tgz", - "integrity": "sha512-cZn6NDFE7wdTpINgs++ZJ4N49W2vRp8LCKrn3Ob1kYNtOo21vfDoaV5GzBfLU4MovSAB8uNRm4jgzVQZ+mBzPQ==", + "version": "7.3.1", "dev": true, + "license": "MIT", + "peer": true, "dependencies": { - "esbuild": "^0.25.0", - "fdir": "^6.4.4", - "picomatch": "^4.0.2", - "postcss": "^8.5.3", - "rollup": "^4.34.9", - "tinyglobby": "^0.2.13" + "esbuild": "^0.27.0", + "fdir": "^6.5.0", + "picomatch": "^4.0.3", + "postcss": "^8.5.6", + "rollup": "^4.43.0", + "tinyglobby": "^0.2.15" }, "bin": { "vite": "bin/vite.js" }, "engines": { - "node": "^18.0.0 || ^20.0.0 || >=22.0.0" + "node": "^20.19.0 || >=22.12.0" }, "funding": { "url": "https://github.com/vitejs/vite?sponsor=1" @@ -11123,14 +10341,14 @@ "fsevents": "~2.3.3" }, "peerDependencies": { - "@types/node": "^18.0.0 || ^20.0.0 || >=22.0.0", + "@types/node": "^20.19.0 || >=22.12.0", "jiti": ">=1.21.0", - "less": "*", + "less": "^4.0.0", "lightningcss": "^1.21.0", - "sass": "*", - "sass-embedded": "*", - "stylus": "*", - "sugarss": "*", + "sass": "^1.70.0", + "sass-embedded": "^1.70.0", + "stylus": ">=0.54.8", + "sugarss": "^5.0.0", "terser": "^5.16.0", "tsx": "^4.8.1", "yaml": "^2.4.2" @@ -11171,39 +10389,16 @@ } } }, - "node_modules/vite-node": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/vite-node/-/vite-node-3.1.4.tgz", - "integrity": "sha512-6enNwYnpyDo4hEgytbmc6mYWHXDHYEn0D1/rw4Q+tnHUGtKTJsn8T1YkX6Q18wI5LCrS8CTYlBaiCqxOy2kvUA==", - "dev": true, - "dependencies": { - "cac": "^6.7.14", - "debug": "^4.4.0", - "es-module-lexer": "^1.7.0", - "pathe": "^2.0.3", - "vite": "^5.0.0 || ^6.0.0" - }, - "bin": { - "vite-node": "vite-node.mjs" - }, - "engines": { - "node": "^18.0.0 || ^20.0.0 || >=22.0.0" - }, - "funding": { - "url": "https://opencollective.com/vitest" - } - }, "node_modules/vite-plugin-pwa": { - "version": "0.21.2", - "resolved": "https://registry.npmjs.org/vite-plugin-pwa/-/vite-plugin-pwa-0.21.2.tgz", - "integrity": "sha512-vFhH6Waw8itNu37hWUJxL50q+CBbNcMVzsKaYHQVrfxTt3ihk3PeLO22SbiP1UNWzcEPaTQv+YVxe4G0KOjAkg==", + "version": "1.2.0", "dev": true, + "license": "MIT", "dependencies": { "debug": "^4.3.6", "pretty-bytes": "^6.1.1", "tinyglobby": "^0.2.10", - "workbox-build": "^7.3.0", - "workbox-window": "^7.3.0" + "workbox-build": "^7.4.0", + "workbox-window": "^7.4.0" }, "engines": { "node": ">=16.0.0" @@ -11212,10 +10407,10 @@ "url": "https://github.com/sponsors/antfu" }, "peerDependencies": { - "@vite-pwa/assets-generator": "^0.2.6", - "vite": "^3.1.0 || ^4.0.0 || ^5.0.0 || ^6.0.0", - "workbox-build": "^7.3.0", - "workbox-window": "^7.3.0" + "@vite-pwa/assets-generator": "^1.0.0", + "vite": "^3.1.0 || ^4.0.0 || ^5.0.0 || ^6.0.0 || ^7.0.0", + "workbox-build": "^7.4.0", + "workbox-window": "^7.4.0" }, "peerDependenciesMeta": { "@vite-pwa/assets-generator": { @@ -11224,10 +10419,12 @@ } }, "node_modules/vite/node_modules/fdir": { - "version": "6.4.4", - "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.4.4.tgz", - "integrity": "sha512-1NZP+GK4GfuAv3PqKvxQRDMjdSRZjnkq7KfhlNrCNNlZ0ygQFpebfrnfnq/W7fpUnAv9aGWmY1zKx7FYL3gwhg==", + "version": "6.5.0", "dev": true, + "license": "MIT", + "engines": { + "node": ">=12.0.0" + }, "peerDependencies": { "picomatch": "^3 || ^4" }, @@ -11238,10 +10435,10 @@ } }, "node_modules/vite/node_modules/picomatch": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.2.tgz", - "integrity": "sha512-M7BAV6Rlcy5u+m6oPhAPFgJTzAioX/6B0DxyvDlo9l8+T3nLKbrczg2WLUyzd45L8RqfUMyGPzekbMvX2Ldkwg==", + "version": "4.0.3", "dev": true, + "license": "MIT", + "peer": true, "engines": { "node": ">=12" }, @@ -11250,48 +10447,49 @@ } }, "node_modules/vitest": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/vitest/-/vitest-3.1.4.tgz", - "integrity": "sha512-Ta56rT7uWxCSJXlBtKgIlApJnT6e6IGmTYxYcmxjJ4ujuZDI59GUQgVDObXXJujOmPDBYXHK1qmaGtneu6TNIQ==", + "version": "4.0.17", "dev": true, + "license": "MIT", + "peer": true, "dependencies": { - "@vitest/expect": "3.1.4", - "@vitest/mocker": "3.1.4", - "@vitest/pretty-format": "^3.1.4", - "@vitest/runner": "3.1.4", - "@vitest/snapshot": "3.1.4", - "@vitest/spy": "3.1.4", - "@vitest/utils": "3.1.4", - "chai": "^5.2.0", - "debug": "^4.4.0", - "expect-type": "^1.2.1", - "magic-string": "^0.30.17", + "@vitest/expect": "4.0.17", + "@vitest/mocker": "4.0.17", + "@vitest/pretty-format": "4.0.17", + "@vitest/runner": "4.0.17", + "@vitest/snapshot": "4.0.17", + "@vitest/spy": "4.0.17", + "@vitest/utils": "4.0.17", + "es-module-lexer": "^1.7.0", + "expect-type": "^1.2.2", + "magic-string": "^0.30.21", + "obug": "^2.1.1", "pathe": "^2.0.3", - "std-env": "^3.9.0", + "picomatch": "^4.0.3", + "std-env": "^3.10.0", "tinybench": "^2.9.0", - "tinyexec": "^0.3.2", - "tinyglobby": "^0.2.13", - "tinypool": "^1.0.2", - "tinyrainbow": "^2.0.0", - "vite": "^5.0.0 || ^6.0.0", - "vite-node": "3.1.4", + "tinyexec": "^1.0.2", + "tinyglobby": "^0.2.15", + "tinyrainbow": "^3.0.3", + "vite": "^6.0.0 || ^7.0.0", "why-is-node-running": "^2.3.0" }, "bin": { "vitest": "vitest.mjs" }, "engines": { - "node": "^18.0.0 || ^20.0.0 || >=22.0.0" + "node": "^20.0.0 || ^22.0.0 || >=24.0.0" }, "funding": { "url": "https://opencollective.com/vitest" }, "peerDependencies": { "@edge-runtime/vm": "*", - "@types/debug": "^4.1.12", - "@types/node": "^18.0.0 || ^20.0.0 || >=22.0.0", - "@vitest/browser": "3.1.4", - "@vitest/ui": "3.1.4", + "@opentelemetry/api": "^1.9.0", + "@types/node": "^20.0.0 || ^22.0.0 || >=24.0.0", + "@vitest/browser-playwright": "4.0.17", + "@vitest/browser-preview": "4.0.17", + "@vitest/browser-webdriverio": "4.0.17", + "@vitest/ui": "4.0.17", "happy-dom": "*", "jsdom": "*" }, @@ -11299,13 +10497,19 @@ "@edge-runtime/vm": { "optional": true }, - "@types/debug": { + "@opentelemetry/api": { "optional": true }, "@types/node": { "optional": true }, - "@vitest/browser": { + "@vitest/browser-playwright": { + "optional": true + }, + "@vitest/browser-preview": { + "optional": true + }, + "@vitest/browser-webdriverio": { "optional": true }, "@vitest/ui": { @@ -11319,11 +10523,21 @@ } } }, + "node_modules/vitest/node_modules/picomatch": { + "version": "4.0.3", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, "node_modules/w3c-xmlserializer": { "version": "5.0.0", - "resolved": "https://registry.npmjs.org/w3c-xmlserializer/-/w3c-xmlserializer-5.0.0.tgz", - "integrity": "sha512-o8qghlI8NZHU1lLPrpi2+Uq7abh4GGPpYANlalzWxyWteJOCsr/P+oPBA49TOLu5FTZO4d3F9MnWJfiMo4BkmA==", "dev": true, + "license": "MIT", "dependencies": { "xml-name-validator": "^5.0.0" }, @@ -11333,34 +10547,30 @@ }, "node_modules/warning": { "version": "4.0.3", - "resolved": "https://registry.npmjs.org/warning/-/warning-4.0.3.tgz", - "integrity": "sha512-rpJyN222KWIvHJ/F53XSZv0Zl/accqHR8et1kpaMTD/fLCRxtV8iX8czMzY7sVZupTI3zcUTg8eycS2kNF9l6w==", + "license": "MIT", "dependencies": { "loose-envify": "^1.0.0" } }, "node_modules/wcwidth": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/wcwidth/-/wcwidth-1.0.1.tgz", - "integrity": "sha512-XHPEwS0q6TaxcvG85+8EYkbiCux2XtWG2mkc47Ng2A77BQu9+DqIOJldST4HgPkuea7dvKSj5VgX3P1d4rW8Tg==", + "license": "MIT", "dependencies": { "defaults": "^1.0.3" } }, "node_modules/webidl-conversions": { "version": "7.0.0", - "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-7.0.0.tgz", - "integrity": "sha512-VwddBukDzu71offAQR975unBIGqfKZpM+8ZX6ySk8nYhVoo5CYaZyzt3YBvYtRtO+aoGlqxPg/B87NGVZ/fu6g==", "dev": true, + "license": "BSD-2-Clause", "engines": { "node": ">=12" } }, "node_modules/whatwg-encoding": { "version": "3.1.1", - "resolved": "https://registry.npmjs.org/whatwg-encoding/-/whatwg-encoding-3.1.1.tgz", - "integrity": "sha512-6qN4hJdMwfYBtE3YBTTHhoeuUrDBPZmbQaxWAqSALV/MeEnR5z1xd8UKud2RAkFoPkmB+hli1TZSnyi84xz1vQ==", "dev": true, + "license": "MIT", "dependencies": { "iconv-lite": "0.6.3" }, @@ -11370,18 +10580,16 @@ }, "node_modules/whatwg-mimetype": { "version": "3.0.0", - "resolved": "https://registry.npmjs.org/whatwg-mimetype/-/whatwg-mimetype-3.0.0.tgz", - "integrity": "sha512-nt+N2dzIutVRxARx1nghPKGv1xHikU7HKdfafKkLNLindmPU/ch3U31NOCGGA/dmPcmb1VlofO0vnKAcsm0o/Q==", "dev": true, + "license": "MIT", "engines": { "node": ">=12" } }, "node_modules/whatwg-url": { "version": "14.2.0", - "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-14.2.0.tgz", - "integrity": "sha512-De72GdQZzNTUBBChsXueQUnPKDkg/5A5zp7pFDuQAj5UFoENpiACU0wlCvzpAGnTkj++ihpKwKyYewn/XNUbKw==", "dev": true, + "license": "MIT", "dependencies": { "tr46": "^5.1.0", "webidl-conversions": "^7.0.0" @@ -11390,11 +10598,13 @@ "node": ">=18" } }, + "node_modules/when-exit": { + "version": "2.1.5", + "license": "MIT" + }, "node_modules/which": { "version": "2.0.2", - "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", - "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", - "dev": true, + "license": "ISC", "dependencies": { "isexe": "^2.0.0" }, @@ -11407,8 +10617,7 @@ }, "node_modules/which-boxed-primitive": { "version": "1.1.1", - "resolved": "https://registry.npmjs.org/which-boxed-primitive/-/which-boxed-primitive-1.1.1.tgz", - "integrity": "sha512-TbX3mj8n0odCBFVlY8AxkqcHASw3L60jIuF8jFP78az3C2YhmGvqbHBpAjTRH2/xqYunrJ9g1jSyjCjpoWzIAA==", + "license": "MIT", "dependencies": { "is-bigint": "^1.1.0", "is-boolean-object": "^1.2.1", @@ -11425,8 +10634,7 @@ }, "node_modules/which-builtin-type": { "version": "1.2.1", - "resolved": "https://registry.npmjs.org/which-builtin-type/-/which-builtin-type-1.2.1.tgz", - "integrity": "sha512-6iBczoX+kDQ7a3+YJBnh3T+KZRxM/iYNPXicqk66/Qfm1b93iu+yOImkg0zHbj5LNOcNv1TEADiZ0xa34B4q6Q==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.2", "function.prototype.name": "^1.1.6", @@ -11451,13 +10659,11 @@ }, "node_modules/which-builtin-type/node_modules/isarray": { "version": "2.0.5", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.5.tgz", - "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==" + "license": "MIT" }, "node_modules/which-collection": { "version": "1.0.2", - "resolved": "https://registry.npmjs.org/which-collection/-/which-collection-1.0.2.tgz", - "integrity": "sha512-K4jVyjnBdgvc86Y6BkaLZEN933SwYOuBFkdmBu9ZfkcAbdVbpITnDmjvZ/aQjRXQrv5EPkTnD1s39GiiqbngCw==", + "license": "MIT", "dependencies": { "is-map": "^2.0.3", "is-set": "^2.0.3", @@ -11472,9 +10678,8 @@ } }, "node_modules/which-typed-array": { - "version": "1.1.19", - "resolved": "https://registry.npmjs.org/which-typed-array/-/which-typed-array-1.1.19.tgz", - "integrity": "sha512-rEvr90Bck4WZt9HHFC4DJMsjvu7x+r6bImz0/BrbWb7A2djJ8hnZMrWnHo9F8ssv0OMErasDhftrfROTyqSDrw==", + "version": "1.1.20", + "license": "MIT", "dependencies": { "available-typed-arrays": "^1.0.7", "call-bind": "^1.0.8", @@ -11493,9 +10698,8 @@ }, "node_modules/why-is-node-running": { "version": "2.3.0", - "resolved": "https://registry.npmjs.org/why-is-node-running/-/why-is-node-running-2.3.0.tgz", - "integrity": "sha512-hUrmaWBdVDcxvYqnyh09zunKzROWjbZTiNy8dBEjkS7ehEDQibXJ7XvlmtbwuTclUiIyN+CyXQD4Vmko8fNm8w==", "dev": true, + "license": "MIT", "dependencies": { "siginfo": "^2.0.0", "stackback": "0.0.2" @@ -11508,46 +10712,86 @@ } }, "node_modules/widest-line": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/widest-line/-/widest-line-3.1.0.tgz", - "integrity": "sha512-NsmoXalsWVDMGupxZ5R08ka9flZjjiLvHVAWYOKtiKM8ujtZWr9cRffak+uSE48+Ob8ObalXpwyeUiyDD6QFgg==", + "version": "5.0.0", + "license": "MIT", "dependencies": { - "string-width": "^4.0.0" + "string-width": "^7.0.0" }, "engines": { - "node": ">=8" + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/widest-line/node_modules/ansi-regex": { + "version": "6.2.2", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-regex?sponsor=1" + } + }, + "node_modules/widest-line/node_modules/emoji-regex": { + "version": "10.6.0", + "license": "MIT" + }, + "node_modules/widest-line/node_modules/string-width": { + "version": "7.2.0", + "license": "MIT", + "dependencies": { + "emoji-regex": "^10.3.0", + "get-east-asian-width": "^1.0.0", + "strip-ansi": "^7.1.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/widest-line/node_modules/strip-ansi": { + "version": "7.1.2", + "license": "MIT", + "dependencies": { + "ansi-regex": "^6.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/strip-ansi?sponsor=1" } }, "node_modules/word-wrap": { "version": "1.2.5", - "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.5.tgz", - "integrity": "sha512-BN22B5eaMMI9UMtjrGd5g5eCYPpCPDUy0FJXbYsaT5zYxjFOckS53SQDE3pWkVoWpHXVb3BrYcEN4Twa55B5cA==", "dev": true, + "license": "MIT", "engines": { "node": ">=0.10.0" } }, "node_modules/workbox-background-sync": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-background-sync/-/workbox-background-sync-7.3.0.tgz", - "integrity": "sha512-PCSk3eK7Mxeuyatb22pcSx9dlgWNv3+M8PqPaYDokks8Y5/FX4soaOqj3yhAZr5k6Q5JWTOMYgaJBpbw11G9Eg==", + "version": "7.4.0", + "license": "MIT", "dependencies": { "idb": "^7.0.1", - "workbox-core": "7.3.0" + "workbox-core": "7.4.0" } }, "node_modules/workbox-broadcast-update": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-broadcast-update/-/workbox-broadcast-update-7.3.0.tgz", - "integrity": "sha512-T9/F5VEdJVhwmrIAE+E/kq5at2OY6+OXXgOWQevnubal6sO92Gjo24v6dCVwQiclAF5NS3hlmsifRrpQzZCdUA==", + "version": "7.4.0", + "license": "MIT", "dependencies": { - "workbox-core": "7.3.0" + "workbox-core": "7.4.0" } }, "node_modules/workbox-build": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-build/-/workbox-build-7.3.0.tgz", - "integrity": "sha512-JGL6vZTPlxnlqZRhR/K/msqg3wKP+m0wfEUVosK7gsYzSgeIxvZLi1ViJJzVL7CEeI8r7rGFV973RiEqkP3lWQ==", + "version": "7.4.0", + "license": "MIT", "dependencies": { "@apideck/better-ajv-errors": "^0.3.1", "@babel/core": "^7.24.4", @@ -11562,39 +10806,38 @@ "common-tags": "^1.8.0", "fast-json-stable-stringify": "^2.1.0", "fs-extra": "^9.0.1", - "glob": "^7.1.6", + "glob": "^11.0.1", "lodash": "^4.17.20", "pretty-bytes": "^5.3.0", - "rollup": "^2.43.1", + "rollup": "^2.79.2", "source-map": "^0.8.0-beta.0", "stringify-object": "^3.3.0", "strip-comments": "^2.0.1", "tempy": "^0.6.0", "upath": "^1.2.0", - "workbox-background-sync": "7.3.0", - "workbox-broadcast-update": "7.3.0", - "workbox-cacheable-response": "7.3.0", - "workbox-core": "7.3.0", - "workbox-expiration": "7.3.0", - "workbox-google-analytics": "7.3.0", - "workbox-navigation-preload": "7.3.0", - "workbox-precaching": "7.3.0", - "workbox-range-requests": "7.3.0", - "workbox-recipes": "7.3.0", - "workbox-routing": "7.3.0", - "workbox-strategies": "7.3.0", - "workbox-streams": "7.3.0", - "workbox-sw": "7.3.0", - "workbox-window": "7.3.0" + "workbox-background-sync": "7.4.0", + "workbox-broadcast-update": "7.4.0", + "workbox-cacheable-response": "7.4.0", + "workbox-core": "7.4.0", + "workbox-expiration": "7.4.0", + "workbox-google-analytics": "7.4.0", + "workbox-navigation-preload": "7.4.0", + "workbox-precaching": "7.4.0", + "workbox-range-requests": "7.4.0", + "workbox-recipes": "7.4.0", + "workbox-routing": "7.4.0", + "workbox-strategies": "7.4.0", + "workbox-streams": "7.4.0", + "workbox-sw": "7.4.0", + "workbox-window": "7.4.0" }, "engines": { - "node": ">=16.0.0" + "node": ">=20.0.0" } }, "node_modules/workbox-build/node_modules/@apideck/better-ajv-errors": { "version": "0.3.6", - "resolved": "https://registry.npmjs.org/@apideck/better-ajv-errors/-/better-ajv-errors-0.3.6.tgz", - "integrity": "sha512-P+ZygBLZtkp0qqOAJJVX4oX/sFo5JR3eBWwwuqHHhK0GIgQOKWrAfiAaWX0aArHkRWHMuggFEgAZNxVPwPZYaA==", + "license": "MIT", "dependencies": { "json-schema": "^0.4.0", "jsonpointer": "^5.0.0", @@ -11609,8 +10852,7 @@ }, "node_modules/workbox-build/node_modules/@rollup/plugin-babel": { "version": "5.3.1", - "resolved": "https://registry.npmjs.org/@rollup/plugin-babel/-/plugin-babel-5.3.1.tgz", - "integrity": "sha512-WFfdLWU/xVWKeRQnKmIAQULUI7Il0gZnBIH/ZFO069wYIfPu+8zrfp/KMW0atmELoRDq8FbiP3VCss9MhCut7Q==", + "license": "MIT", "dependencies": { "@babel/helper-module-imports": "^7.10.4", "@rollup/pluginutils": "^3.1.0" @@ -11631,8 +10873,7 @@ }, "node_modules/workbox-build/node_modules/@rollup/plugin-replace": { "version": "2.4.2", - "resolved": "https://registry.npmjs.org/@rollup/plugin-replace/-/plugin-replace-2.4.2.tgz", - "integrity": "sha512-IGcu+cydlUMZ5En85jxHH4qj2hta/11BHq95iHEyb2sbgiN0eCdzvUcHw5gt9pBL5lTi4JDYJ1acCoMGpTvEZg==", + "license": "MIT", "dependencies": { "@rollup/pluginutils": "^3.1.0", "magic-string": "^0.25.7" @@ -11643,8 +10884,7 @@ }, "node_modules/workbox-build/node_modules/@rollup/pluginutils": { "version": "3.1.0", - "resolved": "https://registry.npmjs.org/@rollup/pluginutils/-/pluginutils-3.1.0.tgz", - "integrity": "sha512-GksZ6pr6TpIjHm8h9lSQ8pi8BE9VeubNT0OMJ3B5uZJ8pz73NPiqOtCog/x2/QzM1ENChPKxMDhiQuRHsqc+lg==", + "license": "MIT", "dependencies": { "@types/estree": "0.0.39", "estree-walker": "^1.0.1", @@ -11659,13 +10899,12 @@ }, "node_modules/workbox-build/node_modules/@types/estree": { "version": "0.0.39", - "resolved": "https://registry.npmjs.org/@types/estree/-/estree-0.0.39.tgz", - "integrity": "sha512-EYNwp3bU+98cpU4lAWYYL7Zz+2gryWH1qbdDTidVd6hkiR6weksdbMadyXKXNPEkQFhXM+hVO9ZygomHXp+AIw==" + "license": "MIT" }, "node_modules/workbox-build/node_modules/ajv": { - "version": "8.17.1", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.17.1.tgz", - "integrity": "sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g==", + "version": "8.18.0", + "license": "MIT", + "peer": true, "dependencies": { "fast-deep-equal": "^3.1.3", "fast-uri": "^3.0.1", @@ -11679,26 +10918,56 @@ }, "node_modules/workbox-build/node_modules/estree-walker": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-1.0.1.tgz", - "integrity": "sha512-1fMXF3YP4pZZVozF8j/ZLfvnR8NSIljt56UhbZ5PeeDmmGHpgpdwQt7ITlGvYaQukCvuBRMLEiKiYC+oeIg4cg==" + "license": "MIT" + }, + "node_modules/workbox-build/node_modules/glob": { + "version": "11.1.0", + "license": "BlueOak-1.0.0", + "dependencies": { + "foreground-child": "^3.3.1", + "jackspeak": "^4.1.1", + "minimatch": "^10.1.1", + "minipass": "^7.1.2", + "package-json-from-dist": "^1.0.0", + "path-scurry": "^2.0.0" + }, + "bin": { + "glob": "dist/esm/bin.mjs" + }, + "engines": { + "node": "20 || >=22" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } }, "node_modules/workbox-build/node_modules/json-schema-traverse": { "version": "1.0.0", - "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", - "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==" + "license": "MIT" }, "node_modules/workbox-build/node_modules/magic-string": { "version": "0.25.9", - "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.25.9.tgz", - "integrity": "sha512-RmF0AsMzgt25qzqqLc1+MbHmhdx0ojF2Fvs4XnOqz2ZOBXzzkEwc/dJQZCYHAn7v1jbVOjAZfK8msRn4BxO4VQ==", + "license": "MIT", "dependencies": { "sourcemap-codec": "^1.4.8" } }, + "node_modules/workbox-build/node_modules/minimatch": { + "version": "10.1.1", + "license": "BlueOak-1.0.0", + "dependencies": { + "@isaacs/brace-expansion": "^5.0.0" + }, + "engines": { + "node": "20 || >=22" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, "node_modules/workbox-build/node_modules/pretty-bytes": { "version": "5.6.0", - "resolved": "https://registry.npmjs.org/pretty-bytes/-/pretty-bytes-5.6.0.tgz", - "integrity": "sha512-FFw039TmrBqFK8ma/7OL3sDz/VytdtJr044/QUJtH0wK9lb9jLq9tJyIxUwtQJHwar2BqtiA4iCWSwo9JLkzFg==", + "license": "MIT", "engines": { "node": ">=6" }, @@ -11708,8 +10977,8 @@ }, "node_modules/workbox-build/node_modules/rollup": { "version": "2.79.2", - "resolved": "https://registry.npmjs.org/rollup/-/rollup-2.79.2.tgz", - "integrity": "sha512-fS6iqSPZDs3dr/y7Od6y5nha8dW1YnbgtsyotCVvoFGKbERG++CVRFv1meyGDE1SNItQA8BrnCw7ScdAhRJ3XQ==", + "license": "MIT", + "peer": true, "bin": { "rollup": "dist/bin/rollup" }, @@ -11721,43 +10990,74 @@ } }, "node_modules/workbox-cacheable-response": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-cacheable-response/-/workbox-cacheable-response-7.3.0.tgz", - "integrity": "sha512-eAFERIg6J2LuyELhLlmeRcJFa5e16Mj8kL2yCDbhWE+HUun9skRQrGIFVUagqWj4DMaaPSMWfAolM7XZZxNmxA==", + "version": "7.4.0", + "license": "MIT", "dependencies": { - "workbox-core": "7.3.0" + "workbox-core": "7.4.0" } }, "node_modules/workbox-cli": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-cli/-/workbox-cli-7.3.0.tgz", - "integrity": "sha512-dB2Yz4s3PWcb2daHLUQC3Q0P+WGeoOKR6+LQqZ7ciWOHMhaWj7sWmomELa4IMVlNat53EF8MXOpXx2Ggd1o7+w==", + "version": "7.4.0", + "license": "MIT", "dependencies": { "chalk": "^4.1.0", - "chokidar": "^3.5.2", + "chokidar": "^3.6.0", "common-tags": "^1.8.0", "fs-extra": "^9.0.1", - "glob": "^7.1.6", + "glob": "^11.0.1", "inquirer": "^7.3.3", "meow": "^7.1.0", "ora": "^5.0.0", "pretty-bytes": "^5.3.0", "stringify-object": "^3.3.0", "upath": "^1.2.0", - "update-notifier": "^4.1.0", - "workbox-build": "7.3.0" + "update-notifier": "^7.3.1", + "workbox-build": "7.4.0" }, "bin": { "workbox": "build/bin.js" }, "engines": { - "node": ">=16.0.0" + "node": ">=20.0.0" + } + }, + "node_modules/workbox-cli/node_modules/glob": { + "version": "11.1.0", + "license": "BlueOak-1.0.0", + "dependencies": { + "foreground-child": "^3.3.1", + "jackspeak": "^4.1.1", + "minimatch": "^10.1.1", + "minipass": "^7.1.2", + "package-json-from-dist": "^1.0.0", + "path-scurry": "^2.0.0" + }, + "bin": { + "glob": "dist/esm/bin.mjs" + }, + "engines": { + "node": "20 || >=22" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/workbox-cli/node_modules/minimatch": { + "version": "10.1.1", + "license": "BlueOak-1.0.0", + "dependencies": { + "@isaacs/brace-expansion": "^5.0.0" + }, + "engines": { + "node": "20 || >=22" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" } }, "node_modules/workbox-cli/node_modules/pretty-bytes": { "version": "5.6.0", - "resolved": "https://registry.npmjs.org/pretty-bytes/-/pretty-bytes-5.6.0.tgz", - "integrity": "sha512-FFw039TmrBqFK8ma/7OL3sDz/VytdtJr044/QUJtH0wK9lb9jLq9tJyIxUwtQJHwar2BqtiA4iCWSwo9JLkzFg==", + "license": "MIT", "engines": { "node": ">=6" }, @@ -11766,120 +11066,106 @@ } }, "node_modules/workbox-core": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-core/-/workbox-core-7.3.0.tgz", - "integrity": "sha512-Z+mYrErfh4t3zi7NVTvOuACB0A/jA3bgxUN3PwtAVHvfEsZxV9Iju580VEETug3zYJRc0Dmii/aixI/Uxj8fmw==" + "version": "7.4.0", + "license": "MIT" }, "node_modules/workbox-expiration": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-expiration/-/workbox-expiration-7.3.0.tgz", - "integrity": "sha512-lpnSSLp2BM+K6bgFCWc5bS1LR5pAwDWbcKt1iL87/eTSJRdLdAwGQznZE+1czLgn/X05YChsrEegTNxjM067vQ==", + "version": "7.4.0", + "license": "MIT", "dependencies": { "idb": "^7.0.1", - "workbox-core": "7.3.0" + "workbox-core": "7.4.0" } }, "node_modules/workbox-google-analytics": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-google-analytics/-/workbox-google-analytics-7.3.0.tgz", - "integrity": "sha512-ii/tSfFdhjLHZ2BrYgFNTrb/yk04pw2hasgbM70jpZfLk0vdJAXgaiMAWsoE+wfJDNWoZmBYY0hMVI0v5wWDbg==", + "version": "7.4.0", + "license": "MIT", "dependencies": { - "workbox-background-sync": "7.3.0", - "workbox-core": "7.3.0", - "workbox-routing": "7.3.0", - "workbox-strategies": "7.3.0" + "workbox-background-sync": "7.4.0", + "workbox-core": "7.4.0", + "workbox-routing": "7.4.0", + "workbox-strategies": "7.4.0" } }, "node_modules/workbox-navigation-preload": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-navigation-preload/-/workbox-navigation-preload-7.3.0.tgz", - "integrity": "sha512-fTJzogmFaTv4bShZ6aA7Bfj4Cewaq5rp30qcxl2iYM45YD79rKIhvzNHiFj1P+u5ZZldroqhASXwwoyusnr2cg==", + "version": "7.4.0", + "license": "MIT", "dependencies": { - "workbox-core": "7.3.0" + "workbox-core": "7.4.0" } }, "node_modules/workbox-precaching": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-precaching/-/workbox-precaching-7.3.0.tgz", - "integrity": "sha512-ckp/3t0msgXclVAYaNndAGeAoWQUv7Rwc4fdhWL69CCAb2UHo3Cef0KIUctqfQj1p8h6aGyz3w8Cy3Ihq9OmIw==", + "version": "7.4.0", + "license": "MIT", "dependencies": { - "workbox-core": "7.3.0", - "workbox-routing": "7.3.0", - "workbox-strategies": "7.3.0" + "workbox-core": "7.4.0", + "workbox-routing": "7.4.0", + "workbox-strategies": "7.4.0" } }, "node_modules/workbox-range-requests": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-range-requests/-/workbox-range-requests-7.3.0.tgz", - "integrity": "sha512-EyFmM1KpDzzAouNF3+EWa15yDEenwxoeXu9bgxOEYnFfCxns7eAxA9WSSaVd8kujFFt3eIbShNqa4hLQNFvmVQ==", + "version": "7.4.0", + "license": "MIT", "dependencies": { - "workbox-core": "7.3.0" + "workbox-core": "7.4.0" } }, "node_modules/workbox-recipes": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-recipes/-/workbox-recipes-7.3.0.tgz", - "integrity": "sha512-BJro/MpuW35I/zjZQBcoxsctgeB+kyb2JAP5EB3EYzePg8wDGoQuUdyYQS+CheTb+GhqJeWmVs3QxLI8EBP1sg==", + "version": "7.4.0", + "license": "MIT", "dependencies": { - "workbox-cacheable-response": "7.3.0", - "workbox-core": "7.3.0", - "workbox-expiration": "7.3.0", - "workbox-precaching": "7.3.0", - "workbox-routing": "7.3.0", - "workbox-strategies": "7.3.0" + "workbox-cacheable-response": "7.4.0", + "workbox-core": "7.4.0", + "workbox-expiration": "7.4.0", + "workbox-precaching": "7.4.0", + "workbox-routing": "7.4.0", + "workbox-strategies": "7.4.0" } }, "node_modules/workbox-routing": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-routing/-/workbox-routing-7.3.0.tgz", - "integrity": "sha512-ZUlysUVn5ZUzMOmQN3bqu+gK98vNfgX/gSTZ127izJg/pMMy4LryAthnYtjuqcjkN4HEAx1mdgxNiKJMZQM76A==", + "version": "7.4.0", + "license": "MIT", "dependencies": { - "workbox-core": "7.3.0" + "workbox-core": "7.4.0" } }, "node_modules/workbox-strategies": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-strategies/-/workbox-strategies-7.3.0.tgz", - "integrity": "sha512-tmZydug+qzDFATwX7QiEL5Hdf7FrkhjaF9db1CbB39sDmEZJg3l9ayDvPxy8Y18C3Y66Nrr9kkN1f/RlkDgllg==", + "version": "7.4.0", + "license": "MIT", "dependencies": { - "workbox-core": "7.3.0" + "workbox-core": "7.4.0" } }, "node_modules/workbox-streams": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-streams/-/workbox-streams-7.3.0.tgz", - "integrity": "sha512-SZnXucyg8x2Y61VGtDjKPO5EgPUG5NDn/v86WYHX+9ZqvAsGOytP0Jxp1bl663YUuMoXSAtsGLL+byHzEuMRpw==", + "version": "7.4.0", + "license": "MIT", "dependencies": { - "workbox-core": "7.3.0", - "workbox-routing": "7.3.0" + "workbox-core": "7.4.0", + "workbox-routing": "7.4.0" } }, "node_modules/workbox-sw": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-sw/-/workbox-sw-7.3.0.tgz", - "integrity": "sha512-aCUyoAZU9IZtH05mn0ACUpyHzPs0lMeJimAYkQkBsOWiqaJLgusfDCR+yllkPkFRxWpZKF8vSvgHYeG7LwhlmA==" + "version": "7.4.0", + "license": "MIT" }, "node_modules/workbox-window": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-window/-/workbox-window-7.3.0.tgz", - "integrity": "sha512-qW8PDy16OV1UBaUNGlTVcepzrlzyzNW/ZJvFQQs2j2TzGsg6IKjcpZC1RSquqQnTOafl5pCj5bGfAHlCjOOjdA==", + "version": "7.4.0", + "license": "MIT", "dependencies": { "@types/trusted-types": "^2.0.2", - "workbox-core": "7.3.0" + "workbox-core": "7.4.0" } }, "node_modules/wrap-ansi": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-8.1.0.tgz", - "integrity": "sha512-si7QWI6zUMq56bESFvagtmzMdGOtoxfR+Sez11Mobfc7tm+VkUckk9bW2UeffTGVUbOksxmSw0AA2gs8g71NCQ==", - "dev": true, + "version": "9.0.2", + "license": "MIT", "dependencies": { - "ansi-styles": "^6.1.0", - "string-width": "^5.0.1", - "strip-ansi": "^7.0.1" + "ansi-styles": "^6.2.1", + "string-width": "^7.0.0", + "strip-ansi": "^7.1.0" }, "engines": { - "node": ">=12" + "node": ">=18" }, "funding": { "url": "https://github.com/chalk/wrap-ansi?sponsor=1" @@ -11888,9 +11174,7 @@ "node_modules/wrap-ansi-cjs": { "name": "wrap-ansi", "version": "7.0.0", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", - "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==", - "dev": true, + "license": "MIT", "dependencies": { "ansi-styles": "^4.0.0", "string-width": "^4.1.0", @@ -11904,10 +11188,8 @@ } }, "node_modules/wrap-ansi/node_modules/ansi-regex": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.1.0.tgz", - "integrity": "sha512-7HSX4QQb4CspciLpVFwyRe79O3xsIZDDLER21kERQ71oaPodF8jL725AgJMFAYbooIqolJoRLuM81SpeUkpkvA==", - "dev": true, + "version": "6.2.2", + "license": "MIT", "engines": { "node": ">=12" }, @@ -11916,10 +11198,8 @@ } }, "node_modules/wrap-ansi/node_modules/ansi-styles": { - "version": "6.2.1", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.1.tgz", - "integrity": "sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug==", - "dev": true, + "version": "6.2.3", + "license": "MIT", "engines": { "node": ">=12" }, @@ -11927,28 +11207,28 @@ "url": "https://github.com/chalk/ansi-styles?sponsor=1" } }, + "node_modules/wrap-ansi/node_modules/emoji-regex": { + "version": "10.6.0", + "license": "MIT" + }, "node_modules/wrap-ansi/node_modules/string-width": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz", - "integrity": "sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==", - "dev": true, + "version": "7.2.0", + "license": "MIT", "dependencies": { - "eastasianwidth": "^0.2.0", - "emoji-regex": "^9.2.2", - "strip-ansi": "^7.0.1" + "emoji-regex": "^10.3.0", + "get-east-asian-width": "^1.0.0", + "strip-ansi": "^7.1.0" }, "engines": { - "node": ">=12" + "node": ">=18" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/wrap-ansi/node_modules/strip-ansi": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz", - "integrity": "sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==", - "dev": true, + "version": "7.1.2", + "license": "MIT", "dependencies": { "ansi-regex": "^6.0.1" }, @@ -11961,25 +11241,13 @@ }, "node_modules/wrappy": { "version": "1.0.2", - "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", - "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==" - }, - "node_modules/write-file-atomic": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/write-file-atomic/-/write-file-atomic-3.0.3.tgz", - "integrity": "sha512-AvHcyZ5JnSfq3ioSyjrBkH9yW4m7Ayk8/9My/DD9onKeu/94fwrMocemO2QAJFAlnnDN+ZDS+ZjAR5ua1/PV/Q==", - "dependencies": { - "imurmurhash": "^0.1.4", - "is-typedarray": "^1.0.0", - "signal-exit": "^3.0.2", - "typedarray-to-buffer": "^3.1.5" - } + "dev": true, + "license": "ISC" }, "node_modules/ws": { - "version": "8.18.2", - "resolved": "https://registry.npmjs.org/ws/-/ws-8.18.2.tgz", - "integrity": "sha512-DMricUmwGZUVr++AEAe2uiVM7UoO9MAVZMDu05UQOaUII0lp+zOzLLU4Xqh/JvTqklB1T4uELaaPBKyjE1r4fQ==", + "version": "8.19.0", "dev": true, + "license": "MIT", "engines": { "node": ">=10.0.0" }, @@ -11997,37 +11265,35 @@ } }, "node_modules/xdg-basedir": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/xdg-basedir/-/xdg-basedir-4.0.0.tgz", - "integrity": "sha512-PSNhEJDejZYV7h50BohL09Er9VaIefr2LMAf3OEmpCkjOi34eYyQYAXUTjEQtZJTKcF0E2UKTh+osDLsgNim9Q==", + "version": "5.1.0", + "license": "MIT", "engines": { - "node": ">=8" + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/xml-name-validator": { "version": "5.0.0", - "resolved": "https://registry.npmjs.org/xml-name-validator/-/xml-name-validator-5.0.0.tgz", - "integrity": "sha512-EvGK8EJ3DhaHfbRlETOWAS5pO9MZITeauHKJyb8wyajUfQUenkIg2MvLDTZ4T/TgIcm3HU0TFBgWWboAZ30UHg==", "dev": true, + "license": "Apache-2.0", "engines": { "node": ">=18" } }, "node_modules/xmlchars": { "version": "2.2.0", - "resolved": "https://registry.npmjs.org/xmlchars/-/xmlchars-2.2.0.tgz", - "integrity": "sha512-JZnDKK8B0RCDw84FNdDAIpZK+JuJw+s7Lz8nksI7SIuU3UXJJslUthsi+uWBUYOwPFwW7W7PRLRfUKpxjtjFCw==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/yallist": { "version": "3.1.1", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz", - "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==" + "license": "ISC" }, "node_modules/yargs-parser": { "version": "18.1.3", - "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-18.1.3.tgz", - "integrity": "sha512-o50j0JeToy/4K6OZcaQmW6lyXXKhq7csREXcDwk2omFPJEwUNOVtJKvmDr9EI1fAJZUyZcRF7kxGBWmRXudrCQ==", + "license": "ISC", "dependencies": { "camelcase": "^5.0.0", "decamelize": "^1.2.0" @@ -12038,9 +11304,8 @@ }, "node_modules/yocto-queue": { "version": "0.1.0", - "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz", - "integrity": "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==", "dev": true, + "license": "MIT", "engines": { "node": ">=10" }, diff --git a/ui/package.json b/ui/package.json index b9c93316b..d4c149b23 100644 --- a/ui/package.json +++ b/ui/package.json @@ -16,19 +16,23 @@ "postinstall": "bin/update-workbox.sh" }, "dependencies": { + "@jsonforms/core": "^2.5.2", + "@jsonforms/material-renderers": "^2.5.2", + "@jsonforms/react": "^2.5.2", "@material-ui/core": "^4.12.4", "@material-ui/icons": "^4.11.3", - "@material-ui/lab": "^4.0.0-alpha.58", + "@material-ui/lab": "^4.0.0-alpha.61", "@material-ui/styles": "^4.11.5", "blueimp-md5": "^2.19.0", "clsx": "^2.1.1", "connected-react-router": "^6.9.3", "deepmerge": "^4.3.1", + "dompurify": "^3.3.2", "history": "^4.10.1", "inflection": "^3.0.2", "jwt-decode": "^4.0.0", "lodash.throttle": "^4.1.1", - "navidrome-music-player": "4.25.1", + "navidrome-music-player": "4.25.2", "prop-types": "^15.8.1", "ra-data-json-server": "^3.19.12", "ra-i18n-polyglot": "^3.19.12", @@ -46,8 +50,8 @@ "react-redux": "^7.2.9", "react-router-dom": "^5.3.4", "redux": "^4.2.1", - "redux-saga": "^1.3.0", - "uuid": "^11.1.0", + "redux-saga": "^1.4.2", + "uuid": "^13.0.0", "workbox-cli": "^7.3.0" }, "devDependencies": { @@ -55,27 +59,27 @@ "@testing-library/react": "^12.1.5", "@testing-library/react-hooks": "^7.0.2", "@testing-library/user-event": "^14.6.1", - "@types/node": "^22.15.21", - "@types/react": "^17.0.86", + "@types/node": "^24.9.1", + "@types/react": "^17.0.89", "@types/react-dom": "^17.0.26", "@typescript-eslint/eslint-plugin": "^6.21.0", "@typescript-eslint/parser": "^6.21.0", - "@vitejs/plugin-react": "^4.5.0", - "@vitest/coverage-v8": "^3.1.4", + "@vitejs/plugin-react": "^5.1.0", + "@vitest/coverage-v8": "^4.0.3", "eslint": "^8.57.1", - "eslint-config-prettier": "^10.1.5", + "eslint-config-prettier": "^10.1.8", "eslint-plugin-jsx-a11y": "^6.10.2", "eslint-plugin-react": "^7.37.5", "eslint-plugin-react-hooks": "^5.2.0", - "eslint-plugin-react-refresh": "^0.4.20", - "happy-dom": "^17.4.7", + "eslint-plugin-react-refresh": "^0.4.24", + "happy-dom": "^20.0.8", "jsdom": "^26.1.0", - "prettier": "^3.5.3", + "prettier": "^3.6.2", "ra-test": "^3.19.12", "typescript": "^5.8.3", - "vite": "^6.3.5", - "vite-plugin-pwa": "^0.21.2", - "vitest": "^3.1.4" + "vite": "^7.1.12", + "vite-plugin-pwa": "^1.1.0", + "vitest": "^4.0.3" }, "overrides": { "vite": { diff --git a/ui/public/fonts/Unbounded-Variable.woff2 b/ui/public/fonts/Unbounded-Variable.woff2 new file mode 100644 index 000000000..96d8ff5fa Binary files /dev/null and b/ui/public/fonts/Unbounded-Variable.woff2 differ diff --git a/ui/src/App.jsx b/ui/src/App.jsx index dc4fe9b53..35eaee3eb 100644 --- a/ui/src/App.jsx +++ b/ui/src/App.jsx @@ -16,6 +16,7 @@ import playlist from './playlist' import radio from './radio' import share from './share' import library from './library' +import plugin from './plugin' import { Player } from './audioplayer' import customRoutes from './routes' import { @@ -32,6 +33,7 @@ import { replayGainReducer, downloadMenuDialogReducer, shareDialogReducer, + transcodingReducer, } from './reducers' import createAdminStore from './store/createAdminStore' import { i18nProvider } from './i18n' @@ -71,6 +73,7 @@ const adminStore = createAdminStore({ activity: activityReducer, settings: settingsReducer, replayGain: replayGainReducer, + transcoding: transcodingReducer, }, }) @@ -139,6 +142,13 @@ const Admin = (props) => { options={{ subMenu: 'settings' }} /> ) : null, + permissions === 'admin' && config.pluginsEnabled ? ( + + ) : null, , , diff --git a/ui/src/actions/player.js b/ui/src/actions/player.js index acef2e9b2..9056abeb6 100644 --- a/ui/src/actions/player.js +++ b/ui/src/actions/player.js @@ -7,6 +7,8 @@ export const PLAYER_PLAY_TRACKS = 'PLAYER_PLAY_TRACKS' export const PLAYER_CURRENT = 'PLAYER_CURRENT' export const PLAYER_SET_VOLUME = 'PLAYER_SET_VOLUME' export const PLAYER_SET_MODE = 'PLAYER_SET_MODE' +export const TRANSCODING_SET_PROFILE = 'TRANSCODING_SET_PROFILE' +export const PLAYER_REFRESH_QUEUE = 'PLAYER_REFRESH_QUEUE' export const setTrack = (data) => ({ type: PLAYER_SET_TRACK, @@ -102,3 +104,13 @@ export const setPlayMode = (mode) => ({ type: PLAYER_SET_MODE, data: { mode }, }) + +export const setTranscodingProfile = (profile) => ({ + type: TRANSCODING_SET_PROFILE, + data: profile, +}) + +export const refreshQueue = (resolvedUrls) => ({ + type: PLAYER_REFRESH_QUEUE, + data: resolvedUrls, +}) diff --git a/ui/src/album/AlbumDetails.jsx b/ui/src/album/AlbumDetails.jsx index 8213eb9d4..2411b8611 100644 --- a/ui/src/album/AlbumDetails.jsx +++ b/ui/src/album/AlbumDetails.jsx @@ -1,4 +1,4 @@ -import { useCallback, useEffect, useState } from 'react' +import { useEffect, useState } from 'react' import { Card, CardContent, @@ -18,6 +18,7 @@ import { useTranslate, } from 'react-admin' import Lightbox from 'react-image-lightbox' +import { COVER_ART_SIZE } from '../consts' import 'react-image-lightbox/style.css' import subsonic from '../subsonic' import { @@ -29,10 +30,12 @@ import { RatingField, SizeField, useAlbumsPerPage, + useImageLoadingState, } from '../common' import config from '../config' import { formatFullDate, intersperse } from '../utils' import AlbumExternalLinks from './AlbumExternalLinks' +import { SafeHTML } from '../common/SafeHTML' const useStyles = makeStyles( (theme) => ({ @@ -219,16 +222,21 @@ const AlbumDetails = (props) => { const isXsmall = useMediaQuery((theme) => theme.breakpoints.down('xs')) const isDesktop = useMediaQuery((theme) => theme.breakpoints.up('lg')) const classes = useStyles() - const [isLightboxOpen, setLightboxOpen] = useState(false) const [expanded, setExpanded] = useState(false) const [albumInfo, setAlbumInfo] = useState() - const [imageLoading, setImageLoading] = useState(false) - const [imageError, setImageError] = useState(false) + const { + imageLoading, + imageError, + isLightboxOpen, + handleImageLoad, + handleImageError, + handleOpenLightbox, + handleCloseLightbox, + } = useImageLoadingState(record.id) - let notes = - albumInfo?.notes?.replace(new RegExp('<.*>', 'g'), '') || record.notes + let notes = albumInfo?.notes || record.notes - if (notes !== undefined) { + if (notes) { notes += '..' } @@ -247,33 +255,9 @@ const AlbumDetails = (props) => { }) }, [record]) - // Reset image state when album changes - useEffect(() => { - setImageLoading(true) - setImageError(false) - }, [record.id]) - - const imageUrl = subsonic.getCoverArtUrl(record, 300) + const imageUrl = subsonic.getCoverArtUrl(record, COVER_ART_SIZE) const fullImageUrl = subsonic.getCoverArtUrl(record) - const handleImageLoad = useCallback(() => { - setImageLoading(false) - setImageError(false) - }, []) - - const handleImageError = useCallback(() => { - setImageLoading(false) - setImageError(true) - }, []) - - const handleOpenLightbox = useCallback(() => { - if (!imageError) { - setLightboxOpen(true) - } - }, [imageError]) - - const handleCloseLightbox = useCallback(() => setLightboxOpen(false), []) - return (
@@ -340,7 +324,7 @@ const AlbumDetails = (props) => { )} )} - {isDesktop && ( + {isDesktop && notes && ( { variant={'body1'} onClick={() => setExpanded(!expanded)} > - + + {notes} + )} @@ -364,14 +350,16 @@ const AlbumDetails = (props) => { {!isDesktop && record['comment'] && ( )} - {!isDesktop && ( + {!isDesktop && notes && (
setExpanded(!expanded)} > - + + {notes} +
diff --git a/ui/src/album/AlbumDetails.test.jsx b/ui/src/album/AlbumDetails.test.jsx index e03022677..484045444 100644 --- a/ui/src/album/AlbumDetails.test.jsx +++ b/ui/src/album/AlbumDetails.test.jsx @@ -14,6 +14,24 @@ vi.mock('@material-ui/core', async () => { } }) +// Mock formatFullDate to return deterministic results +vi.mock('../utils', async () => { + const actual = await import('../utils') + return { + ...actual, + formatFullDate: (date) => { + if (!date) return '' + // Use en-CA locale for consistent test results + return new Date(date).toLocaleDateString('en-CA', { + year: 'numeric', + month: 'short', + day: 'numeric', + timeZone: 'UTC', + }) + }, + } +}) + describe('Details component', () => { describe('Desktop view', () => { beforeEach(() => { diff --git a/ui/src/album/AlbumGridView.jsx b/ui/src/album/AlbumGridView.jsx index 58732bbde..e90e7a77b 100644 --- a/ui/src/album/AlbumGridView.jsx +++ b/ui/src/album/AlbumGridView.jsx @@ -13,8 +13,13 @@ import { linkToRecord, useListContext, Loading } from 'react-admin' import { withContentRect } from 'react-measure' import { useDrag } from 'react-dnd' import subsonic from '../subsonic' -import { AlbumContextMenu, PlayButton, ArtistLinkField } from '../common' -import { DraggableTypes } from '../consts' +import { + AlbumContextMenu, + PlayButton, + ArtistLinkField, + OverflowTooltip, +} from '../common' +import { COVER_ART_SIZE, DraggableTypes } from '../consts' import clsx from 'clsx' import { AlbumDatesField } from './AlbumDatesField.jsx' @@ -28,13 +33,11 @@ const useStyles = makeStyles( transition: 'all 150ms ease-out', opacity: 0, textAlign: 'left', - marginBottom: '3px', background: 'linear-gradient(to top, rgba(0,0,0,0.7) 0%,rgba(0,0,0,0.4) 70%,rgba(0,0,0,0) 100%)', }, tileBarMobile: { textAlign: 'left', - marginBottom: '3px', background: 'linear-gradient(to top, rgba(0,0,0,0.7) 0%,rgba(0,0,0,0.4) 70%,rgba(0,0,0,0) 100%)', }, @@ -89,6 +92,11 @@ const useStyles = makeStyles( ) const useCoverStyles = makeStyles({ + coverContainer: { + width: '100%', + aspectRatio: '1', + overflow: 'hidden', + }, cover: { display: 'inline-block', width: '100%', @@ -145,11 +153,11 @@ const Cover = withContentRect('bounds')(({ }, []) return ( -
+
{record.name} { to={linkToRecord(basePath, record.id, 'show')} > - {record.name} + + {record.name} + {record.tags && record.tags['albumversion'] && ( {record.tags['albumversion']} diff --git a/ui/src/album/AlbumInfo.jsx b/ui/src/album/AlbumInfo.jsx index e71cd3d33..075841e43 100644 --- a/ui/src/album/AlbumInfo.jsx +++ b/ui/src/album/AlbumInfo.jsx @@ -37,7 +37,7 @@ const AlbumInfo = (props) => { const translate = useTranslate() const record = useRecordContext(props) const data = { - album: , + name: , libraryName: , albumArtist: ( diff --git a/ui/src/album/AlbumList.jsx b/ui/src/album/AlbumList.jsx index 40b927a89..d00d97701 100644 --- a/ui/src/album/AlbumList.jsx +++ b/ui/src/album/AlbumList.jsx @@ -10,6 +10,7 @@ import { ReferenceArrayInput, ReferenceInput, SearchInput, + useListContext, usePermissions, useRefresh, useTranslate, @@ -42,6 +43,9 @@ const useStyles = makeStyles({ }, }) +const formatReleaseType = (record) => + record?.tagValue ? humanize(record?.tagValue) : '-- None --' + const AlbumFilter = (props) => { const classes = useStyles() const translate = useTranslate() @@ -142,9 +146,7 @@ const AlbumFilter = (props) => { > - record?.tagValue ? humanize(record?.tagValue) : '-- None --' - } + optionText={formatReleaseType} /> @@ -173,6 +175,14 @@ const AlbumListTitle = ({ albumListType }) => { return } +const AlbumListPagination = (props) => { + const { loading } = useListContext() + if (loading) { + return null + } + return <Pagination {...props} /> +} + const randomStartingSeed = Math.random().toString() const AlbumList = (props) => { @@ -233,7 +243,7 @@ const AlbumList = (props) => { actions={<AlbumListActions />} filters={<AlbumFilter />} perPage={perPage} - pagination={<Pagination rowsPerPageOptions={perPageOptions} />} + pagination={<AlbumListPagination rowsPerPageOptions={perPageOptions} />} title={<AlbumListTitle albumListType={albumListType} />} > {albumView.grid ? ( diff --git a/ui/src/album/AlbumSongs.jsx b/ui/src/album/AlbumSongs.jsx index d705617e1..8a7fd2ae4 100644 --- a/ui/src/album/AlbumSongs.jsx +++ b/ui/src/album/AlbumSongs.jsx @@ -108,6 +108,9 @@ const AlbumSongs = (props) => { /> ), artist: isDesktop && <ArtistLinkField source="artist" sortable={false} />, + composer: isDesktop && ( + <ArtistLinkField source="composer" sortable={false} /> + ), duration: <DurationField source="duration" sortable={false} />, year: isDesktop && ( <FunctionField @@ -148,6 +151,7 @@ const AlbumSongs = (props) => { columns: toggleableFields, omittedColumns: ['title'], defaultOff: [ + 'composer', 'channels', 'bpm', 'year', diff --git a/ui/src/album/AlbumTableView.jsx b/ui/src/album/AlbumTableView.jsx index 1fa33d769..d1a89d512 100644 --- a/ui/src/album/AlbumTableView.jsx +++ b/ui/src/album/AlbumTableView.jsx @@ -14,6 +14,7 @@ import { makeStyles } from '@material-ui/core/styles' import { useDrag } from 'react-dnd' import { ArtistLinkField, + CoverArtAvatar, DurationField, RangeField, SimpleList, @@ -161,12 +162,18 @@ const AlbumTableView = ({       </> )} + leftIcon={(r) => ( + <span style={{ marginRight: '8px' }}> + <CoverArtAvatar record={r} variant="square" /> + </span> + )} linkType={'show'} rightIcon={(r) => <AlbumContextMenu record={r} />} {...rest} /> ) : ( <AlbumDatagrid rowClick={'show'} classes={{ row: classes.row }} {...rest}> + <CoverArtAvatar source="id" variant="square" /> <TextField source="name" /> {columns} <AlbumContextMenu diff --git a/ui/src/artist/ArtistActions.jsx b/ui/src/artist/ArtistActions.jsx index c33ee892b..0b48f232d 100644 --- a/ui/src/artist/ArtistActions.jsx +++ b/ui/src/artist/ArtistActions.jsx @@ -1,7 +1,7 @@ import React from 'react' import PropTypes from 'prop-types' import { useDispatch } from 'react-redux' -import { useMediaQuery } from '@material-ui/core' +import { useMediaQuery, CircularProgress } from '@material-ui/core' import { makeStyles } from '@material-ui/core/styles' import { Button, @@ -14,7 +14,8 @@ import { import ShuffleIcon from '@material-ui/icons/Shuffle' import PlayArrowIcon from '@material-ui/icons/PlayArrow' import { IoIosRadio } from 'react-icons/io' -import { playShuffle, playSimilar, playTopSongs } from './actions.js' +import { playShuffle, playTopSongs } from './actions.js' +import { playSimilar } from '../common/playbackActions.js' const useStyles = makeStyles((theme) => ({ toolbar: { @@ -45,6 +46,12 @@ const useStyles = makeStyles((theme) => ({ }, })) +const LoadingButton = ({ loading, icon, ...rest }) => ( + <Button {...rest}> + {loading ? <CircularProgress size={20} color="inherit" /> : icon} + </Button> +) + const ArtistActions = ({ className, record, ...rest }) => { const dispatch = useDispatch() const translate = useTranslate() @@ -52,34 +59,45 @@ const ArtistActions = ({ className, record, ...rest }) => { const notify = useNotify() const classes = useStyles() const isMobile = useMediaQuery((theme) => theme.breakpoints.down('xs')) + const [loadingAction, setLoadingAction] = React.useState(null) + const isLoading = !!loadingAction const handlePlay = React.useCallback(async () => { + setLoadingAction('play') try { await playTopSongs(dispatch, notify, record.name) } catch (e) { // eslint-disable-next-line no-console console.error('Error fetching top songs for artist:', e) notify('ra.page.error', 'warning') + } finally { + setLoadingAction(null) } }, [dispatch, notify, record]) const handleShuffle = React.useCallback(async () => { + setLoadingAction('shuffle') try { await playShuffle(dataProvider, dispatch, record.id) } catch (e) { // eslint-disable-next-line no-console console.error('Error fetching songs for shuffle:', e) notify('ra.page.error', 'warning') + } finally { + setLoadingAction(null) } }, [dataProvider, dispatch, record, notify]) const handleRadio = React.useCallback(async () => { + setLoadingAction('radio') try { await playSimilar(dispatch, notify, record.id) } catch (e) { // eslint-disable-next-line no-console console.error('Error starting radio for artist:', e) notify('ra.page.error', 'warning') + } finally { + setLoadingAction(null) } }, [dispatch, notify, record]) @@ -88,30 +106,33 @@ const ArtistActions = ({ className, record, ...rest }) => { className={`${className} ${classes.toolbar}`} {...sanitizeListRestProps(rest)} > - <Button + <LoadingButton onClick={handlePlay} label={translate('resources.artist.actions.topSongs')} className={classes.button} size={isMobile ? 'small' : 'medium'} - > - <PlayArrowIcon /> - </Button> - <Button + disabled={isLoading} + loading={loadingAction === 'play'} + icon={<PlayArrowIcon />} + /> + <LoadingButton onClick={handleShuffle} label={translate('resources.artist.actions.shuffle')} className={classes.button} size={isMobile ? 'small' : 'medium'} - > - <ShuffleIcon /> - </Button> - <Button + disabled={isLoading} + loading={loadingAction === 'shuffle'} + icon={<ShuffleIcon />} + /> + <LoadingButton onClick={handleRadio} label={translate('resources.artist.actions.radio')} className={classes.button} size={isMobile ? 'small' : 'medium'} - > - <IoIosRadio className={classes.radioIcon} /> - </Button> + disabled={isLoading} + loading={loadingAction === 'radio'} + icon={<IoIosRadio className={classes.radioIcon} />} + /> </TopToolbar> ) } diff --git a/ui/src/artist/ArtistExternalLink.jsx b/ui/src/artist/ArtistExternalLink.jsx index 1b6d74560..a83972f17 100644 --- a/ui/src/artist/ArtistExternalLink.jsx +++ b/ui/src/artist/ArtistExternalLink.jsx @@ -4,7 +4,7 @@ import { IconButton, Tooltip, Link } from '@material-ui/core' import { ImLastfm2 } from 'react-icons/im' import MusicBrainz from '../icons/MusicBrainz' -import { intersperse } from '../utils' +import { intersperse, isLastFmURL } from '../utils' import config from '../config' import { makeStyles } from '@material-ui/core/styles' @@ -38,13 +38,13 @@ const ArtistExternalLinks = ({ artistInfo, record }) => { } if (config.lastFMEnabled) { - if (lastFMlink) { + if (lastFMlink && isLastFmURL(lastFMlink[2])) { addLink( lastFMlink[2], 'message.openIn.lastfm', <ImLastfm2 className="lastfm-icon" />, ) - } else if (artistInfo?.lastFmUrl) { + } else if (isLastFmURL(artistInfo?.lastFmUrl)) { addLink( artistInfo?.lastFmUrl, 'message.openIn.lastfm', diff --git a/ui/src/artist/ArtistList.jsx b/ui/src/artist/ArtistList.jsx index e175763e3..6c526a5a5 100644 --- a/ui/src/artist/ArtistList.jsx +++ b/ui/src/artist/ArtistList.jsx @@ -22,6 +22,7 @@ import { useDrag } from 'react-dnd' import clsx from 'clsx' import { ArtistContextMenu, + CoverArtAvatar, List, QuickFilter, useGetHandleArtistClick, @@ -43,6 +44,10 @@ const useStyles = makeStyles({ verticalAlign: 'text-top', }, row: { + '& td': { + paddingTop: '4px !important', + paddingBottom: '4px !important', + }, '&:hover': { '& $contextMenu': { visibility: 'visible', @@ -170,6 +175,7 @@ const ArtistListView = ({ hasShow, hasEdit, hasList, width, ...rest }) => { /> ) : ( <ArtistDatagrid rowClick={handleArtistLink} classes={{ row: classes.row }}> + <CoverArtAvatar source="id" /> <TextField source="name" /> <FunctionField source="albumCount" diff --git a/ui/src/artist/ArtistShow.jsx b/ui/src/artist/ArtistShow.jsx index c6dc832c1..935b0bab7 100644 --- a/ui/src/artist/ArtistShow.jsx +++ b/ui/src/artist/ArtistShow.jsx @@ -1,4 +1,4 @@ -import React, { useState, createElement, useEffect } from 'react' +import { useState, useEffect } from 'react' import { useMediaQuery, withWidth } from '@material-ui/core' import { useShowController, @@ -50,12 +50,12 @@ const useStyles = makeStyles( const ArtistDetails = (props) => { const record = useRecordContext(props) - const isDesktop = useMediaQuery((theme) => theme.breakpoints.up('sm')) + const isDesktop = useMediaQuery((theme) => theme.breakpoints.up('sm'), { + noSsr: true, + }) const [artistInfo, setArtistInfo] = useState() - const biography = - artistInfo?.biography?.replace(new RegExp('<.*>', 'g'), '') || - record.biography + const biography = artistInfo?.biography || record.biography useEffect(() => { subsonic @@ -72,15 +72,9 @@ const ArtistDetails = (props) => { }) }, [record.id]) - const component = isDesktop ? DesktopArtistDetails : MobileArtistDetails + const Component = isDesktop ? DesktopArtistDetails : MobileArtistDetails return ( - <> - {createElement(component, { - artistInfo, - record, - biography, - })} - </> + <Component artistInfo={artistInfo} record={record} biography={biography} /> ) } diff --git a/ui/src/artist/ArtistSimpleList.jsx b/ui/src/artist/ArtistSimpleList.jsx index deeb3edbc..55b6b1a0b 100644 --- a/ui/src/artist/ArtistSimpleList.jsx +++ b/ui/src/artist/ArtistSimpleList.jsx @@ -2,12 +2,13 @@ import React from 'react' import PropTypes from 'prop-types' import List from '@material-ui/core/List' import ListItem from '@material-ui/core/ListItem' +import ListItemAvatar from '@material-ui/core/ListItemAvatar' import ListItemIcon from '@material-ui/core/ListItemIcon' import ListItemSecondaryAction from '@material-ui/core/ListItemSecondaryAction' import ListItemText from '@material-ui/core/ListItemText' import { makeStyles } from '@material-ui/core/styles' import { sanitizeListRestProps } from 'react-admin' -import { ArtistContextMenu, RatingField } from '../common' +import { ArtistContextMenu, CoverArtAvatar, RatingField } from '../common' import config from '../config' const useStyles = makeStyles( @@ -47,7 +48,11 @@ const ArtistSimpleList = ({ data[id] && ( <span key={id} onClick={() => linkType(id)}> <ListItem className={classes.listItem} button={true}> + <ListItemAvatar> + <CoverArtAvatar record={data[id]} /> + </ListItemAvatar> <ListItemText + style={{ marginLeft: '8px' }} primary={ <> <div className={classes.title}>{data[id].name}</div> diff --git a/ui/src/artist/DesktopArtistDetails.jsx b/ui/src/artist/DesktopArtistDetails.jsx index bff2c0906..bc2312477 100644 --- a/ui/src/artist/DesktopArtistDetails.jsx +++ b/ui/src/artist/DesktopArtistDetails.jsx @@ -6,11 +6,18 @@ import CardContent from '@material-ui/core/CardContent' import CardMedia from '@material-ui/core/CardMedia' import ArtistExternalLinks from './ArtistExternalLink' import config from '../config' -import { LoveButton, RatingField } from '../common' +import { + LoveButton, + RatingField, + ImageUploadOverlay, + useImageLoadingState, +} from '../common' import Lightbox from 'react-image-lightbox' import ExpandInfoDialog from '../dialogs/ExpandInfoDialog' import AlbumInfo from '../album/AlbumInfo' +import { COVER_ART_SIZE } from '../consts' import subsonic from '../subsonic' +import { SafeHTML } from '../common/SafeHTML' const useStyles = makeStyles( (theme) => ({ @@ -56,6 +63,7 @@ const useStyles = makeStyles( alignItems: 'center', justifyContent: 'center', boxShadow: 'none', + position: 'relative', }, artistDetail: { flex: '1', @@ -84,36 +92,15 @@ const DesktopArtistDetails = ({ artistInfo, record, biography }) => { const [expanded, setExpanded] = useState(false) const classes = useStyles() const title = record.name - const [isLightboxOpen, setLightboxOpen] = React.useState(false) - const [imageLoading, setImageLoading] = React.useState(false) - const [imageError, setImageError] = React.useState(false) - - // Reset image state when artist changes - React.useEffect(() => { - setImageLoading(true) - setImageError(false) - }, [record.id]) - - const handleImageLoad = React.useCallback(() => { - setImageLoading(false) - setImageError(false) - }, []) - - const handleImageError = React.useCallback(() => { - setImageLoading(false) - setImageError(true) - }, []) - - const handleOpenLightbox = React.useCallback(() => { - if (!imageError) { - setLightboxOpen(true) - } - }, [imageError]) - - const handleCloseLightbox = React.useCallback( - () => setLightboxOpen(false), - [], - ) + const { + imageLoading, + imageError, + isLightboxOpen, + handleImageLoad, + handleImageError, + handleOpenLightbox, + handleCloseLightbox, + } = useImageLoadingState(record.id) return ( <div className={classes.root}> @@ -123,7 +110,7 @@ const DesktopArtistDetails = ({ artistInfo, record, biography }) => { <CardMedia key={record.id} component="img" - src={subsonic.getCoverArtUrl(record, 300)} + src={subsonic.getCoverArtUrl(record, COVER_ART_SIZE)} className={`${classes.cover} ${imageLoading ? classes.coverLoading : ''}`} onClick={handleOpenLightbox} onLoad={handleImageLoad} @@ -134,6 +121,11 @@ const DesktopArtistDetails = ({ artistInfo, record, biography }) => { }} /> )} + <ImageUploadOverlay + entityType="artist" + entityId={record.id} + hasUploadedImage={!!record.uploadedImage} + /> </Card> <div className={classes.details}> <CardContent className={classes.content}> @@ -172,7 +164,9 @@ const DesktopArtistDetails = ({ artistInfo, record, biography }) => { variant={'body1'} onClick={() => setExpanded(!expanded)} > - <span dangerouslySetInnerHTML={{ __html: biography }} /> + <span> + <SafeHTML>{biography}</SafeHTML> + </span> </Typography> </Collapse> </CardContent> diff --git a/ui/src/artist/MobileArtistDetails.jsx b/ui/src/artist/MobileArtistDetails.jsx index 9d0450a66..9c6cd88ae 100644 --- a/ui/src/artist/MobileArtistDetails.jsx +++ b/ui/src/artist/MobileArtistDetails.jsx @@ -4,9 +4,16 @@ import { makeStyles } from '@material-ui/core/styles' import Card from '@material-ui/core/Card' import CardMedia from '@material-ui/core/CardMedia' import config from '../config' -import { LoveButton, RatingField } from '../common' +import { + LoveButton, + RatingField, + ImageUploadOverlay, + useImageLoadingState, +} from '../common' import Lightbox from 'react-image-lightbox' +import { COVER_ART_SIZE } from '../consts' import subsonic from '../subsonic' +import { SafeHTML } from '../common/SafeHTML' const useStyles = makeStyles( (theme) => ({ @@ -66,6 +73,7 @@ const useStyles = makeStyles( minWidth: '7rem', display: 'flex', borderRadius: '5em', + position: 'relative', }, loveButton: { top: theme.spacing(-0.2), @@ -82,40 +90,19 @@ const useStyles = makeStyles( ) const MobileArtistDetails = ({ artistInfo, biography, record }) => { - const img = subsonic.getCoverArtUrl(record) + const img = subsonic.getCoverArtUrl(record, 800) const [expanded, setExpanded] = useState(false) const classes = useStyles({ img, expanded }) const title = record.name - const [isLightboxOpen, setLightboxOpen] = React.useState(false) - const [imageLoading, setImageLoading] = React.useState(false) - const [imageError, setImageError] = React.useState(false) - - // Reset image state when artist changes - React.useEffect(() => { - setImageLoading(true) - setImageError(false) - }, [record.id]) - - const handleImageLoad = React.useCallback(() => { - setImageLoading(false) - setImageError(false) - }, []) - - const handleImageError = React.useCallback(() => { - setImageLoading(false) - setImageError(true) - }, []) - - const handleOpenLightbox = React.useCallback(() => { - if (!imageError) { - setLightboxOpen(true) - } - }, [imageError]) - - const handleCloseLightbox = React.useCallback( - () => setLightboxOpen(false), - [], - ) + const { + imageLoading, + imageError, + isLightboxOpen, + handleImageLoad, + handleImageError, + handleOpenLightbox, + handleCloseLightbox, + } = useImageLoadingState(record.id) return ( <> @@ -126,7 +113,7 @@ const MobileArtistDetails = ({ artistInfo, biography, record }) => { <CardMedia key={record.id} component="img" - src={subsonic.getCoverArtUrl(record, 300)} + src={subsonic.getCoverArtUrl(record, COVER_ART_SIZE)} className={`${classes.cover} ${imageLoading ? classes.coverLoading : ''}`} onClick={handleOpenLightbox} onLoad={handleImageLoad} @@ -137,6 +124,11 @@ const MobileArtistDetails = ({ artistInfo, biography, record }) => { }} /> )} + <ImageUploadOverlay + entityType="artist" + entityId={record.id} + hasUploadedImage={!!record.uploadedImage} + /> </Card> <div className={classes.details}> <Typography @@ -168,7 +160,9 @@ const MobileArtistDetails = ({ artistInfo, biography, record }) => { <div className={classes.biography}> <Collapse collapsedHeight={'1.5em'} in={expanded} timeout={'auto'}> <Typography variant={'body1'} onClick={() => setExpanded(!expanded)}> - <span dangerouslySetInnerHTML={{ __html: biography }} /> + <span> + <SafeHTML>{biography}</SafeHTML> + </span> </Typography> </Collapse> </div> diff --git a/ui/src/artist/actions.js b/ui/src/artist/actions.js index 6a8fbd9c6..94b3adf42 100644 --- a/ui/src/artist/actions.js +++ b/ui/src/artist/actions.js @@ -1,31 +1,6 @@ import subsonic from '../subsonic/index.js' import { playTracks } from '../actions/index.js' - -const mapReplayGain = (song) => { - const { replayGain: rg } = song - if (!rg) { - return song - } - - return { - ...song, - ...(rg.albumGain !== undefined && { rgAlbumGain: rg.albumGain }), - ...(rg.albumPeak !== undefined && { rgAlbumPeak: rg.albumPeak }), - ...(rg.trackGain !== undefined && { rgTrackGain: rg.trackGain }), - ...(rg.trackPeak !== undefined && { rgTrackPeak: rg.trackPeak }), - } -} - -const processSongsForPlayback = (songs) => { - const songData = {} - const ids = [] - songs.forEach((s) => { - const song = mapReplayGain(s) - songData[song.id] = song - ids.push(song.id) - }) - return { songData, ids } -} +import { processSongsForPlayback } from '../common/playbackActions.js' export const playTopSongs = async (dispatch, notify, artistName) => { const res = await subsonic.getTopSongs(artistName, 100) @@ -47,26 +22,6 @@ export const playTopSongs = async (dispatch, notify, artistName) => { dispatch(playTracks(songData, ids)) } -export const playSimilar = async (dispatch, notify, id) => { - const res = await subsonic.getSimilarSongs2(id, 100) - const data = res.json['subsonic-response'] - - if (data.status !== 'ok') { - throw new Error( - `Error fetching similar songs: ${data.error?.message || 'Unknown error'} (Code: ${data.error?.code || 'unknown'})`, - ) - } - - const songs = data.similarSongs2?.song || [] - if (!songs.length) { - notify('message.noSimilarSongsFound', 'warning') - return - } - - const { songData, ids } = processSongsForPlayback(songs) - dispatch(playTracks(songData, ids)) -} - export const playShuffle = async (dataProvider, dispatch, id) => { const res = await dataProvider.getList('song', { pagination: { page: 1, perPage: 500 }, diff --git a/ui/src/audioplayer/AudioTitle.jsx b/ui/src/audioplayer/AudioTitle.jsx index 093bb53fb..df37edfbb 100644 --- a/ui/src/audioplayer/AudioTitle.jsx +++ b/ui/src/audioplayer/AudioTitle.jsx @@ -3,6 +3,7 @@ import { useMediaQuery } from '@material-ui/core' import { Link } from 'react-router-dom' import clsx from 'clsx' import { QualityInfo } from '../common' +import { decisionService } from '../transcode' import useStyle from './styles' import { useDrag } from 'react-dnd' import { DraggableTypes } from '../consts' @@ -35,6 +36,14 @@ const AudioTitle = React.memo(({ audioInfo, gainInfo, isMobile }) => { rgTrackPeak: song.rgTrackPeak, } + const decision = decisionService.getCachedDecision(audioInfo.trackId) + const transcodeProps = decision + ? { + transcodeStream: decision.transcodeStream || null, + isDirectPlay: decision.canDirectPlay, + } + : {} + const subtitle = song.tags?.['subtitle'] const title = song.title + (subtitle ? ` (${subtitle})` : '') @@ -53,6 +62,7 @@ const AudioTitle = React.memo(({ audioInfo, gainInfo, isMobile }) => { record={qi} className={classes.qualityInfo} {...gainInfo} + {...transcodeProps} /> )} </span> diff --git a/ui/src/audioplayer/Player.jsx b/ui/src/audioplayer/Player.jsx index 05ca6ddf7..eba3b82d7 100644 --- a/ui/src/audioplayer/Player.jsx +++ b/ui/src/audioplayer/Player.jsx @@ -1,4 +1,4 @@ -import React, { useCallback, useEffect, useMemo, useState } from 'react' +import React, { useCallback, useEffect, useMemo, useRef, useState } from 'react' import { useDispatch, useSelector } from 'react-redux' import { useMediaQuery } from '@material-ui/core' import { ThemeProvider } from '@material-ui/core/styles' @@ -19,7 +19,9 @@ import AudioTitle from './AudioTitle' import { clearQueue, currentPlaying, + refreshQueue, setPlayMode, + setTranscodingProfile, setVolume, syncQueue, } from '../actions' @@ -30,6 +32,7 @@ import locale from './locale' import { keyMap } from '../hotkeys' import keyHandlers from './keyHandlers' import { calculateGain } from '../utils/calculateReplayGain' +import { detectBrowserProfile, decisionService } from '../transcode' const Player = () => { const theme = useCurrentTheme() @@ -49,6 +52,61 @@ const Player = () => { ) const { authenticated } = useAuthState() + + // Keep a ref to playerState so the mount effect can read the latest value + // without re-triggering on every queue/position change + const playerStateRef = useRef(playerState) + playerStateRef.current = playerState + + // Detect browser codec profile and eagerly resolve transcode URLs for the + // persisted queue once on mount (e.g. after a browser refresh) + useEffect(() => { + const profile = detectBrowserProfile() + decisionService.setProfile(profile) + dispatch(setTranscodingProfile(profile)) + + const state = playerStateRef.current + const currentIdx = state.savedPlayIndex || 0 + const trackIds = state.queue + .slice(currentIdx, currentIdx + 4) + .filter((item) => !item.isRadio && item.trackId) + .map((item) => item.trackId) + + if (trackIds.length === 0) { + dispatch(refreshQueue()) + return + } + + Promise.allSettled( + trackIds.map((id) => + decisionService.resolveStreamUrl(id).then((url) => [id, url]), + ), + ).then((results) => { + const resolvedUrls = {} + results.forEach((r) => { + if (r.status === 'fulfilled') { + resolvedUrls[r.value[0]] = r.value[1] + } + }) + dispatch(refreshQueue(resolvedUrls)) + }) + }, [dispatch]) + + // Pre-fetch transcode decisions for next 2-3 songs when queue or position changes + useEffect(() => { + if (!playerState.queue.length) return + + const currentIdx = playerState.savedPlayIndex || 0 + const nextSongIds = playerState.queue + .slice(currentIdx + 1, currentIdx + 4) + .filter((item) => !item.isRadio) + .map((item) => item.trackId) + + if (nextSongIds.length > 0) { + decisionService.prefetchDecisions(nextSongIds) + } + }, [playerState.queue, playerState.savedPlayIndex]) + const visible = authenticated && playerState.queue.length > 0 const isRadio = playerState.current?.isRadio || false const classes = useStyle({ @@ -95,6 +153,19 @@ const Player = () => { } }, [audioInstance, context, gainNode, playerState, gainInfo]) + useEffect(() => { + const handleBeforeUnload = (e) => { + // Check there's a current track and is actually playing/not paused + if (playerState.current?.uuid && audioInstance && !audioInstance.paused) { + e.preventDefault() + e.returnValue = '' // Chrome requires returnValue to be set + } + } + + window.addEventListener('beforeunload', handleBeforeUnload) + return () => window.removeEventListener('beforeunload', handleBeforeUnload) + }, [playerState, audioInstance]) + const defaultOptions = useMemo( () => ({ theme: playerTheme, @@ -127,6 +198,7 @@ const Player = () => { /> ), locale: locale(translate), + sortableOptions: { delay: 200, delayOnTouchOnly: true }, }), [gainInfo, isDesktop, playerTheme, translate, playerState.mode], ) @@ -137,7 +209,9 @@ const Player = () => { ...defaultOptions, audioLists: playerState.queue.map((item) => item), playIndex: playerState.playIndex, - autoPlay: playerState.clear || playerState.playIndex === 0, + autoPlay: + playerState.autoPlay !== false && + (playerState.clear || playerState.playIndex === 0), clearPriorAudioLists: playerState.clear, extendsContent: ( <PlayerToolbar id={current.trackId} isRadio={current.isRadio} /> @@ -176,9 +250,9 @@ const Player = () => { if (!preloaded) { const next = nextSong() - if (next != null) { - const audio = new Audio() - audio.src = next.musicSrc + if (next != null && !next.isRadio) { + // Trigger decision pre-fetch (this also warms the cache) + decisionService.prefetchDecisions([next.trackId]) } setPreload(true) return @@ -270,6 +344,28 @@ const Player = () => { } }, []) + const onAudioError = useCallback( + (error, currentPlayId, audioLists, audioInfo) => { + // Invalidate all cached decisions — token may be stale + decisionService.invalidateAll() + + // Pre-fetch decisions for upcoming songs with fresh tokens + const currentIdx = playerState.queue.findIndex( + (item) => item.uuid === currentPlayId, + ) + if (currentIdx >= 0) { + const nextSongIds = playerState.queue + .slice(currentIdx + 1, currentIdx + 4) + .filter((item) => !item.isRadio) + .map((item) => item.trackId) + if (nextSongIds.length > 0) { + decisionService.prefetchDecisions(nextSongIds) + } + } + }, + [playerState.queue], + ) + const onBeforeDestroy = useCallback(() => { return new Promise((resolve, reject) => { dispatch(clearQueue()) @@ -306,6 +402,7 @@ const Player = () => { onPlayModeChange={(mode) => dispatch(setPlayMode(mode))} onAudioEnded={onAudioEnded} onCoverClick={onCoverClick} + onAudioError={onAudioError} onBeforeDestroy={onBeforeDestroy} getAudioInstance={setAudioInstance} /> diff --git a/ui/src/authProvider.js b/ui/src/authProvider.js index 4ae238eec..813a4f5b4 100644 --- a/ui/src/authProvider.js +++ b/ui/src/authProvider.js @@ -66,6 +66,10 @@ const authProvider = { logout: () => { removeItems() + if (config.extAuthLogoutURL) { + window.location.href = config.extAuthLogoutURL + return Promise.resolve(false) + } return Promise.resolve() }, diff --git a/ui/src/common/CoverArtAvatar.jsx b/ui/src/common/CoverArtAvatar.jsx new file mode 100644 index 000000000..5642f2504 --- /dev/null +++ b/ui/src/common/CoverArtAvatar.jsx @@ -0,0 +1,37 @@ +import { useRecordContext } from 'react-admin' +import { Avatar } from '@material-ui/core' +import { makeStyles } from '@material-ui/core/styles' +import clsx from 'clsx' +import { COVER_ART_SIZE } from '../consts' +import subsonic from '../subsonic' + +const useStyles = makeStyles({ + avatar: { + width: '55px', + height: '55px', + }, + square: { + borderRadius: '4px', + }, +}) + +export const CoverArtAvatar = ({ + record: recordProp, + variant = 'circular', +}) => { + const classes = useStyles() + const recordContext = useRecordContext() + const record = recordProp || recordContext + if (!record) return null + const square = variant !== 'circular' + return ( + <Avatar + src={subsonic.getCoverArtUrl(record, COVER_ART_SIZE, square)} + variant={variant} + className={clsx(classes.avatar, square && classes.square)} + alt={record.name} + /> + ) +} + +CoverArtAvatar.defaultProps = { label: '', sortable: false } diff --git a/ui/src/common/DateField.jsx b/ui/src/common/DateField.jsx index fab15b53c..dce24a2b9 100644 --- a/ui/src/common/DateField.jsx +++ b/ui/src/common/DateField.jsx @@ -1,10 +1,11 @@ import React from 'react' +import { isDateSet } from '../utils/validations' import { DateField as RADateField } from 'react-admin' export const DateField = (props) => { const { record, source } = props const value = record?.[source] - if (value === '0001-01-01T00:00:00Z' || value === null) return null + if (!isDateSet(value)) return null return <RADateField {...props} /> } diff --git a/ui/src/common/ImageUploadOverlay.jsx b/ui/src/common/ImageUploadOverlay.jsx new file mode 100644 index 000000000..e0d0d0a9a --- /dev/null +++ b/ui/src/common/ImageUploadOverlay.jsx @@ -0,0 +1,139 @@ +import { IconButton, Tooltip } from '@material-ui/core' +import { makeStyles } from '@material-ui/core/styles' +import PhotoCameraIcon from '@material-ui/icons/PhotoCamera' +import DeleteIcon from '@material-ui/icons/Delete' +import { useTranslate, useNotify, useRefresh } from 'react-admin' +import { useCallback, useRef } from 'react' +import config from '../config' +import { REST_URL } from '../consts' +import { httpClient } from '../dataProvider' + +const useStyles = makeStyles(() => ({ + coverOverlay: { + position: 'absolute', + bottom: 0, + right: 0, + display: 'flex', + gap: '2px', + padding: '2px', + backgroundColor: 'rgba(0,0,0,0.5)', + borderRadius: '4px 0 0 0', + opacity: 0, + transition: 'opacity 0.2s ease-in-out', + '*:hover > &': { + opacity: 1, + }, + }, + overlayButton: { + color: '#fff', + padding: '4px', + '&:hover': { + backgroundColor: 'rgba(255,255,255,0.2)', + }, + }, + overlayIcon: { + fontSize: '1.2rem', + }, +})) + +export const ImageUploadOverlay = ({ + entityType, + entityId, + hasUploadedImage, + onImageChange, +}) => { + const translate = useTranslate() + const notify = useNotify() + const refresh = useRefresh() + const classes = useStyles() + const fileInputRef = useRef(null) + + const canEdit = + config.enableCoverArtUpload || localStorage.getItem('role') === 'admin' + + const handleUploadClick = useCallback((e) => { + e.stopPropagation() + if (fileInputRef.current) { + fileInputRef.current.click() + } + }, []) + + const handleFileChange = useCallback( + async (e) => { + const file = e.target.files[0] + if (!file || !entityId) return + + const formData = new FormData() + formData.append('image', file) + + try { + await httpClient(`${REST_URL}/${entityType}/${entityId}/image`, { + method: 'POST', + headers: new Headers({}), + body: formData, + }) + notify(`message.coverUploaded`, 'success') + if (onImageChange) onImageChange() + refresh() + } catch (err) { + notify(`message.coverUploadError`, 'warning') + } + + e.target.value = '' + }, + [entityType, entityId, notify, refresh, onImageChange], + ) + + const handleRemoveCover = useCallback( + async (e) => { + e.stopPropagation() + if (!entityId) return + + try { + await httpClient(`${REST_URL}/${entityType}/${entityId}/image`, { + method: 'DELETE', + }) + notify(`message.coverRemoved`, 'success') + if (onImageChange) onImageChange() + refresh() + } catch (err) { + notify(`message.coverRemoveError`, 'warning') + } + }, + [entityType, entityId, notify, refresh, onImageChange], + ) + + if (!canEdit) return null + + return ( + <div className={classes.coverOverlay}> + <Tooltip title={translate(`message.uploadCover`)}> + <IconButton + className={classes.overlayButton} + onClick={handleUploadClick} + size="small" + > + <PhotoCameraIcon className={classes.overlayIcon} /> + </IconButton> + </Tooltip> + {hasUploadedImage && ( + <Tooltip title={translate(`message.removeCover`)}> + <IconButton + className={classes.overlayButton} + onClick={handleRemoveCover} + size="small" + > + <DeleteIcon className={classes.overlayIcon} /> + </IconButton> + </Tooltip> + )} + <input + ref={fileInputRef} + type="file" + accept="image/*" + style={{ display: 'none' }} + onChange={handleFileChange} + /> + </div> + ) +} diff --git a/ui/src/common/Linkify.jsx b/ui/src/common/Linkify.jsx index 0a09e0d76..f1c8b28c9 100644 --- a/ui/src/common/Linkify.jsx +++ b/ui/src/common/Linkify.jsx @@ -53,12 +53,7 @@ const Linkify = ({ text, ...rest }) => { // Push remaining text if (text.length > lastIndex) { - elements.push( - <span - key={'last-span-key'} - dangerouslySetInnerHTML={{ __html: text.substring(lastIndex) }} - />, - ) + elements.push(text.substring(lastIndex)) } return elements.length === 1 ? elements[0] : elements diff --git a/ui/src/common/Linkify.test.jsx b/ui/src/common/Linkify.test.jsx index cef50b228..cd19ffa03 100644 --- a/ui/src/common/Linkify.test.jsx +++ b/ui/src/common/Linkify.test.jsx @@ -1,6 +1,5 @@ import React from 'react' import { render, screen } from '@testing-library/react' -import '@testing-library/jest-dom' import Linkify from './Linkify' const URL = 'http://www.example.com' diff --git a/ui/src/common/List.jsx b/ui/src/common/List.jsx index f74ab027e..72c2d9482 100644 --- a/ui/src/common/List.jsx +++ b/ui/src/common/List.jsx @@ -1,5 +1,6 @@ import React from 'react' import { List as RAList } from 'react-admin' +import config from '../config' import { Pagination } from './Pagination' import { Title } from './index' @@ -13,6 +14,7 @@ export const List = (props) => { args={{ smart_count: 2 }} /> } + debounce={config.uiSearchDebounceMs} perPage={15} pagination={<Pagination />} {...props} diff --git a/ui/src/common/LoveButton.jsx b/ui/src/common/LoveButton.jsx index f42d92ff4..492ba95b3 100644 --- a/ui/src/common/LoveButton.jsx +++ b/ui/src/common/LoveButton.jsx @@ -4,17 +4,26 @@ import FavoriteIcon from '@material-ui/icons/Favorite' import FavoriteBorderIcon from '@material-ui/icons/FavoriteBorder' import IconButton from '@material-ui/core/IconButton' import { makeStyles } from '@material-ui/core/styles' +import clsx from 'clsx' import { useToggleLove } from './useToggleLove' import { useRecordContext } from 'react-admin' import config from '../config' +import { isDateSet } from '../utils/validations' -const useStyles = makeStyles({ - love: { - color: (props) => props.color, - visibility: (props) => - props.visible === false ? 'hidden' : props.loved ? 'visible' : 'inherit', +const useStyles = makeStyles( + { + love: { + color: (props) => props.color, + visibility: (props) => + props.visible === false + ? 'hidden' + : props.loved + ? 'visible' + : 'inherit', + }, }, -}) + { name: 'NDLoveButton' }, +) export const LoveButton = ({ resource, @@ -24,9 +33,11 @@ export const LoveButton = ({ component: Button, addLabel, disabled, + className, + record: recordProp, ...rest }) => { - const record = useRecordContext(rest) || {} + const record = useRecordContext({ record: recordProp }) || {} const classes = useStyles({ color, visible, loved: record.starred }) const [toggleLove, loading] = useToggleLove(resource, record) @@ -46,8 +57,13 @@ export const LoveButton = ({ <Button onClick={handleToggleLove} size={'small'} - disabled={disabled || loading || record?.missing} - className={classes.love} + disabled={disabled || loading || record.missing} + className={clsx(classes.love, className)} + title={ + isDateSet(record.starredAt) + ? new Date(record.starredAt).toLocaleString() + : undefined + } {...rest} > {record.starred ? ( diff --git a/ui/src/common/MultiLineTextField.jsx b/ui/src/common/MultiLineTextField.jsx index f2a07ff86..1218d4bd6 100644 --- a/ui/src/common/MultiLineTextField.jsx +++ b/ui/src/common/MultiLineTextField.jsx @@ -28,19 +28,7 @@ export const MultiLineTextField = memo( component="span" {...sanitizeFieldRestProps(rest)} > - {lines.length === 0 && emptyText - ? emptyText - : lines.map((line, idx) => - line === '' ? ( - <br key={md5(line + idx)} /> - ) : ( - <div - data-testid={`${source}.${idx}`} - key={md5(line + idx)} - dangerouslySetInnerHTML={{ __html: line }} - /> - ), - )} + {lines.length === 0 && emptyText ? emptyText : lines} </Typography> ) }, diff --git a/ui/src/common/MultiLineTextField.test.jsx b/ui/src/common/MultiLineTextField.test.jsx deleted file mode 100644 index 8f29166a3..000000000 --- a/ui/src/common/MultiLineTextField.test.jsx +++ /dev/null @@ -1,28 +0,0 @@ -import * as React from 'react' -import { render, cleanup, screen } from '@testing-library/react' -import { MultiLineTextField } from './MultiLineTextField' - -describe('<MultiLineTextField />', () => { - afterEach(cleanup) - - it('should render each line in a separated div', () => { - const record = { comment: 'line1\nline2' } - render(<MultiLineTextField record={record} source={'comment'} />) - expect(screen.queryByTestId('comment.0').textContent).toBe('line1') - expect(screen.queryByTestId('comment.1').textContent).toBe('line2') - }) - - it.each([null, undefined])( - 'should render the emptyText when value is %s', - (body) => { - render( - <MultiLineTextField - record={{ id: 123, body }} - emptyText="NA" - source="body" - />, - ) - expect(screen.getByText('NA')).toBeInTheDocument() - }, - ) -}) diff --git a/ui/src/common/OverflowTooltip.jsx b/ui/src/common/OverflowTooltip.jsx new file mode 100644 index 000000000..c000bd9f0 --- /dev/null +++ b/ui/src/common/OverflowTooltip.jsx @@ -0,0 +1,90 @@ +import React from 'react' +import PropTypes from 'prop-types' +import { Tooltip } from '@material-ui/core' +import { makeStyles, alpha } from '@material-ui/core/styles' +import grey from '@material-ui/core/colors/grey' + +const useStyles = makeStyles( + (theme) => ({ + tooltip: { + backgroundColor: + theme.palette.type === 'dark' + ? alpha(grey[700], 0.92) + : alpha(grey[300], 0.92), + color: + theme.palette.type === 'dark' + ? theme.palette.common.white + : theme.palette.common.black, + borderRadius: theme.shape.borderRadius, + ...theme.typography.body2, + padding: theme.spacing(0.5, 1), + maxWidth: 300, + }, + }), + { name: 'NDOverflowTooltip' }, +) + +const transitionProps = { timeout: 0 } + +export const OverflowTooltip = ({ + children, + title, + placement = 'bottom-start', +}) => { + const classes = useStyles() + const textRef = React.useRef(null) + const [isOverflowing, setIsOverflowing] = React.useState(false) + const tooltipClasses = React.useMemo( + () => ({ tooltip: classes.tooltip }), + [classes.tooltip], + ) + + React.useLayoutEffect(() => { + const el = textRef.current + if (!el) return + + const checkOverflow = () => { + setIsOverflowing(el.scrollWidth > el.clientWidth) + } + + const resizeObserver = new ResizeObserver(checkOverflow) + resizeObserver.observe(el) + + checkOverflow() + + return () => resizeObserver.disconnect() + }, []) + + const mergedRef = React.useCallback( + (el) => { + textRef.current = el + + const { ref } = children + if (typeof ref === 'function') { + ref(el) + } else if (ref && typeof ref === 'object') { + ref.current = el + } + }, + [children], + ) + + return ( + <Tooltip + title={title} + disableHoverListener={!isOverflowing} + disableTouchListener + placement={placement} + TransitionProps={transitionProps} + classes={tooltipClasses} + > + {React.cloneElement(children, { ref: mergedRef })} + </Tooltip> + ) +} + +OverflowTooltip.propTypes = { + children: PropTypes.element.isRequired, + title: PropTypes.string.isRequired, + placement: PropTypes.string, +} diff --git a/ui/src/common/QualityInfo.jsx b/ui/src/common/QualityInfo.jsx index 171f5e0f0..57a8251a4 100644 --- a/ui/src/common/QualityInfo.jsx +++ b/ui/src/common/QualityInfo.jsx @@ -20,7 +20,15 @@ const useStyle = makeStyles( }, ) -export const QualityInfo = ({ record, size, gainMode, preAmp, className }) => { +export const QualityInfo = ({ + record, + size, + gainMode, + preAmp, + className, + transcodeStream, + isDirectPlay, +}) => { const classes = useStyle() let { suffix, bitRate, rgAlbumGain, rgAlbumPeak, rgTrackGain, rgTrackPeak } = record @@ -34,6 +42,20 @@ export const QualityInfo = ({ record, size, gainMode, preAmp, className }) => { } } + // Show transcode target when transcoding (not direct play) + if (transcodeStream && !isDirectPlay) { + const targetCodec = (transcodeStream.codec || '').toUpperCase() + const targetBitrate = transcodeStream.audioBitrate + ? Math.round(transcodeStream.audioBitrate / 1000) + : 0 + let targetInfo = targetCodec + if (targetBitrate > 0) { + targetInfo += ' ' + targetBitrate + } + const sourceSuffix = suffix || placeholder + info = `${sourceSuffix} → ${targetInfo}` + } + const extra = useMemo(() => { if (gainMode !== 'none') { const gainValue = calculateGain( @@ -63,6 +85,8 @@ QualityInfo.propTypes = { size: PropTypes.string, className: PropTypes.string, gainMode: PropTypes.string, + transcodeStream: PropTypes.object, + isDirectPlay: PropTypes.bool, } QualityInfo.defaultProps = { diff --git a/ui/src/common/QualityInfo.test.jsx b/ui/src/common/QualityInfo.test.jsx index ae1874715..174ee8a85 100644 --- a/ui/src/common/QualityInfo.test.jsx +++ b/ui/src/common/QualityInfo.test.jsx @@ -77,4 +77,30 @@ describe('<QualityInfo />', () => { ) expect(screen.getByText('FLAC (0.00 dB)')).toBeInTheDocument() }) + + it('shows transcode arrow when transcodeStream is provided', () => { + const info = { suffix: 'FLAC', bitRate: 1008 } + const transcodeStream = { codec: 'opus', audioBitrate: 128000 } + render(<QualityInfo record={info} transcodeStream={transcodeStream} />) + expect(screen.getByText('FLAC → OPUS 128')).toBeInTheDocument() + }) + + it('shows transcode with lossy source including bitrate', () => { + const info = { suffix: 'FLAC', bitRate: 1008 } + const transcodeStream = { codec: 'mp3', audioBitrate: 320000 } + render(<QualityInfo record={info} transcodeStream={transcodeStream} />) + expect(screen.getByText('FLAC → MP3 320')).toBeInTheDocument() + }) + + it('does not show arrow when isDirectPlay is true', () => { + const info = { suffix: 'MP3', bitRate: 320 } + render(<QualityInfo record={info} isDirectPlay={true} />) + expect(screen.getByText('MP3 320')).toBeInTheDocument() + }) + + it('behaves normally when no transcode props are passed', () => { + const info = { suffix: 'MP3', bitRate: 320 } + render(<QualityInfo record={info} />) + expect(screen.getByText('MP3 320')).toBeInTheDocument() + }) }) diff --git a/ui/src/common/RatingField.jsx b/ui/src/common/RatingField.jsx index b29c1eee8..f92b0d948 100644 --- a/ui/src/common/RatingField.jsx +++ b/ui/src/common/RatingField.jsx @@ -2,6 +2,7 @@ import React, { useCallback } from 'react' import PropTypes from 'prop-types' import Rating from '@material-ui/lab/Rating' import { makeStyles } from '@material-ui/core/styles' +import { isDateSet } from '../utils/validations' import StarBorderIcon from '@material-ui/icons/StarBorder' import clsx from 'clsx' import { useRating } from './useRating' @@ -45,7 +46,14 @@ export const RatingField = ({ ) return ( - <span onClick={(e) => stopPropagation(e)}> + <span + onClick={(e) => stopPropagation(e)} + title={ + isDateSet(record.ratedAt) + ? new Date(record.ratedAt).toLocaleString() + : undefined + } + > <Rating name={record.mediaFileId || record.id} className={clsx( diff --git a/ui/src/common/SafeHTML.jsx b/ui/src/common/SafeHTML.jsx new file mode 100644 index 000000000..980883568 --- /dev/null +++ b/ui/src/common/SafeHTML.jsx @@ -0,0 +1,27 @@ +import DOMPurify from 'dompurify' +import { useMemo } from 'react' + +export const SafeHTML = ({ children }) => { + const purified = useMemo(() => { + const purify = DOMPurify() + + purify.addHook('afterSanitizeElements', async (node) => { + if (node instanceof HTMLElement) { + // Set referrer-policy for elements with src + switch (node.tagName.toLowerCase()) { + case 'a': + case 'area': + case 'img': + case 'video': + case 'iframe': + case 'script': + node.setAttribute('referrer-policy', 'no-referrer') + } + } + }) + + return purify.sanitize(children, { ADD_ATTR: ['referrer-policy'] }) + }, [children]) + + return <span dangerouslySetInnerHTML={{ __html: purified }} /> +} diff --git a/ui/src/common/SongContextMenu.jsx b/ui/src/common/SongContextMenu.jsx index f8b0bba5e..ac5b10e13 100644 --- a/ui/src/common/SongContextMenu.jsx +++ b/ui/src/common/SongContextMenu.jsx @@ -24,6 +24,7 @@ import { } from '../actions' import { LoveButton } from './LoveButton' import config from '../config' +import { playSimilar } from './playbackActions.js' import { formatBytes } from '../utils' import { useRedirect } from 'react-admin' @@ -86,6 +87,24 @@ export const SongContextMenu = ({ label: translate('resources.song.actions.addToQueue'), action: (record) => dispatch(addTracks({ [record.id]: record })), }, + instantMix: { + enabled: config.enableExternalServices, + label: translate('resources.song.actions.instantMix'), + action: async (record) => { + notify('message.startingInstantMix', { type: 'info' }) + try { + const id = record.mediaFileId || record.id + await playSimilar(dispatch, notify, id, { + seedRecord: record, + shuffle: false, + }) + } catch (e) { + // eslint-disable-next-line no-console + console.error('Error starting instant mix:', e) + notify('ra.page.error', { type: 'warning' }) + } + }, + }, addToPlaylist: { enabled: true, label: translate('resources.song.actions.addToPlaylist'), diff --git a/ui/src/common/SongContextMenu.test.jsx b/ui/src/common/SongContextMenu.test.jsx index a30da859f..7172742d3 100644 --- a/ui/src/common/SongContextMenu.test.jsx +++ b/ui/src/common/SongContextMenu.test.jsx @@ -3,19 +3,36 @@ import { render, fireEvent, screen, waitFor } from '@testing-library/react' import { TestContext } from 'ra-test' import { describe, it, expect, vi, beforeEach } from 'vitest' import { SongContextMenu } from './SongContextMenu' +import subsonic from '../subsonic' vi.mock('../dataProvider', () => ({ httpClient: vi.fn(), })) -vi.mock('react-redux', () => ({ useDispatch: () => vi.fn() })) +vi.mock('../subsonic', () => ({ + default: { getSimilarSongs2: vi.fn() }, +})) + +vi.mock('../config', () => ({ + default: { + enableDownloads: true, + enableFavourites: true, + enableSharing: true, + enableExternalServices: true, + }, +})) + +const mockDispatch = vi.fn() +vi.mock('react-redux', () => ({ useDispatch: () => mockDispatch })) const getPlaylistsMock = vi.fn() +const mockNotify = vi.fn() vi.mock('react-admin', async (importOriginal) => { const actual = await importOriginal() return { ...actual, + useNotify: () => mockNotify, useRedirect: () => (url) => { window.location.hash = `#${url}` }, @@ -35,6 +52,14 @@ describe('SongContextMenu', () => { getPlaylistsMock.mockResolvedValue({ data: [{ id: 'pl1', name: 'Pl 1' }], }) + subsonic.getSimilarSongs2.mockResolvedValue({ + json: { + 'subsonic-response': { + status: 'ok', + similarSongs2: { song: [{ id: 's1' }] }, + }, + }, + }) }) it('navigates to playlist when selected', async () => { @@ -104,4 +129,99 @@ describe('SongContextMenu', () => { ) expect(mockOnClick).not.toHaveBeenCalled() }) + + describe('Instant Mix action', () => { + it('calls getSimilarSongs2 with song id and shows loading notification', async () => { + render( + <TestContext> + <SongContextMenu record={{ id: 'song1', size: 1 }} resource="song" /> + </TestContext>, + ) + + fireEvent.click(screen.getAllByRole('button')[1]) + await waitFor(() => + screen.getByText(/resources\.song\.actions\.instantMix/), + ) + fireEvent.click(screen.getByText(/resources\.song\.actions\.instantMix/)) + + // Verify loading notification is shown + expect(mockNotify).toHaveBeenCalledWith('message.startingInstantMix', { + type: 'info', + }) + + await waitFor(() => + expect(subsonic.getSimilarSongs2).toHaveBeenCalledWith('song1', 100), + ) + expect(mockDispatch).toHaveBeenCalled() + }) + + it('plays seed song first followed by similar songs', async () => { + const seedRecord = { id: 'song1', title: 'Seed Song', size: 1 } + render( + <TestContext> + <SongContextMenu record={seedRecord} resource="song" /> + </TestContext>, + ) + + fireEvent.click(screen.getAllByRole('button')[1]) + await waitFor(() => + screen.getByText(/resources\.song\.actions\.instantMix/), + ) + fireEvent.click(screen.getByText(/resources\.song\.actions\.instantMix/)) + + await waitFor(() => expect(mockDispatch).toHaveBeenCalled()) + + // Verify dispatch was called with playTracks action + const dispatchCall = mockDispatch.mock.calls.find( + (call) => call[0]?.type === 'PLAYER_PLAY_TRACKS', + ) + expect(dispatchCall).toBeDefined() + + // Verify seed song is first (id property contains the first song to play) + const { id, data } = dispatchCall[0] + expect(id).toBe('song1') + // Verify seed song data is included + expect(data['song1']).toBeDefined() + }) + + it('uses mediaFileId when available (playlist context)', async () => { + render( + <TestContext> + <SongContextMenu + record={{ + id: 'playlistTrackId', + mediaFileId: 'actualSongId', + size: 1, + }} + resource="song" + /> + </TestContext>, + ) + + fireEvent.click(screen.getAllByRole('button')[1]) + await waitFor(() => + screen.getByText(/resources\.song\.actions\.instantMix/), + ) + fireEvent.click(screen.getByText(/resources\.song\.actions\.instantMix/)) + + await waitFor(() => + expect(subsonic.getSimilarSongs2).toHaveBeenCalledWith( + 'actualSongId', + 100, + ), + ) + + await waitFor(() => expect(mockDispatch).toHaveBeenCalled()) + + // Verify the mediaFileId is used as the seed song id + const dispatchCall = mockDispatch.mock.calls.find( + (call) => call[0]?.type === 'PLAYER_PLAY_TRACKS', + ) + expect(dispatchCall).toBeDefined() + const { id, data } = dispatchCall[0] + expect(id).toBe('actualSongId') + // Verify seed song data is included + expect(data['actualSongId']).toBeDefined() + }) + }) }) diff --git a/ui/src/common/SongDatagrid.jsx b/ui/src/common/SongDatagrid.jsx index 3586cf225..d2c98bbe7 100644 --- a/ui/src/common/SongDatagrid.jsx +++ b/ui/src/common/SongDatagrid.jsx @@ -1,4 +1,10 @@ -import React, { isValidElement, useMemo, useCallback, forwardRef } from 'react' +import React, { + isValidElement, + useMemo, + useCallback, + useState, + forwardRef, +} from 'react' import { useDispatch } from 'react-redux' import { Datagrid, @@ -17,7 +23,10 @@ import { makeStyles } from '@material-ui/core/styles' import AlbumIcon from '@material-ui/icons/Album' import clsx from 'clsx' import { useDrag } from 'react-dnd' +import Lightbox from 'react-image-lightbox' +import 'react-image-lightbox/style.css' import { playTracks } from '../actions' +import subsonic from '../subsonic' import { AlbumContextMenu } from '../common' import { DraggableTypes } from '../consts' import { formatFullDate } from '../utils' @@ -28,10 +37,20 @@ const useStyles = makeStyles({ overflow: 'hidden', textOverflow: 'ellipsis', verticalAlign: 'middle', + display: 'flex', + alignItems: 'center', }, discIcon: { - verticalAlign: 'text-top', - marginRight: '4px', + marginRight: '14px', + }, + discCoverArt: { + width: '48px', + height: '48px', + marginRight: '14px', + objectFit: 'cover', + borderRadius: '4px', + flexShrink: 0, + cursor: 'pointer', }, row: { cursor: 'pointer', @@ -61,19 +80,55 @@ const useStyles = makeStyles({ const DiscSubtitleRow = forwardRef( ({ record, onClick, colSpan, contextAlwaysVisible }, ref) => { + const translate = useTranslate() const isDesktop = useMediaQuery((theme) => theme.breakpoints.up('md')) const classes = useStyles({ isDesktop }) + const [imageError, setImageError] = useState(false) + const [isLightboxOpen, setLightboxOpen] = useState(false) + const lightboxClosedAt = React.useRef(0) const handlePlaySubset = (discNumber) => () => { + // Ignore clicks shortly after the lightbox was closed to prevent + // mobile touch events from "falling through" the overlay and + // triggering playback. + if (Date.now() - lightboxClosedAt.current < 400) { + return + } onClick(discNumber) } - let subtitle = [] - if (record.discNumber > 0) { - subtitle.push(record.discNumber) - } - if (record.discSubtitle) { - subtitle.push(record.discSubtitle) - } + const coverArtUrl = subsonic.getDiscCoverArtUrl( + record.albumId, + record.discNumber, + record.updatedAt, + 96, + ) + + const fullImageUrl = subsonic.getDiscCoverArtUrl( + record.albumId, + record.discNumber, + record.updatedAt, + ) + + const handleOpenLightbox = useCallback( + (e) => { + if (!imageError) { + e.stopPropagation() + setLightboxOpen(true) + } + }, + [imageError], + ) + + const handleCloseLightbox = useCallback(() => { + lightboxClosedAt.current = Date.now() + setLightboxOpen(false) + }, []) + + const subtitle = record.discSubtitle + ? record.discSubtitle + : translate('resources.song.fields.disc', { + discNumber: record.discNumber, + }) return ( <TableRow @@ -84,9 +139,28 @@ const DiscSubtitleRow = forwardRef( > <TableCell colSpan={colSpan}> <Typography variant="h6" className={classes.subtitle}> - <AlbumIcon className={classes.discIcon} fontSize={'small'} /> - {subtitle.join(': ')} + {!imageError ? ( + <img + src={coverArtUrl} + className={classes.discCoverArt} + alt="" + onClick={handleOpenLightbox} + onError={() => setImageError(true)} + /> + ) : ( + <AlbumIcon className={classes.discIcon} fontSize={'small'} /> + )} + {subtitle} </Typography> + {isLightboxOpen && !imageError && ( + <Lightbox + imagePadding={50} + animationDuration={200} + imageTitle={record.album + ' - ' + subtitle} + mainSrc={fullImageUrl} + onCloseRequest={handleCloseLightbox} + /> + )} </TableCell> <TableCell> <AlbumContextMenu diff --git a/ui/src/common/index.js b/ui/src/common/index.js index f64d4fe0c..a7d6a43c4 100644 --- a/ui/src/common/index.js +++ b/ui/src/common/index.js @@ -41,3 +41,8 @@ export * from './formatRange.js' export * from './playlistUtils.js' export * from './PathField.jsx' export * from './ParticipantsInfo' +export * from './OverflowTooltip' +export * from './useSearchRefocus' +export * from './ImageUploadOverlay' +export * from './CoverArtAvatar' +export * from './useImageLoadingState' diff --git a/ui/src/common/playbackActions.js b/ui/src/common/playbackActions.js new file mode 100644 index 000000000..414dbe413 --- /dev/null +++ b/ui/src/common/playbackActions.js @@ -0,0 +1,76 @@ +import subsonic from '../subsonic/index.js' +import { playTracks } from '../actions/index.js' + +const shuffleArray = (array) => { + const shuffled = [...array] + for (let i = shuffled.length - 1; i > 0; i--) { + const j = Math.floor(Math.random() * (i + 1)) + ;[shuffled[i], shuffled[j]] = [shuffled[j], shuffled[i]] + } + return shuffled +} + +const mapReplayGain = (song) => { + const { replayGain: rg } = song + if (!rg) { + return song + } + + return { + ...song, + ...(rg.albumGain !== undefined && { rgAlbumGain: rg.albumGain }), + ...(rg.albumPeak !== undefined && { rgAlbumPeak: rg.albumPeak }), + ...(rg.trackGain !== undefined && { rgTrackGain: rg.trackGain }), + ...(rg.trackPeak !== undefined && { rgTrackPeak: rg.trackPeak }), + } +} + +export const processSongsForPlayback = (songs) => { + const songData = {} + const ids = [] + songs.forEach((s) => { + const song = mapReplayGain(s) + songData[song.id] = song + ids.push(song.id) + }) + return { songData, ids } +} + +export const playSimilar = async (dispatch, notify, id, options = {}) => { + const { seedRecord = null, shuffle = false } = options + + const res = await subsonic.getSimilarSongs2(id, 100) + const data = res.json['subsonic-response'] + + if (data.status !== 'ok') { + throw new Error( + `Error fetching similar songs: ${data.error?.message || 'Unknown error'} (Code: ${data.error?.code || 'unknown'})`, + ) + } + + let songs = data.similarSongs2?.song || [] + + // Randomize similar songs if requested + if (shuffle) { + songs = shuffleArray(songs) + } + + // If no similar songs found and no seed, show warning + if (!songs.length && !seedRecord) { + notify('message.noSimilarSongsFound', 'warning') + return + } + + const { songData, ids } = processSongsForPlayback(songs) + + // Prepend seed song if provided + if (seedRecord) { + const seedId = seedRecord.mediaFileId || seedRecord.id + // Remove seed from similar songs if it appears there + const filteredIds = ids.filter((songId) => songId !== seedId) + songData[seedId] = mapReplayGain(seedRecord) + dispatch(playTracks(songData, [seedId, ...filteredIds])) + } else { + dispatch(playTracks(songData, ids)) + } +} diff --git a/ui/src/common/useImageLoadingState.js b/ui/src/common/useImageLoadingState.js new file mode 100644 index 000000000..3528b0f3f --- /dev/null +++ b/ui/src/common/useImageLoadingState.js @@ -0,0 +1,44 @@ +import { useState, useEffect, useCallback } from 'react' + +/** + * Manages image loading/error state and lightbox open/close. + * Resets when recordId changes. + */ +export const useImageLoadingState = (recordId) => { + const [imageLoading, setImageLoading] = useState(true) + const [imageError, setImageError] = useState(false) + const [isLightboxOpen, setLightboxOpen] = useState(false) + + useEffect(() => { + setImageLoading(true) + setImageError(false) + }, [recordId]) + + const handleImageLoad = useCallback(() => { + setImageLoading(false) + setImageError(false) + }, []) + + const handleImageError = useCallback(() => { + setImageLoading(false) + setImageError(true) + }, []) + + const handleOpenLightbox = useCallback(() => { + if (!imageError) { + setLightboxOpen(true) + } + }, [imageError]) + + const handleCloseLightbox = useCallback(() => setLightboxOpen(false), []) + + return { + imageLoading, + imageError, + isLightboxOpen, + handleImageLoad, + handleImageError, + handleOpenLightbox, + handleCloseLightbox, + } +} diff --git a/ui/src/common/useSearchRefocus.js b/ui/src/common/useSearchRefocus.js new file mode 100644 index 000000000..4daad26f9 --- /dev/null +++ b/ui/src/common/useSearchRefocus.js @@ -0,0 +1,50 @@ +import { useEffect, useRef } from 'react' +import { useLocation } from 'react-router-dom' + +// Search field names used by SearchInput across different list views: +// - 'name': AlbumList, ArtistList, LibraryList, PlayerList, RadioList, UserList +// - 'title': SongList +// - 'q': PlaylistList +// If a new list view uses a different source field, add it here. +const SEARCH_FIELDS = ['name', 'title', 'q'] + +const getSearchValue = (filter) => { + for (const field of SEARCH_FIELDS) { + if (filter[field]) return filter[field] + } + return '' +} + +export const useSearchRefocus = () => { + const location = useLocation() + const prevSearchValue = useRef(null) + + useEffect(() => { + const params = new URLSearchParams(location.search) + const filterStr = params.get('filter') || '{}' + + let filter = {} + try { + filter = JSON.parse(filterStr) + } catch (e) { + // Invalid JSON, ignore + } + + const searchValue = getSearchValue(filter) + + if (prevSearchValue.current && !searchValue) { + // Use requestAnimationFrame to wait for React to finish re-rendering + // after the URL change before focusing the input + requestAnimationFrame(() => { + // Selector depends on react-admin's internal class naming. + // If react-admin changes these class names, this will need updating. + const input = document.querySelector('[class*="RaSearchInput"] input') + if (input) { + input.focus() + } + }) + } + + prevSearchValue.current = searchValue + }, [location.search]) +} diff --git a/ui/src/common/useSearchRefocus.test.js b/ui/src/common/useSearchRefocus.test.js new file mode 100644 index 000000000..2bce8320d --- /dev/null +++ b/ui/src/common/useSearchRefocus.test.js @@ -0,0 +1,84 @@ +import { vi, describe, it, expect, beforeEach, afterEach } from 'vitest' +import { renderHook } from '@testing-library/react-hooks' +import { useSearchRefocus } from './useSearchRefocus' + +const mockLocation = { search: '' } +vi.mock('react-router-dom', () => ({ + useLocation: () => mockLocation, +})) + +describe('useSearchRefocus', () => { + let container + let rafCallbacks + + beforeEach(() => { + rafCallbacks = [] + vi.spyOn(window, 'requestAnimationFrame').mockImplementation((cb) => { + rafCallbacks.push(cb) + return rafCallbacks.length + }) + + container = document.createElement('div') + container.innerHTML = ` + <div class="RaSearchInput-input"> + <input type="text" /> + </div> + ` + document.body.appendChild(container) + mockLocation.search = '' + }) + + afterEach(() => { + vi.restoreAllMocks() + document.body.removeChild(container) + }) + + const flushRAF = () => { + rafCallbacks.forEach((cb) => cb()) + rafCallbacks = [] + } + + it('focuses the input when search filter is cleared', () => { + const input = container.querySelector('input') + const focusSpy = vi.spyOn(input, 'focus') + + mockLocation.search = '?filter={"name":"test"}' + const { rerender } = renderHook(() => useSearchRefocus()) + + expect(focusSpy).not.toHaveBeenCalled() + + mockLocation.search = '?filter={}' + rerender() + flushRAF() + + expect(focusSpy).toHaveBeenCalledTimes(1) + }) + + it('does not focus if filter was already empty', () => { + const input = container.querySelector('input') + const focusSpy = vi.spyOn(input, 'focus') + + mockLocation.search = '?filter={}' + const { rerender } = renderHook(() => useSearchRefocus()) + + mockLocation.search = '?filter={}' + rerender() + flushRAF() + + expect(focusSpy).not.toHaveBeenCalled() + }) + + it('does not focus if filter value changed but not cleared', () => { + const input = container.querySelector('input') + const focusSpy = vi.spyOn(input, 'focus') + + mockLocation.search = '?filter={"name":"test"}' + const { rerender } = renderHook(() => useSearchRefocus()) + + mockLocation.search = '?filter={"name":"other"}' + rerender() + flushRAF() + + expect(focusSpy).not.toHaveBeenCalled() + }) +}) diff --git a/ui/src/config.js b/ui/src/config.js index a53a97de7..0672a58f4 100644 --- a/ui/src/config.js +++ b/ui/src/config.js @@ -20,7 +20,9 @@ const defaultConfig = { defaultTheme: 'Dark', defaultLanguage: '', defaultUIVolume: 100, + uiSearchDebounceMs: 200, enableUserEditing: true, + enableCoverArtUpload: true, enableSharing: true, shareURL: '', defaultDownloadableShare: true, @@ -38,6 +40,7 @@ const defaultConfig = { publicBaseUrl: '/share', separator: '/', enableInspect: true, + pluginsEnabled: true, } let config diff --git a/ui/src/consts.js b/ui/src/consts.js index e3446c2fe..68ec478f1 100644 --- a/ui/src/consts.js +++ b/ui/src/consts.js @@ -7,6 +7,8 @@ export const M3U_MIME_TYPE = 'audio/x-mpegurl' export const AUTO_THEME_ID = 'AUTO_THEME_ID' +export const AUTO_THEME_CONFIG_VALUE = 'Auto' + export const DraggableTypes = { SONG: 'song', ALBUM: 'album', @@ -22,6 +24,10 @@ DraggableTypes.ALL.push( DraggableTypes.ARTIST, ) +export const RADIO_PLACEHOLDER_IMAGE = 'internet-radio-icon.svg' + +export const COVER_ART_SIZE = 600 + export const DEFAULT_SHARE_BITRATE = 128 export const BITRATE_CHOICES = [ diff --git a/ui/src/dataProvider/wrapperDataProvider.js b/ui/src/dataProvider/wrapperDataProvider.js index 8b4a0cb62..268d3668d 100644 --- a/ui/src/dataProvider/wrapperDataProvider.js +++ b/ui/src/dataProvider/wrapperDataProvider.js @@ -12,7 +12,21 @@ const isAdmin = () => { const getSelectedLibraries = () => { try { const state = JSON.parse(localStorage.getItem('state')) - return state?.library?.selectedLibraries || [] + const selectedLibraries = state?.library?.selectedLibraries || [] + const userLibraries = state?.library?.userLibraries || [] + + // Validate selected libraries against current user libraries + const userLibraryIds = userLibraries.map((lib) => lib.id) + const validatedSelection = selectedLibraries.filter((id) => + userLibraryIds.includes(id), + ) + + // If user has only one library, return empty array (no filter needed) + if (userLibraryIds.length === 1) { + return [] + } + + return validatedSelection } catch (err) { return [] } diff --git a/ui/src/dialogs/AboutDialog.jsx b/ui/src/dialogs/AboutDialog.jsx index 661462b9b..486cc0492 100644 --- a/ui/src/dialogs/AboutDialog.jsx +++ b/ui/src/dialogs/AboutDialog.jsx @@ -9,6 +9,7 @@ import TableBody from '@material-ui/core/TableBody' import TableRow from '@material-ui/core/TableRow' import TableCell from '@material-ui/core/TableCell' import Paper from '@material-ui/core/Paper' +import CloudDownloadIcon from '@material-ui/icons/CloudDownload' import FavoriteBorderIcon from '@material-ui/icons/FavoriteBorder' import FileCopyIcon from '@material-ui/icons/FileCopy' import Button from '@material-ui/core/Button' @@ -245,6 +246,21 @@ const ConfigTabContent = ({ configData }) => { } } + const handleDownloadToml = () => { + const tomlContent = configToToml(configData, translate) + const tomlFile = new File([tomlContent], 'navidrome.toml', { + type: 'text/plain', + }) + + const tomlFileLink = document.createElement('a') + const tomlFileUrl = URL.createObjectURL(tomlFile) + tomlFileLink.href = tomlFileUrl + tomlFileLink.download = tomlFile.name + tomlFileLink.click() + + URL.revokeObjectURL(tomlFileUrl) + } + return ( <div className={classes.configContainer}> <Button @@ -252,11 +268,23 @@ const ConfigTabContent = ({ configData }) => { startIcon={<FileCopyIcon />} onClick={handleCopyToml} className={classes.copyButton} - disabled={!configData} + disabled={ + !configData || !navigator.clipboard || !window.isSecureContext + } size="small" > {translate('about.config.exportToml')} </Button> + <Button + variant="outlined" + startIcon={<CloudDownloadIcon />} + onClick={handleDownloadToml} + className={classes.copyButton} + disabled={!configData} + size="small" + > + {translate('about.config.downloadToml')} + </Button> <TableContainer className={classes.tableContainer}> <Table size="small" stickyHeader> <TableHead> diff --git a/ui/src/dialogs/SelectPlaylistInput.jsx b/ui/src/dialogs/SelectPlaylistInput.jsx index d401dd822..847107523 100644 --- a/ui/src/dialogs/SelectPlaylistInput.jsx +++ b/ui/src/dialogs/SelectPlaylistInput.jsx @@ -318,11 +318,10 @@ export const SelectPlaylistInput = ({ onChange }) => { const canCreateNew = Boolean( searchText.trim() && - !filteredOptions.some( - (option) => - option.name.toLowerCase() === searchText.toLowerCase().trim(), - ) && - !selectedPlaylists.some((p) => p.name === searchText.trim()), + !filteredOptions.some( + (option) => option.name.toLowerCase() === searchText.toLowerCase().trim(), + ) && + !selectedPlaylists.some((p) => p.name === searchText.trim()), ) return ( diff --git a/ui/src/eventStream.test.js b/ui/src/eventStream.test.js index 5bd0dd0be..27f53c872 100644 --- a/ui/src/eventStream.test.js +++ b/ui/src/eventStream.test.js @@ -25,7 +25,7 @@ describe('startEventStream', () => { beforeEach(() => { dispatch = vi.fn() - global.EventSource = vi.fn((url) => { + global.EventSource = vi.fn().mockImplementation(function (url) { instance = new MockEventSource(url) return instance }) diff --git a/ui/src/i18n/en.json b/ui/src/i18n/en.json index 4a9039a67..6c6592178 100644 --- a/ui/src/i18n/en.json +++ b/ui/src/i18n/en.json @@ -10,6 +10,7 @@ "playCount": "Plays", "title": "Title", "artist": "Artist", + "composer": "Composer", "album": "Album", "path": "File path", "libraryName": "Library", @@ -22,6 +23,7 @@ "bitDepth": "Bit depth", "sampleRate": "Sample rate", "channels": "Channels", + "disc": "Disc %{discNumber}", "discSubtitle": "Disc Subtitle", "starred": "Favourite", "comment": "Comment", @@ -46,7 +48,8 @@ "shuffleAll": "Shuffle All", "download": "Download", "playNext": "Play Next", - "info": "Get Info" + "info": "Get Info", + "instantMix": "Instant Mix" } }, "album": { @@ -302,6 +305,8 @@ }, "actions": { "scan": "Scan Library", + "quickScan": "Quick Scan", + "fullScan": "Full Scan", "manageUsers": "Manage User Access", "viewDetails": "View Details" }, @@ -310,6 +315,9 @@ "updated": "Library updated successfully", "deleted": "Library deleted successfully", "scanStarted": "Library scan started", + "quickScanStarted": "Quick scan started", + "fullScanStarted": "Full scan started", + "scanError": "Error starting scan. Check logs", "scanCompleted": "Library scan completed" }, "validation": { @@ -325,6 +333,82 @@ "scanInProgress": "Scan in progress...", "noLibrariesAssigned": "No libraries assigned to this user" } + }, + "plugin": { + "name": "Plugin |||| Plugins", + "fields": { + "id": "ID", + "name": "Name", + "description": "Description", + "version": "Version", + "author": "Author", + "website": "Website", + "permissions": "Permissions", + "enabled": "Enabled", + "status": "Status", + "path": "Path", + "lastError": "Error", + "hasError": "Error", + "updatedAt": "Updated", + "createdAt": "Installed", + "configKey": "Key", + "configValue": "Value", + "allUsers": "Allow all users", + "selectedUsers": "Selected users", + "allLibraries": "Allow all libraries", + "selectedLibraries": "Selected libraries", + "allowWriteAccess": "Allow write access" + }, + "sections": { + "status": "Status", + "info": "Plugin Information", + "configuration": "Configuration", + "manifest": "Manifest", + "usersPermission": "Users Permission", + "libraryPermission": "Library Permission" + }, + "status": { + "enabled": "Enabled", + "disabled": "Disabled" + }, + "actions": { + "enable": "Enable", + "disable": "Disable", + "disabledDueToError": "Fix the error before enabling", + "disabledUsersRequired": "Select users before enabling", + "disabledLibrariesRequired": "Select libraries before enabling", + "addConfig": "Add Configuration", + "rescan": "Rescan" + }, + "notifications": { + "enabled": "Plugin enabled", + "disabled": "Plugin disabled", + "updated": "Plugin updated", + "error": "Error updating plugin" + }, + "validation": { + "invalidJson": "Configuration must be valid JSON" + }, + "messages": { + "configHelp": "Configure the plugin using key-value pairs. Leave empty if the plugin requires no configuration.", + "configValidationError": "Configuration validation failed:", + "schemaRenderError": "Unable to render configuration form. The plugin's schema may be invalid.", + "clickPermissions": "Click a permission for details", + "noConfig": "No configuration set", + "allUsersHelp": "When enabled, the plugin will have access to all users, including those created in the future.", + "noUsers": "No users selected", + "permissionReason": "Reason", + "usersRequired": "This plugin requires access to user information. Select which users the plugin can access, or enable 'Allow all users'.", + "allLibrariesHelp": "When enabled, the plugin will have access to all libraries, including those created in the future.", + "noLibraries": "No libraries selected", + "librariesRequired": "This plugin requires access to library information. Select which libraries the plugin can access, or enable 'Allow all libraries'.", + "allowWriteAccessHelp": "When enabled, the plugin can modify files in the library directories. By default, plugins have read-only access.", + "requiredHosts": "Required hosts" + }, + "placeholders": { + "configKey": "key", + "configValue": "value" + } } }, "ra": { @@ -473,11 +557,18 @@ } }, "message": { + "uploadCover": "Upload Cover", + "removeCover": "Remove Cover", + "coverUploaded": "Cover art updated", + "coverRemoved": "Cover art removed", + "coverUploadError": "Error uploading cover art", + "coverRemoveError": "Error removing cover art", "note": "NOTE", "transcodingDisabled": "Changing the transcoding configuration through the web interface is disabled for security reasons. If you would like to change (edit or add) transcoding options, restart the server with the %{config} configuration option.", "transcodingEnabled": "Navidrome is currently running with %{config}, making it possible to run system commands from the transcoding settings using the web interface. We recommend to disable it for security reasons and only enable it when configuring Transcoding options.", "songsAddedToPlaylist": "Added 1 song to playlist |||| Added %{smart_count} songs to playlist", "noSimilarSongsFound": "No similar songs found", + "startingInstantMix": "Loading Instant Mix...", "noTopSongsFound": "No top songs found", "noPlaylistsAvailable": "None available", "delete_user_title": "Delete user '%{name}'", @@ -591,6 +682,7 @@ "currentValue": "Current Value", "configurationFile": "Configuration File", "exportToml": "Export Configuration (TOML)", + "downloadToml": "Download Configuration (TOML)", "exportSuccess": "Configuration exported to clipboard in TOML format", "exportFailed": "Failed to copy configuration", "devFlagsHeader": "Development Flags (subject to change/removal)", @@ -600,11 +692,12 @@ "activity": { "title": "Activity", "totalScanned": "Total Folders Scanned", - "quickScan": "Quick Scan", - "fullScan": "Full Scan", + "quickScan": "Quick", + "fullScan": "Full", + "selectiveScan": "Selective", "serverUptime": "Server Uptime", "serverDown": "OFFLINE", - "scanType": "Type", + "scanType": "Last Scan", "status": "Scan Error", "elapsedTime": "Elapsed Time" }, diff --git a/ui/src/layout/ActivityPanel.jsx b/ui/src/layout/ActivityPanel.jsx index 18af8dc93..085911ed7 100644 --- a/ui/src/layout/ActivityPanel.jsx +++ b/ui/src/layout/ActivityPanel.jsx @@ -15,7 +15,7 @@ import { Typography, } from '@material-ui/core' import { FiActivity } from 'react-icons/fi' -import { BiError } from 'react-icons/bi' +import { BiError, BiMessageError } from 'react-icons/bi' import { VscSync } from 'react-icons/vsc' import { GiMagnifyingGlass } from 'react-icons/gi' import subsonic from '../subsonic' @@ -28,7 +28,12 @@ import config from '../config' const useStyles = makeStyles((theme) => ({ wrapper: { position: 'relative', - color: (props) => (props.up ? null : 'orange'), + color: (props) => + props.serverDown + ? theme.palette.error.main + : props.hasWarning + ? theme.palette.warning.main + : null, }, progress: { color: theme.palette.primary.light, @@ -75,12 +80,10 @@ const ActivityPanel = () => { scanStatus.scanning, scanStatus.elapsedTime, ) - const [acknowledgedError, setAcknowledgedError] = useState(null) - const isErrorVisible = - scanStatus.error && scanStatus.error !== acknowledgedError - const classes = useStyles({ - up: up && (!scanStatus.error || !isErrorVisible), - }) + // Determine icon state: error (server down), warning (scan error), or normal + const serverDown = !up + const hasWarning = Boolean(scanStatus.error) + const classes = useStyles({ serverDown, hasWarning }) const translate = useTranslate() const notify = useNotify() const [anchorEl, setAnchorEl] = useState(null) @@ -88,13 +91,12 @@ const ActivityPanel = () => { useInitialScanStatus() const handleMenuOpen = (event) => { - if (scanStatus.error) { - setAcknowledgedError(scanStatus.error) - } setAnchorEl(event.currentTarget) } - const handleMenuClose = () => setAnchorEl(null) + const handleMenuClose = () => { + setAnchorEl(null) + } const triggerScan = (full) => () => subsonic.startScan({ fullScan: full }) useEffect(() => { @@ -113,6 +115,9 @@ const ActivityPanel = () => { return translate('activity.fullScan') case 'quick': return translate('activity.quickScan') + case 'full-selective': + case 'quick-selective': + return translate('activity.selectiveScan') default: return '' } @@ -122,8 +127,10 @@ const ActivityPanel = () => { <div className={classes.wrapper}> <Tooltip title={tooltipTitle}> <IconButton className={classes.button} onClick={handleMenuOpen}> - {!up || isErrorVisible ? ( + {serverDown ? ( <BiError data-testid="activity-error-icon" size={'20'} /> + ) : hasWarning ? ( + <BiMessageError data-testid="activity-warning-icon" size={'20'} /> ) : ( <FiActivity data-testid="activity-ok-icon" size={'20'} /> )} @@ -152,7 +159,11 @@ const ActivityPanel = () => { <Box component="span" flex={2}> {translate('activity.serverUptime')}: </Box> - <Box component="span" flex={1}> + <Box + component="span" + flex={1} + className={!up ? classes.error : null} + > {up ? <Uptime /> : translate('activity.serverDown')} </Box> </Box> diff --git a/ui/src/layout/ActivityPanel.test.jsx b/ui/src/layout/ActivityPanel.test.jsx index c506fd08b..3a951df5d 100644 --- a/ui/src/layout/ActivityPanel.test.jsx +++ b/ui/src/layout/ActivityPanel.test.jsx @@ -43,19 +43,47 @@ describe('<ActivityPanel />', () => { }) }) - it('clears the error icon after opening the panel', () => { + it('shows warning icon when server reports a scan error', () => { render( <Provider store={store}> <ActivityPanel /> </Provider>, ) + // Warning icon should be visible when there's a scan error + expect(screen.getByTestId('activity-warning-icon')).toBeInTheDocument() + + // Open the panel - warning icon should still be visible const button = screen.getByRole('button') - expect(screen.getByTestId('activity-error-icon')).toBeInTheDocument() - fireEvent.click(button) - - expect(screen.getByTestId('activity-ok-icon')).toBeInTheDocument() + expect(screen.getByTestId('activity-warning-icon')).toBeInTheDocument() expect(screen.getByText('Scan failed')).toBeInTheDocument() }) + + it('shows error icon when server is down', () => { + const downStore = createStore( + combineReducers({ activity: activityReducer }), + { + activity: { + scanStatus: { + scanning: false, + folderCount: 0, + count: 0, + error: '', + elapsedTime: 0, + }, + serverStart: { version: config.version, startTime: null }, // null startTime = server down + }, + }, + ) + + render( + <Provider store={downStore}> + <ActivityPanel /> + </Provider>, + ) + + // Error icon should be visible when server is down + expect(screen.getByTestId('activity-error-icon')).toBeInTheDocument() + }) }) diff --git a/ui/src/layout/Layout.jsx b/ui/src/layout/Layout.jsx index e3f13d25f..44cf9b42c 100644 --- a/ui/src/layout/Layout.jsx +++ b/ui/src/layout/Layout.jsx @@ -7,6 +7,7 @@ import Menu from './Menu' import AppBar from './AppBar' import Notification from './Notification' import useCurrentTheme from '../themes/useCurrentTheme' +import { useSearchRefocus } from '../common' const useStyles = makeStyles({ root: { paddingBottom: (props) => (props.addPadding ? '80px' : 0) }, @@ -17,6 +18,7 @@ const Layout = (props) => { const queue = useSelector((state) => state.player?.queue) const classes = useStyles({ addPadding: queue.length > 0 }) const dispatch = useDispatch() + useSearchRefocus() const keyHandlers = { TOGGLE_MENU: useCallback(() => dispatch(toggleSidebar()), [dispatch]), diff --git a/ui/src/layout/Login.jsx b/ui/src/layout/Login.jsx index 2244f4dfd..91f56b273 100644 --- a/ui/src/layout/Login.jsx +++ b/ui/src/layout/Login.jsx @@ -136,6 +136,8 @@ const FormLogin = ({ loading, handleSubmit, validate }) => { {config.welcomeMessage && ( <div className={classes.welcome} + // Use dangerouslySetInnerHTML to allow admins to configure + // whatever content they want dangerouslySetInnerHTML={{ __html: config.welcomeMessage }} /> )} diff --git a/ui/src/layout/PlaylistsSubMenu.jsx b/ui/src/layout/PlaylistsSubMenu.jsx index a9f70b875..b94bebf86 100644 --- a/ui/src/layout/PlaylistsSubMenu.jsx +++ b/ui/src/layout/PlaylistsSubMenu.jsx @@ -12,7 +12,7 @@ import QueueMusicOutlinedIcon from '@material-ui/icons/QueueMusicOutlined' import { BiCog } from 'react-icons/bi' import { useDrop } from 'react-dnd' import SubMenu from './SubMenu' -import { canChangeTracks } from '../common' +import { canChangeTracks, OverflowTooltip } from '../common' import { DraggableTypes } from '../consts' import config from '../config' @@ -39,9 +39,11 @@ const PlaylistMenuItemLink = ({ pls, sidebarIsOpen }) => { <MenuItemLink to={`/playlist/${pls.id}/show`} primaryText={ - <Typography variant="inherit" noWrap ref={dropRef}> - {pls.name} - </Typography> + <OverflowTooltip title={pls.name} placement="right"> + <Typography variant="inherit" noWrap ref={dropRef}> + {pls.name} + </Typography> + </OverflowTooltip> } sidebarIsOpen={sidebarIsOpen} dense={false} diff --git a/ui/src/layout/UserMenu.jsx b/ui/src/layout/UserMenu.jsx index c7a3deaf4..e33185578 100644 --- a/ui/src/layout/UserMenu.jsx +++ b/ui/src/layout/UserMenu.jsx @@ -28,6 +28,9 @@ import { useDispatch } from 'react-redux' const useStyles = makeStyles((theme) => ({ user: {}, + button: { + color: 'inherit', + }, avatar: { width: theme.spacing(4), height: theme.spacing(4), @@ -72,12 +75,11 @@ const UserMenu = (props) => { <div className={classes.user}> <Tooltip title={label && translate(label, { _: label })}> <IconButton + className={classes.button} aria-label={label && translate(label, { _: label })} aria-owns={open ? 'menu-appbar' : null} aria-haspopup={true} - color="inherit" onClick={handleMenu} - size={'small'} > {loaded && identity.avatar ? ( <Avatar @@ -120,7 +122,7 @@ const UserMenu = (props) => { }) : null, )} - {!config.auth && logout} + {(!config.auth || !!config.extAuthLogoutURL) && logout} </MenuList> </Popover> </div> diff --git a/ui/src/library/LibraryEdit.jsx b/ui/src/library/LibraryEdit.jsx index 3d981b076..7e89c892c 100644 --- a/ui/src/library/LibraryEdit.jsx +++ b/ui/src/library/LibraryEdit.jsx @@ -169,7 +169,7 @@ const LibraryEdit = (props) => { resource={'library'} source={'totalSize'} label={translate('resources.library.fields.totalSize')} - format={formatBytes} + format={(v) => formatBytes(v, 2)} fullWidth variant="outlined" /> diff --git a/ui/src/library/LibraryList.jsx b/ui/src/library/LibraryList.jsx index c2d2f6295..35d627cbb 100644 --- a/ui/src/library/LibraryList.jsx +++ b/ui/src/library/LibraryList.jsx @@ -9,7 +9,9 @@ import { BooleanField, } from 'react-admin' import { useMediaQuery } from '@material-ui/core' -import { List, DateField, useResourceRefresh } from '../common' +import { List, DateField, useResourceRefresh, SizeField } from '../common' +import LibraryListBulkActions from './LibraryListBulkActions' +import LibraryListActions from './LibraryListActions' const LibraryFilter = (props) => ( <Filter {...props} variant={'outlined'}> @@ -19,6 +21,7 @@ const LibraryFilter = (props) => ( const LibraryList = (props) => { const isXsmall = useMediaQuery((theme) => theme.breakpoints.down('xs')) + const isDesktop = useMediaQuery((theme) => theme.breakpoints.up('lg')) useResourceRefresh('library') return ( @@ -26,8 +29,9 @@ const LibraryList = (props) => { {...props} sort={{ field: 'name', order: 'ASC' }} exporter={false} - bulkActionButtons={false} + bulkActionButtons={!isXsmall && <LibraryListBulkActions />} filters={<LibraryFilter />} + actions={<LibraryListActions />} > {isXsmall ? ( <SimpleList @@ -37,16 +41,13 @@ const LibraryList = (props) => { ) : ( <Datagrid rowClick="edit"> <TextField source="name" /> - <TextField source="path" /> + {isDesktop && <TextField source="path" />} <BooleanField source="defaultNewUsers" /> - <NumberField source="totalSongs" label="Songs" /> - <NumberField source="totalAlbums" label="Albums" /> - <NumberField source="totalMissingFiles" label="Missing Files" /> - <DateField - source="lastScanAt" - label="Last Scan" - sortByOrder={'DESC'} - /> + <NumberField source="totalSongs" /> + <NumberField source="totalAlbums" /> + <NumberField source="totalMissingFiles" /> + <SizeField source="totalSize" /> + <DateField source="lastScanAt" sortByOrder={'DESC'} /> </Datagrid> )} </List> diff --git a/ui/src/library/LibraryListActions.jsx b/ui/src/library/LibraryListActions.jsx new file mode 100644 index 000000000..f4d0913df --- /dev/null +++ b/ui/src/library/LibraryListActions.jsx @@ -0,0 +1,31 @@ +import React, { cloneElement } from 'react' +import { sanitizeListRestProps, TopToolbar, CreateButton } from 'react-admin' +import LibraryScanButton from './LibraryScanButton' + +const LibraryListActions = ({ + className, + filters, + resource, + showFilter, + displayedFilters, + filterValues, + ...rest +}) => { + return ( + <TopToolbar className={className} {...sanitizeListRestProps(rest)}> + {filters && + cloneElement(filters, { + resource, + showFilter, + displayedFilters, + filterValues, + context: 'button', + })} + <LibraryScanButton fullScan={false} /> + <LibraryScanButton fullScan={true} /> + <CreateButton /> + </TopToolbar> + ) +} + +export default LibraryListActions diff --git a/ui/src/library/LibraryListBulkActions.jsx b/ui/src/library/LibraryListBulkActions.jsx new file mode 100644 index 000000000..8862a4f51 --- /dev/null +++ b/ui/src/library/LibraryListBulkActions.jsx @@ -0,0 +1,11 @@ +import React from 'react' +import LibraryScanButton from './LibraryScanButton' + +const LibraryListBulkActions = (props) => ( + <> + <LibraryScanButton fullScan={false} {...props} /> + <LibraryScanButton fullScan={true} {...props} /> + </> +) + +export default LibraryListBulkActions diff --git a/ui/src/library/LibraryScanButton.jsx b/ui/src/library/LibraryScanButton.jsx new file mode 100644 index 000000000..50d90e615 --- /dev/null +++ b/ui/src/library/LibraryScanButton.jsx @@ -0,0 +1,77 @@ +import React, { useState } from 'react' +import PropTypes from 'prop-types' +import { + Button, + useNotify, + useRefresh, + useTranslate, + useUnselectAll, +} from 'react-admin' +import { useSelector } from 'react-redux' +import SyncIcon from '@material-ui/icons/Sync' +import CachedIcon from '@material-ui/icons/Cached' +import subsonic from '../subsonic' + +const LibraryScanButton = ({ fullScan, selectedIds, className }) => { + const [loading, setLoading] = useState(false) + const notify = useNotify() + const refresh = useRefresh() + const translate = useTranslate() + const unselectAll = useUnselectAll() + const scanStatus = useSelector((state) => state.activity.scanStatus) + + const handleClick = async () => { + setLoading(true) + try { + // Build scan options + const options = { fullScan } + + // If specific libraries are selected, scan only those + // Format: "libraryID:" to scan entire library (no folder path specified) + if (selectedIds && selectedIds.length > 0) { + options.target = selectedIds.map((id) => `${id}:`) + } + + await subsonic.startScan(options) + const notificationKey = fullScan + ? 'resources.library.notifications.fullScanStarted' + : 'resources.library.notifications.quickScanStarted' + notify(notificationKey, 'info') + refresh() + + // Unselect all items after successful scan + unselectAll('library') + } catch (error) { + notify('resources.library.notifications.scanError', 'warning') + } finally { + setLoading(false) + } + } + + const isDisabled = loading || scanStatus.scanning + + const label = fullScan + ? translate('resources.library.actions.fullScan') + : translate('resources.library.actions.quickScan') + + const icon = fullScan ? <CachedIcon /> : <SyncIcon /> + + return ( + <Button + onClick={handleClick} + disabled={isDisabled} + label={label} + className={className} + > + {icon} + </Button> + ) +} + +LibraryScanButton.propTypes = { + fullScan: PropTypes.bool.isRequired, + selectedIds: PropTypes.array, + className: PropTypes.string, +} + +export default LibraryScanButton diff --git a/ui/src/missing/MissingListActions.jsx b/ui/src/missing/MissingListActions.jsx index 4bbf77115..fc5c4f7e3 100644 --- a/ui/src/missing/MissingListActions.jsx +++ b/ui/src/missing/MissingListActions.jsx @@ -1,12 +1,15 @@ import React from 'react' -import { TopToolbar, ExportButton } from 'react-admin' +import { TopToolbar, ExportButton, useListContext } from 'react-admin' import DeleteMissingFilesButton from './DeleteMissingFilesButton.jsx' -const MissingListActions = (props) => ( - <TopToolbar {...props}> - <ExportButton /> - <DeleteMissingFilesButton deleteAll /> - </TopToolbar> -) +const MissingListActions = (props) => { + const { total } = useListContext() + return ( + <TopToolbar {...props}> + <ExportButton maxResults={total} /> + <DeleteMissingFilesButton deleteAll /> + </TopToolbar> + ) +} export default MissingListActions diff --git a/ui/src/playlist/PlaylistDetails.jsx b/ui/src/playlist/PlaylistDetails.jsx index acccb15f7..f2f528d4b 100644 --- a/ui/src/playlist/PlaylistDetails.jsx +++ b/ui/src/playlist/PlaylistDetails.jsx @@ -7,10 +7,18 @@ import { } from '@material-ui/core' import { makeStyles } from '@material-ui/core/styles' import { useTranslate } from 'react-admin' -import { useCallback, useState, useEffect } from 'react' import Lightbox from 'react-image-lightbox' import 'react-image-lightbox/style.css' -import { CollapsibleComment, DurationField, SizeField } from '../common' +import { + CollapsibleComment, + DurationField, + ImageUploadOverlay, + SizeField, + isWritable, + OverflowTooltip, + useImageLoadingState, +} from '../common' +import { COVER_ART_SIZE } from '../consts' import subsonic from '../subsonic' const useStyles = makeStyles( @@ -55,6 +63,7 @@ const useStyles = makeStyles( display: 'flex', alignItems: 'center', justifyContent: 'center', + position: 'relative', }, cover: { objectFit: 'contain', @@ -88,37 +97,19 @@ const PlaylistDetails = (props) => { const translate = useTranslate() const classes = useStyles() const isDesktop = useMediaQuery((theme) => theme.breakpoints.up('lg')) - const [isLightboxOpen, setLightboxOpen] = useState(false) - const [imageLoading, setImageLoading] = useState(false) - const [imageError, setImageError] = useState(false) + const { + imageLoading, + imageError, + isLightboxOpen, + handleImageLoad, + handleImageError, + handleOpenLightbox, + handleCloseLightbox, + } = useImageLoadingState(record.id) - const imageUrl = subsonic.getCoverArtUrl(record, 300, true) + const imageUrl = subsonic.getCoverArtUrl(record, COVER_ART_SIZE, true) const fullImageUrl = subsonic.getCoverArtUrl(record) - // Reset image state when playlist changes - useEffect(() => { - setImageLoading(true) - setImageError(false) - }, [record.id]) - - const handleImageLoad = useCallback(() => { - setImageLoading(false) - setImageError(false) - }, []) - - const handleImageError = useCallback(() => { - setImageLoading(false) - setImageError(true) - }, []) - - const handleOpenLightbox = useCallback(() => { - if (!imageError) { - setLightboxOpen(true) - } - }, [imageError]) - - const handleCloseLightbox = useCallback(() => setLightboxOpen(false), []) - return ( <Card className={classes.root}> <div className={classes.cardContents}> @@ -138,15 +129,24 @@ const PlaylistDetails = (props) => { cursor: imageError ? 'default' : 'pointer', }} /> + {isWritable(record.ownerId) && ( + <ImageUploadOverlay + entityType="playlist" + entityId={record.id} + hasUploadedImage={!!record.uploadedImage} + /> + )} </div> <div className={classes.details}> <CardContent className={classes.content}> - <Typography - variant={isDesktop ? 'h5' : 'h6'} - className={classes.title} - > - {record.name || translate('ra.page.loading')} - </Typography> + <OverflowTooltip title={record.name || ''}> + <Typography + variant={isDesktop ? 'h5' : 'h6'} + className={classes.title} + > + {record.name || translate('ra.page.loading')} + </Typography> + </OverflowTooltip> <Typography component="p" className={classes.stats}> {record.songCount ? ( <span> diff --git a/ui/src/playlist/PlaylistEdit.jsx b/ui/src/playlist/PlaylistEdit.jsx index f8cee9b5f..f6882e366 100644 --- a/ui/src/playlist/PlaylistEdit.jsx +++ b/ui/src/playlist/PlaylistEdit.jsx @@ -34,7 +34,15 @@ const PlaylistEditForm = (props) => { return ( <SimpleForm redirect="list" variant={'outlined'} {...props}> <TextInput source="name" validate={required()} /> - <TextInput multiline source="comment" /> + <TextInput + multiline + minRows={3} + source="comment" + fullWidth + inputProps={{ + style: { resize: 'vertical' }, + }} + /> {permissions === 'admin' ? ( <ReferenceInput source="ownerId" diff --git a/ui/src/playlist/PlaylistList.jsx b/ui/src/playlist/PlaylistList.jsx index 920b3ebe5..8732725bc 100644 --- a/ui/src/playlist/PlaylistList.jsx +++ b/ui/src/playlist/PlaylistList.jsx @@ -16,8 +16,10 @@ import { usePermissions, } from 'react-admin' import Switch from '@material-ui/core/Switch' +import { makeStyles } from '@material-ui/core/styles' import { useMediaQuery } from '@material-ui/core' import { + CoverArtAvatar, DurationField, List, Writable, @@ -28,6 +30,12 @@ import { import PlaylistListActions from './PlaylistListActions' import ChangePublicStatusButton from './ChangePublicStatusButton' +const useStyles = makeStyles((theme) => ({ + button: { + color: theme.palette.type === 'dark' ? 'white' : undefined, + }, +})) + const PlaylistFilter = (props) => { const { permissions } = usePermissions() return ( @@ -112,13 +120,24 @@ const ToggleAutoImport = ({ resource, source }) => { ) : null } -const PlaylistListBulkActions = (props) => ( - <> - <ChangePublicStatusButton public={true} {...props} /> - <ChangePublicStatusButton public={false} {...props} /> - <BulkDeleteButton {...props} /> - </> -) +const PlaylistListBulkActions = (props) => { + const classes = useStyles() + return ( + <> + <ChangePublicStatusButton + public={true} + {...props} + className={classes.button} + /> + <ChangePublicStatusButton + public={false} + {...props} + className={classes.button} + /> + <BulkDeleteButton {...props} className={classes.button} /> + </> + ) +} const PlaylistList = (props) => { const isXsmall = useMediaQuery((theme) => theme.breakpoints.down('xs')) @@ -137,7 +156,9 @@ const PlaylistList = (props) => { <TogglePublicInput source="public" sortByOrder={'DESC'} /> ), comment: <TextField source="comment" />, - sync: <ToggleAutoImport source="sync" sortByOrder={'DESC'} />, + sync: !isXsmall && ( + <ToggleAutoImport source="sync" sortByOrder={'DESC'} /> + ), }), [isDesktop, isXsmall], ) @@ -152,11 +173,13 @@ const PlaylistList = (props) => { <List {...props} exporter={false} + sort={{ field: 'name', order: 'ASC' }} filters={<PlaylistFilter />} actions={<PlaylistListActions />} bulkActionButtons={!isXsmall && <PlaylistListBulkActions />} > <Datagrid rowClick="show" isRowSelectable={(r) => isWritable(r?.ownerId)}> + <CoverArtAvatar source="id" variant="square" /> <TextField source="name" /> {columns} <Writable> diff --git a/ui/src/plugin/ConfigCard.jsx b/ui/src/plugin/ConfigCard.jsx new file mode 100644 index 000000000..d9815aa3e --- /dev/null +++ b/ui/src/plugin/ConfigCard.jsx @@ -0,0 +1,123 @@ +import React, { useCallback, useState, useMemo } from 'react' +import PropTypes from 'prop-types' +import { Card, CardContent, Typography, Box } from '@material-ui/core' +import Alert from '@material-ui/lab/Alert' +import { SchemaConfigEditor } from './SchemaConfigEditor' + +// Format error with field title and full path for nested fields +const formatError = (error, schema) => { + // Get path parts from various error formats + const rawPath = + error.dataPath || error.property || error.instancePath?.replace(/\//g, '.') + const parts = rawPath?.split('.').filter(Boolean) || [] + + // Navigate schema to find field title, build bracket-notation path + let currentSchema = schema + let fieldName = parts[parts.length - 1] + const pathParts = [] + + for (const part of parts) { + if (/^\d+$/.test(part)) { + pathParts.push(`[${part}]`) + currentSchema = currentSchema?.items + } else { + fieldName = currentSchema?.properties?.[part]?.title || part + pathParts.push(part) + currentSchema = currentSchema?.properties?.[part] + } + } + + const path = pathParts.join('.').replace(/\.\[/g, '[') + const isNested = path.includes('[') || path.includes('.') + // Replace property name in message with full path for nested fields + const message = isNested + ? error.message.replace(/'[^']+'\s*$/, `'${path}'`) + : error.message + + return { fieldName, message } +} + +export const ConfigCard = ({ + manifest, + configData, + onConfigDataChange, + classes, + translate, +}) => { + const [validationErrors, setValidationErrors] = useState([]) + + // Handle changes from JSONForms + const handleChange = useCallback( + (newData, errors) => { + setValidationErrors(errors || []) + onConfigDataChange(newData, errors) + }, + [onConfigDataChange], + ) + + // Only show config card if manifest has config schema defined + const hasConfigSchema = manifest?.config?.schema + + // Format validation errors with proper field names + const formattedErrors = useMemo(() => { + if (!hasConfigSchema) return [] + return validationErrors.map((error) => + formatError(error, manifest.config.schema), + ) + }, [validationErrors, manifest, hasConfigSchema]) + + if (!hasConfigSchema) { + return null + } + + const { schema, uiSchema } = manifest.config + + return ( + <Card className={classes.section}> + <CardContent> + <Typography variant="h6" className={classes.sectionTitle}> + {translate('resources.plugin.sections.configuration')} + </Typography> + + {formattedErrors.length > 0 && ( + <Box mb={2}> + <Alert severity="error"> + {translate('resources.plugin.messages.configValidationError')} + <ul style={{ margin: '8px 0 0', paddingLeft: 20 }}> + {formattedErrors.map((error, index) => ( + <li key={index}> + {error.fieldName && <strong>{error.fieldName}</strong>} + {error.fieldName && ': '} + {error.message} + </li> + ))} + </ul> + </Alert> + </Box> + )} + + <Box mt={formattedErrors.length > 0 ? 0 : 2}> + <SchemaConfigEditor + schema={schema} + uiSchema={uiSchema} + data={configData} + onChange={handleChange} + /> + </Box> + </CardContent> + </Card> + ) +} + +ConfigCard.propTypes = { + manifest: PropTypes.shape({ + config: PropTypes.shape({ + schema: PropTypes.object, + uiSchema: PropTypes.object, + }), + }), + configData: PropTypes.object, + onConfigDataChange: PropTypes.func.isRequired, + classes: PropTypes.object.isRequired, + translate: PropTypes.func.isRequired, +} diff --git a/ui/src/plugin/ErrorSection.jsx b/ui/src/plugin/ErrorSection.jsx new file mode 100644 index 000000000..61c048e2a --- /dev/null +++ b/ui/src/plugin/ErrorSection.jsx @@ -0,0 +1,16 @@ +import React from 'react' +import { Typography } from '@material-ui/core' +import Alert from '@material-ui/lab/Alert' + +export const ErrorSection = ({ error, translate }) => { + if (!error) return null + + return ( + <Alert severity="error" style={{ marginBottom: 16 }}> + <Typography variant="subtitle2"> + {translate('resources.plugin.fields.lastError')} + </Typography> + <Typography variant="body2">{error}</Typography> + </Alert> + ) +} diff --git a/ui/src/plugin/InfoCard.jsx b/ui/src/plugin/InfoCard.jsx new file mode 100644 index 000000000..8fb6853fe --- /dev/null +++ b/ui/src/plugin/InfoCard.jsx @@ -0,0 +1,237 @@ +import React, { useState } from 'react' +import { + Card, + CardContent, + Typography, + Grid, + Box, + Chip, + Tooltip, + Link, + ClickAwayListener, +} from '@material-ui/core' +import { useTranslate } from 'react-admin' +import { DateField } from '../common' + +// Helper component for permission chips with clickable persistent tooltips +const PermissionChip = ({ label, permission, classes }) => { + const [open, setOpen] = useState(false) + const translate = useTranslate() + + if (!permission) return null + + const hasHosts = permission.requiredHosts?.length > 0 + const hasTooltip = permission.reason || hasHosts + + const handleClick = () => { + if (hasTooltip) { + setOpen((prev) => !prev) + } + } + + const handleClose = () => { + setOpen(false) + } + + const tooltipContent = ( + <Box className={classes.tooltipContent}> + {permission.reason && ( + <Typography variant="body2">{permission.reason}</Typography> + )} + {hasHosts && ( + <Box mt={permission.reason ? 0.5 : 0}> + <Typography variant="caption" component="div"> + {translate('resources.plugin.messages.requiredHosts')}:{' '} + {permission.requiredHosts.map((host, i) => ( + <span key={host}> + {i > 0 && ', '} + <code>{host}</code> + </span> + ))} + </Typography> + </Box> + )} + </Box> + ) + + const chip = ( + <Chip + size="small" + label={label} + className={classes.permissionChip} + onClick={hasTooltip ? handleClick : undefined} + clickable={hasTooltip} + /> + ) + + if (!hasTooltip) { + return chip + } + + return ( + <ClickAwayListener onClickAway={handleClose}> + <div> + <Tooltip + title={tooltipContent} + arrow + open={open} + disableFocusListener + disableHoverListener + disableTouchListener + PopperProps={{ + disablePortal: true, + }} + > + {chip} + </Tooltip> + </div> + </ClickAwayListener> + ) +} + +// Info row component for responsive grid +const InfoRow = ({ label, children, classes, isSmall }) => ( + <> + <Grid item xs={12} sm={3}> + <Typography + variant="body2" + className={classes.infoLabel} + component={isSmall ? 'div' : 'span'} + > + {label} + </Typography> + </Grid> + <Grid item xs={12} sm={9}> + <Typography variant="body2" component="div"> + {children} + </Typography> + </Grid> + </> +) + +// Plugin information card +export const InfoCard = ({ record, manifest, classes, translate, isSmall }) => ( + <Card className={classes.section}> + <CardContent> + <Typography variant="h6" className={classes.sectionTitle}> + {translate('resources.plugin.sections.info')} + </Typography> + <Grid container spacing={1} className={classes.infoGrid}> + <InfoRow + label={translate('resources.plugin.fields.id')} + classes={classes} + isSmall={isSmall} + > + {record.id} + </InfoRow> + + {manifest?.name && ( + <InfoRow + label={translate('resources.plugin.fields.name')} + classes={classes} + isSmall={isSmall} + > + {manifest.name} + </InfoRow> + )} + + {manifest?.version && ( + <InfoRow + label={translate('resources.plugin.fields.version')} + classes={classes} + isSmall={isSmall} + > + {manifest.version} + </InfoRow> + )} + + {manifest?.description && ( + <InfoRow + label={translate('resources.plugin.fields.description')} + classes={classes} + isSmall={isSmall} + > + {manifest.description} + </InfoRow> + )} + + {manifest?.author && ( + <InfoRow + label={translate('resources.plugin.fields.author')} + classes={classes} + isSmall={isSmall} + > + {manifest.author} + </InfoRow> + )} + + {manifest?.website && ( + <InfoRow + label={translate('resources.plugin.fields.website')} + classes={classes} + isSmall={isSmall} + > + <Link + href={manifest.website} + target="_blank" + rel="noopener noreferrer" + > + {manifest.website} + </Link> + </InfoRow> + )} + + {manifest?.permissions && + Object.keys(manifest.permissions).length > 0 && ( + <InfoRow + label={translate('resources.plugin.fields.permissions')} + classes={classes} + isSmall={isSmall} + > + <Box className={classes.permissionsContainer}> + {Object.entries(manifest.permissions).map(([key, value]) => ( + <PermissionChip + key={key} + label={key} + permission={value} + classes={classes} + /> + ))} + </Box> + <Typography + variant="caption" + color="textSecondary" + style={{ marginTop: 4, display: 'block' }} + > + {translate('resources.plugin.messages.clickPermissions')} + </Typography> + </InfoRow> + )} + + <InfoRow + label={translate('resources.plugin.fields.path')} + classes={classes} + isSmall={isSmall} + > + <span className={classes.pathField}>{record.path}</span> + </InfoRow> + + <InfoRow + label={translate('resources.plugin.fields.updatedAt')} + classes={classes} + isSmall={isSmall} + > + <DateField record={record} source="updatedAt" showTime /> + </InfoRow> + + <InfoRow + label={translate('resources.plugin.fields.createdAt')} + classes={classes} + isSmall={isSmall} + > + <DateField record={record} source="createdAt" showTime /> + </InfoRow> + </Grid> + </CardContent> + </Card> +) diff --git a/ui/src/plugin/LibraryPermissionCard.jsx b/ui/src/plugin/LibraryPermissionCard.jsx new file mode 100644 index 000000000..d3c237279 --- /dev/null +++ b/ui/src/plugin/LibraryPermissionCard.jsx @@ -0,0 +1,201 @@ +import React from 'react' +import { + Card, + CardContent, + Typography, + Box, + FormControlLabel, + Switch, + List, + ListItem, + ListItemIcon, + ListItemText, + Checkbox, +} from '@material-ui/core' +import CheckBoxIcon from '@material-ui/icons/CheckBox' +import CheckBoxOutlineBlankIcon from '@material-ui/icons/CheckBoxOutlineBlank' +import Alert from '@material-ui/lab/Alert' +import { useGetList, useTranslate } from 'react-admin' +import PropTypes from 'prop-types' + +export const LibraryPermissionCard = ({ + manifest, + classes, + selectedLibraries, + allLibraries, + allowWriteAccess, + onSelectedLibrariesChange, + onAllLibrariesChange, + onAllowWriteAccessChange, +}) => { + const translate = useTranslate() + + // Fetch all libraries + const { data: librariesData, loading: librariesLoading } = useGetList( + 'library', + { + pagination: { page: 1, perPage: 1000 }, + sort: { field: 'name', order: 'ASC' }, + }, + ) + + const libraries = React.useMemo(() => { + return librariesData ? Object.values(librariesData) : [] + }, [librariesData]) + + const handleToggleLibrary = React.useCallback( + (libraryId) => { + const newSelected = selectedLibraries.includes(libraryId) + ? selectedLibraries.filter((id) => id !== libraryId) + : [...selectedLibraries, libraryId] + onSelectedLibrariesChange(newSelected) + }, + [selectedLibraries, onSelectedLibrariesChange], + ) + + const handleAllLibrariesToggle = React.useCallback( + (event) => { + onAllLibrariesChange(event.target.checked) + }, + [onAllLibrariesChange], + ) + + const handleAllowWriteAccessToggle = React.useCallback( + (event) => { + onAllowWriteAccessChange(event.target.checked) + }, + [onAllowWriteAccessChange], + ) + + // Get permission reason from manifest + const libraryPermission = manifest?.permissions?.library + const reason = libraryPermission?.reason + const hasFilesystem = libraryPermission?.filesystem === true + + // Check if permission is required but not configured + const isConfigurationRequired = + libraryPermission && !allLibraries && selectedLibraries.length === 0 + + if (!libraryPermission) { + return null + } + + return ( + <Card className={classes.section}> + <CardContent> + <Typography variant="h6" className={classes.sectionTitle}> + {translate('resources.plugin.sections.libraryPermission')} + </Typography> + + {reason && ( + <Typography variant="body2" color="textSecondary" gutterBottom> + {translate('resources.plugin.messages.permissionReason')}: {reason} + </Typography> + )} + + {isConfigurationRequired && ( + <Box mb={2}> + <Alert severity="warning"> + {translate('resources.plugin.messages.librariesRequired')} + </Alert> + </Box> + )} + + <Box mb={2}> + <FormControlLabel + control={ + <Switch + checked={allLibraries} + onChange={handleAllLibrariesToggle} + color="primary" + /> + } + label={translate('resources.plugin.fields.allLibraries')} + /> + <Typography variant="body2" color="textSecondary"> + {translate('resources.plugin.messages.allLibrariesHelp')} + </Typography> + </Box> + + {hasFilesystem && ( + <Box mb={2}> + <FormControlLabel + control={ + <Switch + checked={allowWriteAccess} + onChange={handleAllowWriteAccessToggle} + color="primary" + /> + } + label={translate('resources.plugin.fields.allowWriteAccess')} + /> + <Typography variant="body2" color="textSecondary"> + {translate('resources.plugin.messages.allowWriteAccessHelp')} + </Typography> + </Box> + )} + + {!allLibraries && ( + <Box className={classes.usersList}> + <Typography variant="subtitle2" gutterBottom> + {translate('resources.plugin.fields.selectedLibraries')} + </Typography> + {librariesLoading ? ( + <Typography variant="body2" color="textSecondary"> + {translate('ra.message.loading')} + </Typography> + ) : libraries.length === 0 ? ( + <Typography variant="body2" color="textSecondary"> + {translate('resources.plugin.messages.noLibraries')} + </Typography> + ) : ( + <List + dense + style={{ + maxHeight: 200, + overflow: 'auto', + border: '1px solid rgba(0, 0, 0, 0.12)', + borderRadius: 4, + }} + > + {libraries.map((library) => ( + <ListItem + key={library.id} + button + onClick={() => handleToggleLibrary(library.id)} + dense + > + <ListItemIcon> + <Checkbox + icon={<CheckBoxOutlineBlankIcon fontSize="small" />} + checkedIcon={<CheckBoxIcon fontSize="small" />} + checked={selectedLibraries.includes(library.id)} + tabIndex={-1} + disableRipple + /> + </ListItemIcon> + <ListItemText + primary={library.name} + secondary={library.path} + /> + </ListItem> + ))} + </List> + )} + </Box> + )} + </CardContent> + </Card> + ) +} + +LibraryPermissionCard.propTypes = { + manifest: PropTypes.object, + classes: PropTypes.object.isRequired, + selectedLibraries: PropTypes.array.isRequired, + allLibraries: PropTypes.bool.isRequired, + allowWriteAccess: PropTypes.bool.isRequired, + onSelectedLibrariesChange: PropTypes.func.isRequired, + onAllLibrariesChange: PropTypes.func.isRequired, + onAllowWriteAccessChange: PropTypes.func.isRequired, +} diff --git a/ui/src/plugin/ManifestSection.jsx b/ui/src/plugin/ManifestSection.jsx new file mode 100644 index 000000000..3fef65f70 --- /dev/null +++ b/ui/src/plugin/ManifestSection.jsx @@ -0,0 +1,24 @@ +import React from 'react' +import { + Accordion, + AccordionSummary, + AccordionDetails, + Typography, + Box, +} from '@material-ui/core' +import { MdExpandMore } from 'react-icons/md' + +export const ManifestSection = ({ manifestJson, classes, translate }) => ( + <Accordion className={classes.section}> + <AccordionSummary expandIcon={<MdExpandMore />}> + <Typography variant="h6"> + {translate('resources.plugin.sections.manifest')} + </Typography> + </AccordionSummary> + <AccordionDetails> + <Box className={classes.manifestBox} width="100%"> + {manifestJson} + </Box> + </AccordionDetails> + </Accordion> +) diff --git a/ui/src/plugin/OutlinedRenderers.jsx b/ui/src/plugin/OutlinedRenderers.jsx new file mode 100644 index 000000000..8020a5e4f --- /dev/null +++ b/ui/src/plugin/OutlinedRenderers.jsx @@ -0,0 +1,266 @@ +/* eslint-disable react-refresh/only-export-components */ +import React, { useState } from 'react' +import { + rankWith, + isStringControl, + isIntegerControl, + isNumberControl, + isEnumControl, + isOneOfEnumControl, + and, + not, + or, + optionIs, + isDescriptionHidden, +} from '@jsonforms/core' +import { + withJsonFormsControlProps, + withJsonFormsEnumProps, + withJsonFormsOneOfEnumProps, +} from '@jsonforms/react' +import { + TextField, + FormControl, + FormHelperText, + InputLabel, + Select, + MenuItem, +} from '@material-ui/core' +import { makeStyles } from '@material-ui/core/styles' +import merge from 'lodash/merge' + +const useStyles = makeStyles( + (theme) => ({ + control: { + marginBottom: theme.spacing(2), + }, + }), + { name: 'NDOutlinedRenderers' }, +) + +/** + * Hook for common control state (focus, validation, description visibility) + */ +const useControlState = (props) => { + const { config, uischema, description, visible, errors } = props + const [isFocused, setIsFocused] = useState(false) + + const appliedUiSchemaOptions = merge({}, config, uischema?.options) + // errors is a string when there are validation errors, empty/undefined when valid + const showError = errors && errors.length > 0 + + const showDescription = !isDescriptionHidden( + visible, + description, + isFocused, + appliedUiSchemaOptions.showUnfocusedDescription, + ) + + const helperText = showError ? errors : showDescription ? description : '' + + const handleFocus = () => setIsFocused(true) + const handleBlur = () => setIsFocused(false) + + return { + isFocused, + appliedUiSchemaOptions, + showError, + helperText, + handleFocus, + handleBlur, + } +} + +/** + * Base outlined control component that uses TextField with outlined variant + * instead of the default Input component used by JSONForms 2.x + */ +const OutlinedControl = (props) => { + const classes = useStyles() + const { + data, + id, + enabled, + label, + visible, + type = 'text', + inputProps: extraInputProps = {}, + onChange, + } = props + + const { + appliedUiSchemaOptions, + showError, + helperText, + handleFocus, + handleBlur, + } = useControlState(props) + + if (!visible) { + return null + } + + return ( + <TextField + id={id} + label={label} + type={type} + value={data ?? ''} + onChange={onChange} + onFocus={handleFocus} + onBlur={handleBlur} + disabled={!enabled} + autoFocus={appliedUiSchemaOptions.focus} + multiline={type === 'text' && appliedUiSchemaOptions.multi} + rows={appliedUiSchemaOptions.multi ? 3 : undefined} + variant="outlined" + fullWidth + size="small" + error={showError} + helperText={helperText} + inputProps={extraInputProps} + className={classes.control} + /> + ) +} + +// Text control wrapper +const OutlinedTextControl = (props) => { + const { path, handleChange, schema, config, uischema } = props + const appliedUiSchemaOptions = merge({}, config, uischema?.options) + + const inputProps = {} + if (appliedUiSchemaOptions.restrict && schema?.maxLength) { + inputProps.maxLength = schema.maxLength + } + + return ( + <OutlinedControl + {...props} + type={appliedUiSchemaOptions.format === 'password' ? 'password' : 'text'} + inputProps={inputProps} + onChange={(ev) => handleChange(path, ev.target.value)} + /> + ) +} + +// Number control wrapper +const OutlinedNumberControl = (props) => { + const { path, handleChange, schema } = props + const { minimum, maximum } = schema || {} + + const inputProps = {} + if (minimum !== undefined) inputProps.min = minimum + if (maximum !== undefined) inputProps.max = maximum + + const handleNumberChange = (ev) => { + const value = ev.target.value + if (value === '') { + handleChange(path, undefined) + } else { + const numValue = Number(value) + if (!isNaN(numValue)) { + handleChange(path, numValue) + } + } + } + + return ( + <OutlinedControl + {...props} + type="number" + inputProps={inputProps} + onChange={handleNumberChange} + /> + ) +} + +// Enum/Select control wrapper +const OutlinedEnumControl = (props) => { + const classes = useStyles() + const { + data, + id, + enabled, + path, + handleChange, + options, + label, + visible, + required, + } = props + const { + appliedUiSchemaOptions, + showError, + helperText, + handleFocus, + handleBlur, + } = useControlState(props) + + if (!visible) { + return null + } + + return ( + <FormControl + fullWidth + variant="outlined" + size="small" + error={showError} + className={classes.control} + > + <InputLabel id={`${id}-label`}>{label}</InputLabel> + <Select + labelId={`${id}-label`} + id={id} + value={data ?? ''} + onChange={(ev) => { + handleChange( + path, + ev.target.value === '' ? undefined : ev.target.value, + ) + }} + onFocus={handleFocus} + onBlur={handleBlur} + disabled={!enabled} + autoFocus={appliedUiSchemaOptions.focus} + label={label} + fullWidth + > + {!required && ( + <MenuItem value=""> + <em>None</em> + </MenuItem> + )} + {options?.map((option) => ( + <MenuItem key={option.value} value={option.value}> + {option.label} + </MenuItem> + ))} + </Select> + {helperText && <FormHelperText>{helperText}</FormHelperText>} + </FormControl> + ) +} + +// Testers - higher rank than default to override default renderers +// Enum renderers have highest rank since isStringControl also matches enum fields +export const OutlinedEnumRenderer = { + tester: rankWith(5, isEnumControl), + renderer: withJsonFormsEnumProps(OutlinedEnumControl), +} + +export const OutlinedOneOfEnumRenderer = { + tester: rankWith(5, isOneOfEnumControl), + renderer: withJsonFormsOneOfEnumProps(OutlinedEnumControl), +} + +export const OutlinedTextRenderer = { + tester: rankWith(3, and(isStringControl, not(optionIs('format', 'radio')))), + renderer: withJsonFormsControlProps(OutlinedTextControl), +} + +export const OutlinedNumberRenderer = { + tester: rankWith(3, or(isIntegerControl, isNumberControl)), + renderer: withJsonFormsControlProps(OutlinedNumberControl), +} diff --git a/ui/src/plugin/PluginList.jsx b/ui/src/plugin/PluginList.jsx new file mode 100644 index 000000000..67af85b81 --- /dev/null +++ b/ui/src/plugin/PluginList.jsx @@ -0,0 +1,154 @@ +import React, { useMemo, useState, useCallback } from 'react' +import { + Button, + Datagrid, + TextField, + TopToolbar, + useNotify, + useRecordContext, + useRefresh, + useTranslate, +} from 'react-admin' +import { makeStyles } from '@material-ui/core/styles' +import { useMediaQuery, Tooltip, Chip, Typography } from '@material-ui/core' +import { MdError, MdRefresh } from 'react-icons/md' +import { List, DateField, SimpleList, useResourceRefresh } from '../common' +import { httpClient } from '../dataProvider' +import ToggleEnabledSwitch from './ToggleEnabledSwitch' + +const useStyles = makeStyles((theme) => ({ + errorIcon: { + color: theme.palette.error.main, + marginRight: theme.spacing(0.5), + verticalAlign: 'middle', + }, + errorChip: { + backgroundColor: theme.palette.error.light, + color: theme.palette.error.contrastText, + }, +})) + +const useManifest = () => { + const record = useRecordContext() + return useMemo(() => { + if (!record?.manifest) return null + try { + return JSON.parse(record.manifest) + } catch { + return null + } + }, [record?.manifest]) +} + +const EnabledOrErrorField = () => { + const record = useRecordContext() + const translate = useTranslate() + const classes = useStyles() + const manifest = useManifest() + + if (record.lastError) { + return ( + <Tooltip title={record.lastError}> + <Chip + size="small" + icon={<MdError className={classes.errorIcon} />} + label={translate('resources.plugin.fields.hasError')} + className={classes.errorChip} + /> + </Tooltip> + ) + } + + return <ToggleEnabledSwitch source={'enabled'} manifest={manifest} /> +} + +const ManifestField = ({ source }) => { + const manifest = useManifest() + + if (!manifest) { + return <Typography variant="body2">-</Typography> + } + + return <Typography variant="body2">{manifest[source] || '-'}</Typography> +} + +const PluginListActions = () => { + const translate = useTranslate() + const notify = useNotify() + const refresh = useRefresh() + const [loading, setLoading] = useState(false) + + const handleRescan = useCallback(() => { + setLoading(true) + httpClient('/api/plugin/rescan', { method: 'POST' }) + .then(() => { + refresh() + }) + .catch((error) => { + notify(error.message || 'ra.page.error', { type: 'warning' }) + }) + .finally(() => { + setLoading(false) + }) + }, [notify, refresh]) + + return ( + <TopToolbar> + <Button + onClick={handleRescan} + disabled={loading} + label={translate('resources.plugin.actions.rescan')} + data-testid="rescan-button" + > + <MdRefresh /> + </Button> + </TopToolbar> + ) +} + +const PluginList = (props) => { + const isXsmall = useMediaQuery((theme) => theme.breakpoints.down('xs')) + const translate = useTranslate() + useResourceRefresh('plugin') + + return ( + <List + {...props} + sort={{ field: 'id', order: 'ASC' }} + exporter={false} + bulkActionButtons={false} + actions={<PluginListActions />} + > + {isXsmall ? ( + <SimpleList + primaryText={(record) => record.id} + secondaryText={(record) => { + try { + const manifest = JSON.parse(record.manifest) + return manifest.description || '' + } catch { + return '' + } + }} + tertiaryText={(record) => + record.enabled + ? translate('resources.plugin.status.enabled') + : translate('resources.plugin.status.disabled') + } + linkType="show" + /> + ) : ( + <Datagrid rowClick="show"> + <TextField source="id" /> + <ManifestField source="name" /> + {!isXsmall && <ManifestField source="description" />} + <ManifestField source="version" /> + <EnabledOrErrorField source={'enabled'} /> + <DateField source="updatedAt" sortByOrder={'DESC'} /> + </Datagrid> + )} + </List> + ) +} + +export default PluginList diff --git a/ui/src/plugin/PluginList.test.jsx b/ui/src/plugin/PluginList.test.jsx new file mode 100644 index 000000000..0ed41b98c --- /dev/null +++ b/ui/src/plugin/PluginList.test.jsx @@ -0,0 +1,140 @@ +import React from 'react' +import { render, screen, fireEvent, waitFor } from '@testing-library/react' +import { describe, it, expect, vi, beforeEach } from 'vitest' + +const mockNotify = vi.fn() +const mockRefresh = vi.fn() + +// Mock react-admin hooks +vi.mock('react-admin', async () => { + const actual = await vi.importActual('react-admin') + return { + ...actual, + useUpdate: vi.fn(() => [vi.fn(), { loading: false }]), + useNotify: vi.fn(() => mockNotify), + useRefresh: vi.fn(() => mockRefresh), + useTranslate: vi.fn(() => (key) => key), + useResourceContext: vi.fn(() => 'plugin'), + useRecordContext: vi.fn(() => ({ + id: 'test-plugin', + manifest: JSON.stringify({ + name: 'Test Plugin', + version: '1.0.0', + description: 'Test plugin', + }), + enabled: true, + lastError: null, + })), + Button: ({ onClick, disabled, label, children }) => ( + <button onClick={onClick} disabled={disabled} data-testid="rescan-button"> + {children} + {label} + </button> + ), + TopToolbar: ({ children }) => ( + <div data-testid="top-toolbar">{children}</div> + ), + Datagrid: ({ children }) => <div data-testid="datagrid">{children}</div>, + TextField: ({ source }) => <span data-testid={`text-${source}`} />, + } +}) + +// Mock common components +vi.mock('../common', async () => { + return { + List: ({ children, actions, ...props }) => ( + <div data-testid="list"> + {actions} + {children} + </div> + ), + DateField: ({ source }) => <span data-testid={`date-${source}`} />, + SimpleList: ({ primaryText, secondaryText }) => ( + <div data-testid="simple-list" /> + ), + useResourceRefresh: vi.fn(), + } +}) + +// Mock Material-UI +vi.mock('@material-ui/core', async () => { + const actual = await vi.importActual('@material-ui/core') + return { + ...actual, + useMediaQuery: vi.fn(() => false), + } +}) + +// Mock ToggleEnabledSwitch +vi.mock('./ToggleEnabledSwitch', () => ({ + default: () => <span data-testid="toggle-switch" />, +})) + +// Mock httpClient +const mockHttpClient = vi.fn() +vi.mock('../dataProvider', () => ({ + httpClient: (...args) => mockHttpClient(...args), +})) + +import PluginList from './PluginList' + +describe('PluginList', () => { + beforeEach(() => { + vi.clearAllMocks() + mockHttpClient.mockResolvedValue({}) + }) + + it('renders the list component', () => { + render(<PluginList />) + expect(screen.getByTestId('list')).toBeInTheDocument() + }) + + it('renders the datagrid on desktop', () => { + render(<PluginList />) + expect(screen.getByTestId('datagrid')).toBeInTheDocument() + }) + + it('renders the rescan button', () => { + render(<PluginList />) + expect(screen.getByTestId('rescan-button')).toBeInTheDocument() + }) + + it('calls rescan endpoint when rescan button is clicked', async () => { + render(<PluginList />) + const rescanButton = screen.getByTestId('rescan-button') + + fireEvent.click(rescanButton) + + await waitFor(() => { + expect(mockHttpClient).toHaveBeenCalledWith('/api/plugin/rescan', { + method: 'POST', + }) + }) + }) + + it('calls refresh after successful rescan', async () => { + render(<PluginList />) + const rescanButton = screen.getByTestId('rescan-button') + + fireEvent.click(rescanButton) + + await waitFor(() => { + expect(mockRefresh).toHaveBeenCalled() + }) + }) + + it('shows error notification on rescan failure', async () => { + mockHttpClient.mockRejectedValue(new Error('Network error')) + + render(<PluginList />) + const rescanButton = screen.getByTestId('rescan-button') + + fireEvent.click(rescanButton) + + await waitFor(() => { + expect(mockNotify).toHaveBeenCalledWith('Network error', { + type: 'warning', + }) + }) + }) +}) diff --git a/ui/src/plugin/PluginShow.jsx b/ui/src/plugin/PluginShow.jsx new file mode 100644 index 000000000..caea44a75 --- /dev/null +++ b/ui/src/plugin/PluginShow.jsx @@ -0,0 +1,350 @@ +import React, { useState, useCallback, useMemo } from 'react' +import { + ShowContextProvider, + useShowController, + useShowContext, + useTranslate, + useUpdate, + useNotify, + useRefresh, + Title as RaTitle, + Loading, +} from 'react-admin' +import { Box, useMediaQuery, Button } from '@material-ui/core' +import { MdSave } from 'react-icons/md' +import Alert from '@material-ui/lab/Alert' +import { Title, useResourceRefresh } from '../common' +import { usePluginShowStyles } from './styles.js' +import { ErrorSection } from './ErrorSection' +import { StatusCard } from './StatusCard' +import { InfoCard } from './InfoCard' +import { ManifestSection } from './ManifestSection' +import { ConfigCard } from './ConfigCard' +import { UsersPermissionCard } from './UsersPermissionCard' +import { LibraryPermissionCard } from './LibraryPermissionCard' + +// Main show layout component +const PluginShowLayout = () => { + const { record, isPending, error } = useShowContext() + const classes = usePluginShowStyles() + const translate = useTranslate() + const notify = useNotify() + const refresh = useRefresh() + const isSmall = useMediaQuery((theme) => theme.breakpoints.down('xs')) + useResourceRefresh('plugin') + + const [configData, setConfigData] = useState({}) + const [configErrors, setConfigErrors] = useState([]) + const [isDirty, setIsDirty] = useState(false) + const [lastRecordConfig, setLastRecordConfig] = useState(null) + const [isConfigInitialized, setIsConfigInitialized] = useState(false) + + // Users permission state + const [selectedUsers, setSelectedUsers] = useState([]) + const [allUsers, setAllUsers] = useState(false) + const [lastRecordUsers, setLastRecordUsers] = useState(null) + const [lastRecordAllUsers, setLastRecordAllUsers] = useState(null) + + // Libraries permission state + const [selectedLibraries, setSelectedLibraries] = useState([]) + const [allLibraries, setAllLibraries] = useState(false) + const [allowWriteAccess, setAllowWriteAccess] = useState(false) + const [lastRecordLibraries, setLastRecordLibraries] = useState(null) + const [lastRecordAllLibraries, setLastRecordAllLibraries] = useState(null) + const [lastRecordAllowWriteAccess, setLastRecordAllowWriteAccess] = + useState(null) + + // Parse JSON config to object + const jsonToObject = useCallback((jsonString) => { + if (!jsonString || jsonString.trim() === '') return {} + try { + return JSON.parse(jsonString) + } catch { + return {} + } + }, []) + + // Initialize/update config when record loads or changes (e.g., from SSE refresh) + React.useEffect(() => { + const recordConfig = record?.config || '' + if (record && recordConfig !== lastRecordConfig && !isDirty) { + setConfigData(jsonToObject(recordConfig)) + setLastRecordConfig(recordConfig) + // Reset initialization flag - AJV will apply defaults on first render + setIsConfigInitialized(false) + } + }, [record, lastRecordConfig, isDirty, jsonToObject]) + + // Initialize/update users permission state when record loads or changes + React.useEffect(() => { + if (record && !isDirty) { + const recordUsers = record.users || '' + const recordAllUsers = record.allUsers || false + + if ( + recordUsers !== lastRecordUsers || + recordAllUsers !== lastRecordAllUsers + ) { + try { + setSelectedUsers(recordUsers ? JSON.parse(recordUsers) : []) + } catch { + setSelectedUsers([]) + } + setAllUsers(recordAllUsers) + setLastRecordUsers(recordUsers) + setLastRecordAllUsers(recordAllUsers) + } + } + }, [record, lastRecordUsers, lastRecordAllUsers, isDirty]) + + // Initialize/update libraries permission state when record loads or changes + React.useEffect(() => { + if (record && !isDirty) { + const recordLibraries = record.libraries || '' + const recordAllLibraries = record.allLibraries || false + const recordAllowWriteAccess = record.allowWriteAccess || false + + if ( + recordLibraries !== lastRecordLibraries || + recordAllLibraries !== lastRecordAllLibraries || + recordAllowWriteAccess !== lastRecordAllowWriteAccess + ) { + try { + setSelectedLibraries( + recordLibraries ? JSON.parse(recordLibraries) : [], + ) + } catch { + setSelectedLibraries([]) + } + setAllLibraries(recordAllLibraries) + setAllowWriteAccess(recordAllowWriteAccess) + setLastRecordLibraries(recordLibraries) + setLastRecordAllLibraries(recordAllLibraries) + setLastRecordAllowWriteAccess(recordAllowWriteAccess) + } + } + }, [ + record, + lastRecordLibraries, + lastRecordAllLibraries, + lastRecordAllowWriteAccess, + isDirty, + ]) + + const handleConfigDataChange = useCallback( + (newData, errors) => { + setConfigData(newData) + setConfigErrors(errors || []) + // Skip marking dirty on initial onChange (when AJV applies defaults) + if (isConfigInitialized) { + setIsDirty(true) + } else { + setIsConfigInitialized(true) + } + }, + [isConfigInitialized], + ) + + const handleSelectedUsersChange = useCallback((newSelectedUsers) => { + setSelectedUsers(newSelectedUsers) + setIsDirty(true) + }, []) + + const handleAllUsersChange = useCallback((newAllUsers) => { + setAllUsers(newAllUsers) + setIsDirty(true) + }, []) + + const handleSelectedLibrariesChange = useCallback((newSelectedLibraries) => { + setSelectedLibraries(newSelectedLibraries) + setIsDirty(true) + }, []) + + const handleAllLibrariesChange = useCallback((newAllLibraries) => { + setAllLibraries(newAllLibraries) + setIsDirty(true) + }, []) + + const handleAllowWriteAccessChange = useCallback((newAllowWriteAccess) => { + setAllowWriteAccess(newAllowWriteAccess) + setIsDirty(true) + }, []) + + const [updatePlugin, { loading }] = useUpdate( + 'plugin', + record?.id, + {}, + record, + { + undoable: false, + onSuccess: () => { + refresh() + setIsDirty(false) + setLastRecordConfig(null) // Reset to reinitialize from server + setLastRecordUsers(null) + setLastRecordAllUsers(null) + setLastRecordLibraries(null) + setLastRecordAllLibraries(null) + setLastRecordAllowWriteAccess(null) + notify('resources.plugin.notifications.updated', 'info') + }, + onFailure: (err) => { + notify( + err?.message || 'resources.plugin.notifications.error', + 'warning', + ) + }, + }, + ) + + const handleSaveConfig = useCallback(() => { + if (!record) return + const parsedManifest = record.manifest ? JSON.parse(record.manifest) : null + const data = {} + + // Only include config if the plugin has a config schema + if (parsedManifest?.config?.schema) { + data.config = + Object.keys(configData).length > 0 ? JSON.stringify(configData) : '' + } + + // Include users data if users permission is present + if (parsedManifest?.permissions?.users) { + data.users = JSON.stringify(selectedUsers) + data.allUsers = allUsers + } + + // Include libraries data if library permission is present + if (parsedManifest?.permissions?.library) { + data.libraries = JSON.stringify(selectedLibraries) + data.allLibraries = allLibraries + data.allowWriteAccess = allowWriteAccess + } + + updatePlugin('plugin', record.id, data, record) + }, [ + updatePlugin, + record, + configData, + selectedUsers, + allUsers, + selectedLibraries, + allLibraries, + allowWriteAccess, + ]) + + // Parse manifest + const { manifest, manifestJson } = useMemo(() => { + if (!record?.manifest) return { manifest: null, manifestJson: '' } + try { + const parsed = JSON.parse(record.manifest) + return { manifest: parsed, manifestJson: JSON.stringify(parsed, null, 2) } + } catch { + return { manifest: null, manifestJson: record.manifest } + } + }, [record?.manifest]) + + // Handle loading state + if (isPending) { + return <Loading /> + } + + // Handle error state + if (error) { + return ( + <Alert severity="error">{translate('ra.notification.http_error')}</Alert> + ) + } + + // Handle missing record + if (!record) { + return null + } + + return ( + <> + <RaTitle + title={ + <Title + subTitle={`${translate('resources.plugin.name', { smart_count: 1 })} "${record.id}"`} + /> + } + /> + <Box className={classes.root}> + <ErrorSection error={record.lastError} translate={translate} /> + + <StatusCard + classes={classes} + translate={translate} + manifest={manifest} + /> + + <InfoCard + record={record} + manifest={manifest} + classes={classes} + translate={translate} + isSmall={isSmall} + /> + + <ManifestSection + manifestJson={manifestJson} + classes={classes} + translate={translate} + /> + + <ConfigCard + manifest={manifest} + configData={configData} + onConfigDataChange={handleConfigDataChange} + classes={classes} + translate={translate} + /> + + <UsersPermissionCard + manifest={manifest} + classes={classes} + selectedUsers={selectedUsers} + allUsers={allUsers} + onSelectedUsersChange={handleSelectedUsersChange} + onAllUsersChange={handleAllUsersChange} + /> + + <LibraryPermissionCard + manifest={manifest} + classes={classes} + selectedLibraries={selectedLibraries} + allLibraries={allLibraries} + allowWriteAccess={allowWriteAccess} + onSelectedLibrariesChange={handleSelectedLibrariesChange} + onAllLibrariesChange={handleAllLibrariesChange} + onAllowWriteAccessChange={handleAllowWriteAccessChange} + /> + + <Box display="flex" justifyContent="flex-end"> + <Button + variant="contained" + color="primary" + startIcon={<MdSave />} + onClick={handleSaveConfig} + disabled={!isDirty || loading || configErrors.length > 0} + className={classes.saveButton} + > + {translate('ra.action.save')} + </Button> + </Box> + </Box> + </> + ) +} + +const PluginShow = (props) => { + const controllerProps = useShowController(props) + return ( + <ShowContextProvider value={controllerProps}> + <PluginShowLayout /> + </ShowContextProvider> + ) +} + +export default PluginShow diff --git a/ui/src/plugin/SchemaConfigEditor.jsx b/ui/src/plugin/SchemaConfigEditor.jsx new file mode 100644 index 000000000..dc8f8a0f1 --- /dev/null +++ b/ui/src/plugin/SchemaConfigEditor.jsx @@ -0,0 +1,239 @@ +import React, { useCallback, useEffect, useMemo, useRef } from 'react' +import PropTypes from 'prop-types' +import { JsonForms } from '@jsonforms/react' +import { materialRenderers, materialCells } from '@jsonforms/material-renderers' +import { makeStyles } from '@material-ui/core/styles' +import { Typography } from '@material-ui/core' +import { useTranslate } from 'react-admin' +import Ajv from 'ajv' +import { + OutlinedTextRenderer, + OutlinedNumberRenderer, + OutlinedEnumRenderer, + OutlinedOneOfEnumRenderer, +} from './OutlinedRenderers' + +// Error boundary for catching JSONForms rendering errors +class SchemaErrorBoundary extends React.Component { + constructor(props) { + super(props) + this.state = { hasError: false, error: null } + } + + static getDerivedStateFromError(error) { + return { hasError: true, error } + } + + render() { + if (this.state.hasError) { + return this.props.fallback(this.state.error) + } + return this.props.children + } +} + +SchemaErrorBoundary.propTypes = { + children: PropTypes.node.isRequired, + fallback: PropTypes.func.isRequired, +} + +// Custom AJV instance that fixes "required" error paths for JSONForms. +// AJV outputs required errors pointing to the parent (e.g., "/users/1") with +// params.missingProperty. We transform them to point to the field directly +// (e.g., "/users/1/username") so JSONForms displays them under the correct input. +const ajv = new Ajv({ + useDefaults: true, + allErrors: true, + verbose: true, + jsonPointers: true, +}) +const origCompile = ajv.compile.bind(ajv) +ajv.compile = (schema) => { + const validate = origCompile(schema) + const wrapped = (data) => { + const valid = validate(data) + validate.errors?.forEach((e) => { + if (e.keyword === 'required' && e.params?.missingProperty) { + e.dataPath = `${e.dataPath || ''}/${e.params.missingProperty}` + } + }) + wrapped.errors = validate.errors + return valid + } + wrapped.schema = validate.schema + return wrapped +} + +const useStyles = makeStyles( + (theme) => ({ + root: { + '& .MuiFormControl-root': { + marginBottom: theme.spacing(2), + }, + // Label elements (type: "Label" in UI schema) - make slightly smaller + '& .MuiTypography-h6': { + fontSize: '0.95rem', + }, + // Group/array styling + '& .MuiPaper-root': { + backgroundColor: 'transparent', + }, + // Array items styling + '& .MuiAccordion-root': { + marginBottom: theme.spacing(1), + '&:before': { + display: 'none', + }, + }, + '& .MuiAccordionSummary-root': { + backgroundColor: + theme.palette.type === 'dark' + ? theme.palette.grey[800] + : theme.palette.grey[100], + // Hide expand icon - items are always expanded + '& .MuiAccordionSummary-expandIcon': { + display: 'none', + }, + }, + // Checkbox/switch styling + '& .MuiCheckbox-root, & .MuiSwitch-root': { + color: theme.palette.text.secondary, + }, + '& .Mui-checked': { + color: theme.palette.primary.main, + }, + }, + errorContainer: { + padding: theme.spacing(2), + backgroundColor: + theme.palette.type === 'dark' + ? 'rgba(244, 67, 54, 0.1)' + : 'rgba(244, 67, 54, 0.05)', + borderRadius: theme.shape.borderRadius, + border: `1px solid ${theme.palette.error.main}`, + }, + errorMessage: { + color: theme.palette.error.main, + marginBottom: theme.spacing(1), + }, + errorDetails: { + color: theme.palette.text.secondary, + fontSize: '0.85em', + fontFamily: 'monospace', + whiteSpace: 'pre-wrap', + wordBreak: 'break-word', + }, + }), + { name: 'NDSchemaConfigEditor' }, +) + +// Custom renderers with outlined text inputs and always-expanded array layout +const customRenderers = [ + // Put our custom renderers first (higher priority) + OutlinedTextRenderer, + OutlinedNumberRenderer, + OutlinedEnumRenderer, + OutlinedOneOfEnumRenderer, + // Then all the standard material renderers + ...materialRenderers, +] + +export const SchemaConfigEditor = ({ + schema, + uiSchema, + data, + onChange, + readOnly = false, +}) => { + const classes = useStyles() + const translate = useTranslate() + const containerRef = useRef(null) + + // Disable browser autocomplete on all inputs + useEffect(() => { + if (!containerRef.current) return + + const disableAutocomplete = () => { + const inputs = containerRef.current.querySelectorAll('input') + inputs.forEach((input) => { + input.setAttribute('autocomplete', 'off') + }) + } + + // Run immediately and observe for changes (new inputs added) + disableAutocomplete() + const observer = new MutationObserver(disableAutocomplete) + observer.observe(containerRef.current, { childList: true, subtree: true }) + + return () => observer.disconnect() + }, [data]) + + // Memoize the change handler to extract just the data + const handleChange = useCallback( + ({ data: newData, errors }) => { + if (onChange) { + onChange(newData, errors) + } + }, + [onChange], + ) + + // Use custom renderers with always-expanded array layout + const renderers = useMemo(() => customRenderers, []) + const cells = useMemo(() => materialCells, []) + + // JSONForms config - always show descriptions + const config = { + showUnfocusedDescription: true, + } + + // Ensure schema has required fields for JSONForms + const normalizedSchema = useMemo(() => { + if (!schema) return null + // JSONForms requires type to be set at root level + return { + type: 'object', + ...schema, + } + }, [schema]) + + if (!normalizedSchema) { + return null + } + + const renderError = (error) => ( + <div className={classes.errorContainer}> + <Typography className={classes.errorMessage}> + {translate('resources.plugin.messages.schemaRenderError')} + </Typography> + <Typography className={classes.errorDetails}>{error?.message}</Typography> + </div> + ) + + return ( + <div ref={containerRef} className={classes.root}> + <SchemaErrorBoundary fallback={renderError}> + <JsonForms + schema={normalizedSchema} + uischema={uiSchema} + data={data || {}} + renderers={renderers} + cells={cells} + config={config} + onChange={handleChange} + readonly={readOnly} + ajv={ajv} + validationMode="ValidateAndShow" + /> + </SchemaErrorBoundary> + </div> + ) +} + +SchemaConfigEditor.propTypes = { + schema: PropTypes.object, + uiSchema: PropTypes.object, + data: PropTypes.object, + onChange: PropTypes.func, + readOnly: PropTypes.bool, +} diff --git a/ui/src/plugin/SchemaConfigEditor.test.jsx b/ui/src/plugin/SchemaConfigEditor.test.jsx new file mode 100644 index 000000000..ab93e3ac8 --- /dev/null +++ b/ui/src/plugin/SchemaConfigEditor.test.jsx @@ -0,0 +1,86 @@ +import React from 'react' +import { describe, it, expect, vi } from 'vitest' +import { render } from '@testing-library/react' +import { ThemeProvider, createTheme } from '@material-ui/core/styles' +import { Provider } from 'react-redux' +import { createStore } from 'redux' +import { SchemaConfigEditor } from './SchemaConfigEditor' + +const theme = createTheme() + +// JSONForms requires Redux +const mockStore = createStore(() => ({})) + +const renderWithProviders = (component) => { + return render( + <Provider store={mockStore}> + <ThemeProvider theme={theme}>{component}</ThemeProvider> + </Provider>, + ) +} + +describe('SchemaConfigEditor', () => { + const basicSchema = { + type: 'object', + properties: { + name: { + type: 'string', + title: 'Name', + }, + enabled: { + type: 'boolean', + title: 'Enabled', + }, + }, + } + + it('renders nothing when schema is null', () => { + const { container } = renderWithProviders( + <SchemaConfigEditor schema={null} data={{}} onChange={vi.fn()} />, + ) + expect(container.firstChild).toBeNull() + }) + + it('renders the component wrapper with valid schema', () => { + const { container } = renderWithProviders( + <SchemaConfigEditor schema={basicSchema} data={{}} onChange={vi.fn()} />, + ) + // Check that the wrapper div is rendered (class name is generated) + expect( + container.querySelector('[class*="NDSchemaConfigEditor-root"]'), + ).toBeTruthy() + }) + + it('calls onChange on initial render', () => { + const onChange = vi.fn() + renderWithProviders( + <SchemaConfigEditor + schema={basicSchema} + data={{ name: 'Test' }} + onChange={onChange} + />, + ) + + // JSONForms calls onChange on initial render with initial state + expect(onChange).toHaveBeenCalled() + }) + + it('passes data and errors to onChange callback', () => { + const onChange = vi.fn() + const initialData = { name: 'Test Value' } + + renderWithProviders( + <SchemaConfigEditor + schema={basicSchema} + data={initialData} + onChange={onChange} + />, + ) + + // Check that onChange was called with data and errors + expect(onChange).toHaveBeenCalledWith( + expect.objectContaining({ name: 'Test Value' }), + expect.any(Array), + ) + }) +}) diff --git a/ui/src/plugin/StatusCard.jsx b/ui/src/plugin/StatusCard.jsx new file mode 100644 index 000000000..323a4ec10 --- /dev/null +++ b/ui/src/plugin/StatusCard.jsx @@ -0,0 +1,23 @@ +import React from 'react' +import PropTypes from 'prop-types' +import { Card, CardContent, Typography } from '@material-ui/core' +import ToggleEnabledSwitch from './ToggleEnabledSwitch' + +export const StatusCard = ({ classes, translate, manifest }) => { + return ( + <Card className={classes.section}> + <CardContent> + <Typography variant="h6" className={classes.sectionTitle}> + {translate('resources.plugin.sections.status')} + </Typography> + <ToggleEnabledSwitch showLabel size="medium" manifest={manifest} /> + </CardContent> + </Card> + ) +} + +StatusCard.propTypes = { + classes: PropTypes.object.isRequired, + translate: PropTypes.func.isRequired, + manifest: PropTypes.object, +} diff --git a/ui/src/plugin/ToggleEnabledSwitch.jsx b/ui/src/plugin/ToggleEnabledSwitch.jsx new file mode 100644 index 000000000..0b7b4d7d7 --- /dev/null +++ b/ui/src/plugin/ToggleEnabledSwitch.jsx @@ -0,0 +1,197 @@ +import React, { useCallback, useMemo } from 'react' +import { + useUpdate, + useNotify, + useRefresh, + useRecordContext, + useTranslate, + useResourceContext, +} from 'react-admin' +import Switch from '@material-ui/core/Switch' +import { makeStyles } from '@material-ui/core/styles' +import { Tooltip, FormControlLabel } from '@material-ui/core' +import PropTypes from 'prop-types' + +const useStyles = makeStyles((theme) => ({ + enabledSwitch: { + '& .MuiSwitch-colorSecondary.Mui-checked': { + color: theme.palette.success?.main || theme.palette.primary.main, + }, + '& .MuiSwitch-colorSecondary.Mui-checked + .MuiSwitch-track': { + backgroundColor: + theme.palette.success?.main || theme.palette.primary.main, + }, + }, + errorSwitch: { + '& .MuiSwitch-thumb': { + backgroundColor: theme.palette.warning.main, + }, + '& .MuiSwitch-track': { + backgroundColor: theme.palette.warning.light, + opacity: 0.7, + }, + }, +})) + +/** + * Shared toggle switch for enabling/disabling plugins. + * Used in both PluginList (compact) and PluginShow (with label). + * + * @param {Object} props + * @param {boolean} [props.showLabel=false] - Whether to show the enable/disable label + * @param {string} [props.size='small'] - Switch size ('small' or 'medium') + * @param {Object} [props.manifest=null] - Parsed manifest object for permission checking + */ +const ToggleEnabledSwitch = ({ + showLabel = false, + size = 'small', + manifest = null, +}) => { + const resource = useResourceContext() + const record = useRecordContext() + const notify = useNotify() + const refresh = useRefresh() + const translate = useTranslate() + const classes = useStyles() + + const [toggleEnabled, { loading }] = useUpdate( + resource, + record?.id, + { enabled: !record?.enabled }, + record, + { + undoable: false, + onSuccess: () => { + refresh() + notify( + record?.enabled + ? 'resources.plugin.notifications.disabled' + : 'resources.plugin.notifications.enabled', + 'info', + ) + }, + onFailure: (error) => { + refresh() + notify( + error?.message || 'resources.plugin.notifications.error', + 'warning', + ) + }, + }, + ) + + const handleClick = useCallback( + (e) => { + e.stopPropagation() + toggleEnabled() + }, + [toggleEnabled], + ) + + const hasError = !!record?.lastError + + // Check if users permission is required but not configured + const usersPermissionRequired = useMemo(() => { + if (!manifest?.permissions?.users) return false + if (record?.allUsers) return false + // Check if users array is empty or not set + if (!record?.users) return true + try { + const users = JSON.parse(record.users) + return users.length === 0 + } catch { + return true + } + }, [manifest, record?.allUsers, record?.users]) + + // Check if library permission is required but not configured + const libraryPermissionRequired = useMemo(() => { + if (!manifest?.permissions?.library) return false + if (record?.allLibraries) return false + // Check if libraries array is empty or not set + if (!record?.libraries) return true + try { + const libraries = JSON.parse(record.libraries) + return libraries.length === 0 + } catch { + return true + } + }, [manifest, record?.allLibraries, record?.libraries]) + + const permissionRequired = + usersPermissionRequired || libraryPermissionRequired + const isDisabled = + loading || hasError || (permissionRequired && !record?.enabled) + + const tooltipTitle = useMemo(() => { + if (hasError) { + return translate('resources.plugin.actions.disabledDueToError') + } + if (usersPermissionRequired && !record?.enabled) { + return translate('resources.plugin.actions.disabledUsersRequired') + } + if (libraryPermissionRequired && !record?.enabled) { + return translate('resources.plugin.actions.disabledLibrariesRequired') + } + if (!showLabel) { + return translate( + record?.enabled + ? 'resources.plugin.actions.disable' + : 'resources.plugin.actions.enable', + ) + } + return '' + }, [ + hasError, + usersPermissionRequired, + libraryPermissionRequired, + showLabel, + record?.enabled, + translate, + ]) + + const switchElement = ( + <Switch + checked={record?.enabled ?? false} + onClick={handleClick} + disabled={isDisabled} + className={isDisabled ? classes.errorSwitch : classes.enabledSwitch} + size={size} + color="primary" + /> + ) + + if (showLabel) { + const showTooltip = hasError || (permissionRequired && !record?.enabled) + return ( + <Tooltip + title={tooltipTitle} + disableHoverListener={!showTooltip} + disableFocusListener={!showTooltip} + > + <FormControlLabel + control={switchElement} + label={translate( + record?.enabled + ? 'resources.plugin.actions.disable' + : 'resources.plugin.actions.enable', + )} + /> + </Tooltip> + ) + } + + return ( + <Tooltip title={tooltipTitle}> + <span>{switchElement}</span> + </Tooltip> + ) +} + +ToggleEnabledSwitch.propTypes = { + showLabel: PropTypes.bool, + size: PropTypes.oneOf(['small', 'medium']), + manifest: PropTypes.object, +} + +export default ToggleEnabledSwitch diff --git a/ui/src/plugin/UsersPermissionCard.jsx b/ui/src/plugin/UsersPermissionCard.jsx new file mode 100644 index 000000000..54a004ce8 --- /dev/null +++ b/ui/src/plugin/UsersPermissionCard.jsx @@ -0,0 +1,168 @@ +import React from 'react' +import { + Card, + CardContent, + Typography, + Box, + FormControlLabel, + Switch, + List, + ListItem, + ListItemIcon, + ListItemText, + Checkbox, +} from '@material-ui/core' +import CheckBoxIcon from '@material-ui/icons/CheckBox' +import CheckBoxOutlineBlankIcon from '@material-ui/icons/CheckBoxOutlineBlank' +import Alert from '@material-ui/lab/Alert' +import { useGetList, useTranslate } from 'react-admin' +import PropTypes from 'prop-types' + +export const UsersPermissionCard = ({ + manifest, + classes, + selectedUsers, + allUsers, + onSelectedUsersChange, + onAllUsersChange, +}) => { + const translate = useTranslate() + + // Fetch all users + const { data: usersData, loading: usersLoading } = useGetList('user', { + pagination: { page: 1, perPage: 1000 }, + sort: { field: 'userName', order: 'ASC' }, + }) + + const users = React.useMemo(() => { + return usersData ? Object.values(usersData) : [] + }, [usersData]) + + const handleToggleUser = React.useCallback( + (userId) => { + const newSelected = selectedUsers.includes(userId) + ? selectedUsers.filter((id) => id !== userId) + : [...selectedUsers, userId] + onSelectedUsersChange(newSelected) + }, + [selectedUsers, onSelectedUsersChange], + ) + + const handleAllUsersToggle = React.useCallback( + (event) => { + onAllUsersChange(event.target.checked) + }, + [onAllUsersChange], + ) + + // Get permission reason from manifest + const usersPermission = manifest?.permissions?.users + const reason = usersPermission?.reason + + // Check if permission is required but not configured + const isConfigurationRequired = + usersPermission && !allUsers && selectedUsers.length === 0 + + if (!usersPermission) { + return null + } + + return ( + <Card className={classes.section}> + <CardContent> + <Typography variant="h6" className={classes.sectionTitle}> + {translate('resources.plugin.sections.usersPermission')} + </Typography> + + {reason && ( + <Typography variant="body2" color="textSecondary" gutterBottom> + {translate('resources.plugin.messages.permissionReason')}: {reason} + </Typography> + )} + + {isConfigurationRequired && ( + <Box mb={2}> + <Alert severity="warning"> + {translate('resources.plugin.messages.usersRequired')} + </Alert> + </Box> + )} + + <Box mb={2}> + <FormControlLabel + control={ + <Switch + checked={allUsers} + onChange={handleAllUsersToggle} + color="primary" + /> + } + label={translate('resources.plugin.fields.allUsers')} + /> + <Typography variant="body2" color="textSecondary"> + {translate('resources.plugin.messages.allUsersHelp')} + </Typography> + </Box> + + {!allUsers && ( + <Box className={classes.usersList}> + <Typography variant="subtitle2" gutterBottom> + {translate('resources.plugin.fields.selectedUsers')} + </Typography> + {usersLoading ? ( + <Typography variant="body2" color="textSecondary"> + {translate('ra.message.loading')} + </Typography> + ) : users.length === 0 ? ( + <Typography variant="body2" color="textSecondary"> + {translate('resources.plugin.messages.noUsers')} + </Typography> + ) : ( + <List + dense + style={{ + maxHeight: 200, + overflow: 'auto', + border: '1px solid rgba(0, 0, 0, 0.12)', + borderRadius: 4, + }} + > + {users.map((user) => ( + <ListItem + key={user.id} + button + onClick={() => handleToggleUser(user.id)} + dense + > + <ListItemIcon> + <Checkbox + icon={<CheckBoxOutlineBlankIcon fontSize="small" />} + checkedIcon={<CheckBoxIcon fontSize="small" />} + checked={selectedUsers.includes(user.id)} + tabIndex={-1} + disableRipple + /> + </ListItemIcon> + <ListItemText + primary={user.name || user.userName} + secondary={user.name ? user.userName : null} + /> + </ListItem> + ))} + </List> + )} + </Box> + )} + </CardContent> + </Card> + ) +} + +UsersPermissionCard.propTypes = { + manifest: PropTypes.object, + classes: PropTypes.object.isRequired, + selectedUsers: PropTypes.array.isRequired, + allUsers: PropTypes.bool.isRequired, + onSelectedUsersChange: PropTypes.func.isRequired, + onAllUsersChange: PropTypes.func.isRequired, +} diff --git a/ui/src/plugin/index.js b/ui/src/plugin/index.js new file mode 100644 index 000000000..2385308cc --- /dev/null +++ b/ui/src/plugin/index.js @@ -0,0 +1,9 @@ +import { VscExtensions } from 'react-icons/vsc' +import PluginList from './PluginList' +import PluginShow from './PluginShow' + +export default { + icon: VscExtensions, + list: PluginList, + show: PluginShow, +} diff --git a/ui/src/plugin/jsonValidation.js b/ui/src/plugin/jsonValidation.js new file mode 100644 index 000000000..408d6dac5 --- /dev/null +++ b/ui/src/plugin/jsonValidation.js @@ -0,0 +1,68 @@ +/** + * Validates a JSON string and returns validation result + * @param {string} value - The JSON string to validate + * @returns {{ valid: boolean, error: string|null, parsed: object|null }} + */ +export const validateJson = (value) => { + if (!value || value.trim() === '') { + return { valid: true, error: null, parsed: null } + } + + try { + const parsed = JSON.parse(value) + // Ensure config is an object, not an array or primitive + if ( + typeof parsed !== 'object' || + parsed === null || + Array.isArray(parsed) + ) { + return { + valid: false, + error: 'Configuration must be a JSON object', + parsed: null, + } + } + return { valid: true, error: null, parsed } + } catch (e) { + // Try to provide helpful error messages + let error = 'Invalid JSON' + + if (e instanceof SyntaxError) { + const message = e.message + + // Extract position information if available + const positionMatch = message.match(/position (\d+)/) + if (positionMatch) { + const position = parseInt(positionMatch[1], 10) + const lines = value.substring(0, position).split('\n') + const line = lines.length + const column = lines[lines.length - 1].length + 1 + error = `Invalid JSON at line ${line}, column ${column}` + } else if (message.includes('Unexpected end of JSON')) { + error = 'Incomplete JSON - check for missing brackets or quotes' + } else if (message.includes('Unexpected token')) { + error = 'Invalid JSON - unexpected character found' + } + } + + return { valid: false, error, parsed: null } + } +} + +/** + * Formats JSON string with proper indentation + * @param {string} value - The JSON string to format + * @returns {string} - Formatted JSON string or original if invalid + */ +export const formatJson = (value) => { + if (!value || value.trim() === '') { + return value + } + + try { + const parsed = JSON.parse(value) + return JSON.stringify(parsed, null, 2) + } catch { + return value + } +} diff --git a/ui/src/plugin/jsonValidation.test.js b/ui/src/plugin/jsonValidation.test.js new file mode 100644 index 000000000..f56549d79 --- /dev/null +++ b/ui/src/plugin/jsonValidation.test.js @@ -0,0 +1,97 @@ +import { describe, it, expect } from 'vitest' +import { validateJson, formatJson } from './jsonValidation' + +describe('validateJson', () => { + it('returns valid for empty string', () => { + const result = validateJson('') + expect(result.valid).toBe(true) + expect(result.error).toBeNull() + expect(result.parsed).toBeNull() + }) + + it('returns valid for whitespace only', () => { + const result = validateJson(' ') + expect(result.valid).toBe(true) + expect(result.error).toBeNull() + }) + + it('returns valid for valid JSON object', () => { + const result = validateJson('{"key": "value"}') + expect(result.valid).toBe(true) + expect(result.error).toBeNull() + expect(result.parsed).toEqual({ key: 'value' }) + }) + + it('returns valid for nested JSON object', () => { + const result = validateJson('{"outer": {"inner": 123}}') + expect(result.valid).toBe(true) + expect(result.parsed).toEqual({ outer: { inner: 123 } }) + }) + + it('returns invalid for JSON array', () => { + const result = validateJson('[1, 2, 3]') + expect(result.valid).toBe(false) + expect(result.error).toBe('Configuration must be a JSON object') + }) + + it('returns invalid for JSON primitive string', () => { + const result = validateJson('"hello"') + expect(result.valid).toBe(false) + expect(result.error).toBe('Configuration must be a JSON object') + }) + + it('returns invalid for JSON primitive number', () => { + const result = validateJson('42') + expect(result.valid).toBe(false) + expect(result.error).toBe('Configuration must be a JSON object') + }) + + it('returns invalid for JSON null', () => { + const result = validateJson('null') + expect(result.valid).toBe(false) + expect(result.error).toBe('Configuration must be a JSON object') + }) + + it('returns invalid for malformed JSON', () => { + const result = validateJson('{"key": }') + expect(result.valid).toBe(false) + expect(result.error).toContain('Invalid JSON') + }) + + it('returns invalid for incomplete JSON', () => { + const result = validateJson('{"key": "value"') + expect(result.valid).toBe(false) + expect(result.error).toContain('Invalid JSON') + }) + + it('returns invalid for JSON with trailing comma', () => { + const result = validateJson('{"key": "value",}') + expect(result.valid).toBe(false) + expect(result.error).toContain('Invalid JSON') + }) +}) + +describe('formatJson', () => { + it('returns empty string unchanged', () => { + expect(formatJson('')).toBe('') + }) + + it('returns whitespace unchanged', () => { + expect(formatJson(' ')).toBe(' ') + }) + + it('formats compact JSON with indentation', () => { + const result = formatJson('{"key":"value"}') + expect(result).toBe('{\n "key": "value"\n}') + }) + + it('formats nested JSON with proper indentation', () => { + const result = formatJson('{"outer":{"inner":123}}') + expect(result).toBe('{\n "outer": {\n "inner": 123\n }\n}') + }) + + it('returns invalid JSON unchanged', () => { + const invalid = '{"key": }' + expect(formatJson(invalid)).toBe(invalid) + }) +}) diff --git a/ui/src/plugin/styles.js b/ui/src/plugin/styles.js new file mode 100644 index 000000000..104d8bc0f --- /dev/null +++ b/ui/src/plugin/styles.js @@ -0,0 +1,85 @@ +import { makeStyles } from '@material-ui/core/styles' + +export const usePluginShowStyles = makeStyles( + (theme) => ({ + root: { + padding: theme.spacing(2), + maxWidth: 900, + }, + section: { + marginBottom: theme.spacing(3), + }, + sectionTitle: { + marginBottom: theme.spacing(1), + fontWeight: 600, + }, + manifestBox: { + backgroundColor: + theme.palette.type === 'dark' + ? theme.palette.grey[900] + : theme.palette.grey[100], + padding: theme.spacing(2), + borderRadius: theme.shape.borderRadius, + fontFamily: 'monospace', + fontSize: '0.85rem', + whiteSpace: 'pre-wrap', + wordBreak: 'break-word', + overflow: 'auto', + maxHeight: 400, + }, + saveButton: { + marginTop: theme.spacing(2), + }, + infoGrid: { + '& .MuiGrid-item': { + paddingTop: theme.spacing(0.5), + paddingBottom: theme.spacing(0.5), + }, + }, + infoLabel: { + fontWeight: 500, + color: theme.palette.text.secondary, + }, + pathField: { + fontFamily: 'monospace', + fontSize: '0.85rem', + wordBreak: 'break-all', + }, + permissionsContainer: { + display: 'flex', + flexWrap: 'wrap', + gap: theme.spacing(0.5), + }, + permissionChip: { + fontSize: '0.75rem', + }, + tooltipContent: { + '& code': { + fontFamily: 'monospace', + fontSize: '0.8em', + backgroundColor: 'rgba(255,255,255,0.1)', + padding: '1px 4px', + borderRadius: 2, + }, + }, + configTable: { + '& .MuiTableCell-root': { + padding: theme.spacing(1), + }, + }, + configTableInput: { + fontFamily: 'monospace', + fontSize: '0.85rem', + }, + configActionIconButton: { + backgroundColor: theme.palette.action.hover, + borderRadius: theme.shape.borderRadius, + padding: theme.spacing(0.5, 1), + fontWeight: 700, + '&:hover': { + backgroundColor: theme.palette.action.selected, + }, + }, + }), + { name: 'NDPluginShow' }, +) diff --git a/ui/src/radio/RadioEdit.jsx b/ui/src/radio/RadioEdit.jsx index f00f889f3..5f804535a 100644 --- a/ui/src/radio/RadioEdit.jsx +++ b/ui/src/radio/RadioEdit.jsx @@ -6,8 +6,37 @@ import { TextInput, useTranslate, } from 'react-admin' +import { CardMedia } from '@material-ui/core' +import { makeStyles } from '@material-ui/core/styles' import { urlValidate } from '../utils/validations' -import { Title } from '../common' +import { Title, ImageUploadOverlay, useImageLoadingState } from '../common' +import subsonic from '../subsonic' +import { COVER_ART_SIZE, RADIO_PLACEHOLDER_IMAGE } from '../consts' + +const useStyles = makeStyles({ + coverParent: { + display: 'inline-flex', + position: 'relative', + width: '8rem', + height: '8rem', + marginBottom: '1em', + }, + cover: { + width: '8rem', + height: '8rem', + objectFit: 'cover', + cursor: 'pointer', + transition: 'opacity 0.3s ease-in-out', + }, + coverLoading: { + opacity: 0.5, + }, + placeholder: { + width: '8rem', + height: '8rem', + objectFit: 'contain', + }, +}) const RadioTitle = ({ record }) => { const translate = useTranslate() @@ -21,6 +50,7 @@ const RadioEdit = (props) => { return ( <Edit title={<RadioTitle />} {...props}> <SimpleForm variant="outlined" {...props}> + <RadioCoverArt /> <TextInput source="name" validate={[required()]} /> <TextInput type="url" @@ -41,4 +71,39 @@ const RadioEdit = (props) => { ) } +const RadioCoverArt = ({ record }) => { + const classes = useStyles() + const { imageLoading, handleImageLoad, handleImageError } = + useImageLoadingState(record?.id) + + if (!record) return null + + return ( + <div className={classes.coverParent}> + {record.uploadedImage ? ( + <CardMedia + component="img" + src={subsonic.getCoverArtUrl(record, COVER_ART_SIZE, true)} + className={`${classes.cover} ${imageLoading ? classes.coverLoading : ''}`} + onLoad={handleImageLoad} + onError={handleImageError} + title={record.name} + alt={record.name} + /> + ) : ( + <img + src={RADIO_PLACEHOLDER_IMAGE} + className={classes.placeholder} + alt={record.name} + /> + )} + <ImageUploadOverlay + entityType="radio" + entityId={record.id} + hasUploadedImage={!!record.uploadedImage} + /> + </div> + ) +} + export default RadioEdit diff --git a/ui/src/radio/RadioList.jsx b/ui/src/radio/RadioList.jsx index 3d1adacc9..582fcaffc 100644 --- a/ui/src/radio/RadioList.jsx +++ b/ui/src/radio/RadioList.jsx @@ -1,4 +1,4 @@ -import { makeStyles, useMediaQuery } from '@material-ui/core' +import { Avatar, makeStyles, useMediaQuery } from '@material-ui/core' import React, { cloneElement } from 'react' import { CreateButton, @@ -16,9 +16,11 @@ import { } from 'react-admin' import { List } from '../common' import { ToggleFieldsMenu, useSelectedFields } from '../common' +import subsonic from '../subsonic' import { StreamField } from './StreamField' import { setTrack } from '../actions' import { songFromRadio } from './helper' +import { RADIO_PLACEHOLDER_IMAGE } from '../consts' import { useDispatch } from 'react-redux' const useStyles = makeStyles({ @@ -73,6 +75,19 @@ const RadioListActions = ({ ) } +const avatarStyle = { width: 40, height: 40 } + +const CoverArtField = ({ record }) => { + if (!record) return null + const src = record.uploadedImage + ? subsonic.getCoverArtUrl(record, 40, true) + : RADIO_PLACEHOLDER_IMAGE + return ( + <Avatar src={src} variant="rounded" style={avatarStyle} alt={record.name} /> + ) +} +CoverArtField.defaultProps = { label: '' } + const RadioList = ({ permissions, ...props }) => { const classes = useStyles() const isXsmall = useMediaQuery((theme) => theme.breakpoints.down('xs')) @@ -80,6 +95,7 @@ const RadioList = ({ permissions, ...props }) => { const isAdmin = permissions === 'admin' const toggleableFields = { + coverArt: <CoverArtField source="id" sortable={false} />, name: <TextField source="name" />, homePageUrl: ( <UrlField @@ -97,7 +113,7 @@ const RadioList = ({ permissions, ...props }) => { const columns = useSelectedFields({ resource: 'radio', columns: toggleableFields, - defaultOff: ['createdAt'], + defaultOff: ['streamUrl', 'createdAt'], }) const handleRowClick = async (id, basePath, record) => { @@ -117,6 +133,7 @@ const RadioList = ({ permissions, ...props }) => { > {isXsmall ? ( <SimpleList + leftAvatar={(r) => <CoverArtField record={r} />} leftIcon={(r) => ( <StreamField record={r} diff --git a/ui/src/radio/helper.jsx b/ui/src/radio/helper.jsx index 57de244b9..b278c0d7d 100644 --- a/ui/src/radio/helper.jsx +++ b/ui/src/radio/helper.jsx @@ -1,16 +1,24 @@ +import subsonic from '../subsonic' +import { COVER_ART_SIZE, RADIO_PLACEHOLDER_IMAGE } from '../consts' + export async function songFromRadio(radio) { if (!radio) { return undefined } - let cover = 'internet-radio-icon.svg' - try { - const url = new URL(radio.homePageUrl ?? radio.streamUrl) - url.pathname = '/favicon.ico' - await resourceExists(url) - cover = url.toString() - } catch { - // ignore + let cover = RADIO_PLACEHOLDER_IMAGE + if (radio.uploadedImage) { + cover = subsonic.getCoverArtUrl(radio, COVER_ART_SIZE, true) + } else { + // Try favicon as fallback + try { + const url = new URL(radio.homePageUrl ?? radio.streamUrl) + url.pathname = '/favicon.ico' + await resourceExists(url) + cover = url.toString() + } catch { + // No cover available + } } return { diff --git a/ui/src/reducers/index.js b/ui/src/reducers/index.js index 3db0b1dff..64a0049b7 100644 --- a/ui/src/reducers/index.js +++ b/ui/src/reducers/index.js @@ -6,3 +6,4 @@ export * from './albumView' export * from './activityReducer' export * from './settingsReducer' export * from './replayGainReducer' +export * from './transcodingReducer' diff --git a/ui/src/reducers/libraryReducer.js b/ui/src/reducers/libraryReducer.js index 7cda10bcf..ef613260f 100644 --- a/ui/src/reducers/libraryReducer.js +++ b/ui/src/reducers/libraryReducer.js @@ -8,18 +8,39 @@ const initialState = { export const libraryReducer = (previousState = initialState, payload) => { const { type, data } = payload switch (type) { - case SET_USER_LIBRARIES: + case SET_USER_LIBRARIES: { + const newUserLibraryIds = data.map((lib) => lib.id) + + // Validate and filter selected libraries to only include IDs that exist in new user libraries + const validatedSelection = previousState.selectedLibraries.filter((id) => + newUserLibraryIds.includes(id), + ) + + // Determine the final selection: + // 1. If first time setting libraries (no previous user libraries), select all + // 2. If user now has only one library, reset to empty (no filter needed) + // 3. Otherwise, use validated selection (may be empty if all previous selections were invalid) + let finalSelection + if ( + previousState.selectedLibraries.length === 0 && + previousState.userLibraries.length === 0 + ) { + // First time: select all libraries + finalSelection = newUserLibraryIds + } else if (newUserLibraryIds.length === 1) { + // Single library: reset selection (empty means "all accessible") + finalSelection = [] + } else { + // Multiple libraries: use validated selection + finalSelection = validatedSelection + } + return { ...previousState, userLibraries: data, - // If this is the first time setting user libraries and no selection exists, - // default to all libraries - selectedLibraries: - previousState.selectedLibraries.length === 0 && - previousState.userLibraries.length === 0 - ? data.map((lib) => lib.id) - : previousState.selectedLibraries, + selectedLibraries: finalSelection, } + } case SET_SELECTED_LIBRARIES: return { ...previousState, diff --git a/ui/src/reducers/libraryReducer.test.js b/ui/src/reducers/libraryReducer.test.js new file mode 100644 index 000000000..b962c1036 --- /dev/null +++ b/ui/src/reducers/libraryReducer.test.js @@ -0,0 +1,186 @@ +import { describe, it, expect } from 'vitest' +import { libraryReducer } from './libraryReducer' +import { SET_SELECTED_LIBRARIES, SET_USER_LIBRARIES } from '../actions' + +describe('libraryReducer', () => { + const mockLibraries = [ + { id: '1', name: 'Music Library' }, + { id: '2', name: 'Podcasts' }, + { id: '3', name: 'Audiobooks' }, + ] + + const initialState = { + userLibraries: [], + selectedLibraries: [], + } + + describe('SET_USER_LIBRARIES', () => { + it('should set user libraries and select all on first load', () => { + const action = { + type: SET_USER_LIBRARIES, + data: mockLibraries, + } + + const result = libraryReducer(initialState, action) + + expect(result.userLibraries).toEqual(mockLibraries) + expect(result.selectedLibraries).toEqual(['1', '2', '3']) + }) + + it('should reset selection to empty when user has only one library', () => { + const previousState = { + userLibraries: mockLibraries, + selectedLibraries: ['1', '2'], + } + + const action = { + type: SET_USER_LIBRARIES, + data: [mockLibraries[0]], // Only one library now + } + + const result = libraryReducer(previousState, action) + + expect(result.userLibraries).toEqual([mockLibraries[0]]) + expect(result.selectedLibraries).toEqual([]) // Reset for single library + }) + + it('should filter out invalid library IDs from selection', () => { + const previousState = { + userLibraries: mockLibraries, + selectedLibraries: ['1', '2', '3'], + } + + const action = { + type: SET_USER_LIBRARIES, + data: [mockLibraries[0], mockLibraries[1]], // Only libraries 1 and 2 remain + } + + const result = libraryReducer(previousState, action) + + expect(result.userLibraries).toEqual([mockLibraries[0], mockLibraries[1]]) + expect(result.selectedLibraries).toEqual(['1', '2']) // Library 3 removed + }) + + it('should keep valid selection when libraries change', () => { + const previousState = { + userLibraries: mockLibraries, + selectedLibraries: ['1'], + } + + const action = { + type: SET_USER_LIBRARIES, + data: mockLibraries, // Same libraries + } + + const result = libraryReducer(previousState, action) + + expect(result.userLibraries).toEqual(mockLibraries) + expect(result.selectedLibraries).toEqual(['1']) // Selection preserved + }) + + it('should handle selection becoming empty after filtering invalid IDs', () => { + const previousState = { + userLibraries: mockLibraries, + selectedLibraries: ['1', '2'], + } + + const newLibraries = [{ id: '4', name: 'New Library' }] + const action = { + type: SET_USER_LIBRARIES, + data: newLibraries, + } + + const result = libraryReducer(previousState, action) + + expect(result.userLibraries).toEqual(newLibraries) + expect(result.selectedLibraries).toEqual([]) // All selected IDs were invalid + }) + + it('should handle transition from multiple to single library with invalid selection', () => { + const previousState = { + userLibraries: mockLibraries, + selectedLibraries: ['2', '3'], // User had libraries 2 and 3 selected + } + + const action = { + type: SET_USER_LIBRARIES, + data: [mockLibraries[0]], // Now only has access to library 1 + } + + const result = libraryReducer(previousState, action) + + expect(result.userLibraries).toEqual([mockLibraries[0]]) + expect(result.selectedLibraries).toEqual([]) // Reset for single library + }) + + it('should handle empty library list', () => { + const previousState = { + userLibraries: mockLibraries, + selectedLibraries: ['1', '2'], + } + + const action = { + type: SET_USER_LIBRARIES, + data: [], + } + + const result = libraryReducer(previousState, action) + + expect(result.userLibraries).toEqual([]) + expect(result.selectedLibraries).toEqual([]) // All selections filtered out + }) + }) + + describe('SET_SELECTED_LIBRARIES', () => { + it('should update selected libraries', () => { + const previousState = { + userLibraries: mockLibraries, + selectedLibraries: ['1'], + } + + const action = { + type: SET_SELECTED_LIBRARIES, + data: ['2', '3'], + } + + const result = libraryReducer(previousState, action) + + expect(result.selectedLibraries).toEqual(['2', '3']) + expect(result.userLibraries).toEqual(mockLibraries) // Unchanged + }) + + it('should allow setting empty selection', () => { + const previousState = { + userLibraries: mockLibraries, + selectedLibraries: ['1', '2'], + } + + const action = { + type: SET_SELECTED_LIBRARIES, + data: [], + } + + const result = libraryReducer(previousState, action) + + expect(result.selectedLibraries).toEqual([]) + }) + }) + + describe('unknown action', () => { + it('should return previous state for unknown action', () => { + const previousState = { + userLibraries: mockLibraries, + selectedLibraries: ['1'], + } + + const action = { + type: 'UNKNOWN_ACTION', + data: null, + } + + const result = libraryReducer(previousState, action) + + expect(result).toBe(previousState) // Same reference + }) + }) +}) diff --git a/ui/src/reducers/playerReducer.js b/ui/src/reducers/playerReducer.js index 92fe85df4..466a3ec87 100644 --- a/ui/src/reducers/playerReducer.js +++ b/ui/src/reducers/playerReducer.js @@ -1,5 +1,6 @@ import { v4 as uuidv4 } from 'uuid' import subsonic from '../subsonic' +import { decisionService } from '../transcode' import { PLAYER_ADD_TRACKS, PLAYER_CLEAR_QUEUE, @@ -10,6 +11,7 @@ import { PLAYER_SET_VOLUME, PLAYER_SYNC_QUEUE, PLAYER_SET_MODE, + PLAYER_REFRESH_QUEUE, } from '../actions' import config from '../config' @@ -30,6 +32,14 @@ const pad = (value) => { } } +const makeMusicSrc = (trackId) => + decisionService.getProfile() + ? () => + decisionService + .resolveStreamUrl(trackId) + .catch(() => subsonic.streamUrl(trackId)) + : subsonic.streamUrl(trackId) + const mapToAudioLists = (item) => { // If item comes from a playlist, trackId is mediaFileId const trackId = item.mediaFileId || item.id @@ -76,7 +86,7 @@ const mapToAudioLists = (item) => { lyric: lyricText, singer: item.artist, duration: item.duration, - musicSrc: subsonic.streamUrl(trackId), + musicSrc: makeMusicSrc(trackId), cover: subsonic.getCoverArtUrl( { id: trackId, @@ -124,6 +134,7 @@ const reduceAddTracks = (state, { data }) => { } const reducePlayNext = (state, { data }) => { + const newTracks = Object.keys(data).map((id) => mapToAudioLists(data[id])) const newQueue = [] const current = state.current || {} let foundPos = false @@ -131,15 +142,11 @@ const reducePlayNext = (state, { data }) => { newQueue.push(item) if (item.uuid === current.uuid) { foundPos = true - Object.keys(data).forEach((id) => { - newQueue.push(mapToAudioLists(data[id])) - }) + newQueue.push(...newTracks) } }) if (!foundPos) { - Object.keys(data).forEach((id) => { - newQueue.push(mapToAudioLists(data[id])) - }) + newQueue.push(...newTracks) } return { @@ -157,11 +164,18 @@ const reduceSetVolume = (state, { data: { volume } }) => { } const reduceSyncQueue = (state, { data: { audioInfo, audioLists } }) => { + // Only keep clear and playIndex alive when there is an actual pending + // track switch (playIndex differs from savedPlayIndex). This lets + // PLAYER_PLAY_TRACKS selections survive the sync, while allowing + // PLAYER_PLAY_NEXT (which sets playIndex to the current track) to + // reset immediately and avoid restarting playback. + const hasPendingSwitch = + state.playIndex != null && state.playIndex !== state.savedPlayIndex return { ...state, queue: audioLists, - clear: false, - playIndex: undefined, + clear: hasPendingSwitch ? state.clear : false, + playIndex: hasPendingSwitch ? state.playIndex : undefined, } } @@ -170,11 +184,17 @@ const reduceCurrent = (state, { data }) => { const savedPlayIndex = state.queue.findIndex( (item) => item.uuid === current.uuid, ) + // When a track selection is pending (playIndex is set), keep it alive + // until the music player confirms it actually switched to the requested + // track. Without this, a premature onAudioPlay callback for the + // still-playing old track would overwrite the pending selection. + const pending = state.playIndex != null && savedPlayIndex !== state.playIndex return { ...state, current, - playIndex: undefined, - savedPlayIndex, + playIndex: pending ? state.playIndex : undefined, + clear: pending ? state.clear : false, + savedPlayIndex: pending ? state.savedPlayIndex : savedPlayIndex, volume: data.volume, } } @@ -207,6 +227,22 @@ export const playerReducer = (previousState = initialState, payload) => { return reduceCurrent(previousState, payload) case PLAYER_SET_MODE: return reduceMode(previousState, payload) + case PLAYER_REFRESH_QUEUE: { + const resolvedUrls = payload.data || {} + return { + ...previousState, + queue: previousState.queue.map((item) => ({ + ...item, + musicSrc: item.isRadio + ? item.musicSrc + : resolvedUrls[item.trackId] || subsonic.streamUrl(item.trackId), + })), + clear: true, + autoPlay: false, + playIndex: + previousState.savedPlayIndex >= 0 ? previousState.savedPlayIndex : 0, + } + } default: return previousState } diff --git a/ui/src/reducers/playerReducer.test.js b/ui/src/reducers/playerReducer.test.js new file mode 100644 index 000000000..10e9512d7 --- /dev/null +++ b/ui/src/reducers/playerReducer.test.js @@ -0,0 +1,145 @@ +import { describe, it, expect } from 'vitest' +import { playerReducer } from './playerReducer' +import { + PLAYER_SYNC_QUEUE, + PLAYER_CURRENT, + PLAYER_REFRESH_QUEUE, +} from '../actions' + +describe('playerReducer', () => { + describe('pending track selection survives SYNC_QUEUE and premature CURRENT', () => { + // Simulates the real sequence when clicking a new song while one is playing: + // 1. PLAYER_PLAY_TRACKS sets playIndex and clear + // 2. PLAYER_SYNC_QUEUE fires when music player syncs its internal queue + // 3. PLAYER_CURRENT fires for the OLD still-playing track + // 4. PLAYER_CURRENT fires for the NEW track (player switched) + const stateAfterPlayTracks = { + queue: [ + { trackId: 's1', uuid: 'aaa', name: 'Song 1' }, + { trackId: 's2', uuid: 'bbb', name: 'Song 2' }, + { trackId: 's3', uuid: 'ccc', name: 'Song 3' }, + ], + current: { uuid: 'ccc', name: 'Song 3' }, + playIndex: 0, // user clicked Song 1 + savedPlayIndex: 2, // Song 3 was playing + clear: true, + volume: 1, + } + + it('SYNC_QUEUE preserves pending playIndex and clear', () => { + const newQueue = [ + { trackId: 's1', uuid: 'xxx', name: 'Song 1' }, + { trackId: 's2', uuid: 'yyy', name: 'Song 2' }, + { trackId: 's3', uuid: 'zzz', name: 'Song 3' }, + ] + const action = { + type: PLAYER_SYNC_QUEUE, + data: { audioInfo: {}, audioLists: newQueue }, + } + const result = playerReducer(stateAfterPlayTracks, action) + expect(result.playIndex).toBe(0) + expect(result.clear).toBe(true) + expect(result.queue).toBe(newQueue) + }) + + it('SYNC_QUEUE clears playIndex when no pending selection', () => { + const stateNoPending = { ...stateAfterPlayTracks, playIndex: undefined } + const action = { + type: PLAYER_SYNC_QUEUE, + data: { audioInfo: {}, audioLists: stateNoPending.queue }, + } + const result = playerReducer(stateNoPending, action) + expect(result.playIndex).toBeUndefined() + expect(result.clear).toBe(false) + }) + + it('CURRENT for old track preserves pending playIndex', () => { + // After SYNC_QUEUE, queue has new UUIDs. The old track's UUID (zzz) + // is at index 2, but playIndex is 0. This is a premature callback. + const stateAfterSync = { + ...stateAfterPlayTracks, + queue: [ + { trackId: 's1', uuid: 'xxx', name: 'Song 1' }, + { trackId: 's2', uuid: 'yyy', name: 'Song 2' }, + { trackId: 's3', uuid: 'zzz', name: 'Song 3' }, + ], + } + const action = { + type: PLAYER_CURRENT, + data: { uuid: 'zzz', name: 'Song 3', volume: 1 }, + } + const result = playerReducer(stateAfterSync, action) + expect(result.playIndex).toBe(0) + expect(result.clear).toBe(true) + expect(result.savedPlayIndex).toBe(2) // preserved from before + }) + + it('CURRENT for correct track consumes pending playIndex', () => { + const stateAfterSync = { + ...stateAfterPlayTracks, + queue: [ + { trackId: 's1', uuid: 'xxx', name: 'Song 1' }, + { trackId: 's2', uuid: 'yyy', name: 'Song 2' }, + { trackId: 's3', uuid: 'zzz', name: 'Song 3' }, + ], + } + // Player switched to Song 1 (uuid 'xxx', index 0 == playIndex) + const action = { + type: PLAYER_CURRENT, + data: { uuid: 'xxx', name: 'Song 1', volume: 1 }, + } + const result = playerReducer(stateAfterSync, action) + expect(result.playIndex).toBeUndefined() + expect(result.clear).toBe(false) + expect(result.savedPlayIndex).toBe(0) + expect(result.current.name).toBe('Song 1') + }) + }) + + describe('PLAYER_REFRESH_QUEUE', () => { + it('clamps negative savedPlayIndex to 0', () => { + const state = { + queue: [ + { trackId: 'song-1', musicSrc: 'old-url', uuid: 'a' }, + { trackId: 'song-2', musicSrc: 'old-url', uuid: 'b' }, + ], + savedPlayIndex: -1, + current: {}, + clear: false, + volume: 1, + } + const action = { type: PLAYER_REFRESH_QUEUE, data: {} } + const result = playerReducer(state, action) + expect(result.playIndex).toBe(0) + }) + + it('preserves valid savedPlayIndex', () => { + const state = { + queue: [ + { trackId: 'song-1', musicSrc: 'old-url', uuid: 'a' }, + { trackId: 'song-2', musicSrc: 'old-url', uuid: 'b' }, + ], + savedPlayIndex: 1, + current: {}, + clear: false, + volume: 1, + } + const action = { type: PLAYER_REFRESH_QUEUE, data: {} } + const result = playerReducer(state, action) + expect(result.playIndex).toBe(1) + }) + + it('uses savedPlayIndex of 0 correctly', () => { + const state = { + queue: [{ trackId: 'song-1', musicSrc: 'old-url', uuid: 'a' }], + savedPlayIndex: 0, + current: {}, + clear: false, + volume: 1, + } + const action = { type: PLAYER_REFRESH_QUEUE, data: {} } + const result = playerReducer(state, action) + expect(result.playIndex).toBe(0) + }) + }) +}) diff --git a/ui/src/reducers/themeReducer.js b/ui/src/reducers/themeReducer.js index 2a5d5bac6..16d5fa87b 100644 --- a/ui/src/reducers/themeReducer.js +++ b/ui/src/reducers/themeReducer.js @@ -1,8 +1,12 @@ import { CHANGE_THEME } from '../actions' +import { AUTO_THEME_ID, AUTO_THEME_CONFIG_VALUE } from '../consts' import config from '../config' import themes from '../themes' const defaultTheme = () => { + if (config.defaultTheme === AUTO_THEME_CONFIG_VALUE) { + return AUTO_THEME_ID + } return ( Object.keys(themes).find( (t) => themes[t].themeName === config.defaultTheme, diff --git a/ui/src/reducers/themeReducer.test.js b/ui/src/reducers/themeReducer.test.js new file mode 100644 index 000000000..2a66ea851 --- /dev/null +++ b/ui/src/reducers/themeReducer.test.js @@ -0,0 +1,32 @@ +import { describe, it, expect, vi, beforeEach } from 'vitest' +import { AUTO_THEME_ID, AUTO_THEME_CONFIG_VALUE } from '../consts' + +describe('themeReducer', () => { + beforeEach(() => { + vi.resetModules() + }) + + it.each([ + { + configTheme: AUTO_THEME_CONFIG_VALUE, + expected: AUTO_THEME_ID, + description: 'is "Auto"', + }, + { configTheme: 'Dark', expected: 'DarkTheme', description: 'is "Dark"' }, + { + configTheme: 'NonExistent', + expected: 'DarkTheme', + description: 'is unrecognized', + }, + ])( + 'returns $expected when defaultTheme config $description', + async ({ configTheme, expected }) => { + vi.doMock('../config', () => ({ + default: { defaultTheme: configTheme }, + })) + const { themeReducer } = await import('./themeReducer') + const result = themeReducer(undefined, { type: 'UNKNOWN' }) + expect(result).toBe(expected) + }, + ) +}) diff --git a/ui/src/reducers/transcodingReducer.js b/ui/src/reducers/transcodingReducer.js new file mode 100644 index 000000000..db7a3708a --- /dev/null +++ b/ui/src/reducers/transcodingReducer.js @@ -0,0 +1,14 @@ +import { TRANSCODING_SET_PROFILE } from '../actions' + +const initialState = { + browserProfile: null, +} + +export const transcodingReducer = (state = initialState, { type, data }) => { + switch (type) { + case TRANSCODING_SET_PROFILE: + return { ...state, browserProfile: data } + default: + return state + } +} diff --git a/ui/src/reducers/transcodingReducer.test.js b/ui/src/reducers/transcodingReducer.test.js new file mode 100644 index 000000000..eb3e7a490 --- /dev/null +++ b/ui/src/reducers/transcodingReducer.test.js @@ -0,0 +1,23 @@ +import { describe, it, expect } from 'vitest' +import { transcodingReducer } from './transcodingReducer' +import { TRANSCODING_SET_PROFILE } from '../actions' + +describe('transcodingReducer', () => { + const initialState = { browserProfile: null } + + it('returns initial state', () => { + expect(transcodingReducer(undefined, {})).toEqual(initialState) + }) + + it('handles TRANSCODING_SET_PROFILE', () => { + const profile = { + name: 'NavidromeUI', + directPlayProfiles: [{ containers: ['mp3'] }], + } + const state = transcodingReducer(initialState, { + type: TRANSCODING_SET_PROFILE, + data: profile, + }) + expect(state.browserProfile).toEqual(profile) + }) +}) diff --git a/ui/src/share/SharePlayer.jsx b/ui/src/share/SharePlayer.jsx index 2c50275ed..a3a15e50a 100644 --- a/ui/src/share/SharePlayer.jsx +++ b/ui/src/share/SharePlayer.jsx @@ -53,6 +53,7 @@ const SharePlayer = () => { remove: false, spaceBar: true, volumeFade: { fadeIn: 200, fadeOut: 200 }, + sortableOptions: { delay: 200, delayOnTouchOnly: true }, } return ( <ReactJkMusicPlayer diff --git a/ui/src/song/SongList.jsx b/ui/src/song/SongList.jsx index f067e11d2..98684132f 100644 --- a/ui/src/song/SongList.jsx +++ b/ui/src/song/SongList.jsx @@ -145,6 +145,7 @@ const SongList = (props) => { return { album: isDesktop && <AlbumLinkField source="album" sortByOrder={'ASC'} />, artist: <ArtistLinkField source="artist" />, + composer: <ArtistLinkField source="composer" />, albumArtist: <ArtistLinkField source="albumArtist" />, trackNumber: isDesktop && <NumberField source="trackNumber" />, playCount: isDesktop && ( @@ -192,6 +193,7 @@ const SongList = (props) => { resource: 'song', columns: toggleableFields, defaultOff: [ + 'composer', 'channels', 'bpm', 'playDate', diff --git a/ui/src/subsonic/index.js b/ui/src/subsonic/index.js index ad7a391e0..3579619aa 100644 --- a/ui/src/subsonic/index.js +++ b/ui/src/subsonic/index.js @@ -23,7 +23,13 @@ const url = (command, id, options) => { delete options.ts } Object.keys(options).forEach((k) => { - params.append(k, options[k]) + const value = options[k] + // Handle array parameters by appending each value separately + if (Array.isArray(value)) { + value.forEach((v) => params.append(k, v)) + } else { + params.append(k, value) + } }) } return `/rest/${command}?${params.toString()}` @@ -80,11 +86,24 @@ const getCoverArtUrl = (record, size, square) => { } else if (record.sync !== undefined) { // This is a playlist return baseUrl(url('getCoverArt', 'pl-' + record.id, options)) + } else if (record.streamUrl !== undefined) { + // This is a radio station + return baseUrl(url('getCoverArt', 'ra-' + record.id, options)) } else { return baseUrl(url('getCoverArt', 'ar-' + record.id, options)) } } +const getDiscCoverArtUrl = (albumId, discNumber, updatedAt, size) => { + const options = { + ...(updatedAt && { _: updatedAt }), + ...(size && { size }), + } + return baseUrl( + url('getCoverArt', 'dc-' + albumId + ':' + discNumber, options), + ) +} + const getArtistInfo = (id) => { return httpClient(url('getArtistInfo', id)) } @@ -123,6 +142,7 @@ export default { getScanStatus, getNowPlaying, getCoverArtUrl, + getDiscCoverArtUrl, getAvatarUrl, streamUrl, getAlbumInfo, diff --git a/ui/src/subsonic/index.test.js b/ui/src/subsonic/index.test.js index 1e0fbeaa6..38b910b08 100644 --- a/ui/src/subsonic/index.test.js +++ b/ui/src/subsonic/index.test.js @@ -1,4 +1,5 @@ import { vi } from 'vitest' +import { COVER_ART_SIZE } from '../consts' import subsonic from './index' describe('getCoverArtUrl', () => { @@ -30,10 +31,10 @@ describe('getCoverArtUrl', () => { updatedAt: '2023-01-01T00:00:00Z', } - const url = subsonic.getCoverArtUrl(playlistRecord, 300, true) + const url = subsonic.getCoverArtUrl(playlistRecord, COVER_ART_SIZE, true) expect(url).toContain('pl-playlist-123') - expect(url).toContain('size=300') + expect(url).toContain('size=600') expect(url).toContain('square=true') expect(url).toContain('_=2023-01-01T00%3A00%3A00Z') }) @@ -44,10 +45,10 @@ describe('getCoverArtUrl', () => { sync: true, } - const url = subsonic.getCoverArtUrl(playlistRecord, 300, true) + const url = subsonic.getCoverArtUrl(playlistRecord, COVER_ART_SIZE, true) expect(url).toContain('pl-playlist-123') - expect(url).toContain('size=300') + expect(url).toContain('size=600') expect(url).toContain('square=true') expect(url).not.toContain('_=') }) @@ -59,10 +60,10 @@ describe('getCoverArtUrl', () => { updatedAt: '2023-01-01T00:00:00Z', } - const url = subsonic.getCoverArtUrl(albumRecord, 300, true) + const url = subsonic.getCoverArtUrl(albumRecord, COVER_ART_SIZE, true) expect(url).toContain('al-album-123') - expect(url).toContain('size=300') + expect(url).toContain('size=600') expect(url).toContain('square=true') }) @@ -73,10 +74,10 @@ describe('getCoverArtUrl', () => { updatedAt: '2023-01-01T00:00:00Z', } - const url = subsonic.getCoverArtUrl(songRecord, 300, true) + const url = subsonic.getCoverArtUrl(songRecord, COVER_ART_SIZE, true) expect(url).toContain('mf-song-123') - expect(url).toContain('size=300') + expect(url).toContain('size=600') expect(url).toContain('square=true') }) @@ -86,10 +87,10 @@ describe('getCoverArtUrl', () => { updatedAt: '2023-01-01T00:00:00Z', } - const url = subsonic.getCoverArtUrl(artistRecord, 300, true) + const url = subsonic.getCoverArtUrl(artistRecord, COVER_ART_SIZE, true) expect(url).toContain('ar-artist-123') - expect(url).toContain('size=300') + expect(url).toContain('size=600') expect(url).toContain('square=true') }) @@ -105,6 +106,56 @@ describe('getCoverArtUrl', () => { }) }) +describe('getDiscCoverArtUrl', () => { + beforeEach(() => { + const localStorageMock = { + getItem: vi.fn((key) => { + const values = { + username: 'testuser', + 'subsonic-token': 'testtoken', + 'subsonic-salt': 'testsalt', + } + return values[key] || null + }), + } + Object.defineProperty(window, 'localStorage', { value: localStorageMock }) + }) + + it('should construct URL with dc-albumId:discNumber format, size, and cache param', () => { + const url = subsonic.getDiscCoverArtUrl( + 'album-123', + 2, + '2023-01-01T00:00:00Z', + 48, + ) + + expect(url).toContain('getCoverArt') + expect(url).toContain('id=dc-album-123%3A2') + expect(url).toContain('size=48') + expect(url).toContain('_=2023-01-01T00%3A00%3A00Z') + }) + + it('should handle missing updatedAt', () => { + const url = subsonic.getDiscCoverArtUrl('album-123', 1, undefined, 48) + + expect(url).toContain('id=dc-album-123%3A1') + expect(url).toContain('size=48') + expect(url).not.toContain('_=') + }) + + it('should handle missing size', () => { + const url = subsonic.getDiscCoverArtUrl( + 'album-123', + 1, + '2023-01-01T00:00:00Z', + ) + + expect(url).toContain('id=dc-album-123%3A1') + expect(url).toContain('_=2023-01-01T00%3A00%3A00Z') + expect(url).not.toContain('size=') + }) +}) + describe('getAvatarUrl', () => { beforeEach(() => { // Mock localStorage values required by subsonic diff --git a/ui/src/themes/SquiddiesGlass.css.js b/ui/src/themes/SquiddiesGlass.css.js new file mode 100644 index 000000000..2c8e4f1d6 --- /dev/null +++ b/ui/src/themes/SquiddiesGlass.css.js @@ -0,0 +1,175 @@ +const stylesheet = ` + +.react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-handle { + background: #c231ab +} +.react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-track, +.react-jinke-music-player-mobile-progress .rc-slider-track { + background: linear-gradient(to left, #c231ab, #380eff) +} + +.react-jinke-music-player-mobile { + background-color: #171717 !important; +} + +.react-jinke-music-player-mobile-progress .rc-slider-handle { + background: #c231ab; + height: 20px; + width: 20px; + margin-top: -9px; +} + +.react-jinke-music-player-main ::-webkit-scrollbar-thumb { + background-color: #c231ab; +} + +.react-jinke-music-player-pause-icon { + background-color: #c231ab; + border-radius: 50%; + outline: auto; + color: white; +} +.react-jinke-music-player-main .music-player-panel .panel-content .player-content { + z-index: 99999; +} +.react-jinke-music-player-main .music-player-panel .panel-content .player-content .play-btn svg { + border-radius: 50%; + outline: auto; + color: white; +} +.react-jinke-music-player-main .music-player-panel .panel-content .player-content .play-btn svg:hover { + background-color: #c231ab; + border-radius: 50%; + outline: auto; + color: white; +} + +.react-jinke-music-player-main svg:hover { + color: #c231ab; +} + +.react-jinke-music-player .music-player-controller { + color: #c231ab; + border: 1px solid #e14ac2; +} + +.react-jinke-music-player .music-player-controller.music-player-playing:before { + border: 1px solid rgba(194, 49, 171, 0.3); +} + +.react-jinke-music-player .music-player .destroy-btn { + background-color: #c2c1c2; + top: -7px; + border-radius: 50%; + display: flex; +} + +.react-jinke-music-player .music-player .destroy-btn svg { + font-size: 20px; +} + +@media screen and (max-width: 767px) { + .react-jinke-music-player .music-player .destroy-btn { + right: -12px; + } +} + +.react-jinke-music-player-mobile-header-right { + right: 0; + top: 0; +} + +@media screen and (max-width: 767px) { + .react-jinke-music-player-main svg { + font-size: 32px; + } +} + +@keyframes gradientFlow { + 0% { background-position: 0% 50%; } + 50% { background-position: 100% 50%; } + 100% { background-position: 0% 50%; } +} + +.RaBulkActionsToolbar .MuiButton-label { + color: white; +} + +a[aria-current="page"] { + color: #c231ab !important; + font-weight: bold; +} + +a[aria-current="page"] .MuiListItemIcon-root { + color: #c231ab !important; +} + +.panel-content { + position: relative; + overflow: hidden; + background: linear-gradient(90deg, #311f2f, #0a0912, #2f0c28); + background-size: 300% 300%; + animation: gradientFlow 10s ease-in-out infinite; +} + +/* Equalizer bars */ +.panel-content::before { + content: ""; + position: absolute; + inset: 0; + background: repeating-linear-gradient( + 90deg, + rgba(255, 255, 255, 0.05) 0px, + rgba(255, 255, 255, 0.05) 2px, + transparent 1px, + transparent 3px + ); + animation: equalizer 1.8s infinite ease-in-out; + filter: blur(1px); + opacity: 0.5; +} + +@keyframes backgroundFlow { + 0% { + background-position: 0% 50%; + } + 50% { + background-position: 100% 50%; + } + 100% { + background-position: 0% 50%; + } +} + +/* Vertical movement, equalizer type */ +@keyframes equalizer { + 0%, 100% { + transform: scaleY(1); + opacity: 0.2; + } + 25% { + transform: scaleY(1.4); + opacity: 0.9; + } + 50% { + transform: scaleY(0.7); + opacity: 0.2; + } + 75% { + transform: scaleY(1.2); + opacity: 0.8; + } +} + +@keyframes pulse { + 0% { opacity: 0.5; } + 100% { opacity: 1; } +} + +@keyframes spin { + from { transform: rotate(0deg); } + to { transform: rotate(360deg); } +} +` + +export default stylesheet diff --git a/ui/src/themes/SquiddiesGlass.js b/ui/src/themes/SquiddiesGlass.js new file mode 100644 index 000000000..5c3844074 --- /dev/null +++ b/ui/src/themes/SquiddiesGlass.js @@ -0,0 +1,608 @@ +import stylesheet from './SquiddiesGlass.css.js' + +/** + * Color constants used throughout the Squiddies Glass theme. + * Provides a consistent color palette with pink, gray, purple, and basic colors. + * @type {Object} + */ +const colors = { + pink: { + 100: '#fbe3f4', + 200: '#f5b9e3', + 300: '#ec7cd6', + 400: '#e14ac2', + 500: '#c231ab', // base + 600: '#a31a92', + 700: '#8b0f7e', + 800: '#7a006d', + 900: '#670066', + }, + gray: { + 50: '#c2c1c2', + 100: '#b3b3b3', // light gray + 200: '#282828', // medium dark + 300: '#1d1d1d', // darker + 400: '#181818', // even darker + 500: '#171717', // darkest + }, + purple: { + 400: '#524590', + 500: '#4d3249', + 600: '#6d1c5e', + }, + black: '#000', + white: '#fff', + dark: '#121212', +} + +/** + * Shared style object for music list action buttons. + * Defines common styling for buttons in music lists, including hover effects and responsive scaling. + * @type {Object} + */ +const musicListActions = { + padding: '1rem 0', + alignItems: 'center', + '@global': { + button: { + border: '1px solid transparent', + backgroundColor: 'inherit', + color: colors.gray[100], + '&:hover': { + border: `1px solid ${colors.gray[100]}`, + backgroundColor: 'inherit !important', + }, + }, + 'button:first-child:not(:only-child)': { + '@media screen and (max-width: 720px)': { + transform: 'scale(1.3)', + margin: '1em', + '&:hover': { + transform: 'scale(1.2) !important', + }, + }, + transform: 'scale(1.3)', + margin: '1em', + minWidth: 0, + padding: 5, + transition: 'transform .3s ease', + background: colors.pink[500], + color: `${colors.black} !important`, + borderRadius: 500, + border: 0, + '&:hover': { + transform: 'scale(1.2)', + backgroundColor: `${colors.pink[500]} !important`, + border: 0, + }, + }, + 'button:only-child': { + marginTop: '0.3em', + }, + 'button:first-child>span:first-child': { + padding: 0, + color: `${colors.black} !important`, + }, + 'button:first-child>span:first-child>span': { + display: 'none', + }, + 'button>span:first-child>span, button:not(:first-child)>span:first-child>svg': + { + color: colors.gray[100], + }, + }, +} + +/** + * Squiddies Glass theme configuration object. + * Defines the complete theme structure including typography, palette, component overrides, and player settings. + * @type {Object} + */ +export default { + /** + * The name of the theme. + * @type {string} + */ + themeName: 'Squiddies Glass', + + /** + * Typography settings for the theme. + * Specifies font family and heading sizes. + * @type {Object} + */ + typography: { + fontFamily: "system-ui, 'Helvetica Neue', Helvetica, Arial, sans-serif", + h6: { + fontSize: '1rem', // AppBar title + }, + }, + + /** + * Color palette configuration. + * Defines primary, secondary, and background colors for the theme. + * @type {Object} + */ + palette: { + primary: { + light: colors.pink[300], + main: colors.pink[500], + }, + secondary: { + main: colors.white, + contrastText: colors.white, + }, + background: { + default: colors.dark, + paper: colors.dark, + }, + type: 'dark', + }, + + /** + * Component overrides for Material-UI and custom Navidrome components. + * Customizes the appearance and behavior of various UI components. + * @type {Object} + */ + overrides: { + // Material-UI Components + MuiAppBar: { + positionFixed: { + backgroundColor: `${colors.black} !important`, + boxShadow: 'none', + }, + }, + MuiButton: { + root: { + background: colors.pink[500], + color: colors.white, + border: '1px solid transparent', + borderRadius: 500, + '&:hover': { + background: `${colors.pink[900]} !important`, + }, + }, + textSecondary: { + border: `1px solid ${colors.gray[100]}`, + background: colors.black, + '&:hover': { + border: `1px solid ${colors.white} !important`, + background: `${colors.black} !important`, + }, + }, + label: { + color: colors.white, + paddingRight: '1rem', + paddingLeft: '0.7rem', + }, + }, + MuiCardMedia: { + root: { + position: 'relative', + overflow: 'hidden', + boxShadow: `0 2px 32px rgba(0,0,0,0.5), 0px 1px 5px rgba(0,0,0,0.1)`, + }, + }, + MuiDivider: { + root: { + margin: '.75rem 0', + }, + }, + MuiDrawer: { + root: { + background: colors.gray[500], + paddingTop: '10px', + }, + }, + MuiFormGroup: { + root: { + color: colors.pink[500], + }, + }, + MuiMenuItem: { + root: { + fontSize: '0.875rem', + }, + }, + MuiTableCell: { + root: { + borderBottom: `1px solid ${colors.gray[300]}`, + padding: '10px !important', + color: `${colors.gray[100]} !important`, + '& img': { + filter: + 'brightness(0) saturate(100%) invert(36%) sepia(93%) saturate(7463%) hue-rotate(289deg) brightness(95%) contrast(102%);', + }, + '& img + span': { + color: colors.pink[500], + }, + }, + head: { + borderBottom: `1px solid ${colors.gray[200]}`, + fontSize: '0.75rem', + textTransform: 'uppercase', + letterSpacing: 1.2, + }, + }, + MuiTableRow: { + root: { + padding: '10px 0', + transition: 'background-color .3s ease', + '&:hover': { + backgroundColor: `${colors.gray[300]} !important`, + }, + '@global': { + 'td:nth-child(4)': { + color: `${colors.white} !important`, + }, + }, + }, + }, + + // React Admin Components + RaBulkActionsToolbar: { + topToolbar: { + gap: '8px', + }, + }, + RaFilter: { + form: { + '& .MuiOutlinedInput-input:-webkit-autofill': { + '-webkit-box-shadow': `0 0 0 100px ${colors.gray[50]} inset`, + '-webkit-text-fill-color': colors.white, + }, + }, + }, + RaFilterButton: { + root: { + marginRight: '1rem', + }, + }, + RaLayout: { + content: { + padding: '0 !important', + background: `linear-gradient(${colors.dark}, ${colors.gray[500]})`, + borderTopRightRadius: '8px', + borderTopLeftRadius: '8px', + }, + contentWithSidebar: { + gap: '2px', + }, + }, + RaList: { + content: { + backgroundColor: 'inherit', + }, + bulkActionsDisplayed: { + marginTop: '-20px', + }, + }, + RaListToolbar: { + toolbar: { + padding: '0 .55rem !important', + }, + }, + RaPaginationActions: { + currentPageButton: { + border: `1px solid ${colors.gray[100]}`, + }, + button: { + backgroundColor: 'inherit', + minWidth: 48, + margin: '0 4px', + border: `1px solid ${colors.gray[200]}`, + '@global': { + '> .MuiButton-label': { + padding: 0, + }, + }, + }, + actions: { + '@global': { + '.next-page': { + marginLeft: 8, + marginRight: 8, + }, + '.previous-page': { + marginRight: 8, + }, + }, + }, + }, + RaSearchInput: { + input: { + paddingLeft: '.9rem', + border: 0, + '& .MuiInputBase-root': { + backgroundColor: `${colors.white} !important`, + borderRadius: '20px !important', + color: colors.black, + border: '0px', + '& fieldset': { + borderColor: colors.white, + }, + '&:hover fieldset': { + borderColor: colors.white, + }, + '&.Mui-focused fieldset': { + borderColor: colors.white, + }, + '& svg': { + color: `${colors.black} !important`, + }, + '& .MuiOutlinedInput-input:-webkit-autofill': { + borderRadius: '20px 0px 0px 20px', + '-webkit-box-shadow': `0 0 0 100px ${colors.gray[50]} inset`, + '-webkit-text-fill-color': colors.black, + }, + }, + }, + }, + RaSidebar: { + root: { + height: 'initial', + borderTopRightRadius: '8px', + borderTopLeftRadius: '8px', + }, + }, + + // Navidrome Custom Components + NDAlbumDetails: { + root: { + boxShadow: 'none', + background: `linear-gradient(45deg, ${colors.purple[500]}, ${colors.purple[400]}, ${colors.purple[600]})`, + backgroundSize: '200% 200%', + animation: 'gradientFlow 8s ease-in-out infinite', + position: 'relative', + '&:before': { + content: '""', + position: 'absolute', + top: '0', + left: '0', + width: '100%', + height: '100%', + background: `linear-gradient(to bottom, transparent, ${colors.dark})`, + }, + }, + cardContents: { + alignItems: 'flex-start', + }, + coverParent: { + zIndex: '99999', + position: 'relative', + backgroundColor: 'rgba(0, 0, 0, 0.5)', + '&::before': { + content: '""', + position: 'absolute', + inset: '0', + width: '100%', + height: '100%', + borderRadius: '50%', + animation: 'pulse 1.5s ease-in-out infinite alternate', + zIndex: -1, + }, + '&::after': { + content: '""', + position: 'absolute', + inset: '0', + zIndex: '-1', + borderRadius: '50%', + background: + 'repeating-conic-gradient(from 0deg, rgba(255,255,255,0.08) 0deg, rgba(255,255,255,0.08) 0.5deg, rgba(0,0,0,1) 1deg)', + filter: 'contrast(999) sepia(1)', + boxShadow: + 'inset 0 0 25px rgba(255,255,255,0.05), inset 0 0 95px rgba(0,0,0,0.9)', + animation: 'spin 6s linear infinite', + }, + }, + details: { + zIndex: '99999', + }, + recordName: { + fontSize: 'calc(1rem + 1.5vw)', + fontWeight: 900, + }, + recordArtist: { + fontSize: '1.5rem', + fontWeight: 700, + textShadow: '0 2px 16px rgba(0, 0, 0, 0.3)', + }, + recordMeta: { + fontSize: '.875rem', + color: `rgba(${colors.white}, 0.8)`, + }, + content: { + paddingBottom: '0px !important', + paddingTop: '0px', + }, + }, + RaSingleFieldList: { + root: { + '& a:first-of-type > .MuiChip-root': { + marginLeft: '0px', + }, + '& a > .MuiChip-root': { + backgroundColor: colors.pink[500], + fontSize: '0.6rem', + height: '20px', + '& .MuiChip-label': { + color: colors.white, + paddingLeft: '5px', + paddingRight: '5px', + }, + }, + }, + }, + MuiGridListTile: { + tile: { + '&:hover': { + boxShadow: '0 2px 32px rgba(0,0,0,0.5), 0px 1px 5px rgba(0,0,0,0.1)', + }, + }, + }, + NDAlbumGridView: { + tileBar: { + background: + 'linear-gradient(to top, rgba(0, 0, 0, 0.7) 0%, rgba(0, 0, 0, 0.4) 50%, rgba(0, 0, 0, 0) 100%)', + marginBottom: '2px', + }, + albumName: { + marginTop: '0.5rem', + fontWeight: 700, + textTransform: 'none', + color: colors.white, + }, + albumSubtitle: { + color: colors.gray[100], + }, + albumContainer: { + backgroundColor: colors.gray[400], + borderRadius: '.5rem', + padding: '.75rem', + transition: 'background-color .3s ease', + '&:hover': { + backgroundColor: colors.gray[200], + }, + }, + albumPlayButton: { + color: colors.black, + backgroundColor: colors.pink[500], + borderRadius: '50%', + boxShadow: '0 8px 8px rgb(0 0 0 / 30%)', + padding: '0.35rem', + transition: 'padding .3s ease', + '&:hover': { + background: `${colors.pink[500]} !important`, + padding: '0.45rem', + }, + }, + }, + NDAlbumShow: { + albumActions: musicListActions, + }, + NDArtistShow: { + actions: { + padding: '2rem 0', + alignItems: 'center', + overflow: 'visible', + minHeight: '120px', + '@global': { + button: { + border: '1px solid transparent', + backgroundColor: 'inherit', + color: colors.gray[100], + margin: '0 0.5rem', + '&:hover': { + border: `1px solid ${colors.gray[100]}`, + backgroundColor: 'inherit !important', + }, + }, + // Hide shuffle button label (first button) + 'button:first-child>span:first-child>span': { + display: 'none', + }, + // Style shuffle button (first button) + 'button:first-child': { + '@media screen and (max-width: 720px)': { + transform: 'scale(1.5)', + margin: '1rem', + '&:hover': { + transform: 'scale(1.6) !important', + }, + }, + transform: 'scale(2)', + margin: '1.5rem', + minWidth: 0, + padding: 5, + transition: 'transform .3s ease', + background: colors.pink[500], + color: colors.white, + borderRadius: 500, + border: 0, + '&:hover': { + transform: 'scale(2.1)', + backgroundColor: `${colors.pink[500]} !important`, + border: 0, + }, + }, + 'button:first-child>span:first-child': { + padding: 0, + color: `${colors.black} !important`, + }, + 'button>span:first-child>span, button:not(:first-child)>span:first-child>svg': + { + color: colors.gray[100], + }, + }, + }, + actionsContainer: { + overflow: 'visible', + }, + }, + NDAudioPlayer: { + audioTitle: { + color: colors.white, + fontSize: '1.5rem', + '& span:nth-child(3)': { + fontSize: '0.8rem', + }, + }, + songTitle: { + fontWeight: 900, + }, + songInfo: { + fontSize: '0.9rem', + color: colors.gray[100], + }, + }, + NDCollapsibleComment: { + commentBlock: { + fontSize: '.875rem', + color: `rgba(${colors.white}, 0.8)`, + }, + }, + NDLogin: { + main: { + boxShadow: `inset 0 0 0 2000px rgba(${colors.black}, .75)`, + }, + systemNameLink: { + color: colors.white, + }, + card: { + border: `1px solid ${colors.gray[200]}`, + }, + avatar: { + marginBottom: 0, + }, + }, + NDPlaylistDetails: { + container: { + background: `linear-gradient(${colors.gray[300]}, transparent)`, + borderRadius: 0, + paddingTop: '2.5rem !important', + boxShadow: 'none', + }, + title: { + fontSize: 'calc(1.5rem + 1.5vw)', + fontWeight: 700, + color: colors.white, + }, + details: { + fontSize: '.875rem', + color: `rgba(${colors.white}, 0.8)`, + }, + }, + NDPlaylistShow: { + playlistActions: musicListActions, + }, + }, + + /** + * Player configuration settings. + * Specifies the player theme and associated stylesheet. + * @type {Object} + */ + player: { + theme: 'dark', + stylesheet, + }, +} diff --git a/ui/src/themes/amusic.css.js b/ui/src/themes/amusic.css.js new file mode 100644 index 000000000..dcdd8bee8 --- /dev/null +++ b/ui/src/themes/amusic.css.js @@ -0,0 +1,92 @@ +const stylesheet = ` +.react-jinke-music-player-main .music-player-panel svg { + color: #eee +} +.react-jinke-music-player-main .music-player-panel button:disabled svg { + opacity: 0.3 +} +.react-jinke-music-player-main svg:active, .react-jinke-music-player-main svg:hover { + color: #D60017 +} +.react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-handle, +.react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-track { + background-color: #ff4e6b +} +.react-jinke-music-player-main ::-webkit-scrollbar-thumb, +.react-jinke-music-player-mobile-progress .rc-slider-handle, +.react-jinke-music-player-mobile-progress .rc-slider-track { + background-color: #ff4e6b +} +.react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-handle:active { + box-shadow: 0 0 2px #ff4e6b +} +.audio-lists-panel-content .audio-item.playing, +.react-jinke-music-player-main .audio-item.playing svg, +.react-jinke-music-player-main .group player-delete { + color: #ff4e6b +} +.audio-lists-panel-content .audio-item:hover, +.audio-lists-panel-content .audio-item:hover svg +.audio-lists-panel-content .audio-item:active .group:not([class=".player-delete"]) svg, .audio-lists-panel-content .audio-item:hover .group:not([class=".player-delete"]) svg{ + color: #D60017 +} +.react-jinke-music-player-main .audio-item.playing .player-singer { + color: #ff4e6b !important +} +.react-jinke-music-player-main .lyric-btn-active svg{ + color: #ff4e6b !important +} +.react-jinke-music-player-main .lyric-btn-active { + color: #D60017 !important +} +.react-jinke-music-player-main .loading svg { + color: #ff4e6b !important +} +.react-jinke-music-player .music-player-controller .music-player-controller-setting{ + background: #ff4e6b4d +} +.react-jinke-music-player-main .music-player-lyric{ + color: #ff4e6b !important; + text-shadow: -1px -1px 0 #000, 1px -1px 0 #000, -1px 1px 0 #000, 1px 1px 0 #000 +} +.react-jinke-music-player-main .music-player-panel, +.react-jinke-music-player-mobile, +.ril__outer{ + background-color: #1a1a1a; + border: 1px solid #fff1; +} +.ril__toolbarItem{ + font-size: 100%; + color: #eee +} +.audio-lists-panel, +.ril__toolbar{ + background-color: #1f1f1f; + border: 1px solid #fff1; + border-radius: 6px 6px 0 0; +} +.react-jinke-music-player-main .music-player-panel .panel-content .img-rotate, +.react-jinke-music-player-mobile .react-jinke-music-player-mobile-cover img.cover, +.react-jinke-music-player-mobile-cover { + border-radius: 6px !important; + animation-duration: 0s !important +} +.react-jinke-music-player-main .music-player-panel .panel-content .img-content{ + width: 60px; + height: 60px +} +.react-jinke-music-player-main .songTitle{ + color: #eee +} +.react-jinke-music-player .music-player-controller{ + color: #ff4e6b +} +.audio-lists-panel-mobile .audio-item:not(.audio-lists-panel-sortable-highlight-bg){ + background: unset +} +.lastfm-icon, +.musicbrainz-icon{ + color: #eee +} +` +export default stylesheet diff --git a/ui/src/themes/amusic.js b/ui/src/themes/amusic.js new file mode 100644 index 000000000..74f7d3fd4 --- /dev/null +++ b/ui/src/themes/amusic.js @@ -0,0 +1,239 @@ +import stylesheet from './amusic.css.js' + +export default { + themeName: 'AMusic', + typography: { + fontFamily: + '-apple-system, BlinkMacSystemFont, Apple Color Emoji, SF Pro, SF Pro Icons, Helvetica Neue, Helvetica, Arial, sans-serif', + h6: { + fontSize: '1rem', // AppBar title + }, + h5: { + fontSize: '2em', + fontWeight: '600', + }, + }, + palette: { + primary: { + main: '#ff4e6b', + }, + secondary: { + main: '#D60017', + contrastText: '#eee', + }, + background: { + default: '#1a1a1a', + paper: '#1a1a1a', + }, + type: 'dark', + }, + overrides: { + MuiFormGroup: { + root: { + color: 'white', + }, + }, + MuiAppBar: { + positionFixed: { + backgroundColor: '#1d1d1d !important', + boxShadow: 'none', + borderBottom: '1px solid #fff1', + }, + colorSecondary: { + color: '#eee', + }, + }, + MuiDrawer: { + root: { + background: '#1d1d1d', + borderRight: '1px solid #fff1', + }, + }, + MuiToolbar: { + root: { + background: 'transparent !important', + }, + }, + MuiCardMedia: { + img: { + borderRadius: '10px', + boxShadow: '5px 5px 20px #111', + }, + }, + MuiButton: { + root: { + background: '#D60017', + color: '#fff', + borderRadius: '6px', + paddingRight: '0.5rem', + paddingLeft: '0.5rem', + marginLeft: '0.5rem', + marginBottom: '0.5rem', + textTransform: 'capitalize', + fontWeight: 600, + }, + textPrimary: { + color: '#eee', + }, + textSecondary: { + color: '#eee', + backgroundColor: '#ff4e6b', + }, + textSizeSmall: { + fontSize: '0.8rem', + paddingRight: '0.5rem', + paddingLeft: '0.5rem', + }, + label: { + paddingRight: '1rem', + paddingLeft: '0.7rem', + }, + }, + MuiListItemIcon: { + root: { + color: '#ff4e6b', + }, + }, + MuiChip: { + root: { + borderRadius: '6px', + }, + }, + MuiIconButton: { + root: { + color: '#ff4e6b', + }, + }, + MuiTableBody: { + root: { + '&>tr:nth-child(odd)': { + background: 'rgba(255, 255, 255, 0.025)', + }, + }, + }, + MuiTableRow: { + root: { + background: 'transparent', + }, + }, + MuiTableCell: { + root: { + borderBottom: '0 none !important', + padding: '10px !important', + color: '#b3b3b3 !important', + }, + head: { + color: '#b3b3b3 !important', + }, + }, + MuiMenuItem: { + root: { + fontSize: '0.875rem', + borderRadius: '10px', + color: '#eee', + }, + }, + NDAlbumGridView: { + albumName: { + color: '#eee', + }, + albumPlayButton: { + color: '#ff4e6b', + }, + albumArtistName: { + color: '#ccc', + }, + cover: { + borderRadius: '6px', + }, + }, + NDLogin: { + systemNameLink: { + color: '#ff4e6b', + }, + welcome: { + color: '#eee', + }, + card: { + minWidth: 300, + backgroundColor: '#1d1d1d', + }, + icon: { + filter: 'hue-rotate(115deg)', + }, + }, + MuiPaper: { + elevation1: { + boxShadow: 'none', + }, + root: { + color: '#eee', + }, + rounded: { + borderRadius: '6px', + }, + }, + NDMobileArtistDetails: { + bgContainer: { + background: '#1a1a1a', + }, + artistName: { + fontWeight: '600', + fontSize: '2em', + }, + }, + NDDesktopArtistDetails: { + artistName: { + fontWeight: '600', + fontSize: '2em', + }, + artistDetail: { + padding: 'unset', + paddingBottom: '1rem', + }, + }, + RaDeleteWithConfirmButton: { + deleteButton: { + color: '#fff !important', + }, + }, + RaDeleteWithUndoButton: { + deleteButton: { + color: '#fff !important', + }, + }, + RaBulkDeleteWithConfirmButton: { + deleteButton: { + color: '#fff !important', + }, + }, + RaBulkDeleteWithUndoButton: { + deleteButton: { + color: '#fff !important', + }, + }, + RaPaginationActions: { + currentPageButton: { + border: '2px solid #D60017', + background: 'transparent', + }, + button: { + border: '2px solid #D60017', + }, + actions: { + '@global': { + '.next-page': { + border: '0 none', + }, + '.previous-page': { + border: '0 none', + }, + }, + }, + }, + }, + player: { + theme: 'dark', + stylesheet, + }, +} diff --git a/ui/src/themes/dark.js b/ui/src/themes/dark.js index 2f06b4337..15d8aa365 100644 --- a/ui/src/themes/dark.js +++ b/ui/src/themes/dark.js @@ -16,6 +16,11 @@ export default { color: 'white', }, }, + MuiButton: { + textPrimary: { + color: '#fff', + }, + }, NDLogin: { systemNameLink: { color: '#0085ff', diff --git a/ui/src/themes/dracula.css.js b/ui/src/themes/dracula.css.js new file mode 100644 index 000000000..0e837be24 --- /dev/null +++ b/ui/src/themes/dracula.css.js @@ -0,0 +1,181 @@ +const stylesheet = ` + +/* Icon hover: pink */ +.react-jinke-music-player-main svg:active, .react-jinke-music-player-main svg:hover { + color: #ff79c6 +} + +/* Progress bar: purple */ +.react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-handle, .react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-track { + background-color: #bd93f9 +} + +/* Volume bar: green */ +.sound-operation .rc-slider-handle, .sound-operation .rc-slider-track { + background-color: #50fa7b !important +} + +.sound-operation .rc-slider-handle:active { + box-shadow: 0 0 2px #50fa7b !important +} + +/* Scrollbar: comment */ +.react-jinke-music-player-main ::-webkit-scrollbar-thumb { + background-color: #6272a4; +} + +.react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-handle:active { + box-shadow: 0 0 2px #bd93f9 +} + +/* Now playing icon: cyan */ +.react-jinke-music-player-main .audio-item.playing svg { + color: #8be9fd +} + +/* Now playing artist: cyan */ +.react-jinke-music-player-main .audio-item.playing .player-singer { + color: #8be9fd !important +} + +/* Loading spinner: orange */ +.react-jinke-music-player-main .loading svg { + color: #ffb86c !important +} + +.react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-handle { + border: hidden; + box-shadow: rgba(20, 21, 28, 0.25) 0px 4px 6px, rgba(20, 21, 28, 0.1) 0px 5px 7px; +} + +.rc-slider-rail, .rc-slider-track { + height: 6px; +} + +.rc-slider { + padding: 3px 0; +} + +.sound-operation > div:nth-child(4) { + transform: translateX(-50%) translateY(5%) !important; +} + +.sound-operation { + padding: 4px 0; +} + +/* Player panel background */ +.react-jinke-music-player-main .music-player-panel { + background-color: #282a36; + color: #f8f8f2; + box-shadow: 0 0 8px rgba(0, 0, 0, 0.25); +} + +/* Song title in player: foreground */ +.react-jinke-music-player-main .music-player-panel .panel-content .player-content .audio-title { + color: #f8f8f2; +} + +/* Duration/time text: yellow */ +.react-jinke-music-player-main .music-player-panel .panel-content .player-content .duration, .react-jinke-music-player-main .music-player-panel .panel-content .player-content .current-time { + color: #f1fa8c +} + +/* Audio list panel */ +.audio-lists-panel { + background-color: #282a36; + bottom: 6.25rem; + box-shadow: rgba(20, 21, 28, 0.25) 0px 4px 6px, rgba(20, 21, 28, 0.1) 0px 5px 7px; +} + +.audio-lists-panel-content .audio-item.playing { + background-color: transparent; +} + +.audio-lists-panel-content .audio-item:nth-child(2n+1) { + background-color: transparent; +} + +/* Playlist hover: current line */ +.audio-lists-panel-content .audio-item:active, +.audio-lists-panel-content .audio-item:hover { + background-color: #44475a; +} + +.audio-lists-panel-header { + border-bottom: 1px solid rgba(0, 0, 0, 0.25); + box-shadow: none; +} + +/* Playlist header text: orange */ +.audio-lists-panel-header-title { + color: #ffb86c; +} + +.react-jinke-music-player-main .music-player-panel .panel-content .player-content .audio-lists-btn { + background-color: transparent; + box-shadow: none; +} + +.audio-lists-panel-content .audio-item { + line-height: 32px; +} + +.react-jinke-music-player-main .music-player-panel .panel-content .img-content { + box-shadow: rgba(20, 21, 28, 0.25) 0px 4px 6px, rgba(20, 21, 28, 0.1) 0px 5px 7px; +} + +/* Lyrics: yellow */ +.react-jinke-music-player-main .music-player-lyric { + color: #f1fa8c; + -webkit-text-stroke: 0.5px #282a36; + font-weight: bolder; +} + +/* Lyric button active: yellow */ +.react-jinke-music-player-main .lyric-btn-active, .react-jinke-music-player-main .lyric-btn-active svg { + color: #f1fa8c !important; +} + +/* Playlist now playing: cyan */ +.audio-lists-panel-content .audio-item.playing, .audio-lists-panel-content .audio-item.playing svg { + color: #8be9fd +} + +/* Playlist hover icons: pink */ +.audio-lists-panel-content .audio-item:active .group:not(.player-delete) svg, .audio-lists-panel-content .audio-item:hover .group:not(.player-delete) svg { + color: #ff79c6 +} + +.audio-lists-panel-content .audio-item .player-icons { + scale: 75%; +} + +/* Mobile */ + +.react-jinke-music-player-mobile-cover { + border: none; + box-shadow: rgba(20, 21, 28, 0.25) 0px 4px 6px, rgba(20, 21, 28, 0.1) 0px 5px 7px; +} + +.react-jinke-music-player .music-player-controller { + border: none; + box-shadow: rgba(20, 21, 28, 0.25) 0px 4px 6px, rgba(20, 21, 28, 0.1) 0px 5px 7px; + color: #bd93f9; +} + +.react-jinke-music-player .music-player-controller .music-player-controller-setting { + color: rgba(189, 147, 249, 0.3); +} + +/* Mobile progress: green */ +.react-jinke-music-player-mobile-progress .rc-slider-handle, .react-jinke-music-player-mobile-progress .rc-slider-track { + background-color: #50fa7b; +} + +.react-jinke-music-player-mobile-progress .rc-slider-handle { + border: none; +} +` + +export default stylesheet diff --git a/ui/src/themes/dracula.js b/ui/src/themes/dracula.js new file mode 100644 index 000000000..2e4ae38e5 --- /dev/null +++ b/ui/src/themes/dracula.js @@ -0,0 +1,397 @@ +import stylesheet from './dracula.css.js' + +// Dracula color palette +const background = '#282a36' +const currentLine = '#44475a' +const foreground = '#f8f8f2' +const comment = '#6272a4' +const cyan = '#8be9fd' +const green = '#50fa7b' +const pink = '#ff79c6' +const purple = '#bd93f9' +const orange = '#ffb86c' +const red = '#ff5555' +const yellow = '#f1fa8c' + +// Darker shade for surfaces +const surface = '#21222c' + +// For Album, Playlist play button +const musicListActions = { + alignItems: 'center', + '@global': { + 'button:first-child:not(:only-child)': { + '@media screen and (max-width: 720px)': { + transform: 'scale(1.5)', + margin: '1rem', + '&:hover': { + transform: 'scale(1.6) !important', + }, + }, + transform: 'scale(2)', + margin: '1.5rem', + minWidth: 0, + padding: 5, + transition: 'transform .3s ease', + backgroundColor: `${green} !important`, + color: background, + borderRadius: 500, + border: 0, + '&:hover': { + transform: 'scale(2.1)', + backgroundColor: `${green} !important`, + border: 0, + }, + }, + 'button:only-child': { + margin: '1.5rem', + }, + 'button:first-child>span:first-child': { + padding: 0, + }, + 'button:first-child>span:first-child>span': { + display: 'none', + }, + 'button>span:first-child>span, button:not(:first-child)>span:first-child>svg': + { + color: foreground, + }, + }, +} + +export default { + themeName: 'Dracula', + palette: { + primary: { + main: purple, + }, + secondary: { + main: currentLine, + contrastText: foreground, + }, + error: { + main: red, + }, + type: 'dark', + background: { + default: background, + paper: surface, + }, + }, + overrides: { + MuiPaper: { + root: { + color: foreground, + backgroundColor: surface, + }, + }, + MuiAppBar: { + positionFixed: { + backgroundColor: `${currentLine} !important`, + boxShadow: + 'rgba(20, 21, 28, 0.25) 0px 4px 6px, rgba(20, 21, 28, 0.1) 0px 5px 7px', + }, + }, + MuiDrawer: { + root: { + background: background, + }, + }, + MuiButton: { + textPrimary: { + color: purple, + }, + textSecondary: { + color: foreground, + }, + }, + MuiIconButton: { + root: { + color: foreground, + }, + }, + MuiChip: { + root: { + backgroundColor: currentLine, + }, + }, + MuiFormGroup: { + root: { + color: foreground, + }, + }, + MuiFormLabel: { + root: { + color: comment, + '&$focused': { + color: purple, + }, + }, + }, + MuiToolbar: { + root: { + backgroundColor: `${surface} !important`, + }, + }, + MuiOutlinedInput: { + root: { + '& $notchedOutline': { + borderColor: currentLine, + }, + '&:hover $notchedOutline': { + borderColor: comment, + }, + '&$focused $notchedOutline': { + borderColor: purple, + }, + }, + }, + MuiFilledInput: { + root: { + backgroundColor: currentLine, + '&:hover': { + backgroundColor: comment, + }, + '&$focused': { + backgroundColor: currentLine, + }, + }, + }, + MuiTableRow: { + root: { + transition: 'background-color .3s ease', + '&:hover': { + backgroundColor: `${currentLine} !important`, + }, + }, + }, + MuiTableHead: { + root: { + color: foreground, + background: surface, + }, + }, + MuiTableCell: { + root: { + color: foreground, + background: `${surface} !important`, + borderBottom: `1px solid ${currentLine}`, + }, + head: { + color: `${yellow} !important`, + background: `${currentLine} !important`, + }, + body: { + color: `${foreground} !important`, + }, + }, + MuiSwitch: { + colorSecondary: { + '&$checked': { + color: green, + }, + '&$checked + $track': { + backgroundColor: green, + }, + }, + }, + NDAlbumGridView: { + albumName: { + marginTop: '0.5rem', + fontWeight: 700, + color: foreground, + }, + albumSubtitle: { + color: comment, + }, + albumContainer: { + backgroundColor: surface, + borderRadius: '8px', + padding: '.75rem', + transition: 'background-color .3s ease', + '&:hover': { + backgroundColor: currentLine, + }, + }, + albumPlayButton: { + backgroundColor: green, + borderRadius: '50%', + boxShadow: '0 8px 8px rgb(0 0 0 / 30%)', + padding: '0.35rem', + transition: 'padding .3s ease', + '&:hover': { + background: `${green} !important`, + padding: '0.45rem', + }, + }, + }, + NDPlaylistDetails: { + container: { + background: `linear-gradient(${currentLine}, transparent)`, + borderRadius: 0, + paddingTop: '2.5rem !important', + boxShadow: 'none', + }, + title: { + fontWeight: 700, + color: foreground, + }, + details: { + fontSize: '.875rem', + color: comment, + }, + }, + NDAlbumDetails: { + root: { + background: `linear-gradient(${currentLine}, transparent)`, + borderRadius: 0, + boxShadow: 'none', + }, + cardContents: { + alignItems: 'center', + paddingTop: '1.5rem', + }, + recordName: { + fontWeight: 700, + color: foreground, + }, + recordArtist: { + fontSize: '.875rem', + fontWeight: 700, + color: pink, + }, + recordMeta: { + fontSize: '.875rem', + color: comment, + }, + }, + NDCollapsibleComment: { + commentBlock: { + fontSize: '.875rem', + color: comment, + }, + }, + NDAlbumShow: { + albumActions: musicListActions, + }, + NDPlaylistShow: { + playlistActions: musicListActions, + }, + NDAudioPlayer: { + audioTitle: { + color: foreground, + fontSize: '0.875rem', + }, + songTitle: { + fontWeight: 400, + }, + songInfo: { + fontSize: '0.675rem', + color: comment, + }, + }, + NDLogin: { + systemNameLink: { + color: purple, + }, + welcome: { + color: foreground, + }, + card: { + minWidth: 300, + background: background, + }, + button: { + boxShadow: '3px 3px 5px #191a21', + }, + }, + NDMobileArtistDetails: { + bgContainer: { + background: `linear-gradient(to bottom, rgba(40 42 54 / 72%), ${surface})!important`, + }, + }, + RaLayout: { + content: { + padding: '0 !important', + background: surface, + }, + root: { + backgroundColor: background, + }, + }, + RaList: { + content: { + backgroundColor: surface, + }, + }, + RaListToolbar: { + toolbar: { + backgroundColor: background, + padding: '0 .55rem !important', + }, + }, + RaSidebar: { + fixed: { + backgroundColor: background, + }, + drawerPaper: { + backgroundColor: `${background} !important`, + }, + }, + MuiTableSortLabel: { + root: { + color: `${yellow} !important`, + '&:hover': { + color: `${orange} !important`, + }, + '&$active': { + color: `${orange} !important`, + '&& $icon': { + color: `${orange} !important`, + }, + }, + }, + }, + RaMenuItemLink: { + root: { + color: foreground, + '&[aria-current="page"]': { + color: `${pink} !important`, + }, + '&[aria-current="page"] .MuiListItemIcon-root': { + color: `${pink} !important`, + }, + }, + active: { + color: `${pink} !important`, + '& .MuiListItemIcon-root': { + color: `${pink} !important`, + }, + }, + }, + RaLink: { + link: { + color: cyan, + }, + }, + RaButton: { + button: { + margin: '0 5px 0 5px', + }, + }, + RaPaginationActions: { + currentPageButton: { + border: `2px solid ${purple}`, + }, + button: { + backgroundColor: currentLine, + minWidth: 48, + margin: '0 4px', + }, + }, + }, + player: { + theme: 'dark', + stylesheet, + }, +} diff --git a/ui/src/themes/gruvboxDark.js b/ui/src/themes/gruvboxDark.js index b576e7713..20f5c732f 100644 --- a/ui/src/themes/gruvboxDark.js +++ b/ui/src/themes/gruvboxDark.js @@ -40,6 +40,11 @@ export default { color: '#ebdbb2', }, }, + MuiIconButton: { + root: { + color: '#ebdbb2', + }, + }, MuiChip: { clickable: { background: '#49483e', @@ -92,6 +97,16 @@ export default { boxShadow: '3px 3px 5px #3c3836', }, }, + MuiSwitch: { + colorSecondary: { + '&$checked': { + color: '#458588', + }, + '&$checked + $track': { + backgroundColor: '#458588', + }, + }, + }, NDMobileArtistDetails: { bgContainer: { background: diff --git a/ui/src/themes/index.js b/ui/src/themes/index.js index 857b54cb9..f65948438 100644 --- a/ui/src/themes/index.js +++ b/ui/src/themes/index.js @@ -9,8 +9,12 @@ import ElectricPurpleTheme from './electricPurple' import NordTheme from './nord' import GruvboxDarkTheme from './gruvboxDark' import CatppuccinMacchiatoTheme from './catppuccinMacchiato' +import DraculaTheme from './dracula' import NuclearTheme from './nuclear' import NutballTheme from './nutball' +import AmusicTheme from './amusic' +import SquiddiesGlassTheme from './SquiddiesGlass' +import NautilineTheme from './nautiline' export default { // Classic default themes @@ -18,15 +22,19 @@ export default { DarkTheme, // New themes should be added here, in alphabetic order + AmusicTheme, CatppuccinMacchiatoTheme, + DraculaTheme, ElectricPurpleTheme, ExtraDarkTheme, GreenTheme, GruvboxDarkTheme, LigeraTheme, MonokaiTheme, + NautilineTheme, NordTheme, NuclearTheme, NutballTheme, SpotifyTheme, + SquiddiesGlassTheme, } diff --git a/ui/src/themes/ligera.js b/ui/src/themes/ligera.js index 824cf7e67..363a379bc 100644 --- a/ui/src/themes/ligera.js +++ b/ui/src/themes/ligera.js @@ -70,7 +70,7 @@ export default { }, background: { default: '#f0f2f5', - paper: 'inherit', + paper: bLight['500'], }, text: { secondary: '#232323', @@ -448,15 +448,28 @@ export default { backgroundColor: bLight['500'], }, }, + RaButton: { + button: { + margin: '0 5px 0 5px', + }, + }, RaPaginationActions: { button: { - backgroundColor: 'inherit', + backgroundColor: '#fff', + color: '#000', minWidth: 48, margin: '0 4px', - border: '1px solid #282828', + border: '1px solid #cccccc', '@global': { '> .MuiButton-label': { padding: 0, + color: '#656565', + '&:hover': { + color: '#fff !important', + }, + }, + '> .MuiButton-label > svg': { + color: '#656565', }, }, }, diff --git a/ui/src/themes/nautiline.js b/ui/src/themes/nautiline.js new file mode 100644 index 000000000..65ded5fc5 --- /dev/null +++ b/ui/src/themes/nautiline.js @@ -0,0 +1,906 @@ +/** + * Nautiline Theme for Navidrome + * Light theme inspired by the Nautiline iOS app + */ + +// ============================================ +// CONFIGURATION +// ============================================ + +const ACCENT_COLOR = '#009688' // Material teal +const UNBOUNDED_FONT_PATH = 'fonts/Unbounded-Variable.woff2' + +// ============================================ +// DESIGN TOKENS +// ============================================ + +const hexToRgb = (hex) => { + const result = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(hex) + return result + ? { + r: parseInt(result[1], 16), + g: parseInt(result[2], 16), + b: parseInt(result[3], 16), + } + : null +} + +const rgb = hexToRgb(ACCENT_COLOR) +const rgba = (alpha) => + rgb ? `rgba(${rgb.r}, ${rgb.g}, ${rgb.b}, ${alpha})` : 'transparent' + +const tokens = { + colors: { + accent: { + main: ACCENT_COLOR, + faded: rgba(0.1), + hover: rgba(0.15), + }, + background: { + primary: '#FFFFFF', + secondary: '#F5F5F7', + tertiary: '#E5E5EA', + }, + text: { + primary: '#1A1A1A', + secondary: '#8E8E93', + tertiary: '#AEAEB2', + }, + ui: { + separator: 'rgba(0, 0, 0, 0.08)', + shadow: 'rgba(0, 0, 0, 0.04)', + glassBg: 'rgba(255, 255, 255, 0.72)', + }, + }, + typography: { + fontFamily: { + base: [ + '-apple-system', + 'BlinkMacSystemFont', + '"SF Pro Text"', + '"Helvetica Neue"', + 'Arial', + 'sans-serif', + ].join(','), + heading: '"Unbounded", sans-serif', + }, + fontFace: ` + @font-face { + font-family: 'Unbounded'; + font-style: normal; + font-weight: 300 800; + font-display: swap; + src: url('${UNBOUNDED_FONT_PATH}') format('woff2'); + } + `, + }, + spacing: { + xs: '0.25rem', + sm: '0.5rem', + md: '0.75rem', + lg: '1rem', + xl: '1.5rem', + }, + radii: { + sm: '0.25rem', + md: '0.5rem', + lg: '0.625rem', + xl: '0.75rem', + full: '50%', + pill: '1rem', + }, + breakpoints: { + xs: 599, + sm: 600, + md: 720, + lg: 1280, + }, + sizing: { + cover: { + sm: '14em', + lg: '18em', + }, + icon: '1.25rem', + iconMinWidth: '2.5rem', + }, + blur: '1.25rem', +} + +const { colors, typography, spacing, radii, sizing, breakpoints } = tokens + +// ============================================ +// REUSABLE STYLE FACTORIES +// ============================================ + +const headingStyle = (weight, letterSpacing) => ({ + fontFamily: typography.fontFamily.heading, + fontWeight: weight, + ...(letterSpacing && { letterSpacing }), +}) + +const coverSizing = () => ({ + [`@media (min-width: ${breakpoints.sm}px)`]: { + height: sizing.cover.sm, + width: sizing.cover.sm, + minWidth: sizing.cover.sm, + }, + [`@media (min-width: ${breakpoints.lg}px)`]: { + height: sizing.cover.lg, + width: sizing.cover.lg, + minWidth: sizing.cover.lg, + }, +}) + +const customTooltipStyle = () => ({ + display: 'inline', + position: 'absolute', + bottom: '100%', + left: '50%', + transform: 'translateX(-50%)', + marginBottom: spacing.xs, + fontSize: '0.75rem', + whiteSpace: 'nowrap', + backgroundColor: colors.text.primary, + color: colors.background.primary, + padding: `${spacing.xs} ${spacing.sm}`, + borderRadius: radii.sm, + zIndex: 9999, +}) + +const actionButtonsStyle = () => ({ + padding: `${spacing.lg} 0`, + alignItems: 'center', + '@global': { + button: { + border: '1px solid transparent', + backgroundColor: colors.background.secondary, + color: colors.text.secondary, + margin: `0 ${spacing.sm}`, + borderRadius: radii.full, + minWidth: 0, + padding: spacing.lg, + position: 'relative', + '&:hover': { + backgroundColor: `${colors.background.tertiary} !important`, + border: '1px solid transparent', + }, + }, + 'button:first-child:not(:only-child)': { + [`@media screen and (max-width: ${breakpoints.md}px)`]: { + transform: 'scale(1.5)', + margin: spacing.lg, + '&:hover': { + transform: 'scale(1.6) !important', + }, + }, + transform: 'scale(2)', + margin: spacing.xl, + minWidth: 0, + padding: '0.3125rem', + transition: 'transform .3s ease', + background: colors.accent.main, + color: '#fff', + borderRadius: radii.full, + border: 0, + '&:hover': { + transform: 'scale(2.1)', + backgroundColor: `${colors.accent.main} !important`, + border: 0, + }, + }, + 'button:only-child': { + margin: spacing.xl, + }, + 'button:first-child>span:first-child': { + padding: 0, + }, + 'button>span:first-child>span': { + display: 'none', + }, + 'button:not(:first-child):hover>span:first-child>span': + customTooltipStyle(), + 'button:not(:first-child)>span:first-child>svg': { + color: colors.text.secondary, + }, + }, +}) + +const menuIconStyle = () => ({ + color: colors.text.primary, + minWidth: sizing.iconMinWidth, + '& svg': { + fontSize: sizing.icon, + }, +}) + +const activeLinkStyle = { + color: `${colors.accent.main} !important`, + '& .MuiListItemIcon-root': { + color: `${colors.accent.main} !important`, + }, +} + +// ============================================ +// THEME DEFINITION +// ============================================ + +// Note: !important declarations are required to override react-admin and third-party component styles +const NautilineTheme = { + themeName: 'Nautiline', + palette: { + type: 'light', + primary: { + main: colors.accent.main, + contrastText: '#FFFFFF', + }, + secondary: { + main: colors.accent.main, + contrastText: '#FFFFFF', + }, + background: { + default: colors.background.primary, + paper: colors.background.primary, + }, + text: { + primary: colors.text.primary, + secondary: colors.text.secondary, + }, + action: { + active: colors.accent.main, + hover: colors.accent.faded, + selected: colors.accent.faded, + }, + }, + typography: { + fontFamily: typography.fontFamily.base, + h1: headingStyle(700, '-0.02em'), + h2: headingStyle(700, '-0.02em'), + h3: headingStyle(600, '-0.01em'), + h4: headingStyle(600), + h5: headingStyle(600), + h6: headingStyle(600), + subtitle1: { fontWeight: 500 }, + subtitle2: { fontWeight: 500 }, + body1: { fontWeight: 400 }, + body2: { fontWeight: 400 }, + button: { fontWeight: 500, textTransform: 'none' }, + }, + shape: { + borderRadius: radii.xl, + }, + overrides: { + MuiCssBaseline: { + '@global': { + '@font-face': { + fontFamily: 'Unbounded', + fontStyle: 'normal', + fontWeight: '300 800', + fontDisplay: 'swap', + src: `url('${UNBOUNDED_FONT_PATH}') format('woff2')`, + }, + body: { + backgroundColor: colors.background.primary, + }, + }, + }, + MuiAppBar: { + root: { + boxShadow: 'none', + borderBottom: `1px solid ${colors.ui.separator}`, + }, + colorSecondary: { + backgroundColor: colors.background.primary, + color: colors.text.primary, + }, + }, + MuiToolbar: { + root: { + backgroundColor: colors.background.primary, + }, + }, + MuiPaper: { + root: { + backgroundColor: colors.background.primary, + }, + elevation1: { + boxShadow: `0 0.0625rem 0.1875rem ${colors.ui.shadow}`, + }, + elevation2: { + boxShadow: `0 0.125rem ${spacing.sm} ${colors.ui.shadow}`, + }, + }, + MuiCard: { + root: { + backgroundColor: colors.background.primary, + borderRadius: radii.xl, + boxShadow: `0 0.125rem ${spacing.sm} ${colors.ui.shadow}`, + }, + }, + MuiButton: { + root: { + borderRadius: radii.md, + textTransform: 'none', + fontWeight: 600, + }, + contained: { + boxShadow: 'none', + '&:hover': { boxShadow: 'none' }, + }, + containedPrimary: { + backgroundColor: colors.accent.main, + '&:hover': { + backgroundColor: colors.accent.main, + filter: 'brightness(0.9)', + }, + }, + text: { + color: colors.accent.main, + }, + }, + MuiIconButton: { + root: { + color: colors.text.primary, + '&:hover': { + backgroundColor: colors.accent.faded, + }, + }, + colorPrimary: { + color: colors.accent.main, + }, + sizeSmall: { + padding: spacing.md, + }, + }, + MuiSvgIcon: { + colorPrimary: { + color: colors.accent.main, + }, + }, + MuiCheckbox: { + root: { + color: 'rgba(0, 0, 0, 0.15)', + '&$checked': { + color: colors.accent.main, + }, + }, + }, + MuiChip: { + root: { + backgroundColor: colors.background.secondary, + color: colors.text.primary, + borderRadius: radii.pill, + }, + colorPrimary: { + backgroundColor: colors.accent.faded, + color: colors.accent.main, + }, + }, + MuiTableRow: { + root: { + '&:hover': { + backgroundColor: `${colors.accent.faded} !important`, + }, + }, + }, + MuiTableCell: { + root: { + borderBottomColor: 'rgba(0, 0, 0, 0.04)', + }, + head: { + backgroundColor: colors.background.secondary, + color: colors.text.secondary, + fontWeight: 600, + fontSize: '0.75rem', + textTransform: 'uppercase', + letterSpacing: '0.05em', + }, + body: { + color: colors.text.primary, + }, + }, + MuiListItem: { + root: { + color: colors.text.primary, + '&:hover': { + backgroundColor: colors.accent.faded, + }, + '&$selected': { + backgroundColor: colors.accent.faded, + color: colors.accent.main, + '& .MuiListItemIcon-root': { + color: colors.accent.main, + }, + '&:hover': { + backgroundColor: colors.accent.faded, + }, + }, + }, + button: { + color: colors.text.primary, + '&:hover': { + backgroundColor: colors.accent.faded, + color: colors.text.primary, + }, + }, + }, + MuiListItemIcon: { + root: menuIconStyle(), + }, + MuiListItemText: { + primary: { + color: 'inherit', + }, + }, + MuiMenuItem: { + root: { + fontSize: '0.875rem', + paddingTop: '4px', + paddingBottom: '4px', + paddingLeft: '10px', + margin: '5px', + borderRadius: radii.md, + color: colors.text.primary, + }, + }, + MuiDrawer: { + paper: { + backgroundColor: colors.background.primary, + borderRight: `1px solid ${colors.ui.separator}`, + }, + }, + MuiSlider: { + root: { + color: colors.accent.main, + }, + track: { + backgroundColor: colors.accent.main, + }, + thumb: { + backgroundColor: colors.accent.main, + '&:hover': { + boxShadow: `0 0 0 ${spacing.sm} ${colors.accent.faded}`, + }, + }, + rail: { + backgroundColor: colors.background.tertiary, + }, + }, + MuiLinearProgress: { + root: { + backgroundColor: colors.background.tertiary, + borderRadius: radii.sm, + }, + bar: { + backgroundColor: colors.accent.main, + borderRadius: radii.sm, + }, + }, + MuiTabs: { + root: { + borderBottom: `1px solid ${colors.ui.separator}`, + }, + indicator: { + backgroundColor: colors.accent.main, + height: '0.1875rem', + borderRadius: '0.1875rem 0.1875rem 0 0', + }, + }, + MuiTab: { + root: { + textTransform: 'none', + fontWeight: 500, + fontFamily: typography.fontFamily.heading, + '&$selected': { + color: colors.accent.main, + fontWeight: 600, + }, + }, + }, + MuiInputBase: { + root: { + backgroundColor: colors.background.secondary, + borderRadius: radii.lg, + }, + }, + MuiOutlinedInput: { + root: { + borderRadius: radii.lg, + '& $notchedOutline': { + borderColor: colors.ui.separator, + }, + '&:hover $notchedOutline': { + borderColor: colors.text.tertiary, + }, + '&$focused $notchedOutline': { + borderColor: colors.accent.main, + borderWidth: '0.125rem', + }, + }, + }, + MuiFilledInput: { + root: { + backgroundColor: colors.background.secondary, + borderRadius: radii.lg, + '&:hover': { + backgroundColor: colors.background.tertiary, + }, + '&$focused': { + backgroundColor: colors.background.secondary, + }, + }, + }, + MuiFab: { + primary: { + backgroundColor: colors.accent.main, + '&:hover': { + backgroundColor: colors.accent.main, + filter: 'brightness(0.9)', + }, + }, + }, + MuiAvatar: { + root: { + borderRadius: radii.md, + }, + }, + MuiRating: { + iconFilled: { + color: colors.accent.main, + }, + iconHover: { + color: colors.accent.main, + }, + }, + MuiTooltip: { + tooltip: { + backgroundColor: colors.text.primary, + color: colors.background.primary, + fontSize: '0.75rem', + padding: `${spacing.xs} ${spacing.sm}`, + borderRadius: radii.sm, + }, + }, + MuiBottomNavigation: { + root: { + backgroundColor: colors.ui.glassBg, + backdropFilter: `blur(${tokens.blur})`, + borderTop: `1px solid ${colors.ui.separator}`, + }, + }, + MuiBottomNavigationAction: { + root: { + color: colors.text.secondary, + '&$selected': { + color: colors.accent.main, + }, + }, + label: { + fontFamily: typography.fontFamily.heading, + fontSize: '0.65rem', + '&$selected': { + fontSize: '0.65rem', + }, + }, + }, + NDAppBar: { + root: { + color: colors.text.primary, + }, + }, + NDLogin: { + main: { + backgroundColor: colors.background.primary, + }, + card: { + backgroundColor: colors.background.primary, + borderRadius: radii.pill, + boxShadow: `0 ${spacing.xs} ${spacing.xl} ${colors.ui.shadow}`, + }, + }, + NDAlbumGridView: { + albumContainer: { + borderRadius: radii.md, + '& img': { + borderRadius: radii.md, + }, + }, + albumTitle: { + fontWeight: 600, + color: colors.text.primary, + }, + albumSubtitle: { + color: colors.text.secondary, + }, + albumPlayButton: { + backgroundColor: colors.accent.main, + borderRadius: radii.full, + boxShadow: `0 ${spacing.sm} ${spacing.sm} rgba(0, 0, 0, 0.15)`, + padding: '0.35rem', + transition: 'padding .3s ease', + '&:hover': { + backgroundColor: `${colors.accent.main} !important`, + padding: '0.45rem', + }, + }, + }, + NDAlbumDetails: { + root: { + [`@media (max-width: ${breakpoints.xs}px)`]: { + padding: '0.7em', + width: '100%', + minWidth: 'unset', + }, + }, + cardContents: { + [`@media (max-width: ${breakpoints.xs}px)`]: { + flexDirection: 'column', + alignItems: 'center', + }, + }, + details: { + [`@media (max-width: ${breakpoints.xs}px)`]: { + width: '100%', + }, + }, + cover: { + borderRadius: radii.md, + }, + coverParent: { + marginRight: spacing.xl, + [`@media (max-width: ${breakpoints.xs}px)`]: { + width: '100%', + height: 'auto', + minWidth: 'unset', + aspectRatio: '1', + marginRight: 0, + marginBottom: spacing.lg, + }, + ...coverSizing(), + }, + recordName: { + fontSize: '1.75rem', + fontWeight: 700, + marginBottom: '0.15rem', + }, + recordArtist: { + marginBottom: spacing.md, + }, + recordMeta: { + marginBottom: spacing.sm, + }, + genreList: { + marginTop: spacing.md, + }, + loveButton: { + marginLeft: spacing.sm, + }, + }, + NDAlbumShow: { + albumActions: actionButtonsStyle(), + }, + NDPlaylistShow: { + playlistActions: actionButtonsStyle(), + }, + NDSubMenu: { + icon: menuIconStyle(), + menuHeader: { + color: colors.text.primary, + '& .MuiTypography-root': { + color: colors.text.primary, + }, + }, + actionIcon: { + marginLeft: spacing.sm, + }, + }, + RaMenuItemLink: { + root: { + color: `${colors.text.primary} !important`, + '& .MuiListItemIcon-root': menuIconStyle(), + '&[class*="makeStyles-active"]': activeLinkStyle, + }, + active: activeLinkStyle, + }, + NDDesktopArtistDetails: { + root: { + [`@media (min-width: ${breakpoints.sm}px)`]: { + padding: '1em', + }, + [`@media (min-width: ${breakpoints.lg}px)`]: { + padding: '1em', + }, + }, + cover: { + borderRadius: radii.md, + ...coverSizing(), + }, + artistImage: { + borderRadius: radii.md, + marginRight: spacing.xl, + [`@media (min-width: ${breakpoints.sm}px)`]: { + height: sizing.cover.sm, + width: sizing.cover.sm, + minWidth: sizing.cover.sm, + maxHeight: sizing.cover.sm, + minHeight: sizing.cover.sm, + }, + [`@media (min-width: ${breakpoints.lg}px)`]: { + height: sizing.cover.lg, + width: sizing.cover.lg, + minWidth: sizing.cover.lg, + maxHeight: sizing.cover.lg, + minHeight: sizing.cover.lg, + }, + }, + artistName: { + fontSize: '1.75rem', + fontWeight: 700, + marginBottom: spacing.sm, + }, + }, + NDMobileArtistDetails: { + cover: { + borderRadius: radii.md, + }, + artistImage: { + borderRadius: radii.md, + }, + }, + RaList: { + content: { + overflow: 'visible', + }, + }, + RaBulkActionsToolbar: { + topToolbar: { + backgroundColor: 'transparent', + boxShadow: 'none', + padding: spacing.sm, + '@global': { + button: { + border: '1px solid transparent', + backgroundColor: colors.background.secondary, + color: colors.text.secondary, + margin: `0 ${spacing.xs}`, + borderRadius: radii.full, + minWidth: 0, + padding: spacing.sm, + position: 'relative', + '&:hover': { + backgroundColor: `${colors.background.tertiary} !important`, + border: '1px solid transparent', + }, + }, + 'button>span:first-child>span': { + display: 'none', + }, + 'button:hover>span:first-child>span': customTooltipStyle(), + 'button>span:first-child>svg': { + color: colors.text.secondary, + }, + }, + }, + }, + RaPaginationActions: { + currentPageButton: { + backgroundColor: colors.accent.faded, + }, + }, + }, + player: { + theme: 'light', + stylesheet: ` + @font-face { + font-family: 'Unbounded'; + font-style: normal; + font-weight: 300 800; + font-display: swap; + src: url('${UNBOUNDED_FONT_PATH}') format('woff2'); + } + + .react-jinke-music-player-main { + background-color: ${colors.background.primary} !important; + font-family: ${typography.fontFamily.base} !important; + } + + .react-jinke-music-player-main .music-player-panel { + background-color: ${colors.ui.glassBg} !important; + backdrop-filter: blur(${tokens.blur}) !important; + -webkit-backdrop-filter: blur(${tokens.blur}) !important; + border-top: 1px solid ${colors.ui.separator} !important; + box-shadow: 0 -0.125rem 1.25rem rgba(0, 0, 0, 0.06) !important; + } + + .react-jinke-music-player-main svg { + color: ${colors.text.primary} !important; + } + + .react-jinke-music-player-main svg:hover { + color: ${colors.accent.main} !important; + } + + .react-jinke-music-player-main .rc-slider-track, + .react-jinke-music-player-main .rc-slider-handle { + background-color: ${colors.accent.main} !important; + } + + .react-jinke-music-player-main .rc-slider-handle { + border-color: ${colors.accent.main} !important; + } + + .react-jinke-music-player-main .rc-slider-rail { + background-color: ${colors.background.secondary} !important; + } + + .react-jinke-music-player-main .rc-slider { + height: 4px !important; + } + + .react-jinke-music-player-main .rc-slider-rail, + .react-jinke-music-player-main .rc-slider-track { + height: 4px !important; + border-radius: 2px !important; + } + + .react-jinke-music-player-main .rc-slider-handle { + width: 12px !important; + height: 12px !important; + margin-top: -4px !important; + } + + .react-jinke-music-player-main .audio-lists-panel, + .react-jinke-music-player-main .audio-lists-panel-content { + background-color: ${colors.background.primary} !important; + } + + .react-jinke-music-player-main .audio-lists-panel-content .audio-item { + background-color: transparent !important; + color: ${colors.text.primary} !important; + } + + .react-jinke-music-player-main .audio-lists-panel-content .audio-item:hover { + background-color: ${colors.accent.faded} !important; + } + + .react-jinke-music-player-main .audio-lists-panel-content .audio-item.playing { + background-color: ${colors.accent.faded} !important; + color: ${colors.accent.main} !important; + } + + .react-jinke-music-player-main .lyric-btn-active, + .react-jinke-music-player-main .play-mode-title { + color: ${colors.accent.main} !important; + } + + .react-jinke-music-player-main .music-player-panel .player-content .music-player-controller .music-player-info .music-player-title { + color: ${colors.text.primary} !important; + font-weight: 600 !important; + font-family: ${typography.fontFamily.heading} !important; + } + + .react-jinke-music-player-main .music-player-panel .player-content .music-player-controller .music-player-info .music-player-artist { + color: ${colors.text.secondary} !important; + } + + .react-jinke-music-player-main.mini-player { + background-color: ${colors.ui.glassBg} !important; + backdrop-filter: blur(${tokens.blur}) !important; + -webkit-backdrop-filter: blur(${tokens.blur}) !important; + border-radius: ${radii.xl} !important; + box-shadow: 0 ${spacing.xs} 1.25rem rgba(0, 0, 0, 0.08) !important; + } + + + .MuiTypography-h1, + .MuiTypography-h2, + .MuiTypography-h3, + .MuiTypography-h4, + .MuiTypography-h5, + .MuiTypography-h6 { + font-family: ${typography.fontFamily.heading} !important; + } + `, + }, +} + +export default NautilineTheme diff --git a/ui/src/themes/spotify.js b/ui/src/themes/spotify.js index c40ed20aa..725831cc7 100644 --- a/ui/src/themes/spotify.js +++ b/ui/src/themes/spotify.js @@ -389,6 +389,11 @@ export default { marginRight: '1rem', }, }, + RaButton: { + button: { + margin: '0 5px 0 5px', + }, + }, RaPaginationActions: { currentPageButton: { border: '1px solid #b3b3b3', diff --git a/ui/src/themes/useCurrentTheme.js b/ui/src/themes/useCurrentTheme.js index 9793d1e15..0d986033d 100644 --- a/ui/src/themes/useCurrentTheme.js +++ b/ui/src/themes/useCurrentTheme.js @@ -42,6 +42,12 @@ const useCurrentTheme = () => { document.head.removeChild(style) } } + + // Set body background color to match theme (fixes white background on pull-to-refresh) + const isDark = theme.palette?.type === 'dark' + const bgColor = + theme.palette?.background?.default || (isDark ? '#303030' : '#fafafa') + document.body.style.backgroundColor = bgColor }, [theme]) return theme diff --git a/ui/src/themes/useCurrentTheme.test.jsx b/ui/src/themes/useCurrentTheme.test.jsx index 03775d34f..65c3be8c6 100644 --- a/ui/src/themes/useCurrentTheme.test.jsx +++ b/ui/src/themes/useCurrentTheme.test.jsx @@ -15,6 +15,10 @@ function createMatchMedia(theme) { }) } +beforeEach(() => { + document.body.style.backgroundColor = '' +}) + describe('useCurrentTheme', () => { describe('with user preference theme as light', () => { beforeAll(() => { @@ -117,4 +121,44 @@ describe('useCurrentTheme', () => { expect(result.current.themeName).toMatch('Spotify-ish') }) }) + describe('body background color', () => { + beforeAll(() => { + window.matchMedia = createMatchMedia('dark') + }) + it('sets body background for dark theme', () => { + renderHook(() => useCurrentTheme(), { + wrapper: ({ children }) => ( + <Provider store={createStore(themeReducer, { theme: 'DarkTheme' })}> + {children} + </Provider> + ), + }) + // Dark theme uses MUI default dark background + expect(document.body.style.backgroundColor).toBe('rgb(48, 48, 48)') + }) + it('sets body background for light theme', () => { + renderHook(() => useCurrentTheme(), { + wrapper: ({ children }) => ( + <Provider store={createStore(themeReducer, { theme: 'LightTheme' })}> + {children} + </Provider> + ), + }) + // Light theme uses MUI default light background + expect(document.body.style.backgroundColor).toBe('rgb(250, 250, 250)') + }) + it('sets body background for theme with custom background', () => { + renderHook(() => useCurrentTheme(), { + wrapper: ({ children }) => ( + <Provider + store={createStore(themeReducer, { theme: 'SpotifyTheme' })} + > + {children} + </Provider> + ), + }) + // Spotify theme has explicit background.default: #121212 + expect(document.body.style.backgroundColor).toBe('rgb(18, 18, 18)') + }) + }) }) diff --git a/ui/src/transcode/browserProfile.js b/ui/src/transcode/browserProfile.js new file mode 100644 index 000000000..d268af7c9 --- /dev/null +++ b/ui/src/transcode/browserProfile.js @@ -0,0 +1,80 @@ +// Each entry: { codec name for the server, container, mime: [MIME probe strings] } +export const CODEC_PROBES = [ + { codec: 'mp3', container: 'mp3', mime: ['audio/mpeg; codecs="mp3"'] }, + { codec: 'opus', container: 'ogg', mime: ['audio/ogg; codecs="opus"'] }, + { codec: 'vorbis', container: 'ogg', mime: ['audio/ogg; codecs="vorbis"'] }, + { + codec: 'flac', + container: 'flac', + mime: ['audio/flac', 'audio/flac; codecs="flac"'], + }, + { codec: 'wav', container: 'wav', mime: ['audio/wav; codecs="1"'] }, + { codec: 'alac', container: 'mp4', mime: ['audio/mp4; codecs="alac"'] }, + { codec: 'aac', container: 'mp4', mime: ['audio/mp4; codecs="mp4a.40.2"'] }, +] + +// Transcoding targets in preference order (lossless first, then lossy). +// Derived from CODEC_PROBES to avoid duplicating MIME strings. +// MP3 is always included as a universal fallback. +const TRANSCODE_CODECS = ['flac', 'opus', 'mp3'] + +// Safari transcoding is limited to mp3 only. Safari cannot reliably stream +// Ogg containers (reports canPlayType support but fails on non-seekable +// transcoded streams), and FLAC transcoding also fails in practice. +const SAFARI_TRANSCODE_CODECS = ['mp3'] + +function canPlay(audio, mimeList) { + return mimeList.some((m) => { + const result = audio.canPlayType(m) + return result === 'probably' || result === 'maybe' + }) +} + +function probeSupported(audio, probes) { + return probes.filter(({ mime }) => canPlay(audio, mime)) +} + +function isSafari() { + const ua = navigator.userAgent + return ( + ua.includes('Safari') && !ua.includes('Chrome') && !ua.includes('Chromium') + ) +} + +export function detectBrowserProfile() { + const audio = new Audio() + + const directPlayProfiles = probeSupported(audio, CODEC_PROBES).map( + ({ codec, container }) => ({ + containers: [container], + audioCodecs: [codec], + protocols: ['http'], + }), + ) + + // Build transcoding profiles from supported codecs, always keeping mp3 as fallback. + // Safari is limited to mp3 transcoding only. + const transcodeCodecs = isSafari() + ? SAFARI_TRANSCODE_CODECS + : TRANSCODE_CODECS + const transcodingProfiles = transcodeCodecs.reduce((profiles, codec) => { + const probe = CODEC_PROBES.find((p) => p.codec === codec) + if (!probe) return profiles + if (canPlay(audio, probe.mime) || codec === 'mp3') { + profiles.push({ + container: probe.container, + audioCodec: codec, + protocol: 'http', + }) + } + return profiles + }, []) + + return { + name: 'NavidromeUI', + platform: navigator.userAgent, + directPlayProfiles, + transcodingProfiles, + codecProfiles: [], + } +} diff --git a/ui/src/transcode/browserProfile.test.js b/ui/src/transcode/browserProfile.test.js new file mode 100644 index 000000000..e79b7a744 --- /dev/null +++ b/ui/src/transcode/browserProfile.test.js @@ -0,0 +1,179 @@ +import { describe, it, expect, beforeEach, vi } from 'vitest' +import { detectBrowserProfile, CODEC_PROBES } from './browserProfile' + +describe('detectBrowserProfile', () => { + let mockCanPlayType + + beforeEach(() => { + mockCanPlayType = vi.fn() + vi.stubGlobal( + 'Audio', + class { + canPlayType = mockCanPlayType + }, + ) + }) + + it('includes codecs that return "probably"', () => { + mockCanPlayType.mockImplementation((mime) => { + if (mime === 'audio/mpeg; codecs="mp3"') return 'probably' + if (mime === 'audio/ogg; codecs="opus"') return 'probably' + return '' + }) + + const profile = detectBrowserProfile() + + expect(profile.name).toBe('NavidromeUI') + expect(profile.directPlayProfiles.length).toBe(2) + + const codecs = profile.directPlayProfiles.flatMap((p) => p.audioCodecs) + expect(codecs).toContain('mp3') + expect(codecs).toContain('opus') + }) + + it('includes codecs that return "maybe"', () => { + mockCanPlayType.mockImplementation((mime) => { + if (mime === 'audio/flac') return 'maybe' + return '' + }) + + const profile = detectBrowserProfile() + const codecs = profile.directPlayProfiles.flatMap((p) => p.audioCodecs) + expect(codecs).toContain('flac') + }) + + it('excludes codecs that return empty string', () => { + mockCanPlayType.mockReturnValue('') + + const profile = detectBrowserProfile() + expect(profile.directPlayProfiles).toEqual([]) + }) + + it('sets protocol to "http" for all direct play profiles', () => { + mockCanPlayType.mockReturnValue('probably') + + const profile = detectBrowserProfile() + profile.directPlayProfiles.forEach((p) => { + expect(p.protocols).toEqual(['http']) + }) + }) + + it('filters transcoding profiles by canPlayType', () => { + mockCanPlayType.mockImplementation((mime) => { + if (mime === 'audio/mpeg; codecs="mp3"') return 'probably' + if (mime === 'audio/ogg; codecs="opus"') return 'probably' + return '' + }) + + const profile = detectBrowserProfile() + const codecs = profile.transcodingProfiles.map((p) => p.audioCodec) + expect(codecs).toEqual(['opus', 'mp3']) + expect(codecs).not.toContain('flac') + profile.transcodingProfiles.forEach((p) => { + expect(p.protocol).toBe('http') + }) + }) + + it('always includes mp3 fallback in transcoding profiles', () => { + mockCanPlayType.mockReturnValue('') + + const profile = detectBrowserProfile() + expect(profile.transcodingProfiles.length).toBe(1) + expect(profile.transcodingProfiles[0].audioCodec).toBe('mp3') + expect(profile.transcodingProfiles[0].protocol).toBe('http') + }) + + it('does not duplicate mp3 when canPlayType supports it', () => { + mockCanPlayType.mockReturnValue('probably') + + const profile = detectBrowserProfile() + const mp3Count = profile.transcodingProfiles.filter( + (p) => p.audioCodec === 'mp3', + ).length + expect(mp3Count).toBe(1) + }) + + it('preserves transcoding profile preference order', () => { + mockCanPlayType.mockReturnValue('probably') + + const profile = detectBrowserProfile() + const codecs = profile.transcodingProfiles.map((p) => p.audioCodec) + expect(codecs).toEqual(['flac', 'opus', 'mp3']) + }) + + it('sets codecProfiles to empty array', () => { + mockCanPlayType.mockReturnValue('probably') + + const profile = detectBrowserProfile() + expect(profile.codecProfiles).toEqual([]) + }) + + it('matches codec when any mime variant returns "probably"', () => { + mockCanPlayType.mockImplementation((mime) => { + if (mime === 'audio/flac; codecs="flac"') return 'probably' + return '' + }) + + const profile = detectBrowserProfile() + const codecs = profile.directPlayProfiles.flatMap((p) => p.audioCodecs) + expect(codecs).toContain('flac') + }) + + it('includes platform info', () => { + const profile = detectBrowserProfile() + expect(typeof profile.platform).toBe('string') + }) + + describe('Safari restrictions', () => { + beforeEach(() => { + // Safari reports canPlayType for Ogg as positive, but can't actually + // stream transcoded Ogg. Simulate Safari: supports everything. + mockCanPlayType.mockReturnValue('probably') + }) + + it('still includes ogg in direct play profiles on Safari', () => { + vi.stubGlobal('navigator', { + userAgent: + 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/26.2 Safari/605.1.15', + }) + + const profile = detectBrowserProfile() + const containers = profile.directPlayProfiles.flatMap((p) => p.containers) + expect(containers).toContain('ogg') + }) + + it('limits Safari transcoding to mp3 only', () => { + vi.stubGlobal('navigator', { + userAgent: + 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/26.2 Safari/605.1.15', + }) + + const profile = detectBrowserProfile() + const codecs = profile.transcodingProfiles.map((p) => p.audioCodec) + expect(codecs).toEqual(['mp3']) + }) + + it('does NOT restrict transcoding on Chrome', () => { + vi.stubGlobal('navigator', { + userAgent: + 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36', + }) + + const profile = detectBrowserProfile() + const codecs = profile.transcodingProfiles.map((p) => p.audioCodec) + expect(codecs).toContain('opus') + expect(codecs).toContain('flac') + }) + + it('applies same restrictions on iOS Safari', () => { + vi.stubGlobal('navigator', { + userAgent: + 'Mozilla/5.0 (iPhone; CPU iPhone OS 17_0 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.0 Mobile/15E148 Safari/604.1', + }) + + const profile = detectBrowserProfile() + const codecs = profile.transcodingProfiles.map((p) => p.audioCodec) + expect(codecs).toEqual(['mp3']) + }) + }) +}) diff --git a/ui/src/transcode/decisionService.js b/ui/src/transcode/decisionService.js new file mode 100644 index 000000000..9228cc882 --- /dev/null +++ b/ui/src/transcode/decisionService.js @@ -0,0 +1,111 @@ +import { jwtDecode } from 'jwt-decode' +import subsonic from '../subsonic' +import { baseUrl } from '../utils' + +// Decode the exp claim from a JWT token (no signature verification needed client-side). +// The JWT token is meant to be opaque to the client, we are only allowing ourselves to do +// this here because the UI is tightly integrated with the server; normally we would +// need to rely on the getTranscodeStream returning an error on stale tokens. +export function decodeJwtExp(token) { + try { + if (!token) return null + const payload = jwtDecode(token) + return typeof payload.exp === 'number' ? payload.exp : null + } catch { + return null + } +} + +export function createDecisionService(fetchFn) { + const cache = new Map() + let currentProfile = null + + function isFresh(entry) { + const exp = decodeJwtExp(entry.decision?.transcodeParams) + if (exp == null) return false + // exp is in seconds, Date.now() in milliseconds; 60s buffer avoids mid-request expiry + return Date.now() < (exp - 60) * 1000 + } + + function setProfile(profile) { + currentProfile = profile + } + + function getProfile() { + return currentProfile + } + + async function getDecision(songId, browserProfile) { + const profile = browserProfile || currentProfile + if (!profile) return null + + const cached = cache.get(songId) + if (cached && isFresh(cached)) { + return cached.decision + } + + const decision = await fetchFn(songId, profile) + cache.set(songId, { decision }) + return decision + } + + async function prefetchDecisions(songIds, browserProfile) { + const profile = browserProfile || currentProfile + if (!profile) return + + const uncached = songIds.filter((id) => { + const entry = cache.get(id) + return !entry || !isFresh(entry) + }) + + await Promise.allSettled( + uncached.map(async (id) => { + const decision = await fetchFn(id, profile) + cache.set(id, { decision }) + }), + ) + } + + function invalidateAll() { + cache.clear() + } + + function buildStreamUrl(songId, transcodeParams, offset) { + const params = { + mediaId: songId, + mediaType: 'song', + transcodeParams, + } + if (offset != null && offset > 0) { + params.offset = offset + } + return baseUrl(subsonic.url('getTranscodeStream', null, params)) + } + + async function resolveStreamUrl(songId) { + const decision = await getDecision(songId) + if (!decision?.transcodeParams) { + return baseUrl(subsonic.streamUrl(songId)) + } + return buildStreamUrl(songId, decision.transcodeParams) + } + + function getCachedDecision(songId) { + const entry = cache.get(songId) + if (entry && isFresh(entry)) { + return entry.decision + } + return null + } + + return { + getDecision, + getCachedDecision, + prefetchDecisions, + resolveStreamUrl, + invalidateAll, + buildStreamUrl, + setProfile, + getProfile, + } +} diff --git a/ui/src/transcode/decisionService.test.js b/ui/src/transcode/decisionService.test.js new file mode 100644 index 000000000..a2718ade9 --- /dev/null +++ b/ui/src/transcode/decisionService.test.js @@ -0,0 +1,256 @@ +import { describe, it, expect, beforeEach, vi, afterEach } from 'vitest' +import { createDecisionService, decodeJwtExp } from './decisionService' + +// Helper: create a fake JWT with a given exp (seconds since epoch) +function fakeJwt(expSeconds) { + const header = btoa(JSON.stringify({ alg: 'HS256', typ: 'JWT' })) + const payload = btoa(JSON.stringify({ exp: expSeconds })) + return `${header}.${payload}.fake-signature` +} + +// Helper: create a fake JWT with no exp claim +function fakeJwtNoExp() { + const header = btoa(JSON.stringify({ alg: 'HS256', typ: 'JWT' })) + const payload = btoa(JSON.stringify({ sub: 'test' })) + return `${header}.${payload}.fake-signature` +} + +describe('decodeJwtExp', () => { + it('extracts exp from a valid JWT', () => { + const exp = 1700000000 + expect(decodeJwtExp(fakeJwt(exp))).toBe(exp) + }) + + it('returns null for JWT without exp claim', () => { + expect(decodeJwtExp(fakeJwtNoExp())).toBeNull() + }) + + it('returns null for non-JWT string', () => { + expect(decodeJwtExp('not-a-jwt')).toBeNull() + }) + + it('returns null for empty string', () => { + expect(decodeJwtExp('')).toBeNull() + }) + + it('returns null for null/undefined', () => { + expect(decodeJwtExp(null)).toBeNull() + expect(decodeJwtExp(undefined)).toBeNull() + }) +}) + +describe('decisionService', () => { + let service + let mockFetchFn + + const fakeProfile = { + name: 'NavidromeUI', + platform: 'test', + directPlayProfiles: [], + transcodingProfiles: [], + codecProfiles: [], + } + + // Token that expires 1 hour from "now" (will be relative to fake timers) + function makeFakeDecision(expiresInMs = 3600 * 1000) { + const expSeconds = Math.floor((Date.now() + expiresInMs) / 1000) + return { + canDirectPlay: true, + canTranscode: false, + transcodeParams: fakeJwt(expSeconds), + sourceStream: { codec: 'mp3', container: 'mp3' }, + } + } + + beforeEach(() => { + localStorage.setItem('username', 'testuser') + localStorage.setItem('subsonic-token', 'testtoken') + localStorage.setItem('subsonic-salt', 'testsalt') + mockFetchFn = vi.fn().mockImplementation(() => { + return Promise.resolve(makeFakeDecision()) + }) + service = createDecisionService(mockFetchFn) + }) + + afterEach(() => { + vi.restoreAllMocks() + localStorage.clear() + }) + + describe('getDecision', () => { + it('fetches and caches a decision', async () => { + const result = await service.getDecision('song-1', fakeProfile) + expect(result.canDirectPlay).toBe(true) + expect(mockFetchFn).toHaveBeenCalledTimes(1) + expect(mockFetchFn).toHaveBeenCalledWith('song-1', fakeProfile) + + // Second call uses cache + const result2 = await service.getDecision('song-1', fakeProfile) + expect(result2).toEqual(result) + expect(mockFetchFn).toHaveBeenCalledTimes(1) + }) + + it('re-fetches after token expires', async () => { + vi.useFakeTimers() + + // Token expires in 1 hour + mockFetchFn.mockResolvedValue(makeFakeDecision(3600 * 1000)) + await service.getDecision('song-1', fakeProfile) + expect(mockFetchFn).toHaveBeenCalledTimes(1) + + // Advance past expiration + vi.advanceTimersByTime(3600 * 1000 + 1000) + await service.getDecision('song-1', fakeProfile) + expect(mockFetchFn).toHaveBeenCalledTimes(2) + vi.useRealTimers() + }) + + it('does not re-fetch before token expires', async () => { + vi.useFakeTimers() + + // Token expires in 1 hour + mockFetchFn.mockResolvedValue(makeFakeDecision(3600 * 1000)) + await service.getDecision('song-1', fakeProfile) + + // 30 minutes later — still fresh + vi.advanceTimersByTime(1800 * 1000) + await service.getDecision('song-1', fakeProfile) + expect(mockFetchFn).toHaveBeenCalledTimes(1) + vi.useRealTimers() + }) + + it('re-fetches immediately when token has no exp claim', async () => { + const noExpDecision = { + canDirectPlay: true, + canTranscode: false, + transcodeParams: fakeJwtNoExp(), + sourceStream: { codec: 'mp3', container: 'mp3' }, + } + mockFetchFn.mockResolvedValue(noExpDecision) + await service.getDecision('song-1', fakeProfile) + + // Should re-fetch because token has no exp + await service.getDecision('song-1', fakeProfile) + expect(mockFetchFn).toHaveBeenCalledTimes(2) + }) + + it('caches different songs independently', async () => { + await service.getDecision('song-1', fakeProfile) + await service.getDecision('song-2', fakeProfile) + expect(mockFetchFn).toHaveBeenCalledTimes(2) + }) + }) + + describe('getCachedDecision', () => { + it('returns null when song is not cached', () => { + expect(service.getCachedDecision('song-1')).toBeNull() + }) + + it('returns cached decision after getDecision', async () => { + await service.getDecision('song-1', fakeProfile) + const cached = service.getCachedDecision('song-1') + expect(cached).not.toBeNull() + expect(cached.canDirectPlay).toBe(true) + }) + + it('returns null after cache is invalidated', async () => { + await service.getDecision('song-1', fakeProfile) + service.invalidateAll() + expect(service.getCachedDecision('song-1')).toBeNull() + }) + + it('returns null after token expires', async () => { + vi.useFakeTimers() + mockFetchFn.mockResolvedValue(makeFakeDecision(3600 * 1000)) + await service.getDecision('song-1', fakeProfile) + + vi.advanceTimersByTime(3600 * 1000 + 1000) + expect(service.getCachedDecision('song-1')).toBeNull() + vi.useRealTimers() + }) + }) + + describe('prefetchDecisions', () => { + it('fetches decisions for uncached songs', async () => { + await service.prefetchDecisions(['song-1', 'song-2'], fakeProfile) + expect(mockFetchFn).toHaveBeenCalledTimes(2) + }) + + it('skips already cached songs', async () => { + await service.getDecision('song-1', fakeProfile) + mockFetchFn.mockClear() + + await service.prefetchDecisions(['song-1', 'song-2'], fakeProfile) + expect(mockFetchFn).toHaveBeenCalledTimes(1) + expect(mockFetchFn).toHaveBeenCalledWith('song-2', fakeProfile) + }) + + it('silently ignores fetch errors', async () => { + mockFetchFn.mockRejectedValue(new Error('network error')) + await expect( + service.prefetchDecisions(['song-1'], fakeProfile), + ).resolves.not.toThrow() + }) + }) + + describe('invalidateAll', () => { + it('clears cache so next getDecision re-fetches', async () => { + await service.getDecision('song-1', fakeProfile) + expect(mockFetchFn).toHaveBeenCalledTimes(1) + + service.invalidateAll() + + await service.getDecision('song-1', fakeProfile) + expect(mockFetchFn).toHaveBeenCalledTimes(2) + }) + }) + + describe('resolveStreamUrl', () => { + it('fetches decision and returns built URL', async () => { + service.setProfile(fakeProfile) + const url = await service.resolveStreamUrl('song-1') + expect(url).toContain('getTranscodeStream') + expect(url).toContain('mediaId=song-1') + expect(mockFetchFn).toHaveBeenCalledTimes(1) + }) + + it('falls back to stream URL when decision has no transcodeParams', async () => { + service.setProfile(fakeProfile) + mockFetchFn.mockResolvedValue({ + canDirectPlay: true, + canTranscode: false, + }) + const url = await service.resolveStreamUrl('song-1') + expect(url).toContain('stream') + expect(url).not.toContain('getTranscodeStream') + }) + + it('falls back to stream URL when decision is null', async () => { + service.setProfile(fakeProfile) + mockFetchFn.mockResolvedValue(null) + const url = await service.resolveStreamUrl('song-1') + expect(url).toContain('stream') + expect(url).not.toContain('getTranscodeStream') + }) + }) + + describe('buildStreamUrl', () => { + it('builds URL with required parameters', () => { + const url = service.buildStreamUrl('song-1', 'jwt-token-123') + expect(url).toContain('getTranscodeStream') + expect(url).toContain('mediaId=song-1') + expect(url).toContain('mediaType=song') + expect(url).toContain('transcodeParams=jwt-token-123') + }) + + it('includes offset when provided', () => { + const url = service.buildStreamUrl('song-1', 'jwt-token-123', 30) + expect(url).toContain('offset=30') + }) + + it('omits offset when not provided', () => { + const url = service.buildStreamUrl('song-1', 'jwt-token-123') + expect(url).not.toContain('offset') + }) + }) +}) diff --git a/ui/src/transcode/fetchDecision.js b/ui/src/transcode/fetchDecision.js new file mode 100644 index 000000000..1c794082b --- /dev/null +++ b/ui/src/transcode/fetchDecision.js @@ -0,0 +1,23 @@ +import subsonic from '../subsonic' +import { httpClient } from '../dataProvider' + +export async function fetchTranscodeDecision(songId, browserProfile) { + const fetchUrl = subsonic.url('getTranscodeDecision', null, { + mediaId: songId, + mediaType: 'song', + }) + + const { json } = await httpClient(fetchUrl, { + method: 'POST', + body: JSON.stringify(browserProfile), + }) + + const subsonicResponse = json['subsonic-response'] + + if (subsonicResponse.status !== 'ok') { + const err = subsonicResponse.error || {} + throw new Error(`getTranscodeDecision error: ${err.code} ${err.message}`) + } + + return subsonicResponse.transcodeDecision +} diff --git a/ui/src/transcode/fetchDecision.test.js b/ui/src/transcode/fetchDecision.test.js new file mode 100644 index 000000000..83f934f33 --- /dev/null +++ b/ui/src/transcode/fetchDecision.test.js @@ -0,0 +1,92 @@ +import { describe, it, expect, beforeEach, vi, afterEach } from 'vitest' + +// Mock httpClient before importing module under test +vi.mock('../dataProvider', () => ({ + httpClient: vi.fn(), +})) + +import { fetchTranscodeDecision } from './fetchDecision' +import { httpClient } from '../dataProvider' + +describe('fetchTranscodeDecision', () => { + const fakeProfile = { + name: 'NavidromeUI', + platform: 'test', + directPlayProfiles: [ + { containers: ['mp3'], audioCodecs: ['mp3'], protocols: ['http'] }, + ], + transcodingProfiles: [], + codecProfiles: [], + } + + const fakeJson = { + 'subsonic-response': { + status: 'ok', + transcodeDecision: { + canDirectPlay: true, + canTranscode: false, + transcodeParams: 'jwt-token', + sourceStream: { codec: 'mp3' }, + }, + }, + } + + beforeEach(() => { + localStorage.setItem('username', 'testuser') + localStorage.setItem('subsonic-token', 'testtoken') + localStorage.setItem('subsonic-salt', 'testsalt') + + httpClient.mockResolvedValue({ json: fakeJson }) + }) + + afterEach(() => { + vi.restoreAllMocks() + localStorage.clear() + }) + + it('makes a POST request to getTranscodeDecision with correct URL', async () => { + await fetchTranscodeDecision('song-1', fakeProfile) + + expect(httpClient).toHaveBeenCalledTimes(1) + const [url, options] = httpClient.mock.calls[0] + expect(url).toContain('getTranscodeDecision') + expect(url).toContain('mediaId=song-1') + expect(url).toContain('mediaType=song') + expect(options.method).toBe('POST') + }) + + it('sends the browser profile as JSON body', async () => { + await fetchTranscodeDecision('song-1', fakeProfile) + + const [, options] = httpClient.mock.calls[0] + expect(JSON.parse(options.body)).toEqual(fakeProfile) + }) + + it('returns the transcodeDecision from response', async () => { + const result = await fetchTranscodeDecision('song-1', fakeProfile) + expect(result).toEqual(fakeJson['subsonic-response'].transcodeDecision) + }) + + it('throws on HTTP error (httpClient rejects)', async () => { + httpClient.mockRejectedValue(new Error('Server Error')) + + await expect( + fetchTranscodeDecision('song-1', fakeProfile), + ).rejects.toThrow() + }) + + it('throws on Subsonic error response', async () => { + httpClient.mockResolvedValue({ + json: { + 'subsonic-response': { + status: 'failed', + error: { code: 70, message: 'not found' }, + }, + }, + }) + + await expect( + fetchTranscodeDecision('song-1', fakeProfile), + ).rejects.toThrow() + }) +}) diff --git a/ui/src/transcode/index.js b/ui/src/transcode/index.js new file mode 100644 index 000000000..aa0cb216c --- /dev/null +++ b/ui/src/transcode/index.js @@ -0,0 +1,5 @@ +import { createDecisionService } from './decisionService' +import { fetchTranscodeDecision } from './fetchDecision' +export { detectBrowserProfile } from './browserProfile' + +export const decisionService = createDecisionService(fetchTranscodeDecision) diff --git a/ui/src/utils/formatters.js b/ui/src/utils/formatters.js index 74cce6e15..cfcb84b05 100644 --- a/ui/src/utils/formatters.js +++ b/ui/src/utils/formatters.js @@ -95,7 +95,7 @@ export const formatFullDate = (date, locale) => { return new Date(date).toLocaleDateString(locale, options) } -export const formatNumber = (value) => { +export const formatNumber = (value, locale) => { if (value === null || value === undefined) return '0' - return value.toLocaleString() + return value.toLocaleString(locale) } diff --git a/ui/src/utils/formatters.test.js b/ui/src/utils/formatters.test.js index 7709dd91b..d633e96f2 100644 --- a/ui/src/utils/formatters.test.js +++ b/ui/src/utils/formatters.test.js @@ -121,35 +121,35 @@ describe('formatDuration2', () => { describe('formatNumber', () => { it('handles null and undefined values', () => { - expect(formatNumber(null)).toEqual('0') - expect(formatNumber(undefined)).toEqual('0') + expect(formatNumber(null, 'en-CA')).toEqual('0') + expect(formatNumber(undefined, 'en-CA')).toEqual('0') }) it('formats integers', () => { - expect(formatNumber(0)).toEqual('0') - expect(formatNumber(1)).toEqual('1') - expect(formatNumber(123)).toEqual('123') - expect(formatNumber(1000)).toEqual('1,000') - expect(formatNumber(1234567)).toEqual('1,234,567') + expect(formatNumber(0, 'en-CA')).toEqual('0') + expect(formatNumber(1, 'en-CA')).toEqual('1') + expect(formatNumber(123, 'en-CA')).toEqual('123') + expect(formatNumber(1000, 'en-CA')).toEqual('1,000') + expect(formatNumber(1234567, 'en-CA')).toEqual('1,234,567') }) it('formats decimal numbers', () => { - expect(formatNumber(123.45)).toEqual('123.45') - expect(formatNumber(1234.567)).toEqual('1,234.567') + expect(formatNumber(123.45, 'en-CA')).toEqual('123.45') + expect(formatNumber(1234.567, 'en-CA')).toEqual('1,234.567') }) it('formats negative numbers', () => { - expect(formatNumber(-123)).toEqual('-123') - expect(formatNumber(-1234)).toEqual('-1,234') - expect(formatNumber(-123.45)).toEqual('-123.45') + expect(formatNumber(-123, 'en-CA')).toEqual('-123') + expect(formatNumber(-1234, 'en-CA')).toEqual('-1,234') + expect(formatNumber(-123.45, 'en-CA')).toEqual('-123.45') }) }) describe('formatFullDate', () => { it('format dates', () => { - expect(formatFullDate('2011', 'en-US')).toEqual('2011') - expect(formatFullDate('2011-06', 'en-US')).toEqual('Jun 2011') - expect(formatFullDate('1985-01-01', 'en-US')).toEqual('Jan 1, 1985') + expect(formatFullDate('2011', 'en-CA')).toEqual('2011') + expect(formatFullDate('2011-06', 'en-CA')).toEqual('Jun 2011') + expect(formatFullDate('1985-01-01', 'en-CA')).toEqual('Jan 1, 1985') expect(formatFullDate('199704')).toEqual('') }) }) diff --git a/ui/src/utils/urls.js b/ui/src/utils/urls.js index 5788096df..80207fe83 100644 --- a/ui/src/utils/urls.js +++ b/ui/src/utils/urls.js @@ -44,3 +44,16 @@ export const shareCoverUrl = (id, square) => { } export const docsUrl = (path) => `https://www.navidrome.org${path}` + +export const isLastFmURL = (url) => { + try { + const parsed = new URL(url) + return ( + (parsed.protocol === 'http:' || parsed.protocol === 'https:') && + (parsed.hostname === 'last.fm' || parsed.hostname.endsWith('.last.fm')) && + parsed.pathname.startsWith('/music/') + ) + } catch (e) { + return false + } +} diff --git a/ui/src/utils/urls.test.js b/ui/src/utils/urls.test.js new file mode 100644 index 000000000..26bdd1283 --- /dev/null +++ b/ui/src/utils/urls.test.js @@ -0,0 +1,25 @@ +import { isLastFmURL } from './urls' + +describe('isLastFmURL', () => { + it('returns true for valid Last.fm music URLs', () => { + expect(isLastFmURL('https://last.fm/music/The+Beatles')).toBe(true) + expect(isLastFmURL('http://last.fm/music/Radiohead')).toBe(true) + expect(isLastFmURL('https://www.last.fm/music/Daft+Punk')).toBe(true) + }) + + it('returns false for non-http(s) protocols (XSS prevention)', () => { + expect(isLastFmURL('javascript:alert(1)//last.fm/music/')).toBe(false) + expect(isLastFmURL('data:text/html,<script>//last.fm/music/')).toBe(false) + }) + + it('returns false for non-last.fm domains', () => { + expect(isLastFmURL('https://example.com/?q=last.fm/music/')).toBe(false) + expect(isLastFmURL('https://fake-last.fm/music/Artist')).toBe(false) + }) + + it('returns false for invalid paths or inputs', () => { + expect(isLastFmURL('https://last.fm/user/someone')).toBe(false) + expect(isLastFmURL(null)).toBe(false) + expect(isLastFmURL('not-a-url')).toBe(false) + }) +}) diff --git a/ui/src/utils/validations.js b/ui/src/utils/validations.js index 8b163c156..792726e70 100644 --- a/ui/src/utils/validations.js +++ b/ui/src/utils/validations.js @@ -10,3 +10,16 @@ export const urlValidate = (value) => { return 'ra.validation.url' } } + +export function isDateSet(date) { + if (!date) { + return false + } + if (typeof date === 'string') { + return date !== '0001-01-01T00:00:00Z' + } + if (date instanceof Date) { + return date.toISOString() !== '0001-01-01T00:00:00Z' + } + return !!date +} diff --git a/ui/src/utils/validations.test.js b/ui/src/utils/validations.test.js new file mode 100644 index 000000000..10f67d186 --- /dev/null +++ b/ui/src/utils/validations.test.js @@ -0,0 +1,73 @@ +import { isDateSet, urlValidate } from './validations' + +describe('urlValidate', () => { + it('returns undefined for valid URLs', () => { + expect(urlValidate('https://example.com')).toBeUndefined() + expect(urlValidate('http://localhost:3000')).toBeUndefined() + expect(urlValidate('ftp://files.example.com')).toBeUndefined() + }) + + it('returns undefined for empty values', () => { + expect(urlValidate('')).toBeUndefined() + expect(urlValidate(null)).toBeUndefined() + expect(urlValidate(undefined)).toBeUndefined() + }) + + it('returns error for invalid URLs', () => { + expect(urlValidate('not-a-url')).toEqual('ra.validation.url') + expect(urlValidate('example.com')).toEqual('ra.validation.url') + expect(urlValidate('://missing-protocol')).toEqual('ra.validation.url') + }) +}) + +describe('isDateSet', () => { + describe('with falsy values', () => { + it('returns false for null', () => { + expect(isDateSet(null)).toBe(false) + }) + + it('returns false for undefined', () => { + expect(isDateSet(undefined)).toBe(false) + }) + + it('returns false for empty string', () => { + expect(isDateSet('')).toBe(false) + }) + }) + + describe('with Go zero date string', () => { + it('returns false for Go zero date', () => { + expect(isDateSet('0001-01-01T00:00:00Z')).toBe(false) + }) + }) + + describe('with valid date strings', () => { + it('returns true for ISO date strings', () => { + expect(isDateSet('2024-01-15T10:30:00Z')).toBe(true) + expect(isDateSet('2023-12-25T00:00:00Z')).toBe(true) + }) + + it('returns true for other date formats', () => { + expect(isDateSet('2024-01-15')).toBe(true) + }) + }) + + describe('with Date objects', () => { + it('returns true for valid Date objects', () => { + expect(isDateSet(new Date())).toBe(true) + expect(isDateSet(new Date('2024-01-15T10:30:00Z'))).toBe(true) + }) + + // Note: Date objects representing Go zero date would return true because + // toISOString() adds milliseconds (0001-01-01T00:00:00.000Z). + // In practice, dates from the API come as strings, not Date objects, + // so this edge case doesn't occur. + }) + + describe('with other truthy values', () => { + it('returns true for non-date truthy values', () => { + expect(isDateSet(123)).toBe(true) + expect(isDateSet({})).toBe(true) + }) + }) +}) diff --git a/ui/vite.config.js b/ui/vite.config.js index dee9d3939..9d9c845f1 100644 --- a/ui/vite.config.js +++ b/ui/vite.config.js @@ -14,6 +14,9 @@ export default defineConfig({ strategies: 'injectManifest', srcDir: 'src', filename: 'sw.js', + injectManifest: { + maximumFileSizeToCacheInBytes: 3 * 1024 * 1024, // 3 MiB + }, devOptions: { enabled: true, }, @@ -27,6 +30,10 @@ export default defineConfig({ }, }, base: './', + define: { + // JSONForms and other libraries use process.env + 'process.env': JSON.stringify({}), + }, build: { outDir: 'build', sourcemap: true, diff --git a/utils/cache/benchmark_test.go b/utils/cache/benchmark_test.go new file mode 100644 index 000000000..1fe448f84 --- /dev/null +++ b/utils/cache/benchmark_test.go @@ -0,0 +1,171 @@ +package cache + +import ( + "context" + "fmt" + "io" + "os" + "runtime" + "strings" + "sync" + "testing" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" +) + +type benchItem struct { + key string +} + +func (b *benchItem) Key() string { return b.key } + +// setupBenchCache creates a file cache in a temp directory. Returns the cache and cleanup function. +func setupBenchCache(b *testing.B, cacheSize string, getReader ReadFunc) (*fileCache, func()) { + b.Helper() + tmpDir, err := os.MkdirTemp("", "bench-cache-*") + if err != nil { + b.Fatal(err) + } + b.Cleanup(configtest.SetupConfig()) + conf.Server.CacheFolder = tmpDir + + fc := NewFileCache("bench", cacheSize, "bench", 0, getReader).(*fileCache) + + // Wait for cache to be ready + for !fc.ready.Load() { + runtime.Gosched() // Yield to allow background init goroutine to run + } + + teardown := func() { + os.RemoveAll(tmpDir) + } + return fc, teardown +} + +func BenchmarkCacheWrite(b *testing.B) { + // Simulate writing 50KB images (typical 300px JPEG) + imageData := strings.Repeat("x", 50*1024) + + fc, cleanup := setupBenchCache(b, "100MB", func(ctx context.Context, item Item) (io.Reader, error) { + return strings.NewReader(imageData), nil + }) + defer cleanup() + + b.SetBytes(int64(len(imageData))) + b.ResetTimer() + for i := 0; i < b.N; i++ { + key := fmt.Sprintf("write-bench-%d", i) + s, err := fc.Get(context.Background(), &benchItem{key: key}) + if err != nil { + b.Fatal(err) + } + _, _ = io.ReadAll(s) + s.Close() + } +} + +func BenchmarkCacheRead(b *testing.B) { + imageData := strings.Repeat("x", 50*1024) + + fc, cleanup := setupBenchCache(b, "100MB", func(ctx context.Context, item Item) (io.Reader, error) { + return strings.NewReader(imageData), nil + }) + defer cleanup() + + // Pre-populate cache + item := &benchItem{key: "read-bench"} + s, err := fc.Get(context.Background(), item) + if err != nil { + b.Fatal(err) + } + _, _ = io.ReadAll(s) + s.Close() + + b.SetBytes(int64(len(imageData))) + b.ResetTimer() + for i := 0; i < b.N; i++ { + s, err := fc.Get(context.Background(), item) + if err != nil { + b.Fatal(err) + } + _, _ = io.ReadAll(s) + s.Close() + } +} + +func BenchmarkConcurrentCacheRead(b *testing.B) { + imageData := strings.Repeat("x", 50*1024) + + fc, cleanup := setupBenchCache(b, "100MB", func(ctx context.Context, item Item) (io.Reader, error) { + return strings.NewReader(imageData), nil + }) + defer cleanup() + + // Pre-populate cache + item := &benchItem{key: "concurrent-read"} + s, _ := fc.Get(context.Background(), item) + _, _ = io.ReadAll(s) + s.Close() + + concurrencyLevels := []int{1, 10, 50} + for _, n := range concurrencyLevels { + b.Run(fmt.Sprintf("goroutines_%d", n), func(b *testing.B) { + b.SetBytes(int64(len(imageData))) + b.ResetTimer() + for i := 0; i < b.N; i++ { + var wg sync.WaitGroup + wg.Add(n) + for g := 0; g < n; g++ { + go func() { + defer wg.Done() + s, err := fc.Get(context.Background(), item) + if err != nil { + b.Error(err) + return + } + _, _ = io.ReadAll(s) + s.Close() + }() + } + wg.Wait() + } + }) + } +} + +func BenchmarkConcurrentCacheMiss(b *testing.B) { + imageData := strings.Repeat("x", 50*1024) + + concurrencyLevels := []int{1, 10, 50} + for _, n := range concurrencyLevels { + b.Run(fmt.Sprintf("goroutines_%d", n), func(b *testing.B) { + fc, cleanup := setupBenchCache(b, "100MB", func(ctx context.Context, item Item) (io.Reader, error) { + return strings.NewReader(imageData), nil + }) + defer cleanup() + + b.SetBytes(int64(len(imageData))) + b.ResetTimer() + for i := 0; i < b.N; i++ { + var wg sync.WaitGroup + wg.Add(n) + // All goroutines request the SAME key (not yet cached) + item := &benchItem{key: fmt.Sprintf("miss-%d", i)} + for g := 0; g < n; g++ { + go func() { + defer wg.Done() + s, err := fc.Get(context.Background(), item) + if err != nil { + b.Error(err) + return + } + _, _ = io.ReadAll(s) + s.Close() + }() + } + wg.Wait() + } + }) + } +} diff --git a/utils/cache/file_haunter_test.go b/utils/cache/file_haunter_test.go index bd1eb568d..47440cc22 100644 --- a/utils/cache/file_haunter_test.go +++ b/utils/cache/file_haunter_test.go @@ -70,7 +70,7 @@ var _ = Describe("FileHaunter", func() { func createTestFiles(c *fscache.FSCache) error { // Create 5 normal files and 1 empty - for i := 0; i < 6; i++ { + for i := range 6 { name := fmt.Sprintf("stream-%v", i) var r fscache.ReadAtCloser if i < 5 { diff --git a/utils/files.go b/utils/files.go index 9bdc262c5..2fce307ea 100644 --- a/utils/files.go +++ b/utils/files.go @@ -4,11 +4,14 @@ import ( "os" "path" "path/filepath" + "regexp" "strings" "github.com/navidrome/navidrome/model/id" ) +var cleanFileNameRe = regexp.MustCompile(`[^a-z0-9_-]`) + func TempFileName(prefix, suffix string) string { return filepath.Join(os.TempDir(), prefix+id.NewRandom()+suffix) } @@ -18,6 +21,20 @@ func BaseName(filePath string) string { return strings.TrimSuffix(p, path.Ext(p)) } +// CleanFileName produces a filesystem-safe, human-readable version of a name. +// It lowercases, replaces spaces with underscores, strips non-alphanumeric +// characters (except underscore and hyphen), and truncates to 50 characters. +func CleanFileName(name string) string { + s := strings.ToLower(strings.TrimSpace(name)) + s = strings.ReplaceAll(s, " ", "_") + s = cleanFileNameRe.ReplaceAllString(s, "") + if len(s) > 50 { + s = s[:50] + } + s = strings.TrimRight(s, "_-") + return s +} + // FileExists checks if a file or directory exists func FileExists(path string) bool { _, err := os.Stat(path) diff --git a/utils/files_test.go b/utils/files_test.go index dcb28aafb..72fc4f96f 100644 --- a/utils/files_test.go +++ b/utils/files_test.go @@ -99,6 +99,49 @@ var _ = Describe("BaseName", func() { }) }) +var _ = Describe("CleanFileName", func() { + It("lowercases and replaces spaces with underscores", func() { + Expect(utils.CleanFileName("My Cool Playlist")).To(Equal("my_cool_playlist")) + }) + + It("strips special characters", func() { + Expect(utils.CleanFileName("Rock & Roll! (2024)")).To(Equal("rock__roll_2024")) + }) + + It("handles unicode characters", func() { + Expect(utils.CleanFileName("Música Favorita")).To(Equal("msica_favorita")) + }) + + It("preserves hyphens", func() { + Expect(utils.CleanFileName("lo-fi beats")).To(Equal("lo-fi_beats")) + }) + + It("returns empty string for empty input", func() { + Expect(utils.CleanFileName("")).To(BeEmpty()) + }) + + It("returns empty string for whitespace-only input", func() { + Expect(utils.CleanFileName(" ")).To(BeEmpty()) + }) + + It("returns empty string when all characters are stripped", func() { + Expect(utils.CleanFileName("!!!@@@###")).To(BeEmpty()) + }) + + It("truncates to 50 characters", func() { + long := strings.Repeat("abcdefghij", 10) // 100 chars + result := utils.CleanFileName(long) + Expect(len(result)).To(Equal(50)) + }) + + It("trims trailing underscores and hyphens after truncation", func() { + // 49 a's + space + "b" = after clean: 49 a's + "_b" = 51 chars, truncated to 50 = 49 a's + "_" + name := strings.Repeat("a", 49) + " b" + result := utils.CleanFileName(name) + Expect(result).To(Equal(strings.Repeat("a", 49))) + }) +}) + var _ = Describe("FileExists", func() { var tempFile *os.File var tempDir string diff --git a/utils/hasher/hasher_test.go b/utils/hasher/hasher_test.go index 30cda3d05..7ecfe6980 100644 --- a/utils/hasher/hasher_test.go +++ b/utils/hasher/hasher_test.go @@ -57,7 +57,7 @@ var _ = Describe("HashFunc", func() { }) It("does not cause race conditions", func() { - for i := 0; i < 1000; i++ { + for i := range 1000 { go func() { hashFunc := hasher.HashFunc() sum := hashFunc(strconv.Itoa(i), input) diff --git a/utils/index_group_parser.go b/utils/index_group_parser.go index 5622164c6..786f5c457 100644 --- a/utils/index_group_parser.go +++ b/utils/index_group_parser.go @@ -23,8 +23,8 @@ var indexGroupsRx = regexp.MustCompile(`(.+)\((.+)\)`) func ParseIndexGroups(spec string) IndexGroups { parsed := make(IndexGroups) - split := strings.Split(spec, " ") - for _, g := range split { + split := strings.SplitSeq(spec, " ") + for g := range split { sub := indexGroupsRx.FindStringSubmatch(g) if len(sub) > 0 { for _, c := range sub[2] { diff --git a/utils/ioutils/ioutils.go b/utils/ioutils/ioutils.go new file mode 100644 index 000000000..89d3997f3 --- /dev/null +++ b/utils/ioutils/ioutils.go @@ -0,0 +1,33 @@ +package ioutils + +import ( + "io" + "os" + + "golang.org/x/text/encoding/unicode" + "golang.org/x/text/transform" +) + +// UTF8Reader wraps an io.Reader to handle Byte Order Mark (BOM) properly. +// It strips UTF-8 BOM if present, and converts UTF-16 (LE/BE) to UTF-8. +// This is particularly useful for reading user-provided text files (like LRC lyrics, +// playlists) that may have been created on Windows, which often adds BOM markers. +// +// Reference: https://en.wikipedia.org/wiki/Byte_order_mark +func UTF8Reader(r io.Reader) io.Reader { + return transform.NewReader(r, unicode.BOMOverride(unicode.UTF8.NewDecoder())) +} + +// UTF8ReadFile reads the named file and returns its contents as a byte slice, +// automatically handling BOM markers. It's similar to os.ReadFile but strips +// UTF-8 BOM and converts UTF-16 encoded files to UTF-8. +func UTF8ReadFile(filename string) ([]byte, error) { + file, err := os.Open(filename) + if err != nil { + return nil, err + } + defer file.Close() + + reader := UTF8Reader(file) + return io.ReadAll(reader) +} diff --git a/utils/ioutils/ioutils_test.go b/utils/ioutils/ioutils_test.go new file mode 100644 index 000000000..7f5483879 --- /dev/null +++ b/utils/ioutils/ioutils_test.go @@ -0,0 +1,117 @@ +package ioutils + +import ( + "bytes" + "io" + "testing" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestIOUtils(t *testing.T) { + RegisterFailHandler(Fail) + RunSpecs(t, "IO Utils Suite") +} + +var _ = Describe("UTF8Reader", func() { + Context("when reading text with UTF-8 BOM", func() { + It("strips the UTF-8 BOM marker", func() { + // UTF-8 BOM is EF BB BF + input := []byte{0xEF, 0xBB, 0xBF, 'h', 'e', 'l', 'l', 'o'} + reader := UTF8Reader(bytes.NewReader(input)) + + output, err := io.ReadAll(reader) + Expect(err).ToNot(HaveOccurred()) + Expect(string(output)).To(Equal("hello")) + }) + + It("strips UTF-8 BOM from multi-line text", func() { + // Test with the actual LRC file format + input := []byte{0xEF, 0xBB, 0xBF, '[', '0', '0', ':', '0', '0', '.', '0', '0', ']', ' ', 't', 'e', 's', 't'} + reader := UTF8Reader(bytes.NewReader(input)) + + output, err := io.ReadAll(reader) + Expect(err).ToNot(HaveOccurred()) + Expect(string(output)).To(Equal("[00:00.00] test")) + }) + }) + + Context("when reading text without BOM", func() { + It("passes through unchanged", func() { + input := []byte("hello world") + reader := UTF8Reader(bytes.NewReader(input)) + + output, err := io.ReadAll(reader) + Expect(err).ToNot(HaveOccurred()) + Expect(string(output)).To(Equal("hello world")) + }) + }) + + Context("when reading UTF-16 LE encoded text", func() { + It("converts to UTF-8 and strips BOM", func() { + // UTF-16 LE BOM (FF FE) followed by "hi" in UTF-16 LE + input := []byte{0xFF, 0xFE, 'h', 0x00, 'i', 0x00} + reader := UTF8Reader(bytes.NewReader(input)) + + output, err := io.ReadAll(reader) + Expect(err).ToNot(HaveOccurred()) + Expect(string(output)).To(Equal("hi")) + }) + }) + + Context("when reading UTF-16 BE encoded text", func() { + It("converts to UTF-8 and strips BOM", func() { + // UTF-16 BE BOM (FE FF) followed by "hi" in UTF-16 BE + input := []byte{0xFE, 0xFF, 0x00, 'h', 0x00, 'i'} + reader := UTF8Reader(bytes.NewReader(input)) + + output, err := io.ReadAll(reader) + Expect(err).ToNot(HaveOccurred()) + Expect(string(output)).To(Equal("hi")) + }) + }) + + Context("when reading empty content", func() { + It("returns empty string", func() { + reader := UTF8Reader(bytes.NewReader([]byte{})) + + output, err := io.ReadAll(reader) + Expect(err).ToNot(HaveOccurred()) + Expect(string(output)).To(Equal("")) + }) + }) +}) + +var _ = Describe("UTF8ReadFile", func() { + Context("when reading a file with UTF-8 BOM", func() { + It("strips the BOM marker", func() { + // Use the actual fixture from issue #4631 + contents, err := UTF8ReadFile("../../tests/fixtures/bom-test.lrc") + Expect(err).ToNot(HaveOccurred()) + + // Should NOT start with BOM + Expect(contents[0]).ToNot(Equal(byte(0xEF))) + // Should start with '[' + Expect(contents[0]).To(Equal(byte('['))) + Expect(string(contents)).To(HavePrefix("[00:00.00]")) + }) + }) + + Context("when reading a file without BOM", func() { + It("reads the file normally", func() { + contents, err := UTF8ReadFile("../../tests/fixtures/test.lrc") + Expect(err).ToNot(HaveOccurred()) + + // Should contain the expected content + Expect(string(contents)).To(ContainSubstring("We're no strangers to love")) + }) + }) + + Context("when reading a non-existent file", func() { + It("returns an error", func() { + _, err := UTF8ReadFile("../../tests/fixtures/nonexistent.lrc") + Expect(err).To(HaveOccurred()) + }) + }) +}) diff --git a/utils/jsoncommentstrip/jsoncommentstrip.go b/utils/jsoncommentstrip/jsoncommentstrip.go new file mode 100644 index 000000000..54ddd88fa --- /dev/null +++ b/utils/jsoncommentstrip/jsoncommentstrip.go @@ -0,0 +1,128 @@ +// Package jsoncommentstrip provides an io.Reader that strips JavaScript-style +// comments (// line and /* block */) from JSON input while preserving +// comment-like sequences inside JSON string values. +package jsoncommentstrip + +import ( + "bufio" + "io" +) + +type state int + +const ( + stateNormal state = iota + stateInString + stateInStringEscape + stateMaybeComment // saw '/' + stateLineComment // inside // ... + stateBlockComment // inside /* ... */ + stateMaybeBlockEnd // saw '*' inside block comment +) + +type reader struct { + r *bufio.Reader + state state +} + +// NewReader returns an io.Reader that strips JSON comments from the +// underlying reader. It removes single-line comments (// to end of line) +// and block comments (/* ... */), while preserving comment-like sequences +// that appear inside JSON string values. +func NewReader(r io.Reader) io.Reader { + return &reader{ + r: bufio.NewReader(r), + state: stateNormal, + } +} + +func (cr *reader) Read(p []byte) (int, error) { + n := 0 + for n < len(p) { + b, err := cr.r.ReadByte() + if err != nil { + if cr.state == stateMaybeComment { + // Emit the pending '/' before returning EOF + p[n] = '/' + n++ + cr.state = stateNormal + } + return n, err + } + + switch cr.state { + case stateNormal: + switch b { + case '"': + p[n] = b + n++ + cr.state = stateInString + case '/': + cr.state = stateMaybeComment + default: + p[n] = b + n++ + } + + case stateInString: + p[n] = b + n++ + switch b { + case '\\': + cr.state = stateInStringEscape + case '"': + cr.state = stateNormal + } + + case stateInStringEscape: + p[n] = b + n++ + cr.state = stateInString + + case stateMaybeComment: + switch b { + case '/': + cr.state = stateLineComment + case '*': + cr.state = stateBlockComment + default: + // The '/' was not a comment start; emit it and the current byte + p[n] = '/' + n++ + if n < len(p) { + p[n] = b + n++ + } else { + // We need to "unread" the current byte since buffer is full + _ = cr.r.UnreadByte() + } + cr.state = stateNormal + } + + case stateLineComment: + if b == '\n' || b == '\r' { + p[n] = b + n++ + cr.state = stateNormal + } + // Otherwise, consume and discard + + case stateBlockComment: + if b == '*' { + cr.state = stateMaybeBlockEnd + } + // Otherwise, consume and discard + + case stateMaybeBlockEnd: + if b == '/' { + cr.state = stateNormal + } else if b == '*' { + // Stay in stateMaybeBlockEnd (consecutive *'s) + cr.state = stateMaybeBlockEnd + } else { + cr.state = stateBlockComment + } + } + } + return n, nil +} diff --git a/utils/jsoncommentstrip/jsoncommentstrip_test.go b/utils/jsoncommentstrip/jsoncommentstrip_test.go new file mode 100644 index 000000000..21e4bd0b1 --- /dev/null +++ b/utils/jsoncommentstrip/jsoncommentstrip_test.go @@ -0,0 +1,164 @@ +package jsoncommentstrip_test + +import ( + "bytes" + "encoding/json" + "io" + "strings" + "testing" + + "github.com/navidrome/navidrome/utils/jsoncommentstrip" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestJsonCommentStrip(t *testing.T) { + RegisterFailHandler(Fail) + RunSpecs(t, "JsonCommentStrip Suite") +} + +var _ = Describe("NewReader", func() { + read := func(input string) string { + r := jsoncommentstrip.NewReader(strings.NewReader(input)) + out, err := io.ReadAll(r) + Expect(err).ToNot(HaveOccurred()) + return string(out) + } + + // compact returns the compacted JSON form of s, for readable comparisons. + compact := func(s string) string { + var buf bytes.Buffer + ExpectWithOffset(1, json.Compact(&buf, []byte(s))).To(Succeed()) + return buf.String() + } + + It("passes through JSON without comments unchanged", func() { + input := `{"key": "value", "num": 42}` + Expect(read(input)).To(Equal(input)) + }) + + It("strips single-line comments", func() { + input := `{ + // this is a comment + "key": "value" + }` + Expect(compact(read(input))).To(Equal(compact(`{ + "key": "value" + }`))) + }) + + It("strips single-line comments at end of line", func() { + input := `{ + "key": "value" // inline comment + }` + Expect(compact(read(input))).To(Equal(compact(`{ + "key": "value" + }`))) + }) + + It("strips block comments", func() { + input := `{/* comment */"key": "value"}` + Expect(compact(read(input))).To(Equal(`{"key":"value"}`)) + }) + + It("strips multi-line block comments", func() { + input := `{ + /* this is + a multi-line + comment */ + "key": "value" + }` + Expect(compact(read(input))).To(Equal(compact(`{ + "key": "value" + }`))) + }) + + It("preserves // inside JSON strings", func() { + input := `{"key": "value // not a comment"}` + Expect(read(input)).To(Equal(input)) + }) + + It("preserves /* inside JSON strings", func() { + input := `{"key": "value /* not a comment */"}` + Expect(read(input)).To(Equal(input)) + }) + + It("handles escaped quotes in strings", func() { + input := `{"key": "val\"ue // not a comment"}` + Expect(read(input)).To(Equal(input)) + }) + + It("handles / at end of input as literal", func() { + input := `{"key": "value"}/` + Expect(read(input)).To(Equal(input)) + }) + + It("handles * inside block comment not followed by /", func() { + input := `{/* a * b */"key": "value"}` + Expect(compact(read(input))).To(Equal(`{"key":"value"}`)) + }) + + It("handles empty input", func() { + Expect(read("")).To(Equal("")) + }) + + It("handles mixed comments with real content", func() { + input := `{ + // line comment + "name": "test", /* inline block */ + /* multi + line */ + "value": "hello // world", + "other": 123 // trailing + }` + Expect(compact(read(input))).To(Equal(compact(`{ + "name": "test", + "value": "hello // world", + "other": 123 + }`))) + }) + + It("handles consecutive slashes that are not comments", func() { + input := `{"path": "/a/b"}` + Expect(read(input)).To(Equal(input)) + }) + + It("handles block comment at end of input", func() { + input := `{"key": "value"}/* comment */` + Expect(compact(read(input))).To(Equal(`{"key":"value"}`)) + }) + + It("strips comment with windows-style line endings", func() { + input := "{\r\n// comment\r\n\"key\": \"value\"\r\n}" + Expect(compact(read(input))).To(Equal(compact(`{"key": "value"}`))) + }) + + It("strips line comments with mixed line endings", func() { + // From original library: // comments with both \n and \r\n, including multiple on same line + input := "{\n\"one\": 1, // test //\n\"two\": 2, //test //\r\n\"string\": \"value\"\n//test\n}" + expected := "{\n\"one\": 1, \n\"two\": 2, \r\n\"string\": \"value\"\n\n}" + Expect(read(input)).To(Equal(expected)) + }) + + It("strips line comment at start of JSON", func() { + // From original library: // comment as first thing in JSON + input := "{// woot\n\"one\": 1, // test //\n\"two\": 2, //test //\r\n\"string\": \"value\"\n//test\n}" + expected := "{\n\"one\": 1, \n\"two\": 2, \r\n\"string\": \"value\"\n\n}" + Expect(read(input)).To(Equal(expected)) + }) + + It("strips block comments with mixed line endings inside", func() { + // From original library: block comment containing \r\n + input := "{/* multi\nline\r\ncomment */\"one\":1}" + expected := "{\"one\":1}" + Expect(read(input)).To(Equal(expected)) + }) + + It("handles complex mix of escaped quotes, comments, and strings", func() { + // From original library TestQuotationEscape: escaped quote inside string followed by + // comment-like chars, then real comments of both types + input := "{/* multi\nline\r\ncomment */\"one\": \"a value \\\" // /*woot\"/* m\nl *///woot\r\n}" + expected := "{\"one\": \"a value \\\" // /*woot\"\r\n}" + Expect(read(input)).To(Equal(expected)) + }) +}) diff --git a/utils/nanoid/nanoid.go b/utils/nanoid/nanoid.go new file mode 100644 index 000000000..17d32e72f --- /dev/null +++ b/utils/nanoid/nanoid.go @@ -0,0 +1,52 @@ +package nanoid + +import ( + "crypto/rand" + "errors" + "math" +) + +// Generate returns a cryptographically secure random string of `size` characters +// drawn from `alphabet`. It uses bitmask with rejection sampling to avoid modulo bias. +// The alphabet must be non-empty, contain at most 255 characters, and consist only of +// ASCII characters. Non-ASCII alphabets (e.g., multi-byte UTF-8) are not supported. +func Generate(alphabet string, size int) (string, error) { + if len(alphabet) == 0 || len(alphabet) > 255 { + return "", errors.New("alphabet must be non-empty and at most 255 characters") + } + if size <= 0 { + return "", errors.New("size must be a positive integer") + } + + mask := getMask(len(alphabet)) + step := int(math.Ceil(1.6 * float64(mask) * float64(size) / float64(len(alphabet)))) + + id := make([]byte, size) + bytes := make([]byte, step) + for j := 0; ; { + if _, err := rand.Read(bytes); err != nil { + return "", err + } + for i := range step { + idx := int(bytes[i]) & mask + if idx < len(alphabet) { + id[j] = alphabet[idx] + j++ + if j == size { + return string(id), nil + } + } + } + } +} + +// getMask returns the smallest bitmask >= alphabetSize-1. +func getMask(alphabetSize int) int { + for i := 1; i <= 8; i++ { + mask := (2 << uint(i)) - 1 + if mask >= alphabetSize-1 { + return mask + } + } + return 0 +} diff --git a/utils/nanoid/nanoid_test.go b/utils/nanoid/nanoid_test.go new file mode 100644 index 000000000..99d4e5715 --- /dev/null +++ b/utils/nanoid/nanoid_test.go @@ -0,0 +1,85 @@ +package nanoid_test + +import ( + "testing" + + "github.com/navidrome/navidrome/utils/nanoid" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestNanoid(t *testing.T) { + RegisterFailHandler(Fail) + RunSpecs(t, "Nanoid Suite") +} + +var _ = Describe("Generate", func() { + const alphabet = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz" + + It("generates a string of the requested length", func() { + id, err := nanoid.Generate(alphabet, 22) + Expect(err).ToNot(HaveOccurred()) + Expect(id).To(HaveLen(22)) + }) + + It("generates a short string of the requested length", func() { + id, err := nanoid.Generate(alphabet, 10) + Expect(err).ToNot(HaveOccurred()) + Expect(id).To(HaveLen(10)) + }) + + It("only contains characters from the alphabet", func() { + id, err := nanoid.Generate(alphabet, 100) + Expect(err).ToNot(HaveOccurred()) + for _, c := range id { + Expect(alphabet).To(ContainSubstring(string(c))) + } + }) + + It("generates unique IDs", func() { + seen := make(map[string]bool) + for range 1000 { + id, err := nanoid.Generate(alphabet, 22) + Expect(err).ToNot(HaveOccurred()) + Expect(seen).ToNot(HaveKey(id)) + seen[id] = true + } + }) + + It("works with a single-character alphabet", func() { + id, err := nanoid.Generate("a", 5) + Expect(err).ToNot(HaveOccurred()) + Expect(id).To(Equal("aaaaa")) + }) + + It("works with a small alphabet", func() { + id, err := nanoid.Generate("ab", 10) + Expect(err).ToNot(HaveOccurred()) + Expect(id).To(HaveLen(10)) + for _, c := range id { + Expect(string(c)).To(BeElementOf("a", "b")) + } + }) + + It("returns error on empty alphabet", func() { + _, err := nanoid.Generate("", 10) + Expect(err).To(HaveOccurred()) + }) + + It("returns error on alphabet larger than 255 characters", func() { + bigAlphabet := make([]byte, 256) + for i := range bigAlphabet { + bigAlphabet[i] = byte(i) + } + _, err := nanoid.Generate(string(bigAlphabet), 10) + Expect(err).To(HaveOccurred()) + }) + + It("returns error on non-positive size", func() { + _, err := nanoid.Generate(alphabet, 0) + Expect(err).To(HaveOccurred()) + + _, err = nanoid.Generate(alphabet, -1) + Expect(err).To(HaveOccurred()) + }) +}) diff --git a/utils/natural/natural.go b/utils/natural/natural.go new file mode 100644 index 000000000..fa0800e1d --- /dev/null +++ b/utils/natural/natural.go @@ -0,0 +1,98 @@ +// Package natural provides natural (alphanumeric) string comparison. +// When both strings have digit sequences at the same position, they are +// compared numerically (so "file2" < "file10"); otherwise bytes are +// compared one-by-one. No allocations are made. +package natural + +import "strings" + +// Compare returns a negative value if a < b, zero if a == b, +// or a positive value if a > b using natural sort ordering. +// +// When two numeric segments are numerically equal (e.g. "01" vs "1"), +// comparison continues with the remaining suffixes. If one or both +// strings end at the digit boundary, the raw strings are compared +// lexically, which makes leading zeros significant as a tie-breaker +// (e.g. "a01" < "a1", "a0" < "a00"). +func Compare(a, b string) int { + ia, ib := 0, 0 + for ia < len(a) && ib < len(b) { + ca, cb := a[ia], b[ib] + da, db := isDigit(ca), isDigit(cb) + + switch { + case da && db: + // Both are in digit sequences — compare numerically. + endA := ia + for endA < len(a) && isDigit(a[endA]) { + endA++ + } + endB := ib + for endB < len(b) && isDigit(b[endB]) { + endB++ + } + + if c := compareNumbers(a[ia:endA], b[ib:endB]); c != 0 { + return c + } + + // Numerically equal. If both sides have trailing data, continue + // comparing after the digit runs. Otherwise fall through to + // lexical comparison of the full remaining strings (which makes + // leading-zero differences significant as a tie-breaker). + if endA < len(a) && endB < len(b) { + ia = endA + ib = endB + continue + } + return strings.Compare(a[ia:], b[ib:]) + case da != db: + return int(ca) - int(cb) + default: + if ca != cb { + return int(ca) - int(cb) + } + ia++ + ib++ + } + } + return (len(a) - ia) - (len(b) - ib) +} + +// compareNumbers compares two digit strings numerically. +// Leading zeros are stripped before comparison. +func compareNumbers(a, b string) int { + // Strip leading zeros. + sa := stripZeros(a) + sb := stripZeros(b) + + // Different lengths after stripping means different magnitude. + if len(sa) != len(sb) { + return len(sa) - len(sb) + } + + // Same length — compare digit by digit. + for i := range len(sa) { + if sa[i] != sb[i] { + return int(sa[i]) - int(sb[i]) + } + } + return 0 +} + +// stripZeros returns s with leading '0' bytes removed. +// If s is all zeros, returns the last byte (a single "0"). +func stripZeros(s string) string { + i := 0 + for i < len(s) && s[i] == '0' { + i++ + } + if i == len(s) && len(s) > 0 { + return s[len(s)-1:] + } + return s[i:] +} + +func isDigit(c byte) bool { + return c >= '0' && c <= '9' +} diff --git a/utils/natural/natural_test.go b/utils/natural/natural_test.go new file mode 100644 index 000000000..825a944c0 --- /dev/null +++ b/utils/natural/natural_test.go @@ -0,0 +1,116 @@ +package natural_test + +import ( + "testing" + + "github.com/navidrome/navidrome/utils/natural" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestNatural(t *testing.T) { + RegisterFailHandler(Fail) + RunSpecs(t, "Natural Suite") +} + +var _ = Describe("Compare", func() { + DescribeTable("returns correct ordering", + func(a, b string, expected int) { + result := natural.Compare(a, b) + if expected < 0 { + Expect(result).To(BeNumerically("<", 0), "expected %q < %q", a, b) + } else if expected > 0 { + Expect(result).To(BeNumerically(">", 0), "expected %q > %q", a, b) + } else { + Expect(result).To(Equal(0), "expected %q == %q", a, b) + } + }, + // Basic string ordering + Entry("a < b", "a", "b", -1), + Entry("b > a", "b", "a", 1), + Entry("a < aa (prefix)", "a", "aa", -1), + Entry("aa > a", "aa", "a", 1), + + // Equal strings + Entry("equal strings return 0", "abc", "abc", 0), + Entry("both empty", "", "", 0), + Entry("a01 == a01", "a01", "a01", 0), + Entry("a1 == a1", "a1", "a1", 0), + + // Empty string edge cases + Entry("empty < non-empty", "", "a", -1), + Entry("non-empty > empty", "a", "", 1), + + // Numeric comparison + Entry("2 < 10 numerically", "2", "10", -1), + Entry("10 > 2 numerically", "10", "2", 1), + Entry("equal numbers", "42", "42", 0), + Entry("9 < 10", "9", "10", -1), + Entry("99 < 100", "99", "100", -1), + + // Simple numeric segments (from original library) + Entry("a0 < a1", "a0", "a1", -1), + Entry("a0 < a00", "a0", "a00", -1), + Entry("a00 < a01", "a00", "a01", -1), + Entry("a01 < a1", "a01", "a1", -1), + Entry("a01 < a2", "a01", "a2", -1), + Entry("a01x < a2x", "a01x", "a2x", -1), + Entry("a01 > a00", "a01", "a00", 1), + Entry("a2 > a01", "a2", "a01", 1), + Entry("a2x > a01x", "a2x", "a01x", 1), + + // Multiple numeric groups (from original library) + Entry("a0b00 < a00b1", "a0b00", "a00b1", -1), + Entry("a0b00 < a00b01", "a0b00", "a00b01", -1), + Entry("a00b0 < a0b00", "a00b0", "a0b00", -1), + Entry("a00b00 < a0b01", "a00b00", "a0b01", -1), + Entry("a00b00 < a0b1", "a00b00", "a0b1", -1), + Entry("a00b00 > a0b0", "a00b00", "a0b0", 1), + Entry("a00b01 > a0b00", "a00b01", "a0b00", 1), + Entry("a00b00 == a0b00", "a00b00", "a0b00", 0), + + // Leading zeros at end of string — lexical tie-break + Entry("file01 < file1", "file01", "file1", -1), + + // Prefix comparison + Entry("abc < abcd", "abc", "abcd", -1), + Entry("abcd > abc", "abcd", "abc", 1), + + // Navidrome use cases: cover art sorting + Entry("cover < cover.1", "cover", "cover.1", -1), + Entry("cover.1 < cover.2", "cover.1", "cover.2", -1), + Entry("cover.2 < cover.10", "cover.2", "cover.10", -1), + + // Navidrome use cases: disc sorting + Entry("disc1 < disc2", "disc1", "disc2", -1), + Entry("disc2 < disc10", "disc2", "disc10", -1), + Entry("disc1 < disc10", "disc1", "disc10", -1), + + // Multiple numeric segments + Entry("a1b2 < a1b10", "a1b2", "a1b10", -1), + Entry("a2b1 > a1b2", "a2b1", "a1b2", 1), + + // Numbers at the start + Entry("2abc < 10abc", "2abc", "10abc", -1), + + // Numbers larger than uint64 max (from original library) + Entry("large: fewer digits < more digits", + "a99999999999999999999", "a100000000000000000000", -1), + Entry("large: digit-by-digit comparison", + "a123456789012345678901234567890", "a123456789012345678901234567891", -1), + Entry("large: more digits > fewer digits", + "a999999999999999999999", "a1000000000000000000000", -1), + Entry("large: 20 digits < 100 digits by length", + "a20000000000000000000", "a100000000000000000000", -1), + Entry("large: 100 digits > 20 digits", + "a100000000000000000000", "a20000000000000000000", 1), + Entry("large: reverse of above", + "a1000000000000000000000", "a999999999999999999999", 1), + Entry("large: equal", + "a100000000000000000000", "a100000000000000000000", 0), + Entry("large: leading zeros with trailing data", + "a00000000000000000000001x", "a1x", 0), + Entry("large: leading zeros with trailing data (2)", + "a099999999999999999999x", "a99999999999999999999x", 0), + ) +}) diff --git a/utils/number/number.go b/utils/number/number.go index 5176a83e4..daf3b4deb 100644 --- a/utils/number/number.go +++ b/utils/number/number.go @@ -2,11 +2,15 @@ package number import ( "strconv" - - "golang.org/x/exp/constraints" ) -func ParseInt[T constraints.Integer](s string) T { +// Integer is a constraint that permits any integer type. +type Integer interface { + ~int | ~int8 | ~int16 | ~int32 | ~int64 | + ~uint | ~uint8 | ~uint16 | ~uint32 | ~uint64 | ~uintptr +} + +func ParseInt[T Integer](s string) T { r, _ := strconv.ParseInt(s, 10, 64) return T(r) } diff --git a/utils/pl/pipelines.go b/utils/pl/pipelines.go index ed85c6b94..df4ee030c 100644 --- a/utils/pl/pipelines.go +++ b/utils/pl/pipelines.go @@ -29,7 +29,7 @@ func Stage[In any, Out any]( limit := int64(maxWorkers) sem1 := semaphore.NewWeighted(limit) - go func() { + go func() { //nolint:gosec // intentional context.Background() below to wait for workers after ctx cancellation defer close(outputChannel) defer close(errorChannel) @@ -58,7 +58,7 @@ func Stage[In any, Out any]( // By using context.Background() here we are assuming the fn will stop when the context // is canceled. This is required so we can wait for the workers to finish and avoid closing // the outputChannel before they are done. - if err := sem1.Acquire(context.Background(), limit); err != nil { + if err := sem1.Acquire(context.Background(), limit); err != nil { //nolint:gosec // intentional: must wait for workers after ctx cancellation log.Error(ctx, "Failed waiting for workers", err) } }() @@ -152,7 +152,7 @@ func Tee[T any](ctx context.Context, in <-chan T) (<-chan T, <-chan T) { defer close(out2) for val := range ReadOrDone(ctx, in) { var out1, out2 = out1, out2 - for i := 0; i < 2; i++ { + for range 2 { select { case <-ctx.Done(): case out1 <- val: diff --git a/utils/pl/pipelines_test.go b/utils/pl/pipelines_test.go index f5da6e49f..aa0b7faff 100644 --- a/utils/pl/pipelines_test.go +++ b/utils/pl/pipelines_test.go @@ -22,7 +22,7 @@ var _ = Describe("Pipeline", func() { Context("happy path", func() { It("calls the 'transform' function and returns values and errors", func() { inC := make(chan int, 4) - for i := 0; i < 4; i++ { + for i := range 4 { inC <- i } close(inC) @@ -48,7 +48,7 @@ var _ = Describe("Pipeline", func() { const numJobs = 100 It("starts multiple workers, respecting the limit", func() { inC := make(chan int, numJobs) - for i := 0; i < numJobs; i++ { + for i := range numJobs { inC <- i } close(inC) @@ -94,7 +94,7 @@ var _ = Describe("Pipeline", func() { BeforeEach(func() { in1 = make(chan int, 4) in2 = make(chan int, 4) - for i := 0; i < 4; i++ { + for i := range 4 { in1 <- i in2 <- i + 4 } @@ -126,7 +126,7 @@ var _ = Describe("Pipeline", func() { It("copies them to its output channel", func() { in := make(chan int) out := pl.ReadOrDone(context.Background(), in) - for i := 0; i < 4; i++ { + for i := range 4 { in <- i j := <-out Expect(i).To(Equal(j)) diff --git a/utils/random/number.go b/utils/random/number.go index 80c242c38..e93344c19 100644 --- a/utils/random/number.go +++ b/utils/random/number.go @@ -5,12 +5,12 @@ import ( "encoding/binary" "math/big" - "golang.org/x/exp/constraints" + "github.com/navidrome/navidrome/utils/number" ) // Int64N returns a random int64 between 0 and max. // This is a reimplementation of math/rand/v2.Int64N using a cryptographically secure random number generator. -func Int64N[T constraints.Integer](max T) int64 { +func Int64N[T number.Integer](max T) int64 { rnd, _ := rand.Int(rand.Reader, big.NewInt(int64(max))) return rnd.Int64() } diff --git a/utils/random/number_test.go b/utils/random/number_test.go index b591ae257..985a39426 100644 --- a/utils/random/number_test.go +++ b/utils/random/number_test.go @@ -16,7 +16,7 @@ func TestRandom(t *testing.T) { var _ = Describe("number package", func() { Describe("Int64N", func() { It("should return a random int64", func() { - for i := 0; i < 10000; i++ { + for range 10000 { Expect(random.Int64N(100)).To(BeNumerically("<", 100)) } }) diff --git a/utils/random/weighted_random_chooser_test.go b/utils/random/weighted_random_chooser_test.go index 026ee92cd..b336e6ca6 100644 --- a/utils/random/weighted_random_chooser_test.go +++ b/utils/random/weighted_random_chooser_test.go @@ -9,7 +9,7 @@ var _ = Describe("WeightedChooser", func() { var w *WeightedChooser[int] BeforeEach(func() { w = NewWeightedChooser[int]() - for i := 0; i < 10; i++ { + for i := range 10 { w.Add(i, i+1) } }) @@ -23,7 +23,7 @@ var _ = Describe("WeightedChooser", func() { It("removes items", func() { Expect(w.Size()).To(Equal(10)) - for i := 0; i < 10; i++ { + for range 10 { Expect(w.Remove(0)).To(Succeed()) } Expect(w.Size()).To(Equal(0)) @@ -43,7 +43,7 @@ var _ = Describe("WeightedChooser", func() { }) It("returns all items from the list", func() { - for i := 0; i < 10; i++ { + for range 10 { Expect(w.Pick()).To(BeElementOf(0, 1, 2, 3, 4, 5, 6, 7, 8, 9)) } Expect(w.Size()).To(Equal(0)) @@ -61,11 +61,11 @@ var _ = Describe("WeightedChooser", func() { It("chooses based on weights", func() { counts := [10]int{} - for i := 0; i < 200000; i++ { + for range 200000 { c, _ := w.weightedChoice() counts[c] = counts[c] + 1 } - for i := 0; i < 9; i++ { + for i := range 9 { Expect(counts[i]).To(BeNumerically("<", counts[i+1])) } }) diff --git a/utils/shellquote/shellquote.go b/utils/shellquote/shellquote.go new file mode 100644 index 000000000..685e3c2a7 --- /dev/null +++ b/utils/shellquote/shellquote.go @@ -0,0 +1,115 @@ +package shellquote + +import ( + "errors" + "strings" +) + +var ( + ErrUnterminatedSingleQuote = errors.New("unterminated single-quoted string") + ErrUnterminatedDoubleQuote = errors.New("unterminated double-quoted string") + ErrUnterminatedEscape = errors.New("unterminated backslash-escape") +) + +type state int + +const ( + stateUnquoted state = iota + stateSingleQuoted + stateDoubleQuoted +) + +// Split splits a string into words following POSIX-like shell quoting rules. +// It handles single quotes, double quotes, and backslash escapes. +func Split(input string) ([]string, error) { + var words []string + var word strings.Builder + inWord := false + parseState := stateUnquoted + + i := 0 + for i < len(input) { + ch := input[i] + + switch parseState { + case stateUnquoted: + switch { + case ch == '\\': + if i+1 >= len(input) { + return nil, ErrUnterminatedEscape + } + if input[i+1] == '\n' { + // Line continuation: skip both backslash and newline + i += 2 + continue + } + i++ + word.WriteByte(input[i]) + inWord = true + case ch == '\'': + parseState = stateSingleQuoted + inWord = true + case ch == '"': + parseState = stateDoubleQuoted + inWord = true + case ch == ' ' || ch == '\t' || ch == '\n': + if inWord { + words = append(words, word.String()) + word.Reset() + inWord = false + } + default: + word.WriteByte(ch) + inWord = true + } + + case stateSingleQuoted: + if ch == '\'' { + parseState = stateUnquoted + } else { + word.WriteByte(ch) + } + + case stateDoubleQuoted: + switch { + case ch == '"': + parseState = stateUnquoted + case ch == '\\': + if i+1 >= len(input) { + return nil, ErrUnterminatedEscape + } + next := input[i+1] + // In double quotes, backslash only escapes: $ ` " \n \ + if next == '$' || next == '`' || next == '"' || next == '\n' || next == '\\' { + if next == '\n' { + // Line continuation: skip both backslash and newline + i += 2 + continue + } + i++ + word.WriteByte(next) + } else { + // Backslash is literal for other characters + word.WriteByte(ch) + } + default: + word.WriteByte(ch) + } + } + + i++ + } + + switch parseState { + case stateSingleQuoted: + return nil, ErrUnterminatedSingleQuote + case stateDoubleQuoted: + return nil, ErrUnterminatedDoubleQuote + } + + if inWord { + words = append(words, word.String()) + } + + return words, nil +} diff --git a/utils/shellquote/shellquote_test.go b/utils/shellquote/shellquote_test.go new file mode 100644 index 000000000..889b83a5f --- /dev/null +++ b/utils/shellquote/shellquote_test.go @@ -0,0 +1,200 @@ +package shellquote_test + +import ( + "testing" + + "github.com/navidrome/navidrome/utils/shellquote" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestShellquote(t *testing.T) { + RegisterFailHandler(Fail) + RunSpecs(t, "Shellquote Suite") +} + +var _ = Describe("Split", func() { + It("splits simple space-separated words", func() { + words, err := shellquote.Split("a b c") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"a", "b", "c"})) + }) + + It("handles multiple spaces between words", func() { + words, err := shellquote.Split("a b") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"a", "b"})) + }) + + It("handles single-quoted strings", func() { + words, err := shellquote.Split("'hello world'") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"hello world"})) + }) + + It("handles double-quoted strings", func() { + words, err := shellquote.Split(`"hello world"`) + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"hello world"})) + }) + + It("handles backslash escapes in unquoted mode", func() { + words, err := shellquote.Split(`hello\ world`) + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"hello world"})) + }) + + It("handles escaped quotes inside double quotes", func() { + words, err := shellquote.Split(`"hello \" world"`) + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{`hello " world`})) + }) + + It("handles mixed quoting in a single argument", func() { + words, err := shellquote.Split("he'llo wo'rld") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"hello world"})) + }) + + It("returns empty slice for empty input", func() { + words, err := shellquote.Split("") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(BeEmpty()) + }) + + It("returns empty slice for whitespace-only input", func() { + words, err := shellquote.Split(" ") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(BeEmpty()) + }) + + It("returns error for unterminated single quote", func() { + _, err := shellquote.Split("'hello") + Expect(err).To(MatchError(shellquote.ErrUnterminatedSingleQuote)) + }) + + It("returns error for unterminated double quote", func() { + _, err := shellquote.Split(`"hello`) + Expect(err).To(MatchError(shellquote.ErrUnterminatedDoubleQuote)) + }) + + It("returns error for unterminated escape", func() { + _, err := shellquote.Split(`hello\`) + Expect(err).To(MatchError(shellquote.ErrUnterminatedEscape)) + }) + + It("handles tabs and newlines as delimiters", func() { + words, err := shellquote.Split("a\tb\nc") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"a", "b", "c"})) + }) + + It("parses the default MPV command template", func() { + words, err := shellquote.Split("mpv --audio-device=%d --no-audio-display --pause %f --input-ipc-server=%s") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(HaveLen(6)) + Expect(words).To(Equal([]string{ + "mpv", + "--audio-device=%d", + "--no-audio-display", + "--pause", + "%f", + "--input-ipc-server=%s", + })) + }) + + It("preserves spaces in quoted paths", func() { + words, err := shellquote.Split(`--ao-pcm-file="/audio/my folder/file"`) + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{`--ao-pcm-file=/audio/my folder/file`})) + }) + + It("handles backslash in double quotes for special chars", func() { + words, err := shellquote.Split(`"hello\\world"`) + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{`hello\world`})) + }) + + It("preserves backslash in double quotes for non-special chars", func() { + words, err := shellquote.Split(`"hello\nworld"`) + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{`hello\nworld`})) + }) + + It("handles escaped newline in double quotes", func() { + words, err := shellquote.Split("\"hello\\\nworld\"") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"helloworld"})) + }) + + // Cases from original go-shellquote test suite + It("handles shell glob characters as literals", func() { + words, err := shellquote.Split("glob* test?") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"glob*", "test?"})) + }) + + It("handles backslash-escaped special characters", func() { + words, err := shellquote.Split("don\\'t you know the dewey decimal system\\?") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"don't", "you", "know", "the", "dewey", "decimal", "system?"})) + }) + + It("handles single-quote escape idiom", func() { + // Shell idiom: end single-quote, escaped literal quote, start single-quote again + words, err := shellquote.Split("'don'\\''t you know the dewey decimal system?'") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"don't you know the dewey decimal system?"})) + }) + + It("handles empty string argument via quotes", func() { + words, err := shellquote.Split("one '' two") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"one", "", "two"})) + }) + + It("handles backslash-newline joining words in unquoted mode", func() { + words, err := shellquote.Split("text with\\\na backslash-escaped newline") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"text", "witha", "backslash-escaped", "newline"})) + }) + + It("handles quoted newline inside double quotes", func() { + words, err := shellquote.Split("text \"with\na\" quoted newline") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"text", "with\na", "quoted", "newline"})) + }) + + It("handles complex double-quoted escapes with backslash-newline", func() { + words, err := shellquote.Split("\"quoted\\d\\\\\\\" text with\\\na backslash-escaped newline\"") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"quoted\\d\\\" text witha backslash-escaped newline"})) + }) + + It("handles backslash-newline between words", func() { + words, err := shellquote.Split("text with an escaped \\\n newline in the middle") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"text", "with", "an", "escaped", "newline", "in", "the", "middle"})) + }) + + It("handles double-quoted substring concatenation", func() { + words, err := shellquote.Split(`foo"bar"baz`) + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"foobarbaz"})) + }) + + It("returns error for unterminated quote after escape idiom", func() { + _, err := shellquote.Split("'test'\\''ing") + Expect(err).To(MatchError(shellquote.ErrUnterminatedSingleQuote)) + }) + + It("returns error for unterminated double quote with single quote inside", func() { + _, err := shellquote.Split("\"foo'bar") + Expect(err).To(MatchError(shellquote.ErrUnterminatedDoubleQuote)) + }) + + It("returns error for unterminated escape with leading whitespace", func() { + _, err := shellquote.Split(" \\") + Expect(err).To(MatchError(shellquote.ErrUnterminatedEscape)) + }) +}) diff --git a/utils/singleton/singleton.go b/utils/singleton/singleton.go index 1066ae610..83f8c53ab 100644 --- a/utils/singleton/singleton.go +++ b/utils/singleton/singleton.go @@ -9,7 +9,7 @@ import ( ) var ( - instances = map[string]interface{}{} + instances = map[string]any{} pending = map[string]chan struct{}{} lock sync.RWMutex ) diff --git a/utils/singleton/singleton_test.go b/utils/singleton/singleton_test.go index c58bafd93..08e635652 100644 --- a/utils/singleton/singleton_test.go +++ b/utils/singleton/singleton_test.go @@ -69,7 +69,7 @@ var _ = Describe("GetInstance", func() { done.Add(numCallsToDo) numInstancesCreated = 0 - for i := 0; i < numCallsToDo; i++ { + for range numCallsToDo { go func() { // This is needed to make sure the test does not hang if it fails defer GinkgoRecover() diff --git a/utils/slice/slice.go b/utils/slice/slice.go index 1d7c64f50..e87ac5388 100644 --- a/utils/slice/slice.go +++ b/utils/slice/slice.go @@ -6,9 +6,8 @@ import ( "cmp" "io" "iter" + "maps" "slices" - - "golang.org/x/exp/maps" ) func Map[T any, R any](t []T, mapFunc func(T) R) []R { @@ -49,11 +48,9 @@ func CompactByFrequency[T comparable](list []T) []T { counters[item]++ } - sorted := maps.Keys(counters) - slices.SortFunc(sorted, func(i, j T) int { + return slices.SortedFunc(maps.Keys(counters), func(i, j T) int { return cmp.Compare(counters[j], counters[i]) }) - return sorted } func MostFrequent[T comparable](list []T) T { @@ -171,3 +168,14 @@ func SeqFunc[I, O any](s []I, f func(I) O) iter.Seq[O] { } } } + +// Filter returns a new slice containing only the elements of s for which filterFunc returns true +func Filter[T any](s []T, filterFunc func(T) bool) []T { + var result []T + for _, item := range s { + if filterFunc(item) { + result = append(result, item) + } + } + return result +} diff --git a/utils/slice/slice_test.go b/utils/slice/slice_test.go index c6d4be1e0..65e5f0934 100644 --- a/utils/slice/slice_test.go +++ b/utils/slice/slice_test.go @@ -172,4 +172,42 @@ var _ = Describe("Slice Utils", func() { Expect(result).To(ConsistOf("2", "4", "6", "8")) }) }) + + Describe("Filter", func() { + It("returns empty slice for an empty input", func() { + filterFunc := func(v int) bool { return v > 0 } + result := slice.Filter([]int{}, filterFunc) + Expect(result).To(BeEmpty()) + }) + + It("returns all elements when filter matches all", func() { + filterFunc := func(v int) bool { return v > 0 } + result := slice.Filter([]int{1, 2, 3, 4}, filterFunc) + Expect(result).To(HaveExactElements(1, 2, 3, 4)) + }) + + It("returns empty slice when filter matches none", func() { + filterFunc := func(v int) bool { return v > 10 } + result := slice.Filter([]int{1, 2, 3, 4}, filterFunc) + Expect(result).To(BeEmpty()) + }) + + It("returns only matching elements", func() { + filterFunc := func(v int) bool { return v%2 == 0 } + result := slice.Filter([]int{1, 2, 3, 4, 5, 6}, filterFunc) + Expect(result).To(HaveExactElements(2, 4, 6)) + }) + + It("works with string slices", func() { + filterFunc := func(s string) bool { return len(s) > 3 } + result := slice.Filter([]string{"a", "abc", "abcd", "ab", "abcde"}, filterFunc) + Expect(result).To(HaveExactElements("abcd", "abcde")) + }) + + It("preserves order of elements", func() { + filterFunc := func(v int) bool { return v%2 == 1 } + result := slice.Filter([]int{9, 8, 7, 6, 5, 4, 3, 2, 1}, filterFunc) + Expect(result).To(HaveExactElements(9, 7, 5, 3, 1)) + }) + }) }) diff --git a/utils/str/sanitize_strings.go b/utils/str/sanitize_strings.go index ff8b2fb47..73608112e 100644 --- a/utils/str/sanitize_strings.go +++ b/utils/str/sanitize_strings.go @@ -54,8 +54,8 @@ func SanitizeFieldForSortingNoArticle(originalValue string) string { } func RemoveArticle(name string) string { - articles := strings.Split(conf.Server.IgnoredArticles, " ") - for _, a := range articles { + articles := strings.SplitSeq(conf.Server.IgnoredArticles, " ") + for a := range articles { n := strings.TrimPrefix(name, a+" ") if n != name { return n diff --git a/utils/str/str.go b/utils/str/str.go index 8a94488de..177b48191 100644 --- a/utils/str/str.go +++ b/utils/str/str.go @@ -2,6 +2,7 @@ package str import ( "strings" + "unicode/utf8" ) var utf8ToAscii = func() *strings.Replacer { @@ -39,3 +40,22 @@ func LongestCommonPrefix(list []string) string { } return list[0] } + +// TruncateRunes truncates a string to a maximum number of runes, adding a suffix if truncated. +// The suffix is included in the rune count, so if maxRunes is 30 and suffix is "...", the actual +// string content will be truncated to fit within the maxRunes limit including the suffix. +func TruncateRunes(s string, maxRunes int, suffix string) string { + if utf8.RuneCountInString(s) <= maxRunes { + return s + } + + suffixRunes := utf8.RuneCountInString(suffix) + truncateAt := max(maxRunes-suffixRunes, 0) + + runes := []rune(s) + if truncateAt >= len(runes) { + return s + suffix + } + + return string(runes[:truncateAt]) + suffix +} diff --git a/utils/str/str_test.go b/utils/str/str_test.go index 0c3524e4e..511805831 100644 --- a/utils/str/str_test.go +++ b/utils/str/str_test.go @@ -31,6 +31,72 @@ var _ = Describe("String Utils", func() { Expect(str.LongestCommonPrefix(albums)).To(Equal("/artist/album")) }) }) + + Describe("TruncateRunes", func() { + It("returns string unchanged if under max runes", func() { + Expect(str.TruncateRunes("hello", 10, "...")).To(Equal("hello")) + }) + + It("returns string unchanged if exactly at max runes", func() { + Expect(str.TruncateRunes("hello", 5, "...")).To(Equal("hello")) + }) + + It("truncates and adds suffix when over max runes", func() { + Expect(str.TruncateRunes("hello world", 8, "...")).To(Equal("hello...")) + }) + + It("handles unicode characters correctly", func() { + // 6 emoji characters, maxRunes=5, suffix="..." (3 runes) + // So content gets 5-3=2 runes + Expect(str.TruncateRunes("😀😁😂😃😄😅", 5, "...")).To(Equal("😀😁...")) + }) + + It("handles multi-byte UTF-8 characters", func() { + // Characters like é are single runes + Expect(str.TruncateRunes("Café au Lait", 5, "...")).To(Equal("Ca...")) + }) + + It("works with empty suffix", func() { + Expect(str.TruncateRunes("hello world", 5, "")).To(Equal("hello")) + }) + + It("accounts for suffix length in truncation", func() { + // maxRunes=10, suffix="..." (3 runes) -> leaves 7 runes for content + result := str.TruncateRunes("hello world this is long", 10, "...") + Expect(result).To(Equal("hello w...")) + // Verify total rune count is <= maxRunes + runeCount := len([]rune(result)) + Expect(runeCount).To(BeNumerically("<=", 10)) + }) + + It("handles very long suffix gracefully", func() { + // If suffix is longer than maxRunes, we still add it + // but the content will be truncated to 0 + result := str.TruncateRunes("hello world", 5, "... (truncated)") + // Result will be just the suffix (since truncateAt=0) + Expect(result).To(Equal("... (truncated)")) + }) + + It("handles empty string", func() { + Expect(str.TruncateRunes("", 10, "...")).To(Equal("")) + }) + + It("uses custom suffix", func() { + // maxRunes=11, suffix=" [...]" (6 runes) -> content gets 5 runes + // "hello world" is 11 runes exactly, so we need a longer string + Expect(str.TruncateRunes("hello world extra", 11, " [...]")).To(Equal("hello [...]")) + }) + + DescribeTable("truncates at rune boundaries (not byte boundaries)", + func(input string, maxRunes int, suffix string, expected string) { + Expect(str.TruncateRunes(input, maxRunes, suffix)).To(Equal(expected)) + }, + Entry("ASCII", "abcdefghij", 5, "...", "ab..."), + Entry("Mixed ASCII and Unicode", "ab😀cd", 4, ".", "ab😀."), + Entry("All emoji", "😀😁😂😃😄", 3, "…", "😀😁…"), + Entry("Japanese", "こんにちは世界", 3, "…", "こん…"), + ) + }) }) var testPaths = []string{