Add Copy Debug Information to iOS Settings - #13007

Included review availability: Your plan provides up to 10 included reviews per hour; 8 remain after this review.

Walkthrough

The iOS mobile settings diagnostics section now creates and copies a structured debug report. The report includes account, device, app, analytics, host, and connection details. The analytics client ID is propagated through the SwiftUI environment.

Changes

Mobile debug information

Priority: ⬇️ Low

Estimated code review effort: 3 (Moderate) | ~20 minutes

Change: Feature

Sequence Diagram(s)

sequenceDiagram
  participant MobileSettingsDiagnosticsSection
  participant MobileDebugInformation
  participant UIPasteboard
  MobileSettingsDiagnosticsSection->>MobileDebugInformation: Assemble diagnostic fields
  MobileDebugInformation-->>MobileSettingsDiagnosticsSection: Render report text
  MobileSettingsDiagnosticsSection->>UIPasteboard: Copy report to general pasteboard

Suggested reviewers: azooz2003-bit

Explanation

Docstring coverage is 37.50% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 8 functions across 5 files. (1 skipped: 1 unsupported.)

Explanation

The PR adds try? await Task.sleep(for: .seconds(2)) in the shipped MobileSettingsDiagnosticsSection implementation at MobileSettingsView.swift:1128. The new task uses the sleep to hold the “Copied” state for two seconds before resetting it. The repository rule explicitly lists Task.sleep in non-test Swift as a failure, including small delays and animation timing. The test-only and non-Task.sleep UI-delay exceptions do not apply.

Resolution

Replace the production Task.sleep with an approved cancellation-aware timing mechanism or explicit UI state transition. Keep the “Copied” feedback independent of Task.sleep; for example, use a project timer/scheduler abstraction that owns cancellation when the view disappears or the button is pressed again, or remove the delayed reset and use a purely state-driven SwiftUI presentation.

Explanation

The diff adds a discarded Task { @mainactor in ... } in copyDebugInformation() at MobileSettingsView.swift:1127. It sleeps for two seconds and then changes didCopyDebugInformation, so it owns a real UI-feedback lifecycle. The task is not stored or cancelled when the button is tapped again or when the diagnostics view disappears. The existing log-export task in the same view is stored in @State and cancelled on disappearance, which confirms the available lifecycle pattern. This is not a required SwiftUI or OS callback boundary because copyDebugInformation() already runs on @MainActor. No new Dispatch, Combine, or completion-handler pattern was introduced.

Resolution

Store the copy-feedback task in view state, cancel any previous task before starting a new one, and cancel and clear it in the diagnostics view’s onDisappear. Keep the delayed reset in the stored task and check cancellation before mutating didCopyDebugInformation; alternatively, use a SwiftUI lifecycle-bound .task(id:) for the two-second reset.

Explanation

The new production Settings action copies a user-facing support report to UIPasteboard.general. The report includes Hexclave Auth ID and a dynamic Team ID from authManager, as shown in MobileDebugInformation.report and copyDebugInformation(). The rule forbids internal provider names and team IDs unless the user supplied the exact ID. The new tests confirm these fields are part of the report. This behavior is introduced by the pull request.

Resolution

Remove hexclaveAuthID and teamID from the user-facing copied report, including their labels. Keep any required correlation data in sanitized internal telemetry or logs. Use only safe, minimal product-level diagnostics in the copied support text.

Explanation

The new Settings button text is localized correctly: it uses L10n.string(...), and mobile.settings.diagnostics.copyDebugInfo has translated entries for all nine locales already present in ios/cmux/Resources/Localizable.xcstrings. However, the production MobileDebugInformation.report adds user-visible clipboard text (Device ID, Email, Hexclave Auth ID, and the other field labels, plus <unavailable>) as English literals. MobileSettingsDiagnosticsSection.copyDebugInformation() places this report on UIPasteboard.general, so the text is exposed to the user. The report does not use String(localized:defaultValue:) or an equivalent API, and it has no matching catalog entries.

Resolution

Route every report label and the unavailable-value text through the localized API. Add matching translated keys to ios/cmux/Resources/Localizable.xcstrings for en, ja, de, fr, ar, es, zh-Hant, zh-Hans, and ko. Update the report tests to verify the localized English fixture and preserve the required report format.

Explanation

The diff introduces a store reference below the settings form boundary. MobileSettingsView renders MobileSettingsDiagnosticsSection inside Form, and the new section stores let store: CMUXMobileShellStore?. CMUXMobileShellStore is an alias for the @Observable MobileShellComposite. The rule prohibits plain store properties in lazy/list-style row subtrees. The other prohibited patterns are not introduced: no new ObservableObject, @Published, GeometryReader, or render-time state write is present.

Resolution

Do not pass CMUXMobileShellStore into MobileSettingsDiagnosticsSection. Resolve connectionState and transport in MobileSettingsView and pass those immutable value snapshots, or pass a value-producing/action closure. Keep the diagnostics section dependent on snapshots and closures instead of a store reference.

• X
• Mastodon
• Reddit
• LinkedIn