feat(diagnostics): A.3 — redacted in-memory log sink + user-initiated export

Replaces the diagnostics scaffold with the production redaction policy + a user-initiated export path that satisfies DEC-016 (no automatic uploads). * `chanora_diagnostics::Redactor` applies the six policy rules to every captured log line: `$HOME` paths → `[home]`; IPv4 + IPv6 literals → `[ip]`; email-shaped strings → `[email]`; long base64-ish tokens → `[token]`; substrings registered with `KnownSecretRegistry` → `[REDACTED]`. The registry implements SS-AUD-003 defence-in-depth: storage adapters can register secrets as they cross out of the keyring so an accidental `Debug` print is still scrubbed at write time. * `InMemoryLogSink` is a bounded ring buffer (cap 500 lines in the bridge) that always passes lines through the redactor before storing them. `RedactingLogLayer` plugs it into `tracing- subscriber` alongside the existing logcat / fmt layers. * `DiagnosticExport::from_sink` builds a plaintext blob — already redacted — combining free-form metadata (crate version, target os/arch) with the retained log tail. `bridge::api:: export_diagnostics()` is the Flutter-facing entrypoint (`#[frb(sync)]`). * `bridge_init` now installs the redaction layer on both Android and desktop hosts, switching from the global `fmt::init()` shortcut to a layered `Registry` so the in-memory sink can sit side-by-side with the platform sink. * Flutter adds a bug-report icon to the AppBar; tapping it opens a scrollable monospace dialog with Copy and Close actions. New `diagnosticsAction` / `copyAction` / `closeAction` strings land in `app_en.arb` + `app_zh.arb`. Tests cover the redaction matrix (IPv4, IPv6, email, long tokens, known secret), the ring buffer capacity, and the full `DiagnosticExport::to_text()` round-trip — 9/9 green. Live-verified on Moto G: the dialog rendered a multi-line transcript with `[ip]`, `[token]`, `[home]` substitutions, the metadata block showed `target_os=android` `target_arch=aarch64`, and Copy placed the same text on the clipboard.
2026-05-15 01:26:49 +08:00
parent 71ecb83781
commit d2d9ba0a5b
14 changed files with 737 additions and 32 deletions
@@ -12,6 +12,9 @@
  "connectAction": "Connect",
  "disconnectAction": "Disconnect",
  "refreshAction": "Refresh",
+  "diagnosticsAction": "Diagnostics",
+  "copyAction": "Copy",
+  "closeAction": "Close",
  "startAudioAction": "Start audio",
  "pttHoldToTalk": "Hold to talk",
  "pttTransmitting": "Transmitting…",
@@ -11,6 +11,9 @@
  "connectAction": "连接",
  "disconnectAction": "断开连接",
  "refreshAction": "刷新",
+  "diagnosticsAction": "诊断信息",
+  "copyAction": "复制",
+  "closeAction": "关闭",
  "startAudioAction": "启动语音",
  "pttHoldToTalk": "按住说话",
  "pttTransmitting": "正在发送…",
@@ -139,6 +139,24 @@ abstract class AppL10n {
  /// **'Refresh'**
  String get refreshAction;

+  /// No description provided for @diagnosticsAction.
+  ///
+  /// In en, this message translates to:
+  /// **'Diagnostics'**
+  String get diagnosticsAction;
+
+  /// No description provided for @copyAction.
+  ///
+  /// In en, this message translates to:
+  /// **'Copy'**
+  String get copyAction;
+
+  /// No description provided for @closeAction.
+  ///
+  /// In en, this message translates to:
+  /// **'Close'**
+  String get closeAction;
+
  /// No description provided for @startAudioAction.
  ///
  /// In en, this message translates to:
@@ -30,6 +30,15 @@ class AppL10nEn extends AppL10n {
  @override
  String get refreshAction => 'Refresh';

+  @override
+  String get diagnosticsAction => 'Diagnostics';
+
+  @override
+  String get copyAction => 'Copy';
+
+  @override
+  String get closeAction => 'Close';
+
  @override
  String get startAudioAction => 'Start audio';

@@ -29,6 +29,15 @@ class AppL10nZh extends AppL10n {
  @override
  String get refreshAction => '刷新';

+  @override
+  String get diagnosticsAction => '诊断信息';
+
+  @override
+  String get copyAction => '复制';
+
+  @override
+  String get closeAction => '关闭';
+
  @override
  String get startAudioAction => '启动语音';

@@ -13,6 +13,7 @@ import 'dart:async';

 import 'package:connectivity_plus/connectivity_plus.dart';
 import 'package:flutter/material.dart';
+import 'package:flutter/services.dart';
 import 'package:path_provider/path_provider.dart';

 import 'l10n/generated/app_localizations.dart';
@@ -245,6 +246,40 @@ class _BetaHomeState extends State<_BetaHome> {
    });
  }

+  Future<void> _onShowDiagnostics(BuildContext context) async {
+    // A.3: user-initiated diagnostic export (DEC-016). Content is
+    // already redacted on the Rust side; we just present it.
+    final l10n = AppL10n.of(context);
+    final text = rust.exportDiagnostics();
+    if (!mounted) return;
+    await showDialog<void>(
+      context: context,
+      builder: (ctx) => AlertDialog(
+        title: Text(l10n.diagnosticsAction),
+        content: SingleChildScrollView(
+          child: SelectableText(
+            text,
+            style: const TextStyle(fontFamily: 'monospace', fontSize: 11),
+          ),
+        ),
+        actions: [
+          TextButton(
+            onPressed: () async {
+              await Clipboard.setData(ClipboardData(text: text));
+              if (!ctx.mounted) return;
+              Navigator.of(ctx).pop();
+            },
+            child: Text(l10n.copyAction),
+          ),
+          TextButton(
+            onPressed: () => Navigator.of(ctx).pop(),
+            child: Text(l10n.closeAction),
+          ),
+        ],
+      ),
+    );
+  }
+
  @override
  Widget build(BuildContext context) {
    final l10n = AppL10n.of(context);
@@ -265,6 +300,11 @@ class _BetaHomeState extends State<_BetaHome> {
      appBar: AppBar(
        title: Text(l10n.appTitle),
        actions: [
+          IconButton(
+            tooltip: l10n.diagnosticsAction,
+            icon: const Icon(Icons.bug_report_outlined),
+            onPressed: () => _onShowDiagnostics(context),
+          ),
          if (_phase == _Phase.connected) ...[
            IconButton(
              tooltip: l10n.refreshAction,
@@ -9,7 +9,7 @@ import 'package:flutter_rust_bridge/flutter_rust_bridge_for_generated.dart';
 import 'package:freezed_annotation/freezed_annotation.dart' hide protected;
 part 'api.freezed.dart';

-// These functions are ignored because they are not marked as `pub`: `runtime`, `session`
+// These functions are ignored because they are not marked as `pub`: `log_sink`, `runtime`, `session`
 // These function are ignored because they are on traits that is not defined in current crate (put an empty `#[frb]` on it to unignore): `clone`, `clone`, `clone`, `clone`, `clone`, `clone`, `fmt`, `fmt`, `fmt`, `fmt`, `fmt`, `fmt`, `from`, `from`, `from`

 /// Connect to a TeamSpeak-compatible server and return the initial
@@ -37,6 +37,12 @@ Future<void> startAudio() => RustLib.instance.api.crateApiStartAudio();
 Future<void> setPtt({required bool active}) =>
    RustLib.instance.api.crateApiSetPtt(active: active);

+/// User-initiated diagnostic export. Returns a multi-line text
+/// blob, redacted per the production policy, that the user can
+/// share or copy. DEC-016 forbids automatic uploads — this is the
+/// only path that surfaces logs.
+String exportDiagnostics() => RustLib.instance.api.crateApiExportDiagnostics();
+
 /// Wire the identity persistence store to a platform-private
 /// directory. Should be called once on app start after Flutter has
 /// resolved `getApplicationSupportDirectory()` (or equivalent).
@@ -67,7 +67,7 @@ class RustLib extends BaseEntrypoint<RustLibApi, RustLibApiImpl, RustLibWire> {
  String get codegenVersion => '2.12.0';

  @override
-  int get rustContentHash => 1702138901;
+  int get rustContentHash => 2126340080;

  static const kDefaultExternalLibraryLoaderConfig =
      ExternalLibraryLoaderConfig(
@@ -92,6 +92,8 @@ abstract class RustLibApi extends BaseApi {

  Stream<BridgeEvent> crateApiEventsStream();

+  String crateApiExportDiagnostics();
+
  Future<void> crateApiInitStorage({required String dir});

  Future<bool> crateApiIsConnected();
@@ -258,6 +260,28 @@ class RustLibApiImpl extends RustLibApiImplPlatform implements RustLibApi {
  TaskConstMeta get kCrateApiEventsStreamConstMeta =>
      const TaskConstMeta(debugName: "events_stream", argNames: ["sink"]);

+  @override
+  String crateApiExportDiagnostics() {
+    return handler.executeSync(
+      SyncTask(
+        callFfi: () {
+          final serializer = SseSerializer(generalizedFrbRustBinding);
+          return pdeCallFfi(generalizedFrbRustBinding, serializer, funcId: 6)!;
+        },
+        codec: SseCodec(
+          decodeSuccessData: sse_decode_String,
+          decodeErrorData: null,
+        ),
+        constMeta: kCrateApiExportDiagnosticsConstMeta,
+        argValues: [],
+        apiImpl: this,
+      ),
+    );
+  }
+
+  TaskConstMeta get kCrateApiExportDiagnosticsConstMeta =>
+      const TaskConstMeta(debugName: "export_diagnostics", argNames: []);
+
  @override
  Future<void> crateApiInitStorage({required String dir}) {
    return handler.executeNormal(
@@ -268,7 +292,7 @@ class RustLibApiImpl extends RustLibApiImplPlatform implements RustLibApi {
          pdeCallFfi(
            generalizedFrbRustBinding,
            serializer,
-            funcId: 6,
+            funcId: 7,
            port: port_,
          );
        },
@@ -295,7 +319,7 @@ class RustLibApiImpl extends RustLibApiImplPlatform implements RustLibApi {
          pdeCallFfi(
            generalizedFrbRustBinding,
            serializer,
-            funcId: 7,
+            funcId: 8,
            port: port_,
          );
        },
@@ -320,7 +344,7 @@ class RustLibApiImpl extends RustLibApiImplPlatform implements RustLibApi {
        callFfi: () {
          final serializer = SseSerializer(generalizedFrbRustBinding);
          sse_encode_bridge_network_state(state, serializer);
-          return pdeCallFfi(generalizedFrbRustBinding, serializer, funcId: 8)!;
+          return pdeCallFfi(generalizedFrbRustBinding, serializer, funcId: 9)!;
        },
        codec: SseCodec(
          decodeSuccessData: sse_decode_unit,
@@ -346,7 +370,7 @@ class RustLibApiImpl extends RustLibApiImplPlatform implements RustLibApi {
          pdeCallFfi(
            generalizedFrbRustBinding,
            serializer,
-            funcId: 9,
+            funcId: 10,
            port: port_,
          );
        },
@@ -373,7 +397,7 @@ class RustLibApiImpl extends RustLibApiImplPlatform implements RustLibApi {
          pdeCallFfi(
            generalizedFrbRustBinding,
            serializer,
-            funcId: 10,
+            funcId: 11,
            port: port_,
          );
        },
@@ -400,7 +424,7 @@ class RustLibApiImpl extends RustLibApiImplPlatform implements RustLibApi {
          pdeCallFfi(
            generalizedFrbRustBinding,
            serializer,
-            funcId: 11,
+            funcId: 12,
            port: port_,
          );
        },