hex/ios/HEXShared/UserFacingError.swift
Ryan Vogel 05849318bd
iOS: fewer paste prompts, and a translate switch in the keyboard (#2134)
* iOS: Translate to <language> switch in the Hex key menu, with a badge on the Hex key

A tester asked for a translate button where they dictate, not an app setting.
Translate what I say could only be turned on in Settings; the keyboards only
had a "Paste in English / Paste in Spanish" pair while it was already on.

- Full keyboard Hex key menu: "Translate to English" switch (checkmark while
  on) and "Translation language ›", a page of up to six targets (current,
  English, dictation and preferred languages, then common ones; only those
  Apple's Translation lists once it has answered). Picking one sets the target
  and turns translation on.
- Dictation bar language tray: the same switch as a chip; the tray also opens
  when there's no language choice but translation is available.
- While dictations paste translated, the Hex key wears the target's code
  ("EN") in its corner, and the dictation bar shows "→ EN" beside the Hex mark
  (its language label drops the "→ English" it now repeats).
- Same App Group keys as Settings: the switch writes
  experiments.translateDictation (on also sets pastesTranslation to
  translated, as Settings' switch does); Settings' row re-reads everything on
  appear and on returning to the foreground.
- Replaced: the menu's "Paste in English / Paste in Spanish" rows and the bar's
  "Paste in English" chip (and onPasteTranslationSelected), now one switch.
  Settings keeps its Paste in English toggle.
- The keyboard target now includes the app's String Catalog, so the Hex key
  menu (and the shared strings it already had) follow a Chinese iPhone; new
  zh-Hans strings: Language, Translate to %@, Translating to %@, Translation
  language. Menu's Language/Automatic are localized now.

Verified on the iOS 27.2 simulator: HEXMobileTests 391 run, 0 failures
(1 skipped); in the real keyboard in Messages, the menu switch and target page
wrote experiments.translateDictation / .target (en -> ja, then off) and the
badge followed; snapshot scenes in light, dark and zh-Hans.

* iOS: Paste chip reads once and points to Paste from Other Apps › Allow

A tester had to tap Allow Paste for every paste from the keyboard. iOS asks for
each programmatic read while Settings › Apps › Hex › Paste from Other Apps is
Ask (the default). No read path avoids it inside a keyboard: UIPasteControl
draws blank there (TestFlight build 4) and detectPatterns can't return the
text. But that one setting covers the keyboard, so the fix is to point to it.

Checked on the iOS 27.2 simulator: pasted resolves the keyboard's identity to
anomaly.hex.mobile (TCCGetIdentityForCredential), a keyboard read alone (Hex
never launched) made "Paste from Other Apps: Ask" appear under Hex, and with
Allow the chip pasted in Messages and Safari with only iOS's "Hex pasted
from..." banner.

- One read per paste: text if hasStrings, else the URL. Before, a link was read
  as string then url, which could ask twice.
- The read blocks while iOS asks, so a read that took 0.3 s or more asked: the
  strip then shows "Settings › Apps › Hex › Paste from Other Apps › Allow" for
  8 s (VoiceOver gets a sentence), the first 3 times only. A refused read
  (Don't Allow, or the setting is Deny, while the clipboard has text) always
  shows it, since the chip did nothing. Typing takes the strip back; while it
  shows, the pasted text's suggestions wait.
- zh-Hans strings for both. The chip, its slot and offering only a fresh copy
  are unchanged.

Verified: HEXMobileTests 393 run, 0 failures (1 skipped), including two new
KeyboardClipboardTests; on the simulator, Ask -> hint in Messages and Safari
(the simulator can't show the prompt, so its read is refused), Allow -> pasted
with no prompt and no hint. A real iPhone must confirm the prompt's timing
(>= 0.3 s) and that Allow stops it there too.
2026-11-21 03:24:58 +00:00

98 lines
4.2 KiB
Swift

import AVFAudio
import Foundation
/// An error Hex wrote for people: its description is shown as it is. Every other error's
/// description (Apple's, Foundation's, a package's) is for logs, however readable it looks:
/// Speech's "transcription.ru asset not found after attempted download." reads as a sentence.
protocol HexDescribedError: LocalizedError {}
extension Locale {
/// The language Hex's own words are in: the app's when the iPhone's language is one Hex
/// is translated into, else English. The keyboard shares the app's String Catalog, so it
/// follows the same language (its own labels are mostly English still).
static var hexInterface: Locale {
Locale(identifier: Bundle.main.preferredLocalizations.first ?? "en")
}
}
/// Short messages for the errors Hex shows people, in the app and the keyboard. Never a
/// raw OSStatus, error domain, asset name, or Swift type name: those belong in logs.
nonisolated enum UserFacingError {
enum Context {
case microphone
case transcription
case model
var fallback: String {
switch self {
case .microphone: String(localized: "Hex couldn't start the microphone. Try again.")
case .transcription: String(localized: "Hex couldn't transcribe that. Try again.")
case .model: String(localized: "Hex couldn't get speech recognition ready. Try again.")
}
}
}
static var offline: String {
String(localized: "Hex couldn't download the speech model. Check your connection and try again.")
}
/// Audio session errors get their own message, Hex's own errors (`HexDescribedError`)
/// their description, a lost connection while getting the model ready says so, and
/// anything else gets the context's fallback. An allowlist, not a filter: #2035 kept any
/// description without an error code in it, which let Apple Speech's asset errors through
/// to the keyboard. Microphone errors never show a description.
static func message(for error: Error, context: Context) -> String {
if let code = audioSessionCode(of: error) {
return message(for: code) ?? context.fallback
}
guard context != .microphone else { return context.fallback }
if error is HexDescribedError,
let text = (error as? LocalizedError)?.errorDescription?.trimmingCharacters(in: .whitespacesAndNewlines),
!text.isEmpty {
return text
}
if context == .model, isConnectionError(error) {
return offline
}
return context.fallback
}
/// A URL loading error, itself or underneath another.
static func isConnectionError(_ error: Error) -> Bool {
var current: NSError? = error as NSError
for _ in 0..<4 {
guard let ns = current else { return false }
if ns.domain == NSURLErrorDomain { return true }
current = ns.userInfo[NSUnderlyingErrorKey] as? NSError
}
return false
}
/// The `AVAudioSession` error an error carries (they arrive as `NSOSStatusErrorDomain`).
static func audioSessionCode(of error: Error) -> AVAudioSession.ErrorCode? {
let ns = error as NSError
guard ns.domain == NSOSStatusErrorDomain else { return nil }
return AVAudioSession.ErrorCode(rawValue: ns.code)
}
static func message(for code: AVAudioSession.ErrorCode) -> String? {
switch code {
case .cannotInterruptOthers:
String(localized: "Another app is using audio. Try again.")
case .insufficientPriority:
String(localized: "Another app is using the microphone. Try again.")
case .siriIsRecording:
String(localized: "Siri is using the microphone. Try again.")
case .isBusy:
String(localized: "The microphone is busy. Try again.")
case .cannotStartRecording, .cannotStartPlaying:
String(localized: "Open Hex, then try again.")
case .mediaServicesFailed:
String(localized: "Audio restarted on this iPhone. Try again.")
case .resourceNotAvailable:
String(localized: "No microphone is available right now.")
default:
nil
}
}
}