Upload a local run's report (simulator, emulator, device): the CLI side

Aperta
#442 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
flutter, go
Ambito
cli, testing

Direzione di ricerca

Start at the probe test --upload-report CLI path, then read hosted.CIFromEnv and hosted.Preflight, which the issue names as the current blockers. The requested work spans local Git and device facts, run sequencing, optional key enrollment, and updates to MCP descriptions, CLI and configuration docs, VS Code surfaces, and the changelog; the dirty-tree hash and keychain behavior are still open questions. Done means the acceptance criteria pass and all existing flags, report JSON, and envelope schema remain compatible.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

area/cli area/cloud enhancement

What this is

Today probe test --upload-report only works inside GitHub Actions: hosted.CIFromEnv returns nothing elsewhere and hosted.Preflight refuses a payload without CI facts ("only --upload-dry-run works outside CI"). A developer who runs the suite on a local simulator, emulator or device has no way to send that run's report. This issue describes only what the CLI would need. No code yet; how a service treats such a run is out of scope here.

What the CLI would need

  1. A local mode. An explicit opt-in (probe test --upload-local or hosted.mode: local), never implied by --upload-report. The envelope says ci.provider: "local" (an additive value); everything stays optional and the report JSON and its schema value do not change. --upload-dry-run prints every field, as today.
  2. Git facts without CI variables. Commit (git rev-parse HEAD), branch (or HEAD when detached), and a dirty-tree flag plus a hash of the working tree so a run on uncommitted changes is never labelled as "the result of commit C". The hash definition must be stable across platforms and cheap on large repositories (open question: git stash create versus a hash of git diff HEAD plus untracked files).
  3. Device identity without personal identifiers. device_class and the platform/OS version already exist; add a short model string. Never a serial number or UDID, which identify a person's hardware.
  4. A run sequence. Outside CI there is no run id, so the client makes a monotonic one (for example milliseconds since the epoch plus a per-key counter) and a run_attempt of 1.
  5. Signer key enrolment (optional, later). An Ed25519 key generated on the developer's machine and stored in the OS keychain (macOS, Linux and Windows differ), enrolled once through a documented command (probe cloud enrol), with the envelope signed over its canonical bytes. The envelope carries only the key fingerprint (16 hex characters). No name or email goes into the envelope.
  6. Scrubbing and size limits are unchanged: relative paths, secret patterns, no artifacts, the 1 MiB / 5,000-result caps, retries on a busy service.

Constraints

  • Additive only: existing flags, config, the report JSON and the envelope schema keep working.
  • Nothing is sent unless the user opts in, and the docs state the hosted service is a preview and not live yet.
  • Any new flag or config key also updates the MCP descriptions, the CLI reference, the configuration page, the VS Code surfaces and the CHANGELOG.

Acceptance criteria (for a later implementation PR)

  • Tests: a local run builds an envelope with the git facts; a dirty tree sets the flag and the tree hash; a detached HEAD gives HEAD; a repository without commits and a non-git directory give a clear refusal, never a half-filled envelope.
  • No serial, UDID, user name, e-mail address or absolute path appears in the dry-run output.
  • Key custody: the private key never leaves the keychain, is never printed or logged, and signing fails closed when the keychain is unavailable.

Open questions

  • The dirty-tree hash definition (see 2).
  • Keychain access on each OS and a fallback for headless machines.
  • Whether the sequence needs a hash of the previous envelope so that a missing or reordered run is detectable on the client side.
Lingua principale
Go
Stelle
6
Fork
3
Merge medio
6h 28m
PR unite (30g)
362

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di AlphaWaveSystems/flutter-probe

Tutte le issue di AlphaWaveSystems/flutter-probe

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.