From 76b9d1da32b8e8a7cf18b1ec2a91b045a4617141 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Micha=C5=82=20Buczek?= <michal.buczek@protonmail.com>
Date: Wed, 4 Sep 2024 04:49:05 +0200
Subject: [PATCH] Fix #3298: Add support for Xcode 16 (#3299)

Task/Issue URL: #3298 & https://app.asana.com/0/414709148257752/1208200157992058/f
Tech Design URL:
CC:

Description:

Resolves #3298

This PR allows this repo to be compiled with Xcode 16.
Two changes had to be made:

In iOS 18 Apple added a new field to UIViewController named tab.
It causes ambiguity and has to be renamed.
Source https://developer.apple.com/documentation/uikit/uiviewcontroller/4434584-tab
I renamed it to _tab, I am open to any other rename suggestion

The URLOpener protocol and Apple's UIApplication shared the same
signature for url opening function. This resulted in ambiguous compile
time error.
Code is now simplified and still allows to be used in mocks.

Changes I made should be backwards compatible and work in Xcode 15 as well
---
 Core/URLOpener.swift                          |  8 +++----
 DuckDuckGo/CriticalAlerts.swift               |  4 ++--
 DuckDuckGo/MainViewController+Email.swift     |  2 +-
 DuckDuckGo/NewTabPageViewController.swift     |  6 ++---
 DuckDuckGo/NoMicPermissionAlert.swift         |  2 +-
 DuckDuckGo/SettingsViewModel.swift            | 24 +++++--------------
 .../HeadlessWebViewCoordinator.swift          |  2 +-
 .../SubscriptionSettingsViewModel.swift       |  2 +-
 DuckDuckGo/SyncSettingsViewController.swift   |  2 +-
 DuckDuckGo/TabViewController.swift            |  2 +-
 DuckDuckGoTests/MockURLOpener.swift           |  2 +-
 .../SyncUI/Views/SyncSettingsView.swift       |  4 +---
 12 files changed, 22 insertions(+), 38 deletions(-)

diff --git a/Core/URLOpener.swift b/Core/URLOpener.swift
index d107c8a805..3bcdfb99ca 100644
--- a/Core/URLOpener.swift
+++ b/Core/URLOpener.swift
@@ -21,13 +21,11 @@ import UIKit
 
 public protocol URLOpener: AnyObject {
     func canOpenURL(_ url: URL) -> Bool
-    func open(_ url: URL, options: [UIApplication.OpenExternalURLOptionsKey: Any], completionHandler completion: ((Bool) -> Void)?)
+    func open(_ url: URL)
 }
 
-public extension URLOpener {
-    func open(_ url: URL) {
+extension UIApplication: URLOpener {
+    public func open(_ url: URL) {
         open(url, options: [:], completionHandler: nil)
     }
 }
-
-extension UIApplication: URLOpener {}
diff --git a/DuckDuckGo/CriticalAlerts.swift b/DuckDuckGo/CriticalAlerts.swift
index e9a5c9ebfb..7856f81756 100644
--- a/DuckDuckGo/CriticalAlerts.swift
+++ b/DuckDuckGo/CriticalAlerts.swift
@@ -43,7 +43,7 @@ struct CriticalAlerts {
 
         let openSettingsButton = UIAlertAction(title: UserText.insufficientDiskSpaceAction, style: .default) { _ in
             let url = URL(string: UIApplication.openSettingsURLString)!
-            UIApplication.shared.open(url, options: [:]) { _ in
+            UIApplication.shared.open(url) { _ in
                 fatalError("App is in unrecoverable state")
             }
         }
@@ -59,7 +59,7 @@ struct CriticalAlerts {
 
         let closeButton = UIAlertAction(title: UserText.keyCommandClose, style: .cancel)
         let signInButton = UIAlertAction(title: UserText.emailProtectionSignInAction, style: .default) { _ in
-            UIApplication.shared.open(URL.emailProtectionQuickLink, options: [:], completionHandler: nil)
+            UIApplication.shared.open(URL.emailProtectionQuickLink)
         }
 
         alertController.addAction(closeButton)
diff --git a/DuckDuckGo/MainViewController+Email.swift b/DuckDuckGo/MainViewController+Email.swift
index 8b4bb3421b..884068d937 100644
--- a/DuckDuckGo/MainViewController+Email.swift
+++ b/DuckDuckGo/MainViewController+Email.swift
@@ -26,7 +26,7 @@ extension MainViewController {
 
     func newEmailAddress() {
         guard emailManager.isSignedIn else {
-            UIApplication.shared.open(URL.emailProtectionQuickLink, options: [:], completionHandler: nil)
+            UIApplication.shared.open(URL.emailProtectionQuickLink)
             return
         }
 
diff --git a/DuckDuckGo/NewTabPageViewController.swift b/DuckDuckGo/NewTabPageViewController.swift
index 1a71aeacd6..bb11fcabfc 100644
--- a/DuckDuckGo/NewTabPageViewController.swift
+++ b/DuckDuckGo/NewTabPageViewController.swift
@@ -39,7 +39,7 @@ final class NewTabPageViewController: UIHostingController<NewTabPageView<Favorit
     private let shortcutsModel: ShortcutsModel
     private let shortcutsSettingsModel: NewTabPageShortcutsSettingsModel
     private let sectionsSettingsModel: NewTabPageSectionsSettingsModel
-    private let tab: Tab
+    private let associatedTab: Tab
 
     private var hostingController: UIHostingController<AnyView>?
 
@@ -53,7 +53,7 @@ final class NewTabPageViewController: UIHostingController<NewTabPageView<Favorit
          newTabDialogFactory: any NewTabDaxDialogProvider,
          newTabDialogTypeProvider: NewTabDialogSpecProvider) {
 
-        self.tab = tab
+        self.associatedTab = tab
         self.syncService = syncService
         self.syncBookmarksAdapter = syncBookmarksAdapter
         self.variantManager = variantManager
@@ -82,7 +82,7 @@ final class NewTabPageViewController: UIHostingController<NewTabPageView<Favorit
     override func viewDidAppear(_ animated: Bool) {
         super.viewDidAppear(animated)
 
-        tab.viewed = true
+        associatedTab.viewed = true
 
         presentNextDaxDialog()
 
diff --git a/DuckDuckGo/NoMicPermissionAlert.swift b/DuckDuckGo/NoMicPermissionAlert.swift
index 3adbba0021..8612d56598 100644
--- a/DuckDuckGo/NoMicPermissionAlert.swift
+++ b/DuckDuckGo/NoMicPermissionAlert.swift
@@ -29,7 +29,7 @@ struct NoMicPermissionAlert {
 
         let openSettingsButton = UIAlertAction(title: UserText.noVoicePermissionActionSettings, style: .default) { _ in
             let url = URL(string: UIApplication.openSettingsURLString)!
-            UIApplication.shared.open(url, options: [:], completionHandler: nil)
+            UIApplication.shared.open(url)
         }
         let cancelAction = UIAlertAction(title: UserText.actionCancel, style: .cancel, handler: nil)
 
diff --git a/DuckDuckGo/SettingsViewModel.swift b/DuckDuckGo/SettingsViewModel.swift
index 7fbce016d5..da6ae1abb2 100644
--- a/DuckDuckGo/SettingsViewModel.swift
+++ b/DuckDuckGo/SettingsViewModel.swift
@@ -524,33 +524,23 @@ extension SettingsViewModel {
     }
 
     func openEmailProtection() {
-        UIApplication.shared.open(URL.emailProtectionQuickLink,
-                                  options: [:],
-                                  completionHandler: nil)
+        UIApplication.shared.open(URL.emailProtectionQuickLink)
     }
 
     func openEmailAccountManagement() {
-        UIApplication.shared.open(URL.emailProtectionAccountLink,
-                                  options: [:],
-                                  completionHandler: nil)
+        UIApplication.shared.open(URL.emailProtectionAccountLink)
     }
 
     func openEmailSupport() {
-        UIApplication.shared.open(URL.emailProtectionSupportLink,
-                                  options: [:],
-                                  completionHandler: nil)
+        UIApplication.shared.open(URL.emailProtectionSupportLink)
     }
 
     func openOtherPlatforms() {
-        UIApplication.shared.open(URL.apps,
-                                  options: [:],
-                                  completionHandler: nil)
+        UIApplication.shared.open(URL.apps)
     }
 
     func openMoreSearchSettings() {
-        UIApplication.shared.open(URL.searchSettings,
-                                  options: [:],
-                                  completionHandler: nil)
+        UIApplication.shared.open(URL.searchSettings)
     }
 
     var shouldDisplayDuckPlayerContingencyMessage: Bool {
@@ -560,9 +550,7 @@ extension SettingsViewModel {
     func openDuckPlayerContingencyMessageSite() {
         guard let url = duckPlayerContingencyHandler.learnMoreURL else { return }
         Pixel.fire(pixel: .duckPlayerContingencyLearnMoreClicked)
-        UIApplication.shared.open(url,
-                                  options: [:],
-                                  completionHandler: nil)
+        UIApplication.shared.open(url)
     }
 
     @MainActor func openCookiePopupManagement() {
diff --git a/DuckDuckGo/Subscription/AsyncHeadlessWebview/HeadlessWebViewCoordinator.swift b/DuckDuckGo/Subscription/AsyncHeadlessWebview/HeadlessWebViewCoordinator.swift
index 5acd4df139..2cb46b10dc 100644
--- a/DuckDuckGo/Subscription/AsyncHeadlessWebview/HeadlessWebViewCoordinator.swift
+++ b/DuckDuckGo/Subscription/AsyncHeadlessWebview/HeadlessWebViewCoordinator.swift
@@ -164,7 +164,7 @@ extension HeadlessWebViewCoordinator: WKNavigationDelegate {
         
         // Handle custom schemes (e.g., tel:, facetime:, etc.)
         if Constants.externalSchemes.contains(scheme), UIApplication.shared.canOpenURL(url) {
-            UIApplication.shared.open(url, options: [:], completionHandler: nil)
+            UIApplication.shared.open(url)
             decisionHandler(.cancel)
             return
         }
diff --git a/DuckDuckGo/Subscription/ViewModel/SubscriptionSettingsViewModel.swift b/DuckDuckGo/Subscription/ViewModel/SubscriptionSettingsViewModel.swift
index 55d1fdbd25..d6773ece49 100644
--- a/DuckDuckGo/Subscription/ViewModel/SubscriptionSettingsViewModel.swift
+++ b/DuckDuckGo/Subscription/ViewModel/SubscriptionSettingsViewModel.swift
@@ -317,7 +317,7 @@ final class SubscriptionSettingsViewModel: ObservableObject {
     @MainActor
     private func openURL(_ url: URL) {
         if UIApplication.shared.canOpenURL(url) {
-            UIApplication.shared.open(url, options: [:], completionHandler: nil)
+            UIApplication.shared.open(url)
         }
     }
     
diff --git a/DuckDuckGo/SyncSettingsViewController.swift b/DuckDuckGo/SyncSettingsViewController.swift
index d8c64c414a..0c88d0719a 100644
--- a/DuckDuckGo/SyncSettingsViewController.swift
+++ b/DuckDuckGo/SyncSettingsViewController.swift
@@ -407,7 +407,7 @@ extension SyncSettingsViewController: ScanOrPasteCodeViewModelDelegate {
 
     func gotoSettings() {
         if let appSettings = URL(string: UIApplication.openSettingsURLString) {
-            UIApplication.shared.open(appSettings, options: [:], completionHandler: nil)
+            UIApplication.shared.open(appSettings)
         }
     }
 
diff --git a/DuckDuckGo/TabViewController.swift b/DuckDuckGo/TabViewController.swift
index f2922c5556..bb4ea7aee3 100644
--- a/DuckDuckGo/TabViewController.swift
+++ b/DuckDuckGo/TabViewController.swift
@@ -1042,7 +1042,7 @@ class TabViewController: UIViewController {
     private func openExternally(url: URL) {
         self.url = webView.url
         delegate?.tabLoadingStateDidChange(tab: self)
-        UIApplication.shared.open(url, options: [:]) { opened in
+        UIApplication.shared.open(url) { opened in
             if !opened {
                 let addressBarBottom = self.appSettings.currentAddressBarPosition.isBottom
                 ActionMessageView.present(message: UserText.failedToOpenExternally,
diff --git a/DuckDuckGoTests/MockURLOpener.swift b/DuckDuckGoTests/MockURLOpener.swift
index 79a5b9fe6e..1297f14f52 100644
--- a/DuckDuckGoTests/MockURLOpener.swift
+++ b/DuckDuckGoTests/MockURLOpener.swift
@@ -33,7 +33,7 @@ final class MockURLOpener: URLOpener {
         return canOpenURL
     }
 
-    func open(_ url: URL, options: [UIApplication.OpenExternalURLOptionsKey: Any], completionHandler completion: ((Bool) -> Void)?) {
+    func open(_ url: URL) {
         didCallOpenURL = true
         capturedURL = url
     }
diff --git a/LocalPackages/SyncUI/Sources/SyncUI/Views/SyncSettingsView.swift b/LocalPackages/SyncUI/Sources/SyncUI/Views/SyncSettingsView.swift
index d8cd17d5ad..2a8edd6254 100644
--- a/LocalPackages/SyncUI/Sources/SyncUI/Views/SyncSettingsView.swift
+++ b/LocalPackages/SyncUI/Sources/SyncUI/Views/SyncSettingsView.swift
@@ -99,9 +99,7 @@ public struct SyncSettingsView: View {
                     title: Text("Secure Your Device to Use Sync & Backup"),
                     message: Text("A device password is required to use Sync & Backup."),
                     dismissButton: .default(Text("Go to Settings"), action: {
-                        UIApplication.shared.open(URL(string: UIApplication.openSettingsURLString)!,
-                                                  options: [:],
-                                                  completionHandler: nil)
+                        UIApplication.shared.open(URL(string: UIApplication.openSettingsURLString)!)
                         model.shouldShowPasscodeRequiredAlert = false
                     })
                 )