| # 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 request, Response |
| from flask_appbuilder import expose |
| from flask_appbuilder.api import BaseApi, safe |
| from flask_appbuilder.security.decorators import permission_name, protect |
| |
| from superset.extensions import async_query_manager, event_logger |
| from superset.utils.async_query_manager import AsyncQueryTokenException |
| |
| logger = logging.getLogger(__name__) |
| |
| |
| class AsyncEventsRestApi(BaseApi): |
| resource_name = "async_event" |
| allow_browser_login = True |
| include_route_methods = { |
| "events", |
| } |
| |
| @expose("/", methods=["GET"]) |
| @event_logger.log_this |
| @protect() |
| @safe |
| @permission_name("list") |
| def events(self) -> Response: |
| """ |
| Reads off of the Redis async events stream, using the user's JWT token and |
| optional query params for last event received. |
| --- |
| get: |
| description: >- |
| Reads off of the Redis events stream, using the user's JWT token and |
| optional query params for last event received. |
| parameters: |
| - in: query |
| name: last_id |
| description: Last ID received by the client |
| schema: |
| type: string |
| responses: |
| 200: |
| description: Async event results |
| content: |
| application/json: |
| schema: |
| type: object |
| properties: |
| result: |
| type: array |
| items: |
| type: object |
| properties: |
| id: |
| type: string |
| channel_id: |
| type: string |
| job_id: |
| type: string |
| user_id: |
| type: integer |
| status: |
| type: string |
| errors: |
| type: array |
| items: |
| type: object |
| result_url: |
| type: string |
| 401: |
| $ref: '#/components/responses/401' |
| 500: |
| $ref: '#/components/responses/500' |
| """ |
| try: |
| async_channel_id = async_query_manager.parse_jwt_from_request(request)[ |
| "channel" |
| ] |
| last_event_id = request.args.get("last_id") |
| events = async_query_manager.read_events(async_channel_id, last_event_id) |
| |
| except AsyncQueryTokenException: |
| return self.response_401() |
| |
| return self.response(200, result=events) |