KotlinConf 24 - Dynamic Exploration of Static Analysis with Compose

Video: https://www.youtube.com/watch?v=vRzE6HIz-_M
KotlinConf Talk: https://kotlinconf.com/talks/586687/

Static analysis is so much more than just finding lint errors. With custom static analyzers, you can collect data you are interested in to better understand your codebase at scale.

I personally found the idea of collecting custom analysis to be unapproachable and I didn’t know where to start. After making it through, and finding so much value, I want to break down that barrier for you through a series of examples. These examples are based on real use cases where you will learn how to write your own static analysis collectors for Kotlin, how to visualize the analysis results with Compose, and find hidden insights into your team’s project.

We’ll start by learning how to create a custom static analyzer of your project via Kotlin's Program Structure Interface (PSI) to collect the data. In this case we’ll collect Anvil and Dagger Dependency Injection contributions and usage.

We’ll then continue on to use the collected analysis data to render a Compose report allowing us to see these dependency relationships that are unavailable to the IDE (because it is unaware of our dependency injection frameworks).

This talk gives you the foundation you need to write custom static analysis collectors, how you can explore that data, and solve problems for your team at scale.

Transcript

1. Dynamic Exploration of Static Analysis with Compose Sam Edwards @HandstandSam
2. @HandstandSam
3. Joined Android Foundation
4. First Task “As an Android developer, I want to know which Development Apps exercise the :impl Gradle Modules my team owns.”
5. First Task “As an Android developer, I want to know which Development Apps exercise the :impl Gradle Modules my team owns.”
6. First Task “As an Android developer, I want to know which Development Apps exercise the :impl Gradle Modules my team owns.”
7. First Task “As an Android developer, I want to know which Development Apps exercise the :impl Gradle Modules my team owns.”
8. Module Structure at Square
9. Android Module Structure speakerdeck.com/vrallev/android-at-scale-at-square
10. Development Apps speakerdeck.com/vrallev/android-at-scale-at-square
11. Development Apps speakerdeck.com/vrallev/android-at-scale-at-square
12. I have a plan.
13. Dependency Guard github.com/dropbox/dependency-guard
14. Custom Gradle Plugin & Task • Con fi gure Project • Resolve all Transitive Dependencies • Execute Task • Report Output
15. Initial Output Development App -> Dependencies
16. Kotlin Source Configurations • Runtime Con fi guration • Test Con fi guration • Release Con fi guration • Debug Con fi guration • Android Test Con fi guration
17. Gradle Gradle Plugin
18. Gradle -> JSON Gradle Plugin Shared Models (data class) .json
19. Gradle -> JSON -> React JS Gradle Plugin Shared Models (data class) .json
20. Dynamic Exploration React JS
21. Kotlin Multiplatform Shared Models & Serialization Gradle Plugin
22. Kotlin Multiplatform Shared Models & Serialization Gradle Plugin Shared Models (data class) .json
23. Kotlin Multiplatform Shared Models & Serialization Gradle Plugin Shared Models (data class) .json Compose Report
24. Compose Multiplatform Web (WASM)
25. THIS IS SO COOL
26. Compose Web (WASM) - September 2023
27. Compose Multiplatform Web (WASM)
28. Compose Multiplatform Web (WASM)
29. Compose Multiplatform Web (WASM)
30. Compose Web (WASM) - September 2023 • Wow, this is cool! • I can’t paste into the search inputs. • I can’t select the text from the results table. • This isn’t the right fi t…
31. Compose Web (WASM) - October 23’ Compose Web (WASM) - Now in Alpha (Kotlin 2.0.0)
32. Compose HTML • Accessible from anywhere • Copy/Paste Support • Standalone, doesn’t require any backend (GitHub Pages) • Familiar to Kotlin developers • Dynamic Exploration
33. 🔃 Invert Inverted view of your Gradle Project
34. ./gradlew :invert
36. Demo!
37. Inverted Dependencies Link
38. …
39. Couldn’t you have used Chat GPT to do it?
40. How do I ask my codebase questions? 🤔
41. IntelliJ Search
42. Find Usages
43. Type Hierarchy
44. Code Structure
45. Context
46. Analysis Creates Context
48. Easy Questions Examples • Find the word “Analytics” in a fi le named *.kt? • Which fi les have the import “kotlin.test.Test”? Requirements • File contents indexed & searchable
49. Hard Questions Examples • Is my code formatted correctly? • Did I follow our coding patterns in my latest commit? • Can you fi nd the usages of the Analytics interface? • What are the concrete implementations of the Analytics interface?
50. Hard Questions Requirements • Code Structure • Type Resolution • References • Build Con fi guration
51. Multiple Hard Questions 1. What are the concrete implementations of the Analytics interface? 2. What modules are they in? 3. Who are the owners of that module? 4. What fi les are they in?
52. Ask Question, Run Analysis
53. Ask Question, Run Analysis
54. What if we…
55. Run Analysis, Ask Questions
56. Run Analysis, Ask Questions
57. Context
58. Dynamic Exploration ✅ with Compose ✅ Static Analysis 🧐
59. Static Analysis
60. https://en.wikipedia.org/wiki/Static_program_analysis Static Analysis Analysis of source code without executing it.
61. Static Analysis Popular Tools
62. How do they work?
63. AST (Abstract Syntax Tree) • Kotlin PSI (Program Structure Interface) • Parses Kotlin Code into an AST Representation • Traversable
65. K2 and FIR
66. Use Case: Finding Anvil & Dagger Injections with PSI
67. Why? Missing Dagger Bindings > Task :app:kaptKotlin FAILED /Users/samedwards/Development/invert/examples/app/build/tmp/kapt3/ stubs/main/com/squareup/invert/examples/AppComponent.java:7: error: [Dagger/MissingBinding] com.squareup.invert.examples.di.NetworkGraph cannot be provided without an @Provides-annotated method. public abstract interface AppComponent { ^ Missing binding usage: com.squareup.invert.examples.di.NetworkGraph is requested at com.squareup.invert.examples.AppComponent.networking()
68. Why? Missing Dagger Bindings > Task :app:kaptKotlin FAILED /Users/samedwards/Development/invert/examples/app/build/tmp/kapt3/ stubs/main/com/squareup/invert/examples/AppComponent.java:7: error: [Dagger/MissingBinding] com.squareup.invert.examples.di.NetworkGraph cannot be provided without an @Provides-annotated method. public abstract interface AppComponent { ^ Missing binding usage: com.squareup.invert.examples.di.NetworkGraph is requested at com.squareup.invert.examples.AppComponent.networking()
69. Missing Bindings Demo! ./gradlew :app:assemble
70. Find DI Provides and Injects • Scan the Kotlin Source fi les for each module • Where is a type provided? • Where is a type injected? • Enable dynamic exploration of results
71. Contributes @ContributesBinding(AppScope::class) class LiveNetworkGraph @Inject constructor( override val userRepo: UserRepo, override val categoryRepo: CategoryRepo, val networkConfig: NetworkConfig, val httpClient: HttpClient, ) : NetworkGraph {}
72. Contributes @ContributesBinding(AppScope::class) class LiveNetworkGraph @Inject constructor( override val userRepo: UserRepo, override val categoryRepo: CategoryRepo, val networkConfig: NetworkConfig, val httpClient: HttpClient, ) : NetworkGraph {}
73. Contributes @ContributesBinding(AppScope::class) class LiveNetworkGraph @Inject constructor( override val userRepo: UserRepo, override val categoryRepo: CategoryRepo, val networkConfig: NetworkConfig, val httpClient: HttpClient, ) : NetworkGraph {}
74. Injects @ContributesBinding(AppScope::class) class LiveNetworkGraph @Inject constructor( override val userRepo: UserRepo, override val categoryRepo: CategoryRepo, val networkConfig: NetworkConfig, val httpClient: HttpClient, ) : NetworkGraph {}
75. Injects @ContributesBinding(AppScope::class) class LiveNetworkGraph @Inject constructor( override val userRepo: UserRepo, override val categoryRepo: CategoryRepo, val networkConfig: NetworkConfig, val httpClient: HttpClient, ) : NetworkGraph {}
76. Injects @ContributesBinding(AppScope::class) class LiveNetworkGraph @Inject constructor( override val userRepo: UserRepo, override val categoryRepo: CategoryRepo, val networkConfig: NetworkConfig, val httpClient: HttpClient, ) : NetworkGraph {}
77. Injects @ContributesBinding(AppScope::class) class LiveNetworkGraph @Inject constructor( override val userRepo: UserRepo, override val categoryRepo: CategoryRepo, val networkConfig: NetworkConfig, val httpClient: HttpClient, ) : NetworkGraph {}
78. Injects @ContributesBinding(AppScope::class) class LiveNetworkGraph @Inject constructor( override val userRepo: UserRepo, override val categoryRepo: CategoryRepo, val networkConfig: NetworkConfig, val httpClient: HttpClient, ) : NetworkGraph {}
79. Live PSI Coding LiveNetworkGraph KotlinconfLiveNetworkGraphPsiTest
80. PsiViewer github.com/JetBrains/psiviewer
81. StatiK github.com/rickbusarow/statik • psiElement.printEverything() • com.rickbusarow.statik:statik-kotlin-psi:0.1.0-SNAPSHOT
82. FIR Tree plugins.jetbrains.com/plugin/23270- fi r-tree
83. Provides/Injects Report Demo ./gradlew :invert
86. What other questions could be asked?
87. It’s up to you.
88. 🔃 Invert Playbook • Collector Plugin Ecosystem • Ability to create customized report pages • Available and Up-to-date on CI via GitHub Pages • Supports Deep Links
89. Sam Edwards @HandstandSam Thank you,
 and don’t forget
 to vote