Odyssey Stats widget: Only load stats script when widget is visible

projects/packages/stats-admin/changelog/fix-only-load-stats-data-when-widget-is-visible

@@ -0,0 +1,4 @@
+Significance: minor
+Type: added
+
+Support load scripts conditionally for Stats widget

projects/packages/stats-admin/composer.json

@@ -52,7 +52,7 @@
 		"autotagger": true,
 		"mirror-repo": "Automattic/jetpack-stats-admin",
 		"branch-alias": {
-			"dev-trunk": "0.13.x-dev"
+			"dev-trunk": "0.14.x-dev"
 		},
 		"textdomain": "jetpack-stats-admin",
 		"version-constants": {

projects/packages/stats-admin/package.json

@@ -1,7 +1,7 @@
 {
 	"private": true,
 	"name": "@automattic/jetpack-stats-admin",
-	"version": "0.13.0",
+	"version": "0.14.0-alpha",
 	"description": "Stats Dashboard",
 	"homepage": "https://github.com/Automattic/jetpack/tree/HEAD/projects/packages/stats-admin/#readme",
 	"bugs": {

projects/packages/stats-admin/src/class-main.php

@@ -22,7 +22,7 @@ class Main {
 	/**
 	 * Stats version.
 	 */
-	const VERSION = '0.13.0';
+	const VERSION = '0.14.0-alpha';
 
 	/**
 	 * Singleton Main instance.

projects/packages/stats-admin/src/class-wp-dashboard-odyssey-widget.php

@@ -13,11 +13,14 @@
  * @package jetpack-stats-admin
  */
 class WP_Dashboard_Odyssey_Widget {
+	const DASHBOARD_WIDGET_ID = 'jetpack_summary_widget';
 
 	/**
 	 * Renders the widget and fires a dashboard widget action.
 	 */
-	public static function render() {
+	public function render() {
+		// The widget is always rendered, so if it was hidden and then toggled open, we need to ask user to refresh the page to load data properly.
+		$is_toggled_open = $this->is_widget_hidden();
 		?>
 		<div id="dashboard_stats" class="jp-stats-widget" style="min-height: 200px;">
 			<div class="hide-if-js"><?php esc_html_e( 'Your Jetpack Stats widget requires JavaScript to function properly.', 'jetpack-stats-admin' ); ?></div>
@@ -30,6 +33,13 @@ class="jp-stats-widget-loading-spinner"
 					alt=<?php echo esc_attr( __( 'Loading', 'jetpack-stats-admin' ) ); ?>
 					src="//en.wordpress.com/i/loading/loading-64.gif"
 				/>
+				<p>
+				<?php
+				if ( $is_toggled_open ) {
+					echo esc_html__( 'Please reload the page to see your stats...', 'jetpack-stats-admin' );
+				}
+				?>
+				</p>
 			</div>
 		</div>
 		<?php
@@ -57,4 +67,24 @@ public function load_admin_scripts() {
 			)
 		);
 	}
+
+	/**
+	 * Load the admin scripts when the widget is visible.
+	 */
+	public function maybe_load_admin_scripts() {
+		if ( $this->is_widget_hidden() ) {
+			return;
+		}
+		$this->load_admin_scripts();
+	}
+
+	/**
+	 * Returns true if the widget is hidden for the current screen and current user.
+	 *
+	 * @return bool
+	 */
+	public function is_widget_hidden() {
+		$hidden = get_hidden_meta_boxes( get_current_screen() );
+		return in_array( self::DASHBOARD_WIDGET_ID, $hidden, true );
+	}
 }

projects/plugins/jetpack/changelog/fix-only-load-stats-data-when-widget-is-visible

@@ -0,0 +1,4 @@
+Significance: patch
+Type: other
+
+Odyssey Stats widget: only load scripts when the widget is visible

projects/plugins/jetpack/changelog/fix-only-load-stats-data-when-widget-is-visible#2

@@ -0,0 +1,5 @@
+Significance: patch
+Type: other
+Comment: Updated composer.lock.
+
+

projects/plugins/jetpack/class-jetpack-stats-dashboard-widget.php

@@ -68,15 +68,16 @@ public static function wp_dashboard_setup() {
 				// New widget implemented in Odyssey Stats.
 				$stats_widget = new Dashboard_Stats_Widget();
 				wp_add_dashboard_widget(
-					'jetpack_summary_widget',
+					Dashboard_Stats_Widget::DASHBOARD_WIDGET_ID,
 					$widget_title,
 					array( $stats_widget, 'render' )
 				);
-				$stats_widget->load_admin_scripts();
+				// Only load scripts when the widget is not hidden
+				$stats_widget->maybe_load_admin_scripts();
 			} else {
 				// Legacy widget.
 				wp_add_dashboard_widget(
-					'jetpack_summary_widget',
+					Dashboard_Stats_Widget::DASHBOARD_WIDGET_ID,
 					$widget_title,
 					array( __CLASS__, 'render_widget' )
 				);