[incubator-superset] branch master updated: [core] Fix, sanitize errors returned from testconn (#9178)

[dp...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

dpgaspar pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-superset.git


The following commit(s) were added to refs/heads/master by this push:
     new 27b371a  [core] Fix, sanitize errors returned from testconn (#9178)
27b371a is described below

commit 27b371a4856d970dff93c8aba4605e3daf3b5eb2
Author: Daniel Vaz Gaspar <da...@gmail.com>
AuthorDate: Mon Feb 24 10:40:51 2020 +0000

    [core] Fix, sanitize errors returned from testconn (#9178)
---
 superset/views/core.py                | 40 +++++++++++++++++++++++++++++------
 superset/views/database/validators.py |  6 +++---
 tests/core_tests.py                   |  4 +---
 3 files changed, 37 insertions(+), 13 deletions(-)

diff --git a/superset/views/core.py b/superset/views/core.py
index 520883e..0a7872e 100755
--- a/superset/views/core.py
+++ b/superset/views/core.py
@@ -34,7 +34,13 @@ from flask_appbuilder.security.decorators import has_access, has_access_api
 from flask_appbuilder.security.sqla import models as ab_models
 from flask_babel import gettext as __, lazy_gettext as _
 from sqlalchemy import and_, Integer, or_, select
-from sqlalchemy.exc import SQLAlchemyError
+from sqlalchemy.engine.url import make_url
+from sqlalchemy.exc import (
+    ArgumentError,
+    NoSuchModuleError,
+    OperationalError,
+    SQLAlchemyError,
+)
 from sqlalchemy.orm.session import Session
 from werkzeug.urls import Href
 
@@ -1298,10 +1304,9 @@ class Superset(BaseSupersetView):
     @expose("/testconn", methods=["POST", "GET"])
     def testconn(self):
         """Tests a sqla connection"""
+        db_name = request.json.get("name")
+        uri = request.json.get("uri")
         try:
-            db_name = request.json.get("name")
-            uri = request.json.get("uri")
-
             # if the database already exists in the database, only its safe (password-masked) URI
             # would be shown in the UI and would be passed in the form data.
             # so if the database already exists and the form was submitted with the safe URI,
@@ -1330,11 +1335,32 @@ class Superset(BaseSupersetView):
             with closing(engine.connect()) as conn:
                 conn.scalar(select([1]))
                 return json_success('"OK"')
-        except Exception as e:
-            logger.exception(e)
+        except NoSuchModuleError as e:
+            logger.info("Invalid driver %s", e)
+            driver_name = make_url(uri).drivername
             return json_error_response(
-                "Connection failed!\n\n" f"The error message returned was:\n{e}", 400
+                _(
+                    "Could not load database driver: %(driver_name)s",
+                    driver_name=driver_name,
+                ),
+                400,
             )
+        except ArgumentError as e:
+            logger.info("Invalid URI %s", e)
+            return json_error_response(
+                _(
+                    "Invalid connection string, a valid string usually follows:\n"
+                    "'DRIVER://USER:PASSWORD@DB-HOST/DATABASE-NAME'"
+                )
+            )
+        except OperationalError as e:
+            logger.warning("Connection failed %s", e)
+            return json_error_response(
+                _("Connection failed, please check your connection settings."), 400
+            )
+        except Exception as e:
+            logger.error("Unexpected error %s", e)
+            return json_error_response(_("Unexpected error occurred."), 400)
 
     @api
     @has_access_api
diff --git a/superset/views/database/validators.py b/superset/views/database/validators.py
index 07ddc24..0800c11 100644
--- a/superset/views/database/validators.py
+++ b/superset/views/database/validators.py
@@ -36,9 +36,9 @@ def sqlalchemy_uri_validator(
     except (ArgumentError, AttributeError):
         raise exception(
             _(
-                "Invalid connnection string, a valid string follows: "
-                " 'DRIVER://USER:PASSWORD@DB-HOST/DATABASE-NAME'"
-                " <p>Example:'postgresql://user:password@your-postgres-db/database'</p>"
+                "Invalid connection string, a valid string usually follows:"
+                "'DRIVER://USER:PASSWORD@DB-HOST/DATABASE-NAME'"
+                "<p>Example:'postgresql://user:password@your-postgres-db/database'</p>"
             )
         )
 
diff --git a/tests/core_tests.py b/tests/core_tests.py
index cf93d7a..c497feb 100644
--- a/tests/core_tests.py
+++ b/tests/core_tests.py
@@ -476,9 +476,7 @@ class CoreTests(SupersetTestCase):
         assert response.status_code == 400
         assert response.headers["Content-Type"] == "application/json"
         response_body = json.loads(response.data.decode("utf-8"))
-        expected_body = {
-            "error": "Connection failed!\n\nThe error message returned was:\nCan't load plugin: sqlalchemy.dialects:broken"
-        }
+        expected_body = {"error": "Could not load database driver: broken"}
         assert response_body == expected_body, "%s != %s" % (
             response_body,
             expected_body,