mirror of
https://github.com/apache/superset.git
synced 2026-04-07 18:35:15 +00:00
233 lines
8.6 KiB
Python
233 lines
8.6 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 __future__ import annotations
|
|
|
|
import logging
|
|
from enum import Enum
|
|
from time import sleep
|
|
from typing import Any, Dict, List, Optional, Tuple, TYPE_CHECKING
|
|
|
|
from flask import current_app
|
|
from selenium.common.exceptions import (
|
|
StaleElementReferenceException,
|
|
TimeoutException,
|
|
WebDriverException,
|
|
)
|
|
from selenium.webdriver import chrome, firefox, FirefoxProfile
|
|
from selenium.webdriver.common.by import By
|
|
from selenium.webdriver.remote.webdriver import WebDriver
|
|
from selenium.webdriver.support import expected_conditions as EC
|
|
from selenium.webdriver.support.ui import WebDriverWait
|
|
|
|
from superset.extensions import machine_auth_provider_factory
|
|
from superset.utils.retries import retry_call
|
|
|
|
WindowSize = Tuple[int, int]
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
if TYPE_CHECKING:
|
|
from flask_appbuilder.security.sqla.models import User
|
|
|
|
|
|
class DashboardStandaloneMode(Enum):
|
|
HIDE_NAV = 1
|
|
HIDE_NAV_AND_TITLE = 2
|
|
REPORT = 3
|
|
|
|
|
|
class ChartStandaloneMode(Enum):
|
|
HIDE_NAV = "true"
|
|
SHOW_NAV = 0
|
|
|
|
|
|
def find_unexpected_errors(driver: WebDriver) -> List[str]:
|
|
error_messages = []
|
|
|
|
try:
|
|
alert_divs = driver.find_elements(By.XPATH, "//div[@role = 'alert']")
|
|
logger.debug(
|
|
"%i alert elements have been found in the screenshot", len(alert_divs)
|
|
)
|
|
|
|
for alert_div in alert_divs:
|
|
# See More button
|
|
alert_div.find_element(By.XPATH, ".//*[@role = 'button']").click()
|
|
|
|
# wait for modal to show up
|
|
modal = WebDriverWait(
|
|
driver, current_app.config["SCREENSHOT_WAIT_FOR_ERROR_MODAL_VISIBLE"]
|
|
).until(
|
|
EC.visibility_of_any_elements_located(
|
|
(By.CLASS_NAME, "ant-modal-content")
|
|
)
|
|
)[
|
|
0
|
|
]
|
|
|
|
err_msg_div = modal.find_element(By.CLASS_NAME, "ant-modal-body")
|
|
|
|
# collect error message
|
|
error_messages.append(err_msg_div.text)
|
|
|
|
# close modal after collecting error messages
|
|
modal.find_element(By.CLASS_NAME, "ant-modal-close").click()
|
|
|
|
# wait until the modal becomes invisible
|
|
WebDriverWait(
|
|
driver, current_app.config["SCREENSHOT_WAIT_FOR_ERROR_MODAL_INVISIBLE"]
|
|
).until(EC.invisibility_of_element(modal))
|
|
|
|
# Use HTML so that error messages are shown in the same style (color)
|
|
error_as_html = err_msg_div.get_attribute("innerHTML").replace("'", "\\'")
|
|
|
|
try:
|
|
# Even if some errors can't be updated in the screenshot,
|
|
# keep all the errors in the server log and do not fail the loop
|
|
driver.execute_script(
|
|
f"arguments[0].innerHTML = '{error_as_html}'", alert_div
|
|
)
|
|
except WebDriverException:
|
|
logger.exception("Failed to update error messages using alert_div")
|
|
except WebDriverException:
|
|
logger.exception("Failed to capture unexpected errors")
|
|
|
|
return error_messages
|
|
|
|
|
|
class WebDriverProxy:
|
|
def __init__(self, driver_type: str, window: Optional[WindowSize] = None):
|
|
self._driver_type = driver_type
|
|
self._window: WindowSize = window or (800, 600)
|
|
self._screenshot_locate_wait = current_app.config["SCREENSHOT_LOCATE_WAIT"]
|
|
self._screenshot_load_wait = current_app.config["SCREENSHOT_LOAD_WAIT"]
|
|
|
|
def create(self) -> WebDriver:
|
|
pixel_density = current_app.config["WEBDRIVER_WINDOW"].get("pixel_density", 1)
|
|
if self._driver_type == "firefox":
|
|
driver_class = firefox.webdriver.WebDriver
|
|
options = firefox.options.Options()
|
|
profile = FirefoxProfile()
|
|
profile.set_preference("layout.css.devPixelsPerPx", str(pixel_density))
|
|
kwargs: Dict[Any, Any] = dict(options=options, firefox_profile=profile)
|
|
elif self._driver_type == "chrome":
|
|
driver_class = chrome.webdriver.WebDriver
|
|
options = chrome.options.Options()
|
|
options.add_argument(f"--force-device-scale-factor={pixel_density}")
|
|
options.add_argument(f"--window-size={self._window[0]},{self._window[1]}")
|
|
kwargs = dict(options=options)
|
|
else:
|
|
raise Exception(f"Webdriver name ({self._driver_type}) not supported")
|
|
# Prepare args for the webdriver init
|
|
|
|
# Add additional configured options
|
|
for arg in current_app.config["WEBDRIVER_OPTION_ARGS"]:
|
|
options.add_argument(arg)
|
|
|
|
kwargs.update(current_app.config["WEBDRIVER_CONFIGURATION"])
|
|
logger.debug("Init selenium driver")
|
|
|
|
return driver_class(**kwargs)
|
|
|
|
def auth(self, user: User) -> WebDriver:
|
|
driver = self.create()
|
|
return machine_auth_provider_factory.instance.authenticate_webdriver(
|
|
driver, user
|
|
)
|
|
|
|
@staticmethod
|
|
def destroy(driver: WebDriver, tries: int = 2) -> None:
|
|
"""Destroy a driver"""
|
|
# This is some very flaky code in selenium. Hence the retries
|
|
# and catch-all exceptions
|
|
try:
|
|
retry_call(driver.close, max_tries=tries)
|
|
except Exception: # pylint: disable=broad-except
|
|
pass
|
|
try:
|
|
driver.quit()
|
|
except Exception: # pylint: disable=broad-except
|
|
pass
|
|
|
|
def get_screenshot(
|
|
self, url: str, element_name: str, user: User
|
|
) -> Optional[bytes]:
|
|
driver = self.auth(user)
|
|
driver.set_window_size(*self._window)
|
|
driver.get(url)
|
|
img: Optional[bytes] = None
|
|
selenium_headstart = current_app.config["SCREENSHOT_SELENIUM_HEADSTART"]
|
|
logger.debug("Sleeping for %i seconds", selenium_headstart)
|
|
sleep(selenium_headstart)
|
|
|
|
try:
|
|
logger.debug("Wait for the presence of %s", element_name)
|
|
element = WebDriverWait(driver, self._screenshot_locate_wait).until(
|
|
EC.presence_of_element_located((By.CLASS_NAME, element_name))
|
|
)
|
|
|
|
logger.debug("Wait for chart containers to draw")
|
|
WebDriverWait(driver, self._screenshot_locate_wait).until(
|
|
EC.visibility_of_all_elements_located(
|
|
(By.CLASS_NAME, "slice_container")
|
|
)
|
|
)
|
|
|
|
logger.debug("Wait for loading element of charts to be gone")
|
|
WebDriverWait(driver, self._screenshot_load_wait).until_not(
|
|
EC.presence_of_all_elements_located((By.CLASS_NAME, "loading"))
|
|
)
|
|
|
|
selenium_animation_wait = current_app.config[
|
|
"SCREENSHOT_SELENIUM_ANIMATION_WAIT"
|
|
]
|
|
logger.debug("Wait %i seconds for chart animation", selenium_animation_wait)
|
|
sleep(selenium_animation_wait)
|
|
logger.debug(
|
|
"Taking a PNG screenshot of url %s as user %s",
|
|
url,
|
|
user.username,
|
|
)
|
|
|
|
if current_app.config["SCREENSHOT_REPLACE_UNEXPECTED_ERRORS"]:
|
|
unexpected_errors = find_unexpected_errors(driver)
|
|
if unexpected_errors:
|
|
logger.warning(
|
|
"%i errors found in the screenshot. URL: %s. Errors are: %s",
|
|
len(unexpected_errors),
|
|
url,
|
|
unexpected_errors,
|
|
)
|
|
|
|
img = element.screenshot_as_png
|
|
|
|
except TimeoutException:
|
|
logger.exception("Selenium timed out requesting url %s", url)
|
|
except StaleElementReferenceException:
|
|
logger.exception(
|
|
"Selenium got a stale element while requesting url %s",
|
|
url,
|
|
)
|
|
except WebDriverException:
|
|
logger.exception(
|
|
"Encountered an unexpected error when requeating url %s", url
|
|
)
|
|
finally:
|
|
self.destroy(driver, current_app.config["SCREENSHOT_SELENIUM_RETRIES"])
|
|
return img
|