chore(dbc-ui): encode characters before building sqlalchemy uri

.pylintrc

@@ -364,7 +364,7 @@ max-args=5
 ignored-argument-names=_.*
 
 # Maximum number of locals for function / method body
-max-locals=15
+max-locals=16
 
 # Maximum number of return / yield for function / method body
 max-returns=10

superset/databases/commands/validate.py

@@ -30,6 +30,7 @@
     InvalidParametersError,
 )
 from superset.databases.dao import DatabaseDAO
+from superset.databases.utils import encode_parameters
 from superset.db_engine_specs import get_engine_specs
 from superset.db_engine_specs.base import BasicParametersMixin
 from superset.errors import ErrorLevel, SupersetError, SupersetErrorType
@@ -99,9 +100,12 @@ def run(self) -> None:
         except json.decoder.JSONDecodeError:
             encrypted_extra = {}
 
+        # encode parameters
+        params = encode_parameters(self._properties.get("parameters", {}))
+
         # try to connect
         sqlalchemy_uri = engine_spec.build_sqlalchemy_uri(  # type: ignore
-            self._properties.get("parameters"), encrypted_extra,
+            params, encrypted_extra,
         )
         if self._model and sqlalchemy_uri == self._model.safe_sqlalchemy_uri():
             sqlalchemy_uri = self._model.sqlalchemy_uri_decrypted

superset/databases/schemas.py

@@ -28,6 +28,7 @@
 from sqlalchemy.exc import ArgumentError
 
 from superset import db
+from superset.databases.utils import encode_parameters
 from superset.db_engine_specs import BaseEngineSpec, get_engine_specs
 from superset.exceptions import CertificateException, SupersetSecurityException
 from superset.models.core import ConfigurationMethod, Database, PASSWORD_MASK
@@ -254,6 +255,10 @@ def build_sqlalchemy_uri(
         the constructed SQLAlchemy URI to be passed.
         """
         parameters = data.pop("parameters", {})
+
+        # encode parameters
+        parameters = encode_parameters(parameters)
+
         # TODO(AAfghahi) standardize engine.
         engine = (
             data.pop("engine", None)

superset/databases/utils.py

@@ -14,6 +14,7 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
+import urllib
 from typing import Any, Dict, List, Optional
 
 from superset import app
@@ -101,3 +102,13 @@ def get_table_metadata(
         "indexes": keys,
         "comment": table_comment,
     }
+
+
+def encode_parameters(parameters: Dict[str, Any]) -> Dict[str, Any]:
+    encoded_params = {}
+    for k, v in parameters.items():
+        if isinstance(v, str):
+            encoded_params[k] = urllib.parse.quote_plus(v)
+        else:
+            encoded_params[k] = v
+    return encoded_params

tests/integration_tests/databases/utils_tests.py

@@ -0,0 +1,46 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+import pytest
+
+from superset.databases.utils import encode_parameters
+
+
+@pytest.mark.parametrize(
+    "test_input, expected",
+    [
+        (
+            {
+                "host": "local%host",
+                "port": "5432",
+                "database": "postgres",
+                "username": "postgres",
+                "password": "hugh@miles4",
+                "query": {},
+            },
+            {
+                "host": "local%25host",
+                "port": "5432",
+                "database": "postgres",
+                "username": "postgres",
+                "password": "hugh%40miles4",
+                "query": {},
+            },
+        )
+    ],
+)
+def test_escape_parameters(test_input, expected):
+    assert encode_parameters(test_input) == expected