Compare commits
11
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f76ee96ac4 | ||
|
|
23f5a0c53a | ||
|
|
502b814a65 | ||
|
|
c19a806298 | ||
|
|
67eeb75e7b | ||
|
|
fe1fbefee7 | ||
|
|
de04339494 | ||
|
|
998ce75fb6 | ||
|
|
4b392cb4c4 | ||
|
|
8d2109b87e | ||
|
|
b741b01cdf |
@@ -258,20 +258,25 @@ one.
|
||||
`build/android/Taskfile.yml` ships more than the Makefile wraps, and
|
||||
they are the right thing to reach for when you want something one-off:
|
||||
|
||||
> **Do not run `android:run:device` or `android:deploy-device`
|
||||
> against a device that has the released app on it (#159).** Both begin
|
||||
> with `adb uninstall {{.APP_ID}}`, and `APP_ID` defaults to
|
||||
> `app.yellowjacket` — the **release** id — while `run:device` builds
|
||||
> the **debug** variant, whose id is `app.yellowjacket.dev`. So it
|
||||
> uninstalls the user's app, taking the library with it, installs a
|
||||
> different package, and then fails to launch the one it removed. This
|
||||
> is "the identity is declared twice" (below) cashing out. The safe
|
||||
> sequence is at the end of this section.
|
||||
> **These four were unsafe until #159 and are now the way in.** All of
|
||||
> them began with `adb uninstall {{.APP_ID}}`, where `APP_ID` defaulted
|
||||
> to `app.yellowjacket` — the **release** id — while `run` and
|
||||
> `run:device` build the **debug** variant, whose id is
|
||||
> `app.yellowjacket.dev`. So they uninstalled the user's app, taking
|
||||
> the library with it, installed a different package, and then failed
|
||||
> to launch the one they had removed.
|
||||
>
|
||||
> They share `scripts/android-deploy.sh` now, which **never**
|
||||
> uninstalls (`install -r`, and a changed signing certificate is
|
||||
> reported with the command rather than acted on), reads the package id
|
||||
> back out of the built APK, and refuses a target that is not the kind
|
||||
> the task names. There is nothing left to avoid; the manual sequence
|
||||
> below is kept because it is still the smallest thing that works.
|
||||
|
||||
```
|
||||
wails3 task android:run # debug build + emulator install + launch
|
||||
wails3 task android:run:device # UNSAFE, see #159
|
||||
wails3 task android:deploy-device # UNSAFE, see #159
|
||||
wails3 task android:run:device # debug build + install + launch on a phone
|
||||
wails3 task android:deploy-device # release build, same
|
||||
wails3 task android:bundle:fat # AAB, for a Play Store upload
|
||||
wails3 task android:studio # open build/android/ in Android Studio
|
||||
wails3 task android:device:list
|
||||
@@ -279,6 +284,16 @@ wails3 task android:logs:all
|
||||
wails3 task android:clean
|
||||
```
|
||||
|
||||
**`run` and `deploy-emulator` mean the emulator, and now say so to
|
||||
adb.** They used a bare `adb install`, which with exactly one device
|
||||
attached picks that device whatever it is — so with a phone plugged in
|
||||
and no emulator running, the task whose summary reads "in the Android
|
||||
Emulator" installed on the phone. They pass `--target emulator` and
|
||||
refuse with `make android-emulator` as the remedy.
|
||||
|
||||
**`DEVICE_ID=<serial>` still names a device, and several attached
|
||||
devices is now an error rather than a silent pick of the first.**
|
||||
|
||||
Two are deliberately **not** wrapped. `android:logs` greps logcat for
|
||||
`(Wails|yellowjacket)`, which catches the `WailsBridge` tag but misses
|
||||
the app's own process tag (`app.yellowjacket` — lowercase, so `Wails`
|
||||
@@ -288,16 +303,51 @@ instead. And `ensure-emulator` boots whatever `-list-avds | tail -1`
|
||||
returns, with no pidfile and no boot wait, so it cannot be stopped or
|
||||
sequenced.
|
||||
|
||||
## The identity is declared twice
|
||||
## The identity is read back from the APK
|
||||
|
||||
It used to be **declared twice**, and that is what #159 was.
|
||||
`applicationId` in `build/android/app/build.gradle` is what Gradle
|
||||
installs. `APP_ID` in `build/android/Taskfile.yml` is what every
|
||||
adb-driven task uninstalls, launches and filters. **Nothing enforces
|
||||
that they agree**, and `ANDROID.md`'s advice to set `APP_ID` in
|
||||
`build/config.yml` does not work in beta.8 — `wails3 task` never reads
|
||||
that file (verified with `--dry`), and even when set it feeds only the
|
||||
adb commands, never Gradle. Change both or the official `run`/`deploy`
|
||||
tasks address a package that is not installed.
|
||||
installs; `APP_ID` in `build/android/Taskfile.yml` was what every
|
||||
adb-driven task uninstalled, launched and filtered, and nothing
|
||||
enforced that they agree. They did not: the debug buildType carries
|
||||
`applicationIdSuffix ".dev"`, so every task that assembles a debug APK
|
||||
addressed the release id. This file flagged the hazard for five phases
|
||||
and it cashed out twice — once as a wrong `am start`, once as an
|
||||
uninstall of the user's library.
|
||||
|
||||
**`scripts/android-pkgid.sh` is the one answer now.** It prints the
|
||||
package id an APK declares (`aapt2 dump packagename`, falling back to
|
||||
`aapt dump badging`), and the deploy path installs and launches *that*.
|
||||
The APK is the authority because the task that installs it has just
|
||||
built it: whatever Gradle resolved the applicationId to, suffixes and
|
||||
flavours included, is in the file, and no default can disagree with it.
|
||||
An APK it cannot read is a hard failure, never a fallback to a written
|
||||
down default — guessing is the bug.
|
||||
|
||||
**`APP_ID` survives as an assertion, not a setting**, and has no
|
||||
default. `wails3 task android:run APP_ID=app.yellowjacket` says "this
|
||||
build had better declare that id" and is refused, naming both, *before*
|
||||
anything is installed or a device is even chosen. It could never have
|
||||
been a setting: `ANDROID.md`'s advice to put it in `build/config.yml`
|
||||
does not work in beta.8 — `wails3 task` never reads that file (verified
|
||||
with `--dry`) — and even when set it fed only the adb commands, never
|
||||
Gradle.
|
||||
|
||||
`scripts/android-emulator.sh` derives `PKG` the same way, from
|
||||
`bin/yellowjacket.apk` when one is built, so `make android-install`,
|
||||
`android-launch`, `android-logs` and `android-smoke` follow whichever
|
||||
variant is actually in `bin/`. `YJ_ANDROID_PKG` still overrides, and
|
||||
the old literal survives only for a tree with no APK built yet.
|
||||
|
||||
**The uninstall is gone and is not coming back.** It existed to make
|
||||
the bare `install` on the next line work at all — without `-r` Android
|
||||
refuses an install over an existing package — so `install -r` removes
|
||||
the *reason* for it rather than merely removing it. What is left is the
|
||||
one case an uninstall really is the remedy, a changed signing
|
||||
certificate, and that is exactly the case where performing it silently
|
||||
costs the user their library. So it is named and not done, which is the
|
||||
answer `scripts/android-emulator.sh` had already reached for
|
||||
`make android-install`.
|
||||
|
||||
Related, and it will bite once: the launcher activity is
|
||||
`com.wails.app.MainActivity` and the applicationId is
|
||||
@@ -306,8 +356,10 @@ resolves the leading dot against the *applicationId* and fails with a
|
||||
class-not-found that reads like a broken build. Always the
|
||||
fully-qualified form.
|
||||
|
||||
**The safe way to put a debug build on a real device**, which is what
|
||||
#52 used and what #159 exists to make unnecessary:
|
||||
**`wails3 task android:run:device` is the way to put a debug build on a
|
||||
real device**, since #159. What #52 used, before it was safe, was the
|
||||
longer form, and it is still the smallest thing that works if you want
|
||||
no script between you and adb:
|
||||
|
||||
```bash
|
||||
wails3 task android:build ARCH=arm64 && wails3 task android:assemble:apk
|
||||
@@ -315,9 +367,15 @@ adb install -r bin/yellowjacket.apk # -r, never uninstall
|
||||
adb shell am start -n app.yellowjacket.dev/com.wails.app.MainActivity
|
||||
```
|
||||
|
||||
`YJ_ANDROID_PKG=app.yellowjacket.dev` points `scripts/android-emulator.sh`
|
||||
— and therefore `make android-smoke`, `android-logs`, `android-launch`
|
||||
— at the debug id, which is otherwise `app.yellowjacket`.
|
||||
The id in that last line is the one thing to keep an eye on by hand —
|
||||
`./scripts/android-pkgid.sh bin/yellowjacket.apk` is what the tasks ask,
|
||||
and it is a good habit before any `am start` written out in full.
|
||||
|
||||
`YJ_ANDROID_PKG=app.yellowjacket.dev` still overrides what
|
||||
`scripts/android-emulator.sh` — and therefore `make android-smoke`,
|
||||
`android-logs`, `android-launch` — addresses, but it is rarely needed
|
||||
now: that default is read from `bin/yellowjacket.apk`, so it already
|
||||
follows whichever variant was built last.
|
||||
|
||||
## What only a device can answer
|
||||
|
||||
@@ -457,6 +515,75 @@ Four things about it, each of which costs an hour if met cold:
|
||||
script. Plug in over USB for anything longer than a couple of probes.
|
||||
- **The socket name carries the pid**, which changes on every launch, so
|
||||
it is resolved rather than remembered.
|
||||
- **A reinstall resets the runtime permissions**, and the grant dialog
|
||||
is a separate activity that takes focus — so the app is up, `am start`
|
||||
reports "delivered to currently running top-most instance", and
|
||||
`pidof` is empty because it never got to the foreground.
|
||||
`dumpsys window | grep mCurrentFocus` naming
|
||||
`GrantPermissionsActivity` is the tell. `adb shell pm grant
|
||||
app.yellowjacket.dev android.permission.READ_MEDIA_AUDIO` (and
|
||||
`POST_NOTIFICATIONS`) ahead of the launch skips it.
|
||||
|
||||
### Calling a binding on the device
|
||||
|
||||
**The runtime call does not go over HTTP on Android**, and this is worth
|
||||
knowing before an hour is spent on it. The WebView cannot deliver a
|
||||
`fetch()` POST body to `shouldInterceptRequest`, so v3 routes runtime
|
||||
calls through the `addJavascriptInterface` bridge instead: the
|
||||
@wailsio/runtime installs a `customTransport` that calls
|
||||
`window.wails.invokeAsync(id, payload)` and receives the answer on
|
||||
`window._wailsAndroidCallback`. Two consequences:
|
||||
|
||||
- **`.playwright/init-events.js` does not transfer to the device.** Its
|
||||
outbound half hooks `fetch`, which sees nothing here, and its
|
||||
`call()` posts to `/wails/runtime`, which answers
|
||||
`Invalid runtime call: missing object value` — the interceptor got the
|
||||
URL with no body. Its *inbound* half is still right, because
|
||||
`dispatchWailsEvent` is the entry point in every mode.
|
||||
- **Hooking `fetch` from an eval is too late anyway**, on any platform:
|
||||
the bundle captured its reference at module scope, so a wrapper
|
||||
installed afterwards records nothing. That is why the harness is an
|
||||
`initScript` and not a step in a spec.
|
||||
|
||||
What works is to borrow the bridge, chaining the runtime's own callback
|
||||
so its pending calls still resolve:
|
||||
|
||||
```js
|
||||
const pending = new Map();
|
||||
const prev = window._wailsAndroidCallback;
|
||||
window._wailsAndroidCallback = (id, response, error) => {
|
||||
if (!pending.has(id)) return prev && prev(id, response, error);
|
||||
const p = pending.get(id); pending.delete(id);
|
||||
const env = JSON.parse(response || "{}");
|
||||
return env.ok ? p.resolve(env.data ?? env.text) : p.reject(new Error(env.error));
|
||||
};
|
||||
window.__yj = { call(name, args) {
|
||||
return new Promise((resolve, reject) => {
|
||||
const id = "yj" + Math.random().toString(36).slice(2);
|
||||
pending.set(id, { resolve, reject });
|
||||
window.wails.invokeAsync(id, JSON.stringify({
|
||||
object: 0, method: 0, windowName: "",
|
||||
args: { "call-id": id, methodName: "yellowjacket/backend/" + name, args: args || [] },
|
||||
clientId: window._wails.clientId,
|
||||
}));
|
||||
});
|
||||
} };
|
||||
```
|
||||
|
||||
That turns the device into a tier that can be *driven* rather than only
|
||||
looked at — `__yj.call("player.Player.LoadFile", [path])` and
|
||||
`__yj.call("library.Library.AddLibrary", ["/sdcard/Music/..."])` are how
|
||||
#53 was measured. Names are the Go ones (`GetTracks`, not
|
||||
`GetAllTracks`); an unknown one comes back as a plain
|
||||
`unknown bound method name`, so a wrong guess is loud.
|
||||
|
||||
**Getting audio onto the phone**: `adb push` into
|
||||
`/sdcard/Android/data/<pkg>/files/` looks like it works and then the
|
||||
files are not there — scoped storage. `/sdcard/Music/...` plus
|
||||
`pm grant … READ_MEDIA_AUDIO` does work, and `AddLibrary` takes the
|
||||
plain path. The generated fixtures are **~2 seconds** each, which is
|
||||
fine for a scan and useless for watching a seek bar, so synthesise a
|
||||
long one: `ffmpeg -f lavfi -i sine=frequency=440:duration=240`.
|
||||
|
||||
**And the reason to bother: the phone is an engine, not a screen.** The
|
||||
first device here renders in **Chrome 113** at 424x439 CSS px. Every
|
||||
|
||||
@@ -4155,3 +4155,198 @@ This is the hazard that file already names — "The identity is declared
|
||||
twice ... **Nothing enforces that they agree**" — reached by a second
|
||||
route: the two ids differ not because someone edited one, but because
|
||||
the debug buildType suffixes it.
|
||||
|
||||
## The uninstall was there to make a bare `install` work (measured 2026-08-20)
|
||||
|
||||
Fixing #159 turned up *why* the `adb uninstall` was in all four tasks,
|
||||
which the issue does not say and which decides whether it can simply be
|
||||
deleted. The line under it was `adb install`, with **no `-r`** — and
|
||||
Android refuses an install over an existing package without it. So the
|
||||
uninstall was not a deliberate clean-slate step; it was the price of
|
||||
the missing flag, paid on every run, and `install -r` removes the
|
||||
reason for it rather than merely removing it.
|
||||
|
||||
That matters because "should the uninstall go at all" looked like a
|
||||
trade — drop it and a signing-certificate change fails with
|
||||
`INSTALL_FAILED_UPDATE_INCOMPATIBLE` instead of being handled. It is
|
||||
not a trade: nothing else was relying on it. The certificate case is
|
||||
reported with the command to run, which is what
|
||||
`scripts/android-emulator.sh` already did for `make android-install`,
|
||||
so this is one existing judgement applied consistently rather than a
|
||||
new one.
|
||||
|
||||
## `wails3 task android:run` installs on a phone (measured 2026-08-20)
|
||||
|
||||
The emulator tasks (`run`, `deploy-emulator`) used a bare `adb install`
|
||||
with no `-s`. adb with exactly one device attached uses that device
|
||||
whatever kind it is, so with a phone plugged in and no emulator
|
||||
running, the task whose summary reads "in the Android Emulator"
|
||||
installed on the phone — and, before #159 was fixed, ran
|
||||
`adb uninstall app.yellowjacket` against it first. The reported data
|
||||
loss was reachable from the *emulator* task, which is not what the
|
||||
issue describes and is worse, because nothing in the name warns you.
|
||||
|
||||
Measured after the fix, phone attached and emulator stopped:
|
||||
|
||||
```
|
||||
$ ./scripts/android-deploy.sh --apk bin/yellowjacket.apk --target emulator
|
||||
android-deploy: no emulator target is online.
|
||||
LP3LHMA531900746 device
|
||||
Start one with: make android-emulator
|
||||
```
|
||||
|
||||
The general form: **a task that names a target has to say so to adb.**
|
||||
The device tasks always filtered on `$1 !~ /^emulator-/`; the emulator
|
||||
tasks filtered on nothing at all.
|
||||
|
||||
## The package id can be read back, and costs nothing (2026-08-20)
|
||||
|
||||
`aapt2 dump packagename <apk>` answers in one word and ~40 ms, from
|
||||
`$ANDROID_HOME/build-tools/*/aapt2` (versioned, so resolved not
|
||||
pinned); `aapt dump badging` is the fallback for older build-tools and
|
||||
is what #159's own measurement used. That is cheap enough to do on
|
||||
every deploy, which is what makes "the two ids agree by construction"
|
||||
affordable rather than aspirational — the alternative considered was
|
||||
giving the debug-flavoured tasks `APP_ID` + `.dev`, which is one line
|
||||
and leaves the class of bug alive for the next flavour or suffix.
|
||||
|
||||
The guard runs **before** a target is chosen, deliberately: it is a
|
||||
question about the artifact, so it can be exercised with nothing
|
||||
plugged in, and a build whose id is wrong should be refused whether or
|
||||
not there is anything to install it onto. That is what let the negative
|
||||
test run safely with the user's phone attached:
|
||||
|
||||
```
|
||||
$ ./scripts/android-deploy.sh --apk bin/yellowjacket.apk \
|
||||
--target device --expect app.yellowjacket
|
||||
android-pkgid: refusing to act on a package this APK does not declare.
|
||||
the APK declares: app.yellowjacket.dev
|
||||
the task expects: app.yellowjacket
|
||||
rc=2
|
||||
```
|
||||
|
||||
That is exactly #159's configuration — debug APK, release id, real
|
||||
device — refused with no adb call made.
|
||||
|
||||
## `make android-emulator`'s boot wait can be satisfied by a phone (2026-08-20)
|
||||
|
||||
Noticed while booting the emulator for #159's verification, with a
|
||||
phone also attached. `scripts/android-emulator.sh start` reported
|
||||
`waiting for boot ok / android 14` about **eight seconds** after
|
||||
launching the emulator, which had not appeared in `adb devices` yet —
|
||||
`pick_device`'s last resort is "exactly one device online", and at that
|
||||
moment the one online device was the phone. So it waited for the
|
||||
phone's boot, found it long since booted, and returned. The emulator
|
||||
took another ~10 s to come up.
|
||||
|
||||
Harmless here (the emulator was up before anything used it) and a
|
||||
straightforward race otherwise: `start` should wait for a device that
|
||||
is an emulator, not for whatever `pick_device` returns. Filed as #162.
|
||||
|
||||
## The Android runtime transport is not HTTP (measured 2026-08-20)
|
||||
|
||||
Found while trying to drive the phone for #53. `wails3` routes runtime
|
||||
calls through `addJavascriptInterface` on Android, not through
|
||||
`/wails/runtime` — the WebView cannot deliver a `fetch()` POST body to
|
||||
`shouldInterceptRequest`, which the v3 source says in as many words
|
||||
(`application_android.go`, "The Android transport"). The runtime
|
||||
installs a `customTransport` over `window.wails.invokeAsync(id,
|
||||
payload)` and takes the answer on `window._wailsAndroidCallback`.
|
||||
|
||||
Two things follow, and both cost time before the source was read:
|
||||
|
||||
- **`.playwright/init-events.js` does not transfer to the device.** Its
|
||||
outbound half hooks `fetch`; a POST to `/wails/runtime` answers
|
||||
`Invalid runtime call: missing object value`, which reads like a
|
||||
wrong payload shape and is actually the interceptor receiving a URL
|
||||
with no body at all. The payload shape was right the whole time. Its
|
||||
*inbound* half is still correct, because `dispatchWailsEvent` is the
|
||||
entry point in every mode.
|
||||
- **Hooking `fetch` from an `eval` is too late on any platform.** The
|
||||
bundle captured its reference at module scope, so a wrapper installed
|
||||
afterwards records nothing — which is exactly why the harness is an
|
||||
`initScript`. Measured: zero calls captured while the app was
|
||||
demonstrably making them.
|
||||
|
||||
The working recipe is in `android-tier.md`; it chains the runtime's own
|
||||
callback rather than replacing it, so its pending calls still resolve.
|
||||
This is what makes the device a tier that can be *driven*.
|
||||
|
||||
## #53's frontend is byte-identical to the build it was reported against (2026-08-20)
|
||||
|
||||
`git diff v0.3.1 HEAD -- frontend/src/components/audio-player/seekbar/
|
||||
frontend/src/store/player-store.ts` is **empty**; the whole diff in that
|
||||
area is `backend/player/`. The phone carries the released `v0.3.1`, so
|
||||
whatever #53 saw, the component was not what changed — and v0.4.0 is
|
||||
where the player audit (#122–#127) landed.
|
||||
|
||||
Measured on that phone, current `main`, with a synthesised 4-minute
|
||||
track: the Now Playing seek bar tracks correctly when mounted
|
||||
mid-playback (`seekValue` 28 of 240), when the view is opened before
|
||||
playback starts, after a tap on the track, and across an activity
|
||||
recreation (same pid, bar resumes at 30 → 35). The issue's stated
|
||||
symptom did not reproduce in any of them.
|
||||
|
||||
Reverting **only** `backend/player/` to v0.3.1 — the frontend and
|
||||
everything else at HEAD — does reproduce a real position defect on the
|
||||
same device: six seconds into a 20-second file with no database row,
|
||||
played after a 240-second one, the bar read **01:27 of 240**. That is
|
||||
#125's stale `trackLengthMs` ("cleared only by UnloadTrack, so a file
|
||||
with no row inherited the previous track's duration"), and it is fixed
|
||||
at HEAD. Note the *shape* of it: the fraction is roughly right and the
|
||||
absolute numbers are wrong, so it presents as a clock that lies rather
|
||||
than as a handle that will not move.
|
||||
|
||||
The one-line experiment is worth remembering: v0.3.1's `backend/player`
|
||||
compiles against HEAD with a single shim
|
||||
(`SetPlaybackFinishedHandler` gained a `srcErr error` parameter), which
|
||||
makes "did the backend fix cause this" a ten-minute question instead of
|
||||
a full checkout.
|
||||
|
||||
## An overlay band is not a notification, it is a lid (measured 2026-08-20)
|
||||
|
||||
#62 asks for background jobs to become "a notification" on the phone,
|
||||
and the app has exactly one notification surface, so the first version
|
||||
of the fix put `<job-panel>` in `notification-host`'s band — which is
|
||||
`position: fixed` under the header. It renders correctly, it is on top,
|
||||
it is inside the viewport, and it is unusable.
|
||||
|
||||
At the device's 424x439 viewport a **compact** panel showing two active
|
||||
jobs is ~216px — half the screen — drawn over the content, with
|
||||
`pointer-events: auto` so it swallows every tap underneath. Nothing in
|
||||
the component tier could see it. The e2e suite could: four specs failed,
|
||||
and *none* of them was about jobs — two `phone-shell` journeys into the
|
||||
full-screen Now Playing and `header-action-overflow`'s phone case, all
|
||||
three because the band was intercepting taps meant for the app.
|
||||
|
||||
`<job-band>` is in the shell's grid instead, as a row between the top
|
||||
bar and the main panel, so it **pushes**. That is #24's one sentence
|
||||
("no action is ever unreachable at any supported size") deciding a
|
||||
layout question: a band that hides the app in order to say the app is
|
||||
busy has traded the popover's fault for a worse one.
|
||||
|
||||
Two things fell out of it worth keeping:
|
||||
|
||||
- **A finished row in flow is furniture.** The overlay could afford to
|
||||
keep terminal jobs around; a row that holds the content down after
|
||||
the work is done cannot. `job-panel` grew `active-only` for the band,
|
||||
and Settings keeps finished rows because that is where "did the last
|
||||
scan work" is asked.
|
||||
- **`job-row` already had the right density.** `variant="compact"` is
|
||||
described in its own source as "the popover density", which is
|
||||
exactly what the band is replacing — 216px against 259px for the
|
||||
same two jobs, and no per-job statistics that a phone has no room
|
||||
for.
|
||||
|
||||
## The e2e suite is the tier that sees a shell regression (2026-08-20)
|
||||
|
||||
Worth stating because it decided how #62 was verified. The change is
|
||||
one component, one stylesheet and one line of `index.html`; `make
|
||||
ui-test` (955 tests) passed on the broken overlay version and so did
|
||||
`tsc`, `lint` and the whole Go suite. The failure was three specs that
|
||||
have nothing to do with jobs, failing on `click()` timeouts.
|
||||
|
||||
The corollary for anything that draws over the shell: **run the whole
|
||||
e2e suite, not the spec you wrote.** A spec written for a feature
|
||||
asserts the feature works; what a new overlay breaks is everything
|
||||
else, and only the suite is looking at that.
|
||||
|
||||
@@ -593,11 +593,38 @@ rather than renaming them.
|
||||
`ClearFinishedJobs` is global — a Clear under Libraries would discard
|
||||
the index build's history too; a finished row dismisses itself.
|
||||
|
||||
The header `job-indicator` is untouched and is still the one view of
|
||||
everything at once, from every page. One consequence worth knowing
|
||||
before writing a spec: a section holding a `job-panel` also holds a
|
||||
`job-details-drawer`, whose own header carries `.header` — so
|
||||
The header `job-indicator` is still the one view of everything at
|
||||
once, from every page — **on a desktop.** One consequence worth
|
||||
knowing before writing a spec: a section holding a `job-panel` also
|
||||
holds a `job-details-drawer`, whose own header carries `.header` — so
|
||||
`config-section .header` is ambiguous the moment a job exists.
|
||||
|
||||
**Below 600px that indicator stands down and `<job-band>` takes
|
||||
over** (#62), because a popover is a *disclosure* and background work
|
||||
is the one thing a phone should not make you open something to see —
|
||||
and because #57 deletes the bar it is anchored to and is blocked on
|
||||
it having somewhere else to live. The band is the same `job-panel`,
|
||||
so `applyJobControl` and its index-build confirmation come along
|
||||
rather than being reimplemented; `kinds="*"` is how it says "every
|
||||
kind", which is what the indicator was for.
|
||||
|
||||
Three things about it are load-bearing. **It is in the layout, not
|
||||
over it**, as its own grid row above the main panel: the first
|
||||
version put it in `notification-host`'s fixed band, which reads fine
|
||||
in a screenshot and is unusable — at 424×439 a compact panel is
|
||||
~200px of a 439px screen and it *covers* what is under it, which four
|
||||
e2e specs caught by failing on taps it was intercepting. **It shows
|
||||
active work only** (`active-only`), because in flow a finished row is
|
||||
furniture that keeps the content pushed down after the work is done;
|
||||
finished rows stay where the work was started, which is #27's rule.
|
||||
And **it renders nothing above 600px**, from `matchMedia` rather than
|
||||
a media query, because that decides whether the element *exists* —
|
||||
Settings already holds four `job-panel`s and a fifth answering for
|
||||
every kind is `bottom-nav`'s "resolved to 2 elements" trap again.
|
||||
`index.css` keeps it `display: none` outside the phone for a second
|
||||
reason: an in-flow grid child with no named area is auto-placed into
|
||||
one of the shell's rows, which is what the skip link is absolutely
|
||||
positioned to avoid.
|
||||
- `config` — TOML-based settings. Settings page uses HTMX + templ for server-rendered HTML fragments.
|
||||
- `playlist` / `smartplaylist` — Playlist CRUD and rule-based smart playlists.
|
||||
- `mediacontrols` — OS media controls behind one `Handler`: MPRIS over
|
||||
|
||||
+25
-55
@@ -4,18 +4,28 @@ includes:
|
||||
common: ../Taskfile.yml
|
||||
|
||||
vars:
|
||||
# The *installed* package name, which every adb-driven task below uses
|
||||
# to uninstall, launch and filter. It must agree with `applicationId`
|
||||
# in app/build.gradle, and nothing enforces that.
|
||||
# APP_ID is an *assertion*, not a setting, and it has no default.
|
||||
#
|
||||
# ANDROID.md says to set this in build/config.yml. That does not work
|
||||
# in beta.8, checked both ways: `wails3 task` builds its var set from
|
||||
# CLI KEY=VALUE arguments and the Taskfile tree only -- nothing reads
|
||||
# config.yml -- and even when set it feeds only these adb commands,
|
||||
# never Gradle. So the identity is declared twice, here and in
|
||||
# build.gradle, and a change to one alone means the official run and
|
||||
# deploy tasks address a package that is not installed.
|
||||
APP_ID: '{{.APP_ID | default "app.yellowjacket"}}'
|
||||
# It used to be the id every adb-driven task below uninstalled,
|
||||
# launched and filtered, defaulting to "app.yellowjacket". It could
|
||||
# never have been a setting: `wails3 task` builds its var set from CLI
|
||||
# KEY=VALUE arguments and the Taskfile tree only -- nothing reads
|
||||
# build/config.yml, contrary to ANDROID.md, checked with --dry -- and
|
||||
# even when set it fed only the adb commands, never Gradle. So the
|
||||
# identity was declared twice, here and as `applicationId` in
|
||||
# app/build.gradle, with nothing enforcing that they agree.
|
||||
#
|
||||
# They did not agree. The debug buildType carries
|
||||
# `applicationIdSuffix ".dev"`, so the tasks that assemble a debug APK
|
||||
# addressed the *release* id -- on a device, the user's installed app
|
||||
# and their library (#159).
|
||||
#
|
||||
# The id is now read back from the built APK by scripts/android-
|
||||
# pkgid.sh, so the thing installed and the thing launched agree by
|
||||
# construction. Passing APP_ID= says "this build had better declare
|
||||
# that id", and the deploy refuses before touching anything if it does
|
||||
# not -- which is the check that would have caught #159 statically.
|
||||
APP_ID: '{{.APP_ID | default ""}}'
|
||||
MIN_SDK: '21'
|
||||
TARGET_SDK: '35'
|
||||
# The emulator runs the host architecture; physical devices are arm64
|
||||
@@ -372,9 +382,7 @@ tasks:
|
||||
ARCH: '{{.ARCH | default .HOST_ARCH}}'
|
||||
cmds:
|
||||
- task: ensure-emulator
|
||||
- '"{{.ADB}}" uninstall {{.APP_ID}} 2>/dev/null || true'
|
||||
- '"{{.ADB}}" install "{{.BIN_DIR}}/{{.APP_NAME}}.apk"'
|
||||
- '"{{.ADB}}" shell am start -n {{.APP_ID}}/com.wails.app.MainActivity'
|
||||
- './scripts/android-deploy.sh --apk "{{.BIN_DIR}}/{{.APP_NAME}}.apk" --target emulator{{if .APP_ID}} --expect "{{.APP_ID}}"{{end}}'
|
||||
|
||||
run:
|
||||
summary: Build, install and launch a debug build in the Android Emulator
|
||||
@@ -383,9 +391,7 @@ tasks:
|
||||
- task: build
|
||||
cmds:
|
||||
- task: assemble:apk
|
||||
- '"{{.ADB}}" uninstall {{.APP_ID}} 2>/dev/null || true'
|
||||
- '"{{.ADB}}" install "{{.BIN_DIR}}/{{.APP_NAME}}.apk"'
|
||||
- '"{{.ADB}}" shell am start -n {{.APP_ID}}/com.wails.app.MainActivity'
|
||||
- './scripts/android-deploy.sh --apk "{{.BIN_DIR}}/{{.APP_NAME}}.apk" --target emulator{{if .APP_ID}} --expect "{{.APP_ID}}"{{end}}'
|
||||
|
||||
device:list:
|
||||
summary: Lists connected Android devices and emulators (serials)
|
||||
@@ -400,25 +406,7 @@ tasks:
|
||||
ARCH: arm64
|
||||
cmds:
|
||||
- task: assemble:apk
|
||||
- |
|
||||
DEVICE='{{.DEVICE_ID | default ""}}'
|
||||
if [ -z "$DEVICE" ]; then
|
||||
DEVICE="${DEVICE_ID:-}"
|
||||
fi
|
||||
if [ -z "$DEVICE" ]; then
|
||||
DEVICE=$("{{.ADB}}" devices | awk 'NR > 1 && $2 == "device" && $1 !~ /^emulator-/ { print $1; exit }')
|
||||
fi
|
||||
if [ -z "$DEVICE" ]; then
|
||||
echo "Error: no connected physical Android device found."
|
||||
echo "Pass DEVICE_ID=<serial> to target a device explicitly."
|
||||
echo "Find connected device serials with: {{.ADB}} devices"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "Deploying {{.BIN_DIR}}/{{.APP_NAME}}.apk to device $DEVICE..."
|
||||
"{{.ADB}}" -s "$DEVICE" uninstall {{.APP_ID}} 2>/dev/null || true
|
||||
"{{.ADB}}" -s "$DEVICE" install "{{.BIN_DIR}}/{{.APP_NAME}}.apk"
|
||||
"{{.ADB}}" -s "$DEVICE" shell am start -n {{.APP_ID}}/com.wails.app.MainActivity
|
||||
- './scripts/android-deploy.sh --apk "{{.BIN_DIR}}/{{.APP_NAME}}.apk" --target device{{if .DEVICE_ID}} --serial "{{.DEVICE_ID}}"{{end}}{{if .APP_ID}} --expect "{{.APP_ID}}"{{end}}'
|
||||
preconditions:
|
||||
- sh: '[ -x "{{.ADB}}" ] || command -v adb'
|
||||
msg: "adb not found. Install the Android SDK platform-tools (or set ANDROID_HOME)"
|
||||
@@ -430,25 +418,7 @@ tasks:
|
||||
vars:
|
||||
ARCH: arm64
|
||||
cmds:
|
||||
- |
|
||||
DEVICE='{{.DEVICE_ID | default ""}}'
|
||||
if [ -z "$DEVICE" ]; then
|
||||
DEVICE="${DEVICE_ID:-}"
|
||||
fi
|
||||
if [ -z "$DEVICE" ]; then
|
||||
DEVICE=$("{{.ADB}}" devices | awk 'NR > 1 && $2 == "device" && $1 !~ /^emulator-/ { print $1; exit }')
|
||||
fi
|
||||
if [ -z "$DEVICE" ]; then
|
||||
echo "Error: no connected physical Android device found."
|
||||
echo "Pass DEVICE_ID=<serial> to target a device explicitly."
|
||||
echo "Find connected device serials with: {{.ADB}} devices"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "Deploying {{.BIN_DIR}}/{{.APP_NAME}}.apk to device $DEVICE..."
|
||||
"{{.ADB}}" -s "$DEVICE" uninstall {{.APP_ID}} 2>/dev/null || true
|
||||
"{{.ADB}}" -s "$DEVICE" install "{{.BIN_DIR}}/{{.APP_NAME}}.apk"
|
||||
"{{.ADB}}" -s "$DEVICE" shell am start -n {{.APP_ID}}/com.wails.app.MainActivity
|
||||
- './scripts/android-deploy.sh --apk "{{.BIN_DIR}}/{{.APP_NAME}}.apk" --target device{{if .DEVICE_ID}} --serial "{{.DEVICE_ID}}"{{end}}{{if .APP_ID}} --expect "{{.APP_ID}}"{{end}}'
|
||||
preconditions:
|
||||
- sh: '[ -x "{{.ADB}}" ] || command -v adb'
|
||||
msg: "adb not found. Install the Android SDK platform-tools (or set ANDROID_HOME)"
|
||||
|
||||
@@ -0,0 +1,204 @@
|
||||
import { test, expect } from '../support/fixtures.js';
|
||||
|
||||
/**
|
||||
* #62. On a phone, background work is shown in the notification band
|
||||
* and the header indicator stands down.
|
||||
*
|
||||
* The report was that the indicator's popover "is obscured by other UI,
|
||||
* so it cannot be read while jobs run". Worth saying plainly: **that
|
||||
* symptom did not reproduce in this tier.** Measured at the device's
|
||||
* own 424x439 viewport, the popover was neither clipped nor covered —
|
||||
* `elementFromPoint` at its centre returned the indicator at every
|
||||
* width tried. So this is not a fix for a stacking bug, and a spec
|
||||
* asserting one would be a spec asserting something that was never
|
||||
* true here.
|
||||
*
|
||||
* What is true regardless, and is what these assert:
|
||||
*
|
||||
* - a popover is a **disclosure**, and it is anchored to a bar 3.25em
|
||||
* tall on a screen 439px tall. Background work is the one thing a
|
||||
* phone should not make you open something to see.
|
||||
* - #57 deletes that bar and is *blocked on this issue*, because the
|
||||
* indicator needs somewhere else to live first. Somewhere else is
|
||||
* the band, and the test that matters for #57 is that the bar no
|
||||
* longer holds the indicator at all.
|
||||
*
|
||||
* This is the media-query tier by necessity: a query inside a shadow
|
||||
* root is answered by the viewport, and `notification-host` decides
|
||||
* whether the panel *exists* from `matchMedia`. The component tier
|
||||
* cannot set either.
|
||||
*/
|
||||
|
||||
type Page = import('@playwright/test').Page;
|
||||
|
||||
const JOBS = [
|
||||
{
|
||||
id: 'phone:scan',
|
||||
kind: 'library-scan',
|
||||
state: 'running',
|
||||
title: 'Scanning Music',
|
||||
current: 40,
|
||||
total: 100,
|
||||
caps: { pausable: true, cancellable: true },
|
||||
},
|
||||
{
|
||||
id: 'phone:idx',
|
||||
kind: 'index-build',
|
||||
state: 'running',
|
||||
title: 'Building the search index',
|
||||
current: 2,
|
||||
total: 9,
|
||||
caps: { pausable: true, cancellable: true },
|
||||
},
|
||||
];
|
||||
|
||||
/** The panel the band renders. Playwright's CSS engine pierces open
|
||||
* shadow roots, which is what keeps this one line. */
|
||||
const bandPanel = (page: Page) => page.locator('job-band').locator('job-panel');
|
||||
|
||||
const PHONE = { width: 424, height: 439 };
|
||||
const DESKTOP = { width: 1100, height: 800 };
|
||||
|
||||
test.describe('background jobs on a phone', () => {
|
||||
test('are shown in the band, without opening anything', async ({
|
||||
app,
|
||||
testctl,
|
||||
}) => {
|
||||
await app.setViewportSize(PHONE);
|
||||
await testctl.emit('JobsChanged', JOBS);
|
||||
|
||||
await expect(bandPanel(app)).toBeVisible();
|
||||
|
||||
// Both jobs, drawn by real `job-row`s -- asking the rows what they
|
||||
// hold rather than reading the panel's text, which would pass
|
||||
// whether or not a row rendered. Playwright's CSS engine pierces
|
||||
// open shadow roots, which is what makes this one line;
|
||||
// `querySelectorAll` does not, and stops at `job-panel`.
|
||||
await expect(bandPanel(app).locator('job-row')).toHaveCount(2);
|
||||
|
||||
await expect(
|
||||
bandPanel(app).locator('job-row').first(),
|
||||
).toContainText('Scanning Music');
|
||||
});
|
||||
|
||||
/**
|
||||
* The #57 assertion. Not "the indicator is invisible" — that could be
|
||||
* true because the bar overflowed — but that the shell's own rule
|
||||
* puts it away at this width.
|
||||
*/
|
||||
test('leave the top bar, which is what #57 is waiting for', async ({
|
||||
app,
|
||||
testctl,
|
||||
}) => {
|
||||
await app.setViewportSize(PHONE);
|
||||
await testctl.emit('JobsChanged', JOBS);
|
||||
await expect(bandPanel(app)).toBeVisible();
|
||||
|
||||
await expect(app.locator('job-indicator')).toBeHidden();
|
||||
});
|
||||
|
||||
/**
|
||||
* The property the first attempt at this got wrong, so it is the one
|
||||
* worth pinning: the band is **in the layout**, not over it.
|
||||
*
|
||||
* A fixed band reads fine in a screenshot and is unusable -- at
|
||||
* 424x439 a compact panel is ~200px of a 439px screen and it covers
|
||||
* what is under it. Four specs failed on that version, two
|
||||
* phone-shell journeys and the header's action menu, because the
|
||||
* panel was intercepting the taps. So: nothing of the app is
|
||||
* underneath it, and the main panel starts below it.
|
||||
*/
|
||||
test('push the content down rather than covering it', async ({
|
||||
app,
|
||||
testctl,
|
||||
}) => {
|
||||
await app.setViewportSize(PHONE);
|
||||
|
||||
const before = await app
|
||||
.getByTestId('main-content')
|
||||
.evaluate((el) => el.getBoundingClientRect().top);
|
||||
|
||||
await testctl.emit('JobsChanged', JOBS);
|
||||
await expect(bandPanel(app)).toBeVisible();
|
||||
|
||||
const after = await app.evaluate(() => {
|
||||
const band = document.querySelector('job-band') as HTMLElement;
|
||||
const main = document.querySelector(
|
||||
'[data-testid="main-content"]',
|
||||
) as HTMLElement;
|
||||
const b = band.getBoundingClientRect();
|
||||
const m = main.getBoundingClientRect();
|
||||
|
||||
// What the browser reports at the band's own centre. If this is
|
||||
// anything but the band, the band is sitting on top of it.
|
||||
const hit = document.elementFromPoint(
|
||||
Math.round(b.x + b.width / 2),
|
||||
Math.round(b.y + b.height / 2),
|
||||
);
|
||||
|
||||
return {
|
||||
mainTop: m.top,
|
||||
bandBottom: b.bottom,
|
||||
withinViewport: b.bottom <= window.innerHeight + 0.5,
|
||||
hit: hit?.tagName.toLowerCase() ?? null,
|
||||
};
|
||||
});
|
||||
|
||||
expect({
|
||||
pushed: after.mainTop > before,
|
||||
mainClearsBand: after.mainTop >= after.bandBottom - 0.5,
|
||||
withinViewport: after.withinViewport,
|
||||
hit: after.hit,
|
||||
}).toEqual({
|
||||
pushed: true,
|
||||
mainClearsBand: true,
|
||||
withinViewport: true,
|
||||
hit: 'job-band',
|
||||
});
|
||||
});
|
||||
|
||||
/**
|
||||
* A running job repaints several times a second. The stack it sits
|
||||
* beside is `role="status" aria-live="polite"`, and a progress bar
|
||||
* inside a live region is a screen reader reading a number out over
|
||||
* and over — so the two are siblings in the band rather than one
|
||||
* list, and this is what says so.
|
||||
*/
|
||||
test('are not inside the live region they sit beside', async ({
|
||||
app,
|
||||
testctl,
|
||||
}) => {
|
||||
await app.setViewportSize(PHONE);
|
||||
await testctl.emit('JobsChanged', JOBS);
|
||||
await expect(bandPanel(app)).toBeVisible();
|
||||
|
||||
const insideLiveRegion = await app.evaluate(() => {
|
||||
const band = document.querySelector('job-band');
|
||||
|
||||
// Neither the band itself nor anything it is nested in may be a
|
||||
// live region -- `closest` answers both at once.
|
||||
return !!band?.closest('[aria-live]') || band?.hasAttribute('aria-live');
|
||||
});
|
||||
|
||||
expect(insideLiveRegion).toBe(false);
|
||||
});
|
||||
|
||||
/**
|
||||
* `bottom-nav` rendering its duplicate `<app-sidebar>` unconditionally
|
||||
* broke 30 specs with "resolved to 2 elements" on a viewport where it
|
||||
* was not even visible. Settings already holds four `job-panel`s, so
|
||||
* a fifth that answers for *every* kind is the same trap — which is
|
||||
* why the band decides from `matchMedia` whether the element exists
|
||||
* rather than hiding it with CSS.
|
||||
*/
|
||||
test('do not leave a second panel behind on a desktop', async ({
|
||||
app,
|
||||
testctl,
|
||||
}) => {
|
||||
await app.setViewportSize(DESKTOP);
|
||||
await testctl.emit('JobsChanged', JOBS);
|
||||
|
||||
await expect(app.locator('job-indicator')).toBeVisible();
|
||||
await expect(bandPanel(app)).toHaveCount(0);
|
||||
});
|
||||
});
|
||||
@@ -108,7 +108,23 @@ test.describe('the top bar fits the window', () => {
|
||||
|
||||
// The indicator has to actually be up, or this test passes by
|
||||
// measuring the idle case under another name.
|
||||
await expect(app.locator('job-indicator')).toBeVisible();
|
||||
//
|
||||
// Below 600px there is deliberately no indicator to measure:
|
||||
// #62 stands it down and puts the rows in `<job-band>` instead,
|
||||
// in the layout under the bar. So at 390 the assertion is that
|
||||
// it *is* away and the bar still fits -- which is the same
|
||||
// property (the bar has nothing hanging out of it) reached by the
|
||||
// other branch of the same rule, rather than a width quietly
|
||||
// dropped from the list.
|
||||
const phone = width < 600;
|
||||
|
||||
await expect(app.locator('job-indicator'))[
|
||||
phone ? 'toBeHidden' : 'toBeVisible'
|
||||
]();
|
||||
|
||||
if (phone) {
|
||||
await expect(app.locator('job-band').locator('job-row')).toHaveCount(1);
|
||||
}
|
||||
|
||||
await expect.poll(() => overflowingChildren(app)).toEqual([]);
|
||||
});
|
||||
|
||||
@@ -414,6 +414,7 @@ body div.sidebar {
|
||||
body {
|
||||
grid-template:
|
||||
"top-bar" 3.25em
|
||||
"jobs-band" auto
|
||||
"main-panel" 1fr
|
||||
"bottom-bar" auto
|
||||
"bottom-nav" auto
|
||||
@@ -522,3 +523,45 @@ body div.sidebar {
|
||||
display: none;
|
||||
}
|
||||
}
|
||||
|
||||
/* Out of the desktop grid entirely. `job-band` renders nothing above
|
||||
600px anyway, but an in-flow grid child with no named area is
|
||||
auto-placed into a row of the shell -- the same trap the skip link is
|
||||
absolutely positioned to avoid. */
|
||||
body job-band {
|
||||
display: none;
|
||||
}
|
||||
|
||||
/* #62. The job indicator stands down on the phone, and its work is
|
||||
shown in the notification band instead (notification-host).
|
||||
|
||||
Three reasons, and the first is the report: its popover is anchored
|
||||
to the top bar, which is 3.25em here on a viewport 439 CSS px tall,
|
||||
and it was reported as unreadable behind other UI. The second is
|
||||
that a popover is a disclosure, and background work is the one thing
|
||||
a phone should not make you disclose. The third is #57, which
|
||||
deletes this bar entirely and is blocked on the indicator having
|
||||
somewhere else to live -- this is that somewhere.
|
||||
|
||||
`display: none` rather than a fit step: `services/top-bar-fit.ts`
|
||||
already skips children whose computed display is none, so the bar's
|
||||
measurement simply sees one fewer child, and `[compact]` toggling on
|
||||
a hidden element costs nothing. */
|
||||
@media (max-width: 599px) {
|
||||
.top-bar job-indicator {
|
||||
display: none;
|
||||
}
|
||||
|
||||
/* ...and its rows appear here, in the grid row above the content.
|
||||
In flow rather than over it: a fixed band reads fine in a
|
||||
screenshot and is unusable, because at 424x439 a compact panel
|
||||
is ~200px of a 439px screen and it *covers* what is under it.
|
||||
Measured, not assumed -- four e2e specs failed on that version,
|
||||
two phone-shell journeys and the header's action menu, because
|
||||
the panel was intercepting the taps. */
|
||||
body job-band {
|
||||
display: block;
|
||||
grid-area: jobs-band;
|
||||
background-color: var(--yj-bg-elevated, #343a40);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -30,6 +30,14 @@
|
||||
<search-bar></search-bar>
|
||||
<job-indicator></job-indicator>
|
||||
</header>
|
||||
<!-- The phone's view of background work (#62): below 600px the
|
||||
indicator above stands down and its rows appear here instead,
|
||||
in the layout rather than over it. `display: none` above that
|
||||
width in index.css, which is also what keeps it out of the
|
||||
desktop grid -- an in-flow child with no named area is
|
||||
auto-placed into one of the shell's rows, which is the trap the
|
||||
skip link is absolutely positioned to avoid. -->
|
||||
<job-band></job-band>
|
||||
<div class="sidebar">
|
||||
<app-sidebar></app-sidebar>
|
||||
</div>
|
||||
|
||||
@@ -38,6 +38,11 @@ import '@components/confirm-dialog/confirm-dialog.ts';
|
||||
// not know what is going on. It costs a dialog and a table.
|
||||
import '@components/shortcuts-overlay/shortcuts-overlay.ts';
|
||||
import '@components/jobs/job-indicator.ts';
|
||||
// The phone's half of the same thing (#62). Eager because it is part
|
||||
// of the shell's first paint below 600px, and because a band that has
|
||||
// to fetch a chunk before it can say the app is busy is late by
|
||||
// exactly the interval it exists to explain.
|
||||
import '@components/jobs/job-band.ts';
|
||||
import '@awesome.me/webawesome/dist/styles/themes/default.css';
|
||||
import '@awesome.me/webawesome/dist/components/icon/icon.js';
|
||||
import { setBasePath } from '@awesome.me/webawesome/dist/webawesome.js';
|
||||
|
||||
@@ -22,6 +22,24 @@ export class SeekBar extends LitElement {
|
||||
@state()
|
||||
private seekValue: number = 0;
|
||||
|
||||
/**
|
||||
* Whether the user is dragging the thumb right now.
|
||||
*
|
||||
* It is `@state` rather than a plain field because `updated()` owns
|
||||
* the interval and only reactive state brings `updated()` round. A
|
||||
* bare `stopProgress()` in the input handler mutated nothing, so
|
||||
* nothing re-rendered, so the tail of `updated()` that restarts the
|
||||
* interval never ran — and the only things that could restart it
|
||||
* were a `change` event or the next backend report. Any `input`
|
||||
* without a committed `change` therefore froze the interpolation:
|
||||
* a drag cancelled outside the element, a pointer taken by a scroll,
|
||||
* or a touch on the track treated as a scrub, which on a phone are
|
||||
* ordinary gestures. While playing, the 1 Hz report papered over it
|
||||
* within a second; with reports not arriving it was permanent.
|
||||
*/
|
||||
@state()
|
||||
private dragging: boolean = false;
|
||||
|
||||
/** Whether the right-hand clock shows time remaining or total. */
|
||||
@state()
|
||||
private showRemaining: boolean = true;
|
||||
@@ -133,6 +151,7 @@ export class SeekBar extends LitElement {
|
||||
override disconnectedCallback() {
|
||||
super.disconnectedCallback();
|
||||
this.stopProgress();
|
||||
this.endDrag();
|
||||
}
|
||||
|
||||
override updated() {
|
||||
@@ -154,18 +173,33 @@ export class SeekBar extends LitElement {
|
||||
// A report for a track that is no longer loaded is stale by
|
||||
// definition: the change id is the only thing that distinguishes
|
||||
// it, since the same file can play twice in a row.
|
||||
//
|
||||
// A report arriving mid-drag is deliberately *not* applied: the
|
||||
// thumb belongs to the finger on it, and adopting a report once a
|
||||
// second pulls it back out from under them. The seq is left
|
||||
// unrecorded too, so the first report after the drag still counts
|
||||
// as fresh.
|
||||
const position = this.player.position;
|
||||
const forThisTrack =
|
||||
position !== null && position.trackChangeId === currentChangeId;
|
||||
|
||||
if (position && forThisTrack && position.seq !== this.previousPositionSeq) {
|
||||
if (
|
||||
position &&
|
||||
forThisTrack &&
|
||||
!this.dragging &&
|
||||
position.seq !== this.previousPositionSeq
|
||||
) {
|
||||
this.previousPositionSeq = position.seq;
|
||||
this.seekValue = position.positionSeconds;
|
||||
this.stopProgress();
|
||||
}
|
||||
|
||||
// Start/stop progress interval based on playback state
|
||||
if (this.isPlaying && this.hasTrack) {
|
||||
// One owner for the interval, and this is it. Every other place
|
||||
// that wants it started or stopped says so by changing state that
|
||||
// brings us back here, so the timer cannot be left running by a
|
||||
// path that forgot to stop it or stopped by a path that forgot to
|
||||
// start it again.
|
||||
if (this.isPlaying && this.hasTrack && !this.dragging) {
|
||||
this.startProgress();
|
||||
} else {
|
||||
this.stopProgress();
|
||||
@@ -210,18 +244,48 @@ export class SeekBar extends LitElement {
|
||||
|
||||
private handleChange(e: Event) {
|
||||
const newSeekVal = (e.target as WaSlider).value;
|
||||
this.endDrag();
|
||||
this.setSeekValue(newSeekVal);
|
||||
this.player.seek(newSeekVal);
|
||||
}
|
||||
|
||||
if (this.isPlaying) {
|
||||
this.startProgress();
|
||||
/**
|
||||
* The user is moving the thumb.
|
||||
*
|
||||
* This only records that fact; `updated()` decides what it means for
|
||||
* the interval. `seekValue` follows the slider so the clocks track
|
||||
* the thumb during the drag rather than jumping when it is released.
|
||||
*/
|
||||
private handleInput(e: Event) {
|
||||
this.setSeekValue((e.target as WaSlider).value);
|
||||
|
||||
if (this.dragging) {
|
||||
return;
|
||||
}
|
||||
|
||||
this.dragging = true;
|
||||
|
||||
// A drag that never commits must not strand the flag, or this fix
|
||||
// turns a stall of up to one second into a permanent one -- which
|
||||
// is the failure it exists to remove. `change` is the ordinary
|
||||
// end; these are the ones that are not, and they are on the
|
||||
// document because the pointer is routinely released outside the
|
||||
// element it started in. A drag's listeners belong to the drag,
|
||||
// so they go on with it and come off with it.
|
||||
document.addEventListener('pointerup', this.endDrag);
|
||||
document.addEventListener('pointercancel', this.endDrag);
|
||||
document.addEventListener('touchend', this.endDrag);
|
||||
document.addEventListener('touchcancel', this.endDrag);
|
||||
}
|
||||
|
||||
// Stops progress while user is dragging the thumb
|
||||
private handleInput() {
|
||||
this.stopProgress();
|
||||
}
|
||||
private endDrag = () => {
|
||||
document.removeEventListener('pointerup', this.endDrag);
|
||||
document.removeEventListener('pointercancel', this.endDrag);
|
||||
document.removeEventListener('touchend', this.endDrag);
|
||||
document.removeEventListener('touchcancel', this.endDrag);
|
||||
|
||||
this.dragging = false;
|
||||
};
|
||||
|
||||
private setSeekValue(val: number) {
|
||||
if (val < 0) val = 0;
|
||||
|
||||
@@ -0,0 +1,132 @@
|
||||
/**
|
||||
* The phone's view of background work (#62).
|
||||
*
|
||||
* The header `job-indicator` is a *popover*, anchored to a bar 3.25em
|
||||
* tall on a screen 439 CSS px tall, and it was reported as unreadable
|
||||
* behind other UI. Two things are wrong with it there regardless of
|
||||
* that symptom: a popover is a **disclosure**, and background work is
|
||||
* the one thing a phone should not make you open something to see; and
|
||||
* #57 deletes the bar it is anchored to, and is blocked on this issue
|
||||
* precisely because the indicator needs somewhere else to live first.
|
||||
*
|
||||
* This is that somewhere. Below 600px the indicator stands down
|
||||
* (`index.css`) and its work appears here instead.
|
||||
*
|
||||
* Four things about it are load-bearing.
|
||||
*
|
||||
* **It is the existing `job-panel`, not a second job UI.** Pause,
|
||||
* cancel, Details and the log all come along — and, more to the point,
|
||||
* so does `applyJobControl`, which is what carries the "you will
|
||||
* discard hours of downloading" confirmation for an index build. A
|
||||
* host drawing its own buttons drops that silently, which is the trap
|
||||
* #27 already named.
|
||||
*
|
||||
* **It is in the layout, not over it**, and that was measured rather
|
||||
* than assumed. The first version of this put the panel in
|
||||
* `notification-host`'s fixed band, which reads fine in a screenshot
|
||||
* and is unusable: at 424x439 a compact panel is ~200px of a 439px
|
||||
* screen, and it *covers* what is under it. Four e2e specs failed —
|
||||
* two phone-shell journeys and the header's action menu — because the
|
||||
* panel was intercepting the taps. A band that hides the app to tell
|
||||
* you the app is busy is worse than the popover it replaced. In flow
|
||||
* it pushes instead, so nothing is covered and nothing is unreachable,
|
||||
* which is #24's one sentence across all three bands.
|
||||
*
|
||||
* **It shows active work only.** A finished row that lingers is a
|
||||
* banner that stays after the work is done, which is the opposite of
|
||||
* what #62 asks for ("dismissed automatically on completion") and, in
|
||||
* flow, is furniture that keeps the content pushed down. Finished jobs
|
||||
* are still shown where the work was started, which is #27's rule and
|
||||
* unaffected.
|
||||
*
|
||||
* **It renders nothing at all above 600px**, from `matchMedia` rather
|
||||
* than a media query, because this decides whether the element
|
||||
* *exists*. `bottom-nav` learned that the expensive way: rendering its
|
||||
* duplicate `<app-sidebar>` unconditionally put a second copy of every
|
||||
* `nav-*` testid in the DOM and broke 30 specs on a viewport where it
|
||||
* was not even visible. Settings already holds four `job-panel`s, so a
|
||||
* fifth answering for *every* kind is the same trap.
|
||||
*/
|
||||
import { LitElement, html, css, nothing } from 'lit';
|
||||
import { customElement, state } from 'lit/decorators.js';
|
||||
|
||||
import { jobStore } from '@store/job-store';
|
||||
import { isTerminal } from '@store/job-store';
|
||||
import { designTokens } from '../../styles/tokens.css';
|
||||
import { PHONE_QUERY } from '../../utils/breakpoints';
|
||||
import './job-panel';
|
||||
|
||||
@customElement('job-band')
|
||||
export class JobBand extends LitElement {
|
||||
@state() private phone = false;
|
||||
|
||||
@state() private active = 0;
|
||||
|
||||
private media?: MediaQueryList;
|
||||
|
||||
private unsubscribe?: () => void;
|
||||
|
||||
static override styles = [
|
||||
designTokens,
|
||||
css`
|
||||
:host {
|
||||
display: block;
|
||||
min-width: 0;
|
||||
}
|
||||
|
||||
/* The panel's own margin is for a settings section; here the
|
||||
band owns the spacing. */
|
||||
job-panel {
|
||||
margin-top: 0;
|
||||
padding: 0 0.5em 0.5em;
|
||||
}
|
||||
`,
|
||||
];
|
||||
|
||||
private onMedia = (e: MediaQueryListEvent | MediaQueryList) => {
|
||||
this.phone = e.matches;
|
||||
};
|
||||
|
||||
private onJobs = () => {
|
||||
this.active = jobStore.jobs.filter((job) => !isTerminal(job)).length;
|
||||
};
|
||||
|
||||
override connectedCallback(): void {
|
||||
super.connectedCallback();
|
||||
|
||||
this.media = window.matchMedia(PHONE_QUERY);
|
||||
this.phone = this.media.matches;
|
||||
this.media.addEventListener('change', this.onMedia);
|
||||
|
||||
// The band decides whether to render *at all*, and a panel that
|
||||
// hides itself cannot tell its host that.
|
||||
this.unsubscribe = jobStore.subscribe(this.onJobs);
|
||||
this.onJobs();
|
||||
void jobStore.init();
|
||||
}
|
||||
|
||||
override disconnectedCallback(): void {
|
||||
super.disconnectedCallback();
|
||||
this.unsubscribe?.();
|
||||
this.media?.removeEventListener('change', this.onMedia);
|
||||
}
|
||||
|
||||
override render() {
|
||||
// `hidden` rather than an empty render, so the grid row this
|
||||
// sits in costs nothing at all while there is no work -- the
|
||||
// rule `job-panel` already follows one layer down.
|
||||
this.hidden = !(this.phone && this.active > 0);
|
||||
|
||||
if (this.hidden) return nothing;
|
||||
|
||||
return html`
|
||||
<job-panel kinds="*" density="compact" active-only></job-panel>
|
||||
`;
|
||||
}
|
||||
}
|
||||
|
||||
declare global {
|
||||
interface HTMLElementTagNameMap {
|
||||
'job-band': JobBand;
|
||||
}
|
||||
}
|
||||
@@ -51,6 +51,14 @@ export class JobPanel extends LitElement {
|
||||
* literal in a template, and one of them is inside an HTMX-adjacent
|
||||
* settings page where a property binding would be one more thing to
|
||||
* remember.
|
||||
*
|
||||
* **`*` means every kind**, which is the phone's band (#62) and
|
||||
* nothing else: there, this panel is standing in for the header
|
||||
* indicator, whose whole job was to be the one view of everything
|
||||
* at once. It is spelled `*` rather than taken as the meaning of an
|
||||
* empty attribute, because empty is what a typo and a missing
|
||||
* binding both produce and "show everything" is the wrong thing to
|
||||
* do by accident. Empty still shows nothing.
|
||||
*/
|
||||
@property({ type: String })
|
||||
kinds = '';
|
||||
@@ -59,6 +67,31 @@ export class JobPanel extends LitElement {
|
||||
@property({ type: String })
|
||||
heading = '';
|
||||
|
||||
/**
|
||||
* Row density, passed to `job-row`.
|
||||
*
|
||||
* `full` adds elapsed time and per-job statistics and is what a
|
||||
* settings section wants, so it stays the default and the four
|
||||
* existing call sites are unchanged. `compact` is what `job-row`
|
||||
* itself calls "the popover density", and it is what the phone's
|
||||
* band uses (#62) — there this panel *is* the popover, on a screen
|
||||
* 439 CSS px tall, and the full density spent 259 of them.
|
||||
*/
|
||||
@property({ type: String })
|
||||
density: 'compact' | 'full' = 'full';
|
||||
|
||||
/**
|
||||
* Drop finished rows.
|
||||
*
|
||||
* For the phone's band (#62), which is *in the layout*: a finished
|
||||
* row there is a banner that stays after the work is done and keeps
|
||||
* the content pushed down. Settings keeps them, because that is
|
||||
* where "did the last scan work" is asked, and a finished row there
|
||||
* dismisses itself.
|
||||
*/
|
||||
@property({ type: Boolean, attribute: 'active-only' })
|
||||
activeOnly = false;
|
||||
|
||||
@state()
|
||||
private jobs: Job[] = [];
|
||||
|
||||
@@ -162,9 +195,14 @@ export class JobPanel extends LitElement {
|
||||
}
|
||||
|
||||
private get mine(): Job[] {
|
||||
const wanted = this.wanted;
|
||||
const ofKind =
|
||||
this.kinds.trim() === '*'
|
||||
? this.jobs
|
||||
: this.jobs.filter((job) =>
|
||||
this.wanted.has(job.kind as JobKind),
|
||||
);
|
||||
|
||||
return this.jobs.filter((job) => wanted.has(job.kind as JobKind));
|
||||
return this.activeOnly ? ofKind.filter((job) => !isTerminal(job)) : ofKind;
|
||||
}
|
||||
|
||||
private openDetails(id: string) {
|
||||
@@ -196,7 +234,7 @@ export class JobPanel extends LitElement {
|
||||
<div class="job-entry">
|
||||
<job-row
|
||||
.job=${job}
|
||||
variant="full"
|
||||
variant=${this.density}
|
||||
@job-control=${applyJobControl}
|
||||
></job-row>
|
||||
<button
|
||||
|
||||
@@ -76,6 +76,68 @@ describe('<job-panel>', () => {
|
||||
expect(titles(el)).toEqual(['Building the index', 'Filling in artists']);
|
||||
});
|
||||
|
||||
/**
|
||||
* #62. The phone's band has no kinds to name: it is standing in for
|
||||
* the header indicator, whose whole job was to be the one view of
|
||||
* everything at once.
|
||||
*/
|
||||
it('answers for every kind when asked with a star', async () => {
|
||||
const el = await fixture<LitElement>('job-panel', { kinds: '*' });
|
||||
|
||||
await snapshot([
|
||||
job({ id: 'scan:1', kind: 'library-scan', title: 'Scanning Music' }),
|
||||
job({ id: 'idx', kind: 'index-build', title: 'Building the index' }),
|
||||
job({ id: 'dl:1', kind: 'download', title: 'Downloading Glass Harbour' }),
|
||||
]);
|
||||
await el.updateComplete;
|
||||
|
||||
expect(titles(el)).toEqual([
|
||||
'Scanning Music',
|
||||
'Building the index',
|
||||
'Downloading Glass Harbour',
|
||||
]);
|
||||
});
|
||||
|
||||
/**
|
||||
* The other half of that, and the reason it is a star rather than the
|
||||
* meaning of an empty attribute: empty is what a typo and a dropped
|
||||
* binding both produce, and "show everything" is the wrong thing to
|
||||
* do by accident.
|
||||
*/
|
||||
it('still shows nothing when asked for nothing', async () => {
|
||||
const el = await fixture<LitElement>('job-panel', { kinds: '' });
|
||||
|
||||
await snapshot([job({ id: 'scan:1', kind: 'library-scan' })]);
|
||||
await el.updateComplete;
|
||||
|
||||
expect([el.hidden, rows(el)].map(String)).toEqual(['true', '']);
|
||||
});
|
||||
|
||||
/**
|
||||
* `full` stays the default so the four settings call sites are
|
||||
* untouched; the band asks for the density `job-row` calls "the
|
||||
* popover density", because on the phone this panel *is* the popover.
|
||||
*/
|
||||
it('passes its density to the rows, defaulting to full', async () => {
|
||||
const settings = await fixture<LitElement>('job-panel', { kinds: '*' });
|
||||
|
||||
await snapshot([job()]);
|
||||
await settings.updateComplete;
|
||||
|
||||
const band = await fixture<LitElement>('job-panel', {
|
||||
kinds: '*',
|
||||
density: 'compact',
|
||||
});
|
||||
|
||||
await snapshot([job()]);
|
||||
await band.updateComplete;
|
||||
|
||||
expect([
|
||||
rows(settings)[0]?.getAttribute('variant'),
|
||||
rows(band)[0]?.getAttribute('variant'),
|
||||
]).toEqual(['full', 'compact']);
|
||||
});
|
||||
|
||||
/**
|
||||
* An idle panel in four places is four pieces of furniture describing
|
||||
* an absence — and `hidden` rather than an empty render, because the
|
||||
|
||||
@@ -397,6 +397,111 @@ describe('<seek-bar>', () => {
|
||||
expect(lastArgs('player.Player.Seek')).toEqual([42]);
|
||||
});
|
||||
|
||||
// #164. `handleInput` used to call `stopProgress()` and mutate no
|
||||
// reactive state, so Lit scheduled no update, `updated()` never ran,
|
||||
// and the tail of `updated()` that restarts the interval never
|
||||
// executed. Only a `change` or the next backend report could bring
|
||||
// it back -- so an `input` that never commits froze the clock, which
|
||||
// on a touch device is an ordinary cancelled gesture. With no
|
||||
// reports arriving, that is permanent.
|
||||
it('keeps ticking after a drag that never commits', async () => {
|
||||
vi.useFakeTimers();
|
||||
|
||||
const el = await fixture('seek-bar');
|
||||
|
||||
emit(Events.TrackChanged, TRACK);
|
||||
emit(Events.PlaybackStateChanged, { state: 'playing' });
|
||||
await vi.advanceTimersByTimeAsync(2000);
|
||||
await el.updateComplete;
|
||||
|
||||
// A touch lands on the track and is then cancelled: `input`, and
|
||||
// no `change` ever follows.
|
||||
const slider = shadow<HTMLElement & { value: number }>(el, 'wa-slider');
|
||||
|
||||
if (slider) slider.value = 20;
|
||||
|
||||
slider?.dispatchEvent(new Event('input'));
|
||||
await el.updateComplete;
|
||||
|
||||
document.dispatchEvent(new Event('pointerup'));
|
||||
await vi.advanceTimersByTimeAsync(0);
|
||||
await el.updateComplete;
|
||||
|
||||
await vi.advanceTimersByTimeAsync(3000);
|
||||
await el.updateComplete;
|
||||
|
||||
expect(text(el, '[data-testid="elapsed-time"]')).toBe('00:23');
|
||||
});
|
||||
|
||||
// The other half of the same fix: while the thumb is held, a report
|
||||
// arriving once a second used to overwrite `seekValue` and pull it
|
||||
// back out from under the finger.
|
||||
it('leaves the thumb where the finger is while a drag is live', async () => {
|
||||
vi.useFakeTimers();
|
||||
|
||||
const el = await fixture('seek-bar');
|
||||
|
||||
emit(Events.TrackChanged, { ...TRACK, trackChangeId: 20 });
|
||||
emit(Events.PlaybackStateChanged, { state: 'playing' });
|
||||
await vi.advanceTimersByTimeAsync(0);
|
||||
await el.updateComplete;
|
||||
|
||||
const slider = shadow<HTMLElement & { value: number }>(el, 'wa-slider');
|
||||
|
||||
if (slider) slider.value = 60;
|
||||
|
||||
slider?.dispatchEvent(new Event('input'));
|
||||
await el.updateComplete;
|
||||
|
||||
emit(Events.PlaybackPositionChanged, {
|
||||
positionSeconds: 4,
|
||||
trackLength: 90,
|
||||
trackChangeId: 20,
|
||||
seq: 7,
|
||||
playing: true,
|
||||
});
|
||||
await vi.advanceTimersByTimeAsync(0);
|
||||
await el.updateComplete;
|
||||
|
||||
expect(text(el, '[data-testid="elapsed-time"]')).toBe('01:00');
|
||||
});
|
||||
|
||||
// And the drag must not hold the interval hostage once it ends: the
|
||||
// report that was skipped mid-drag is not recorded as seen, so the
|
||||
// next one is still fresh and is applied.
|
||||
it('takes the backend back as the authority once the drag commits', async () => {
|
||||
vi.useFakeTimers();
|
||||
|
||||
const el = await fixture('seek-bar');
|
||||
|
||||
emit(Events.TrackChanged, { ...TRACK, trackChangeId: 21 });
|
||||
emit(Events.PlaybackStateChanged, { state: 'playing' });
|
||||
await vi.advanceTimersByTimeAsync(0);
|
||||
await el.updateComplete;
|
||||
|
||||
const slider = shadow<HTMLElement & { value: number }>(el, 'wa-slider');
|
||||
|
||||
if (slider) slider.value = 60;
|
||||
|
||||
slider?.dispatchEvent(new Event('input'));
|
||||
await el.updateComplete;
|
||||
|
||||
slider?.dispatchEvent(new Event('change'));
|
||||
await el.updateComplete;
|
||||
|
||||
emit(Events.PlaybackPositionChanged, {
|
||||
positionSeconds: 61,
|
||||
trackLength: 90,
|
||||
trackChangeId: 21,
|
||||
seq: 9,
|
||||
playing: true,
|
||||
});
|
||||
await vi.advanceTimersByTimeAsync(0);
|
||||
await el.updateComplete;
|
||||
|
||||
expect(text(el, '[data-testid="elapsed-time"]')).toBe('01:01');
|
||||
});
|
||||
|
||||
it('bounds the slider by the track length', async () => {
|
||||
const el = await fixture('seek-bar');
|
||||
|
||||
|
||||
Executable
+196
@@ -0,0 +1,196 @@
|
||||
#!/usr/bin/env bash
|
||||
#
|
||||
# Install a built APK onto an Android target and launch it, under the
|
||||
# package id the APK itself declares.
|
||||
#
|
||||
# This is the whole body of build/android/Taskfile.yml's four adb-driven
|
||||
# tasks — deploy-emulator, run, run:device, deploy-device — which were
|
||||
# three lines each, written out four times, and wrong in two ways in all
|
||||
# four (#159):
|
||||
#
|
||||
# adb uninstall app.yellowjacket # the RELEASE id, unconditionally
|
||||
# adb install bin/yellowjacket.apk
|
||||
# adb shell am start -n app.yellowjacket/com.wails.app.MainActivity
|
||||
#
|
||||
# **The uninstall is not here and does not come back.** It was there to
|
||||
# make the bare `install` on the next line work at all — without -r,
|
||||
# Android refuses an install over an existing package — so `install -r`
|
||||
# removes the reason for it rather than merely removing it. What is
|
||||
# left is the one case an uninstall really is the remedy, a changed
|
||||
# signing certificate, and that is exactly the case where performing it
|
||||
# silently costs the user their library. So it is *named* and not done:
|
||||
# an error message carrying the command is a decision the person at the
|
||||
# keyboard gets to make, which is the same answer scripts/android-
|
||||
# emulator.sh already reached for `make android-install`.
|
||||
#
|
||||
# **The id is read back from the artifact**, never defaulted, so the
|
||||
# thing installed and the thing launched cannot disagree — see
|
||||
# scripts/android-pkgid.sh for why that is by construction rather than
|
||||
# by discipline.
|
||||
#
|
||||
# **The target is checked against the task's own name.** The emulator
|
||||
# tasks used a bare `adb`, which with one device attached picks that
|
||||
# device whatever it is — so `wails3 task android:run`, whose summary
|
||||
# says "in the Android Emulator", installed on the phone when a phone
|
||||
# was the only thing plugged in. A task addressing something other than
|
||||
# what it says is the same fault as the package id, one level up.
|
||||
#
|
||||
# Usage:
|
||||
# android-deploy.sh --apk <path> --target emulator|device|any \
|
||||
# [--expect <id>] [--serial <s>] [--no-launch]
|
||||
set -euo pipefail
|
||||
|
||||
cd "$(dirname "$0")/.."
|
||||
|
||||
SDK="${ANDROID_HOME:-${ANDROID_SDK_ROOT:-$HOME/Android/Sdk}}"
|
||||
ADB="$(command -v adb || echo "$SDK/platform-tools/adb")"
|
||||
|
||||
# **Not "$PKG/.MainActivity".** A leading-dot activity is resolved
|
||||
# against the applicationId, and the scaffold's activity lives in the
|
||||
# Java package com.wails.app, which is deliberately not it. The short
|
||||
# form fails with a class-not-found that reads like a broken build.
|
||||
ACTIVITY="${YJ_ANDROID_ACTIVITY:-com.wails.app.MainActivity}"
|
||||
|
||||
APK=""
|
||||
TARGET="any"
|
||||
EXPECT=""
|
||||
SERIAL="${ANDROID_SERIAL:-${DEVICE_ID:-}}"
|
||||
LAUNCH=1
|
||||
|
||||
die() { echo "android-deploy: $*" >&2; exit 1; }
|
||||
|
||||
while [ $# -gt 0 ]; do
|
||||
case "$1" in
|
||||
--apk) APK="${2:-}"; shift 2 ;;
|
||||
--target) TARGET="${2:-}"; shift 2 ;;
|
||||
--expect) EXPECT="${2:-}"; shift 2 ;;
|
||||
--serial) SERIAL="${2:-}"; shift 2 ;;
|
||||
--no-launch) LAUNCH=0; shift ;;
|
||||
*) die "unknown option $1" ;;
|
||||
esac
|
||||
done
|
||||
|
||||
[ -n "$APK" ] || die "--apk is required"
|
||||
[ -f "$APK" ] || die "no such APK: $APK
|
||||
Build one first: wails3 task android:assemble:apk (debug)
|
||||
wails3 task android:package (release)"
|
||||
[ -x "$ADB" ] || command -v adb >/dev/null ||
|
||||
die "adb not found. Install the Android SDK platform-tools (or set ANDROID_HOME)"
|
||||
|
||||
case "$TARGET" in
|
||||
emulator | device | any) ;;
|
||||
*) die "--target must be emulator, device or any (got '$TARGET')" ;;
|
||||
esac
|
||||
|
||||
# ---------------------------------------------------------------- #
|
||||
# Which package
|
||||
# ---------------------------------------------------------------- #
|
||||
|
||||
# This runs *before* a target is chosen, deliberately: the guard is a
|
||||
# question about the artifact, so it can be answered — and exercised —
|
||||
# with nothing plugged in, and a build whose id is wrong should be
|
||||
# refused whether or not there is anything to install it onto.
|
||||
#
|
||||
# An unreadable APK, or an id that is not the one the caller named, is a
|
||||
# hard stop before anything is installed or launched. Spelled as two
|
||||
# calls rather than one with a conditional argument: an empty array under
|
||||
# `set -u` is an unbound variable in bash 3.2, which is what macOS ships.
|
||||
if [ -n "$EXPECT" ]; then
|
||||
PKG="$(./scripts/android-pkgid.sh "$APK" --expect "$EXPECT")"
|
||||
else
|
||||
PKG="$(./scripts/android-pkgid.sh "$APK")"
|
||||
fi
|
||||
|
||||
# ---------------------------------------------------------------- #
|
||||
# Which target
|
||||
# ---------------------------------------------------------------- #
|
||||
|
||||
# An emulator serial is "emulator-<port>"; anything else online is a
|
||||
# physical device. That is the same test the device tasks already made,
|
||||
# and the emulator tasks did not make at all.
|
||||
online_matching() {
|
||||
case "$TARGET" in
|
||||
emulator) "$ADB" devices | awk 'NR > 1 && $2 == "device" && $1 ~ /^emulator-/ { print $1 }' ;;
|
||||
device) "$ADB" devices | awk 'NR > 1 && $2 == "device" && $1 !~ /^emulator-/ { print $1 }' ;;
|
||||
any) "$ADB" devices | awk 'NR > 1 && $2 == "device" { print $1 }' ;;
|
||||
esac
|
||||
}
|
||||
|
||||
if [ -z "$SERIAL" ]; then
|
||||
matches="$(online_matching)"
|
||||
count="$(printf '%s' "$matches" | grep -c . || true)"
|
||||
|
||||
if [ "$count" -eq 0 ]; then
|
||||
echo "android-deploy: no ${TARGET/any/attached} target is online." >&2
|
||||
"$ADB" devices | sed '1d;/^$/d;s/^/ /' >&2 || true
|
||||
if [ "$TARGET" = "emulator" ]; then
|
||||
echo " Start one with: make android-emulator" >&2
|
||||
elif [ "$TARGET" = "device" ]; then
|
||||
echo " Plug a phone in and authorise the adb key." >&2
|
||||
fi
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Several is ambiguous, and picking the first silently is how a
|
||||
# build lands on a target nobody named. The old run:device did
|
||||
# exactly that.
|
||||
if [ "$count" -gt 1 ]; then
|
||||
echo "android-deploy: several $TARGET targets are online — name one." >&2
|
||||
printf '%s\n' "$matches" | sed 's/^/ /' >&2
|
||||
echo " Pass DEVICE_ID=<serial>, or set ANDROID_SERIAL." >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
SERIAL="$matches"
|
||||
fi
|
||||
|
||||
# ---------------------------------------------------------------- #
|
||||
# Install
|
||||
# ---------------------------------------------------------------- #
|
||||
|
||||
echo "android-deploy: $APK ($PKG) -> $SERIAL"
|
||||
|
||||
if ! out="$("$ADB" -s "$SERIAL" install -r "$APK" 2>&1)"; then
|
||||
printf '%s\n' "$out"
|
||||
case "$out" in
|
||||
*INSTALL_FAILED_UPDATE_INCOMPATIBLE* | *"signatures do not match"*)
|
||||
cat >&2 <<EOF
|
||||
|
||||
The copy of $PKG already installed was signed with a different key, and
|
||||
Android never allows that as an update.
|
||||
|
||||
The only way forward is an uninstall — **which deletes that app's data**,
|
||||
and for this app that is the user's library, irreversibly. So it is not
|
||||
done for you. If the installed copy is disposable:
|
||||
|
||||
$ADB -s $SERIAL uninstall $PKG
|
||||
|
||||
If it is not — if this is a released build with a real library on it —
|
||||
install the debug variant instead, which carries applicationIdSuffix
|
||||
".dev" and so sits beside it rather than replacing it:
|
||||
|
||||
wails3 task android:assemble:apk
|
||||
EOF
|
||||
;;
|
||||
*INSTALL_FAILED_VERSION_DOWNGRADE*)
|
||||
cat >&2 <<EOF
|
||||
|
||||
The installed copy of $PKG has a higher versionCode than this build.
|
||||
A bare 'make android' builds versionCode 1; a versioned one builds e.g.
|
||||
10301. Either build with a version:
|
||||
|
||||
YJ_VERSION=1.3.1 YJ_VERSION_CODE=10301 make android
|
||||
|
||||
or, if the installed copy is disposable, remove it:
|
||||
|
||||
$ADB -s $SERIAL uninstall $PKG
|
||||
EOF
|
||||
;;
|
||||
esac
|
||||
exit 1
|
||||
fi
|
||||
printf '%s\n' "$out"
|
||||
|
||||
[ "$LAUNCH" -eq 1 ] || exit 0
|
||||
|
||||
"$ADB" -s "$SERIAL" shell am start -n "$PKG/$ACTIVITY"
|
||||
@@ -34,7 +34,21 @@ cd "$(dirname "$0")/.."
|
||||
|
||||
AVD="${YJ_AVD:-yj-test}"
|
||||
SDK="${ANDROID_SDK_ROOT:-${ANDROID_HOME:-$HOME/Android/Sdk}}"
|
||||
PKG="${YJ_ANDROID_PKG:-app.yellowjacket}"
|
||||
# The third declaration of the app's identity, and the one #159 did not
|
||||
# cash out in -- but the same hazard, so it is derived rather than
|
||||
# written down too. The APK in bin/ is what `make android-install` is
|
||||
# about to install and what `android-launch`, `logs` and `smoke` are
|
||||
# about to address, so it is the authority; whatever Gradle resolved the
|
||||
# applicationId to, suffix included, is in the file.
|
||||
#
|
||||
# The literal survives only as the answer for a tree with no APK built
|
||||
# yet, where these commands are asking about whatever is already on the
|
||||
# device and there is nothing to read. YJ_ANDROID_PKG still overrides.
|
||||
PKG="${YJ_ANDROID_PKG:-}"
|
||||
if [ -z "$PKG" ] && [ -f bin/yellowjacket.apk ]; then
|
||||
PKG="$(./scripts/android-pkgid.sh bin/yellowjacket.apk 2>/dev/null || true)"
|
||||
fi
|
||||
PKG="${PKG:-app.yellowjacket}"
|
||||
# Where `make android-inspect` forwards the WebView's devtools socket.
|
||||
CDP_PORT="${YJ_ANDROID_CDP_PORT:-9222}"
|
||||
# **Not "$PKG/.MainActivity".** A leading-dot activity is resolved
|
||||
@@ -281,15 +295,24 @@ cmd_inspect() {
|
||||
need_sdk
|
||||
pick_device || die "no device -- plug a phone in (USB debugging on) or run 'make android-emulator'"
|
||||
|
||||
local pkg pid
|
||||
local pkg pid candidates
|
||||
pid=""
|
||||
|
||||
for pkg in "$PKG.dev" "$PKG"; do
|
||||
# Debug sibling first, release second, whichever way round $PKG was
|
||||
# resolved -- it is read from the built APK now, so it is already the
|
||||
# .dev id whenever a debug build is what is in bin/, and appending a
|
||||
# second ".dev" to it would probe a package that cannot exist.
|
||||
case "$PKG" in
|
||||
*.dev) candidates="$PKG ${PKG%.dev}" ;;
|
||||
*) candidates="$PKG.dev $PKG" ;;
|
||||
esac
|
||||
|
||||
for pkg in $candidates; do
|
||||
pid=$("$ADB" shell pidof "$pkg" 2>/dev/null | tr -d '\r' | awk '{print $1}')
|
||||
[ -n "$pid" ] && break
|
||||
done
|
||||
|
||||
[ -n "$pid" ] || die "neither $PKG.dev nor $PKG is running; launch it first"
|
||||
[ -n "$pid" ] || die "none of: $candidates is running; launch it first"
|
||||
|
||||
"$ADB" forward --remove-all >/dev/null 2>&1 || true
|
||||
"$ADB" forward "tcp:$CDP_PORT" "localabstract:webview_devtools_remote_$pid" >/dev/null \
|
||||
|
||||
Executable
+97
@@ -0,0 +1,97 @@
|
||||
#!/usr/bin/env bash
|
||||
#
|
||||
# Print the package id an APK actually declares — and, given --expect,
|
||||
# refuse when that is not the id the caller was about to act on.
|
||||
#
|
||||
# This exists because the identity is declared twice and nothing made
|
||||
# the two agree. `applicationId` in build/android/app/build.gradle is
|
||||
# what Gradle installs; `APP_ID` in build/android/Taskfile.yml was what
|
||||
# every adb-driven task uninstalled, launched and filtered. They differ
|
||||
# for a reason nobody has to get wrong: the debug buildType carries
|
||||
# `applicationIdSuffix ".dev"`, so a debug build is app.yellowjacket.dev
|
||||
# while the default was app.yellowjacket — the *release* id, and on a
|
||||
# real phone the released app with the user's library on it (#159).
|
||||
#
|
||||
# So the id is read back from the artifact rather than written down a
|
||||
# third time. The APK is the authority because the task that installs
|
||||
# it has just built it: whatever Gradle resolved the applicationId to,
|
||||
# suffixes and flavours included, is in the file, and no default can
|
||||
# disagree with it.
|
||||
#
|
||||
# Usage:
|
||||
# android-pkgid.sh <apk> [--expect <id>]
|
||||
#
|
||||
# Exit codes: 0 printed the id; 1 could not read it; 2 --expect failed.
|
||||
set -euo pipefail
|
||||
|
||||
die() { echo "android-pkgid: $*" >&2; exit 1; }
|
||||
|
||||
APK=""
|
||||
EXPECT=""
|
||||
while [ $# -gt 0 ]; do
|
||||
case "$1" in
|
||||
--expect) EXPECT="${2:-}"; shift 2 ;;
|
||||
-*) die "unknown option $1" ;;
|
||||
*) APK="$1"; shift ;;
|
||||
esac
|
||||
done
|
||||
|
||||
[ -n "$APK" ] || die "usage: android-pkgid.sh <apk> [--expect <id>]"
|
||||
[ -f "$APK" ] || die "no such APK: $APK"
|
||||
|
||||
# aapt2 lives under build-tools/<version>/, which is versioned, so it is
|
||||
# resolved rather than pinned. PATH first, so a system aapt2 (Arch ships
|
||||
# one) works without an SDK layout at all.
|
||||
find_aapt() {
|
||||
local sdk name
|
||||
for name in "$@"; do
|
||||
command -v "$name" 2>/dev/null && return 0
|
||||
done
|
||||
sdk="${ANDROID_HOME:-${ANDROID_SDK_ROOT:-$HOME/Android/Sdk}}"
|
||||
for name in "$@"; do
|
||||
ls "$sdk"/build-tools/*/"$name" 2>/dev/null | sort -V | tail -1 | grep . && return 0
|
||||
done
|
||||
return 1
|
||||
}
|
||||
|
||||
pkg=""
|
||||
|
||||
# `aapt2 dump packagename` answers in one word and is the cheapest of
|
||||
# the three. aapt1 is the fallback because it is what older build-tools
|
||||
# carry and what the issue's own measurement used.
|
||||
if AAPT2="$(find_aapt aapt2)"; then
|
||||
pkg="$("$AAPT2" dump packagename "$APK" 2>/dev/null | head -1 | tr -d '\r')" || true
|
||||
fi
|
||||
|
||||
if [ -z "$pkg" ] && AAPT="$(find_aapt aapt)"; then
|
||||
pkg="$("$AAPT" dump badging "$APK" 2>/dev/null |
|
||||
sed -n "s/^package: name='\([^']*\)'.*/\1/p" | head -1)" || true
|
||||
fi
|
||||
|
||||
# Guessing here is the bug this file exists to prevent, so an unreadable
|
||||
# APK is a hard failure and never a fallback to a written-down default.
|
||||
if [ -z "$pkg" ]; then
|
||||
die "could not read a package name from $APK.
|
||||
Install the SDK build-tools (aapt2), or set ANDROID_HOME to an SDK
|
||||
that carries them: sdkmanager 'build-tools;34.0.0'"
|
||||
fi
|
||||
|
||||
if [ -n "$EXPECT" ] && [ "$EXPECT" != "$pkg" ]; then
|
||||
cat >&2 <<EOF
|
||||
android-pkgid: refusing to act on a package this APK does not declare.
|
||||
|
||||
the APK declares: $pkg
|
||||
the task expects: $EXPECT
|
||||
APK: $APK
|
||||
|
||||
These must agree, and when they do not it is the *expectation* that is
|
||||
wrong: the APK is what Gradle built. A debug build carries
|
||||
applicationIdSuffix ".dev" (app/build.gradle), so a task that assembles
|
||||
a debug APK and then addresses the unsuffixed id is addressing the
|
||||
released app — which on a real device is the user's install, with their
|
||||
library in it (#159).
|
||||
EOF
|
||||
exit 2
|
||||
fi
|
||||
|
||||
printf '%s\n' "$pkg"
|
||||
Reference in New Issue
Block a user