Bump Hypersistence Optimizer to 2.1.0 and add configuration examples for the Session timeout mechanism

Author: vladmihalcea

README.md

@@ -9,35 +9,35 @@ Once you downloaded the [Full or Trial version](https://vladmihalcea.com/hypersi
 The first thing you need to do is to unzip the package you have just downloaded.
 
 ```bash
-> unzip hypersistence-optimizer-2.0.2-pack.zip
+> unzip hypersistence-optimizer-2.1.0-pack.zip
 ```
 
 After unzipping the project package, you will get the following file structure:
 
 ```bash
-creating: hypersistence-optimizer-2.0.2/
-   creating: hypersistence-optimizer-2.0.2/lib/
-  inflating: hypersistence-optimizer-2.0.2/lib/hypersistence-optimizer-2.0.2-javadoc.jar
-  inflating: hypersistence-optimizer-2.0.2/lib/hypersistence-optimizer-2.0.2-sources.jar
-  inflating: hypersistence-optimizer-2.0.2/lib/hypersistence-optimizer-2.0.2.jar
-   creating: hypersistence-optimizer-2.0.2/configs/
-   creating: hypersistence-optimizer-2.0.2/configs/META-INF/
-   creating: hypersistence-optimizer-2.0.2/configs/META-INF/services/
-  inflating: hypersistence-optimizer-2.0.2/configs/META-INF/services/org.hibernate.boot.spi.SessionFactoryBuilderFactory
-   creating: hypersistence-optimizer-2.0.2/docs/
-   creating: hypersistence-optimizer-2.0.2/docs/html/
-   creating: hypersistence-optimizer-2.0.2/docs/pdf/
-  inflating: hypersistence-optimizer-2.0.2/docs/html/asciidoctor.css
-  inflating: hypersistence-optimizer-2.0.2/docs/html/coderay-asciidoctor.css
-  inflating: hypersistence-optimizer-2.0.2/docs/pdf/InstallationGuide.pdf
-  inflating: hypersistence-optimizer-2.0.2/docs/html/InstallationGuide.html
-  inflating: hypersistence-optimizer-2.0.2/docs/html/UserGuide.html
-  inflating: hypersistence-optimizer-2.0.2/docs/pdf/UserGuide.pdf
-  inflating: hypersistence-optimizer-2.0.2/changelog.txt
-  inflating: hypersistence-optimizer-2.0.2/LICENSE.txt
-  inflating: hypersistence-optimizer-2.0.2/maven-install.bat
-  inflating: hypersistence-optimizer-2.0.2/maven-install.sh
-  inflating: hypersistence-optimizer-2.0.2/README.txt
+creating: hypersistence-optimizer-2.1.0/
+   creating: hypersistence-optimizer-2.1.0/lib/
+  inflating: hypersistence-optimizer-2.1.0/lib/hypersistence-optimizer-2.1.0-javadoc.jar
+  inflating: hypersistence-optimizer-2.1.0/lib/hypersistence-optimizer-2.1.0-sources.jar
+  inflating: hypersistence-optimizer-2.1.0/lib/hypersistence-optimizer-2.1.0.jar
+   creating: hypersistence-optimizer-2.1.0/configs/
+   creating: hypersistence-optimizer-2.1.0/configs/META-INF/
+   creating: hypersistence-optimizer-2.1.0/configs/META-INF/services/
+  inflating: hypersistence-optimizer-2.1.0/configs/META-INF/services/org.hibernate.boot.spi.SessionFactoryBuilderFactory
+   creating: hypersistence-optimizer-2.1.0/docs/
+   creating: hypersistence-optimizer-2.1.0/docs/html/
+   creating: hypersistence-optimizer-2.1.0/docs/pdf/
+  inflating: hypersistence-optimizer-2.1.0/docs/html/asciidoctor.css
+  inflating: hypersistence-optimizer-2.1.0/docs/html/coderay-asciidoctor.css
+  inflating: hypersistence-optimizer-2.1.0/docs/pdf/InstallationGuide.pdf
+  inflating: hypersistence-optimizer-2.1.0/docs/html/InstallationGuide.html
+  inflating: hypersistence-optimizer-2.1.0/docs/html/UserGuide.html
+  inflating: hypersistence-optimizer-2.1.0/docs/pdf/UserGuide.pdf
+  inflating: hypersistence-optimizer-2.1.0/changelog.txt
+  inflating: hypersistence-optimizer-2.1.0/LICENSE.txt
+  inflating: hypersistence-optimizer-2.1.0/maven-install.bat
+  inflating: hypersistence-optimizer-2.1.0/maven-install.sh
+  inflating: hypersistence-optimizer-2.1.0/README.txt
 ```
 
 The package contains the following resources:
@@ -55,8 +55,8 @@ The package contains the following resources:
 In order to install Hypersistence Optimizer, you need to read the Installation Guide, which is available both in
 HTML and PDF formats in the unzipped package:
 
-* `hypersistence-optimizer-2.0.2/docs/pdf/InstallationGuide.pdf`
-* `hypersistence-optimizer-2.0.2/docs/html/InstallationGuide.html`
+* `hypersistence-optimizer-2.1.0/docs/pdf/InstallationGuide.pdf`
+* `hypersistence-optimizer-2.1.0/docs/html/InstallationGuide.html`
 
 > You can also read the [Installation Guide online](https://vladmihalcea.com/hypersistence-optimizer/docs/installation-guide/) if you want.
 
@@ -67,8 +67,8 @@ Hypersistence Optimizer so that you can get the most out of it.
 
 You can find the User Guide in the docs folder as well:
 
-* `hypersistence-optimizer-2.0.2/docs/html/UserGuide.html`
-* `hypersistence-optimizer-2.0.2/docs/pdf/UserGuide.pdf`
+* `hypersistence-optimizer-2.1.0/docs/html/UserGuide.html`
+* `hypersistence-optimizer-2.1.0/docs/pdf/UserGuide.pdf`
 
 > You can also read the [User Guide online](https://vladmihalcea.com/hypersistence-optimizer/docs/user-guide/) if you want.
 

hypersistence-optimizer-config-example/src/test/java/io/hypersistence/optimizer/config/RuntimeConfigurationPropertiesTest.java

@@ -0,0 +1,71 @@
+package io.hypersistence.optimizer.config;
+
+import io.hypersistence.optimizer.HypersistenceOptimizer;
+import io.hypersistence.optimizer.core.config.Config;
+import io.hypersistence.optimizer.core.config.JpaConfig;
+import io.hypersistence.optimizer.core.event.Event;
+import io.hypersistence.optimizer.core.event.ListEventHandler;
+import io.hypersistence.optimizer.hibernate.event.mapping.association.fetching.EagerFetchingEvent;
+import io.hypersistence.optimizer.hibernate.event.session.SessionTimeoutEvent;
+import io.hypersistence.optimizer.util.AbstractTest;
+import io.hypersistence.optimizer.util.transaction.JPATransactionVoidFunction;
+import org.junit.Test;
+
+import javax.persistence.*;
+
+import java.util.Collections;
+
+import static org.junit.Assert.assertSame;
+
+/**
+ * @author Vlad Mihalcea
+ */
+public class RuntimeConfigurationPropertiesTest extends AbstractTest {
+
+    @Override
+    public Class<?>[] entities() {
+        return new Class<?>[]{
+        };
+    }
+
+    private ListEventHandler listEventHandler = new ListEventHandler();
+
+    @Override
+    protected void afterInit() {
+        new HypersistenceOptimizer(
+            new JpaConfig(entityManagerFactory())
+                .addEventHandler(listEventHandler)
+                .setProperties(
+                    Collections.singletonMap(
+                        Config.Property.Session.TIMEOUT_MILLIS,
+                        25
+                    )
+                )
+        );
+    }
+
+    @Test
+    public void test() {
+        doInJPA(entityManager -> {
+            try {
+                Thread.sleep(50);
+            } catch (InterruptedException e) {
+                Thread.interrupted();
+            }
+        });
+
+        assertEventTriggered(1, SessionTimeoutEvent.class);
+    }
+
+    protected void assertEventTriggered(int expectedCount, Class<? extends Event> eventClass) {
+        int count = 0;
+
+        for (Event event : listEventHandler.getEvents()) {
+            if (event.getClass().equals(eventClass)) {
+                count++;
+            }
+        }
+
+        assertSame(expectedCount, count);
+    }
+}

hypersistence-optimizer-glassfish-hibernate-example/src/test/java/io/hypersistence/optimizer/forum/adaptor/glassfish/AbstractGlassfishDataSourceJndiIntegrationTest.java

@@ -12,6 +12,7 @@
 import io.hypersistence.optimizer.hibernate.event.mapping.association.OneToOneWithoutMapsIdEvent;
 import io.hypersistence.optimizer.hibernate.event.mapping.association.fetching.EagerFetchingEvent;
 import io.hypersistence.optimizer.hibernate.event.query.PaginationWithoutOrderByEvent;
+import io.hypersistence.optimizer.hibernate.event.session.SessionTimeoutEvent;
 import org.jboss.arquillian.junit.Arquillian;
 import org.junit.Before;
 import org.junit.Test;
@@ -60,6 +61,8 @@ public void test() throws Exception {
             getEntityManager().persist(post);
         });
 
+        hypersistenceOptimizer.getEvents().clear();
+
         doInTransaction(() -> {
             assertEventTriggered(0, PaginationWithoutOrderByEvent.class);
 
@@ -72,7 +75,15 @@ public void test() throws Exception {
             assertEquals(1, posts.size());
 
             assertEventTriggered(1, PaginationWithoutOrderByEvent.class);
+
+            try {
+                Thread.sleep(25);
+            } catch (InterruptedException e) {
+                Thread.interrupted();
+            }
         });
+
+        assertEventTriggered(1, SessionTimeoutEvent.class);
     }
 
     private void doInTransaction(VoidCallable callable) {

hypersistence-optimizer-glassfish-hibernate-example/src/test/resources-glassfish-embedded/MANIFEST/test-persistence.xml

@@ -26,11 +26,10 @@
 
         <properties>
             <property name="hibernate.hbm2ddl.auto" value="update"/>
-            <property
-                name="hibernate.transaction.jta.platform"
-                value="SunOne"
-            />
+            <property name="hibernate.transaction.jta.platform" value="SunOne"/>
             <property name="hibernate.show_sql" value="true"/>
+
+            <property name="hypersistence.session.timeout_millis" value="25"/>
         </properties>
     </persistence-unit>
 </persistence>

hypersistence-optimizer-glassfish-hibernate4-example/src/test/java/io/hypersistence/optimizer/forum/adaptor/glassfish/AbstractGlassfishDataSourceJndiIntegrationTest.java

@@ -10,6 +10,7 @@
 import io.hypersistence.optimizer.hibernate.event.mapping.association.OneToOneWithoutMapsIdEvent;
 import io.hypersistence.optimizer.hibernate.event.mapping.association.fetching.EagerFetchingEvent;
 import io.hypersistence.optimizer.hibernate.event.query.PaginationWithoutOrderByEvent;
+import io.hypersistence.optimizer.hibernate.event.session.SessionTimeoutEvent;
 import org.jboss.arquillian.junit.Arquillian;
 import org.junit.Before;
 import org.junit.Test;
@@ -56,6 +57,8 @@ public void test() throws Exception {
             getEntityManager().persist(post);
         });
 
+        hypersistenceOptimizer.getEvents().clear();
+
         doInTransaction(() -> {
             assertEventTriggered(0, PaginationWithoutOrderByEvent.class);
 
@@ -68,7 +71,15 @@ public void test() throws Exception {
             assertEquals(1, posts.size());
 
             assertEventTriggered(1, PaginationWithoutOrderByEvent.class);
+
+            try {
+                Thread.sleep(25);
+            } catch (InterruptedException e) {
+                Thread.interrupted();
+            }
         });
+
+        assertEventTriggered(1, SessionTimeoutEvent.class);
     }
 
     private void doInTransaction(VoidCallable callable) {

hypersistence-optimizer-glassfish-hibernate4-example/src/test/resources-glassfish-embedded/MANIFEST/test-persistence.xml

@@ -13,12 +13,10 @@
 
         <properties>
             <property name="hibernate.hbm2ddl.auto" value="update"/>
-
+            <property name="hibernate.transaction.jta.platform" value="SunOne"/>
             <property name="hibernate.show_sql" value="true"/>
 
-            <property name="hibernate.dialect" value="org.hibernate.dialect.HSQLDialect"/>
-
-            <property name="hibernate.transaction.jta.platform" value="org.hibernate.service.jta.platform.internal.SunOneJtaPlatform"/>
+            <property name="hypersistence.session.timeout_millis" value="25"/>
         </properties>
     </persistence-unit>
 </persistence>

hypersistence-optimizer-spring-boot-example/src/test/java/io/hypersistence/optimizer/forum/ApplicationTest.java

@@ -31,6 +31,7 @@
 import io.hypersistence.optimizer.hibernate.event.mapping.association.OneToOneWithoutMapsIdEvent;
 import io.hypersistence.optimizer.hibernate.event.mapping.association.fetching.EagerFetchingEvent;
 import io.hypersistence.optimizer.hibernate.event.query.PaginationWithoutOrderByEvent;
+import io.hypersistence.optimizer.hibernate.event.session.SessionTimeoutEvent;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
@@ -43,12 +44,12 @@
 import org.springframework.transaction.support.TransactionCallback;
 import org.springframework.transaction.support.TransactionTemplate;
 
-import javax.persistence.EntityManager;
-import javax.persistence.EntityManagerFactory;
-import javax.persistence.PersistenceContext;
-import javax.persistence.PersistenceUnit;
+import javax.persistence.*;
 import java.util.Arrays;
 import java.util.List;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
 
 import static org.junit.Assert.*;
 
@@ -70,6 +71,12 @@ public class ApplicationTest {
     @Autowired
     private ForumService forumService;
 
+    protected final ExecutorService executorService = Executors.newSingleThreadExecutor(r -> {
+        Thread bob = new Thread(r);
+        bob.setName("Bob");
+        return bob;
+    });
+
     @Before
     public void init() {
         try {
@@ -89,7 +96,7 @@ public void init() {
     }
 
     @Test
-    public void test() {
+    public void test() throws ExecutionException, InterruptedException {
         assertEventTriggered(2, EagerFetchingEvent.class);
         assertEventTriggered(1, ManyToManyListEvent.class);
         assertEventTriggered(1, OneToOneParentSideEvent.class);
@@ -99,18 +106,37 @@ public void test() {
         assertEventTriggered(1, QueryPaginationCollectionFetchingEvent.class);
         assertEventTriggered(1, QueryInClauseParameterPaddingEvent.class);
 
-        Post newPost = forumService.newPost("High-Performance Java Persistence", Arrays.asList("hibernate", "jpa"));
-        assertNotNull(newPost.getId());
+        Post newPost = null;
+
+        for (int i = 0; i < 10; i++) {
+            newPost = forumService.newPost("High-Performance Java Persistence", Arrays.asList("hibernate", "jpa"));
+            assertNotNull(newPost.getId());
+        }
 
         List<Post> posts = forumService.findAllByTitle("High-Performance Java Persistence");
-        assertEquals(1, posts.size());
+        assertEquals(10, posts.size());
 
         Post post = forumService.findById(newPost.getId());
         assertEquals("High-Performance Java Persistence", post.getTitle());
 
         assertEventTriggered(0, PaginationWithoutOrderByEvent.class);
-        assertEquals(1, forumService.findAll(5).size());
+        assertEquals(5, forumService.findAll(5).size());
         assertEventTriggered(1, PaginationWithoutOrderByEvent.class);
+
+        hypersistenceOptimizer.getEvents().clear();
+
+        executorService.submit(() -> transactionTemplate.execute(
+            transactionStatus -> {
+                try {
+                    Thread.sleep(50);
+                } catch (InterruptedException e) {
+                    Thread.interrupted();
+                }
+                return null;
+            }
+        )).get();
+
+        assertEventTriggered(1, SessionTimeoutEvent.class);
     }
 
     protected void assertEventTriggered(int expectedCount, Class<? extends Event> eventClass) {

hypersistence-optimizer-spring-boot-example/src/test/resources/application.properties

@@ -0,0 +1,2 @@
+spring.jpa.properties.hypersistence.session.timeout_millis=25
+spring.jpa.open-in-view=false

hypersistence-optimizer-test-case/src/test/java/io/hypersistence/optimizer/util/transaction/HibernateTransactionConsumer.java

@@ -5,14 +5,14 @@
 /**
  * @author Vlad Mihalcea
  */
-public abstract class HibernateTransactionConsumer {
-    public abstract void accept(Session t);
+public interface HibernateTransactionConsumer {
+    void accept(Session t);
 
-    public void beforeTransactionCompletion() {
+    default void beforeTransactionCompletion() {
 
     }
 
-    public void afterTransactionCompletion() {
+    default void afterTransactionCompletion() {
 
     }
 }

hypersistence-optimizer-test-case/src/test/java/io/hypersistence/optimizer/util/transaction/HibernateTransactionFunction.java

@@ -5,15 +5,15 @@
 /**
  * @author Vlad Mihalcea
  */
-public abstract class HibernateTransactionFunction<T> {
+public interface HibernateTransactionFunction<T> {
 
-    public abstract T apply(Session t);
+    T apply(Session t);
 
-    public void beforeTransactionCompletion() {
+    default void beforeTransactionCompletion() {
 
     }
 
-    public void afterTransactionCompletion() {
+    default void afterTransactionCompletion() {
 
     }
 }