Files
element-x-ios/ElementX/Sources/AccessibilityTests/AccessibilityTestsAppCoordinator.swift
T
Michael 22d14ff8e4 AppSettings are Mockable (#5589)
* create DependenciesProtocol and replace ServiceLocator registration with it

replace mocking calls for ServiceLocator to Dependencies

replace ServiceLocator with instance level calls

replace ServiceLocator configs with TestDependencies config in Tests

replace servicelocator usage in analytics service

replace remaining ServiceLocator calls in unit tests

that depended on the UnitTestAppCoordinator configuration with per suite dependencies instances

fix swiftlint warning

remove remaining references to ServiceLocator

make dependencies properties consistent in tests

delete Dependencies and DependenciesProtocol

fix whitespace modifications

updates from PR feedback

a pass over converting AppSettings and AnalyticsService test instance properties to per test instantiation

fix a missed PR feedback

Sync up after rebase

create DependenciesProtocol and replace ServiceLocator registration with it

replace mocking calls for ServiceLocator to Dependencies

replace ServiceLocator with instance level calls

replace ServiceLocator configs with TestDependencies config in Tests

replace servicelocator usage in analytics service

replace remaining ServiceLocator calls in unit tests

that depended on the UnitTestAppCoordinator configuration with per suite dependencies instances

fix swiftlint warning

remove remaining references to ServiceLocator

make dependencies properties consistent in tests

delete Dependencies and DependenciesProtocol

* AppSettings is instance level mockable now

* replace mocked and preview usages of reset + AppSettings global init with

AppSettings(store: UserDefaultsMock())

* AppSettings.UserDefaultsKeys is now a RawRep struct, making it extensible

* update tests with new AppSettings so it builds

* update remaining AppSettings test/mock inits

* AppSettings.UserDefaultsKey conformed to ExpressibleByStringLiteral

* addressed issues found in first pass ai review

* update AppSettings instantiations after rebase

* fix accessibility tests coordinator after rebase

* Rename to VolatileUserDefaults

* AppSettings init uses mandatory parameter

* Revert UserDefaultsKey to enum

* Add TrackedUserDefaults to be able to reset the defaults object

* Added volatile static func to AppSettings

* Use .volatile() static func instead of full init

* review fixups

* Resolve build issues after rebase

* updated enterprise module

* remove the static reset settings call from the preview tests

---------

Co-authored-by: Mauro Romito <mauro.romito@element.io>
2026-05-22 15:14:08 +02:00

160 lines
5.5 KiB
Swift

//
// Copyright 2025 Element Creations Ltd.
// Copyright 2025 New Vector Ltd.
//
// SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
// Please see LICENSE files in the repository root for full details.
//
import Combine
import CoreLocation
import SwiftUI
class AccessibilityTestsAppCoordinator: AppCoordinatorProtocol {
var windowManager: any SecureWindowManagerProtocol
func handleDeepLink(_ url: URL, isExternalURL: Bool, windowType: SecondaryWindowType?) -> Bool {
fatalError("Not implemented")
}
func handleAppRoute(_ appRoute: AppRoute, windowType: SecondaryWindowType?) {
fatalError("Not implemented.")
}
func handlePotentialPhishingAttempt(url: URL, openURLAction: @escaping (URL) -> Void) -> Bool {
fatalError("Not implemented")
}
func handleUserActivity(_ userActivity: NSUserActivity) {
fatalError("Not implemented")
}
private let previewsWrapper: PreviewsWrapper
private var cancellables = Set<AnyCancellable>()
init(appDelegate: AppDelegate) {
windowManager = WindowManager(appDelegate: appDelegate)
// disabling View animations
UIView.setAnimationsEnabled(false)
MXLog.configure(currentTarget: "accessibility-tests")
let appSettings = AppSettings.volatile()
guard let name = ProcessInfo.accessibilityViewID,
let previewType = TestablePreviewsDictionary.dictionary[name] else {
fatalError("Unable to launch with unknown screen.")
}
previewsWrapper = .init(name: name, previews: previewType._allPreviews)
setupSignalling()
// Used to perform the request check before the tests run on CI, so it can be immediately dismissed.
CLLocationManager().requestWhenInUseAuthorization()
}
func toPresentable() -> AnyView {
AnyView(PreviewsWrapperView(wrapper: previewsWrapper))
}
private func setupSignalling() {
do {
let client = try UITestsSignalling.Client(mode: .app)
client.signals.sink { [weak self] signal in
guard let self else { return }
switch signal {
case .accessibilityAudit(let auditSignal):
switch auditSignal {
case .nextPreview:
Task { [weak self] in
guard let self else { return }
await previewsWrapper.updateCurrentIndex()
do {
guard !previewsWrapper.isDone else {
try client.send(.accessibilityAudit(.noMorePreviews))
return
}
try client.send(.accessibilityAudit(.nextPreviewReady(name: previewsWrapper.previewName)))
} catch {
fatalError("Failed sending signal: \(signal)")
}
}
default:
break
}
default:
break
}
}
.store(in: &cancellables)
} catch {
fatalError("Unable to start client signalling")
}
}
}
struct PreviewsWrapperView: View {
let wrapper: PreviewsWrapper
@Environment(\.dynamicTypeSize) var dynamicTypeSize
var body: some View {
if wrapper.currentIndex >= 0, !wrapper.isDone {
wrapper.currentPreview.content
.id("\(wrapper.previewName)-\(dynamicTypeSize)")
}
}
}
@Observable final class PreviewsWrapper {
private let name: String
private let previews: [_Preview]
private(set) var currentIndex = -1
var currentPreview: _Preview {
previews[currentIndex]
}
private(set) var isDone = false
var previewName: String {
"\(name)-\(currentPreview.displayName ?? String(currentIndex))"
}
init(name: String, previews: [_Preview]) {
self.name = name
self.previews = previews
}
@MainActor
func updateCurrentIndex() async {
let newIndex = currentIndex + 1
guard newIndex < previews.count else {
isDone = true
return
}
let newPreview = previews[newIndex]
var fulfillmentSource: SnapshotFulfillmentPreferenceKey.Source?
let preferenceReadingView = newPreview.content.onPreferenceChange(SnapshotFulfillmentPreferenceKey.self) { fulfillmentSource = $0?.source }
// Render an image of the view in order to trigger the preference updates to occur.
let imageRenderer = ImageRenderer(content: preferenceReadingView)
_ = imageRenderer.uiImage
switch fulfillmentSource {
case .publisher(let publisher):
_ = await publisher
// Not sure whye byt some publisher seem to not properly comunicate their completion,
// so we added a timeout. Since we are going to migrate from publishers to stream,
// this is a temporary solution
.timeout(.seconds(1), scheduler: DispatchQueue.main)
.values.first { $0 == true }
case .sequence(let sequence):
_ = await sequence.first { $0 == true }
case .none:
break
}
currentIndex = newIndex
}
}