Merge pull request #3195 from plotly/upgrade-get

Change to use GET request when requesting dash version from server

Author: marthacryan

components/dash-table/tests/selenium/test_header.py

@@ -136,6 +136,7 @@ def test_head005_no_warnings_emitted(test):
  use_reloader=False,
  use_debugger=True,
  dev_tools_hot_reload=False,
+ dev_tools_disable_version_check=True,
  )
 
  target = test.table("table")
@@ -173,6 +174,7 @@ def test_head006_style_merged_columns(test):
  use_reloader=False,
  use_debugger=True,
  dev_tools_hot_reload=False,
+ dev_tools_disable_version_check=True,
  )
 
  target = test.table("table")

dash/_configs.py

@@ -29,6 +29,7 @@ def load_dash_env_vars():
  "DASH_HOT_RELOAD_WATCH_INTERVAL",
  "DASH_HOT_RELOAD_MAX_RETRY",
  "DASH_SILENCE_ROUTES_LOGGING",
+ "DASH_DISABLE_VERSION_CHECK",
  "DASH_PRUNE_ERRORS",
  "DASH_COMPRESS",
  "HOST",

dash/dash-renderer/src/components/error/menu/VersionInfo.react.js

@@ -46,25 +46,17 @@ async function requestDashVersionInfo(config) {
  version: JSON.parse(cachedVersionInfo),
  link: cachedNewDashVersionLink
  };
- } else {
- return fetch(dashVersionUrl, {
- method: 'POST',
- body: JSON.stringify({
- dash_version: currentDashVersion,
- python_version: pythonVersion,
- ddk_version: ddkVersion,
- plotly_version: plotlyVersion
- }),
- headers: {
- 'Content-Type': 'application/json'
- }
- })
+ } else if (shouldRequestDashVersion(config)) {
+ const queryParams = new URLSearchParams({
+ dash_version: currentDashVersion,
+ python_version: pythonVersion,
+ ddk_version: ddkVersion,
+ plotly_version: plotlyVersion
+ }).toString();
+ return fetch(dashVersionUrl + '?' + queryParams, {mode: 'cors'})
  .then(response => response.json())
- .catch(() => {
- return {};
- })
  .then(body => {
- if (body.version && body.link) {
+ if (body && body.version && body.link) {
  localStorage.setItem(
  'cachedNewDashVersion',
  JSON.stringify(body.version)
@@ -75,18 +67,42 @@ async function requestDashVersionInfo(config) {
  } else {
  return {};
  }
+ })
+ .catch(() => {
+ return {};
  });
  }
 }
 
-function shouldShowUpgradeNotification(currentDashVersion, newDashVersion) {
- const showNotifications = localStorage.getItem('showNotifications');
+function shouldRequestDashVersion(config) {
+ const showNotificationsLocalStorage =
+ localStorage.getItem('showNotifications');
+ const showNotifications = config.disable_version_check
+ ? false
+ : showNotificationsLocalStorage !== 'false';
+ const lastFetched = localStorage.getItem('lastFetched');
+ return (
+ showNotifications &&
+ (!lastFetched || Date.now() - Number(lastFetched) > DAY_IN_MS)
+ );
+}
+
+function shouldShowUpgradeNotification(
+ currentDashVersion,
+ newDashVersion,
+ config
+) {
+ const showNotificationsLocalStorage =
+ localStorage.getItem('showNotifications');
+ const showNotifications = config.disable_version_check
+ ? false
+ : showNotificationsLocalStorage !== 'false';
  const lastDismissed = localStorage.getItem('lastDismissed');
  const lastDismissedVersion = localStorage.getItem('lastDismissedVersion');
  if (
  newDashVersion === undefined ||
  compareVersions(currentDashVersion, newDashVersion) >= 0 ||
- showNotifications === 'false'
+ !showNotifications
  ) {
  return false;
  } else if (
@@ -133,8 +149,10 @@ export const VersionInfo = ({config}) => {
 
  useEffect(() => {
  requestDashVersionInfo(config).then(body => {
- setNewDashVersionLink(body.link);
- setNewDashVersion(body.version);
+ if (body) {
+ setNewDashVersionLink(body.link);
+ setNewDashVersion(body.version);
+ }
  });
  }, []);
 
@@ -178,7 +196,8 @@ export const VersionInfo = ({config}) => {
  <span>v{config.dash_version}</span>
  {shouldShowUpgradeNotification(
  config.dash_version,
- newDashVersion
+ newDashVersion,
+ config
  ) ? (
  <button
  className='dash-debug-menu__upgrade-button'

dash/dash.py

@@ -802,6 +802,7 @@ def _config(self):
  "requests_pathname_prefix": self.config.requests_pathname_prefix,
  "ui": self._dev_tools.ui,
  "props_check": self._dev_tools.props_check,
+ "disable_version_check": self._dev_tools.disable_version_check,
  "show_undo_redo": self.config.show_undo_redo,
  "suppress_callback_exceptions": self.config.suppress_callback_exceptions,
  "update_title": self.config.update_title,
@@ -1754,6 +1755,12 @@ def _setup_dev_tools(self, **kwargs):
  get_combined_config(attr, kwargs.get(attr, None), default=default)
  )
 
+ dev_tools["disable_version_check"] = get_combined_config(
+ "disable_version_check",
+ kwargs.get("disable_version_check", None),
+ default=False,
+ )
+
  return dev_tools
 
  def enable_dev_tools(
@@ -1767,6 +1774,7 @@ def enable_dev_tools(
  dev_tools_hot_reload_watch_interval=None,
  dev_tools_hot_reload_max_retry=None,
  dev_tools_silence_routes_logging=None,
+ dev_tools_disable_version_check=None,
  dev_tools_prune_errors=None,
  ):
  """Activate the dev tools, called by `run`. If your application
@@ -1787,6 +1795,7 @@ def enable_dev_tools(
  - DASH_HOT_RELOAD_WATCH_INTERVAL
  - DASH_HOT_RELOAD_MAX_RETRY
  - DASH_SILENCE_ROUTES_LOGGING
+ - DASH_DISABLE_VERSION_CHECK
  - DASH_PRUNE_ERRORS
 
  :param debug: Enable/disable all the dev tools unless overridden by the
@@ -1832,6 +1841,11 @@ def enable_dev_tools(
  env: ``DASH_SILENCE_ROUTES_LOGGING``
  :type dev_tools_silence_routes_logging: bool
 
+ :param dev_tools_disable_version_check: Silence the upgrade
+ notification to prevent making requests to the Dash server.
+ env: ``DASH_DISABLE_VERSION_CHECK``
+ :type dev_tools_disable_version_check: bool
+
  :param dev_tools_prune_errors: Reduce tracebacks to just user code,
  stripping out Flask and Dash pieces. Only available with debugging.
  `True` by default, set to `False` to see the complete traceback.
@@ -1853,6 +1867,7 @@ def enable_dev_tools(
  hot_reload_watch_interval=dev_tools_hot_reload_watch_interval,
  hot_reload_max_retry=dev_tools_hot_reload_max_retry,
  silence_routes_logging=dev_tools_silence_routes_logging,
+ disable_version_check=dev_tools_disable_version_check,
  prune_errors=dev_tools_prune_errors,
  )
 
@@ -2052,6 +2067,7 @@ def run(
  dev_tools_hot_reload_watch_interval: Optional[int] = None,
  dev_tools_hot_reload_max_retry: Optional[int] = None,
  dev_tools_silence_routes_logging: Optional[bool] = None,
+ dev_tools_disable_version_check: Optional[bool] = None,
  dev_tools_prune_errors: Optional[bool] = None,
  **flask_run_options,
  ):
@@ -2124,6 +2140,11 @@ def run(
  env: ``DASH_SILENCE_ROUTES_LOGGING``
  :type dev_tools_silence_routes_logging: bool
 
+ :param dev_tools_disable_version_check: Silence the upgrade
+ notification to prevent making requests to the Dash server.
+ env: ``DASH_DISABLE_VERSION_CHECK``
+ :type dev_tools_disable_version_check: bool
+
  :param dev_tools_prune_errors: Reduce tracebacks to just user code,
  stripping out Flask and Dash pieces. Only available with debugging.
  `True` by default, set to `False` to see the complete traceback.
@@ -2161,6 +2182,7 @@ def run(
  dev_tools_hot_reload_watch_interval,
  dev_tools_hot_reload_max_retry,
  dev_tools_silence_routes_logging,
+ dev_tools_disable_version_check,
  dev_tools_prune_errors,
  )
 

dash/testing/application_runners.py

@@ -162,6 +162,7 @@ def run():
  app.css.config.serve_locally = True
 
  options = kwargs.copy()
+ options["dev_tools_disable_version_check"] = True
 
  if "port" not in kwargs:
  options["port"] = self.port = BaseDashRunner._next_port

tests/integration/callbacks/test_missing_outputs.py

@@ -9,7 +9,11 @@
 from dash.testing.wait import until
 
 debugging = dict(
- debug=True, use_reloader=False, use_debugger=True, dev_tools_hot_reload=False
+ debug=True,
+ use_reloader=False,
+ use_debugger=True,
+ dev_tools_hot_reload=False,
+ dev_tools_disable_version_check=True,
 )
 
 
@@ -63,7 +67,7 @@ def content_inner(n2):
  def out2(contents):
  return sum(contents)
 
- dash_duo.start_server(app)
+ dash_duo.start_server(app, dev_tools_disable_version_check=True)
 
  dash_duo.wait_for_text_to_equal("#content", "")
  dash_duo.wait_for_text_to_equal("#output", "0")
@@ -231,7 +235,7 @@ def content_inner(n2):
  def out2(ci, cj):
  return sum(ci) + sum(cj)
 
- dash_duo.start_server(app)
+ dash_duo.start_server(app, dev_tools_disable_version_check=True)
 
  dash_duo.wait_for_text_to_equal("#content1", "0\n0")
  dash_duo.wait_for_text_to_equal("#content2", "")
@@ -304,7 +308,7 @@ def this_callback_takes_forever(n_clicks):
  call_counts["button-output"].value += 1
  return "New value!"
 
- dash_duo.start_server(app)
+ dash_duo.start_server(app, dev_tools_disable_version_check=True)
 
  dash_duo.wait_for_text_to_equal("#ch1-title", "Chapter 1")
  assert call_counts["body"].value == 1

tests/integration/devtools/test_devtools_ui.py

@@ -24,6 +24,7 @@ def test_dvui001_disable_props_check_config(dash_duo):
  use_debugger=True,
  dev_tools_hot_reload=False,
  dev_tools_props_check=False,
+ dev_tools_disable_version_check=True,
  )
 
  dash_duo.wait_for_text_to_equal("#tcid", "Hello Props Check")
@@ -48,6 +49,7 @@ def test_dvui002_disable_ui_config(dash_duo):
  use_debugger=True,
  dev_tools_hot_reload=False,
  dev_tools_ui=False,
+ dev_tools_disable_version_check=True,
  )
 
  dash_duo.wait_for_text_to_equal("#tcid", "Hello Disable UI")
@@ -70,6 +72,7 @@ def test_dvui003_callback_graph(dash_duo):
  use_reloader=False,
  use_debugger=True,
  dev_tools_hot_reload=False,
+ dev_tools_disable_version_check=True,
  )
 
  dash_duo.wait_for_text_to_equal("#totals", "0 of 0 items completed")
@@ -137,6 +140,7 @@ def get_width(n_clicks):
  use_reloader=False,
  use_debugger=True,
  dev_tools_hot_reload=False,
+ dev_tools_disable_version_check=True,
  )
 
  dash_duo.find_element("#dash-debug-menu__callback-graph-button").click()
@@ -172,7 +176,7 @@ def check_undo_redo_exist(has_undo, has_redo):
  def set_b(a):
  return a
 
- dash_duo.start_server(app)
+ dash_duo.start_server(app, dev_tools_disable_version_check=True)
 
  dash_duo.find_element("#a").send_keys("xyz")
 
@@ -207,7 +211,7 @@ def test_dvui006_no_undo_redo(dash_duo):
  def set_b(a):
  return a
 
- dash_duo.start_server(app)
+ dash_duo.start_server(app, dev_tools_disable_version_check=True)
 
  dash_duo.find_element("#a").send_keys("xyz")