rewrite: UnsupportedOperationException for request scoped bean with parameter

As for the startup error. I’m worried that this might be some circular initialization loop where SpringBoot is trying to start the WebApplicationContext, then Rewrite tries to start up and request bean names to create the configuration, then SpringBoot says, “Hey, I’m not ready yet and don’t have a WebApplicationContext”, and returns null back to Rewrite.

Digging deeper.

The “problem” is that org.ocpsoft.rewrite.spring.SpringServiceEnricher does not have access to the current ServletContext, so it can’t access the ServletContext attribute org.springframework.web.context.WebApplicationContext.ROOT in which the WebApplicationContext could be found.

See also org.springframework.web.context.support.WebApplicationContextUtils#getRequiredWebApplicationContext

Instead it relies on org.springframework.web.context.ContextLoader#getCurrentWebApplicationContext which is null for Spring Boot Applications, because they aren’t loaded by the ContextLoaders. (The only exception might be WAR-based Spring-Boot Application, deployed to an existing servlet container)

I tested the changes successfully with 4.0.0-SNAPSHOT as JAR and WAR. Thank you @lincolnthree and @larsgrefer. I’m looking forward to the new release. 😃

Additionally. I have improved the expression language bean name resolution so that it tries providers until either it finds one that works, or they all fail.

BAM. It works. This is MUCH cleaner. Thanks @larsgrefer.

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::                (v2.7.6)

2023-03-21 16:20:14.422  INFO 63251 --- [           main] com.example.rewrite.RewriteApplication   : Starting RewriteApplication using Java 11.0.18 on mshark.local with PID 63251 (/Users/lincoln/projects/ocpsoft/rewrite-issue-362/target/classes started by lincoln in /Users/lincoln/projects/ocpsoft/rewrite-issue-362)
2023-03-21 16:20:14.424  INFO 63251 --- [           main] com.example.rewrite.RewriteApplication   : No active profile set, falling back to 1 default profile: "default"
2023-03-21 16:20:15.025  INFO 63251 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat initialized with port(s): 8080 (http)
2023-03-21 16:20:15.033  INFO 63251 --- [           main] o.apache.catalina.core.StandardService   : Starting service [Tomcat]
2023-03-21 16:20:15.033  INFO 63251 --- [           main] org.apache.catalina.core.StandardEngine  : Starting Servlet engine: [Apache Tomcat/9.0.69]
2023-03-21 16:20:15.193  INFO 63251 --- [           main] org.apache.jasper.servlet.TldScanner     : At least one JAR was scanned for TLDs yet contained no TLDs. Enable debug logging for this logger for a complete list of JARs that were scanned but no TLDs were found in them. Skipping unneeded JARs during scanning can improve startup time and JSP compilation time.
2023-03-21 16:20:15.204  INFO 63251 --- [           main] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext
2023-03-21 16:20:15.204  INFO 63251 --- [           main] w.s.c.ServletWebServerApplicationContext : Root WebApplicationContext: initialization completed in 736 ms
2023-03-21 16:20:15.220  WARN 63251 --- [           main] o.s.w.c.s.SpringBeanAutowiringSupport    : Current WebApplicationContext is not available for processing of SLF4JLogAdapterFactory: Make sure this class gets constructed in a Spring web application after the Spring WebApplicationContext has been initialized. Proceeding without injection.
2023-03-21 16:20:15.733  INFO 63251 --- [           main] vletContainerInitializerRegistrationBean : Resolving classes for com.sun.faces.config.FacesInitializer took 0.485617667s
2023-03-21 16:20:15.747  WARN 63251 --- [           main] o.s.w.c.s.SpringBeanAutowiringSupport    : Current WebApplicationContext is not available for processing of SpringServiceEnricher: Make sure this class gets constructed in a Spring web application after the Spring WebApplicationContext has been initialized. Proceeding without injection.
2023-03-21 16:20:15.775  INFO 63251 --- [           main] j.e.resource.webcontainer.jsf.config     : Initializing Mojarra 2.3.5 ( 20180516-1910 bf35b0f6c540c69e80e6da962a2b62756838ac41) for context ''
2023-03-21 16:20:15.843  INFO 63251 --- [           main] j.e.r.webcontainer.jsf.application       : JSF1048: PostConstruct/PreDestroy annotations present.  ManagedBeans methods marked with these annotations will have said annotations processed.
2023-03-21 16:20:15.906  INFO 63251 --- [           main] o.o.rewrite.faces.RewritePhaseListener   : RewritePhaseListener starting up.
2023-03-21 16:20:16.011  INFO 63251 --- [           main] o.ocpsoft.rewrite.servlet.RewriteFilter  : RewriteFilter starting up...
2023-03-21 16:20:16.023  INFO 63251 --- [           main] o.ocpsoft.rewrite.servlet.RewriteFilter  : Loaded [3] org.ocpsoft.rewrite.servlet.spi.RewriteLifecycleListener [org.ocpsoft.rewrite.faces.FacesRewriteLifecycleListener<0>, org.ocpsoft.rewrite.servlet.impl.DefaultRewriteLifecycleListener<2147483647>, org.ocpsoft.rewrite.servlet.config.lifecycle.JoinRewriteLifecycleListener<2147483647>]
2023-03-21 16:20:16.023  INFO 63251 --- [           main] o.ocpsoft.rewrite.servlet.RewriteFilter  : Loaded [1] org.ocpsoft.rewrite.servlet.spi.RequestCycleWrapper [org.ocpsoft.rewrite.servlet.impl.HttpRewriteRequestCycleWrapper<0>]
2023-03-21 16:20:16.023  INFO 63251 --- [           main] o.ocpsoft.rewrite.servlet.RewriteFilter  : Loaded [1] org.ocpsoft.rewrite.spi.RewriteProvider [org.ocpsoft.rewrite.servlet.impl.DefaultHttpRewriteProvider<0>]
2023-03-21 16:20:16.023  INFO 63251 --- [           main] o.ocpsoft.rewrite.servlet.RewriteFilter  : Loaded [1] org.ocpsoft.rewrite.servlet.spi.RewriteResultHandler [org.ocpsoft.rewrite.servlet.impl.HttpRewriteResultHandler<0>]
2023-03-21 16:20:16.023  INFO 63251 --- [           main] o.ocpsoft.rewrite.servlet.RewriteFilter  : Loaded [1] org.ocpsoft.rewrite.servlet.spi.InboundRewriteProducer [org.ocpsoft.rewrite.servlet.impl.HttpInboundRewriteProducer<0>]
2023-03-21 16:20:16.023  INFO 63251 --- [           main] o.ocpsoft.rewrite.servlet.RewriteFilter  : Loaded [1] org.ocpsoft.rewrite.servlet.spi.OutboundRewriteProducer [org.ocpsoft.rewrite.servlet.impl.HttpOutboundRewriteProducer<0>]
2023-03-21 16:20:16.024  INFO 63251 --- [           main] o.ocpsoft.rewrite.servlet.RewriteFilter  : Loaded [1] org.ocpsoft.rewrite.servlet.spi.ContextListener [org.ocpsoft.rewrite.spring.SpringServiceEnricher<0>]
2023-03-21 16:20:16.025  INFO 63251 --- [           main] o.ocpsoft.rewrite.servlet.RewriteFilter  : Loaded [0] org.ocpsoft.rewrite.servlet.spi.RequestListener []
2023-03-21 16:20:16.026  INFO 63251 --- [           main] o.ocpsoft.rewrite.servlet.RewriteFilter  : Loaded [0] org.ocpsoft.rewrite.servlet.spi.RequestParameterProvider []
2023-03-21 16:20:16.030  INFO 63251 --- [           main] o.ocpsoft.rewrite.servlet.RewriteFilter  : Loaded [2] org.ocpsoft.rewrite.el.spi.ExpressionLanguageProvider [org.ocpsoft.rewrite.spring.SpringExpressionLanguageProvider<20>, org.ocpsoft.rewrite.faces.FacesExpressionLanguageProvider<30>]
2023-03-21 16:20:16.032  INFO 63251 --- [           main] o.ocpsoft.rewrite.servlet.RewriteFilter  : Loaded [1] org.ocpsoft.rewrite.spi.InvocationResultHandler [org.ocpsoft.rewrite.faces.NavigatingInvocationResultHandler<100>]
2023-03-21 16:20:16.034  INFO 63251 --- [           main] o.ocpsoft.rewrite.servlet.RewriteFilter  : Loaded [2] org.ocpsoft.common.spi.ServiceEnricher [org.ocpsoft.rewrite.spring.SpringServiceEnricher<0>, org.joinfaces.autoconfigure.rewrite.SpringBootServiceEnricher]
2023-03-21 16:20:16.036  INFO 63251 --- [           main] o.ocpsoft.rewrite.servlet.RewriteFilter  : Loaded [1] org.ocpsoft.rewrite.spi.ConfigurationCacheProvider [org.ocpsoft.rewrite.servlet.impl.ServletContextConfigurationCacheProvider<0>]
2023-03-21 16:20:16.039  INFO 63251 --- [           main] o.ocpsoft.rewrite.servlet.RewriteFilter  : Loaded [2] org.ocpsoft.rewrite.config.ConfigurationProvider [org.joinfaces.autoconfigure.rewrite.SpringBootAnnotationConfigProvider<100>, org.ocpsoft.rewrite.annotation.config.AnnotationConfigProvider<100>]
2023-03-21 16:20:16.042  INFO 63251 --- [           main] o.o.r.s.impl.DefaultHttpRewriteProvider  : Loaded [0] org.ocpsoft.rewrite.spi.RuleCacheProvider []
2023-03-21 16:20:16.452  INFO 63251 --- [           main] o.o.rewrite.param.DefaultParameterStore  : Loaded [1] org.ocpsoft.rewrite.spi.GlobalParameterProvider [org.ocpsoft.rewrite.instance.WildcardParameterProvider<0>]
2023-03-21 16:20:16.480  INFO 63251 --- [           main] o.ocpsoft.rewrite.servlet.RewriteFilter  : Rewrite 4.0.0-SNAPSHOT initialized.
2023-03-21 16:20:16.714  INFO 63251 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8080 (http) with context path ''
2023-03-21 16:20:16.721  INFO 63251 --- [           main] com.example.rewrite.RewriteApplication   : Started RewriteApplication in 2.557 seconds (JVM running for 2.778)

processInjectionBasedOnServletContext also uses org.springframework.web.context.support.WebApplicationContextUtils#getRequiredWebApplicationContext internally.

The interesting SPI is ServiceEnricher once this works correctly, the other Spring SPI Implementations can get their ApplicationContext reference from the enriched by just implementing ApplicationContextAware

Proof it works 😃

Hey @larsgrefer! Thanks for the info and for pointing me toward getRequiredWebApplicationContextg The issue here is that the JoinFaces BeanNameResolver is still using ApplicationContext.getBeansOfType. So it’s going to fail when Rewrite attempts to configure Bean names and parameters (which is what’s happening to @TobiasBerndt) and the Context isn’t found.

I think the better solution here would be to make the Rewrite SpringBeanNameResolver aware of the ServletContext so that it can properly attempt to access the WebApplicationContext in Spring Boot applications using the method you recommended. Then you’d be able to remove your JoinFaces SPI implementation. Or you can make yours implement ContextListener and fix it that way too.

Here’s what I propose, regardless of where the fix goes:

/*
 * Copyright 2011 <a href="mailto:lincolnbaxter@gmail.com">Lincoln Baxter, III</a>
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.ocpsoft.rewrite.spring;

import java.util.HashSet;
import java.util.Set;

import org.ocpsoft.logging.Logger;
import org.ocpsoft.rewrite.el.spi.BeanNameResolver;
import org.springframework.beans.factory.ListableBeanFactory;
import org.springframework.core.PriorityOrdered;
import org.springframework.web.context.WebApplicationContext;

/**
 * {@link BeanNameResolver} implementation for Spring.
 * 
 * @author Christian Kaltepoth
 * @author <a href="mailto:lincolnbaxter@gmail.com">Lincoln Baxter, III</a>
 */
public class SpringBeanNameResolver implements BeanNameResolver
{
   private final Logger log = Logger.getLogger(SpringBeanNameResolver.class);

   @Override
   public String getBeanName(Class<?> clazz)
   {
      WebApplicationContext context = SpringWebApplicationContextProvider.getWebApplicationContext();
      if (context == null) {
         throw new IllegalStateException("Unable to get current WebApplicationContext");
      }

      // obtain a map of bean names
      Set<String> beanNames = resolveBeanNames(context, clazz);

      // no beans of that type, nothing we can do
      if (beanNames == null || beanNames.size() == 0) {
         return null;
      }

      // more than one result -> warn the user
      else if (beanNames.size() > 1) {
         log.warn("Spring knows more than one bean of type [{}]", clazz.getName());
         return null;
      }

      // exactly one result -> we got a name
      else {
         return beanNames.iterator().next();
      }

   }

   /**
    * Will ignore scoped proxy target bean names.
    * 
    * @see https://github.com/ocpsoft/rewrite/issues/170
    */
   private Set<String> resolveBeanNames(ListableBeanFactory beanFactory, Class<?> clazz)
   {

      final Set<String> result = new HashSet<String>();

      String[] names = beanFactory.getBeanNamesForType(clazz); <--- NOTE: This is the important change right here.
      if (names != null) {
         for (String name : names) {
            if (name != null && !name.startsWith("scopedTarget.")) {
               result.add(name);
            }
         }
      }

      return result;

   }

}

I am working on a new release/snapshot that should resolve this, regardless 😃 Let’s see if we can get it taken care of!

Ok, so from what I can tell, it appears that Spring Boot is misconfigured or incompatible somehow. The Spring WebApplicationContext is not available during Servlet Filter startup, and it needs to be. I am not an expert in Spring Boot and its startup lifecycle, so I’m not sure how much I will be able to help, here. Know anyone with Spring Boot expertise?

Generally, when configuring Spring Manually, you’d ensure this happens by ordering Spring’s WebContextListener to run before Rewrite’s.

2023-03-21 11:46:58.515  WARN 47756 --- [           main] o.s.w.c.s.SpringBeanAutowiringSupport    : 
Current WebApplicationContext is not available for processing of FacesRewriteLifecycleListener:
Make sure this class gets constructed in a Spring web application after the Spring
WebApplicationContext has been initialized. Proceeding without injection.

I’ve tried all the solutions proposed here: https://stackoverflow.com/questions/33486219/spring-boot-no-webapplicationcontext-found, but I suspect something is interfering with or overriding the boot order. I might suggest checking with the JoinFaces folks and see what they are doing in this regard, and if there is any way to override their defined start order (if they’ve set one, which I presume they have.)

Nevertheless I tried it with SpringBootServletInitializer but exceptions during startup are still thrown.

[Edit. You are correct – This doesn’t fix the issue. I think it just changed the order of classloading and a different issue came up first.] Please ignore.

I thought SpringBootServletInitializer is only needed if you want to run the application as WAR. My sample application is running as JAR with an embedded tomcat. Javadoc of SpringBootServletInitializer:

An opinionated WebApplicationInitializer to run a SpringApplication from a traditional WAR deployment. […] Note that a WebApplicationInitializer is only needed if you are building a war file and deploying it. If you prefer to run an embedded web server then you won’t need this at all.

Nevertheless I tried it with SpringBootServletInitializer but exceptions during startup are still thrown.

Okay, so I think I know why this is happening. First, the startup error is caused because you need to extend SpringBootServletInitializer in your RewriteConfiguration to tell Spring Boot that this Configuration uses the WebApplicationContext (which changes initialization order.)

This resolves the startup error:

@Configuration
public class RewriteConfiguration extends SpringBootServletInitializer
{
	@Bean
	@Scope(value = "request", proxyMode = ScopedProxyMode.TARGET_CLASS)
	public MyController myController()
	{
		return new MyController();
	}
}

Next, regarding the PrettyFaces error when loading the Parameter config, I am still working on that. But it’s being caused because the request-scoped bean is being looked up during application startup for some reason. It shouldn’t be. The EL container should be able to return metadata about the bean without instantiating the bean. I’m still researching.