Custom Spring MVC -portlets broken after upgrading to Liferay 6.1 GA2 (web.xml listener order)

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 6.1.1 CE GA2, 6.1.20 EE GA2
• Fix Version/s: 6.1.X EE, 6.2.0 CE M2
• Component/s: Tools, Tools > Plugins SDK > Portlets
• Labels:
  • QA-R
• Environment: Any, tested with Liferay JBoss & Tomcat bundles
• Branch Version/s:
  6.1.x
• Backported to Branch:
  Committed
• Epic/Theme:
  • Escalation
• Fix Priority: 5
• Similar Issues: Show 5 results ; ;

  LPS-31351	After upgrading from LR 6.1 GA1 to GA2 create_account and create_anonymous_account struts actions doesn't work
  LPS-29166	After deployed a portlet with two or plus servlet in web.xml the generated web.xml from Liferay deploy system is wrong
  LPS-7307	Upgrade to Spring 3
  LPS-35280	Upgrade Process 6.0 EE SP2 (6.0.12) to 6.1 EE GA2 (6.1.20) fails during Verify Document Library Process.
  LPS-30374	NullPointerException when Accessing Legacy URLs to Document Library Assets in 6.1 GA2

We have the structure where applicationContext.xml contains shared beans (service layer, dao layer and such) and is loaded by org.springframework.web.context.ContextLoaderListener . Additionally all portlets have their own context loading MVC related beans (controllers, view resolvers, etc).

Generated listeners in web.xml on version 6.1 GA1:

<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
<listener>
<listener-class>com.liferay.portal.kernel.servlet.SerializableSessionAttributeListener</listener-class>
</listener>
<listener>
<listener-class>com.liferay.portal.kernel.servlet.PortletContextListener</listener-class>
</listener>

After upgrading to Liferay 6.1 GA2 deployment sorts listeners in web.xml alphabetically:

<listener>
<listener-class>com.liferay.portal.kernel.servlet.PluginContextListener</listener-class>
</listener>
<listener>
<listener-class>com.liferay.portal.kernel.servlet.SerializableSessionAttributeListener</listener-class>
</listener>
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>

This causes portlet context to be loaded first and dependent beans from application context are missing.

[Vedran Pugar]

Problem is with implementation in the com/liferay/portal/tools/deploy/BaseDeployer.java. In web.xml it is adding plugin context listener before any custom listener. Here is custom listener org.springframework.web.context.ContextLoaderListener so in current implementation it is loaded last. And it should be first to provide loading main application context beans.

I made change to put plugin context listener after customer listeners, and also to strip out comments from web.xml because they can potential problems in searching inside web.xml.
You can check fix on https://github.com/vpugar/liferay-portal/blob/6.1.x_LPS-29103/portal-impl/src/com/liferay/portal/tools/deploy/BaseDeployer.java

[Joshua Green]

We've also encountered this problem. We had to manually switch the order of the listeners in the web.xml file (moving{{ContextLoaderListener}} before PluginContextListener). This fixed the problem but I guess it will reoccur every time we redeploy.

[František Hartman]

I can confirm the same issue with all our Spring MVC portlets (i.e. all of them ). This issue is imo so critical that it deserves official patch, otherwise it's no-go for 6.1.1.

[Michael Saechang]

Committed on:
Portal 6.2.x GIT ID: bce745ca61c8b8311312fe60df3d575bcea419c2.

[NWO Isaac]

We have encountered the same problem. Could you tell us how to patch this issue?

[Tammy Fong]

PASSED Manual Testing following the steps in the description.

Reproduced on:
Tomcat 7.0 + MySQL 5. Portal 6.1.20 EE.
Plugins 6.1.x EE GIT ID: c0a6ae0e7c09124bd1e26366e175efd179af078b.

At deployment, the following console error displays:

05:30:24,087 ERROR [pool-2-thread-2][PortletBagFactory:313] 
org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'org.springframework.samples.petportal.portlet.PetDescriptionUploadController#0' defined in PortletContext resource [/WEB-INF/context/upload-portlet.xml]: Cannot resolve reference to bean 'petService' while setting bean property 'petService'; nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException: No bean named 'petService' is defined

Fixed on:
Tomcat 7.0 + MySQL 5. Portal 6.1.x EE GIT ID: 001d217d34562a9065e44148e25f6146e701b21a.
Plugins 6.1.x EE GIT ID: 9b82967c3f1d2fab768e36d7d0b722ff64c08b47.
Tomcat 7.0 + MySQL 5. Portal 6.2.x GIT ID: a7e8d79e0d8a8cfaa2172ad0bf443931c9b64da3.
Plugins 6.2.x GIT ID: c09d56d98c6ebe9e8c8f35b53ccdf456bec814ec.

At deployment, XML bean definitions can be loaded with no console error.

[NWO Isaac]

Is this also going to be fixed for Portal 6.1.1 CE GA2?

[Tammy Fong]

Hi NWO,

Portal 6.1.1.1 CE GA2 was released before the commit so it will not have the fix. However, the fix is on the current trunk head, so this issue should be fixed in the next version of Liferay Portal. Thanks,

[Andrius Kurtinaitis]

It still fails if spring beans try to access PortalProps while initializing.

[Koen De Jaeger]

This BaseDeployer.java can't be overriden with a hook, right?

[Thorsten Glaser]

Hi everyone,

the patch by Vedran Pugar is on his github (6.1.x_LPS-29103 against 6.1.X stable branch). I wonder why it was not applied to the Liferay 6.1.X stable branch at ↓ ?

https://github.com/liferay/liferay-portal/tree/6.1.x

I’d be glad if you could apply it there.

Thanks in advance!