Skip to content

LLM-Driven Extraction of Unstructured Data — Built for API Deployments & ETL Pipeline Workflows

UN-2806 [FIX] Set SSL to False by default for MariaDB connections to prevent connection errors (#1535)

Kirtiman Mishraa9b090aa4172
diff --git a/backend/workflow_manager/endpoint_v2/tests/destination-connectors/test_destination_connector_mariadb.py b/backend/workflow_manager/endpoint_v2/tests/destination-connectors/test_destination_connector_mariadb.py
index 0f2bd39ab..2c46a65fe 100644
--- a/backend/workflow_manager/endpoint_v2/tests/destination-connectors/test_destination_connector_mariadb.py
+++ b/backend/workflow_manager/endpoint_v2/tests/destination-connectors/test_destination_connector_mariadb.py
@@ -22,6 +22,7 @@ class TestDestinationConnectorMariaDB(TestCase):
"MARIADB_DATABASE",
"MARIADB_USER",
"MARIADB_PASSWORD",
+ "MARIADB_SSL_ENABLED",
]
# Check if all required environment variables are set
@@ -37,8 +38,8 @@ class TestDestinationConnectorMariaDB(TestCase):
"database": os.getenv("MARIADB_DATABASE"),
"user": os.getenv("MARIADB_USER"),
"password": os.getenv("MARIADB_PASSWORD"),
+ "sslEnabled": os.getenv("MARIADB_SSL_ENABLED", False),
}
-
# Test data that will be inserted into the database
self.test_data = {"key": "value", "result": "test_result", "status": "success"}
self.test_metadata = {
diff --git a/unstract/connectors/sample.env b/unstract/connectors/sample.env
new file mode 100644
index 000000000..f52cb783a
--- /dev/null
+++ b/unstract/connectors/sample.env
@@ -0,0 +1,9 @@
+# MariaDB Test Configuration
+# Copy this file to .env and update with your MariaDB credentials
+
+MARIADB_HOST=localhost
+MARIADB_PORT=3306
+MARIADB_DATABASE=unstract_db
+MARIADB_USER=unstract_dev
+MARIADB_PASSWORD=unstract_pass
+MARIADB_SSL_ENABLED=False
diff --git a/unstract/connectors/src/unstract/connectors/databases/mariadb/mariadb.py b/unstract/connectors/src/unstract/connectors/databases/mariadb/mariadb.py
index b32a3b7a9..fdbede8f2 100644
--- a/unstract/connectors/src/unstract/connectors/databases/mariadb/mariadb.py
+++ b/unstract/connectors/src/unstract/connectors/databases/mariadb/mariadb.py
@@ -2,10 +2,12 @@ import os
from typing import Any
import pymysql
+import pymysql.err as MysqlError
from pymysql.connections import Connection
from unstract.connectors.databases.mysql_handler import MysqlHandler
from unstract.connectors.databases.unstract_db import UnstractDB
+from unstract.connectors.exceptions import ConnectorError
class MariaDB(UnstractDB, MysqlHandler):
@@ -17,6 +19,7 @@ class MariaDB(UnstractDB, MysqlHandler):
self.host = settings.get("host")
self.port = settings.get("port", 3306)
self.database = settings.get("database")
+ self.ssl_enabled = settings.get("sslEnabled", True)
@staticmethod
def get_id() -> str:
@@ -50,14 +53,24 @@ class MariaDB(UnstractDB, MysqlHandler):
return True
def get_engine(self) -> Connection: # type: ignore[type-arg]
- con = pymysql.connect(
- host=self.host,
- port=int(self.port),
- database=self.database,
- user=self.user,
- password=self.password,
- )
- return con
+ connection_params = {
+ "host": self.host,
+ "port": int(self.port),
+ "database": self.database,
+ "user": self.user,
+ "password": self.password,
+ }
+
+ try:
+ if self.ssl_enabled:
+ connection_params.update({"ssl": {"ssl_disabled": False}})
+ con = pymysql.connect(**connection_params)
+ return con
+ except MysqlError.OperationalError as e:
+ error_msg = MysqlHandler.handle_connection_error(
+ e, self.host, self.port, self.ssl_enabled
+ )
+ raise ConnectorError(error_msg) from e
def sql_to_db_mapping(self, value: Any, column_name: str | None = None) -> str:
return str(MysqlHandler.sql_to_db_mapping(value=value, column_name=column_name))
diff --git a/unstract/connectors/src/unstract/connectors/databases/mariadb/static/json_schema.json b/unstract/connectors/src/unstract/connectors/databases/mariadb/static/json_schema.json
index b932a402b..783a5bb71 100644
--- a/unstract/connectors/src/unstract/connectors/databases/mariadb/static/json_schema.json
+++ b/unstract/connectors/src/unstract/connectors/databases/mariadb/static/json_schema.json
@@ -40,6 +40,12 @@
"title": "Password",
"format": "password",
"default": ""
+ },
+ "sslEnabled": {
+ "type": "boolean",
+ "title": "Enable SSL",
+ "description": "Toggle TLS/SSL for the client connection. Enable if your server enforces TLS; disable if your environment requires plain connections.",
+ "default": false
}
}
}
diff --git a/unstract/connectors/src/unstract/connectors/databases/mysql_handler.py b/unstract/connectors/src/unstract/connectors/databases/mysql_handler.py
index 13752dbb6..d202acf61 100644
--- a/unstract/connectors/src/unstract/connectors/databases/mysql_handler.py
+++ b/unstract/connectors/src/unstract/connectors/databases/mysql_handler.py
@@ -13,6 +13,16 @@ from unstract.connectors.databases.exceptions_helper import ExceptionHelper
logger = logging.getLogger(__name__)
+# MySQL/MariaDB connection error codes mapping
+CONNECTION_ERROR_MESSAGES = {
+ 1045: "Authentication failed. Please check your username, password and SSL SETTINGS.",
+ 2003: "Cannot connect to server. Please check the host, port, and network connectivity.",
+ 1049: "Unknown database. Please verify the database name exists.",
+ 2005: "Unknown host. Please check the host address.",
+ 2006: "MySQL server is unavailable. Connection was lost.",
+ 2013: "Lost connection to MySQL server during query.",
+}
+
class MysqlHandler:
@staticmethod
@@ -72,3 +82,30 @@ class MysqlHandler:
database=database,
table_name=table_name,
) from e
+
+ @staticmethod
+ def handle_connection_error(
+ e: MysqlError.OperationalError, host: str, port: int, ssl_enabled: bool
+ ) -> str:
+ """Handle MySQL/MariaDB connection errors with user-friendly messages.
+
+ Args:
+ e: The OperationalError from pymysql
+ host: Database host
+ port: Database port
+ ssl_enabled: Whether SSL is enabled
+
+ Returns:
+ str: User-friendly error message for UI display
+ """
+ error_code, original_message = e.args
+ user_message = CONNECTION_ERROR_MESSAGES.get(error_code, original_message)
+
+ ssl_context = ""
+ if ssl_enabled is not None:
+ ssl_context = f" (SSL {'enabled' if ssl_enabled else 'disabled'})"
+
+ return (
+ f"{user_message} Connection: '{host}:{port}{ssl_context}' \n"
+ f"```\n{original_message}\n```"
+ )
diff --git a/unstract/connectors/tests/databases/test_mariadb.py b/unstract/connectors/tests/databases/test_mariadb.py
index da76f9378..e6f008af2 100644
--- a/unstract/connectors/tests/databases/test_mariadb.py
+++ b/unstract/connectors/tests/databases/test_mariadb.py
@@ -1,27 +1,128 @@
+import os
import unittest
+from typing import Any
+from unittest.mock import Mock, patch
+
+import pymysql.err as MysqlError
from unstract.connectors.databases.mariadb.mariadb import MariaDB
+from unstract.connectors.exceptions import ConnectorError
class TestMariaDB(unittest.TestCase):
- def test_user_name_and_password(self):
- mariadb = MariaDB(
- {
- "user": "root",
- "password": "ascon",
- "host": "localhost",
- "port": "3306",
- "database": "testdb",
- }
+ def setUp(self) -> None:
+ """Set up test configuration from environment variables"""
+
+ # SSL enabled config for testing SSL scenarios
+ self.mariadb_config_ssl_enabled = {
+ "host": os.getenv("MARIADB_HOST", "localhost"),
+ "port": os.getenv("MARIADB_PORT", "3306"),
+ "database": os.getenv("MARIADB_DATABASE", "testdb"),
+ "user": os.getenv("MARIADB_USER", "root"),
+ "password": os.getenv("MARIADB_PASSWORD", ""),
+ "sslEnabled": True,
+ }
+
+ # SSL disabled config for testing non-SSL scenarios
+ self.mariadb_config_ssl_disabled = {
+ "host": os.getenv("MARIADB_HOST", "localhost"),
+ "port": os.getenv("MARIADB_PORT", "3306"),
+ "database": os.getenv("MARIADB_DATABASE", "testdb"),
+ "user": os.getenv("MARIADB_USER", "root"),
+ "password": os.getenv("MARIADB_PASSWORD", ""),
+ "sslEnabled": False,
+ }
+
+ def test_ssl_config_from_environment(self) -> None:
+ """Test SSL configuration is loaded from environment variables"""
+ # Use existing config but override SSL to read from environment
+ config = {**self.mariadb_config_ssl_enabled, "sslEnabled": os.getenv("MARIADB_SSL_ENABLED", "false").lower() == "true"}
+
+ mariadb = MariaDB(config)
+ expected_ssl = os.getenv("MARIADB_SSL_ENABLED", "false").lower() == "true"
+ self.assertEqual(mariadb.ssl_enabled, expected_ssl)
+
+ @patch("unstract.connectors.databases.mariadb.mariadb.pymysql.connect")
+ def test_connection_params_ssl_enabled(self, mock_connect: Any) -> None:
+ """Test that SSL parameters are passed when SSL is enabled"""
+ mock_connection = Mock()
+ mock_connect.return_value = mock_connection
+ mariadb = MariaDB(self.mariadb_config_ssl_enabled)
+
+ result = mariadb.get_engine()
+
+ # Verify pymysql.connect was called with SSL parameters
+ mock_connect.assert_called_once()
+ call_args = mock_connect.call_args[1]
+ self.assertIn("ssl", call_args)
+ self.assertEqual(call_args["ssl"], {"ssl_disabled": False})
+ self.assertEqual(result, mock_connection)
+
+ @patch("unstract.connectors.databases.mariadb.mariadb.pymysql.connect")
+ def test_connection_params_ssl_disabled(self, mock_connect: Any) -> None:
+ """Test that no SSL parameters are passed when SSL is disabled"""
+ mock_connection = Mock()
+ mock_connect.return_value = mock_connection
+
+ mariadb = MariaDB(self.mariadb_config_ssl_disabled)
+ result = mariadb.get_engine()
+
+ mock_connect.assert_called_once()
+ call_args = mock_connect.call_args[1]
+ self.assertNotIn("ssl", call_args)
+ self.assertEqual(result, mock_connection)
+
+ @patch("unstract.connectors.databases.mariadb.mariadb.pymysql.connect")
+ def test_authentication_error_handling(self, mock_connect: Any) -> None:
+ """Test authentication error (1045) produces proper error message"""
+ mock_connect.side_effect = MysqlError.OperationalError(
+ 1045, "Access denied for user 'test'@'localhost'"
)
- query = "SELECT * FROM employees"
- cursor = mariadb.get_engine().cursor()
- cursor.execute(query)
- results = cursor.fetchall()
-
- for c in results:
- print(c)
- self.assertTrue(len(results) > 0)
+
+ mariadb = MariaDB(self.mariadb_config_ssl_enabled)
+
+ with self.assertRaises(ConnectorError) as context:
+ mariadb.get_engine()
+
+ error_message = str(context.exception)
+ self.assertIn("Authentication failed", error_message)
+ self.assertIn("username, password and ssl-settings", error_message)
+ self.assertIn("localhost:3306", error_message)
+ self.assertIn("SSL enabled", error_message)
+
+ @patch("unstract.connectors.databases.mariadb.mariadb.pymysql.connect")
+ def test_network_error_handling_ssl_enabled(self, mock_connect: Any) -> None:
+ """Test network error (2003) with SSL enabled includes SSL context"""
+ mock_connect.side_effect = MysqlError.OperationalError(
+ 2003, "Can't connect to MySQL server"
+ )
+
+ mariadb = MariaDB(self.mariadb_config_ssl_enabled)
+
+ with self.assertRaises(ConnectorError) as context:
+ mariadb.get_engine()
+
+ error_message = str(context.exception)
+ self.assertIn("Cannot connect to server", error_message)
+ self.assertIn("localhost:3306", error_message)
+ self.assertIn("SSL enabled", error_message)
+
+ @patch("unstract.connectors.databases.mariadb.mariadb.pymysql.connect")
+ def test_network_error_handling_ssl_disabled(self, mock_connect: Any) -> None:
+ """Test network error (2003) with SSL disabled includes SSL context"""
+ mock_connect.side_effect = MysqlError.OperationalError(
+ 2003, "Can't connect to MySQL server"
+ )
+
+ mariadb = MariaDB(self.mariadb_config_ssl_disabled)
+
+ with self.assertRaises(ConnectorError) as context:
+ mariadb.get_engine()
+
+ error_message = str(context.exception)
+ self.assertIn("Cannot connect to server", error_message)
+ self.assertIn("localhost:3306", error_message)
+ self.assertIn("SSL disabled", error_message)
if __name__ == "__main__":