Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 28 additions & 10 deletions packages/app/e2e/session/session-renderer-diagnostics.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,21 @@ async function scrollTimelineToBottom(page: Page) {
expect(found, "session timeline viewport should exist").toBe(true)
}

async function resetTimelineToTop(page: Page) {
const found = await page.evaluate(
({ scrollViewportSelector, turnListSelector }) => {
const list = document.querySelector(turnListSelector)
const viewport = list?.closest(scrollViewportSelector)
if (!(viewport instanceof HTMLElement)) return false
viewport.scrollTop = 0
viewport.dispatchEvent(new Event("scroll", { bubbles: true }))
return true
},
{ scrollViewportSelector, turnListSelector: sessionTurnListSelector },
)
expect(found, "session timeline viewport should exist").toBe(true)
}

async function sendVisiblePrompt(input: { page: Page; text: string }) {
const prompt = input.page.locator(promptSelector)
await expect(prompt).toBeVisible()
Expand Down Expand Up @@ -143,21 +158,24 @@ test("captures renderer diagnostics while guarding send scroll position", async
.locator(sessionMessageItemSelector)
.last()
.evaluate((item) => (item instanceof HTMLElement ? item.dataset.messageId : null))
const metricsBefore = await expectTimelineMetrics(page)
const beforeCount = await page.locator(sessionMessageItemSelector).count()

await sendVisiblePrompt({ page, text: `diagnostics guard ${Date.now()}` })
await expect(page.locator(sessionMessageItemSelector)).toHaveCount(beforeCount + 1, { timeout: 30_000 })
const promptText = `diagnostics guard ${Date.now()}`
await sendVisiblePrompt({ page, text: promptText })
await expect(page.locator(sessionMessageItemSelector).last()).toContainText(promptText, { timeout: 30_000 })
await resetTimelineToTop(page)
await expect.poll(async () => (await expectTimelineMetrics(page)).distanceFromBottom).toBeLessThan(80)

const metricsAfter = await expectTimelineMetrics(page)
const scrollAnchorAfter = await page
.locator(sessionMessageItemSelector)
.nth(beforeCount - 1)
.evaluate((item) => (item instanceof HTMLElement ? item.dataset.messageId : null))
const scrollAnchorAfter = await page.locator(sessionTurnListSelector).evaluate((list, id) => {
if (!(list instanceof HTMLElement) || !id) return null
return Array.from(list.querySelectorAll("[data-message-id]")).some(
(item) => item instanceof HTMLElement && item.dataset.messageId === id,
)
? id
: null
}, scrollAnchorBefore)
expect(scrollAnchorBefore).not.toBeNull()
expect(scrollAnchorAfter).toBe(scrollAnchorBefore)
expect(Math.abs(metricsAfter.top - metricsBefore.top)).toBeLessThan(200)
expect(metricsAfter.distanceFromBottom).toBeLessThan(80)

const events = await readRendererDiagnostics(page)
expect(events.some((event) => event.name === "session.action.submit")).toBe(true)
Expand Down
2 changes: 1 addition & 1 deletion packages/app/src/pages/session.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -627,7 +627,7 @@ export default function Page() {
setScrollRef={setScrollRef}
scheduleScrollState={scheduleScrollState}
autoScroll={autoScroll}
markScrollGesture={activeMessage.markScrollGesture}
markScrollGesture={timelineInteraction.markScrollGesture}
hasScrollGesture={activeMessage.hasScrollGesture}
markUserScroll={activeMessage.markUserScroll}
historyWindow={historyWindow}
Expand Down
73 changes: 73 additions & 0 deletions packages/app/src/pages/session/use-session-scroll-dock.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -291,4 +291,77 @@ describe("session scroll dock", () => {
})
})
})

test("restores a submit-time browser reset while bottom follow is locked", () => {
createRoot((dispose) => {
const scroller = makeScroller({
clientHeight: 400,
scrollHeight: 1000,
scrollTop: 600,
})
const scrollDock = createSessionScrollDock({
clearMessageHash: () => undefined,
clearActiveMessage: () => undefined,
fill: () => undefined,
})

scrollDock.setScrollRef(scroller.el)
scrollDock.resumeScroll()
scroller.el.scrollTop = 0

expect(scrollDock.restoreBottomIfLocked()).toBe(true)
expect(scroller.top).toBe(1000)

dispose()
})
})

test("repairs a locked reset before the next scroll state sample", () => {
createRoot((dispose) => {
const scroller = makeScroller({
clientHeight: 400,
scrollHeight: 1000,
scrollTop: 600,
})
const scrollDock = createSessionScrollDock({
clearMessageHash: () => undefined,
clearActiveMessage: () => undefined,
fill: () => undefined,
})

scrollDock.setScrollRef(scroller.el)
scrollDock.resumeScroll()
scroller.el.scrollTop = 0
scrollDock.scheduleScrollState(scroller.el)

expect(scroller.top).toBe(1000)

dispose()
})
})

test("does not restore after a real scroll gesture cancels the bottom follow lock", () => {
createRoot((dispose) => {
const scroller = makeScroller({
clientHeight: 400,
scrollHeight: 1000,
scrollTop: 600,
})
const scrollDock = createSessionScrollDock({
clearMessageHash: () => undefined,
clearActiveMessage: () => undefined,
fill: () => undefined,
})

scrollDock.setScrollRef(scroller.el)
scrollDock.resumeScroll()
scrollDock.cancelBottomFollowLock()
scroller.el.scrollTop = 0

expect(scrollDock.restoreBottomIfLocked()).toBe(false)
expect(scroller.top).toBe(0)

dispose()
})
})
})
61 changes: 55 additions & 6 deletions packages/app/src/pages/session/use-session-scroll-dock.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { createAutoScroll } from "@opencode-ai/ui/hooks"
import { createEffect, on, onCleanup } from "solid-js"
import { createEffect, createSignal, on, onCleanup } from "solid-js"
import { createStore } from "solid-js/store"

export type SessionScrollState = {
Expand Down Expand Up @@ -106,6 +106,25 @@ export function createSessionScrollDock(input: {
let dockHeight = 0
let scrollStateFrame: number | undefined
let scrollStateTarget: HTMLDivElement | undefined
let bottomFollowLockTimer: ReturnType<typeof setTimeout> | undefined
const [bottomFollowLocked, setBottomFollowLocked] = createSignal(false)

const cancelBottomFollowLock = () => {
if (bottomFollowLockTimer !== undefined) {
clearTimeout(bottomFollowLockTimer)
bottomFollowLockTimer = undefined
}
setBottomFollowLocked(false)
}

const armBottomFollowLock = () => {
if (bottomFollowLockTimer !== undefined) clearTimeout(bottomFollowLockTimer)
setBottomFollowLocked(true)
bottomFollowLockTimer = setTimeout(() => {
bottomFollowLockTimer = undefined
setBottomFollowLocked(false)
}, 3_000)
Comment thread
Astro-Han marked this conversation as resolved.
Resolved
}

const updateScrollState = (el: HTMLDivElement) => {
const next = calculateSessionScrollState({
Expand All @@ -119,6 +138,19 @@ export function createSessionScrollDock(input: {
}

const scheduleScrollState = (el: HTMLDivElement) => {
if (bottomFollowLocked()) {
const next = calculateSessionScrollState({
clientHeight: el.clientHeight,
scrollHeight: el.scrollHeight,
scrollTop: el.scrollTop,
})
if (next.overflow && !next.bottom) {
input.clearActiveMessage()
autoScroll.forceScrollToBottom()
input.clearMessageHash()
}
Comment thread
Astro-Han marked this conversation as resolved.
Resolved
}

scrollStateTarget = el
if (scrollStateFrame !== undefined) return

Expand All @@ -131,12 +163,22 @@ export function createSessionScrollDock(input: {
})
}

const restoreBottomIfLocked = () => {
if (!bottomFollowLocked()) return false
input.clearActiveMessage()
autoScroll.forceScrollToBottom()
input.clearMessageHash()
if (scroller) scheduleScrollState(scroller)
return true
}

const setScrollRef = (el: HTMLDivElement | undefined) => {
scroller = el
autoScroll.scrollRef(el)
if (!el) return
scheduleScrollState(el)
input.fill()
restoreBottomIfLocked()
}

const setContentRef = (el: HTMLDivElement | undefined) => {
Expand All @@ -149,6 +191,7 @@ export function createSessionScrollDock(input: {
contentObserver = new ResizeObserver(() => {
if (scroller) scheduleScrollState(scroller)
input.fill()
restoreBottomIfLocked()
})
contentObserver.observe(el)
}
Expand Down Expand Up @@ -199,17 +242,18 @@ export function createSessionScrollDock(input: {
}

const resumeScroll = () => {
input.clearActiveMessage()
autoScroll.forceScrollToBottom()
input.clearMessageHash()
if (scroller) scheduleScrollState(scroller)
armBottomFollowLock()
restoreBottomIfLocked()
}

createEffect(
on(
autoScroll.userScrolled,
(scrolled) => {
if (scrolled) return
if (scrolled) {
cancelBottomFollowLock()
return
}
input.clearActiveMessage()
input.clearMessageHash()
},
Expand All @@ -221,6 +265,7 @@ export function createSessionScrollDock(input: {
contentObserver?.disconnect()
promptDockObserver?.disconnect()
if (scrollStateFrame !== undefined) cancelAnimationFrame(scrollStateFrame)
if (bottomFollowLockTimer !== undefined) clearTimeout(bottomFollowLockTimer)
document.documentElement.style.removeProperty("--composer-dock-height")
})

Expand All @@ -233,5 +278,9 @@ export function createSessionScrollDock(input: {
setPromptDockRef,
scheduleScrollState,
resumeScroll,
armBottomFollowLock,
restoreBottomIfLocked,
cancelBottomFollowLock,
bottomFollowLocked,
}
}
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import type { UserMessage } from "@opencode-ai/sdk/v2"
import { createEffect, on } from "solid-js"
import { emitRendererDiagnostic } from "@/context/renderer-diagnostics"
import { createSessionActiveMessage } from "@/pages/session/use-session-active-message"
import { useSessionHashScroll } from "@/pages/session/use-session-hash-scroll"
Expand Down Expand Up @@ -44,6 +45,7 @@ export function createSessionTimelineInteraction(input: {
})
const autoScroll = scrollDock.autoScroll
const resumeScroll = scrollDock.resumeScroll
const userScrolledForHistory = () => (scrollDock.bottomFollowLocked() ? false : autoScroll.userScrolled())

activeMessage = createSessionActiveMessage({
sessionKey: input.sessionKey,
Expand All @@ -62,7 +64,7 @@ export function createSessionTimelineInteraction(input: {
historyMore: input.historyMore,
historyLoading: input.historyLoading,
loadMore: input.loadMore,
userScrolled: autoScroll.userScrolled,
userScrolled: userScrolledForHistory,
isAtBottom: () => scrollDock.scroll.bottom,
scroller: scrollDock.scroller,
})
Expand All @@ -84,6 +86,21 @@ export function createSessionTimelineInteraction(input: {
scroller: scrollDock.scroller,
})

const markScrollGesture = (target?: EventTarget | null) => {
scrollDock.cancelBottomFollowLock()
activeMessage.markScrollGesture(target)
}

createEffect(
on(
() => [input.sessionID(), input.visibleUserMessages().at(-1)?.id, historyWindow.turnStart()] as const,
() => {
scrollDock.restoreBottomIfLocked()
},
{ defer: true },
),
)

const hashScroll = useSessionHashScroll({
sessionKey: input.sessionKey,
sessionID: input.sessionID,
Expand Down Expand Up @@ -117,5 +134,6 @@ export function createSessionTimelineInteraction(input: {
scheduleScrollState: scrollDock.scheduleScrollState,
scrollDock,
setScrollRef: scrollDock.setScrollRef,
markScrollGesture,
}
}
Loading