steam-frame/saphid--frame-control
1
0 Fork 0
mirror of https://github.com/saphid/frame-control.git synced 2026-10-06 09:00:35 +02:00
Code Issues Packages Projects Releases 6 Wiki Activity

Analytics, self-update and Report a problem

Browse Source 
- Anonymous PostHog analytics (ui/frame_telemetry.py): usage on by default
  after a first-run notice; compatibility results and error details opt-in,
  offered together by the notice's "Share more to help fix problems" button.
  Random id, no person profiles or GeoIP, scrubbed text, an offline outbox,
  and "Show what's been sent" in the new Privacy panel. Inert without a
  project key, from a source checkout, or with DO_NOT_TRACK=1.
- APK installs now record install_failed when the APK itself won't install,
  and offer a 20-second test after installing. Opted-in reports reach the
  shared database through PostHog and `frame_compat_db.py sync`.
- The desktop app updates itself from published releases (app/updater.js):
  update.json from releases/latest/download, SHA-256 checked, no downgrades;
  macOS bundle swap, Windows NSIS, Linux AppImage, otherwise the release page.
  scripts/publish-release.sh publishes a tested draft with its manifest.
- Report a problem (header button, Privacy panel, Help menu) files a GitHub
  issue through the website's feedback API, with a previewed, scrubbed
  diagnostics snapshot; activity and logs only when asked for.

Reviewed by GPT-6 Astra (xhigh, read-only) three times; all findings fixed.
Docs: docs/privacy.md, docs/releasing.md.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
This commit is contained in:
saphidandClaude Opus 5.5 committed 2026-09-28 17:34:21 +10:00
1 parent 10f96656e3
commit 9eeca79b5d
21 files changed
+2326 -47
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

ui/server.py
+95 -8
View File
@@ -36,7 +36,9 @@ sys.path.insert(0, str(Path(__file__).resolve().parent))
import frame_android # noqa: E402
import frame_catalog # noqa: E402
import frame_host # noqa: E402
import frame_report # noqa: E402
import frame_store # noqa: E402
import frame_telemetry # noqa: E402
import frame_titles # noqa: E402
import frame_webinstall # noqa: E402
@@ -153,7 +155,12 @@ def terminal(argv):
# ---- actions ---------------------------------------------------------------
def status(_body):
return json.loads(ssh("python3 -", stdin=(HERE / "frame_status.py").read_text(), timeout=20))
s = json.loads(ssh("python3 -", stdin=(HERE / "frame_status.py").read_text(), timeout=20))
osr = s.get("os") if isinstance(s, dict) else None
if isinstance(osr, dict):
frame_telemetry.frame_seen(osr.get("build"), osr.get("version"))
frame_report.frame.update(build=osr.get("build"), version=osr.get("version"))
return s
def headset_view():
@@ -335,7 +342,16 @@ def steam(body):
raise Failure("bad appid", 400)
if action not in ("install", "store"):
raise Failure("action must be install or store", 400)
return steam_frame(action, appid)
if action == "store":
return steam_frame(action, appid)
# Starts Steam's download; Steam reports the rest in the headset.
try:
res = steam_frame(action, appid)
except Failure as e:
frame_telemetry.install_finished("steam", False, error=e, steam_appid=appid)
raise
frame_telemetry.install_finished("steam", True, steam_appid=appid)
return res
def steam_search(query):
@@ -408,10 +424,16 @@ def flatpak(body):
if not FLATPAK_ID.match(app):
raise Failure("bad Flatpak app ID", 400)
if action == "install":
# Per-user, so it survives SteamOS updates and needs no sudo (as install-apps.sh).
ssh("flatpak remote-add --user --if-not-exists flathub "
"https://dl.flathub.org/repo/flathub.flatpakrepo && "
f"flatpak install --user -y --noninteractive flathub {shlex.quote(app)}", timeout=900)
start = time.time()
try:
# Per-user, so it survives SteamOS updates and needs no sudo (as install-apps.sh).
ssh("flatpak remote-add --user --if-not-exists flathub "
"https://dl.flathub.org/repo/flathub.flatpakrepo && "
f"flatpak install --user -y --noninteractive flathub {shlex.quote(app)}", timeout=900)
except Failure as e:
frame_telemetry.install_finished("flatpak", False, time.time() - start, e, flatpak_id=app)
raise
frame_telemetry.install_finished("flatpak", True, time.time() - start, flatpak_id=app)
return {"message": f"Installed {app}"}
if action == "uninstall":
out = ssh(f"flatpak uninstall --user -y -- {shlex.quote(app)}", timeout=300)
@@ -468,13 +490,37 @@ def android(body):
runtime=body.get("runtime") or "instance",
label=body.get("label"), source=body.get("source"))
name = r.get("label") or pkg
where = "" if frame_catalog.compat_db.shared() else " on this computer"
where = ("" if frame_catalog.compat_db.shared() else
" and shared it" if frame_telemetry.enabled("compat") else " on this computer")
return {"message": f"Saved your report for {name}{where}", "report": r}
except frame_android.FrameError as e:
raise Failure(str(e))
raise Failure("unknown action", 400)
# Errors that are the APK's own fault, so they belong in the compatibility
# database as install_failed. Connection trouble and the like don't.
APK_FAULTS = {"android_installer", "apk_needs_newer_android", "apk_wrong_abi"}
def apk_installed(info, meta, error, seconds):
"""Every APK install (catalogue, dropped file, web link): usage analytics, and an
install_failed report when the APK itself wouldn't install."""
pkg = (info or {}).get("package")
by_pkg = frame_catalog._cache.get("by_pkg") or {}
in_catalog = bool(pkg) and pkg in by_pkg
# Package names only for catalogue apps, which are public; a private APK's name stays here.
# No version: a local rebuild can share a catalogue app's package name but carry anything in its version.
frame_telemetry.install_finished("apk", error is None, seconds, error, catalog=in_catalog,
package=pkg if in_catalog else None)
if error is not None and pkg and frame_telemetry.categorize(error)[0] in APK_FAULTS:
frame_catalog.add_report(pkg, info.get("version"), result="install_failed", notes=str(error)[:300],
via="install", label=info.get("label"))
frame_android.install_hooks.append(apk_installed)
# ---- Sideloaded titles (Linux/Windows builds as Steam Devkit Games) --------
#
# Installing is two steps: inspect (a dropped file is uploaded and a zip
@@ -528,14 +574,18 @@ def _run_title_install(token, entry, name, exe, runtime):
with _titles_lock:
_title_jobs[token].update(fields)
start = time.time()
try:
m = frame_titles.install_plan(entry["plan"], name=name, exe=exe, runtime=runtime,
progress=lambda stage, fraction: update(stage=stage, fraction=fraction))
update(title=m, message=f"Installed {m['id']} in the Steam library ({m['runtime_label']})")
frame_telemetry.install_finished("title", True, time.time() - start, runtime=m.get("runtime"))
except frame_android.FrameError as e:
update(error=str(e))
frame_telemetry.install_finished("title", False, time.time() - start, e)
except Exception as e:
update(error=f"{type(e).__name__}: {e}")
frame_telemetry.install_finished("title", False, time.time() - start, e)
finally:
_drop_staged(entry)
update(done=True, time=time.time())
@@ -964,10 +1014,16 @@ def _webinstall_run(plan, job):
ensure_master()
res = frame_webinstall.dispatch(path, name=plan["name"], exe=plan["exe"], progress=detail, source=plan["url"])
job["message"], job["phase"] = res["message"], "done"
if res.get("kind") != "apk": # APKs are counted by apk_installed
frame_telemetry.install_finished("web", True, kind_detail=res.get("kind"))
except Exception as e:
stage = job.get("phase") # download or install, before it becomes "error"
known = (frame_webinstall.WebInstallError, Failure, frame_android.FrameError)
job["error"] = str(e) if isinstance(e, known) else f"{type(e).__name__}: {e}"
job["phase"] = "error"
# An APK that failed to install was counted by apk_installed.
if not isinstance(e, frame_webinstall.Cancelled) and not (stage == "install" and plan.get("kind") == "apk"):
frame_telemetry.install_finished("web", False, error=e, stage=stage, kind_detail=plan.get("kind"))
finally:
with _web_lock:
job.pop("_conn", None)
@@ -1066,14 +1122,36 @@ def _sweep_one(prefix, d):
pass
# ---- Report a problem (frame_report.py) --------------------------------------
def report_preview(body):
"""Exactly the diagnostics a report would include, for the dialog to show first."""
return {"text": frame_report.diagnostics(body.get("activity") or (), include_logs=bool(body.get("includeLogs")))}
def report_send(body):
try:
return frame_report.send(body)
except frame_report.ReportError as e:
raise Failure(str(e))
POST = {"/api/android/display": android_display, "/api/android": android, "/api/titles": titles, "/api/launch": launch, "/api/steam": steam, "/api/volume": set_volume, "/api/clipboard": clipboard,
"/api/flatpak": flatpak, "/api/open": open_thing, "/api/shots/save": save_shots,
"/api/webinstall/check": webinstall_check, "/api/webinstall/start": webinstall_start,
"/api/webinstall/cancel": webinstall_cancel}
"/api/webinstall/cancel": webinstall_cancel,
"/api/telemetry": frame_telemetry.update_settings, "/api/telemetry/event": frame_telemetry.page_event,
"/api/report/preview": report_preview, "/api/report": report_send}
# ---- HTTP ------------------------------------------------------------------
def action_of(body):
"""The action a request asked for, for diagnostics: a short word, never user data."""
a = body.get("action") if isinstance(body, dict) else None
return a if isinstance(a, str) and re.fullmatch(r"[a-z]{1,20}", a) else ""
def _pipe_reader(pipe):
"""Chunks from a pipe via a thread; select() can't wait on pipes on Windows."""
chunks = queue.Queue() # unbounded: the pump never blocks, so it ends at EOF
@@ -1182,6 +1260,8 @@ class Handler(BaseHTTPRequestHandler):
"shared": frame_catalog.compat_db.shared()})
elif path == "/api/android/catalog":
self.send_json({"apps": frame_catalog.catalog()})
elif path == "/api/telemetry":
self.send_json(frame_telemetry.state())
elif path == "/api/status":
self.send_json(status({}))
elif path == "/api/steam/owned":
@@ -1208,12 +1288,14 @@ class Handler(BaseHTTPRequestHandler):
except frame_android.FrameError as e:
self.send_json({"error": str(e)}, 502)
except Exception as e:
frame_telemetry.diagnostic(f"GET {path}", e)
self.send_json({"error": f"{type(e).__name__}: {e}"}, 500)
def do_POST(self):
if not self.local_request():
return
path = urlparse(self.path).path
body = None
try:
if path == "/api/upload":
self.send_json(self.upload())
@@ -1230,12 +1312,16 @@ class Handler(BaseHTTPRequestHandler):
raise Failure("request body must be a JSON object", 400)
self.send_json(handler(body))
except Failure as e:
if e.status >= 500:
frame_telemetry.diagnostic(f"POST {path} {action_of(body)}", e)
self.send_json({"error": str(e)}, e.status)
except (ValueError, TypeError) as e:
self.send_json({"error": f"bad request: {e}"}, 400)
except frame_android.FrameError as e:
frame_telemetry.diagnostic(f"POST {path} {action_of(body)}", e)
self.send_json({"error": str(e)}, 502)
except Exception as e:
frame_telemetry.diagnostic(f"POST {path} {action_of(body)}", e)
self.send_json({"error": f"{type(e).__name__}: {e}"}, 500)
def stream_video(self, query):
@@ -1356,6 +1442,7 @@ def main():
args = ap.parse_args()
httpd = ThreadingHTTPServer(("127.0.0.1", args.port), Handler)
sweep_tmp()
frame_telemetry.start()
if not frame_host.WINDOWS:
signal.signal(signal.SIGTERM, lambda *_: (_ for _ in ()).throw(KeyboardInterrupt))
if args.exit_on_eof: