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

superset/explore/permalink/commands/__init__.py

@@ -0,0 +1,16 @@
+# 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.

superset/explore/permalink/commands/base.py

@@ -0,0 +1,23 @@
+# 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 abc import ABC
+
+from superset.commands.base import BaseCommand
+
+
+class BaseExplorePermalinkCommand(BaseCommand, ABC):
+    resource = "explore_permalink"

superset/explore/permalink/commands/create.py

@@ -0,0 +1,60 @@
+# 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.
+import logging
+from typing import Any, Dict, Optional
+
+from flask_appbuilder.security.sqla.models import User
+from sqlalchemy.exc import SQLAlchemyError
+
+from superset.explore.permalink.commands.base import BaseExplorePermalinkCommand
+from superset.explore.permalink.exceptions import ExplorePermalinkCreateFailedError
+from superset.explore.utils import check_access
+from superset.key_value.commands.create import CreateKeyValueCommand
+from superset.key_value.types import KeyType
+
+logger = logging.getLogger(__name__)
+
+
+class CreateExplorePermalinkCommand(BaseExplorePermalinkCommand):
+    def __init__(self, actor: User, state: Dict[str, Any], key_type: KeyType):
+        self.actor = actor
+        self.chart_id: Optional[int] = state["formData"].get("slice_id")
+        self.datasource: str = state["formData"]["datasource"]
+        self.state = state
+        self.key_type = key_type
+
+    def run(self) -> str:
+        self.validate()
+        try:
+            dataset_id = int(self.datasource.split("__")[0])
+            check_access(dataset_id, self.chart_id, self.actor)
+            value = {
+                "chartId": self.chart_id,
+                "datasetId": dataset_id,
+                "datasource": self.datasource,
+                "state": self.state,
+            }
+            command = CreateKeyValueCommand(
+                self.actor, self.resource, value, self.key_type
+            )
+            return command.run()
+        except SQLAlchemyError as ex:
+            logger.exception("Error running create command")
+            raise ExplorePermalinkCreateFailedError() from ex
+
+    def validate(self) -> None:
+        pass

superset/explore/permalink/commands/get.py

@@ -0,0 +1,66 @@
+# 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.
+import logging
+from typing import Optional
+
+from flask_appbuilder.security.sqla.models import User
+from sqlalchemy.exc import SQLAlchemyError
+
+from superset.datasets.commands.exceptions import DatasetNotFoundError
+from superset.explore.permalink.commands.base import BaseExplorePermalinkCommand
+from superset.explore.permalink.exceptions import ExplorePermalinkGetFailedError
+from superset.explore.permalink.types import ExplorePermalinkValue
+from superset.explore.utils import check_access
+from superset.key_value.commands.get import GetKeyValueCommand
+from superset.key_value.exceptions import KeyValueGetFailedError, KeyValueParseKeyError
+from superset.key_value.types import KeyType
+
+logger = logging.getLogger(__name__)
+
+
+class GetExplorePermalinkCommand(BaseExplorePermalinkCommand):
+    def __init__(
+        self, actor: User, key: str, key_type: KeyType,
+    ):
+        self.actor = actor
+        self.key = key
+        self.key_type = key_type
+
+    def run(self) -> Optional[ExplorePermalinkValue]:
+        self.validate()
+        try:
+            value: Optional[ExplorePermalinkValue] = GetKeyValueCommand(
+                self.resource, self.key, key_type=self.key_type
+            ).run()
+            if value:
+                chart_id: Optional[int] = value.get("chartId")
+                dataset_id = value["datasetId"]
+                check_access(dataset_id, chart_id, self.actor)
+                return value
+            return None
+        except (
+            DatasetNotFoundError,
+            KeyValueGetFailedError,
+            KeyValueParseKeyError,
+        ) as ex:
+            raise ExplorePermalinkGetFailedError(message=ex.message) from ex
+        except SQLAlchemyError as ex:
+            logger.exception("Error running get command")
+            raise ExplorePermalinkGetFailedError() from ex
+
+    def validate(self) -> None:
+        pass