|
1 | 1 | import type * as NodeWorkerThreads from "node:worker_threads"; |
2 | | -import { FileRenderer, getSharedHighlighter, type FileContents } from "@pierre/diffs"; |
| 2 | +import { |
| 3 | + FileRenderer, |
| 4 | + getSharedHighlighter, |
| 5 | + type CodeViewScrollTarget, |
| 6 | + type FileContents, |
| 7 | +} from "@pierre/diffs"; |
3 | 8 | import { useWorkerPool, type CodeViewProps } from "@pierre/diffs/react"; |
4 | 9 | import { WorkerPoolManager, type WorkerRequest, type WorkerResponse } from "@pierre/diffs/worker"; |
5 | | -import { act, useEffect, useState } from "react"; |
| 10 | +import { |
| 11 | + act, |
| 12 | + useEffect, |
| 13 | + useImperativeHandle, |
| 14 | + useLayoutEffect, |
| 15 | + useMemo, |
| 16 | + useRef, |
| 17 | + useState, |
| 18 | + type Ref, |
| 19 | +} from "react"; |
6 | 20 | import { renderToStaticMarkup } from "react-dom/server"; |
7 | 21 | import { create, type ReactTestRenderer } from "react-test-renderer"; |
8 | 22 | import { afterEach, beforeEach, describe, expect, it, vi } from "vite-plus/test"; |
@@ -96,6 +110,7 @@ vi.mock("@pierre/diffs/react", async (importOriginal) => ({ |
96 | 110 | })); |
97 | 111 |
|
98 | 112 | import { StyledDiffCodeView } from "./StyledDiffCodeView"; |
| 113 | +import { useCodeViewFileReveal } from "./useCodeViewFileReveal"; |
99 | 114 |
|
100 | 115 | function FileOutput({ file }: { file: FileContents }) { |
101 | 116 | const pool = useWorkerPool(); |
@@ -320,3 +335,194 @@ describe("code-view worker lifecycle", () => { |
320 | 335 | expect(renderer!.root.findAllByType("pre")).toHaveLength(0); |
321 | 336 | }); |
322 | 337 | }); |
| 338 | + |
| 339 | +type RevealHandle = NonNullable<Parameters<typeof useCodeViewFileReveal>[0]>; |
| 340 | +const revealCalls: { |
| 341 | + scope: string; |
| 342 | + fileKey: string; |
| 343 | + mounted: boolean; |
| 344 | + collapsed: boolean | undefined; |
| 345 | +}[] = []; |
| 346 | + |
| 347 | +function RevealViewer({ |
| 348 | + viewerRef, |
| 349 | + scope, |
| 350 | + collapsed, |
| 351 | +}: { |
| 352 | + viewerRef: Ref<RevealHandle>; |
| 353 | + scope: string; |
| 354 | + collapsed: boolean; |
| 355 | +}) { |
| 356 | + const instance = useRef<{ collapsed: boolean } | undefined>(undefined); |
| 357 | + useLayoutEffect(() => { |
| 358 | + instance.current = { collapsed }; |
| 359 | + return () => { |
| 360 | + instance.current = undefined; |
| 361 | + }; |
| 362 | + }, [collapsed]); |
| 363 | + const handle = useMemo( |
| 364 | + () => ({ |
| 365 | + getInstance: () => instance.current, |
| 366 | + scrollTo: (target: CodeViewScrollTarget) => { |
| 367 | + if (target.type !== "item") return; |
| 368 | + revealCalls.push({ |
| 369 | + scope, |
| 370 | + fileKey: target.id, |
| 371 | + mounted: instance.current !== undefined, |
| 372 | + collapsed: instance.current?.collapsed, |
| 373 | + }); |
| 374 | + }, |
| 375 | + }), |
| 376 | + [scope], |
| 377 | + ); |
| 378 | + useImperativeHandle(viewerRef, () => handle, [handle]); |
| 379 | + return null; |
| 380 | +} |
| 381 | + |
| 382 | +function RevealViews({ |
| 383 | + scope, |
| 384 | + visible, |
| 385 | + selectedFile = null, |
| 386 | + requestId = 0, |
| 387 | +}: { |
| 388 | + scope: string; |
| 389 | + visible: boolean; |
| 390 | + selectedFile?: string | null; |
| 391 | + requestId?: number; |
| 392 | +}) { |
| 393 | + const [viewer, setViewer] = useState<RevealHandle | null>(null); |
| 394 | + const [collapsed, setCollapsed] = useState(true); |
| 395 | + const selectedRequest = useMemo(() => ({ selectedFile, requestId }), [requestId, selectedFile]); |
| 396 | + useEffect(() => { |
| 397 | + if (!selectedRequest.selectedFile || !viewer?.getInstance()) return; |
| 398 | + viewer.scrollTo({ type: "item", id: selectedRequest.selectedFile, align: "start" }); |
| 399 | + }, [selectedRequest, viewer]); |
| 400 | + const revealScope = useMemo(() => ({ scope, selectedRequest }), [scope, selectedRequest]); |
| 401 | + const requestReveal = useCodeViewFileReveal(viewer, revealScope); |
| 402 | + return ( |
| 403 | + <> |
| 404 | + {visible && ( |
| 405 | + <RevealViewer key={scope} viewerRef={setViewer} scope={scope} collapsed={collapsed} /> |
| 406 | + )} |
| 407 | + <button |
| 408 | + onClick={() => { |
| 409 | + setCollapsed(false); |
| 410 | + requestReveal("tree-file"); |
| 411 | + }} |
| 412 | + > |
| 413 | + Reveal file |
| 414 | + </button> |
| 415 | + </> |
| 416 | + ); |
| 417 | +} |
| 418 | + |
| 419 | +describe("code-view file reveals", () => { |
| 420 | + let renderer: ReactTestRenderer | undefined; |
| 421 | + |
| 422 | + beforeEach(() => { |
| 423 | + revealCalls.length = 0; |
| 424 | + vi.stubGlobal("IS_REACT_ACT_ENVIRONMENT", true); |
| 425 | + }); |
| 426 | + |
| 427 | + afterEach(async () => { |
| 428 | + await act(async () => renderer?.unmount()); |
| 429 | + renderer = undefined; |
| 430 | + vi.unstubAllGlobals(); |
| 431 | + }); |
| 432 | + |
| 433 | + it("does not replay a handled tree click or scroll an old handle when a selected file remounts the view", async () => { |
| 434 | + await act(async () => { |
| 435 | + renderer = create(<RevealViews scope="first" visible selectedFile="external-a" />); |
| 436 | + }); |
| 437 | + await act(async () => { |
| 438 | + (renderer!.root.findByType("button").props as { onClick(): void }).onClick(); |
| 439 | + }); |
| 440 | + expect(revealCalls.at(-1)?.fileKey).toBe("tree-file"); |
| 441 | + revealCalls.length = 0; |
| 442 | + |
| 443 | + await act(async () => { |
| 444 | + renderer!.update( |
| 445 | + <RevealViews scope="second" visible selectedFile="external-b" requestId={1} />, |
| 446 | + ); |
| 447 | + }); |
| 448 | + expect(revealCalls).toEqual([ |
| 449 | + { scope: "second", fileKey: "external-b", mounted: true, collapsed: false }, |
| 450 | + ]); |
| 451 | + }); |
| 452 | + |
| 453 | + it("waits for a live viewer and applies each pending tree click only once", async () => { |
| 454 | + await act(async () => { |
| 455 | + renderer = create(<RevealViews scope="diff" visible={false} selectedFile="external" />); |
| 456 | + }); |
| 457 | + await act(async () => { |
| 458 | + (renderer!.root.findByType("button").props as { onClick(): void }).onClick(); |
| 459 | + }); |
| 460 | + expect(revealCalls).toEqual([]); |
| 461 | + |
| 462 | + await act(async () => { |
| 463 | + renderer!.update(<RevealViews scope="diff" visible selectedFile="external" />); |
| 464 | + }); |
| 465 | + expect(revealCalls.map((call) => call.fileKey)).toEqual(["external", "tree-file"]); |
| 466 | + revealCalls.length = 0; |
| 467 | + await act(async () => { |
| 468 | + renderer!.update(<RevealViews scope="diff" visible={false} selectedFile="external" />); |
| 469 | + }); |
| 470 | + await act(async () => { |
| 471 | + renderer!.update(<RevealViews scope="diff" visible selectedFile="external" />); |
| 472 | + }); |
| 473 | + expect(revealCalls).toEqual([ |
| 474 | + { scope: "diff", fileKey: "external", mounted: true, collapsed: false }, |
| 475 | + ]); |
| 476 | + |
| 477 | + revealCalls.length = 0; |
| 478 | + await act(async () => { |
| 479 | + (renderer!.root.findByType("button").props as { onClick(): void }).onClick(); |
| 480 | + renderer!.update(<RevealViews scope="diff" visible={false} selectedFile="external" />); |
| 481 | + }); |
| 482 | + expect(revealCalls).toEqual([]); |
| 483 | + await act(async () => { |
| 484 | + renderer!.update(<RevealViews scope="diff" visible selectedFile="external" />); |
| 485 | + }); |
| 486 | + expect(revealCalls).toEqual([ |
| 487 | + { scope: "diff", fileKey: "external", mounted: true, collapsed: false }, |
| 488 | + { scope: "diff", fileKey: "tree-file", mounted: true, collapsed: false }, |
| 489 | + ]); |
| 490 | + }); |
| 491 | + |
| 492 | + it("cancels pending tree clicks when an external selection or diff scope changes", async () => { |
| 493 | + await act(async () => { |
| 494 | + renderer = create(<RevealViews scope="first" visible={false} selectedFile="external-a" />); |
| 495 | + }); |
| 496 | + await act(async () => { |
| 497 | + (renderer!.root.findByType("button").props as { onClick(): void }).onClick(); |
| 498 | + }); |
| 499 | + await act(async () => { |
| 500 | + renderer!.update( |
| 501 | + <RevealViews scope="first" visible selectedFile="external-b" requestId={1} />, |
| 502 | + ); |
| 503 | + }); |
| 504 | + expect(revealCalls.map((call) => call.fileKey)).toEqual(["external-b"]); |
| 505 | + revealCalls.length = 0; |
| 506 | + |
| 507 | + await act(async () => renderer!.update(<RevealViews scope="first" visible={false} />)); |
| 508 | + await act(async () => { |
| 509 | + (renderer!.root.findByType("button").props as { onClick(): void }).onClick(); |
| 510 | + }); |
| 511 | + await act(async () => renderer!.update(<RevealViews scope="second" visible={false} />)); |
| 512 | + await act(async () => renderer!.update(<RevealViews scope="first" visible />)); |
| 513 | + expect(revealCalls).toEqual([]); |
| 514 | + }); |
| 515 | + |
| 516 | + it("reveals after a collapsed file expands and honors another click on the same file", async () => { |
| 517 | + await act(async () => { |
| 518 | + renderer = create(<RevealViews scope="diff" visible />); |
| 519 | + }); |
| 520 | + const reveal = renderer!.root.findByType("button").props as { onClick(): void }; |
| 521 | + await act(async () => reveal.onClick()); |
| 522 | + await act(async () => reveal.onClick()); |
| 523 | + expect(revealCalls).toEqual([ |
| 524 | + { scope: "diff", fileKey: "tree-file", mounted: true, collapsed: false }, |
| 525 | + { scope: "diff", fileKey: "tree-file", mounted: true, collapsed: false }, |
| 526 | + ]); |
| 527 | + }); |
| 528 | +}); |
0 commit comments