feat(android-distribution): Add build_configuration support and fix response parsing

runningcode · claude · runningcode · commit ad4961a0fc8b · 2025-10-10T16:58:44.000+02:00
- Add required buildConfiguration parameter to UpdateCheckParams - Update checkForUpdates to include build_configuration query parameter - Add debug logging to print full URL for debugging - Fix response parser to use correct backend format (update object instead of updateAvailable boolean) - Fix response parser to use snake_case field names to match backend API - Add toString methods to UpdateInfo and UpdateStatus classes for better debugging - Update all tests to match new response format 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
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
@@ -4354,6 +4354,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 {
@@ -4363,20 +4364,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
@@ -16,6 +16,11 @@ private UpToDate() {}
     public static UpToDate getInstance() {
       return INSTANCE;
     }
+
+    @Override
+    public String toString() {
+      return "UpdateStatus.UpToDate{}";
+    }
   }
 
   /** A new release is available for download. */
@@ -29,6 +34,11 @@ public NewRelease(final @NotNull UpdateInfo info) {
     public @NotNull UpdateInfo getInfo() {
       return info;
     }
+
+    @Override
+    public String toString() {
+      return "UpdateStatus.NewRelease{" + "info=" + info + '}';
+    }
   }
 
   /** An error occurred during the update check. */
@@ -42,6 +52,11 @@ public UpdateError(final @NotNull String message) {
     public @NotNull String getMessage() {
       return message;
     }
+
+    @Override
+    public String toString() {
+      return "UpdateStatus.UpdateError{" + "message='" + message + '\'' + '}';
+    }
   }
 
   /** No network connection is available to check for updates. */
@@ -55,5 +70,10 @@ public NoNetwork(final @NotNull String message) {
     public @NotNull String getMessage() {
       return message;
     }
+
+    @Override
+    public String toString() {
+      return "UpdateStatus.NoNetwork{" + "message='" + message + '\'' + '}';
+    }
   }
 }

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)`
Original file line number	Diff line number	Diff line change
`@@ -4354,6 +4354,7 @@ public final class io/sentry/UpdateInfo {`
`4354`	`4354`	`public fun getCreatedDate ()Ljava/lang/String;`
`4355`	`4355`	`public fun getDownloadUrl ()Ljava/lang/String;`
`4356`	`4356`	`public fun getId ()Ljava/lang/String;`
	`4357`	`+ public fun toString ()Ljava/lang/String;`
`4357`	`4358`	`}`
`4358`	`4359`
`4359`	`4360`	`public abstract class io/sentry/UpdateStatus {`
`@@ -4363,20 +4364,24 @@ public abstract class io/sentry/UpdateStatus {`
`4363`	`4364`	`public final class io/sentry/UpdateStatus$NewRelease : io/sentry/UpdateStatus {`
`4364`	`4365`	`public fun <init> (Lio/sentry/UpdateInfo;)V`
`4365`	`4366`	`public fun getInfo ()Lio/sentry/UpdateInfo;`
	`4367`	`+ public fun toString ()Ljava/lang/String;`
`4366`	`4368`	`}`
`4367`	`4369`
`4368`	`4370`	`public final class io/sentry/UpdateStatus$NoNetwork : io/sentry/UpdateStatus {`
`4369`	`4371`	`public fun <init> (Ljava/lang/String;)V`
`4370`	`4372`	`public fun getMessage ()Ljava/lang/String;`
	`4373`	`+ public fun toString ()Ljava/lang/String;`
`4371`	`4374`	`}`
`4372`	`4375`
`4373`	`4376`	`public final class io/sentry/UpdateStatus$UpToDate : io/sentry/UpdateStatus {`
`4374`	`4377`	`public static fun getInstance ()Lio/sentry/UpdateStatus$UpToDate;`
	`4378`	`+ public fun toString ()Ljava/lang/String;`
`4375`	`4379`	`}`
`4376`	`4380`
`4377`	`4381`	`public final class io/sentry/UpdateStatus$UpdateError : io/sentry/UpdateStatus {`
`4378`	`4382`	`public fun <init> (Ljava/lang/String;)V`
`4379`	`4383`	`public fun getMessage ()Ljava/lang/String;`
	`4384`	`+ public fun toString ()Ljava/lang/String;`
`4380`	`4385`	`}`
`4381`	`4386`
`4382`	`4387`	`public final class io/sentry/UserFeedback : io/sentry/JsonSerializable, io/sentry/JsonUnknown {`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,11 @@ private UpToDate() {}`
`16`	`16`	`public static UpToDate getInstance() {`
`17`	`17`	`return INSTANCE;`
`18`	`18`	`}`
	`19`	`+`
	`20`	`+ @Override`
	`21`	`+ public String toString() {`
	`22`	`+ return "UpdateStatus.UpToDate{}";`
	`23`	`+ }`
`19`	`24`	`}`
`20`	`25`
`21`	`26`	`/** A new release is available for download. */`
`@@ -29,6 +34,11 @@ public NewRelease(final @NotNull UpdateInfo info) {`
`29`	`34`	`public @NotNull UpdateInfo getInfo() {`
`30`	`35`	`return info;`
`31`	`36`	`}`
	`37`	`+`
	`38`	`+ @Override`
	`39`	`+ public String toString() {`
	`40`	`+ return "UpdateStatus.NewRelease{" + "info=" + info + '}';`
	`41`	`+ }`
`32`	`42`	`}`
`33`	`43`
`34`	`44`	`/** An error occurred during the update check. */`
`@@ -42,6 +52,11 @@ public UpdateError(final @NotNull String message) {`
`42`	`52`	`public @NotNull String getMessage() {`
`43`	`53`	`return message;`
`44`	`54`	`}`
	`55`	`+`
	`56`	`+ @Override`
	`57`	`+ public String toString() {`
	`58`	`+ return "UpdateStatus.UpdateError{" + "message='" + message + '\'' + '}';`
	`59`	`+ }`
`45`	`60`	`}`
`46`	`61`
`47`	`62`	`/** No network connection is available to check for updates. */`
`@@ -55,5 +70,10 @@ public NoNetwork(final @NotNull String message) {`
`55`	`70`	`public @NotNull String getMessage() {`
`56`	`71`	`return message;`
`57`	`72`	`}`
	`73`	`+`
	`74`	`+ @Override`
	`75`	`+ public String toString() {`
	`76`	`+ return "UpdateStatus.NoNetwork{" + "message='" + message + '\'' + '}';`
	`77`	`+ }`
`58`	`78`	`}`
`59`	`79`	`}`