A platform for community discussion. Free, open, simple.
DEV: Make nested scroll restoration spec deterministic (#42096)
Mark VanLandingham5b768a3fa32c
diff --git a/frontend/discourse/app/components/nested.gjs b/frontend/discourse/app/components/nested.gjsindex f310c76295d..77925d775da 100644--- a/frontend/discourse/app/components/nested.gjs+++ b/frontend/discourse/app/components/nested.gjs@@ -39,6 +39,9 @@ const postExcerpt = helper(([post]) => {const MOBILE_ROOT_VIEW_COLLAPSE_DEPTH = 3;const STORED_SCROLL_ANCHORS = Object.create(null);+// Exported so system specs can wait out the full restoration window.+export const SCROLL_RESTORE_WINDOW_MS = 1250;+export default class Nested extends Component {@service appEvents;@service currentUser;@@ -440,7 +443,7 @@ export default class Nested extends Component {}this.#scrollRestoreCompletionTimer = setTimeout(() => {this.#cancelScrollRestoration({ clearAnchor: true });- }, 1250);+ }, SCROLL_RESTORE_WINDOW_MS);});}diff --git a/spec/system/nested_scroll_restoration_spec.rb b/spec/system/nested_scroll_restoration_spec.rbindex cba78674d3c..fcf3d46b223 100644--- a/spec/system/nested_scroll_restoration_spec.rb+++ b/spec/system/nested_scroll_restoration_spec.rb@@ -78,16 +78,21 @@ RSpec.describe "Nested view scroll restoration" donested_view.scroll_to_post(target_post)saved_position = nested_view.current_scroll_position- nested_view.visit_nested(topic)- expect(nested_view).to have_root_post_count(20)-- restored_position = nested_view.current_scroll_position- nested_view.wheel_down.scroll_to_bottom- after_bottom_position = nested_view.current_scroll_position-- expect(restored_position).to be < saved_position- expect(after_bottom_position).to be >= restored_position- expect(nested_view).to have_root_post_count(40)- expect(nested_view.current_scroll_position).to be_within(10).of(after_bottom_position)+ nested_view.with_root_pagination_paused(topic) do |pagination|+ nested_view.visit_nested(topic)+ expect(nested_view).to have_root_post_count(20)+ pagination.wait++ restored_position = nested_view.current_scroll_position+ after_user_scroll_position = nested_view.user_scroll_by(distance: -1000)+ centered_post_number = nested_view.centered_root_post_number+ pagination.resume++ expect(restored_position).to be < saved_position+ expect(after_user_scroll_position).to be < restored_position - 500+ expect(nested_view).to have_root_post_count(40)+ expect(nested_view.scroll_position_after_restore_window).to be < saved_position+ expect(nested_view.centered_root_post_number).to eq(centered_post_number)+ endendenddiff --git a/spec/system/page_objects/cdp.rb b/spec/system/page_objects/cdp.rbindex c94e4125b8e..1f3ea903bc0 100644--- a/spec/system/page_objects/cdp.rb+++ b/spec/system/page_objects/cdp.rb@@ -2,6 +2,34 @@module PageObjectsclass CDP+ class PausedRequest+ def initialize+ @request_started = Queue.new+ @resume_request = Queue.new+ @resumed = false+ end++ def intercept(route, _request)+ @request_started << true+ @resume_request.pop+ route.continue+ end++ def wait+ return if @request_started.pop(timeout: Capybara.default_max_wait_time)++ raise Capybara::ExpectationNotMet, "Timed out waiting for the paused request"+ end++ def resume+ return if @resumed++ @resumed = true+ @resume_request << true+ end+ end+ private_constant :PausedRequest+include Capybara::DSLinclude SystemHelpersinclude RSpec::Matchers@@ -162,5 +190,18 @@ module PageObjectspw_page.unroute(pattern)endend++ def with_paused_request(pattern)+ paused_request = PausedRequest.new+ handler = paused_request.method(:intercept)++ page.driver.with_playwright_page do |pw_page|+ pw_page.route(pattern, handler, times: 1)+ yield(paused_request)+ ensure+ paused_request.resume+ pw_page.unroute(pattern, handler:)+ end+ endendenddiff --git a/spec/system/page_objects/pages/nested_view.rb b/spec/system/page_objects/pages/nested_view.rbindex fe99ceef800..1edceaa83b4 100644--- a/spec/system/page_objects/pages/nested_view.rb+++ b/spec/system/page_objects/pages/nested_view.rb@@ -247,6 +247,11 @@ module PageObjectspage.evaluate_script("window.scrollY")end+ def with_root_pagination_paused(topic, &block)+ pattern = %r{/n/#{Regexp.escape(topic.slug)}/#{topic.id}\.json\?.*\bpage=1(?:&|$)}+ PageObjects::CDP.new.with_paused_request(pattern, &block)+ end+def disable_cloakingpage.execute_script('require("discourse/modifiers/post-stream-viewport-tracker").disableCloaking()',@@ -259,12 +264,57 @@ module PageObjectsselfend- def wheel_down+ def user_scroll_by(distance:)+ start_position = current_scroll_position+page.driver.with_playwright_page do |playwright_page|- playwright_page.mouse.move(200, 200)- playwright_page.mouse.wheel(0, 1000)+ viewport = playwright_page.viewport_size+ playwright_page.mouse.move(viewport[:width] * 0.65, viewport[:height] * 0.5)+ playwright_page.mouse.wheel(0, distance)end- self++ page.evaluate_async_script(<<~JS, start_position)+ const [startPosition, done] = arguments;+ let previousPosition;+ let stableFrames = 0;++ const finishWhenStable = () => {+ const currentPosition = window.scrollY;+ const hasMoved = currentPosition !== startPosition;+ stableFrames =+ hasMoved && currentPosition === previousPosition+ ? stableFrames + 1+ : 0;+ previousPosition = currentPosition;++ if (stableFrames === 2) {+ done(currentPosition);+ } else {+ requestAnimationFrame(finishWhenStable);+ }+ };++ requestAnimationFrame(finishWhenStable);+ JS+ end++ def centered_root_post_number+ page.evaluate_script(<<~JS)+ (() => {+ const roots = document.querySelector(".nested-view__roots");+ const rootsRect = roots.getBoundingClientRect();+ const element = document.elementFromPoint(+ rootsRect.left + rootsRect.width / 2,+ window.innerHeight / 2+ );+ const root = element?.closest(".nested-post");+ const article = root?.querySelector(+ ":scope > .nested-post__main > [data-post-number]"+ );++ return Number(article?.dataset.postNumber);+ })()+ JSenddef scroll_to_post(post)@@ -573,6 +623,14 @@ module PageObjectsJSend+ def scroll_position_after_restore_window+ page.evaluate_async_script(<<~JS)+ const done = arguments[0];+ const { SCROLL_RESTORE_WINDOW_MS } = require("discourse/components/nested");+ setTimeout(() => done(window.scrollY), SCROLL_RESTORE_WINDOW_MS + 50);+ JS+ end+# ── Deletion/recovery assertions ─────────────────────────────def has_deleted_placeholder_for?(post)