session-review.tsx 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542
  1. import { Accordion } from "./accordion"
  2. import { Button } from "./button"
  3. import { DropdownMenu } from "./dropdown-menu"
  4. import { RadioGroup } from "./radio-group"
  5. import { DiffChanges } from "./diff-changes"
  6. import { FileIcon } from "./file-icon"
  7. import { Icon } from "./icon"
  8. import { IconButton } from "./icon-button"
  9. import { StickyAccordionHeader } from "./sticky-accordion-header"
  10. import { Tooltip } from "./tooltip"
  11. import { ScrollView } from "./scroll-view"
  12. import { useFileComponent } from "../context/file"
  13. import { useI18n } from "../context/i18n"
  14. import { getDirectory, getFilename } from "@opencode-ai/util/path"
  15. import { checksum } from "@opencode-ai/util/encode"
  16. import { createEffect, createMemo, For, Match, Show, Switch, untrack, type JSX } from "solid-js"
  17. import { onCleanup } from "solid-js"
  18. import { createStore } from "solid-js/store"
  19. import { type FileContent, type FileDiff } from "@opencode-ai/sdk/v2"
  20. import { PreloadMultiFileDiffResult } from "@pierre/diffs/ssr"
  21. import { type SelectedLineRange } from "@pierre/diffs"
  22. import { Dynamic } from "solid-js/web"
  23. import { mediaKindFromPath } from "../pierre/media"
  24. import { cloneSelectedLineRange, previewSelectedLines } from "../pierre/selection-bridge"
  25. import { createLineCommentController } from "./line-comment-annotations"
  26. const MAX_DIFF_CHANGED_LINES = 500
  27. export type SessionReviewDiffStyle = "unified" | "split"
  28. export type SessionReviewComment = {
  29. id: string
  30. file: string
  31. selection: SelectedLineRange
  32. comment: string
  33. }
  34. export type SessionReviewLineComment = {
  35. file: string
  36. selection: SelectedLineRange
  37. comment: string
  38. preview?: string
  39. }
  40. export type SessionReviewCommentUpdate = SessionReviewLineComment & {
  41. id: string
  42. }
  43. export type SessionReviewCommentDelete = {
  44. id: string
  45. file: string
  46. }
  47. export type SessionReviewCommentActions = {
  48. moreLabel: string
  49. editLabel: string
  50. deleteLabel: string
  51. saveLabel: string
  52. }
  53. export type SessionReviewFocus = { file: string; id: string }
  54. type ReviewDiff = FileDiff & { preloaded?: PreloadMultiFileDiffResult<any> }
  55. export interface SessionReviewProps {
  56. title?: JSX.Element
  57. empty?: JSX.Element
  58. split?: boolean
  59. diffStyle?: SessionReviewDiffStyle
  60. onDiffStyleChange?: (diffStyle: SessionReviewDiffStyle) => void
  61. onDiffRendered?: () => void
  62. onLineComment?: (comment: SessionReviewLineComment) => void
  63. onLineCommentUpdate?: (comment: SessionReviewCommentUpdate) => void
  64. onLineCommentDelete?: (comment: SessionReviewCommentDelete) => void
  65. lineCommentActions?: SessionReviewCommentActions
  66. comments?: SessionReviewComment[]
  67. focusedComment?: SessionReviewFocus | null
  68. onFocusedCommentChange?: (focus: SessionReviewFocus | null) => void
  69. focusedFile?: string
  70. open?: string[]
  71. onOpenChange?: (open: string[]) => void
  72. scrollRef?: (el: HTMLDivElement) => void
  73. onScroll?: JSX.EventHandlerUnion<HTMLDivElement, Event>
  74. class?: string
  75. classList?: Record<string, boolean | undefined>
  76. classes?: { root?: string; header?: string; container?: string }
  77. actions?: JSX.Element
  78. diffs: ReviewDiff[]
  79. onViewFile?: (file: string) => void
  80. readFile?: (path: string) => Promise<FileContent | undefined>
  81. }
  82. function ReviewCommentMenu(props: {
  83. labels: SessionReviewCommentActions
  84. onEdit: VoidFunction
  85. onDelete: VoidFunction
  86. }) {
  87. return (
  88. <div onMouseDown={(event) => event.stopPropagation()} onClick={(event) => event.stopPropagation()}>
  89. <DropdownMenu gutter={4} placement="bottom-end">
  90. <DropdownMenu.Trigger
  91. as={IconButton}
  92. icon="dot-grid"
  93. variant="ghost"
  94. size="small"
  95. class="size-6 rounded-md"
  96. aria-label={props.labels.moreLabel}
  97. />
  98. <DropdownMenu.Portal>
  99. <DropdownMenu.Content>
  100. <DropdownMenu.Item onSelect={props.onEdit}>
  101. <DropdownMenu.ItemLabel>{props.labels.editLabel}</DropdownMenu.ItemLabel>
  102. </DropdownMenu.Item>
  103. <DropdownMenu.Item onSelect={props.onDelete}>
  104. <DropdownMenu.ItemLabel>{props.labels.deleteLabel}</DropdownMenu.ItemLabel>
  105. </DropdownMenu.Item>
  106. </DropdownMenu.Content>
  107. </DropdownMenu.Portal>
  108. </DropdownMenu>
  109. </div>
  110. )
  111. }
  112. function diffId(file: string): string | undefined {
  113. const sum = checksum(file)
  114. if (!sum) return
  115. return `session-review-diff-${sum}`
  116. }
  117. type SessionReviewSelection = {
  118. file: string
  119. range: SelectedLineRange
  120. }
  121. export const SessionReview = (props: SessionReviewProps) => {
  122. let scroll: HTMLDivElement | undefined
  123. let focusToken = 0
  124. const i18n = useI18n()
  125. const fileComponent = useFileComponent()
  126. const anchors = new Map<string, HTMLElement>()
  127. const [store, setStore] = createStore({
  128. open: [] as string[],
  129. force: {} as Record<string, boolean>,
  130. selection: null as SessionReviewSelection | null,
  131. commenting: null as SessionReviewSelection | null,
  132. opened: null as SessionReviewFocus | null,
  133. })
  134. const selection = () => store.selection
  135. const commenting = () => store.commenting
  136. const opened = () => store.opened
  137. const open = () => props.open ?? store.open
  138. const files = createMemo(() => props.diffs.map((diff) => diff.file))
  139. const diffs = createMemo(() => new Map(props.diffs.map((diff) => [diff.file, diff] as const)))
  140. const diffStyle = () => props.diffStyle ?? (props.split ? "split" : "unified")
  141. const hasDiffs = () => files().length > 0
  142. const handleChange = (open: string[]) => {
  143. props.onOpenChange?.(open)
  144. if (props.open !== undefined) return
  145. setStore("open", open)
  146. }
  147. const handleExpandOrCollapseAll = () => {
  148. const next = open().length > 0 ? [] : files()
  149. handleChange(next)
  150. }
  151. const openFileLabel = () => i18n.t("ui.sessionReview.openFile")
  152. const selectionSide = (range: SelectedLineRange) => range.endSide ?? range.side ?? "additions"
  153. const selectionPreview = (diff: FileDiff, range: SelectedLineRange) => {
  154. const side = selectionSide(range)
  155. const contents = side === "deletions" ? diff.before : diff.after
  156. if (typeof contents !== "string" || contents.length === 0) return undefined
  157. return previewSelectedLines(contents, range)
  158. }
  159. createEffect(() => {
  160. const focus = props.focusedComment
  161. if (!focus) return
  162. untrack(() => {
  163. focusToken++
  164. const token = focusToken
  165. setStore("opened", focus)
  166. const comment = (props.comments ?? []).find((c) => c.file === focus.file && c.id === focus.id)
  167. if (comment) setStore("selection", { file: comment.file, range: cloneSelectedLineRange(comment.selection) })
  168. const current = open()
  169. if (!current.includes(focus.file)) {
  170. handleChange([...current, focus.file])
  171. }
  172. const scrollTo = (attempt: number) => {
  173. if (token !== focusToken) return
  174. const root = scroll
  175. if (!root) return
  176. const wrapper = anchors.get(focus.file)
  177. const anchor = wrapper?.querySelector(`[data-comment-id="${focus.id}"]`)
  178. const ready =
  179. anchor instanceof HTMLElement && anchor.style.pointerEvents !== "none" && anchor.style.opacity !== "0"
  180. const target = ready ? anchor : wrapper
  181. if (!target) {
  182. if (attempt >= 120) return
  183. requestAnimationFrame(() => scrollTo(attempt + 1))
  184. return
  185. }
  186. const rootRect = root.getBoundingClientRect()
  187. const targetRect = target.getBoundingClientRect()
  188. const offset = targetRect.top - rootRect.top
  189. const next = root.scrollTop + offset - rootRect.height / 2 + targetRect.height / 2
  190. root.scrollTop = Math.max(0, next)
  191. if (ready) return
  192. if (attempt >= 120) return
  193. requestAnimationFrame(() => scrollTo(attempt + 1))
  194. }
  195. requestAnimationFrame(() => scrollTo(0))
  196. requestAnimationFrame(() => props.onFocusedCommentChange?.(null))
  197. })
  198. })
  199. return (
  200. <div data-component="session-review" class={props.class} classList={props.classList}>
  201. <div data-slot="session-review-header" class={props.classes?.header}>
  202. <div data-slot="session-review-title">
  203. {props.title === undefined ? i18n.t("ui.sessionReview.title") : props.title}
  204. </div>
  205. <div data-slot="session-review-actions">
  206. <Show when={hasDiffs() && props.onDiffStyleChange}>
  207. <RadioGroup
  208. options={["unified", "split"] as const}
  209. current={diffStyle()}
  210. size="small"
  211. value={(style) => style}
  212. label={(style) =>
  213. i18n.t(style === "unified" ? "ui.sessionReview.diffStyle.unified" : "ui.sessionReview.diffStyle.split")
  214. }
  215. onSelect={(style) => style && props.onDiffStyleChange?.(style)}
  216. />
  217. </Show>
  218. <Show when={hasDiffs()}>
  219. <Button
  220. size="small"
  221. icon="chevron-grabber-vertical"
  222. class="w-[106px] justify-start"
  223. onClick={handleExpandOrCollapseAll}
  224. >
  225. <Switch>
  226. <Match when={open().length > 0}>{i18n.t("ui.sessionReview.collapseAll")}</Match>
  227. <Match when={true}>{i18n.t("ui.sessionReview.expandAll")}</Match>
  228. </Switch>
  229. </Button>
  230. </Show>
  231. {props.actions}
  232. </div>
  233. </div>
  234. <ScrollView
  235. data-slot="session-review-scroll"
  236. viewportRef={(el) => {
  237. scroll = el
  238. props.scrollRef?.(el)
  239. }}
  240. onScroll={props.onScroll as any}
  241. classList={{
  242. [props.classes?.root ?? ""]: !!props.classes?.root,
  243. }}
  244. >
  245. <div data-slot="session-review-container" class={props.classes?.container}>
  246. <Show when={hasDiffs()} fallback={props.empty}>
  247. <div class="pb-6">
  248. <Accordion multiple value={open()} onChange={handleChange}>
  249. <For each={files()}>
  250. {(file) => {
  251. let wrapper: HTMLDivElement | undefined
  252. const item = createMemo(() => diffs().get(file)!)
  253. const expanded = createMemo(() => open().includes(file))
  254. const force = () => !!store.force[file]
  255. const comments = createMemo(() => (props.comments ?? []).filter((c) => c.file === file))
  256. const commentedLines = createMemo(() => comments().map((c) => c.selection))
  257. const beforeText = () => (typeof item().before === "string" ? item().before : "")
  258. const afterText = () => (typeof item().after === "string" ? item().after : "")
  259. const changedLines = () => item().additions + item().deletions
  260. const mediaKind = createMemo(() => mediaKindFromPath(file))
  261. const tooLarge = createMemo(() => {
  262. if (!expanded()) return false
  263. if (force()) return false
  264. if (mediaKind()) return false
  265. return changedLines() > MAX_DIFF_CHANGED_LINES
  266. })
  267. const isAdded = () =>
  268. item().status === "added" || (beforeText().length === 0 && afterText().length > 0)
  269. const isDeleted = () =>
  270. item().status === "deleted" || (afterText().length === 0 && beforeText().length > 0)
  271. const selectedLines = createMemo(() => {
  272. const current = selection()
  273. if (!current || current.file !== file) return null
  274. return current.range
  275. })
  276. const draftRange = createMemo(() => {
  277. const current = commenting()
  278. if (!current || current.file !== file) return null
  279. return current.range
  280. })
  281. const commentsUi = createLineCommentController<SessionReviewComment>({
  282. comments,
  283. label: i18n.t("ui.lineComment.submit"),
  284. draftKey: () => file,
  285. state: {
  286. opened: () => {
  287. const current = opened()
  288. if (!current || current.file !== file) return null
  289. return current.id
  290. },
  291. setOpened: (id) => setStore("opened", id ? { file, id } : null),
  292. selected: selectedLines,
  293. setSelected: (range) => setStore("selection", range ? { file, range } : null),
  294. commenting: draftRange,
  295. setCommenting: (range) => setStore("commenting", range ? { file, range } : null),
  296. },
  297. getSide: selectionSide,
  298. clearSelectionOnSelectionEndNull: false,
  299. onSubmit: ({ comment, selection }) => {
  300. props.onLineComment?.({
  301. file,
  302. selection,
  303. comment,
  304. preview: selectionPreview(item(), selection),
  305. })
  306. },
  307. onUpdate: ({ id, comment, selection }) => {
  308. props.onLineCommentUpdate?.({
  309. id,
  310. file,
  311. selection,
  312. comment,
  313. preview: selectionPreview(item(), selection),
  314. })
  315. },
  316. onDelete: (comment) => {
  317. props.onLineCommentDelete?.({
  318. id: comment.id,
  319. file,
  320. })
  321. },
  322. editSubmitLabel: props.lineCommentActions?.saveLabel,
  323. renderCommentActions: props.lineCommentActions
  324. ? (comment, controls) => (
  325. <ReviewCommentMenu
  326. labels={props.lineCommentActions!}
  327. onEdit={controls.edit}
  328. onDelete={controls.remove}
  329. />
  330. )
  331. : undefined,
  332. })
  333. onCleanup(() => {
  334. anchors.delete(file)
  335. })
  336. const handleLineSelected = (range: SelectedLineRange | null) => {
  337. if (!props.onLineComment) return
  338. commentsUi.onLineSelected(range)
  339. }
  340. const handleLineSelectionEnd = (range: SelectedLineRange | null) => {
  341. if (!props.onLineComment) return
  342. commentsUi.onLineSelectionEnd(range)
  343. }
  344. return (
  345. <Accordion.Item
  346. value={file}
  347. id={diffId(file)}
  348. data-file={file}
  349. data-slot="session-review-accordion-item"
  350. data-selected={props.focusedFile === file ? "" : undefined}
  351. >
  352. <StickyAccordionHeader>
  353. <Accordion.Trigger>
  354. <div data-slot="session-review-trigger-content">
  355. <div data-slot="session-review-file-info">
  356. <FileIcon node={{ path: file, type: "file" }} />
  357. <div data-slot="session-review-file-name-container">
  358. <Show when={file.includes("/")}>
  359. <span data-slot="session-review-directory">{`\u202A${getDirectory(file)}\u202C`}</span>
  360. </Show>
  361. <span data-slot="session-review-filename">{getFilename(file)}</span>
  362. <Show when={props.onViewFile}>
  363. <Tooltip value={openFileLabel()} placement="top" gutter={4}>
  364. <button
  365. data-slot="session-review-view-button"
  366. type="button"
  367. aria-label={openFileLabel()}
  368. onClick={(e) => {
  369. e.stopPropagation()
  370. props.onViewFile?.(file)
  371. }}
  372. >
  373. <Icon name="open-file" size="small" />
  374. </button>
  375. </Tooltip>
  376. </Show>
  377. </div>
  378. </div>
  379. <div data-slot="session-review-trigger-actions">
  380. <Switch>
  381. <Match when={isAdded()}>
  382. <div data-slot="session-review-change-group" data-type="added">
  383. <span data-slot="session-review-change" data-type="added">
  384. {i18n.t("ui.sessionReview.change.added")}
  385. </span>
  386. <DiffChanges changes={item()} />
  387. </div>
  388. </Match>
  389. <Match when={isDeleted()}>
  390. <span data-slot="session-review-change" data-type="removed">
  391. {i18n.t("ui.sessionReview.change.removed")}
  392. </span>
  393. </Match>
  394. <Match when={!!mediaKind()}>
  395. <span data-slot="session-review-change" data-type="modified">
  396. {i18n.t("ui.sessionReview.change.modified")}
  397. </span>
  398. </Match>
  399. <Match when={true}>
  400. <DiffChanges changes={item()} />
  401. </Match>
  402. </Switch>
  403. <span data-slot="session-review-diff-chevron">
  404. <Icon name="chevron-down" size="small" />
  405. </span>
  406. </div>
  407. </div>
  408. </Accordion.Trigger>
  409. </StickyAccordionHeader>
  410. <Accordion.Content data-slot="session-review-accordion-content">
  411. <div
  412. data-slot="session-review-diff-wrapper"
  413. ref={(el) => {
  414. wrapper = el
  415. anchors.set(file, el)
  416. }}
  417. >
  418. <Show when={expanded()}>
  419. <Switch>
  420. <Match when={tooLarge()}>
  421. <div data-slot="session-review-large-diff">
  422. <div data-slot="session-review-large-diff-title">
  423. {i18n.t("ui.sessionReview.largeDiff.title")}
  424. </div>
  425. <div data-slot="session-review-large-diff-meta">
  426. {i18n.t("ui.sessionReview.largeDiff.meta", {
  427. limit: MAX_DIFF_CHANGED_LINES.toLocaleString(),
  428. current: changedLines().toLocaleString(),
  429. })}
  430. </div>
  431. <div data-slot="session-review-large-diff-actions">
  432. <Button
  433. size="normal"
  434. variant="secondary"
  435. onClick={() => setStore("force", file, true)}
  436. >
  437. {i18n.t("ui.sessionReview.largeDiff.renderAnyway")}
  438. </Button>
  439. </div>
  440. </div>
  441. </Match>
  442. <Match when={true}>
  443. <Dynamic
  444. component={fileComponent}
  445. mode="diff"
  446. preloadedDiff={item().preloaded}
  447. diffStyle={diffStyle()}
  448. onRendered={() => {
  449. props.onDiffRendered?.()
  450. }}
  451. enableLineSelection={props.onLineComment != null}
  452. enableHoverUtility={props.onLineComment != null}
  453. onLineSelected={handleLineSelected}
  454. onLineSelectionEnd={handleLineSelectionEnd}
  455. onLineNumberSelectionEnd={commentsUi.onLineNumberSelectionEnd}
  456. annotations={commentsUi.annotations()}
  457. renderAnnotation={commentsUi.renderAnnotation}
  458. renderHoverUtility={props.onLineComment ? commentsUi.renderHoverUtility : undefined}
  459. selectedLines={selectedLines()}
  460. commentedLines={commentedLines()}
  461. before={{
  462. name: file,
  463. contents: typeof item().before === "string" ? item().before : "",
  464. }}
  465. after={{
  466. name: file,
  467. contents: typeof item().after === "string" ? item().after : "",
  468. }}
  469. media={{
  470. mode: "auto",
  471. path: file,
  472. before: item().before,
  473. after: item().after,
  474. readFile: props.readFile,
  475. }}
  476. />
  477. </Match>
  478. </Switch>
  479. </Show>
  480. </div>
  481. </Accordion.Content>
  482. </Accordion.Item>
  483. )
  484. }}
  485. </For>
  486. </Accordion>
  487. </div>
  488. </Show>
  489. </div>
  490. </ScrollView>
  491. </div>
  492. )
  493. }