|
13 | 13 | - 11-module Maven build with data flowing left-to-right through the pipeline |
14 | 14 | - Central DTO: `CodebaseGraphDTO` (JGraphT graphs + disharmony lists + metrics) |
15 | 15 | - CLI entry point: `org.hjug.refactorfirst.Main` → `ReportCommand` |
16 | | -- Fat jar location: `cli/target/refactor-first-cli-*.jar` |
| 16 | +- Fat jar location: `cli/target/cli-<version>.jar` |
| 17 | +- **Anonymous/synthetic classes are first-class graph members.** Java `Outer$N`/`Outer$` (anonymous/synthetic inner classes) and the Kotlin literal `"<anonymous>"` FQN are **not** sieved out by `GraphDependencyCollector`; they genuinely participate in cycles and can harbour antipatterns, so they are vertices in the class graph and rendered with `$` as the enclosing-class separator. `GraphDependencyCollector` keeps only the `from == to` self-edge guard, plus a degenerate-package guard so a packageless `"<anonymous>"` source never creates an `""` package-graph vertex. **Sink-only** anonymous/synthetic vertices (those with no outgoing edges) are suppressed only at render time in `HtmlReport.isSinkAnonymousOrSyntheticVertex` to keep the Class/Cycle Map DOT graph readable; active ones still render. |
| 18 | +- **Anonymous DOT node ids are source-file derived.** OpenRewrite attributes a Kotlin anonymous object / function-literal type with {@code "<anonymous>"} as the trailing simple-name segment of its FQN: standalone ({@code "<anonymous>"}) or, in real graphs (e.g. FXGL), prefixed by the enclosing class/package ({@code "dev.DeveloperWASDControl.<anonymous>"}). {@code HtmlReport.isAnonymousFqn(vertex)} detects a vertex when its trailing segment starts with {@code <}. {@code HtmlReport.renderSafeNodeId(vertex, codebaseGraphDTO)} then derives the enclosing owner from the vertex's mapped source-file path in {@code CodebaseGraphDTO.classToSourceFilePathMapping} (file base name without extension, e.g. {@code DeveloperWASDControl.kt} -> {@code DeveloperWASDControl}). The DOT node id renders as {@code DeveloperWASDControl_anonymous} and the human-readable label as {@code DeveloperWASDControl\$anonymous} ({@code $} escaped as {@code \$} for DOT). When no source path is mapped (or DTO is null) it degrades to the reversible {@code lt_}/{@code _gt} {@code <}/{@code >} encoding. The renderer is responsible for DOT/HTML-safe encoding of the literal {@code "<anonymous>"} FQN ({@code <}/{@code >} are illegal in Graphviz node ids; {@code <}/{@code >} escaping in HTML table labels). |
| 19 | + |
| 20 | +## Kotlin analysis (hard dependency) |
| 21 | + |
| 22 | +`rewrite-kotlin` (`org.openrewrite:rewrite-kotlin`) is a **non-optional |
| 23 | +compile dependency** of the `codebase-graph-builder` module, pulled in via that |
| 24 | +module's `rewrite-bom` import (`rewrite-bom:8.90.4`). The Kotlin |
| 25 | +parser is therefore always on the classpath of any consumer of |
| 26 | +`codebase-graph-builder`; there is no opt-in and no reflective "is Kotlin |
| 27 | +present?" guard. (An earlier, never-merged iteration made it `<optional>` with a |
| 28 | +`CompositeGraphBuilder.isKotlinAvailable()` reflection guard, but the Kotlin |
| 29 | +builder and visitors import `org.openrewrite.kotlin.*` directly and are |
| 30 | +constructed via `new`, so the guard was dead code — it would have thrown |
| 31 | +`NoClassDefFoundError` at `new KotlinSourceFileGraphBuilder()` before the guard |
| 32 | +could ever run. The guard has been removed and the optionality dropped.) |
| 33 | + |
| 34 | +**Distribution impact:** because the dependency is mandatory, the Maven plugin |
| 35 | +and the CLI fat-jar bundle the Kotlin compiler — |
| 36 | +`kotlin-compiler-embeddable:2.x` (verified at `2.3.20` in this build) and its |
| 37 | +`kotlin-script-runtime` / `kotlin-daemon-embeddable` / |
| 38 | +`kotlinx-coroutines-core-jvm` transitives — into **every** consumer's runtime, |
| 39 | +including pure-Java projects that never contain a `.kt` file. As of this branch |
| 40 | +the CLI fat-jar is `cli/target/cli-<version>.jar` and measures **~144 MB** |
| 41 | +(verified via `du -sh cli/target/cli-0.10.0-SNAPSHOT.jar` after |
| 42 | +`mvn clean install -DskipTests`); the Kotlin compiler and its transitives are a |
| 43 | +material fraction of that. A pure-Java consumer therefore pays this size/cost |
| 44 | +(the dependency is always on the classpath regardless). |
| 45 | + |
| 46 | +**No opt-out:** Kotlin analysis runs unconditionally — there is no |
| 47 | +`analyzeKotlin` switch on `GraphBuilderConfig`. The Kotlin parser is always |
| 48 | +exercised. The config field `kotlinLanguageLevel` is kept as a `String` to |
| 49 | +avoid importing `rewrite-kotlin`'s enum into the config DTO. |
| 50 | + |
| 51 | +**Orchestration & fallback:** `CompositeGraphBuilder.getCodebaseGraphDTO(path, |
| 52 | +config)` is the single orchestrator — it builds the Java graph, then the Kotlin |
| 53 | +graph and merges them. A Kotlin build *failure* (parse error, IO, etc.) falls |
| 54 | +back to returning the Java-only DTO with a `log.warn` |
| 55 | +(`"Kotlin analysis failed; falling back to Java-only graph"`). This fallback |
| 56 | +is for build failures, not for "Kotlin is absent". |
17 | 57 |
|
18 | 58 | ## Testing Notes |
19 | 59 | - JUnit 5 with parameterized tests |
|
29 | 69 |
|
30 | 70 | ## Maven Plugin Usage |
31 | 71 | Generate reports directly: |
32 | | -`mvn org.hjug.refactorfirst.plugin:refactor-first-maven-plugin:0.8.0:htmlReport` |
| 72 | +`mvn org.hjug.refactorfirst.plugin:refactor-first-maven-plugin:0.9.0:htmlReport` |
33 | 73 |
|
34 | 74 | Configuration options (most important): |
35 | 75 | - `showDetails`: Shows God Class metrics in table (default: false) |
36 | 76 | - `backEdgeAnalysisCount`: 0 = analyze all back edges (default: 50) |
37 | 77 | - `analyzeCycles`: Whether to analyze cycles (default: true) |
38 | 78 | - `excludeTests`: Exclude test classes (default: true) |
39 | | -- `minifyHtml`: Minify HTML report (default: false) |
| 79 | +- `minifyHtml`: Minify HTML report (default: false) |
| 80 | + |
| 81 | +## CVE Pinning |
| 82 | +Transitive dependencies surfaced by an OWASP dependency-check are pinned centrally in the |
| 83 | +parent `pom.xml` `<dependencyManagement>` so child modules reference them by bare |
| 84 | +GAV (no `<version>`). If a new transitive surfaces, add its fixed-version pin to the parent's |
| 85 | +`<dependencyManagement>` block labelled "Centralized CVE mitigations", |
| 86 | +recording the CVE ID, the NVD-quoted CVSS, and the affected range in the |
| 87 | +comment, and drop the corresponding `<version>` from whichever child module introduced the |
| 88 | +transitive. Currently pinned: |
| 89 | +- `io.micrometer:micrometer-core:1.17.0` — CVE-2026-40984, CVSS 7.5, affected 1.9.0–1.9.17 / 1.13.0–1.13.18 / 1.14.0–1.14.15 / 1.15.0–1.15.11 / 1.16.0–1.16.5 (rewrite-core 8.86.0) |
| 90 | +- `io.quarkus.gizmo:gizmo:1.9.0` — CVSS > 8.0 advisory in 1.0.11, no public CVE (rewrite-core) |
| 91 | +- `org.apache.commons:commons-lang3:3.18.0` — CVE-2025-48924, CVSS 5.3, affected 3.0 before 3.18.0 (pmd-java, maven-reporting-impl) |
| 92 | +- `org.iq80.snappy:snappy:0.5` — CVE-2024-36124, CVSS 5.3 (maven-core) |
| 93 | +- `commons-beanutils:commons-beanutils:1.11.0` — CVE-2025-48734, CVSS 8.8 (maven-reporting-impl 4.0.0) |
| 94 | + |
| 95 | +Note: `mvn clean install -Plocal` invokes the OWASP `dependency-check-maven` |
| 96 | +plugin which requires NVD network access; in sandboxed / offline environments |
| 97 | +the plugin emits HTTP 429 or `JdbcBatchUpdateException` and the build fails |
| 98 | +on a network precondition rather than a code issue. |
| 99 | +Re-verify any CVE ID quoted here against the NVD before bumping a pin; the citations were last verified on 2026-08-09. |
0 commit comments