feat(content-distribution): add CLI command for distribute post

includes/class-content-distribution.php

@@ -7,11 +7,11 @@
 
 namespace Newspack_Network;
 
-use Newspack_Network\Content_Distribution\Outgoing_Post;
-use Newspack_Network\Content_Distribution\Incoming_Post;
 use Newspack\Data_Events;
+use Newspack_Network\Content_Distribution\CLI;
+use Newspack_Network\Content_Distribution\Incoming_Post;
+use Newspack_Network\Content_Distribution\Outgoing_Post;
 use WP_Post;
-use WP_Error;
 
 /**
  * Main class for content distribution
@@ -26,6 +26,7 @@ public static function init() {
 		if ( ! defined( 'NEWPACK_NETWORK_CONTENT_DISTRIBUTION' ) || ! NEWPACK_NETWORK_CONTENT_DISTRIBUTION ) {
 			return;
 		}
+		CLI::init();
 		add_action( 'init', [ __CLASS__, 'register_listeners' ] );
 		add_filter( 'newspack_webhooks_request_priority', [ __CLASS__, 'webhooks_request_priority' ], 10, 2 );
 	}
@@ -73,6 +74,8 @@ public static function handle_post_updated( $post ) {
 		if ( $post ) {
 			return $post->get_payload();
 		}
+
+		return null;
 	}
 
 	/**
@@ -149,14 +152,16 @@ public static function get_reserved_post_meta_keys() {
 	 *
 	 * @param WP_Post|int $post The post object or ID.
 	 *
-	 * @return Outgoing_Post|null The distributed post or null if not found.
+	 * @return Outgoing_Post|null The distributed post or null if not found, or we couldn't create one.
 	 */
 	public static function get_distributed_post( $post ) {
-		$outgoing_post = new Outgoing_Post( $post );
-		if ( ! $outgoing_post->is_distributed() ) {
+		try {
+			$outgoing_post = new Outgoing_Post( $post );
+		} catch ( \InvalidArgumentException ) {
 			return null;
 		}
-		return $outgoing_post;
+
+		return $outgoing_post->is_distributed() ? $outgoing_post : null;
 	}
 
 	/**

includes/content-distribution/class-cli.php

@@ -0,0 +1,104 @@
+<?php
+/**
+ * Network Content Distribution commands.
+ *
+ * @package Newspack
+ */
+
+namespace Newspack_Network\Content_Distribution;
+
+use Newspack_Network\Content_Distribution;
+use Newspack_Network\Utils\Network;
+use WP_CLI;
+use WP_CLI\ExitException;
+
+/**
+ * Class Distribution.
+ */
+class CLI {
+	/**
+	 * Initialize this class and register hooks
+	 *
+	 * @return void
+	 */
+	public static function init(): void {
+		if ( defined( 'WP_CLI' ) && WP_CLI ) {
+			add_action( 'init', [ __CLASS__, 'register_commands' ] );
+		}
+	}
+
+	/**
+	 * Callback to register the WP-CLI commands.
+	 *
+	 * @return void
+	 * @throws \Exception If something goes wrong.
+	 */
+	public static function register_commands(): void {
+		WP_CLI::add_command(
+			'newspack network distribute post',
+			[ __CLASS__, 'cmd_distribute_post' ],
+			[
+				'shortdesc' => __( 'Distribute a post to all the network or the specified sites' ),
+				'synopsis'  => [
+					[
+						'type'        => 'positional',
+						'name'        => 'post-id',
+						'description' => sprintf(
+							'The ID of the post to distribute. Supported post types are: %s',
+							implode(
+								', ',
+								Content_Distribution::get_distributed_post_types()
+							)
+						),
+						'optional'    => false,
+						'repeating'   => false,
+					],
+					[
+						'type'        => 'assoc',
+						'name'        => 'sites',
+						'description' => __( "Networked site url(s) comma separated to distribute the post to – or 'all' to distribute to all sites in the network." ),
+						'optional'    => false,
+					],
+				],
+			]
+		);
+	}
+
+	/**
+	 * Callback for the `newspack-network distribute post` command.
+	 *
+	 * @param array $pos_args   Positional arguments.
+	 * @param array $assoc_args Associative arguments.
+	 *
+	 * @throws ExitException If something goes wrong.
+	 */
+	public function cmd_distribute_post( array $pos_args, array $assoc_args ): void {
+		$post_id = $pos_args[0];
+		if ( ! is_numeric( $post_id ) ) {
+			WP_CLI::error( 'Post ID must be a number.' );
+		}
+
+		if ( 'all' === $assoc_args['sites'] ) {
+			$sites = Network::get_networked_urls();
+		} else {
+			$sites = array_map(
+				fn( $site ) => untrailingslashit( trim( $site ) ),
+				explode( ',', $assoc_args['sites'] )
+			);
+		}
+
+		try {
+			$outgoing_post = Content_Distribution::get_distributed_post( $post_id ) ?? new Outgoing_Post( $post_id );
+			$config = $outgoing_post->set_config( $sites );
+			if ( is_wp_error( $config ) ) {
+				WP_CLI::error( $config->get_error_message() );
+			}
+
+			Content_Distribution::distribute_post( $outgoing_post );
+			WP_CLI::success( sprintf( 'Post with ID %d is distributed to %d sites: %s', $post_id, count( $config['site_urls'] ), implode( ', ', $config['site_urls'] ) ) );
+
+		} catch ( \Exception $e ) {
+			WP_CLI::error( $e->getMessage() );
+		}
+	}
+}

includes/content-distribution/class-outgoing-post.php

@@ -8,8 +8,9 @@
 namespace Newspack_Network\Content_Distribution;
 
 use Newspack_Network\Content_Distribution;
-use WP_Post;
+use Newspack_Network\Utils\Network;
 use WP_Error;
+use WP_Post;
 
 /**
  * Outgoing Post Class.
@@ -40,6 +41,11 @@ public function __construct( $post ) {
 			throw new \InvalidArgumentException( esc_html( __( 'Invalid post.', 'newspack-network' ) ) );
 		}
 
+		if ( ! in_array( $post->post_type, Content_Distribution::get_distributed_post_types() ) ) {
+			/* translators: unsupported post type for content distribution */
+			throw new \InvalidArgumentException( esc_html( sprintf( __( 'Post type %s is not supported as a distributed outgoing post.', 'newspack-network' ), $post->post_type ) ) );
+		}
+
 		$this->post = $post;
 	}
 
@@ -57,9 +63,27 @@ public function get_post() {
 	 *
 	 * @param int[] $site_urls Array of site URLs to distribute the post to.
 	 *
-	 * @return void|WP_Error Void on success, WP_Error on failure.
+	 * @return array|WP_Error Config array on success, WP_Error on failure.
 	 */
-	public function set_config( $site_urls = [] ) {
+	public function set_config( $site_urls ) {
+		if ( empty( $site_urls ) ) {
+			return new WP_Error( 'config_no_site_urls', __( 'No site URLs provided.', 'newspack-network' ) );
+		}
+
+		$networked_urls      = Network::get_networked_urls();
+		$urls_not_in_network = array_diff( $site_urls, $networked_urls );
+		if ( ! empty( $urls_not_in_network ) ) {
+			return new WP_Error(
+				'config_non_networked_urls',
+				sprintf(
+					/* translators: %s: list of non-networked URLs */
+					__( 'Non-networked URLs were passed to config: %s', 'newspack-network' ),
+					implode( ', ', $urls_not_in_network )
+				)
+			);
+		}
+
+
 		$config = get_post_meta( $this->post->ID, self::DISTRIBUTED_POST_META, true );
 		if ( ! is_array( $config ) ) {
 			$config = [];
@@ -68,8 +92,18 @@ public function set_config( $site_urls = [] ) {
 		if ( empty( $config['network_post_id'] ) ) {
 			$config['network_post_id'] = md5( $this->post->ID . get_bloginfo( 'url' ) );
 		}
-		$config['site_urls'] = $site_urls;
+
+		if ( empty( $config['site_urls'] ) ) {
+			$config['site_urls'] = [];
+		}
+
+		// If there are urls not already in the config, add them. Note that we don't support
+		// removing urls from the config.
+		$config['site_urls'] = array_unique( array_merge( $config['site_urls'], $site_urls ) );
+
 		update_post_meta( $this->post->ID, self::DISTRIBUTED_POST_META, $config );
+
+		return $config;
 	}
 
 	/**

tests/unit-tests/test-outgoing-post.php

@@ -6,17 +6,31 @@
  */
 
 use Newspack_Network\Content_Distribution\Outgoing_Post;
+use Newspack_Network\Hub\Node as Hub_Node;
 
 /**
  * Test the Outgoing_Post class.
  */
-class TestOutgoingPoist extends WP_UnitTestCase {
+class TestOutgoingPost extends WP_UnitTestCase {
+
+
 	/**
-	 * URL for node that receives posts.
+	 * "Mocked" network nodes.
 	 *
-	 * @var string
+	 * @var array
 	 */
-	protected $node_url = 'https://node.test';
+	protected $network = [
+		[
+			'id'    => 1234,
+			'title' => 'Test Node',
+			'url'   => 'https://node.test',
+		],
+		[
+			'id'    => 5678,
+			'title' => 'Test Node 2',
+			'url'   => 'https://other-node.test',
+		],
+	];
 
 	/**
 	 * A distributed post.
@@ -31,16 +45,36 @@ class TestOutgoingPoist extends WP_UnitTestCase {
 	public function set_up() {
 		parent::set_up();
 
-		$post = $this->factory->post->create_and_get( [ 'post_type' => 'post' ] );
+		// "Mock" the network node(s).
+		update_option( Hub_Node::HUB_NODES_SYNCED_OPTION, $this->network );
+		$post                = $this->factory->post->create_and_get( [ 'post_type' => 'post' ] );
 		$this->outgoing_post = new Outgoing_Post( $post );
-		$this->outgoing_post->set_config( [ $this->node_url ] );
+		$this->outgoing_post->set_config( [ $this->network[0]['url'] ] );
+	}
+
+	/**
+	 * Test adding a site URL to the config after already having added one.
+	 */
+	public function test_add_site_url() {
+		$config = $this->outgoing_post->get_config();
+		$this->assertTrue( in_array( $this->network[0]['url'], $config['site_urls'], true ) );
+		$this->assertEquals( 1, count( $config['site_urls'] ) );
+
+		// Now add one more site URL.
+		$this->outgoing_post->set_config( [ $this->network[1]['url'] ] );
+		$config = $this->outgoing_post->get_config();
+		// Check that both urls are there.
+		$this->assertTrue( in_array( $this->network[0]['url'], $config['site_urls'], true ) );
+		$this->assertTrue( in_array( $this->network[1]['url'], $config['site_urls'], true ) );
+		// But no more than that.
+		$this->assertEquals( 2, count( $config['site_urls'] ) );
 	}
 
 	/**
 	 * Test set post distribution configuration.
 	 */
 	public function test_set_config() {
-		$result = $this->outgoing_post->set_config( [ $this->node_url ] );
+		$result = $this->outgoing_post->set_config( [ $this->network[0]['url'] ] );
 		$this->assertFalse( is_wp_error( $result ) );
 	}
 
@@ -49,17 +83,17 @@ public function test_set_config() {
 	 */
 	public function test_get_config() {
 		$config = $this->outgoing_post->get_config();
-		$this->assertSame( [ $this->node_url ], $config['site_urls'] );
+		$this->assertSame( [ $this->network[0]['url'] ], $config['site_urls'] );
 		$this->assertSame( 32, strlen( $config['network_post_id'] ) );
 	}
 
 	/**
 	 * Test get config for non-distributed.
 	 */
 	public function test_get_config_for_non_distributed() {
-		$post = $this->factory->post->create_and_get( [ 'post_type' => 'post' ] );
+		$post          = $this->factory->post->create_and_get( [ 'post_type' => 'post' ] );
 		$outgoing_post = new Outgoing_Post( $post );
-		$config           = $outgoing_post->get_config();
+		$config        = $outgoing_post->get_config();
 		$this->assertEmpty( $config['site_urls'] );
 		$this->assertEmpty( $config['network_post_id'] );
 	}
@@ -68,11 +102,12 @@ public function test_get_config_for_non_distributed() {
 	 * Test set post distribution persists the network post ID.
 	 */
 	public function test_set_config_persists_network_post_id() {
-		$result = $this->outgoing_post->set_config( [ $this->node_url ] );
+		$horse = '';
+		$this->outgoing_post->set_config( [ $this->network[0]['url'] ] );
 		$config = $this->outgoing_post->get_config();
 
-		// Update the post distribution.
-		$result     = $this->outgoing_post->set_config( [ 'https://other-node.test' ] );
+		// Update the post distribution with one more node.
+		$this->outgoing_post->set_config( [ $this->network[1]['url'] ] );
 		$new_config = $this->outgoing_post->get_config();
 
 		$this->assertSame( $config['network_post_id'], $new_config['network_post_id'] );
@@ -82,14 +117,8 @@ public function test_set_config_persists_network_post_id() {
 	 * Test is distributed.
 	 */
 	public function test_is_distributed() {
-		$this->assertTrue( $this->outgoing_post->is_distributed() );
-
-		// Update the post distribution.
-		$result = $this->outgoing_post->set_config( [] );
-		$this->assertFalse( $this->outgoing_post->is_distributed() );
-
 		// Assert regular post.
-		$post = $this->factory->post->create_and_get( [ 'post_type' => 'post' ] );
+		$post          = $this->factory->post->create_and_get( [ 'post_type' => 'post' ] );
 		$outgoing_post = new Outgoing_Post( $post );
 		$this->assertFalse( $outgoing_post->is_distributed() );
 	}