Merge branch 'IOS-962-AccessibilityIdentifier-refactor'

mullvad · Dec 10, 2024 · 534866b · 534866b
2 parents 3232f1b + bdf7473
commit 534866b
Show file tree

Hide file tree

Showing 69 changed files with 198 additions and 200 deletions.
diff --git a/ios/MullvadVPN/Classes/AccessbilityIdentifier.swift b/ios/MullvadVPN/Classes/AccessbilityIdentifier.swift
@@ -8,7 +8,7 @@
 
 import UIKit
 
-public enum AccessibilityIdentifier: String {
+public enum AccessibilityIdentifier: Equatable {
     // Buttons
     case addAccessMethodButton
     case accessMethodAddButton
@@ -181,7 +181,7 @@ public enum AccessibilityIdentifier: String {
     case wireGuardObfuscationOff
     case wireGuardObfuscationUdpOverTcp
     case wireGuardObfuscationShadowsocks
-    case wireGuardPort
+    case wireGuardPort(UInt16?)
     case udpOverTcpObfuscationSettings
 
     // Custom DNS
@@ -214,14 +214,14 @@ public enum AccessibilityIdentifier: String {
     case unknown
 }
 
+extension AccessibilityIdentifier {
+    public var asString: String {
+        "\(self)"
+    }
+}
+
 extension UIAccessibilityIdentification {
-    var accessibilityIdentifier: AccessibilityIdentifier? {
-        get {
-            guard let accessibilityIdentifier else { return nil }
-            return AccessibilityIdentifier(rawValue: accessibilityIdentifier)
-        }
-        set {
-            accessibilityIdentifier = newValue?.rawValue
-        }
+    func setAccessibilityIdentifier(_ value: AccessibilityIdentifier?) {
+        accessibilityIdentifier = value.map(\.asString)
     }
 }
diff --git a/ios/MullvadVPN/Containers/Root/HeaderBarView.swift b/ios/MullvadVPN/Containers/Root/HeaderBarView.swift
@@ -33,7 +33,7 @@ class HeaderBarView: UIView {
         label.font = UIFont.systemFont(ofSize: 14)
         label.textColor = UIColor(white: 1.0, alpha: 0.8)
         label.setContentHuggingPriority(.defaultHigh, for: .horizontal)
-        label.accessibilityIdentifier = .headerDeviceNameLabel
+        label.setAccessibilityIdentifier(.headerDeviceNameLabel)
         return label
     }()
 
@@ -58,7 +58,7 @@ class HeaderBarView: UIView {
 
     let accountButton: UIButton = {
         let button = makeHeaderBarButton(with: UIImage(named: "IconAccount"))
-        button.accessibilityIdentifier = .accountButton
+        button.setAccessibilityIdentifier(.accountButton)
         button.accessibilityLabel = NSLocalizedString(
             "HEADER_BAR_ACCOUNT_BUTTON_ACCESSIBILITY_LABEL",
             tableName: "HeaderBar",
@@ -72,7 +72,7 @@ class HeaderBarView: UIView {
 
     let settingsButton: UIButton = {
         let button = makeHeaderBarButton(with: UIImage(named: "IconSettings"))
-        button.accessibilityIdentifier = .settingsButton
+        button.setAccessibilityIdentifier(.settingsButton)
         button.accessibilityLabel = NSLocalizedString(
             "HEADER_BAR_SETTINGS_BUTTON_ACCESSIBILITY_LABEL",
             tableName: "HeaderBar",
@@ -170,7 +170,7 @@ class HeaderBarView: UIView {
         )
 
         accessibilityContainerType = .semanticGroup
-        accessibilityIdentifier = .headerBarView
+        setAccessibilityIdentifier(.headerBarView)
 
         let brandImageSize = brandNameImage?.size ?? .zero
         let brandNameAspectRatio = brandImageSize.width / max(brandImageSize.height, 1)

diff --git a/ios/MullvadVPN/Coordinators/ApplicationCoordinator.swift b/ios/MullvadVPN/Coordinators/ApplicationCoordinator.swift
@@ -559,7 +559,7 @@ final class ApplicationCoordinator: Coordinator, Presenting, RootContainerViewCo
         )
 
         let navigationController = CustomNavigationController()
-        navigationController.view.accessibilityIdentifier = .settingsContainerView
+        navigationController.view.setAccessibilityIdentifier(.settingsContainerView)
 
         let configurationTester = ProxyConfigurationTester(transportProvider: configuredTransportProvider)
 

diff --git a/ios/MullvadVPN/Coordinators/CustomLists/AddLocationsViewController.swift b/ios/MullvadVPN/Coordinators/CustomLists/AddLocationsViewController.swift
@@ -27,7 +27,7 @@ class AddLocationsViewController: UIViewController {
         tableView.separatorInset = .zero
         tableView.rowHeight = 56
         tableView.indicatorStyle = .white
-        tableView.accessibilityIdentifier = .editCustomListEditLocationsTableView
+        tableView.setAccessibilityIdentifier(.editCustomListEditLocationsTableView)
         return tableView
     }()
 
@@ -46,7 +46,7 @@ class AddLocationsViewController: UIViewController {
 
     override func viewDidLoad() {
         super.viewDidLoad()
-        view.accessibilityIdentifier = .editCustomListEditLocationsView
+        view.setAccessibilityIdentifier(.editCustomListEditLocationsView)
         tableView.backgroundColor = view.backgroundColor
         view.backgroundColor = .secondaryColor
         addConstraints()

diff --git a/ios/MullvadVPN/Coordinators/CustomLists/CustomListCellConfiguration.swift b/ios/MullvadVPN/Coordinators/CustomLists/CustomListCellConfiguration.swift
@@ -79,7 +79,7 @@ struct CustomListCellConfiguration {
         contentConfiguration.maxLength = NameInputFormatter.maxLength
         contentConfiguration.editingEvents.onChange = subject.bindTextAction(to: \.name)
 
-        cell.accessibilityIdentifier = AccessibilityIdentifier.customListEditNameFieldCell
+        cell.setAccessibilityIdentifier(.customListEditNameFieldCell)
         cell.contentConfiguration = contentConfiguration
     }
 
@@ -88,7 +88,7 @@ struct CustomListCellConfiguration {
 
         contentConfiguration.text = itemIdentifier.text
         cell.contentConfiguration = contentConfiguration
-        cell.accessibilityIdentifier = AccessibilityIdentifier.customListEditAddOrEditLocationCell
+        cell.setAccessibilityIdentifier(.customListEditAddOrEditLocationCell)
 
         if let cell = cell as? CustomCellDisclosureHandling {
             cell.disclosureType = .chevron
@@ -104,7 +104,7 @@ struct CustomListCellConfiguration {
             onDelete?()
         }
 
-        cell.accessibilityIdentifier = AccessibilityIdentifier.customListEditDeleteListCell
+        cell.setAccessibilityIdentifier(.customListEditDeleteListCell)
         cell.contentConfiguration = contentConfiguration
     }
 }
diff --git a/ios/MullvadVPN/Coordinators/CustomLists/CustomListViewController.swift b/ios/MullvadVPN/Coordinators/CustomLists/CustomListViewController.swift
@@ -58,7 +58,7 @@ class CustomListViewController: UIViewController {
             }
         )
         barButtonItem.style = .done
-        barButtonItem.accessibilityIdentifier = AccessibilityIdentifier.saveCreateCustomListButton
+        barButtonItem.setAccessibilityIdentifier(.saveCreateCustomListButton)
 
         return barButtonItem
     }()
@@ -87,7 +87,7 @@ class CustomListViewController: UIViewController {
         navigationItem.rightBarButtonItem = saveBarButton
         view.directionalLayoutMargins = UIMetrics.contentLayoutMargins
         view.backgroundColor = .secondaryColor
-        view.accessibilityIdentifier = .newCustomListView
+        view.setAccessibilityIdentifier(.newCustomListView)
         isModalInPresentation = true
 
         addSubviews()
@@ -104,7 +104,7 @@ class CustomListViewController: UIViewController {
         tableView.delegate = dataSourceConfiguration
         tableView.backgroundColor = .secondaryColor
         tableView.registerReusableViews(from: CustomListItemIdentifier.CellIdentifier.self)
-        tableView.accessibilityIdentifier = AccessibilityIdentifier.customListEditTableView
+        tableView.setAccessibilityIdentifier(.customListEditTableView)
     }
 
     private func configureDataSource() {

diff --git a/ios/MullvadVPN/Coordinators/CustomLists/ListCustomListViewController.swift b/ios/MullvadVPN/Coordinators/CustomLists/ListCustomListViewController.swift
@@ -50,7 +50,7 @@ class ListCustomListViewController: UIViewController {
         super.viewDidLoad()
 
         view.backgroundColor = .secondaryColor
-        view.accessibilityIdentifier = .listCustomListsView
+        view.setAccessibilityIdentifier(.listCustomListsView)
 
         addSubviews()
         configureNavigationItem()
@@ -89,7 +89,7 @@ class ListCustomListViewController: UIViewController {
         tableView.separatorStyle = .singleLine
         tableView.rowHeight = UIMetrics.SettingsCell.customListsCellHeight
         tableView.registerReusableViews(from: CellReuseIdentifier.self)
-        tableView.accessibilityIdentifier = .listCustomListsTableView
+        tableView.setAccessibilityIdentifier(.listCustomListsTableView)
     }
 
     private func configureNavigationItem() {
@@ -107,7 +107,7 @@ class ListCustomListViewController: UIViewController {
             })
         )
 
-        navigationItem.rightBarButtonItem?.accessibilityIdentifier = .listCustomListDoneButton
+        navigationItem.rightBarButtonItem?.setAccessibilityIdentifier(.listCustomListDoneButton)
     }
 
     private func configureDataSource() {

diff --git a/ios/MullvadVPN/Coordinators/LocationCoordinator.swift b/ios/MullvadVPN/Coordinators/LocationCoordinator.swift
@@ -284,7 +284,7 @@ extension LocationCoordinator: LocationViewControllerWrapperDelegate {
                 self?.showAddCustomList(nodes: nodes)
             }
         )
-        addCustomListAction.accessibilityIdentifier = AccessibilityIdentifier.addNewCustomListButton
+        addCustomListAction.setAccessibilityIdentifier(.addNewCustomListButton)
         actionSheet.addAction(addCustomListAction)
 
         let editAction = UIAlertAction(
@@ -297,7 +297,7 @@ extension LocationCoordinator: LocationViewControllerWrapperDelegate {
             }
         )
         editAction.isEnabled = !customListRepository.fetchAll().isEmpty
-        editAction.accessibilityIdentifier = AccessibilityIdentifier.editCustomListButton
+        editAction.setAccessibilityIdentifier(.editCustomListButton)
         actionSheet.addAction(editAction)
 
         actionSheet.addAction(UIAlertAction(

diff --git a/ios/MullvadVPN/Coordinators/Settings/APIAccess/Cells/SwitchCellContentView.swift b/ios/MullvadVPN/Coordinators/Settings/APIAccess/Cells/SwitchCellContentView.swift
@@ -76,7 +76,7 @@ class SwitchCellContentView: UIView, UIContentView, UITextFieldDelegate {
     private func configureSwitch() {
         switchContainer.control.isOn = actualConfiguration.isOn
         switchContainer.transform = CGAffineTransform(scaleX: 0.85, y: 0.85)
-        switchContainer.accessibilityIdentifier = actualConfiguration.accessibilityIdentifier
+        switchContainer.setAccessibilityIdentifier(actualConfiguration.accessibilityIdentifier)
     }
 
     private func addSubviews() {

diff --git a/ios/MullvadVPN/Coordinators/Settings/APIAccess/Common/SocksSectionHandler.swift b/ios/MullvadVPN/Coordinators/Settings/APIAccess/Common/SocksSectionHandler.swift
@@ -38,7 +38,7 @@ struct SocksSectionHandler {
         contentConfiguration.inputText = subject.value.socks.server
         contentConfiguration.textFieldProperties = .withSmartFeaturesDisabled()
         contentConfiguration.editingEvents.onChange = subject.bindTextAction(to: \.socks.server)
-        cell.accessibilityIdentifier = .socks5ServerCell
+        cell.setAccessibilityIdentifier(.socks5ServerCell)
         cell.contentConfiguration = contentConfiguration
     }
 
@@ -51,7 +51,7 @@ struct SocksSectionHandler {
         contentConfiguration.editingEvents.onChange = subject.bindTextAction(to: \.socks.port)
         contentConfiguration.textFieldProperties = .withSmartFeaturesDisabled()
         contentConfiguration.textFieldProperties.keyboardType = .numberPad
-        cell.accessibilityIdentifier = .socks5PortCell
+        cell.setAccessibilityIdentifier(.socks5PortCell)
         cell.contentConfiguration = contentConfiguration
     }
 

diff --git a/ios/MullvadVPN/Coordinators/Settings/APIAccess/Edit/EditAccessMethodViewController.swift b/ios/MullvadVPN/Coordinators/Settings/APIAccess/Edit/EditAccessMethodViewController.swift
@@ -47,7 +47,7 @@ class EditAccessMethodViewController: UIViewController {
 
         view.backgroundColor = .secondaryColor
 
-        tableView.accessibilityIdentifier = .editAccessMethodView
+        tableView.setAccessibilityIdentifier(.editAccessMethodView)
         tableView.backgroundColor = .secondaryColor
         tableView.delegate = self
 

diff --git a/...Coordinators/Settings/APIAccess/Edit/MethodSettings/MethodSettingsCellConfiguration.swift b/...Coordinators/Settings/APIAccess/Edit/MethodSettings/MethodSettingsCellConfiguration.swift
@@ -113,7 +113,7 @@ class MethodSettingsCellConfiguration {
         contentConfiguration.maxLength = NameInputFormatter.maxLength
         contentConfiguration.editingEvents.onChange = subject.bindTextAction(to: \.name)
 
-        cell.accessibilityIdentifier = .accessMethodNameTextField
+        cell.setAccessibilityIdentifier(.accessMethodNameTextField)
         cell.setDisabled(isTesting)
         cell.contentConfiguration = contentConfiguration
     }
@@ -156,7 +156,7 @@ class MethodSettingsCellConfiguration {
             cell.disclosureType = .chevron
         }
 
-        cell.accessibilityIdentifier = .accessMethodProtocolSelectionCell
+        cell.setAccessibilityIdentifier(.accessMethodProtocolSelectionCell)
         cell.setDisabled(isTesting)
     }
 

diff --git a/...PN/Coordinators/Settings/APIAccess/Edit/MethodSettings/MethodSettingsViewController.swift b/...PN/Coordinators/Settings/APIAccess/Edit/MethodSettings/MethodSettingsViewController.swift
@@ -76,12 +76,12 @@ class MethodSettingsViewController: UITableViewController {
     override func viewDidLoad() {
         super.viewDidLoad()
 
-        view.accessibilityIdentifier = .addAccessMethodTableView
+        view.setAccessibilityIdentifier(.addAccessMethodTableView)
         view.directionalLayoutMargins = UIMetrics.contentLayoutMargins
         view.backgroundColor = .secondaryColor
 
         navigationItem.rightBarButtonItem = saveBarButton
-        navigationItem.rightBarButtonItem?.accessibilityIdentifier = .accessMethodAddButton
+        navigationItem.rightBarButtonItem?.setAccessibilityIdentifier(.accessMethodAddButton)
         navigationItem.rightBarButtonItem?.isAccessibilityElement = true
         isModalInPresentation = true
 

diff --git a/...rdinators/Settings/APIAccess/Edit/MethodSettings/MethodTestingStatusCellContentView.swift b/...rdinators/Settings/APIAccess/Edit/MethodSettings/MethodTestingStatusCellContentView.swift
@@ -139,11 +139,11 @@ class MethodTestingStatusCellContentView: UIView, UIContentView {
         // Set accessibility identifier for the text label based on the status it is indicating
         switch actualConfiguration.status {
         case .reachable:
-            textLabel.accessibilityIdentifier = .addAccessMethodTestStatusReachableLabel
+            textLabel.setAccessibilityIdentifier(.addAccessMethodTestStatusReachableLabel)
         case .unreachable:
-            textLabel.accessibilityIdentifier = .addAccessMethodTestStatusUnreachableLabel
+            textLabel.setAccessibilityIdentifier(.addAccessMethodTestStatusUnreachableLabel)
         case .testing:
-            textLabel.accessibilityIdentifier = .addAccessMethodTestStatusTestingLabel
+            textLabel.setAccessibilityIdentifier(.addAccessMethodTestStatusTestingLabel)
         }
 
         // Text label is always the last one, so only add it into the stack if it's not there yet.

diff --git a/ios/MullvadVPN/Coordinators/Settings/APIAccess/List/ListAccessMethodViewController.swift b/ios/MullvadVPN/Coordinators/Settings/APIAccess/List/ListAccessMethodViewController.swift
@@ -62,7 +62,7 @@ class ListAccessMethodViewController: UIViewController, UITableViewDelegate {
 
         tableView.registerReusableViews(from: CellReuseIdentifier.self)
 
-        view.accessibilityIdentifier = .apiAccessView
+        view.setAccessibilityIdentifier(.apiAccessView)
 
         let headerView = createHeaderView()
         view.addConstrainedSubviews([headerView, tableView]) {
@@ -115,7 +115,7 @@ class ListAccessMethodViewController: UIViewController, UITableViewDelegate {
         button.addAction(UIAction { [weak self] _ in
             self?.sendAddNew()
         }, for: .touchUpInside)
-        button.accessibilityIdentifier = .addAccessMethodButton
+        button.setAccessibilityIdentifier(.addAccessMethodButton)
 
         let fontSize = button.titleLabel?.font.pointSize ?? 0
         button.titleLabel?.font = UIFont.systemFont(ofSize: fontSize, weight: .regular)

diff --git a/ios/MullvadVPN/Coordinators/Settings/APIAccess/Pickers/AccessMethodProtocolPicker.swift b/ios/MullvadVPN/Coordinators/Settings/APIAccess/Pickers/AccessMethodProtocolPicker.swift
@@ -23,7 +23,7 @@ struct AccessMethodProtocolPicker {
 
         let dataSource = AccessMethodProtocolPickerDataSource()
         let controller = ListItemPickerViewController(dataSource: dataSource, selectedItemID: currentValue)
-        controller.view.accessibilityIdentifier = .accessMethodProtocolPickerView
+        controller.view.setAccessibilityIdentifier(.accessMethodProtocolPickerView)
 
         controller.navigationItem.title = NSLocalizedString(
             "SELECT_PROTOCOL_NAV_TITLE",

diff --git a/ios/MullvadVPN/Coordinators/Settings/SettingsViewControllerFactory.swift b/ios/MullvadVPN/Coordinators/Settings/SettingsViewControllerFactory.swift
@@ -103,7 +103,7 @@ struct SettingsViewControllerFactory {
             value: "Multihop",
             comment: ""
         )
-        host.view.accessibilityIdentifier = AccessibilityIdentifier.multihopView.rawValue
+        host.view.setAccessibilityIdentifier(.multihopView)
 
         return .viewController(host)
     }
@@ -129,7 +129,7 @@ struct SettingsViewControllerFactory {
             value: "DAITA",
             comment: ""
         )
-        host.view.accessibilityIdentifier = AccessibilityIdentifier.daitaView.rawValue
+        host.view.setAccessibilityIdentifier(.daitaView)
 
         return .viewController(host)
     }

diff --git a/ios/MullvadVPN/View controllers/Account/AccountContentView.swift b/ios/MullvadVPN/View controllers/Account/AccountContentView.swift
@@ -11,13 +11,13 @@ import UIKit
 class AccountContentView: UIView {
     let purchaseButton: InAppPurchaseButton = {
         let button = InAppPurchaseButton()
-        button.accessibilityIdentifier = .purchaseButton
+        button.setAccessibilityIdentifier(.purchaseButton)
         return button
     }()
 
     let redeemVoucherButton: AppButton = {
         let button = AppButton(style: .success)
-        button.accessibilityIdentifier = .redeemVoucherButton
+        button.setAccessibilityIdentifier(.redeemVoucherButton)
         button.setTitle(NSLocalizedString(
             "REDEEM_VOUCHER_BUTTON_TITLE",
             tableName: "Account",
@@ -29,7 +29,7 @@ class AccountContentView: UIView {
 
     let logoutButton: AppButton = {
         let button = AppButton(style: .danger)
-        button.accessibilityIdentifier = .logoutButton
+        button.setAccessibilityIdentifier(.logoutButton)
         button.setTitle(NSLocalizedString(
             "LOGOUT_BUTTON_TITLE",
             tableName: "Account",
@@ -41,7 +41,7 @@ class AccountContentView: UIView {
 
     let deleteButton: AppButton = {
         let button = AppButton(style: .danger)
-        button.accessibilityIdentifier = .deleteButton
+        button.setAccessibilityIdentifier(.deleteButton)
         button.setTitle(NSLocalizedString(
             "DELETE_BUTTON_TITLE",
             tableName: "Account",
@@ -101,7 +101,7 @@ class AccountContentView: UIView {
         super.init(frame: frame)
 
         directionalLayoutMargins = UIMetrics.contentLayoutMargins
-        accessibilityIdentifier = .accountView
+        setAccessibilityIdentifier(.accountView)
 
         addConstrainedSubviews([contentStackView, buttonStackView]) {
             contentStackView.pinEdgesToSuperviewMargins(.all().excluding(.bottom))

diff --git a/ios/MullvadVPN/View controllers/Account/AccountDeviceRow.swift b/ios/MullvadVPN/View controllers/Account/AccountDeviceRow.swift
@@ -13,7 +13,7 @@ class AccountDeviceRow: UIView {
         didSet {
             deviceLabel.text = deviceName?.capitalized ?? ""
             accessibilityValue = deviceName
-            accessibilityIdentifier = .accountPageDeviceNameLabel
+            setAccessibilityIdentifier(.accountPageDeviceNameLabel)
         }
     }
 
@@ -41,7 +41,7 @@ class AccountDeviceRow: UIView {
 
     private let infoButton: UIButton = {
         let button = IncreasedHitButton(type: .system)
-        button.accessibilityIdentifier = .infoButton
+        button.setAccessibilityIdentifier(.infoButton)
         button.tintColor = .white
         button.setImage(UIImage(named: "IconInfo"), for: .normal)
         return button