Files
jellytau/scripts
dtourolle 11d9d760d8 feat(player): native video on Linux, and one contract for every player (v0.11.0)
mpv now decodes video on Linux, drawn into a framebuffer we own and blitted
into the default vbox's draw handler. Tauri's widget tree is untouched, so an
upgrade that assumes its own layout cannot invalidate this. Direct play means
the original file, hardware decoding, and no server transcode at all — where
previously every desktop video was re-encoded to h264 for the browser engine,
whatever the file actually was. Off by default: JELLYTAU_NATIVE_VIDEO=1.

That settles finding 2 of playback-backend-unification.md — "native video
cannot be composited with a Tauri webview" — by demonstration rather than
argument, on X11 and Wayland both.

Turning it on exposed nine defects, none of them mpv's. Each was the same
mistake in a different place: a capability written down as a compile-time fact
about the platform, or a state asserted instead of confirmed.

  DR-238/246  a seek routed by the stream's container rather than by what the
              engine could do with it - correct only while one player handled
              those streams, silent the moment another did
  DR-239      a property handled but never observed, so the play/pause button
              waited for an event that could not arrive
  DR-240      fullscreen expanding the document while the window stayed put
  DR-241      a seek issued before the engine had a file, failed, and discarded
              - which is why resume began at zero
  DR-247      a Linux-only gate outliving the caller that made it Linux-only,
              breaking the Android build outright
  DR-250      a stop aimed at whichever renderer bookkeeping believed was in
              charge, missing the one actually making sound
  DR-251      a duration of zero believed, leaving the seek bar no scale
  DR-252      a junk float converted to a Duration, panicking the backend the
              instant a length-less stream appeared

So the MediaPlayer contract (DR-242 … DR-247): `open` carries a start position,
so no caller sequences load-then-seek and none can race an engine's load;
`seek` states a destination and leaves in-place-versus-re-open to the engine;
`snapshot` is one coherent read; and `Phase::Opening` names the window where
intent used to be lost. One conformance suite runs against every engine —
FakePlayer and mpv under cargo test, ExoPlayer instrumented on a device — so an
engine is either correct or visibly failing.

Two of the nine were introduced during this work and caught on hardware, not by
any suite: an over-broad capability that grouped ExoPlayer with mpv, and the
Duration panic. The suites test engines that behave. That is recorded in
docs/native-player-verification.md, which asks for the exact action sequences
that found them.

Verified: all automated gates, conformance (mpv 9/9, legacy 8/9 by design,
ExoPlayer 7/7 on device), and manual desktop and Android passes on real
hardware.

Known open and deliberately shipped: resume reads local progress and never the
server's; the background-audio handoff still declares a state swap it does not
confirm (the symptom is now impossible, the race is not); and `bun run
android:dev` builds an APK carrying the release application id, whose failure
message advises an uninstall that would destroy app data. Fix that last one
before anyone else builds for Android.

Squashed from worktree-linux-native-video, which keeps the per-defect history.
2026-08-23 10:51:45 +02:00
..
2026-01-26 22:21:54 +01:00
2026-01-26 22:21:54 +01:00
2026-01-26 22:21:54 +01:00

Development Scripts

Collection of utility scripts for building, testing, and deploying JellyTau.

Testing Scripts

test-all.sh

Run all tests (frontend + Rust backend).

./scripts/test-all.sh

test-frontend.sh

Run frontend tests only.

./scripts/test-frontend.sh          # Single pass (same as `bun run test`)
./scripts/test-frontend.sh --watch  # Watch mode
./scripts/test-frontend.sh --ui     # Open UI

bun run test is vitest run — one pass, exit code, done. It used to be bare vitest, which parked in watch mode; CLAUDE.md's "Before Committing" list tells people to run it, so it had to terminate. The interactive modes moved to their own entry points:

Command Runs
bun run test vitest run — single pass
bun run test:watch vitest — watch mode
bun run test:ui vitest --ui
bun run test:coverage vitest run --coverage

test-frontend.sh forwards any extra arguments to vitest and switches to the long-running form automatically when it sees --watch, -w, or --ui.

test-rust.sh

Run Rust tests only.

./scripts/test-rust.sh              # Run all tests
./scripts/test-rust.sh -- --nocapture  # Show println! output

Android Scripts

build-android.sh

Build the Android APK.

./scripts/build-android.sh          # Debug build
./scripts/build-android.sh release  # Release build

deploy-android.sh

Install APK on connected Android device.

./scripts/deploy-android.sh         # Deploy debug APK
./scripts/deploy-android.sh release # Deploy release APK

build-and-deploy.sh

Build and deploy in one command.

./scripts/build-and-deploy.sh       # Build + deploy debug
./scripts/build-and-deploy.sh release  # Build + deploy release

check-android.sh

Check Android development environment setup.

./scripts/check-android.sh

logcat.sh

View Android logcat filtered for the app.

./scripts/logcat.sh

Traceability & Documentation

extract-traces.ts

Extract requirement IDs (TRACES) from source code and generate a traceability matrix mapping requirements to implementation locations.

bun run traces                    # Generate markdown report
bun run traces:json              # Generate JSON report
bun run traces:markdown           # Save to docs/traceability.md
bun run traces:coverage           # Coverage gate — exits non-zero below the ratchet
bun run traces:validate           # Dangling-ID gate — every traced ID must be defined

The script scans all TypeScript, Svelte, and Rust files (plus scripts/) looking for TRACES: comments and generates a comprehensive mapping of:

  • Which code files implement which requirements
  • Line numbers and code context
  • Coverage summary by requirement type (UR, IR, DR, JA)

bun run traces:coverage is the supported way to check requirement coverage locally — it runs the same computation CI does. Coverage denominators are derived from docs/requirements.md at run time; they are never hardcoded. An ID that appears in a TRACES: comment but is not defined in requirements.md is reported as orphaned and does not count toward coverage (see DR-093).

bun run traces:validate is the dangling-ID gate. It fails if any traced ID — including UT/IT, which coverage deliberately ignores — is not defined as a table row in requirements.md, printing each offender with the files that reference it. Without it the extractor accepted any well-formed ID silently, so typos and renames that missed a call site went unreported for months.

Removed: check-req-coverage.sh, check-test-coverage.sh, and find-req-implementations.sh were deleted in July 2026. They read an undocumented @req: tag convention parallel to TRACES:, grepped src-tauri/ unscoped (hanging on ~40 GB of target/ artifacts), and in one case reported "all requirements implemented" from an empty result set. extract-traces.ts is the single source of truth for requirement coverage. See it reported Total Requirements: 1 and then "All requirements have implementations!". Nothing referenced it. Use bun run traces:coverage.

Example TRACES comment in code:

// TRACES: UR-005, UR-026 | DR-029
function handlePlayback() { ... }

See docs/traceability.md for the latest generated mapping.

CI/CD Validation

The traceability system is integrated with Gitea Actions CI/CD:

  • Automatically validates TRACES on every push and pull request
  • Enforces a minimum coverage threshold (a ratchet: raise it, never lower it)
  • Fails on dangling IDs — traced but undefined in requirements.md
  • Warns if new code lacks TRACES comments
  • Generates traceability reports automatically

For details, see:

Linting & Formatting

There is no script wrapper for these — they are plain package.json entries:

bun run lint          # eslint .
bun run lint:fix      # eslint . --fix
bun run format        # prettier --write .
bun run format:check  # prettier --check .

Config lives in eslint.config.js (flat config: typescript-eslint + eslint-plugin-svelte, tuned for Svelte 5 and TS strict), .prettierrc, and .prettierignore. src/lib/api/bindings.ts is excluded from both — it is generated by tauri-specta on every Rust build.

bun run lint is currently error-clean but not warning-clean: several rules are deliberately set to warn because the existing tree has more hits than a tooling change should touch (unused bindings, any at the IPC boundary, unkeyed {#each}). Each one is annotated in eslint.config.js with why, and the intended end state is error. Drive them down; do not delete them.

no-console is switched off for now — see the note in eslint.config.js.

Git Hooks

install-hooks.sh

Point git at the repo's tracked hooks directory (core.hooksPath).

bun run hooks:install      # or: ./scripts/install-hooks.sh

hooks/pre-commit

Runs the fast half of CLAUDE.md's "Before Committing" list so it is enforced rather than remembered:

  • bun run check (svelte-check)
  • bun run test (vitest, single pass)
  • scripts/check-frontend-boundary.sh
  • cargo fmt --all -- --check, only when staged files touch src-tauri/

cargo clippy and cargo test are deliberately not in the hook — minutes per commit is how you teach people to reach for --no-verify. They run in CI, and locally via bun run test:all.

git commit --no-verify     # skip the hook for one commit
git config --unset core.hooksPath   # uninstall

The hook skips itself during a merge, rebase, or cherry-pick, and when nothing is staged.

Utility Scripts

clean.sh

Clean all build artifacts.

./scripts/clean.sh

NPM Script Aliases

You can also run these via npm/bun:

bun run test               # Frontend tests (single pass)
bun run test:all           # All tests
bun run test:rust          # Rust tests
bun run lint               # ESLint
bun run format:check       # Prettier (check only)
bun run hooks:install      # Install the git hooks
bun run android:build      # Build Android APK
bun run android:deploy     # Deploy to device
bun run android:dev        # Build + deploy debug
bun run android:check      # Check environment
bun run clean              # Clean artifacts