Improving Your Architecture with Forensic Analysis

Try it out Now in Your Project!

npm i @softarc/detective –D
npx detective

---
Feedback:
https://github.com/angular-architects/detective/issues

Transcript

1. AngularArchitects.io | @ManfredSteyer Improving Your Architecture with Forensic Analysis
2. Architecture & Code Reviews Code Review Best Practices Architectural Goals Consequences/ Trade-offs Recomentations Joint Walkthrough Developer Interviews More general: Stakeholder Interviews
4. Can we support Reviews with Code Metrics?
5. First Reaction … NO!
6. Which One is More Complex? [Adam Tornhill: Your Code as a Crime Scene, 2nd edition, 2024]
7. Same „Cyclomatic Complexity“ [Adam Tornhill: Your Code as a Crime Scene, 2nd edition, 2024]
8. Goodhart‘s Law: „When a measure becomes a target, it ceases to be a good measure.“ -- Charles A. E. Goodhart
9. What‘s Important for Architects? Minimal Dependencies Vertical 1 Vertical 2 Vertical 3 Feature UI Data Conway‘s Law Feature UI Data Feature UI Data
10. What‘s Important for Architects? Low Coupling Vertical 1 Vertical 2 Vertical 3 Conway‘s Law High Cohesion High Cohesion High Cohesion Single Responsibility? Most Changes: Within ONE Verical Reduce Cognitive Load!
11. Code Churn Code that changes often: Indicator for Issues
13. Forensic Analysis Source Code History History History Forensic Analysis „Hidden“ Patterns e.g., Git History
14. Agenda • Ideas behind Forensic Analysis • Tools for Forensic Analysis • Limitations of Forensic Analysis • DEMO
15. About me… Manfred Steyer, ANGULARarchitects.io (Remote) Angular Workshops and Consulting Google Developer Expert for Angular Blog, Books, Articles, and Talks about Angular Manfred Steyer
16. Forensic Analysis
17. Hot Spots [Adam Tornhill: Your Code as a Crime Scene, 2nd edition, 2024] Hotspot High Code Churn + Complex Hotspot Index Count Changes * Complexity Important Focus on specific time frame Tools used here CodeScene
18. Hot Spots [Adam Tornhill: Your Code as a Crime Scene, 2nd edition, 2024] Possible Reasons Too many responsibilities? No clear modularization? Error-prone implementation? Too little domain knowledge?
19. Change Coupling Change Coupling Parts often change together Hidden Coupling Tool used here Detective
20. Change Coupling Possible Reasons Too many responsibilities? No clear modularization? Code duplication? Domain Understanding?
21. Team/Code-Alignment Vertical 1 Vertical 2 Vertical 3 Conway‘s Law
22. Team/Code-Alignment Vertical 1 Vertical 2 Possible Reasons Verticals work against Conway‘s Law Devs ignore the official team structure
23. Tools
24. Code Scene • By Adam Tornhill • Free for Open Source Projects • Lot‘s of analysis methods • Awesome visualization • Several Programming Languages • Code & Architecture Level • https://codescene.com/
25. Detective • Our take on Forensic Analysis • Open Source • Limited to a few methods • Architecture Level • Primarily TypeScript • Focus: Help for Reviews • Appetizer for CodeScene!
26. Detective npm i @softarc/detective –D npx detective
27. Limitations
28. Awesome, but not a replacement for … Code Review Best Practices Architectural Goals Consequences/ Trade-offs Recomentations Joint Walkthrough Developer Interviews More general: Stakeholder Interviews
29. However, a tempting addition … Code Review Best Practices Architectural Goals Consequences/ Trade-offs Recomentations Joint Walkthrough Developer Interviews More general: Stakeholder Interviews (Forensic) Analysis Better Questions
30. Conclusion • Metrics: Grain of Salt • Metrics should not become a target! • Low Coupling, High Cohesion, Conway’s Law
31. Conclusion • Hot Spots = High Change Rate + High Complexity • Change Coupling • Team/Code Alignment
32. Conclusion • No replacement for qualitative approaches! • … but a nice addition
33. Try it out Now in Your Project! npm i @softarc/detective –D npx detective https://github.com/angular-architects/detective/issues … and provide feedback:
34. Contact and Downloads [web] ANGULARarchitects.io [twitter] ManfredSteyer d Slides & Examples Remote and In-House http://softwarearchitekt.at/workshops