1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
from __future__ import annotations
import re
import unittest
from pathlib import Path
PROJECT_ROOT = Path(__file__).resolve().parent.parent
HOT_PATH_SOURCES = (
PROJECT_ROOT / "src" / "ui.rs",
*sorted((PROJECT_ROOT / "src" / "ui").rglob("*.rs")),
PROJECT_ROOT / "src" / "server" / "render_stream.rs",
)
APP_SERVER_SOURCES = (
*sorted((PROJECT_ROOT / "src" / "app").rglob("*.rs")),
*sorted((PROJECT_ROOT / "src" / "server").rglob("*.rs")),
)
TEST_MODULE = re.compile(r"(?m)^#\[cfg\(test\)\]\s*\nmod\s+\w+\s*\{")
INPUT_STATE_CALL = re.compile(r"(?:\.|::)input_state\b")
KEYBOARD_STATE_ANSI_CALL = re.compile(
r"(?:\.|::)(?:keyboard_state_ansi|kitty_keyboard_state_ansi)\b"
)
AGGREGATE_STATE_CALLS = (
(INPUT_STATE_CALL, "aggregate terminal input state; add a narrow accessor"),
(KEYBOARD_STATE_ANSI_CALL, "formatted keyboard state"),
)
FORBIDDEN_CALLS = (
*AGGREGATE_STATE_CALLS,
(
re.compile(r"(?:\.|::)screen_text_snapshot\b"),
"formatted terminal screen snapshot",
),
(
re.compile(r"\bforeground_job\s*\("),
"process-tree inspection",
),
)
def blank_non_newlines(chars: list[str], start: int, end: int) -> None:
for index in range(start, end):
if chars[index] != "\n":
chars[index] = " "
def mask_comments_and_literals(source: str) -> str:
chars = list(source)
index = 0
while index < len(source):
if source.startswith("//", index):
end = source.find("\n", index + 2)
end = len(source) if end == -1 else end
blank_non_newlines(chars, index, end)
index = end
continue
if source.startswith("/*", index):
depth = 1
end = index + 2
while end < len(source) and depth > 0:
if source.startswith("/*", end):
depth += 1
end += 2
elif source.startswith("*/", end):
depth -= 1
end += 2
else:
end += 1
blank_non_newlines(chars, index, end)
index = end
continue
if source[index] == "r":
quote = index + 1
while quote < len(source) and source[quote] == "#":
quote += 1
if quote < len(source) and source[quote] == '"':
suffix = '"' + "#" * (quote - index - 1)
end = source.find(suffix, quote + 1)
end = len(source) if end == -1 else end + len(suffix)
blank_non_newlines(chars, index, end)
index = end
continue
if source[index] == '"':
end = index + 1
while end < len(source):
if source[end] == "\\":
end += 2
elif source[end] == '"':
end += 1
break
else:
end += 1
blank_non_newlines(chars, index, min(end, len(source)))
index = end
continue
if source[index] == "'":
end = index + 2
if index + 1 < len(source) and source[index + 1] == "\\":
end += 1
if end < len(source) and source[end] == "'":
end += 1
blank_non_newlines(chars, index, end)
index = end
continue
index += 1
return "".join(chars)
def production_code(source: str) -> str:
code = mask_comments_and_literals(source)
chars = list(code)
search_from = 0
while test_module := TEST_MODULE.search(code, search_from):
depth = 0
end = test_module.end() - 1
while end < len(code):
if code[end] == "{":
depth += 1
elif code[end] == "}":
depth -= 1
if depth == 0:
end += 1
break
end += 1
blank_non_newlines(chars, test_module.start(), end)
code = "".join(chars)
search_from = end
return code
def find_violations(paths, rules) -> list[str]:
violations: list[str] = []
for path in paths:
code = production_code(path.read_text(encoding="utf-8"))
for pattern, description in rules:
for match in pattern.finditer(code):
line = code.count("\n", 0, match.start()) + 1
relative_path = path.relative_to(PROJECT_ROOT)
violations.append(f"{relative_path}:{line}: {description}")
return violations
class UiHotPathArchitectureTests(unittest.TestCase):
def test_render_hot_paths_avoid_known_expensive_runtime_queries(self) -> None:
violations = find_violations(HOT_PATH_SOURCES, FORBIDDEN_CALLS)
self.assertEqual(
violations,
[],
"Render/layout code must not perform pane-scaled expensive reads:\n"
+ "\n".join(violations),
)
def test_app_and_server_avoid_aggregate_terminal_state(self) -> None:
self.assertTrue(APP_SERVER_SOURCES, "No app/server Rust sources were discovered")
violations = find_violations(APP_SERVER_SOURCES, AGGREGATE_STATE_CALLS)
self.assertEqual(
violations,
[],
"App/server code must use narrow terminal-state accessors:\n"
+ "\n".join(violations),
)
def test_scanner_ignores_non_production_references(self) -> None:
source = '''
// runtime.input_state()
const EXAMPLE: &str = "runtime.input_state()";
#[cfg(test)]
mod tests {
fn aggregate_state_test() { runtime.input_state(); }
}
fn production_after_tests() {}
'''
code = production_code(source)
self.assertNotRegex(code, FORBIDDEN_CALLS[0][0])
self.assertIn("fn production_after_tests()", code)
self.assertEqual(code.count("\n"), source.count("\n"))
def test_scanner_checks_production_after_test_modules(self) -> None:
source = '''
#[cfg(test)]
mod tests {
const BRACES: &str = "}}";
}
fn render() { TerminalRuntime::input_state; }
'''
self.assertRegex(production_code(source), FORBIDDEN_CALLS[0][0])
def test_scanner_catches_each_aggregate_state_call(self) -> None:
cases = (
("fn render() { runtime.input_state(); }", INPUT_STATE_CALL),
("fn render() { runtime.keyboard_state_ansi(); }", KEYBOARD_STATE_ANSI_CALL),
("fn render() { runtime.kitty_keyboard_state_ansi(); }", KEYBOARD_STATE_ANSI_CALL),
)
for source, pattern in cases:
with self.subTest(source=source):
self.assertRegex(production_code(source), pattern)
def test_scanner_catches_imported_process_query(self) -> None:
source = "fn render() { foreground_job(pid); }"
self.assertRegex(production_code(source), FORBIDDEN_CALLS[3][0])
if __name__ == "__main__":
unittest.main()
|
