SchedulerFactoryBeanCustomizer now runs first so user customization is not overridden

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## Unreleased
+
+### Fixes
+
+- SchedulerFactoryBeanCustomizer now runs first so user customization is not overridden ([#3095](https://github.com/getsentry/sentry-java/pull/3095))
+  - If you are setting global job listeners please also add `SentryJobListener`
+
 ## 7.1.0
 
 ### Features

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

@@ -37,10 +37,15 @@ import org.mockito.kotlin.anyOrNull
 import org.mockito.kotlin.mock
 import org.mockito.kotlin.verify
 import org.mockito.kotlin.whenever
+import org.quartz.JobExecutionContext
+import org.quartz.JobExecutionException
+import org.quartz.JobListener
+import org.quartz.Scheduler
 import org.quartz.core.QuartzScheduler
 import org.slf4j.MDC
 import org.springframework.aop.support.NameMatchMethodPointcut
 import org.springframework.boot.autoconfigure.AutoConfigurations
+import org.springframework.boot.autoconfigure.quartz.QuartzAutoConfiguration
 import org.springframework.boot.autoconfigure.quartz.SchedulerFactoryBeanCustomizer
 import org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration
 import org.springframework.boot.context.annotation.UserConfigurations
@@ -784,6 +789,61 @@ class SentryAutoConfigurationTest {
             }
     }
 
+    @Test
+    fun `Sentry quartz job listener is added`() {
+        contextRunner.withPropertyValues("sentry.dsn=http://key@localhost/proj", "sentry.enable-automatic-checkins=true")
+            .withUserConfiguration(QuartzAutoConfiguration::class.java)
+            .run {
+                val jobListeners = it.getBean(Scheduler::class.java).listenerManager.jobListeners
+                assertThat(jobListeners).hasSize(1)
+                assertThat(jobListeners[0]).matches(
+                    { it.name == "sentry-job-listener" },
+                    "is sentry job listener"
+                )
+            }
+    }
+
+    @Test
+    fun `user defined SchedulerFactoryBeanCustomizer overrides Sentry Customizer`() {
+        contextRunner.withPropertyValues("sentry.dsn=http://key@localhost/proj", "sentry.enable-automatic-checkins=true")
+            .withUserConfiguration(QuartzAutoConfiguration::class.java, CustomSchedulerFactoryBeanCustomizerConfiguration::class.java)
+            .run {
+                val jobListeners = it.getBean(Scheduler::class.java).listenerManager.jobListeners
+                assertThat(jobListeners).hasSize(1)
+                assertThat(jobListeners[0]).matches(
+                    { it.name == "custom-job-listener" },
+                    "is custom job listener"
+                )
+            }
+    }
+
+    @Configuration(proxyBeanMethods = false)
+    open class CustomSchedulerFactoryBeanCustomizerConfiguration {
+        class MyJobListener : JobListener {
+            override fun getName() = "custom-job-listener"
+
+            override fun jobToBeExecuted(context: JobExecutionContext?) {
+                // do nothing
+            }
+
+            override fun jobExecutionVetoed(context: JobExecutionContext?) {
+                // do nothing
+            }
+
+            override fun jobWasExecuted(
+                context: JobExecutionContext?,
+                jobException: JobExecutionException?
+            ) {
+                // do nothing
+            }
+        }
+
+        @Bean
+        open fun mySchedulerFactoryBeanCustomizer(): SchedulerFactoryBeanCustomizer {
+            return SchedulerFactoryBeanCustomizer { schedulerFactoryBean -> schedulerFactoryBean.setGlobalJobListeners(MyJobListener()) }
+        }
+    }
+
     @Configuration(proxyBeanMethods = false)
     open class CustomOptionsConfigurationConfiguration {
 

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

@@ -36,10 +36,15 @@ import org.mockito.kotlin.anyOrNull
 import org.mockito.kotlin.mock
 import org.mockito.kotlin.verify
 import org.mockito.kotlin.whenever
+import org.quartz.JobExecutionContext
+import org.quartz.JobExecutionException
+import org.quartz.JobListener
+import org.quartz.Scheduler
 import org.quartz.core.QuartzScheduler
 import org.slf4j.MDC
 import org.springframework.aop.support.NameMatchMethodPointcut
 import org.springframework.boot.autoconfigure.AutoConfigurations
+import org.springframework.boot.autoconfigure.quartz.QuartzAutoConfiguration
 import org.springframework.boot.autoconfigure.quartz.SchedulerFactoryBeanCustomizer
 import org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration
 import org.springframework.boot.context.annotation.UserConfigurations
@@ -784,6 +789,61 @@ class SentryAutoConfigurationTest {
             }
     }
 
+    @Test
+    fun `Sentry quartz job listener is added`() {
+        contextRunner.withPropertyValues("sentry.dsn=http://key@localhost/proj", "sentry.enable-automatic-checkins=true")
+            .withUserConfiguration(QuartzAutoConfiguration::class.java)
+            .run {
+                val jobListeners = it.getBean(Scheduler::class.java).listenerManager.jobListeners
+                assertThat(jobListeners).hasSize(1)
+                assertThat(jobListeners[0]).matches(
+                    { it.name == "sentry-job-listener" },
+                    "is sentry job listener"
+                )
+            }
+    }
+
+    @Test
+    fun `user defined SchedulerFactoryBeanCustomizer overrides Sentry Customizer`() {
+        contextRunner.withPropertyValues("sentry.dsn=http://key@localhost/proj", "sentry.enable-automatic-checkins=true")
+            .withUserConfiguration(QuartzAutoConfiguration::class.java, CustomSchedulerFactoryBeanCustomizerConfiguration::class.java)
+            .run {
+                val jobListeners = it.getBean(Scheduler::class.java).listenerManager.jobListeners
+                assertThat(jobListeners).hasSize(1)
+                assertThat(jobListeners[0]).matches(
+                    { it.name == "custom-job-listener" },
+                    "is custom job listener"
+                )
+            }
+    }
+
+    @Configuration(proxyBeanMethods = false)
+    open class CustomSchedulerFactoryBeanCustomizerConfiguration {
+        class MyJobListener : JobListener {
+            override fun getName() = "custom-job-listener"
+
+            override fun jobToBeExecuted(context: JobExecutionContext?) {
+                // do nothing
+            }
+
+            override fun jobExecutionVetoed(context: JobExecutionContext?) {
+                // do nothing
+            }
+
+            override fun jobWasExecuted(
+                context: JobExecutionContext?,
+                jobException: JobExecutionException?
+            ) {
+                // do nothing
+            }
+        }
+
+        @Bean
+        open fun mySchedulerFactoryBeanCustomizer(): SchedulerFactoryBeanCustomizer {
+            return SchedulerFactoryBeanCustomizer { schedulerFactoryBean -> schedulerFactoryBean.setGlobalJobListeners(MyJobListener()) }
+        }
+    }
+
     @Configuration(proxyBeanMethods = false)
     open class CustomOptionsConfigurationConfiguration {
 

sentry-spring-jakarta/src/main/java/io/sentry/spring/jakarta/checkin/SentryQuartzConfiguration.java

@@ -5,13 +5,16 @@
 import org.springframework.boot.autoconfigure.quartz.SchedulerFactoryBeanCustomizer;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.core.Ordered;
+import org.springframework.core.annotation.Order;
 
 @Configuration(proxyBeanMethods = false)
 @Open
 @ApiStatus.Experimental
 public class SentryQuartzConfiguration {
 
   @Bean
+  @Order(Ordered.HIGHEST_PRECEDENCE)
   public SchedulerFactoryBeanCustomizer schedulerFactoryBeanCustomizer() {
     return new SentrySchedulerFactoryBeanCustomizer();
   }

sentry-spring/src/main/java/io/sentry/spring/checkin/SentryQuartzConfiguration.java

@@ -5,13 +5,16 @@
 import org.springframework.boot.autoconfigure.quartz.SchedulerFactoryBeanCustomizer;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.core.Ordered;
+import org.springframework.core.annotation.Order;
 
 @Configuration(proxyBeanMethods = false)
 @Open
 @ApiStatus.Experimental
 public class SentryQuartzConfiguration {
 
   @Bean
+  @Order(Ordered.HIGHEST_PRECEDENCE)
   public SchedulerFactoryBeanCustomizer schedulerFactoryBeanCustomizer() {
     return new SentrySchedulerFactoryBeanCustomizer();
   }