Files
hapi/ios/HapiTests/TranscriptRefreshTests.swift
T
weishuandClaude Opus 5.5 243466da04 fix(ios): keep transcript rows in sync with environment changes on iOS 27
On iOS 27, SwiftUI re-runs a representable's update only when an
environment value read during it changes; even @Environment(\.self) is
tracked per key. AnchoredTranscriptList copied context.environment
without reading keys, and compared metrics later in a drain that is
often deferred. A theme switch or a system text size change therefore
never reached the hosted rows: text kept its old size and colors.

updateUIViewController now reads every runtime-changing value the rows
follow (Dynamic Type, bold text, typography, locale, direction, color
scheme, theme, link action, enabled state). Rows still receive the
complete environment snapshot.

The tests drive Dynamic Type through UIKit traits, as the system does.
On iOS 27 a SwiftUI dynamicTypeSize override does not reach a UIKit
representable's environment, and the app never sets one above the
list. A new test checks that theme-only and text-size-only changes
reach visible rows without reconfiguring cells; it fails without the
fix.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-28 19:25:18 +08:00

219 lines
9.3 KiB
Swift

import Observation
import SwiftUI
import UIKit
import XCTest
@testable import HapiUI
@MainActor
final class TranscriptRefreshTests: XCTestCase {
struct Row: Identifiable, Equatable {
let id: String
var height: CGFloat = 120
}
struct Sample: Equatable {
let basePath: String
let dark: Bool
let size: DynamicTypeSize
let locale: String
let direction: LayoutDirection
}
@Observable @MainActor
final class Driver {
var rows = (0..<80).map { Row(id: String($0)) }
var version = 0
var basePath = "/before"
var dark = false
var locale = Locale(identifier: "en")
var direction = LayoutDirection.leftToRight
var actionToken = 0
@ObservationIgnored var lastAction = -1
@ObservationIgnored var layouts: [Int] = []
@ObservationIgnored var samples: [String: Sample] = [:]
@ObservationIgnored var actions: [String: HapiOpenURLAction] = [:]
}
private struct Harness: View {
let driver: Driver
var body: some View {
let token = driver.actionToken
ListView(driver: driver)
.hapiTheme(driver.dark ? .dark : .light)
.environment(\.locale, driver.locale)
.environment(\.layoutDirection, driver.direction)
.environment(\.hapiOpenURL, HapiOpenURLAction { _ in
Task { @MainActor in driver.lastAction = token }
})
}
}
private struct ListView: View {
let driver: Driver
var body: some View {
// An ordinary value capture, not a live observable read in a row.
let basePath = driver.basePath
AnchoredTranscriptList(
items: driver.rows, historyVersion: driver.version, jumpToken: 0,
historyControlID: "history", onViewport: { _ in },
onLayout: { version, _ in driver.layouts.append(version) }
) { row in
AnyView(ProbeRow(row: row, basePath: basePath, driver: driver))
}
}
}
private struct ProbeRow: View {
let row: Row
let basePath: String
let driver: Driver
@Environment(\.dynamicTypeSize) private var size
var body: some View {
Text(row.id)
.frame(maxWidth: .infinity)
.frame(height: row.height + (size.isAccessibilitySize ? 60 : 0))
.background(Probe(id: row.id, basePath: basePath, driver: driver))
}
}
private struct Probe: UIViewRepresentable {
let id: String
let basePath: String
let driver: Driver
func makeUIView(context: Context) -> UIView { UIView() }
func updateUIView(_ view: UIView, context: Context) {
let environment = context.environment
driver.samples[id] = Sample(basePath: basePath, dark: environment.hapiTheme.isDark,
size: environment.dynamicTypeSize, locale: environment.locale.identifier,
direction: environment.layoutDirection)
driver.actions[id] = environment.hapiOpenURL
}
}
private func host(_ driver: Driver) throws -> (UIWindow, TranscriptCollectionController<Row>, UICollectionView) {
let scene = try XCTUnwrap(UIApplication.shared.connectedScenes.compactMap { $0 as? UIWindowScene }.first)
let window = UIWindow(windowScene: scene)
window.setDynamicTypeSize(.large)
let host = UIHostingController(rootView: Harness(driver: driver))
window.rootViewController = host
window.makeKeyAndVisible()
host.view.layoutIfNeeded()
func find(_ controller: UIViewController) -> TranscriptCollectionController<Row>? {
if let result = controller as? TranscriptCollectionController<Row> { return result }
return controller.children.lazy.compactMap(find).first
}
let controller = try XCTUnwrap(find(host))
return (window, controller, try XCTUnwrap(controller.view as? UICollectionView))
}
private func settle(_ condition: () -> Bool = { true }, file: StaticString = #filePath, line: UInt = #line) async {
for _ in 0..<100 {
try? await Task.sleep(for: .milliseconds(20))
if condition() {
try? await Task.sleep(for: .milliseconds(100))
return
}
}
XCTFail("Transcript did not settle", file: file, line: line)
}
private func browse(_ view: UICollectionView, index: Int) async {
view.delegate?.scrollViewWillBeginDragging?(view)
view.scrollToItem(at: IndexPath(item: index, section: 0), at: .top, animated: false)
await settle()
}
func testOffscreenUpdatesKeepVisibleHostingConfigurationsAndStillResizeChangedRows() async throws {
let driver = Driver()
let (window, controller, view) = try host(driver)
defer { window.isHidden = true }
await settle { driver.layouts.contains(0) }
await browse(view, index: 25)
let cell = try XCTUnwrap(view.cellForItem(at: IndexPath(item: 25, section: 0)))
let offset = cell.frame.minY - view.contentOffset.y
#if DEBUG
let configurations = controller.cellConfigurationCount
#endif
for version in 1...3 {
driver.rows[79].height += 20
driver.version = version
await settle { driver.layouts.contains(version) }
}
#if DEBUG
XCTAssertEqual(controller.cellConfigurationCount, configurations,
"Offscreen streaming must not reinstall unchanged visible hosting roots")
#endif
XCTAssertEqual(cell.frame.minY - view.contentOffset.y, offset, accuracy: 1)
driver.rows[25].height += 70
await settle { abs(cell.frame.height - 190) < 1 }
XCTAssertEqual(cell.frame.minY - view.contentOffset.y, offset, accuracy: 1)
await browse(view, index: 79)
let tail = try XCTUnwrap(view.cellForItem(at: IndexPath(item: 79, section: 0)))
XCTAssertEqual(tail.frame.height, 180, accuracy: 1, "Recycled cells must use the latest offscreen value")
}
func testEnvironmentOnlyChangesReachVisibleRows() async throws {
let driver = Driver()
let (window, controller, view) = try host(driver)
defer { window.isHidden = true }
await settle { driver.layouts.contains(0) }
await browse(view, index: 25)
#if DEBUG
let configurations = controller.cellConfigurationCount
#endif
// No item or closure capture changes: only the environment does.
driver.dark = true
await settle { driver.samples["25"]?.dark == true }
XCTAssertEqual(driver.samples["25"]?.dark, true, "A theme change must reach hosted rows")
#if DEBUG
XCTAssertEqual(controller.cellConfigurationCount, configurations)
#endif
window.setDynamicTypeSize(.accessibility2)
await settle { driver.samples["25"]?.size == .accessibility2 }
let cell = try XCTUnwrap(view.cellForItem(at: IndexPath(item: 25, section: 0)))
XCTAssertEqual(cell.frame.height, 180, accuracy: 1, "A system text size change must re-measure rows")
}
func testEqualItemsReceiveLatestEnvironmentValueCapturesAndActions() async throws {
let driver = Driver()
let (window, controller, view) = try host(driver)
defer { window.isHidden = true }
await settle { driver.layouts.contains(0) }
await browse(view, index: 25)
#if DEBUG
let configurations = controller.cellConfigurationCount
#endif
driver.basePath = "/after"
driver.dark = true
driver.actionToken = 1
let expected = Sample(basePath: "/after", dark: true, size: .large, locale: "en", direction: .leftToRight)
await settle { driver.samples["25"] == expected }
XCTAssertEqual(driver.samples["25"], expected)
#if DEBUG
XCTAssertEqual(controller.cellConfigurationCount, configurations)
#endif
try XCTUnwrap(driver.actions["25"])(URL(string: "hapi-file://?path=test")!)
await settle { driver.lastAction == 1 }
// UIKit may itself request cells again when layout-direction traits
// change; only ordinary data/context updates have a zero-config budget.
driver.locale = Locale(identifier: "ar")
driver.direction = .rightToLeft
window.setDynamicTypeSize(.accessibility2)
let recycled = Sample(basePath: "/after", dark: true, size: .accessibility2, locale: "ar", direction: .rightToLeft)
await settle { driver.samples["25"] == recycled }
let cell = try XCTUnwrap(view.cellForItem(at: IndexPath(item: 25, section: 0)))
XCTAssertEqual(cell.frame.height, 180, accuracy: 1, "Environment-only changes must still self-size")
await browse(view, index: 60)
XCTAssertEqual(driver.samples["60"], recycled)
}
}
private extension UIWindow {
/// Change text size as the system does. On iOS 27 a SwiftUI
/// `dynamicTypeSize` override does not reach a UIKit representable's
/// `context.environment`, and the app never overrides it above the list.
func setDynamicTypeSize(_ size: DynamicTypeSize) {
traitOverrides.preferredContentSizeCategory = UIContentSizeCategory(size)
}
}