Merge branch 'main' into stefanosiano/fix/strict-mode

stefanosiano · stefanosiano · commit b2e03d4c1a9b · 2025-10-14T10:09:21.000+02:00
diff --git a/.craft.yml b/.craft.yml
@@ -34,6 +34,7 @@ targets:
       maven:io.sentry:sentry-apache-http-client-5:
       maven:io.sentry:sentry-android:
       maven:io.sentry:sentry-android-core:
+      maven:io.sentry:sentry-android-distribution:
       maven:io.sentry:sentry-android-ndk:
       maven:io.sentry:sentry-android-timber:
       maven:io.sentry:sentry-kotlin-extensions:
diff --git a/.github/workflows/danger.yml b/.github/workflows/danger.yml
@@ -6,4 +6,6 @@ on:
 
 jobs:
   danger:
-    uses: getsentry/github-workflows/.github/workflows/danger.yml@v2
+    runs-on: ubuntu-latest
+    steps:
+      - uses: getsentry/github-workflows/danger@v3
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Features
+
+- Add experimental Sentry Android Distribution module for integrating with Sentry Build Distribution to check for and install updates ([#4804](https://github.com/getsentry/sentry-java/pull/4804))
+
 ### Fixes
 
 - Avoid StrictMode warnings ([#4724](https://github.com/getsentry/sentry-java/pull/4724))
diff --git a/README.md b/README.md
@@ -20,6 +20,7 @@ Sentry SDK for Java and Android
 |-----------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| ------- |
 | sentry-android                          | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-android/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-android)                                                   | 21 |
 | sentry-android-core                     | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-android-core/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-android-core)                                         | 21 |
+| sentry-android-distribution             | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-android-distribution/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-android-distribution)                         | 21 |
 | sentry-android-ndk                      | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-android-ndk/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-android-ndk)                                           | 21 |
 | sentry-android-timber                   | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-android-timber/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-android-timber)                                     | 21 |
 | sentry-android-fragment                 | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-android-fragment/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-android-fragment)                                 | 21 |
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -161,7 +161,7 @@ subprojects {
         }
     }
 
-    if (!this.name.contains("sample") && !this.name.contains("integration-tests") && this.name != "sentry-system-test-support" && this.name != "sentry-test-support" && this.name != "sentry-android-distribution") {
+    if (!this.name.contains("sample") && !this.name.contains("integration-tests") && this.name != "sentry-system-test-support" && this.name != "sentry-test-support") {
         apply<DistributionPlugin>()
         apply<com.vanniktech.maven.publish.MavenPublishPlugin>()
 
diff --git a/sentry-android-distribution/README.md b/sentry-android-distribution/README.md
@@ -0,0 +1,3 @@
+# sentry-android-distribution
+
+This module contains the client library for the Sentry Android Build Distribution that checks for updates for your application automatically for internal testing purposes.
diff --git a/sentry-android-distribution/src/main/java/io/sentry/android/distribution/DistributionHttpClient.kt b/sentry-android-distribution/src/main/java/io/sentry/android/distribution/DistributionHttpClient.kt
@@ -26,6 +26,7 @@ internal class DistributionHttpClient(private val options: SentryOptions) {
     val platform: String = "android",
     val versionCode: Long,
     val versionName: String,
+    val buildConfiguration: String,
   )
 
   /**
@@ -56,9 +57,12 @@ internal class DistributionHttpClient(private val options: SentryOptions) {
       append("&platform=${URLEncoder.encode(params.platform, "UTF-8")}")
       append("&build_number=${URLEncoder.encode(params.versionCode.toString(), "UTF-8")}")
       append("&build_version=${URLEncoder.encode(params.versionName, "UTF-8")}")
+      append("&build_configuration=${URLEncoder.encode(params.buildConfiguration, "UTF-8")}")
     }
     val url = URL(urlString)
 
+    options.logger.log(SentryLevel.DEBUG, "Distribution API URL: $urlString")
+
     return try {
       makeRequest(url, authToken)
     } catch (e: IOException) {
diff --git a/sentry-android-distribution/src/main/java/io/sentry/android/distribution/DistributionIntegration.kt b/sentry-android-distribution/src/main/java/io/sentry/android/distribution/DistributionIntegration.kt
@@ -132,11 +132,16 @@ public class DistributionIntegration(context: Context) : Integration, IDistribut
         }
       val appId = context.applicationInfo.packageName
 
+      val buildConfiguration =
+        sentryOptions.distribution.buildConfiguration
+          ?: throw IllegalStateException("buildConfiguration must be set in distribution options")
+
       DistributionHttpClient.UpdateCheckParams(
         appId = appId,
         platform = "android",
         versionCode = versionCode,
         versionName = versionName,
+        buildConfiguration = buildConfiguration,
       )
     } catch (e: PackageManager.NameNotFoundException) {
       sentryOptions.logger.log(SentryLevel.ERROR, e, "Failed to get package info")
diff --git a/sentry-android-distribution/src/main/java/io/sentry/android/distribution/UpdateResponseParser.kt b/sentry-android-distribution/src/main/java/io/sentry/android/distribution/UpdateResponseParser.kt
@@ -32,11 +32,11 @@ internal class UpdateResponseParser(private val options: SentryOptions) {
 
       options.logger.log(SentryLevel.DEBUG, "Parsing distribution API response")
 
-      // Check if there's a new release available
-      val updateAvailable = json.optBoolean("updateAvailable", false)
+      // Check if there's an update object in the response
+      val updateJson = json.optJSONObject("update")
 
-      if (updateAvailable) {
-        val updateInfo = parseUpdateInfo(json)
+      if (updateJson != null) {
+        val updateInfo = parseUpdateInfo(updateJson)
         UpdateStatus.NewRelease(updateInfo)
       } else {
         UpdateStatus.UpToDate.getInstance()
@@ -52,11 +52,11 @@ internal class UpdateResponseParser(private val options: SentryOptions) {
 
   private fun parseUpdateInfo(json: JSONObject): UpdateInfo {
     val id = json.optString("id", "")
-    val buildVersion = json.optString("buildVersion", "")
-    val buildNumber = json.optInt("buildNumber", 0)
-    val downloadUrl = json.optString("downloadUrl", "")
-    val appName = json.optString("appName", "")
-    val createdDate = json.optString("createdDate", "")
+    val buildVersion = json.optString("build_version", "")
+    val buildNumber = json.optInt("build_number", 0)
+    val downloadUrl = json.optString("download_url", "")
+    val appName = json.optString("app_name", "")
+    val createdDate = json.optString("created_date", "")
 
     // Validate required fields (optString returns "null" for null values)
     val missingFields = mutableListOf<String>()
diff --git a/sentry-android-distribution/src/test/java/io/sentry/android/distribution/DistributionHttpClientTest.kt b/sentry-android-distribution/src/test/java/io/sentry/android/distribution/DistributionHttpClientTest.kt
@@ -37,6 +37,7 @@ class DistributionHttpClientTest {
         appId = "com.emergetools.hackernews",
         versionName = "1.0.0",
         versionCode = 5L,
+        buildConfiguration = "release",
       )
 
     val response = httpClient.checkForUpdates(params)
diff --git a/sentry-android-distribution/src/test/java/io/sentry/android/distribution/UpdateResponseParserTest.kt b/sentry-android-distribution/src/test/java/io/sentry/android/distribution/UpdateResponseParserTest.kt
@@ -26,13 +26,15 @@ class UpdateResponseParserTest {
     val responseBody =
       """
       {
-        "updateAvailable": true,
-        "id": "update-123",
-        "buildVersion": "2.0.0",
-        "buildNumber": 42,
-        "downloadUrl": "https://example.com/download",
-        "appName": "Test App",
-        "createdDate": "2023-10-01T00:00:00Z"
+        "update": {
+          "id": "update-123",
+          "build_version": "2.0.0",
+          "build_number": 42,
+          "download_url": "https://example.com/download",
+          "app_name": "Test App",
+          "created_date": "2023-10-01T00:00:00Z"
+        },
+        "current": null
       }
     """
         .trimIndent()
@@ -54,7 +56,15 @@ class UpdateResponseParserTest {
     val responseBody =
       """
       {
-        "updateAvailable": false
+        "update": null,
+        "current": {
+          "id": "current-123",
+          "build_version": "1.0.0",
+          "build_number": 10,
+          "download_url": "https://example.com/download",
+          "app_name": "Test App",
+          "created_date": "2023-09-01T00:00:00Z"
+        }
       }
     """
         .trimIndent()
@@ -65,11 +75,18 @@ class UpdateResponseParserTest {
   }
 
   @Test
-  fun `parseResponse returns UpToDate when updateAvailable is missing`() {
+  fun `parseResponse returns UpToDate when update is missing`() {
     val responseBody =
       """
       {
-        "someOtherField": "value"
+        "current": {
+          "id": "current-123",
+          "build_version": "1.0.0",
+          "build_number": 10,
+          "download_url": "https://example.com/download",
+          "app_name": "Test App",
+          "created_date": "2023-09-01T00:00:00Z"
+        }
       }
     """
         .trimIndent()
@@ -123,8 +140,9 @@ class UpdateResponseParserTest {
     val responseBody =
       """
       {
-        "updateAvailable": true,
-        "buildVersion": "2.0.0"
+        "update": {
+          "build_version": "2.0.0"
+        }
       }
     """
         .trimIndent()
@@ -144,10 +162,14 @@ class UpdateResponseParserTest {
     val responseBody =
       """
       {
-        "updateAvailable": true,
-        "id": "update-123",
-        "buildVersion": "2.0.0",
-        "downloadUrl": "https://example.com/download"
+        "update": {
+          "id": "update-123",
+          "build_version": "2.0.0",
+          "build_number": 0,
+          "download_url": "https://example.com/download",
+          "app_name": "",
+          "created_date": ""
+        }
       }
     """
         .trimIndent()
@@ -181,10 +203,14 @@ class UpdateResponseParserTest {
     val responseBody =
       """
       {
-        "updateAvailable": true,
-        "id": null,
-        "buildVersion": "2.0.0",
-        "downloadUrl": "https://example.com/download"
+        "update": {
+          "id": null,
+          "build_version": "2.0.0",
+          "build_number": 10,
+          "download_url": "https://example.com/download",
+          "app_name": "Test App",
+          "created_date": "2023-10-01T00:00:00Z"
+        }
       }
     """
         .trimIndent()
@@ -204,9 +230,13 @@ class UpdateResponseParserTest {
     val responseBody =
       """
       {
-        "updateAvailable": true,
-        "buildVersion": "2.0.0",
-        "downloadUrl": "https://example.com/download"
+        "update": {
+          "build_version": "2.0.0",
+          "build_number": 10,
+          "download_url": "https://example.com/download",
+          "app_name": "Test App",
+          "created_date": "2023-10-01T00:00:00Z"
+        }
       }
     """
         .trimIndent()
@@ -226,9 +256,13 @@ class UpdateResponseParserTest {
     val responseBody =
       """
       {
-        "updateAvailable": true,
-        "id": "update-123",
-        "downloadUrl": "https://example.com/download"
+        "update": {
+          "id": "update-123",
+          "build_number": 10,
+          "download_url": "https://example.com/download",
+          "app_name": "Test App",
+          "created_date": "2023-10-01T00:00:00Z"
+        }
       }
     """
         .trimIndent()
@@ -248,9 +282,13 @@ class UpdateResponseParserTest {
     val responseBody =
       """
       {
-        "updateAvailable": true,
-        "id": "update-123",
-        "buildVersion": "2.0.0"
+        "update": {
+          "id": "update-123",
+          "build_version": "2.0.0",
+          "build_number": 10,
+          "app_name": "Test App",
+          "created_date": "2023-10-01T00:00:00Z"
+        }
       }
     """
         .trimIndent()
@@ -270,8 +308,11 @@ class UpdateResponseParserTest {
     val responseBody =
       """
       {
-        "updateAvailable": true,
-        "buildNumber": 42
+        "update": {
+          "build_number": 42,
+          "app_name": "Test App",
+          "created_date": "2023-10-01T00:00:00Z"
+        }
       }
     """
         .trimIndent()
@@ -293,10 +334,14 @@ class UpdateResponseParserTest {
     val responseBody =
       """
       {
-        "updateAvailable": true,
-        "id": "null",
-        "buildVersion": "2.0.0",
-        "downloadUrl": "https://example.com/download"
+        "update": {
+          "id": "null",
+          "build_version": "2.0.0",
+          "build_number": 10,
+          "download_url": "https://example.com/download",
+          "app_name": "Test App",
+          "created_date": "2023-10-01T00:00:00Z"
+        }
       }
     """
         .trimIndent()
diff --git a/sentry/api/sentry.api b/sentry/api/sentry.api
@@ -4356,6 +4356,7 @@ public final class io/sentry/UpdateInfo {
 	public fun getCreatedDate ()Ljava/lang/String;
 	public fun getDownloadUrl ()Ljava/lang/String;
 	public fun getId ()Ljava/lang/String;
+	public fun toString ()Ljava/lang/String;
 }
 
 public abstract class io/sentry/UpdateStatus {
@@ -4365,20 +4366,24 @@ public abstract class io/sentry/UpdateStatus {
 public final class io/sentry/UpdateStatus$NewRelease : io/sentry/UpdateStatus {
 	public fun <init> (Lio/sentry/UpdateInfo;)V
 	public fun getInfo ()Lio/sentry/UpdateInfo;
+	public fun toString ()Ljava/lang/String;
 }
 
 public final class io/sentry/UpdateStatus$NoNetwork : io/sentry/UpdateStatus {
 	public fun <init> (Ljava/lang/String;)V
 	public fun getMessage ()Ljava/lang/String;
+	public fun toString ()Ljava/lang/String;
 }
 
 public final class io/sentry/UpdateStatus$UpToDate : io/sentry/UpdateStatus {
 	public static fun getInstance ()Lio/sentry/UpdateStatus$UpToDate;
+	public fun toString ()Ljava/lang/String;
 }
 
 public final class io/sentry/UpdateStatus$UpdateError : io/sentry/UpdateStatus {
 	public fun <init> (Ljava/lang/String;)V
 	public fun getMessage ()Ljava/lang/String;
+	public fun toString ()Ljava/lang/String;
 }
 
 public final class io/sentry/UserFeedback : io/sentry/JsonSerializable, io/sentry/JsonUnknown {
diff --git a/sentry/src/main/java/io/sentry/UpdateInfo.java b/sentry/src/main/java/io/sentry/UpdateInfo.java
@@ -52,4 +52,27 @@ public int getBuildNumber() {
   public @Nullable String getCreatedDate() {
     return createdDate;
   }
+
+  @Override
+  public String toString() {
+    return "UpdateInfo{"
+        + "id='"
+        + id
+        + '\''
+        + ", buildVersion='"
+        + buildVersion
+        + '\''
+        + ", buildNumber="
+        + buildNumber
+        + ", downloadUrl='"
+        + downloadUrl
+        + '\''
+        + ", appName='"
+        + appName
+        + '\''
+        + ", createdDate='"
+        + createdDate
+        + '\''
+        + '}';
+  }
 }
diff --git a/sentry/src/main/java/io/sentry/UpdateStatus.java b/sentry/src/main/java/io/sentry/UpdateStatus.java

Original file line number	Diff line number	Diff line change
`@@ -161,7 +161,7 @@ subprojects {`
`161`	`161`	`}`
`162`	`162`	`}`
`163`	`163`
`164`		`- if (!this.name.contains("sample") && !this.name.contains("integration-tests") && this.name != "sentry-system-test-support" && this.name != "sentry-test-support" && this.name != "sentry-android-distribution") {`
	`164`	`+ if (!this.name.contains("sample") && !this.name.contains("integration-tests") && this.name != "sentry-system-test-support" && this.name != "sentry-test-support") {`
`165`	`165`	`apply<DistributionPlugin>()`
`166`	`166`	`apply<com.vanniktech.maven.publish.MavenPublishPlugin>()`
`167`	`167`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# sentry-android-distribution`
	`2`	`+`
	`3`	`+This module contains the client library for the Sentry Android Build Distribution that checks for updates for your application automatically for internal testing purposes.`
Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,7 @@ class DistributionHttpClientTest {`
`37`	`37`	`appId = "com.emergetools.hackernews",`
`38`	`38`	`versionName = "1.0.0",`
`39`	`39`	`versionCode = 5L,`
	`40`	`+ buildConfiguration = "release",`
`40`	`41`	`)`
`41`	`42`
`42`	`43`	`val response = httpClient.checkForUpdates(params)`