vs/draft search perssists (#863)

* vs/draft search perssists

* suggestions test rework

* fix lint

---------

Co-authored-by: Philimon Derib Ayalew <[email protected]>

Author: 2 people

SELECTOR_INFO.md

@@ -2581,6 +2581,13 @@ Location: Any clickable area on the awesome bar
 Path to .json: modules/data/navigation.components.json
 ```
 ```
+Selector name: legacy-search-mode-suggestion-container
+Selector Data: richlistbox[class='autocomplete-richlistbox search-panel-tree']
+Description: Legacy search container
+Location: Any clickable area on the awesome bar
+Path to .json: modules/data/navigation.components.json
+```
+```
 Selector name: results-dropdown
 Selector Data: urlbar-results
 Description: URL bar search results

modules/browser_object_navigation.py

@@ -1,5 +1,6 @@
 import logging
 import re
+import time
 from typing import Literal
 
 from selenium.common.exceptions import StaleElementReferenceException, TimeoutException
@@ -291,6 +292,52 @@ def open_tracker_panel(self) -> BasePage:
         self.get_element("shield-icon").click()
         return self
 
+    def search_and_check_if_suggestions_are_present(
+        self, text, search_mode: str = "awesome", min_suggestions=0
+    ):
+        """
+        Search in the given address bar and check if suggestions are present.
+
+        Args:
+            text (str): Text to search for in the suggestions.
+            search_mode(str): Search mode to use. Can be 'awesome' or 'search'. Defaults to 'awesome'.
+            min_suggestions (int): Minimum number of suggestions to collect.
+        """
+        if search_mode == "awesome":
+            self.clear_awesome_bar()
+            self.type_in_awesome_bar(text)
+            time.sleep(0.5)
+            return self.awesome_bar_has_suggestions()
+        elif search_mode == "search":
+            self.set_search_bar()
+            self.type_in_search_bar(text)
+            return self.search_bar_has_suggestions(min_suggestions)
+        else:
+            raise ValueError("search_mode must be either 'awesome' or 'search'")
+
+    def awesome_bar_has_suggestions(self) -> bool:
+        """Check if the awesome bar has any suggestions."""
+        self.wait_for_suggestions_present(1)
+        suggestions = self.get_all_children("results-dropdown")
+        return len(suggestions) > 2
+
+    @BasePage.context_chrome
+    def search_bar_has_suggestions(self, min_suggestions: int = 0) -> bool:
+        """Check if the legacy search bar has suggestions. if a style has max-height: 0px, then no suggestions are present."""
+        suggestion_container = self.get_element(
+            "legacy-search-mode-suggestion-container"
+        )
+        if min_suggestions > 2:
+            return (
+                suggestion_container.find_element(By.XPATH, "./*[1]").tag_name
+                == "richlistitem"
+            )
+        else:
+            has_children = self.driver.execute_script(
+                "return arguments[0].children.length > 0;", suggestion_container
+            )
+            return has_children
+
     def wait_for_suggestions_present(self, at_least: int = 1):
         """Wait until the suggestion list has at least one visible item."""
         self.set_chrome_context()

modules/data/about_prefs.components.json

@@ -13,6 +13,7 @@
       "searchEngineDropdown"
     ]
   },
+
   "custom-tracker-options-parent": {
     "selectorData": "contentBlockingOptionCustom",
     "strategy": "id",
@@ -168,6 +169,16 @@
     "strategy": "css",
     "groups": []
   },
+  "show-suggestions-in-address-bar": {
+    "selectorData": "showSearchSuggestionsFirstCheckbox",
+    "strategy": "id",
+    "groups": []
+  },
+  "show-suggestions-awesomebar": {
+    "selectorData": "urlBarSuggestion",
+    "strategy": "id",
+    "groups": []
+  },
   "firefox-suggest-nonsponsored": {
     "selectorData": "firefoxSuggestNonsponsored",
     "strategy": "id",

modules/data/customize_firefox.components.json

@@ -28,5 +28,15 @@
         "selectorData": "customization-container",
         "strategy": "id",
         "groups": []
+    },
+    "nav-searchbar": {
+      "selectorData": "search-container",
+      "strategy": "id",
+      "groups": []
+    },
+    "done-button": {
+      "selectorData": "customization-done-button",
+      "strategy": "id",
+      "groups": []
     }
 }

modules/data/navigation.components.json

@@ -29,6 +29,12 @@
         "groups": []
     },
 
+    "legacy-search-mode-suggestion-container": {
+      "selectorData": "richlistbox[class='autocomplete-richlistbox search-panel-tree']",
+      "strategy": "css",
+      "groups": []
+    },
+
     "overflow-item": {
         "selectorData": "[class='urlbarView-title urlbarView-overflowable']",
         "strategy": "css",

modules/page_object_customize_firefox.py

@@ -13,13 +13,13 @@ class CustomizeFirefox(BasePage):
 
     URL_TEMPLATE = ""
 
+    @BasePage.context_chrome
     def add_widget_to_toolbar(
         self, reference: Union[str, tuple, WebElement], labels=[]
     ) -> BasePage:
-        with self.driver.context(self.driver.CONTEXT_CHROME):
-            widget = self.fetch(reference, labels=labels)
-            self.context_click(widget)
-            ContextMenu(self.driver).click_and_hide_menu(
-                "customize-firefox-add-toolbar"
-            )
+        widget = self.fetch(reference, labels=labels)
+        self.context_click(widget)
+        ContextMenu(self.driver).click_and_hide_menu("customize-firefox-add-toolbar")
+        self.element_clickable("nav-searchbar")
+        self.click_on("done-button")
         return self

modules/page_object_prefs.py

@@ -52,6 +52,20 @@ def __init__(self):
 
     # Function Organization
     # Search and Settings
+
+    def select_search_suggestions_in_address_bar(self, value: bool = True) -> BasePage:
+        """
+        Selects the search suggestions in the Address Bar checkbox according to the value given.
+        """
+        checkbox = self.get_element("show-suggestions")
+        awesome_bar_checkbox = self.get_element("show-suggestions-awesomebar")
+        checked = bool(checkbox.get_attribute("checked"))
+        if value != checked:
+            checkbox.click()
+        if value and not awesome_bar_checkbox.get_attribute("checked"):
+            awesome_bar_checkbox.click()
+        return self
+
     def search_engine_dropdown(self) -> Dropdown:
         """Returns the Dropdown region for search engine prefs"""
         return Dropdown(

tests/address_bar_and_search/test_default_search_provider_change_legacy_search_bar.py

@@ -34,15 +34,15 @@ def test_default_search_provider_change_legacy_search_bar(driver: Firefox):
     tabs.new_tab_by_button()
     nav.type_in_search_bar(SEARCH_TERM)
     nav.click_on_change_search_settings_button()
-    driver.switch_to.window(driver.window_handles[2])
+    driver.switch_to.window(driver.window_handles[1])
     assert driver.current_url == SEARCH_SETTINGS_URL
 
     # Step 3: Open site, repeat nav to settings (validates correct tab handling)
     driver.get("https://9gag.com/")
     nav.type_in_search_bar(SEARCH_TERM)
     nav.click_on_change_search_settings_button()
     assert driver.current_url == "https://9gag.com/"
-    driver.switch_to.window(driver.window_handles[3])
+    driver.switch_to.window(driver.window_handles[2])
     assert driver.current_url == SEARCH_SETTINGS_URL
 
     # Step 4: Change the default search engine

tests/address_bar_and_search/test_seach_suggestions_can_be_disabled.py

@@ -0,0 +1,50 @@
+import pytest
+from modules.browser_object import Navigation
+from modules.browser_object_panel_ui import PanelUi
+from modules.page_object_customize_firefox import CustomizeFirefox
+from modules.page_object_prefs import AboutPrefs
+
+RANDOM_TEXT = "cluj"
+
+
+@pytest.fixture()
+def test_case():
+    return "3028773"
+
+
+def test_search_suggestions_pref_affects_urlbar_and_searchbar(driver):
+    nav = Navigation(driver)
+    prefs = AboutPrefs(driver, category="search")
+    panel_ui = PanelUi(driver)
+    customize = CustomizeFirefox(driver)
+
+    # Add legacy search bar to toolbar.
+    panel_ui.open_panel_menu()
+    panel_ui.navigate_to_customize_toolbar()
+    customize.add_widget_to_toolbar("search-bar")
+
+    # --- Step 1: Disable the pref
+    prefs.open()
+    prefs.select_search_suggestions_in_address_bar(False)
+
+    # --- Step 2: Validate NO suggestions when disabled (both in awesome and search bar)
+    for search_mode in ["search", "awesome"]:
+        has_suggestions = nav.search_and_check_if_suggestions_are_present(
+            RANDOM_TEXT, search_mode
+        )
+        assert not has_suggestions, (
+            "Suggestions should be disabled for the Address Bar."
+        )
+
+    # --- Step 3: Re-enable to restore the original state
+    prefs.open()
+    prefs.select_search_suggestions_in_address_bar(True)
+
+    # --- Step 4: Validate that suggestions appear when enabled
+    for search_mode in ["search", "awesome"]:
+        has_suggestions = nav.search_and_check_if_suggestions_are_present(
+            RANDOM_TEXT, search_mode, 3
+        )
+        assert has_suggestions, (
+            f"{search_mode} Suggestions should be visible for the Address Bar when enabled."
+        )