hex/ios/HEXKeyboard/KeyboardInputView.swift
Ryan Vogel 994b346982
iOS keyboard: stop leaking views, capture web views, and emoji indices across shows (#2352)
What was wrong:
iOS creates a new KeyboardViewController almost every time the keyboard comes up inside
one HEXKeyboard process. Three things stayed behind after each presentation (~0.44 MB
per empty show, ~0.82 MB once a word was typed) until iOS killed the keyboard over its
memory limit and fell back to the system keyboard:

1. KeyboardLocalDictation built a new WKWebView (KeyboardWebCapture) for every controller
   and never detached it from KeyboardInputView when the keyboard hid or deallocated.
   WebKit's process-wide observers kept each WKWebView alive, and its Auto Layout engine
   kept the whole dismissed KeyboardInputView and FullKeyboardView alive with it.
2. On iOS 27, UIKit keeps every UIInputView shell alive in ObjC associated storage after
   its controller deallocates, so any subviews Hex left attached (FullKeyboardView, the
   bar, KeyboardBackdropView's UIVisualEffectView) stayed in memory too. In hosts with an
   autofocusing inputAccessoryView (#2302), iOS also keeps earlier controllers alive
   without calling viewWillDisappear, leaving their views and 4 Hz poll timers running.
3. EmojiLibrary.load built a new ~0.8 MB index per FullKeyboardView instead of sharing
   one copy per process like TypingDecoderModel and GermanCapitals.

What changed (and what was replaced):
- Replaced per-controller WKWebView creation with one shared KeyboardWebCapture per
  extension process, guarded by KeyboardCaptureOwnership so only the current owner (or
  any caller while parked with no owner) can detach, park, or evict it on a memory
  warning. A stale controller that hid or received a memory warning drops only its own
  pointer instead of stopping a newer keyboard's active recording.
- Replaced eager KeyboardBackdropView allocation with a lazy backdrop created only while
  KeyboardsOnScreen.isOverAnother is true. KeyboardInputView records weak references to
  only the subviews Hex mounted (surface, backdrop, barEmojiPanel) and removes those
  exact views in viewDidDisappear and deinit without touching UIKit's own views.
- Superseded controllers in the same named field (KeyboardsOnScreen.isSuperseded) stop
  their poll timer and unmount their surface; if the newer keyboard above leaves while
  the older one is still on screen, restoreRetiredKeyboard() rebuilds only its surface
  and poll timer without handing off number pads, auto-starting dictation, or resetting
  its cold-start job. Cleared handOffWaitsForPosture on appear, disappear, teardown, and
  retire.
- Added EmojiLibrary.bundled(language:bundle:) and EmojiLibrary.evictCached() to share
  one index across presentations until a memory warning.

Checked:
- Release on iPhone Air iOS 27.2 simulator vs origin/dev:
  - 30 hide/shows + 20 Apple switches: 46.35 MB (peak 54.71 MB) -> 25.25 MB (peak
    33.57 MB); FullKeyboardView 51 -> 1, WKWebView 51 -> 1, KeyboardBackdropView 51 -> 0.
  - 6 switches in autofocus inputAccessoryView host: 28.50 MB -> 24.96 MB (1 live
    FullKeyboardView, 1 WKWebView, 1 backdrop on the top keyboard).
  - First-frame commit time (20 shows): 1.19 ms median (new controller) vs 1.25 ms on
    dev; 15.66 ms when forcibly reusing one controller; keys present across Messages,
    Safari address bar and web fields, Spotlight, two-field focus, and rotation.
  - 48 kHz mock-mic dictation across first show, 10 hide/shows, keyboard switches, bar,
    auto-start, hide mid-recording/transcribing, active recording surviving an older
    controller's memory warning/hide/deinit, and number-pad restore without hand-off or
    auto-start.
- xcodebuild test -scheme HEXMobile: 808 executed, 3 skipped, 0 failures; code-shape and
  hex-agent-policy clean.
2026-11-22 06:45:38 -05:00

31 lines
1.3 KiB
Swift
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import UIKit
/// The keyboard's root view. `UIDevice.playInputClick()` plays the key click only while the
/// visible input view adopts `UIInputViewAudioFeedback` and enables it (UIKit's docs for
/// both): a subview that adopts it, as the full keyboard's did, plays nothing. The click then
/// follows Settings › Sounds & Haptics › Keyboard Feedback › Sound, as the system keyboard's
/// does, and like any keyboard sound needs Allow Full Access (Apple's custom keyboard guide).
final class KeyboardInputView: UIInputView, UIInputViewAudioFeedback {
var enableInputClicksWhenVisible: Bool { true }
private struct WeakView {
weak var view: UIView?
}
private var mountedByHex: [WeakView] = []
/// Records a subview Hex itself mounted (`surface`, `backdrop`, `barEmojiPanel`) so
/// `unmountHexViews()` removes only those exact views by reference—never any view UIKit
/// adds inside `UIInputView`.
func noteHexSubview(_ subview: UIView) {
mountedByHex.removeAll { $0.view == nil || $0.view === subview }
mountedByHex.append(WeakView(view: subview))
}
func unmountHexViews() {
for entry in mountedByHex {
entry.view?.removeFromSuperview()
}
mountedByHex.removeAll()
}
}