Merge pull request #5799 from getsentry/feat/data-collection-resolver

feat(core): [Data Collection 3] Add policy resolver

Author: adinauer

sentry/api/sentry.api

@@ -415,6 +415,22 @@ public final class io/sentry/DataCollection$HttpHeaders {
 	public fun setResponse (Lio/sentry/KeyValueCollectionBehavior;)V
 }
 
+public final class io/sentry/DataCollectionResolver {
+	public fun getCookies ()Lio/sentry/KeyValueCollectionBehavior;
+	public fun getHttpRequestHeaders ()Lio/sentry/KeyValueCollectionBehavior;
+	public fun getHttpResponseHeaders ()Lio/sentry/KeyValueCollectionBehavior;
+	public fun getUrlQueryParams ()Lio/sentry/KeyValueCollectionBehavior;
+	public fun isDataCollectionConfigured ()Z
+	public fun isDatabaseQueryData ()Z
+	public fun isGraphqlDocument ()Z
+	public fun isGraphqlVariables ()Z
+	public fun isIncomingRequestBody ()Z
+	public fun isIncomingResponseBody ()Z
+	public fun isOutgoingRequestBody ()Z
+	public fun isOutgoingResponseBody ()Z
+	public fun isUserInfo ()Z
+}
+
 public final class io/sentry/DateUtils {
 	public static fun dateToSeconds (Ljava/util/Date;)D
 	public static fun doubleToBigDecimal (D)Ljava/math/BigDecimal;
@@ -3696,6 +3712,7 @@ public class io/sentry/SentryOptions {
 	public fun getContinuousProfiler ()Lio/sentry/IContinuousProfiler;
 	public fun getCron ()Lio/sentry/SentryOptions$Cron;
 	public fun getDataCollection ()Lio/sentry/DataCollection;
+	public fun getDataCollectionResolver ()Lio/sentry/DataCollectionResolver;
 	public fun getDateProvider ()Lio/sentry/SentryDateProvider;
 	public fun getDeadlineTimeout ()J
 	public fun getDebugMetaLoader ()Lio/sentry/internal/debugmeta/IDebugMetaLoader;

sentry/src/main/java/io/sentry/DataCollectionResolver.java

@@ -0,0 +1,105 @@
+package io.sentry;
+
+import java.util.Set;
+import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+/** Resolves effective Data Collection policies for SDK integrations. */
+@ApiStatus.Internal
+public final class DataCollectionResolver {
+
+  private static final @NotNull KeyValueCollectionBehavior OFF = KeyValueCollectionBehavior.off();
+  private static final @NotNull KeyValueCollectionBehavior EMPTY_DENY_LIST =
+      KeyValueCollectionBehavior.denyList();
+
+  private final @NotNull SentryOptions options;
+
+  DataCollectionResolver(final @NotNull SentryOptions options) {
+    this.options = options;
+  }
+
+  public boolean isDataCollectionConfigured() {
+    return options.getDataCollection().isExplicitlyConfigured();
+  }
+
+  public boolean isUserInfo() {
+    return explicitOrSendDefaultPii(options.getDataCollection().getUserInfo(), true);
+  }
+
+  public boolean isDatabaseQueryData() {
+    return explicitOrSendDefaultPii(options.getDataCollection().getDatabaseQueryData(), true);
+  }
+
+  public boolean isGraphqlDocument() {
+    return explicitOrSendDefaultPii(options.getDataCollection().getGraphql().getDocument(), true);
+  }
+
+  public boolean isGraphqlVariables() {
+    return explicitOrSendDefaultPii(options.getDataCollection().getGraphql().getVariables(), true);
+  }
+
+  public @NotNull KeyValueCollectionBehavior getCookies() {
+    final @NotNull DataCollection dataCollection = options.getDataCollection();
+    final @Nullable KeyValueCollectionBehavior cookies = dataCollection.getCookies();
+
+    if (cookies != null) {
+      return cookies;
+    }
+    if (isDataCollectionConfigured()) {
+      return EMPTY_DENY_LIST;
+    }
+    return options.isSendDefaultPii() ? EMPTY_DENY_LIST : OFF;
+  }
+
+  public @NotNull KeyValueCollectionBehavior getUrlQueryParams() {
+    return explicitOrEmptyDenyList(options.getDataCollection().getUrlQueryParams());
+  }
+
+  public @NotNull KeyValueCollectionBehavior getHttpRequestHeaders() {
+    return explicitOrEmptyDenyList(options.getDataCollection().getHttpHeaders().getRequest());
+  }
+
+  public @NotNull KeyValueCollectionBehavior getHttpResponseHeaders() {
+    return explicitOrEmptyDenyList(options.getDataCollection().getHttpHeaders().getResponse());
+  }
+
+  public boolean isIncomingRequestBody() {
+    return isHttpBodyEnabled(HttpBodyType.INCOMING_REQUEST, options.isSendDefaultPii());
+  }
+
+  public boolean isOutgoingRequestBody() {
+    return isHttpBodyEnabled(HttpBodyType.OUTGOING_REQUEST, true);
+  }
+
+  public boolean isIncomingResponseBody() {
+    return isHttpBodyEnabled(HttpBodyType.INCOMING_RESPONSE, true);
+  }
+
+  public boolean isOutgoingResponseBody() {
+    return isHttpBodyEnabled(HttpBodyType.OUTGOING_RESPONSE, options.isSendDefaultPii());
+  }
+
+  private boolean explicitOrSendDefaultPii(
+      final @Nullable Boolean explicit, final boolean defaultValue) {
+    if (explicit != null) {
+      return explicit;
+    }
+    return isDataCollectionConfigured() ? defaultValue : options.isSendDefaultPii();
+  }
+
+  private @NotNull KeyValueCollectionBehavior explicitOrEmptyDenyList(
+      final @Nullable KeyValueCollectionBehavior explicit) {
+    return explicit != null ? explicit : EMPTY_DENY_LIST;
+  }
+
+  private boolean isHttpBodyEnabled(
+      final @NotNull HttpBodyType bodyType, final boolean legacyFallback) {
+    final @NotNull DataCollection dataCollection = options.getDataCollection();
+    final @Nullable Set<HttpBodyType> httpBodies = dataCollection.getHttpBodies();
+    if (httpBodies != null) {
+      return httpBodies.contains(bodyType);
+    }
+    return isDataCollectionConfigured() || legacyFallback;
+  }
+}

sentry/src/main/java/io/sentry/SentryOptions.java

@@ -340,6 +340,9 @@ public class SentryOptions {
 
   private @NotNull DataCollection dataCollection = new DataCollection(false);
 
+  private final @NotNull DataCollectionResolver dataCollectionResolver =
+      new DataCollectionResolver(this);
+
   /** SSLSocketFactory for self-signed certificate trust * */
   private @Nullable SSLSocketFactory sslSocketFactory;
 
@@ -1720,6 +1723,12 @@ public void setDataCollection(final @NotNull DataCollection dataCollection) {
     }
   }
 
+  /** Returns the Data Collection policy resolver used by SDK integrations. */
+  @ApiStatus.Internal
+  public @NotNull DataCollectionResolver getDataCollectionResolver() {
+    return dataCollectionResolver;
+  }
+
   /**
    * Adds a Scope observer
    *