feat: add permalink to dashboard and explore (#19078)

* rename key_value to temporary_cache

* add migration

* create new key_value package

* add commands

* lots of new stuff

* fix schema reference

* remove redundant filter state from bootstrap data

* add missing license headers

* fix pylint

* fix dashboard permalink access

* use valid json mocks for filter state tests

* fix temporary cache tests

* add anchors to dashboard state

* lint

* fix util test

* fix url shortlink button tests

* remove legacy shortner

* remove unused imports

* fix js tests

* fix test

* add native filter state to anchor link

* add UPDATING.md section

* address comments

* address comments

* lint

* fix test

* add utils tests + other test stubs

* add key_value integration tests

* add filter box state to permalink state

* fully support persisting url parameters

* lint, add redirects and a few integration tests

* fix test + clean up trailing comma

* fix anchor bug

* change value to LargeBinary to support persisting binary values

* fix urlParams type and simplify urlencode

* lint

* add optional entry expiration

* fix incorrect chart id + add test

tests/unit_tests/explore/utils_test.py

@@ -30,8 +30,8 @@ from superset.datasets.commands.exceptions import (
 
 dataset_find_by_id = "superset.datasets.dao.DatasetDAO.find_by_id"
 chart_find_by_id = "superset.charts.dao.ChartDAO.find_by_id"
-is_user_admin = "superset.explore.form_data.utils.is_user_admin"
-is_owner = "superset.explore.form_data.utils.is_owner"
+is_user_admin = "superset.explore.utils.is_user_admin"
+is_owner = "superset.explore.utils.is_owner"
 can_access_datasource = (
     "superset.security.SupersetSecurityManager.can_access_datasource"
 )
@@ -39,7 +39,7 @@ can_access = "superset.security.SupersetSecurityManager.can_access"
 
 
 def test_unsaved_chart_no_dataset_id(app_context: AppContext) -> None:
-    from superset.explore.form_data.utils import check_access
+    from superset.explore.utils import check_access
 
     with raises(DatasetNotFoundError):
         check_access(dataset_id=0, chart_id=0, actor=User())
@@ -48,7 +48,7 @@ def test_unsaved_chart_no_dataset_id(app_context: AppContext) -> None:
 def test_unsaved_chart_unknown_dataset_id(
     mocker: MockFixture, app_context: AppContext
 ) -> None:
-    from superset.explore.form_data.utils import check_access
+    from superset.explore.utils import check_access
 
     with raises(DatasetNotFoundError):
         mocker.patch(dataset_find_by_id, return_value=None)
@@ -59,7 +59,7 @@ def test_unsaved_chart_unauthorized_dataset(
     mocker: MockFixture, app_context: AppContext
 ) -> None:
     from superset.connectors.sqla.models import SqlaTable
-    from superset.explore.form_data import utils
+    from superset.explore import utils
 
     with raises(DatasetAccessDeniedError):
         mocker.patch(dataset_find_by_id, return_value=SqlaTable())
@@ -71,7 +71,7 @@ def test_unsaved_chart_authorized_dataset(
     mocker: MockFixture, app_context: AppContext
 ) -> None:
     from superset.connectors.sqla.models import SqlaTable
-    from superset.explore.form_data.utils import check_access
+    from superset.explore.utils import check_access
 
     mocker.patch(dataset_find_by_id, return_value=SqlaTable())
     mocker.patch(can_access_datasource, return_value=True)
@@ -82,7 +82,7 @@ def test_saved_chart_unknown_chart_id(
     mocker: MockFixture, app_context: AppContext
 ) -> None:
     from superset.connectors.sqla.models import SqlaTable
-    from superset.explore.form_data.utils import check_access
+    from superset.explore.utils import check_access
 
     with raises(ChartNotFoundError):
         mocker.patch(dataset_find_by_id, return_value=SqlaTable())
@@ -95,7 +95,7 @@ def test_saved_chart_unauthorized_dataset(
     mocker: MockFixture, app_context: AppContext
 ) -> None:
     from superset.connectors.sqla.models import SqlaTable
-    from superset.explore.form_data import utils
+    from superset.explore import utils
 
     with raises(DatasetAccessDeniedError):
         mocker.patch(dataset_find_by_id, return_value=SqlaTable())
@@ -105,19 +105,19 @@ def test_saved_chart_unauthorized_dataset(
 
 def test_saved_chart_is_admin(mocker: MockFixture, app_context: AppContext) -> None:
     from superset.connectors.sqla.models import SqlaTable
-    from superset.explore.form_data.utils import check_access
+    from superset.explore.utils import check_access
     from superset.models.slice import Slice
 
     mocker.patch(dataset_find_by_id, return_value=SqlaTable())
     mocker.patch(can_access_datasource, return_value=True)
     mocker.patch(is_user_admin, return_value=True)
     mocker.patch(chart_find_by_id, return_value=Slice())
-    assert check_access(dataset_id=1, chart_id=1, actor=User()) == True
+    assert check_access(dataset_id=1, chart_id=1, actor=User()) is True
 
 
 def test_saved_chart_is_owner(mocker: MockFixture, app_context: AppContext) -> None:
     from superset.connectors.sqla.models import SqlaTable
-    from superset.explore.form_data.utils import check_access
+    from superset.explore.utils import check_access
     from superset.models.slice import Slice
 
     mocker.patch(dataset_find_by_id, return_value=SqlaTable())
@@ -130,7 +130,7 @@ def test_saved_chart_is_owner(mocker: MockFixture, app_context: AppContext) -> N
 
 def test_saved_chart_has_access(mocker: MockFixture, app_context: AppContext) -> None:
     from superset.connectors.sqla.models import SqlaTable
-    from superset.explore.form_data.utils import check_access
+    from superset.explore.utils import check_access
     from superset.models.slice import Slice
 
     mocker.patch(dataset_find_by_id, return_value=SqlaTable())
@@ -144,7 +144,7 @@ def test_saved_chart_has_access(mocker: MockFixture, app_context: AppContext) ->
 
 def test_saved_chart_no_access(mocker: MockFixture, app_context: AppContext) -> None:
     from superset.connectors.sqla.models import SqlaTable
-    from superset.explore.form_data.utils import check_access
+    from superset.explore.utils import check_access
     from superset.models.slice import Slice
 
     with raises(ChartAccessDeniedError):

tests/unit_tests/key_value/utils_test.py

@@ -0,0 +1,117 @@
+# 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.
+from __future__ import annotations
+
+import json
+from typing import TYPE_CHECKING
+from unittest.mock import patch
+from uuid import UUID
+
+if TYPE_CHECKING:
+    from superset.key_value.models import KeyValueEntry
+
+import pytest
+from flask.ctx import AppContext
+
+from superset.key_value.types import Key
+
+RESOURCE = "my-resource"
+UUID_KEY = "3e7a2ab8-bcaf-49b0-a5df-dfb432f291cc"
+ID_KEY = "123"
+
+
+@pytest.fixture
+def key_value_entry(app_context: AppContext):
+    from superset.key_value.models import KeyValueEntry
+
+    return KeyValueEntry(
+        id=int(ID_KEY), uuid=UUID(UUID_KEY), value=json.dumps({"foo": "bar"}),
+    )
+
+
+def test_parse_permalink_key_uuid_valid(app_context: AppContext) -> None:
+    from superset.key_value.utils import parse_permalink_key
+
+    assert parse_permalink_key(UUID_KEY) == Key(id=None, uuid=UUID(UUID_KEY))
+
+
+def test_parse_permalink_key_id_invalid(app_context: AppContext) -> None:
+    from superset.key_value.utils import parse_permalink_key
+
+    with pytest.raises(ValueError):
+        parse_permalink_key(ID_KEY)
+
+
+@patch("superset.key_value.utils.current_app.config", {"PERMALINK_KEY_TYPE": "id"})
+def test_parse_permalink_key_id_valid(app_context: AppContext) -> None:
+    from superset.key_value.utils import parse_permalink_key
+
+    assert parse_permalink_key(ID_KEY) == Key(id=int(ID_KEY), uuid=None)
+
+
+@patch("superset.key_value.utils.current_app.config", {"PERMALINK_KEY_TYPE": "id"})
+def test_parse_permalink_key_uuid_invalid(app_context: AppContext) -> None:
+    from superset.key_value.utils import parse_permalink_key
+
+    with pytest.raises(ValueError):
+        parse_permalink_key(UUID_KEY)
+
+
+def test_format_permalink_key_uuid(app_context: AppContext) -> None:
+    from superset.key_value.utils import format_permalink_key
+
+    assert format_permalink_key(Key(id=None, uuid=UUID(UUID_KEY))) == UUID_KEY
+
+
+def test_format_permalink_key_id(app_context: AppContext) -> None:
+    from superset.key_value.utils import format_permalink_key
+
+    assert format_permalink_key(Key(id=int(ID_KEY), uuid=None)) == ID_KEY
+
+
+def test_extract_key_uuid(
+    app_context: AppContext, key_value_entry: KeyValueEntry,
+) -> None:
+    from superset.key_value.utils import extract_key
+
+    assert extract_key(key_value_entry, "id") == ID_KEY
+
+
+def test_extract_key_id(
+    app_context: AppContext, key_value_entry: KeyValueEntry,
+) -> None:
+    from superset.key_value.utils import extract_key
+
+    assert extract_key(key_value_entry, "uuid") == UUID_KEY
+
+
+def test_get_filter_uuid(app_context: AppContext,) -> None:
+    from superset.key_value.utils import get_filter
+
+    assert get_filter(resource=RESOURCE, key=UUID_KEY, key_type="uuid",) == {
+        "resource": RESOURCE,
+        "uuid": UUID(UUID_KEY),
+    }
+
+
+def test_get_filter_id(app_context: AppContext,) -> None:
+    from superset.key_value.utils import get_filter
+
+    assert get_filter(resource=RESOURCE, key=ID_KEY, key_type="id",) == {
+        "resource": RESOURCE,
+        "id": int(ID_KEY),
+    }