Url session propagation (#13)

* Fix session id retrieval from URL
* Fix integration test
* Simplify http reply matcher
* Remove perm size
* Fix BUILD.md document
* Add URL session propagation tests
* Update dependency versions
* Clarify session propagation usage.

Author: nbogojevic

README.md

@@ -228,13 +228,30 @@ The first one is based on cookies and is the default one.
 The second one is based on URL rewriting where the session is appended at the
 end of the path part of URL (preceding the query).
 
+The session propagation can be configured using web.xml (standard Servlet approach)
+
+```xml
+<web-app> 
+...
+  <session-config>
+    <tracking-mode>URL</tracking-mode>
+  </session-config>
+</web-app> 
+```
+It can also be configured using system property or servlet initialization parameter
+`com.amadeus.session.tracking`. Valid values are `COOKIE`, `URL` or `DEFAULT` 
+(which is same as `COOKIE`).
+
+The URL rewriting session propagation is not supported on Tomcat 6 based servlet 
+engines (Tomcat 6.x, JBoss 6.x).
+
 #### Cookie Session Management
 
 The session is stored as a UUID inside a cookie.
 The cookie name is one of the following by descending order of priority:
 
-* Using the `com.amadeus.session.cookieName` initialization parameter of the ServletContext.
-* Using the `com.amadeus.session.cookieName` system property.
+* Using the `com.amadeus.session.sessionName` initialization parameter of the ServletContext.
+* Using the `com.amadeus.session.sessionName` system property.
 * `JSESSIONID`.
 
 In case of HTTPS requests, cookies can be marked as secure.

docs/BUILD.md

@@ -28,7 +28,7 @@ JVM with agent activated.
 Container testing is using arquillian framework. Same battery of tests can be run against
 several servlet containers. All tests are part of `session-replacement` project. In this
 project, coverage report can be activated using `coverage-per-test` profile.
-Following paragraphs describe testing in specific containers.
+Following paragraphs describe integration testing with specific containers.
 
 #### Jetty 9
 
@@ -45,7 +45,7 @@ The tests run on an embedded container.
 The testing is invoked using
 
 ```sh
-mvn verify -Ptomcat-7-arquillian,arquillian-tests
+mvn verify -Ptomcat-7-embedded-arquillian,arquillian-tests
 ```
 
 #### Wildfly 10
@@ -57,6 +57,10 @@ The testing is invoked using
 mvn verify -Pwildfly-10-managed-arquillian,arquillian-tests
 ```
 
+```sh
+mvn verify -Pwildfly-10-managed-arquillian-with-agent,external-arquillian-tests
+```
+
 ### Redis Tests
 
 Redis tests require docker installation. This can be either native docker on Linux machines

docs/Usage.md

@@ -85,6 +85,10 @@ $JBOSS_HOME/bin/standalone.sh -mp $JBOSS_HOME/modules:$SESSION_PATH/modules
 # on Windows: $JBOSS_HOME\bin\standalone.ps1 -mp $JBOSS_HOME\modules;$SESSION_PATH\modules
 ```
 
+### URL session propagation
+
+URL session propagation is _not_ supported in JBoss 6.x. It works in versions 7.x and in all Wildfly verions.
+
 ### Session replacement configuration in Wildfly/JBoss configuration file
 
 TODO explain configuration using system properties in standalone.xml
@@ -162,8 +166,9 @@ manifested with class cast exceptions. It is recommended to give preference to t
 Tomcat 6.x supports Servlet 2.5 specification. This environment has few limitations and prerequisites:
 
 * your web application must have at least one `Filter`, otherwise there will be no session replacement.
-* if you can modify your web application, add com.amadeus.session.servlet.SessionFilter as first filter of your web application.
+* if you can modify your web application, add `com.amadeus.session.servlet.SessionFilter` as first filter of your web application.
 * to support sending events to `HttpSessionListener` and `HttpSessionAttributeListener`, start the agent with `session=2.x` argument or set system property `com.amadeus.session.servlet.api=2.x`
+* URL session propagation is _not_ supported in Tomcat 6.x.
 
 ### Usage with Spring library
 

integration-tests/arquillian-tests/src/test/container/wildfly10/standalone/configuration/standalone.xml

@@ -90,6 +90,20 @@
                     <named-formatter name="COLOR-PATTERN"/>
                 </formatter>
             </console-handler>
+            <async-handler name="ASYNC">                                                                                                                                                                                                             
+                <queue-length value="512"/>                                                                                                                                                                                                          
+                <overflow-action value="block"/>                                                                                                                                                                                                     
+                <subhandlers>                                                                                                                                                                                                                        
+                    <handler name="CONSOLE"/>                                                                                                                                                                                                        
+                </subhandlers>                                                                                                                                                                                                                       
+            </async-handler>                                                                                                                                                                                                                         
+            <async-handler name="ASYNC-FILE">                                                                                                                                                                                                             
+                <queue-length value="512"/>                                                                                                                                                                                                          
+                <overflow-action value="block"/>                                                                                                                                                                                                     
+                <subhandlers>                                                                                                                                                                                                                        
+                    <handler name="FILE"/>                                                                                                                                                                                                        
+                </subhandlers>                                                                                                                                                                                                                       
+            </async-handler>                                                                                                                                                                                                                         
             <periodic-rotating-file-handler name="FILE" autoflush="true">
                 <formatter>
                     <named-formatter name="PATTERN"/>
@@ -108,10 +122,10 @@
                 <level name="WARN"/>
             </logger>
             <root-logger>
-                <level name="WARN"/>
+                <level name="INFO"/>
                 <handlers>
-                    <handler name="CONSOLE"/>
-                    <handler name="FILE"/>
+                    <handler name="ASYNC"/>
+                    <handler name="ASYNC-FILE"/>
                 </handlers>
             </root-logger>
             <formatter name="PATTERN">

integration-tests/arquillian-tests/src/test/resources/arquillian.xml

@@ -7,26 +7,27 @@
 		<configuration>
 			<property name="user">arquillian</property>
 			<property name="pass">arquillian</property>
-			<property name="javaVmArguments">-Xmx512m -XX:MaxPermSize=128m -Djava.rmi.server.hostname=localhost -Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.local.only=false</property>
+			<property name="javaVmArguments">-Xmx512m -Djava.rmi.server.hostname=localhost -Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.local.only=false</property>
 		</configuration>
 	</container>
 	<container qualifier="tomcat-6-managed-arquillian-with-agent">
 		<configuration>
 			<property name="user">arquillian</property>
 			<property name="pass">arquillian</property>
-			<property name="javaVmArguments">-Xmx512m -XX:MaxPermSize=128m -javaagent:${agent.location}=interceptListeners=true -Djava.rmi.server.hostname=localhost -Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.local.only=false</property>
+			<property name="javaVmArguments">-Xmx512m -javaagent:${agent.location}=interceptListeners=true -Djava.rmi.server.hostname=localhost -Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.local.only=false</property>
 		</configuration>
 	</container>
 	<container qualifier="tomcat-7-managed-arquillian-with-agent">
 		<configuration>
 			<property name="user">arquillian</property>
 			<property name="pass">arquillian</property>
-			<property name="javaVmArguments">-Xmx512m -XX:MaxPermSize=128m -javaagent:${agent.location}=interceptListeners=true -Djava.rmi.server.hostname=localhost -Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.local.only=false</property>
+			<property name="javaVmArguments">-Xmx512m -javaagent:${agent.location}=interceptListeners=true -Djava.rmi.server.hostname=localhost -Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.local.only=false</property>
 		</configuration>
 	</container>
 	<container qualifier="wildfly-10-managed-arquillian-with-agent">
 		<configuration>
-			<property name="javaVmArguments">-Xmx512m -XX:MaxPermSize=128m -javaagent:${agent.location}=interceptListeners=true</property>
+			<!-- For debugging prepend with -Xrunjdwp:transport=dt_socket,address=8787,server=y,suspend=y -->
+			<property name="javaVmArguments">-Xmx512m -javaagent:${agent.location}=interceptListeners=true</property>
 		</configuration>
 	</container>
 </arquillian>

session-replacement/pom.xml

@@ -10,14 +10,14 @@
   <name>session-replacement</name>
   <description>Implementation of session management for JEE HttpSessions and general use case. Includes implemenations of in-memory and redis session distribution.</description>
   <properties>
-    <redis.version>3.2.5</redis.version>
+    <redis.version>3.2.8</redis.version>
     <redis.image>redis:${redis.version}-alpine</redis.image>
     <jedis.version>2.9.0</jedis.version>
-    <slf4j.version>1.7.21</slf4j.version>
-    <version.arquillian>1.1.11.Final</version.arquillian>
-    <version.arquillian_jacoco>1.0.0.Alpha8</version.arquillian_jacoco>
-    <version.jetty9>9.3.14.v20161028</version.jetty9>
-    <version.tomcat7>7.0.73</version.tomcat7>
+    <slf4j.version>1.7.25</slf4j.version>
+    <version.arquillian>1.1.13.Final</version.arquillian>
+    <version.arquillian_jacoco>1.0.0.Alpha9</version.arquillian_jacoco>
+    <version.jetty9>9.3.18.v20170406</version.jetty9>
+    <version.tomcat7>7.0.77</version.tomcat7>
     <version.wildfly>10.0.0.Final</version.wildfly>
     <sonar.exclusions>**/org/slf4j/impl/*.java</sonar.exclusions>
   </properties>
@@ -597,6 +597,11 @@
               <environmentVariables>
                 <JBOSS_HOME>${project.build.directory}/wildfly-${version.wildfly}</JBOSS_HOME>
               </environmentVariables>
+              <!--
+              <systemPropertyVariables>
+                <arquillian.launch>wildfly-10-managed-arquillian</arquillian.launch>
+              </systemPropertyVariables>
+              -->
             </configuration>
           </plugin>
         </plugins>

session-replacement/src/main/java/com/amadeus/session/SessionConfiguration.java

@@ -243,7 +243,7 @@ public interface AttributeProvider {
    *
    * @see #DEFAULT_SESSION_ID_NAME
    */
-  public static final String SESSION_ID_NAME = "com.amadeus.session.cookieName";
+  public static final String SESSION_ID_NAME = "com.amadeus.session.sessionName";
 
   /**
    * Default name for the cookie or URL element.

session-replacement/src/main/java/com/amadeus/session/servlet/UrlSessionTracking.java

@@ -35,11 +35,11 @@ public void configure(SessionConfiguration configuration) {
 
   @Override
   public String retrieveId(RequestWithSession request) {
-    String pathInfo = ((HttpServletRequest)request).getPathInfo();
-    int sessionIdStart = pathInfo.lastIndexOf(sessionIdPathItem);
+    String requestUri = ((HttpServletRequest)request).getRequestURI();
+    int sessionIdStart = requestUri.lastIndexOf(sessionIdPathItem);
     if (sessionIdStart > -1) {
       sessionIdStart += sessionIdPathItem.length();
-      String sessionId = pathInfo.substring(sessionIdStart);
+      String sessionId = requestUri.substring(sessionIdStart);
       return clean(sessionId);
     }
     return null;

session-replacement/src/test/java/com/amadeus/session/servlet/TestCookieSessionTracking.java

@@ -60,7 +60,7 @@ public void testRetrieveId() {
     HttpServletRequest hsr = (HttpServletRequest)request;
     UUID uuid = UUID.randomUUID();
     UUID uuidUrl = UUID.randomUUID();
-    when(hsr.getPathInfo()).thenReturn(";somesession=" + uuidUrl);
+    when(hsr.getRequestURI()).thenReturn("/url;somesession=" + uuidUrl);
     when(hsr.getCookies()).thenReturn(new Cookie[] { new Cookie("somesession", uuid.toString()) });
     assertEquals(uuid.toString(), cookieSessionTracking.retrieveId(request));
     when(hsr.getCookies()).thenReturn(new Cookie[] { new Cookie("notused", uuid.toString()) });

session-replacement/src/test/java/com/amadeus/session/servlet/TestUrlSessionTracking.java

@@ -59,7 +59,7 @@ public void testRetrieveId() {
     RequestWithSession request = mock(RequestWithSession.class, withSettings().extraInterfaces(HttpServletRequest.class));
     HttpServletRequest hsr = (HttpServletRequest)request;
     UUID uuid = UUID.randomUUID();
-    when(hsr.getPathInfo()).thenReturn(";somesession="+uuid);
+    when(hsr.getRequestURI()).thenReturn("/url;somesession="+uuid);
     String id = urlSessionTracking.retrieveId(request);
     assertEquals(uuid.toString(), id);
   }
@@ -71,7 +71,7 @@ public void testBadId() {
     urlSessionTracking.configure(sc);
     RequestWithSession request = mock(RequestWithSession.class, withSettings().extraInterfaces(HttpServletRequest.class));
     HttpServletRequest hsr = (HttpServletRequest)request;
-    when(hsr.getPathInfo()).thenReturn(";somesession=");
+    when(hsr.getRequestURI()).thenReturn("/url;somesession=");
     String id = urlSessionTracking.retrieveId(request);
     assertNull(id);
   }