Auto-configure inAppIncludes in Spring Boot integration.

CHANGELOG.md

@@ -1,5 +1,6 @@
 # 3.0.1
 
+* Auto-Configure `inAppIncludes` in Spring Boot integration
 * fix: Don't require `sentry.dsn` to be set when using `io.sentry:sentry-spring-boot-starter` and `io.sentry:sentry-logback` together
 
 # 3.0.0

sentry-spring-boot-starter/src/main/java/io/sentry/spring/boot/InAppIncludesResolver.java

@@ -0,0 +1,43 @@
+package io.sentry.spring.boot;
+
+import com.jakewharton.nopen.annotation.Open;
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+import org.springframework.beans.BeansException;
+import org.springframework.boot.SpringBootConfiguration;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.ApplicationContext;
+import org.springframework.context.ApplicationContextAware;
+
+/**
+ * Resolves {@link SentryProperties} inAppIncludes by getting a package name from a class annotated
+ * with {@link SpringBootConfiguration} or another annotation meta-annotated with {@link
+ * SpringBootConfiguration} like {@link SpringBootApplication}.
+ */
+@Open
+class InAppIncludesResolver implements ApplicationContextAware {
+  private @Nullable ApplicationContext applicationContext;
+
+  @Nullable
+  List<String> resolveInAppIncludes() {
+    if (applicationContext != null) {
+      Map<String, Object> beansWithAnnotation =
+          applicationContext.getBeansWithAnnotation(SpringBootConfiguration.class);
+      return beansWithAnnotation.values().stream()
+          .map(bean -> bean.getClass().getPackage().getName())
+          .collect(Collectors.toList());
+    } else {
+      return Collections.emptyList();
+    }
+  }
+
+  @Override
+  public void setApplicationContext(@NotNull ApplicationContext applicationContext)
+      throws BeansException {
+    this.applicationContext = applicationContext;
+  }
+}

sentry-spring-boot-starter/src/main/java/io/sentry/spring/boot/SentryAutoConfiguration.java

@@ -46,7 +46,8 @@ static class HubConfiguration {
         final @NotNull List<Integration> integrations,
         final @NotNull ObjectProvider<ITransportGate> transportGate,
         final @NotNull ObjectProvider<SentryUserProvider> sentryUserProviders,
-        final @NotNull ObjectProvider<ITransport> transport) {
+        final @NotNull ObjectProvider<ITransport> transport,
+        final @NotNull InAppIncludesResolver inAppPackagesResolver) {
       return options -> {
         beforeSendCallback.ifAvailable(options::setBeforeSend);
         beforeBreadcrumbCallback.ifAvailable(options::setBeforeBreadcrumb);
@@ -58,9 +59,15 @@ static class HubConfiguration {
                     new SentryUserProviderEventProcessor(sentryUserProvider)));
         transportGate.ifAvailable(options::setTransportGate);
         transport.ifAvailable(options::setTransport);
+        inAppPackagesResolver.resolveInAppIncludes().forEach(options::addInAppInclude);
       };
     }
 
+    @Bean
+    public @NotNull InAppIncludesResolver inAppPackagesResolver() {
+      return new InAppIncludesResolver();
+    }
+
     @Bean
     public @NotNull IHub sentryHub(
         final @NotNull Sentry.OptionsConfiguration<SentryOptions> optionsConfiguration,

sentry-spring-boot-starter/src/test/kotlin/com/acme/MainBootClass.kt

@@ -0,0 +1,6 @@
+package com.acme
+
+import org.springframework.boot.autoconfigure.SpringBootApplication
+
+@SpringBootApplication
+open class MainBootClass

sentry-spring-boot-starter/src/test/kotlin/io/sentry/spring/boot/SentryAutoConfigurationTest.kt

@@ -1,5 +1,6 @@
 package io.sentry.spring.boot
 
+import com.acme.MainBootClass
 import com.nhaarman.mockitokotlin2.mock
 import com.nhaarman.mockitokotlin2.verify
 import com.nhaarman.mockitokotlin2.whenever
@@ -205,6 +206,16 @@ class SentryAutoConfigurationTest {
             }
     }
 
+    @Test
+    fun `sets inAppIncludes on SentryOptions from a class annotated with @SpringBootApplication`() {
+        contextRunner.withPropertyValues("sentry.dsn=http://key@localhost/proj")
+            .withUserConfiguration(MainBootClass::class.java)
+            .run {
+                assertThat(it.getBean(SentryProperties::class.java).inAppIncludes)
+                    .containsOnly("com.acme")
+            }
+    }
+
     @Configuration(proxyBeanMethods = false)
     open class CustomOptionsConfigurationConfiguration {