Compare commits
56
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7529266f5b | ||
|
|
7d5dcd454e | ||
|
|
3fa5d9fc3a | ||
|
|
fa75bd08d7 | ||
|
|
de41169ccb | ||
|
|
b1e55adc14 | ||
|
|
5dc6aa9c2f | ||
|
|
ec1e59921b | ||
|
|
7ec8a82871 | ||
|
|
b61474744b | ||
|
|
1aba1a41e6 | ||
|
|
0d0b04bff0 | ||
|
|
f3b124f9b2 | ||
|
|
09e78962b2 | ||
|
|
466912e202 | ||
|
|
c96231106f | ||
|
|
557887bb07 | ||
|
|
ae7e05c579 | ||
|
|
9f588b6d61 | ||
|
|
10d50dccbd | ||
|
|
6028d78844 | ||
|
|
1d4ef1a23f | ||
|
|
165c87047e | ||
|
|
05bc85f2b8 | ||
|
|
d1fe3758d5 | ||
|
|
664b129947 | ||
|
|
c9fa18ecb7 | ||
|
|
3077ed75fe | ||
|
|
97e84a79eb | ||
|
|
a29ceaaeab | ||
|
|
54b2720d76 | ||
|
|
fe142e3451 | ||
|
|
3bdfa94f39 | ||
|
|
22ea27efff | ||
|
|
09bd71629a | ||
|
|
c83670d216 | ||
|
|
1e9aed214b | ||
|
|
3638d1d822 | ||
|
|
18618bd135 | ||
|
|
d2985f3841 | ||
|
|
f70df9f827 | ||
|
|
439c8625d5 | ||
|
|
1d67c160b2 | ||
|
|
237380b122 | ||
|
|
4f077736b6 | ||
|
|
727f68950e | ||
|
|
aa9f534f3c | ||
|
|
011b4d9a9c | ||
|
|
d5aa081157 | ||
|
|
a99f855e98 | ||
|
|
7e4727fc49 | ||
|
|
1b7fa635d8 | ||
|
|
57d2299180 | ||
|
|
fa7ea41ccf | ||
|
|
324059b2bd | ||
|
|
1138d75a45 |
+2
-6
@@ -9,12 +9,8 @@ web/build
|
||||
# The Android client — built by its own job, never from this context. The APK
|
||||
# reaches the image through client/, downloaded as a CI artifact, so nothing
|
||||
# here reads android/ sources.
|
||||
#
|
||||
# This block named `flutter_client/` until 2026-09-10 and lost its PATTERN when
|
||||
# that tree was deleted, leaving a comment describing an exclusion that was no
|
||||
# longer happening. android/ never took its place, so 4.1 MB of Gradle project
|
||||
# has been entering the context and busting the `COPY . .` layer on every
|
||||
# Android-only change.
|
||||
# Excluded so the Gradle project neither bloats the context nor busts the
|
||||
# `COPY . .` layer on every Android-only change.
|
||||
android/
|
||||
|
||||
# Local `make build` output — an 18 MB binary the image never uses, since the
|
||||
|
||||
+117
-154
@@ -7,45 +7,39 @@ name: release
|
||||
# push tag vYYYY.MM.DD.HHMM → :latest (fresh APK bundled)
|
||||
# workflow_dispatch → manual trigger (same rules based on the ref)
|
||||
#
|
||||
# That is the whole tag map, and it is family rule 145 + 147 as written.
|
||||
# That is the whole tag map.
|
||||
#
|
||||
# :<sha> on main is the ROLLBACK UNIT — every production commit addressable
|
||||
# without a release ceremony. It is minted only on main, where rollback is
|
||||
# actually worth having: merges are gated (rule 2) so they number in the dozens
|
||||
# per year, while on dev they would be one per push, forever, for a channel
|
||||
# whose entire contract is that it moves.
|
||||
# actually worth having: merges to main are deliberate, so they number in the
|
||||
# dozens per year, while on dev they would be one per push, forever, for a
|
||||
# channel whose entire contract is that it moves.
|
||||
#
|
||||
# There are NO :<version> image tags. This repo published :vYYYY.MM.DD.HHMM
|
||||
# until 2026-09-10 and it was the inverse of the rule on both counts — minting
|
||||
# a version tag nobody pinned while the rollback unit the rule names did not
|
||||
# exist here at all. Git and the build's own self-reported version answer
|
||||
# "which build is this"; a third name for the same thing is upkeep for a model
|
||||
# we do not run. Operator, 2026-09-10: "only things like the APK need that kind
|
||||
# of versioning for their update process."
|
||||
# There are NO :<version> image tags. Git and the build's own self-reported
|
||||
# version answer "which build is this"; a third name for the same thing is
|
||||
# upkeep for a model we do not run. Only the APK needs version numbers, for
|
||||
# its update process.
|
||||
#
|
||||
# There is no :main either. :latest tracks main's tip with no gate between them
|
||||
# (rule 147), so a second name for the same image sends readers looking for a
|
||||
# There is no :main either. :latest tracks main's tip with no gate between
|
||||
# them, so a second name for the same image sends readers looking for a
|
||||
# distinction that does not exist.
|
||||
#
|
||||
# The dev channel exists so testing a build does not require shipping one.
|
||||
# Before it, the only way to get an APK onto a phone was to cut a release,
|
||||
# which made `main` the staging area by default. `:dev` carries its own
|
||||
# freshly-built APK, signed with the SAME key as release builds — a different
|
||||
# key cannot install over the stable app, so anyone crossing channels would
|
||||
# have to uninstall and lose their data.
|
||||
# The dev channel exists so testing a build does not require shipping one:
|
||||
# without it the only way to get an APK onto a phone is to cut a release,
|
||||
# which makes `main` the staging area. `:dev` carries its own freshly-built
|
||||
# APK, signed with the SAME key as release builds — a different key cannot
|
||||
# install over the stable app, so anyone crossing channels would have to
|
||||
# uninstall and lose their data.
|
||||
#
|
||||
# :dev is published ALONE, with no per-commit tag. A rolling channel is
|
||||
# rolling by definition; a commit-addressable image for it would be a
|
||||
# rollback target nobody ever pulls, kept forever. Recovery on dev is to fix
|
||||
# forward.
|
||||
#
|
||||
# Note what this repo does NOT need: a cross-repo dispatch to refresh the
|
||||
# channel when its bundled APK is rebuilt. That mechanism exists elsewhere in
|
||||
# the family because the app and the server live in separate repos. Minstrel
|
||||
# is a monorepo — one push builds the APK and the image in the same run from
|
||||
# the same commit, so the channel cannot go stale against its own artifact.
|
||||
# The requirement is satisfied structurally; copying the mechanism would add
|
||||
# a moving part to fix a problem that does not exist here.
|
||||
# No cross-repo dispatch is needed to refresh a channel when its bundled APK
|
||||
# is rebuilt: Minstrel is a monorepo, so one push builds the APK and the
|
||||
# image in the same run from the same commit, and the channel cannot go
|
||||
# stale against its own artifact.
|
||||
#
|
||||
# Release model: the tag IS the artifact's version name with a `v` in front.
|
||||
# `v2026.09.10.1432` and `2026.09.10.1432` are the same string, derived from
|
||||
@@ -55,15 +49,9 @@ name: release
|
||||
#
|
||||
# TAGS ARE IMMUTABLE. Never move, retarget or delete a published tag. A
|
||||
# same-day second release is not a collision — HHMM makes every tag unique
|
||||
# by construction, so the answer is simply another tag.
|
||||
#
|
||||
# This block used to say the opposite: that the per-day tag was
|
||||
# "intentionally mutable" and that a same-day re-cut should
|
||||
# `git push -f origin vYYYY.MM.DD`. That instruction is what the family
|
||||
# rulebook now forbids outright, and it has incidents behind it — moving a
|
||||
# same-day tag forward once took a published release down with it. Anyone
|
||||
# installing from a tag is holding something the tag no longer points at,
|
||||
# which is a worse failure than an extra row in the tag list.
|
||||
# by construction, so the answer is simply another tag. Anyone installing
|
||||
# from a moved tag would hold something the tag no longer points at, which
|
||||
# is a worse failure than an extra row in the tag list.
|
||||
#
|
||||
# :latest is updated by every main push AND every tag push, so it always
|
||||
# reflects the newest blessed image.
|
||||
@@ -83,15 +71,14 @@ name: release
|
||||
# recomputed ones — so no rebuild is needed, just a rebundle. Tag builds
|
||||
# keep bundling their own freshly-built APK.
|
||||
#
|
||||
# THE GATE (rule 177, M462 #4984). Every verifying lane lives in this file —
|
||||
# THE GATE. Every verifying lane lives in this file —
|
||||
# Go (vet, lint, short tests), the Postgres integration suite, the web app
|
||||
# (npm audit, svelte-check, vitest), Android (ktlint, detekt, unit tests) and
|
||||
# govulncheck — and every job that publishes something names each of them in
|
||||
# `needs:` and requires `success` from each, by name. Nothing publishes on red.
|
||||
#
|
||||
# They used to be three separate workflows (test-go, test-web, android) on the
|
||||
# same push trigger as this one. Separate workflows cannot see each other's
|
||||
# verdict, so :dev meant "it built", never "it passed": a red test run and a
|
||||
# One workflow, because separate workflows cannot see each other's verdict:
|
||||
# :dev would mean "it built", never "it passed", and a red test run and a
|
||||
# fresh :dev could carry the same timestamp. One graph is the only place the
|
||||
# edge can be written.
|
||||
#
|
||||
@@ -125,10 +112,9 @@ on:
|
||||
type: boolean
|
||||
default: false
|
||||
|
||||
# A rapid re-push to main should supersede the in-flight build — the
|
||||
# operator explicitly wants the later commit to win. Tags no longer enter
|
||||
# into this: they are immutable and unique, so no tag build can ever be
|
||||
# superseded by another run on the same ref.
|
||||
# A rapid re-push to main supersedes the in-flight build: the later commit
|
||||
# wins. Tags are immutable and unique, so no tag build can be superseded by
|
||||
# another run on the same ref.
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
@@ -173,14 +159,14 @@ jobs:
|
||||
# Full `go test -race` against an ephemeral Postgres.
|
||||
#
|
||||
# DB wiring follows the act_runner shared-daemon pattern: the runner's Docker
|
||||
# daemon also runs the operator's dev compose stack, so service containers
|
||||
# get NO published ports (collision) and no service-name DNS. We discover the
|
||||
# daemon also runs a dev compose stack, so service containers get NO
|
||||
# published ports (collision) and no service-name DNS. We discover the
|
||||
# service container through the mounted docker socket and reach it by bridge
|
||||
# IP. The exactly-one assertion is a hard guard — pointing tests at the dev
|
||||
# Postgres would truncate it (the disaster Fable #339 exists to prevent).
|
||||
# Postgres would truncate it.
|
||||
#
|
||||
# The key stays `integration` with no `name:` (rule 80): act_runner derives
|
||||
# the service container's name from the job's display name.
|
||||
# The key stays `integration` with no `name:`: act_runner derives the
|
||||
# service container's name from the job's display name.
|
||||
#
|
||||
# `web/build/` has a committed placeholder index.html so go:embed succeeds
|
||||
# without the SPA being built first.
|
||||
@@ -195,7 +181,7 @@ jobs:
|
||||
POSTGRES_USER: minstrel
|
||||
POSTGRES_PASSWORD: minstrel
|
||||
POSTGRES_DB: minstrel_test
|
||||
# No `ports:` — the runner shares the operator's dev compose
|
||||
# No `ports:` — the runner shares the dev compose
|
||||
# Docker daemon; publishing a fixed host port collides.
|
||||
|
||||
steps:
|
||||
@@ -209,13 +195,13 @@ jobs:
|
||||
# mounted docker socket. act_runner attaches the job
|
||||
# container and its service container(s) to a shared per-job
|
||||
# network, so scope discovery to a postgres that sits on a
|
||||
# network THIS job container is also on. The old
|
||||
# `--filter name=integration` matched EVERY concurrent
|
||||
# integration run's postgres (a dev push + the main-merge run
|
||||
# overlap → 2 candidates → false "expected exactly 1" abort).
|
||||
# The operator's dev compose `minstrel-postgres-*` is never on
|
||||
# this job's network; skip it explicitly as belt-and-suspenders
|
||||
# (a wrong target would truncate real data).
|
||||
# network THIS job container is also on. A name filter alone
|
||||
# would match EVERY concurrent integration run's postgres (a dev
|
||||
# push and a main-merge run overlapping give 2 candidates and a
|
||||
# false "expected exactly 1" abort). The dev compose
|
||||
# `minstrel-postgres-*` is never on this job's network; skip it
|
||||
# explicitly as belt-and-suspenders (a wrong target would
|
||||
# truncate real data).
|
||||
SELF=$(cat /etc/hostname)
|
||||
SELF_NETS=$(docker inspect -f '{{range $k,$v := .NetworkSettings.Networks}}{{$k}} {{end}}' "$SELF")
|
||||
test -n "$SELF_NETS"
|
||||
@@ -236,11 +222,11 @@ jobs:
|
||||
export MINSTREL_TEST_DATABASE_URL="postgres://minstrel:minstrel@${PG_IP}:5432/minstrel_test?sslmode=disable"
|
||||
|
||||
# Wait for Postgres to accept connections. Asked of the service
|
||||
# container itself: the run: shell is dash (rule 81), where the
|
||||
# old `/dev/tcp` probe never connects and the loop silently
|
||||
# burned its full two minutes on every run.
|
||||
# container itself: the run: shell is dash, where a `/dev/tcp`
|
||||
# probe never connects and the loop would silently burn its full
|
||||
# two minutes.
|
||||
#
|
||||
# Over TCP (-h 127.0.0.1), not the unix socket (#5426). On first
|
||||
# Over TCP (-h 127.0.0.1), not the unix socket. On first
|
||||
# boot the image's entrypoint runs initdb under a temporary server
|
||||
# that listens on the socket only, then stops it and starts the
|
||||
# real one. A socket probe can catch the temporary server, and the
|
||||
@@ -267,7 +253,7 @@ jobs:
|
||||
# synchronous_commit is user-context, so pg_reload_conf() picks
|
||||
# all three up with no restart.
|
||||
# Non-fatal: a failure degrades to "slower", never red CI. But
|
||||
# slower is ~15x on internal/api (#5426), so retry a few times and
|
||||
# slower is ~15x on internal/api, so retry a few times and
|
||||
# print what took effect.
|
||||
relaxed=""
|
||||
for i in 1 2 3 4 5; do
|
||||
@@ -291,10 +277,10 @@ jobs:
|
||||
# every integration package TRUNCATEs the one shared test DB;
|
||||
# concurrent package binaries → TRUNCATE deadlocks. Serialize
|
||||
# package execution (the documented local invocation too).
|
||||
# -timeout 20m: internal/api alone takes ~6.5 min under -race on
|
||||
# an idle runner, and a dev and a main run sharing the runner
|
||||
# pushed it past go test's default 10m (run 8368, 600.016s, the
|
||||
# running test 2s old — nothing hung).
|
||||
# -timeout 20m: internal/api alone takes several minutes under
|
||||
# -race on an idle runner, and a dev and a main run sharing the
|
||||
# runner can push it past go test's default 10m with nothing
|
||||
# hung.
|
||||
MINSTREL_DATABASE_URL="$MINSTREL_TEST_DATABASE_URL" go run ./cmd/minstrel migrate
|
||||
go test -p 1 -race -timeout 20m ./...
|
||||
|
||||
@@ -314,11 +300,8 @@ jobs:
|
||||
- name: Install deps
|
||||
run: npm ci
|
||||
|
||||
# The whole tree, build and test tooling included. Until #5021 this
|
||||
# audited only what ships to browsers (`--omit=dev`), because vite,
|
||||
# vitest, tailwind and kit carried advisories that needed major
|
||||
# upgrades. Those upgrades landed and the full tree audits clean, so
|
||||
# the tooling that builds the shipped bundle is held to the same bar.
|
||||
# The whole tree, build and test tooling included: the tooling that
|
||||
# builds the shipped bundle is held to the same bar as the bundle.
|
||||
- name: npm audit (all dependencies)
|
||||
run: npm audit --audit-level=moderate
|
||||
|
||||
@@ -329,8 +312,8 @@ jobs:
|
||||
run: npm test
|
||||
|
||||
android:
|
||||
# Using flutter-ci runner label because it's the only proven-working
|
||||
# label with docker that can pull our container.image.
|
||||
# The flutter-ci runner label is the only proven-working label with
|
||||
# docker that can pull our container.image.
|
||||
runs-on: flutter-ci
|
||||
container:
|
||||
image: git.fabledsword.com/bvandeusen/ci-android:36
|
||||
@@ -376,11 +359,10 @@ jobs:
|
||||
- name: Unit tests
|
||||
run: ./gradlew testDebugUnitTest
|
||||
|
||||
# No debug APK is built or uploaded here. Main used to upload a
|
||||
# debug-signed app-debug.apk: a build signed by a key regenerated in
|
||||
# every container, which no install can update (family idea #5103,
|
||||
# practice 2). Phones get builds from android-release, signed with
|
||||
# the one release key, on dev and on tags.
|
||||
# No debug APK is built or uploaded here: a debug build is signed by a
|
||||
# key regenerated in every container, which no install can update.
|
||||
# Phones get builds from android-release, signed with the one release
|
||||
# key, on dev and on tags.
|
||||
|
||||
# Known vulnerabilities in the Go code and the standard library it is built
|
||||
# with. Runs in the SAME image the Dockerfile's builder stage uses, so the
|
||||
@@ -388,7 +370,7 @@ jobs:
|
||||
# the ci-go image carries its own Go and would be checking a different
|
||||
# toolchain. Keep this image and the Dockerfile's builder in step.
|
||||
#
|
||||
# govulncheck is fetched at CI time, unpinned (rule 154): the vulnerability
|
||||
# govulncheck is fetched at CI time, unpinned: the vulnerability
|
||||
# database and the tool that reads it should both be current.
|
||||
govulncheck:
|
||||
runs-on: go-ci
|
||||
@@ -397,7 +379,7 @@ jobs:
|
||||
|
||||
steps:
|
||||
# Plain git, not actions/checkout: that action runs on node, which the
|
||||
# golang image does not carry. This step is dash (rule 81).
|
||||
# golang image does not carry. This step is dash.
|
||||
- name: Checkout
|
||||
env:
|
||||
TOKEN: ${{ github.token }}
|
||||
@@ -420,7 +402,7 @@ jobs:
|
||||
android-release:
|
||||
name: Build signed APK (releases and dev)
|
||||
# Also builds on `dev`, which is what makes a test channel possible at
|
||||
# all. Without it the only way to get a build onto a phone was to cut a
|
||||
# all: without it the only way to get a build onto a phone is to cut a
|
||||
# release, which quietly turns `main` into the staging area.
|
||||
if: startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/dev'
|
||||
runs-on: flutter-ci
|
||||
@@ -453,7 +435,7 @@ jobs:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
# Full history. The version name now reads only the tip commit's
|
||||
# Full history. The version name reads only the tip commit's
|
||||
# timestamp, so a shallow clone would technically serve — but this
|
||||
# job derives a value that ships to devices, and a shallow checkout
|
||||
# changes what git-derived values resolve to WITHOUT failing. The
|
||||
@@ -470,7 +452,7 @@ jobs:
|
||||
# The derivation lives in ci/version.sh, not here, so it can be
|
||||
# executed by a test on every push. Anything inline in this file is
|
||||
# unverifiable until a release is already running.
|
||||
out="$(ci/version.sh HEAD)"
|
||||
out="$(ci/version.sh --apk HEAD)"
|
||||
printf '%s\n' "${out}" >> "$GITHUB_OUTPUT"
|
||||
|
||||
# The channel is a property of the LANE, not of the commit, which is
|
||||
@@ -487,9 +469,9 @@ jobs:
|
||||
|
||||
# Checked BEFORE the expensive work, not after it. "Attach APK to gitea
|
||||
# Release" below resolves the release by tag and fails if it is absent —
|
||||
# but that is the final step, so a tag pushed without a release built an
|
||||
# APK for several minutes first and only then discovered it had nowhere to
|
||||
# put it. Same check, seconds in instead of minutes.
|
||||
# but that is the final step, so a tag pushed without a release would
|
||||
# build an APK for several minutes first and only then find it has
|
||||
# nowhere to put it. Same check, seconds in instead of minutes.
|
||||
#
|
||||
# Releases are normally created through the API (which creates the tag and
|
||||
# the release together, so this passes). A bare `git push origin vX` is the
|
||||
@@ -549,16 +531,15 @@ jobs:
|
||||
# secret) reaches no installed phone. The certificate's digest is
|
||||
# pinned below; it is public, not a secret. Gradle signs with the
|
||||
# release key or leaves the APK unsigned, and an unsigned build fails
|
||||
# here too, as there is no app-release.apk to verify (family idea
|
||||
# #5103, practice 3). apksigner, not keytool: keytool prints nothing
|
||||
# for a v2-only APK.
|
||||
# here too, as there is no app-release.apk to verify. apksigner, not
|
||||
# keytool: keytool prints nothing for a v2-only APK.
|
||||
#
|
||||
# Rotating the key on purpose means every install must be removed and
|
||||
# reinstalled; change the digest here in the same commit.
|
||||
- name: The APK carries the release key
|
||||
shell: bash
|
||||
env:
|
||||
# CN=Minstrel, O=FabledSword. Read from run 8446 (#5116).
|
||||
# CN=Minstrel, O=FabledSword.
|
||||
RELEASE_CERT_SHA256: 43d183307bc46b821789d90444a960b137f78f2166ff431efb2406d0fceaf612
|
||||
run: |
|
||||
set -euo pipefail
|
||||
@@ -580,11 +561,10 @@ jobs:
|
||||
fi
|
||||
|
||||
- name: Upload APK as workflow artifact
|
||||
# Stock action (snippet #2271) — never @v3, which uploads something Gitea
|
||||
# will never serve back. This is the producing half of a pair:
|
||||
# image-release downloads `minstrel-apk` below. Any upload v4+ pairs with
|
||||
# any download v4+ on this forge (every combination tested 2026-09-10,
|
||||
# Scribe spike #3843), so the two pins need not move together.
|
||||
# Stock action — never @v3, which uploads something Gitea will never
|
||||
# serve back. This is the producing half of a pair: image-release
|
||||
# downloads `minstrel-apk` below. Any upload v4+ pairs with any
|
||||
# download v4+ on this forge, so the two pins need not move together.
|
||||
uses: actions/upload-artifact@v7
|
||||
with:
|
||||
name: minstrel-apk
|
||||
@@ -687,7 +667,7 @@ jobs:
|
||||
|
||||
image-release:
|
||||
name: Build + push container image
|
||||
# Every lane must have SUCCEEDED, each named here (rule 177). Then the
|
||||
# Every lane must have SUCCEEDED, each named here. Then the
|
||||
# APK: tag and dev pushes build one and it must have succeeded; main
|
||||
# pushes skip android-release and bundle the latest release's APK
|
||||
# instead, so for main alone a skipped android-release is expected.
|
||||
@@ -713,15 +693,13 @@ jobs:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
# Full history, and rule 149 names this specifically: any job that
|
||||
# DERIVES the version name needs it, because a shallow clone changes
|
||||
# what git-derived values resolve to WITHOUT failing — a too-low
|
||||
# value, silently, with every lane green.
|
||||
# Full history: any job that DERIVES the version name needs it,
|
||||
# because a shallow clone changes what git-derived values resolve to
|
||||
# WITHOUT failing — a too-low value, silently, with every lane green.
|
||||
#
|
||||
# This job was depth-1 while it took the version from GITHUB_REF. It
|
||||
# now runs ci/version.sh itself, because with :<version> image tags
|
||||
# gone the server's self-reported version is the only thing that says
|
||||
# which build an image is.
|
||||
# This job runs ci/version.sh itself: with no :<version> image tags,
|
||||
# the server's self-reported version is the only thing that says which
|
||||
# build an image is.
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Detect buildable project
|
||||
@@ -743,21 +721,16 @@ jobs:
|
||||
set -euo pipefail
|
||||
|
||||
# THE VERSION, and it is derived the same way on every ref — the
|
||||
# branch decides the CHANNEL, never the version (family rule 149).
|
||||
# branch decides the CHANNEL, never the version.
|
||||
#
|
||||
# This used to be three different things: the literal string "main"
|
||||
# on main, "dev" on dev, and the tag name on a tag. None of them
|
||||
# ordered, and the first two were the same string forever — two dev
|
||||
# images eight weeks apart were indistinguishable in the UI. That
|
||||
# mattered little while :vYYYY.MM.DD.HHMM existed to identify a
|
||||
# build; with version image tags gone, this IS how an operator tells
|
||||
# which build a container is running.
|
||||
# A per-ref string ("main", "dev", the tag name) would not order, and
|
||||
# "dev" would be the same string forever — two dev images eight weeks
|
||||
# apart indistinguishable in the UI. With no version image tags, this
|
||||
# is how an admin tells which build a container is running.
|
||||
#
|
||||
# `sed -n s///p` rather than `grep`: it exits 0 when nothing matches,
|
||||
# so the empty check below is actually reachable. A grep here would
|
||||
# kill the step at the assignment under the runner's pipefail — the
|
||||
# exact bug that took down the first main build after the version
|
||||
# rework.
|
||||
# kill the step at the assignment under the runner's pipefail.
|
||||
VERSION="$(ci/version.sh HEAD | sed -n 's/^name=//p')"
|
||||
if [ -z "${VERSION}" ]; then
|
||||
echo "::error::could not derive a build version from ci/version.sh"
|
||||
@@ -770,13 +743,13 @@ jobs:
|
||||
# The tag build exists to produce the signed APK and attach it to
|
||||
# the release; the image it rebuilds is the SAME SOURCE as the main
|
||||
# build minutes earlier, differing only in which APK is baked in.
|
||||
# Rule 145 is explicit about that case: when the same source is
|
||||
# rebuilt with different contents, publish the moving channel tag
|
||||
# and never a commit-addressable one.
|
||||
# When the same source is rebuilt with different contents,
|
||||
# publish the moving channel tag and never a commit-addressable
|
||||
# one.
|
||||
#
|
||||
# :latest must move here rather than waiting for the next main
|
||||
# push, or the channel would carry the PREVIOUS release's APK
|
||||
# indefinitely — a channel that cannot refresh itself (rule 146).
|
||||
# indefinitely — a channel that cannot refresh itself.
|
||||
CHANNEL=stable
|
||||
echo "args=-t ${IMAGE}:latest" >> "$GITHUB_OUTPUT"
|
||||
echo "::notice::Release build ${VERSION}: refreshing :latest around the new APK"
|
||||
@@ -790,10 +763,9 @@ jobs:
|
||||
echo "args=-t ${IMAGE}:dev" >> "$GITHUB_OUTPUT"
|
||||
echo "::notice::Dev-branch build ${VERSION}: :dev"
|
||||
else
|
||||
# The production line: :latest tracks main's tip (rule 147) and
|
||||
# :<sha> is the rollback unit (rule 145). Full 40-char SHA, matching
|
||||
# the family's other repos, so a rollback target is addressable
|
||||
# straight from the commit anyone is reading.
|
||||
# The production line: :latest tracks main's tip and :<sha> is
|
||||
# the rollback unit. Full 40-char SHA, so a rollback target is
|
||||
# addressable straight from the commit anyone is reading.
|
||||
CHANNEL=stable
|
||||
echo "args=-t ${IMAGE}:latest -t ${IMAGE}:${GITHUB_SHA}" >> "$GITHUB_OUTPUT"
|
||||
echo "::notice::Main-branch build ${VERSION}: :latest + :${GITHUB_SHA}"
|
||||
@@ -818,8 +790,8 @@ jobs:
|
||||
(startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/dev')
|
||||
# Consuming half of the pair: stock download-artifact, which works here for
|
||||
# the same reason as the upload (gitea/runner 3.x edits the GHES refusal
|
||||
# out of the bundle; snippet #2271). v8 runs on node24, which every
|
||||
# CI-runner image carries — the runner uses the image's own node.
|
||||
# out of the bundle). v8 runs on node24, which every CI-runner image
|
||||
# carries — the runner uses the image's own node.
|
||||
uses: actions/download-artifact@v8
|
||||
with:
|
||||
name: minstrel-apk
|
||||
@@ -887,10 +859,10 @@ jobs:
|
||||
curl -fsSL -H "Authorization: token ${CI_TOKEN}" -o client/minstrel.apk "${APK_URL}"
|
||||
|
||||
# Take the version the release RECORDED rather than recomputing it.
|
||||
# This used to re-derive the name from the tagged commit, which meant
|
||||
# the formula lived in two files that had to be kept in step, and it
|
||||
# could only ever recover the name — the ordering key is build-time
|
||||
# minutes and does not exist anywhere after that build ends.
|
||||
# Re-deriving it from the tagged commit would keep the formula in two
|
||||
# files that must stay in step, and could only ever recover the name —
|
||||
# the ordering key is build-time minutes and exists nowhere after that
|
||||
# build ends.
|
||||
SIDECAR_URL="$(printf '%s' "${REL_JSON}" | grep -oP '"browser_download_url":\s*"\K[^"]+' | grep -E '\.apk\.version$' | head -1)" || true
|
||||
if [ -n "${SIDECAR_URL}" ]; then
|
||||
curl -fsSL -H "Authorization: token ${CI_TOKEN}" -o client/minstrel.apk.version "${SIDECAR_URL}"
|
||||
@@ -924,18 +896,15 @@ jobs:
|
||||
# Verifies a tag release actually ended up complete, and names the specific
|
||||
# thing that's missing if not.
|
||||
#
|
||||
# Added 2026-08-07 after v2026.08.07 was re-cut. The android-release job never
|
||||
# started — no log was written at all — so all eight of its steps reported
|
||||
# `failure` with none executed and image-release showed `skipped`. The run was
|
||||
# red, but the *release page rendered fine*, and `main`'s own push build had
|
||||
# already moved `:latest`, so the code was deployable and nothing looked
|
||||
# obviously wrong. The release was simply missing its APK and its image,
|
||||
# which is easy to skim past.
|
||||
# A release can be incomplete while looking fine. If android-release never
|
||||
# starts (a runner failing to launch), its steps all report `failure` with
|
||||
# none executed and image-release shows `skipped`. The run is red, but the
|
||||
# release page renders and main's own push build has already moved
|
||||
# `:latest`, so a release missing its APK and its image is easy to skim
|
||||
# past.
|
||||
#
|
||||
# This job cannot prevent that (the cause was a runner failing to launch, not
|
||||
# anything in this file). What it does is turn an incomplete release into an
|
||||
# explicit, named error instead of eight mystery step failures — so the
|
||||
# consequence is legible without having to infer it.
|
||||
# This job cannot prevent that; it turns an incomplete release into an
|
||||
# explicit, named error instead of a row of mystery step failures.
|
||||
#
|
||||
# `if: always()` is the whole point: it has to report precisely when the jobs
|
||||
# above did NOT succeed.
|
||||
@@ -977,22 +946,16 @@ jobs:
|
||||
echo "::notice::APK attached: ${APK}"
|
||||
|
||||
# The other half. Checking only the APK would report success on a release
|
||||
# whose image push failed — which is precisely the second thing that was
|
||||
# missing when v2026.08.07 had to be re-cut. `always()` on this job means
|
||||
# it runs even when image-release failed, so without this the guard would
|
||||
# cheerfully verify an incomplete release.
|
||||
# whose image push failed. `always()` on this job means it runs even when
|
||||
# image-release failed, so without this the guard would cheerfully verify
|
||||
# an incomplete release.
|
||||
#
|
||||
# This asserted `:${TAG}` — the :vYYYY.MM.DD.HHMM image — until
|
||||
# 2026-09-10. Version image tags are no longer published (rule 145), so
|
||||
# that assertion would now fail every release for a tag nothing mints.
|
||||
# The rollback target it was really protecting is the :<sha> image, which
|
||||
# main's own build published for this same commit before the tag was cut.
|
||||
#
|
||||
# Checking it here earns its keep twice over: it still catches an image
|
||||
# push that silently did not happen, and it additionally proves the
|
||||
# ORDERING — a tag cut on a commit whose main build never completed has
|
||||
# no rollback target, and that is worth failing on rather than
|
||||
# discovering during an incident.
|
||||
# The image checked is the :<sha> rollback target, which main's own build
|
||||
# published for this same commit before the tag was cut (there are no
|
||||
# version image tags). It catches an image push that silently did not
|
||||
# happen, and it proves the ORDERING — a tag cut on a commit whose main
|
||||
# build never completed has no rollback target, and that is worth failing
|
||||
# on rather than discovering during an incident.
|
||||
- name: Rollback image must exist for the tagged commit
|
||||
shell: bash
|
||||
run: |
|
||||
|
||||
+6
-9
@@ -12,13 +12,11 @@
|
||||
# Test binary, built with `go test -c`
|
||||
*.test
|
||||
|
||||
# `make build` output. bin/minstrel was tracked until 2026-09-10 — an 18 MB
|
||||
# binary committed by accident, last refreshed by a commit about web test
|
||||
# mocks, and re-dirtied by every local build since.
|
||||
# `make build` output — an 18 MB binary that is never committed.
|
||||
bin/
|
||||
|
||||
# Bundled Android APK + version sidecar (#397). Populated by CI for
|
||||
# tag releases; never committed. README in client/ explains the flow.
|
||||
# Bundled Android APK + version sidecar. Populated by CI on every image
|
||||
# build; never committed. README in client/ explains the flow.
|
||||
client/minstrel.apk
|
||||
client/minstrel.apk.version
|
||||
|
||||
@@ -44,10 +42,9 @@ go.work.sum
|
||||
docs/superpowers/
|
||||
|
||||
# Per-machine Claude Code settings + remember-skill memory artifacts +
|
||||
# project-level Claude/AI instruction files. All operator-scoped; the
|
||||
# canonical project memory lives under ~/.claude/projects/ outside the
|
||||
# repo. CLAUDE.md/AGENTS.md/GEMINI.md stay on the operator's machine
|
||||
# only — they're tool-specific working notes, not project artifacts.
|
||||
# project-level Claude/AI instruction files. All per-machine;
|
||||
# CLAUDE.md/AGENTS.md/GEMINI.md are tool-specific working notes, not
|
||||
# project artifacts.
|
||||
.claude/
|
||||
.remember/
|
||||
CLAUDE.md
|
||||
|
||||
+12
-11
@@ -19,11 +19,10 @@ ENV CGO_ENABLED=0
|
||||
# (YYYY.MM.DD.HHMM) and the lane's channel; a local `docker build` falls back
|
||||
# to "dev"/"local". Both are surfaced at /healthz.
|
||||
#
|
||||
# These are two values on purpose (family rule 149): the same commit built on
|
||||
# dev and on main reports the same NAME and differs only in CHANNEL. Folding
|
||||
# the channel into the version string is what the rule forbids — the version
|
||||
# used to BE the channel word here ("main"/"dev"), which meant two dev images
|
||||
# eight weeks apart were indistinguishable.
|
||||
# These are two values on purpose: the same commit built on dev and on main
|
||||
# reports the same NAME and differs only in CHANNEL. Folding the channel
|
||||
# into the version string would make two dev images eight weeks apart
|
||||
# indistinguishable.
|
||||
ARG MINSTREL_VERSION=dev
|
||||
ARG MINSTREL_CHANNEL=local
|
||||
RUN go build -trimpath \
|
||||
@@ -36,8 +35,8 @@ FROM debian:bookworm-slim
|
||||
# ffmpeg: duration probes and the exact-tier audio hash (a SHA-256 of the
|
||||
# encoded audio packets, so no decode). libchromaprint-tools: fpcalc, the
|
||||
# acoustic fingerprint that tells the same recording at two bitrates apart
|
||||
# from two different recordings (M400). Both are baked in at build time so a
|
||||
# deployed instance never fetches either (rule 164); fpcalc is shelled out
|
||||
# from two different recordings. Both are baked in at build time so a
|
||||
# deployed instance never fetches either; fpcalc is shelled out
|
||||
# rather than bound because CGO_ENABLED=0 above rules out cgo.
|
||||
RUN apt-get update \
|
||||
&& apt-get install -y --no-install-recommends ca-certificates ffmpeg libchromaprint-tools \
|
||||
@@ -57,10 +56,12 @@ COPY config.example.yaml /etc/smartmusic/config.yaml
|
||||
RUN mkdir -p /app/data /app/client && chown -R minstrel:minstrel /app
|
||||
WORKDIR /app
|
||||
|
||||
# In-app update channel (#397). client/ in the build context holds
|
||||
# minstrel.apk + minstrel.apk.version (populated by release.yml on tag
|
||||
# pushes; .gitkeep + README otherwise). Endpoints return 404 when the
|
||||
# APK files aren't present, so non-tag images degrade gracefully.
|
||||
# In-app update channel. client/ in the build context holds
|
||||
# minstrel.apk + minstrel.apk.version, which release.yml fills on every
|
||||
# build (dev and tag pushes bundle their own APK, main bundles the latest
|
||||
# release's); a local build has only .gitkeep + README. Endpoints return
|
||||
# 404 when the APK files aren't present, so such an image degrades
|
||||
# gracefully.
|
||||
COPY --chown=minstrel:minstrel client/ /app/client/
|
||||
|
||||
USER minstrel
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
plugins {
|
||||
alias(libs.plugins.android.application)
|
||||
// kotlin-android NOT applied: AGP 9 enables built-in Kotlin by default,
|
||||
// and KSP 2.3.x supports it (PR #2674, merged Oct 2025). serialization
|
||||
// + compose-compiler are language-level Kotlin compiler plugins and
|
||||
// still need explicit application.
|
||||
// and KSP 2.3.x supports it. serialization + compose-compiler are
|
||||
// language-level Kotlin compiler plugins and still need explicit
|
||||
// application.
|
||||
alias(libs.plugins.kotlin.serialization)
|
||||
alias(libs.plugins.compose.compiler)
|
||||
alias(libs.plugins.ksp)
|
||||
@@ -31,14 +31,9 @@ android {
|
||||
//
|
||||
// versionCode is minutes since 2020-01-01 at BUILD time. It is the
|
||||
// value the platform decides installs by, so it must be monotonic by
|
||||
// construction.
|
||||
//
|
||||
// This comment used to say versionCode was a commit count and that it
|
||||
// was "monotonic forever". It was neither — a commit count runs ahead
|
||||
// on `dev`, so a dev build outranked the `main` release meant to
|
||||
// replace it and Android refused the install as a downgrade. Worth
|
||||
// knowing the claim was here, stated as a reassurance, while the bug
|
||||
// it denied was live.
|
||||
// construction. Not a commit count: that runs ahead on `dev`, so a dev
|
||||
// build would outrank the `main` release meant to replace it and
|
||||
// Android would refuse the install as a downgrade.
|
||||
val versionNameOverride =
|
||||
(project.findProperty("MINSTREL_VERSION_NAME") as String?)?.takeIf { it.isNotBlank() }
|
||||
val versionCodeOverride =
|
||||
@@ -73,9 +68,9 @@ android {
|
||||
"proguard-rules.pro",
|
||||
)
|
||||
// Signed with the release key or not at all. Falling back to the
|
||||
// debug key made a missing secret into a published APK that no
|
||||
// install could ever update (family idea #5103, practice 2). An
|
||||
// unsigned build installs nowhere, so the gap shows at once.
|
||||
// debug key would turn a missing secret into a published APK that no
|
||||
// install could ever update. An unsigned build installs nowhere, so
|
||||
// the gap shows at once.
|
||||
signingConfig =
|
||||
if (System.getenv("ANDROID_KEYSTORE_PATH").isNullOrEmpty()) {
|
||||
null
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
|
||||
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PLAYBACK" />
|
||||
<uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
|
||||
<!-- Notifications when the app is closed (M489 #5347): the delivery
|
||||
<!-- Notifications when the app is closed: the delivery
|
||||
service, and starting it again after a reboot or an update. -->
|
||||
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_SPECIAL_USE" />
|
||||
<uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" />
|
||||
@@ -84,11 +84,8 @@
|
||||
</intent-filter>
|
||||
</receiver>
|
||||
|
||||
<!-- The FileProvider that used to live here existed solely to expose the
|
||||
downloaded update APK as a content:// URI for the old ACTION_VIEW
|
||||
install intent. A PackageInstaller session takes a stream instead,
|
||||
so both the provider and res/xml/file_paths.xml are gone — nothing
|
||||
else in the app ever used that authority. -->
|
||||
<!-- No FileProvider: the self-update streams the downloaded APK into a
|
||||
PackageInstaller session, so nothing needs a content:// URI. -->
|
||||
|
||||
<!-- On-demand WorkManager initialization: MinstrelApplication
|
||||
implements Configuration.Provider and supplies the
|
||||
|
||||
@@ -106,7 +106,7 @@ class MainActivity : ComponentActivity() {
|
||||
}
|
||||
|
||||
/**
|
||||
* Android 13+ asks before an app may post notifications (M489 #5347).
|
||||
* Android 13+ asks before an app may post notifications.
|
||||
* Asked once delivery is wanted (signed in, background delivery on),
|
||||
* each launch until answered: after a second "no" the system stops
|
||||
* showing the prompt by itself, and Settings → Notifications links to
|
||||
|
||||
@@ -8,6 +8,7 @@ import coil3.SingletonImageLoader
|
||||
import coil3.network.okhttp.OkHttpNetworkFetcherFactory
|
||||
import coil3.request.crossfade
|
||||
import com.fabledsword.minstrel.cache.CacheIndexer
|
||||
import com.fabledsword.minstrel.cache.audiocache.CacheBudgetSync
|
||||
import com.fabledsword.minstrel.cache.mutations.MutationReplayer
|
||||
import com.fabledsword.minstrel.cache.sync.SyncController
|
||||
import com.fabledsword.minstrel.di.ApplicationScope
|
||||
@@ -19,10 +20,10 @@ import com.fabledsword.minstrel.metadata.FreshnessSweeper
|
||||
import com.fabledsword.minstrel.notifications.delivery.DeliveryLauncher
|
||||
import com.fabledsword.minstrel.player.AudioPrefetcher
|
||||
import com.fabledsword.minstrel.player.CoverPrefetcher
|
||||
import com.fabledsword.minstrel.player.LikedAudioPinner
|
||||
import com.fabledsword.minstrel.player.PlayEventsReporter
|
||||
import com.fabledsword.minstrel.player.PlaybackErrorReporter
|
||||
import com.fabledsword.minstrel.player.ResumeController
|
||||
import com.fabledsword.minstrel.update.data.UpdateBannerController
|
||||
import com.fabledsword.minstrel.connectivity.NetworkStatusController
|
||||
import dagger.hilt.android.HiltAndroidApp
|
||||
import kotlinx.coroutines.CoroutineScope
|
||||
@@ -79,7 +80,7 @@ class MinstrelApplication :
|
||||
/**
|
||||
* Same construct-the-singleton trick — DeliveryLauncher starts and stops
|
||||
* the background-delivery service and runs the notification catch-up on
|
||||
* every nudge and reconnect (M489 #5347). Without this @Inject no phone
|
||||
* every nudge and reconnect. Without this @Inject no phone
|
||||
* notification would ever be posted.
|
||||
*/
|
||||
@Suppress("unused") @Inject lateinit var deliveryLauncher: DeliveryLauncher
|
||||
@@ -120,6 +121,21 @@ class MinstrelApplication :
|
||||
*/
|
||||
@Suppress("unused") @Inject lateinit var cacheIndexer: CacheIndexer
|
||||
|
||||
/**
|
||||
* Same construct-the-singleton trick — CacheBudgetSync's init block
|
||||
* feeds the audio cache's evictor the liked set and the Storage caps.
|
||||
* Without this @Inject the evictor would never arm, and the cache
|
||||
* would grow without a limit.
|
||||
*/
|
||||
@Suppress("unused") @Inject lateinit var cacheBudgetSync: CacheBudgetSync
|
||||
|
||||
/**
|
||||
* Same construct-the-singleton trick — LikedAudioPinner's init block
|
||||
* downloads liked tracks into the Liked songs budget. Without this
|
||||
* @Inject, liking a track would not keep it offline.
|
||||
*/
|
||||
@Suppress("unused") @Inject lateinit var likedAudioPinner: LikedAudioPinner
|
||||
|
||||
/**
|
||||
* Same construct-the-singleton trick — AudioPrefetcher's init
|
||||
* block subscribes to PlayerController.uiState +
|
||||
@@ -138,14 +154,6 @@ class MinstrelApplication :
|
||||
*/
|
||||
@Suppress("unused") @Inject lateinit var networkStatusController: NetworkStatusController
|
||||
|
||||
/**
|
||||
* Same construct-the-singleton trick — UpdateBannerController polls
|
||||
* /api/client/version at launch + every 24h and drives the shell's
|
||||
* soft "update available" banner. Without this @Inject the poll
|
||||
* loop would never start and the banner would never surface.
|
||||
*/
|
||||
@Suppress("unused") @Inject lateinit var updateBannerController: UpdateBannerController
|
||||
|
||||
/**
|
||||
* Same construct-the-singleton trick — FreshnessSweeper's init
|
||||
* block starts a 30-min sweep loop that re-fetches cached
|
||||
@@ -171,7 +179,7 @@ class MinstrelApplication :
|
||||
*/
|
||||
@Suppress("unused") @Inject lateinit var liveEventsDispatcher: LiveEventsDispatcher
|
||||
|
||||
// Device diagnostics (M9). The reporter gates itself on the account's
|
||||
// Device diagnostics. The reporter gates itself on the account's
|
||||
// debug flag; the uploader drains its buffer on a tick / recovery.
|
||||
@Suppress("unused") @Inject lateinit var diagnosticsReporter: DiagnosticsReporter
|
||||
@Suppress("unused") @Inject lateinit var diagnosticsUploader: DiagnosticsUploader
|
||||
@@ -181,7 +189,7 @@ class MinstrelApplication :
|
||||
override fun onCreate() {
|
||||
super.onCreate()
|
||||
// Debug builds get the full DebugTree (verbose). Release builds
|
||||
// get a WARN+ tree so operator-driven diagnosis via `adb logcat`
|
||||
// get a WARN+ tree so diagnosis via `adb logcat`
|
||||
// still surfaces UPnP / cast failures, OkHttp errors, and our
|
||||
// own Timber.w / Timber.e calls — without the chatty DEBUG /
|
||||
// INFO traffic flooding the buffer in production.
|
||||
@@ -229,10 +237,9 @@ class MinstrelApplication :
|
||||
* before Coil makes its first request.
|
||||
*
|
||||
* Crossfade is set here rather than per-call so every cover surface
|
||||
* in the app fades its artwork in instead of snapping it. Art
|
||||
* landing a beat after its tile was the most visible pop-in on Home
|
||||
* (issue #2327); `ServerImage` fades its placeholder out over the
|
||||
* same window so the two read as one cross-dissolve.
|
||||
* in the app fades its artwork in instead of snapping it, and
|
||||
* `ServerImage` fades its placeholder out over the same window so the
|
||||
* two read as one cross-dissolve.
|
||||
*/
|
||||
override fun newImageLoader(context: android.content.Context): ImageLoader =
|
||||
ImageLoader.Builder(context)
|
||||
|
||||
+3
-4
@@ -11,10 +11,9 @@ import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* Read-through accessor for the admin quarantine queue. Mirrors the
|
||||
* Flutter `AdminQuarantineController`. No Room cache — same rationale
|
||||
* as AdminRequests. Three resolution actions all delete the row from
|
||||
* the queue once the server accepts them.
|
||||
* Read-through accessor for the admin quarantine queue. No Room cache —
|
||||
* same rationale as AdminRequests. Three resolution actions all delete
|
||||
* the row from the queue once the server accepts them.
|
||||
*/
|
||||
@Singleton
|
||||
class AdminQuarantineRepository @Inject constructor(
|
||||
|
||||
+1
-1
@@ -14,7 +14,7 @@ import javax.inject.Singleton
|
||||
*
|
||||
* No Room caching — admin actions are infrequent and don't benefit
|
||||
* from offline scrollback. `approve` and `reject` fire direct REST
|
||||
* (no mutation queue) because operator confirmation is point-and-shoot;
|
||||
* (no mutation queue) because admin confirmation is point-and-shoot;
|
||||
* if the request fails the UI surfaces the error and rolls back.
|
||||
*/
|
||||
@Singleton
|
||||
|
||||
+1
-1
@@ -12,7 +12,7 @@ import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* Read-through accessor for the tag-enrichment provider settings (#1521).
|
||||
* Read-through accessor for the tag-enrichment provider settings.
|
||||
* No Room caching — admin settings are infrequent point-and-shoot edits;
|
||||
* mutations fire direct REST and the ViewModel reconciles on failure.
|
||||
* Exceptions propagate to the ViewModel (which maps them via ErrorCopy).
|
||||
|
||||
+2
-2
@@ -13,8 +13,8 @@ import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* Read-through accessor for the admin users list + the four per-user
|
||||
* mutations. Mirrors Flutter's `AdminUsersController`. Same
|
||||
* no-Room-cache, no-MutationQueue pattern as the other admin slices.
|
||||
* mutations. Same no-Room-cache, no-MutationQueue pattern as the other
|
||||
* admin repositories.
|
||||
*/
|
||||
@Singleton
|
||||
class AdminUsersRepository @Inject constructor(
|
||||
|
||||
+1
-1
@@ -39,7 +39,7 @@ class AdminInvitesViewModel @Inject constructor(
|
||||
|
||||
init {
|
||||
refresh()
|
||||
// Screen-level auto-recovery (issue #1245): reload a failed list
|
||||
// Screen-level auto-recovery: reload a failed list
|
||||
// when server health returns instead of waiting for a manual pull.
|
||||
viewModelScope.launch {
|
||||
networkStatus.recoveries().collect {
|
||||
|
||||
+3
-3
@@ -40,8 +40,8 @@ class AdminQuarantineViewModel @Inject constructor(
|
||||
/**
|
||||
* One-shot messages for the screen's snackbar. A failed action has to say
|
||||
* why: the row quietly reappearing reads as a glitch, and for a Delete
|
||||
* file refused by a read-only library it hides the one thing the
|
||||
* operator can fix (#3918).
|
||||
* file refused by a read-only library it hides the one thing an
|
||||
* admin can fix.
|
||||
*/
|
||||
private val transientMessagesChannel = Channel<String>(Channel.BUFFERED)
|
||||
val transientMessages: Flow<String> = transientMessagesChannel.receiveAsFlow()
|
||||
@@ -53,7 +53,7 @@ class AdminQuarantineViewModel @Inject constructor(
|
||||
.filter { it.kind.startsWith("quarantine.") }
|
||||
.collect { refresh() }
|
||||
}
|
||||
// Screen-level auto-recovery (issue #1245): reload a failed list
|
||||
// Screen-level auto-recovery: reload a failed list
|
||||
// when server health returns instead of waiting for a manual pull.
|
||||
viewModelScope.launch {
|
||||
networkStatus.recoveries().collect {
|
||||
|
||||
+1
-1
@@ -43,7 +43,7 @@ class AdminRequestsViewModel @Inject constructor(
|
||||
.filter { it.kind in RELEVANT_EVENT_KINDS }
|
||||
.collect { refresh() }
|
||||
}
|
||||
// Screen-level auto-recovery (issue #1245): reload a failed list
|
||||
// Screen-level auto-recovery: reload a failed list
|
||||
// when server health returns instead of waiting for a manual pull.
|
||||
viewModelScope.launch {
|
||||
networkStatus.recoveries().collect {
|
||||
|
||||
+1
-1
@@ -38,7 +38,7 @@ class AdminTagSourcesViewModel @Inject constructor(
|
||||
init {
|
||||
refresh()
|
||||
// Screen-level auto-recovery: reload a failed list when server
|
||||
// health returns instead of waiting for a manual pull (issue #1245).
|
||||
// health returns instead of waiting for a manual pull.
|
||||
viewModelScope.launch {
|
||||
networkStatus.recoveries().collect {
|
||||
if (internal.value is AdminTagSourcesUiState.Error) refresh()
|
||||
|
||||
@@ -33,7 +33,7 @@ class AdminUsersViewModel @Inject constructor(
|
||||
|
||||
init {
|
||||
refresh()
|
||||
// Screen-level auto-recovery (issue #1245): reload a failed list
|
||||
// Screen-level auto-recovery: reload a failed list
|
||||
// when server health returns instead of waiting for a manual pull.
|
||||
viewModelScope.launch {
|
||||
networkStatus.recoveries().collect {
|
||||
|
||||
@@ -12,18 +12,12 @@ import javax.inject.Singleton
|
||||
* flow), and clears the store on 401 so downstream code can react
|
||||
* to logout.
|
||||
*
|
||||
* Mirrors the Flutter Dio interceptor pattern.
|
||||
*
|
||||
* Scoped to the [BaseUrlInterceptor.PLACEHOLDER_HOST] sentinel host
|
||||
* the same way BaseUrlInterceptor is. Drift #568 / #569 caught two
|
||||
* leaks here: (1) the session cookie was being attached to every
|
||||
* external request the shared OkHttpClient services — including
|
||||
* Coil image fetches to artwork.musicbrainz.org / coverartarchive.org
|
||||
* — exposing the session
|
||||
* identifier to third-party logging; (2) a 401 from any of those
|
||||
* external hosts silently wiped the user's Minstrel session.
|
||||
* Restricting both attach + clear to placeholder-host requests
|
||||
* closes both gaps.
|
||||
* the same way BaseUrlInterceptor is. The shared OkHttpClient also
|
||||
* serves Coil's image fetches to external hosts such as
|
||||
* artwork.musicbrainz.org and coverartarchive.org; unscoped, this
|
||||
* would hand the session identifier to third-party logging, and a 401
|
||||
* from any of those hosts would sign the user out of Minstrel.
|
||||
*/
|
||||
@Singleton
|
||||
class AuthCookieInterceptor @Inject constructor(
|
||||
|
||||
@@ -17,15 +17,14 @@ import javax.inject.Singleton
|
||||
*
|
||||
* This interceptor closes the gap: Retrofit can stay built with the
|
||||
* placeholder forever, and every actual Minstrel-bound request gets
|
||||
* retargeted at the live AuthStore value. Lets the user change
|
||||
* server URL in Settings without an app relaunch (Phase 11 wiring).
|
||||
* retargeted at the live AuthStore value, so the user can change the
|
||||
* server URL in Settings without an app relaunch.
|
||||
*
|
||||
* Only requests whose host is the [PLACEHOLDER_HOST] sentinel are
|
||||
* rewritten. Absolute external URLs — artwork from
|
||||
* artwork.musicbrainz.org / coverartarchive.org, for example — must
|
||||
* reach their authored host unchanged; rewriting them to the
|
||||
* Minstrel host produced 404s the user saw as missing Discover
|
||||
* suggestion covers.
|
||||
* reach their authored host unchanged: rewritten to the Minstrel host
|
||||
* they 404, and Discover suggestions show no covers.
|
||||
*
|
||||
* No-op when the stored base URL is unparseable (falls through to
|
||||
* whatever Retrofit had) — that case shows up as a transport-level
|
||||
|
||||
@@ -16,11 +16,10 @@ object MinstrelServerRequest
|
||||
|
||||
/**
|
||||
* Plain `http://` to the Minstrel server is allowed only when the connection
|
||||
* actually lands on a private address (family security baseline #5105,
|
||||
* practice 13).
|
||||
* actually lands on a private address.
|
||||
*
|
||||
* Cleartext stays permitted app-wide for LAN servers and UPnP
|
||||
* (network_security_config.xml, #2439), but a password or session cookie sent
|
||||
* (network_security_config.xml), but a password or session cookie sent
|
||||
* over plain HTTP to a public address can be read by anyone on the path.
|
||||
*
|
||||
* Checked per connection, on the address the socket really reached, not on
|
||||
|
||||
@@ -44,9 +44,9 @@ object ErrorCopy {
|
||||
}
|
||||
|
||||
/**
|
||||
* Codes whose server message carries specifics the operator needs in
|
||||
* Codes whose server message carries specifics an admin needs in
|
||||
* order to act — which directory, which uid — that fixed copy cannot say.
|
||||
* For these the message follows the copy (#3918). Kept to a named set on
|
||||
* For these the message follows the copy. Kept to a named set on
|
||||
* purpose: most server messages are internal detail. Mirrors web's
|
||||
* errors.ts.
|
||||
*/
|
||||
|
||||
@@ -57,16 +57,15 @@ object NetworkModule {
|
||||
.addInterceptor(reachability)
|
||||
// AuthCookieInterceptor MUST run before BaseUrlInterceptor.
|
||||
// Both scope on `host == PLACEHOLDER_HOST` to distinguish
|
||||
// Minstrel-server requests from external image fetches
|
||||
// (drift #568 / #569). If BaseUrlInterceptor runs first it
|
||||
// rewrites the host to the real server before auth sees the
|
||||
// request, auth's placeholder check fails, and the session
|
||||
// cookie is neither attached on outgoing requests nor
|
||||
// captured from Set-Cookie on login — fresh installs get
|
||||
// stuck at the Welcome screen. Auth first means it sees
|
||||
// Minstrel-server requests from external image fetches. If
|
||||
// BaseUrlInterceptor runs first it rewrites the host to the real
|
||||
// server before auth sees the request, auth's placeholder check
|
||||
// fails, and the session cookie is neither attached on outgoing
|
||||
// requests nor captured from Set-Cookie on login — fresh installs
|
||||
// get stuck at the Welcome screen. Auth first means it sees
|
||||
// placeholder.invalid, attaches/captures correctly, then
|
||||
// BaseUrlInterceptor retargets to the live AuthStore host
|
||||
// for transport.
|
||||
// BaseUrlInterceptor retargets to the live AuthStore host for
|
||||
// transport.
|
||||
.addInterceptor(auth)
|
||||
.addInterceptor(baseUrl)
|
||||
.addInterceptor(logging)
|
||||
|
||||
@@ -27,9 +27,8 @@ interface AdminInvitesApi {
|
||||
}
|
||||
|
||||
/**
|
||||
* Body for `POST /api/admin/invites`. The Flutter client omits the
|
||||
* field when note is empty; Kotlin/serialization just serializes
|
||||
* null which the server treats identically.
|
||||
* Body for `POST /api/admin/invites`. An empty note is sent as null,
|
||||
* which the server treats the same as an absent field.
|
||||
*/
|
||||
@Serializable
|
||||
data class CreateInviteBody(val note: String? = null)
|
||||
|
||||
+3
-3
@@ -12,9 +12,9 @@ import retrofit2.http.POST
|
||||
import retrofit2.http.Path
|
||||
|
||||
/**
|
||||
* Retrofit interface for `/api/admin/tag-sources` (#1521) — the admin
|
||||
* surface for the tag-enrichment provider settings (#1490). Mirrors the
|
||||
* web integrations "Tag enrichment sources" card. Same shape as the
|
||||
* Retrofit interface for `/api/admin/tag-sources` — the admin surface
|
||||
* for the tag-enrichment provider settings. Mirrors the web
|
||||
* integrations "Tag enrichment sources" card. Same shape as the
|
||||
* cover-sources admin surface; kept independent so a new tag source is
|
||||
* added without touching art settings.
|
||||
*/
|
||||
|
||||
@@ -30,7 +30,7 @@ interface CastApi {
|
||||
* the 21_600 default (6h) is long enough to play through any typical
|
||||
* track without re-minting mid-playback.
|
||||
*
|
||||
* [level] asks for the leveled stream (M464 #5001): the track rendered at
|
||||
* [level] asks for the leveled stream: the track rendered at
|
||||
* the user's loudness gain, which the server works out from their setting.
|
||||
* [asAlbum] says the track plays among its album in order, which picks
|
||||
* album gain in auto mode. [prerender] says the speaker will fetch it
|
||||
|
||||
@@ -7,7 +7,7 @@ import retrofit2.http.Body
|
||||
import retrofit2.http.POST
|
||||
|
||||
/**
|
||||
* Retrofit interface for device diagnostics ingest (M9). One call
|
||||
* Retrofit interface for device diagnostics ingest. One call
|
||||
* uploads a batch of buffered events. The server stores them only when
|
||||
* the account's debug_mode_enabled flag is on (it returns 204 otherwise,
|
||||
* which the uploader treats as success so it can drop the batch).
|
||||
|
||||
@@ -19,8 +19,7 @@ import retrofit2.http.Query
|
||||
* second, so the Discover screen searches when the query is submitted,
|
||||
* not on every keystroke.
|
||||
*
|
||||
* Cancel + my-requests-list endpoints live on RequestsApi (Phase 10
|
||||
* Commit B), not here.
|
||||
* Cancel + my-requests-list endpoints live on RequestsApi, not here.
|
||||
*/
|
||||
interface DiscoverApi {
|
||||
@GET("api/discover/suggestions")
|
||||
|
||||
@@ -56,16 +56,15 @@ interface LibraryApi {
|
||||
@GET("api/library/shuffle")
|
||||
suspend fun shuffleLibrary(@Query("limit") limit: Int = 100): List<TrackWire>
|
||||
|
||||
// Browse axes (#367). Both indexes are unpaged by design: the client needs
|
||||
// Browse axes. Both indexes are unpaged by design: the client needs
|
||||
// the whole set to render a browsable picker, and even a messy library
|
||||
// yields hundreds of rows, not thousands.
|
||||
//
|
||||
// These read the server rather than the local cache on purpose. The cache
|
||||
// is a full mirror of the library, but /api/library/sync ships tracks whose
|
||||
// files are missing and carries no flag for it (#2704), while the browse
|
||||
// index filters them out -- so a locally-computed index would disagree with
|
||||
// the server's and with the web client. One source of truth wins over
|
||||
// offline capability here until #2704 is resolved.
|
||||
// These read the server rather than the local cache on purpose: the
|
||||
// server's index leaves out tracks whose files are missing and is the
|
||||
// one the web client shows, so the two clients agree. The cache carries
|
||||
// the same mark (cached_tracks.missing), but an index built from it
|
||||
// would be a second copy of the server's grouping that could drift.
|
||||
@GET("api/library/genres")
|
||||
suspend fun getGenres(): List<GenreCountWire>
|
||||
|
||||
|
||||
@@ -92,9 +92,7 @@ data class ChangePasswordRequest(
|
||||
|
||||
/**
|
||||
* Body for `PUT /api/me/listenbrainz`. Either `token` or `enabled`
|
||||
* is set; the server treats other fields as untouched. Mirrors
|
||||
* Flutter's `setListenBrainzToken` / `setListenBrainzEnabled` split
|
||||
* over a single endpoint shape.
|
||||
* is set; the server treats other fields as untouched.
|
||||
*/
|
||||
@Serializable
|
||||
data class ListenBrainzPutBody(
|
||||
|
||||
+1
-1
@@ -10,7 +10,7 @@ import retrofit2.http.Path
|
||||
import retrofit2.http.Query
|
||||
|
||||
/**
|
||||
* The notifications inbox and its per-user settings (M489). The server
|
||||
* The notifications inbox and its per-user settings. The server
|
||||
* renders each notice's title, body and link, so the app shows them as given.
|
||||
*/
|
||||
interface NotificationsApi {
|
||||
|
||||
@@ -49,7 +49,7 @@ interface PlaylistsApi {
|
||||
suspend fun refreshSystem(@Path("kind") variant: String): RefreshSystemResponse
|
||||
|
||||
/**
|
||||
* GET /api/playlists/system/{kind}/shuffle (#415 / #411 R2). Returns
|
||||
* GET /api/playlists/system/{kind}/shuffle. Returns
|
||||
* the system playlist's tracks in rotation-aware order without
|
||||
* rebuilding — used by the Home play-button overlay so taps on For
|
||||
* You / Discover / Today's mix advance rotation rather than picking
|
||||
@@ -60,8 +60,8 @@ interface PlaylistsApi {
|
||||
}
|
||||
|
||||
/**
|
||||
* POST /api/playlists/{id}/tracks body. Server expects snake_case
|
||||
* `track_ids` per the Flutter wire shape.
|
||||
* POST /api/playlists/{id}/tracks body. The server expects snake_case
|
||||
* `track_ids`.
|
||||
*/
|
||||
@Serializable
|
||||
data class AppendTracksRequest(
|
||||
|
||||
@@ -13,7 +13,7 @@ import retrofit2.http.Path
|
||||
*
|
||||
* Both flag and unflag are user-scoped — callers act on their own
|
||||
* quarantine entries. The cross-user admin surface is a separate
|
||||
* `/api/admin/quarantine` route (Phase 10 Commit D).
|
||||
* `/api/admin/quarantine` route.
|
||||
*/
|
||||
interface QuarantineApi {
|
||||
@GET("api/quarantine/mine")
|
||||
|
||||
@@ -4,7 +4,7 @@ import com.fabledsword.minstrel.models.wire.ReplayGainResponseWire
|
||||
import retrofit2.http.GET
|
||||
import retrofit2.http.Query
|
||||
|
||||
/** The player's loudness lookup (#4997), kept apart from the browse surface in [LibraryApi]. */
|
||||
/** The player's loudness lookup, kept apart from the browse surface in [LibraryApi]. */
|
||||
interface ReplayGainApi {
|
||||
/**
|
||||
* ReplayGain values for up to 200 comma-separated track ids. An id
|
||||
|
||||
@@ -10,7 +10,7 @@ import retrofit2.http.Path
|
||||
*
|
||||
* Server scopes results to the caller — admins see only their own
|
||||
* requests through this endpoint. The cross-user admin view lives on
|
||||
* a separate `/api/admin/requests` route (Phase 10 Commit D).
|
||||
* a separate `/api/admin/requests` route.
|
||||
*
|
||||
* The DELETE endpoint returns the cancelled row (not 204) so the UI
|
||||
* can patch local state without a refetch.
|
||||
|
||||
@@ -6,7 +6,7 @@ import retrofit2.http.GET
|
||||
import retrofit2.http.Query
|
||||
|
||||
/**
|
||||
* Retrofit interface for `/api/library/sync` (#357). The endpoint
|
||||
* Retrofit interface for `/api/library/sync`. The endpoint
|
||||
* returns three possible status codes that the SyncController
|
||||
* branches on:
|
||||
* - 200: parsed body with cursor + upserts + deletes
|
||||
|
||||
@@ -57,7 +57,7 @@ class AuthController @Inject constructor(
|
||||
}
|
||||
}
|
||||
// Refresh from /api/me on startup so a remotely-changed account
|
||||
// flag (e.g. admin enabling debug mode, M9) reaches the device
|
||||
// flag (e.g. an admin enabling debug mode) reaches the device
|
||||
// without a re-login. Best-effort; failures keep the cached value.
|
||||
scope.launch { refreshProfile() }
|
||||
}
|
||||
|
||||
@@ -35,13 +35,13 @@ import javax.inject.Singleton
|
||||
* sees the new value immediately; the DAO write coroutine catches up
|
||||
* shortly after.
|
||||
*
|
||||
* **The session cookie is the exception** (M462 #4985): it is persisted
|
||||
* through [SessionVault] (Keystore-encrypted), not the Room row. On the
|
||||
* first launch after the upgrade, a cookie still in the row is moved into
|
||||
* the vault and the column cleared, so nobody is signed out by the change.
|
||||
* If the Keystore cannot be used on a device, the cookie stays in the row
|
||||
* as before rather than being lost. [awaitSessionHydrated] lets a caller
|
||||
* that needs a definitive answer (the auth gate) wait for this.
|
||||
* **The session cookie is the exception**: it is persisted through
|
||||
* [SessionVault] (Keystore-encrypted), not the Room row. A cookie still
|
||||
* in the row is moved into the vault on launch and the column cleared,
|
||||
* so nobody is signed out by the move. If the Keystore cannot be used
|
||||
* on a device, the cookie stays in the row rather than being lost.
|
||||
* [awaitSessionHydrated] lets a caller that needs a definitive answer
|
||||
* (the auth gate) wait for this.
|
||||
*/
|
||||
// AuthStore is the single-row facade over auth_session (de-facto
|
||||
// app_preferences — see entity comment). It legitimately owns one
|
||||
@@ -81,7 +81,7 @@ class AuthStore @Inject constructor(
|
||||
private val normalizationState = MutableStateFlow(NormalizationPrefs.DEFAULT)
|
||||
val normalization: StateFlow<NormalizationPrefs> = normalizationState.asStateFlow()
|
||||
|
||||
// Background delivery (M489 #5347): the device's choice, on by default.
|
||||
// Background delivery: the device's choice, on by default.
|
||||
// The shade's high-water mark lives in the same row but is read and
|
||||
// written through the DAO by NotificationSync, awaited, never cached here.
|
||||
private val backgroundDeliveryState = MutableStateFlow(true)
|
||||
@@ -131,8 +131,8 @@ class AuthStore @Inject constructor(
|
||||
|
||||
/**
|
||||
* Suspends until the stored session cookie has been loaded into
|
||||
* [sessionCookie], or [HYDRATION_DEADLINE_MS] passes (rule 156: a wedged
|
||||
* Keystore must not leave the start screen spinning). Returns false on
|
||||
* [sessionCookie], or [HYDRATION_DEADLINE_MS] passes, so a wedged
|
||||
* Keystore cannot leave the start screen spinning. Returns false on
|
||||
* the deadline; the caller then decides from whatever has loaded, and a
|
||||
* late hydration still lands in [sessionCookie].
|
||||
*/
|
||||
|
||||
@@ -19,15 +19,14 @@ import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* Where the session cookie lives at rest (M462 #4985).
|
||||
* Where the session cookie lives at rest.
|
||||
*
|
||||
* The cookie is a bearer credential: anyone holding it is signed in as the
|
||||
* user until the server expires or revokes it. It used to sit in plain text
|
||||
* in the Room `auth_session` row, readable from any copy of the app's data
|
||||
* directory (a rooted device, an adb backup of a debuggable build, a
|
||||
* forensic image). Now only ciphertext is stored, under an AES key that
|
||||
* lives in the Android Keystore and never leaves it, so a copy of the
|
||||
* files alone yields nothing usable.
|
||||
* user until the server expires or revokes it. In plain text it would be
|
||||
* readable from any copy of the app's data directory (a rooted device, an
|
||||
* adb backup of a debuggable build, a forensic image). Only ciphertext is
|
||||
* stored, under an AES key that lives in the Android Keystore and never
|
||||
* leaves it, so a copy of the files alone yields nothing usable.
|
||||
*/
|
||||
interface SessionVault {
|
||||
/** The stored cookie, or null when none is stored or it can't be decrypted. */
|
||||
|
||||
@@ -19,8 +19,8 @@ import javax.inject.Inject
|
||||
* persisted auth state. Reads the row from AuthSessionDao directly, and
|
||||
* the session cookie only after [AuthStore.awaitSessionHydrated]: both
|
||||
* StateFlows default to null until their async load lands, and we need a
|
||||
* definitive answer before drawing any nav graph. The cookie is no longer
|
||||
* in the row (it lives in the Keystore-backed SessionVault, #4985).
|
||||
* definitive answer before drawing any nav graph. The cookie lives in the
|
||||
* Keystore-backed SessionVault, not the row.
|
||||
*
|
||||
* - no row at all → ServerUrl (first launch)
|
||||
* - row with baseUrl, no cookie → Login (URL configured, not yet signed in)
|
||||
|
||||
@@ -18,15 +18,13 @@ import javax.inject.Singleton
|
||||
* Populates `audio_cache_index` from playback so the offline pools
|
||||
* ([ShuffleSource]) and the cached indicator have a data source.
|
||||
*
|
||||
* Mirrors the user-visible behavior of Flutter's `AudioCacheManager`
|
||||
* (`registerStreamCache` + `touch`): a track you play gets cached as a
|
||||
* side effect of streaming, and playing it bumps its recency. The
|
||||
* Android idiom differs intentionally — Media3's `SimpleCache` is the
|
||||
* real byte store (span-based, keyed by trackId via the MediaItem's
|
||||
* custom cache key), so this index is a lightweight *play-recency*
|
||||
* record (source = INCIDENTAL) rather than Flutter's file-per-track
|
||||
* table. SimpleCache stays the source of truth for "is it actually on
|
||||
* disk"; this index orders "recently played" for the offline pools.
|
||||
* A track you play gets cached as a side effect of streaming, and
|
||||
* playing it bumps its recency. Media3's `SimpleCache` is the real byte
|
||||
* store (span-based, keyed by trackId via the MediaItem's custom cache
|
||||
* key), so this index is a lightweight *play-recency* record
|
||||
* (source = INCIDENTAL), not a file-per-track table. SimpleCache stays
|
||||
* the source of truth for "is it actually on disk"; this index orders
|
||||
* "recently played" for the offline pools.
|
||||
*
|
||||
* State observed against [PlayerController.uiState], deduped by track
|
||||
* id so each entry into the player records once. Eager-constructed via
|
||||
|
||||
@@ -19,11 +19,10 @@ private const val POOL_LIMIT = 100
|
||||
* storage/eviction-only and never filters playback — exactly what
|
||||
* this relies on.
|
||||
*
|
||||
* Divergence note: Flutter's `audioCacheIndex` only holds fully-cached
|
||||
* tracks, so its pools are inherently resident. Android's index records
|
||||
* plays (see `CacheIndexer`), so the recency list is intersected with
|
||||
* true Media3 SimpleCache residency here — the pool never offers a
|
||||
* played-then-evicted track that would fail to play offline.
|
||||
* The index records plays (see `CacheIndexer`), not residency, so the
|
||||
* recency list is intersected with true Media3 SimpleCache residency
|
||||
* here — the pool never offers a played-then-evicted track that would
|
||||
* fail to play offline.
|
||||
*
|
||||
* Surfaced on Home's Playlists row only when offline; tap shuffles +
|
||||
* plays the pool from the cache.
|
||||
@@ -58,7 +57,7 @@ class ShuffleSource @Inject constructor(
|
||||
if (orderedIds.isEmpty()) return emptyList()
|
||||
val byId = trackDao.getByIds(orderedIds).associateBy { it.id }
|
||||
return orderedIds.mapNotNull { id ->
|
||||
// Clear the server's missing mark (#2704). Every id reaching here
|
||||
// Clear the server's missing mark. Every id reaching here
|
||||
// came through residentIdsByRecency, which already proved the
|
||||
// AUDIO is in the local cache — so these play regardless of what
|
||||
// the server has lost, and the queue filter in PlayerController
|
||||
|
||||
+122
@@ -0,0 +1,122 @@
|
||||
package com.fabledsword.minstrel.cache.audiocache
|
||||
|
||||
import java.util.TreeSet
|
||||
|
||||
/** Which budget a cached track's bytes count against. */
|
||||
enum class CacheBucket { LIKED, RECENT }
|
||||
|
||||
/**
|
||||
* The bookkeeping behind [TwoBucketCacheEvictor]: which budget each cached
|
||||
* span counts against, how full each budget is, and which span to drop
|
||||
* next. It knows nothing of Media3, so it is tested directly.
|
||||
*
|
||||
* A span belongs to [CacheBucket.LIKED] when its key (the track id) is in
|
||||
* the liked set, and to [CacheBucket.RECENT] otherwise. A track that is
|
||||
* liked and also recently played is therefore charged to Liked only; the
|
||||
* two budgets never count the same bytes. Each bucket drops its own
|
||||
* least-recently-used span first, so filling one never evicts the other.
|
||||
*
|
||||
* Nothing is evicted until [setLiked] has been called once. Before then
|
||||
* every span would read as Recently played, and trimming at the Recently
|
||||
* played cap would throw away liked audio at startup.
|
||||
*
|
||||
* Not thread-safe; the evictor serialises every call.
|
||||
*/
|
||||
class BucketLedger<S : Any>(
|
||||
private val keyOf: (S) -> String,
|
||||
private val lengthOf: (S) -> Long,
|
||||
lruOrder: Comparator<S>,
|
||||
) {
|
||||
private val spans = mapOf(
|
||||
CacheBucket.LIKED to TreeSet(lruOrder),
|
||||
CacheBucket.RECENT to TreeSet(lruOrder),
|
||||
)
|
||||
private val bytes = mutableMapOf(CacheBucket.LIKED to 0L, CacheBucket.RECENT to 0L)
|
||||
private val spansByKey = HashMap<String, MutableSet<S>>()
|
||||
private val bucketByKey = HashMap<String, CacheBucket>()
|
||||
private var liked: Set<String> = emptySet()
|
||||
private var armed = false
|
||||
|
||||
/** Cap on Liked bytes; 0 means unlimited. */
|
||||
var likedCapBytes: Long = 0L
|
||||
|
||||
/** Cap on Recently played bytes; 0 means unlimited. */
|
||||
var recentCapBytes: Long = 0L
|
||||
|
||||
fun bucketOf(key: String): CacheBucket =
|
||||
if (key in liked) CacheBucket.LIKED else CacheBucket.RECENT
|
||||
|
||||
fun bytesIn(bucket: CacheBucket): Long = bytes.getValue(bucket)
|
||||
|
||||
/** Bytes the Liked budget can still take; [Long.MAX_VALUE] when unlimited. */
|
||||
fun likedRoomBytes(): Long = when {
|
||||
likedCapBytes <= 0L -> Long.MAX_VALUE
|
||||
else -> (likedCapBytes - bytesIn(CacheBucket.LIKED)).coerceAtLeast(0L)
|
||||
}
|
||||
|
||||
fun add(span: S) {
|
||||
val key = keyOf(span)
|
||||
val bucket = bucketByKey[key] ?: bucketOf(key).also { bucketByKey[key] = it }
|
||||
if (spans.getValue(bucket).add(span)) {
|
||||
bytes[bucket] = bytesIn(bucket) + lengthOf(span)
|
||||
spansByKey.getOrPut(key) { HashSet() }.add(span)
|
||||
}
|
||||
}
|
||||
|
||||
fun remove(span: S) {
|
||||
val key = keyOf(span)
|
||||
val bucket = bucketByKey[key] ?: return
|
||||
if (spans.getValue(bucket).remove(span)) {
|
||||
bytes[bucket] = bytesIn(bucket) - lengthOf(span)
|
||||
}
|
||||
val forKey = spansByKey[key] ?: return
|
||||
forKey.remove(span)
|
||||
if (forKey.isEmpty()) {
|
||||
spansByKey.remove(key)
|
||||
bucketByKey.remove(key)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Replace the liked set and move every cached track whose bucket
|
||||
* changed: a newly liked track's bytes leave Recently played for Liked,
|
||||
* an unliked track's go the other way. Arms eviction.
|
||||
*/
|
||||
fun setLiked(ids: Set<String>) {
|
||||
liked = ids
|
||||
armed = true
|
||||
val moves = bucketByKey.filter { (key, bucket) -> bucketOf(key) != bucket }.keys.toList()
|
||||
for (key in moves) {
|
||||
val from = bucketByKey.getValue(key)
|
||||
val to = bucketOf(key)
|
||||
for (span in spansByKey[key].orEmpty()) {
|
||||
if (spans.getValue(from).remove(span)) {
|
||||
bytes[from] = bytesIn(from) - lengthOf(span)
|
||||
spans.getValue(to).add(span)
|
||||
bytes[to] = bytesIn(to) + lengthOf(span)
|
||||
}
|
||||
}
|
||||
bucketByKey[key] = to
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* The span to drop next, or null when both budgets fit. [pendingKey] and
|
||||
* [pendingBytes] describe a write about to start, so room is made for it
|
||||
* in its own bucket first. Recently played is trimmed before Liked.
|
||||
*/
|
||||
fun nextEviction(pendingKey: String? = null, pendingBytes: Long = 0L): S? {
|
||||
if (!armed) return null
|
||||
val pendingBucket = pendingKey?.let(::bucketOf)
|
||||
return listOf(CacheBucket.RECENT, CacheBucket.LIKED).firstNotNullOfOrNull { bucket ->
|
||||
val incoming = if (bucket == pendingBucket) pendingBytes.coerceAtLeast(0L) else 0L
|
||||
oldestIfOver(bucket, incoming)
|
||||
}
|
||||
}
|
||||
|
||||
private fun oldestIfOver(bucket: CacheBucket, incoming: Long): S? {
|
||||
val cap = if (bucket == CacheBucket.LIKED) likedCapBytes else recentCapBytes
|
||||
val over = cap > 0L && bytesIn(bucket) + incoming > cap
|
||||
return if (over) spans.getValue(bucket).firstOrNull() else null
|
||||
}
|
||||
}
|
||||
+40
@@ -0,0 +1,40 @@
|
||||
package com.fabledsword.minstrel.cache.audiocache
|
||||
|
||||
import com.fabledsword.minstrel.auth.AuthStore
|
||||
import com.fabledsword.minstrel.di.ApplicationScope
|
||||
import com.fabledsword.minstrel.likes.data.LikesRepository
|
||||
import kotlinx.coroutines.CoroutineScope
|
||||
import kotlinx.coroutines.Dispatchers
|
||||
import kotlinx.coroutines.flow.combine
|
||||
import kotlinx.coroutines.launch
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* Keeps [TwoBucketCacheEvictor] in step with the signed-in user's liked
|
||||
* tracks and the Storage caps. A like moves that track's cached audio into
|
||||
* the Liked budget, an unlike moves it out, and a cap change trims at once.
|
||||
*
|
||||
* The liked set only flows once a user is signed in, and the evictor drops
|
||||
* nothing until it has one, so liked audio is never trimmed as Recently
|
||||
* played while the session is still loading.
|
||||
*
|
||||
* Eager-constructed via the construct-the-singleton trick in
|
||||
* `MinstrelApplication`.
|
||||
*/
|
||||
@Singleton
|
||||
class CacheBudgetSync @Inject constructor(
|
||||
likes: LikesRepository,
|
||||
authStore: AuthStore,
|
||||
evictor: TwoBucketCacheEvictor,
|
||||
@ApplicationScope scope: CoroutineScope,
|
||||
) {
|
||||
init {
|
||||
scope.launch(Dispatchers.IO) {
|
||||
combine(likes.observeSignedInLikedTrackIds(), authStore.cacheSettings, ::Pair)
|
||||
.collect { (ids, settings) ->
|
||||
evictor.update(ids, settings.likedCapBytes, settings.rollingCapBytes)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
-23
@@ -1,23 +0,0 @@
|
||||
package com.fabledsword.minstrel.cache.audiocache
|
||||
|
||||
/**
|
||||
* Defaults for the 2-bucket audio cache.
|
||||
*
|
||||
* - `likedCapBytes`: cap for the protected bucket — cached files for
|
||||
* tracks the user has liked. Evicted only after the rolling bucket
|
||||
* is fully drained (almost never under normal use).
|
||||
* - `rollingCapBytes`: cap for the unprotected bucket — incidental /
|
||||
* auto-prefetch downloads. LRU within this bucket.
|
||||
*
|
||||
* Phase 11 (Settings) will allow user overrides; the values are kept
|
||||
* generous so first-time installs work well without configuration.
|
||||
*/
|
||||
data class CacheConfig(
|
||||
val likedCapBytes: Long = DEFAULT_LIKED_CAP_BYTES,
|
||||
val rollingCapBytes: Long = DEFAULT_ROLLING_CAP_BYTES,
|
||||
) {
|
||||
companion object {
|
||||
const val DEFAULT_LIKED_CAP_BYTES: Long = 200L * 1024 * 1024 // 200 MiB
|
||||
const val DEFAULT_ROLLING_CAP_BYTES: Long = 150L * 1024 * 1024 // 150 MiB
|
||||
}
|
||||
}
|
||||
+12
-12
@@ -9,19 +9,19 @@ private const val DEFAULT_PREFETCH_WINDOW = 5
|
||||
* User-tunable audio cache settings. Persisted as a JSON
|
||||
* blob on the auth_session single-row table via [AuthStore].
|
||||
*
|
||||
* - [likedCapBytes]: budget for cached files of liked tracks. 0 means
|
||||
* unlimited. Effective at next app start (SimpleCache is built once
|
||||
* per process).
|
||||
* - [rollingCapBytes]: budget for incidental / auto-prefetch downloads.
|
||||
* Same 0=unlimited / restart-to-apply caveat.
|
||||
* - [prefetchWindow]: 1..10. Number of next-tracks the prefetcher
|
||||
* pre-downloads. Has no effect until the prefetcher lands (separate
|
||||
* audit follow-up) — persisted now so the user can pre-configure.
|
||||
* - [cacheLikedTracks]: when true, liking a track should also pin its
|
||||
* audio to the liked-cache bucket. Has no effect until pin-on-like
|
||||
* lands (separate follow-up).
|
||||
* - [likedCapBytes]: the Liked songs budget, for the cached audio of
|
||||
* liked tracks. 0 means unlimited.
|
||||
* - [rollingCapBytes]: the Recently played budget, for everything else
|
||||
* streamed or prefetched. 0 means unlimited.
|
||||
* A track that is liked and also recently played counts against Liked
|
||||
* only. Both caps apply as soon as they change ([TwoBucketCacheEvictor]).
|
||||
* - [prefetchWindow]: 1..10. Number of next-tracks `AudioPrefetcher`
|
||||
* pre-downloads.
|
||||
* - [cacheLikedTracks]: "Keep liked songs offline". When true,
|
||||
* `LikedAudioPinner` downloads liked tracks into the Liked budget on
|
||||
* Wi-Fi, most recently liked first, while the budget has room.
|
||||
*
|
||||
* Defaults match Flutter: 5 GiB per bucket, prefetch=5, cache-liked=true.
|
||||
* Defaults: 5 GiB per bucket, prefetch=5, cache-liked=true.
|
||||
*/
|
||||
@Serializable
|
||||
data class CacheSettings(
|
||||
|
||||
Vendored
+112
@@ -0,0 +1,112 @@
|
||||
package com.fabledsword.minstrel.cache.audiocache
|
||||
|
||||
import androidx.media3.common.C
|
||||
import androidx.media3.datasource.cache.Cache
|
||||
import androidx.media3.datasource.cache.CacheEvictor
|
||||
import androidx.media3.datasource.cache.CacheSpan
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* Bytes held against each audio-cache budget, and how much more the Liked
|
||||
* budget can take ([Long.MAX_VALUE] when it is unlimited).
|
||||
*/
|
||||
data class CacheUsage(val likedBytes: Long, val recentBytes: Long, val likedRoomBytes: Long)
|
||||
|
||||
/**
|
||||
* The audio cache's eviction policy: two budgets, Liked songs and Recently
|
||||
* played, each with its own cap and its own least-recently-used order (see
|
||||
* [BucketLedger]). SimpleCache takes exactly one evictor, so this one
|
||||
* carries both budgets.
|
||||
*
|
||||
* [CacheBudgetSync] feeds it the signed-in user's liked set and the caps
|
||||
* from Storage settings, so a like, an unlike or a cap change applies at
|
||||
* once, without restarting the app.
|
||||
*
|
||||
* Locking: SimpleCache calls every [CacheEvictor] method while holding its
|
||||
* own monitor. Outside calls take the cache's monitor first and the
|
||||
* ledger's second, the same order as those callbacks, so the two never
|
||||
* deadlock.
|
||||
*/
|
||||
@Singleton
|
||||
class TwoBucketCacheEvictor @Inject constructor() : CacheEvictor {
|
||||
private val ledger = BucketLedger<CacheSpan>(
|
||||
keyOf = { it.key },
|
||||
lengthOf = { it.length },
|
||||
lruOrder = compareBy<CacheSpan> { it.lastTouchTimestamp }.then(naturalOrder()),
|
||||
)
|
||||
|
||||
@Volatile private var cache: Cache? = null
|
||||
|
||||
/** Called once the SimpleCache exists, so updates can trim it. */
|
||||
fun attach(cache: Cache) {
|
||||
this.cache = cache
|
||||
}
|
||||
|
||||
/** Apply a new liked set and caps, then trim whatever no longer fits. */
|
||||
fun update(likedIds: Set<String>, likedCapBytes: Long, recentCapBytes: Long) {
|
||||
val c = cache
|
||||
val apply = {
|
||||
ledger.likedCapBytes = likedCapBytes
|
||||
ledger.recentCapBytes = recentCapBytes
|
||||
ledger.setLiked(likedIds)
|
||||
}
|
||||
if (c == null) {
|
||||
synchronized(ledger) { apply() }
|
||||
} else {
|
||||
synchronized(c) {
|
||||
synchronized(ledger) {
|
||||
apply()
|
||||
evict(c, pendingKey = null, pendingBytes = 0L)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fun usage(): CacheUsage = synchronized(ledger) {
|
||||
CacheUsage(
|
||||
likedBytes = ledger.bytesIn(CacheBucket.LIKED),
|
||||
recentBytes = ledger.bytesIn(CacheBucket.RECENT),
|
||||
likedRoomBytes = ledger.likedRoomBytes(),
|
||||
)
|
||||
}
|
||||
|
||||
override fun requiresCacheSpanTouches(): Boolean = true
|
||||
|
||||
override fun onCacheInitialized() = Unit
|
||||
|
||||
override fun onStartFile(cache: Cache, key: String, position: Long, length: Long) {
|
||||
synchronized(ledger) {
|
||||
evict(cache, key, if (length == C.LENGTH_UNSET.toLong()) 0L else length)
|
||||
}
|
||||
}
|
||||
|
||||
override fun onSpanAdded(cache: Cache, span: CacheSpan) {
|
||||
synchronized(ledger) {
|
||||
ledger.add(span)
|
||||
evict(cache, pendingKey = null, pendingBytes = 0L)
|
||||
}
|
||||
}
|
||||
|
||||
override fun onSpanRemoved(cache: Cache, span: CacheSpan) {
|
||||
synchronized(ledger) { ledger.remove(span) }
|
||||
}
|
||||
|
||||
override fun onSpanTouched(cache: Cache, oldSpan: CacheSpan, newSpan: CacheSpan) {
|
||||
synchronized(ledger) {
|
||||
ledger.remove(oldSpan)
|
||||
ledger.add(newSpan)
|
||||
evict(cache, pendingKey = null, pendingBytes = 0L)
|
||||
}
|
||||
}
|
||||
|
||||
private fun evict(cache: Cache, pendingKey: String?, pendingBytes: Long) {
|
||||
while (true) {
|
||||
val span = ledger.nextEviction(pendingKey, pendingBytes) ?: return
|
||||
cache.removeSpan(span)
|
||||
// removeSpan reports back through onSpanRemoved; removing here as
|
||||
// well guarantees the loop advances even if it did not.
|
||||
ledger.remove(span)
|
||||
}
|
||||
}
|
||||
}
|
||||
+20
-25
@@ -40,17 +40,12 @@ import com.fabledsword.minstrel.cache.db.entities.DiagnosticEventEntity
|
||||
import com.fabledsword.minstrel.cache.db.entities.SyncMetadataEntity
|
||||
|
||||
/**
|
||||
* Single Room database for the whole app. Mirrors the Flutter client's
|
||||
* Drift `AppDb` — same logical schema, one entity-family per @Entity.
|
||||
* Single Room database for the whole app, one entity family per @Entity.
|
||||
*
|
||||
* Native v1 starts at schema version 1 (the Flutter Drift schemaVersion 11
|
||||
* is an internal client detail; the server is the source of truth and the
|
||||
* sync controller refills on first launch). Future schema bumps land per
|
||||
* change with explicit `Migration` entries; `fallbackToDestructiveMigration`
|
||||
* in `DatabaseModule` is the safety net while we're pre-v1.
|
||||
*
|
||||
* Entity families land in Task 4.2 slices. The set will grow until the
|
||||
* whole Drift schema is mirrored.
|
||||
* The server is the source of truth: the sync controller refills the
|
||||
* cache on first launch. Schema bumps land with explicit `Migration`
|
||||
* entries; `fallbackToDestructiveMigration` in `DatabaseModule` rebuilds
|
||||
* the database from a version that has no migration path.
|
||||
*/
|
||||
@Database(
|
||||
entities = [
|
||||
@@ -73,25 +68,25 @@ import com.fabledsword.minstrel.cache.db.entities.SyncMetadataEntity
|
||||
CachedNotificationSettingsEntity::class,
|
||||
],
|
||||
// v12: + auth_session.backgroundDelivery and notifiedUpTo, the device's
|
||||
// background-delivery choice and its shade high-water mark (M489 #5347).
|
||||
// background-delivery choice and its shade high-water mark.
|
||||
// v11: + cached_notifications and cached_notification_settings, the
|
||||
// notifications inbox and its settings (M489). MIGRATION_10_11 creates
|
||||
// notifications inbox and its settings. MIGRATION_10_11 creates
|
||||
// both; nothing to backfill, the first refresh fills them.
|
||||
// v10: + cached_tracks.trackGain/trackPeak and cached_albums.albumGain/
|
||||
// albumPeak, the ReplayGain values the player levels by (M464 #5000).
|
||||
// albumPeak, the ReplayGain values the player levels by.
|
||||
// MIGRATION_9_10 also rewinds the sync cursor, so the next sync re-sends
|
||||
// every row and an existing cache gains its values.
|
||||
// v9: + auth_session.normalizationJson, the loudness-normalization
|
||||
// preference (M464 #4998). The first schema step with an explicit
|
||||
// Migration (MIGRATION_8_9): a destructive rebuild would also wipe this
|
||||
// row — the server address and theme — and the queued offline writes,
|
||||
// preference. The first schema step with an explicit Migration
|
||||
// (MIGRATION_8_9): a destructive rebuild would also wipe this row —
|
||||
// the server address and theme — and the queued offline writes,
|
||||
// which is too much to lose for one added column.
|
||||
// v8: + cached_tracks.missing, the server's missing-file mark (#2704),
|
||||
// v8: + cached_tracks.missing, the server's missing-file mark,
|
||||
// so cache-first surfaces stop offering files that cannot stream.
|
||||
// v7: + diagnostic_events table (M9) and the diagnosticsOptOut column
|
||||
// on auth_session. Pre-v1 destructive fallback rebuilds on mismatch —
|
||||
// which is exactly right here: the next sync refills every row with the
|
||||
// new column populated, so there is nothing to migrate by hand.
|
||||
// v7: + diagnostic_events table and the diagnosticsOptOut column
|
||||
// on auth_session. Versions before v8 rebuild destructively, which is
|
||||
// right for them: the next sync refills every row with the new
|
||||
// columns populated, so there is nothing to migrate by hand.
|
||||
version = 12,
|
||||
exportSchema = true,
|
||||
)
|
||||
@@ -115,7 +110,7 @@ abstract class AppDatabase : RoomDatabase() {
|
||||
abstract fun cachedNotificationDao(): CachedNotificationDao
|
||||
}
|
||||
|
||||
/** v8 → v9: add the nullable normalization preference column (#4998). */
|
||||
/** v8 → v9: add the nullable normalization preference column. */
|
||||
val MIGRATION_8_9: Migration = object : Migration(8, 9) {
|
||||
override fun migrate(db: SupportSQLiteDatabase) {
|
||||
db.execSQL("ALTER TABLE auth_session ADD COLUMN normalizationJson TEXT")
|
||||
@@ -123,7 +118,7 @@ val MIGRATION_8_9: Migration = object : Migration(8, 9) {
|
||||
}
|
||||
|
||||
/**
|
||||
* v9 → v10: the gain columns (#5000). Rows synced before this carry no gains,
|
||||
* v9 → v10: the gain columns. Rows synced before this carry no gains,
|
||||
* and the sync is incremental, so it would never re-send them: the cursor goes
|
||||
* back to 0 and the next sync is a full one, upserting every row in place.
|
||||
*/
|
||||
@@ -138,7 +133,7 @@ val MIGRATION_9_10: Migration = object : Migration(9, 10) {
|
||||
}
|
||||
|
||||
/**
|
||||
* v10 → v11: the notifications inbox cache and its settings (M489). The SQL
|
||||
* v10 → v11: the notifications inbox cache and its settings. The SQL
|
||||
* matches what Room generates for the two entities; Room checks it on open.
|
||||
*/
|
||||
val MIGRATION_10_11: Migration = object : Migration(10, 11) {
|
||||
@@ -157,7 +152,7 @@ val MIGRATION_10_11: Migration = object : Migration(10, 11) {
|
||||
}
|
||||
|
||||
/**
|
||||
* v11 → v12: background delivery (M489 #5347). The device choice defaults on,
|
||||
* v11 → v12: background delivery. The device choice defaults on,
|
||||
* as the entity's column default says; the high-water mark starts empty, so
|
||||
* the first catch-up sets it without announcing anything.
|
||||
*/
|
||||
|
||||
+4
-5
@@ -33,11 +33,10 @@ object DatabaseModule {
|
||||
@Singleton
|
||||
fun provideDatabase(@ApplicationContext context: Context): AppDatabase =
|
||||
Room.databaseBuilder(context, AppDatabase::class.java, DATABASE_NAME)
|
||||
// Pre-v1 safety net: rebuild on any schema mismatch. The sync
|
||||
// controller refills the cache from the server on first
|
||||
// launch, so users lose only the unsynced mutation queue
|
||||
// (acceptable while we're iterating). Replace with explicit
|
||||
// Migration entries before the first tagged release.
|
||||
// Explicit migrations from v8 onward; an older schema has no path
|
||||
// and rebuilds. The sync controller refills the cache from the
|
||||
// server on first launch, so a rebuild loses only the unsynced
|
||||
// mutation queue.
|
||||
.addMigrations(MIGRATION_8_9, MIGRATION_9_10, MIGRATION_10_11, MIGRATION_11_12)
|
||||
.fallbackToDestructiveMigration(dropAllTables = true)
|
||||
.build()
|
||||
|
||||
+6
-15
@@ -4,17 +4,10 @@ import androidx.room.TypeConverter
|
||||
import kotlinx.datetime.Instant
|
||||
|
||||
/**
|
||||
* Source category for a cached audio file. Mirrors the Drift `CacheSource`
|
||||
* enum used by the Flutter client's `audio_cache_index` table 1:1.
|
||||
*
|
||||
* - `MANUAL`: user explicitly pinned (e.g. "save for offline")
|
||||
* - `AUTO_LIKED`: auto-cached because the track is liked
|
||||
* - `AUTO_PLAYLIST`: auto-cached because it's in a pinned playlist
|
||||
* - `AUTO_PREFETCH`: pre-warmed by background prefetch heuristics
|
||||
* - `INCIDENTAL`: cached as a side effect of playback streaming
|
||||
*
|
||||
* Eviction priority order (first to evict): INCIDENTAL → AUTO_PREFETCH
|
||||
* → AUTO_PLAYLIST → AUTO_LIKED → MANUAL.
|
||||
* How a row reached `audio_cache_index`. `CacheIndexer` writes
|
||||
* `INCIDENTAL` (the track was played); the other values are stored names
|
||||
* no writer uses. Eviction does not read this: the audio cache's two
|
||||
* budgets follow the liked set (see `TwoBucketCacheEvictor`).
|
||||
*/
|
||||
enum class CacheSource { MANUAL, AUTO_LIKED, AUTO_PLAYLIST, AUTO_PREFETCH, INCIDENTAL }
|
||||
|
||||
@@ -22,10 +15,8 @@ enum class CacheSource { MANUAL, AUTO_LIKED, AUTO_PLAYLIST, AUTO_PREFETCH, INCID
|
||||
* Cross-cutting Room type converters. Registered on `@Database` via
|
||||
* `@TypeConverters(MinstrelTypeConverters::class)`.
|
||||
*
|
||||
* `kotlinx.datetime.Instant` ↔ `Long` epoch millis: the same convention the
|
||||
* Flutter client uses (Drift `text()` column with ISO-8601 strings would
|
||||
* also work but Long is leaner; we don't need human-readable rows in the
|
||||
* SQLite file).
|
||||
* `kotlinx.datetime.Instant` ↔ `Long` epoch millis: leaner than ISO-8601
|
||||
* text, and nothing needs human-readable rows in the SQLite file.
|
||||
*/
|
||||
class MinstrelTypeConverters {
|
||||
@TypeConverter fun instantToLong(i: Instant?): Long? = i?.toEpochMilliseconds()
|
||||
|
||||
-18
@@ -4,7 +4,6 @@ import androidx.room.Dao
|
||||
import androidx.room.Insert
|
||||
import androidx.room.OnConflictStrategy
|
||||
import androidx.room.Query
|
||||
import com.fabledsword.minstrel.cache.db.CacheSource
|
||||
import com.fabledsword.minstrel.cache.db.entities.AudioCacheIndexEntity
|
||||
import kotlinx.coroutines.flow.Flow
|
||||
|
||||
@@ -32,23 +31,6 @@ interface AudioCacheIndexDao {
|
||||
@Query("SELECT trackId FROM audio_cache_index ORDER BY lastPlayedAt DESC NULLS LAST")
|
||||
suspend fun trackIdsByRecency(): List<String>
|
||||
|
||||
/** Eviction-candidate ordering — oldest lastPlayedAt first within a source. */
|
||||
@Query(
|
||||
"SELECT * FROM audio_cache_index " +
|
||||
"WHERE source = :source " +
|
||||
"ORDER BY lastPlayedAt ASC NULLS FIRST, cachedAt ASC",
|
||||
)
|
||||
suspend fun evictionCandidates(source: CacheSource): List<AudioCacheIndexEntity>
|
||||
|
||||
/** Sum of bytes across rows; the rolling/liked bucket caps compare against this. */
|
||||
@Query("SELECT COALESCE(SUM(sizeBytes), 0) FROM audio_cache_index")
|
||||
suspend fun totalBytes(): Long
|
||||
|
||||
@Query(
|
||||
"SELECT COALESCE(SUM(sizeBytes), 0) FROM audio_cache_index WHERE source = :source",
|
||||
)
|
||||
suspend fun bytesBySource(source: CacheSource): Long
|
||||
|
||||
@Insert(onConflict = OnConflictStrategy.REPLACE)
|
||||
suspend fun upsert(row: AudioCacheIndexEntity)
|
||||
|
||||
|
||||
+10
-7
@@ -10,12 +10,16 @@ import kotlinx.coroutines.flow.Flow
|
||||
|
||||
@Dao
|
||||
interface CachedLikeDao {
|
||||
/** All track IDs the user has liked. Audio-cache eviction uses this set. */
|
||||
/**
|
||||
* The user's liked track IDs, most recently liked first. The audio
|
||||
* cache's Liked budget and the liked-audio downloads read this.
|
||||
*/
|
||||
@Query(
|
||||
"SELECT entityId FROM cached_likes " +
|
||||
"WHERE userId = :userId AND entityType = 'track'",
|
||||
"WHERE userId = :userId AND entityType = 'track' " +
|
||||
"ORDER BY likedAt DESC",
|
||||
)
|
||||
fun observeLikedTrackIds(userId: String): Flow<List<String>>
|
||||
fun observeLikedTrackIdsNewestFirst(userId: String): Flow<List<String>>
|
||||
|
||||
@Query(
|
||||
"SELECT entityId FROM cached_likes " +
|
||||
@@ -44,10 +48,9 @@ interface CachedLikeDao {
|
||||
/**
|
||||
* Atomically replaces the user's entire cached_likes set with
|
||||
* [rows]. Used by [com.fabledsword.minstrel.likes.data.LikesRepository.refreshIds]
|
||||
* so cross-device unlikes (a row that the server no longer
|
||||
* surfaces) get removed from the local cache — drift #570
|
||||
* caught the missing delete pass that left stale Liked tab
|
||||
* entries pointing at tracks the user had unliked elsewhere.
|
||||
* so an unlike made on another device (a row the server no longer
|
||||
* surfaces) leaves the local cache too; upserts alone would keep a
|
||||
* stale Liked tab entry forever.
|
||||
*/
|
||||
@Transaction
|
||||
suspend fun replaceAllForUser(userId: String, rows: List<CachedLikeEntity>) {
|
||||
|
||||
+5
-5
@@ -46,13 +46,13 @@ interface CachedPlaylistTrackDao {
|
||||
* Atomic on purpose. Room's InvalidationTracker only notifies observers
|
||||
* after the transaction commits, so [observeByPlaylist] never sees the
|
||||
* empty gap between the delete and the re-insert. Un-transacted, that
|
||||
* gap is a real observed state — it's what made every Home row visibly
|
||||
* collapse to empty and refill before issue #2327 fixed the equivalent
|
||||
* write in `CachedHomeIndexDao`.
|
||||
* gap is a real observed state: the list visibly collapses to empty
|
||||
* and refills, which is why `CachedHomeIndexDao` transacts its writes
|
||||
* too.
|
||||
*
|
||||
* Nothing observes [observeByPlaylist] live today, so this is
|
||||
* pre-emptive: it means making playlist detail cache-first later can't
|
||||
* silently reintroduce that flicker.
|
||||
* pre-emptive: making playlist detail cache-first later can't
|
||||
* silently bring that flicker in.
|
||||
*/
|
||||
@Transaction
|
||||
suspend fun replacePlaylistTracks(
|
||||
|
||||
+1
-2
@@ -41,8 +41,7 @@ interface CachedQuarantineDao {
|
||||
/**
|
||||
* Atomic full-replace from the server snapshot — one transaction so
|
||||
* the `observeAll()` watcher sees a single merged emission, not a
|
||||
* delete-then-insert flicker. Mirrors Flutter's MyQuarantineController
|
||||
* `_refreshFromServer` transaction.
|
||||
* delete-then-insert flicker.
|
||||
*/
|
||||
@Transaction
|
||||
suspend fun replaceAll(rows: List<CachedQuarantineEntity>) {
|
||||
|
||||
+1
-1
@@ -39,7 +39,7 @@ interface CachedTrackDao {
|
||||
suspend fun upsertAll(rows: List<CachedTrackEntity>)
|
||||
|
||||
/**
|
||||
* ReplayGain values for [ids] (M464 #5000): the track's own from its row,
|
||||
* ReplayGain values for [ids]: the track's own from its row,
|
||||
* the album's from its album row. A track not in the cache has no row.
|
||||
*/
|
||||
@Query(
|
||||
|
||||
Vendored
+7
-11
@@ -7,18 +7,14 @@ import kotlinx.datetime.Clock
|
||||
import kotlinx.datetime.Instant
|
||||
|
||||
/**
|
||||
* One row per fully-downloaded audio file. Mirrors
|
||||
* the Flutter client's `AudioCacheIndex` Drift table.
|
||||
* One row per track that has played through the audio cache (see
|
||||
* `CacheIndexer`); SimpleCache, not this table, says what is on disk.
|
||||
*
|
||||
* Drives the 2-bucket LRU eviction (Phase 12 AudioCacheEvictionWorker):
|
||||
* - `incidental` files (streamed-and-cached side effect) evict first
|
||||
* - `autoPrefetch` second
|
||||
* - `manual` (user explicitly pinned) evict last
|
||||
*
|
||||
* `cachedAt` = when we downloaded. `lastPlayedAt` = when the user last
|
||||
* played it; drives the offline "recently played" ordering and is the
|
||||
* tiebreaker for LRU eviction within a source bucket. Nullable on
|
||||
* brand-new rows until the first post-cache play touches them.
|
||||
* `source` says how the row arrived (see [CacheSource]); eviction does
|
||||
* not read it. `cachedAt` = when the row was written. `lastPlayedAt` =
|
||||
* when the user last played the track, which orders the offline
|
||||
* "recently played" pool. Nullable on brand-new rows until the first
|
||||
* post-cache play touches them.
|
||||
*/
|
||||
@Entity(tableName = "audio_cache_index")
|
||||
data class AudioCacheIndexEntity(
|
||||
|
||||
+3
-3
@@ -39,7 +39,7 @@ data class AuthSessionEntity(
|
||||
*/
|
||||
val cacheSettingsJson: String? = null,
|
||||
/**
|
||||
* Per-device opt-out of diagnostics reporting (M9). When the
|
||||
* Per-device opt-out of diagnostics reporting. When the
|
||||
* account's debug mode is enabled by an admin, the user can still
|
||||
* turn reporting OFF on this device (battery/privacy) — that local
|
||||
* choice lives here. Default false = honor the account flag.
|
||||
@@ -47,12 +47,12 @@ data class AuthSessionEntity(
|
||||
val diagnosticsOptOut: Boolean = false,
|
||||
/**
|
||||
* JSON-encoded NormalizationPrefs (settings/data), the last value seen
|
||||
* from the server or set here (M464 #4998). Null = never fetched; the
|
||||
* from the server or set here. Null = never fetched; the
|
||||
* defaults apply. Kept so offline playback still levels.
|
||||
*/
|
||||
val normalizationJson: String? = null,
|
||||
/**
|
||||
* "Notifications when the app is closed" (M489 #5347): keep the
|
||||
* "Notifications when the app is closed": keep the
|
||||
* delivery foreground service running. A device choice, on by default.
|
||||
* The column default matches MIGRATION_11_12's, which Room checks.
|
||||
*/
|
||||
|
||||
+2
-5
@@ -5,10 +5,7 @@ import androidx.room.PrimaryKey
|
||||
import kotlinx.datetime.Clock
|
||||
import kotlinx.datetime.Instant
|
||||
|
||||
/**
|
||||
* Cache row for one album. Mirrors the Flutter client's
|
||||
* `CachedAlbums` Drift table.
|
||||
*/
|
||||
/** Cache row for one album. */
|
||||
@Entity(tableName = "cached_albums")
|
||||
data class CachedAlbumEntity(
|
||||
@PrimaryKey val id: String,
|
||||
@@ -18,7 +15,7 @@ data class CachedAlbumEntity(
|
||||
val releaseDate: String? = null,
|
||||
val coverPath: String? = null,
|
||||
val mbid: String? = null,
|
||||
// ReplayGain 2.0 album values (M464); null until every track is measured.
|
||||
// ReplayGain 2.0 album values; null until every track is measured.
|
||||
val albumGain: Float? = null,
|
||||
val albumPeak: Float? = null,
|
||||
val fetchedAt: Instant = Clock.System.now(),
|
||||
|
||||
+4
-6
@@ -6,13 +6,11 @@ import kotlinx.datetime.Clock
|
||||
import kotlinx.datetime.Instant
|
||||
|
||||
/**
|
||||
* Cache row for one artist. Mirrors the Flutter client's
|
||||
* `CachedArtists` Drift table.
|
||||
* Cache row for one artist.
|
||||
*
|
||||
* Column names follow Kotlin idiom (camelCase) rather than Drift's
|
||||
* snake_case — the schema is purely internal to the native client; the
|
||||
* sync controller exchanges snake_case JSON with the server and our
|
||||
* mappers translate at the boundary.
|
||||
* Column names follow Kotlin idiom (camelCase) — the schema is purely
|
||||
* internal to the app; the sync controller exchanges snake_case JSON
|
||||
* with the server and our mappers translate at the boundary.
|
||||
*/
|
||||
@Entity(tableName = "cached_artists")
|
||||
data class CachedArtistEntity(
|
||||
|
||||
Vendored
+1
-2
@@ -8,8 +8,7 @@ import kotlinx.datetime.Instant
|
||||
/**
|
||||
* Single-row snapshot of the `/api/me/history` response, stored as the
|
||||
* raw wire JSON so the History tab paints instantly from disk on cold
|
||||
* open and survives connectivity loss. Mirrors the Flutter Drift
|
||||
* `CachedHistorySnapshot` table (id defaults to 1; one row total).
|
||||
* open and survives connectivity loss. One row total; id defaults to 1.
|
||||
*
|
||||
* Cache-first + SWR: the tab observes this row and a background refresh
|
||||
* overwrites it, so the freshest plays land without a blocking spinner.
|
||||
|
||||
Vendored
+1
-2
@@ -5,8 +5,7 @@ import kotlinx.datetime.Clock
|
||||
import kotlinx.datetime.Instant
|
||||
|
||||
/**
|
||||
* Per-item row driving the Home screen sections. Mirrors
|
||||
* the Flutter client's `CachedHomeIndex` Drift table.
|
||||
* Per-item row driving the Home screen sections.
|
||||
*
|
||||
* `section` is one of (matching /api/home keys):
|
||||
* - "recently_added_albums"
|
||||
|
||||
+3
-4
@@ -5,14 +5,13 @@ import kotlinx.datetime.Clock
|
||||
import kotlinx.datetime.Instant
|
||||
|
||||
/**
|
||||
* Like membership row. Mirrors the Flutter client's
|
||||
* `CachedLikes` Drift table. Composite primary key — one user may
|
||||
* Like membership row. Composite primary key — one user may
|
||||
* independently like a track AND its album AND its artist; rows are
|
||||
* disambiguated by the (userId, entityType, entityId) triple.
|
||||
*
|
||||
* `entityType` is one of "track" | "album" | "artist". Stored as a
|
||||
* plain string for parity with the Drift schema and the server's wire
|
||||
* format; an enum doesn't earn its keep here.
|
||||
* plain string to match the server's wire format; an enum doesn't
|
||||
* earn its keep here.
|
||||
*/
|
||||
@Entity(
|
||||
tableName = "cached_likes",
|
||||
|
||||
Vendored
+2
-3
@@ -6,12 +6,11 @@ import kotlinx.datetime.Clock
|
||||
import kotlinx.datetime.Instant
|
||||
|
||||
/**
|
||||
* One row per pending offline-write. Mirrors
|
||||
* the Flutter client's `CachedMutations` Drift table.
|
||||
* One row per pending offline write.
|
||||
*
|
||||
* MutationQueue.enqueue() inserts a row when a server-write fails with
|
||||
* an IOException; MutationReplayer.drain() pops and re-attempts each
|
||||
* row when connectivity returns (Phase 12.2).
|
||||
* row when connectivity returns.
|
||||
*
|
||||
* `kind` is a stable string registered in `MutationKind` — the replayer
|
||||
* looks up the handler in a kind→suspend-function map. Unknown kinds
|
||||
|
||||
Vendored
+1
-1
@@ -5,7 +5,7 @@ import androidx.room.PrimaryKey
|
||||
import kotlinx.datetime.Instant
|
||||
|
||||
/**
|
||||
* One notice from the user's inbox (M489), kept so the Notifications screen
|
||||
* One notice from the user's inbox, kept so the Notifications screen
|
||||
* and the bell's badge work offline, and so a read made offline shows at once.
|
||||
* The newest page is cached; older notices are the server's to keep.
|
||||
*/
|
||||
|
||||
+1
-1
@@ -4,7 +4,7 @@ import androidx.room.Entity
|
||||
import androidx.room.PrimaryKey
|
||||
|
||||
/**
|
||||
* Single-row copy of the user's notification settings (M489), stored as the
|
||||
* Single-row copy of the user's notification settings, stored as the
|
||||
* wire JSON, so the settings screen opens offline and a toggle shows at once.
|
||||
*/
|
||||
@Entity(tableName = "cached_notification_settings")
|
||||
|
||||
Vendored
+1
-2
@@ -6,8 +6,7 @@ import kotlinx.datetime.Clock
|
||||
import kotlinx.datetime.Instant
|
||||
|
||||
/**
|
||||
* Cache row for one playlist (user or system). Mirrors
|
||||
* the Flutter client's `CachedPlaylists` Drift table.
|
||||
* Cache row for one playlist (user or system).
|
||||
*
|
||||
* `systemVariant` is null for user playlists and one of
|
||||
* "for_you" / "songs_like_artist" / "discover" / "todays_mix" / etc.
|
||||
|
||||
Vendored
+1
-2
@@ -3,8 +3,7 @@ package com.fabledsword.minstrel.cache.db.entities
|
||||
import androidx.room.Entity
|
||||
|
||||
/**
|
||||
* Ordered membership of tracks within a playlist. Mirrors
|
||||
* the Flutter client's `CachedPlaylistTracks` Drift table.
|
||||
* Ordered membership of tracks within a playlist.
|
||||
* Composite PK so the same track can only appear once per playlist;
|
||||
* `position` carries the ordering.
|
||||
*/
|
||||
|
||||
Vendored
+1
-3
@@ -6,9 +6,7 @@ import kotlinx.datetime.Clock
|
||||
import kotlinx.datetime.Instant
|
||||
|
||||
/**
|
||||
* The current user's quarantine flag for one track. Mirrors
|
||||
* the Flutter client's `CachedQuarantineMine` Drift
|
||||
* table.
|
||||
* The current user's quarantine flag for one track.
|
||||
*
|
||||
* The flat denormalized track/album/artist columns let the Quarantine
|
||||
* screen render off this single table without a join — the server
|
||||
|
||||
Vendored
+4
-7
@@ -7,18 +7,15 @@ import kotlinx.datetime.Instant
|
||||
|
||||
/**
|
||||
* Single-row snapshot of the last playback session — queue (as JSON),
|
||||
* current index, position, and source tag. Mirrors
|
||||
* the Flutter client's `CachedResumeState` Drift table.
|
||||
* current index, position, and source tag.
|
||||
*
|
||||
* Lets a torn-down session (the player's idle/dismissed teardown)
|
||||
* resume on next launch; without it the headset / lock-screen play
|
||||
* button has nothing to act on. The Flutter codebase persists this on
|
||||
* every queue change and reads on cold start.
|
||||
* button has nothing to act on.
|
||||
*
|
||||
* The `json` field carries the entire ResumeState shape (queue trackrefs,
|
||||
* currentIndex, positionMs, sourceTag). Kotlin-side deserialization
|
||||
* happens in the ResumeController (Phase 6.5) so the schema stays
|
||||
* stable across resume-shape changes.
|
||||
* currentIndex, positionMs, sourceTag). The ResumeController decodes it,
|
||||
* so the schema stays stable across resume-shape changes.
|
||||
*/
|
||||
@Entity(tableName = "cached_resume_state")
|
||||
data class CachedResumeStateEntity(
|
||||
|
||||
+3
-4
@@ -6,10 +6,9 @@ import kotlinx.datetime.Clock
|
||||
import kotlinx.datetime.Instant
|
||||
|
||||
/**
|
||||
* Cache row for one track. Mirrors the Flutter client's
|
||||
* `CachedTracks` Drift table.
|
||||
* Cache row for one track.
|
||||
*
|
||||
* [missing] carries the server's missing-file mark (#2704). Every read that
|
||||
* [missing] carries the server's missing-file mark. Every read that
|
||||
* can put a track in front of the user — or in a queue — must exclude it, and
|
||||
* the DAO queries do that rather than each call site remembering to.
|
||||
*/
|
||||
@@ -26,7 +25,7 @@ data class CachedTrackEntity(
|
||||
val fileFormat: String? = null,
|
||||
val genre: String? = null,
|
||||
val missing: Boolean = false,
|
||||
// ReplayGain 2.0 track values (M464), kept so cached audio levels
|
||||
// ReplayGain 2.0 track values, kept so cached audio levels
|
||||
// offline. Null until the server has measured the track.
|
||||
val trackGain: Float? = null,
|
||||
val trackPeak: Float? = null,
|
||||
|
||||
Vendored
+2
-2
@@ -4,14 +4,14 @@ import androidx.room.Entity
|
||||
import androidx.room.PrimaryKey
|
||||
|
||||
/**
|
||||
* One buffered device-diagnostics event (M9). The DiagnosticsReporter
|
||||
* One buffered device-diagnostics event. The DiagnosticsReporter
|
||||
* writes rows here when the account's debug mode is on; the
|
||||
* DiagnosticsUploader drains them to POST /api/diagnostics and deletes
|
||||
* on success.
|
||||
*
|
||||
* This is a deliberate ring buffer that is NOT routed through the offline
|
||||
* MutationQueue: diagnostics are high-volume, best-effort telemetry, and
|
||||
* the bug we're chasing (roaming / dead-zone recovery) happens WHILE
|
||||
* the failures they record (roaming / dead-zone recovery) happen WHILE
|
||||
* offline — so events must persist locally through the dead zone and
|
||||
* upload on recovery, without clogging the user-data mutation replay.
|
||||
*
|
||||
|
||||
+2
-6
@@ -7,12 +7,8 @@ import kotlinx.datetime.Instant
|
||||
/**
|
||||
* Single-row table that tracks where the SyncController left off.
|
||||
*
|
||||
* Mirrors the Flutter Drift `sync_metadata` table. There is only ever
|
||||
* one row at `id = 0`; the SyncController upserts on every successful
|
||||
* `/api/sync` call.
|
||||
*
|
||||
* Pulled into Task 4.1 to give Room a compileable @Database (it needs
|
||||
* at least one entity); the SyncController itself lands in Phase 12.4.
|
||||
* There is only ever one row at `id = 0`; the SyncController upserts it
|
||||
* on every successful `/api/library/sync` call.
|
||||
*/
|
||||
@Entity(tableName = "sync_metadata")
|
||||
data class SyncMetadataEntity(
|
||||
|
||||
+18
-22
@@ -33,30 +33,29 @@ object MutationKind {
|
||||
|
||||
// Durable close-by-id for a play whose server row is already open
|
||||
// (play_started succeeded). Distinct from PLAY_OFFLINE, which records
|
||||
// a *whole* play when no server row exists. Using close-by-id on
|
||||
// background avoids the duplicate + orphan row the old offline-on-stop
|
||||
// path produced (see 2026-06-11 contract audit).
|
||||
// a *whole* play when no server row exists. Recording a whole play on
|
||||
// background would duplicate the open row and leave it orphaned.
|
||||
const val PLAY_ENDED: String = "play_ended"
|
||||
|
||||
// #2374 suggestion snooze. ONE toggle kind rather than separate
|
||||
// Suggestion snooze. ONE toggle kind rather than separate
|
||||
// snooze/unsnooze kinds, mirroring LIKE_TOGGLE, so a snooze followed by
|
||||
// an undo collapses to the latest intent instead of replaying as two
|
||||
// opposed calls whose order decides the outcome.
|
||||
const val SUGGESTION_SNOOZE_TOGGLE: String = "suggestion_snooze_toggle"
|
||||
|
||||
// M464 #4998 loudness-normalization preference. The payload is the whole
|
||||
// Loudness-normalization preference. The payload is the whole
|
||||
// preference, a target state like the toggles above, so queued changes
|
||||
// collapse to the last one and an older one can never be replayed last.
|
||||
const val NORMALIZATION_SET: String = "normalization_set"
|
||||
|
||||
// M489 notifications inbox. A read is a one-way action (read never goes
|
||||
// Notifications inbox. A read is a one-way action (read never goes
|
||||
// back to unread), so neither read kind needs collapsing. Read-all
|
||||
// carries the moment the user asked, so a late replay leaves newer
|
||||
// notices unread.
|
||||
const val NOTIFICATION_READ: String = "notification_read"
|
||||
const val NOTIFICATIONS_READ_ALL: String = "notifications_read_all"
|
||||
|
||||
// M489 per-kind channel setting. One row per (kind, channel) target
|
||||
// Per-kind notification channel. One row per (kind, channel) target
|
||||
// state, collapsed on that pair, so the newest choice is the one sent.
|
||||
const val NOTIFICATION_SETTING_SET: String = "notification_setting_set"
|
||||
}
|
||||
@@ -92,16 +91,13 @@ data class RequestCreatePayload(
|
||||
)
|
||||
|
||||
/**
|
||||
* Minimal write-side of the offline mutation queue. Phase 8 v1 only
|
||||
* enqueues — the connectivity-aware replayer that drains the queue
|
||||
* lands with Phase 12.2's SyncController.
|
||||
* Write side of the offline mutation queue; [MutationReplayer] drains it.
|
||||
*
|
||||
* Callers (LikesRepository et al.) follow the optimistic-write
|
||||
* pattern: mutate Room first so the UI reflects the change
|
||||
* immediately, fire the REST call as a best-effort attempt, and on
|
||||
* failure enqueue here so the replayer eventually pushes it through.
|
||||
* This matches `feedback_offline_first_for_server_writes` — writes
|
||||
* never go fire-and-forget.
|
||||
* Writes never go fire-and-forget.
|
||||
*/
|
||||
@Suppress("TooManyFunctions") // one enqueue per mutation kind, like the replayer's dispatchers
|
||||
@Singleton
|
||||
@@ -262,7 +258,7 @@ class MutationQueue @Inject constructor(
|
||||
}
|
||||
|
||||
/**
|
||||
* Persisted payload for `MutationKind.SUGGESTION_SNOOZE_TOGGLE` (#2374).
|
||||
* Persisted payload for `MutationKind.SUGGESTION_SNOOZE_TOGGLE`.
|
||||
* `desiredSnoozed` is the *target* state, matching [LikeTogglePayload], so
|
||||
* the replayer can collapse repeated toggles for one candidate down to the
|
||||
* last intent. Both directions are idempotent server-side: re-snoozing
|
||||
@@ -285,10 +281,10 @@ data class SuggestionSnoozeTogglePayload(
|
||||
data class QuarantineUnflagPayload(val trackId: String)
|
||||
|
||||
/**
|
||||
* Persisted payload for `MutationKind.PLAYLIST_APPEND`. Mirrors the
|
||||
* Flutter wire shape: list of track IDs to append to a specific
|
||||
* playlist. Server is idempotent at the (playlist_id, track_id) pair
|
||||
* level — re-firing the same payload yields no duplicates.
|
||||
* Persisted payload for `MutationKind.PLAYLIST_APPEND`: the track IDs to
|
||||
* append to one playlist. The server is idempotent at the
|
||||
* (playlist_id, track_id) pair level — re-firing the same payload yields
|
||||
* no duplicates.
|
||||
*/
|
||||
@Serializable
|
||||
data class PlaylistAppendPayload(
|
||||
@@ -314,7 +310,7 @@ data class QuarantineFlagPayload(
|
||||
* re-fires `POST /api/events` with type=play_offline; the server
|
||||
* records start+end from `atIso` (the original play-start time)
|
||||
* + `durationPlayedMs`, applies the canonical skip rule, and
|
||||
* advances #415 rotation when source is a system playlist.
|
||||
* advances rotation when source is a system playlist.
|
||||
*/
|
||||
@Serializable
|
||||
data class PlayOfflinePayload(
|
||||
@@ -323,7 +319,7 @@ data class PlayOfflinePayload(
|
||||
val atIso: String,
|
||||
val durationPlayedMs: Long,
|
||||
val source: String? = null,
|
||||
// #1551: device class for context conditioning; null on payloads queued
|
||||
// Device class for context conditioning; null on payloads queued
|
||||
// before this field existed (decodes to null → server stores NULL).
|
||||
val deviceClass: String? = null,
|
||||
)
|
||||
@@ -367,12 +363,12 @@ data class PlaybackErrorReportPayload(
|
||||
val clientId: String,
|
||||
)
|
||||
|
||||
/** Persisted payload for `MutationKind.NOTIFICATION_READ` (M489). */
|
||||
/** Persisted payload for `MutationKind.NOTIFICATION_READ`. */
|
||||
@Serializable
|
||||
data class NotificationReadPayload(val id: String)
|
||||
|
||||
/**
|
||||
* Persisted payload for `MutationKind.NOTIFICATIONS_READ_ALL` (M489).
|
||||
* Persisted payload for `MutationKind.NOTIFICATIONS_READ_ALL`.
|
||||
* `upToIso` is the newest notice the user could see when they asked; null
|
||||
* when the inbox was empty on the device, which marks everything.
|
||||
*/
|
||||
@@ -380,7 +376,7 @@ data class NotificationReadPayload(val id: String)
|
||||
data class NotificationsReadAllPayload(val upToIso: String?)
|
||||
|
||||
/**
|
||||
* Persisted payload for `MutationKind.NOTIFICATION_SETTING_SET` (M489): one
|
||||
* Persisted payload for `MutationKind.NOTIFICATION_SETTING_SET`: one
|
||||
* kind's one channel, as a target state. `channel` is "inbox" | "phone" |
|
||||
* "email". No defaults, so every field is always written.
|
||||
*/
|
||||
|
||||
+4
-4
@@ -160,7 +160,7 @@ class MutationReplayer @Inject constructor(
|
||||
/**
|
||||
* Returns the outcome of replaying one row. SENT on a 2xx; DROP for an
|
||||
* unknown kind/variant. Network / HTTP failures THROW and are classified
|
||||
* by [outcomeFor] — dispatchers no longer swallow.
|
||||
* by [outcomeFor] — dispatchers never swallow them.
|
||||
*/
|
||||
private suspend fun dispatch(row: CachedMutationEntity): Outcome = when (row.kind) {
|
||||
MutationKind.LIKE_TOGGLE -> dispatchLikeToggle(row.payload)
|
||||
@@ -182,7 +182,7 @@ class MutationReplayer @Inject constructor(
|
||||
else -> Outcome.DROP
|
||||
}
|
||||
|
||||
/** The notifications inbox's kinds (M489), split out to keep [dispatch] simple. */
|
||||
/** The notifications inbox's kinds, split out to keep [dispatch] simple. */
|
||||
private suspend fun dispatchNotification(row: CachedMutationEntity): Outcome = when (row.kind) {
|
||||
MutationKind.NOTIFICATION_READ -> dispatchNotificationRead(row.payload)
|
||||
MutationKind.NOTIFICATIONS_READ_ALL -> dispatchNotificationsReadAll(row.payload)
|
||||
@@ -354,8 +354,8 @@ class MutationReplayer @Inject constructor(
|
||||
/**
|
||||
* Row ids of desired-state toggles superseded by a later toggle for the same
|
||||
* entity. Applies to every kind whose payload encodes a TARGET state rather
|
||||
* than an action — like-toggles, suggestion snoozes (#2374) and the
|
||||
* normalization preference (#4998) — because
|
||||
* than an action — like-toggles, suggestion snoozes and the
|
||||
* normalization preference — because
|
||||
* replaying a stale one last would invert the final state.
|
||||
*
|
||||
* Top-level and pure so it can be unit-tested without standing up a Retrofit
|
||||
|
||||
+11
-13
@@ -34,9 +34,8 @@ import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* Drives the delta sync against `/api/library/sync` (#357). Mirrors
|
||||
* the Flutter `SyncController`, scoped to the entity types the
|
||||
* native client cares about (artist/album/track). Likes and
|
||||
* Drives the delta sync against `/api/library/sync`, scoped to the
|
||||
* entity types the app caches (artist/album/track). Likes and
|
||||
* playlists get their own dedicated refresh paths so the sync
|
||||
* controller doesn't need to track them.
|
||||
*
|
||||
@@ -46,10 +45,9 @@ import javax.inject.Singleton
|
||||
* with a persisted cookie). Re-running on every cookie change is
|
||||
* what makes the Library tabs populate within seconds of sign-in.
|
||||
*
|
||||
* Wipes-on-410: when the server's compaction window has passed the
|
||||
* stored cursor, the response is 410 Gone. The controller drops the
|
||||
* three local caches and recurses with cursor=0 — same wipe behavior
|
||||
* as the Flutter port.
|
||||
* Restart-on-410: when the server's compaction window has passed the
|
||||
* stored cursor, the response is 410 Gone. The controller resets the
|
||||
* cursor to 0 and pulls the full entity set again (see [resetCursor]).
|
||||
*/
|
||||
@Singleton
|
||||
class SyncController @Inject constructor(
|
||||
@@ -110,11 +108,11 @@ class SyncController @Inject constructor(
|
||||
}
|
||||
|
||||
/**
|
||||
* Pulls pages until the server has nothing newer (#5654). The server
|
||||
* returns at most 1000 changes a call; taking one page per trigger left
|
||||
* the cache behind a change log that a full re-read grows by ~26,000
|
||||
* rows, so merge deletes never arrived and the freshness sweep kept
|
||||
* asking for tracks that were gone. The cursor is stored after each
|
||||
* Pulls pages until the server has nothing newer. The server returns
|
||||
* at most 1000 changes a call, and a full library re-read adds tens
|
||||
* of thousands, so one page per trigger would leave the cache behind:
|
||||
* merge deletes would never arrive and the freshness sweep would keep
|
||||
* asking for tracks that are gone. The cursor is stored after each
|
||||
* page, so an interrupted pass resumes where it stopped.
|
||||
*/
|
||||
private suspend fun sync() {
|
||||
@@ -153,7 +151,7 @@ class SyncController @Inject constructor(
|
||||
body.cursor > cursor
|
||||
}
|
||||
else -> {
|
||||
// Unhandled status — treat as a no-op for v1; the next
|
||||
// Unhandled status — treat as a no-op; the next
|
||||
// app start retries from the same cursor.
|
||||
false
|
||||
}
|
||||
|
||||
+29
@@ -74,6 +74,35 @@ class ConnectivityObserver @Inject constructor(
|
||||
awaitClose { cm.unregisterNetworkCallback(callback) }
|
||||
}.distinctUntilChanged()
|
||||
|
||||
/**
|
||||
* Whether the network the device is using now is unmetered: Wi-Fi or
|
||||
* Ethernet, but not mobile data or a hotspot Android marks metered.
|
||||
* Downloads the user did not start (the liked-song downloads) wait for
|
||||
* this.
|
||||
*/
|
||||
val unmetered: Flow<Boolean> = callbackFlow {
|
||||
val callback = object : ConnectivityManager.NetworkCallback() {
|
||||
override fun onCapabilitiesChanged(
|
||||
network: Network,
|
||||
capabilities: NetworkCapabilities,
|
||||
) {
|
||||
trySend(capabilities.hasCapability(NetworkCapabilities.NET_CAPABILITY_NOT_METERED))
|
||||
}
|
||||
override fun onLost(network: Network) {
|
||||
trySend(false)
|
||||
}
|
||||
}
|
||||
cm.registerDefaultNetworkCallback(callback)
|
||||
trySend(isActiveNetworkUnmetered())
|
||||
awaitClose { cm.unregisterNetworkCallback(callback) }
|
||||
}.distinctUntilChanged()
|
||||
|
||||
private fun isActiveNetworkUnmetered(): Boolean {
|
||||
val caps = cm.activeNetwork?.let { cm.getNetworkCapabilities(it) }
|
||||
return caps != null &&
|
||||
caps.hasCapability(NetworkCapabilities.NET_CAPABILITY_NOT_METERED)
|
||||
}
|
||||
|
||||
private fun hasActiveNetwork(): Boolean {
|
||||
val caps = cm.activeNetwork?.let { cm.getNetworkCapabilities(it) }
|
||||
return caps != null &&
|
||||
|
||||
+12
-14
@@ -29,27 +29,25 @@ private const val POLL_DEGRADED_MS = 20_000L
|
||||
private const val ARBITRATE_MIN_GAP_MS = 2_000L
|
||||
|
||||
/**
|
||||
* THE single authority on network/server reachability. Absorbs the former
|
||||
* VersionCheckController (the /healthz poll + version parsing) and
|
||||
* ServerHealthController (the tri-state derive) into one signal-driven unit so
|
||||
* the app has one place that answers "can we reach Minstrel?" — not three
|
||||
* half-systems reporting differently.
|
||||
* THE single authority on network/server reachability: the /healthz poll,
|
||||
* version parsing and the tri-state health derive live in one
|
||||
* signal-driven unit, so the app has one place that answers "can we reach
|
||||
* Minstrel?".
|
||||
*
|
||||
* Inputs (all funnel through a single-consumer intent channel for thread
|
||||
* safety — [reportSuccess]/[reportFailure] are called from the audio read path
|
||||
* and OkHttp threads):
|
||||
* - device link transitions ([ConnectivityObserver]); link-return triggers an
|
||||
* immediate probe so recovery is near-instant (fixes the sticky banner).
|
||||
* immediate probe so recovery is near-instant.
|
||||
* - periodic /healthz probe, adaptive cadence (calm when Healthy, fast when down).
|
||||
* - reportSuccess / reportFailure from the API interceptor, the audio data
|
||||
* source, and the playback-error reporter.
|
||||
* - recheck() from pull-to-refresh and the banner.
|
||||
* - a forced probe when the app returns to the foreground (#1209). Without
|
||||
* it a stale ServerDown outlived the condition that caused it: the poll
|
||||
* loop's delay() is throttled while screen-off/doze, so recovery waited on
|
||||
* whenever the OS next let the loop run. Meanwhile ServerDown makes
|
||||
* OfflineGatedDataSource refuse every uncached track, so the app declined
|
||||
* to play music that would have played fine.
|
||||
* - a forced probe when the app returns to the foreground. The poll
|
||||
* loop's delay() is throttled while screen-off/doze, so without it a
|
||||
* stale ServerDown would outlive its cause until the OS next let the
|
||||
* loop run — and ServerDown makes OfflineGatedDataSource refuse every
|
||||
* uncached track, declining music that would play fine.
|
||||
*
|
||||
* Version compatibility is a byproduct of the same /healthz response.
|
||||
*
|
||||
@@ -112,7 +110,7 @@ class NetworkStatusController @Inject constructor(
|
||||
|
||||
/**
|
||||
* App returned to the foreground — probe now rather than waiting for the
|
||||
* poll loop (#1209).
|
||||
* poll loop.
|
||||
*
|
||||
* The link-return probe in `init` does NOT cover this: it fires on a
|
||||
* connectivity *change*, and an app backgrounded on stable Wi-Fi sees none.
|
||||
@@ -172,7 +170,7 @@ class NetworkStatusController @Inject constructor(
|
||||
|
||||
private suspend fun probeOnce(force: Boolean = false) {
|
||||
// Startup guard: don't poll the localhost placeholder before AuthStore
|
||||
// hydrates the real base URL — that false failure used to flash the banner.
|
||||
// hydrates the real base URL — that false failure would flash the banner.
|
||||
if (authStore.baseUrl.value == AuthStore.DEFAULT_BASE_URL) return
|
||||
val now = System.currentTimeMillis()
|
||||
if (!force && now - lastProbeAtMs.get() < ARBITRATE_MIN_GAP_MS) return
|
||||
|
||||
+5
-6
@@ -5,15 +5,14 @@ internal const val CORROBORATION_WINDOW_MS = 30_000L
|
||||
internal const val CORROBORATION_OP_THRESHOLD = 2
|
||||
|
||||
/**
|
||||
* Minimum gap between op failures for them to count as SEPARATE evidence
|
||||
* (#1209).
|
||||
* Minimum gap between op failures for them to count as SEPARATE evidence.
|
||||
*
|
||||
* A link handoff fails every in-flight request at once, so a burst is one
|
||||
* event producing N failures — not N independent observations that the server
|
||||
* is gone. Without this, two simultaneous failures corroborated each other
|
||||
* straight to Unreachable, and ServerDown makes OfflineGatedDataSource refuse
|
||||
* every uncached track. The app declined to play music that would have played
|
||||
* fine, for a blip that had already resolved.
|
||||
* is gone. Counted separately, two simultaneous failures would corroborate
|
||||
* each other straight to Unreachable, and ServerDown makes
|
||||
* OfflineGatedDataSource refuse every uncached track: the app would decline
|
||||
* music that plays fine, for a blip that had already resolved.
|
||||
*
|
||||
* 3s is comfortably above the sub-second window an OS handoff occupies while
|
||||
* still letting a genuine outage corroborate within seconds once a client
|
||||
|
||||
+6
-8
@@ -38,7 +38,7 @@ import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* On-device diagnostics collector (M9). Active only while the account's
|
||||
* On-device diagnostics collector. Active only while the account's
|
||||
* debug mode is enabled (server flag, read via AuthController.currentUser)
|
||||
* AND the user hasn't opted out locally. When active it taps existing
|
||||
* connectivity / player / UPnP / power seams READ-ONLY and writes a
|
||||
@@ -196,13 +196,11 @@ class DiagnosticsReporter @Inject constructor(
|
||||
/**
|
||||
* Catch the renderer rapidly leaving and re-entering PLAYING.
|
||||
*
|
||||
* The operator reports the Sonos "play pause play pause, like someone
|
||||
* pressing it every half second", usually as a track starts, cleared by a
|
||||
* manual pause or skip. Nothing here could see that: `player_state`
|
||||
* carries source/loading/error but not playing, `track_change` needs the
|
||||
* index to move, and the heartbeat samples once per 45s. The symptom fell
|
||||
* through every existing collector, which is why it has only ever been
|
||||
* described and never measured.
|
||||
* The symptom: a Sonos rapidly play-pause-play-pausing, about every half
|
||||
* second, usually as a track starts, cleared by a manual pause or skip.
|
||||
* No other collector sees it: `player_state` carries
|
||||
* source/loading/error but not playing, `track_change` needs the index
|
||||
* to move, and the heartbeat samples once per 45s.
|
||||
*
|
||||
* Records every raw transport change (cheap — steady playback produces
|
||||
* a couple per track) and, when they come in a burst, one summary event
|
||||
|
||||
+1
-1
@@ -27,7 +27,7 @@ import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* Drains the [DiagnosticEventDao] ring buffer to POST /api/diagnostics
|
||||
* (M9). Triggers mirror [com.fabledsword.minstrel.cache.mutations.MutationReplayer]:
|
||||
*. Triggers mirror [com.fabledsword.minstrel.cache.mutations.MutationReplayer]:
|
||||
* a periodic tick, a sign-in (sessionCookie non-null), and a server-health
|
||||
* recovery to [ServerHealth.Healthy] — so a dead-zone's buffered events
|
||||
* upload the moment the link comes back.
|
||||
|
||||
+3
-4
@@ -6,10 +6,9 @@ import com.fabledsword.minstrel.player.TransportObservation
|
||||
* Decides when a run of renderer transport changes is a *flap* — the renderer
|
||||
* repeatedly failing to settle — rather than an ordinary track transition.
|
||||
*
|
||||
* The operator reports the Sonos "play pause play pause, like someone pressing
|
||||
* it every half second", usually as a track starts. No diagnostic event could
|
||||
* see it, so it has been described several times and measured never. This is
|
||||
* the rule that decides when an episode is worth writing down.
|
||||
* The symptom: a Sonos rapidly play-pause-play-pausing, about every half
|
||||
* second, usually as a track starts. No other diagnostic event records it;
|
||||
* this is the rule that decides when an episode is worth writing down.
|
||||
*
|
||||
* Pure decision state, like [com.fabledsword.minstrel.player.RemoteStallWatchdog]:
|
||||
* the caller owns the flow and the recording, this only answers "is this an
|
||||
|
||||
+5
-10
@@ -29,16 +29,11 @@ enum class RequestOutcome { ACCEPTED, QUEUED }
|
||||
|
||||
/**
|
||||
* Read-through Discover surface: catalogue search, suggestion feed, and
|
||||
* the request-creation write path. Mirrors the Flutter
|
||||
* `DiscoverApi` + `mutationQueueProvider` integration —
|
||||
* `feedback_offline_first_for_server_writes` says writes never go
|
||||
* fire-and-forget, so `createRequest` falls back to the
|
||||
* MutationQueue on transport failure.
|
||||
* the request-creation write path. Writes never go fire-and-forget, so
|
||||
* `createRequest` falls back to the MutationQueue on transport failure.
|
||||
*
|
||||
* Reads are not cached locally yet — discovery results are inherently
|
||||
* transient (60s server-side LRU); the cache wins are minor and
|
||||
* unblock no UX. Phase 13's offline pass adds an offline scrollback
|
||||
* for the suggestion feed only.
|
||||
* Reads are not cached locally — discovery results are inherently
|
||||
* transient (60s server-side LRU), so a local cache would win little.
|
||||
*/
|
||||
@Singleton
|
||||
class DiscoverRepository @Inject constructor(
|
||||
@@ -54,7 +49,7 @@ class DiscoverRepository @Inject constructor(
|
||||
api.listSnoozes().map { it.toDomain() }
|
||||
|
||||
/**
|
||||
* Parks a suggestion ("not right now"). Offline-first per rule #100: on
|
||||
* Parks a suggestion ("not right now"). Offline-first: on
|
||||
* transport failure the target state is queued for the replayer rather
|
||||
* than dropped.
|
||||
*
|
||||
|
||||
@@ -195,8 +195,8 @@ private fun KindChips(kind: RequestKind, onChange: (RequestKind) -> Unit) {
|
||||
|
||||
/**
|
||||
* The snooze surface's data and callbacks, bundled rather than threaded
|
||||
* through as four more parameters — the pane grew from one action to three
|
||||
* with slice 4 and the signatures stopped being readable.
|
||||
* through as separate parameters: the pane carries three actions, and the
|
||||
* signatures stop being readable otherwise.
|
||||
*/
|
||||
private data class SnoozeUi(
|
||||
val locallySnoozedMbids: Set<String>,
|
||||
@@ -240,9 +240,9 @@ private fun SuggestionsList(
|
||||
) {
|
||||
item { SuggestionsHeader() }
|
||||
if (items.isEmpty()) {
|
||||
// An empty deck used to mean one thing — no listening signal yet.
|
||||
// With snoozing it can also mean "you parked them all", and telling
|
||||
// that user to go listen to something would be wrong advice.
|
||||
// An empty deck means one of two things — no listening signal yet,
|
||||
// or "you parked them all" — and telling the second user to go
|
||||
// listen to something would be wrong advice.
|
||||
item {
|
||||
CenteredMessage(
|
||||
if (snoozeUi.snoozes.isEmpty()) {
|
||||
|
||||
@@ -79,8 +79,8 @@ internal fun SuggestionTile(
|
||||
IconButton(onClick = onSnooze) {
|
||||
Icon(
|
||||
imageVector = Lucide.Clock,
|
||||
// Rule #101: the label states what happens, and passes no
|
||||
// judgement on the music. Never "not for me".
|
||||
// The label states what happens and passes no judgement on the
|
||||
// music: never "not for me".
|
||||
contentDescription = "Not right now — hide ${s.name} for a while",
|
||||
tint = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
@@ -173,7 +173,7 @@ private fun Avatar(imageUrl: String, fallback: ImageVector, circular: Boolean) {
|
||||
.background(MaterialTheme.colorScheme.surfaceVariant),
|
||||
contentAlignment = Alignment.Center,
|
||||
) {
|
||||
// The server hands back its own art endpoint (relative, M502 #5519),
|
||||
// The server hands back its own art endpoint (relative),
|
||||
// which answers 404 when no source has an image: ServerImage resolves
|
||||
// the path and shows the icon while loading and on a miss.
|
||||
ServerImage(
|
||||
|
||||
@@ -68,7 +68,7 @@ class DiscoverViewModel @Inject constructor(
|
||||
|
||||
init {
|
||||
loadSuggestions()
|
||||
// Screen-level auto-recovery (issue #1245): re-run whichever pane
|
||||
// Screen-level auto-recovery: re-run whichever pane
|
||||
// failed while the server was unreachable once health returns.
|
||||
viewModelScope.launch {
|
||||
networkStatus.recoveries().collect {
|
||||
|
||||
@@ -54,7 +54,7 @@ private const val EVENTS_BUFFER_CAPACITY = 64
|
||||
* retry. Without this a single blip silently kills cross-device
|
||||
* reactivity until the next app launch.
|
||||
* - [connected] says whether a stream is open. Background delivery
|
||||
* (M489 #5347) catches up on every rising edge: nothing replays a
|
||||
* catches up on every rising edge: nothing replays a
|
||||
* frame sent while the stream was down.
|
||||
*
|
||||
* The URL passes through the placeholder host that
|
||||
|
||||
@@ -4,8 +4,7 @@ import kotlinx.serialization.Serializable
|
||||
import kotlinx.serialization.json.JsonObject
|
||||
|
||||
/**
|
||||
* Parsed event from the server's SSE stream. Mirrors
|
||||
* the Flutter client's `LiveEvent`.
|
||||
* Parsed event from the server's SSE stream.
|
||||
*
|
||||
* - [kind] is the SSE `event:` field (e.g. "track.liked", "playlist.deleted").
|
||||
* - [userId] is the actor whose user-scoped state changed (empty for
|
||||
|
||||
@@ -51,7 +51,7 @@ class LiveEventsDispatcher @Inject constructor(
|
||||
"artist.liked",
|
||||
"artist.unliked",
|
||||
-> refreshLikes()
|
||||
// M489: a contentless nudge; the inbox refetches its newest page.
|
||||
// a contentless nudge; the inbox refetches its newest page.
|
||||
"notification.created" -> refreshNotifications()
|
||||
}
|
||||
// Other kinds (playlist.*, quarantine.*, request.status_changed,
|
||||
|
||||
@@ -3,14 +3,14 @@ package com.fabledsword.minstrel.events
|
||||
import kotlin.random.Random
|
||||
|
||||
/**
|
||||
* How long [EventsStream] waits before reconnecting (M489 #5347).
|
||||
* How long [EventsStream] waits before reconnecting.
|
||||
*
|
||||
* The stream is wanted around the clock once notifications arrive with the app
|
||||
* closed, so a server that is down overnight must not cost a radio wakeup
|
||||
* every few seconds: Roundtable's flat 2s came to about 43,000 of them. The
|
||||
* wait doubles from [BASE_MS] to [MAX_MS]. The jitter spreads the moment every
|
||||
* phone on the server reconnects, which is when the server has just come back
|
||||
* and can least take a spike.
|
||||
* every few seconds: a flat 2s retry is 1,800 wakeups an hour. The wait
|
||||
* doubles from [BASE_MS] to [MAX_MS]. The jitter spreads the moment every
|
||||
* phone on the server reconnects, which is when the server has just come
|
||||
* back and can least take a spike.
|
||||
*
|
||||
* A network coming up (a hint, never a gate) or the app coming to the
|
||||
* foreground reconnects at once and starts the ladder over.
|
||||
|
||||
+3
-5
@@ -33,9 +33,7 @@ data class HistoryPage(
|
||||
)
|
||||
|
||||
/**
|
||||
* Cache-first listening history. Mirrors Flutter's `_historyProvider`
|
||||
* (`cacheFirst` over the `cached_history_snapshot` drift row with
|
||||
* `alwaysRefresh`) using the native Room + Flow idiom:
|
||||
* Cache-first listening history, in the Room + Flow idiom:
|
||||
*
|
||||
* - [observeHistory] emits the cached snapshot instantly (null until
|
||||
* the first fetch lands), so the History tab paints from disk on
|
||||
@@ -47,8 +45,8 @@ data class HistoryPage(
|
||||
*
|
||||
* The whole page is stored as one JSON blob (single-row table) rather
|
||||
* than per-row Room entities — history is a read-only timestamp-keyed
|
||||
* snapshot, so a blob is the simplest faithful mirror of the Drift
|
||||
* snapshot and avoids ordering/paging bookkeeping for no UX gain.
|
||||
* snapshot, so a blob is the simplest faithful copy and avoids
|
||||
* ordering/paging bookkeeping for no UX gain.
|
||||
*/
|
||||
@Singleton
|
||||
class HistoryRepository @Inject constructor(
|
||||
|
||||
@@ -86,7 +86,7 @@ class HistoryTabViewModel @Inject constructor(
|
||||
|
||||
init {
|
||||
refresh()
|
||||
// Screen-level auto-recovery (issue #1245): re-pull when server
|
||||
// Screen-level auto-recovery: re-pull when server
|
||||
// health returns, so a load that failed offline heals unprompted.
|
||||
viewModelScope.launch {
|
||||
networkStatus.recoveries().collect { refresh() }
|
||||
@@ -99,7 +99,7 @@ class HistoryTabViewModel @Inject constructor(
|
||||
.onFailure { refreshError.value = ErrorCopy.fromThrowable(it) }
|
||||
}
|
||||
|
||||
/** Single-track play, matching the Flutter history-row behavior. */
|
||||
/** Plays the tapped track on its own. */
|
||||
fun playTrack(track: TrackRef) {
|
||||
if (track.streamUrl.isEmpty()) return
|
||||
player.setQueue(listOf(track), initialIndex = 0, source = "history")
|
||||
|
||||
@@ -33,8 +33,7 @@ import javax.inject.Singleton
|
||||
* [MetadataProvider] Flow that emits the cached row (or null while it
|
||||
* hydrates) and fires a dedup'd, concurrency-gated on-miss fetch. A
|
||||
* null [HomeTile.value] renders as a skeleton in position; the tile
|
||||
* reveals when the fetch lands and Room re-emits. Mirrors Flutter's
|
||||
* per-item tile providers.
|
||||
* reveals when the fetch lands and Room re-emits.
|
||||
*
|
||||
* `refreshIndex()` pulls `GET /api/home/index`, swaps all sections in
|
||||
* one transaction (so the rows update together in a single emission
|
||||
@@ -99,8 +98,8 @@ class HomeRepository @Inject constructor(
|
||||
* One transaction for all seven sections is deliberate: Room notifies
|
||||
* observers once, on commit, so Home swaps from the old content to
|
||||
* the new in a single emission. Per-section, un-transacted writes
|
||||
* made every row visibly collapse to empty and refill, one after
|
||||
* another (issue #2327).
|
||||
* would make every row visibly collapse to empty and refill, one
|
||||
* after another.
|
||||
*/
|
||||
suspend fun refreshIndex() {
|
||||
val wire = api.getHomeIndex()
|
||||
@@ -141,7 +140,7 @@ class HomeRepository @Inject constructor(
|
||||
* the id list instead means a section whose contents didn't actually
|
||||
* move never restarts the `flatMapLatest` below, which would
|
||||
* otherwise tear down and rebuild all of its tiles' hydration flows
|
||||
* and flicker unchanged tiles (issue #2327).
|
||||
* and flicker unchanged tiles.
|
||||
*/
|
||||
private fun observeSectionIds(section: String): Flow<List<String>> =
|
||||
homeIndexDao.observeBySection(section)
|
||||
|
||||
@@ -102,6 +102,8 @@ import com.fabledsword.minstrel.shared.widgets.PullToRefreshScaffold
|
||||
import com.fabledsword.minstrel.shared.widgets.SkeletonAlbumTile
|
||||
import com.fabledsword.minstrel.shared.widgets.SkeletonArtistTile
|
||||
import com.fabledsword.minstrel.shared.widgets.SkeletonSectionHeader
|
||||
import com.fabledsword.minstrel.update.ui.UpdateNotices
|
||||
import com.fabledsword.minstrel.update.ui.UpdateViewModel
|
||||
import dagger.hilt.android.lifecycle.HiltViewModel
|
||||
import kotlinx.coroutines.async
|
||||
import kotlinx.coroutines.channels.Channel
|
||||
@@ -133,7 +135,7 @@ private const val RECENTLY_ADDED_GRID_HEIGHT_DP = 440
|
||||
// "Updating your mixes…" veil. UpdateVeilController decides both whether it
|
||||
// appears at all — only when a refresh actually changes something — and how
|
||||
// long it stays, by watching the screen settle rather than by a fixed delay,
|
||||
// which lowered it while tiles and artwork were still landing (#2327).
|
||||
// which would lower it while tiles and artwork are still landing.
|
||||
// Near-opaque (VEIL_ALPHA) so the section churn never bleeds through.
|
||||
private const val VEIL_WIPE_MS = 280
|
||||
private const val VEIL_ALPHA = 0.96f
|
||||
@@ -244,9 +246,8 @@ class HomeViewModel @Inject constructor(
|
||||
|
||||
/**
|
||||
* Tap on a Most-played tile: replace the queue with the section's
|
||||
* tracks and start at the tapped index. Mirrors Flutter's
|
||||
* `_resolveSectionTracks` — Home's section is itself the playable
|
||||
* unit, not a list of album-detail links.
|
||||
* tracks and start at the tapped index. Home's section is itself the
|
||||
* playable unit, not a list of album-detail links.
|
||||
*/
|
||||
fun playMostPlayed(tracks: List<com.fabledsword.minstrel.models.TrackRef>, startIndex: Int) {
|
||||
if (tracks.isEmpty()) return
|
||||
@@ -259,13 +260,11 @@ class HomeViewModel @Inject constructor(
|
||||
|
||||
/**
|
||||
* Tap the album play-button overlay: fetch the album detail and
|
||||
* play its tracks from the first. Mirrors Flutter's AlbumCard
|
||||
* `_playAlbum`. Suspending so the button's spinner waits for the
|
||||
* fetch + queue setup; the inner work is launched in viewModelScope
|
||||
* so cancellation from leaving the screen mid-fetch doesn't kill
|
||||
* playback. Errors surface via the snackbar channel (Android
|
||||
* improvement over Flutter's silent-fail; matches the existing
|
||||
* ArtistDetail play handler).
|
||||
* play its tracks from the first. Suspending so the button's spinner
|
||||
* waits for the fetch + queue setup; the inner work is launched in
|
||||
* viewModelScope so cancellation from leaving the screen mid-fetch
|
||||
* doesn't kill playback. Errors surface via the snackbar channel,
|
||||
* like the ArtistDetail play handler.
|
||||
*/
|
||||
suspend fun playAlbum(albumId: String) {
|
||||
viewModelScope.launch {
|
||||
@@ -288,9 +287,8 @@ class HomeViewModel @Inject constructor(
|
||||
|
||||
/**
|
||||
* Tap the artist play-button overlay: fetch every track across the
|
||||
* artist's albums, Fisher-Yates shuffle, play from index 0. Mirrors
|
||||
* Flutter's ArtistCard `_playArtistShuffle`. Empty + error semantics
|
||||
* follow [playAlbum].
|
||||
* artist's albums, Fisher-Yates shuffle, play from index 0. Empty +
|
||||
* error semantics follow [playAlbum].
|
||||
*/
|
||||
suspend fun playArtistShuffled(artistId: String) {
|
||||
viewModelScope.launch {
|
||||
@@ -315,9 +313,8 @@ class HomeViewModel @Inject constructor(
|
||||
* Tap the playlist play-button overlay: fetch the playlist's tracks
|
||||
* (rotation-aware shuffle for refreshable system playlists, stored
|
||||
* order for everything else), 8s timeout, play from index 0.
|
||||
* Mirrors Flutter PlaylistCard `_playPlaylist`. Empty-mix and
|
||||
* timeout get their own copy strings; other errors fall through to
|
||||
* [ErrorCopy.fromThrowable].
|
||||
* Empty-mix and timeout get their own copy strings; other errors
|
||||
* fall through to [ErrorCopy.fromThrowable].
|
||||
*/
|
||||
suspend fun playPlaylist(playlist: PlaylistRef) {
|
||||
viewModelScope.launch {
|
||||
@@ -366,9 +363,9 @@ class HomeViewModel @Inject constructor(
|
||||
fun retry() = veil.request(userInitiated = true)
|
||||
|
||||
/**
|
||||
* Manual pull-to-refresh. Goes behind the veil like every other refresh
|
||||
* (operator call, 2026-07-31: the churn a pull causes is identical to
|
||||
* the automatic paths, and a small spinner didn't hide it).
|
||||
* Manual pull-to-refresh. Goes behind the veil like every other
|
||||
* refresh: a pull churns the screen exactly as the automatic paths
|
||||
* do, and a small spinner does not hide it.
|
||||
*
|
||||
* Suspends until the veil has taken over OR the session has finished,
|
||||
* so the pull indicator hands off to exactly one successor: the veil if
|
||||
@@ -488,7 +485,7 @@ class HomeViewModel @Inject constructor(
|
||||
* Only user-initiated sessions say anything. The same outcome from a
|
||||
* background check — the initial load, the 03:00 rebuild, a reconnect —
|
||||
* is noise, and "Already up to date" on every launch would be worse
|
||||
* than silence (operator's call, 2026-07-31).
|
||||
* than silence.
|
||||
*/
|
||||
private fun reportRefreshOutcome(result: VeilSessionResult) {
|
||||
if (!result.userInitiated) return
|
||||
@@ -505,7 +502,7 @@ class HomeViewModel @Inject constructor(
|
||||
*
|
||||
* Raised only when a refresh actually changes what's on screen, and then
|
||||
* held until Home settles — tiles hydrated, artwork loaded — instead of
|
||||
* for a fixed delay after the network pull returns (issue #2327). A
|
||||
* for a fixed delay after the network pull returns. A
|
||||
* refresh that returns what's already cached shows no veil at all;
|
||||
* [reportRefreshOutcome] tells the user instead, if they asked.
|
||||
*/
|
||||
@@ -515,9 +512,9 @@ class HomeViewModel @Inject constructor(
|
||||
// Every refresh path goes through the controller, which decides
|
||||
// per session whether to raise the veil. That includes the initial
|
||||
// load: over a warm cache it's a full re-pull that churns every
|
||||
// section, and it used to run completely unveiled.
|
||||
// section.
|
||||
veil.request()
|
||||
// Screen-level auto-recovery (issue #1245): a Home that failed to
|
||||
// Screen-level auto-recovery: a Home that failed to
|
||||
// load while the server was unreachable re-pulls itself the moment
|
||||
// health returns — same idiom as SyncController, one layer up.
|
||||
// This is also the recovery that keeps trying after the veil has
|
||||
@@ -525,9 +522,8 @@ class HomeViewModel @Inject constructor(
|
||||
viewModelScope.launch {
|
||||
networkStatus.recoveries().collect { veil.request() }
|
||||
}
|
||||
// Server-side changes that rewrite what Home renders (#968 and
|
||||
// the 2026-07-31 widening) re-pull behind the veil. Mirrors the
|
||||
// web SSE consumer.
|
||||
// Server-side changes that rewrite what Home renders re-pull
|
||||
// behind the veil, as the web SSE consumer does.
|
||||
viewModelScope.launch {
|
||||
eventsStream.events
|
||||
.filter { it.kind in VEILED_EVENT_KINDS }
|
||||
@@ -559,6 +555,7 @@ class HomeViewModel @Inject constructor(
|
||||
fun HomeScreen(
|
||||
navController: NavHostController,
|
||||
viewModel: HomeViewModel = hiltViewModel(),
|
||||
updates: UpdateViewModel = hiltViewModel(),
|
||||
) {
|
||||
val snackbarHostState = remember { SnackbarHostState() }
|
||||
LaunchedEffect(Unit) {
|
||||
@@ -581,7 +578,11 @@ fun HomeScreen(
|
||||
val offline by viewModel.offline.collectAsStateWithLifecycle()
|
||||
val updating by viewModel.isUpdating.collectAsStateWithLifecycle()
|
||||
PullToRefreshScaffold(
|
||||
onRefresh = { viewModel.refreshFromPull() },
|
||||
onRefresh = {
|
||||
// A pull asks about a newer app too, so one shows up at once.
|
||||
updates.check()
|
||||
viewModel.refreshFromPull()
|
||||
},
|
||||
modifier = Modifier.fillMaxSize().padding(inner),
|
||||
) {
|
||||
Box(Modifier.fillMaxSize()) {
|
||||
@@ -596,6 +597,7 @@ fun HomeScreen(
|
||||
// hide behind an "Updating your mixes…" wipe that stays up
|
||||
// until the screen has actually stopped moving.
|
||||
UpdatingVeil(visible = updating)
|
||||
UpdateNotices(updates)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -758,8 +760,7 @@ private fun HomeSuccessContent(
|
||||
// Always rendered: real system/user playlists, with
|
||||
// placeholder cards filling the For You / Discover slots
|
||||
// that haven't generated yet. When offline, the cache-backed
|
||||
// pool cards lead the row. Songs-like now lives in its own
|
||||
// dedicated row below (#1491), no longer inside this carousel.
|
||||
// pool cards lead the row. Songs-like has its own row below.
|
||||
PlaylistsRow(
|
||||
title = "Playlists",
|
||||
rowItems = buildPlaylistsRow(sections.playlists, systemStatus, offline),
|
||||
@@ -769,10 +770,9 @@ private fun HomeSuccessContent(
|
||||
onPlayPlaylist = onPlayPlaylist,
|
||||
)
|
||||
}
|
||||
// Songs-like is the best-performing surface (#1491) — promoted out
|
||||
// of the Playlists carousel into its own row so it shows a wider
|
||||
// spread of "Songs like {artist}" mixes. Hidden when there's
|
||||
// nothing to show (offline with none cached).
|
||||
// Songs-like gets its own row so it can show a wider spread of
|
||||
// "Songs like {artist}" mixes than a carousel slot allows. Hidden
|
||||
// when there's nothing to show (offline with none cached).
|
||||
songsLikeSection(
|
||||
playlists = sections.playlists,
|
||||
status = systemStatus,
|
||||
@@ -805,11 +805,11 @@ private fun HomeSuccessContent(
|
||||
}
|
||||
|
||||
/**
|
||||
* The dedicated "Songs like…" row (#1491). Reuses [PlaylistsRow]'s card
|
||||
* The dedicated "Songs like…" row. Reuses [PlaylistsRow]'s card
|
||||
* rendering with a distinct title; hidden entirely when there's nothing
|
||||
* to show (offline with no cached mixes). Online with none generated yet
|
||||
* still shows a few placeholders so the building / seed-needed state is
|
||||
* visible, matching the pre-promotion carousel behavior.
|
||||
* visible.
|
||||
*/
|
||||
private fun LazyListScope.songsLikeSection(
|
||||
playlists: List<PlaylistRef>,
|
||||
@@ -1000,7 +1000,7 @@ private fun EmptySection(title: String, body: String) {
|
||||
/**
|
||||
* Rediscover may have both an albums sub-row and an artists sub-row. When
|
||||
* both are present the artist row gets an empty title so the section
|
||||
* reads as a single visual block — matches the Flutter behavior.
|
||||
* reads as a single visual block.
|
||||
*/
|
||||
@Composable
|
||||
private fun RediscoverBlock(
|
||||
@@ -1164,18 +1164,12 @@ enum class OfflinePoolKind(val label: String) {
|
||||
* placeholder otherwise), then the secondary system kinds (deep cuts /
|
||||
* rediscover / new for you / on this day / first listens) when they exist —
|
||||
* no placeholders for these since they're conditional on library shape — then
|
||||
* user-owned playlists. Songs-like has its own dedicated row (#1491) via
|
||||
* [buildSongsLikeRow] and no longer appears in this carousel.
|
||||
* user-owned playlists. Songs-like has its own row via [buildSongsLikeRow].
|
||||
*
|
||||
* Offline: the two cache-backed pools (Recently played, Liked) lead, then the
|
||||
* same real playlists in curated order but stably partitioned fully-cached
|
||||
* first / greyed after, and the "building/pending" placeholders are dropped
|
||||
* (they need the server to generate, so they're meaningless offline).
|
||||
*
|
||||
* Diverges from Flutter (the Flutter client
|
||||
* `_buildPlaylistsRow`) which only shows the 5 fixed slots and never
|
||||
* surfaces the secondary kinds on Home. Operator authorized the
|
||||
* divergence on 2026-06-01; web UI catch-up tracked as task #53.
|
||||
*/
|
||||
internal fun buildPlaylistsRow(
|
||||
owned: List<PlaylistRef>,
|
||||
@@ -1204,7 +1198,7 @@ private fun buildOnlineRow(
|
||||
out += owned.firstOrNull { it.systemVariant == "discover" }
|
||||
?.let { PlaylistRowItem.Real(it) }
|
||||
?: PlaylistRowItem.Placeholder("Discover", variantFor("discover", status))
|
||||
// Songs-like is no longer here — it has its own dedicated row (#1491).
|
||||
// Songs-like is not here: it has its own row.
|
||||
for (variant in SECONDARY_SYSTEM_VARIANTS) {
|
||||
owned.firstOrNull { it.systemVariant == variant }?.let { out += PlaylistRowItem.Real(it) }
|
||||
}
|
||||
@@ -1213,8 +1207,8 @@ private fun buildOnlineRow(
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds the dedicated Songs-like row (#1491): all "Songs like {artist}"
|
||||
* mixes the server generated, no longer capped to the 3 carousel slots.
|
||||
* Builds the dedicated Songs-like row: every "Songs like {artist}" mix
|
||||
* the server generated, uncapped.
|
||||
*
|
||||
* Online: every generated mix as a real card; when none exist yet, a few
|
||||
* placeholders so the building / seed-needed state stays visible.
|
||||
@@ -1244,7 +1238,7 @@ internal fun buildSongsLikeRow(
|
||||
* Must mirror [buildOnlineRow]'s slot order — the offline row reuses this and
|
||||
* only differs by dropping placeholders + partitioning available-first.
|
||||
* Songs-like is excluded here too — it renders in its own row via
|
||||
* [buildSongsLikeRow] in both online and offline modes (#1491).
|
||||
* [buildSongsLikeRow] in both online and offline modes.
|
||||
*/
|
||||
private fun orderedRealPlaylists(owned: List<PlaylistRef>): List<PlaylistRef> {
|
||||
val out = mutableListOf<PlaylistRef>()
|
||||
@@ -1266,7 +1260,7 @@ private fun variantFor(slot: String, s: SystemPlaylistsStatus): String = when {
|
||||
|
||||
// How many "Songs like…" placeholder cards the dedicated row shows while
|
||||
// the mixes haven't generated yet (building / seed-needed). Real mixes,
|
||||
// once generated, are shown in full and no longer capped by this (#1491).
|
||||
// once generated, are shown in full, uncapped.
|
||||
private const val SONGS_LIKE_PLACEHOLDER_SLOTS = 3
|
||||
|
||||
/**
|
||||
@@ -1308,8 +1302,7 @@ private fun ArtistsRow(
|
||||
/**
|
||||
* Most-played section. Renders compact track tiles (cover + title + artist).
|
||||
* Tapping a tile replaces the queue with the entire section starting
|
||||
* at that tile — mirrors Flutter's `_resolveSectionTracks` behaviour
|
||||
* where Home sections are themselves playable units.
|
||||
* at that tile — Home sections are themselves playable units.
|
||||
*/
|
||||
@Composable
|
||||
private fun MostPlayedRow(
|
||||
@@ -1373,12 +1366,8 @@ private const val MOST_PLAYED_TILE_HEIGHT_DP = 56
|
||||
private const val MOST_PLAYED_COVER_DP = 48
|
||||
|
||||
// 3 rows of MOST_PLAYED_TILE_HEIGHT_DP + 2 * 8dp inter-row spacing,
|
||||
// rounded up. Mirrors Flutter (`CompactTrackCard` in
|
||||
// the Flutter client) which
|
||||
// uses a horizontal-row card pattern - much denser than the square
|
||||
// per-track tiles that web uses (operator request 2026-06-01: "in the
|
||||
// flutter iteration the tiles were different and smaller so more of
|
||||
// them could fit in a smaller space").
|
||||
// rounded up. Horizontal-row cards, much denser than the square
|
||||
// per-track tiles web uses, so more tracks fit in less space.
|
||||
private const val MOST_PLAYED_GRID_HEIGHT_DP = 200
|
||||
|
||||
@Composable
|
||||
|
||||
+9
-12
@@ -23,10 +23,9 @@ import javax.inject.Singleton
|
||||
* server and upsert into Room — the Flow emissions then propagate
|
||||
* automatically.
|
||||
*
|
||||
* Constructs its own LibraryApi from the shared Retrofit. Per the
|
||||
* "repositories own their interfaces" pattern adopted in Phase 5.1's
|
||||
* NetworkModule, we don't @Provides per-endpoint Retrofit interfaces
|
||||
* — fewer Hilt bindings, locality of reference.
|
||||
* Constructs its own LibraryApi from the shared Retrofit: repositories
|
||||
* own their interfaces (see NetworkModule), so there is no @Provides
|
||||
* per endpoint — fewer Hilt bindings, locality of reference.
|
||||
*/
|
||||
// LibraryRepository owns reads + refreshes for three entity families
|
||||
// (artists / albums / tracks) plus shuffle. Function count scales with
|
||||
@@ -46,8 +45,7 @@ class LibraryRepository @Inject constructor(
|
||||
|
||||
// Joins each artist to its first cached album (by sort title) so the
|
||||
// tile cover derives from /api/albums/{id}/cover — cached_artists
|
||||
// stores no cover and sync carries none. Mirrors Flutter's
|
||||
// artistTileProvider JOIN.
|
||||
// stores no cover and sync carries none.
|
||||
fun observeArtists(): Flow<List<ArtistRef>> =
|
||||
combine(artistDao.observeAll(), albumDao.observeAll()) { artists, albums ->
|
||||
val firstAlbumByArtist = albums
|
||||
@@ -161,13 +159,12 @@ class LibraryRepository @Inject constructor(
|
||||
suspend fun shuffleLibrary(limit: Int = SHUFFLE_DEFAULT_LIMIT): List<TrackRef> =
|
||||
api.shuffleLibrary(limit = limit).map { it.toDomain() }
|
||||
|
||||
// ---- Browse axes (#367 / #2467) ----
|
||||
// ---- Browse axes ----
|
||||
//
|
||||
// Server-backed rather than cache-first, unlike everything above. The
|
||||
// cache mirrors the whole library but includes tracks whose files are
|
||||
// missing, with no flag to spot them (#2704), while the server's index
|
||||
// excludes them -- so a locally-derived index would quietly disagree with
|
||||
// the web client's. Revisit when #2704 lands.
|
||||
// Server-backed rather than cache-first, unlike everything above: the
|
||||
// server's index leaves out tracks whose files are missing and is the
|
||||
// one the web client shows. See LibraryApi for why the cache's own
|
||||
// missing mark is not used to build it locally.
|
||||
|
||||
/** Genre index, ordered by track count then name (server order). */
|
||||
suspend fun genres(): List<GenreCount> =
|
||||
|
||||
+1
-1
@@ -67,7 +67,7 @@ class AlbumDetailViewModel @Inject constructor(
|
||||
|
||||
init {
|
||||
refresh()
|
||||
// Screen-level auto-recovery (issue #1245): a detail that failed to
|
||||
// Screen-level auto-recovery: a detail that failed to
|
||||
// load while the server was unreachable re-fetches when health
|
||||
// returns, so coming back to the screen shows content, not an error.
|
||||
viewModelScope.launch {
|
||||
|
||||
@@ -310,9 +310,9 @@ private fun ArtistHeader(
|
||||
|
||||
@Composable
|
||||
private fun ArtistAvatar(artist: ArtistRef, fallbackAlbumId: String? = null) {
|
||||
// Server coverUrl wins; otherwise mirror the server's "use the
|
||||
// first album's cover" rule via the loaded album list (Flutter
|
||||
// _ArtistAvatar). Bare Lucide.User only when neither exists.
|
||||
// Server coverUrl wins; otherwise use the first loaded album's
|
||||
// cover, the same rule the server applies. Bare Lucide.User only
|
||||
// when neither exists.
|
||||
val model = when {
|
||||
artist.coverUrl.isNotEmpty() -> artist.coverUrl
|
||||
fallbackAlbumId != null -> albumCoverPath(fallbackAlbumId)
|
||||
|
||||
+4
-5
@@ -72,7 +72,7 @@ class ArtistDetailViewModel @Inject constructor(
|
||||
|
||||
init {
|
||||
refresh()
|
||||
// Screen-level auto-recovery (issue #1245). From Error, redo the
|
||||
// Screen-level auto-recovery. From Error, redo the
|
||||
// whole load; from Success, re-pull just the secondary sections —
|
||||
// their fetch failures are swallowed to emptyList, so a dead zone
|
||||
// during the first load leaves them permanently absent otherwise.
|
||||
@@ -139,10 +139,9 @@ class ArtistDetailViewModel @Inject constructor(
|
||||
|
||||
/**
|
||||
* Pull every track across the artist's albums, shuffle, and start
|
||||
* playing. Mirrors Flutter's artist Play button — pressing Play on
|
||||
* an artist is implicitly "shuffle this artist", not "play album by
|
||||
* album in tracklist order". Network round-trip per click; fine
|
||||
* because the user explicitly tapped Play.
|
||||
* playing. Pressing Play on an artist means "shuffle this artist",
|
||||
* not "play album by album in tracklist order". One network
|
||||
* round-trip per click; fine because the user explicitly tapped Play.
|
||||
*/
|
||||
fun playArtist() {
|
||||
viewModelScope.launch {
|
||||
|
||||
@@ -42,15 +42,12 @@ data class AlbumBrowseState(
|
||||
}
|
||||
|
||||
/**
|
||||
* Backs the Genres and Years tabs (#2467), mirroring the web surfaces #367
|
||||
* shipped.
|
||||
* Backs the Genres and Years tabs, the same browse axes the web client has.
|
||||
*
|
||||
* Both indexes come from the server, which is a deliberate departure from the
|
||||
* cache-first Artists/Albums tabs beside them: the local cache includes tracks
|
||||
* whose files are missing and cannot tell you which (#2704), while the server's
|
||||
* index excludes them, so a locally-derived index would disagree with the web
|
||||
* client's. These two tabs therefore need a connection; the empty states say so
|
||||
* rather than looking broken.
|
||||
* Both indexes come from the server, unlike the cache-first Artists/Albums
|
||||
* tabs beside them: the server's index leaves out tracks whose files are
|
||||
* missing and matches the web client's. These two tabs therefore need a
|
||||
* connection; the empty states say so rather than looking broken.
|
||||
*/
|
||||
// Two browse axes, each with an index, a filter/sort or grouping, a
|
||||
// drill-down and a pager. The function count is two axes' worth of a
|
||||
|
||||
@@ -41,7 +41,7 @@ import com.fabledsword.minstrel.shared.widgets.EmptyState
|
||||
import com.fabledsword.minstrel.shared.widgets.ErrorRetry
|
||||
|
||||
/**
|
||||
* Genres tab (#2467) — the Android half of the browse axis #367 shipped on web.
|
||||
* Genres tab: the genre browse axis, as on web.
|
||||
*
|
||||
* Two states in one tab rather than a navigation destination: the index, and
|
||||
* the albums for a chosen genre. Back returns to the index. A route would have
|
||||
|
||||
@@ -54,17 +54,11 @@ import com.fabledsword.minstrel.shared.widgets.SkeletonArtistTile
|
||||
/**
|
||||
* Library tab. Seven-tab TabBar (Artists / Albums / Genres / Years /
|
||||
* History / Liked / Hidden), matching the web client's library tab bar.
|
||||
* Genres and Years arrived with #2467; the rest predate it and mirrored
|
||||
* the Flutter client.
|
||||
*
|
||||
* Artists + Albums are wired against the existing LibraryViewModel
|
||||
* (cache-first reads of cached_artists / cached_albums). The other
|
||||
* three tabs render placeholder EmptyStates pointing at the upcoming
|
||||
* data-layer phases:
|
||||
* - History → Phase 9 (server-side /api/me/history wiring)
|
||||
* - Liked → Phase 8 (likes write path + cached_likes hydration)
|
||||
* - Hidden → Phase 10 (quarantine flag/unflag UI lives in Admin slice
|
||||
* but the user-side "my hidden tracks" view comes here)
|
||||
* Artists + Albums are cache-first reads of cached_artists /
|
||||
* cached_albums through LibraryViewModel; Genres and Years read the
|
||||
* server through BrowseViewModel; History, Liked and Hidden are their
|
||||
* own tabs ([HistoryTab], [LikedTab], [HiddenTab]).
|
||||
*/
|
||||
@OptIn(ExperimentalMaterial3Api::class)
|
||||
@Composable
|
||||
@@ -160,7 +154,7 @@ private const val TAB_LIKED = 5
|
||||
private const val TAB_HIDDEN = 6
|
||||
|
||||
// Genres and Years sit straight after Albums, matching the web tab bar's
|
||||
// order (#2467) -- they are browse axes over the same albums, so they belong
|
||||
// order -- they are browse axes over the same albums, so they belong
|
||||
// beside them rather than after the personal tabs.
|
||||
private val LIBRARY_TABS =
|
||||
listOf("Artists", "Albums", "Genres", "Years", "History", "Liked", "Hidden")
|
||||
|
||||
@@ -26,7 +26,7 @@ import com.fabledsword.minstrel.shared.widgets.EmptyState
|
||||
import com.fabledsword.minstrel.shared.widgets.ErrorRetry
|
||||
|
||||
/**
|
||||
* Years tab (#2467). Same two-state shape as [GenresTab]: the decade-grouped
|
||||
* Years tab. Same two-state shape as [GenresTab]: the decade-grouped
|
||||
* index, then the albums for a chosen year.
|
||||
*
|
||||
* Albums with no release date are absent from this axis entirely — the server
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user