Compare commits
84
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
67eeb75e7b | ||
|
|
fe1fbefee7 | ||
|
|
de04339494 | ||
|
|
998ce75fb6 | ||
|
|
4b392cb4c4 | ||
|
|
8d2109b87e | ||
|
|
b741b01cdf | ||
|
|
8a757c9bb4 | ||
|
|
d714bd7090 | ||
|
|
d64b069053 | ||
|
|
5490b2423e | ||
|
|
ffc9490a32 | ||
|
|
dc6625d33a | ||
|
|
dc8db159f9 | ||
|
|
86e7444603 | ||
|
|
2365806d18 | ||
|
|
7d348f243a | ||
|
|
ddd04623f7 | ||
|
|
9ad1477b1e | ||
|
|
70ab3ddf94 | ||
|
|
4f7529c315 | ||
|
|
bb21072386 | ||
|
|
ead1354e4d | ||
|
|
ae85df0dad | ||
|
|
6e7e349e63 | ||
|
|
f9ba9a87d7 | ||
|
|
e4efec6f0c | ||
|
|
99f355b2fc | ||
|
|
c79d4d47a3 | ||
|
|
8efed2dd2b | ||
|
|
12af6ec1f7 | ||
|
|
f3d1ae1c8c | ||
|
|
5af545e38d | ||
|
|
9da3967dd9 | ||
|
|
c8d94a8203 | ||
|
|
43d78a731a | ||
|
|
a3926704cc | ||
|
|
ea53d4f15b | ||
|
|
ea16e07c46 | ||
|
|
4f47c85208 | ||
|
|
603728a3fb | ||
|
|
018d857746 | ||
|
|
a7ac2b4a3e | ||
|
|
d347809e6e | ||
|
|
a5ffcc22e3 | ||
|
|
f18691560d | ||
|
|
c84a9069ef | ||
|
|
f967916550 | ||
|
|
3fa7c7734b | ||
|
|
cceeb40b16 | ||
|
|
2926ecd4b4 | ||
|
|
ff3c4003cb | ||
|
|
def596a99e | ||
|
|
14f78c0b57 | ||
|
|
7cea238e71 | ||
|
|
4f2f1827ab | ||
|
|
e454e4074b | ||
|
|
c518ac8c73 | ||
|
|
977f624123 | ||
|
|
23f3d4b3b0 | ||
|
|
8d46c4abb7 | ||
|
|
f714fe513d | ||
|
|
087c69ac8d | ||
|
|
bb7dde1963 | ||
|
|
446380e3a9 | ||
|
|
e07f248cc8 | ||
|
|
90ac6e0825 | ||
|
|
4e3c953acf | ||
|
|
ede183d026 | ||
|
|
481c9dca65 | ||
|
|
4025106234 | ||
|
|
a3134f997f | ||
|
|
3607fe445e | ||
|
|
61d549a9d5 | ||
|
|
2b84bc53e9 | ||
|
|
282dab43eb | ||
|
|
cc9df4004c | ||
|
|
b5d70ac1cd | ||
|
|
9118c16fe3 | ||
|
|
fe67849e57 | ||
|
|
21b303ba7c | ||
|
|
9375f25629 | ||
|
|
905654cc84 | ||
|
|
219fa3c615 |
@@ -195,6 +195,12 @@ Two rules about climbing:
|
|||||||
- **Do not write an e2e spec first.** Drive the flow by hand, then
|
- **Do not write an e2e spec first.** Drive the flow by hand, then
|
||||||
promote it with `/e2e`. Specs written blind assert on selectors that
|
promote it with `/e2e`. Specs written blind assert on selectors that
|
||||||
do not exist.
|
do not exist.
|
||||||
|
- **Not every view has a nav item.** Since #25 the destinations are
|
||||||
|
configurable, Autotag is hidden by default and Downloads is absent
|
||||||
|
until a download client exists — so `getByTestId('nav-<view>')` waits
|
||||||
|
30 s for a locator that will never resolve. `navigateTo(page, view)`
|
||||||
|
(`e2e/support/fixtures.ts`) dispatches the app's own `navigate` event.
|
||||||
|
Click the nav item when the *nav* is what the spec is about.
|
||||||
|
|
||||||
Before a commit, the gate is `make lint`, `make test`, `make ui-test`,
|
Before a commit, the gate is `make lint`, `make test`, `make ui-test`,
|
||||||
`make bindings-check`, `make css-check` and — from `frontend/` —
|
`make bindings-check`, `make css-check` and — from `frontend/` —
|
||||||
|
|||||||
@@ -194,9 +194,13 @@ like the app's fault and none is:
|
|||||||
|---|---|---|
|
|---|---|---|
|
||||||
| x86_64 | modernc's raw `lstat` vs seccomp | SIGSYS, syscall 6 |
|
| x86_64 | modernc's raw `lstat` vs seccomp | SIGSYS, syscall 6 |
|
||||||
| arm64, translated | Go reads `ID_AA64ISAR0_EL1` | SIGILL |
|
| arm64, translated | Go reads `ID_AA64ISAR0_EL1` | SIGILL |
|
||||||
| arm64, real device | — | unverified, still |
|
| arm64, real device | **runs** (2026-08-20) | — |
|
||||||
|
|
||||||
**A physical arm64 device remains the only verification path.**
|
**A physical arm64 device remains the only verification path**, and it
|
||||||
|
has now been walked: a Light Phone III (TLP301, Android 14 / SDK 34,
|
||||||
|
arm64-v8a, WebView Chrome 113 at 424x439). The app builds, installs,
|
||||||
|
launches and stays up; `make android-smoke SECONDS=60` passes on it.
|
||||||
|
What that run *found* is the lifecycle fault below.
|
||||||
|
|
||||||
### What was fixed to get here
|
### What was fixed to get here
|
||||||
|
|
||||||
@@ -210,6 +214,11 @@ no-op. `backend/system` gained no import of the Wails application
|
|||||||
package, which matters for the same reason `backend/events` is split by
|
package, which matters for the same reason `backend/events` is split by
|
||||||
the `indexbuild` tag.
|
the `indexbuild` tag.
|
||||||
|
|
||||||
|
**And `main()` is now latched to one run per process** (#52). That is
|
||||||
|
the second `os.Exit(1)` in this file's history and it had the same
|
||||||
|
signature as the first, which is the argument for #160: both were named
|
||||||
|
exactly by an `slog` line that went to `/dev/null`.
|
||||||
|
|
||||||
### What is still not done
|
### What is still not done
|
||||||
|
|
||||||
The shell is still a desktop shell, and the x86_64 half of the APK is
|
The shell is still a desktop shell, and the x86_64 half of the APK is
|
||||||
@@ -249,10 +258,25 @@ one.
|
|||||||
`build/android/Taskfile.yml` ships more than the Makefile wraps, and
|
`build/android/Taskfile.yml` ships more than the Makefile wraps, and
|
||||||
they are the right thing to reach for when you want something one-off:
|
they are the right thing to reach for when you want something one-off:
|
||||||
|
|
||||||
|
> **These four were unsafe until #159 and are now the way in.** All of
|
||||||
|
> them began with `adb uninstall {{.APP_ID}}`, where `APP_ID` defaulted
|
||||||
|
> to `app.yellowjacket` — the **release** id — while `run` and
|
||||||
|
> `run:device` build the **debug** variant, whose id is
|
||||||
|
> `app.yellowjacket.dev`. So they uninstalled the user's app, taking
|
||||||
|
> the library with it, installed a different package, and then failed
|
||||||
|
> to launch the one they had removed.
|
||||||
|
>
|
||||||
|
> They share `scripts/android-deploy.sh` now, which **never**
|
||||||
|
> uninstalls (`install -r`, and a changed signing certificate is
|
||||||
|
> reported with the command rather than acted on), reads the package id
|
||||||
|
> back out of the built APK, and refuses a target that is not the kind
|
||||||
|
> the task names. There is nothing left to avoid; the manual sequence
|
||||||
|
> below is kept because it is still the smallest thing that works.
|
||||||
|
|
||||||
```
|
```
|
||||||
wails3 task android:run # debug build + emulator install + launch
|
wails3 task android:run # debug build + emulator install + launch
|
||||||
wails3 task android:run:device # same, first connected physical device
|
wails3 task android:run:device # debug build + install + launch on a phone
|
||||||
wails3 task android:deploy-device # production APK to a device
|
wails3 task android:deploy-device # release build, same
|
||||||
wails3 task android:bundle:fat # AAB, for a Play Store upload
|
wails3 task android:bundle:fat # AAB, for a Play Store upload
|
||||||
wails3 task android:studio # open build/android/ in Android Studio
|
wails3 task android:studio # open build/android/ in Android Studio
|
||||||
wails3 task android:device:list
|
wails3 task android:device:list
|
||||||
@@ -260,6 +284,16 @@ wails3 task android:logs:all
|
|||||||
wails3 task android:clean
|
wails3 task android:clean
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**`run` and `deploy-emulator` mean the emulator, and now say so to
|
||||||
|
adb.** They used a bare `adb install`, which with exactly one device
|
||||||
|
attached picks that device whatever it is — so with a phone plugged in
|
||||||
|
and no emulator running, the task whose summary reads "in the Android
|
||||||
|
Emulator" installed on the phone. They pass `--target emulator` and
|
||||||
|
refuse with `make android-emulator` as the remedy.
|
||||||
|
|
||||||
|
**`DEVICE_ID=<serial>` still names a device, and several attached
|
||||||
|
devices is now an error rather than a silent pick of the first.**
|
||||||
|
|
||||||
Two are deliberately **not** wrapped. `android:logs` greps logcat for
|
Two are deliberately **not** wrapped. `android:logs` greps logcat for
|
||||||
`(Wails|yellowjacket)`, which catches the `WailsBridge` tag but misses
|
`(Wails|yellowjacket)`, which catches the `WailsBridge` tag but misses
|
||||||
the app's own process tag (`app.yellowjacket` — lowercase, so `Wails`
|
the app's own process tag (`app.yellowjacket` — lowercase, so `Wails`
|
||||||
@@ -269,16 +303,51 @@ instead. And `ensure-emulator` boots whatever `-list-avds | tail -1`
|
|||||||
returns, with no pidfile and no boot wait, so it cannot be stopped or
|
returns, with no pidfile and no boot wait, so it cannot be stopped or
|
||||||
sequenced.
|
sequenced.
|
||||||
|
|
||||||
## The identity is declared twice
|
## The identity is read back from the APK
|
||||||
|
|
||||||
|
It used to be **declared twice**, and that is what #159 was.
|
||||||
`applicationId` in `build/android/app/build.gradle` is what Gradle
|
`applicationId` in `build/android/app/build.gradle` is what Gradle
|
||||||
installs. `APP_ID` in `build/android/Taskfile.yml` is what every
|
installs; `APP_ID` in `build/android/Taskfile.yml` was what every
|
||||||
adb-driven task uninstalls, launches and filters. **Nothing enforces
|
adb-driven task uninstalled, launched and filtered, and nothing
|
||||||
that they agree**, and `ANDROID.md`'s advice to set `APP_ID` in
|
enforced that they agree. They did not: the debug buildType carries
|
||||||
`build/config.yml` does not work in beta.8 — `wails3 task` never reads
|
`applicationIdSuffix ".dev"`, so every task that assembles a debug APK
|
||||||
that file (verified with `--dry`), and even when set it feeds only the
|
addressed the release id. This file flagged the hazard for five phases
|
||||||
adb commands, never Gradle. Change both or the official `run`/`deploy`
|
and it cashed out twice — once as a wrong `am start`, once as an
|
||||||
tasks address a package that is not installed.
|
uninstall of the user's library.
|
||||||
|
|
||||||
|
**`scripts/android-pkgid.sh` is the one answer now.** It prints the
|
||||||
|
package id an APK declares (`aapt2 dump packagename`, falling back to
|
||||||
|
`aapt dump badging`), and the deploy path installs and launches *that*.
|
||||||
|
The APK is the authority because the task that installs it has just
|
||||||
|
built it: whatever Gradle resolved the applicationId to, suffixes and
|
||||||
|
flavours included, is in the file, and no default can disagree with it.
|
||||||
|
An APK it cannot read is a hard failure, never a fallback to a written
|
||||||
|
down default — guessing is the bug.
|
||||||
|
|
||||||
|
**`APP_ID` survives as an assertion, not a setting**, and has no
|
||||||
|
default. `wails3 task android:run APP_ID=app.yellowjacket` says "this
|
||||||
|
build had better declare that id" and is refused, naming both, *before*
|
||||||
|
anything is installed or a device is even chosen. It could never have
|
||||||
|
been a setting: `ANDROID.md`'s advice to put it in `build/config.yml`
|
||||||
|
does not work in beta.8 — `wails3 task` never reads that file (verified
|
||||||
|
with `--dry`) — and even when set it fed only the adb commands, never
|
||||||
|
Gradle.
|
||||||
|
|
||||||
|
`scripts/android-emulator.sh` derives `PKG` the same way, from
|
||||||
|
`bin/yellowjacket.apk` when one is built, so `make android-install`,
|
||||||
|
`android-launch`, `android-logs` and `android-smoke` follow whichever
|
||||||
|
variant is actually in `bin/`. `YJ_ANDROID_PKG` still overrides, and
|
||||||
|
the old literal survives only for a tree with no APK built yet.
|
||||||
|
|
||||||
|
**The uninstall is gone and is not coming back.** It existed to make
|
||||||
|
the bare `install` on the next line work at all — without `-r` Android
|
||||||
|
refuses an install over an existing package — so `install -r` removes
|
||||||
|
the *reason* for it rather than merely removing it. What is left is the
|
||||||
|
one case an uninstall really is the remedy, a changed signing
|
||||||
|
certificate, and that is exactly the case where performing it silently
|
||||||
|
costs the user their library. So it is named and not done, which is the
|
||||||
|
answer `scripts/android-emulator.sh` had already reached for
|
||||||
|
`make android-install`.
|
||||||
|
|
||||||
Related, and it will bite once: the launcher activity is
|
Related, and it will bite once: the launcher activity is
|
||||||
`com.wails.app.MainActivity` and the applicationId is
|
`com.wails.app.MainActivity` and the applicationId is
|
||||||
@@ -287,6 +356,27 @@ resolves the leading dot against the *applicationId* and fails with a
|
|||||||
class-not-found that reads like a broken build. Always the
|
class-not-found that reads like a broken build. Always the
|
||||||
fully-qualified form.
|
fully-qualified form.
|
||||||
|
|
||||||
|
**`wails3 task android:run:device` is the way to put a debug build on a
|
||||||
|
real device**, since #159. What #52 used, before it was safe, was the
|
||||||
|
longer form, and it is still the smallest thing that works if you want
|
||||||
|
no script between you and adb:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
wails3 task android:build ARCH=arm64 && wails3 task android:assemble:apk
|
||||||
|
adb install -r bin/yellowjacket.apk # -r, never uninstall
|
||||||
|
adb shell am start -n app.yellowjacket.dev/com.wails.app.MainActivity
|
||||||
|
```
|
||||||
|
|
||||||
|
The id in that last line is the one thing to keep an eye on by hand —
|
||||||
|
`./scripts/android-pkgid.sh bin/yellowjacket.apk` is what the tasks ask,
|
||||||
|
and it is a good habit before any `am start` written out in full.
|
||||||
|
|
||||||
|
`YJ_ANDROID_PKG=app.yellowjacket.dev` still overrides what
|
||||||
|
`scripts/android-emulator.sh` — and therefore `make android-smoke`,
|
||||||
|
`android-logs`, `android-launch` — addresses, but it is rarely needed
|
||||||
|
now: that default is read from `bin/yellowjacket.apk`, so it already
|
||||||
|
follows whichever variant was built last.
|
||||||
|
|
||||||
## What only a device can answer
|
## What only a device can answer
|
||||||
|
|
||||||
The emulator cannot run this app (three separate reasons, none of them
|
The emulator cannot run this app (three separate reasons, none of them
|
||||||
@@ -311,6 +401,91 @@ system bars, the back gesture, focus and audio interruptions,
|
|||||||
permission dialogs, the keyboard — not about what the app draws. The
|
permission dialogs, the keyboard — not about what the app draws. The
|
||||||
drawing is what the other five tiers already cover.
|
drawing is what the other five tiers already cover.
|
||||||
|
|
||||||
|
**The third such fault was the activity lifecycle** (#52), and it is
|
||||||
|
the one to re-check after touching `main()`, `WailsBridge` or
|
||||||
|
`MainActivity`. Android destroys and recreates an activity **without
|
||||||
|
restarting the process**, and Wails' `nativeInit` — which
|
||||||
|
`MainActivity.onCreate` calls — runs `go mainFunc()` every time. So
|
||||||
|
Go's `main()` ran again on a live app, `app.Run()` refused (`a.starting`
|
||||||
|
is still true behind Android's `select{}`), and the `os.Exit(1)` under
|
||||||
|
it took the healthy first app down with it.
|
||||||
|
|
||||||
|
### The lifecycle check, and how to trigger it on demand
|
||||||
|
|
||||||
|
This is the regression guard for #52 on this tier, because no other
|
||||||
|
tier runs `main()` on Android at all. The Go-side guard
|
||||||
|
(`TestMainClaimsBeforeItDoesAnything`) catches work creeping above the
|
||||||
|
latch; only the device catches the latch not working.
|
||||||
|
|
||||||
|
**Trigger a relaunch with a configuration change the manifest does not
|
||||||
|
declare.** `AndroidManifest.xml` lists
|
||||||
|
`orientation|screenSize|keyboardHidden|uiMode`, so those are handled
|
||||||
|
in-place and are *not* triggers. `fontScale` is not listed, and it is a
|
||||||
|
one-liner:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
adb shell settings put system font_scale 1.15 # restore the old value after
|
||||||
|
```
|
||||||
|
|
||||||
|
That is the same in-process destroy/recreate that "Don't keep
|
||||||
|
activities", a locale change and a memory trim produce, but on demand.
|
||||||
|
|
||||||
|
**"Don't keep activities" is the report's own lever and did not work on
|
||||||
|
this device**: `settings put global always_finish_activities 1` reads
|
||||||
|
back as `1`, `am set-always-finish-activities` does not exist on this
|
||||||
|
build, and the activity was never finished on backgrounding. Do not
|
||||||
|
spend an afternoon on it; use the config change.
|
||||||
|
|
||||||
|
**The assertion is the pid, and the tell is two bridge inits in one.**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
adb logcat -d | grep -E "Wails bridge initialized|has died|finishDrawing of relaunch"
|
||||||
|
```
|
||||||
|
|
||||||
|
Healthy is one pid appearing twice — the process surviving the
|
||||||
|
recreation:
|
||||||
|
|
||||||
|
```
|
||||||
|
I/WailsBridge(28420): Wails bridge initialized
|
||||||
|
I/WailsBridge(28420): Wails bridge initialized <- same pid, recreated
|
||||||
|
```
|
||||||
|
|
||||||
|
Broken is that pair followed within a second by:
|
||||||
|
|
||||||
|
```
|
||||||
|
I/WindowManager: finishDrawing of relaunch: Window{...MainActivity} 603ms
|
||||||
|
I/ActivityManager: Process app.yellowjacket.dev (pid 22956) has died: fg TOP
|
||||||
|
W/ActivityTaskManager: Force removing ActivityRecord{...}: app died, no saved state
|
||||||
|
```
|
||||||
|
|
||||||
|
Two things about reading that. **`has died: fg TOP` is not a memory
|
||||||
|
kill** — the system does not reclaim the foreground process, so this is
|
||||||
|
the app leaving of its own accord. And there is **no crash record
|
||||||
|
anywhere**: `logcat -b crash` is empty, no `AndroidRuntime`, no
|
||||||
|
`libc: Fatal signal`, no tombstone. That is the `os.Exit` signature,
|
||||||
|
and it is why "the system killed it" is the wrong first hypothesis.
|
||||||
|
|
||||||
|
**Surviving is only half of it — check the recreated WebView is still
|
||||||
|
wired to the running app.** A plausible-looking fix (making
|
||||||
|
`WailsBridge.initialized` static, so the second `nativeInit` is skipped)
|
||||||
|
keeps the process alive and silently breaks this, because `nativeInit`
|
||||||
|
is also what re-points the JNI reference at the new bridge. Go would go
|
||||||
|
on executing JavaScript against the destroyed activity's WebView: the
|
||||||
|
app opens, renders, and never receives another backend event.
|
||||||
|
|
||||||
|
Ask the page, after a relaunch and a resume:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
make android-inspect
|
||||||
|
make android-eval EXPR='(()=>{window.__probe=[];const o=window._wails.dispatchWailsEvent.bind(window._wails);window._wails.dispatchWailsEvent=(e)=>{window.__probe.push(e&&e.name);return o(e)};return "ok"})()'
|
||||||
|
# background and foreground the app, then:
|
||||||
|
make android-eval EXPR='JSON.stringify(window.__probe)'
|
||||||
|
```
|
||||||
|
|
||||||
|
A healthy build answers with events from the live services —
|
||||||
|
`["IndexStatusChanged","JobsChanged","JobsChanged","android:storageAccess"]`.
|
||||||
|
`[]` means the bridge reference is stale.
|
||||||
|
|
||||||
## Asking the device, not just looking at it
|
## Asking the device, not just looking at it
|
||||||
|
|
||||||
A real phone can be inspected, and that turns this tier from "reported
|
A real phone can be inspected, and that turns this tier from "reported
|
||||||
@@ -340,6 +515,75 @@ Four things about it, each of which costs an hour if met cold:
|
|||||||
script. Plug in over USB for anything longer than a couple of probes.
|
script. Plug in over USB for anything longer than a couple of probes.
|
||||||
- **The socket name carries the pid**, which changes on every launch, so
|
- **The socket name carries the pid**, which changes on every launch, so
|
||||||
it is resolved rather than remembered.
|
it is resolved rather than remembered.
|
||||||
|
- **A reinstall resets the runtime permissions**, and the grant dialog
|
||||||
|
is a separate activity that takes focus — so the app is up, `am start`
|
||||||
|
reports "delivered to currently running top-most instance", and
|
||||||
|
`pidof` is empty because it never got to the foreground.
|
||||||
|
`dumpsys window | grep mCurrentFocus` naming
|
||||||
|
`GrantPermissionsActivity` is the tell. `adb shell pm grant
|
||||||
|
app.yellowjacket.dev android.permission.READ_MEDIA_AUDIO` (and
|
||||||
|
`POST_NOTIFICATIONS`) ahead of the launch skips it.
|
||||||
|
|
||||||
|
### Calling a binding on the device
|
||||||
|
|
||||||
|
**The runtime call does not go over HTTP on Android**, and this is worth
|
||||||
|
knowing before an hour is spent on it. The WebView cannot deliver a
|
||||||
|
`fetch()` POST body to `shouldInterceptRequest`, so v3 routes runtime
|
||||||
|
calls through the `addJavascriptInterface` bridge instead: the
|
||||||
|
@wailsio/runtime installs a `customTransport` that calls
|
||||||
|
`window.wails.invokeAsync(id, payload)` and receives the answer on
|
||||||
|
`window._wailsAndroidCallback`. Two consequences:
|
||||||
|
|
||||||
|
- **`.playwright/init-events.js` does not transfer to the device.** Its
|
||||||
|
outbound half hooks `fetch`, which sees nothing here, and its
|
||||||
|
`call()` posts to `/wails/runtime`, which answers
|
||||||
|
`Invalid runtime call: missing object value` — the interceptor got the
|
||||||
|
URL with no body. Its *inbound* half is still right, because
|
||||||
|
`dispatchWailsEvent` is the entry point in every mode.
|
||||||
|
- **Hooking `fetch` from an eval is too late anyway**, on any platform:
|
||||||
|
the bundle captured its reference at module scope, so a wrapper
|
||||||
|
installed afterwards records nothing. That is why the harness is an
|
||||||
|
`initScript` and not a step in a spec.
|
||||||
|
|
||||||
|
What works is to borrow the bridge, chaining the runtime's own callback
|
||||||
|
so its pending calls still resolve:
|
||||||
|
|
||||||
|
```js
|
||||||
|
const pending = new Map();
|
||||||
|
const prev = window._wailsAndroidCallback;
|
||||||
|
window._wailsAndroidCallback = (id, response, error) => {
|
||||||
|
if (!pending.has(id)) return prev && prev(id, response, error);
|
||||||
|
const p = pending.get(id); pending.delete(id);
|
||||||
|
const env = JSON.parse(response || "{}");
|
||||||
|
return env.ok ? p.resolve(env.data ?? env.text) : p.reject(new Error(env.error));
|
||||||
|
};
|
||||||
|
window.__yj = { call(name, args) {
|
||||||
|
return new Promise((resolve, reject) => {
|
||||||
|
const id = "yj" + Math.random().toString(36).slice(2);
|
||||||
|
pending.set(id, { resolve, reject });
|
||||||
|
window.wails.invokeAsync(id, JSON.stringify({
|
||||||
|
object: 0, method: 0, windowName: "",
|
||||||
|
args: { "call-id": id, methodName: "yellowjacket/backend/" + name, args: args || [] },
|
||||||
|
clientId: window._wails.clientId,
|
||||||
|
}));
|
||||||
|
});
|
||||||
|
} };
|
||||||
|
```
|
||||||
|
|
||||||
|
That turns the device into a tier that can be *driven* rather than only
|
||||||
|
looked at — `__yj.call("player.Player.LoadFile", [path])` and
|
||||||
|
`__yj.call("library.Library.AddLibrary", ["/sdcard/Music/..."])` are how
|
||||||
|
#53 was measured. Names are the Go ones (`GetTracks`, not
|
||||||
|
`GetAllTracks`); an unknown one comes back as a plain
|
||||||
|
`unknown bound method name`, so a wrong guess is loud.
|
||||||
|
|
||||||
|
**Getting audio onto the phone**: `adb push` into
|
||||||
|
`/sdcard/Android/data/<pkg>/files/` looks like it works and then the
|
||||||
|
files are not there — scoped storage. `/sdcard/Music/...` plus
|
||||||
|
`pm grant … READ_MEDIA_AUDIO` does work, and `AddLibrary` takes the
|
||||||
|
plain path. The generated fixtures are **~2 seconds** each, which is
|
||||||
|
fine for a scan and useless for watching a seek bar, so synthesise a
|
||||||
|
long one: `ffmpeg -f lavfi -i sine=frequency=440:duration=240`.
|
||||||
|
|
||||||
**And the reason to bother: the phone is an engine, not a screen.** The
|
**And the reason to bother: the phone is an engine, not a screen.** The
|
||||||
first device here renders in **Chrome 113** at 424x439 CSS px. Every
|
first device here renders in **Chrome 113** at 424x439 CSS px. Every
|
||||||
|
|||||||
@@ -3580,3 +3580,725 @@ per-card flag can answer at all.
|
|||||||
The general point: **two columns that agree today are not one column.**
|
The general point: **two columns that agree today are not one column.**
|
||||||
Which of them a new surface reads should be decided by which one has
|
Which of them a new surface reads should be decided by which one has
|
||||||
something that can un-set it.
|
something that can un-set it.
|
||||||
|
|
||||||
|
## The queue panel was a column that could not afford to be one (measured 2026-08-19)
|
||||||
|
|
||||||
|
Plan 018, issue #24. Measured against the running app (`make
|
||||||
|
dev-headless SEED=default`, Chromium) on Playlists, sweeping the
|
||||||
|
viewport with the queue open and closed. Main panel width, and how much
|
||||||
|
of the page header survived:
|
||||||
|
|
||||||
|
| viewport | sidebar | main (queue open) | actions clipped |
|
||||||
|
|---|---|---|---|
|
||||||
|
| 1280×800 | 200 | 759 | — |
|
||||||
|
| 1000×700 | 200 | 479 | 2 of 3 |
|
||||||
|
| **900×600** | 200 | **379** | all three |
|
||||||
|
| 800×600 | 56 | 423 | all three |
|
||||||
|
| 390×780 | — | **69** | all three |
|
||||||
|
| 320×600 | — | **0** | all three |
|
||||||
|
| 800×600 | 56 | 744 *(closed)* | New Smart Playlist, 158/162px |
|
||||||
|
|
||||||
|
Five things came out of it that the issue did not say.
|
||||||
|
|
||||||
|
- **The header clips at the enforced minimum with the queue closed.**
|
||||||
|
800×600 is the only size this app promises, and "New Smart Playlist"
|
||||||
|
loses 4px of its 162 there. The queue makes it dramatic; it is not
|
||||||
|
the cause.
|
||||||
|
- **900×600 is worse than 800×600.** `AUTO_COLLAPSE_VIEWPORT` collapses
|
||||||
|
the sidebar *below* 900, so the main panel is 843px at 899 and 700px
|
||||||
|
at 900. **The worst desktop case is the top of the Compact band, not
|
||||||
|
the enforced floor** — so every viewport list that stopped at "the
|
||||||
|
minimum" was missing its own worst case. `layout-overflow.spec.ts`
|
||||||
|
carries 900 now.
|
||||||
|
- **At 320px the main panel was 0px.** The panel is `flex-shrink: 0` in
|
||||||
|
the flow of `.content-area`, so an open queue is paid for by the
|
||||||
|
content rather than covering it. Not degraded — gone. That is the
|
||||||
|
measurement #55 wanted and did not have.
|
||||||
|
- **Only Playlists overflows.** All ten primary views swept at 900×600
|
||||||
|
and 390×780; every other header reports `scrollWidth ==
|
||||||
|
clientWidth`, and Albums at 390 renders title, count and sort legibly
|
||||||
|
(checked on a screenshot, not just the number). So #69 is one view's
|
||||||
|
action set — three text buttons totalling 390px — and not a systemic
|
||||||
|
header failure.
|
||||||
|
- **Both reasons in `MinWidth`'s comment had expired.** The subtitle is
|
||||||
|
`display: none` from 899 down, and the sidebar host is
|
||||||
|
`overflow-y: auto` (at 600×460, `scrollHeight` 434 against a 332px
|
||||||
|
client, Settings reachable after scrolling). The floor is right; its
|
||||||
|
stated defence was two mechanisms that can no longer happen, which is
|
||||||
|
worse than either answer because nobody can argue with it.
|
||||||
|
|
||||||
|
**A correction worth keeping, because it nearly went in the plan.** My
|
||||||
|
first probe for the sidebar's scroller searched
|
||||||
|
`shadowRoot.querySelectorAll('*')` and reported "no scroller — items
|
||||||
|
are unreachable", which reads exactly like a live Settings-unreachable
|
||||||
|
bug. The scroller is the **host**, and a host is not inside its own
|
||||||
|
shadow root. CLAUDE.md was right and the probe was wrong.
|
||||||
|
|
||||||
|
**And one claim in the plan's first draft was too strong**: that the
|
||||||
|
overlay "removes the desktop half of #69". After phase 2, at 900×600,
|
||||||
|
open and closed are now *identical* (main 700, one action clipped)
|
||||||
|
where open used to be main 379 with all three clipped. The queue's
|
||||||
|
contribution is gone; the header's own overflow remains and is still a
|
||||||
|
live defect at a supported size.
|
||||||
|
|
||||||
|
### The mode cannot be a media query
|
||||||
|
|
||||||
|
The panel is drag-resizable 200–500px and persisted, so a viewport
|
||||||
|
breakpoint assumes the default 320 and is wrong by up to 180px for a
|
||||||
|
user who widened it — in the direction that hurts, since a wider queue
|
||||||
|
is exactly when the content can least afford it. It is computed from
|
||||||
|
`.content-area`'s width instead (which already accounts for the
|
||||||
|
sidebar's collapse), and the component test that matters widens the
|
||||||
|
panel at a *fixed* parent width and asserts the flip.
|
||||||
|
|
||||||
|
The floor (480) is a judgement, and the measurement is why: there is no
|
||||||
|
cliff. The track list rescales its columns continuously — 213px down to
|
||||||
|
124px between main widths of 900 and 544, `rowOverflow=0` at every step
|
||||||
|
— and the album grid steps 3 columns to 2 somewhere between 564 and 644
|
||||||
|
without breaking. So 480 is anchored at both ends instead: it keeps the
|
||||||
|
default 1100px window inline, and puts every measured-broken case on
|
||||||
|
the overlay side.
|
||||||
|
|
||||||
|
The scrim is perceptible but subtle on a dark ramp, which is worth
|
||||||
|
knowing before someone "fixes" it as broken: sampled from screenshots at
|
||||||
|
900×600, the main panel's background goes 33,37,41 → 18,20,23 and a
|
||||||
|
row's text 242 → 133. It covers the content area only — not the sidebar
|
||||||
|
or the transport — because the queue is not modal.
|
||||||
|
|
||||||
|
## No test tier can see a `hover:` media query (measured 2026-08-19)
|
||||||
|
|
||||||
|
Gating an affordance on `(hover: hover) and (pointer: fine)` — #68's fix
|
||||||
|
for the play button that flashed on a long-press — is invisible to both
|
||||||
|
browser tiers, in *different* ways, and neither of them fails.
|
||||||
|
|
||||||
|
- **`make ui-test`**: CDP's `Emulation.setEmulatedMedia` with a `hover`
|
||||||
|
feature does not reach the tier's iframe. The call succeeds and
|
||||||
|
`matchMedia('(hover: hover)')` still answers `true` afterwards. So
|
||||||
|
there is no way to render a component as a phone would and read the
|
||||||
|
computed style.
|
||||||
|
- **`make e2e`**: both projects are desktop (`Desktop Chrome`,
|
||||||
|
`Desktop Safari`), and the phone specs reach phone *width* with
|
||||||
|
`setViewportSize`, which changes no media feature but `width`. So the
|
||||||
|
phone specs run with `hover: hover` and the gate is never exercised.
|
||||||
|
|
||||||
|
What does work, and what the fix was verified with, is a second browser
|
||||||
|
context under a device descriptor: `chromium.newContext(devices['Pixel
|
||||||
|
5'])` reports `hover=false pointer:fine=false` and the button computes
|
||||||
|
`display: none`, against `flex` at 1440px. That is a one-off script, not
|
||||||
|
a spec — `isMobile` is Chromium-only, so it cannot become an e2e project
|
||||||
|
without losing the WebKit half.
|
||||||
|
|
||||||
|
`hover-affordance.test.ts` therefore asserts the *parsed stylesheet* —
|
||||||
|
that the reveal rule sits inside the media query — which catches the
|
||||||
|
regression that actually threatens it: someone hoisting the rule back out
|
||||||
|
as a tidy-up, a change nothing on a desktop renders differently.
|
||||||
|
|
||||||
|
Related: a width-gated decision **is** testable at both tiers, which is
|
||||||
|
why #61's phone mini player is a `matchMedia` stub in the component test
|
||||||
|
and needs nothing special.
|
||||||
|
|
||||||
|
## A default that is an *absent* key survives an existing seed (2026-08-19)
|
||||||
|
|
||||||
|
The skill warns that a seed freezes every default it has already
|
||||||
|
persisted, so changing one in `backend/config` is invisible against an
|
||||||
|
existing `YJ_HOME` while CI, which seeds by running the app, tests the
|
||||||
|
new one. That warning is about defaults stored as *values*.
|
||||||
|
|
||||||
|
#25's Autotag-hidden default is stored as the **absence of a key**:
|
||||||
|
`GeneralConfig.ViewVisibility` is a map, an id it does not mention takes
|
||||||
|
`backend/config.Views`' answer, and only what the user changed is ever
|
||||||
|
written. So a seed built before the feature existed showed the new
|
||||||
|
default immediately — verified against `.dev/seeds/default.tar`, whose
|
||||||
|
`config.toml` has no `[General.ViewVisibility]` table at all, and whose
|
||||||
|
sidebar came up without Autotag on the first launch of the new binary.
|
||||||
|
After toggling it on and off again the file carries exactly one line,
|
||||||
|
`autotag = false`.
|
||||||
|
|
||||||
|
The general form is worth keeping: **a default expressed as a zero value
|
||||||
|
needs a re-seed to observe; a default expressed as an absent key does
|
||||||
|
not**, and it needs no migration for existing installs either. It is the
|
||||||
|
same property that makes removing a view later free (an unknown key is
|
||||||
|
dropped on load), which is what the `#25 → #27` ordering on #73 rests on.
|
||||||
|
|
||||||
|
## A spec cannot assume a destination has a nav item (2026-08-19)
|
||||||
|
|
||||||
|
Since #25, `getByTestId('nav-<view>')` is not a reliable way to reach a
|
||||||
|
view: Autotag is hidden by default and Downloads is absent without a
|
||||||
|
download client, so four existing specs failed on a 30 s timeout waiting
|
||||||
|
for a locator that will never resolve. `navigateTo(page, view)` in
|
||||||
|
`e2e/support/fixtures.ts` dispatches the app's own `navigate` event
|
||||||
|
instead, which is what every nav item, card and detail view dispatches —
|
||||||
|
so it is the mechanism and not a test-only door.
|
||||||
|
|
||||||
|
Use the nav item when the *nav* is the subject, and `navigateTo` when
|
||||||
|
the view is.
|
||||||
|
|
||||||
|
## `config-section .header` is ambiguous once a job exists (2026-08-19)
|
||||||
|
|
||||||
|
#27 embeds `<job-panel>` inside four Settings sections, and a panel with
|
||||||
|
any job in it also mounts a `job-details-drawer` — whose own header
|
||||||
|
carries the class `.header`. So `config-page config-section .header`,
|
||||||
|
which `settings-reach.spec.ts` had used since plan 007, resolves to two
|
||||||
|
elements and fails Playwright's strict mode the moment a scan has run.
|
||||||
|
|
||||||
|
Two things follow. A spec asserting on a section's *disclosure* should
|
||||||
|
locate it by role and name (`getByRole('button', {name: heading})`) or
|
||||||
|
scope per section and take `.first()`, not by that class. And this is a
|
||||||
|
worked example of the more general trap: a class name is not a
|
||||||
|
selector's contract, and a component that embeds another inherits its
|
||||||
|
class names into every ancestor query.
|
||||||
|
|
||||||
|
It also only appears in a suite that has *done* something — the
|
||||||
|
sections are empty on a fresh app, so this cannot be reproduced by
|
||||||
|
opening Settings and looking.
|
||||||
|
|
||||||
|
**And it appears on the second engine, not the first.** CI runs
|
||||||
|
chromium then webkit against **one app**, so a spec that scans in the
|
||||||
|
chromium pass leaves a finished job the webkit pass then trips over.
|
||||||
|
Three specs used that selector; two failed locally and the third
|
||||||
|
(`failure-voice.spec.ts`) was green on chromium and red on webkit in
|
||||||
|
the same run. Reproducing it locally is running the suite twice against
|
||||||
|
one `make dev-headless` — which is worth doing for any change that
|
||||||
|
leaves state behind, since it is the only place a cross-engine order
|
||||||
|
dependency shows up.
|
||||||
|
|
||||||
|
## `scrollWidth` counts the left padding and not the right (measured 2026-08-20)
|
||||||
|
|
||||||
|
The obvious predicate for "does this flex row fit" is
|
||||||
|
`el.scrollWidth <= el.clientWidth`, and on a box with symmetric gutters
|
||||||
|
it **under-reports by one gutter**. `scrollWidth` is the extent of the
|
||||||
|
scrollable content area, which includes `padding-left` and excludes
|
||||||
|
`padding-right`; `clientWidth` includes both. So a child may end up to
|
||||||
|
`padding-right` past where content is allowed to go while the box
|
||||||
|
reports a perfect fit.
|
||||||
|
|
||||||
|
Measured on the top bar (`padding: 0 2em`) at 700x600 with a long-titled
|
||||||
|
scan staged: `clientWidth 700`, `scrollWidth 700` — and
|
||||||
|
`job-indicator`'s right edge at 700 against a content edge of 668, i.e.
|
||||||
|
sitting in the whole right gutter. `#143`'s first fix passed its own
|
||||||
|
measurement and left the indicator visibly jammed against the window
|
||||||
|
edge.
|
||||||
|
|
||||||
|
The predicate `services/top-bar-fit.ts` uses instead is the one its
|
||||||
|
spec asserts: no in-flow child's rect outside the parent's *content*
|
||||||
|
box, both edges, with half a pixel of slack for fractional flex widths.
|
||||||
|
|
||||||
|
This is the same family as #69's title trap — the measurement easiest to
|
||||||
|
reach for is the one that cannot see the failure — and it is worth
|
||||||
|
knowing before writing the next one of these: **the fit test and the
|
||||||
|
assertion that proves it should be the same test.** It was found only
|
||||||
|
because `top-bar-fit.spec.ts` measures per child rather than asserting
|
||||||
|
on the container, which is exactly why #69 needed
|
||||||
|
`header-action-overflow.spec.ts`.
|
||||||
|
|
||||||
|
## The top bar's overflow is 11px idle and 262px while working (measured 2026-08-20)
|
||||||
|
|
||||||
|
#143 was filed as "11px at 600x600" and re-measured as 171. Both are the
|
||||||
|
same defect seen with different jobs running: `job-indicator` is
|
||||||
|
`hidden` when idle, ~144px wide showing "Scanning Music", and **235px**
|
||||||
|
showing a real library's scan title ("Scanning Music from the external
|
||||||
|
drive"), because the label is capped at 12rem and gets there.
|
||||||
|
|
||||||
|
Swept against the running app with that job staged, `header.top-bar`
|
||||||
|
client vs scroll:
|
||||||
|
|
||||||
|
| width | idle | with the long-titled scan |
|
||||||
|
|---|---|---|
|
||||||
|
| 320, 390, 599 | fits | fits (the phone rules drop the filter and the label) |
|
||||||
|
| 600 | 611 | **862** |
|
||||||
|
| 700 | fits | 862 |
|
||||||
|
| 800 | fits | 862 |
|
||||||
|
| 899 | fits | 899 (fits) |
|
||||||
|
| 900 | fits | 946 |
|
||||||
|
| 1100, 1440 | fits | fits |
|
||||||
|
|
||||||
|
Two things worth keeping. The band is **600–610 idle and 600–900 while
|
||||||
|
working**, so "a narrow corner" and "the header is crowded from 900
|
||||||
|
down" are both true and the difference is entirely what is in flight —
|
||||||
|
which is the case a seeded, settled app can never show you. And 899
|
||||||
|
fits while 900 does not, because `nav-history` appears at 900: the worst
|
||||||
|
width for the header is not the narrowest one, the same way 900 rather
|
||||||
|
than 800 is the worst width for the content area.
|
||||||
|
|
||||||
|
Staging it is `/__test/emit` with a `JobsChanged` snapshot; a job with
|
||||||
|
`state: "running"` never completes, so it stays up until an empty
|
||||||
|
snapshot is emitted, which is what makes an idle re-measurement look
|
||||||
|
like the fix not working.
|
||||||
|
|
||||||
|
## Two repaint mechanisms, and neither is pinned alone (measured 2026-08-20)
|
||||||
|
|
||||||
|
`CLAUDE.md` already states the rule — *a virtualized list repaints only
|
||||||
|
when you tell it to, and the accidental way you were telling it may be
|
||||||
|
the thing you are about to delete* — found in `artists-view` and
|
||||||
|
`genres-view`. `queue-panel` is a second instance with numbers, and the
|
||||||
|
numbers are the part worth keeping.
|
||||||
|
|
||||||
|
It repaints its rows **two** ways:
|
||||||
|
|
||||||
|
- `onSelectionChanged()` calls `virtualizer.requestUpdate()`, which is
|
||||||
|
the intended one and the one `track-list` has always had;
|
||||||
|
- `.keyFunction=${(track) => track.id}` is a **per-render arrow**, so it
|
||||||
|
is a changed property on every host update and repaints the rows by
|
||||||
|
itself.
|
||||||
|
|
||||||
|
Removing *either* alone changes nothing observable. That is why #43
|
||||||
|
could not be settled by reading the code: the hypothesis in its Findings
|
||||||
|
(the repaint is missing) was checkable, false, and would have looked
|
||||||
|
identical either way.
|
||||||
|
|
||||||
|
Removing **both** does not break selection either — it delays it. Time
|
||||||
|
from click to `aria-selected`, three clicks each:
|
||||||
|
|
||||||
|
| build | ms to highlight |
|
||||||
|
|---|---|
|
||||||
|
| healthy | 5, 16, 17 |
|
||||||
|
| both mechanisms removed | 134, 3,866, 5,816 |
|
||||||
|
|
||||||
|
The highlight arrives on whatever unrelated render happens next (the
|
||||||
|
player's 1 Hz position report is the usual candidate). **Four seconds is
|
||||||
|
indistinguishable from broken to a user, and invisible to a spec** —
|
||||||
|
`expect.poll`'s default 5 s timeout passes the degraded build on every
|
||||||
|
assertion. `queue-selection.spec.ts` bounds its selection assertions at
|
||||||
|
500 ms for that reason, which is ~30x the healthy case and an order of
|
||||||
|
magnitude under the degraded one.
|
||||||
|
|
||||||
|
The general form, for the next spec about anything push-driven: **a poll
|
||||||
|
generous enough to be stable is generous enough to miss a latency
|
||||||
|
regression entirely.** If "late" is a failure mode worth having, the
|
||||||
|
timeout has to say so.
|
||||||
|
|
||||||
|
## A hit-scan says how much of a row is not selectable (measured 2026-08-20)
|
||||||
|
|
||||||
|
`explore-link` stops the click's propagation on purpose — "the row must
|
||||||
|
not also treat it as a selection" — so a click on a track, album or
|
||||||
|
artist *name* navigates and selects nothing. That is app-wide and
|
||||||
|
deliberate, and the useful question about any given list is how much of
|
||||||
|
its row it costs.
|
||||||
|
|
||||||
|
Asking `elementFromPoint` what is under each x across a row, at three
|
||||||
|
heights:
|
||||||
|
|
||||||
|
| list | link coverage |
|
||||||
|
|---|---|
|
||||||
|
| queue panel | 12% |
|
||||||
|
| track list | 21% |
|
||||||
|
|
||||||
|
This killed a fix in progress. #43 reads as "selection is broken in the
|
||||||
|
queue panel, and fine in the track list", the obvious mechanism is that
|
||||||
|
the queue's narrow rows are mostly name, and it is **wrong**: the panel
|
||||||
|
is *less* link-covered than the list it is being compared against. The
|
||||||
|
scan takes a minute and is worth running before demoting anybody's links
|
||||||
|
— `explore-album-details`'s tracklist (number / title / artist /
|
||||||
|
duration) is the one that plausibly *is* mostly link, and is the one
|
||||||
|
#5 is about to add selection to.
|
||||||
|
|
||||||
|
## A layout is still moving when a guard says it has arrived (measured 2026-08-20)
|
||||||
|
|
||||||
|
`album-dropdown.spec.ts` failed with `Expected 80, Received 10` twice
|
||||||
|
over two sessions, and #133 already strengthened its guard from
|
||||||
|
"scrollable at all" to "has at least the range the assertion needs".
|
||||||
|
That was necessary and could not be sufficient, and the reason is
|
||||||
|
structural rather than a matter of thresholds: **a guard and the write
|
||||||
|
it guards are separate CDP round trips**, so the page is free to
|
||||||
|
re-lay-out between them. Polling harder cannot close a window between
|
||||||
|
two moments; only removing the window can.
|
||||||
|
|
||||||
|
Measured directly, sampling `scrollHeight - clientHeight` on
|
||||||
|
`.grid-scroll-container` every frame across a 1440x900 → 900x600 resize,
|
||||||
|
three runs:
|
||||||
|
|
||||||
|
| t (ms) | range |
|
||||||
|
|---|---|
|
||||||
|
| 0 | 0 |
|
||||||
|
| 1 | **88** |
|
||||||
|
| 8–14 | 330 (settled) |
|
||||||
|
|
||||||
|
88 satisfies a guard asking for 80 and is not the settled value, so the
|
||||||
|
guard can pass while the grid is one layout pass from done. Under
|
||||||
|
full-suite load the transient is worse — the observed failure had 10 —
|
||||||
|
which is why it shows up on the second run of a suite and not in ten
|
||||||
|
consecutive runs of the file alone (0/10 both before and after the fix).
|
||||||
|
|
||||||
|
The shape to write instead: **one page-side call that performs the
|
||||||
|
action and returns what it observes**, with `expect.poll` retrying
|
||||||
|
*that*. `scrollTo()` sets `scrollTop` and returns `scrollTop`, so the
|
||||||
|
assertion is about what the grid did rather than about what it was
|
||||||
|
ready to do. `layout-overflow.spec.ts`'s sidebar probe already had the
|
||||||
|
fused half and was missing the retry; it has both now.
|
||||||
|
|
||||||
|
Worth generalising: a spec that resizes and then measures is asserting
|
||||||
|
about a moving target for the next dozen frames. Fuse, then poll.
|
||||||
|
|
||||||
|
## "The first N tracks" is not a way to ask for an ordinary one (2026-08-20)
|
||||||
|
|
||||||
|
`queue-selection.spec.ts` staged its queue from the first few rows of
|
||||||
|
`library.Library.GetTracks(0)` and clicked a track *name*, which
|
||||||
|
`explore-link` routes to that track's **album** page. Four tracks in the
|
||||||
|
fixture library have no album at all — `01 Tone A`, `02 Tone B`,
|
||||||
|
`Title Only`, `no-tags-at-all` — and a name with nothing to route to
|
||||||
|
renders as **plain text**, not as a link.
|
||||||
|
|
||||||
|
Two things follow, and the second is the sharper one.
|
||||||
|
|
||||||
|
**The order is the scan's.** `GetTracks` returns `audio_files.id` order,
|
||||||
|
i.e. the order the scan inserted rows, which depends on concurrency and
|
||||||
|
directory traversal. Locally the first eight are all from two proper
|
||||||
|
albums, so the spec passed twice over; CI rebuilds its seed with a real
|
||||||
|
scan, got a different eight, and failed on both engines. This is the
|
||||||
|
same family as "a seed freezes every default it has already persisted" —
|
||||||
|
the fixture library is not a list, it is a *set* with an incidental
|
||||||
|
order, and no spec should depend on that order.
|
||||||
|
|
||||||
|
**A loose locator hid it.** The row was located with
|
||||||
|
`.locator('.explore-link').first()`, and a row has two — the title and
|
||||||
|
the artist. When the title is plain text, `first()` silently resolves to
|
||||||
|
the **artist** link, so the click went somewhere real and the assertion
|
||||||
|
was about a destination the test had not exercised. `.track-title
|
||||||
|
.explore-link` is the locator that says which one it means; the loose
|
||||||
|
one turned a fixture problem into a mystery.
|
||||||
|
|
||||||
|
The general rule for this repo's fixture library: it is deliberately
|
||||||
|
full of edge cases (untagged, unicode, duplicates, extremes), so a spec
|
||||||
|
that wants an *ordinary* track has to **say so** — filter on the
|
||||||
|
property it depends on rather than slicing.
|
||||||
|
## A nested rule starting with an element name is dropped on the phone (2026-08-20)
|
||||||
|
|
||||||
|
`CLAUDE.md` records that the device renders in **Chrome 113**, which
|
||||||
|
does not have relaxed CSS nesting (Chrome 120). The consequence is
|
||||||
|
sharper than "some syntax is unavailable": a nested rule whose selector
|
||||||
|
begins with a bare identifier is not a parse error you would notice, it
|
||||||
|
is **silently dropped**.
|
||||||
|
|
||||||
|
Three such rules were live in `frontend/index.css`, all inside
|
||||||
|
`.bottom-bar`, and all therefore dead on the phone and only on the
|
||||||
|
phone:
|
||||||
|
|
||||||
|
```css
|
||||||
|
.bottom-bar {
|
||||||
|
#track-info { p { … } } /* the metadata's ellipsis */
|
||||||
|
now-playing { overflow: hidden; }
|
||||||
|
audio-player { margin: 0.5em 1em; }
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The first is the interesting one: it is the *ellipsis* on the bottom
|
||||||
|
bar's track title and artist, so on the device that text has never
|
||||||
|
truncated — the same class of fault as `now-playing`'s marquee, whose
|
||||||
|
`text-overflow` sat on the wrong box and had never produced an ellipsis
|
||||||
|
in any mode. Both are invisible to every assertion and visible in a
|
||||||
|
screenshot.
|
||||||
|
|
||||||
|
`& p`, `& now-playing`, `& audio-player` are valid in both, so the fix
|
||||||
|
is one character per rule. What is worth keeping is the rule of thumb:
|
||||||
|
**inside a nested block, always write `&`** — and note that a rule
|
||||||
|
inside `@media` is *not* nested, so `@media … { bottom-nav { … } }`
|
||||||
|
elsewhere in that file is fine and needs nothing.
|
||||||
|
|
||||||
|
`make css-check` does not catch this (it looks for backticks that end a
|
||||||
|
tagged template early). Filed as an issue: the check is the natural
|
||||||
|
place for it, being the same shape of trap — a silent, phone-only,
|
||||||
|
screenshot-only failure.
|
||||||
|
|
||||||
|
## Centring a bar costs the control in the middle of it (measured 2026-08-20)
|
||||||
|
|
||||||
|
#23 asks for the transport centred in the bottom bar. The obvious
|
||||||
|
implementation — make the outer two grid tracks the same width, so the
|
||||||
|
middle is centred by construction — is right, and the first cut of it
|
||||||
|
was a regression, because "the same width" was taken to mean *the
|
||||||
|
metadata's* width on both sides.
|
||||||
|
|
||||||
|
Measured at 800px, with the seek bar's own track:
|
||||||
|
|
||||||
|
| layout | seek track | transport column |
|
||||||
|
|---|---|---|
|
||||||
|
| `320px 1fr auto` (before) | 257 | 407 |
|
||||||
|
| both sides `--now-playing-width` | **61** | 179 |
|
||||||
|
| both sides `min(--now-playing-width, 25%)` | 246 | 364 |
|
||||||
|
|
||||||
|
At 200% text the middle row is worse still: 130 before, **0** with the
|
||||||
|
uncapped sides. Centring is free at 1440 and expensive at 800, so a
|
||||||
|
change checked only at a comfortable width looks perfect.
|
||||||
|
|
||||||
|
The general form: **a symmetric layout reserves space on the side that
|
||||||
|
does not need it.** The right-hand group here is ~141px (volume plus
|
||||||
|
the queue button) and was being given 320 to keep the arithmetic
|
||||||
|
symmetric. Cap the side tracks against the *bar*, not against their
|
||||||
|
content, and the middle gets the difference.
|
||||||
|
|
||||||
|
The spec that pins this is two assertions, not one, and that split is
|
||||||
|
deliberate: an uncapped build is *perfectly centred* and fails only the
|
||||||
|
seek-bar width, so a spec asserting centring alone would have passed
|
||||||
|
the regression.
|
||||||
|
|
||||||
|
## The phone's way into Now Playing was under the artwork (measured 2026-08-20)
|
||||||
|
|
||||||
|
`phone-shell.spec.ts`'s "opens the full-screen now playing" failed in CI
|
||||||
|
on both engines, three times across two branches that could not have
|
||||||
|
caused it, and passed on re-run each time. It was filed as a flake
|
||||||
|
(#150). It is not one: **it depends on which track is playing.**
|
||||||
|
|
||||||
|
`.expand` — the phone's only route into `<now-playing-view>` — is
|
||||||
|
`position: absolute; inset: 0` inside `.cover-art-wrapper`, and
|
||||||
|
`.cover-art` is a **later sibling**. Both have `z-index: auto`, so they
|
||||||
|
tie on paint order and the later one wins. With an `<img>` that costs
|
||||||
|
nothing; with no artwork the placeholder `wa-icon` renders and takes
|
||||||
|
every click aimed at the button underneath it.
|
||||||
|
|
||||||
|
Measured at 390px with `elementFromPoint` at the button's centre:
|
||||||
|
|
||||||
|
| playing track | hit test |
|
||||||
|
|---|---|
|
||||||
|
| has artwork | `button.expand` |
|
||||||
|
| no artwork | **`wa-icon`** |
|
||||||
|
| no artwork, with `z-index: 1` | `button.expand` |
|
||||||
|
|
||||||
|
So on a phone, the only way into the full-screen player stopped working
|
||||||
|
whenever the current song had no cover — and this has nothing to do with
|
||||||
|
the fixture: any library has untagged files.
|
||||||
|
|
||||||
|
Three things worth keeping.
|
||||||
|
|
||||||
|
**"Flaky in CI" was the wrong diagnosis and it cost three cycles.** The
|
||||||
|
spec starts the *first* row of the track list, so which track it plays
|
||||||
|
is the order the scan inserted rows in — the same root cause as #156,
|
||||||
|
one spec over. A test whose subject is a hit test has to *choose* the
|
||||||
|
case that breaks it.
|
||||||
|
|
||||||
|
**The first two hypotheses were both wrong, and both were plausible.**
|
||||||
|
A custom element's upgrade replacing its own contents, and the cover
|
||||||
|
preview's `mouseenter` opening a popup under the pointer. Neither
|
||||||
|
survived contact with `elementFromPoint`, which took a minute and would
|
||||||
|
have saved the other two cycles.
|
||||||
|
|
||||||
|
**And the spec that pins it needs the 90-second track**, because a
|
||||||
|
2-second one finishes before the assertions run — the trap
|
||||||
|
`fixtures.ts` already documents. Note the filter that does *not* work:
|
||||||
|
`library.Track.CoverArt` is empty for all 31 fixture rows, so "the
|
||||||
|
first track with no cover art" selects nothing in particular. The
|
||||||
|
placeholder's presence is asserted instead, which is the property the
|
||||||
|
test actually depends on.
|
||||||
|
|
||||||
|
## An activity recreation kills the process, deterministically (measured 2026-08-20)
|
||||||
|
|
||||||
|
#52's report was "sometimes crashes or restarts when reopened after
|
||||||
|
running in the background". Measured on a real device, the *fault* is
|
||||||
|
not intermittent at all — only its trigger is.
|
||||||
|
|
||||||
|
Device: Light Phone III (TLP301), Android 14 / SDK 34, arm64-v8a,
|
||||||
|
WebView **Chrome 113** at 424x439 CSS px. Debug build
|
||||||
|
(`app.yellowjacket.dev`), installed beside the released `v0.3.1` with
|
||||||
|
`install -r`.
|
||||||
|
|
||||||
|
**Conditional on the activity actually being recreated in a live
|
||||||
|
process, the process died 8 times out of 8** — 3 by hand, then 5/5 in a
|
||||||
|
scripted loop. The runs where it survived were runs where no recreation
|
||||||
|
happened (one `Wails bridge initialized` in the log rather than two), so
|
||||||
|
they are inconclusive rather than passes; a harness that does not check
|
||||||
|
for the second init reports those as green and reads as flakiness.
|
||||||
|
After the fix: 5/5 recreations survived, plus 6 background/foreground
|
||||||
|
cycles and 3 interleaved recreations on one pid.
|
||||||
|
|
||||||
|
The mechanism is three log lines:
|
||||||
|
|
||||||
|
```
|
||||||
|
12:47:56.159 I/WailsBridge(22956): Wails bridge initialized
|
||||||
|
12:48:38.898 I/WailsBridge(22956): Wails bridge initialized <- same pid
|
||||||
|
12:48:39.357 I/ActivityManager: Process app.yellowjacket.dev (pid 22956) has died: fg TOP
|
||||||
|
```
|
||||||
|
|
||||||
|
`nativeInit` runs `go mainFunc()` on every activity creation; the second
|
||||||
|
`main()` reaches `app.Run()`, which refuses because `a.starting` is
|
||||||
|
still true behind Android's `select{}`, and `os.Exit(1)` takes the whole
|
||||||
|
process — including the healthy first app — with it.
|
||||||
|
|
||||||
|
Four things worth keeping:
|
||||||
|
|
||||||
|
- **`has died: fg TOP` is not a memory kill.** The system does not
|
||||||
|
reclaim the foreground process. This reads as "the OS killed us",
|
||||||
|
which is the wrong hypothesis and the reason the issue sat unverified.
|
||||||
|
- **There is no crash record of any kind**: `logcat -b crash` empty, no
|
||||||
|
`AndroidRuntime`, no `libc: Fatal signal`, no tombstone. `os.Exit` is
|
||||||
|
not a crash. The one line that named the fault —
|
||||||
|
`slog.Error("application error", "err", ...)`, carrying
|
||||||
|
`"application is running or a previous run has failed"` — went to
|
||||||
|
`/dev/null`. That is #160.
|
||||||
|
- **"Don't keep activities" does not work on this device.**
|
||||||
|
`settings put global always_finish_activities 1` reads back as `1`,
|
||||||
|
`am set-always-finish-activities` does not exist on this build, and
|
||||||
|
the activity was never finished on backgrounding. The report's own
|
||||||
|
suggested lever is a dead end here. What *does* work, deterministically
|
||||||
|
and in one line, is a configuration change the manifest does not
|
||||||
|
declare: `adb shell settings put system font_scale 1.15`
|
||||||
|
(`AndroidManifest.xml` declares `orientation|screenSize|
|
||||||
|
keyboardHidden|uiMode`, so none of those are triggers).
|
||||||
|
- **Surviving is only half the property.** The recreated WebView has to
|
||||||
|
still be wired to the running app, which was verified by hooking
|
||||||
|
`window._wails.dispatchWailsEvent` and backgrounding/foregrounding:
|
||||||
|
`["IndexStatusChanged","JobsChanged","JobsChanged",
|
||||||
|
"android:storageAccess"]`. The tempting Java-side fix — making
|
||||||
|
`WailsBridge.initialized` static — passes the pid check and fails
|
||||||
|
this one, because `nativeInit` is also what re-points the JNI
|
||||||
|
reference at the new bridge.
|
||||||
|
|
||||||
|
## The Taskfile's device tasks uninstall the released app (2026-08-20)
|
||||||
|
|
||||||
|
`android:run:device` builds the **debug** variant
|
||||||
|
(`applicationIdSuffix ".dev"`) and then runs
|
||||||
|
`adb uninstall {{.APP_ID}}`, where `APP_ID` defaults to
|
||||||
|
`app.yellowjacket` — the **release** id. So it deletes the user's
|
||||||
|
installed app and its library, installs a different package, and then
|
||||||
|
fails to launch the one it removed. `deploy-device` carries the same
|
||||||
|
uninstall. Filed as #159; `android-tier.md` had been recommending
|
||||||
|
`run:device` as the way onto a device.
|
||||||
|
|
||||||
|
This is the hazard that file already names — "The identity is declared
|
||||||
|
twice ... **Nothing enforces that they agree**" — reached by a second
|
||||||
|
route: the two ids differ not because someone edited one, but because
|
||||||
|
the debug buildType suffixes it.
|
||||||
|
|
||||||
|
## The uninstall was there to make a bare `install` work (measured 2026-08-20)
|
||||||
|
|
||||||
|
Fixing #159 turned up *why* the `adb uninstall` was in all four tasks,
|
||||||
|
which the issue does not say and which decides whether it can simply be
|
||||||
|
deleted. The line under it was `adb install`, with **no `-r`** — and
|
||||||
|
Android refuses an install over an existing package without it. So the
|
||||||
|
uninstall was not a deliberate clean-slate step; it was the price of
|
||||||
|
the missing flag, paid on every run, and `install -r` removes the
|
||||||
|
reason for it rather than merely removing it.
|
||||||
|
|
||||||
|
That matters because "should the uninstall go at all" looked like a
|
||||||
|
trade — drop it and a signing-certificate change fails with
|
||||||
|
`INSTALL_FAILED_UPDATE_INCOMPATIBLE` instead of being handled. It is
|
||||||
|
not a trade: nothing else was relying on it. The certificate case is
|
||||||
|
reported with the command to run, which is what
|
||||||
|
`scripts/android-emulator.sh` already did for `make android-install`,
|
||||||
|
so this is one existing judgement applied consistently rather than a
|
||||||
|
new one.
|
||||||
|
|
||||||
|
## `wails3 task android:run` installs on a phone (measured 2026-08-20)
|
||||||
|
|
||||||
|
The emulator tasks (`run`, `deploy-emulator`) used a bare `adb install`
|
||||||
|
with no `-s`. adb with exactly one device attached uses that device
|
||||||
|
whatever kind it is, so with a phone plugged in and no emulator
|
||||||
|
running, the task whose summary reads "in the Android Emulator"
|
||||||
|
installed on the phone — and, before #159 was fixed, ran
|
||||||
|
`adb uninstall app.yellowjacket` against it first. The reported data
|
||||||
|
loss was reachable from the *emulator* task, which is not what the
|
||||||
|
issue describes and is worse, because nothing in the name warns you.
|
||||||
|
|
||||||
|
Measured after the fix, phone attached and emulator stopped:
|
||||||
|
|
||||||
|
```
|
||||||
|
$ ./scripts/android-deploy.sh --apk bin/yellowjacket.apk --target emulator
|
||||||
|
android-deploy: no emulator target is online.
|
||||||
|
LP3LHMA531900746 device
|
||||||
|
Start one with: make android-emulator
|
||||||
|
```
|
||||||
|
|
||||||
|
The general form: **a task that names a target has to say so to adb.**
|
||||||
|
The device tasks always filtered on `$1 !~ /^emulator-/`; the emulator
|
||||||
|
tasks filtered on nothing at all.
|
||||||
|
|
||||||
|
## The package id can be read back, and costs nothing (2026-08-20)
|
||||||
|
|
||||||
|
`aapt2 dump packagename <apk>` answers in one word and ~40 ms, from
|
||||||
|
`$ANDROID_HOME/build-tools/*/aapt2` (versioned, so resolved not
|
||||||
|
pinned); `aapt dump badging` is the fallback for older build-tools and
|
||||||
|
is what #159's own measurement used. That is cheap enough to do on
|
||||||
|
every deploy, which is what makes "the two ids agree by construction"
|
||||||
|
affordable rather than aspirational — the alternative considered was
|
||||||
|
giving the debug-flavoured tasks `APP_ID` + `.dev`, which is one line
|
||||||
|
and leaves the class of bug alive for the next flavour or suffix.
|
||||||
|
|
||||||
|
The guard runs **before** a target is chosen, deliberately: it is a
|
||||||
|
question about the artifact, so it can be exercised with nothing
|
||||||
|
plugged in, and a build whose id is wrong should be refused whether or
|
||||||
|
not there is anything to install it onto. That is what let the negative
|
||||||
|
test run safely with the user's phone attached:
|
||||||
|
|
||||||
|
```
|
||||||
|
$ ./scripts/android-deploy.sh --apk bin/yellowjacket.apk \
|
||||||
|
--target device --expect app.yellowjacket
|
||||||
|
android-pkgid: refusing to act on a package this APK does not declare.
|
||||||
|
the APK declares: app.yellowjacket.dev
|
||||||
|
the task expects: app.yellowjacket
|
||||||
|
rc=2
|
||||||
|
```
|
||||||
|
|
||||||
|
That is exactly #159's configuration — debug APK, release id, real
|
||||||
|
device — refused with no adb call made.
|
||||||
|
|
||||||
|
## `make android-emulator`'s boot wait can be satisfied by a phone (2026-08-20)
|
||||||
|
|
||||||
|
Noticed while booting the emulator for #159's verification, with a
|
||||||
|
phone also attached. `scripts/android-emulator.sh start` reported
|
||||||
|
`waiting for boot ok / android 14` about **eight seconds** after
|
||||||
|
launching the emulator, which had not appeared in `adb devices` yet —
|
||||||
|
`pick_device`'s last resort is "exactly one device online", and at that
|
||||||
|
moment the one online device was the phone. So it waited for the
|
||||||
|
phone's boot, found it long since booted, and returned. The emulator
|
||||||
|
took another ~10 s to come up.
|
||||||
|
|
||||||
|
Harmless here (the emulator was up before anything used it) and a
|
||||||
|
straightforward race otherwise: `start` should wait for a device that
|
||||||
|
is an emulator, not for whatever `pick_device` returns. Filed as #162.
|
||||||
|
|
||||||
|
## The Android runtime transport is not HTTP (measured 2026-08-20)
|
||||||
|
|
||||||
|
Found while trying to drive the phone for #53. `wails3` routes runtime
|
||||||
|
calls through `addJavascriptInterface` on Android, not through
|
||||||
|
`/wails/runtime` — the WebView cannot deliver a `fetch()` POST body to
|
||||||
|
`shouldInterceptRequest`, which the v3 source says in as many words
|
||||||
|
(`application_android.go`, "The Android transport"). The runtime
|
||||||
|
installs a `customTransport` over `window.wails.invokeAsync(id,
|
||||||
|
payload)` and takes the answer on `window._wailsAndroidCallback`.
|
||||||
|
|
||||||
|
Two things follow, and both cost time before the source was read:
|
||||||
|
|
||||||
|
- **`.playwright/init-events.js` does not transfer to the device.** Its
|
||||||
|
outbound half hooks `fetch`; a POST to `/wails/runtime` answers
|
||||||
|
`Invalid runtime call: missing object value`, which reads like a
|
||||||
|
wrong payload shape and is actually the interceptor receiving a URL
|
||||||
|
with no body at all. The payload shape was right the whole time. Its
|
||||||
|
*inbound* half is still correct, because `dispatchWailsEvent` is the
|
||||||
|
entry point in every mode.
|
||||||
|
- **Hooking `fetch` from an `eval` is too late on any platform.** The
|
||||||
|
bundle captured its reference at module scope, so a wrapper installed
|
||||||
|
afterwards records nothing — which is exactly why the harness is an
|
||||||
|
`initScript`. Measured: zero calls captured while the app was
|
||||||
|
demonstrably making them.
|
||||||
|
|
||||||
|
The working recipe is in `android-tier.md`; it chains the runtime's own
|
||||||
|
callback rather than replacing it, so its pending calls still resolve.
|
||||||
|
This is what makes the device a tier that can be *driven*.
|
||||||
|
|
||||||
|
## #53's frontend is byte-identical to the build it was reported against (2026-08-20)
|
||||||
|
|
||||||
|
`git diff v0.3.1 HEAD -- frontend/src/components/audio-player/seekbar/
|
||||||
|
frontend/src/store/player-store.ts` is **empty**; the whole diff in that
|
||||||
|
area is `backend/player/`. The phone carries the released `v0.3.1`, so
|
||||||
|
whatever #53 saw, the component was not what changed — and v0.4.0 is
|
||||||
|
where the player audit (#122–#127) landed.
|
||||||
|
|
||||||
|
Measured on that phone, current `main`, with a synthesised 4-minute
|
||||||
|
track: the Now Playing seek bar tracks correctly when mounted
|
||||||
|
mid-playback (`seekValue` 28 of 240), when the view is opened before
|
||||||
|
playback starts, after a tap on the track, and across an activity
|
||||||
|
recreation (same pid, bar resumes at 30 → 35). The issue's stated
|
||||||
|
symptom did not reproduce in any of them.
|
||||||
|
|
||||||
|
Reverting **only** `backend/player/` to v0.3.1 — the frontend and
|
||||||
|
everything else at HEAD — does reproduce a real position defect on the
|
||||||
|
same device: six seconds into a 20-second file with no database row,
|
||||||
|
played after a 240-second one, the bar read **01:27 of 240**. That is
|
||||||
|
#125's stale `trackLengthMs` ("cleared only by UnloadTrack, so a file
|
||||||
|
with no row inherited the previous track's duration"), and it is fixed
|
||||||
|
at HEAD. Note the *shape* of it: the fraction is roughly right and the
|
||||||
|
absolute numbers are wrong, so it presents as a clock that lies rather
|
||||||
|
than as a handle that will not move.
|
||||||
|
|
||||||
|
The one-line experiment is worth remembering: v0.3.1's `backend/player`
|
||||||
|
compiles against HEAD with a single shim
|
||||||
|
(`SetPlaybackFinishedHandler` gained a `srcErr error` parameter), which
|
||||||
|
makes "did the backend fix cause this" a ten-minute question instead of
|
||||||
|
a full checkout.
|
||||||
|
|||||||
@@ -0,0 +1,327 @@
|
|||||||
|
# 018 — Supported sizes, and what the queue panel is
|
||||||
|
|
||||||
|
**Issue:** #24 (`Area/Shell-Nav`, `Priority/High`, `Reviewed/Confirmed`)
|
||||||
|
**Unblocks:** #55 (queue as a screen) — a real Gitea dependency
|
||||||
|
**Relates:** #69 (page-header overflow), #12 (mini-player), #51 (small-screen umbrella)
|
||||||
|
**Status:** complete — #24 shipped as PR #132, and the matrix's last
|
||||||
|
unkept promise closed with #69.
|
||||||
|
|
||||||
|
#73 puts this first in Phase 2 and hangs the rest of the phase off it,
|
||||||
|
so the decision has to be written down and arguable before any CSS
|
||||||
|
moves. This document is the decision. Everything below the matrix is
|
||||||
|
either a measurement or an argument for one of the four choices #24
|
||||||
|
asks for.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## What is actually wrong, measured
|
||||||
|
|
||||||
|
Against the running app (`make dev-headless SEED=default`, Chromium),
|
||||||
|
Playlists, sweeping the viewport with the queue open and closed. The
|
||||||
|
number that matters is how much of the page header survives.
|
||||||
|
|
||||||
|
| viewport | sidebar | queue | main panel | header needs | actions clipped |
|
||||||
|
|---|---|---|---|---|---|
|
||||||
|
| 1280×800 | 200 | open 321 | 759 | 759 | — |
|
||||||
|
| 1000×700 | 200 | open 321 | 479 | 747 | New Playlist, New Smart Playlist |
|
||||||
|
| **900×600** | 200 | open 321 | **379** | 747 | **all three** |
|
||||||
|
| 800×600 | 56 | open 321 | 423 | 747 | all three |
|
||||||
|
| 700×600 | 56 | open 321 | 323 | 747 | all three |
|
||||||
|
| 390×780 | — | open 321 | **69** | 747 | all three |
|
||||||
|
| 320×600 | — | open 321 | **0** | 747 | all three |
|
||||||
|
| 900×600 | 200 | closed | 700 | 747 | New Smart Playlist |
|
||||||
|
| **800×600** | 56 | closed | 744 | 747 | **New Smart Playlist (158/162px)** |
|
||||||
|
| 320×600 | — | closed | 320 | 747 | all three |
|
||||||
|
|
||||||
|
Five things in that table are not in the issue.
|
||||||
|
|
||||||
|
**The header clips at the supported minimum with the queue closed.**
|
||||||
|
At 800×600 — the size `backend/config/window.go` enforces and the only
|
||||||
|
size this app *promises* — "New Smart Playlist" loses 4px of its 162.
|
||||||
|
#24 reads as a queue-panel bug; the queue makes it dramatic, but the
|
||||||
|
header overflows on its own at the minimum window.
|
||||||
|
|
||||||
|
**900×600 is worse than 800×600, because the sidebar expands at 900.**
|
||||||
|
`AUTO_COLLAPSE_VIEWPORT` collapses the sidebar to icons *below* 900, so
|
||||||
|
at 899px the main panel is 843px and at 900px it is 700px. The worst
|
||||||
|
desktop case is therefore not the minimum window; it is the pixel
|
||||||
|
immediately above the collapse. Anything that tests "the minimum" and
|
||||||
|
stops has not tested the worst case, which is what
|
||||||
|
`layout-overflow.spec.ts` does today.
|
||||||
|
|
||||||
|
**At phone widths the queue is not a drawer, it is an amputation.**
|
||||||
|
`queue-panel`'s host is `flex-shrink: 0; width: 0`, going to
|
||||||
|
`width: var(--queue-width, 320px)` under `[open]` — it is *in the flow*
|
||||||
|
of `.content-area`, so it takes its width from the main panel rather
|
||||||
|
than covering it. At 390px that leaves 69px of the page; at 320px it
|
||||||
|
leaves **0px**, and the app is not degraded but gone. This is the
|
||||||
|
measurement #55 needs and did not have.
|
||||||
|
|
||||||
|
**Only Playlists overflows.** Sweeping all ten primary views at 900×600
|
||||||
|
and at 390×780, every other header reports `scrollWidth ==
|
||||||
|
clientWidth`, and Albums at 390px renders title, count and sort
|
||||||
|
legibly (checked on a screenshot, not just the number). #69 is
|
||||||
|
therefore one view's action set — three text buttons totalling 390px —
|
||||||
|
and not a systemic header failure, though the *rule* still belongs in
|
||||||
|
`page-header`.
|
||||||
|
|
||||||
|
**Both reasons in `MinWidth`'s comment are stale.** It says the floor is
|
||||||
|
800×600 because "below ~780 the header's subtitle wraps" and "below
|
||||||
|
~600 tall the eleven sidebar items no longer fit". The subtitle is
|
||||||
|
`display: none` below 900 (index.css), and the sidebar host is
|
||||||
|
`overflow-y: auto` — at 600×460 its `scrollHeight` is 434 against a
|
||||||
|
332px client, and Settings is reachable after scrolling. Neither
|
||||||
|
mechanism can happen any more. That does not mean the floor should
|
||||||
|
move; it means its stated reason no longer supports it, which is worse
|
||||||
|
than either answer.
|
||||||
|
|
||||||
|
*(Care needed: my first probe for the sidebar scroller searched
|
||||||
|
`shadowRoot.querySelectorAll('*')` and reported "items are
|
||||||
|
unreachable", because the scroller is the **host** and a host is not in
|
||||||
|
its own shadow root. The claim in CLAUDE.md is correct.)*
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Decision 1 — the supported size matrix
|
||||||
|
|
||||||
|
Three bands. Two of them already exist and are already argued; what is
|
||||||
|
new is that they are written down as a *promise*, and that the queue is
|
||||||
|
part of it.
|
||||||
|
|
||||||
|
| band | width | navigation | queue | promise |
|
||||||
|
|---|---|---|---|---|
|
||||||
|
| **Phone** | < 600 | `bottom-nav` + drawer | overlay, full width | reflows; nothing needs sideways scrolling; fits 320px |
|
||||||
|
| **Compact** | 600 – 899 | icon sidebar | overlay + scrim | nothing is clipped or unreachable at any width in the band |
|
||||||
|
| **Desktop** | ≥ 900 | labelled sidebar | inline where it fits (see decision 2), else overlay | as Compact |
|
||||||
|
|
||||||
|
And one promise across all three: **no action is ever unreachable.**
|
||||||
|
That is the sentence #69 asks for and it is the one the matrix exists
|
||||||
|
to make checkable.
|
||||||
|
|
||||||
|
**400% zoom** keeps the meaning it already has: WCAG 1.4.10 names 320px
|
||||||
|
as the reflow target, the phone band covers it, and
|
||||||
|
`layout-overflow.spec.ts` already asserts a 320px viewport needs no
|
||||||
|
sideways scrolling. What changes is that the *queue* must be part of
|
||||||
|
that assertion — it is not today, and with the queue open at 320px the
|
||||||
|
main panel is 0px wide, which no current test can see.
|
||||||
|
|
||||||
|
**The window minimum stays 800×600**, and its comment gets the real
|
||||||
|
reason. The old mechanisms are gone, but the floor is still where the
|
||||||
|
Compact band's chrome stops being comfortable, and lowering it would
|
||||||
|
mean promising the desktop layout at sizes where only the phone layout
|
||||||
|
works. The interesting consequence is decision 4.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Decision 2 — the queue is an overlay when it cannot afford to be a column
|
||||||
|
|
||||||
|
**The rule.** The queue panel renders inline — in the flow, as today —
|
||||||
|
only while
|
||||||
|
|
||||||
|
```
|
||||||
|
viewport − sidebar − queueWidth ≥ 480
|
||||||
|
```
|
||||||
|
|
||||||
|
and as an overlay with a scrim otherwise.
|
||||||
|
|
||||||
|
**Why it cannot be a media query**, which is the load-bearing half:
|
||||||
|
the queue's width is *user state*. It is drag-resizable between 200 and
|
||||||
|
500px and persisted (`--queue-width`, `MIN_WIDTH`/`MAX_WIDTH` in
|
||||||
|
`queue-panel.ts`). A breakpoint at a fixed viewport width silently
|
||||||
|
assumes the default 320, and is wrong by 180px for a user who has
|
||||||
|
dragged the panel wide — in the direction that hurts, since a wider
|
||||||
|
queue is exactly when the content can least afford it. So the mode is
|
||||||
|
computed from the measured widths and published as an attribute, the
|
||||||
|
way `data-active-view` already is, and the CSS keys off that.
|
||||||
|
|
||||||
|
**Why 480, honestly.** There is no cliff to derive it from. The track
|
||||||
|
list rescales its columns continuously — at main widths from 900 down
|
||||||
|
to 544 its `--grid-cols` shrink from 213px to 124px with
|
||||||
|
`rowOverflow=0` throughout — and the album grid steps 3 columns to 2
|
||||||
|
somewhere between 564 and 644 without breaking. So this is a judgement,
|
||||||
|
anchored on two things: it keeps the *default* window (1100 wide, main
|
||||||
|
= 580) inline, because the inline queue is a desktop affordance people
|
||||||
|
choose and turning it into an overlay for the common case would be a
|
||||||
|
regression in feel; and it puts every case measured as broken —
|
||||||
|
900×600 at main=379, and every phone width — on the overlay side.
|
||||||
|
1024×768 lands at main=504 and stays inline.
|
||||||
|
|
||||||
|
**The scrim is the other half of the issue's complaint** ("make the
|
||||||
|
queue obviously an overlay *over* the content so it reads as something
|
||||||
|
to close"). An overlay queue gets a scrim, closes on scrim click and on
|
||||||
|
Escape, and returns focus to `#queue-button`.
|
||||||
|
|
||||||
|
**What must not change**: #55's Direction is explicit — one component,
|
||||||
|
two mount points, do not fork it. The overlay is a *presentation* of
|
||||||
|
the same `queue-panel`, so the roving tab stop, Alt+Arrow reorder, drag
|
||||||
|
reorder, selection semantics and the `virtualizer.requestUpdate()` on
|
||||||
|
selection and current-track change all come along untouched. This
|
||||||
|
decision deliberately stops short of #55's detail-view mount, but it is
|
||||||
|
the shape that makes it possible, and it unblocks it.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Decision 3 — #69 is its own PR, and here is the finding that decides it
|
||||||
|
|
||||||
|
`page-header` **cannot collapse its own actions**, and that is not an
|
||||||
|
effort estimate but a fact about the API. Actions arrive through
|
||||||
|
`<slot name="actions">` as arbitrary light-DOM markup — Playlists slots
|
||||||
|
a `<div class="header-actions">` of three `<button>`s with click
|
||||||
|
handlers, drag handlers and a conditional class. A component cannot
|
||||||
|
move another component's light-DOM children into a dropdown and keep
|
||||||
|
their behaviour; there is nothing generic to render as a menu item.
|
||||||
|
|
||||||
|
So the overflow rule needs an *actions API* — hosts declaring
|
||||||
|
`{icon, label, handler, priority}` data that `page-header` can render
|
||||||
|
either as buttons or as menu items — which is a change to all three
|
||||||
|
hosts that slot actions, not a rule added in one place. That is a
|
||||||
|
different piece of work from this one, it is independently verifiable,
|
||||||
|
and the desktop half of #69's symptom is removed by decision 2 anyway
|
||||||
|
(the queue stops eating the header's width).
|
||||||
|
|
||||||
|
It therefore stays #69, gets the finding above recorded on it, and
|
||||||
|
follows immediately after this. What *this* plan owes it is the
|
||||||
|
promise in the matrix — no action unreachable at any supported size —
|
||||||
|
and the measurement that the only offender today is Playlists.
|
||||||
|
|
||||||
|
**And the promise is not kept yet, which is the honest version of a
|
||||||
|
claim this document made in its first draft.** "Decision 2 removes the
|
||||||
|
desktop half of #69's symptom" was too strong. Measured after phase 2,
|
||||||
|
at 900×600 on Playlists:
|
||||||
|
|
||||||
|
| | before | after |
|
||||||
|
|---|---|---|
|
||||||
|
| queue open | main 379px, **all three** actions clipped | main 700px, **one** clipped |
|
||||||
|
| queue closed | main 700px, one clipped | unchanged |
|
||||||
|
|
||||||
|
So the queue's *contribution* is gone — open and closed are now
|
||||||
|
identical, which is the whole of what this decision owed — and the
|
||||||
|
residual "New Smart Playlist: 114/162px" is the header overflowing on
|
||||||
|
its own, at a size the queue never touched. #69 is still a live defect
|
||||||
|
at a supported size, and the matrix's promise is what will close it.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Decision 4 — a very small window becomes the phone layout, not the mini-player
|
||||||
|
|
||||||
|
#24 asks whether a very small window should switch to the mini-player
|
||||||
|
(#12) "or simply refuse to go there". Both options in the question are
|
||||||
|
worse than the one the codebase already has.
|
||||||
|
|
||||||
|
**#12 is a second window, not a mode.** Its findings say so: v3
|
||||||
|
supports multiple windows, `AlwaysOnTop` is a window *option*, and the
|
||||||
|
frontend would need an entry branch mounting only the mini-player root
|
||||||
|
for a second window loading the same bundle. Turning the main window
|
||||||
|
into a mini-player at some width conflates the two: it would throw away
|
||||||
|
the user's navigation state on a resize, and it puts the MPRIS question
|
||||||
|
(#12's own open question — media controls are process-level and must
|
||||||
|
not be per-window) on a code path that a drag can trigger by accident.
|
||||||
|
|
||||||
|
**And "refuses" is unnecessary, because the reflow already exists.**
|
||||||
|
The phone band is real, tested, and reached by width alone — a desktop
|
||||||
|
window narrowed below 600px already gets `bottom-nav` and the phone
|
||||||
|
shell. That is a better answer than refusing: it is strictly more
|
||||||
|
usable than a hard minimum, it costs nothing new, and it is the same
|
||||||
|
code Android runs, so it stays exercised.
|
||||||
|
|
||||||
|
So: the main window reflows and never becomes a mini-player; #12 stays
|
||||||
|
a separate always-on-top window and is not blocked by, or coupled to,
|
||||||
|
this decision. The window minimum stays 800×600 for the reason in
|
||||||
|
decision 1 — but the phone band is what happens below it, not a
|
||||||
|
refusal, which is why the minimum is a comfort floor rather than a
|
||||||
|
correctness one.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phases
|
||||||
|
|
||||||
|
1. **This document**, linked from #24, with the matrix reported on the
|
||||||
|
issue and #55 told whether it is unblocked. *(no code)* — **done**
|
||||||
|
2. **The queue's overlay mode** — computed mode attribute, scrim,
|
||||||
|
Escape and scrim-click close, focus return. The inline path is
|
||||||
|
unchanged above the threshold. — **done**
|
||||||
|
3. **The window minimum's comment** — replace both stale reasons with
|
||||||
|
the measured ones. No value change. — **done**
|
||||||
|
4. **Verification**, below. Including the specs that must change
|
||||||
|
because they assert the old behaviour. — **done**
|
||||||
|
|
||||||
|
#69 follows as its own branch; #55 became unblocked at phase 2.
|
||||||
|
|
||||||
|
## What landed, measured
|
||||||
|
|
||||||
|
Main panel width with the queue open, before and after:
|
||||||
|
|
||||||
|
| viewport | before | after | mode |
|
||||||
|
|---|---|---|---|
|
||||||
|
| 1280×800 | 759 | 759 | inline |
|
||||||
|
| 1100×720 (default window) | 579 | 579 | inline |
|
||||||
|
| 1024×768 | 503 | 503 | inline |
|
||||||
|
| 900×600 | **379** | **700** | overlay |
|
||||||
|
| 800×600 | 423 | 744 | overlay |
|
||||||
|
| 390×780 | **69** | **390** | overlay |
|
||||||
|
| 320×600 | **0** | **320** | overlay |
|
||||||
|
|
||||||
|
The scrim is perceptible but subtle on a dark ramp, which is worth
|
||||||
|
knowing before someone "fixes" it: sampled from the screenshots at
|
||||||
|
900×600, the main panel's background goes 33,37,41 → 18,20,23 and a
|
||||||
|
row's text 242 → 133. It covers the **content area only** — not the
|
||||||
|
sidebar or the transport — on purpose: the queue is not modal, and
|
||||||
|
leaving the navigation live means the scrim reads as "this is over the
|
||||||
|
content" (which is what #24 asked for) without pretending the rest of
|
||||||
|
the app is unavailable.
|
||||||
|
|
||||||
|
## What #69 did with the promise, and one thing this plan got wrong
|
||||||
|
|
||||||
|
#69 landed on its own branch as decision 3 said it would, and the
|
||||||
|
matrix's *no action is ever unreachable at any supported size* is now
|
||||||
|
kept rather than promised. Measured on Playlists, actions clipped:
|
||||||
|
|
||||||
|
| viewport | before #24 | after #24 | after #69 |
|
||||||
|
|---|---|---|---|
|
||||||
|
| 900×600, queue open | all three | one (114/162px) | none |
|
||||||
|
| 900×600, queue closed | one | one | none |
|
||||||
|
| 800×600, queue closed | one (158/162px) | one | none |
|
||||||
|
| 390×780 | all three | all three | none |
|
||||||
|
| 320×600 | all three | all three | none |
|
||||||
|
|
||||||
|
The shape was the one decision 3 predicted — an actions API first, an
|
||||||
|
overflow rule second — and all three hosts that slot actions migrated.
|
||||||
|
|
||||||
|
**What this document got wrong is smaller and worth keeping.** Decision
|
||||||
|
1 says the header's minimum is a *comfort* floor and that only the
|
||||||
|
queue and the actions compete for the header's width. They are not the
|
||||||
|
only two: every child of that flex row was `flex-shrink: 0`, so
|
||||||
|
whatever came last lost, and the actions come last. At 320px the sort
|
||||||
|
control alone is 172px of the header — so with every action already
|
||||||
|
collapsed into the menu, the *menu button* was 76px off the right edge.
|
||||||
|
The promise was still broken with nothing left to collapse.
|
||||||
|
|
||||||
|
That is why #69 also had to decide what gives way: the title (which the
|
||||||
|
navigation also states) and, below 600px, the word "Sort:" (which the
|
||||||
|
direction arrow implies). Neither is an action, which is the rule the
|
||||||
|
matrix actually encodes — **an action is a capability and everything
|
||||||
|
else on that row is a label.**
|
||||||
|
|
||||||
|
## Verification, and what each tier cannot see
|
||||||
|
|
||||||
|
- `make ui-test` — the queue panel's mode logic is component-tier
|
||||||
|
work and belongs there. It **cannot** see the shell: the threshold is
|
||||||
|
computed from the sidebar and viewport, which do not exist in that
|
||||||
|
tier.
|
||||||
|
- `make e2e` — `layout-overflow.spec.ts` gains the queue-open case at
|
||||||
|
every band (it has none today, which is why main=0px at 320px has
|
||||||
|
never failed anything) and **gains 900×600**, since the minimum is
|
||||||
|
not the worst case. `queue-toggle-state.spec.ts` and
|
||||||
|
`phone-shell.spec.ts` both touch the panel and must be re-read before
|
||||||
|
editing.
|
||||||
|
- **Screenshots at every band, read by a human.** This is not optional
|
||||||
|
here: `layout-overflow.spec.ts` asserts the *shell* needs no sideways
|
||||||
|
scrolling and passes on a build whose album header clips its own
|
||||||
|
buttons (measured this session at 390px; filed on #66). Clipping
|
||||||
|
*inside* a component is invisible to it, and clipping is this issue.
|
||||||
|
- `make ui-visual` **cannot help at all** — the component tier renders
|
||||||
|
the token fallbacks, because the theme only reaches `:root` in the
|
||||||
|
real app.
|
||||||
|
- Accessible names via `page.getByRole(...)`, never a shadow-root
|
||||||
|
query. A drawer with a scrim is exactly the shape that grows a
|
||||||
|
nameless control, and this repo has shipped one three times.
|
||||||
@@ -317,6 +317,60 @@ stacking dialogs. Window state moved off that path entirely, onto a
|
|||||||
window still exists and `OnShutdown` has neither a context nor a
|
window still exists and `OnShutdown` has neither a context nor a
|
||||||
window.
|
window.
|
||||||
|
|
||||||
|
**An activity is a view onto the process, and `main()` runs once per
|
||||||
|
process.** On Android the Wails entry point is `nativeInit`, which
|
||||||
|
`MainActivity.onCreate` calls — and it does two things: it re-points the
|
||||||
|
native library's global JNI reference at the calling `WailsBridge`, and
|
||||||
|
it runs `go mainFunc()`. Android destroys and recreates an activity
|
||||||
|
**without restarting the process** (a configuration change the manifest
|
||||||
|
does not declare, memory pressure, or every background under "Don't keep
|
||||||
|
activities"), so `main()` ran again on a live app. `application.New`
|
||||||
|
returns the *existing* app rather than building a second one,
|
||||||
|
`app.Run()` then refuses — `a.starting` is still true, because Android's
|
||||||
|
`platformRun` is `select{}` and never returns — and the `os.Exit(1)`
|
||||||
|
under that error took the **first**, healthy app down with it: its
|
||||||
|
database, its queue, and the audio a `mediaPlayback` foreground service
|
||||||
|
was holding the process alive to play. `mainStarted` latches it, first
|
||||||
|
statement in `main()`.
|
||||||
|
|
||||||
|
Four things about it are load-bearing.
|
||||||
|
|
||||||
|
**The answer to "restore the session or cold-start" is settled by
|
||||||
|
playback, not by preference.** The audio lives in the Go process, so a
|
||||||
|
cold start on every activity recreation would stop the music mid-song —
|
||||||
|
which is the exact thing the foreground service exists to prevent. The
|
||||||
|
activity is a view; the app is the process. The frontend already
|
||||||
|
cooperates, because a recreated WebView loads the page fresh and fetches
|
||||||
|
its state from a backend that never went away.
|
||||||
|
|
||||||
|
**Returning early is not a degraded mode, and that is why the latch is
|
||||||
|
in Go rather than in Java.** The obvious fix — making
|
||||||
|
`WailsBridge.initialized` `static`, so the second `nativeInit` is
|
||||||
|
skipped — keeps the process alive and silently breaks the app, because
|
||||||
|
skipping `nativeInit` skips the reference re-point too: Go would keep
|
||||||
|
executing JavaScript against the *destroyed* activity's WebView, and the
|
||||||
|
app would open, render, and never receive another backend event. The
|
||||||
|
latch lets `nativeInit` do its first job and declines only its second.
|
||||||
|
|
||||||
|
**`ServiceShutdown` has never run on Android**, and nothing should be
|
||||||
|
built on the assumption that it will. `App.Quit()` reaches an
|
||||||
|
`androidApp.destroy()` that is an empty method, and `Run()`'s deferred
|
||||||
|
`shutdownServices()` cannot fire behind `select{}`. Durability on this
|
||||||
|
platform is the persist writers, which submit on every mutation rather
|
||||||
|
than at exit — which is also why `MainActivity.onDestroy` no longer
|
||||||
|
calls `bridge.shutdown()`: the activity going away is not the app
|
||||||
|
shutting down, and there is no callback for the process going away
|
||||||
|
because Android simply kills it.
|
||||||
|
|
||||||
|
**No tier here can see any of this**, so the guard is split. A source
|
||||||
|
sweep (`TestMainClaimsBeforeItDoesAnything`) asserts the latch is the
|
||||||
|
*first* statement of `main()` — the failure it exists for is not
|
||||||
|
deletion, which is loud, but a line creeping in above it, since a second
|
||||||
|
`NewYellowJacketApp` opens the SQLite database again on every
|
||||||
|
recreation. The rest is a documented device check in
|
||||||
|
`.pi/skills/yellowjacket-dev/references/android-tier.md`, with the
|
||||||
|
logcat signature and a one-line way to force a recreation.
|
||||||
|
|
||||||
`internalServiceMethods` auto-excludes `ServiceStartup`,
|
`internalServiceMethods` auto-excludes `ServiceStartup`,
|
||||||
`ServiceShutdown`, `ServiceName` and `ServeHTTP` from bindings, so this
|
`ServiceShutdown`, `ServiceName` and `ServeHTTP` from bindings, so this
|
||||||
shape **removed** 12 spurious bindings and the bogus `context` model
|
shape **removed** 12 spurious bindings and the bogus `context` model
|
||||||
@@ -514,6 +568,36 @@ rather than renaming them.
|
|||||||
the autotag apply are registered; anything that is not registered has
|
the autotag apply are registered; anything that is not registered has
|
||||||
none of that, which is exactly how the three gaps the audit found
|
none of that, which is exactly how the three gaps the audit found
|
||||||
came about.
|
came about.
|
||||||
|
|
||||||
|
**Its rows are shown where the work is started, not on a page of
|
||||||
|
their own.** #27 folded the Jobs destination away, and the shape it
|
||||||
|
folded into is `<job-panel kinds="…">` embedded four times — scans in
|
||||||
|
Settings → Libraries, index and enrichment in Settings → Search
|
||||||
|
Index, downloads under the download clients, the autotag apply in
|
||||||
|
`autotag-view`. One "Background jobs" section in Settings was the
|
||||||
|
obvious reading of the report and is the tab again under another
|
||||||
|
name.
|
||||||
|
|
||||||
|
Four things about it are load-bearing. **Four of the five kinds
|
||||||
|
already had a home** that showed their work — the tier list, the
|
||||||
|
download list, the apply ring — and what none of them had is the
|
||||||
|
*generic* affordances, so the panel carries pause, cancel, Details
|
||||||
|
and the log to each rather than replacing what is there. **The
|
||||||
|
controls are `applyJobControl`**, not a reimplementation, which is
|
||||||
|
what keeps the "you will discard hours of downloading" confirmation
|
||||||
|
alive: it is keyed on `KindIndexBuild` inside the shared handler, and
|
||||||
|
a host drawing its own buttons would drop it silently. **A panel with
|
||||||
|
nothing to say is `hidden`**, host margin included, because an idle
|
||||||
|
panel in four places is four pieces of furniture describing an
|
||||||
|
absence. And **there is no "Clear finished"** in it, because
|
||||||
|
`ClearFinishedJobs` is global — a Clear under Libraries would discard
|
||||||
|
the index build's history too; a finished row dismisses itself.
|
||||||
|
|
||||||
|
The header `job-indicator` is untouched and is still the one view of
|
||||||
|
everything at once, from every page. One consequence worth knowing
|
||||||
|
before writing a spec: a section holding a `job-panel` also holds a
|
||||||
|
`job-details-drawer`, whose own header carries `.header` — so
|
||||||
|
`config-section .header` is ambiguous the moment a job exists.
|
||||||
- `config` — TOML-based settings. Settings page uses HTMX + templ for server-rendered HTML fragments.
|
- `config` — TOML-based settings. Settings page uses HTMX + templ for server-rendered HTML fragments.
|
||||||
- `playlist` / `smartplaylist` — Playlist CRUD and rule-based smart playlists.
|
- `playlist` / `smartplaylist` — Playlist CRUD and rule-based smart playlists.
|
||||||
- `mediacontrols` — OS media controls behind one `Handler`: MPRIS over
|
- `mediacontrols` — OS media controls behind one `Handler`: MPRIS over
|
||||||
@@ -945,13 +1029,167 @@ change at all.
|
|||||||
|
|
||||||
Two rules hold it up. The **first** navigation *replaces* the launch
|
Two rules hold it up. The **first** navigation *replaces* the launch
|
||||||
entry rather than pushing one, or every launch costs a back press before
|
entry rather than pushing one, or every launch costs a back press before
|
||||||
the app will close. And the in-app back buttons (`navigate-back`, fired
|
the app will close. **There are two launch navigations**, which is what
|
||||||
|
defeated that rule for five phases: the eager `navigate → home` at the
|
||||||
|
foot of `index.ts` and the configured page `GetDefaultPage()` resolves
|
||||||
|
to later. Only the first replaced, so a fresh session was already one
|
||||||
|
entry deep, the first back press replayed home over home, and on Android
|
||||||
|
`canGoBack()` was true so the press that should have exited the app did
|
||||||
|
nothing (#142). The landing-page navigation carries `_replace`, honoured
|
||||||
|
only while still at index 0 — past that the user has navigated during
|
||||||
|
the backend call, and a slow answer must not overwrite an entry they
|
||||||
|
made. And the in-app back buttons (`navigate-back`, fired
|
||||||
by the detail views and `now-playing-view`) go through `history.back()`
|
by the detail views and `now-playing-view`) go through `history.back()`
|
||||||
rather than a stack of their own: the old `navStack` is **deleted**, not
|
rather than a stack of their own: the old `navStack` is **deleted**, not
|
||||||
kept beside it, because two stacks is precisely how a view's own back
|
kept beside it, because two stacks is precisely how a view's own back
|
||||||
button and the phone's gesture come to disagree about what one press
|
button and the phone's gesture come to disagree about what one press
|
||||||
means.
|
means.
|
||||||
|
|
||||||
|
**And there is one statement of which view is active**, for the same
|
||||||
|
reason: `popstate` calls `handleNavigate()` directly and dispatches no
|
||||||
|
`navigate`, so the two nav components — which learned the active view
|
||||||
|
from that event — kept highlighting the view the user had just *left*.
|
||||||
|
`store/active-view-store.ts` is the shell saying where the user is, and
|
||||||
|
both navs read it through `ActiveViewController` rather than holding an
|
||||||
|
`activeView` of their own.
|
||||||
|
|
||||||
|
Four things about it are load-bearing.
|
||||||
|
|
||||||
|
**"Please go to X" and "the active view is now X" are different
|
||||||
|
statements**, and only the first existed — dispatched from 28 call
|
||||||
|
sites across 18 files. A re-dispatch from inside `handleNavigate` is
|
||||||
|
not the fix and cannot be: that function is the `document` listener for
|
||||||
|
`navigate`, so it is an infinite loop.
|
||||||
|
|
||||||
|
**It is a store rather than an event, because a component that mounts
|
||||||
|
after a navigation still has to know.** `bottom-nav`'s "More" drawer
|
||||||
|
creates its `<app-sidebar>` on open, and that copy had heard no
|
||||||
|
`navigate` at all — standing on Albums, the drawer opened highlighting
|
||||||
|
Home. An event has no answer for a listener that was not there.
|
||||||
|
|
||||||
|
**A detail view is not a view here**, so the destination it was opened
|
||||||
|
from stays lit. `app-sidebar` did that by accident (it guarded on
|
||||||
|
`navItems.some(...)`, so an unmatched name left its highlight alone)
|
||||||
|
and `bottom-nav` had no such guard and so lit *nothing* — which is why
|
||||||
|
one looked right and the other looked broken on the same screen.
|
||||||
|
Whether a view is primary is the shell's fact: `view in VIEW_TAGS` is
|
||||||
|
passed to `setView`, never re-derived, because a second copy of that
|
||||||
|
list is a second thing to forget.
|
||||||
|
|
||||||
|
**Nothing is lit until the shell has navigated.** The store starts
|
||||||
|
empty rather than defaulting to `home`, which is what `app-sidebar`'s
|
||||||
|
field used to do to match the landing view — a default that is correct
|
||||||
|
only while `GetDefaultPage()` agrees with it.
|
||||||
|
|
||||||
|
**Back and forward are chrome, and the depth is the shell's own
|
||||||
|
count.** `<nav-history>` in the top bar is #6: the stack was always
|
||||||
|
global — every navigation is an entry and `popstate` restores any of
|
||||||
|
them in either direction — so what was missing was an affordance, since
|
||||||
|
the only way back was a detail view's own button, which leaves the
|
||||||
|
screen with the view it belongs to. The buttons dispatch
|
||||||
|
`navigate-back` / `navigate-forward` and the shell owns both guards,
|
||||||
|
for the reason the old `navStack` was deleted: a second caller reaching
|
||||||
|
for `history` is how two stacks come to disagree.
|
||||||
|
|
||||||
|
Three things about it are load-bearing. **Forward is not back
|
||||||
|
negated**, so the single `pushedEntries` counter could not express it —
|
||||||
|
`popstate` carries no direction and fires identically both ways, so a
|
||||||
|
counter decremented on every pop reads a forward as a second back. Each
|
||||||
|
entry carries its index (`yjIdx`) and the shell keeps the current one
|
||||||
|
and a high-water mark; that also survives a jump of more than one,
|
||||||
|
which `history.go(-n)` and a long-press on a browser's back button both
|
||||||
|
produce. **A control that cannot act is `disabled` here**, which is the
|
||||||
|
documented exception to `library-status-indicator`'s rule: the two are
|
||||||
|
a pair whose positions the user learns, and hiding one moves the other
|
||||||
|
under the cursor. And **it stands down below 900px** — the top bar is
|
||||||
|
what runs out of room first below that (it already overflows 600px by
|
||||||
|
11px, #143), and nothing becomes unreachable: `nav.back` / `nav.forward`
|
||||||
|
(`Alt+Left` / `Alt+Right`, the browser's own combination, and clear of
|
||||||
|
the bare arrows that seek) are global at every width, and the phone has
|
||||||
|
the platform's gesture.
|
||||||
|
|
||||||
|
The assertion is `aria-current="page"`, in
|
||||||
|
`e2e/specs/back-navigation.spec.ts`. That file existed throughout the
|
||||||
|
bug, covered exactly these journeys, and asserted only
|
||||||
|
`data-active-view` — the shell's own bookkeeping, which was right the
|
||||||
|
whole way through — so it was green on the broken build. Same trap as
|
||||||
|
`layout-overflow.spec.ts` and `page-header`: a spec named for the
|
||||||
|
behaviour, measuring the plumbing.
|
||||||
|
|
||||||
|
**Which destinations exist is configuration, and hiding one takes away
|
||||||
|
the nav item and nothing else.** Eleven sidebar entries is more than
|
||||||
|
most libraries need (#25), so each is toggleable from Settings →
|
||||||
|
Navigation, Autotag is off until asked for, and Downloads is absent
|
||||||
|
until there is a client to download with — a destination for a feature
|
||||||
|
that cannot work is worse than none. `navigate` still resolves a hidden
|
||||||
|
view, which is not a nicety: detail views navigate into these and the
|
||||||
|
launch page is one of them. Nothing needed a special case for the
|
||||||
|
highlight either, because the paragraph above moved that onto
|
||||||
|
`active-view-store`: the sidebar asks `isActive(id)` per *rendered*
|
||||||
|
item, so a hidden view lights nothing exactly as a detail view does.
|
||||||
|
|
||||||
|
Five things about it are load-bearing.
|
||||||
|
|
||||||
|
**The stored shape is a map keyed by view id, and an absent key means
|
||||||
|
that view's own default** (`backend/config.Views`). That is what makes
|
||||||
|
this need no migration in either direction, and it is the polarity rule
|
||||||
|
`AllowMeteredCatalogDownload` states: the zero value is the intended
|
||||||
|
answer. A `HiddenViews []string` cannot express "Autotag off by
|
||||||
|
default" at all — its zero value is *hide nothing* — and a struct with
|
||||||
|
a boolean per view turns a view that later stops existing into stored
|
||||||
|
garbage. Here an unknown key is dropped on load and a view added later
|
||||||
|
gets its own default rather than being invisible or forcibly visible.
|
||||||
|
It is also what makes #73's `#25 → #27` order safe rather than
|
||||||
|
backwards: when Jobs folds into Settings, `jobs = true` in somebody's
|
||||||
|
config is a key nothing asks about.
|
||||||
|
|
||||||
|
**Two states the user could not get out of are refused, in the config
|
||||||
|
and not in the checkbox.** Settings is never hideable and the launch
|
||||||
|
page is not hideable while it is the launch page. `config.toml` is
|
||||||
|
hand-editable, so a disabled checkbox is the affordance and
|
||||||
|
`SetViewVisible` is the rule — an app that can be locked out of its own
|
||||||
|
Settings by a typo in TOML is a support problem nobody can debug
|
||||||
|
remotely. On *load* the launch page is instead un-hidden rather than
|
||||||
|
refused: there is nobody to tell, and the honest reading of "my launch
|
||||||
|
page is Autotag" is that this user wants Autotag, not that their launch
|
||||||
|
page should be silently reset to something they did not choose.
|
||||||
|
|
||||||
|
**Downloads is gated at the nav and not in the config**, on
|
||||||
|
`downloadStore.available`, so switching it on in Settings still means
|
||||||
|
what it says once a client exists and the tab appears without a restart
|
||||||
|
(#37's rule). `available` is false until the providers have loaded,
|
||||||
|
which makes the item *appear* on a fresh launch rather than appearing
|
||||||
|
and then vanishing.
|
||||||
|
|
||||||
|
**The tab bar honours the toggles too, and the reason is local rather
|
||||||
|
than a general rule about phones.** `PHONE_COLUMN_IDS` is the precedent
|
||||||
|
for "what a phone shows is a different question", and it would apply —
|
||||||
|
except that `bottom-nav`'s "More" opens the *same* `<app-sidebar>`,
|
||||||
|
which filters, so an unfiltered bar would contradict its own drawer one
|
||||||
|
tap away. Which four tabs is still plan 016's committed subset; this
|
||||||
|
only removes from it, and "More" is never filtered because it is how
|
||||||
|
everything else stays reachable.
|
||||||
|
|
||||||
|
**A retired destination is the one shape this does not make free.** An
|
||||||
|
absent visibility key takes its default and an unknown one is dropped,
|
||||||
|
but `DefaultPage` is a *value*: a launch page naming a view that no
|
||||||
|
longer exists fails validation, and on the load path that means the app
|
||||||
|
refuses to start for whoever had it selected. `RetiredViews` is that
|
||||||
|
list, and `ApplyDefaults` treats a retired name as a zero value while
|
||||||
|
an unknown-but-not-retired one still errors — a typo is worth being
|
||||||
|
told about. #27 retiring `jobs` is its first entry.
|
||||||
|
|
||||||
|
**The list of destinations is `services/view-meta.ts`**, on
|
||||||
|
`shortcut-meta.ts`'s pattern, because #25 gave it a second reader:
|
||||||
|
Settings renders a toggle per view and needs the same labels in the
|
||||||
|
same order. Which views exist and what an unconfigured install shows is
|
||||||
|
Go's (`backend/config.Views`, which `DefaultPage`'s validation reads
|
||||||
|
too, so the launchable set is not a second list); how they are *drawn*
|
||||||
|
is the frontend's, beside the rest of the icon vocabulary. The binding
|
||||||
|
returns the **resolved** map for every view, so the frontend holds no
|
||||||
|
copy of the defaults — which would be the copy that shipped in the
|
||||||
|
binary rather than the one being edited.
|
||||||
|
|
||||||
**A primary view is cached, not unmounted.** `index.ts` keeps every
|
**A primary view is cached, not unmounted.** `index.ts` keeps every
|
||||||
primary view in the DOM and toggles a `.view-hidden` class, because that
|
primary view in the DOM and toggles a `.view-hidden` class, because that
|
||||||
is what preserves `scrollTop` across navigation — so
|
is what preserves `scrollTop` across navigation — so
|
||||||
@@ -1328,6 +1566,164 @@ is 32px each. Which four is plan 016's committed subset, and everything
|
|||||||
else — Settings included, because a phone still needs it — is behind
|
else — Settings included, because a phone still needs it — is behind
|
||||||
"More".
|
"More".
|
||||||
|
|
||||||
|
**There are three supported size bands, and the queue is part of the
|
||||||
|
promise.** Plan 018 (#24) wrote them down: **Phone** below 600 (bottom
|
||||||
|
nav, reflows, fits 320px exactly), **Compact** 600–899 (icon sidebar),
|
||||||
|
**Desktop** from 900 (labelled sidebar) — plus one sentence across all
|
||||||
|
three, *no action is ever unreachable at any supported size*. The bands
|
||||||
|
themselves already existed; what was new is that they are a promise and
|
||||||
|
that the queue panel is inside it.
|
||||||
|
|
||||||
|
**The top bar decides what it can afford, and what it gives up is never
|
||||||
|
an action.** Its five children do not fit at the bottom of the Compact
|
||||||
|
band: the bar was 611px inside a 600px viewport idle and **862px while
|
||||||
|
a scan ran**, because `job-indicator` is `hidden` when idle and 235px
|
||||||
|
wide showing a real library's scan title (#143). So `services/
|
||||||
|
top-bar-fit.ts` is `page-header`'s treatment one bar up — a
|
||||||
|
ResizeObserver, every pass starting from all-visible, hiding the
|
||||||
|
lowest-priority child until it fits.
|
||||||
|
|
||||||
|
Five things about it are load-bearing.
|
||||||
|
|
||||||
|
**It is measured rather than breakpointed for a reason specific to this
|
||||||
|
bar**: three of its five children are as wide as their *content* — the
|
||||||
|
library filter is a `<select>` sized by the longest library name, the
|
||||||
|
indicator by the running job's title, the search box by its view-scoped
|
||||||
|
placeholder — so any width picked is right for one library, one job and
|
||||||
|
one view. Swept with a long-titled scan staged, the bar overflowed at
|
||||||
|
**every** width from 600 to 899 *and* at 900 where `nav-history`
|
||||||
|
appears, while 899 fits; a breakpoint fixing "600 to 610" would have
|
||||||
|
fixed whichever case happened to be idle when it was measured.
|
||||||
|
|
||||||
|
**What yields is decided by the promise above, which rules out the two
|
||||||
|
cheapest answers.** Hiding the library filter takes away an action —
|
||||||
|
`library-filter` is the only control in the app that calls
|
||||||
|
`setSelectedLibrary` — so it trades this promise for the same promise
|
||||||
|
(#148 is the phone already doing that). Collapsing the search box to an
|
||||||
|
icon is what #57 wants and #57 is blocked behind #62, so building it
|
||||||
|
here is building it without the thing that blocks it. The two that
|
||||||
|
yield are the two that are **not** actions: the wordmark, which the
|
||||||
|
window's own title bar repeats and which #48 wants down to "YJ" at
|
||||||
|
every width anyway, and then the job indicator's *label*, leaving the
|
||||||
|
ring — which is not a new judgement, since the component already drops
|
||||||
|
it below 600px and its `sr-only` live region is what announces the
|
||||||
|
state either way.
|
||||||
|
|
||||||
|
**The wordmark yields its width, not its existence.** The collapsed
|
||||||
|
rule is visually-hidden rather than `display: none`, because that `h1`
|
||||||
|
is the document's top-level heading as well as the brand.
|
||||||
|
|
||||||
|
**"Fits" is the children against the content box, and `scrollWidth`
|
||||||
|
cannot express it.** `scrollWidth` counts a box's left padding and not
|
||||||
|
its right, so with 2em gutters it under-reports by 32px: the first fix
|
||||||
|
read `700/700` — a perfect fit — with the indicator sitting in the
|
||||||
|
whole right gutter. Same family as #69's title trap, and found only
|
||||||
|
because `top-bar-fit.spec.ts` measures **per child**, which is what
|
||||||
|
`layout-overflow.spec.ts` cannot do and why that spec was green
|
||||||
|
throughout the defect.
|
||||||
|
|
||||||
|
And **the bar does not resize when a job starts**, which is the case the
|
||||||
|
whole thing is for — a ResizeObserver on the header alone never fires,
|
||||||
|
so every element child is observed too.
|
||||||
|
|
||||||
|
**The bottom bar is three columns whose outer two are the same width,
|
||||||
|
and that is what "centred" means.** It was `320px 1fr auto`, so the
|
||||||
|
transport sat in the middle of the space the metadata and the queue
|
||||||
|
button did not use — its centre was ~140px right of the window's at
|
||||||
|
every size (#23). The outer tracks are now the same expression, so the
|
||||||
|
middle one is centred by construction rather than by arithmetic that
|
||||||
|
has to be redone whenever a control joins the bar.
|
||||||
|
|
||||||
|
Four things about it are load-bearing.
|
||||||
|
|
||||||
|
**The side width is the metadata's, capped at a quarter of the bar**,
|
||||||
|
and the cap is not tidiness — it was measured as a regression first.
|
||||||
|
Reserving the full `--now-playing-width` on *both* sides costs the
|
||||||
|
transport twice: at 800px the outer pair wanted 640 of 800 and the seek
|
||||||
|
bar's track fell from **257px to 61px**, and to 0 at 200% text. The
|
||||||
|
control you drag was being squeezed to centre the buttons above it.
|
||||||
|
With the cap it is 246px at 800, which is parity with the uncentred
|
||||||
|
layout.
|
||||||
|
|
||||||
|
**The cap is a `min()` rather than a breakpoint** because
|
||||||
|
`--now-playing-width` is *user state* — the metadata panel has a drag
|
||||||
|
handle — and the same reasoning the queue panel's overlay mode uses
|
||||||
|
applies: a rule that assumed the default 320 would be wrong by whatever
|
||||||
|
the user dragged. Tying both sides to that variable is also what keeps
|
||||||
|
the handle meaningful; a plain `1fr … 1fr` would centre the transport
|
||||||
|
just as well and silently make dragging a no-op.
|
||||||
|
|
||||||
|
**The volume moved out of `audio-player` and into the bar** (#42),
|
||||||
|
because the transport column has to hold the transport and nothing
|
||||||
|
else or "centred" means centred with a slider bolted to one side. It
|
||||||
|
lives in `.bar-end` with the queue button — one cell, not two columns,
|
||||||
|
since the centring compares *columns* and a separate volume track would
|
||||||
|
make the outer pair unequal by whatever the slider measures.
|
||||||
|
|
||||||
|
And **the slider is inline by default, with the popup as a setting**
|
||||||
|
whose stored flag names the *popup*: `backend/config`'s polarity rule,
|
||||||
|
where the zero value has to be the intended answer, so an existing
|
||||||
|
`config.toml` with no key gets the new default without a migration.
|
||||||
|
Inline, the icon becomes the mute toggle and is named after that action
|
||||||
|
rather than after the state, because with the slider beside it there is
|
||||||
|
nothing left to disclose. It stands down below 600px whatever the
|
||||||
|
setting says — that is about the platform rather than preference, and
|
||||||
|
is why `mediacontrols`' Android handler implements no volume callback.
|
||||||
|
|
||||||
|
**900 is the worst desktop width, not the 800×600 minimum.** The
|
||||||
|
sidebar collapses to icons *below* 900, so the main panel is 843px at
|
||||||
|
899 and 700px at 900 — the narrowest content area any desktop width
|
||||||
|
produces is at the top of the Compact band, not at the enforced floor.
|
||||||
|
Every viewport list that stopped at "the minimum" was therefore missing
|
||||||
|
its own worst case, which is why `layout-overflow.spec.ts` carries 900
|
||||||
|
now. And **both reasons in `MinWidth`'s comment had expired** — the
|
||||||
|
subtitle is `display: none` from 899 down and the sidebar host scrolls
|
||||||
|
(`overflow-y: auto`; at 600×460 its `scrollHeight` is 434 against a
|
||||||
|
332px client) — so 800×600 is a *comfort* floor for desktop chrome and
|
||||||
|
not a correctness one. Below it the phone layout takes over, which is
|
||||||
|
also why a very small window reflows rather than becoming a
|
||||||
|
mini-player: **#12 is a second always-on-top window, not a mode of this
|
||||||
|
one**, and making it a mode would discard navigation state on a resize
|
||||||
|
and put the process-level MPRIS question on a path a drag can trigger.
|
||||||
|
|
||||||
|
**The queue panel is a column only while the content can spare the
|
||||||
|
width, and that cannot be a media query.** In flow the host is
|
||||||
|
`flex-shrink: 0`, so an open queue is paid for by the main panel: it
|
||||||
|
left 379px at 900×600 (with all three of the Playlists header's actions
|
||||||
|
clipped), 69px at 390, and **0px** at 320 — the content was not
|
||||||
|
degraded but gone. It goes to an overlay with a scrim when
|
||||||
|
`available - panelWidth < 480`, where `available` is
|
||||||
|
`.content-area`'s width and therefore already accounts for the
|
||||||
|
sidebar's collapse.
|
||||||
|
|
||||||
|
Four things about it are load-bearing. **The mode is computed, not
|
||||||
|
breakpointed**, because the panel's width is user state — drag-resizable
|
||||||
|
200–500px and persisted — so a viewport breakpoint silently assumes the
|
||||||
|
default 320 and is wrong by up to 180px in the direction that hurts;
|
||||||
|
widening the panel at a fixed window size must flip it, and
|
||||||
|
`queue-overlay-mode.test.ts` is written around exactly that. **480 is a
|
||||||
|
judgement and says so**: there is no cliff to derive it from (the track
|
||||||
|
list rescales continuously, 213px to 124px columns with no row
|
||||||
|
overflow), so it is anchored to keep the default 1100px window inline
|
||||||
|
and put every measured-broken case on the overlay side. **The scrim
|
||||||
|
covers the content area only** — not the sidebar or the transport —
|
||||||
|
because the queue is not modal, and it is subtle on a dark ramp by
|
||||||
|
arithmetic rather than by accident (33,37,41 → 18,20,23). And **the
|
||||||
|
overlay is a presentation, not a fork**: #55 asks for one component
|
||||||
|
with two mount points, so the roving tab stop, Alt+Arrow reorder, drag
|
||||||
|
reorder, selection semantics and `virtualizer.requestUpdate()` all come
|
||||||
|
along untouched. Escape closes it and returns focus, and is attached
|
||||||
|
only while the overlay is up — it is a dismissal, not a shortcut, which
|
||||||
|
is why it is not a panel-scoped binding.
|
||||||
|
|
||||||
|
What this does **not** fix is `page-header` overflowing on its own:
|
||||||
|
at 900×600 "New Smart Playlist" is still clipped to 114 of 162px with
|
||||||
|
the queue *closed*. That is #69, and it cannot be fixed in
|
||||||
|
`page-header` alone — actions arrive through `<slot name="actions">` as
|
||||||
|
arbitrary light-DOM markup with their own handlers, so collapsing them
|
||||||
|
into a "More actions" menu needs an actions *API* (data, not markup)
|
||||||
|
across all three hosts that slot them.
|
||||||
|
|
||||||
**The phone section of `index.css` is last on purpose.** A media query
|
**The phone section of `index.css` is last on purpose.** A media query
|
||||||
adds no specificity, so a `@media (max-width: 599px)` block placed
|
adds no specificity, so a `@media (max-width: 599px)` block placed
|
||||||
above the plain rules it overrides loses to them — which is how phase 1
|
above the plain rules it overrides loses to them — which is how phase 1
|
||||||
@@ -1918,6 +2314,79 @@ that corrects itself a moment later is worse than saying nothing. And
|
|||||||
the field, the direction and their persistence, so the control cannot
|
the field, the direction and their persistence, so the control cannot
|
||||||
disagree with the list.
|
disagree with the list.
|
||||||
|
|
||||||
|
**And an action is data, on that same rule: the header decides what
|
||||||
|
fits, the host decides what happens.** Playlists slotted three buttons
|
||||||
|
totalling 390px into a header that gets 700px at 900×600, so "New Smart
|
||||||
|
Playlist" rendered **114 of its 162px** with the queue closed — and on a
|
||||||
|
phone none of them could be reached at all, which is what #69 reported.
|
||||||
|
A host passes `PageAction[]` (`{id, label, icon, onSelect, priority,
|
||||||
|
drop?}`) and `page-header` renders each one as a button or as an item in
|
||||||
|
one "More actions" menu.
|
||||||
|
|
||||||
|
**It could not have been a rule added in one place**, and that is a fact
|
||||||
|
about the API rather than an effort estimate: actions used to arrive
|
||||||
|
through `<slot name="actions">` as arbitrary light-DOM markup, and a
|
||||||
|
component cannot move another component's light-DOM children into a
|
||||||
|
dropdown and keep their behaviour — there is nothing generic in markup
|
||||||
|
to render as a menu item. The slot survives for markup a data list
|
||||||
|
cannot express, at the stated cost that **a slotted action does not
|
||||||
|
collapse** and must therefore fit at 800×600.
|
||||||
|
|
||||||
|
Six things about it are load-bearing:
|
||||||
|
|
||||||
|
- **The fit is measured, never breakpointed.** A ResizeObserver drives
|
||||||
|
it, and each pass starts from *all visible* and hides the
|
||||||
|
lowest-priority action until it fits — so the collapsed set is a pure
|
||||||
|
function of the current width rather than of how the window got
|
||||||
|
there. A rule that only ever added to the set would never give a
|
||||||
|
button back, and one that adjusted by a step would need a hysteresis
|
||||||
|
band to stop it oscillating on the pixel where a button exactly fits.
|
||||||
|
- **"Fits" means nothing is clipped, which is not the same as the
|
||||||
|
header not overflowing.** The title can ellipsis, and the moment it
|
||||||
|
can it absorbs the pressure: `scrollWidth` reports a header that fits
|
||||||
|
perfectly while the heading reads "Playlis…". That is this bug moved
|
||||||
|
from the button to the title, invisible to the same measurement that
|
||||||
|
missed it the first time — so the heading's own truncation counts as
|
||||||
|
not fitting, and an action is collapsed before the title gives way.
|
||||||
|
Below that, at 320px, the title *is* what yields: the navigation also
|
||||||
|
says which page you are on, and an action has nowhere else to be said.
|
||||||
|
- **The measurement flips `hidden` on the rendered nodes rather than
|
||||||
|
re-rendering between steps.** Reading `scrollWidth` forces layout,
|
||||||
|
which is the point; awaiting a Lit update between steps instead lets
|
||||||
|
the intermediate all-visible state paint, so the fix would flash the
|
||||||
|
overflow it exists to prevent.
|
||||||
|
- **Priority is what a *capability* costs, not what a button is worth.**
|
||||||
|
New Playlist is highest because it is the **drop target** and a closed
|
||||||
|
menu cannot be one; that is also why `PageAction.drop` carries the
|
||||||
|
host's own `dragover`/`dragleave`/`drop` handlers rather than the
|
||||||
|
header owning a notion of dropping, and why the affordance is simply
|
||||||
|
absent from the overflow rather than approximated there.
|
||||||
|
- **`aria-controls` names a panel that is always in the DOM** —
|
||||||
|
`config-section`'s rule, and `wa-popup` hides it when inactive — and
|
||||||
|
the keyboard model is `MenuKeyboard`, shared with every other menu in
|
||||||
|
the app so this is not a second one.
|
||||||
|
- **It is checked per button, because `layout-overflow.spec.ts` cannot
|
||||||
|
see this.** That spec asserts the *shell* needs no sideways
|
||||||
|
scrolling and passed on the broken build; clipping *inside* a
|
||||||
|
component is invisible to it, which is exactly why the defect
|
||||||
|
survived a spec named for it.
|
||||||
|
`e2e/specs/header-action-overflow.spec.ts` measures each button
|
||||||
|
against its header at 900×600, 800×600, 390×780 and 320×600, and
|
||||||
|
asserts buttons **plus** menu account for every declared action —
|
||||||
|
without that half it would pass vacuously on a build that renders no
|
||||||
|
actions at all.
|
||||||
|
|
||||||
|
One thing it deliberately does **not** grow is a phone mode for the
|
||||||
|
actions. `PHONE_COLUMN_IDS` is the precedent for "what is drawn and
|
||||||
|
what can be sorted are different questions", but it exists because the
|
||||||
|
track list's columns cannot be derived from a width; these can, and a
|
||||||
|
second declaration of what a phone shows is a second thing to keep in
|
||||||
|
step. What the header *does* state at phone width is one word: below
|
||||||
|
600px the sort control's "Sort:" label is visually hidden — 172px of a
|
||||||
|
320px header for a label the adjacent direction arrow implies — and it
|
||||||
|
stays in the accessibility tree, because it is the select's accessible
|
||||||
|
name and hiding it outright is `config-field`'s bug one component over.
|
||||||
|
|
||||||
**The header search box is view-scoped, and now says so.** It sits in
|
**The header search box is view-scoped, and now says so.** It sits in
|
||||||
the app header and reads as global; typing `tide` on Playlists answered
|
the app header and reads as global; typing `tide` on Playlists answered
|
||||||
"No playlists match your search" with three *Tideline* tracks in the
|
"No playlists match your search" with three *Tideline* tracks in the
|
||||||
@@ -2307,6 +2776,23 @@ Pre-commit hooks verify generated code is fresh — always run `make generate` a
|
|||||||
mistyped `feat` ships a minor version. `make release-dry` answers "what
|
mistyped `feat` ships a minor version. `make release-dry` answers "what
|
||||||
would this merge release" without pushing.
|
would this merge release" without pushing.
|
||||||
|
|
||||||
|
**The analyzer reads the type and ignores the scope, so a CI-only change
|
||||||
|
is `ci:` and never `fix(ci):`.** The scope is decoration; `fix` is a
|
||||||
|
patch whatever is in the brackets. Two commits touching nothing but
|
||||||
|
`.gitea/workflows/unclaim.yml` were written `fix(ci):` and cut `v0.2.1`
|
||||||
|
and `v0.2.2` — real releases, published to Arch, Homebrew and the APK
|
||||||
|
registry, containing no user-facing change. They were left in place
|
||||||
|
rather than deleted, because a version that vanishes is worse for
|
||||||
|
whoever pulled it than one that turns out to be empty.
|
||||||
|
|
||||||
|
**The blast radius is bigger than the version number**, which is what
|
||||||
|
makes this worth a paragraph. A merge to `main` starts two workflows;
|
||||||
|
if `release.yml` then pushes a tag, that tag push starts **four more**
|
||||||
|
(`arch-package`, `homebrew-formula`, `android-apk`, `desktop-assets`) —
|
||||||
|
on a runner with capacity 1, where the APK build alone is tens of
|
||||||
|
minutes. `make release-dry` before merging is how you find out, and it
|
||||||
|
is cheaper than every one of those.
|
||||||
|
|
||||||
**`@semantic-release/github` is not in that config and must not be.**
|
**`@semantic-release/github` is not in that config and must not be.**
|
||||||
Gitea's API is `/api/v1` and is not GitHub's surface, so
|
Gitea's API is `/api/v1` and is not GitHub's surface, so
|
||||||
`@semantic-release/exec` calls `scripts/gitea-release.sh` instead — one
|
`@semantic-release/exec` calls `scripts/gitea-release.sh` instead — one
|
||||||
|
|||||||
@@ -17,6 +17,34 @@ const (
|
|||||||
RecommendationStrong Recommendation = "strong"
|
RecommendationStrong Recommendation = "strong"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// ConfidentTier is the tier at which this package considers a match
|
||||||
|
// good enough to act on without being asked to look.
|
||||||
|
//
|
||||||
|
// It exists as a name rather than as `== RecommendationStrong` at
|
||||||
|
// each call site because two features read it and they must not
|
||||||
|
// disagree about what "high confidence" means: the album page tells
|
||||||
|
// the user unprompted that the autotagger has a match (#28), and
|
||||||
|
// strict auto-accept will rewrite the files without asking (#90).
|
||||||
|
// A page that says "we are sure" about something the auto-accept
|
||||||
|
// pass would decline is the app contradicting itself.
|
||||||
|
//
|
||||||
|
// What the two do *not* share is everything else. Surfacing a match
|
||||||
|
// is a suggestion with a confirm dialog behind it; auto-accept is an
|
||||||
|
// irreversible on-disk rewrite, and #90 gates it on further
|
||||||
|
// conditions this tier cannot express — exact track count, every
|
||||||
|
// title matching, lengths within a couple of seconds, no cover
|
||||||
|
// replacement, no MBID conflict. So this is the floor both stand on,
|
||||||
|
// not the whole of either test.
|
||||||
|
const ConfidentTier = RecommendationStrong
|
||||||
|
|
||||||
|
// Confident reports whether a tier clears ConfidentTier.
|
||||||
|
//
|
||||||
|
// A comparison rather than an equality, so adding a tier above
|
||||||
|
// "strong" later does not silently stop qualifying.
|
||||||
|
func Confident(r Recommendation) bool {
|
||||||
|
return recommendationRank(r) >= recommendationRank(ConfidentTier)
|
||||||
|
}
|
||||||
|
|
||||||
const (
|
const (
|
||||||
// Absolute score tiers.
|
// Absolute score tiers.
|
||||||
strongScoreThresh = 0.90
|
strongScoreThresh = 0.90
|
||||||
|
|||||||
@@ -168,3 +168,34 @@ func TestRecommend_LocalCandidatesWithoutRGMBIDCompareByTitle(t *testing.T) {
|
|||||||
t.Errorf("different-title rival: Recommend = %q, want medium", got)
|
t.Errorf("different-title rival: Recommend = %q, want medium", got)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The tier both features stand on is one name, checked here rather
|
||||||
|
// than assumed at two call sites.
|
||||||
|
//
|
||||||
|
// #28 renders "we have a match for this album" on the album page and
|
||||||
|
// #90 will rewrite files without asking; a page that claims confidence
|
||||||
|
// the auto-accept pass would decline is the app contradicting itself.
|
||||||
|
// What they do not share is everything else — auto-accept adds gates
|
||||||
|
// this tier cannot express — so this pins the floor, not the whole of
|
||||||
|
// either test.
|
||||||
|
func TestConfidentIsTheOneSharedFloor(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
if ConfidentTier != RecommendationStrong {
|
||||||
|
t.Errorf("ConfidentTier = %q, want strong", ConfidentTier)
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tc := range []struct {
|
||||||
|
rec Recommendation
|
||||||
|
want bool
|
||||||
|
}{
|
||||||
|
{RecommendationNone, false},
|
||||||
|
{RecommendationLow, false},
|
||||||
|
{RecommendationMedium, false},
|
||||||
|
{RecommendationStrong, true},
|
||||||
|
} {
|
||||||
|
if got := Confident(tc.rec); got != tc.want {
|
||||||
|
t.Errorf("Confident(%q) = %v, want %v", tc.rec, got, tc.want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -0,0 +1,145 @@
|
|||||||
|
package autotagservice
|
||||||
|
|
||||||
|
import (
|
||||||
|
"database/sql"
|
||||||
|
"fmt"
|
||||||
|
|
||||||
|
"yellowjacket/backend/autotag"
|
||||||
|
)
|
||||||
|
|
||||||
|
// AlbumMatchView is "the autotagger already has a confident match for
|
||||||
|
// the album you are looking at".
|
||||||
|
//
|
||||||
|
// It is deliberately not a score. The album page renders a suggestion,
|
||||||
|
// and a suggestion has to be actionable: which release, what it is
|
||||||
|
// called, and whether acting on it here would do the whole album or
|
||||||
|
// only part of it.
|
||||||
|
type AlbumMatchView struct {
|
||||||
|
// GroupKey is the tagging group the actions operate on.
|
||||||
|
GroupKey string `json:"groupKey"`
|
||||||
|
|
||||||
|
// Recommendation is the tier, as a string, for a caller that
|
||||||
|
// wants to render the strength rather than trust the filter.
|
||||||
|
Recommendation string `json:"recommendation"`
|
||||||
|
|
||||||
|
// Score is the top candidate's raw score, 0..1.
|
||||||
|
Score float64 `json:"score"`
|
||||||
|
|
||||||
|
// ReleaseMBID is the release Apply would write.
|
||||||
|
ReleaseMBID string `json:"releaseMbid"`
|
||||||
|
|
||||||
|
// Title and ArtistCredit name that release, so the banner can say
|
||||||
|
// what it is offering rather than "a match".
|
||||||
|
Title string `json:"title"`
|
||||||
|
ArtistCredit string `json:"artistCredit"`
|
||||||
|
|
||||||
|
// TrackCount is the group's local track count.
|
||||||
|
TrackCount int64 `json:"trackCount"`
|
||||||
|
|
||||||
|
// GroupCount is how many tagging groups this album spans.
|
||||||
|
//
|
||||||
|
// More than one means a multi-disc album (one group per disc), and
|
||||||
|
// it is the reason this is a field rather than an implementation
|
||||||
|
// detail: applying "the album" from a single button would retag
|
||||||
|
// one disc of three and leave the folder holding a mix of old and
|
||||||
|
// new tags. The caller offers review instead.
|
||||||
|
GroupCount int `json:"groupCount"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// MatchForAlbum answers "does the autotagger have something confident
|
||||||
|
// to say about this album", for the album detail page.
|
||||||
|
//
|
||||||
|
// Three things about it are load-bearing.
|
||||||
|
//
|
||||||
|
// **It costs no MusicBrainz request.** Everything it needs is already
|
||||||
|
// on disk: `tagging_items` carries the top score and release from the
|
||||||
|
// background prefetch, and `tagging_candidates` durably holds the
|
||||||
|
// scored list. The rate limiters here are shared with every page the
|
||||||
|
// user can open, so a lookup that fires on page load must not join
|
||||||
|
// that queue — which also means this returns nothing for a folder
|
||||||
|
// nobody has scored yet, rather than scoring it now. That is the
|
||||||
|
// right trade: the prefetch will get to it, and a page that silently
|
||||||
|
// spends a minute of somebody's MusicBrainz budget to draw a banner
|
||||||
|
// is worse than a page that says nothing.
|
||||||
|
//
|
||||||
|
// **The tier is computed, not read.** `tagging_items.score` is the raw
|
||||||
|
// number and `Recommend` is what turns it into a claim — capping it
|
||||||
|
// for an ambiguous runner-up, an incomplete alignment or a folder too
|
||||||
|
// small to corroborate itself. Filtering on the raw score would
|
||||||
|
// promise confidence the scorer had explicitly withheld.
|
||||||
|
//
|
||||||
|
// **Nothing is said about an album the user has already answered
|
||||||
|
// for.** Only a `pending` group qualifies: `confirmed` covers both a
|
||||||
|
// finished apply and an explicit "leave as is", and `skipped` is the
|
||||||
|
// user saying not now. Re-offering either is nagging, and "leave as
|
||||||
|
// is" would be actively wrong to argue with.
|
||||||
|
func (s *Service) MatchForAlbum(albumID int64) (*AlbumMatchView, error) {
|
||||||
|
if albumID <= 0 {
|
||||||
|
return nil, nil //nolint:nilnil // "no album" is not an error.
|
||||||
|
}
|
||||||
|
|
||||||
|
rows, err := s.db.Queries.GetTaggingItemsForAlbum(
|
||||||
|
s.ctx, sql.NullInt64{Int64: albumID, Valid: true},
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("tagging items for album: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
pending := rows[:0:0]
|
||||||
|
|
||||||
|
for _, row := range rows {
|
||||||
|
if row.Status == "pending" {
|
||||||
|
pending = append(pending, row)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(pending) == 0 {
|
||||||
|
return nil, nil //nolint:nilnil // nothing to say is not an error.
|
||||||
|
}
|
||||||
|
|
||||||
|
// Rows arrive best-score-first, so the first pending one is the
|
||||||
|
// group worth describing. On a multi-disc album that is one disc
|
||||||
|
// of several and GroupCount says so.
|
||||||
|
best := pending[0]
|
||||||
|
|
||||||
|
cands := s.lookupCachedCandidates(best.GroupKey)
|
||||||
|
if len(cands) == 0 {
|
||||||
|
return nil, nil //nolint:nilnil // not scored yet; see the doc comment.
|
||||||
|
}
|
||||||
|
|
||||||
|
locals, err := s.scorer.LocalTracksForGroup(s.ctx, best.GroupKey)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("local tracks for group: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
group := autotag.Group{
|
||||||
|
AlbumName: best.AlbumName,
|
||||||
|
AlbumArtist: best.AlbumArtist,
|
||||||
|
Tracks: locals,
|
||||||
|
Synthetic: best.Synthetic != 0,
|
||||||
|
}
|
||||||
|
|
||||||
|
rec := autotag.Recommend(group, cands)
|
||||||
|
if !autotag.Confident(rec) {
|
||||||
|
return nil, nil //nolint:nilnil // not confident enough to interrupt.
|
||||||
|
}
|
||||||
|
|
||||||
|
top := cands[0]
|
||||||
|
|
||||||
|
// The release the banner names must be the release Apply would
|
||||||
|
// write. Apply with an empty MBID takes the top cached candidate,
|
||||||
|
// which is what this reads — but it is passed explicitly anyway,
|
||||||
|
// so a rescore between the page rendering and the user clicking
|
||||||
|
// cannot swap the album out from under a button they have already
|
||||||
|
// read.
|
||||||
|
return &AlbumMatchView{
|
||||||
|
GroupKey: best.GroupKey,
|
||||||
|
Recommendation: string(rec),
|
||||||
|
Score: top.Score,
|
||||||
|
ReleaseMBID: top.ReleaseMBID,
|
||||||
|
Title: top.Title,
|
||||||
|
ArtistCredit: top.ArtistCredit,
|
||||||
|
TrackCount: best.TrackCount,
|
||||||
|
GroupCount: len(pending),
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,320 @@
|
|||||||
|
package autotagservice
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"yellowjacket/backend/autotag"
|
||||||
|
"yellowjacket/backend/database"
|
||||||
|
)
|
||||||
|
|
||||||
|
// seedAlbumGroup writes one album's files, its tagging item and the
|
||||||
|
// durable candidate blob the prefetch would have left behind.
|
||||||
|
//
|
||||||
|
// The candidate list is what a real one looks like in the two ways
|
||||||
|
// that decide the tier: a per-track alignment for every local track,
|
||||||
|
// and a runner-up far enough away not to count as ambiguity.
|
||||||
|
func seedAlbumGroup(
|
||||||
|
t *testing.T,
|
||||||
|
db *database.DB,
|
||||||
|
groupKey string,
|
||||||
|
tracks int,
|
||||||
|
status string,
|
||||||
|
score float64,
|
||||||
|
) int64 {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
for i := 1; i <= tracks; i++ {
|
||||||
|
database.InsertTestTrack(t, db, database.TestTrack{
|
||||||
|
FilePath: filePathFor(groupKey, i),
|
||||||
|
Title: titleFor(i),
|
||||||
|
Artist: "Tideline",
|
||||||
|
Album: "Glass Harbour",
|
||||||
|
AlbumArtist: "Tideline",
|
||||||
|
TrackNumber: int64(i),
|
||||||
|
LengthMs: 200000,
|
||||||
|
LibraryID: 0,
|
||||||
|
GroupKey: groupKey,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
if _, err := db.ExecContext(`
|
||||||
|
INSERT INTO tagging_items
|
||||||
|
(group_key, library_id, track_count, album_name, album_artist,
|
||||||
|
disc_number, status, score, best_match_release_mbid)
|
||||||
|
VALUES (?, 0, ?, 'Glass Harbour', 'Tideline', 0, ?, ?, 'rel-1')
|
||||||
|
`, groupKey, tracks, status, score); err != nil {
|
||||||
|
t.Fatalf("insert tagging item: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
var albumID int64
|
||||||
|
if err := db.QueryRowWriter(
|
||||||
|
`SELECT album_id FROM audio_files WHERE group_key = ? LIMIT 1`, groupKey,
|
||||||
|
).Scan(&albumID); err != nil {
|
||||||
|
t.Fatalf("read album id: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return albumID
|
||||||
|
}
|
||||||
|
|
||||||
|
func filePathFor(groupKey string, n int) string {
|
||||||
|
return "/music/" + groupKey + "/0" + string(rune('0'+n)) + ".mp3"
|
||||||
|
}
|
||||||
|
|
||||||
|
func titleFor(n int) string {
|
||||||
|
return "Track " + string(rune('0'+n))
|
||||||
|
}
|
||||||
|
|
||||||
|
// storeCandidates writes the durable blob GetCandidates would have
|
||||||
|
// cached, with `top` as the winning score.
|
||||||
|
func storeCandidates(
|
||||||
|
t *testing.T, db *database.DB, groupKey string, tracks int, top float64,
|
||||||
|
) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
aligns := make([]autotag.TrackAlignment, 0, tracks)
|
||||||
|
for i := range tracks {
|
||||||
|
aligns = append(aligns, autotag.TrackAlignment{
|
||||||
|
Status: autotag.AlignmentMatched,
|
||||||
|
LocalIndex: i,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
cands := []autotag.Candidate{
|
||||||
|
{
|
||||||
|
ReleaseMBID: "rel-1",
|
||||||
|
ReleaseGroupMBID: "rg-1",
|
||||||
|
Title: "Glass Harbour",
|
||||||
|
ArtistCredit: "Tideline",
|
||||||
|
TrackCount: tracks,
|
||||||
|
Alignments: aligns,
|
||||||
|
Score: top,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
ReleaseMBID: "rel-2",
|
||||||
|
ReleaseGroupMBID: "rg-2",
|
||||||
|
Title: "Something Else",
|
||||||
|
ArtistCredit: "Another Band",
|
||||||
|
TrackCount: tracks,
|
||||||
|
Score: 0.40,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
blob, err := json.Marshal(cands)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("marshal candidates: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if _, err := db.ExecContext(
|
||||||
|
`INSERT INTO tagging_candidates (group_key, candidates) VALUES (?, ?)`,
|
||||||
|
groupKey, string(blob),
|
||||||
|
); err != nil {
|
||||||
|
t.Fatalf("insert candidates: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A confident match is what the album page exists to surface.
|
||||||
|
func TestMatchForAlbumSurfacesAConfidentMatch(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
db := database.NewTestDB(t)
|
||||||
|
svc := newTestService(t, db)
|
||||||
|
|
||||||
|
albumID := seedAlbumGroup(t, db, "grp-1", 8, "pending", 0.95)
|
||||||
|
storeCandidates(t, db, "grp-1", 8, 0.95)
|
||||||
|
|
||||||
|
got, err := svc.MatchForAlbum(albumID)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("MatchForAlbum: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if got == nil {
|
||||||
|
t.Fatal("no match returned for a strong candidate")
|
||||||
|
}
|
||||||
|
|
||||||
|
if got.Recommendation != string(autotag.RecommendationStrong) {
|
||||||
|
t.Errorf("recommendation = %q, want strong", got.Recommendation)
|
||||||
|
}
|
||||||
|
|
||||||
|
// The release named is the release Apply would write — the page
|
||||||
|
// must not offer one album and tag another.
|
||||||
|
if got.ReleaseMBID != "rel-1" || got.Title != "Glass Harbour" {
|
||||||
|
t.Errorf("named %q/%q, want rel-1/Glass Harbour", got.ReleaseMBID, got.Title)
|
||||||
|
}
|
||||||
|
|
||||||
|
if got.GroupCount != 1 {
|
||||||
|
t.Errorf("groupCount = %d, want 1", got.GroupCount)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// The tier is computed from the candidates, not read off the raw
|
||||||
|
// score — a high number the scorer would have capped must not reach
|
||||||
|
// the page as confidence it withheld.
|
||||||
|
func TestMatchForAlbumDoesNotTrustTheStoredScore(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
db := database.NewTestDB(t)
|
||||||
|
svc := newTestService(t, db)
|
||||||
|
|
||||||
|
// Two tracks: below the evidence floor, so `Recommend` caps this
|
||||||
|
// at medium however well it scores.
|
||||||
|
albumID := seedAlbumGroup(t, db, "grp-2", 2, "pending", 0.99)
|
||||||
|
storeCandidates(t, db, "grp-2", 2, 0.99)
|
||||||
|
|
||||||
|
got, err := svc.MatchForAlbum(albumID)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("MatchForAlbum: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if got != nil {
|
||||||
|
t.Errorf("surfaced %+v for a two-track folder, want nothing", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A weak match is not worth interrupting for.
|
||||||
|
func TestMatchForAlbumStaysQuietBelowTheTier(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
db := database.NewTestDB(t)
|
||||||
|
svc := newTestService(t, db)
|
||||||
|
|
||||||
|
albumID := seedAlbumGroup(t, db, "grp-3", 8, "pending", 0.60)
|
||||||
|
storeCandidates(t, db, "grp-3", 8, 0.60)
|
||||||
|
|
||||||
|
got, err := svc.MatchForAlbum(albumID)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("MatchForAlbum: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if got != nil {
|
||||||
|
t.Errorf("surfaced %+v for a 0.60 match, want nothing", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// An album the user has already answered for is not re-offered.
|
||||||
|
//
|
||||||
|
// `confirmed` covers both a finished apply and an explicit "leave as
|
||||||
|
// is", and arguing with the second would be actively wrong.
|
||||||
|
func TestMatchForAlbumRespectsAnAnswerAlreadyGiven(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
for _, status := range []string{"confirmed", "skipped", "matched"} {
|
||||||
|
t.Run(status, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
db := database.NewTestDB(t)
|
||||||
|
svc := newTestService(t, db)
|
||||||
|
|
||||||
|
albumID := seedAlbumGroup(t, db, "grp-"+status, 8, status, 0.95)
|
||||||
|
storeCandidates(t, db, "grp-"+status, 8, 0.95)
|
||||||
|
|
||||||
|
got, err := svc.MatchForAlbum(albumID)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("MatchForAlbum: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if got != nil {
|
||||||
|
t.Errorf("surfaced %+v for a %s group, want nothing", got, status)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A folder nobody has scored yet says nothing, rather than scoring it
|
||||||
|
// now: the MusicBrainz limiter is shared with every page the user can
|
||||||
|
// open, and this runs on page load.
|
||||||
|
func TestMatchForAlbumMakesNoNetworkCallForAnUnscoredFolder(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
db := database.NewTestDB(t)
|
||||||
|
svc := newTestService(t, db)
|
||||||
|
|
||||||
|
// No storeCandidates: the prefetch has not reached this folder.
|
||||||
|
albumID := seedAlbumGroup(t, db, "grp-4", 8, "pending", 0.95)
|
||||||
|
|
||||||
|
got, err := svc.MatchForAlbum(albumID)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("MatchForAlbum: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if got != nil {
|
||||||
|
t.Errorf("surfaced %+v with no cached candidates, want nothing", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A multi-disc album is several groups, and the count is what stops
|
||||||
|
// the page offering one button that would retag one disc of two.
|
||||||
|
func TestMatchForAlbumCountsEveryGroupOfTheAlbum(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
db := database.NewTestDB(t)
|
||||||
|
svc := newTestService(t, db)
|
||||||
|
|
||||||
|
albumID := seedAlbumGroup(t, db, "grp-d1", 8, "pending", 0.95)
|
||||||
|
storeCandidates(t, db, "grp-d1", 8, 0.95)
|
||||||
|
|
||||||
|
// Disc two: same album row, its own folder and tagging group.
|
||||||
|
for i := 1; i <= 6; i++ {
|
||||||
|
database.InsertTestTrack(t, db, database.TestTrack{
|
||||||
|
FilePath: filePathFor("grp-d2", i),
|
||||||
|
Title: titleFor(i),
|
||||||
|
Artist: "Tideline",
|
||||||
|
Album: "Glass Harbour",
|
||||||
|
AlbumArtist: "Tideline",
|
||||||
|
TrackNumber: int64(i),
|
||||||
|
DiscNumber: 2,
|
||||||
|
LengthMs: 200000,
|
||||||
|
LibraryID: 0,
|
||||||
|
GroupKey: "grp-d2",
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
if _, err := db.ExecContext(`
|
||||||
|
INSERT INTO tagging_items
|
||||||
|
(group_key, library_id, track_count, album_name, album_artist,
|
||||||
|
disc_number, status, score)
|
||||||
|
VALUES ('grp-d2', 0, 6, 'Glass Harbour', 'Tideline', 2, 'pending', 0.93)
|
||||||
|
`); err != nil {
|
||||||
|
t.Fatalf("insert disc two: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
storeCandidates(t, db, "grp-d2", 6, 0.93)
|
||||||
|
|
||||||
|
got, err := svc.MatchForAlbum(albumID)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("MatchForAlbum: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if got == nil {
|
||||||
|
t.Fatal("no match returned")
|
||||||
|
}
|
||||||
|
|
||||||
|
if got.GroupCount != 2 {
|
||||||
|
t.Errorf("groupCount = %d, want 2", got.GroupCount)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Best-first: the 0.95 disc is the one described.
|
||||||
|
if got.GroupKey != "grp-d1" {
|
||||||
|
t.Errorf("described %q, want the higher-scoring grp-d1", got.GroupKey)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// An album with no local files at all — a pure catalog page — is not
|
||||||
|
// a question this can answer.
|
||||||
|
func TestMatchForAlbumSaysNothingWithoutAnAlbum(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
db := database.NewTestDB(t)
|
||||||
|
svc := newTestService(t, db)
|
||||||
|
|
||||||
|
for _, id := range []int64{0, -1, 4242} {
|
||||||
|
got, err := svc.MatchForAlbum(id)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("MatchForAlbum(%d): %v", id, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if got != nil {
|
||||||
|
t.Errorf("MatchForAlbum(%d) = %+v, want nil", id, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
+119
-1
@@ -544,7 +544,7 @@ func (c *Config) SetDefaultPage(page string) error {
|
|||||||
c.General.ApplyDefaults()
|
c.General.ApplyDefaults()
|
||||||
}
|
}
|
||||||
|
|
||||||
c.General.DefaultPage = DefaultPage(page)
|
c.General.DefaultPage = View(page)
|
||||||
|
|
||||||
if err := c.General.Validate(); err != nil {
|
if err := c.General.Validate(); err != nil {
|
||||||
return fmt.Errorf(
|
return fmt.Errorf(
|
||||||
@@ -666,6 +666,124 @@ func (c *Config) SetAllowMeteredCatalogDownload(allow bool) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// GetPopupVolume reports whether the bottom bar's volume control is a
|
||||||
|
// click-to-open popup rather than an inline slider (#42).
|
||||||
|
func (c *Config) GetPopupVolume() bool {
|
||||||
|
if c.General == nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
return c.General.PopupVolume
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetPopupVolume saves the volume control's presentation.
|
||||||
|
//
|
||||||
|
// Nothing to validate: both values are legal at every width, and the
|
||||||
|
// frontend additionally stands the inline slider down below the phone
|
||||||
|
// breakpoint whatever this says, because that is about room rather than
|
||||||
|
// about preference.
|
||||||
|
func (c *Config) SetPopupVolume(popup bool) error {
|
||||||
|
if c.General == nil {
|
||||||
|
c.General = &GeneralConfig{}
|
||||||
|
c.General.ApplyDefaults()
|
||||||
|
}
|
||||||
|
|
||||||
|
c.General.PopupVolume = popup
|
||||||
|
|
||||||
|
if err := c.Save(); err != nil {
|
||||||
|
return fmt.Errorf(
|
||||||
|
"could not save config: %w", err,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
events.Emit(
|
||||||
|
c.ctx,
|
||||||
|
events.GeneralConfigChanged,
|
||||||
|
map[string]any{
|
||||||
|
"PopupVolume": popup,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
c.logger.Info("volume control presentation updated", "popup", popup)
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetViewVisibility reports which primary views the sidebar should
|
||||||
|
// show, answered for every known view rather than only the ones the
|
||||||
|
// config mentions -- so the frontend filters on a value and never has
|
||||||
|
// to hold a second copy of the defaults.
|
||||||
|
func (c *Config) GetViewVisibility() map[string]bool {
|
||||||
|
if c.General == nil {
|
||||||
|
general := &GeneralConfig{}
|
||||||
|
general.ApplyDefaults()
|
||||||
|
|
||||||
|
return general.ResolvedViewVisibility()
|
||||||
|
}
|
||||||
|
|
||||||
|
return c.General.ResolvedViewVisibility()
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetViewVisible shows or hides one primary view.
|
||||||
|
//
|
||||||
|
// Two refusals, both about a state the user cannot get out of from the
|
||||||
|
// UI they would be left with: Settings is never hideable, and the
|
||||||
|
// launch page is never hideable while it is the launch page (change it
|
||||||
|
// first). Hiding a view does not make it unreachable -- `navigate`
|
||||||
|
// still resolves it, which detail views depend on -- it only takes the
|
||||||
|
// nav item away.
|
||||||
|
func (c *Config) SetViewVisible(view string, visible bool) error {
|
||||||
|
spec, known := LookupView(view)
|
||||||
|
if !known {
|
||||||
|
return fmt.Errorf("%w: %q", errUnknownView, view)
|
||||||
|
}
|
||||||
|
|
||||||
|
if c.General == nil {
|
||||||
|
c.General = &GeneralConfig{}
|
||||||
|
c.General.ApplyDefaults()
|
||||||
|
}
|
||||||
|
|
||||||
|
if !visible {
|
||||||
|
if !spec.Hideable {
|
||||||
|
return fmt.Errorf("%w: %q", errViewNotHideable, view)
|
||||||
|
}
|
||||||
|
|
||||||
|
if spec.ID == c.General.DefaultPage {
|
||||||
|
return fmt.Errorf("%w: %q", errViewIsLaunchPage, view)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if c.General.ViewVisibility == nil {
|
||||||
|
c.General.ViewVisibility = make(map[string]bool, len(Views))
|
||||||
|
}
|
||||||
|
|
||||||
|
c.General.ViewVisibility[view] = visible
|
||||||
|
|
||||||
|
if err := c.General.Validate(); err != nil {
|
||||||
|
return fmt.Errorf("invalid view visibility: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := c.Save(); err != nil {
|
||||||
|
return fmt.Errorf("could not save config: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
events.Emit(
|
||||||
|
c.ctx,
|
||||||
|
events.GeneralConfigChanged,
|
||||||
|
map[string]any{
|
||||||
|
"ViewVisibility": c.General.ResolvedViewVisibility(),
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
c.logger.Info(
|
||||||
|
"view visibility updated",
|
||||||
|
"view", view,
|
||||||
|
"visible", visible,
|
||||||
|
)
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
// GetTrackListColumns returns the configured track-list columns.
|
// GetTrackListColumns returns the configured track-list columns.
|
||||||
func (c *Config) GetTrackListColumns() []tracklist.Column {
|
func (c *Config) GetTrackListColumns() []tracklist.Column {
|
||||||
if c.TrackList == nil {
|
if c.TrackList == nil {
|
||||||
|
|||||||
@@ -188,3 +188,43 @@ func TestEmit_FavoritesChangeCarriesFullConfig(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TestEmit_PopupVolumeRoundTripsAndDefaultsToInline pins both halves of
|
||||||
|
// #42's storage decision.
|
||||||
|
//
|
||||||
|
// The **default** is the load-bearing one: inline is what a fresh
|
||||||
|
// install and an existing `config.toml` with no such key must both
|
||||||
|
// produce, which is why the field names the popup rather than the
|
||||||
|
// inline slider. A flag spelled the other way round would default to
|
||||||
|
// false, hand every existing install the popup this issue exists to
|
||||||
|
// stop being the only option, and need a migration to say otherwise.
|
||||||
|
func TestEmit_PopupVolumeRoundTripsAndDefaultsToInline(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
conf, rec := setupRecordedConfig(t)
|
||||||
|
|
||||||
|
if conf.GetPopupVolume() {
|
||||||
|
t.Error("a config with no PopupVolume key wants the popup, want inline")
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := conf.SetPopupVolume(true); err != nil {
|
||||||
|
t.Fatalf("SetPopupVolume: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if !conf.GetPopupVolume() {
|
||||||
|
t.Error("GetPopupVolume = false after setting it true")
|
||||||
|
}
|
||||||
|
|
||||||
|
data := payloadMap(t, rec, events.GeneralConfigChanged)
|
||||||
|
if data["PopupVolume"] != true {
|
||||||
|
t.Errorf("PopupVolume = %v, want true", data["PopupVolume"])
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := conf.SetPopupVolume(false); err != nil {
|
||||||
|
t.Fatalf("SetPopupVolume(false): %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if conf.GetPopupVolume() {
|
||||||
|
t.Error("GetPopupVolume = true after setting it false")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
+96
-26
@@ -5,27 +5,13 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
)
|
)
|
||||||
|
|
||||||
// DefaultPage identifies which view the app opens to on launch.
|
|
||||||
type DefaultPage string
|
|
||||||
|
|
||||||
// Valid DefaultPage values, matching the frontend's top-level route ids.
|
|
||||||
const (
|
|
||||||
DefaultPageHome DefaultPage = "home"
|
|
||||||
DefaultPageTracks DefaultPage = "tracks"
|
|
||||||
DefaultPageAlbums DefaultPage = "albums"
|
|
||||||
DefaultPageArtists DefaultPage = "artists"
|
|
||||||
DefaultPageGenres DefaultPage = "genres"
|
|
||||||
DefaultPagePlaylists DefaultPage = "playlists"
|
|
||||||
DefaultPageExplore DefaultPage = "explore"
|
|
||||||
DefaultPageDownloads DefaultPage = "downloads"
|
|
||||||
DefaultPageAutotag DefaultPage = "autotag"
|
|
||||||
DefaultPageJobs DefaultPage = "jobs"
|
|
||||||
)
|
|
||||||
|
|
||||||
// DefaultDefaultPage is the launch page for a fresh install.
|
// DefaultDefaultPage is the launch page for a fresh install.
|
||||||
const DefaultDefaultPage = DefaultPageHome
|
const DefaultDefaultPage = ViewHome
|
||||||
|
|
||||||
var errUnknownDefaultPage = errors.New("unknown default page")
|
var (
|
||||||
|
errUnknownDefaultPage = errors.New("unknown default page")
|
||||||
|
errViewCannotLaunch = errors.New("view cannot be the launch page")
|
||||||
|
)
|
||||||
|
|
||||||
// QueueFallback identifies what plays, if anything, once the queue
|
// QueueFallback identifies what plays, if anything, once the queue
|
||||||
// runs out with nothing left to auto-advance to.
|
// runs out with nothing left to auto-advance to.
|
||||||
@@ -46,18 +32,52 @@ var errUnknownQueueFallback = errors.New("unknown queue fallback")
|
|||||||
// GeneralConfig holds general application preferences that don't
|
// GeneralConfig holds general application preferences that don't
|
||||||
// belong to a more specific subsystem.
|
// belong to a more specific subsystem.
|
||||||
type GeneralConfig struct {
|
type GeneralConfig struct {
|
||||||
DefaultPage DefaultPage `toml:"DefaultPage"`
|
DefaultPage View `toml:"DefaultPage"`
|
||||||
QueueFallback QueueFallback `toml:"QueueFallback"`
|
QueueFallback QueueFallback `toml:"QueueFallback"`
|
||||||
|
// ViewVisibility says which sidebar destinations are shown, keyed by
|
||||||
|
// view id.
|
||||||
|
//
|
||||||
|
// **An absent key means that view's own default** (`Views`), and that
|
||||||
|
// is the whole reason this is a map rather than a `HiddenViews
|
||||||
|
// []string` or a struct of booleans. A list's zero value is "hide
|
||||||
|
// nothing", which cannot express Autotag being off by default without
|
||||||
|
// a migration; a struct field for a view that later stops existing is
|
||||||
|
// stored garbage somebody has to deprecate. Here a view added later
|
||||||
|
// gets its own default rather than being invisible or forcibly
|
||||||
|
// visible, an unknown key is dropped on load, and no install needs
|
||||||
|
// migrating in either direction. Same polarity rule as
|
||||||
|
// AllowMeteredCatalogDownload: the zero value is the intended answer.
|
||||||
|
ViewVisibility map[string]bool `toml:"ViewVisibility"`
|
||||||
// AllowMeteredCatalogDownload permits the ~0.6 GB Explore catalog to
|
// AllowMeteredCatalogDownload permits the ~0.6 GB Explore catalog to
|
||||||
// be fetched on a connection the platform calls cellular. It defaults
|
// be fetched on a connection the platform calls cellular. It defaults
|
||||||
// to false, which is the whole point: the zero value is the safe one,
|
// to false, which is the whole point: the zero value is the safe one,
|
||||||
// so an existing config with no such key refuses by default rather
|
// so an existing config with no such key refuses by default rather
|
||||||
// than needing a migration to become careful.
|
// than needing a migration to become careful.
|
||||||
AllowMeteredCatalogDownload bool `toml:"AllowMeteredCatalogDownload"`
|
AllowMeteredCatalogDownload bool `toml:"AllowMeteredCatalogDownload"`
|
||||||
|
// PopupVolume draws the bottom bar's volume as a click-to-open popup
|
||||||
|
// instead of a slider that is always there (#42).
|
||||||
|
//
|
||||||
|
// The polarity is the rule this file already states twice: **the
|
||||||
|
// zero value is the intended answer**. Inline is the new default, so
|
||||||
|
// the flag has to name the *other* choice — an `InlineVolume bool`
|
||||||
|
// would default to false and give every existing install the popup
|
||||||
|
// this issue exists to stop being the only option, and would need a
|
||||||
|
// migration to say otherwise.
|
||||||
|
PopupVolume bool `toml:"PopupVolume"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// ApplyDefaults fills zero-value fields with sensible defaults.
|
// ApplyDefaults fills zero-value fields with sensible defaults.
|
||||||
|
//
|
||||||
|
// A launch page naming a *retired* view is treated as a zero value
|
||||||
|
// rather than as an error, because the alternative is an app that will
|
||||||
|
// not start for anyone who had that page selected when it was removed.
|
||||||
|
// An unknown-but-not-retired name still fails Validate: that is a typo,
|
||||||
|
// and telling someone about it is the useful answer.
|
||||||
func (c *GeneralConfig) ApplyDefaults() {
|
func (c *GeneralConfig) ApplyDefaults() {
|
||||||
|
if _, retired := RetiredViews[c.DefaultPage]; retired {
|
||||||
|
c.DefaultPage = ""
|
||||||
|
}
|
||||||
|
|
||||||
if c.DefaultPage == "" {
|
if c.DefaultPage == "" {
|
||||||
c.DefaultPage = DefaultDefaultPage
|
c.DefaultPage = DefaultDefaultPage
|
||||||
}
|
}
|
||||||
@@ -71,15 +91,17 @@ func (c *GeneralConfig) ApplyDefaults() {
|
|||||||
func (c *GeneralConfig) Validate() error {
|
func (c *GeneralConfig) Validate() error {
|
||||||
c.ApplyDefaults()
|
c.ApplyDefaults()
|
||||||
|
|
||||||
switch c.DefaultPage {
|
spec, known := LookupView(string(c.DefaultPage))
|
||||||
case DefaultPageHome, DefaultPageTracks, DefaultPageAlbums, DefaultPageArtists,
|
if !known {
|
||||||
DefaultPageGenres, DefaultPagePlaylists, DefaultPageExplore, DefaultPageDownloads,
|
|
||||||
DefaultPageAutotag, DefaultPageJobs:
|
|
||||||
// Valid.
|
|
||||||
default:
|
|
||||||
return fmt.Errorf("%w: %q", errUnknownDefaultPage, c.DefaultPage)
|
return fmt.Errorf("%w: %q", errUnknownDefaultPage, c.DefaultPage)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if !spec.CanLaunch {
|
||||||
|
return fmt.Errorf("%w: %q", errViewCannotLaunch, c.DefaultPage)
|
||||||
|
}
|
||||||
|
|
||||||
|
c.normalizeViewVisibility()
|
||||||
|
|
||||||
switch c.QueueFallback {
|
switch c.QueueFallback {
|
||||||
case QueueFallbackStop, QueueFallbackFavorites, QueueFallbackDynamicMix:
|
case QueueFallbackStop, QueueFallbackFavorites, QueueFallbackDynamicMix:
|
||||||
// Valid.
|
// Valid.
|
||||||
@@ -89,3 +111,51 @@ func (c *GeneralConfig) Validate() error {
|
|||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// normalizeViewVisibility drops what the stored map may not say, and
|
||||||
|
// repairs the one invariant the shell depends on.
|
||||||
|
//
|
||||||
|
// Three things are dropped or forced, and all three are reachable only
|
||||||
|
// from a hand-edited config or from a version that knew different
|
||||||
|
// views: an unknown id (a view removed since, e.g. when #27 folds Jobs
|
||||||
|
// into Settings) says nothing to anybody; a view that is not Hideable
|
||||||
|
// cannot be false; and **the launch page is always visible**, because
|
||||||
|
// otherwise an install lands on a page with no nav item pointing at it.
|
||||||
|
//
|
||||||
|
// That last one is a *repair* here and an *error* at the setter
|
||||||
|
// (SetViewVisible), deliberately. On load there is nobody to tell and
|
||||||
|
// the honest reading of "my launch page is Autotag" is that this user
|
||||||
|
// wants Autotag, so it is un-hidden rather than the launch page being
|
||||||
|
// silently reset to something they did not choose. At the setter the
|
||||||
|
// user is right there and can act, so it refuses and says why.
|
||||||
|
func (c *GeneralConfig) normalizeViewVisibility() {
|
||||||
|
for id := range c.ViewVisibility {
|
||||||
|
spec, known := LookupView(id)
|
||||||
|
if !known || !spec.Hideable {
|
||||||
|
delete(c.ViewVisibility, id)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if visible, ok := c.ViewVisibility[string(c.DefaultPage)]; ok && !visible {
|
||||||
|
c.ViewVisibility[string(c.DefaultPage)] = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ResolvedViewVisibility answers for every known view, so no caller has
|
||||||
|
// to know the defaults -- the frontend included, which is why the
|
||||||
|
// binding returns this rather than the stored map.
|
||||||
|
func (c *GeneralConfig) ResolvedViewVisibility() map[string]bool {
|
||||||
|
resolved := make(map[string]bool, len(Views))
|
||||||
|
|
||||||
|
for _, v := range Views {
|
||||||
|
visible := v.VisibleByDefault
|
||||||
|
|
||||||
|
if stored, ok := c.ViewVisibility[string(v.ID)]; ok && v.Hideable {
|
||||||
|
visible = stored
|
||||||
|
}
|
||||||
|
|
||||||
|
resolved[string(v.ID)] = visible
|
||||||
|
}
|
||||||
|
|
||||||
|
return resolved
|
||||||
|
}
|
||||||
|
|||||||
@@ -0,0 +1,103 @@
|
|||||||
|
package config
|
||||||
|
|
||||||
|
import "errors"
|
||||||
|
|
||||||
|
var (
|
||||||
|
errUnknownView = errors.New("unknown view")
|
||||||
|
errViewNotHideable = errors.New("view cannot be hidden")
|
||||||
|
errViewIsLaunchPage = errors.New("view is the launch page")
|
||||||
|
)
|
||||||
|
|
||||||
|
// View identifies one of the shell's primary destinations -- the
|
||||||
|
// things the sidebar lists and `index.ts` knows as `VIEW_TAGS`.
|
||||||
|
type View string
|
||||||
|
|
||||||
|
// The primary views, in no particular order: the sidebar owns the order
|
||||||
|
// it draws them in, because that is presentation.
|
||||||
|
const (
|
||||||
|
ViewHome View = "home"
|
||||||
|
ViewPlaylists View = "playlists"
|
||||||
|
ViewArtists View = "artists"
|
||||||
|
ViewGenres View = "genres"
|
||||||
|
ViewAlbums View = "albums"
|
||||||
|
ViewTracks View = "tracks"
|
||||||
|
ViewExplore View = "explore"
|
||||||
|
ViewDownloads View = "downloads"
|
||||||
|
ViewAutotag View = "autotag"
|
||||||
|
ViewSettings View = "settings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// RetiredViews are destinations that used to exist and no longer do.
|
||||||
|
//
|
||||||
|
// A *visibility* entry for a removed view needs no such list: it is a
|
||||||
|
// key in a map, and an unknown key is dropped on load. A `DefaultPage`
|
||||||
|
// is a **value**, and an unknown one fails validation -- which on the
|
||||||
|
// load path means the app refuses to start rather than a setting being
|
||||||
|
// ignored. So the one shape that cannot be retired for free is named
|
||||||
|
// here and reset to the default instead.
|
||||||
|
//
|
||||||
|
// `jobs` was folded into Settings by #27: library scans under
|
||||||
|
// Libraries, index work under Search Index, downloads under the
|
||||||
|
// download clients, and the autotag apply into the Autotag view.
|
||||||
|
var RetiredViews = map[View]struct{}{
|
||||||
|
"jobs": {},
|
||||||
|
}
|
||||||
|
|
||||||
|
// ViewSpec is what the backend knows about a destination. The label and
|
||||||
|
// the icon are deliberately absent: those are presentation, they live
|
||||||
|
// beside the rest of the app's icon vocabulary in
|
||||||
|
// `frontend/src/utils/icon-language.ts`, and a Go copy of them would be
|
||||||
|
// a second thing to keep in step for nothing.
|
||||||
|
type ViewSpec struct {
|
||||||
|
// ID is the view name the frontend navigates by.
|
||||||
|
ID View
|
||||||
|
// VisibleByDefault is what an install gets when the config says
|
||||||
|
// nothing about this view -- which is every install until somebody
|
||||||
|
// changes it, and every view added after this one shipped.
|
||||||
|
VisibleByDefault bool
|
||||||
|
// Hideable is false for Settings alone. It is a property of the
|
||||||
|
// view rather than a check in the setter because `config.toml` is
|
||||||
|
// hand-editable, and an app that can be locked out of its own
|
||||||
|
// Settings by a typo is a support problem nobody can debug
|
||||||
|
// remotely.
|
||||||
|
Hideable bool
|
||||||
|
// CanLaunch reports whether the view may be the launch page.
|
||||||
|
// Settings is the only one that may not, which is the shape the
|
||||||
|
// DefaultPage enum already had.
|
||||||
|
CanLaunch bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// Views is the one list of primary destinations, in the order Settings
|
||||||
|
// offers them.
|
||||||
|
//
|
||||||
|
// It is the single source for three things that used to be written down
|
||||||
|
// separately: which views exist, which of them may be the launch page
|
||||||
|
// (`DefaultPage`'s validation reads it), and what an unconfigured
|
||||||
|
// install shows.
|
||||||
|
//
|
||||||
|
// Autotag is the one view hidden by default: it rewrites tags on disk,
|
||||||
|
// which is not what most libraries want on day one, and #25 asks for it
|
||||||
|
// to be turned on deliberately.
|
||||||
|
var Views = []ViewSpec{
|
||||||
|
{ID: ViewHome, VisibleByDefault: true, Hideable: true, CanLaunch: true},
|
||||||
|
{ID: ViewPlaylists, VisibleByDefault: true, Hideable: true, CanLaunch: true},
|
||||||
|
{ID: ViewArtists, VisibleByDefault: true, Hideable: true, CanLaunch: true},
|
||||||
|
{ID: ViewGenres, VisibleByDefault: true, Hideable: true, CanLaunch: true},
|
||||||
|
{ID: ViewAlbums, VisibleByDefault: true, Hideable: true, CanLaunch: true},
|
||||||
|
{ID: ViewTracks, VisibleByDefault: true, Hideable: true, CanLaunch: true},
|
||||||
|
{ID: ViewExplore, VisibleByDefault: true, Hideable: true, CanLaunch: true},
|
||||||
|
{ID: ViewDownloads, VisibleByDefault: true, Hideable: true, CanLaunch: true},
|
||||||
|
{ID: ViewAutotag, VisibleByDefault: false, Hideable: true, CanLaunch: true},
|
||||||
|
{ID: ViewSettings, VisibleByDefault: true, Hideable: false, CanLaunch: false},
|
||||||
|
}
|
||||||
|
|
||||||
|
// LookupView returns the spec for a view id.
|
||||||
|
func LookupView(id string) (ViewSpec, bool) {
|
||||||
|
for _, v := range Views {
|
||||||
|
if string(v.ID) == id {
|
||||||
|
return v, true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return ViewSpec{}, false
|
||||||
|
}
|
||||||
@@ -0,0 +1,307 @@
|
|||||||
|
package config
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"log/slog"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
// newViewTestConfig builds a Config backed by a temp file, which is all
|
||||||
|
// SetViewVisible needs: it saves and emits, and the emit is a no-op
|
||||||
|
// without a running app.
|
||||||
|
func newViewTestConfig(t *testing.T) *Config {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
c := &Config{
|
||||||
|
logger: slog.Default(),
|
||||||
|
filePath: filepath.Join(t.TempDir(), "config.toml"),
|
||||||
|
}
|
||||||
|
|
||||||
|
// Load a file that is not there: that is what marks the config
|
||||||
|
// loaded, without which Save refuses on the *second* write.
|
||||||
|
if err := c.Load(); err != nil {
|
||||||
|
t.Fatalf("Load() error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return c
|
||||||
|
}
|
||||||
|
|
||||||
|
// A view the config says nothing about takes its own default, which is
|
||||||
|
// what makes this need no migration in either direction: an existing
|
||||||
|
// install gets Autotag hidden without a key, and a view added later
|
||||||
|
// gets its own answer rather than the list's.
|
||||||
|
func TestViewVisibilityDefaults(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
general := &GeneralConfig{}
|
||||||
|
general.ApplyDefaults()
|
||||||
|
|
||||||
|
resolved := general.ResolvedViewVisibility()
|
||||||
|
|
||||||
|
if len(resolved) != len(Views) {
|
||||||
|
t.Fatalf("resolved %d views, want %d", len(resolved), len(Views))
|
||||||
|
}
|
||||||
|
|
||||||
|
if resolved[string(ViewAutotag)] {
|
||||||
|
t.Error("autotag should be hidden by default")
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, v := range Views {
|
||||||
|
if v.ID == ViewAutotag {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if !resolved[string(v.ID)] {
|
||||||
|
t.Errorf("%s should be visible by default", v.ID)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A stored answer wins over the default, in both directions -- turning
|
||||||
|
// Autotag on is the whole user-facing point.
|
||||||
|
func TestViewVisibilityStoredWins(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
general := &GeneralConfig{
|
||||||
|
ViewVisibility: map[string]bool{
|
||||||
|
string(ViewAutotag): true,
|
||||||
|
string(ViewExplore): false,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
general.ApplyDefaults()
|
||||||
|
|
||||||
|
resolved := general.ResolvedViewVisibility()
|
||||||
|
|
||||||
|
if !resolved[string(ViewAutotag)] {
|
||||||
|
t.Error("autotag was switched on and should be visible")
|
||||||
|
}
|
||||||
|
|
||||||
|
if resolved[string(ViewExplore)] {
|
||||||
|
t.Error("explore was switched off and should be hidden")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A key for a view that no longer exists is discarded rather than
|
||||||
|
// migrated. This is the property the #25-before-#27 ordering rests on:
|
||||||
|
// when Jobs folds into Settings, `jobs = true` in somebody's config is
|
||||||
|
// a key nothing asks about, not a cleanup task.
|
||||||
|
func TestValidateDropsUnknownAndUnhideableViews(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
general := &GeneralConfig{
|
||||||
|
ViewVisibility: map[string]bool{
|
||||||
|
"a-view-that-was-removed": true,
|
||||||
|
string(ViewSettings): false,
|
||||||
|
string(ViewAutotag): true,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := general.Validate(); err != nil {
|
||||||
|
t.Fatalf("Validate() error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if _, ok := general.ViewVisibility["a-view-that-was-removed"]; ok {
|
||||||
|
t.Error("an unknown view id should be dropped on load")
|
||||||
|
}
|
||||||
|
|
||||||
|
if _, ok := general.ViewVisibility[string(ViewSettings)]; ok {
|
||||||
|
t.Error("settings is not hideable and should not be stored")
|
||||||
|
}
|
||||||
|
|
||||||
|
if !general.ResolvedViewVisibility()[string(ViewSettings)] {
|
||||||
|
t.Error("settings must resolve visible whatever the file said")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// On load there is nobody to tell, so a launch page hidden by a
|
||||||
|
// hand-edited file is un-hidden rather than the launch page being
|
||||||
|
// reset to something the user did not choose.
|
||||||
|
func TestValidateRevealsAHiddenLaunchPage(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
general := &GeneralConfig{
|
||||||
|
DefaultPage: ViewAutotag,
|
||||||
|
ViewVisibility: map[string]bool{
|
||||||
|
string(ViewAutotag): false,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := general.Validate(); err != nil {
|
||||||
|
t.Fatalf("Validate() error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if !general.ResolvedViewVisibility()[string(ViewAutotag)] {
|
||||||
|
t.Error("the launch page must be visible")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A launch page naming a view that no longer exists resets to the
|
||||||
|
// default instead of failing validation, which on the load path would
|
||||||
|
// mean the app refusing to start for whoever had it selected.
|
||||||
|
//
|
||||||
|
// This is the one shape #25's storage decision does *not* make free: a
|
||||||
|
// visibility entry is a key and an unknown key is dropped, but a launch
|
||||||
|
// page is a value.
|
||||||
|
func TestARetiredLaunchPageFallsBackToTheDefault(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
general := &GeneralConfig{DefaultPage: "jobs"}
|
||||||
|
|
||||||
|
if err := general.Validate(); err != nil {
|
||||||
|
t.Fatalf("Validate() error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if general.DefaultPage != DefaultDefaultPage {
|
||||||
|
t.Errorf("DefaultPage = %q, want %q", general.DefaultPage, DefaultDefaultPage)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A name that is merely wrong is still an error: that is a typo, and
|
||||||
|
// saying so is more useful than ignoring it.
|
||||||
|
func TestAnUnknownLaunchPageIsStillAnError(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
general := &GeneralConfig{DefaultPage: "nonsense"}
|
||||||
|
|
||||||
|
if err := general.Validate(); !errors.Is(err, errUnknownDefaultPage) {
|
||||||
|
t.Fatalf("Validate() error = %v, want errUnknownDefaultPage", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A retired view is not a view, so nothing offers it and nothing
|
||||||
|
// resolves it -- the visibility map included.
|
||||||
|
func TestARetiredViewIsGone(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
for id := range RetiredViews {
|
||||||
|
if _, ok := LookupView(string(id)); ok {
|
||||||
|
t.Errorf("%s is retired but still in Views", id)
|
||||||
|
}
|
||||||
|
|
||||||
|
general := &GeneralConfig{}
|
||||||
|
general.ApplyDefaults()
|
||||||
|
|
||||||
|
if _, ok := general.ResolvedViewVisibility()[string(id)]; ok {
|
||||||
|
t.Errorf("%s is retired but still resolves a visibility", id)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Settings may not be the launch page, which is the shape the old
|
||||||
|
// DefaultPage enum had and is now read off the same table.
|
||||||
|
func TestValidateRejectsAnUnlaunchablePage(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
general := &GeneralConfig{DefaultPage: ViewSettings}
|
||||||
|
|
||||||
|
err := general.Validate()
|
||||||
|
if !errors.Is(err, errViewCannotLaunch) {
|
||||||
|
t.Fatalf("Validate() error = %v, want errViewCannotLaunch", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// At the setter the user is present and can act, so the two states
|
||||||
|
// they could not get out of are refused rather than repaired.
|
||||||
|
func TestSetViewVisibleRefusals(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
view string
|
||||||
|
visible bool
|
||||||
|
want error
|
||||||
|
}{
|
||||||
|
{"settings is never hideable", string(ViewSettings), false, errViewNotHideable},
|
||||||
|
{"the launch page is not hideable", string(ViewHome), false, errViewIsLaunchPage},
|
||||||
|
{"an unknown view is not a setting", "nonsense", false, errUnknownView},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
c := newViewTestConfig(t)
|
||||||
|
|
||||||
|
err := c.SetViewVisible(tt.view, tt.visible)
|
||||||
|
if !errors.Is(err, tt.want) {
|
||||||
|
t.Fatalf("SetViewVisible() error = %v, want %v", err, tt.want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Showing a view is never refused, including Settings and the launch
|
||||||
|
// page -- there is no state to be stuck in.
|
||||||
|
func TestSetViewVisibleShowsAnything(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
c := newViewTestConfig(t)
|
||||||
|
|
||||||
|
for _, v := range Views {
|
||||||
|
if err := c.SetViewVisible(string(v.ID), true); err != nil {
|
||||||
|
t.Fatalf("SetViewVisible(%q, true) error: %v", v.ID, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if !c.GetViewVisibility()[string(ViewAutotag)] {
|
||||||
|
t.Error("autotag was switched on and should be visible")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// The stored map survives a save/load round trip, which is what a
|
||||||
|
// map-valued TOML key is worth checking for.
|
||||||
|
func TestViewVisibilityRoundTrips(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
path := filepath.Join(t.TempDir(), "config.toml")
|
||||||
|
|
||||||
|
original := &Config{logger: slog.Default(), filePath: path}
|
||||||
|
if err := original.Load(); err != nil {
|
||||||
|
t.Fatalf("Load() error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := original.SetViewVisible(string(ViewAutotag), true); err != nil {
|
||||||
|
t.Fatalf("SetViewVisible() error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := original.SetViewVisible(string(ViewExplore), false); err != nil {
|
||||||
|
t.Fatalf("SetViewVisible() error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
loaded := &Config{logger: slog.Default(), filePath: path}
|
||||||
|
if err := loaded.Load(); err != nil {
|
||||||
|
t.Fatalf("Load() error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
resolved := loaded.GetViewVisibility()
|
||||||
|
|
||||||
|
if !resolved[string(ViewAutotag)] {
|
||||||
|
t.Error("autotag should have loaded as visible")
|
||||||
|
}
|
||||||
|
|
||||||
|
if resolved[string(ViewExplore)] {
|
||||||
|
t.Error("explore should have loaded as hidden")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Every view the shell can launch into is a view the sidebar can show,
|
||||||
|
// or an install could land on a page with no nav item and no setting
|
||||||
|
// pointing at it.
|
||||||
|
func TestEveryLaunchableViewIsAView(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
for _, v := range Views {
|
||||||
|
if !v.CanLaunch {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if !v.Hideable {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if _, ok := LookupView(string(v.ID)); !ok {
|
||||||
|
t.Errorf("%s is launchable but not a known view", v.ID)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -13,13 +13,31 @@ const (
|
|||||||
// enforces this at runtime; it is also the floor below which a
|
// enforces this at runtime; it is also the floor below which a
|
||||||
// reported size is treated as bogus and not persisted.
|
// reported size is treated as bogus and not persisted.
|
||||||
//
|
//
|
||||||
// 800x600 is where the shell was measured to still work, rather
|
// **Both reasons this comment used to give have expired**, and the
|
||||||
// than a round number: below ~780 the header's subtitle wraps and
|
// value is right for a third one. It said the floor was 800x600
|
||||||
// pushes the title out of the 4em top bar, and below ~600 tall the
|
// because "below ~780 the header's subtitle wraps and pushes the
|
||||||
// eleven sidebar items no longer fit at once. The previous
|
// title out of the 4em top bar" and "below ~600 tall the eleven
|
||||||
// 512x384 was aspirational — at 700x480 the sidebar overflowed
|
// sidebar items no longer fit at once". Neither mechanism can
|
||||||
// behind the player bar with no scroll and Settings and Jobs could
|
// happen now: the subtitle is display:none from 899px down
|
||||||
// not be reached at all.
|
// (index.css), and the sidebar host is overflow-y:auto — measured
|
||||||
|
// at 600x460, its scrollHeight is 434 against a 332px client and
|
||||||
|
// Settings is reachable after scrolling. A floor defended by two
|
||||||
|
// mechanisms that no longer exist is a number nobody can argue
|
||||||
|
// with, which is worse than either answer.
|
||||||
|
//
|
||||||
|
// It stays 800x600 because that is where the *desktop* chrome
|
||||||
|
// stops being comfortable — the Compact band of plan 018's size
|
||||||
|
// matrix (#24) — and not because the app breaks below it. It does
|
||||||
|
// not: under 600px wide the phone layout takes over (bottom-nav,
|
||||||
|
// no sidebar) and the shell fits 320px exactly, which is what
|
||||||
|
// makes this a comfort floor rather than a correctness one, and
|
||||||
|
// why a very small window reflows instead of becoming a
|
||||||
|
// mini-player (#12 is a second always-on-top window, not a mode of
|
||||||
|
// this one).
|
||||||
|
//
|
||||||
|
// The previous 512x384 was aspirational — at 700x480 the sidebar
|
||||||
|
// overflowed behind the player bar with no scroll and Settings and
|
||||||
|
// Jobs could not be reached at all.
|
||||||
MinWidth = 800
|
MinWidth = 800
|
||||||
// MinHeight is the smallest allowed window height in pixels.
|
// MinHeight is the smallest allowed window height in pixels.
|
||||||
MinHeight = 600
|
MinHeight = 600
|
||||||
|
|||||||
@@ -342,3 +342,35 @@ WHERE ti.status = 'pending'
|
|||||||
)
|
)
|
||||||
ORDER BY ti.group_key
|
ORDER BY ti.group_key
|
||||||
LIMIT 1;
|
LIMIT 1;
|
||||||
|
|
||||||
|
-- name: GetTaggingItemsForAlbum :many
|
||||||
|
-- Every tagging group holding a file of this album.
|
||||||
|
--
|
||||||
|
-- The join is `audio_files.group_key`, not a key derived from the
|
||||||
|
-- album's folder path: a group carved out of a mixed-bag folder by
|
||||||
|
-- SplitMixedFolder is keyed on its tags rather than on a directory,
|
||||||
|
-- so a path-derived key finds nothing for exactly the messiest
|
||||||
|
-- libraries this is meant to help.
|
||||||
|
--
|
||||||
|
-- Usually one row. A multi-disc album is one group per disc, which
|
||||||
|
-- the caller has to know about rather than average over -- applying
|
||||||
|
-- to "the album" would silently retag one disc of three.
|
||||||
|
SELECT
|
||||||
|
ti.group_key,
|
||||||
|
ti.status,
|
||||||
|
ti.score,
|
||||||
|
ti.best_match_release_mbid,
|
||||||
|
ti.track_count,
|
||||||
|
ti.album_name,
|
||||||
|
ti.album_artist,
|
||||||
|
ti.synthetic
|
||||||
|
FROM tagging_items ti
|
||||||
|
WHERE ti.group_key IN (
|
||||||
|
SELECT DISTINCT af.group_key
|
||||||
|
FROM audio_files af
|
||||||
|
WHERE af.album_id = sqlc.arg(album_id) AND af.group_key != ''
|
||||||
|
)
|
||||||
|
AND ti.cleared_at IS NULL
|
||||||
|
-- Best first, with an unscored group last rather than first: NULL
|
||||||
|
-- sorts low in SQLite and DESC would put it at the top.
|
||||||
|
ORDER BY ti.score IS NULL, ti.score DESC, ti.group_key;
|
||||||
|
|||||||
@@ -231,6 +231,82 @@ func (q *Queries) GetTaggingItem(ctx context.Context, groupKey string) (TaggingI
|
|||||||
return i, err
|
return i, err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const getTaggingItemsForAlbum = `-- name: GetTaggingItemsForAlbum :many
|
||||||
|
SELECT
|
||||||
|
ti.group_key,
|
||||||
|
ti.status,
|
||||||
|
ti.score,
|
||||||
|
ti.best_match_release_mbid,
|
||||||
|
ti.track_count,
|
||||||
|
ti.album_name,
|
||||||
|
ti.album_artist,
|
||||||
|
ti.synthetic
|
||||||
|
FROM tagging_items ti
|
||||||
|
WHERE ti.group_key IN (
|
||||||
|
SELECT DISTINCT af.group_key
|
||||||
|
FROM audio_files af
|
||||||
|
WHERE af.album_id = ?1 AND af.group_key != ''
|
||||||
|
)
|
||||||
|
AND ti.cleared_at IS NULL
|
||||||
|
ORDER BY ti.score IS NULL, ti.score DESC, ti.group_key
|
||||||
|
`
|
||||||
|
|
||||||
|
type GetTaggingItemsForAlbumRow struct {
|
||||||
|
GroupKey string
|
||||||
|
Status string
|
||||||
|
Score sql.NullFloat64
|
||||||
|
BestMatchReleaseMbid sql.NullString
|
||||||
|
TrackCount int64
|
||||||
|
AlbumName string
|
||||||
|
AlbumArtist string
|
||||||
|
Synthetic int64
|
||||||
|
}
|
||||||
|
|
||||||
|
// Every tagging group holding a file of this album.
|
||||||
|
//
|
||||||
|
// The join is `audio_files.group_key`, not a key derived from the
|
||||||
|
// album's folder path: a group carved out of a mixed-bag folder by
|
||||||
|
// SplitMixedFolder is keyed on its tags rather than on a directory,
|
||||||
|
// so a path-derived key finds nothing for exactly the messiest
|
||||||
|
// libraries this is meant to help.
|
||||||
|
//
|
||||||
|
// Usually one row. A multi-disc album is one group per disc, which
|
||||||
|
// the caller has to know about rather than average over -- applying
|
||||||
|
// to "the album" would silently retag one disc of three.
|
||||||
|
// Best first, with an unscored group last rather than first: NULL
|
||||||
|
// sorts low in SQLite and DESC would put it at the top.
|
||||||
|
func (q *Queries) GetTaggingItemsForAlbum(ctx context.Context, albumID sql.NullInt64) ([]GetTaggingItemsForAlbumRow, error) {
|
||||||
|
rows, err := q.db.QueryContext(ctx, getTaggingItemsForAlbum, albumID)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
defer rows.Close()
|
||||||
|
var items []GetTaggingItemsForAlbumRow
|
||||||
|
for rows.Next() {
|
||||||
|
var i GetTaggingItemsForAlbumRow
|
||||||
|
if err := rows.Scan(
|
||||||
|
&i.GroupKey,
|
||||||
|
&i.Status,
|
||||||
|
&i.Score,
|
||||||
|
&i.BestMatchReleaseMbid,
|
||||||
|
&i.TrackCount,
|
||||||
|
&i.AlbumName,
|
||||||
|
&i.AlbumArtist,
|
||||||
|
&i.Synthetic,
|
||||||
|
); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
items = append(items, i)
|
||||||
|
}
|
||||||
|
if err := rows.Close(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if err := rows.Err(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return items, nil
|
||||||
|
}
|
||||||
|
|
||||||
const listAudioFilesInTaggingGroup = `-- name: ListAudioFilesInTaggingGroup :many
|
const listAudioFilesInTaggingGroup = `-- name: ListAudioFilesInTaggingGroup :many
|
||||||
SELECT
|
SELECT
|
||||||
af.id,
|
af.id,
|
||||||
|
|||||||
@@ -82,6 +82,100 @@ func TestPruneStaleLocalCrossReferences(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TestPruneClearsInLibraryWithNoLocalID covers the fixed point: a row
|
||||||
|
// carrying in_library with a NULL local_*_id. The upsert's conflict
|
||||||
|
// clause is `in_library = MAX(in_library, excluded.in_library)`, so it
|
||||||
|
// can only ever raise the flag, and this pass used to be gated on the id
|
||||||
|
// being present — which meant nothing in the app could clear such a row,
|
||||||
|
// ever. It is asserted for all three entity types because the gate was
|
||||||
|
// written once and used three times, so a fix applied to one is a fix
|
||||||
|
// that looks complete.
|
||||||
|
//
|
||||||
|
// The rows are seeded with raw SQL rather than through seedIndexResult
|
||||||
|
// deliberately: upsertBatch writes a zero LocalArtistID as literal 0,
|
||||||
|
// not NULL, and 0 satisfies `IS NOT NULL` — so the old gate already
|
||||||
|
// caught that shape and a fixture built through the upsert cannot
|
||||||
|
// reproduce this at all. NULL is what the artifact importer and any
|
||||||
|
// older writer leave behind, the column being nullable with no default.
|
||||||
|
func TestPruneClearsInLibraryWithNoLocalID(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
db := database.NewTestDB(t)
|
||||||
|
si := NewSearchIndex(db, nil, nil, slog.Default())
|
||||||
|
|
||||||
|
// A genuinely owned artist, to prove the wider gate does not simply
|
||||||
|
// clear everything it now looks at.
|
||||||
|
database.InsertTestTrack(t, db, database.TestTrack{
|
||||||
|
FilePath: "/music/owned.mp3",
|
||||||
|
Artist: "Owned",
|
||||||
|
})
|
||||||
|
|
||||||
|
artist, err := db.Queries.GetArtistByName(t.Context(), "Owned")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("read seeded artist: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
seedIndexResult(t, db, SearchIndexResult{
|
||||||
|
EntityType: EntityArtist,
|
||||||
|
MBID: testMBID("owned"),
|
||||||
|
Title: "Owned",
|
||||||
|
ArtistName: "Owned",
|
||||||
|
ArtistMBID: testMBID("owned"),
|
||||||
|
InLibrary: true,
|
||||||
|
LocalArtistID: artist.ID,
|
||||||
|
})
|
||||||
|
|
||||||
|
orphans := []struct {
|
||||||
|
name string
|
||||||
|
entityType string
|
||||||
|
mbid string
|
||||||
|
}{
|
||||||
|
{"artist", EntityArtist, "orphan-artist"},
|
||||||
|
{"release group", EntityReleaseGroup, "orphan-release-group"},
|
||||||
|
{"recording", EntityRecording, "orphan-recording"},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, o := range orphans {
|
||||||
|
if _, err := db.ExecContext(
|
||||||
|
`INSERT INTO explore_index
|
||||||
|
(entity_type, mbid, title, artist_name, artist_mbid,
|
||||||
|
in_library,
|
||||||
|
local_artist_id, local_release_group_id, local_recording_id)
|
||||||
|
VALUES (?, ?, ?, ?, ?, 1, ?, ?, ?)`,
|
||||||
|
dbEntityType(o.entityType), dbMBID(testMBID(o.mbid)), o.name, o.name,
|
||||||
|
dbMBID(testMBID(o.mbid)),
|
||||||
|
nil, nil, nil,
|
||||||
|
); err != nil {
|
||||||
|
t.Fatalf("seed %s orphan: %v", o.name, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
si.pruneStaleLocalCrossReferences()
|
||||||
|
|
||||||
|
inLibrary := func(t *testing.T, mbid string) int {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var flag int
|
||||||
|
if err := db.QueryRowWriter(
|
||||||
|
"SELECT in_library FROM explore_index WHERE mbid = ?", dbMBID(mbid),
|
||||||
|
).Scan(&flag); err != nil {
|
||||||
|
t.Fatalf("read in_library for %q: %v", mbid, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return flag
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, o := range orphans {
|
||||||
|
if got := inLibrary(t, testMBID(o.mbid)); got != 0 {
|
||||||
|
t.Errorf("%s with a NULL local id: in_library = %d, want 0", o.name, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if got := inLibrary(t, testMBID("owned")); got != 1 {
|
||||||
|
t.Errorf("owned artist: in_library = %d, want 1 (it still has a file)", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// TestUnenrichedLibraryArtistMBIDs_OrdersByOwnedTrackCount verifies the
|
// TestUnenrichedLibraryArtistMBIDs_OrdersByOwnedTrackCount verifies the
|
||||||
// backfill queue prioritizes artists by how many tracks the user actually
|
// backfill queue prioritizes artists by how many tracks the user actually
|
||||||
// owns, not by how many duplicate-mbid artist rows happen to exist (the
|
// owns, not by how many duplicate-mbid artist rows happen to exist (the
|
||||||
|
|||||||
@@ -2562,6 +2562,19 @@ func (si *SearchIndex) PopulateLocalCrossReferences() {
|
|||||||
// The row itself is left in place (it may still be part of the shipped
|
// The row itself is left in place (it may still be part of the shipped
|
||||||
// catalog, just no longer owned) — only the "this is mine" bookkeeping
|
// catalog, just no longer owned) — only the "this is mine" bookkeeping
|
||||||
// is cleared.
|
// is cleared.
|
||||||
|
//
|
||||||
|
// It is gated on the flag *or* the id, not on the id alone. Gated on
|
||||||
|
// the id, `in_library = 1 AND local_*_id IS NULL` is a fixed point: the
|
||||||
|
// upsert can only ever raise the flag and this pass skipped such a row
|
||||||
|
// by construction, so nothing in the app could clear it — a row claiming
|
||||||
|
// to be owned, permanently, with no local row to check the claim
|
||||||
|
// against. Nothing in the tree writes that shape today
|
||||||
|
// (collectLibraryEntities sets both together), which is exactly why it
|
||||||
|
// is worth closing now: the exposure is a database written by an older
|
||||||
|
// version, and the next writer that sets the flag without an id, which
|
||||||
|
// nothing structurally prevents. A NULL id fails the existence test on
|
||||||
|
// its own, so the wider gate needs no second clause to say what "not
|
||||||
|
// owned" means.
|
||||||
func (si *SearchIndex) pruneStaleLocalCrossReferences() {
|
func (si *SearchIndex) pruneStaleLocalCrossReferences() {
|
||||||
type prune struct {
|
type prune struct {
|
||||||
entityType string
|
entityType string
|
||||||
@@ -2594,7 +2607,8 @@ func (si *SearchIndex) pruneStaleLocalCrossReferences() {
|
|||||||
result, err := si.db.ExecContext(
|
result, err := si.db.ExecContext(
|
||||||
`UPDATE explore_index
|
`UPDATE explore_index
|
||||||
SET in_library = 0, `+p.column+` = NULL
|
SET in_library = 0, `+p.column+` = NULL
|
||||||
WHERE entity_type = ? AND `+p.column+` IS NOT NULL
|
WHERE entity_type = ?
|
||||||
|
AND (`+p.column+` IS NOT NULL OR in_library = 1)
|
||||||
AND NOT EXISTS (`+p.exists+`)`,
|
AND NOT EXISTS (`+p.exists+`)`,
|
||||||
dbEntityType(p.entityType),
|
dbEntityType(p.entityType),
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -0,0 +1,188 @@
|
|||||||
|
package player
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/gopxl/beep/v2"
|
||||||
|
)
|
||||||
|
|
||||||
|
// errTestDecode stands in for a decoder blowing up mid-track.
|
||||||
|
var errTestDecode = errors.New("decode blew up")
|
||||||
|
|
||||||
|
// stalledStreamer never produces a sample and never reports
|
||||||
|
// end-of-stream: (0, true), forever. A damaged file that decodes to
|
||||||
|
// nothing looks like this, and so does any source whose producer has
|
||||||
|
// quietly stopped.
|
||||||
|
type stalledStreamer struct{}
|
||||||
|
|
||||||
|
func (stalledStreamer) Stream(_ [][2]float64) (int, bool) { return 0, true }
|
||||||
|
func (stalledStreamer) Err() error { return nil }
|
||||||
|
|
||||||
|
// failingStreamer produces n good samples and then fails, which is
|
||||||
|
// what a decode error mid-track looks like: the same (0, false) a
|
||||||
|
// finished track returns, distinguishable only by Err.
|
||||||
|
type failingStreamer struct {
|
||||||
|
remaining int
|
||||||
|
err error
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *failingStreamer) Stream(samples [][2]float64) (int, bool) {
|
||||||
|
if f.remaining <= 0 {
|
||||||
|
return 0, false
|
||||||
|
}
|
||||||
|
|
||||||
|
n := min(len(samples), f.remaining)
|
||||||
|
|
||||||
|
for i := range n {
|
||||||
|
samples[i] = [2]float64{1, 1}
|
||||||
|
}
|
||||||
|
|
||||||
|
f.remaining -= n
|
||||||
|
|
||||||
|
return n, true
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *failingStreamer) Err() error { return f.err }
|
||||||
|
|
||||||
|
// drainUntilEnd calls Stream until it reports end-of-stream, or gives
|
||||||
|
// up. It returns whether the stream ended.
|
||||||
|
//
|
||||||
|
// The give-up bound is wall clock rather than a call count: the stall
|
||||||
|
// budget is a duration, so a tight loop has to actually wait it out.
|
||||||
|
func drainUntilEnd(bs *BufferedStreamer, within time.Duration) bool {
|
||||||
|
buf := make([][2]float64, 512)
|
||||||
|
deadline := time.Now().Add(within)
|
||||||
|
|
||||||
|
for time.Now().Before(deadline) {
|
||||||
|
if _, ok := bs.Stream(buf); !ok {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
time.Sleep(time.Millisecond)
|
||||||
|
}
|
||||||
|
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// A source that stops producing without ever ending is the fault this
|
||||||
|
// whole file exists for: Stream used to answer with silence and ok
|
||||||
|
// forever, so the chain never ended, the player stayed in Playing
|
||||||
|
// with the button showing pause, and the decoder's position never
|
||||||
|
// moved -- a frozen seek bar over a track that was not playing.
|
||||||
|
func TestAStalledSourceEndsTheStream(t *testing.T) {
|
||||||
|
bs := NewBufferedStreamer(stalledStreamer{}, 2048)
|
||||||
|
defer bs.Close()
|
||||||
|
|
||||||
|
if !drainUntilEnd(bs, maxStarvedDuration+2*time.Second) {
|
||||||
|
t.Fatal(
|
||||||
|
"a stalled source never ended the stream: the player " +
|
||||||
|
"would sit in Playing with a frozen position",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
if !errors.Is(bs.Err(), errSourceStalled) {
|
||||||
|
t.Fatalf(
|
||||||
|
"expected the stall to be reported, got %v", bs.Err(),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Close is the other exit that used to leave `done` false, with the
|
||||||
|
// same consequence: the ring drains and every call after it is
|
||||||
|
// silence that claims to be audio.
|
||||||
|
func TestClosingEndsTheStream(t *testing.T) {
|
||||||
|
bs := NewBufferedStreamer(finiteStreamer(1<<20), 2048)
|
||||||
|
|
||||||
|
// Let the read-ahead fill something, so this exercises the drain
|
||||||
|
// after Close rather than a buffer that was empty anyway.
|
||||||
|
time.Sleep(20 * time.Millisecond)
|
||||||
|
bs.Close()
|
||||||
|
|
||||||
|
if !drainUntilEnd(bs, 2*time.Second) {
|
||||||
|
t.Fatal("a closed streamer never reported end-of-stream")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A source that fails is not a source that finished, and only Err
|
||||||
|
// tells them apart. Before this, the player reported a mid-track
|
||||||
|
// decode failure to the queue as a natural end, so the queue
|
||||||
|
// auto-advanced in silence and counted the broken track as played.
|
||||||
|
func TestAFailedSourceReportsItsError(t *testing.T) {
|
||||||
|
src := &failingStreamer{remaining: 4096, err: errTestDecode}
|
||||||
|
|
||||||
|
bs := NewBufferedStreamer(src, 2048)
|
||||||
|
defer bs.Close()
|
||||||
|
|
||||||
|
if !drainUntilEnd(bs, 2*time.Second) {
|
||||||
|
t.Fatal("a failing source never reported end-of-stream")
|
||||||
|
}
|
||||||
|
|
||||||
|
if !errors.Is(bs.Err(), errTestDecode) {
|
||||||
|
t.Fatalf(
|
||||||
|
"expected the source's error to survive, got %v",
|
||||||
|
bs.Err(),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// The ordinary case has to keep working: a source that ends cleanly
|
||||||
|
// ends with no error, or every finished track would be reported as a
|
||||||
|
// failure and skipped.
|
||||||
|
func TestADrainedSourceReportsNoError(t *testing.T) {
|
||||||
|
bs := NewBufferedStreamer(finiteStreamer(4096), 2048)
|
||||||
|
defer bs.Close()
|
||||||
|
|
||||||
|
if !drainUntilEnd(bs, 2*time.Second) {
|
||||||
|
t.Fatal("a finite source never reported end-of-stream")
|
||||||
|
}
|
||||||
|
|
||||||
|
if bs.Err() != nil {
|
||||||
|
t.Fatalf(
|
||||||
|
"a track that finished normally reported %v", bs.Err(),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A slow source is exactly what the read-ahead exists to absorb, so
|
||||||
|
// underruns must not be charged cumulatively -- otherwise a file on a
|
||||||
|
// slow disk ends itself partway through.
|
||||||
|
func TestUnderrunsDoNotAccumulateAcrossASlowSource(t *testing.T) {
|
||||||
|
const total = 8192
|
||||||
|
|
||||||
|
src := &slowStreamer{
|
||||||
|
inner: finiteStreamer(total),
|
||||||
|
delay: 2 * time.Millisecond,
|
||||||
|
}
|
||||||
|
|
||||||
|
bs := NewBufferedStreamer(src, 1024)
|
||||||
|
defer bs.Close()
|
||||||
|
|
||||||
|
buf := make([][2]float64, 256)
|
||||||
|
got := 0
|
||||||
|
|
||||||
|
for {
|
||||||
|
n, ok := bs.Stream(buf)
|
||||||
|
if !ok {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
for i := range n {
|
||||||
|
if buf[i][0] != 0 {
|
||||||
|
got++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if got != total {
|
||||||
|
t.Fatalf(
|
||||||
|
"a slow but healthy source was cut short: got %d of %d "+
|
||||||
|
"samples",
|
||||||
|
got, total,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// beep.Streamer is what the player wraps; keep the type honest.
|
||||||
|
var _ beep.Streamer = (*BufferedStreamer)(nil)
|
||||||
@@ -1,6 +1,7 @@
|
|||||||
package player
|
package player
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"errors"
|
||||||
"sync"
|
"sync"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
@@ -34,8 +35,45 @@ type BufferedStreamer struct {
|
|||||||
done bool
|
done bool
|
||||||
err error
|
err error
|
||||||
closed chan struct{}
|
closed chan struct{}
|
||||||
|
|
||||||
|
// starved counts consecutive Stream calls served with silence
|
||||||
|
// because the ring was empty, and starvedSince is when that run
|
||||||
|
// began. An underrun is legitimate for a moment -- that is what
|
||||||
|
// the read-ahead exists to absorb -- but it is not legitimate
|
||||||
|
// forever, and "forever" is indistinguishable from healthy
|
||||||
|
// playback everywhere above this type: the chain never ends, so
|
||||||
|
// the player stays in Playing with the button showing pause, and
|
||||||
|
// the decoder's position never moves, so the 1 Hz report pins the
|
||||||
|
// seek bar and suppresses its interpolation.
|
||||||
|
starved int
|
||||||
|
starvedSince time.Time
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The silence fill is bounded by both a duration and a run of calls,
|
||||||
|
// and it needs both.
|
||||||
|
//
|
||||||
|
// Duration alone is the real measure -- the speaker paces itself, so
|
||||||
|
// wall clock is what says whether the source has actually stopped --
|
||||||
|
// but a caller draining in a tight loop (a test, a decode-to-buffer)
|
||||||
|
// makes hundreds of calls in microseconds and would trip nothing.
|
||||||
|
// A call count alone is the opposite failure: the same tight loop
|
||||||
|
// spends the whole budget before the read-ahead goroutine has been
|
||||||
|
// scheduled once, and ends a perfectly good stream at sample zero.
|
||||||
|
//
|
||||||
|
// The duration is longer than the 2 s read-ahead it is there to
|
||||||
|
// outlast, and the count is short enough that the speaker (~200 ms a
|
||||||
|
// call) reaches it well inside that.
|
||||||
|
const (
|
||||||
|
maxStarvedDuration = 3 * time.Second
|
||||||
|
minStarvedCalls = 8
|
||||||
|
)
|
||||||
|
|
||||||
|
// errSourceStalled is returned by Err when the source stopped
|
||||||
|
// producing samples without ever reporting end-of-stream.
|
||||||
|
var errSourceStalled = errors.New(
|
||||||
|
"audio source stopped producing samples",
|
||||||
|
)
|
||||||
|
|
||||||
// NewBufferedStreamer creates a BufferedStreamer that pre-fills
|
// NewBufferedStreamer creates a BufferedStreamer that pre-fills
|
||||||
// bufferSize samples from source via a background goroutine.
|
// bufferSize samples from source via a background goroutine.
|
||||||
// A typical bufferSize is 2× the sample rate (~2 seconds of audio).
|
// A typical bufferSize is 2× the sample rate (~2 seconds of audio).
|
||||||
@@ -54,8 +92,24 @@ func NewBufferedStreamer(
|
|||||||
return bs
|
return bs
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// finish marks the stream ended, recording err as the reason when
|
||||||
|
// there is one. Every exit from readAhead goes through it: an exit
|
||||||
|
// that leaves done false strands Stream in its underrun branch,
|
||||||
|
// where it returns silence and ok forever.
|
||||||
|
func (bs *BufferedStreamer) finish(err error) {
|
||||||
|
bs.mu.Lock()
|
||||||
|
defer bs.mu.Unlock()
|
||||||
|
|
||||||
|
bs.done = true
|
||||||
|
|
||||||
|
if err != nil && bs.err == nil {
|
||||||
|
bs.err = err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// readAhead continuously reads from the source into the ring buffer
|
// readAhead continuously reads from the source into the ring buffer
|
||||||
// until the source is drained, an error occurs, or Close is called.
|
// until the source is drained, an error occurs, or Close is called.
|
||||||
|
// It always marks the stream done on the way out.
|
||||||
func (bs *BufferedStreamer) readAhead() {
|
func (bs *BufferedStreamer) readAhead() {
|
||||||
// Temporary buffer for reading from source outside the lock.
|
// Temporary buffer for reading from source outside the lock.
|
||||||
// 512 samples per chunk keeps the critical section short.
|
// 512 samples per chunk keeps the critical section short.
|
||||||
@@ -63,6 +117,13 @@ func (bs *BufferedStreamer) readAhead() {
|
|||||||
|
|
||||||
tmp := make([][2]float64, chunkSize)
|
tmp := make([][2]float64, chunkSize)
|
||||||
|
|
||||||
|
// Every exit marks the stream done. An exit that does not is what
|
||||||
|
// stranded Stream in its underrun branch, returning silence and ok
|
||||||
|
// for the rest of the process's life.
|
||||||
|
var exitErr error
|
||||||
|
|
||||||
|
defer func() { bs.finish(exitErr) }()
|
||||||
|
|
||||||
for {
|
for {
|
||||||
// Check if closed.
|
// Check if closed.
|
||||||
select {
|
select {
|
||||||
@@ -72,6 +133,15 @@ func (bs *BufferedStreamer) readAhead() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
bs.mu.Lock()
|
bs.mu.Lock()
|
||||||
|
|
||||||
|
// Stream gave up waiting for us. Nothing downstream is
|
||||||
|
// listening any more, so filling the ring is work for nobody.
|
||||||
|
if bs.done {
|
||||||
|
bs.mu.Unlock()
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
space := len(bs.ring) - bs.count
|
space := len(bs.ring) - bs.count
|
||||||
|
|
||||||
if space == 0 {
|
if space == 0 {
|
||||||
@@ -115,14 +185,12 @@ func (bs *BufferedStreamer) readAhead() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if !ok {
|
if !ok {
|
||||||
bs.mu.Lock()
|
// A drained source and a failed one both land here and are
|
||||||
bs.done = true
|
// not the same event: one is a track that ended, the other
|
||||||
|
// is a track that broke. Err is what tells them apart, and
|
||||||
if srcErr := bs.source.Err(); srcErr != nil {
|
// it is why the player must ask before treating this as a
|
||||||
bs.err = srcErr
|
// natural finish.
|
||||||
}
|
exitErr = bs.source.Err()
|
||||||
|
|
||||||
bs.mu.Unlock()
|
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@@ -154,7 +222,27 @@ func (bs *BufferedStreamer) Stream(
|
|||||||
}
|
}
|
||||||
|
|
||||||
if bs.count == 0 {
|
if bs.count == 0 {
|
||||||
// Buffer temporarily empty — fill with silence.
|
// The read-ahead has not caught up. Silence buys it time --
|
||||||
|
// but only for a bounded stretch, because "forever" is
|
||||||
|
// reported upward as healthy playback and there is no watchdog
|
||||||
|
// above this to notice otherwise.
|
||||||
|
bs.starved++
|
||||||
|
|
||||||
|
if bs.starvedSince.IsZero() {
|
||||||
|
bs.starvedSince = time.Now()
|
||||||
|
}
|
||||||
|
|
||||||
|
if bs.starved >= minStarvedCalls &&
|
||||||
|
time.Since(bs.starvedSince) > maxStarvedDuration {
|
||||||
|
bs.done = true
|
||||||
|
|
||||||
|
if bs.err == nil {
|
||||||
|
bs.err = errSourceStalled
|
||||||
|
}
|
||||||
|
|
||||||
|
return 0, false
|
||||||
|
}
|
||||||
|
|
||||||
for i := range samples {
|
for i := range samples {
|
||||||
samples[i] = [2]float64{}
|
samples[i] = [2]float64{}
|
||||||
}
|
}
|
||||||
@@ -162,6 +250,9 @@ func (bs *BufferedStreamer) Stream(
|
|||||||
return len(samples), true
|
return len(samples), true
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Samples arrived, so whatever the stall was, it is over.
|
||||||
|
bs.resetStarvationLocked()
|
||||||
|
|
||||||
// Copy available samples from ring buffer.
|
// Copy available samples from ring buffer.
|
||||||
n := len(samples)
|
n := len(samples)
|
||||||
if n > bs.count {
|
if n > bs.count {
|
||||||
@@ -197,6 +288,19 @@ func (bs *BufferedStreamer) Flush() {
|
|||||||
bs.readPos = 0
|
bs.readPos = 0
|
||||||
bs.writPos = 0
|
bs.writPos = 0
|
||||||
bs.count = 0
|
bs.count = 0
|
||||||
|
|
||||||
|
// A seek empties the ring on purpose, and the refill that follows
|
||||||
|
// is exactly the stall the budget exists to tolerate. Charging it
|
||||||
|
// against a budget the previous underrun already spent would end
|
||||||
|
// the track on a seek near the end of a slow file.
|
||||||
|
bs.resetStarvationLocked()
|
||||||
|
}
|
||||||
|
|
||||||
|
// resetStarvationLocked forgets an underrun run. Must be called with
|
||||||
|
// bs.mu held.
|
||||||
|
func (bs *BufferedStreamer) resetStarvationLocked() {
|
||||||
|
bs.starved = 0
|
||||||
|
bs.starvedSince = time.Time{}
|
||||||
}
|
}
|
||||||
|
|
||||||
// LockSource blocks the read-ahead goroutine from touching the
|
// LockSource blocks the read-ahead goroutine from touching the
|
||||||
|
|||||||
@@ -0,0 +1,213 @@
|
|||||||
|
package player
|
||||||
|
|
||||||
|
import (
|
||||||
|
"log/slog"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/wailsapp/wails/v3/pkg/application"
|
||||||
|
|
||||||
|
"yellowjacket/backend/events"
|
||||||
|
"yellowjacket/internal/testfixtures"
|
||||||
|
)
|
||||||
|
|
||||||
|
// fixtureSampleRate is what cmd/gentestdata writes (audio.go). It is
|
||||||
|
// deliberately not the speaker rate, which is what lets these tests
|
||||||
|
// tell the decoder's format from the player's default.
|
||||||
|
const fixtureSampleRate = 22050
|
||||||
|
|
||||||
|
// newTestPlayer is a player with a context and no database, so the
|
||||||
|
// track-metadata lookup cannot succeed.
|
||||||
|
func newTestPlayer(t *testing.T) *Player {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
p := NewPlayer(slog.Default(), nil)
|
||||||
|
rec := events.NewRecorder()
|
||||||
|
|
||||||
|
_ = p.ServiceStartup(
|
||||||
|
events.WithSink(t.Context(), rec),
|
||||||
|
application.ServiceOptions{},
|
||||||
|
)
|
||||||
|
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// loadFileLocked needs no speaker: it decodes, builds the chain and
|
||||||
|
// registers it paused. speaker.Play on an uninitialised device is
|
||||||
|
// what the integration guard elsewhere is about, so these assert on
|
||||||
|
// the state the load computed rather than on playback.
|
||||||
|
|
||||||
|
// p.format used to be assigned once, in the constructor, to the
|
||||||
|
// *speaker's* rate -- so it claimed 44.1 kHz for every file ever
|
||||||
|
// loaded. Play()'s replay-after-finish path resamples from it, so a
|
||||||
|
// finished track played again was resampled from a rate the decoder
|
||||||
|
// never produced: audibly the wrong speed and pitch, and wrong
|
||||||
|
// length and position arithmetic with it.
|
||||||
|
//
|
||||||
|
// The fixtures are 22050 Hz, which is exactly the point -- any of
|
||||||
|
// them disagrees with the speaker rate.
|
||||||
|
func TestLoadRecordsTheDecodersOwnFormat(t *testing.T) {
|
||||||
|
m := testfixtures.Load(t)
|
||||||
|
path := m.Case(t, testfixtures.CaseCoverDedup)[0]
|
||||||
|
|
||||||
|
p := newTestPlayer(t)
|
||||||
|
|
||||||
|
if got := p.format.SampleRate; got != speakerSampleRate {
|
||||||
|
t.Fatalf(
|
||||||
|
"precondition: a fresh player should hold the speaker "+
|
||||||
|
"rate, got %d",
|
||||||
|
got,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := p.LoadFile(path); err != nil {
|
||||||
|
t.Fatalf("LoadFile(%s): %v", path, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if p.format.SampleRate == speakerSampleRate {
|
||||||
|
t.Fatalf(
|
||||||
|
"p.format still holds the speaker rate (%d) after "+
|
||||||
|
"loading a %d Hz file: the replay path would "+
|
||||||
|
"resample from the wrong rate",
|
||||||
|
speakerSampleRate, fixtureSampleRate,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
if got := int(p.format.SampleRate); got != fixtureSampleRate {
|
||||||
|
t.Errorf(
|
||||||
|
"expected the decoder's rate %d, got %d",
|
||||||
|
fixtureSampleRate, got,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// trackLengthMs is written only when the database has a row for the
|
||||||
|
// file and cleared only by UnloadTrack, so a track with no row used
|
||||||
|
// to inherit whatever the last track's duration was -- and every
|
||||||
|
// position report is scaled by it, so the whole seek bar was then
|
||||||
|
// reporting one track's progress on another track's scale.
|
||||||
|
//
|
||||||
|
// There is no database here, so the lookup cannot succeed: exactly
|
||||||
|
// the case that used to inherit.
|
||||||
|
func TestLoadDoesNotInheritThePreviousTracksDuration(t *testing.T) {
|
||||||
|
m := testfixtures.Load(t)
|
||||||
|
path := m.Case(t, testfixtures.CaseCoverDedup)[0]
|
||||||
|
|
||||||
|
p := newTestPlayer(t)
|
||||||
|
|
||||||
|
// Stand in for a previous track whose duration was resolved.
|
||||||
|
p.trackLengthMs = 9_999_000
|
||||||
|
|
||||||
|
if err := p.LoadFile(path); err != nil {
|
||||||
|
t.Fatalf("LoadFile(%s): %v", path, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if p.trackLengthMs == 9_999_000 {
|
||||||
|
t.Fatal(
|
||||||
|
"the previous track's duration survived the load: every " +
|
||||||
|
"position report for this track would be scaled by it",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A new chain supersedes the old one's pending finished callback.
|
||||||
|
// Without this, a callback that queued for p.mu behind a LoadFile
|
||||||
|
// woke up and rewound, stopped and auto-advanced the *new* track.
|
||||||
|
func TestANewChainSupersedesTheOldFinishedCallback(t *testing.T) {
|
||||||
|
m := testfixtures.Load(t)
|
||||||
|
paths := m.Case(t, testfixtures.CaseCoverDedup)
|
||||||
|
|
||||||
|
if len(paths) < 2 {
|
||||||
|
t.Skip("need two fixture tracks")
|
||||||
|
}
|
||||||
|
|
||||||
|
p := newTestPlayer(t)
|
||||||
|
|
||||||
|
if err := p.LoadFile(paths[0]); err != nil {
|
||||||
|
t.Fatalf("LoadFile(%s): %v", paths[0], err)
|
||||||
|
}
|
||||||
|
|
||||||
|
stale := p.chainID
|
||||||
|
|
||||||
|
if err := p.LoadFile(paths[1]); err != nil {
|
||||||
|
t.Fatalf("LoadFile(%s): %v", paths[1], err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if p.chainID == stale {
|
||||||
|
t.Fatal("loading a second file did not supersede the chain")
|
||||||
|
}
|
||||||
|
|
||||||
|
called := false
|
||||||
|
|
||||||
|
p.SetPlaybackFinishedHandler(func(error) { called = true })
|
||||||
|
|
||||||
|
// The first track's callback, arriving late.
|
||||||
|
p.onPlaybackFinished(stale, nil)
|
||||||
|
|
||||||
|
if called {
|
||||||
|
t.Error(
|
||||||
|
"a superseded chain's callback drove auto-advance: the " +
|
||||||
|
"track that is loaded now would be skipped",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
if p.state == Stopped {
|
||||||
|
t.Error(
|
||||||
|
"a superseded chain's callback stopped the current track",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// The decoder is read by the read-ahead goroutine and by every
|
||||||
|
// position emit, and those used to be guarded by different mutexes:
|
||||||
|
// the read by srcMu, the position by the speaker lock, which
|
||||||
|
// read-ahead never takes. Under -race this failed on the emit that
|
||||||
|
// LoadFile itself makes.
|
||||||
|
//
|
||||||
|
// It needs the read-ahead goroutine to actually be running, so it
|
||||||
|
// keeps asking for the position for long enough to overlap it.
|
||||||
|
func TestPositionReadsDoNotRaceTheReadAhead(t *testing.T) {
|
||||||
|
m := testfixtures.Load(t)
|
||||||
|
path := m.Case(t, testfixtures.CaseFLACAlbum)[0]
|
||||||
|
|
||||||
|
p := newTestPlayer(t)
|
||||||
|
|
||||||
|
if err := p.LoadFile(path); err != nil {
|
||||||
|
t.Fatalf("LoadFile(%s): %v", path, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
for range 200 {
|
||||||
|
if _, err := p.CurrentPositionSeconds(); err != nil {
|
||||||
|
t.Fatalf("CurrentPositionSeconds: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Seeking emits the landing position, and that emit reads the
|
||||||
|
// decoder -- so the source lock the seek holds must be released
|
||||||
|
// before it. A reentrant take here is a deadlock, not a failure,
|
||||||
|
// which is why this test exists rather than a comment.
|
||||||
|
func TestSeekEmitsWithoutDeadlocking(t *testing.T) {
|
||||||
|
m := testfixtures.Load(t)
|
||||||
|
path := m.Case(t, testfixtures.CaseFLACAlbum)[0]
|
||||||
|
|
||||||
|
p := newTestPlayer(t)
|
||||||
|
|
||||||
|
if err := p.LoadFile(path); err != nil {
|
||||||
|
t.Fatalf("LoadFile(%s): %v", path, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
done := make(chan struct{})
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
defer close(done)
|
||||||
|
|
||||||
|
_ = p.Seek(1)
|
||||||
|
}()
|
||||||
|
|
||||||
|
select {
|
||||||
|
case <-done:
|
||||||
|
case <-time.After(10 * time.Second):
|
||||||
|
t.Fatal("Seek deadlocked: the position emit re-took the source lock")
|
||||||
|
}
|
||||||
|
}
|
||||||
+171
-34
@@ -52,9 +52,17 @@ type Player struct {
|
|||||||
control *beep.Ctrl
|
control *beep.Ctrl
|
||||||
volume *effects.Volume
|
volume *effects.Volume
|
||||||
speakerStreamer beep.Streamer
|
speakerStreamer beep.Streamer
|
||||||
playbackFinishedHandler func()
|
playbackFinishedHandler func(error)
|
||||||
trackChangeID uint64
|
trackChangeID uint64
|
||||||
mediaControls mediacontrols.Handler
|
|
||||||
|
// chainID identifies the streamer chain currently registered with
|
||||||
|
// the speaker. updateStreamers bumps it, and the finished
|
||||||
|
// callback carries the value it was registered with, so a callback
|
||||||
|
// that queued for p.mu behind a LoadFile can tell that the player
|
||||||
|
// has moved on and return rather than rewinding somebody else's
|
||||||
|
// track.
|
||||||
|
chainID uint64
|
||||||
|
mediaControls mediacontrols.Handler
|
||||||
|
|
||||||
// duckAmount is the attenuation currently applied on top of the
|
// duckAmount is the attenuation currently applied on top of the
|
||||||
// user's volume, in the same base-2 exponent effects.Volume uses.
|
// user's volume, in the same base-2 exponent effects.Volume uses.
|
||||||
@@ -180,11 +188,18 @@ func (p *Player) InitSpeaker() error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// SetPlaybackFinishedHandler sets a callback invoked when a track
|
// SetPlaybackFinishedHandler sets a callback invoked when a track
|
||||||
// finishes naturally. This allows the queue to drive auto-advance
|
// stops streaming. This allows the queue to drive auto-advance
|
||||||
// without circular imports.
|
// without circular imports.
|
||||||
//
|
//
|
||||||
|
// The error says *why* the track stopped: nil for a track that
|
||||||
|
// reached its end, non-nil for one that broke partway through. Both
|
||||||
|
// arrive here because both look identical to the speaker, and only
|
||||||
|
// the queue holds the metadata a PlaybackFailed needs -- but they are
|
||||||
|
// not the same event, and reporting a decode failure as a natural
|
||||||
|
// finish is how a broken file used to auto-advance in silence.
|
||||||
|
//
|
||||||
//wails:ignore // internal wiring, not part of the app's IPC surface.
|
//wails:ignore // internal wiring, not part of the app's IPC surface.
|
||||||
func (p *Player) SetPlaybackFinishedHandler(handler func()) {
|
func (p *Player) SetPlaybackFinishedHandler(handler func(error)) {
|
||||||
p.mu.Lock()
|
p.mu.Lock()
|
||||||
defer p.mu.Unlock()
|
defer p.mu.Unlock()
|
||||||
|
|
||||||
@@ -424,6 +439,19 @@ func (p *Player) updateStreamers(
|
|||||||
newBaseStreamer beep.StreamSeeker,
|
newBaseStreamer beep.StreamSeeker,
|
||||||
sr beep.SampleRate,
|
sr beep.SampleRate,
|
||||||
) error {
|
) error {
|
||||||
|
// A new chain supersedes the old one, so any finished callback the
|
||||||
|
// old one still owes is stale from here on.
|
||||||
|
p.chainID++
|
||||||
|
|
||||||
|
// The previous read-ahead goroutine reads the same decoder this
|
||||||
|
// one is about to, under its own srcMu -- two goroutines, two
|
||||||
|
// mutexes, one decoder that is not safe for concurrent use. The
|
||||||
|
// replay-after-finish path rebuilds from p.seeker without going
|
||||||
|
// through LoadFile, which is where that pair could meet.
|
||||||
|
if p.buffered != nil {
|
||||||
|
p.buffered.Close()
|
||||||
|
}
|
||||||
|
|
||||||
// set base streamer
|
// set base streamer
|
||||||
p.baseStreamer = newBaseStreamer
|
p.baseStreamer = newBaseStreamer
|
||||||
p.seeker = newBaseStreamer
|
p.seeker = newBaseStreamer
|
||||||
@@ -474,23 +502,57 @@ func (p *Player) startPaused() {
|
|||||||
p.control.Paused = true
|
p.control.Paused = true
|
||||||
speaker.Unlock()
|
speaker.Unlock()
|
||||||
|
|
||||||
|
// Captured, not read at callback time: by then p.chainID names
|
||||||
|
// whatever is loaded *now*, which is the thing the guard exists to
|
||||||
|
// distinguish this chain from.
|
||||||
|
chainID := p.chainID
|
||||||
|
buffered := p.buffered
|
||||||
|
|
||||||
// The beep.Callback runs with the speaker mutex held, so we
|
// The beep.Callback runs with the speaker mutex held, so we
|
||||||
// dispatch to a goroutine that can safely acquire p.mu.
|
// dispatch to a goroutine that can safely acquire p.mu.
|
||||||
speaker.Play(beep.Seq(
|
speaker.Play(beep.Seq(
|
||||||
p.speakerStreamer,
|
p.speakerStreamer,
|
||||||
beep.Callback(func() {
|
beep.Callback(func() {
|
||||||
go p.onPlaybackFinished()
|
// Asked here rather than under p.mu: this is the chain that
|
||||||
|
// just ended, and by the time the goroutine holds the lock
|
||||||
|
// p.buffered may be a different one.
|
||||||
|
var err error
|
||||||
|
if buffered != nil {
|
||||||
|
err = buffered.Err()
|
||||||
|
}
|
||||||
|
|
||||||
|
go p.onPlaybackFinished(chainID, err)
|
||||||
}),
|
}),
|
||||||
))
|
))
|
||||||
|
|
||||||
p.state = Paused
|
p.state = Paused
|
||||||
}
|
}
|
||||||
|
|
||||||
// onPlaybackFinished handles the natural end of a track. It is
|
// onPlaybackFinished handles a track that stopped streaming, whether
|
||||||
// called on a new goroutine from the beep callback (which holds
|
// it ended or broke. It is called on a new goroutine from the beep
|
||||||
// the speaker lock) so that it can safely acquire p.mu.
|
// callback (which holds the speaker lock) so that it can safely
|
||||||
func (p *Player) onPlaybackFinished() {
|
// acquire p.mu.
|
||||||
|
//
|
||||||
|
// chainID names the streamer chain the callback fired for and srcErr
|
||||||
|
// says why it stopped.
|
||||||
|
func (p *Player) onPlaybackFinished(chainID uint64, srcErr error) {
|
||||||
p.mu.Lock()
|
p.mu.Lock()
|
||||||
|
|
||||||
|
// The player has moved on while this callback queued for the lock
|
||||||
|
// -- a user pressing Next during the last second of a track is
|
||||||
|
// enough. Everything below is about the *current* track: rewinding
|
||||||
|
// the decoder, saying playback stopped, asking the queue to
|
||||||
|
// advance. Doing any of it now would do it to the wrong track.
|
||||||
|
if chainID != p.chainID {
|
||||||
|
p.mu.Unlock()
|
||||||
|
p.logger.Debug(
|
||||||
|
"Ignoring finished callback for a superseded chain",
|
||||||
|
"chain", chainID, "current", p.chainID,
|
||||||
|
)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
p.state = Stopped
|
p.state = Stopped
|
||||||
handler := p.playbackFinishedHandler
|
handler := p.playbackFinishedHandler
|
||||||
mc := p.mediaControls
|
mc := p.mediaControls
|
||||||
@@ -501,10 +563,11 @@ func (p *Player) onPlaybackFinished() {
|
|||||||
// the Stopped state anyway, so this only moves the decoder.
|
// the Stopped state anyway, so this only moves the decoder.
|
||||||
p.rewindLocked()
|
p.rewindLocked()
|
||||||
p.emitPositionLocked()
|
p.emitPositionLocked()
|
||||||
p.mu.Unlock()
|
|
||||||
|
|
||||||
// Emit Wails events outside the lock — these are non-blocking
|
// Emitted under p.mu, like every other transition in this file.
|
||||||
// calls that don't need player state.
|
// Outside it, a Play() taking the lock in the gap emits `playing`
|
||||||
|
// first and this stale `stopped` lands last -- leaving the button
|
||||||
|
// showing play over a track that is audibly running.
|
||||||
p.emitPlaybackFinished()
|
p.emitPlaybackFinished()
|
||||||
|
|
||||||
events.Emit(
|
events.Emit(
|
||||||
@@ -513,6 +576,8 @@ func (p *Player) onPlaybackFinished() {
|
|||||||
map[string]string{"state": string(Stopped)},
|
map[string]string{"state": string(Stopped)},
|
||||||
)
|
)
|
||||||
|
|
||||||
|
p.mu.Unlock()
|
||||||
|
|
||||||
// Notify media controls outside the lock. The track just
|
// Notify media controls outside the lock. The track just
|
||||||
// ended so position is 0.
|
// ended so position is 0.
|
||||||
if mc != nil {
|
if mc != nil {
|
||||||
@@ -521,12 +586,19 @@ func (p *Player) onPlaybackFinished() {
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
p.logger.Info("Playback finished naturally")
|
if srcErr != nil {
|
||||||
|
p.logger.Error(
|
||||||
|
"Playback stopped: the audio source failed",
|
||||||
|
"err", srcErr,
|
||||||
|
)
|
||||||
|
} else {
|
||||||
|
p.logger.Info("Playback finished naturally")
|
||||||
|
}
|
||||||
|
|
||||||
// Notify queue for auto-advance. Called without p.mu held
|
// Notify queue for auto-advance. Called without p.mu held
|
||||||
// because it re-enters the player via LoadFile/Play.
|
// because it re-enters the player via LoadFile/Play.
|
||||||
if handler != nil {
|
if handler != nil {
|
||||||
handler()
|
handler(srcErr)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -587,6 +659,18 @@ func (p *Player) loadFileLocked(filePath string) error {
|
|||||||
|
|
||||||
p.currentFile = f
|
p.currentFile = f
|
||||||
|
|
||||||
|
// The decoder's own format, kept for the paths that rebuild the
|
||||||
|
// chain later: Play()'s replay branch resamples from it, so a
|
||||||
|
// stale rate there plays a finished track back at the wrong speed.
|
||||||
|
p.format = format
|
||||||
|
|
||||||
|
// The previous track's duration must not outlive it. This is set
|
||||||
|
// again by emitTrackChanged below, but only when the database has
|
||||||
|
// a row for the file -- and every position this player reports is
|
||||||
|
// scaled by it, so inheriting means every report is wrong by the
|
||||||
|
// ratio between two unrelated tracks.
|
||||||
|
p.trackLengthMs = 0
|
||||||
|
|
||||||
if err := p.updateStreamers(
|
if err := p.updateStreamers(
|
||||||
streamer, format.SampleRate,
|
streamer, format.SampleRate,
|
||||||
); err != nil {
|
); err != nil {
|
||||||
@@ -906,6 +990,8 @@ func (p *Player) CurrentPosition() (int, error) {
|
|||||||
return 0, errNoAudioFileLoaded
|
return 0, errNoAudioFileLoaded
|
||||||
}
|
}
|
||||||
|
|
||||||
|
defer p.lockSourceLocked()()
|
||||||
|
|
||||||
speaker.Lock()
|
speaker.Lock()
|
||||||
pos := math.Round(
|
pos := math.Round(
|
||||||
100.0 * float64(p.seeker.Position()) /
|
100.0 * float64(p.seeker.Position()) /
|
||||||
@@ -924,6 +1010,28 @@ func (p *Player) Seek(targetSeconds int) error {
|
|||||||
return p.seekLocked(targetSeconds)
|
return p.seekLocked(targetSeconds)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// lockSourceLocked blocks the read-ahead goroutine from touching the
|
||||||
|
// decoder and returns the function that releases it, so a caller can
|
||||||
|
// `defer p.lockSourceLocked()()`.
|
||||||
|
//
|
||||||
|
// Reading the decoder's position is a read *of the decoder*, and the
|
||||||
|
// speaker lock does not exclude the read-ahead goroutine -- it never
|
||||||
|
// takes it. That was a genuine data race on every position emit,
|
||||||
|
// once a second for the whole of playback.
|
||||||
|
//
|
||||||
|
// srcMu is not reentrant, so nothing that already holds it may call
|
||||||
|
// this; seekSourceLocked exists to keep that region free of emits.
|
||||||
|
// Must be called with p.mu held.
|
||||||
|
func (p *Player) lockSourceLocked() func() {
|
||||||
|
if p.buffered == nil {
|
||||||
|
return func() {}
|
||||||
|
}
|
||||||
|
|
||||||
|
p.buffered.LockSource()
|
||||||
|
|
||||||
|
return p.buffered.UnlockSource
|
||||||
|
}
|
||||||
|
|
||||||
// rewindLocked returns the decoder to the start of the track without
|
// rewindLocked returns the decoder to the start of the track without
|
||||||
// touching playback state. Must be called with p.mu held.
|
// touching playback state. Must be called with p.mu held.
|
||||||
func (p *Player) rewindLocked() {
|
func (p *Player) rewindLocked() {
|
||||||
@@ -959,6 +1067,46 @@ func (p *Player) seekLocked(targetSeconds int) error {
|
|||||||
return fmt.Errorf("cannot get track length: %w", err)
|
return fmt.Errorf("cannot get track length: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The source lock is released before anything below is emitted:
|
||||||
|
// emitPositionLocked reads the decoder's position and takes the
|
||||||
|
// same lock, which is not reentrant.
|
||||||
|
seekErr := p.seekSourceLocked(targetSeconds, lengthSecs)
|
||||||
|
if seekErr != nil {
|
||||||
|
p.logger.Warn(
|
||||||
|
"Seek failed, playback will start from "+
|
||||||
|
"the beginning",
|
||||||
|
"target-seconds", targetSeconds,
|
||||||
|
"err", seekErr,
|
||||||
|
)
|
||||||
|
|
||||||
|
// The optimistic move the UI already made has to be taken
|
||||||
|
// back, and only the backend knows it did not happen.
|
||||||
|
events.Emit(p.ctx, events.SeekFailed)
|
||||||
|
p.emitPositionLocked()
|
||||||
|
|
||||||
|
return fmt.Errorf("failed to seek: %w", seekErr)
|
||||||
|
}
|
||||||
|
|
||||||
|
if p.mediaControls != nil {
|
||||||
|
p.mediaControls.NotifySeek(targetSeconds)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Report the landing position immediately rather than leaving the
|
||||||
|
// UI to guess until the next tick — this is the half of H-3 that
|
||||||
|
// desynced the seek bar by 30 s over four keyboard seeks.
|
||||||
|
p.emitPositionLocked()
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// seekSourceLocked moves the decoder and flushes the stale read-ahead
|
||||||
|
// behind it. It owns the source lock for exactly that long and
|
||||||
|
// emits nothing, so its caller is free to read the position
|
||||||
|
// afterwards. Must be called with p.mu held.
|
||||||
|
func (p *Player) seekSourceLocked(
|
||||||
|
targetSeconds int,
|
||||||
|
lengthSecs int,
|
||||||
|
) error {
|
||||||
// Block the read-ahead goroutine from reading the source while
|
// Block the read-ahead goroutine from reading the source while
|
||||||
// we seek it. The decoder (e.g. FLAC's bufseekio.ReadSeeker) is
|
// we seek it. The decoder (e.g. FLAC's bufseekio.ReadSeeker) is
|
||||||
// not safe for concurrent Read+Seek, and read-ahead runs on its
|
// not safe for concurrent Read+Seek, and read-ahead runs on its
|
||||||
@@ -1014,19 +1162,11 @@ func (p *Player) seekLocked(targetSeconds int) error {
|
|||||||
if seekErr != nil {
|
if seekErr != nil {
|
||||||
speaker.Unlock()
|
speaker.Unlock()
|
||||||
|
|
||||||
p.logger.Warn(
|
p.logger.Debug(
|
||||||
"Seek failed, playback will start from "+
|
"seek rejected by the decoder",
|
||||||
"the beginning",
|
"samples", samples, "err", seekErr,
|
||||||
"target-seconds", targetSeconds,
|
|
||||||
"samples", samples,
|
|
||||||
"err", seekErr,
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// The optimistic move the UI already made has to be taken
|
|
||||||
// back, and only the backend knows it did not happen.
|
|
||||||
events.Emit(p.ctx, events.SeekFailed)
|
|
||||||
p.emitPositionLocked()
|
|
||||||
|
|
||||||
return fmt.Errorf("failed to seek: %w", seekErr)
|
return fmt.Errorf("failed to seek: %w", seekErr)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1039,15 +1179,6 @@ func (p *Player) seekLocked(targetSeconds int) error {
|
|||||||
p.buffered.Flush()
|
p.buffered.Flush()
|
||||||
}
|
}
|
||||||
|
|
||||||
if p.mediaControls != nil {
|
|
||||||
p.mediaControls.NotifySeek(targetSeconds)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Report the landing position immediately rather than leaving the
|
|
||||||
// UI to guess until the next tick — this is the half of H-3 that
|
|
||||||
// desynced the seek bar by 30 s over four keyboard seeks.
|
|
||||||
p.emitPositionLocked()
|
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1140,6 +1271,10 @@ func (p *Player) seekerLengthSecsLocked() (int, error) {
|
|||||||
return 0, errNoAudioFileLoaded
|
return 0, errNoAudioFileLoaded
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Len is fixed for the life of the decoder, so unlike Position it
|
||||||
|
// races with nothing and needs no source lock -- which it must not
|
||||||
|
// take anyway: displayPositionSecsLocked calls this while holding
|
||||||
|
// it, and srcMu is not reentrant.
|
||||||
speaker.Lock()
|
speaker.Lock()
|
||||||
length := p.seeker.Len() / int(p.format.SampleRate)
|
length := p.seeker.Len() / int(p.format.SampleRate)
|
||||||
speaker.Unlock()
|
speaker.Unlock()
|
||||||
@@ -1156,6 +1291,8 @@ func (p *Player) displayPositionSecsLocked() int {
|
|||||||
return 0
|
return 0
|
||||||
}
|
}
|
||||||
|
|
||||||
|
defer p.lockSourceLocked()()
|
||||||
|
|
||||||
speaker.Lock()
|
speaker.Lock()
|
||||||
pos := p.seeker.Position()
|
pos := p.seeker.Position()
|
||||||
total := p.seeker.Len()
|
total := p.seeker.Len()
|
||||||
|
|||||||
@@ -83,7 +83,7 @@ func TestFallback_TriggersOnNaturalFinish(t *testing.T) {
|
|||||||
q.SetFallbackSource(fake)
|
q.SetFallbackSource(fake)
|
||||||
|
|
||||||
q.SetQueue(seedPaths, 0, false, Source{Type: "album", ID: 1, Label: "Seed Album"})
|
q.SetQueue(seedPaths, 0, false, Source{Type: "album", ID: 1, Label: "Seed Album"})
|
||||||
q.OnPlaybackFinished()
|
q.OnPlaybackFinished(nil)
|
||||||
|
|
||||||
waitUntil(t, func() bool { return fake.callCount() == 1 }, "fallback to be resolved")
|
waitUntil(t, func() bool { return fake.callCount() == 1 }, "fallback to be resolved")
|
||||||
waitUntil(t, func() bool {
|
waitUntil(t, func() bool {
|
||||||
@@ -159,7 +159,7 @@ func TestFallback_EmptyResultLeavesQueueExhausted(t *testing.T) {
|
|||||||
q.SetFallbackSource(fake)
|
q.SetFallbackSource(fake)
|
||||||
|
|
||||||
q.SetQueue(seedPaths, 0, false, Source{})
|
q.SetQueue(seedPaths, 0, false, Source{})
|
||||||
q.OnPlaybackFinished()
|
q.OnPlaybackFinished(nil)
|
||||||
|
|
||||||
waitUntil(t, func() bool { return fake.callCount() == 1 }, "fallback to be resolved")
|
waitUntil(t, func() bool { return fake.callCount() == 1 }, "fallback to be resolved")
|
||||||
|
|
||||||
@@ -193,7 +193,7 @@ func TestFallback_StaleResolutionDiscarded(t *testing.T) {
|
|||||||
q.SetFallbackSource(fake)
|
q.SetFallbackSource(fake)
|
||||||
|
|
||||||
q.SetQueue(seedPaths, 0, false, Source{})
|
q.SetQueue(seedPaths, 0, false, Source{})
|
||||||
q.OnPlaybackFinished() // starts resolving, blocked on gate
|
q.OnPlaybackFinished(nil) // starts resolving, blocked on gate
|
||||||
|
|
||||||
time.Sleep(20 * time.Millisecond) // let the goroutine reach the gate
|
time.Sleep(20 * time.Millisecond) // let the goroutine reach the gate
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,78 @@
|
|||||||
|
package queue
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"yellowjacket/backend/events"
|
||||||
|
)
|
||||||
|
|
||||||
|
// errTestDecode stands in for a decoder blowing up mid-track.
|
||||||
|
var errTestDecode = errors.New("decode blew up")
|
||||||
|
|
||||||
|
// currentIndex == -1 against a non-empty queue is a state this
|
||||||
|
// package produces on purpose: onQueueExhausted(false) sets it and
|
||||||
|
// deliberately leaves the finished track loaded in the player, so it
|
||||||
|
// stays on the now-playing bar. Pressing play from there and letting
|
||||||
|
// it finish re-enters OnPlaybackFinished with exactly that pair --
|
||||||
|
// which used to index q.tracks[-1] and panic, on a goroutine
|
||||||
|
// dispatched from the audio callback with no caller to recover it.
|
||||||
|
func TestFinishedWithNoCurrentTrackDoesNotPanic(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
index int
|
||||||
|
}{
|
||||||
|
{"exhausted queue leaves -1", -1},
|
||||||
|
{"index past the end", 3},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
q, _, _ := setupRecordedQueue(t)
|
||||||
|
q.tracks = []Track{
|
||||||
|
{FilePath: "/a.mp3"},
|
||||||
|
{FilePath: "/b.mp3"},
|
||||||
|
}
|
||||||
|
q.currentIndex = tt.index
|
||||||
|
|
||||||
|
// The assertion is that this returns at all.
|
||||||
|
q.OnPlaybackFinished(nil)
|
||||||
|
|
||||||
|
if q.currentIndex != tt.index {
|
||||||
|
t.Errorf(
|
||||||
|
"an out-of-range index was acted on: %d became %d",
|
||||||
|
tt.index, q.currentIndex,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A track that broke mid-playback is not a track that was listened
|
||||||
|
// to. The player cannot say so itself -- the metadata is here -- so
|
||||||
|
// it hands the reason over and this is where it becomes a
|
||||||
|
// PlaybackFailed rather than a silent auto-advance.
|
||||||
|
func TestAFailedTrackIsReportedAndNotCountedAsAPlay(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
q, _, rec := setupRecordedQueue(t)
|
||||||
|
q.tracks = []Track{
|
||||||
|
{FilePath: "/a.mp3", Title: "A", AudioFileID: 1},
|
||||||
|
{FilePath: "/b.mp3", Title: "B", AudioFileID: 2},
|
||||||
|
}
|
||||||
|
q.currentIndex = 0
|
||||||
|
|
||||||
|
q.OnPlaybackFinished(errTestDecode)
|
||||||
|
|
||||||
|
if _, ok := rec.Last(events.PlaybackFailed); !ok {
|
||||||
|
t.Errorf(
|
||||||
|
"a track that failed mid-playback told the user nothing; "+
|
||||||
|
"got %v",
|
||||||
|
rec.Names(),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,18 +1,45 @@
|
|||||||
package queue
|
package queue
|
||||||
|
|
||||||
// OnPlaybackFinished is called when a track finishes playing naturally.
|
// OnPlaybackFinished is called when a track stops streaming. This
|
||||||
// This drives the auto-advance behavior and records the play.
|
// drives the auto-advance behavior and records the play.
|
||||||
func (q *Queue) OnPlaybackFinished() {
|
//
|
||||||
|
// srcErr says why the track stopped: nil for one that reached its
|
||||||
|
// end, non-nil for one that broke partway through. The player cannot
|
||||||
|
// tell the user which, because the metadata lives here -- so a failure
|
||||||
|
// is reported as PlaybackFailed and *not* recorded as a play, while
|
||||||
|
// the advance happens either way. Before this, a file that failed
|
||||||
|
// mid-track advanced in silence and was counted as listened to.
|
||||||
|
//
|
||||||
|
//wails:ignore // internal wiring, not part of the app's IPC surface.
|
||||||
|
func (q *Queue) OnPlaybackFinished(srcErr error) {
|
||||||
q.mu.Lock()
|
q.mu.Lock()
|
||||||
|
|
||||||
if len(q.tracks) == 0 {
|
// currentIndex is -1 whenever the queue has been exhausted, and
|
||||||
|
// onQueueExhausted deliberately leaves the finished track loaded
|
||||||
|
// in the player -- so a natural finish can re-enter here against a
|
||||||
|
// queue that is not empty and an index that is not valid. Every
|
||||||
|
// other path in this package bounds-checks before indexing; this
|
||||||
|
// one panicked, on a goroutine with no caller to recover it.
|
||||||
|
if q.currentIndex < 0 || q.currentIndex >= len(q.tracks) {
|
||||||
q.mu.Unlock()
|
q.mu.Unlock()
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
// Capture the track that just finished before advancing.
|
// Capture the track that just finished before advancing.
|
||||||
finishedID := q.tracks[q.currentIndex].AudioFileID
|
finished := q.tracks[q.currentIndex]
|
||||||
|
finishedID := finished.AudioFileID
|
||||||
|
|
||||||
|
if srcErr != nil {
|
||||||
|
q.emitPlaybackFailed(finished, srcErr)
|
||||||
|
}
|
||||||
|
|
||||||
|
// A track that broke was not listened to.
|
||||||
|
recordFinished := func() {
|
||||||
|
if srcErr == nil {
|
||||||
|
q.recordPlay(finishedID)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// Repeat One: replay the current track.
|
// Repeat One: replay the current track.
|
||||||
if q.repeatMode == RepeatOne {
|
if q.repeatMode == RepeatOne {
|
||||||
@@ -21,7 +48,7 @@ func (q *Queue) OnPlaybackFinished() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
q.mu.Unlock()
|
q.mu.Unlock()
|
||||||
q.recordPlay(finishedID)
|
recordFinished()
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@@ -31,7 +58,7 @@ func (q *Queue) OnPlaybackFinished() {
|
|||||||
// Queue exhausted — this is the extension point for a future fallback playlist.
|
// Queue exhausted — this is the extension point for a future fallback playlist.
|
||||||
q.onQueueExhausted(false)
|
q.onQueueExhausted(false)
|
||||||
q.mu.Unlock()
|
q.mu.Unlock()
|
||||||
q.recordPlay(finishedID)
|
recordFinished()
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@@ -44,12 +71,12 @@ func (q *Queue) OnPlaybackFinished() {
|
|||||||
if !q.playCurrentOrSkip(true, q.nextIndex) {
|
if !q.playCurrentOrSkip(true, q.nextIndex) {
|
||||||
q.onQueueExhausted(false)
|
q.onQueueExhausted(false)
|
||||||
q.mu.Unlock()
|
q.mu.Unlock()
|
||||||
q.recordPlay(finishedID)
|
recordFinished()
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
q.emitIndexChanged()
|
q.emitIndexChanged()
|
||||||
q.mu.Unlock()
|
q.mu.Unlock()
|
||||||
q.recordPlay(finishedID)
|
recordFinished()
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -107,7 +107,7 @@ func TestPlaybackFailed_AutoAdvanceSkipsPastIt(t *testing.T) {
|
|||||||
|
|
||||||
// The first track finished: auto-advance lands on the missing
|
// The first track finished: auto-advance lands on the missing
|
||||||
// file and must step over it rather than stopping dead.
|
// file and must step over it rather than stopping dead.
|
||||||
q.OnPlaybackFinished()
|
q.OnPlaybackFinished(nil)
|
||||||
|
|
||||||
if got := q.GetState().CurrentIndex; got != 2 {
|
if got := q.GetState().CurrentIndex; got != 2 {
|
||||||
t.Errorf("currentIndex after skipping: got %d, want 2", got)
|
t.Errorf("currentIndex after skipping: got %d, want 2", got)
|
||||||
@@ -183,7 +183,7 @@ func TestQueueExhausted_KeepsTheFinishedTrackLoaded(t *testing.T) {
|
|||||||
|
|
||||||
q.SetQueue(paths, 0, false, Source{})
|
q.SetQueue(paths, 0, false, Source{})
|
||||||
q.Play()
|
q.Play()
|
||||||
q.OnPlaybackFinished()
|
q.OnPlaybackFinished(nil)
|
||||||
|
|
||||||
if q.GetState().CurrentIndex != -1 {
|
if q.GetState().CurrentIndex != -1 {
|
||||||
t.Errorf(
|
t.Errorf(
|
||||||
|
|||||||
@@ -24,10 +24,19 @@ func DefaultBindings() map[string]string {
|
|||||||
"player.repeat": "R",
|
"player.repeat": "R",
|
||||||
"player.mute": "M",
|
"player.mute": "M",
|
||||||
|
|
||||||
// Navigation (Global scope)
|
// Navigation (Global scope). Back and forward are the browser's
|
||||||
|
// own combination on every platform, which is the whole design
|
||||||
|
// brief for them: the app has one global history and this is the
|
||||||
|
// gesture people already have for it. The modifier is what keeps
|
||||||
|
// them clear of `player.seekBack`/`seekForward`, which are the
|
||||||
|
// bare arrows -- a binding is matched on its full canonical
|
||||||
|
// string, so "Alt+Left" and "Left" are different keys and not a
|
||||||
|
// conflict.
|
||||||
"nav.search": "/",
|
"nav.search": "/",
|
||||||
"nav.searchAlt": "Ctrl+F",
|
"nav.searchAlt": "Ctrl+F",
|
||||||
"nav.queue": "Q",
|
"nav.queue": "Q",
|
||||||
|
"nav.back": "Alt+Left",
|
||||||
|
"nav.forward": "Alt+Right",
|
||||||
|
|
||||||
// App actions
|
// App actions
|
||||||
"app.selectAll": "Ctrl+A",
|
"app.selectAll": "Ctrl+A",
|
||||||
|
|||||||
+25
-55
@@ -4,18 +4,28 @@ includes:
|
|||||||
common: ../Taskfile.yml
|
common: ../Taskfile.yml
|
||||||
|
|
||||||
vars:
|
vars:
|
||||||
# The *installed* package name, which every adb-driven task below uses
|
# APP_ID is an *assertion*, not a setting, and it has no default.
|
||||||
# to uninstall, launch and filter. It must agree with `applicationId`
|
|
||||||
# in app/build.gradle, and nothing enforces that.
|
|
||||||
#
|
#
|
||||||
# ANDROID.md says to set this in build/config.yml. That does not work
|
# It used to be the id every adb-driven task below uninstalled,
|
||||||
# in beta.8, checked both ways: `wails3 task` builds its var set from
|
# launched and filtered, defaulting to "app.yellowjacket". It could
|
||||||
# CLI KEY=VALUE arguments and the Taskfile tree only -- nothing reads
|
# never have been a setting: `wails3 task` builds its var set from CLI
|
||||||
# config.yml -- and even when set it feeds only these adb commands,
|
# KEY=VALUE arguments and the Taskfile tree only -- nothing reads
|
||||||
# never Gradle. So the identity is declared twice, here and in
|
# build/config.yml, contrary to ANDROID.md, checked with --dry -- and
|
||||||
# build.gradle, and a change to one alone means the official run and
|
# even when set it fed only the adb commands, never Gradle. So the
|
||||||
# deploy tasks address a package that is not installed.
|
# identity was declared twice, here and as `applicationId` in
|
||||||
APP_ID: '{{.APP_ID | default "app.yellowjacket"}}'
|
# app/build.gradle, with nothing enforcing that they agree.
|
||||||
|
#
|
||||||
|
# They did not agree. The debug buildType carries
|
||||||
|
# `applicationIdSuffix ".dev"`, so the tasks that assemble a debug APK
|
||||||
|
# addressed the *release* id -- on a device, the user's installed app
|
||||||
|
# and their library (#159).
|
||||||
|
#
|
||||||
|
# The id is now read back from the built APK by scripts/android-
|
||||||
|
# pkgid.sh, so the thing installed and the thing launched agree by
|
||||||
|
# construction. Passing APP_ID= says "this build had better declare
|
||||||
|
# that id", and the deploy refuses before touching anything if it does
|
||||||
|
# not -- which is the check that would have caught #159 statically.
|
||||||
|
APP_ID: '{{.APP_ID | default ""}}'
|
||||||
MIN_SDK: '21'
|
MIN_SDK: '21'
|
||||||
TARGET_SDK: '35'
|
TARGET_SDK: '35'
|
||||||
# The emulator runs the host architecture; physical devices are arm64
|
# The emulator runs the host architecture; physical devices are arm64
|
||||||
@@ -372,9 +382,7 @@ tasks:
|
|||||||
ARCH: '{{.ARCH | default .HOST_ARCH}}'
|
ARCH: '{{.ARCH | default .HOST_ARCH}}'
|
||||||
cmds:
|
cmds:
|
||||||
- task: ensure-emulator
|
- task: ensure-emulator
|
||||||
- '"{{.ADB}}" uninstall {{.APP_ID}} 2>/dev/null || true'
|
- './scripts/android-deploy.sh --apk "{{.BIN_DIR}}/{{.APP_NAME}}.apk" --target emulator{{if .APP_ID}} --expect "{{.APP_ID}}"{{end}}'
|
||||||
- '"{{.ADB}}" install "{{.BIN_DIR}}/{{.APP_NAME}}.apk"'
|
|
||||||
- '"{{.ADB}}" shell am start -n {{.APP_ID}}/com.wails.app.MainActivity'
|
|
||||||
|
|
||||||
run:
|
run:
|
||||||
summary: Build, install and launch a debug build in the Android Emulator
|
summary: Build, install and launch a debug build in the Android Emulator
|
||||||
@@ -383,9 +391,7 @@ tasks:
|
|||||||
- task: build
|
- task: build
|
||||||
cmds:
|
cmds:
|
||||||
- task: assemble:apk
|
- task: assemble:apk
|
||||||
- '"{{.ADB}}" uninstall {{.APP_ID}} 2>/dev/null || true'
|
- './scripts/android-deploy.sh --apk "{{.BIN_DIR}}/{{.APP_NAME}}.apk" --target emulator{{if .APP_ID}} --expect "{{.APP_ID}}"{{end}}'
|
||||||
- '"{{.ADB}}" install "{{.BIN_DIR}}/{{.APP_NAME}}.apk"'
|
|
||||||
- '"{{.ADB}}" shell am start -n {{.APP_ID}}/com.wails.app.MainActivity'
|
|
||||||
|
|
||||||
device:list:
|
device:list:
|
||||||
summary: Lists connected Android devices and emulators (serials)
|
summary: Lists connected Android devices and emulators (serials)
|
||||||
@@ -400,25 +406,7 @@ tasks:
|
|||||||
ARCH: arm64
|
ARCH: arm64
|
||||||
cmds:
|
cmds:
|
||||||
- task: assemble:apk
|
- task: assemble:apk
|
||||||
- |
|
- './scripts/android-deploy.sh --apk "{{.BIN_DIR}}/{{.APP_NAME}}.apk" --target device{{if .DEVICE_ID}} --serial "{{.DEVICE_ID}}"{{end}}{{if .APP_ID}} --expect "{{.APP_ID}}"{{end}}'
|
||||||
DEVICE='{{.DEVICE_ID | default ""}}'
|
|
||||||
if [ -z "$DEVICE" ]; then
|
|
||||||
DEVICE="${DEVICE_ID:-}"
|
|
||||||
fi
|
|
||||||
if [ -z "$DEVICE" ]; then
|
|
||||||
DEVICE=$("{{.ADB}}" devices | awk 'NR > 1 && $2 == "device" && $1 !~ /^emulator-/ { print $1; exit }')
|
|
||||||
fi
|
|
||||||
if [ -z "$DEVICE" ]; then
|
|
||||||
echo "Error: no connected physical Android device found."
|
|
||||||
echo "Pass DEVICE_ID=<serial> to target a device explicitly."
|
|
||||||
echo "Find connected device serials with: {{.ADB}} devices"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "Deploying {{.BIN_DIR}}/{{.APP_NAME}}.apk to device $DEVICE..."
|
|
||||||
"{{.ADB}}" -s "$DEVICE" uninstall {{.APP_ID}} 2>/dev/null || true
|
|
||||||
"{{.ADB}}" -s "$DEVICE" install "{{.BIN_DIR}}/{{.APP_NAME}}.apk"
|
|
||||||
"{{.ADB}}" -s "$DEVICE" shell am start -n {{.APP_ID}}/com.wails.app.MainActivity
|
|
||||||
preconditions:
|
preconditions:
|
||||||
- sh: '[ -x "{{.ADB}}" ] || command -v adb'
|
- sh: '[ -x "{{.ADB}}" ] || command -v adb'
|
||||||
msg: "adb not found. Install the Android SDK platform-tools (or set ANDROID_HOME)"
|
msg: "adb not found. Install the Android SDK platform-tools (or set ANDROID_HOME)"
|
||||||
@@ -430,25 +418,7 @@ tasks:
|
|||||||
vars:
|
vars:
|
||||||
ARCH: arm64
|
ARCH: arm64
|
||||||
cmds:
|
cmds:
|
||||||
- |
|
- './scripts/android-deploy.sh --apk "{{.BIN_DIR}}/{{.APP_NAME}}.apk" --target device{{if .DEVICE_ID}} --serial "{{.DEVICE_ID}}"{{end}}{{if .APP_ID}} --expect "{{.APP_ID}}"{{end}}'
|
||||||
DEVICE='{{.DEVICE_ID | default ""}}'
|
|
||||||
if [ -z "$DEVICE" ]; then
|
|
||||||
DEVICE="${DEVICE_ID:-}"
|
|
||||||
fi
|
|
||||||
if [ -z "$DEVICE" ]; then
|
|
||||||
DEVICE=$("{{.ADB}}" devices | awk 'NR > 1 && $2 == "device" && $1 !~ /^emulator-/ { print $1; exit }')
|
|
||||||
fi
|
|
||||||
if [ -z "$DEVICE" ]; then
|
|
||||||
echo "Error: no connected physical Android device found."
|
|
||||||
echo "Pass DEVICE_ID=<serial> to target a device explicitly."
|
|
||||||
echo "Find connected device serials with: {{.ADB}} devices"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "Deploying {{.BIN_DIR}}/{{.APP_NAME}}.apk to device $DEVICE..."
|
|
||||||
"{{.ADB}}" -s "$DEVICE" uninstall {{.APP_ID}} 2>/dev/null || true
|
|
||||||
"{{.ADB}}" -s "$DEVICE" install "{{.BIN_DIR}}/{{.APP_NAME}}.apk"
|
|
||||||
"{{.ADB}}" -s "$DEVICE" shell am start -n {{.APP_ID}}/com.wails.app.MainActivity
|
|
||||||
preconditions:
|
preconditions:
|
||||||
- sh: '[ -x "{{.ADB}}" ] || command -v adb'
|
- sh: '[ -x "{{.ADB}}" ] || command -v adb'
|
||||||
msg: "adb not found. Install the Android SDK platform-tools (or set ANDROID_HOME)"
|
msg: "adb not found. Install the Android SDK platform-tools (or set ANDROID_HOME)"
|
||||||
|
|||||||
@@ -891,13 +891,41 @@ public class MainActivity extends AppCompatActivity {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The activity going away is not the app shutting down.
|
||||||
|
*
|
||||||
|
* <p>The scaffold called {@code bridge.shutdown()} here, which is
|
||||||
|
* the natural reading of onDestroy and is wrong for this app twice
|
||||||
|
* over. Android destroys and recreates an activity for a
|
||||||
|
* configuration change the manifest does not declare, under memory
|
||||||
|
* pressure, and on every background if the user has "Don't keep
|
||||||
|
* activities" on -- all **without restarting the process**. And
|
||||||
|
* when the user really does leave, this app's reason for existing
|
||||||
|
* in the background is that a song is playing, which is what the
|
||||||
|
* {@code mediaPlayback} foreground service is holding the process
|
||||||
|
* alive for. Either way, tearing the Go side down here would stop
|
||||||
|
* the music.
|
||||||
|
*
|
||||||
|
* <p>It was harmless only by accident: {@code nativeShutdown} calls
|
||||||
|
* {@code App.Quit()}, whose Android {@code destroy()} is an empty
|
||||||
|
* method, and {@code Run()}'s deferred {@code shutdownServices()}
|
||||||
|
* can never fire because Android's {@code platformRun} is
|
||||||
|
* {@code select{}} and does not return. So no {@code
|
||||||
|
* ServiceShutdown} has ever run on Android, and removing this call
|
||||||
|
* changes nothing today -- it stops the day someone implements
|
||||||
|
* {@code destroy()} from silently killing playback on a rotation.
|
||||||
|
*
|
||||||
|
* <p>There is no callback for "the process is going away"; Android
|
||||||
|
* simply kills it. Durability on this platform is the persist
|
||||||
|
* writers, which submit on every mutation rather than at exit.
|
||||||
|
*
|
||||||
|
* <p>See #52, and CLAUDE.md, "An activity is a view onto the
|
||||||
|
* process".
|
||||||
|
*/
|
||||||
@Override
|
@Override
|
||||||
protected void onDestroy() {
|
protected void onDestroy() {
|
||||||
super.onDestroy();
|
super.onDestroy();
|
||||||
unregisterSystemEventReceivers();
|
unregisterSystemEventReceivers();
|
||||||
if (bridge != null) {
|
|
||||||
bridge.shutdown();
|
|
||||||
}
|
|
||||||
if (webView != null) {
|
if (webView != null) {
|
||||||
webView.destroy();
|
webView.destroy();
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -129,7 +129,24 @@ public class WailsBridge {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Initialize the native Go library
|
* Initialize the native Go library.
|
||||||
|
*
|
||||||
|
* <p><b>{@code initialized} is deliberately per-instance, and making
|
||||||
|
* it {@code static} is the trap this comment exists for.</b> A
|
||||||
|
* recreated activity builds a new bridge and calls this again, in a
|
||||||
|
* process where the native library is already loaded and Go's
|
||||||
|
* {@code main()} is already running -- so "initialise once per
|
||||||
|
* process" looks like exactly the right rule. It is not, because
|
||||||
|
* {@code nativeInit} does <i>two</i> things: it runs
|
||||||
|
* {@code go mainFunc()}, and it stores the global JNI reference to
|
||||||
|
* <i>this</i> bridge. Skip it and Go keeps executing JavaScript
|
||||||
|
* against the destroyed activity's WebView: the app opens, renders,
|
||||||
|
* and never receives another backend event.
|
||||||
|
*
|
||||||
|
* <p>So this is called every time, and the half that must not repeat
|
||||||
|
* is latched on the Go side instead, at the top of {@code main()} --
|
||||||
|
* which is also where the damage was ({@code os.Exit(1)}), and the
|
||||||
|
* only place that can see it. See #52.
|
||||||
*/
|
*/
|
||||||
public void initialize() {
|
public void initialize() {
|
||||||
if (initialized) {
|
if (initialized) {
|
||||||
|
|||||||
@@ -1,6 +1,12 @@
|
|||||||
import { test, expect } from '../support/fixtures.js';
|
import { test, expect } from '../support/fixtures.js';
|
||||||
import type { Page } from '@playwright/test';
|
import type { Page } from '@playwright/test';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* How far the scroll test scrolls. One constant, because the guard and
|
||||||
|
* the assertion have to agree about it — they did not, which is #133.
|
||||||
|
*/
|
||||||
|
const SCROLL_TARGET = 80;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Plan 007 phase 5: expanding an album shows its tracks.
|
* Plan 007 phase 5: expanding an album shows its tracks.
|
||||||
*
|
*
|
||||||
@@ -104,20 +110,30 @@ test.describe('the album dropdown', () => {
|
|||||||
await app.setViewportSize({ width: 900, height: 600 });
|
await app.setViewportSize({ width: 900, height: 600 });
|
||||||
|
|
||||||
try {
|
try {
|
||||||
await expect.poll(() => scrollRange(app)).toMatchObject({
|
// The container has to be a scroller at all, which is the thing
|
||||||
scrollable: true,
|
// the defect behind this spec broke and is a property rather
|
||||||
overflowY: 'auto',
|
// than a moment.
|
||||||
});
|
await expect
|
||||||
|
.poll(() => scrollRange(app))
|
||||||
|
.toMatchObject({ overflowY: 'auto' });
|
||||||
|
|
||||||
await app.evaluate(() => {
|
// **Scrolling it and reading it back are one round trip** (#151).
|
||||||
const sc = document
|
//
|
||||||
.querySelector('cover-grid')
|
// #133 made the guard ask for the range this needs rather than
|
||||||
?.shadowRoot?.querySelector('.grid-scroll-container');
|
// for "scrollable at all", which was necessary and is not
|
||||||
|
// sufficient: a guard and the write it guards are separate
|
||||||
if (sc) sc.scrollTop = 80;
|
// `evaluate` calls, so the grid can satisfy the range and settle
|
||||||
});
|
// out of it before the write lands. It still does — observed as
|
||||||
|
// `Expected 80, Received 10` in the second of three consecutive
|
||||||
expect(await scrollTop(app)).toBe(80);
|
// full-suite runs, with the spec green alone on the same app
|
||||||
|
// straight afterwards.
|
||||||
|
//
|
||||||
|
// Polling harder cannot close a window between two moments; only
|
||||||
|
// removing the window can. So the probe sets `scrollTop` and
|
||||||
|
// returns what it reads back, in one page-side call, and the
|
||||||
|
// poll retries *that* — which also means the assertion is about
|
||||||
|
// what the grid did rather than about what it was ready to do.
|
||||||
|
await expect.poll(() => scrollTo(app, SCROLL_TARGET)).toBe(SCROLL_TARGET);
|
||||||
|
|
||||||
// And the dropdown it opens is on screen, wherever the manager
|
// And the dropdown it opens is on screen, wherever the manager
|
||||||
// decides that leaves the scroll. It is *not* "the position is
|
// decides that leaves the scroll. It is *not* "the position is
|
||||||
@@ -248,27 +264,45 @@ async function closeDropdown(app: Page): Promise<void> {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Whether the grid can scroll at all, which decides if a probe can move. */
|
/** Whether the grid is a scroller at all, which is what the bug broke. */
|
||||||
async function scrollRange(app: Page) {
|
async function scrollRange(app: Page) {
|
||||||
return app.evaluate(() => {
|
return app.evaluate((target) => {
|
||||||
const sc = document
|
const sc = document
|
||||||
.querySelector('cover-grid')
|
.querySelector('cover-grid')
|
||||||
?.shadowRoot?.querySelector('.grid-scroll-container');
|
?.shadowRoot?.querySelector('.grid-scroll-container');
|
||||||
|
|
||||||
return {
|
return {
|
||||||
scrollable: !!sc && sc.scrollHeight > sc.clientHeight + 40,
|
// Reported for the failure message rather than waited on: `room`
|
||||||
|
// was the guard #133 strengthened, and #151 is that a guard in
|
||||||
|
// its own round trip cannot speak for the write in the next one.
|
||||||
|
// `scrollTo` below is the assertion now; this says *why* it did
|
||||||
|
// not reach the target when it does not.
|
||||||
|
room: !!sc && sc.scrollHeight - sc.clientHeight >= target,
|
||||||
overflowY: sc ? getComputedStyle(sc).overflowY : '',
|
overflowY: sc ? getComputedStyle(sc).overflowY : '',
|
||||||
};
|
};
|
||||||
});
|
}, SCROLL_TARGET);
|
||||||
}
|
}
|
||||||
|
|
||||||
async function scrollTop(app: Page): Promise<number> {
|
/**
|
||||||
return app.evaluate(
|
* Scroll the grid and report where it actually landed, in one call.
|
||||||
() =>
|
*
|
||||||
document
|
* The whole point is that the set and the read share a moment: a
|
||||||
.querySelector('cover-grid')
|
* `scrollTop` write is clamped to the range *at the instant it lands*,
|
||||||
?.shadowRoot?.querySelector('.grid-scroll-container')?.scrollTop ?? -1,
|
* so reading it back in a second round trip asks a container that may
|
||||||
);
|
* have re-laid out in between.
|
||||||
|
*/
|
||||||
|
async function scrollTo(app: Page, target: number): Promise<number> {
|
||||||
|
return app.evaluate((to) => {
|
||||||
|
const sc = document
|
||||||
|
.querySelector('cover-grid')
|
||||||
|
?.shadowRoot?.querySelector('.grid-scroll-container');
|
||||||
|
|
||||||
|
if (!sc) return -1;
|
||||||
|
|
||||||
|
sc.scrollTop = to;
|
||||||
|
|
||||||
|
return sc.scrollTop;
|
||||||
|
}, target);
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Whether the open dropdown is inside the scroll container's viewport. */
|
/** Whether the open dropdown is inside the scroll container's viewport. */
|
||||||
|
|||||||
@@ -15,12 +15,49 @@ import { test, expect } from '../support/fixtures.js';
|
|||||||
*
|
*
|
||||||
* What it cannot answer is whether Android's *gesture* reaches the
|
* What it cannot answer is whether Android's *gesture* reaches the
|
||||||
* WebView, which is between the OS and the scaffold.
|
* WebView, which is between the OS and the scaffold.
|
||||||
|
*
|
||||||
|
* **And `data-active-view` is not the behaviour.** Every assertion here
|
||||||
|
* used to be that attribute, which the shell sets on every path
|
||||||
|
* including `_isBack` — so this file was green throughout #72, in
|
||||||
|
* which both navs highlighted the view the user had just *left*. The
|
||||||
|
* shell's own bookkeeping was the one thing that was already right;
|
||||||
|
* what a person sees is `aria-current`, and that is asserted below as
|
||||||
|
* well. This is the same trap `layout-overflow.spec.ts` set for #69: a
|
||||||
|
* spec named for the behaviour, measuring the plumbing.
|
||||||
*/
|
*/
|
||||||
type Page = import('@playwright/test').Page;
|
type Page = import('@playwright/test').Page;
|
||||||
|
|
||||||
const activeView = (page: Page) =>
|
const activeView = (page: Page) =>
|
||||||
page.getByTestId('main-content');
|
page.getByTestId('main-content');
|
||||||
|
|
||||||
|
/** A common phone, where the bottom bar is the primary navigation. */
|
||||||
|
const PHONE = { width: 390, height: 844 };
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The nav item for a destination, in whichever navigation is on screen.
|
||||||
|
*
|
||||||
|
* Both navs carry a button named `Albums`, and only one of them is ever
|
||||||
|
* in the accessibility tree — the other is `display: none` — so the
|
||||||
|
* role query resolves to the one the user can see at this viewport.
|
||||||
|
* That is the point: the highlight has to be right in both, and #72 was
|
||||||
|
* two different-looking symptoms of one cause.
|
||||||
|
*/
|
||||||
|
const navItem = (page: Page, label: string) =>
|
||||||
|
page.getByRole('button', { name: label, exact: true });
|
||||||
|
|
||||||
|
/**
|
||||||
|
* `aria-current="page"` is the accessible fact and the assertion worth
|
||||||
|
* making; `.active` is a class and could be restyled without breaking
|
||||||
|
* anything real.
|
||||||
|
*/
|
||||||
|
async function expectHighlighted(page: Page, label: string): Promise<void> {
|
||||||
|
await expect(navItem(page, label)).toHaveAttribute('aria-current', 'page');
|
||||||
|
}
|
||||||
|
|
||||||
|
async function expectNotHighlighted(page: Page, label: string): Promise<void> {
|
||||||
|
await expect(navItem(page, label)).toHaveAttribute('aria-current', 'false');
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Open an artist's detail view, which is the deepest ordinary route.
|
* Open an artist's detail view, which is the deepest ordinary route.
|
||||||
*
|
*
|
||||||
@@ -42,6 +79,114 @@ async function openAnArtist(app: Page): Promise<void> {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The global back/forward control (#6).
|
||||||
|
*
|
||||||
|
* It is desktop chrome — hidden below 900px, where the sidebar has
|
||||||
|
* already given up its labels — so these set a desktop viewport
|
||||||
|
* explicitly rather than trusting the runner's default.
|
||||||
|
*/
|
||||||
|
const DESKTOP = { width: 1280, height: 800 };
|
||||||
|
|
||||||
|
const backButton = (page: Page) =>
|
||||||
|
page.locator('nav-history').getByRole('button', { name: 'Back' });
|
||||||
|
|
||||||
|
const forwardButton = (page: Page) =>
|
||||||
|
page.locator('nav-history').getByRole('button', { name: 'Forward' });
|
||||||
|
|
||||||
|
test.describe('global back and forward', () => {
|
||||||
|
test.beforeEach(async ({ app }) => {
|
||||||
|
await app.setViewportSize(DESKTOP);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('offers nothing at launch, in either direction', async ({ app }) => {
|
||||||
|
// The launch entry is *replaced*, not pushed, so there is nothing
|
||||||
|
// of ours behind it — and a Back button that is live at the root
|
||||||
|
// is a press that does nothing on desktop and, on Android, the
|
||||||
|
// press that should have exited the app (#142). This assertion is
|
||||||
|
// what pins that: it failed before the launch navigation stopped
|
||||||
|
// recording two entries.
|
||||||
|
await expect(backButton(app)).toBeDisabled();
|
||||||
|
await expect(forwardButton(app)).toBeDisabled();
|
||||||
|
});
|
||||||
|
|
||||||
|
test('walks the history in both directions, and says which are available', async ({
|
||||||
|
app,
|
||||||
|
}) => {
|
||||||
|
await app.getByTestId('nav-albums').click();
|
||||||
|
await expect(activeView(app)).toHaveAttribute('data-active-view', 'albums');
|
||||||
|
await expect(backButton(app)).toBeEnabled();
|
||||||
|
await expect(forwardButton(app)).toBeDisabled();
|
||||||
|
|
||||||
|
await app.getByTestId('nav-tracks').click();
|
||||||
|
await expect(activeView(app)).toHaveAttribute('data-active-view', 'tracks');
|
||||||
|
|
||||||
|
await backButton(app).click();
|
||||||
|
|
||||||
|
await expect(activeView(app)).toHaveAttribute('data-active-view', 'albums');
|
||||||
|
// Standing in the middle of the list: both directions live, which
|
||||||
|
// is the state a single depth counter cannot express.
|
||||||
|
await expect(backButton(app)).toBeEnabled();
|
||||||
|
await expect(forwardButton(app)).toBeEnabled();
|
||||||
|
|
||||||
|
await forwardButton(app).click();
|
||||||
|
|
||||||
|
await expect(activeView(app)).toHaveAttribute('data-active-view', 'tracks');
|
||||||
|
await expect(forwardButton(app)).toBeDisabled();
|
||||||
|
});
|
||||||
|
|
||||||
|
test('reaches the detail view a tab click left behind', async ({ app }) => {
|
||||||
|
// The report, exactly: the album is one entry away the whole time,
|
||||||
|
// and before this control the only way back to it was a button
|
||||||
|
// that had gone off screen with the view it belonged to.
|
||||||
|
await app.getByTestId('nav-artists').click();
|
||||||
|
await openAnArtist(app);
|
||||||
|
|
||||||
|
await app.getByTestId('nav-tracks').click();
|
||||||
|
await expect(activeView(app)).toHaveAttribute('data-active-view', 'tracks');
|
||||||
|
|
||||||
|
await backButton(app).click();
|
||||||
|
|
||||||
|
await expect(activeView(app)).toHaveAttribute(
|
||||||
|
'data-active-view',
|
||||||
|
'explore-artist-details',
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('drops the forward list when the user navigates from the middle', async ({
|
||||||
|
app,
|
||||||
|
}) => {
|
||||||
|
await app.getByTestId('nav-albums').click();
|
||||||
|
await app.getByTestId('nav-tracks').click();
|
||||||
|
await backButton(app).click();
|
||||||
|
await expect(forwardButton(app)).toBeEnabled();
|
||||||
|
|
||||||
|
// A browser truncates here, and so does this: what was ahead is no
|
||||||
|
// longer reachable, and a Forward button still offering it would
|
||||||
|
// be pointing at an entry that has been overwritten.
|
||||||
|
await app.getByTestId('nav-genres').click();
|
||||||
|
|
||||||
|
await expect(activeView(app)).toHaveAttribute('data-active-view', 'genres');
|
||||||
|
await expect(forwardButton(app)).toBeDisabled();
|
||||||
|
await expect(backButton(app)).toBeEnabled();
|
||||||
|
});
|
||||||
|
|
||||||
|
test('is absent below the desktop band, where nothing needs it', async ({
|
||||||
|
app,
|
||||||
|
}) => {
|
||||||
|
// Alt+Left/Right survive at every width, the detail views keep
|
||||||
|
// their own back buttons and the phone has the platform's gesture
|
||||||
|
// — so this is a control standing down, not an action becoming
|
||||||
|
// unreachable. It is hidden at 899 because the top bar is what
|
||||||
|
// runs out of room first below 900 (#143).
|
||||||
|
await app.setViewportSize({ width: 899, height: 600 });
|
||||||
|
await expect(app.locator('nav-history')).toBeHidden();
|
||||||
|
|
||||||
|
await app.setViewportSize({ width: 390, height: 844 });
|
||||||
|
await expect(app.locator('nav-history')).toBeHidden();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
test.describe('the back gesture', () => {
|
test.describe('the back gesture', () => {
|
||||||
test('leaves a detail view for the view it was opened from', async ({
|
test('leaves a detail view for the view it was opened from', async ({
|
||||||
app,
|
app,
|
||||||
@@ -71,6 +216,105 @@ test.describe('the back gesture', () => {
|
|||||||
await expect(activeView(app)).toHaveAttribute('data-active-view', 'albums');
|
await expect(activeView(app)).toHaveAttribute('data-active-view', 'albums');
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test('leaves the nav highlighting the view it landed on, not the one it left', async ({
|
||||||
|
app,
|
||||||
|
}) => {
|
||||||
|
await app.getByTestId('nav-albums').click();
|
||||||
|
await expectHighlighted(app, 'Albums');
|
||||||
|
|
||||||
|
await app.getByTestId('nav-tracks').click();
|
||||||
|
await expectHighlighted(app, 'Tracks');
|
||||||
|
|
||||||
|
await app.goBack();
|
||||||
|
|
||||||
|
// #72, and the half of it the report did not describe: this is
|
||||||
|
// desktop, and before the shell published the active view *both*
|
||||||
|
// navs stayed on Tracks. An absent highlight reads as a glitch; a
|
||||||
|
// confident wrong one is worse, and any back across two primary
|
||||||
|
// views produced it.
|
||||||
|
await expect(activeView(app)).toHaveAttribute('data-active-view', 'albums');
|
||||||
|
await expectHighlighted(app, 'Albums');
|
||||||
|
await expectNotHighlighted(app, 'Tracks');
|
||||||
|
});
|
||||||
|
|
||||||
|
test('keeps the parent destination lit while a detail view is open', async ({
|
||||||
|
app,
|
||||||
|
}) => {
|
||||||
|
await app.getByTestId('nav-artists').click();
|
||||||
|
await expectHighlighted(app, 'Artists');
|
||||||
|
|
||||||
|
await openAnArtist(app);
|
||||||
|
|
||||||
|
// A detail view is not a destination in either nav, and the user is
|
||||||
|
// still inside Artists. `app-sidebar` did this by accident -- it
|
||||||
|
// guarded on its own item list, so an unmatched name left the
|
||||||
|
// highlight alone -- and that accident is why the sidebar looked
|
||||||
|
// right on a detail view while the tab bar lit nothing. This test
|
||||||
|
// therefore passed before the fix and is here to keep the rule from
|
||||||
|
// being lost while the others are made to pass; the *tab bar's*
|
||||||
|
// half of it is the phone test below, which did not.
|
||||||
|
await expectHighlighted(app, 'Artists');
|
||||||
|
|
||||||
|
await app.goBack();
|
||||||
|
|
||||||
|
await expectHighlighted(app, 'Artists');
|
||||||
|
});
|
||||||
|
|
||||||
|
test('the tab bar survives the same journey on a phone', async ({ app }) => {
|
||||||
|
await app.setViewportSize(PHONE);
|
||||||
|
|
||||||
|
// The reported shape: Albums, open an album, press back. The tab
|
||||||
|
// bar had a highlight, then no highlight at all, and never got it
|
||||||
|
// back — `bottom-nav` took the detail view's name, matched it
|
||||||
|
// against no tab, and lit nothing.
|
||||||
|
await navItem(app, 'Albums').click();
|
||||||
|
await expectHighlighted(app, 'Albums');
|
||||||
|
|
||||||
|
await app.locator('cover-grid').getByText('Glass Harbour').first().click();
|
||||||
|
await expect(activeView(app)).toHaveAttribute(
|
||||||
|
'data-active-view',
|
||||||
|
'explore-album-details',
|
||||||
|
);
|
||||||
|
await expectHighlighted(app, 'Albums');
|
||||||
|
|
||||||
|
await app.goBack();
|
||||||
|
|
||||||
|
await expect(activeView(app)).toHaveAttribute('data-active-view', 'albums');
|
||||||
|
await expectHighlighted(app, 'Albums');
|
||||||
|
});
|
||||||
|
|
||||||
|
test('the drawer sidebar opens on the page you are standing on', async ({
|
||||||
|
app,
|
||||||
|
}) => {
|
||||||
|
await app.setViewportSize(PHONE);
|
||||||
|
|
||||||
|
await navItem(app, 'Tracks').click();
|
||||||
|
await expectHighlighted(app, 'Tracks');
|
||||||
|
|
||||||
|
// A third symptom of the same cause, found while measuring #72 and
|
||||||
|
// not in the report: `bottom-nav` mounts its `<app-sidebar>` when
|
||||||
|
// the drawer opens, so that copy had heard no `navigate` at all and
|
||||||
|
// showed its own default — Home, from any page in the app. An event
|
||||||
|
// has no answer for a listener that was not there; a store does.
|
||||||
|
await navItem(app, 'More').click();
|
||||||
|
|
||||||
|
// The element carrying the testid is the `wa-drawer` host, which
|
||||||
|
// always reports hidden -- what is visible is the `<dialog>` in its
|
||||||
|
// shadow root -- so the drawer being open is asserted of the
|
||||||
|
// sidebar it holds rather than of itself.
|
||||||
|
const drawer = app.getByTestId('nav-drawer');
|
||||||
|
|
||||||
|
await expect(drawer.locator('app-sidebar')).toBeVisible();
|
||||||
|
await expect(drawer.getByTestId('nav-tracks')).toHaveAttribute(
|
||||||
|
'aria-current',
|
||||||
|
'page',
|
||||||
|
);
|
||||||
|
await expect(drawer.getByTestId('nav-home')).toHaveAttribute(
|
||||||
|
'aria-current',
|
||||||
|
'false',
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
test('an in-app back button consumes exactly one entry', async ({ app }) => {
|
test('an in-app back button consumes exactly one entry', async ({ app }) => {
|
||||||
await app.getByTestId('nav-tracks').click();
|
await app.getByTestId('nav-tracks').click();
|
||||||
await openAnArtist(app);
|
await openAnArtist(app);
|
||||||
|
|||||||
@@ -0,0 +1,147 @@
|
|||||||
|
import { test, expect, callBinding, NO_QUEUE_SOURCE } from '../support/fixtures.js';
|
||||||
|
import type { Page } from '@playwright/test';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The bottom bar's two promises (#23, #42): the transport is centred in
|
||||||
|
* the window, and the volume is a slider rather than a popup.
|
||||||
|
*
|
||||||
|
* **"Centred" is measured against the window, not against the space
|
||||||
|
* left over**, which is the whole of #23. The bar was
|
||||||
|
* `320px 1fr auto`, so the transport sat in the middle of what the
|
||||||
|
* metadata and the queue button did not use — its centre was ~140px
|
||||||
|
* right of the window's at every size, which reads as an alignment
|
||||||
|
* mistake rather than as a layout choice.
|
||||||
|
*
|
||||||
|
* The mechanism is that the outer two columns are the same width, so
|
||||||
|
* this asserts the *outcome* (centre lines up) rather than the CSS. A
|
||||||
|
* spec that checked `grid-template-columns` would pass on any build
|
||||||
|
* that kept the declaration and broke the result.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/** Where the transport sits, against where the window's centre is. */
|
||||||
|
const geometry = (app: Page) =>
|
||||||
|
app.evaluate(() => {
|
||||||
|
const bar = document.querySelector<HTMLElement>('.bottom-bar')!;
|
||||||
|
const player = document.querySelector<HTMLElement>('audio-player')!;
|
||||||
|
const b = bar.getBoundingClientRect();
|
||||||
|
const p = player.getBoundingClientRect();
|
||||||
|
|
||||||
|
const seek = player.shadowRoot
|
||||||
|
?.querySelector('seek-bar')
|
||||||
|
?.shadowRoot?.querySelector('wa-slider');
|
||||||
|
|
||||||
|
return {
|
||||||
|
offset: Math.round(p.left + p.width / 2 - (b.left + b.width / 2)),
|
||||||
|
barHeight: Math.round(b.height),
|
||||||
|
seekWidth: seek ? Math.round(seek.getBoundingClientRect().width) : -1,
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
/** Something has to be playing before the transport draws a seek bar. */
|
||||||
|
async function play(app: Page): Promise<void> {
|
||||||
|
const paths = await app.evaluate(async () => {
|
||||||
|
const tracks = (await window.__yjEvents.call(
|
||||||
|
'library.Library.GetTracks',
|
||||||
|
[0],
|
||||||
|
10_000,
|
||||||
|
)) as { FilePath: string }[];
|
||||||
|
|
||||||
|
return tracks.slice(0, 3).map((t) => t.FilePath);
|
||||||
|
});
|
||||||
|
|
||||||
|
await callBinding(app, 'queue.Queue.SetQueue', [
|
||||||
|
paths,
|
||||||
|
0,
|
||||||
|
false,
|
||||||
|
NO_QUEUE_SOURCE,
|
||||||
|
]);
|
||||||
|
await callBinding(app, 'queue.Queue.Play');
|
||||||
|
await expect(app.getByTestId('now-playing-title')).not.toBeEmpty();
|
||||||
|
}
|
||||||
|
|
||||||
|
test.describe('the bottom bar', () => {
|
||||||
|
test.afterEach(async ({ app }) => {
|
||||||
|
await callBinding(app, 'queue.Queue.Clear').catch(() => {
|
||||||
|
/* already empty */
|
||||||
|
});
|
||||||
|
await app.setViewportSize({ width: 1440, height: 900 });
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Four widths, because a centring bug is a function of width: the old
|
||||||
|
* layout was off by half the difference between the two outer
|
||||||
|
* columns, so it was wrong by a different amount at each one and
|
||||||
|
* exactly right at none.
|
||||||
|
*/
|
||||||
|
for (const width of [800, 900, 1100, 1440]) {
|
||||||
|
test(`centres the transport in the window at ${width}px`, async ({
|
||||||
|
app,
|
||||||
|
}) => {
|
||||||
|
await app.setViewportSize({ width, height: 700 });
|
||||||
|
await play(app);
|
||||||
|
|
||||||
|
await expect.poll(() => geometry(app).then((g) => g.offset)).toBe(0);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The seek bar is what the centring is *paid for* with, so it is
|
||||||
|
* asserted rather than assumed.
|
||||||
|
*
|
||||||
|
* Reserving the metadata's full width on both sides centres the
|
||||||
|
* transport perfectly and squeezes the control you drag: measured
|
||||||
|
* during this work at **61px of track at 800px**, against 257 before
|
||||||
|
* the change. The side columns are capped at a quarter of the bar for
|
||||||
|
* that reason, and this is the number that says so — 246 at 800px,
|
||||||
|
* which is parity with the uncentred layout.
|
||||||
|
*/
|
||||||
|
test('does not pay for the centring with the seek bar', async ({ app }) => {
|
||||||
|
await app.setViewportSize({ width: 800, height: 700 });
|
||||||
|
await play(app);
|
||||||
|
|
||||||
|
await expect
|
||||||
|
.poll(() => geometry(app).then((g) => g.seekWidth))
|
||||||
|
.toBeGreaterThan(200);
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* #42: the slider is simply there. Three gestures — click open, drag,
|
||||||
|
* click closed — is what a bottom bar has room not to ask for.
|
||||||
|
*/
|
||||||
|
test('shows the volume slider without a click', async ({ app }) => {
|
||||||
|
await app.setViewportSize({ width: 1440, height: 900 });
|
||||||
|
|
||||||
|
const volume = app.locator('.bottom-bar volume-control');
|
||||||
|
|
||||||
|
await expect(volume).toBeVisible();
|
||||||
|
await expect(volume.locator('wa-slider')).toBeVisible();
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* And the inline icon is the mute toggle, because with the slider
|
||||||
|
* beside it there is nothing left to disclose. The name follows the
|
||||||
|
* action rather than the state for the same reason.
|
||||||
|
*/
|
||||||
|
test('names the inline icon after what it does', async ({ app }) => {
|
||||||
|
await app.setViewportSize({ width: 1440, height: 900 });
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
app.locator('.bottom-bar volume-control').getByRole('button', {
|
||||||
|
name: 'Mute',
|
||||||
|
}),
|
||||||
|
).toBeVisible();
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The bar is a fixed 4em row and the transport sits in it. A slider
|
||||||
|
* with a label grows `#slider` by 8px unless `wa-slider-label.css`
|
||||||
|
* suppresses it, which moved the whole bar the last time — so the
|
||||||
|
* height is pinned here rather than left to a screenshot.
|
||||||
|
*/
|
||||||
|
test('stays 4em tall', async ({ app }) => {
|
||||||
|
await app.setViewportSize({ width: 1440, height: 900 });
|
||||||
|
await play(app);
|
||||||
|
|
||||||
|
await expect.poll(() => geometry(app).then((g) => g.barHeight)).toBe(64);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -29,18 +29,13 @@ test.describe('a control says what it controls', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
test('the volume slider is announced as Volume', async ({ app }) => {
|
test('the volume slider is announced as Volume', async ({ app }) => {
|
||||||
// The popup renders no slider at all while closed, the same way the
|
// No disclosure to open first, and no state to put back afterwards:
|
||||||
// queue panel renders no list — so this has to open it first.
|
// #42 made the slider inline, so it is simply there. The assertion
|
||||||
await app.getByRole('button', { name: /volume/i }).click();
|
// is unchanged — the *name* is the subject here, and the route to
|
||||||
|
// the control got shorter rather than different.
|
||||||
await expect(
|
await expect(
|
||||||
app.getByRole('slider', { name: 'Volume' }),
|
app.getByRole('slider', { name: 'Volume' }),
|
||||||
).toBeVisible();
|
).toBeVisible();
|
||||||
|
|
||||||
// Leave the transport as it was found: the specs share one page in
|
|
||||||
// file order, and an open popup covers the buttons beneath it.
|
|
||||||
await app.keyboard.press('Escape');
|
|
||||||
await app.locator('body').click({ position: { x: 5, y: 5 } });
|
|
||||||
});
|
});
|
||||||
|
|
||||||
test('naming the slider did not move the transport', async ({ app }) => {
|
test('naming the slider did not move the transport', async ({ app }) => {
|
||||||
|
|||||||
@@ -36,9 +36,16 @@ test.describe('a failed binding says so', () => {
|
|||||||
// Libraries is the one section that starts expanded (H-22), so ask
|
// Libraries is the one section that starts expanded (H-22), so ask
|
||||||
// the disclosure what state it is in rather than assuming one — a
|
// the disclosure what state it is in rather than assuming one — a
|
||||||
// blind click used to expand it and now collapses it.
|
// blind click used to expand it and now collapses it.
|
||||||
|
//
|
||||||
|
// By role and name, not by `.header`: since #27 the section also
|
||||||
|
// contains a `job-panel`, and an open `job-details-drawer` inside
|
||||||
|
// it carries the same class. That only bites once a job exists,
|
||||||
|
// which is why it showed up on the *second* engine of a CI run and
|
||||||
|
// not the first.
|
||||||
const disclosure = page
|
const disclosure = page
|
||||||
.locator('config-section[heading="Libraries"]')
|
.locator('config-section[heading="Libraries"]')
|
||||||
.locator('.header');
|
.getByRole('button', { name: 'Libraries' })
|
||||||
|
.first();
|
||||||
|
|
||||||
if ((await disclosure.getAttribute('aria-expanded')) === 'false') {
|
if ((await disclosure.getAttribute('aria-expanded')) === 'false') {
|
||||||
await disclosure.click();
|
await disclosure.click();
|
||||||
|
|||||||
@@ -0,0 +1,318 @@
|
|||||||
|
import { test, expect } from '../support/fixtures.js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* #69: the Playlists header's buttons could not be reached.
|
||||||
|
*
|
||||||
|
* Three text buttons — Import (91px), New Playlist (122px), New Smart
|
||||||
|
* Playlist (162px), 390px in total — inside a header that gets 700px at
|
||||||
|
* 900×600. "New Smart Playlist" rendered **114 of its 162px**, and at
|
||||||
|
* phone width the Android report was the plain version of it: you
|
||||||
|
* cannot scroll to reach them, and scrolling is not how page controls
|
||||||
|
* should be exposed anyway.
|
||||||
|
*
|
||||||
|
* **`layout-overflow.spec.ts` passes on the broken build**, which is why
|
||||||
|
* this file exists rather than a case being added there. That spec
|
||||||
|
* asserts the *shell* needs no sideways scrolling; clipping *inside* a
|
||||||
|
* component is invisible to it. So the measurement here is per-button
|
||||||
|
* and per-header, against the widths the app promises.
|
||||||
|
*
|
||||||
|
* Plan 018's size matrix is the promise being kept: **no action is ever
|
||||||
|
* unreachable at any supported size.** These are its three bands.
|
||||||
|
*/
|
||||||
|
|
||||||
|
const VIEWPORTS = [
|
||||||
|
// Desktop's worst case, and not the enforced minimum: the sidebar
|
||||||
|
// collapses to icons *below* 900, so the content area is 843px at 899
|
||||||
|
// and 700px at 900. Testing "the minimum" and stopping misses it.
|
||||||
|
{ name: '900×600 (widest sidebar, narrowest content)', width: 900, height: 600 },
|
||||||
|
{ name: '800×600 (the enforced minimum)', width: 800, height: 600 },
|
||||||
|
{ name: '390×780 (phone)', width: 390, height: 780 },
|
||||||
|
// WCAG 1.4.10's reflow target, which plan 018 promises the app fits.
|
||||||
|
{ name: '320×600 (400% zoom)', width: 320, height: 600 },
|
||||||
|
];
|
||||||
|
|
||||||
|
/** Every action the Playlists header can offer, in declared order. */
|
||||||
|
const ACTIONS = ['Import', 'New Playlist', 'New Smart Playlist'];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* What the header is actually rendering, measured rather than inferred.
|
||||||
|
*
|
||||||
|
* A shadow query is the wrong tool for *asserting* — that is what
|
||||||
|
* `getByRole` below is for — but it is the right one for a measurement,
|
||||||
|
* because the number this issue is about (a button 48px wider than the
|
||||||
|
* box holding it) is not in the accessibility tree at all.
|
||||||
|
*/
|
||||||
|
const headerFit = (page: import('@playwright/test').Page) =>
|
||||||
|
page.evaluate(() => {
|
||||||
|
const root = document
|
||||||
|
.querySelector('[data-testid="main-content"] playlist-view')
|
||||||
|
?.shadowRoot?.querySelector('page-header')?.shadowRoot;
|
||||||
|
|
||||||
|
if (!root) return null;
|
||||||
|
|
||||||
|
const header = root.querySelector<HTMLElement>('.page-header')!;
|
||||||
|
const box = header.getBoundingClientRect();
|
||||||
|
const title = root.querySelector<HTMLElement>('h1')!;
|
||||||
|
|
||||||
|
const clipped = [
|
||||||
|
...root.querySelectorAll<HTMLElement>('.action, .more-button'),
|
||||||
|
]
|
||||||
|
.filter((b) => !b.hidden)
|
||||||
|
.filter((b) => {
|
||||||
|
const r = b.getBoundingClientRect();
|
||||||
|
|
||||||
|
return r.right > box.right + 1 || r.left < box.left - 1;
|
||||||
|
})
|
||||||
|
.map((b) => b.dataset['actionId'] ?? 'more');
|
||||||
|
|
||||||
|
return {
|
||||||
|
overflow: header.scrollWidth - header.clientWidth,
|
||||||
|
clipped,
|
||||||
|
titleTruncated: title.scrollWidth > title.clientWidth + 1,
|
||||||
|
buttons: [...root.querySelectorAll<HTMLElement>('.action')]
|
||||||
|
.filter((b) => !b.hidden)
|
||||||
|
.map((b) => b.textContent?.trim() ?? ''),
|
||||||
|
menu: [
|
||||||
|
...root.querySelectorAll('#page-header-overflow wa-dropdown-item'),
|
||||||
|
].map((i) => i.textContent?.trim() ?? ''),
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
test.describe('the page header never clips an action', () => {
|
||||||
|
test.beforeEach(async ({ app }) => {
|
||||||
|
await app.getByTestId('nav-playlists').click();
|
||||||
|
await expect(app.getByTestId('main-content')).toHaveAttribute(
|
||||||
|
'data-active-view',
|
||||||
|
'playlists',
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test.afterEach(async ({ app }) => {
|
||||||
|
await app.setViewportSize({ width: 1280, height: 800 });
|
||||||
|
});
|
||||||
|
|
||||||
|
for (const vp of VIEWPORTS) {
|
||||||
|
test(`every action is reachable at ${vp.name}`, async ({ app }) => {
|
||||||
|
await app.setViewportSize({ width: vp.width, height: vp.height });
|
||||||
|
|
||||||
|
// Polled: the fit is decided by a ResizeObserver, so it settles a
|
||||||
|
// frame after the resize rather than with it.
|
||||||
|
await expect
|
||||||
|
.poll(async () => (await headerFit(app))?.clipped)
|
||||||
|
.toEqual([]);
|
||||||
|
|
||||||
|
const fit = (await headerFit(app))!;
|
||||||
|
|
||||||
|
expect(fit.overflow).toBeLessThanOrEqual(0);
|
||||||
|
|
||||||
|
// Between them, buttons and menu account for all three. This is
|
||||||
|
// the assertion the issue asks for: not "it fits" but "nothing
|
||||||
|
// was dropped to make it fit".
|
||||||
|
expect([...fit.buttons, ...fit.menu].sort()).toEqual([...ACTIONS].sort());
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The title gives way before an action does.
|
||||||
|
*
|
||||||
|
* Once the heading can ellipsis it absorbs the pressure, and
|
||||||
|
* `scrollWidth` then reports a header that fits perfectly while the
|
||||||
|
* heading reads "Playlis…" — this issue's own failure mode moved from
|
||||||
|
* the button to the title, and invisible to exactly the measurement
|
||||||
|
* that missed it the first time. At the desktop sizes there is always
|
||||||
|
* an action to collapse instead.
|
||||||
|
*/
|
||||||
|
test('does not truncate the heading to keep a button', async ({ app }) => {
|
||||||
|
for (const vp of VIEWPORTS.slice(0, 2)) {
|
||||||
|
await app.setViewportSize({ width: vp.width, height: vp.height });
|
||||||
|
|
||||||
|
await expect
|
||||||
|
.poll(async () => (await headerFit(app))?.titleTruncated)
|
||||||
|
.toBe(false);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Asserted through the accessibility tree, never a shadow query. An
|
||||||
|
* overflow menu is exactly the shape that grows a nameless control,
|
||||||
|
* and this repo has shipped one four times — most recently the
|
||||||
|
* queue's own close button.
|
||||||
|
*/
|
||||||
|
test('the overflow is a named control that opens a named menu', async ({
|
||||||
|
app,
|
||||||
|
}) => {
|
||||||
|
await app.setViewportSize({ width: 900, height: 600 });
|
||||||
|
|
||||||
|
const more = app.getByRole('button', { name: 'More actions' });
|
||||||
|
|
||||||
|
await expect(more).toBeVisible();
|
||||||
|
await expect(more).toHaveAttribute('aria-expanded', 'false');
|
||||||
|
|
||||||
|
await more.click();
|
||||||
|
|
||||||
|
await expect(more).toHaveAttribute('aria-expanded', 'true');
|
||||||
|
|
||||||
|
const menu = app.getByRole('menu', { name: 'More actions' });
|
||||||
|
|
||||||
|
await expect(menu).toBeVisible();
|
||||||
|
|
||||||
|
// Collapsed at 900×600: Import (lowest priority) and New Smart
|
||||||
|
// Playlist. New Playlist stays a button because it is the drop
|
||||||
|
// target, and a closed menu cannot be one.
|
||||||
|
await expect(
|
||||||
|
menu.getByRole('menuitem', { name: 'Import' }),
|
||||||
|
).toBeVisible();
|
||||||
|
await expect(
|
||||||
|
app.getByRole('button', { name: 'New Playlist', exact: true }),
|
||||||
|
).toBeVisible();
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The phone case is the original report. Every action is in the menu
|
||||||
|
* at 390px, and the menu is reachable by name — which is the whole of
|
||||||
|
* "these need to be reachable in a sensible way".
|
||||||
|
*/
|
||||||
|
test('offers every action from the menu on a phone', async ({ app }) => {
|
||||||
|
await app.setViewportSize({ width: 390, height: 780 });
|
||||||
|
|
||||||
|
const more = app.getByRole('button', { name: 'More actions' });
|
||||||
|
|
||||||
|
await expect(more).toBeVisible();
|
||||||
|
await more.click();
|
||||||
|
|
||||||
|
const menu = app.getByRole('menu', { name: 'More actions' });
|
||||||
|
|
||||||
|
for (const label of ACTIONS) {
|
||||||
|
await expect(menu.getByRole('menuitem', { name: label })).toBeVisible();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Escape closes it and focus goes back to the trigger — `MenuKeyboard`
|
||||||
|
* is shared with every other menu in the app precisely so this is not
|
||||||
|
* a second keyboard model, and this is what proves it was wired up
|
||||||
|
* rather than merely imported.
|
||||||
|
*/
|
||||||
|
test('takes the keyboard, and gives it back', async ({ app }) => {
|
||||||
|
await app.setViewportSize({ width: 900, height: 600 });
|
||||||
|
|
||||||
|
const more = app.getByRole('button', { name: 'More actions' });
|
||||||
|
|
||||||
|
await more.click();
|
||||||
|
|
||||||
|
const menu = app.getByRole('menu', { name: 'More actions' });
|
||||||
|
|
||||||
|
await expect(menu).toBeVisible();
|
||||||
|
|
||||||
|
// The first item takes focus on open. `wa-dropdown-item` sets its
|
||||||
|
// own role in its own first update, so this is polled rather than
|
||||||
|
// read: a query at the host's updateComplete finds nothing, which
|
||||||
|
// reads exactly like a menu that refused to take focus.
|
||||||
|
await expect
|
||||||
|
.poll(async () =>
|
||||||
|
app.evaluate(() => {
|
||||||
|
// Stops where `MenuKeyboard`'s own `deepActiveElement` stops:
|
||||||
|
// on the *host* whose shadow root has no active element.
|
||||||
|
// Descending unconditionally lands inside the focused
|
||||||
|
// `wa-dropdown-item`'s own shadow root, where nothing is
|
||||||
|
// focused — which reads exactly like a menu that refused the
|
||||||
|
// keyboard, on a build where it did not.
|
||||||
|
let el = document.activeElement;
|
||||||
|
|
||||||
|
while (el?.shadowRoot?.activeElement) el = el.shadowRoot.activeElement;
|
||||||
|
|
||||||
|
return el?.textContent?.trim() ?? null;
|
||||||
|
}),
|
||||||
|
)
|
||||||
|
.toBe('Import');
|
||||||
|
|
||||||
|
await app.keyboard.press('Escape');
|
||||||
|
|
||||||
|
await expect(more).toHaveAttribute('aria-expanded', 'false');
|
||||||
|
await expect(more).toBeFocused();
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* New Playlist is a drop target, and declaring it as data must not
|
||||||
|
* take that away — which is why a `PageAction` carries the drop
|
||||||
|
* handlers rather than the header owning a notion of dropping.
|
||||||
|
*
|
||||||
|
* Nothing covered this before, in either tier, and it is the one
|
||||||
|
* behaviour the migration could plausibly have destroyed silently:
|
||||||
|
* dragging still *looks* fine against a button that no longer
|
||||||
|
* accepts anything.
|
||||||
|
*/
|
||||||
|
test('New Playlist still accepts a dropped track', async ({ app }) => {
|
||||||
|
await app.setViewportSize({ width: 1280, height: 800 });
|
||||||
|
|
||||||
|
const button = app.getByRole('button', {
|
||||||
|
name: 'New Playlist',
|
||||||
|
exact: true,
|
||||||
|
});
|
||||||
|
|
||||||
|
await expect(button).toBeVisible();
|
||||||
|
|
||||||
|
const result = await app.evaluate(async () => {
|
||||||
|
const view = document.querySelector(
|
||||||
|
'[data-testid="main-content"] playlist-view',
|
||||||
|
)!;
|
||||||
|
const target = view.shadowRoot!
|
||||||
|
.querySelector('page-header')!
|
||||||
|
.shadowRoot!.querySelector('[data-testid="page-action-new-playlist"]')!;
|
||||||
|
|
||||||
|
const data = new DataTransfer();
|
||||||
|
|
||||||
|
data.setData(
|
||||||
|
'application/x-yj-tracks',
|
||||||
|
JSON.stringify({ filePaths: ['/tmp/dropped.mp3'] }),
|
||||||
|
);
|
||||||
|
|
||||||
|
const fire = (type: string) =>
|
||||||
|
target.dispatchEvent(
|
||||||
|
new DragEvent(type, {
|
||||||
|
bubbles: true,
|
||||||
|
cancelable: true,
|
||||||
|
dataTransfer: data,
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
|
||||||
|
fire('dragover');
|
||||||
|
await new Promise((r) => setTimeout(r, 50));
|
||||||
|
|
||||||
|
// The affordance is the host's state reaching the header's
|
||||||
|
// button, which is the half a plain handler call would not prove.
|
||||||
|
const highlighted = target.classList.contains('drag-over');
|
||||||
|
|
||||||
|
fire('drop');
|
||||||
|
await new Promise((r) => setTimeout(r, 200));
|
||||||
|
|
||||||
|
return {
|
||||||
|
highlighted,
|
||||||
|
opened: view.shadowRoot!.querySelector('.create-form') !== null,
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(result).toEqual({ highlighted: true, opened: true });
|
||||||
|
|
||||||
|
// Leave the view as it was found.
|
||||||
|
await app.keyboard.press('Escape');
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An action given back when the window widens again. The collapsed
|
||||||
|
* set is a function of the current width and not of how it got there
|
||||||
|
* — a rule that only ever *added* to it would never widen.
|
||||||
|
*/
|
||||||
|
test('gives the buttons back when the window grows', async ({ app }) => {
|
||||||
|
await app.setViewportSize({ width: 390, height: 780 });
|
||||||
|
|
||||||
|
await expect.poll(async () => (await headerFit(app))?.buttons).toEqual([]);
|
||||||
|
|
||||||
|
await app.setViewportSize({ width: 1440, height: 900 });
|
||||||
|
|
||||||
|
await expect
|
||||||
|
.poll(async () => (await headerFit(app))?.buttons)
|
||||||
|
.toEqual(ACTIONS);
|
||||||
|
await expect.poll(async () => (await headerFit(app))?.menu).toEqual([]);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,124 @@
|
|||||||
|
import { test, expect, waitForEvent } from '../support/fixtures.js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The Jobs tab folded into the places the work is started (#27).
|
||||||
|
*
|
||||||
|
* The assertion worth making is not that the tab is gone — that is one
|
||||||
|
* line of a table — but that **nothing became unreachable when it
|
||||||
|
* went**. Scanning is the case that mattered: the per-library controls
|
||||||
|
* lived only on that page, and the tab's own comment says they had been
|
||||||
|
* moved there out of Settings in the first place.
|
||||||
|
*
|
||||||
|
* `#24` wrote down one sentence covering all three size bands: *no
|
||||||
|
* action is ever unreachable at any supported size*. Deleting a
|
||||||
|
* destination is exactly the change that can quietly break it.
|
||||||
|
*/
|
||||||
|
type Page = import('@playwright/test').Page;
|
||||||
|
|
||||||
|
const section = (page: Page, heading: string) =>
|
||||||
|
page.locator(`config-page config-section[heading="${heading}"]`);
|
||||||
|
|
||||||
|
async function openSettings(page: Page, heading: string): Promise<void> {
|
||||||
|
await page.getByTestId('nav-settings').click();
|
||||||
|
|
||||||
|
// The section's own disclosure, by role rather than by `.header`:
|
||||||
|
// an open Libraries section also contains `job-details-drawer`,
|
||||||
|
// whose own header matches that class and makes it ambiguous.
|
||||||
|
const header = section(page, heading)
|
||||||
|
.getByRole('button', { name: heading })
|
||||||
|
.first();
|
||||||
|
|
||||||
|
await expect(header).toBeVisible();
|
||||||
|
|
||||||
|
if ((await header.getAttribute('aria-expanded')) === 'false') {
|
||||||
|
await header.click();
|
||||||
|
}
|
||||||
|
|
||||||
|
await expect(header).toHaveAttribute('aria-expanded', 'true');
|
||||||
|
}
|
||||||
|
|
||||||
|
test.describe('background jobs live where the work is started', () => {
|
||||||
|
test('the Jobs destination is gone', async ({ app }) => {
|
||||||
|
await expect(app.getByTestId('nav-jobs')).toHaveCount(0);
|
||||||
|
|
||||||
|
// And it is not offered as a launch page either, which is the copy
|
||||||
|
// of the destination list that is easiest to forget.
|
||||||
|
await openSettings(app, 'General');
|
||||||
|
|
||||||
|
const options = await section(app, 'General')
|
||||||
|
.locator('select')
|
||||||
|
.first()
|
||||||
|
.locator('option')
|
||||||
|
.allTextContents();
|
||||||
|
|
||||||
|
expect(options).not.toContain('Jobs');
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Scanning is startable from Settings → Libraries, and the job that
|
||||||
|
* results is visible there with its controls. One assertion covers
|
||||||
|
* both halves, because a Scan All that started nothing would leave
|
||||||
|
* the panel empty and read exactly like a panel that does not work.
|
||||||
|
*/
|
||||||
|
test('a scan is started and watched in Settings', async ({ app }) => {
|
||||||
|
await openSettings(app, 'Libraries');
|
||||||
|
|
||||||
|
const libraries = section(app, 'Libraries');
|
||||||
|
|
||||||
|
await libraries.getByRole('button', { name: 'Scan All' }).click();
|
||||||
|
|
||||||
|
await waitForEvent(app, 'LibraryScanComplete', { timeoutMs: 60_000 });
|
||||||
|
|
||||||
|
const panel = libraries.locator('job-panel');
|
||||||
|
|
||||||
|
await expect(panel.locator('job-row')).toHaveCount(1, { timeout: 10_000 });
|
||||||
|
|
||||||
|
// The generic affordances are the point of the panel: the tier
|
||||||
|
// list and the progress rings the other surfaces already had
|
||||||
|
// cannot open a log.
|
||||||
|
await expect(
|
||||||
|
panel.getByRole('button', { name: /^Details/ }),
|
||||||
|
).toBeVisible();
|
||||||
|
});
|
||||||
|
|
||||||
|
/** A finished job dismisses from where it is shown. */
|
||||||
|
test('a finished scan can be dismissed in place', async ({ app }) => {
|
||||||
|
await openSettings(app, 'Libraries');
|
||||||
|
|
||||||
|
const panel = section(app, 'Libraries').locator('job-panel');
|
||||||
|
const dismiss = panel.getByRole('button', { name: /^Dismiss/ }).first();
|
||||||
|
|
||||||
|
await expect(dismiss).toBeVisible({ timeout: 10_000 });
|
||||||
|
await dismiss.click();
|
||||||
|
|
||||||
|
await expect(panel.locator('job-row')).toHaveCount(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Full rescan is destructive and asks first. It is asserted at the
|
||||||
|
* dialog rather than through it — running one against the seeded app
|
||||||
|
* would delete the library the rest of the suite reads.
|
||||||
|
*/
|
||||||
|
test('Full Rescan asks before it does anything', async ({ app }) => {
|
||||||
|
await openSettings(app, 'Libraries');
|
||||||
|
|
||||||
|
await section(app, 'Libraries')
|
||||||
|
.getByRole('button', { name: 'Full Rescan' })
|
||||||
|
.click();
|
||||||
|
|
||||||
|
const dialog = app.getByRole('dialog', { name: 'Full rescan' });
|
||||||
|
|
||||||
|
await expect(dialog).toBeVisible();
|
||||||
|
|
||||||
|
// The message is read off the *host*, not the dialog: a wa-dialog
|
||||||
|
// keeps its slotted content in the host's shadow root, so
|
||||||
|
// `toContainText` on the dialog itself sees only Web Awesome's
|
||||||
|
// chrome.
|
||||||
|
await expect(app.locator('confirm-dialog')).toContainText(
|
||||||
|
'deletes all library data',
|
||||||
|
);
|
||||||
|
|
||||||
|
await app.getByRole('button', { name: 'Cancel' }).click();
|
||||||
|
await expect(dialog).toBeHidden();
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -26,7 +26,21 @@ const MIN_VIEWPORT = { width: 800, height: 600 };
|
|||||||
const VIEWPORTS = [
|
const VIEWPORTS = [
|
||||||
{ name: '1440×900', width: 1440, height: 900 },
|
{ name: '1440×900', width: 1440, height: 900 },
|
||||||
{ name: '1024×768', width: 1024, height: 768 },
|
{ name: '1024×768', width: 1024, height: 768 },
|
||||||
|
// Not the minimum, and that is the point (#24). The sidebar collapses
|
||||||
|
// to icons *below* 900, so the main panel is 843px at 899 and 700px
|
||||||
|
// at 900 — the narrowest content area any desktop width produces is
|
||||||
|
// here, not at the enforced floor. A list that stopped at the minimum
|
||||||
|
// was missing its own worst case.
|
||||||
|
{ name: '900×600 (the widest sidebar, so the narrowest content)', width: 900, height: 600 },
|
||||||
{ name: `the minimum (${MIN_VIEWPORT.width}×${MIN_VIEWPORT.height})`, ...MIN_VIEWPORT },
|
{ name: `the minimum (${MIN_VIEWPORT.width}×${MIN_VIEWPORT.height})`, ...MIN_VIEWPORT },
|
||||||
|
// Below the enforced minimum on purpose, and for the reason 700×480
|
||||||
|
// is below it further down: a scaled display or a large system font
|
||||||
|
// lands the layout here without the window ever being dragged there,
|
||||||
|
// and 600 is the last width before the phone layout takes over. The
|
||||||
|
// *narrowest header* is a different question from the narrowest
|
||||||
|
// content area and has a different answer — this one (#143), where
|
||||||
|
// the bar was 611px inside 600 sitting still.
|
||||||
|
{ name: '600×600 (the bottom of the Compact band)', width: 600, height: 600 },
|
||||||
];
|
];
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -87,9 +101,10 @@ test.describe('the app fits in its own window', () => {
|
|||||||
)
|
)
|
||||||
.toBe(true);
|
.toBe(true);
|
||||||
|
|
||||||
// Settings and Jobs are the two that were unreachable: they are
|
// Settings is the one that was unreachable: it is last in the nav,
|
||||||
// last in the nav, and the pane used to clip rather than scroll.
|
// and the pane used to clip rather than scroll. (Jobs was the other
|
||||||
for (const view of ['jobs', 'settings'] as const) {
|
// half of this until #27 folded it into Settings.)
|
||||||
|
for (const view of ['explore', 'settings'] as const) {
|
||||||
const item = app.getByTestId(`nav-${view}`);
|
const item = app.getByTestId(`nav-${view}`);
|
||||||
|
|
||||||
await item.scrollIntoViewIfNeeded();
|
await item.scrollIntoViewIfNeeded();
|
||||||
@@ -117,27 +132,45 @@ test.describe('the app fits in its own window', () => {
|
|||||||
// be dragged here, but a scaled display or a large system font can
|
// be dragged here, but a scaled display or a large system font can
|
||||||
// still land the layout in it, and clipping the nav with no scroll
|
// still land the layout in it, and clipping the nav with no scroll
|
||||||
// is the failure that made Settings unreachable.
|
// is the failure that made Settings unreachable.
|
||||||
const reachable = await app.locator('app-sidebar').evaluate((el) => {
|
//
|
||||||
const settings = el.shadowRoot?.querySelector<HTMLElement>(
|
// The scroll and the measurement share one `evaluate` — #151's
|
||||||
'[data-testid="nav-settings"]',
|
// rule, which this already had — and the whole probe is polled,
|
||||||
);
|
// which it did not: a viewport change settles asynchronously, so a
|
||||||
|
// single attempt reads whatever the sidebar happened to be doing.
|
||||||
|
// The probe is safe to repeat because scrolling to the bottom twice
|
||||||
|
// is scrolling to the bottom.
|
||||||
|
await expect
|
||||||
|
.poll(() =>
|
||||||
|
app.locator('app-sidebar').evaluate((el) => {
|
||||||
|
const settings = el.shadowRoot?.querySelector<HTMLElement>(
|
||||||
|
'[data-testid="nav-settings"]',
|
||||||
|
);
|
||||||
|
|
||||||
if (!settings) return null;
|
if (!settings) return null;
|
||||||
|
|
||||||
el.scrollTop = el.scrollHeight;
|
el.scrollTop = el.scrollHeight;
|
||||||
|
|
||||||
const item = settings.getBoundingClientRect();
|
const item = settings.getBoundingClientRect();
|
||||||
const pane = el.getBoundingClientRect();
|
const pane = el.getBoundingClientRect();
|
||||||
|
|
||||||
return item.bottom <= Math.ceil(pane.bottom) && item.top >= Math.floor(pane.top);
|
return (
|
||||||
});
|
item.bottom <= Math.ceil(pane.bottom) &&
|
||||||
|
item.top >= Math.floor(pane.top)
|
||||||
expect(reachable).toBe(true);
|
);
|
||||||
|
}),
|
||||||
|
)
|
||||||
|
.toBe(true);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
test.describe('the title block fits its bar', () => {
|
test.describe('the title block fits its bar', () => {
|
||||||
test('the hgroup stays inside the 4em top bar', async ({ app }) => {
|
test('the hgroup stays inside the 4em top bar', async ({ app }) => {
|
||||||
|
// Stated rather than inherited from whatever ran last. Since #143
|
||||||
|
// the wordmark is visually hidden at widths where the bar cannot
|
||||||
|
// afford it, so a test about its *vertical* fit has to say which
|
||||||
|
// width it is asking about.
|
||||||
|
await app.setViewportSize({ width: 1440, height: 900 });
|
||||||
|
|
||||||
// The state a11y.29 landed in. The pair is flex-centred and a UA
|
// The state a11y.29 landed in. The pair is flex-centred and a UA
|
||||||
// gives an `h1` a 0.67em top margin, so the block measured 67px
|
// gives an `h1` a 0.67em top margin, so the block measured 67px
|
||||||
// inside 64 — pre-existing, and invisible until dropping the h3's
|
// inside 64 — pre-existing, and invisible until dropping the h3's
|
||||||
@@ -239,16 +272,26 @@ test.describe('the shell reflows rather than hiding what does not fit', () => {
|
|||||||
test(`no scrollbar appears at ${vp.name}`, async ({ app }) => {
|
test(`no scrollbar appears at ${vp.name}`, async ({ app }) => {
|
||||||
await app.setViewportSize({ width: vp.width, height: vp.height });
|
await app.setViewportSize({ width: vp.width, height: vp.height });
|
||||||
|
|
||||||
const excess = await app.evaluate(() => {
|
// Polled, for the reason the track-row test above is: since #143
|
||||||
const de = document.documentElement;
|
// the top bar's fit is *measured* — a ResizeObserver decides what
|
||||||
|
// it can afford at this width — so a single read taken straight
|
||||||
|
// after the resize races the observer and reports the frame
|
||||||
|
// before it. Read once, this passed alone and failed in the full
|
||||||
|
// suite, which is the shape of a timing assumption rather than of
|
||||||
|
// a defect.
|
||||||
|
//
|
||||||
|
// The other half of the assertion: at every size this app
|
||||||
|
// promises, the fix costs nothing. A scrollbar that is always
|
||||||
|
// there is a worse answer than the clipping it replaced.
|
||||||
|
await expect
|
||||||
|
.poll(() =>
|
||||||
|
app.evaluate(() => {
|
||||||
|
const de = document.documentElement;
|
||||||
|
|
||||||
return de.scrollWidth - de.clientWidth;
|
return de.scrollWidth - de.clientWidth;
|
||||||
});
|
}),
|
||||||
|
)
|
||||||
// The other half: at every size this app promises, the fix costs
|
.toBe(0);
|
||||||
// nothing. A scrollbar that is always there is a worse answer
|
|
||||||
// than the clipping it replaced.
|
|
||||||
expect(excess).toBe(0);
|
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -28,7 +28,7 @@ const EXPECTED_MIN_ICONS = 5;
|
|||||||
|
|
||||||
const VIEWS = [
|
const VIEWS = [
|
||||||
'home', 'tracks', 'albums', 'artists', 'genres', 'playlists',
|
'home', 'tracks', 'albums', 'artists', 'genres', 'playlists',
|
||||||
'explore', 'downloads', 'jobs', 'settings',
|
'explore', 'downloads', 'autotag', 'settings',
|
||||||
];
|
];
|
||||||
|
|
||||||
type IconState = { name: string; hasSvg: boolean };
|
type IconState = { name: string; hasSvg: boolean };
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import { test, expect } from '../support/fixtures.js';
|
import { test, expect, navigateTo } from '../support/fixtures.js';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* H-19: Playlists, Downloads, Jobs, Settings and Home had a page
|
* H-19: Playlists, Downloads, Jobs, Settings and Home had a page
|
||||||
@@ -21,7 +21,6 @@ const VIEWS: [string, string, boolean][] = [
|
|||||||
['tracks', 'Tracks', true],
|
['tracks', 'Tracks', true],
|
||||||
['explore', 'Explore', false],
|
['explore', 'Explore', false],
|
||||||
['downloads', 'Downloads', false],
|
['downloads', 'Downloads', false],
|
||||||
['jobs', 'Background jobs', false],
|
|
||||||
];
|
];
|
||||||
|
|
||||||
/** The header lives in the view's shadow root, inside its own. */
|
/** The header lives in the view's shadow root, inside its own. */
|
||||||
@@ -53,13 +52,16 @@ const TAGS: Record<string, string> = {
|
|||||||
tracks: 'track-list',
|
tracks: 'track-list',
|
||||||
explore: 'explore-view',
|
explore: 'explore-view',
|
||||||
downloads: 'downloads-view',
|
downloads: 'downloads-view',
|
||||||
jobs: 'jobs-view',
|
|
||||||
};
|
};
|
||||||
|
|
||||||
test.describe('every primary view says what it is', () => {
|
test.describe('every primary view says what it is', () => {
|
||||||
test('each one has the shared header, with a heading', async ({ app }) => {
|
test('each one has the shared header, with a heading', async ({ app }) => {
|
||||||
|
// By event rather than by nav item: a destination is not
|
||||||
|
// guaranteed to have one any more (#25 — Downloads is absent
|
||||||
|
// without a download client), and every one of these is still a
|
||||||
|
// primary view with a header, which is what this spec is about.
|
||||||
for (const [view, heading, hasCount] of VIEWS) {
|
for (const [view, heading, hasCount] of VIEWS) {
|
||||||
await app.getByTestId(`nav-${view}`).click();
|
await navigateTo(app, view);
|
||||||
await expect(app.getByTestId('main-content')).toHaveAttribute(
|
await expect(app.getByTestId('main-content')).toHaveAttribute(
|
||||||
'data-active-view',
|
'data-active-view',
|
||||||
view,
|
view,
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import { test, expect } from '../support/fixtures.js';
|
import { test, expect, LONG_TRACK } from '../support/fixtures.js';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The phone shell (plan 016 B2, phase 1).
|
* The phone shell (plan 016 B2, phase 1).
|
||||||
@@ -138,6 +138,78 @@ test.describe('the shell on a phone', () => {
|
|||||||
.toHaveAttribute('data-active-view', 'tracks');
|
.toHaveAttribute('data-active-view', 'tracks');
|
||||||
});
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The same journey with a track that has **no cover art** (#150).
|
||||||
|
*
|
||||||
|
* The test above starts the *first* row of the track list, so which
|
||||||
|
* track it plays is the order the scan inserted them in — and the
|
||||||
|
* answer decided whether it passed. A track with artwork renders an
|
||||||
|
* `<img>`, which is no obstacle; one without renders a placeholder
|
||||||
|
* `wa-icon`, which took every click aimed at the button beneath it,
|
||||||
|
* because that button is absolutely positioned with `z-index: auto`
|
||||||
|
* and the art is a *later* sibling. They tied, and the later one won.
|
||||||
|
*
|
||||||
|
* So this picks a track *for* the property that broke it, which is
|
||||||
|
* the only way the assertion means anything: the version above passes
|
||||||
|
* on a broken build roughly two runs in three, which is exactly how
|
||||||
|
* it came to cost three CI cycles across two branches that could not
|
||||||
|
* have caused it.
|
||||||
|
*/
|
||||||
|
test('opens the full-screen now playing for a track with no art', async ({
|
||||||
|
app,
|
||||||
|
}) => {
|
||||||
|
// `LONG_TRACK` by name, and not "the first track with no
|
||||||
|
// CoverArt": the *library* model reports that field empty for
|
||||||
|
// every row in this fixture (31 of 31), so filtering on it selects
|
||||||
|
// nothing in particular and picked a 2-second track, which had
|
||||||
|
// finished before the assertions ran. The placeholder check below
|
||||||
|
// is what actually holds the property this test needs.
|
||||||
|
const started = await app.evaluate(async (longTitle) => {
|
||||||
|
const tracks = (await window.__yjEvents.call(
|
||||||
|
'library.Library.GetTracks',
|
||||||
|
[0],
|
||||||
|
10_000,
|
||||||
|
)) as { FilePath: string; TrackName: string }[];
|
||||||
|
|
||||||
|
const bare = tracks.find((t) => t.TrackName === longTitle);
|
||||||
|
|
||||||
|
if (!bare) return null;
|
||||||
|
|
||||||
|
await window.__yjEvents.call(
|
||||||
|
'queue.Queue.SetQueue',
|
||||||
|
[[bare.FilePath], 0, false, { type: '', id: 0, label: '' }],
|
||||||
|
10_000,
|
||||||
|
);
|
||||||
|
await window.__yjEvents.call('queue.Queue.Play', [], 5_000);
|
||||||
|
|
||||||
|
return bare.TrackName;
|
||||||
|
}, LONG_TRACK);
|
||||||
|
|
||||||
|
expect(started).toBe(LONG_TRACK);
|
||||||
|
|
||||||
|
await expect(app.getByTestId('now-playing-title')).not.toBeEmpty();
|
||||||
|
|
||||||
|
// **The placeholder is the whole point**, so it is asserted rather
|
||||||
|
// than assumed: this test is about the thing that renders when
|
||||||
|
// there is no artwork. If the fixture ever gives this album a
|
||||||
|
// cover, this fails and says so instead of passing while measuring
|
||||||
|
// the easy case.
|
||||||
|
//
|
||||||
|
// One selector rather than a chain from the host: Playwright's CSS
|
||||||
|
// engine pierces an open shadow root, and chaining from the host
|
||||||
|
// element does not reach into it.
|
||||||
|
await expect(
|
||||||
|
app.locator('now-playing .cover-placeholder'),
|
||||||
|
).toBeAttached();
|
||||||
|
|
||||||
|
await app.getByTestId('open-now-playing').click();
|
||||||
|
|
||||||
|
await expect(app.getByTestId('main-content'))
|
||||||
|
.toHaveAttribute('data-active-view', 'now-playing');
|
||||||
|
|
||||||
|
await app.getByTestId('npv-back').click();
|
||||||
|
});
|
||||||
|
|
||||||
test('offers no way in on a desktop, where the bar is whole', async ({ app }) => {
|
test('offers no way in on a desktop, where the bar is whole', async ({ app }) => {
|
||||||
await app.setViewportSize({ width: 1440, height: 900 });
|
await app.setViewportSize({ width: 1440, height: 900 });
|
||||||
|
|
||||||
@@ -154,9 +226,26 @@ test.describe('the shell on a phone', () => {
|
|||||||
await expect(app.locator('now-playing')).toBeVisible();
|
await expect(app.locator('now-playing')).toBeVisible();
|
||||||
|
|
||||||
// Volume is the hardware keys' job on a phone, and a 4px seek bar
|
// Volume is the hardware keys' job on a phone, and a 4px seek bar
|
||||||
// is not a thumb target -- both belong to a later phase's
|
// is not a thumb target -- both belong to the full-screen
|
||||||
// full-screen now-playing view.
|
// now-playing view.
|
||||||
await expect(app.locator('audio-player volume-control')).toBeHidden();
|
//
|
||||||
|
// `.bottom-bar volume-control`, not `audio-player volume-control`:
|
||||||
|
// #42 moved the control out of that component and into the bar, and
|
||||||
|
// **the old locator would have kept passing** — `toBeHidden()` is
|
||||||
|
// satisfied by an element that does not exist, so this assertion
|
||||||
|
// would have gone on reporting success about nothing. Its partner
|
||||||
|
// below is what makes this one mean something.
|
||||||
|
await expect(app.locator('.bottom-bar volume-control')).toBeHidden();
|
||||||
|
|
||||||
|
// The element is there and hidden, rather than absent: the check
|
||||||
|
// above cannot tell those apart on its own.
|
||||||
|
await expect(app.locator('.bottom-bar volume-control')).toHaveCount(1);
|
||||||
|
|
||||||
|
// And the seek bar is still inside the transport, where it stands
|
||||||
|
// down by its own media query.
|
||||||
|
await expect(
|
||||||
|
app.locator('audio-player').locator('seek-bar'),
|
||||||
|
).toBeHidden();
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,187 @@
|
|||||||
|
import { test, expect } from '../support/fixtures.js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* #24 — the queue panel does not take the page's width away from it.
|
||||||
|
*
|
||||||
|
* The panel is `flex-shrink: 0` in the flow of `.content-area`, so an
|
||||||
|
* open queue used to be paid for by the main panel. Measured on
|
||||||
|
* Playlists before the fix:
|
||||||
|
*
|
||||||
|
* | viewport | main panel |
|
||||||
|
* |---|---|
|
||||||
|
* | 900×600 | 379px — all three header actions clipped |
|
||||||
|
* | 390×780 | 69px |
|
||||||
|
* | 320×600 | **0px** |
|
||||||
|
*
|
||||||
|
* **900×600 is the worst desktop case, not the 800×600 minimum**, and
|
||||||
|
* that is the trap this file exists to keep closed: the sidebar
|
||||||
|
* collapses to icons *below* 900, so the main panel is 843px at 899 and
|
||||||
|
* 700px at 900. A spec that checks "the minimum" and stops has not
|
||||||
|
* checked the worst case — which is what every viewport list in this
|
||||||
|
* suite did before this.
|
||||||
|
*
|
||||||
|
* These assert the *content's* width rather than the panel's mode
|
||||||
|
* wherever they can, because the mode is the mechanism and the width is
|
||||||
|
* the complaint.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/** The bands from plan 018's size matrix, plus the pixel above the collapse. */
|
||||||
|
const BANDS = [
|
||||||
|
{ name: 'a wide desktop (1280×800)', width: 1280, height: 800, inline: true },
|
||||||
|
{ name: 'the default window (1100×720)', width: 1100, height: 720, inline: true },
|
||||||
|
{ name: 'a laptop (1024×768)', width: 1024, height: 768, inline: true },
|
||||||
|
{ name: 'the worst desktop width (900×600)', width: 900, height: 600, inline: false },
|
||||||
|
{ name: 'the enforced minimum (800×600)', width: 800, height: 600, inline: false },
|
||||||
|
{ name: 'a phone (390×780)', width: 390, height: 780, inline: false },
|
||||||
|
{ name: '400% zoom (320×600)', width: 320, height: 600, inline: false },
|
||||||
|
];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* How much room the content has, and whether the shell needs scrolling
|
||||||
|
* to reach any of itself.
|
||||||
|
*/
|
||||||
|
const shellGeometry = (page: import('@playwright/test').Page) =>
|
||||||
|
page.evaluate(() => {
|
||||||
|
const main = document.querySelector('#main-content')!.getBoundingClientRect();
|
||||||
|
const panel = document.querySelector('#queue-panel')!;
|
||||||
|
|
||||||
|
return {
|
||||||
|
mainWidth: Math.round(main.width),
|
||||||
|
overlay: panel.hasAttribute('overlay'),
|
||||||
|
open: panel.hasAttribute('open'),
|
||||||
|
bodyScrollWidth: document.body.scrollWidth,
|
||||||
|
bodyClientWidth: document.body.clientWidth,
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
async function openQueue(page: import('@playwright/test').Page) {
|
||||||
|
const toggle = page.locator('#queue-button');
|
||||||
|
|
||||||
|
if ((await toggle.getAttribute('aria-expanded')) !== 'true') {
|
||||||
|
await toggle.click();
|
||||||
|
}
|
||||||
|
|
||||||
|
await expect(toggle).toHaveAttribute('aria-expanded', 'true');
|
||||||
|
}
|
||||||
|
|
||||||
|
test.describe('an open queue leaves the content its width', () => {
|
||||||
|
for (const band of BANDS) {
|
||||||
|
test(`at ${band.name}`, async ({ app }) => {
|
||||||
|
await app.setViewportSize({ width: band.width, height: band.height });
|
||||||
|
await openQueue(app);
|
||||||
|
|
||||||
|
// The mode is settled by a ResizeObserver, so poll rather than
|
||||||
|
// read once: a single read races the resize and reports the
|
||||||
|
// previous viewport's answer.
|
||||||
|
await expect
|
||||||
|
.poll(async () => (await shellGeometry(app)).overlay)
|
||||||
|
.toBe(!band.inline);
|
||||||
|
|
||||||
|
const geo = await shellGeometry(app);
|
||||||
|
|
||||||
|
// The floor is the point of the whole issue. Inline, the queue is
|
||||||
|
// affordable and the content keeps the rest; as an overlay the
|
||||||
|
// content keeps *everything*, which is what makes 0px at 320
|
||||||
|
// impossible rather than merely unlikely.
|
||||||
|
expect(geo.mainWidth).toBeGreaterThanOrEqual(320);
|
||||||
|
|
||||||
|
if (!band.inline) {
|
||||||
|
expect(geo.mainWidth).toBeGreaterThanOrEqual(
|
||||||
|
Math.min(band.width, 320),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// And opening the queue must not make the shell overflow.
|
||||||
|
expect(geo.bodyScrollWidth).toBeLessThanOrEqual(geo.bodyClientWidth);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test.describe('an overlaid queue says it is over the content', () => {
|
||||||
|
test.beforeEach(async ({ app }) => {
|
||||||
|
await app.setViewportSize({ width: 900, height: 600 });
|
||||||
|
});
|
||||||
|
|
||||||
|
test('draws a scrim and closes when it is clicked', async ({ app }) => {
|
||||||
|
await openQueue(app);
|
||||||
|
|
||||||
|
const panel = app.locator('#queue-panel');
|
||||||
|
|
||||||
|
await expect(panel).toHaveAttribute('overlay', '');
|
||||||
|
|
||||||
|
// The scrim is `aria-hidden` on purpose — it is a dismissal target,
|
||||||
|
// and the named routes out are the close button and Escape — so it
|
||||||
|
// is located structurally rather than by role.
|
||||||
|
await panel.evaluate((el) =>
|
||||||
|
el.shadowRoot!.querySelector<HTMLElement>('.scrim')!.click(),
|
||||||
|
);
|
||||||
|
|
||||||
|
await expect(app.locator('#queue-button')).toHaveAttribute(
|
||||||
|
'aria-expanded',
|
||||||
|
'false',
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* `getByRole`, not a shadow-root query: this repo has shipped a
|
||||||
|
* nameless control three times, and a drawer with a scrim is exactly
|
||||||
|
* the shape that grows a fourth.
|
||||||
|
*/
|
||||||
|
test('offers a named close button', async ({ app }) => {
|
||||||
|
await openQueue(app);
|
||||||
|
|
||||||
|
const close = app.getByRole('button', { name: 'Close queue' });
|
||||||
|
|
||||||
|
await expect(close).toBeVisible();
|
||||||
|
await close.click();
|
||||||
|
|
||||||
|
await expect(app.locator('#queue-button')).toHaveAttribute(
|
||||||
|
'aria-expanded',
|
||||||
|
'false',
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('closes on Escape and gives focus back to the toggle', async ({
|
||||||
|
app,
|
||||||
|
}) => {
|
||||||
|
const toggle = app.locator('#queue-button');
|
||||||
|
|
||||||
|
await toggle.focus();
|
||||||
|
await toggle.click();
|
||||||
|
await expect(toggle).toHaveAttribute('aria-expanded', 'true');
|
||||||
|
|
||||||
|
await app.keyboard.press('Escape');
|
||||||
|
|
||||||
|
await expect(toggle).toHaveAttribute('aria-expanded', 'false');
|
||||||
|
await expect(toggle).toBeFocused();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The inline panel is the mode that already worked, and the one every
|
||||||
|
* other queue spec is written against. It keeps its resize handle and
|
||||||
|
* gains none of the overlay's chrome.
|
||||||
|
*/
|
||||||
|
test.describe('a wide window keeps the queue beside the content', () => {
|
||||||
|
test('no scrim, no close button, and the content is narrower', async ({
|
||||||
|
app,
|
||||||
|
}) => {
|
||||||
|
await app.setViewportSize({ width: 1280, height: 800 });
|
||||||
|
|
||||||
|
const widthWithoutQueue = (await shellGeometry(app)).mainWidth;
|
||||||
|
|
||||||
|
await openQueue(app);
|
||||||
|
|
||||||
|
await expect(app.locator('#queue-panel')).not.toHaveAttribute(
|
||||||
|
'overlay',
|
||||||
|
'',
|
||||||
|
);
|
||||||
|
|
||||||
|
const geo = await shellGeometry(app);
|
||||||
|
|
||||||
|
expect(geo.mainWidth).toBeLessThan(widthWithoutQueue);
|
||||||
|
await expect(
|
||||||
|
app.getByRole('button', { name: 'Close queue' }),
|
||||||
|
).toHaveCount(0);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,299 @@
|
|||||||
|
import {
|
||||||
|
test,
|
||||||
|
expect,
|
||||||
|
callBinding,
|
||||||
|
navigateTo,
|
||||||
|
LONG_TRACK,
|
||||||
|
NO_QUEUE_SOURCE,
|
||||||
|
} from '../support/fixtures.js';
|
||||||
|
import type { Page } from '@playwright/test';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The queue panel's mouse model (#43): single click selects, ctrl and
|
||||||
|
* shift extend, double click plays from that row.
|
||||||
|
*
|
||||||
|
* **All four already worked, and nothing pinned any of them** — which is
|
||||||
|
* the whole reason the report could be made and could not be settled.
|
||||||
|
* `queue-reorder.spec.ts` covers the keyboard, `queue-overlay.spec.ts`
|
||||||
|
* covers the panel's mode, and the component tier has the reorder
|
||||||
|
* arithmetic; the pointer path had no coverage in either tier, so
|
||||||
|
* "selection is broken here" and "selection is fine here" were equally
|
||||||
|
* consistent with a green suite.
|
||||||
|
*
|
||||||
|
* Two things this spec is deliberately shaped around.
|
||||||
|
*
|
||||||
|
* **The clicks are real.** A `dispatchEvent(new MouseEvent('click'))`
|
||||||
|
* on a row exercises the delegated handler and *not* the question being
|
||||||
|
* asked, which is what the pointer lands on: the rows carry
|
||||||
|
* `explore-link` names that take their own clicks, and a synthetic
|
||||||
|
* event aimed at the row reports a selection the mouse would never have
|
||||||
|
* produced. Every click here goes through Playwright.
|
||||||
|
*
|
||||||
|
* **The playing assertions use the 90-second fixture.** Every other
|
||||||
|
* track is 2–6 seconds, so "double click plays row 3" read against a
|
||||||
|
* 2-second track reports whatever auto-advance moved on to — measured
|
||||||
|
* during this work as row 3 double-clicked and row 4 playing, which
|
||||||
|
* reads exactly like an off-by-one in `PlayIndex` and is not one.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* How long a click may take to show up as a highlight.
|
||||||
|
*
|
||||||
|
* **A poll with the default 5s timeout cannot see this defect**, and
|
||||||
|
* that is the point of naming it. `queue-panel` repaints its rows two
|
||||||
|
* ways — `onSelectionChanged()` calls `virtualizer.requestUpdate()`,
|
||||||
|
* and `.keyFunction` is a per-render arrow, which is itself a changed
|
||||||
|
* property the virtualizer reacts to. With **both** removed the
|
||||||
|
* highlight still arrives, on whatever unrelated render happens next:
|
||||||
|
* measured at 134ms, 3,866ms and 5,816ms for three clicks, against
|
||||||
|
* 5ms, 16ms and 17ms on a healthy build.
|
||||||
|
*
|
||||||
|
* A user cannot tell "four seconds late" from "broken", which is very
|
||||||
|
* close to what this issue reports. So the assertion is that the
|
||||||
|
* highlight is *prompt*, with a bound ~30x the measured healthy case
|
||||||
|
* and an order of magnitude under the degraded one.
|
||||||
|
*/
|
||||||
|
const HIGHLIGHT_MS = 500;
|
||||||
|
|
||||||
|
/** The queue's own answer, never the DOM's. */
|
||||||
|
async function playing(app: Page): Promise<{ index: number; title: string }> {
|
||||||
|
const state = await callBinding<{
|
||||||
|
currentIndex: number;
|
||||||
|
tracks: { title: string }[];
|
||||||
|
}>(app, 'queue.Queue.GetState');
|
||||||
|
|
||||||
|
return {
|
||||||
|
index: state.currentIndex,
|
||||||
|
title: state.tracks[state.currentIndex]?.title ?? '',
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Which rows are selected, as the accessibility tree sees it. */
|
||||||
|
const selected = (app: Page) =>
|
||||||
|
app.evaluate(() =>
|
||||||
|
[
|
||||||
|
...document
|
||||||
|
.querySelector('queue-panel')!
|
||||||
|
.shadowRoot!.querySelectorAll('[data-index]'),
|
||||||
|
]
|
||||||
|
.filter((row) => row.getAttribute('aria-selected') === 'true')
|
||||||
|
.map((row) => Number((row as HTMLElement).dataset['index'])),
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Six tracks with the long one in the middle, so a "play from here"
|
||||||
|
* assertion has something to land on that will still be playing when it
|
||||||
|
* is read back.
|
||||||
|
*/
|
||||||
|
async function queueSixAndOpen(app: Page): Promise<void> {
|
||||||
|
const paths = await app.evaluate(async (longTitle) => {
|
||||||
|
// `TrackName`, not `Title`: the library model names it after the
|
||||||
|
// tag, and the *queue* is what calls it `title`.
|
||||||
|
const tracks = (await window.__yjEvents.call(
|
||||||
|
'library.Library.GetTracks',
|
||||||
|
[0],
|
||||||
|
10_000,
|
||||||
|
)) as { FilePath: string; TrackName: string; Album: string }[];
|
||||||
|
|
||||||
|
const long = tracks.find((t) => t.TrackName === longTitle);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* **Tracks that have an album**, which is a requirement of one of
|
||||||
|
* the tests and was previously left to luck (#156).
|
||||||
|
*
|
||||||
|
* `explore-link` routes a track name to its *album's* page, so a
|
||||||
|
* track with no album renders a name that navigates nowhere — and
|
||||||
|
* the fixture library deliberately contains two (`01 Tone A`,
|
||||||
|
* `02 Tone B`). Which tracks arrive first is `audio_files.id`
|
||||||
|
* order, i.e. the order the **scan** inserted them, which depends
|
||||||
|
* on concurrency and directory traversal: locally the first eight
|
||||||
|
* all had albums and the spec passed twice over, and CI rebuilds
|
||||||
|
* its seed with a real scan and got a different eight.
|
||||||
|
*
|
||||||
|
* Asking for what the test needs is the fix. It is not a
|
||||||
|
* narrowing: every assertion here wants an ordinary track, and
|
||||||
|
* "the first five rows" was never a way to ask for one in a
|
||||||
|
* library whose whole purpose is edge cases.
|
||||||
|
*/
|
||||||
|
const rest = tracks
|
||||||
|
.filter((t) => t.TrackName !== longTitle && t.Album !== '')
|
||||||
|
.slice(0, 5);
|
||||||
|
|
||||||
|
// Index 3 is the long one: far enough down that a shift-extend has
|
||||||
|
// room either side of it.
|
||||||
|
return [
|
||||||
|
...rest.slice(0, 3).map((t) => t.FilePath),
|
||||||
|
long!.FilePath,
|
||||||
|
...rest.slice(3).map((t) => t.FilePath),
|
||||||
|
];
|
||||||
|
}, LONG_TRACK);
|
||||||
|
|
||||||
|
await callBinding(app, 'queue.Queue.SetQueue', [
|
||||||
|
paths,
|
||||||
|
0,
|
||||||
|
false,
|
||||||
|
NO_QUEUE_SOURCE,
|
||||||
|
]);
|
||||||
|
|
||||||
|
// A closed panel renders no list at all.
|
||||||
|
await app.locator('#queue-button').click();
|
||||||
|
await expect(app.locator('queue-panel .track-item').first()).toBeVisible();
|
||||||
|
await expect(app.locator('queue-panel .track-item')).toHaveCount(6);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The row at a data-index, not the nth child: see the note in the file. */
|
||||||
|
const row = (app: Page, index: number) =>
|
||||||
|
app.locator(`queue-panel .track-item[data-index="${index}"]`);
|
||||||
|
|
||||||
|
test.describe('selecting in the queue with a mouse', () => {
|
||||||
|
// The suite shares one backend in file order, and a queue and an open
|
||||||
|
// panel both outlive the page. `queue-reorder.spec.ts` sets the
|
||||||
|
// precedent and the reason: a spec that spends state fails the next
|
||||||
|
// one, in a list that reads like a regression in whatever you hold.
|
||||||
|
test.afterEach(async ({ app }) => {
|
||||||
|
await callBinding(app, 'queue.Queue.Clear').catch(() => {
|
||||||
|
/* an empty queue is the state we were asking for */
|
||||||
|
});
|
||||||
|
|
||||||
|
const open = await app.locator('queue-panel[open]').count();
|
||||||
|
|
||||||
|
if (open > 0) await app.locator('#queue-button').click();
|
||||||
|
});
|
||||||
|
|
||||||
|
test('a single click selects that row and only that row', async ({ app }) => {
|
||||||
|
await queueSixAndOpen(app);
|
||||||
|
|
||||||
|
await row(app, 1).click();
|
||||||
|
await expect
|
||||||
|
.poll(() => selected(app), { timeout: HIGHLIGHT_MS })
|
||||||
|
.toEqual([1]);
|
||||||
|
|
||||||
|
// And it *replaces* rather than accumulating, which is the half a
|
||||||
|
// test of one click cannot see.
|
||||||
|
await row(app, 4).click();
|
||||||
|
await expect
|
||||||
|
.poll(() => selected(app), { timeout: HIGHLIGHT_MS })
|
||||||
|
.toEqual([4]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('ctrl adds a row and shift extends a range', async ({ app }) => {
|
||||||
|
await queueSixAndOpen(app);
|
||||||
|
|
||||||
|
await row(app, 1).click();
|
||||||
|
await row(app, 3).click({ modifiers: ['Control'] });
|
||||||
|
await expect
|
||||||
|
.poll(() => selected(app), { timeout: HIGHLIGHT_MS })
|
||||||
|
.toEqual([1, 3]);
|
||||||
|
|
||||||
|
// From the last row touched, so 3→5, keeping the ctrl-picked 1.
|
||||||
|
await row(app, 5).click({ modifiers: ['Shift'] });
|
||||||
|
await expect
|
||||||
|
.poll(() => selected(app), { timeout: HIGHLIGHT_MS })
|
||||||
|
.toEqual([1, 3, 4, 5]);
|
||||||
|
|
||||||
|
// A plain click collapses the whole thing back to one.
|
||||||
|
await row(app, 2).click();
|
||||||
|
await expect
|
||||||
|
.poll(() => selected(app), { timeout: HIGHLIGHT_MS })
|
||||||
|
.toEqual([2]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('a double click plays from that row', async ({ app }) => {
|
||||||
|
await queueSixAndOpen(app);
|
||||||
|
|
||||||
|
// Row 3 is the 90-second track. Asked of the backend, because the
|
||||||
|
// panel's own highlight is a different claim.
|
||||||
|
await row(app, 3).dblclick();
|
||||||
|
|
||||||
|
await expect.poll(() => playing(app)).toEqual({
|
||||||
|
index: 3,
|
||||||
|
title: LONG_TRACK,
|
||||||
|
});
|
||||||
|
|
||||||
|
// Playing is not selecting: the double click clears the selection
|
||||||
|
// it made on the way through, or every play leaves a row looking
|
||||||
|
// picked out for an action the user did not ask for.
|
||||||
|
await expect.poll(() => selected(app)).toEqual([]);
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The one collision the report is actually about.
|
||||||
|
*
|
||||||
|
* Every track, album and artist name in the app navigates
|
||||||
|
* (`utils/explore-link.ts`), and it does that by **stopping the
|
||||||
|
* click's propagation** — in its own words, "the row must not also
|
||||||
|
* treat it as a selection". So a click that lands on the name text
|
||||||
|
* navigates and selects nothing, in the queue panel and in the track
|
||||||
|
* list alike.
|
||||||
|
*
|
||||||
|
* That is deliberate and it is pinned here rather than argued with,
|
||||||
|
* because the measurement says the queue is not the surface where it
|
||||||
|
* hurts: a horizontal hit-scan of a row at three heights makes the
|
||||||
|
* queue row **12%** link and the track list's row **21%** — the panel
|
||||||
|
* the report calls broken is *less* covered by links than the list it
|
||||||
|
* calls correct. What is left is one deliberate exception, and a
|
||||||
|
* change to it should have to fail a test.
|
||||||
|
*/
|
||||||
|
test('a click on a name navigates instead, and that is the exception', async ({
|
||||||
|
app,
|
||||||
|
}) => {
|
||||||
|
await queueSixAndOpen(app);
|
||||||
|
|
||||||
|
await row(app, 1).click();
|
||||||
|
await expect
|
||||||
|
.poll(() => selected(app), { timeout: HIGHLIGHT_MS })
|
||||||
|
.toEqual([1]);
|
||||||
|
|
||||||
|
// `.track-title .explore-link`, not `.explore-link` first(): a row
|
||||||
|
// has two, and which one `first()` finds depends on whether the
|
||||||
|
// *title* is a link at all. It is not, for a track with no album —
|
||||||
|
// `explore-link` renders plain text where it cannot route — so the
|
||||||
|
// loose locator silently clicked the **artist** instead and the
|
||||||
|
// assertion below was about a different destination than the one
|
||||||
|
// being exercised (#156).
|
||||||
|
await row(app, 2).locator('.track-title .explore-link').click();
|
||||||
|
|
||||||
|
await expect(app.getByTestId('main-content')).toHaveAttribute(
|
||||||
|
'data-active-view',
|
||||||
|
'explore-album-details',
|
||||||
|
);
|
||||||
|
|
||||||
|
// Row 2 did not join the selection — the link took the click.
|
||||||
|
await expect.poll(() => selected(app)).toEqual([1]);
|
||||||
|
|
||||||
|
await navigateTo(app, 'tracks');
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* And the other half of that bargain: the link holds its navigation
|
||||||
|
* for one double-click interval and drops it if a second click
|
||||||
|
* arrives, so double-clicking a *name* still plays the row rather
|
||||||
|
* than navigating away from it. That is what makes the exception
|
||||||
|
* above survivable, and it is the part most likely to break silently
|
||||||
|
* if the grace interval is ever removed.
|
||||||
|
*/
|
||||||
|
test('a double click on a name plays rather than navigating', async ({
|
||||||
|
app,
|
||||||
|
}) => {
|
||||||
|
await queueSixAndOpen(app);
|
||||||
|
|
||||||
|
// Read rather than assumed: which view the app lands on is the
|
||||||
|
// user's `DefaultPage`, so naming one here would be asserting on a
|
||||||
|
// config value in a test about a double click.
|
||||||
|
const before = await app
|
||||||
|
.getByTestId('main-content')
|
||||||
|
.getAttribute('data-active-view');
|
||||||
|
|
||||||
|
await row(app, 3).locator('.explore-link').first().dblclick();
|
||||||
|
|
||||||
|
await expect.poll(() => playing(app)).toEqual({
|
||||||
|
index: 3,
|
||||||
|
title: LONG_TRACK,
|
||||||
|
});
|
||||||
|
|
||||||
|
await expect(app.getByTestId('main-content')).toHaveAttribute(
|
||||||
|
'data-active-view',
|
||||||
|
before!,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
import { test, expect } from '../support/fixtures.js';
|
import { test, expect, navigateTo } from '../support/fixtures.js';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Plan 007 phase 5: a11y.1 and a11y.2, frozen against the real app.
|
* Plan 007 phase 5: a11y.1 and a11y.2, frozen against the real app.
|
||||||
@@ -18,16 +18,19 @@ test.describe('Settings is reachable without a mouse', () => {
|
|||||||
}) => {
|
}) => {
|
||||||
await app.getByTestId('nav-settings').click();
|
await app.getByTestId('nav-settings').click();
|
||||||
|
|
||||||
const headers = app.locator('config-page config-section .header');
|
// Per *section*, not per `.header`: a section holding a
|
||||||
|
// `job-panel` (#27) also contains `job-details-drawer`, whose own
|
||||||
|
// header carries that class and is not a disclosure.
|
||||||
|
const sections = app.locator('config-page config-section');
|
||||||
|
|
||||||
await expect(headers.first()).toBeVisible();
|
await expect(sections.first()).toBeVisible();
|
||||||
|
|
||||||
const count = await headers.count();
|
const count = await sections.count();
|
||||||
|
|
||||||
expect(count).toBeGreaterThan(4);
|
expect(count).toBeGreaterThan(4);
|
||||||
|
|
||||||
for (let i = 0; i < count; i++) {
|
for (let i = 0; i < count; i++) {
|
||||||
const header = headers.nth(i);
|
const header = sections.nth(i).locator('.header').first();
|
||||||
|
|
||||||
expect(await header.evaluate((el) => el.tagName)).toBe('BUTTON');
|
expect(await header.evaluate((el) => el.tagName)).toBe('BUTTON');
|
||||||
expect(['true', 'false']).toContain(
|
expect(['true', 'false']).toContain(
|
||||||
@@ -56,7 +59,9 @@ test.describe('Settings is reachable without a mouse', () => {
|
|||||||
|
|
||||||
test.describe("Downloads' tabs are tabs", () => {
|
test.describe("Downloads' tabs are tabs", () => {
|
||||||
test('arrow keys move the selection and swap the panel', async ({ app }) => {
|
test('arrow keys move the selection and swap the panel', async ({ app }) => {
|
||||||
await app.getByTestId('nav-downloads').click();
|
// By event, not by nav item: with no download client configured
|
||||||
|
// there is no Downloads destination to click (#25).
|
||||||
|
await navigateTo(app, 'downloads');
|
||||||
|
|
||||||
const view = app.locator('downloads-view');
|
const view = app.locator('downloads-view');
|
||||||
const requests = view.getByRole('tab', { name: 'Requests' });
|
const requests = view.getByRole('tab', { name: 'Requests' });
|
||||||
|
|||||||
@@ -0,0 +1,207 @@
|
|||||||
|
import { test, expect } from '../support/fixtures.js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The top bar fits the window it is in (#143).
|
||||||
|
*
|
||||||
|
* **This is measured per child, not on the shell**, which is #69's
|
||||||
|
* lesson repeated one component over: `layout-overflow.spec.ts` asserts
|
||||||
|
* the *document* needs no sideways scrolling, and clipping inside a
|
||||||
|
* component is invisible to it — which is exactly why that spec was
|
||||||
|
* green throughout this defect. What a user sees is a control rendered
|
||||||
|
* past the edge of the bar it belongs to, so that is what is asserted.
|
||||||
|
*
|
||||||
|
* **And it is measured with a job running**, which is the half the
|
||||||
|
* original report missed. `job-indicator` is `hidden` while idle and up
|
||||||
|
* to 235px wide when it is not, so the bar was 611px inside 600 sitting
|
||||||
|
* still and 862px during a scan — 171 to 262px of overflow, arriving
|
||||||
|
* exactly when a user has reason to look at that bar. Nothing else in
|
||||||
|
* this suite has ever measured a layout with work in flight;
|
||||||
|
* `/__test/emit` stages it without staging the scan.
|
||||||
|
*/
|
||||||
|
type Page = import('@playwright/test').Page;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The widths this asks about.
|
||||||
|
*
|
||||||
|
* 600 is the bottom of the Compact band (#24) and where the defect
|
||||||
|
* lands; 899 and 900 straddle `nav-history` appearing (68px more to
|
||||||
|
* find, at the width that just gained the sidebar's labels); 800 is the
|
||||||
|
* enforced minimum; 390 is a phone, where the answer must be that
|
||||||
|
* nothing collapses because the media queries already did the work.
|
||||||
|
*/
|
||||||
|
const WIDTHS = [390, 600, 800, 899, 900, 1440];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A scan whose title is as long as a real one gets. The label is capped
|
||||||
|
* at 12rem by the component, so this is the widest the indicator can
|
||||||
|
* be — measuring with "Scanning" instead reports a bar that fits and a
|
||||||
|
* defect that is 100px smaller than it is.
|
||||||
|
*/
|
||||||
|
const LONG_JOB = {
|
||||||
|
id: 'top-bar-fit',
|
||||||
|
kind: 'library-scan',
|
||||||
|
state: 'running',
|
||||||
|
title: 'Scanning Music from the external drive',
|
||||||
|
current: 40,
|
||||||
|
total: 100,
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Every child's right edge against the bar's own content box.
|
||||||
|
*
|
||||||
|
* The content box, not `clientWidth`: the bar has a 2em right gutter,
|
||||||
|
* and a control sitting in the padding is already the failure — it is
|
||||||
|
* simply one that `scrollWidth` under-reports, because `scrollWidth`
|
||||||
|
* counts the left padding and not the right.
|
||||||
|
*/
|
||||||
|
const overflowingChildren = (page: Page) =>
|
||||||
|
page.evaluate(() => {
|
||||||
|
const bar = document.querySelector<HTMLElement>('header.top-bar')!;
|
||||||
|
const style = getComputedStyle(bar);
|
||||||
|
const box = bar.getBoundingClientRect();
|
||||||
|
const left = box.left + parseFloat(style.paddingLeft);
|
||||||
|
const right = box.right - parseFloat(style.paddingRight);
|
||||||
|
|
||||||
|
return [...bar.children]
|
||||||
|
.filter((child) => {
|
||||||
|
const cs = getComputedStyle(child);
|
||||||
|
|
||||||
|
// Out of flow is out of the question: a collapsed wordmark is
|
||||||
|
// `position: absolute` and 1px wide precisely so it costs the
|
||||||
|
// row nothing.
|
||||||
|
if (cs.display === 'none' || cs.position === 'absolute') return false;
|
||||||
|
|
||||||
|
const r = child.getBoundingClientRect();
|
||||||
|
|
||||||
|
return r.width > 0 && (r.right > right + 0.5 || r.left < left - 0.5);
|
||||||
|
})
|
||||||
|
.map((child) => {
|
||||||
|
const r = child.getBoundingClientRect();
|
||||||
|
|
||||||
|
return `${child.tagName.toLowerCase()}: ${Math.round(r.left)}..${Math.round(r.right)} outside ${Math.round(left)}..${Math.round(right)}`;
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
/** What the fit pass gave up, read back off the DOM it changed. */
|
||||||
|
const collapsed = (page: Page) =>
|
||||||
|
page.evaluate(() => ({
|
||||||
|
wordmark: !!document.querySelector('header.top-bar hgroup.yj-collapsed'),
|
||||||
|
jobLabel: !!document.querySelector('job-indicator[compact]'),
|
||||||
|
}));
|
||||||
|
|
||||||
|
test.describe('the top bar fits the window', () => {
|
||||||
|
for (const width of WIDTHS) {
|
||||||
|
test(`no control sits outside the bar at ${width}px, idle`, async ({
|
||||||
|
app,
|
||||||
|
}) => {
|
||||||
|
await app.setViewportSize({ width, height: 600 });
|
||||||
|
|
||||||
|
await expect.poll(() => overflowingChildren(app)).toEqual([]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test(`no control sits outside the bar at ${width}px, with a job running`, async ({
|
||||||
|
app,
|
||||||
|
testctl,
|
||||||
|
}) => {
|
||||||
|
await app.setViewportSize({ width, height: 600 });
|
||||||
|
await testctl.emit('JobsChanged', [LONG_JOB]);
|
||||||
|
|
||||||
|
// The indicator has to actually be up, or this test passes by
|
||||||
|
// measuring the idle case under another name.
|
||||||
|
await expect(app.locator('job-indicator')).toBeVisible();
|
||||||
|
|
||||||
|
await expect.poll(() => overflowingChildren(app)).toEqual([]);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The other half of "measured, never breakpointed": a rule that
|
||||||
|
* collapses defensively at every narrow width fits just as well and
|
||||||
|
* is a worse app. 1440 is roomy at any job title; 899 was measured to
|
||||||
|
* fit with the longest one, because `nav-history` is not there yet.
|
||||||
|
*/
|
||||||
|
test('nothing is given up where there is room for it', async ({
|
||||||
|
app,
|
||||||
|
testctl,
|
||||||
|
}) => {
|
||||||
|
await app.setViewportSize({ width: 1440, height: 900 });
|
||||||
|
await testctl.emit('JobsChanged', [LONG_JOB]);
|
||||||
|
await expect(app.locator('job-indicator')).toBeVisible();
|
||||||
|
|
||||||
|
await expect.poll(() => collapsed(app)).toEqual({
|
||||||
|
wordmark: false,
|
||||||
|
jobLabel: false,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* And it gives them back. The pass starts from all-visible every
|
||||||
|
* time, so this is the property that a rule which only ever *added*
|
||||||
|
* to the collapsed set would fail — the wordmark would be gone for
|
||||||
|
* the rest of the session after one narrow moment.
|
||||||
|
*/
|
||||||
|
test('the wordmark comes back when the window does', async ({
|
||||||
|
app,
|
||||||
|
testctl,
|
||||||
|
}) => {
|
||||||
|
await testctl.emit('JobsChanged', [LONG_JOB]);
|
||||||
|
await app.setViewportSize({ width: 600, height: 600 });
|
||||||
|
|
||||||
|
await expect.poll(() => collapsed(app)).toEqual({
|
||||||
|
wordmark: true,
|
||||||
|
jobLabel: true,
|
||||||
|
});
|
||||||
|
|
||||||
|
await app.setViewportSize({ width: 1440, height: 900 });
|
||||||
|
|
||||||
|
await expect.poll(() => collapsed(app)).toEqual({
|
||||||
|
wordmark: false,
|
||||||
|
jobLabel: false,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The wordmark yields its width and not its existence: `display:
|
||||||
|
* none` would take the document from one top-level heading to none.
|
||||||
|
*/
|
||||||
|
test('the collapsed wordmark is still the document heading', async ({
|
||||||
|
app,
|
||||||
|
testctl,
|
||||||
|
}) => {
|
||||||
|
await testctl.emit('JobsChanged', [LONG_JOB]);
|
||||||
|
await app.setViewportSize({ width: 600, height: 600 });
|
||||||
|
|
||||||
|
await expect.poll(() => collapsed(app)).toMatchObject({ wordmark: true });
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
app.getByRole('heading', { name: 'YellowJacket', level: 1 }),
|
||||||
|
).toHaveCount(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* And the indicator keeps saying what it is doing after its visible
|
||||||
|
* label goes — the `sr-only` live region is what announces the state,
|
||||||
|
* which is the same argument the phone's own rule was written on.
|
||||||
|
*/
|
||||||
|
test('the job indicator still announces its state without its label', async ({
|
||||||
|
app,
|
||||||
|
testctl,
|
||||||
|
}) => {
|
||||||
|
await testctl.emit('JobsChanged', [LONG_JOB]);
|
||||||
|
await app.setViewportSize({ width: 600, height: 600 });
|
||||||
|
|
||||||
|
await expect.poll(() => collapsed(app)).toMatchObject({ jobLabel: true });
|
||||||
|
|
||||||
|
const spoken = await app
|
||||||
|
.locator('job-indicator')
|
||||||
|
.evaluate(
|
||||||
|
(el) =>
|
||||||
|
el.shadowRoot?.querySelector('[aria-live]')?.textContent?.trim() ?? '',
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(spoken).toContain('Scanning Music from the external drive');
|
||||||
|
|
||||||
|
// Leave the app as the next spec expects to find it.
|
||||||
|
await app.setViewportSize({ width: 1440, height: 900 });
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -4,6 +4,7 @@ import {
|
|||||||
eventNames,
|
eventNames,
|
||||||
resetEvents,
|
resetEvents,
|
||||||
waitForEvent,
|
waitForEvent,
|
||||||
|
navigateTo,
|
||||||
} from '../support/fixtures.js';
|
} from '../support/fixtures.js';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -39,7 +40,9 @@ test.describe('view lifecycle', () => {
|
|||||||
test('a keypress on Settings does not reach the Autotag queue', async ({
|
test('a keypress on Settings does not reach the Autotag queue', async ({
|
||||||
app,
|
app,
|
||||||
}) => {
|
}) => {
|
||||||
await app.getByTestId('nav-autotag').click();
|
// By event, not by nav item: Autotag is hidden by default (#25)
|
||||||
|
// and a hidden view is still reachable.
|
||||||
|
await navigateTo(app, 'autotag');
|
||||||
await expect(app.getByTestId('main-content')).toHaveAttribute(
|
await expect(app.getByTestId('main-content')).toHaveAttribute(
|
||||||
'data-active-view',
|
'data-active-view',
|
||||||
'autotag',
|
'autotag',
|
||||||
@@ -83,7 +86,9 @@ test.describe('view lifecycle', () => {
|
|||||||
// The other half of the same bug (H-2): two document keydown handlers
|
// The other half of the same bug (H-2): two document keydown handlers
|
||||||
// with no arbitration meant `s` on this page skipped the album *and*
|
// with no arbitration meant `s` on this page skipped the album *and*
|
||||||
// toggled shuffle. As a panel binding it can only mean one thing.
|
// toggled shuffle. As a panel binding it can only mean one thing.
|
||||||
await app.getByTestId('nav-autotag').click();
|
// By event, not by nav item: Autotag is hidden by default (#25)
|
||||||
|
// and a hidden view is still reachable.
|
||||||
|
await navigateTo(app, 'autotag');
|
||||||
await expect
|
await expect
|
||||||
.poll(() => pendingCount(app))
|
.poll(() => pendingCount(app))
|
||||||
.toMatch(/^Pending \(\d+\)$/);
|
.toMatch(/^Pending \(\d+\)$/);
|
||||||
|
|||||||
@@ -0,0 +1,116 @@
|
|||||||
|
import { test, expect, navigateTo } from '../support/fixtures.js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Which destinations the navigation offers (#25).
|
||||||
|
*
|
||||||
|
* Eleven sidebar entries is more than most libraries need, so they are
|
||||||
|
* individually toggleable from Settings, Autotag is off until asked for
|
||||||
|
* and Downloads is absent until there is a client to download with.
|
||||||
|
*
|
||||||
|
* **The assertions are about the navigation, not about the setting.**
|
||||||
|
* "The config was saved" is the plumbing, and the two most recent bugs
|
||||||
|
* in this area — #69 and #72 — both shipped green under specs that
|
||||||
|
* measured exactly that. What a person sees is whether the item is in
|
||||||
|
* the accessibility tree, and whether the view is still reachable when
|
||||||
|
* it is not.
|
||||||
|
*
|
||||||
|
* This runs against the seeded app, whose config is defaults and whose
|
||||||
|
* download client list is empty, so the initial state below is what a
|
||||||
|
* fresh install looks like.
|
||||||
|
*/
|
||||||
|
type Page = import('@playwright/test').Page;
|
||||||
|
|
||||||
|
const navItem = (page: Page, label: string) =>
|
||||||
|
page.getByRole('button', { name: label, exact: true });
|
||||||
|
|
||||||
|
/** The Navigation section's checkbox for a destination. */
|
||||||
|
const viewToggle = (page: Page, label: string) =>
|
||||||
|
page.getByRole('checkbox', { name: `Show ${label} in the navigation` });
|
||||||
|
|
||||||
|
async function openNavigationSettings(page: Page): Promise<void> {
|
||||||
|
await page.getByTestId('nav-settings').click();
|
||||||
|
|
||||||
|
const section = page.locator(
|
||||||
|
'config-page config-section[heading="Navigation"] .header',
|
||||||
|
);
|
||||||
|
|
||||||
|
await expect(section).toBeVisible();
|
||||||
|
|
||||||
|
if ((await section.getAttribute('aria-expanded')) === 'false') {
|
||||||
|
await section.click();
|
||||||
|
}
|
||||||
|
|
||||||
|
await expect(section).toHaveAttribute('aria-expanded', 'true');
|
||||||
|
}
|
||||||
|
|
||||||
|
test.describe('configurable destinations', () => {
|
||||||
|
test('Autotag is off by default and Downloads needs a client', async ({
|
||||||
|
app,
|
||||||
|
}) => {
|
||||||
|
await expect(app.getByTestId('nav-home')).toBeVisible();
|
||||||
|
|
||||||
|
await expect(app.getByTestId('nav-autotag')).toHaveCount(0);
|
||||||
|
await expect(app.getByTestId('nav-downloads')).toHaveCount(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Hiding takes the item away and nothing else. Detail views navigate
|
||||||
|
* into these and the launch page is one of them, so a destination
|
||||||
|
* with no nav item still has to open.
|
||||||
|
*/
|
||||||
|
test('a hidden destination is still reachable', async ({ app }) => {
|
||||||
|
await navigateTo(app, 'autotag');
|
||||||
|
|
||||||
|
await expect(app.getByTestId('main-content')).toHaveAttribute(
|
||||||
|
'data-active-view',
|
||||||
|
'autotag',
|
||||||
|
);
|
||||||
|
|
||||||
|
// And nothing is falsely lit while standing on it -- the same rule
|
||||||
|
// a detail view follows, with no special case for either.
|
||||||
|
await expect(navItem(app, 'Home')).toHaveAttribute('aria-current', 'false');
|
||||||
|
});
|
||||||
|
|
||||||
|
test('switching Autotag on adds it to the sidebar', async ({ app }) => {
|
||||||
|
await openNavigationSettings(app);
|
||||||
|
|
||||||
|
await viewToggle(app, 'Autotag').check();
|
||||||
|
|
||||||
|
await expect(app.getByTestId('nav-autotag')).toBeVisible();
|
||||||
|
|
||||||
|
// Clicking it is the point of having it.
|
||||||
|
await app.getByTestId('nav-autotag').click();
|
||||||
|
await expect(app.getByTestId('main-content')).toHaveAttribute(
|
||||||
|
'data-active-view',
|
||||||
|
'autotag',
|
||||||
|
);
|
||||||
|
|
||||||
|
// Put it back, or the next spec against this app sees a library
|
||||||
|
// this one changed.
|
||||||
|
await openNavigationSettings(app);
|
||||||
|
await viewToggle(app, 'Autotag').uncheck();
|
||||||
|
await expect(app.getByTestId('nav-autotag')).toHaveCount(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Settings has no toggle at all, rather than a toggle that refuses:
|
||||||
|
* a user who hides it cannot get back to unhide it. The backend
|
||||||
|
* refuses it too, because `config.toml` is hand-editable.
|
||||||
|
*/
|
||||||
|
test('Settings cannot be switched off', async ({ app }) => {
|
||||||
|
await openNavigationSettings(app);
|
||||||
|
|
||||||
|
await expect(viewToggle(app, 'Settings')).toBeDisabled();
|
||||||
|
await expect(app.getByTestId('nav-settings')).toBeVisible();
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The launch page is refused while it is the launch page, which is a
|
||||||
|
* state the user can leave by changing the launch page above it.
|
||||||
|
*/
|
||||||
|
test('the launch page cannot be switched off', async ({ app }) => {
|
||||||
|
await openNavigationSettings(app);
|
||||||
|
|
||||||
|
await expect(viewToggle(app, 'Home')).toBeDisabled();
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -111,6 +111,35 @@ export async function bindingCalls(page: Page): Promise<string[]> {
|
|||||||
return calls.map(nameOf);
|
return calls.map(nameOf);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Go to a view without going through the navigation.
|
||||||
|
*
|
||||||
|
* `navigate` is the event the shell listens for and every nav item, card
|
||||||
|
* and detail view dispatches, so this is the app's own mechanism rather
|
||||||
|
* than a test-only door. It exists because a destination is not
|
||||||
|
* guaranteed to have a nav item any more (#25): Autotag is hidden until
|
||||||
|
* the user asks for it and Downloads until a client exists, and a spec
|
||||||
|
* about what a *view* does should not also be asserting that the
|
||||||
|
* sidebar offers it.
|
||||||
|
*/
|
||||||
|
export async function navigateTo(page: Page, view: string): Promise<void> {
|
||||||
|
await page.evaluate(
|
||||||
|
(v) =>
|
||||||
|
void document.dispatchEvent(
|
||||||
|
new CustomEvent('navigate', {
|
||||||
|
detail: { view: v },
|
||||||
|
bubbles: true,
|
||||||
|
composed: true,
|
||||||
|
}),
|
||||||
|
),
|
||||||
|
view,
|
||||||
|
);
|
||||||
|
|
||||||
|
await page
|
||||||
|
.getByTestId('main-content')
|
||||||
|
.waitFor({ state: 'attached' });
|
||||||
|
}
|
||||||
|
|
||||||
/** Thin client for the dev-only /__test/ surface (backend/testctl). */
|
/** Thin client for the dev-only /__test/ surface (backend/testctl). */
|
||||||
export class TestCtl {
|
export class TestCtl {
|
||||||
constructor(private readonly baseURL: string) {}
|
constructor(private readonly baseURL: string) {}
|
||||||
|
|||||||
@@ -7,6 +7,7 @@ export {
|
|||||||
};
|
};
|
||||||
|
|
||||||
export type {
|
export type {
|
||||||
|
AlbumMatchView,
|
||||||
AlignmentView,
|
AlignmentView,
|
||||||
ApplyResultView,
|
ApplyResultView,
|
||||||
CandidateView,
|
CandidateView,
|
||||||
|
|||||||
@@ -1,6 +1,61 @@
|
|||||||
// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL
|
// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL
|
||||||
// This file is automatically generated. DO NOT EDIT
|
// This file is automatically generated. DO NOT EDIT
|
||||||
|
|
||||||
|
/**
|
||||||
|
* AlbumMatchView is "the autotagger already has a confident match for
|
||||||
|
* the album you are looking at".
|
||||||
|
*
|
||||||
|
* It is deliberately not a score. The album page renders a suggestion,
|
||||||
|
* and a suggestion has to be actionable: which release, what it is
|
||||||
|
* called, and whether acting on it here would do the whole album or
|
||||||
|
* only part of it.
|
||||||
|
*/
|
||||||
|
export interface AlbumMatchView {
|
||||||
|
/**
|
||||||
|
* GroupKey is the tagging group the actions operate on.
|
||||||
|
*/
|
||||||
|
"groupKey": string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Recommendation is the tier, as a string, for a caller that
|
||||||
|
* wants to render the strength rather than trust the filter.
|
||||||
|
*/
|
||||||
|
"recommendation": string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Score is the top candidate's raw score, 0..1.
|
||||||
|
*/
|
||||||
|
"score": number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* ReleaseMBID is the release Apply would write.
|
||||||
|
*/
|
||||||
|
"releaseMbid": string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Title and ArtistCredit name that release, so the banner can say
|
||||||
|
* what it is offering rather than "a match".
|
||||||
|
*/
|
||||||
|
"title": string;
|
||||||
|
"artistCredit": string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* TrackCount is the group's local track count.
|
||||||
|
*/
|
||||||
|
"trackCount": number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* GroupCount is how many tagging groups this album spans.
|
||||||
|
*
|
||||||
|
* More than one means a multi-disc album (one group per disc), and
|
||||||
|
* it is the reason this is a field rather than an implementation
|
||||||
|
* detail: applying "the album" from a single button would retag
|
||||||
|
* one disc of three and leave the folder holding a mix of old and
|
||||||
|
* new tags. The caller offers review instead.
|
||||||
|
*/
|
||||||
|
"groupCount": number;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* AlignmentView mirrors autotag.TrackAlignment. LocalIndex of -1
|
* AlignmentView mirrors autotag.TrackAlignment. LocalIndex of -1
|
||||||
* means "candidate has this track, folder doesn't" (status=missing).
|
* means "candidate has this track, folder doesn't" (status=missing).
|
||||||
|
|||||||
@@ -160,6 +160,39 @@ export function ListPendingFolders(libraryID: number): $CancellablePromise<$mode
|
|||||||
return $Call.ByID(617511590, libraryID);
|
return $Call.ByID(617511590, libraryID);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* MatchForAlbum answers "does the autotagger have something confident
|
||||||
|
* to say about this album", for the album detail page.
|
||||||
|
*
|
||||||
|
* Three things about it are load-bearing.
|
||||||
|
*
|
||||||
|
* **It costs no MusicBrainz request.** Everything it needs is already
|
||||||
|
* on disk: `tagging_items` carries the top score and release from the
|
||||||
|
* background prefetch, and `tagging_candidates` durably holds the
|
||||||
|
* scored list. The rate limiters here are shared with every page the
|
||||||
|
* user can open, so a lookup that fires on page load must not join
|
||||||
|
* that queue — which also means this returns nothing for a folder
|
||||||
|
* nobody has scored yet, rather than scoring it now. That is the
|
||||||
|
* right trade: the prefetch will get to it, and a page that silently
|
||||||
|
* spends a minute of somebody's MusicBrainz budget to draw a banner
|
||||||
|
* is worse than a page that says nothing.
|
||||||
|
*
|
||||||
|
* **The tier is computed, not read.** `tagging_items.score` is the raw
|
||||||
|
* number and `Recommend` is what turns it into a claim — capping it
|
||||||
|
* for an ambiguous runner-up, an incomplete alignment or a folder too
|
||||||
|
* small to corroborate itself. Filtering on the raw score would
|
||||||
|
* promise confidence the scorer had explicitly withheld.
|
||||||
|
*
|
||||||
|
* **Nothing is said about an album the user has already answered
|
||||||
|
* for.** Only a `pending` group qualifies: `confirmed` covers both a
|
||||||
|
* finished apply and an explicit "leave as is", and `skipped` is the
|
||||||
|
* user saying not now. Re-offering either is nagging, and "leave as
|
||||||
|
* is" would be actively wrong to argue with.
|
||||||
|
*/
|
||||||
|
export function MatchForAlbum(albumID: number): $CancellablePromise<$models.AlbumMatchView | null> {
|
||||||
|
return $Call.ByID(514173221, albumID);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* RetagGroup flips a group back to 'pending' so the user can
|
* RetagGroup flips a group back to 'pending' so the user can
|
||||||
* re-review after an apply or skip. Drops the durably-cached
|
* re-review after an apply or skip. Drops the durably-cached
|
||||||
|
|||||||
@@ -69,6 +69,14 @@ export function GetPinDefaultPlaylist(): $CancellablePromise<boolean> {
|
|||||||
return $Call.ByID(3818283301);
|
return $Call.ByID(3818283301);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* GetPopupVolume reports whether the bottom bar's volume control is a
|
||||||
|
* click-to-open popup rather than an inline slider (#42).
|
||||||
|
*/
|
||||||
|
export function GetPopupVolume(): $CancellablePromise<boolean> {
|
||||||
|
return $Call.ByID(2885777);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* GetQueueFallback returns what plays, if anything, once the queue
|
* GetQueueFallback returns what plays, if anything, once the queue
|
||||||
* runs out.
|
* runs out.
|
||||||
@@ -112,6 +120,16 @@ export function GetTrackListColumns(): $CancellablePromise<tracklist$0.Column[]
|
|||||||
return $Call.ByID(3426289065);
|
return $Call.ByID(3426289065);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* GetViewVisibility reports which primary views the sidebar should
|
||||||
|
* show, answered for every known view rather than only the ones the
|
||||||
|
* config mentions -- so the frontend filters on a value and never has
|
||||||
|
* to hold a second copy of the defaults.
|
||||||
|
*/
|
||||||
|
export function GetViewVisibility(): $CancellablePromise<{ [_ in string]?: boolean } | null> {
|
||||||
|
return $Call.ByID(2798108026);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Load reads and parses the config file from disk.
|
* Load reads and parses the config file from disk.
|
||||||
*/
|
*/
|
||||||
@@ -197,6 +215,18 @@ export function SetPinDefaultPlaylist(pin: boolean): $CancellablePromise<void> {
|
|||||||
return $Call.ByID(372446849, pin);
|
return $Call.ByID(372446849, pin);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* SetPopupVolume saves the volume control's presentation.
|
||||||
|
*
|
||||||
|
* Nothing to validate: both values are legal at every width, and the
|
||||||
|
* frontend additionally stands the inline slider down below the phone
|
||||||
|
* breakpoint whatever this says, because that is about room rather than
|
||||||
|
* about preference.
|
||||||
|
*/
|
||||||
|
export function SetPopupVolume(popup: boolean): $CancellablePromise<void> {
|
||||||
|
return $Call.ByID(1430308453, popup);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* SetQueueFallback validates and saves a new queue-fallback mode.
|
* SetQueueFallback validates and saves a new queue-fallback mode.
|
||||||
*/
|
*/
|
||||||
@@ -247,6 +277,20 @@ export function SetTrackListColumns(columns: tracklist$0.Column[] | null): $Canc
|
|||||||
return $Call.ByID(4226159685, columns);
|
return $Call.ByID(4226159685, columns);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* SetViewVisible shows or hides one primary view.
|
||||||
|
*
|
||||||
|
* Two refusals, both about a state the user cannot get out of from the
|
||||||
|
* UI they would be left with: Settings is never hideable, and the
|
||||||
|
* launch page is never hideable while it is the launch page (change it
|
||||||
|
* first). Hiding a view does not make it unreachable -- `navigate`
|
||||||
|
* still resolves it, which detail views depend on -- it only takes the
|
||||||
|
* nav item away.
|
||||||
|
*/
|
||||||
|
export function SetViewVisible(view: string, visible: boolean): $CancellablePromise<void> {
|
||||||
|
return $Call.ByID(1751982648, view, visible);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Validate returns errors if there is a breaking issue with the config.
|
* Validate returns errors if there is a breaking issue with the config.
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -113,14 +113,6 @@ export function Next(): $CancellablePromise<void> {
|
|||||||
return $Call.ByID(1968784044);
|
return $Call.ByID(1968784044);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* OnPlaybackFinished is called when a track finishes playing naturally.
|
|
||||||
* This drives the auto-advance behavior and records the play.
|
|
||||||
*/
|
|
||||||
export function OnPlaybackFinished(): $CancellablePromise<void> {
|
|
||||||
return $Call.ByID(2184869763);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Play handles a play request by either resuming the current track or
|
* Play handles a play request by either resuming the current track or
|
||||||
* starting playback from the beginning of the queue. When a track is
|
* starting playback from the beginning of the queue. When a track is
|
||||||
|
|||||||
+155
-6
@@ -104,6 +104,51 @@ p {
|
|||||||
flex: 0 1 320px;
|
flex: 0 1 320px;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* What the bar gives up when it does not fit is decided by measuring
|
||||||
|
it (`services/top-bar-fit.ts`, #143). Two rules here are what make
|
||||||
|
that measurement mean anything.
|
||||||
|
|
||||||
|
**Nothing but the search box may shrink.** `scrollWidth` reports a
|
||||||
|
perfect fit while a child quietly truncates -- #69's trap, one
|
||||||
|
component over -- and the indicator's label is `text-overflow:
|
||||||
|
ellipsis`, so it would have absorbed the deficit and hidden it. The
|
||||||
|
search box is exempt because it shrinks between its 320px basis and
|
||||||
|
the 200px floor its own stylesheet sets, and a narrower input hides
|
||||||
|
nothing it was showing. */
|
||||||
|
.top-bar hgroup,
|
||||||
|
.top-bar library-filter,
|
||||||
|
.top-bar job-indicator {
|
||||||
|
flex-shrink: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* **The wordmark yields its width, not its existence.** It is the
|
||||||
|
app's top-level heading as well as its brand, and `display: none`
|
||||||
|
would take a document from one `h1` to none at exactly the widths
|
||||||
|
where the view's own header is the only thing left saying where you
|
||||||
|
are. This is `styles/sr-only.css.ts`'s recipe, written out because
|
||||||
|
that one is a `CSSResult` for shadow roots and this is the light
|
||||||
|
DOM. */
|
||||||
|
.top-bar hgroup.yj-collapsed {
|
||||||
|
position: absolute;
|
||||||
|
width: 1px;
|
||||||
|
height: 1px;
|
||||||
|
padding: 0;
|
||||||
|
margin: -1px;
|
||||||
|
overflow: hidden;
|
||||||
|
clip-path: inset(50%);
|
||||||
|
white-space: nowrap;
|
||||||
|
border: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* The bar is `justify-content: space-between`, which with four children
|
||||||
|
spreads them evenly and left back/forward floating in the middle of
|
||||||
|
nothing. Collecting the free space *after* this one puts the pair
|
||||||
|
beside the brand, where a browser keeps them, and leaves the
|
||||||
|
right-hand group exactly as it was. */
|
||||||
|
.top-bar nav-history {
|
||||||
|
margin-right: auto;
|
||||||
|
}
|
||||||
|
|
||||||
ul {
|
ul {
|
||||||
list-style-type: none;
|
list-style-type: none;
|
||||||
}
|
}
|
||||||
@@ -133,6 +178,23 @@ ul {
|
|||||||
.subtitle {
|
.subtitle {
|
||||||
display: none;
|
display: none;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* Back/forward is Desktop-band chrome (#6), and 900 is the same
|
||||||
|
line the sidebar's labels and the subtitle are already given up
|
||||||
|
at -- below it the shell is narrow enough that the header is
|
||||||
|
what runs out of room first. Measured at 600, the bottom of the
|
||||||
|
Compact band: the bar is 611px inside a 600px viewport *before*
|
||||||
|
this component exists (filed separately), and 695px with it, so
|
||||||
|
keeping it here would be widening a violation of the promise
|
||||||
|
that nothing scrolls sideways at a supported size.
|
||||||
|
|
||||||
|
Nothing is unreachable as a result, which is the rule that
|
||||||
|
decides it: Alt+Left / Alt+Right are global and every width has
|
||||||
|
them, the detail views keep their own back buttons, and the
|
||||||
|
phone additionally has the platform's gesture. */
|
||||||
|
.top-bar nav-history {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
body div.sidebar {
|
body div.sidebar {
|
||||||
@@ -149,7 +211,39 @@ body div.sidebar {
|
|||||||
padding: 0.25em;
|
padding: 0.25em;
|
||||||
background-color: var(--yj-bg-elevated, #343a40);
|
background-color: var(--yj-bg-elevated, #343a40);
|
||||||
display: grid;
|
display: grid;
|
||||||
grid-template-columns: var(--now-playing-width, 320px) 1fr auto;
|
/* Three columns whose outer two are the *same* width, which is what
|
||||||
|
centres the middle one (#23). It was `var(--now-playing-width) 1fr
|
||||||
|
auto`, so the transport's centre sat at `W/2 + 140px` — in the
|
||||||
|
middle of the space left over, which is not the same thing and
|
||||||
|
reads as an alignment mistake at every window size.
|
||||||
|
|
||||||
|
The outer width is still `--now-playing-width`, so **the metadata
|
||||||
|
panel's drag handle keeps meaning something**: widening it takes
|
||||||
|
room from the transport on both sides at once, symmetrically. An
|
||||||
|
`1fr … 1fr` pair would have centred the transport just as well and
|
||||||
|
silently made that handle a no-op.
|
||||||
|
|
||||||
|
**The cap is what stops that being a regression**, and it was
|
||||||
|
measured as one first. Reserving the full metadata width on both
|
||||||
|
sides costs the transport twice: at 800px the outer pair wanted
|
||||||
|
640 of 800, and the seek bar's track went from 257px to 61px
|
||||||
|
(and to 0 at 200% text) — the control you drag, squeezed out to
|
||||||
|
centre the buttons above it. So the side tracks are the metadata
|
||||||
|
width *or a quarter of the bar*, whichever is smaller, which
|
||||||
|
leaves the drag handle meaningful everywhere it has room to be
|
||||||
|
and hands the difference to the transport where it does not.
|
||||||
|
|
||||||
|
`minmax(0, …)` on the outer tracks and `min-content` on the middle
|
||||||
|
decide who yields when even that is not enough: the metadata and
|
||||||
|
the end group shrink (both truncate; neither loses an action), and
|
||||||
|
the transport keeps at least its buttons. Without the `min-content`
|
||||||
|
floor the middle collapses first, because a `1fr` track's minimum
|
||||||
|
is `auto` only until something else insists. */
|
||||||
|
--bar-side: min(var(--now-playing-width, 320px), 25%);
|
||||||
|
grid-template-columns:
|
||||||
|
minmax(0, var(--bar-side))
|
||||||
|
minmax(min-content, 1fr)
|
||||||
|
minmax(0, var(--bar-side));
|
||||||
align-items: center;
|
align-items: center;
|
||||||
contain: layout style;
|
contain: layout style;
|
||||||
|
|
||||||
@@ -177,23 +271,44 @@ body div.sidebar {
|
|||||||
text-wrap-mode: nowrap;
|
text-wrap-mode: nowrap;
|
||||||
overflow: hidden;
|
overflow: hidden;
|
||||||
|
|
||||||
p {
|
/* `& p`, not `p`. **A nested rule that begins with a bare
|
||||||
|
element selector is silently dropped before Chrome 120**
|
||||||
|
(relaxed nesting), and the phone this app runs on renders
|
||||||
|
in Chrome 113 -- so this ellipsis, and the two rules
|
||||||
|
below, have never applied on the device. Nothing fails;
|
||||||
|
the text simply overflows there. The `&` form is valid in
|
||||||
|
both, which is why it is used for every element selector
|
||||||
|
in this file's nested blocks. */
|
||||||
|
& p {
|
||||||
overflow: hidden;
|
overflow: hidden;
|
||||||
text-overflow: ellipsis;
|
text-overflow: ellipsis;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
now-playing {
|
& now-playing {
|
||||||
overflow: hidden;
|
overflow: hidden;
|
||||||
}
|
}
|
||||||
|
|
||||||
audio-player {
|
& audio-player {
|
||||||
margin: 0.5em 1em;
|
margin: 0.5em 1em;
|
||||||
|
min-width: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* The right-hand group, and the thing the left column is matched
|
||||||
|
against. It is one grid cell rather than two columns because the
|
||||||
|
centring rule above compares *columns*: volume and the queue
|
||||||
|
button in separate tracks would make the outer pair unequal by
|
||||||
|
whatever the volume happens to measure. */
|
||||||
|
.bar-end {
|
||||||
|
justify-self: end;
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 0.25em;
|
||||||
|
min-width: 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
#queue-button {
|
#queue-button {
|
||||||
justify-self: end;
|
|
||||||
background: none;
|
background: none;
|
||||||
border: none;
|
border: none;
|
||||||
color: inherit;
|
color: inherit;
|
||||||
@@ -231,6 +346,14 @@ body div.sidebar {
|
|||||||
display: flex;
|
display: flex;
|
||||||
overflow: hidden;
|
overflow: hidden;
|
||||||
contain: layout style;
|
contain: layout style;
|
||||||
|
|
||||||
|
/* The containing block for the queue panel's overlay mode (plan
|
||||||
|
018, #24), which spans this box rather than taking width from
|
||||||
|
the main panel beside it. `contain: layout` already establishes
|
||||||
|
one; this says so on purpose, so that removing the containment
|
||||||
|
for a paint reason does not silently reparent the overlay to the
|
||||||
|
viewport. */
|
||||||
|
position: relative;
|
||||||
}
|
}
|
||||||
|
|
||||||
.main-panel {
|
.main-panel {
|
||||||
@@ -338,7 +461,13 @@ body div.sidebar {
|
|||||||
|
|
||||||
/* The search box is the one header control worth its width; the
|
/* The search box is the one header control worth its width; the
|
||||||
library filter is a rarely-changed setting and reachable from
|
library filter is a rarely-changed setting and reachable from
|
||||||
the drawer's Settings. */
|
the drawer's Settings.
|
||||||
|
|
||||||
|
`nav-history` is already gone from 899 down. It would belong
|
||||||
|
here anyway and for a stronger reason than width: the phone has
|
||||||
|
Back as a gesture or a button the OS owns, and this app hooks it
|
||||||
|
(`popstate`), so a second Back in the chrome duplicates a
|
||||||
|
control the platform provides. */
|
||||||
.top-bar library-filter {
|
.top-bar library-filter {
|
||||||
display: none;
|
display: none;
|
||||||
}
|
}
|
||||||
@@ -364,6 +493,11 @@ body div.sidebar {
|
|||||||
}
|
}
|
||||||
|
|
||||||
@media (max-width: 599px) {
|
@media (max-width: 599px) {
|
||||||
|
/* The phone keeps the two-part bar it had: metadata, then the
|
||||||
|
transport and the queue button. There is no third column to
|
||||||
|
balance because the centring the desktop does is a luxury of
|
||||||
|
having room — at 360px the metadata needs all of the space the
|
||||||
|
controls do not. */
|
||||||
.bottom-bar {
|
.bottom-bar {
|
||||||
grid-template-columns: minmax(0, 1fr) auto auto;
|
grid-template-columns: minmax(0, 1fr) auto auto;
|
||||||
gap: 0.25em;
|
gap: 0.25em;
|
||||||
@@ -372,4 +506,19 @@ body div.sidebar {
|
|||||||
.bottom-bar audio-player {
|
.bottom-bar audio-player {
|
||||||
margin: 0.25em;
|
margin: 0.25em;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* Volume stands down here whatever the setting says, because this
|
||||||
|
is about room and about the platform rather than about
|
||||||
|
preference: the hardware keys own volume on a phone, which is
|
||||||
|
also why mediacontrols' Android handler implements no volume
|
||||||
|
callback. It moved from `audio-player`'s own media query when
|
||||||
|
#42 moved the control into the bar — same rule, and now stated
|
||||||
|
where the element actually is.
|
||||||
|
|
||||||
|
`.bottom-bar volume-control`, not the one in
|
||||||
|
`now-playing-view`: that view is the phone's transport and is
|
||||||
|
where a slider does belong. */
|
||||||
|
.bottom-bar volume-control {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+28
-7
@@ -20,6 +20,12 @@
|
|||||||
<!-- a11y.29: a heading level was being used for type size. -->
|
<!-- a11y.29: a heading level was being used for type size. -->
|
||||||
<p class="subtitle">Music how it was meant to bee.</p>
|
<p class="subtitle">Music how it was meant to bee.</p>
|
||||||
</hgroup>
|
</hgroup>
|
||||||
|
<!-- Global back/forward (#6). Before the library filter so the
|
||||||
|
two navigation controls in this bar are adjacent, and after
|
||||||
|
the brand because that is where a window's chrome ends and
|
||||||
|
the app's begins. Hidden below 600px by index.css: the
|
||||||
|
phone has a system back, and this bar has no room. -->
|
||||||
|
<nav-history></nav-history>
|
||||||
<library-filter></library-filter>
|
<library-filter></library-filter>
|
||||||
<search-bar></search-bar>
|
<search-bar></search-bar>
|
||||||
<job-indicator></job-indicator>
|
<job-indicator></job-indicator>
|
||||||
@@ -34,16 +40,31 @@
|
|||||||
</main>
|
</main>
|
||||||
<queue-panel id="queue-panel"></queue-panel>
|
<queue-panel id="queue-panel"></queue-panel>
|
||||||
</div>
|
</div>
|
||||||
|
<!-- Three columns, and the outer two are the same width, which is
|
||||||
|
what makes the middle one *centred* rather than merely in the
|
||||||
|
middle of what is left (#23). The transport used to sit in a
|
||||||
|
`320px 1fr auto` grid, so its centre was ~140px right of the
|
||||||
|
window's.
|
||||||
|
|
||||||
|
That is also why the volume moved out of `audio-player` and
|
||||||
|
into the bar (#42): the transport column has to contain the
|
||||||
|
transport and nothing else, or "centred" means centred with a
|
||||||
|
slider bolted to one side. It joins the queue button in
|
||||||
|
`.bar-end`, whose width is what the left column is matched
|
||||||
|
against. -->
|
||||||
<footer class="bottom-bar">
|
<footer class="bottom-bar">
|
||||||
<now-playing></now-playing>
|
<now-playing></now-playing>
|
||||||
<audio-player></audio-player>
|
<audio-player></audio-player>
|
||||||
<button aria-label="Toggle queue" aria-controls="queue-panel" aria-expanded="false"
|
<div class="bar-end">
|
||||||
id="queue-button">
|
<volume-control></volume-control>
|
||||||
<!-- ICON_QUEUE in src/utils/icon-language.ts, written out
|
<button aria-label="Toggle queue" aria-controls="queue-panel" aria-expanded="false"
|
||||||
because this file has no module scope. It was `list`,
|
id="queue-button">
|
||||||
which is the Playlists destination's icon. -->
|
<!-- ICON_QUEUE in src/utils/icon-language.ts, written out
|
||||||
<wa-icon name="bars-staggered"></wa-icon>
|
because this file has no module scope. It was `list`,
|
||||||
</button>
|
which is the Playlists destination's icon. -->
|
||||||
|
<wa-icon name="bars-staggered"></wa-icon>
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
</footer>
|
</footer>
|
||||||
<!-- The phone's primary navigation, hidden above 600px by
|
<!-- The phone's primary navigation, hidden above 600px by
|
||||||
index.css. Eager rather than a chunk, for the reason
|
index.css. Eager rather than a chunk, for the reason
|
||||||
|
|||||||
+129
-20
@@ -18,11 +18,15 @@
|
|||||||
// track-list — index.html renders one, so it is the first paint.
|
// track-list — index.html renders one, so it is the first paint.
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
import '@components/audio-player/audio-player.ts';
|
import '@components/audio-player/audio-player.ts';
|
||||||
|
// In the bar rather than inside `audio-player` since #42, so the shell
|
||||||
|
// is what has to register it.
|
||||||
|
import '@components/audio-player/volume-control/volume-control.ts';
|
||||||
import '@components/track-list/track-list.ts';
|
import '@components/track-list/track-list.ts';
|
||||||
import '@components/now-playing/now-playing.ts';
|
import '@components/now-playing/now-playing.ts';
|
||||||
import '@components/sidebar/app-sidebar.ts';
|
import '@components/sidebar/app-sidebar.ts';
|
||||||
import '@components/bottom-nav/bottom-nav.ts';
|
import '@components/bottom-nav/bottom-nav.ts';
|
||||||
import '@components/queue-panel/queue-panel.ts';
|
import '@components/queue-panel/queue-panel.ts';
|
||||||
|
import '@components/nav-history/nav-history.ts';
|
||||||
import '@components/search-bar/search-bar.ts';
|
import '@components/search-bar/search-bar.ts';
|
||||||
import '@components/library-filter/library-filter.ts';
|
import '@components/library-filter/library-filter.ts';
|
||||||
import '@components/first-run-wizard/first-run-wizard.ts';
|
import '@components/first-run-wizard/first-run-wizard.ts';
|
||||||
@@ -40,6 +44,8 @@ import { setBasePath } from '@awesome.me/webawesome/dist/webawesome.js';
|
|||||||
import { registerBundledIcons } from './src/icons';
|
import { registerBundledIcons } from './src/icons';
|
||||||
import { queueStore } from '@store/queue-store';
|
import { queueStore } from '@store/queue-store';
|
||||||
import { searchStore } from '@store/search-store';
|
import { searchStore } from '@store/search-store';
|
||||||
|
import { activeViewStore } from '@store/active-view-store';
|
||||||
|
import { historyStore } from '@store/history-store';
|
||||||
import * as Player from '@go/player/player.js';
|
import * as Player from '@go/player/player.js';
|
||||||
import * as Queue from '@go/queue/queue.js';
|
import * as Queue from '@go/queue/queue.js';
|
||||||
import { GetDefaultPage } from '@go/config/config.js';
|
import { GetDefaultPage } from '@go/config/config.js';
|
||||||
@@ -51,6 +57,7 @@ import '@store/theme-store';
|
|||||||
import './src/services/keyboard-shortcut-service';
|
import './src/services/keyboard-shortcut-service';
|
||||||
import { activateView, deactivateView } from '@utils/view-lifecycle';
|
import { activateView, deactivateView } from '@utils/view-lifecycle';
|
||||||
import { installLongPressContextMenu } from '@utils/long-press';
|
import { installLongPressContextMenu } from '@utils/long-press';
|
||||||
|
import { installTopBarFit } from './src/services/top-bar-fit';
|
||||||
import {
|
import {
|
||||||
hasTrackPayload,
|
hasTrackPayload,
|
||||||
getDragPayload,
|
getDragPayload,
|
||||||
@@ -70,6 +77,14 @@ registerBundledIcons();
|
|||||||
// on `pointerType === 'touch'` only.
|
// on `pointerType === 'touch'` only.
|
||||||
installLongPressContextMenu();
|
installLongPressContextMenu();
|
||||||
|
|
||||||
|
// The top bar decides what it can afford to show (#143). Here rather
|
||||||
|
// than in a component because the bar is light DOM in index.html and
|
||||||
|
// its children are five separate elements; the shell is the only thing
|
||||||
|
// that can see all five at once.
|
||||||
|
const topBar = document.querySelector<HTMLElement>('header.top-bar');
|
||||||
|
|
||||||
|
if (topBar) installTopBarFit(topBar);
|
||||||
|
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
// View caching navigation system
|
// View caching navigation system
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
@@ -98,7 +113,6 @@ const VIEW_TAGS: Record<string, string> = {
|
|||||||
explore: 'explore-view',
|
explore: 'explore-view',
|
||||||
autotag: 'autotag-view',
|
autotag: 'autotag-view',
|
||||||
downloads: 'downloads-view',
|
downloads: 'downloads-view',
|
||||||
jobs: 'jobs-view',
|
|
||||||
settings: 'config-page',
|
settings: 'config-page',
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -116,7 +130,6 @@ const VIEW_LOADERS: Record<string, () => Promise<unknown>> = {
|
|||||||
explore: () => import('@components/explore-view/explore-view.ts'),
|
explore: () => import('@components/explore-view/explore-view.ts'),
|
||||||
autotag: () => import('@components/autotag-view/autotag-view.ts'),
|
autotag: () => import('@components/autotag-view/autotag-view.ts'),
|
||||||
downloads: () => import('@components/downloads-view/downloads-view.ts'),
|
downloads: () => import('@components/downloads-view/downloads-view.ts'),
|
||||||
jobs: () => import('@components/jobs/jobs-view.ts'),
|
|
||||||
settings: () => import('@components/config-page/config-page.ts'),
|
settings: () => import('@components/config-page/config-page.ts'),
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -214,45 +227,101 @@ document.addEventListener('navigate', (e: Event) => {
|
|||||||
// go through `history.back()` rather than popping `navStack`
|
// go through `history.back()` rather than popping `navStack`
|
||||||
// themselves, so one press cannot consume two entries.
|
// themselves, so one press cannot consume two entries.
|
||||||
|
|
||||||
/** The navigation an entry stands for. `undefined` on the entry that
|
/** The navigation an entry stands for, and where it sits in this
|
||||||
* predates the app's own routing, which is the one back exits from. */
|
* session's list. `undefined` on the entry that predates the app's own
|
||||||
type NavState = { yjNav?: { view: string; [key: string]: any } };
|
* routing, which is the one back exits from. */
|
||||||
|
type NavState = { yjNav?: { view: string; [key: string]: any }; yjIdx?: number };
|
||||||
|
|
||||||
/** Whether the app's first navigation has been recorded. It *replaces*
|
/** Whether the app's first navigation has been recorded. It *replaces*
|
||||||
* the launch entry rather than pushing, or every launch would cost one
|
* the launch entry rather than pushing, or every launch would cost one
|
||||||
* back press before the app would exit. */
|
* back press before the app would exit. */
|
||||||
let historyStarted = false;
|
let historyStarted = false;
|
||||||
|
|
||||||
/** How many entries this session has pushed beyond that first one --
|
// Back and forward are the *same* `popstate` event -- it carries no
|
||||||
* i.e. how deep back can go while staying inside the app. */
|
// direction, and the History API exposes neither the current position
|
||||||
let pushedEntries = 0;
|
// nor a reachable depth. So the shell numbers its own entries: the
|
||||||
|
// index of the one showing, and the highest index reachable from here.
|
||||||
|
//
|
||||||
|
// The counter this replaced (`pushedEntries`, one number decremented on
|
||||||
|
// every pop) could not express forward at all: going forward looked
|
||||||
|
// exactly like going back again, so two presses of a Forward button
|
||||||
|
// would have claimed the app was at its root.
|
||||||
|
|
||||||
|
/** Index of the entry now showing. 0 is the launch entry, which is
|
||||||
|
* replaced rather than pushed -- so this is also how deep back can go
|
||||||
|
* while staying inside the app. */
|
||||||
|
let currentIndex = 0;
|
||||||
|
|
||||||
|
/** The highest index reachable from here: how far forward is left.
|
||||||
|
* A new navigation truncates the forward list, exactly as a browser
|
||||||
|
* does, so this is reset to the entry being pushed. */
|
||||||
|
let maxIndex = 0;
|
||||||
|
|
||||||
|
function publishDepth(): void {
|
||||||
|
historyStore.setDepth(currentIndex > 0, currentIndex < maxIndex);
|
||||||
|
}
|
||||||
|
|
||||||
function recordNavigation(detail: { view: string; [key: string]: any }): void {
|
function recordNavigation(detail: { view: string; [key: string]: any }): void {
|
||||||
// `_isBack` is bookkeeping, not destination: keeping it in the entry
|
// `_isBack` and `_replace` are bookkeeping, not destination: keeping
|
||||||
// would make a replayed navigation claim to be a back-navigation.
|
// either in the entry would make a replayed navigation claim to be
|
||||||
const { _isBack: _ignored, ...nav } = detail;
|
// one.
|
||||||
const state: NavState = { yjNav: nav };
|
const { _isBack: _ignored, _replace: replace, ...nav } = detail;
|
||||||
|
|
||||||
|
// Still launching: the configured landing page is not a navigation
|
||||||
|
// *away* from the eager one, it is the same arrival arriving late
|
||||||
|
// (#142). Pushing it left the app one entry deep before the user
|
||||||
|
// had touched anything, so the first back press replayed home over
|
||||||
|
// home -- invisible on desktop until #6 drew a Back button, and on
|
||||||
|
// Android the press that should have exited the app instead did
|
||||||
|
// nothing, because `canGoBack()` was true.
|
||||||
|
//
|
||||||
|
// Guarded on being at the root rather than on a flag, because
|
||||||
|
// `GetDefaultPage()` is a backend call and the user can navigate
|
||||||
|
// while it is in flight: past index 0 this is an ordinary
|
||||||
|
// navigation, or a slow answer would overwrite an entry they made.
|
||||||
|
if (historyStarted && replace && currentIndex === 0) {
|
||||||
|
history.replaceState({ yjNav: nav, yjIdx: 0 }, '');
|
||||||
|
maxIndex = 0;
|
||||||
|
publishDepth();
|
||||||
|
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
// Same URL, deliberately: the app has no routes, and a path a
|
// Same URL, deliberately: the app has no routes, and a path a
|
||||||
// reload cannot resolve is worse than no path at all.
|
// reload cannot resolve is worse than no path at all.
|
||||||
if (historyStarted) {
|
if (historyStarted) {
|
||||||
history.pushState(state, '');
|
currentIndex += 1;
|
||||||
pushedEntries += 1;
|
// Navigating from the middle of the list drops what was ahead
|
||||||
|
// of it -- there is no longer a forward to go to.
|
||||||
|
maxIndex = currentIndex;
|
||||||
|
history.pushState({ yjNav: nav, yjIdx: currentIndex }, '');
|
||||||
} else {
|
} else {
|
||||||
history.replaceState(state, '');
|
currentIndex = 0;
|
||||||
|
maxIndex = 0;
|
||||||
|
history.replaceState({ yjNav: nav, yjIdx: 0 }, '');
|
||||||
historyStarted = true;
|
historyStarted = true;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
publishDepth();
|
||||||
}
|
}
|
||||||
|
|
||||||
window.addEventListener('popstate', (e: PopStateEvent) => {
|
window.addEventListener('popstate', (e: PopStateEvent) => {
|
||||||
const nav = (e.state as NavState | null)?.yjNav;
|
const state = e.state as NavState | null;
|
||||||
|
const nav = state?.yjNav;
|
||||||
|
|
||||||
// Before the app's first navigation, or an entry somebody else
|
// Before the app's first navigation, or an entry somebody else
|
||||||
// pushed: nothing to restore, and the activity should be free to
|
// pushed: nothing to restore, and the activity should be free to
|
||||||
// finish.
|
// finish.
|
||||||
if (!nav) return;
|
if (!nav) return;
|
||||||
|
|
||||||
pushedEntries = Math.max(0, pushedEntries - 1);
|
// The entry says where it is, so this works in both directions and
|
||||||
|
// across a jump of more than one -- which a long-press on a
|
||||||
|
// browser's back button, and `history.go(-n)`, both produce.
|
||||||
|
// The fallback is for an entry pushed before this numbering
|
||||||
|
// existed; it can only be wrong about a control's disabled state,
|
||||||
|
// never about which view is restored.
|
||||||
|
currentIndex = state?.yjIdx ?? Math.max(0, currentIndex - 1);
|
||||||
|
publishDepth();
|
||||||
|
|
||||||
void handleNavigate({ ...nav, _isBack: true });
|
void handleNavigate({ ...nav, _isBack: true });
|
||||||
});
|
});
|
||||||
@@ -279,6 +348,20 @@ async function handleNavigate(
|
|||||||
// attribute keeps e2e selectors semantic instead of structural.
|
// attribute keeps e2e selectors semantic instead of structural.
|
||||||
mainContent.dataset.activeView = view;
|
mainContent.dataset.activeView = view;
|
||||||
|
|
||||||
|
// And publishing it as a *value* is what the nav components read.
|
||||||
|
// They used to learn the active view from the `navigate` event,
|
||||||
|
// which only the outbound path dispatches -- so a back-navigation
|
||||||
|
// left both of them highlighting the view it had just left (#72).
|
||||||
|
// Re-dispatching `navigate` here is not the fix: this file is a
|
||||||
|
// document listener for it, so that is an infinite loop, and
|
||||||
|
// "please go to X" is not the statement being made.
|
||||||
|
//
|
||||||
|
// `view in VIEW_TAGS` is the primary/detail split, and it is passed
|
||||||
|
// rather than re-derived because this table is where it is written
|
||||||
|
// down. A detail view therefore leaves the tab it was opened from
|
||||||
|
// lit, which is what the report asks for.
|
||||||
|
activeViewStore.setView(view, view in VIEW_TAGS);
|
||||||
|
|
||||||
// --- Primary (cacheable) views ----------------------------------------
|
// --- Primary (cacheable) views ----------------------------------------
|
||||||
if (view in VIEW_TAGS) {
|
if (view in VIEW_TAGS) {
|
||||||
// Remove any active detail view first
|
// Remove any active detail view first
|
||||||
@@ -308,6 +391,18 @@ async function handleNavigate(
|
|||||||
deactivateView(currentViewEl);
|
deactivateView(currentViewEl);
|
||||||
}
|
}
|
||||||
target.classList.remove('view-hidden');
|
target.classList.remove('view-hidden');
|
||||||
|
|
||||||
|
// A primary view is cached, so there is no construction to
|
||||||
|
// hand a payload to the way a detail view gets one below. The
|
||||||
|
// one navigation that carries something is the album page's
|
||||||
|
// "Review in Autotag", which has to land on *that* album: the
|
||||||
|
// request goes on as an attribute and `autotag-view` consumes
|
||||||
|
// it (removes it) once acted on, or every later visit would
|
||||||
|
// reopen a folder the user finished with long ago.
|
||||||
|
if (view === 'autotag' && typeof detail.groupKey === 'string') {
|
||||||
|
target.setAttribute('group-key', detail.groupKey);
|
||||||
|
}
|
||||||
|
|
||||||
// A freshly created view was appended hidden, so it did not
|
// A freshly created view was appended hidden, so it did not
|
||||||
// self-activate on connection; a cached one was deactivated on
|
// self-activate on connection; a cached one was deactivated on
|
||||||
// the way out. Either way this is the call that starts it.
|
// the way out. Either way this is the call that starts it.
|
||||||
@@ -485,7 +580,18 @@ function schedule(fn: () => void): void {
|
|||||||
// anyway would leave the app: the depth check is what stops a stray
|
// anyway would leave the app: the depth check is what stops a stray
|
||||||
// `navigate-back` closing it.
|
// `navigate-back` closing it.
|
||||||
document.addEventListener('navigate-back', () => {
|
document.addEventListener('navigate-back', () => {
|
||||||
if (pushedEntries > 0) history.back();
|
if (currentIndex > 0) history.back();
|
||||||
|
});
|
||||||
|
|
||||||
|
// Forward: the other half of #6. The stack was always global -- every
|
||||||
|
// navigation is an entry and `popstate` restores any of them -- so what
|
||||||
|
// was missing is a way to ask for one, and a truthful answer to whether
|
||||||
|
// there is one to ask for. It is guarded for the same reason back is:
|
||||||
|
// `history.forward()` at the end of the list is silent, so a button
|
||||||
|
// that offers it when there is nothing there is a button that does
|
||||||
|
// nothing.
|
||||||
|
document.addEventListener('navigate-forward', () => {
|
||||||
|
if (currentIndex < maxIndex) history.forward();
|
||||||
});
|
});
|
||||||
|
|
||||||
// Navigate to the user's configured launch page. Falls back to 'home'
|
// Navigate to the user's configured launch page. Falls back to 'home'
|
||||||
@@ -495,14 +601,17 @@ GetDefaultPage()
|
|||||||
document.dispatchEvent(new CustomEvent('navigate', {
|
document.dispatchEvent(new CustomEvent('navigate', {
|
||||||
bubbles: true,
|
bubbles: true,
|
||||||
composed: true,
|
composed: true,
|
||||||
detail: { view: view || 'home' },
|
// Part of launching, not a navigation away from the eager
|
||||||
|
// 'home' above: it replaces that entry rather than
|
||||||
|
// stacking on it (#142).
|
||||||
|
detail: { view: view || 'home', _replace: true },
|
||||||
}));
|
}));
|
||||||
})
|
})
|
||||||
.catch(() => {
|
.catch(() => {
|
||||||
document.dispatchEvent(new CustomEvent('navigate', {
|
document.dispatchEvent(new CustomEvent('navigate', {
|
||||||
bubbles: true,
|
bubbles: true,
|
||||||
composed: true,
|
composed: true,
|
||||||
detail: { view: 'home' },
|
detail: { view: 'home', _replace: true },
|
||||||
}));
|
}));
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1 @@
|
|||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.3.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2026 Fonticons, Inc. --><path fill="currentColor" d="M502.6 278.6c12.5-12.5 12.5-32.8 0-45.3l-160-160c-12.5-12.5-32.8-12.5-45.3 0s-12.5 32.8 0 45.3L402.7 224 32 224c-17.7 0-32 14.3-32 32s14.3 32 32 32l370.7 0-105.4 105.4c-12.5 12.5-12.5 32.8 0 45.3s32.8 12.5 45.3 0l160-160z"/></svg>
|
||||||
|
After Width: | Height: | Size: 532 B |
@@ -0,0 +1 @@
|
|||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.3.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2026 Fonticons, Inc. --><path fill="currentColor" d="M0 256a56 56 0 1 1 112 0 56 56 0 1 1 -112 0zm168 0a56 56 0 1 1 112 0 56 56 0 1 1 -112 0zm224-56a56 56 0 1 1 0 112 56 56 0 1 1 0-112z"/></svg>
|
||||||
|
After Width: | Height: | Size: 443 B |
@@ -3,7 +3,6 @@ import { customElement } from 'lit/decorators.js';
|
|||||||
import '@awesome.me/webawesome/dist/components/icon/icon.js';
|
import '@awesome.me/webawesome/dist/components/icon/icon.js';
|
||||||
import './controls/player-controls';
|
import './controls/player-controls';
|
||||||
import './seekbar/seek-bar';
|
import './seekbar/seek-bar';
|
||||||
import './volume-control/volume-control';
|
|
||||||
import '../notifications/inline-notice';
|
import '../notifications/inline-notice';
|
||||||
import { PlayerRegion } from '@store/player-store';
|
import { PlayerRegion } from '@store/player-store';
|
||||||
import { designTokens } from '../../styles/tokens.css';
|
import { designTokens } from '../../styles/tokens.css';
|
||||||
@@ -30,6 +29,7 @@ export class AudioPlayer extends LitElement {
|
|||||||
|
|
||||||
.player-main {
|
.player-main {
|
||||||
flex: 1;
|
flex: 1;
|
||||||
|
min-width: 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* The phone transport (plan 016 B2): the buttons, and nothing
|
/* The phone transport (plan 016 B2): the buttons, and nothing
|
||||||
@@ -37,14 +37,17 @@ export class AudioPlayer extends LitElement {
|
|||||||
viewport, not by the host, so this is the component saying what
|
viewport, not by the host, so this is the component saying what
|
||||||
it drops at phone width rather than the shell reaching in.
|
it drops at phone width rather than the shell reaching in.
|
||||||
|
|
||||||
Volume goes because the hardware keys own it on a phone --
|
|
||||||
Android routes them to the media stream, which is also why
|
|
||||||
mediacontrols' Android handler implements no volume callback.
|
|
||||||
The seek bar goes because a 4px-tall target dragged with a thumb
|
The seek bar goes because a 4px-tall target dragged with a thumb
|
||||||
is not a seek control; seeking belongs to the full-screen
|
is not a seek control; seeking belongs to the full-screen
|
||||||
now-playing view, which is the next phase. */
|
now-playing view.
|
||||||
|
|
||||||
|
Volume used to go from here too, and now goes from index.css
|
||||||
|
instead: #42 moved the control out of this component and into
|
||||||
|
the bar, so the shell is what can hide it. The reason is
|
||||||
|
unchanged -- the hardware keys own volume on a phone, which is
|
||||||
|
also why mediacontrols' Android handler implements no volume
|
||||||
|
callback. */
|
||||||
@media (max-width: 599px) {
|
@media (max-width: 599px) {
|
||||||
volume-control,
|
|
||||||
seek-bar {
|
seek-bar {
|
||||||
display: none;
|
display: none;
|
||||||
}
|
}
|
||||||
@@ -65,7 +68,6 @@ export class AudioPlayer extends LitElement {
|
|||||||
<seek-bar></seek-bar>
|
<seek-bar></seek-bar>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<volume-control></volume-control>
|
|
||||||
</div>
|
</div>
|
||||||
`;
|
`;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -22,6 +22,24 @@ export class SeekBar extends LitElement {
|
|||||||
@state()
|
@state()
|
||||||
private seekValue: number = 0;
|
private seekValue: number = 0;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether the user is dragging the thumb right now.
|
||||||
|
*
|
||||||
|
* It is `@state` rather than a plain field because `updated()` owns
|
||||||
|
* the interval and only reactive state brings `updated()` round. A
|
||||||
|
* bare `stopProgress()` in the input handler mutated nothing, so
|
||||||
|
* nothing re-rendered, so the tail of `updated()` that restarts the
|
||||||
|
* interval never ran — and the only things that could restart it
|
||||||
|
* were a `change` event or the next backend report. Any `input`
|
||||||
|
* without a committed `change` therefore froze the interpolation:
|
||||||
|
* a drag cancelled outside the element, a pointer taken by a scroll,
|
||||||
|
* or a touch on the track treated as a scrub, which on a phone are
|
||||||
|
* ordinary gestures. While playing, the 1 Hz report papered over it
|
||||||
|
* within a second; with reports not arriving it was permanent.
|
||||||
|
*/
|
||||||
|
@state()
|
||||||
|
private dragging: boolean = false;
|
||||||
|
|
||||||
/** Whether the right-hand clock shows time remaining or total. */
|
/** Whether the right-hand clock shows time remaining or total. */
|
||||||
@state()
|
@state()
|
||||||
private showRemaining: boolean = true;
|
private showRemaining: boolean = true;
|
||||||
@@ -133,6 +151,7 @@ export class SeekBar extends LitElement {
|
|||||||
override disconnectedCallback() {
|
override disconnectedCallback() {
|
||||||
super.disconnectedCallback();
|
super.disconnectedCallback();
|
||||||
this.stopProgress();
|
this.stopProgress();
|
||||||
|
this.endDrag();
|
||||||
}
|
}
|
||||||
|
|
||||||
override updated() {
|
override updated() {
|
||||||
@@ -154,18 +173,33 @@ export class SeekBar extends LitElement {
|
|||||||
// A report for a track that is no longer loaded is stale by
|
// A report for a track that is no longer loaded is stale by
|
||||||
// definition: the change id is the only thing that distinguishes
|
// definition: the change id is the only thing that distinguishes
|
||||||
// it, since the same file can play twice in a row.
|
// it, since the same file can play twice in a row.
|
||||||
|
//
|
||||||
|
// A report arriving mid-drag is deliberately *not* applied: the
|
||||||
|
// thumb belongs to the finger on it, and adopting a report once a
|
||||||
|
// second pulls it back out from under them. The seq is left
|
||||||
|
// unrecorded too, so the first report after the drag still counts
|
||||||
|
// as fresh.
|
||||||
const position = this.player.position;
|
const position = this.player.position;
|
||||||
const forThisTrack =
|
const forThisTrack =
|
||||||
position !== null && position.trackChangeId === currentChangeId;
|
position !== null && position.trackChangeId === currentChangeId;
|
||||||
|
|
||||||
if (position && forThisTrack && position.seq !== this.previousPositionSeq) {
|
if (
|
||||||
|
position &&
|
||||||
|
forThisTrack &&
|
||||||
|
!this.dragging &&
|
||||||
|
position.seq !== this.previousPositionSeq
|
||||||
|
) {
|
||||||
this.previousPositionSeq = position.seq;
|
this.previousPositionSeq = position.seq;
|
||||||
this.seekValue = position.positionSeconds;
|
this.seekValue = position.positionSeconds;
|
||||||
this.stopProgress();
|
this.stopProgress();
|
||||||
}
|
}
|
||||||
|
|
||||||
// Start/stop progress interval based on playback state
|
// One owner for the interval, and this is it. Every other place
|
||||||
if (this.isPlaying && this.hasTrack) {
|
// that wants it started or stopped says so by changing state that
|
||||||
|
// brings us back here, so the timer cannot be left running by a
|
||||||
|
// path that forgot to stop it or stopped by a path that forgot to
|
||||||
|
// start it again.
|
||||||
|
if (this.isPlaying && this.hasTrack && !this.dragging) {
|
||||||
this.startProgress();
|
this.startProgress();
|
||||||
} else {
|
} else {
|
||||||
this.stopProgress();
|
this.stopProgress();
|
||||||
@@ -210,18 +244,48 @@ export class SeekBar extends LitElement {
|
|||||||
|
|
||||||
private handleChange(e: Event) {
|
private handleChange(e: Event) {
|
||||||
const newSeekVal = (e.target as WaSlider).value;
|
const newSeekVal = (e.target as WaSlider).value;
|
||||||
|
this.endDrag();
|
||||||
this.setSeekValue(newSeekVal);
|
this.setSeekValue(newSeekVal);
|
||||||
this.player.seek(newSeekVal);
|
this.player.seek(newSeekVal);
|
||||||
|
}
|
||||||
|
|
||||||
if (this.isPlaying) {
|
/**
|
||||||
this.startProgress();
|
* The user is moving the thumb.
|
||||||
|
*
|
||||||
|
* This only records that fact; `updated()` decides what it means for
|
||||||
|
* the interval. `seekValue` follows the slider so the clocks track
|
||||||
|
* the thumb during the drag rather than jumping when it is released.
|
||||||
|
*/
|
||||||
|
private handleInput(e: Event) {
|
||||||
|
this.setSeekValue((e.target as WaSlider).value);
|
||||||
|
|
||||||
|
if (this.dragging) {
|
||||||
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
this.dragging = true;
|
||||||
|
|
||||||
|
// A drag that never commits must not strand the flag, or this fix
|
||||||
|
// turns a stall of up to one second into a permanent one -- which
|
||||||
|
// is the failure it exists to remove. `change` is the ordinary
|
||||||
|
// end; these are the ones that are not, and they are on the
|
||||||
|
// document because the pointer is routinely released outside the
|
||||||
|
// element it started in. A drag's listeners belong to the drag,
|
||||||
|
// so they go on with it and come off with it.
|
||||||
|
document.addEventListener('pointerup', this.endDrag);
|
||||||
|
document.addEventListener('pointercancel', this.endDrag);
|
||||||
|
document.addEventListener('touchend', this.endDrag);
|
||||||
|
document.addEventListener('touchcancel', this.endDrag);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Stops progress while user is dragging the thumb
|
private endDrag = () => {
|
||||||
private handleInput() {
|
document.removeEventListener('pointerup', this.endDrag);
|
||||||
this.stopProgress();
|
document.removeEventListener('pointercancel', this.endDrag);
|
||||||
}
|
document.removeEventListener('touchend', this.endDrag);
|
||||||
|
document.removeEventListener('touchcancel', this.endDrag);
|
||||||
|
|
||||||
|
this.dragging = false;
|
||||||
|
};
|
||||||
|
|
||||||
private setSeekValue(val: number) {
|
private setSeekValue(val: number) {
|
||||||
if (val < 0) val = 0;
|
if (val < 0) val = 0;
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ import '@awesome.me/webawesome/dist/components/icon/icon.js';
|
|||||||
import '@awesome.me/webawesome/dist/components/slider/slider.js';
|
import '@awesome.me/webawesome/dist/components/slider/slider.js';
|
||||||
import type WaSlider from '@awesome.me/webawesome/dist/components/slider/slider.js';
|
import type WaSlider from '@awesome.me/webawesome/dist/components/slider/slider.js';
|
||||||
import { PlayerController } from '@store/controllers/player-controller';
|
import { PlayerController } from '@store/controllers/player-controller';
|
||||||
|
import { volumeStyleStore } from '@store/volume-style-store';
|
||||||
import { designTokens } from '../../../styles/tokens.css';
|
import { designTokens } from '../../../styles/tokens.css';
|
||||||
import { waSliderLabel } from '../../../styles/wa-slider-label.css';
|
import { waSliderLabel } from '../../../styles/wa-slider-label.css';
|
||||||
|
|
||||||
@@ -22,6 +23,12 @@ export class VolumeControl extends LitElement {
|
|||||||
@state()
|
@state()
|
||||||
private showSlider = false;
|
private showSlider = false;
|
||||||
|
|
||||||
|
/** Whether this is the click-to-open popup rather than a slider. */
|
||||||
|
@state()
|
||||||
|
private popup = volumeStyleStore.popup;
|
||||||
|
|
||||||
|
private unsubscribeStyle?: () => void;
|
||||||
|
|
||||||
// Locally-tracked volume while the user is actively dragging or scrolling.
|
// Locally-tracked volume while the user is actively dragging or scrolling.
|
||||||
// The store's volume only updates once the backend echoes VolumeChanged
|
// The store's volume only updates once the backend echoes VolumeChanged
|
||||||
// (which we debounce), so we track intent here for responsive UI and to let
|
// (which we debounce), so we track intent here for responsive UI and to let
|
||||||
@@ -86,11 +93,31 @@ export class VolumeControl extends LitElement {
|
|||||||
--thumb-height: 16px;
|
--thumb-height: 16px;
|
||||||
}
|
}
|
||||||
|
|
||||||
wa-slider::part(track) {
|
.volume-popup wa-slider::part(track) {
|
||||||
background: var(--yj-text-primary, white);
|
background: var(--yj-text-primary, white);
|
||||||
height: 120px;
|
height: 120px;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* The inline slider (#42). It is the default now, so the width is
|
||||||
|
a real layout decision rather than a detail: 5em is wide enough
|
||||||
|
to aim at and narrow enough that the bottom bar's *outer*
|
||||||
|
columns stay equal without squeezing the transport — which is
|
||||||
|
the arrangement #23 depends on.
|
||||||
|
|
||||||
|
flex-shrink: 0 for the reason the top bar's children have it
|
||||||
|
(#143): a control that quietly gets narrower under pressure
|
||||||
|
hides the fact that the bar has run out of room. This one stands
|
||||||
|
down at phone width instead, in index.css, where the shell can
|
||||||
|
see the viewport. */
|
||||||
|
.inline-slider {
|
||||||
|
width: 5em;
|
||||||
|
flex-shrink: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.inline-slider::part(track) {
|
||||||
|
background: var(--yj-text-primary, white);
|
||||||
|
}
|
||||||
|
|
||||||
wa-slider::part(indicator) {
|
wa-slider::part(indicator) {
|
||||||
background: var(--yj-accent, yellow);
|
background: var(--yj-accent, yellow);
|
||||||
}
|
}
|
||||||
@@ -122,8 +149,23 @@ export class VolumeControl extends LitElement {
|
|||||||
// LIFECYCLE
|
// LIFECYCLE
|
||||||
// ===================================================================
|
// ===================================================================
|
||||||
|
|
||||||
|
override connectedCallback() {
|
||||||
|
super.connectedCallback();
|
||||||
|
|
||||||
|
this.unsubscribeStyle = volumeStyleStore.subscribe(() => {
|
||||||
|
this.popup = volumeStyleStore.popup;
|
||||||
|
|
||||||
|
// Switching to the slider while the popup is open would leave the
|
||||||
|
// document listener installed for a popup that no longer renders.
|
||||||
|
if (!this.popup) this.closeSlider();
|
||||||
|
});
|
||||||
|
|
||||||
|
void volumeStyleStore.init();
|
||||||
|
}
|
||||||
|
|
||||||
override disconnectedCallback() {
|
override disconnectedCallback() {
|
||||||
super.disconnectedCallback();
|
super.disconnectedCallback();
|
||||||
|
this.unsubscribeStyle?.();
|
||||||
document.removeEventListener('click', this.boundHandleOutsideClick);
|
document.removeEventListener('click', this.boundHandleOutsideClick);
|
||||||
clearTimeout(this.volumeDebounceTimer);
|
clearTimeout(this.volumeDebounceTimer);
|
||||||
}
|
}
|
||||||
@@ -154,10 +196,12 @@ export class VolumeControl extends LitElement {
|
|||||||
private handleOutsideClick(e: Event) {
|
private handleOutsideClick(e: Event) {
|
||||||
const path = e.composedPath();
|
const path = e.composedPath();
|
||||||
|
|
||||||
if (!path.includes(this)) {
|
if (!path.includes(this)) this.closeSlider();
|
||||||
this.showSlider = false;
|
}
|
||||||
document.removeEventListener('click', this.boundHandleOutsideClick);
|
|
||||||
}
|
private closeSlider() {
|
||||||
|
this.showSlider = false;
|
||||||
|
document.removeEventListener('click', this.boundHandleOutsideClick);
|
||||||
}
|
}
|
||||||
|
|
||||||
private handleInput(e: Event) {
|
private handleInput(e: Event) {
|
||||||
@@ -192,18 +236,46 @@ export class VolumeControl extends LitElement {
|
|||||||
override render() {
|
override render() {
|
||||||
const muted = this.player.muted;
|
const muted = this.player.muted;
|
||||||
|
|
||||||
|
// Inline, the icon is the mute toggle rather than a disclosure:
|
||||||
|
// there is nothing left to disclose, and a button that opens a
|
||||||
|
// popup containing the slider already beside it would be a control
|
||||||
|
// whose only effect is to duplicate its neighbour.
|
||||||
|
const iconAction = this.popup
|
||||||
|
? this.toggleSlider
|
||||||
|
: () => this.player.toggleMute();
|
||||||
|
const iconLabel = this.popup
|
||||||
|
? muted
|
||||||
|
? 'Muted'
|
||||||
|
: `Volume ${this.currentVolume}%`
|
||||||
|
: muted
|
||||||
|
? 'Unmute'
|
||||||
|
: 'Mute';
|
||||||
|
|
||||||
return html`
|
return html`
|
||||||
<button
|
<button
|
||||||
class=${muted ? 'muted' : ''}
|
class=${muted ? 'muted' : ''}
|
||||||
title=${muted ? 'Muted — click for volume' : 'Volume'}
|
title=${muted ? 'Muted — click for volume' : 'Volume'}
|
||||||
aria-label=${muted ? 'Muted' : `Volume ${this.currentVolume}%`}
|
aria-label=${iconLabel}
|
||||||
data-muted=${muted ? 'true' : 'false'}
|
data-muted=${muted ? 'true' : 'false'}
|
||||||
@click="${this.toggleSlider}"
|
@click="${iconAction}"
|
||||||
@wheel="${this.handleWheel}"
|
@wheel="${this.handleWheel}"
|
||||||
>
|
>
|
||||||
<wa-icon name=${this.volumeIcon}></wa-icon>
|
<wa-icon name=${this.volumeIcon}></wa-icon>
|
||||||
</button>
|
</button>
|
||||||
${this.showSlider
|
${!this.popup
|
||||||
|
? html`
|
||||||
|
<wa-slider
|
||||||
|
class="inline-slider ${muted ? 'muted' : ''}"
|
||||||
|
label="Volume"
|
||||||
|
min="0"
|
||||||
|
max="100"
|
||||||
|
.value="${this.currentVolume}"
|
||||||
|
@input="${this.handleInput}"
|
||||||
|
@wheel="${this.handleWheel}"
|
||||||
|
></wa-slider>
|
||||||
|
`
|
||||||
|
: ''}
|
||||||
|
${this.popup && this.showSlider
|
||||||
? html`
|
? html`
|
||||||
<div
|
<div
|
||||||
class="volume-popup ${muted ? 'muted' : ''}"
|
class="volume-popup ${muted ? 'muted' : ''}"
|
||||||
|
|||||||
@@ -29,6 +29,7 @@ import { nameDialogsIn } from '../../utils/name-dialog';
|
|||||||
import { ViewLifecycleMixin } from '../../utils/view-lifecycle';
|
import { ViewLifecycleMixin } from '../../utils/view-lifecycle';
|
||||||
import { confirmAction } from '../confirm-dialog/confirm-dialog';
|
import { confirmAction } from '../confirm-dialog/confirm-dialog';
|
||||||
import '@awesome.me/webawesome/dist/components/dialog/dialog.js';
|
import '@awesome.me/webawesome/dist/components/dialog/dialog.js';
|
||||||
|
import '@components/jobs/job-panel';
|
||||||
import { list } from '@utils/binding';
|
import { list } from '@utils/binding';
|
||||||
|
|
||||||
type PendingItem = autotagservice.PendingItem;
|
type PendingItem = autotagservice.PendingItem;
|
||||||
@@ -135,8 +136,20 @@ export class AutotagView extends ViewLifecycleMixin(LitElement) {
|
|||||||
padding: 0.75rem 1rem;
|
padding: 0.75rem 1rem;
|
||||||
}
|
}
|
||||||
|
|
||||||
.header {
|
/* The header and the apply-job panel share the header row.
|
||||||
|
A wrapper rather than a third grid row, because the panel
|
||||||
|
is display:none while nothing is applying and a grid
|
||||||
|
row would still spend the container's gap on it -- the
|
||||||
|
idle case, which is nearly always. */
|
||||||
|
.header-area {
|
||||||
grid-area: header;
|
grid-area: header;
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
gap: 0.5rem;
|
||||||
|
min-width: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.header {
|
||||||
display: flex;
|
display: flex;
|
||||||
align-items: center;
|
align-items: center;
|
||||||
gap: 0.75rem;
|
gap: 0.75rem;
|
||||||
@@ -1315,13 +1328,40 @@ export class AutotagView extends ViewLifecycleMixin(LitElement) {
|
|||||||
// the page only needs the folder list, which is local and may
|
// the page only needs the folder list, which is local and may
|
||||||
// have moved while the page was away.
|
// have moved while the page was away.
|
||||||
if (this.queueStarted) {
|
if (this.queueStarted) {
|
||||||
void this.loadFolders();
|
void this.loadFolders().then(() => this.openRequestedFolder());
|
||||||
} else {
|
} else {
|
||||||
this.queueStarted = true;
|
this.queueStarted = true;
|
||||||
void this.startQueue();
|
void this.startQueue().then(() => this.openRequestedFolder());
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Open the folder somebody navigated here to look at.
|
||||||
|
*
|
||||||
|
* The album page's "Review in Autotag" has to land on *that*
|
||||||
|
* album. The queue is sorted by score so the intended folder is
|
||||||
|
* often near the top, but "often" is a link that sometimes opens
|
||||||
|
* the wrong album, which is worse than no link.
|
||||||
|
*
|
||||||
|
* It is an attribute rather than a property because this is a
|
||||||
|
* **cached primary view**: `index.ts` creates it once and reuses
|
||||||
|
* it, so there is no construction to pass a value to. Which is
|
||||||
|
* also why the request is *consumed* — the attribute is removed
|
||||||
|
* once acted on, or every later visit to Autotag would reopen an
|
||||||
|
* album the user finished with three navigations ago.
|
||||||
|
*/
|
||||||
|
private openRequestedFolder(): void {
|
||||||
|
const requested = this.getAttribute('group-key');
|
||||||
|
|
||||||
|
if (!requested) return;
|
||||||
|
|
||||||
|
this.removeAttribute('group-key');
|
||||||
|
|
||||||
|
if (this.current?.groupKey === requested) return;
|
||||||
|
|
||||||
|
void this.selectFolder(requested);
|
||||||
|
}
|
||||||
|
|
||||||
protected override onViewDeactivate(): void {
|
protected override onViewDeactivate(): void {
|
||||||
this.unsubscribeLibraryStore?.();
|
this.unsubscribeLibraryStore?.();
|
||||||
this.unsubscribeLibraryStore = undefined;
|
this.unsubscribeLibraryStore = undefined;
|
||||||
@@ -3180,7 +3220,20 @@ export class AutotagView extends ViewLifecycleMixin(LitElement) {
|
|||||||
// sees a blank full-screen "Loading\u2026".
|
// sees a blank full-screen "Loading\u2026".
|
||||||
return html`
|
return html`
|
||||||
<div class="root">
|
<div class="root">
|
||||||
${this.renderHeader()}
|
<div class="header-area">
|
||||||
|
${this.renderHeader()}
|
||||||
|
<!--
|
||||||
|
Applying rewrites tags on disk, and until #27 the
|
||||||
|
only way to stop a run was the Jobs tab or the
|
||||||
|
header popover. The per-album ring says work is
|
||||||
|
happening; this is what can stop it, and what has
|
||||||
|
the log when it goes wrong.
|
||||||
|
-->
|
||||||
|
<job-panel
|
||||||
|
kinds="autotag-apply"
|
||||||
|
heading="Applying tags"
|
||||||
|
></job-panel>
|
||||||
|
</div>
|
||||||
${this.renderFolderSidebar()}
|
${this.renderFolderSidebar()}
|
||||||
${this.renderMain()}
|
${this.renderMain()}
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
@@ -7,6 +7,8 @@ import { designTokens } from '../../styles/tokens.css';
|
|||||||
import '../sidebar/app-sidebar.js';
|
import '../sidebar/app-sidebar.js';
|
||||||
import { nameDialog } from '@utils/name-dialog';
|
import { nameDialog } from '@utils/name-dialog';
|
||||||
import { ICON_PLAYLIST } from '@utils/icon-language';
|
import { ICON_PLAYLIST } from '@utils/icon-language';
|
||||||
|
import { ActiveViewController } from '@store/controllers/active-view-controller';
|
||||||
|
import { ViewVisibilityController } from '@store/controllers/view-visibility-controller';
|
||||||
|
|
||||||
type View = 'home' | 'albums' | 'tracks' | 'playlists';
|
type View = 'home' | 'albums' | 'tracks' | 'playlists';
|
||||||
|
|
||||||
@@ -114,8 +116,35 @@ export class BottomNav extends LitElement {
|
|||||||
}
|
}
|
||||||
`];
|
`];
|
||||||
|
|
||||||
@state()
|
/**
|
||||||
private activeView = 'home';
|
* Which tab is lit, read from the shell rather than tracked here.
|
||||||
|
*
|
||||||
|
* This was a `@state()` field set from the `navigate` event, which
|
||||||
|
* only the outbound path dispatches -- so backing out of a detail
|
||||||
|
* view left the highlight wherever it had been (#72). It had no
|
||||||
|
* equivalent of `app-sidebar`'s `navItems.some(...)` guard either,
|
||||||
|
* so a detail view set it to a name matching no tab and *nothing*
|
||||||
|
* was lit; that asymmetry is why one nav looked broken and the
|
||||||
|
* other looked fine. The store answers both: a detail view leaves
|
||||||
|
* the tab it was opened from lit, in both components.
|
||||||
|
*/
|
||||||
|
private activeCtrl = new ActiveViewController(this);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The tab bar honours the sidebar's toggles (#25), and the reason is
|
||||||
|
* inside this component rather than a general rule about phones.
|
||||||
|
* `PHONE_COLUMN_IDS` is the precedent for "what a phone shows is a
|
||||||
|
* different question", and it would apply here too -- except that
|
||||||
|
* "More" opens the *same* `<app-sidebar>`, which filters. An
|
||||||
|
* unfiltered bar would therefore contradict its own drawer, one tap
|
||||||
|
* apart, and a destination the user switched off is off wherever it
|
||||||
|
* is offered.
|
||||||
|
*
|
||||||
|
* Which four tabs remains plan 016's committed subset; this only
|
||||||
|
* removes from it. Hiding all four leaves "More", which is always
|
||||||
|
* present and reaches everything.
|
||||||
|
*/
|
||||||
|
private visibilityCtrl = new ViewVisibilityController(this);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Whether the drawer has been asked for.
|
* Whether the drawer has been asked for.
|
||||||
@@ -167,12 +196,9 @@ export class BottomNav extends LitElement {
|
|||||||
nameDialog(this.drawer);
|
nameDialog(this.drawer);
|
||||||
}
|
}
|
||||||
|
|
||||||
private onGlobalNavigate = (e: Event) => {
|
private onGlobalNavigate = () => {
|
||||||
const detail = (e as CustomEvent<{ view?: string }>).detail;
|
|
||||||
|
|
||||||
if (detail?.view) this.activeView = detail.view;
|
|
||||||
|
|
||||||
// A navigation from inside the drawer is the drawer's job done.
|
// A navigation from inside the drawer is the drawer's job done.
|
||||||
|
// The highlight is not this listener's business any more.
|
||||||
this.drawerOpen = false;
|
this.drawerOpen = false;
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -202,13 +228,17 @@ export class BottomNav extends LitElement {
|
|||||||
return html`
|
return html`
|
||||||
<nav aria-label="Primary">
|
<nav aria-label="Primary">
|
||||||
<ul>
|
<ul>
|
||||||
${BottomNav.TABS.map((tab) => html`
|
${BottomNav.TABS
|
||||||
|
.filter((tab) => this.visibilityCtrl.visible(tab.id))
|
||||||
|
.map((tab) => html`
|
||||||
<li>
|
<li>
|
||||||
<button
|
<button
|
||||||
type="button"
|
type="button"
|
||||||
class=${this.activeView === tab.id ? 'active' : ''}
|
class=${this.activeCtrl.isActive(tab.id)
|
||||||
|
? 'active'
|
||||||
|
: ''}
|
||||||
data-testid="tab-${tab.id}"
|
data-testid="tab-${tab.id}"
|
||||||
aria-current=${this.activeView === tab.id
|
aria-current=${this.activeCtrl.isActive(tab.id)
|
||||||
? 'page'
|
? 'page'
|
||||||
: 'false'}
|
: 'false'}
|
||||||
@click=${() => this.navigate(tab.id)}
|
@click=${() => this.navigate(tab.id)}
|
||||||
|
|||||||
@@ -9,7 +9,13 @@ import {
|
|||||||
RemoveLibrary,
|
RemoveLibrary,
|
||||||
GetRemovalImpact,
|
GetRemovalImpact,
|
||||||
GetAllLibrariesWithTrackCounts,
|
GetAllLibrariesWithTrackCounts,
|
||||||
|
ScanLibrary,
|
||||||
|
ScanAllLibraries,
|
||||||
|
FullRescan,
|
||||||
} from '@go/library/library.js';
|
} from '@go/library/library.js';
|
||||||
|
import { jobStore } from '@store/job-store';
|
||||||
|
import type { Job } from '@store/job-store';
|
||||||
|
import '@components/jobs/job-panel';
|
||||||
import {
|
import {
|
||||||
GetScanConcurrency,
|
GetScanConcurrency,
|
||||||
SetScanConcurrency,
|
SetScanConcurrency,
|
||||||
@@ -19,6 +25,8 @@ import {
|
|||||||
SetQueueFallback,
|
SetQueueFallback,
|
||||||
GetAllowMeteredCatalogDownload,
|
GetAllowMeteredCatalogDownload,
|
||||||
SetAllowMeteredCatalogDownload,
|
SetAllowMeteredCatalogDownload,
|
||||||
|
GetPopupVolume,
|
||||||
|
SetPopupVolume,
|
||||||
} from '@go/config/config.js';
|
} from '@go/config/config.js';
|
||||||
import { GetIndexStatus } from '@go/explore/service.js';
|
import { GetIndexStatus } from '@go/explore/service.js';
|
||||||
import { notificationStore } from '@store/notification-store';
|
import { notificationStore } from '@store/notification-store';
|
||||||
@@ -27,6 +35,9 @@ import type * as library from '@go/library/models.js';
|
|||||||
import { ThemeController } from '@store/controllers/theme-controller';
|
import { ThemeController } from '@store/controllers/theme-controller';
|
||||||
import { TrackListController } from '@store/controllers/tracklist-controller';
|
import { TrackListController } from '@store/controllers/tracklist-controller';
|
||||||
import { FavoritesController } from '@store/controllers/favorites-controller';
|
import { FavoritesController } from '@store/controllers/favorites-controller';
|
||||||
|
import { ViewVisibilityController } from '@store/controllers/view-visibility-controller';
|
||||||
|
import { VIEW_META } from '../../services/view-meta';
|
||||||
|
import { downloadStore } from '@store/download-store';
|
||||||
import { GetAllPlaylists } from '@go/playlist/service.js';
|
import { GetAllPlaylists } from '@go/playlist/service.js';
|
||||||
import type * as playlist from '@go/playlist/models.js';
|
import type * as playlist from '@go/playlist/models.js';
|
||||||
import { Events } from '../../events';
|
import { Events } from '../../events';
|
||||||
@@ -71,6 +82,27 @@ export class ConfigPage extends ViewLifecycleMixin(LitElement) {
|
|||||||
// --- Favorites controller ---
|
// --- Favorites controller ---
|
||||||
private favCtrl = new FavoritesController(this);
|
private favCtrl = new FavoritesController(this);
|
||||||
|
|
||||||
|
/** Which destinations the navigation offers (#25). */
|
||||||
|
private viewsCtrl = new ViewVisibilityController(this);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The job snapshot, for the per-library scan status (#27).
|
||||||
|
*
|
||||||
|
* Held as state rather than read from the store in `render()` so
|
||||||
|
* Lit sees the dependency: the store notifies, and a getter read
|
||||||
|
* inside a template is not a reactive input.
|
||||||
|
*/
|
||||||
|
@state() private jobs: Job[] = [];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set between pressing a scan button and the job snapshot that
|
||||||
|
* proves it started -- `JobsChanged` is coalesced at 250 ms, which
|
||||||
|
* is long enough for a second click to start a second scan.
|
||||||
|
*/
|
||||||
|
@state() private startingScan = false;
|
||||||
|
|
||||||
|
private unsubscribeJobs: (() => void) | null = null;
|
||||||
|
|
||||||
// --- Shortcuts controller ---
|
// --- Shortcuts controller ---
|
||||||
private shortcutsCtrl = new ShortcutsController(this);
|
private shortcutsCtrl = new ShortcutsController(this);
|
||||||
|
|
||||||
@@ -95,6 +127,8 @@ export class ConfigPage extends ViewLifecycleMixin(LitElement) {
|
|||||||
@state() private concurrencyMode = 'auto';
|
@state() private concurrencyMode = 'auto';
|
||||||
@state() private defaultPage = 'home';
|
@state() private defaultPage = 'home';
|
||||||
@state() private queueFallback = 'favorites';
|
@state() private queueFallback = 'favorites';
|
||||||
|
|
||||||
|
@state() private popupVolume = false;
|
||||||
@state() private indexStatus: explore.IndexStatus | null = null;
|
@state() private indexStatus: explore.IndexStatus | null = null;
|
||||||
/** Three states, not one: the panel used to say "Loading status…"
|
/** Three states, not one: the panel used to say "Loading status…"
|
||||||
* for the entire session, because the only thing that ever set
|
* for the entire session, because the only thing that ever set
|
||||||
@@ -469,6 +503,12 @@ export class ConfigPage extends ViewLifecycleMixin(LitElement) {
|
|||||||
flex: 1;
|
flex: 1;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.view-note {
|
||||||
|
color: var(--yj-text-tertiary, #888);
|
||||||
|
font-size: var(--yj-font-size-sm, 0.85rem);
|
||||||
|
margin-left: auto;
|
||||||
|
}
|
||||||
|
|
||||||
.column-arrows {
|
.column-arrows {
|
||||||
display: flex;
|
display: flex;
|
||||||
gap: 0.15em;
|
gap: 0.15em;
|
||||||
@@ -852,8 +892,14 @@ export class ConfigPage extends ViewLifecycleMixin(LitElement) {
|
|||||||
this.scrollMode =
|
this.scrollMode =
|
||||||
localStorage.getItem(SCROLL_STORAGE_KEY) || 'hover';
|
localStorage.getItem(SCROLL_STORAGE_KEY) || 'hover';
|
||||||
|
|
||||||
// Scan progress lives in the jobs panel now — this page only
|
// Scanning is started and watched here (#27), so the job
|
||||||
// needs to know when the library list itself changes.
|
// snapshot is a live input to this page.
|
||||||
|
this.unsubscribeJobs = jobStore.subscribe(() => {
|
||||||
|
this.jobs = jobStore.jobs;
|
||||||
|
});
|
||||||
|
this.jobs = jobStore.jobs;
|
||||||
|
void jobStore.init();
|
||||||
|
|
||||||
this.cancelLibraryAdded = EventsOn(
|
this.cancelLibraryAdded = EventsOn(
|
||||||
Events.LibraryAdded,
|
Events.LibraryAdded,
|
||||||
() => void this.loadLibraries(),
|
() => void this.loadLibraries(),
|
||||||
@@ -884,6 +930,9 @@ export class ConfigPage extends ViewLifecycleMixin(LitElement) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
protected override onViewDeactivate(): void {
|
protected override onViewDeactivate(): void {
|
||||||
|
this.unsubscribeJobs?.();
|
||||||
|
this.unsubscribeJobs = null;
|
||||||
|
|
||||||
this.cancelLibraryAdded?.();
|
this.cancelLibraryAdded?.();
|
||||||
this.cancelLibraryRenamed?.();
|
this.cancelLibraryRenamed?.();
|
||||||
this.cancelLibraryRemoved?.();
|
this.cancelLibraryRemoved?.();
|
||||||
@@ -893,20 +942,28 @@ export class ConfigPage extends ViewLifecycleMixin(LitElement) {
|
|||||||
|
|
||||||
private async loadLibraries(): Promise<void> {
|
private async loadLibraries(): Promise<void> {
|
||||||
try {
|
try {
|
||||||
const [libs, mode, defaultPage, queueFallback, allowMetered] =
|
const [
|
||||||
await Promise.all([
|
libs,
|
||||||
GetAllLibrariesWithTrackCounts(),
|
mode,
|
||||||
GetScanConcurrency(),
|
defaultPage,
|
||||||
GetDefaultPage(),
|
queueFallback,
|
||||||
GetQueueFallback(),
|
allowMetered,
|
||||||
GetAllowMeteredCatalogDownload(),
|
popupVolume,
|
||||||
]);
|
] = await Promise.all([
|
||||||
|
GetAllLibrariesWithTrackCounts(),
|
||||||
|
GetScanConcurrency(),
|
||||||
|
GetDefaultPage(),
|
||||||
|
GetQueueFallback(),
|
||||||
|
GetAllowMeteredCatalogDownload(),
|
||||||
|
GetPopupVolume(),
|
||||||
|
]);
|
||||||
|
|
||||||
this.libraries = libs ?? [];
|
this.libraries = libs ?? [];
|
||||||
this.concurrencyMode = mode;
|
this.concurrencyMode = mode;
|
||||||
this.defaultPage = defaultPage;
|
this.defaultPage = defaultPage;
|
||||||
this.queueFallback = queueFallback;
|
this.queueFallback = queueFallback;
|
||||||
this.allowMeteredCatalogDownload = allowMetered;
|
this.allowMeteredCatalogDownload = allowMetered;
|
||||||
|
this.popupVolume = popupVolume;
|
||||||
|
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
console.error(
|
console.error(
|
||||||
@@ -1084,6 +1141,133 @@ export class ConfigPage extends ViewLifecycleMixin(LitElement) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ===================================================================
|
||||||
|
// SCANNING (#27 — back from the Jobs tab)
|
||||||
|
// ===================================================================
|
||||||
|
|
||||||
|
/** The scan job for a library, if one is registered. */
|
||||||
|
private jobForLibrary(id: number): Job | undefined {
|
||||||
|
return this.jobs.find((job) => job.id === `scan:${id}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The status line under a library name while it is being scanned. */
|
||||||
|
private libraryScanStatus(id: number): string | null {
|
||||||
|
const job = this.jobForLibrary(id);
|
||||||
|
|
||||||
|
if (!job) return null;
|
||||||
|
|
||||||
|
switch (job.state) {
|
||||||
|
case 'running':
|
||||||
|
return job.phase ? `Scanning · ${job.phase}` : 'Scanning';
|
||||||
|
case 'queued':
|
||||||
|
return 'Queued';
|
||||||
|
case 'paused':
|
||||||
|
return 'Paused';
|
||||||
|
case 'pausing':
|
||||||
|
return 'Pausing…';
|
||||||
|
case 'cancelling':
|
||||||
|
return 'Stopping…';
|
||||||
|
default:
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private get anyScanning(): boolean {
|
||||||
|
return this.libraries.some(
|
||||||
|
(lib) => this.libraryScanStatus(lib.id) !== null,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Run something that starts a job, holding the buttons until the
|
||||||
|
* snapshot lands and saying so when it does not start at all.
|
||||||
|
*
|
||||||
|
* Persistent, not a toast: the user asked for work to happen, it
|
||||||
|
* did not, and retrying is exactly the useful response.
|
||||||
|
*/
|
||||||
|
private async startJob(
|
||||||
|
what: string,
|
||||||
|
start: () => Promise<unknown>,
|
||||||
|
retry: () => void,
|
||||||
|
): Promise<void> {
|
||||||
|
if (this.startingScan) return;
|
||||||
|
|
||||||
|
this.startingScan = true;
|
||||||
|
|
||||||
|
try {
|
||||||
|
await start();
|
||||||
|
} catch (err) {
|
||||||
|
console.error(`${what} failed:`, err);
|
||||||
|
notificationStore.persistent({
|
||||||
|
key: 'scan-start',
|
||||||
|
title: 'Scan did not start',
|
||||||
|
text: `${what} failed. ${describeError(err)}`,
|
||||||
|
detail: String(err),
|
||||||
|
action: { label: 'Try again', run: retry },
|
||||||
|
});
|
||||||
|
} finally {
|
||||||
|
this.startingScan = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private handleScanLibrary = (id: number): void => {
|
||||||
|
this.activeMenuId = null;
|
||||||
|
void this.startJob(
|
||||||
|
'Scanning that library',
|
||||||
|
() => ScanLibrary(id),
|
||||||
|
() => this.handleScanLibrary(id),
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
private handleScanAll = (): void => {
|
||||||
|
void this.startJob(
|
||||||
|
'Scanning your libraries',
|
||||||
|
() => ScanAllLibraries(),
|
||||||
|
() => this.handleScanAll(),
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
private handleFullRescan = async (): Promise<void> => {
|
||||||
|
const ok = await confirmAction({
|
||||||
|
title: 'Full rescan',
|
||||||
|
message:
|
||||||
|
'This deletes all library data — including downloaded '
|
||||||
|
+ 'cover art — and rebuilds it from your files.',
|
||||||
|
impact:
|
||||||
|
'It is not the same as “Scan now”, which only picks up '
|
||||||
|
+ 'what changed.',
|
||||||
|
confirmLabel: 'Rebuild everything',
|
||||||
|
danger: true,
|
||||||
|
});
|
||||||
|
|
||||||
|
if (!ok) return;
|
||||||
|
|
||||||
|
await this.startJob(
|
||||||
|
'The full rescan',
|
||||||
|
() => FullRescan(),
|
||||||
|
() => void this.handleFullRescan(),
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
private handleViewToggle = (
|
||||||
|
view: string,
|
||||||
|
visible: boolean,
|
||||||
|
): void => {
|
||||||
|
this.viewsCtrl
|
||||||
|
.setVisible(view, visible)
|
||||||
|
.catch((err: unknown) => {
|
||||||
|
console.error('Failed to save view visibility:', err);
|
||||||
|
notificationStore.transient({
|
||||||
|
key: 'view-visibility',
|
||||||
|
text: `Could not change which views are shown. ${describeError(err)}`,
|
||||||
|
detail: String(err),
|
||||||
|
});
|
||||||
|
// The checkbox has already flipped itself; the store is
|
||||||
|
// the truth, so redraw from it.
|
||||||
|
this.requestUpdate();
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
private handleDefaultPageChange = (
|
private handleDefaultPageChange = (
|
||||||
e: CustomEvent<ConfigFieldChangeEvent>,
|
e: CustomEvent<ConfigFieldChangeEvent>,
|
||||||
): void => {
|
): void => {
|
||||||
@@ -1428,6 +1612,7 @@ export class ConfigPage extends ViewLifecycleMixin(LitElement) {
|
|||||||
-->
|
-->
|
||||||
${this.renderLibrarySection()}
|
${this.renderLibrarySection()}
|
||||||
${this.renderGeneralSection()}
|
${this.renderGeneralSection()}
|
||||||
|
${this.renderNavigationSection()}
|
||||||
${this.renderNowPlayingSection()}
|
${this.renderNowPlayingSection()}
|
||||||
${this.renderThemeSection()}
|
${this.renderThemeSection()}
|
||||||
${this.renderTrackListSection()}
|
${this.renderTrackListSection()}
|
||||||
@@ -1522,6 +1707,20 @@ export class ConfigPage extends ViewLifecycleMixin(LitElement) {
|
|||||||
.value=${this.allowMeteredCatalogDownload}
|
.value=${this.allowMeteredCatalogDownload}
|
||||||
@config-change=${this.handleAllowMeteredChange}
|
@config-change=${this.handleAllowMeteredChange}
|
||||||
></config-field>
|
></config-field>
|
||||||
|
|
||||||
|
<!--
|
||||||
|
The tier list above says what the build is *doing*;
|
||||||
|
this says it is a job, and gives it the pause, cancel
|
||||||
|
and log the tier list never had (#27). Cancelling one
|
||||||
|
still asks first — that confirmation is inside
|
||||||
|
applyJobControl, keyed on the kind, which is why
|
||||||
|
this embeds the shared rows rather than drawing its
|
||||||
|
own.
|
||||||
|
-->
|
||||||
|
<job-panel
|
||||||
|
kinds="index-build,catalog-enrich"
|
||||||
|
heading="Index jobs"
|
||||||
|
></job-panel>
|
||||||
</config-section>
|
</config-section>
|
||||||
`;
|
`;
|
||||||
}
|
}
|
||||||
@@ -1642,18 +1841,15 @@ export class ConfigPage extends ViewLifecycleMixin(LitElement) {
|
|||||||
description:
|
description:
|
||||||
'The page the app opens to on launch.',
|
'The page the app opens to on launch.',
|
||||||
type: 'select' as const,
|
type: 'select' as const,
|
||||||
options: [
|
// Derived, not written out: this list was a
|
||||||
{ value: 'home', label: 'Home' },
|
// second copy of the launchable set, and #27
|
||||||
{ value: 'tracks', label: 'Tracks' },
|
// removing a destination is exactly the change
|
||||||
{ value: 'albums', label: 'Albums' },
|
// that would have left the two disagreeing.
|
||||||
{ value: 'artists', label: 'Artists' },
|
// Settings is excluded because it is the one
|
||||||
{ value: 'genres', label: 'Genres' },
|
// view the backend refuses to launch into.
|
||||||
{ value: 'playlists', label: 'Playlists' },
|
options: VIEW_META
|
||||||
{ value: 'explore', label: 'Explore' },
|
.filter((v) => v.alwaysShown !== true)
|
||||||
{ value: 'downloads', label: 'Downloads' },
|
.map((v) => ({ value: v.id, label: v.label })),
|
||||||
{ value: 'autotag', label: 'Autotag' },
|
|
||||||
{ value: 'jobs', label: 'Jobs' },
|
|
||||||
],
|
|
||||||
}}
|
}}
|
||||||
.value=${this.defaultPage}
|
.value=${this.defaultPage}
|
||||||
@config-change=${this.handleDefaultPageChange}
|
@config-change=${this.handleDefaultPageChange}
|
||||||
@@ -1674,6 +1870,120 @@ export class ConfigPage extends ViewLifecycleMixin(LitElement) {
|
|||||||
.value=${this.queueFallback}
|
.value=${this.queueFallback}
|
||||||
@config-change=${this.handleQueueFallbackChange}
|
@config-change=${this.handleQueueFallbackChange}
|
||||||
></config-field>
|
></config-field>
|
||||||
|
<config-field
|
||||||
|
.schema=${{
|
||||||
|
key: 'popupVolume',
|
||||||
|
label: 'Volume opens in a popup',
|
||||||
|
description:
|
||||||
|
'Off, the volume slider is always visible in the '
|
||||||
|
+ 'player bar. On, it hides behind the speaker '
|
||||||
|
+ 'icon. The slider stands down on a phone either '
|
||||||
|
+ 'way, where the hardware keys own volume.',
|
||||||
|
type: 'toggle' as const,
|
||||||
|
}}
|
||||||
|
.value=${this.popupVolume}
|
||||||
|
@config-change=${this.handlePopupVolumeChange}
|
||||||
|
></config-field>
|
||||||
|
</config-section>
|
||||||
|
`;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The volume control's presentation (#42).
|
||||||
|
*
|
||||||
|
* In General rather than beside the theme because it is about the
|
||||||
|
* transport's behaviour rather than its colours, and next to "When
|
||||||
|
* the Queue Ends" because both are answers to "how should the
|
||||||
|
* player behave".
|
||||||
|
*/
|
||||||
|
private handlePopupVolumeChange = (
|
||||||
|
e: CustomEvent<ConfigFieldChangeEvent>,
|
||||||
|
): void => {
|
||||||
|
const popup = Boolean(e.detail.value);
|
||||||
|
const previous = this.popupVolume;
|
||||||
|
|
||||||
|
this.popupVolume = popup;
|
||||||
|
|
||||||
|
void SetPopupVolume(popup).catch((err: unknown) => {
|
||||||
|
console.error('failed to save the volume control setting', err);
|
||||||
|
this.popupVolume = previous;
|
||||||
|
notificationStore.transient({
|
||||||
|
key: 'popup-volume-setting',
|
||||||
|
title: 'Setting not saved',
|
||||||
|
text: describeError(err, 'That setting could not be saved.'),
|
||||||
|
});
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
// --- Navigation section ---
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Which destinations the sidebar and the phone's tab bar offer.
|
||||||
|
*
|
||||||
|
* Two items are drawn but not editable, and both say why in place
|
||||||
|
* rather than being silently inert. Settings is never hideable --
|
||||||
|
* the backend refuses it too, because `config.toml` is
|
||||||
|
* hand-editable. The launch page is not hideable *while it is the
|
||||||
|
* launch page*, which is a state the user can leave by changing the
|
||||||
|
* launch page above; refusing is preferable to the alternatives,
|
||||||
|
* since resetting their launch page silently changes a second thing
|
||||||
|
* they chose and allowing it lands the app on a page nothing points
|
||||||
|
* at.
|
||||||
|
*/
|
||||||
|
private renderNavigationSection() {
|
||||||
|
return html`
|
||||||
|
<config-section
|
||||||
|
heading="Navigation"
|
||||||
|
description="Choose which destinations the sidebar and the phone's tab bar offer. Hiding one does not remove it — links and the launch page still open it."
|
||||||
|
>
|
||||||
|
<ul class="column-list">
|
||||||
|
${repeat(VIEW_META, (v) => v.id, (v) => {
|
||||||
|
const checked = this.viewsCtrl.enabled(v.id);
|
||||||
|
const isLaunchPage = this.defaultPage === v.id;
|
||||||
|
const locked = v.alwaysShown === true || isLaunchPage;
|
||||||
|
|
||||||
|
let note = '';
|
||||||
|
|
||||||
|
if (v.alwaysShown === true) {
|
||||||
|
note = 'Always shown.';
|
||||||
|
} else if (isLaunchPage) {
|
||||||
|
note = 'This is the launch page.';
|
||||||
|
} else if (
|
||||||
|
v.id === 'downloads' &&
|
||||||
|
checked &&
|
||||||
|
!downloadStore.available
|
||||||
|
) {
|
||||||
|
// The config says show it and the nav does not, which
|
||||||
|
// would otherwise read as the checkbox not working.
|
||||||
|
note = 'Hidden until a download client is configured.';
|
||||||
|
}
|
||||||
|
|
||||||
|
return html`
|
||||||
|
<li
|
||||||
|
class="column-item ${checked ? 'enabled' : 'disabled'}"
|
||||||
|
>
|
||||||
|
<input
|
||||||
|
type="checkbox"
|
||||||
|
class="column-toggle"
|
||||||
|
aria-label="Show ${v.label} in the navigation"
|
||||||
|
.checked=${checked}
|
||||||
|
?disabled=${locked}
|
||||||
|
@change=${(e: Event) =>
|
||||||
|
this.handleViewToggle(
|
||||||
|
v.id,
|
||||||
|
(e.target as HTMLInputElement).checked,
|
||||||
|
)}
|
||||||
|
/>
|
||||||
|
<span class="column-label">
|
||||||
|
${v.label}
|
||||||
|
</span>
|
||||||
|
${note
|
||||||
|
? html`<span class="view-note">${note}</span>`
|
||||||
|
: nothing}
|
||||||
|
</li>
|
||||||
|
`;
|
||||||
|
})}
|
||||||
|
</ul>
|
||||||
</config-section>
|
</config-section>
|
||||||
`;
|
`;
|
||||||
}
|
}
|
||||||
@@ -2056,8 +2366,8 @@ export class ConfigPage extends ViewLifecycleMixin(LitElement) {
|
|||||||
return html`
|
return html`
|
||||||
<config-section
|
<config-section
|
||||||
heading="Libraries"
|
heading="Libraries"
|
||||||
description="Manage your music library folders. Scanning and its
|
description="Manage your music library folders, and scan them
|
||||||
progress live in the Jobs panel."
|
for new and changed files."
|
||||||
.open=${true}
|
.open=${true}
|
||||||
>
|
>
|
||||||
<div class="scan-actions">
|
<div class="scan-actions">
|
||||||
@@ -2067,6 +2377,23 @@ export class ConfigPage extends ViewLifecycleMixin(LitElement) {
|
|||||||
>
|
>
|
||||||
Add Library
|
Add Library
|
||||||
</button>
|
</button>
|
||||||
|
<button
|
||||||
|
?disabled=${this.anyScanning
|
||||||
|
|| this.startingScan
|
||||||
|
|| this.libraries.length === 0}
|
||||||
|
@click=${this.handleScanAll}
|
||||||
|
>
|
||||||
|
Scan All
|
||||||
|
</button>
|
||||||
|
<button
|
||||||
|
class="btn-danger"
|
||||||
|
?disabled=${this.anyScanning
|
||||||
|
|| this.startingScan
|
||||||
|
|| this.libraries.length === 0}
|
||||||
|
@click=${this.handleFullRescan}
|
||||||
|
>
|
||||||
|
Full Rescan
|
||||||
|
</button>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
${this.libraries.length > 0
|
${this.libraries.length > 0
|
||||||
@@ -2104,7 +2431,8 @@ export class ConfigPage extends ViewLifecycleMixin(LitElement) {
|
|||||||
<span class="library-count">
|
<span class="library-count">
|
||||||
${this.removingLibraryId === lib.id
|
${this.removingLibraryId === lib.id
|
||||||
? 'Removing…'
|
? 'Removing…'
|
||||||
: html`${lib.trackCount} tracks`}
|
: this.libraryScanStatus(lib.id)
|
||||||
|
?? html`${lib.trackCount} tracks`}
|
||||||
</span>
|
</span>
|
||||||
<div class="overflow-wrapper">
|
<div class="overflow-wrapper">
|
||||||
<button
|
<button
|
||||||
@@ -2127,6 +2455,16 @@ export class ConfigPage extends ViewLifecycleMixin(LitElement) {
|
|||||||
>
|
>
|
||||||
Rename
|
Rename
|
||||||
</div>
|
</div>
|
||||||
|
${this.libraryScanStatus(lib.id) === null
|
||||||
|
? html`
|
||||||
|
<div
|
||||||
|
class="overflow-item"
|
||||||
|
@click=${() => this.handleScanLibrary(lib.id)}
|
||||||
|
>
|
||||||
|
Scan now
|
||||||
|
</div>
|
||||||
|
`
|
||||||
|
: nothing}
|
||||||
<div
|
<div
|
||||||
class="overflow-item overflow-item--danger"
|
class="overflow-item overflow-item--danger"
|
||||||
@click=${() => void this.handleRemoveClick(lib.id)}
|
@click=${() => void this.handleRemoveClick(lib.id)}
|
||||||
@@ -2170,6 +2508,11 @@ export class ConfigPage extends ViewLifecycleMixin(LitElement) {
|
|||||||
@config-change=${this.handleConcurrencyChange}
|
@config-change=${this.handleConcurrencyChange}
|
||||||
></config-field>
|
></config-field>
|
||||||
|
|
||||||
|
<job-panel
|
||||||
|
kinds="library-scan"
|
||||||
|
heading="Scans"
|
||||||
|
></job-panel>
|
||||||
|
|
||||||
</config-section>
|
</config-section>
|
||||||
`;
|
`;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -22,6 +22,7 @@ import { compact } from '@utils/binding';
|
|||||||
import { describeError, explainError } from '@utils/describe-error';
|
import { describeError, explainError } from '@utils/describe-error';
|
||||||
import { confirmAction } from '@components/confirm-dialog/confirm-dialog';
|
import { confirmAction } from '@components/confirm-dialog/confirm-dialog';
|
||||||
import './config-section';
|
import './config-section';
|
||||||
|
import '@components/jobs/job-panel';
|
||||||
import { pickDirectory } from '../../utils/pick-directory';
|
import { pickDirectory } from '../../utils/pick-directory';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -274,6 +275,17 @@ export class DownloadClients extends LitElement {
|
|||||||
</wa-button>
|
</wa-button>
|
||||||
</div>
|
</div>
|
||||||
`}
|
`}
|
||||||
|
|
||||||
|
<!--
|
||||||
|
The Downloads view already shows every download's
|
||||||
|
lifecycle state; what it has never had is pause,
|
||||||
|
cancel and the log, which the Jobs tab carried (#27).
|
||||||
|
Renders nothing while nothing is downloading.
|
||||||
|
-->
|
||||||
|
<job-panel
|
||||||
|
kinds="download"
|
||||||
|
heading="Downloads in progress"
|
||||||
|
></job-panel>
|
||||||
</config-section>
|
</config-section>
|
||||||
|
|
||||||
<config-section
|
<config-section
|
||||||
|
|||||||
@@ -81,23 +81,55 @@ export class ConfirmDialog extends LitElement {
|
|||||||
`,
|
`,
|
||||||
];
|
];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Which question is on screen.
|
||||||
|
*
|
||||||
|
* This is a singleton reused for every confirmation in the app,
|
||||||
|
* and `wa-dialog` reports its close *asynchronously* — `open =
|
||||||
|
* false` starts an animation and `wa-hide` arrives after it. So a
|
||||||
|
* hide belonging to a question that has already been answered can
|
||||||
|
* land after the *next* question has opened, and cancel it: the
|
||||||
|
* user is asked something, the dialog vanishes on its own, and the
|
||||||
|
* call site is told they said no.
|
||||||
|
*
|
||||||
|
* The counter is what tells one question from the next. Every
|
||||||
|
* close bumps it, and the `wa-hide` handler carries the id its
|
||||||
|
* template was rendered with.
|
||||||
|
*/
|
||||||
|
private askSeq = 0;
|
||||||
|
|
||||||
/** Ask. Resolves true if the user went ahead. */
|
/** Ask. Resolves true if the user went ahead. */
|
||||||
ask(request: ConfirmRequest): Promise<boolean> {
|
ask(request: ConfirmRequest): Promise<boolean> {
|
||||||
this.close(false);
|
this.close(false);
|
||||||
|
|
||||||
|
const id = ++this.askSeq;
|
||||||
|
|
||||||
this.request = request;
|
this.request = request;
|
||||||
|
|
||||||
return new Promise<boolean>((resolve) => {
|
return new Promise<boolean>((resolve) => {
|
||||||
this.settle = resolve;
|
this.settle = resolve;
|
||||||
void this.updateComplete.then(() => {
|
void this.updateComplete.then(() => {
|
||||||
if (this.dialog) this.dialog.open = true;
|
// A third question could have arrived while this one
|
||||||
|
// was waiting for its own render.
|
||||||
|
if (this.askSeq === id && this.dialog) this.dialog.open = true;
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
private close(ok: boolean): void {
|
/**
|
||||||
|
* Settle the current question, if `id` still names it.
|
||||||
|
*
|
||||||
|
* The button handlers pass nothing and always mean the question on
|
||||||
|
* screen; only `wa-hide` carries an id, because only `wa-hide` can
|
||||||
|
* arrive late.
|
||||||
|
*/
|
||||||
|
private close(ok: boolean, id = this.askSeq): void {
|
||||||
|
if (id !== this.askSeq) return;
|
||||||
|
|
||||||
const settle = this.settle;
|
const settle = this.settle;
|
||||||
|
|
||||||
this.settle = null;
|
this.settle = null;
|
||||||
|
this.askSeq++;
|
||||||
|
|
||||||
if (this.dialog) this.dialog.open = false;
|
if (this.dialog) this.dialog.open = false;
|
||||||
this.request = null;
|
this.request = null;
|
||||||
@@ -118,11 +150,15 @@ export class ConfirmDialog extends LitElement {
|
|||||||
|
|
||||||
if (!request) return nothing;
|
if (!request) return nothing;
|
||||||
|
|
||||||
|
// Captured at render time, so the handler answers the question
|
||||||
|
// it was drawn for and not whichever one is up when it fires.
|
||||||
|
const id = this.askSeq;
|
||||||
|
|
||||||
return html`
|
return html`
|
||||||
<wa-dialog
|
<wa-dialog
|
||||||
label=${request.title}
|
label=${request.title}
|
||||||
data-testid="confirm-dialog"
|
data-testid="confirm-dialog"
|
||||||
@wa-hide=${() => this.close(false)}
|
@wa-hide=${() => this.close(false, id)}
|
||||||
>
|
>
|
||||||
<p>${request.message}</p>
|
<p>${request.message}</p>
|
||||||
${request.impact
|
${request.impact
|
||||||
|
|||||||
@@ -246,7 +246,7 @@ export class DownloadPicker extends LitElement {
|
|||||||
return html`
|
return html`
|
||||||
<wa-callout variant="success">
|
<wa-callout variant="success">
|
||||||
Found a clear match and started downloading it. Progress is
|
Found a clear match and started downloading it. Progress is
|
||||||
in the background jobs panel.
|
on the Downloads page.
|
||||||
</wa-callout>
|
</wa-callout>
|
||||||
`;
|
`;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,6 +3,7 @@ import { customElement, state } from 'lit/decorators.js';
|
|||||||
import '@awesome.me/webawesome/dist/components/icon/icon.js';
|
import '@awesome.me/webawesome/dist/components/icon/icon.js';
|
||||||
import '@awesome.me/webawesome/dist/components/button/button.js';
|
import '@awesome.me/webawesome/dist/components/button/button.js';
|
||||||
import '@components/page-header/page-header';
|
import '@components/page-header/page-header';
|
||||||
|
import type { PageAction } from '@components/page-header/page-header';
|
||||||
import { designTokens } from '../../styles/tokens.css';
|
import { designTokens } from '../../styles/tokens.css';
|
||||||
import { downloadStore, stateLabel } from '@store/download-store';
|
import { downloadStore, stateLabel } from '@store/download-store';
|
||||||
import type { Request, RequestSummary, DownloadView as DownloadRecord } from '@store/download-store';
|
import type { Request, RequestSummary, DownloadView as DownloadRecord } from '@store/download-store';
|
||||||
@@ -246,23 +247,23 @@ export class DownloadsView extends ViewLifecycleMixin(LitElement) {
|
|||||||
|
|
||||||
override render() {
|
override render() {
|
||||||
return html`
|
return html`
|
||||||
<page-header heading="Downloads">
|
<page-header
|
||||||
${this.tab === 'requests'
|
heading="Downloads"
|
||||||
? html`
|
.actions=${this.tab === 'requests'
|
||||||
<wa-button
|
? ([
|
||||||
slot="actions"
|
{
|
||||||
size="small"
|
id: 'check-now',
|
||||||
appearance="outlined"
|
label: this.checking
|
||||||
?disabled=${this.checking}
|
? 'Searching\u2026'
|
||||||
title="Search every download client for everything on this list right now, instead of waiting for the next scheduled check"
|
: 'Check now',
|
||||||
@click=${() => void this.checkNow()}
|
icon: 'rotate',
|
||||||
>
|
disabled: this.checking,
|
||||||
<wa-icon slot="start" name="rotate"></wa-icon>
|
title: 'Search every download client for everything on this list right now, instead of waiting for the next scheduled check',
|
||||||
${this.checking ? 'Searching…' : 'Check now'}
|
onSelect: () => void this.checkNow(),
|
||||||
</wa-button>
|
},
|
||||||
`
|
] satisfies PageAction[])
|
||||||
: nothing}
|
: []}
|
||||||
</page-header>
|
></page-header>
|
||||||
|
|
||||||
<p class="subtitle">
|
<p class="subtitle">
|
||||||
Music you have requested, and the download attempts that
|
Music you have requested, and the download attempts that
|
||||||
|
|||||||
@@ -30,12 +30,16 @@ import { Events } from '../../events';
|
|||||||
import '@awesome.me/webawesome/dist/components/icon/icon.js';
|
import '@awesome.me/webawesome/dist/components/icon/icon.js';
|
||||||
import '../library-status-indicator/library-status-indicator.js';
|
import '../library-status-indicator/library-status-indicator.js';
|
||||||
import { libraryStatusFor } from '@utils/library-status';
|
import { libraryStatusFor } from '@utils/library-status';
|
||||||
|
import { ICON_AUTOTAG } from '@utils/icon-language';
|
||||||
import type { LibraryStatus } from '../library-status-indicator/library-status-indicator.js';
|
import type { LibraryStatus } from '../library-status-indicator/library-status-indicator.js';
|
||||||
import '../catalog-scope-notice/catalog-scope-notice.js';
|
import '../catalog-scope-notice/catalog-scope-notice.js';
|
||||||
import type { CatalogScope } from '../catalog-scope-notice/catalog-scope-notice.js';
|
import type { CatalogScope } from '../catalog-scope-notice/catalog-scope-notice.js';
|
||||||
import '@awesome.me/webawesome/dist/components/button/button.js';
|
import '@awesome.me/webawesome/dist/components/button/button.js';
|
||||||
import '../download-picker/download-picker';
|
import '../download-picker/download-picker';
|
||||||
import { downloadStore } from '../../store/download-store';
|
import { downloadStore } from '../../store/download-store';
|
||||||
|
import { MatchForAlbum, ApplyAsync } from '@go/autotagservice/service.js';
|
||||||
|
import type * as autotagservice from '@go/autotagservice/models.js';
|
||||||
|
import { confirmAction } from '../confirm-dialog/confirm-dialog';
|
||||||
import { queueStore } from '../../store/queue-store';
|
import { queueStore } from '../../store/queue-store';
|
||||||
import type { QueueSource } from '../../store/queue-store';
|
import type { QueueSource } from '../../store/queue-store';
|
||||||
import { notificationStore } from '../../store/notification-store';
|
import { notificationStore } from '../../store/notification-store';
|
||||||
@@ -175,6 +179,19 @@ export class ExploreAlbumDetails extends LitElement implements ContextMenuHost {
|
|||||||
@property({ type: Number, attribute: 'local-album-id' })
|
@property({ type: Number, attribute: 'local-album-id' })
|
||||||
localAlbumId = 0;
|
localAlbumId = 0;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A confident autotag match for this album, or null when there is
|
||||||
|
* none worth mentioning.
|
||||||
|
*
|
||||||
|
* The tier behind "confident" is `autotag.ConfidentTier`, decided
|
||||||
|
* in the backend so this page and strict auto-accept cannot
|
||||||
|
* disagree about what it means (#28, #90).
|
||||||
|
*/
|
||||||
|
@state() private autotagMatch: autotagservice.AlbumMatchView | null = null;
|
||||||
|
|
||||||
|
/** True while an apply started from this page is in flight. */
|
||||||
|
@state() private applyingTags = false;
|
||||||
|
|
||||||
/* ── Internal state ── */
|
/* ── Internal state ── */
|
||||||
|
|
||||||
@state() private releaseGroup: MBReleaseGroup | null = null;
|
@state() private releaseGroup: MBReleaseGroup | null = null;
|
||||||
@@ -198,6 +215,28 @@ export class ExploreAlbumDetails extends LitElement implements ContextMenuHost {
|
|||||||
@state() private versionEntries: VersionEntry[] = [];
|
@state() private versionEntries: VersionEntry[] = [];
|
||||||
/** Currently-selected dropdown entry (by VersionEntry.key). */
|
/** Currently-selected dropdown entry (by VersionEntry.key). */
|
||||||
@state() private selectedVersionKey: string = '';
|
@state() private selectedVersionKey: string = '';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The key `buildClusters` defaulted to, kept so the page can tell
|
||||||
|
* "this is what we picked for you" from "you went and chose this".
|
||||||
|
*
|
||||||
|
* Only the second needs saying out loud. With the selector demoted
|
||||||
|
* to a disclosure below the tracklist, a chosen version is the one
|
||||||
|
* case where the list on screen is not the one the header
|
||||||
|
* describes, and nothing else on the page would say so.
|
||||||
|
*/
|
||||||
|
@state() private defaultVersionKey: string = '';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether the "Other versions" disclosure is open.
|
||||||
|
*
|
||||||
|
* Collapsed by default — choosing which pressing you are looking at
|
||||||
|
* is a metadata-repair task and does not belong above the
|
||||||
|
* tracklist. It is deliberately *not* closed when the selection
|
||||||
|
* changes: the user opened it to change something, and a panel that
|
||||||
|
* shuts on use cannot be used twice.
|
||||||
|
*/
|
||||||
|
@state() private versionsOpen = false;
|
||||||
@state() private coverArtURL = '';
|
@state() private coverArtURL = '';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -523,7 +562,144 @@ export class ExploreAlbumDetails extends LitElement implements ContextMenuHost {
|
|||||||
flex-shrink: 0;
|
flex-shrink: 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* ── Version selector ── */
|
/* ── The autotag suggestion ── */
|
||||||
|
.autotag-match {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
flex-wrap: wrap;
|
||||||
|
gap: 8px 12px;
|
||||||
|
margin-bottom: 12px;
|
||||||
|
padding: 10px 14px;
|
||||||
|
border: 1px solid
|
||||||
|
var(--yj-border-subtle, rgba(255, 255, 255, 0.08));
|
||||||
|
border-radius: 8px;
|
||||||
|
background: var(--yj-surface-1, rgba(255, 255, 255, 0.04));
|
||||||
|
}
|
||||||
|
|
||||||
|
.autotag-match > wa-icon {
|
||||||
|
flex-shrink: 0;
|
||||||
|
font-size: var(--yj-icon-sm);
|
||||||
|
color: var(--yj-text-secondary, #b3b3b3);
|
||||||
|
}
|
||||||
|
|
||||||
|
.autotag-match-text {
|
||||||
|
margin: 0;
|
||||||
|
flex: 1;
|
||||||
|
/* The suggestion sits in a flex row beside its buttons,
|
||||||
|
* and a grid/flex item's implicit minimum is its
|
||||||
|
* content — without this a long release title pushes
|
||||||
|
* the actions off the end at phone width. */
|
||||||
|
min-width: 0;
|
||||||
|
font-size: var(--yj-text-sm);
|
||||||
|
color: var(--yj-text-secondary, #b3b3b3);
|
||||||
|
}
|
||||||
|
|
||||||
|
.autotag-match-text strong {
|
||||||
|
color: var(--yj-text-primary, #fff);
|
||||||
|
font-weight: 600;
|
||||||
|
}
|
||||||
|
|
||||||
|
.autotag-match-note {
|
||||||
|
display: block;
|
||||||
|
margin-top: 2px;
|
||||||
|
font-size: var(--yj-text-xs);
|
||||||
|
color: var(--yj-text-tertiary, #888);
|
||||||
|
}
|
||||||
|
|
||||||
|
.autotag-match-actions {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 8px;
|
||||||
|
flex-shrink: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* ── Other versions (a disclosure, below the tracklist) ── */
|
||||||
|
.versions {
|
||||||
|
margin-top: 24px;
|
||||||
|
border-top: 1px solid
|
||||||
|
var(--yj-border-subtle, rgba(255, 255, 255, 0.08));
|
||||||
|
padding-top: 8px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* The heading exists so the section is reachable by heading
|
||||||
|
* navigation; the button inside it is the control. Its own
|
||||||
|
* type scale is the section header's, reduced — this is a
|
||||||
|
* footnote to the page, not a peer of the tracklist. */
|
||||||
|
.versions-heading {
|
||||||
|
margin: 0;
|
||||||
|
font-size: var(--yj-text-sm);
|
||||||
|
font-weight: 500;
|
||||||
|
}
|
||||||
|
|
||||||
|
.versions-toggle {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 8px;
|
||||||
|
width: 100%;
|
||||||
|
padding: 8px 2px;
|
||||||
|
background: none;
|
||||||
|
border: none;
|
||||||
|
color: var(--yj-text-secondary, #b3b3b3);
|
||||||
|
font: inherit;
|
||||||
|
text-align: left;
|
||||||
|
cursor: pointer;
|
||||||
|
}
|
||||||
|
|
||||||
|
.versions-toggle:hover {
|
||||||
|
color: var(--yj-text-primary, #fff);
|
||||||
|
}
|
||||||
|
|
||||||
|
.versions-toggle:focus-visible {
|
||||||
|
outline: 2px solid var(--yj-accent-text, #ffd43b);
|
||||||
|
outline-offset: 2px;
|
||||||
|
border-radius: 4px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.versions-toggle wa-icon {
|
||||||
|
font-size: var(--yj-icon-xs, 11px);
|
||||||
|
transition: transform 0.2s ease;
|
||||||
|
}
|
||||||
|
|
||||||
|
.versions-toggle[aria-expanded='false'] wa-icon {
|
||||||
|
transform: rotate(-90deg);
|
||||||
|
}
|
||||||
|
|
||||||
|
.versions-intro {
|
||||||
|
margin: 0 0 10px;
|
||||||
|
font-size: var(--yj-text-xs);
|
||||||
|
color: var(--yj-text-tertiary, #888);
|
||||||
|
line-height: 1.4;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* A line above the tracklist, and only after a deliberate
|
||||||
|
* choice — see renderChosenVersion. */
|
||||||
|
.chosen-version {
|
||||||
|
margin: 0 0 10px;
|
||||||
|
font-size: var(--yj-text-sm);
|
||||||
|
color: var(--yj-text-secondary, #b3b3b3);
|
||||||
|
}
|
||||||
|
|
||||||
|
.chosen-version strong {
|
||||||
|
color: var(--yj-text-primary, #fff);
|
||||||
|
font-weight: 600;
|
||||||
|
}
|
||||||
|
|
||||||
|
.chosen-version-reset {
|
||||||
|
background: none;
|
||||||
|
border: none;
|
||||||
|
padding: 0;
|
||||||
|
font: inherit;
|
||||||
|
color: var(--yj-accent-text, #ffd43b);
|
||||||
|
text-decoration: underline;
|
||||||
|
cursor: pointer;
|
||||||
|
}
|
||||||
|
|
||||||
|
.chosen-version-reset:focus-visible {
|
||||||
|
outline: 2px solid var(--yj-accent-text, #ffd43b);
|
||||||
|
outline-offset: 2px;
|
||||||
|
border-radius: 2px;
|
||||||
|
}
|
||||||
|
|
||||||
.version-selector {
|
.version-selector {
|
||||||
display: flex;
|
display: flex;
|
||||||
flex-direction: column;
|
flex-direction: column;
|
||||||
@@ -948,10 +1124,20 @@ export class ExploreAlbumDetails extends LitElement implements ContextMenuHost {
|
|||||||
this.releases = [];
|
this.releases = [];
|
||||||
this.versionEntries = [];
|
this.versionEntries = [];
|
||||||
this.selectedVersionKey = '';
|
this.selectedVersionKey = '';
|
||||||
|
this.defaultVersionKey = '';
|
||||||
|
this.versionsOpen = false;
|
||||||
this.showFullTracklist = null;
|
this.showFullTracklist = null;
|
||||||
this.localTracks = [];
|
this.localTracks = [];
|
||||||
this.filePaths = new Map();
|
this.filePaths = new Map();
|
||||||
this.askedFor = new Set();
|
this.askedFor = new Set();
|
||||||
|
this.autotagMatch = null;
|
||||||
|
|
||||||
|
// Not awaited: the banner is a bonus and the page must not
|
||||||
|
// wait on it. It is also the *most* useful on an untagged
|
||||||
|
// album, which is exactly the page that has least else to
|
||||||
|
// show, so it is asked for on both branches below rather than
|
||||||
|
// only the catalog one.
|
||||||
|
void this.loadAutotagMatch();
|
||||||
|
|
||||||
// Local-only album (no MBID) — populate entirely from library.
|
// Local-only album (no MBID) — populate entirely from library.
|
||||||
if (!mbid && this.localAlbumId) {
|
if (!mbid && this.localAlbumId) {
|
||||||
@@ -1144,6 +1330,31 @@ export class ExploreAlbumDetails extends LitElement implements ContextMenuHost {
|
|||||||
return this.completeness;
|
return this.completeness;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Ask whether the autotagger already has a confident match here.
|
||||||
|
*
|
||||||
|
* It answers from what the background prefetch has already scored
|
||||||
|
* and makes no MusicBrainz request, so this is safe on page load —
|
||||||
|
* see `MatchForAlbum`. A folder nobody has reached yet answers
|
||||||
|
* `null`, which is the same as "nothing to say": the banner is a
|
||||||
|
* bonus, so a failure is a missing suggestion rather than an error
|
||||||
|
* the user can act on, and it stays in the console.
|
||||||
|
*/
|
||||||
|
private async loadAutotagMatch(): Promise<void> {
|
||||||
|
if (this.localAlbumId <= 0) {
|
||||||
|
this.autotagMatch = null;
|
||||||
|
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
this.autotagMatch = await MatchForAlbum(this.localAlbumId);
|
||||||
|
} catch (err) {
|
||||||
|
console.error('[explore-album] autotag match lookup failed', err);
|
||||||
|
this.autotagMatch = null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Fetch and set `localTracks` directly by local album id — the
|
* Fetch and set `localTracks` directly by local album id — the
|
||||||
* definite source of truth, used when nothing else has already
|
* definite source of truth, used when nothing else has already
|
||||||
@@ -1639,6 +1850,14 @@ export class ExploreAlbumDetails extends LitElement implements ContextMenuHost {
|
|||||||
|| standardEntry?.key
|
|| standardEntry?.key
|
||||||
|| this.versionEntries[0]?.key
|
|| this.versionEntries[0]?.key
|
||||||
|| '';
|
|| '';
|
||||||
|
|
||||||
|
// Recorded here rather than derived later: this is the one
|
||||||
|
// place that knows what "the version we picked" means, and
|
||||||
|
// recomputing the preference order at the render site would be
|
||||||
|
// a second copy of it. `handleTracklistScopeChange` rebuilds
|
||||||
|
// through here too, so the switch does not read as a choice of
|
||||||
|
// version.
|
||||||
|
this.defaultVersionKey = this.selectedVersionKey;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -2297,9 +2516,11 @@ export class ExploreAlbumDetails extends LitElement implements ContextMenuHost {
|
|||||||
entity-type="album"
|
entity-type="album"
|
||||||
@catalog-retry=${this.retryCatalog}
|
@catalog-retry=${this.retryCatalog}
|
||||||
></catalog-scope-notice>
|
></catalog-scope-notice>
|
||||||
${this.renderVersionSelector()}
|
${this.renderAutotagMatch()}
|
||||||
|
${this.renderChosenVersion()}
|
||||||
${this.renderTracklistScope()}
|
${this.renderTracklistScope()}
|
||||||
${this.renderTracklist()}
|
${this.renderTracklist()}
|
||||||
|
${this.renderVersionSelector()}
|
||||||
</div>
|
</div>
|
||||||
<track-details></track-details>
|
<track-details></track-details>
|
||||||
`;
|
`;
|
||||||
@@ -2950,26 +3171,230 @@ export class ExploreAlbumDetails extends LitElement implements ContextMenuHost {
|
|||||||
|
|
||||||
/* ── Version Selector (R025, R026, R027) ── */
|
/* ── Version Selector (R025, R026, R027) ── */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* "MusicBrainz has a match for this album."
|
||||||
|
*
|
||||||
|
* The complaint this answers is that the user had to notice the
|
||||||
|
* metadata was missing, then go and hunt the album down on the
|
||||||
|
* Autotag page — so the point is to say it *here*, while they are
|
||||||
|
* looking at the thing, with something to do about it.
|
||||||
|
*
|
||||||
|
* Three things about it are load-bearing.
|
||||||
|
*
|
||||||
|
* **Applying is offered only when it would do the whole album.** A
|
||||||
|
* tagging group is a folder, so a multi-disc album is several, and
|
||||||
|
* one button that applied to the best-scoring one would leave the
|
||||||
|
* album holding a mix of old and new tags — the exact case the
|
||||||
|
* app's Blocking notification level exists for. `groupCount` is
|
||||||
|
* the test, and the answer there is review, not apply.
|
||||||
|
*
|
||||||
|
* **The confirm is not a formality.** This rewrites tags on disk
|
||||||
|
* and cannot be undone, so it goes through `confirmAction()` with
|
||||||
|
* an impact line that says so in those words.
|
||||||
|
*
|
||||||
|
* **The banner does not claim a percentage.** The backend has a
|
||||||
|
* score and deliberately does not put it in the sentence: 0.95
|
||||||
|
* reads as a probability and is not one. What the user needs is
|
||||||
|
* which release it is, which is what the release title and artist
|
||||||
|
* are for.
|
||||||
|
*/
|
||||||
|
private renderAutotagMatch() {
|
||||||
|
const match = this.autotagMatch;
|
||||||
|
|
||||||
|
if (!match) return nothing;
|
||||||
|
|
||||||
|
const wholeAlbum = match.groupCount === 1;
|
||||||
|
|
||||||
|
return html`
|
||||||
|
<div class="autotag-match" role="status">
|
||||||
|
<wa-icon name=${ICON_AUTOTAG} aria-hidden="true"></wa-icon>
|
||||||
|
<p class="autotag-match-text">
|
||||||
|
MusicBrainz has a match for this album:
|
||||||
|
<strong>${match.title}</strong>
|
||||||
|
${match.artistCredit ? html` by ${match.artistCredit}` : nothing}.
|
||||||
|
${wholeAlbum
|
||||||
|
? nothing
|
||||||
|
: html`<span class="autotag-match-note"
|
||||||
|
>It is filed as ${match.groupCount} folders here, so
|
||||||
|
tagging it is a review rather than one
|
||||||
|
step.</span
|
||||||
|
>`}
|
||||||
|
</p>
|
||||||
|
<div class="autotag-match-actions">
|
||||||
|
${wholeAlbum
|
||||||
|
? html`<wa-button
|
||||||
|
size="small"
|
||||||
|
variant="brand"
|
||||||
|
?disabled=${this.applyingTags}
|
||||||
|
@click=${this.onApplyAutotagMatch}
|
||||||
|
>Apply tags</wa-button
|
||||||
|
>`
|
||||||
|
: nothing}
|
||||||
|
<wa-button
|
||||||
|
size="small"
|
||||||
|
appearance="outlined"
|
||||||
|
@click=${this.onReviewAutotagMatch}
|
||||||
|
>Review in Autotag</wa-button
|
||||||
|
>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
`;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Hand the group over to the Autotag page and go there. */
|
||||||
|
private onReviewAutotagMatch = () => {
|
||||||
|
const match = this.autotagMatch;
|
||||||
|
|
||||||
|
if (!match) return;
|
||||||
|
|
||||||
|
this.dispatchEvent(
|
||||||
|
new CustomEvent('navigate', {
|
||||||
|
bubbles: true,
|
||||||
|
composed: true,
|
||||||
|
detail: { view: 'autotag', groupKey: match.groupKey },
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Apply the match, after asking.
|
||||||
|
*
|
||||||
|
* `ApplyAsync` is the registered-job path, so the work is visible
|
||||||
|
* in the jobs indicator and cancellable there like every other
|
||||||
|
* long-running operation — this page does not grow a second
|
||||||
|
* progress surface for it. What it does own is the *acknowledgement*
|
||||||
|
* that the request was accepted, because the button is here.
|
||||||
|
*
|
||||||
|
* The page is not refreshed on completion either: rewriting tags
|
||||||
|
* emits `TrackMetadataChanged`, which `library-store` answers by
|
||||||
|
* discarding every cached collection, and this page reloads from
|
||||||
|
* that like everything else.
|
||||||
|
*/
|
||||||
|
private onApplyAutotagMatch = async () => {
|
||||||
|
const match = this.autotagMatch;
|
||||||
|
|
||||||
|
if (!match || this.applyingTags) return;
|
||||||
|
|
||||||
|
const ok = await confirmAction({
|
||||||
|
title: `Tag this album as “${match.title}”?`,
|
||||||
|
message:
|
||||||
|
`The ${match.trackCount} files of this album are rewritten to` +
|
||||||
|
` match the MusicBrainz release${
|
||||||
|
match.artistCredit ? ` by ${match.artistCredit}` : ''
|
||||||
|
}.`,
|
||||||
|
impact:
|
||||||
|
'This edits the tags in the files on disk and cannot be' +
|
||||||
|
' undone. Nothing is moved or deleted.',
|
||||||
|
confirmLabel: 'Apply tags',
|
||||||
|
});
|
||||||
|
|
||||||
|
if (!ok) return;
|
||||||
|
|
||||||
|
this.applyingTags = true;
|
||||||
|
|
||||||
|
try {
|
||||||
|
await ApplyAsync(match.groupKey, match.releaseMbid);
|
||||||
|
|
||||||
|
// The suggestion has been acted on, so it stops being a
|
||||||
|
// suggestion immediately rather than sitting there inviting
|
||||||
|
// a second click while the job runs.
|
||||||
|
this.autotagMatch = null;
|
||||||
|
|
||||||
|
notificationStore.transient({
|
||||||
|
text: 'Tagging this album — progress is in the jobs indicator.',
|
||||||
|
});
|
||||||
|
} catch (err) {
|
||||||
|
console.error('[explore-album] autotag apply failed', err);
|
||||||
|
|
||||||
|
// Persistent rather than transient: the user asked for
|
||||||
|
// something that did not happen, and retrying is meaningful.
|
||||||
|
notificationStore.persistent({
|
||||||
|
text: describeError(
|
||||||
|
err,
|
||||||
|
'Those tags could not be applied.',
|
||||||
|
),
|
||||||
|
tone: 'error',
|
||||||
|
});
|
||||||
|
} finally {
|
||||||
|
this.applyingTags = false;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Which pressing is on screen — said only when the user chose it.
|
||||||
|
*
|
||||||
|
* The selector is a disclosure below the tracklist now, so nothing
|
||||||
|
* above the list names the version it came from. That is right for
|
||||||
|
* the default, which is what the header already describes; it is
|
||||||
|
* wrong the moment someone picks a different one, because then the
|
||||||
|
* tracklist and the page disagree and the control that explains it
|
||||||
|
* is off the bottom of the screen.
|
||||||
|
*
|
||||||
|
* `defaultVersionKey` is the whole test. A quiet line that appears
|
||||||
|
* on every album would be the thing this issue removed, one size
|
||||||
|
* smaller.
|
||||||
|
*/
|
||||||
|
private renderChosenVersion() {
|
||||||
|
if (this.loadingReleases || this.errorReleases) return nothing;
|
||||||
|
if (!this.selectedVersionKey) return nothing;
|
||||||
|
if (this.selectedVersionKey === this.defaultVersionKey) return nothing;
|
||||||
|
|
||||||
|
const current = this.currentVersion();
|
||||||
|
|
||||||
|
if (!current) return nothing;
|
||||||
|
|
||||||
|
return html`
|
||||||
|
<p class="chosen-version">
|
||||||
|
Showing <strong>${current.label}</strong> —
|
||||||
|
${current.sublabel}.
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
class="chosen-version-reset"
|
||||||
|
@click=${this.resetVersion}
|
||||||
|
>
|
||||||
|
Use the default version
|
||||||
|
</button>
|
||||||
|
</p>
|
||||||
|
`;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Back to what `buildClusters` picked, without opening the panel. */
|
||||||
|
private resetVersion = () => {
|
||||||
|
if (!this.defaultVersionKey) return;
|
||||||
|
|
||||||
|
this.selectedVersionKey = this.defaultVersionKey;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* "Other versions" — a disclosure, below the tracklist.
|
||||||
|
*
|
||||||
|
* Choosing which pressing you are looking at is an advanced,
|
||||||
|
* metadata-repair task, and it used to sit directly above the
|
||||||
|
* tracklist with a heading and a paragraph of prose explaining our
|
||||||
|
* clustering heuristic. It is not removed — matching the wrong
|
||||||
|
* release is a real problem and this is how it gets fixed — it is
|
||||||
|
* demoted (#17).
|
||||||
|
*
|
||||||
|
* Two things about the shape are load-bearing, and both are
|
||||||
|
* `config-section`'s rules rather than new ones. The header is a
|
||||||
|
* real `<button aria-expanded aria-controls>` inside the heading
|
||||||
|
* that names the section, so it is reachable by Tab and by heading
|
||||||
|
* navigation alike. And the body **renders unconditionally and is
|
||||||
|
* toggled with `hidden`**, because `aria-controls` has to name an
|
||||||
|
* element that is in the DOM.
|
||||||
|
*
|
||||||
|
* The loading and error states this used to own are gone rather
|
||||||
|
* than moved. Both were unguarded, so they took the primary slot on
|
||||||
|
* every album regardless of whether there was ever going to be a
|
||||||
|
* choice: the spinner said the same thing `renderTracklist` was
|
||||||
|
* already saying about the same fetch, and the error is the one
|
||||||
|
* `catalog-scope-notice` shows at the top of the page with a retry
|
||||||
|
* — every path that sets `errorReleases` also sets `catalogFailed`,
|
||||||
|
* which is the only route to `unavailable`. What the tracklist does
|
||||||
|
* with a failure is now the tracklist's own business.
|
||||||
|
*/
|
||||||
private renderVersionSelector() {
|
private renderVersionSelector() {
|
||||||
if (this.loadingReleases) {
|
if (this.loadingReleases || this.errorReleases) return nothing;
|
||||||
return html`
|
|
||||||
<section>
|
|
||||||
<h3 class="section-header">Versions</h3>
|
|
||||||
<div class="section-loading">Loading releases\u2026</div>
|
|
||||||
</section>
|
|
||||||
`;
|
|
||||||
}
|
|
||||||
if (this.errorReleases) {
|
|
||||||
return html`
|
|
||||||
<section>
|
|
||||||
<h3 class="section-header">Versions</h3>
|
|
||||||
<div class="section-error">
|
|
||||||
<wa-icon name="triangle-exclamation"></wa-icon>
|
|
||||||
${this.errorReleases}
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
`;
|
|
||||||
}
|
|
||||||
|
|
||||||
// A dropdown is only a choice if the choices differ. Counting
|
// A dropdown is only a choice if the choices differ. Counting
|
||||||
// *entries* is the wrong test: a release group routinely has
|
// *entries* is the wrong test: a release group routinely has
|
||||||
@@ -2980,7 +3405,9 @@ export class ExploreAlbumDetails extends LitElement implements ContextMenuHost {
|
|||||||
//
|
//
|
||||||
// Distinct *tracklists* is the real question, and it is already
|
// Distinct *tracklists* is the real question, and it is already
|
||||||
// computed: clusters are keyed by tracklist fingerprint.
|
// computed: clusters are keyed by tracklist fingerprint.
|
||||||
if (this.distinctTracklistCount() <= 1) return nothing;
|
const choices = this.distinctTracklistCount();
|
||||||
|
|
||||||
|
if (choices <= 1) return nothing;
|
||||||
|
|
||||||
const aggregateEntries = this.versionEntries.filter(
|
const aggregateEntries = this.versionEntries.filter(
|
||||||
(e) => e.group === 'aggregate',
|
(e) => e.group === 'aggregate',
|
||||||
@@ -2990,35 +3417,59 @@ export class ExploreAlbumDetails extends LitElement implements ContextMenuHost {
|
|||||||
);
|
);
|
||||||
|
|
||||||
return html`
|
return html`
|
||||||
<div class="version-selector">
|
<section class="versions">
|
||||||
<div class="version-selector-row">
|
<h3 class="versions-heading">
|
||||||
<label for="version-select">Version</label>
|
<button
|
||||||
<select
|
type="button"
|
||||||
id="version-select"
|
class="versions-toggle"
|
||||||
@change=${this.handleVersionChange}
|
aria-expanded=${this.versionsOpen ? 'true' : 'false'}
|
||||||
aria-label="Select release version"
|
aria-controls="versions-body"
|
||||||
|
@click=${this.toggleVersions}
|
||||||
>
|
>
|
||||||
${aggregateEntries.length > 0
|
<wa-icon name="chevron-down" aria-hidden="true"></wa-icon>
|
||||||
? html`
|
Other versions of this album (${choices})
|
||||||
<optgroup label="Aggregate">
|
</button>
|
||||||
${aggregateEntries.map((e) =>
|
</h3>
|
||||||
this.renderVersionOption(e),
|
<div id="versions-body" ?hidden=${!this.versionsOpen}>
|
||||||
)}
|
<p class="versions-intro">
|
||||||
</optgroup>
|
A release group can have several pressings with
|
||||||
`
|
different tracklists. Pick another if the one
|
||||||
: nothing}
|
above does not match your copy.
|
||||||
<optgroup label="Versions">
|
</p>
|
||||||
${clusterEntries.map((e) =>
|
<div class="version-selector">
|
||||||
this.renderVersionOption(e),
|
<div class="version-selector-row">
|
||||||
)}
|
<label for="version-select">Version</label>
|
||||||
</optgroup>
|
<select
|
||||||
</select>
|
id="version-select"
|
||||||
|
@change=${this.handleVersionChange}
|
||||||
|
>
|
||||||
|
${aggregateEntries.length > 0
|
||||||
|
? html`
|
||||||
|
<optgroup label="Aggregate">
|
||||||
|
${aggregateEntries.map((e) =>
|
||||||
|
this.renderVersionOption(e),
|
||||||
|
)}
|
||||||
|
</optgroup>
|
||||||
|
`
|
||||||
|
: nothing}
|
||||||
|
<optgroup label="Versions">
|
||||||
|
${clusterEntries.map((e) =>
|
||||||
|
this.renderVersionOption(e),
|
||||||
|
)}
|
||||||
|
</optgroup>
|
||||||
|
</select>
|
||||||
|
</div>
|
||||||
|
${this.renderVersionMeta()}
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
${this.renderVersionMeta()}
|
</section>
|
||||||
</div>
|
|
||||||
`;
|
`;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private toggleVersions = () => {
|
||||||
|
this.versionsOpen = !this.versionsOpen;
|
||||||
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* One option in the version list.
|
* One option in the version list.
|
||||||
*
|
*
|
||||||
@@ -3197,8 +3648,21 @@ export class ExploreAlbumDetails extends LitElement implements ContextMenuHost {
|
|||||||
`;
|
`;
|
||||||
}
|
}
|
||||||
if (this.errorReleases) {
|
if (this.errorReleases) {
|
||||||
// Error already shown in version selector section
|
// The failure belongs to the list that is missing because
|
||||||
return nothing;
|
// of it. This used to return `nothing` and lean on the
|
||||||
|
// version selector's own error block to have said it, which
|
||||||
|
// is precisely the coupling that made demoting the selector
|
||||||
|
// a rewrite rather than a move: a control in a collapsed
|
||||||
|
// disclosure cannot be the page's error surface.
|
||||||
|
return html`
|
||||||
|
<section>
|
||||||
|
<h3 class="sr-only">Tracklist</h3>
|
||||||
|
<div class="section-error">
|
||||||
|
<wa-icon name="triangle-exclamation"></wa-icon>
|
||||||
|
${this.errorReleases}
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
`;
|
||||||
}
|
}
|
||||||
const current = this.currentVersion();
|
const current = this.currentVersion();
|
||||||
if (!current) {
|
if (!current) {
|
||||||
|
|||||||
@@ -1,8 +1,9 @@
|
|||||||
import { LitElement, html, css, nothing } from 'lit';
|
import { LitElement, html, css, nothing } from 'lit';
|
||||||
import { customElement, state } from 'lit/decorators.js';
|
import { customElement, state } from 'lit/decorators.js';
|
||||||
import '@awesome.me/webawesome/dist/components/icon/icon.js';
|
import '@awesome.me/webawesome/dist/components/icon/icon.js';
|
||||||
import '@awesome.me/webawesome/dist/components/button/button.js';
|
|
||||||
import { GetShelves } from '@go/home/service.js';
|
import { GetShelves } from '@go/home/service.js';
|
||||||
|
import { ICON_SHUFFLE } from '@utils/icon-language';
|
||||||
|
import type { PageAction } from '@components/page-header/page-header';
|
||||||
import { GetAlbumTracks } from '@go/library/library.js';
|
import { GetAlbumTracks } from '@go/library/library.js';
|
||||||
import type * as home from '@go/home/models.js';
|
import type * as home from '@go/home/models.js';
|
||||||
import type * as library from '@go/library/models.js';
|
import type * as library from '@go/library/models.js';
|
||||||
@@ -160,29 +161,52 @@ export class HomeView extends ViewLifecycleMixin(LitElement) {
|
|||||||
user-select: none;
|
user-select: none;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* The hover play button is a *hover* affordance, so it is
|
||||||
|
* gated on the device having hover rather than on width. A
|
||||||
|
* touch long-press synthesises a hover state in the WebView,
|
||||||
|
* so on a phone it flashed into view during the 500ms hold
|
||||||
|
* that utils/long-press.ts is measuring for a context menu —
|
||||||
|
* a control appearing because you were reaching for a
|
||||||
|
* different one. A phone user taps the album and plays from
|
||||||
|
* the detail view, so there is nothing to replace it with.
|
||||||
|
*
|
||||||
|
* display:none outside the query rather than opacity:0 on
|
||||||
|
* its own: an opacity-0 button still takes taps and is
|
||||||
|
* still in the accessibility tree, so the invisible control
|
||||||
|
* would keep the hit area it was never meant to have on
|
||||||
|
* touch. Everything else stays inside, so the desktop
|
||||||
|
* animation is unchanged.
|
||||||
|
*/
|
||||||
.play {
|
.play {
|
||||||
position: absolute;
|
display: none;
|
||||||
right: 8px;
|
|
||||||
bottom: 8px;
|
|
||||||
width: 38px;
|
|
||||||
height: 38px;
|
|
||||||
border: none;
|
|
||||||
border-radius: 50%;
|
|
||||||
background: var(--yj-accent, #ffd43b);
|
|
||||||
color: var(--yj-accent-fg, #000);
|
|
||||||
display: flex;
|
|
||||||
align-items: center;
|
|
||||||
justify-content: center;
|
|
||||||
cursor: pointer;
|
|
||||||
opacity: 0;
|
|
||||||
transform: translateY(6px);
|
|
||||||
transition: opacity 0.12s ease, transform 0.12s ease;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
.card:hover .play,
|
@media (hover: hover) and (pointer: fine) {
|
||||||
.card:focus-within .play {
|
.play {
|
||||||
opacity: 1;
|
position: absolute;
|
||||||
transform: translateY(0);
|
right: 8px;
|
||||||
|
bottom: 8px;
|
||||||
|
width: 38px;
|
||||||
|
height: 38px;
|
||||||
|
border: none;
|
||||||
|
border-radius: 50%;
|
||||||
|
background: var(--yj-accent, #ffd43b);
|
||||||
|
color: var(--yj-accent-fg, #000);
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
cursor: pointer;
|
||||||
|
opacity: 0;
|
||||||
|
transform: translateY(6px);
|
||||||
|
transition: opacity 0.12s ease, transform 0.12s ease;
|
||||||
|
}
|
||||||
|
|
||||||
|
.card:hover .play,
|
||||||
|
.card:focus-within .play {
|
||||||
|
opacity: 1;
|
||||||
|
transform: translateY(0);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
.name {
|
.name {
|
||||||
@@ -260,23 +284,24 @@ export class HomeView extends ViewLifecycleMixin(LitElement) {
|
|||||||
|
|
||||||
override render() {
|
override render() {
|
||||||
return html`
|
return html`
|
||||||
<page-header heading="Home">
|
<page-header
|
||||||
<!-- "Shuffle" alone was two different controls with one
|
heading="Home"
|
||||||
name: this one and the transport's shuffle mode.
|
.actions=${[
|
||||||
They were never on screen together until the app
|
{
|
||||||
started landing on Home (H-8), and a cached view is
|
// "Shuffle" alone was two different controls
|
||||||
in the accessibility tree either way. -->
|
// with one name: this one and the transport's
|
||||||
<wa-button
|
// shuffle mode. They were never on screen
|
||||||
slot="actions"
|
// together until the app started landing on
|
||||||
size="small"
|
// Home (H-8), and a cached view is in the
|
||||||
appearance="plain"
|
// accessibility tree either way.
|
||||||
title="Reshuffle the suggestions"
|
id: 'shuffle-suggestions',
|
||||||
@click=${() => void this.load()}
|
label: 'Shuffle suggestions',
|
||||||
>
|
icon: ICON_SHUFFLE,
|
||||||
<wa-icon slot="start" name="shuffle"></wa-icon>
|
title: 'Reshuffle the suggestions',
|
||||||
Shuffle suggestions
|
onSelect: () => void this.load(),
|
||||||
</wa-button>
|
},
|
||||||
</page-header>
|
] satisfies PageAction[]}
|
||||||
|
></page-header>
|
||||||
<p class="lede">Somewhere to start listening.</p>
|
<p class="lede">Somewhere to start listening.</p>
|
||||||
${this.renderBody()}
|
${this.renderBody()}
|
||||||
`;
|
`;
|
||||||
|
|||||||
@@ -155,13 +155,27 @@ export class JobIndicator extends LitElement {
|
|||||||
goes -- the live region in render() is what announces
|
goes -- the live region in render() is what announces
|
||||||
this, and it is unaffected, so the ring keeps its
|
this, and it is unaffected, so the ring keeps its
|
||||||
accessible name and screen readers keep hearing the
|
accessible name and screen readers keep hearing the
|
||||||
state change. */
|
state change.
|
||||||
|
|
||||||
|
[compact] is the same removal asked for by measurement
|
||||||
|
rather than by width, and it is set from outside: the
|
||||||
|
shell's fit pass (services/top-bar-fit.ts, #143) owns
|
||||||
|
it, because between 600 and 900 whether this label fits
|
||||||
|
depends on what else is in the bar and on how long the
|
||||||
|
running job's title is -- 235px for "Scanning Music from
|
||||||
|
the external drive" -- rather than on the viewport. Two
|
||||||
|
triggers, one effect, and the phone's is unconditional
|
||||||
|
because it was argued and pinned before this existed. */
|
||||||
@media (max-width: 599px) {
|
@media (max-width: 599px) {
|
||||||
.label {
|
.label {
|
||||||
display: none;
|
display: none;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
:host([compact]) .label {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
.alert-dot {
|
.alert-dot {
|
||||||
width: 6px;
|
width: 6px;
|
||||||
height: 6px;
|
height: 6px;
|
||||||
|
|||||||
@@ -0,0 +1,229 @@
|
|||||||
|
import { LitElement, html, css, nothing } from 'lit';
|
||||||
|
import { customElement, property, state } from 'lit/decorators.js';
|
||||||
|
import { designTokens } from '../../styles/tokens.css';
|
||||||
|
import { jobStore } from '@store/job-store';
|
||||||
|
import type { Job, JobKind } from '@store/job-store';
|
||||||
|
import { isTerminal } from '@store/job-store';
|
||||||
|
import './job-row';
|
||||||
|
import './job-details-drawer';
|
||||||
|
import { applyJobControl } from './job-controls';
|
||||||
|
import { jobStateStyles } from './job-format';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The background work of one kind, rendered wherever that work is
|
||||||
|
* started or configured.
|
||||||
|
*
|
||||||
|
* #27 folded the Jobs tab away, and the shape it folded into is this
|
||||||
|
* rather than one "Background jobs" panel in Settings — which would
|
||||||
|
* have been the tab again under another name. Reading the app first
|
||||||
|
* turned up that **four of the five job kinds already had a home**
|
||||||
|
* showing their work: Settings → Search Index draws per-tier index
|
||||||
|
* progress, `downloads-view` draws every download's lifecycle state,
|
||||||
|
* `autotag-view` draws its own apply ring, and only `library-scan` had
|
||||||
|
* nowhere but the tab. What none of those four had is the *generic*
|
||||||
|
* affordances — pause, cancel, "Details", the log, and a finished job
|
||||||
|
* you can dismiss — which is what this carries to each of them.
|
||||||
|
*
|
||||||
|
* Three things about it are load-bearing.
|
||||||
|
*
|
||||||
|
* **The controls are `applyJobControl`, not a reimplementation.** That
|
||||||
|
* is what keeps the "you will discard hours of downloading"
|
||||||
|
* confirmation on an index build alive across the move: it is keyed on
|
||||||
|
* `KindIndexBuild` inside the shared handler, and a host that rendered
|
||||||
|
* its own buttons would silently drop it.
|
||||||
|
*
|
||||||
|
* **A panel with nothing to say renders nothing at all**, host padding
|
||||||
|
* included — an idle panel in four places is four pieces of furniture
|
||||||
|
* describing an absence. That is the rule `startBackfillJob` follows
|
||||||
|
* for the indicator, one layer up.
|
||||||
|
*
|
||||||
|
* **There is no "Clear finished" here**, because `ClearFinishedJobs` is
|
||||||
|
* global: a Clear in the Libraries panel would silently discard the
|
||||||
|
* index build's history too. A finished row dismisses itself, which is
|
||||||
|
* per-job and is what `job-row` already offers.
|
||||||
|
*/
|
||||||
|
@customElement('job-panel')
|
||||||
|
export class JobPanel extends LitElement {
|
||||||
|
/**
|
||||||
|
* Comma-separated job kinds, e.g. `index-build,catalog-enrich`.
|
||||||
|
*
|
||||||
|
* An attribute rather than a property because every call site is a
|
||||||
|
* literal in a template, and one of them is inside an HTMX-adjacent
|
||||||
|
* settings page where a property binding would be one more thing to
|
||||||
|
* remember.
|
||||||
|
*/
|
||||||
|
@property({ type: String })
|
||||||
|
kinds = '';
|
||||||
|
|
||||||
|
/** Heading above the rows. Omitted renders no heading. */
|
||||||
|
@property({ type: String })
|
||||||
|
heading = '';
|
||||||
|
|
||||||
|
@state()
|
||||||
|
private jobs: Job[] = [];
|
||||||
|
|
||||||
|
@state()
|
||||||
|
private drawerJobId = '';
|
||||||
|
|
||||||
|
@state()
|
||||||
|
private drawerOpen = false;
|
||||||
|
|
||||||
|
private unsubscribe: (() => void) | null = null;
|
||||||
|
|
||||||
|
static override styles = [
|
||||||
|
designTokens,
|
||||||
|
jobStateStyles,
|
||||||
|
css`
|
||||||
|
:host {
|
||||||
|
display: block;
|
||||||
|
margin-top: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* An empty panel takes no room at all, margin included. */
|
||||||
|
:host([hidden]) {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
h3 {
|
||||||
|
font-size: var(--yj-text-sm);
|
||||||
|
text-transform: uppercase;
|
||||||
|
letter-spacing: 0.06em;
|
||||||
|
color: var(--yj-text-tertiary, #868e96);
|
||||||
|
margin: 0 0 0.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.card {
|
||||||
|
background: var(--yj-bg-surface, #2b3035);
|
||||||
|
border: 1px solid var(--yj-border, #495057);
|
||||||
|
border-radius: 6px;
|
||||||
|
overflow: hidden;
|
||||||
|
}
|
||||||
|
|
||||||
|
.job-entry {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 0.75em;
|
||||||
|
padding: 0.6em 0.8em;
|
||||||
|
border-bottom: 1px solid var(--yj-border-subtle, #3a4046);
|
||||||
|
}
|
||||||
|
|
||||||
|
.job-entry:last-child {
|
||||||
|
border-bottom: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
job-row {
|
||||||
|
flex: 1;
|
||||||
|
/* A grid child's implicit minimum is its content, and a
|
||||||
|
job title is long. */
|
||||||
|
min-width: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.details-btn {
|
||||||
|
background: none;
|
||||||
|
border: 1px solid var(--yj-border, #495057);
|
||||||
|
border-radius: 4px;
|
||||||
|
color: var(--yj-text-secondary, #adb5bd);
|
||||||
|
cursor: pointer;
|
||||||
|
font-family: inherit;
|
||||||
|
font-size: var(--yj-text-sm);
|
||||||
|
padding: 0.3em 0.6em;
|
||||||
|
white-space: nowrap;
|
||||||
|
}
|
||||||
|
|
||||||
|
.details-btn:hover {
|
||||||
|
color: var(--yj-text-primary, #e9ecef);
|
||||||
|
}
|
||||||
|
`,
|
||||||
|
];
|
||||||
|
|
||||||
|
override connectedCallback() {
|
||||||
|
super.connectedCallback();
|
||||||
|
this.unsubscribe = jobStore.subscribe(() => {
|
||||||
|
this.jobs = jobStore.jobs;
|
||||||
|
});
|
||||||
|
this.jobs = jobStore.jobs;
|
||||||
|
void jobStore.init();
|
||||||
|
}
|
||||||
|
|
||||||
|
override disconnectedCallback() {
|
||||||
|
super.disconnectedCallback();
|
||||||
|
this.unsubscribe?.();
|
||||||
|
this.unsubscribe = null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The kinds this panel answers for. */
|
||||||
|
private get wanted(): ReadonlySet<string> {
|
||||||
|
return new Set(
|
||||||
|
this.kinds
|
||||||
|
.split(',')
|
||||||
|
.map((k) => k.trim())
|
||||||
|
.filter(Boolean),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
private get mine(): Job[] {
|
||||||
|
const wanted = this.wanted;
|
||||||
|
|
||||||
|
return this.jobs.filter((job) => wanted.has(job.kind as JobKind));
|
||||||
|
}
|
||||||
|
|
||||||
|
private openDetails(id: string) {
|
||||||
|
this.drawerJobId = id;
|
||||||
|
this.drawerOpen = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
private onDrawerClosed = () => {
|
||||||
|
this.drawerOpen = false;
|
||||||
|
};
|
||||||
|
|
||||||
|
override render() {
|
||||||
|
const mine = this.mine;
|
||||||
|
|
||||||
|
// Hidden rather than empty: see the class comment. The drawer
|
||||||
|
// goes with it, since it can only have been opened from a row.
|
||||||
|
this.hidden = mine.length === 0;
|
||||||
|
|
||||||
|
if (mine.length === 0) return nothing;
|
||||||
|
|
||||||
|
const active = mine.filter((job) => !isTerminal(job));
|
||||||
|
const finished = mine.filter(isTerminal);
|
||||||
|
|
||||||
|
return html`
|
||||||
|
${this.heading ? html`<h3>${this.heading}</h3>` : nothing}
|
||||||
|
<div class="card">
|
||||||
|
${[...active, ...finished].map(
|
||||||
|
(job) => html`
|
||||||
|
<div class="job-entry">
|
||||||
|
<job-row
|
||||||
|
.job=${job}
|
||||||
|
variant="full"
|
||||||
|
@job-control=${applyJobControl}
|
||||||
|
></job-row>
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
class="details-btn"
|
||||||
|
@click=${() => this.openDetails(job.id)}
|
||||||
|
>
|
||||||
|
Details${job.warnCount
|
||||||
|
? ` · ${job.warnCount}⚠`
|
||||||
|
: ''}
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
`,
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<job-details-drawer
|
||||||
|
job-id=${this.drawerJobId}
|
||||||
|
?open=${this.drawerOpen}
|
||||||
|
@drawer-closed=${this.onDrawerClosed}
|
||||||
|
></job-details-drawer>
|
||||||
|
`;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
declare global {
|
||||||
|
interface HTMLElementTagNameMap {
|
||||||
|
'job-panel': JobPanel;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,568 +0,0 @@
|
|||||||
import { LitElement, html, css, nothing } from 'lit';
|
|
||||||
import { customElement, state } from 'lit/decorators.js';
|
|
||||||
import '@awesome.me/webawesome/dist/components/icon/icon.js';
|
|
||||||
import '@components/page-header/page-header';
|
|
||||||
import { designTokens } from '../../styles/tokens.css';
|
|
||||||
import {
|
|
||||||
GetAllLibrariesWithTrackCounts,
|
|
||||||
ScanLibrary,
|
|
||||||
ScanAllLibraries,
|
|
||||||
FullRescan,
|
|
||||||
} from '@go/library/library.js';
|
|
||||||
import type * as library from '@go/library/models.js';
|
|
||||||
import { EventsOn } from '@runtime/runtime';
|
|
||||||
import { Events } from '../../events';
|
|
||||||
import { jobStore } from '@store/job-store';
|
|
||||||
import type { Job } from '@store/job-store';
|
|
||||||
import { notificationStore } from '@store/notification-store';
|
|
||||||
import { describeError } from '@utils/describe-error';
|
|
||||||
import { confirmAction } from '../confirm-dialog/confirm-dialog';
|
|
||||||
import './job-row';
|
|
||||||
import './job-details-drawer';
|
|
||||||
import { applyJobControl } from './job-controls';
|
|
||||||
import { jobStateStyles } from './job-format';
|
|
||||||
import { ViewLifecycleMixin } from '../../utils/view-lifecycle';
|
|
||||||
|
|
||||||
type LibraryInfo = library.Info;
|
|
||||||
|
|
||||||
/** Job states meaning the job will not progress further. */
|
|
||||||
const TERMINAL_STATES: ReadonlySet<string> = new Set([
|
|
||||||
'complete',
|
|
||||||
'cancelled',
|
|
||||||
'error',
|
|
||||||
]);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Full-page view of background work: everything running right now, the
|
|
||||||
* per-library scan controls that used to live in Settings, and a short
|
|
||||||
* history of what recently finished.
|
|
||||||
*
|
|
||||||
* This is the same job rows as the top-bar popover at a larger density —
|
|
||||||
* one implementation, two placements, so the two can never disagree.
|
|
||||||
*/
|
|
||||||
@customElement('jobs-view')
|
|
||||||
export class JobsView extends ViewLifecycleMixin(LitElement) {
|
|
||||||
@state()
|
|
||||||
private jobs: Job[] = [];
|
|
||||||
|
|
||||||
@state()
|
|
||||||
private libraries: LibraryInfo[] = [];
|
|
||||||
|
|
||||||
@state()
|
|
||||||
private drawerJobId = '';
|
|
||||||
|
|
||||||
@state()
|
|
||||||
private drawerOpen = false;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set between pressing a scan button and the job snapshot that
|
|
||||||
* proves it started. `anyScanning` is derived from `JobsChanged`,
|
|
||||||
* which is coalesced at 250 ms — long enough for a second click to
|
|
||||||
* start a second scan (errors.M5).
|
|
||||||
*/
|
|
||||||
@state()
|
|
||||||
private starting = false;
|
|
||||||
|
|
||||||
private unsubscribe: (() => void) | null = null;
|
|
||||||
|
|
||||||
private eventCleanups: Array<() => void> = [];
|
|
||||||
|
|
||||||
static override styles = [
|
|
||||||
designTokens,
|
|
||||||
jobStateStyles,
|
|
||||||
css`
|
|
||||||
:host {
|
|
||||||
display: block;
|
|
||||||
overflow-y: auto;
|
|
||||||
height: 100%;
|
|
||||||
padding: 1.5em 1.75em 3em;
|
|
||||||
box-sizing: border-box;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* The header supplies its own padding and rule, so it runs
|
|
||||||
to the edge of a host that pads its own content. */
|
|
||||||
page-header {
|
|
||||||
margin: -1.5em -1.75em 1em;
|
|
||||||
}
|
|
||||||
|
|
||||||
h1 {
|
|
||||||
font-size: var(--yj-text-xl);
|
|
||||||
color: var(--yj-text-primary, #e9ecef);
|
|
||||||
margin: 0 0 0.2em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.page-sub {
|
|
||||||
font-size: var(--yj-text-md);
|
|
||||||
color: var(--yj-text-tertiary, #868e96);
|
|
||||||
margin: 0 0 1.75em;
|
|
||||||
}
|
|
||||||
|
|
||||||
section {
|
|
||||||
margin-bottom: 2em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.section-head {
|
|
||||||
display: flex;
|
|
||||||
align-items: center;
|
|
||||||
justify-content: space-between;
|
|
||||||
gap: 1em;
|
|
||||||
margin-bottom: 0.75em;
|
|
||||||
}
|
|
||||||
|
|
||||||
h2 {
|
|
||||||
font-size: var(--yj-text-sm);
|
|
||||||
text-transform: uppercase;
|
|
||||||
letter-spacing: 0.06em;
|
|
||||||
color: var(--yj-text-tertiary, #868e96);
|
|
||||||
margin: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.card {
|
|
||||||
background: rgba(255, 255, 255, 0.03);
|
|
||||||
border: 1px solid rgba(255, 255, 255, 0.07);
|
|
||||||
border-radius: 10px;
|
|
||||||
overflow: hidden;
|
|
||||||
}
|
|
||||||
|
|
||||||
.card > * + * {
|
|
||||||
border-top: 1px solid rgba(255, 255, 255, 0.06);
|
|
||||||
}
|
|
||||||
|
|
||||||
.job-entry {
|
|
||||||
display: grid;
|
|
||||||
grid-template-columns: 1fr auto;
|
|
||||||
align-items: center;
|
|
||||||
gap: 0.5em;
|
|
||||||
padding-right: 0.75em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.empty {
|
|
||||||
padding: 1.1em;
|
|
||||||
font-size: var(--yj-text-md);
|
|
||||||
color: var(--yj-text-tertiary, #868e96);
|
|
||||||
font-style: italic;
|
|
||||||
}
|
|
||||||
|
|
||||||
.library-row {
|
|
||||||
display: grid;
|
|
||||||
grid-template-columns: 1fr auto;
|
|
||||||
align-items: center;
|
|
||||||
gap: 1em;
|
|
||||||
padding: 0.75em 0.9em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.library-name {
|
|
||||||
font-size: var(--yj-text-md);
|
|
||||||
color: var(--yj-text-primary, #e9ecef);
|
|
||||||
}
|
|
||||||
|
|
||||||
.library-meta {
|
|
||||||
font-size: var(--yj-text-sm);
|
|
||||||
color: var(--yj-text-tertiary, #868e96);
|
|
||||||
margin-top: 0.15em;
|
|
||||||
overflow-wrap: anywhere;
|
|
||||||
}
|
|
||||||
|
|
||||||
.library-state {
|
|
||||||
font-size: var(--yj-text-sm);
|
|
||||||
color: var(--job-tone);
|
|
||||||
margin-top: 0.15em;
|
|
||||||
}
|
|
||||||
|
|
||||||
button.action {
|
|
||||||
display: inline-flex;
|
|
||||||
align-items: center;
|
|
||||||
gap: 0.45em;
|
|
||||||
border: 1px solid rgba(255, 255, 255, 0.14);
|
|
||||||
border-radius: 7px;
|
|
||||||
background: rgba(255, 255, 255, 0.05);
|
|
||||||
color: var(--yj-text-primary, #e9ecef);
|
|
||||||
font-size: var(--yj-text-sm);
|
|
||||||
padding: 0.42em 0.85em;
|
|
||||||
cursor: pointer;
|
|
||||||
white-space: nowrap;
|
|
||||||
transition:
|
|
||||||
background-color 120ms ease,
|
|
||||||
border-color 120ms ease;
|
|
||||||
}
|
|
||||||
|
|
||||||
button.action:hover:not(:disabled) {
|
|
||||||
background: rgba(255, 255, 255, 0.11);
|
|
||||||
}
|
|
||||||
|
|
||||||
button.action:disabled {
|
|
||||||
opacity: 0.4;
|
|
||||||
cursor: default;
|
|
||||||
}
|
|
||||||
|
|
||||||
button.action:focus-visible {
|
|
||||||
outline: 2px solid var(--yj-accent, #ffd43b);
|
|
||||||
outline-offset: 2px;
|
|
||||||
}
|
|
||||||
|
|
||||||
button.action.danger {
|
|
||||||
color: var(--yj-error-text, #ff8787);
|
|
||||||
border-color: rgba(255, 107, 107, 0.35);
|
|
||||||
}
|
|
||||||
|
|
||||||
button.action.danger:hover:not(:disabled) {
|
|
||||||
background: rgba(255, 107, 107, 0.12);
|
|
||||||
}
|
|
||||||
|
|
||||||
button.link {
|
|
||||||
border: none;
|
|
||||||
background: transparent;
|
|
||||||
color: var(--yj-accent-text, #ffd43b);
|
|
||||||
font-size: var(--yj-text-sm);
|
|
||||||
cursor: pointer;
|
|
||||||
padding: 0.2em 0.4em;
|
|
||||||
border-radius: 5px;
|
|
||||||
}
|
|
||||||
|
|
||||||
button.link:hover {
|
|
||||||
text-decoration: underline;
|
|
||||||
}
|
|
||||||
|
|
||||||
.details-btn {
|
|
||||||
border: none;
|
|
||||||
background: transparent;
|
|
||||||
color: var(--yj-text-secondary, #adb5bd);
|
|
||||||
font-size: var(--yj-text-sm);
|
|
||||||
cursor: pointer;
|
|
||||||
padding: 0.3em 0.5em;
|
|
||||||
border-radius: 6px;
|
|
||||||
white-space: nowrap;
|
|
||||||
}
|
|
||||||
|
|
||||||
.details-btn:hover {
|
|
||||||
background: rgba(255, 255, 255, 0.1);
|
|
||||||
color: var(--yj-text-primary, #e9ecef);
|
|
||||||
}
|
|
||||||
`,
|
|
||||||
];
|
|
||||||
|
|
||||||
protected override onViewActivate(): void {
|
|
||||||
this.unsubscribe = jobStore.subscribe(() => {
|
|
||||||
this.jobs = jobStore.jobs;
|
|
||||||
});
|
|
||||||
void jobStore.init();
|
|
||||||
this.jobs = jobStore.jobs;
|
|
||||||
void this.loadLibraries();
|
|
||||||
|
|
||||||
// Library CRUD happens elsewhere; keep the picker in step.
|
|
||||||
for (const event of [
|
|
||||||
Events.LibraryAdded,
|
|
||||||
Events.LibraryRemoved,
|
|
||||||
Events.LibraryRenamed,
|
|
||||||
Events.LibraryScanComplete,
|
|
||||||
]) {
|
|
||||||
this.eventCleanups.push(
|
|
||||||
EventsOn(event, () => void this.loadLibraries()),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
protected override onViewDeactivate(): void {
|
|
||||||
this.unsubscribe?.();
|
|
||||||
this.unsubscribe = null;
|
|
||||||
this.eventCleanups.forEach((off) => off());
|
|
||||||
this.eventCleanups = [];
|
|
||||||
}
|
|
||||||
|
|
||||||
private async loadLibraries(): Promise<void> {
|
|
||||||
try {
|
|
||||||
this.libraries = (await GetAllLibrariesWithTrackCounts()) ?? [];
|
|
||||||
} catch (err) {
|
|
||||||
console.error('Failed to load libraries:', err);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/** The scan job for a library, if one is registered. */
|
|
||||||
private jobForLibrary(id: number): Job | undefined {
|
|
||||||
return jobStore.getJob(`scan:${id}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
private openDetails(id: string) {
|
|
||||||
this.drawerJobId = id;
|
|
||||||
this.drawerOpen = true;
|
|
||||||
}
|
|
||||||
|
|
||||||
private onDrawerClosed = () => {
|
|
||||||
this.drawerOpen = false;
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Run something that starts a job, holding the buttons until the
|
|
||||||
* snapshot lands and saying so when it does not start at all.
|
|
||||||
*
|
|
||||||
* Persistent, not a toast: the user asked for work to happen, it
|
|
||||||
* did not, and retrying is exactly the useful response.
|
|
||||||
*/
|
|
||||||
private async startJob(
|
|
||||||
what: string,
|
|
||||||
start: () => Promise<unknown>,
|
|
||||||
retry: () => void,
|
|
||||||
): Promise<void> {
|
|
||||||
if (this.starting) return;
|
|
||||||
|
|
||||||
this.starting = true;
|
|
||||||
|
|
||||||
try {
|
|
||||||
await start();
|
|
||||||
} catch (err) {
|
|
||||||
console.error(`${what} failed:`, err);
|
|
||||||
notificationStore.persistent({
|
|
||||||
key: 'scan-start',
|
|
||||||
title: 'Scan did not start',
|
|
||||||
text: `${what} failed. ${describeError(err)}`,
|
|
||||||
detail: String(err),
|
|
||||||
action: { label: 'Try again', run: retry },
|
|
||||||
});
|
|
||||||
} finally {
|
|
||||||
this.starting = false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private async startScan(id: number) {
|
|
||||||
await this.startJob(
|
|
||||||
'Scanning that library',
|
|
||||||
() => ScanLibrary(id),
|
|
||||||
() => void this.startScan(id),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
private async startAllScans() {
|
|
||||||
await this.startJob(
|
|
||||||
'Scanning your libraries',
|
|
||||||
() => ScanAllLibraries(),
|
|
||||||
() => void this.startAllScans(),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
private async clearFinished() {
|
|
||||||
await jobStore.clearFinished();
|
|
||||||
}
|
|
||||||
|
|
||||||
private async fullRescan() {
|
|
||||||
const ok = await confirmAction({
|
|
||||||
title: 'Full rescan',
|
|
||||||
message:
|
|
||||||
'This deletes all library data — including downloaded ' +
|
|
||||||
'cover art — and rebuilds it from your files.',
|
|
||||||
impact:
|
|
||||||
'It is not the same as “Scan now”, which only picks up ' +
|
|
||||||
'what changed.',
|
|
||||||
confirmLabel: 'Rebuild everything',
|
|
||||||
danger: true,
|
|
||||||
});
|
|
||||||
|
|
||||||
if (!ok) return;
|
|
||||||
|
|
||||||
await this.startJob(
|
|
||||||
'The full rescan',
|
|
||||||
() => FullRescan(),
|
|
||||||
() => void this.fullRescan(),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
private renderJobList(list: Job[], emptyText: string) {
|
|
||||||
if (list.length === 0) {
|
|
||||||
return html`<div class="card">
|
|
||||||
<div class="empty">${emptyText}</div>
|
|
||||||
</div>`;
|
|
||||||
}
|
|
||||||
|
|
||||||
return html`
|
|
||||||
<div class="card">
|
|
||||||
${list.map(
|
|
||||||
(job) => html`
|
|
||||||
<div class="job-entry">
|
|
||||||
<job-row
|
|
||||||
.job=${job}
|
|
||||||
variant="full"
|
|
||||||
@job-control=${applyJobControl}
|
|
||||||
></job-row>
|
|
||||||
<button
|
|
||||||
class="details-btn"
|
|
||||||
@click=${() => this.openDetails(job.id)}
|
|
||||||
>
|
|
||||||
Details${job.warnCount
|
|
||||||
? ` · ${job.warnCount}⚠`
|
|
||||||
: ''}
|
|
||||||
</button>
|
|
||||||
</div>
|
|
||||||
`,
|
|
||||||
)}
|
|
||||||
</div>
|
|
||||||
`;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** The status line under a library name in the scan-control list. */
|
|
||||||
private libraryStatus(job: Job | undefined): string | null {
|
|
||||||
if (!job) return null;
|
|
||||||
|
|
||||||
switch (job.state) {
|
|
||||||
case 'running':
|
|
||||||
return job.phase ? `Scanning · ${job.phase}` : 'Scanning';
|
|
||||||
case 'queued':
|
|
||||||
return 'Queued';
|
|
||||||
case 'paused':
|
|
||||||
return 'Paused';
|
|
||||||
case 'pausing':
|
|
||||||
return 'Pausing…';
|
|
||||||
case 'cancelling':
|
|
||||||
return 'Stopping…';
|
|
||||||
default:
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private renderLibraryRow(lib: LibraryInfo) {
|
|
||||||
const job = this.jobForLibrary(lib.id);
|
|
||||||
const status = this.libraryStatus(job);
|
|
||||||
const busy = status !== null;
|
|
||||||
|
|
||||||
return html`
|
|
||||||
<div class="library-row">
|
|
||||||
<div>
|
|
||||||
<div class="library-name">${lib.name}</div>
|
|
||||||
<div class="library-meta">
|
|
||||||
${lib.trackCount.toLocaleString()} tracks · ${lib.path}
|
|
||||||
</div>
|
|
||||||
${status
|
|
||||||
? html`<div class="library-state">${status}</div>`
|
|
||||||
: nothing}
|
|
||||||
</div>
|
|
||||||
|
|
||||||
${busy
|
|
||||||
? html`
|
|
||||||
<button
|
|
||||||
class="link"
|
|
||||||
@click=${() => this.openDetails(`scan:${lib.id}`)}
|
|
||||||
>
|
|
||||||
View progress
|
|
||||||
</button>
|
|
||||||
`
|
|
||||||
: html`
|
|
||||||
<button
|
|
||||||
class="action"
|
|
||||||
?disabled=${this.starting}
|
|
||||||
@click=${() => this.startScan(lib.id)}
|
|
||||||
>
|
|
||||||
<wa-icon name="arrows-rotate"></wa-icon>
|
|
||||||
Scan now
|
|
||||||
</button>
|
|
||||||
`}
|
|
||||||
</div>
|
|
||||||
`;
|
|
||||||
}
|
|
||||||
|
|
||||||
override render() {
|
|
||||||
// Derived from `this.jobs` rather than the store getters so Lit
|
|
||||||
// sees the reactive dependency and re-renders on every snapshot.
|
|
||||||
const active = this.jobs.filter((j) => !TERMINAL_STATES.has(j.state));
|
|
||||||
const finished = this.jobs.filter((j) => TERMINAL_STATES.has(j.state));
|
|
||||||
const anyScanning = this.libraries.some((lib) =>
|
|
||||||
Boolean(this.libraryStatus(this.jobForLibrary(lib.id))),
|
|
||||||
);
|
|
||||||
|
|
||||||
return html`
|
|
||||||
<page-header heading="Background jobs"></page-header>
|
|
||||||
<p class="page-sub">
|
|
||||||
Library scans and search index builds, with their progress and
|
|
||||||
output.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<section>
|
|
||||||
<div class="section-head">
|
|
||||||
<h2>Running now</h2>
|
|
||||||
</div>
|
|
||||||
${this.renderJobList(active, 'Nothing is running.')}
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section>
|
|
||||||
<div class="section-head">
|
|
||||||
<h2>Libraries</h2>
|
|
||||||
<button
|
|
||||||
class="action"
|
|
||||||
?disabled=${anyScanning ||
|
|
||||||
this.starting ||
|
|
||||||
this.libraries.length === 0}
|
|
||||||
@click=${this.startAllScans}
|
|
||||||
>
|
|
||||||
<wa-icon name="arrows-rotate"></wa-icon>
|
|
||||||
Scan all
|
|
||||||
</button>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="card">
|
|
||||||
${this.libraries.length === 0
|
|
||||||
? html`<div class="empty">
|
|
||||||
No libraries yet — add one in Settings.
|
|
||||||
</div>`
|
|
||||||
: this.libraries.map((lib) =>
|
|
||||||
this.renderLibraryRow(lib),
|
|
||||||
)}
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section>
|
|
||||||
<div class="section-head">
|
|
||||||
<h2>Maintenance</h2>
|
|
||||||
</div>
|
|
||||||
<div class="card">
|
|
||||||
<div class="library-row">
|
|
||||||
<div>
|
|
||||||
<div class="library-name">Full rescan</div>
|
|
||||||
<div class="library-meta">
|
|
||||||
Wipes all library data and cover art, then
|
|
||||||
rebuilds from your files. Only needed when the
|
|
||||||
library is corrupt — a normal scan already
|
|
||||||
picks up changes.
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<button
|
|
||||||
class="action danger"
|
|
||||||
?disabled=${anyScanning ||
|
|
||||||
this.starting ||
|
|
||||||
this.libraries.length === 0}
|
|
||||||
@click=${this.fullRescan}
|
|
||||||
>
|
|
||||||
<wa-icon name="triangle-exclamation"></wa-icon>
|
|
||||||
Full rescan
|
|
||||||
</button>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
${finished.length > 0
|
|
||||||
? html`
|
|
||||||
<section>
|
|
||||||
<div class="section-head">
|
|
||||||
<h2>Recently finished</h2>
|
|
||||||
<button
|
|
||||||
class="link"
|
|
||||||
@click=${this.clearFinished}
|
|
||||||
>
|
|
||||||
Clear
|
|
||||||
</button>
|
|
||||||
</div>
|
|
||||||
${this.renderJobList(finished, '')}
|
|
||||||
</section>
|
|
||||||
`
|
|
||||||
: nothing}
|
|
||||||
|
|
||||||
<job-details-drawer
|
|
||||||
job-id=${this.drawerJobId}
|
|
||||||
?open=${this.drawerOpen}
|
|
||||||
@drawer-closed=${this.onDrawerClosed}
|
|
||||||
></job-details-drawer>
|
|
||||||
`;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
declare global {
|
|
||||||
interface HTMLElementTagNameMap {
|
|
||||||
'jobs-view': JobsView;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,133 @@
|
|||||||
|
import { LitElement, html, css } from 'lit';
|
||||||
|
import { customElement } from 'lit/decorators.js';
|
||||||
|
import '@awesome.me/webawesome/dist/components/icon/icon.js';
|
||||||
|
import { designTokens } from '../../styles/tokens.css';
|
||||||
|
import { HistoryController } from '@store/controllers/history-controller';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Global back and forward, in the top bar (#6).
|
||||||
|
*
|
||||||
|
* **The stack was already global; the affordance was not.** Every
|
||||||
|
* navigation has been a history entry since the Android back gesture
|
||||||
|
* landed, and `popstate` restores any of them in either direction --
|
||||||
|
* `back-navigation.spec.ts` has asserted `goForward()` since it was
|
||||||
|
* written. What the report describes as "back is tab-scoped" is that
|
||||||
|
* the *only* way back was a detail view's own button, which vanishes
|
||||||
|
* the moment you leave for another tab: the album you were reading is
|
||||||
|
* still one entry away, and nothing on screen says so or offers it.
|
||||||
|
*
|
||||||
|
* Four things about this are load-bearing.
|
||||||
|
*
|
||||||
|
* **It asks the shell rather than the History API.** `history.length`
|
||||||
|
* counts entries this app did not push and never shrinks, and there is
|
||||||
|
* no way to ask where in the list you are -- so a control derived from
|
||||||
|
* it is confidently wrong at both ends. `historyStore` is the shell's
|
||||||
|
* own numbering.
|
||||||
|
*
|
||||||
|
* **A control that cannot act is `disabled`, not hidden.** This is the
|
||||||
|
* one place in the app where that is right rather than the fault
|
||||||
|
* `library-status-indicator` was: back and forward are a *pair* whose
|
||||||
|
* positions the user learns, and a button that disappears at the end
|
||||||
|
* of the list moves the other one under the cursor. It is also what
|
||||||
|
* every browser does, which is the whole design brief here.
|
||||||
|
*
|
||||||
|
* **The buttons dispatch the events the rest of the app already
|
||||||
|
* dispatches**, `navigate-back` and `navigate-forward`, rather than
|
||||||
|
* calling `history.back()` themselves. The shell owns the guard -- one
|
||||||
|
* press is one entry, and at the root there is nothing of ours to go
|
||||||
|
* back to -- and a second caller reaching for `history` directly is
|
||||||
|
* how the old `navStack` came to disagree with the platform.
|
||||||
|
*
|
||||||
|
* **It is desktop chrome.** Below 600px the phone has a system back
|
||||||
|
* gesture (and, on Android, a hardware/gesture Back that this app
|
||||||
|
* hooks), the top bar is 3.25em with three other things in it, and two
|
||||||
|
* more 32px targets there would be the first thing to overflow. Hidden
|
||||||
|
* by `index.css` at that width, next to the rest of the phone header's
|
||||||
|
* concessions.
|
||||||
|
*/
|
||||||
|
@customElement('nav-history')
|
||||||
|
export class NavHistory extends LitElement {
|
||||||
|
private historyCtrl = new HistoryController(this);
|
||||||
|
|
||||||
|
static override styles = [designTokens, css`
|
||||||
|
:host {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 0.25em;
|
||||||
|
/* A grid item's implicit minimum is its content; this one
|
||||||
|
genuinely cannot shrink, so it says so rather than
|
||||||
|
letting the header widen the body. */
|
||||||
|
flex: 0 0 auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
button {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
width: 2em;
|
||||||
|
height: 2em;
|
||||||
|
padding: 0;
|
||||||
|
border: none;
|
||||||
|
border-radius: 50%;
|
||||||
|
background: transparent;
|
||||||
|
color: var(--yj-text-primary, #f8f9fa);
|
||||||
|
cursor: pointer;
|
||||||
|
font-size: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
button:hover:not(:disabled) {
|
||||||
|
background-color: var(--yj-bg-overlay, #495057);
|
||||||
|
}
|
||||||
|
|
||||||
|
button:focus-visible {
|
||||||
|
outline: 2px solid var(--yj-accent, #ffd43b);
|
||||||
|
outline-offset: 2px;
|
||||||
|
}
|
||||||
|
|
||||||
|
button:disabled {
|
||||||
|
/* Not a contrast failure: a disabled control is exempt from
|
||||||
|
1.4.3, and the pair has to read as unavailable rather
|
||||||
|
than merely quiet. */
|
||||||
|
color: var(--yj-text-tertiary, #868e96);
|
||||||
|
cursor: default;
|
||||||
|
}
|
||||||
|
`];
|
||||||
|
|
||||||
|
private go(direction: 'back' | 'forward') {
|
||||||
|
this.dispatchEvent(new CustomEvent(`navigate-${direction}`, {
|
||||||
|
bubbles: true,
|
||||||
|
composed: true,
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
|
||||||
|
override render() {
|
||||||
|
const { canBack, canForward } = this.historyCtrl.depth;
|
||||||
|
|
||||||
|
return html`
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
data-testid="history-back"
|
||||||
|
aria-label="Back"
|
||||||
|
?disabled=${!canBack}
|
||||||
|
@click=${() => this.go('back')}
|
||||||
|
>
|
||||||
|
<wa-icon name="arrow-left"></wa-icon>
|
||||||
|
</button>
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
data-testid="history-forward"
|
||||||
|
aria-label="Forward"
|
||||||
|
?disabled=${!canForward}
|
||||||
|
@click=${() => this.go('forward')}
|
||||||
|
>
|
||||||
|
<wa-icon name="arrow-right"></wa-icon>
|
||||||
|
</button>
|
||||||
|
`;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
declare global {
|
||||||
|
interface HTMLElementTagNameMap {
|
||||||
|
'nav-history': NavHistory;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -13,6 +13,7 @@ import {
|
|||||||
isQueueSourceNavigable,
|
isQueueSourceNavigable,
|
||||||
navigateToQueueSource,
|
navigateToQueueSource,
|
||||||
} from '@utils/queue-source-link';
|
} from '@utils/queue-source-link';
|
||||||
|
import { PHONE_QUERY } from '@utils/breakpoints';
|
||||||
import { PlayerController } from '@store/controllers/player-controller';
|
import { PlayerController } from '@store/controllers/player-controller';
|
||||||
import { creditStore } from '@store/credit-store';
|
import { creditStore } from '@store/credit-store';
|
||||||
import { QueueController } from '@store/controllers/queue-controller';
|
import { QueueController } from '@store/controllers/queue-controller';
|
||||||
@@ -80,6 +81,19 @@ export class NowPlaying extends LitElement {
|
|||||||
|
|
||||||
private reduceMotionQuery?: MediaQueryList;
|
private reduceMotionQuery?: MediaQueryList;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Phone width, from the shell's own breakpoint.
|
||||||
|
*
|
||||||
|
* This is in JS rather than in the stylesheet because what changes
|
||||||
|
* is the *content*, not its appearance: the title, artist and
|
||||||
|
* source render as plain text instead of as links, and no CSS rule
|
||||||
|
* can take a click handler off an element.
|
||||||
|
*/
|
||||||
|
@state()
|
||||||
|
private phone = false;
|
||||||
|
|
||||||
|
private phoneQuery?: MediaQueryList;
|
||||||
|
|
||||||
/** Whether each field is actively mid-scroll (class toggle). */
|
/** Whether each field is actively mid-scroll (class toggle). */
|
||||||
@state()
|
@state()
|
||||||
private titleScrolling = false;
|
private titleScrolling = false;
|
||||||
@@ -174,6 +188,27 @@ export class NowPlaying extends LitElement {
|
|||||||
cursor: pointer;
|
cursor: pointer;
|
||||||
/* The art shows through; this is a target, not a picture. */
|
/* The art shows through; this is a target, not a picture. */
|
||||||
color: transparent;
|
color: transparent;
|
||||||
|
/* **Above the art, or it is not a target at all** (#150).
|
||||||
|
|
||||||
|
This button is absolutely positioned with z-index auto and
|
||||||
|
the art is a *later* sibling, so the two tie on paint order
|
||||||
|
and the later one wins. With an <img> that costs nothing --
|
||||||
|
an image is not a hit-test obstacle here -- but a track with
|
||||||
|
no artwork renders a placeholder wa-icon, which is, and it
|
||||||
|
takes every click aimed at the button underneath it.
|
||||||
|
|
||||||
|
The failure is therefore per *track*, not per build: on a
|
||||||
|
phone the only way into the full-screen now-playing view
|
||||||
|
stopped working whenever the current song had no cover.
|
||||||
|
Measured with elementFromPoint at the button's centre --
|
||||||
|
wa-icon with a placeholder, button.expand with an image, and
|
||||||
|
button.expand either way once this line exists.
|
||||||
|
|
||||||
|
z-index rather than pointer-events: none on the art, which
|
||||||
|
would take the cover preview's mouseenter with it; and
|
||||||
|
rather than reordering the DOM, which would leave the same
|
||||||
|
tie to be won by the same accident in the other direction. */
|
||||||
|
z-index: 1;
|
||||||
}
|
}
|
||||||
|
|
||||||
.expand:focus-visible {
|
.expand:focus-visible {
|
||||||
@@ -341,6 +376,12 @@ export class NowPlaying extends LitElement {
|
|||||||
this.reduceMotion = this.reduceMotionQuery?.matches ?? false;
|
this.reduceMotion = this.reduceMotionQuery?.matches ?? false;
|
||||||
this.reduceMotionQuery?.addEventListener('change', this.handleReduceMotionChange);
|
this.reduceMotionQuery?.addEventListener('change', this.handleReduceMotionChange);
|
||||||
|
|
||||||
|
// Same reasoning as above: looked up here, not at module load,
|
||||||
|
// so a test can install its own matchMedia first.
|
||||||
|
this.phoneQuery = window.matchMedia?.(PHONE_QUERY);
|
||||||
|
this.phone = this.phoneQuery?.matches ?? false;
|
||||||
|
this.phoneQuery?.addEventListener('change', this.handlePhoneChange);
|
||||||
|
|
||||||
this.resizeObserver = new ResizeObserver(() => {
|
this.resizeObserver = new ResizeObserver(() => {
|
||||||
this.geometryDirty = true;
|
this.geometryDirty = true;
|
||||||
this.requestUpdate();
|
this.requestUpdate();
|
||||||
@@ -364,6 +405,7 @@ export class NowPlaying extends LitElement {
|
|||||||
this.attachDragListeners(false);
|
this.attachDragListeners(false);
|
||||||
window.removeEventListener(SCROLL_CHANGE_EVENT, this.handleScrollModeEvent);
|
window.removeEventListener(SCROLL_CHANGE_EVENT, this.handleScrollModeEvent);
|
||||||
this.reduceMotionQuery?.removeEventListener('change', this.handleReduceMotionChange);
|
this.reduceMotionQuery?.removeEventListener('change', this.handleReduceMotionChange);
|
||||||
|
this.phoneQuery?.removeEventListener('change', this.handlePhoneChange);
|
||||||
this.resizeObserver?.disconnect();
|
this.resizeObserver?.disconnect();
|
||||||
this.stopScrollCycle('title');
|
this.stopScrollCycle('title');
|
||||||
this.stopScrollCycle('artist');
|
this.stopScrollCycle('artist');
|
||||||
@@ -488,7 +530,7 @@ export class NowPlaying extends LitElement {
|
|||||||
@mouseleave=${this.handleTitleMouseLeave}
|
@mouseleave=${this.handleTitleMouseLeave}
|
||||||
@transitionend=${() => this.onScrollCycleEnd('title')}
|
@transitionend=${() => this.onScrollCycleEnd('title')}
|
||||||
>
|
>
|
||||||
<span class="scroll-content">${trackLink(track.title, track.album, track.releaseGroupMbid, track.recordingMbid) || track.title}</span>
|
<span class="scroll-content">${this.phone ? track.title : trackLink(track.title, track.album, track.releaseGroupMbid, track.recordingMbid) || track.title}</span>
|
||||||
</span>
|
</span>
|
||||||
<span
|
<span
|
||||||
class="track-artist ${artistScrolling ? 'will-scroll' : ''} ${this.artistScrolling ? 'scrolling' : ''}"
|
class="track-artist ${artistScrolling ? 'will-scroll' : ''} ${this.artistScrolling ? 'scrolling' : ''}"
|
||||||
@@ -498,14 +540,15 @@ export class NowPlaying extends LitElement {
|
|||||||
@mouseleave=${this.handleArtistMouseLeave}
|
@mouseleave=${this.handleArtistMouseLeave}
|
||||||
@transitionend=${() => this.onScrollCycleEnd('artist')}
|
@transitionend=${() => this.onScrollCycleEnd('artist')}
|
||||||
>
|
>
|
||||||
<span class="scroll-content">${creditLink(creditStore.credits(track.recordingMbid), track.artist, track.artistMbid) || 'Unknown Artist'}</span>
|
<span class="scroll-content">${this.phone ? track.artist || 'Unknown Artist' : creditLink(creditStore.credits(track.recordingMbid), track.artist, track.artistMbid) || 'Unknown Artist'}</span>
|
||||||
</span>
|
</span>
|
||||||
${describeQueueSource(this.queue.source)
|
${describeQueueSource(this.queue.source)
|
||||||
? html`
|
? html`
|
||||||
<span
|
<span
|
||||||
class="track-source ${isQueueSourceNavigable(this.queue.source) ? 'navigable' : ''}"
|
class="track-source ${!this.phone && isQueueSourceNavigable(this.queue.source) ? 'navigable' : ''}"
|
||||||
data-testid="now-playing-source"
|
data-testid="now-playing-source"
|
||||||
@click=${(e: MouseEvent) => {
|
@click=${(e: MouseEvent) => {
|
||||||
|
if (this.phone) return;
|
||||||
if (!isQueueSourceNavigable(this.queue.source)) return;
|
if (!isQueueSourceNavigable(this.queue.source)) return;
|
||||||
navigateToQueueSource(
|
navigateToQueueSource(
|
||||||
e.currentTarget as EventTarget,
|
e.currentTarget as EventTarget,
|
||||||
@@ -571,6 +614,10 @@ export class NowPlaying extends LitElement {
|
|||||||
this.reduceMotion = e.matches;
|
this.reduceMotion = e.matches;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
private handlePhoneChange = (e: MediaQueryListEvent): void => {
|
||||||
|
this.phone = e.matches;
|
||||||
|
};
|
||||||
|
|
||||||
private shouldScroll(field: 'title' | 'artist'): boolean {
|
private shouldScroll(field: 'title' | 'artist'): boolean {
|
||||||
const overflows = field === 'title' ? this.titleOverflows : this.artistOverflows;
|
const overflows = field === 'title' ? this.titleOverflows : this.artistOverflows;
|
||||||
|
|
||||||
@@ -606,6 +653,12 @@ export class NowPlaying extends LitElement {
|
|||||||
track?.artist ?? '',
|
track?.artist ?? '',
|
||||||
this.shouldScroll('title') ? '1' : '0',
|
this.shouldScroll('title') ? '1' : '0',
|
||||||
this.shouldScroll('artist') ? '1' : '0',
|
this.shouldScroll('artist') ? '1' : '0',
|
||||||
|
// Crossing the breakpoint swaps a link for a bare string,
|
||||||
|
// and a link is not guaranteed to measure the same as the
|
||||||
|
// text inside it. The marquee travels a distance read from
|
||||||
|
// that measurement, so this belongs in the key even though
|
||||||
|
// the words are identical either side.
|
||||||
|
this.phone ? '1' : '0',
|
||||||
].join('\u0000');
|
].join('\u0000');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,8 +1,16 @@
|
|||||||
import { LitElement, html, css, nothing } from 'lit';
|
import { LitElement, html, css, nothing } from 'lit';
|
||||||
import { customElement, property } from 'lit/decorators.js';
|
import { customElement, property, query, state } from 'lit/decorators.js';
|
||||||
import '@awesome.me/webawesome/dist/components/icon/icon.js';
|
import '@awesome.me/webawesome/dist/components/icon/icon.js';
|
||||||
|
import '@awesome.me/webawesome/dist/components/popup/popup.js';
|
||||||
|
import '@awesome.me/webawesome/dist/components/dropdown-item/dropdown-item.js';
|
||||||
|
import type WaPopup from '@awesome.me/webawesome/dist/components/popup/popup.js';
|
||||||
|
|
||||||
import { designTokens } from '../../styles/tokens.css';
|
import { designTokens } from '../../styles/tokens.css';
|
||||||
|
import {
|
||||||
|
MenuKeyboard,
|
||||||
|
contextMenuStyles,
|
||||||
|
} from '../../utils/context-menu-controller';
|
||||||
|
import { ICON_MORE_ACTIONS } from '../../utils/icon-language';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The one arrangement every primary view uses to say what it is.
|
* The one arrangement every primary view uses to say what it is.
|
||||||
@@ -18,6 +26,19 @@ import { designTokens } from '../../styles/tokens.css';
|
|||||||
* Title, count, sort, actions — in that order, in one component, so a
|
* Title, count, sort, actions — in that order, in one component, so a
|
||||||
* new view gets the shape by using it rather than by copying whichever
|
* new view gets the shape by using it rather than by copying whichever
|
||||||
* neighbour it happened to read.
|
* neighbour it happened to read.
|
||||||
|
*
|
||||||
|
* **Actions are data, and `<slot name="actions">` is the exception.**
|
||||||
|
* Playlists' three buttons totalled 390px inside a header that gets
|
||||||
|
* 700px at 900×600 and clipped "New Smart Playlist" to 114 of its 162
|
||||||
|
* (#69) — a live defect at a size the app promises, against plan 018's
|
||||||
|
* *no action is ever unreachable at any supported size*. The header
|
||||||
|
* cannot fix that for slotted markup: it cannot move another
|
||||||
|
* component's light-DOM children into a dropdown and keep their
|
||||||
|
* behaviour, and arbitrary markup offers nothing generic to render as
|
||||||
|
* a menu item. So a host declares `PageAction[]` and the header picks
|
||||||
|
* the rendering. The slot survives for markup a data list genuinely
|
||||||
|
* cannot express, at the stated cost that **a slotted action does not
|
||||||
|
* collapse** and must therefore fit at 800×600.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
export interface SortOption {
|
export interface SortOption {
|
||||||
@@ -27,6 +48,50 @@ export interface SortOption {
|
|||||||
|
|
||||||
export type SortDirection = 'asc' | 'desc';
|
export type SortDirection = 'asc' | 'desc';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An action that only makes sense while it is a button.
|
||||||
|
*
|
||||||
|
* A drop target is the case: you cannot drag a track onto a closed
|
||||||
|
* menu, so the affordance is absent from the overflow rather than
|
||||||
|
* approximated there. The header wires these onto the button it
|
||||||
|
* renders and owns none of them — the same division the sort control
|
||||||
|
* already lives by.
|
||||||
|
*/
|
||||||
|
export interface PageActionDrop {
|
||||||
|
/** True while an acceptable payload is over the button. */
|
||||||
|
active?: boolean;
|
||||||
|
onDragOver: (e: DragEvent) => void;
|
||||||
|
onDragLeave: (e: DragEvent) => void;
|
||||||
|
onDrop: (e: DragEvent) => void;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* One thing a view can do, as data rather than as markup.
|
||||||
|
*
|
||||||
|
* `<slot name="actions">` cannot be collapsed, and that is a fact about
|
||||||
|
* the API rather than an effort estimate (#69): a component cannot move
|
||||||
|
* another component's light-DOM children into a dropdown and keep their
|
||||||
|
* behaviour, and there is nothing generic in arbitrary markup to render
|
||||||
|
* as a menu item. Declaring an action instead is what lets the header
|
||||||
|
* choose between the two renderings.
|
||||||
|
*/
|
||||||
|
export interface PageAction {
|
||||||
|
id: string;
|
||||||
|
label: string;
|
||||||
|
/** From `utils/icon-language`, never a literal. */
|
||||||
|
icon: string;
|
||||||
|
onSelect: () => void;
|
||||||
|
/**
|
||||||
|
* Higher survives longer. The lowest collapses first, ties broken
|
||||||
|
* by declaration order from the right, so a host that says nothing
|
||||||
|
* gets "the last one written goes first".
|
||||||
|
*/
|
||||||
|
priority?: number;
|
||||||
|
disabled?: boolean;
|
||||||
|
title?: string;
|
||||||
|
drop?: PageActionDrop;
|
||||||
|
}
|
||||||
|
|
||||||
@customElement('page-header')
|
@customElement('page-header')
|
||||||
export class PageHeader extends LitElement {
|
export class PageHeader extends LitElement {
|
||||||
/**
|
/**
|
||||||
@@ -80,8 +145,82 @@ export class PageHeader extends LitElement {
|
|||||||
@property({ type: Boolean })
|
@property({ type: Boolean })
|
||||||
busy = false;
|
busy = false;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* What this view can do, in the order it wants them shown.
|
||||||
|
*
|
||||||
|
* The header decides what *fits*; the host decides what *happens*.
|
||||||
|
* That is the rule the sort control already lives by — it asks for
|
||||||
|
* a sort rather than performing one — and actions follow it, which
|
||||||
|
* is why an action carries a handler rather than the header
|
||||||
|
* carrying a verb it would have to interpret.
|
||||||
|
*/
|
||||||
|
@property({ attribute: false })
|
||||||
|
actions: PageAction[] = [];
|
||||||
|
|
||||||
|
/** Action ids currently in the overflow menu. Derived, never set by a host. */
|
||||||
|
@state()
|
||||||
|
private collapsed: ReadonlySet<string> = new Set();
|
||||||
|
|
||||||
|
@state()
|
||||||
|
private menuOpen = false;
|
||||||
|
|
||||||
|
@query('.page-header')
|
||||||
|
private headerEl?: HTMLElement;
|
||||||
|
|
||||||
|
@query('.more-button')
|
||||||
|
private moreButton?: HTMLButtonElement;
|
||||||
|
|
||||||
|
@query('#page-header-overflow')
|
||||||
|
private menuPanel?: HTMLElement;
|
||||||
|
|
||||||
|
@query('wa-popup')
|
||||||
|
private popup?: WaPopup;
|
||||||
|
|
||||||
|
private menuKeyboard = new MenuKeyboard(() => this.closeMenu());
|
||||||
|
|
||||||
|
private resizeObserver?: ResizeObserver;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether the outside-click listener is attached.
|
||||||
|
*
|
||||||
|
* A `removeEventListener` with no matching `add` is not harmless
|
||||||
|
* here: `view-lifecycle.test.ts` counts document listeners across a
|
||||||
|
* view's life and an unconditional detach on disconnect shows up as
|
||||||
|
* `held: -1`, which is the same accounting that would hide a real
|
||||||
|
* leak in the other direction.
|
||||||
|
*/
|
||||||
|
private outsideCloseAttached = false;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* What the last fit was measured against.
|
||||||
|
*
|
||||||
|
* `updated()` runs on every pass, so it has to say what it depends
|
||||||
|
* on or it re-measures — and a measurement here forces synchronous
|
||||||
|
* layout. Width changes arrive through the ResizeObserver; this key
|
||||||
|
* covers everything *else* in the flex row that can change how much
|
||||||
|
* of it the actions are left.
|
||||||
|
|
||||||
|
*/
|
||||||
|
private lastFitKey = '';
|
||||||
|
|
||||||
|
override connectedCallback(): void {
|
||||||
|
super.connectedCallback();
|
||||||
|
|
||||||
|
this.resizeObserver = new ResizeObserver(() => this.measureFit());
|
||||||
|
this.resizeObserver.observe(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
override disconnectedCallback(): void {
|
||||||
|
super.disconnectedCallback();
|
||||||
|
|
||||||
|
this.resizeObserver?.disconnect();
|
||||||
|
this.resizeObserver = undefined;
|
||||||
|
this.detachOutsideClose();
|
||||||
|
}
|
||||||
|
|
||||||
static override styles = [
|
static override styles = [
|
||||||
designTokens,
|
designTokens,
|
||||||
|
contextMenuStyles,
|
||||||
css`
|
css`
|
||||||
:host {
|
:host {
|
||||||
display: block;
|
display: block;
|
||||||
@@ -96,12 +235,26 @@ export class PageHeader extends LitElement {
|
|||||||
border-bottom: 1px solid var(--yj-border-subtle, #333);
|
border-bottom: 1px solid var(--yj-border-subtle, #333);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* The title gives way before an action does.
|
||||||
|
|
||||||
|
Everything in this row was flex-shrink: 0, so whatever
|
||||||
|
came last lost — and the actions come last, which is how
|
||||||
|
the "More actions" button ended up 76px off the right
|
||||||
|
edge of a 320px viewport with every action already
|
||||||
|
collapsed into it. The title is the one thing here the
|
||||||
|
navigation also says (the sidebar item is selected, the
|
||||||
|
bottom-nav tab is current), so it is the cheapest thing
|
||||||
|
to truncate; the count, the sort and the actions are each
|
||||||
|
the only place they are said. */
|
||||||
h1 {
|
h1 {
|
||||||
margin: 0;
|
margin: 0;
|
||||||
font-size: var(--yj-text-xl, 18px);
|
font-size: var(--yj-text-xl, 18px);
|
||||||
font-weight: 600;
|
font-weight: 600;
|
||||||
color: var(--yj-text-primary, #fff);
|
color: var(--yj-text-primary, #fff);
|
||||||
white-space: nowrap;
|
white-space: nowrap;
|
||||||
|
overflow: hidden;
|
||||||
|
text-overflow: ellipsis;
|
||||||
|
min-width: 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
.count {
|
.count {
|
||||||
@@ -191,6 +344,98 @@ export class PageHeader extends LitElement {
|
|||||||
::slotted(*) {
|
::slotted(*) {
|
||||||
flex-shrink: 0;
|
flex-shrink: 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.actions {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 8px;
|
||||||
|
flex-shrink: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.action,
|
||||||
|
.more-button {
|
||||||
|
background: none;
|
||||||
|
border: 1px solid var(--yj-border-subtle, #555);
|
||||||
|
border-radius: 4px;
|
||||||
|
color: var(--yj-text-primary, #fff);
|
||||||
|
padding: 6px 12px;
|
||||||
|
font-size: var(--yj-text-md, 13px);
|
||||||
|
font-family: inherit;
|
||||||
|
cursor: pointer;
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 6px;
|
||||||
|
white-space: nowrap;
|
||||||
|
flex-shrink: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.more-button {
|
||||||
|
padding: 6px 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* The display: flex above outranks the UA stylesheet's
|
||||||
|
rule for [hidden], and hiding is how an action
|
||||||
|
collapses. (No backticks in here: one ends the css
|
||||||
|
literal, and what you get is "css(...) is not a
|
||||||
|
function" a long way from the cause.) */
|
||||||
|
.action[hidden],
|
||||||
|
.more-button[hidden] {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.action:hover,
|
||||||
|
.more-button:hover,
|
||||||
|
.action.drag-over {
|
||||||
|
border-color: var(--yj-accent, #ffd43b);
|
||||||
|
color: var(--yj-accent-text, #ffd43b);
|
||||||
|
}
|
||||||
|
|
||||||
|
.action.drag-over {
|
||||||
|
background-color: var(
|
||||||
|
--yj-accent-bg-strong,
|
||||||
|
rgba(255, 212, 59, 0.15)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
.action:disabled {
|
||||||
|
opacity: 0.5;
|
||||||
|
cursor: default;
|
||||||
|
}
|
||||||
|
|
||||||
|
.action:focus-visible,
|
||||||
|
.more-button:focus-visible {
|
||||||
|
outline: 2px solid var(--yj-accent, #ffd43b);
|
||||||
|
outline-offset: -1px;
|
||||||
|
}
|
||||||
|
|
||||||
|
wa-popup {
|
||||||
|
z-index: 200;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* A component states what it drops at phone width itself,
|
||||||
|
in its own stylesheet, because a media query inside a
|
||||||
|
shadow root is answered by the viewport and the shell
|
||||||
|
cannot reach in. Here that is one word: the sort control
|
||||||
|
is 172px of a 320px header, and "Sort:" is ~40px of it
|
||||||
|
for a label the adjacent direction arrow already implies.
|
||||||
|
It stays in the accessibility tree — it is the select's
|
||||||
|
accessible name, so hiding it outright would rename the
|
||||||
|
control to nothing — which is config-field's bug, one
|
||||||
|
component over. clip-path rather than display: none for
|
||||||
|
the reason styles/sr-only.css.ts gives. */
|
||||||
|
@media (max-width: 599px) {
|
||||||
|
.sort-label {
|
||||||
|
position: absolute;
|
||||||
|
width: 1px;
|
||||||
|
height: 1px;
|
||||||
|
margin: -1px;
|
||||||
|
padding: 0;
|
||||||
|
overflow: hidden;
|
||||||
|
clip-path: inset(50%);
|
||||||
|
white-space: nowrap;
|
||||||
|
border: 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
`,
|
`,
|
||||||
];
|
];
|
||||||
|
|
||||||
@@ -212,11 +457,293 @@ export class PageHeader extends LitElement {
|
|||||||
${this.renderCount()}
|
${this.renderCount()}
|
||||||
<div class="spacer"></div>
|
<div class="spacer"></div>
|
||||||
${this.renderScope()} ${this.renderSort()}
|
${this.renderScope()} ${this.renderSort()}
|
||||||
|
${this.renderActions()}
|
||||||
<slot name="actions"></slot>
|
<slot name="actions"></slot>
|
||||||
</header>
|
</header>
|
||||||
`;
|
`;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
protected override updated(): void {
|
||||||
|
const key = [
|
||||||
|
this.heading,
|
||||||
|
this.count,
|
||||||
|
this.countNoun,
|
||||||
|
this.countPlural,
|
||||||
|
this.searchTerm,
|
||||||
|
this.sortOptions.length,
|
||||||
|
this.sortField,
|
||||||
|
this.sortDirection,
|
||||||
|
this.busy,
|
||||||
|
this.actions.map((a) => `${a.id}:${a.label}:${a.disabled ?? false}`).join(','),
|
||||||
|
].join('|');
|
||||||
|
|
||||||
|
if (key === this.lastFitKey) return;
|
||||||
|
|
||||||
|
this.lastFitKey = key;
|
||||||
|
this.measureFit();
|
||||||
|
}
|
||||||
|
|
||||||
|
// =================================================================
|
||||||
|
// What fits
|
||||||
|
// =================================================================
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Decide which actions are buttons and which are menu items.
|
||||||
|
*
|
||||||
|
* Two things about the shape of this are load-bearing.
|
||||||
|
*
|
||||||
|
* **Every pass starts from all-visible**, so the collapsed set is a
|
||||||
|
* pure function of the current width rather than of the order the
|
||||||
|
* widths arrived in. A rule that only ever *added* to the set would
|
||||||
|
* never give an action back when the window grew, and one that
|
||||||
|
* adjusted by a step would need a hysteresis band to stop it
|
||||||
|
* oscillating on the pixel where a button exactly fits.
|
||||||
|
*
|
||||||
|
* **It flips `hidden` on the rendered nodes rather than re-rendering
|
||||||
|
* between steps.** Reading `scrollWidth` forces layout, which is the
|
||||||
|
* point; awaiting a Lit update between steps instead would let the
|
||||||
|
* intermediate all-visible state paint, so the fix would flash the
|
||||||
|
* overflow it exists to prevent. The reactive state is set once, at
|
||||||
|
* the end, and the next render agrees with what was measured.
|
||||||
|
*
|
||||||
|
* The budget is the *header's* overflow and not the actions row's,
|
||||||
|
* because the count and the sort control are `flex-shrink: 0` and
|
||||||
|
* are therefore competing for the same width — only `.scope` gives
|
||||||
|
* way, which is what it has an ellipsis for.
|
||||||
|
*/
|
||||||
|
private measureFit(): void {
|
||||||
|
const header = this.headerEl;
|
||||||
|
|
||||||
|
if (!header) return;
|
||||||
|
|
||||||
|
if (this.actions.length === 0) {
|
||||||
|
this.commitCollapsed(new Set());
|
||||||
|
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const buttons = new Map<string, HTMLElement>();
|
||||||
|
|
||||||
|
for (const el of this.renderRoot.querySelectorAll<HTMLElement>(
|
||||||
|
'[data-action-id]',
|
||||||
|
)) {
|
||||||
|
const id = el.dataset['actionId'];
|
||||||
|
|
||||||
|
if (id !== undefined) buttons.set(id, el);
|
||||||
|
}
|
||||||
|
|
||||||
|
const more = this.moreButton;
|
||||||
|
const title = this.renderRoot.querySelector('h1');
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Nothing is clipped — which is not the same as the header not
|
||||||
|
* overflowing, and the difference is a trap worth naming.
|
||||||
|
*
|
||||||
|
* Once the title can ellipsis, it absorbs the pressure and
|
||||||
|
* `scrollWidth` reports a header that fits perfectly while the
|
||||||
|
* heading reads "Playlis…". That is this issue's own failure
|
||||||
|
* mode moved from the button to the title, and it is invisible
|
||||||
|
* to exactly the same measurement that missed it the first time.
|
||||||
|
* So the title's own truncation counts as not fitting, and
|
||||||
|
* collapsing an action is tried before the title gives way.
|
||||||
|
*/
|
||||||
|
const fits = () =>
|
||||||
|
header.scrollWidth <= header.clientWidth &&
|
||||||
|
(title === null || title.scrollWidth <= title.clientWidth + 1);
|
||||||
|
|
||||||
|
for (const el of buttons.values()) el.hidden = false;
|
||||||
|
|
||||||
|
if (more) more.hidden = true;
|
||||||
|
|
||||||
|
const collapsed = new Set<string>();
|
||||||
|
|
||||||
|
if (!fits()) {
|
||||||
|
if (more) more.hidden = false;
|
||||||
|
|
||||||
|
for (const action of this.collapseOrder()) {
|
||||||
|
collapsed.add(action.id);
|
||||||
|
|
||||||
|
const el = buttons.get(action.id);
|
||||||
|
|
||||||
|
if (el) el.hidden = true;
|
||||||
|
|
||||||
|
if (fits()) break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
this.commitCollapsed(collapsed);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Lowest priority first; ties broken from the right. */
|
||||||
|
private collapseOrder(): PageAction[] {
|
||||||
|
return this.actions
|
||||||
|
.map((action, index) => ({ action, index }))
|
||||||
|
.sort(
|
||||||
|
(a, b) =>
|
||||||
|
(a.action.priority ?? 0) - (b.action.priority ?? 0) ||
|
||||||
|
b.index - a.index,
|
||||||
|
)
|
||||||
|
.map(({ action }) => action);
|
||||||
|
}
|
||||||
|
|
||||||
|
private commitCollapsed(next: Set<string>): void {
|
||||||
|
const same =
|
||||||
|
next.size === this.collapsed.size &&
|
||||||
|
[...next].every((id) => this.collapsed.has(id));
|
||||||
|
|
||||||
|
if (same) return;
|
||||||
|
|
||||||
|
this.collapsed = next;
|
||||||
|
|
||||||
|
// Nothing left to show in it. Closing rather than leaving an
|
||||||
|
// empty menu open is the same rule the shelves follow.
|
||||||
|
if (next.size === 0 && this.menuOpen) this.closeMenu();
|
||||||
|
}
|
||||||
|
|
||||||
|
// =================================================================
|
||||||
|
// Rendering
|
||||||
|
// =================================================================
|
||||||
|
|
||||||
|
private renderActions() {
|
||||||
|
if (this.actions.length === 0) return nothing;
|
||||||
|
|
||||||
|
const overflowed = this.actions.filter((a) => this.collapsed.has(a.id));
|
||||||
|
|
||||||
|
return html`
|
||||||
|
<div class="actions">
|
||||||
|
${this.actions.map((a) => this.renderActionButton(a))}
|
||||||
|
<wa-popup
|
||||||
|
placement="bottom-end"
|
||||||
|
flip
|
||||||
|
shift
|
||||||
|
.active=${this.menuOpen}
|
||||||
|
>
|
||||||
|
<button
|
||||||
|
slot="anchor"
|
||||||
|
class="more-button"
|
||||||
|
type="button"
|
||||||
|
data-testid="page-actions-more"
|
||||||
|
aria-label="More actions"
|
||||||
|
aria-haspopup="menu"
|
||||||
|
aria-expanded=${this.menuOpen ? 'true' : 'false'}
|
||||||
|
aria-controls="page-header-overflow"
|
||||||
|
?hidden=${overflowed.length === 0}
|
||||||
|
@click=${this.onMoreClick}
|
||||||
|
>
|
||||||
|
<wa-icon name=${ICON_MORE_ACTIONS}></wa-icon>
|
||||||
|
</button>
|
||||||
|
<div
|
||||||
|
id="page-header-overflow"
|
||||||
|
class="context-menu-panel"
|
||||||
|
role="menu"
|
||||||
|
aria-label="More actions"
|
||||||
|
>
|
||||||
|
${overflowed.map(
|
||||||
|
(a) => html`
|
||||||
|
<wa-dropdown-item
|
||||||
|
?disabled=${a.disabled ?? false}
|
||||||
|
@click=${() => this.onActionSelect(a)}
|
||||||
|
>
|
||||||
|
<wa-icon
|
||||||
|
slot="icon"
|
||||||
|
name=${a.icon}
|
||||||
|
></wa-icon>
|
||||||
|
${a.label}
|
||||||
|
</wa-dropdown-item>
|
||||||
|
`,
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
</wa-popup>
|
||||||
|
</div>
|
||||||
|
`;
|
||||||
|
}
|
||||||
|
|
||||||
|
private renderActionButton(a: PageAction) {
|
||||||
|
const drop = a.drop;
|
||||||
|
|
||||||
|
return html`
|
||||||
|
<button
|
||||||
|
class="action ${drop?.active === true ? 'drag-over' : ''}"
|
||||||
|
type="button"
|
||||||
|
data-action-id=${a.id}
|
||||||
|
data-testid=${`page-action-${a.id}`}
|
||||||
|
title=${a.title ?? nothing}
|
||||||
|
?disabled=${a.disabled ?? false}
|
||||||
|
?hidden=${this.collapsed.has(a.id)}
|
||||||
|
@click=${() => a.onSelect()}
|
||||||
|
@dragover=${(e: DragEvent) => drop?.onDragOver(e)}
|
||||||
|
@dragleave=${(e: DragEvent) => drop?.onDragLeave(e)}
|
||||||
|
@drop=${(e: DragEvent) => drop?.onDrop(e)}
|
||||||
|
>
|
||||||
|
<wa-icon name=${a.icon}></wa-icon>
|
||||||
|
${a.label}
|
||||||
|
</button>
|
||||||
|
`;
|
||||||
|
}
|
||||||
|
|
||||||
|
// =================================================================
|
||||||
|
// The overflow menu
|
||||||
|
// =================================================================
|
||||||
|
|
||||||
|
private onActionSelect(a: PageAction): void {
|
||||||
|
if (a.disabled === true) return;
|
||||||
|
|
||||||
|
this.closeMenu();
|
||||||
|
a.onSelect();
|
||||||
|
}
|
||||||
|
|
||||||
|
private onMoreClick = (): void => {
|
||||||
|
if (this.menuOpen) {
|
||||||
|
this.closeMenu();
|
||||||
|
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
this.menuOpen = true;
|
||||||
|
|
||||||
|
void this.updateComplete.then(() => {
|
||||||
|
if (!this.menuOpen) return;
|
||||||
|
|
||||||
|
this.popup?.reposition();
|
||||||
|
this.menuKeyboard.open(this.menuPanel ?? null, this.moreButton);
|
||||||
|
this.attachOutsideClose();
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
private closeMenu(): void {
|
||||||
|
if (!this.menuOpen) return;
|
||||||
|
|
||||||
|
this.detachOutsideClose();
|
||||||
|
this.menuKeyboard.close();
|
||||||
|
this.menuOpen = false;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A click anywhere else closes it. `composedPath` rather than
|
||||||
|
* `contains`, because the trigger and the panel are both inside
|
||||||
|
* this shadow root and a click retargets at the host.
|
||||||
|
*/
|
||||||
|
private onOutsideDown = (e: Event): void => {
|
||||||
|
if (e.composedPath().includes(this.menuPanel as EventTarget)) return;
|
||||||
|
if (e.composedPath().includes(this.moreButton as EventTarget)) return;
|
||||||
|
|
||||||
|
this.closeMenu();
|
||||||
|
};
|
||||||
|
|
||||||
|
private attachOutsideClose(): void {
|
||||||
|
if (this.outsideCloseAttached) return;
|
||||||
|
|
||||||
|
this.outsideCloseAttached = true;
|
||||||
|
document.addEventListener('mousedown', this.onOutsideDown, true);
|
||||||
|
}
|
||||||
|
|
||||||
|
private detachOutsideClose(): void {
|
||||||
|
if (!this.outsideCloseAttached) return;
|
||||||
|
|
||||||
|
this.outsideCloseAttached = false;
|
||||||
|
document.removeEventListener('mousedown', this.onOutsideDown, true);
|
||||||
|
}
|
||||||
|
|
||||||
private renderCount() {
|
private renderCount() {
|
||||||
if (this.count === null) return nothing;
|
if (this.count === null) return nothing;
|
||||||
|
|
||||||
@@ -258,7 +785,10 @@ export class PageHeader extends LitElement {
|
|||||||
if (this.sortOptions.length === 1) {
|
if (this.sortOptions.length === 1) {
|
||||||
return html`
|
return html`
|
||||||
<div class="sort">
|
<div class="sort">
|
||||||
<span>Sort: ${this.sortOptions[0]?.label}</span>
|
<span
|
||||||
|
><span class="sort-label">Sort: </span
|
||||||
|
>${this.sortOptions[0]?.label}</span
|
||||||
|
>
|
||||||
${this.renderDirectionButton(ascending)}
|
${this.renderDirectionButton(ascending)}
|
||||||
</div>
|
</div>
|
||||||
`;
|
`;
|
||||||
@@ -267,7 +797,7 @@ export class PageHeader extends LitElement {
|
|||||||
return html`
|
return html`
|
||||||
<div class="sort">
|
<div class="sort">
|
||||||
<label>
|
<label>
|
||||||
Sort:
|
<span class="sort-label">Sort:</span>
|
||||||
<select
|
<select
|
||||||
data-testid="page-sort"
|
data-testid="page-sort"
|
||||||
.value=${this.sortField}
|
.value=${this.sortField}
|
||||||
|
|||||||
@@ -40,7 +40,10 @@ import type { DuplicateTracksDialog } from '@components/duplicate-tracks-dialog/
|
|||||||
import {
|
import {
|
||||||
ICON_NEW,
|
ICON_NEW,
|
||||||
ICON_PLAYLIST,
|
ICON_PLAYLIST,
|
||||||
|
ICON_SMART_PLAYLIST,
|
||||||
} from '@utils/icon-language';
|
} from '@utils/icon-language';
|
||||||
|
import '@components/page-header/page-header';
|
||||||
|
import type { PageAction } from '@components/page-header/page-header';
|
||||||
|
|
||||||
const SCROLL_DEBOUNCE_MS = 100;
|
const SCROLL_DEBOUNCE_MS = 100;
|
||||||
|
|
||||||
@@ -194,11 +197,6 @@ export class PlaylistView extends ViewLifecycleMixin(LitElement) {
|
|||||||
contain: layout style;
|
contain: layout style;
|
||||||
}
|
}
|
||||||
|
|
||||||
.header-actions {
|
|
||||||
display: flex;
|
|
||||||
gap: 8px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.header-spinner {
|
.header-spinner {
|
||||||
display: inline-block;
|
display: inline-block;
|
||||||
width: 14px;
|
width: 14px;
|
||||||
@@ -209,33 +207,6 @@ export class PlaylistView extends ViewLifecycleMixin(LitElement) {
|
|||||||
animation: spin 0.6s linear infinite;
|
animation: spin 0.6s linear infinite;
|
||||||
}
|
}
|
||||||
|
|
||||||
.new-playlist-button {
|
|
||||||
background: none;
|
|
||||||
border: 1px solid var(--yj-border-subtle, #555);
|
|
||||||
border-radius: 4px;
|
|
||||||
color: var(--yj-text-primary, #fff);
|
|
||||||
padding: 6px 12px;
|
|
||||||
font-size: 13px;
|
|
||||||
cursor: pointer;
|
|
||||||
display: flex;
|
|
||||||
align-items: center;
|
|
||||||
gap: 6px;
|
|
||||||
font-family: inherit;
|
|
||||||
}
|
|
||||||
|
|
||||||
.new-playlist-button:hover,
|
|
||||||
.new-playlist-button.drag-over {
|
|
||||||
border-color: var(--yj-accent, #ffd43b);
|
|
||||||
color: var(--yj-accent-text, #ffd43b);
|
|
||||||
}
|
|
||||||
|
|
||||||
.new-playlist-button.drag-over {
|
|
||||||
background-color: var(
|
|
||||||
--yj-accent-bg-strong,
|
|
||||||
rgba(255, 212, 59, 0.15)
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
.create-form {
|
.create-form {
|
||||||
display: flex;
|
display: flex;
|
||||||
align-items: center;
|
align-items: center;
|
||||||
@@ -455,25 +426,6 @@ export class PlaylistView extends ViewLifecycleMixin(LitElement) {
|
|||||||
min-width: 0;
|
min-width: 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
.import-button {
|
|
||||||
background: none;
|
|
||||||
border: 1px solid var(--yj-border-subtle, #555);
|
|
||||||
border-radius: 4px;
|
|
||||||
color: var(--yj-text-primary, #fff);
|
|
||||||
padding: 6px 12px;
|
|
||||||
font-size: 13px;
|
|
||||||
cursor: pointer;
|
|
||||||
display: flex;
|
|
||||||
align-items: center;
|
|
||||||
gap: 6px;
|
|
||||||
font-family: inherit;
|
|
||||||
}
|
|
||||||
|
|
||||||
.import-button:hover {
|
|
||||||
border-color: var(--yj-accent, #ffd43b);
|
|
||||||
color: var(--yj-accent-text, #ffd43b);
|
|
||||||
}
|
|
||||||
|
|
||||||
.import-error {
|
.import-error {
|
||||||
padding: 0.5em 0.75em;
|
padding: 0.5em 0.75em;
|
||||||
margin: 0.5em 16px 0;
|
margin: 0.5em 16px 0;
|
||||||
@@ -1022,10 +974,11 @@ export class PlaylistView extends ViewLifecycleMixin(LitElement) {
|
|||||||
) => {
|
) => {
|
||||||
const related =
|
const related =
|
||||||
e.relatedTarget as Node | null;
|
e.relatedTarget as Node | null;
|
||||||
const btn =
|
// The button the event was bound to, rather than a selector for
|
||||||
this.shadowRoot?.querySelector(
|
// it: `page-header` renders it now, so it is not in this shadow
|
||||||
'.new-playlist-button',
|
// root at all and the old `.new-playlist-button` lookup would
|
||||||
);
|
// find nothing and leave the highlight stuck on.
|
||||||
|
const btn = e.currentTarget as Element | null;
|
||||||
|
|
||||||
if (btn && !btn.contains(related)) {
|
if (btn && !btn.contains(related)) {
|
||||||
this.dragOverNewButton = false;
|
this.dragOverNewButton = false;
|
||||||
@@ -1470,6 +1423,49 @@ export class PlaylistView extends ViewLifecycleMixin(LitElement) {
|
|||||||
this.saveSortPreferences();
|
this.saveSortPreferences();
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The three things this page can do, as data.
|
||||||
|
*
|
||||||
|
* The priority order is what #69's Direction asks for and it is
|
||||||
|
* only interesting for one of them: **New Playlist is highest
|
||||||
|
* because it is the drop target**. You cannot drag a track onto a
|
||||||
|
* closed menu, so collapsing it is the one collapse here that
|
||||||
|
* removes a capability rather than relocating it. Import is lowest
|
||||||
|
* because it is the rarest, and at 900×600 it is the only one that
|
||||||
|
* has to go.
|
||||||
|
*/
|
||||||
|
private headerActions(): PageAction[] {
|
||||||
|
return [
|
||||||
|
{
|
||||||
|
id: 'import',
|
||||||
|
label: 'Import',
|
||||||
|
icon: 'file-import',
|
||||||
|
priority: 0,
|
||||||
|
onSelect: () => void this.handleImportPlaylist(),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: 'new-playlist',
|
||||||
|
label: 'New Playlist',
|
||||||
|
icon: ICON_NEW,
|
||||||
|
priority: 2,
|
||||||
|
onSelect: () => this.handleNewPlaylistClick(),
|
||||||
|
drop: {
|
||||||
|
active: this.dragOverNewButton,
|
||||||
|
onDragOver: this.onNewButtonDragOver,
|
||||||
|
onDragLeave: this.onNewButtonDragLeave,
|
||||||
|
onDrop: this.onNewButtonDrop,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: 'new-smart-playlist',
|
||||||
|
label: 'New Smart Playlist',
|
||||||
|
icon: ICON_SMART_PLAYLIST,
|
||||||
|
priority: 1,
|
||||||
|
onSelect: () => this.handleNewSmartPlaylistClick(),
|
||||||
|
},
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
override render() {
|
override render() {
|
||||||
return html`
|
return html`
|
||||||
<page-header
|
<page-header
|
||||||
@@ -1484,33 +1480,8 @@ export class PlaylistView extends ViewLifecycleMixin(LitElement) {
|
|||||||
search-term=${this.searchCtrl.term}
|
search-term=${this.searchCtrl.term}
|
||||||
?busy=${this.refreshing}
|
?busy=${this.refreshing}
|
||||||
@sort-change=${this.onPageHeaderSort}
|
@sort-change=${this.onPageHeaderSort}
|
||||||
|
.actions=${this.headerActions()}
|
||||||
>
|
>
|
||||||
<div slot="actions" class="header-actions">
|
|
||||||
<button
|
|
||||||
class="import-button"
|
|
||||||
@click=${this.handleImportPlaylist}
|
|
||||||
>
|
|
||||||
<wa-icon name="file-import"></wa-icon>
|
|
||||||
Import
|
|
||||||
</button>
|
|
||||||
<button
|
|
||||||
class="new-playlist-button ${this.dragOverNewButton ? 'drag-over' : ''}"
|
|
||||||
@click=${this.handleNewPlaylistClick}
|
|
||||||
@dragover=${this.onNewButtonDragOver}
|
|
||||||
@dragleave=${this.onNewButtonDragLeave}
|
|
||||||
@drop=${this.onNewButtonDrop}
|
|
||||||
>
|
|
||||||
<wa-icon name=${ICON_NEW}></wa-icon>
|
|
||||||
New Playlist
|
|
||||||
</button>
|
|
||||||
<button
|
|
||||||
class="new-playlist-button"
|
|
||||||
@click=${this.handleNewSmartPlaylistClick}
|
|
||||||
>
|
|
||||||
<wa-icon name="filter"></wa-icon>
|
|
||||||
New Smart Playlist
|
|
||||||
</button>
|
|
||||||
</div>
|
|
||||||
</page-header>
|
</page-header>
|
||||||
|
|
||||||
${this.importError
|
${this.importError
|
||||||
@@ -1765,7 +1736,7 @@ export class PlaylistView extends ViewLifecycleMixin(LitElement) {
|
|||||||
: entry.summary.IsSmart
|
: entry.summary.IsSmart
|
||||||
? html`<wa-icon
|
? html`<wa-icon
|
||||||
class="playlist-icon"
|
class="playlist-icon"
|
||||||
name="filter"
|
name=${ICON_SMART_PLAYLIST}
|
||||||
></wa-icon>`
|
></wa-icon>`
|
||||||
: nothing}
|
: nothing}
|
||||||
${isRenaming
|
${isRenaming
|
||||||
|
|||||||
@@ -72,6 +72,24 @@ const MIN_WIDTH = 200;
|
|||||||
const MAX_WIDTH = 500;
|
const MAX_WIDTH = 500;
|
||||||
const DEFAULT_WIDTH = 320;
|
const DEFAULT_WIDTH = 320;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The narrowest main panel the queue is allowed to leave behind before
|
||||||
|
* it stops being a column and becomes an overlay (plan 018, issue #24).
|
||||||
|
*
|
||||||
|
* There is no cliff to derive this from, and pretending otherwise would
|
||||||
|
* be the more dishonest answer: the track list rescales its columns
|
||||||
|
* continuously (213px down to 124px between main widths of 900 and 544,
|
||||||
|
* with no row overflow at any of them) and the album grid steps 3
|
||||||
|
* columns to 2 without breaking. So this is a judgement, anchored at
|
||||||
|
* both ends — it keeps the *default* 1100px window inline, because an
|
||||||
|
* inline queue is a desktop affordance people choose and demoting the
|
||||||
|
* common case to an overlay would be a regression in feel; and it puts
|
||||||
|
* every case measured as broken on the overlay side, which is 900x600
|
||||||
|
* (main = 379px, where all three of the Playlists header's actions are
|
||||||
|
* clipped) and every phone width (main = 69px at 390, 0px at 320).
|
||||||
|
*/
|
||||||
|
const MAIN_PANEL_FLOOR = 480;
|
||||||
|
|
||||||
@customElement('queue-panel')
|
@customElement('queue-panel')
|
||||||
export class QueuePanel
|
export class QueuePanel
|
||||||
extends LitElement
|
extends LitElement
|
||||||
@@ -85,6 +103,22 @@ export class QueuePanel
|
|||||||
@property({ type: Boolean, reflect: true })
|
@property({ type: Boolean, reflect: true })
|
||||||
open = false;
|
open = false;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether the panel is covering the content instead of sitting
|
||||||
|
* beside it. **Computed, never set by a caller** — it is reflected
|
||||||
|
* so the stylesheet and a spec can both read it.
|
||||||
|
*
|
||||||
|
* It is deliberately *not* a media query, which is the whole reason
|
||||||
|
* this is a property and not a `@media` block. The panel's width is
|
||||||
|
* user state: drag-resizable between MIN_WIDTH and MAX_WIDTH and
|
||||||
|
* persisted. A breakpoint at a fixed viewport width silently
|
||||||
|
* assumes the default 320, so it is wrong by up to 180px for a user
|
||||||
|
* who has widened the panel — in the direction that hurts, since a
|
||||||
|
* wider queue is exactly when the content can least afford it.
|
||||||
|
*/
|
||||||
|
@property({ type: Boolean, reflect: true })
|
||||||
|
overlay = false;
|
||||||
|
|
||||||
@state()
|
@state()
|
||||||
private isDragging = false;
|
private isDragging = false;
|
||||||
|
|
||||||
@@ -190,6 +224,19 @@ export class QueuePanel
|
|||||||
private panelWidth = DEFAULT_WIDTH;
|
private panelWidth = DEFAULT_WIDTH;
|
||||||
private scrollbarDragging = false;
|
private scrollbarDragging = false;
|
||||||
|
|
||||||
|
/** Watches `.content-area`, which is the viewport minus the sidebar. */
|
||||||
|
private spaceObserver?: ResizeObserver;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* What had focus when the overlay opened, so Escape and the scrim
|
||||||
|
* can give it back. Focus is only taken back if the panel had it —
|
||||||
|
* the same rule `MenuKeyboard` follows, for the same reason: the
|
||||||
|
* queue can also be closed by the button in the bottom bar, and
|
||||||
|
* yanking focus away from wherever the user actually is would be
|
||||||
|
* worse than leaving it.
|
||||||
|
*/
|
||||||
|
private overlayOpener: HTMLElement | null = null;
|
||||||
|
|
||||||
// _itemSize is an internal property applied via Object.assign in BaseLayout's
|
// _itemSize is an internal property applied via Object.assign in BaseLayout's
|
||||||
// config setter. Setting it to match the actual fixed .track-item height (49px)
|
// config setter. Setting it to match the actual fixed .track-item height (49px)
|
||||||
// prevents lit-virtualizer's scroll error correction from fighting the native
|
// prevents lit-virtualizer's scroll error correction from fighting the native
|
||||||
@@ -230,6 +277,26 @@ export class QueuePanel
|
|||||||
return this.queue.tracks.length;
|
return this.queue.tracks.length;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Repaint the rows when the selection changes.
|
||||||
|
*
|
||||||
|
* `<lit-virtualizer>` renders through the `virtualize` directive,
|
||||||
|
* which reacts to its *own* properties and not to the host having
|
||||||
|
* re-rendered, so host state like a selection reaches the rows only
|
||||||
|
* if it is pushed. `track-list` has always done this and both
|
||||||
|
* playlist views had to be taught it.
|
||||||
|
*
|
||||||
|
* **There is a second, accidental mechanism here and it must not be
|
||||||
|
* mistaken for this one**: `.keyFunction` below is a per-render
|
||||||
|
* arrow, so it is a changed property on every host update and
|
||||||
|
* repaints the rows by itself. Removing *either* alone changes
|
||||||
|
* nothing observable, which is why #43 could not be settled by
|
||||||
|
* reading the code. With both gone the highlight still arrives —
|
||||||
|
* on whatever unrelated render happens next, measured at 134ms,
|
||||||
|
* 3,866ms and 5,816ms against 5–17ms healthy, which a user cannot
|
||||||
|
* tell from broken. `queue-selection.spec.ts` asserts the
|
||||||
|
* *promptness* rather than the eventual state for that reason.
|
||||||
|
*/
|
||||||
onSelectionChanged(): void {
|
onSelectionChanged(): void {
|
||||||
this.virtualizer?.requestUpdate();
|
this.virtualizer?.requestUpdate();
|
||||||
}
|
}
|
||||||
@@ -265,6 +332,86 @@ export class QueuePanel
|
|||||||
border-left: 1px solid var(--yj-border-subtle, #333);
|
border-left: 1px solid var(--yj-border-subtle, #333);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* ---------------------------------------------------------
|
||||||
|
Overlay mode (plan 018, #24).
|
||||||
|
|
||||||
|
In flow the panel takes its width *from the main panel*,
|
||||||
|
which is the reported bug: at 900x600 that left 379px and
|
||||||
|
clipped every action in the Playlists header, and at 320px
|
||||||
|
it left 0px — the content was not degraded but gone.
|
||||||
|
|
||||||
|
Here the host spans the whole content area instead and
|
||||||
|
stops being a layout participant, so the main panel keeps
|
||||||
|
its full width and the queue sits over it. The host itself
|
||||||
|
is transparent and click-through; the scrim and the panel
|
||||||
|
are what take pointer events. The containment drops paint,
|
||||||
|
which would otherwise clip the panel's own shadow.
|
||||||
|
--------------------------------------------------------- */
|
||||||
|
:host([overlay]) {
|
||||||
|
position: absolute;
|
||||||
|
inset: 0;
|
||||||
|
width: auto;
|
||||||
|
background-color: transparent;
|
||||||
|
overflow: visible;
|
||||||
|
pointer-events: none;
|
||||||
|
contain: layout style;
|
||||||
|
z-index: 20;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Closed, an overlay is not there at all. In flow the panel is
|
||||||
|
width: 0, which is its own way of saying this; absolutely
|
||||||
|
positioned there is no width to collapse. */
|
||||||
|
:host([overlay]:not([open])) {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
:host([overlay][open]) {
|
||||||
|
border-left: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
:host([overlay]) .panel-content {
|
||||||
|
position: absolute;
|
||||||
|
top: 0;
|
||||||
|
right: 0;
|
||||||
|
bottom: 0;
|
||||||
|
width: var(--queue-width, ${unsafeCSS(DEFAULT_WIDTH)}px);
|
||||||
|
max-width: 100%;
|
||||||
|
box-sizing: border-box;
|
||||||
|
background-color: var(--yj-bg-surface, #212529);
|
||||||
|
border-left: 1px solid var(--yj-border-subtle, #333);
|
||||||
|
box-shadow: -8px 0 24px rgb(0 0 0 / 45%);
|
||||||
|
pointer-events: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Dragging the edge of something that is already covering the
|
||||||
|
content answers a question nobody asked, and it is a
|
||||||
|
mouse-only affordance either way. */
|
||||||
|
:host([overlay]) .resize-handle {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.scrim {
|
||||||
|
position: absolute;
|
||||||
|
inset: 0;
|
||||||
|
background-color: rgb(0 0 0 / 45%);
|
||||||
|
pointer-events: auto;
|
||||||
|
border: none;
|
||||||
|
padding: 0;
|
||||||
|
margin: 0;
|
||||||
|
cursor: pointer;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* The phone gets the whole width: below 600 there is no
|
||||||
|
"beside" left to be, and this is the shape #55 turns into a
|
||||||
|
real screen. A media query inside a shadow root is answered
|
||||||
|
by the viewport, so the component states this itself rather
|
||||||
|
than the shell reaching in. */
|
||||||
|
@media (max-width: 599px) {
|
||||||
|
:host([overlay]) .panel-content {
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
.resize-handle {
|
.resize-handle {
|
||||||
position: absolute;
|
position: absolute;
|
||||||
top: 0;
|
top: 0;
|
||||||
@@ -656,6 +803,20 @@ export class QueuePanel
|
|||||||
'--queue-width',
|
'--queue-width',
|
||||||
`${this.panelWidth}px`,
|
`${this.panelWidth}px`,
|
||||||
);
|
);
|
||||||
|
|
||||||
|
// The mode is a measurement, so it is observed rather than
|
||||||
|
// computed once: the parent is `.content-area`, whose width is
|
||||||
|
// the viewport minus the sidebar — including the sidebar's own
|
||||||
|
// collapse at 900px, which is what makes 900 the *worst*
|
||||||
|
// desktop width rather than the minimum.
|
||||||
|
this.updateOverlayMode();
|
||||||
|
|
||||||
|
if (this.parentElement) {
|
||||||
|
this.spaceObserver = new ResizeObserver(() =>
|
||||||
|
this.updateOverlayMode(),
|
||||||
|
);
|
||||||
|
this.spaceObserver.observe(this.parentElement);
|
||||||
|
}
|
||||||
document.addEventListener(
|
document.addEventListener(
|
||||||
'mousemove',
|
'mousemove',
|
||||||
this.handleMouseMove,
|
this.handleMouseMove,
|
||||||
@@ -690,6 +851,9 @@ export class QueuePanel
|
|||||||
super.disconnectedCallback();
|
super.disconnectedCallback();
|
||||||
this.creditsUnsub?.();
|
this.creditsUnsub?.();
|
||||||
this.creditsUnsub = undefined;
|
this.creditsUnsub = undefined;
|
||||||
|
this.spaceObserver?.disconnect();
|
||||||
|
this.spaceObserver = undefined;
|
||||||
|
document.removeEventListener('keydown', this.onOverlayKeydown);
|
||||||
document.removeEventListener(
|
document.removeEventListener(
|
||||||
'mousemove',
|
'mousemove',
|
||||||
this.handleMouseMove,
|
this.handleMouseMove,
|
||||||
@@ -736,7 +900,79 @@ export class QueuePanel
|
|||||||
this.delegationAttached = false;
|
this.delegationAttached = false;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Decide whether the queue can afford to be a column.
|
||||||
|
*
|
||||||
|
* The parent is `.content-area`, so its width is the viewport minus
|
||||||
|
* the sidebar and the sum already accounts for the sidebar's own
|
||||||
|
* collapse. It is stable across the panel's own open/closed state
|
||||||
|
* in both modes — in flow the panel is a child of that box, and as
|
||||||
|
* an overlay it is out of flow — so this cannot oscillate.
|
||||||
|
*/
|
||||||
|
private updateOverlayMode = () => {
|
||||||
|
const available = this.parentElement?.clientWidth ?? 0;
|
||||||
|
|
||||||
|
// Before layout there is nothing to measure, and answering 0 by
|
||||||
|
// flipping to overlay would show the scrim for a frame.
|
||||||
|
if (available === 0) return;
|
||||||
|
|
||||||
|
this.overlay = available - this.panelWidth < MAIN_PANEL_FLOOR;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Escape closes a scrimmed overlay, which is the one keyboard rule
|
||||||
|
* every dialog in this app already follows.
|
||||||
|
*
|
||||||
|
* It is a document listener rather than a panel-scoped binding
|
||||||
|
* (`services/shortcut-scope.ts`) because it is not a *shortcut*: it
|
||||||
|
* is the dismissal of something covering the page, and it has to
|
||||||
|
* work while focus is still behind the scrim. It is attached only
|
||||||
|
* while the overlay is actually up and removed on close, so it is
|
||||||
|
* scoped to a state rather than being a permanent global. Nothing
|
||||||
|
* else binds Escape — the shortcut service only uses it to blur a
|
||||||
|
* text input.
|
||||||
|
*/
|
||||||
|
private onOverlayKeydown = (e: KeyboardEvent) => {
|
||||||
|
if (e.key !== 'Escape' || !this.open || !this.overlay) return;
|
||||||
|
|
||||||
|
e.stopPropagation();
|
||||||
|
this.closeFromOverlay();
|
||||||
|
};
|
||||||
|
|
||||||
|
private closeFromOverlay = () => {
|
||||||
|
const hadFocus = this.contains(
|
||||||
|
document.activeElement as Node | null,
|
||||||
|
);
|
||||||
|
|
||||||
|
this.open = false;
|
||||||
|
|
||||||
|
if (hadFocus) {
|
||||||
|
const back =
|
||||||
|
this.overlayOpener ??
|
||||||
|
document.getElementById('queue-button');
|
||||||
|
|
||||||
|
back?.focus();
|
||||||
|
}
|
||||||
|
|
||||||
|
this.overlayOpener = null;
|
||||||
|
};
|
||||||
|
|
||||||
override updated() {
|
override updated() {
|
||||||
|
// The overlay owns Escape only while it is up.
|
||||||
|
if (this.open && this.overlay) {
|
||||||
|
document.addEventListener('keydown', this.onOverlayKeydown);
|
||||||
|
|
||||||
|
this.overlayOpener ??=
|
||||||
|
document.activeElement instanceof HTMLElement &&
|
||||||
|
document.activeElement !== document.body
|
||||||
|
? document.activeElement
|
||||||
|
: null;
|
||||||
|
} else {
|
||||||
|
document.removeEventListener('keydown', this.onOverlayKeydown);
|
||||||
|
|
||||||
|
if (!this.open) this.overlayOpener = null;
|
||||||
|
}
|
||||||
|
|
||||||
// Closed, the panel is `width: 0` — which hides it from the eye
|
// Closed, the panel is `width: 0` — which hides it from the eye
|
||||||
// and from nobody else: its Clear and Add buttons still took tab
|
// and from nobody else: its Clear and Add buttons still took tab
|
||||||
// stops at x=1440 and were still read out (H-5). `inert` is the
|
// stops at x=1440 and were still read out (H-5). `inert` is the
|
||||||
@@ -1631,6 +1867,11 @@ export class QueuePanel
|
|||||||
'--queue-width',
|
'--queue-width',
|
||||||
`${clampedWidth}px`,
|
`${clampedWidth}px`,
|
||||||
);
|
);
|
||||||
|
|
||||||
|
// Widening the panel is one of the two ways the content can run
|
||||||
|
// out of room, and it is the way a viewport-width media query
|
||||||
|
// cannot see at all.
|
||||||
|
this.updateOverlayMode();
|
||||||
};
|
};
|
||||||
|
|
||||||
private handleMouseUp = () => {
|
private handleMouseUp = () => {
|
||||||
@@ -1714,6 +1955,15 @@ export class QueuePanel
|
|||||||
const tracks = this.queue.tracks;
|
const tracks = this.queue.tracks;
|
||||||
|
|
||||||
return html`
|
return html`
|
||||||
|
${this.overlay
|
||||||
|
? html`<div
|
||||||
|
class="scrim"
|
||||||
|
part="scrim"
|
||||||
|
data-testid="queue-scrim"
|
||||||
|
aria-hidden="true"
|
||||||
|
@click=${this.closeFromOverlay}
|
||||||
|
></div>`
|
||||||
|
: nothing}
|
||||||
<div class="panel-content">
|
<div class="panel-content">
|
||||||
<div
|
<div
|
||||||
class="resize-handle ${this.isDragging
|
class="resize-handle ${this.isDragging
|
||||||
@@ -1763,6 +2013,16 @@ export class QueuePanel
|
|||||||
name=${ICON_PLAYLIST}
|
name=${ICON_PLAYLIST}
|
||||||
></wa-icon>
|
></wa-icon>
|
||||||
</button>
|
</button>
|
||||||
|
${this.overlay
|
||||||
|
? html`<button
|
||||||
|
class="header-action-button"
|
||||||
|
data-testid="queue-close"
|
||||||
|
aria-label="Close queue"
|
||||||
|
@click=${this.closeFromOverlay}
|
||||||
|
>
|
||||||
|
<wa-icon name="xmark"></wa-icon>
|
||||||
|
</button>`
|
||||||
|
: nothing}
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|||||||
@@ -4,18 +4,10 @@ import '@awesome.me/webawesome/dist/components/icon/icon.js';
|
|||||||
import { designTokens } from '../../styles/tokens.css';
|
import { designTokens } from '../../styles/tokens.css';
|
||||||
|
|
||||||
import type { DragActiveDetail } from '@utils/drag-controller';
|
import type { DragActiveDetail } from '@utils/drag-controller';
|
||||||
import {
|
import { ActiveViewController } from '@store/controllers/active-view-controller';
|
||||||
ICON_PLAYLIST,
|
import { ViewVisibilityController } from '@store/controllers/view-visibility-controller';
|
||||||
ICON_REQUESTED,
|
import { VIEW_META } from '../../services/view-meta';
|
||||||
} from '@utils/icon-language';
|
import type { View } from '../../services/view-meta';
|
||||||
|
|
||||||
type View = 'home' | 'playlists' | 'artists' | 'genres' | 'albums' | 'tracks' | 'explore' | 'downloads' | 'autotag' | 'jobs' | 'settings';
|
|
||||||
|
|
||||||
interface NavItem {
|
|
||||||
id: View;
|
|
||||||
label: string;
|
|
||||||
icon: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
const MIN_WIDTH = 56;
|
const MIN_WIDTH = 56;
|
||||||
const MAX_WIDTH = 400;
|
const MAX_WIDTH = 400;
|
||||||
@@ -158,11 +150,20 @@ export class AppSidebar extends LitElement {
|
|||||||
/** Delay in ms before a drag-hover triggers navigation. */
|
/** Delay in ms before a drag-hover triggers navigation. */
|
||||||
private static readonly HOVER_NAV_DELAY = 600;
|
private static readonly HOVER_NAV_DELAY = 600;
|
||||||
|
|
||||||
/** Home, because that is where `index.ts` now navigates on startup
|
/**
|
||||||
* (H-8). The sidebar does not hear a `navigate` it did not send,
|
* Which item is lit, read from the shell rather than tracked here.
|
||||||
* so this default is what keeps `aria-current` honest on arrival. */
|
*
|
||||||
@state()
|
* This used to be a `@state()` field defaulting to `home` -- the
|
||||||
private activeView: View = 'home';
|
* landing view -- because "the sidebar does not hear a `navigate`
|
||||||
|
* it did not send". That default was the only honest moment it
|
||||||
|
* ever had: a back-navigation dispatches no `navigate`, so the
|
||||||
|
* highlight stayed on the view the user had just left (#72), and
|
||||||
|
* the copy of this component that `bottom-nav` mounts inside its
|
||||||
|
* drawer opened on `home` from whatever page you were standing on.
|
||||||
|
* The shell publishes the active view now, so there is nothing to
|
||||||
|
* default and nothing to keep in step.
|
||||||
|
*/
|
||||||
|
private activeCtrl = new ActiveViewController(this);
|
||||||
|
|
||||||
@state()
|
@state()
|
||||||
private isDragging = false;
|
private isDragging = false;
|
||||||
@@ -199,19 +200,15 @@ export class AppSidebar extends LitElement {
|
|||||||
typeof setTimeout
|
typeof setTimeout
|
||||||
> | null = null;
|
> | null = null;
|
||||||
|
|
||||||
private navItems: NavItem[] = [
|
/**
|
||||||
{ id: 'home', label: 'Home', icon: 'house' },
|
* Which destinations the user has kept (#25). The list below is
|
||||||
{ id: 'playlists', label: 'Playlists', icon: ICON_PLAYLIST },
|
* still the whole set and its order -- this only filters it, and
|
||||||
{ id: 'artists', label: 'Artists', icon: 'user-group' },
|
* only for drawing: a hidden view is still reachable by `navigate`,
|
||||||
{ id: 'genres', label: 'Genres', icon: 'masks-theater' },
|
* which is what detail views and the launch page depend on.
|
||||||
{ id: 'albums', label: 'Albums', icon: 'compact-disc' },
|
*/
|
||||||
{ id: 'tracks', label: 'Tracks', icon: 'music' },
|
private visibilityCtrl = new ViewVisibilityController(this);
|
||||||
{ id: 'explore', label: 'Explore', icon: 'globe' },
|
|
||||||
{ id: 'downloads', label: 'Downloads', icon: ICON_REQUESTED },
|
private navItems = VIEW_META;
|
||||||
{ id: 'autotag', label: 'Autotag', icon: 'tag' },
|
|
||||||
{ id: 'jobs', label: 'Jobs', icon: 'list-check' },
|
|
||||||
{ id: 'settings', label: 'Settings', icon: 'gear' },
|
|
||||||
];
|
|
||||||
|
|
||||||
override connectedCallback() {
|
override connectedCallback() {
|
||||||
super.connectedCallback();
|
super.connectedCallback();
|
||||||
@@ -236,10 +233,6 @@ export class AppSidebar extends LitElement {
|
|||||||
'yj-drag-active',
|
'yj-drag-active',
|
||||||
this.onDragActive as EventListener,
|
this.onDragActive as EventListener,
|
||||||
);
|
);
|
||||||
document.addEventListener(
|
|
||||||
'navigate',
|
|
||||||
this.onGlobalNavigate as EventListener,
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
override disconnectedCallback() {
|
override disconnectedCallback() {
|
||||||
@@ -261,10 +254,6 @@ export class AppSidebar extends LitElement {
|
|||||||
'yj-drag-active',
|
'yj-drag-active',
|
||||||
this.onDragActive as EventListener,
|
this.onDragActive as EventListener,
|
||||||
);
|
);
|
||||||
document.removeEventListener(
|
|
||||||
'navigate',
|
|
||||||
this.onGlobalNavigate as EventListener,
|
|
||||||
);
|
|
||||||
this.clearDragHoverTimer();
|
this.clearDragHoverTimer();
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -280,9 +269,12 @@ export class AppSidebar extends LitElement {
|
|||||||
></div>
|
></div>
|
||||||
<nav aria-label="Main">
|
<nav aria-label="Main">
|
||||||
<ul>
|
<ul>
|
||||||
${this.navItems.map((item) => {
|
${this.navItems
|
||||||
|
.filter((item) => this.visibilityCtrl.visible(item.id))
|
||||||
|
.map((item) => {
|
||||||
|
const active = this.activeCtrl.isActive(item.id);
|
||||||
const classes = [
|
const classes = [
|
||||||
this.activeView === item.id
|
active
|
||||||
? 'active'
|
? 'active'
|
||||||
: '',
|
: '',
|
||||||
this.dragHoverView === item.id
|
this.dragHoverView === item.id
|
||||||
@@ -298,7 +290,7 @@ export class AppSidebar extends LitElement {
|
|||||||
type="button"
|
type="button"
|
||||||
class=${classes}
|
class=${classes}
|
||||||
data-testid="nav-${item.id}"
|
data-testid="nav-${item.id}"
|
||||||
aria-current=${this.activeView === item.id
|
aria-current=${active
|
||||||
? 'page'
|
? 'page'
|
||||||
: 'false'}
|
: 'false'}
|
||||||
@click=${() =>
|
@click=${() =>
|
||||||
@@ -381,19 +373,6 @@ export class AppSidebar extends LitElement {
|
|||||||
private static readonly DROP_VIEWS: Set<View> =
|
private static readonly DROP_VIEWS: Set<View> =
|
||||||
new Set(['playlists']);
|
new Set(['playlists']);
|
||||||
|
|
||||||
/** Keeps the highlighted nav item in sync with navigation that
|
|
||||||
* originates outside the sidebar itself (e.g. the launch-page
|
|
||||||
* dispatch in index.ts). */
|
|
||||||
private onGlobalNavigate = (
|
|
||||||
e: CustomEvent<{ view?: string }>,
|
|
||||||
) => {
|
|
||||||
const view = e.detail.view;
|
|
||||||
|
|
||||||
if (view && this.navItems.some((item) => item.id === view)) {
|
|
||||||
this.activeView = view as View;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
private onDragActive = (
|
private onDragActive = (
|
||||||
e: CustomEvent<DragActiveDetail>,
|
e: CustomEvent<DragActiveDetail>,
|
||||||
) => {
|
) => {
|
||||||
@@ -459,7 +438,11 @@ export class AppSidebar extends LitElement {
|
|||||||
}
|
}
|
||||||
|
|
||||||
private navigate(view: View) {
|
private navigate(view: View) {
|
||||||
this.activeView = view;
|
// No optimistic highlight: the shell answers, and it answers
|
||||||
|
// synchronously in `handleNavigate` before it awaits anything.
|
||||||
|
// Setting it here as well is the second opinion this fix
|
||||||
|
// removes -- it is what let a click's highlight survive a
|
||||||
|
// navigation the shell then handled differently.
|
||||||
this.dispatchEvent(new CustomEvent('navigate', {
|
this.dispatchEvent(new CustomEvent('navigate', {
|
||||||
detail: { view },
|
detail: { view },
|
||||||
bubbles: true,
|
bubbles: true,
|
||||||
|
|||||||
@@ -64,6 +64,7 @@ import { list } from '@utils/binding';
|
|||||||
import {
|
import {
|
||||||
ICON_PLAYLIST,
|
ICON_PLAYLIST,
|
||||||
ICON_QUEUE,
|
ICON_QUEUE,
|
||||||
|
ICON_SMART_PLAYLIST,
|
||||||
} from '@utils/icon-language';
|
} from '@utils/icon-language';
|
||||||
|
|
||||||
|
|
||||||
@@ -1214,7 +1215,7 @@ export class SmartPlaylistDetails
|
|||||||
<wa-icon name="arrow-left"></wa-icon>
|
<wa-icon name="arrow-left"></wa-icon>
|
||||||
</button>
|
</button>
|
||||||
<div class="playlist-avatar">
|
<div class="playlist-avatar">
|
||||||
<wa-icon name="filter"></wa-icon>
|
<wa-icon name=${ICON_SMART_PLAYLIST}></wa-icon>
|
||||||
</div>
|
</div>
|
||||||
<div class="playlist-info">
|
<div class="playlist-info">
|
||||||
<h1
|
<h1
|
||||||
|
|||||||
@@ -11,6 +11,7 @@ import {
|
|||||||
import { SelectionController } from '@utils/selection-controller';
|
import { SelectionController } from '@utils/selection-controller';
|
||||||
import type { SelectionHost } from '@utils/selection-controller';
|
import type { SelectionHost } from '@utils/selection-controller';
|
||||||
import { ViewLifecycleMixin } from '@utils/view-lifecycle';
|
import { ViewLifecycleMixin } from '@utils/view-lifecycle';
|
||||||
|
import { PHONE_QUERY } from '@utils/breakpoints';
|
||||||
import {
|
import {
|
||||||
ContextMenuController,
|
ContextMenuController,
|
||||||
contextMenuStyles,
|
contextMenuStyles,
|
||||||
@@ -105,9 +106,6 @@ const ROW_CHROME_WIDTH =
|
|||||||
const ROW_HEIGHT = 33;
|
const ROW_HEIGHT = 33;
|
||||||
const PHONE_ROW_HEIGHT = 52;
|
const PHONE_ROW_HEIGHT = 52;
|
||||||
|
|
||||||
/** The shell's phone breakpoint, as `index.css` and every component
|
|
||||||
* stylesheet spells it. */
|
|
||||||
const PHONE_QUERY = '(max-width: 599px)';
|
|
||||||
|
|
||||||
// Inline SVG paths for favorite icons — eliminates wa-icon shadow DOM
|
// Inline SVG paths for favorite icons — eliminates wa-icon shadow DOM
|
||||||
// overhead (30-50 shadow roots during scroll). Font Awesome 6 paths.
|
// overhead (30-50 shadow roots during scroll). Font Awesome 6 paths.
|
||||||
|
|||||||
@@ -19,6 +19,7 @@ regular/heart
|
|||||||
regular/star
|
regular/star
|
||||||
solid/arrow-down-wide-short
|
solid/arrow-down-wide-short
|
||||||
solid/arrow-left
|
solid/arrow-left
|
||||||
|
solid/arrow-right
|
||||||
solid/arrow-rotate-right
|
solid/arrow-rotate-right
|
||||||
solid/arrows-rotate
|
solid/arrows-rotate
|
||||||
solid/arrow-up-short-wide
|
solid/arrow-up-short-wide
|
||||||
@@ -41,6 +42,7 @@ solid/compact-disc
|
|||||||
solid/copy
|
solid/copy
|
||||||
solid/database
|
solid/database
|
||||||
solid/download
|
solid/download
|
||||||
|
solid/ellipsis
|
||||||
solid/file-import
|
solid/file-import
|
||||||
solid/filter
|
solid/filter
|
||||||
solid/floppy-disk
|
solid/floppy-disk
|
||||||
|
|||||||
@@ -400,6 +400,20 @@ async function dispatch(action: string): Promise<void> {
|
|||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The keyboard half of #6. It dispatches the same events the
|
||||||
|
// header's buttons and the detail views' own back buttons do,
|
||||||
|
// rather than calling `history.back()` here: the shell owns the
|
||||||
|
// guard that stops a press at the root leaving the app, and a
|
||||||
|
// second caller reaching for `history` directly is how the old
|
||||||
|
// `navStack` came to disagree with the platform.
|
||||||
|
case 'nav.back':
|
||||||
|
document.dispatchEvent(new CustomEvent('navigate-back'));
|
||||||
|
break;
|
||||||
|
|
||||||
|
case 'nav.forward':
|
||||||
|
document.dispatchEvent(new CustomEvent('navigate-forward'));
|
||||||
|
break;
|
||||||
|
|
||||||
case 'nav.queue': {
|
case 'nav.queue': {
|
||||||
const queuePanel = document.getElementById(
|
const queuePanel = document.getElementById(
|
||||||
'queue-panel',
|
'queue-panel',
|
||||||
|
|||||||
@@ -103,6 +103,18 @@ export const SHORTCUT_META: Record<string, ShortcutMeta> = {
|
|||||||
scope: 'global',
|
scope: 'global',
|
||||||
defaultKey: 'Q',
|
defaultKey: 'Q',
|
||||||
},
|
},
|
||||||
|
'nav.back': {
|
||||||
|
label: 'Back',
|
||||||
|
category: 'Navigation',
|
||||||
|
scope: 'global',
|
||||||
|
defaultKey: 'Alt+Left',
|
||||||
|
},
|
||||||
|
'nav.forward': {
|
||||||
|
label: 'Forward',
|
||||||
|
category: 'Navigation',
|
||||||
|
scope: 'global',
|
||||||
|
defaultKey: 'Alt+Right',
|
||||||
|
},
|
||||||
'app.shortcuts': {
|
'app.shortcuts': {
|
||||||
label: 'Keyboard Shortcuts',
|
label: 'Keyboard Shortcuts',
|
||||||
category: 'App',
|
category: 'App',
|
||||||
|
|||||||
@@ -0,0 +1,199 @@
|
|||||||
|
/**
|
||||||
|
* What the top bar drops when it runs out of room (#143).
|
||||||
|
*
|
||||||
|
* The bar holds five children — the wordmark, back/forward, the library
|
||||||
|
* filter, the search box and the job indicator — and at the bottom of
|
||||||
|
* the Compact band they do not all fit. Measured on `main` at 600×600:
|
||||||
|
* the bar is 611px inside a 600px viewport sitting still, and **862px
|
||||||
|
* while a scan with a long title is running**, because `job-indicator`
|
||||||
|
* is `hidden` when idle and up to 235px wide when it is not. `body` is
|
||||||
|
* `overflow-x: auto`, so what a user sees is a horizontal scrollbar on
|
||||||
|
* a shell that #24 promised would not need one.
|
||||||
|
*
|
||||||
|
* **The fit is measured, never breakpointed**, which is `page-header`'s
|
||||||
|
* rule (#69) and applies here for a reason specific to this bar: three
|
||||||
|
* of its five children are as wide as their *content*. The library
|
||||||
|
* filter is a `<select>` sized by the longest library name, the job
|
||||||
|
* indicator by the running job's title, and the search box by its
|
||||||
|
* view-scoped placeholder — so any width you pick is right for exactly
|
||||||
|
* one library, one job and one view. The same sweep that produced the
|
||||||
|
* numbers above found the bar overflowing at every width from 600 to
|
||||||
|
* 899 *and* at 900, where `nav-history` reappears; a breakpoint fixing
|
||||||
|
* "600 to 610" would have fixed the case that happened to be idle.
|
||||||
|
*
|
||||||
|
* **What yields is chosen by #24's own sentence** — *no action is ever
|
||||||
|
* unreachable at any supported size* — which rules out the two cheapest
|
||||||
|
* candidates the issue lists. Hiding the library filter takes away an
|
||||||
|
* action: `library-filter` is the **only** control in the app that sets
|
||||||
|
* the selected library (nothing else calls `setSelectedLibrary`), so
|
||||||
|
* hiding it is trading this promise for the same promise. Collapsing
|
||||||
|
* the search box to an icon is what #57 wants on a phone, but #57 is
|
||||||
|
* blocked behind #62 and building its modal here would be building it
|
||||||
|
* without the thing that blocks it.
|
||||||
|
*
|
||||||
|
* So the two things that yield are the two that are **not** actions and
|
||||||
|
* whose content survives elsewhere:
|
||||||
|
*
|
||||||
|
* 1. **The wordmark**, which is a brand — the window's own title bar
|
||||||
|
* says the same thing, and #48 wants it down to "YJ" at every width
|
||||||
|
* anyway. It yields its *width*, not its existence: the rule in
|
||||||
|
* `index.css` is visually-hidden rather than `display: none`, so the
|
||||||
|
* document keeps its top-level heading.
|
||||||
|
* 2. **The job indicator's label**, leaving the ring. This is not a new
|
||||||
|
* judgement — the component already drops it below 600px for exactly
|
||||||
|
* this reason, and its `sr-only` live region is what announces the
|
||||||
|
* state either way, so nothing is lost to anyone. What a measurement
|
||||||
|
* adds is the band between 600 and 900, where whether the label fits
|
||||||
|
* depends on what else is in the bar rather than on the width alone.
|
||||||
|
*
|
||||||
|
* Measured against the running app with a long-titled scan staged, that
|
||||||
|
* order fits at every width from 320 to 1440 — and collapses nothing at
|
||||||
|
* 320, 390, 599, 899 and 1100, which is the other half of the claim.
|
||||||
|
*
|
||||||
|
* Three things about the mechanism are load-bearing.
|
||||||
|
*
|
||||||
|
* **Every pass starts from all-visible**, so the collapsed set is a
|
||||||
|
* pure function of the current width rather than of how the window got
|
||||||
|
* there. `page-header` states the same rule and the same reasons: a
|
||||||
|
* pass that only ever added would never give the wordmark back, and one
|
||||||
|
* that adjusted by a step would need a hysteresis band to stop it
|
||||||
|
* oscillating on the pixel where it exactly fits.
|
||||||
|
*
|
||||||
|
* **"Fits" is the children against the content box, not `scrollWidth`
|
||||||
|
* against `clientWidth`** — and that distinction is not pedantry, it
|
||||||
|
* is a measured false pass. `scrollWidth` counts a box's *left*
|
||||||
|
* padding and not its right, so with this bar's 2em gutters it
|
||||||
|
* under-reports by 32px: at 700px with a scan running it read
|
||||||
|
* `700/700`, a perfect fit, while `job-indicator` ended 32px past
|
||||||
|
* where the content may go and sat in the gutter. Same family as #69's
|
||||||
|
* title trap, one property over — the measurement that is easiest to
|
||||||
|
* reach for is the one that cannot see the failure. So the predicate
|
||||||
|
* here is the same one `top-bar-fit.spec.ts` asserts: no in-flow child
|
||||||
|
* outside the content box.
|
||||||
|
*
|
||||||
|
* That is only truthful in turn because **nothing here absorbs pressure
|
||||||
|
* by truncating**. The collapsible children are `flex-shrink: 0` in
|
||||||
|
* `index.css`, so a deficit shows up as a child out of bounds instead
|
||||||
|
* of quietly eating the indicator's label, which is `text-overflow:
|
||||||
|
* ellipsis` and would have. The search box is the one child that may
|
||||||
|
* shrink, between its 320px basis and the 200px floor its own
|
||||||
|
* stylesheet sets, and a narrower input hides nothing it was showing.
|
||||||
|
*
|
||||||
|
* **The bar does not resize when a job starts**, which is the case the
|
||||||
|
* whole thing is for. A ResizeObserver on the header alone never fires:
|
||||||
|
* the indicator goes 0 → 235 inside a bar whose width has not changed.
|
||||||
|
* Every element child is observed too.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/** One thing the bar can give up, cheapest first. */
|
||||||
|
interface FitStep {
|
||||||
|
/** For tests and for reading the DOM back. */
|
||||||
|
readonly id: string;
|
||||||
|
/** Applied to the bar; `on` collapses. */
|
||||||
|
readonly collapse: (bar: HTMLElement, on: boolean) => void;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The order things are given up in. Lowest priority first — see the
|
||||||
|
* argument above for why these two and not the library filter.
|
||||||
|
*/
|
||||||
|
export const FIT_STEPS: readonly FitStep[] = [
|
||||||
|
{
|
||||||
|
id: 'wordmark',
|
||||||
|
collapse: (bar, on) =>
|
||||||
|
bar.querySelector('hgroup')?.classList.toggle('yj-collapsed', on),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: 'job-label',
|
||||||
|
collapse: (bar, on) =>
|
||||||
|
bar.querySelector('job-indicator')?.toggleAttribute('compact', on),
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Decide what the bar shows at its current width.
|
||||||
|
*
|
||||||
|
* Exported for the component tier, which can hand it a bar of known
|
||||||
|
* widths; the app installs the observer below and never calls this.
|
||||||
|
*
|
||||||
|
* @returns the ids collapsed, in the order they were given up.
|
||||||
|
*/
|
||||||
|
export function measureTopBarFit(bar: HTMLElement): string[] {
|
||||||
|
const fits = () => {
|
||||||
|
const style = getComputedStyle(bar);
|
||||||
|
const box = bar.getBoundingClientRect();
|
||||||
|
const left = box.left + parseFloat(style.paddingLeft);
|
||||||
|
const right = box.right - parseFloat(style.paddingRight);
|
||||||
|
|
||||||
|
for (const child of bar.children) {
|
||||||
|
const cs = getComputedStyle(child);
|
||||||
|
|
||||||
|
// Out of flow is out of the question: a collapsed wordmark
|
||||||
|
// is absolutely positioned and 1px wide precisely so that
|
||||||
|
// it costs the row nothing.
|
||||||
|
if (cs.display === 'none' || cs.position === 'absolute') continue;
|
||||||
|
|
||||||
|
const r = child.getBoundingClientRect();
|
||||||
|
|
||||||
|
// Sub-pixel slack: a flex row's widths are fractional and a
|
||||||
|
// rounding difference is not an overflow anyone can see.
|
||||||
|
if (r.width > 0 && (r.right > right + 0.5 || r.left < left - 0.5)) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
};
|
||||||
|
|
||||||
|
for (const step of FIT_STEPS) step.collapse(bar, false);
|
||||||
|
|
||||||
|
const collapsed: string[] = [];
|
||||||
|
|
||||||
|
if (!fits()) {
|
||||||
|
for (const step of FIT_STEPS) {
|
||||||
|
step.collapse(bar, true);
|
||||||
|
collapsed.push(step.id);
|
||||||
|
|
||||||
|
if (fits()) break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return collapsed;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Watch the bar and its children, and keep it fitting.
|
||||||
|
*
|
||||||
|
* Returns the uninstaller, which the tests use; the app installs once
|
||||||
|
* for the life of the session.
|
||||||
|
*/
|
||||||
|
export function installTopBarFit(bar: HTMLElement): () => void {
|
||||||
|
let measuring = false;
|
||||||
|
|
||||||
|
const measure = () => {
|
||||||
|
// A pass resizes the children it collapses, which the observer
|
||||||
|
// would report back to us. It settles either way — the pass is
|
||||||
|
// idempotent at a given width — but re-entering it is work for
|
||||||
|
// no news, and it is what "ResizeObserver loop completed with
|
||||||
|
// undelivered notifications" is.
|
||||||
|
if (measuring) return;
|
||||||
|
|
||||||
|
measuring = true;
|
||||||
|
|
||||||
|
try {
|
||||||
|
measureTopBarFit(bar);
|
||||||
|
} finally {
|
||||||
|
measuring = false;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
const observer = new ResizeObserver(measure);
|
||||||
|
|
||||||
|
observer.observe(bar);
|
||||||
|
|
||||||
|
for (const child of bar.children) observer.observe(child);
|
||||||
|
|
||||||
|
measure();
|
||||||
|
|
||||||
|
return () => observer.disconnect();
|
||||||
|
}
|
||||||
@@ -0,0 +1,64 @@
|
|||||||
|
import {
|
||||||
|
ICON_PLAYLIST,
|
||||||
|
ICON_AUTOTAG,
|
||||||
|
ICON_REQUESTED,
|
||||||
|
} from '@utils/icon-language';
|
||||||
|
|
||||||
|
/** A primary destination. Mirrors `backend/config.View`. */
|
||||||
|
export type View =
|
||||||
|
| 'home'
|
||||||
|
| 'playlists'
|
||||||
|
| 'artists'
|
||||||
|
| 'genres'
|
||||||
|
| 'albums'
|
||||||
|
| 'tracks'
|
||||||
|
| 'explore'
|
||||||
|
| 'downloads'
|
||||||
|
| 'autotag'
|
||||||
|
| 'settings';
|
||||||
|
|
||||||
|
export interface ViewMeta {
|
||||||
|
id: View;
|
||||||
|
label: string;
|
||||||
|
icon: string;
|
||||||
|
/**
|
||||||
|
* Views that are never offered as a toggle. Settings alone, because
|
||||||
|
* a user who hides it cannot get back to unhide it.
|
||||||
|
*
|
||||||
|
* This is the *affordance*; the rule is `backend/config.ViewSpec`'s
|
||||||
|
* `Hideable`, which refuses at the setter and drops the key on load.
|
||||||
|
* `config.toml` is hand-editable, so the checkbox being absent is
|
||||||
|
* not what makes this safe — it is only what stops the question
|
||||||
|
* being asked.
|
||||||
|
*/
|
||||||
|
alwaysShown?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The app's primary destinations, in the order the navigation draws
|
||||||
|
* them and Settings lists them.
|
||||||
|
*
|
||||||
|
* It is here rather than inside `app-sidebar` because #25 gave it a
|
||||||
|
* second reader: Settings renders a toggle per view and needs the same
|
||||||
|
* labels in the same order. Same shape as `services/shortcut-meta.ts`,
|
||||||
|
* which moved out of `config-page` for the same reason -- a private
|
||||||
|
* static that two surfaces need is a private static that is about to be
|
||||||
|
* copied.
|
||||||
|
*
|
||||||
|
* The labels and icons deliberately do not exist in Go. Which views
|
||||||
|
* exist and what an unconfigured install shows is `backend/config.Views`
|
||||||
|
* and is asked for over the binding; how they are *drawn* is the
|
||||||
|
* frontend's, and lives beside the rest of the icon vocabulary.
|
||||||
|
*/
|
||||||
|
export const VIEW_META: ViewMeta[] = [
|
||||||
|
{ id: 'home', label: 'Home', icon: 'house' },
|
||||||
|
{ id: 'playlists', label: 'Playlists', icon: ICON_PLAYLIST },
|
||||||
|
{ id: 'artists', label: 'Artists', icon: 'user-group' },
|
||||||
|
{ id: 'genres', label: 'Genres', icon: 'masks-theater' },
|
||||||
|
{ id: 'albums', label: 'Albums', icon: 'compact-disc' },
|
||||||
|
{ id: 'tracks', label: 'Tracks', icon: 'music' },
|
||||||
|
{ id: 'explore', label: 'Explore', icon: 'globe' },
|
||||||
|
{ id: 'downloads', label: 'Downloads', icon: ICON_REQUESTED },
|
||||||
|
{ id: 'autotag', label: 'Autotag', icon: ICON_AUTOTAG },
|
||||||
|
{ id: 'settings', label: 'Settings', icon: 'gear', alwaysShown: true },
|
||||||
|
];
|
||||||
@@ -0,0 +1,90 @@
|
|||||||
|
/**
|
||||||
|
* Which primary view the app is showing.
|
||||||
|
*
|
||||||
|
* The shell has always known this -- `handleNavigate()` sets
|
||||||
|
* `#main-content`'s `data-active-view` on every path, `_isBack`
|
||||||
|
* included -- and never told anyone. The nav components learned it
|
||||||
|
* from the `navigate` CustomEvent instead, which only the *outbound*
|
||||||
|
* path dispatches: the `popstate` listener calls `handleNavigate()`
|
||||||
|
* directly. So both navs kept highlighting the view you had just left
|
||||||
|
* (#72).
|
||||||
|
*
|
||||||
|
* The fix cannot be a re-dispatch of `navigate`. `index.ts` is itself a
|
||||||
|
* document listener for it, so emitting one from inside
|
||||||
|
* `handleNavigate` is an infinite loop -- and the two statements are
|
||||||
|
* different anyway: `navigate` means *please go to X*, and 28 call
|
||||||
|
* sites across 18 files say it. This says *the active view is now X*,
|
||||||
|
* which only the shell is in a position to say and only once per
|
||||||
|
* navigation.
|
||||||
|
*
|
||||||
|
* Three things about it are load-bearing.
|
||||||
|
*
|
||||||
|
* **It is a store rather than an event**, because a component that
|
||||||
|
* mounts *after* a navigation still has to know. `bottom-nav`'s "More"
|
||||||
|
* drawer creates its `<app-sidebar>` on open, and that copy had heard
|
||||||
|
* no `navigate` at all: standing on Albums, the drawer highlighted
|
||||||
|
* Home -- its `activeView` default, which existed to match the landing
|
||||||
|
* view and matched nothing else ever after. An event has no answer for
|
||||||
|
* a listener that was not there; a value does.
|
||||||
|
*
|
||||||
|
* **A detail view is not a view here.** Opening one leaves the primary
|
||||||
|
* view it was opened from lit, which is what #72 asks for and what
|
||||||
|
* `app-sidebar` used to do by accident -- it guarded on
|
||||||
|
* `navItems.some(...)`, so a name matching no item left its highlight
|
||||||
|
* alone. `bottom-nav` had no such guard and so lit nothing on a detail
|
||||||
|
* view. Neither was correct; the sidebar was stale-but-lucky, and
|
||||||
|
* stating the rule once is what makes the two agree.
|
||||||
|
*
|
||||||
|
* **Whether a view is primary is the shell's fact, not this store's.**
|
||||||
|
* `VIEW_TAGS` in `index.ts` is the list, and a copy of it here is a
|
||||||
|
* second list to forget -- so the caller passes the answer it already
|
||||||
|
* has rather than this file re-deriving it.
|
||||||
|
*/
|
||||||
|
|
||||||
|
type Subscriber = () => void;
|
||||||
|
|
||||||
|
class ActiveViewStore {
|
||||||
|
/** Empty until the shell's first navigation, which happens at
|
||||||
|
* startup from `GetDefaultPage()`. Nothing is highlighted for that
|
||||||
|
* moment, which is honest: the alternative is a written-down
|
||||||
|
* default that is right only when the default page agrees with it. */
|
||||||
|
private activeView = '';
|
||||||
|
|
||||||
|
private subscribers = new Set<Subscriber>();
|
||||||
|
|
||||||
|
/** The active primary view, e.g. `albums`. */
|
||||||
|
get(): string {
|
||||||
|
return this.activeView;
|
||||||
|
}
|
||||||
|
|
||||||
|
isActive(view: string): boolean {
|
||||||
|
return this.activeView !== '' && this.activeView === view;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Called by the shell on every navigation, `popstate` included.
|
||||||
|
*
|
||||||
|
* `isPrimary` is `view in VIEW_TAGS` at the call site: a detail
|
||||||
|
* view reports itself and deliberately changes nothing, so the view
|
||||||
|
* it was opened from stays lit until the user picks another one.
|
||||||
|
*/
|
||||||
|
setView(view: string, isPrimary: boolean): void {
|
||||||
|
if (!isPrimary) return;
|
||||||
|
if (view === this.activeView) return;
|
||||||
|
|
||||||
|
this.activeView = view;
|
||||||
|
this.notify();
|
||||||
|
}
|
||||||
|
|
||||||
|
subscribe(fn: Subscriber): () => void {
|
||||||
|
this.subscribers.add(fn);
|
||||||
|
|
||||||
|
return () => this.subscribers.delete(fn);
|
||||||
|
}
|
||||||
|
|
||||||
|
private notify(): void {
|
||||||
|
this.subscribers.forEach((fn) => fn());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export const activeViewStore = new ActiveViewStore();
|
||||||
@@ -0,0 +1,59 @@
|
|||||||
|
import type {
|
||||||
|
ReactiveController,
|
||||||
|
ReactiveControllerHost,
|
||||||
|
} from 'lit';
|
||||||
|
import { activeViewStore } from '../active-view-store';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* ActiveViewController connects a Lit component to the
|
||||||
|
* ActiveViewStore.
|
||||||
|
*
|
||||||
|
* Usage in a component:
|
||||||
|
*
|
||||||
|
* private activeCtrl = new ActiveViewController(this);
|
||||||
|
*
|
||||||
|
* render() {
|
||||||
|
* const lit = this.activeCtrl.isActive('albums');
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* It reads through to the store rather than copying the value into a
|
||||||
|
* `@state()` field, which is the point of #72: two components holding
|
||||||
|
* their own idea of the active view is what let them disagree with the
|
||||||
|
* shell and with each other.
|
||||||
|
*/
|
||||||
|
export class ActiveViewController implements ReactiveController {
|
||||||
|
private host: ReactiveControllerHost;
|
||||||
|
private unsubscribe?: () => void;
|
||||||
|
|
||||||
|
constructor(host: ReactiveControllerHost) {
|
||||||
|
this.host = host;
|
||||||
|
host.addController(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ===============================================================
|
||||||
|
// LIFECYCLE HOOKS
|
||||||
|
// ===============================================================
|
||||||
|
|
||||||
|
hostConnected(): void {
|
||||||
|
this.unsubscribe = activeViewStore.subscribe(() => {
|
||||||
|
this.host.requestUpdate();
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
hostDisconnected(): void {
|
||||||
|
this.unsubscribe?.();
|
||||||
|
}
|
||||||
|
|
||||||
|
// ===============================================================
|
||||||
|
// DATA ACCESS
|
||||||
|
// ===============================================================
|
||||||
|
|
||||||
|
/** The active primary view, e.g. `albums`. */
|
||||||
|
get current(): string {
|
||||||
|
return activeViewStore.get();
|
||||||
|
}
|
||||||
|
|
||||||
|
isActive(view: string): boolean {
|
||||||
|
return activeViewStore.isActive(view);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,40 @@
|
|||||||
|
import type {
|
||||||
|
ReactiveController,
|
||||||
|
ReactiveControllerHost,
|
||||||
|
} from 'lit';
|
||||||
|
import { historyStore, type HistoryDepth } from '../history-store';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* HistoryController connects a Lit component to the HistoryStore.
|
||||||
|
*
|
||||||
|
* Usage in a component:
|
||||||
|
*
|
||||||
|
* private historyCtrl = new HistoryController(this);
|
||||||
|
*
|
||||||
|
* render() {
|
||||||
|
* const { canBack } = this.historyCtrl.depth;
|
||||||
|
* }
|
||||||
|
*/
|
||||||
|
export class HistoryController implements ReactiveController {
|
||||||
|
private host: ReactiveControllerHost;
|
||||||
|
private unsubscribe?: () => void;
|
||||||
|
|
||||||
|
constructor(host: ReactiveControllerHost) {
|
||||||
|
this.host = host;
|
||||||
|
host.addController(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
hostConnected(): void {
|
||||||
|
this.unsubscribe = historyStore.subscribe(() => {
|
||||||
|
this.host.requestUpdate();
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
hostDisconnected(): void {
|
||||||
|
this.unsubscribe?.();
|
||||||
|
}
|
||||||
|
|
||||||
|
get depth(): HistoryDepth {
|
||||||
|
return historyStore.get();
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,54 @@
|
|||||||
|
import type {
|
||||||
|
ReactiveController,
|
||||||
|
ReactiveControllerHost,
|
||||||
|
} from 'lit';
|
||||||
|
import { viewVisibilityStore } from '../view-visibility-store';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* ViewVisibilityController connects a Lit component to the
|
||||||
|
* ViewVisibilityStore.
|
||||||
|
*
|
||||||
|
* It reads through to the store rather than copying the map into a
|
||||||
|
* `@state()` field, for the reason `ActiveViewController` does: there
|
||||||
|
* are two live `<app-sidebar>` instances the moment `bottom-nav`'s
|
||||||
|
* "More" drawer opens, and two components holding their own idea of
|
||||||
|
* which destinations exist is how they come to disagree.
|
||||||
|
*/
|
||||||
|
export class ViewVisibilityController implements ReactiveController {
|
||||||
|
private host: ReactiveControllerHost;
|
||||||
|
private unsubscribe?: () => void;
|
||||||
|
|
||||||
|
constructor(host: ReactiveControllerHost) {
|
||||||
|
this.host = host;
|
||||||
|
host.addController(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
hostConnected(): void {
|
||||||
|
this.unsubscribe = viewVisibilityStore.subscribe(() => {
|
||||||
|
this.host.requestUpdate();
|
||||||
|
});
|
||||||
|
|
||||||
|
void viewVisibilityStore.init();
|
||||||
|
}
|
||||||
|
|
||||||
|
hostDisconnected(): void {
|
||||||
|
this.unsubscribe?.();
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Whether the navigation should offer this destination. */
|
||||||
|
visible(view: string): boolean {
|
||||||
|
return viewVisibilityStore.visible(view);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* What the config says, ignoring the download-client gate — the
|
||||||
|
* state Settings' own checkbox shows.
|
||||||
|
*/
|
||||||
|
enabled(view: string): boolean {
|
||||||
|
return viewVisibilityStore.enabled(view);
|
||||||
|
}
|
||||||
|
|
||||||
|
setVisible(view: string, visible: boolean): Promise<void> {
|
||||||
|
return viewVisibilityStore.setVisible(view, visible);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -189,6 +189,8 @@ class DownloadStore {
|
|||||||
|
|
||||||
private initialized = false;
|
private initialized = false;
|
||||||
|
|
||||||
|
private providersLoaded = false;
|
||||||
|
|
||||||
constructor() {
|
constructor() {
|
||||||
EventsOn(Events.DownloadProvidersChanged, () => {
|
EventsOn(Events.DownloadProvidersChanged, () => {
|
||||||
void this.refreshProviders();
|
void this.refreshProviders();
|
||||||
@@ -285,6 +287,25 @@ class DownloadStore {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Loads the providers, and only those, once.
|
||||||
|
*
|
||||||
|
* `init()` additionally fetches the descriptors, the downloads and
|
||||||
|
* the request list, which is right for a page about downloading and
|
||||||
|
* wrong for the sidebar: it only needs `available`, to decide
|
||||||
|
* whether the Downloads destination exists at all (#25), and that
|
||||||
|
* is one query. `DownloadProvidersChanged` keeps it current
|
||||||
|
* afterwards, so configuring a client makes the tab appear without
|
||||||
|
* a restart.
|
||||||
|
*/
|
||||||
|
async ensureProviders(): Promise<void> {
|
||||||
|
if (this.providersLoaded) return;
|
||||||
|
|
||||||
|
this.providersLoaded = true;
|
||||||
|
|
||||||
|
await this.refreshProviders();
|
||||||
|
}
|
||||||
|
|
||||||
async refreshProviders(): Promise<void> {
|
async refreshProviders(): Promise<void> {
|
||||||
try {
|
try {
|
||||||
this.providersValue = (await ListProviders()) ?? [];
|
this.providersValue = (await ListProviders()) ?? [];
|
||||||
|
|||||||
@@ -0,0 +1,66 @@
|
|||||||
|
/**
|
||||||
|
* How far the session can go back and forward.
|
||||||
|
*
|
||||||
|
* The History API exposes `length` and nothing useful: it counts
|
||||||
|
* entries the app did not push, does not say where in the list the
|
||||||
|
* current entry is, and `popstate` fires *identically* whether the
|
||||||
|
* user went back or forward. So a control that wants to grey itself
|
||||||
|
* out has to be told, and the shell is the only thing in a position to
|
||||||
|
* know (#6).
|
||||||
|
*
|
||||||
|
* Two rules follow from how the shell counts, and both are the reason
|
||||||
|
* this is a pair of booleans rather than one depth:
|
||||||
|
*
|
||||||
|
* **Forward is not "back, negated".** `pushedEntries` -- the counter
|
||||||
|
* this replaces -- decremented on every `popstate`, which made a
|
||||||
|
* forward navigation look like a second back. The shell keeps an index
|
||||||
|
* per entry and a high-water mark instead, and publishes the two
|
||||||
|
* answers rather than the arithmetic.
|
||||||
|
*
|
||||||
|
* **Back stops at the app's own floor.** The launch entry is
|
||||||
|
* *replaced*, not pushed, so that one back press from the root exits
|
||||||
|
* the app on Android; `canBack` is false there, which is what stops
|
||||||
|
* the header's own button being the thing that quits.
|
||||||
|
*/
|
||||||
|
|
||||||
|
type Subscriber = () => void;
|
||||||
|
|
||||||
|
export interface HistoryDepth {
|
||||||
|
canBack: boolean;
|
||||||
|
canForward: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
class HistoryStore {
|
||||||
|
private depth: HistoryDepth = { canBack: false, canForward: false };
|
||||||
|
|
||||||
|
private subscribers = new Set<Subscriber>();
|
||||||
|
|
||||||
|
get(): HistoryDepth {
|
||||||
|
return this.depth;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Called by the shell whenever an entry is pushed or restored. */
|
||||||
|
setDepth(canBack: boolean, canForward: boolean): void {
|
||||||
|
if (
|
||||||
|
canBack === this.depth.canBack &&
|
||||||
|
canForward === this.depth.canForward
|
||||||
|
) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
this.depth = { canBack, canForward };
|
||||||
|
this.notify();
|
||||||
|
}
|
||||||
|
|
||||||
|
subscribe(fn: Subscriber): () => void {
|
||||||
|
this.subscribers.add(fn);
|
||||||
|
|
||||||
|
return () => this.subscribers.delete(fn);
|
||||||
|
}
|
||||||
|
|
||||||
|
private notify(): void {
|
||||||
|
this.subscribers.forEach((fn) => fn());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export const historyStore = new HistoryStore();
|
||||||
@@ -9,6 +9,11 @@ export type { ThemeState, BackgroundShade } from './theme-store';
|
|||||||
export { ThemeController } from './controllers/theme-controller';
|
export { ThemeController } from './controllers/theme-controller';
|
||||||
export { searchStore } from './search-store';
|
export { searchStore } from './search-store';
|
||||||
export { SearchController } from './controllers/search-controller';
|
export { SearchController } from './controllers/search-controller';
|
||||||
|
export { activeViewStore } from './active-view-store';
|
||||||
|
export { ActiveViewController } from './controllers/active-view-controller';
|
||||||
|
export { historyStore } from './history-store';
|
||||||
|
export type { HistoryDepth } from './history-store';
|
||||||
|
export { HistoryController } from './controllers/history-controller';
|
||||||
export { shortcutsStore } from './shortcuts-store';
|
export { shortcutsStore } from './shortcuts-store';
|
||||||
export type { ShortcutsState } from './shortcuts-store';
|
export type { ShortcutsState } from './shortcuts-store';
|
||||||
export { ShortcutsController } from './controllers/shortcuts-controller';
|
export { ShortcutsController } from './controllers/shortcuts-controller';
|
||||||
|
|||||||
@@ -30,6 +30,7 @@ export type JobState =
|
|||||||
export type JobKind =
|
export type JobKind =
|
||||||
| 'library-scan'
|
| 'library-scan'
|
||||||
| 'index-build'
|
| 'index-build'
|
||||||
|
| 'download'
|
||||||
| 'autotag-apply'
|
| 'autotag-apply'
|
||||||
| 'catalog-enrich';
|
| 'catalog-enrich';
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,119 @@
|
|||||||
|
import { EventsOn } from '@runtime/runtime';
|
||||||
|
import { GetViewVisibility, SetViewVisible } from '@go/config/config.js';
|
||||||
|
import { dictByName } from '@utils/binding';
|
||||||
|
import { downloadStore } from './download-store';
|
||||||
|
import { Events } from '../events';
|
||||||
|
|
||||||
|
type Subscriber = () => void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Which primary destinations the navigation offers.
|
||||||
|
*
|
||||||
|
* Eleven sidebar entries is more than most libraries need, so #25 makes
|
||||||
|
* them individually toggleable. Three rules about this are load-bearing.
|
||||||
|
*
|
||||||
|
* **Hidden is not unreachable.** This decides what the *nav* draws and
|
||||||
|
* nothing else: `navigate` still resolves a hidden view, which is not a
|
||||||
|
* nicety — detail views navigate into these, and the shell's launch
|
||||||
|
* page is one of them. Nothing here needs a special case for the
|
||||||
|
* highlight either, because #72 moved that onto `active-view-store`:
|
||||||
|
* `app-sidebar` asks `isActive(id)` per *rendered* item, so a hidden
|
||||||
|
* view lights nothing exactly as a detail view does.
|
||||||
|
*
|
||||||
|
* **The defaults live in Go**, in `backend/config.Views`, and this asks
|
||||||
|
* for the *resolved* answer rather than the stored map. A config that
|
||||||
|
* says nothing about a view means "that view's own default", so a copy
|
||||||
|
* of the defaults here would be a second thing to keep in step — and
|
||||||
|
* the one that shipped in the artifact, not the one being edited.
|
||||||
|
*
|
||||||
|
* **Downloads is a second question**, answered by the download client
|
||||||
|
* rather than by the config: a destination for a feature that cannot
|
||||||
|
* work is worse than an absent one. It is gated at `visible()` and not
|
||||||
|
* in the config, so switching it on in Settings still means what it
|
||||||
|
* says once a client exists. `available` is false until the providers
|
||||||
|
* have loaded, which makes the tab *appear* on a fresh launch rather
|
||||||
|
* than appearing and then vanishing — the less jarring half of a race
|
||||||
|
* that resolves in one query.
|
||||||
|
*/
|
||||||
|
class ViewVisibilityStore {
|
||||||
|
/** The backend's resolved answer, empty until the first load. */
|
||||||
|
private configured: Record<string, boolean> = {};
|
||||||
|
|
||||||
|
private loaded = false;
|
||||||
|
|
||||||
|
private subscribers = new Set<Subscriber>();
|
||||||
|
|
||||||
|
constructor() {
|
||||||
|
EventsOn(Events.GeneralConfigChanged, () => {
|
||||||
|
void this.refresh();
|
||||||
|
});
|
||||||
|
|
||||||
|
// A client configured later has to add the destination without a
|
||||||
|
// restart -- #37's rule, one surface over.
|
||||||
|
downloadStore.subscribe(() => this.notify());
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Loads the visibility map once. Safe to call from every mount. */
|
||||||
|
async init(): Promise<void> {
|
||||||
|
if (this.loaded) return;
|
||||||
|
|
||||||
|
this.loaded = true;
|
||||||
|
|
||||||
|
await Promise.all([
|
||||||
|
this.refresh(),
|
||||||
|
downloadStore.ensureProviders(),
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether the navigation should offer this destination.
|
||||||
|
*
|
||||||
|
* An unknown id is visible: the caller is drawing it from its own
|
||||||
|
* list, and a view this store has not heard of (or has not loaded
|
||||||
|
* yet) is better shown than silently dropped.
|
||||||
|
*/
|
||||||
|
visible(view: string): boolean {
|
||||||
|
if (view === 'downloads' && !downloadStore.available) return false;
|
||||||
|
|
||||||
|
return this.configured[view] ?? true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* What the *config* says, ignoring the download-client gate — which
|
||||||
|
* is what Settings' own checkbox has to show, or a user with no
|
||||||
|
* client would see Downloads switched off and be unable to switch
|
||||||
|
* it on.
|
||||||
|
*/
|
||||||
|
enabled(view: string): boolean {
|
||||||
|
return this.configured[view] ?? true;
|
||||||
|
}
|
||||||
|
|
||||||
|
async setVisible(view: string, visible: boolean): Promise<void> {
|
||||||
|
await SetViewVisible(view, visible);
|
||||||
|
|
||||||
|
// The backend emits GeneralConfigChanged, but the caller is
|
||||||
|
// owed the new state by the time this resolves.
|
||||||
|
await this.refresh();
|
||||||
|
}
|
||||||
|
|
||||||
|
subscribe(fn: Subscriber): () => void {
|
||||||
|
this.subscribers.add(fn);
|
||||||
|
|
||||||
|
return () => this.subscribers.delete(fn);
|
||||||
|
}
|
||||||
|
|
||||||
|
private async refresh(): Promise<void> {
|
||||||
|
try {
|
||||||
|
this.configured = await dictByName(GetViewVisibility());
|
||||||
|
this.notify();
|
||||||
|
} catch (err) {
|
||||||
|
console.error('Failed to load view visibility:', err);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private notify(): void {
|
||||||
|
this.subscribers.forEach((fn) => fn());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export const viewVisibilityStore = new ViewVisibilityStore();
|
||||||
@@ -0,0 +1,85 @@
|
|||||||
|
import { EventsOn } from '@runtime/runtime';
|
||||||
|
import { GetPopupVolume } from '@go/config/config.js';
|
||||||
|
import { Events } from '../events';
|
||||||
|
|
||||||
|
type Subscriber = () => void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether the volume control is a click-to-open popup (#42).
|
||||||
|
*
|
||||||
|
* The popup was the only option, and "click open, drag, click closed"
|
||||||
|
* is three gestures for a control a bottom bar has room to just show.
|
||||||
|
* So an inline slider is the default and the popup is a setting.
|
||||||
|
*
|
||||||
|
* **The stored flag names the popup, not the slider**, which is the
|
||||||
|
* polarity rule `backend/config` states for every option it has: the
|
||||||
|
* zero value has to be the intended answer. An `InlineVolume bool`
|
||||||
|
* would default to false, hand the popup to every existing install, and
|
||||||
|
* need a migration to say what the default already says.
|
||||||
|
*
|
||||||
|
* It is a store rather than a field on the component because two
|
||||||
|
* components render `<volume-control>` — the bottom bar and the phone's
|
||||||
|
* full-screen now-playing view — and a setting that only reached
|
||||||
|
* whichever one happened to mount after it changed is the fault
|
||||||
|
* `active-view-store` exists to prevent, one surface over.
|
||||||
|
*
|
||||||
|
* The initial value is the *default* rather than a pending answer, so
|
||||||
|
* the first paint is the inline slider and not an empty gap that
|
||||||
|
* becomes one. An install that has chosen the popup sees it swap once
|
||||||
|
* on load, which is the cheaper of the two wrong first frames: the
|
||||||
|
* inline slider occupies the space the popup's button would have.
|
||||||
|
*/
|
||||||
|
class VolumeStyleStore {
|
||||||
|
private value = false;
|
||||||
|
|
||||||
|
private loaded = false;
|
||||||
|
|
||||||
|
private subscribers = new Set<Subscriber>();
|
||||||
|
|
||||||
|
constructor() {
|
||||||
|
EventsOn(Events.GeneralConfigChanged, () => {
|
||||||
|
void this.refresh();
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Whether to draw the popup. Safe to read before `init()`. */
|
||||||
|
get popup(): boolean {
|
||||||
|
return this.value;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Reads the setting once. Safe to call from every mount. */
|
||||||
|
async init(): Promise<void> {
|
||||||
|
if (this.loaded) return;
|
||||||
|
|
||||||
|
this.loaded = true;
|
||||||
|
|
||||||
|
await this.refresh();
|
||||||
|
}
|
||||||
|
|
||||||
|
subscribe(fn: Subscriber): () => void {
|
||||||
|
this.subscribers.add(fn);
|
||||||
|
|
||||||
|
return () => this.subscribers.delete(fn);
|
||||||
|
}
|
||||||
|
|
||||||
|
private async refresh(): Promise<void> {
|
||||||
|
try {
|
||||||
|
const popup = await GetPopupVolume();
|
||||||
|
|
||||||
|
if (popup === this.value) return;
|
||||||
|
|
||||||
|
this.value = popup;
|
||||||
|
this.notify();
|
||||||
|
} catch (err) {
|
||||||
|
// Nothing to tell the user: the control renders in its
|
||||||
|
// default presentation, which is a working volume control.
|
||||||
|
console.error('failed to read the volume control setting', err);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private notify(): void {
|
||||||
|
for (const fn of this.subscribers) fn();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export const volumeStyleStore = new VolumeStyleStore();
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
/**
|
||||||
|
* The shell's breakpoints, where JavaScript has to agree with CSS.
|
||||||
|
*
|
||||||
|
* A media query inside a shadow root is answered by the viewport, so a
|
||||||
|
* component normally states what it drops at phone width in its own
|
||||||
|
* stylesheet and needs nothing from here. This exists for the cases
|
||||||
|
* where the decision is not a style: `track-list` computes its grid in
|
||||||
|
* JS from the host width, and `now-playing` renders *different content*
|
||||||
|
* on a phone — a plain string instead of a link — which no stylesheet
|
||||||
|
* can express.
|
||||||
|
*
|
||||||
|
* One breakpoint, several expressions of it. It was a private const in
|
||||||
|
* track-list.ts when there was one; a second reader is where a copy
|
||||||
|
* would start drifting from index.css.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Phone width. 600px rather than the sidebar's 900px because 900 is a
|
||||||
|
* laptop: the answer there is a narrower sidebar, which is still a
|
||||||
|
* sidebar. Below this the shell drops the sidebar column entirely and
|
||||||
|
* bottom-nav takes over.
|
||||||
|
*/
|
||||||
|
export const PHONE_QUERY = '(max-width: 599px)';
|
||||||
@@ -54,6 +54,18 @@ export const ICON_PLAYLIST = 'list';
|
|||||||
*/
|
*/
|
||||||
export const ICON_NEW = 'plus';
|
export const ICON_NEW = 'plus';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A smart playlist — the rule, and the thing the rule makes.
|
||||||
|
*
|
||||||
|
* Governed for the reason `ICON_AUTOTAG` states: it was already at
|
||||||
|
* three call sites (the Playlists header, the row marker beside a smart
|
||||||
|
* playlist's name, and `smart-playlist-details`'s avatar), and a name
|
||||||
|
* stops being a detail of one component the moment there are two. It is
|
||||||
|
* deliberately *not* `ICON_NEW`, even on the button that makes one:
|
||||||
|
* an icon names the noun it acts on, and the noun here is the rule.
|
||||||
|
*/
|
||||||
|
export const ICON_SMART_PLAYLIST = 'filter';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The request ("want") toggle, as an outline/solid pair.
|
* The request ("want") toggle, as an outline/solid pair.
|
||||||
*
|
*
|
||||||
@@ -80,6 +92,17 @@ export const ICON_REQUESTED = 'solid/bookmark';
|
|||||||
*/
|
*/
|
||||||
export const ICON_IN_LIBRARY = 'check';
|
export const ICON_IN_LIBRARY = 'check';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The autotagger, and a match it is offering.
|
||||||
|
*
|
||||||
|
* The same icon as the Autotag destination in the sidebar, on the rule
|
||||||
|
* `ICON_PLAYLIST` was chosen by: an icon names the noun it acts on, so
|
||||||
|
* a suggestion on the album page wears the mark of the page it would
|
||||||
|
* send you to. Governed from the moment there were two call sites,
|
||||||
|
* which is when a name stops being a detail of one component.
|
||||||
|
*/
|
||||||
|
export const ICON_AUTOTAG = 'tag';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Something is being fetched right now.
|
* Something is being fetched right now.
|
||||||
*
|
*
|
||||||
@@ -89,6 +112,18 @@ export const ICON_IN_LIBRARY = 'check';
|
|||||||
*/
|
*/
|
||||||
export const ICON_DOWNLOADING = 'download';
|
export const ICON_DOWNLOADING = 'download';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The rest of what this thing can do.
|
||||||
|
*
|
||||||
|
* `page-header` collapses the actions that do not fit into one menu
|
||||||
|
* behind this, so the glyph has to name *more of the same nouns* rather
|
||||||
|
* than any one of them — which is what an ellipsis is and what `bars`
|
||||||
|
* (the navigation drawer, one component over in `bottom-nav`) is not.
|
||||||
|
* It is deliberately the only meaning it carries: an overflow menu that
|
||||||
|
* shared an icon with a destination would be the `list` problem again.
|
||||||
|
*/
|
||||||
|
export const ICON_MORE_ACTIONS = 'ellipsis';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Take this away.
|
* Take this away.
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -0,0 +1,286 @@
|
|||||||
|
/**
|
||||||
|
* Being told about a match while looking at the album.
|
||||||
|
*
|
||||||
|
* The complaint (#28) is that the user had to notice their metadata
|
||||||
|
* was missing and then go and hunt the album down on the Autotag page.
|
||||||
|
* So the suggestion is drawn here, with something to do about it — and
|
||||||
|
* the something rewrites files on disk, which is what most of this
|
||||||
|
* file is about.
|
||||||
|
*
|
||||||
|
* The confidence tier behind "MusicBrainz has a match" is decided in
|
||||||
|
* the backend (`autotag.ConfidentTier`) so this page and strict
|
||||||
|
* auto-accept cannot disagree about what it means; what is pinned here
|
||||||
|
* is only what the page does with the answer.
|
||||||
|
*/
|
||||||
|
import { describe, expect, it, beforeEach } from 'vitest';
|
||||||
|
import type { LitElement } from 'lit';
|
||||||
|
import { page } from 'vitest/browser';
|
||||||
|
|
||||||
|
import '@components/explore-album-details/explore-album-details';
|
||||||
|
import { stub, stubFailure, flush, resetHarness, calls } from '@test/support/harness';
|
||||||
|
import { notificationStore } from '@store/notification-store';
|
||||||
|
import '@components/notifications/notification-host';
|
||||||
|
import { fixture, shadow, shadowAll } from '@test/support/render';
|
||||||
|
|
||||||
|
const MATCH = 'autotagservice.Service.MatchForAlbum';
|
||||||
|
const APPLY = 'autotagservice.Service.ApplyAsync';
|
||||||
|
|
||||||
|
function match(over: Record<string, unknown> = {}) {
|
||||||
|
return {
|
||||||
|
groupKey: 'grp-1',
|
||||||
|
recommendation: 'strong',
|
||||||
|
score: 0.95,
|
||||||
|
releaseMbid: 'rel-1',
|
||||||
|
title: 'Glass Harbour',
|
||||||
|
artistCredit: 'Tideline',
|
||||||
|
trackCount: 10,
|
||||||
|
groupCount: 1,
|
||||||
|
...over,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
async function albumPage(): Promise<LitElement> {
|
||||||
|
const el = await fixture<LitElement>('explore-album-details', {
|
||||||
|
albumName: 'Glass Harbour',
|
||||||
|
localAlbumId: 7,
|
||||||
|
});
|
||||||
|
|
||||||
|
await flush();
|
||||||
|
await el.updateComplete;
|
||||||
|
|
||||||
|
return el;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The confirm dialog attaches itself to the document on first use. */
|
||||||
|
function confirmHost(): (LitElement & { shadowRoot: ShadowRoot | null }) | null {
|
||||||
|
return document.querySelector('confirm-dialog');
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Press one of the dialog's own buttons, the way a person would. */
|
||||||
|
async function pressConfirm(testid: string): Promise<void> {
|
||||||
|
const host = confirmHost();
|
||||||
|
|
||||||
|
if (!host) throw new Error('confirm-dialog did not mount itself');
|
||||||
|
|
||||||
|
await host.updateComplete;
|
||||||
|
host.shadowRoot
|
||||||
|
?.querySelector<HTMLButtonElement>(`[data-testid="${testid}"]`)
|
||||||
|
?.click();
|
||||||
|
await host.updateComplete;
|
||||||
|
await flush();
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Click one of the banner's buttons by its label. */
|
||||||
|
async function pressBanner(el: LitElement, label: string): Promise<void> {
|
||||||
|
shadowAll<HTMLElement>(el, '.autotag-match-actions wa-button')
|
||||||
|
.find((b) => b.textContent?.includes(label))
|
||||||
|
?.click();
|
||||||
|
await flush();
|
||||||
|
}
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
resetHarness();
|
||||||
|
notificationStore.clear();
|
||||||
|
stub('explore.Service.BrowseReleases', []);
|
||||||
|
stub('explore.Service.LookupReleaseGroup', null);
|
||||||
|
stub('explore.Service.GetThumbnail', '');
|
||||||
|
stub('library.Library.GetAlbumTracks', []);
|
||||||
|
stub('library.Library.GetAlbumCompleteness', {
|
||||||
|
owned: 0,
|
||||||
|
expected: 0,
|
||||||
|
known: false,
|
||||||
|
complete: false,
|
||||||
|
});
|
||||||
|
stub('library.Library.GetAllLibrariesWithTrackCounts', []);
|
||||||
|
stub('library.Library.GetFilePathsByRecordingMBIDs', {});
|
||||||
|
stub(MATCH, null);
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('the autotag suggestion', () => {
|
||||||
|
it('says nothing when the backend has nothing confident', async () => {
|
||||||
|
const el = await albumPage();
|
||||||
|
|
||||||
|
expect(shadow(el, '.autotag-match')).toBeNull();
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A pure catalog page has no files to retag, so the question is not
|
||||||
|
* asked at all — this runs on every album open and a call that
|
||||||
|
* cannot have an answer is a call not worth making.
|
||||||
|
*/
|
||||||
|
it('is not even asked about an album with no local files', async () => {
|
||||||
|
stub(MATCH, match());
|
||||||
|
|
||||||
|
const el = await fixture<LitElement>('explore-album-details', {
|
||||||
|
albumName: 'Glass Harbour',
|
||||||
|
releaseGroupMBID: 'rg-1',
|
||||||
|
});
|
||||||
|
|
||||||
|
await flush();
|
||||||
|
await el.updateComplete;
|
||||||
|
|
||||||
|
expect(calls(MATCH)).toHaveLength(0);
|
||||||
|
expect(shadow(el, '.autotag-match')).toBeNull();
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The banner names the release rather than quoting a number: 0.95
|
||||||
|
* reads as a probability and is not one, and which release it is, is
|
||||||
|
* the thing the user can actually judge.
|
||||||
|
*/
|
||||||
|
it('names the release it is offering', async () => {
|
||||||
|
stub(MATCH, match());
|
||||||
|
|
||||||
|
const el = await albumPage();
|
||||||
|
const text = shadow(el, '.autotag-match')?.textContent ?? '';
|
||||||
|
|
||||||
|
expect(text).toContain('MusicBrainz has a match');
|
||||||
|
expect(text).toContain('Glass Harbour');
|
||||||
|
expect(text).toContain('Tideline');
|
||||||
|
expect(text).not.toContain('95');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('offers both an apply and a review', async () => {
|
||||||
|
stub(MATCH, match());
|
||||||
|
|
||||||
|
await albumPage();
|
||||||
|
|
||||||
|
await expect
|
||||||
|
.element(page.getByRole('button', { name: 'Apply tags' }))
|
||||||
|
.toBeInTheDocument();
|
||||||
|
await expect
|
||||||
|
.element(page.getByRole('button', { name: 'Review in Autotag' }))
|
||||||
|
.toBeInTheDocument();
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A tagging group is a folder, so a multi-disc album is several. One
|
||||||
|
* button that applied to the best-scoring one would leave the album
|
||||||
|
* holding a mix of old and new tags — which is the case the app's
|
||||||
|
* Blocking notification level exists for, and is worth not creating.
|
||||||
|
*/
|
||||||
|
it('will not apply to an album filed as several folders', async () => {
|
||||||
|
stub(MATCH, match({ groupCount: 2 }));
|
||||||
|
|
||||||
|
const el = await albumPage();
|
||||||
|
const labels = shadowAll(el, '.autotag-match-actions wa-button').map(
|
||||||
|
(b) => b.textContent?.trim(),
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(labels).toEqual(['Review in Autotag']);
|
||||||
|
expect(shadow(el, '.autotag-match')?.textContent).toContain('2 folders');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('navigates to Autotag carrying the group key', async () => {
|
||||||
|
stub(MATCH, match());
|
||||||
|
|
||||||
|
const el = await albumPage();
|
||||||
|
const seen: CustomEvent[] = [];
|
||||||
|
|
||||||
|
el.addEventListener('navigate', (e) => seen.push(e as CustomEvent));
|
||||||
|
|
||||||
|
await pressBanner(el, 'Review');
|
||||||
|
|
||||||
|
expect(seen).toHaveLength(1);
|
||||||
|
expect(seen[0]?.detail).toMatchObject({
|
||||||
|
view: 'autotag',
|
||||||
|
groupKey: 'grp-1',
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('applying from the album page', () => {
|
||||||
|
/**
|
||||||
|
* This rewrites tags in files on disk and cannot be undone, so it
|
||||||
|
* asks first — and cancelling has to be a true no-op, not a
|
||||||
|
* confirmation that fires the call anyway.
|
||||||
|
*/
|
||||||
|
it('asks before it writes, and cancelling writes nothing', async () => {
|
||||||
|
stub(MATCH, match());
|
||||||
|
stub(APPLY, null);
|
||||||
|
|
||||||
|
const el = await albumPage();
|
||||||
|
|
||||||
|
await pressBanner(el, 'Apply');
|
||||||
|
|
||||||
|
expect(confirmHost()).not.toBeNull();
|
||||||
|
expect(calls(APPLY)).toHaveLength(0);
|
||||||
|
|
||||||
|
await pressConfirm('confirm-cancel');
|
||||||
|
await el.updateComplete;
|
||||||
|
|
||||||
|
expect(calls(APPLY)).toHaveLength(0);
|
||||||
|
expect(shadow(el, '.autotag-match')).not.toBeNull();
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The impact line has to say the thing that cannot be taken back, in
|
||||||
|
* those words — "cannot be undone" — and that nothing is deleted,
|
||||||
|
* because "rewrites your files" reads worse than it is.
|
||||||
|
*/
|
||||||
|
it('says what cannot be undone', async () => {
|
||||||
|
stub(MATCH, match());
|
||||||
|
|
||||||
|
const el = await albumPage();
|
||||||
|
|
||||||
|
await pressBanner(el, 'Apply');
|
||||||
|
|
||||||
|
const text = confirmHost()?.shadowRoot?.textContent ?? '';
|
||||||
|
|
||||||
|
expect(text).toContain('cannot be');
|
||||||
|
expect(text).toContain('undone');
|
||||||
|
expect(text.toLowerCase()).toContain('nothing is moved or deleted');
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* `ApplyAsync` is the registered-job path, so progress belongs to
|
||||||
|
* the jobs indicator and this page does not grow a second one. What
|
||||||
|
* it owes the user is an acknowledgement, because the button is
|
||||||
|
* here — and the suggestion has to stop inviting a second click.
|
||||||
|
*/
|
||||||
|
it('hands the work to the job registry and stands down', async () => {
|
||||||
|
stub(MATCH, match());
|
||||||
|
stub(APPLY, null);
|
||||||
|
|
||||||
|
const el = await albumPage();
|
||||||
|
|
||||||
|
await pressBanner(el, 'Apply');
|
||||||
|
await pressConfirm('confirm-accept');
|
||||||
|
await el.updateComplete;
|
||||||
|
|
||||||
|
expect(calls(APPLY)).toHaveLength(1);
|
||||||
|
// The release is passed explicitly: a rescore between the page
|
||||||
|
// rendering and the click must not swap the album out from under
|
||||||
|
// a button the user has already read.
|
||||||
|
expect(calls(APPLY)[0]?.args).toEqual(['grp-1', 'rel-1']);
|
||||||
|
expect(shadow(el, '.autotag-match')).toBeNull();
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A failure is Persistent, not Transient: the user asked for
|
||||||
|
* something that did not happen and retrying is meaningful, which is
|
||||||
|
* the notification store's own rule for choosing the level.
|
||||||
|
*/
|
||||||
|
it('keeps a failure on screen', async () => {
|
||||||
|
stub(MATCH, match());
|
||||||
|
stubFailure(APPLY, 'the tag writer refused');
|
||||||
|
|
||||||
|
const el = await albumPage();
|
||||||
|
|
||||||
|
await pressBanner(el, 'Apply');
|
||||||
|
await pressConfirm('confirm-accept');
|
||||||
|
await el.updateComplete;
|
||||||
|
|
||||||
|
// Read it the way a person would: the app's one notification
|
||||||
|
// surface, rendered.
|
||||||
|
const host = await fixture<LitElement>('notification-host');
|
||||||
|
|
||||||
|
await host.updateComplete;
|
||||||
|
|
||||||
|
const shown = shadowAll(host, '[data-testid="notification"]').map(
|
||||||
|
(n) => n.textContent ?? '',
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(shown.join(' ')).toContain('could not be');
|
||||||
|
});
|
||||||
|
});
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user