Files
AgentCompany/builtin-skills/software-engineer/clean-code/references/class-organize-for-change.md
T
ZacharyZhang-NY e74dafcd36 Silence render-disposed spam, unbreak bundled skills, drop board wake
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.
2026-04-20 08:13:48 -04:00

71 lines
1.9 KiB
Markdown

---
title: Organize Classes for Change
impact: MEDIUM
impactDescription: minimizes modification risk when requirements change
tags: class, ocp, change, design
---
## Organize Classes for Change
Classes should be organized so that change is minimally invasive. Following the Open-Closed Principle (OCP): classes should be open for extension but closed for modification.
**Incorrect (must modify class for each new SQL type):**
```java
public class Sql {
public Sql(String table, Column[] columns) { /* ... */ }
public String create() { /* ... */ }
public String insert(Object[] fields) { /* ... */ }
public String selectAll() { /* ... */ }
public String findByKey(String key) { /* ... */ }
// Must modify this class to add update, delete, etc.
// Each change risks breaking existing functionality
}
```
**Correct (extend without modifying):**
```java
public abstract class Sql {
protected String table;
protected Column[] columns;
public Sql(String table, Column[] columns) {
this.table = table;
this.columns = columns;
}
public abstract String generate();
}
public class CreateSql extends Sql {
public CreateSql(String table, Column[] columns) {
super(table, columns);
}
public String generate() { /* CREATE TABLE ... */ }
}
public class InsertSql extends Sql {
private Object[] fields;
public InsertSql(String table, Column[] columns, Object[] fields) {
super(table, columns);
this.fields = fields;
}
public String generate() { /* INSERT INTO ... */ }
}
// Adding UpdateSql doesn't require modifying existing classes
public class UpdateSql extends Sql { /* ... */ }
```
**Benefits:**
- Adding new SQL types = adding new classes
- Existing classes remain untouched
- Each class does one thing
Reference: [Clean Code, Chapter 10: Classes](https://www.oreilly.com/library/view/clean-code-a/9780136083238/)