fix: Ability to share saved queries

superset-frontend/src/SqlLab/actions/sqlLab.js

@@ -161,9 +161,8 @@ export function updateQueryEditor(alterations) {
 export function scheduleQuery(query) {
   return dispatch =>
     SupersetClient.post({
-      endpoint: '/savedqueryviewapi/api/create',
+      endpoint: '/api/v1/saved_query/',
       postPayload: query,
-      stringify: false,
     })
       .then(() =>
         dispatch(

superset-frontend/src/SqlLab/components/ShareSqlLabQuery/index.tsx

@@ -48,7 +48,7 @@ const ShareSqlLabQuery = ({
 }: ShareSqlLabQueryProps) => {
   const theme = useTheme();
 
-  const { dbId, name, schema, autorun, sql, remoteId, templateParams } =
+  const { dbId, name, schema, autorun, sql, remoteId, templateParams, uuid } =
     useQueryEditor(queryEditorId, [
       'dbId',
       'name',
@@ -57,6 +57,7 @@ const ShareSqlLabQuery = ({
       'sql',
       'remoteId',
       'templateParams',
+      'uuid',
     ]);
 
   const getCopyUrlForKvStore = (callback: Function) => {
@@ -76,10 +77,10 @@ const ShareSqlLabQuery = ({
   const getCopyUrlForSavedQuery = (callback: Function) => {
     let savedQueryToastContent;
 
-    if (remoteId) {
+    if (uuid) {
       savedQueryToastContent = `${
         window.location.origin + window.location.pathname
-      }?savedQueryId=${remoteId}`;
+      }?savedQueryId=${uuid}`;
       callback(savedQueryToastContent);
     } else {
       savedQueryToastContent = t('Please save the query to enable sharing');

superset-frontend/src/SqlLab/fixtures.ts

@@ -187,6 +187,7 @@ export const defaultQueryEditor = {
   remoteId: null,
   hideLeftBar: false,
   templateParams: '{}',
+  uuid: '8a7f4812-fa3a-4cf8-86f3-67a55fcc9102',
 };
 
 export const extraQueryEditor1 = {

superset-frontend/src/SqlLab/types.ts

@@ -49,6 +49,7 @@ export interface QueryEditor {
   selectedText?: string;
   queryLimit?: number;
   description?: string;
+  uuid: string | null;
 }
 
 export type toastState = {

superset-frontend/src/pages/SavedQueryList/index.tsx

@@ -216,10 +216,10 @@ function SavedQueryList({
   };
 
   const copyQueryLink = useCallback(
-    (id: number) => {
+    (uuid: string) => {
       copyTextToClipboard(() =>
         Promise.resolve(
-          `${window.location.origin}/superset/sqllab?savedQueryId=${id}`,
+          `${window.location.origin}/superset/sqllab?savedQueryId=${uuid}`,
         ),
       )
         .then(() => {
@@ -390,7 +390,7 @@ function SavedQueryList({
             handleSavedQueryPreview(original.id);
           };
           const handleEdit = () => openInSqlLab(original.id);
-          const handleCopy = () => copyQueryLink(original.id);
+          const handleCopy = () => copyQueryLink(original.uuid);
           const handleExport = () => handleBulkSavedQueryExport([original]);
           const handleDelete = () => setQueryCurrentlyDeleting(original);
 

superset/dashboards/dao.py

@@ -26,12 +26,12 @@
 from superset import security_manager
 from superset.dao.base import BaseDAO
 from superset.dashboards.commands.exceptions import DashboardNotFoundError
-from superset.dashboards.filters import DashboardAccessFilter, is_uuid
+from superset.dashboards.filters import DashboardAccessFilter
 from superset.extensions import db
 from superset.models.core import FavStar, FavStarClassName
 from superset.models.dashboard import Dashboard, id_or_slug_filter
 from superset.models.slice import Slice
-from superset.utils.core import get_user_id
+from superset.utils.core import get_user_id, is_uuid
 from superset.utils.dashboard_filter_scopes_converter import copy_filter_scopes
 
 logger = logging.getLogger(__name__)

superset/dashboards/filters.py

@@ -25,11 +25,11 @@
 from superset import db, is_feature_enabled, security_manager
 from superset.connectors.sqla.models import SqlaTable
 from superset.models.core import Database, FavStar
-from superset.models.dashboard import Dashboard, is_uuid
+from superset.models.dashboard import Dashboard
 from superset.models.embedded_dashboard import EmbeddedDashboard
 from superset.models.slice import Slice
 from superset.security.guest_token import GuestTokenResourceType, GuestUser
-from superset.utils.core import get_user_id
+from superset.utils.core import get_user_id, is_uuid
 from superset.utils.filters import get_dataset_access_filters
 from superset.views.base import BaseFilter
 from superset.views.base_api import BaseFavoriteFilter, BaseTagFilter

superset/models/dashboard.py

@@ -60,7 +60,7 @@
 from superset.tasks.utils import get_current_user
 from superset.thumbnails.digest import get_dashboard_digest
 from superset.utils import core as utils
-from superset.utils.core import get_user_id
+from superset.utils.core import get_user_id, is_uuid
 from superset.utils.decorators import debounce
 
 metadata = Model.metadata  # pylint: disable=no-member
@@ -452,14 +452,6 @@ def get(cls, id_or_slug: str | int) -> Dashboard:
         return qry.one_or_none()
 
 
-def is_uuid(value: str | int) -> bool:
-    try:
-        uuid.UUID(str(value))
-        return True
-    except ValueError:
-        return False
-
-
 def is_int(value: str | int) -> bool:
     try:
         int(value)

superset/models/sql_lab.py

@@ -410,7 +410,7 @@ def to_dict(self) -> dict[str, Any]:
     def pop_tab_link(self) -> Markup:
         return Markup(
             f"""
-            <a href="/superset/sqllab?savedQueryId={self.id}">
+            <a href="/superset/sqllab?savedQueryId={self.uuid}">
                 <i class="fa fa-link"></i>
             </a>
         """
@@ -425,7 +425,7 @@ def sqlalchemy_uri(self) -> URL:
         return self.database.sqlalchemy_uri
 
     def url(self) -> str:
-        return f"/superset/sqllab?savedQueryId={self.id}"
+        return f"/superset/sqllab?savedQueryId={self.uuid}"
 
     @property
     def sql_tables(self) -> list[Table]:

superset/queries/saved_queries/api.py

@@ -22,7 +22,7 @@
 from zipfile import is_zipfile, ZipFile
 
 from flask import g, request, Response, send_file
-from flask_appbuilder.api import expose, protect, rison, safe
+from flask_appbuilder.api import expose, permission_name, protect, rison, safe
 from flask_appbuilder.models.sqla.interface import SQLAInterface
 from flask_babel import ngettext
 
@@ -47,6 +47,7 @@
 from superset.queries.saved_queries.commands.importers.dispatcher import (
     ImportSavedQueriesCommand,
 )
+from superset.queries.saved_queries.dao import SavedQueryDAO
 from superset.queries.saved_queries.filters import (
     SavedQueryAllTextFilter,
     SavedQueryFavoriteFilter,
@@ -57,6 +58,7 @@
     get_delete_ids_schema,
     get_export_ids_schema,
     openapi_spec_methods_override,
+    SavedQueryGetSchema,
 )
 from superset.views.base_api import (
     BaseSupersetModelRestApi,
@@ -99,6 +101,7 @@ class SavedQueryRestApi(BaseSupersetModelRestApi):
         "sql",
         "sql_tables",
         "template_parameters",
+        "uuid",
     ]
     list_columns = [
         "changed_on_delta_humanized",
@@ -118,6 +121,7 @@ class SavedQueryRestApi(BaseSupersetModelRestApi):
         "schema",
         "sql",
         "sql_tables",
+        "uuid",
     ]
     if is_feature_enabled("TAGGING_SYSTEM"):
         list_columns += ["tags.id", "tags.name", "tags.type"]
@@ -129,6 +133,7 @@ class SavedQueryRestApi(BaseSupersetModelRestApi):
         "schema",
         "sql",
         "template_parameters",
+        "extra_json",
     ]
     edit_columns = add_columns
     order_columns = [
@@ -158,9 +163,12 @@ class SavedQueryRestApi(BaseSupersetModelRestApi):
         "get_delete_ids_schema": get_delete_ids_schema,
         "get_export_ids_schema": get_export_ids_schema,
     }
+    openapi_spec_component_schemas = (SavedQueryGetSchema,)
     openapi_spec_tag = "Queries"
     openapi_spec_methods = openapi_spec_methods_override
 
+    saved_query_get_schema = SavedQueryGetSchema()
+
     related_field_filters = {
         "database": "database_name",
     }
@@ -174,6 +182,53 @@ def pre_add(self, item: SavedQuery) -> None:
     def pre_update(self, item: SavedQuery) -> None:
         self.pre_add(item)
 
+    # pylint: disable=arguments-renamed
+    @expose("/<id_>", methods=("GET",))
+    @protect()
+    @safe
+    @permission_name("get")
+    @statsd_metrics
+    @event_logger.log_this_with_context(
+        action=lambda self, *args, **kwargs: f"{self.__class__.__name__}.get",
+        log_to_statsd=False,
+    )
+    def get(self, id_: str, **kwargs: Any) -> Response:
+        """Get a saved query by id or uuid
+        ---
+        get:
+          summary: >-
+            Gets a saved query
+          description: >-
+            Users who did not create a saved query can only discover it via UUID
+          parameters:
+          - in: path
+            name: id_
+            schema:
+              type: string
+            description: ID or UUID of the saved query
+          responses:
+            200:
+              description: Saved query
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      result:
+                        $ref: '#/components/schemas/SavedQueryGetSchema'
+            401:
+              $ref: '#/components/responses/401'
+            404:
+              $ref: '#/components/responses/404'
+            500:
+              $ref: '#/components/responses/500'
+        """
+        saved_query = SavedQueryDAO.get_by_id(id_)
+        if not saved_query:
+            return self.response_404()
+        result = self.saved_query_get_schema.dump(saved_query)
+        return self.response(200, result=result)
+
     @expose("/", methods=("DELETE",))
     @protect()
     @safe

superset/queries/saved_queries/dao.py

@@ -15,15 +15,18 @@
 # specific language governing permissions and limitations
 # under the License.
 import logging
+import uuid
 from typing import Optional
 
+from flask_appbuilder.models.sqla.interface import SQLAInterface
 from sqlalchemy.exc import SQLAlchemyError
 
 from superset.dao.base import BaseDAO
 from superset.dao.exceptions import DAODeleteFailedError
 from superset.extensions import db
 from superset.models.sql_lab import SavedQuery
 from superset.queries.saved_queries.filters import SavedQueryFilter
+from superset.utils.core import is_uuid
 
 logger = logging.getLogger(__name__)
 
@@ -44,3 +47,20 @@ def bulk_delete(models: Optional[list[SavedQuery]], commit: bool = True) -> None
         except SQLAlchemyError as ex:
             db.session.rollback()
             raise DAODeleteFailedError() from ex
+
+    @classmethod
+    def get_by_id(cls, id_: str) -> Optional[SavedQuery]:
+        if is_uuid(id_):
+            return (
+                db.session.query(SavedQuery)
+                .filter(SavedQuery.uuid == uuid.UUID(id_))
+                .scalar()
+            )
+        try:
+            query = db.session.query(SavedQuery).filter(SavedQuery.id == int(id_))
+        except ValueError:  # Invalid id
+            return None
+        query = cls.base_filter("id", SQLAInterface(SavedQuery, db.session)).apply(
+            query, None
+        )
+        return query.scalar()

superset/queries/saved_queries/schemas.py

@@ -14,9 +14,13 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-from marshmallow import fields, Schema
+from typing import Any
+
+from marshmallow import fields, post_dump, Schema
 from marshmallow.validate import Length
 
+from superset.models.sql_lab import SavedQuery
+
 openapi_spec_methods_override = {
     "get": {
         "get": {
@@ -48,3 +52,46 @@ class ImportV1SavedQuerySchema(Schema):
     uuid = fields.UUID(required=True)
     version = fields.String(required=True)
     database_uuid = fields.UUID(required=True)
+
+
+class SavedQueryCreatorSchema(Schema):
+    id = fields.Integer(metadata={"description": "Creator's ID"})
+    first_name = fields.String(metadata={"description": "Creator's first name"})
+    last_name = fields.String(metadata={"description": "Creator's last name"})
+
+
+class SavedQueryDatabaseSchema(Schema):
+    database_name = fields.String(metadata={"description": "Database's name"})
+    id = fields.Integer(metadata={"description": "Database's ID"})
+
+
+class SavedQuerySqlTableSchema(Schema):
+    table = fields.String()
+    schema = fields.String()
+    catalog = fields.String()
+
+
+class SavedQueryGetSchema(Schema):
+    changed_on_delta_humanized = fields.String(
+        metadata={"description": "How long ago the query was changed"}
+    )
+    created_by = fields.Nested(SavedQueryCreatorSchema)
+    database = fields.Nested(SavedQueryDatabaseSchema)
+    description = fields.String(metadata={"description": "Query's description"})
+    id = fields.Integer(metadata={"description": "Query's ID"})
+    label = fields.String(metadata={"description": "Query's label"})
+    schema = fields.String(metadata={"description": "Query's schema"})
+    sql = fields.String(metadata={"description": "Query's SQL"})
+    sql_tables = fields.List(
+        fields.Nested(SavedQuerySqlTableSchema),
+        metadata={"description": "Tables accessed by query SQL"},
+    )
+    uuid = fields.UUID(metadata={"description": "Query's UUID"})
+
+    # pylint: disable=no-self-use, unused-argument
+    @post_dump(pass_original=True)
+    def post_dump(
+        self, serialized: dict[str, Any], saved_query: SavedQuery, **kwargs: Any
+    ) -> dict[str, Any]:
+        serialized["changed_on_delta_humanized"] = saved_query.changed_on_humanized
+        return serialized

superset/utils/core.py

@@ -1974,3 +1974,11 @@ def remove_extra_adhoc_filters(form_data: dict[str, Any]) -> None:
         form_data[key] = [
             filter_ for filter_ in value or [] if not filter_.get("isExtra")
         ]
+
+
+def is_uuid(value: str | int) -> bool:
+    try:
+        uuid.UUID(str(value))
+        return True
+    except ValueError:
+        return False