Merge branch 'main' into add-pr-template

Author: adinauer

.cursor/rules/new_module.mdc

@@ -0,0 +1,88 @@
+---
+description: Module Addition Rules for sentry-java
+alwaysApply: false
+---
+# Module Addition Rules for sentry-java
+
+## Overview
+
+This document outlines the complete process for adding a new module to the sentry-java repository. Follow these steps in order to ensure proper integration and release management.
+
+## Step-by-Step Process
+
+### 1. Create the Module Structure
+
+1. Create the new module, conforming to the existing naming conventions and build scripts
+
+2. Add the module to the include list in `settings.gradle.kts`
+
+If adding a `sentry-samples` module, also add it to the `ignoredProjects` list in the root `build.gradle.kts`:
+
+```kotlin
+ignoredProjects.addAll(
+    listOf(
+        // ... existing projects ...
+        "sentry-samples-{module-name}"
+    )
+)
+```
+
+3. If adding a JVM sample, add E2E (system) tests, following the structure we have in the existing JVM examples.
+   The test should then be added to `test/system-test-runner.py` and `.github/workflows/system-tests-backend.yml`.
+
+### 2. Create Module Documentation
+
+Create a `README.md` in the module directory with the following structure:
+
+```markdown
+# sentry-{module-name}
+
+This module provides an integration for [Technology/Framework Name].
+
+Please consult the documentation on how to install and use this integration in the Sentry Docs for [Android](https://docs.sentry.io/platforms/android/integrations/{module-name}/) or [Java](https://docs.sentry.io/platforms/java/tracing/instrumentation/{module-name}/).
+```
+
+The following tasks are required only when adding a module that isn't a sample.
+
+### 3. Update Main README.md
+
+Add the new module to the packages table in the main `README.md` with a placeholder link to the badge:
+
+```markdown
+| sentry-{module-name} | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-{module-name}/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-{module-name}) | |
+```
+
+Note that the badge will only work after the module is released to Maven Central.
+
+### 4. Add Documentation to docs.sentry.io
+
+Add the necessary documentation to [docs.sentry.io](https://docs.sentry.io):
+- For Java modules: Add to Java platform docs, usually in integrations section
+- For Android modules: Add to Android platform docs, usually in integrations section
+- Include installation instructions, configuration options, and usage examples
+
+### 5. Post release tasks
+
+Remind the user to perform the following tasks after the module is merged and released:
+
+1. Add the SDK to the Sentry release registry, following the instructions in the [sentry-release-registry README](https://github.com/getsentry/sentry-release-registry#adding-new-sdks)
+
+2. Add the module to `.craft.yml` in the `sdks` section:
+   ```yaml
+   sdks:
+     # ... existing modules ...
+     maven:io.sentry:sentry-{module-name}:
+   ```
+
+## Module Naming Conventions
+
+- Use kebab-case for module names: `sentry-{module-name}`
+- Follow existing patterns: `sentry-okhttp`, `sentry-apollo-4`, `sentry-spring-boot`
+- For version-specific modules, include the version: `sentry-apollo-3`, `sentry-apollo-4`
+
+## Important Notes
+
+1. **API Files**: Do not modify `.api` files manually. Run `./gradlew apiDump` to regenerate them
+2. **Backwards Compatibility**: Ensure new features are opt-in by default
+3. **Testing**: Write comprehensive tests for all new functionality
+4. **Documentation**: Always include proper documentation and examples

.cursor/rules/overview_dev.mdc

@@ -42,6 +42,8 @@ Use the `fetch_rules` tool to include these rules when working on specific areas
   - `OtelSpanFactory`, `SentrySpanExporter`
   - Tracing, distributed tracing
 
+- **`new_module`**: Use when adding a new integration or sample module
+
 ### Testing
 - **`e2e_tests`**: Use when working with:
   - System tests, sample applications
@@ -58,5 +60,6 @@ Use the `fetch_rules` tool to include these rules when working on specific areas
    - Scope/Hub/forking → `scopes`
    - Duplicate/dedup → `deduplication` 
    - OpenTelemetry/tracing/spans → `opentelemetry`
+   - new module/integration/sample → `new_module`
    - Cache/offline/network → `offline`
    - System test/e2e/sample → `e2e_tests`

sentry-android-core/proguard-rules.pro

@@ -80,6 +80,6 @@
 ##---------------End: proguard configuration for sentry-android-replay  ----------
 
 ##---------------Begin: proguard configuration for sentry-android-distribution  ----------
--dontwarn io.sentry.android.distribution.internal.DistributionIntegration
--keepnames class io.sentry.android.distribution.internal.DistributionIntegration
+-dontwarn io.sentry.android.distribution.DistributionIntegration
+-keepnames class io.sentry.android.distribution.DistributionIntegration
 ##---------------End: proguard configuration for sentry-android-distribution  ----------

sentry-android-core/src/main/java/io/sentry/android/core/AndroidOptionsInitializer.java

@@ -32,7 +32,7 @@
 import io.sentry.android.core.internal.util.AndroidThreadChecker;
 import io.sentry.android.core.internal.util.SentryFrameMetricsCollector;
 import io.sentry.android.core.performance.AppStartMetrics;
-import io.sentry.android.distribution.internal.DistributionIntegration;
+import io.sentry.android.distribution.DistributionIntegration;
 import io.sentry.android.fragment.FragmentLifecycleIntegration;
 import io.sentry.android.replay.DefaultReplayBreadcrumbConverter;
 import io.sentry.android.replay.ReplayIntegration;
@@ -394,7 +394,9 @@ static void installDefaultIntegrations(
       options.setReplayController(replay);
     }
     if (isDistributionAvailable) {
-      options.addIntegration(new DistributionIntegration());
+      final DistributionIntegration distribution = new DistributionIntegration((context));
+      options.setDistributionController(distribution);
+      options.addIntegration(distribution);
     }
     options
         .getFeedbackOptions()

sentry-android-core/src/main/java/io/sentry/android/core/SentryAndroid.java

@@ -42,7 +42,7 @@ public final class SentryAndroid {
       "io.sentry.android.replay.ReplayIntegration";
 
   static final String SENTRY_DISTRIBUTION_INTEGRATION_CLASS_NAME =
-      "io.sentry.android.distribution.internal.DistributionIntegration";
+      "io.sentry.android.distribution.DistributionIntegration";
 
   private static final String TIMBER_CLASS_NAME = "timber.log.Timber";
   private static final String FRAGMENT_CLASS_NAME =

sentry-android-distribution/api/sentry-android-distribution.api

@@ -1,79 +1,8 @@
-public final class io/sentry/android/distribution/Distribution {
-	public static final field INSTANCE Lio/sentry/android/distribution/Distribution;
-	public final fun checkForUpdate (Landroid/content/Context;Lkotlin/jvm/functions/Function1;)V
-	public final fun checkForUpdateBlocking (Landroid/content/Context;)Lio/sentry/android/distribution/UpdateStatus;
-	public final fun downloadUpdate (Landroid/content/Context;Lio/sentry/android/distribution/UpdateInfo;)V
-	public final fun init (Landroid/content/Context;)V
-	public final fun init (Landroid/content/Context;Lkotlin/jvm/functions/Function1;)V
-	public final fun isEnabled ()Z
-}
-
-public final class io/sentry/android/distribution/DistributionOptions {
-	public fun <init> ()V
-	public final fun getBuildConfiguration ()Ljava/lang/String;
-	public final fun getOrgAuthToken ()Ljava/lang/String;
-	public final fun getOrganizationSlug ()Ljava/lang/String;
-	public final fun getProjectSlug ()Ljava/lang/String;
-	public final fun getSentryBaseUrl ()Ljava/lang/String;
-	public final fun setBuildConfiguration (Ljava/lang/String;)V
-	public final fun setOrgAuthToken (Ljava/lang/String;)V
-	public final fun setOrganizationSlug (Ljava/lang/String;)V
-	public final fun setProjectSlug (Ljava/lang/String;)V
-	public final fun setSentryBaseUrl (Ljava/lang/String;)V
-}
-
-public final class io/sentry/android/distribution/UpdateInfo {
-	public fun <init> (Ljava/lang/String;Ljava/lang/String;ILjava/lang/String;Ljava/lang/String;Ljava/lang/String;)V
-	public final fun component1 ()Ljava/lang/String;
-	public final fun component2 ()Ljava/lang/String;
-	public final fun component3 ()I
-	public final fun component4 ()Ljava/lang/String;
-	public final fun component5 ()Ljava/lang/String;
-	public final fun component6 ()Ljava/lang/String;
-	public final fun copy (Ljava/lang/String;Ljava/lang/String;ILjava/lang/String;Ljava/lang/String;Ljava/lang/String;)Lio/sentry/android/distribution/UpdateInfo;
-	public static synthetic fun copy$default (Lio/sentry/android/distribution/UpdateInfo;Ljava/lang/String;Ljava/lang/String;ILjava/lang/String;Ljava/lang/String;Ljava/lang/String;ILjava/lang/Object;)Lio/sentry/android/distribution/UpdateInfo;
-	public fun equals (Ljava/lang/Object;)Z
-	public final fun getAppName ()Ljava/lang/String;
-	public final fun getBuildNumber ()I
-	public final fun getBuildVersion ()Ljava/lang/String;
-	public final fun getCreatedDate ()Ljava/lang/String;
-	public final fun getDownloadUrl ()Ljava/lang/String;
-	public final fun getId ()Ljava/lang/String;
-	public fun hashCode ()I
-	public fun toString ()Ljava/lang/String;
-}
-
-public abstract class io/sentry/android/distribution/UpdateStatus {
-}
-
-public final class io/sentry/android/distribution/UpdateStatus$Error : io/sentry/android/distribution/UpdateStatus {
-	public fun <init> (Ljava/lang/String;)V
-	public final fun component1 ()Ljava/lang/String;
-	public final fun copy (Ljava/lang/String;)Lio/sentry/android/distribution/UpdateStatus$Error;
-	public static synthetic fun copy$default (Lio/sentry/android/distribution/UpdateStatus$Error;Ljava/lang/String;ILjava/lang/Object;)Lio/sentry/android/distribution/UpdateStatus$Error;
-	public fun equals (Ljava/lang/Object;)Z
-	public final fun getMessage ()Ljava/lang/String;
-	public fun hashCode ()I
-	public fun toString ()Ljava/lang/String;
-}
-
-public final class io/sentry/android/distribution/UpdateStatus$NewRelease : io/sentry/android/distribution/UpdateStatus {
-	public fun <init> (Lio/sentry/android/distribution/UpdateInfo;)V
-	public final fun component1 ()Lio/sentry/android/distribution/UpdateInfo;
-	public final fun copy (Lio/sentry/android/distribution/UpdateInfo;)Lio/sentry/android/distribution/UpdateStatus$NewRelease;
-	public static synthetic fun copy$default (Lio/sentry/android/distribution/UpdateStatus$NewRelease;Lio/sentry/android/distribution/UpdateInfo;ILjava/lang/Object;)Lio/sentry/android/distribution/UpdateStatus$NewRelease;
-	public fun equals (Ljava/lang/Object;)Z
-	public final fun getInfo ()Lio/sentry/android/distribution/UpdateInfo;
-	public fun hashCode ()I
-	public fun toString ()Ljava/lang/String;
-}
-
-public final class io/sentry/android/distribution/UpdateStatus$UpToDate : io/sentry/android/distribution/UpdateStatus {
-	public static final field INSTANCE Lio/sentry/android/distribution/UpdateStatus$UpToDate;
-}
-
-public final class io/sentry/android/distribution/internal/DistributionIntegration : io/sentry/Integration {
-	public fun <init> ()V
+public final class io/sentry/android/distribution/DistributionIntegration : io/sentry/IDistributionApi, io/sentry/Integration {
+	public fun <init> (Landroid/content/Context;)V
+	public fun checkForUpdate (Lio/sentry/IDistributionApi$UpdateCallback;)V
+	public fun checkForUpdateBlocking ()Lio/sentry/UpdateStatus;
+	public fun downloadUpdate (Lio/sentry/UpdateInfo;)V
 	public fun register (Lio/sentry/IScopes;Lio/sentry/SentryOptions;)V
 }
 

sentry-android-distribution/build.gradle.kts

@@ -25,5 +25,8 @@ androidComponents.beforeVariants {
 
 dependencies {
   implementation(projects.sentry)
+  implementation(
+    libs.jetbrains.annotations
+  ) // Use implementation instead of compileOnly to override kotlin stdlib's version
   implementation(kotlin(Config.kotlinStdLib, Config.kotlinStdLibVersionAndroid))
 }