Merge pull request #1090 from woocommerce/release/1.4.13

Release 1.4.13

changelog.txt

@@ -1,5 +1,10 @@
 *** Pinterest for WooCommerce Changelog ***
 
+= 1.4.13 - 2024-12-04 =
+* Add - Admin notice of a failed Pinterest account status.
+* Update - Do not disconnect on the Action Scheduler action failure.
+* Update - Failed actions to log the errors.
+
 = 1.4.12 - 2024-11-07 =
 * Tweak - WC 9.4 compatibility.
 * Tweak - WP 6.7 compatibility.

class-pinterest-for-woocommerce.php

@@ -310,8 +310,6 @@ public function init_plugin() {
 
 			add_action( 'pinterest_for_woocommerce_disconnect', array( self::class, 'reset_connection' ) );
 
-			add_action( 'action_scheduler_failed_execution', array( self::class, 'action_scheduler_reset_connection' ), 10, 2 );
-
 			// Handle the Pinterest verification URL.
 			add_action( 'parse_request', array( $this, 'verification_request' ) );
 
@@ -847,25 +845,6 @@ public static function reset_connection() {
 			TokenInvalidFailure::possibly_add_note();
 		}
 
-		/**
-		 * Resets the connection from action scheduler.
-		 *
-		 * @since 1.4.4
-		 *
-		 * @param string    $action_id The ID of the action.
-		 * @param Exception $e         The exception that was thrown.
-		 *
-		 * @return void
-		 * @throws NotesUnavailableException If the notes API is not available.
-		 * @throws Exception                 If the exception is a 401 error.
-		 */
-		public static function action_scheduler_reset_connection( $action_id, $e ) {
-			if ( in_array( $e->getCode(), array( 401, 403 ) ) ) {
-				self::reset_connection();
-				throw $e;
-			}
-		}
-
 		/**
 		 * Flush data option and remove settings.
 		 *

package.json

@@ -2,7 +2,7 @@
   "name": "pinterest-for-woocommerce",
   "title": "Pinterest for WooCommerce",
   "description": "Pinterest for WooCommerce",
-  "version": "1.4.12",
+  "version": "1.4.13",
   "main": "gulpfile.js",
   "repository": {
     "type": "git",

pinterest-for-woocommerce.php

@@ -13,7 +13,7 @@
  * Plugin Name:       Pinterest for WooCommerce
  * Plugin URI:        https://woocommerce.com/products/pinterest-for-woocommerce/
  * Description:       Grow your business on Pinterest! Use this official plugin to allow shoppers to Pin products while browsing your store, track conversions, and advertise on Pinterest.
- * Version:           1.4.12
+ * Version:           1.4.13
  * Author:            WooCommerce
  * Author URI:        https://woocommerce.com
  * License:           GPL-2.0+
@@ -47,7 +47,7 @@
 }
 
 define( 'PINTEREST_FOR_WOOCOMMERCE_PLUGIN_FILE', __FILE__ );
-define( 'PINTEREST_FOR_WOOCOMMERCE_VERSION', '1.4.12' ); // WRCS: DEFINED_VERSION.
+define( 'PINTEREST_FOR_WOOCOMMERCE_VERSION', '1.4.13' ); // WRCS: DEFINED_VERSION.
 
 // HPOS compatibility declaration.
 add_action(

readme.txt

@@ -4,7 +4,7 @@ Tags: pinterest, woocommerce, marketing, product catalog feed, pixel
 Requires at least: 5.6
 Tested up to: 6.7
 Requires PHP: 7.3
-Stable tag: 1.4.12
+Stable tag: 1.4.13
 License: GPLv3
 License URI: https://www.gnu.org/licenses/gpl-3.0.html
 
@@ -91,6 +91,11 @@ Release and roadmap notes available on the [WooCommerce Developers Blog](https:/
 
 == Changelog ==
 
+= 1.4.13 - 2024-12-04 =
+* Add - Admin notice of a failed Pinterest account status.
+* Update - Do not disconnect on the Action Scheduler action failure.
+* Update - Failed actions to log the errors.
+
 = 1.4.12 - 2024-11-07 =
 * Tweak - WC 9.4 compatibility.
 * Tweak - WP 6.7 compatibility.

src/API/APIV5.php

@@ -9,7 +9,6 @@
 
 namespace Automattic\WooCommerce\Pinterest\API;
 
-use Automattic\WooCommerce\Pinterest\Feeds;
 use Automattic\WooCommerce\Pinterest\PinterestApiException;
 use Exception;
 

src/API/Base.php

@@ -129,6 +129,18 @@ public static function make_request( $endpoint, $method = 'POST', $payload = arr
 				do_action( 'pinterest_for_woocommerce_disconnect' );
 			}
 
+			/**
+			 * Action used to intercept the Pinterest API exception with code and a message and decide whether or not
+			 * to show an admin notice for the exception.
+			 *
+			 * @since 1.4.13
+			 *
+			 * @param int    $http_code             Pinterest API HTTP response code.
+			 * @param int    $pinterest_api_code    Pinterest API error code.
+			 * @param string $pinterest_api_message Pinterest API error message.
+			 */
+			do_action( 'pinterest_for_woocommerce_show_admin_notice_for_api_exception', $e->getCode(), $e->get_pinterest_code(), $e->getMessage() );
+
 			throw $e;
 		}
 	}

src/CommerceIntegration.php

@@ -128,6 +128,7 @@ public static function handle_create( $attempt = 0 ): array {
 	 * Handles Commerce Integration partner_metadata updates.
 	 *
 	 * @since 1.4.11
+	 * @throws PinterestApiException Pinterest API exception.
 	 * @return void
 	 */
 	public static function handle_sync() {
@@ -171,6 +172,7 @@ public static function handle_sync() {
 				),
 				'error'
 			);
+			throw $e;
 		}
 	}
 

src/FeedRegistration.php

@@ -8,8 +8,8 @@
 
 namespace Automattic\WooCommerce\Pinterest;
 
+use Automattic\WooCommerce\Pinterest\Notes\AccountFailure;
 use Exception;
-use Pinterest_For_Woocommerce;
 use Throwable;
 use Automattic\WooCommerce\Pinterest\Utilities\ProductFeedLogger;
 use Automattic\WooCommerce\Pinterest\Exception\PinterestApiLocaleException;
@@ -66,6 +66,9 @@ public function init() {
 
 		// We do not want to disconnect the merchant if the authentication fails, since it running action can not be unscheduled.
 		add_filter( 'pinterest_for_woocommerce_disconnect_on_authentication_failure', '__return_false' );
+
+		add_action( 'pinterest_for_woocommerce_show_admin_notice_for_api_exception', array( self::class, 'maybe_account_failure_notice' ), 10, 3 );
+		add_action( 'pinterest_for_woocommerce_disconnect', array( AccountFailure::class, 'delete_note' ) );
 	}
 
 	/**
@@ -79,8 +82,9 @@ public function init() {
 	 *
 	 * @return bool
 	 *
-	 * @throws Exception PHP Exception.
-	 * @throws PinterestApiException Pinterest API Exception.
+	 * @throws PinterestApiLocaleException Pinterest API does not support the locale.
+	 * @throws PinterestApiException       Pinterest API exception.
+	 * @throws Throwable                   Any other exception.
 	 */
 	public function handle_feed_registration(): bool {
 
@@ -94,26 +98,19 @@ public function handle_feed_registration(): bool {
 		}
 
 		try {
-			if ( self::register_feed() ) {
-				return true;
-			}
-			throw new Exception( esc_html__( 'Could not register feed.', 'pinterest-for-woocommerce' ) );
+			return self::register_feed();
 		} catch ( PinterestApiLocaleException $e ) {
 			Pinterest_For_Woocommerce()::save_data( 'merchant_locale_not_valid', true );
 
 			// translators: %s: Error message.
-			$error_message = "Could not register feed. Error: {$e->getMessage()}";
+			$error_message = "Could not register the feed. Error: {$e->getMessage()}";
 			self::log( $error_message, 'error' );
-			return false;
+			throw $e;
 		} catch ( PinterestApiException $e ) {
 			throw $e;
 		} catch ( Throwable $th ) {
-			if ( method_exists( $th, 'get_pinterest_code' ) && 4163 === $th->get_pinterest_code() ) {
-				Pinterest_For_Woocommerce()::save_data( 'merchant_connected_diff_platform', true );
-			}
-
 			self::log( $th->getMessage(), 'error' );
-			return false;
+			throw $th;
 		}
 	}
 
@@ -136,7 +133,7 @@ private function clear_merchant_error_code() {
 	 *
 	 * @return boolean
 	 *
-	 * @throws Exception PHP Exception.
+	 * @throws PinterestApiException PHP Exception.
 	 */
 	private static function register_feed(): bool {
 		$feed_id = Feeds::match_local_feed_configuration_to_registered_feeds();
@@ -230,4 +227,21 @@ public static function deregister() {
 		Pinterest_For_Woocommerce()::save_data( 'feed_registered', false );
 		self::cancel_jobs();
 	}
+
+	/**
+	 * Maybe show admin notice about account being disapproved.
+	 *
+	 * @since 1.4.13
+	 *
+	 * @param int    $http_code             Pinterest API HTTP response code.
+	 * @param int    $pinterest_api_code    Pinterest API error code.
+	 * @param string $pinterest_api_message Pinterest API error message.
+	 *
+	 * @return void
+	 */
+	public static function maybe_account_failure_notice( int $http_code, int $pinterest_api_code, string $pinterest_api_message ): void {
+		if ( 403 === $http_code ) {
+			AccountFailure::maybe_add_note( $pinterest_api_message );
+		}
+	}
 }

src/Feeds.php

@@ -93,7 +93,6 @@ class Feeds {
 	 * @since 1.4.0
 	 *
 	 * @return string The Feed ID or an empty string if failed.
-	 * @throws Exception PHP Exception if there is an error creating the feed, and we are throttling the requests.
 	 * @throws PinterestApiException Pinterest API Exception if there is an error creating the feed.
 	 */
 	public static function create_feed(): string {
@@ -141,13 +140,21 @@ public static function create_feed(): string {
 			'default_availability' => 'IN_STOCK',
 		);
 
-		$cache_key = PINTEREST_FOR_WOOCOMMERCE_PREFIX . '_request_' . md5( wp_json_encode( $data ) . (string) $ad_account_id );
-		$cache     = get_transient( $cache_key );
-
-		if ( false !== $cache ) {
-			throw new Exception(
-				esc_html__( 'There was a previous error trying to create a feed.', 'pinterest-for-woocommerce' ),
-				(int) $cache
+		$cache_key    = PINTEREST_FOR_WOOCOMMERCE_PREFIX . '_request_' . md5( wp_json_encode( $data ) . (string) $ad_account_id );
+		$cached_error = get_transient( $cache_key );
+
+		if ( false !== $cached_error ) {
+			// Faking Pinterest API response to 425 Too early.
+			throw new PinterestApiException(
+				sprintf(
+					/* translators: Pinterest API error code and message. 1: Cached error string. */
+					esc_html__(
+						'Previous request for the same action failed due to: %1$s. Delaying the next call to prevent repeating errors.',
+						'pinterest-for-woocommerce'
+					),
+					esc_html( $cached_error )
+				),
+				425
 			);
 		}
 
@@ -160,8 +167,9 @@ public static function create_feed(): string {
 		try {
 			$feed = APIV5::create_feed( $data, $ad_account_id );
 		} catch ( PinterestApiException $e ) {
-			$delay = Pinterest_For_Woocommerce()::get_data( 'create_feed_delay' ) ?? MINUTE_IN_SECONDS;
-			set_transient( $cache_key, $e->getCode(), $delay );
+			$delay   = Pinterest_For_Woocommerce()::get_data( 'create_feed_delay' ) ?? MINUTE_IN_SECONDS;
+			$message = sprintf( '%1$s - %2$s', esc_html( $e->get_pinterest_code() ), esc_html( $e->getMessage() ) );
+			set_transient( $cache_key, $message, $delay );
 			// Double the delay.
 			Pinterest_For_Woocommerce()::save_data(
 				'create_feed_delay',
@@ -172,11 +180,7 @@ public static function create_feed(): string {
 
 		static::invalidate_feeds_cache();
 
-		try {
-			$feed_id = static::match_local_feed_configuration_to_registered_feeds( array( $feed ) );
-		} catch ( Throwable $th ) {
-			$feed_id = '';
-		}
+		$feed_id = static::match_local_feed_configuration_to_registered_feeds( array( $feed ) );
 
 		// Clean the cached delay.
 		Pinterest_For_Woocommerce()::save_data( 'create_feed_delay', false );
@@ -278,8 +282,6 @@ public static function invalidate_feeds_cache() {
 	 *
 	 * @param array $feeds The list of feeds to check against. If not set, the list will be fetched from the API.
 	 * @return string Returns the ID of the feed if properly registered or an empty string otherwise.
-	 *
-	 * @throws PinterestApiLocaleException No valid locale found to check for the registered feed.
 	 */
 	public static function match_local_feed_configuration_to_registered_feeds( array $feeds = array() ): string {
 		if ( empty( $feeds ) ) {

src/Notes/AccountFailure.php

@@ -0,0 +1,82 @@
+<?php
+/**
+ * Adds an error note to display Pinterest API account status failure responses.
+ *
+ * @since 1.4.13
+ * @package Automattic\WooCommerce\Pinterest\Notes
+ */
+
+namespace Automattic\WooCommerce\Pinterest\Notes;
+
+defined( 'ABSPATH' ) || exit;
+
+use Automattic\WooCommerce\Admin\Notes\Note;
+use Automattic\WooCommerce\Admin\Notes\Notes;
+use Automattic\WooCommerce\Admin\Notes\NotesUnavailableException;
+use Automattic\WooCommerce\Admin\Notes\NoteTraits;
+
+/**
+ * Account Failure admin notice.
+ *
+ * @since 1.4.13
+ */
+class AccountFailure {
+	/**
+	 * Note traits.
+	 */
+	use NoteTraits;
+
+	/**
+	 * Name of the note for use in the database.
+	 */
+	const NOTE_NAME = 'pinterest-for-woocommerce-account-failure';
+
+	/**
+	 * Get the note.
+	 *
+	 * @since 1.4.13
+	 * @param string $message Pinterest API error message.
+	 * @return Note
+	 */
+	public static function get_note( string $message ) {
+		$additional_data = array(
+			'role' => 'administrator',
+		);
+
+		$note = new Note();
+		$note->set_title( __( 'Pinterest For WooCommerce action required.', 'pinterest-for-woocommerce' ) );
+		$note->set_content( esc_html( $message ) );
+		$note->set_content_data( (object) $additional_data );
+		$note->set_type( Note::E_WC_ADMIN_NOTE_ERROR );
+		$note->set_name( self::NOTE_NAME );
+		$note->set_source( 'woocommerce-admin' );
+		return $note;
+	}
+
+	/**
+	 * Used to add an account failure note if the one does not exist.
+	 *
+	 * @since 1.4.13
+	 * @param string $message Pinterest API error message.
+	 * @return void
+	 * @throws NotesUnavailableException An exception when notes are unavailable.
+	 */
+	public static function maybe_add_note( string $message ): void {
+		if ( self::note_exists() ) {
+			return;
+		}
+
+		$note = self::get_note( $message );
+		$note->save();
+	}
+
+	/**
+	 * Delete the note.
+	 *
+	 * @since 1.4.13
+	 * @return void
+	 */
+	public static function delete_note() {
+		Notes::delete_notes_with_name( self::NOTE_NAME );
+	}
+}