Skip to content

Commit f8b951c

Browse files
authored
fix(session-ui): drive tool and message disclosures through one state machine (#61830)
1 parent 6f725c6 commit f8b951c

7 files changed

Lines changed: 526 additions & 221 deletions

File tree

‎packages/session-ui/src/components/basic-tool.tsx‎

Lines changed: 19 additions & 129 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,10 @@
1-
import {
2-
createEffect,
3-
createMemo,
4-
For,
5-
Match,
6-
on,
7-
onCleanup,
8-
onMount,
9-
Show,
10-
Switch,
11-
type Accessor,
12-
type JSX,
13-
} from "solid-js"
1+
import { createMemo, For, Match, Show, Switch, type Accessor, type JSX } from "solid-js"
142
import { Option, Schema } from "effect"
153
import { useI18n } from "@opencode/ui/context/i18n"
16-
import { createStore } from "solid-js/store"
174
import { Collapsible } from "@opencode/ui/collapsible"
185
import type { IconProps } from "@opencode/ui/icon"
196
import { TextShimmer } from "@opencode/ui/text-shimmer"
7+
import { createDisclosure } from "./disclosure"
208

219
export type TriggerTitle = {
2210
title: string
@@ -58,61 +46,24 @@ export interface BasicToolProps {
5846
action?: JSX.Element
5947
}
6048

61-
const deferredMounts: Array<{ active: boolean; fn: () => void }> = []
62-
63-
let deferredFrame: number | undefined
64-
65-
function flushDeferredMounts() {
66-
while (deferredMounts.length > 0) {
67-
// Timeline tools are mounted top-to-bottom, but the viewport starts at the latest turn.
68-
// Pop from the end so heavy default-open bodies near the bottom become interactive first.
69-
const item = deferredMounts.pop()!
70-
71-
if (item.active) {
72-
deferredFrame = deferredMounts.length > 0 ? requestAnimationFrame(flushDeferredMounts) : undefined
73-
item.fn()
74-
75-
return
76-
}
77-
}
78-
79-
deferredFrame = undefined
80-
}
81-
82-
function scheduleDeferredFlush() {
83-
if (deferredFrame !== undefined) return
84-
deferredFrame = requestAnimationFrame(() => {
85-
deferredFrame = requestAnimationFrame(flushDeferredMounts)
86-
})
87-
}
88-
89-
function scheduleDeferredMount(fn: () => void) {
90-
const item = { active: true, fn }
91-
deferredMounts.push(item)
92-
scheduleDeferredFlush()
93-
94-
return () => {
95-
item.active = false
96-
}
97-
}
98-
99-
function scheduleFrameMount(fn: () => void) {
100-
const frame = requestAnimationFrame(fn)
101-
102-
return () => cancelAnimationFrame(frame)
103-
}
104-
10549
export function BasicTool(props: BasicToolProps) {
106-
const [state, setState] = createStore({
107-
open: props.defaultOpen ?? false,
108-
ready: !props.defer && (props.defaultOpen ?? false),
109-
})
110-
111-
const open = () => props.open ?? state.open
112-
const ready = () => state.ready
11350
const pending = () => props.status === "streaming" || props.status === "running"
11451
const hasChildren = () => props.hasContent ?? (props.defer ? "children" in props : props.children)
11552

53+
const disclosure = createDisclosure({
54+
open: () => props.open,
55+
defaultOpen: () => props.defaultOpen ?? false,
56+
forceOpen: () => props.forceOpen ?? false,
57+
defer: () => props.defer ?? false,
58+
queue: "deferred",
59+
locked: () => props.locked ?? false,
60+
pending,
61+
allowOpenWhilePending: () => props.allowOpenWhilePending ?? false,
62+
onOpenChange: (open) => props.onOpenChange?.(open),
63+
})
64+
65+
const open = disclosure.open
66+
11667
const triggerContent = createMemo(() => {
11768
const value = props.trigger
11869

@@ -131,67 +82,6 @@ export function BasicTool(props: BasicToolProps) {
13182
return isTriggerTitle(value) ? undefined : value
13283
}
13384

134-
let cancelReady: (() => void) | undefined
135-
136-
const cancel = () => {
137-
cancelReady?.()
138-
cancelReady = undefined
139-
}
140-
141-
const scheduleReady = (initial = false) => {
142-
cancel()
143-
cancelReady = (initial ? scheduleDeferredMount : scheduleFrameMount)(() => {
144-
cancelReady = undefined
145-
146-
if (!open()) return
147-
setState("ready", true)
148-
})
149-
}
150-
151-
onCleanup(cancel)
152-
153-
onMount(() => {
154-
if (props.defer && open()) scheduleReady(true)
155-
})
156-
157-
const setOpen = (value: boolean) => {
158-
if (props.open === undefined) setState("open", value)
159-
props.onOpenChange?.(value)
160-
}
161-
162-
createEffect(() => {
163-
if (!props.forceOpen) return
164-
165-
if (open()) return
166-
setOpen(true)
167-
})
168-
169-
createEffect(
170-
on(
171-
open,
172-
(value) => {
173-
if (!props.defer) return
174-
175-
if (!value) {
176-
cancel()
177-
setState("ready", false)
178-
179-
return
180-
}
181-
182-
scheduleReady()
183-
},
184-
{ defer: true },
185-
),
186-
)
187-
188-
const handleOpenChange = (value: boolean) => {
189-
if (pending() && !props.allowOpenWhilePending) return
190-
191-
if (props.locked && !value) return
192-
setOpen(value)
193-
}
194-
19585
const trigger = () => (
19686
<div
19787
data-component="tool-trigger"
@@ -257,7 +147,7 @@ export function BasicTool(props: BasicToolProps) {
257147
</Switch>
258148
</div>
259149
</div>
260-
<Show when={hasChildren() && !props.hideDetails && !props.locked && (!pending() || props.allowOpenWhilePending)}>
150+
<Show when={hasChildren() && !props.hideDetails && disclosure.canToggle()}>
261151
<Collapsible.Arrow />
262152
</Show>
263153
</div>
@@ -266,7 +156,7 @@ export function BasicTool(props: BasicToolProps) {
266156
return (
267157
<Collapsible
268158
open={open()}
269-
onOpenChange={props.locked ? undefined : handleOpenChange}
159+
onOpenChange={props.locked ? undefined : disclosure.setOpen}
270160
class="tool-collapsible"
271161
data-compact={props.compact ? "true" : undefined}
272162
data-rail={props.rail === false ? "false" : undefined}
@@ -314,7 +204,7 @@ export function BasicTool(props: BasicToolProps) {
314204
when={props.locked && open() && !props.defer}
315205
fallback={
316206
<Collapsible.Content>
317-
<Show when={!props.defer || ready()}>{props.children}</Show>
207+
<Show when={!props.defer || disclosure.mounted()}>{props.children}</Show>
318208
</Collapsible.Content>
319209
}
320210
>
Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
import { describe, expect, test } from "bun:test"
2+
import {
3+
createDisclosureState,
4+
transitionDisclosure,
5+
viewDisclosure,
6+
type DisclosureEvent,
7+
type DisclosureProps,
8+
type DisclosureState,
9+
} from "./disclosure-machine"
10+
11+
const free = { locked: false, pending: false, allowOpenWhilePending: false }
12+
13+
const props = (value: Partial<DisclosureProps> = {}): DisclosureProps => ({
14+
open: undefined,
15+
defaultOpen: false,
16+
forceOpen: false,
17+
defer: false,
18+
...value,
19+
})
20+
21+
const sync = (value: Partial<DisclosureProps>): DisclosureEvent => ({ type: "props.sync", props: props(value) })
22+
23+
const toggle = (open: boolean, defer = false, capabilities = free): DisclosureEvent => ({
24+
type: "toggle.requested",
25+
open,
26+
defer,
27+
capabilities,
28+
})
29+
30+
const open = (state: DisclosureState) => viewDisclosure(state, free).open
31+
32+
describe("disclosure", () => {
33+
test("asks a controlled owner to open once per rising forceOpen", () => {
34+
const initial = createDisclosureState(props({ open: false, forceOpen: true }), "frame")
35+
36+
expect(initial.effects).toEqual([{ type: "notify", open: true }])
37+
const repeated = transitionDisclosure(initial.state, sync({ open: false, forceOpen: true }))
38+
39+
expect(repeated.state).toBe(initial.state)
40+
expect(repeated.effects).toEqual([])
41+
const dropped = transitionDisclosure(repeated.state, sync({ open: false }))
42+
const raised = transitionDisclosure(dropped.state, sync({ open: false, forceOpen: true }))
43+
44+
expect(dropped.effects).toEqual([])
45+
expect(raised.effects).toEqual([{ type: "notify", open: true }])
46+
})
47+
48+
test("keeps an uncontrolled disclosure open after forceOpen drops", () => {
49+
const forced = transitionDisclosure(createDisclosureState(props(), "frame").state, sync({ forceOpen: true }))
50+
const kept = transitionDisclosure(forced.state, sync({}))
51+
52+
expect(forced.effects).toEqual([{ type: "notify", open: true }])
53+
expect(open(kept.state)).toBe(true)
54+
})
55+
56+
test("leaves a controlled state to its owner, and falls back to defaultOpen when the owner lets go", () => {
57+
const controlled = createDisclosureState(props({ open: false }), "frame").state
58+
const asked = transitionDisclosure(controlled, toggle(true))
59+
60+
expect(asked.state).toBe(controlled)
61+
expect(asked.effects).toEqual([{ type: "notify", open: true }])
62+
const released = transitionDisclosure(asked.state, sync({ open: undefined, defaultOpen: false }))
63+
64+
expect(released.state).toMatchObject({ status: "closed", control: "uncontrolled", touched: false })
65+
})
66+
67+
test("toggles an uncontrolled disclosure and still tells the owner", () => {
68+
const opened = transitionDisclosure(createDisclosureState(props(), "frame").state, toggle(true))
69+
70+
expect(opened.state).toMatchObject({ status: "open", touched: true })
71+
expect(opened.effects).toEqual([{ type: "notify", open: true }])
72+
expect(open(transitionDisclosure(opened.state, sync({ defaultOpen: false })).state)).toBe(true)
73+
})
74+
75+
test("follows defaultOpen until the user toggles", () => {
76+
const initial = createDisclosureState(props(), "frame").state
77+
const followed = transitionDisclosure(initial, sync({ defaultOpen: true }))
78+
79+
expect(open(followed.state)).toBe(true)
80+
expect(followed.effects).toEqual([])
81+
})
82+
83+
test("never reports a closed body as mounted, and drops the frame of an earlier open", () => {
84+
const initial = createDisclosureState(props({ defaultOpen: true, defer: true }), "deferred")
85+
86+
expect(initial.effects).toEqual([{ type: "schedule-mount", attempt: 1, queue: "deferred" }])
87+
expect(viewDisclosure(initial.state, free).mounted).toBe(false)
88+
const closed = transitionDisclosure(initial.state, toggle(false, true))
89+
90+
expect(closed.effects).toEqual([
91+
{ type: "cancel-mount", attempt: 1 },
92+
{ type: "notify", open: false },
93+
])
94+
expect(viewDisclosure(closed.state, free)).toMatchObject({ open: false, mounted: false })
95+
const reopened = transitionDisclosure(closed.state, toggle(true, true))
96+
97+
expect(reopened.effects).toEqual([
98+
{ type: "schedule-mount", attempt: 2, queue: "frame" },
99+
{ type: "notify", open: true },
100+
])
101+
expect(transitionDisclosure(reopened.state, { type: "mount.ready", attempt: 1 }).state).toBe(reopened.state)
102+
const mounted = transitionDisclosure(reopened.state, { type: "mount.ready", attempt: 2 })
103+
104+
expect(viewDisclosure(mounted.state, free).mounted).toBe(true)
105+
})
106+
107+
test("closes on a controlled prop without waiting for an effect", () => {
108+
const mounted = transitionDisclosure(createDisclosureState(props({ open: true, defer: true }), "frame").state, {
109+
type: "mount.ready",
110+
attempt: 1,
111+
})
112+
113+
const closed = transitionDisclosure(mounted.state, sync({ open: false, defer: true }))
114+
115+
expect(viewDisclosure(closed.state, free)).toMatchObject({ open: false, mounted: false })
116+
})
117+
118+
test("ignores toggles while locked or pending", () => {
119+
const initial = createDisclosureState(props(), "frame").state
120+
const locked = transitionDisclosure(initial, toggle(true, false, { ...free, locked: true }))
121+
const pending = transitionDisclosure(initial, toggle(true, false, { ...free, pending: true }))
122+
123+
const allowed = transitionDisclosure(
124+
initial,
125+
toggle(true, false, { ...free, pending: true, allowOpenWhilePending: true }),
126+
)
127+
128+
expect(locked.state).toBe(initial)
129+
expect(pending.state).toBe(initial)
130+
expect(open(allowed.state)).toBe(true)
131+
expect(viewDisclosure(initial, { ...free, pending: true }).canToggle).toBe(false)
132+
})
133+
134+
test("cancels a scheduled mount on dispose and ignores its frame", () => {
135+
const initial = createDisclosureState(props({ defaultOpen: true, defer: true }), "deferred")
136+
const disposed = transitionDisclosure(initial.state, { type: "disposed" })
137+
138+
expect(disposed.effects).toEqual([{ type: "cancel-mount", attempt: 1 }])
139+
expect(transitionDisclosure(disposed.state, { type: "mount.ready", attempt: 1 }).state).toBe(disposed.state)
140+
})
141+
})

0 commit comments

Comments
 (0)