#23 - Tidy up online() online() and offline() offline() behaviour + API 4.5 improvements

Author: rbygrave

pom.xml

@@ -10,7 +10,7 @@
 
   <groupId>io.ebean</groupId>
   <artifactId>ebean-datasource</artifactId>
-  <version>4.4.2-SNAPSHOT</version>
+  <version>4.5.1-SNAPSHOT</version>
 
   <scm>
     <developerConnection>scm:git:[email protected]:ebean-orm/ebean-datasource.git</developerConnection>
@@ -22,7 +22,7 @@
     <dependency>
       <groupId>io.ebean</groupId>
       <artifactId>ebean-datasource-api</artifactId>
-      <version>4.4</version>
+      <version>4.5</version>
     </dependency>
 
     <dependency>

src/main/java/io/ebean/datasource/pool/ConnectionPool.java

@@ -280,11 +280,6 @@ private void checkDriver() {
     }
   }
 
-  @Override
-  public void online() throws SQLException {
-    initialise();
-  }
-
   private void initialise() throws SQLException {
 
     //noinspection StringBufferReplaceableByString
@@ -300,7 +295,7 @@ private void initialise() throws SQLException {
     try {
       dataSourceUp = true;
       queue.ensureMinimumConnections();
-      startHeartBeat();
+      startHeartBeatIfStopped();
     } catch (SQLException e) {
       if (failOnStart) {
         throw e;
@@ -309,14 +304,6 @@ private void initialise() throws SQLException {
     }
   }
 
-  private void startHeartBeat() {
-    int freqMillis = heartbeatFreqSecs * 1000;
-    if (freqMillis > 0) {
-      heartBeatTimer = new Timer(name + ".heartBeat", true);
-      heartBeatTimer.scheduleAtFixedRate(new HeartBeatRunnable(), freqMillis, freqMillis);
-    }
-  }
-
   /**
    * Initialise the database using the owner credentials if we can't connect using the normal credentials.
    * <p>
@@ -438,6 +425,7 @@ private synchronized void notifyDataSourceIsUp() {
       dataSourceUp = true;
       dataSourceDownReason = null;
       reset();
+      startHeartBeatIfStopped();
     }
   }
 
@@ -845,6 +833,11 @@ public void testAlert() {
     }
   }
 
+  @Override
+  public void shutdown() {
+    shutdown(false);
+  }
+
   /**
    * This will close all the free connections, and then go into a wait loop,
    * waiting for the busy connections to be freed.
@@ -855,21 +848,51 @@ public void testAlert() {
    * </p>
    */
   @Override
-  public void shutdown(boolean deregisterDriver) {
-    heartBeatTimer.cancel();
-    queue.shutdown();
+  public synchronized void shutdown(boolean deregisterDriver) {
+    offline();
     if (deregisterDriver) {
       deregisterDriver();
     }
   }
 
   @Override
-  public void offline() {
-    heartBeatTimer.cancel();
+  public synchronized void offline() {
+    stopHeartBeatIfRunning();
     queue.shutdown();
     dataSourceUp = false;
   }
 
+  @Override
+  public synchronized boolean isOnline() {
+    return dataSourceUp;
+  }
+
+  @Override
+  public synchronized void online() throws SQLException {
+    if (!dataSourceUp) {
+      initialise();
+    }
+  }
+
+  private void startHeartBeatIfStopped() {
+    // only start if it is not already running
+    if (heartBeatTimer == null) {
+      int freqMillis = heartbeatFreqSecs * 1000;
+      if (freqMillis > 0) {
+        heartBeatTimer = new Timer(name + ".heartBeat", true);
+        heartBeatTimer.scheduleAtFixedRate(new HeartBeatRunnable(), freqMillis, freqMillis);
+      }
+    }
+  }
+
+  private void stopHeartBeatIfRunning() {
+    // only stop if it was running
+    if (heartBeatTimer != null) {
+      heartBeatTimer.cancel();
+      heartBeatTimer = null;
+    }
+  }
+
   /**
    * Return the default autoCommit setting Connections in this pool will use.
    *

src/test/java/io/ebean/datasource/pool/ConnectionPoolOfflineTest.java

@@ -5,8 +5,10 @@
 import org.slf4j.LoggerFactory;
 import org.testng.annotations.Test;
 
+import java.sql.Connection;
 import java.sql.SQLException;
 
+import static org.assertj.core.api.Assertions.assertThat;
 import static org.testng.Assert.assertEquals;
 
 public class ConnectionPoolOfflineTest {
@@ -17,7 +19,7 @@ private DataSourceConfig config() {
 
     DataSourceConfig config = new DataSourceConfig();
     config.setDriver("org.h2.Driver");
-    config.setUrl("jdbc:h2:mem:tests");
+    config.setUrl("jdbc:h2:mem:testOffline");
     config.setUsername("sa");
     config.setPassword("");
     config.setMinConnections(2);
@@ -33,7 +35,8 @@ public void testOffline() throws InterruptedException, SQLException {
 
     DataSourceConfig config = config();
 
-    ConnectionPool pool = new ConnectionPool("test", config);
+    ConnectionPool pool = new ConnectionPool("testOffline", config);
+    assertThat(pool.isOnline()).isFalse();
     log.info("pool created ");
     Thread.sleep(3000);
 
@@ -42,28 +45,81 @@ public void testOffline() throws InterruptedException, SQLException {
 
     pool.online();
     log.info("pool online");
+    assertThat(pool.isOnline()).isTrue();
     assertEquals(2, pool.getStatus(false).getFree());
     assertEquals(0, pool.getStatus(false).getBusy());
 
     Thread.sleep(3000);
 
     pool.offline();
     log.info("pool offline");
+    assertThat(pool.isOnline()).isFalse();
     assertEquals(0, pool.getStatus(false).getFree());
     assertEquals(0, pool.getStatus(false).getBusy());
 
     Thread.sleep(3000);
 
     pool.online();
     log.info("pool online");
+    assertThat(pool.isOnline()).isTrue();
     assertEquals(2, pool.getStatus(false).getFree());
     assertEquals(0, pool.getStatus(false).getBusy());
     Thread.sleep(3000);
 
-    pool.shutdown(false);
+    pool.shutdown();
 
+    assertThat(pool.isOnline()).isFalse();
     assertEquals(0, pool.getStatus(false).getFree());
     assertEquals(0, pool.getStatus(false).getBusy());
   }
 
+  @Test
+  public void offlineOffline() {
+
+    DataSourceConfig config = config().setUrl("jdbc:h2:mem:offlineOffline");
+
+    ConnectionPool pool = new ConnectionPool("offlineOffline", config);
+    assertThat(pool.isOnline()).isFalse();
+
+    pool.offline();
+    assertThat(pool.isOnline()).isFalse();
+
+    pool.offline();
+    pool.offline();
+    assertThat(pool.isOnline()).isFalse();
+  }
+
+  @Test
+  public void offlineGetConnection_expect_goesOnline() throws SQLException {
+
+    DataSourceConfig config = config().setUrl("jdbc:h2:mem:offlineOffline");
+
+    ConnectionPool pool = new ConnectionPool("offlineOffline", config);
+    pool.offline();
+    assertThat(pool.isOnline()).isFalse();
+
+    try (Connection connection = pool.getConnection()) {
+      assertThat(connection).isNotNull();
+      assertThat(pool.isOnline()).isTrue();
+    }
+
+    pool.shutdown();
+    assertThat(pool.isOnline()).isFalse();
+  }
+
+  @Test
+  public void onlineOnline() throws SQLException {
+
+    DataSourceConfig config = config().setUrl("jdbc:h2:mem:onlineOnline");
+
+    ConnectionPool pool = new ConnectionPool("onlineOnline", config);
+    assertThat(pool.isOnline()).isFalse();
+
+    pool.online();
+    assertThat(pool.isOnline()).isTrue();
+
+    pool.online();
+    pool.online();
+    assertThat(pool.isOnline()).isTrue();
+  }
 }