Compare commits
142
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7ba5d321f6 | ||
|
|
f126dd7397 | ||
|
|
510d3470f9 | ||
|
|
d78830aa52 | ||
|
|
a72d1f68ed | ||
|
|
60f1c5a6b2 | ||
|
|
11ba7b3180 | ||
|
|
7f8e185d7c | ||
|
|
42483c4b61 | ||
|
|
deea6ad06d | ||
|
|
fba608fdbd | ||
|
|
f59490b113 | ||
|
|
6cca57f229 | ||
|
|
ea3edde697 | ||
|
|
14e3ab574c | ||
|
|
4b2eec5703 | ||
|
|
3871d37fdb | ||
|
|
09b005557c | ||
|
|
ef5574d18b | ||
|
|
31dafb0ce0 | ||
|
|
9e7e7ce5a1 | ||
|
|
9aaa8beb99 | ||
|
|
2e29e67664 | ||
|
|
f26b44db08 | ||
|
|
b43172a60c | ||
|
|
2be6fb3066 | ||
|
|
867ced8c81 | ||
|
|
fd71ef53c5 | ||
|
|
e3b64f9255 | ||
|
|
c7e5a4f086 | ||
|
|
f65822c4b2 | ||
|
|
32d4dc2c82 | ||
|
|
218e4f5e99 | ||
|
|
56a5ff99fe | ||
|
|
af4b28b0d7 | ||
|
|
4ee5b4b473 | ||
|
|
a70a7ed9eb | ||
|
|
de2cb2693a | ||
|
|
880adff12c | ||
|
|
d6f7412e9d | ||
|
|
1ab767a317 | ||
|
|
ac8f86eb00 | ||
|
|
47bd9ef211 | ||
|
|
b801fa533a | ||
|
|
8879192097 | ||
|
|
f76ee96ac4 | ||
|
|
23f5a0c53a | ||
|
|
502b814a65 | ||
|
|
c19a806298 | ||
|
|
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 | ||
|
|
c4e055ce51 | ||
|
|
10eca353ab | ||
|
|
88fc50afb8 | ||
|
|
19c68d73a7 | ||
|
|
41c41a860e | ||
|
|
4bf59b45b7 | ||
|
|
fc99d9e0d7 | ||
|
|
90f1239fba | ||
|
|
b2fe1cb1e0 |
@@ -139,6 +139,23 @@ jobs:
|
|||||||
echo "skip=true" >> "$GITHUB_OUTPUT"
|
echo "skip=true" >> "$GITHUB_OUTPUT"
|
||||||
exit 0
|
exit 0
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
# Nor is a prerelease, and this trigger is `v*`, which matches
|
||||||
|
# `v0.4.0-beta.1`. Two reasons it is worst here. The APK goes
|
||||||
|
# to the *generic* registry, which is readable without
|
||||||
|
# credentials so Obtainium can poll a plain URL — a beta would
|
||||||
|
# be offered to every device on it. And the versionCode maths
|
||||||
|
# below splits on dots and would read "1" out of "0-beta",
|
||||||
|
# producing a code that is wrong rather than a build that
|
||||||
|
# fails: Android orders releases by that integer and refuses
|
||||||
|
# anything not greater than what is installed.
|
||||||
|
case "$v" in
|
||||||
|
*-*)
|
||||||
|
echo "v$v is a prerelease; not publishing an APK for it"
|
||||||
|
echo "skip=true" >> "$GITHUB_OUTPUT"
|
||||||
|
exit 0
|
||||||
|
;;
|
||||||
|
esac
|
||||||
echo "skip=false" >> "$GITHUB_OUTPUT"
|
echo "skip=false" >> "$GITHUB_OUTPUT"
|
||||||
|
|
||||||
# Android orders releases by an integer and refuses anything
|
# Android orders releases by an integer and refuses anything
|
||||||
|
|||||||
@@ -72,6 +72,22 @@ jobs:
|
|||||||
exit 0
|
exit 0
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
# A prerelease is not a shipment either, and this trigger is
|
||||||
|
# `v*` — which matches `v0.4.0-beta.1`. Nothing produces one
|
||||||
|
# today; the guard is here because the thing that would is
|
||||||
|
# semantic-release's `prerelease: true` channel, a one-line
|
||||||
|
# change in .releaserc.yml whose blast radius is four public
|
||||||
|
# package channels. Same argument as release.yml's
|
||||||
|
# `chore(release):` guard: cheap, against something a future
|
||||||
|
# edit turns on somewhere else entirely.
|
||||||
|
case "$v" in
|
||||||
|
*-*)
|
||||||
|
echo "$v is a prerelease; not packaging it for pacman"
|
||||||
|
echo "skip=true" >> "$GITHUB_OUTPUT"
|
||||||
|
exit 0
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
echo "skip=false" >> "$GITHUB_OUTPUT"
|
echo "skip=false" >> "$GITHUB_OUTPUT"
|
||||||
echo "tag=$v" >> "$GITHUB_OUTPUT"
|
echo "tag=$v" >> "$GITHUB_OUTPUT"
|
||||||
echo "building $v"
|
echo "building $v"
|
||||||
|
|||||||
@@ -95,6 +95,19 @@ jobs:
|
|||||||
exit 0
|
exit 0
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
# Nor is a prerelease, and this trigger is `v*`, which matches
|
||||||
|
# `v0.4.0-beta.1`. The mildest of the four — assets attach to
|
||||||
|
# the prerelease's own Gitea release and no package manager
|
||||||
|
# reads them — but four workflows sharing one trigger should
|
||||||
|
# share one answer about what a shipment is.
|
||||||
|
case "$v" in
|
||||||
|
*-*)
|
||||||
|
echo "$v is a prerelease; not attaching desktop assets"
|
||||||
|
echo "skip=true" >> "$GITHUB_OUTPUT"
|
||||||
|
exit 0
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
echo "skip=false" >> "$GITHUB_OUTPUT"
|
echo "skip=false" >> "$GITHUB_OUTPUT"
|
||||||
echo "tag=$v" >> "$GITHUB_OUTPUT"
|
echo "tag=$v" >> "$GITHUB_OUTPUT"
|
||||||
echo "version=${v#v}" >> "$GITHUB_OUTPUT"
|
echo "version=${v#v}" >> "$GITHUB_OUTPUT"
|
||||||
|
|||||||
@@ -56,6 +56,18 @@ jobs:
|
|||||||
echo "skip=true" >> "$GITHUB_OUTPUT"
|
echo "skip=true" >> "$GITHUB_OUTPUT"
|
||||||
exit 0
|
exit 0
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
# Nor is a prerelease, and this trigger is `v*`, which matches
|
||||||
|
# `v0.4.0-beta.1`. It matters most here of the four: the tap
|
||||||
|
# is public, and `brew upgrade` would offer a beta to everyone
|
||||||
|
# on it.
|
||||||
|
case "$VERSION" in
|
||||||
|
*-*)
|
||||||
|
echo "$TAG is a prerelease; not syncing it to a public tap"
|
||||||
|
echo "skip=true" >> "$GITHUB_OUTPUT"
|
||||||
|
exit 0
|
||||||
|
;;
|
||||||
|
esac
|
||||||
echo "skip=false" >> "$GITHUB_OUTPUT"
|
echo "skip=false" >> "$GITHUB_OUTPUT"
|
||||||
|
|
||||||
TARBALL="${SOURCE_TARBALL_BASE}/${TAG}.tar.gz"
|
TARBALL="${SOURCE_TARBALL_BASE}/${TAG}.tar.gz"
|
||||||
|
|||||||
@@ -1,11 +1,36 @@
|
|||||||
name: Release
|
name: Release
|
||||||
|
|
||||||
# The sixth workflow, and the one that decides whether the other three
|
# The sixth workflow, and the one that decides whether the other three
|
||||||
# run at all. On every push to main it reads the Conventional Commits
|
# run at all. It reads the Conventional Commits since the last tag, and
|
||||||
# since the last tag, and if any of them is releasable it writes the
|
# if any of them is releasable it writes the changelog, pushes the tag,
|
||||||
# changelog, pushes the tag, and creates the Gitea release whose body is
|
# and creates the Gitea release whose body is that changelog section.
|
||||||
# that changelog section. The publishing workflows are keyed on `v*`, so
|
# The publishing workflows are keyed on `v*`, so the tag push is what
|
||||||
# the tag push is what starts them.
|
# starts them.
|
||||||
|
#
|
||||||
|
# **It is triggered by hand, and there is deliberately no `push`
|
||||||
|
# trigger.** There was one, on `main`, which made the trigger "a PR was
|
||||||
|
# merged" and nothing else: eight releases in twenty-two hours
|
||||||
|
# (v0.0.1 -> v0.3.1) for one session's work, each fanning out to four
|
||||||
|
# publishers on a runner with capacity 1, so ~40 packaging jobs shipped
|
||||||
|
# three issues and ordinary PR CI queued behind them. A version per
|
||||||
|
# merged PR is a version per unit of *work*, not per *shipment*, and
|
||||||
|
# pacman, Homebrew and Obtainium see every one.
|
||||||
|
#
|
||||||
|
# Nothing else had to change to batch them: semantic-release already
|
||||||
|
# reads every commit since the last tag, so five fixes and two feats
|
||||||
|
# become one minor release with all seven in the notes. Release
|
||||||
|
# frequency was only ever how often this file fired.
|
||||||
|
#
|
||||||
|
# This is the rule `index-artifact.yml` states and is the other instance
|
||||||
|
# of: **a job that mutates state which cannot be rebuilt in ten minutes
|
||||||
|
# is triggered deliberately, not by a push.** A release here is a tag,
|
||||||
|
# a Gitea release, an Arch package, a Homebrew formula, a signed APK and
|
||||||
|
# desktop assets — and an Android version going backwards costs the user
|
||||||
|
# their library (docs/android-release.md).
|
||||||
|
#
|
||||||
|
# A schedule was considered and rejected: a cron batches without anyone
|
||||||
|
# having to remember, but it puts the decision back on a timer, which is
|
||||||
|
# the thing being removed.
|
||||||
#
|
#
|
||||||
# **Why the tag is pushed with PACKAGE_TOKEN and not the Actions token.**
|
# **Why the tag is pushed with PACKAGE_TOKEN and not the Actions token.**
|
||||||
# Gitea, like GitHub, does not start a workflow from a ref pushed by a
|
# Gitea, like GitHub, does not start a workflow from a ref pushed by a
|
||||||
@@ -19,9 +44,12 @@ name: Release
|
|||||||
# instead.
|
# instead.
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
|
||||||
branches: [main]
|
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
|
inputs:
|
||||||
|
dry_run:
|
||||||
|
description: "Report what would be released and stop"
|
||||||
|
required: false
|
||||||
|
default: "false"
|
||||||
|
|
||||||
# Cutting a tag is not a thing to cancel halfway: a superseded run must
|
# Cutting a tag is not a thing to cancel halfway: a superseded run must
|
||||||
# finish, not be killed between `git push --tags` and the release POST.
|
# finish, not be killed between `git push --tags` and the release POST.
|
||||||
@@ -163,14 +191,32 @@ jobs:
|
|||||||
# been right, the tag would have been right, every job would have
|
# been right, the tag would have been right, every job would have
|
||||||
# been green, and the release body would have been empty. Check the
|
# been green, and the release body would have been empty. Check the
|
||||||
# notes, not the exit code, before moving any of these.
|
# notes, not the exit code, before moving any of these.
|
||||||
|
# The point of a manual trigger is deliberateness, and deliberate
|
||||||
|
# means being able to look before pulling the lever. `--dry-run`
|
||||||
|
# reports the version and the notes and writes nothing: no tag, no
|
||||||
|
# release, no publishers. `make release-dry` is the same answer
|
||||||
|
# locally; this is it from the runner, against the same commit and
|
||||||
|
# the same tag history, which is what actually decides.
|
||||||
- name: Run semantic-release
|
- name: Run semantic-release
|
||||||
if: steps.guard.outputs.skip == 'false'
|
if: steps.guard.outputs.skip == 'false'
|
||||||
working-directory: /src
|
working-directory: /src
|
||||||
|
env:
|
||||||
|
DRY_RUN: ${{ inputs.dry_run }}
|
||||||
run: |
|
run: |
|
||||||
set -eu
|
set -eu
|
||||||
git config user.name "yellowjacket-ci"
|
git config user.name "yellowjacket-ci"
|
||||||
git config user.email "yj@yellowjacket.app"
|
git config user.email "yj@yellowjacket.app"
|
||||||
|
|
||||||
|
# Anything but a literal "true" releases for real. A typo in a
|
||||||
|
# dispatch box must not silently turn a shipment into a no-op
|
||||||
|
# that reports success — the failure worth avoiding is the one
|
||||||
|
# where nothing happens and the run is green.
|
||||||
|
dry=""
|
||||||
|
if [ "${DRY_RUN:-false}" = "true" ]; then
|
||||||
|
echo "DRY RUN — no tag will be pushed and no release created"
|
||||||
|
dry="--dry-run"
|
||||||
|
fi
|
||||||
|
|
||||||
npx --yes \
|
npx --yes \
|
||||||
-p semantic-release@25 \
|
-p semantic-release@25 \
|
||||||
-p @semantic-release/commit-analyzer@13 \
|
-p @semantic-release/commit-analyzer@13 \
|
||||||
@@ -178,5 +224,5 @@ jobs:
|
|||||||
-p @semantic-release/changelog@7 \
|
-p @semantic-release/changelog@7 \
|
||||||
-p @semantic-release/exec@7 \
|
-p @semantic-release/exec@7 \
|
||||||
-p conventional-changelog-conventionalcommits@9 \
|
-p conventional-changelog-conventionalcommits@9 \
|
||||||
semantic-release \
|
semantic-release $dry \
|
||||||
--repository-url "https://x-access-token:${PACKAGE_TOKEN}@${SERVER_URL#https://}/${REPO}.git"
|
--repository-url "https://x-access-token:${PACKAGE_TOKEN}@${SERVER_URL#https://}/${REPO}.git"
|
||||||
|
|||||||
@@ -88,3 +88,8 @@ build/android/overlay.json
|
|||||||
# Written by @semantic-release/changelog purely to carry the release notes
|
# Written by @semantic-release/changelog purely to carry the release notes
|
||||||
# into scripts/gitea-release.sh; the release page is the changelog.
|
# into scripts/gitea-release.sh; the release page is the changelog.
|
||||||
.release-notes.md
|
.release-notes.md
|
||||||
|
|
||||||
|
# Agent session log: local scratch, not repo memory (that is CLAUDE.md
|
||||||
|
# and .planning/). Written by the scheduled backlog runs.
|
||||||
|
.pi/journal.md
|
||||||
|
.pi/schedule-prompts.json
|
||||||
|
|||||||
@@ -0,0 +1,142 @@
|
|||||||
|
---
|
||||||
|
description: Take on the next actionable backlog issue end to end, and stop
|
||||||
|
---
|
||||||
|
Take on exactly one issue from the YellowJacket backlog, end to end, and stop.
|
||||||
|
|
||||||
|
Repo: yonlu/yellowjacket at https://git.ljones.me — API base
|
||||||
|
https://git.ljones.me/api/v1/repos/yonlu/yellowjacket, auth with
|
||||||
|
`-H "Authorization: token $GITEA_TOKEN"`. Default branch is `main`.
|
||||||
|
|
||||||
|
## 1. Orient before you pick
|
||||||
|
|
||||||
|
Read, in this order: `CLAUDE.md` (the architecture and the reasons behind
|
||||||
|
it), `.pi/journal.md` (what happened last), `.planning/NOTES.md` (what was
|
||||||
|
already considered and rejected), and `.planning/plans/active/`. Do not skip
|
||||||
|
this because the issue looks small — most of this codebase's traps are
|
||||||
|
written down in exactly one of those four places, and the ones that bite are
|
||||||
|
the ones you didn't read.
|
||||||
|
|
||||||
|
## 2. Pick the issue
|
||||||
|
|
||||||
|
List open issues. Choose the single highest-value one that is *actionable
|
||||||
|
right now*:
|
||||||
|
|
||||||
|
- Order by `Priority/Critical` → `High` → `Medium` → `Low`. Within a tier,
|
||||||
|
prefer `Reviewed/Confirmed`, then `Kind/Bug` over `Kind/Enhancement` over
|
||||||
|
`Kind/Feature`.
|
||||||
|
- Consult issue #73 (the roadmap) — if it sequences the candidates, that
|
||||||
|
ordering wins over the label ordering.
|
||||||
|
- **Skip** anything labelled `Status/Blocked`, `Status/In Progress`,
|
||||||
|
`Status/Abandoned`, `Reviewed/Won't Fix`, `Reviewed/Duplicate`,
|
||||||
|
`Reviewed/Invalid`, or already carrying an open PR.
|
||||||
|
- **Skip anything someone else is already on.** The label is not the only
|
||||||
|
claim, because a concurrent session may not have applied it — several pi
|
||||||
|
sessions run against this repo from separate worktrees under
|
||||||
|
`~/.paseo/worktrees/`. Run `git ls-remote --heads origin` and skip any
|
||||||
|
issue whose number or slug matches an existing branch (`60-…`,
|
||||||
|
`fix/<slug>`). A duplicated fix costs more than a skipped issue.
|
||||||
|
- **Skip** anything that cannot be verified without hardware you do not
|
||||||
|
have: physical-device Android behaviour (audio output, on-device file
|
||||||
|
writes, real gesture input). A browser at 424px is not a phone — see the
|
||||||
|
Chrome 113 section of `CLAUDE.md`.
|
||||||
|
- **Skip** intermittent-failure issues unless you can reproduce the failure
|
||||||
|
on demand within a few minutes. Chasing a 1-in-3 flake is an unbounded
|
||||||
|
task and does not belong in a scheduled run.
|
||||||
|
- If nothing qualifies, say so, do nothing, and stop. An empty run is a
|
||||||
|
correct outcome.
|
||||||
|
|
||||||
|
## 3. Claim it
|
||||||
|
|
||||||
|
Add `Status/In Progress` to the issue and comment that you are picking it
|
||||||
|
up. Then branch:
|
||||||
|
|
||||||
|
```
|
||||||
|
git fetch origin && git checkout -b <type>/<short-slug> origin/main
|
||||||
|
```
|
||||||
|
|
||||||
|
`<type>` matches the issue's `Kind` (`fix/`, `feat/`, `refactor/`, `test/`,
|
||||||
|
`docs/`, `ci/`). Branch from `origin/main`, never by checking out `main`
|
||||||
|
itself — this repo is worked from several git worktrees at once and `main`
|
||||||
|
is checked out in one of them, so `git checkout main` fails outright.
|
||||||
|
|
||||||
|
## 4. Do the work
|
||||||
|
|
||||||
|
Fix the issue that was reported and nothing else. Match the surrounding
|
||||||
|
code's style. Follow the constraints in `CLAUDE.md` rather than reasoning
|
||||||
|
from first principles — where it explains why something is shaped the way it
|
||||||
|
is, that shape is load-bearing and there is usually a test pinning it.
|
||||||
|
|
||||||
|
**Anything else you discover becomes a new issue, not a bigger diff.** File
|
||||||
|
it with the right `Area/`, `Kind/`, `Priority/` labels, describe the
|
||||||
|
symptom before the theory, and link it from your PR. Scope creep is the
|
||||||
|
failure mode this instruction exists to prevent.
|
||||||
|
|
||||||
|
If the work turns out to be materially larger than the issue implied, stop:
|
||||||
|
comment on the issue with what you found and what it would actually take,
|
||||||
|
remove `Status/In Progress`, push nothing, and end the run.
|
||||||
|
|
||||||
|
## 5. Verify — the right tier, not the cheapest one
|
||||||
|
|
||||||
|
Run `make generate` if you touched `.sql` or `.templ`, and `make bindings`
|
||||||
|
if you changed a bound Go signature. Then run what the change actually
|
||||||
|
demands:
|
||||||
|
|
||||||
|
- Go change → `make lint` and `make test` (both cover all three build
|
||||||
|
configurations).
|
||||||
|
- Frontend component or store → `make ui-test`.
|
||||||
|
- User-visible flow → `make e2e` against `make dev-headless`. **Check the
|
||||||
|
port first**: `ss -ltn | grep 34115`. If it is occupied, another worktree
|
||||||
|
is already running the app — do not start a second one and do not run
|
||||||
|
`make e2e`. Attaching to someone else's build produces a green result
|
||||||
|
about code that is not yours, which is worse than no result. Either
|
||||||
|
choose an issue that does not need this tier, or stop and say why.
|
||||||
|
- Anything cosmetic or layout-related → look at a screenshot. Several bugs
|
||||||
|
in this repo's history were invisible to every assertion and obvious in an
|
||||||
|
image.
|
||||||
|
|
||||||
|
A tier you skipped is a claim you did not check. If a tier fails for reasons
|
||||||
|
unrelated to your change, say so explicitly rather than quietly moving on.
|
||||||
|
|
||||||
|
## 6. Keep the documentation true
|
||||||
|
|
||||||
|
If you changed structure, behaviour, or a constraint, update `CLAUDE.md` in
|
||||||
|
the same commit. That file is this project's memory; a change that leaves it
|
||||||
|
describing the old shape is worse than no change. Append a short entry to
|
||||||
|
`.pi/journal.md` covering what you did, what you verified, and what you left
|
||||||
|
open.
|
||||||
|
|
||||||
|
## 7. Commit and open the PR
|
||||||
|
|
||||||
|
Conventional Commits, imperative subject, ≤72 chars, scope optional. The
|
||||||
|
body explains *why*. Push the branch — never push to `main`, never
|
||||||
|
force-push.
|
||||||
|
|
||||||
|
Open the PR:
|
||||||
|
|
||||||
|
```
|
||||||
|
curl -sS -X POST \
|
||||||
|
-H "Authorization: token $GITEA_TOKEN" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
https://git.ljones.me/api/v1/repos/yonlu/yellowjacket/pulls \
|
||||||
|
-d '{"head":"<branch>","base":"main","title":"<subject>","body":"<body>"}'
|
||||||
|
```
|
||||||
|
|
||||||
|
The body states: what the issue was, what you changed and why, **which
|
||||||
|
verification tiers you ran and their results**, anything you deliberately
|
||||||
|
did not do, and `Closes #<n>`.
|
||||||
|
|
||||||
|
Then wait for CI (`ci.yml`, jobs `check` and `e2e`) and report the result on
|
||||||
|
the PR. If it fails, read the log — `gitea_ci`'s `job_logs` 404s on this
|
||||||
|
Gitea build, so use
|
||||||
|
`GET /api/v1/repos/yonlu/yellowjacket/actions/runs/<run>/jobs` for per-step
|
||||||
|
status and `GET /api/v1/repos/yonlu/yellowjacket/actions/jobs/<id>/logs` for
|
||||||
|
the log — and fix it. Two consecutive failed CI runs on the same cause: stop,
|
||||||
|
comment what you know on the PR, and leave it for a human.
|
||||||
|
|
||||||
|
**Do not merge.** Comment on the issue linking the PR, leave
|
||||||
|
`Status/In Progress` on, and end the run.
|
||||||
|
|
||||||
|
## Finally
|
||||||
|
|
||||||
|
Report in three lines: which issue you took, what state it is in
|
||||||
|
(PR open / CI green / stopped and why), and any issues you filed.
|
||||||
@@ -130,7 +130,13 @@ reference, because you need them *before* the failure, not after.
|
|||||||
what you otherwise get is `Property 'scroll' does not exist on type
|
what you otherwise get is `Property 'scroll' does not exist on type
|
||||||
'CSSResult'` pointing at a line of prose, or every test in the suite
|
'CSSResult'` pointing at a line of prose, or every test in the suite
|
||||||
failing to import. It went in after the trap cost a fourth session in
|
failing to import. It went in after the trap cost a fourth session in
|
||||||
which its own warning had been read twice.
|
which its own warning had been read twice. **The same command carries
|
||||||
|
a second CSS check**: a nested rule whose selector starts with an
|
||||||
|
element name (`audio-player { … }` rather than `& audio-player { … }`)
|
||||||
|
is silently dropped by the device's Chrome 113 and by nothing else, so
|
||||||
|
every tier you can run renders it correctly. Run it after touching
|
||||||
|
`index.css` or any `css` literal; a rule directly inside a top-level
|
||||||
|
`@media` is not nested and is not flagged.
|
||||||
- **A failing CI job's log is reachable even when `gitea_ci job_logs`
|
- **A failing CI job's log is reachable even when `gitea_ci job_logs`
|
||||||
says it is not.** That endpoint 404s on this Gitea build. The REST
|
says it is not.** That endpoint 404s on this Gitea build. The REST
|
||||||
API answers, with the `GITEA_TOKEN` already in the environment:
|
API answers, with the `GITEA_TOKEN` already in the environment:
|
||||||
@@ -195,6 +201,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
|
||||||
|
|||||||
+1251
File diff suppressed because it is too large
Load Diff
@@ -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.
|
||||||
+14
-3
@@ -1,8 +1,19 @@
|
|||||||
# semantic-release configuration.
|
# semantic-release configuration.
|
||||||
#
|
#
|
||||||
# Runs on pushes to main from .gitea/workflows/release.yml: determine the
|
# Run by hand from .gitea/workflows/release.yml, which has no push
|
||||||
# version from the Conventional Commits since the last tag, write the
|
# trigger: determine the version from the Conventional Commits since the
|
||||||
# changelog, commit it, push the tag, and create the Gitea release.
|
# last tag, write the changelog, push the tag, and create the Gitea
|
||||||
|
# release. A release is a shipment rather than a merge, and the commits
|
||||||
|
# accumulate until someone says so -- this file needs to know nothing
|
||||||
|
# about that, because reading everything since the last tag is what it
|
||||||
|
# already did.
|
||||||
|
#
|
||||||
|
# `branches` is main and only main. A `prerelease: true` channel is the
|
||||||
|
# obvious next edit here and is the one to think twice about: all four
|
||||||
|
# publishing workflows trigger on `v*`, which matches `v0.4.0-beta.1`.
|
||||||
|
# They carry a prerelease guard now, so the failure is a clean skip
|
||||||
|
# rather than a beta in a public tap -- but they are four separate files
|
||||||
|
# and this is the line that would turn them on.
|
||||||
#
|
#
|
||||||
# **There is no `@semantic-release/github` plugin here and there must not
|
# **There is no `@semantic-release/github` plugin here and there must not
|
||||||
# be.** Gitea's API is `/api/v1` and is not GitHub's surface. The Gitea
|
# be.** Gitea's API is `/api/v1` and is not GitHub's surface. The Gitea
|
||||||
|
|||||||
+10
-5
@@ -5,15 +5,20 @@ The changelog is the releases page:
|
|||||||
<https://git.ljones.me/yonlu/yellowjacket/releases>
|
<https://git.ljones.me/yonlu/yellowjacket/releases>
|
||||||
|
|
||||||
Every release there is generated from the Conventional Commits it
|
Every release there is generated from the Conventional Commits it
|
||||||
contains, by `.gitea/workflows/release.yml` on merge to `main`. Each one
|
contains, by `.gitea/workflows/release.yml`. Each one carries its notes
|
||||||
carries its notes as its body, grouped by change type, with a link to the
|
as its body, grouped by change type, with a link to the commit behind
|
||||||
commit behind every line.
|
every line.
|
||||||
|
|
||||||
|
That workflow is **run by hand**, so a release holds everything merged
|
||||||
|
since the last one rather than one PR's worth. It used to fire on every
|
||||||
|
push to `main`, which made a version per merged PR (issue #115).
|
||||||
|
|
||||||
**This file is not generated and is not a copy of that.** `main` is a
|
**This file is not generated and is not a copy of that.** `main` is a
|
||||||
protected branch, so nothing pushes a changelog commit back to it — and a
|
protected branch, so nothing pushes a changelog commit back to it — and a
|
||||||
file that claimed to be a changelog while silently never updating would
|
file that claimed to be a changelog while silently never updating would
|
||||||
be worse than no file at all. `make release-dry` prints what the next
|
be worse than no file at all. `make release-dry` prints what a release
|
||||||
merge would release.
|
run would cut right now, and the workflow's own `dry_run` input answers
|
||||||
|
the same question from CI.
|
||||||
|
|
||||||
History before `v0.0.1` is in `git log`. The versions before it were cut
|
History before `v0.0.1` is in `git log`. The versions before it were cut
|
||||||
by hand and are not on the releases page; the entries this file used to
|
by hand and are not on the releases page; the entries this file used to
|
||||||
|
|||||||
@@ -172,12 +172,17 @@ ui-setup: ## Install the Vitest browser provider's own Chromium (once)
|
|||||||
bindings-check: ## Fail if the generated bindings are stale
|
bindings-check: ## Fail if the generated bindings are stale
|
||||||
@./scripts/bindings-check.sh
|
@./scripts/bindings-check.sh
|
||||||
|
|
||||||
|
# Two CSS traps that report a long way from their cause, or not at all.
|
||||||
# A backtick inside a comment in a css`` literal ends the literal, and
|
# A backtick inside a comment in a css`` literal ends the literal, and
|
||||||
# what you get back is a type error about CSSResult, or every test in
|
# what you get back is a type error about CSSResult, or every test in
|
||||||
# the suite failing to import. Four sessions, three plans. Instant.
|
# the suite failing to import. Four sessions, three plans. And a nested
|
||||||
|
# rule starting with an element name is dropped by the device's
|
||||||
|
# Chrome 113 in silence -- no tier here runs an engine that can see it.
|
||||||
|
# Instant.
|
||||||
.PHONY: css-check
|
.PHONY: css-check
|
||||||
css-check: ## Fail if a css`` literal was ended early by a backtick in a comment
|
css-check: ## Fail on a css`` literal ended early by a backtick, or a nested rule needing an &
|
||||||
@cd frontend && node scripts/check-css-literals.mjs
|
@cd frontend && node scripts/check-css-literals.mjs
|
||||||
|
@cd frontend && node scripts/check-css-nesting.mjs
|
||||||
|
|
||||||
# .pi/ and CLAUDE.md document commands, and a doc that documents a
|
# .pi/ and CLAUDE.md document commands, and a doc that documents a
|
||||||
# command wrongly is worse than no doc: an agent runs it confidently.
|
# command wrongly is worse than no doc: an agent runs it confidently.
|
||||||
@@ -192,15 +197,21 @@ skill-check: ## Fail if the agent docs name a missing make target, or AGENTS.md
|
|||||||
commit-check: ## Fail if a commit subject is not a Conventional Commit
|
commit-check: ## Fail if a commit subject is not a Conventional Commit
|
||||||
@./scripts/commit-check.sh $(if $(RANGE),--range $(RANGE))
|
@./scripts/commit-check.sh $(if $(RANGE),--range $(RANGE))
|
||||||
|
|
||||||
# What a merge to main would release, without releasing it. Reads the
|
# What running the release workflow now would ship, without shipping it.
|
||||||
# same .releaserc.yml CI does, so "why did that not cut a version" is
|
# Reads the same .releaserc.yml CI does, so "why did that not cut a
|
||||||
# answerable locally instead of by pushing and watching. Needs no
|
# version" is answerable locally instead of by pushing and watching.
|
||||||
# credentials: --dry-run neither tags nor publishes.
|
# Needs no credentials: --dry-run neither tags nor publishes.
|
||||||
|
#
|
||||||
|
# release.yml is dispatch-only, so this answers the question that
|
||||||
|
# actually gets asked now -- what has accumulated since the last tag --
|
||||||
|
# rather than what one merge would have done. The workflow's own
|
||||||
|
# `dry_run` input is the same answer from the runner, against whatever
|
||||||
|
# main points at rather than the working tree.
|
||||||
#
|
#
|
||||||
# The pins must stay identical to release.yml's, which is where the note
|
# The pins must stay identical to release.yml's, which is where the note
|
||||||
# on holding the conventionalcommits preset at 9 lives -- at 10 the
|
# on holding the conventionalcommits preset at 9 lives -- at 10 the
|
||||||
# release notes come out empty with everything green.
|
# release notes come out empty with everything green.
|
||||||
release-dry: ## Print the version a merge to main would release
|
release-dry: ## Print the version a release run would cut right now
|
||||||
@npx --yes \
|
@npx --yes \
|
||||||
-p semantic-release@25 \
|
-p semantic-release@25 \
|
||||||
-p @semantic-release/commit-analyzer@13 \
|
-p @semantic-release/commit-analyzer@13 \
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
@@ -135,3 +135,49 @@ SELECT
|
|||||||
) AS INTEGER) AS known
|
) AS INTEGER) AS known
|
||||||
FROM audio_files a
|
FROM audio_files a
|
||||||
WHERE a.album_id = sqlc.arg(album_id);
|
WHERE a.album_id = sqlc.arg(album_id);
|
||||||
|
|
||||||
|
-- name: GetAlbumsCompleteness :many
|
||||||
|
-- The same question as GetAlbumCompleteness, asked of a screenful of
|
||||||
|
-- albums at once.
|
||||||
|
--
|
||||||
|
-- A card grid cannot afford one query per card, and the answer it wants
|
||||||
|
-- is the one thing a badge cannot guess: an album held 9 tracks of 12
|
||||||
|
-- must show the count, never a bare tick. So this is one query for the
|
||||||
|
-- whole grid, asked only of the cards that have a local album id.
|
||||||
|
--
|
||||||
|
-- It is two grouping levels rather than the single-album form's
|
||||||
|
-- correlated subqueries, because a correlated subquery in the FROM
|
||||||
|
-- clause is not something SQLite will reliably do -- and because the
|
||||||
|
-- slice may only be spelled once, or sqlc expands it twice with
|
||||||
|
-- independently numbered placeholders.
|
||||||
|
--
|
||||||
|
-- The per-disc level is where the meaning is, and it is the same
|
||||||
|
-- meaning as the single-album query. `owned` counts DISTINCT track
|
||||||
|
-- numbers within a disc (this app detects duplicates, and counting two
|
||||||
|
-- files of track 3 twice would report a short album as complete), with
|
||||||
|
-- a file that declares no track number falling back to its own id
|
||||||
|
-- because three untagged files are three tracks and not one.
|
||||||
|
-- `expected` takes each disc's declared total and sums over discs,
|
||||||
|
-- since a total is declared per disc and a release total written on
|
||||||
|
-- every file of a two-disc album would double its expectation. A disc
|
||||||
|
-- whose files declared nothing contributes a NULL that SUM ignores,
|
||||||
|
-- and `known` is what says the album is therefore unanswerable.
|
||||||
|
WITH per_disc AS (
|
||||||
|
SELECT
|
||||||
|
album_id AS album_id,
|
||||||
|
COUNT(DISTINCT COALESCE(CAST(track_number AS TEXT), 'f' || id))
|
||||||
|
AS owned_on_disc,
|
||||||
|
MAX(total_tracks) AS disc_total,
|
||||||
|
SUM(CASE WHEN total_tracks IS NULL THEN 1 ELSE 0 END)
|
||||||
|
AS discs_without_a_total
|
||||||
|
FROM audio_files
|
||||||
|
WHERE album_id IN (sqlc.slice('album_ids'))
|
||||||
|
GROUP BY album_id, COALESCE(disc_number, 1)
|
||||||
|
)
|
||||||
|
SELECT
|
||||||
|
CAST(album_id AS INTEGER) AS album_id,
|
||||||
|
CAST(SUM(owned_on_disc) AS INTEGER) AS owned,
|
||||||
|
CAST(COALESCE(SUM(disc_total), 0) AS INTEGER) AS expected,
|
||||||
|
CAST(SUM(discs_without_a_total) = 0 AS INTEGER) AS known
|
||||||
|
FROM per_disc
|
||||||
|
GROUP BY album_id;
|
||||||
|
|||||||
@@ -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;
|
||||||
|
|||||||
@@ -8,6 +8,7 @@ package sqlcgen
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"database/sql"
|
"database/sql"
|
||||||
|
"strings"
|
||||||
)
|
)
|
||||||
|
|
||||||
const deleteAlbum = `-- name: DeleteAlbum :exec
|
const deleteAlbum = `-- name: DeleteAlbum :exec
|
||||||
@@ -234,6 +235,98 @@ func (q *Queries) GetAlbumsByArtistName(ctx context.Context, arg GetAlbumsByArti
|
|||||||
return items, nil
|
return items, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const getAlbumsCompleteness = `-- name: GetAlbumsCompleteness :many
|
||||||
|
WITH per_disc AS (
|
||||||
|
SELECT
|
||||||
|
album_id AS album_id,
|
||||||
|
COUNT(DISTINCT COALESCE(CAST(track_number AS TEXT), 'f' || id))
|
||||||
|
AS owned_on_disc,
|
||||||
|
MAX(total_tracks) AS disc_total,
|
||||||
|
SUM(CASE WHEN total_tracks IS NULL THEN 1 ELSE 0 END)
|
||||||
|
AS discs_without_a_total
|
||||||
|
FROM audio_files
|
||||||
|
WHERE album_id IN (/*SLICE:album_ids*/?)
|
||||||
|
GROUP BY album_id, COALESCE(disc_number, 1)
|
||||||
|
)
|
||||||
|
SELECT
|
||||||
|
CAST(album_id AS INTEGER) AS album_id,
|
||||||
|
CAST(SUM(owned_on_disc) AS INTEGER) AS owned,
|
||||||
|
CAST(COALESCE(SUM(disc_total), 0) AS INTEGER) AS expected,
|
||||||
|
CAST(SUM(discs_without_a_total) = 0 AS INTEGER) AS known
|
||||||
|
FROM per_disc
|
||||||
|
GROUP BY album_id
|
||||||
|
`
|
||||||
|
|
||||||
|
type GetAlbumsCompletenessRow struct {
|
||||||
|
AlbumID int64
|
||||||
|
Owned int64
|
||||||
|
Expected int64
|
||||||
|
Known int64
|
||||||
|
}
|
||||||
|
|
||||||
|
// The same question as GetAlbumCompleteness, asked of a screenful of
|
||||||
|
// albums at once.
|
||||||
|
//
|
||||||
|
// A card grid cannot afford one query per card, and the answer it wants
|
||||||
|
// is the one thing a badge cannot guess: an album held 9 tracks of 12
|
||||||
|
// must show the count, never a bare tick. So this is one query for the
|
||||||
|
// whole grid, asked only of the cards that have a local album id.
|
||||||
|
//
|
||||||
|
// It is two grouping levels rather than the single-album form's
|
||||||
|
// correlated subqueries, because a correlated subquery in the FROM
|
||||||
|
// clause is not something SQLite will reliably do -- and because the
|
||||||
|
// slice may only be spelled once, or sqlc expands it twice with
|
||||||
|
// independently numbered placeholders.
|
||||||
|
//
|
||||||
|
// The per-disc level is where the meaning is, and it is the same
|
||||||
|
// meaning as the single-album query. `owned` counts DISTINCT track
|
||||||
|
// numbers within a disc (this app detects duplicates, and counting two
|
||||||
|
// files of track 3 twice would report a short album as complete), with
|
||||||
|
// a file that declares no track number falling back to its own id
|
||||||
|
// because three untagged files are three tracks and not one.
|
||||||
|
// `expected` takes each disc's declared total and sums over discs,
|
||||||
|
// since a total is declared per disc and a release total written on
|
||||||
|
// every file of a two-disc album would double its expectation. A disc
|
||||||
|
// whose files declared nothing contributes a NULL that SUM ignores,
|
||||||
|
// and `known` is what says the album is therefore unanswerable.
|
||||||
|
func (q *Queries) GetAlbumsCompleteness(ctx context.Context, albumIds []sql.NullInt64) ([]GetAlbumsCompletenessRow, error) {
|
||||||
|
query := getAlbumsCompleteness
|
||||||
|
var queryParams []interface{}
|
||||||
|
if len(albumIds) > 0 {
|
||||||
|
for _, v := range albumIds {
|
||||||
|
queryParams = append(queryParams, v)
|
||||||
|
}
|
||||||
|
query = strings.Replace(query, "/*SLICE:album_ids*/?", strings.Repeat(",?", len(albumIds))[1:], 1)
|
||||||
|
} else {
|
||||||
|
query = strings.Replace(query, "/*SLICE:album_ids*/?", "NULL", 1)
|
||||||
|
}
|
||||||
|
rows, err := q.db.QueryContext(ctx, query, queryParams...)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
defer rows.Close()
|
||||||
|
var items []GetAlbumsCompletenessRow
|
||||||
|
for rows.Next() {
|
||||||
|
var i GetAlbumsCompletenessRow
|
||||||
|
if err := rows.Scan(
|
||||||
|
&i.AlbumID,
|
||||||
|
&i.Owned,
|
||||||
|
&i.Expected,
|
||||||
|
&i.Known,
|
||||||
|
); 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 getAlbumsWithPendingReleaseMBID = `-- name: GetAlbumsWithPendingReleaseMBID :many
|
const getAlbumsWithPendingReleaseMBID = `-- name: GetAlbumsWithPendingReleaseMBID :many
|
||||||
SELECT id, pending_release_mbid FROM albums
|
SELECT id, pending_release_mbid FROM albums
|
||||||
WHERE pending_release_mbid IS NOT NULL AND pending_release_mbid != ''
|
WHERE pending_release_mbid IS NOT NULL AND pending_release_mbid != ''
|
||||||
|
|||||||
@@ -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,
|
||||||
|
|||||||
@@ -2212,6 +2212,7 @@ func (e *Service) gatherTopCandidates(
|
|||||||
ArtistType: a.Type,
|
ArtistType: a.Type,
|
||||||
Country: a.Country,
|
Country: a.Country,
|
||||||
InLibrary: a.InLibrary,
|
InLibrary: a.InLibrary,
|
||||||
|
LocalID: a.LocalID,
|
||||||
},
|
},
|
||||||
category: "artist",
|
category: "artist",
|
||||||
qualityScore: quality,
|
qualityScore: quality,
|
||||||
@@ -2243,6 +2244,7 @@ func (e *Service) gatherTopCandidates(
|
|||||||
ArtistType: a.Type,
|
ArtistType: a.Type,
|
||||||
Country: a.Country,
|
Country: a.Country,
|
||||||
InLibrary: a.InLibrary,
|
InLibrary: a.InLibrary,
|
||||||
|
LocalID: a.LocalID,
|
||||||
},
|
},
|
||||||
category: "artist",
|
category: "artist",
|
||||||
qualityScore: quality,
|
qualityScore: quality,
|
||||||
@@ -2275,6 +2277,7 @@ func (e *Service) gatherTopCandidates(
|
|||||||
PrimaryType: rg.PrimaryType,
|
PrimaryType: rg.PrimaryType,
|
||||||
Year: year,
|
Year: year,
|
||||||
InLibrary: rg.InLibrary,
|
InLibrary: rg.InLibrary,
|
||||||
|
LocalID: rg.LocalID,
|
||||||
},
|
},
|
||||||
category: "release_group",
|
category: "release_group",
|
||||||
qualityScore: quality,
|
qualityScore: quality,
|
||||||
@@ -2320,6 +2323,7 @@ func (e *Service) gatherTopCandidates(
|
|||||||
PrimaryType: rg.PrimaryType,
|
PrimaryType: rg.PrimaryType,
|
||||||
Year: year,
|
Year: year,
|
||||||
InLibrary: rg.InLibrary,
|
InLibrary: rg.InLibrary,
|
||||||
|
LocalID: rg.LocalID,
|
||||||
},
|
},
|
||||||
category: "release_group",
|
category: "release_group",
|
||||||
qualityScore: quality,
|
qualityScore: quality,
|
||||||
@@ -2347,6 +2351,7 @@ func (e *Service) gatherTopCandidates(
|
|||||||
CAAReleaseMBID: r.CAAReleaseMBID,
|
CAAReleaseMBID: r.CAAReleaseMBID,
|
||||||
ReleaseName: r.ReleaseName,
|
ReleaseName: r.ReleaseName,
|
||||||
InLibrary: r.InLibrary,
|
InLibrary: r.InLibrary,
|
||||||
|
LocalID: r.LocalID,
|
||||||
},
|
},
|
||||||
category: "recording",
|
category: "recording",
|
||||||
qualityScore: quality,
|
qualityScore: quality,
|
||||||
@@ -2403,6 +2408,7 @@ func (e *Service) gatherTopCandidates(
|
|||||||
CAAReleaseMBID: r.CAAReleaseMBID,
|
CAAReleaseMBID: r.CAAReleaseMBID,
|
||||||
ReleaseName: r.ReleaseName,
|
ReleaseName: r.ReleaseName,
|
||||||
InLibrary: r.InLibrary,
|
InLibrary: r.InLibrary,
|
||||||
|
LocalID: r.LocalID,
|
||||||
},
|
},
|
||||||
category: "recording",
|
category: "recording",
|
||||||
qualityScore: quality,
|
qualityScore: quality,
|
||||||
@@ -2425,6 +2431,7 @@ func (e *Service) gatherTopCandidates(
|
|||||||
ArtistType: m.ArtistType,
|
ArtistType: m.ArtistType,
|
||||||
Country: m.Country,
|
Country: m.Country,
|
||||||
InLibrary: m.InLibrary || m.LocalArtistID > 0,
|
InLibrary: m.InLibrary || m.LocalArtistID > 0,
|
||||||
|
LocalID: m.LocalArtistID,
|
||||||
},
|
},
|
||||||
category: "artist",
|
category: "artist",
|
||||||
qualityScore: quality,
|
qualityScore: quality,
|
||||||
@@ -2445,6 +2452,7 @@ func (e *Service) gatherTopCandidates(
|
|||||||
PrimaryType: m.PrimaryType,
|
PrimaryType: m.PrimaryType,
|
||||||
Year: year,
|
Year: year,
|
||||||
InLibrary: m.InLibrary || m.LocalReleaseGroupID > 0,
|
InLibrary: m.InLibrary || m.LocalReleaseGroupID > 0,
|
||||||
|
LocalID: m.LocalReleaseGroupID,
|
||||||
},
|
},
|
||||||
category: "release_group",
|
category: "release_group",
|
||||||
qualityScore: quality,
|
qualityScore: quality,
|
||||||
@@ -2459,6 +2467,7 @@ func (e *Service) gatherTopCandidates(
|
|||||||
ArtistMBID: m.ArtistMBID,
|
ArtistMBID: m.ArtistMBID,
|
||||||
Length: m.Duration,
|
Length: m.Duration,
|
||||||
InLibrary: m.InLibrary || m.LocalRecordingID > 0,
|
InLibrary: m.InLibrary || m.LocalRecordingID > 0,
|
||||||
|
LocalID: m.LocalRecordingID,
|
||||||
},
|
},
|
||||||
category: "recording",
|
category: "recording",
|
||||||
qualityScore: quality,
|
qualityScore: quality,
|
||||||
|
|||||||
@@ -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),
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -41,7 +41,16 @@ type TopResult struct {
|
|||||||
ReleaseGroupMBID string `json:"releaseGroupMbid,omitempty"`
|
ReleaseGroupMBID string `json:"releaseGroupMbid,omitempty"`
|
||||||
ReleaseName string `json:"releaseName,omitempty"`
|
ReleaseName string `json:"releaseName,omitempty"`
|
||||||
// Library status — populated from index cross-reference columns.
|
// Library status — populated from index cross-reference columns.
|
||||||
InLibrary bool `json:"inLibrary"`
|
//
|
||||||
|
// LocalID is the one the cards read. It is the local row behind
|
||||||
|
// this entity — an album, a file, an artist — and it is set and
|
||||||
|
// cleared by a test against `audio_files`, so it means "there is
|
||||||
|
// something of mine here". InLibrary is written by the same pass
|
||||||
|
// but is a one-way ratchet the prune can only clear alongside a
|
||||||
|
// local id, so it is the weaker of the two and stays for scoring
|
||||||
|
// (`fwInLibrary`), which is where an approximate answer is fine.
|
||||||
|
InLibrary bool `json:"inLibrary"`
|
||||||
|
LocalID int64 `json:"localId,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// MBArtist is a Wails-friendly projection of a MusicBrainz artist.
|
// MBArtist is a Wails-friendly projection of a MusicBrainz artist.
|
||||||
|
|||||||
@@ -232,3 +232,112 @@ func TestGetAlbumCompleteness_EmptyAlbum(t *testing.T) {
|
|||||||
t.Errorf("empty album reported %+v, want zero and unknown", got)
|
t.Errorf("empty album reported %+v, want zero and unknown", got)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The batch and the single-album query are two spellings of one
|
||||||
|
// question, and the thing worth pinning is that they never disagree.
|
||||||
|
//
|
||||||
|
// They are genuinely different SQL — the single-album form is
|
||||||
|
// correlated subqueries over one album, the batch is two grouping
|
||||||
|
// levels over a slice — so the risk is not a typo but a drift in
|
||||||
|
// meaning: a disc's total counted once per file, a duplicate counted
|
||||||
|
// twice, a disc with no total silently covered by one that had one.
|
||||||
|
// Every shape the table above cares about is staged here at once,
|
||||||
|
// because a batch that is only ever asked about one album is not being
|
||||||
|
// asked the question that can go wrong.
|
||||||
|
func TestGetAlbumsCompletenessAgreesWithTheSingleAlbumQuery(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
lib, _ := setupTestLibrary(t)
|
||||||
|
|
||||||
|
shapes := map[int][]track{
|
||||||
|
1: disc(1, 100, 12, 12),
|
||||||
|
2: disc(1, 200, 9, 12),
|
||||||
|
3: disc(1, 300, 13, 12),
|
||||||
|
4: {{recordingID: 400, disc: 1, number: 1}},
|
||||||
|
5: append(disc(1, 500, 10, 10), disc(2, 600, 2, 5)...),
|
||||||
|
6: append(
|
||||||
|
disc(1, 700, 10, 10),
|
||||||
|
track{recordingID: 750, disc: 2, number: 1},
|
||||||
|
),
|
||||||
|
7: append(
|
||||||
|
disc(1, 800, 5, 6),
|
||||||
|
track{recordingID: 899, disc: 1, number: 3, total: 6},
|
||||||
|
),
|
||||||
|
}
|
||||||
|
|
||||||
|
ids := make([]int64, 0, len(shapes))
|
||||||
|
|
||||||
|
for albumID, tracks := range shapes {
|
||||||
|
stageAlbum(t, lib, albumID, tracks)
|
||||||
|
ids = append(ids, albumIDFor(t, lib, albumID))
|
||||||
|
}
|
||||||
|
|
||||||
|
batch, err := lib.GetAlbumsCompleteness(ids)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("GetAlbumsCompleteness: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(batch) != len(ids) {
|
||||||
|
t.Fatalf("batch answered for %d albums, want %d", len(batch), len(ids))
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, id := range ids {
|
||||||
|
one, err := lib.GetAlbumCompleteness(id)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("GetAlbumCompleteness(%d): %v", id, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if got := batch[id]; got != one {
|
||||||
|
t.Errorf("album %d: batch says %+v, single says %+v", id, got, one)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// An album with no files is absent from the batch, not zeroed.
|
||||||
|
//
|
||||||
|
// "I have none of this" and "I have no idea" are the third state Known
|
||||||
|
// exists to keep apart, and a caller reading a missing key gets nothing
|
||||||
|
// rather than a confident zero it would have to know to distrust.
|
||||||
|
func TestGetAlbumsCompletenessOmitsAnAlbumWithNoFiles(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
lib, _ := setupTestLibrary(t)
|
||||||
|
|
||||||
|
stageAlbum(t, lib, 1, disc(1, 100, 3, 3))
|
||||||
|
|
||||||
|
held := albumIDFor(t, lib, 1)
|
||||||
|
|
||||||
|
got, err := lib.GetAlbumsCompleteness([]int64{held, 4242})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("GetAlbumsCompleteness: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if _, ok := got[4242]; ok {
|
||||||
|
t.Errorf("an album with no files answered %+v, want absent", got[4242])
|
||||||
|
}
|
||||||
|
|
||||||
|
if !got[held].Complete {
|
||||||
|
t.Errorf("held album reported %+v, want complete", got[held])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A caller with nothing to ask about must not issue a query at all —
|
||||||
|
// sqlc's empty-slice branch rewrites the placeholder to NULL, which is
|
||||||
|
// a perfectly valid query returning nothing, so this is about the round
|
||||||
|
// trip rather than the answer.
|
||||||
|
func TestGetAlbumsCompletenessAsksNothingForAnEmptyList(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
lib, _ := setupTestLibrary(t)
|
||||||
|
|
||||||
|
for _, ids := range [][]int64{nil, {}, {0}, {-1, 0}} {
|
||||||
|
got, err := lib.GetAlbumsCompleteness(ids)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("GetAlbumsCompleteness(%v): %v", ids, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(got) != 0 {
|
||||||
|
t.Errorf("GetAlbumsCompleteness(%v) = %+v, want empty", ids, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -244,6 +244,65 @@ func (l *Library) GetAlbumCompleteness(albumID int64) (AlbumCompleteness, error)
|
|||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// GetAlbumsCompleteness answers the same question for a screenful of
|
||||||
|
// albums in one query, keyed by album id.
|
||||||
|
//
|
||||||
|
// A card grid asks this about every card that has a local album behind
|
||||||
|
// it, and one query per card is how a grid of fifty albums becomes
|
||||||
|
// fifty round trips. The answer matters there for the reason it
|
||||||
|
// matters on the album page: an album held 9 tracks of 12 has to show
|
||||||
|
// the count, and a bare tick saying "in your library" is the complaint
|
||||||
|
// this whole rule came from.
|
||||||
|
//
|
||||||
|
// An album with no row in the result is one with no files, and it is
|
||||||
|
// absent rather than zeroed — "I have none of this" and "I have no
|
||||||
|
// idea" are the same third state `Known` exists to keep apart, and a
|
||||||
|
// caller reading a missing key gets nothing rather than a confident 0.
|
||||||
|
func (l *Library) GetAlbumsCompleteness(
|
||||||
|
albumIDs []int64,
|
||||||
|
) (map[int64]AlbumCompleteness, error) {
|
||||||
|
out := make(map[int64]AlbumCompleteness, len(albumIDs))
|
||||||
|
|
||||||
|
if len(albumIDs) == 0 {
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
keys := make([]sql.NullInt64, 0, len(albumIDs))
|
||||||
|
|
||||||
|
for _, id := range albumIDs {
|
||||||
|
if id <= 0 {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
keys = append(keys, sql.NullInt64{Int64: id, Valid: true})
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(keys) == 0 {
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
rows, err := l.db.ReadQueries.GetAlbumsCompleteness(l.ctx, keys)
|
||||||
|
if err != nil {
|
||||||
|
l.logger.Error("could not get album completeness in batch",
|
||||||
|
"albums", len(keys), "error", err)
|
||||||
|
|
||||||
|
return nil, fmt.Errorf("could not get album completeness: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, row := range rows {
|
||||||
|
known := row.Known != 0 && row.Expected > 0
|
||||||
|
|
||||||
|
out[row.AlbumID] = AlbumCompleteness{
|
||||||
|
Owned: int(row.Owned),
|
||||||
|
Expected: int(row.Expected),
|
||||||
|
Known: known,
|
||||||
|
Complete: known && row.Owned >= row.Expected,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
// GetAlbumTracks returns one album's tracks in disc/track order.
|
// GetAlbumTracks returns one album's tracks in disc/track order.
|
||||||
func (l *Library) GetAlbumTracks(albumID, libraryID int64) ([]Track, error) {
|
func (l *Library) GetAlbumTracks(albumID, libraryID int64) ([]Track, error) {
|
||||||
rows, err := l.db.ReadQueries.GetTracksByAlbum(
|
rows, err := l.db.ReadQueries.GetTracksByAlbum(
|
||||||
|
|||||||
@@ -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")
|
||||||
|
}
|
||||||
|
}
|
||||||
+227
-41
@@ -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.
|
||||||
@@ -63,6 +71,19 @@ type Player struct {
|
|||||||
// not something the user chose.
|
// not something the user chose.
|
||||||
duckAmount float64
|
duckAmount float64
|
||||||
|
|
||||||
|
// systemVolume is what SystemOwnsVolume answers: the platform's own
|
||||||
|
// control is the only one, so ours neither acts nor persists. It is
|
||||||
|
// a field rather than the build constant read directly so that a
|
||||||
|
// test can exercise both sides on any machine. See systemvolume.go.
|
||||||
|
systemVolume bool
|
||||||
|
|
||||||
|
// storedVolume and storedMuted hold the persisted level as it was
|
||||||
|
// found at restore, for a platform whose volume we do not own: the
|
||||||
|
// maximum we then run at is not a level the user chose, so saveState
|
||||||
|
// writes back what it read rather than overwriting it.
|
||||||
|
storedVolume UserVolume
|
||||||
|
storedMuted bool
|
||||||
|
|
||||||
// trackLengthMs holds the authoritative track duration in
|
// trackLengthMs holds the authoritative track duration in
|
||||||
// milliseconds, sourced from the database (which uses the
|
// milliseconds, sourced from the database (which uses the
|
||||||
// custom header parser). The go-mp3 decoder's Len() can be
|
// custom header parser). The go-mp3 decoder's Len() can be
|
||||||
@@ -148,6 +169,8 @@ func NewPlayer(logger *slog.Logger, db *database.DB) *Player {
|
|||||||
logger: logger,
|
logger: logger,
|
||||||
db: db,
|
db: db,
|
||||||
state: Stopped,
|
state: Stopped,
|
||||||
|
systemVolume: platformOwnsVolume,
|
||||||
|
storedVolume: DefaultUserVol,
|
||||||
baseStreamer: generators.Silence(-1),
|
baseStreamer: generators.Silence(-1),
|
||||||
format: beep.Format{
|
format: beep.Format{
|
||||||
SampleRate: speakerSampleRate,
|
SampleRate: speakerSampleRate,
|
||||||
@@ -180,11 +203,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 +454,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 +517,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 +578,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 +591,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 +601,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 +674,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 {
|
||||||
@@ -791,6 +890,10 @@ func (p *Player) SetVolume(desiredVolume UserVolume) {
|
|||||||
p.mu.Lock()
|
p.mu.Lock()
|
||||||
defer p.mu.Unlock()
|
defer p.mu.Unlock()
|
||||||
|
|
||||||
|
if p.systemVolume {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
p.setVolumeLocked(desiredVolume)
|
p.setVolumeLocked(desiredVolume)
|
||||||
p.emitVolumeChanged()
|
p.emitVolumeChanged()
|
||||||
p.saveState()
|
p.saveState()
|
||||||
@@ -839,6 +942,10 @@ func (p *Player) ChangeVolume(deltaVolume int) error {
|
|||||||
p.mu.Lock()
|
p.mu.Lock()
|
||||||
defer p.mu.Unlock()
|
defer p.mu.Unlock()
|
||||||
|
|
||||||
|
if p.systemVolume {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
p.setVolumeLocked(p.getUserVolume() + UserVolume(deltaVolume))
|
p.setVolumeLocked(p.getUserVolume() + UserVolume(deltaVolume))
|
||||||
p.emitVolumeChanged()
|
p.emitVolumeChanged()
|
||||||
p.saveState()
|
p.saveState()
|
||||||
@@ -869,6 +976,14 @@ func (p *Player) MuteToggle() error {
|
|||||||
return errNoAudioFileLoaded
|
return errNoAudioFileLoaded
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Mute is a level of zero by another name, so it goes with the rest
|
||||||
|
// of the volume where the system owns it -- and it would be the one
|
||||||
|
// state on such a platform the user could not get out of, since with
|
||||||
|
// no control rendered there is nothing left to un-mute with.
|
||||||
|
if p.systemVolume {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
speaker.Lock()
|
speaker.Lock()
|
||||||
p.volume.Silent = !p.volume.Silent
|
p.volume.Silent = !p.volume.Silent
|
||||||
speaker.Unlock()
|
speaker.Unlock()
|
||||||
@@ -906,6 +1021,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 +1041,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 +1098,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 +1193,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 +1210,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 +1302,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 +1322,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()
|
||||||
@@ -1266,7 +1434,15 @@ func (p *Player) saveState() {
|
|||||||
volume := int64(DefaultUserVol)
|
volume := int64(DefaultUserVol)
|
||||||
muted := false
|
muted := false
|
||||||
|
|
||||||
if p.volume != nil {
|
switch {
|
||||||
|
case p.systemVolume:
|
||||||
|
// The maximum this platform runs at is not a level anybody
|
||||||
|
// chose, so it is not one to remember. Writing back what
|
||||||
|
// restore found keeps the row a description of the user's
|
||||||
|
// setting without needing a second query that omits the column.
|
||||||
|
volume = int64(p.storedVolume)
|
||||||
|
muted = p.storedMuted
|
||||||
|
case p.volume != nil:
|
||||||
volume = int64(p.getUserVolume())
|
volume = int64(p.getUserVolume())
|
||||||
muted = p.volume.Silent
|
muted = p.volume.Silent
|
||||||
}
|
}
|
||||||
@@ -1350,11 +1526,20 @@ func (p *Player) restoreStateLocked() {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
vol := clampVolume(UserVolume(state.Volume))
|
if p.systemVolume {
|
||||||
p.setVolumeLocked(vol)
|
// Remembered, not applied: the device's keys are the volume
|
||||||
|
// control here, so the player runs wide open and hands the
|
||||||
|
// stored level back untouched at the next save.
|
||||||
|
p.storedVolume = clampVolume(UserVolume(state.Volume))
|
||||||
|
p.storedMuted = state.Muted
|
||||||
|
p.setVolumeLocked(MaxUserVol)
|
||||||
|
} else {
|
||||||
|
vol := clampVolume(UserVolume(state.Volume))
|
||||||
|
p.setVolumeLocked(vol)
|
||||||
|
|
||||||
if state.Muted {
|
if state.Muted {
|
||||||
p.volume.Silent = true
|
p.volume.Silent = true
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Restore last track if the file still exists.
|
// Restore last track if the file still exists.
|
||||||
@@ -1394,8 +1579,9 @@ func (p *Player) restoreStateLocked() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
p.logger.Info("Player state restored",
|
p.logger.Info("Player state restored",
|
||||||
"volume", vol,
|
"volume", p.getUserVolume(),
|
||||||
"muted", state.Muted,
|
"muted", p.volume.Silent,
|
||||||
|
"systemVolume", p.systemVolume,
|
||||||
"trackPath", state.LastTrackPath,
|
"trackPath", state.LastTrackPath,
|
||||||
"positionSeconds", state.LastPositionSeconds,
|
"positionSeconds", state.LastPositionSeconds,
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -0,0 +1,42 @@
|
|||||||
|
package player
|
||||||
|
|
||||||
|
// Who owns the volume, and what follows when it is not us.
|
||||||
|
//
|
||||||
|
// On Android the hardware keys *are* the volume control and the
|
||||||
|
// framework mixes our stream against the device level, so a second
|
||||||
|
// control inside the app is a slider that moves something the user
|
||||||
|
// already moved (#64). Where that is true the player's own level sits
|
||||||
|
// at maximum, nothing changes it, and nothing persists it.
|
||||||
|
//
|
||||||
|
// **The predicate is named after the capability, not the platform.**
|
||||||
|
// The frontend asks "is there a volume for me to control", which is a
|
||||||
|
// question about this build; asking "is this a phone" instead would
|
||||||
|
// key the answer to a viewport, and an Android tablet at 600px or more
|
||||||
|
// would then draw the bottom bar's slider over a level pinned at
|
||||||
|
// maximum -- a control that cannot act, which is the thing
|
||||||
|
// `library-status-indicator` already settled is worse than none.
|
||||||
|
//
|
||||||
|
// **Only `platformOwnsVolume` is behind a build tag**, in two files
|
||||||
|
// that declare nothing else. A tagged file is compiled by nothing
|
||||||
|
// `make lint` or `make test` runs and is untestable off a phone, which
|
||||||
|
// is the reasoning `mediacontrols/androidpayload.go` states for
|
||||||
|
// keeping its contract out of one -- so everything decidable here is
|
||||||
|
// decided against `Player.systemVolume`, a field a test sets either
|
||||||
|
// way, and the tag decides only what that field starts as.
|
||||||
|
//
|
||||||
|
// The one thing this must not disturb is ducking. `SetDuck` applies
|
||||||
|
// its attenuation by re-applying the *user's* level through
|
||||||
|
// `setVolumeLocked`, so pinning that level to maximum leaves the
|
||||||
|
// offset arithmetic exactly as it was: an OS asking us to get out of
|
||||||
|
// the way of a navigation prompt is not the user setting a volume, and
|
||||||
|
// it is the only thing that may move the output on such a platform.
|
||||||
|
|
||||||
|
// SystemOwnsVolume reports whether the platform's own control is the
|
||||||
|
// only volume control there is, so this app neither offers one nor
|
||||||
|
// remembers a level.
|
||||||
|
//
|
||||||
|
// It is bound: the frontend renders no `<volume-control>` when it is
|
||||||
|
// true, at any width.
|
||||||
|
func (p *Player) SystemOwnsVolume() bool {
|
||||||
|
return p.systemVolume
|
||||||
|
}
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
//go:build android
|
||||||
|
|
||||||
|
package player
|
||||||
|
|
||||||
|
// platformOwnsVolume is true on Android: volume is the device's, set
|
||||||
|
// with the hardware keys, and `mediacontrols`' Android handler
|
||||||
|
// implements no volume callback for the same reason.
|
||||||
|
//
|
||||||
|
// See systemvolume.go for why this constant is the whole of what a
|
||||||
|
// build tag decides here.
|
||||||
|
const platformOwnsVolume = true
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
//go:build !android
|
||||||
|
|
||||||
|
package player
|
||||||
|
|
||||||
|
// platformOwnsVolume is false everywhere but Android: a desktop mixer
|
||||||
|
// is per-application, so our level is the one the user reaches for.
|
||||||
|
//
|
||||||
|
// See systemvolume.go for why this constant is the whole of what a
|
||||||
|
// build tag decides here.
|
||||||
|
const platformOwnsVolume = false
|
||||||
@@ -0,0 +1,215 @@
|
|||||||
|
package player
|
||||||
|
|
||||||
|
import (
|
||||||
|
"log/slog"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/gopxl/beep/v2/effects"
|
||||||
|
|
||||||
|
"yellowjacket/backend/database"
|
||||||
|
)
|
||||||
|
|
||||||
|
// pinnedPlayer is a player on a platform whose volume belongs to the
|
||||||
|
// device. The field is set rather than the build constant read,
|
||||||
|
// because the constant is true on exactly one platform and no tier
|
||||||
|
// here runs on it -- see systemvolume.go.
|
||||||
|
func pinnedPlayer(t *testing.T, db *database.DB) *Player {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
p := NewPlayer(slog.Default(), db)
|
||||||
|
p.systemVolume = true
|
||||||
|
p.volume = &effects.Volume{Base: 2}
|
||||||
|
p.setVolumeLocked(MaxUserVol)
|
||||||
|
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestSystemVolumeRefusesEveryWayToChangeTheLevel is the first half of
|
||||||
|
// #64: where the device owns the volume, ours sits at maximum and none
|
||||||
|
// of the three routes to a level moves it. Mute is in that list
|
||||||
|
// because it is a level of zero by another name, and because with no
|
||||||
|
// control rendered it is the one state on such a platform there would
|
||||||
|
// be nothing to get out of.
|
||||||
|
func TestSystemVolumeRefusesEveryWayToChangeTheLevel(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
p := pinnedPlayer(t, nil)
|
||||||
|
|
||||||
|
if !p.SystemOwnsVolume() {
|
||||||
|
t.Fatal("SystemOwnsVolume() = false on a pinned player")
|
||||||
|
}
|
||||||
|
|
||||||
|
if got := p.getUserVolume(); got != MaxUserVol {
|
||||||
|
t.Errorf("starting volume = %d, want %d", got, MaxUserVol)
|
||||||
|
}
|
||||||
|
|
||||||
|
p.SetVolume(20)
|
||||||
|
|
||||||
|
if got := p.getUserVolume(); got != MaxUserVol {
|
||||||
|
t.Errorf("volume after SetVolume(20) = %d, want %d", got, MaxUserVol)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := p.ChangeVolume(-30); err != nil {
|
||||||
|
t.Fatalf("ChangeVolume: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if got := p.getUserVolume(); got != MaxUserVol {
|
||||||
|
t.Errorf("volume after ChangeVolume(-30) = %d, want %d", got, MaxUserVol)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := p.MuteToggle(); err != nil {
|
||||||
|
t.Fatalf("MuteToggle: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if p.volume.Silent {
|
||||||
|
t.Error("MuteToggle silenced a player whose volume the system owns")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestAnUnpinnedPlayerStillChangesItsVolume is the other side of the
|
||||||
|
// same switch. Without it the test above passes on a player that
|
||||||
|
// refuses everything, which is what a mis-wired field would produce.
|
||||||
|
func TestAnUnpinnedPlayerStillChangesItsVolume(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
p := NewPlayer(slog.Default(), nil)
|
||||||
|
p.volume = &effects.Volume{Base: 2}
|
||||||
|
p.setVolumeLocked(MaxUserVol)
|
||||||
|
|
||||||
|
if p.SystemOwnsVolume() {
|
||||||
|
t.Fatal("SystemOwnsVolume() = true off Android")
|
||||||
|
}
|
||||||
|
|
||||||
|
p.SetVolume(20)
|
||||||
|
|
||||||
|
if got := p.getUserVolume(); got != 20 {
|
||||||
|
t.Errorf("volume after SetVolume(20) = %d, want 20", got)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := p.MuteToggle(); err != nil {
|
||||||
|
t.Fatalf("MuteToggle: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if !p.volume.Silent {
|
||||||
|
t.Error("MuteToggle did not silence an ordinary player")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestSystemVolumeStillDucks is the issue's second Finding, made a
|
||||||
|
// test: pinning the user's level must leave the OS's attenuation
|
||||||
|
// working, because a duck is not a volume the user chose and is the
|
||||||
|
// only thing that may move the output on such a platform.
|
||||||
|
func TestSystemVolumeStillDucks(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
p := pinnedPlayer(t, nil)
|
||||||
|
open := p.volume.Volume
|
||||||
|
|
||||||
|
p.SetDuck(true)
|
||||||
|
|
||||||
|
if p.volume.Volume >= open {
|
||||||
|
t.Errorf(
|
||||||
|
"ducked output = %v, want less than %v", p.volume.Volume, open,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
if got := p.getUserVolume(); got != MaxUserVol {
|
||||||
|
t.Errorf("user volume while ducked = %d, want %d", got, MaxUserVol)
|
||||||
|
}
|
||||||
|
|
||||||
|
// A refused SetVolume must not disturb the offset either: it
|
||||||
|
// returns before setVolumeLocked, which is what re-applies it.
|
||||||
|
ducked := p.volume.Volume
|
||||||
|
|
||||||
|
p.SetVolume(10)
|
||||||
|
|
||||||
|
if p.volume.Volume != ducked {
|
||||||
|
t.Errorf(
|
||||||
|
"output after a refused SetVolume = %v, want %v",
|
||||||
|
p.volume.Volume, ducked,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
p.SetDuck(false)
|
||||||
|
|
||||||
|
if p.volume.Volume != open {
|
||||||
|
t.Errorf("output after unduck = %v, want %v", p.volume.Volume, open)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestSystemVolumeWritesBackTheLevelItFound is the rest of the
|
||||||
|
// Direction: "make sure nothing writes a persisted volume from that
|
||||||
|
// platform". The maximum the player runs at is synthetic, so saving
|
||||||
|
// must not record it over whatever the row already said.
|
||||||
|
func TestSystemVolumeWritesBackTheLevelItFound(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
db := database.NewTestDB(t)
|
||||||
|
|
||||||
|
// A level set by some earlier, unpinned session.
|
||||||
|
writer := NewPlayer(slog.Default(), db)
|
||||||
|
writer.volume = &effects.Volume{Base: 2}
|
||||||
|
writer.setVolumeLocked(30)
|
||||||
|
writer.SaveState()
|
||||||
|
|
||||||
|
p := pinnedPlayer(t, db)
|
||||||
|
p.RestoreState()
|
||||||
|
|
||||||
|
if got := p.getUserVolume(); got != MaxUserVol {
|
||||||
|
t.Errorf("restored volume = %d, want %d (the level is pinned)", got, MaxUserVol)
|
||||||
|
}
|
||||||
|
|
||||||
|
if p.volume.Silent {
|
||||||
|
t.Error("restore muted a player whose volume the system owns")
|
||||||
|
}
|
||||||
|
|
||||||
|
p.SaveState()
|
||||||
|
|
||||||
|
state, err := db.Queries.GetPlayerState(db.Ctx)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("GetPlayerState: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if state.Volume != 30 {
|
||||||
|
t.Errorf("persisted volume = %d, want 30 (untouched)", state.Volume)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestPlatformVolumeOwnershipIsDeclaredOncePerPlatform sweeps the
|
||||||
|
// source, because the pair of tagged files is the one thing here no
|
||||||
|
// tier compiles both halves of: `make lint` and `make test` build the
|
||||||
|
// `!android` side only, so a deleted or edited android file fails
|
||||||
|
// nothing until somebody has a phone in their hand.
|
||||||
|
func TestPlatformVolumeOwnershipIsDeclaredOncePerPlatform(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
want := map[string]string{
|
||||||
|
"systemvolume_other.go": "const platformOwnsVolume = false",
|
||||||
|
"systemvolume_android.go": "const platformOwnsVolume = true",
|
||||||
|
}
|
||||||
|
|
||||||
|
tags := map[string]string{
|
||||||
|
"systemvolume_other.go": "//go:build !android",
|
||||||
|
"systemvolume_android.go": "//go:build android",
|
||||||
|
}
|
||||||
|
|
||||||
|
for name, decl := range want {
|
||||||
|
src, err := os.ReadFile(filepath.Join(".", name))
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("%s: %v", name, err)
|
||||||
|
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if !strings.Contains(string(src), decl) {
|
||||||
|
t.Errorf("%s does not declare %q", name, decl)
|
||||||
|
}
|
||||||
|
|
||||||
|
if !strings.Contains(string(src), tags[name]) {
|
||||||
|
t.Errorf("%s does not carry %q", name, tags[name])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -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) {
|
||||||
|
|||||||
+16
-6
@@ -7,12 +7,22 @@ which is what lets Obtainium poll a plain URL with no token. It also
|
|||||||
attaches the same file to the Gitea release, which is what a person
|
attaches the same file to the Gitea release, which is what a person
|
||||||
looking at the release page downloads.
|
looking at the release page downloads.
|
||||||
|
|
||||||
**Tags are not pushed by hand any more.** `.gitea/workflows/release.yml`
|
**Tags are not pushed by hand any more, but releasing is a decision.**
|
||||||
reads the Conventional Commits on every merge to `main`, decides the
|
`.gitea/workflows/release.yml` reads the Conventional Commits since the
|
||||||
version, and pushes the tag this workflow is keyed on — so releasing the
|
last tag, decides the version, and pushes the tag this workflow is keyed
|
||||||
APK means merging a `fix:` or `feat:` commit, not running `git tag`. The
|
on — so releasing the APK means **running that workflow**, not running
|
||||||
`workflow_dispatch` path below remains, for rebuilding a tag that already
|
`git tag`. It has no push trigger: merging a `fix:` or `feat:` used to
|
||||||
exists.
|
be enough and produced a version per merged PR (issue #115). Run it with
|
||||||
|
`dry_run` first to see what the accumulated commits would ship. The
|
||||||
|
`workflow_dispatch` path below is a different thing and remains, for
|
||||||
|
rebuilding a tag that already exists.
|
||||||
|
|
||||||
|
**A prerelease tag is skipped here**, cleanly. This workflow triggers on
|
||||||
|
`v*`, which matches `v0.4.0-beta.1`, and it is the one where that would
|
||||||
|
hurt most: the APK goes to the credential-free generic registry that
|
||||||
|
Obtainium polls, and the `versionCode` maths below splits on dots — it
|
||||||
|
would read `1` out of `0-beta` and produce a wrong number rather than a
|
||||||
|
failed build.
|
||||||
|
|
||||||
## The 1.x installs cannot be upgraded to 0.0.x
|
## The 1.x installs cannot be upgraded to 0.0.x
|
||||||
|
|
||||||
|
|||||||
@@ -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();
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,204 @@
|
|||||||
|
import { test, expect } from '../support/fixtures.js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* #62. On a phone, background work is shown in the notification band
|
||||||
|
* and the header indicator stands down.
|
||||||
|
*
|
||||||
|
* The report was that the indicator's popover "is obscured by other UI,
|
||||||
|
* so it cannot be read while jobs run". Worth saying plainly: **that
|
||||||
|
* symptom did not reproduce in this tier.** Measured at the device's
|
||||||
|
* own 424x439 viewport, the popover was neither clipped nor covered —
|
||||||
|
* `elementFromPoint` at its centre returned the indicator at every
|
||||||
|
* width tried. So this is not a fix for a stacking bug, and a spec
|
||||||
|
* asserting one would be a spec asserting something that was never
|
||||||
|
* true here.
|
||||||
|
*
|
||||||
|
* What is true regardless, and is what these assert:
|
||||||
|
*
|
||||||
|
* - a popover is a **disclosure**, and it is anchored to a bar 3.25em
|
||||||
|
* tall on a screen 439px tall. Background work is the one thing a
|
||||||
|
* phone should not make you open something to see.
|
||||||
|
* - #57 deletes that bar and is *blocked on this issue*, because the
|
||||||
|
* indicator needs somewhere else to live first. Somewhere else is
|
||||||
|
* the band, and the test that matters for #57 is that the bar no
|
||||||
|
* longer holds the indicator at all.
|
||||||
|
*
|
||||||
|
* This is the media-query tier by necessity: a query inside a shadow
|
||||||
|
* root is answered by the viewport, and `notification-host` decides
|
||||||
|
* whether the panel *exists* from `matchMedia`. The component tier
|
||||||
|
* cannot set either.
|
||||||
|
*/
|
||||||
|
|
||||||
|
type Page = import('@playwright/test').Page;
|
||||||
|
|
||||||
|
const JOBS = [
|
||||||
|
{
|
||||||
|
id: 'phone:scan',
|
||||||
|
kind: 'library-scan',
|
||||||
|
state: 'running',
|
||||||
|
title: 'Scanning Music',
|
||||||
|
current: 40,
|
||||||
|
total: 100,
|
||||||
|
caps: { pausable: true, cancellable: true },
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: 'phone:idx',
|
||||||
|
kind: 'index-build',
|
||||||
|
state: 'running',
|
||||||
|
title: 'Building the search index',
|
||||||
|
current: 2,
|
||||||
|
total: 9,
|
||||||
|
caps: { pausable: true, cancellable: true },
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
/** The panel the band renders. Playwright's CSS engine pierces open
|
||||||
|
* shadow roots, which is what keeps this one line. */
|
||||||
|
const bandPanel = (page: Page) => page.locator('job-band').locator('job-panel');
|
||||||
|
|
||||||
|
const PHONE = { width: 424, height: 439 };
|
||||||
|
const DESKTOP = { width: 1100, height: 800 };
|
||||||
|
|
||||||
|
test.describe('background jobs on a phone', () => {
|
||||||
|
test('are shown in the band, without opening anything', async ({
|
||||||
|
app,
|
||||||
|
testctl,
|
||||||
|
}) => {
|
||||||
|
await app.setViewportSize(PHONE);
|
||||||
|
await testctl.emit('JobsChanged', JOBS);
|
||||||
|
|
||||||
|
await expect(bandPanel(app)).toBeVisible();
|
||||||
|
|
||||||
|
// Both jobs, drawn by real `job-row`s -- asking the rows what they
|
||||||
|
// hold rather than reading the panel's text, which would pass
|
||||||
|
// whether or not a row rendered. Playwright's CSS engine pierces
|
||||||
|
// open shadow roots, which is what makes this one line;
|
||||||
|
// `querySelectorAll` does not, and stops at `job-panel`.
|
||||||
|
await expect(bandPanel(app).locator('job-row')).toHaveCount(2);
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
bandPanel(app).locator('job-row').first(),
|
||||||
|
).toContainText('Scanning Music');
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The #57 assertion. Not "the indicator is invisible" — that could be
|
||||||
|
* true because the bar overflowed — but that the shell's own rule
|
||||||
|
* puts it away at this width.
|
||||||
|
*/
|
||||||
|
test('leave the top bar, which is what #57 is waiting for', async ({
|
||||||
|
app,
|
||||||
|
testctl,
|
||||||
|
}) => {
|
||||||
|
await app.setViewportSize(PHONE);
|
||||||
|
await testctl.emit('JobsChanged', JOBS);
|
||||||
|
await expect(bandPanel(app)).toBeVisible();
|
||||||
|
|
||||||
|
await expect(app.locator('job-indicator')).toBeHidden();
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The property the first attempt at this got wrong, so it is the one
|
||||||
|
* worth pinning: the band is **in the layout**, not over it.
|
||||||
|
*
|
||||||
|
* A fixed band reads fine in a screenshot and is unusable -- at
|
||||||
|
* 424x439 a compact panel is ~200px of a 439px screen and it covers
|
||||||
|
* what is under it. Four specs failed on that version, two
|
||||||
|
* phone-shell journeys and the header's action menu, because the
|
||||||
|
* panel was intercepting the taps. So: nothing of the app is
|
||||||
|
* underneath it, and the main panel starts below it.
|
||||||
|
*/
|
||||||
|
test('push the content down rather than covering it', async ({
|
||||||
|
app,
|
||||||
|
testctl,
|
||||||
|
}) => {
|
||||||
|
await app.setViewportSize(PHONE);
|
||||||
|
|
||||||
|
const before = await app
|
||||||
|
.getByTestId('main-content')
|
||||||
|
.evaluate((el) => el.getBoundingClientRect().top);
|
||||||
|
|
||||||
|
await testctl.emit('JobsChanged', JOBS);
|
||||||
|
await expect(bandPanel(app)).toBeVisible();
|
||||||
|
|
||||||
|
const after = await app.evaluate(() => {
|
||||||
|
const band = document.querySelector('job-band') as HTMLElement;
|
||||||
|
const main = document.querySelector(
|
||||||
|
'[data-testid="main-content"]',
|
||||||
|
) as HTMLElement;
|
||||||
|
const b = band.getBoundingClientRect();
|
||||||
|
const m = main.getBoundingClientRect();
|
||||||
|
|
||||||
|
// What the browser reports at the band's own centre. If this is
|
||||||
|
// anything but the band, the band is sitting on top of it.
|
||||||
|
const hit = document.elementFromPoint(
|
||||||
|
Math.round(b.x + b.width / 2),
|
||||||
|
Math.round(b.y + b.height / 2),
|
||||||
|
);
|
||||||
|
|
||||||
|
return {
|
||||||
|
mainTop: m.top,
|
||||||
|
bandBottom: b.bottom,
|
||||||
|
withinViewport: b.bottom <= window.innerHeight + 0.5,
|
||||||
|
hit: hit?.tagName.toLowerCase() ?? null,
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
expect({
|
||||||
|
pushed: after.mainTop > before,
|
||||||
|
mainClearsBand: after.mainTop >= after.bandBottom - 0.5,
|
||||||
|
withinViewport: after.withinViewport,
|
||||||
|
hit: after.hit,
|
||||||
|
}).toEqual({
|
||||||
|
pushed: true,
|
||||||
|
mainClearsBand: true,
|
||||||
|
withinViewport: true,
|
||||||
|
hit: 'job-band',
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A running job repaints several times a second. The stack it sits
|
||||||
|
* beside is `role="status" aria-live="polite"`, and a progress bar
|
||||||
|
* inside a live region is a screen reader reading a number out over
|
||||||
|
* and over — so the two are siblings in the band rather than one
|
||||||
|
* list, and this is what says so.
|
||||||
|
*/
|
||||||
|
test('are not inside the live region they sit beside', async ({
|
||||||
|
app,
|
||||||
|
testctl,
|
||||||
|
}) => {
|
||||||
|
await app.setViewportSize(PHONE);
|
||||||
|
await testctl.emit('JobsChanged', JOBS);
|
||||||
|
await expect(bandPanel(app)).toBeVisible();
|
||||||
|
|
||||||
|
const insideLiveRegion = await app.evaluate(() => {
|
||||||
|
const band = document.querySelector('job-band');
|
||||||
|
|
||||||
|
// Neither the band itself nor anything it is nested in may be a
|
||||||
|
// live region -- `closest` answers both at once.
|
||||||
|
return !!band?.closest('[aria-live]') || band?.hasAttribute('aria-live');
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(insideLiveRegion).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* `bottom-nav` rendering its duplicate `<app-sidebar>` unconditionally
|
||||||
|
* broke 30 specs with "resolved to 2 elements" on a viewport where it
|
||||||
|
* was not even visible. Settings already holds four `job-panel`s, so
|
||||||
|
* a fifth that answers for *every* kind is the same trap — which is
|
||||||
|
* why the band decides from `matchMedia` whether the element exists
|
||||||
|
* rather than hiding it with CSS.
|
||||||
|
*/
|
||||||
|
test('do not leave a second panel behind on a desktop', async ({
|
||||||
|
app,
|
||||||
|
testctl,
|
||||||
|
}) => {
|
||||||
|
await app.setViewportSize(DESKTOP);
|
||||||
|
await testctl.emit('JobsChanged', JOBS);
|
||||||
|
|
||||||
|
await expect(app.locator('job-indicator')).toBeVisible();
|
||||||
|
await expect(bandPanel(app)).toHaveCount(0);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -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,
|
||||||
|
|||||||
@@ -0,0 +1,209 @@
|
|||||||
|
import { test, expect } from '../support/fixtures.js';
|
||||||
|
import type { Page } from '@playwright/test';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The album page on a phone (#66).
|
||||||
|
*
|
||||||
|
* Two faults, and neither was visible to `layout-overflow.spec.ts`:
|
||||||
|
* that spec asserts the *shell* needs no sideways scrolling, and the
|
||||||
|
* shell was correct throughout — `body.scrollWidth === clientWidth`
|
||||||
|
* while `explore-album-details` itself measured 443 inside a 424px box
|
||||||
|
* and clipped two of the album's three primary actions with its own
|
||||||
|
* `overflow: hidden`. So the measurement here is **per control against
|
||||||
|
* the component's box**, which is the same shape `top-bar-fit.spec.ts`
|
||||||
|
* needed for the same reason.
|
||||||
|
*
|
||||||
|
* The other half is the scroll: the page was a fixed header over a
|
||||||
|
* scrolling tracklist, so at the reference device's 424x439 the header
|
||||||
|
* owned 253 of the panel's 318px and the list scrolled in the 64 that
|
||||||
|
* were left. It is one scroll container below 600px, which is a
|
||||||
|
* property of the *host* rather than of `.content`.
|
||||||
|
*
|
||||||
|
* The engine is the caveat this tier cannot close: the reference device
|
||||||
|
* renders in Chrome 113 and this is Chromium/WebKit. A flex direction
|
||||||
|
* and a scroll container are nowhere near that engine's documented gaps
|
||||||
|
* (relaxed nesting, the Popover API, `light-dark()`), but "it renders
|
||||||
|
* at that size in Chromium" is not evidence about the phone.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/** The phone this was measured on, in CSS pixels. */
|
||||||
|
const DEVICE = { width: 424, height: 439 };
|
||||||
|
|
||||||
|
const details = (page: Page) => page.locator('explore-album-details');
|
||||||
|
|
||||||
|
/** The page's own boxes, read from inside its shadow root. */
|
||||||
|
const geometry = (page: Page) =>
|
||||||
|
page.evaluate(() => {
|
||||||
|
const host = document.querySelector('explore-album-details');
|
||||||
|
const sr = host?.shadowRoot;
|
||||||
|
|
||||||
|
if (!host || !sr) return null;
|
||||||
|
|
||||||
|
const box = (sel: string) => {
|
||||||
|
const el = sr.querySelector(sel);
|
||||||
|
|
||||||
|
if (!el) return null;
|
||||||
|
|
||||||
|
const r = el.getBoundingClientRect();
|
||||||
|
|
||||||
|
return { width: Math.round(r.width), right: Math.round(r.right) };
|
||||||
|
};
|
||||||
|
|
||||||
|
const content = sr.querySelector('.content');
|
||||||
|
|
||||||
|
return {
|
||||||
|
hostWidth: host.clientWidth,
|
||||||
|
hostScrollWidth: host.scrollWidth,
|
||||||
|
// The host is the scroller below 600px, so the page is taller
|
||||||
|
// than its box rather than the tracklist being a window inside it.
|
||||||
|
hostScrolls: host.scrollHeight > host.clientHeight,
|
||||||
|
contentScrolls: content
|
||||||
|
? content.scrollHeight > content.clientHeight
|
||||||
|
: null,
|
||||||
|
header: box('.album-header'),
|
||||||
|
play: box('[data-testid="album-play"]'),
|
||||||
|
shuffle: box('[data-testid="album-shuffle"]'),
|
||||||
|
queue: box('[data-testid="album-queue"]'),
|
||||||
|
title: (() => {
|
||||||
|
const el = sr.querySelector('.album-title-text');
|
||||||
|
|
||||||
|
return el ? el.scrollWidth <= el.clientWidth + 1 : null;
|
||||||
|
})(),
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
test.describe('the album page on a phone', () => {
|
||||||
|
test.beforeEach(async ({ app }) => {
|
||||||
|
await app.setViewportSize(DEVICE);
|
||||||
|
await openFirstAlbum(app);
|
||||||
|
});
|
||||||
|
|
||||||
|
test.afterEach(async ({ app }) => {
|
||||||
|
await app.setViewportSize({ width: 1440, height: 900 });
|
||||||
|
await app.getByTestId('nav-tracks').click();
|
||||||
|
});
|
||||||
|
|
||||||
|
test('keeps every action inside its own box', async ({ app }) => {
|
||||||
|
const geo = await geometry(app);
|
||||||
|
|
||||||
|
expect(geo).not.toBeNull();
|
||||||
|
// "Shuffle album" ended at x=443 in a 424px component and could not
|
||||||
|
// be reached by any gesture; "Add to queue" at 440.
|
||||||
|
for (const action of ['play', 'shuffle', 'queue'] as const) {
|
||||||
|
expect(
|
||||||
|
geo?.[action],
|
||||||
|
`${action} is rendered`,
|
||||||
|
).not.toBeNull();
|
||||||
|
expect(
|
||||||
|
geo?.[action]?.right ?? 0,
|
||||||
|
`${action} ends inside the page`,
|
||||||
|
).toBeLessThanOrEqual(geo?.hostWidth ?? 0);
|
||||||
|
}
|
||||||
|
|
||||||
|
expect(geo?.hostScrollWidth).toBe(geo?.hostWidth);
|
||||||
|
expect(geo?.header?.width).toBe(geo?.hostWidth);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('gives the title the row rather than one glyph of it', async ({
|
||||||
|
app,
|
||||||
|
}) => {
|
||||||
|
// `.album-info` was squeezed to 112px beside the art, so an album
|
||||||
|
// called *Glass Harbour* drew as `G…`. It carries `min-width: 0`
|
||||||
|
// and was shrinking as asked — the row had to stack.
|
||||||
|
expect(await geometry(app).then((g) => g?.title)).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('scrolls as one page, with the header scrolling away', async ({
|
||||||
|
app,
|
||||||
|
}) => {
|
||||||
|
const before = await geometry(app);
|
||||||
|
|
||||||
|
expect(before?.hostScrolls).toBe(true);
|
||||||
|
expect(before?.contentScrolls).toBe(false);
|
||||||
|
|
||||||
|
const headerTop = () =>
|
||||||
|
app.evaluate(
|
||||||
|
() =>
|
||||||
|
document
|
||||||
|
.querySelector('explore-album-details')
|
||||||
|
?.shadowRoot?.querySelector('.album-header')
|
||||||
|
?.getBoundingClientRect().top ?? 0,
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(await headerTop()).toBeGreaterThanOrEqual(0);
|
||||||
|
|
||||||
|
// A wheel gesture, not `scrollTop`: `overflow: hidden` still permits
|
||||||
|
// programmatic scrolling, so a probe that assigns it passes on the
|
||||||
|
// build this exists to fail.
|
||||||
|
await details(app).hover();
|
||||||
|
await app.mouse.wheel(0, 250);
|
||||||
|
|
||||||
|
await expect.poll(headerTop).toBeLessThan(-100);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('is the desktop arrangement again above the breakpoint', async ({
|
||||||
|
app,
|
||||||
|
}) => {
|
||||||
|
await app.setViewportSize({ width: 1024, height: 800 });
|
||||||
|
|
||||||
|
// The same element, re-laid-out: one component with two
|
||||||
|
// arrangements, not a phone-only copy.
|
||||||
|
await expect
|
||||||
|
.poll(async () => (await geometry(app))?.hostScrolls)
|
||||||
|
.toBe(false);
|
||||||
|
|
||||||
|
const arrangement = await app.evaluate(() => {
|
||||||
|
const sr = document.querySelector('explore-album-details')?.shadowRoot;
|
||||||
|
const header = sr?.querySelector('.album-header');
|
||||||
|
const content = sr?.querySelector('.content');
|
||||||
|
|
||||||
|
return {
|
||||||
|
direction: header ? getComputedStyle(header).flexDirection : null,
|
||||||
|
contentOverflow: content ? getComputedStyle(content).overflowY : null,
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(arrangement.direction).toBe('row');
|
||||||
|
expect(arrangement.contentOverflow).toBe('auto');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
/** Albums → the second card, which navigates to the album page. */
|
||||||
|
async function openFirstAlbum(app: Page): Promise<void> {
|
||||||
|
// Below 600px the sidebar is gone; the tab bar is the navigation.
|
||||||
|
await app.getByTestId('tab-albums').click();
|
||||||
|
await expect(app.getByTestId('main-content')).toHaveAttribute(
|
||||||
|
'data-active-view',
|
||||||
|
'albums',
|
||||||
|
);
|
||||||
|
|
||||||
|
await expect.poll(() => cardCount(app)).toBeGreaterThan(1);
|
||||||
|
|
||||||
|
// Dispatched rather than clicked: the card lives in a virtualizer
|
||||||
|
// inside a shadow root, and Enter expands the dropdown instead.
|
||||||
|
await app.evaluate(() => {
|
||||||
|
document
|
||||||
|
.querySelector('cover-grid')
|
||||||
|
?.shadowRoot?.querySelectorAll('.album-card')[1]
|
||||||
|
?.dispatchEvent(
|
||||||
|
new MouseEvent('click', { bubbles: true, composed: true }),
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
await expect(app.getByTestId('main-content')).toHaveAttribute(
|
||||||
|
'data-active-view',
|
||||||
|
'explore-album-details',
|
||||||
|
);
|
||||||
|
await expect(
|
||||||
|
details(app).locator('[data-testid="album-play"]'),
|
||||||
|
).toBeVisible();
|
||||||
|
}
|
||||||
|
|
||||||
|
async function cardCount(app: Page): Promise<number> {
|
||||||
|
return app.evaluate(
|
||||||
|
() =>
|
||||||
|
document
|
||||||
|
.querySelector('cover-grid')
|
||||||
|
?.shadowRoot?.querySelectorAll('.album-card').length ?? 0,
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,136 @@
|
|||||||
|
import {
|
||||||
|
test,
|
||||||
|
expect,
|
||||||
|
callBinding,
|
||||||
|
resetEvents,
|
||||||
|
waitForEvent,
|
||||||
|
LONG_TRACK,
|
||||||
|
NO_QUEUE_SOURCE,
|
||||||
|
} from '../support/fixtures.js';
|
||||||
|
import type { Page } from '@playwright/test';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The phone's progress line (#58).
|
||||||
|
*
|
||||||
|
* The component tier already pins what the line *says* — that it
|
||||||
|
* renders the backend's reported position and never a count of its own.
|
||||||
|
* What only a real shell can answer is **where it is**: the issue asks
|
||||||
|
* for a line on the border between the mini player and the tab bar, and
|
||||||
|
* "on the border" is two adjacencies in a grid that no component-level
|
||||||
|
* render has around it.
|
||||||
|
*
|
||||||
|
* It also asserts the line is not there on a desktop, which is the
|
||||||
|
* other half of the same fact: above 600px there is no tab bar for it
|
||||||
|
* to sit on the border of, and the bar carries a real seek bar.
|
||||||
|
*/
|
||||||
|
type Rect = { x: number; y: number; width: number; height: number };
|
||||||
|
|
||||||
|
/** The reference device's real viewport. */
|
||||||
|
const DEVICE = { width: 424, height: 439 };
|
||||||
|
const DESKTOP = { width: 1280, height: 800 };
|
||||||
|
|
||||||
|
async function rectOf(app: Page, selector: string): Promise<Rect | null> {
|
||||||
|
return app.evaluate((sel) => {
|
||||||
|
const el = document.querySelector(sel);
|
||||||
|
|
||||||
|
if (!el) return null;
|
||||||
|
|
||||||
|
const r = el.getBoundingClientRect();
|
||||||
|
|
||||||
|
return { x: r.x, y: r.y, width: r.width, height: r.height };
|
||||||
|
}, selector);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Put the 90-second fixture on and wait for the first position report.
|
||||||
|
*
|
||||||
|
* The long track rather than any track: every other fixture is 2-6
|
||||||
|
* seconds, which is shorter than the time this spec takes to measure
|
||||||
|
* three rectangles.
|
||||||
|
*/
|
||||||
|
async function play(app: Page): Promise<void> {
|
||||||
|
const tracks = await callBinding<{ FilePath: string; TrackName: string }[]>(
|
||||||
|
app,
|
||||||
|
'library.Library.GetTracks',
|
||||||
|
[0],
|
||||||
|
);
|
||||||
|
|
||||||
|
// `TrackName`, not `Title`: that is what the library model calls it.
|
||||||
|
const long = tracks.find((t) => t.TrackName === LONG_TRACK);
|
||||||
|
|
||||||
|
expect(long, `no fixture track named ${LONG_TRACK}`).toBeTruthy();
|
||||||
|
|
||||||
|
await callBinding(app, 'queue.Queue.Clear');
|
||||||
|
await resetEvents(app);
|
||||||
|
await callBinding(app, 'queue.Queue.SetQueue', [
|
||||||
|
[long!.FilePath],
|
||||||
|
0,
|
||||||
|
false,
|
||||||
|
NO_QUEUE_SOURCE,
|
||||||
|
]);
|
||||||
|
await waitForEvent(app, 'QueueChanged');
|
||||||
|
await callBinding(app, 'queue.Queue.Play');
|
||||||
|
await waitForEvent(app, 'PlaybackPositionChanged', { timeoutMs: 15_000 });
|
||||||
|
}
|
||||||
|
|
||||||
|
test.describe('the progress line sits on the border between the bars', () => {
|
||||||
|
test.beforeEach(async ({ app }) => {
|
||||||
|
await app.setViewportSize(DEVICE);
|
||||||
|
await play(app);
|
||||||
|
});
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Every test here starts a LONG_TRACK and the suite is workers: 1,
|
||||||
|
* fullyParallel: false against one long-lived app — so without this
|
||||||
|
* the four phone-* specs that follow alphabetically inherit a playing
|
||||||
|
* queue. phone-transport.spec.ts records where that lesson came from:
|
||||||
|
* the fault first showed up as a flake in a spec about something else.
|
||||||
|
*/
|
||||||
|
test.afterEach(async ({ app }) => {
|
||||||
|
await callBinding(app, 'queue.Queue.Clear').catch(() => {
|
||||||
|
/* already empty */
|
||||||
|
});
|
||||||
|
await app.setViewportSize(DESKTOP);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('spans the width, between the mini player and the tab bar', async ({
|
||||||
|
app,
|
||||||
|
}) => {
|
||||||
|
const line = await rectOf(app, 'player-progress-line');
|
||||||
|
const bar = await rectOf(app, '.bottom-bar');
|
||||||
|
const nav = await rectOf(app, 'bottom-nav');
|
||||||
|
|
||||||
|
expect(line, 'no progress line on the phone').not.toBeNull();
|
||||||
|
expect(bar).not.toBeNull();
|
||||||
|
expect(nav).not.toBeNull();
|
||||||
|
|
||||||
|
// A border, not a band: 2px, the full width, and touching both.
|
||||||
|
expect(line!.height).toBeCloseTo(2, 0);
|
||||||
|
expect(line!.width).toBeCloseTo(bar!.width, 0);
|
||||||
|
expect(line!.y).toBeCloseTo(bar!.y + bar!.height, 0);
|
||||||
|
expect(nav!.y).toBeCloseTo(line!.y + line!.height, 0);
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* It is 2px on the top edge of the tab bar, which is exactly where a
|
||||||
|
* thumb aiming at a tab lands. A line that sometimes seeks is worse
|
||||||
|
* than one that never does, so it must take no part in hit testing
|
||||||
|
* at all.
|
||||||
|
*/
|
||||||
|
test('takes no taps', async ({ app }) => {
|
||||||
|
const line = await rectOf(app, 'player-progress-line');
|
||||||
|
|
||||||
|
const hit = await app.evaluate(
|
||||||
|
({ x, y }) => document.elementFromPoint(x, y)?.tagName ?? '',
|
||||||
|
{ x: line!.x + line!.width / 2, y: line!.y + 1 },
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(hit).not.toBe('PLAYER-PROGRESS-LINE');
|
||||||
|
});
|
||||||
|
|
||||||
|
test('is not there on a desktop', async ({ app }) => {
|
||||||
|
await app.setViewportSize(DESKTOP);
|
||||||
|
|
||||||
|
await expect(app.locator('player-progress-line')).toBeHidden();
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,322 @@
|
|||||||
|
import { test, expect } from '../support/fixtures.js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* #57. Below 600px the top bar is not in the layout, and search is a
|
||||||
|
* button that opens a modal on the pages where searching means
|
||||||
|
* anything.
|
||||||
|
*
|
||||||
|
* **This is the tier that can answer it, with one honest exception.**
|
||||||
|
* The shell's breakpoints are media queries, which the component tier
|
||||||
|
* cannot set — so whether the bar is a grid row, and whether a header
|
||||||
|
* grows a search button, is a question for a real viewport. What this
|
||||||
|
* tier *cannot* answer is the reason the surface is a `wa-dialog`:
|
||||||
|
* #60 read out of the Web Awesome source that `wa-popup` falls back to
|
||||||
|
* `position: fixed` where there is no Popover API (Chrome 113, the
|
||||||
|
* reference device) and that `.main-panel`'s `contain: paint` clips a
|
||||||
|
* fixed descendant. Chromium and WebKit here both have the Popover API,
|
||||||
|
* so a popup is top-layered and correct, and **an assertion that the
|
||||||
|
* modal is not clipped would pass on the broken build.** The mechanism
|
||||||
|
* is asserted in `frontend/test/components/search-dialog.test.ts`
|
||||||
|
* instead, where "is there a native <dialog>" is a question a browser
|
||||||
|
* can answer without lying.
|
||||||
|
*
|
||||||
|
* **And it is measured per element.** `layout-overflow.spec.ts` asks
|
||||||
|
* whether the *shell* needs sideways scrolling and was green throughout
|
||||||
|
* the defect it is named for; the win this issue is for is vertical and
|
||||||
|
* belongs to one element, so it is that element's box that is read.
|
||||||
|
*/
|
||||||
|
type Page = import('@playwright/test').Page;
|
||||||
|
|
||||||
|
/** The reference device's own viewport, and a common small phone. */
|
||||||
|
const DEVICE = { width: 424, height: 439 };
|
||||||
|
const PHONE = { width: 390, height: 780 };
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Where the top bar is, and how much of the screen it costs.
|
||||||
|
*
|
||||||
|
* `contentTop` is measured against the *jobs band* rather than against
|
||||||
|
* the window, because that band is a real grid row whenever work is in
|
||||||
|
* flight (#62) and the app under these specs is long-lived — a job
|
||||||
|
* staged by another file is still in the store. Measuring against zero
|
||||||
|
* makes this assertion say "and no background job is running", which is
|
||||||
|
* not what it is for and is not something it can arrange.
|
||||||
|
*/
|
||||||
|
const barBox = (page: Page) =>
|
||||||
|
page.evaluate(() => {
|
||||||
|
const bar = document.querySelector<HTMLElement>('header.top-bar')!;
|
||||||
|
const main = document.querySelector<HTMLElement>('.main-panel')!;
|
||||||
|
const band = document.querySelector<HTMLElement>('job-band');
|
||||||
|
const cs = getComputedStyle(bar);
|
||||||
|
|
||||||
|
return {
|
||||||
|
position: cs.position,
|
||||||
|
height: Math.round(bar.getBoundingClientRect().height),
|
||||||
|
/** Where the content starts, and where the row above it ends. */
|
||||||
|
contentTop: Math.round(main.getBoundingClientRect().top),
|
||||||
|
aboveBottom: Math.round(band?.getBoundingClientRect().bottom ?? 0),
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
test.describe('the phone has no top bar', () => {
|
||||||
|
test.beforeEach(async ({ app }) => {
|
||||||
|
await app.setViewportSize(DEVICE);
|
||||||
|
});
|
||||||
|
|
||||||
|
test.afterEach(async ({ app }) => {
|
||||||
|
await app.setViewportSize({ width: 1440, height: 900 });
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The vertical win, measured rather than asserted by the absence of
|
||||||
|
* an element: `display: none` on the header would satisfy "the bar is
|
||||||
|
* hidden" while leaving a 3.25em grid row exactly where it was.
|
||||||
|
*/
|
||||||
|
test('gives the row back to the content', async ({ app }) => {
|
||||||
|
const box = await barBox(app);
|
||||||
|
|
||||||
|
// Out of flow, so it takes no row — and 1px rather than 0, because
|
||||||
|
// it still carries the document's h1.
|
||||||
|
expect(box.position).toBe('absolute');
|
||||||
|
expect(box.height).toBeLessThanOrEqual(1);
|
||||||
|
|
||||||
|
// The content starts where the row above it ends, and there is no
|
||||||
|
// row above it but the jobs band. On `main` at the time of writing
|
||||||
|
// the content started 52px down from that point.
|
||||||
|
expect(box.contentTop).toBe(box.aboveBottom);
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The wordmark yields its width and not its existence, which is the
|
||||||
|
* rule `top-bar-fit.ts` already lives by one band up: with the bar
|
||||||
|
* gone, `display: none` would take this document from one top-level
|
||||||
|
* heading to none on every page whose own header has no h1 —
|
||||||
|
* Settings has no `page-header` at all.
|
||||||
|
*/
|
||||||
|
test('still has a top-level heading', async ({ app }) => {
|
||||||
|
await expect(
|
||||||
|
app.getByRole('heading', { name: 'YellowJacket', level: 1 }),
|
||||||
|
).toHaveCount(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* And its four controls are gone from the tab order, not merely from
|
||||||
|
* sight. A visually-hidden container is still focusable, and tabbing
|
||||||
|
* into a search box nobody can see is worse than not having one.
|
||||||
|
*/
|
||||||
|
test('leaves nothing in the bar to tab into', async ({ app }) => {
|
||||||
|
for (const tag of [
|
||||||
|
'nav-history',
|
||||||
|
'library-filter',
|
||||||
|
'search-bar',
|
||||||
|
'job-indicator',
|
||||||
|
]) {
|
||||||
|
await expect(app.locator(`header.top-bar ${tag}`)).toBeHidden();
|
||||||
|
}
|
||||||
|
|
||||||
|
const focusable = await app.evaluate(
|
||||||
|
() =>
|
||||||
|
document
|
||||||
|
.querySelector('header.top-bar')!
|
||||||
|
.querySelectorAll('input, select, button, a[href]').length,
|
||||||
|
);
|
||||||
|
|
||||||
|
// Nothing in the bar is *rendered*, so nothing in it can be
|
||||||
|
// focused; the controls are display:none, which takes their own
|
||||||
|
// shadow content with them.
|
||||||
|
expect(focusable).toBe(0);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
test.describe('search on a phone', () => {
|
||||||
|
test.beforeEach(async ({ app }) => {
|
||||||
|
await app.setViewportSize(PHONE);
|
||||||
|
});
|
||||||
|
|
||||||
|
test.afterEach(async ({ app }) => {
|
||||||
|
await app.setViewportSize({ width: 1440, height: 900 });
|
||||||
|
});
|
||||||
|
|
||||||
|
test('is a button in the view that can be searched', async ({ app }) => {
|
||||||
|
await app.getByTestId('tab-tracks').click();
|
||||||
|
await expect(app.getByTestId('main-content')).toHaveAttribute(
|
||||||
|
'data-active-view',
|
||||||
|
'tracks',
|
||||||
|
);
|
||||||
|
|
||||||
|
// Scoped to the view: every cached primary view holds a
|
||||||
|
// `page-header`, and an unscoped testid is `bottom-nav`'s
|
||||||
|
// "resolved to 2 elements" trap again.
|
||||||
|
const trigger = app.locator('track-list page-header search-trigger button');
|
||||||
|
|
||||||
|
await expect(trigger).toBeVisible();
|
||||||
|
await expect(trigger).toHaveAttribute('aria-label', 'Search tracks');
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The whole journey, which is the thing the issue asks for: a button,
|
||||||
|
* a modal, and the results on the page behind it saying what they are
|
||||||
|
* showing.
|
||||||
|
*/
|
||||||
|
test('opens a modal, filters the page, and says so', async ({ app }) => {
|
||||||
|
await app.getByTestId('tab-tracks').click();
|
||||||
|
await expect(app.getByTestId('main-content')).toHaveAttribute(
|
||||||
|
'data-active-view',
|
||||||
|
'tracks',
|
||||||
|
);
|
||||||
|
|
||||||
|
await app.locator('track-list page-header search-trigger button').click();
|
||||||
|
|
||||||
|
const dialog = app.getByTestId('search-dialog');
|
||||||
|
|
||||||
|
// Attached, not visible: `wa-dialog`'s host is `display: contents`,
|
||||||
|
// so the element carrying the testid always reports hidden — what
|
||||||
|
// is visible is the native `<dialog>` inside it. That awkwardness
|
||||||
|
// is written down in CLAUDE.md and is why the assertion that this
|
||||||
|
// is really up is the role query below.
|
||||||
|
await expect(dialog).toBeAttached();
|
||||||
|
|
||||||
|
// Named, which `getByRole` can answer and the a11y snapshot cannot
|
||||||
|
// — the snapshot never prints a dialog's name, named or not. This
|
||||||
|
// is also the assertion that the dialog is genuinely showing.
|
||||||
|
await expect(
|
||||||
|
app.getByRole('dialog', { name: 'Search tracks' }),
|
||||||
|
).toBeVisible();
|
||||||
|
|
||||||
|
// Scoped: the header's own box is still in the document, hidden.
|
||||||
|
// This is the one moment there are two `search-input`s.
|
||||||
|
await dialog.getByTestId('search-input').fill('aurora');
|
||||||
|
|
||||||
|
// Enter hands the screen back, because the results are the page.
|
||||||
|
await app.keyboard.press('Enter');
|
||||||
|
await expect(dialog).not.toBeAttached();
|
||||||
|
|
||||||
|
// Polled: the box debounces by 150ms, so reading the page once
|
||||||
|
// straight after closing the dialog can capture the state before
|
||||||
|
// the term ever reached the store.
|
||||||
|
await expect
|
||||||
|
.poll(() =>
|
||||||
|
app.evaluate(
|
||||||
|
() =>
|
||||||
|
document
|
||||||
|
.querySelector('[data-testid="main-content"] track-list')
|
||||||
|
?.shadowRoot?.querySelector('page-header')
|
||||||
|
?.shadowRoot?.querySelector('[data-testid="page-search-scope"]')
|
||||||
|
?.textContent?.trim() ?? '',
|
||||||
|
),
|
||||||
|
)
|
||||||
|
.toMatch(/matching.*aurora/);
|
||||||
|
|
||||||
|
// And the button says the search is on, in its name rather than
|
||||||
|
// only in its colour.
|
||||||
|
await expect(
|
||||||
|
app.locator('track-list page-header search-trigger button'),
|
||||||
|
).toHaveAttribute('aria-label', /aurora/);
|
||||||
|
|
||||||
|
// Leave the app as the next spec expects to find it.
|
||||||
|
await app.locator('track-list page-header search-trigger button').click();
|
||||||
|
await app.getByTestId('search-dialog').getByTestId('search-input').fill('');
|
||||||
|
await app.keyboard.press('Escape');
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Two of the seven searchable views have no `page-header` — they are
|
||||||
|
* detail views that filter on the term and say so in their own
|
||||||
|
* headers. A trigger placed only in `page-header` would leave them
|
||||||
|
* with a search they can show and no way to set it, which is #24's
|
||||||
|
* sentence broken in the band it was written for.
|
||||||
|
*/
|
||||||
|
test('reaches the playlist detail view too', async ({ app }) => {
|
||||||
|
await app.getByTestId('tab-playlists').click();
|
||||||
|
await expect(app.getByTestId('main-content')).toHaveAttribute(
|
||||||
|
'data-active-view',
|
||||||
|
'playlists',
|
||||||
|
);
|
||||||
|
|
||||||
|
// `.playlist-item`, which is what the list renders. Asserted to
|
||||||
|
// exist rather than skipped on: the seed has a playlist, and a
|
||||||
|
// spec that quietly skips when its selector stops matching is a
|
||||||
|
// spec that reports success for a renamed class.
|
||||||
|
const first = app.locator('playlist-view .playlist-item').first();
|
||||||
|
|
||||||
|
await expect(first).toBeVisible();
|
||||||
|
await first.dblclick();
|
||||||
|
|
||||||
|
await expect(app.getByTestId('main-content')).toHaveAttribute(
|
||||||
|
'data-active-view',
|
||||||
|
'playlist-details',
|
||||||
|
);
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
app.locator('playlist-details search-trigger button'),
|
||||||
|
).toBeVisible();
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A button that cannot do anything is worse than none — the rule
|
||||||
|
* `library-status-indicator` was rewritten on. Home has nothing of
|
||||||
|
* its own to search and is not in the store's map.
|
||||||
|
*/
|
||||||
|
test('offers no button where there is nothing to search', async ({ app }) => {
|
||||||
|
await app.getByTestId('tab-home').click();
|
||||||
|
await expect(app.getByTestId('main-content')).toHaveAttribute(
|
||||||
|
'data-active-view',
|
||||||
|
'home',
|
||||||
|
);
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
app.locator('home-view page-header search-trigger button'),
|
||||||
|
).toHaveCount(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('offers no button on a desktop, where the header has a box', async ({
|
||||||
|
app,
|
||||||
|
}) => {
|
||||||
|
await app.setViewportSize({ width: 1440, height: 900 });
|
||||||
|
await app.getByTestId('nav-tracks').click();
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
app.locator('track-list page-header search-trigger button'),
|
||||||
|
).toHaveCount(0);
|
||||||
|
await expect(app.locator('header.top-bar search-bar')).toBeVisible();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* #148, which #57 inherits: `library-filter` is the only control in the
|
||||||
|
* app that calls `setSelectedLibrary`, and the bar it lived in is gone
|
||||||
|
* on a phone. #143 refused to hide it as a fit step for exactly this
|
||||||
|
* reason, so dropping it here would have been the same trade.
|
||||||
|
*/
|
||||||
|
test.describe('the library filter has a home that is not the bar', () => {
|
||||||
|
test.afterEach(async ({ app }) => {
|
||||||
|
await app.setViewportSize({ width: 1440, height: 900 });
|
||||||
|
});
|
||||||
|
|
||||||
|
test('is in Settings, and is reachable from a phone', async ({ app }) => {
|
||||||
|
await app.setViewportSize(PHONE);
|
||||||
|
|
||||||
|
await app.getByTestId('tab-more').click();
|
||||||
|
await app.getByTestId('nav-drawer').getByTestId('nav-settings').click();
|
||||||
|
|
||||||
|
await expect(app.getByTestId('main-content')).toHaveAttribute(
|
||||||
|
'data-active-view',
|
||||||
|
'settings',
|
||||||
|
);
|
||||||
|
|
||||||
|
const filter = app.getByTestId('settings-library-filter');
|
||||||
|
|
||||||
|
await expect(filter).toBeVisible();
|
||||||
|
await expect(filter.locator('select')).toBeVisible();
|
||||||
|
});
|
||||||
|
|
||||||
|
test('and it is the same control at every width', async ({ app }) => {
|
||||||
|
// Not a phone-only copy: "where do I change which library I am
|
||||||
|
// browsing" having two answers by viewport is the fault, not the
|
||||||
|
// fix.
|
||||||
|
await app.setViewportSize({ width: 1440, height: 900 });
|
||||||
|
await app.getByTestId('nav-settings').click();
|
||||||
|
|
||||||
|
await expect(app.getByTestId('settings-library-filter')).toBeVisible();
|
||||||
|
await expect(app.locator('header.top-bar library-filter')).toBeVisible();
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -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).
|
||||||
@@ -130,6 +130,25 @@ test.describe('the shell on a phone', () => {
|
|||||||
// are here, and they are the *same* components -- this view
|
// are here, and they are the *same* components -- this view
|
||||||
// composes the transport rather than reimplementing it.
|
// composes the transport rather than reimplementing it.
|
||||||
await expect(app.locator('now-playing-view seek-bar')).toBeVisible();
|
await expect(app.locator('now-playing-view seek-bar')).toBeVisible();
|
||||||
|
|
||||||
|
// Volume is here **because the player says there is one** (#64),
|
||||||
|
// not because this is a phone. This tier is the platform that owns
|
||||||
|
// its own volume, so what it can assert is that the control's
|
||||||
|
// presence follows that answer -- an inverted polarity in
|
||||||
|
// `volume-style-store` fails here and in `bottom-bar.spec.ts`, and
|
||||||
|
// the *absent* branch is checked in the component tier, where the
|
||||||
|
// binding can be stubbed. Nothing here can reach the Android side.
|
||||||
|
const systemOwns = await app.evaluate(
|
||||||
|
async () =>
|
||||||
|
(await window.__yjEvents.call(
|
||||||
|
'player.Player.SystemOwnsVolume',
|
||||||
|
[],
|
||||||
|
5_000,
|
||||||
|
)) as boolean,
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(systemOwns, 'this platform should own its own volume').toBe(false);
|
||||||
|
|
||||||
await expect(app.locator('now-playing-view volume-control')).toBeVisible();
|
await expect(app.locator('now-playing-view volume-control')).toBeVisible();
|
||||||
|
|
||||||
// Back goes where the user came from, through the nav stack.
|
// Back goes where the user came from, through the nav stack.
|
||||||
@@ -138,6 +157,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 +245,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,315 @@
|
|||||||
|
import { test, expect } from '../support/fixtures.js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The phone's transport (#59, #56).
|
||||||
|
*
|
||||||
|
* #56 reports that "the playback controls are the most important thing
|
||||||
|
* in the mobile app and they are tiny". Measured at the reference
|
||||||
|
* device's 424x439 before this, every one of them was **33x21px**, and
|
||||||
|
* the favourite beside them — which #59 keeps on the bar — was
|
||||||
|
* **18x14px**, the smallest control in the app.
|
||||||
|
*
|
||||||
|
* #59 is what makes the sizes affordable: five controls plus a queue
|
||||||
|
* button at 44px does not fit 424 CSS px, so the bar carries three and
|
||||||
|
* the rest are on the full-screen view.
|
||||||
|
*
|
||||||
|
* **The assertion that matters is not the pixel count.** Plan 018's
|
||||||
|
* matrix promises that *no action is ever unreachable at any supported
|
||||||
|
* size*, and #59 removes three controls from the phone's bar — so the
|
||||||
|
* first thing this file checks is that all three are still reachable,
|
||||||
|
* by walking the route a user would. A spec that only measured the
|
||||||
|
* survivors would be green on a build that had made shuffle
|
||||||
|
* unreachable, which is the failure mode this pair of issues is one
|
||||||
|
* mistake away from.
|
||||||
|
*/
|
||||||
|
type Page = import('@playwright/test').Page;
|
||||||
|
|
||||||
|
/** The reference device's real viewport. */
|
||||||
|
const DEVICE = { width: 424, height: 439 };
|
||||||
|
const PHONE = { width: 390, height: 780 };
|
||||||
|
const DESKTOP = { width: 1280, height: 800 };
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The touch-target floor. 44px is what #56's Findings name and what
|
||||||
|
* #55's queue header was sized to, so the app has one number.
|
||||||
|
*/
|
||||||
|
const TARGET = 44;
|
||||||
|
|
||||||
|
/** The play button is named for its action, not its identity. */
|
||||||
|
const PLAY_PAUSE = /^(Play|Pause)$/;
|
||||||
|
|
||||||
|
const barControls = (page: Page) =>
|
||||||
|
page.locator('audio-player player-controls');
|
||||||
|
|
||||||
|
/**
|
||||||
|
* `name` may be a regex, and for play/pause it must be: that button is
|
||||||
|
* named for the *action*, so it is "Pause" while a track runs and
|
||||||
|
* "Play" when it stops. An exact 'Play' made these tests wait out a
|
||||||
|
* fixture track (11.1s each, passing by luck) and would have failed
|
||||||
|
* outright against `LONG_TRACK`. A test about a control's size does not
|
||||||
|
* care what the transport is doing.
|
||||||
|
*/
|
||||||
|
async function sizeOf(
|
||||||
|
page: Page,
|
||||||
|
name: string | RegExp,
|
||||||
|
): Promise<[number, number]> {
|
||||||
|
const box = await page
|
||||||
|
.getByRole('button', { name, exact: typeof name === 'string' })
|
||||||
|
.boundingBox();
|
||||||
|
|
||||||
|
expect(box, `no button named ${name}`).not.toBeNull();
|
||||||
|
|
||||||
|
return [box!.width, box!.height];
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Put something in the queue, so the transport has a track to act on. */
|
||||||
|
async function stageATrack(page: Page): Promise<void> {
|
||||||
|
await page.evaluate(async () => {
|
||||||
|
const tracks = (await window.__yjEvents.call(
|
||||||
|
'library.Library.GetTracks',
|
||||||
|
[0],
|
||||||
|
10_000,
|
||||||
|
)) as { FilePath: string }[];
|
||||||
|
|
||||||
|
await window.__yjEvents.call(
|
||||||
|
'queue.Queue.SetQueue',
|
||||||
|
[tracks.slice(0, 4).map((t) => t.FilePath), 0, false, { type: '', id: 0, label: '' }],
|
||||||
|
10_000,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
test.describe('the phone bar carries three controls', () => {
|
||||||
|
test.beforeEach(async ({ app }) => {
|
||||||
|
await app.setViewportSize(DEVICE);
|
||||||
|
await stageATrack(app);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('drops shuffle, repeat and the queue from the bar', async ({ app }) => {
|
||||||
|
const bar = barControls(app);
|
||||||
|
|
||||||
|
await expect(bar.getByRole('button', { name: 'Previous track' })).toBeVisible();
|
||||||
|
await expect(bar.getByRole('button', { name: 'Next track' })).toBeVisible();
|
||||||
|
|
||||||
|
// Not in the bar's own subtree. Asserted against the bar rather
|
||||||
|
// than the page, because the whole point is that they moved rather
|
||||||
|
// than went away -- a page-wide `not.toBeVisible()` would fail the
|
||||||
|
// moment Now Playing is open and would be asserting the wrong
|
||||||
|
// thing besides.
|
||||||
|
await expect(bar.getByRole('button', { name: 'Shuffle' })).toHaveCount(0);
|
||||||
|
await expect(bar.getByRole('button', { name: /^Repeat/ })).toHaveCount(0);
|
||||||
|
await expect(app.locator('#queue-button')).toBeHidden();
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The promise, walked. Every control #59 takes off the bar is
|
||||||
|
* reachable from the mini player's art in one tap.
|
||||||
|
*/
|
||||||
|
test('leaves every removed control reachable from Now Playing', async ({
|
||||||
|
app,
|
||||||
|
}) => {
|
||||||
|
await app.getByTestId('open-now-playing').click();
|
||||||
|
|
||||||
|
await expect(app.getByTestId('main-content')).toHaveAttribute(
|
||||||
|
'data-active-view',
|
||||||
|
'now-playing',
|
||||||
|
);
|
||||||
|
|
||||||
|
await expect(app.getByRole('button', { name: 'Shuffle' })).toBeVisible();
|
||||||
|
await expect(app.getByRole('button', { name: /^Repeat/ })).toBeVisible();
|
||||||
|
await expect(app.getByRole('button', { name: 'Show the queue' })).toBeVisible();
|
||||||
|
});
|
||||||
|
|
||||||
|
test('sizes what is left for a thumb', async ({ app }) => {
|
||||||
|
for (const name of ['Previous track', 'Next track']) {
|
||||||
|
const [w, h] = await sizeOf(app, name);
|
||||||
|
|
||||||
|
expect(w, `${name} width`).toBeGreaterThanOrEqual(TARGET);
|
||||||
|
expect(h, `${name} height`).toBeGreaterThanOrEqual(TARGET);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Play is deliberately bigger than its neighbours: a row of
|
||||||
|
// identical squares says every action is equally likely, which is
|
||||||
|
// not true of play.
|
||||||
|
const [pw, ph] = await sizeOf(app, PLAY_PAUSE);
|
||||||
|
const [nw] = await sizeOf(app, 'Next track');
|
||||||
|
|
||||||
|
expect(ph).toBeGreaterThanOrEqual(TARGET);
|
||||||
|
expect(pw).toBeGreaterThan(nw);
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The favourite was 18x14 and is one of the three controls #59
|
||||||
|
* keeps, so it is part of this issue rather than a nicety.
|
||||||
|
*/
|
||||||
|
test('sizes the favourite, which was the smallest control in the app', async ({
|
||||||
|
app,
|
||||||
|
}) => {
|
||||||
|
const fav = app
|
||||||
|
.locator('now-playing')
|
||||||
|
.getByRole('button', { name: /Favorites$/ });
|
||||||
|
|
||||||
|
const box = await fav.boundingBox();
|
||||||
|
|
||||||
|
expect(box).not.toBeNull();
|
||||||
|
expect(box!.width).toBeGreaterThanOrEqual(TARGET);
|
||||||
|
expect(box!.height).toBeGreaterThanOrEqual(TARGET);
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* **The route to the queue must not depend on what is playing.**
|
||||||
|
*
|
||||||
|
* `now-playing` renders two branches, and the no-track one had no
|
||||||
|
* `.expand` button on its placeholder — so with nothing loaded there
|
||||||
|
* was no way to Now Playing, and once #59 takes the queue button off
|
||||||
|
* the bar that makes the *queue* unreachable. The queue is persisted
|
||||||
|
* across restarts, so "tracks queued, nothing playing" is a state the
|
||||||
|
* app launches into.
|
||||||
|
*
|
||||||
|
* This is asserted with the queue explicitly emptied rather than by
|
||||||
|
* relying on the app not having played anything: `make e2e` runs one
|
||||||
|
* long-lived app across every spec file (#168), so "no track loaded"
|
||||||
|
* is otherwise whatever the file before this one left behind — which
|
||||||
|
* is how the underlying fault first showed up as a flake in a spec
|
||||||
|
* about something else.
|
||||||
|
*/
|
||||||
|
test('reaches the queue with nothing playing', async ({ app }) => {
|
||||||
|
await app.evaluate(async () => {
|
||||||
|
await window.__yjEvents.call('queue.Queue.Clear', [], 10_000);
|
||||||
|
});
|
||||||
|
|
||||||
|
await expect(app.getByTestId('open-now-playing')).toBeVisible();
|
||||||
|
|
||||||
|
await app.getByTestId('open-now-playing').click();
|
||||||
|
await app.getByTestId('npv-queue').click();
|
||||||
|
|
||||||
|
await expect(app.locator('#queue-panel')).toHaveAttribute('open', '');
|
||||||
|
});
|
||||||
|
|
||||||
|
test('still fits, with nothing to scroll sideways to', async ({ app }) => {
|
||||||
|
const fit = await app.evaluate(() => ({
|
||||||
|
scroll: document.body.scrollWidth,
|
||||||
|
client: document.body.clientWidth,
|
||||||
|
}));
|
||||||
|
|
||||||
|
expect(fit.scroll).toBe(fit.client);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
test.describe('the full-screen transport is the page', () => {
|
||||||
|
test.beforeEach(async ({ app }) => {
|
||||||
|
await app.setViewportSize(DEVICE);
|
||||||
|
await stageATrack(app);
|
||||||
|
await app.getByTestId('open-now-playing').click();
|
||||||
|
});
|
||||||
|
|
||||||
|
test('draws all five, larger than the bar draws any', async ({ app }) => {
|
||||||
|
const [pw, ph] = await sizeOf(app, PLAY_PAUSE);
|
||||||
|
|
||||||
|
expect(pw).toBeGreaterThanOrEqual(56);
|
||||||
|
expect(ph).toBeGreaterThanOrEqual(56);
|
||||||
|
|
||||||
|
for (const name of ['Shuffle', 'Previous track', 'Next track']) {
|
||||||
|
const [w, h] = await sizeOf(app, name);
|
||||||
|
|
||||||
|
expect(w, `${name} width`).toBeGreaterThanOrEqual(TARGET);
|
||||||
|
expect(h, `${name} height`).toBeGreaterThanOrEqual(TARGET);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test('fits at both phone widths', async ({ app }) => {
|
||||||
|
for (const size of [DEVICE, PHONE]) {
|
||||||
|
await app.setViewportSize(size);
|
||||||
|
|
||||||
|
const fit = await app.evaluate(() => ({
|
||||||
|
scroll: document.body.scrollWidth,
|
||||||
|
client: document.body.clientWidth,
|
||||||
|
}));
|
||||||
|
|
||||||
|
expect(fit.scroll, `${size.width}px`).toBe(fit.client);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* **The desktop bar is not what either issue is about, and must not
|
||||||
|
* move.** Both are `Platform/Android`; this is the guard that says so
|
||||||
|
* in a way a build can check.
|
||||||
|
*
|
||||||
|
* It caught a real regression while it was being written: a generic
|
||||||
|
* `font-size` on the buttons took them from the UA stylesheet's 13.3px
|
||||||
|
* to the shell's 16px and grew every one from 33x21 to 36x24 — a
|
||||||
|
* change nobody asked for, invisible to every other assertion here.
|
||||||
|
*/
|
||||||
|
test.describe('the desktop bar is untouched', () => {
|
||||||
|
test.beforeEach(async ({ app }) => {
|
||||||
|
await app.setViewportSize(DESKTOP);
|
||||||
|
await stageATrack(app);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('keeps all five controls and the queue button', async ({ app }) => {
|
||||||
|
const bar = barControls(app);
|
||||||
|
|
||||||
|
for (const name of ['Shuffle', 'Previous track', 'Next track']) {
|
||||||
|
await expect(bar.getByRole('button', { name })).toBeVisible();
|
||||||
|
}
|
||||||
|
|
||||||
|
await expect(bar.getByRole('button', { name: /^Repeat/ })).toBeVisible();
|
||||||
|
await expect(app.locator('#queue-button')).toBeVisible();
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* **The mechanism, because the pixels are the engine's.**
|
||||||
|
*
|
||||||
|
* The first version of this asserted the literal `'33x21'`, measured
|
||||||
|
* on `main` in Chromium — and WebKit draws the same button **36x24**,
|
||||||
|
* so it failed in CI on a build where nothing was wrong. A button's
|
||||||
|
* box comes from the UA stylesheet when the author sets nothing, and
|
||||||
|
* what each UA sets is its own business.
|
||||||
|
*
|
||||||
|
* What this PR must not do is *set* anything here, so that is what is
|
||||||
|
* asserted: our two box properties are unset, and the font is still
|
||||||
|
* the UA's rather than the shell's. That is precisely the regression
|
||||||
|
* this caught the first time — a generic `font-size: inherit` took
|
||||||
|
* these from the UA's default to 16px — and it catches it in either
|
||||||
|
* engine.
|
||||||
|
*/
|
||||||
|
test('sets no size of its own on the desktop bar', async ({ app }) => {
|
||||||
|
const measured = await barControls(app).evaluate((el) => {
|
||||||
|
// A bare button with no author styles: whatever this engine
|
||||||
|
// gives one is what the bar's buttons must still be.
|
||||||
|
const probe = document.createElement('button');
|
||||||
|
|
||||||
|
document.body.appendChild(probe);
|
||||||
|
|
||||||
|
const uaFontSize = getComputedStyle(probe).fontSize;
|
||||||
|
|
||||||
|
probe.remove();
|
||||||
|
|
||||||
|
return [...el.shadowRoot!.querySelectorAll('button')].map((b) => {
|
||||||
|
const cs = getComputedStyle(b);
|
||||||
|
const r = b.getBoundingClientRect();
|
||||||
|
|
||||||
|
return {
|
||||||
|
minWidth: cs.minWidth,
|
||||||
|
minHeight: cs.minHeight,
|
||||||
|
usesUaFont: cs.fontSize === uaFontSize,
|
||||||
|
size: `${Math.round(r.width)}x${Math.round(r.height)}`,
|
||||||
|
};
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(measured).toHaveLength(5);
|
||||||
|
|
||||||
|
for (const m of measured) {
|
||||||
|
expect(m.minWidth, 'min-width').toBe('0px');
|
||||||
|
expect(m.minHeight, 'min-height').toBe('0px');
|
||||||
|
expect(m.usesUaFont, 'font-size is still the UA default').toBe(true);
|
||||||
|
}
|
||||||
|
|
||||||
|
// And all five are the same box: `.play` takes a larger size in
|
||||||
|
// both sized contexts, so this is what says the desktop is neither
|
||||||
|
// of them.
|
||||||
|
expect(new Set(measured.map((m) => m.size)).size).toBe(1);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,373 @@
|
|||||||
|
import { test, expect, openTheQueue } from '../support/fixtures.js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* #55 — the queue is a *place* while it covers the content, and a
|
||||||
|
* *control* while it sits beside it.
|
||||||
|
*
|
||||||
|
* #24 already made the pixels right: measured at the reference device's
|
||||||
|
* 424×439, the overlaid panel is 424×318, which is `.main-panel`'s rect
|
||||||
|
* exactly. What was missing was the navigation model, and the defect was
|
||||||
|
* measurable in one line — opening the queue on Artists and pressing
|
||||||
|
* back moved the page *underneath* to Albums and left the queue up. A
|
||||||
|
* back press that changes something the user cannot see, and costs them
|
||||||
|
* their place, is the whole of "it does not flow".
|
||||||
|
*
|
||||||
|
* **These assert the entry, not the attribute.** The temptation is to
|
||||||
|
* check `#queue-button[aria-expanded]` and stop, which is the shell's
|
||||||
|
* own bookkeeping and was right throughout the bug: what has to be true
|
||||||
|
* is that *one* back press closes the queue and the *next* one
|
||||||
|
* navigates. Asserting only the first would pass on a build that
|
||||||
|
* orphans the entry, which is the defect moved one press later — the
|
||||||
|
* same trap `back-navigation.spec.ts` documents about `data-active-view`
|
||||||
|
* and `layout-overflow.spec.ts` set for #69.
|
||||||
|
*
|
||||||
|
* **Three of these nine fail on the build before #55**, and the other
|
||||||
|
* six cannot, which is worth knowing before trusting them: "the entry
|
||||||
|
* is not orphaned" and "the column is not in the stack" are both
|
||||||
|
* vacuously true of a build that pushes no entry at all, and the
|
||||||
|
* containment assertion pins the mount that was *not* taken. They guard
|
||||||
|
* the next change rather than reproducing this one — the three that
|
||||||
|
* reproduce it are the two back-press tests and the touch target.
|
||||||
|
*/
|
||||||
|
type Page = import('@playwright/test').Page;
|
||||||
|
|
||||||
|
/** The reference device's real viewport, not a resized desktop. */
|
||||||
|
const DEVICE = { width: 424, height: 439 };
|
||||||
|
|
||||||
|
/** Wide enough that the queue is a column: 1280 − 200 − 320 ≥ 480. */
|
||||||
|
const DESKTOP = { width: 1280, height: 800 };
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The Compact band, where the queue is a *screen* (644 − 320 < 480) and
|
||||||
|
* the bottom bar still carries its button.
|
||||||
|
*
|
||||||
|
* Two of these tests need both facts at once and only this band has
|
||||||
|
* them: below 600px #59 takes the button off the bar, so there is no
|
||||||
|
* toggle to re-press and the queue is opened from Now Playing — which
|
||||||
|
* is itself a detail view, so "the destination stays lit" is vacuously
|
||||||
|
* true there rather than tested.
|
||||||
|
*/
|
||||||
|
const COMPACT = { width: 700, height: 600 };
|
||||||
|
|
||||||
|
const activeView = (page: Page) => page.getByTestId('main-content');
|
||||||
|
const queue = (page: Page) => page.locator('#queue-panel');
|
||||||
|
const toggle = (page: Page) => page.locator('#queue-button');
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether the queue is up.
|
||||||
|
*
|
||||||
|
* The panel's own attribute rather than the toggle's `aria-expanded`,
|
||||||
|
* because below 600px there is no toggle to ask (#59) — and the panel
|
||||||
|
* is the one fact both of them reflect anyway.
|
||||||
|
*/
|
||||||
|
async function expectQueue(page: Page, open: boolean): Promise<void> {
|
||||||
|
const panel = queue(page);
|
||||||
|
|
||||||
|
if (open) {
|
||||||
|
await expect(panel).toHaveAttribute('open', '');
|
||||||
|
} else {
|
||||||
|
await expect(panel).not.toHaveAttribute('open', '');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
test.describe('the queue is a screen where it covers the content', () => {
|
||||||
|
test.beforeEach(async ({ app }) => {
|
||||||
|
await app.setViewportSize(DEVICE);
|
||||||
|
await app.getByTestId('tab-albums').click();
|
||||||
|
await expect(activeView(app)).toHaveAttribute('data-active-view', 'albums');
|
||||||
|
});
|
||||||
|
|
||||||
|
// On a phone the queue is opened from Now Playing (#59), so the page
|
||||||
|
// *underneath* it is `now-playing` and the journey is two entries
|
||||||
|
// deep: albums -> now-playing -> queue. That is the real route a user
|
||||||
|
// takes, which is why these do not reach for the shortcut.
|
||||||
|
|
||||||
|
test('back closes the queue and leaves the page where it was', async ({
|
||||||
|
app,
|
||||||
|
}) => {
|
||||||
|
await expect(queue(app)).toHaveAttribute('overlay', '');
|
||||||
|
|
||||||
|
await openTheQueue(app);
|
||||||
|
await expectQueue(app, true);
|
||||||
|
|
||||||
|
await app.goBack();
|
||||||
|
|
||||||
|
await expectQueue(app, false);
|
||||||
|
// The page underneath is untouched. Before #55 this was the
|
||||||
|
// *previous* view, because the queue was not in the stack at all
|
||||||
|
// and back spent an entry navigating something nobody could see.
|
||||||
|
await expect(activeView(app)).toHaveAttribute(
|
||||||
|
'data-active-view',
|
||||||
|
'now-playing',
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('costs exactly one entry, so the next press navigates', async ({
|
||||||
|
app,
|
||||||
|
}) => {
|
||||||
|
await openTheQueue(app);
|
||||||
|
await expectQueue(app, true);
|
||||||
|
|
||||||
|
await app.goBack();
|
||||||
|
await expectQueue(app, false);
|
||||||
|
await expect(activeView(app)).toHaveAttribute(
|
||||||
|
'data-active-view',
|
||||||
|
'now-playing',
|
||||||
|
);
|
||||||
|
|
||||||
|
await app.goBack();
|
||||||
|
|
||||||
|
// Exactly one entry each: the second press leaves Now Playing for
|
||||||
|
// the page it was opened from, rather than being swallowed by a
|
||||||
|
// queue that had already closed.
|
||||||
|
await expect(activeView(app)).toHaveAttribute('data-active-view', 'albums');
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Every route out unwinds the entry, and they do it through the
|
||||||
|
* panel's own `open` attribute rather than each knowing about
|
||||||
|
* history — which is why a fourth route added later gets this free.
|
||||||
|
*
|
||||||
|
* The failure this pins is silent: close by button, and if the entry
|
||||||
|
* is orphaned the app looks correct until the next back press does
|
||||||
|
* nothing at all. It is a guard rather than a reproduction — a build
|
||||||
|
* with no entry to orphan passes it — and it is paired with the two
|
||||||
|
* above, which do reproduce.
|
||||||
|
*/
|
||||||
|
for (const [name, dismiss] of [
|
||||||
|
[
|
||||||
|
'the close button',
|
||||||
|
async (app: Page) => {
|
||||||
|
await app.getByRole('button', { name: 'Close queue' }).click();
|
||||||
|
},
|
||||||
|
],
|
||||||
|
[
|
||||||
|
'Escape',
|
||||||
|
async (app: Page) => {
|
||||||
|
await app.keyboard.press('Escape');
|
||||||
|
},
|
||||||
|
],
|
||||||
|
] as Array<[string, (app: Page) => Promise<void>]>) {
|
||||||
|
test(`${name} leaves no entry behind`, async ({ app }) => {
|
||||||
|
await openTheQueue(app);
|
||||||
|
await expectQueue(app, true);
|
||||||
|
|
||||||
|
await dismiss(app);
|
||||||
|
await expectQueue(app, false);
|
||||||
|
|
||||||
|
await app.goBack();
|
||||||
|
|
||||||
|
// One press, one screen: Now Playing is what the queue was opened
|
||||||
|
// from, so leaving it lands on Albums. An orphaned entry would
|
||||||
|
// have spent this press on nothing and left it here.
|
||||||
|
await expect(activeView(app)).toHaveAttribute(
|
||||||
|
'data-active-view',
|
||||||
|
'albums',
|
||||||
|
);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A detail view leaves the destination it was opened from lit
|
||||||
|
* (`active-view-store`, #72), and the queue inherits that — it is
|
||||||
|
* published with `isPrimary: false`, so `isActive('albums')` is still
|
||||||
|
* true underneath it.
|
||||||
|
*
|
||||||
|
* `aria-current` rather than a class, for the reason
|
||||||
|
* `back-navigation.spec.ts` gives: the class was right throughout the
|
||||||
|
* bug that rule exists for.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* With the panel spanning the whole width there is no scrim here at
|
||||||
|
* all (#171), so the close button is the only pointer route out of a
|
||||||
|
* full-screen surface. Measured at 424×439 before #55: **25×21px**.
|
||||||
|
*/
|
||||||
|
test('offers a way out a thumb can hit', async ({ app }) => {
|
||||||
|
await openTheQueue(app);
|
||||||
|
|
||||||
|
const box = await app
|
||||||
|
.getByRole('button', { name: 'Close queue' })
|
||||||
|
.boundingBox();
|
||||||
|
|
||||||
|
expect(box).not.toBeNull();
|
||||||
|
expect(box!.width).toBeGreaterThanOrEqual(44);
|
||||||
|
expect(box!.height).toBeGreaterThanOrEqual(44);
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* #171 — and it draws no scrim, because there is nowhere to tap.
|
||||||
|
*
|
||||||
|
* `.panel-content` is `width: 100%` here, so the scrim sat entirely
|
||||||
|
* underneath it: measured at 424×439, host, panel and scrim all
|
||||||
|
* 424×318. #24's tap-outside-to-close cannot exist on a surface with
|
||||||
|
* no outside, and a `cursor: pointer` layer nobody can reach is a
|
||||||
|
* claim the component cannot keep.
|
||||||
|
*
|
||||||
|
* Asserted as absence rather than by clicking, for the reason the
|
||||||
|
* issue gives: a naive phone case clicks the scrim's centre and hits
|
||||||
|
* the panel, so it passes on the build this exists to fail. The scrim
|
||||||
|
* is still real between 600 and 899px, which `queue-overlay.spec.ts`
|
||||||
|
* asserts at 900×600 by clicking it.
|
||||||
|
*/
|
||||||
|
test('draws no scrim, because a screen has no outside to tap', async ({
|
||||||
|
app,
|
||||||
|
}) => {
|
||||||
|
await openTheQueue(app);
|
||||||
|
|
||||||
|
const scrim = await queue(app).evaluate(
|
||||||
|
(el) => el.shadowRoot!.querySelector('.scrim') !== null,
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(scrim).toBe(false);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* **The mechanism, because no tier here can see the consequence.**
|
||||||
|
*
|
||||||
|
* #55's Direction asked for a `DETAIL_LOADERS` mount, which would put
|
||||||
|
* the panel inside `.main-panel > *`. That box is paint-contained under
|
||||||
|
* a `.main-panel` that is too, and `contain: paint` makes an element a
|
||||||
|
* containing block for fixed descendants *and clips them* — which is
|
||||||
|
* what a `wa-popup` falls back to on the reference device's Chrome 113,
|
||||||
|
* where the Popover API does not exist (#60, `.planning/NOTES.md`).
|
||||||
|
* `queue-panel` has a context menu, so that mount would have broken a
|
||||||
|
* working menu on the one device this issue is about.
|
||||||
|
*
|
||||||
|
* CI's Chromium and WebKit both *have* the Popover API, so the menu is
|
||||||
|
* top-layered and correct here either way: a spec asserting "the menu is
|
||||||
|
* not clipped" is green on the broken build. What a browser can answer
|
||||||
|
* honestly is where the element is, so that is what this asks.
|
||||||
|
*/
|
||||||
|
test('the panel stays out of the paint-contained region', async ({ app }) => {
|
||||||
|
await app.setViewportSize(DEVICE);
|
||||||
|
|
||||||
|
// Open, because that is the only state in which a menu can be opened
|
||||||
|
// from it — and because the host drops `paint` from its own
|
||||||
|
// containment deliberately in overlay mode, so a closed panel answers
|
||||||
|
// a different question.
|
||||||
|
await openTheQueue(app);
|
||||||
|
await expectQueue(app, true);
|
||||||
|
|
||||||
|
const ancestry = await app.evaluate(() => {
|
||||||
|
const chain: Array<{ tag: string; contain: string }> = [];
|
||||||
|
|
||||||
|
for (
|
||||||
|
let el = document.getElementById('queue-panel');
|
||||||
|
el && el !== document.documentElement;
|
||||||
|
el = el.parentElement
|
||||||
|
) {
|
||||||
|
chain.push({
|
||||||
|
tag: el.tagName.toLowerCase(),
|
||||||
|
contain: getComputedStyle(el).contain,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
return chain;
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(ancestry.length).toBeGreaterThan(1);
|
||||||
|
expect(ancestry.some((a) => a.tag === 'main')).toBe(false);
|
||||||
|
|
||||||
|
for (const { tag, contain } of ancestry) {
|
||||||
|
expect(
|
||||||
|
`${tag}: ${contain}`,
|
||||||
|
'a paint-contained ancestor clips a fixed-positioned popup on Chrome 113',
|
||||||
|
).not.toMatch(/paint|content|strict/);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Two properties need the queue to be a *screen* and the bar to still
|
||||||
|
* have its button, and only the Compact band has both — below 600px #59
|
||||||
|
* takes the button off the bar.
|
||||||
|
*/
|
||||||
|
test.describe('a screen opened from the bar', () => {
|
||||||
|
test.beforeEach(async ({ app }) => {
|
||||||
|
await app.setViewportSize(COMPACT);
|
||||||
|
await app.getByTestId('nav-albums').click();
|
||||||
|
await expect(activeView(app)).toHaveAttribute('data-active-view', 'albums');
|
||||||
|
await expect(queue(app)).toHaveAttribute('overlay', '');
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A detail view leaves the destination it was opened from lit
|
||||||
|
* (`active-view-store`, #72), and the queue inherits that — it is
|
||||||
|
* published with `isPrimary: false`, so `isActive('albums')` is still
|
||||||
|
* true underneath it.
|
||||||
|
*
|
||||||
|
* `aria-current` rather than a class, for the reason
|
||||||
|
* `back-navigation.spec.ts` gives: the class was right throughout the
|
||||||
|
* bug that rule exists for.
|
||||||
|
*/
|
||||||
|
test('leaves the destination it was opened from highlighted', async ({
|
||||||
|
app,
|
||||||
|
}) => {
|
||||||
|
// By testid, not by role: at 700px the sidebar is in icon mode, so
|
||||||
|
// what the item is *named* is a different question from which item
|
||||||
|
// it is. The assertion is still `aria-current`, which is the
|
||||||
|
// accessible fact.
|
||||||
|
const albums = app.getByTestId('nav-albums');
|
||||||
|
|
||||||
|
await expect(albums).toHaveAttribute('aria-current', 'page');
|
||||||
|
|
||||||
|
await toggle(app).click();
|
||||||
|
await expectQueue(app, true);
|
||||||
|
|
||||||
|
await expect(albums).toHaveAttribute('aria-current', 'page');
|
||||||
|
});
|
||||||
|
|
||||||
|
/** The toggle is a fourth way out, and it unwinds the entry like the
|
||||||
|
* other three — through the panel's attribute, not its own handler. */
|
||||||
|
test('closes from the same toggle, leaving no entry behind', async ({
|
||||||
|
app,
|
||||||
|
}) => {
|
||||||
|
await toggle(app).click();
|
||||||
|
await expectQueue(app, true);
|
||||||
|
|
||||||
|
await toggle(app).click();
|
||||||
|
await expectQueue(app, false);
|
||||||
|
|
||||||
|
await app.goBack();
|
||||||
|
|
||||||
|
await expect(activeView(app)).not.toHaveAttribute(
|
||||||
|
'data-active-view',
|
||||||
|
'albums',
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The column is not a place. Somebody docked it; back must not undock
|
||||||
|
* it, and navigating to another view must not take it away.
|
||||||
|
*
|
||||||
|
* This is the half a viewport breakpoint would get wrong: the mode is
|
||||||
|
* computed from the panel's own drag-resizable width, so the queue
|
||||||
|
* becomes a screen exactly when it stops being affordable as a column.
|
||||||
|
*/
|
||||||
|
test.describe('a docked queue is not in the back stack', () => {
|
||||||
|
test.beforeEach(async ({ app }) => {
|
||||||
|
await app.setViewportSize(DESKTOP);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('survives a navigation, and back navigates the page', async ({
|
||||||
|
app,
|
||||||
|
}) => {
|
||||||
|
await app.getByTestId('nav-albums').click();
|
||||||
|
await expect(activeView(app)).toHaveAttribute('data-active-view', 'albums');
|
||||||
|
|
||||||
|
await toggle(app).click();
|
||||||
|
await expectQueue(app, true);
|
||||||
|
await expect(queue(app)).not.toHaveAttribute('overlay', '');
|
||||||
|
|
||||||
|
await app.getByTestId('nav-artists').click();
|
||||||
|
await expect(activeView(app)).toHaveAttribute('data-active-view', 'artists');
|
||||||
|
await expectQueue(app, true);
|
||||||
|
|
||||||
|
await app.goBack();
|
||||||
|
|
||||||
|
await expect(activeView(app)).toHaveAttribute('data-active-view', 'albums');
|
||||||
|
await expectQueue(app, true);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,187 @@
|
|||||||
|
import { test, expect, openTheQueue } 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,
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Opening the queue is `openTheQueue`, which takes the route this
|
||||||
|
* viewport offers. It used to be a local helper that clicked
|
||||||
|
* `#queue-button` unconditionally, and #59 hid that button below
|
||||||
|
* 600px -- so the two phone bands here failed on a build where the
|
||||||
|
* queue was working perfectly, having been asserting *how* it opens as
|
||||||
|
* much as what it does.
|
||||||
|
*/
|
||||||
|
const openQueue = openTheQueue;
|
||||||
|
|
||||||
|
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,269 @@
|
|||||||
|
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 kept, and what it asks changed with #57.** There is no bar
|
||||||
|
* to fit below 600px any more — it is out of the grid and visually
|
||||||
|
* hidden — so "nothing hangs out of it" is a claim about an element
|
||||||
|
* with no row, and would pass on a build that had merely broken the
|
||||||
|
* bar. Dropping the width would be dropping the one place this file
|
||||||
|
* can still say something true about a phone, so it asserts the
|
||||||
|
* *stronger* property instead, below: the bar is out of the layout
|
||||||
|
* altogether, which is the thing #57 wanted and the thing that makes
|
||||||
|
* fitting moot.
|
||||||
|
*/
|
||||||
|
const WIDTHS = [600, 800, 899, 900, 1440];
|
||||||
|
|
||||||
|
/** Where #57 leaves the bar, and where the desktop still has one. */
|
||||||
|
const PHONE_WIDTH = 390;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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', () => {
|
||||||
|
/**
|
||||||
|
* The phone's answer, which is not "it fits" (#57).
|
||||||
|
*
|
||||||
|
* The bar has no grid row below 600px, so measuring its children
|
||||||
|
* against its content box is measuring a 1px box that is already
|
||||||
|
* invisible — a fit pass would collapse the wordmark every time and
|
||||||
|
* report success about nothing, which is why `measureTopBarFit`
|
||||||
|
* declines to run at all when the bar is out of flow. What is worth
|
||||||
|
* asserting here is that the fit pass has not quietly started
|
||||||
|
* *undoing* that: a rule that put the bar back in the layout would
|
||||||
|
* pass every assertion in this file and cost a 439px screen 12% of
|
||||||
|
* its height.
|
||||||
|
*/
|
||||||
|
test(`the bar is out of the layout at ${PHONE_WIDTH}px, with a job running`, async ({
|
||||||
|
app,
|
||||||
|
testctl,
|
||||||
|
}) => {
|
||||||
|
await app.setViewportSize({ width: PHONE_WIDTH, height: 600 });
|
||||||
|
await testctl.emit('JobsChanged', [LONG_JOB]);
|
||||||
|
|
||||||
|
// Not merely hidden: `display: none` on the header would satisfy
|
||||||
|
// "invisible" and leave the 3.25em row exactly where it was. So
|
||||||
|
// the assertion is that the content starts where the row above it
|
||||||
|
// ends -- and with a job staged, the row above it is the jobs
|
||||||
|
// band, which is the whole reason this row could go.
|
||||||
|
await expect
|
||||||
|
.poll(() =>
|
||||||
|
app.evaluate(() => {
|
||||||
|
const bar = document.querySelector<HTMLElement>('header.top-bar')!;
|
||||||
|
const main = document.querySelector<HTMLElement>('.main-panel')!;
|
||||||
|
const band = document.querySelector<HTMLElement>('job-band')!;
|
||||||
|
|
||||||
|
return {
|
||||||
|
position: getComputedStyle(bar).position,
|
||||||
|
gap:
|
||||||
|
Math.round(main.getBoundingClientRect().top) -
|
||||||
|
Math.round(band.getBoundingClientRect().bottom),
|
||||||
|
};
|
||||||
|
}),
|
||||||
|
)
|
||||||
|
.toEqual({ position: 'absolute', gap: 0 });
|
||||||
|
|
||||||
|
// And the work is still visible, in the band that replaced the
|
||||||
|
// indicator (#62) — which is what made this row removable at all.
|
||||||
|
await expect(app.locator('job-indicator')).toBeHidden();
|
||||||
|
await expect(app.locator('job-band').locator('job-row')).toHaveCount(1);
|
||||||
|
|
||||||
|
await app.setViewportSize({ width: 1440, height: 900 });
|
||||||
|
});
|
||||||
|
|
||||||
|
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,79 @@ 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' });
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Open the queue the way a user at this viewport would.
|
||||||
|
*
|
||||||
|
* **The route differs by width and that is the feature, not an
|
||||||
|
* inconvenience.** Above 600px the bottom bar carries a queue button.
|
||||||
|
* Below it that button is gone (#59) and the queue is reached from the
|
||||||
|
* full-screen Now Playing view, which the mini player's art opens —
|
||||||
|
* "reachable only from Now Playing", which is what the issue asks for.
|
||||||
|
*
|
||||||
|
* It is here rather than in one spec because four files need it, and
|
||||||
|
* because a spec that hard-codes `#queue-button` is quietly asserting
|
||||||
|
* *which* route exists as well as what the queue does. Four of them
|
||||||
|
* were, which is how hiding one button failed ten tests about
|
||||||
|
* something else.
|
||||||
|
*
|
||||||
|
* The width is read from the page rather than passed, so a caller that
|
||||||
|
* resizes and then opens does not have to say so twice.
|
||||||
|
*/
|
||||||
|
export async function openTheQueue(page: Page): Promise<void> {
|
||||||
|
const toggle = page.locator('#queue-button');
|
||||||
|
|
||||||
|
if (await toggle.isVisible()) {
|
||||||
|
if ((await toggle.getAttribute('aria-expanded')) !== 'true') {
|
||||||
|
await toggle.click();
|
||||||
|
}
|
||||||
|
|
||||||
|
await expect(toggle).toHaveAttribute('aria-expanded', 'true');
|
||||||
|
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The phone: through Now Playing. `open-now-playing` is the mini
|
||||||
|
// player's art, which is a button only below 600px.
|
||||||
|
if (
|
||||||
|
(await page.getByTestId('main-content').getAttribute('data-active-view')) !==
|
||||||
|
'now-playing'
|
||||||
|
) {
|
||||||
|
await page.getByTestId('open-now-playing').click();
|
||||||
|
}
|
||||||
|
|
||||||
|
await page.getByTestId('npv-queue').click();
|
||||||
|
await expect(page.locator('#queue-panel')).toHaveAttribute('open', '');
|
||||||
|
}
|
||||||
|
|
||||||
/** 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.
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -431,8 +431,17 @@ export interface TopResult {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Library status — populated from index cross-reference columns.
|
* Library status — populated from index cross-reference columns.
|
||||||
|
*
|
||||||
|
* LocalID is the one the cards read. It is the local row behind
|
||||||
|
* this entity — an album, a file, an artist — and it is set and
|
||||||
|
* cleared by a test against `audio_files`, so it means "there is
|
||||||
|
* something of mine here". InLibrary is written by the same pass
|
||||||
|
* but is a one-way ratchet the prune can only clear alongside a
|
||||||
|
* local id, so it is the weaker of the two and stays for scoring
|
||||||
|
* (`fwInLibrary`), which is where an approximate answer is fine.
|
||||||
*/
|
*/
|
||||||
"inLibrary": boolean;
|
"inLibrary": boolean;
|
||||||
|
"localId"?: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -98,6 +98,26 @@ export function GetAlbumsByArtist(artist: string, libraryID: number): $Cancellab
|
|||||||
return $Call.ByID(1456840721, artist, libraryID);
|
return $Call.ByID(1456840721, artist, libraryID);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* GetAlbumsCompleteness answers the same question for a screenful of
|
||||||
|
* albums in one query, keyed by album id.
|
||||||
|
*
|
||||||
|
* A card grid asks this about every card that has a local album behind
|
||||||
|
* it, and one query per card is how a grid of fifty albums becomes
|
||||||
|
* fifty round trips. The answer matters there for the reason it
|
||||||
|
* matters on the album page: an album held 9 tracks of 12 has to show
|
||||||
|
* the count, and a bare tick saying "in your library" is the complaint
|
||||||
|
* this whole rule came from.
|
||||||
|
*
|
||||||
|
* An album with no row in the result is one with no files, and it is
|
||||||
|
* absent rather than zeroed — "I have none of this" and "I have no
|
||||||
|
* idea" are the same third state `Known` exists to keep apart, and a
|
||||||
|
* caller reading a missing key gets nothing rather than a confident 0.
|
||||||
|
*/
|
||||||
|
export function GetAlbumsCompleteness(albumIDs: number[] | null): $CancellablePromise<{ [_ in `${number}`]?: $models.AlbumCompleteness } | null> {
|
||||||
|
return $Call.ByID(531636827, albumIDs);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* GetAllLibrariesWithTrackCounts lists the libraries and their sizes.
|
* GetAllLibrariesWithTrackCounts lists the libraries and their sizes.
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -142,6 +142,18 @@ export function SetVolume(desiredVolume: $models.UserVolume): $CancellablePromis
|
|||||||
return $Call.ByID(1375836663, desiredVolume);
|
return $Call.ByID(1375836663, desiredVolume);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* SystemOwnsVolume reports whether the platform's own control is the
|
||||||
|
* only volume control there is, so this app neither offers one nor
|
||||||
|
* remembers a level.
|
||||||
|
*
|
||||||
|
* It is bound: the frontend renders no `<volume-control>` when it is
|
||||||
|
* true, at any width.
|
||||||
|
*/
|
||||||
|
export function SystemOwnsVolume(): $CancellablePromise<boolean> {
|
||||||
|
return $Call.ByID(1027623185);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* TrackLengthInSeconds returns the duration of the current track.
|
* TrackLengthInSeconds returns the duration of the current track.
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
+288
-35
@@ -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 {
|
||||||
@@ -289,10 +412,21 @@ body div.sidebar {
|
|||||||
=================================================================== */
|
=================================================================== */
|
||||||
@media (max-width: 599px) {
|
@media (max-width: 599px) {
|
||||||
body {
|
body {
|
||||||
|
/* **There is no top-bar row here (#57).** Every one of the five
|
||||||
|
things that bar held has somewhere else to be below 600px:
|
||||||
|
`nav-history` is the platform's own gesture (gone from 899
|
||||||
|
down), the job indicator is `<job-band>` (#62), the search
|
||||||
|
box is a modal opened from the view's own header
|
||||||
|
(`search-trigger`), the library filter is Settings ->
|
||||||
|
Libraries (#148), and the wordmark is below. That is 3.25em
|
||||||
|
of a 439 CSS px viewport -- the single biggest vertical win
|
||||||
|
available on the reference device, which is why #57 asks for
|
||||||
|
the row rather than for a smaller bar. */
|
||||||
grid-template:
|
grid-template:
|
||||||
"top-bar" 3.25em
|
"jobs-band" auto
|
||||||
"main-panel" 1fr
|
"main-panel" 1fr
|
||||||
"bottom-bar" auto
|
"bottom-bar" auto
|
||||||
|
"progress-line" auto
|
||||||
"bottom-nav" auto
|
"bottom-nav" auto
|
||||||
/ 1fr;
|
/ 1fr;
|
||||||
/* Nothing may scroll sideways here. On a desktop the shell is
|
/* Nothing may scroll sideways here. On a desktop the shell is
|
||||||
@@ -309,40 +443,55 @@ body div.sidebar {
|
|||||||
grid-area: bottom-nav;
|
grid-area: bottom-nav;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* The 2em gutters are half a thumb each at this width, and the
|
/* The bar is out of the layout, and out of it the way the *wordmark*
|
||||||
subtitle is already gone from 900 down.
|
already goes at desktop widths: visually hidden rather than
|
||||||
|
`display: none`, because that `h1` is the document's top-level
|
||||||
|
heading and this app would otherwise have none on the pages whose
|
||||||
|
own header is empty by design (`page-header` renders no `h1` when
|
||||||
|
`heading` is '', and Settings has no `page-header` at all).
|
||||||
|
|
||||||
`min-width: 0` is the load-bearing half. A grid item's implicit
|
Its four *controls* are `display: none` below, which is what
|
||||||
minimum is `auto` -- its content -- so a header whose children
|
keeps them out of the tab order -- a visually-hidden container is
|
||||||
ask for 580px makes the *body* 580px wide inside a 360px
|
still focusable, and tabbing into a search box nobody can see is
|
||||||
viewport, and `overflow-x: hidden` then hides the right-hand
|
worse than not having one.
|
||||||
third of the app rather than fitting it. Every box between the
|
|
||||||
viewport and the content that must shrink needs this. */
|
This is `styles/sr-only.css.ts`'s recipe again, written out
|
||||||
|
because that one is a `CSSResult` for shadow roots and this is
|
||||||
|
the light DOM. `position: absolute` is also what tells
|
||||||
|
`services/top-bar-fit.ts` there is no row to fit into. */
|
||||||
.top-bar {
|
.top-bar {
|
||||||
padding-left: 0.75em;
|
position: absolute;
|
||||||
padding-right: 0.75em;
|
width: 1px;
|
||||||
gap: 0.5em;
|
height: 1px;
|
||||||
min-width: 0;
|
padding: 0;
|
||||||
|
margin: -1px;
|
||||||
overflow: hidden;
|
overflow: hidden;
|
||||||
|
clip-path: inset(50%);
|
||||||
|
white-space: nowrap;
|
||||||
|
border: 0;
|
||||||
|
gap: 0;
|
||||||
|
min-width: 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.top-bar nav-history,
|
||||||
|
.top-bar library-filter,
|
||||||
|
.top-bar search-bar,
|
||||||
|
.top-bar job-indicator {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* `min-width: 0` is load-bearing wherever a box sits between the
|
||||||
|
viewport and content that must shrink. A grid item's implicit
|
||||||
|
minimum is `auto` -- its content -- so one child insisting on
|
||||||
|
580px makes the *body* 580px wide inside a 360px viewport, and
|
||||||
|
`overflow-x: hidden` then hides the right-hand third of the app
|
||||||
|
rather than fitting it. */
|
||||||
.content-area,
|
.content-area,
|
||||||
.main-panel,
|
.main-panel,
|
||||||
.bottom-bar {
|
.bottom-bar {
|
||||||
min-width: 0;
|
min-width: 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
.title {
|
|
||||||
font-size: 1.1em;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* The search box is the one header control worth its width; the
|
|
||||||
library filter is a rarely-changed setting and reachable from
|
|
||||||
the drawer's Settings. */
|
|
||||||
.top-bar library-filter {
|
|
||||||
display: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* The full-screen now-playing view *is* the transport, so the bar
|
/* The full-screen now-playing view *is* the transport, so the bar
|
||||||
repeating it underneath is 4em of a small screen spent saying
|
repeating it underneath is 4em of a small screen spent saying
|
||||||
the same thing twice -- visible in a screenshot, invisible to
|
the same thing twice -- visible in a screenshot, invisible to
|
||||||
@@ -353,17 +502,18 @@ body div.sidebar {
|
|||||||
expression of the same fact is a second thing to keep in step.
|
expression of the same fact is a second thing to keep in step.
|
||||||
The view carries its own queue button, because this is where
|
The view carries its own queue button, because this is where
|
||||||
that one lived. */
|
that one lived. */
|
||||||
body:has(#main-content[data-active-view="now-playing"]) .bottom-bar {
|
body:has(#main-content[data-active-view="now-playing"]) .bottom-bar,
|
||||||
|
body:has(#main-content[data-active-view="now-playing"]) player-progress-line {
|
||||||
display: none;
|
display: none;
|
||||||
}
|
}
|
||||||
|
|
||||||
.top-bar search-bar {
|
|
||||||
flex: 1 1 auto;
|
|
||||||
min-width: 0;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
@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 +522,107 @@ 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: five controls and a slider do not fit a 360px
|
||||||
|
bar, and the full-screen now-playing view is where seeking and
|
||||||
|
volume go on a phone. 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.
|
||||||
|
|
||||||
|
**This rule used to carry the platform argument too, and no
|
||||||
|
longer does** (#64). "The hardware keys own the volume" is not a
|
||||||
|
width: it is false of a narrow desktop window and true of an
|
||||||
|
Android tablet, which this selector gets backwards both ways.
|
||||||
|
The player answers it now — `SystemOwnsVolume` — and
|
||||||
|
`volume-control` renders nothing when it is true, at every
|
||||||
|
width and in both of its mount points. What is left here is the
|
||||||
|
question a stylesheet can actually answer. */
|
||||||
|
.bottom-bar volume-control {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* The queue leaves the phone's bar (#59), because #55 made it a
|
||||||
|
screen with an entry in the back stack and Now Playing already
|
||||||
|
carries its own button for it. The route is the mini player's
|
||||||
|
art -> Now Playing -> the queue, which is the "reachable only
|
||||||
|
from Now Playing" this issue asks for.
|
||||||
|
|
||||||
|
This is allowed to remove a control only because the control is
|
||||||
|
still reachable: plan 018's matrix promises that no action is
|
||||||
|
ever unreachable at any supported size, and that promise is what
|
||||||
|
`phone-transport.spec.ts` asserts rather than the button count.
|
||||||
|
|
||||||
|
**`.bottom-bar #queue-button`, not `#queue-button`**, and that is
|
||||||
|
not decoration. The rule this overrides is written *nested*
|
||||||
|
inside `.bottom-bar`, so it builds to a descendant selector one
|
||||||
|
class more specific than it looks in the source -- and a bare
|
||||||
|
`#queue-button` here loses to it, media query or not. Being last
|
||||||
|
in the file is not enough when the thing above is more specific,
|
||||||
|
which is the same lesson as this section's own header one level
|
||||||
|
down: nesting adds specificity the source does not show, and the
|
||||||
|
failure is silent (the button simply stayed). */
|
||||||
|
.bottom-bar #queue-button {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Out of the desktop grid entirely. `job-band` renders nothing above
|
||||||
|
600px anyway, but an in-flow grid child with no named area is
|
||||||
|
auto-placed into a row of the shell -- the same trap the skip link is
|
||||||
|
absolutely positioned to avoid. `player-progress-line` (#58) is the
|
||||||
|
same element in the same position for the same reason: below 600px it
|
||||||
|
has a named row, and above it there is no border for it to sit on --
|
||||||
|
the desktop bar carries a real, interactive seek bar. */
|
||||||
|
body job-band,
|
||||||
|
body player-progress-line {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* #62. The job indicator stands down on the phone, and its work is
|
||||||
|
shown in the notification band instead (notification-host).
|
||||||
|
|
||||||
|
Three reasons, and the first is the report: its popover is anchored
|
||||||
|
to the top bar, which is 3.25em here on a viewport 439 CSS px tall,
|
||||||
|
and it was reported as unreadable behind other UI. The second is
|
||||||
|
that a popover is a disclosure, and background work is the one thing
|
||||||
|
a phone should not make you disclose. The third is #57, which
|
||||||
|
deletes this bar entirely and is blocked on the indicator having
|
||||||
|
somewhere else to live -- this is that somewhere.
|
||||||
|
|
||||||
|
#57 has since done exactly that, so the indicator's own rule now
|
||||||
|
lives with the other three in the phone block above, where the bar
|
||||||
|
goes out of the layout in one statement rather than four. What stays
|
||||||
|
here is the band, and the argument for it. */
|
||||||
|
@media (max-width: 599px) {
|
||||||
|
/* The indicator's rows appear here, in the grid row above the content.
|
||||||
|
In flow rather than over it: a fixed band reads fine in a
|
||||||
|
screenshot and is unusable, because at 424x439 a compact panel
|
||||||
|
is ~200px of a 439px screen and it *covers* what is under it.
|
||||||
|
Measured, not assumed -- four e2e specs failed on that version,
|
||||||
|
two phone-shell journeys and the header's action menu, because
|
||||||
|
the panel was intercepting the taps. */
|
||||||
|
body job-band {
|
||||||
|
display: block;
|
||||||
|
grid-area: jobs-band;
|
||||||
|
background-color: var(--yj-bg-elevated, #343a40);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/* #58. How far through the song we are, in its own grid row between
|
||||||
|
the two bars -- so the line is *on* the border rather than inside
|
||||||
|
either of them, and in flow rather than over it. The row is `auto`
|
||||||
|
and the element renders nothing while no track is loaded, so it costs
|
||||||
|
no height at all until there is something to say.
|
||||||
|
|
||||||
|
**This block is below the `display: none` above and has to be**, for
|
||||||
|
the reason the band's rule is: a media query adds no specificity, so
|
||||||
|
`body player-progress-line { display: block }` written before that
|
||||||
|
rule loses to it at equal specificity and the line never appears at
|
||||||
|
any width. Nothing fails; it is simply not there. */
|
||||||
|
@media (max-width: 599px) {
|
||||||
|
body player-progress-line {
|
||||||
|
display: block;
|
||||||
|
grid-area: progress-line;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+59
-7
@@ -14,16 +14,37 @@
|
|||||||
user is not walked through the header, the library filter, the
|
user is not walked through the header, the library filter, the
|
||||||
search box and eleven nav items on every navigation. -->
|
search box and eleven nav items on every navigation. -->
|
||||||
<a class="skip-link" href="#main-content">Skip to content</a>
|
<a class="skip-link" href="#main-content">Skip to content</a>
|
||||||
|
<!-- Below 600px this bar is not in the layout at all (#57): index.css
|
||||||
|
takes its grid row away and leaves the element visually hidden,
|
||||||
|
carrying nothing but the `h1` below. Every control in it has
|
||||||
|
somewhere else to be there -- `nav-history` is the platform's
|
||||||
|
own back gesture, `job-indicator` is `<job-band>`, `search-bar`
|
||||||
|
is `<search-dialog>` opened from the view's own header, and
|
||||||
|
`library-filter` is Settings -> Libraries (#148). -->
|
||||||
<header class="top-bar">
|
<header class="top-bar">
|
||||||
<hgroup>
|
<hgroup>
|
||||||
<h1 class="title">YellowJacket</h1>
|
<h1 class="title">YellowJacket</h1>
|
||||||
<!-- 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>
|
||||||
</header>
|
</header>
|
||||||
|
<!-- The phone's view of background work (#62): below 600px the
|
||||||
|
indicator above stands down and its rows appear here instead,
|
||||||
|
in the layout rather than over it. `display: none` above that
|
||||||
|
width in index.css, which is also what keeps it out of the
|
||||||
|
desktop grid -- an in-flow child with no named area is
|
||||||
|
auto-placed into one of the shell's rows, which is the trap the
|
||||||
|
skip link is absolutely positioned to avoid. -->
|
||||||
|
<job-band></job-band>
|
||||||
<div class="sidebar">
|
<div class="sidebar">
|
||||||
<app-sidebar></app-sidebar>
|
<app-sidebar></app-sidebar>
|
||||||
</div>
|
</div>
|
||||||
@@ -34,17 +55,42 @@
|
|||||||
</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>
|
||||||
|
<!-- How far through the song we are, on the border between the two
|
||||||
|
bars (#58). The shell's element rather than either bar's:
|
||||||
|
they are separate components stacked in this grid, so a line
|
||||||
|
on the border between them is a row of it, and neither one has
|
||||||
|
to reach into the other's box for two pixels. It renders
|
||||||
|
nothing above 600px and nothing with no track, is `aria-hidden`
|
||||||
|
(Now Playing's seek bar is what announces the position) and
|
||||||
|
takes no pointer events at all -- a thin line that sometimes
|
||||||
|
seeks is worse than one that never does. -->
|
||||||
|
<player-progress-line></player-progress-line>
|
||||||
<!-- 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
|
||||||
notification-host is: it is the only way to move around the
|
notification-host is: it is the only way to move around the
|
||||||
@@ -55,6 +101,12 @@
|
|||||||
<first-run-wizard></first-run-wizard>
|
<first-run-wizard></first-run-wizard>
|
||||||
<notification-host></notification-host>
|
<notification-host></notification-host>
|
||||||
<shortcuts-overlay></shortcuts-overlay>
|
<shortcuts-overlay></shortcuts-overlay>
|
||||||
|
<!-- The phone's search surface (#57). A singleton here for the
|
||||||
|
reason shortcuts-overlay is one: one instance, one document
|
||||||
|
listener, and no `data-testid="search-input"` resolving to two
|
||||||
|
elements. It renders nothing while shut, so the header's box
|
||||||
|
is still the only one on a desktop. -->
|
||||||
|
<search-dialog></search-dialog>
|
||||||
</body>
|
</body>
|
||||||
|
|
||||||
</html>
|
</html>
|
||||||
|
|||||||
+232
-26
@@ -18,12 +18,25 @@
|
|||||||
// 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';
|
||||||
|
// The phone's progress line (#58), on the border between the mini
|
||||||
|
// player and the tab bar. In the shell for the same reason the volume
|
||||||
|
// is, and eager because it is part of the bottom bar's first paint.
|
||||||
|
import '@components/audio-player/progress-line/progress-line.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';
|
||||||
|
// The phone's search surface (#57). Eager, because below 600px it is
|
||||||
|
// the *only* way to search and a modal that has to fetch a chunk before
|
||||||
|
// it can take a keystroke is late by exactly the interval it exists to
|
||||||
|
// remove. It renders nothing until asked.
|
||||||
|
import '@components/search-dialog/search-dialog.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';
|
||||||
import '@components/notifications/notification-host.ts';
|
import '@components/notifications/notification-host.ts';
|
||||||
@@ -34,12 +47,19 @@ import '@components/confirm-dialog/confirm-dialog.ts';
|
|||||||
// not know what is going on. It costs a dialog and a table.
|
// not know what is going on. It costs a dialog and a table.
|
||||||
import '@components/shortcuts-overlay/shortcuts-overlay.ts';
|
import '@components/shortcuts-overlay/shortcuts-overlay.ts';
|
||||||
import '@components/jobs/job-indicator.ts';
|
import '@components/jobs/job-indicator.ts';
|
||||||
|
// The phone's half of the same thing (#62). Eager because it is part
|
||||||
|
// of the shell's first paint below 600px, and because a band that has
|
||||||
|
// to fetch a chunk before it can say the app is busy is late by
|
||||||
|
// exactly the interval it exists to explain.
|
||||||
|
import '@components/jobs/job-band.ts';
|
||||||
import '@awesome.me/webawesome/dist/styles/themes/default.css';
|
import '@awesome.me/webawesome/dist/styles/themes/default.css';
|
||||||
import '@awesome.me/webawesome/dist/components/icon/icon.js';
|
import '@awesome.me/webawesome/dist/components/icon/icon.js';
|
||||||
import { setBasePath } from '@awesome.me/webawesome/dist/webawesome.js';
|
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 +71,8 @@ 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 { openQueue, queuePanelElement } from '@utils/open-queue';
|
||||||
|
import { installTopBarFit } from './src/services/top-bar-fit';
|
||||||
import {
|
import {
|
||||||
hasTrackPayload,
|
hasTrackPayload,
|
||||||
getDragPayload,
|
getDragPayload,
|
||||||
@@ -70,6 +92,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 +128,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 +145,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,49 +242,132 @@ 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 });
|
||||||
});
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The queue, while it is a screen (#55).
|
||||||
|
*
|
||||||
|
* It is *not* in `VIEW_TAGS` and *not* in `DETAIL_LOADERS`: there is
|
||||||
|
* nothing to mount, because the panel is already in the document and,
|
||||||
|
* as an overlay, already occupies `.main-panel`'s rect exactly. What a
|
||||||
|
* navigation adds is the two things that make a screen a screen — a
|
||||||
|
* history entry, so the platform's back gesture answers it, and a
|
||||||
|
* destination to leave, so navigating anywhere else takes it away.
|
||||||
|
*
|
||||||
|
* Keeping it out of both tables is what keeps its context menu working
|
||||||
|
* on the reference device: `.main-panel > *` is paint-contained and a
|
||||||
|
* `wa-popup` falls back to `position: fixed` on Chrome 113, which
|
||||||
|
* escapes overflow but not containment (#60). The panel stays in
|
||||||
|
* `.content-area`, which is not paint-contained, exactly as it is
|
||||||
|
* today.
|
||||||
|
*/
|
||||||
|
const QUEUE_VIEW = 'queue';
|
||||||
|
|
||||||
|
/** Close a queue that is being navigated away from. A *column* is not
|
||||||
|
* a place, so it survives a navigation the way the sidebar does. */
|
||||||
|
function dismissQueueScreen(): void {
|
||||||
|
const panel = queuePanelElement();
|
||||||
|
|
||||||
|
if (panel?.hasAttribute('overlay')) panel.removeAttribute('open');
|
||||||
|
}
|
||||||
|
|
||||||
async function handleNavigate(
|
async function handleNavigate(
|
||||||
detail: { view: string; [key: string]: any },
|
detail: { view: string; [key: string]: any },
|
||||||
): Promise<void> {
|
): Promise<void> {
|
||||||
@@ -268,6 +379,25 @@ async function handleNavigate(
|
|||||||
|
|
||||||
if (!detail._isBack) recordNavigation(detail);
|
if (!detail._isBack) recordNavigation(detail);
|
||||||
|
|
||||||
|
if (view === QUEUE_VIEW) {
|
||||||
|
// The shell says where the user is; `false` because the queue is
|
||||||
|
// not a primary view, so nothing in either nav lights while it
|
||||||
|
// is up -- the same rule a detail view gets, and the reason the
|
||||||
|
// tab the queue was opened from stays lit.
|
||||||
|
activeViewStore.setView(view, false);
|
||||||
|
queuePanelElement()?.setAttribute('open', '');
|
||||||
|
|
||||||
|
// Deliberately not `searchStore.setCurrentView` and not
|
||||||
|
// `dataset.activeView`: both describe what is *in the main
|
||||||
|
// panel*, and the queue covers that panel without replacing it.
|
||||||
|
// Overwriting either would disable the search box belonging to
|
||||||
|
// the page underneath and make every `data-active-view`
|
||||||
|
// selector in the suite disagree with the element it names.
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
dismissQueueScreen();
|
||||||
|
|
||||||
// Bookkeeping stays synchronous with the click: the search box's
|
// Bookkeeping stays synchronous with the click: the search box's
|
||||||
// scope and the active-view attribute describe the navigation that
|
// scope and the active-view attribute describe the navigation that
|
||||||
// was *asked for*, and are what the rest of the app and the e2e
|
// was *asked for*, and are what the rest of the app and the e2e
|
||||||
@@ -279,6 +409,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 +452,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 +641,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 +662,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 },
|
||||||
}));
|
}));
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -512,13 +682,17 @@ const queuePanel = document.getElementById('queue-panel') as HTMLElement | null;
|
|||||||
|
|
||||||
if (queueButton && queuePanel) {
|
if (queueButton && queuePanel) {
|
||||||
queueButton.addEventListener('click', () => {
|
queueButton.addEventListener('click', () => {
|
||||||
const isOpen = queuePanel.hasAttribute('open');
|
if (queuePanel.hasAttribute('open')) {
|
||||||
|
// Closing goes through the panel either way; where the queue
|
||||||
if (isOpen) {
|
// is a screen the observer below is what unwinds its history
|
||||||
|
// entry, so this button, Escape, the scrim and the close
|
||||||
|
// button all take the same route out.
|
||||||
queuePanel.removeAttribute('open');
|
queuePanel.removeAttribute('open');
|
||||||
} else {
|
|
||||||
queuePanel.setAttribute('open', '');
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
openQueue();
|
||||||
});
|
});
|
||||||
|
|
||||||
// The button says whether the panel is open, and it learns that
|
// The button says whether the panel is open, and it learns that
|
||||||
@@ -536,7 +710,39 @@ if (queueButton && queuePanel) {
|
|||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
new MutationObserver(reflectQueueState).observe(queuePanel, {
|
/**
|
||||||
|
* Keep the back stack honest about a queue that closed itself.
|
||||||
|
*
|
||||||
|
* Where the queue is a screen its `open` attribute and the current
|
||||||
|
* history entry are two statements of one fact, and the panel can
|
||||||
|
* change its half on its own -- Escape, the scrim, the close button,
|
||||||
|
* and anything added later. Reconciling here rather than at each of
|
||||||
|
* those is the same reason this observer already exists for
|
||||||
|
* `aria-expanded`: the attribute is the one fact, and a state kept
|
||||||
|
* beside a click is right until something else changes it.
|
||||||
|
*
|
||||||
|
* Without this the entry is orphaned and the *next* back press is
|
||||||
|
* the one that closes the queue -- a press that appears to do
|
||||||
|
* nothing, which is the defect this issue is about, moved one press
|
||||||
|
* later.
|
||||||
|
*
|
||||||
|
* `history.back()` rather than a stack of our own, for the reason
|
||||||
|
* `navigate-back` does: two stacks is how a component's own way out
|
||||||
|
* and the phone's gesture come to disagree about what one press
|
||||||
|
* means.
|
||||||
|
*/
|
||||||
|
const reconcileQueueHistory = () => {
|
||||||
|
if (queuePanel.hasAttribute('open')) return;
|
||||||
|
|
||||||
|
const state = history.state as NavState | null;
|
||||||
|
|
||||||
|
if (state?.yjNav?.view === QUEUE_VIEW) history.back();
|
||||||
|
};
|
||||||
|
|
||||||
|
new MutationObserver(() => {
|
||||||
|
reflectQueueState();
|
||||||
|
reconcileQueueHistory();
|
||||||
|
}).observe(queuePanel, {
|
||||||
attributes: true,
|
attributes: true,
|
||||||
attributeFilter: ['open'],
|
attributeFilter: ['open'],
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -23,97 +23,23 @@
|
|||||||
* as the literal contains an unterminated `/*`. Nothing else produces
|
* as the literal contains an unterminated `/*`. Nothing else produces
|
||||||
* that, and a legitimate literal cannot contain one.
|
* that, and a legitimate literal cannot contain one.
|
||||||
*/
|
*/
|
||||||
import { readFileSync } from 'node:fs';
|
import { globSync, readFileSync } from 'node:fs';
|
||||||
import { globSync } from 'node:fs';
|
|
||||||
|
import { taggedLiterals } from './css-literals.mjs';
|
||||||
|
|
||||||
const TAGS = ['css', 'html', 'svg'];
|
const TAGS = ['css', 'html', 'svg'];
|
||||||
|
|
||||||
/**
|
|
||||||
* Find the end of a template literal that starts at `start` (the index
|
|
||||||
* of its opening backtick), respecting escapes and `${}` substitutions.
|
|
||||||
* Returns the index of the closing backtick, or -1.
|
|
||||||
*/
|
|
||||||
function endOfTemplate(src, start) {
|
|
||||||
let depth = 0;
|
|
||||||
|
|
||||||
for (let i = start + 1; i < src.length; i++) {
|
|
||||||
const c = src[i];
|
|
||||||
|
|
||||||
if (c === '\\') {
|
|
||||||
i++;
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (c === '$' && src[i + 1] === '{') {
|
|
||||||
depth++;
|
|
||||||
i++;
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (c === '}' && depth > 0) {
|
|
||||||
depth--;
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (c === '`' && depth === 0) return i;
|
|
||||||
}
|
|
||||||
|
|
||||||
return -1;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Strip `${...}` substitutions, which may legitimately contain anything. */
|
|
||||||
function stripSubstitutions(text) {
|
|
||||||
let out = '';
|
|
||||||
let depth = 0;
|
|
||||||
|
|
||||||
for (let i = 0; i < text.length; i++) {
|
|
||||||
if (text[i] === '$' && text[i + 1] === '{') {
|
|
||||||
depth++;
|
|
||||||
i++;
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (text[i] === '}' && depth > 0) {
|
|
||||||
depth--;
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (depth === 0) out += text[i];
|
|
||||||
}
|
|
||||||
|
|
||||||
return out;
|
|
||||||
}
|
|
||||||
|
|
||||||
function lineOf(src, index) {
|
|
||||||
return src.slice(0, index).split('\n').length;
|
|
||||||
}
|
|
||||||
|
|
||||||
const files = globSync('src/**/*.ts', { cwd: process.cwd() });
|
const files = globSync('src/**/*.ts', { cwd: process.cwd() });
|
||||||
const problems = [];
|
const problems = [];
|
||||||
|
|
||||||
for (const file of files) {
|
for (const file of files) {
|
||||||
const src = readFileSync(file, 'utf8');
|
const src = readFileSync(file, 'utf8');
|
||||||
const tagPattern = new RegExp(`(^|[^\\w$.])(${TAGS.join('|')})\``, 'g');
|
|
||||||
|
|
||||||
let match;
|
for (const { tag, body, line } of taggedLiterals(src, TAGS)) {
|
||||||
|
|
||||||
while ((match = tagPattern.exec(src)) !== null) {
|
|
||||||
const open = match.index + match[0].length - 1;
|
|
||||||
const close = endOfTemplate(src, open);
|
|
||||||
|
|
||||||
if (close === -1) continue;
|
|
||||||
|
|
||||||
const body = stripSubstitutions(src.slice(open + 1, close));
|
|
||||||
const opens = (body.match(/\/\*/g) ?? []).length;
|
const opens = (body.match(/\/\*/g) ?? []).length;
|
||||||
const closes = (body.match(/\*\//g) ?? []).length;
|
const closes = (body.match(/\*\//g) ?? []).length;
|
||||||
|
|
||||||
if (opens > closes) {
|
if (opens > closes) problems.push({ file, line, tag });
|
||||||
problems.push({
|
|
||||||
file,
|
|
||||||
line: lineOf(src, open),
|
|
||||||
tag: match[2],
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,79 @@
|
|||||||
|
#!/usr/bin/env node
|
||||||
|
/**
|
||||||
|
* Fail on a nested rule whose selector starts with an element name.
|
||||||
|
*
|
||||||
|
* See `css-nesting.mjs` for what the phone does with one. No tier here
|
||||||
|
* can see it: the component tier, the e2e tier and `make ui-visual` all
|
||||||
|
* run a current Chromium, where the rule applies normally, so the only
|
||||||
|
* report is a screenshot of the device — which is how the bottom bar's
|
||||||
|
* title came to have never truncated there.
|
||||||
|
*
|
||||||
|
* It covers `index.css` and the `css` literals in the components alike,
|
||||||
|
* because a shadow-root stylesheet is parsed by the same engine.
|
||||||
|
*/
|
||||||
|
import { globSync, readFileSync } from 'node:fs';
|
||||||
|
|
||||||
|
import { taggedLiterals } from './css-literals.mjs';
|
||||||
|
import { findBareNestedRules } from './css-nesting.mjs';
|
||||||
|
|
||||||
|
const problems = [];
|
||||||
|
|
||||||
|
// Every stylesheet, not `index.css` by name: the hook that runs this
|
||||||
|
// fires on `frontend/**/*.{ts,css}`, so naming one file promises a
|
||||||
|
// coverage the sweep does not deliver -- a second stylesheet would be
|
||||||
|
// silently unswept while the hook still went green over it. There is
|
||||||
|
// only `index.css` today, which is exactly when this is free to fix.
|
||||||
|
const stylesheets = globSync('*.css', { cwd: process.cwd() });
|
||||||
|
|
||||||
|
if (stylesheets.length === 0) {
|
||||||
|
console.error('css-nesting-check: no stylesheet matched *.css');
|
||||||
|
process.exit(1);
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const file of stylesheets) {
|
||||||
|
for (const { line, selector } of findBareNestedRules(
|
||||||
|
readFileSync(file, 'utf8'),
|
||||||
|
)) {
|
||||||
|
problems.push({ file, line, selector });
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const sources = globSync('src/**/*.ts', { cwd: process.cwd() });
|
||||||
|
|
||||||
|
// A sweep over an empty glob passes, and this one is expected to find
|
||||||
|
// nothing, so "it found nothing" has to mean it looked.
|
||||||
|
if (sources.length === 0) {
|
||||||
|
console.error('css-nesting-check: no sources matched src/**/*.ts');
|
||||||
|
process.exit(1);
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const file of sources) {
|
||||||
|
const src = readFileSync(file, 'utf8');
|
||||||
|
|
||||||
|
for (const literal of taggedLiterals(src, ['css'])) {
|
||||||
|
for (const { line, selector } of findBareNestedRules(literal.body)) {
|
||||||
|
problems.push({ file, line: literal.line + line - 1, selector });
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (problems.length > 0) {
|
||||||
|
for (const p of problems) {
|
||||||
|
console.error(
|
||||||
|
`${p.file}:${p.line}: nested rule "${p.selector.split('\n')[0]}" starts ` +
|
||||||
|
'with an element name — write it as "& ' +
|
||||||
|
`${p.selector.split('\n')[0]}"`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
console.error(
|
||||||
|
`\ncss-nesting-check: ${problems.length} problem(s). ` +
|
||||||
|
'Chrome 113 (the device) drops a nested rule that does not start ' +
|
||||||
|
'with a symbol; the leading & is valid in both syntaxes.',
|
||||||
|
);
|
||||||
|
process.exit(1);
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log(
|
||||||
|
`css-nesting-check: ${stylesheets.length} stylesheet(s) + ${sources.length} files, no bare nested rules`,
|
||||||
|
);
|
||||||
@@ -0,0 +1,103 @@
|
|||||||
|
/**
|
||||||
|
* Finding the `css` tagged templates in a TypeScript source.
|
||||||
|
*
|
||||||
|
* Two checks read them — the unterminated-comment one and the nesting
|
||||||
|
* one — and a second scanner would be a second thing to keep in step
|
||||||
|
* with how a template literal actually ends.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Find the end of a template literal that starts at `start` (the index
|
||||||
|
* of its opening backtick), respecting escapes and `${}` substitutions.
|
||||||
|
* Returns the index of the closing backtick, or -1.
|
||||||
|
*/
|
||||||
|
export function endOfTemplate(src, start) {
|
||||||
|
let depth = 0;
|
||||||
|
|
||||||
|
for (let i = start + 1; i < src.length; i++) {
|
||||||
|
const c = src[i];
|
||||||
|
|
||||||
|
if (c === '\\') {
|
||||||
|
i++;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (c === '$' && src[i + 1] === '{') {
|
||||||
|
depth++;
|
||||||
|
i++;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (c === '}' && depth > 0) {
|
||||||
|
depth--;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (c === '`' && depth === 0) return i;
|
||||||
|
}
|
||||||
|
|
||||||
|
return -1;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Strip `${...}` substitutions, which may legitimately contain anything.
|
||||||
|
*
|
||||||
|
* Newlines inside them are kept, so a line number taken from the
|
||||||
|
* stripped text still names the right line of the file it came from.
|
||||||
|
*/
|
||||||
|
export function stripSubstitutions(text) {
|
||||||
|
let out = '';
|
||||||
|
let depth = 0;
|
||||||
|
|
||||||
|
for (let i = 0; i < text.length; i++) {
|
||||||
|
if (text[i] === '$' && text[i + 1] === '{') {
|
||||||
|
depth++;
|
||||||
|
i++;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (text[i] === '}' && depth > 0) {
|
||||||
|
depth--;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (depth === 0) out += text[i];
|
||||||
|
else if (text[i] === '\n') out += '\n';
|
||||||
|
}
|
||||||
|
|
||||||
|
return out;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The 1-based line number of `index` in `src`. */
|
||||||
|
export function lineOf(src, index) {
|
||||||
|
return src.slice(0, index).split('\n').length;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Every tagged template literal in `src` whose tag is in `tags`.
|
||||||
|
*
|
||||||
|
* `body` has its substitutions stripped and `line` is the line its
|
||||||
|
* opening backtick sits on, so `line + (n - 1)` is the file line of the
|
||||||
|
* body's own line `n`.
|
||||||
|
*/
|
||||||
|
export function taggedLiterals(src, tags) {
|
||||||
|
const pattern = new RegExp(`(^|[^\\w$.])(${tags.join('|')})\``, 'g');
|
||||||
|
const found = [];
|
||||||
|
|
||||||
|
let match;
|
||||||
|
|
||||||
|
while ((match = pattern.exec(src)) !== null) {
|
||||||
|
const open = match.index + match[0].length - 1;
|
||||||
|
const close = endOfTemplate(src, open);
|
||||||
|
|
||||||
|
if (close === -1) continue;
|
||||||
|
|
||||||
|
found.push({
|
||||||
|
tag: match[2],
|
||||||
|
body: stripSubstitutions(src.slice(open + 1, close)),
|
||||||
|
line: lineOf(src, open),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
return found;
|
||||||
|
}
|
||||||
@@ -0,0 +1,119 @@
|
|||||||
|
/**
|
||||||
|
* A nested rule whose selector starts with an element name is silently
|
||||||
|
* dropped on the phone.
|
||||||
|
*
|
||||||
|
* The device renders in Chrome 113, which predates relaxed CSS nesting
|
||||||
|
* (Chrome 120): before that a nested selector had to start with
|
||||||
|
* something that could not be read as the beginning of a declaration,
|
||||||
|
* so `.bottom-bar { audio-player { … } }` is not a parse error anyone
|
||||||
|
* would notice — the inner rule simply does not exist, on the phone and
|
||||||
|
* only on the phone. Three were live in `index.css`, one of them the
|
||||||
|
* `text-overflow: ellipsis` on the bottom bar's title, which had
|
||||||
|
* therefore never truncated on the device.
|
||||||
|
*
|
||||||
|
* `& audio-player` is valid in both syntaxes, so no nested rule here
|
||||||
|
* has any reason to omit it.
|
||||||
|
*
|
||||||
|
* Two things the detection has to get right:
|
||||||
|
*
|
||||||
|
* - **A rule directly inside an at-rule is not nested.**
|
||||||
|
* `@media (…) { bottom-nav { … } }` at the top level is an ordinary
|
||||||
|
* rule and is fine — and it is the majority of the matches a regex
|
||||||
|
* over the file would produce. What decides it is whether a *style*
|
||||||
|
* rule is somewhere above, not what the immediate parent is: inside
|
||||||
|
* `.bar { @media (…) { audio-player { … } } }` the inner rule is
|
||||||
|
* nested, at-rule in between or not.
|
||||||
|
* - **A declaration is not a rule.** `background: url(…)` and any
|
||||||
|
* string or comment can hold a brace, so this tracks them rather than
|
||||||
|
* matching lines.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/** Does this selector start with an identifier, rather than a symbol? */
|
||||||
|
function startsWithIdent(selector) {
|
||||||
|
return /^[A-Za-z_\u00A0-\uFFFF]/.test(selector);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Every nested style rule in `css` whose selector starts with an
|
||||||
|
* element name, as `{ line, selector }` with a 1-based line.
|
||||||
|
*/
|
||||||
|
export function findBareNestedRules(css) {
|
||||||
|
const found = [];
|
||||||
|
/** The blocks we are inside, innermost last: 'style' or 'at'. */
|
||||||
|
const stack = [];
|
||||||
|
/** The text since the last `{`, `}` or `;` — a prelude, if a `{` follows. */
|
||||||
|
let prelude = '';
|
||||||
|
let preludeLine = 1;
|
||||||
|
let line = 1;
|
||||||
|
|
||||||
|
const startPrelude = () => {
|
||||||
|
prelude = '';
|
||||||
|
preludeLine = line;
|
||||||
|
};
|
||||||
|
|
||||||
|
for (let i = 0; i < css.length; i++) {
|
||||||
|
const c = css[i];
|
||||||
|
|
||||||
|
if (c === '\n') {
|
||||||
|
line++;
|
||||||
|
if (prelude.trim() === '') preludeLine = line;
|
||||||
|
prelude += c;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (c === '/' && css[i + 1] === '*') {
|
||||||
|
const end = css.indexOf('*/', i + 2);
|
||||||
|
const comment = css.slice(i, end === -1 ? css.length : end + 2);
|
||||||
|
|
||||||
|
line += (comment.match(/\n/g) ?? []).length;
|
||||||
|
i += comment.length - 1;
|
||||||
|
if (prelude.trim() === '') preludeLine = line;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (c === '"' || c === "'") {
|
||||||
|
let j = i + 1;
|
||||||
|
|
||||||
|
while (j < css.length && css[j] !== c) {
|
||||||
|
if (css[j] === '\\') j++;
|
||||||
|
j++;
|
||||||
|
}
|
||||||
|
|
||||||
|
prelude += css.slice(i, j + 1);
|
||||||
|
i = j;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (c === '{') {
|
||||||
|
const selector = prelude.trim();
|
||||||
|
const kind = selector.startsWith('@') ? 'at' : 'style';
|
||||||
|
|
||||||
|
if (
|
||||||
|
kind === 'style' &&
|
||||||
|
stack.includes('style') &&
|
||||||
|
startsWithIdent(selector)
|
||||||
|
) {
|
||||||
|
found.push({ line: preludeLine, selector });
|
||||||
|
}
|
||||||
|
|
||||||
|
stack.push(kind);
|
||||||
|
startPrelude();
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (c === '}') {
|
||||||
|
stack.pop();
|
||||||
|
startPrelude();
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (c === ';') {
|
||||||
|
startPrelude();
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
prelude += c;
|
||||||
|
}
|
||||||
|
|
||||||
|
return found;
|
||||||
|
}
|
||||||
@@ -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 |
@@ -26,14 +26,15 @@ import {
|
|||||||
contextMenuStyles,
|
contextMenuStyles,
|
||||||
isContextMenuKey,
|
isContextMenuKey,
|
||||||
} from '@utils/context-menu-controller.js';
|
} from '@utils/context-menu-controller.js';
|
||||||
import type { ContextMenuHost } from '@utils/context-menu-controller.js';
|
import type { ContextMenuHost, MenuTarget } from '@utils/context-menu-controller.js';
|
||||||
import { FavoritesController } from '@store/controllers/favorites-controller';
|
import { FavoritesController } from '@store/controllers/favorites-controller';
|
||||||
import { ViewLifecycleMixin } from '@utils/view-lifecycle';
|
import { ViewLifecycleMixin } from '@utils/view-lifecycle';
|
||||||
import { RovingGridController } from '@utils/roving-grid';
|
import { RovingGridController } from '@utils/roving-grid';
|
||||||
|
|
||||||
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/popup/popup.js';
|
||||||
import type WaPopup from '@awesome.me/webawesome/dist/components/popup/popup.js';
|
import type { MenuSurface } from '../menu-surface/menu-surface';
|
||||||
|
import '../menu-surface/menu-surface';
|
||||||
import '@awesome.me/webawesome/dist/components/dropdown-item/dropdown-item.js';
|
import '@awesome.me/webawesome/dist/components/dropdown-item/dropdown-item.js';
|
||||||
import '@components/playlist-picker/playlist-picker.js';
|
import '@components/playlist-picker/playlist-picker.js';
|
||||||
import { dict, list } from '@utils/binding';
|
import { dict, list } from '@utils/binding';
|
||||||
@@ -131,17 +132,17 @@ export class ArtistsView
|
|||||||
private contextMenuArtistId: number | null = null;
|
private contextMenuArtistId: number | null = null;
|
||||||
|
|
||||||
@query('#context-menu')
|
@query('#context-menu')
|
||||||
private contextMenuPopup!: WaPopup;
|
private contextMenuPopup!: MenuSurface;
|
||||||
|
|
||||||
@query('#playlist-submenu')
|
@query('#playlist-submenu')
|
||||||
private playlistSubmenuPopup!: WaPopup;
|
private playlistSubmenuPopup!: MenuSurface;
|
||||||
|
|
||||||
getContextMenuPopup(): WaPopup | undefined {
|
getContextMenuPopup(): MenuTarget | undefined {
|
||||||
return this.contextMenuPopup;
|
return this.contextMenuPopup;
|
||||||
}
|
}
|
||||||
|
|
||||||
getPlaylistSubmenuPopup():
|
getPlaylistSubmenuPopup():
|
||||||
| WaPopup
|
| MenuTarget
|
||||||
| undefined {
|
| undefined {
|
||||||
return this.playlistSubmenuPopup;
|
return this.playlistSubmenuPopup;
|
||||||
}
|
}
|
||||||
@@ -1336,11 +1337,8 @@ export class ArtistsView
|
|||||||
|
|
||||||
private renderContextMenu() {
|
private renderContextMenu() {
|
||||||
return html`
|
return html`
|
||||||
<wa-popup
|
<menu-surface
|
||||||
id="context-menu"
|
id="context-menu"
|
||||||
placement="bottom-start"
|
|
||||||
flip
|
|
||||||
shift
|
|
||||||
.active=${this.ctxMenu
|
.active=${this.ctxMenu
|
||||||
.contextMenuOpen}
|
.contextMenuOpen}
|
||||||
>
|
>
|
||||||
@@ -1434,13 +1432,12 @@ export class ArtistsView
|
|||||||
</div>
|
</div>
|
||||||
`
|
`
|
||||||
: nothing}
|
: nothing}
|
||||||
</wa-popup>
|
</menu-surface>
|
||||||
|
|
||||||
<wa-popup
|
<menu-surface
|
||||||
id="playlist-submenu"
|
id="playlist-submenu"
|
||||||
|
label="Add to playlist"
|
||||||
placement="right-start"
|
placement="right-start"
|
||||||
flip
|
|
||||||
shift
|
|
||||||
.active=${this.ctxMenu
|
.active=${this.ctxMenu
|
||||||
.playlistSubmenuOpen}
|
.playlistSubmenuOpen}
|
||||||
>
|
>
|
||||||
@@ -1468,7 +1465,7 @@ export class ArtistsView
|
|||||||
</div>
|
</div>
|
||||||
`
|
`
|
||||||
: nothing}
|
: nothing}
|
||||||
</wa-popup>
|
</menu-surface>
|
||||||
`;
|
`;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -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>
|
||||||
`;
|
`;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,22 +1,77 @@
|
|||||||
import { LitElement, html, css } from 'lit';
|
import { LitElement, html, css, nothing } from 'lit';
|
||||||
import { customElement, state } from 'lit/decorators.js';
|
import { customElement, property, state } from 'lit/decorators.js';
|
||||||
import '@awesome.me/webawesome/dist/components/icon/icon.js';
|
import '@awesome.me/webawesome/dist/components/icon/icon.js';
|
||||||
import { PlayerController } from '@store/controllers/player-controller';
|
import { PlayerController } from '@store/controllers/player-controller';
|
||||||
import { queueStore } from '@store/queue-store';
|
import { queueStore } from '@store/queue-store';
|
||||||
import type { RepeatMode } from '@store/queue-store';
|
import type { RepeatMode } from '@store/queue-store';
|
||||||
import { designTokens } from '../../../styles/tokens.css';
|
import { designTokens } from '../../../styles/tokens.css';
|
||||||
|
import { PHONE_QUERY } from '../../../utils/breakpoints';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The transport, in the two places it appears.
|
||||||
|
*
|
||||||
|
* **The context is a property and cannot be a media query**, which is
|
||||||
|
* the whole reason this exists (#56). Everywhere else in this app a
|
||||||
|
* component states what it drops at phone width itself, because a media
|
||||||
|
* query inside a shadow root is answered by the viewport and that is
|
||||||
|
* the honest signal. Here the two hosts want *different* answers at the
|
||||||
|
* *same* viewport: on a phone the bottom bar wants three controls sized
|
||||||
|
* for a thumb, and `now-playing-view` wants five, larger still. So the
|
||||||
|
* host says which context and the viewport says which size band, and
|
||||||
|
* neither one alone can express it.
|
||||||
|
*
|
||||||
|
* Measured at the reference device's 424x439 before this: every button
|
||||||
|
* here was **33x21px**, in both places, which is what #56 reports as
|
||||||
|
* "the most important thing in the mobile app and they are tiny".
|
||||||
|
*/
|
||||||
|
export type ControlsContext = 'bar' | 'full';
|
||||||
|
|
||||||
@customElement('player-controls')
|
@customElement('player-controls')
|
||||||
export class PlayerControls extends LitElement {
|
export class PlayerControls extends LitElement {
|
||||||
private player = new PlayerController(this);
|
private player = new PlayerController(this);
|
||||||
private unsubscribeQueue?: () => void;
|
private unsubscribeQueue?: () => void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Where these controls are drawn. `bar` is the bottom bar in both
|
||||||
|
* bands; `full` is the full-screen transport.
|
||||||
|
*
|
||||||
|
* Reflected so a spec can read it and so the stylesheet keys off one
|
||||||
|
* fact rather than a class the host has to remember to set.
|
||||||
|
*/
|
||||||
|
@property({ type: String, reflect: true })
|
||||||
|
context: ControlsContext = 'bar';
|
||||||
|
|
||||||
@state() private shuffleMode = false;
|
@state() private shuffleMode = false;
|
||||||
@state() private repeatMode: RepeatMode = 'off';
|
@state() private repeatMode: RepeatMode = 'off';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Phone width, from `matchMedia` rather than from a media query,
|
||||||
|
* because what it decides is whether shuffle and repeat *exist* here
|
||||||
|
* — and a stylesheet can only decide whether they are painted.
|
||||||
|
* `job-band` and `search-trigger` are the same pattern for the same
|
||||||
|
* reason.
|
||||||
|
*/
|
||||||
|
@state() private phone = false;
|
||||||
|
|
||||||
|
private media?: MediaQueryList;
|
||||||
|
|
||||||
|
private onMedia = (e: MediaQueryListEvent) => {
|
||||||
|
this.phone = e.matches;
|
||||||
|
};
|
||||||
|
|
||||||
|
/** Whether this is the phone's bottom bar, which carries three
|
||||||
|
* controls rather than five. */
|
||||||
|
private get slim(): boolean {
|
||||||
|
return this.context === 'bar' && this.phone;
|
||||||
|
}
|
||||||
|
|
||||||
override connectedCallback(): void {
|
override connectedCallback(): void {
|
||||||
super.connectedCallback();
|
super.connectedCallback();
|
||||||
|
|
||||||
|
this.media = window.matchMedia(PHONE_QUERY);
|
||||||
|
this.phone = this.media.matches;
|
||||||
|
this.media.addEventListener('change', this.onMedia);
|
||||||
|
|
||||||
const s = queueStore.getState();
|
const s = queueStore.getState();
|
||||||
this.shuffleMode = s.shuffleMode;
|
this.shuffleMode = s.shuffleMode;
|
||||||
this.repeatMode = s.repeatMode;
|
this.repeatMode = s.repeatMode;
|
||||||
@@ -37,6 +92,7 @@ export class PlayerControls extends LitElement {
|
|||||||
override disconnectedCallback(): void {
|
override disconnectedCallback(): void {
|
||||||
super.disconnectedCallback();
|
super.disconnectedCallback();
|
||||||
this.unsubscribeQueue?.();
|
this.unsubscribeQueue?.();
|
||||||
|
this.media?.removeEventListener('change', this.onMedia);
|
||||||
}
|
}
|
||||||
|
|
||||||
static override styles = [designTokens, css`
|
static override styles = [designTokens, css`
|
||||||
@@ -58,6 +114,99 @@ export class PlayerControls extends LitElement {
|
|||||||
justify-content: center;
|
justify-content: center;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* ---------------------------------------------------------------
|
||||||
|
Sizes (#56).
|
||||||
|
|
||||||
|
44px is the floor everything here is sized to, and play/pause
|
||||||
|
alone goes above it -- "large play/pause, adequate prev/next" is
|
||||||
|
the Direction, and it is the one control the report calls "front
|
||||||
|
and centre".
|
||||||
|
|
||||||
|
They are stated as custom properties rather than on each button
|
||||||
|
so a context sets two numbers instead of five rules, and so the
|
||||||
|
icon scales with its target: a 44px box around a 16px glyph is a
|
||||||
|
big hit area that still looks tiny, which is half of what the
|
||||||
|
report is about.
|
||||||
|
|
||||||
|
**The desktop bar sets none of them and must not change at all.**
|
||||||
|
#56 is an Android issue; the desktop's buttons are 33x21 before
|
||||||
|
this and are 33x21 after it.
|
||||||
|
|
||||||
|
That is why the box rules take a zero fallback and the *font-size*
|
||||||
|
rules are scoped to the two contexts instead of sharing them. A
|
||||||
|
button does not inherit its font from its parent -- the UA
|
||||||
|
stylesheet gives it one -- so a generic font-size: inherit is
|
||||||
|
not the no-op it reads as: it moved the desktop's buttons from
|
||||||
|
33x21 to 36x24, silently, by taking them from the UA's 13.3px to
|
||||||
|
the shell's 16px. Measured before and after by stashing this
|
||||||
|
file, which is the only way that particular 3px shows up.
|
||||||
|
--------------------------------------------------------------- */
|
||||||
|
button {
|
||||||
|
min-width: var(--yj-control-target, 0);
|
||||||
|
min-height: var(--yj-control-target, 0);
|
||||||
|
}
|
||||||
|
|
||||||
|
button.play {
|
||||||
|
min-width: var(--yj-control-play-target, 0);
|
||||||
|
min-height: var(--yj-control-play-target, 0);
|
||||||
|
}
|
||||||
|
|
||||||
|
/* The phone's bottom bar: three controls, sized for a thumb.
|
||||||
|
Shuffle and repeat are not here -- see the render method, which
|
||||||
|
does not draw them rather than hiding them, because a control
|
||||||
|
that is display:none is still a thing the component claims to
|
||||||
|
have. They are on the full-screen view, which is one tap away
|
||||||
|
through the mini player's art (#59). */
|
||||||
|
@media (max-width: 599px) {
|
||||||
|
:host([context='bar']) {
|
||||||
|
--yj-control-target: 44px;
|
||||||
|
--yj-control-icon: 18px;
|
||||||
|
--yj-control-play-target: 56px;
|
||||||
|
--yj-control-play-icon: 24px;
|
||||||
|
}
|
||||||
|
|
||||||
|
:host([context='bar']) button {
|
||||||
|
font-size: var(--yj-control-icon);
|
||||||
|
}
|
||||||
|
|
||||||
|
:host([context='bar']) button.play {
|
||||||
|
font-size: var(--yj-control-play-icon);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/* The full-screen transport, at every width: this view *is* the
|
||||||
|
player, so the controls are the page rather than a strip of it. */
|
||||||
|
:host([context='full']) {
|
||||||
|
--yj-control-target: 44px;
|
||||||
|
--yj-control-icon: 20px;
|
||||||
|
--yj-control-play-target: 64px;
|
||||||
|
--yj-control-play-icon: 28px;
|
||||||
|
}
|
||||||
|
|
||||||
|
:host([context='full']) button {
|
||||||
|
font-size: var(--yj-control-icon);
|
||||||
|
}
|
||||||
|
|
||||||
|
:host([context='full']) button.play {
|
||||||
|
font-size: var(--yj-control-play-icon);
|
||||||
|
}
|
||||||
|
|
||||||
|
:host([context='full']) #player-control-buttons {
|
||||||
|
gap: 12px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Secondary controls sit below the primary row rather than beside
|
||||||
|
it, which is the Direction's shape and is why this is a second
|
||||||
|
group in the DOM instead of a CSS order property: visual order
|
||||||
|
and focus order have to agree. */
|
||||||
|
.secondary {
|
||||||
|
display: flex;
|
||||||
|
justify-content: center;
|
||||||
|
align-items: center;
|
||||||
|
gap: 24px;
|
||||||
|
margin-top: 8px;
|
||||||
|
}
|
||||||
|
|
||||||
button:hover {
|
button:hover {
|
||||||
color: var(--yj-accent-text, #ffd43b);
|
color: var(--yj-accent-text, #ffd43b);
|
||||||
}
|
}
|
||||||
@@ -104,46 +253,107 @@ export class PlayerControls extends LitElement {
|
|||||||
queueStore.cycleRepeat();
|
queueStore.cycleRepeat();
|
||||||
};
|
};
|
||||||
|
|
||||||
override render() {
|
/** Shuffle. Secondary: it changes how the queue behaves rather than
|
||||||
const playOrPauseIcon = this.player.isPlaying ? 'pause' : 'play';
|
* what is playing now. */
|
||||||
const playOrPauseHandler = this.player.isPlaying
|
private renderShuffle() {
|
||||||
? this.handlePauseClick
|
return html`
|
||||||
: this.handlePlayClick;
|
<button
|
||||||
|
class=${this.shuffleMode ? 'active' : ''}
|
||||||
|
aria-label="Shuffle"
|
||||||
|
aria-pressed=${this.shuffleMode}
|
||||||
|
@click=${this.handleShuffleClick}
|
||||||
|
>
|
||||||
|
<wa-icon name="shuffle"></wa-icon>
|
||||||
|
</button>
|
||||||
|
`;
|
||||||
|
}
|
||||||
|
|
||||||
const shuffleClass = this.shuffleMode ? 'active' : '';
|
/** Repeat, whose label spells the mode out because one icon covers
|
||||||
|
* three states. */
|
||||||
|
private renderRepeat() {
|
||||||
const repeatMode = this.repeatMode;
|
const repeatMode = this.repeatMode;
|
||||||
const repeatClasses = [
|
const repeatClasses = [
|
||||||
repeatMode !== 'off' ? 'active' : '',
|
repeatMode !== 'off' ? 'active' : '',
|
||||||
repeatMode === 'one' ? 'repeat-one' : '',
|
repeatMode === 'one' ? 'repeat-one' : '',
|
||||||
].filter(Boolean).join(' ');
|
].filter(Boolean).join(' ');
|
||||||
|
|
||||||
|
return html`
|
||||||
|
<button
|
||||||
|
class=${repeatClasses}
|
||||||
|
aria-label=${`Repeat: ${repeatMode}`}
|
||||||
|
aria-pressed=${repeatMode !== 'off'}
|
||||||
|
@click=${this.handleRepeatClick}
|
||||||
|
>
|
||||||
|
<wa-icon name="repeat"></wa-icon>
|
||||||
|
</button>
|
||||||
|
`;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Previous, play/pause, next — the three that are always drawn, in
|
||||||
|
* every context and at every width. Only play/pause takes the large
|
||||||
|
* size: the Direction asks for "large play/pause, adequate
|
||||||
|
* prev/next", and a row of identical squares says every action here
|
||||||
|
* is equally likely, which is not true of play. */
|
||||||
|
private renderPrimary() {
|
||||||
|
const playOrPauseIcon = this.player.isPlaying ? 'pause' : 'play';
|
||||||
|
const playOrPauseHandler = this.player.isPlaying
|
||||||
|
? this.handlePauseClick
|
||||||
|
: this.handlePlayClick;
|
||||||
|
|
||||||
|
return html`
|
||||||
|
<button
|
||||||
|
aria-label="Previous track"
|
||||||
|
@click=${this.handlePreviousClick}
|
||||||
|
>
|
||||||
|
<wa-icon name="backward-step"></wa-icon>
|
||||||
|
</button>
|
||||||
|
<button
|
||||||
|
class="play"
|
||||||
|
aria-label=${this.player.isPlaying ? 'Pause' : 'Play'}
|
||||||
|
@click="${playOrPauseHandler}"
|
||||||
|
>
|
||||||
|
<wa-icon name=${playOrPauseIcon}></wa-icon>
|
||||||
|
</button>
|
||||||
|
<button
|
||||||
|
aria-label="Next track"
|
||||||
|
@click=${this.handleNextClick}
|
||||||
|
>
|
||||||
|
<wa-icon name="forward-step"></wa-icon>
|
||||||
|
</button>
|
||||||
|
`;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Two arrangements, not two components.
|
||||||
|
*
|
||||||
|
* `bar` keeps the order it has always had — shuffle, prev, play,
|
||||||
|
* next, repeat, one row — so nothing about the desktop bar moves.
|
||||||
|
* `full` puts the primary three on their own row with the secondary
|
||||||
|
* pair beneath, which the Direction asks for.
|
||||||
|
*
|
||||||
|
* **The phone's bar draws three buttons rather than hiding two.** A
|
||||||
|
* `display: none` control is still in the component's shadow root,
|
||||||
|
* still in the accessibility tree's markup, and still something a
|
||||||
|
* `shadowAll('button')[4]` finds — so "the phone has three controls"
|
||||||
|
* would be true of the pixels and false of the element. They are
|
||||||
|
* reachable on the full-screen view, which the mini player's art
|
||||||
|
* opens, and through the global shortcuts.
|
||||||
|
*/
|
||||||
|
override render() {
|
||||||
|
if (this.context === 'full') {
|
||||||
|
return html`
|
||||||
|
<div id="player-control-buttons">${this.renderPrimary()}</div>
|
||||||
|
<div class="secondary">
|
||||||
|
${this.renderShuffle()}${this.renderRepeat()}
|
||||||
|
</div>
|
||||||
|
`;
|
||||||
|
}
|
||||||
|
|
||||||
return html`
|
return html`
|
||||||
<div id="player-control-buttons">
|
<div id="player-control-buttons">
|
||||||
<button
|
${this.slim ? nothing : this.renderShuffle()}
|
||||||
class=${shuffleClass}
|
${this.renderPrimary()}
|
||||||
aria-label="Shuffle"
|
${this.slim ? nothing : this.renderRepeat()}
|
||||||
aria-pressed=${this.shuffleMode}
|
|
||||||
@click=${this.handleShuffleClick}
|
|
||||||
>
|
|
||||||
<wa-icon name="shuffle"></wa-icon>
|
|
||||||
</button>
|
|
||||||
<button aria-label="Previous track" @click=${this.handlePreviousClick}>
|
|
||||||
<wa-icon name="backward-step"></wa-icon>
|
|
||||||
</button>
|
|
||||||
<button aria-label=${this.player.isPlaying ? 'Pause' : 'Play'} @click="${playOrPauseHandler}">
|
|
||||||
<wa-icon name=${playOrPauseIcon}></wa-icon>
|
|
||||||
</button>
|
|
||||||
<button aria-label="Next track" @click=${this.handleNextClick}>
|
|
||||||
<wa-icon name="forward-step"></wa-icon>
|
|
||||||
</button>
|
|
||||||
<button
|
|
||||||
class=${repeatClasses}
|
|
||||||
aria-label=${`Repeat: ${repeatMode}`}
|
|
||||||
aria-pressed=${repeatMode !== 'off'}
|
|
||||||
@click=${this.handleRepeatClick}
|
|
||||||
>
|
|
||||||
<wa-icon name="repeat"></wa-icon>
|
|
||||||
</button>
|
|
||||||
</div>
|
</div>
|
||||||
`;
|
`;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,204 @@
|
|||||||
|
import { LitElement, html, css, nothing } from 'lit';
|
||||||
|
import { customElement, state } from 'lit/decorators.js';
|
||||||
|
|
||||||
|
import { PlayerController } from '@store/controllers/player-controller';
|
||||||
|
import { designTokens } from '../../../styles/tokens.css';
|
||||||
|
import { PHONE_QUERY } from '../../../utils/breakpoints';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* How far through the song we are, on the border between the mini
|
||||||
|
* player and the tab bar (#58).
|
||||||
|
*
|
||||||
|
* The phone's bottom bar carries three controls and no seek bar — plan
|
||||||
|
* 016 B2 took it out, because 4px of height is not a thumb target and the
|
||||||
|
* full-screen `now-playing-view` is where seeking belongs. What went
|
||||||
|
* with it is the one thing a mini player is expected to say without
|
||||||
|
* being opened: how far through the song it is. This is that, and
|
||||||
|
* only that.
|
||||||
|
*
|
||||||
|
* Four things about it are load-bearing.
|
||||||
|
*
|
||||||
|
* **It is the shell's element, not either bar's.** The mini player and
|
||||||
|
* `<bottom-nav>` are separate components stacked in the shell's grid,
|
||||||
|
* so a line on the border between them is a row of the grid — either
|
||||||
|
* one drawing it means reaching into the other's box for two pixels.
|
||||||
|
*
|
||||||
|
* **It never counts.** The position is pushed at 1 Hz by the backend
|
||||||
|
* (`PlaybackPositionChanged`), and the interval here interpolates
|
||||||
|
* *between* those reports and is stopped and restarted by every one of
|
||||||
|
* them — the seek bar's rule, for the reason the seek bar has it: a
|
||||||
|
* local clock drifted 30 s away from the backend across four keyboard
|
||||||
|
* seeks. The `trackChangeId` and `seq` guards come along for the same
|
||||||
|
* reason: the store is a singleton, so a report about the previous
|
||||||
|
* track must not be adopted, and the same second reported twice still
|
||||||
|
* has to reset the interpolation.
|
||||||
|
*
|
||||||
|
* **It is not a control and cannot become one.** `aria-hidden` on the
|
||||||
|
* host and `pointer-events: none` throughout: the real progress is
|
||||||
|
* announced by the seek bar on Now Playing, and a 2px strip on the top
|
||||||
|
* edge of the tab bar that sometimes seeks is worse than one that
|
||||||
|
* never does. It is also where a thumb aiming at a tab lands.
|
||||||
|
*
|
||||||
|
* **It renders nothing above 600px**, from `matchMedia` rather than a
|
||||||
|
* media query, because that decides whether the element *exists* — and
|
||||||
|
* with it whether a 1 Hz interval runs for the life of every desktop
|
||||||
|
* session about a line nobody can see. `job-band`, `search-trigger`
|
||||||
|
* and `player-controls` are the same pattern for the same reason.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The reporting cadence, matched. This is not the clock: it exists
|
||||||
|
* only so the line moves in the second between two reports, and its
|
||||||
|
* error is discarded by the next one rather than carried.
|
||||||
|
*/
|
||||||
|
const InterpolationIntervalMillis = 1000;
|
||||||
|
|
||||||
|
@customElement('player-progress-line')
|
||||||
|
export class PlayerProgressLine extends LitElement {
|
||||||
|
private player = new PlayerController(this);
|
||||||
|
|
||||||
|
/** Phone width. See the class comment: existence, not paint. */
|
||||||
|
@state() private phone = false;
|
||||||
|
|
||||||
|
/** Seconds into the track, from the last report plus interpolation. */
|
||||||
|
@state() private elapsed = 0;
|
||||||
|
|
||||||
|
private previousTrackChangeId = -1;
|
||||||
|
|
||||||
|
/** The sequence number of the last backend report applied. */
|
||||||
|
private previousPositionSeq = -1;
|
||||||
|
|
||||||
|
private timerID = -1;
|
||||||
|
|
||||||
|
private media?: MediaQueryList;
|
||||||
|
|
||||||
|
private onMedia = (e: MediaQueryListEvent) => {
|
||||||
|
this.phone = e.matches;
|
||||||
|
};
|
||||||
|
|
||||||
|
static override styles = [
|
||||||
|
designTokens,
|
||||||
|
css`
|
||||||
|
:host {
|
||||||
|
display: block;
|
||||||
|
/* Not a target, at any depth. */
|
||||||
|
pointer-events: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.track {
|
||||||
|
height: 2px;
|
||||||
|
background-color: var(--yj-bg-surface, #212529);
|
||||||
|
}
|
||||||
|
|
||||||
|
.fill {
|
||||||
|
height: 100%;
|
||||||
|
background-color: var(--yj-accent, #ffd43b);
|
||||||
|
/* scaleX off a full-width box rather than a width in
|
||||||
|
percent, so the moving thing is a transform and the
|
||||||
|
line costs no layout once a second. */
|
||||||
|
transform-origin: left center;
|
||||||
|
}
|
||||||
|
`,
|
||||||
|
];
|
||||||
|
|
||||||
|
private get trackLength(): number {
|
||||||
|
return this.player.currentTrack?.trackLength ?? 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
override connectedCallback(): void {
|
||||||
|
super.connectedCallback();
|
||||||
|
|
||||||
|
// Decorative in full: the seek bar on Now Playing is what
|
||||||
|
// announces the position, and this says the same thing without
|
||||||
|
// a name, a value or a way to act on it.
|
||||||
|
this.setAttribute('aria-hidden', 'true');
|
||||||
|
|
||||||
|
this.media = window.matchMedia(PHONE_QUERY);
|
||||||
|
this.phone = this.media.matches;
|
||||||
|
this.media.addEventListener('change', this.onMedia);
|
||||||
|
}
|
||||||
|
|
||||||
|
override disconnectedCallback(): void {
|
||||||
|
super.disconnectedCallback();
|
||||||
|
this.stopInterpolating();
|
||||||
|
this.media?.removeEventListener('change', this.onMedia);
|
||||||
|
}
|
||||||
|
|
||||||
|
override updated(): void {
|
||||||
|
// A track change resets the line, and `trackChangeId` is what
|
||||||
|
// reveals one when the same file plays twice in a row.
|
||||||
|
const currentChangeId = this.player.currentTrack?.trackChangeId ?? -1;
|
||||||
|
|
||||||
|
if (currentChangeId !== this.previousTrackChangeId) {
|
||||||
|
this.previousTrackChangeId = currentChangeId;
|
||||||
|
this.elapsed = this.player.currentTrack?.seekPosition ?? 0;
|
||||||
|
this.stopInterpolating();
|
||||||
|
}
|
||||||
|
|
||||||
|
// The backend's own position wins over anything counted here,
|
||||||
|
// and a report for a track that is no longer loaded is stale by
|
||||||
|
// definition.
|
||||||
|
const position = this.player.position;
|
||||||
|
|
||||||
|
if (
|
||||||
|
position &&
|
||||||
|
position.trackChangeId === currentChangeId &&
|
||||||
|
position.seq !== this.previousPositionSeq
|
||||||
|
) {
|
||||||
|
this.previousPositionSeq = position.seq;
|
||||||
|
this.elapsed = position.positionSeconds;
|
||||||
|
this.stopInterpolating();
|
||||||
|
}
|
||||||
|
|
||||||
|
// One owner for the interval, as in `seek-bar`: everything that
|
||||||
|
// wants it started or stopped says so by changing state that
|
||||||
|
// brings us back here.
|
||||||
|
if (this.phone && this.player.isPlaying && currentChangeId !== -1) {
|
||||||
|
this.startInterpolating();
|
||||||
|
} else {
|
||||||
|
this.stopInterpolating();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private stopInterpolating(): void {
|
||||||
|
if (this.timerID !== -1) {
|
||||||
|
clearInterval(this.timerID);
|
||||||
|
this.timerID = -1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private startInterpolating(): void {
|
||||||
|
if (this.timerID !== -1) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
this.timerID = window.setInterval(() => {
|
||||||
|
if (this.elapsed < this.trackLength) {
|
||||||
|
this.elapsed += 1;
|
||||||
|
}
|
||||||
|
}, InterpolationIntervalMillis);
|
||||||
|
}
|
||||||
|
|
||||||
|
override render() {
|
||||||
|
// Nothing playing is nothing to say, and the grid row is `auto`
|
||||||
|
// so an empty render costs no height at all -- `job-band`'s
|
||||||
|
// rule one row down.
|
||||||
|
if (!this.phone || this.player.currentTrack === null) return nothing;
|
||||||
|
|
||||||
|
const length = this.trackLength;
|
||||||
|
const fraction =
|
||||||
|
length > 0 ? Math.min(1, Math.max(0, this.elapsed / length)) : 0;
|
||||||
|
|
||||||
|
return html`
|
||||||
|
<div class="track" data-testid="progress-line">
|
||||||
|
<div class="fill" style="transform: scaleX(${fraction})"></div>
|
||||||
|
</div>
|
||||||
|
`;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
declare global {
|
||||||
|
interface HTMLElementTagNameMap {
|
||||||
|
'player-progress-line': PlayerProgressLine;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -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;
|
||||||
|
|||||||
@@ -1,9 +1,10 @@
|
|||||||
import { LitElement, html, css } 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/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,32 @@ 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;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether there is a volume of ours to control at all (#64).
|
||||||
|
*
|
||||||
|
* The decision is made here rather than at either mount point,
|
||||||
|
* because there are two -- the bottom bar's copy lives in
|
||||||
|
* `index.html`, which has no module scope to make it conditional --
|
||||||
|
* and one of them is a control the shell cannot un-render. So the
|
||||||
|
* control answers for itself, and the bar and the phone's
|
||||||
|
* full-screen transport get the same answer without either knowing
|
||||||
|
* the question exists.
|
||||||
|
*
|
||||||
|
* It renders `nothing` *and* hides the host: an empty shadow root is
|
||||||
|
* what stops a positional or role query finding a button that cannot
|
||||||
|
* act, and `:host([hidden])` is what stops the element occupying a
|
||||||
|
* flex item's worth of the transport -- the `:host` display above
|
||||||
|
* outranks the UA's `[hidden]` rule, so it has to be said.
|
||||||
|
*/
|
||||||
|
@state()
|
||||||
|
private available = volumeStyleStore.available;
|
||||||
|
|
||||||
|
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
|
||||||
@@ -36,6 +63,13 @@ export class VolumeControl extends LitElement {
|
|||||||
align-items: center;
|
align-items: center;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* See the available field. A gap is only drawn between boxes,
|
||||||
|
so a hidden host costs its parent nothing -- which is where the
|
||||||
|
29px this gives back to Now Playing comes from (#172). */
|
||||||
|
:host([hidden]) {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
button {
|
button {
|
||||||
background: none;
|
background: none;
|
||||||
border: none;
|
border: none;
|
||||||
@@ -86,11 +120,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 +176,26 @@ export class VolumeControl extends LitElement {
|
|||||||
// LIFECYCLE
|
// LIFECYCLE
|
||||||
// ===================================================================
|
// ===================================================================
|
||||||
|
|
||||||
|
override connectedCallback() {
|
||||||
|
super.connectedCallback();
|
||||||
|
|
||||||
|
this.unsubscribeStyle = volumeStyleStore.subscribe(() => {
|
||||||
|
this.popup = volumeStyleStore.popup;
|
||||||
|
this.setAvailable(volumeStyleStore.available);
|
||||||
|
|
||||||
|
// 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();
|
||||||
|
});
|
||||||
|
|
||||||
|
this.setAvailable(volumeStyleStore.available);
|
||||||
|
|
||||||
|
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 +226,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) {
|
||||||
@@ -189,21 +263,67 @@ export class VolumeControl extends LitElement {
|
|||||||
// RENDER
|
// RENDER
|
||||||
// ===================================================================
|
// ===================================================================
|
||||||
|
|
||||||
|
/**
|
||||||
|
* `hidden` is set imperatively rather than reflected from the state,
|
||||||
|
* because it has to be on the *host* and a `@state` does not reflect.
|
||||||
|
* It is the right attribute besides: it takes the element out of the
|
||||||
|
* accessibility tree as well as out of the layout.
|
||||||
|
*/
|
||||||
|
private setAvailable(available: boolean) {
|
||||||
|
this.available = available;
|
||||||
|
this.hidden = !available;
|
||||||
|
|
||||||
|
// A popup left open when the control goes away would keep its
|
||||||
|
// document click listener installed for markup that no longer
|
||||||
|
// renders.
|
||||||
|
if (!available) this.closeSlider();
|
||||||
|
}
|
||||||
|
|
||||||
override render() {
|
override render() {
|
||||||
|
if (!this.available) return nothing;
|
||||||
|
|
||||||
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>
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user