Files
superset2/superset/key_value/utils.py
Ville Brofeldt b7a0559aaf 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
2022-03-17 01:15:52 +02:00

58 lines
2.0 KiB
Python

# 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 typing import Literal
from uuid import UUID
from flask import current_app
from superset.key_value.exceptions import KeyValueParseKeyError
from superset.key_value.models import KeyValueEntry
from superset.key_value.types import Key, KeyType, KeyValueFilter
def parse_permalink_key(key: str) -> Key:
key_type: Literal["id", "uuid"] = current_app.config["PERMALINK_KEY_TYPE"]
if key_type == "id":
return Key(id=int(key), uuid=None)
return Key(id=None, uuid=UUID(key))
def format_permalink_key(key: Key) -> str:
"""
return the string representation of the key
:param key: a key object with either a numerical or uuid key
:return: a formatted string
"""
return str(key.id if key.id is not None else key.uuid)
def extract_key(entry: KeyValueEntry, key_type: KeyType) -> str:
return str(entry.id if key_type == "id" else entry.uuid)
def get_filter(resource: str, key: str, key_type: KeyType) -> KeyValueFilter:
try:
filter_: KeyValueFilter = {"resource": resource}
if key_type == "uuid":
filter_["uuid"] = UUID(key)
else:
filter_["id"] = int(key)
return filter_
except ValueError as ex:
raise KeyValueParseKeyError() from ex