You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@superset.apache.org by GitBox <gi...@apache.org> on 2019/01/11 23:17:51 UTC
[GitHub] mistercrunch closed pull request #4381: [WiP] Phantom JS
mistercrunch closed pull request #4381: [WiP] Phantom JS
URL: https://github.com/apache/incubator-superset/pull/4381
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/setup.py b/setup.py
index 033d9ac83e..a4d912bb6a 100644
--- a/setup.py
+++ b/setup.py
@@ -71,6 +71,9 @@ def get_git_sha():
],
extras_require={
'cors': ['Flask-Cors>=2.0.0'],
+ 'images': [
+ 'selenium',
+ ],
},
tests_require=[
'codeclimate-test-reporter',
diff --git a/superset/assets/javascripts/explorev2/components/ChartContainer.jsx b/superset/assets/javascripts/explorev2/components/ChartContainer.jsx
index 1053222dac..d5d902c7ae 100644
--- a/superset/assets/javascripts/explorev2/components/ChartContainer.jsx
+++ b/superset/assets/javascripts/explorev2/components/ChartContainer.jsx
@@ -42,6 +42,7 @@ class ChartContainer extends React.PureComponent {
this.state = {
selector: `#${props.containerId}`,
showStackTrace: false,
+ firstRenderDone: false, // Used as a marker for selenium
};
}
@@ -51,6 +52,7 @@ class ChartContainer extends React.PureComponent {
this.setState({ mockSlice });
try {
visMap[this.props.viz_type](mockSlice, this.props.queryResponse);
+ this.setState({ firstRenderDone: true });
} catch (e) {
this.props.actions.chartRenderingFailed(e);
}
@@ -201,6 +203,9 @@ class ChartContainer extends React.PureComponent {
style={{ position: 'absolute' }}
/>
}
+ { this.state.firstRenderDone &&
+ <div className="first-render-done" />
+ }
<div
id={this.props.containerId}
ref={ref => { this.chartContainerRef = ref; }}
diff --git a/superset/views/__init__.py b/superset/views/__init__.py
index b964e8b14e..f144a63e7a 100644
--- a/superset/views/__init__.py
+++ b/superset/views/__init__.py
@@ -1,3 +1,4 @@
from . import base # noqa
from . import core # noqa
from . import sql_lab # noqa
+from . import images # noqa
diff --git a/superset/views/images.py b/superset/views/images.py
new file mode 100644
index 0000000000..a89de26dc1
--- /dev/null
+++ b/superset/views/images.py
@@ -0,0 +1,146 @@
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+from __future__ import unicode_literals
+
+import io
+import os
+import signal
+import time
+
+from flask import request, send_file
+from flask_appbuilder import expose
+
+from selenium import webdriver
+from selenium.common.exceptions import TimeoutException, WebDriverException
+from selenium.webdriver.support import ui
+from selenium.webdriver.common.by import By
+from selenium.webdriver.support import expected_conditions as EC
+
+from superset import appbuilder, db
+from superset.models.core import Slice
+from .base import BaseSupersetView
+
+
+class BrowserSession(object):
+ """
+ A context manager representing a Superset browser session accessed via the
+ PhantomJS web-driver.
+ """
+ @staticmethod
+ def get_session_cookie(driver):
+ """Hack to find the cookie domain, can be removed if predicted"""
+ driver.get(request.url_root + 'superset/welcome')
+ session_cookie = None
+ for cookie in driver.get_cookies():
+ if cookie['name'] == 'session':
+ session_cookie = cookie
+ return session_cookie
+
+ @classmethod
+ def flask_to_driver(cls, driver):
+ """Copies the flask request into the selenium driver"""
+ session_cookie = cls.get_session_cookie(driver)
+ if not session_cookie:
+ session_cookie = {
+ 'name': 'session',
+ 'domain': '.localhost',
+ 'path': '/',
+ }
+ if not session_cookie['domain'].startswith('.'):
+ session_cookie['domain'] = '.' + session_cookie['domain']
+ for k, v in request.cookies.items():
+ if k == 'session':
+ session_cookie['value'] = v
+ driver.add_cookie(session_cookie)
+
+ for k, v in request.headers.items():
+ field = 'phantomjs.page.customHeaders.{}'.format(k)
+ webdriver.DesiredCapabilities.PHANTOMJS[field] = v
+
+ def __enter__(self):
+ """
+ Start a Superset browser session.
+ Note that the user is logged in via internal authorization.
+ :returns: The Superset browser session context manager
+ :rtype: BrowserSession
+ """
+ self.driver = webdriver.PhantomJS(service_log_path=os.path.devnull)
+ self.flask_to_driver(self.driver)
+ return self
+
+ def __exit__(self, *args):
+ """
+ End the Superset browser session by quitting the PhantomJS web-driver
+ and ensuring that the forked child process is terminated.
+ Note the the user is not logged out given that the PhantomJS web-driver
+ may be non-responsive.
+ """
+
+ self.driver.service.process.send_signal(signal.SIGTERM)
+ self.driver.quit()
+
+ def capture(self, path, wait=15, width=1280, height=800):
+ """
+ Capture the screenshot of the rendered path as a PNG image using the
+ PhantomJS headless browser.
+ The PhantomJS web-driver waits until the page is loaded in the browser
+ however not all AJAX elements within the page may have loaded and thus
+ an explicit wait is defined prior to proceeding to capture the
+ screenshot.
+ If the page contains '.loading' CSS selector elements the page is deemed
+ renderable when all the elements are hidden, otherwise the web-driver
+ will wait the entire period.
+ Note for an unknown reason the AJAX request may cause the web-driver to
+ become non-responsive rendering the browser inoperable and eventually
+ causing PhantomJS to crash. An explicit socket timeout signifies such
+ an event.
+ The PhantomJS web-driver only strictly adheres to the window width and
+ window height is resized if needed to ensure that the entire page is
+ encapsulated within the window.
+ :param path: The Superset URL path
+ :type path: str
+ :param wait: The maximum time to wait for AJAX content in seconds
+ :type wait: int
+ :param width: The screenshot width in pixels
+ :type width: int
+ :returns: The captured image
+ :rtype: PIL.Image
+ :raises HTTPException: If the HTTP request fails
+ :raises socket.timeout: If the page becomes non-responsive
+ :raises URLError: If the connection is refused
+ """
+ url = request.url_root[:-1] + path
+ print('-='*80)
+ print(url)
+ self.driver.get(url)
+
+ # The non-zero window height is merely a lower bound.
+ self.driver.set_window_size(width, height)
+ wait = ui.WebDriverWait(self.driver, 30)
+ wait.until(EC.presence_of_element_located(
+ (By.CSS_SELECTOR, ".first-render-done")))
+ time.sleep(1)
+ png = self.driver.get_screenshot_as_png()
+ return io.BytesIO(png)
+
+
+class Img(BaseSupersetView):
+
+ """The base views for Superset!"""
+
+ @expose("/slice/<slice_id>/")
+ def slice(self, slice_id):
+ """Assigns a list of found users to the given role."""
+ height = int(request.args.get('height', '800'))
+ width = int(request.args.get('width', '800'))
+
+ slice_id = int(slice_id)
+ slc = db.session.query(Slice).filter_by(id=slice_id).first()
+ with BrowserSession() as browser:
+ img = browser.capture(
+ slc.slice_url + '&standalone=true', width=width, height=height)
+ return send_file(img, mimetype='image/png')
+ return "Nope"
+
+appbuilder.add_view_no_menu(Img)
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org