Feat(mysql-event-listener): Add user and password config to MySQL event listener

Allow configuring MySQL credentials for the event listener using separate mysql-event-listener.db.user and mysql-event-listener.db.password properties. This makes it easier and safer to provide credentials, especially when passwords contain special characters, and aligns with the configuration style of other Trino connectors. The connection logic now uses these properties if provided, falling back to credentials in the JDBC URL if not set.

Author: danielbelchior

docs/src/main/sphinx/admin/event-listeners-mysql.md

@@ -66,5 +66,12 @@ string, user, catalog, and others with information about the query processing.
 * - Property name
   - Description
 * - `mysql-event-listener.db.url`
-  - JDBC connection URL to the database including credentials
+  - Fully qualified JDBC connection URL used to connect to the MySQL database.
+    Credentials can be embedded in the URL if `user` and `password` are not specified separately
+* - `mysql-event-listener.db.user`
+  - Username used for authenticating the JDBC connection to the MySQL database.
+    An exception will be raised if credentials are included in the `URL`.
+* - `mysql-event-listener.db.password`
+  - Password used for authenticating the JDBC connection to the MySQL database.
+    An exception will be raised if credentials are included in the `URL`.
 :::

plugin/trino-mysql-event-listener/src/main/java/io/trino/plugin/eventlistener/mysql/MysqlEventListenerConfig.java

@@ -15,15 +15,19 @@
 
 import com.mysql.cj.jdbc.Driver;
 import io.airlift.configuration.Config;
+import io.airlift.configuration.ConfigDescription;
 import io.airlift.configuration.ConfigSecuritySensitive;
 import jakarta.validation.constraints.AssertTrue;
 import jakarta.validation.constraints.NotNull;
 
 import java.sql.SQLException;
+import java.util.Optional;
 
 public class MysqlEventListenerConfig
 {
     private String url;
+    private Optional<String> user = Optional.empty();
+    private Optional<String> password = Optional.empty();
 
     @NotNull
     public String getUrl()
@@ -39,11 +43,47 @@ public MysqlEventListenerConfig setUrl(String url)
         return this;
     }
 
+    public Optional<String> getUser()
+    {
+        return user;
+    }
+
+    @ConfigDescription("MySQL connection user")
+    @Config("mysql-event-listener.db.user")
+    public MysqlEventListenerConfig setUser(String user)
+    {
+        this.user = Optional.ofNullable(user);
+        return this;
+    }
+
+    public Optional<String> getPassword()
+    {
+        return password;
+    }
+
+    @ConfigSecuritySensitive
+    @ConfigDescription("MySQL connection password")
+    @Config("mysql-event-listener.db.password")
+    public MysqlEventListenerConfig setPassword(String password)
+    {
+        this.password = Optional.ofNullable(password);
+        return this;
+    }
+
     @AssertTrue(message = "Invalid JDBC URL for MySQL event listener")
     public boolean isValidUrl()
     {
         try {
-            return new Driver().acceptsURL(getUrl());
+            String url = getUrl();
+            // Check for user property
+            if (getUser().isPresent() && url != null && url.matches(".*[?&]user=.+")) {
+                throw new RuntimeException("'user' property is set, but JDBC URL also contains 'user' in the query string. Please specify the user only once.");
+            }
+            // Check for password property
+            if (getPassword().isPresent() && url != null && url.matches(".*[?&]password=.+")) {
+                throw new RuntimeException("'password' property is set, but JDBC URL also contains 'password' in the query string. Please specify the password only once.");
+            }
+            return new Driver().acceptsURL(url);
         }
         catch (SQLException e) {
             throw new RuntimeException(e);

plugin/trino-mysql-event-listener/src/main/java/io/trino/plugin/eventlistener/mysql/MysqlEventListenerFactory.java

@@ -90,7 +90,16 @@ public void configure(Binder binder)
         @Provides
         public ConnectionFactory createConnectionFactory(MysqlEventListenerConfig config)
         {
-            return () -> new Driver().connect(config.getUrl(), new Properties());
+            return () -> {
+                Properties properties = new Properties();
+                if (config.getUser() != null) {
+                    properties.setProperty("user", config.getUser());
+                }
+                if (config.getPassword() != null) {
+                    properties.setProperty("password", config.getPassword());
+                }
+                return new Driver().connect(config.getUrl(), properties);
+            };
         }
 
         @Singleton

plugin/trino-mysql-event-listener/src/test/java/io/trino/plugin/eventlistener/mysql/TestMysqlEventListener.java

@@ -354,6 +354,8 @@ final class TestMysqlEventListener
 
     private MySQLContainer<?> mysqlContainer;
     private String mysqlContainerUrl;
+    private String mysqlContainerUser;
+    private String mysqlContainerPassword;
     private EventListener eventListener;
     private JsonCodecFactory jsonCodecFactory;
 
@@ -363,8 +365,12 @@ void setup()
         mysqlContainer = new MySQLContainer<>("mysql:8.0.36");
         mysqlContainer.start();
         mysqlContainerUrl = getJdbcUrl(mysqlContainer);
+        mysqlContainerUser = mysqlContainer.getUsername();
+        mysqlContainerPassword = mysqlContainer.getPassword();
         eventListener = new MysqlEventListenerFactory()
-                .create(Map.of("mysql-event-listener.db.url", mysqlContainerUrl), new TestingEventListenerContext());
+                .create(Map.of("mysql-event-listener.db.url", mysqlContainerUrl,
+                        "mysql-event-listener.db.user", mysqlContainerUser,
+                        "mysql-event-listener.db.password", mysqlContainerPassword), new TestingEventListenerContext());
         jsonCodecFactory = new JsonCodecFactory();
     }
 
@@ -375,17 +381,17 @@ void teardown()
             mysqlContainer.close();
             mysqlContainer = null;
             mysqlContainerUrl = null;
+            mysqlContainerUser = null;
+            mysqlContainerPassword = null;
         }
         eventListener = null;
         jsonCodecFactory = null;
     }
 
     private static String getJdbcUrl(MySQLContainer<?> container)
     {
-        return format("%s?user=%s&password=%s&useSSL=false&allowPublicKeyRetrieval=true",
-                container.getJdbcUrl(),
-                container.getUsername(),
-                container.getPassword());
+        return format("%s?useSSL=false&allowPublicKeyRetrieval=true",
+                container.getJdbcUrl());
     }
 
     @Test

plugin/trino-mysql-event-listener/src/test/java/io/trino/plugin/eventlistener/mysql/TestMysqlEventListenerConfig.java

@@ -16,6 +16,7 @@
 import org.junit.jupiter.api.Test;
 
 import java.util.Map;
+import java.util.Optional;
 
 import static io.airlift.configuration.testing.ConfigAssertions.assertFullMapping;
 import static io.airlift.configuration.testing.ConfigAssertions.assertRecordedDefaults;
@@ -28,33 +29,45 @@ final class TestMysqlEventListenerConfig
     void testDefaults()
     {
         assertRecordedDefaults(recordDefaults(MysqlEventListenerConfig.class)
-                .setUrl(null));
+                .setUrl(null)
+                .setUser(null)
+                .setPassword(null));
     }
 
     @Test
     void testExplicitPropertyMappings()
     {
         Map<String, String> properties = Map.of(
-                "mysql-event-listener.db.url", "jdbc:mysql://example.net:3306");
+                "mysql-event-listener.db.url", "jdbc:mysql://example.net:3306",
+                "mysql-event-listener.db.user", "user",
+                "mysql-event-listener.db.password", "password");
 
         MysqlEventListenerConfig expected = new MysqlEventListenerConfig()
-                .setUrl("jdbc:mysql://example.net:3306");
+                .setUrl("jdbc:mysql://example.net:3306")
+                .setUser("user")
+                .setPassword("password");
 
         assertFullMapping(properties, expected);
     }
 
     @Test
     void testIsValidUrl()
     {
-        assertThat(isValidUrl("jdbc:mysql://example.net:3306")).isTrue();
-        assertThat(isValidUrl("jdbc:mysql://example.net:3306/")).isTrue();
-        assertThat(isValidUrl("jdbc:postgresql://example.net:3306/somedatabase")).isFalse();
+        assertThat(isValidUrl("jdbc:mysql://example.net:3306", Optional.empty(), Optional.empty())).isTrue();
+        assertThat(isValidUrl("jdbc:mysql://example.net:3306/", Optional.empty(), Optional.empty())).isTrue();
+        assertThat(isValidUrl("jdbc:postgresql://example.net:3306/somedatabase", Optional.empty(), Optional.empty())).isFalse();
+        assertThat(isValidUrl("jdbc:mysql://example.net:3306?user=user", Optional.empty(), Optional.empty())).isTrue();
+        assertThat(isValidUrl("jdbc:mysql://example.net:3306?user=user", Optional.of("user"), Optional.empty())).isFalse();
+        assertThat(isValidUrl("jdbc:mysql://example.net:3306?password=password", Optional.empty(), Optional.empty())).isTrue();
+        assertThat(isValidUrl("jdbc:mysql://example.net:3306?password=password", Optional.empty(), Optional.of("password"))).isFalse();
     }
 
-    private static boolean isValidUrl(String url)
+    private static boolean isValidUrl(String url, Optional<String> user, Optional<String> password)
     {
         return new MysqlEventListenerConfig()
                 .setUrl(url)
+                .setUser(user.orElse(null))
+                .setPassword(password.orElse(null))
                 .isValidUrl();
     }
 }