Simplify Spring integration (#1188)

Fixes #1187

Author: maciejwalkowiak

CHANGELOG.md

@@ -11,6 +11,7 @@
 * Enhancement: Simplify registering traces sample callback in Spring integration (#1184)
 * Enhancement: Polish Performance API (#1165)
 * Enhancement: Set "debug" through external properties (#1186)
+* Enhancement: Simplify Spring integration (#1188)
 
 # 4.0.0-alpha.3
 

buildSrc/src/main/java/Config.kt

@@ -16,6 +16,8 @@ object Config {
         val springBoot = "org.springframework.boot"
         val springDependencyManagement = "io.spring.dependency-management"
         val springDependencyManagementVersion = "1.0.10.RELEASE"
+        val gretty = "org.gretty"
+        val grettyVersion = "3.0.3"
     }
 
     object Android {
@@ -54,6 +56,8 @@ object Config {
         val springBootStarterSecurity = "org.springframework.boot:spring-boot-starter-security:$springBootVersion"
 
         val springWeb = "org.springframework:spring-webmvc"
+        val springSecurityWeb = "org.springframework.security:spring-security-web"
+        val springSecurityConfig = "org.springframework.security:spring-security-config"
         val springAop = "org.springframework:spring-aop"
         val aspectj = "org.aspectj:aspectjweaver"
         val servletApi = "javax.servlet:javax.servlet-api"

sentry-samples/sentry-samples-spring/README.md

@@ -4,16 +4,16 @@ Sample application showing how to use Sentry with [Spring](http://spring.io/).
 
 ## How to run? 
 
-To see events triggered in this sample application in your Sentry dashboard, go to `src/main/java/io/sentry/samples/spring/SentryDemoApplication.java` and replace the test DSN with your own DSN. 
+To see events triggered in this sample application in your Sentry dashboard, go to `src/main/java/io/sentry/samples/spring/SentryConfig.java` and replace the test DSN with your own DSN. 
 
 Then, execute a command from the module directory:
 
 ```
-../../gradlew bootRun
+../../gradlew appRun
 ```
 
 Make an HTTP request that will trigger events:
 
 ```
-curl -XPOST --user user:password http://localhost:8080/person/ -H "Content-Type:application/json" -d '{"firstName":"John","lastName":"Smith"}
+curl -XPOST --user user:password http://localhost:8080/sentry-samples-spring/person/ -H "Content-Type:application/json" -d '{"firstName":"John","lastName":"Smith"}
 ```

sentry-samples/sentry-samples-spring/api/sentry-samples-spring.api

@@ -1,12 +1,13 @@
-public class io/sentry/samples/spring/Person {
-	public fun <init> (Ljava/lang/String;Ljava/lang/String;)V
-	public fun getFirstName ()Ljava/lang/String;
-	public fun getLastName ()Ljava/lang/String;
-	public fun toString ()Ljava/lang/String;
+public class io/sentry/samples/spring/AppConfig {
+	public fun <init> ()V
 }
 
-public class io/sentry/samples/spring/PersonController {
+public class io/sentry/samples/spring/AppInitializer : org/springframework/web/servlet/support/AbstractAnnotationConfigDispatcherServletInitializer {
 	public fun <init> ()V
+	protected fun getRootConfigClasses ()[Ljava/lang/Class;
+	protected fun getServletConfigClasses ()[Ljava/lang/Class;
+	protected fun getServletFilters ()[Ljavax/servlet/Filter;
+	protected fun getServletMappings ()[Ljava/lang/String;
 }
 
 public class io/sentry/samples/spring/SecurityConfiguration : org/springframework/security/config/annotation/web/configuration/WebSecurityConfigurerAdapter {
@@ -15,8 +16,26 @@ public class io/sentry/samples/spring/SecurityConfiguration : org/springframewor
 	public fun userDetailsService ()Lorg/springframework/security/core/userdetails/UserDetailsService;
 }
 
-public class io/sentry/samples/spring/SentryDemoApplication {
+public class io/sentry/samples/spring/SentryConfig {
 	public fun <init> ()V
-	public static fun main ([Ljava/lang/String;)V
+}
+
+public class io/sentry/samples/spring/WebConfig {
+	public fun <init> ()V
+}
+
+public class io/sentry/samples/spring/web/Person {
+	public fun <init> (Ljava/lang/String;Ljava/lang/String;)V
+	public fun getFirstName ()Ljava/lang/String;
+	public fun getLastName ()Ljava/lang/String;
+	public fun toString ()Ljava/lang/String;
+}
+
+public class io/sentry/samples/spring/web/PersonController {
+	public fun <init> (Lio/sentry/samples/spring/web/PersonService;)V
+}
+
+public class io/sentry/samples/spring/web/PersonService {
+	public fun <init> (Lorg/springframework/web/client/RestTemplate;)V
 }
 

sentry-samples/sentry-samples-spring/build.gradle.kts

@@ -2,10 +2,12 @@ import org.jetbrains.kotlin.config.KotlinCompilerVersion
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 plugins {
-    id(Config.BuildPlugins.springBoot) version Config.springBootVersion
+    id(Config.BuildPlugins.springBoot) version Config.springBootVersion apply false
     id(Config.BuildPlugins.springDependencyManagement) version Config.BuildPlugins.springDependencyManagementVersion
     kotlin("jvm")
     kotlin("plugin.spring") version Config.kotlinVersion
+    id("war")
+    id(Config.BuildPlugins.gretty) version Config.BuildPlugins.grettyVersion
 }
 
 group = "io.sentry.sample.spring"
@@ -16,10 +18,20 @@ repositories {
     mavenCentral()
 }
 
+dependencyManagement {
+    imports {
+        mavenBom(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
+    }
+}
+
 dependencies {
-    implementation(Config.Libs.springBootStarterSecurity)
-    implementation(Config.Libs.springBootStarterWeb)
-    implementation(Config.Libs.springBootStarter)
+    implementation(Config.Libs.servletApi)
+    implementation(Config.Libs.springWeb)
+    implementation(Config.Libs.springAop)
+    implementation(Config.Libs.aspectj)
+    implementation(Config.Libs.springSecurityWeb)
+    implementation(Config.Libs.springSecurityConfig)
+    implementation(Config.Libs.logbackClassic)
     implementation("org.jetbrains.kotlin:kotlin-reflect")
     implementation(kotlin(Config.kotlinStdLib, KotlinCompilerVersion.VERSION))
     implementation(project(":sentry-spring"))

sentry-samples/sentry-samples-spring/src/main/java/io/sentry/samples/spring/AppConfig.java

@@ -0,0 +1,8 @@
+package io.sentry.samples.spring;
+
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Import;
+
+@Configuration
+@Import(SentryConfig.class)
+public class AppConfig {}

sentry-samples/sentry-samples-spring/src/main/java/io/sentry/samples/spring/AppInitializer.java

@@ -0,0 +1,35 @@
+package io.sentry.samples.spring;
+
+import io.sentry.spring.tracing.SentryTracingFilter;
+import javax.servlet.Filter;
+import org.springframework.web.filter.DelegatingFilterProxy;
+import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;
+
+public class AppInitializer extends AbstractAnnotationConfigDispatcherServletInitializer {
+
+  @Override
+  protected String[] getServletMappings() {
+    return new String[] {"/*"};
+  }
+
+  @Override
+  protected Class<?>[] getRootConfigClasses() {
+    return new Class<?>[] {AppConfig.class, SecurityConfiguration.class};
+  }
+
+  @Override
+  protected Class<?>[] getServletConfigClasses() {
+    return new Class<?>[] {WebConfig.class};
+  }
+
+  @Override
+  protected Filter[] getServletFilters() {
+    // creates Sentry transactions around incoming HTTP requests
+    SentryTracingFilter sentryTracingFilter = new SentryTracingFilter();
+
+    // filter required by Spring Security
+    DelegatingFilterProxy springSecurityFilterChain = new DelegatingFilterProxy();
+    springSecurityFilterChain.setTargetBeanName("springSecurityFilterChain");
+    return new Filter[] {sentryTracingFilter, springSecurityFilterChain};
+  }
+}

sentry-samples/sentry-samples-spring/src/main/java/io/sentry/samples/spring/SecurityConfiguration.java

@@ -4,6 +4,7 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.security.config.annotation.web.builders.HttpSecurity;
+import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
 import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
 import org.springframework.security.core.userdetails.User;
 import org.springframework.security.core.userdetails.UserDetails;
@@ -13,6 +14,7 @@
 import org.springframework.security.provisioning.InMemoryUserDetailsManager;
 
 @Configuration
+@EnableWebSecurity
 public class SecurityConfiguration extends WebSecurityConfigurerAdapter {
 
   // this API is meant to be consumed by non-browser clients thus the CSRF protection is not needed.

sentry-samples/sentry-samples-spring/src/main/java/io/sentry/samples/spring/SentryConfig.java

@@ -0,0 +1,35 @@
+package io.sentry.samples.spring;
+
+import io.sentry.SentryOptions.TracesSamplerCallback;
+import io.sentry.spring.EnableSentry;
+import io.sentry.spring.tracing.SentryTracingConfiguration;
+import javax.servlet.http.HttpServletRequest;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Import;
+
+// NOTE: Replace the test DSN below with YOUR OWN DSN to see the events from this app in your Sentry
+// project/dashboard
+@EnableSentry(
+    dsn = "https://[email protected]/5428563",
+    sendDefaultPii = true)
+@Import(SentryTracingConfiguration.class)
+public class SentryConfig {
+
+  /**
+   * Configures callback used to determine if transaction should be sampled.
+   *
+   * @return traces sampler callback
+   */
+  @Bean
+  TracesSamplerCallback tracesSamplerCallback() {
+    return samplingContext -> {
+      HttpServletRequest request =
+          (HttpServletRequest) samplingContext.getCustomSamplingContext().get("request");
+      if ("/error".equals(request.getRequestURI())) {
+        return 0.5d;
+      } else {
+        return 1.0d;
+      }
+    };
+  }
+}