Skip to content

working-effectively-with-legacy-code.md

Latest commit

 

History

History
68 lines (45 loc) · 6.91 KB

working-effectively-with-legacy-code.md

File metadata and controls

68 lines (45 loc) · 6.91 KB
Raw

Clean Architecture vs Working Effectively with Legacy Code

Status: reviewed Research basis: mini-only

Verdict: ✅ Complementary

Conflict: 12% Overlap: 38% Complementarity: 78%

Loading Decision

Use together when changing existing code: one rule set controls safe change sequencing while the other defines the target design, construction, architecture, data, or production quality.

Book A Pressure

  • Clean Architecture should drive tasks where business policy must stay independent from frameworks, databases, delivery, vendors, and volatile mechanisms.
  • Evidence: clean-architecture/clean-architecture.mini.md lines 3-5: applies when business rules should survive changes in frameworks, databases, delivery mechanisms, services, vendors, or schedule pressure.

Book B Pressure

  • Working Effectively with Legacy Code should drive tasks where unclear or weakly tested code requires characterization, seams, dependency breaking, and small safe changes.
  • Evidence: working-effectively-with-legacy-code/working-effectively-with-legacy-code.mini.md lines 3-5: applies when code is expensive to change safely because behavior is unclear, tests are weak, dependencies hidden, or runtime/framework setup blocks feedback.

Complementary Forces

  • Claim: Clean Architecture contributes policy-independence and replaceable-detail pressure; Working Effectively with Legacy Code contributes characterization, seam, dependency-breaking, small-change, and local-refactoring pressure. Together they are useful only where both scopes are active.
  • Evidence:
    • clean-architecture/clean-architecture.mini.md lines 13-24: requires inward dependencies, domain/use-case policy placement, plain request/response boundaries, outer-layer details, policy-owned ports, humble adapters, use-case structure, boundary cost checks, and enforceable boundaries.
    • working-effectively-with-legacy-code/working-effectively-with-legacy-code.mini.md lines 13-27: requires treating untested areas as legacy, stating behavior delta and preserved behavior, following the legacy loop, focused tests, effect tracing, smallest useful seam, deliberate dependency breaking, separated behavior/refactor/cleanup, sprout/wrap/extract moves for risky edits, side-effect/policy separation, barrier-specific dependency breaking, responsibility sketching, legacy-risk review, rejecting hidden-dependency expansion or premature architecture, and leaving touched area more testable/changeable.

Overlap

  • Claim: They overlap where both affect safe existing-code change, tests, behavior preservation, ownership, and stopping before speculative cleanup; the overlap score reflects how often an agent would receive similar pressure from both.
  • Evidence:
    • clean-architecture/clean-architecture.mini.md lines 42-49: checks policy independence, inward dependencies, invariant-guarding entities/use cases, enforced boundaries, humble adapters, business-revealing structure, fast core tests, and replaceable details.
    • working-effectively-with-legacy-code/working-effectively-with-legacy-code.mini.md lines 42-50: checks legacy risk, behavior delta/preservation, characterization, close fast tests, smallest seam, reduced blocking dependency, separated behavior/refactor/cleanup, cleanup path for temporary seams, and improved understandability/testability.

Conflicts

  • Claim: The tension is scope creep: design or architecture improvements must not override behavior preservation, characterization, or the current-smell stop condition.
  • Evidence:
    • clean-architecture/clean-architecture.mini.md lines 7-9: corrects detail-driven architecture by keeping business policy independent and dependencies pointing inward.
    • working-effectively-with-legacy-code/working-effectively-with-legacy-code.mini.md lines 7-9: corrects improving design before gaining control by requiring behavior understanding, preservation, smallest useful seam, dependency breaking, requested change, and local testability improvement.

Use Together When

  • Use together when changing weakly tested code toward Clean Architecture goals: first characterize behavior and create the smallest seam, then apply the other rule set inside the controlled change area.

Prefer One When

  • Prefer Working Effectively with Legacy Code when tests are weak or behavior is unclear; prefer the other book only after control, characterization, or seams make the change safe.

Source Basis

  • clean-architecture/clean-architecture.mini.md lines 3-5: applies when business rules should survive changes in frameworks, databases, delivery mechanisms, services, vendors, or schedule pressure.
  • clean-architecture/clean-architecture.mini.md lines 7-9: corrects detail-driven architecture by keeping business policy independent and dependencies pointing inward.
  • clean-architecture/clean-architecture.mini.md lines 13-24: requires inward dependencies, domain/use-case policy placement, plain request/response boundaries, outer-layer details, policy-owned ports, humble adapters, use-case structure, boundary cost checks, and enforceable boundaries.
  • clean-architecture/clean-architecture.mini.md lines 42-49: checks policy independence, inward dependencies, invariant-guarding entities/use cases, enforced boundaries, humble adapters, business-revealing structure, fast core tests, and replaceable details.
  • working-effectively-with-legacy-code/working-effectively-with-legacy-code.mini.md lines 3-5: applies when code is expensive to change safely because behavior is unclear, tests are weak, dependencies hidden, or runtime/framework setup blocks feedback.
  • working-effectively-with-legacy-code/working-effectively-with-legacy-code.mini.md lines 7-9: corrects improving design before gaining control by requiring behavior understanding, preservation, smallest useful seam, dependency breaking, requested change, and local testability improvement.
  • working-effectively-with-legacy-code/working-effectively-with-legacy-code.mini.md lines 13-27: requires treating untested areas as legacy, stating behavior delta and preserved behavior, following the legacy loop, focused tests, effect tracing, smallest useful seam, deliberate dependency breaking, separated behavior/refactor/cleanup, sprout/wrap/extract moves for risky edits, side-effect/policy separation, barrier-specific dependency breaking, responsibility sketching, legacy-risk review, rejecting hidden-dependency expansion or premature architecture, and leaving touched area more testable/changeable.
  • working-effectively-with-legacy-code/working-effectively-with-legacy-code.mini.md lines 42-50: checks legacy risk, behavior delta/preservation, characterization, close fast tests, smallest seam, reduced blocking dependency, separated behavior/refactor/cleanup, cleanup path for temporary seams, and improved understandability/testability.

Review Notes

  • External context was not used as decisive evidence for Clean Architecture vs Working Effectively with Legacy Code; the verdict is based on the cited local mini line ranges.