Add back help-page.goml rustdoc GUI test

[GuillaumeGomez]

Since #127010 was merged, let's see if we can revert #126445...

r? @notriddle

[GuillaumeGomez]

@bors rollup=iffy

[GuillaumeGomez]

If only I could know what's going on in this server...

[GuillaumeGomez]

Like this it works. Makes me sad but better that than not having this test.

[notriddle]

Try this change?

diff --git a/tests/rustdoc-gui/utils.goml b/tests/rustdoc-gui/utils.goml
index 844dc98a537..7bf3fe05772 100644
--- a/tests/rustdoc-gui/utils.goml
+++ b/tests/rustdoc-gui/utils.goml
@@ -13,6 +13,6 @@ define-function: (
         // 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|}
     },
 )

[GuillaumeGomez]

I already tried it in #126436.

[notriddle]

Okay, try this one:

diff --git a/src/librustdoc/html/static/js/settings.js b/src/librustdoc/html/static/js/settings.js
index 2b42fbebb80..176f6f86b20 100644
--- a/src/librustdoc/html/static/js/settings.js
+++ b/src/librustdoc/html/static/js/settings.js
@@ -219,6 +219,9 @@
             document.getElementById(MAIN_ID).appendChild(el);
         } else {
             el.setAttribute("tabindex", "-1");
+            // Don't make the popover visible until after the event handlers are set up.
+            // Otherwise, we get flakey integration tests.
+            el.style.display = "none";
             getSettingsButton().appendChild(el);
         }
         return el;
diff --git a/tests/rustdoc-gui/utils.goml b/tests/rustdoc-gui/utils.goml
index 844dc98a537..ebf0c65bd14 100644
--- a/tests/rustdoc-gui/utils.goml
+++ b/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|}
     },
 )

The interesting part, the change in settings.js, is based on this hypothesis:

1. buildSettingsPage is running synchronously when the script is first run
2. The test harness is instantly clicking the radio button after it becomes visible
3. Then the event handlers are registered in the setTimeout tick below, failing to respond to the form inputs in step 2

To avoid this, I ensure the settings page isn't visible until after the event handlers are registered.

[rustbot]

Some changes occurred in HTML/CSS/JS.

cc @GuillaumeGomez, @jsha

[GuillaumeGomez]

Let's see if it works.

[GuillaumeGomez]

Ah, github actions seems to be having issues. Suspense instensifies

[GuillaumeGomez]

Same failure. Dark magic, really. I have no clue why it just doesn't work in the CI.

[notriddle]

K

@bors r+ rollup=never

[bors]

📌 Commit c8bbeef has been approved by notriddle

It is now in the queue for this repository.

[bors]

⌛ Testing commit c8bbeef with merge ad12a2a...

[bors]

☀️ Test successful - checks-actions
Approved by: notriddle
Pushing ad12a2a to master...

[rust-timer]

Finished benchmarking commit (ad12a2a): comparison URL.

Overall result: no relevant changes - no action needed

@rustbot label: -perf-regression

Instruction count

This benchmark run did not return any relevant results for this metric.

Max RSS (memory usage)

This benchmark run did not return any relevant results for this metric.

Cycles

Results (secondary 4.4%)

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

	mean	range	count
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	4.4%	[3.5%, 6.4%]	4
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-	-	0
All ❌✅ (primary)	-	-	0

Binary size

This benchmark run did not return any relevant results for this metric.

Bootstrap: 696.913s -> 697.036s (0.02%)
Artifact size: 324.66 MiB -> 324.65 MiB (-0.00%)