[FIX] Skip an empty keyphrase sync so Arc is unchanged

[UPD] Bump plugin version to 0.6.1
[DOC] Add the v0.6.1 release notes
[TST] Cover a vacant keyphrase replace

Author: devhalls

ROADMAP.md

@@ -66,7 +66,8 @@ has none, and to connect this install when it is not paired with Arc.
 Those notices do not change the menu count. **Sync with Arc** is shown after the first scan,
 and only when the local list hash differs from `GET /v1/sites/{siteId}/seo-targets`.
 The click sends dirty rows when Arc still matches the last accepted hash,
-or the whole list when Arc has moved. Commit uses `auto_run: true`, which
+or the whole list when Arc has moved. A replace with no page phrases and no
+focus is not sent, so an empty site does not clear the Arc list. Commit uses `auto_run: true`, which
 queues the SEO report. Turning the checkbox off clears the WordPress list
 and leaves the Arc target in place.
 

docs/releases/v0.6.1.md

@@ -0,0 +1,24 @@
+WordPress plugin that connects a site to Pendulum Arc. An empty keyphrase list no longer replaces Arc for v0.6.1.
+
+**Min version support:**
+- WordPress **6.7**
+- PHP **8.1** with the sodium extension
+
+**Requires:**
+- A Pendulum Arc account, and an API key or Arc sign-in
+
+**Runtime support:**
+- WordPress 6.7 or newer
+
+**Changes since v0.6.0:**
+- Sync keyphrases does not send a replace when this site has no focus phrase and no page phrases. Arc keeps the list it already has
+- A list that does have page phrases still replaces the Arc target
+
+**Support us:**
+
+If you find this useful, visit Pendulum:
+
+[![Pendulum][Pendulum-shield]][Pendulum-url]
+
+[Pendulum-shield]: https://img.shields.io/badge/pendulum-000000?style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyBpZD0iTGF5ZXJfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgdmlld0JveD0iMCAwIDE2NSAxNjUiPjxkZWZzPjxsaW5lYXJHcmFkaWVudCBpZD0ibGluZWFyLWdyYWRpZW50IiB4MT0iMCIgeTE9IjgzLjUiIHgyPSIxNjEuMzkiIHkyPSI4My41IiBncmFkaWVudFRyYW5zZm9ybT0idHJhbnNsYXRlKDAgMTY2KSBzY2FsZSgxIC0xKSIgZ3JhZGllbnRVbml0cz0idXNlclNwYWNlT25Vc2UiPjxzdG9wIG9mZnNldD0iMCIgc3RvcC1jb2xvcj0iIzMyYjdkNiIvPjxzdG9wIG9mZnNldD0iMSIgc3RvcC1jb2xvcj0iI2Y0OTYzYyIvPjwvbGluZWFyR3JhZGllbnQ+PC9kZWZzPjxyZWN0IHdpZHRoPSIxNjUiIGhlaWdodD0iMTY1IiBzdHlsZT0iZmlsbDp1cmwoI2xpbmVhci1ncmFkaWVudCk7Ii8+PHBhdGggZD0iTTU0LjA4LDEzM2gtMjUuOThWMzMuMDNoNDEuMzZjMTEuMjIsMCwxOS44MiwyLjkyLDI1Ljc4LDguNzVzOC45NSwxNC4wNSw4Ljk1LDI0LjY2LTIuOTgsMTguODMtOC45NSwyNC42NmMtNS45Niw1LjgzLTE0LjU2LDguNzUtMjUuNzgsOC43NWgtMTUuMzhzMCwzMy4xNSwwLDMzLjE1Wk01NC4wOCw3OC45aDguNjJjOS41NCwwLDE0LjMyLTQuMTUsMTQuMzItMTIuNDZzLTQuNzctMTIuNDYtMTQuMzItMTIuNDZoLTguNjJ2MjQuOTNoMFpNMTQzLjEsMzNsLTI2LjExLDEwMGgtMjVsMjYuMTEtMTAwaDI1WiIgc3R5bGU9ImZpbGw6I2ZmZjsiLz48L3N2Zz4=
+[Pendulum-url]: https://pendulumdev.co.uk/

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "arc-wordpress",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "private": true,
   "description": "Connect a WordPress site to a Pendulum Arc account.",
   "author": "Pendulum Development Ltd",

package.json

@@ -67,6 +67,17 @@ public static function plan( ?string $acked_hash, string $arc_hash, string $focu
 		);
 	}
 
+	/**
+	 * A replace with no pages and no focus must not be sent. Arc keeps its list.
+	 *
+	 * @param array{mode: string, upserts: array<int, mixed>, focus: string|null} $plan Push plan.
+	 */
+	public static function vacant( array $plan ): bool {
+		return 'replace' === $plan['mode']
+			&& array() === $plan['upserts']
+			&& null === $plan['focus'];
+	}
+
 	/**
 	 * @param array<int, array{path: string, focusKeyphrase: string}> $upserts Upserts.
 	 * @param array<int, string>                                      $deletes Paths to delete.

pendulum-arc/includes/class-keyphrase-push.php

@@ -260,6 +260,12 @@ function ( string $env, string $token, string $site_id ) {
 		);
 		$arc_hash = (string) ( $remote['hash'] ?? '' );
 		$plan     = Keyphrase_Push::plan( $state['acked_hash'], $arc_hash, $state['focus'], $state['focus_synced'], $this->list->rows() );
+		if ( Keyphrase_Push::vacant( $plan ) ) {
+			return array(
+				'ok'      => true,
+				'message' => __( 'This site has no keyphrases to send. Arc was left unchanged.', 'pendulum-arc' ),
+			);
+		}
 		if ( '' !== $state['sync_id'] ) {
 			$this->abandon( $state['sync_id'] );
 		}

pendulum-arc/includes/class-keyphrase-sync.php

@@ -3,7 +3,7 @@
  * Plugin Name:       Arc Analytics
  * Plugin URI:        https://github.com/pendulumdev/arc-wordpress
  * Description:       Connect this site to a Pendulum Arc account.
- * Version:           0.6.0
+ * Version:           0.6.1
  * Requires at least: 6.7
  * Requires PHP:      8.1
  * Author:            Pendulum
@@ -21,7 +21,7 @@
 	exit;
 }
 
-define( 'ARC_WORDPRESS_VERSION', '0.6.0' );
+define( 'ARC_WORDPRESS_VERSION', '0.6.1' );
 define( 'ARC_WORDPRESS_FILE', __FILE__ );
 define( 'ARC_WORDPRESS_DIR', plugin_dir_path( __FILE__ ) );
 

pendulum-arc/pendulum-arc.php

@@ -4,7 +4,7 @@ Tags: seo, analytics
 Requires at least: 6.7
 Tested up to: 7.1
 Requires PHP: 8.1
-Stable tag: 0.6.0
+Stable tag: 0.6.1
 License: GPLv2 or later
 License URI: https://www.gnu.org/licenses/gpl-2.0.html
 
@@ -20,7 +20,7 @@ An API key pairs the site when Arc already has this address. When it does not, y
 
 On Settings, Invite sends project invites to WordPress administrators who are not already on the Arc project.
 
-Sync keyphrases, on the Settings page, reads focus keyphrases already stored by Yoast, Rank Math, SEOPress, and All in One SEO. When that list differs from Arc, a notice appears at the top of Arc screens and the Arc menu shows a count of 1. Sync with Arc sends that list to Arc and queues the SEO report. Turning the checkbox off clears the list in WordPress and leaves the Arc target as it is.
+Sync keyphrases, on the Settings page, reads focus keyphrases already stored by Yoast, Rank Math, SEOPress, and All in One SEO. When that list differs from Arc, a notice appears at the top of Arc screens and the Arc menu shows a count of 1. Sync with Arc sends that list to Arc and queues the SEO report. An empty list is not sent, so Arc keeps the phrases it already has. Turning the checkbox off clears the list in WordPress and leaves the Arc target as it is.
 
 GDPR Consent, under the Arc menu, is a cookie banner for this site. It does not call Arc, and it is available before the site is paired. Optional cookies, and scripts listed on them, stay off until a visitor accepts them. Decline refuses every optional cookie. Consent logging is off until you turn it on. A static banner is printed at the end of the theme header or footer. A fixed banner is positioned on the screen. Disable, on the Behaviour tab, turns the banner off and leaves script tags unchanged.
 
@@ -69,6 +69,10 @@ When the GitHub repository is public and a release is newer than this install, W
 
 == Changelog ==
 
+= 0.6.1 =
+* Sync keyphrases does not send a replace when this site has no focus phrase and no page phrases. Arc keeps the list it already has.
+* A list that does have page phrases still replaces the Arc target.
+
 = 0.6.0 =
 * The Arc Analytics screen shows the paired site's latest Analytics, SEO, A11Y, AI, Security, and Brand report.
 * SEO, accessibility, and AI page rows open that page's issues. The list scrolls down.

pendulum-arc/readme.txt

@@ -227,6 +227,31 @@ public function test_a_different_arc_hash_replaces_the_whole_list(): void {
 		self::assertCount( 1, $plan['upserts'] );
 	}
 
+	public function test_an_empty_replace_is_vacant(): void {
+		$plan = Keyphrase_Push::plan( 'old', 'moved', '', '', array() );
+		self::assertSame( 'replace', $plan['mode'] );
+		self::assertSame( array(), $plan['upserts'] );
+		self::assertNull( $plan['focus'] );
+		self::assertTrue( Keyphrase_Push::vacant( $plan ) );
+
+		$pages = Keyphrase_Push::plan(
+			'old',
+			'moved',
+			'',
+			'',
+			array(
+				array(
+					'path'          => '/about',
+					'phrase'        => 'about',
+					'synced_phrase' => '',
+					'deleted'       => false,
+				),
+			)
+		);
+		self::assertFalse( Keyphrase_Push::vacant( $pages ) );
+		self::assertCount( 1, $pages['upserts'] );
+	}
+
 	public function test_only_the_keyphrase_alert_counts(): void {
 		self::assertFalse( Page_Alerts::keyphrase_pending( true, false, true, 'home', '', true, false ) );
 		self::assertFalse( Page_Alerts::keyphrase_pending( true, true, false, 'home', '', true, false ) );