You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@superset.apache.org by "diegomedina248 (via GitHub)" <gi...@apache.org> on 2023/01/30 16:34:52 UTC
[GitHub] [superset] diegomedina248 opened a new pull request, #22910: chore: Migrate /superset/estimate_query_cost/// to API v1
diegomedina248 opened a new pull request, #22910:
URL: https://github.com/apache/superset/pull/22910
### SUMMARY
Continuing the effort on deprecating all /superset/ REST API endpoints
Deprecates `/superset/estimate_query_cost` for `/api/v1/sqllab/estimate/`
### BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
<!--- Skip this if not applicable -->
### TESTING INSTRUCTIONS
<!--- Required! What steps can be taken to manually verify the changes? -->
### ADDITIONAL INFORMATION
<!--- Check any relevant boxes with "x" -->
<!--- HINT: Include "Fixes #nnn" if you are fixing an existing issue -->
- [ ] Has associated issue:
- [ ] Required feature flags:
- [ ] Changes UI
- [ ] Includes DB Migration (follow approval process in [SIP-59](https://github.com/apache/superset/issues/13351))
- [ ] Migration is atomic, supports rollback & is backwards-compatible
- [ ] Confirm DB migration upgrade and downgrade tested
- [ ] Runtime estimates and downtime expectations provided
- [ ] Introduces new feature or API
- [ ] Removes existing feature or API
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] diegomedina248 commented on pull request #22910: chore: Migrate /superset/estimate_query_cost/// to API v1
Posted by "diegomedina248 (via GitHub)" <gi...@apache.org>.
diegomedina248 commented on PR #22910:
URL: https://github.com/apache/superset/pull/22910#issuecomment-1420060094
@dpgaspar the remaining comments here I believe will be addressed by you as a follow up right?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] hughhhh closed pull request #22910: chore: Migrate /superset/estimate_query_cost/// to API v1
Posted by "hughhhh (via GitHub)" <gi...@apache.org>.
hughhhh closed pull request #22910: chore: Migrate /superset/estimate_query_cost/<database_id>/<schema>/ to API v1
URL: https://github.com/apache/superset/pull/22910
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] codecov[bot] commented on pull request #22910: chore: Migrate /superset/estimate_query_cost/// to API v1
Posted by codecov.
codecov[bot] commented on PR #22910:
URL: https://github.com/apache/superset/pull/22910#issuecomment-1409041175
# [Codecov](https://codecov.io/gh/apache/superset/pull/22910?src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) Report
> Merging [#22910](https://codecov.io/gh/apache/superset/pull/22910?src=pr&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) (5e6e356) into [master](https://codecov.io/gh/apache/superset/commit/c839d0daf50af4e974572b3a261eae5582951bbd?el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) (c839d0d) will **increase** coverage by `0.06%`.
> The diff coverage is `97.36%`.
> :exclamation: Current head 5e6e356 differs from pull request most recent head a4ec247. Consider uploading reports for the commit a4ec247 to get more accurate results
```diff
@@ Coverage Diff @@
## master #22910 +/- ##
==========================================
+ Coverage 65.81% 65.88% +0.06%
==========================================
Files 1876 1877 +1
Lines 72086 72144 +58
Branches 7872 7869 -3
==========================================
+ Hits 47447 47533 +86
+ Misses 22619 22593 -26
+ Partials 2020 2018 -2
```
| Flag | Coverage Δ | |
|---|---|---|
| mysql | `?` | |
| postgres | `78.80% <100.00%> (+0.04%)` | :arrow_up: |
| presto | `52.62% <56.75%> (?)` | |
| python | `78.96% <100.00%> (+0.11%)` | :arrow_up: |
| sqlite | `?` | |
Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#carryforward-flags-in-the-pull-request-comment) to find out more.
| [Impacted Files](https://codecov.io/gh/apache/superset/pull/22910?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) | Coverage Δ | |
|---|---|---|
| [superset-frontend/src/SqlLab/actions/sqlLab.js](https://codecov.io/gh/apache/superset/pull/22910?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-c3VwZXJzZXQtZnJvbnRlbmQvc3JjL1NxbExhYi9hY3Rpb25zL3NxbExhYi5qcw==) | `63.65% <0.00%> (+0.16%)` | :arrow_up: |
| [superset-frontend/src/SqlLab/reducers/sqlLab.js](https://codecov.io/gh/apache/superset/pull/22910?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-c3VwZXJzZXQtZnJvbnRlbmQvc3JjL1NxbExhYi9yZWR1Y2Vycy9zcWxMYWIuanM=) | `36.87% <ø> (ø)` | |
| [superset/constants.py](https://codecov.io/gh/apache/superset/pull/22910?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-c3VwZXJzZXQvY29uc3RhbnRzLnB5) | `100.00% <ø> (ø)` | |
| [superset/sqllab/api.py](https://codecov.io/gh/apache/superset/pull/22910?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-c3VwZXJzZXQvc3FsbGFiL2FwaS5weQ==) | `100.00% <100.00%> (ø)` | |
| [superset/sqllab/commands/estimate.py](https://codecov.io/gh/apache/superset/pull/22910?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-c3VwZXJzZXQvc3FsbGFiL2NvbW1hbmRzL2VzdGltYXRlLnB5) | `100.00% <100.00%> (ø)` | |
| [superset/sqllab/schemas.py](https://codecov.io/gh/apache/superset/pull/22910?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-c3VwZXJzZXQvc3FsbGFiL3NjaGVtYXMucHk=) | `100.00% <100.00%> (ø)` | |
| [superset/views/core.py](https://codecov.io/gh/apache/superset/pull/22910?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-c3VwZXJzZXQvdmlld3MvY29yZS5weQ==) | `74.41% <100.00%> (-0.21%)` | :arrow_down: |
| [superset/db\_engine\_specs/sqlite.py](https://codecov.io/gh/apache/superset/pull/22910?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-c3VwZXJzZXQvZGJfZW5naW5lX3NwZWNzL3NxbGl0ZS5weQ==) | `75.00% <0.00%> (-17.86%)` | :arrow_down: |
| [.../src/utils/getChartRequiredFieldsMissingMessage.ts](https://codecov.io/gh/apache/superset/pull/22910?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-c3VwZXJzZXQtZnJvbnRlbmQvc3JjL3V0aWxzL2dldENoYXJ0UmVxdWlyZWRGaWVsZHNNaXNzaW5nTWVzc2FnZS50cw==) | `66.66% <0.00%> (-13.34%)` | :arrow_down: |
| [superset/common/utils/dataframe\_utils.py](https://codecov.io/gh/apache/superset/pull/22910?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-c3VwZXJzZXQvY29tbW9uL3V0aWxzL2RhdGFmcmFtZV91dGlscy5weQ==) | `80.95% <0.00%> (-4.77%)` | :arrow_down: |
| ... and [33 more](https://codecov.io/gh/apache/superset/pull/22910?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) | |
:mega: We’re building smart automated test selection to slash your CI/CD build times. [Learn more](https://about.codecov.io/iterative-testing/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] dpgaspar commented on a diff in pull request #22910: chore: Migrate /superset/estimate_query_cost/// to API v1
Posted by "dpgaspar (via GitHub)" <gi...@apache.org>.
dpgaspar commented on code in PR #22910:
URL: https://github.com/apache/superset/pull/22910#discussion_r1091648584
##########
superset/sqllab/commands/estimate.py:
##########
@@ -0,0 +1,106 @@
+# 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.
+# pylint: disable=too-few-public-methods, too-many-arguments
+from __future__ import annotations
+
+import logging
+from typing import Any, Dict, List
+
+from flask_babel import gettext as __, lazy_gettext as _
+
+from superset import app, db
+from superset.commands.base import BaseCommand
+from superset.errors import ErrorLevel, SupersetError, SupersetErrorType
+from superset.exceptions import SupersetErrorException, SupersetTimeoutException
+from superset.jinja_context import get_template_processor
+from superset.models.core import Database
+from superset.sqllab.schemas import EstimateQueryCostSchema
+from superset.utils import core as utils
+
+config = app.config
+SQLLAB_QUERY_COST_ESTIMATE_TIMEOUT = config["SQLLAB_QUERY_COST_ESTIMATE_TIMEOUT"]
+stats_logger = config["STATS_LOGGER"]
+
+logger = logging.getLogger(__name__)
+
+
+class QueryEstimationCommand(BaseCommand):
+ _database_id: int
+ _sql: str
+ _template_params: Dict[str, Any]
+ _schema: str
+ _database: Database
+
+ def __init__(self, params: EstimateQueryCostSchema) -> None:
+ self._database_id = params.get("database_id")
+ self._sql = params.get("sql", "")
+ self._template_params = params.get("template_params", {})
+ self._schema = params.get("schema", "")
+
+ def validate(self) -> None:
+ self._database = db.session.query(Database).get(self._database_id)
Review Comment:
this should go to the DAO to get all possible security constraints applied to it
##########
superset/sqllab/commands/estimate.py:
##########
@@ -0,0 +1,106 @@
+# 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.
+# pylint: disable=too-few-public-methods, too-many-arguments
+from __future__ import annotations
+
+import logging
+from typing import Any, Dict, List
+
+from flask_babel import gettext as __, lazy_gettext as _
+
+from superset import app, db
+from superset.commands.base import BaseCommand
+from superset.errors import ErrorLevel, SupersetError, SupersetErrorType
+from superset.exceptions import SupersetErrorException, SupersetTimeoutException
+from superset.jinja_context import get_template_processor
+from superset.models.core import Database
+from superset.sqllab.schemas import EstimateQueryCostSchema
+from superset.utils import core as utils
+
+config = app.config
+SQLLAB_QUERY_COST_ESTIMATE_TIMEOUT = config["SQLLAB_QUERY_COST_ESTIMATE_TIMEOUT"]
+stats_logger = config["STATS_LOGGER"]
+
+logger = logging.getLogger(__name__)
+
+
+class QueryEstimationCommand(BaseCommand):
+ _database_id: int
+ _sql: str
+ _template_params: Dict[str, Any]
+ _schema: str
+ _database: Database
+
+ def __init__(self, params: EstimateQueryCostSchema) -> None:
Review Comment:
user should be passed in, because there are some security constraints that should be applied
##########
superset/sqllab/api.py:
##########
@@ -68,17 +70,71 @@ class SqlLabRestApi(BaseSupersetApi):
class_permission_name = "Query"
+ estimate_model_schema = EstimateQueryCostSchema()
execute_model_schema = ExecutePayloadSchema()
apispec_parameter_schemas = {
"sql_lab_get_results_schema": sql_lab_get_results_schema,
}
openapi_spec_tag = "SQL Lab"
openapi_spec_component_schemas = (
+ EstimateQueryCostSchema,
ExecutePayloadSchema,
QueryExecutionResponseSchema,
)
+ @expose("/estimate/", methods=["POST"])
Review Comment:
What do you think about placing this one on `/api/v1/database/` instead?
##########
tests/integration_tests/sql_lab/commands_tests.py:
##########
@@ -18,18 +18,88 @@
from unittest.mock import patch
import pytest
+from flask_babel import gettext as __
-from superset import db, sql_lab
+from superset import app, db, sql_lab
from superset.common.db_query_status import QueryStatus
-from superset.errors import SupersetErrorType
-from superset.exceptions import SerializationError, SupersetErrorException
+from superset.errors import ErrorLevel, SupersetErrorType
+from superset.exceptions import (
+ SerializationError,
+ SupersetErrorException,
+ SupersetTimeoutException,
+)
from superset.models.core import Database
from superset.models.sql_lab import Query
-from superset.sqllab.commands import results
+from superset.sqllab.commands import estimate, results
from superset.utils import core as utils
from tests.integration_tests.base_tests import SupersetTestCase
+class TestQueryEstimationCommand(SupersetTestCase):
+ def test_validation_no_database(self) -> None:
+ params = {"database_id": 1, "sql": "SELECT 1"}
+ command = estimate.QueryEstimationCommand(params)
+
+ with mock.patch("superset.sqllab.commands.estimate.db") as mock_superset_db:
+ mock_superset_db.session.query().get.return_value = None
+ with pytest.raises(SupersetErrorException) as ex_info:
+ command.validate()
+ assert (
+ ex_info.value.error.error_type
+ == SupersetErrorType.RESULTS_BACKEND_ERROR
+ )
+
+ @patch("superset.tasks.scheduler.is_feature_enabled")
+ def test_run_timeout(self, is_feature_enabled) -> None:
+ params = {"database_id": 1, "sql": "SELECT 1", "template_params": {"temp": 123}}
+ command = estimate.QueryEstimationCommand(params)
+
+ db_mock = mock.Mock()
+ db_mock.db_engine_spec = mock.Mock()
+ db_mock.db_engine_spec.estimate_query_cost = mock.Mock(
+ side_effect=SupersetTimeoutException(
+ error_type=SupersetErrorType.CONNECTION_DATABASE_TIMEOUT,
+ message=(
+ "Please check your connection details and database settings, "
+ "and ensure that your database is accepting connections, "
+ "then try connecting again."
+ ),
+ level=ErrorLevel.ERROR,
+ )
+ )
+ db_mock.db_engine_spec.query_cost_formatter = mock.Mock(return_value=None)
+ is_feature_enabled.return_value = False
+
+ with mock.patch("superset.sqllab.commands.estimate.db") as mock_superset_db:
+ mock_superset_db.session.query().get.return_value = db_mock
+ with pytest.raises(SupersetErrorException) as ex_info:
+ command.run()
+ assert (
+ ex_info.value.error.error_type == SupersetErrorType.SQLLAB_TIMEOUT_ERROR
+ )
+ assert ex_info.value.error.message == __(
+ "The query estimation was killed after %(sqllab_timeout)s seconds. It might "
+ "be too complex, or the database might be under heavy load.",
+ sqllab_timeout=app.config["SQLLAB_QUERY_COST_ESTIMATE_TIMEOUT"],
+ )
+
+ def test_run_success(self) -> None:
Review Comment:
add some tests for users that don't have access to the database (missing database access on [some-db.id])
##########
superset/sqllab/schemas.py:
##########
@@ -25,6 +25,13 @@
}
+class EstimateQueryCostSchema(Schema):
+ database_id = fields.Integer(required=True)
+ sql = fields.String(required=True)
Review Comment:
let's add some nice descriptions here
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] diegomedina248 commented on a diff in pull request #22910: chore: Migrate /superset/estimate_query_cost/// to API v1
Posted by "diegomedina248 (via GitHub)" <gi...@apache.org>.
diegomedina248 commented on code in PR #22910:
URL: https://github.com/apache/superset/pull/22910#discussion_r1098098195
##########
superset/sqllab/api.py:
##########
@@ -68,17 +70,71 @@ class SqlLabRestApi(BaseSupersetApi):
class_permission_name = "Query"
+ estimate_model_schema = EstimateQueryCostSchema()
execute_model_schema = ExecutePayloadSchema()
apispec_parameter_schemas = {
"sql_lab_get_results_schema": sql_lab_get_results_schema,
}
openapi_spec_tag = "SQL Lab"
openapi_spec_component_schemas = (
+ EstimateQueryCostSchema,
ExecutePayloadSchema,
QueryExecutionResponseSchema,
)
+ @expose("/estimate/", methods=["POST"])
Review Comment:
It's a balancing act here, I agree.
I think the database resource is bloated already, and while I could see usages outside SQL lab, we don't at the moment nor in the medium term (afaik).
I could see arguments on both sides and I don't feel particularly strong about either of them
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org