fix(snapshot): Use Paparazzi's default snapshot dir for sidecar metadata

Instead of configuring a custom snapshotRootDirectory on HtmlReportWriter
and passing it via a sentry.snapshot.output system property, reuse the
paparazzi.snapshot.dir that Paparazzi's plugin already sets. Sidecar JSON
files are now written alongside golden images in the same directory.

Also simplifies sidecar JSON generation using a linkedMapOf and removes
dead code.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Author: runningcode

plugin-build/src/main/kotlin/io/sentry/android/gradle/snapshot/GenerateSnapshotTestsTask.kt

@@ -218,9 +218,6 @@ private object PaparazziPreviewRule {
             false -> previewInfo.apiLevel
         }
         val tolerance = 0.0
-        val sentryOutputDir = File(
-            System.getProperty("sentry.snapshot.output", "build/sentry-snapshots")
-        )
         return Paparazzi(
             environment = detectEnvironment().copy(compileSdkVersion = previewApiLevel),
             deviceConfig = DeviceConfigBuilder.build(preview.previewInfo),
@@ -234,10 +231,7 @@ private object PaparazziPreviewRule {
             snapshotHandler = TestNameOverrideHandler(
                 when (System.getProperty("paparazzi.test.verify")?.toBoolean() == true) {
                     true -> SnapshotVerifier(maxPercentDifference = tolerance)
-                    false -> HtmlReportWriter(
-                        maxPercentDifference = tolerance,
-                        snapshotRootDirectory = sentryOutputDir,
-                    )
+                    false -> HtmlReportWriter(maxPercentDifference = tolerance)
                 }
             ),
             maxPercentDifference = tolerance,
@@ -310,8 +304,6 @@ class $CLASS_NAME(
             .encodeUnsafeCharacters()
             .build()
 
-        writeSidecarMetadata(screenshotId, preview)
-
         paparazzi.snapshot(name = screenshotId) {
             val previewInfo = preview.previewInfo
             when (previewInfo.showSystemUi) {
@@ -338,57 +330,40 @@ class $CLASS_NAME(
                 }
             }
         }
+        
+        writeSidecarMetadata(screenshotId, preview)
     }
 
     private fun writeSidecarMetadata(
         screenshotId: String,
         preview: ComposablePreview<AndroidPreviewInfo>,
     ) {
-        val sentryRoot = File(
-            System.getProperty("sentry.snapshot.output", "build/sentry-snapshots")
-        )
-        val imagesDir = File(sentryRoot, "images")
+        val snapshotDir = File(System.getProperty("paparazzi.snapshot.dir"))
+        val imagesDir = File(snapshotDir, "images")
         imagesDir.mkdirs()
         val info = preview.previewInfo
-        val q = '"'
-        val parts = mutableListOf<String>()
-        parts.add(q + "display_name" + q + ": " + q + escapeJson(screenshotId) + q)
-        parts.add(q + "image_file_name" + q + ": " + q + escapeJson(screenshotId) + q)
-        parts.add(q + "className" + q + ": " + q + escapeJson(preview.declaringClass) + q)
-        parts.add(q + "methodName" + q + ": " + q + escapeJson(preview.methodName) + q)
-        if (info.group.isNotBlank()) {
-            parts.add(q + "group" + q + ": " + q + escapeJson(info.group) + q)
-        }
-        if (info.name.isNotBlank()) {
-            parts.add(q + "previewName" + q + ": " + q + escapeJson(info.name) + q)
-        }
-        if (info.locale.isNotBlank()) {
-            parts.add(q + "locale" + q + ": " + q + escapeJson(info.locale) + q)
-        }
-        if (info.device.isNotBlank()) {
-            parts.add(q + "device" + q + ": " + q + escapeJson(info.device) + q)
-        }
-        val nightMode = info.uiMode and 0x30 == 0x20
-        parts.add(q + "nightMode" + q + ": " + if (nightMode) "true" else "false")
-        if (info.fontScale != 1f) {
-            parts.add(q + "fontScale" + q + ": " + info.fontScale)
-        }
-        if (info.apiLevel != -1) {
-            parts.add(q + "apiLevel" + q + ": " + info.apiLevel)
-        }
-        if (info.widthDp > 0) {
-            parts.add(q + "widthDp" + q + ": " + info.widthDp)
-        }
-        if (info.heightDp > 0) {
-            parts.add(q + "heightDp" + q + ": " + info.heightDp)
-        }
-        if (info.showSystemUi) {
-            parts.add(q + "showSystemUi" + q + ": true")
-        }
-        if (info.showBackground) {
-            parts.add(q + "showBackground" + q + ": true")
+        val metadata = linkedMapOf<String, Any>(
+            "display_name" to screenshotId,
+            "image_file_name" to screenshotId,
+            "className" to preview.declaringClass,
+            "methodName" to preview.methodName,
+        )
+        if (info.group.isNotBlank()) metadata["group"] = info.group
+        if (info.name.isNotBlank()) metadata["previewName"] = info.name
+        if (info.locale.isNotBlank()) metadata["locale"] = info.locale
+        if (info.device.isNotBlank()) metadata["device"] = info.device
+        metadata["nightMode"] = (info.uiMode and 0x30 == 0x20)
+        if (info.fontScale != 1f) metadata["fontScale"] = info.fontScale
+        if (info.apiLevel != -1) metadata["apiLevel"] = info.apiLevel
+        if (info.widthDp > 0) metadata["widthDp"] = info.widthDp
+        if (info.heightDp > 0) metadata["heightDp"] = info.heightDp
+        if (info.showSystemUi) metadata["showSystemUi"] = true
+        if (info.showBackground) metadata["showBackground"] = true
+
+        val json = metadata.entries.joinToString(",\n  ", prefix = "{\n  ", postfix = "\n}") { (k, v) ->
+            if (v is String) "\"" + k + "\": \"" + escapeJson(v) + "\""
+            else "\"" + k + "\": " + v
         }
-        val json = parts.joinToString(",\n  ", prefix = "{\n  ", postfix = "\n}")
         val sidecarName = "Paparazzi_Preview_Test_" +
             screenshotId.lowercase(Locale.US).replace("\\s".toRegex(), "_")
         File(imagesDir, "${'$'}{sidecarName}.json").writeText(json)

plugin-build/src/main/kotlin/io/sentry/android/gradle/snapshot/SentrySnapshotPlugin.kt

@@ -1,10 +1,9 @@
 package io.sentry.android.gradle.snapshot
 
 import com.android.build.api.variant.ApplicationAndroidComponentsExtension
-import com.android.build.api.variant.HostTestBuilder
+import com.android.build.api.variant.HostTestBuilder.Companion.UNIT_TEST_TYPE
 import com.android.build.gradle.BaseExtension
 import io.sentry.android.gradle.util.AgpVersions
-import java.io.File
 import kotlin.jvm.java
 import org.gradle.api.Plugin
 import org.gradle.api.Project
@@ -32,45 +31,25 @@ class SentrySnapshotPlugin : Plugin<Project> {
         project.extensions.getByType(ApplicationAndroidComponentsExtension::class.java)
 
       androidComponents.onVariants { variant ->
-        val variantName = variant.name
-        val sentrySnapshotRootDir =
-          project.layout.buildDirectory.dir("sentry-snapshots/$variantName")
-        val testTaskName = "test${variantName.replaceFirstChar { it.uppercase() }}UnitTest"
-        project.tasks
-          .matching { it.name == testTaskName }
-          .configureEach { task ->
-            val testTask = task as Test
-            testTask.systemProperty(
-              "sentry.snapshot.output",
-              sentrySnapshotRootDir.get().asFile.absolutePath,
-            )
-            testTask.systemProperty("paparazzi.test.record", "true")
-            testTask.doFirst {
-              val imagesDir = File(sentrySnapshotRootDir.get().asFile, "images")
-              if (imagesDir.exists()) {
-                imagesDir.deleteRecursively()
-              }
-            }
-          }
-
         val generateTask = GenerateSnapshotTestsTask.register(project, extension, android, variant)
         if (AgpVersions.isAGP90(AgpVersions.CURRENT)) {
           // Right now it seems we only have HostTestBuilder.UNIT_TEST_TYPE as the key but we are
           // creating screenshot tests like HostTestBuilder.SCREENSHOT_TEST_TYPE
           // We should adjust this once the API is stable and documented.
-          variant.hostTests[HostTestBuilder.UNIT_TEST_TYPE]
-            // Using `sources?.kotlin` is broken so we have to use sources?.java:
-            // https://issuetracker.google.com/issues/268248348
-            ?.sources
-            ?.java
-            ?.addGeneratedSourceDirectory(generateTask, GenerateSnapshotTestsTask::outputDir)
+          variant.hostTests[UNIT_TEST_TYPE]?.apply {
+            configureTestTask { it.systemProperty("paparazzi.test.record", "true") }
+            sources.java?.addGeneratedSourceDirectory(
+              generateTask,
+              GenerateSnapshotTestsTask::outputDir
+            )
+          }
         } else {
-          // `unitTest` is deprecated, the replacement above is complex
           @Suppress("DEPRECATION_ERROR")
-          variant.unitTest
-            ?.sources
-            ?.java
-            ?.addGeneratedSourceDirectory(generateTask, GenerateSnapshotTestsTask::outputDir)
+          // `unitTest` is deprecated, the replacement above is complex
+          variant.unitTest?.apply {
+            sources.java?.addGeneratedSourceDirectory(generateTask, GenerateSnapshotTestsTask::outputDir)
+            configureTestTask { it.systemProperty("paparazzi.test.record", "true") }
+          }
         }
       }
     }