mirror of
https://github.com/vitorpamplona/amethyst.git
synced 2026-10-30 07:37:38 +00:00
Claude
d0550695c0
StoreAccountSessionStore replaced the roster entry of a saved account with the transient one when the same npub logged in transiently (the login screen's temporary login, or the desktop's startup key), and the roster write drops transient entries, so the saved account fell out of the saved list on disk. The saved entry now stays on disk in the transient one's place (aTransientLoginOfASavedAccountKeepsItSaved reproduces it). Also from the audit of the startup login/sign-up: - A sign-up that throws at start no longer leaves the window on the loading screen: it logs and falls back to the saved account or the login screen. - run-headless.sh --login also refuses an uppercase NSEC1/NCRYPTSEC1 and a seed phrase, which the app reads as private keys. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NQ76C3JzYqA4GC4y2uUJXb
142 lines
8.4 KiB
Markdown
142 lines
8.4 KiB
Markdown
# desktop-run: launch and drive the desktop app headless
|
|
|
|
The desktop app renders the same shared UI (`AmethystApp`, `commonsUI`) as Android: the same screens,
|
|
navigation shell and feeds. A UI change that works on desktop has passed the shared code path, so
|
|
running the JVM build is the cheapest way to check a change for real when no Android device is
|
|
attached, for example in a cloud agent container. Compiling and unit tests do not catch a screen
|
|
that crashes on open, a missing string, or a layout that collapses.
|
|
|
|
Two pieces, both pure JDK plus Xvfb. No xdotool and no window manager needed:
|
|
|
|
- `run-headless.sh` starts Xvfb on `:99`, builds and runs `./gradlew :desktopApp:run` on a separate
|
|
profile, waits for the first paint and takes a screenshot. It fails with the log's errors when
|
|
the build fails, the JVM dies or nothing paints.
|
|
- `Drive.java` is a `java.awt.Robot` driver that takes screenshots, clicks, types, presses keys and
|
|
scrolls. Run it as a single-file program (`java Drive.java ...`) against the same `DISPLAY`.
|
|
|
|
## Loop
|
|
|
|
```bash
|
|
tools/desktop-run/run-headless.sh start --fresh # first build: many minutes; warm restart ~20 s
|
|
# look at /tmp/amethyst-desktop-run/shot.png (an agent: open it with its image-reading tool)
|
|
|
|
D="java tools/desktop-run/Drive.java"
|
|
export DISPLAY=:99
|
|
$D click 800 422 ";" type npub1sg6plzptd64u62a878hep2kev88swjh3tw00gjsfl8f237lmu63q0uf63m # see below
|
|
$D click 800 595 ";" sleep 8000 ";" shot /tmp/amethyst-desktop-run/feed.png
|
|
|
|
# or skip the login screen: open already logged in, or sign up a new account (see Accounts)
|
|
tools/desktop-run/run-headless.sh start --login npub1sg6plzptd64u62a878hep2kev88swjh3tw00gjsfl8f237lmu63q0uf63m
|
|
tools/desktop-run/run-headless.sh start --signup "Test Run"
|
|
|
|
tools/desktop-run/run-headless.sh logs # running?, exceptions first, then the tail
|
|
tools/desktop-run/run-headless.sh stop # ALWAYS before rebuilding (see Traps)
|
|
```
|
|
|
|
`start` without `--fresh` keeps the profile in `/tmp/amethyst-desktop-run/profile`, including the
|
|
logged-in account, so a restart after a code change lands directly on the feed.
|
|
|
|
## Drive.java commands
|
|
|
|
Join steps with a quoted `";"` to run them in one JVM (each JVM start costs about 1 s):
|
|
|
|
| Command | Does |
|
|
|---|---|
|
|
| `shot <file.png> [x y w h]` | Screenshot of the whole screen, or a region (zoom in on a detail) |
|
|
| `click x y`, `dclick x y`, `rclick x y`, `move x y` | Mouse, in screen pixels (= window pixels: no WM, so the window is undecorated) |
|
|
| `type <text...>` | Pastes the text through the clipboard + Ctrl+V. Works for any character and layout |
|
|
| `key <chord...>` | `enter`, `tab`, `escape`, `ctrl+k`, `ctrl+shift+n`, `f5`, `down`, `pagedown`, ... |
|
|
| `scroll x y n` | Mouse wheel at (x, y); positive `n` scrolls down |
|
|
| `sleep ms`, `waitpaint [ms]` | Wait; wait until the screen shows something drawn |
|
|
| `size` | Prints the screen size |
|
|
|
|
Read coordinates off the last screenshot. The screen is 1600x1000 by default. The window fills up
|
|
to 90% of it (at most 1380x920 dp), centred and undecorated, so screenshot pixels are the click
|
|
pixels. The screen size picks the `ScreenLayoutSpec` tier, so one run per size shows each shell. Use
|
|
a new display number, because a running Xvfb keeps its size:
|
|
|
|
```bash
|
|
tools/desktop-run/run-headless.sh start # wide: drawer + docked notifications
|
|
AMETHYST_DISPLAY=:98 AMETHYST_SCREEN=480x900x24 tools/desktop-run/run-headless.sh start # phone: bottom bar, as on Android
|
|
```
|
|
|
|
`start` drops the saved window bounds each time, so the window always fits the current screen.
|
|
|
|
## Accounts
|
|
|
|
`start` can skip the login screen, so the first screenshot is already the logged-in app:
|
|
|
|
| Option | Opens |
|
|
|---|---|
|
|
| `--login <key>` | Logged in with a public key: `npub`, `nprofile` or `name@domain` (read-only, never its NIP-46 signer) |
|
|
| `--login-file <path>` | Logged in with the key in that file, an `nsec` included |
|
|
| `--signup "<name>"` | A new account, signed up as the Sign Up button does (below) |
|
|
|
|
Pass at most one. `--login` refuses an `nsec`, an `ncryptsec`, a 64-character hex key (the app
|
|
reads that as a private key) and a seed phrase: arguments show in `ps` and in the shell history, so
|
|
a private key goes in a file. `--login-file` is read before `--fresh` clears the profile, so
|
|
`start --fresh --login-file /tmp/amethyst-desktop-run/profile/signup.nsec` works.
|
|
|
|
The login is transient: the key goes to no keyring, password file or account list, so no key prompt
|
|
appears and the profile's saved accounts are left as they were; the next `start` without an option
|
|
opens the saved account, or the login screen. A key that does not parse logs
|
|
`Could not log in with the startup key` and falls back the same way.
|
|
|
|
The options only set `AMETHYST_LOGIN` / `AMETHYST_SIGNUP`, which the app reads itself, so the same
|
|
variables work on a plain `./gradlew :desktopApp:run` (from the environment: `-Damethyst.login=`
|
|
also works there, but shows in `ps`, so keep it to public keys).
|
|
|
|
- **Read-only, preferred:** log in with any public `npub` (the one above is jack's). That loads real
|
|
feeds, profiles and notifications and cannot sign or publish anything.
|
|
- **Flows that sign** (posting, reacting, settings that publish lists): use a throwaway account from
|
|
the app's Sign Up, never a real key. They publish to real public relays, so do it only when the
|
|
human asked for that flow to be tested.
|
|
- **Sign up without the screen:** `start --signup "<display name>"` does what the Sign Up button
|
|
does with that name: a new key, Amethyst's default relays and lists published to public relays,
|
|
and the Import Follow List screen to start on. The account is transient like `--login` (no
|
|
password prompt), so its nsec is written to `profile/signup.nsec` (owner-only, replacing the last
|
|
sign-up's) and the log names the npub; reopen the same account later with
|
|
`start --login-file /tmp/amethyst-desktop-run/profile/signup.nsec`. It publishes, so the rule
|
|
above applies.
|
|
- The container has no OS keyring, so a key that is remembered goes to the NIP-49 password file.
|
|
The login screen says so, and that is expected here.
|
|
|
|
## Expected noise (not your bug)
|
|
|
|
- `Can't play this video ... Failed to create native player`: no native media engine in the
|
|
container.
|
|
- `[MediaHttp] ... error=...` / relay `stalled` lines: the network, not the UI.
|
|
- `No OS keyring; keys go to the password file`: see above.
|
|
- A screenshot taken while the UI is moving (a feed filling, a bar sliding in) can show overlapping
|
|
text for one frame. Take another before calling it a rendering bug.
|
|
|
|
## Traps
|
|
|
|
- **Stop before rebuilding shared modules.** A Gradle build rewrites the jars the running app
|
|
loaded, and it dies with `NoClassDefFoundError`. `stop`, build or edit, `start`.
|
|
- **Never `pkill -f AmethystDesktopKt` from an agent shell.** The pattern also matches the shell
|
|
whose own command line contains it, and kills your tool call (exit 144). `run-headless.sh stop`
|
|
anchors the match on the java binary.
|
|
- **Tor never starts in a sandboxed container, and by default DM and untrusted relays wait for
|
|
it.** Tor needs direct TCP to its guard relays; a container that only lets traffic out through
|
|
an HTTPS proxy never gets a SOCKS port, so every Tor-routed relay is held back with nothing in
|
|
the log. For an account whose outbox is also its DM relay, its own lists (follows, emoji, mutes)
|
|
then never load and its publishes never leave, while clearnet relays work and hide the problem.
|
|
The tell is the drawer's `Relays 1/11`. Before testing a signing account, open the onion icon
|
|
next to the version at the bottom of the drawer and set the Tor engine to **Off**; the choice is
|
|
saved in the run's profile, so it survives `stop`/`start`.
|
|
- A dependency resolution `429 Too Many Requests` from Maven Central is a rate limit. Re-run
|
|
`start`.
|
|
- `start` gives up after `AMETHYST_START_TIMEOUT` seconds (default 900). Raise it for a first cold
|
|
build on a slow machine.
|
|
- `AMETHYST_RUN_ARGS` passes extra Gradle arguments to the run, e.g. the updater's development
|
|
switches: `AMETHYST_RUN_ARGS="-Damethyst.update.devCheck=true -Damethyst.update.pretendVersion=1.0.0"`
|
|
checks for updates five seconds after start, as if version 1.0.0 were running.
|
|
|
|
## Automated alternative
|
|
|
|
For a check that should keep passing, write a Compose UI test instead
|
|
(`createComposeRule()`, see `desktopApp/src/jvmTest/.../desktop/ui/BlockInteractionsUiTest.kt`) and
|
|
run `xvfb-run --auto-servernum ./gradlew :desktopApp:test`, which is what
|
|
`.github/workflows/smoke-test-desktop.yml` does in CI.
|