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.
78 lines
2.2 KiB
Markdown
78 lines
2.2 KiB
Markdown
---
|
|
title: Structure Should Scream the Domain Not the Framework
|
|
impact: HIGH
|
|
impactDescription: enables understanding at a glance, reveals intent
|
|
tags: comp, screaming-architecture, structure, domain
|
|
---
|
|
|
|
## Structure Should Scream the Domain Not the Framework
|
|
|
|
The folder structure should communicate what the system does, not what framework it uses. Looking at the top-level directories should reveal the business domain.
|
|
|
|
**Incorrect (framework-oriented structure):**
|
|
|
|
```text
|
|
src/
|
|
├── controllers/
|
|
│ ├── UserController.ts
|
|
│ ├── OrderController.ts
|
|
│ └── ProductController.ts
|
|
├── services/
|
|
│ ├── UserService.ts
|
|
│ ├── OrderService.ts
|
|
│ └── ProductService.ts
|
|
├── repositories/
|
|
│ ├── UserRepository.ts
|
|
│ ├── OrderRepository.ts
|
|
│ └── ProductRepository.ts
|
|
├── models/
|
|
│ ├── User.ts
|
|
│ ├── Order.ts
|
|
│ └── Product.ts
|
|
└── utils/
|
|
└── helpers.ts
|
|
|
|
# This screams "MVC framework" not "e-commerce system"
|
|
```
|
|
|
|
**Correct (domain-oriented structure):**
|
|
|
|
```text
|
|
src/
|
|
├── ordering/
|
|
│ ├── domain/
|
|
│ │ ├── Order.ts
|
|
│ │ ├── OrderLine.ts
|
|
│ │ └── OrderStatus.ts
|
|
│ ├── application/
|
|
│ │ ├── PlaceOrderUseCase.ts
|
|
│ │ ├── CancelOrderUseCase.ts
|
|
│ │ └── ports/
|
|
│ │ ├── OrderRepository.ts
|
|
│ │ └── PaymentGateway.ts
|
|
│ └── infrastructure/
|
|
│ ├── PostgresOrderRepository.ts
|
|
│ └── StripePaymentGateway.ts
|
|
├── inventory/
|
|
│ ├── domain/
|
|
│ ├── application/
|
|
│ └── infrastructure/
|
|
├── customers/
|
|
│ ├── domain/
|
|
│ ├── application/
|
|
│ └── infrastructure/
|
|
└── shared/
|
|
└── kernel/
|
|
├── Money.ts
|
|
└── EntityId.ts
|
|
|
|
# This screams "e-commerce with ordering, inventory, customers"
|
|
```
|
|
|
|
**Benefits:**
|
|
- New developers understand the domain immediately
|
|
- Related code lives together, enabling focused changes
|
|
- Frameworks become implementation details, not organizing principles
|
|
|
|
Reference: [Screaming Architecture](https://blog.cleancoder.com/uncle-bob/2011/09/30/Screaming-Architecture.html)
|