Add silence_upgrade_notification flag to prevent upgrade notification requests in CI

Author: marthacryan

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_SILENCE_UPGRADE_NOTIFICATION",
                 "DASH_PRUNE_ERRORS",
                 "DASH_COMPRESS",
                 "HOST",

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

@@ -32,6 +32,9 @@ async function requestDashVersionInfo(config) {
         ddk_version: ddkVersion,
         plotly_version: plotlyVersion
     } = config;
+    if (!shouldRequestDashVersion(config)) {
+        return {};
+    }
     const cachedVersionInfo = localStorage.getItem('cachedNewDashVersion');
     const cachedNewDashVersionLink = localStorage.getItem(
         'cachedNewDashVersionLink'
@@ -74,14 +77,35 @@ async function requestDashVersionInfo(config) {
     }
 }
 
-function shouldShowUpgradeNotification(currentDashVersion, newDashVersion) {
-    const showNotifications = localStorage.getItem('showNotifications');
+function shouldRequestDashVersion(config) {
+    const showNotificationsLocalStorage =
+        localStorage.getItem('showNotifications');
+    const showNotifications = config.silence_upgrade_notification
+        ? 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.silence_upgrade_notification
+        ? 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 (
@@ -173,7 +197,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,
+            "silence_upgrade_notification": self._dev_tools.silence_upgrade_notification,
             "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["silence_upgrade_notification"] = get_combined_config(
+            "silence_upgrade_notification",
+            kwargs.get("silence_upgrade_notification", 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_silence_upgrade_notification=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_SILENCE_UPGRADE_NOTIFICATION
             - 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_silence_upgrade_notification: Silence the upgrade
+            notification to prevent making requests to the Dash server.
+            env: ``DASH_SILENCE_UPGRADE_NOTIFICATION``
+        :type dev_tools_silence_upgrade_notification: 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,
+            silence_upgrade_notification=dev_tools_silence_upgrade_notification,
             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_silence_upgrade_notification: 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_silence_upgrade_notification: Silence the upgrade
+            notification to prevent making requests to the Dash server.
+            env: ``DASH_SILENCE_UPGRADE_NOTIFICATION``
+        :type dev_tools_silence_upgrade_notification: 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_silence_upgrade_notification,
             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["silence_upgrade_notification"] = True
 
             if "port" not in kwargs:
                 options["port"] = self.port = BaseDashRunner._next_port