ktmud commented on a change in pull request #19078: URL: https://github.com/apache/superset/pull/19078#discussion_r828558897
########## File path: superset/dashboards/permalink/api.py ########## @@ -0,0 +1,171 @@ +# 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 flask import current_app, g, request, Response +from flask_appbuilder.api import BaseApi, expose, protect, safe +from marshmallow import ValidationError + +from superset.constants import MODEL_API_RW_METHOD_PERMISSION_MAP, RouteMethod +from superset.dashboards.commands.exceptions import ( + DashboardAccessDeniedError, + DashboardNotFoundError, +) +from superset.dashboards.permalink.commands.create import ( + CreateDashboardPermalinkCommand, +) +from superset.dashboards.permalink.commands.get import GetDashboardPermalinkCommand +from superset.dashboards.permalink.exceptions import DashboardPermalinkInvalidStateError +from superset.dashboards.permalink.schemas import DashboardPermalinkPostSchema +from superset.extensions import event_logger +from superset.key_value.exceptions import KeyValueAccessDeniedError +from superset.views.base_api import requires_json + +logger = logging.getLogger(__name__) + + +class DashboardPermalinkRestApi(BaseApi): + add_model_schema = DashboardPermalinkPostSchema() + method_permission_name = MODEL_API_RW_METHOD_PERMISSION_MAP + include_route_methods = { + RouteMethod.POST, + RouteMethod.PUT, + RouteMethod.GET, + RouteMethod.DELETE, + } + allow_browser_login = True + class_permission_name = "DashboardPermalinkRestApi" + resource_name = "dashboard" + openapi_spec_tag = "Dashboard Permanent Link" + openapi_spec_component_schemas = (DashboardPermalinkPostSchema,) + + @expose("/<pk>/permalink", methods=["POST"]) + @protect() + @safe + @event_logger.log_this_with_context( + action=lambda self, *args, **kwargs: f"{self.__class__.__name__}.post", + log_to_statsd=False, + ) + @requires_json + def post(self, pk: str) -> Response: + """Stores a new permanent link. + --- + post: + description: >- + Stores a new permanent link. + parameters: + - in: path + schema: + type: string + name: pk + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DashboardPermalinkPostSchema' + responses: + 201: + description: The permanent link was stored successfully. + content: + application/json: + schema: + type: object + properties: + key: + type: string + description: The key to retrieve the permanent link data. + url: + type: string + description: permanent link. + 400: + $ref: '#/components/responses/400' + 401: + $ref: '#/components/responses/401' + 422: + $ref: '#/components/responses/422' + 500: + $ref: '#/components/responses/500' + """ + key_type = current_app.config["PERMALINK_KEY_TYPE"] Review comment: I don't think we should provide this option. Adding one more config options means more efforts to support it in the future. We should not have to provide more flexibility in the config file unless users request it. The numeric ids were deprecated based on arguments of security risks---if security risk with numeric ids is real, then it's real for everyone. If not, then we should just not worry about it and keep using numeric ids that users are used to. If URL readability was the concern for UUID, we should probably just change the keys from uuid (which only uses 16 hex characters) to case-sensitive [hashids](https://hashids.org/) used in real short-url services (e.g., bit.ly and t.co). Personally I think hashids might be a better end state. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: notifications-unsubscr...@superset.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: notifications-unsubscr...@superset.apache.org For additional commands, e-mail: notifications-h...@superset.apache.org
