Refactor FXIOS-14456 #31308 ⁃ Fix test failing on XCode 26.2 to enable using this version on LoginHelper (#31611)

* Replace WKFrameInfo with PasswordGeneratorFrameContext + merge origin

* Add back origin with meaningful name and update middle

* Make scriptEvaluator and host non optional

Author: yoanarios

firefox-ios/Client/Frontend/Browser/BrowserViewController/Actions/GeneralBrowserAction.swift

@@ -17,15 +17,15 @@ struct GeneralBrowserAction: Action {
     let showOverlay: Bool?
     let buttonTapped: UIButton?
     let isNativeErrorPage: Bool?
-    let frame: WKFrameInfo?
+    let frameContext: PasswordGeneratorFrameContext?
     let summarizerConfig: SummarizerConfig?
     init(selectedTabURL: URL? = nil,
          isPrivateBrowsing: Bool? = nil,
          toastType: ToastType? = nil,
          showOverlay: Bool? = nil,
          buttonTapped: UIButton? = nil,
          isNativeErrorPage: Bool? = nil,
-         frame: WKFrameInfo? = nil,
+         frameContext: PasswordGeneratorFrameContext? = nil,
          summarizerConfig: SummarizerConfig? = nil,
          windowUUID: WindowUUID,
          actionType: ActionType) {
@@ -37,7 +37,7 @@ struct GeneralBrowserAction: Action {
         self.buttonTapped = buttonTapped
         self.showOverlay = showOverlay
         self.isNativeErrorPage = isNativeErrorPage
-        self.frame = frame
+        self.frameContext = frameContext
         self.summarizerConfig = summarizerConfig
     }
 }

firefox-ios/Client/Frontend/Browser/BrowserViewController/State/BrowserViewControllerState.swift

@@ -48,7 +48,7 @@ struct BrowserViewControllerState: ScreenState {
     var navigateTo: NavigationType? // use default value when re-creating
     var displayView: DisplayType? // use default value when re-creating
     var buttonTapped: UIButton?
-    var frame: WKFrameInfo?
+    var frameContext: PasswordGeneratorFrameContext?
     var microsurveyState: MicrosurveyPromptState
     var navigationDestination: NavigationDestination?
 
@@ -72,7 +72,7 @@ struct BrowserViewControllerState: ScreenState {
                   navigateTo: bvcState.navigateTo,
                   displayView: bvcState.displayView,
                   buttonTapped: bvcState.buttonTapped,
-                  frame: bvcState.frame,
+                  frameContext: bvcState.frameContext,
                   microsurveyState: bvcState.microsurveyState,
                   navigationDestination: bvcState.navigationDestination)
     }
@@ -102,7 +102,7 @@ struct BrowserViewControllerState: ScreenState {
         navigateTo: NavigationType? = nil,
         displayView: DisplayType? = nil,
         buttonTapped: UIButton? = nil,
-        frame: WKFrameInfo? = nil,
+        frameContext: PasswordGeneratorFrameContext? = nil,
         microsurveyState: MicrosurveyPromptState,
         navigationDestination: NavigationDestination? = nil
     ) {
@@ -116,7 +116,7 @@ struct BrowserViewControllerState: ScreenState {
         self.navigateTo = navigateTo
         self.displayView = displayView
         self.buttonTapped = buttonTapped
-        self.frame = frame
+        self.frameContext = frameContext
         self.microsurveyState = microsurveyState
         self.navigationDestination = navigationDestination
     }
@@ -610,7 +610,7 @@ struct BrowserViewControllerState: ScreenState {
             windowUUID: state.windowUUID,
             browserViewType: state.browserViewType,
             displayView: .passwordGenerator,
-            frame: action.frame,
+            frameContext: action.frameContext,
             microsurveyState: MicrosurveyPromptState.reducer(state.microsurveyState, action))
     }
 

firefox-ios/Client/Frontend/Browser/BrowserViewController/Views/BrowserViewController.swift

@@ -2882,8 +2882,8 @@ class BrowserViewController: UIViewController,
         case .summarizer(let config):
             navigationHandler?.showSummarizePanel(.toolbarIcon, config: config)
         case .passwordGenerator:
-            if let tab = tabManager.selectedTab, let frame = state.frame {
-                navigationHandler?.showPasswordGenerator(tab: tab, frame: frame)
+            if let tab = tabManager.selectedTab, let frameContext = state.frameContext {
+                navigationHandler?.showPasswordGenerator(tab: tab, frameContext: frameContext)
             }
         }
     }

firefox-ios/Client/Frontend/PasswordGenerator/PasswordGeneratorAction.swift

@@ -7,11 +7,17 @@ import Redux
 import Common
 import WebKit
 
-struct PasswordGeneratorFrameContext {
+struct PasswordGeneratorFrameContext: Equatable {
     let origin: String?
     let host: String
-    let scriptEvaluator: PasswordGeneratorScriptEvaluator?
+    let scriptEvaluator: PasswordGeneratorScriptEvaluator
     let frameInfo: WKFrameInfo?
+
+    static func == (lhs: PasswordGeneratorFrameContext, rhs: PasswordGeneratorFrameContext) -> Bool {
+        lhs.origin == rhs.origin &&
+        lhs.host == rhs.host &&
+        lhs.frameInfo === rhs.frameInfo
+    }
 }
 
 struct PasswordGeneratorAction: Action {
@@ -23,19 +29,18 @@ struct PasswordGeneratorAction: Action {
 
     // Used in some reducers
     let password: String?
-
-    let origin: String?
+    let loginEntryOrigin: String?
 
     init(windowUUID: WindowUUID,
          actionType: any ActionType,
          password: String? = nil,
          frameContext: PasswordGeneratorFrameContext? = nil,
-         origin: String? = nil) {
+         loginEntryOrigin: String? = nil) {
         self.windowUUID = windowUUID
         self.actionType = actionType
         self.password = password
         self.frameContext = frameContext
-        self.origin = origin
+        self.loginEntryOrigin = loginEntryOrigin
     }
 }
 

firefox-ios/Client/Frontend/PasswordGenerator/PasswordGeneratorMiddleware.swift

@@ -49,7 +49,7 @@ final class PasswordGeneratorMiddleware {
             self.userTappedRefreshPassword(frameContext: frameContext, windowUUID: windowUUID)
 
         case PasswordGeneratorActionType.clearGeneratedPasswordForSite:
-            guard let origin = (action as? PasswordGeneratorAction)?.frameContext?.origin else { return }
+            guard let origin = (action as? PasswordGeneratorAction)?.loginEntryOrigin else { return }
             self.clearGeneratedPasswordForSite(origin: origin, windowUUID: windowUUID)
 
         default:
@@ -84,8 +84,8 @@ final class PasswordGeneratorMiddleware {
                                      completion: @MainActor @escaping (String) -> Void) {
         let originRules = PasswordGeneratorMiddleware.getPasswordRule(for: frameContext.host)
         let jsFunctionCall = "window.__firefox__.logins.generatePassword(\(originRules ?? "" ))"
-        frameContext.scriptEvaluator?.evaluateJavascriptInDefaultContentWorld(jsFunctionCall,
-                                                                              frameContext.frameInfo) { (result, error) in
+        frameContext.scriptEvaluator.evaluateJavascriptInDefaultContentWorld(jsFunctionCall,
+                                                                             frameContext.frameInfo) { (result, error) in
             if let error = error {
                 self.logger.log("JavaScript evaluation error",
                                 level: .warning,
@@ -102,8 +102,8 @@ final class PasswordGeneratorMiddleware {
         guard let escapedPassword = escapeString(string: password) else { return }
 
         let jsFunctionCall = "window.__firefox__.logins.fillGeneratedPassword(\(escapedPassword))"
-        frameContext.scriptEvaluator?.evaluateJavascriptInDefaultContentWorld(jsFunctionCall,
-                                                                              frameContext.frameInfo) { (result, error) in
+        frameContext.scriptEvaluator.evaluateJavascriptInDefaultContentWorld(jsFunctionCall,
+                                                                             frameContext.frameInfo) { (result, error) in
             if error != nil {
                 self.logger.log("Error filling in password info",
                                 level: .warning,

firefox-ios/Client/Frontend/TabContentsScripts/LoginsHelper.swift

@@ -148,6 +148,11 @@ class LoginsHelper: @unchecked Sendable, TabContentScript, FeatureFlaggable {
         if type == "clearAccessoryView" {
             tab?.webView?.accessoryView.reloadViewFor(.standard)
         }
+        let scriptEvaluator = WebKitPasswordGeneratorScriptEvaluator(webView: message.frameInfo.webView)
+        let frameContext = PasswordGeneratorFrameContext(origin: message.frameInfo.webView?.url?.origin,
+                                                         host: message.frameInfo.securityOrigin.host,
+                                                         scriptEvaluator: scriptEvaluator,
+                                                         frameInfo: message.frameInfo)
 
         if type == "generatePassword",
             let tab = self.tab,
@@ -156,7 +161,7 @@ class LoginsHelper: @unchecked Sendable, TabContentScript, FeatureFlaggable {
             let userDefaults = UserDefaults.standard
             let showPasswordGeneratorClosure = {
                 let newAction = GeneralBrowserAction(
-                    frame: message.frameInfo,
+                    frameContext: frameContext,
                     windowUUID: tab.windowUUID,
                     actionType: GeneralBrowserActionType.showPasswordGenerator)
 
@@ -390,7 +395,7 @@ class LoginsHelper: @unchecked Sendable, TabContentScript, FeatureFlaggable {
         if let windowUUID = self.tab?.windowUUID {
             let action = PasswordGeneratorAction(windowUUID: windowUUID,
                                                  actionType: PasswordGeneratorActionType.clearGeneratedPasswordForSite,
-                                                 origin: origin)
+                                                 loginEntryOrigin: origin)
             store.dispatch(action)
         }
     }

firefox-ios/firefox-ios-tests/Tests/ClientTests/BrowserViewControllerStateTests.swift

@@ -62,13 +62,15 @@ final class BrowserViewControllerStateTests: XCTestCase, StoreTestUtility {
     func testShowPasswordGeneratorAction() {
         let initialState = createSubject()
         let reducer = browserViewControllerReducer()
-        let URL = URL(string: "https://foo.com")!
-        let webView = MockWKWebView(URL)
-        let frame = MockWKFrameInfo(webView: webView, frameURL: URL, isMainFrame: true)
+        let mockEvaluator = MockPasswordGeneratorScriptEvaluator()
+        let frameContext = PasswordGeneratorFrameContext(origin: "https://foo.com",
+                                                         host: "foo.com",
+                                                         scriptEvaluator: mockEvaluator,
+                                                         frameInfo: nil)
 
         XCTAssertNil(initialState.displayView)
 
-        let action = GeneralBrowserAction(frame: frame,
+        let action = GeneralBrowserAction(frameContext: frameContext,
                                           windowUUID: .XCTestDefaultUUID,
                                           actionType: GeneralBrowserActionType.showPasswordGenerator)
         let newState = reducer(initialState, action)
@@ -77,7 +79,7 @@ final class BrowserViewControllerStateTests: XCTestCase, StoreTestUtility {
         BrowserViewControllerState.DisplayType.passwordGenerator
 
         XCTAssertEqual(displayView, desiredDisplayView)
-        XCTAssertNotNil(newState.frame)
+        XCTAssertNotNil(newState.frameContext)
     }
 
     func testReloadWebsiteAction() {