@SentryTransaction breaks @Autowired when using SpringBeanJobFactory

[buckett]

Integration

sentry-spring-boot-starter

Java Version

17

Version

6.3.0

Steps to Reproduce

• Create a spring boot project using sentry-spring-boot-starter and spring-boot-starter-quartz.
• Create a simple spring service that has a method that can be called from a quartz job, eg:

    @Component
    public class HelloWorld {
        public String say() {
             return "Hello World"
        }
     }

• Create a Quartz job that has this service autowired into it and calls the say() method. eg:

    public class HelloWorldJob implements Job {
         @Autowired
         private HelloWorld helloWorld;

         @SentryTransaction(operation = "job")
         public final void execute(JobExecutionContext context) throws JobExecutionException {
             helloWorld.say();
         }
     }

• Create a job and schedule this to run regularly. The SpringBeanJobFactory used by Spring Boot means that the @Autowired annotation is processed. As long as sentry tracing isn't setup this work correctly.
• By setting the Spring property sentry.dsn=... the Sentry configuration is enabled and now the HelloWorldJob no longer has its dependencies autowired resulting in a NPE.

When debugging this it was the org.springframework.aop.aspectj.annotation.AnnotationAwareAspectJAutoProxyCreator code that was creating a new instance of the Job (after the dependencies had been autowired into the original Job). The call stack when this was happening was:

applyBeanPostProcessorsAfterInitialization:456, AbstractAutowireCapableBeanFactory (org.springframework.beans.factory.support)
initializeBean:1808, AbstractAutowireCapableBeanFactory (org.springframework.beans.factory.support)
doCreateBean:620, AbstractAutowireCapableBeanFactory (org.springframework.beans.factory.support)
createBean:542, AbstractAutowireCapableBeanFactory (org.springframework.beans.factory.support)
createBean:378, AbstractAutowireCapableBeanFactory (org.springframework.beans.factory.support)
createJobInstance:90, SpringBeanJobFactory (org.springframework.scheduling.quartz)
newJob:43, AdaptableJobFactory (org.springframework.scheduling.quartz)
initialize:127, JobRunShell (org.quartz.core)
run:392, QuartzSchedulerThread (org.quartz.core)

Expected Result

The job is correctly initialised with it's dependencies, but also sends a transaction to sentry.

Actual Result

A NPE when accessing the autowired dependency.

[philipphofmann]

Sorry for the late reply, @buckett. We had hackweek last week and are now catching up with issues. I think @adinauer should get to this issue soon.

[adinauer]

Hello @buckett I'm able to reproduce the issue. I was able to get injection to work by providing a few beans:

import org.quartz.spi.TriggerFiredBundle;
import org.springframework.beans.factory.config.AutowireCapableBeanFactory;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.scheduling.quartz.SpringBeanJobFactory;

public final class AutowiringSpringBeanJobFactory
  extends SpringBeanJobFactory
  implements ApplicationContextAware {

  private transient AutowireCapableBeanFactory beanFactory;

  public void setApplicationContext(
    final ApplicationContext context) {
    beanFactory = context.getAutowireCapableBeanFactory();
  }

  @Override
  protected Object createJobInstance(
    final TriggerFiredBundle bundle)
    throws Exception {final Object job = super.createJobInstance(bundle);
    beanFactory.autowireBean(job);
    return job;
  }
}

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.quartz.SchedulerFactoryBeanCustomizer;
import org.springframework.scheduling.quartz.SchedulerFactoryBean;
import org.springframework.scheduling.quartz.SpringBeanJobFactory;
import org.springframework.stereotype.Component;

@Component
public class MySchedulerFactoryBeanCustomizer implements SchedulerFactoryBeanCustomizer {

  @Autowired
  SpringBeanJobFactory jobFactory;

  @Override
  public void customize(SchedulerFactoryBean schedulerFactoryBean) {
    schedulerFactoryBean.setJobFactory(jobFactory);
  }
}

  @Bean
  public JobDetail jobDetail() {
    return JobBuilder.newJob().ofType(HelloWorldJob.class)
      .storeDurably()
      .withIdentity("Qrtz_Job_Detail")
      .withDescription("Invoke Sample Job service...")
      .build();
  }

  @Bean
  public Trigger trigger(JobDetail job) {
    return TriggerBuilder.newTrigger().forJob(job)
      .withIdentity("Qrtz_Trigger")
      .withDescription("Sample trigger")
      .withSchedule(simpleSchedule().repeatForever().withIntervalInSeconds(30))
      .build();
  }

  @Bean
  public SpringBeanJobFactory springBeanJobFactory() {
    AutowiringSpringBeanJobFactory jobFactory = new AutowiringSpringBeanJobFactory();
    jobFactory.setApplicationContext(applicationContext);
    return jobFactory;
  }

I only gave this a quick look and haven't investigated why it breaks once tracing is turned on. But maybe this helps already?

[adinauer]

Closing due to inactivity, please feel free to reopen if you have anything to share.