Fix for Bug#114846 (Bug#36574322), Auto-closeable X dev session.

Change-Id: Iae79e3ddf89daaa68a58d58bfe2a08c801ab377a
mysql · May 15, 2024 · a9ec867 · a9ec867
1 parent 223dfaf
commit a9ec867
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 2 deletions.
diff --git a/CHANGES b/CHANGES
@@ -3,6 +3,9 @@
 
 Version 9.0.0
 
+  - Fix for Bug#114846 (Bug#36574322), Auto-closeable X dev session.
+    Thanks to Daniel Kec for his contribution.
+
   - Fix for Bug#114989 (Bug#36612566), Setting null value in setClientInfo throws an NPE.
 
   - WL#16376, Set 'caching_sha2_password' as default fallback authentication plugin.

diff --git a/src/main/user-api/java/com/mysql/cj/xdevapi/Client.java b/src/main/user-api/java/com/mysql/cj/xdevapi/Client.java
@@ -25,7 +25,7 @@
  * <p>
  * The Client object is obtained via {@link ClientFactory#getClient(String, java.util.Properties)} or {@link ClientFactory#getClient(String, String)} methods.
  */
-public interface Client {
+public interface Client extends AutoCloseable {
 
     /**
      * Get <code>Session</code> from pool or the new one.
@@ -41,6 +41,7 @@ public interface Client {
      * Calling the method <code>close</code> on a <code>Client</code>
      * object that is already closed is a no-op.
      */
+    @Override
     public void close();
 
     public enum ClientProperty {

diff --git a/src/main/user-api/java/com/mysql/cj/xdevapi/Session.java b/src/main/user-api/java/com/mysql/cj/xdevapi/Session.java
@@ -65,7 +65,7 @@
  * <p>
  * Users of the CRUD API do not need to escape identifiers. This is true for working with collections and for working with relational tables.
  */
-public interface Session {
+public interface Session extends AutoCloseable {
 
     /**
      * Retrieve the list of Schema objects for which the current user has access.
@@ -143,6 +143,7 @@ public interface Session {
     /**
      * Close this session.
      */
+    @Override
     void close();
 
     /**

diff --git a/src/test/java/testsuite/x/devapi/SessionTest.java b/src/test/java/testsuite/x/devapi/SessionTest.java
@@ -2533,4 +2533,41 @@ public void testBug97269() throws Exception {
         }
     }
 
+    @Test
+    void testAutoCloseableSession() throws Exception {
+        final Session testSessionRef;
+
+        try (Session testSession = this.fact.getSession(this.baseUrl)) {
+            assertTrue(testSession.isOpen());
+            testSessionRef = testSession;
+        }
+
+        assertNotNull(testSessionRef);
+        assertFalse(testSessionRef.isOpen());
+    }
+
+    @Test
+    void testAutoCloseableClient() throws Exception {
+        final ClientFactory testClientFactory = new ClientFactory();
+        final Client testClientRef;
+        final Session testSessionRef1;
+        final Session testSessionRef2;
+
+        try (Client testClient = testClientFactory.getClient(this.baseUrl, new Properties())) {
+            testSessionRef1 = testClient.getSession();
+            assertTrue(testSessionRef1.isOpen());
+            testSessionRef2 = testClient.getSession();
+            assertTrue(testSessionRef2.isOpen());
+            testClientRef = testClient;
+        }
+
+        assertNotNull(testSessionRef1);
+        assertFalse(testSessionRef1.isOpen());
+        assertNotNull(testSessionRef2);
+        assertFalse(testSessionRef2.isOpen());
+
+        assertNotNull(testClientRef);
+        assertThrows(XDevAPIError.class, "Client is closed\\.", testClientRef::getSession);
+    }
+
 }