refactor: load tracking and banner using internal pages

Author: Soare-Robert-Daniel

feedzy-rss-feed.php

@@ -284,8 +284,6 @@ function feedzy_import_job_logs( $name, $msg, $type ) {
 }
 add_action( 'themeisle_log_event', 'feedzy_import_job_logs', 20, 3 );
 
-add_filter( 'themeisle_sdk_enable_telemetry', '__return_true' );
-
 add_filter(
 	'feedzy_rss_feeds_float_widget_metadata', function () {
 		return array(

includes/admin/feedzy-rss-feeds-admin.php

@@ -76,6 +76,33 @@ function( $data, $page_slug ) {
 				2
 			);
 		}
+
+		/**
+		 * Load SDK dependencies.
+		 */
+		add_filter( 'themeisle_internal_page', function( $product_name, $page_slug ) {
+			if ( $product_name !== $this->plugin_name ) {
+				return;
+			}
+
+			if ( in_array( $page_slug, array( 'imports', 'categories' ), true ) ) {
+				$this->add_banner_anchor();
+			}
+
+			if ( in_array( $page_slug, array( 'imports', 'categories', 'settings' ), true ) ) {
+				$license_data = get_option( 'feedzy_rss_feeds_pro_license_data', array() );
+				if ( self::plan_category( $license_data ) <= 1 ) {
+					do_action( 'themeisle_sdk_load_banner', 'feedzy' );
+				}
+			}
+
+			if (
+				in_array( $page_slug, array( 'imports', 'new-category', 'settings' ), true )
+				&& 'yes' === get_option( 'feedzy_rss_feeds_logger_flag', false )
+			) {
+				$this->enable_telemetry();
+			}
+		}, 10, 2 );
 	}
 
 	/**
@@ -133,22 +160,8 @@ public function enqueue_styles_admin() {
 			return;
 		}
 
-		$telemetry_enabled = get_option( 'feedzy_rss_feeds_logger_flag', false );
-		if ( ! defined( 'TI_CYPRESS_TESTING' ) &&
-			! empty( $telemetry_enabled ) &&
-			(
-				'feedzy_categories' === $screen->post_type ||
-				'feedzy_page_feedzy-settings' === $screen->base ||
-				'feedzy_imports' === $screen->post_type
-			)
-		) {
-			wp_enqueue_script( $this->plugin_name . '_telemetry', FEEDZY_ABSURL . 'js/telemetry.js', array(), $this->version, true );
-		}
-
 		if ( 'feedzy_imports' === $screen->post_type && 'edit' === $screen->base ) {
 			$this->do_internal_page( 'imports' );
-
-			$this->add_banner_anchor();
 		}
 
 		if ( 'feedzy_categories' === $screen->post_type ) {
@@ -175,7 +188,6 @@ public function enqueue_styles_admin() {
 					),
 				)
 			);
-			$this->add_banner_anchor();
 		}
 
 		if ( 'feedzy_page_feedzy-settings' === $screen->base || 'feedzy_page_feedzy-integration' === $screen->base ) {
@@ -197,17 +209,6 @@ public function enqueue_styles_admin() {
 			);
 		}
 
-		if (
-			'feedzy_page_feedzy-settings' === $screen->base ||
-			'feedzy_categories' === $screen->post_type ||
-			( 'feedzy_imports' === $screen->post_type && 'edit' === $screen->base )
-		) {
-			$license_data = get_option( 'feedzy_rss_feeds_pro_license_data', array() );
-			if ( self::plan_category( $license_data ) <= 1 ) {
-				do_action( 'themeisle_sdk_load_banner', 'feedzy' );
-			}
-		}
-
 		$upsell_screens = array( 'feedzy-rss_page_feedzy-settings', 'feedzy-rss_page_feedzy-admin-menu-pro-upsell' );
 		if ( 'feedzy_imports' === $screen->post_type && 'edit' !== $screen->base ) {
 
@@ -252,11 +253,13 @@ public function enqueue_styles_admin() {
 			wp_enqueue_style( 'wp-block-editor' );
 
 			wp_set_script_translations( $this->plugin_name . '_conditions', 'feedzy-rss-feeds' );
+			$this->enable_telemetry();
 		}
 		if ( ! defined( 'TI_CYPRESS_TESTING' ) && ( 'edit' !== $screen->base && 'feedzy_imports' === $screen->post_type && feedzy_show_import_tour() ) ) {
 			$asset_file = include FEEDZY_ABSPATH . '/build/onboarding/index.asset.php';
 			wp_enqueue_script( $this->plugin_name . '_on_boarding', FEEDZY_ABSURL . 'build/onboarding/index.js', array_merge( $asset_file['dependencies'], array( 'wp-editor', 'wp-api' ) ), $asset_file['version'], true );
 			wp_set_script_translations( $this->plugin_name . '_on_boarding', 'feedzy-rss-feeds' );
+			$this->enable_telemetry();
 		}
 
 		if ( 'feedzy_page_feedzy-settings' === $screen->base ) {
@@ -2348,4 +2351,16 @@ public function register_settings() {
 	private function do_internal_page( $page_slug ) {
 		do_action( 'themeisle_internal_page', $this->plugin_name, $page_slug );
 	}
+
+	/**
+	 * Enable the loading of telemetry script in page.
+	 */
+	private function enable_telemetry() {
+		if ( defined( 'E2E_TESTING' ) ) {
+			return;
+		}
+
+		add_filter( 'themeisle_sdk_enable_telemetry', '__return_true' );
+		wp_enqueue_script( $this->plugin_name . '_telemetry', FEEDZY_ABSURL . 'js/telemetry.js', array(), $this->version, true );
+	}
 }

includes/gutenberg/feedzy-rss-feeds-gutenberg-block.php

@@ -81,6 +81,10 @@ public function feedzy_gutenberg_scripts() {
 		// Enqueue editor block styles
 		wp_enqueue_style( 'feedzy-block-css', FEEDZY_ABSURL . 'css/feedzy-rss-feeds.css', array(), $this->version );
 		wp_enqueue_style( 'feedzy-gutenberg-block-css', FEEDZY_ABSURL . 'build/block/style-index.css', array(), $this->version );
+
+		if ( ! defined( 'TE2E_TESTING' ) ) {
+			add_filter( 'themeisle_sdk_enable_telemetry', '__return_true' );
+		}
 	}
 
 	/**