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.
71 lines
2.2 KiB
Markdown
71 lines
2.2 KiB
Markdown
---
|
|
title: Release Components as Cohesive Units
|
|
impact: HIGH
|
|
impactDescription: enables version tracking, supports parallel team development
|
|
tags: comp, release, versioning, cohesion
|
|
---
|
|
|
|
## Release Components as Cohesive Units
|
|
|
|
Classes grouped into a component should be releasable together. A component should have a version number, release notes, and clear documentation. This is the Reuse/Release Equivalence Principle (REP).
|
|
|
|
**Incorrect (arbitrary grouping):**
|
|
|
|
```text
|
|
shared-lib/
|
|
├── src/
|
|
│ ├── auth/
|
|
│ │ ├── JwtValidator.ts
|
|
│ │ └── PermissionChecker.ts
|
|
│ ├── logging/
|
|
│ │ └── Logger.ts
|
|
│ ├── email/
|
|
│ │ └── EmailSender.ts
|
|
│ └── payment/
|
|
│ └── StripeClient.ts
|
|
└── package.json // version 1.2.3
|
|
|
|
# Version 1.2.4 fixes JWT bug
|
|
# But users of EmailSender must also upgrade
|
|
# Changelog unclear which features affect which users
|
|
```
|
|
|
|
**Correct (cohesive releasable components):**
|
|
|
|
```text
|
|
packages/
|
|
├── auth/
|
|
│ ├── src/
|
|
│ │ ├── JwtValidator.ts
|
|
│ │ ├── PermissionChecker.ts
|
|
│ │ └── index.ts
|
|
│ ├── CHANGELOG.md # Auth-specific changes
|
|
│ └── package.json # @company/auth v2.1.0
|
|
├── logging/
|
|
│ ├── src/
|
|
│ │ └── Logger.ts
|
|
│ ├── CHANGELOG.md
|
|
│ └── package.json # @company/logging v1.0.3
|
|
├── email/
|
|
│ ├── src/
|
|
│ │ └── EmailSender.ts
|
|
│ ├── CHANGELOG.md
|
|
│ └── package.json # @company/email v1.5.0
|
|
└── payments/
|
|
├── src/
|
|
│ └── StripeClient.ts
|
|
├── CHANGELOG.md
|
|
└── package.json # @company/payments v3.0.0
|
|
|
|
# Clear ownership: auth team owns @company/auth
|
|
# Independent versioning: JWT fix only bumps auth
|
|
# Semantic versioning: breaking change in payments doesn't affect others
|
|
```
|
|
|
|
**Benefits:**
|
|
- Teams release independently on their own schedule
|
|
- Version numbers communicate compatibility
|
|
- Changelogs specific to what users of each component care about
|
|
|
|
Reference: [Clean Architecture - Reuse/Release Equivalence Principle](https://www.oreilly.com/library/view/clean-architecture-a/9780134494272/ch13.xhtml)
|