How to override/replace SqsListenerAnnotationBeanPostProcessor?

[erizzo-cfa]

I have a requirement to intercept processing of @SqsListener annotations (to bypass the creation of endpoints under very specific circumstances). It appears as if providing an alternate annotation post-processor is supported (based on the way io.awspring.cloud.sqs.config.SqsBootstrapConfiguration is written) but I've been unable to provide my own implementation using @AutoConfigureBefore. No matter what I've tried, the default io.awspring.cloud.sqs.annotation.SqsListenerAnnotationBeanPostProcessor is always created and used.
Is there an example or guidance of how to replace that annotation processor bean with a custom one?

[erizzo-cfa]

Here's what I did to accomplish my goal. Hopefully is can be a useful example for others to follow.

1. Wrote a POJO class that extends SqsListenerAnnotationBeanPostProcessor, overriding the methods createEndpointRegistrar() and createEndpoint(SqsListener annotation) to avoid creating Endpoints based on my requirement.
2. Created a @Configuration class that registers my custom processor as a @Bean using the name io.awspring.cloud.sqs.config.SqsBeanNames.SQS_LISTENER_ANNOTATION_BEAN_POST_PROCESSOR_BEAN_NAME.
   I made sure to use @AutoConfigureBefore(SqsAutoConfiguration.clas}) to make my configuration class process before the built-in awspring auto-configure class.
3. Include the fully qualified name of my @Configuration class in the file META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports. This was key to registering it so Spring Boot knows about it.

Here's the outline of the code:

public class MySQSListenerAnnotationBeanPostProcessor extends SqsListenerAnnotationBeanPostProcessor {

	private final boolean disableCertainEndpoints;


	public MySQSListenerAnnotationBeanPostProcessor(Environment environment) {
		this.disableCertainEndpoints = /* check Environment for config property */ ;
	}

	@Override
	protected Endpoint createEndpoint(SqsListener annotation) {
		String[] queueNames = annotation.queueNames();
		boolean anyMatchingQueues = Arrays.stream(queueNames).anyMatch( /* predicate to match queues I'm interested in */);

		if (anyMatchingQueues && disableCertainEndpoints) {
			return null;
		}

		return super.createEndpoint(annotation);
	}

	@Override
	protected EndpointRegistrar createEndpointRegistrar() {
		// This override is necessary to ignore when createEndpoint() returns null. Maybe this should be a PR in awspring's default implementation?
		return new EndpointRegistrar() {
			@Override
			public void registerEndpoint(Endpoint endpoint) {
				if (endpoint != null) {
					super.registerEndpoint(endpoint);
				}
			}
		};
	}
}

@Configuration
@AutoConfigureBefore(SqsAutoConfiguration.class)
public class AnnotationProcessorsConfiguration {

    @Bean(SqsBeanNames.SQS_LISTENER_ANNOTATION_BEAN_POST_PROCESSOR_BEAN_NAME)
    SqsListenerAnnotationBeanPostProcessor sqsListenerProcessor(Environment environment) {
    	return new MySQSListenerAnnotationBeanPostProcessor(environment);
    }
}

File META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports:

com.my.package.AnnotationProcessorsConfiguration

[tomazfernandes]

Hey @erizzo-cfa, sorry for the delay, happy you found the solution, that's indeed the correct way to handle it.

This sounds like an interesting use case - we could have an EndpointFilter interface or similar in the framework to streamline this logic.

Would you like to open an issue and contribute a PR for that?

[erizzo-cfa]

I'll give it a shot.

[erizzo-cfa]

Since this would be new public interface, I assume the version would be 3.5.0. Do you have a branch already for 3.5.0 (I see that main is 3.4.1)?

[maciejwalkowiak]

That's my bad. I'll change version in main to 3.5.0 so feel free to make a PR against main branch.

[erizzo]

Created a draft PR: #1416 - does it look to be on the right track?