allenliang2022
d31a345b17
Address greptile review: the new S.activeStreamId restore branch omitted the _maybeShowNewMessageScrollCue call that the preserveScroll and idle-unpin restore branches both make. An unpinned reader whose position is restored mid-stream should still see the new-message cue, so add it for consistency. Update the behavioral test to assert the cue fires and the test_issue1690 source-lock for the new branch body.
100 lines
5.3 KiB
Python
100 lines
5.3 KiB
Python
from pathlib import Path
|
|
|
|
REPO = Path(__file__).resolve().parents[1]
|
|
UI_JS = (REPO / "static" / "ui.js").read_text(encoding="utf-8")
|
|
MESSAGES_JS = (REPO / "static" / "messages.js").read_text(encoding="utf-8")
|
|
SESSIONS_JS = (REPO / "static" / "sessions.js").read_text(encoding="utf-8")
|
|
|
|
|
|
def _function_body(src: str, name: str) -> str:
|
|
start = src.index(f"function {name}")
|
|
brace = src.index("{", start)
|
|
depth = 0
|
|
for i in range(brace, len(src)):
|
|
if src[i] == "{":
|
|
depth += 1
|
|
elif src[i] == "}":
|
|
depth -= 1
|
|
if depth == 0:
|
|
return src[start : i + 1]
|
|
raise AssertionError(f"function {name} body not found")
|
|
|
|
|
|
def _event_listener_body(src: str, event_name: str) -> str:
|
|
needle = f"source.addEventListener('{event_name}'"
|
|
start = src.index(needle)
|
|
brace = src.index("{", start)
|
|
depth = 0
|
|
for i in range(brace, len(src)):
|
|
if src[i] == "{":
|
|
depth += 1
|
|
elif src[i] == "}":
|
|
depth -= 1
|
|
if depth == 0:
|
|
return src[start : i + 1]
|
|
raise AssertionError(f"event listener {event_name!r} body not found")
|
|
|
|
|
|
def test_terminal_done_render_preserves_manual_scroll_after_active_stream_is_cleared():
|
|
done_block = _event_listener_body(MESSAGES_JS, "done")
|
|
|
|
clear_idx = done_block.index("S.activeStreamId=null")
|
|
render_idx = done_block.index("renderMessages({preserveScroll:true})")
|
|
|
|
assert clear_idx < render_idx, (
|
|
"the done handler should clear stream liveness before the final render, "
|
|
"but must pass preserveScroll so renderMessages does not infer bottom-pin "
|
|
"from S.activeStreamId alone"
|
|
)
|
|
|
|
|
|
def test_render_messages_preserve_scroll_option_uses_user_pin_state_not_stream_liveness():
|
|
render_body = _function_body(UI_JS, "renderMessages")
|
|
scroll_helper = _function_body(UI_JS, "_scrollAfterMessageRender")
|
|
follow_helper = _function_body(UI_JS, "_followMessagesAfterDomReplace")
|
|
|
|
assert "function renderMessages(options)" in render_body
|
|
assert "const preserveScroll=!!(options&&options.preserveScroll);" in render_body
|
|
assert "_scrollAfterMessageRender(preserveScroll, scrollSnapshot);" in render_body
|
|
assert "const scrollSnapshot=(preserveScroll||_messageUserUnpinned)?_captureMessageScrollSnapshot():null" in render_body
|
|
assert "if(preserveScroll){" in scroll_helper
|
|
# #4124: a reader clearly away from the bottom (>250px) is treated as an active
|
|
# reading position, so the forced follow-to-bottom is gated behind it.
|
|
assert "const readerAwayFromBottom=" in scroll_helper
|
|
assert "Number(scrollSnapshot.bottom)>250" in scroll_helper
|
|
assert "// Keep master's follow heuristic" in scroll_helper
|
|
assert "if(!readerAwayFromBottom && !_messageUserUnpinned && _followMessagesAfterDomReplace()) return;\n _restoreMessageScrollSnapshot(scrollSnapshot);\n _maybeShowNewMessageScrollCue(scrollSnapshot);\n return;\n }" in scroll_helper
|
|
assert "_shouldFollowMessagesOnDomReplace()" in follow_helper
|
|
assert "scrollToBottom();" in follow_helper
|
|
# Mid-stream re-render branch (issue: wipe-rows0 scrollHeight-collapse jump-back).
|
|
# An unpinned reader (scrolled up into history) must have their pre-wipe viewport
|
|
# RESTORED — scrollIfPinned() is a no-op for the unpinned case and cannot undo the
|
|
# browser's scrollTop clamp from the inner.innerHTML='' wipe, so it stranded the
|
|
# reader at the top. Pinned/tail-following readers still take scrollIfPinned().
|
|
assert "if(S.activeStreamId){" in scroll_helper
|
|
assert "if(_messageUserUnpinned && scrollSnapshot){\n _restoreMessageScrollSnapshot(scrollSnapshot);\n _maybeShowNewMessageScrollCue(scrollSnapshot);\n return;\n }\n scrollIfPinned();\n return;\n }" in scroll_helper
|
|
|
|
|
|
def test_cached_render_path_uses_same_scroll_policy_as_fresh_render():
|
|
render_body = _function_body(UI_JS, "renderMessages")
|
|
cached_branch = render_body[render_body.index("if(sid&&sid!==_sessionHtmlCacheSid") : render_body.index("const compressionState=")]
|
|
|
|
assert "_scrollAfterMessageRender(preserveScroll, scrollSnapshot);" in cached_branch
|
|
assert "if(S.activeStreamId){scrollIfPinned();}else{scrollToBottom();}" not in cached_branch
|
|
|
|
|
|
def test_session_switch_and_idle_session_load_keep_default_bottom_pin_behavior():
|
|
load_session = _function_body(SESSIONS_JS, "loadSession")
|
|
idle_branch = load_session[load_session.index("}else{\n S.busy=false;") : load_session.index("// Sync context usage indicator")]
|
|
|
|
# #3326: the idle branch now renders with a CONDITIONAL preserveScroll —
|
|
# `renderMessages(sameSessionForceReload?{preserveScroll:true}:undefined)`.
|
|
# For a normal cross-session idle load (currentSid!==sid) sameSessionForceReload
|
|
# is false, so the arg is undefined and the default bottom-pin behavior (#1690)
|
|
# is unchanged. preserveScroll only applies to a same-session external
|
|
# force-refresh (#3239), which is a different code path from #1690's scenario.
|
|
assert "syncTopbar();renderMessages(sameSessionForceReload?{preserveScroll:true}:undefined);" in idle_branch
|
|
# The idle path must NOT unconditionally preserveScroll — it stays bottom-pinned
|
|
# for cross-session loads. Guard against a regression to an always-on preserve.
|
|
assert "renderMessages({preserveScroll:true})" not in idle_branch
|