Duck.ai deeplink (#3775)

Task/Issue URL: https://app.asana.com/0/1204167627774280/1208991515313413/f Tech Design URL: CC: **Description**: Add deep-link integration to duck.ai. Opening duck.ai from anywhere should open the custom webview instead of a new tab
duckduckgo · Jan 9, 2025 · b41e8e7 · b41e8e7
1 parent 3618d2e
commit b41e8e7
Show file tree

Hide file tree

Showing 7 changed files with 87 additions and 30 deletions.
diff --git a/Core/FeatureFlag.swift b/Core/FeatureFlag.swift
@@ -48,6 +48,7 @@ public enum FeatureFlag: String {
     case autcompleteTabs
     case textZoom
     case adAttributionReporting
+    case aiChat
 
     /// https://app.asana.com/0/72649045549333/1208231259093710/f
     case networkProtectionUserTips
@@ -137,6 +138,8 @@ extension FeatureFlag: FeatureFlagDescribing {
             return .internalOnly()
         case .freeTrials:
             return .remoteDevelopment(.subfeature(PrivacyProSubfeature.freeTrials))
+        case .aiChat:
+            return .remoteReleasable(.feature(.aiChat))
         }
     }
 }

diff --git a/DuckDuckGo/MainViewController.swift b/DuckDuckGo/MainViewController.swift
@@ -1506,27 +1506,30 @@ class MainViewController: UIViewController {
             }
             .store(in: &emailCancellables)
     }
-    
+
     private func subscribeToURLInterceptorNotifications() {
         NotificationCenter.default.publisher(for: .urlInterceptPrivacyPro)
             .receive(on: DispatchQueue.main)
             .sink { [weak self] notification in
-                switch notification.name {
-                case .urlInterceptPrivacyPro:
-                    let deepLinkTarget: SettingsViewModel.SettingsDeepLinkSection
-                    if let origin = notification.userInfo?[AttributionParameter.origin] as? String {
-                        deepLinkTarget = .subscriptionFlow(origin: origin)
-                    } else {
-                        deepLinkTarget = .subscriptionFlow()
-                    }
-                    self?.launchSettings(deepLinkTarget: deepLinkTarget)
-                default:
-                    return
+                let deepLinkTarget: SettingsViewModel.SettingsDeepLinkSection
+                if let origin = notification.userInfo?[AttributionParameter.origin] as? String {
+                    deepLinkTarget = .subscriptionFlow(origin: origin)
+                } else {
+                    deepLinkTarget = .subscriptionFlow()
                 }
+                self?.launchSettings(deepLinkTarget: deepLinkTarget)
+
+            }
+            .store(in: &urlInterceptorCancellables)
+
+        NotificationCenter.default.publisher(for: .urlInterceptAIChat)
+            .receive(on: DispatchQueue.main)
+            .sink { [weak self] _ in
+                self?.openAIChat()
             }
             .store(in: &urlInterceptorCancellables)
     }
-    
+
     private func subscribeToSettingsDeeplinkNotifications() {
         NotificationCenter.default.publisher(for: .settingsDeepLinkNotification)
             .receive(on: DispatchQueue.main)

diff --git a/DuckDuckGo/TabURLInterceptor.swift b/DuckDuckGo/TabURLInterceptor.swift
@@ -21,9 +21,11 @@ import Foundation
 import BrowserServicesKit
 import Common
 import Subscription
+import AIChat
 
 enum InterceptedURL: String {
     case privacyPro
+    case aiChat
 }
 
 struct InterceptedURLInfo {
@@ -39,31 +41,31 @@ final class TabURLInterceptorDefault: TabURLInterceptor {
 
     typealias CanPurchaseUpdater = () -> Bool
     private let canPurchase: CanPurchaseUpdater
+    private let featureFlagger: FeatureFlagger
 
-    init(canPurchase: @escaping CanPurchaseUpdater) {
+    init(featureFlagger: FeatureFlagger, canPurchase: @escaping CanPurchaseUpdater) {
         self.canPurchase = canPurchase
+        self.featureFlagger = featureFlagger
     }
 
     static let interceptedURLs: [InterceptedURLInfo] = [
         InterceptedURLInfo(id: .privacyPro, path: "/pro")
     ]
 
     func allowsNavigatingTo(url: URL) -> Bool {
-
-        if !url.isPart(ofDomain: "duckduckgo.com") {
-            return true
+        if url.isDuckAIURL {
+            return handleURLInterception(interceptedURL: .aiChat, queryItems: nil)
         }
-
-        guard let components = normalizeScheme(url.absoluteString) else {
-            return true
-        }
-
-        guard let matchingURL = urlToIntercept(path: components.path) else {
+
+        guard url.isPart(ofDomain: "duckduckgo.com"),
+              let components = normalizeScheme(url.absoluteString),
+              let matchingURL = urlToIntercept(path: components.path) else {
             return true
         }
 
         return handleURLInterception(interceptedURL: matchingURL.id, queryItems: components.percentEncodedQueryItems)
     }
+
 }
 
 extension TabURLInterceptorDefault {
@@ -99,11 +101,21 @@ extension TabURLInterceptorDefault {
                 )
                 return false
             }
+        case .aiChat:
+            if featureFlagger.isFeatureOn(.aiChat) {
+                NotificationCenter.default.post(
+                    name: .urlInterceptAIChat,
+                    object: nil,
+                    userInfo: nil
+                )
+                return false
+            }
         }
         return true
     }
 }
 
 extension NSNotification.Name {
     static let urlInterceptPrivacyPro: NSNotification.Name = Notification.Name(rawValue: "com.duckduckgo.notification.urlInterceptPrivacyPro")
+    static let urlInterceptAIChat: NSNotification.Name = Notification.Name(rawValue: "com.duckduckgo.notification.urlInterceptAIChat")
 }
diff --git a/DuckDuckGo/TabViewController.swift b/DuckDuckGo/TabViewController.swift
@@ -132,9 +132,7 @@ class TabViewController: UIViewController {
 
     private var trackersInfoWorkItem: DispatchWorkItem?
 
-    private var tabURLInterceptor: TabURLInterceptor = TabURLInterceptorDefault {
-        return AppDependencyProvider.shared.subscriptionManager.canPurchase
-    }
+    private var tabURLInterceptor: TabURLInterceptor
     private var currentlyLoadedURL: URL?
 
     private let netPConnectionObserver: ConnectionStatusObserver = AppDependencyProvider.shared.connectionObserver
@@ -424,6 +422,10 @@ class TabViewController: UIViewController {
         self.fireproofing = fireproofing
         self.websiteDataManager = websiteDataManager
 
+        self.tabURLInterceptor = TabURLInterceptorDefault(featureFlagger: featureFlagger) {
+            return AppDependencyProvider.shared.subscriptionManager.canPurchase
+        }
+
         super.init(coder: aDecoder)
 
         // Assign itself as tabNavigationHandler for DuckPlayer

diff --git a/DuckDuckGoTests/TabURLInterceptorTests.swift b/DuckDuckGoTests/TabURLInterceptorTests.swift
@@ -28,9 +28,7 @@ class TabURLInterceptorDefaultTests: XCTestCase {
 
     override func setUp() {
         super.setUp()
-        urlInterceptor = TabURLInterceptorDefault(canPurchase: {
-            true
-        })
+        urlInterceptor = TabURLInterceptorDefault(featureFlagger: MockFeatureFlagger(), canPurchase: { true })
     }
 
     override func tearDown() {
@@ -98,4 +96,34 @@ class TabURLInterceptorDefaultTests: XCTestCase {
         waitForExpectations(timeout: 1)
         XCTAssertNil(capturedNotification?.userInfo?[AttributionParameter.origin] as? String)
     }
+
+    func testAllowsNavigationForNonAIChatURL() {
+        let url = URL(string: "https://www.example.com")!
+        XCTAssertTrue(urlInterceptor.allowsNavigatingTo(url: url))
+    }
+
+    func testNotificationForInterceptedAIChatPathWhenFeatureFlagIsOn() {
+        urlInterceptor = TabURLInterceptorDefault(featureFlagger: MockFeatureFlagger(enabledFeatureFlags: [.aiChat]), canPurchase: { true })
+
+        _ = self.expectation(forNotification: .urlInterceptAIChat, object: nil, handler: nil)
+
+        let url = URL(string: "https://duckduckgo.com/?ia=chat")!
+        let canNavigate = urlInterceptor.allowsNavigatingTo(url: url)
+
+        XCTAssertFalse(canNavigate)
+
+        waitForExpectations(timeout: 1) { error in
+            if let error = error {
+                XCTFail("Notification expectation failed: \(error)")
+            }
+        }
+    }
+
+    func testAllowsNavigationForAIChatPathWhenFeatureFlagIsOff() {
+        urlInterceptor = TabURLInterceptorDefault(featureFlagger: MockFeatureFlagger(enabledFeatureFlags: []), canPurchase: { true })
+
+        let url = URL(string: "https://duckduckgo.com/?ia=chat")!
+        XCTAssertTrue(urlInterceptor.allowsNavigatingTo(url: url))
+    }
+
 }
diff --git a/LocalPackages/AIChat/Sources/AIChat/URL+Extension.swift b/LocalPackages/AIChat/Sources/AIChat/URL+Extension.swift
@@ -39,7 +39,7 @@ extension URL {
         return urlComponents.url ?? self
     }
 
-    var isDuckAIURL: Bool {
+    public var isDuckAIURL: Bool {
         guard let host = self.host, host == Constants.duckDuckGoHost else {
             return false
         }

diff --git a/LocalPackages/AIChat/Tests/URLExtensionTests.swift b/LocalPackages/AIChat/Tests/URLExtensionTests.swift
@@ -33,6 +33,7 @@ final class URLExtensionTests: XCTestCase {
         static let duckDuckGoWithMissingQuery = "\(duckDuckGoDomain)/"
         static let duckDuckGoDifferentQuery = "\(duckDuckGoDomain)/?ia=search"
         static let duckDuckGoAdditionalQueryItems = "\(duckDuckGoDomain)/?ia=chat&other=param"
+        static let privacyPro = "\(duckDuckGoDomain)/privacypro"
     }
 
     func testAddingQueryItemToEmptyURL() {
@@ -103,6 +104,14 @@ final class URLExtensionTests: XCTestCase {
         }
     }
 
+    func testPrivacyProURL() {
+        if let url = URL(string: TestURLs.privacyPro) {
+            XCTAssertFalse(url.isDuckAIURL, "The URL should not be identified as a DuckDuckGo AI URL due to the domain.")
+        } else {
+            XCTFail("Failed to create URL from string.")
+        }
+    }
+
     func testIsDuckAIURLWithInvalidDomain() {
         if let url = URL(string: TestURLs.exampleWithExistingQuery) {
             XCTAssertFalse(url.isDuckAIURL, "The URL should not be identified as a DuckDuckGo AI URL due to the domain.")