pi-ext bugabingas pi extensions
owned by bugabinga
README Source History Refs Compare Notes Search demo: add diff-review browser recording
81b0a7582a5bffffe91e28d9a026cd00a0c7eec0
Oliver Jan Krylow <oliver@bugabinga.net > · 27 May 2026
unsigned
Browse files Compare with HEAD
Changed files (9) drivers/diff_review_browser.py Added new file mode 100644 1 + title
= "Diff Review browser" 3 + readme_id
= "diff-review" 5 + (
"Pi bridge" ,
"diff_review_terminal.gif" ),
6 + (
"Browser UI" ,
"diff_review_browser.gif" ),
20 + browser_script
= "extensions/diff-review/scripts/demo-browser.ts" drivers/diff_review_terminal.py Added new file mode 100644 1 + title
= "Diff Review terminal" 3 + readme_id
= "diff-review" 5 + (
"Pi bridge" ,
"diff_review_terminal.gif" ),
6 + (
"Browser UI" ,
"diff_review_browser.gif" ),
21 + "PI_DIFF_REVIEW_NO_OPEN" :
"1" ,
26 + (
"command" ,
"/diff-review --base HEAD~1" ,
8000 ),
extensions/diff-review/README.md Modified 5 + | **Pi bridge** | **Browser UI** |
6 + | --------------------------------------------- | --------------------------------------------- |
7 + |  |  |
3 11 Browser UI for reviewing git diffs and sending findings back to Pi.
extensions/diff-review/__tests__/core.test.ts Modified 7 7 import { parsePatchFiles }
from "@pierre/diffs" ;
8 8 import { parseArgs }
from "../args.js" ;
9 9 import { collectDiff }
from "../git.js" ;
10 + import { openBrowser }
from "../open-browser.js" ;
11 12 const execFileAsync
= promisify (execFile);
12 13 const tempDirs
: string []
= [];
41 + it (
"does not spawn browser openers during tests" ,
async ()
=> {
42 + await expect (
openBrowser (
"http://127.0.0.1:1/" )).resolves.
toEqual ({
44 + error:
"Browser opener disabled" ,
40 48 it (
"preserves staged rename metadata when collecting per-file diffs" ,
async ()
=> {
41 49 const repo
= await tempRepo ();
42 50 await writeFile (
join (repo,
"old.txt" ),
"one\n" );
extensions/diff-review/assets/diff_review_browser.gif Added new file mode 100644Current version contains binary or non-UTF-8 data.
extensions/diff-review/assets/diff_review_terminal.gif Added new file mode 100644Current version contains binary or non-UTF-8 data.
extensions/diff-review/open-browser.ts Modified 3 3 import { spawn }
from "node:child_process" ;
5 5 export async function openBrowser (
7 7 )
: Promise <{ ok
: boolean ; command
?: string ; error
?: string }> {
8 + if (
process .
env .NODE_ENV
=== "test" || process .
env .PI_DIFF_REVIEW_NO_OPEN)
9 + return { ok:
false , error:
"Browser opener disabled" };
8 11 const candidates
= openerCandidates (url);
9 12 for (
const candidate
of candidates) {
10 13 const result
= await trySpawn (candidate.command, candidate.args);
extensions/diff-review/scripts/demo-browser.ts Added new file mode 100644 1 + import { type ChildProcess, execFile, spawn }
from "node:child_process" ;
2 + import { existsSync }
from "node:fs" ;
3 + import { mkdir, mkdtemp, readdir, rm, writeFile }
from "node:fs/promises" ;
4 + import { tmpdir }
from "node:os" ;
5 + import { dirname, join, resolve }
from "node:path" ;
6 + import { fileURLToPath }
from "node:url" ;
7 + import { promisify }
from "node:util" ;
8 + import { parseArgs }
from "../args.js" ;
9 + import { collectDiff }
from "../git.js" ;
10 + import { startReviewServer }
from "../server.js" ;
12 + const execFileAsync
= promisify (execFile);
13 + const EXT_DIR
= dirname (
dirname (
fileURLToPath (
import .
meta .url)));
14 + const ROOT
= dirname (
dirname (EXT_DIR));
18 + const FRAME_DELAY_MS
= 100 ;
19 + const CHROME_COMMANDS
= [
20 + "google-chrome-stable" ,
26 + async function main () {
27 + const out
= outputPath ();
28 + const chrome
= process .
env .CHROME
?? (
await findCommand (CHROME_COMMANDS));
30 + throw new Error (
"Chrome/Chromium not found; set CHROME=/path/to/chrome" );
31 + if (
! (
await findCommand ([
"ffmpeg" ])))
throw new Error (
"ffmpeg not found" );
33 + await execFileAsync (
"bun" , [
"run" ,
"build" ], {
35 + maxBuffer:
20 * 1024 * 1024 ,
38 + const repo
= await mkdtemp (
join (
tmpdir (),
"diff-review-demo-repo-" ));
39 + const profile
= await mkdtemp (
join (
tmpdir (),
"diff-review-demo-chrome-" ));
40 + const frames
= await mkdtemp (
join (
tmpdir (),
"diff-review-demo-frames-" ));
41 + let browser
: ChildProcess | undefined ;
42 + let server
: Awaited <
ReturnType <
typeof startReviewServer>>
| undefined ;
45 + await prepareRepo (repo);
46 + server
= await startReviewServer ({
47 + diff:
await collectDiff (repo,
parseArgs (
"" )),
48 + state: { round:
0 , findings: [], rounds: [] },
53 + const debugPort
= 12_000 + Math .
floor (
Math .
random ()
* 1000 );
54 + browser
= launchChrome (chrome, profile, debugPort, server.url);
55 + const client
= await connectCdp (
56 + (
await waitForTab (debugPort)).webSocketDebuggerUrl,
59 + await client.
call (
"Runtime.enable" );
60 + await client.
call (
"Page.enable" );
61 + await waitForUi (client);
62 + await recordFrames (client, frames);
67 + server?.
close (
"demo" );
68 + browser?.
kill (
"SIGTERM" );
70 + rm (repo, { recursive:
true , force:
true }),
71 + rm (profile, { recursive:
true , force:
true }),
75 + await encodeGif (frames, out);
76 + const count
= (
await readdir (frames)).
filter ((name)
=> 77 + name.
endsWith (
".png" ),
79 + await rm (frames, { recursive:
true , force:
true });
80 + console .
log (
`OK browser demo ${out} (${count} frames)` );
83 + function outputPath () {
84 + const idx
= process .
argv .
indexOf (
"--out" );
85 + if (idx
>= 0 && process .
argv [idx
+ 1 ])
return resolve (
process .
argv [idx
+ 1 ]);
86 + return join (ROOT,
".demo" ,
"diff_review_browser.gif" );
89 + async function prepareRepo (repo
: string ) {
90 + await git (repo, [
"init" ,
"-q" ]);
91 + await git (repo, [
"config" ,
"user.email" ,
"demo@example.invalid" ]);
92 + await git (repo, [
"config" ,
"user.name" ,
"Demo" ]);
93 + await mkdir (
join (repo,
"src" ));
94 + await mkdir (
join (repo,
"test" ));
96 + join (repo,
"src/report.ts" ),
97 + `export function total(items: number[]) {\n\treturn items.reduce((sum, n) => sum + n, 0);\n}\n\nexport function label(name: string) {\n\treturn name.trim();\n}\n` ,
100 + join (repo,
"test/report.test.ts" ),
101 + `import { total } from '../src/report';\n\nconsole.log(total([1, 2]));\n` ,
103 + await git (repo, [
"add" ,
"." ]);
104 + await git (repo, [
"commit" ,
"-qm" ,
"init" ]);
106 + join (repo,
"src/report.ts" ),
107 + `export function total(items: number[]) {\n\treturn items.reduce((sum, n) => sum - n, 0);\n}\n\nexport function label(name: string) {\n\treturn name.trim().toUpperCase();\n}\n` ,
110 + join (repo,
"test/report.test.ts" ),
111 + `import { total } from '../src/report';\n\nconsole.log(total([1, 2, 3]));\n` ,
115 + async function git (cwd
: string , args
: string []) {
116 + await execFileAsync (
"git" , args, { cwd, maxBuffer:
20 * 1024 * 1024 });
119 + function launchChrome (
131 + "--disable-dev-shm-usage" ,
132 + `--remote-debugging-port=${debugPort}` ,
133 + `--user-data-dir=${profile}` ,
134 + `--window-size=${WIDTH},${HEIGHT}` ,
137 + { stdio:
"ignore" },
141 + async function recordFrames (client
: CdpClient , frames
: string ) {
143 + const snap = async (count
: number )
=> {
144 + for (
let i
= 0 ; i
< count; i
++ ) {
145 + const result
= await client.
call (
"Page.captureScreenshot" , {
149 + const data
= result.result?.
data ;
150 + if (
typeof data
!== "string" )
throw new Error (
"screenshot failed" );
152 + join (frames,
`${ String (frame ++ ). padStart (4, "0")}.png` ),
153 + Buffer .
from (data,
"base64" ),
155 + await sleep (FRAME_DELAY_MS);
160 + await client.
eval (
` 161 + document.querySelector('#theme-mode').value = 'dark'; 162 + document.querySelector('#theme-mode').dispatchEvent(new Event('change', { bubbles: true })); 165 + await client.
eval (
` 166 + document.querySelector('#search').value = 'total'; 167 + document.querySelector('#search').dispatchEvent(new Event('input', { bubbles: true })); 171 + await client.
eval (
` 172 + document.querySelector('#search').dispatchEvent(new KeyboardEvent('keydown', { key: 'Enter', bubbles: true })); 176 + await client.
eval (
` 177 + const root = document.querySelector('diffs-container')?.shadowRoot; 178 + const line = root?.querySelector('[data-additions] [data-line]'); 179 + const rect = line?.getBoundingClientRect(); 180 + line?.dispatchEvent(new MouseEvent('click', { 183 + clientX: (rect?.left ?? 300) + 24, 184 + clientY: (rect?.top ?? 300) + 10, 189 + await client.
eval (
` 190 + document.querySelector('#comment').value = 'Demo finding: validate changed total.'; 191 + document.querySelector('#comment').dispatchEvent(new Event('input', { bubbles: true })); 196 + async function encodeGif (frames
: string , out
: string ) {
197 + const palette
= join (frames,
"palette.png" );
198 + await execFileAsync (
205 + join (frames,
"%04d.png" ),
207 + "scale=1000:-1:flags=lanczos,palettegen" ,
210 + { maxBuffer:
20 * 1024 * 1024 },
212 + await execFileAsync (
219 + join (frames,
"%04d.png" ),
223 + "scale=1000:-1:flags=lanczos[x];[x][1:v]paletteuse" ,
226 + { maxBuffer:
20 * 1024 * 1024 },
230 + async function waitForUi (client
: CdpClient ) {
232 + for (
let i
= 0 ; i
< 80 ; i
++ ) {
233 + const ok
= await client.
eval (
` 234 + document.querySelector('diffs-container')?.shadowRoot?.querySelector('[data-additions] [data-line]') !== null 236 + if (ok
=== true )
return ;
239 + throw new Error (
"diff-review UI not ready" );
242 + async function waitForTab (
244 + )
: Promise <{ webSocketDebuggerUrl
: string }> {
245 + for (
let i
= 0 ; i
< 80 ; i
++ ) {
246 + const tab
= await fetch (
`http://127.0.0.1:${port}/json/list` )
247 + .
then ((res)
=> res.
json ()
as Promise <
Array <
Record <
string ,
string >>>)
248 + .
catch (()
=> undefined );
249 + const page
= tab?.
find (
251 + item.
type === "page" && 252 + item.webSocketDebuggerUrl
&& 253 + item.url?.
startsWith (
"http://127.0.0.1" ),
255 + if (page?.webSocketDebuggerUrl) {
256 + return { webSocketDebuggerUrl: page.webSocketDebuggerUrl };
260 + throw new Error (
"Chrome CDP tab not found" );
263 + type CdpResponse = {
266 + result
?: { value
?: unknown };
267 + exceptionDetails
?: { text
?: string };
269 + error
?: { message
?: string };
273 + call (method
: string , params
?: Record <
string ,
unknown >)
: Promise <
CdpResponse >;
274 + eval (expression
: string )
: Promise <
unknown >;
278 + async function connectCdp (url
: string )
: Promise <
CdpClient > {
280 + const ws
= new WebSocket (url);
281 + const pending
= new Map <
number , (value
: CdpResponse )
=> void >();
282 + ws.
onmessage = (event)
=> {
283 + const msg
= JSON .
parse (
String (
event .
data ));
284 + if (
typeof msg.
id !== "number" )
return ;
285 + const resolve
= pending.
get (msg.
id );
286 + if (
! resolve)
return ;
287 + pending.
delete (msg.
id );
290 + await new Promise <
void >((resolve, reject)
=> {
291 + ws.
onopen = ()
=> resolve ();
292 + ws.onerror
= reject;
295 + call (method
: string , params
: Record <
string ,
unknown >
= {}) {
296 + return new Promise <
CdpResponse >((resolve)
=> {
297 + const callId
= ++ id;
298 + pending.
set (callId, resolve);
299 + ws.
send (
JSON .
stringify ({ id: callId, method, params }));
302 + async eval (expression
: string ) {
303 + const response
= await this.
call (
"Runtime.evaluate" , {
305 + returnByValue:
true ,
306 + awaitPromise:
true ,
308 + if (response.error)
309 + throw new Error (response.error.message
?? "CDP error" );
310 + if (response.result?.exceptionDetails)
311 + throw new Error (response.result.exceptionDetails.
text ?? "eval failed" );
312 + return response.result?.result?.
value ;
320 + async function findCommand (commands
: string []) {
321 + for (
const command
of commands) {
322 + const found
= await execFileAsync (
"sh" , [
"-c" ,
`command -v ${command}` ])
323 + .
then ((result)
=> result.stdout.
trim ())
325 + if (found
&& existsSync (found))
return found;
330 + function sleep (ms
: number ) {
331 + return new Promise ((resolve)
=> setTimeout (resolve, ms));
334 + main ().
catch ((err)
=> {
335 + console .
error (err
instanceof Error ? err.message
: String (err));
7 7 import importlib.util
57 58 readme_items:
list [
tuple [
str ,
str ]]
| None 59 + browser_script:
str | None 60 63 def load_module (name:
str ) -> ModuleType:
117 120 raise SystemExit (
f "readme_items entries must be (caption, gif): {item
!r }
" )
122 + browser_script
= getattr (module,
"browser_script" ,
None )
123 + if browser_script
is not None and not isinstance (browser_script,
str ):
124 + raise SystemExit (
"browser_script must be string" )
126 + env
= getattr (module,
"env" , {})
127 + if not isinstance (env,
dict )
or not all (
128 + isinstance (k,
str )
and isinstance (v,
str )
for k, v
in env.items()
130 + raise SystemExit (
"env must be dict[str, str]" )
128 141 readme_id
= readme_id,
129 142 readme_items
= readme_items,
143 + browser_script
= browser_script,
131 146 validate_driver(driver)
170 185 def validate_driver (driver: Driver) ->
None :
186 + if driver.browser_script
and not (ROOT
/ driver.browser_script).exists():
187 + raise SystemExit (
f "browser_script missing: {driver.browser_script}
" )
171 188 for name
in driver.extensions:
172 189 if not (EXTENSIONS
/ name
/ "index.ts" ).exists():
173 190 raise SystemExit (
f "extension missing index.ts: {name}
" )
267 284 child
= pexpect.spawn(
268 285 pi_command(driver),
269 286 cwd
= str (driver.cwd),
287 + env
= {
** os.environ,
** driver.env},
270 288 encoding
= "utf-8" ,
272 290 dimensions
= (driver.rows, driver.cols),
294 312 def record (driver: Driver, gif_out: Path
| None = None ) ->
tuple [Path, Path, Path]:
296 313 OUT.mkdir(exist_ok
= True )
297 314 cast
= OUT
/ f " {driver.name}
.cast" 298 315 gif
= gif_out
or OUT
/ f " {driver.name}
.gif" 299 316 txt
= OUT
/ f " {driver.name}
.txt" 300 317 gif.parent.mkdir(parents
= True , exist_ok
= True )
319 + if driver.browser_script:
321 + [
"bun" ,
str (ROOT
/ driver.browser_script),
"--out" ,
str (gif)],
325 + cast.write_text(
"browser demo: no asciinema cast\n" )
326 + txt.write_text(
"browser demo\n" )
327 + return cast, gif, txt
351 379 def readme_block (driver: Driver) ->
str :
352 380 if driver.readme_items:
353 - headers
= " | " .join(
f "** {caption}
**" for caption, _gif
in driver.readme_items)
354 - separators
= " | " .join(
"---" for _item
in driver.readme_items)
355 - images
= " | " .join(
f "" for caption, gif
in driver.readme_items)
356 - body
= f "| {headers}
|\n| {separators}
|\n| {images}
|" 358 - body
= f "" 381 + headers
= [
f "** {caption}
**" for caption, _gif
in driver.readme_items]
382 + images
= [
f "" for caption, gif
in driver.readme_items]
384 + max (
len (header),
len (image),
3 )
for header, image
in zip (headers, images, strict
= True )
387 + def row (cells:
list [
str ]) ->
str :
388 + padded
= [cell.ljust(width)
for cell, width
in zip (cells, widths, strict
= True )]
389 + return f "| {
' | ' .join(padded)}
|" 391 + separators
= [
"-" * width
for width
in widths]
392 + body
= f " {row(headers)}
\n {row(separators)}
\n {row(images)}
" 394 + f "<!-- demo: {driver.readme_id}
:start -->\n\n" 396 + f "<!-- demo: {driver.readme_id}
:end -->" 398 + body
= f "" 359 399 return f "<!-- demo: {driver.readme_id}
:start -->\n {body}
\n<!-- demo: {driver.readme_id}
:end -->"