Merge branch 'add/experiment-subscriptions-admin-menu-2' into add/experiment-subscriptions-admin-menu-1

plugins/woocommerce/src/Internal/Admin/WcPaySubscriptionsPage.php

@@ -2,6 +2,7 @@
 
 namespace Automattic\WooCommerce\Internal\Admin;
 
+use Automattic\WooCommerce\Admin\PageController;
 use Automattic\WooCommerce\Admin\Features\OnboardingTasks\Tasks\WooCommercePayments;
 
 /**
@@ -9,11 +10,29 @@ use Automattic\WooCommerce\Admin\Features\OnboardingTasks\Tasks\WooCommercePayme
  */
 class WcPaySubscriptionsPage {
 
+	/**
+	 * The WCPay Subscriptions admin page ID.
+	 *
+	 * @var string
+	 */
+	private $page_id = 'woocommerce-wcpay-subscriptions';
+
+	/**
+	 * The option key used to record when a user has viewed the WCPay Subscriptions admin page.
+	 *
+	 * @var string
+	 */
+	private $user_viewed_option = 'woocommerce-wcpay-subscriptions_page_viewed';
+
 	/**
 	 * Hook into WooCommerce.
 	 */
 	public function __construct() {
 		add_action( 'admin_menu', array( $this, 'register_subscriptions_page' ) );
+		add_action( 'current_screen', array( $this, 'record_user_page_view' ) );
+
+		// Priority 50 to run after Automattic\WooCommerce\Internal\Admin\Homescreen::update_link_structure() which runs on 20.
+		add_action( 'admin_menu', array( $this, 'restructure_menu_order' ), 50 );
 	}
 
 	/**
@@ -22,7 +41,7 @@ class WcPaySubscriptionsPage {
 	public function register_subscriptions_page() {
 		global $submenu;
 
-		// WC Payment must not be active.
+		// WC Payments must not be active.
 		if ( is_plugin_active( 'woocommerce-payments/woocommerce-payments.php' ) ) {
 			return;
 		}
@@ -32,30 +51,70 @@ class WcPaySubscriptionsPage {
 		}
 
 		$menu_data = array(
-			'id'         => 'woocommerce-wcpay-subscriptions',
+			'id'         => $this->page_id,
 			'title'      => _x( 'Subscriptions', 'Admin menu name', 'woocommerce' ),
 			'parent'     => 'woocommerce',
 			'path'       => '/subscriptions',
 			'capability' => 'manage_options',
-			'nav_args' => [
-				'order'  => 10, // TODO: this menu item should appear below the "Orders" menu item.
-				'parent' => 'woocommerce',
-			],
 		);
 
 		wc_admin_register_page( $menu_data );
 
-		if ( ! isset( $submenu['woocommerce'] ) ) {
+		if ( ! isset( $submenu['woocommerce'] ) || 'yes' === get_option( $this->user_viewed_option, 'no' ) ) {
 			return;
 		}
 
 		// Add the "1" badge.
-		// TODO: remove this badge after the user has visited the "Subscriptions" page the first time.
 		foreach ( $submenu['woocommerce'] as $key => $menu_item ) {
 			if ( 'wc-admin&path=/subscriptions' === $menu_item[2] ) {
-				$submenu['woocommerce'][ $key ][0] .= ' <span class="wcpay-subscriptions-menu-badge awaiting-mod count-1"><span class="plugin-count">1</span></span>';
+				$submenu['woocommerce'][ $key ][0] .= ' <span class="wcpay-subscriptions-menu-badge awaiting-mod count-1"><span class="plugin-count">1</span></span>'; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
 				break;
 			}
 		}
 	}
+
+	/**
+	 * Registers when a user views the WCPay Subscriptions screen.
+	 *
+	 * Sets an option to prevent the notification badge from being displayed.
+	 */
+	public function record_user_page_view() {
+		$current_page = PageController::get_instance()->get_current_page();
+
+		if ( isset( $current_page['id'] ) && $current_page['id'] === $this->page_id ) {
+			update_option( $this->user_viewed_option, 'yes' );
+		}
+	}
+
+	/**
+	 * Reorders the default WC admin menu items to ensure the Subscriptions item comes after orders.
+	 *
+	 * @see Automattic\WooCommerce\Internal\Admin\Homescreen::update_link_structure() which this approach is based on.
+	 */
+	public function restructure_menu_order() {
+		global $submenu;
+		$wc_admin_menu           = array();
+		$subscriptions_menu_item = null;
+
+		foreach ( $submenu['woocommerce'] as $key => $menu_item ) {
+			$wc_admin_menu[ $key ] = $menu_item;
+
+			// Add a placeholder element for the Subscriptions item after the Orders element. We'll replace it later.
+			if ( 'edit.php?post_type=shop_order' === $menu_item[2] ) {
+				$wc_admin_menu['wcpay-subscriptions'] = 'wcpay-subscriptions';
+			}
+
+			// Keep a record of the subscriptions item and remove it from its current place in the menu.
+			if ( 'wc-admin&path=/subscriptions' === $menu_item[2] ) {
+				$subscriptions_menu_item = $menu_item;
+				unset( $wc_admin_menu[ $key ] );
+			}
+		}
+
+		// Replace the placeholder element with the subscription menu item.
+		if ( isset( $wc_admin_menu['wcpay-subscriptions'] ) && $subscriptions_menu_item ) {
+			$wc_admin_menu['wcpay-subscriptions'] = $subscriptions_menu_item;
+			$submenu['woocommerce']               = array_values( $wc_admin_menu ); // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
+		}
+	}
 }