From 8b26cf86e55c2efd0776f818e829ba4cb451ed26 Mon Sep 17 00:00:00 2001 From: shakibuzzaman Date: Mon, 24 Aug 2026 18:41:30 +0600 Subject: [PATCH] fix: verify each protected variant with its own task - One verifyDevConsoleProtectedArtifacts per protected variant, holding only that variant's runtime classpath and packaged scan - Each variant's assemble/bundle depends only on its own verifier, so building one flavor's release no longer builds every other flavor's - verifyDevConsoleProtectedArtifacts is now an aggregate over all of them; check, CI and existing release scripts keep working unchanged - Packaged-artifact scans are keyed by variant name instead of collected into one list - Functional test asserts no other flavor's tasks reach the task graph - README, CHANGELOG and docs cover the flavored-project case and upgrade --- CHANGELOG.md | 20 +++ README.md | 74 +++++++- docs/BUILD_VARIANTS_AND_PRODUCTION_SAFETY.md | 23 ++- docs/FAQ_TROUBLESHOOTING.md | 11 ++ .../gradle/DevConsoleVariantPolicyPlugin.kt | 167 ++++++++++-------- ...onsoleVariantPolicyPluginFunctionalTest.kt | 32 +++- 6 files changed, 248 insertions(+), 79 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b9a2fcf..a6e9de5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -63,6 +63,26 @@ assumed. new route could not otherwise reach it. Left abstract rather than given a no-op default: a custom store that silently declined to clear would fail invisibly, which is worse than failing to compile. +- **The protected-artifact verifier is now one task per protected variant**, named + `verifyDevConsoleProtectedArtifacts`. `verifyDevConsoleProtectedArtifacts` survives as an + aggregate that depends on all of them, so `check`, the sample apps' CI invocations, and any host + release script that names it keep working unchanged. A host that wants to verify one variant on its + own can now ask for that variant's task by name. + +### Fixed + +- **Building one flavor's release no longer builds every other flavor's release.** The verifier used + to be a single task holding *every* protected variant's runtime classpath and packaged APK/AAB as + its own task inputs, and it was wired onto each protected variant's `assemble`/`bundle`. On a + flavored project that meant `assembleProductionRelease` pulled + `verifyStagingReleaseDevConsolePackagedArtifact` into the graph, which in turn pulled + `dexBuilderStagingRelease`, `bundleStagingRelease` and the rest — so the build resolved and + downloaded every other flavor's dependencies, and produced artifacts nobody asked for. A host whose + flavors carry environment-specific SDK coordinates saw its production build reach for + internal-only artifacts and stall or fail when that repository was unreachable. Splitting the + verifier per variant keeps each variant's inputs to itself: building `productionRelease` now + touches `productionRelease` only, with no loss of enforcement. + ## 1.2.4 — 2026-08-20 ### Fixed diff --git a/README.md b/README.md index becf7be..c695dec 100644 --- a/README.md +++ b/README.md @@ -488,11 +488,81 @@ Don't take the table's word for it. Check any build yourself: aapt2 dump permissions app/build/outputs/apk/release/app-release.apk ``` -The Gradle plugin enforces the same split mechanically. `verifyDevConsoleProtectedArtifacts` fails -the build if the full runtime reaches a protected variant, checking declared dependencies, the +The Gradle plugin enforces the same split mechanically. `verifyDevConsoleProtectedArtifacts` +fails the build if the full runtime reaches a protected variant, checking declared dependencies, the resolved runtime classpath, and the final APK/AAB bytes. See [Build variants and production safety](docs/BUILD_VARIANTS_AND_PRODUCTION_SAFETY.md). +## Flavored projects: verify the variant you ship + +**If your app has product flavors, read this before wiring the plugin into a release pipeline.** + +By default every non-debug variant is `PROTECTED`, so a project with `production`, `staging`, and +`partner` flavors gets three protected release variants and three verifiers: + +``` +verifyProductionReleaseDevConsoleProtectedArtifacts +verifyStagingReleaseDevConsoleProtectedArtifacts +verifyPartnerReleaseDevConsoleProtectedArtifacts +``` + +Each one is wired onto **its own** `assemble` / `bundle` and nothing else, so +`./gradlew :app:assembleProductionRelease` verifies `productionRelease` and resolves +`productionRelease`'s classpath — no other flavor is touched. That matters most when your flavors +carry environment-specific coordinates: + +```groovy +productionImplementation "com.example.sdk:analytics-production-release:1.8.0" +stagingImplementation "com.example.sdk:analytics-staging-release:1.8.0" +partnerImplementation "com.example.sdk:analytics-partner-release:1.8.0" +``` + +A production build must never reach for another environment's artifacts — especially when those live +in a repository only reachable from an internal network. It doesn't. + +The aggregate `verifyDevConsoleProtectedArtifacts` still exists and still verifies **every** protected +variant — that is its job, and `check` depends on it. On the project above it therefore resolves and +builds all three release variants. Use it in a CI job that is meant to cover everything; don't put it +on the critical path of a single-flavor release build: + +```bash +./gradlew :app:assembleProductionRelease # ships production, verifies production +./gradlew :app:verifyProductionReleaseDevConsoleProtectedArtifacts # the same check on its own +./gradlew :app:verifyDevConsoleProtectedArtifacts # full sweep, all flavors, CI +``` + +### Upgrading from 1.2.4 or earlier + +Up to and including 1.2.4 there was one shared verifier task carrying every protected variant's +inputs, wired onto every protected variant's `assemble`/`bundle`. Building one flavor's release +therefore built all of them. If you recognise any of these, that was the cause and this release fixes +it: + +- a single-flavor release build downloading another flavor's dependencies +- `assembleProductionRelease` running `dexBuilderStagingRelease`, `bundlePartnerRelease`, or similar +- a release build failing or hanging on a repository only one flavor's artifacts live in +- release builds several times slower than the flavor being shipped could explain + +No migration is needed — the task name your scripts and CI already call still works, it is now the +aggregate. If you worked around this by excluding the verifier (`-x verifyDevConsoleProtectedArtifacts`) +or by narrowing `protectedVariantPatterns` to one flavor, undo it: those workarounds bought speed by +dropping enforcement, and you no longer have to pay for one with the other. + +### Narrowing what gets protected + +If you genuinely want fewer protected variants — a flavor whose release build is never distributed, +say — lower the default and name what you protect. Understand that a variant left out is a variant +nobody checks: + +```kotlin +devConsole { + defaultPolicy.set(DevConsoleVariantPolicy.DISABLED) + protectedVariantPatterns.set(listOf("(?i)production.*release")) +} +``` + +`DISABLED` variants still get `devconsole-noop` auto-wired — they simply are not verified. + ## Security model DevConsole deliberately exposes your app's internals to a browser, and two of its defaults trade diff --git a/docs/BUILD_VARIANTS_AND_PRODUCTION_SAFETY.md b/docs/BUILD_VARIANTS_AND_PRODUCTION_SAFETY.md index 291a855..79b6d31 100644 --- a/docs/BUILD_VARIANTS_AND_PRODUCTION_SAFETY.md +++ b/docs/BUILD_VARIANTS_AND_PRODUCTION_SAFETY.md @@ -65,19 +65,32 @@ artifact, but only `PROTECTED` variants fail the build if the full runtime shows ## `devConsoleVariantReport` and `verifyDevConsoleProtectedArtifacts` -Two tasks come with the plugin: +The plugin registers: - `devConsoleVariantReport` writes `build/reports/devconsole/variants.json` listing the effective policy (`ENABLED`/`DISABLED`/`PROTECTED`) for every variant. -- `verifyDevConsoleProtectedArtifacts` inspects each protected variant's dependency graph for a - direct `ProjectDependency` on any path in `protectedDependencyPaths`, and fails the build if one - is found. Run it as part of your release checklist — the three sample apps run it in CI on every - push (see [`.github/workflows/verify.yml`](../.github/workflows/verify.yml)). +- `verifyDevConsoleProtectedArtifacts` — one task per protected variant — inspects that + variant's dependency graph for a direct `ProjectDependency` on any path in + `protectedDependencyPaths`, and fails the build if one is found. Each variant's + `assemble` and `bundle` depends on its own verifier, so building a protected + artifact always runs its checks. +- `verifyDevConsoleProtectedArtifacts` is the aggregate: it depends on every per-variant verifier, + and `check` hangs off it. Run it as part of your release checklist — the three sample apps run it + in CI on every push (see [`.github/workflows/verify.yml`](../.github/workflows/verify.yml)). ```bash ./gradlew :app:assembleRelease :app:verifyDevConsoleProtectedArtifacts ``` +On a flavored project, ask for the variant you are actually shipping. The aggregate verifies *every* +protected variant, so on a project with `production`/`staging`/`partner` flavors it resolves — and +builds — all three release variants: + +```bash +./gradlew :app:assembleProductionRelease # verifies productionRelease only +./gradlew :app:verifyProductionReleaseDevConsoleProtectedArtifacts # the same check, on its own +``` + ## Full/no-op parity `devconsole` and `devconsole-noop` are compiled from the same shared facade source diff --git a/docs/FAQ_TROUBLESHOOTING.md b/docs/FAQ_TROUBLESHOOTING.md index b888dfe..16ac1fd 100644 --- a/docs/FAQ_TROUBLESHOOTING.md +++ b/docs/FAQ_TROUBLESHOOTING.md @@ -30,6 +30,17 @@ dashboard assets, and storage layer live only in `sdk:full`, and `verifyDevConso checks specifically for a dependency on that module, not for the absence of every DevConsole class. See [BUILD_VARIANTS_AND_PRODUCTION_SAFETY.md](BUILD_VARIANTS_AND_PRODUCTION_SAFETY.md). +**Why is my release build downloading another flavor's dependencies?** Up to 1.2.4 the plugin +registered a single `verifyDevConsoleProtectedArtifacts` task holding *every* protected variant's +runtime classpath and packaged artifact as its own inputs, and wired it onto each protected variant's +`assemble`/`bundle` — so `assembleProductionRelease` dragged `dexBuilderStagingRelease`, +`bundlePartnerRelease` and every other flavor's dependency download into the graph. Since then there +is one verifier per variant (`verifyProductionReleaseDevConsoleProtectedArtifacts`), each wired only +onto its own variant's tasks, and `verifyDevConsoleProtectedArtifacts` is an aggregate you invoke +deliberately. +Upgrade, and drop any `-x verifyDevConsoleProtectedArtifacts` workaround. See the flavored-projects +section in the [README](../README.md#flavored-projects-verify-the-variant-you-ship). + **I toggled a feature flag in the dashboard but my app didn't change.** Flags are pulled, not pushed. Call `DevConsole.featureFlagValue(key)` wherever you'd otherwise check a local flag. There is no change notification, so re-check after whatever user action would plausibly follow a QA diff --git a/gradle-plugin/src/main/kotlin/io/devconsole/gradle/DevConsoleVariantPolicyPlugin.kt b/gradle-plugin/src/main/kotlin/io/devconsole/gradle/DevConsoleVariantPolicyPlugin.kt index 9dbebaf..b035637 100644 --- a/gradle-plugin/src/main/kotlin/io/devconsole/gradle/DevConsoleVariantPolicyPlugin.kt +++ b/gradle-plugin/src/main/kotlin/io/devconsole/gradle/DevConsoleVariantPolicyPlugin.kt @@ -418,7 +418,7 @@ private val CORE_RUNTIME_COORDINATE_NAMES = setOf("devconsole", "devconsole-noop class DevConsoleVariantPolicyPlugin : Plugin { override fun apply(target: Project) = with(target) { - val packagedVerificationTasks = mutableListOf>() + val packagedVerificationTasks = linkedMapOf>() // variant name -> AGP build type name (e.g. "productionDebug" -> "debug"). Populated by the // AndroidComponentsExtension#onVariants callbacks in registerPackagedArtifactScans below. The // build type is what lets a flavored variant like "productionDebug" resolve against @@ -514,7 +514,7 @@ class DevConsoleVariantPolicyPlugin : Plugin { private fun Project.registerPackagedArtifactScans( extension: DevConsoleExtension, - scans: MutableList>, + scans: MutableMap>, actualVariantBuildTypes: MutableMap, ) { plugins.withId("com.android.application") { @@ -525,7 +525,7 @@ class DevConsoleVariantPolicyPlugin : Plugin { if (variantPolicy(variant.name, variant.buildType, extension) != DevConsoleVariantPolicy.PROTECTED) { return@onVariants } - scans += + scans[variant.name] = tasks.register( "verify${variant.name.capitalized()}DevConsolePackagedArtifact", ) { @@ -551,7 +551,7 @@ class DevConsoleVariantPolicyPlugin : Plugin { if (variantPolicy(variant.name, variant.buildType, extension) != DevConsoleVariantPolicy.PROTECTED) { return@onVariants } - scans += + scans[variant.name] = tasks.register( "verify${variant.name.capitalized()}DevConsolePackagedArtifact", ) { @@ -677,81 +677,106 @@ class DevConsoleVariantPolicyPlugin : Plugin { policies: Map, report: TaskProvider, extension: DevConsoleExtension, - packagedVerificationTasks: List>, + packagedVerificationTasks: Map>, ) { val protectedPaths = extension.protectedDependencyPaths.get() val protectedVariants = policies.filterValues { it == DevConsoleVariantPolicy.PROTECTED }.keys - val violations = protectedVariants.flatMap { variant -> - val variantConfig = configurations.findByName("${variant}Implementation") - val implConfig = configurations.findByName("implementation") - val allDeps = (variantConfig?.dependencies.orEmpty() + implConfig?.dependencies.orEmpty()) - allDeps.mapNotNull { dep -> - when { - dep is ProjectDependency -> { - val path = dep.projectPathCompat() - if (path in protectedPaths) "$variant -> $path" else null - } - dep is org.gradle.api.artifacts.ExternalModuleDependency && dep.group in DEVCONSOLE_GROUPS && dep.name == "devconsole" -> "$variant -> ${dep.group}:${dep.name}" - else -> null - } - } - } - // Walk each protected variant's runtime dependency *graph* lazily (at task execution) so - // transitive inclusion of the full runtime is caught too. The graph (resolutionResult) yields - // component identities without resolving artifact files, which for an Android classpath is - // ambiguous across artifact types. - val resolvedComponents = protectedVariants.map { variant -> - val classpath = configurations.findByName("${variant}RuntimeClasspath") - ?: error( - "DevConsole: protected variant '$variant' has no '${variant}RuntimeClasspath' " + - "configuration, so its transitive dependency graph cannot be verified. This " + - "usually means io.github.devconsole-android was applied before " + - "com.android.application (or com.android.library) in the `plugins {}` block, " + - "or '$variant' is a build-type name that does not correspond to a real " + - "variant on a flavored project (e.g. 'release' instead of " + - "'productionRelease'). Apply com.android.application (or com.android.library) " + - "before io.github.devconsole-android, or ensure enabledVariants / " + - "protectedVariantPatterns reference actual variant names.", - ) - variant to classpath.incoming.resolutionResult.rootComponent.map { root -> - val seen = linkedSetOf() - val queue = ArrayDeque(root.dependencies) - while (queue.isNotEmpty()) { - val dependency = queue.removeFirst() as? ResolvedDependencyResult ?: continue - val selected = dependency.selected - val identity = - when (val componentId = selected.id) { - is ProjectComponentIdentifier -> "project ${componentId.projectPath}" - else -> componentId.displayName - } - if (seen.add(identity)) queue.addAll(selected.dependencies) - } - seen.toList() + // One verifier task per protected variant, never a single shared one. A shared task carries + // every protected variant's runtime classpath and packaged artifact as its own inputs, so + // wiring it onto assemble made building one variant resolve -- and on a flavored + // project fully build -- every other protected variant too: `assembleProductionRelease` + // dragged `dexBuilderStagingRelease`, `bundleStagingRelease` and every other flavor's + // dependency download into the graph. Per-variant tasks keep each variant's inputs to itself. + val verifiers = protectedVariants.map { variant -> + val verifier = tasks.register( + "verify${variant.capitalized()}DevConsoleProtectedArtifacts", + ) { + group = "verification" + dependsOn(report) + packagedVerificationTasks[variant]?.let { packaged -> dependsOn(packaged) } + violations.set(declaredViolations(variant, protectedPaths)) + resolvedRuntimeComponents.put(variant, resolvedRuntimeComponents(variant)) + protectedProjectPaths.set(protectedPaths) + failOnUnsafeVariant.set(extension.failBuildOnUnsafeVariant) } + // `check` alone is not enough: `./gradlew bundleRelease && upload` (or `assembleRelease`) + // never runs `check` and previously got zero enforcement. Wire the verifier as a dependency + // of this variant's own assemble/bundle task too, so building the + // protected artifact itself always runs the checks. tasks.matching { }.configureEach { } is + // lazy and safe even when a task name does not exist for this project type (e.g. + // bundle on a library module, which has no bundle task) -- it never forces the task + // to be created, it just configures it if and when it is. + val capitalized = variant.capitalized() + tasks.matching { it.name == "assemble$capitalized" }.configureEach { it.dependsOn(verifier) } + tasks.matching { it.name == "bundle$capitalized" }.configureEach { it.dependsOn(verifier) } + verifier } - val verifier = tasks.register("verifyDevConsoleProtectedArtifacts") { - group = "verification" - dependsOn(report) - dependsOn(packagedVerificationTasks) - this.violations.set(violations) - resolvedComponents.forEach { (variant, provider) -> resolvedRuntimeComponents.put(variant, provider) } - protectedProjectPaths.set(protectedPaths) - this.failOnUnsafeVariant.set(extension.failBuildOnUnsafeVariant) + // Aggregate lifecycle task: the name hosts and CI already invoke, and what `check` hangs off. + // Asking for it explicitly still verifies every protected variant -- it just is no longer on + // any single variant's build path. + val aggregate = tasks.register("verifyDevConsoleProtectedArtifacts") { task -> + task.group = "verification" + task.description = "Verifies every protected variant excludes the full DevConsole runtime." + task.dependsOn(verifiers) } tasks.findByName("check")?.let { checkTask -> - checkTask.dependsOn(verifier) + checkTask.dependsOn(aggregate) } - // `check` alone is not enough: `./gradlew bundleRelease && upload` (or `assembleRelease`) - // never runs `check` and previously got zero enforcement. Wire the verifier as a dependency of - // every protected variant's assemble/bundle task too, so building the - // protected artifact itself always runs the checks. tasks.matching { }.configureEach { } is - // lazy and safe even when a task name does not exist for this project type (e.g. - // bundle on a library module, which has no bundle task) -- it never forces the task - // to be created, it just configures it if and when it is. - protectedVariants.forEach { variant -> - val capitalized = variant.capitalized() - tasks.matching { it.name == "assemble$capitalized" }.configureEach { it.dependsOn(verifier) } - tasks.matching { it.name == "bundle$capitalized" }.configureEach { it.dependsOn(verifier) } + } + + /** Violations found among a protected variant's *declared* dependencies. */ + private fun Project.declaredViolations( + variant: String, + protectedPaths: Set, + ): List { + val variantConfig = configurations.findByName("${variant}Implementation") + val implConfig = configurations.findByName("implementation") + val allDeps = (variantConfig?.dependencies.orEmpty() + implConfig?.dependencies.orEmpty()) + return allDeps.mapNotNull { dep -> + when { + dep is ProjectDependency -> { + val path = dep.projectPathCompat() + if (path in protectedPaths) "$variant -> $path" else null + } + dep is org.gradle.api.artifacts.ExternalModuleDependency && dep.group in DEVCONSOLE_GROUPS && dep.name == "devconsole" -> "$variant -> ${dep.group}:${dep.name}" + else -> null + } + } + } + + /** + * Walks a protected variant's runtime dependency *graph* lazily (at task execution) so transitive + * inclusion of the full runtime is caught too. The graph (resolutionResult) yields component + * identities without resolving artifact files, which for an Android classpath is ambiguous across + * artifact types. + */ + private fun Project.resolvedRuntimeComponents(variant: String): org.gradle.api.provider.Provider> { + val classpath = configurations.findByName("${variant}RuntimeClasspath") + ?: error( + "DevConsole: protected variant '$variant' has no '${variant}RuntimeClasspath' " + + "configuration, so its transitive dependency graph cannot be verified. This " + + "usually means io.github.devconsole-android was applied before " + + "com.android.application (or com.android.library) in the `plugins {}` block, " + + "or '$variant' is a build-type name that does not correspond to a real " + + "variant on a flavored project (e.g. 'release' instead of " + + "'productionRelease'). Apply com.android.application (or com.android.library) " + + "before io.github.devconsole-android, or ensure enabledVariants / " + + "protectedVariantPatterns reference actual variant names.", + ) + return classpath.incoming.resolutionResult.rootComponent.map { root -> + val seen = linkedSetOf() + val queue = ArrayDeque(root.dependencies) + while (queue.isNotEmpty()) { + val dependency = queue.removeFirst() as? ResolvedDependencyResult ?: continue + val selected = dependency.selected + val identity = + when (val componentId = selected.id) { + is ProjectComponentIdentifier -> "project ${componentId.projectPath}" + else -> componentId.displayName + } + if (seen.add(identity)) queue.addAll(selected.dependencies) + } + seen.toList() } } } diff --git a/gradle-plugin/src/test/kotlin/io/devconsole/gradle/DevConsoleVariantPolicyPluginFunctionalTest.kt b/gradle-plugin/src/test/kotlin/io/devconsole/gradle/DevConsoleVariantPolicyPluginFunctionalTest.kt index 530db31..b99020e 100644 --- a/gradle-plugin/src/test/kotlin/io/devconsole/gradle/DevConsoleVariantPolicyPluginFunctionalTest.kt +++ b/gradle-plugin/src/test/kotlin/io/devconsole/gradle/DevConsoleVariantPolicyPluginFunctionalTest.kt @@ -517,7 +517,7 @@ class DevConsoleVariantPolicyPluginFunctionalTest { val result = runner("bundleRelease").buildAndFail() - assertTrue(result.output, result.output.contains(":verifyDevConsoleProtectedArtifacts")) + assertTrue(result.output, result.output.contains(":verifyReleaseDevConsoleProtectedArtifacts")) assertTrue(result.output, result.output.contains("release -> :stub-full")) } @@ -975,6 +975,36 @@ class DevConsoleVariantPolicyPluginFunctionalTest { assertTrue(result.output, result.output.contains("io.github.devconsole-android:devconsole-ui-compose")) } + @Test + fun `assembling one flavor's release keeps another flavor's release out of the task graph`() { + writeFixture( + devConsoleBlock = "", + androidPlugin = "com.android.application", + applicationIdLine = + """ + applicationId = "io.devconsole.fixture" + versionCode = 1 + """.trimIndent(), + androidBlock = + """ + flavorDimensions += "environment" + productFlavors { + create("production") { dimension = "environment" } + create("partner") { dimension = "environment" } + } + """.trimIndent(), + ) + + val result = runner("assembleProductionRelease", "--dry-run").build() + + assertTrue(result.output, result.output.contains(":verifyProductionReleaseDevConsoleProtectedArtifacts")) + assertTrue(result.output, result.output.contains(":verifyProductionReleaseDevConsolePackagedArtifact")) + // A single shared verifier task holding every protected variant's runtime classpath and + // packaged artifact as inputs made assembling one flavor resolve -- and build -- every other + // flavor's release variant too. + assertTrue(result.output, !result.output.contains("PartnerRelease")) + } + private companion object { /** A valid, empty zip -- enough for Gradle to accept the stub as a jar artifact. */ val EMPTY_JAR_BYTES =