Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
cfec242e33 |
@@ -158,7 +158,7 @@ only climb when it cannot.
|
|||||||
| You changed | Run | Cost |
|
| You changed | Run | Cost |
|
||||||
|---|---|---|
|
|---|---|---|
|
||||||
| A Lit component, a store, the shortcut service | `make ui-test` | ~2 s, no app |
|
| A Lit component, a store, the shortcut service | `make ui-test` | ~2 s, no app |
|
||||||
| …and it renders differently | `make ui-visual` | + 10 baselines, opt-in, never gates |
|
| …and it renders differently | `make ui-visual` | + 6 baselines, opt-in |
|
||||||
| Any Go code | `make test` | 3 passes, ~2 min |
|
| Any Go code | `make test` | 3 passes, ~2 min |
|
||||||
| A service that emits events | `make test` — assert on the payload, see `backend/queue/emit_test.go` | in-process, no app |
|
| A service that emits events | `make test` — assert on the payload, see `backend/queue/emit_test.go` | in-process, no app |
|
||||||
| A bound method or a bound struct field | `make bindings` then `make ui-test` | ~1.5 s + 2 s |
|
| A bound method or a bound struct field | `make bindings` then `make ui-test` | ~1.5 s + 2 s |
|
||||||
@@ -180,13 +180,6 @@ less than it looks.)
|
|||||||
|
|
||||||
Two rules about climbing:
|
Two rules about climbing:
|
||||||
|
|
||||||
- **If you moved a component's geometry, run `make ui-visual` and
|
|
||||||
refresh that component's baseline in the same commit.** Nothing else
|
|
||||||
will: it is the one tier in this repo no hook and no CI job runs, and
|
|
||||||
it cannot be one — its references are machine-specific, measured in
|
|
||||||
[references/ui-tier.md](references/ui-tier.md). Four of them drifted
|
|
||||||
across three merges before anyone noticed (#196). Read the image;
|
|
||||||
never bless a reference you did not cause.
|
|
||||||
- **A component test passing is not the app rendering.** If you touched
|
- **A component test passing is not the app rendering.** If you touched
|
||||||
anything in `frontend/src`, verify it in the real app too — start it
|
anything in `frontend/src`, verify it in the real app too — start it
|
||||||
headless, `screenshot --filename=/tmp/shot.png`, and *read the PNG*.
|
headless, `screenshot --filename=/tmp/shot.png`, and *read the PNG*.
|
||||||
|
|||||||
@@ -78,58 +78,9 @@ synchronously.
|
|||||||
Microtasks and not a timer, deliberately: a timer hangs forever under
|
Microtasks and not a timer, deliberately: a timer hangs forever under
|
||||||
the suites that install fake ones.
|
the suites that install fake ones.
|
||||||
|
|
||||||
## The visual tier does not gate, and that is measured (#196)
|
Visual baselines are font-hinting and compositing sensitive, which is
|
||||||
|
why they are opt-in: they only mean anything on the machine that
|
||||||
`make ui-visual` is the same suite with nine `toMatchScreenshot`
|
recorded them.
|
||||||
baselines switched on. **Nothing runs it but a person**, deliberately,
|
|
||||||
and the reason is a number rather than a preference: the committed
|
|
||||||
baselines were recorded on Arch, and replayed in a bare `ubuntu:24.04`
|
|
||||||
container — CI's `check` image — three of them fail for reasons that
|
|
||||||
have nothing to do with any component.
|
|
||||||
|
|
||||||
| baseline | Arch | ubuntu:24.04 |
|
|
||||||
|---|---|---|
|
|
||||||
| `page-header` filtered-by-search | passes | ratio 0.03 differ, against a 0.02 allowance |
|
|
||||||
| `track-info` | passes | ratio 0.03 differ |
|
|
||||||
| `seek-bar` | 1152×18 | 1152×17 |
|
|
||||||
|
|
||||||
The two references that were genuinely stale did not even agree about
|
|
||||||
their *new* size — `now-playing` renders 1152×65 on Arch and 1152×64 in
|
|
||||||
the container. So moving CI's `check` job from `make ui-test` to
|
|
||||||
`make ui-visual` is not a one-line change: it needs a second,
|
|
||||||
container-recorded baseline set, which every local run would then fail
|
|
||||||
against. That is the same trap the other way round, and a pre-push hook
|
|
||||||
is the same fault again — one machine's baselines against everybody
|
|
||||||
else's renderer.
|
|
||||||
|
|
||||||
So the tier stays local and opt-in, and the rule that replaces the gate
|
|
||||||
is:
|
|
||||||
|
|
||||||
- **A change that moves a component's geometry refreshes that
|
|
||||||
component's reference in the same commit, having read the image.**
|
|
||||||
Look at the PNG; the dimensions in the failure message are the cheap
|
|
||||||
half of the answer.
|
|
||||||
- **Never refresh a reference you did not cause.** #196 exists because
|
|
||||||
four of them drifted across three unrelated merges, and every red run
|
|
||||||
made the next person likelier to stop running the tier than to read
|
|
||||||
it.
|
|
||||||
- **State the world the shot is taken in.** The stores are singletons,
|
|
||||||
so a visual case that sets nothing photographs whatever the previous
|
|
||||||
case left behind — which is how the sidebar's baseline came to have
|
|
||||||
Tracks lit and `now-playing`'s to be playing from a dynamic mix.
|
|
||||||
- **Record one file with `make ui-visual-update UI_ARGS=<path>`**, and
|
|
||||||
check `git status` before committing either way. That filter is only
|
|
||||||
honoured since #204: the recipe was a bare `--update`, and vitest
|
|
||||||
takes the following positional as the flag's value, so the path was
|
|
||||||
swallowed and *every* baseline was re-recorded — blessing any stale
|
|
||||||
one in silence.
|
|
||||||
|
|
||||||
What the tier is worth, for the record: it is a *layout* check, blind to
|
|
||||||
colour (the component tier has no `:root`, so it renders the fallbacks —
|
|
||||||
`make ui-visual` passed unchanged through a whole palette rewrite,
|
|
||||||
twice), and it has caught one thing nothing else could — swapping
|
|
||||||
`library-status-indicator`'s `<button>` for a `<span>` lost the UA
|
|
||||||
stylesheet's `box-sizing` and grew the badge 36→38px.
|
|
||||||
|
|
||||||
## Bindings
|
## Bindings
|
||||||
|
|
||||||
|
|||||||
@@ -4913,88 +4913,6 @@ disabled — it gates on a directory chosen *in the wizard*, and the
|
|||||||
existing-library check runs once, on mount. A reload clears it. Nothing
|
existing-library check runs once, on mount. A reload clears it. Nothing
|
||||||
is broken; it cost twenty minutes of believing a tap had been swallowed.
|
is broken; it cost twenty minutes of believing a tap had been swallowed.
|
||||||
|
|
||||||
## The sheet's scroll fade, and where a scrim may not go (measured 2026-08-23, headless)
|
|
||||||
|
|
||||||
#207's answer. The affordance is two background layers on
|
|
||||||
`wa-dialog::part(body)` and the conditionality is
|
|
||||||
`background-attachment`, not a scroll listener: a cover of the sheet's
|
|
||||||
own colour painted at the end of the *content* (`local`) over a shadow
|
|
||||||
pinned to the box (`scroll`), so the cover scrolls up and hides the
|
|
||||||
shadow exactly when there is nothing more to see.
|
|
||||||
|
|
||||||
Measured at 424x360 (which is where a menu overflows on `main`, since
|
|
||||||
`main` does not yet carry #67's eighth item — at 424x439 the track
|
|
||||||
list's seven items are `scrollHeight` 364 against `clientHeight` 364,
|
|
||||||
fitting exactly). Pixel at x=300, dark ramp, `bgElevated` `#343a40`:
|
|
||||||
|
|
||||||
| y | before | more below | at the end of the list |
|
|
||||||
|---|---|---|---|
|
|
||||||
| 330 | 52,58,64 | 50,56,62 | 52,58,64 |
|
|
||||||
| 340 | 52,58,64 | 43,48,53 | 52,58,64 |
|
|
||||||
| 350 | 52,58,64 | 33,37,40 | 52,58,64 |
|
|
||||||
| 359 | 52,58,64 | 22,24,27 | 52,58,64 |
|
|
||||||
|
|
||||||
Three things worth keeping.
|
|
||||||
|
|
||||||
**A menu that fits draws nothing**, which is the same measurement: at
|
|
||||||
424x439 the sheet is flat 52,58,64 to its bottom edge, because with no
|
|
||||||
overflow the `local` layer's positioning area *is* the padding box and
|
|
||||||
the cover lands on top of the shadow.
|
|
||||||
|
|
||||||
**A scrim over a menu row is that row's text surface**, so the 4.5:1
|
|
||||||
rule reaches it and this is why the curve is steep rather than linear.
|
|
||||||
A row is 48px with its label centred; 32px of scrim already down to a
|
|
||||||
quarter strength at 14px puts about 0.06 at the label. Checked on the
|
|
||||||
light ramp (`bgElevated` `#e9ecef`, text `#212529`) by overriding the
|
|
||||||
two custom properties on `:root`: background at the label 205,207,210,
|
|
||||||
which is **9.9:1**. The first draft — a linear 48px at 0.8 — put ~0.375
|
|
||||||
on that label, 5.0:1, passing but visibly greyed. The bottom few pixels
|
|
||||||
go to ~2.4:1 in either draft and are deliberately below where any
|
|
||||||
label of a *fully visible* row sits; a label that lands there belongs
|
|
||||||
to the half-cut row, which is the thing being signalled.
|
|
||||||
|
|
||||||
**A dark scrim on a dark surface reads far worse in a shrunk screenshot
|
|
||||||
than on screen.** The first two probes (24px/0.45, then 32px/0.75) were
|
|
||||||
measurably present — 52,58,64 down to 30,33,37 — and invisible in the
|
|
||||||
inline preview. Crop the bottom 70px and scale it up before judging;
|
|
||||||
the pixel values are the honest answer either way.
|
|
||||||
|
|
||||||
## The phone's context sheet is now longer than the phone (measured 2026-08-23, headless at 424x439)
|
|
||||||
|
|
||||||
#67 moves two destinations into every row menu, and the track list's
|
|
||||||
menu is where that runs out of screen. Measured against the running
|
|
||||||
app at the reference viewport, one row selected:
|
|
||||||
|
|
||||||
| menu | items | first item top | last item bottom |
|
|
||||||
|---|---|---|---|
|
|
||||||
| queue panel | 7 | 95 | 431 |
|
|
||||||
| track list | 8 | 86 | **470** |
|
|
||||||
|
|
||||||
The viewport is 439. So the track list's last item — "Remove from
|
|
||||||
Library" — is below the fold. It is **not unreachable**: the sheet is a
|
|
||||||
`wa-dialog` whose body is `overflow-y: auto`, measured `scrollHeight`
|
|
||||||
412 against `clientHeight` 373, and scrolling it 39px brings that item
|
|
||||||
fully into view (383–431). What it has is no *affordance*: nothing on
|
|
||||||
screen says the list continues.
|
|
||||||
|
|
||||||
Two things worth knowing before adding a ninth item anywhere.
|
|
||||||
|
|
||||||
**The limit was already reached, and this is what crossed it.** Seven
|
|
||||||
48px rows in a 373px body is 364px — the queue's menu fits with 8px to
|
|
||||||
spare and the track list's fitted exactly. Any item added to any of the
|
|
||||||
fourteen menus after #60 was going to be the one that overflowed; the
|
|
||||||
first one simply happened to be this.
|
|
||||||
|
|
||||||
**The measurement has to be taken with a row selected**, since the
|
|
||||||
`Go to` items are drawn for a single selection only, and on the *first*
|
|
||||||
track of the fixture library — which has no album (`01 Tone A`,
|
|
||||||
`02 Tone B`) — only "Go to Artist" appears. That is the 8 above; an
|
|
||||||
ordinary track makes it 9.
|
|
||||||
|
|
||||||
Filed as its own issue rather than fixed in #67's diff: it is a
|
|
||||||
property of the shared sheet (`components/menu-surface/`), not of the
|
|
||||||
items.
|
|
||||||
|
|
||||||
## The tap highlight is one inherited declaration (measured 2026-08-24)
|
## The tap highlight is one inherited declaration (measured 2026-08-24)
|
||||||
|
|
||||||
`-webkit-tap-highlight-color` is an **inherited** property, and an
|
`-webkit-tap-highlight-color` is an **inherited** property, and an
|
||||||
@@ -5029,52 +4947,3 @@ Findings offer it for the 300ms tap delay; this app's viewport is
|
|||||||
the stated benefit is not there to win. What it would change is the
|
the stated benefit is not there to win. What it would change is the
|
||||||
gesture stack #63 tuned by measurement on the device (`pan-y` plus a
|
gesture stack #63 tuned by measurement on the device (`pan-y` plus a
|
||||||
non-passive `preventDefault`), and that is not measurable from here.
|
non-passive `preventDefault`), and that is not measurable from here.
|
||||||
|
|
||||||
## Art pop-in is measurable in a browser, if you count frames rather than milliseconds (measured 2026-08-24)
|
|
||||||
|
|
||||||
#65 is an Android report ("scrolling through albums, the art pops in")
|
|
||||||
and the desktop harness can measure it, which was not obvious: the
|
|
||||||
first attempt waited 220 ms after each scroll jump and found **zero**
|
|
||||||
blank covers on either build. The metric only discriminates at one and
|
|
||||||
two animation frames after the jump, which is where a pop-in actually
|
|
||||||
lives.
|
|
||||||
|
|
||||||
Protocol, on `make dev-headless SEED=bulk` (4 988 albums), ten
|
|
||||||
2 400px jumps of `.grid-scroll-container`, counting covers whose rect
|
|
||||||
intersects the viewport with `naturalWidth === 0`:
|
|
||||||
|
|
||||||
| build | blank at frame 1 | at frame 2 | at 50 ms |
|
|
||||||
|---|---|---|---|
|
|
||||||
| `main` | 254 / 258 | 214 / 258 | 0 |
|
|
||||||
| `main`, second run | 254 / 258 | 190 / 258 | 0 |
|
|
||||||
| prefetch | 117 / 258 | 77 / 258 | 0 |
|
|
||||||
| prefetch, second run | 118 / 258 | 96 / 258 | 0 |
|
|
||||||
|
|
||||||
Two things this protocol gets wrong if repeated carelessly. **A second
|
|
||||||
run in the same browser session measures the HTTP cache**, not the
|
|
||||||
build — the skill already warns about this for `make perf`, and it
|
|
||||||
applies to any image measurement; every row above is a fresh
|
|
||||||
`playwright-cli close` + `open`. And **the frontend is embedded**, so
|
|
||||||
comparing builds is a `git stash` *and* a rebuild, not a stash.
|
|
||||||
|
|
||||||
**The bulk library's covers are 300x300 and ~3.7 kB**, which is why
|
|
||||||
both builds are clean by 50 ms here and why the phone's number cannot
|
|
||||||
be inferred from this one — same caveat the skill already records
|
|
||||||
about full-size artwork.
|
|
||||||
|
|
||||||
**`rangeChanged` and `visibilityChanged` are different ranges**, and
|
|
||||||
the difference is the whole of this fix's value.
|
|
||||||
`@lit-labs/virtualizer` reports `_first`/`_last` (rendered, including
|
|
||||||
the ~1000px overhang) on the former and `_firstVisible`/`_lastVisible`
|
|
||||||
on the latter. Both grids listen to `visibilityChanged` for scroll
|
|
||||||
persistence, which wants the visible range and is correct; a prefetch
|
|
||||||
window measured from it lands mostly on cards that already exist.
|
|
||||||
Anchored there, the component test could see only one row past the
|
|
||||||
last rendered card.
|
|
||||||
|
|
||||||
**`_overhang` is not configurable.** It is a `protected` field set to
|
|
||||||
1000 in `BaseLayout` and read by every layout; there is no option on
|
|
||||||
`grid()`/`flow()` and no property on the element. The issue's Direction
|
|
||||||
("ask the virtualizer for a larger overscan") is therefore not
|
|
||||||
available without patching a private, which is why the request is
|
|
||||||
issued ahead of the element instead.
|
|
||||||
|
|||||||
@@ -262,26 +262,6 @@ real store code. A binding carries an **ID**, not a name
|
|||||||
`yellowjacket/backend/home.Service.GetShelves`), so the fake derives
|
`yellowjacket/backend/home.Service.GetShelves`), so the fake derives
|
||||||
that map from the generated tree rather than writing it down.
|
that map from the generated tree rather than writing it down.
|
||||||
|
|
||||||
**A test file does not get its own origin, so `setup.ts` clears
|
|
||||||
`localStorage` between tests.** `@vitest/browser-playwright` opens one
|
|
||||||
BrowserContext per session and runs several files in it one after
|
|
||||||
another, so everything a component persists — the track list's sort and
|
|
||||||
column widths, the cover size, `now-playing`'s scroll mode — is still
|
|
||||||
there when the next file mounts the same component. Which files share a
|
|
||||||
tab, and in what order, changes run to run, so the symptom is a spec
|
|
||||||
that fails about one test in three and passes every time it is run on
|
|
||||||
its own: #138 cost three scheduled runs, one of them a PR whose diff
|
|
||||||
held no frontend code at all. Measured on the build before the fix, a
|
|
||||||
single full run started **24** tests with storage already set. Two
|
|
||||||
things follow. The clear is safe precisely because the leak is
|
|
||||||
sequential — files in a session do not overlap, so it cannot wipe
|
|
||||||
storage a concurrently-running file is in the middle of using — and it
|
|
||||||
belongs in `setup.ts` rather than in the specs that write, because the
|
|
||||||
spec that *reads* is never the one that knows. And a spec whose
|
|
||||||
assertion depends on an order still **states that order** rather than
|
|
||||||
inheriting a default, or the next change to a default is the same
|
|
||||||
mystery again.
|
|
||||||
|
|
||||||
**`frontend/bindings/` is generated by `wails3`, not `go generate`**, so
|
**`frontend/bindings/` is generated by `wails3`, not `go generate`**, so
|
||||||
the pre-commit codegen check does not cover it. `make bindings-check`
|
the pre-commit codegen check does not cover it. `make bindings-check`
|
||||||
(~3.5 s warm, ~20 s on a cold build cache, also a pre-commit hook)
|
(~3.5 s warm, ~20 s on a cold build cache, also a pre-commit hook)
|
||||||
@@ -1113,9 +1093,9 @@ not the fix and cannot be: that function is the `document` listener for
|
|||||||
`navigate`, so it is an infinite loop.
|
`navigate`, so it is an infinite loop.
|
||||||
|
|
||||||
**It is a store rather than an event, because a component that mounts
|
**It is a store rather than an event, because a component that mounts
|
||||||
after a navigation still has to know.** `bottom-nav`'s "More" sheet
|
after a navigation still has to know.** `bottom-nav`'s "More" drawer
|
||||||
creates its `<app-sidebar>` on open, and that copy had heard no
|
creates its `<app-sidebar>` on open, and that copy had heard no
|
||||||
`navigate` at all — standing on Albums, it opened highlighting
|
`navigate` at all — standing on Albums, the drawer opened highlighting
|
||||||
Home. An event has no answer for a listener that was not there.
|
Home. An event has no answer for a listener that was not there.
|
||||||
|
|
||||||
**A detail view is not a view here**, so the destination it was opened
|
**A detail view is not a view here**, so the destination it was opened
|
||||||
@@ -1216,7 +1196,7 @@ and then vanishing.
|
|||||||
than a general rule about phones.** `PHONE_COLUMN_IDS` is the precedent
|
than a general rule about phones.** `PHONE_COLUMN_IDS` is the precedent
|
||||||
for "what a phone shows is a different question", and it would apply —
|
for "what a phone shows is a different question", and it would apply —
|
||||||
except that `bottom-nav`'s "More" opens the *same* `<app-sidebar>`,
|
except that `bottom-nav`'s "More" opens the *same* `<app-sidebar>`,
|
||||||
which filters, so an unfiltered bar would contradict its own sheet one
|
which filters, so an unfiltered bar would contradict its own drawer one
|
||||||
tap away. Which four tabs is still plan 016's committed subset; this
|
tap away. Which four tabs is still plan 016's committed subset; this
|
||||||
only removes from it, and "More" is never filtered because it is how
|
only removes from it, and "More" is never filtered because it is how
|
||||||
everything else stays reachable.
|
everything else stays reachable.
|
||||||
@@ -1422,7 +1402,7 @@ descendants. On the reference device the main panel spans 0-318 of a
|
|||||||
items cut off, with no way to reach them. `showModal()` is Chrome 37
|
items cut off, with no way to reach them. `showModal()` is Chrome 37
|
||||||
and uses the real top layer, so a dialog is immune by construction.
|
and uses the real top layer, so a dialog is immune by construction.
|
||||||
|
|
||||||
Seven things about it are load-bearing.
|
Six things about it are load-bearing.
|
||||||
|
|
||||||
**"Dialogs are fine" needed checking, because every other dialog in
|
**"Dialogs are fine" needed checking, because every other dialog in
|
||||||
this app is mounted in `index.html`** — outside `.main-panel` — so it
|
this app is mounted in `index.html`** — outside `.main-panel` — so it
|
||||||
@@ -1451,25 +1431,6 @@ doing nothing, which reads as the gesture breaking. `menu-dismiss` is
|
|||||||
that signal; the three surfaces that do not use `ContextMenuController`
|
that signal; the three surfaces that do not use `ContextMenuController`
|
||||||
bind it themselves.
|
bind it themselves.
|
||||||
|
|
||||||
**A sheet that scrolls says so, and `background-attachment` is what
|
|
||||||
asks whether it does** (#207). The sheet is capped at 85vh — a surface
|
|
||||||
covering the whole screen is a page, not a sheet — so a long menu's
|
|
||||||
body scrolls, and for three phases it scrolled *silently*: measured at
|
|
||||||
424x439, eight items ended at y=470 with the fold at 439, and where the
|
|
||||||
cut lands on a row boundary the sheet ends in a clean edge that reads
|
|
||||||
as the end of the list. The fade is two background layers on
|
|
||||||
`wa-dialog::part(body)` — a shadow pinned to the box (`scroll`) under a
|
|
||||||
cover of the sheet's own colour painted at the end of the *content*
|
|
||||||
(`local`), which scrolls up over the shadow exactly when there is
|
|
||||||
nothing more to see. So it is absent on a menu that fits, present the
|
|
||||||
moment one does not, and gone again at the end of the list, with no
|
|
||||||
scroll listener and nothing reaching into `wa-dialog`'s shadow root for
|
|
||||||
the scroller. **The curve is steep because the rows under it stay
|
|
||||||
live**: a scrim over a menu item is that item's text surface, and the
|
|
||||||
4.5:1 rule applies to it — 32px already down to a quarter strength at
|
|
||||||
14px spends its weight below the last legible label, measured at 9.9:1
|
|
||||||
on the light ramp, whose `bgElevated` is `#e9ecef`.
|
|
||||||
|
|
||||||
**The playlist submenu is a sheet too, and it had to be.** It is a
|
**The playlist submenu is a sheet too, and it had to be.** It is a
|
||||||
`placement="right-start"` flyout, and making the menu full-width moved
|
`placement="right-start"` flyout, and making the menu full-width moved
|
||||||
its anchor — measured at x −182 to 0, entirely off-screen, so "Add to
|
its anchor — measured at x −182 to 0, entirely off-screen, so "Add to
|
||||||
@@ -1874,7 +1835,7 @@ listing the destinations again — but rendering it unconditionally put a
|
|||||||
second copy of every `data-testid="nav-*"` in the DOM, and 30 existing
|
second copy of every `data-testid="nav-*"` in the DOM, and 30 existing
|
||||||
specs failed with "strict mode violation: resolved to 2 elements" on a
|
specs failed with "strict mode violation: resolved to 2 elements" on a
|
||||||
desktop viewport where the element is not even visible. It renders only
|
desktop viewport where the element is not even visible. It renders only
|
||||||
while the sheet is open, and `bottom-nav.test.ts` asserts its absence
|
while the drawer is open, and `bottom-nav.test.ts` asserts its absence
|
||||||
before that.
|
before that.
|
||||||
|
|
||||||
**The tab bar is four destinations and a way to the rest.** Three to
|
**The tab bar is four destinations and a way to the rest.** Three to
|
||||||
@@ -1883,33 +1844,6 @@ is 32px each. Which four is plan 016's committed subset, and everything
|
|||||||
else — Settings included, because a phone still needs it — is behind
|
else — Settings included, because a phone still needs it — is behind
|
||||||
"More".
|
"More".
|
||||||
|
|
||||||
**And "More" rises from the bottom, on #60's sheet rather than a
|
|
||||||
second one** (#71). It was a `wa-drawer placement="start"`: a 200px
|
|
||||||
column of a 424px screen, opening away from the thumb that asked for
|
|
||||||
it, with the rest of its 400px band empty. It is the *same element*
|
|
||||||
with `placement="bottom"` and `without-header`, which is what keeps
|
|
||||||
the change to where it comes from — `wa-drawer` renders a native
|
|
||||||
`<dialog>` and opens it with `showModal()`, so #60's containment
|
|
||||||
finding carries over with nothing new to prove, and the focus trap,
|
|
||||||
Escape, tap-outside and `wa-after-hide` all come along. Measured at
|
|
||||||
424x439: 424 wide, 373 tall (85vh, so there is an outside to tap),
|
|
||||||
48px rows.
|
|
||||||
|
|
||||||
Three things about it are load-bearing. **The sidebar is mounted
|
|
||||||
rather than re-listed as data**, which the issue offers as the
|
|
||||||
alternative: the shell's own `<app-sidebar>` is `display: none` below
|
|
||||||
600px rather than removed, so a second list drawing `nav-*` handles is
|
|
||||||
the duplication above, and it would be a second place to add the next
|
|
||||||
view to. **There is one scroller, and it is the sheet's body** — the
|
|
||||||
reported "only part of the screen scrolls under my finger" is three
|
|
||||||
nested ones (the dialog, its body, and the sidebar's own
|
|
||||||
`overflow-y: auto` host), so which box a drag moves depends on where
|
|
||||||
the finger landed; `overscroll-behavior: contain` is the other half.
|
|
||||||
And **`expanded` means the host owns the box, not just the labels**:
|
|
||||||
`app-sidebar` writes an *inline* width and caps itself at 400px, which
|
|
||||||
beats any rule the host could write, so the width, the scrolling and
|
|
||||||
the mouse-only resize handle all follow that attribute.
|
|
||||||
|
|
||||||
**There are three supported size bands, and the queue is part of the
|
**There are three supported size bands, and the queue is part of the
|
||||||
promise.** Plan 018 (#24) wrote them down: **Phone** below 600 (bottom
|
promise.** Plan 018 (#24) wrote them down: **Phone** below 600 (bottom
|
||||||
nav, reflows, fits 320px exactly), **Compact** 600–899 (icon sidebar),
|
nav, reflows, fits 320px exactly), **Compact** 600–899 (icon sidebar),
|
||||||
@@ -2447,31 +2381,6 @@ a list or a detail view:
|
|||||||
and dropped if a second click arrives, because the title is the
|
and dropped if a second click arrives, because the title is the
|
||||||
widest thing in a row and double-clicking a row plays it. Rows do
|
widest thing in a row and double-clicking a row plays it. Rows do
|
||||||
not need to know links exist.
|
not need to know links exist.
|
||||||
|
|
||||||
**Below 600px a name is not a link, and the row's menu is where it
|
|
||||||
went** (#67). Every sentence above is a *desktop* compromise: the
|
|
||||||
double-click grace means nothing on touch, a few characters of text
|
|
||||||
is not a touch target, and since #63 a claimed `yj-tap` has its click
|
|
||||||
swallowed, so the link was unreachable as well as fiddly. The rule is
|
|
||||||
in the utility rather than at twenty call sites, and
|
|
||||||
`utils/go-to-menu.ts` is the other half — "Go to Artist" / "Go to
|
|
||||||
Album", drawn under exactly the condition the link is not, from
|
|
||||||
`explore-link`'s own exported routing so an untagged artist reaches
|
|
||||||
the library page by the same lookup.
|
|
||||||
|
|
||||||
Three things about it are load-bearing. **Suppressing a link without
|
|
||||||
a menu behind it is not a smaller affordance**, it is a destination
|
|
||||||
the phone cannot reach — so `keepOnPhone` is the documented exception
|
|
||||||
for the three surfaces with no row menu (`now-playing-view`,
|
|
||||||
`explore-album-details`' header credit, `top-results-row`), and
|
|
||||||
nothing else may pass it. **One row or none**: the items are the Play
|
|
||||||
item's rule one step on, since "go to the album" of five different
|
|
||||||
albums means nothing. And **there is no "Go to Genre"**, because
|
|
||||||
there is no genre link anywhere to lose — that would be new
|
|
||||||
navigation rather than a replacement, and belongs in its own issue.
|
|
||||||
`track-list` is the one list that gains rather than moves: its phone
|
|
||||||
column set stacks title over artist as plain text already, so those
|
|
||||||
names have never been links there.
|
|
||||||
- **`<catalog-scope-notice>`** is how a detail page admits what it is
|
- **`<catalog-scope-notice>`** is how a detail page admits what it is
|
||||||
showing: catalog data (silent), a library stand-in while a fetch is
|
showing: catalog data (silent), a library stand-in while a fetch is
|
||||||
in flight, library-only because the entity has no MBID, or a failed/
|
in flight, library-only because the entity has no MBID, or a failed/
|
||||||
@@ -2685,38 +2594,11 @@ Five things about it are load-bearing, and four of them fail silently:
|
|||||||
correctly. Confidently wrong is worse than absent here, which is the
|
correctly. Confidently wrong is worse than absent here, which is the
|
||||||
same rule `Known` exists for.
|
same rule `Known` exists for.
|
||||||
|
|
||||||
One gap this did not close and #104 did: **`dhowden/tag` has no RIFF
|
One gap this did not close, and it is older: **`dhowden/tag` has no
|
||||||
reader**, so nothing the tag writer put in a WAV's `id3 ` chunk was
|
RIFF reader**, so nothing the tag writer puts in a WAV's `id3 ` chunk
|
||||||
visible to `metadata.ExtractTags` — not the totals and not the title
|
is visible to `metadata.ExtractTags` — not the totals and not the title
|
||||||
either, on files the app itself had just tagged. `wav_test.go` read
|
either. `wav_test.go` reads that chunk itself, which is why no test
|
||||||
that chunk itself, which is why no test noticed: a round trip asserted
|
ever noticed.
|
||||||
through the writer's own parser is a test of the writer.
|
|
||||||
|
|
||||||
`backend/riff` is where the container is now read, and it is its own
|
|
||||||
package because the alternative is an import cycle — `tagwriter`
|
|
||||||
imports `metadata`, so `metadata` cannot reach back for `parseRIFF`.
|
|
||||||
`backend/tagtotals` is the precedent.
|
|
||||||
|
|
||||||
Three things about it are load-bearing. **The two readers are
|
|
||||||
deliberately different**: `Parse` holds every chunk in memory, which is
|
|
||||||
what rewriting a file needs, and a WAV's audio *is* a chunk — so the
|
|
||||||
scan path uses `ID3Chunk`, which seeks over what it is not looking for.
|
|
||||||
**The container decides, before `tag.ReadFrom` rather than after it
|
|
||||||
fails**, because that library's last resort is an ID3v1 trailer and a
|
|
||||||
WAV carrying both would otherwise be read by the wrong one. And **an
|
|
||||||
untagged WAV is a file with no tags, not a file with a problem**: no
|
|
||||||
chunk, an RF64 container or a tag holding no frames all read as empty
|
|
||||||
metadata with no `TagReadWarning`, since the scanner's filename
|
|
||||||
fallback is the right answer and a warning would put a fault on a file
|
|
||||||
that has none.
|
|
||||||
|
|
||||||
The gap was pinned by a test that said so, which failed the moment the
|
|
||||||
reader learned and carried the instructions for what to update in its
|
|
||||||
own comment. So it is deleted, `TestFixturesMatchManifest` no longer
|
|
||||||
skips `wav`, and `totals_test.go`'s WAV case goes through
|
|
||||||
`metadata.ExtractTags` like the other three formats. The fixture
|
|
||||||
library's two WAV tracks scan with their tags and their cover now,
|
|
||||||
which is a change to what every seeded tier sees.
|
|
||||||
|
|
||||||
**The absence is what gets marked, not the presence.** The tracklist
|
**The absence is what gets marked, not the presence.** The tracklist
|
||||||
put a green tick against every owned track and a legend underneath
|
put a green tick against every owned track and a legend underneath
|
||||||
@@ -3403,46 +3285,6 @@ rather than searching it — the store replaces that array when its
|
|||||||
contents change and shares the unchanged members, which is the same
|
contents change and shares the unchanged members, which is the same
|
||||||
signal `track-list`'s memoized caches key on.
|
signal `track-list`'s memoized caches key on.
|
||||||
|
|
||||||
**And the right tier arriving late still reads as no art at all**, so
|
|
||||||
the two grids ask for it before the card exists (#65).
|
|
||||||
`utils/image-prefetch.ts` warms the images a scroll is about to reach,
|
|
||||||
from `cover-grid`'s and `artists-view`'s virtualizers. Measured on the
|
|
||||||
50 000-track bulk seed over ten 2 400px jumps: of 258 covers arriving
|
|
||||||
in view, **254 were still blank one frame later and 214 two frames
|
|
||||||
later**; with the prefetch, 117 and 77. Both builds are clean by 50 ms
|
|
||||||
on a desktop with 3.7 kB fixture covers, which is where the reference
|
|
||||||
device's slower engine and 27 kB covers spend their pop-in.
|
|
||||||
|
|
||||||
Four things about it are load-bearing.
|
|
||||||
|
|
||||||
**The overscan the obvious fix asks for does not exist.**
|
|
||||||
`@lit-labs/virtualizer`'s `_overhang` is a hard-coded 1000px
|
|
||||||
`protected` field on `BaseLayout` with no configuration surface, so
|
|
||||||
raising it means monkey-patching a private. 1000px is about two
|
|
||||||
screens on a 439px viewport, and the *image* cannot be requested until
|
|
||||||
the card it lives in is rendered — which is what this asks for
|
|
||||||
instead.
|
|
||||||
|
|
||||||
**It hangs off `rangeChanged`, not `visibilityChanged`.** Those report
|
|
||||||
different ranges: visibility is what is on screen, and the virtualizer
|
|
||||||
has already rendered that 1000px past it. Anchored to the visible
|
|
||||||
range the window is spent on cards that already exist and have already
|
|
||||||
asked for their own art — measured as the difference between the
|
|
||||||
prefetch reaching one row past the last card and reaching a full
|
|
||||||
window past it.
|
|
||||||
|
|
||||||
**It is not the `LRUMap` path, and saying so is the bound.** That
|
|
||||||
ceiling holds Explore's base64 data URLs in JS; a library cover is a
|
|
||||||
plain URL under `Cache-Control: immutable` (the filenames are content
|
|
||||||
hashes), so what retains the bytes is the browser's own cache. What
|
|
||||||
this module retains is the *set of URLs already asked for*, capped at
|
|
||||||
512 and reported to `window.__yjCacheStats()` — 497 entries and 15 407
|
|
||||||
chars after the run above.
|
|
||||||
|
|
||||||
**The prefetch asks for what the card will draw.** `artists-view`'s
|
|
||||||
tier ladder moved into `artistAvatarURL()` so the two cannot disagree;
|
|
||||||
a second copy would be a warm cache for a tier nothing renders.
|
|
||||||
|
|
||||||
**The same rule, on the selection path, was the worst stall in the
|
**The same rule, on the selection path, was the worst stall in the
|
||||||
app.** Five components turned selected file paths back into tracks with
|
app.** Five components turned selected file paths back into tracks with
|
||||||
`filePaths.map(fp => tracks.find(…))`, so "Select all → Edit tags" at
|
`filePaths.map(fp => tracks.find(…))`, so "Select all → Edit tags" at
|
||||||
@@ -3627,25 +3469,6 @@ Pre-commit hooks verify generated code is fresh — always run `make generate` a
|
|||||||
Tests use `database.NewTestDB(t)` for in-memory SQLite, built by the same
|
Tests use `database.NewTestDB(t)` for in-memory SQLite, built by the same
|
||||||
`applySchema` production uses so the two cannot diverge. Test audio fixtures live in `test_data/music_library_test/`. Table-driven tests are the norm.
|
`applySchema` production uses so the two cannot diverge. Test audio fixtures live in `test_data/music_library_test/`. Table-driven tests are the norm.
|
||||||
|
|
||||||
**`make ui-visual` is the one tier nothing but a person runs, and it
|
|
||||||
cannot become one.** Its ten `toMatchScreenshot` baselines were recorded
|
|
||||||
on a developer's Arch box; replayed in a bare `ubuntu:24.04` container
|
|
||||||
— CI's `check` image — three of them fail on font metrics and
|
|
||||||
compositing alone (`track-info` and one `page-header` shot at a 0.03
|
|
||||||
mismatch ratio against a 0.02 allowance, `seek-bar` one pixel shorter),
|
|
||||||
and two components disagree about their own height between the two
|
|
||||||
machines. So CI keeps running `make ui-test`, which is the same suite
|
|
||||||
with the comparisons off, and a pre-push hook would be the same fault
|
|
||||||
with the machines swapped. What replaces the gate is a rule, in
|
|
||||||
`.pi/skills/yellowjacket-dev/references/ui-tier.md`: **a change that
|
|
||||||
moves a component's geometry refreshes that component's baseline in the
|
|
||||||
same commit, having read the image, and never one it did not cause**.
|
|
||||||
That is #196, which was four stale references accumulated across three
|
|
||||||
unrelated merges — a red tier nobody could read, which is how it stayed
|
|
||||||
red. A visual case must also **state the world it photographs**, since
|
|
||||||
the stores are singletons and a case that sets nothing records whatever
|
|
||||||
the previous one left in them.
|
|
||||||
|
|
||||||
## Git Workflow
|
## Git Workflow
|
||||||
|
|
||||||
Feature branches and PRs are the only way in: **`main` is a protected
|
Feature branches and PRs are the only way in: **`main` is a protected
|
||||||
|
|||||||
@@ -160,11 +160,8 @@ ui-watch: ## Same suite, in watch mode
|
|||||||
ui-visual: ## Run the suite including screenshot comparisons
|
ui-visual: ## Run the suite including screenshot comparisons
|
||||||
@cd frontend && YJ_VISUAL=1 npx vitest run $(UI_ARGS)
|
@cd frontend && YJ_VISUAL=1 npx vitest run $(UI_ARGS)
|
||||||
|
|
||||||
# `--update=true`, never a bare `--update`: vitest takes the following
|
ui-visual-update: ## Re-record the screenshot baselines
|
||||||
# positional as the flag's value, so `--update <path>` swallows the path
|
@cd frontend && YJ_VISUAL=1 npx vitest run --update $(UI_ARGS)
|
||||||
# and re-records every baseline in the repo instead of the one named.
|
|
||||||
ui-visual-update: ## Re-record the screenshot baselines (UI_ARGS=<path> to filter)
|
|
||||||
@cd frontend && YJ_VISUAL=1 npx vitest run --update=true $(UI_ARGS)
|
|
||||||
|
|
||||||
ui-setup: ## Install the Vitest browser provider's own Chromium (once)
|
ui-setup: ## Install the Vitest browser provider's own Chromium (once)
|
||||||
@cd frontend && pnpm install && npx playwright install chromium
|
@cd frontend && pnpm install && npx playwright install chromium
|
||||||
|
|||||||
@@ -74,14 +74,6 @@ func ExtractTags(path string) (*TrackMetadata, error) {
|
|||||||
|
|
||||||
// ExtractTagsFromReader reads metadata from an io.ReadSeeker.
|
// ExtractTagsFromReader reads metadata from an io.ReadSeeker.
|
||||||
func ExtractTagsFromReader(r io.ReadSeeker) (*TrackMetadata, error) {
|
func ExtractTagsFromReader(r io.ReadSeeker) (*TrackMetadata, error) {
|
||||||
// The container decides, so this is asked before tag.ReadFrom and
|
|
||||||
// not after its failure: a WAV's tags live in a RIFF chunk that
|
|
||||||
// dhowden/tag cannot see, and its fallback -- an ID3v1 trailer --
|
|
||||||
// would otherwise outrank them.
|
|
||||||
if meta, ok := wavTags(r); ok {
|
|
||||||
return meta, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
m, err := tag.ReadFrom(r)
|
m, err := tag.ReadFrom(r)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
// No tags found is not necessarily an error - return empty metadata
|
// No tags found is not necessarily an error - return empty metadata
|
||||||
|
|||||||
@@ -1,68 +0,0 @@
|
|||||||
package metadata
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"strings"
|
|
||||||
|
|
||||||
"yellowjacket/backend/riff"
|
|
||||||
)
|
|
||||||
|
|
||||||
// wavTags reads the ID3v2 tag a WAV carries in its RIFF "id3 " chunk,
|
|
||||||
// which is where backend/tagwriter puts it and where dhowden/tag --
|
|
||||||
// having no RIFF reader at all -- cannot look. Without this a WAV
|
|
||||||
// scans as an untagged file however carefully it was tagged.
|
|
||||||
//
|
|
||||||
// ok is false when r is not a RIFF/WAVE container, and the read
|
|
||||||
// position is restored either way so the caller can carry on.
|
|
||||||
func wavTags(r io.ReadSeeker) (*TrackMetadata, bool) {
|
|
||||||
start, err := r.Seek(0, io.SeekCurrent)
|
|
||||||
if err != nil {
|
|
||||||
return nil, false
|
|
||||||
}
|
|
||||||
|
|
||||||
id3Data, chunkErr := riff.ID3Chunk(r)
|
|
||||||
|
|
||||||
if _, err := r.Seek(start, io.SeekStart); err != nil {
|
|
||||||
return nil, false
|
|
||||||
}
|
|
||||||
|
|
||||||
switch {
|
|
||||||
case chunkErr == nil:
|
|
||||||
return wavTagsFrom(id3Data), true
|
|
||||||
|
|
||||||
// Not ours to read: let the ordinary dispatch have the file.
|
|
||||||
case errors.Is(chunkErr, riff.ErrNotRIFF), errors.Is(chunkErr, riff.ErrNotWAVE):
|
|
||||||
return nil, false
|
|
||||||
|
|
||||||
// A RIFF container we cannot get a tag out of -- no chunk, an RF64
|
|
||||||
// file, a truncated header. That is a file with no readable tags,
|
|
||||||
// which is what the scanner's filename fallback is for.
|
|
||||||
default:
|
|
||||||
return &TrackMetadata{}, true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// wavTagsFrom parses the bytes of a WAV's ID3v2 chunk.
|
|
||||||
func wavTagsFrom(id3Data []byte) *TrackMetadata {
|
|
||||||
meta, err := extractID3v2Lenient(bytes.NewReader(id3Data))
|
|
||||||
if err != nil {
|
|
||||||
// A tag holding no frames is not a damaged tag: writing every
|
|
||||||
// field back out empty leaves one, and warning about it would
|
|
||||||
// put a fault on a file that has none.
|
|
||||||
if errors.Is(err, ErrTagsUnreadable) {
|
|
||||||
return &TrackMetadata{}
|
|
||||||
}
|
|
||||||
|
|
||||||
return &TrackMetadata{
|
|
||||||
TagReadWarning: fmt.Errorf("%w: %w", ErrTagsUnreadable, err),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// extractID3v2Lenient names MP3, being the recovery path for one.
|
|
||||||
meta.FileFormat = strings.ToUpper(strings.TrimPrefix(string(WAV), "."))
|
|
||||||
|
|
||||||
return meta
|
|
||||||
}
|
|
||||||
@@ -1,186 +0,0 @@
|
|||||||
// Package riff reads the chunk layout of a RIFF/WAVE container.
|
|
||||||
//
|
|
||||||
// It exists because both halves of WAV tagging need it and neither can
|
|
||||||
// import the other: backend/tagwriter writes a WAV's tags into a RIFF
|
|
||||||
// "id3 " chunk and already imports backend/metadata, which is what has
|
|
||||||
// to read them back out. backend/tagtotals is the precedent.
|
|
||||||
//
|
|
||||||
// The two readers here are deliberately different. Parse holds every
|
|
||||||
// chunk's data in memory, which is what rewriting a file needs; a WAV's
|
|
||||||
// audio *is* the "data" chunk, so doing that on the scan path would
|
|
||||||
// read every library file in full. ID3Chunk seeks over what it is not
|
|
||||||
// looking for instead. Both walk the same headers.
|
|
||||||
package riff
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"encoding/binary"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Sentinel errors describing a container this package will not read.
|
|
||||||
var (
|
|
||||||
ErrRF64NotSupported = errors.New("RF64 files are not yet supported")
|
|
||||||
ErrNotRIFF = errors.New("not a RIFF file")
|
|
||||||
ErrNotWAVE = errors.New("not a WAVE file")
|
|
||||||
ErrNoID3Chunk = errors.New("no ID3 chunk in RIFF file")
|
|
||||||
)
|
|
||||||
|
|
||||||
// Chunk holds a single RIFF sub-chunk (ID + raw data).
|
|
||||||
type Chunk struct {
|
|
||||||
ID [4]byte
|
|
||||||
Data []byte
|
|
||||||
}
|
|
||||||
|
|
||||||
// IsID3 reports whether id is that of an ID3v2 RIFF chunk. Both
|
|
||||||
// lowercase "id3 " and uppercase "ID3 " are accepted.
|
|
||||||
func IsID3(id [4]byte) bool {
|
|
||||||
return strings.ToLower(string(id[:3])) == "id3"
|
|
||||||
}
|
|
||||||
|
|
||||||
// Parse reads every RIFF sub-chunk from r, in order, starting at the
|
|
||||||
// reader's current position. It rejects RF64 files and non-WAVE
|
|
||||||
// containers with descriptive errors. The parser is lenient: it
|
|
||||||
// tolerates a missing final padding byte and ignores the declared
|
|
||||||
// RIFF size.
|
|
||||||
func Parse(r io.Reader) ([]Chunk, error) {
|
|
||||||
if err := readContainer(r); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
var chunks []Chunk
|
|
||||||
|
|
||||||
for {
|
|
||||||
id, size, err := nextHeader(r)
|
|
||||||
if errors.Is(err, io.EOF) {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Copied rather than allocated up front, as ID3Chunk does: the
|
|
||||||
// size is four bytes off the file, so a truncated one is free to
|
|
||||||
// declare a chunk larger than the whole of itself.
|
|
||||||
var data bytes.Buffer
|
|
||||||
if _, err := io.CopyN(&data, r, int64(size)); err != nil {
|
|
||||||
return nil, fmt.Errorf("read chunk data for %q: %w", id, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
chunks = append(chunks, Chunk{ID: id, Data: data.Bytes()})
|
|
||||||
|
|
||||||
// Odd-length chunks have a padding byte. Lenient: if the
|
|
||||||
// read fails (e.g. EOF), just break rather than error.
|
|
||||||
if size%2 != 0 {
|
|
||||||
var pad [1]byte
|
|
||||||
|
|
||||||
if _, err := r.Read(pad[:]); err != nil {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return chunks, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// ID3Chunk returns the payload of the ID3v2 chunk of the RIFF/WAVE
|
|
||||||
// container at the reader's current position, seeking over every other
|
|
||||||
// chunk rather than reading it. It returns ErrNoID3Chunk when the
|
|
||||||
// container carries no such chunk, and leaves the read position
|
|
||||||
// unspecified either way.
|
|
||||||
func ID3Chunk(r io.ReadSeeker) ([]byte, error) {
|
|
||||||
if err := readContainer(r); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
for {
|
|
||||||
id, size, err := nextHeader(r)
|
|
||||||
if errors.Is(err, io.EOF) {
|
|
||||||
return nil, ErrNoID3Chunk
|
|
||||||
}
|
|
||||||
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
if !IsID3(id) {
|
|
||||||
// Odd-length chunks carry a padding byte. Seeking past
|
|
||||||
// the end of the file is not an error; the next header
|
|
||||||
// read is what reports the end.
|
|
||||||
if _, err := r.Seek(int64(size)+int64(size%2), io.SeekCurrent); err != nil {
|
|
||||||
return nil, fmt.Errorf("skip chunk %q: %w", id, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
// Copied rather than allocated up front: a truncated file is
|
|
||||||
// free to declare a chunk larger than the whole of itself.
|
|
||||||
var data bytes.Buffer
|
|
||||||
if _, err := io.CopyN(&data, r, int64(size)); err != nil {
|
|
||||||
return nil, fmt.Errorf("read chunk data for %q: %w", id, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return data.Bytes(), nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// readContainer consumes the 12-byte RIFF/WAVE header at the reader's
|
|
||||||
// current position.
|
|
||||||
func readContainer(r io.Reader) error {
|
|
||||||
var magic [4]byte
|
|
||||||
if _, err := io.ReadFull(r, magic[:]); err != nil {
|
|
||||||
return fmt.Errorf("read RIFF magic: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if string(magic[:]) == "RF64" {
|
|
||||||
return ErrRF64NotSupported
|
|
||||||
}
|
|
||||||
|
|
||||||
if string(magic[:]) != "RIFF" {
|
|
||||||
return fmt.Errorf("%w: got %q", ErrNotRIFF, magic)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Read (and discard) RIFF size — lenient, do not enforce.
|
|
||||||
var riffSize uint32
|
|
||||||
if err := binary.Read(r, binary.LittleEndian, &riffSize); err != nil {
|
|
||||||
return fmt.Errorf("read RIFF size: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
var form [4]byte
|
|
||||||
if _, err := io.ReadFull(r, form[:]); err != nil {
|
|
||||||
return fmt.Errorf("read WAVE form type: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if string(form[:]) != "WAVE" {
|
|
||||||
return fmt.Errorf("%w: got %q", ErrNotWAVE, form)
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// nextHeader reads one sub-chunk header. It returns io.EOF once the
|
|
||||||
// chunks are exhausted, including for a header cut short.
|
|
||||||
func nextHeader(r io.Reader) ([4]byte, uint32, error) {
|
|
||||||
var id [4]byte
|
|
||||||
|
|
||||||
_, err := io.ReadFull(r, id[:])
|
|
||||||
if errors.Is(err, io.EOF) || errors.Is(err, io.ErrUnexpectedEOF) {
|
|
||||||
return id, 0, io.EOF
|
|
||||||
}
|
|
||||||
|
|
||||||
if err != nil {
|
|
||||||
return id, 0, fmt.Errorf("read chunk ID: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
var size uint32
|
|
||||||
if err := binary.Read(r, binary.LittleEndian, &size); err != nil {
|
|
||||||
return id, 0, fmt.Errorf("read chunk size for %q: %w", id, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return id, size, nil
|
|
||||||
}
|
|
||||||
@@ -1,254 +0,0 @@
|
|||||||
package riff_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"encoding/binary"
|
|
||||||
"errors"
|
|
||||||
"runtime"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"yellowjacket/backend/riff"
|
|
||||||
)
|
|
||||||
|
|
||||||
// chunk is one sub-chunk to put in a test container.
|
|
||||||
type chunk struct {
|
|
||||||
id string
|
|
||||||
data []byte
|
|
||||||
}
|
|
||||||
|
|
||||||
// buildRIFF assembles a container from magic, form type and chunks,
|
|
||||||
// padding odd-length chunks the way a writer must.
|
|
||||||
func buildRIFF(magic, form string, chunks []chunk) []byte {
|
|
||||||
var body bytes.Buffer
|
|
||||||
|
|
||||||
body.WriteString(form)
|
|
||||||
|
|
||||||
for _, c := range chunks {
|
|
||||||
body.WriteString(c.id)
|
|
||||||
_ = binary.Write(&body, binary.LittleEndian, uint32(len(c.data)))
|
|
||||||
body.Write(c.data)
|
|
||||||
|
|
||||||
if len(c.data)%2 != 0 {
|
|
||||||
body.WriteByte(0)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
var out bytes.Buffer
|
|
||||||
|
|
||||||
out.WriteString(magic)
|
|
||||||
_ = binary.Write(&out, binary.LittleEndian, uint32(body.Len()))
|
|
||||||
out.Write(body.Bytes())
|
|
||||||
|
|
||||||
return out.Bytes()
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestID3Chunk_FindsTheTagPastTheAudio(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
chunks []chunk
|
|
||||||
want string
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
name: "after an odd-length chunk",
|
|
||||||
chunks: []chunk{
|
|
||||||
{id: "fmt ", data: make([]byte, 16)},
|
|
||||||
{id: "LIST", data: []byte("INFOodd")},
|
|
||||||
{id: "data", data: make([]byte, 200)},
|
|
||||||
{id: "id3 ", data: []byte("ID3vTAG")},
|
|
||||||
},
|
|
||||||
want: "ID3vTAG",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
// The chunk ID is written both ways in the wild, and the
|
|
||||||
// writer accepts either, so the reader must too.
|
|
||||||
name: "uppercase ID3",
|
|
||||||
chunks: []chunk{
|
|
||||||
{id: "data", data: make([]byte, 8)},
|
|
||||||
{id: "ID3 ", data: []byte("upper")},
|
|
||||||
},
|
|
||||||
want: "upper",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "first chunk",
|
|
||||||
chunks: []chunk{
|
|
||||||
{id: "id3 ", data: []byte("first")},
|
|
||||||
{id: "data", data: make([]byte, 8)},
|
|
||||||
},
|
|
||||||
want: "first",
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range tests {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
r := bytes.NewReader(buildRIFF("RIFF", "WAVE", tc.chunks))
|
|
||||||
|
|
||||||
got, err := riff.ID3Chunk(r)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("ID3Chunk: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if string(got) != tc.want {
|
|
||||||
t.Errorf("chunk data: got %q, want %q", got, tc.want)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestID3Chunk_RejectsWhatItCannotRead(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
bytes []byte
|
|
||||||
want error
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
name: "no ID3 chunk",
|
|
||||||
bytes: buildRIFF("RIFF", "WAVE", []chunk{{id: "data", data: []byte{1, 2}}}),
|
|
||||||
want: riff.ErrNoID3Chunk,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "no chunks at all",
|
|
||||||
bytes: buildRIFF("RIFF", "WAVE", nil),
|
|
||||||
want: riff.ErrNoID3Chunk,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "not RIFF",
|
|
||||||
bytes: []byte("ID3\x03\x00\x00\x00\x00\x00\x00\x00\x00"),
|
|
||||||
want: riff.ErrNotRIFF,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "not WAVE",
|
|
||||||
bytes: buildRIFF("RIFF", "AVI ", []chunk{{id: "id3 ", data: []byte("x")}}),
|
|
||||||
want: riff.ErrNotWAVE,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "RF64",
|
|
||||||
bytes: buildRIFF("RF64", "WAVE", []chunk{{id: "id3 ", data: []byte("x")}}),
|
|
||||||
want: riff.ErrRF64NotSupported,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range tests {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
_, err := riff.ID3Chunk(bytes.NewReader(tc.bytes))
|
|
||||||
if !errors.Is(err, tc.want) {
|
|
||||||
t.Errorf("ID3Chunk error: got %v, want %v", err, tc.want)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// A file cut short mid-chunk is a file with no tag, not a reason to
|
|
||||||
// allocate the size it claims: the declared size is four bytes any
|
|
||||||
// truncation can leave saying 4 GB.
|
|
||||||
func TestID3Chunk_ToleratesATruncatedFile(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
full := buildRIFF("RIFF", "WAVE", []chunk{
|
|
||||||
{id: "data", data: make([]byte, 64)},
|
|
||||||
{id: "id3 ", data: []byte("tag")},
|
|
||||||
})
|
|
||||||
|
|
||||||
t.Run("cut inside the audio", func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
_, err := riff.ID3Chunk(bytes.NewReader(full[:32]))
|
|
||||||
if !errors.Is(err, riff.ErrNoID3Chunk) {
|
|
||||||
t.Errorf("ID3Chunk error: got %v, want %v", err, riff.ErrNoID3Chunk)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
t.Run("cut inside the tag", func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
if _, err := riff.ID3Chunk(bytes.NewReader(full[:len(full)-2])); err == nil {
|
|
||||||
t.Error("ID3Chunk: got nil error for a truncated tag chunk")
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// Parse is the writer's half and reads every chunk into memory, which
|
|
||||||
// is what preserving them needs.
|
|
||||||
func TestParse_ReadsEveryChunkInOrder(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
raw := buildRIFF("RIFF", "WAVE", []chunk{
|
|
||||||
{id: "fmt ", data: make([]byte, 16)},
|
|
||||||
{id: "LIST", data: []byte("INFOodd")},
|
|
||||||
{id: "id3 ", data: []byte("tag")},
|
|
||||||
})
|
|
||||||
|
|
||||||
chunks, err := riff.Parse(bytes.NewReader(raw))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Parse: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
want := []string{"fmt ", "LIST", "id3 "}
|
|
||||||
if len(chunks) != len(want) {
|
|
||||||
t.Fatalf("chunk count: got %d, want %d", len(chunks), len(want))
|
|
||||||
}
|
|
||||||
|
|
||||||
for i, id := range want {
|
|
||||||
if got := string(chunks[i].ID[:]); got != id {
|
|
||||||
t.Errorf("chunk %d: got %q, want %q", i, got, id)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if !riff.IsID3(chunks[2].ID) || string(chunks[2].Data) != "tag" {
|
|
||||||
t.Errorf("id3 chunk: got %q", chunks[2].Data)
|
|
||||||
}
|
|
||||||
|
|
||||||
// The padding byte after an odd chunk is not part of its data.
|
|
||||||
if string(chunks[1].Data) != "INFOodd" {
|
|
||||||
t.Errorf("odd chunk data: got %q, want %q", chunks[1].Data, "INFOodd")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// A chunk size is four bytes read off the file, so a truncated or
|
|
||||||
// malformed WAV is free to declare a chunk larger than the whole of
|
|
||||||
// itself. Parse must grow with what arrives rather than with what was
|
|
||||||
// claimed.
|
|
||||||
//
|
|
||||||
// This measures the allocation instead of the error because the error
|
|
||||||
// is the same either way: a build sizing its buffer from the header
|
|
||||||
// reports the truncation correctly, having asked the allocator for a
|
|
||||||
// gigabyte on the way. Deliberately not parallel — TotalAlloc is
|
|
||||||
// process-wide, and a test paused beside another one is measuring it
|
|
||||||
// too.
|
|
||||||
func TestParse_DoesNotAllocateWhatAChunkClaims(t *testing.T) {
|
|
||||||
// Large enough that a header-sized buffer is unmistakable, in a
|
|
||||||
// container of a few dozen bytes.
|
|
||||||
const declared = 1 << 30
|
|
||||||
|
|
||||||
var raw bytes.Buffer
|
|
||||||
|
|
||||||
raw.WriteString("RIFF")
|
|
||||||
_ = binary.Write(&raw, binary.LittleEndian, uint32(declared+12))
|
|
||||||
raw.WriteString("WAVE")
|
|
||||||
raw.WriteString("data")
|
|
||||||
_ = binary.Write(&raw, binary.LittleEndian, uint32(declared))
|
|
||||||
raw.WriteString("and then the file ends")
|
|
||||||
|
|
||||||
var before, after runtime.MemStats
|
|
||||||
|
|
||||||
runtime.GC()
|
|
||||||
runtime.ReadMemStats(&before)
|
|
||||||
|
|
||||||
if _, err := riff.Parse(bytes.NewReader(raw.Bytes())); err == nil {
|
|
||||||
t.Fatal("Parse: got nil error for a chunk larger than the file holding it")
|
|
||||||
}
|
|
||||||
|
|
||||||
runtime.ReadMemStats(&after)
|
|
||||||
|
|
||||||
if grew := after.TotalAlloc - before.TotalAlloc; grew > 1<<20 {
|
|
||||||
t.Errorf("Parse allocated %d bytes reading a %d-byte file whose chunk header claimed %d",
|
|
||||||
grew, raw.Len(), declared)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -13,10 +13,9 @@ import (
|
|||||||
// indistinguishable from never having written one. So these assert the
|
// indistinguishable from never having written one. So these assert the
|
||||||
// round trip through the *reader the scan uses*, not the bytes.
|
// round trip through the *reader the scan uses*, not the bytes.
|
||||||
//
|
//
|
||||||
// WAV was the exception until #104 -- dhowden/tag has no RIFF reader,
|
// WAV is the exception and it is not this change's: dhowden/tag has no
|
||||||
// so metadata.ExtractTags could not see a WAV's ID3 chunk and this
|
// RIFF reader at all, so metadata.ExtractTags cannot see a WAV's ID3
|
||||||
// case read the chunk itself, which is a test of the writer wearing
|
// chunk -- which is why every other test here reads that chunk itself.
|
||||||
// the shape of a round trip. All four go through the scanner now.
|
|
||||||
func TestWriteTotals_RoundTripsInEveryFormat(t *testing.T) {
|
func TestWriteTotals_RoundTripsInEveryFormat(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
@@ -92,7 +91,7 @@ func TestWriteTotals_RoundTripsInEveryFormat(t *testing.T) {
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "wav",
|
name: "wav",
|
||||||
read: viaScanner,
|
read: readWavID3Tags,
|
||||||
write: func(t *testing.T, dir string) string {
|
write: func(t *testing.T, dir string) string {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
|
|||||||
+105
-11
@@ -8,22 +8,116 @@ import (
|
|||||||
"io"
|
"io"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"os"
|
"os"
|
||||||
|
"strings"
|
||||||
|
|
||||||
id3v2 "github.com/bogem/id3v2/v2"
|
id3v2 "github.com/bogem/id3v2/v2"
|
||||||
|
|
||||||
"yellowjacket/backend/fileutil"
|
"yellowjacket/backend/fileutil"
|
||||||
"yellowjacket/backend/riff"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// errFileTooLargeForWAV is the one RIFF error that belongs to the
|
// Sentinel errors for WAV RIFF operations.
|
||||||
// writer; reading rejects a container in backend/riff.
|
var (
|
||||||
var errFileTooLargeForWAV = errors.New("file too large for WAV format (>4GB)")
|
errRF64NotSupported = errors.New("RF64 files are not yet supported")
|
||||||
|
errNotRIFF = errors.New("not a RIFF file")
|
||||||
|
errNotWAVE = errors.New("not a WAVE file")
|
||||||
|
errFileTooLargeForWAV = errors.New("file too large for WAV format (>4GB)")
|
||||||
|
)
|
||||||
|
|
||||||
|
// riffChunk holds a single RIFF sub-chunk (ID + raw data).
|
||||||
|
type riffChunk struct {
|
||||||
|
id [4]byte
|
||||||
|
data []byte
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseRIFF reads all RIFF sub-chunks from r. It rejects RF64 files
|
||||||
|
// and non-WAVE containers with descriptive errors. The parser is
|
||||||
|
// lenient on read: it tolerates missing padding bytes and ignores
|
||||||
|
// the declared RIFF size.
|
||||||
|
func parseRIFF(r io.ReadSeeker) ([]riffChunk, error) {
|
||||||
|
// Read 4-byte container magic.
|
||||||
|
var magic [4]byte
|
||||||
|
if _, err := io.ReadFull(r, magic[:]); err != nil {
|
||||||
|
return nil, fmt.Errorf("read RIFF magic: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if string(magic[:]) == "RF64" {
|
||||||
|
return nil, errRF64NotSupported
|
||||||
|
}
|
||||||
|
|
||||||
|
if string(magic[:]) != "RIFF" {
|
||||||
|
return nil, fmt.Errorf("%w: got %q", errNotRIFF, magic)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Read (and discard) RIFF size — lenient, do not enforce.
|
||||||
|
var riffSize uint32
|
||||||
|
if err := binary.Read(r, binary.LittleEndian, &riffSize); err != nil {
|
||||||
|
return nil, fmt.Errorf("read RIFF size: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Read 4-byte form type.
|
||||||
|
var form [4]byte
|
||||||
|
if _, err := io.ReadFull(r, form[:]); err != nil {
|
||||||
|
return nil, fmt.Errorf("read WAVE form type: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if string(form[:]) != "WAVE" {
|
||||||
|
return nil, fmt.Errorf("%w: got %q", errNotWAVE, form)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Read sub-chunks until EOF.
|
||||||
|
var chunks []riffChunk
|
||||||
|
|
||||||
|
for {
|
||||||
|
var chunkID [4]byte
|
||||||
|
|
||||||
|
_, err := io.ReadFull(r, chunkID[:])
|
||||||
|
if errors.Is(err, io.EOF) || errors.Is(err, io.ErrUnexpectedEOF) {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("read chunk ID: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
var chunkSize uint32
|
||||||
|
if err := binary.Read(r, binary.LittleEndian, &chunkSize); err != nil {
|
||||||
|
return nil, fmt.Errorf("read chunk size for %q: %w", chunkID, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
data := make([]byte, chunkSize)
|
||||||
|
if _, err := io.ReadFull(r, data); err != nil {
|
||||||
|
return nil, fmt.Errorf("read chunk data for %q: %w", chunkID, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
chunks = append(chunks, riffChunk{id: chunkID, data: data})
|
||||||
|
|
||||||
|
// Odd-length chunks have a padding byte. Lenient: if the
|
||||||
|
// read fails (e.g. EOF), just break rather than error.
|
||||||
|
if chunkSize%2 != 0 {
|
||||||
|
var pad [1]byte
|
||||||
|
|
||||||
|
if _, err := r.Read(pad[:]); err != nil {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return chunks, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// isID3ChunkID returns true if id represents an ID3v2 RIFF chunk.
|
||||||
|
// Both lowercase "id3 " and uppercase "ID3 " are accepted.
|
||||||
|
func isID3ChunkID(id [4]byte) bool {
|
||||||
|
s := strings.ToLower(string(id[:3]))
|
||||||
|
|
||||||
|
return s == "id3"
|
||||||
|
}
|
||||||
|
|
||||||
// writeRIFF writes a complete RIFF/WAVE container to w, preserving
|
// writeRIFF writes a complete RIFF/WAVE container to w, preserving
|
||||||
// the given chunks in order and appending the id3Data as the final
|
// the given chunks in order and appending the id3Data as the final
|
||||||
// "id3 " chunk. Returns errFileTooLargeForWAV if the result would
|
// "id3 " chunk. Returns errFileTooLargeForWAV if the result would
|
||||||
// exceed the 4 GB RIFF limit.
|
// exceed the 4 GB RIFF limit.
|
||||||
func writeRIFF(w io.Writer, chunks []riff.Chunk, id3Data []byte) error {
|
func writeRIFF(w io.Writer, chunks []riffChunk, id3Data []byte) error {
|
||||||
// Calculate total RIFF payload size:
|
// Calculate total RIFF payload size:
|
||||||
// 4 bytes (WAVE form type)
|
// 4 bytes (WAVE form type)
|
||||||
// + for each preserved chunk: 8 (header) + len(data) + padding
|
// + for each preserved chunk: 8 (header) + len(data) + padding
|
||||||
@@ -31,7 +125,7 @@ func writeRIFF(w io.Writer, chunks []riff.Chunk, id3Data []byte) error {
|
|||||||
riffPayload := uint64(4)
|
riffPayload := uint64(4)
|
||||||
|
|
||||||
for _, c := range chunks {
|
for _, c := range chunks {
|
||||||
sz := uint64(len(c.Data))
|
sz := uint64(len(c.data))
|
||||||
riffPayload += 8 + sz
|
riffPayload += 8 + sz
|
||||||
|
|
||||||
if sz%2 != 0 {
|
if sz%2 != 0 {
|
||||||
@@ -68,7 +162,7 @@ func writeRIFF(w io.Writer, chunks []riff.Chunk, id3Data []byte) error {
|
|||||||
|
|
||||||
// Write each preserved chunk.
|
// Write each preserved chunk.
|
||||||
for _, c := range chunks {
|
for _, c := range chunks {
|
||||||
if err := writeChunk(w, c.ID, c.Data); err != nil {
|
if err := writeChunk(w, c.id, c.data); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -131,7 +225,7 @@ func writeWavTags(
|
|||||||
return fmt.Errorf("open wav for reading: %w", err)
|
return fmt.Errorf("open wav for reading: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
allChunks, err := riff.Parse(f)
|
allChunks, err := parseRIFF(f)
|
||||||
|
|
||||||
// Close immediately — we need the handle released before
|
// Close immediately — we need the handle released before
|
||||||
// AtomicWrite creates the replacement file.
|
// AtomicWrite creates the replacement file.
|
||||||
@@ -143,13 +237,13 @@ func writeWavTags(
|
|||||||
|
|
||||||
// Separate preserved chunks from existing ID3 data.
|
// Separate preserved chunks from existing ID3 data.
|
||||||
var (
|
var (
|
||||||
preserved []riff.Chunk
|
preserved []riffChunk
|
||||||
existingID3 []byte
|
existingID3 []byte
|
||||||
)
|
)
|
||||||
|
|
||||||
for _, c := range allChunks {
|
for _, c := range allChunks {
|
||||||
if riff.IsID3(c.ID) {
|
if isID3ChunkID(c.id) {
|
||||||
existingID3 = c.Data
|
existingID3 = c.data
|
||||||
} else {
|
} else {
|
||||||
preserved = append(preserved, c)
|
preserved = append(preserved, c)
|
||||||
}
|
}
|
||||||
|
|||||||
+17
-103
@@ -12,7 +12,6 @@ import (
|
|||||||
id3v2 "github.com/bogem/id3v2/v2"
|
id3v2 "github.com/bogem/id3v2/v2"
|
||||||
|
|
||||||
"yellowjacket/backend/metadata"
|
"yellowjacket/backend/metadata"
|
||||||
"yellowjacket/backend/riff"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// createTestWAV builds a minimal valid WAV file with an optional
|
// createTestWAV builds a minimal valid WAV file with an optional
|
||||||
@@ -271,88 +270,6 @@ func TestWriteWavTags_PartialUpdate(t *testing.T) {
|
|||||||
assertStrField(t, "Composer", meta.Composer, "Original Composer")
|
assertStrField(t, "Composer", meta.Composer, "Original Composer")
|
||||||
}
|
}
|
||||||
|
|
||||||
// The writer has always been correct and the reader could not see it:
|
|
||||||
// a WAV tagged by this app scanned as an untagged file, so editing
|
|
||||||
// tags, autotagging a folder or importing a WAV download all appeared
|
|
||||||
// to work and changed nothing the library could show (#104). So this
|
|
||||||
// asserts the write through metadata.ExtractTags -- the reader the
|
|
||||||
// scan uses -- rather than through the id3 chunk.
|
|
||||||
func TestWriteWavTags_ReadBackByTheScanner(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
dir := t.TempDir()
|
|
||||||
path := createTestWAV(t, dir, "scanner.wav", nil)
|
|
||||||
art := tinyJPEG(t)
|
|
||||||
|
|
||||||
changes := TagChanges{
|
|
||||||
FieldTitle: "Some Song",
|
|
||||||
FieldArtist: "Some Artist",
|
|
||||||
FieldAlbum: "Some Album",
|
|
||||||
FieldAlbumArtist: "Some Album Artist",
|
|
||||||
FieldGenre: "Rock",
|
|
||||||
FieldYear: 2024,
|
|
||||||
FieldTrackNumber: 3,
|
|
||||||
FieldComposer: "Some Composer",
|
|
||||||
FieldCoverArt: art,
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := writeWavTags(testLogger(), path, changes); err != nil {
|
|
||||||
t.Fatalf("writeWavTags: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
meta, err := metadata.ExtractTags(path)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("ExtractTags: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if meta.TagReadWarning != nil {
|
|
||||||
t.Errorf("TagReadWarning: %v", meta.TagReadWarning)
|
|
||||||
}
|
|
||||||
|
|
||||||
assertStrField(t, "Title", meta.Title, "Some Song")
|
|
||||||
assertStrField(t, "Artist", meta.Artist, "Some Artist")
|
|
||||||
assertStrField(t, "Album", meta.Album, "Some Album")
|
|
||||||
assertStrField(t, "AlbumArtist", meta.AlbumArtist, "Some Album Artist")
|
|
||||||
assertStrField(t, "Genre", meta.Genre, "Rock")
|
|
||||||
assertStrField(t, "Composer", meta.Composer, "Some Composer")
|
|
||||||
assertStrField(t, "FileFormat", meta.FileFormat, "WAV")
|
|
||||||
assertIntField(t, "Year", meta.Year, 2024)
|
|
||||||
assertIntField(t, "TrackNumber", meta.TrackNumber, 3)
|
|
||||||
|
|
||||||
if !strings.HasPrefix(meta.TagFormat, "ID3v2") {
|
|
||||||
t.Errorf("TagFormat: got %q, want an ID3v2 version", meta.TagFormat)
|
|
||||||
}
|
|
||||||
|
|
||||||
if meta.Picture == nil {
|
|
||||||
t.Fatal("expected cover art, got nil")
|
|
||||||
}
|
|
||||||
|
|
||||||
if !bytes.Equal(meta.Picture.Data, art) {
|
|
||||||
t.Errorf("picture data mismatch: got %d bytes, want %d",
|
|
||||||
len(meta.Picture.Data), len(art))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// An untagged WAV is a file with no tags, not a file with a problem:
|
|
||||||
// the scanner falls back to the filename and must not be handed a
|
|
||||||
// warning to surface about it.
|
|
||||||
func TestUntaggedWav_ReadsAsEmptyWithoutAWarning(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
path := createTestWAV(t, t.TempDir(), "bare.wav", nil)
|
|
||||||
|
|
||||||
meta, err := metadata.ExtractTags(path)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("ExtractTags: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if meta.TagReadWarning != nil {
|
|
||||||
t.Errorf("TagReadWarning: %v", meta.TagReadWarning)
|
|
||||||
}
|
|
||||||
|
|
||||||
assertStrField(t, "Title", meta.Title, "")
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestWriteWavTags_ChunkPreservation(t *testing.T) {
|
func TestWriteWavTags_ChunkPreservation(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
@@ -365,7 +282,7 @@ func TestWriteWavTags_ChunkPreservation(t *testing.T) {
|
|||||||
t.Fatalf("open original: %v", err)
|
t.Fatalf("open original: %v", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
origChunks, err := riff.Parse(origFile)
|
origChunks, err := parseRIFF(origFile)
|
||||||
_ = origFile.Close()
|
_ = origFile.Close()
|
||||||
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -375,7 +292,7 @@ func TestWriteWavTags_ChunkPreservation(t *testing.T) {
|
|||||||
// Record original chunk data by ID string.
|
// Record original chunk data by ID string.
|
||||||
origData := map[string][]byte{}
|
origData := map[string][]byte{}
|
||||||
for _, c := range origChunks {
|
for _, c := range origChunks {
|
||||||
origData[string(c.ID[:])] = c.Data
|
origData[string(c.id[:])] = c.data
|
||||||
}
|
}
|
||||||
|
|
||||||
// Write a tag to trigger RIFF rewrite.
|
// Write a tag to trigger RIFF rewrite.
|
||||||
@@ -392,7 +309,7 @@ func TestWriteWavTags_ChunkPreservation(t *testing.T) {
|
|||||||
t.Fatalf("open after write: %v", err)
|
t.Fatalf("open after write: %v", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
newChunks, err := riff.Parse(newFile)
|
newChunks, err := parseRIFF(newFile)
|
||||||
_ = newFile.Close()
|
_ = newFile.Close()
|
||||||
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -403,7 +320,7 @@ func TestWriteWavTags_ChunkPreservation(t *testing.T) {
|
|||||||
origNonID3 := 0
|
origNonID3 := 0
|
||||||
|
|
||||||
for _, c := range origChunks {
|
for _, c := range origChunks {
|
||||||
if !riff.IsID3(c.ID) {
|
if !isID3ChunkID(c.id) {
|
||||||
origNonID3++
|
origNonID3++
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -411,7 +328,7 @@ func TestWriteWavTags_ChunkPreservation(t *testing.T) {
|
|||||||
newNonID3 := 0
|
newNonID3 := 0
|
||||||
|
|
||||||
for _, c := range newChunks {
|
for _, c := range newChunks {
|
||||||
if !riff.IsID3(c.ID) {
|
if !isID3ChunkID(c.id) {
|
||||||
newNonID3++
|
newNonID3++
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -442,17 +359,17 @@ func TestWriteWavTags_ChunkPreservation(t *testing.T) {
|
|||||||
// in chunks and its data matches want byte-for-byte.
|
// in chunks and its data matches want byte-for-byte.
|
||||||
func checkChunkPreserved(
|
func checkChunkPreserved(
|
||||||
t *testing.T,
|
t *testing.T,
|
||||||
chunks []riff.Chunk,
|
chunks []riffChunk,
|
||||||
idStr string,
|
idStr string,
|
||||||
want []byte,
|
want []byte,
|
||||||
) {
|
) {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
for _, c := range chunks {
|
for _, c := range chunks {
|
||||||
if string(c.ID[:]) == idStr {
|
if string(c.id[:]) == idStr {
|
||||||
if !bytes.Equal(c.Data, want) {
|
if !bytes.Equal(c.data, want) {
|
||||||
t.Errorf("chunk %q data changed: got %d bytes, want %d",
|
t.Errorf("chunk %q data changed: got %d bytes, want %d",
|
||||||
idStr, len(c.Data), len(want))
|
idStr, len(c.data), len(want))
|
||||||
}
|
}
|
||||||
|
|
||||||
return
|
return
|
||||||
@@ -513,7 +430,7 @@ func TestWriteWavTags_RejectsRF64(t *testing.T) {
|
|||||||
buf.WriteString("WAVE")
|
buf.WriteString("WAVE")
|
||||||
|
|
||||||
// Minimal ds64 chunk (required for RF64 but we just need
|
// Minimal ds64 chunk (required for RF64 but we just need
|
||||||
// enough bytes for riff.Parse to hit the RF64 rejection).
|
// enough bytes for parseRIFF to hit the RF64 rejection).
|
||||||
buf.WriteString("ds64")
|
buf.WriteString("ds64")
|
||||||
_ = binary.Write(&buf, binary.LittleEndian, uint32(28)) //nolint:mnd
|
_ = binary.Write(&buf, binary.LittleEndian, uint32(28)) //nolint:mnd
|
||||||
buf.Write(make([]byte, 28)) //nolint:mnd
|
buf.Write(make([]byte, 28)) //nolint:mnd
|
||||||
@@ -537,12 +454,9 @@ func TestWriteWavTags_RejectsRF64(t *testing.T) {
|
|||||||
|
|
||||||
// readWavID3Tags extracts ID3v2 metadata from a WAV file by parsing
|
// readWavID3Tags extracts ID3v2 metadata from a WAV file by parsing
|
||||||
// the RIFF structure and reading the id3 chunk with bogem/id3v2.
|
// the RIFF structure and reading the id3 chunk with bogem/id3v2.
|
||||||
//
|
// dhowden/tag's ReadFrom does not support WAV files, and its
|
||||||
// metadata.ExtractTags reads a WAV since #104 and is what the round
|
// ReadID3v2Tags fails on empty tags (after clearing all frames).
|
||||||
// trips assert through. This stays for the two cases that are about
|
// Using bogem/id3v2.ParseReader handles all cases correctly.
|
||||||
// the bytes rather than about the scan: a tag with every frame
|
|
||||||
// cleared, which no reader reports as anything, and the chunk
|
|
||||||
// preservation test, which is already parsing the container itself.
|
|
||||||
func readWavID3Tags(
|
func readWavID3Tags(
|
||||||
t *testing.T,
|
t *testing.T,
|
||||||
path string,
|
path string,
|
||||||
@@ -556,17 +470,17 @@ func readWavID3Tags(
|
|||||||
|
|
||||||
defer func() { _ = f.Close() }()
|
defer func() { _ = f.Close() }()
|
||||||
|
|
||||||
chunks, err := riff.Parse(f)
|
chunks, err := parseRIFF(f)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("riff.Parse: %v", err)
|
t.Fatalf("parseRIFF: %v", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Find the id3 chunk.
|
// Find the id3 chunk.
|
||||||
var id3Data []byte
|
var id3Data []byte
|
||||||
|
|
||||||
for _, c := range chunks {
|
for _, c := range chunks {
|
||||||
if riff.IsID3(c.ID) {
|
if isID3ChunkID(c.id) {
|
||||||
id3Data = c.Data
|
id3Data = c.data
|
||||||
|
|
||||||
break
|
break
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,135 +0,0 @@
|
|||||||
import {
|
|
||||||
test,
|
|
||||||
expect,
|
|
||||||
callBinding,
|
|
||||||
openTheQueue,
|
|
||||||
NO_QUEUE_SOURCE,
|
|
||||||
} from '../support/fixtures.js';
|
|
||||||
import type { Page } from '@playwright/test';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* #67 — a name is not a link on a phone, and the menu is where it went.
|
|
||||||
*
|
|
||||||
* The queue panel is the surface this is visible on: its rows draw a
|
|
||||||
* track title and an artist credit as `explore-link`s at every width,
|
|
||||||
* unlike `track-list`, whose phone column set stacks title over artist
|
|
||||||
* as plain text already.
|
|
||||||
*
|
|
||||||
* **The pair is what makes either assertion mean anything.** A link
|
|
||||||
* that is gone and a menu item that never arrived is not a smaller
|
|
||||||
* affordance — it is a destination the phone cannot reach, which is
|
|
||||||
* what plan 018's "no action is unreachable at any supported size"
|
|
||||||
* refuses. So each test asserts the phone and the desktop in the same
|
|
||||||
* breath: text *and* an item here, a link *and* no item there.
|
|
||||||
*
|
|
||||||
* The desktop half is also the regression guard for the change: menus
|
|
||||||
* above the breakpoint must be exactly what they were, because the name
|
|
||||||
* beside them is still a link and a menu that repeats the row is
|
|
||||||
* furniture.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/** The reference device's real viewport, not a resized desktop. */
|
|
||||||
const DEVICE = { width: 424, height: 439 };
|
|
||||||
|
|
||||||
/** Wide enough that the queue is a column beside the content. */
|
|
||||||
const DESKTOP = { width: 1280, height: 800 };
|
|
||||||
|
|
||||||
const row = (app: Page, index: number) =>
|
|
||||||
app.locator(`queue-panel .track-item[data-index="${index}"]`);
|
|
||||||
|
|
||||||
/** The queue panel's own context menu, as a list of item labels. */
|
|
||||||
async function menuLabels(app: Page): Promise<string[]> {
|
|
||||||
return app.evaluate(() =>
|
|
||||||
[
|
|
||||||
...document
|
|
||||||
.querySelector('queue-panel')!
|
|
||||||
.shadowRoot!.querySelectorAll('wa-dropdown-item'),
|
|
||||||
].map((item) => item.textContent?.replace(/\s+/g, ' ').trim() ?? ''),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Queue three tracks that have an album, for the reason
|
|
||||||
* `queue-selection.spec.ts` states at length: `explore-link` routes a
|
|
||||||
* title to its *album's* page and renders plain text where it cannot
|
|
||||||
* route, so a track with no album answers this file's question with
|
|
||||||
* the wrong "no link".
|
|
||||||
*/
|
|
||||||
async function queueThree(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; Album: string; ArtistName: string }[];
|
|
||||||
|
|
||||||
return tracks
|
|
||||||
.filter((t) => t.Album !== '' && t.ArtistName !== '')
|
|
||||||
.slice(0, 3)
|
|
||||||
.map((t) => t.FilePath);
|
|
||||||
});
|
|
||||||
|
|
||||||
await callBinding(app, 'queue.Queue.SetQueue', [
|
|
||||||
paths,
|
|
||||||
0,
|
|
||||||
false,
|
|
||||||
NO_QUEUE_SOURCE,
|
|
||||||
]);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Open the row's context menu and read the items back. */
|
|
||||||
async function openRowMenu(app: Page, index: number): Promise<string[]> {
|
|
||||||
await row(app, index).click({ button: 'right' });
|
|
||||||
await expect
|
|
||||||
.poll(async () => (await menuLabels(app)).length)
|
|
||||||
.toBeGreaterThan(0);
|
|
||||||
|
|
||||||
return menuLabels(app);
|
|
||||||
}
|
|
||||||
|
|
||||||
test.describe('an inline name and the menu that replaces it', () => {
|
|
||||||
test.afterEach(async ({ app }) => {
|
|
||||||
await app.keyboard.press('Escape');
|
|
||||||
await callBinding(app, 'queue.Queue.Clear').catch(() => {
|
|
||||||
/* an empty queue is the state we were asking for */
|
|
||||||
});
|
|
||||||
await app.setViewportSize(DESKTOP);
|
|
||||||
});
|
|
||||||
|
|
||||||
test('a queue row is plain text on a phone and carries the destination', async ({
|
|
||||||
app,
|
|
||||||
}) => {
|
|
||||||
await app.setViewportSize(DEVICE);
|
|
||||||
await queueThree(app);
|
|
||||||
await openTheQueue(app);
|
|
||||||
await expect(row(app, 0)).toBeVisible();
|
|
||||||
|
|
||||||
// The name is text: nothing in the row is a link at all.
|
|
||||||
await expect(app.locator('queue-panel .track-item .explore-link')).toHaveCount(
|
|
||||||
0,
|
|
||||||
);
|
|
||||||
|
|
||||||
const labels = await openRowMenu(app, 0);
|
|
||||||
|
|
||||||
expect(labels).toContain('Go to Artist');
|
|
||||||
expect(labels).toContain('Go to Album');
|
|
||||||
});
|
|
||||||
|
|
||||||
test('the same row on a desktop is a link, and its menu is untouched', async ({
|
|
||||||
app,
|
|
||||||
}) => {
|
|
||||||
await app.setViewportSize(DESKTOP);
|
|
||||||
await queueThree(app);
|
|
||||||
await openTheQueue(app);
|
|
||||||
await expect(row(app, 0)).toBeVisible();
|
|
||||||
|
|
||||||
await expect(
|
|
||||||
row(app, 0).locator('.track-title .explore-link'),
|
|
||||||
).toHaveCount(1);
|
|
||||||
|
|
||||||
const labels = await openRowMenu(app, 0);
|
|
||||||
|
|
||||||
expect(labels).not.toContain('Go to Artist');
|
|
||||||
expect(labels).not.toContain('Go to Album');
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -98,58 +98,6 @@ test.describe('the shell on a phone', () => {
|
|||||||
).toBeVisible();
|
).toBeVisible();
|
||||||
});
|
});
|
||||||
|
|
||||||
test('draws "More" as a sheet on the bottom edge (#71)', async ({ app }) => {
|
|
||||||
await app.getByTestId('tab-more').click();
|
|
||||||
await expect(app.getByTestId('nav-drawer').locator('app-sidebar'))
|
|
||||||
.toBeVisible();
|
|
||||||
|
|
||||||
// What the report is about is geometry, and geometry is what no
|
|
||||||
// other assertion here can see: the side drawer was a 200px column
|
|
||||||
// opening away from the thumb that asked for it, with the rest of
|
|
||||||
// its 400px band empty. Measured rather than screenshotted, since
|
|
||||||
// the failure is a number.
|
|
||||||
//
|
|
||||||
// Polled, because a sheet *arrives*: the drawer's show animation
|
|
||||||
// translates it a full height below the fold, so a measurement
|
|
||||||
// taken the moment its content is visible reports a box hanging
|
|
||||||
// 412px off the bottom of the screen. Asking for the settled
|
|
||||||
// number is the assertion; asking once is a race.
|
|
||||||
const measure = () => app.evaluate(() => {
|
|
||||||
const nav = document.querySelector('bottom-nav');
|
|
||||||
const drawer = nav?.shadowRoot?.querySelector('wa-drawer');
|
|
||||||
const dialog = drawer?.shadowRoot?.querySelector('[part~="dialog"]');
|
|
||||||
const sidebar = nav?.shadowRoot?.querySelector('app-sidebar');
|
|
||||||
const row = sidebar?.shadowRoot?.querySelector('li button');
|
|
||||||
const box = dialog?.getBoundingClientRect();
|
|
||||||
|
|
||||||
return {
|
|
||||||
left: Math.round(box?.left ?? -1),
|
|
||||||
right: Math.round(box?.right ?? -1),
|
|
||||||
bottom: Math.round(box?.bottom ?? -1),
|
|
||||||
height: Math.round(box?.height ?? -1),
|
|
||||||
row: Math.round(row?.getBoundingClientRect().height ?? -1),
|
|
||||||
viewport: [window.innerWidth, window.innerHeight],
|
|
||||||
};
|
|
||||||
});
|
|
||||||
|
|
||||||
await expect
|
|
||||||
.poll(async () => (await measure()).bottom)
|
|
||||||
.toBe(PHONE.height);
|
|
||||||
|
|
||||||
const sheet = await measure();
|
|
||||||
|
|
||||||
expect(sheet.left).toBe(0);
|
|
||||||
expect(sheet.right).toBe(sheet.viewport[0]);
|
|
||||||
|
|
||||||
// A surface covering the whole screen is a page, not a sheet --
|
|
||||||
// which is also what leaves an outside to tap on, the only pointer
|
|
||||||
// route out of it (#171 is the same question one surface over).
|
|
||||||
expect(sheet.height).toBeLessThan(sheet.viewport[1]);
|
|
||||||
|
|
||||||
// 48px rows, from #186's touch floor and #60's context sheet.
|
|
||||||
expect(sheet.row).toBeGreaterThanOrEqual(48);
|
|
||||||
});
|
|
||||||
|
|
||||||
for (const vp of [PHONE, SMALL_PHONE]) {
|
for (const vp of [PHONE, SMALL_PHONE]) {
|
||||||
test(`does not scroll sideways at ${vp.width}×${vp.height}`, async ({ app }) => {
|
test(`does not scroll sideways at ${vp.width}×${vp.height}`, async ({ app }) => {
|
||||||
await app.setViewportSize(vp);
|
await app.setViewportSize(vp);
|
||||||
|
|||||||
@@ -7,7 +7,6 @@ import {
|
|||||||
import '@lit-labs/virtualizer';
|
import '@lit-labs/virtualizer';
|
||||||
import type {
|
import type {
|
||||||
LitVirtualizer,
|
LitVirtualizer,
|
||||||
RangeChangedEvent,
|
|
||||||
VisibilityChangedEvent,
|
VisibilityChangedEvent,
|
||||||
} from '@lit-labs/virtualizer';
|
} from '@lit-labs/virtualizer';
|
||||||
import { grid } from '@lit-labs/virtualizer/layouts/grid.js';
|
import { grid } from '@lit-labs/virtualizer/layouts/grid.js';
|
||||||
@@ -31,7 +30,6 @@ import type { ContextMenuHost, MenuTarget } from '@utils/context-menu-controller
|
|||||||
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 { prefetchImageWindow } from '@utils/image-prefetch';
|
|
||||||
|
|
||||||
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';
|
||||||
@@ -584,26 +582,6 @@ export class ArtistsView
|
|||||||
* Scroll position persistence
|
* Scroll position persistence
|
||||||
* ================================================================ */
|
* ================================================================ */
|
||||||
|
|
||||||
/**
|
|
||||||
* Warm the avatars just past the rendered range (#65).
|
|
||||||
*
|
|
||||||
* `rangeChanged` is the rendered range and `visibilityChanged` is
|
|
||||||
* what is on screen; the virtualizer has already drawn about
|
|
||||||
* 1000px past the latter, so that is the wrong anchor to measure a
|
|
||||||
* prefetch window from. It is deliberately outside the
|
|
||||||
* `restoringScroll` guard below: a restored scroll lands in the
|
|
||||||
* middle of the grid, which is exactly when nothing around it is
|
|
||||||
* cached.
|
|
||||||
*/
|
|
||||||
private onRangeChanged = (e: RangeChangedEvent) => {
|
|
||||||
prefetchImageWindow(
|
|
||||||
this.cachedGridEntries,
|
|
||||||
e.first,
|
|
||||||
e.last,
|
|
||||||
(entry) => this.artistAvatarURL(entry.artist),
|
|
||||||
);
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Save the first visible item index on scroll.
|
* Save the first visible item index on scroll.
|
||||||
*/
|
*/
|
||||||
@@ -1167,16 +1145,7 @@ export class ArtistsView
|
|||||||
* Helpers
|
* Helpers
|
||||||
* ================================================================ */
|
* ================================================================ */
|
||||||
|
|
||||||
/**
|
private renderArtistAvatar(artist: library.Artist) {
|
||||||
* The image this artist's card will draw, or `''` for the initial
|
|
||||||
* placeholder.
|
|
||||||
*
|
|
||||||
* Split out of `renderArtistAvatar` so the prefetch (#65) asks for
|
|
||||||
* exactly what the card is going to ask for — a second copy of the
|
|
||||||
* tier ladder would be a second thing to keep in step, and warming
|
|
||||||
* the wrong tier is a download that buys nothing.
|
|
||||||
*/
|
|
||||||
private artistAvatarURL(artist: library.Artist): string {
|
|
||||||
const needed = (this.imageSize ?? 176) * window.devicePixelRatio;
|
const needed = (this.imageSize ?? 176) * window.devicePixelRatio;
|
||||||
let imageURL = '';
|
let imageURL = '';
|
||||||
|
|
||||||
@@ -1203,12 +1172,6 @@ export class ArtistsView
|
|||||||
) ?? '';
|
) ?? '';
|
||||||
}
|
}
|
||||||
|
|
||||||
return imageURL;
|
|
||||||
}
|
|
||||||
|
|
||||||
private renderArtistAvatar(artist: library.Artist) {
|
|
||||||
const imageURL = this.artistAvatarURL(artist);
|
|
||||||
|
|
||||||
if (imageURL) {
|
if (imageURL) {
|
||||||
return html`<img
|
return html`<img
|
||||||
class="avatar-image"
|
class="avatar-image"
|
||||||
@@ -1568,7 +1531,6 @@ export class ArtistsView
|
|||||||
.keyFunction=${(entry: ArtistEntry) => entry.artist.ID}
|
.keyFunction=${(entry: ArtistEntry) => entry.artist.ID}
|
||||||
.layout=${this.gridLayout}
|
.layout=${this.gridLayout}
|
||||||
@visibilityChanged=${this.onVisibilityChanged}
|
@visibilityChanged=${this.onVisibilityChanged}
|
||||||
@rangeChanged=${this.onRangeChanged}
|
|
||||||
></lit-virtualizer>
|
></lit-virtualizer>
|
||||||
</div>
|
</div>
|
||||||
${this.renderContextMenu()}
|
${this.renderContextMenu()}
|
||||||
|
|||||||
@@ -27,43 +27,15 @@ interface Tab {
|
|||||||
* three to five items before the targets stop being thumb-sized —
|
* three to five items before the targets stop being thumb-sized —
|
||||||
* 360 px over eleven sidebar entries is 32 px each — so the four here
|
* 360 px over eleven sidebar entries is 32 px each — so the four here
|
||||||
* are the ones plan 016's subset says a phone is *for*, and "More"
|
* are the ones plan 016's subset says a phone is *for*, and "More"
|
||||||
* opens the existing `<app-sidebar>` in a sheet. That is deliberately
|
* opens the existing `<app-sidebar>` in a drawer. That is deliberately
|
||||||
* a reuse rather than a second nav: two lists of destinations is two
|
* a reuse rather than a second nav: two lists of destinations is two
|
||||||
* places to add the next view to, and the sidebar already carries the
|
* places to add the next view to, and the sidebar already carries the
|
||||||
* drag-to-navigate behaviour, the active state and the labels.
|
* drag-to-navigate behaviour, the active state and the labels.
|
||||||
*
|
*
|
||||||
* **"More" rises from the bottom, and it is the same sheet a context
|
|
||||||
* menu is** (#71). It was a `wa-drawer` sliding in from the side: a
|
|
||||||
* 200px column of a 424px screen, opening away from the thumb that
|
|
||||||
* asked for it, with three nested scrollers in it — the dialog, its
|
|
||||||
* body, and the sidebar's own `overflow-y: auto` host — which is the
|
|
||||||
* "only part of the screen scrolls under my finger" in the report.
|
|
||||||
*
|
|
||||||
* Three things about the replacement are load-bearing.
|
|
||||||
*
|
|
||||||
* **It is the same element with another `placement`, not a new
|
|
||||||
* surface.** `wa-drawer` renders a native `<dialog>` and opens it with
|
|
||||||
* `showModal()`, which is exactly what `menu-surface`'s sheet relies
|
|
||||||
* on — Chrome 37, the real top layer — so #60's containment finding
|
|
||||||
* carries over with nothing new to prove, and the focus trap, Escape,
|
|
||||||
* tap-outside and `wa-after-hide` all come along unchanged.
|
|
||||||
*
|
|
||||||
* **The body is the only scroller**, with `overscroll-behavior:
|
|
||||||
* contain`, and the sidebar is told to stop being one. Nesting them is
|
|
||||||
* what makes a drag scroll the wrong box.
|
|
||||||
*
|
|
||||||
* **The sidebar is still mounted rather than re-listed as data**,
|
|
||||||
* which the issue offers as an alternative. Its `data-testid` per
|
|
||||||
* destination is the reason: the shell's own sidebar is `display:
|
|
||||||
* none` below 600px rather than removed, so a second list drawing
|
|
||||||
* `nav-*` handles is the duplication this component already renders
|
|
||||||
* conditionally to avoid — and it would be a second place to add the
|
|
||||||
* next view to, with its own copy of #25's visibility filter.
|
|
||||||
*
|
|
||||||
* It emits the same bubbling, composed `navigate` event the sidebar
|
* It emits the same bubbling, composed `navigate` event the sidebar
|
||||||
* does, so `index.ts` needs no knowledge of it, and it listens for that
|
* does, so `index.ts` needs no knowledge of it, and it listens for that
|
||||||
* event globally for the same reason the sidebar does: a navigation it
|
* event globally for the same reason the sidebar does: a navigation it
|
||||||
* did not send (a card click, a detail view, the sheet) still has to
|
* did not send (a card click, a detail view, the drawer) still has to
|
||||||
* move the highlight.
|
* move the highlight.
|
||||||
*/
|
*/
|
||||||
@customElement('bottom-nav')
|
@customElement('bottom-nav')
|
||||||
@@ -143,50 +115,15 @@ export class BottomNav extends LitElement {
|
|||||||
white-space: nowrap;
|
white-space: nowrap;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* The sheet. --size is the drawer's own API for the axis its
|
|
||||||
placement uses, so auto is what makes it hug its content
|
|
||||||
instead of being a fixed 25rem band; the rest is the shape
|
|
||||||
the menu-surface context sheet already has, so a phone meets
|
|
||||||
one sheet rather than two. 85vh for its reason too: a surface
|
|
||||||
covering the whole screen is a page, not a sheet. */
|
|
||||||
wa-drawer {
|
|
||||||
--size: auto;
|
|
||||||
}
|
|
||||||
|
|
||||||
wa-drawer::part(dialog) {
|
|
||||||
max-height: 85vh;
|
|
||||||
border-radius: 12px 12px 0 0;
|
|
||||||
/* The sidebar paints its own surface, so the sheet takes
|
|
||||||
that colour rather than the menus' elevated one: two
|
|
||||||
greys in one sheet is a seam across the middle of it. */
|
|
||||||
background-color: var(--yj-bg-surface, #212529);
|
|
||||||
/* One scroller, and it is the body below. The dialog's own
|
|
||||||
overflow: auto is what let the sheet scroll as well as
|
|
||||||
its content, and it is also what would square off the
|
|
||||||
corners this rule just rounded. */
|
|
||||||
overflow: hidden;
|
|
||||||
}
|
|
||||||
|
|
||||||
wa-drawer::part(body) {
|
wa-drawer::part(body) {
|
||||||
padding: 0;
|
padding: 0;
|
||||||
/* A scroll that reaches the end of this list must not
|
|
||||||
become a scroll of the page underneath it. */
|
|
||||||
overscroll-behavior: contain;
|
|
||||||
/* The sheet sits on the bottom edge, so the last
|
|
||||||
destination would otherwise be under the home indicator
|
|
||||||
on a gesture-navigation phone -- the same allowance the
|
|
||||||
bar itself makes above. */
|
|
||||||
padding-bottom: env(safe-area-inset-bottom, 0);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/* A sheet is dragged at with a thumb, so it says where its top
|
app-sidebar {
|
||||||
edge is. Decorative: the destinations are below it. */
|
/* The sidebar sizes itself inline and collapses to icons
|
||||||
.grip {
|
below 900px, which is every phone. In the drawer there
|
||||||
width: 36px;
|
is room for the labels, so it is told not to. */
|
||||||
height: 4px;
|
height: 100%;
|
||||||
margin: 8px auto 4px;
|
|
||||||
border-radius: 2px;
|
|
||||||
background: var(--yj-text-tertiary, #888);
|
|
||||||
}
|
}
|
||||||
`];
|
`];
|
||||||
|
|
||||||
@@ -221,7 +158,7 @@ export class BottomNav extends LitElement {
|
|||||||
private visibilityCtrl = new ViewVisibilityController(this);
|
private visibilityCtrl = new ViewVisibilityController(this);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Whether the sheet has been asked for.
|
* Whether the drawer has been asked for.
|
||||||
*
|
*
|
||||||
* The sidebar inside it is rendered only while this is true, and
|
* The sidebar inside it is rendered only while this is true, and
|
||||||
* that is not an optimisation. `app-sidebar` carries a
|
* that is not an optimisation. `app-sidebar` carries a
|
||||||
@@ -263,17 +200,15 @@ export class BottomNav extends LitElement {
|
|||||||
|
|
||||||
override updated() {
|
override updated() {
|
||||||
// Web Awesome renders its heading into its own shadow root and
|
// Web Awesome renders its heading into its own shadow root and
|
||||||
// never points aria-labelledby at it, so the sheet would
|
// never points aria-labelledby at it, so the drawer would
|
||||||
// otherwise be announced unnamed -- the same fix, and the same
|
// otherwise be announced unnamed -- the same fix, and the same
|
||||||
// reason, as every wa-dialog in the app. A drawer's shadow root
|
// reason, as every wa-dialog in the app. A drawer's shadow root
|
||||||
// has the same shape, so the helper needs no change; under
|
// has the same shape, so the helper needs no change.
|
||||||
// `without-header` there is no heading to point at, which is
|
|
||||||
// that helper's documented `aria-label` path.
|
|
||||||
nameDialog(this.drawer);
|
nameDialog(this.drawer);
|
||||||
}
|
}
|
||||||
|
|
||||||
private onGlobalNavigate = () => {
|
private onGlobalNavigate = () => {
|
||||||
// A navigation from inside the sheet is the sheet's job done.
|
// A navigation from inside the drawer is the drawer's job done.
|
||||||
// The highlight is not this listener's business any more.
|
// The highlight is not this listener's business any more.
|
||||||
this.drawerOpen = false;
|
this.drawerOpen = false;
|
||||||
};
|
};
|
||||||
@@ -339,14 +274,12 @@ export class BottomNav extends LitElement {
|
|||||||
</nav>
|
</nav>
|
||||||
|
|
||||||
<wa-drawer
|
<wa-drawer
|
||||||
placement="bottom"
|
placement="start"
|
||||||
without-header
|
|
||||||
label="All views"
|
label="All views"
|
||||||
data-testid="nav-drawer"
|
data-testid="nav-drawer"
|
||||||
?open=${this.drawerOpen}
|
?open=${this.drawerOpen}
|
||||||
@wa-after-hide=${this.onDrawerHide}
|
@wa-after-hide=${this.onDrawerHide}
|
||||||
>
|
>
|
||||||
<div class="grip"></div>
|
|
||||||
${this.drawerOpen
|
${this.drawerOpen
|
||||||
? html`<app-sidebar expanded></app-sidebar>`
|
? html`<app-sidebar expanded></app-sidebar>`
|
||||||
: nothing}
|
: nothing}
|
||||||
|
|||||||
@@ -8,7 +8,6 @@ import {
|
|||||||
import '@lit-labs/virtualizer';
|
import '@lit-labs/virtualizer';
|
||||||
import type {
|
import type {
|
||||||
LitVirtualizer,
|
LitVirtualizer,
|
||||||
RangeChangedEvent,
|
|
||||||
VisibilityChangedEvent,
|
VisibilityChangedEvent,
|
||||||
} from '@lit-labs/virtualizer';
|
} from '@lit-labs/virtualizer';
|
||||||
import { grid } from '@lit-labs/virtualizer/layouts/grid.js';
|
import { grid } from '@lit-labs/virtualizer/layouts/grid.js';
|
||||||
@@ -31,7 +30,6 @@ import '@awesome.me/webawesome/dist/components/icon/icon.js';
|
|||||||
import '@components/playlist-picker/playlist-picker.js';
|
import '@components/playlist-picker/playlist-picker.js';
|
||||||
import { loadTrackDetails } from '@utils/lazy-track-details.js';
|
import { loadTrackDetails } from '@utils/lazy-track-details.js';
|
||||||
import { tracksByFilePath, tracksForPaths } from '@utils/track-index.js';
|
import { tracksByFilePath, tracksForPaths } from '@utils/track-index.js';
|
||||||
import { prefetchImageWindow } from '@utils/image-prefetch.js';
|
|
||||||
import type { TrackDetails } from '@components/track-details/track-details.js';
|
import type { TrackDetails } from '@components/track-details/track-details.js';
|
||||||
import type { CoverArtUrls } from '@components/track-details/track-details.js';
|
import type { CoverArtUrls } from '@components/track-details/track-details.js';
|
||||||
import { AlbumSelectionManager } from './album-selection.js';
|
import { AlbumSelectionManager } from './album-selection.js';
|
||||||
@@ -57,8 +55,6 @@ import {
|
|||||||
import type { ContextMenuHost, MenuTarget } 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 { creditLink, exploreLinkStyles } from '../../utils/explore-link';
|
import { creditLink, exploreLinkStyles } from '../../utils/explore-link';
|
||||||
import { goToMenuItems } from '../../utils/go-to-menu';
|
|
||||||
import type { GoToTarget } from '../../utils/go-to-menu';
|
|
||||||
import { creditStore } from '@store/credit-store';
|
import { creditStore } from '@store/credit-store';
|
||||||
import {
|
import {
|
||||||
createAlbumArtDragImage,
|
createAlbumArtDragImage,
|
||||||
@@ -912,31 +908,6 @@ export class CoverGrid
|
|||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
|
||||||
* Warm the covers just past the rendered range (#65).
|
|
||||||
*
|
|
||||||
* `rangeChanged` rather than `visibilityChanged`, because the two
|
|
||||||
* report different ranges and only one of them is the right
|
|
||||||
* anchor: visibility is what is on screen, and the virtualizer has
|
|
||||||
* already rendered about 1000px past that. Measured from the
|
|
||||||
* visible range this would spend most of its window on cards that
|
|
||||||
* already exist and have already asked for their own art.
|
|
||||||
*
|
|
||||||
* The entry lists are memoized, so asking for one here costs a
|
|
||||||
* reference compare.
|
|
||||||
*/
|
|
||||||
private onRangeChanged = (e: RangeChangedEvent) => {
|
|
||||||
const entries = this.splitMode
|
|
||||||
? this.getBeforeEntries()
|
|
||||||
: this.buildGridEntries();
|
|
||||||
|
|
||||||
prefetchImageWindow(entries, e.first, e.last, (entry) =>
|
|
||||||
entry.album.CoverArtPath
|
|
||||||
? this.getCoverUrl(entry.album)
|
|
||||||
: '',
|
|
||||||
);
|
|
||||||
};
|
|
||||||
|
|
||||||
/* ====================================================================
|
/* ====================================================================
|
||||||
* Virtualizer items
|
* Virtualizer items
|
||||||
* ==================================================================== */
|
* ==================================================================== */
|
||||||
@@ -2030,7 +2001,6 @@ export class CoverGrid
|
|||||||
@keydown=${this.onGridAlbumKeydown}
|
@keydown=${this.onGridAlbumKeydown}
|
||||||
@contextmenu=${this.onGridAlbumContextMenu}
|
@contextmenu=${this.onGridAlbumContextMenu}
|
||||||
@visibilityChanged=${this.onVisibilityChanged}
|
@visibilityChanged=${this.onVisibilityChanged}
|
||||||
@rangeChanged=${this.onRangeChanged}
|
|
||||||
></lit-virtualizer>
|
></lit-virtualizer>
|
||||||
`;
|
`;
|
||||||
}
|
}
|
||||||
@@ -2065,7 +2035,6 @@ export class CoverGrid
|
|||||||
@keydown=${this.onGridAlbumKeydown}
|
@keydown=${this.onGridAlbumKeydown}
|
||||||
@contextmenu=${this.onGridAlbumContextMenu}
|
@contextmenu=${this.onGridAlbumContextMenu}
|
||||||
@visibilityChanged=${this.onVisibilityChanged}
|
@visibilityChanged=${this.onVisibilityChanged}
|
||||||
@rangeChanged=${this.onRangeChanged}
|
|
||||||
></lit-virtualizer>
|
></lit-virtualizer>
|
||||||
|
|
||||||
<album-dropdown
|
<album-dropdown
|
||||||
@@ -2115,30 +2084,6 @@ export class CoverGrid
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* The artist an album card's menu can navigate to — the card's own
|
|
||||||
* credit line, which stops being a link below the phone breakpoint
|
|
||||||
* (#67).
|
|
||||||
*
|
|
||||||
* A *track* target gets nothing: the dropdown's rows carry no
|
|
||||||
* links of their own, and the album they sit under is the card
|
|
||||||
* that opened them.
|
|
||||||
*/
|
|
||||||
private get goToTarget(): GoToTarget | undefined {
|
|
||||||
if (this.contextMenuTarget.kind !== 'album') return undefined;
|
|
||||||
|
|
||||||
const album = this.albums.find(
|
|
||||||
(a) => a.ID === this.contextMenuAlbumId,
|
|
||||||
);
|
|
||||||
|
|
||||||
if (!album) return undefined;
|
|
||||||
|
|
||||||
return {
|
|
||||||
artistName: album.ArtistName,
|
|
||||||
artistMBID: album.ArtistMBID,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
private renderContextMenu() {
|
private renderContextMenu() {
|
||||||
const { ctxMenu } = this;
|
const { ctxMenu } = this;
|
||||||
|
|
||||||
@@ -2254,11 +2199,6 @@ export class CoverGrid
|
|||||||
</wa-dropdown-item>
|
</wa-dropdown-item>
|
||||||
`
|
`
|
||||||
: nothing}
|
: nothing}
|
||||||
${goToMenuItems(this.goToTarget, {
|
|
||||||
onSelect: () => ctxMenu.close(),
|
|
||||||
onHover: () =>
|
|
||||||
ctxMenu.closePlaylistSubmenu(),
|
|
||||||
})}
|
|
||||||
</div>
|
</div>
|
||||||
`
|
`
|
||||||
: nothing}
|
: nothing}
|
||||||
|
|||||||
@@ -3191,14 +3191,10 @@ export class ExploreAlbumDetails extends LitElement implements ContextMenuHost {
|
|||||||
return html`
|
return html`
|
||||||
${artist
|
${artist
|
||||||
? html`<div class="album-artist">
|
? html`<div class="album-artist">
|
||||||
<!-- keepOnPhone: the page header is not a row and
|
|
||||||
has no menu of its own, so this credit is the
|
|
||||||
only route from an album to its artist (#67). -->
|
|
||||||
${creditLink(
|
${creditLink(
|
||||||
creditStore.credits(this.releaseGroupMBID),
|
creditStore.credits(this.releaseGroupMBID),
|
||||||
artist,
|
artist,
|
||||||
artistMbid,
|
artistMbid,
|
||||||
{ keepOnPhone: true },
|
|
||||||
)}
|
)}
|
||||||
</div>`
|
</div>`
|
||||||
: nothing}
|
: nothing}
|
||||||
|
|||||||
@@ -30,7 +30,6 @@ import { libraryStore } from '../../store/library-store';
|
|||||||
import { downloadStore } from '../../store/download-store';
|
import { downloadStore } from '../../store/download-store';
|
||||||
import '@awesome.me/webawesome/dist/components/button/button.js';
|
import '@awesome.me/webawesome/dist/components/button/button.js';
|
||||||
import { trackLink, exploreLinkStyles } from '../../utils/explore-link';
|
import { trackLink, exploreLinkStyles } from '../../utils/explore-link';
|
||||||
import { goToMenuItems } from '../../utils/go-to-menu';
|
|
||||||
import { describeError } from '../../utils/describe-error';
|
import { describeError } from '../../utils/describe-error';
|
||||||
import {
|
import {
|
||||||
GetAlbumsByArtist,
|
GetAlbumsByArtist,
|
||||||
@@ -2706,16 +2705,6 @@ export class ExploreArtistDetails extends LitElement implements ContextMenuHost
|
|||||||
<wa-icon slot="icon" name="globe"></wa-icon>
|
<wa-icon slot="icon" name="globe"></wa-icon>
|
||||||
View on MusicBrainz
|
View on MusicBrainz
|
||||||
</wa-dropdown-item>
|
</wa-dropdown-item>
|
||||||
<!-- The track title links to its album, and below the phone
|
|
||||||
breakpoint it is plain text (#67). The artist is this
|
|
||||||
page, so there is nothing to go to. -->
|
|
||||||
${goToMenuItems(
|
|
||||||
{ albumName: track.releaseName, albumMBID: track.releaseGroupMbid ?? '' },
|
|
||||||
{
|
|
||||||
onSelect: () => this.ctxMenu.close(),
|
|
||||||
onHover: () => this.ctxMenu.closePlaylistSubmenu(),
|
|
||||||
},
|
|
||||||
)}
|
|
||||||
`;
|
`;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -23,8 +23,6 @@ import { queueStore } from '../../store/queue-store';
|
|||||||
import { notificationStore } from '../../store/notification-store';
|
import { notificationStore } from '../../store/notification-store';
|
||||||
import '../notifications/inline-notice';
|
import '../notifications/inline-notice';
|
||||||
import { creditLink, trackLink, exploreLinkStyles } from '../../utils/explore-link';
|
import { creditLink, trackLink, exploreLinkStyles } from '../../utils/explore-link';
|
||||||
import { goToMenuItems } from '../../utils/go-to-menu';
|
|
||||||
import type { GoToTarget } from '../../utils/go-to-menu';
|
|
||||||
import { creditStore } from '@store/credit-store';
|
import { creditStore } from '@store/credit-store';
|
||||||
import { describeError } from '../../utils/describe-error';
|
import { describeError } from '../../utils/describe-error';
|
||||||
import '@awesome.me/webawesome/dist/components/icon/icon.js';
|
import '@awesome.me/webawesome/dist/components/icon/icon.js';
|
||||||
@@ -56,28 +54,10 @@ export const ExploreRegion = 'explore';
|
|||||||
* is present only when owned — that's what gates the playback items,
|
* is present only when owned — that's what gates the playback items,
|
||||||
* while `mbid` (always present) is what "View on MusicBrainz" uses, so
|
* while `mbid` (always present) is what "View on MusicBrainz" uses, so
|
||||||
* a catalog-only card still gets a menu with somewhere useful to go.
|
* a catalog-only card still gets a menu with somewhere useful to go.
|
||||||
*
|
|
||||||
* `goTo` is the names the card draws -- an artist credit, and for a
|
|
||||||
* recording row the release its title links to. Below the phone
|
|
||||||
* breakpoint those are plain text, so the menu is where they went
|
|
||||||
* (#67); an album card carries no album of its own, because tapping
|
|
||||||
* the card is already that.
|
|
||||||
*/
|
*/
|
||||||
type ExploreMenuTarget =
|
type ExploreMenuTarget =
|
||||||
| {
|
| { kind: 'album'; mbid: string; localId?: number; title: string }
|
||||||
kind: 'album';
|
| { kind: 'recording'; mbid: string; localId?: number; title: string };
|
||||||
mbid: string;
|
|
||||||
localId?: number;
|
|
||||||
title: string;
|
|
||||||
goTo?: GoToTarget;
|
|
||||||
}
|
|
||||||
| {
|
|
||||||
kind: 'recording';
|
|
||||||
mbid: string;
|
|
||||||
localId?: number;
|
|
||||||
title: string;
|
|
||||||
goTo?: GoToTarget;
|
|
||||||
};
|
|
||||||
type ThumbnailRequest = explore.ThumbnailRequest;
|
type ThumbnailRequest = explore.ThumbnailRequest;
|
||||||
type MBSearchResult = explore.MBSearchResult;
|
type MBSearchResult = explore.MBSearchResult;
|
||||||
type LyricsResult = explore.LyricsResult;
|
type LyricsResult = explore.LyricsResult;
|
||||||
@@ -1406,9 +1386,6 @@ export class ExploreView extends ViewLifecycleMixin(LitElement) implements Conte
|
|||||||
<wa-icon slot="icon" name="globe"></wa-icon>
|
<wa-icon slot="icon" name="globe"></wa-icon>
|
||||||
View on MusicBrainz
|
View on MusicBrainz
|
||||||
</wa-dropdown-item>
|
</wa-dropdown-item>
|
||||||
${goToMenuItems(target.goTo, {
|
|
||||||
onSelect: () => this.ctxMenu.close(),
|
|
||||||
})}
|
|
||||||
</div>
|
</div>
|
||||||
`
|
`
|
||||||
: nothing}
|
: nothing}
|
||||||
@@ -2211,10 +2188,6 @@ export class ExploreView extends ViewLifecycleMixin(LitElement) implements Conte
|
|||||||
mbid: rg.mbid,
|
mbid: rg.mbid,
|
||||||
localId: rg.localId,
|
localId: rg.localId,
|
||||||
title: rg.title,
|
title: rg.title,
|
||||||
goTo: {
|
|
||||||
artistName: rg.artistCredit,
|
|
||||||
artistMBID: rg.artistMbid ?? '',
|
|
||||||
},
|
|
||||||
})}
|
})}
|
||||||
role="button"
|
role="button"
|
||||||
tabindex="0"
|
tabindex="0"
|
||||||
@@ -2227,10 +2200,6 @@ export class ExploreView extends ViewLifecycleMixin(LitElement) implements Conte
|
|||||||
mbid: rg.mbid,
|
mbid: rg.mbid,
|
||||||
localId: rg.localId,
|
localId: rg.localId,
|
||||||
title: rg.title,
|
title: rg.title,
|
||||||
goTo: {
|
|
||||||
artistName: rg.artistCredit,
|
|
||||||
artistMBID: rg.artistMbid ?? '',
|
|
||||||
},
|
|
||||||
},
|
},
|
||||||
)}
|
)}
|
||||||
>
|
>
|
||||||
@@ -2309,12 +2278,6 @@ export class ExploreView extends ViewLifecycleMixin(LitElement) implements Conte
|
|||||||
mbid: r.mbid,
|
mbid: r.mbid,
|
||||||
localId: r.localId,
|
localId: r.localId,
|
||||||
title: r.title,
|
title: r.title,
|
||||||
goTo: {
|
|
||||||
artistName: r.artistCredit,
|
|
||||||
artistMBID: r.artistMbid ?? '',
|
|
||||||
albumName: r.releaseName ?? '',
|
|
||||||
albumMBID: r.releaseGroupMbid ?? '',
|
|
||||||
},
|
|
||||||
})}
|
})}
|
||||||
@keydown=${(e: KeyboardEvent) =>
|
@keydown=${(e: KeyboardEvent) =>
|
||||||
this.onCardKeydown(
|
this.onCardKeydown(
|
||||||
@@ -2325,12 +2288,6 @@ export class ExploreView extends ViewLifecycleMixin(LitElement) implements Conte
|
|||||||
mbid: r.mbid,
|
mbid: r.mbid,
|
||||||
localId: r.localId,
|
localId: r.localId,
|
||||||
title: r.title,
|
title: r.title,
|
||||||
goTo: {
|
|
||||||
artistName: r.artistCredit,
|
|
||||||
artistMBID: r.artistMbid ?? '',
|
|
||||||
albumName: r.releaseName ?? '',
|
|
||||||
albumMBID: r.releaseGroupMbid ?? '',
|
|
||||||
},
|
|
||||||
},
|
},
|
||||||
)}
|
)}
|
||||||
>
|
>
|
||||||
|
|||||||
@@ -155,55 +155,10 @@ export class MenuSurface extends LitElement {
|
|||||||
bottom was at y=452 on a 439px screen -- the one row a
|
bottom was at y=452 on a 439px screen -- the one row a
|
||||||
destructive action is most likely to be. The cap has to stay
|
destructive action is most likely to be. The cap has to stay
|
||||||
(a sheet covering the whole screen is a page, not a sheet),
|
(a sheet covering the whole screen is a page, not a sheet),
|
||||||
so the body is what gives.
|
so the body is what gives. */
|
||||||
|
|
||||||
**And a body that scrolls says so** (#207). Scrolling was the
|
|
||||||
whole of the fix above, which left the last item reachable
|
|
||||||
and nothing on screen admitting it was there -- measured at
|
|
||||||
424x439, eight items ending at y=470 with the fold at 439,
|
|
||||||
and worse when the cut lands on a row boundary, where the
|
|
||||||
sheet ends in a clean edge that reads as the end of the list.
|
|
||||||
|
|
||||||
Two layers, and the *order* is what asks the question: a
|
|
||||||
shadow pinned to the bottom of the box (attachment scroll),
|
|
||||||
and over it a cover of the sheet's own colour painted at the
|
|
||||||
end of the *content* (attachment local), which therefore
|
|
||||||
scrolls up over the shadow and hides it exactly when there is
|
|
||||||
nothing more to see. So the affordance is absent on a menu
|
|
||||||
that fits, present the moment one does not, and gone again at
|
|
||||||
the end of the list -- with no scroll listener, no
|
|
||||||
measurement, and nothing reaching into wa-dialog's shadow
|
|
||||||
root for the scroller. background-attachment is Chrome 4;
|
|
||||||
the reference device is Chrome 113.
|
|
||||||
|
|
||||||
**The curve is steep because the rows under it stay live.**
|
|
||||||
A scrim over a menu item is that item's text surface, and
|
|
||||||
this app's rule is that text clears 4.5:1 on every surface it
|
|
||||||
can sit on -- which the light ramp, whose bgElevated is
|
|
||||||
#e9ecef, is what makes non-theoretical. A row is 48px with
|
|
||||||
its label centred, so 32px of scrim that is already down to
|
|
||||||
a quarter strength at 14px reaches y-centre at about 0.06 and
|
|
||||||
spends its weight on the strip below the last legible label.
|
|
||||||
Measured on the dark ramp at x=300, flat 52,58,64 throughout
|
|
||||||
before: 50,56,62 at y=330, 33,37,40 at y=350 and 22,24,27 at
|
|
||||||
the bottom edge, and flat again at the end of the list. The
|
|
||||||
light ramp puts 9.9:1 on the last label. */
|
|
||||||
wa-dialog::part(body) {
|
wa-dialog::part(body) {
|
||||||
padding: 0;
|
padding: 0;
|
||||||
overflow-y: auto;
|
overflow-y: auto;
|
||||||
background:
|
|
||||||
linear-gradient(
|
|
||||||
var(--yj-bg-elevated, #343a40),
|
|
||||||
var(--yj-bg-elevated, #343a40)
|
|
||||||
)
|
|
||||||
bottom / 100% 32px no-repeat local,
|
|
||||||
linear-gradient(
|
|
||||||
to top,
|
|
||||||
rgba(0, 0, 0, 0.6) 0%,
|
|
||||||
rgba(0, 0, 0, 0.25) 45%,
|
|
||||||
rgba(0, 0, 0, 0) 100%
|
|
||||||
)
|
|
||||||
bottom / 100% 32px no-repeat scroll;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/* A sheet is dragged at with a thumb, so it says where its top
|
/* A sheet is dragged at with a thumb, so it says where its top
|
||||||
|
|||||||
@@ -420,20 +420,11 @@ export class NowPlayingView extends LitElement {
|
|||||||
<h2 class="title" data-testid="npv-title">
|
<h2 class="title" data-testid="npv-title">
|
||||||
${track.title || track.fileName}
|
${track.title || track.fileName}
|
||||||
</h2>
|
</h2>
|
||||||
<!-- keepOnPhone: this screen is the phone's,
|
|
||||||
and it has no context menu to carry the
|
|
||||||
destination the way a row does (#67).
|
|
||||||
Suppressing these takes the artist and the
|
|
||||||
album away rather than moving them, and
|
|
||||||
they are two lines of their own here
|
|
||||||
rather than a few characters inside a
|
|
||||||
row. -->
|
|
||||||
<p class="artist">
|
<p class="artist">
|
||||||
${creditLink(
|
${creditLink(
|
||||||
creditStore.credits(track.recordingMbid),
|
creditStore.credits(track.recordingMbid),
|
||||||
track.artist,
|
track.artist,
|
||||||
track.artistMbid,
|
track.artistMbid,
|
||||||
{ keepOnPhone: true },
|
|
||||||
)}
|
)}
|
||||||
</p>
|
</p>
|
||||||
${track.album
|
${track.album
|
||||||
@@ -443,7 +434,6 @@ export class NowPlayingView extends LitElement {
|
|||||||
track.releaseGroupMbid,
|
track.releaseGroupMbid,
|
||||||
undefined,
|
undefined,
|
||||||
track.artist,
|
track.artist,
|
||||||
{ keepOnPhone: true },
|
|
||||||
)}
|
)}
|
||||||
</p>`
|
</p>`
|
||||||
: nothing}
|
: nothing}
|
||||||
|
|||||||
@@ -74,8 +74,6 @@ import {
|
|||||||
trackLink,
|
trackLink,
|
||||||
exploreLinkStyles,
|
exploreLinkStyles,
|
||||||
} from '@utils/explore-link';
|
} from '@utils/explore-link';
|
||||||
import { goToMenuItems } from '@utils/go-to-menu';
|
|
||||||
import type { GoToTarget } from '@utils/go-to-menu';
|
|
||||||
import { designTokens } from '../../styles/tokens.css';
|
import { designTokens } from '../../styles/tokens.css';
|
||||||
import { srOnly } from '../../styles/sr-only.css';
|
import { srOnly } from '../../styles/sr-only.css';
|
||||||
import { backButton } from '../../styles/back-button.css';
|
import { backButton } from '../../styles/back-button.css';
|
||||||
@@ -591,28 +589,6 @@ export class PlaylistDetails
|
|||||||
.map((i) => this.tracks[i]!.FilePath);
|
.map((i) => this.tracks[i]!.FilePath);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* The row "Go to Artist" / "Go to Album" navigate from — one row
|
|
||||||
* or none, and only below the phone breakpoint, where the row's
|
|
||||||
* own names stopped being links (#67).
|
|
||||||
*/
|
|
||||||
private get goToTarget(): GoToTarget | undefined {
|
|
||||||
const indices = this.selection.getSelectedIndices();
|
|
||||||
|
|
||||||
if (indices.length !== 1) return undefined;
|
|
||||||
|
|
||||||
const track = this.tracks[indices[0]!];
|
|
||||||
|
|
||||||
if (!track) return undefined;
|
|
||||||
|
|
||||||
return {
|
|
||||||
artistName: track.Artist,
|
|
||||||
artistMBID: track.ArtistMBID,
|
|
||||||
albumName: track.Album,
|
|
||||||
albumMBID: track.ReleaseGroupMBID,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
// =================================================================
|
// =================================================================
|
||||||
// Context menu actions
|
// Context menu actions
|
||||||
// =================================================================
|
// =================================================================
|
||||||
@@ -1945,14 +1921,6 @@ export class PlaylistDetails
|
|||||||
Track
|
Track
|
||||||
Details
|
Details
|
||||||
</wa-dropdown-item>
|
</wa-dropdown-item>
|
||||||
${goToMenuItems(this.goToTarget, {
|
|
||||||
onSelect: () => {
|
|
||||||
this.selection.clear();
|
|
||||||
this.ctxMenu.close();
|
|
||||||
},
|
|
||||||
onHover: () =>
|
|
||||||
this.ctxMenu.closePlaylistSubmenu(),
|
|
||||||
})}
|
|
||||||
</div>
|
</div>
|
||||||
`
|
`
|
||||||
: nothing}
|
: nothing}
|
||||||
|
|||||||
@@ -62,8 +62,6 @@ import {
|
|||||||
trackLink,
|
trackLink,
|
||||||
exploreLinkStyles,
|
exploreLinkStyles,
|
||||||
} from '@utils/explore-link';
|
} from '@utils/explore-link';
|
||||||
import { goToMenuItems } from '@utils/go-to-menu';
|
|
||||||
import type { GoToTarget } from '@utils/go-to-menu';
|
|
||||||
import {
|
import {
|
||||||
ICON_NEW,
|
ICON_NEW,
|
||||||
ICON_PLAY,
|
ICON_PLAY,
|
||||||
@@ -1645,29 +1643,6 @@ export class QueuePanel
|
|||||||
.map((i) => tracks[i]!.filePath);
|
.map((i) => tracks[i]!.filePath);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* The row "Go to Artist" / "Go to Album" navigate from, which is
|
|
||||||
* one row or none — the rule the Play item already follows. Both
|
|
||||||
* items are drawn only below the phone breakpoint, where the row's
|
|
||||||
* own names stopped being links (#67).
|
|
||||||
*/
|
|
||||||
private get goToTarget(): GoToTarget | undefined {
|
|
||||||
const indices = this.selection.getSelectedIndices();
|
|
||||||
|
|
||||||
if (indices.length !== 1) return undefined;
|
|
||||||
|
|
||||||
const track = this.queue.tracks[indices[0]!];
|
|
||||||
|
|
||||||
if (!track) return undefined;
|
|
||||||
|
|
||||||
return {
|
|
||||||
artistName: track.artist,
|
|
||||||
artistMBID: track.artistMbid,
|
|
||||||
albumName: track.album,
|
|
||||||
albumMBID: track.releaseGroupMbid,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
// =================================================================
|
// =================================================================
|
||||||
// Drop target (tracks dropped into queue)
|
// Drop target (tracks dropped into queue)
|
||||||
// =================================================================
|
// =================================================================
|
||||||
@@ -2385,14 +2360,6 @@ export class QueuePanel
|
|||||||
Track
|
Track
|
||||||
Details
|
Details
|
||||||
</wa-dropdown-item>
|
</wa-dropdown-item>
|
||||||
${goToMenuItems(this.goToTarget, {
|
|
||||||
onSelect: () => {
|
|
||||||
this.selection.clear();
|
|
||||||
this.ctxMenu.close();
|
|
||||||
},
|
|
||||||
onHover: () =>
|
|
||||||
this.ctxMenu.closePlaylistSubmenu(),
|
|
||||||
})}
|
|
||||||
</div>
|
</div>
|
||||||
`
|
`
|
||||||
: nothing}
|
: nothing}
|
||||||
|
|||||||
@@ -42,26 +42,6 @@ export class AppSidebar extends LitElement {
|
|||||||
scrollbar-width: thin;
|
scrollbar-width: thin;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* A host that has made room owns the box, not just the labels
|
|
||||||
(#71). The bottom-nav sheet is the width of the screen and
|
|
||||||
provides the one scroll container it needs; left to itself
|
|
||||||
the sidebar is a 200px column with a second scroller inside
|
|
||||||
it, which is what a nested scroll region feels like under a
|
|
||||||
thumb -- part of the surface moves and part of it does not. */
|
|
||||||
:host([expanded]) {
|
|
||||||
max-width: none;
|
|
||||||
height: auto;
|
|
||||||
overflow: visible;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* And the width is not draggable there. It is a mouse
|
|
||||||
affordance (mousedown, col-resize) sitting on the right edge
|
|
||||||
of a touch surface, where the compatibility mouse events a
|
|
||||||
tap synthesises can start a resize nobody asked for. */
|
|
||||||
:host([expanded]) .resize-handle {
|
|
||||||
display: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
.resize-handle {
|
.resize-handle {
|
||||||
position: absolute;
|
position: absolute;
|
||||||
top: 0;
|
top: 0;
|
||||||
@@ -180,25 +160,6 @@ export class AppSidebar extends LitElement {
|
|||||||
:host(.collapsed) li button wa-icon {
|
:host(.collapsed) li button wa-icon {
|
||||||
font-size: var(--yj-icon-md);
|
font-size: var(--yj-icon-md);
|
||||||
}
|
}
|
||||||
|
|
||||||
/* Below 600px the only place this renders is the bottom-nav
|
|
||||||
sheet -- the shell's own copy is display: none there -- so
|
|
||||||
the rows are sized for the thumb that opened it: 48px, which
|
|
||||||
is #186's floor and the height every row in #60's context
|
|
||||||
sheet already has. A media query inside a shadow root is
|
|
||||||
answered by the viewport, so the component states this
|
|
||||||
itself rather than the sheet reaching in. */
|
|
||||||
@media (max-width: 599px) {
|
|
||||||
ul {
|
|
||||||
padding: 4px 8px 8px;
|
|
||||||
}
|
|
||||||
|
|
||||||
li button {
|
|
||||||
min-height: 48px;
|
|
||||||
padding: 12px 10px;
|
|
||||||
gap: 14px;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
`];
|
`];
|
||||||
|
|
||||||
/** Delay in ms before a drag-hover triggers navigation. */
|
/** Delay in ms before a drag-hover triggers navigation. */
|
||||||
@@ -227,14 +188,11 @@ export class AppSidebar extends LitElement {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Keep the labels regardless of the viewport, for a host that has
|
* Keep the labels regardless of the viewport, for a host that has
|
||||||
* made room for them -- `bottom-nav`'s sheet, which is the whole
|
* made room for them -- `bottom-nav`'s drawer, which is the whole
|
||||||
* screen wide on the phone where this would otherwise auto-collapse
|
* screen wide on the phone where this would otherwise auto-collapse
|
||||||
* to icons. The auto-collapse is a *width* response to a narrow
|
* to icons. The auto-collapse is a *width* response to a narrow
|
||||||
* shell, and inside a sheet the shell is not what the sidebar is
|
* shell, and inside a drawer the shell is not what the sidebar is
|
||||||
* sharing space with.
|
* sharing space with.
|
||||||
*
|
|
||||||
* It says the host owns the *box*, not only the labels: the width,
|
|
||||||
* the scrolling and the resize handle all follow it (#71).
|
|
||||||
*/
|
*/
|
||||||
@property({ type: Boolean, reflect: true })
|
@property({ type: Boolean, reflect: true })
|
||||||
expanded = false;
|
expanded = false;
|
||||||
@@ -407,18 +365,9 @@ export class AppSidebar extends LitElement {
|
|||||||
* be a media query in the stylesheet.
|
* be a media query in the stylesheet.
|
||||||
*/
|
*/
|
||||||
private applyViewportWidth() {
|
private applyViewportWidth() {
|
||||||
// A host that made room decides how much: `bottom-nav`'s sheet
|
const narrow =
|
||||||
// is the whole screen wide, and the inline width below -- which
|
!this.expanded &&
|
||||||
// beats any rule the host could write -- would draw the old
|
(this.narrowViewport?.matches ?? false);
|
||||||
// 200px side drawer inside it.
|
|
||||||
if (this.expanded) {
|
|
||||||
this.style.width = '100%';
|
|
||||||
this.collapsed = false;
|
|
||||||
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
const narrow = this.narrowViewport?.matches ?? false;
|
|
||||||
const width = narrow
|
const width = narrow
|
||||||
? MIN_WIDTH
|
? MIN_WIDTH
|
||||||
: this.userWidth;
|
: this.userWidth;
|
||||||
|
|||||||
@@ -64,8 +64,6 @@ import {
|
|||||||
trackLink,
|
trackLink,
|
||||||
exploreLinkStyles,
|
exploreLinkStyles,
|
||||||
} from '@utils/explore-link';
|
} from '@utils/explore-link';
|
||||||
import { goToMenuItems } from '@utils/go-to-menu';
|
|
||||||
import type { GoToTarget } from '@utils/go-to-menu';
|
|
||||||
import '@components/smart-playlist-editor/smart-playlist-editor.js';
|
import '@components/smart-playlist-editor/smart-playlist-editor.js';
|
||||||
import { designTokens } from '../../styles/tokens.css';
|
import { designTokens } from '../../styles/tokens.css';
|
||||||
import { backButton } from '../../styles/back-button.css';
|
import { backButton } from '../../styles/back-button.css';
|
||||||
@@ -949,28 +947,6 @@ export class SmartPlaylistDetails
|
|||||||
.map((i) => this.tracks[i]!.FilePath);
|
.map((i) => this.tracks[i]!.FilePath);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* The row "Go to Artist" / "Go to Album" navigate from — one row
|
|
||||||
* or none, and only below the phone breakpoint, where the row's
|
|
||||||
* own names stopped being links (#67).
|
|
||||||
*/
|
|
||||||
private get goToTarget(): GoToTarget | undefined {
|
|
||||||
const indices = this.selection.getSelectedIndices();
|
|
||||||
|
|
||||||
if (indices.length !== 1) return undefined;
|
|
||||||
|
|
||||||
const track = this.tracks[indices[0]!];
|
|
||||||
|
|
||||||
if (!track) return undefined;
|
|
||||||
|
|
||||||
return {
|
|
||||||
artistName: track.Artist,
|
|
||||||
artistMBID: track.ArtistMBID,
|
|
||||||
albumName: track.Album,
|
|
||||||
albumMBID: track.ReleaseGroupMBID,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
// =================================================================
|
// =================================================================
|
||||||
// Context menu actions
|
// Context menu actions
|
||||||
// =================================================================
|
// =================================================================
|
||||||
@@ -1726,14 +1702,6 @@ export class SmartPlaylistDetails
|
|||||||
></wa-icon>
|
></wa-icon>
|
||||||
Track Details
|
Track Details
|
||||||
</wa-dropdown-item>
|
</wa-dropdown-item>
|
||||||
${goToMenuItems(this.goToTarget, {
|
|
||||||
onSelect: () => {
|
|
||||||
this.selection.clear();
|
|
||||||
this.ctxMenu.close();
|
|
||||||
},
|
|
||||||
onHover: () =>
|
|
||||||
this.ctxMenu.closePlaylistSubmenu(),
|
|
||||||
})}
|
|
||||||
</div>
|
</div>
|
||||||
`
|
`
|
||||||
: nothing}
|
: nothing}
|
||||||
|
|||||||
@@ -371,11 +371,8 @@ export class TopResultsRow extends LitElement {
|
|||||||
<span class="card-name">${r.name}</span>
|
<span class="card-name">${r.name}</span>
|
||||||
${artistPart || metaPart
|
${artistPart || metaPart
|
||||||
? html`<span class="card-subtitle"
|
? html`<span class="card-subtitle"
|
||||||
><!-- keepOnPhone: this card has no
|
>${artistPart
|
||||||
context menu, so the credit is
|
? creditLink(creditStore.credits(r.mbid), artistPart, r.artistMbid ?? '')
|
||||||
the only route to the artist of
|
|
||||||
a top result (#67). -->${artistPart
|
|
||||||
? creditLink(creditStore.credits(r.mbid), artistPart, r.artistMbid ?? '', { keepOnPhone: true })
|
|
||||||
: nothing}${artistPart && metaPart
|
: nothing}${artistPart && metaPart
|
||||||
? ' · '
|
? ' · '
|
||||||
: ''}${metaPart}</span
|
: ''}${metaPart}</span
|
||||||
|
|||||||
@@ -51,8 +51,6 @@ import {
|
|||||||
trackLink,
|
trackLink,
|
||||||
exploreLinkStyles,
|
exploreLinkStyles,
|
||||||
} from '@utils/explore-link';
|
} from '@utils/explore-link';
|
||||||
import { goToMenuItems } from '@utils/go-to-menu';
|
|
||||||
import type { GoToTarget } from '@utils/go-to-menu';
|
|
||||||
import {
|
import {
|
||||||
setDragPayload,
|
setDragPayload,
|
||||||
emitDragActive,
|
emitDragActive,
|
||||||
@@ -1981,33 +1979,6 @@ export class TrackList
|
|||||||
emitDragActive(false);
|
emitDragActive(false);
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
|
||||||
* The row the menu can navigate from, for "Go to Artist" / "Go to
|
|
||||||
* Album" — which exist only below the phone breakpoint, where the
|
|
||||||
* row's own names are no longer links (#67).
|
|
||||||
*
|
|
||||||
* One row only, on the rule the Play item already states: one row
|
|
||||||
* is a position, several are an explicit choice of *those* tracks,
|
|
||||||
* and "go to the album" of five different albums means nothing.
|
|
||||||
*/
|
|
||||||
private get goToTarget(): GoToTarget | undefined {
|
|
||||||
if (this.selection.selectionCount !== 1) return undefined;
|
|
||||||
|
|
||||||
const [path] = this.selection.selectedItems;
|
|
||||||
const track = path
|
|
||||||
? tracksByFilePath(this.tracks).get(path)
|
|
||||||
: undefined;
|
|
||||||
|
|
||||||
if (!track) return undefined;
|
|
||||||
|
|
||||||
return {
|
|
||||||
artistName: track.ArtistName,
|
|
||||||
artistMBID: track.ArtistMBID,
|
|
||||||
albumName: track.Album,
|
|
||||||
albumMBID: track.ReleaseGroupMBID,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
private onContextMenuAction(action: string) {
|
private onContextMenuAction(action: string) {
|
||||||
const filePaths =
|
const filePaths =
|
||||||
this.selection.getSelectedKeysOrdered();
|
this.selection.getSelectedKeysOrdered();
|
||||||
@@ -2617,13 +2588,6 @@ export class TrackList
|
|||||||
></wa-icon>
|
></wa-icon>
|
||||||
Track Details
|
Track Details
|
||||||
</wa-dropdown-item>
|
</wa-dropdown-item>
|
||||||
${goToMenuItems(this.goToTarget, {
|
|
||||||
onSelect: () => {
|
|
||||||
this.selection.clear();
|
|
||||||
this.ctxMenu.close();
|
|
||||||
},
|
|
||||||
onHover: () => this.ctxMenu.closePlaylistSubmenu(),
|
|
||||||
})}
|
|
||||||
<wa-dropdown-item
|
<wa-dropdown-item
|
||||||
@click=${() =>
|
@click=${() =>
|
||||||
this.onContextMenuAction(
|
this.onContextMenuAction(
|
||||||
|
|||||||
@@ -13,35 +13,11 @@
|
|||||||
* bug, not as a statement about metadata. The only case that still
|
* bug, not as a statement about metadata. The only case that still
|
||||||
* renders as text is one we genuinely cannot route (no name at all, or
|
* renders as text is one we genuinely cannot route (no name at all, or
|
||||||
* nothing in the library by that name).
|
* nothing in the library by that name).
|
||||||
*
|
|
||||||
* ## Below the phone breakpoint a name is not a link (#67)
|
|
||||||
*
|
|
||||||
* A few characters of text inside a row is not a touch target, and the
|
|
||||||
* click handling below is explicitly a *desktop* compromise: the
|
|
||||||
* navigation is held for one double-click interval so double-clicking
|
|
||||||
* the row can still play it, which means nothing at all on touch. On
|
|
||||||
* a phone the row's own gesture wins anyway — a claimed `yj-tap` has
|
|
||||||
* its click swallowed by `utils/touch-gestures.ts`, so the link was
|
|
||||||
* unreachable as well as fiddly.
|
|
||||||
*
|
|
||||||
* So the rule lives here rather than at twenty call sites, which is
|
|
||||||
* what the Findings on #67 ask for: a name renders as plain text below
|
|
||||||
* `PHONE_QUERY`, and the row's context menu carries "Go to Artist" /
|
|
||||||
* "Go to Album" in its place (`goToMenuItems`).
|
|
||||||
*
|
|
||||||
* The exception is `keepOnPhone`, and it is not a preference. Three
|
|
||||||
* surfaces render a name with **no menu to carry the destination** —
|
|
||||||
* `now-playing-view`, `explore-album-details`' header credit and
|
|
||||||
* `top-results-row` — so suppressing the link there takes the action
|
|
||||||
* away entirely rather than moving it, which is what plan 018's "no
|
|
||||||
* action is unreachable at any supported size" refuses. Each of those
|
|
||||||
* call sites says so.
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import { html, css } from 'lit';
|
import { html, css } from 'lit';
|
||||||
import type { TemplateResult } from 'lit';
|
import type { TemplateResult } from 'lit';
|
||||||
import { libraryStore } from '../store/library-store';
|
import { libraryStore } from '../store/library-store';
|
||||||
import { PHONE_QUERY } from './breakpoints';
|
|
||||||
|
|
||||||
/** Shared CSS for explore link styling. Import into component styles. */
|
/** Shared CSS for explore link styling. Import into component styles. */
|
||||||
export const exploreLinkStyles = css`
|
export const exploreLinkStyles = css`
|
||||||
@@ -56,57 +32,6 @@ export const exploreLinkStyles = css`
|
|||||||
}
|
}
|
||||||
`;
|
`;
|
||||||
|
|
||||||
/**
|
|
||||||
* Options every link function takes, for the one case that is not the
|
|
||||||
* default.
|
|
||||||
*/
|
|
||||||
export interface LinkOptions {
|
|
||||||
/**
|
|
||||||
* Keep the name navigable at phone width.
|
|
||||||
*
|
|
||||||
* For a surface with no context menu to carry the destination —
|
|
||||||
* see the header of this file. A row must not pass it: the row's
|
|
||||||
* tap already means "play", and the menu is where the destination
|
|
||||||
* went.
|
|
||||||
*/
|
|
||||||
keepOnPhone?: boolean;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The live phone breakpoint, made once and read per link.
|
|
||||||
*
|
|
||||||
* A `MediaQueryList` is live, so one object answers for the life of
|
|
||||||
* the page and a resize needs nothing from here. The identity check
|
|
||||||
* is the test seam: this tier's viewport is fixed by the runner, so a
|
|
||||||
* spec answers the query by replacing `window.matchMedia` (the same
|
|
||||||
* stub `now-playing-phone.test.ts` installs), and swapping the
|
|
||||||
* function is what tells us to ask again.
|
|
||||||
*/
|
|
||||||
let phoneQuery: MediaQueryList | undefined;
|
|
||||||
let phoneQuerySource: typeof window.matchMedia | undefined;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Whether an inline name still navigates.
|
|
||||||
*
|
|
||||||
* Exported because the menus that carry the destination in its place
|
|
||||||
* are drawn under exactly the same condition -- one answer, not two.
|
|
||||||
*/
|
|
||||||
export function inlineLinksSuppressed(): boolean {
|
|
||||||
if (!window.matchMedia) return false;
|
|
||||||
|
|
||||||
if (phoneQuerySource !== window.matchMedia) {
|
|
||||||
phoneQuerySource = window.matchMedia;
|
|
||||||
phoneQuery = window.matchMedia(PHONE_QUERY);
|
|
||||||
}
|
|
||||||
|
|
||||||
return phoneQuery?.matches ?? false;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Whether this call site should render plain text rather than a link. */
|
|
||||||
function plainText(options?: LinkOptions): boolean {
|
|
||||||
return !options?.keepOnPhone && inlineLinksSuppressed();
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Fire a navigate event from the clicked element. */
|
/** Fire a navigate event from the clicked element. */
|
||||||
function navigate(target: EventTarget, detail: Record<string, unknown>): void {
|
function navigate(target: EventTarget, detail: Record<string, unknown>): void {
|
||||||
target.dispatchEvent(
|
target.dispatchEvent(
|
||||||
@@ -228,19 +153,39 @@ function singleClick(
|
|||||||
* @param mbid - The MusicBrainz artist ID. Empty string = local only.
|
* @param mbid - The MusicBrainz artist ID. Empty string = local only.
|
||||||
* @param content - Optional custom content to render inside the link
|
* @param content - Optional custom content to render inside the link
|
||||||
* (e.g. highlighted search result). Defaults to artistName.
|
* (e.g. highlighted search result). Defaults to artistName.
|
||||||
* @param options - See `LinkOptions`.
|
|
||||||
*/
|
*/
|
||||||
export function artistLink(
|
export function artistLink(
|
||||||
artistName: string,
|
artistName: string,
|
||||||
mbid: string,
|
mbid: string,
|
||||||
content?: TemplateResult | string,
|
content?: TemplateResult | string,
|
||||||
options?: LinkOptions,
|
|
||||||
): TemplateResult | string {
|
): TemplateResult | string {
|
||||||
if (!artistName) return artistName;
|
if (!artistName) return artistName;
|
||||||
if (plainText(options)) return content ?? artistName;
|
|
||||||
|
|
||||||
const onClick = singleClick((target) => {
|
const onClick = singleClick((target) => {
|
||||||
void openArtistPage(target, artistName, mbid);
|
void (async () => {
|
||||||
|
if (mbid) {
|
||||||
|
navigate(target, {
|
||||||
|
view: 'explore-artist-details',
|
||||||
|
artistMBID: mbid,
|
||||||
|
artistName,
|
||||||
|
});
|
||||||
|
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const local = await findLocalArtist(artistName);
|
||||||
|
if (!local) return;
|
||||||
|
|
||||||
|
// The caller's row had no MBID, but the library row for the
|
||||||
|
// same artist may — the grid routes by exactly this field,
|
||||||
|
// so reading it here is what keeps the two paths agreeing.
|
||||||
|
navigate(target, {
|
||||||
|
view: 'explore-artist-details',
|
||||||
|
artistMBID: local.MBID || '',
|
||||||
|
artistName,
|
||||||
|
localArtistId: local.ID,
|
||||||
|
});
|
||||||
|
})();
|
||||||
});
|
});
|
||||||
|
|
||||||
return html`<a
|
return html`<a
|
||||||
@@ -258,22 +203,19 @@ export function artistLink(
|
|||||||
* @param mbid - The MusicBrainz release group ID. Empty = local only.
|
* @param mbid - The MusicBrainz release group ID. Empty = local only.
|
||||||
* @param content - Optional custom content to render inside the link.
|
* @param content - Optional custom content to render inside the link.
|
||||||
* @param artistName - Disambiguates same-named albums in the library.
|
* @param artistName - Disambiguates same-named albums in the library.
|
||||||
* @param options - See `LinkOptions`.
|
|
||||||
*/
|
*/
|
||||||
export function albumLink(
|
export function albumLink(
|
||||||
albumName: string,
|
albumName: string,
|
||||||
mbid: string,
|
mbid: string,
|
||||||
content?: TemplateResult | string,
|
content?: TemplateResult | string,
|
||||||
artistName?: string,
|
artistName?: string,
|
||||||
options?: LinkOptions,
|
|
||||||
): TemplateResult | string {
|
): TemplateResult | string {
|
||||||
if (!albumName) return albumName;
|
if (!albumName) return albumName;
|
||||||
if (plainText(options)) return content ?? albumName;
|
|
||||||
|
|
||||||
return html`<a
|
return html`<a
|
||||||
class="explore-link"
|
class="explore-link"
|
||||||
@click=${singleClick((target) => {
|
@click=${singleClick((target) => {
|
||||||
void openAlbumPage(target, albumName, mbid, artistName);
|
void openAlbum(target, albumName, mbid, artistName);
|
||||||
})}
|
})}
|
||||||
title=${mbid ? 'View album on Explore' : 'View album in your library'}
|
title=${mbid ? 'View album on Explore' : 'View album in your library'}
|
||||||
>${content ?? albumName}</a>`;
|
>${content ?? albumName}</a>`;
|
||||||
@@ -290,7 +232,6 @@ export function albumLink(
|
|||||||
* @param recordingMBID - The track's MusicBrainz recording ID.
|
* @param recordingMBID - The track's MusicBrainz recording ID.
|
||||||
* @param content - Optional custom content (e.g. highlighted text).
|
* @param content - Optional custom content (e.g. highlighted text).
|
||||||
* @param artistName - Disambiguates same-named albums in the library.
|
* @param artistName - Disambiguates same-named albums in the library.
|
||||||
* @param options - See `LinkOptions`.
|
|
||||||
*/
|
*/
|
||||||
export function trackLink(
|
export function trackLink(
|
||||||
trackName: string,
|
trackName: string,
|
||||||
@@ -299,16 +240,14 @@ export function trackLink(
|
|||||||
recordingMBID: string,
|
recordingMBID: string,
|
||||||
content?: TemplateResult | string,
|
content?: TemplateResult | string,
|
||||||
artistName?: string,
|
artistName?: string,
|
||||||
options?: LinkOptions,
|
|
||||||
): TemplateResult | string {
|
): TemplateResult | string {
|
||||||
if (!trackName) return trackName;
|
if (!trackName) return trackName;
|
||||||
if (!albumName) return content ?? trackName;
|
if (!albumName) return content ?? trackName;
|
||||||
if (plainText(options)) return content ?? trackName;
|
|
||||||
|
|
||||||
return html`<a
|
return html`<a
|
||||||
class="explore-link"
|
class="explore-link"
|
||||||
@click=${singleClick((target) => {
|
@click=${singleClick((target) => {
|
||||||
void openAlbumPage(
|
void openAlbum(
|
||||||
target,
|
target,
|
||||||
albumName,
|
albumName,
|
||||||
releaseGroupMBID,
|
releaseGroupMBID,
|
||||||
@@ -323,48 +262,11 @@ export function trackLink(
|
|||||||
>${content ?? trackName}</a>`;
|
>${content ?? trackName}</a>`;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Route to an artist page, preferring the catalog and falling back to
|
|
||||||
* the library copy.
|
|
||||||
*
|
|
||||||
* Exported because a menu item goes to the same place a name does, and
|
|
||||||
* two routings of "go to this artist" is how the two come to disagree
|
|
||||||
* about an untagged one.
|
|
||||||
*/
|
|
||||||
export async function openArtistPage(
|
|
||||||
target: EventTarget,
|
|
||||||
artistName: string,
|
|
||||||
mbid: string,
|
|
||||||
): Promise<void> {
|
|
||||||
if (mbid) {
|
|
||||||
navigate(target, {
|
|
||||||
view: 'explore-artist-details',
|
|
||||||
artistMBID: mbid,
|
|
||||||
artistName,
|
|
||||||
});
|
|
||||||
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
const local = await findLocalArtist(artistName);
|
|
||||||
if (!local) return;
|
|
||||||
|
|
||||||
// The caller's row had no MBID, but the library row for the
|
|
||||||
// same artist may — the grid routes by exactly this field,
|
|
||||||
// so reading it here is what keeps the two paths agreeing.
|
|
||||||
navigate(target, {
|
|
||||||
view: 'explore-artist-details',
|
|
||||||
artistMBID: local.MBID || '',
|
|
||||||
artistName,
|
|
||||||
localArtistId: local.ID,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Route to an album page, preferring the catalog and falling back to
|
* Route to an album page, preferring the catalog and falling back to
|
||||||
* the library copy. `highlight*` marks one track on arrival.
|
* the library copy. `highlight*` marks one track on arrival.
|
||||||
*/
|
*/
|
||||||
export async function openAlbumPage(
|
async function openAlbum(
|
||||||
target: EventTarget,
|
target: EventTarget,
|
||||||
albumName: string,
|
albumName: string,
|
||||||
releaseGroupMBID: string,
|
releaseGroupMBID: string,
|
||||||
@@ -435,31 +337,23 @@ export interface CreditPart {
|
|||||||
* @param parts - The credit's parts in position order, if known.
|
* @param parts - The credit's parts in position order, if known.
|
||||||
* @param fallbackName - The credit as a single string.
|
* @param fallbackName - The credit as a single string.
|
||||||
* @param fallbackMbid - The primary artist's MBID.
|
* @param fallbackMbid - The primary artist's MBID.
|
||||||
* @param options - See `LinkOptions`.
|
|
||||||
*/
|
*/
|
||||||
export function creditLink(
|
export function creditLink(
|
||||||
parts: readonly CreditPart[] | undefined,
|
parts: readonly CreditPart[] | undefined,
|
||||||
fallbackName: string,
|
fallbackName: string,
|
||||||
fallbackMbid: string,
|
fallbackMbid: string,
|
||||||
options?: LinkOptions,
|
|
||||||
): TemplateResult | string {
|
): TemplateResult | string {
|
||||||
// One part is one link, so it is the fallback rather than a special
|
// One part is one link, so it is the fallback rather than a special
|
||||||
// case — and a zero-part credit reaching here would otherwise
|
// case — and a zero-part credit reaching here would otherwise
|
||||||
// render as nothing at all, which is worse than the single-artist
|
// render as nothing at all, which is worse than the single-artist
|
||||||
// answer it replaced.
|
// answer it replaced.
|
||||||
if (!parts || parts.length < 2) {
|
if (!parts || parts.length < 2) {
|
||||||
return artistLink(fallbackName, fallbackMbid, undefined, options);
|
return artistLink(fallbackName, fallbackMbid);
|
||||||
}
|
}
|
||||||
|
|
||||||
// A decomposed credit is rendered from the same parts either way,
|
|
||||||
// so the join phrases survive the suppression and the text reads
|
|
||||||
// as it did — which is `creditText`'s job, and it is the string
|
|
||||||
// the `title=` beside these already uses.
|
|
||||||
if (plainText(options)) return creditText(parts, fallbackName);
|
|
||||||
|
|
||||||
return html`${parts.map(
|
return html`${parts.map(
|
||||||
(part) =>
|
(part) =>
|
||||||
html`${artistLink(part.creditedName, part.artistMbid, undefined, options)}${part.joinPhrase}`,
|
html`${artistLink(part.creditedName, part.artistMbid)}${part.joinPhrase}`,
|
||||||
)}`;
|
)}`;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,109 +0,0 @@
|
|||||||
/**
|
|
||||||
* "Go to Artist" / "Go to Album", for the menus that carry a name the
|
|
||||||
* phone stopped drawing as a link (#67).
|
|
||||||
*
|
|
||||||
* `utils/explore-link.ts` renders a plain string below the phone
|
|
||||||
* breakpoint, because a few characters inside a row is not a touch
|
|
||||||
* target and the row's own tap already means "play". That takes a
|
|
||||||
* destination away, so the row's context menu gives it back — which is
|
|
||||||
* the whole of this issue: the navigation moves, it does not go.
|
|
||||||
*
|
|
||||||
* Three things about it are load-bearing.
|
|
||||||
*
|
|
||||||
* **It is drawn under exactly the condition the link is not.**
|
|
||||||
* `inlineLinksSuppressed()` answers both, so a desktop menu is
|
|
||||||
* untouched (the name beside it is still a link, and a menu that
|
|
||||||
* repeats what the row already offers is furniture) and a phone menu
|
|
||||||
* cannot be missing what the row lost.
|
|
||||||
*
|
|
||||||
* **It goes where the name went.** `openArtistPage` / `openAlbumPage`
|
|
||||||
* are `explore-link`'s own routing, exported rather than reimplemented,
|
|
||||||
* so an untagged artist reaches the library page here for the same
|
|
||||||
* reason and by the same lookup it does from a link.
|
|
||||||
*
|
|
||||||
* **The host says when it is over**, through `onSelect` — every menu in
|
|
||||||
* this app closes itself and most clear their selection, and both are
|
|
||||||
* the host's bookkeeping rather than something a shared item may do on
|
|
||||||
* its behalf. `onHover` is for the four hosts with a playlist submenu,
|
|
||||||
* which closes on any other item being pointed at.
|
|
||||||
*/
|
|
||||||
|
|
||||||
import { html, nothing } from 'lit';
|
|
||||||
import type { TemplateResult } from 'lit';
|
|
||||||
|
|
||||||
import { inlineLinksSuppressed, openArtistPage, openAlbumPage } from './explore-link';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The entities one row or card can send you to.
|
|
||||||
*
|
|
||||||
* Everything is optional because the hosts differ: a track row knows
|
|
||||||
* both, an album card knows only its artist, and an artist page's own
|
|
||||||
* tracklist knows only the album.
|
|
||||||
*/
|
|
||||||
export interface GoToTarget {
|
|
||||||
artistName?: string;
|
|
||||||
artistMBID?: string;
|
|
||||||
albumName?: string;
|
|
||||||
albumMBID?: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface GoToHandlers {
|
|
||||||
/** Called before navigating: close the menu, clear the selection. */
|
|
||||||
onSelect?: () => void;
|
|
||||||
/** Called on hover: close a playlist submenu, where the host has one. */
|
|
||||||
onHover?: () => void;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The menu items for a target, or nothing at all where the name beside
|
|
||||||
* them is still a link.
|
|
||||||
*/
|
|
||||||
export function goToMenuItems(
|
|
||||||
target: GoToTarget | undefined,
|
|
||||||
handlers: GoToHandlers = {},
|
|
||||||
): TemplateResult | typeof nothing {
|
|
||||||
if (!target || !inlineLinksSuppressed()) return nothing;
|
|
||||||
|
|
||||||
const artist = target.artistName?.trim();
|
|
||||||
const album = target.albumName?.trim();
|
|
||||||
|
|
||||||
if (!artist && !album) return nothing;
|
|
||||||
|
|
||||||
return html`
|
|
||||||
${artist
|
|
||||||
? html`<wa-dropdown-item
|
|
||||||
data-testid="go-to-artist"
|
|
||||||
@click=${(e: Event) => {
|
|
||||||
handlers.onSelect?.();
|
|
||||||
void openArtistPage(
|
|
||||||
e.currentTarget as EventTarget,
|
|
||||||
artist,
|
|
||||||
target.artistMBID ?? '',
|
|
||||||
);
|
|
||||||
}}
|
|
||||||
@mouseenter=${() => handlers.onHover?.()}
|
|
||||||
>
|
|
||||||
<wa-icon slot="icon" name="user-group"></wa-icon>
|
|
||||||
Go to Artist
|
|
||||||
</wa-dropdown-item>`
|
|
||||||
: nothing}
|
|
||||||
${album
|
|
||||||
? html`<wa-dropdown-item
|
|
||||||
data-testid="go-to-album"
|
|
||||||
@click=${(e: Event) => {
|
|
||||||
handlers.onSelect?.();
|
|
||||||
void openAlbumPage(
|
|
||||||
e.currentTarget as EventTarget,
|
|
||||||
album,
|
|
||||||
target.albumMBID ?? '',
|
|
||||||
artist,
|
|
||||||
);
|
|
||||||
}}
|
|
||||||
@mouseenter=${() => handlers.onHover?.()}
|
|
||||||
>
|
|
||||||
<wa-icon slot="icon" name="compact-disc"></wa-icon>
|
|
||||||
Go to Album
|
|
||||||
</wa-dropdown-item>`
|
|
||||||
: nothing}
|
|
||||||
`;
|
|
||||||
}
|
|
||||||
@@ -1,156 +0,0 @@
|
|||||||
/**
|
|
||||||
* Warm the browser's image cache for the cards a scroll is about to
|
|
||||||
* reach.
|
|
||||||
*
|
|
||||||
* #65: album art pops in while scrolling. The rule this app already
|
|
||||||
* follows is that a row image is `loading="lazy" decoding="async"` and
|
|
||||||
* draws the smallest adequate tier, and both halves are in place —
|
|
||||||
* `cover-grid.getCoverUrl()` and `artists-view`'s avatar both pick
|
|
||||||
* `_sm`/`_md`/`_lg` from the card size and the device pixel ratio. What
|
|
||||||
* is left is *when* the fetch starts: the grids are virtualized, so the
|
|
||||||
* `<img>` does not exist at all until the virtualizer decides to render
|
|
||||||
* its card, and only then can the browser ask for anything.
|
|
||||||
*
|
|
||||||
* The issue's Direction asks for a larger overscan, and that is not
|
|
||||||
* available: `@lit-labs/virtualizer`'s `_overhang` is a hard-coded
|
|
||||||
* 1000px `protected` field on `BaseLayout` with no configuration
|
|
||||||
* surface, so raising it means monkey-patching a private. 1000px is
|
|
||||||
* about two screens on the reference device's 439px viewport, which is
|
|
||||||
* a fraction of a second at speed.
|
|
||||||
*
|
|
||||||
* So the request is issued ahead of the element instead. Cover art and
|
|
||||||
* artist images are plain URLs served by `coverart.Handler` /
|
|
||||||
* `explore`'s image handler under `Cache-Control: public,
|
|
||||||
* max-age=31536000, immutable` — the filenames are content hashes — so
|
|
||||||
* a prefetched image is a cache hit by the time the card is drawn, and
|
|
||||||
* a second pass over the same rows costs nothing at all.
|
|
||||||
*
|
|
||||||
* Three things about it are load-bearing.
|
|
||||||
*
|
|
||||||
* **This is not the `LRUMap` path the issue's Findings warn about.**
|
|
||||||
* That ceiling (`ARTIST_IMAGE_CACHE_LIMIT` and friends) bounds
|
|
||||||
* Explore's base64 data URLs, which are held in JS. A library cover is
|
|
||||||
* a URL, and what retains the bytes is the browser's own HTTP cache,
|
|
||||||
* which evicts on its own terms. What this module retains is the *set
|
|
||||||
* of URLs already asked for*, which is why that set has a cap and
|
|
||||||
* reports itself to `window.__yjCacheStats()` — the measurement the
|
|
||||||
* issue asks for.
|
|
||||||
*
|
|
||||||
* **A window is warmed on both sides of the rendered range.** The
|
|
||||||
* event carries no direction, and scrolling back up needs the same
|
|
||||||
* treatment; the rows behind are already in `requested` from the pass
|
|
||||||
* that rendered them, so the backward half issues nothing in the
|
|
||||||
* common case and is free.
|
|
||||||
*
|
|
||||||
* **An in-flight image is held.** `new Image().src = url` and drop it
|
|
||||||
* is the usual idiom and usually survives, but "usually" is an engine
|
|
||||||
* detail and the engine that matters here is a two-year-old WebView.
|
|
||||||
* The element is kept until it loads or fails, and no longer — nothing
|
|
||||||
* here holds a decoded bitmap on purpose.
|
|
||||||
*/
|
|
||||||
|
|
||||||
import { registerCacheProbe } from './cache-stats.js';
|
|
||||||
import { LRUMap } from './lru-map.js';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* How many entries past each edge of the rendered range to warm.
|
|
||||||
*
|
|
||||||
* Entries rather than pixels, because that is what the event reports
|
|
||||||
* and what the caller has an array of. Twelve rows on the phone's
|
|
||||||
* two-column grid and four on a desktop's six, on top of the
|
|
||||||
* virtualizer's own 1000px — enough to cover a flick, and bounded so a
|
|
||||||
* fast scroll through 5 000 albums cannot ask for 5 000 covers.
|
|
||||||
*/
|
|
||||||
export const PREFETCH_AHEAD = 24;
|
|
||||||
|
|
||||||
/** Ceiling on the record of what has already been asked for. */
|
|
||||||
export const PREFETCH_MEMORY = 512;
|
|
||||||
|
|
||||||
/** URLs already requested; the value is a placeholder, the key is the record. */
|
|
||||||
const requested = new LRUMap<string, true>(PREFETCH_MEMORY);
|
|
||||||
|
|
||||||
/** Images still loading, held so the request cannot be collected. */
|
|
||||||
const inFlight = new Set<HTMLImageElement>();
|
|
||||||
|
|
||||||
registerCacheProbe('imagePrefetch', () => {
|
|
||||||
let chars = 0;
|
|
||||||
|
|
||||||
for (const url of requested.keys()) chars += url.length;
|
|
||||||
|
|
||||||
return { entries: requested.size, chars, limit: PREFETCH_MEMORY };
|
|
||||||
});
|
|
||||||
|
|
||||||
/** Whether this URL has already been asked for. */
|
|
||||||
export function imagePrefetched(url: string): boolean {
|
|
||||||
return requested.has(url);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Ask the browser for `url` unless it has already been asked for.
|
|
||||||
* Returns whether a request was issued.
|
|
||||||
*/
|
|
||||||
export function prefetchImage(url: string): boolean {
|
|
||||||
if (!url || requested.has(url)) return false;
|
|
||||||
|
|
||||||
requested.set(url, true);
|
|
||||||
|
|
||||||
const img = new Image();
|
|
||||||
|
|
||||||
inFlight.add(img);
|
|
||||||
|
|
||||||
const done = () => {
|
|
||||||
inFlight.delete(img);
|
|
||||||
};
|
|
||||||
|
|
||||||
img.addEventListener('load', done, { once: true });
|
|
||||||
img.addEventListener('error', done, { once: true });
|
|
||||||
img.decoding = 'async';
|
|
||||||
img.src = url;
|
|
||||||
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Warm the images either side of a virtualizer's rendered range.
|
|
||||||
*
|
|
||||||
* `first`/`last` are the indices the `visibilityChanged` event
|
|
||||||
* reported; `urlOf` returns the image the card at that index will
|
|
||||||
* draw, or `''` where it draws a placeholder. Returns how many
|
|
||||||
* requests were issued, which is what a test can assert on and what
|
|
||||||
* makes "a second run does approximately nothing" checkable.
|
|
||||||
*/
|
|
||||||
export function prefetchImageWindow<T>(
|
|
||||||
items: readonly T[],
|
|
||||||
first: number,
|
|
||||||
last: number,
|
|
||||||
urlOf: (item: T) => string,
|
|
||||||
ahead: number = PREFETCH_AHEAD,
|
|
||||||
): number {
|
|
||||||
if (items.length === 0 || first < 0 || last < first) return 0;
|
|
||||||
|
|
||||||
const from = Math.max(0, first - ahead);
|
|
||||||
const to = Math.min(items.length - 1, last + ahead);
|
|
||||||
let issued = 0;
|
|
||||||
|
|
||||||
// Forward first: it is the direction a scroll is usually going, so
|
|
||||||
// it is the half that has to win the race.
|
|
||||||
for (let i = last + 1; i <= to; i++) {
|
|
||||||
const item = items[i];
|
|
||||||
|
|
||||||
if (item !== undefined && prefetchImage(urlOf(item))) issued++;
|
|
||||||
}
|
|
||||||
|
|
||||||
for (let i = from; i < first; i++) {
|
|
||||||
const item = items[i];
|
|
||||||
|
|
||||||
if (item !== undefined && prefetchImage(urlOf(item))) issued++;
|
|
||||||
}
|
|
||||||
|
|
||||||
return issued;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Forget what has been asked for. For tests; the app never needs it. */
|
|
||||||
export function resetImagePrefetch(): void {
|
|
||||||
requested.clear();
|
|
||||||
inFlight.clear();
|
|
||||||
}
|
|
||||||
BIN
Binary file not shown.
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 15 KiB |
BIN
Binary file not shown.
|
Before Width: | Height: | Size: 6.7 KiB After Width: | Height: | Size: 4.4 KiB |
@@ -1,190 +0,0 @@
|
|||||||
/**
|
|
||||||
* The grids ask for the art below the fold before the card exists
|
|
||||||
* (#65).
|
|
||||||
*
|
|
||||||
* Reported as "scrolling through albums, the art pops in". The cards
|
|
||||||
* already draw the smallest adequate tier and are already
|
|
||||||
* `loading="lazy"`, so what was left is *when*: `<lit-virtualizer>`
|
|
||||||
* renders about 1000px past the viewport and the `<img>` — and
|
|
||||||
* therefore the request — does not exist until it does. On the
|
|
||||||
* reference device that is about two screens.
|
|
||||||
*
|
|
||||||
* These assert the mechanism, since no tier here can photograph a
|
|
||||||
* pop-in: that the rows past the rendered range are requested, that
|
|
||||||
* the request is for the same tier the card will draw, and that the
|
|
||||||
* window has an end — an unbounded prefetch of a 5 000-album library
|
|
||||||
* is the failure this trades against.
|
|
||||||
*
|
|
||||||
* What is *not* asserted here is that a rendered card was never
|
|
||||||
* prefetched. It often was, honestly: the grid lays out more than once
|
|
||||||
* on mount, so a row warmed by the first pass is drawn by the second,
|
|
||||||
* which is the whole point. The rule that a single pass skips its own
|
|
||||||
* rendered range is `image-prefetch.test.ts`'s, where one call can be
|
|
||||||
* looked at on its own.
|
|
||||||
*/
|
|
||||||
import { describe, expect, it, beforeEach } from 'vitest';
|
|
||||||
import type { LitElement } from 'lit';
|
|
||||||
|
|
||||||
import '@components/cover-grid/cover-grid';
|
|
||||||
import '@components/artists-view/artists-view';
|
|
||||||
import { emit, stub, flush, resetHarness } from '@test/support/harness';
|
|
||||||
import { Events } from '../../src/events';
|
|
||||||
import { fixture, shadowAll } from '@test/support/render';
|
|
||||||
import {
|
|
||||||
PREFETCH_AHEAD,
|
|
||||||
imagePrefetched,
|
|
||||||
resetImagePrefetch,
|
|
||||||
} from '@utils/image-prefetch';
|
|
||||||
|
|
||||||
/** Enough albums that the virtualizer's own window is nowhere near the end. */
|
|
||||||
const ALBUMS = Array.from({ length: 400 }, (_, i) => {
|
|
||||||
const n = String(i + 1).padStart(4, '0');
|
|
||||||
|
|
||||||
return {
|
|
||||||
ID: i + 1,
|
|
||||||
Name: `Album ${n}`,
|
|
||||||
ArtistName: 'Aurora Fields',
|
|
||||||
Year: 2020,
|
|
||||||
CoverArtPath: `/covers/${n}.jpg`,
|
|
||||||
CoverArtSmall: `/covers/${n}_sm.jpg`,
|
|
||||||
CoverArtMedium: `/covers/${n}_md.jpg`,
|
|
||||||
CoverArtLarge: `/covers/${n}_lg.jpg`,
|
|
||||||
};
|
|
||||||
});
|
|
||||||
|
|
||||||
const ARTISTS = Array.from({ length: 400 }, (_, i) => {
|
|
||||||
const n = String(i + 1).padStart(4, '0');
|
|
||||||
|
|
||||||
return {
|
|
||||||
ID: i + 1,
|
|
||||||
Name: `Artist ${n}`,
|
|
||||||
AlbumCount: 2,
|
|
||||||
TrackCount: 9,
|
|
||||||
ImageSmall: `/artists/${n}_sm.jpg`,
|
|
||||||
ImageMedium: `/artists/${n}_md.jpg`,
|
|
||||||
ImageLarge: `/artists/${n}_lg.jpg`,
|
|
||||||
};
|
|
||||||
});
|
|
||||||
|
|
||||||
/** Give the virtualizer a viewport; a zero-height host renders nothing. */
|
|
||||||
function sized(el: HTMLElement): void {
|
|
||||||
el.style.display = 'block';
|
|
||||||
el.style.height = '600px';
|
|
||||||
el.style.width = '900px';
|
|
||||||
}
|
|
||||||
|
|
||||||
async function settle(el: LitElement): Promise<void> {
|
|
||||||
await flush();
|
|
||||||
await el.updateComplete;
|
|
||||||
await new Promise((r) => setTimeout(r, 200));
|
|
||||||
}
|
|
||||||
|
|
||||||
/** The `src` of every card the grid actually rendered. */
|
|
||||||
function renderedSources(el: LitElement, selector: string): string[] {
|
|
||||||
return shadowAll(el, selector)
|
|
||||||
.map((img) => (img as HTMLImageElement).getAttribute('src') ?? '')
|
|
||||||
.filter(Boolean);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The last index the virtualizer has rendered, read off the cards
|
|
||||||
* rather than counted: the rendered range is what the prefetch window
|
|
||||||
* is measured from, and a count assumes it starts at 0 and has no
|
|
||||||
* gaps.
|
|
||||||
*/
|
|
||||||
function lastRenderedIndex(el: LitElement, selector: string): number {
|
|
||||||
const indices = shadowAll(el, selector).map((card) =>
|
|
||||||
Number(card.getAttribute('data-index')),
|
|
||||||
);
|
|
||||||
|
|
||||||
return Math.max(...indices);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The tier the cards chose, read off a rendered card rather than
|
|
||||||
* recomputed — the point of the assertion is that the prefetch and the
|
|
||||||
* card agree, so deriving both from the same ladder here would prove
|
|
||||||
* nothing.
|
|
||||||
*/
|
|
||||||
function tierSuffix(src: string): string {
|
|
||||||
const m = /_(sm|md|lg)\.jpg$/.exec(src);
|
|
||||||
|
|
||||||
return m ? `_${m[1]}` : '';
|
|
||||||
}
|
|
||||||
|
|
||||||
beforeEach(() => {
|
|
||||||
resetHarness();
|
|
||||||
resetImagePrefetch();
|
|
||||||
localStorage.clear();
|
|
||||||
stub('library.Library.GetAlbums', ALBUMS);
|
|
||||||
stub('library.Library.GetArtists', ARTISTS);
|
|
||||||
stub('library.Library.GetTracks', []);
|
|
||||||
stub('library.Library.GetGenres', []);
|
|
||||||
emit(Events.LibraryScanComplete);
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('the albums grid warms the covers below the fold', () => {
|
|
||||||
it('asks for the covers past the rendered range, in the tier the card draws', async () => {
|
|
||||||
const el = await fixture<LitElement>('cover-grid');
|
|
||||||
|
|
||||||
sized(el);
|
|
||||||
await settle(el);
|
|
||||||
|
|
||||||
const rendered = renderedSources(el, 'img.cover-image');
|
|
||||||
|
|
||||||
expect(rendered.length).toBeGreaterThan(0);
|
|
||||||
|
|
||||||
const tier = tierSuffix(rendered[0]!);
|
|
||||||
const url = (index: number) =>
|
|
||||||
`/covers/${String(index + 1).padStart(4, '0')}${tier}.jpg`;
|
|
||||||
|
|
||||||
// The grid starts at the top and never scrolls here, so the whole
|
|
||||||
// window lies past the last card drawn.
|
|
||||||
const last = lastRenderedIndex(el, '.album-card');
|
|
||||||
|
|
||||||
expect(imagePrefetched(url(last + 1))).toBe(true);
|
|
||||||
expect(imagePrefetched(url(last + PREFETCH_AHEAD))).toBe(true);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('stops at the end of the window rather than warming the library', async () => {
|
|
||||||
const el = await fixture<LitElement>('cover-grid');
|
|
||||||
|
|
||||||
sized(el);
|
|
||||||
await settle(el);
|
|
||||||
|
|
||||||
const rendered = renderedSources(el, 'img.cover-image');
|
|
||||||
const tier = tierSuffix(rendered[0]!);
|
|
||||||
const url = (index: number) =>
|
|
||||||
`/covers/${String(index + 1).padStart(4, '0')}${tier}.jpg`;
|
|
||||||
|
|
||||||
// Not "exactly `last + PREFETCH_AHEAD`": the grid lays out more
|
|
||||||
// than once on mount and each pass warms a window from wherever
|
|
||||||
// the rendered range was then, so the reachable set is a few
|
|
||||||
// windows wide. The property that matters is that it is a window
|
|
||||||
// at all rather than the library.
|
|
||||||
expect(imagePrefetched(url(399))).toBe(false);
|
|
||||||
expect(window.__yjCacheStats?.()['imagePrefetch']?.entries ?? 0)
|
|
||||||
.toBeLessThan(ALBUMS.length / 2);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('the artists grid warms its avatars the same way', () => {
|
|
||||||
it('asks for the avatars past the rendered range', async () => {
|
|
||||||
const el = await fixture<LitElement>('artists-view');
|
|
||||||
|
|
||||||
sized(el);
|
|
||||||
await settle(el);
|
|
||||||
|
|
||||||
const rendered = renderedSources(el, 'img.avatar-image');
|
|
||||||
|
|
||||||
expect(rendered.length).toBeGreaterThan(0);
|
|
||||||
|
|
||||||
const tier = tierSuffix(rendered[0]!);
|
|
||||||
const last = lastRenderedIndex(el, '.artist-card');
|
|
||||||
const url = (index: number) =>
|
|
||||||
`/artists/${String(index + 1).padStart(4, '0')}${tier}.jpg`;
|
|
||||||
|
|
||||||
expect(imagePrefetched(url(last + 1))).toBe(true);
|
|
||||||
expect(imagePrefetched(url(399))).toBe(false);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -193,119 +193,4 @@ describe('bottom-nav', () => {
|
|||||||
expect(shadow<HTMLElement>(el, 'app-sidebar')?.hasAttribute('expanded'))
|
expect(shadow<HTMLElement>(el, 'app-sidebar')?.hasAttribute('expanded'))
|
||||||
.toBe(true);
|
.toBe(true);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('draws "More" as a sheet rising from the bottom', async () => {
|
|
||||||
const el = await fixture<Nav>('bottom-nav');
|
|
||||||
const drawer = shadow<HTMLElement>(el, 'wa-drawer');
|
|
||||||
|
|
||||||
// #71. A side drawer is a desktop shape: it opened away from the
|
|
||||||
// thumb that asked for it and drew a 200px column of a 424px
|
|
||||||
// screen. `placement` is the whole of the change to *where* it
|
|
||||||
// comes from, and `without-header` is what makes it the same sheet
|
|
||||||
// `menu-surface` draws rather than a second pattern with a title
|
|
||||||
// bar and a close button.
|
|
||||||
expect(drawer?.getAttribute('placement')).toBe('bottom');
|
|
||||||
expect(drawer?.hasAttribute('without-header')).toBe(true);
|
|
||||||
|
|
||||||
// Named all the same: `nameDialog`'s documented aria-label path,
|
|
||||||
// since without-header renders no heading to point at.
|
|
||||||
expect(drawer?.getAttribute('label')).toBe('All views');
|
|
||||||
});
|
|
||||||
|
|
||||||
it('leaves exactly one scroll container, and it is the sheet body', async () => {
|
|
||||||
const el = await fixture<Nav>('bottom-nav');
|
|
||||||
const drawer = shadow<HTMLElement & { open: boolean }>(el, 'wa-drawer');
|
|
||||||
|
|
||||||
if (!drawer) throw new Error('no drawer');
|
|
||||||
|
|
||||||
const shown = once(drawer, 'wa-after-show');
|
|
||||||
|
|
||||||
shadow<HTMLButtonElement>(el, '[data-testid="tab-more"]')?.click();
|
|
||||||
await shown;
|
|
||||||
await update(el, {});
|
|
||||||
|
|
||||||
// The report is "only part of the screen scrolls under my finger",
|
|
||||||
// and the cause is three boxes that each scroll: the dialog, its
|
|
||||||
// body, and the sidebar's own overflow-y host. Which one a drag
|
|
||||||
// moves depends on where the finger landed.
|
|
||||||
const dialog = drawer.shadowRoot?.querySelector('[part~="dialog"]');
|
|
||||||
const body = drawer.shadowRoot?.querySelector('[part~="body"]');
|
|
||||||
const sidebar = shadow<HTMLElement>(el, 'app-sidebar');
|
|
||||||
|
|
||||||
if (!dialog || !body || !sidebar) throw new Error('no sheet');
|
|
||||||
|
|
||||||
expect(getComputedStyle(dialog).overflowY).toBe('hidden');
|
|
||||||
expect(getComputedStyle(body).overflowY).toBe('auto');
|
|
||||||
expect(getComputedStyle(sidebar).overflowY).toBe('visible');
|
|
||||||
|
|
||||||
// And the one that does scroll keeps it to itself, or reaching the
|
|
||||||
// end of the destinations scrolls the page behind the sheet.
|
|
||||||
expect(getComputedStyle(body).overscrollBehaviorY).toBe('contain');
|
|
||||||
});
|
|
||||||
|
|
||||||
it('gives the sheet the whole width, which the sidebar does not take', async () => {
|
|
||||||
const el = await fixture<Nav>('bottom-nav');
|
|
||||||
|
|
||||||
shadow<HTMLButtonElement>(el, '[data-testid="tab-more"]')?.click();
|
|
||||||
await update(el, {});
|
|
||||||
|
|
||||||
const sidebar = shadow<HTMLElement>(el, 'app-sidebar');
|
|
||||||
|
|
||||||
if (!sidebar) throw new Error('no sidebar');
|
|
||||||
|
|
||||||
// `app-sidebar` writes an *inline* width and caps itself at 400px,
|
|
||||||
// which beats any rule this host could write — so "the host owns
|
|
||||||
// the box" has to be part of what `expanded` means, or the sheet
|
|
||||||
// draws the old 200px column inside a full-width surface.
|
|
||||||
expect(sidebar.style.width).toBe('100%');
|
|
||||||
expect(getComputedStyle(sidebar).maxWidth).toBe('none');
|
|
||||||
});
|
|
||||||
|
|
||||||
it('sizes the sheet rows for a thumb, below the phone breakpoint', async () => {
|
|
||||||
const el = await fixture<Nav>('bottom-nav');
|
|
||||||
|
|
||||||
shadow<HTMLButtonElement>(el, '[data-testid="tab-more"]')?.click();
|
|
||||||
await update(el, {});
|
|
||||||
|
|
||||||
const sidebar = shadow<HTMLElement>(el, 'app-sidebar');
|
|
||||||
const sheets = sidebar?.shadowRoot?.adoptedStyleSheets ?? [];
|
|
||||||
const phoneRules: string[] = [];
|
|
||||||
|
|
||||||
for (const sheet of sheets) {
|
|
||||||
for (const rule of Array.from(sheet.cssRules)) {
|
|
||||||
if (!(rule instanceof CSSMediaRule)) continue;
|
|
||||||
|
|
||||||
if (!/max-width:\s*599px/.test(rule.conditionText)) continue;
|
|
||||||
|
|
||||||
for (const inner of Array.from(rule.cssRules)) {
|
|
||||||
phoneRules.push(inner.cssText);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Asserted against the parsed stylesheet, like
|
|
||||||
// `hover-affordance.test.ts` and for the same reason: this tier's
|
|
||||||
// iframe is not 599px wide, so the rule cannot be *rendered* here —
|
|
||||||
// but the regression worth catching is someone moving it out of the
|
|
||||||
// query, which nothing on a desktop draws differently.
|
|
||||||
expect(phoneRules.length).toBeGreaterThan(0);
|
|
||||||
expect(phoneRules.some((r) => /min-height:\s*48px/.test(r))).toBe(true);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('takes the resize handle out of the sheet', async () => {
|
|
||||||
const el = await fixture<Nav>('bottom-nav');
|
|
||||||
|
|
||||||
shadow<HTMLButtonElement>(el, '[data-testid="tab-more"]')?.click();
|
|
||||||
await update(el, {});
|
|
||||||
|
|
||||||
const handle = shadow<HTMLElement>(el, 'app-sidebar')
|
|
||||||
?.shadowRoot?.querySelector('.resize-handle');
|
|
||||||
|
|
||||||
if (!handle) throw new Error('no resize handle');
|
|
||||||
|
|
||||||
// A col-resize strip on the right edge of a touch surface: the
|
|
||||||
// compatibility mouse events a tap synthesises reach its
|
|
||||||
// `mousedown`, so it can start a resize nobody asked for.
|
|
||||||
expect(getComputedStyle(handle).display).toBe('none');
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -137,11 +137,6 @@ describe('<app-sidebar>', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
it('looks the way it did last time', async () => {
|
it('looks the way it did last time', async () => {
|
||||||
// Stated rather than inherited: `activeViewStore` is a singleton, so
|
|
||||||
// without this the shot records whichever view the *previous* case
|
|
||||||
// left in it and the reference moves when the file is reordered.
|
|
||||||
activeViewStore.setView('home', true);
|
|
||||||
|
|
||||||
const el = await fixture('app-sidebar');
|
const el = await fixture('app-sidebar');
|
||||||
|
|
||||||
await visual(el, 'app-sidebar');
|
await visual(el, 'app-sidebar');
|
||||||
|
|||||||
@@ -206,56 +206,6 @@ describe('menu-surface', () => {
|
|||||||
expect(dismissed, 'no menu-dismiss reached the document').toBe(1);
|
expect(dismissed, 'no menu-dismiss reached the document').toBe(1);
|
||||||
});
|
});
|
||||||
|
|
||||||
/**
|
|
||||||
* The scroll affordance (#207), and this is the mechanism again
|
|
||||||
* rather than the symptom.
|
|
||||||
*
|
|
||||||
* The sheet's body has scrolled since #60 and said nothing about
|
|
||||||
* it: measured at 424x439, eight items ended at y=470 with the
|
|
||||||
* fold at 439, and where the cut lands on a row boundary the sheet
|
|
||||||
* ends in a clean edge that reads as the end of the list.
|
|
||||||
*
|
|
||||||
* What makes the fade *conditional* — absent on a menu that fits,
|
|
||||||
* present the moment one does not, gone again at the end of the
|
|
||||||
* list — is `background-attachment`, not a scroll listener: a cover
|
|
||||||
* of the sheet's own colour is painted at the end of the content
|
|
||||||
* and attached `local`, over a shadow pinned to the box and
|
|
||||||
* attached `scroll`. So the pair of attachments *is* the feature,
|
|
||||||
* and it is what this asserts. The rendered result was measured in
|
|
||||||
* the harness (dark ramp 52,58,64 flat before; 52,57,63 at the last
|
|
||||||
* label and 22,24,27 at the bottom edge with more below; flat again
|
|
||||||
* at the end of the list) and is on the PR.
|
|
||||||
*/
|
|
||||||
it('paints the fade only while there is more below', async () => {
|
|
||||||
const el = await surfaceWithPanel();
|
|
||||||
|
|
||||||
const wrapper = el.shadowRoot?.querySelector('wa-dialog');
|
|
||||||
|
|
||||||
await (wrapper as HTMLElement & { updateComplete: Promise<unknown> })
|
|
||||||
.updateComplete;
|
|
||||||
|
|
||||||
const body = wrapper?.shadowRoot?.querySelector('[part~="body"]');
|
|
||||||
|
|
||||||
expect(body, 'no body part to scroll').not.toBeNull();
|
|
||||||
|
|
||||||
const style = getComputedStyle(body as Element);
|
|
||||||
|
|
||||||
expect(style.overflowY, 'the body is what gives, not the cap').toBe(
|
|
||||||
'auto',
|
|
||||||
);
|
|
||||||
|
|
||||||
// The cover scrolls with the content; the shadow does not. Either
|
|
||||||
// one alone is a fade that is always there or never there.
|
|
||||||
expect(
|
|
||||||
style.backgroundAttachment,
|
|
||||||
'the cover must be local and the shadow must not',
|
|
||||||
).toBe('local, scroll');
|
|
||||||
|
|
||||||
// Both sit at the bottom, or the cover hides nothing.
|
|
||||||
expect(style.backgroundPosition).toBe('50% 100%, 50% 100%');
|
|
||||||
expect(style.backgroundSize).toBe('100% 32px, 100% 32px');
|
|
||||||
});
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A dialog with no accessible name is what `utils/name-dialog.ts`
|
* A dialog with no accessible name is what `utils/name-dialog.ts`
|
||||||
* exists for; here the name is already written on the panel, so no
|
* exists for; here the name is already written on the panel, so no
|
||||||
|
|||||||
@@ -366,16 +366,6 @@ describe('<now-playing>', () => {
|
|||||||
const el = await fixture('now-playing');
|
const el = await fixture('now-playing');
|
||||||
|
|
||||||
emit(Events.TrackChanged, { ...TRACK, trackChangeId: 6 });
|
emit(Events.TrackChanged, { ...TRACK, trackChangeId: 6 });
|
||||||
// Stated rather than inherited: the queue store is a singleton, so
|
|
||||||
// without this the shot records whichever source the *previous*
|
|
||||||
// case left in it and the reference moves when the file is
|
|
||||||
// reordered. Three lines is what the bar renders while playing
|
|
||||||
// from somewhere, which is the arrangement worth recording.
|
|
||||||
setQueue([queueTrack(1, 'Ashes to Ashes')], 0, {
|
|
||||||
type: 'album',
|
|
||||||
id: 7,
|
|
||||||
label: 'Scary Monsters',
|
|
||||||
});
|
|
||||||
await flush();
|
await flush();
|
||||||
await el.updateComplete;
|
await el.updateComplete;
|
||||||
|
|
||||||
|
|||||||
@@ -1,275 +0,0 @@
|
|||||||
/**
|
|
||||||
* A name is not a link on a phone, and the menu is where it went (#67).
|
|
||||||
*
|
|
||||||
* `utils/explore-link.ts` makes every track, album and artist name
|
|
||||||
* navigable, with click handling that is explicitly a desktop
|
|
||||||
* compromise — the navigation is held for one double-click interval so
|
|
||||||
* double-clicking the row can still play it. On touch that is a delay
|
|
||||||
* on an ambiguous target, and since #63 the row's own tap claims the
|
|
||||||
* click anyway, so the link was unreachable as well as fiddly.
|
|
||||||
*
|
|
||||||
* So below the phone breakpoint a name renders as plain text and the
|
|
||||||
* row's context menu carries "Go to Artist" / "Go to Album" instead.
|
|
||||||
* The two halves are asserted together on purpose: a suppressed link
|
|
||||||
* with no menu item behind it is not a smaller affordance, it is a
|
|
||||||
* destination that cannot be reached, which is what plan 018 promises
|
|
||||||
* against.
|
|
||||||
*
|
|
||||||
* The breakpoint is stubbed rather than emulated for the reason
|
|
||||||
* `now-playing-phone.test.ts` states: this tier's viewport is fixed at
|
|
||||||
* 1280x800 by the runner, and `matchMedia` is the seam.
|
|
||||||
*/
|
|
||||||
import { describe, expect, it, beforeEach, afterEach } from 'vitest';
|
|
||||||
import { html, render } from 'lit';
|
|
||||||
import type { LitElement } from 'lit';
|
|
||||||
|
|
||||||
import '@components/playlist-details/playlist-details';
|
|
||||||
import {
|
|
||||||
albumLink,
|
|
||||||
artistLink,
|
|
||||||
creditLink,
|
|
||||||
trackLink,
|
|
||||||
} from '@utils/explore-link';
|
|
||||||
import { goToMenuItems } from '@utils/go-to-menu';
|
|
||||||
import { stub, flush, resetHarness } from '@test/support/harness';
|
|
||||||
import { fixture, shadowAll } from '@test/support/render';
|
|
||||||
|
|
||||||
/** Answer the phone breakpoint, and hand back the undo. */
|
|
||||||
function atPhone(phone: boolean): () => void {
|
|
||||||
const real = window.matchMedia.bind(window);
|
|
||||||
|
|
||||||
window.matchMedia = ((q: string) =>
|
|
||||||
q.includes('max-width: 599px')
|
|
||||||
? {
|
|
||||||
matches: phone,
|
|
||||||
media: q,
|
|
||||||
addEventListener() {},
|
|
||||||
removeEventListener() {},
|
|
||||||
}
|
|
||||||
: real(q)) as typeof window.matchMedia;
|
|
||||||
|
|
||||||
return () => {
|
|
||||||
window.matchMedia = real as typeof window.matchMedia;
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Render a template into a detached container and hand it back. */
|
|
||||||
function draw(template: unknown): HTMLElement {
|
|
||||||
const host = document.createElement('div');
|
|
||||||
|
|
||||||
document.body.append(host);
|
|
||||||
render(html`${template}`, host);
|
|
||||||
|
|
||||||
return host;
|
|
||||||
}
|
|
||||||
|
|
||||||
describe('an inline name below the phone breakpoint', () => {
|
|
||||||
let restore: () => void = () => {};
|
|
||||||
|
|
||||||
afterEach(() => {
|
|
||||||
restore();
|
|
||||||
document.querySelectorAll('body > div').forEach((el) => el.remove());
|
|
||||||
});
|
|
||||||
|
|
||||||
it('is a link on a desktop', () => {
|
|
||||||
restore = atPhone(false);
|
|
||||||
|
|
||||||
const host = draw(artistLink('Cocteau Twins', 'artist-mbid'));
|
|
||||||
|
|
||||||
expect(host.querySelector('a.explore-link')).not.toBeNull();
|
|
||||||
expect(host.textContent?.trim()).toBe('Cocteau Twins');
|
|
||||||
});
|
|
||||||
|
|
||||||
it('is plain text on a phone, for all four shapes', () => {
|
|
||||||
restore = atPhone(true);
|
|
||||||
|
|
||||||
const host = draw(html`
|
|
||||||
${artistLink('Cocteau Twins', 'artist-mbid')}
|
|
||||||
${albumLink('Heaven or Las Vegas', 'rg-mbid')}
|
|
||||||
${trackLink('Iceblink Luck', 'Heaven or Las Vegas', 'rg-mbid', 'rec-mbid')}
|
|
||||||
${creditLink(
|
|
||||||
[
|
|
||||||
{
|
|
||||||
creditedName: 'Skrillex',
|
|
||||||
artistMbid: 'a1',
|
|
||||||
joinPhrase: ' feat. ',
|
|
||||||
},
|
|
||||||
{ creditedName: 'Swae Lee', artistMbid: 'a2', joinPhrase: '' },
|
|
||||||
],
|
|
||||||
'Skrillex & Swae Lee',
|
|
||||||
'a1',
|
|
||||||
)}
|
|
||||||
`);
|
|
||||||
|
|
||||||
expect(host.querySelectorAll('a.explore-link')).toHaveLength(0);
|
|
||||||
|
|
||||||
// The words survive, join phrases included — a decomposed credit is
|
|
||||||
// still assembled from its parts, so the text does not change with
|
|
||||||
// the affordance.
|
|
||||||
expect(host.textContent).toContain('Cocteau Twins');
|
|
||||||
expect(host.textContent).toContain('Heaven or Las Vegas');
|
|
||||||
expect(host.textContent).toContain('Iceblink Luck');
|
|
||||||
expect(host.textContent).toContain('Skrillex feat. Swae Lee');
|
|
||||||
});
|
|
||||||
|
|
||||||
it('stays a link where the caller has no menu to carry it', () => {
|
|
||||||
restore = atPhone(true);
|
|
||||||
|
|
||||||
const host = draw(
|
|
||||||
albumLink('Heaven or Las Vegas', 'rg-mbid', undefined, 'Cocteau Twins', {
|
|
||||||
keepOnPhone: true,
|
|
||||||
}),
|
|
||||||
);
|
|
||||||
|
|
||||||
expect(host.querySelector('a.explore-link')).not.toBeNull();
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('the "Go to" menu items', () => {
|
|
||||||
let restore: () => void = () => {};
|
|
||||||
|
|
||||||
afterEach(() => {
|
|
||||||
restore();
|
|
||||||
document.querySelectorAll('body > div').forEach((el) => el.remove());
|
|
||||||
});
|
|
||||||
|
|
||||||
it('are absent on a desktop, where the name beside them is a link', () => {
|
|
||||||
restore = atPhone(false);
|
|
||||||
|
|
||||||
const host = draw(
|
|
||||||
goToMenuItems({ artistName: 'Cocteau Twins', albumName: 'Treasure' }),
|
|
||||||
);
|
|
||||||
|
|
||||||
expect(host.querySelectorAll('wa-dropdown-item')).toHaveLength(0);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('offer only what the target knows', () => {
|
|
||||||
restore = atPhone(true);
|
|
||||||
|
|
||||||
const both = draw(
|
|
||||||
goToMenuItems({ artistName: 'Cocteau Twins', albumName: 'Treasure' }),
|
|
||||||
);
|
|
||||||
const artistOnly = draw(goToMenuItems({ artistName: 'Cocteau Twins' }));
|
|
||||||
const neither = draw(goToMenuItems({}));
|
|
||||||
|
|
||||||
expect(both.querySelectorAll('wa-dropdown-item')).toHaveLength(2);
|
|
||||||
expect(artistOnly.querySelectorAll('wa-dropdown-item')).toHaveLength(1);
|
|
||||||
expect(neither.querySelectorAll('wa-dropdown-item')).toHaveLength(0);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
// =====================================================================
|
|
||||||
// The menu that carries the destination
|
|
||||||
// =====================================================================
|
|
||||||
|
|
||||||
function playlistTracks(n: number) {
|
|
||||||
return Array.from({ length: n }, (_, i) => ({
|
|
||||||
ID: i + 1,
|
|
||||||
FilePath: `/music/track-${i}.mp3`,
|
|
||||||
Title: `Track ${i}`,
|
|
||||||
Artist: 'Cocteau Twins',
|
|
||||||
ArtistMBID: 'artist-mbid',
|
|
||||||
Album: 'Heaven or Las Vegas',
|
|
||||||
ReleaseGroupMBID: 'rg-mbid',
|
|
||||||
Duration: 180000,
|
|
||||||
Phantom: false,
|
|
||||||
}));
|
|
||||||
}
|
|
||||||
|
|
||||||
describe('a playlist row’s context menu on a phone', () => {
|
|
||||||
let el: LitElement;
|
|
||||||
let restore: () => void = () => {};
|
|
||||||
|
|
||||||
beforeEach(async () => {
|
|
||||||
resetHarness();
|
|
||||||
restore = atPhone(true);
|
|
||||||
stub('playlist.Service.GetPlaylistTracks', playlistTracks(8));
|
|
||||||
stub('playlist.Service.GetAllPlaylists', []);
|
|
||||||
|
|
||||||
el = await fixture<LitElement>('playlist-details', {
|
|
||||||
playlistId: 1,
|
|
||||||
playlistName: 'A playlist',
|
|
||||||
});
|
|
||||||
el.style.display = 'block';
|
|
||||||
el.style.height = '600px';
|
|
||||||
await flush();
|
|
||||||
await el.updateComplete;
|
|
||||||
await new Promise((r) => setTimeout(r, 60));
|
|
||||||
});
|
|
||||||
|
|
||||||
afterEach(() => {
|
|
||||||
restore();
|
|
||||||
});
|
|
||||||
|
|
||||||
/** Right-click a row and hand back the menu's items. */
|
|
||||||
async function openMenu(index: number): Promise<HTMLElement[]> {
|
|
||||||
const row = shadowAll(el, '.track-item').find(
|
|
||||||
(r) => r.getAttribute('data-index') === String(index),
|
|
||||||
);
|
|
||||||
|
|
||||||
row!.dispatchEvent(
|
|
||||||
new MouseEvent('contextmenu', { bubbles: true, composed: true }),
|
|
||||||
);
|
|
||||||
await el.updateComplete;
|
|
||||||
|
|
||||||
return shadowAll<HTMLElement>(el, 'wa-dropdown-item');
|
|
||||||
}
|
|
||||||
|
|
||||||
it('carries the artist and the album the row stopped linking to', async () => {
|
|
||||||
const labels = (await openMenu(3)).map((i) => i.textContent?.trim());
|
|
||||||
|
|
||||||
expect(labels).toContain('Go to Artist');
|
|
||||||
expect(labels).toContain('Go to Album');
|
|
||||||
});
|
|
||||||
|
|
||||||
it('navigates where the name would have', async () => {
|
|
||||||
const seen: CustomEvent[] = [];
|
|
||||||
const listen = (e: Event) => seen.push(e as CustomEvent);
|
|
||||||
|
|
||||||
document.addEventListener('navigate', listen);
|
|
||||||
|
|
||||||
try {
|
|
||||||
const items = await openMenu(3);
|
|
||||||
|
|
||||||
items
|
|
||||||
.find((i) => i.textContent?.trim() === 'Go to Artist')!
|
|
||||||
.click();
|
|
||||||
await flush();
|
|
||||||
} finally {
|
|
||||||
document.removeEventListener('navigate', listen);
|
|
||||||
}
|
|
||||||
|
|
||||||
expect(seen.map((e) => e.detail)).toEqual([
|
|
||||||
{
|
|
||||||
view: 'explore-artist-details',
|
|
||||||
artistMBID: 'artist-mbid',
|
|
||||||
artistName: 'Cocteau Twins',
|
|
||||||
},
|
|
||||||
]);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('is absent while several rows are selected', async () => {
|
|
||||||
// "Go to the album" of five different albums means nothing, which
|
|
||||||
// is the rule the Play item already follows: one row is a
|
|
||||||
// position, several are an explicit choice of those tracks.
|
|
||||||
const rows = shadowAll(el, '.track-item');
|
|
||||||
const click = (i: number, modifiers: MouseEventInit) =>
|
|
||||||
rows
|
|
||||||
.find((r) => r.getAttribute('data-index') === String(i))!
|
|
||||||
.dispatchEvent(
|
|
||||||
new MouseEvent('click', {
|
|
||||||
bubbles: true,
|
|
||||||
composed: true,
|
|
||||||
...modifiers,
|
|
||||||
}),
|
|
||||||
);
|
|
||||||
|
|
||||||
click(1, {});
|
|
||||||
click(4, { ctrlKey: true });
|
|
||||||
await el.updateComplete;
|
|
||||||
|
|
||||||
const labels = (await openMenu(4)).map((i) => i.textContent?.trim());
|
|
||||||
|
|
||||||
expect(labels).not.toContain('Go to Artist');
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -161,15 +161,6 @@ describe('double-clicking a row in the track list', () => {
|
|||||||
localStorage.removeItem('track-list-column-widths');
|
localStorage.removeItem('track-list-column-widths');
|
||||||
|
|
||||||
el = await fixture<LitElement>('track-list', { externalTracks: LIST });
|
el = await fixture<LitElement>('track-list', { externalTracks: LIST });
|
||||||
|
|
||||||
// Say which order is being asserted rather than inheriting one.
|
|
||||||
// `restoreSortPreferences()` runs in `connectedCallback`, so the
|
|
||||||
// list opens in whatever sort was last persisted -- and
|
|
||||||
// `track-11` sorts before `track-3` by title, which is the shape
|
|
||||||
// of #138. The row below is the fixture's third track only while
|
|
||||||
// nothing is sorting the list.
|
|
||||||
(el as unknown as { sortField: string | null }).sortField = null;
|
|
||||||
|
|
||||||
el.style.display = 'block';
|
el.style.display = 'block';
|
||||||
el.style.height = '600px';
|
el.style.height = '600px';
|
||||||
await flush();
|
await flush();
|
||||||
@@ -181,10 +172,6 @@ describe('double-clicking a row in the track list', () => {
|
|||||||
const rows = shadowAll(el, '.track-row');
|
const rows = shadowAll(el, '.track-row');
|
||||||
const row = rows.find((r) => r.getAttribute('data-index') === '3');
|
const row = rows.find((r) => r.getAttribute('data-index') === '3');
|
||||||
|
|
||||||
// Stated first, so a list that is not in the order this asserts
|
|
||||||
// fails by saying so rather than as an off-by-eight file path.
|
|
||||||
expect(row?.getAttribute('data-file-path')).toBe('/music/track-3.mp3');
|
|
||||||
|
|
||||||
dblclick(row!);
|
dblclick(row!);
|
||||||
await flush();
|
await flush();
|
||||||
|
|
||||||
|
|||||||
@@ -72,23 +72,6 @@ document.body.style.margin = '0';
|
|||||||
|
|
||||||
beforeEach(() => {
|
beforeEach(() => {
|
||||||
resetHarness();
|
resetHarness();
|
||||||
|
|
||||||
// A test file does not get its own origin. `@vitest/browser-playwright`
|
|
||||||
// opens one BrowserContext per session and runs several files in it,
|
|
||||||
// one after another, so everything a component persists — the track
|
|
||||||
// list's sort and column widths, the cover size, `now-playing`'s
|
|
||||||
// scroll mode — is still there when the next file mounts the same
|
|
||||||
// component. That is invisible until it is intermittent, because
|
|
||||||
// which files share a tab and in what order changes run to run: it
|
|
||||||
// cost #138 three scheduled runs, one of them a PR with no frontend
|
|
||||||
// code in it at all.
|
|
||||||
//
|
|
||||||
// Clearing here rather than in the specs that write is deliberate —
|
|
||||||
// the spec that *reads* is never the one that knows. It is safe for
|
|
||||||
// the same reason the leak exists: files in a session are
|
|
||||||
// sequential, so this cannot wipe storage a concurrent file is in
|
|
||||||
// the middle of using.
|
|
||||||
localStorage.clear();
|
|
||||||
});
|
});
|
||||||
|
|
||||||
afterEach(() => {
|
afterEach(() => {
|
||||||
|
|||||||
@@ -1,2 +0,0 @@
|
|||||||
<!-- A real, servable image for the prefetch tests: one transparent pixel. -->
|
|
||||||
<svg xmlns="http://www.w3.org/2000/svg" width="1" height="1"></svg>
|
|
||||||
|
Before Width: | Height: | Size: 147 B |
@@ -1,113 +0,0 @@
|
|||||||
/**
|
|
||||||
* What the grids ask for ahead of the scroll (#65).
|
|
||||||
*
|
|
||||||
* The virtualizer renders about 1000px past its viewport and nothing
|
|
||||||
* else can be asked for, because the `<img>` does not exist until the
|
|
||||||
* card does — two screens on the reference device, which is a fraction
|
|
||||||
* of a second at speed. `prefetchImageWindow` issues the request
|
|
||||||
* before the element, so the assertions here are about *which* rows
|
|
||||||
* are asked for, that none is asked for twice, and that a request is
|
|
||||||
* really made rather than merely recorded.
|
|
||||||
*/
|
|
||||||
import { describe, expect, it, beforeEach } from 'vitest';
|
|
||||||
|
|
||||||
import {
|
|
||||||
PREFETCH_MEMORY,
|
|
||||||
imagePrefetched,
|
|
||||||
prefetchImage,
|
|
||||||
prefetchImageWindow,
|
|
||||||
resetImagePrefetch,
|
|
||||||
} from '@utils/image-prefetch';
|
|
||||||
|
|
||||||
/** A hundred cards, each with its own cover URL. */
|
|
||||||
const CARDS = Array.from({ length: 100 }, (_, i) => ({ url: `/covers/${i}_sm.jpg` }));
|
|
||||||
|
|
||||||
const urlOf = (card: { url: string }) => card.url;
|
|
||||||
|
|
||||||
beforeEach(() => {
|
|
||||||
resetImagePrefetch();
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('warming the images a scroll is about to reach', () => {
|
|
||||||
it('asks for the rows just past the rendered range, and no further', () => {
|
|
||||||
const issued = prefetchImageWindow(CARDS, 40, 50, urlOf, 3);
|
|
||||||
|
|
||||||
// Three past each edge: 51-53 and 37-39.
|
|
||||||
expect(issued).toBe(6);
|
|
||||||
expect(imagePrefetched('/covers/51_sm.jpg')).toBe(true);
|
|
||||||
expect(imagePrefetched('/covers/53_sm.jpg')).toBe(true);
|
|
||||||
expect(imagePrefetched('/covers/54_sm.jpg')).toBe(false);
|
|
||||||
expect(imagePrefetched('/covers/39_sm.jpg')).toBe(true);
|
|
||||||
expect(imagePrefetched('/covers/37_sm.jpg')).toBe(true);
|
|
||||||
expect(imagePrefetched('/covers/36_sm.jpg')).toBe(false);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('leaves the rendered rows alone — they have their own <img>', () => {
|
|
||||||
prefetchImageWindow(CARDS, 40, 50, urlOf, 3);
|
|
||||||
|
|
||||||
expect(imagePrefetched('/covers/45_sm.jpg')).toBe(false);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('asks for nothing twice, so a scroll back over the same rows is free', () => {
|
|
||||||
prefetchImageWindow(CARDS, 40, 50, urlOf, 3);
|
|
||||||
|
|
||||||
expect(prefetchImageWindow(CARDS, 40, 50, urlOf, 3)).toBe(0);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('clamps at both ends of the list', () => {
|
|
||||||
// At the top of a five-item list nothing precedes the range, and
|
|
||||||
// the tail runs out after two.
|
|
||||||
expect(prefetchImageWindow(CARDS.slice(0, 5), 0, 2, urlOf, 10)).toBe(2);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('asks for nothing when the virtualizer reports an empty range', () => {
|
|
||||||
// `visibilityChanged` reports -1/-1 before anything is laid out.
|
|
||||||
expect(prefetchImageWindow(CARDS, -1, -1, urlOf)).toBe(0);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('skips a card that draws a placeholder rather than an image', () => {
|
|
||||||
expect(prefetchImageWindow(CARDS, 40, 50, () => '', 3)).toBe(0);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('really issues the request, rather than only recording it', async () => {
|
|
||||||
// A served file, so the load succeeds and the resource timing entry
|
|
||||||
// is unambiguous; the query string keeps it distinct per run.
|
|
||||||
const url = `/test/support/pixel.svg?prefetch=${Date.now()}`;
|
|
||||||
const href = new URL(url, location.href).href;
|
|
||||||
|
|
||||||
expect(prefetchImage(url)).toBe(true);
|
|
||||||
|
|
||||||
for (let i = 0; i < 100; i++) {
|
|
||||||
if (performance.getEntriesByName(href).length > 0) break;
|
|
||||||
|
|
||||||
await new Promise((r) => setTimeout(r, 20));
|
|
||||||
}
|
|
||||||
|
|
||||||
expect(performance.getEntriesByName(href)).toHaveLength(1);
|
|
||||||
expect(prefetchImage(url)).toBe(false);
|
|
||||||
expect(performance.getEntriesByName(href)).toHaveLength(1);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('reports what it is holding, with its cap, to the cache stats', () => {
|
|
||||||
prefetchImageWindow(CARDS, 40, 50, urlOf, 3);
|
|
||||||
|
|
||||||
const stat = window.__yjCacheStats?.()['imagePrefetch'];
|
|
||||||
|
|
||||||
expect(stat).toBeTruthy();
|
|
||||||
expect(stat!.entries).toBe(6);
|
|
||||||
expect(stat!.limit).toBe(PREFETCH_MEMORY);
|
|
||||||
// It holds URLs, not images — the bytes are the browser's cache.
|
|
||||||
expect(stat!.chars).toBe(6 * '/covers/51_sm.jpg'.length);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('keeps its record bounded, so a 50 000-album scroll cannot grow it', () => {
|
|
||||||
const many = Array.from(
|
|
||||||
{ length: PREFETCH_MEMORY * 2 },
|
|
||||||
(_, i) => ({ url: `/covers/bulk-${i}_sm.jpg` }),
|
|
||||||
);
|
|
||||||
|
|
||||||
prefetchImageWindow(many, 0, 0, urlOf, many.length);
|
|
||||||
|
|
||||||
expect(window.__yjCacheStats?.()['imagePrefetch']?.entries).toBe(PREFETCH_MEMORY);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -30,6 +30,12 @@ func TestFixturesMatchManifest(t *testing.T) {
|
|||||||
m := testfixtures.Load(t)
|
m := testfixtures.Load(t)
|
||||||
|
|
||||||
for _, want := range m.Tracks {
|
for _, want := range m.Tracks {
|
||||||
|
// WAV tags are write-only today; see
|
||||||
|
// TestWAVTagsAreNotReadableYet.
|
||||||
|
if want.Format == "wav" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
t.Run(want.Path, func(t *testing.T) {
|
t.Run(want.Path, func(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
@@ -155,6 +161,39 @@ func TestDuplicateFixturesAreIndistinguishable(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TestWAVTagsAreNotReadableYet pins a known gap rather than hiding it.
|
||||||
|
//
|
||||||
|
// backend/tagwriter writes WAV tags into a RIFF "id3 " chunk, but
|
||||||
|
// backend/metadata reads through dhowden/tag, which recognises MP3,
|
||||||
|
// FLAC, OGG, MP4 and DSF and has no RIFF parser at all. So every tag
|
||||||
|
// the app writes to a WAV is invisible to the app that wrote it, and
|
||||||
|
// WAV tracks always scan in as untitled.
|
||||||
|
//
|
||||||
|
// The fixtures are tagged correctly on disk, so when the reader learns
|
||||||
|
// to unwrap the RIFF chunk this test starts failing — which is the
|
||||||
|
// point. Delete it then and drop the "wav" skip in
|
||||||
|
// TestFixturesMatchManifest.
|
||||||
|
func TestWAVTagsAreNotReadableYet(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
m := testfixtures.Load(t)
|
||||||
|
|
||||||
|
for _, path := range m.Case(t, testfixtures.CaseWAVTracks) {
|
||||||
|
got, err := metadata.ExtractTags(path)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("extract tags from %s: %v", path, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if got.Title != "" {
|
||||||
|
t.Errorf(
|
||||||
|
"%s: WAV tags are now readable (%q) — good news; "+
|
||||||
|
"see this test's comment for what to update",
|
||||||
|
filepath.Base(path), got.Title,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func assertTag(t *testing.T, field string, want testfixtures.Track, got string) {
|
func assertTag(t *testing.T, field string, want testfixtures.Track, got string) {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user