From db5a1b734817de25228df71712e66135332d3f60 Mon Sep 17 00:00:00 2001
From: Jeff Stieler <jeff.m.stieler@gmail.com>
Date: Tue, 21 May 2019 13:01:55 -0600
Subject: [PATCH] =?UTF-8?q?Add=20support=20for=20=E2=80=9Cprimary=E2=80=9D?=
 =?UTF-8?q?=20admin=20notice=20actions.?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../client/layout/store-alerts/index.js       |  1 +
 .../includes/class-wc-admin-install.php       |  1 +
 .../class-wc-admin-notes-data-store.php       | 15 +++++-----
 .../includes/notes/class-wc-admin-note.php    | 30 +++++++++++--------
 .../class-wc-admin-notes-historical-data.php  |  3 +-
 5 files changed, 29 insertions(+), 21 deletions(-)

diff --git a/plugins/woocommerce-admin/client/layout/store-alerts/index.js b/plugins/woocommerce-admin/client/layout/store-alerts/index.js
index 52455291e4e..0a34b64f47f 100644
--- a/plugins/woocommerce-admin/client/layout/store-alerts/index.js
+++ b/plugins/woocommerce-admin/client/layout/store-alerts/index.js
@@ -73,6 +73,7 @@ class StoreAlerts extends Component {
 				<Button
 					key={ action.name }
 					isDefault
+					isPrimary={ action.primary }
 					href={ action.url }
 					onClick={ '' === action.status ? noop : markStatus }
 				>
diff --git a/plugins/woocommerce-admin/includes/class-wc-admin-install.php b/plugins/woocommerce-admin/includes/class-wc-admin-install.php
index db961290cc8..f40dd0aa20e 100644
--- a/plugins/woocommerce-admin/includes/class-wc-admin-install.php
+++ b/plugins/woocommerce-admin/includes/class-wc-admin-install.php
@@ -170,6 +170,7 @@ class WC_Admin_Install {
 			label varchar(255) NOT NULL,
 			query longtext NOT NULL,
 			status varchar(255) NOT NULL,
+			is_primary boolean DEFAULT 0 NOT NULL,
 			PRIMARY KEY (action_id),
 			KEY note_id (note_id)
 		) $collate;
diff --git a/plugins/woocommerce-admin/includes/data-stores/class-wc-admin-notes-data-store.php b/plugins/woocommerce-admin/includes/data-stores/class-wc-admin-notes-data-store.php
index 2edf11074e3..aeb284640f5 100644
--- a/plugins/woocommerce-admin/includes/data-stores/class-wc-admin-notes-data-store.php
+++ b/plugins/woocommerce-admin/includes/data-stores/class-wc-admin-notes-data-store.php
@@ -200,13 +200,13 @@ class WC_Admin_Notes_Data_Store extends WC_Data_Store_WP implements WC_Object_Da
 
 		$actions = $wpdb->get_results(
 			$wpdb->prepare(
-				"SELECT name, label, query, status FROM {$wpdb->prefix}wc_admin_note_actions WHERE note_id = %d",
+				"SELECT name, label, query, status, is_primary FROM {$wpdb->prefix}wc_admin_note_actions WHERE note_id = %d",
 				$note->get_id()
 			)
 		);
 		if ( $actions ) {
 			foreach ( $actions as $action ) {
-				$note->add_action( $action->name, $action->label, $action->query, $action->status );
+				$note->add_action( $action->name, $action->label, $action->query, $action->status, $action->is_primary );
 			}
 		}
 	}
@@ -231,11 +231,12 @@ class WC_Admin_Notes_Data_Store extends WC_Data_Store_WP implements WC_Object_Da
 			$wpdb->insert(
 				$wpdb->prefix . 'wc_admin_note_actions',
 				array(
-					'note_id' => $note->get_id(),
-					'name'    => $action->name,
-					'label'   => $action->label,
-					'query'   => $action->query,
-					'status'  => $action->status,
+					'note_id'    => $note->get_id(),
+					'name'       => $action->name,
+					'label'      => $action->label,
+					'query'      => $action->query,
+					'status'     => $action->status,
+					'is_primary' => $action->primary,
 				)
 			);
 		}
diff --git a/plugins/woocommerce-admin/includes/notes/class-wc-admin-note.php b/plugins/woocommerce-admin/includes/notes/class-wc-admin-note.php
index 8126c47d749..5b5349383c8 100644
--- a/plugins/woocommerce-admin/includes/notes/class-wc-admin-note.php
+++ b/plugins/woocommerce-admin/includes/notes/class-wc-admin-note.php
@@ -466,16 +466,18 @@ class WC_Admin_Note extends WC_Data {
 	/**
 	 * Add an action to the note
 	 *
-	 * @param string $name Label name (not presented to user).
-	 * @param string $label Note label (e.g. presented as button label).
-	 * @param string $query Note query (for redirect).
-	 * @param string $status The status to set for the action should on click.
+	 * @param string  $name    Label name (not presented to user).
+	 * @param string  $label   Note label (e.g. presented as button label).
+	 * @param string  $query   Note query (for redirect).
+	 * @param string  $status  The status to set for the action should on click.
+	 * @param boolean $primary Whether or not this is the primary action. Defaults to false.
 	 */
-	public function add_action( $name, $label, $query, $status = '' ) {
-		$name   = wc_clean( $name );
-		$label  = wc_clean( $label );
-		$query  = wc_clean( $query );
-		$status = wc_clean( $status );
+	public function add_action( $name, $label, $query, $status = '', $primary = false ) {
+		$name    = wc_clean( $name );
+		$label   = wc_clean( $label );
+		$query   = wc_clean( $query );
+		$status  = wc_clean( $status );
+		$primary = (bool) $primary;
 
 		if ( empty( $name ) ) {
 			$this->error( 'admin_note_invalid_data', __( 'The admin note action name prop cannot be empty.', 'woocommerce-admin' ) );
@@ -485,15 +487,17 @@ class WC_Admin_Note extends WC_Data {
 			$this->error( 'admin_note_invalid_data', __( 'The admin note action label prop cannot be empty.', 'woocommerce-admin' ) );
 		}
 
+		// @todo - maybe allow empty queries? for dismissals that don't need navigation.
 		if ( empty( $query ) ) {
 			$this->error( 'admin_note_invalid_data', __( 'The admin note action query prop cannot be empty.', 'woocommerce-admin' ) );
 		}
 
 		$action = array(
-			'name'   => $name,
-			'label'  => $label,
-			'query'  => $query,
-			'status' => $status,
+			'name'    => $name,
+			'label'   => $label,
+			'query'   => $query,
+			'status'  => $status,
+			'primary' => $primary,
 		);
 
 		$note_actions   = $this->get_prop( 'actions', 'edit' );
diff --git a/plugins/woocommerce-admin/includes/notes/class-wc-admin-notes-historical-data.php b/plugins/woocommerce-admin/includes/notes/class-wc-admin-notes-historical-data.php
index 893f4365437..a432c08ead2 100644
--- a/plugins/woocommerce-admin/includes/notes/class-wc-admin-notes-historical-data.php
+++ b/plugins/woocommerce-admin/includes/notes/class-wc-admin-notes-historical-data.php
@@ -49,7 +49,8 @@ class WC_Admin_Notes_Historical_Data {
 			'get-started',
 			__( 'Get Started', 'woocommerce-admin' ),
 			'?page=wc-admin#/analytics/settings',
-			'actioned'
+			'actioned',
+			true
 		);
 
 		$note->save();