ZacharyZhang-NY
e74dafcd36
Three independently ugly bugs that all fed the same log flood:
* Electron's `WebFrameMain.send` writes every "Render frame was disposed"
to stderr via `console.error`. When the worker fans a second
agent-event past a reloading renderer, we produced thousands of
identical lines and stalled the main loop on stderr I/O. Added a
`mainFrame.detached` guard so the send is short-circuited before
Electron's own catch block fires, and installed a targeted filter in
`suppress-warnings.ts` (now actually imported from the entry point)
so the specific `console.error("Error sending from webFrameMain:"…)`
noise never reaches the terminal. Any other payload still surfaces.
* `dispatchAgentMessage` accepted the human-reader sentinel as a wake
target when an agent replied to `__board__` — `wakeAgentIfPossible`
then called `db.getAgent("__board__")`, threw, and the dispatcher
kept repeating on every send. Strip `HUMAN_SENDER_ID` at
`resolveMessageWakeTargets`, and keep a defense-in-depth guard in the
heartbeat so a stray caller (future automation fan-out) cannot
reintroduce the crash.
* Pi's skills loader rejects any SKILL.md whose frontmatter `name`
diverges from its parent directory. The four bundled `my-writing-style`
copies declared `name: writing-style-skill`, so every install emitted
a warning and dropped the skill. They also lived as orphan gitlinks
(mode 160000 without .gitmodules), and the global `*.md` gitignore
hid every other SKILL.md from version control. Fixed the frontmatter
to match the dir, converted the dangling submodules to plain trees,
and allowlisted `builtin-skills/**/*.md` so a fresh clone carries the
catalogue instead of silently losing it.
69 lines
2.3 KiB
Markdown
69 lines
2.3 KiB
Markdown
---
|
|
title: Maintain One Level of Abstraction
|
|
impact: CRITICAL
|
|
impactDescription: prevents jarring context switches
|
|
tags: func, abstraction, stepdown, readability
|
|
---
|
|
|
|
## Maintain One Level of Abstraction
|
|
|
|
Statements within a function should all be at the same level of abstraction. Mixing high-level concepts with low-level details is confusing. Code should read like a top-down narrative.
|
|
|
|
**Incorrect (mixed abstraction levels):**
|
|
|
|
```java
|
|
public void analyzeDocument(String documentPath) {
|
|
// High level
|
|
Document document = loadDocument(documentPath);
|
|
|
|
// Low level - string manipulation details
|
|
String text = document.getText();
|
|
text = text.replaceAll("\\s+", " ");
|
|
text = text.toLowerCase();
|
|
String[] words = text.split(" ");
|
|
|
|
// High level again
|
|
WordFrequency frequency = analyzeFrequency(words);
|
|
|
|
// Low level - file I/O details
|
|
FileOutputStream fos = new FileOutputStream("output.txt");
|
|
BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(fos));
|
|
for (Map.Entry<String, Integer> entry : frequency.getEntries()) {
|
|
writer.write(entry.getKey() + ": " + entry.getValue());
|
|
writer.newLine();
|
|
}
|
|
writer.close();
|
|
}
|
|
```
|
|
|
|
**Correct (consistent abstraction level):**
|
|
|
|
```java
|
|
public void analyzeDocument(String documentPath) {
|
|
Document document = loadDocument(documentPath);
|
|
String normalizedText = normalizeText(document);
|
|
WordFrequency frequency = analyzeFrequency(normalizedText);
|
|
saveResults(frequency);
|
|
}
|
|
|
|
private String normalizeText(Document document) {
|
|
String text = document.getText();
|
|
text = collapseWhitespace(text);
|
|
text = toLowerCase(text);
|
|
return text;
|
|
}
|
|
|
|
private void saveResults(WordFrequency frequency) {
|
|
ResultWriter writer = new ResultWriter("output.txt");
|
|
writer.write(frequency);
|
|
}
|
|
```
|
|
|
|
Read the code from top to bottom. Each function introduces the next level of abstraction.
|
|
|
|
**When mixing levels is acceptable:**
|
|
- Short utility functions (under 10 lines) that perform one task can mix levels without confusion. The overhead of extracting one-line helpers often exceeds the readability benefit.
|
|
- Test code frequently mixes setup (low-level) with assertions (high-level) — this is expected and follows the Arrange-Act-Assert pattern.
|
|
|
|
Reference: [Clean Code, Chapter 3: Functions](https://www.oreilly.com/library/view/clean-code-a/9780136083238/)
|