Reduce flakyness in help.goml

Author: GuillaumeGomez

src/librustdoc/html/static/js/settings.js

@@ -218,6 +218,9 @@
         if (isSettingsPage) {
             document.getElementById(MAIN_ID).appendChild(el);
         } else {
+            // Don't make the popover visible until after the event handlers are set up.
+            // Otherwise, we get flakey integration tests.
+            el.style.display = "none";
             el.setAttribute("tabindex", "-1");
             getSettingsButton().appendChild(el);
         }

tests/rustdoc-gui/help-page.goml

@@ -1,4 +1,5 @@
 // This test ensures that opening the help page in its own tab works.
+include: "utils.goml"
 go-to: "file://" + |DOC_PATH| + "/help.html"
 set-window-size: (1000, 1000) // Try desktop size first.
 wait-for: "#help"
@@ -19,9 +20,7 @@ define-function: (
     "check-colors",
     [theme, color, background, box_shadow],
     block {
-        // FIXME: no clue why we can't call the `switch-theme` function here...
-        set-local-storage: {"rustdoc-theme": |theme|, "rustdoc-use-system-theme": "false"}
-        reload:
+        call-function: ("switch-theme", {"theme": |theme|})
         assert-css: ("#help kbd", {
             "color": |color|,
             "background-color": |background|,

tests/rustdoc-gui/utils.goml

@@ -7,12 +7,12 @@ define-function: (
         // Open the settings menu.
         click: "#settings-menu"
         // Wait for the popover to appear...
-        wait-for: "#settings"
+        wait-for-css: ("#settings", {"display": "block"})
         // Change the setting.
         click: "#theme-"+ |theme|
         // Close the popover.
         click: "#settings-menu"
         // Ensure that the local storage was correctly updated.
-        assert-local-storage: {"rustdoc-theme": |theme|}
+        wait-for-local-storage: {"rustdoc-theme": |theme|}
     },
 )