74 lines
2.8 KiB
Python
74 lines
2.8 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.
|
|
import logging
|
|
|
|
from sqlalchemy.exc import SQLAlchemyError
|
|
|
|
from superset.commands.dashboard.permalink.base import BaseDashboardPermalinkCommand
|
|
from superset.commands.key_value.upsert import UpsertKeyValueCommand
|
|
from superset.daos.dashboard import DashboardDAO
|
|
from superset.dashboards.permalink.exceptions import DashboardPermalinkCreateFailedError
|
|
from superset.dashboards.permalink.types import DashboardPermalinkState
|
|
from superset.key_value.exceptions import KeyValueCodecEncodeException
|
|
from superset.key_value.utils import encode_permalink_key, get_deterministic_uuid
|
|
from superset.utils.core import get_user_id
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class CreateDashboardPermalinkCommand(BaseDashboardPermalinkCommand):
|
|
"""
|
|
Get or create a permalink key for the dashboard.
|
|
|
|
The same dashboard_id and state for the same user will return the
|
|
same permalink.
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
dashboard_id: str,
|
|
state: DashboardPermalinkState,
|
|
):
|
|
self.dashboard_id = dashboard_id
|
|
self.state = state
|
|
|
|
def run(self) -> str:
|
|
self.validate()
|
|
try:
|
|
dashboard = DashboardDAO.get_by_id_or_slug(self.dashboard_id)
|
|
value = {
|
|
"dashboardId": str(dashboard.uuid),
|
|
"state": self.state,
|
|
}
|
|
user_id = get_user_id()
|
|
key = UpsertKeyValueCommand(
|
|
resource=self.resource,
|
|
key=get_deterministic_uuid(self.salt, (user_id, value)),
|
|
value=value,
|
|
codec=self.codec,
|
|
).run()
|
|
assert key.id # for type checks
|
|
return encode_permalink_key(key=key.id, salt=self.salt)
|
|
except KeyValueCodecEncodeException as ex:
|
|
raise DashboardPermalinkCreateFailedError(str(ex)) from ex
|
|
except SQLAlchemyError as ex:
|
|
logger.exception("Error running create command")
|
|
raise DashboardPermalinkCreateFailedError() from ex
|
|
|
|
def validate(self) -> None:
|
|
pass
|