opencode-swarm-plugin 0.43.0 → 0.44.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bin/cass.characterization.test.ts +422 -0
- package/bin/swarm.serve.test.ts +6 -4
- package/bin/swarm.test.ts +68 -0
- package/bin/swarm.ts +81 -8
- package/dist/compaction-prompt-scoring.js +139 -0
- package/dist/contributor-tools.d.ts +42 -0
- package/dist/contributor-tools.d.ts.map +1 -0
- package/dist/eval-capture.js +12811 -0
- package/dist/hive.d.ts.map +1 -1
- package/dist/index.d.ts +12 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +7728 -62590
- package/dist/plugin.js +23833 -78695
- package/dist/sessions/agent-discovery.d.ts +59 -0
- package/dist/sessions/agent-discovery.d.ts.map +1 -0
- package/dist/sessions/index.d.ts +10 -0
- package/dist/sessions/index.d.ts.map +1 -0
- package/dist/swarm-orchestrate.d.ts.map +1 -1
- package/dist/swarm-prompts.d.ts.map +1 -1
- package/dist/swarm-review.d.ts.map +1 -1
- package/package.json +17 -5
- package/.changeset/swarm-insights-data-layer.md +0 -63
- package/.hive/analysis/eval-failure-analysis-2025-12-25.md +0 -331
- package/.hive/analysis/session-data-quality-audit.md +0 -320
- package/.hive/eval-results.json +0 -483
- package/.hive/issues.jsonl +0 -138
- package/.hive/memories.jsonl +0 -729
- package/.opencode/eval-history.jsonl +0 -327
- package/.turbo/turbo-build.log +0 -9
- package/CHANGELOG.md +0 -2255
- package/SCORER-ANALYSIS.md +0 -598
- package/docs/analysis/subagent-coordination-patterns.md +0 -902
- package/docs/analysis-socratic-planner-pattern.md +0 -504
- package/docs/planning/ADR-001-monorepo-structure.md +0 -171
- package/docs/planning/ADR-002-package-extraction.md +0 -393
- package/docs/planning/ADR-003-performance-improvements.md +0 -451
- package/docs/planning/ADR-004-message-queue-features.md +0 -187
- package/docs/planning/ADR-005-devtools-observability.md +0 -202
- package/docs/planning/ADR-007-swarm-enhancements-worktree-review.md +0 -168
- package/docs/planning/ADR-008-worker-handoff-protocol.md +0 -293
- package/docs/planning/ADR-009-oh-my-opencode-patterns.md +0 -353
- package/docs/planning/ROADMAP.md +0 -368
- package/docs/semantic-memory-cli-syntax.md +0 -123
- package/docs/swarm-mail-architecture.md +0 -1147
- package/docs/testing/context-recovery-test.md +0 -470
- package/evals/ARCHITECTURE.md +0 -1189
- package/evals/README.md +0 -768
- package/evals/compaction-prompt.eval.ts +0 -149
- package/evals/compaction-resumption.eval.ts +0 -289
- package/evals/coordinator-behavior.eval.ts +0 -307
- package/evals/coordinator-session.eval.ts +0 -154
- package/evals/evalite.config.ts.bak +0 -15
- package/evals/example.eval.ts +0 -31
- package/evals/fixtures/compaction-cases.ts +0 -350
- package/evals/fixtures/compaction-prompt-cases.ts +0 -311
- package/evals/fixtures/coordinator-sessions.ts +0 -328
- package/evals/fixtures/decomposition-cases.ts +0 -105
- package/evals/lib/compaction-loader.test.ts +0 -248
- package/evals/lib/compaction-loader.ts +0 -320
- package/evals/lib/data-loader.evalite-test.ts +0 -289
- package/evals/lib/data-loader.test.ts +0 -345
- package/evals/lib/data-loader.ts +0 -281
- package/evals/lib/llm.ts +0 -115
- package/evals/scorers/compaction-prompt-scorers.ts +0 -145
- package/evals/scorers/compaction-scorers.ts +0 -305
- package/evals/scorers/coordinator-discipline.evalite-test.ts +0 -539
- package/evals/scorers/coordinator-discipline.ts +0 -325
- package/evals/scorers/index.test.ts +0 -146
- package/evals/scorers/index.ts +0 -328
- package/evals/scorers/outcome-scorers.evalite-test.ts +0 -27
- package/evals/scorers/outcome-scorers.ts +0 -349
- package/evals/swarm-decomposition.eval.ts +0 -121
- package/examples/commands/swarm.md +0 -745
- package/examples/plugin-wrapper-template.ts +0 -2426
- package/examples/skills/hive-workflow/SKILL.md +0 -212
- package/examples/skills/skill-creator/SKILL.md +0 -223
- package/examples/skills/swarm-coordination/SKILL.md +0 -292
- package/global-skills/cli-builder/SKILL.md +0 -344
- package/global-skills/cli-builder/references/advanced-patterns.md +0 -244
- package/global-skills/learning-systems/SKILL.md +0 -644
- package/global-skills/skill-creator/LICENSE.txt +0 -202
- package/global-skills/skill-creator/SKILL.md +0 -352
- package/global-skills/skill-creator/references/output-patterns.md +0 -82
- package/global-skills/skill-creator/references/workflows.md +0 -28
- package/global-skills/swarm-coordination/SKILL.md +0 -995
- package/global-skills/swarm-coordination/references/coordinator-patterns.md +0 -235
- package/global-skills/swarm-coordination/references/strategies.md +0 -138
- package/global-skills/system-design/SKILL.md +0 -213
- package/global-skills/testing-patterns/SKILL.md +0 -430
- package/global-skills/testing-patterns/references/dependency-breaking-catalog.md +0 -586
- package/opencode-swarm-plugin-0.30.7.tgz +0 -0
- package/opencode-swarm-plugin-0.31.0.tgz +0 -0
- package/scripts/cleanup-test-memories.ts +0 -346
- package/scripts/init-skill.ts +0 -222
- package/scripts/migrate-unknown-sessions.ts +0 -349
- package/scripts/validate-skill.ts +0 -204
- package/src/agent-mail.ts +0 -1724
- package/src/anti-patterns.test.ts +0 -1167
- package/src/anti-patterns.ts +0 -448
- package/src/compaction-capture.integration.test.ts +0 -257
- package/src/compaction-hook.test.ts +0 -838
- package/src/compaction-hook.ts +0 -1204
- package/src/compaction-observability.integration.test.ts +0 -139
- package/src/compaction-observability.test.ts +0 -187
- package/src/compaction-observability.ts +0 -324
- package/src/compaction-prompt-scorers.test.ts +0 -475
- package/src/compaction-prompt-scoring.ts +0 -300
- package/src/dashboard.test.ts +0 -611
- package/src/dashboard.ts +0 -462
- package/src/error-enrichment.test.ts +0 -403
- package/src/error-enrichment.ts +0 -219
- package/src/eval-capture.test.ts +0 -1015
- package/src/eval-capture.ts +0 -929
- package/src/eval-gates.test.ts +0 -306
- package/src/eval-gates.ts +0 -218
- package/src/eval-history.test.ts +0 -508
- package/src/eval-history.ts +0 -214
- package/src/eval-learning.test.ts +0 -378
- package/src/eval-learning.ts +0 -360
- package/src/eval-runner.test.ts +0 -223
- package/src/eval-runner.ts +0 -402
- package/src/export-tools.test.ts +0 -476
- package/src/export-tools.ts +0 -257
- package/src/hive.integration.test.ts +0 -2241
- package/src/hive.ts +0 -1628
- package/src/index.ts +0 -935
- package/src/learning.integration.test.ts +0 -1815
- package/src/learning.ts +0 -1079
- package/src/logger.test.ts +0 -189
- package/src/logger.ts +0 -135
- package/src/mandate-promotion.test.ts +0 -473
- package/src/mandate-promotion.ts +0 -239
- package/src/mandate-storage.integration.test.ts +0 -601
- package/src/mandate-storage.test.ts +0 -578
- package/src/mandate-storage.ts +0 -794
- package/src/mandates.ts +0 -540
- package/src/memory-tools.test.ts +0 -195
- package/src/memory-tools.ts +0 -344
- package/src/memory.integration.test.ts +0 -334
- package/src/memory.test.ts +0 -158
- package/src/memory.ts +0 -527
- package/src/model-selection.test.ts +0 -188
- package/src/model-selection.ts +0 -68
- package/src/observability-tools.test.ts +0 -359
- package/src/observability-tools.ts +0 -871
- package/src/output-guardrails.test.ts +0 -438
- package/src/output-guardrails.ts +0 -381
- package/src/pattern-maturity.test.ts +0 -1160
- package/src/pattern-maturity.ts +0 -525
- package/src/planning-guardrails.test.ts +0 -491
- package/src/planning-guardrails.ts +0 -438
- package/src/plugin.ts +0 -23
- package/src/post-compaction-tracker.test.ts +0 -251
- package/src/post-compaction-tracker.ts +0 -237
- package/src/query-tools.test.ts +0 -636
- package/src/query-tools.ts +0 -324
- package/src/rate-limiter.integration.test.ts +0 -466
- package/src/rate-limiter.ts +0 -774
- package/src/replay-tools.test.ts +0 -496
- package/src/replay-tools.ts +0 -240
- package/src/repo-crawl.integration.test.ts +0 -441
- package/src/repo-crawl.ts +0 -610
- package/src/schemas/cell-events.test.ts +0 -347
- package/src/schemas/cell-events.ts +0 -807
- package/src/schemas/cell.ts +0 -257
- package/src/schemas/evaluation.ts +0 -166
- package/src/schemas/index.test.ts +0 -199
- package/src/schemas/index.ts +0 -286
- package/src/schemas/mandate.ts +0 -232
- package/src/schemas/swarm-context.ts +0 -115
- package/src/schemas/task.ts +0 -161
- package/src/schemas/worker-handoff.test.ts +0 -302
- package/src/schemas/worker-handoff.ts +0 -131
- package/src/skills.integration.test.ts +0 -1192
- package/src/skills.test.ts +0 -643
- package/src/skills.ts +0 -1549
- package/src/storage.integration.test.ts +0 -341
- package/src/storage.ts +0 -884
- package/src/structured.integration.test.ts +0 -817
- package/src/structured.test.ts +0 -1046
- package/src/structured.ts +0 -762
- package/src/swarm-decompose.test.ts +0 -188
- package/src/swarm-decompose.ts +0 -1302
- package/src/swarm-deferred.integration.test.ts +0 -157
- package/src/swarm-deferred.test.ts +0 -38
- package/src/swarm-insights.test.ts +0 -214
- package/src/swarm-insights.ts +0 -459
- package/src/swarm-mail.integration.test.ts +0 -970
- package/src/swarm-mail.ts +0 -739
- package/src/swarm-orchestrate.integration.test.ts +0 -282
- package/src/swarm-orchestrate.test.ts +0 -548
- package/src/swarm-orchestrate.ts +0 -3084
- package/src/swarm-prompts.test.ts +0 -1270
- package/src/swarm-prompts.ts +0 -2077
- package/src/swarm-research.integration.test.ts +0 -701
- package/src/swarm-research.test.ts +0 -698
- package/src/swarm-research.ts +0 -472
- package/src/swarm-review.integration.test.ts +0 -285
- package/src/swarm-review.test.ts +0 -879
- package/src/swarm-review.ts +0 -709
- package/src/swarm-strategies.ts +0 -407
- package/src/swarm-worktree.test.ts +0 -501
- package/src/swarm-worktree.ts +0 -575
- package/src/swarm.integration.test.ts +0 -2377
- package/src/swarm.ts +0 -38
- package/src/tool-adapter.integration.test.ts +0 -1221
- package/src/tool-availability.ts +0 -461
- package/tsconfig.json +0 -28
|
@@ -1,586 +0,0 @@
|
|
|
1
|
-
# Dependency-Breaking Techniques Catalog
|
|
2
|
-
|
|
3
|
-
From Michael Feathers' "Working Effectively with Legacy Code" - 25 techniques for getting code under test.
|
|
4
|
-
|
|
5
|
-
## Constructor Problems
|
|
6
|
-
|
|
7
|
-
### Parameterize Constructor
|
|
8
|
-
|
|
9
|
-
**When**: Constructor creates dependencies internally.
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
// Before
|
|
13
|
-
class ReportGenerator {
|
|
14
|
-
private db: Database;
|
|
15
|
-
constructor() {
|
|
16
|
-
this.db = new ProductionDatabase();
|
|
17
|
-
}
|
|
18
|
-
}
|
|
19
|
-
|
|
20
|
-
// After
|
|
21
|
-
class ReportGenerator {
|
|
22
|
-
private db: Database;
|
|
23
|
-
constructor(db: Database = new ProductionDatabase()) {
|
|
24
|
-
this.db = db;
|
|
25
|
-
}
|
|
26
|
-
}
|
|
27
|
-
|
|
28
|
-
// Test
|
|
29
|
-
const generator = new ReportGenerator(new FakeDatabase());
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
### Extract and Override Factory Method
|
|
33
|
-
|
|
34
|
-
**When**: Constructor creates object you can't easily replace.
|
|
35
|
-
|
|
36
|
-
```typescript
|
|
37
|
-
// Before
|
|
38
|
-
class OrderProcessor {
|
|
39
|
-
private validator: Validator;
|
|
40
|
-
constructor() {
|
|
41
|
-
this.validator = new ComplexValidator();
|
|
42
|
-
}
|
|
43
|
-
}
|
|
44
|
-
|
|
45
|
-
// After
|
|
46
|
-
class OrderProcessor {
|
|
47
|
-
private validator: Validator;
|
|
48
|
-
constructor() {
|
|
49
|
-
this.validator = this.createValidator();
|
|
50
|
-
}
|
|
51
|
-
|
|
52
|
-
protected createValidator(): Validator {
|
|
53
|
-
return new ComplexValidator();
|
|
54
|
-
}
|
|
55
|
-
}
|
|
56
|
-
|
|
57
|
-
// Test subclass
|
|
58
|
-
class TestableOrderProcessor extends OrderProcessor {
|
|
59
|
-
protected createValidator(): Validator {
|
|
60
|
-
return new SimpleValidator();
|
|
61
|
-
}
|
|
62
|
-
}
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
### Supersede Instance Variable
|
|
66
|
-
|
|
67
|
-
**When**: Can't change constructor, but can add setter.
|
|
68
|
-
|
|
69
|
-
```typescript
|
|
70
|
-
class PaymentService {
|
|
71
|
-
private gateway = new StripeGateway();
|
|
72
|
-
|
|
73
|
-
// Add for testing only
|
|
74
|
-
_setGatewayForTesting(gateway: PaymentGateway) {
|
|
75
|
-
this.gateway = gateway;
|
|
76
|
-
}
|
|
77
|
-
}
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
**Warning**: Use sparingly. Prefer constructor injection.
|
|
81
|
-
|
|
82
|
-
## Method Problems
|
|
83
|
-
|
|
84
|
-
### Extract and Override Call
|
|
85
|
-
|
|
86
|
-
**When**: Method makes problematic call you need to isolate.
|
|
87
|
-
|
|
88
|
-
```typescript
|
|
89
|
-
// Before
|
|
90
|
-
class OrderService {
|
|
91
|
-
process(order: Order) {
|
|
92
|
-
// ... logic
|
|
93
|
-
this.sendEmail(order.customer); // problematic
|
|
94
|
-
// ... more logic
|
|
95
|
-
}
|
|
96
|
-
|
|
97
|
-
private sendEmail(customer: Customer) {
|
|
98
|
-
emailService.send(customer.email, "Order confirmed");
|
|
99
|
-
}
|
|
100
|
-
}
|
|
101
|
-
|
|
102
|
-
// After - make protected, override in test
|
|
103
|
-
class OrderService {
|
|
104
|
-
process(order: Order) {
|
|
105
|
-
// ... logic
|
|
106
|
-
this.sendEmail(order.customer);
|
|
107
|
-
// ... more logic
|
|
108
|
-
}
|
|
109
|
-
|
|
110
|
-
protected sendEmail(customer: Customer) {
|
|
111
|
-
emailService.send(customer.email, "Order confirmed");
|
|
112
|
-
}
|
|
113
|
-
}
|
|
114
|
-
|
|
115
|
-
class TestableOrderService extends OrderService {
|
|
116
|
-
emailsSent: Customer[] = [];
|
|
117
|
-
|
|
118
|
-
protected sendEmail(customer: Customer) {
|
|
119
|
-
this.emailsSent.push(customer);
|
|
120
|
-
}
|
|
121
|
-
}
|
|
122
|
-
```
|
|
123
|
-
|
|
124
|
-
### Parameterize Method
|
|
125
|
-
|
|
126
|
-
**When**: Method uses hardcoded value that should vary.
|
|
127
|
-
|
|
128
|
-
```typescript
|
|
129
|
-
// Before
|
|
130
|
-
function getRecentOrders() {
|
|
131
|
-
const cutoff = new Date();
|
|
132
|
-
cutoff.setDate(cutoff.getDate() - 30);
|
|
133
|
-
return db.query(`SELECT * FROM orders WHERE date > ?`, cutoff);
|
|
134
|
-
}
|
|
135
|
-
|
|
136
|
-
// After
|
|
137
|
-
function getRecentOrders(days: number = 30) {
|
|
138
|
-
const cutoff = new Date();
|
|
139
|
-
cutoff.setDate(cutoff.getDate() - days);
|
|
140
|
-
return db.query(`SELECT * FROM orders WHERE date > ?`, cutoff);
|
|
141
|
-
}
|
|
142
|
-
```
|
|
143
|
-
|
|
144
|
-
### Replace Function with Function Pointer
|
|
145
|
-
|
|
146
|
-
**When**: Need to swap out a function call (especially in C/procedural code).
|
|
147
|
-
|
|
148
|
-
```typescript
|
|
149
|
-
// Before
|
|
150
|
-
function processData(data: Data) {
|
|
151
|
-
const validated = validateData(data); // hardcoded call
|
|
152
|
-
return transform(validated);
|
|
153
|
-
}
|
|
154
|
-
|
|
155
|
-
// After
|
|
156
|
-
function processData(data: Data, validate: (d: Data) => Data = validateData) {
|
|
157
|
-
const validated = validate(data);
|
|
158
|
-
return transform(validated);
|
|
159
|
-
}
|
|
160
|
-
```
|
|
161
|
-
|
|
162
|
-
## Interface Techniques
|
|
163
|
-
|
|
164
|
-
### Extract Interface
|
|
165
|
-
|
|
166
|
-
**When**: Need to create test double for a class.
|
|
167
|
-
|
|
168
|
-
```typescript
|
|
169
|
-
// 1. Identify methods used by client
|
|
170
|
-
class PaymentGateway {
|
|
171
|
-
charge(amount: number): Receipt { ... }
|
|
172
|
-
refund(receiptId: string): void { ... }
|
|
173
|
-
getBalance(): number { ... }
|
|
174
|
-
}
|
|
175
|
-
|
|
176
|
-
// 2. Extract interface with only needed methods
|
|
177
|
-
interface Chargeable {
|
|
178
|
-
charge(amount: number): Receipt;
|
|
179
|
-
}
|
|
180
|
-
|
|
181
|
-
// 3. Implement interface
|
|
182
|
-
class PaymentGateway implements Chargeable { ... }
|
|
183
|
-
|
|
184
|
-
// 4. Create test double
|
|
185
|
-
class FakeChargeable implements Chargeable {
|
|
186
|
-
charges: number[] = [];
|
|
187
|
-
charge(amount: number): Receipt {
|
|
188
|
-
this.charges.push(amount);
|
|
189
|
-
return { id: 'fake-receipt' };
|
|
190
|
-
}
|
|
191
|
-
}
|
|
192
|
-
```
|
|
193
|
-
|
|
194
|
-
### Extract Implementer
|
|
195
|
-
|
|
196
|
-
**When**: Class is concrete but you need interface. Similar to Extract Interface but you rename the original.
|
|
197
|
-
|
|
198
|
-
```typescript
|
|
199
|
-
// Before
|
|
200
|
-
class MessageQueue {
|
|
201
|
-
send(msg: Message) { ... }
|
|
202
|
-
receive(): Message { ... }
|
|
203
|
-
}
|
|
204
|
-
|
|
205
|
-
// After
|
|
206
|
-
interface MessageQueue {
|
|
207
|
-
send(msg: Message): void;
|
|
208
|
-
receive(): Message;
|
|
209
|
-
}
|
|
210
|
-
|
|
211
|
-
class ProductionMessageQueue implements MessageQueue {
|
|
212
|
-
send(msg: Message) { ... }
|
|
213
|
-
receive(): Message { ... }
|
|
214
|
-
}
|
|
215
|
-
```
|
|
216
|
-
|
|
217
|
-
### Introduce Instance Delegator
|
|
218
|
-
|
|
219
|
-
**When**: Static methods prevent testing.
|
|
220
|
-
|
|
221
|
-
```typescript
|
|
222
|
-
// Before - static method
|
|
223
|
-
class DateUtils {
|
|
224
|
-
static now(): Date {
|
|
225
|
-
return new Date();
|
|
226
|
-
}
|
|
227
|
-
}
|
|
228
|
-
|
|
229
|
-
// After - instance method delegates to static
|
|
230
|
-
class DateUtils {
|
|
231
|
-
static now(): Date {
|
|
232
|
-
return new Date();
|
|
233
|
-
}
|
|
234
|
-
|
|
235
|
-
// Instance method for testability
|
|
236
|
-
getCurrentDate(): Date {
|
|
237
|
-
return DateUtils.now();
|
|
238
|
-
}
|
|
239
|
-
}
|
|
240
|
-
|
|
241
|
-
// Or better - extract interface
|
|
242
|
-
interface Clock {
|
|
243
|
-
now(): Date;
|
|
244
|
-
}
|
|
245
|
-
|
|
246
|
-
class SystemClock implements Clock {
|
|
247
|
-
now(): Date {
|
|
248
|
-
return new Date();
|
|
249
|
-
}
|
|
250
|
-
}
|
|
251
|
-
|
|
252
|
-
class FakeClock implements Clock {
|
|
253
|
-
private time: Date;
|
|
254
|
-
constructor(time: Date) {
|
|
255
|
-
this.time = time;
|
|
256
|
-
}
|
|
257
|
-
now(): Date {
|
|
258
|
-
return this.time;
|
|
259
|
-
}
|
|
260
|
-
}
|
|
261
|
-
```
|
|
262
|
-
|
|
263
|
-
## Class Extraction
|
|
264
|
-
|
|
265
|
-
### Break Out Method Object
|
|
266
|
-
|
|
267
|
-
**When**: Long method with many local variables. Extract to class where locals become fields.
|
|
268
|
-
|
|
269
|
-
```typescript
|
|
270
|
-
// Before - 200 line method with 15 local variables
|
|
271
|
-
class ReportGenerator {
|
|
272
|
-
generate(data: Data): Report {
|
|
273
|
-
let total = 0;
|
|
274
|
-
let items: Item[] = [];
|
|
275
|
-
let categories: Map<string, number> = new Map();
|
|
276
|
-
// ... 200 lines using these variables
|
|
277
|
-
}
|
|
278
|
-
}
|
|
279
|
-
|
|
280
|
-
// After - method becomes class
|
|
281
|
-
class ReportGeneration {
|
|
282
|
-
private total = 0;
|
|
283
|
-
private items: Item[] = [];
|
|
284
|
-
private categories: Map<string, number> = new Map();
|
|
285
|
-
|
|
286
|
-
constructor(private data: Data) {}
|
|
287
|
-
|
|
288
|
-
run(): Report {
|
|
289
|
-
this.calculateTotals();
|
|
290
|
-
this.categorize();
|
|
291
|
-
return this.buildReport();
|
|
292
|
-
}
|
|
293
|
-
|
|
294
|
-
private calculateTotals() { ... }
|
|
295
|
-
private categorize() { ... }
|
|
296
|
-
private buildReport() { ... }
|
|
297
|
-
}
|
|
298
|
-
|
|
299
|
-
class ReportGenerator {
|
|
300
|
-
generate(data: Data): Report {
|
|
301
|
-
return new ReportGeneration(data).run();
|
|
302
|
-
}
|
|
303
|
-
}
|
|
304
|
-
```
|
|
305
|
-
|
|
306
|
-
### Expose Static Method
|
|
307
|
-
|
|
308
|
-
**When**: Method doesn't use instance state. Make static to test without instantiation.
|
|
309
|
-
|
|
310
|
-
```typescript
|
|
311
|
-
// Before
|
|
312
|
-
class Calculator {
|
|
313
|
-
// Doesn't use 'this' at all
|
|
314
|
-
computeTax(amount: number, rate: number): number {
|
|
315
|
-
return amount * rate;
|
|
316
|
-
}
|
|
317
|
-
}
|
|
318
|
-
|
|
319
|
-
// After
|
|
320
|
-
class Calculator {
|
|
321
|
-
static computeTax(amount: number, rate: number): number {
|
|
322
|
-
return amount * rate;
|
|
323
|
-
}
|
|
324
|
-
}
|
|
325
|
-
|
|
326
|
-
// Test without instantiating Calculator
|
|
327
|
-
expect(Calculator.computeTax(100, 0.1)).toBe(10);
|
|
328
|
-
```
|
|
329
|
-
|
|
330
|
-
## Global/Static State
|
|
331
|
-
|
|
332
|
-
### Introduce Static Setter
|
|
333
|
-
|
|
334
|
-
**When**: Singleton or global state blocks testing.
|
|
335
|
-
|
|
336
|
-
```typescript
|
|
337
|
-
// Before - untestable singleton
|
|
338
|
-
class Configuration {
|
|
339
|
-
private static instance: Configuration;
|
|
340
|
-
|
|
341
|
-
static getInstance(): Configuration {
|
|
342
|
-
if (!this.instance) {
|
|
343
|
-
this.instance = new Configuration();
|
|
344
|
-
}
|
|
345
|
-
return this.instance;
|
|
346
|
-
}
|
|
347
|
-
}
|
|
348
|
-
|
|
349
|
-
// After - add setter for tests
|
|
350
|
-
class Configuration {
|
|
351
|
-
private static instance: Configuration;
|
|
352
|
-
|
|
353
|
-
static getInstance(): Configuration {
|
|
354
|
-
if (!this.instance) {
|
|
355
|
-
this.instance = new Configuration();
|
|
356
|
-
}
|
|
357
|
-
return this.instance;
|
|
358
|
-
}
|
|
359
|
-
|
|
360
|
-
// For testing only
|
|
361
|
-
static _setInstanceForTesting(config: Configuration) {
|
|
362
|
-
this.instance = config;
|
|
363
|
-
}
|
|
364
|
-
|
|
365
|
-
static _resetForTesting() {
|
|
366
|
-
this.instance = undefined!;
|
|
367
|
-
}
|
|
368
|
-
}
|
|
369
|
-
```
|
|
370
|
-
|
|
371
|
-
**Warning**: This is a last resort. Prefer dependency injection.
|
|
372
|
-
|
|
373
|
-
### Encapsulate Global References
|
|
374
|
-
|
|
375
|
-
**When**: Code uses global variables directly.
|
|
376
|
-
|
|
377
|
-
```typescript
|
|
378
|
-
// Before
|
|
379
|
-
let globalConfig: Config;
|
|
380
|
-
|
|
381
|
-
function processOrder(order: Order) {
|
|
382
|
-
if (globalConfig.taxEnabled) {
|
|
383
|
-
// ...
|
|
384
|
-
}
|
|
385
|
-
}
|
|
386
|
-
|
|
387
|
-
// After - wrap in accessor
|
|
388
|
-
class ConfigAccess {
|
|
389
|
-
static getConfig(): Config {
|
|
390
|
-
return globalConfig;
|
|
391
|
-
}
|
|
392
|
-
|
|
393
|
-
static _setConfigForTesting(config: Config) {
|
|
394
|
-
globalConfig = config;
|
|
395
|
-
}
|
|
396
|
-
}
|
|
397
|
-
|
|
398
|
-
function processOrder(order: Order) {
|
|
399
|
-
if (ConfigAccess.getConfig().taxEnabled) {
|
|
400
|
-
// ...
|
|
401
|
-
}
|
|
402
|
-
}
|
|
403
|
-
```
|
|
404
|
-
|
|
405
|
-
## Subclass Techniques
|
|
406
|
-
|
|
407
|
-
### Subclass and Override Method
|
|
408
|
-
|
|
409
|
-
**When**: Need to neutralize or sense a method call.
|
|
410
|
-
|
|
411
|
-
```typescript
|
|
412
|
-
class NotificationService {
|
|
413
|
-
notify(user: User, message: string) {
|
|
414
|
-
this.sendPush(user, message);
|
|
415
|
-
this.sendEmail(user, message);
|
|
416
|
-
this.logNotification(user, message);
|
|
417
|
-
}
|
|
418
|
-
|
|
419
|
-
protected sendPush(user: User, message: string) {
|
|
420
|
-
pushService.send(user.deviceId, message);
|
|
421
|
-
}
|
|
422
|
-
|
|
423
|
-
protected sendEmail(user: User, message: string) {
|
|
424
|
-
emailService.send(user.email, message);
|
|
425
|
-
}
|
|
426
|
-
|
|
427
|
-
protected logNotification(user: User, message: string) {
|
|
428
|
-
logger.info(`Notified ${user.id}: ${message}`);
|
|
429
|
-
}
|
|
430
|
-
}
|
|
431
|
-
|
|
432
|
-
// Test subclass - override problematic methods
|
|
433
|
-
class TestableNotificationService extends NotificationService {
|
|
434
|
-
pushes: Array<{ user: User; message: string }> = [];
|
|
435
|
-
emails: Array<{ user: User; message: string }> = [];
|
|
436
|
-
|
|
437
|
-
protected sendPush(user: User, message: string) {
|
|
438
|
-
this.pushes.push({ user, message });
|
|
439
|
-
}
|
|
440
|
-
|
|
441
|
-
protected sendEmail(user: User, message: string) {
|
|
442
|
-
this.emails.push({ user, message });
|
|
443
|
-
}
|
|
444
|
-
}
|
|
445
|
-
```
|
|
446
|
-
|
|
447
|
-
### Push Down Dependency
|
|
448
|
-
|
|
449
|
-
**When**: Only a few methods have problematic dependencies.
|
|
450
|
-
|
|
451
|
-
```typescript
|
|
452
|
-
// Before - whole class untestable due to one method
|
|
453
|
-
class DataProcessor {
|
|
454
|
-
process(data: Data): Result {
|
|
455
|
-
const validated = this.validate(data);
|
|
456
|
-
const transformed = this.transform(validated);
|
|
457
|
-
return this.save(transformed); // problematic
|
|
458
|
-
}
|
|
459
|
-
|
|
460
|
-
private save(data: Data): Result {
|
|
461
|
-
return database.insert(data); // real DB call
|
|
462
|
-
}
|
|
463
|
-
}
|
|
464
|
-
|
|
465
|
-
// After - push dependency to subclass
|
|
466
|
-
abstract class DataProcessor {
|
|
467
|
-
process(data: Data): Result {
|
|
468
|
-
const validated = this.validate(data);
|
|
469
|
-
const transformed = this.transform(validated);
|
|
470
|
-
return this.save(transformed);
|
|
471
|
-
}
|
|
472
|
-
|
|
473
|
-
protected abstract save(data: Data): Result;
|
|
474
|
-
}
|
|
475
|
-
|
|
476
|
-
class ProductionDataProcessor extends DataProcessor {
|
|
477
|
-
protected save(data: Data): Result {
|
|
478
|
-
return database.insert(data);
|
|
479
|
-
}
|
|
480
|
-
}
|
|
481
|
-
|
|
482
|
-
class TestableDataProcessor extends DataProcessor {
|
|
483
|
-
saved: Data[] = [];
|
|
484
|
-
protected save(data: Data): Result {
|
|
485
|
-
this.saved.push(data);
|
|
486
|
-
return { success: true };
|
|
487
|
-
}
|
|
488
|
-
}
|
|
489
|
-
```
|
|
490
|
-
|
|
491
|
-
## Adapter Techniques
|
|
492
|
-
|
|
493
|
-
### Adapt Parameter
|
|
494
|
-
|
|
495
|
-
**When**: Parameter type is hard to construct in tests.
|
|
496
|
-
|
|
497
|
-
```typescript
|
|
498
|
-
// Before - HttpRequest is hard to construct
|
|
499
|
-
function handleRequest(request: HttpRequest): Response {
|
|
500
|
-
const userId = request.headers.get("X-User-Id");
|
|
501
|
-
const body = request.body;
|
|
502
|
-
// ... process
|
|
503
|
-
}
|
|
504
|
-
|
|
505
|
-
// After - extract what you need
|
|
506
|
-
interface RequestData {
|
|
507
|
-
userId: string;
|
|
508
|
-
body: unknown;
|
|
509
|
-
}
|
|
510
|
-
|
|
511
|
-
function handleRequest(request: HttpRequest): Response {
|
|
512
|
-
return processRequest({
|
|
513
|
-
userId: request.headers.get("X-User-Id"),
|
|
514
|
-
body: request.body,
|
|
515
|
-
});
|
|
516
|
-
}
|
|
517
|
-
|
|
518
|
-
function processRequest(data: RequestData): Response {
|
|
519
|
-
// ... process - now testable with simple object
|
|
520
|
-
}
|
|
521
|
-
```
|
|
522
|
-
|
|
523
|
-
### Skin and Wrap the API
|
|
524
|
-
|
|
525
|
-
**When**: Third-party API is hard to mock.
|
|
526
|
-
|
|
527
|
-
```typescript
|
|
528
|
-
// Before - direct AWS SDK usage everywhere
|
|
529
|
-
async function uploadFile(file: Buffer) {
|
|
530
|
-
const s3 = new S3Client({});
|
|
531
|
-
await s3.send(
|
|
532
|
-
new PutObjectCommand({
|
|
533
|
-
Bucket: "my-bucket",
|
|
534
|
-
Key: "file.txt",
|
|
535
|
-
Body: file,
|
|
536
|
-
}),
|
|
537
|
-
);
|
|
538
|
-
}
|
|
539
|
-
|
|
540
|
-
// After - wrap in your own interface
|
|
541
|
-
interface FileStorage {
|
|
542
|
-
upload(key: string, content: Buffer): Promise<void>;
|
|
543
|
-
}
|
|
544
|
-
|
|
545
|
-
class S3Storage implements FileStorage {
|
|
546
|
-
private client = new S3Client({});
|
|
547
|
-
|
|
548
|
-
async upload(key: string, content: Buffer): Promise<void> {
|
|
549
|
-
await this.client.send(
|
|
550
|
-
new PutObjectCommand({
|
|
551
|
-
Bucket: "my-bucket",
|
|
552
|
-
Key: key,
|
|
553
|
-
Body: content,
|
|
554
|
-
}),
|
|
555
|
-
);
|
|
556
|
-
}
|
|
557
|
-
}
|
|
558
|
-
|
|
559
|
-
class FakeStorage implements FileStorage {
|
|
560
|
-
files: Map<string, Buffer> = new Map();
|
|
561
|
-
|
|
562
|
-
async upload(key: string, content: Buffer): Promise<void> {
|
|
563
|
-
this.files.set(key, content);
|
|
564
|
-
}
|
|
565
|
-
}
|
|
566
|
-
```
|
|
567
|
-
|
|
568
|
-
## Quick Reference
|
|
569
|
-
|
|
570
|
-
| Problem | Technique |
|
|
571
|
-
| ------------------------------- | ----------------------------------- |
|
|
572
|
-
| Constructor creates dependency | Parameterize Constructor |
|
|
573
|
-
| Constructor does complex work | Extract and Override Factory Method |
|
|
574
|
-
| Can't change constructor | Supersede Instance Variable |
|
|
575
|
-
| Method makes problematic call | Extract and Override Call |
|
|
576
|
-
| Method uses hardcoded value | Parameterize Method |
|
|
577
|
-
| Need test double for class | Extract Interface |
|
|
578
|
-
| Static methods block testing | Introduce Instance Delegator |
|
|
579
|
-
| Long method, many locals | Break Out Method Object |
|
|
580
|
-
| Method doesn't use instance | Expose Static Method |
|
|
581
|
-
| Singleton blocks testing | Introduce Static Setter |
|
|
582
|
-
| Global variable usage | Encapsulate Global References |
|
|
583
|
-
| Need to sense/neutralize method | Subclass and Override Method |
|
|
584
|
-
| Few methods have dependencies | Push Down Dependency |
|
|
585
|
-
| Parameter hard to construct | Adapt Parameter |
|
|
586
|
-
| Third-party API hard to mock | Skin and Wrap the API |
|
|
Binary file
|
|
Binary file
|