Live

1"""Live views of a run.
2
3COMPARE_LIVE=1 (default): compare.py serves a live page (live_server.py). COMPARE_LIVE=0 turns it off.
4COMPARE_LIVE_WINDOWS=1 also opens the Instance AI thread in the browser and a terminal window for
5each CLI builder. If a view cannot open, the script prints how to open it.
6COMPARE_RECORD=0 skips the screen recordings that the report replays.
7"""
8
9import shlex
10import shutil
11import subprocess
12import sys
13import webbrowser
14
15from n8n_api import setting
16
17
18def is_on(name, default='1'):
19	return setting(name, default=default).strip().lower() not in ('0', 'false', 'no', 'off')
20
21
22def enabled():
23	return is_on('COMPARE_LIVE')
24
25
26def windows():
27	return enabled() and is_on('COMPARE_LIVE_WINDOWS', default='0')
28
29
30def recording():
31	return is_on('COMPARE_RECORD')
32
33
34def open_url(url):
35	if not windows():
36		return
37	try:
38		opened = webbrowser.open(url)
39	except webbrowser.Error:
40		opened = False
41	if not opened:
42		print(f'open {url} to watch the run', flush=True)
43
44
45def log_window_launchers(command):
46	if sys.platform == 'darwin' and shutil.which('osascript'):
47		# The command goes in as an argument, so it needs no AppleScript quoting.
48		yield ['osascript', '-e', 'on run argv', '-e',
49		       'tell application "Terminal" to do script (item 1 of argv)', '-e', 'end run', command]
50	for terminal, flag in (('x-terminal-emulator', '-e'), ('gnome-terminal', '--'), ('konsole', '-e'), ('xterm', '-e')):
51		if shutil.which(terminal):
52			yield [terminal, flag, 'sh', '-c', command]
53			return
54
55
56def open_terminal(title, command, cols=None, rows=None):
57	"""Open a terminal window with a title that runs a shell command. Returns False if none opened."""
58	if not windows():
59		return True
60	prefix = f"printf '\\033]0;%s\\007' {shlex.quote(title)}; "
61	if cols and rows:
62		# Resize the window so that the full screen of the CLI fits.
63		prefix += f"printf '\\033[8;{rows};{cols}t'; "
64	for launcher in log_window_launchers(prefix + command):
65		# osascript returns at once, but xterm and other emulators run as long as the window is open.
66		# A launcher that still runs after a short wait has opened its window.
67		try:
68			proc = subprocess.Popen(launcher, stdin=subprocess.DEVNULL, stdout=subprocess.DEVNULL,
69			                        stderr=subprocess.DEVNULL, start_new_session=True)
70		except OSError:
71			continue
72		try:
73			if proc.wait(timeout=3) == 0:
74				return True
75		except subprocess.TimeoutExpired:
76			return True
77	return False
78
79
80def open_log_window(title, path):
81	"""Open a terminal window that follows the log file at path."""
82	quoted = shlex.quote(str(path))
83	if not open_terminal(title, f'tail -n +1 -f {quoted}'):
84		print(f'watch {title}: tail -f {quoted}', flush=True)