refactor: sql lab command: separate concerns into different modules (a…

…pache#16917)

* chore move sql_execution_context to sqllab package

* add new helper methods into base Dao

* refactor separate get existing query concern from command

* refactor separate query access validation concern

* refactor separate get query's database concern from command

* refactor separate get query rendering concern from command

* refactor sqllab_execution_context

* refactor separate creating payload for view

* chore decouple command from superset app

* fix pylint issues

* fix failed tests

* fix pylint issues

* fix failed test

* fix failed black

* fix failed black

* fix failed test

superset/charts/dao.py

@@ -14,6 +14,7 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
+# pylint: disable=arguments-renamed
 import logging
 from typing import List, Optional, TYPE_CHECKING
 

superset/dao/base.py

@@ -14,6 +14,7 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
+# pylint: disable=isinstance-second-argument-not-valid-type
 from typing import Any, Dict, List, Optional, Type
 
 from flask_appbuilder.models.filters import BaseFilter
@@ -89,6 +90,19 @@ def find_all(cls) -> List[Model]:
             ).apply(query, None)
         return query.all()
 
+    @classmethod
+    def find_one_or_none(cls, **filter_by: Any) -> Optional[Model]:
+        """
+        Get the first that fit the `base_filter`
+        """
+        query = db.session.query(cls.model_cls)
+        if cls.base_filter:
+            data_model = SQLAInterface(cls.model_cls, db.session)
+            query = cls.base_filter(  # pylint: disable=not-callable
+                "id", data_model
+            ).apply(query, None)
+        return query.filter_by(**filter_by).one_or_none()
+
     @classmethod
     def create(cls, properties: Dict[str, Any], commit: bool = True) -> Model:
         """
@@ -109,6 +123,27 @@ def create(cls, properties: Dict[str, Any], commit: bool = True) -> Model:
             raise DAOCreateFailedError(exception=ex) from ex
         return model
 
+    @classmethod
+    def save(cls, instance_model: Model, commit: bool = True) -> Model:
+        """
+        Generic for saving models
+        :raises: DAOCreateFailedError
+        """
+        if cls.model_cls is None:
+            raise DAOConfigError()
+        if not isinstance(instance_model, cls.model_cls):
+            raise DAOCreateFailedError(
+                "the instance model is not a type of the model class"
+            )
+        try:
+            db.session.add(instance_model)
+            if commit:
+                db.session.commit()
+        except SQLAlchemyError as ex:  # pragma: no cover
+            db.session.rollback()
+            raise DAOCreateFailedError(exception=ex) from ex
+        return instance_model
+
     @classmethod
     def update(
         cls, model: Model, properties: Dict[str, Any], commit: bool = True

superset/datasets/dao.py

@@ -143,7 +143,7 @@ def validate_metrics_uniqueness(dataset_id: int, metrics_names: List[str]) -> bo
         return len(dataset_query) == 0
 
     @classmethod
-    def update(  # pylint: disable=arguments-differ
+    def update(
         cls, model: SqlaTable, properties: Dict[str, Any], commit: bool = True
     ) -> Optional[SqlaTable]:
         """

superset/models/core.py

@@ -14,6 +14,7 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
+# pylint: disable=line-too-long
 """A collection of ORM sqlalchemy models for Superset"""
 import enum
 import json
@@ -253,7 +254,7 @@ def parameters(self) -> Dict[str, Any]:
     @property
     def parameters_schema(self) -> Dict[str, Any]:
         try:
-            parameters_schema = self.db_engine_spec.parameters_json_schema()  # type: ignore # pylint: disable=line-too-long
+            parameters_schema = self.db_engine_spec.parameters_json_schema()  # type: ignore
         except Exception:  # pylint: disable=broad-except
             parameters_schema = {}
         return parameters_schema