Compare commits
5
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
edff6eedc9 | ||
|
|
9c75e74ea3 | ||
|
|
76a2d9609b | ||
|
|
30a9cb32f5 | ||
|
|
88260ab6c9 |
@@ -28,7 +28,7 @@ jobs:
|
||||
if: "!startsWith(github.event.head_commit.message, 'chore(release)')"
|
||||
runs-on: linux/amd64
|
||||
container:
|
||||
image: gitea.tourolle.paris/dtourolle/jellytau-builder:2026.08
|
||||
image: gitea.tourolle.paris/dtourolle/jellytau-builder:2026.08.1
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
@@ -187,7 +187,7 @@ jobs:
|
||||
runs-on: linux/amd64
|
||||
needs: test
|
||||
container:
|
||||
image: gitea.tourolle.paris/dtourolle/jellytau-builder:2026.08
|
||||
image: gitea.tourolle.paris/dtourolle/jellytau-builder:2026.08.1
|
||||
env:
|
||||
ANDROID_HOME: /opt/android-sdk
|
||||
ANDROID_SDK_ROOT: /opt/android-sdk
|
||||
@@ -256,7 +256,7 @@ jobs:
|
||||
name: Supply Chain
|
||||
runs-on: linux/amd64
|
||||
container:
|
||||
image: gitea.tourolle.paris/dtourolle/jellytau-builder:2026.08
|
||||
image: gitea.tourolle.paris/dtourolle/jellytau-builder:2026.08.1
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
|
||||
@@ -21,7 +21,7 @@ jobs:
|
||||
name: Run Tests
|
||||
runs-on: linux/amd64
|
||||
container:
|
||||
image: gitea.tourolle.paris/dtourolle/jellytau-builder:2026.08
|
||||
image: gitea.tourolle.paris/dtourolle/jellytau-builder:2026.08.1
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
@@ -94,7 +94,7 @@ jobs:
|
||||
runs-on: linux/amd64
|
||||
needs: test
|
||||
container:
|
||||
image: gitea.tourolle.paris/dtourolle/jellytau-builder:2026.08
|
||||
image: gitea.tourolle.paris/dtourolle/jellytau-builder:2026.08.1
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
@@ -190,12 +190,15 @@ jobs:
|
||||
# Without nullglob an unmatched pattern stays literal, so test each
|
||||
# candidate instead. Same POSIX-only rule as traceability-check.yml.
|
||||
#
|
||||
# The .AppImage.tar.gz + .sig pair is what the updater downloads and
|
||||
# verifies; the plain .AppImage is what a human downloads. Both ship.
|
||||
# Tauri v2 signs the .AppImage ITSELF and writes <name>.AppImage.sig
|
||||
# beside it -- there is no .AppImage.tar.gz unless
|
||||
# bundle.createUpdaterArtifacts is set to "v1Compatible". The updater
|
||||
# downloads the same AppImage a human does and verifies that .sig, so
|
||||
# both files must ship or the manifest points at a signature nobody
|
||||
# can fetch.
|
||||
for bundle in \
|
||||
src-tauri/target/release/bundle/appimage/*.AppImage \
|
||||
src-tauri/target/release/bundle/appimage/*.AppImage.tar.gz \
|
||||
src-tauri/target/release/bundle/appimage/*.AppImage.tar.gz.sig \
|
||||
src-tauri/target/release/bundle/appimage/*.AppImage.sig \
|
||||
src-tauri/target/release/bundle/deb/*.deb \
|
||||
src-tauri/target/release/bundle/rpm/*.rpm; do
|
||||
[ -e "$bundle" ] || continue
|
||||
@@ -232,7 +235,7 @@ jobs:
|
||||
# baked into the builder image. No toolchain installs here — the image has
|
||||
# cargo-xwin, clang/clang-cl, lld, llvm, nsis and the msvc target.
|
||||
container:
|
||||
image: gitea.tourolle.paris/dtourolle/jellytau-builder:2026.08
|
||||
image: gitea.tourolle.paris/dtourolle/jellytau-builder:2026.08.1
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
@@ -305,7 +308,7 @@ jobs:
|
||||
runs-on: linux/amd64
|
||||
needs: test
|
||||
container:
|
||||
image: gitea.tourolle.paris/dtourolle/jellytau-builder:2026.08
|
||||
image: gitea.tourolle.paris/dtourolle/jellytau-builder:2026.08.1
|
||||
env:
|
||||
ANDROID_HOME: /opt/android-sdk
|
||||
ANDROID_SDK_ROOT: /opt/android-sdk
|
||||
@@ -408,7 +411,7 @@ jobs:
|
||||
needs: [build-linux, build-windows, build-android]
|
||||
if: startsWith(github.ref, 'refs/tags/v')
|
||||
container:
|
||||
image: gitea.tourolle.paris/dtourolle/jellytau-builder:2026.08
|
||||
image: gitea.tourolle.paris/dtourolle/jellytau-builder:2026.08.1
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
@@ -499,8 +502,13 @@ jobs:
|
||||
APPIMAGE_URL=""
|
||||
NSIS_URL=""
|
||||
|
||||
for f in artifacts/linux/*.AppImage.tar.gz; do
|
||||
# Tauri v2 signs the AppImage itself; <name>.AppImage.sig sits beside
|
||||
# it. Verified against a real signed build before tagging -- the
|
||||
# v1-style .AppImage.tar.gz is never produced with
|
||||
# createUpdaterArtifacts: true.
|
||||
for f in artifacts/linux/*.AppImage; do
|
||||
[ -e "$f" ] || continue
|
||||
case "$f" in *.sig) continue;; esac
|
||||
APPIMAGE_URL="${BASE}/$(basename "$f")"
|
||||
[ -e "$f.sig" ] && APPIMAGE_SIG="$(cat "$f.sig")"
|
||||
done
|
||||
|
||||
@@ -21,7 +21,7 @@ jobs:
|
||||
name: Build & publish docs to gitea-pages
|
||||
runs-on: linux/amd64
|
||||
container:
|
||||
image: gitea.tourolle.paris/dtourolle/jellytau-builder:2026.08
|
||||
image: gitea.tourolle.paris/dtourolle/jellytau-builder:2026.08.1
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
|
||||
@@ -17,7 +17,7 @@ jobs:
|
||||
runs-on: linux/amd64
|
||||
name: Check Requirement Traces
|
||||
container:
|
||||
image: gitea.tourolle.paris/dtourolle/jellytau-builder:2026.08
|
||||
image: gitea.tourolle.paris/dtourolle/jellytau-builder:2026.08.1
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
|
||||
+119
@@ -9,6 +9,125 @@ generated trace matrix lives in [docs/traceability.md](docs/traceability.md).
|
||||
For how long each fixed defect had been shipping before it was found, see
|
||||
[docs/defect-windows.md](docs/defect-windows.md).
|
||||
|
||||
## v0.10.1
|
||||
|
||||
A single fix, for something that had been quietly overriding a choice you made.
|
||||
|
||||
### 🐛 Fixes
|
||||
|
||||
- **Locking the screen no longer keeps playing a video's audio unless you asked
|
||||
it to.** The player has a background-audio button: turn it on and the sound
|
||||
carries on when you lock the screen or leave the app, turn it off and playback
|
||||
stops. It stopped working when video moved to the native renderer — which plays
|
||||
through a media service designed to keep going while the app is hidden — and
|
||||
nothing was left to stop it. So the audio continued whether the button was on
|
||||
or off, and there was no way to make it behave otherwise. The button governs it
|
||||
again: with it off, locking the screen pauses the video and unlocking resumes
|
||||
where you were; with it on, the audio continues as before. Music is untouched —
|
||||
it keeps playing when backgrounded, as a music player should — and a video in a
|
||||
picture-in-picture window keeps playing too, because the window is still on
|
||||
screen. If you had already paused before locking, it stays paused.
|
||||
(UR-040 → DR-224)
|
||||
|
||||
## v0.10.0
|
||||
|
||||
Two things you can see, and a great deal of work on how this project builds and
|
||||
ships itself. The app can now update itself, and it can tell you what it did
|
||||
when something goes wrong — both of which existed as gaps rather than as bugs,
|
||||
which is why they lasted so long.
|
||||
|
||||
### ✨ Changes
|
||||
|
||||
- **JellyTau can update itself.** Anyone who installed an AppImage or ran the
|
||||
Windows installer was frozen on that version permanently: nothing in the app
|
||||
ever mentioned that a newer one existed, and the release page was the only
|
||||
announcement. Settings → Updates now checks, shows what changed, and installs
|
||||
and restarts on request. Each download is verified against JellyTau's signing
|
||||
key before anything is installed, so a substituted file is refused rather than
|
||||
run. Android is deliberately not wired to this — an app may not replace its own
|
||||
APK, that is the system installer's job — and is given a link to the releases
|
||||
page instead of a button that would fail. (UR-077 → DR-217)
|
||||
|
||||
- **You can export a diagnostics bundle.** Until now the app forgot everything it
|
||||
had done the moment it closed. Logs went to standard output, which nobody sees
|
||||
when launching from a desktop icon, and on Android went nowhere at all — so the
|
||||
backend was invisible on the platform where the hardest playback bugs live. A
|
||||
crash left nothing behind. Logs are now kept in a size-capped file that
|
||||
survives a restart, a crash is recorded before the app dies, and Settings →
|
||||
Diagnostics exports the lot as one file to attach to a bug report. Access
|
||||
tokens and passwords are stripped before anything is written to disk, not
|
||||
merely before it is exported. Nothing is transmitted anywhere; you attach the
|
||||
file yourself. (UR-078 → DR-218)
|
||||
|
||||
- **Linux gets an AppImage again.** The release notes have advertised one for
|
||||
months while the build never produced it — the packaging step looked for the
|
||||
file, found nothing, and said nothing. (DR-217)
|
||||
|
||||
### 🐛 Fixes
|
||||
|
||||
- **Releases no longer ship every Windows installer ever built.** Every release
|
||||
from v0.1.0 to v0.8.2 carried its predecessors': sixteen installers on v0.8.2,
|
||||
thirteen of them stale, and a download list on v0.5.0 reaching back to 0.1.0.
|
||||
The build directory is never cleaned and the build machine reuses it, so each
|
||||
release collected whatever was left behind. It went unnoticed for eight months
|
||||
because nothing looked wrong — the files were real and the page merely looked
|
||||
busy. The stale files have been removed from the published releases, the build
|
||||
now clears that directory first, and a check refuses to publish a release
|
||||
containing an artifact from a different version. (DR-220)
|
||||
|
||||
- **Release notes now say what changed.** All 35 previous releases published the
|
||||
same block of generic install instructions, whose "What's New" section was a
|
||||
link to a file that does not resolve from a release page. Every release page
|
||||
now carries its own entry from this changelog, and the past ones have been
|
||||
filled in. (DR-219)
|
||||
|
||||
### 🔒 Security and supply chain
|
||||
|
||||
- **Dependencies are now checked against a vulnerability database on every
|
||||
build.** They never had been. The first run found eight vulnerabilities and one
|
||||
unsoundness in the Rust dependency graph — all of them fixed by an update
|
||||
nobody had a reason to run. Licences are checked against an allow-list too, so
|
||||
nothing gets redistributed inside a release that does not permit it.
|
||||
(DR-216)
|
||||
|
||||
- **Every release publishes checksums and a bill of materials.** `SHA256SUMS`
|
||||
lets you verify a download (`sha256sum -c SHA256SUMS`); the SBOM lists what
|
||||
went into the build, so "does this release contain <vulnerable library>?" has
|
||||
an answer that is not "rebuild it and find out". (DR-216)
|
||||
|
||||
- **Builds are reproducible again.** Every CI job named a container image tag
|
||||
that was rewritten in place, so rebuilding an old release did not necessarily
|
||||
rebuild the same thing. Jobs now pin an immutable tag. The one dependency that
|
||||
comes from a git branch rather than a package registry is pinned to an exact
|
||||
revision, closing a path by which new upstream code could arrive unreviewed in
|
||||
a library linked into the player. (DR-216)
|
||||
|
||||
### 🧹 Under the hood
|
||||
|
||||
- Formatting, linting and type-checking now run in CI. All three were configured
|
||||
and enforced by nothing: 199 files did not match the project's own formatter, a
|
||||
type error could sit on the main branch until somebody cut a release, and the
|
||||
test-coverage command had been broken for months by a dependency mismatch.
|
||||
Coverage now has a floor that only moves up. (DR-215)
|
||||
|
||||
- The traceability matrix counts requirements implemented by configuration.
|
||||
Several carried the necessary annotations and were being counted as uncovered
|
||||
because the extraction tool only read source files. (DR-215)
|
||||
|
||||
- The project now has a security policy, contribution guide, code of conduct,
|
||||
issue and pull-request templates, and an operations document covering the
|
||||
builder image, the release secrets, and what losing the signing key would mean.
|
||||
|
||||
- The app framework moved from Tauri 2.9.5 to 2.11.5. Nothing about this is
|
||||
visible in use, but it is worth recording that it did not go quietly: the
|
||||
windowing layer beneath Tauri quietly stopped publishing the Android JavaVM
|
||||
and application handle that this app's credential storage had been reading for
|
||||
its whole life. Nothing here had changed; a side effect several dependencies
|
||||
down had simply gone away, and the app aborted on launch on every Android
|
||||
device. JellyTau now sets that handle itself rather than relying on someone
|
||||
else to do it. Caught by installing on a real tablet before release — no test
|
||||
suite runs the app. (UR-012 → DR-223)
|
||||
|
||||
## v0.9.1
|
||||
|
||||
A one-line fix to the home screen, released on its own because it is the kind of
|
||||
|
||||
@@ -141,6 +141,17 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
|
||||
lld \
|
||||
llvm \
|
||||
nsis \
|
||||
# AppImage bundling. linuxdeploy embeds xdg-open into the AppImage and
|
||||
# aborts the whole bundle if it is missing:
|
||||
# failed to bundle project: xdg-open binary not found
|
||||
# It is present on most desktop distros, which is why the AppImage built on
|
||||
# a developer machine and failed here. desktop-file-utils and zsync are the
|
||||
# other two linuxdeploy commonly wants (desktop-file-validate, and zsync for
|
||||
# delta updates), added together so a missing one does not cost another
|
||||
# image rebuild and another failed release build.
|
||||
xdg-utils \
|
||||
desktop-file-utils \
|
||||
zsync \
|
||||
&& rm -rf /var/lib/apt/lists/* \
|
||||
# Ubuntu's clang package ships clang but NOT the clang-cl alias that cc-rs
|
||||
# invokes for MSVC targets. clang-cl is the same binary in MSVC-compat mode,
|
||||
|
||||
Vendored
+24
@@ -61,6 +61,11 @@ filled. Keep a couple of dated tags live and prune the rest.
|
||||
|
||||
The order matters — CI breaks if the workflow lands before the image exists.
|
||||
|
||||
A caveat learned the hard way: the *trailing* layer is only fast for `cargo
|
||||
install` tools. Adding an **apt** package invalidates the packaging layer, which
|
||||
sits above the `cargo-xwin`/`cargo-deny` installs, so those recompile too — a
|
||||
~20 minute rebuild rather than ~2.
|
||||
|
||||
```bash
|
||||
# 1. Edit Dockerfile.builder. Put new tools in the TRAILING layer: it exists so
|
||||
# a tool change is a ~2 min rebuild instead of ~15.
|
||||
@@ -103,6 +108,25 @@ transitive upgrade (bumping `tauri-plugin-log` to 2.9.0 also moved `wry`,
|
||||
therefore video playback. That is a change to make deliberately, with a full
|
||||
build and a playback check — not one to slip into a release.
|
||||
|
||||
## AppImage needs more than the Rust toolchain
|
||||
|
||||
`linuxdeploy` (which Tauri downloads at build time to assemble the AppImage)
|
||||
shells out to distro tools that a minimal server image does not have. It aborts
|
||||
the whole bundle on the first one missing:
|
||||
|
||||
```
|
||||
failed to bundle project: xdg-open binary not found
|
||||
```
|
||||
|
||||
The image therefore carries `xdg-utils`, `desktop-file-utils` and `zsync`. This
|
||||
is a class of failure that **cannot be caught by building locally**: a developer
|
||||
machine is a desktop and has all three, so the AppImage builds there and fails in
|
||||
CI. It cost one release build to find.
|
||||
|
||||
Tauri's AppImage bundler also downloads `linuxdeploy`, `AppRun` and two plugin
|
||||
scripts from GitHub during the build. That is Tauri's behaviour, not ours, but it
|
||||
means an AppImage build depends on GitHub being reachable from the runner.
|
||||
|
||||
## Secrets
|
||||
|
||||
Managed with the `tea` CLI (`tea actions secrets list`) or the repo settings UI.
|
||||
|
||||
@@ -415,6 +415,7 @@ Internal architecture, components, and application logic.
|
||||
| DR-221 | The release path is exercised before a tag exists. Nothing in `build-and-test.yml` runs `tauri build` — only a tag does — so a whole class of breakage was invisible until release day, and two instances of it were sitting on master at once. Tauri refuses to build when a plugin's Rust crate and npm package differ by minor version, which the updater and logging work had introduced (`tauri-plugin-log 2.8.0` against `@tauri-apps/plugin-log 2.9.0`) while `cargo check`, clippy, the tests and `svelte-check` all passed; both sides are now pinned exactly rather than by caret, since a caret is what let them separate, and CI runs `tauri info` to compare them without building. The AppImage target had never once been built: linuxdeploy carries a `strip` too old to parse the `.relr.dyn` section modern toolchains emit, so bundling failed on every library — and Ubuntu 23.10+ links with `-z pack-relative-relocs` by default, so the builder image fails the same way a modern Arch host does. `NO_STRIP=true` is linuxdeploy's documented escape hatch; the cost is a larger, unstripped bundle. Both were found by building the target locally before tagging rather than by publishing a release that could not build | Tooling | - | Done |
|
||||
| DR-222 | Build tooling matches the package manager the project declares. `scripts/build-android.sh` ran `npm install` on its clean-build path — in a bun project, where `packageManager` says bun and `bun.lock` is the committed lockfile. npm ignores that lockfile, re-resolves the whole tree from package.json, and writes a `package-lock.json` that `.gitignore` then hides. That is not a style preference: the JS halves of the Tauri plugins are pinned exactly against Cargo.lock because the CLI refuses to build when a plugin's crate and package differ by minor version, and a silent re-resolve is precisely how they drift apart. It survived because clean builds are rare — the shape shared by nearly every defect found preparing v0.10.0, where the code running on every commit was healthy and the code running on a release, a tag or a clean build had no guard at all. `scripts/check-tooling.sh` fails on any npm/yarn/pnpm invocation or foreign lockfile | Tooling | - | Done |
|
||||
| DR-223 | The Android JavaVM and Application are published into `ndk_context` by this crate, not by a transitive dependency. Seven call sites (five in credentials.rs, two in lib.rs) read that process-global to reach JNI, and nothing here ever set it — `tao` did, three levels below anything this project names in Cargo.toml. tao 0.35.3 moved those pointers into a private struct and stopped publishing them, so the Tauri 2.11 upgrade made the first credential read abort the process on every launch: `PANIC ... android context was not initialized`. Our code had not changed; an undocumented side effect of the windowing layer had gone. The invariant is now owned here rather than assumed: `JNI_OnLoad` captures the JavaVM as the shared library loads, and the Application is resolved lazily via `ActivityThread.currentApplication()` and pinned as a global reference for the process lifetime — the Application rather than the Activity, since that is what `SecureStorage.initialize()` immediately reduces its argument to. Failure degrades to the encrypted-file credential path and is logged, rather than aborting. Found only by installing on a device: nothing in CI runs the app | Security | UR-012 | Done |
|
||||
| DR-224 | Backgrounding the app obeys the background-audio toggle on every renderer. The toggle (UR-040) was built for the WebView `<video>` path, where losing visibility kills the decode: it chose between handing off to a native audio stream and letting playback stop. Native video then became the default renderer (DR-188), and on that path playback runs through ExoPlayer inside a `MediaSessionService` — a foreground media service whose purpose is to keep playing while the app is hidden. Nothing paused it and nothing in the codebase paused on background, so locking the screen kept the audio going whether or not the toggle was on: the toggle governed a handoff that no longer had a gap to bridge, and users got background playback they never asked for. The decision now lives in Rust (`player/background_policy.rs`) and both renderers obey it: a video with the toggle off pauses, with the toggle on hands off to audio, music is never paused by backgrounding, and picture-in-picture keeps playing because the window is still on screen (UR-041). It takes no renderer parameter on purpose — the split between the two paths is what produced the defect | Player | UR-040 | Done |
|
||||
| DR-198 | The webview runs under a real Content-Security-Policy, and the asset protocol is scoped to the one directory it still serves. `csp` was `null`, which disables CSP entirely: any script that reached the web layer — through a future `{@html}`, a dependency, or a devtools paste — would have inherited the whole IPC surface, and with it the user's session. `script-src 'self'` (Tauri injects a nonce for SvelteKit's inline bootstrap script at build time, so no `'unsafe-inline'` is needed) plus `object-src`/`frame-src 'none'` and `base-uri 'self'` is the part that is genuinely restrictive. `img-src`/`media-src`/`connect-src` cannot be: the Jellyfin origin is typed in by the user at run time and is commonly plain `http` on a LAN, so they allow `http:`/`https:` — a wide grant for *data*, but one that still bars `file:`, `filesystem:` and scripting schemes, and leaves `script-src` untouched. `style-src` keeps `'unsafe-inline'` because Svelte compiles `style="…"` attributes (including `app.html`'s `display: contents` wrapper) into markup; this is safe only while no `<style>` element survives into `index.html`, since a nonce there would make Tauri's injection outrank — and therefore void — `'unsafe-inline'`. `worker-src blob:` and `media-src blob:` are hls.js: it demuxes in a worker built from a blob and attaches MSE through `URL.createObjectURL`. `asset:` and `http://asset.localhost` are the same protocol under the two naming schemes `convertFileSrc` emits (custom scheme on Linux/macOS, `http` host on Windows/Android); `ipc:`/`http://ipc.localhost` is the invoke transport, which would otherwise be blocked by `connect-src`. A run-time CSP naming the server origin exactly was rejected: Tauri computes the header from immutable config when it serves the HTML, so it would mean rebuilding config and reloading the webview on every server change, for a policy the user can already point anywhere. The asset-protocol scope narrows from `$APPDATA/**` to `$APPDATA/thumbnails/**` — since DR-137 moved downloaded media to the loopback server, `imageCache` is the only `convertFileSrc` caller left, so the database and the encrypted-token fallback file no longer sit inside the grant | Security | UR-012, UR-071 | Done |
|
||||
|
||||
---
|
||||
@@ -715,6 +716,7 @@ Internal architecture, components, and application logic.
|
||||
| UT-208 | The update decision: each numeric version field is compared in order, the installed version is not offered to itself, a leading `v` is tolerated because that is how the tags are written, a pre-release sorts below the release of the same number so 0.9.2-rc1 is not offered to somebody on 0.9.2, a missing patch field reads as zero rather than NaN, mobile reports link-only while desktop reports install, and absent release notes normalise to null rather than undefined | DR-217 | Done |
|
||||
| UT-209 | Redaction and forwarding. Rust: every credential shape reduces to `[REDACTED]` while the host, username and neighbouring parameters survive; redaction is idempotent, leaves ordinary lines alone, does not fire on the word "token" in prose, and does not panic on multi-byte input; a server URL keeps only scheme and host and drops an embedded `user:pass@`; an unparseable level falls back to info rather than failing at startup. Frontend: info and above forward while debug does not, a message the level filter suppressed is not forwarded, a throwing forwarder neither propagates nor prevents the console write, and an `Error` renders as name and message rather than the `{}` that `JSON.stringify` produces | DR-218 | Done |
|
||||
| UT-210 | Cosmetic-commit detection for release notes: a `chore(format)`, `chore(deps)` or `style` subject is skipped when deriving a range's changed files, while `fix`, `feat`, `ci`, `docs`, a bare `chore:` and `chore(release):` are kept; and the word "format" appearing later in a subject ("fix(duration): format times over 24 hours") does not make a real fix look cosmetic | DR-219 | Done |
|
||||
| UT-211 | The background decision: a video with the toggle off pauses (the reported defect, where the media service kept playing regardless), a video with it on hands off to audio, music keeps playing whatever the toggle says because it has no picture to lose, picture-in-picture keeps playing in every combination since the window is still visible, and the answer does not vary by renderer | DR-224 | Done |
|
||||
|
||||
### Integration Tests
|
||||
|
||||
|
||||
@@ -28,7 +28,7 @@ know how something *works*, read
|
||||
|
||||
**Next free requirement ids** (always re-check
|
||||
[requirements.md](../requirements.md) before allocating): **UR-079**,
|
||||
**IR-033**, **DR-224**. Three specs below suggested ids that have since been
|
||||
**IR-033**, **DR-225**. Three specs below suggested ids that have since been
|
||||
taken by other work; each carries a ⚠️ note at the top.
|
||||
|
||||
## Partially implemented
|
||||
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "jellytau",
|
||||
"version": "0.9.1",
|
||||
"version": "0.10.1",
|
||||
"description": "A cross-platform Jellyfin client built with Tauri, SvelteKit and Rust.",
|
||||
"author": "Duncan Tourolle <duncan@tourolle.paris>",
|
||||
"license": "MIT",
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
# tarball/VCS URL and drop the local-copy prepare() step.
|
||||
|
||||
pkgname=jellytau
|
||||
pkgver=0.9.1
|
||||
pkgver=0.10.1
|
||||
pkgrel=1
|
||||
pkgdesc="A cross-platform Jellyfin client"
|
||||
arch=('x86_64')
|
||||
|
||||
Generated
+1
-1
@@ -2181,7 +2181,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "jellytau"
|
||||
version = "0.9.1"
|
||||
version = "0.10.1"
|
||||
dependencies = [
|
||||
"aes-gcm",
|
||||
"async-trait",
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "jellytau"
|
||||
version = "0.9.1"
|
||||
version = "0.10.1"
|
||||
description = "A cross-platform Jellyfin client"
|
||||
authors = ["Duncan Tourolle <duncan@tourolle.paris>"]
|
||||
license = "MIT"
|
||||
|
||||
@@ -164,17 +164,33 @@ class MainActivity : TauriActivity() {
|
||||
*/
|
||||
override fun onStop() {
|
||||
super.onStop()
|
||||
if (backgroundAudioEnabled) {
|
||||
dispatchWebEvent("jellytau-background")
|
||||
// Fires unconditionally now. It used to be gated on backgroundAudioEnabled,
|
||||
// which meant the frontend was never told the app had gone away unless the
|
||||
// toggle was already on -- so with the toggle OFF nothing could react, and
|
||||
// on the native path ExoPlayer's media service simply kept playing. That is
|
||||
// the whole defect: the toggle appeared to do nothing because the only
|
||||
// notification of backgrounding was itself gated on the toggle (DR-224).
|
||||
//
|
||||
// What to DO about it is decided in Rust (player_background_action); this
|
||||
// only reports the two facts the activity alone knows.
|
||||
val inPip = if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.N) {
|
||||
isInPictureInPictureMode
|
||||
} else {
|
||||
false
|
||||
}
|
||||
dispatchWebEvent(
|
||||
"jellytau-background",
|
||||
"{\"backgroundAudioArmed\": $backgroundAudioEnabled, \"inPictureInPicture\": $inPip}"
|
||||
)
|
||||
}
|
||||
|
||||
/** The app is visible again — tell the frontend to resume WebView video. */
|
||||
override fun onStart() {
|
||||
super.onStart()
|
||||
if (backgroundAudioEnabled) {
|
||||
dispatchWebEvent("jellytau-foreground")
|
||||
}
|
||||
// Also unconditional, for the same reason: a video paused on background has
|
||||
// to be told it is visible again, and that pause happens with the toggle
|
||||
// OFF. The frontend ignores this when it has nothing to restore.
|
||||
dispatchWebEvent("jellytau-foreground")
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -182,14 +198,14 @@ class MainActivity : TauriActivity() {
|
||||
* evaluateJavascript pattern already used to unmute video elements. Posted to
|
||||
* the WebView thread; safe no-op if the WebView isn't found yet.
|
||||
*/
|
||||
private fun dispatchWebEvent(name: String) {
|
||||
private fun dispatchWebEvent(name: String, detailJson: String = "null") {
|
||||
val webView = mediaWebView ?: run {
|
||||
android.util.Log.w("MainActivity", "dispatchWebEvent('$name'): no WebView")
|
||||
return
|
||||
}
|
||||
webView.post {
|
||||
webView.evaluateJavascript(
|
||||
"window.dispatchEvent(new CustomEvent('$name'));",
|
||||
"window.dispatchEvent(new CustomEvent('$name', { detail: $detailJson }));",
|
||||
null
|
||||
)
|
||||
android.util.Log.d("MainActivity", "Dispatched web event: $name")
|
||||
|
||||
@@ -840,6 +840,46 @@ pub async fn player_enter_background_audio(
|
||||
/// untouched — if it fired while backgrounded, playback is already stopped and
|
||||
/// this simply reports the last position.
|
||||
///
|
||||
/// What playback should do now that the app is no longer visible.
|
||||
///
|
||||
/// The caller supplies only what it alone knows -- whether the per-player
|
||||
/// toggle is armed, and whether Android put the window into picture-in-picture.
|
||||
/// Everything else (what is playing, and therefore whether there is a picture to
|
||||
/// lose) is read here, because it is domain state.
|
||||
///
|
||||
/// The rule itself is in `player::background_policy`; this command is the wire.
|
||||
/// Returning `KeepPlaying` for an empty queue is deliberate: with nothing
|
||||
/// playing there is nothing to pause, and an error would make the frontend
|
||||
/// handle a case that is not a failure.
|
||||
///
|
||||
/// TRACES: UR-040, UR-041 | DR-224 | UT-211
|
||||
#[tauri::command]
|
||||
#[specta::specta]
|
||||
pub async fn player_background_action(
|
||||
player: State<'_, PlayerStateWrapper>,
|
||||
background_audio_armed: bool,
|
||||
in_picture_in_picture: bool,
|
||||
) -> Result<crate::player::background_policy::BackgroundAction, String> {
|
||||
use crate::player::background_policy::{background_action, is_video_media, BackgroundAction};
|
||||
|
||||
let is_video = {
|
||||
let controller = player.0.lock().await;
|
||||
let queue_arc = controller.queue();
|
||||
let queue = queue_arc.lock().map_err(|e| e.to_string())?;
|
||||
match queue.current() {
|
||||
Some(item) => is_video_media(item.media_type),
|
||||
None => return Ok(BackgroundAction::KeepPlaying),
|
||||
}
|
||||
};
|
||||
|
||||
let action = background_action(is_video, background_audio_armed, in_picture_in_picture);
|
||||
info!(
|
||||
"[player_background_action] video={} armed={} pip={} -> {:?}",
|
||||
is_video, background_audio_armed, in_picture_in_picture, action
|
||||
);
|
||||
Ok(action)
|
||||
}
|
||||
|
||||
/// TRACES: UR-040 | DR-052 | UT-061, IT-013
|
||||
#[tauri::command]
|
||||
#[specta::specta]
|
||||
|
||||
@@ -121,6 +121,7 @@ use commands::{
|
||||
player_add_to_queue,
|
||||
player_add_track_by_id,
|
||||
player_add_tracks_by_ids,
|
||||
player_background_action,
|
||||
player_cancel_autoplay_countdown,
|
||||
player_cancel_sleep_timer,
|
||||
// Jellyfin reporting commands
|
||||
@@ -742,6 +743,7 @@ fn specta_builder() -> Builder<tauri::Wry> {
|
||||
.commands(tauri_specta::collect_commands![
|
||||
// Player commands
|
||||
player_play_item,
|
||||
player_background_action,
|
||||
player_enter_background_audio,
|
||||
player_exit_background_audio,
|
||||
player_play_queue,
|
||||
|
||||
@@ -0,0 +1,155 @@
|
||||
//! What playback should do when the app stops being visible.
|
||||
//!
|
||||
//! TRACES: UR-040 | DR-224 | UT-211
|
||||
//!
|
||||
//! # The defect this exists for
|
||||
//!
|
||||
//! The per-player background-audio toggle (UR-040) was built for the WebView
|
||||
//! `<video>` path, where backgrounding the app kills the decode: the toggle
|
||||
//! decided whether to *hand off* to a native audio stream or let playback die.
|
||||
//!
|
||||
//! Native video then became the default renderer (DR-188). On that path playback
|
||||
//! runs through ExoPlayer inside a `MediaSessionService` — a foreground media
|
||||
//! service whose entire purpose is to keep playing when the app is not visible.
|
||||
//! Nothing stops it, and nothing in the codebase paused playback on background.
|
||||
//!
|
||||
//! So locking the screen kept the audio playing **whether or not the toggle was
|
||||
//! on**. The toggle governed a handoff that no longer had anything to hand off
|
||||
//! *from*: there was no gap in playback to bridge. A user who had never touched
|
||||
//! it got background audio anyway, which is the bug as reported.
|
||||
//!
|
||||
//! # Why the decision lives in Rust
|
||||
//!
|
||||
//! It depends on what the item *is* (a video keeps its picture; music has none
|
||||
//! to lose) and on a user setting — domain questions, not presentation ones, and
|
||||
//! the answer must be identical for both renderers. The frontend and the Android
|
||||
//! activity carry it out; neither decides it. Putting the rule in either would
|
||||
//! have reproduced exactly the split that caused this: two renderers, two
|
||||
//! behaviours, one toggle that only reached one of them.
|
||||
|
||||
use crate::player::media::MediaType;
|
||||
|
||||
/// What the player should do when the app is backgrounded.
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq, serde::Serialize, serde::Deserialize, specta::Type)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub enum BackgroundAction {
|
||||
/// Carry on. Music, and video the user explicitly asked to keep hearing
|
||||
/// while it is in a picture-in-picture window.
|
||||
KeepPlaying,
|
||||
/// Swap the video stream for an audio-only one and keep playing.
|
||||
HandOffToAudio,
|
||||
/// Stop making sound. The user did not ask for background playback.
|
||||
Pause,
|
||||
}
|
||||
|
||||
/// Decide what backgrounding should do.
|
||||
///
|
||||
/// * `is_video` — whether the current item has a picture to lose. Music is
|
||||
/// never paused by backgrounding; that is what a music player is for.
|
||||
/// * `background_audio_armed` — the per-player toggle (UR-040).
|
||||
/// * `in_picture_in_picture` — the app is not "gone", it is in a floating
|
||||
/// window and still visible. Pausing here would break PiP (UR-041).
|
||||
///
|
||||
/// TRACES: UR-040, UR-041 | DR-224 | UT-211
|
||||
pub fn background_action(
|
||||
is_video: bool,
|
||||
background_audio_armed: bool,
|
||||
in_picture_in_picture: bool,
|
||||
) -> BackgroundAction {
|
||||
// PiP first: the window is still on screen, so this is not backgrounding in
|
||||
// any sense the user would recognise.
|
||||
if in_picture_in_picture {
|
||||
return BackgroundAction::KeepPlaying;
|
||||
}
|
||||
|
||||
// Music has no picture to lose; a music player that stopped when the screen
|
||||
// locked would be broken in an obvious way.
|
||||
if !is_video {
|
||||
return BackgroundAction::KeepPlaying;
|
||||
}
|
||||
|
||||
if background_audio_armed {
|
||||
BackgroundAction::HandOffToAudio
|
||||
} else {
|
||||
BackgroundAction::Pause
|
||||
}
|
||||
}
|
||||
|
||||
/// Whether a media type has a picture that backgrounding would throw away.
|
||||
///
|
||||
/// TRACES: UR-040 | DR-224
|
||||
pub fn is_video_media(media_type: MediaType) -> bool {
|
||||
matches!(media_type, MediaType::Video)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn video_without_the_toggle_pauses() {
|
||||
// THE REPORTED BUG. Native video runs in a foreground media service that
|
||||
// keeps playing when the app is hidden, and nothing paused it -- so
|
||||
// locking the screen gave background audio to a user who never asked
|
||||
// for it.
|
||||
assert_eq!(
|
||||
background_action(true, false, false),
|
||||
BackgroundAction::Pause
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn video_with_the_toggle_hands_off_to_audio() {
|
||||
assert_eq!(
|
||||
background_action(true, true, false),
|
||||
BackgroundAction::HandOffToAudio
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn music_always_keeps_playing() {
|
||||
// Backgrounding a music player and having it stop would be absurd. The
|
||||
// toggle is irrelevant here: there is no picture to give up.
|
||||
assert_eq!(
|
||||
background_action(false, false, false),
|
||||
BackgroundAction::KeepPlaying
|
||||
);
|
||||
assert_eq!(
|
||||
background_action(false, true, false),
|
||||
BackgroundAction::KeepPlaying
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn picture_in_picture_is_not_backgrounding() {
|
||||
// The video is in a floating window and still on screen. Pausing would
|
||||
// break PiP (UR-041), which is a separate feature reached through
|
||||
// onUserLeaveHint rather than onStop.
|
||||
assert_eq!(
|
||||
background_action(true, false, true),
|
||||
BackgroundAction::KeepPlaying
|
||||
);
|
||||
assert_eq!(
|
||||
background_action(true, true, true),
|
||||
BackgroundAction::KeepPlaying
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_rule_does_not_depend_on_the_renderer() {
|
||||
// There is deliberately no renderer parameter. The WebView path and the
|
||||
// native path must answer identically -- the split between them is what
|
||||
// produced the defect, because the toggle only ever reached one.
|
||||
for armed in [true, false] {
|
||||
let once = background_action(true, armed, false);
|
||||
let again = background_action(true, armed, false);
|
||||
assert_eq!(once, again);
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn only_video_counts_as_having_a_picture() {
|
||||
assert!(is_video_media(MediaType::Video));
|
||||
assert!(!is_video_media(MediaType::Audio));
|
||||
}
|
||||
}
|
||||
@@ -4,6 +4,7 @@
|
||||
// DR-001, DR-004, DR-005, DR-009, DR-028, DR-029, DR-047
|
||||
pub mod autoplay;
|
||||
pub mod backend;
|
||||
pub mod background_policy;
|
||||
pub mod events;
|
||||
pub mod media;
|
||||
pub mod queue;
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"$schema": "https://schema.tauri.app/config/2",
|
||||
"productName": "JellyTau",
|
||||
"version": "0.9.1",
|
||||
"version": "0.10.1",
|
||||
"identifier": "com.dtourolle.jellytau",
|
||||
"build": {
|
||||
"beforeDevCommand": "bun run dev",
|
||||
@@ -44,6 +44,7 @@
|
||||
},
|
||||
"bundle": {
|
||||
"active": true,
|
||||
"createUpdaterArtifacts": true,
|
||||
"targets": [
|
||||
"deb",
|
||||
"rpm",
|
||||
|
||||
+42
-7
@@ -19,6 +19,31 @@ export const commands = {
|
||||
async playerPlayItem(item: PlayItemRequest) : Promise<PlayerStatus> {
|
||||
return await TAURI_INVOKE("player_play_item", { item });
|
||||
},
|
||||
/**
|
||||
* Exit background-audio mode: stop the native audio player and return its final
|
||||
* position so the frontend can reload the WebView `<video>` there (UR-040).
|
||||
*
|
||||
* Returns the position in seconds. The sleep timer is intentionally left
|
||||
* untouched — if it fired while backgrounded, playback is already stopped and
|
||||
* this simply reports the last position.
|
||||
*
|
||||
* What playback should do now that the app is no longer visible.
|
||||
*
|
||||
* The caller supplies only what it alone knows -- whether the per-player
|
||||
* toggle is armed, and whether Android put the window into picture-in-picture.
|
||||
* Everything else (what is playing, and therefore whether there is a picture to
|
||||
* lose) is read here, because it is domain state.
|
||||
*
|
||||
* The rule itself is in `player::background_policy`; this command is the wire.
|
||||
* Returning `KeepPlaying` for an empty queue is deliberate: with nothing
|
||||
* playing there is nothing to pause, and an error would make the frontend
|
||||
* handle a case that is not a failure.
|
||||
*
|
||||
* TRACES: UR-040, UR-041 | DR-224 | UT-211
|
||||
*/
|
||||
async playerBackgroundAction(backgroundAudioArmed: boolean, inPictureInPicture: boolean) : Promise<BackgroundAction> {
|
||||
return await TAURI_INVOKE("player_background_action", { backgroundAudioArmed, inPictureInPicture });
|
||||
},
|
||||
/**
|
||||
* Enter background-audio mode: hand playback of the currently-watched video off
|
||||
* to the native ExoPlayer *audio* path so the audio keeps playing while the app
|
||||
@@ -41,13 +66,6 @@ async playerEnterBackgroundAudio(item: PlayItemRequest, positionSeconds: number)
|
||||
return await TAURI_INVOKE("player_enter_background_audio", { item, positionSeconds });
|
||||
},
|
||||
/**
|
||||
* Exit background-audio mode: stop the native audio player and return its final
|
||||
* position so the frontend can reload the WebView `<video>` there (UR-040).
|
||||
*
|
||||
* Returns the position in seconds. The sleep timer is intentionally left
|
||||
* untouched — if it fired while backgrounded, playback is already stopped and
|
||||
* this simply reports the last position.
|
||||
*
|
||||
* TRACES: UR-040 | DR-052 | UT-061, IT-013
|
||||
*/
|
||||
async playerExitBackgroundAudio() : Promise<number> {
|
||||
@@ -1976,6 +1994,23 @@ countdownSeconds: number;
|
||||
* Maximum number of episodes to auto-play consecutively (0 = unlimited)
|
||||
*/
|
||||
maxEpisodes?: number }
|
||||
/**
|
||||
* What the player should do when the app is backgrounded.
|
||||
*/
|
||||
export type BackgroundAction =
|
||||
/**
|
||||
* Carry on. Music, and video the user explicitly asked to keep hearing
|
||||
* while it is in a picture-in-picture window.
|
||||
*/
|
||||
"keepPlaying" |
|
||||
/**
|
||||
* Swap the video stream for an audio-only one and keep playing.
|
||||
*/
|
||||
"handOffToAudio" |
|
||||
/**
|
||||
* Stop making sound. The user did not ask for background playback.
|
||||
*/
|
||||
"pause"
|
||||
/**
|
||||
* Smart caching configuration
|
||||
*/
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
import { get } from "svelte/store";
|
||||
import { goto } from "$app/navigation";
|
||||
import { commands } from "$lib/api/bindings";
|
||||
import type { JRayActor, StreamingQuality } from "$lib/api/bindings";
|
||||
import type { JRayActor, StreamingQuality, BackgroundAction } from "$lib/api/bindings";
|
||||
import { listen } from "@tauri-apps/api/event";
|
||||
import Hls from "hls.js";
|
||||
import type { MediaItem } from "$lib/api/types";
|
||||
@@ -63,6 +63,7 @@
|
||||
import {
|
||||
setBackgroundAudioEnabled,
|
||||
subscribeAppBackgrounded,
|
||||
type BackgroundSignal,
|
||||
subscribeAppForegrounded,
|
||||
} from "$lib/utils/backgroundAudio";
|
||||
import { platform } from "@tauri-apps/plugin-os";
|
||||
@@ -825,7 +826,7 @@
|
||||
// flip the component into HTML5 mode). Unsubscribers go into nativeUnlisteners
|
||||
// so onDestroy tears them down.
|
||||
if (backgroundAudioSupported) {
|
||||
nativeUnlisteners.push(subscribeAppBackgrounded(enterBackgroundAudioHandoff));
|
||||
nativeUnlisteners.push(subscribeAppBackgrounded(onAppBackgrounded));
|
||||
nativeUnlisteners.push(subscribeAppForegrounded(exitBackgroundAudioHandoff));
|
||||
}
|
||||
|
||||
@@ -1722,6 +1723,9 @@
|
||||
const backgroundAudioSupported = platform() === "android";
|
||||
let backgroundAudioOn = $state(false); // v1: default OFF each session
|
||||
let handoffState: BackgroundAudioState = { ...initialHandoffState };
|
||||
// Set when backgrounding paused playback, so foregrounding resumes only
|
||||
// what we stopped -- never something the user paused themselves.
|
||||
let pausedByBackgrounding = false;
|
||||
|
||||
function toggleBackgroundAudio() {
|
||||
backgroundAudioOn = !backgroundAudioOn;
|
||||
@@ -1737,6 +1741,43 @@
|
||||
|
||||
// App went to background/locked while background-audio is armed: hand off to
|
||||
// native audio and stop the WebView video decode.
|
||||
async function onAppBackgrounded(signal: BackgroundSignal) {
|
||||
// What to do is a domain decision, not a presentation one: it depends on
|
||||
// whether the item has a picture to lose, which is Rust's to know. This used
|
||||
// to be decided implicitly by Kotlin gating the event on the toggle, which
|
||||
// is why the native path -- whose media service keeps playing regardless --
|
||||
// ignored the toggle entirely (DR-224).
|
||||
let action: BackgroundAction;
|
||||
try {
|
||||
action = await commands.playerBackgroundAction(
|
||||
signal.backgroundAudioArmed,
|
||||
signal.inPictureInPicture,
|
||||
);
|
||||
} catch (e) {
|
||||
// Never leave playback in an undefined state because a decision call
|
||||
// failed. Continuing is the old behaviour and the safer default: it
|
||||
// cannot silently stop something the user is listening to.
|
||||
log.warn("Background action lookup failed; leaving playback alone:", e);
|
||||
return;
|
||||
}
|
||||
|
||||
log.debug("Background action:", action);
|
||||
switch (action) {
|
||||
case "keepPlaying":
|
||||
return;
|
||||
case "pause":
|
||||
// The user did not ask for background playback. Remember that WE paused
|
||||
// it, so returning to the foreground can resume rather than leaving a
|
||||
// video mysteriously stopped.
|
||||
pausedByBackgrounding = isPlaying;
|
||||
if (isPlaying) await playerController.pause();
|
||||
return;
|
||||
case "handOffToAudio":
|
||||
await enterBackgroundAudioHandoff();
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
async function enterBackgroundAudioHandoff() {
|
||||
if (!shouldEnterBackgroundAudio(backgroundAudioOn, handoffState)) return;
|
||||
// `currentTime` is the component's authoritative ABSOLUTE position (the RAF
|
||||
@@ -1797,6 +1838,20 @@
|
||||
// App returned to foreground: stop native audio, reload the WebView <video> at
|
||||
// the position native reached, and restore play/pause.
|
||||
async function exitBackgroundAudioHandoff() {
|
||||
// Resume what backgrounding paused, before the handoff check: the pause path
|
||||
// and the handoff path are mutually exclusive, and this one leaves no
|
||||
// handoff state to unwind. Only resumes if WE paused it -- a user who
|
||||
// paused before locking the screen stays paused.
|
||||
if (pausedByBackgrounding) {
|
||||
pausedByBackgrounding = false;
|
||||
try {
|
||||
await playerController.play();
|
||||
} catch (e) {
|
||||
log.warn("Failed to resume after backgrounding:", e);
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
if (!shouldExitBackgroundAudio(handoffState)) return;
|
||||
// Read the native player's state BEFORE exiting — the exit stops it. If the
|
||||
// user hit pause on the lockscreen while backgrounded, that pause must
|
||||
|
||||
@@ -66,10 +66,31 @@ export function setBackgroundAudioEnabled(enabled: boolean): boolean {
|
||||
* Returns an unsubscribe function. No-op where unsupported (the event never
|
||||
* fires on non-Android platforms).
|
||||
*/
|
||||
export function subscribeAppBackgrounded(handler: () => void): () => void {
|
||||
export interface BackgroundSignal {
|
||||
/** Whether the per-player background-audio toggle was armed (UR-040). */
|
||||
backgroundAudioArmed: boolean;
|
||||
/** Whether Android put the window into picture-in-picture (UR-041). */
|
||||
inPictureInPicture: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* Older builds dispatched this event with no detail, and only when the toggle
|
||||
* was already armed. Treat a missing detail as "armed, not PiP" so a mismatched
|
||||
* pair degrades to the previous behaviour rather than pausing unexpectedly.
|
||||
*/
|
||||
function readSignal(event: Event): BackgroundSignal {
|
||||
const detail = (event as CustomEvent).detail as Partial<BackgroundSignal> | null | undefined;
|
||||
return {
|
||||
backgroundAudioArmed: detail?.backgroundAudioArmed ?? true,
|
||||
inPictureInPicture: detail?.inPictureInPicture ?? false,
|
||||
};
|
||||
}
|
||||
|
||||
export function subscribeAppBackgrounded(handler: (signal: BackgroundSignal) => void): () => void {
|
||||
if (typeof window === "undefined") return () => {};
|
||||
window.addEventListener("jellytau-background", handler);
|
||||
return () => window.removeEventListener("jellytau-background", handler);
|
||||
const listener = (event: Event) => handler(readSignal(event));
|
||||
window.addEventListener("jellytau-background", listener);
|
||||
return () => window.removeEventListener("jellytau-background", listener);
|
||||
}
|
||||
|
||||
/** Subscribe to the native "app foregrounded" signal. Returns an unsubscribe fn. */
|
||||
|
||||
Reference in New Issue
Block a user